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 *,
922 static void display_menu_bar
P_ ((struct window
*));
923 static int display_count_lines
P_ ((int, int, int, int, int *));
924 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
925 int, int, struct it
*, int, int, int, int));
926 static void compute_line_metrics
P_ ((struct it
*));
927 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
928 static int get_overlay_strings
P_ ((struct it
*, int));
929 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
930 static void next_overlay_string
P_ ((struct it
*));
931 static void reseat
P_ ((struct it
*, struct text_pos
, int));
932 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
933 static void back_to_previous_visible_line_start
P_ ((struct it
*));
934 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
935 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
936 static int next_element_from_ellipsis
P_ ((struct it
*));
937 static int next_element_from_display_vector
P_ ((struct it
*));
938 static int next_element_from_string
P_ ((struct it
*));
939 static int next_element_from_c_string
P_ ((struct it
*));
940 static int next_element_from_buffer
P_ ((struct it
*));
941 static int next_element_from_composition
P_ ((struct it
*));
942 static int next_element_from_image
P_ ((struct it
*));
943 static int next_element_from_stretch
P_ ((struct it
*));
944 static void load_overlay_strings
P_ ((struct it
*, int));
945 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
946 struct display_pos
*));
947 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
948 Lisp_Object
, int, int, int, int));
949 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
951 void move_it_vertically_backward
P_ ((struct it
*, int));
952 static void init_to_row_start
P_ ((struct it
*, struct window
*,
953 struct glyph_row
*));
954 static int init_to_row_end
P_ ((struct it
*, struct window
*,
955 struct glyph_row
*));
956 static void back_to_previous_line_start
P_ ((struct it
*));
957 static int forward_to_next_line_start
P_ ((struct it
*, int *));
958 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
960 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
961 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
962 static int number_of_chars
P_ ((unsigned char *, int));
963 static void compute_stop_pos
P_ ((struct it
*));
964 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
966 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
967 static int next_overlay_change
P_ ((int));
968 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
969 Lisp_Object
, Lisp_Object
,
970 struct text_pos
*, int));
971 static int underlying_face_id
P_ ((struct it
*));
972 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
975 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
976 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
978 #ifdef HAVE_WINDOW_SYSTEM
980 static void update_tool_bar
P_ ((struct frame
*, int));
981 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
982 static int redisplay_tool_bar
P_ ((struct frame
*));
983 static void display_tool_bar_line
P_ ((struct it
*, int));
984 static void notice_overwritten_cursor
P_ ((struct window
*,
986 int, int, int, int));
990 #endif /* HAVE_WINDOW_SYSTEM */
993 /***********************************************************************
994 Window display dimensions
995 ***********************************************************************/
997 /* Return the bottom boundary y-position for text lines in window W.
998 This is the first y position at which a line cannot start.
999 It is relative to the top of the window.
1001 This is the height of W minus the height of a mode line, if any. */
1004 window_text_bottom_y (w
)
1007 int height
= WINDOW_TOTAL_HEIGHT (w
);
1009 if (WINDOW_WANTS_MODELINE_P (w
))
1010 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1014 /* Return the pixel width of display area AREA of window W. AREA < 0
1015 means return the total width of W, not including fringes to
1016 the left and right of the window. */
1019 window_box_width (w
, area
)
1023 int cols
= XFASTINT (w
->total_cols
);
1026 if (!w
->pseudo_window_p
)
1028 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1030 if (area
== TEXT_AREA
)
1032 if (INTEGERP (w
->left_margin_cols
))
1033 cols
-= XFASTINT (w
->left_margin_cols
);
1034 if (INTEGERP (w
->right_margin_cols
))
1035 cols
-= XFASTINT (w
->right_margin_cols
);
1036 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1038 else if (area
== LEFT_MARGIN_AREA
)
1040 cols
= (INTEGERP (w
->left_margin_cols
)
1041 ? XFASTINT (w
->left_margin_cols
) : 0);
1044 else if (area
== RIGHT_MARGIN_AREA
)
1046 cols
= (INTEGERP (w
->right_margin_cols
)
1047 ? XFASTINT (w
->right_margin_cols
) : 0);
1052 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1056 /* Return the pixel height of the display area of window W, not
1057 including mode lines of W, if any. */
1060 window_box_height (w
)
1063 struct frame
*f
= XFRAME (w
->frame
);
1064 int height
= WINDOW_TOTAL_HEIGHT (w
);
1066 xassert (height
>= 0);
1068 /* Note: the code below that determines the mode-line/header-line
1069 height is essentially the same as that contained in the macro
1070 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1071 the appropriate glyph row has its `mode_line_p' flag set,
1072 and if it doesn't, uses estimate_mode_line_height instead. */
1074 if (WINDOW_WANTS_MODELINE_P (w
))
1076 struct glyph_row
*ml_row
1077 = (w
->current_matrix
&& w
->current_matrix
->rows
1078 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1080 if (ml_row
&& ml_row
->mode_line_p
)
1081 height
-= ml_row
->height
;
1083 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1086 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1088 struct glyph_row
*hl_row
1089 = (w
->current_matrix
&& w
->current_matrix
->rows
1090 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1092 if (hl_row
&& hl_row
->mode_line_p
)
1093 height
-= hl_row
->height
;
1095 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1098 /* With a very small font and a mode-line that's taller than
1099 default, we might end up with a negative height. */
1100 return max (0, height
);
1103 /* Return the window-relative coordinate of the left edge of display
1104 area AREA of window W. AREA < 0 means return the left edge of the
1105 whole window, to the right of the left fringe of W. */
1108 window_box_left_offset (w
, area
)
1114 if (w
->pseudo_window_p
)
1117 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1119 if (area
== TEXT_AREA
)
1120 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1121 + window_box_width (w
, LEFT_MARGIN_AREA
));
1122 else if (area
== RIGHT_MARGIN_AREA
)
1123 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1124 + window_box_width (w
, LEFT_MARGIN_AREA
)
1125 + window_box_width (w
, TEXT_AREA
)
1126 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1128 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1129 else if (area
== LEFT_MARGIN_AREA
1130 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1131 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1137 /* Return the window-relative coordinate of the right edge of display
1138 area AREA of window W. AREA < 0 means return the left edge of the
1139 whole window, to the left of the right fringe of W. */
1142 window_box_right_offset (w
, area
)
1146 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1149 /* Return the frame-relative coordinate of the left edge of display
1150 area AREA of window W. AREA < 0 means return the left edge of the
1151 whole window, to the right of the left fringe of W. */
1154 window_box_left (w
, area
)
1158 struct frame
*f
= XFRAME (w
->frame
);
1161 if (w
->pseudo_window_p
)
1162 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1164 x
= (WINDOW_LEFT_EDGE_X (w
)
1165 + window_box_left_offset (w
, area
));
1171 /* Return the frame-relative coordinate of the right edge of display
1172 area AREA of window W. AREA < 0 means return the left edge of the
1173 whole window, to the left of the right fringe of W. */
1176 window_box_right (w
, area
)
1180 return window_box_left (w
, area
) + window_box_width (w
, area
);
1183 /* Get the bounding box of the display area AREA of window W, without
1184 mode lines, in frame-relative coordinates. AREA < 0 means the
1185 whole window, not including the left and right fringes of
1186 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1187 coordinates of the upper-left corner of the box. Return in
1188 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1191 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1194 int *box_x
, *box_y
, *box_width
, *box_height
;
1197 *box_width
= window_box_width (w
, area
);
1199 *box_height
= window_box_height (w
);
1201 *box_x
= window_box_left (w
, area
);
1204 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1205 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1206 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1211 /* Get the bounding box of the display area AREA of window W, without
1212 mode lines. AREA < 0 means the whole window, not including the
1213 left and right fringe of the window. Return in *TOP_LEFT_X
1214 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1215 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1216 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1220 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1221 bottom_right_x
, bottom_right_y
)
1224 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1226 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1228 *bottom_right_x
+= *top_left_x
;
1229 *bottom_right_y
+= *top_left_y
;
1234 /***********************************************************************
1236 ***********************************************************************/
1238 /* Return the bottom y-position of the line the iterator IT is in.
1239 This can modify IT's settings. */
1245 int line_height
= it
->max_ascent
+ it
->max_descent
;
1246 int line_top_y
= it
->current_y
;
1248 if (line_height
== 0)
1251 line_height
= last_height
;
1252 else if (IT_CHARPOS (*it
) < ZV
)
1254 move_it_by_lines (it
, 1, 1);
1255 line_height
= (it
->max_ascent
|| it
->max_descent
1256 ? it
->max_ascent
+ it
->max_descent
1261 struct glyph_row
*row
= it
->glyph_row
;
1263 /* Use the default character height. */
1264 it
->glyph_row
= NULL
;
1265 it
->what
= IT_CHARACTER
;
1268 PRODUCE_GLYPHS (it
);
1269 line_height
= it
->ascent
+ it
->descent
;
1270 it
->glyph_row
= row
;
1274 return line_top_y
+ line_height
;
1278 /* Return 1 if position CHARPOS is visible in window W.
1279 CHARPOS < 0 means return info about WINDOW_END position.
1280 If visible, set *X and *Y to pixel coordinates of top left corner.
1281 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1282 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1285 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1287 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1290 struct text_pos top
;
1292 struct buffer
*old_buffer
= NULL
;
1297 if (XBUFFER (w
->buffer
) != current_buffer
)
1299 old_buffer
= current_buffer
;
1300 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1303 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1305 /* Compute exact mode line heights. */
1306 if (WINDOW_WANTS_MODELINE_P (w
))
1307 current_mode_line_height
1308 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1309 current_buffer
->mode_line_format
);
1311 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1312 current_header_line_height
1313 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1314 current_buffer
->header_line_format
);
1316 start_display (&it
, w
, top
);
1317 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1318 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1320 /* Note that we may overshoot because of invisible text. */
1321 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1323 int top_x
= it
.current_x
;
1324 int top_y
= it
.current_y
;
1325 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1326 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1328 if (top_y
< window_top_y
)
1329 visible_p
= bottom_y
> window_top_y
;
1330 else if (top_y
< it
.last_visible_y
)
1334 Lisp_Object window
, prop
;
1336 XSETWINDOW (window
, w
);
1337 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1338 Qinvisible
, window
);
1340 /* If charpos coincides with invisible text covered with an
1341 ellipsis, use the first glyph of the ellipsis to compute
1342 the pixel positions. */
1343 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1345 struct glyph_row
*row
= it
.glyph_row
;
1346 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1347 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1350 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1351 x
+= glyph
->pixel_width
;
1357 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1358 *rtop
= max (0, window_top_y
- top_y
);
1359 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1360 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1361 - max (top_y
, window_top_y
)));
1370 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1371 move_it_by_lines (&it
, 1, 0);
1372 if (charpos
< IT_CHARPOS (it
)
1373 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1376 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1378 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1379 *rtop
= max (0, -it2
.current_y
);
1380 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1381 - it
.last_visible_y
));
1382 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1384 - max (it2
.current_y
,
1385 WINDOW_HEADER_LINE_HEIGHT (w
))));
1391 set_buffer_internal_1 (old_buffer
);
1393 current_header_line_height
= current_mode_line_height
= -1;
1395 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1396 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1399 /* Debugging code. */
1401 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1402 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1404 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1411 /* Return the next character from STR which is MAXLEN bytes long.
1412 Return in *LEN the length of the character. This is like
1413 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1414 we find one, we return a `?', but with the length of the invalid
1418 string_char_and_length (str
, maxlen
, len
)
1419 const unsigned char *str
;
1424 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1425 if (!CHAR_VALID_P (c
, 1))
1426 /* We may not change the length here because other places in Emacs
1427 don't use this function, i.e. they silently accept invalid
1436 /* Given a position POS containing a valid character and byte position
1437 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1439 static struct text_pos
1440 string_pos_nchars_ahead (pos
, string
, nchars
)
1441 struct text_pos pos
;
1445 xassert (STRINGP (string
) && nchars
>= 0);
1447 if (STRING_MULTIBYTE (string
))
1449 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1450 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1455 string_char_and_length (p
, rest
, &len
);
1456 p
+= len
, rest
-= len
;
1457 xassert (rest
>= 0);
1459 BYTEPOS (pos
) += len
;
1463 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1469 /* Value is the text position, i.e. character and byte position,
1470 for character position CHARPOS in STRING. */
1472 static INLINE
struct text_pos
1473 string_pos (charpos
, string
)
1477 struct text_pos pos
;
1478 xassert (STRINGP (string
));
1479 xassert (charpos
>= 0);
1480 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1485 /* Value is a text position, i.e. character and byte position, for
1486 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1487 means recognize multibyte characters. */
1489 static struct text_pos
1490 c_string_pos (charpos
, s
, multibyte_p
)
1495 struct text_pos pos
;
1497 xassert (s
!= NULL
);
1498 xassert (charpos
>= 0);
1502 int rest
= strlen (s
), len
;
1504 SET_TEXT_POS (pos
, 0, 0);
1507 string_char_and_length (s
, rest
, &len
);
1508 s
+= len
, rest
-= len
;
1509 xassert (rest
>= 0);
1511 BYTEPOS (pos
) += len
;
1515 SET_TEXT_POS (pos
, charpos
, charpos
);
1521 /* Value is the number of characters in C string S. MULTIBYTE_P
1522 non-zero means recognize multibyte characters. */
1525 number_of_chars (s
, multibyte_p
)
1533 int rest
= strlen (s
), len
;
1534 unsigned char *p
= (unsigned char *) s
;
1536 for (nchars
= 0; rest
> 0; ++nchars
)
1538 string_char_and_length (p
, rest
, &len
);
1539 rest
-= len
, p
+= len
;
1543 nchars
= strlen (s
);
1549 /* Compute byte position NEWPOS->bytepos corresponding to
1550 NEWPOS->charpos. POS is a known position in string STRING.
1551 NEWPOS->charpos must be >= POS.charpos. */
1554 compute_string_pos (newpos
, pos
, string
)
1555 struct text_pos
*newpos
, pos
;
1558 xassert (STRINGP (string
));
1559 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1561 if (STRING_MULTIBYTE (string
))
1562 *newpos
= string_pos_nchars_ahead (pos
, string
,
1563 CHARPOS (*newpos
) - CHARPOS (pos
));
1565 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1569 Return an estimation of the pixel height of mode or top lines on
1570 frame F. FACE_ID specifies what line's height to estimate. */
1573 estimate_mode_line_height (f
, face_id
)
1575 enum face_id face_id
;
1577 #ifdef HAVE_WINDOW_SYSTEM
1578 if (FRAME_WINDOW_P (f
))
1580 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1582 /* This function is called so early when Emacs starts that the face
1583 cache and mode line face are not yet initialized. */
1584 if (FRAME_FACE_CACHE (f
))
1586 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1590 height
= FONT_HEIGHT (face
->font
);
1591 if (face
->box_line_width
> 0)
1592 height
+= 2 * face
->box_line_width
;
1603 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1604 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1605 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1606 not force the value into range. */
1609 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1611 register int pix_x
, pix_y
;
1613 NativeRectangle
*bounds
;
1617 #ifdef HAVE_WINDOW_SYSTEM
1618 if (FRAME_WINDOW_P (f
))
1620 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1621 even for negative values. */
1623 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1625 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1627 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1628 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1631 STORE_NATIVE_RECT (*bounds
,
1632 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1633 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1634 FRAME_COLUMN_WIDTH (f
) - 1,
1635 FRAME_LINE_HEIGHT (f
) - 1);
1641 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1642 pix_x
= FRAME_TOTAL_COLS (f
);
1646 else if (pix_y
> FRAME_LINES (f
))
1647 pix_y
= FRAME_LINES (f
);
1657 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1658 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1659 can't tell the positions because W's display is not up to date,
1663 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1666 int *frame_x
, *frame_y
;
1668 #ifdef HAVE_WINDOW_SYSTEM
1669 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1673 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1674 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1676 if (display_completed
)
1678 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1679 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1680 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1686 hpos
+= glyph
->pixel_width
;
1690 /* If first glyph is partially visible, its first visible position is still 0. */
1702 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1703 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1714 #ifdef HAVE_WINDOW_SYSTEM
1716 /* Find the glyph under window-relative coordinates X/Y in window W.
1717 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1718 strings. Return in *HPOS and *VPOS the row and column number of
1719 the glyph found. Return in *AREA the glyph area containing X.
1720 Value is a pointer to the glyph found or null if X/Y is not on
1721 text, or we can't tell because W's current matrix is not up to
1724 static struct glyph
*
1725 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1728 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1730 struct glyph
*glyph
, *end
;
1731 struct glyph_row
*row
= NULL
;
1734 /* Find row containing Y. Give up if some row is not enabled. */
1735 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1737 row
= MATRIX_ROW (w
->current_matrix
, i
);
1738 if (!row
->enabled_p
)
1740 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1747 /* Give up if Y is not in the window. */
1748 if (i
== w
->current_matrix
->nrows
)
1751 /* Get the glyph area containing X. */
1752 if (w
->pseudo_window_p
)
1759 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1761 *area
= LEFT_MARGIN_AREA
;
1762 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1764 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1767 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1771 *area
= RIGHT_MARGIN_AREA
;
1772 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1776 /* Find glyph containing X. */
1777 glyph
= row
->glyphs
[*area
];
1778 end
= glyph
+ row
->used
[*area
];
1780 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1782 x
-= glyph
->pixel_width
;
1792 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1795 *hpos
= glyph
- row
->glyphs
[*area
];
1801 Convert frame-relative x/y to coordinates relative to window W.
1802 Takes pseudo-windows into account. */
1805 frame_to_window_pixel_xy (w
, x
, y
)
1809 if (w
->pseudo_window_p
)
1811 /* A pseudo-window is always full-width, and starts at the
1812 left edge of the frame, plus a frame border. */
1813 struct frame
*f
= XFRAME (w
->frame
);
1814 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1815 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1819 *x
-= WINDOW_LEFT_EDGE_X (w
);
1820 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1825 Return in RECTS[] at most N clipping rectangles for glyph string S.
1826 Return the number of stored rectangles. */
1829 get_glyph_string_clip_rects (s
, rects
, n
)
1830 struct glyph_string
*s
;
1831 NativeRectangle
*rects
;
1839 if (s
->row
->full_width_p
)
1841 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1842 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1843 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1845 /* Unless displaying a mode or menu bar line, which are always
1846 fully visible, clip to the visible part of the row. */
1847 if (s
->w
->pseudo_window_p
)
1848 r
.height
= s
->row
->visible_height
;
1850 r
.height
= s
->height
;
1854 /* This is a text line that may be partially visible. */
1855 r
.x
= window_box_left (s
->w
, s
->area
);
1856 r
.width
= window_box_width (s
->w
, s
->area
);
1857 r
.height
= s
->row
->visible_height
;
1861 if (r
.x
< s
->clip_head
->x
)
1863 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1864 r
.width
-= s
->clip_head
->x
- r
.x
;
1867 r
.x
= s
->clip_head
->x
;
1870 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1872 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1873 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1878 /* If S draws overlapping rows, it's sufficient to use the top and
1879 bottom of the window for clipping because this glyph string
1880 intentionally draws over other lines. */
1881 if (s
->for_overlaps
)
1883 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1884 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1886 /* Alas, the above simple strategy does not work for the
1887 environments with anti-aliased text: if the same text is
1888 drawn onto the same place multiple times, it gets thicker.
1889 If the overlap we are processing is for the erased cursor, we
1890 take the intersection with the rectagle of the cursor. */
1891 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1893 XRectangle rc
, r_save
= r
;
1895 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1896 rc
.y
= s
->w
->phys_cursor
.y
;
1897 rc
.width
= s
->w
->phys_cursor_width
;
1898 rc
.height
= s
->w
->phys_cursor_height
;
1900 x_intersect_rectangles (&r_save
, &rc
, &r
);
1905 /* Don't use S->y for clipping because it doesn't take partially
1906 visible lines into account. For example, it can be negative for
1907 partially visible lines at the top of a window. */
1908 if (!s
->row
->full_width_p
1909 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1910 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1912 r
.y
= max (0, s
->row
->y
);
1914 /* If drawing a tool-bar window, draw it over the internal border
1915 at the top of the window. */
1916 if (WINDOWP (s
->f
->tool_bar_window
)
1917 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1918 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1921 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1923 /* If drawing the cursor, don't let glyph draw outside its
1924 advertised boundaries. Cleartype does this under some circumstances. */
1925 if (s
->hl
== DRAW_CURSOR
)
1927 struct glyph
*glyph
= s
->first_glyph
;
1932 r
.width
-= s
->x
- r
.x
;
1935 r
.width
= min (r
.width
, glyph
->pixel_width
);
1937 /* If r.y is below window bottom, ensure that we still see a cursor. */
1938 height
= min (glyph
->ascent
+ glyph
->descent
,
1939 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1940 max_y
= window_text_bottom_y (s
->w
) - height
;
1941 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1942 if (s
->ybase
- glyph
->ascent
> max_y
)
1949 /* Don't draw cursor glyph taller than our actual glyph. */
1950 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1951 if (height
< r
.height
)
1953 max_y
= r
.y
+ r
.height
;
1954 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1955 r
.height
= min (max_y
- r
.y
, height
);
1962 XRectangle r_save
= r
;
1964 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1968 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1969 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1971 #ifdef CONVERT_FROM_XRECT
1972 CONVERT_FROM_XRECT (r
, *rects
);
1980 /* If we are processing overlapping and allowed to return
1981 multiple clipping rectangles, we exclude the row of the glyph
1982 string from the clipping rectangle. This is to avoid drawing
1983 the same text on the environment with anti-aliasing. */
1984 #ifdef CONVERT_FROM_XRECT
1987 XRectangle
*rs
= rects
;
1989 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1991 if (s
->for_overlaps
& OVERLAPS_PRED
)
1994 if (r
.y
+ r
.height
> row_y
)
1997 rs
[i
].height
= row_y
- r
.y
;
2003 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2006 if (r
.y
< row_y
+ s
->row
->visible_height
)
2008 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2010 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2011 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2020 #ifdef CONVERT_FROM_XRECT
2021 for (i
= 0; i
< n
; i
++)
2022 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2029 Return in *NR the clipping rectangle for glyph string S. */
2032 get_glyph_string_clip_rect (s
, nr
)
2033 struct glyph_string
*s
;
2034 NativeRectangle
*nr
;
2036 get_glyph_string_clip_rects (s
, nr
, 1);
2041 Return the position and height of the phys cursor in window W.
2042 Set w->phys_cursor_width to width of phys cursor.
2046 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2048 struct glyph_row
*row
;
2049 struct glyph
*glyph
;
2050 int *xp
, *yp
, *heightp
;
2052 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2053 int x
, y
, wd
, h
, h0
, y0
;
2055 /* Compute the width of the rectangle to draw. If on a stretch
2056 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2057 rectangle as wide as the glyph, but use a canonical character
2059 wd
= glyph
->pixel_width
- 1;
2064 x
= w
->phys_cursor
.x
;
2071 if (glyph
->type
== STRETCH_GLYPH
2072 && !x_stretch_cursor_p
)
2073 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2074 w
->phys_cursor_width
= wd
;
2076 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2078 /* If y is below window bottom, ensure that we still see a cursor. */
2079 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2081 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2082 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2084 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2087 h
= max (h
- (y0
- y
) + 1, h0
);
2092 y0
= window_text_bottom_y (w
) - h0
;
2100 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2101 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2106 * Remember which glyph the mouse is over.
2110 remember_mouse_glyph (f
, gx
, gy
, rect
)
2113 NativeRectangle
*rect
;
2117 struct glyph_row
*r
, *gr
, *end_row
;
2118 enum window_part part
;
2119 enum glyph_row_area area
;
2120 int x
, y
, width
, height
;
2122 /* Try to determine frame pixel position and size of the glyph under
2123 frame pixel coordinates X/Y on frame F. */
2125 if (!f
->glyphs_initialized_p
2126 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2129 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2130 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2134 w
= XWINDOW (window
);
2135 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2136 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2138 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2139 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2141 if (w
->pseudo_window_p
)
2144 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2150 case ON_LEFT_MARGIN
:
2151 area
= LEFT_MARGIN_AREA
;
2154 case ON_RIGHT_MARGIN
:
2155 area
= RIGHT_MARGIN_AREA
;
2158 case ON_HEADER_LINE
:
2160 gr
= (part
== ON_HEADER_LINE
2161 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2162 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2165 goto text_glyph_row_found
;
2172 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2173 if (r
->y
+ r
->height
> y
)
2179 text_glyph_row_found
:
2182 struct glyph
*g
= gr
->glyphs
[area
];
2183 struct glyph
*end
= g
+ gr
->used
[area
];
2185 height
= gr
->height
;
2186 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2187 if (gx
+ g
->pixel_width
> x
)
2192 if (g
->type
== IMAGE_GLYPH
)
2194 /* Don't remember when mouse is over image, as
2195 image may have hot-spots. */
2196 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2199 width
= g
->pixel_width
;
2203 /* Use nominal char spacing at end of line. */
2205 gx
+= (x
/ width
) * width
;
2208 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2209 gx
+= window_box_left_offset (w
, area
);
2213 /* Use nominal line height at end of window. */
2214 gx
= (x
/ width
) * width
;
2216 gy
+= (y
/ height
) * height
;
2220 case ON_LEFT_FRINGE
:
2221 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2222 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2223 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2224 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2227 case ON_RIGHT_FRINGE
:
2228 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2229 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2230 : window_box_right_offset (w
, TEXT_AREA
));
2231 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2235 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2237 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2238 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2239 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2241 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2245 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2246 if (r
->y
+ r
->height
> y
)
2253 height
= gr
->height
;
2256 /* Use nominal line height at end of window. */
2258 gy
+= (y
/ height
) * height
;
2265 /* If there is no glyph under the mouse, then we divide the screen
2266 into a grid of the smallest glyph in the frame, and use that
2269 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2270 round down even for negative values. */
2276 gx
= (gx
/ width
) * width
;
2277 gy
= (gy
/ height
) * height
;
2282 gx
+= WINDOW_LEFT_EDGE_X (w
);
2283 gy
+= WINDOW_TOP_EDGE_Y (w
);
2286 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2288 /* Visible feedback for debugging. */
2291 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2292 f
->output_data
.x
->normal_gc
,
2293 gx
, gy
, width
, height
);
2299 #endif /* HAVE_WINDOW_SYSTEM */
2302 /***********************************************************************
2303 Lisp form evaluation
2304 ***********************************************************************/
2306 /* Error handler for safe_eval and safe_call. */
2309 safe_eval_handler (arg
)
2312 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2317 /* Evaluate SEXPR and return the result, or nil if something went
2318 wrong. Prevent redisplay during the evaluation. */
2326 if (inhibit_eval_during_redisplay
)
2330 int count
= SPECPDL_INDEX ();
2331 struct gcpro gcpro1
;
2334 specbind (Qinhibit_redisplay
, Qt
);
2335 /* Use Qt to ensure debugger does not run,
2336 so there is no possibility of wanting to redisplay. */
2337 val
= internal_condition_case_1 (Feval
, sexpr
, Qt
,
2340 val
= unbind_to (count
, val
);
2347 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2348 Return the result, or nil if something went wrong. Prevent
2349 redisplay during the evaluation. */
2352 safe_call (nargs
, args
)
2358 if (inhibit_eval_during_redisplay
)
2362 int count
= SPECPDL_INDEX ();
2363 struct gcpro gcpro1
;
2366 gcpro1
.nvars
= nargs
;
2367 specbind (Qinhibit_redisplay
, Qt
);
2368 /* Use Qt to ensure debugger does not run,
2369 so there is no possibility of wanting to redisplay. */
2370 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2373 val
= unbind_to (count
, val
);
2380 /* Call function FN with one argument ARG.
2381 Return the result, or nil if something went wrong. */
2384 safe_call1 (fn
, arg
)
2385 Lisp_Object fn
, arg
;
2387 Lisp_Object args
[2];
2390 return safe_call (2, args
);
2395 /***********************************************************************
2397 ***********************************************************************/
2401 /* Define CHECK_IT to perform sanity checks on iterators.
2402 This is for debugging. It is too slow to do unconditionally. */
2408 if (it
->method
== GET_FROM_STRING
)
2410 xassert (STRINGP (it
->string
));
2411 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2415 xassert (IT_STRING_CHARPOS (*it
) < 0);
2416 if (it
->method
== GET_FROM_BUFFER
)
2418 /* Check that character and byte positions agree. */
2419 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2424 xassert (it
->current
.dpvec_index
>= 0);
2426 xassert (it
->current
.dpvec_index
< 0);
2429 #define CHECK_IT(IT) check_it ((IT))
2433 #define CHECK_IT(IT) (void) 0
2440 /* Check that the window end of window W is what we expect it
2441 to be---the last row in the current matrix displaying text. */
2444 check_window_end (w
)
2447 if (!MINI_WINDOW_P (w
)
2448 && !NILP (w
->window_end_valid
))
2450 struct glyph_row
*row
;
2451 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2452 XFASTINT (w
->window_end_vpos
)),
2454 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2455 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2459 #define CHECK_WINDOW_END(W) check_window_end ((W))
2461 #else /* not GLYPH_DEBUG */
2463 #define CHECK_WINDOW_END(W) (void) 0
2465 #endif /* not GLYPH_DEBUG */
2469 /***********************************************************************
2470 Iterator initialization
2471 ***********************************************************************/
2473 /* Initialize IT for displaying current_buffer in window W, starting
2474 at character position CHARPOS. CHARPOS < 0 means that no buffer
2475 position is specified which is useful when the iterator is assigned
2476 a position later. BYTEPOS is the byte position corresponding to
2477 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2479 If ROW is not null, calls to produce_glyphs with IT as parameter
2480 will produce glyphs in that row.
2482 BASE_FACE_ID is the id of a base face to use. It must be one of
2483 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2484 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2485 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2487 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2488 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2489 will be initialized to use the corresponding mode line glyph row of
2490 the desired matrix of W. */
2493 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2496 int charpos
, bytepos
;
2497 struct glyph_row
*row
;
2498 enum face_id base_face_id
;
2500 int highlight_region_p
;
2502 /* Some precondition checks. */
2503 xassert (w
!= NULL
&& it
!= NULL
);
2504 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2507 /* If face attributes have been changed since the last redisplay,
2508 free realized faces now because they depend on face definitions
2509 that might have changed. Don't free faces while there might be
2510 desired matrices pending which reference these faces. */
2511 if (face_change_count
&& !inhibit_free_realized_faces
)
2513 face_change_count
= 0;
2514 free_all_realized_faces (Qnil
);
2517 /* Use one of the mode line rows of W's desired matrix if
2521 if (base_face_id
== MODE_LINE_FACE_ID
2522 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2523 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2524 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2525 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2529 bzero (it
, sizeof *it
);
2530 it
->current
.overlay_string_index
= -1;
2531 it
->current
.dpvec_index
= -1;
2532 it
->base_face_id
= base_face_id
;
2534 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2536 /* The window in which we iterate over current_buffer: */
2537 XSETWINDOW (it
->window
, w
);
2539 it
->f
= XFRAME (w
->frame
);
2541 /* Extra space between lines (on window systems only). */
2542 if (base_face_id
== DEFAULT_FACE_ID
2543 && FRAME_WINDOW_P (it
->f
))
2545 if (NATNUMP (current_buffer
->extra_line_spacing
))
2546 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2547 else if (FLOATP (current_buffer
->extra_line_spacing
))
2548 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2549 * FRAME_LINE_HEIGHT (it
->f
));
2550 else if (it
->f
->extra_line_spacing
> 0)
2551 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2552 it
->max_extra_line_spacing
= 0;
2555 /* If realized faces have been removed, e.g. because of face
2556 attribute changes of named faces, recompute them. When running
2557 in batch mode, the face cache of the initial frame is null. If
2558 we happen to get called, make a dummy face cache. */
2559 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2560 init_frame_faces (it
->f
);
2561 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2562 recompute_basic_faces (it
->f
);
2564 /* Current value of the `slice', `space-width', and 'height' properties. */
2565 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2566 it
->space_width
= Qnil
;
2567 it
->font_height
= Qnil
;
2568 it
->override_ascent
= -1;
2570 /* Are control characters displayed as `^C'? */
2571 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2573 /* -1 means everything between a CR and the following line end
2574 is invisible. >0 means lines indented more than this value are
2576 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2577 ? XFASTINT (current_buffer
->selective_display
)
2578 : (!NILP (current_buffer
->selective_display
)
2580 it
->selective_display_ellipsis_p
2581 = !NILP (current_buffer
->selective_display_ellipses
);
2583 /* Display table to use. */
2584 it
->dp
= window_display_table (w
);
2586 /* Are multibyte characters enabled in current_buffer? */
2587 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2589 /* Non-zero if we should highlight the region. */
2591 = (!NILP (Vtransient_mark_mode
)
2592 && !NILP (current_buffer
->mark_active
)
2593 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2595 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2596 start and end of a visible region in window IT->w. Set both to
2597 -1 to indicate no region. */
2598 if (highlight_region_p
2599 /* Maybe highlight only in selected window. */
2600 && (/* Either show region everywhere. */
2601 highlight_nonselected_windows
2602 /* Or show region in the selected window. */
2603 || w
== XWINDOW (selected_window
)
2604 /* Or show the region if we are in the mini-buffer and W is
2605 the window the mini-buffer refers to. */
2606 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2607 && WINDOWP (minibuf_selected_window
)
2608 && w
== XWINDOW (minibuf_selected_window
))))
2610 int charpos
= marker_position (current_buffer
->mark
);
2611 it
->region_beg_charpos
= min (PT
, charpos
);
2612 it
->region_end_charpos
= max (PT
, charpos
);
2615 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2617 /* Get the position at which the redisplay_end_trigger hook should
2618 be run, if it is to be run at all. */
2619 if (MARKERP (w
->redisplay_end_trigger
)
2620 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2621 it
->redisplay_end_trigger_charpos
2622 = marker_position (w
->redisplay_end_trigger
);
2623 else if (INTEGERP (w
->redisplay_end_trigger
))
2624 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2626 /* Correct bogus values of tab_width. */
2627 it
->tab_width
= XINT (current_buffer
->tab_width
);
2628 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2631 /* Are lines in the display truncated? */
2632 it
->truncate_lines_p
2633 = (base_face_id
!= DEFAULT_FACE_ID
2634 || XINT (it
->w
->hscroll
)
2635 || (truncate_partial_width_windows
2636 && !WINDOW_FULL_WIDTH_P (it
->w
))
2637 || !NILP (current_buffer
->truncate_lines
));
2639 /* Get dimensions of truncation and continuation glyphs. These are
2640 displayed as fringe bitmaps under X, so we don't need them for such
2642 if (!FRAME_WINDOW_P (it
->f
))
2644 if (it
->truncate_lines_p
)
2646 /* We will need the truncation glyph. */
2647 xassert (it
->glyph_row
== NULL
);
2648 produce_special_glyphs (it
, IT_TRUNCATION
);
2649 it
->truncation_pixel_width
= it
->pixel_width
;
2653 /* We will need the continuation glyph. */
2654 xassert (it
->glyph_row
== NULL
);
2655 produce_special_glyphs (it
, IT_CONTINUATION
);
2656 it
->continuation_pixel_width
= it
->pixel_width
;
2659 /* Reset these values to zero because the produce_special_glyphs
2660 above has changed them. */
2661 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2662 it
->phys_ascent
= it
->phys_descent
= 0;
2665 /* Set this after getting the dimensions of truncation and
2666 continuation glyphs, so that we don't produce glyphs when calling
2667 produce_special_glyphs, above. */
2668 it
->glyph_row
= row
;
2669 it
->area
= TEXT_AREA
;
2671 /* Get the dimensions of the display area. The display area
2672 consists of the visible window area plus a horizontally scrolled
2673 part to the left of the window. All x-values are relative to the
2674 start of this total display area. */
2675 if (base_face_id
!= DEFAULT_FACE_ID
)
2677 /* Mode lines, menu bar in terminal frames. */
2678 it
->first_visible_x
= 0;
2679 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2684 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2685 it
->last_visible_x
= (it
->first_visible_x
2686 + window_box_width (w
, TEXT_AREA
));
2688 /* If we truncate lines, leave room for the truncator glyph(s) at
2689 the right margin. Otherwise, leave room for the continuation
2690 glyph(s). Truncation and continuation glyphs are not inserted
2691 for window-based redisplay. */
2692 if (!FRAME_WINDOW_P (it
->f
))
2694 if (it
->truncate_lines_p
)
2695 it
->last_visible_x
-= it
->truncation_pixel_width
;
2697 it
->last_visible_x
-= it
->continuation_pixel_width
;
2700 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2701 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2704 /* Leave room for a border glyph. */
2705 if (!FRAME_WINDOW_P (it
->f
)
2706 && !WINDOW_RIGHTMOST_P (it
->w
))
2707 it
->last_visible_x
-= 1;
2709 it
->last_visible_y
= window_text_bottom_y (w
);
2711 /* For mode lines and alike, arrange for the first glyph having a
2712 left box line if the face specifies a box. */
2713 if (base_face_id
!= DEFAULT_FACE_ID
)
2717 it
->face_id
= base_face_id
;
2719 /* If we have a boxed mode line, make the first character appear
2720 with a left box line. */
2721 face
= FACE_FROM_ID (it
->f
, base_face_id
);
2722 if (face
->box
!= FACE_NO_BOX
)
2723 it
->start_of_box_run_p
= 1;
2726 /* If a buffer position was specified, set the iterator there,
2727 getting overlays and face properties from that position. */
2728 if (charpos
>= BUF_BEG (current_buffer
))
2730 it
->end_charpos
= ZV
;
2732 IT_CHARPOS (*it
) = charpos
;
2734 /* Compute byte position if not specified. */
2735 if (bytepos
< charpos
)
2736 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2738 IT_BYTEPOS (*it
) = bytepos
;
2740 it
->start
= it
->current
;
2742 /* Compute faces etc. */
2743 reseat (it
, it
->current
.pos
, 1);
2750 /* Initialize IT for the display of window W with window start POS. */
2753 start_display (it
, w
, pos
)
2756 struct text_pos pos
;
2758 struct glyph_row
*row
;
2759 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2761 row
= w
->desired_matrix
->rows
+ first_vpos
;
2762 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2763 it
->first_vpos
= first_vpos
;
2765 /* Don't reseat to previous visible line start if current start
2766 position is in a string or image. */
2767 if (it
->method
== GET_FROM_BUFFER
&& !it
->truncate_lines_p
)
2769 int start_at_line_beg_p
;
2770 int first_y
= it
->current_y
;
2772 /* If window start is not at a line start, skip forward to POS to
2773 get the correct continuation lines width. */
2774 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2775 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2776 if (!start_at_line_beg_p
)
2780 reseat_at_previous_visible_line_start (it
);
2781 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2783 new_x
= it
->current_x
+ it
->pixel_width
;
2785 /* If lines are continued, this line may end in the middle
2786 of a multi-glyph character (e.g. a control character
2787 displayed as \003, or in the middle of an overlay
2788 string). In this case move_it_to above will not have
2789 taken us to the start of the continuation line but to the
2790 end of the continued line. */
2791 if (it
->current_x
> 0
2792 && !it
->truncate_lines_p
/* Lines are continued. */
2793 && (/* And glyph doesn't fit on the line. */
2794 new_x
> it
->last_visible_x
2795 /* Or it fits exactly and we're on a window
2797 || (new_x
== it
->last_visible_x
2798 && FRAME_WINDOW_P (it
->f
))))
2800 if (it
->current
.dpvec_index
>= 0
2801 || it
->current
.overlay_string_index
>= 0)
2803 set_iterator_to_next (it
, 1);
2804 move_it_in_display_line_to (it
, -1, -1, 0);
2807 it
->continuation_lines_width
+= it
->current_x
;
2810 /* We're starting a new display line, not affected by the
2811 height of the continued line, so clear the appropriate
2812 fields in the iterator structure. */
2813 it
->max_ascent
= it
->max_descent
= 0;
2814 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2816 it
->current_y
= first_y
;
2818 it
->current_x
= it
->hpos
= 0;
2822 #if 0 /* Don't assert the following because start_display is sometimes
2823 called intentionally with a window start that is not at a
2824 line start. Please leave this code in as a comment. */
2826 /* Window start should be on a line start, now. */
2827 xassert (it
->continuation_lines_width
2828 || IT_CHARPOS (it
) == BEGV
2829 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2834 /* Return 1 if POS is a position in ellipses displayed for invisible
2835 text. W is the window we display, for text property lookup. */
2838 in_ellipses_for_invisible_text_p (pos
, w
)
2839 struct display_pos
*pos
;
2842 Lisp_Object prop
, window
;
2844 int charpos
= CHARPOS (pos
->pos
);
2846 /* If POS specifies a position in a display vector, this might
2847 be for an ellipsis displayed for invisible text. We won't
2848 get the iterator set up for delivering that ellipsis unless
2849 we make sure that it gets aware of the invisible text. */
2850 if (pos
->dpvec_index
>= 0
2851 && pos
->overlay_string_index
< 0
2852 && CHARPOS (pos
->string_pos
) < 0
2854 && (XSETWINDOW (window
, w
),
2855 prop
= Fget_char_property (make_number (charpos
),
2856 Qinvisible
, window
),
2857 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2859 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2861 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2868 /* Initialize IT for stepping through current_buffer in window W,
2869 starting at position POS that includes overlay string and display
2870 vector/ control character translation position information. Value
2871 is zero if there are overlay strings with newlines at POS. */
2874 init_from_display_pos (it
, w
, pos
)
2877 struct display_pos
*pos
;
2879 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2880 int i
, overlay_strings_with_newlines
= 0;
2882 /* If POS specifies a position in a display vector, this might
2883 be for an ellipsis displayed for invisible text. We won't
2884 get the iterator set up for delivering that ellipsis unless
2885 we make sure that it gets aware of the invisible text. */
2886 if (in_ellipses_for_invisible_text_p (pos
, w
))
2892 /* Keep in mind: the call to reseat in init_iterator skips invisible
2893 text, so we might end up at a position different from POS. This
2894 is only a problem when POS is a row start after a newline and an
2895 overlay starts there with an after-string, and the overlay has an
2896 invisible property. Since we don't skip invisible text in
2897 display_line and elsewhere immediately after consuming the
2898 newline before the row start, such a POS will not be in a string,
2899 but the call to init_iterator below will move us to the
2901 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2903 /* This only scans the current chunk -- it should scan all chunks.
2904 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2905 to 16 in 22.1 to make this a lesser problem. */
2906 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2908 const char *s
= SDATA (it
->overlay_strings
[i
]);
2909 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2911 while (s
< e
&& *s
!= '\n')
2916 overlay_strings_with_newlines
= 1;
2921 /* If position is within an overlay string, set up IT to the right
2923 if (pos
->overlay_string_index
>= 0)
2927 /* If the first overlay string happens to have a `display'
2928 property for an image, the iterator will be set up for that
2929 image, and we have to undo that setup first before we can
2930 correct the overlay string index. */
2931 if (it
->method
== GET_FROM_IMAGE
)
2934 /* We already have the first chunk of overlay strings in
2935 IT->overlay_strings. Load more until the one for
2936 pos->overlay_string_index is in IT->overlay_strings. */
2937 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2939 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2940 it
->current
.overlay_string_index
= 0;
2943 load_overlay_strings (it
, 0);
2944 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2948 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2949 relative_index
= (it
->current
.overlay_string_index
2950 % OVERLAY_STRING_CHUNK_SIZE
);
2951 it
->string
= it
->overlay_strings
[relative_index
];
2952 xassert (STRINGP (it
->string
));
2953 it
->current
.string_pos
= pos
->string_pos
;
2954 it
->method
= GET_FROM_STRING
;
2957 #if 0 /* This is bogus because POS not having an overlay string
2958 position does not mean it's after the string. Example: A
2959 line starting with a before-string and initialization of IT
2960 to the previous row's end position. */
2961 else if (it
->current
.overlay_string_index
>= 0)
2963 /* If POS says we're already after an overlay string ending at
2964 POS, make sure to pop the iterator because it will be in
2965 front of that overlay string. When POS is ZV, we've thereby
2966 also ``processed'' overlay strings at ZV. */
2969 xassert (it
->current
.overlay_string_index
== -1);
2970 xassert (it
->method
== GET_FROM_BUFFER
);
2971 if (CHARPOS (pos
->pos
) == ZV
)
2972 it
->overlay_strings_at_end_processed_p
= 1;
2976 if (CHARPOS (pos
->string_pos
) >= 0)
2978 /* Recorded position is not in an overlay string, but in another
2979 string. This can only be a string from a `display' property.
2980 IT should already be filled with that string. */
2981 it
->current
.string_pos
= pos
->string_pos
;
2982 xassert (STRINGP (it
->string
));
2985 /* Restore position in display vector translations, control
2986 character translations or ellipses. */
2987 if (pos
->dpvec_index
>= 0)
2989 if (it
->dpvec
== NULL
)
2990 get_next_display_element (it
);
2991 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2992 it
->current
.dpvec_index
= pos
->dpvec_index
;
2996 return !overlay_strings_with_newlines
;
3000 /* Initialize IT for stepping through current_buffer in window W
3001 starting at ROW->start. */
3004 init_to_row_start (it
, w
, row
)
3007 struct glyph_row
*row
;
3009 init_from_display_pos (it
, w
, &row
->start
);
3010 it
->start
= row
->start
;
3011 it
->continuation_lines_width
= row
->continuation_lines_width
;
3016 /* Initialize IT for stepping through current_buffer in window W
3017 starting in the line following ROW, i.e. starting at ROW->end.
3018 Value is zero if there are overlay strings with newlines at ROW's
3022 init_to_row_end (it
, w
, row
)
3025 struct glyph_row
*row
;
3029 if (init_from_display_pos (it
, w
, &row
->end
))
3031 if (row
->continued_p
)
3032 it
->continuation_lines_width
3033 = row
->continuation_lines_width
+ row
->pixel_width
;
3044 /***********************************************************************
3046 ***********************************************************************/
3048 /* Called when IT reaches IT->stop_charpos. Handle text property and
3049 overlay changes. Set IT->stop_charpos to the next position where
3056 enum prop_handled handled
;
3057 int handle_overlay_change_p
;
3061 it
->current
.dpvec_index
= -1;
3062 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3063 it
->ignore_overlay_strings_at_pos_p
= 0;
3065 /* Use face of preceding text for ellipsis (if invisible) */
3066 if (it
->selective_display_ellipsis_p
)
3067 it
->saved_face_id
= it
->face_id
;
3071 handled
= HANDLED_NORMALLY
;
3073 /* Call text property handlers. */
3074 for (p
= it_props
; p
->handler
; ++p
)
3076 handled
= p
->handler (it
);
3078 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3080 else if (handled
== HANDLED_RETURN
)
3082 /* We still want to show before and after strings from
3083 overlays even if the actual buffer text is replaced. */
3084 if (!handle_overlay_change_p
|| it
->sp
> 1)
3086 if (!get_overlay_strings_1 (it
, 0, 0))
3088 it
->ignore_overlay_strings_at_pos_p
= 1;
3089 it
->string_from_display_prop_p
= 0;
3090 handle_overlay_change_p
= 0;
3091 handled
= HANDLED_RECOMPUTE_PROPS
;
3094 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3095 handle_overlay_change_p
= 0;
3098 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3100 /* Don't check for overlay strings below when set to deliver
3101 characters from a display vector. */
3102 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3103 handle_overlay_change_p
= 0;
3105 /* Handle overlay changes.
3106 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3107 if it finds overlays. */
3108 if (handle_overlay_change_p
)
3109 handled
= handle_overlay_change (it
);
3112 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3114 /* Determine where to stop next. */
3115 if (handled
== HANDLED_NORMALLY
)
3116 compute_stop_pos (it
);
3120 /* Compute IT->stop_charpos from text property and overlay change
3121 information for IT's current position. */
3124 compute_stop_pos (it
)
3127 register INTERVAL iv
, next_iv
;
3128 Lisp_Object object
, limit
, position
;
3130 /* If nowhere else, stop at the end. */
3131 it
->stop_charpos
= it
->end_charpos
;
3133 if (STRINGP (it
->string
))
3135 /* Strings are usually short, so don't limit the search for
3137 object
= it
->string
;
3139 position
= make_number (IT_STRING_CHARPOS (*it
));
3145 /* If next overlay change is in front of the current stop pos
3146 (which is IT->end_charpos), stop there. Note: value of
3147 next_overlay_change is point-max if no overlay change
3149 charpos
= next_overlay_change (IT_CHARPOS (*it
));
3150 if (charpos
< it
->stop_charpos
)
3151 it
->stop_charpos
= charpos
;
3153 /* If showing the region, we have to stop at the region
3154 start or end because the face might change there. */
3155 if (it
->region_beg_charpos
> 0)
3157 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3158 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3159 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3160 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3163 /* Set up variables for computing the stop position from text
3164 property changes. */
3165 XSETBUFFER (object
, current_buffer
);
3166 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3167 position
= make_number (IT_CHARPOS (*it
));
3171 /* Get the interval containing IT's position. Value is a null
3172 interval if there isn't such an interval. */
3173 iv
= validate_interval_range (object
, &position
, &position
, 0);
3174 if (!NULL_INTERVAL_P (iv
))
3176 Lisp_Object values_here
[LAST_PROP_IDX
];
3179 /* Get properties here. */
3180 for (p
= it_props
; p
->handler
; ++p
)
3181 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3183 /* Look for an interval following iv that has different
3185 for (next_iv
= next_interval (iv
);
3186 (!NULL_INTERVAL_P (next_iv
)
3188 || XFASTINT (limit
) > next_iv
->position
));
3189 next_iv
= next_interval (next_iv
))
3191 for (p
= it_props
; p
->handler
; ++p
)
3193 Lisp_Object new_value
;
3195 new_value
= textget (next_iv
->plist
, *p
->name
);
3196 if (!EQ (values_here
[p
->idx
], new_value
))
3204 if (!NULL_INTERVAL_P (next_iv
))
3206 if (INTEGERP (limit
)
3207 && next_iv
->position
>= XFASTINT (limit
))
3208 /* No text property change up to limit. */
3209 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3211 /* Text properties change in next_iv. */
3212 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3216 xassert (STRINGP (it
->string
)
3217 || (it
->stop_charpos
>= BEGV
3218 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3222 /* Return the position of the next overlay change after POS in
3223 current_buffer. Value is point-max if no overlay change
3224 follows. This is like `next-overlay-change' but doesn't use
3228 next_overlay_change (pos
)
3233 Lisp_Object
*overlays
;
3236 /* Get all overlays at the given position. */
3237 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3239 /* If any of these overlays ends before endpos,
3240 use its ending point instead. */
3241 for (i
= 0; i
< noverlays
; ++i
)
3246 oend
= OVERLAY_END (overlays
[i
]);
3247 oendpos
= OVERLAY_POSITION (oend
);
3248 endpos
= min (endpos
, oendpos
);
3256 /***********************************************************************
3258 ***********************************************************************/
3260 /* Handle changes in the `fontified' property of the current buffer by
3261 calling hook functions from Qfontification_functions to fontify
3264 static enum prop_handled
3265 handle_fontified_prop (it
)
3268 Lisp_Object prop
, pos
;
3269 enum prop_handled handled
= HANDLED_NORMALLY
;
3271 if (!NILP (Vmemory_full
))
3274 /* Get the value of the `fontified' property at IT's current buffer
3275 position. (The `fontified' property doesn't have a special
3276 meaning in strings.) If the value is nil, call functions from
3277 Qfontification_functions. */
3278 if (!STRINGP (it
->string
)
3280 && !NILP (Vfontification_functions
)
3281 && !NILP (Vrun_hooks
)
3282 && (pos
= make_number (IT_CHARPOS (*it
)),
3283 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3284 /* Ignore the special cased nil value always present at EOB since
3285 no amount of fontifying will be able to change it. */
3286 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3288 int count
= SPECPDL_INDEX ();
3291 val
= Vfontification_functions
;
3292 specbind (Qfontification_functions
, Qnil
);
3294 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3295 safe_call1 (val
, pos
);
3298 Lisp_Object globals
, fn
;
3299 struct gcpro gcpro1
, gcpro2
;
3302 GCPRO2 (val
, globals
);
3304 for (; CONSP (val
); val
= XCDR (val
))
3310 /* A value of t indicates this hook has a local
3311 binding; it means to run the global binding too.
3312 In a global value, t should not occur. If it
3313 does, we must ignore it to avoid an endless
3315 for (globals
= Fdefault_value (Qfontification_functions
);
3317 globals
= XCDR (globals
))
3319 fn
= XCAR (globals
);
3321 safe_call1 (fn
, pos
);
3325 safe_call1 (fn
, pos
);
3331 unbind_to (count
, Qnil
);
3333 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3334 something. This avoids an endless loop if they failed to
3335 fontify the text for which reason ever. */
3336 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3337 handled
= HANDLED_RECOMPUTE_PROPS
;
3345 /***********************************************************************
3347 ***********************************************************************/
3349 /* Set up iterator IT from face properties at its current position.
3350 Called from handle_stop. */
3352 static enum prop_handled
3353 handle_face_prop (it
)
3356 int new_face_id
, next_stop
;
3358 if (!STRINGP (it
->string
))
3361 = face_at_buffer_position (it
->w
,
3363 it
->region_beg_charpos
,
3364 it
->region_end_charpos
,
3367 + TEXT_PROP_DISTANCE_LIMIT
),
3370 /* Is this a start of a run of characters with box face?
3371 Caveat: this can be called for a freshly initialized
3372 iterator; face_id is -1 in this case. We know that the new
3373 face will not change until limit, i.e. if the new face has a
3374 box, all characters up to limit will have one. But, as
3375 usual, we don't know whether limit is really the end. */
3376 if (new_face_id
!= it
->face_id
)
3378 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3380 /* If new face has a box but old face has not, this is
3381 the start of a run of characters with box, i.e. it has
3382 a shadow on the left side. The value of face_id of the
3383 iterator will be -1 if this is the initial call that gets
3384 the face. In this case, we have to look in front of IT's
3385 position and see whether there is a face != new_face_id. */
3386 it
->start_of_box_run_p
3387 = (new_face
->box
!= FACE_NO_BOX
3388 && (it
->face_id
>= 0
3389 || IT_CHARPOS (*it
) == BEG
3390 || new_face_id
!= face_before_it_pos (it
)));
3391 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3396 int base_face_id
, bufpos
;
3398 Lisp_Object from_overlay
3399 = (it
->current
.overlay_string_index
>= 0
3400 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3403 /* See if we got to this string directly or indirectly from
3404 an overlay property. That includes the before-string or
3405 after-string of an overlay, strings in display properties
3406 provided by an overlay, their text properties, etc.
3408 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3409 if (! NILP (from_overlay
))
3410 for (i
= it
->sp
- 1; i
>= 0; i
--)
3412 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3414 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3415 else if (! NILP (it
->stack
[i
].from_overlay
))
3416 from_overlay
= it
->stack
[i
].from_overlay
;
3418 if (!NILP (from_overlay
))
3422 if (! NILP (from_overlay
))
3424 bufpos
= IT_CHARPOS (*it
);
3425 /* For a string from an overlay, the base face depends
3426 only on text properties and ignores overlays. */
3428 = face_for_overlay_string (it
->w
,
3430 it
->region_beg_charpos
,
3431 it
->region_end_charpos
,
3434 + TEXT_PROP_DISTANCE_LIMIT
),
3442 /* For strings from a `display' property, use the face at
3443 IT's current buffer position as the base face to merge
3444 with, so that overlay strings appear in the same face as
3445 surrounding text, unless they specify their own
3447 base_face_id
= underlying_face_id (it
);
3450 new_face_id
= face_at_string_position (it
->w
,
3452 IT_STRING_CHARPOS (*it
),
3454 it
->region_beg_charpos
,
3455 it
->region_end_charpos
,
3459 #if 0 /* This shouldn't be neccessary. Let's check it. */
3460 /* If IT is used to display a mode line we would really like to
3461 use the mode line face instead of the frame's default face. */
3462 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3463 && new_face_id
== DEFAULT_FACE_ID
)
3464 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3467 /* Is this a start of a run of characters with box? Caveat:
3468 this can be called for a freshly allocated iterator; face_id
3469 is -1 is this case. We know that the new face will not
3470 change until the next check pos, i.e. if the new face has a
3471 box, all characters up to that position will have a
3472 box. But, as usual, we don't know whether that position
3473 is really the end. */
3474 if (new_face_id
!= it
->face_id
)
3476 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3477 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3479 /* If new face has a box but old face hasn't, this is the
3480 start of a run of characters with box, i.e. it has a
3481 shadow on the left side. */
3482 it
->start_of_box_run_p
3483 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3484 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3488 it
->face_id
= new_face_id
;
3489 return HANDLED_NORMALLY
;
3493 /* Return the ID of the face ``underlying'' IT's current position,
3494 which is in a string. If the iterator is associated with a
3495 buffer, return the face at IT's current buffer position.
3496 Otherwise, use the iterator's base_face_id. */
3499 underlying_face_id (it
)
3502 int face_id
= it
->base_face_id
, i
;
3504 xassert (STRINGP (it
->string
));
3506 for (i
= it
->sp
- 1; i
>= 0; --i
)
3507 if (NILP (it
->stack
[i
].string
))
3508 face_id
= it
->stack
[i
].face_id
;
3514 /* Compute the face one character before or after the current position
3515 of IT. BEFORE_P non-zero means get the face in front of IT's
3516 position. Value is the id of the face. */
3519 face_before_or_after_it_pos (it
, before_p
)
3524 int next_check_charpos
;
3525 struct text_pos pos
;
3527 xassert (it
->s
== NULL
);
3529 if (STRINGP (it
->string
))
3531 int bufpos
, base_face_id
;
3533 /* No face change past the end of the string (for the case
3534 we are padding with spaces). No face change before the
3536 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3537 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3540 /* Set pos to the position before or after IT's current position. */
3542 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3544 /* For composition, we must check the character after the
3546 pos
= (it
->what
== IT_COMPOSITION
3547 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
3548 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3550 if (it
->current
.overlay_string_index
>= 0)
3551 bufpos
= IT_CHARPOS (*it
);
3555 base_face_id
= underlying_face_id (it
);
3557 /* Get the face for ASCII, or unibyte. */
3558 face_id
= face_at_string_position (it
->w
,
3562 it
->region_beg_charpos
,
3563 it
->region_end_charpos
,
3564 &next_check_charpos
,
3567 /* Correct the face for charsets different from ASCII. Do it
3568 for the multibyte case only. The face returned above is
3569 suitable for unibyte text if IT->string is unibyte. */
3570 if (STRING_MULTIBYTE (it
->string
))
3572 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3573 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3575 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3577 c
= string_char_and_length (p
, rest
, &len
);
3578 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3583 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3584 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3587 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3588 pos
= it
->current
.pos
;
3591 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3594 if (it
->what
== IT_COMPOSITION
)
3595 /* For composition, we must check the position after the
3597 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
3599 INC_TEXT_POS (pos
, it
->multibyte_p
);
3602 /* Determine face for CHARSET_ASCII, or unibyte. */
3603 face_id
= face_at_buffer_position (it
->w
,
3605 it
->region_beg_charpos
,
3606 it
->region_end_charpos
,
3607 &next_check_charpos
,
3610 /* Correct the face for charsets different from ASCII. Do it
3611 for the multibyte case only. The face returned above is
3612 suitable for unibyte text if current_buffer is unibyte. */
3613 if (it
->multibyte_p
)
3615 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3616 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3617 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3626 /***********************************************************************
3628 ***********************************************************************/
3630 /* Set up iterator IT from invisible properties at its current
3631 position. Called from handle_stop. */
3633 static enum prop_handled
3634 handle_invisible_prop (it
)
3637 enum prop_handled handled
= HANDLED_NORMALLY
;
3639 if (STRINGP (it
->string
))
3641 extern Lisp_Object Qinvisible
;
3642 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3644 /* Get the value of the invisible text property at the
3645 current position. Value will be nil if there is no such
3647 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3648 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3651 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3653 handled
= HANDLED_RECOMPUTE_PROPS
;
3655 /* Get the position at which the next change of the
3656 invisible text property can be found in IT->string.
3657 Value will be nil if the property value is the same for
3658 all the rest of IT->string. */
3659 XSETINT (limit
, SCHARS (it
->string
));
3660 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3663 /* Text at current position is invisible. The next
3664 change in the property is at position end_charpos.
3665 Move IT's current position to that position. */
3666 if (INTEGERP (end_charpos
)
3667 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3669 struct text_pos old
;
3670 old
= it
->current
.string_pos
;
3671 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3672 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3676 /* The rest of the string is invisible. If this is an
3677 overlay string, proceed with the next overlay string
3678 or whatever comes and return a character from there. */
3679 if (it
->current
.overlay_string_index
>= 0)
3681 next_overlay_string (it
);
3682 /* Don't check for overlay strings when we just
3683 finished processing them. */
3684 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3688 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3689 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3697 EMACS_INT newpos
, next_stop
, start_charpos
;
3698 Lisp_Object pos
, prop
, overlay
;
3700 /* First of all, is there invisible text at this position? */
3701 start_charpos
= IT_CHARPOS (*it
);
3702 pos
= make_number (IT_CHARPOS (*it
));
3703 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3705 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3707 /* If we are on invisible text, skip over it. */
3708 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3710 /* Record whether we have to display an ellipsis for the
3712 int display_ellipsis_p
= invis_p
== 2;
3714 handled
= HANDLED_RECOMPUTE_PROPS
;
3716 /* Loop skipping over invisible text. The loop is left at
3717 ZV or with IT on the first char being visible again. */
3720 /* Try to skip some invisible text. Return value is the
3721 position reached which can be equal to IT's position
3722 if there is nothing invisible here. This skips both
3723 over invisible text properties and overlays with
3724 invisible property. */
3725 newpos
= skip_invisible (IT_CHARPOS (*it
),
3726 &next_stop
, ZV
, it
->window
);
3728 /* If we skipped nothing at all we weren't at invisible
3729 text in the first place. If everything to the end of
3730 the buffer was skipped, end the loop. */
3731 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3735 /* We skipped some characters but not necessarily
3736 all there are. Check if we ended up on visible
3737 text. Fget_char_property returns the property of
3738 the char before the given position, i.e. if we
3739 get invis_p = 0, this means that the char at
3740 newpos is visible. */
3741 pos
= make_number (newpos
);
3742 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3743 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3746 /* If we ended up on invisible text, proceed to
3747 skip starting with next_stop. */
3749 IT_CHARPOS (*it
) = next_stop
;
3751 /* If there are adjacent invisible texts, don't lose the
3752 second one's ellipsis. */
3754 display_ellipsis_p
= 1;
3758 /* The position newpos is now either ZV or on visible text. */
3759 IT_CHARPOS (*it
) = newpos
;
3760 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3762 /* If there are before-strings at the start of invisible
3763 text, and the text is invisible because of a text
3764 property, arrange to show before-strings because 20.x did
3765 it that way. (If the text is invisible because of an
3766 overlay property instead of a text property, this is
3767 already handled in the overlay code.) */
3769 && get_overlay_strings (it
, start_charpos
))
3771 handled
= HANDLED_RECOMPUTE_PROPS
;
3772 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3774 else if (display_ellipsis_p
)
3776 /* Make sure that the glyphs of the ellipsis will get
3777 correct `charpos' values. If we would not update
3778 it->position here, the glyphs would belong to the
3779 last visible character _before_ the invisible
3780 text, which confuses `set_cursor_from_row'.
3782 We use the last invisible position instead of the
3783 first because this way the cursor is always drawn on
3784 the first "." of the ellipsis, whenever PT is inside
3785 the invisible text. Otherwise the cursor would be
3786 placed _after_ the ellipsis when the point is after the
3787 first invisible character. */
3788 if (!STRINGP (it
->object
))
3790 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3791 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3793 setup_for_ellipsis (it
, 0);
3794 /* Let the ellipsis display before
3795 considering any properties of the following char.
3796 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3797 handled
= HANDLED_RETURN
;
3806 /* Make iterator IT return `...' next.
3807 Replaces LEN characters from buffer. */
3810 setup_for_ellipsis (it
, len
)
3814 /* Use the display table definition for `...'. Invalid glyphs
3815 will be handled by the method returning elements from dpvec. */
3816 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3818 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3819 it
->dpvec
= v
->contents
;
3820 it
->dpend
= v
->contents
+ v
->size
;
3824 /* Default `...'. */
3825 it
->dpvec
= default_invis_vector
;
3826 it
->dpend
= default_invis_vector
+ 3;
3829 it
->dpvec_char_len
= len
;
3830 it
->current
.dpvec_index
= 0;
3831 it
->dpvec_face_id
= -1;
3833 /* Remember the current face id in case glyphs specify faces.
3834 IT's face is restored in set_iterator_to_next.
3835 saved_face_id was set to preceding char's face in handle_stop. */
3836 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3837 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3839 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3845 /***********************************************************************
3847 ***********************************************************************/
3849 /* Set up iterator IT from `display' property at its current position.
3850 Called from handle_stop.
3851 We return HANDLED_RETURN if some part of the display property
3852 overrides the display of the buffer text itself.
3853 Otherwise we return HANDLED_NORMALLY. */
3855 static enum prop_handled
3856 handle_display_prop (it
)
3859 Lisp_Object prop
, object
, overlay
;
3860 struct text_pos
*position
;
3861 /* Nonzero if some property replaces the display of the text itself. */
3862 int display_replaced_p
= 0;
3864 if (STRINGP (it
->string
))
3866 object
= it
->string
;
3867 position
= &it
->current
.string_pos
;
3871 XSETWINDOW (object
, it
->w
);
3872 position
= &it
->current
.pos
;
3875 /* Reset those iterator values set from display property values. */
3876 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3877 it
->space_width
= Qnil
;
3878 it
->font_height
= Qnil
;
3881 /* We don't support recursive `display' properties, i.e. string
3882 values that have a string `display' property, that have a string
3883 `display' property etc. */
3884 if (!it
->string_from_display_prop_p
)
3885 it
->area
= TEXT_AREA
;
3887 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3888 Qdisplay
, object
, &overlay
);
3890 return HANDLED_NORMALLY
;
3891 /* Now OVERLAY is the overlay that gave us this property, or nil
3892 if it was a text property. */
3894 if (!STRINGP (it
->string
))
3895 object
= it
->w
->buffer
;
3898 /* Simple properties. */
3899 && !EQ (XCAR (prop
), Qimage
)
3900 && !EQ (XCAR (prop
), Qspace
)
3901 && !EQ (XCAR (prop
), Qwhen
)
3902 && !EQ (XCAR (prop
), Qslice
)
3903 && !EQ (XCAR (prop
), Qspace_width
)
3904 && !EQ (XCAR (prop
), Qheight
)
3905 && !EQ (XCAR (prop
), Qraise
)
3906 /* Marginal area specifications. */
3907 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3908 && !EQ (XCAR (prop
), Qleft_fringe
)
3909 && !EQ (XCAR (prop
), Qright_fringe
)
3910 && !NILP (XCAR (prop
)))
3912 for (; CONSP (prop
); prop
= XCDR (prop
))
3914 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3915 position
, display_replaced_p
))
3917 display_replaced_p
= 1;
3918 /* If some text in a string is replaced, `position' no
3919 longer points to the position of `object'. */
3920 if (STRINGP (object
))
3925 else if (VECTORP (prop
))
3928 for (i
= 0; i
< ASIZE (prop
); ++i
)
3929 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3930 position
, display_replaced_p
))
3932 display_replaced_p
= 1;
3933 /* If some text in a string is replaced, `position' no
3934 longer points to the position of `object'. */
3935 if (STRINGP (object
))
3941 int ret
= handle_single_display_spec (it
, prop
, object
, overlay
,
3943 if (ret
< 0) /* Replaced by "", i.e. nothing. */
3944 return HANDLED_RECOMPUTE_PROPS
;
3946 display_replaced_p
= 1;
3949 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3953 /* Value is the position of the end of the `display' property starting
3954 at START_POS in OBJECT. */
3956 static struct text_pos
3957 display_prop_end (it
, object
, start_pos
)
3960 struct text_pos start_pos
;
3963 struct text_pos end_pos
;
3965 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3966 Qdisplay
, object
, Qnil
);
3967 CHARPOS (end_pos
) = XFASTINT (end
);
3968 if (STRINGP (object
))
3969 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3971 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3977 /* Set up IT from a single `display' specification PROP. OBJECT
3978 is the object in which the `display' property was found. *POSITION
3979 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3980 means that we previously saw a display specification which already
3981 replaced text display with something else, for example an image;
3982 we ignore such properties after the first one has been processed.
3984 OVERLAY is the overlay this `display' property came from,
3985 or nil if it was a text property.
3987 If PROP is a `space' or `image' specification, and in some other
3988 cases too, set *POSITION to the position where the `display'
3991 Value is non-zero if something was found which replaces the display
3992 of buffer or string text. Specifically, the value is -1 if that
3993 "something" is "nothing". */
3996 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
3997 display_replaced_before_p
)
4001 Lisp_Object overlay
;
4002 struct text_pos
*position
;
4003 int display_replaced_before_p
;
4006 Lisp_Object location
, value
;
4007 struct text_pos start_pos
, save_pos
;
4010 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4011 If the result is non-nil, use VALUE instead of SPEC. */
4013 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4022 if (!NILP (form
) && !EQ (form
, Qt
))
4024 int count
= SPECPDL_INDEX ();
4025 struct gcpro gcpro1
;
4027 /* Bind `object' to the object having the `display' property, a
4028 buffer or string. Bind `position' to the position in the
4029 object where the property was found, and `buffer-position'
4030 to the current position in the buffer. */
4031 specbind (Qobject
, object
);
4032 specbind (Qposition
, make_number (CHARPOS (*position
)));
4033 specbind (Qbuffer_position
,
4034 make_number (STRINGP (object
)
4035 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4037 form
= safe_eval (form
);
4039 unbind_to (count
, Qnil
);
4045 /* Handle `(height HEIGHT)' specifications. */
4047 && EQ (XCAR (spec
), Qheight
)
4048 && CONSP (XCDR (spec
)))
4050 if (!FRAME_WINDOW_P (it
->f
))
4053 it
->font_height
= XCAR (XCDR (spec
));
4054 if (!NILP (it
->font_height
))
4056 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4057 int new_height
= -1;
4059 if (CONSP (it
->font_height
)
4060 && (EQ (XCAR (it
->font_height
), Qplus
)
4061 || EQ (XCAR (it
->font_height
), Qminus
))
4062 && CONSP (XCDR (it
->font_height
))
4063 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4065 /* `(+ N)' or `(- N)' where N is an integer. */
4066 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4067 if (EQ (XCAR (it
->font_height
), Qplus
))
4069 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4071 else if (FUNCTIONP (it
->font_height
))
4073 /* Call function with current height as argument.
4074 Value is the new height. */
4076 height
= safe_call1 (it
->font_height
,
4077 face
->lface
[LFACE_HEIGHT_INDEX
]);
4078 if (NUMBERP (height
))
4079 new_height
= XFLOATINT (height
);
4081 else if (NUMBERP (it
->font_height
))
4083 /* Value is a multiple of the canonical char height. */
4086 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
4087 new_height
= (XFLOATINT (it
->font_height
)
4088 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4092 /* Evaluate IT->font_height with `height' bound to the
4093 current specified height to get the new height. */
4094 int count
= SPECPDL_INDEX ();
4096 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4097 value
= safe_eval (it
->font_height
);
4098 unbind_to (count
, Qnil
);
4100 if (NUMBERP (value
))
4101 new_height
= XFLOATINT (value
);
4105 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4111 /* Handle `(space-width WIDTH)'. */
4113 && EQ (XCAR (spec
), Qspace_width
)
4114 && CONSP (XCDR (spec
)))
4116 if (!FRAME_WINDOW_P (it
->f
))
4119 value
= XCAR (XCDR (spec
));
4120 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4121 it
->space_width
= value
;
4126 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4128 && EQ (XCAR (spec
), Qslice
))
4132 if (!FRAME_WINDOW_P (it
->f
))
4135 if (tem
= XCDR (spec
), CONSP (tem
))
4137 it
->slice
.x
= XCAR (tem
);
4138 if (tem
= XCDR (tem
), CONSP (tem
))
4140 it
->slice
.y
= XCAR (tem
);
4141 if (tem
= XCDR (tem
), CONSP (tem
))
4143 it
->slice
.width
= XCAR (tem
);
4144 if (tem
= XCDR (tem
), CONSP (tem
))
4145 it
->slice
.height
= XCAR (tem
);
4153 /* Handle `(raise FACTOR)'. */
4155 && EQ (XCAR (spec
), Qraise
)
4156 && CONSP (XCDR (spec
)))
4158 if (!FRAME_WINDOW_P (it
->f
))
4161 #ifdef HAVE_WINDOW_SYSTEM
4162 value
= XCAR (XCDR (spec
));
4163 if (NUMBERP (value
))
4165 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4166 it
->voffset
= - (XFLOATINT (value
)
4167 * (FONT_HEIGHT (face
->font
)));
4169 #endif /* HAVE_WINDOW_SYSTEM */
4174 /* Don't handle the other kinds of display specifications
4175 inside a string that we got from a `display' property. */
4176 if (it
->string_from_display_prop_p
)
4179 /* Characters having this form of property are not displayed, so
4180 we have to find the end of the property. */
4181 start_pos
= *position
;
4182 *position
= display_prop_end (it
, object
, start_pos
);
4185 /* Stop the scan at that end position--we assume that all
4186 text properties change there. */
4187 it
->stop_charpos
= position
->charpos
;
4189 /* Handle `(left-fringe BITMAP [FACE])'
4190 and `(right-fringe BITMAP [FACE])'. */
4192 && (EQ (XCAR (spec
), Qleft_fringe
)
4193 || EQ (XCAR (spec
), Qright_fringe
))
4194 && CONSP (XCDR (spec
)))
4196 int face_id
= DEFAULT_FACE_ID
;
4199 if (!FRAME_WINDOW_P (it
->f
))
4200 /* If we return here, POSITION has been advanced
4201 across the text with this property. */
4204 #ifdef HAVE_WINDOW_SYSTEM
4205 value
= XCAR (XCDR (spec
));
4206 if (!SYMBOLP (value
)
4207 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4208 /* If we return here, POSITION has been advanced
4209 across the text with this property. */
4212 if (CONSP (XCDR (XCDR (spec
))))
4214 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4215 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4221 /* Save current settings of IT so that we can restore them
4222 when we are finished with the glyph property value. */
4224 save_pos
= it
->position
;
4225 it
->position
= *position
;
4227 it
->position
= save_pos
;
4229 it
->area
= TEXT_AREA
;
4230 it
->what
= IT_IMAGE
;
4231 it
->image_id
= -1; /* no image */
4232 it
->position
= start_pos
;
4233 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4234 it
->method
= GET_FROM_IMAGE
;
4235 it
->from_overlay
= Qnil
;
4236 it
->face_id
= face_id
;
4238 /* Say that we haven't consumed the characters with
4239 `display' property yet. The call to pop_it in
4240 set_iterator_to_next will clean this up. */
4241 *position
= start_pos
;
4243 if (EQ (XCAR (spec
), Qleft_fringe
))
4245 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4246 it
->left_user_fringe_face_id
= face_id
;
4250 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4251 it
->right_user_fringe_face_id
= face_id
;
4253 #endif /* HAVE_WINDOW_SYSTEM */
4257 /* Prepare to handle `((margin left-margin) ...)',
4258 `((margin right-margin) ...)' and `((margin nil) ...)'
4259 prefixes for display specifications. */
4260 location
= Qunbound
;
4261 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4265 value
= XCDR (spec
);
4267 value
= XCAR (value
);
4270 if (EQ (XCAR (tem
), Qmargin
)
4271 && (tem
= XCDR (tem
),
4272 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4274 || EQ (tem
, Qleft_margin
)
4275 || EQ (tem
, Qright_margin
))))
4279 if (EQ (location
, Qunbound
))
4285 /* After this point, VALUE is the property after any
4286 margin prefix has been stripped. It must be a string,
4287 an image specification, or `(space ...)'.
4289 LOCATION specifies where to display: `left-margin',
4290 `right-margin' or nil. */
4292 valid_p
= (STRINGP (value
)
4293 #ifdef HAVE_WINDOW_SYSTEM
4294 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4295 #endif /* not HAVE_WINDOW_SYSTEM */
4296 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4298 if (valid_p
&& !display_replaced_before_p
)
4300 /* Save current settings of IT so that we can restore them
4301 when we are finished with the glyph property value. */
4302 save_pos
= it
->position
;
4303 it
->position
= *position
;
4305 it
->position
= save_pos
;
4306 it
->from_overlay
= overlay
;
4308 if (NILP (location
))
4309 it
->area
= TEXT_AREA
;
4310 else if (EQ (location
, Qleft_margin
))
4311 it
->area
= LEFT_MARGIN_AREA
;
4313 it
->area
= RIGHT_MARGIN_AREA
;
4315 if (STRINGP (value
))
4317 if (SCHARS (value
) == 0)
4320 return -1; /* Replaced by "", i.e. nothing. */
4323 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4324 it
->current
.overlay_string_index
= -1;
4325 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4326 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4327 it
->method
= GET_FROM_STRING
;
4328 it
->stop_charpos
= 0;
4329 it
->string_from_display_prop_p
= 1;
4330 /* Say that we haven't consumed the characters with
4331 `display' property yet. The call to pop_it in
4332 set_iterator_to_next will clean this up. */
4333 if (BUFFERP (object
))
4334 it
->current
.pos
= start_pos
;
4336 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4338 it
->method
= GET_FROM_STRETCH
;
4340 it
->position
= start_pos
;
4341 if (BUFFERP (object
))
4342 it
->current
.pos
= start_pos
;
4344 #ifdef HAVE_WINDOW_SYSTEM
4347 it
->what
= IT_IMAGE
;
4348 it
->image_id
= lookup_image (it
->f
, value
);
4349 it
->position
= start_pos
;
4350 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4351 it
->method
= GET_FROM_IMAGE
;
4353 /* Say that we haven't consumed the characters with
4354 `display' property yet. The call to pop_it in
4355 set_iterator_to_next will clean this up. */
4356 if (BUFFERP (object
))
4357 it
->current
.pos
= start_pos
;
4359 #endif /* HAVE_WINDOW_SYSTEM */
4364 /* Invalid property or property not supported. Restore
4365 POSITION to what it was before. */
4366 *position
= start_pos
;
4371 /* Check if SPEC is a display sub-property value whose text should be
4372 treated as intangible. */
4375 single_display_spec_intangible_p (prop
)
4378 /* Skip over `when FORM'. */
4379 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4393 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4394 we don't need to treat text as intangible. */
4395 if (EQ (XCAR (prop
), Qmargin
))
4403 || EQ (XCAR (prop
), Qleft_margin
)
4404 || EQ (XCAR (prop
), Qright_margin
))
4408 return (CONSP (prop
)
4409 && (EQ (XCAR (prop
), Qimage
)
4410 || EQ (XCAR (prop
), Qspace
)));
4414 /* Check if PROP is a display property value whose text should be
4415 treated as intangible. */
4418 display_prop_intangible_p (prop
)
4422 && CONSP (XCAR (prop
))
4423 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4425 /* A list of sub-properties. */
4426 while (CONSP (prop
))
4428 if (single_display_spec_intangible_p (XCAR (prop
)))
4433 else if (VECTORP (prop
))
4435 /* A vector of sub-properties. */
4437 for (i
= 0; i
< ASIZE (prop
); ++i
)
4438 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4442 return single_display_spec_intangible_p (prop
);
4448 /* Return 1 if PROP is a display sub-property value containing STRING. */
4451 single_display_spec_string_p (prop
, string
)
4452 Lisp_Object prop
, string
;
4454 if (EQ (string
, prop
))
4457 /* Skip over `when FORM'. */
4458 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4467 /* Skip over `margin LOCATION'. */
4468 if (EQ (XCAR (prop
), Qmargin
))
4479 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4483 /* Return 1 if STRING appears in the `display' property PROP. */
4486 display_prop_string_p (prop
, string
)
4487 Lisp_Object prop
, string
;
4490 && CONSP (XCAR (prop
))
4491 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4493 /* A list of sub-properties. */
4494 while (CONSP (prop
))
4496 if (single_display_spec_string_p (XCAR (prop
), string
))
4501 else if (VECTORP (prop
))
4503 /* A vector of sub-properties. */
4505 for (i
= 0; i
< ASIZE (prop
); ++i
)
4506 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4510 return single_display_spec_string_p (prop
, string
);
4516 /* Determine from which buffer position in W's buffer STRING comes
4517 from. AROUND_CHARPOS is an approximate position where it could
4518 be from. Value is the buffer position or 0 if it couldn't be
4521 W's buffer must be current.
4523 This function is necessary because we don't record buffer positions
4524 in glyphs generated from strings (to keep struct glyph small).
4525 This function may only use code that doesn't eval because it is
4526 called asynchronously from note_mouse_highlight. */
4529 string_buffer_position (w
, string
, around_charpos
)
4534 Lisp_Object limit
, prop
, pos
;
4535 const int MAX_DISTANCE
= 1000;
4538 pos
= make_number (around_charpos
);
4539 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4540 while (!found
&& !EQ (pos
, limit
))
4542 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4543 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4546 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4551 pos
= make_number (around_charpos
);
4552 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4553 while (!found
&& !EQ (pos
, limit
))
4555 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4556 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4559 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4564 return found
? XINT (pos
) : 0;
4569 /***********************************************************************
4570 `composition' property
4571 ***********************************************************************/
4573 static enum prop_handled
4574 handle_auto_composed_prop (it
)
4577 enum prop_handled handled
= HANDLED_NORMALLY
;
4579 if (FUNCTIONP (Vauto_composition_function
))
4581 Lisp_Object val
= Qnil
;
4582 EMACS_INT pos
, limit
= -1;
4584 if (STRINGP (it
->string
))
4585 pos
= IT_STRING_CHARPOS (*it
);
4587 pos
= IT_CHARPOS (*it
);
4589 val
= Fget_text_property (make_number (pos
), Qauto_composed
, it
->string
);
4592 Lisp_Object cmp_prop
;
4593 EMACS_INT cmp_start
, cmp_end
;
4595 #ifdef USE_FONT_BACKEND
4596 if (enable_font_backend
4597 && get_property_and_range (pos
, Qcomposition
, &cmp_prop
,
4598 &cmp_start
, &cmp_end
, it
->string
)
4600 && COMPOSITION_METHOD (cmp_prop
) == COMPOSITION_WITH_GLYPH_STRING
)
4602 Lisp_Object gstring
= COMPOSITION_COMPONENTS (cmp_prop
);
4603 Lisp_Object font_object
= LGSTRING_FONT (gstring
);
4605 if (! EQ (font_object
,
4606 font_at (-1, pos
, FACE_FROM_ID (it
->f
, it
->face_id
),
4607 it
->w
, it
->string
)))
4608 /* We must re-compute the composition for the
4617 /* As Fnext_single_char_property_change is very slow, we
4618 limit the search to the current line. */
4619 if (STRINGP (it
->string
))
4620 limit
= SCHARS (it
->string
);
4622 limit
= find_next_newline_no_quit (pos
, 1);
4623 end
= Fnext_single_char_property_change (make_number (pos
),
4626 make_number (limit
));
4628 if (XINT (end
) < limit
)
4629 /* The current point is auto-composed, but there exist
4630 characters not yet composed beyond the
4631 auto-composed region. There's a possiblity that
4632 the last characters in the region may be newly
4640 limit
= (STRINGP (it
->string
) ? SCHARS (it
->string
)
4641 : find_next_newline_no_quit (pos
, 1));
4644 int count
= SPECPDL_INDEX ();
4645 Lisp_Object args
[5];
4647 args
[0] = Vauto_composition_function
;
4648 specbind (Qauto_composition_function
, Qnil
);
4649 args
[1] = make_number (pos
);
4650 args
[2] = make_number (limit
);
4651 #ifdef USE_FONT_BACKEND
4652 if (enable_font_backend
)
4653 args
[3] = it
->window
;
4655 #endif /* USE_FONT_BACKEND */
4657 args
[4] = it
->string
;
4658 safe_call (5, args
);
4659 unbind_to (count
, Qnil
);
4667 /* Set up iterator IT from `composition' property at its current
4668 position. Called from handle_stop. */
4670 static enum prop_handled
4671 handle_composition_prop (it
)
4674 Lisp_Object prop
, string
;
4675 EMACS_INT pos
, pos_byte
, start
, end
;
4676 enum prop_handled handled
= HANDLED_NORMALLY
;
4678 if (STRINGP (it
->string
))
4682 pos
= IT_STRING_CHARPOS (*it
);
4683 pos_byte
= IT_STRING_BYTEPOS (*it
);
4684 string
= it
->string
;
4685 s
= SDATA (string
) + pos_byte
;
4686 it
->c
= STRING_CHAR (s
, 0);
4690 pos
= IT_CHARPOS (*it
);
4691 pos_byte
= IT_BYTEPOS (*it
);
4693 it
->c
= FETCH_CHAR (pos_byte
);
4696 /* If there's a valid composition and point is not inside of the
4697 composition (in the case that the composition is from the current
4698 buffer), draw a glyph composed from the composition components. */
4699 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4700 && COMPOSITION_VALID_P (start
, end
, prop
)
4701 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4707 if (STRINGP (it
->string
))
4708 pos_byte
= string_char_to_byte (it
->string
, start
);
4710 pos_byte
= CHAR_TO_BYTE (start
);
4712 id
= get_composition_id (start
, pos_byte
, end
- start
, prop
, string
);
4716 struct composition
*cmp
= composition_table
[id
];
4718 if (cmp
->glyph_len
== 0)
4721 if (STRINGP (it
->string
))
4723 IT_STRING_CHARPOS (*it
) = end
;
4724 IT_STRING_BYTEPOS (*it
) = string_char_to_byte (it
->string
,
4729 IT_CHARPOS (*it
) = end
;
4730 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (end
);
4732 return HANDLED_RECOMPUTE_PROPS
;
4735 it
->stop_charpos
= end
;
4738 it
->method
= GET_FROM_COMPOSITION
;
4740 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
4741 /* For a terminal, draw only the first (non-TAB) character
4742 of the components. */
4743 #ifdef USE_FONT_BACKEND
4744 if (composition_table
[id
]->method
== COMPOSITION_WITH_GLYPH_STRING
)
4746 Lisp_Object lgstring
= AREF (XHASH_TABLE (composition_hash_table
)
4748 cmp
->hash_index
* 2);
4751 #endif /* USE_FONT_BACKEND */
4755 for (i
= 0; i
< cmp
->glyph_len
; i
++)
4756 if ((it
->c
= COMPOSITION_GLYPH (composition_table
[id
], i
))
4762 it
->len
= (STRINGP (it
->string
)
4763 ? string_char_to_byte (it
->string
, end
)
4764 : CHAR_TO_BYTE (end
)) - pos_byte
;
4765 handled
= HANDLED_RETURN
;
4774 /***********************************************************************
4776 ***********************************************************************/
4778 /* The following structure is used to record overlay strings for
4779 later sorting in load_overlay_strings. */
4781 struct overlay_entry
4783 Lisp_Object overlay
;
4790 /* Set up iterator IT from overlay strings at its current position.
4791 Called from handle_stop. */
4793 static enum prop_handled
4794 handle_overlay_change (it
)
4797 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4798 return HANDLED_RECOMPUTE_PROPS
;
4800 return HANDLED_NORMALLY
;
4804 /* Set up the next overlay string for delivery by IT, if there is an
4805 overlay string to deliver. Called by set_iterator_to_next when the
4806 end of the current overlay string is reached. If there are more
4807 overlay strings to display, IT->string and
4808 IT->current.overlay_string_index are set appropriately here.
4809 Otherwise IT->string is set to nil. */
4812 next_overlay_string (it
)
4815 ++it
->current
.overlay_string_index
;
4816 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4818 /* No more overlay strings. Restore IT's settings to what
4819 they were before overlay strings were processed, and
4820 continue to deliver from current_buffer. */
4821 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4825 || it
->method
== GET_FROM_COMPOSITION
4826 || (NILP (it
->string
)
4827 && it
->method
== GET_FROM_BUFFER
4828 && it
->stop_charpos
>= BEGV
4829 && it
->stop_charpos
<= it
->end_charpos
));
4830 it
->current
.overlay_string_index
= -1;
4831 it
->n_overlay_strings
= 0;
4833 /* If we're at the end of the buffer, record that we have
4834 processed the overlay strings there already, so that
4835 next_element_from_buffer doesn't try it again. */
4836 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4837 it
->overlay_strings_at_end_processed_p
= 1;
4839 /* If we have to display `...' for invisible text, set
4840 the iterator up for that. */
4841 if (display_ellipsis_p
)
4842 setup_for_ellipsis (it
, 0);
4846 /* There are more overlay strings to process. If
4847 IT->current.overlay_string_index has advanced to a position
4848 where we must load IT->overlay_strings with more strings, do
4850 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4852 if (it
->current
.overlay_string_index
&& i
== 0)
4853 load_overlay_strings (it
, 0);
4855 /* Initialize IT to deliver display elements from the overlay
4857 it
->string
= it
->overlay_strings
[i
];
4858 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4859 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4860 it
->method
= GET_FROM_STRING
;
4861 it
->stop_charpos
= 0;
4868 /* Compare two overlay_entry structures E1 and E2. Used as a
4869 comparison function for qsort in load_overlay_strings. Overlay
4870 strings for the same position are sorted so that
4872 1. All after-strings come in front of before-strings, except
4873 when they come from the same overlay.
4875 2. Within after-strings, strings are sorted so that overlay strings
4876 from overlays with higher priorities come first.
4878 2. Within before-strings, strings are sorted so that overlay
4879 strings from overlays with higher priorities come last.
4881 Value is analogous to strcmp. */
4885 compare_overlay_entries (e1
, e2
)
4888 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4889 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4892 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4894 /* Let after-strings appear in front of before-strings if
4895 they come from different overlays. */
4896 if (EQ (entry1
->overlay
, entry2
->overlay
))
4897 result
= entry1
->after_string_p
? 1 : -1;
4899 result
= entry1
->after_string_p
? -1 : 1;
4901 else if (entry1
->after_string_p
)
4902 /* After-strings sorted in order of decreasing priority. */
4903 result
= entry2
->priority
- entry1
->priority
;
4905 /* Before-strings sorted in order of increasing priority. */
4906 result
= entry1
->priority
- entry2
->priority
;
4912 /* Load the vector IT->overlay_strings with overlay strings from IT's
4913 current buffer position, or from CHARPOS if that is > 0. Set
4914 IT->n_overlays to the total number of overlay strings found.
4916 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4917 a time. On entry into load_overlay_strings,
4918 IT->current.overlay_string_index gives the number of overlay
4919 strings that have already been loaded by previous calls to this
4922 IT->add_overlay_start contains an additional overlay start
4923 position to consider for taking overlay strings from, if non-zero.
4924 This position comes into play when the overlay has an `invisible'
4925 property, and both before and after-strings. When we've skipped to
4926 the end of the overlay, because of its `invisible' property, we
4927 nevertheless want its before-string to appear.
4928 IT->add_overlay_start will contain the overlay start position
4931 Overlay strings are sorted so that after-string strings come in
4932 front of before-string strings. Within before and after-strings,
4933 strings are sorted by overlay priority. See also function
4934 compare_overlay_entries. */
4937 load_overlay_strings (it
, charpos
)
4941 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4942 Lisp_Object overlay
, window
, str
, invisible
;
4943 struct Lisp_Overlay
*ov
;
4946 int n
= 0, i
, j
, invis_p
;
4947 struct overlay_entry
*entries
4948 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4951 charpos
= IT_CHARPOS (*it
);
4953 /* Append the overlay string STRING of overlay OVERLAY to vector
4954 `entries' which has size `size' and currently contains `n'
4955 elements. AFTER_P non-zero means STRING is an after-string of
4957 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4960 Lisp_Object priority; \
4964 int new_size = 2 * size; \
4965 struct overlay_entry *old = entries; \
4967 (struct overlay_entry *) alloca (new_size \
4968 * sizeof *entries); \
4969 bcopy (old, entries, size * sizeof *entries); \
4973 entries[n].string = (STRING); \
4974 entries[n].overlay = (OVERLAY); \
4975 priority = Foverlay_get ((OVERLAY), Qpriority); \
4976 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4977 entries[n].after_string_p = (AFTER_P); \
4982 /* Process overlay before the overlay center. */
4983 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4985 XSETMISC (overlay
, ov
);
4986 xassert (OVERLAYP (overlay
));
4987 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4988 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4993 /* Skip this overlay if it doesn't start or end at IT's current
4995 if (end
!= charpos
&& start
!= charpos
)
4998 /* Skip this overlay if it doesn't apply to IT->w. */
4999 window
= Foverlay_get (overlay
, Qwindow
);
5000 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5003 /* If the text ``under'' the overlay is invisible, both before-
5004 and after-strings from this overlay are visible; start and
5005 end position are indistinguishable. */
5006 invisible
= Foverlay_get (overlay
, Qinvisible
);
5007 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5009 /* If overlay has a non-empty before-string, record it. */
5010 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5011 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5013 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5015 /* If overlay has a non-empty after-string, record it. */
5016 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5017 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5019 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5022 /* Process overlays after the overlay center. */
5023 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5025 XSETMISC (overlay
, ov
);
5026 xassert (OVERLAYP (overlay
));
5027 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5028 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5030 if (start
> charpos
)
5033 /* Skip this overlay if it doesn't start or end at IT's current
5035 if (end
!= charpos
&& start
!= charpos
)
5038 /* Skip this overlay if it doesn't apply to IT->w. */
5039 window
= Foverlay_get (overlay
, Qwindow
);
5040 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5043 /* If the text ``under'' the overlay is invisible, it has a zero
5044 dimension, and both before- and after-strings apply. */
5045 invisible
= Foverlay_get (overlay
, Qinvisible
);
5046 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5048 /* If overlay has a non-empty before-string, record it. */
5049 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5050 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5052 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5054 /* If overlay has a non-empty after-string, record it. */
5055 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5056 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5058 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5061 #undef RECORD_OVERLAY_STRING
5065 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5067 /* Record the total number of strings to process. */
5068 it
->n_overlay_strings
= n
;
5070 /* IT->current.overlay_string_index is the number of overlay strings
5071 that have already been consumed by IT. Copy some of the
5072 remaining overlay strings to IT->overlay_strings. */
5074 j
= it
->current
.overlay_string_index
;
5075 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5077 it
->overlay_strings
[i
] = entries
[j
].string
;
5078 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5085 /* Get the first chunk of overlay strings at IT's current buffer
5086 position, or at CHARPOS if that is > 0. Value is non-zero if at
5087 least one overlay string was found. */
5090 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5094 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5095 process. This fills IT->overlay_strings with strings, and sets
5096 IT->n_overlay_strings to the total number of strings to process.
5097 IT->pos.overlay_string_index has to be set temporarily to zero
5098 because load_overlay_strings needs this; it must be set to -1
5099 when no overlay strings are found because a zero value would
5100 indicate a position in the first overlay string. */
5101 it
->current
.overlay_string_index
= 0;
5102 load_overlay_strings (it
, charpos
);
5104 /* If we found overlay strings, set up IT to deliver display
5105 elements from the first one. Otherwise set up IT to deliver
5106 from current_buffer. */
5107 if (it
->n_overlay_strings
)
5109 /* Make sure we know settings in current_buffer, so that we can
5110 restore meaningful values when we're done with the overlay
5113 compute_stop_pos (it
);
5114 xassert (it
->face_id
>= 0);
5116 /* Save IT's settings. They are restored after all overlay
5117 strings have been processed. */
5118 xassert (!compute_stop_p
|| it
->sp
== 0);
5121 /* Set up IT to deliver display elements from the first overlay
5123 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5124 it
->string
= it
->overlay_strings
[0];
5125 it
->from_overlay
= Qnil
;
5126 it
->stop_charpos
= 0;
5127 xassert (STRINGP (it
->string
));
5128 it
->end_charpos
= SCHARS (it
->string
);
5129 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5130 it
->method
= GET_FROM_STRING
;
5134 it
->current
.overlay_string_index
= -1;
5139 get_overlay_strings (it
, charpos
)
5144 it
->method
= GET_FROM_BUFFER
;
5146 (void) get_overlay_strings_1 (it
, charpos
, 1);
5150 /* Value is non-zero if we found at least one overlay string. */
5151 return STRINGP (it
->string
);
5156 /***********************************************************************
5157 Saving and restoring state
5158 ***********************************************************************/
5160 /* Save current settings of IT on IT->stack. Called, for example,
5161 before setting up IT for an overlay string, to be able to restore
5162 IT's settings to what they were after the overlay string has been
5169 struct iterator_stack_entry
*p
;
5171 xassert (it
->sp
< IT_STACK_SIZE
);
5172 p
= it
->stack
+ it
->sp
;
5174 p
->stop_charpos
= it
->stop_charpos
;
5175 xassert (it
->face_id
>= 0);
5176 p
->face_id
= it
->face_id
;
5177 p
->string
= it
->string
;
5178 p
->method
= it
->method
;
5179 p
->from_overlay
= it
->from_overlay
;
5182 case GET_FROM_IMAGE
:
5183 p
->u
.image
.object
= it
->object
;
5184 p
->u
.image
.image_id
= it
->image_id
;
5185 p
->u
.image
.slice
= it
->slice
;
5187 case GET_FROM_COMPOSITION
:
5188 p
->u
.comp
.object
= it
->object
;
5189 p
->u
.comp
.c
= it
->c
;
5190 p
->u
.comp
.len
= it
->len
;
5191 p
->u
.comp
.cmp_id
= it
->cmp_id
;
5192 p
->u
.comp
.cmp_len
= it
->cmp_len
;
5194 case GET_FROM_STRETCH
:
5195 p
->u
.stretch
.object
= it
->object
;
5198 p
->position
= it
->position
;
5199 p
->current
= it
->current
;
5200 p
->end_charpos
= it
->end_charpos
;
5201 p
->string_nchars
= it
->string_nchars
;
5203 p
->multibyte_p
= it
->multibyte_p
;
5204 p
->space_width
= it
->space_width
;
5205 p
->font_height
= it
->font_height
;
5206 p
->voffset
= it
->voffset
;
5207 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5208 p
->display_ellipsis_p
= 0;
5213 /* Restore IT's settings from IT->stack. Called, for example, when no
5214 more overlay strings must be processed, and we return to delivering
5215 display elements from a buffer, or when the end of a string from a
5216 `display' property is reached and we return to delivering display
5217 elements from an overlay string, or from a buffer. */
5223 struct iterator_stack_entry
*p
;
5225 xassert (it
->sp
> 0);
5227 p
= it
->stack
+ it
->sp
;
5228 it
->stop_charpos
= p
->stop_charpos
;
5229 it
->face_id
= p
->face_id
;
5230 it
->current
= p
->current
;
5231 it
->position
= p
->position
;
5232 it
->string
= p
->string
;
5233 it
->from_overlay
= p
->from_overlay
;
5234 if (NILP (it
->string
))
5235 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5236 it
->method
= p
->method
;
5239 case GET_FROM_IMAGE
:
5240 it
->image_id
= p
->u
.image
.image_id
;
5241 it
->object
= p
->u
.image
.object
;
5242 it
->slice
= p
->u
.image
.slice
;
5244 case GET_FROM_COMPOSITION
:
5245 it
->object
= p
->u
.comp
.object
;
5246 it
->c
= p
->u
.comp
.c
;
5247 it
->len
= p
->u
.comp
.len
;
5248 it
->cmp_id
= p
->u
.comp
.cmp_id
;
5249 it
->cmp_len
= p
->u
.comp
.cmp_len
;
5251 case GET_FROM_STRETCH
:
5252 it
->object
= p
->u
.comp
.object
;
5254 case GET_FROM_BUFFER
:
5255 it
->object
= it
->w
->buffer
;
5257 case GET_FROM_STRING
:
5258 it
->object
= it
->string
;
5261 it
->end_charpos
= p
->end_charpos
;
5262 it
->string_nchars
= p
->string_nchars
;
5264 it
->multibyte_p
= p
->multibyte_p
;
5265 it
->space_width
= p
->space_width
;
5266 it
->font_height
= p
->font_height
;
5267 it
->voffset
= p
->voffset
;
5268 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5273 /***********************************************************************
5275 ***********************************************************************/
5277 /* Set IT's current position to the previous line start. */
5280 back_to_previous_line_start (it
)
5283 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5284 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5288 /* Move IT to the next line start.
5290 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5291 we skipped over part of the text (as opposed to moving the iterator
5292 continuously over the text). Otherwise, don't change the value
5295 Newlines may come from buffer text, overlay strings, or strings
5296 displayed via the `display' property. That's the reason we can't
5297 simply use find_next_newline_no_quit.
5299 Note that this function may not skip over invisible text that is so
5300 because of text properties and immediately follows a newline. If
5301 it would, function reseat_at_next_visible_line_start, when called
5302 from set_iterator_to_next, would effectively make invisible
5303 characters following a newline part of the wrong glyph row, which
5304 leads to wrong cursor motion. */
5307 forward_to_next_line_start (it
, skipped_p
)
5311 int old_selective
, newline_found_p
, n
;
5312 const int MAX_NEWLINE_DISTANCE
= 500;
5314 /* If already on a newline, just consume it to avoid unintended
5315 skipping over invisible text below. */
5316 if (it
->what
== IT_CHARACTER
5318 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5320 set_iterator_to_next (it
, 0);
5325 /* Don't handle selective display in the following. It's (a)
5326 unnecessary because it's done by the caller, and (b) leads to an
5327 infinite recursion because next_element_from_ellipsis indirectly
5328 calls this function. */
5329 old_selective
= it
->selective
;
5332 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5333 from buffer text. */
5334 for (n
= newline_found_p
= 0;
5335 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5336 n
+= STRINGP (it
->string
) ? 0 : 1)
5338 if (!get_next_display_element (it
))
5340 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5341 set_iterator_to_next (it
, 0);
5344 /* If we didn't find a newline near enough, see if we can use a
5346 if (!newline_found_p
)
5348 int start
= IT_CHARPOS (*it
);
5349 int limit
= find_next_newline_no_quit (start
, 1);
5352 xassert (!STRINGP (it
->string
));
5354 /* If there isn't any `display' property in sight, and no
5355 overlays, we can just use the position of the newline in
5357 if (it
->stop_charpos
>= limit
5358 || ((pos
= Fnext_single_property_change (make_number (start
),
5360 Qnil
, make_number (limit
)),
5362 && next_overlay_change (start
) == ZV
))
5364 IT_CHARPOS (*it
) = limit
;
5365 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5366 *skipped_p
= newline_found_p
= 1;
5370 while (get_next_display_element (it
)
5371 && !newline_found_p
)
5373 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5374 set_iterator_to_next (it
, 0);
5379 it
->selective
= old_selective
;
5380 return newline_found_p
;
5384 /* Set IT's current position to the previous visible line start. Skip
5385 invisible text that is so either due to text properties or due to
5386 selective display. Caution: this does not change IT->current_x and
5390 back_to_previous_visible_line_start (it
)
5393 while (IT_CHARPOS (*it
) > BEGV
)
5395 back_to_previous_line_start (it
);
5397 if (IT_CHARPOS (*it
) <= BEGV
)
5400 /* If selective > 0, then lines indented more than that values
5402 if (it
->selective
> 0
5403 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5404 (double) it
->selective
)) /* iftc */
5407 /* Check the newline before point for invisibility. */
5410 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5411 Qinvisible
, it
->window
);
5412 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5416 if (IT_CHARPOS (*it
) <= BEGV
)
5423 Lisp_Object val
, overlay
;
5425 /* If newline is part of a composition, continue from start of composition */
5426 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5427 && beg
< IT_CHARPOS (*it
))
5430 /* If newline is replaced by a display property, find start of overlay
5431 or interval and continue search from that point. */
5433 pos
= --IT_CHARPOS (it2
);
5436 if (handle_display_prop (&it2
) == HANDLED_RETURN
5437 && !NILP (val
= get_char_property_and_overlay
5438 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5439 && (OVERLAYP (overlay
)
5440 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5441 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5444 /* Newline is not replaced by anything -- so we are done. */
5450 IT_CHARPOS (*it
) = beg
;
5451 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5455 it
->continuation_lines_width
= 0;
5457 xassert (IT_CHARPOS (*it
) >= BEGV
);
5458 xassert (IT_CHARPOS (*it
) == BEGV
5459 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5464 /* Reseat iterator IT at the previous visible line start. Skip
5465 invisible text that is so either due to text properties or due to
5466 selective display. At the end, update IT's overlay information,
5467 face information etc. */
5470 reseat_at_previous_visible_line_start (it
)
5473 back_to_previous_visible_line_start (it
);
5474 reseat (it
, it
->current
.pos
, 1);
5479 /* Reseat iterator IT on the next visible line start in the current
5480 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5481 preceding the line start. Skip over invisible text that is so
5482 because of selective display. Compute faces, overlays etc at the
5483 new position. Note that this function does not skip over text that
5484 is invisible because of text properties. */
5487 reseat_at_next_visible_line_start (it
, on_newline_p
)
5491 int newline_found_p
, skipped_p
= 0;
5493 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5495 /* Skip over lines that are invisible because they are indented
5496 more than the value of IT->selective. */
5497 if (it
->selective
> 0)
5498 while (IT_CHARPOS (*it
) < ZV
5499 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5500 (double) it
->selective
)) /* iftc */
5502 xassert (IT_BYTEPOS (*it
) == BEGV
5503 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5504 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5507 /* Position on the newline if that's what's requested. */
5508 if (on_newline_p
&& newline_found_p
)
5510 if (STRINGP (it
->string
))
5512 if (IT_STRING_CHARPOS (*it
) > 0)
5514 --IT_STRING_CHARPOS (*it
);
5515 --IT_STRING_BYTEPOS (*it
);
5518 else if (IT_CHARPOS (*it
) > BEGV
)
5522 reseat (it
, it
->current
.pos
, 0);
5526 reseat (it
, it
->current
.pos
, 0);
5533 /***********************************************************************
5534 Changing an iterator's position
5535 ***********************************************************************/
5537 /* Change IT's current position to POS in current_buffer. If FORCE_P
5538 is non-zero, always check for text properties at the new position.
5539 Otherwise, text properties are only looked up if POS >=
5540 IT->check_charpos of a property. */
5543 reseat (it
, pos
, force_p
)
5545 struct text_pos pos
;
5548 int original_pos
= IT_CHARPOS (*it
);
5550 reseat_1 (it
, pos
, 0);
5552 /* Determine where to check text properties. Avoid doing it
5553 where possible because text property lookup is very expensive. */
5555 || CHARPOS (pos
) > it
->stop_charpos
5556 || CHARPOS (pos
) < original_pos
)
5563 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5564 IT->stop_pos to POS, also. */
5567 reseat_1 (it
, pos
, set_stop_p
)
5569 struct text_pos pos
;
5572 /* Don't call this function when scanning a C string. */
5573 xassert (it
->s
== NULL
);
5575 /* POS must be a reasonable value. */
5576 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5578 it
->current
.pos
= it
->position
= pos
;
5579 it
->end_charpos
= ZV
;
5581 it
->current
.dpvec_index
= -1;
5582 it
->current
.overlay_string_index
= -1;
5583 IT_STRING_CHARPOS (*it
) = -1;
5584 IT_STRING_BYTEPOS (*it
) = -1;
5586 it
->method
= GET_FROM_BUFFER
;
5587 it
->object
= it
->w
->buffer
;
5588 it
->area
= TEXT_AREA
;
5589 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5591 it
->string_from_display_prop_p
= 0;
5592 it
->face_before_selective_p
= 0;
5595 it
->stop_charpos
= CHARPOS (pos
);
5599 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5600 If S is non-null, it is a C string to iterate over. Otherwise,
5601 STRING gives a Lisp string to iterate over.
5603 If PRECISION > 0, don't return more then PRECISION number of
5604 characters from the string.
5606 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5607 characters have been returned. FIELD_WIDTH < 0 means an infinite
5610 MULTIBYTE = 0 means disable processing of multibyte characters,
5611 MULTIBYTE > 0 means enable it,
5612 MULTIBYTE < 0 means use IT->multibyte_p.
5614 IT must be initialized via a prior call to init_iterator before
5615 calling this function. */
5618 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5623 int precision
, field_width
, multibyte
;
5625 /* No region in strings. */
5626 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5628 /* No text property checks performed by default, but see below. */
5629 it
->stop_charpos
= -1;
5631 /* Set iterator position and end position. */
5632 bzero (&it
->current
, sizeof it
->current
);
5633 it
->current
.overlay_string_index
= -1;
5634 it
->current
.dpvec_index
= -1;
5635 xassert (charpos
>= 0);
5637 /* If STRING is specified, use its multibyteness, otherwise use the
5638 setting of MULTIBYTE, if specified. */
5640 it
->multibyte_p
= multibyte
> 0;
5644 xassert (STRINGP (string
));
5645 it
->string
= string
;
5647 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5648 it
->method
= GET_FROM_STRING
;
5649 it
->current
.string_pos
= string_pos (charpos
, string
);
5656 /* Note that we use IT->current.pos, not it->current.string_pos,
5657 for displaying C strings. */
5658 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5659 if (it
->multibyte_p
)
5661 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5662 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5666 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5667 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5670 it
->method
= GET_FROM_C_STRING
;
5673 /* PRECISION > 0 means don't return more than PRECISION characters
5675 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5676 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5678 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5679 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5680 FIELD_WIDTH < 0 means infinite field width. This is useful for
5681 padding with `-' at the end of a mode line. */
5682 if (field_width
< 0)
5683 field_width
= INFINITY
;
5684 if (field_width
> it
->end_charpos
- charpos
)
5685 it
->end_charpos
= charpos
+ field_width
;
5687 /* Use the standard display table for displaying strings. */
5688 if (DISP_TABLE_P (Vstandard_display_table
))
5689 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5691 it
->stop_charpos
= charpos
;
5697 /***********************************************************************
5699 ***********************************************************************/
5701 /* Map enum it_method value to corresponding next_element_from_* function. */
5703 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5705 next_element_from_buffer
,
5706 next_element_from_display_vector
,
5707 next_element_from_composition
,
5708 next_element_from_string
,
5709 next_element_from_c_string
,
5710 next_element_from_image
,
5711 next_element_from_stretch
5715 /* Load IT's display element fields with information about the next
5716 display element from the current position of IT. Value is zero if
5717 end of buffer (or C string) is reached. */
5719 static struct frame
*last_escape_glyph_frame
= NULL
;
5720 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5721 static int last_escape_glyph_merged_face_id
= 0;
5724 get_next_display_element (it
)
5727 /* Non-zero means that we found a display element. Zero means that
5728 we hit the end of what we iterate over. Performance note: the
5729 function pointer `method' used here turns out to be faster than
5730 using a sequence of if-statements. */
5734 success_p
= (*get_next_element
[it
->method
]) (it
);
5736 if (it
->what
== IT_CHARACTER
)
5738 /* Map via display table or translate control characters.
5739 IT->c, IT->len etc. have been set to the next character by
5740 the function call above. If we have a display table, and it
5741 contains an entry for IT->c, translate it. Don't do this if
5742 IT->c itself comes from a display table, otherwise we could
5743 end up in an infinite recursion. (An alternative could be to
5744 count the recursion depth of this function and signal an
5745 error when a certain maximum depth is reached.) Is it worth
5747 if (success_p
&& it
->dpvec
== NULL
)
5752 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5755 struct Lisp_Vector
*v
= XVECTOR (dv
);
5757 /* Return the first character from the display table
5758 entry, if not empty. If empty, don't display the
5759 current character. */
5762 it
->dpvec_char_len
= it
->len
;
5763 it
->dpvec
= v
->contents
;
5764 it
->dpend
= v
->contents
+ v
->size
;
5765 it
->current
.dpvec_index
= 0;
5766 it
->dpvec_face_id
= -1;
5767 it
->saved_face_id
= it
->face_id
;
5768 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5773 set_iterator_to_next (it
, 0);
5778 /* Translate control characters into `\003' or `^C' form.
5779 Control characters coming from a display table entry are
5780 currently not translated because we use IT->dpvec to hold
5781 the translation. This could easily be changed but I
5782 don't believe that it is worth doing.
5784 If it->multibyte_p is nonzero, non-printable non-ASCII
5785 characters are also translated to octal form.
5787 If it->multibyte_p is zero, eight-bit characters that
5788 don't have corresponding multibyte char code are also
5789 translated to octal form. */
5790 else if ((it
->c
< ' '
5791 ? (it
->area
!= TEXT_AREA
5792 /* In mode line, treat \n, \t like other crl chars. */
5794 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5795 || (it
->c
!= '\n' && it
->c
!= '\t'))
5797 ? (!CHAR_PRINTABLE_P (it
->c
)
5798 || (!NILP (Vnobreak_char_display
)
5799 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5800 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5802 && (! unibyte_display_via_language_environment
5803 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5805 /* IT->c is a control character which must be displayed
5806 either as '\003' or as `^C' where the '\\' and '^'
5807 can be defined in the display table. Fill
5808 IT->ctl_chars with glyphs for what we have to
5809 display. Then, set IT->dpvec to these glyphs. */
5812 int face_id
, lface_id
= 0 ;
5815 /* Handle control characters with ^. */
5817 if (it
->c
< 128 && it
->ctl_arrow_p
)
5819 g
= '^'; /* default glyph for Control */
5820 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5822 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
5823 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
5825 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
5826 lface_id
= FAST_GLYPH_FACE (g
);
5830 g
= FAST_GLYPH_CHAR (g
);
5831 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5834 else if (it
->f
== last_escape_glyph_frame
5835 && it
->face_id
== last_escape_glyph_face_id
)
5837 face_id
= last_escape_glyph_merged_face_id
;
5841 /* Merge the escape-glyph face into the current face. */
5842 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5844 last_escape_glyph_frame
= it
->f
;
5845 last_escape_glyph_face_id
= it
->face_id
;
5846 last_escape_glyph_merged_face_id
= face_id
;
5849 XSETINT (it
->ctl_chars
[0], g
);
5851 XSETINT (it
->ctl_chars
[1], g
);
5853 goto display_control
;
5856 /* Handle non-break space in the mode where it only gets
5859 if (EQ (Vnobreak_char_display
, Qt
)
5862 /* Merge the no-break-space face into the current face. */
5863 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5867 XSETINT (it
->ctl_chars
[0], g
);
5869 goto display_control
;
5872 /* Handle sequences that start with the "escape glyph". */
5874 /* the default escape glyph is \. */
5875 escape_glyph
= '\\';
5878 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
5879 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
5881 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
5882 lface_id
= FAST_GLYPH_FACE (escape_glyph
);
5886 /* The display table specified a face.
5887 Merge it into face_id and also into escape_glyph. */
5888 escape_glyph
= FAST_GLYPH_CHAR (escape_glyph
);
5889 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5892 else if (it
->f
== last_escape_glyph_frame
5893 && it
->face_id
== last_escape_glyph_face_id
)
5895 face_id
= last_escape_glyph_merged_face_id
;
5899 /* Merge the escape-glyph face into the current face. */
5900 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5902 last_escape_glyph_frame
= it
->f
;
5903 last_escape_glyph_face_id
= it
->face_id
;
5904 last_escape_glyph_merged_face_id
= face_id
;
5907 /* Handle soft hyphens in the mode where they only get
5910 if (EQ (Vnobreak_char_display
, Qt
)
5914 XSETINT (it
->ctl_chars
[0], g
);
5916 goto display_control
;
5919 /* Handle non-break space and soft hyphen
5920 with the escape glyph. */
5922 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5924 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5925 g
= it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5926 XSETINT (it
->ctl_chars
[1], g
);
5928 goto display_control
;
5932 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5936 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5937 if (CHAR_BYTE8_P (it
->c
))
5939 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5942 else if (it
->c
< 256)
5949 /* It's an invalid character, which shouldn't
5950 happen actually, but due to bugs it may
5951 happen. Let's print the char as is, there's
5952 not much meaningful we can do with it. */
5954 str
[1] = it
->c
>> 8;
5955 str
[2] = it
->c
>> 16;
5956 str
[3] = it
->c
>> 24;
5960 for (i
= 0; i
< len
; i
++)
5962 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5963 /* Insert three more glyphs into IT->ctl_chars for
5964 the octal display of the character. */
5965 g
= ((str
[i
] >> 6) & 7) + '0';
5966 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5967 g
= ((str
[i
] >> 3) & 7) + '0';
5968 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5969 g
= (str
[i
] & 7) + '0';
5970 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5976 /* Set up IT->dpvec and return first character from it. */
5977 it
->dpvec_char_len
= it
->len
;
5978 it
->dpvec
= it
->ctl_chars
;
5979 it
->dpend
= it
->dpvec
+ ctl_len
;
5980 it
->current
.dpvec_index
= 0;
5981 it
->dpvec_face_id
= face_id
;
5982 it
->saved_face_id
= it
->face_id
;
5983 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5990 /* Adjust face id for a multibyte character. There are no multibyte
5991 character in unibyte text. */
5992 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5995 && FRAME_WINDOW_P (it
->f
))
5997 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5998 int pos
= (it
->s
? -1
5999 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6000 : IT_CHARPOS (*it
));
6002 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6005 /* Is this character the last one of a run of characters with
6006 box? If yes, set IT->end_of_box_run_p to 1. */
6013 it
->end_of_box_run_p
6014 = ((face_id
= face_after_it_pos (it
),
6015 face_id
!= it
->face_id
)
6016 && (face
= FACE_FROM_ID (it
->f
, face_id
),
6017 face
->box
== FACE_NO_BOX
));
6020 /* Value is 0 if end of buffer or string reached. */
6025 /* Move IT to the next display element.
6027 RESEAT_P non-zero means if called on a newline in buffer text,
6028 skip to the next visible line start.
6030 Functions get_next_display_element and set_iterator_to_next are
6031 separate because I find this arrangement easier to handle than a
6032 get_next_display_element function that also increments IT's
6033 position. The way it is we can first look at an iterator's current
6034 display element, decide whether it fits on a line, and if it does,
6035 increment the iterator position. The other way around we probably
6036 would either need a flag indicating whether the iterator has to be
6037 incremented the next time, or we would have to implement a
6038 decrement position function which would not be easy to write. */
6041 set_iterator_to_next (it
, reseat_p
)
6045 /* Reset flags indicating start and end of a sequence of characters
6046 with box. Reset them at the start of this function because
6047 moving the iterator to a new position might set them. */
6048 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6052 case GET_FROM_BUFFER
:
6053 /* The current display element of IT is a character from
6054 current_buffer. Advance in the buffer, and maybe skip over
6055 invisible lines that are so because of selective display. */
6056 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6057 reseat_at_next_visible_line_start (it
, 0);
6060 xassert (it
->len
!= 0);
6061 IT_BYTEPOS (*it
) += it
->len
;
6062 IT_CHARPOS (*it
) += 1;
6063 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6067 case GET_FROM_COMPOSITION
:
6068 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
6069 xassert (it
->sp
> 0);
6071 if (it
->method
== GET_FROM_STRING
)
6073 IT_STRING_BYTEPOS (*it
) += it
->len
;
6074 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
6075 goto consider_string_end
;
6077 else if (it
->method
== GET_FROM_BUFFER
)
6079 IT_BYTEPOS (*it
) += it
->len
;
6080 IT_CHARPOS (*it
) += it
->cmp_len
;
6084 case GET_FROM_C_STRING
:
6085 /* Current display element of IT is from a C string. */
6086 IT_BYTEPOS (*it
) += it
->len
;
6087 IT_CHARPOS (*it
) += 1;
6090 case GET_FROM_DISPLAY_VECTOR
:
6091 /* Current display element of IT is from a display table entry.
6092 Advance in the display table definition. Reset it to null if
6093 end reached, and continue with characters from buffers/
6095 ++it
->current
.dpvec_index
;
6097 /* Restore face of the iterator to what they were before the
6098 display vector entry (these entries may contain faces). */
6099 it
->face_id
= it
->saved_face_id
;
6101 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6103 int recheck_faces
= it
->ellipsis_p
;
6106 it
->method
= GET_FROM_C_STRING
;
6107 else if (STRINGP (it
->string
))
6108 it
->method
= GET_FROM_STRING
;
6111 it
->method
= GET_FROM_BUFFER
;
6112 it
->object
= it
->w
->buffer
;
6116 it
->current
.dpvec_index
= -1;
6118 /* Skip over characters which were displayed via IT->dpvec. */
6119 if (it
->dpvec_char_len
< 0)
6120 reseat_at_next_visible_line_start (it
, 1);
6121 else if (it
->dpvec_char_len
> 0)
6123 if (it
->method
== GET_FROM_STRING
6124 && it
->n_overlay_strings
> 0)
6125 it
->ignore_overlay_strings_at_pos_p
= 1;
6126 it
->len
= it
->dpvec_char_len
;
6127 set_iterator_to_next (it
, reseat_p
);
6130 /* Maybe recheck faces after display vector */
6132 it
->stop_charpos
= IT_CHARPOS (*it
);
6136 case GET_FROM_STRING
:
6137 /* Current display element is a character from a Lisp string. */
6138 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6139 IT_STRING_BYTEPOS (*it
) += it
->len
;
6140 IT_STRING_CHARPOS (*it
) += 1;
6142 consider_string_end
:
6144 if (it
->current
.overlay_string_index
>= 0)
6146 /* IT->string is an overlay string. Advance to the
6147 next, if there is one. */
6148 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6149 next_overlay_string (it
);
6153 /* IT->string is not an overlay string. If we reached
6154 its end, and there is something on IT->stack, proceed
6155 with what is on the stack. This can be either another
6156 string, this time an overlay string, or a buffer. */
6157 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6161 if (it
->method
== GET_FROM_STRING
)
6162 goto consider_string_end
;
6167 case GET_FROM_IMAGE
:
6168 case GET_FROM_STRETCH
:
6169 /* The position etc with which we have to proceed are on
6170 the stack. The position may be at the end of a string,
6171 if the `display' property takes up the whole string. */
6172 xassert (it
->sp
> 0);
6174 if (it
->method
== GET_FROM_STRING
)
6175 goto consider_string_end
;
6179 /* There are no other methods defined, so this should be a bug. */
6183 xassert (it
->method
!= GET_FROM_STRING
6184 || (STRINGP (it
->string
)
6185 && IT_STRING_CHARPOS (*it
) >= 0));
6188 /* Load IT's display element fields with information about the next
6189 display element which comes from a display table entry or from the
6190 result of translating a control character to one of the forms `^C'
6193 IT->dpvec holds the glyphs to return as characters.
6194 IT->saved_face_id holds the face id before the display vector--
6195 it is restored into IT->face_idin set_iterator_to_next. */
6198 next_element_from_display_vector (it
)
6202 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6204 it
->face_id
= it
->saved_face_id
;
6206 if (INTEGERP (*it
->dpvec
)
6207 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
6211 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
6212 it
->c
= FAST_GLYPH_CHAR (g
);
6213 it
->len
= CHAR_BYTES (it
->c
);
6215 /* The entry may contain a face id to use. Such a face id is
6216 the id of a Lisp face, not a realized face. A face id of
6217 zero means no face is specified. */
6218 if (it
->dpvec_face_id
>= 0)
6219 it
->face_id
= it
->dpvec_face_id
;
6222 int lface_id
= FAST_GLYPH_FACE (g
);
6224 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6229 /* Display table entry is invalid. Return a space. */
6230 it
->c
= ' ', it
->len
= 1;
6232 /* Don't change position and object of the iterator here. They are
6233 still the values of the character that had this display table
6234 entry or was translated, and that's what we want. */
6235 it
->what
= IT_CHARACTER
;
6240 /* Load IT with the next display element from Lisp string IT->string.
6241 IT->current.string_pos is the current position within the string.
6242 If IT->current.overlay_string_index >= 0, the Lisp string is an
6246 next_element_from_string (it
)
6249 struct text_pos position
;
6251 xassert (STRINGP (it
->string
));
6252 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6253 position
= it
->current
.string_pos
;
6255 /* Time to check for invisible text? */
6256 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6257 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6261 /* Since a handler may have changed IT->method, we must
6263 return get_next_display_element (it
);
6266 if (it
->current
.overlay_string_index
>= 0)
6268 /* Get the next character from an overlay string. In overlay
6269 strings, There is no field width or padding with spaces to
6271 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6276 else if (STRING_MULTIBYTE (it
->string
))
6278 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6279 const unsigned char *s
= (SDATA (it
->string
)
6280 + IT_STRING_BYTEPOS (*it
));
6281 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6285 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6291 /* Get the next character from a Lisp string that is not an
6292 overlay string. Such strings come from the mode line, for
6293 example. We may have to pad with spaces, or truncate the
6294 string. See also next_element_from_c_string. */
6295 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6300 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6302 /* Pad with spaces. */
6303 it
->c
= ' ', it
->len
= 1;
6304 CHARPOS (position
) = BYTEPOS (position
) = -1;
6306 else if (STRING_MULTIBYTE (it
->string
))
6308 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6309 const unsigned char *s
= (SDATA (it
->string
)
6310 + IT_STRING_BYTEPOS (*it
));
6311 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6315 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6320 /* Record what we have and where it came from. */
6321 it
->what
= IT_CHARACTER
;
6322 it
->object
= it
->string
;
6323 it
->position
= position
;
6328 /* Load IT with next display element from C string IT->s.
6329 IT->string_nchars is the maximum number of characters to return
6330 from the string. IT->end_charpos may be greater than
6331 IT->string_nchars when this function is called, in which case we
6332 may have to return padding spaces. Value is zero if end of string
6333 reached, including padding spaces. */
6336 next_element_from_c_string (it
)
6342 it
->what
= IT_CHARACTER
;
6343 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6346 /* IT's position can be greater IT->string_nchars in case a field
6347 width or precision has been specified when the iterator was
6349 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6351 /* End of the game. */
6355 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6357 /* Pad with spaces. */
6358 it
->c
= ' ', it
->len
= 1;
6359 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6361 else if (it
->multibyte_p
)
6363 /* Implementation note: The calls to strlen apparently aren't a
6364 performance problem because there is no noticeable performance
6365 difference between Emacs running in unibyte or multibyte mode. */
6366 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6367 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6371 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6377 /* Set up IT to return characters from an ellipsis, if appropriate.
6378 The definition of the ellipsis glyphs may come from a display table
6379 entry. This function Fills IT with the first glyph from the
6380 ellipsis if an ellipsis is to be displayed. */
6383 next_element_from_ellipsis (it
)
6386 if (it
->selective_display_ellipsis_p
)
6387 setup_for_ellipsis (it
, it
->len
);
6390 /* The face at the current position may be different from the
6391 face we find after the invisible text. Remember what it
6392 was in IT->saved_face_id, and signal that it's there by
6393 setting face_before_selective_p. */
6394 it
->saved_face_id
= it
->face_id
;
6395 it
->method
= GET_FROM_BUFFER
;
6396 it
->object
= it
->w
->buffer
;
6397 reseat_at_next_visible_line_start (it
, 1);
6398 it
->face_before_selective_p
= 1;
6401 return get_next_display_element (it
);
6405 /* Deliver an image display element. The iterator IT is already
6406 filled with image information (done in handle_display_prop). Value
6411 next_element_from_image (it
)
6414 it
->what
= IT_IMAGE
;
6419 /* Fill iterator IT with next display element from a stretch glyph
6420 property. IT->object is the value of the text property. Value is
6424 next_element_from_stretch (it
)
6427 it
->what
= IT_STRETCH
;
6432 /* Load IT with the next display element from current_buffer. Value
6433 is zero if end of buffer reached. IT->stop_charpos is the next
6434 position at which to stop and check for text properties or buffer
6438 next_element_from_buffer (it
)
6443 /* Check this assumption, otherwise, we would never enter the
6444 if-statement, below. */
6445 xassert (IT_CHARPOS (*it
) >= BEGV
6446 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6448 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6450 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6452 int overlay_strings_follow_p
;
6454 /* End of the game, except when overlay strings follow that
6455 haven't been returned yet. */
6456 if (it
->overlay_strings_at_end_processed_p
)
6457 overlay_strings_follow_p
= 0;
6460 it
->overlay_strings_at_end_processed_p
= 1;
6461 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6464 if (overlay_strings_follow_p
)
6465 success_p
= get_next_display_element (it
);
6469 it
->position
= it
->current
.pos
;
6476 return get_next_display_element (it
);
6481 /* No face changes, overlays etc. in sight, so just return a
6482 character from current_buffer. */
6485 /* Maybe run the redisplay end trigger hook. Performance note:
6486 This doesn't seem to cost measurable time. */
6487 if (it
->redisplay_end_trigger_charpos
6489 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6490 run_redisplay_end_trigger_hook (it
);
6492 /* Get the next character, maybe multibyte. */
6493 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6494 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6496 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
6497 - IT_BYTEPOS (*it
));
6498 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
6501 it
->c
= *p
, it
->len
= 1;
6503 /* Record what we have and where it came from. */
6504 it
->what
= IT_CHARACTER
;
6505 it
->object
= it
->w
->buffer
;
6506 it
->position
= it
->current
.pos
;
6508 /* Normally we return the character found above, except when we
6509 really want to return an ellipsis for selective display. */
6514 /* A value of selective > 0 means hide lines indented more
6515 than that number of columns. */
6516 if (it
->selective
> 0
6517 && IT_CHARPOS (*it
) + 1 < ZV
6518 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6519 IT_BYTEPOS (*it
) + 1,
6520 (double) it
->selective
)) /* iftc */
6522 success_p
= next_element_from_ellipsis (it
);
6523 it
->dpvec_char_len
= -1;
6526 else if (it
->c
== '\r' && it
->selective
== -1)
6528 /* A value of selective == -1 means that everything from the
6529 CR to the end of the line is invisible, with maybe an
6530 ellipsis displayed for it. */
6531 success_p
= next_element_from_ellipsis (it
);
6532 it
->dpvec_char_len
= -1;
6537 /* Value is zero if end of buffer reached. */
6538 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6543 /* Run the redisplay end trigger hook for IT. */
6546 run_redisplay_end_trigger_hook (it
)
6549 Lisp_Object args
[3];
6551 /* IT->glyph_row should be non-null, i.e. we should be actually
6552 displaying something, or otherwise we should not run the hook. */
6553 xassert (it
->glyph_row
);
6555 /* Set up hook arguments. */
6556 args
[0] = Qredisplay_end_trigger_functions
;
6557 args
[1] = it
->window
;
6558 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6559 it
->redisplay_end_trigger_charpos
= 0;
6561 /* Since we are *trying* to run these functions, don't try to run
6562 them again, even if they get an error. */
6563 it
->w
->redisplay_end_trigger
= Qnil
;
6564 Frun_hook_with_args (3, args
);
6566 /* Notice if it changed the face of the character we are on. */
6567 handle_face_prop (it
);
6571 /* Deliver a composition display element. The iterator IT is already
6572 filled with composition information (done in
6573 handle_composition_prop). Value is always 1. */
6576 next_element_from_composition (it
)
6579 it
->what
= IT_COMPOSITION
;
6580 it
->position
= (STRINGP (it
->string
)
6581 ? it
->current
.string_pos
6583 if (STRINGP (it
->string
))
6584 it
->object
= it
->string
;
6586 it
->object
= it
->w
->buffer
;
6592 /***********************************************************************
6593 Moving an iterator without producing glyphs
6594 ***********************************************************************/
6596 /* Check if iterator is at a position corresponding to a valid buffer
6597 position after some move_it_ call. */
6599 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6600 ((it)->method == GET_FROM_STRING \
6601 ? IT_STRING_CHARPOS (*it) == 0 \
6605 /* Move iterator IT to a specified buffer or X position within one
6606 line on the display without producing glyphs.
6608 OP should be a bit mask including some or all of these bits:
6609 MOVE_TO_X: Stop on reaching x-position TO_X.
6610 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6611 Regardless of OP's value, stop in reaching the end of the display line.
6613 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6614 This means, in particular, that TO_X includes window's horizontal
6617 The return value has several possible values that
6618 say what condition caused the scan to stop:
6620 MOVE_POS_MATCH_OR_ZV
6621 - when TO_POS or ZV was reached.
6624 -when TO_X was reached before TO_POS or ZV were reached.
6627 - when we reached the end of the display area and the line must
6631 - when we reached the end of the display area and the line is
6635 - when we stopped at a line end, i.e. a newline or a CR and selective
6638 static enum move_it_result
6639 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
6641 int to_charpos
, to_x
, op
;
6643 enum move_it_result result
= MOVE_UNDEFINED
;
6644 struct glyph_row
*saved_glyph_row
;
6646 /* Don't produce glyphs in produce_glyphs. */
6647 saved_glyph_row
= it
->glyph_row
;
6648 it
->glyph_row
= NULL
;
6650 #define BUFFER_POS_REACHED_P() \
6651 ((op & MOVE_TO_POS) != 0 \
6652 && BUFFERP (it->object) \
6653 && IT_CHARPOS (*it) >= to_charpos \
6654 && (it->method == GET_FROM_BUFFER \
6655 || (it->method == GET_FROM_DISPLAY_VECTOR \
6656 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6661 int x
, i
, ascent
= 0, descent
= 0;
6663 /* Stop if we move beyond TO_CHARPOS (after an image or stretch glyph). */
6664 if ((op
& MOVE_TO_POS
) != 0
6665 && BUFFERP (it
->object
)
6666 && it
->method
== GET_FROM_BUFFER
6667 && IT_CHARPOS (*it
) > to_charpos
)
6669 result
= MOVE_POS_MATCH_OR_ZV
;
6673 /* Stop when ZV reached.
6674 We used to stop here when TO_CHARPOS reached as well, but that is
6675 too soon if this glyph does not fit on this line. So we handle it
6676 explicitly below. */
6677 if (!get_next_display_element (it
)
6678 || (it
->truncate_lines_p
6679 && BUFFER_POS_REACHED_P ()))
6681 result
= MOVE_POS_MATCH_OR_ZV
;
6685 /* The call to produce_glyphs will get the metrics of the
6686 display element IT is loaded with. We record in x the
6687 x-position before this display element in case it does not
6691 /* Remember the line height so far in case the next element doesn't
6693 if (!it
->truncate_lines_p
)
6695 ascent
= it
->max_ascent
;
6696 descent
= it
->max_descent
;
6699 PRODUCE_GLYPHS (it
);
6701 if (it
->area
!= TEXT_AREA
)
6703 set_iterator_to_next (it
, 1);
6707 /* The number of glyphs we get back in IT->nglyphs will normally
6708 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6709 character on a terminal frame, or (iii) a line end. For the
6710 second case, IT->nglyphs - 1 padding glyphs will be present
6711 (on X frames, there is only one glyph produced for a
6712 composite character.
6714 The behavior implemented below means, for continuation lines,
6715 that as many spaces of a TAB as fit on the current line are
6716 displayed there. For terminal frames, as many glyphs of a
6717 multi-glyph character are displayed in the current line, too.
6718 This is what the old redisplay code did, and we keep it that
6719 way. Under X, the whole shape of a complex character must
6720 fit on the line or it will be completely displayed in the
6723 Note that both for tabs and padding glyphs, all glyphs have
6727 /* More than one glyph or glyph doesn't fit on line. All
6728 glyphs have the same width. */
6729 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6731 int x_before_this_char
= x
;
6732 int hpos_before_this_char
= it
->hpos
;
6734 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6736 new_x
= x
+ single_glyph_width
;
6738 /* We want to leave anything reaching TO_X to the caller. */
6739 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6741 if (BUFFER_POS_REACHED_P ())
6742 goto buffer_pos_reached
;
6744 result
= MOVE_X_REACHED
;
6747 else if (/* Lines are continued. */
6748 !it
->truncate_lines_p
6749 && (/* And glyph doesn't fit on the line. */
6750 new_x
> it
->last_visible_x
6751 /* Or it fits exactly and we're on a window
6753 || (new_x
== it
->last_visible_x
6754 && FRAME_WINDOW_P (it
->f
))))
6756 if (/* IT->hpos == 0 means the very first glyph
6757 doesn't fit on the line, e.g. a wide image. */
6759 || (new_x
== it
->last_visible_x
6760 && FRAME_WINDOW_P (it
->f
)))
6763 it
->current_x
= new_x
;
6765 /* The character's last glyph just barely fits
6767 if (i
== it
->nglyphs
- 1)
6769 /* If this is the destination position,
6770 return a position *before* it in this row,
6771 now that we know it fits in this row. */
6772 if (BUFFER_POS_REACHED_P ())
6774 it
->hpos
= hpos_before_this_char
;
6775 it
->current_x
= x_before_this_char
;
6776 result
= MOVE_POS_MATCH_OR_ZV
;
6780 set_iterator_to_next (it
, 1);
6781 #ifdef HAVE_WINDOW_SYSTEM
6782 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6784 if (!get_next_display_element (it
))
6786 result
= MOVE_POS_MATCH_OR_ZV
;
6789 if (BUFFER_POS_REACHED_P ())
6791 if (ITERATOR_AT_END_OF_LINE_P (it
))
6792 result
= MOVE_POS_MATCH_OR_ZV
;
6794 result
= MOVE_LINE_CONTINUED
;
6797 if (ITERATOR_AT_END_OF_LINE_P (it
))
6799 result
= MOVE_NEWLINE_OR_CR
;
6803 #endif /* HAVE_WINDOW_SYSTEM */
6809 it
->max_ascent
= ascent
;
6810 it
->max_descent
= descent
;
6813 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6815 result
= MOVE_LINE_CONTINUED
;
6818 else if (BUFFER_POS_REACHED_P ())
6819 goto buffer_pos_reached
;
6820 else if (new_x
> it
->first_visible_x
)
6822 /* Glyph is visible. Increment number of glyphs that
6823 would be displayed. */
6828 /* Glyph is completely off the left margin of the display
6829 area. Nothing to do. */
6833 if (result
!= MOVE_UNDEFINED
)
6836 else if (BUFFER_POS_REACHED_P ())
6840 it
->max_ascent
= ascent
;
6841 it
->max_descent
= descent
;
6842 result
= MOVE_POS_MATCH_OR_ZV
;
6845 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6847 /* Stop when TO_X specified and reached. This check is
6848 necessary here because of lines consisting of a line end,
6849 only. The line end will not produce any glyphs and we
6850 would never get MOVE_X_REACHED. */
6851 xassert (it
->nglyphs
== 0);
6852 result
= MOVE_X_REACHED
;
6856 /* Is this a line end? If yes, we're done. */
6857 if (ITERATOR_AT_END_OF_LINE_P (it
))
6859 result
= MOVE_NEWLINE_OR_CR
;
6863 /* The current display element has been consumed. Advance
6865 set_iterator_to_next (it
, 1);
6867 /* Stop if lines are truncated and IT's current x-position is
6868 past the right edge of the window now. */
6869 if (it
->truncate_lines_p
6870 && it
->current_x
>= it
->last_visible_x
)
6872 #ifdef HAVE_WINDOW_SYSTEM
6873 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6875 if (!get_next_display_element (it
)
6876 || BUFFER_POS_REACHED_P ())
6878 result
= MOVE_POS_MATCH_OR_ZV
;
6881 if (ITERATOR_AT_END_OF_LINE_P (it
))
6883 result
= MOVE_NEWLINE_OR_CR
;
6887 #endif /* HAVE_WINDOW_SYSTEM */
6888 result
= MOVE_LINE_TRUNCATED
;
6893 #undef BUFFER_POS_REACHED_P
6895 /* Restore the iterator settings altered at the beginning of this
6897 it
->glyph_row
= saved_glyph_row
;
6902 /* Move IT forward until it satisfies one or more of the criteria in
6903 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
6905 OP is a bit-mask that specifies where to stop, and in particular,
6906 which of those four position arguments makes a difference. See the
6907 description of enum move_operation_enum.
6909 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
6910 screen line, this function will set IT to the next position >
6914 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
6916 int to_charpos
, to_x
, to_y
, to_vpos
;
6919 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
6925 if (op
& MOVE_TO_VPOS
)
6927 /* If no TO_CHARPOS and no TO_X specified, stop at the
6928 start of the line TO_VPOS. */
6929 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
6931 if (it
->vpos
== to_vpos
)
6937 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
6941 /* TO_VPOS >= 0 means stop at TO_X in the line at
6942 TO_VPOS, or at TO_POS, whichever comes first. */
6943 if (it
->vpos
== to_vpos
)
6949 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
6951 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
6956 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
6958 /* We have reached TO_X but not in the line we want. */
6959 skip
= move_it_in_display_line_to (it
, to_charpos
,
6961 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6969 else if (op
& MOVE_TO_Y
)
6971 struct it it_backup
;
6973 /* TO_Y specified means stop at TO_X in the line containing
6974 TO_Y---or at TO_CHARPOS if this is reached first. The
6975 problem is that we can't really tell whether the line
6976 contains TO_Y before we have completely scanned it, and
6977 this may skip past TO_X. What we do is to first scan to
6980 If TO_X is not specified, use a TO_X of zero. The reason
6981 is to make the outcome of this function more predictable.
6982 If we didn't use TO_X == 0, we would stop at the end of
6983 the line which is probably not what a caller would expect
6985 skip
= move_it_in_display_line_to (it
, to_charpos
,
6989 | (op
& MOVE_TO_POS
)));
6991 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
6992 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6998 /* If TO_X was reached, we would like to know whether TO_Y
6999 is in the line. This can only be said if we know the
7000 total line height which requires us to scan the rest of
7002 if (skip
== MOVE_X_REACHED
)
7004 /* Wait! We can conclude that TO_Y is in the line if
7005 the already scanned glyphs make the line tall enough
7006 because further scanning doesn't make it shorter. */
7007 line_height
= it
->max_ascent
+ it
->max_descent
;
7008 if (to_y
>= it
->current_y
7009 && to_y
< it
->current_y
+ line_height
)
7015 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7016 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7018 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7021 /* Now, decide whether TO_Y is in this line. */
7022 line_height
= it
->max_ascent
+ it
->max_descent
;
7023 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7025 if (to_y
>= it
->current_y
7026 && to_y
< it
->current_y
+ line_height
)
7028 if (skip
== MOVE_X_REACHED
)
7029 /* If TO_Y is in this line and TO_X was reached above,
7030 we scanned too far. We have to restore IT's settings
7031 to the ones before skipping. */
7035 else if (skip
== MOVE_X_REACHED
)
7038 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7045 else if (BUFFERP (it
->object
)
7046 && it
->method
== GET_FROM_BUFFER
7047 && IT_CHARPOS (*it
) >= to_charpos
)
7048 skip
= MOVE_POS_MATCH_OR_ZV
;
7050 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7054 case MOVE_POS_MATCH_OR_ZV
:
7058 case MOVE_NEWLINE_OR_CR
:
7059 set_iterator_to_next (it
, 1);
7060 it
->continuation_lines_width
= 0;
7063 case MOVE_LINE_TRUNCATED
:
7064 it
->continuation_lines_width
= 0;
7065 reseat_at_next_visible_line_start (it
, 0);
7066 if ((op
& MOVE_TO_POS
) != 0
7067 && IT_CHARPOS (*it
) > to_charpos
)
7074 case MOVE_LINE_CONTINUED
:
7075 /* For continued lines ending in a tab, some of the glyphs
7076 associated with the tab are displayed on the current
7077 line. Since it->current_x does not include these glyphs,
7078 we use it->last_visible_x instead. */
7079 it
->continuation_lines_width
+=
7080 (it
->c
== '\t') ? it
->last_visible_x
: it
->current_x
;
7087 /* Reset/increment for the next run. */
7088 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7089 it
->current_x
= it
->hpos
= 0;
7090 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7092 last_height
= it
->max_ascent
+ it
->max_descent
;
7093 last_max_ascent
= it
->max_ascent
;
7094 it
->max_ascent
= it
->max_descent
= 0;
7099 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7103 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7105 If DY > 0, move IT backward at least that many pixels. DY = 0
7106 means move IT backward to the preceding line start or BEGV. This
7107 function may move over more than DY pixels if IT->current_y - DY
7108 ends up in the middle of a line; in this case IT->current_y will be
7109 set to the top of the line moved to. */
7112 move_it_vertically_backward (it
, dy
)
7123 start_pos
= IT_CHARPOS (*it
);
7125 /* Estimate how many newlines we must move back. */
7126 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7128 /* Set the iterator's position that many lines back. */
7129 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7130 back_to_previous_visible_line_start (it
);
7132 /* Reseat the iterator here. When moving backward, we don't want
7133 reseat to skip forward over invisible text, set up the iterator
7134 to deliver from overlay strings at the new position etc. So,
7135 use reseat_1 here. */
7136 reseat_1 (it
, it
->current
.pos
, 1);
7138 /* We are now surely at a line start. */
7139 it
->current_x
= it
->hpos
= 0;
7140 it
->continuation_lines_width
= 0;
7142 /* Move forward and see what y-distance we moved. First move to the
7143 start of the next line so that we get its height. We need this
7144 height to be able to tell whether we reached the specified
7147 it2
.max_ascent
= it2
.max_descent
= 0;
7150 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7151 MOVE_TO_POS
| MOVE_TO_VPOS
);
7153 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7154 xassert (IT_CHARPOS (*it
) >= BEGV
);
7157 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7158 xassert (IT_CHARPOS (*it
) >= BEGV
);
7159 /* H is the actual vertical distance from the position in *IT
7160 and the starting position. */
7161 h
= it2
.current_y
- it
->current_y
;
7162 /* NLINES is the distance in number of lines. */
7163 nlines
= it2
.vpos
- it
->vpos
;
7165 /* Correct IT's y and vpos position
7166 so that they are relative to the starting point. */
7172 /* DY == 0 means move to the start of the screen line. The
7173 value of nlines is > 0 if continuation lines were involved. */
7175 move_it_by_lines (it
, nlines
, 1);
7177 /* I think this assert is bogus if buffer contains
7178 invisible text or images. KFS. */
7179 xassert (IT_CHARPOS (*it
) <= start_pos
);
7184 /* The y-position we try to reach, relative to *IT.
7185 Note that H has been subtracted in front of the if-statement. */
7186 int target_y
= it
->current_y
+ h
- dy
;
7187 int y0
= it3
.current_y
;
7188 int y1
= line_bottom_y (&it3
);
7189 int line_height
= y1
- y0
;
7191 /* If we did not reach target_y, try to move further backward if
7192 we can. If we moved too far backward, try to move forward. */
7193 if (target_y
< it
->current_y
7194 /* This is heuristic. In a window that's 3 lines high, with
7195 a line height of 13 pixels each, recentering with point
7196 on the bottom line will try to move -39/2 = 19 pixels
7197 backward. Try to avoid moving into the first line. */
7198 && (it
->current_y
- target_y
7199 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7200 && IT_CHARPOS (*it
) > BEGV
)
7202 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7203 target_y
- it
->current_y
));
7204 dy
= it
->current_y
- target_y
;
7205 goto move_further_back
;
7207 else if (target_y
>= it
->current_y
+ line_height
7208 && IT_CHARPOS (*it
) < ZV
)
7210 /* Should move forward by at least one line, maybe more.
7212 Note: Calling move_it_by_lines can be expensive on
7213 terminal frames, where compute_motion is used (via
7214 vmotion) to do the job, when there are very long lines
7215 and truncate-lines is nil. That's the reason for
7216 treating terminal frames specially here. */
7218 if (!FRAME_WINDOW_P (it
->f
))
7219 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7224 move_it_by_lines (it
, 1, 1);
7226 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7230 /* I think this assert is bogus if buffer contains
7231 invisible text or images. KFS. */
7232 xassert (IT_CHARPOS (*it
) >= BEGV
);
7239 /* Move IT by a specified amount of pixel lines DY. DY negative means
7240 move backwards. DY = 0 means move to start of screen line. At the
7241 end, IT will be on the start of a screen line. */
7244 move_it_vertically (it
, dy
)
7249 move_it_vertically_backward (it
, -dy
);
7252 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7253 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7254 MOVE_TO_POS
| MOVE_TO_Y
);
7255 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7257 /* If buffer ends in ZV without a newline, move to the start of
7258 the line to satisfy the post-condition. */
7259 if (IT_CHARPOS (*it
) == ZV
7261 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7262 move_it_by_lines (it
, 0, 0);
7267 /* Move iterator IT past the end of the text line it is in. */
7270 move_it_past_eol (it
)
7273 enum move_it_result rc
;
7275 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7276 if (rc
== MOVE_NEWLINE_OR_CR
)
7277 set_iterator_to_next (it
, 0);
7281 #if 0 /* Currently not used. */
7283 /* Return non-zero if some text between buffer positions START_CHARPOS
7284 and END_CHARPOS is invisible. IT->window is the window for text
7288 invisible_text_between_p (it
, start_charpos
, end_charpos
)
7290 int start_charpos
, end_charpos
;
7292 Lisp_Object prop
, limit
;
7293 int invisible_found_p
;
7295 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
7297 /* Is text at START invisible? */
7298 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
7300 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
7301 invisible_found_p
= 1;
7304 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
7306 make_number (end_charpos
));
7307 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
7310 return invisible_found_p
;
7316 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7317 negative means move up. DVPOS == 0 means move to the start of the
7318 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7319 NEED_Y_P is zero, IT->current_y will be left unchanged.
7321 Further optimization ideas: If we would know that IT->f doesn't use
7322 a face with proportional font, we could be faster for
7323 truncate-lines nil. */
7326 move_it_by_lines (it
, dvpos
, need_y_p
)
7328 int dvpos
, need_y_p
;
7330 struct position pos
;
7332 /* The commented-out optimization uses vmotion on terminals. This
7333 gives bad results, because elements like it->what, on which
7334 callers such as pos_visible_p rely, aren't updated. */
7335 /* if (!FRAME_WINDOW_P (it->f))
7337 struct text_pos textpos;
7339 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7340 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7341 reseat (it, textpos, 1);
7342 it->vpos += pos.vpos;
7343 it->current_y += pos.vpos;
7349 /* DVPOS == 0 means move to the start of the screen line. */
7350 move_it_vertically_backward (it
, 0);
7351 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7352 /* Let next call to line_bottom_y calculate real line height */
7357 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7358 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7359 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7364 int start_charpos
, i
;
7366 /* Start at the beginning of the screen line containing IT's
7367 position. This may actually move vertically backwards,
7368 in case of overlays, so adjust dvpos accordingly. */
7370 move_it_vertically_backward (it
, 0);
7373 /* Go back -DVPOS visible lines and reseat the iterator there. */
7374 start_charpos
= IT_CHARPOS (*it
);
7375 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7376 back_to_previous_visible_line_start (it
);
7377 reseat (it
, it
->current
.pos
, 1);
7379 /* Move further back if we end up in a string or an image. */
7380 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7382 /* First try to move to start of display line. */
7384 move_it_vertically_backward (it
, 0);
7386 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7388 /* If start of line is still in string or image,
7389 move further back. */
7390 back_to_previous_visible_line_start (it
);
7391 reseat (it
, it
->current
.pos
, 1);
7395 it
->current_x
= it
->hpos
= 0;
7397 /* Above call may have moved too far if continuation lines
7398 are involved. Scan forward and see if it did. */
7400 it2
.vpos
= it2
.current_y
= 0;
7401 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7402 it
->vpos
-= it2
.vpos
;
7403 it
->current_y
-= it2
.current_y
;
7404 it
->current_x
= it
->hpos
= 0;
7406 /* If we moved too far back, move IT some lines forward. */
7407 if (it2
.vpos
> -dvpos
)
7409 int delta
= it2
.vpos
+ dvpos
;
7411 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7412 /* Move back again if we got too far ahead. */
7413 if (IT_CHARPOS (*it
) >= start_charpos
)
7419 /* Return 1 if IT points into the middle of a display vector. */
7422 in_display_vector_p (it
)
7425 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7426 && it
->current
.dpvec_index
> 0
7427 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7431 /***********************************************************************
7433 ***********************************************************************/
7436 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7440 add_to_log (format
, arg1
, arg2
)
7442 Lisp_Object arg1
, arg2
;
7444 Lisp_Object args
[3];
7445 Lisp_Object msg
, fmt
;
7448 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7451 /* Do nothing if called asynchronously. Inserting text into
7452 a buffer may call after-change-functions and alike and
7453 that would means running Lisp asynchronously. */
7454 if (handling_signal
)
7458 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7460 args
[0] = fmt
= build_string (format
);
7463 msg
= Fformat (3, args
);
7465 len
= SBYTES (msg
) + 1;
7466 SAFE_ALLOCA (buffer
, char *, len
);
7467 bcopy (SDATA (msg
), buffer
, len
);
7469 message_dolog (buffer
, len
- 1, 1, 0);
7476 /* Output a newline in the *Messages* buffer if "needs" one. */
7479 message_log_maybe_newline ()
7481 if (message_log_need_newline
)
7482 message_dolog ("", 0, 1, 0);
7486 /* Add a string M of length NBYTES to the message log, optionally
7487 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7488 nonzero, means interpret the contents of M as multibyte. This
7489 function calls low-level routines in order to bypass text property
7490 hooks, etc. which might not be safe to run.
7492 This may GC (insert may run before/after change hooks),
7493 so the buffer M must NOT point to a Lisp string. */
7496 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7498 int nbytes
, nlflag
, multibyte
;
7500 if (!NILP (Vmemory_full
))
7503 if (!NILP (Vmessage_log_max
))
7505 struct buffer
*oldbuf
;
7506 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7507 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7508 int point_at_end
= 0;
7510 Lisp_Object old_deactivate_mark
, tem
;
7511 struct gcpro gcpro1
;
7513 old_deactivate_mark
= Vdeactivate_mark
;
7514 oldbuf
= current_buffer
;
7515 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7516 current_buffer
->undo_list
= Qt
;
7518 oldpoint
= message_dolog_marker1
;
7519 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7520 oldbegv
= message_dolog_marker2
;
7521 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7522 oldzv
= message_dolog_marker3
;
7523 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7524 GCPRO1 (old_deactivate_mark
);
7532 BEGV_BYTE
= BEG_BYTE
;
7535 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7537 /* Insert the string--maybe converting multibyte to single byte
7538 or vice versa, so that all the text fits the buffer. */
7540 && NILP (current_buffer
->enable_multibyte_characters
))
7542 int i
, c
, char_bytes
;
7543 unsigned char work
[1];
7545 /* Convert a multibyte string to single-byte
7546 for the *Message* buffer. */
7547 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7549 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7550 work
[0] = (ASCII_CHAR_P (c
)
7552 : multibyte_char_to_unibyte (c
, Qnil
));
7553 insert_1_both (work
, 1, 1, 1, 0, 0);
7556 else if (! multibyte
7557 && ! NILP (current_buffer
->enable_multibyte_characters
))
7559 int i
, c
, char_bytes
;
7560 unsigned char *msg
= (unsigned char *) m
;
7561 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7562 /* Convert a single-byte string to multibyte
7563 for the *Message* buffer. */
7564 for (i
= 0; i
< nbytes
; i
++)
7567 c
= unibyte_char_to_multibyte (c
);
7568 char_bytes
= CHAR_STRING (c
, str
);
7569 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7573 insert_1 (m
, nbytes
, 1, 0, 0);
7577 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7578 insert_1 ("\n", 1, 1, 0, 0);
7580 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7582 this_bol_byte
= PT_BYTE
;
7584 /* See if this line duplicates the previous one.
7585 If so, combine duplicates. */
7588 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7590 prev_bol_byte
= PT_BYTE
;
7592 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7593 this_bol
, this_bol_byte
);
7596 del_range_both (prev_bol
, prev_bol_byte
,
7597 this_bol
, this_bol_byte
, 0);
7603 /* If you change this format, don't forget to also
7604 change message_log_check_duplicate. */
7605 sprintf (dupstr
, " [%d times]", dup
);
7606 duplen
= strlen (dupstr
);
7607 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7608 insert_1 (dupstr
, duplen
, 1, 0, 1);
7613 /* If we have more than the desired maximum number of lines
7614 in the *Messages* buffer now, delete the oldest ones.
7615 This is safe because we don't have undo in this buffer. */
7617 if (NATNUMP (Vmessage_log_max
))
7619 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7620 -XFASTINT (Vmessage_log_max
) - 1, 0);
7621 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7624 BEGV
= XMARKER (oldbegv
)->charpos
;
7625 BEGV_BYTE
= marker_byte_position (oldbegv
);
7634 ZV
= XMARKER (oldzv
)->charpos
;
7635 ZV_BYTE
= marker_byte_position (oldzv
);
7639 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7641 /* We can't do Fgoto_char (oldpoint) because it will run some
7643 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7644 XMARKER (oldpoint
)->bytepos
);
7647 unchain_marker (XMARKER (oldpoint
));
7648 unchain_marker (XMARKER (oldbegv
));
7649 unchain_marker (XMARKER (oldzv
));
7651 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7652 set_buffer_internal (oldbuf
);
7654 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7655 message_log_need_newline
= !nlflag
;
7656 Vdeactivate_mark
= old_deactivate_mark
;
7661 /* We are at the end of the buffer after just having inserted a newline.
7662 (Note: We depend on the fact we won't be crossing the gap.)
7663 Check to see if the most recent message looks a lot like the previous one.
7664 Return 0 if different, 1 if the new one should just replace it, or a
7665 value N > 1 if we should also append " [N times]". */
7668 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7669 int prev_bol
, this_bol
;
7670 int prev_bol_byte
, this_bol_byte
;
7673 int len
= Z_BYTE
- 1 - this_bol_byte
;
7675 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7676 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7678 for (i
= 0; i
< len
; i
++)
7680 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7688 if (*p1
++ == ' ' && *p1
++ == '[')
7691 while (*p1
>= '0' && *p1
<= '9')
7692 n
= n
* 10 + *p1
++ - '0';
7693 if (strncmp (p1
, " times]\n", 8) == 0)
7700 /* Display an echo area message M with a specified length of NBYTES
7701 bytes. The string may include null characters. If M is 0, clear
7702 out any existing message, and let the mini-buffer text show
7705 This may GC, so the buffer M must NOT point to a Lisp string. */
7708 message2 (m
, nbytes
, multibyte
)
7713 /* First flush out any partial line written with print. */
7714 message_log_maybe_newline ();
7716 message_dolog (m
, nbytes
, 1, multibyte
);
7717 message2_nolog (m
, nbytes
, multibyte
);
7721 /* The non-logging counterpart of message2. */
7724 message2_nolog (m
, nbytes
, multibyte
)
7726 int nbytes
, multibyte
;
7728 struct frame
*sf
= SELECTED_FRAME ();
7729 message_enable_multibyte
= multibyte
;
7733 if (noninteractive_need_newline
)
7734 putc ('\n', stderr
);
7735 noninteractive_need_newline
= 0;
7737 fwrite (m
, nbytes
, 1, stderr
);
7738 if (cursor_in_echo_area
== 0)
7739 fprintf (stderr
, "\n");
7742 /* A null message buffer means that the frame hasn't really been
7743 initialized yet. Error messages get reported properly by
7744 cmd_error, so this must be just an informative message; toss it. */
7745 else if (INTERACTIVE
7746 && sf
->glyphs_initialized_p
7747 && FRAME_MESSAGE_BUF (sf
))
7749 Lisp_Object mini_window
;
7752 /* Get the frame containing the mini-buffer
7753 that the selected frame is using. */
7754 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7755 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7757 FRAME_SAMPLE_VISIBILITY (f
);
7758 if (FRAME_VISIBLE_P (sf
)
7759 && ! FRAME_VISIBLE_P (f
))
7760 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7764 set_message (m
, Qnil
, nbytes
, multibyte
);
7765 if (minibuffer_auto_raise
)
7766 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7769 clear_message (1, 1);
7771 do_pending_window_change (0);
7772 echo_area_display (1);
7773 do_pending_window_change (0);
7774 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7775 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7780 /* Display an echo area message M with a specified length of NBYTES
7781 bytes. The string may include null characters. If M is not a
7782 string, clear out any existing message, and let the mini-buffer
7785 This function cancels echoing. */
7788 message3 (m
, nbytes
, multibyte
)
7793 struct gcpro gcpro1
;
7796 clear_message (1,1);
7799 /* First flush out any partial line written with print. */
7800 message_log_maybe_newline ();
7806 SAFE_ALLOCA (buffer
, char *, nbytes
);
7807 bcopy (SDATA (m
), buffer
, nbytes
);
7808 message_dolog (buffer
, nbytes
, 1, multibyte
);
7811 message3_nolog (m
, nbytes
, multibyte
);
7817 /* The non-logging version of message3.
7818 This does not cancel echoing, because it is used for echoing.
7819 Perhaps we need to make a separate function for echoing
7820 and make this cancel echoing. */
7823 message3_nolog (m
, nbytes
, multibyte
)
7825 int nbytes
, multibyte
;
7827 struct frame
*sf
= SELECTED_FRAME ();
7828 message_enable_multibyte
= multibyte
;
7832 if (noninteractive_need_newline
)
7833 putc ('\n', stderr
);
7834 noninteractive_need_newline
= 0;
7836 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7837 if (cursor_in_echo_area
== 0)
7838 fprintf (stderr
, "\n");
7841 /* A null message buffer means that the frame hasn't really been
7842 initialized yet. Error messages get reported properly by
7843 cmd_error, so this must be just an informative message; toss it. */
7844 else if (INTERACTIVE
7845 && sf
->glyphs_initialized_p
7846 && FRAME_MESSAGE_BUF (sf
))
7848 Lisp_Object mini_window
;
7852 /* Get the frame containing the mini-buffer
7853 that the selected frame is using. */
7854 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7855 frame
= XWINDOW (mini_window
)->frame
;
7858 FRAME_SAMPLE_VISIBILITY (f
);
7859 if (FRAME_VISIBLE_P (sf
)
7860 && !FRAME_VISIBLE_P (f
))
7861 Fmake_frame_visible (frame
);
7863 if (STRINGP (m
) && SCHARS (m
) > 0)
7865 set_message (NULL
, m
, nbytes
, multibyte
);
7866 if (minibuffer_auto_raise
)
7867 Fraise_frame (frame
);
7868 /* Assume we are not echoing.
7869 (If we are, echo_now will override this.) */
7870 echo_message_buffer
= Qnil
;
7873 clear_message (1, 1);
7875 do_pending_window_change (0);
7876 echo_area_display (1);
7877 do_pending_window_change (0);
7878 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7879 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7884 /* Display a null-terminated echo area message M. If M is 0, clear
7885 out any existing message, and let the mini-buffer text show through.
7887 The buffer M must continue to exist until after the echo area gets
7888 cleared or some other message gets displayed there. Do not pass
7889 text that is stored in a Lisp string. Do not pass text in a buffer
7890 that was alloca'd. */
7896 message2 (m
, (m
? strlen (m
) : 0), 0);
7900 /* The non-logging counterpart of message1. */
7906 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
7909 /* Display a message M which contains a single %s
7910 which gets replaced with STRING. */
7913 message_with_string (m
, string
, log
)
7918 CHECK_STRING (string
);
7924 if (noninteractive_need_newline
)
7925 putc ('\n', stderr
);
7926 noninteractive_need_newline
= 0;
7927 fprintf (stderr
, m
, SDATA (string
));
7928 if (cursor_in_echo_area
== 0)
7929 fprintf (stderr
, "\n");
7933 else if (INTERACTIVE
)
7935 /* The frame whose minibuffer we're going to display the message on.
7936 It may be larger than the selected frame, so we need
7937 to use its buffer, not the selected frame's buffer. */
7938 Lisp_Object mini_window
;
7939 struct frame
*f
, *sf
= SELECTED_FRAME ();
7941 /* Get the frame containing the minibuffer
7942 that the selected frame is using. */
7943 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7944 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7946 /* A null message buffer means that the frame hasn't really been
7947 initialized yet. Error messages get reported properly by
7948 cmd_error, so this must be just an informative message; toss it. */
7949 if (FRAME_MESSAGE_BUF (f
))
7951 Lisp_Object args
[2], message
;
7952 struct gcpro gcpro1
, gcpro2
;
7954 args
[0] = build_string (m
);
7955 args
[1] = message
= string
;
7956 GCPRO2 (args
[0], message
);
7959 message
= Fformat (2, args
);
7962 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7964 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7968 /* Print should start at the beginning of the message
7969 buffer next time. */
7970 message_buf_print
= 0;
7976 /* Dump an informative message to the minibuf. If M is 0, clear out
7977 any existing message, and let the mini-buffer text show through. */
7981 message (m
, a1
, a2
, a3
)
7983 EMACS_INT a1
, a2
, a3
;
7989 if (noninteractive_need_newline
)
7990 putc ('\n', stderr
);
7991 noninteractive_need_newline
= 0;
7992 fprintf (stderr
, m
, a1
, a2
, a3
);
7993 if (cursor_in_echo_area
== 0)
7994 fprintf (stderr
, "\n");
7998 else if (INTERACTIVE
)
8000 /* The frame whose mini-buffer we're going to display the message
8001 on. It may be larger than the selected frame, so we need to
8002 use its buffer, not the selected frame's buffer. */
8003 Lisp_Object mini_window
;
8004 struct frame
*f
, *sf
= SELECTED_FRAME ();
8006 /* Get the frame containing the mini-buffer
8007 that the selected frame is using. */
8008 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8009 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8011 /* A null message buffer means that the frame hasn't really been
8012 initialized yet. Error messages get reported properly by
8013 cmd_error, so this must be just an informative message; toss
8015 if (FRAME_MESSAGE_BUF (f
))
8026 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8027 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8029 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8030 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8032 #endif /* NO_ARG_ARRAY */
8034 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8039 /* Print should start at the beginning of the message
8040 buffer next time. */
8041 message_buf_print
= 0;
8047 /* The non-logging version of message. */
8050 message_nolog (m
, a1
, a2
, a3
)
8052 EMACS_INT a1
, a2
, a3
;
8054 Lisp_Object old_log_max
;
8055 old_log_max
= Vmessage_log_max
;
8056 Vmessage_log_max
= Qnil
;
8057 message (m
, a1
, a2
, a3
);
8058 Vmessage_log_max
= old_log_max
;
8062 /* Display the current message in the current mini-buffer. This is
8063 only called from error handlers in process.c, and is not time
8069 if (!NILP (echo_area_buffer
[0]))
8072 string
= Fcurrent_message ();
8073 message3 (string
, SBYTES (string
),
8074 !NILP (current_buffer
->enable_multibyte_characters
));
8079 /* Make sure echo area buffers in `echo_buffers' are live.
8080 If they aren't, make new ones. */
8083 ensure_echo_area_buffers ()
8087 for (i
= 0; i
< 2; ++i
)
8088 if (!BUFFERP (echo_buffer
[i
])
8089 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8092 Lisp_Object old_buffer
;
8095 old_buffer
= echo_buffer
[i
];
8096 sprintf (name
, " *Echo Area %d*", i
);
8097 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8098 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8100 for (j
= 0; j
< 2; ++j
)
8101 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8102 echo_area_buffer
[j
] = echo_buffer
[i
];
8107 /* Call FN with args A1..A4 with either the current or last displayed
8108 echo_area_buffer as current buffer.
8110 WHICH zero means use the current message buffer
8111 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8112 from echo_buffer[] and clear it.
8114 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8115 suitable buffer from echo_buffer[] and clear it.
8117 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8118 that the current message becomes the last displayed one, make
8119 choose a suitable buffer for echo_area_buffer[0], and clear it.
8121 Value is what FN returns. */
8124 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8127 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8133 int this_one
, the_other
, clear_buffer_p
, rc
;
8134 int count
= SPECPDL_INDEX ();
8136 /* If buffers aren't live, make new ones. */
8137 ensure_echo_area_buffers ();
8142 this_one
= 0, the_other
= 1;
8144 this_one
= 1, the_other
= 0;
8147 this_one
= 0, the_other
= 1;
8150 /* We need a fresh one in case the current echo buffer equals
8151 the one containing the last displayed echo area message. */
8152 if (!NILP (echo_area_buffer
[this_one
])
8153 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8154 echo_area_buffer
[this_one
] = Qnil
;
8157 /* Choose a suitable buffer from echo_buffer[] is we don't
8159 if (NILP (echo_area_buffer
[this_one
]))
8161 echo_area_buffer
[this_one
]
8162 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8163 ? echo_buffer
[the_other
]
8164 : echo_buffer
[this_one
]);
8168 buffer
= echo_area_buffer
[this_one
];
8170 /* Don't get confused by reusing the buffer used for echoing
8171 for a different purpose. */
8172 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8175 record_unwind_protect (unwind_with_echo_area_buffer
,
8176 with_echo_area_buffer_unwind_data (w
));
8178 /* Make the echo area buffer current. Note that for display
8179 purposes, it is not necessary that the displayed window's buffer
8180 == current_buffer, except for text property lookup. So, let's
8181 only set that buffer temporarily here without doing a full
8182 Fset_window_buffer. We must also change w->pointm, though,
8183 because otherwise an assertions in unshow_buffer fails, and Emacs
8185 set_buffer_internal_1 (XBUFFER (buffer
));
8189 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8192 current_buffer
->undo_list
= Qt
;
8193 current_buffer
->read_only
= Qnil
;
8194 specbind (Qinhibit_read_only
, Qt
);
8195 specbind (Qinhibit_modification_hooks
, Qt
);
8197 if (clear_buffer_p
&& Z
> BEG
)
8200 xassert (BEGV
>= BEG
);
8201 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8203 rc
= fn (a1
, a2
, a3
, a4
);
8205 xassert (BEGV
>= BEG
);
8206 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8208 unbind_to (count
, Qnil
);
8213 /* Save state that should be preserved around the call to the function
8214 FN called in with_echo_area_buffer. */
8217 with_echo_area_buffer_unwind_data (w
)
8221 Lisp_Object vector
, tmp
;
8223 /* Reduce consing by keeping one vector in
8224 Vwith_echo_area_save_vector. */
8225 vector
= Vwith_echo_area_save_vector
;
8226 Vwith_echo_area_save_vector
= Qnil
;
8229 vector
= Fmake_vector (make_number (7), Qnil
);
8231 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8232 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8233 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8237 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8238 ASET (vector
, i
, w
->buffer
); ++i
;
8239 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8240 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8245 for (; i
< end
; ++i
)
8246 ASET (vector
, i
, Qnil
);
8249 xassert (i
== ASIZE (vector
));
8254 /* Restore global state from VECTOR which was created by
8255 with_echo_area_buffer_unwind_data. */
8258 unwind_with_echo_area_buffer (vector
)
8261 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8262 Vdeactivate_mark
= AREF (vector
, 1);
8263 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8265 if (WINDOWP (AREF (vector
, 3)))
8268 Lisp_Object buffer
, charpos
, bytepos
;
8270 w
= XWINDOW (AREF (vector
, 3));
8271 buffer
= AREF (vector
, 4);
8272 charpos
= AREF (vector
, 5);
8273 bytepos
= AREF (vector
, 6);
8276 set_marker_both (w
->pointm
, buffer
,
8277 XFASTINT (charpos
), XFASTINT (bytepos
));
8280 Vwith_echo_area_save_vector
= vector
;
8285 /* Set up the echo area for use by print functions. MULTIBYTE_P
8286 non-zero means we will print multibyte. */
8289 setup_echo_area_for_printing (multibyte_p
)
8292 /* If we can't find an echo area any more, exit. */
8293 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8296 ensure_echo_area_buffers ();
8298 if (!message_buf_print
)
8300 /* A message has been output since the last time we printed.
8301 Choose a fresh echo area buffer. */
8302 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8303 echo_area_buffer
[0] = echo_buffer
[1];
8305 echo_area_buffer
[0] = echo_buffer
[0];
8307 /* Switch to that buffer and clear it. */
8308 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8309 current_buffer
->truncate_lines
= Qnil
;
8313 int count
= SPECPDL_INDEX ();
8314 specbind (Qinhibit_read_only
, Qt
);
8315 /* Note that undo recording is always disabled. */
8317 unbind_to (count
, Qnil
);
8319 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8321 /* Set up the buffer for the multibyteness we need. */
8323 != !NILP (current_buffer
->enable_multibyte_characters
))
8324 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8326 /* Raise the frame containing the echo area. */
8327 if (minibuffer_auto_raise
)
8329 struct frame
*sf
= SELECTED_FRAME ();
8330 Lisp_Object mini_window
;
8331 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8332 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8335 message_log_maybe_newline ();
8336 message_buf_print
= 1;
8340 if (NILP (echo_area_buffer
[0]))
8342 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8343 echo_area_buffer
[0] = echo_buffer
[1];
8345 echo_area_buffer
[0] = echo_buffer
[0];
8348 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8350 /* Someone switched buffers between print requests. */
8351 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8352 current_buffer
->truncate_lines
= Qnil
;
8358 /* Display an echo area message in window W. Value is non-zero if W's
8359 height is changed. If display_last_displayed_message_p is
8360 non-zero, display the message that was last displayed, otherwise
8361 display the current message. */
8364 display_echo_area (w
)
8367 int i
, no_message_p
, window_height_changed_p
, count
;
8369 /* Temporarily disable garbage collections while displaying the echo
8370 area. This is done because a GC can print a message itself.
8371 That message would modify the echo area buffer's contents while a
8372 redisplay of the buffer is going on, and seriously confuse
8374 count
= inhibit_garbage_collection ();
8376 /* If there is no message, we must call display_echo_area_1
8377 nevertheless because it resizes the window. But we will have to
8378 reset the echo_area_buffer in question to nil at the end because
8379 with_echo_area_buffer will sets it to an empty buffer. */
8380 i
= display_last_displayed_message_p
? 1 : 0;
8381 no_message_p
= NILP (echo_area_buffer
[i
]);
8383 window_height_changed_p
8384 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8385 display_echo_area_1
,
8386 (EMACS_INT
) w
, Qnil
, 0, 0);
8389 echo_area_buffer
[i
] = Qnil
;
8391 unbind_to (count
, Qnil
);
8392 return window_height_changed_p
;
8396 /* Helper for display_echo_area. Display the current buffer which
8397 contains the current echo area message in window W, a mini-window,
8398 a pointer to which is passed in A1. A2..A4 are currently not used.
8399 Change the height of W so that all of the message is displayed.
8400 Value is non-zero if height of W was changed. */
8403 display_echo_area_1 (a1
, a2
, a3
, a4
)
8408 struct window
*w
= (struct window
*) a1
;
8410 struct text_pos start
;
8411 int window_height_changed_p
= 0;
8413 /* Do this before displaying, so that we have a large enough glyph
8414 matrix for the display. If we can't get enough space for the
8415 whole text, display the last N lines. That works by setting w->start. */
8416 window_height_changed_p
= resize_mini_window (w
, 0);
8418 /* Use the starting position chosen by resize_mini_window. */
8419 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8422 clear_glyph_matrix (w
->desired_matrix
);
8423 XSETWINDOW (window
, w
);
8424 try_window (window
, start
, 0);
8426 return window_height_changed_p
;
8430 /* Resize the echo area window to exactly the size needed for the
8431 currently displayed message, if there is one. If a mini-buffer
8432 is active, don't shrink it. */
8435 resize_echo_area_exactly ()
8437 if (BUFFERP (echo_area_buffer
[0])
8438 && WINDOWP (echo_area_window
))
8440 struct window
*w
= XWINDOW (echo_area_window
);
8442 Lisp_Object resize_exactly
;
8444 if (minibuf_level
== 0)
8445 resize_exactly
= Qt
;
8447 resize_exactly
= Qnil
;
8449 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8450 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8453 ++windows_or_buffers_changed
;
8454 ++update_mode_lines
;
8455 redisplay_internal (0);
8461 /* Callback function for with_echo_area_buffer, when used from
8462 resize_echo_area_exactly. A1 contains a pointer to the window to
8463 resize, EXACTLY non-nil means resize the mini-window exactly to the
8464 size of the text displayed. A3 and A4 are not used. Value is what
8465 resize_mini_window returns. */
8468 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8470 Lisp_Object exactly
;
8473 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8477 /* Resize mini-window W to fit the size of its contents. EXACT_P
8478 means size the window exactly to the size needed. Otherwise, it's
8479 only enlarged until W's buffer is empty.
8481 Set W->start to the right place to begin display. If the whole
8482 contents fit, start at the beginning. Otherwise, start so as
8483 to make the end of the contents appear. This is particularly
8484 important for y-or-n-p, but seems desirable generally.
8486 Value is non-zero if the window height has been changed. */
8489 resize_mini_window (w
, exact_p
)
8493 struct frame
*f
= XFRAME (w
->frame
);
8494 int window_height_changed_p
= 0;
8496 xassert (MINI_WINDOW_P (w
));
8498 /* By default, start display at the beginning. */
8499 set_marker_both (w
->start
, w
->buffer
,
8500 BUF_BEGV (XBUFFER (w
->buffer
)),
8501 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8503 /* Don't resize windows while redisplaying a window; it would
8504 confuse redisplay functions when the size of the window they are
8505 displaying changes from under them. Such a resizing can happen,
8506 for instance, when which-func prints a long message while
8507 we are running fontification-functions. We're running these
8508 functions with safe_call which binds inhibit-redisplay to t. */
8509 if (!NILP (Vinhibit_redisplay
))
8512 /* Nil means don't try to resize. */
8513 if (NILP (Vresize_mini_windows
)
8514 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8517 if (!FRAME_MINIBUF_ONLY_P (f
))
8520 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8521 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8522 int height
, max_height
;
8523 int unit
= FRAME_LINE_HEIGHT (f
);
8524 struct text_pos start
;
8525 struct buffer
*old_current_buffer
= NULL
;
8527 if (current_buffer
!= XBUFFER (w
->buffer
))
8529 old_current_buffer
= current_buffer
;
8530 set_buffer_internal (XBUFFER (w
->buffer
));
8533 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8535 /* Compute the max. number of lines specified by the user. */
8536 if (FLOATP (Vmax_mini_window_height
))
8537 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8538 else if (INTEGERP (Vmax_mini_window_height
))
8539 max_height
= XINT (Vmax_mini_window_height
);
8541 max_height
= total_height
/ 4;
8543 /* Correct that max. height if it's bogus. */
8544 max_height
= max (1, max_height
);
8545 max_height
= min (total_height
, max_height
);
8547 /* Find out the height of the text in the window. */
8548 if (it
.truncate_lines_p
)
8553 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8554 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8555 height
= it
.current_y
+ last_height
;
8557 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8558 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8559 height
= (height
+ unit
- 1) / unit
;
8562 /* Compute a suitable window start. */
8563 if (height
> max_height
)
8565 height
= max_height
;
8566 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8567 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8568 start
= it
.current
.pos
;
8571 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8572 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8574 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8576 /* Let it grow only, until we display an empty message, in which
8577 case the window shrinks again. */
8578 if (height
> WINDOW_TOTAL_LINES (w
))
8580 int old_height
= WINDOW_TOTAL_LINES (w
);
8581 freeze_window_starts (f
, 1);
8582 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8583 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8585 else if (height
< WINDOW_TOTAL_LINES (w
)
8586 && (exact_p
|| BEGV
== ZV
))
8588 int old_height
= WINDOW_TOTAL_LINES (w
);
8589 freeze_window_starts (f
, 0);
8590 shrink_mini_window (w
);
8591 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8596 /* Always resize to exact size needed. */
8597 if (height
> WINDOW_TOTAL_LINES (w
))
8599 int old_height
= WINDOW_TOTAL_LINES (w
);
8600 freeze_window_starts (f
, 1);
8601 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8602 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8604 else if (height
< WINDOW_TOTAL_LINES (w
))
8606 int old_height
= WINDOW_TOTAL_LINES (w
);
8607 freeze_window_starts (f
, 0);
8608 shrink_mini_window (w
);
8612 freeze_window_starts (f
, 1);
8613 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8616 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8620 if (old_current_buffer
)
8621 set_buffer_internal (old_current_buffer
);
8624 return window_height_changed_p
;
8628 /* Value is the current message, a string, or nil if there is no
8636 if (NILP (echo_area_buffer
[0]))
8640 with_echo_area_buffer (0, 0, current_message_1
,
8641 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8643 echo_area_buffer
[0] = Qnil
;
8651 current_message_1 (a1
, a2
, a3
, a4
)
8656 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8659 *msg
= make_buffer_string (BEG
, Z
, 1);
8666 /* Push the current message on Vmessage_stack for later restauration
8667 by restore_message. Value is non-zero if the current message isn't
8668 empty. This is a relatively infrequent operation, so it's not
8669 worth optimizing. */
8675 msg
= current_message ();
8676 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8677 return STRINGP (msg
);
8681 /* Restore message display from the top of Vmessage_stack. */
8688 xassert (CONSP (Vmessage_stack
));
8689 msg
= XCAR (Vmessage_stack
);
8691 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8693 message3_nolog (msg
, 0, 0);
8697 /* Handler for record_unwind_protect calling pop_message. */
8700 pop_message_unwind (dummy
)
8707 /* Pop the top-most entry off Vmessage_stack. */
8712 xassert (CONSP (Vmessage_stack
));
8713 Vmessage_stack
= XCDR (Vmessage_stack
);
8717 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8718 exits. If the stack is not empty, we have a missing pop_message
8722 check_message_stack ()
8724 if (!NILP (Vmessage_stack
))
8729 /* Truncate to NCHARS what will be displayed in the echo area the next
8730 time we display it---but don't redisplay it now. */
8733 truncate_echo_area (nchars
)
8737 echo_area_buffer
[0] = Qnil
;
8738 /* A null message buffer means that the frame hasn't really been
8739 initialized yet. Error messages get reported properly by
8740 cmd_error, so this must be just an informative message; toss it. */
8741 else if (!noninteractive
8743 && !NILP (echo_area_buffer
[0]))
8745 struct frame
*sf
= SELECTED_FRAME ();
8746 if (FRAME_MESSAGE_BUF (sf
))
8747 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8752 /* Helper function for truncate_echo_area. Truncate the current
8753 message to at most NCHARS characters. */
8756 truncate_message_1 (nchars
, a2
, a3
, a4
)
8761 if (BEG
+ nchars
< Z
)
8762 del_range (BEG
+ nchars
, Z
);
8764 echo_area_buffer
[0] = Qnil
;
8769 /* Set the current message to a substring of S or STRING.
8771 If STRING is a Lisp string, set the message to the first NBYTES
8772 bytes from STRING. NBYTES zero means use the whole string. If
8773 STRING is multibyte, the message will be displayed multibyte.
8775 If S is not null, set the message to the first LEN bytes of S. LEN
8776 zero means use the whole string. MULTIBYTE_P non-zero means S is
8777 multibyte. Display the message multibyte in that case.
8779 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8780 to t before calling set_message_1 (which calls insert).
8784 set_message (s
, string
, nbytes
, multibyte_p
)
8787 int nbytes
, multibyte_p
;
8789 message_enable_multibyte
8790 = ((s
&& multibyte_p
)
8791 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8793 with_echo_area_buffer (0, -1, set_message_1
,
8794 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8795 message_buf_print
= 0;
8796 help_echo_showing_p
= 0;
8800 /* Helper function for set_message. Arguments have the same meaning
8801 as there, with A1 corresponding to S and A2 corresponding to STRING
8802 This function is called with the echo area buffer being
8806 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8809 EMACS_INT nbytes
, multibyte_p
;
8811 const char *s
= (const char *) a1
;
8812 Lisp_Object string
= a2
;
8814 /* Change multibyteness of the echo buffer appropriately. */
8815 if (message_enable_multibyte
8816 != !NILP (current_buffer
->enable_multibyte_characters
))
8817 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8819 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8821 /* Insert new message at BEG. */
8822 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8824 if (STRINGP (string
))
8829 nbytes
= SBYTES (string
);
8830 nchars
= string_byte_to_char (string
, nbytes
);
8832 /* This function takes care of single/multibyte conversion. We
8833 just have to ensure that the echo area buffer has the right
8834 setting of enable_multibyte_characters. */
8835 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
8840 nbytes
= strlen (s
);
8842 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
8844 /* Convert from multi-byte to single-byte. */
8846 unsigned char work
[1];
8848 /* Convert a multibyte string to single-byte. */
8849 for (i
= 0; i
< nbytes
; i
+= n
)
8851 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
8852 work
[0] = (ASCII_CHAR_P (c
)
8854 : multibyte_char_to_unibyte (c
, Qnil
));
8855 insert_1_both (work
, 1, 1, 1, 0, 0);
8858 else if (!multibyte_p
8859 && !NILP (current_buffer
->enable_multibyte_characters
))
8861 /* Convert from single-byte to multi-byte. */
8863 const unsigned char *msg
= (const unsigned char *) s
;
8864 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8866 /* Convert a single-byte string to multibyte. */
8867 for (i
= 0; i
< nbytes
; i
++)
8870 c
= unibyte_char_to_multibyte (c
);
8871 n
= CHAR_STRING (c
, str
);
8872 insert_1_both (str
, 1, n
, 1, 0, 0);
8876 insert_1 (s
, nbytes
, 1, 0, 0);
8883 /* Clear messages. CURRENT_P non-zero means clear the current
8884 message. LAST_DISPLAYED_P non-zero means clear the message
8888 clear_message (current_p
, last_displayed_p
)
8889 int current_p
, last_displayed_p
;
8893 echo_area_buffer
[0] = Qnil
;
8894 message_cleared_p
= 1;
8897 if (last_displayed_p
)
8898 echo_area_buffer
[1] = Qnil
;
8900 message_buf_print
= 0;
8903 /* Clear garbaged frames.
8905 This function is used where the old redisplay called
8906 redraw_garbaged_frames which in turn called redraw_frame which in
8907 turn called clear_frame. The call to clear_frame was a source of
8908 flickering. I believe a clear_frame is not necessary. It should
8909 suffice in the new redisplay to invalidate all current matrices,
8910 and ensure a complete redisplay of all windows. */
8913 clear_garbaged_frames ()
8917 Lisp_Object tail
, frame
;
8918 int changed_count
= 0;
8920 FOR_EACH_FRAME (tail
, frame
)
8922 struct frame
*f
= XFRAME (frame
);
8924 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
8928 Fredraw_frame (frame
);
8929 f
->force_flush_display_p
= 1;
8931 clear_current_matrices (f
);
8940 ++windows_or_buffers_changed
;
8945 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
8946 is non-zero update selected_frame. Value is non-zero if the
8947 mini-windows height has been changed. */
8950 echo_area_display (update_frame_p
)
8953 Lisp_Object mini_window
;
8956 int window_height_changed_p
= 0;
8957 struct frame
*sf
= SELECTED_FRAME ();
8959 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8960 w
= XWINDOW (mini_window
);
8961 f
= XFRAME (WINDOW_FRAME (w
));
8963 /* Don't display if frame is invisible or not yet initialized. */
8964 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
8967 #ifdef HAVE_WINDOW_SYSTEM
8968 /* When Emacs starts, selected_frame may be the initial terminal
8969 frame. If we let this through, a message would be displayed on
8971 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
8973 #endif /* HAVE_WINDOW_SYSTEM */
8975 /* Redraw garbaged frames. */
8977 clear_garbaged_frames ();
8979 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
8981 echo_area_window
= mini_window
;
8982 window_height_changed_p
= display_echo_area (w
);
8983 w
->must_be_updated_p
= 1;
8985 /* Update the display, unless called from redisplay_internal.
8986 Also don't update the screen during redisplay itself. The
8987 update will happen at the end of redisplay, and an update
8988 here could cause confusion. */
8989 if (update_frame_p
&& !redisplaying_p
)
8993 /* If the display update has been interrupted by pending
8994 input, update mode lines in the frame. Due to the
8995 pending input, it might have been that redisplay hasn't
8996 been called, so that mode lines above the echo area are
8997 garbaged. This looks odd, so we prevent it here. */
8998 if (!display_completed
)
8999 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9001 if (window_height_changed_p
9002 /* Don't do this if Emacs is shutting down. Redisplay
9003 needs to run hooks. */
9004 && !NILP (Vrun_hooks
))
9006 /* Must update other windows. Likewise as in other
9007 cases, don't let this update be interrupted by
9009 int count
= SPECPDL_INDEX ();
9010 specbind (Qredisplay_dont_pause
, Qt
);
9011 windows_or_buffers_changed
= 1;
9012 redisplay_internal (0);
9013 unbind_to (count
, Qnil
);
9015 else if (FRAME_WINDOW_P (f
) && n
== 0)
9017 /* Window configuration is the same as before.
9018 Can do with a display update of the echo area,
9019 unless we displayed some mode lines. */
9020 update_single_window (w
, 1);
9021 FRAME_RIF (f
)->flush_display (f
);
9024 update_frame (f
, 1, 1);
9026 /* If cursor is in the echo area, make sure that the next
9027 redisplay displays the minibuffer, so that the cursor will
9028 be replaced with what the minibuffer wants. */
9029 if (cursor_in_echo_area
)
9030 ++windows_or_buffers_changed
;
9033 else if (!EQ (mini_window
, selected_window
))
9034 windows_or_buffers_changed
++;
9036 /* Last displayed message is now the current message. */
9037 echo_area_buffer
[1] = echo_area_buffer
[0];
9038 /* Inform read_char that we're not echoing. */
9039 echo_message_buffer
= Qnil
;
9041 /* Prevent redisplay optimization in redisplay_internal by resetting
9042 this_line_start_pos. This is done because the mini-buffer now
9043 displays the message instead of its buffer text. */
9044 if (EQ (mini_window
, selected_window
))
9045 CHARPOS (this_line_start_pos
) = 0;
9047 return window_height_changed_p
;
9052 /***********************************************************************
9053 Mode Lines and Frame Titles
9054 ***********************************************************************/
9056 /* A buffer for constructing non-propertized mode-line strings and
9057 frame titles in it; allocated from the heap in init_xdisp and
9058 resized as needed in store_mode_line_noprop_char. */
9060 static char *mode_line_noprop_buf
;
9062 /* The buffer's end, and a current output position in it. */
9064 static char *mode_line_noprop_buf_end
;
9065 static char *mode_line_noprop_ptr
;
9067 #define MODE_LINE_NOPROP_LEN(start) \
9068 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9071 MODE_LINE_DISPLAY
= 0,
9077 /* Alist that caches the results of :propertize.
9078 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9079 static Lisp_Object mode_line_proptrans_alist
;
9081 /* List of strings making up the mode-line. */
9082 static Lisp_Object mode_line_string_list
;
9084 /* Base face property when building propertized mode line string. */
9085 static Lisp_Object mode_line_string_face
;
9086 static Lisp_Object mode_line_string_face_prop
;
9089 /* Unwind data for mode line strings */
9091 static Lisp_Object Vmode_line_unwind_vector
;
9094 format_mode_line_unwind_data (obuf
, save_proptrans
)
9095 struct buffer
*obuf
;
9097 Lisp_Object vector
, tmp
;
9099 /* Reduce consing by keeping one vector in
9100 Vwith_echo_area_save_vector. */
9101 vector
= Vmode_line_unwind_vector
;
9102 Vmode_line_unwind_vector
= Qnil
;
9105 vector
= Fmake_vector (make_number (7), Qnil
);
9107 ASET (vector
, 0, make_number (mode_line_target
));
9108 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9109 ASET (vector
, 2, mode_line_string_list
);
9110 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9111 ASET (vector
, 4, mode_line_string_face
);
9112 ASET (vector
, 5, mode_line_string_face_prop
);
9115 XSETBUFFER (tmp
, obuf
);
9118 ASET (vector
, 6, tmp
);
9124 unwind_format_mode_line (vector
)
9127 mode_line_target
= XINT (AREF (vector
, 0));
9128 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9129 mode_line_string_list
= AREF (vector
, 2);
9130 if (! EQ (AREF (vector
, 3), Qt
))
9131 mode_line_proptrans_alist
= AREF (vector
, 3);
9132 mode_line_string_face
= AREF (vector
, 4);
9133 mode_line_string_face_prop
= AREF (vector
, 5);
9135 if (!NILP (AREF (vector
, 6)))
9137 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9138 ASET (vector
, 6, Qnil
);
9141 Vmode_line_unwind_vector
= vector
;
9146 /* Store a single character C for the frame title in mode_line_noprop_buf.
9147 Re-allocate mode_line_noprop_buf if necessary. */
9151 store_mode_line_noprop_char (char c
)
9153 store_mode_line_noprop_char (c
)
9157 /* If output position has reached the end of the allocated buffer,
9158 double the buffer's size. */
9159 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9161 int len
= MODE_LINE_NOPROP_LEN (0);
9162 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9163 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9164 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9165 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9168 *mode_line_noprop_ptr
++ = c
;
9172 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9173 mode_line_noprop_ptr. STR is the string to store. Do not copy
9174 characters that yield more columns than PRECISION; PRECISION <= 0
9175 means copy the whole string. Pad with spaces until FIELD_WIDTH
9176 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9177 pad. Called from display_mode_element when it is used to build a
9181 store_mode_line_noprop (str
, field_width
, precision
)
9182 const unsigned char *str
;
9183 int field_width
, precision
;
9188 /* Copy at most PRECISION chars from STR. */
9189 nbytes
= strlen (str
);
9190 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9192 store_mode_line_noprop_char (*str
++);
9194 /* Fill up with spaces until FIELD_WIDTH reached. */
9195 while (field_width
> 0
9198 store_mode_line_noprop_char (' ');
9205 /***********************************************************************
9207 ***********************************************************************/
9209 #ifdef HAVE_WINDOW_SYSTEM
9211 /* Set the title of FRAME, if it has changed. The title format is
9212 Vicon_title_format if FRAME is iconified, otherwise it is
9213 frame_title_format. */
9216 x_consider_frame_title (frame
)
9219 struct frame
*f
= XFRAME (frame
);
9221 if (FRAME_WINDOW_P (f
)
9222 || FRAME_MINIBUF_ONLY_P (f
)
9223 || f
->explicit_name
)
9225 /* Do we have more than one visible frame on this X display? */
9232 int count
= SPECPDL_INDEX ();
9234 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9236 Lisp_Object other_frame
= XCAR (tail
);
9237 struct frame
*tf
= XFRAME (other_frame
);
9240 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9241 && !FRAME_MINIBUF_ONLY_P (tf
)
9242 && !EQ (other_frame
, tip_frame
)
9243 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9247 /* Set global variable indicating that multiple frames exist. */
9248 multiple_frames
= CONSP (tail
);
9250 /* Switch to the buffer of selected window of the frame. Set up
9251 mode_line_target so that display_mode_element will output into
9252 mode_line_noprop_buf; then display the title. */
9253 record_unwind_protect (unwind_format_mode_line
,
9254 format_mode_line_unwind_data (current_buffer
, 0));
9256 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9257 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9259 mode_line_target
= MODE_LINE_TITLE
;
9260 title_start
= MODE_LINE_NOPROP_LEN (0);
9261 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9262 NULL
, DEFAULT_FACE_ID
);
9263 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9264 len
= MODE_LINE_NOPROP_LEN (title_start
);
9265 title
= mode_line_noprop_buf
+ title_start
;
9266 unbind_to (count
, Qnil
);
9268 /* Set the title only if it's changed. This avoids consing in
9269 the common case where it hasn't. (If it turns out that we've
9270 already wasted too much time by walking through the list with
9271 display_mode_element, then we might need to optimize at a
9272 higher level than this.) */
9273 if (! STRINGP (f
->name
)
9274 || SBYTES (f
->name
) != len
9275 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9276 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9280 #endif /* not HAVE_WINDOW_SYSTEM */
9285 /***********************************************************************
9287 ***********************************************************************/
9290 /* Prepare for redisplay by updating menu-bar item lists when
9291 appropriate. This can call eval. */
9294 prepare_menu_bars ()
9297 struct gcpro gcpro1
, gcpro2
;
9299 Lisp_Object tooltip_frame
;
9301 #ifdef HAVE_WINDOW_SYSTEM
9302 tooltip_frame
= tip_frame
;
9304 tooltip_frame
= Qnil
;
9307 /* Update all frame titles based on their buffer names, etc. We do
9308 this before the menu bars so that the buffer-menu will show the
9309 up-to-date frame titles. */
9310 #ifdef HAVE_WINDOW_SYSTEM
9311 if (windows_or_buffers_changed
|| update_mode_lines
)
9313 Lisp_Object tail
, frame
;
9315 FOR_EACH_FRAME (tail
, frame
)
9318 if (!EQ (frame
, tooltip_frame
)
9319 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9320 x_consider_frame_title (frame
);
9323 #endif /* HAVE_WINDOW_SYSTEM */
9325 /* Update the menu bar item lists, if appropriate. This has to be
9326 done before any actual redisplay or generation of display lines. */
9327 all_windows
= (update_mode_lines
9328 || buffer_shared
> 1
9329 || windows_or_buffers_changed
);
9332 Lisp_Object tail
, frame
;
9333 int count
= SPECPDL_INDEX ();
9334 /* 1 means that update_menu_bar has run its hooks
9335 so any further calls to update_menu_bar shouldn't do so again. */
9336 int menu_bar_hooks_run
= 0;
9338 record_unwind_save_match_data ();
9340 FOR_EACH_FRAME (tail
, frame
)
9344 /* Ignore tooltip frame. */
9345 if (EQ (frame
, tooltip_frame
))
9348 /* If a window on this frame changed size, report that to
9349 the user and clear the size-change flag. */
9350 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9352 Lisp_Object functions
;
9354 /* Clear flag first in case we get an error below. */
9355 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9356 functions
= Vwindow_size_change_functions
;
9357 GCPRO2 (tail
, functions
);
9359 while (CONSP (functions
))
9361 call1 (XCAR (functions
), frame
);
9362 functions
= XCDR (functions
);
9368 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9369 #ifdef HAVE_WINDOW_SYSTEM
9370 update_tool_bar (f
, 0);
9372 mac_update_title_bar (f
, 0);
9378 unbind_to (count
, Qnil
);
9382 struct frame
*sf
= SELECTED_FRAME ();
9383 update_menu_bar (sf
, 1, 0);
9384 #ifdef HAVE_WINDOW_SYSTEM
9385 update_tool_bar (sf
, 1);
9387 mac_update_title_bar (sf
, 1);
9392 /* Motif needs this. See comment in xmenu.c. Turn it off when
9393 pending_menu_activation is not defined. */
9394 #ifdef USE_X_TOOLKIT
9395 pending_menu_activation
= 0;
9400 /* Update the menu bar item list for frame F. This has to be done
9401 before we start to fill in any display lines, because it can call
9404 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9406 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9407 already ran the menu bar hooks for this redisplay, so there
9408 is no need to run them again. The return value is the
9409 updated value of this flag, to pass to the next call. */
9412 update_menu_bar (f
, save_match_data
, hooks_run
)
9414 int save_match_data
;
9418 register struct window
*w
;
9420 /* If called recursively during a menu update, do nothing. This can
9421 happen when, for instance, an activate-menubar-hook causes a
9423 if (inhibit_menubar_update
)
9426 window
= FRAME_SELECTED_WINDOW (f
);
9427 w
= XWINDOW (window
);
9429 #if 0 /* The if statement below this if statement used to include the
9430 condition !NILP (w->update_mode_line), rather than using
9431 update_mode_lines directly, and this if statement may have
9432 been added to make that condition work. Now the if
9433 statement below matches its comment, this isn't needed. */
9434 if (update_mode_lines
)
9435 w
->update_mode_line
= Qt
;
9438 if (FRAME_WINDOW_P (f
)
9440 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9441 || defined (USE_GTK)
9442 FRAME_EXTERNAL_MENU_BAR (f
)
9444 FRAME_MENU_BAR_LINES (f
) > 0
9446 : FRAME_MENU_BAR_LINES (f
) > 0)
9448 /* If the user has switched buffers or windows, we need to
9449 recompute to reflect the new bindings. But we'll
9450 recompute when update_mode_lines is set too; that means
9451 that people can use force-mode-line-update to request
9452 that the menu bar be recomputed. The adverse effect on
9453 the rest of the redisplay algorithm is about the same as
9454 windows_or_buffers_changed anyway. */
9455 if (windows_or_buffers_changed
9456 /* This used to test w->update_mode_line, but we believe
9457 there is no need to recompute the menu in that case. */
9458 || update_mode_lines
9459 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9460 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9461 != !NILP (w
->last_had_star
))
9462 || ((!NILP (Vtransient_mark_mode
)
9463 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9464 != !NILP (w
->region_showing
)))
9466 struct buffer
*prev
= current_buffer
;
9467 int count
= SPECPDL_INDEX ();
9469 specbind (Qinhibit_menubar_update
, Qt
);
9471 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9472 if (save_match_data
)
9473 record_unwind_save_match_data ();
9474 if (NILP (Voverriding_local_map_menu_flag
))
9476 specbind (Qoverriding_terminal_local_map
, Qnil
);
9477 specbind (Qoverriding_local_map
, Qnil
);
9482 /* Run the Lucid hook. */
9483 safe_run_hooks (Qactivate_menubar_hook
);
9485 /* If it has changed current-menubar from previous value,
9486 really recompute the menu-bar from the value. */
9487 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9488 call0 (Qrecompute_lucid_menubar
);
9490 safe_run_hooks (Qmenu_bar_update_hook
);
9495 XSETFRAME (Vmenu_updating_frame
, f
);
9496 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9498 /* Redisplay the menu bar in case we changed it. */
9499 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9500 || defined (USE_GTK)
9501 if (FRAME_WINDOW_P (f
))
9504 /* All frames on Mac OS share the same menubar. So only
9505 the selected frame should be allowed to set it. */
9506 if (f
== SELECTED_FRAME ())
9508 set_frame_menubar (f
, 0, 0);
9511 /* On a terminal screen, the menu bar is an ordinary screen
9512 line, and this makes it get updated. */
9513 w
->update_mode_line
= Qt
;
9514 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9515 /* In the non-toolkit version, the menu bar is an ordinary screen
9516 line, and this makes it get updated. */
9517 w
->update_mode_line
= Qt
;
9518 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9520 unbind_to (count
, Qnil
);
9521 set_buffer_internal_1 (prev
);
9530 /***********************************************************************
9532 ***********************************************************************/
9534 #ifdef HAVE_WINDOW_SYSTEM
9537 Nominal cursor position -- where to draw output.
9538 HPOS and VPOS are window relative glyph matrix coordinates.
9539 X and Y are window relative pixel coordinates. */
9541 struct cursor_pos output_cursor
;
9545 Set the global variable output_cursor to CURSOR. All cursor
9546 positions are relative to updated_window. */
9549 set_output_cursor (cursor
)
9550 struct cursor_pos
*cursor
;
9552 output_cursor
.hpos
= cursor
->hpos
;
9553 output_cursor
.vpos
= cursor
->vpos
;
9554 output_cursor
.x
= cursor
->x
;
9555 output_cursor
.y
= cursor
->y
;
9560 Set a nominal cursor position.
9562 HPOS and VPOS are column/row positions in a window glyph matrix. X
9563 and Y are window text area relative pixel positions.
9565 If this is done during an update, updated_window will contain the
9566 window that is being updated and the position is the future output
9567 cursor position for that window. If updated_window is null, use
9568 selected_window and display the cursor at the given position. */
9571 x_cursor_to (vpos
, hpos
, y
, x
)
9572 int vpos
, hpos
, y
, x
;
9576 /* If updated_window is not set, work on selected_window. */
9580 w
= XWINDOW (selected_window
);
9582 /* Set the output cursor. */
9583 output_cursor
.hpos
= hpos
;
9584 output_cursor
.vpos
= vpos
;
9585 output_cursor
.x
= x
;
9586 output_cursor
.y
= y
;
9588 /* If not called as part of an update, really display the cursor.
9589 This will also set the cursor position of W. */
9590 if (updated_window
== NULL
)
9593 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9594 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9595 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9600 #endif /* HAVE_WINDOW_SYSTEM */
9603 /***********************************************************************
9605 ***********************************************************************/
9607 #ifdef HAVE_WINDOW_SYSTEM
9609 /* Where the mouse was last time we reported a mouse event. */
9611 FRAME_PTR last_mouse_frame
;
9613 /* Tool-bar item index of the item on which a mouse button was pressed
9616 int last_tool_bar_item
;
9619 /* Update the tool-bar item list for frame F. This has to be done
9620 before we start to fill in any display lines. Called from
9621 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9622 and restore it here. */
9625 update_tool_bar (f
, save_match_data
)
9627 int save_match_data
;
9629 #if defined (USE_GTK) || USE_MAC_TOOLBAR
9630 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9632 int do_update
= WINDOWP (f
->tool_bar_window
)
9633 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9641 window
= FRAME_SELECTED_WINDOW (f
);
9642 w
= XWINDOW (window
);
9644 /* If the user has switched buffers or windows, we need to
9645 recompute to reflect the new bindings. But we'll
9646 recompute when update_mode_lines is set too; that means
9647 that people can use force-mode-line-update to request
9648 that the menu bar be recomputed. The adverse effect on
9649 the rest of the redisplay algorithm is about the same as
9650 windows_or_buffers_changed anyway. */
9651 if (windows_or_buffers_changed
9652 || !NILP (w
->update_mode_line
)
9653 || update_mode_lines
9654 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9655 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9656 != !NILP (w
->last_had_star
))
9657 || ((!NILP (Vtransient_mark_mode
)
9658 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9659 != !NILP (w
->region_showing
)))
9661 struct buffer
*prev
= current_buffer
;
9662 int count
= SPECPDL_INDEX ();
9663 Lisp_Object new_tool_bar
;
9665 struct gcpro gcpro1
;
9667 /* Set current_buffer to the buffer of the selected
9668 window of the frame, so that we get the right local
9670 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9672 /* Save match data, if we must. */
9673 if (save_match_data
)
9674 record_unwind_save_match_data ();
9676 /* Make sure that we don't accidentally use bogus keymaps. */
9677 if (NILP (Voverriding_local_map_menu_flag
))
9679 specbind (Qoverriding_terminal_local_map
, Qnil
);
9680 specbind (Qoverriding_local_map
, Qnil
);
9683 GCPRO1 (new_tool_bar
);
9685 /* Build desired tool-bar items from keymaps. */
9686 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9689 /* Redisplay the tool-bar if we changed it. */
9690 if (new_n_tool_bar
!= f
->n_tool_bar_items
9691 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9693 /* Redisplay that happens asynchronously due to an expose event
9694 may access f->tool_bar_items. Make sure we update both
9695 variables within BLOCK_INPUT so no such event interrupts. */
9697 f
->tool_bar_items
= new_tool_bar
;
9698 f
->n_tool_bar_items
= new_n_tool_bar
;
9699 w
->update_mode_line
= Qt
;
9705 unbind_to (count
, Qnil
);
9706 set_buffer_internal_1 (prev
);
9712 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9713 F's desired tool-bar contents. F->tool_bar_items must have
9714 been set up previously by calling prepare_menu_bars. */
9717 build_desired_tool_bar_string (f
)
9720 int i
, size
, size_needed
;
9721 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9722 Lisp_Object image
, plist
, props
;
9724 image
= plist
= props
= Qnil
;
9725 GCPRO3 (image
, plist
, props
);
9727 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9728 Otherwise, make a new string. */
9730 /* The size of the string we might be able to reuse. */
9731 size
= (STRINGP (f
->desired_tool_bar_string
)
9732 ? SCHARS (f
->desired_tool_bar_string
)
9735 /* We need one space in the string for each image. */
9736 size_needed
= f
->n_tool_bar_items
;
9738 /* Reuse f->desired_tool_bar_string, if possible. */
9739 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9740 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9744 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9745 Fremove_text_properties (make_number (0), make_number (size
),
9746 props
, f
->desired_tool_bar_string
);
9749 /* Put a `display' property on the string for the images to display,
9750 put a `menu_item' property on tool-bar items with a value that
9751 is the index of the item in F's tool-bar item vector. */
9752 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9754 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9756 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9757 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9758 int hmargin
, vmargin
, relief
, idx
, end
;
9759 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9761 /* If image is a vector, choose the image according to the
9763 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9764 if (VECTORP (image
))
9768 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9769 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9772 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9773 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9775 xassert (ASIZE (image
) >= idx
);
9776 image
= AREF (image
, idx
);
9781 /* Ignore invalid image specifications. */
9782 if (!valid_image_p (image
))
9785 /* Display the tool-bar button pressed, or depressed. */
9786 plist
= Fcopy_sequence (XCDR (image
));
9788 /* Compute margin and relief to draw. */
9789 relief
= (tool_bar_button_relief
>= 0
9790 ? tool_bar_button_relief
9791 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9792 hmargin
= vmargin
= relief
;
9794 if (INTEGERP (Vtool_bar_button_margin
)
9795 && XINT (Vtool_bar_button_margin
) > 0)
9797 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9798 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9800 else if (CONSP (Vtool_bar_button_margin
))
9802 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9803 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9804 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9806 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9807 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9808 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9811 if (auto_raise_tool_bar_buttons_p
)
9813 /* Add a `:relief' property to the image spec if the item is
9817 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
9824 /* If image is selected, display it pressed, i.e. with a
9825 negative relief. If it's not selected, display it with a
9827 plist
= Fplist_put (plist
, QCrelief
,
9829 ? make_number (-relief
)
9830 : make_number (relief
)));
9835 /* Put a margin around the image. */
9836 if (hmargin
|| vmargin
)
9838 if (hmargin
== vmargin
)
9839 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
9841 plist
= Fplist_put (plist
, QCmargin
,
9842 Fcons (make_number (hmargin
),
9843 make_number (vmargin
)));
9846 /* If button is not enabled, and we don't have special images
9847 for the disabled state, make the image appear disabled by
9848 applying an appropriate algorithm to it. */
9849 if (!enabled_p
&& idx
< 0)
9850 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
9852 /* Put a `display' text property on the string for the image to
9853 display. Put a `menu-item' property on the string that gives
9854 the start of this item's properties in the tool-bar items
9856 image
= Fcons (Qimage
, plist
);
9857 props
= list4 (Qdisplay
, image
,
9858 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
9860 /* Let the last image hide all remaining spaces in the tool bar
9861 string. The string can be longer than needed when we reuse a
9863 if (i
+ 1 == f
->n_tool_bar_items
)
9864 end
= SCHARS (f
->desired_tool_bar_string
);
9867 Fadd_text_properties (make_number (i
), make_number (end
),
9868 props
, f
->desired_tool_bar_string
);
9876 /* Display one line of the tool-bar of frame IT->f.
9878 HEIGHT specifies the desired height of the tool-bar line.
9879 If the actual height of the glyph row is less than HEIGHT, the
9880 row's height is increased to HEIGHT, and the icons are centered
9881 vertically in the new height.
9883 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
9884 count a final empty row in case the tool-bar width exactly matches
9889 display_tool_bar_line (it
, height
)
9893 struct glyph_row
*row
= it
->glyph_row
;
9894 int max_x
= it
->last_visible_x
;
9897 prepare_desired_row (row
);
9898 row
->y
= it
->current_y
;
9900 /* Note that this isn't made use of if the face hasn't a box,
9901 so there's no need to check the face here. */
9902 it
->start_of_box_run_p
= 1;
9904 while (it
->current_x
< max_x
)
9906 int x
, n_glyphs_before
, i
, nglyphs
;
9907 struct it it_before
;
9909 /* Get the next display element. */
9910 if (!get_next_display_element (it
))
9912 /* Don't count empty row if we are counting needed tool-bar lines. */
9913 if (height
< 0 && !it
->hpos
)
9918 /* Produce glyphs. */
9919 n_glyphs_before
= row
->used
[TEXT_AREA
];
9922 PRODUCE_GLYPHS (it
);
9924 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
9926 x
= it_before
.current_x
;
9929 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
9931 if (x
+ glyph
->pixel_width
> max_x
)
9933 /* Glyph doesn't fit on line. Backtrack. */
9934 row
->used
[TEXT_AREA
] = n_glyphs_before
;
9936 /* If this is the only glyph on this line, it will never fit on the
9937 toolbar, so skip it. But ensure there is at least one glyph,
9938 so we don't accidentally disable the tool-bar. */
9939 if (n_glyphs_before
== 0
9940 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
9946 x
+= glyph
->pixel_width
;
9950 /* Stop at line ends. */
9951 if (ITERATOR_AT_END_OF_LINE_P (it
))
9954 set_iterator_to_next (it
, 1);
9959 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
9961 /* Use default face for the border below the tool bar.
9963 FIXME: When auto-resize-tool-bars is grow-only, there is
9964 no additional border below the possibly empty tool-bar lines.
9965 So to make the extra empty lines look "normal", we have to
9966 use the tool-bar face for the border too. */
9967 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
9968 it
->face_id
= DEFAULT_FACE_ID
;
9970 extend_face_to_end_of_line (it
);
9971 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
9972 last
->right_box_line_p
= 1;
9973 if (last
== row
->glyphs
[TEXT_AREA
])
9974 last
->left_box_line_p
= 1;
9976 /* Make line the desired height and center it vertically. */
9977 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
9979 /* Don't add more than one line height. */
9980 height
%= FRAME_LINE_HEIGHT (it
->f
);
9981 it
->max_ascent
+= height
/ 2;
9982 it
->max_descent
+= (height
+ 1) / 2;
9985 compute_line_metrics (it
);
9987 /* If line is empty, make it occupy the rest of the tool-bar. */
9988 if (!row
->displays_text_p
)
9990 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
9991 row
->visible_height
= row
->height
;
9992 row
->ascent
= row
->phys_ascent
= 0;
9993 row
->extra_line_spacing
= 0;
9996 row
->full_width_p
= 1;
9997 row
->continued_p
= 0;
9998 row
->truncated_on_left_p
= 0;
9999 row
->truncated_on_right_p
= 0;
10001 it
->current_x
= it
->hpos
= 0;
10002 it
->current_y
+= row
->height
;
10008 /* Max tool-bar height. */
10010 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10011 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10013 /* Value is the number of screen lines needed to make all tool-bar
10014 items of frame F visible. The number of actual rows needed is
10015 returned in *N_ROWS if non-NULL. */
10018 tool_bar_lines_needed (f
, n_rows
)
10022 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10024 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10025 the desired matrix, so use (unused) mode-line row as temporary row to
10026 avoid destroying the first tool-bar row. */
10027 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10029 /* Initialize an iterator for iteration over
10030 F->desired_tool_bar_string in the tool-bar window of frame F. */
10031 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10032 it
.first_visible_x
= 0;
10033 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10034 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10036 while (!ITERATOR_AT_END_P (&it
))
10038 clear_glyph_row (temp_row
);
10039 it
.glyph_row
= temp_row
;
10040 display_tool_bar_line (&it
, -1);
10042 clear_glyph_row (temp_row
);
10044 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10046 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10048 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10052 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10054 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10063 frame
= selected_frame
;
10065 CHECK_FRAME (frame
);
10066 f
= XFRAME (frame
);
10068 if (WINDOWP (f
->tool_bar_window
)
10069 || (w
= XWINDOW (f
->tool_bar_window
),
10070 WINDOW_TOTAL_LINES (w
) > 0))
10072 update_tool_bar (f
, 1);
10073 if (f
->n_tool_bar_items
)
10075 build_desired_tool_bar_string (f
);
10076 nlines
= tool_bar_lines_needed (f
, NULL
);
10080 return make_number (nlines
);
10084 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10085 height should be changed. */
10088 redisplay_tool_bar (f
)
10093 struct glyph_row
*row
;
10095 #if defined (USE_GTK) || USE_MAC_TOOLBAR
10096 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10097 update_frame_tool_bar (f
);
10101 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10102 do anything. This means you must start with tool-bar-lines
10103 non-zero to get the auto-sizing effect. Or in other words, you
10104 can turn off tool-bars by specifying tool-bar-lines zero. */
10105 if (!WINDOWP (f
->tool_bar_window
)
10106 || (w
= XWINDOW (f
->tool_bar_window
),
10107 WINDOW_TOTAL_LINES (w
) == 0))
10110 /* Set up an iterator for the tool-bar window. */
10111 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10112 it
.first_visible_x
= 0;
10113 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10114 row
= it
.glyph_row
;
10116 /* Build a string that represents the contents of the tool-bar. */
10117 build_desired_tool_bar_string (f
);
10118 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10120 if (f
->n_tool_bar_rows
== 0)
10124 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10125 nlines
!= WINDOW_TOTAL_LINES (w
)))
10127 extern Lisp_Object Qtool_bar_lines
;
10129 int old_height
= WINDOW_TOTAL_LINES (w
);
10131 XSETFRAME (frame
, f
);
10132 Fmodify_frame_parameters (frame
,
10133 Fcons (Fcons (Qtool_bar_lines
,
10134 make_number (nlines
)),
10136 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10138 clear_glyph_matrix (w
->desired_matrix
);
10139 fonts_changed_p
= 1;
10145 /* Display as many lines as needed to display all tool-bar items. */
10147 if (f
->n_tool_bar_rows
> 0)
10149 int border
, rows
, height
, extra
;
10151 if (INTEGERP (Vtool_bar_border
))
10152 border
= XINT (Vtool_bar_border
);
10153 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10154 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10155 else if (EQ (Vtool_bar_border
, Qborder_width
))
10156 border
= f
->border_width
;
10162 rows
= f
->n_tool_bar_rows
;
10163 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10164 extra
= it
.last_visible_y
- border
- height
* rows
;
10166 while (it
.current_y
< it
.last_visible_y
)
10169 if (extra
> 0 && rows
-- > 0)
10171 h
= (extra
+ rows
- 1) / rows
;
10174 display_tool_bar_line (&it
, height
+ h
);
10179 while (it
.current_y
< it
.last_visible_y
)
10180 display_tool_bar_line (&it
, 0);
10183 /* It doesn't make much sense to try scrolling in the tool-bar
10184 window, so don't do it. */
10185 w
->desired_matrix
->no_scrolling_p
= 1;
10186 w
->must_be_updated_p
= 1;
10188 if (!NILP (Vauto_resize_tool_bars
))
10190 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10191 int change_height_p
= 0;
10193 /* If we couldn't display everything, change the tool-bar's
10194 height if there is room for more. */
10195 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10196 && it
.current_y
< max_tool_bar_height
)
10197 change_height_p
= 1;
10199 row
= it
.glyph_row
- 1;
10201 /* If there are blank lines at the end, except for a partially
10202 visible blank line at the end that is smaller than
10203 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10204 if (!row
->displays_text_p
10205 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10206 change_height_p
= 1;
10208 /* If row displays tool-bar items, but is partially visible,
10209 change the tool-bar's height. */
10210 if (row
->displays_text_p
10211 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10212 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10213 change_height_p
= 1;
10215 /* Resize windows as needed by changing the `tool-bar-lines'
10216 frame parameter. */
10217 if (change_height_p
)
10219 extern Lisp_Object Qtool_bar_lines
;
10221 int old_height
= WINDOW_TOTAL_LINES (w
);
10223 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10225 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10226 && !f
->minimize_tool_bar_window_p
)
10227 ? (nlines
> old_height
)
10228 : (nlines
!= old_height
));
10229 f
->minimize_tool_bar_window_p
= 0;
10231 if (change_height_p
)
10233 XSETFRAME (frame
, f
);
10234 Fmodify_frame_parameters (frame
,
10235 Fcons (Fcons (Qtool_bar_lines
,
10236 make_number (nlines
)),
10238 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10240 clear_glyph_matrix (w
->desired_matrix
);
10241 f
->n_tool_bar_rows
= nrows
;
10242 fonts_changed_p
= 1;
10249 f
->minimize_tool_bar_window_p
= 0;
10254 /* Get information about the tool-bar item which is displayed in GLYPH
10255 on frame F. Return in *PROP_IDX the index where tool-bar item
10256 properties start in F->tool_bar_items. Value is zero if
10257 GLYPH doesn't display a tool-bar item. */
10260 tool_bar_item_info (f
, glyph
, prop_idx
)
10262 struct glyph
*glyph
;
10269 /* This function can be called asynchronously, which means we must
10270 exclude any possibility that Fget_text_property signals an
10272 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10273 charpos
= max (0, charpos
);
10275 /* Get the text property `menu-item' at pos. The value of that
10276 property is the start index of this item's properties in
10277 F->tool_bar_items. */
10278 prop
= Fget_text_property (make_number (charpos
),
10279 Qmenu_item
, f
->current_tool_bar_string
);
10280 if (INTEGERP (prop
))
10282 *prop_idx
= XINT (prop
);
10292 /* Get information about the tool-bar item at position X/Y on frame F.
10293 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10294 the current matrix of the tool-bar window of F, or NULL if not
10295 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10296 item in F->tool_bar_items. Value is
10298 -1 if X/Y is not on a tool-bar item
10299 0 if X/Y is on the same item that was highlighted before.
10303 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10306 struct glyph
**glyph
;
10307 int *hpos
, *vpos
, *prop_idx
;
10309 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10310 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10313 /* Find the glyph under X/Y. */
10314 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10315 if (*glyph
== NULL
)
10318 /* Get the start of this tool-bar item's properties in
10319 f->tool_bar_items. */
10320 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10323 /* Is mouse on the highlighted item? */
10324 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10325 && *vpos
>= dpyinfo
->mouse_face_beg_row
10326 && *vpos
<= dpyinfo
->mouse_face_end_row
10327 && (*vpos
> dpyinfo
->mouse_face_beg_row
10328 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10329 && (*vpos
< dpyinfo
->mouse_face_end_row
10330 || *hpos
< dpyinfo
->mouse_face_end_col
10331 || dpyinfo
->mouse_face_past_end
))
10339 Handle mouse button event on the tool-bar of frame F, at
10340 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10341 0 for button release. MODIFIERS is event modifiers for button
10345 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10348 unsigned int modifiers
;
10350 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10351 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10352 int hpos
, vpos
, prop_idx
;
10353 struct glyph
*glyph
;
10354 Lisp_Object enabled_p
;
10356 /* If not on the highlighted tool-bar item, return. */
10357 frame_to_window_pixel_xy (w
, &x
, &y
);
10358 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10361 /* If item is disabled, do nothing. */
10362 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10363 if (NILP (enabled_p
))
10368 /* Show item in pressed state. */
10369 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10370 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10371 last_tool_bar_item
= prop_idx
;
10375 Lisp_Object key
, frame
;
10376 struct input_event event
;
10377 EVENT_INIT (event
);
10379 /* Show item in released state. */
10380 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10381 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10383 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10385 XSETFRAME (frame
, f
);
10386 event
.kind
= TOOL_BAR_EVENT
;
10387 event
.frame_or_window
= frame
;
10389 kbd_buffer_store_event (&event
);
10391 event
.kind
= TOOL_BAR_EVENT
;
10392 event
.frame_or_window
= frame
;
10394 event
.modifiers
= modifiers
;
10395 kbd_buffer_store_event (&event
);
10396 last_tool_bar_item
= -1;
10401 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10402 tool-bar window-relative coordinates X/Y. Called from
10403 note_mouse_highlight. */
10406 note_tool_bar_highlight (f
, x
, y
)
10410 Lisp_Object window
= f
->tool_bar_window
;
10411 struct window
*w
= XWINDOW (window
);
10412 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10414 struct glyph
*glyph
;
10415 struct glyph_row
*row
;
10417 Lisp_Object enabled_p
;
10419 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10420 int mouse_down_p
, rc
;
10422 /* Function note_mouse_highlight is called with negative x(y
10423 values when mouse moves outside of the frame. */
10424 if (x
<= 0 || y
<= 0)
10426 clear_mouse_face (dpyinfo
);
10430 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10433 /* Not on tool-bar item. */
10434 clear_mouse_face (dpyinfo
);
10438 /* On same tool-bar item as before. */
10439 goto set_help_echo
;
10441 clear_mouse_face (dpyinfo
);
10443 /* Mouse is down, but on different tool-bar item? */
10444 mouse_down_p
= (dpyinfo
->grabbed
10445 && f
== last_mouse_frame
10446 && FRAME_LIVE_P (f
));
10448 && last_tool_bar_item
!= prop_idx
)
10451 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10452 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10454 /* If tool-bar item is not enabled, don't highlight it. */
10455 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10456 if (!NILP (enabled_p
))
10458 /* Compute the x-position of the glyph. In front and past the
10459 image is a space. We include this in the highlighted area. */
10460 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10461 for (i
= x
= 0; i
< hpos
; ++i
)
10462 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10464 /* Record this as the current active region. */
10465 dpyinfo
->mouse_face_beg_col
= hpos
;
10466 dpyinfo
->mouse_face_beg_row
= vpos
;
10467 dpyinfo
->mouse_face_beg_x
= x
;
10468 dpyinfo
->mouse_face_beg_y
= row
->y
;
10469 dpyinfo
->mouse_face_past_end
= 0;
10471 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10472 dpyinfo
->mouse_face_end_row
= vpos
;
10473 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10474 dpyinfo
->mouse_face_end_y
= row
->y
;
10475 dpyinfo
->mouse_face_window
= window
;
10476 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10478 /* Display it as active. */
10479 show_mouse_face (dpyinfo
, draw
);
10480 dpyinfo
->mouse_face_image_state
= draw
;
10485 /* Set help_echo_string to a help string to display for this tool-bar item.
10486 XTread_socket does the rest. */
10487 help_echo_object
= help_echo_window
= Qnil
;
10488 help_echo_pos
= -1;
10489 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10490 if (NILP (help_echo_string
))
10491 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10494 #endif /* HAVE_WINDOW_SYSTEM */
10498 /************************************************************************
10499 Horizontal scrolling
10500 ************************************************************************/
10502 static int hscroll_window_tree
P_ ((Lisp_Object
));
10503 static int hscroll_windows
P_ ((Lisp_Object
));
10505 /* For all leaf windows in the window tree rooted at WINDOW, set their
10506 hscroll value so that PT is (i) visible in the window, and (ii) so
10507 that it is not within a certain margin at the window's left and
10508 right border. Value is non-zero if any window's hscroll has been
10512 hscroll_window_tree (window
)
10513 Lisp_Object window
;
10515 int hscrolled_p
= 0;
10516 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10517 int hscroll_step_abs
= 0;
10518 double hscroll_step_rel
= 0;
10520 if (hscroll_relative_p
)
10522 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10523 if (hscroll_step_rel
< 0)
10525 hscroll_relative_p
= 0;
10526 hscroll_step_abs
= 0;
10529 else if (INTEGERP (Vhscroll_step
))
10531 hscroll_step_abs
= XINT (Vhscroll_step
);
10532 if (hscroll_step_abs
< 0)
10533 hscroll_step_abs
= 0;
10536 hscroll_step_abs
= 0;
10538 while (WINDOWP (window
))
10540 struct window
*w
= XWINDOW (window
);
10542 if (WINDOWP (w
->hchild
))
10543 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10544 else if (WINDOWP (w
->vchild
))
10545 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10546 else if (w
->cursor
.vpos
>= 0)
10549 int text_area_width
;
10550 struct glyph_row
*current_cursor_row
10551 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10552 struct glyph_row
*desired_cursor_row
10553 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10554 struct glyph_row
*cursor_row
10555 = (desired_cursor_row
->enabled_p
10556 ? desired_cursor_row
10557 : current_cursor_row
);
10559 text_area_width
= window_box_width (w
, TEXT_AREA
);
10561 /* Scroll when cursor is inside this scroll margin. */
10562 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10564 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10565 && ((XFASTINT (w
->hscroll
)
10566 && w
->cursor
.x
<= h_margin
)
10567 || (cursor_row
->enabled_p
10568 && cursor_row
->truncated_on_right_p
10569 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10573 struct buffer
*saved_current_buffer
;
10577 /* Find point in a display of infinite width. */
10578 saved_current_buffer
= current_buffer
;
10579 current_buffer
= XBUFFER (w
->buffer
);
10581 if (w
== XWINDOW (selected_window
))
10582 pt
= BUF_PT (current_buffer
);
10585 pt
= marker_position (w
->pointm
);
10586 pt
= max (BEGV
, pt
);
10590 /* Move iterator to pt starting at cursor_row->start in
10591 a line with infinite width. */
10592 init_to_row_start (&it
, w
, cursor_row
);
10593 it
.last_visible_x
= INFINITY
;
10594 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10595 current_buffer
= saved_current_buffer
;
10597 /* Position cursor in window. */
10598 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10599 hscroll
= max (0, (it
.current_x
10600 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10601 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10602 : (text_area_width
/ 2))))
10603 / FRAME_COLUMN_WIDTH (it
.f
);
10604 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10606 if (hscroll_relative_p
)
10607 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10610 wanted_x
= text_area_width
10611 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10614 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10618 if (hscroll_relative_p
)
10619 wanted_x
= text_area_width
* hscroll_step_rel
10622 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10625 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10627 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10629 /* Don't call Fset_window_hscroll if value hasn't
10630 changed because it will prevent redisplay
10632 if (XFASTINT (w
->hscroll
) != hscroll
)
10634 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10635 w
->hscroll
= make_number (hscroll
);
10644 /* Value is non-zero if hscroll of any leaf window has been changed. */
10645 return hscrolled_p
;
10649 /* Set hscroll so that cursor is visible and not inside horizontal
10650 scroll margins for all windows in the tree rooted at WINDOW. See
10651 also hscroll_window_tree above. Value is non-zero if any window's
10652 hscroll has been changed. If it has, desired matrices on the frame
10653 of WINDOW are cleared. */
10656 hscroll_windows (window
)
10657 Lisp_Object window
;
10659 int hscrolled_p
= hscroll_window_tree (window
);
10661 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10662 return hscrolled_p
;
10667 /************************************************************************
10669 ************************************************************************/
10671 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10672 to a non-zero value. This is sometimes handy to have in a debugger
10677 /* First and last unchanged row for try_window_id. */
10679 int debug_first_unchanged_at_end_vpos
;
10680 int debug_last_unchanged_at_beg_vpos
;
10682 /* Delta vpos and y. */
10684 int debug_dvpos
, debug_dy
;
10686 /* Delta in characters and bytes for try_window_id. */
10688 int debug_delta
, debug_delta_bytes
;
10690 /* Values of window_end_pos and window_end_vpos at the end of
10693 EMACS_INT debug_end_pos
, debug_end_vpos
;
10695 /* Append a string to W->desired_matrix->method. FMT is a printf
10696 format string. A1...A9 are a supplement for a variable-length
10697 argument list. If trace_redisplay_p is non-zero also printf the
10698 resulting string to stderr. */
10701 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10704 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10707 char *method
= w
->desired_matrix
->method
;
10708 int len
= strlen (method
);
10709 int size
= sizeof w
->desired_matrix
->method
;
10710 int remaining
= size
- len
- 1;
10712 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10713 if (len
&& remaining
)
10716 --remaining
, ++len
;
10719 strncpy (method
+ len
, buffer
, remaining
);
10721 if (trace_redisplay_p
)
10722 fprintf (stderr
, "%p (%s): %s\n",
10724 ((BUFFERP (w
->buffer
)
10725 && STRINGP (XBUFFER (w
->buffer
)->name
))
10726 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10731 #endif /* GLYPH_DEBUG */
10734 /* Value is non-zero if all changes in window W, which displays
10735 current_buffer, are in the text between START and END. START is a
10736 buffer position, END is given as a distance from Z. Used in
10737 redisplay_internal for display optimization. */
10740 text_outside_line_unchanged_p (w
, start
, end
)
10744 int unchanged_p
= 1;
10746 /* If text or overlays have changed, see where. */
10747 if (XFASTINT (w
->last_modified
) < MODIFF
10748 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10750 /* Gap in the line? */
10751 if (GPT
< start
|| Z
- GPT
< end
)
10754 /* Changes start in front of the line, or end after it? */
10756 && (BEG_UNCHANGED
< start
- 1
10757 || END_UNCHANGED
< end
))
10760 /* If selective display, can't optimize if changes start at the
10761 beginning of the line. */
10763 && INTEGERP (current_buffer
->selective_display
)
10764 && XINT (current_buffer
->selective_display
) > 0
10765 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10768 /* If there are overlays at the start or end of the line, these
10769 may have overlay strings with newlines in them. A change at
10770 START, for instance, may actually concern the display of such
10771 overlay strings as well, and they are displayed on different
10772 lines. So, quickly rule out this case. (For the future, it
10773 might be desirable to implement something more telling than
10774 just BEG/END_UNCHANGED.) */
10777 if (BEG
+ BEG_UNCHANGED
== start
10778 && overlay_touches_p (start
))
10780 if (END_UNCHANGED
== end
10781 && overlay_touches_p (Z
- end
))
10786 return unchanged_p
;
10790 /* Do a frame update, taking possible shortcuts into account. This is
10791 the main external entry point for redisplay.
10793 If the last redisplay displayed an echo area message and that message
10794 is no longer requested, we clear the echo area or bring back the
10795 mini-buffer if that is in use. */
10800 redisplay_internal (0);
10805 overlay_arrow_string_or_property (var
)
10810 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10813 return Voverlay_arrow_string
;
10816 /* Return 1 if there are any overlay-arrows in current_buffer. */
10818 overlay_arrow_in_current_buffer_p ()
10822 for (vlist
= Voverlay_arrow_variable_list
;
10824 vlist
= XCDR (vlist
))
10826 Lisp_Object var
= XCAR (vlist
);
10829 if (!SYMBOLP (var
))
10831 val
= find_symbol_value (var
);
10833 && current_buffer
== XMARKER (val
)->buffer
)
10840 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
10844 overlay_arrows_changed_p ()
10848 for (vlist
= Voverlay_arrow_variable_list
;
10850 vlist
= XCDR (vlist
))
10852 Lisp_Object var
= XCAR (vlist
);
10853 Lisp_Object val
, pstr
;
10855 if (!SYMBOLP (var
))
10857 val
= find_symbol_value (var
);
10858 if (!MARKERP (val
))
10860 if (! EQ (COERCE_MARKER (val
),
10861 Fget (var
, Qlast_arrow_position
))
10862 || ! (pstr
= overlay_arrow_string_or_property (var
),
10863 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
10869 /* Mark overlay arrows to be updated on next redisplay. */
10872 update_overlay_arrows (up_to_date
)
10877 for (vlist
= Voverlay_arrow_variable_list
;
10879 vlist
= XCDR (vlist
))
10881 Lisp_Object var
= XCAR (vlist
);
10883 if (!SYMBOLP (var
))
10886 if (up_to_date
> 0)
10888 Lisp_Object val
= find_symbol_value (var
);
10889 Fput (var
, Qlast_arrow_position
,
10890 COERCE_MARKER (val
));
10891 Fput (var
, Qlast_arrow_string
,
10892 overlay_arrow_string_or_property (var
));
10894 else if (up_to_date
< 0
10895 || !NILP (Fget (var
, Qlast_arrow_position
)))
10897 Fput (var
, Qlast_arrow_position
, Qt
);
10898 Fput (var
, Qlast_arrow_string
, Qt
);
10904 /* Return overlay arrow string to display at row.
10905 Return integer (bitmap number) for arrow bitmap in left fringe.
10906 Return nil if no overlay arrow. */
10909 overlay_arrow_at_row (it
, row
)
10911 struct glyph_row
*row
;
10915 for (vlist
= Voverlay_arrow_variable_list
;
10917 vlist
= XCDR (vlist
))
10919 Lisp_Object var
= XCAR (vlist
);
10922 if (!SYMBOLP (var
))
10925 val
= find_symbol_value (var
);
10928 && current_buffer
== XMARKER (val
)->buffer
10929 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
10931 if (FRAME_WINDOW_P (it
->f
)
10932 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
10934 #ifdef HAVE_WINDOW_SYSTEM
10935 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
10938 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
10939 return make_number (fringe_bitmap
);
10942 return make_number (-1); /* Use default arrow bitmap */
10944 return overlay_arrow_string_or_property (var
);
10951 /* Return 1 if point moved out of or into a composition. Otherwise
10952 return 0. PREV_BUF and PREV_PT are the last point buffer and
10953 position. BUF and PT are the current point buffer and position. */
10956 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
10957 struct buffer
*prev_buf
, *buf
;
10960 EMACS_INT start
, end
;
10962 Lisp_Object buffer
;
10964 XSETBUFFER (buffer
, buf
);
10965 /* Check a composition at the last point if point moved within the
10967 if (prev_buf
== buf
)
10970 /* Point didn't move. */
10973 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
10974 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
10975 && COMPOSITION_VALID_P (start
, end
, prop
)
10976 && start
< prev_pt
&& end
> prev_pt
)
10977 /* The last point was within the composition. Return 1 iff
10978 point moved out of the composition. */
10979 return (pt
<= start
|| pt
>= end
);
10982 /* Check a composition at the current point. */
10983 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
10984 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
10985 && COMPOSITION_VALID_P (start
, end
, prop
)
10986 && start
< pt
&& end
> pt
);
10990 /* Reconsider the setting of B->clip_changed which is displayed
10994 reconsider_clip_changes (w
, b
)
10998 if (b
->clip_changed
10999 && !NILP (w
->window_end_valid
)
11000 && w
->current_matrix
->buffer
== b
11001 && w
->current_matrix
->zv
== BUF_ZV (b
)
11002 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11003 b
->clip_changed
= 0;
11005 /* If display wasn't paused, and W is not a tool bar window, see if
11006 point has been moved into or out of a composition. In that case,
11007 we set b->clip_changed to 1 to force updating the screen. If
11008 b->clip_changed has already been set to 1, we can skip this
11010 if (!b
->clip_changed
11011 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11015 if (w
== XWINDOW (selected_window
))
11016 pt
= BUF_PT (current_buffer
);
11018 pt
= marker_position (w
->pointm
);
11020 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11021 || pt
!= XINT (w
->last_point
))
11022 && check_point_in_composition (w
->current_matrix
->buffer
,
11023 XINT (w
->last_point
),
11024 XBUFFER (w
->buffer
), pt
))
11025 b
->clip_changed
= 1;
11030 /* Select FRAME to forward the values of frame-local variables into C
11031 variables so that the redisplay routines can access those values
11035 select_frame_for_redisplay (frame
)
11038 Lisp_Object tail
, sym
, val
;
11039 Lisp_Object old
= selected_frame
;
11041 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11043 selected_frame
= frame
;
11047 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11048 if (CONSP (XCAR (tail
))
11049 && (sym
= XCAR (XCAR (tail
)),
11051 && (sym
= indirect_variable (sym
),
11052 val
= SYMBOL_VALUE (sym
),
11053 (BUFFER_LOCAL_VALUEP (val
)))
11054 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11055 /* Use find_symbol_value rather than Fsymbol_value
11056 to avoid an error if it is void. */
11057 find_symbol_value (sym
);
11058 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11062 #define STOP_POLLING \
11063 do { if (! polling_stopped_here) stop_polling (); \
11064 polling_stopped_here = 1; } while (0)
11066 #define RESUME_POLLING \
11067 do { if (polling_stopped_here) start_polling (); \
11068 polling_stopped_here = 0; } while (0)
11071 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11072 response to any user action; therefore, we should preserve the echo
11073 area. (Actually, our caller does that job.) Perhaps in the future
11074 avoid recentering windows if it is not necessary; currently that
11075 causes some problems. */
11078 redisplay_internal (preserve_echo_area
)
11079 int preserve_echo_area
;
11081 struct window
*w
= XWINDOW (selected_window
);
11084 int must_finish
= 0;
11085 struct text_pos tlbufpos
, tlendpos
;
11086 int number_of_visible_frames
;
11089 int polling_stopped_here
= 0;
11090 Lisp_Object old_frame
= selected_frame
;
11092 /* Non-zero means redisplay has to consider all windows on all
11093 frames. Zero means, only selected_window is considered. */
11094 int consider_all_windows_p
;
11096 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11098 /* No redisplay if running in batch mode or frame is not yet fully
11099 initialized, or redisplay is explicitly turned off by setting
11100 Vinhibit_redisplay. */
11102 || !NILP (Vinhibit_redisplay
))
11105 /* Don't examine these until after testing Vinhibit_redisplay.
11106 When Emacs is shutting down, perhaps because its connection to
11107 X has dropped, we should not look at them at all. */
11108 f
= XFRAME (w
->frame
);
11109 sf
= SELECTED_FRAME ();
11111 if (!f
->glyphs_initialized_p
)
11114 /* The flag redisplay_performed_directly_p is set by
11115 direct_output_for_insert when it already did the whole screen
11116 update necessary. */
11117 if (redisplay_performed_directly_p
)
11119 redisplay_performed_directly_p
= 0;
11120 if (!hscroll_windows (selected_window
))
11124 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
11125 if (popup_activated ())
11129 /* I don't think this happens but let's be paranoid. */
11130 if (redisplaying_p
)
11133 /* Record a function that resets redisplaying_p to its old value
11134 when we leave this function. */
11135 count
= SPECPDL_INDEX ();
11136 record_unwind_protect (unwind_redisplay
,
11137 Fcons (make_number (redisplaying_p
), selected_frame
));
11139 specbind (Qinhibit_free_realized_faces
, Qnil
);
11142 Lisp_Object tail
, frame
;
11144 FOR_EACH_FRAME (tail
, frame
)
11146 struct frame
*f
= XFRAME (frame
);
11147 f
->already_hscrolled_p
= 0;
11152 if (!EQ (old_frame
, selected_frame
)
11153 && FRAME_LIVE_P (XFRAME (old_frame
)))
11154 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11155 selected_frame and selected_window to be temporarily out-of-sync so
11156 when we come back here via `goto retry', we need to resync because we
11157 may need to run Elisp code (via prepare_menu_bars). */
11158 select_frame_for_redisplay (old_frame
);
11161 reconsider_clip_changes (w
, current_buffer
);
11162 last_escape_glyph_frame
= NULL
;
11163 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11165 /* If new fonts have been loaded that make a glyph matrix adjustment
11166 necessary, do it. */
11167 if (fonts_changed_p
)
11169 adjust_glyphs (NULL
);
11170 ++windows_or_buffers_changed
;
11171 fonts_changed_p
= 0;
11174 /* If face_change_count is non-zero, init_iterator will free all
11175 realized faces, which includes the faces referenced from current
11176 matrices. So, we can't reuse current matrices in this case. */
11177 if (face_change_count
)
11178 ++windows_or_buffers_changed
;
11180 if (FRAME_TERMCAP_P (sf
)
11181 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11183 /* Since frames on a single ASCII terminal share the same
11184 display area, displaying a different frame means redisplay
11185 the whole thing. */
11186 windows_or_buffers_changed
++;
11187 SET_FRAME_GARBAGED (sf
);
11188 FRAME_TTY (sf
)->previous_frame
= sf
;
11191 /* Set the visible flags for all frames. Do this before checking
11192 for resized or garbaged frames; they want to know if their frames
11193 are visible. See the comment in frame.h for
11194 FRAME_SAMPLE_VISIBILITY. */
11196 Lisp_Object tail
, frame
;
11198 number_of_visible_frames
= 0;
11200 FOR_EACH_FRAME (tail
, frame
)
11202 struct frame
*f
= XFRAME (frame
);
11204 FRAME_SAMPLE_VISIBILITY (f
);
11205 if (FRAME_VISIBLE_P (f
))
11206 ++number_of_visible_frames
;
11207 clear_desired_matrices (f
);
11212 /* Notice any pending interrupt request to change frame size. */
11213 do_pending_window_change (1);
11215 /* Clear frames marked as garbaged. */
11216 if (frame_garbaged
)
11217 clear_garbaged_frames ();
11219 /* Build menubar and tool-bar items. */
11220 if (NILP (Vmemory_full
))
11221 prepare_menu_bars ();
11223 if (windows_or_buffers_changed
)
11224 update_mode_lines
++;
11226 /* Detect case that we need to write or remove a star in the mode line. */
11227 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11229 w
->update_mode_line
= Qt
;
11230 if (buffer_shared
> 1)
11231 update_mode_lines
++;
11234 /* Avoid invocation of point motion hooks by `current_column' below. */
11235 count1
= SPECPDL_INDEX ();
11236 specbind (Qinhibit_point_motion_hooks
, Qt
);
11238 /* If %c is in the mode line, update it if needed. */
11239 if (!NILP (w
->column_number_displayed
)
11240 /* This alternative quickly identifies a common case
11241 where no change is needed. */
11242 && !(PT
== XFASTINT (w
->last_point
)
11243 && XFASTINT (w
->last_modified
) >= MODIFF
11244 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11245 && (XFASTINT (w
->column_number_displayed
)
11246 != (int) current_column ())) /* iftc */
11247 w
->update_mode_line
= Qt
;
11249 unbind_to (count1
, Qnil
);
11251 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11253 /* The variable buffer_shared is set in redisplay_window and
11254 indicates that we redisplay a buffer in different windows. See
11256 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11257 || cursor_type_changed
);
11259 /* If specs for an arrow have changed, do thorough redisplay
11260 to ensure we remove any arrow that should no longer exist. */
11261 if (overlay_arrows_changed_p ())
11262 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11264 /* Normally the message* functions will have already displayed and
11265 updated the echo area, but the frame may have been trashed, or
11266 the update may have been preempted, so display the echo area
11267 again here. Checking message_cleared_p captures the case that
11268 the echo area should be cleared. */
11269 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11270 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11271 || (message_cleared_p
11272 && minibuf_level
== 0
11273 /* If the mini-window is currently selected, this means the
11274 echo-area doesn't show through. */
11275 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11277 int window_height_changed_p
= echo_area_display (0);
11280 /* If we don't display the current message, don't clear the
11281 message_cleared_p flag, because, if we did, we wouldn't clear
11282 the echo area in the next redisplay which doesn't preserve
11284 if (!display_last_displayed_message_p
)
11285 message_cleared_p
= 0;
11287 if (fonts_changed_p
)
11289 else if (window_height_changed_p
)
11291 consider_all_windows_p
= 1;
11292 ++update_mode_lines
;
11293 ++windows_or_buffers_changed
;
11295 /* If window configuration was changed, frames may have been
11296 marked garbaged. Clear them or we will experience
11297 surprises wrt scrolling. */
11298 if (frame_garbaged
)
11299 clear_garbaged_frames ();
11302 else if (EQ (selected_window
, minibuf_window
)
11303 && (current_buffer
->clip_changed
11304 || XFASTINT (w
->last_modified
) < MODIFF
11305 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11306 && resize_mini_window (w
, 0))
11308 /* Resized active mini-window to fit the size of what it is
11309 showing if its contents might have changed. */
11311 consider_all_windows_p
= 1;
11312 ++windows_or_buffers_changed
;
11313 ++update_mode_lines
;
11315 /* If window configuration was changed, frames may have been
11316 marked garbaged. Clear them or we will experience
11317 surprises wrt scrolling. */
11318 if (frame_garbaged
)
11319 clear_garbaged_frames ();
11323 /* If showing the region, and mark has changed, we must redisplay
11324 the whole window. The assignment to this_line_start_pos prevents
11325 the optimization directly below this if-statement. */
11326 if (((!NILP (Vtransient_mark_mode
)
11327 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11328 != !NILP (w
->region_showing
))
11329 || (!NILP (w
->region_showing
)
11330 && !EQ (w
->region_showing
,
11331 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11332 CHARPOS (this_line_start_pos
) = 0;
11334 /* Optimize the case that only the line containing the cursor in the
11335 selected window has changed. Variables starting with this_ are
11336 set in display_line and record information about the line
11337 containing the cursor. */
11338 tlbufpos
= this_line_start_pos
;
11339 tlendpos
= this_line_end_pos
;
11340 if (!consider_all_windows_p
11341 && CHARPOS (tlbufpos
) > 0
11342 && NILP (w
->update_mode_line
)
11343 && !current_buffer
->clip_changed
11344 && !current_buffer
->prevent_redisplay_optimizations_p
11345 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11346 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11347 /* Make sure recorded data applies to current buffer, etc. */
11348 && this_line_buffer
== current_buffer
11349 && current_buffer
== XBUFFER (w
->buffer
)
11350 && NILP (w
->force_start
)
11351 && NILP (w
->optional_new_start
)
11352 /* Point must be on the line that we have info recorded about. */
11353 && PT
>= CHARPOS (tlbufpos
)
11354 && PT
<= Z
- CHARPOS (tlendpos
)
11355 /* All text outside that line, including its final newline,
11356 must be unchanged */
11357 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11358 CHARPOS (tlendpos
)))
11360 if (CHARPOS (tlbufpos
) > BEGV
11361 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11362 && (CHARPOS (tlbufpos
) == ZV
11363 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11364 /* Former continuation line has disappeared by becoming empty */
11366 else if (XFASTINT (w
->last_modified
) < MODIFF
11367 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11368 || MINI_WINDOW_P (w
))
11370 /* We have to handle the case of continuation around a
11371 wide-column character (See the comment in indent.c around
11374 For instance, in the following case:
11376 -------- Insert --------
11377 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11378 J_I_ ==> J_I_ `^^' are cursors.
11382 As we have to redraw the line above, we should goto cancel. */
11385 int line_height_before
= this_line_pixel_height
;
11387 /* Note that start_display will handle the case that the
11388 line starting at tlbufpos is a continuation lines. */
11389 start_display (&it
, w
, tlbufpos
);
11391 /* Implementation note: It this still necessary? */
11392 if (it
.current_x
!= this_line_start_x
)
11395 TRACE ((stderr
, "trying display optimization 1\n"));
11396 w
->cursor
.vpos
= -1;
11397 overlay_arrow_seen
= 0;
11398 it
.vpos
= this_line_vpos
;
11399 it
.current_y
= this_line_y
;
11400 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11401 display_line (&it
);
11403 /* If line contains point, is not continued,
11404 and ends at same distance from eob as before, we win */
11405 if (w
->cursor
.vpos
>= 0
11406 /* Line is not continued, otherwise this_line_start_pos
11407 would have been set to 0 in display_line. */
11408 && CHARPOS (this_line_start_pos
)
11409 /* Line ends as before. */
11410 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11411 /* Line has same height as before. Otherwise other lines
11412 would have to be shifted up or down. */
11413 && this_line_pixel_height
== line_height_before
)
11415 /* If this is not the window's last line, we must adjust
11416 the charstarts of the lines below. */
11417 if (it
.current_y
< it
.last_visible_y
)
11419 struct glyph_row
*row
11420 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11421 int delta
, delta_bytes
;
11423 if (Z
- CHARPOS (tlendpos
) == ZV
)
11425 /* This line ends at end of (accessible part of)
11426 buffer. There is no newline to count. */
11428 - CHARPOS (tlendpos
)
11429 - MATRIX_ROW_START_CHARPOS (row
));
11430 delta_bytes
= (Z_BYTE
11431 - BYTEPOS (tlendpos
)
11432 - MATRIX_ROW_START_BYTEPOS (row
));
11436 /* This line ends in a newline. Must take
11437 account of the newline and the rest of the
11438 text that follows. */
11440 - CHARPOS (tlendpos
)
11441 - MATRIX_ROW_START_CHARPOS (row
));
11442 delta_bytes
= (Z_BYTE
11443 - BYTEPOS (tlendpos
)
11444 - MATRIX_ROW_START_BYTEPOS (row
));
11447 increment_matrix_positions (w
->current_matrix
,
11448 this_line_vpos
+ 1,
11449 w
->current_matrix
->nrows
,
11450 delta
, delta_bytes
);
11453 /* If this row displays text now but previously didn't,
11454 or vice versa, w->window_end_vpos may have to be
11456 if ((it
.glyph_row
- 1)->displays_text_p
)
11458 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11459 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11461 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11462 && this_line_vpos
> 0)
11463 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11464 w
->window_end_valid
= Qnil
;
11466 /* Update hint: No need to try to scroll in update_window. */
11467 w
->desired_matrix
->no_scrolling_p
= 1;
11470 *w
->desired_matrix
->method
= 0;
11471 debug_method_add (w
, "optimization 1");
11473 #ifdef HAVE_WINDOW_SYSTEM
11474 update_window_fringes (w
, 0);
11481 else if (/* Cursor position hasn't changed. */
11482 PT
== XFASTINT (w
->last_point
)
11483 /* Make sure the cursor was last displayed
11484 in this window. Otherwise we have to reposition it. */
11485 && 0 <= w
->cursor
.vpos
11486 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11490 do_pending_window_change (1);
11492 /* We used to always goto end_of_redisplay here, but this
11493 isn't enough if we have a blinking cursor. */
11494 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11495 goto end_of_redisplay
;
11499 /* If highlighting the region, or if the cursor is in the echo area,
11500 then we can't just move the cursor. */
11501 else if (! (!NILP (Vtransient_mark_mode
)
11502 && !NILP (current_buffer
->mark_active
))
11503 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11504 || highlight_nonselected_windows
)
11505 && NILP (w
->region_showing
)
11506 && NILP (Vshow_trailing_whitespace
)
11507 && !cursor_in_echo_area
)
11510 struct glyph_row
*row
;
11512 /* Skip from tlbufpos to PT and see where it is. Note that
11513 PT may be in invisible text. If so, we will end at the
11514 next visible position. */
11515 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11516 NULL
, DEFAULT_FACE_ID
);
11517 it
.current_x
= this_line_start_x
;
11518 it
.current_y
= this_line_y
;
11519 it
.vpos
= this_line_vpos
;
11521 /* The call to move_it_to stops in front of PT, but
11522 moves over before-strings. */
11523 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11525 if (it
.vpos
== this_line_vpos
11526 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11529 xassert (this_line_vpos
== it
.vpos
);
11530 xassert (this_line_y
== it
.current_y
);
11531 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11533 *w
->desired_matrix
->method
= 0;
11534 debug_method_add (w
, "optimization 3");
11543 /* Text changed drastically or point moved off of line. */
11544 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11547 CHARPOS (this_line_start_pos
) = 0;
11548 consider_all_windows_p
|= buffer_shared
> 1;
11549 ++clear_face_cache_count
;
11550 #ifdef HAVE_WINDOW_SYSTEM
11551 ++clear_image_cache_count
;
11554 /* Build desired matrices, and update the display. If
11555 consider_all_windows_p is non-zero, do it for all windows on all
11556 frames. Otherwise do it for selected_window, only. */
11558 if (consider_all_windows_p
)
11560 Lisp_Object tail
, frame
;
11562 FOR_EACH_FRAME (tail
, frame
)
11563 XFRAME (frame
)->updated_p
= 0;
11565 /* Recompute # windows showing selected buffer. This will be
11566 incremented each time such a window is displayed. */
11569 FOR_EACH_FRAME (tail
, frame
)
11571 struct frame
*f
= XFRAME (frame
);
11573 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11575 if (! EQ (frame
, selected_frame
))
11576 /* Select the frame, for the sake of frame-local
11578 select_frame_for_redisplay (frame
);
11580 /* Mark all the scroll bars to be removed; we'll redeem
11581 the ones we want when we redisplay their windows. */
11582 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11583 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11585 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11586 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11588 /* Any scroll bars which redisplay_windows should have
11589 nuked should now go away. */
11590 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11591 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11593 /* If fonts changed, display again. */
11594 /* ??? rms: I suspect it is a mistake to jump all the way
11595 back to retry here. It should just retry this frame. */
11596 if (fonts_changed_p
)
11599 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11601 /* See if we have to hscroll. */
11602 if (!f
->already_hscrolled_p
)
11604 f
->already_hscrolled_p
= 1;
11605 if (hscroll_windows (f
->root_window
))
11609 /* Prevent various kinds of signals during display
11610 update. stdio is not robust about handling
11611 signals, which can cause an apparent I/O
11613 if (interrupt_input
)
11614 unrequest_sigio ();
11617 /* Update the display. */
11618 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11619 pause
|= update_frame (f
, 0, 0);
11620 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
11632 /* Do the mark_window_display_accurate after all windows have
11633 been redisplayed because this call resets flags in buffers
11634 which are needed for proper redisplay. */
11635 FOR_EACH_FRAME (tail
, frame
)
11637 struct frame
*f
= XFRAME (frame
);
11640 mark_window_display_accurate (f
->root_window
, 1);
11641 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11642 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11647 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11649 Lisp_Object mini_window
;
11650 struct frame
*mini_frame
;
11652 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11653 /* Use list_of_error, not Qerror, so that
11654 we catch only errors and don't run the debugger. */
11655 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11657 redisplay_window_error
);
11659 /* Compare desired and current matrices, perform output. */
11662 /* If fonts changed, display again. */
11663 if (fonts_changed_p
)
11666 /* Prevent various kinds of signals during display update.
11667 stdio is not robust about handling signals,
11668 which can cause an apparent I/O error. */
11669 if (interrupt_input
)
11670 unrequest_sigio ();
11673 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11675 if (hscroll_windows (selected_window
))
11678 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11679 pause
= update_frame (sf
, 0, 0);
11682 /* We may have called echo_area_display at the top of this
11683 function. If the echo area is on another frame, that may
11684 have put text on a frame other than the selected one, so the
11685 above call to update_frame would not have caught it. Catch
11687 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11688 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11690 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11692 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11693 pause
|= update_frame (mini_frame
, 0, 0);
11694 if (!pause
&& hscroll_windows (mini_window
))
11699 /* If display was paused because of pending input, make sure we do a
11700 thorough update the next time. */
11703 /* Prevent the optimization at the beginning of
11704 redisplay_internal that tries a single-line update of the
11705 line containing the cursor in the selected window. */
11706 CHARPOS (this_line_start_pos
) = 0;
11708 /* Let the overlay arrow be updated the next time. */
11709 update_overlay_arrows (0);
11711 /* If we pause after scrolling, some rows in the current
11712 matrices of some windows are not valid. */
11713 if (!WINDOW_FULL_WIDTH_P (w
)
11714 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11715 update_mode_lines
= 1;
11719 if (!consider_all_windows_p
)
11721 /* This has already been done above if
11722 consider_all_windows_p is set. */
11723 mark_window_display_accurate_1 (w
, 1);
11725 /* Say overlay arrows are up to date. */
11726 update_overlay_arrows (1);
11728 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11729 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11732 update_mode_lines
= 0;
11733 windows_or_buffers_changed
= 0;
11734 cursor_type_changed
= 0;
11737 /* Start SIGIO interrupts coming again. Having them off during the
11738 code above makes it less likely one will discard output, but not
11739 impossible, since there might be stuff in the system buffer here.
11740 But it is much hairier to try to do anything about that. */
11741 if (interrupt_input
)
11745 /* If a frame has become visible which was not before, redisplay
11746 again, so that we display it. Expose events for such a frame
11747 (which it gets when becoming visible) don't call the parts of
11748 redisplay constructing glyphs, so simply exposing a frame won't
11749 display anything in this case. So, we have to display these
11750 frames here explicitly. */
11753 Lisp_Object tail
, frame
;
11756 FOR_EACH_FRAME (tail
, frame
)
11758 int this_is_visible
= 0;
11760 if (XFRAME (frame
)->visible
)
11761 this_is_visible
= 1;
11762 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11763 if (XFRAME (frame
)->visible
)
11764 this_is_visible
= 1;
11766 if (this_is_visible
)
11770 if (new_count
!= number_of_visible_frames
)
11771 windows_or_buffers_changed
++;
11774 /* Change frame size now if a change is pending. */
11775 do_pending_window_change (1);
11777 /* If we just did a pending size change, or have additional
11778 visible frames, redisplay again. */
11779 if (windows_or_buffers_changed
&& !pause
)
11782 /* Clear the face cache eventually. */
11783 if (consider_all_windows_p
)
11785 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11787 clear_face_cache (0);
11788 clear_face_cache_count
= 0;
11790 #ifdef HAVE_WINDOW_SYSTEM
11791 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
11793 clear_image_caches (Qnil
);
11794 clear_image_cache_count
= 0;
11796 #endif /* HAVE_WINDOW_SYSTEM */
11800 unbind_to (count
, Qnil
);
11805 /* Redisplay, but leave alone any recent echo area message unless
11806 another message has been requested in its place.
11808 This is useful in situations where you need to redisplay but no
11809 user action has occurred, making it inappropriate for the message
11810 area to be cleared. See tracking_off and
11811 wait_reading_process_output for examples of these situations.
11813 FROM_WHERE is an integer saying from where this function was
11814 called. This is useful for debugging. */
11817 redisplay_preserve_echo_area (from_where
)
11820 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
11822 if (!NILP (echo_area_buffer
[1]))
11824 /* We have a previously displayed message, but no current
11825 message. Redisplay the previous message. */
11826 display_last_displayed_message_p
= 1;
11827 redisplay_internal (1);
11828 display_last_displayed_message_p
= 0;
11831 redisplay_internal (1);
11833 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
11834 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11835 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
11839 /* Function registered with record_unwind_protect in
11840 redisplay_internal. Reset redisplaying_p to the value it had
11841 before redisplay_internal was called, and clear
11842 prevent_freeing_realized_faces_p. It also selects the previously
11843 selected frame, unless it has been deleted (by an X connection
11844 failure during redisplay, for example). */
11847 unwind_redisplay (val
)
11850 Lisp_Object old_redisplaying_p
, old_frame
;
11852 old_redisplaying_p
= XCAR (val
);
11853 redisplaying_p
= XFASTINT (old_redisplaying_p
);
11854 old_frame
= XCDR (val
);
11855 if (! EQ (old_frame
, selected_frame
)
11856 && FRAME_LIVE_P (XFRAME (old_frame
)))
11857 select_frame_for_redisplay (old_frame
);
11862 /* Mark the display of window W as accurate or inaccurate. If
11863 ACCURATE_P is non-zero mark display of W as accurate. If
11864 ACCURATE_P is zero, arrange for W to be redisplayed the next time
11865 redisplay_internal is called. */
11868 mark_window_display_accurate_1 (w
, accurate_p
)
11872 if (BUFFERP (w
->buffer
))
11874 struct buffer
*b
= XBUFFER (w
->buffer
);
11877 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
11878 w
->last_overlay_modified
11879 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
11881 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
11885 b
->clip_changed
= 0;
11886 b
->prevent_redisplay_optimizations_p
= 0;
11888 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
11889 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
11890 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
11891 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
11893 w
->current_matrix
->buffer
= b
;
11894 w
->current_matrix
->begv
= BUF_BEGV (b
);
11895 w
->current_matrix
->zv
= BUF_ZV (b
);
11897 w
->last_cursor
= w
->cursor
;
11898 w
->last_cursor_off_p
= w
->cursor_off_p
;
11900 if (w
== XWINDOW (selected_window
))
11901 w
->last_point
= make_number (BUF_PT (b
));
11903 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
11909 w
->window_end_valid
= w
->buffer
;
11910 #if 0 /* This is incorrect with variable-height lines. */
11911 xassert (XINT (w
->window_end_vpos
)
11912 < (WINDOW_TOTAL_LINES (w
)
11913 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
11915 w
->update_mode_line
= Qnil
;
11920 /* Mark the display of windows in the window tree rooted at WINDOW as
11921 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
11922 windows as accurate. If ACCURATE_P is zero, arrange for windows to
11923 be redisplayed the next time redisplay_internal is called. */
11926 mark_window_display_accurate (window
, accurate_p
)
11927 Lisp_Object window
;
11932 for (; !NILP (window
); window
= w
->next
)
11934 w
= XWINDOW (window
);
11935 mark_window_display_accurate_1 (w
, accurate_p
);
11937 if (!NILP (w
->vchild
))
11938 mark_window_display_accurate (w
->vchild
, accurate_p
);
11939 if (!NILP (w
->hchild
))
11940 mark_window_display_accurate (w
->hchild
, accurate_p
);
11945 update_overlay_arrows (1);
11949 /* Force a thorough redisplay the next time by setting
11950 last_arrow_position and last_arrow_string to t, which is
11951 unequal to any useful value of Voverlay_arrow_... */
11952 update_overlay_arrows (-1);
11957 /* Return value in display table DP (Lisp_Char_Table *) for character
11958 C. Since a display table doesn't have any parent, we don't have to
11959 follow parent. Do not call this function directly but use the
11960 macro DISP_CHAR_VECTOR. */
11963 disp_char_vector (dp
, c
)
11964 struct Lisp_Char_Table
*dp
;
11969 if (ASCII_CHAR_P (c
))
11972 if (SUB_CHAR_TABLE_P (val
))
11973 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
11979 XSETCHAR_TABLE (table
, dp
);
11980 val
= char_table_ref (table
, c
);
11989 /***********************************************************************
11991 ***********************************************************************/
11993 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
11996 redisplay_windows (window
)
11997 Lisp_Object window
;
11999 while (!NILP (window
))
12001 struct window
*w
= XWINDOW (window
);
12003 if (!NILP (w
->hchild
))
12004 redisplay_windows (w
->hchild
);
12005 else if (!NILP (w
->vchild
))
12006 redisplay_windows (w
->vchild
);
12009 displayed_buffer
= XBUFFER (w
->buffer
);
12010 /* Use list_of_error, not Qerror, so that
12011 we catch only errors and don't run the debugger. */
12012 internal_condition_case_1 (redisplay_window_0
, window
,
12014 redisplay_window_error
);
12022 redisplay_window_error ()
12024 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12029 redisplay_window_0 (window
)
12030 Lisp_Object window
;
12032 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12033 redisplay_window (window
, 0);
12038 redisplay_window_1 (window
)
12039 Lisp_Object window
;
12041 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12042 redisplay_window (window
, 1);
12047 /* Increment GLYPH until it reaches END or CONDITION fails while
12048 adding (GLYPH)->pixel_width to X. */
12050 #define SKIP_GLYPHS(glyph, end, x, condition) \
12053 (x) += (glyph)->pixel_width; \
12056 while ((glyph) < (end) && (condition))
12059 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12060 DELTA is the number of bytes by which positions recorded in ROW
12061 differ from current buffer positions.
12063 Return 0 if cursor is not on this row. 1 otherwise. */
12066 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12068 struct glyph_row
*row
;
12069 struct glyph_matrix
*matrix
;
12070 int delta
, delta_bytes
, dy
, dvpos
;
12072 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12073 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12074 struct glyph
*cursor
= NULL
;
12075 /* The first glyph that starts a sequence of glyphs from string. */
12076 struct glyph
*string_start
;
12077 /* The X coordinate of string_start. */
12078 int string_start_x
;
12079 /* The last known character position. */
12080 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12081 /* The last known character position before string_start. */
12082 int string_before_pos
;
12085 int cursor_from_overlay_pos
= 0;
12086 int pt_old
= PT
- delta
;
12088 /* Skip over glyphs not having an object at the start of the row.
12089 These are special glyphs like truncation marks on terminal
12091 if (row
->displays_text_p
)
12093 && INTEGERP (glyph
->object
)
12094 && glyph
->charpos
< 0)
12096 x
+= glyph
->pixel_width
;
12100 string_start
= NULL
;
12102 && !INTEGERP (glyph
->object
)
12103 && (!BUFFERP (glyph
->object
)
12104 || (last_pos
= glyph
->charpos
) < pt_old
))
12106 if (! STRINGP (glyph
->object
))
12108 string_start
= NULL
;
12109 x
+= glyph
->pixel_width
;
12111 if (cursor_from_overlay_pos
12112 && last_pos
>= cursor_from_overlay_pos
)
12114 cursor_from_overlay_pos
= 0;
12120 if (string_start
== NULL
)
12122 string_before_pos
= last_pos
;
12123 string_start
= glyph
;
12124 string_start_x
= x
;
12126 /* Skip all glyphs from string. */
12131 if ((cursor
== NULL
|| glyph
> cursor
)
12132 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12133 Qcursor
, (glyph
)->object
),
12135 && (pos
= string_buffer_position (w
, glyph
->object
,
12136 string_before_pos
),
12137 (pos
== 0 /* From overlay */
12138 || pos
== pt_old
)))
12140 /* Estimate overlay buffer position from the buffer
12141 positions of the glyphs before and after the overlay.
12142 Add 1 to last_pos so that if point corresponds to the
12143 glyph right after the overlay, we still use a 'cursor'
12144 property found in that overlay. */
12145 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12146 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12150 x
+= glyph
->pixel_width
;
12153 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12157 if (cursor
!= NULL
)
12162 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12164 /* Scan back over the ellipsis glyphs, decrementing positions. */
12165 while (glyph
> row
->glyphs
[TEXT_AREA
]
12166 && (glyph
- 1)->charpos
== last_pos
)
12167 glyph
--, x
-= glyph
->pixel_width
;
12168 /* That loop always goes one position too far,
12169 including the glyph before the ellipsis.
12170 So scan forward over that one. */
12171 x
+= glyph
->pixel_width
;
12174 else if (string_start
12175 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12177 /* We may have skipped over point because the previous glyphs
12178 are from string. As there's no easy way to know the
12179 character position of the current glyph, find the correct
12180 glyph on point by scanning from string_start again. */
12182 Lisp_Object string
;
12183 struct glyph
*stop
= glyph
;
12186 limit
= make_number (pt_old
+ 1);
12187 glyph
= string_start
;
12188 x
= string_start_x
;
12189 string
= glyph
->object
;
12190 pos
= string_buffer_position (w
, string
, string_before_pos
);
12191 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12192 because we always put cursor after overlay strings. */
12193 while (pos
== 0 && glyph
< stop
)
12195 string
= glyph
->object
;
12196 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12198 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12201 while (glyph
< stop
)
12203 pos
= XINT (Fnext_single_char_property_change
12204 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12207 /* Skip glyphs from the same string. */
12208 string
= glyph
->object
;
12209 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12210 /* Skip glyphs from an overlay. */
12211 while (glyph
< stop
12212 && ! string_buffer_position (w
, glyph
->object
, pos
))
12214 string
= glyph
->object
;
12215 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12219 /* If we reached the end of the line, and end was from a string,
12220 cursor is not on this line. */
12221 if (glyph
== end
&& row
->continued_p
)
12225 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12227 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12228 w
->cursor
.y
= row
->y
+ dy
;
12230 if (w
== XWINDOW (selected_window
))
12232 if (!row
->continued_p
12233 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12236 this_line_buffer
= XBUFFER (w
->buffer
);
12238 CHARPOS (this_line_start_pos
)
12239 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12240 BYTEPOS (this_line_start_pos
)
12241 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12243 CHARPOS (this_line_end_pos
)
12244 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12245 BYTEPOS (this_line_end_pos
)
12246 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12248 this_line_y
= w
->cursor
.y
;
12249 this_line_pixel_height
= row
->height
;
12250 this_line_vpos
= w
->cursor
.vpos
;
12251 this_line_start_x
= row
->x
;
12254 CHARPOS (this_line_start_pos
) = 0;
12261 /* Run window scroll functions, if any, for WINDOW with new window
12262 start STARTP. Sets the window start of WINDOW to that position.
12264 We assume that the window's buffer is really current. */
12266 static INLINE
struct text_pos
12267 run_window_scroll_functions (window
, startp
)
12268 Lisp_Object window
;
12269 struct text_pos startp
;
12271 struct window
*w
= XWINDOW (window
);
12272 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12274 if (current_buffer
!= XBUFFER (w
->buffer
))
12277 if (!NILP (Vwindow_scroll_functions
))
12279 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12280 make_number (CHARPOS (startp
)));
12281 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12282 /* In case the hook functions switch buffers. */
12283 if (current_buffer
!= XBUFFER (w
->buffer
))
12284 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12291 /* Make sure the line containing the cursor is fully visible.
12292 A value of 1 means there is nothing to be done.
12293 (Either the line is fully visible, or it cannot be made so,
12294 or we cannot tell.)
12296 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12297 is higher than window.
12299 A value of 0 means the caller should do scrolling
12300 as if point had gone off the screen. */
12303 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12306 int current_matrix_p
;
12308 struct glyph_matrix
*matrix
;
12309 struct glyph_row
*row
;
12312 if (!make_cursor_line_fully_visible_p
)
12315 /* It's not always possible to find the cursor, e.g, when a window
12316 is full of overlay strings. Don't do anything in that case. */
12317 if (w
->cursor
.vpos
< 0)
12320 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12321 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12323 /* If the cursor row is not partially visible, there's nothing to do. */
12324 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12327 /* If the row the cursor is in is taller than the window's height,
12328 it's not clear what to do, so do nothing. */
12329 window_height
= window_box_height (w
);
12330 if (row
->height
>= window_height
)
12332 if (!force_p
|| MINI_WINDOW_P (w
)
12333 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12339 /* This code used to try to scroll the window just enough to make
12340 the line visible. It returned 0 to say that the caller should
12341 allocate larger glyph matrices. */
12343 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12345 int dy
= row
->height
- row
->visible_height
;
12348 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12350 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12352 int dy
= - (row
->height
- row
->visible_height
);
12355 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12358 /* When we change the cursor y-position of the selected window,
12359 change this_line_y as well so that the display optimization for
12360 the cursor line of the selected window in redisplay_internal uses
12361 the correct y-position. */
12362 if (w
== XWINDOW (selected_window
))
12363 this_line_y
= w
->cursor
.y
;
12365 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12366 redisplay with larger matrices. */
12367 if (matrix
->nrows
< required_matrix_height (w
))
12369 fonts_changed_p
= 1;
12378 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12379 non-zero means only WINDOW is redisplayed in redisplay_internal.
12380 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12381 in redisplay_window to bring a partially visible line into view in
12382 the case that only the cursor has moved.
12384 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12385 last screen line's vertical height extends past the end of the screen.
12389 1 if scrolling succeeded
12391 0 if scrolling didn't find point.
12393 -1 if new fonts have been loaded so that we must interrupt
12394 redisplay, adjust glyph matrices, and try again. */
12400 SCROLLING_NEED_LARGER_MATRICES
12404 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12405 scroll_step
, temp_scroll_step
, last_line_misfit
)
12406 Lisp_Object window
;
12407 int just_this_one_p
;
12408 EMACS_INT scroll_conservatively
, scroll_step
;
12409 int temp_scroll_step
;
12410 int last_line_misfit
;
12412 struct window
*w
= XWINDOW (window
);
12413 struct frame
*f
= XFRAME (w
->frame
);
12414 struct text_pos scroll_margin_pos
;
12415 struct text_pos pos
;
12416 struct text_pos startp
;
12418 Lisp_Object window_end
;
12419 int this_scroll_margin
;
12423 int amount_to_scroll
= 0;
12424 Lisp_Object aggressive
;
12426 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12429 debug_method_add (w
, "try_scrolling");
12432 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12434 /* Compute scroll margin height in pixels. We scroll when point is
12435 within this distance from the top or bottom of the window. */
12436 if (scroll_margin
> 0)
12438 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12439 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12442 this_scroll_margin
= 0;
12444 /* Force scroll_conservatively to have a reasonable value so it doesn't
12445 cause an overflow while computing how much to scroll. */
12446 if (scroll_conservatively
)
12447 scroll_conservatively
= min (scroll_conservatively
,
12448 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
12450 /* Compute how much we should try to scroll maximally to bring point
12452 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12453 scroll_max
= max (scroll_step
,
12454 max (scroll_conservatively
, temp_scroll_step
));
12455 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12456 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12457 /* We're trying to scroll because of aggressive scrolling
12458 but no scroll_step is set. Choose an arbitrary one. Maybe
12459 there should be a variable for this. */
12463 scroll_max
*= FRAME_LINE_HEIGHT (f
);
12465 /* Decide whether we have to scroll down. Start at the window end
12466 and move this_scroll_margin up to find the position of the scroll
12468 window_end
= Fwindow_end (window
, Qt
);
12472 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
12473 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
12475 if (this_scroll_margin
|| extra_scroll_margin_lines
)
12477 start_display (&it
, w
, scroll_margin_pos
);
12478 if (this_scroll_margin
)
12479 move_it_vertically_backward (&it
, this_scroll_margin
);
12480 if (extra_scroll_margin_lines
)
12481 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
12482 scroll_margin_pos
= it
.current
.pos
;
12485 if (PT
>= CHARPOS (scroll_margin_pos
))
12489 /* Point is in the scroll margin at the bottom of the window, or
12490 below. Compute a new window start that makes point visible. */
12492 /* Compute the distance from the scroll margin to PT.
12493 Give up if the distance is greater than scroll_max. */
12494 start_display (&it
, w
, scroll_margin_pos
);
12496 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12497 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12499 /* To make point visible, we have to move the window start
12500 down so that the line the cursor is in is visible, which
12501 means we have to add in the height of the cursor line. */
12502 dy
= line_bottom_y (&it
) - y0
;
12504 if (dy
> scroll_max
)
12505 return SCROLLING_FAILED
;
12507 /* Move the window start down. If scrolling conservatively,
12508 move it just enough down to make point visible. If
12509 scroll_step is set, move it down by scroll_step. */
12510 start_display (&it
, w
, startp
);
12512 if (scroll_conservatively
)
12513 /* Set AMOUNT_TO_SCROLL to at least one line,
12514 and at most scroll_conservatively lines. */
12516 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12517 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12518 else if (scroll_step
|| temp_scroll_step
)
12519 amount_to_scroll
= scroll_max
;
12522 aggressive
= current_buffer
->scroll_up_aggressively
;
12523 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12524 if (NUMBERP (aggressive
))
12526 double float_amount
= XFLOATINT (aggressive
) * height
;
12527 amount_to_scroll
= float_amount
;
12528 if (amount_to_scroll
== 0 && float_amount
> 0)
12529 amount_to_scroll
= 1;
12533 if (amount_to_scroll
<= 0)
12534 return SCROLLING_FAILED
;
12536 /* If moving by amount_to_scroll leaves STARTP unchanged,
12537 move it down one screen line. */
12539 move_it_vertically (&it
, amount_to_scroll
);
12540 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12541 move_it_by_lines (&it
, 1, 1);
12542 startp
= it
.current
.pos
;
12546 /* See if point is inside the scroll margin at the top of the
12548 scroll_margin_pos
= startp
;
12549 if (this_scroll_margin
)
12551 start_display (&it
, w
, startp
);
12552 move_it_vertically (&it
, this_scroll_margin
);
12553 scroll_margin_pos
= it
.current
.pos
;
12556 if (PT
< CHARPOS (scroll_margin_pos
))
12558 /* Point is in the scroll margin at the top of the window or
12559 above what is displayed in the window. */
12562 /* Compute the vertical distance from PT to the scroll
12563 margin position. Give up if distance is greater than
12565 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12566 start_display (&it
, w
, pos
);
12568 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12569 it
.last_visible_y
, -1,
12570 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12571 dy
= it
.current_y
- y0
;
12572 if (dy
> scroll_max
)
12573 return SCROLLING_FAILED
;
12575 /* Compute new window start. */
12576 start_display (&it
, w
, startp
);
12578 if (scroll_conservatively
)
12580 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12581 else if (scroll_step
|| temp_scroll_step
)
12582 amount_to_scroll
= scroll_max
;
12585 aggressive
= current_buffer
->scroll_down_aggressively
;
12586 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12587 if (NUMBERP (aggressive
))
12589 double float_amount
= XFLOATINT (aggressive
) * height
;
12590 amount_to_scroll
= float_amount
;
12591 if (amount_to_scroll
== 0 && float_amount
> 0)
12592 amount_to_scroll
= 1;
12596 if (amount_to_scroll
<= 0)
12597 return SCROLLING_FAILED
;
12599 move_it_vertically_backward (&it
, amount_to_scroll
);
12600 startp
= it
.current
.pos
;
12604 /* Run window scroll functions. */
12605 startp
= run_window_scroll_functions (window
, startp
);
12607 /* Display the window. Give up if new fonts are loaded, or if point
12609 if (!try_window (window
, startp
, 0))
12610 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12611 else if (w
->cursor
.vpos
< 0)
12613 clear_glyph_matrix (w
->desired_matrix
);
12614 rc
= SCROLLING_FAILED
;
12618 /* Maybe forget recorded base line for line number display. */
12619 if (!just_this_one_p
12620 || current_buffer
->clip_changed
12621 || BEG_UNCHANGED
< CHARPOS (startp
))
12622 w
->base_line_number
= Qnil
;
12624 /* If cursor ends up on a partially visible line,
12625 treat that as being off the bottom of the screen. */
12626 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12628 clear_glyph_matrix (w
->desired_matrix
);
12629 ++extra_scroll_margin_lines
;
12632 rc
= SCROLLING_SUCCESS
;
12639 /* Compute a suitable window start for window W if display of W starts
12640 on a continuation line. Value is non-zero if a new window start
12643 The new window start will be computed, based on W's width, starting
12644 from the start of the continued line. It is the start of the
12645 screen line with the minimum distance from the old start W->start. */
12648 compute_window_start_on_continuation_line (w
)
12651 struct text_pos pos
, start_pos
;
12652 int window_start_changed_p
= 0;
12654 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12656 /* If window start is on a continuation line... Window start may be
12657 < BEGV in case there's invisible text at the start of the
12658 buffer (M-x rmail, for example). */
12659 if (CHARPOS (start_pos
) > BEGV
12660 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12663 struct glyph_row
*row
;
12665 /* Handle the case that the window start is out of range. */
12666 if (CHARPOS (start_pos
) < BEGV
)
12667 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12668 else if (CHARPOS (start_pos
) > ZV
)
12669 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12671 /* Find the start of the continued line. This should be fast
12672 because scan_buffer is fast (newline cache). */
12673 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12674 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12675 row
, DEFAULT_FACE_ID
);
12676 reseat_at_previous_visible_line_start (&it
);
12678 /* If the line start is "too far" away from the window start,
12679 say it takes too much time to compute a new window start. */
12680 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12681 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12683 int min_distance
, distance
;
12685 /* Move forward by display lines to find the new window
12686 start. If window width was enlarged, the new start can
12687 be expected to be > the old start. If window width was
12688 decreased, the new window start will be < the old start.
12689 So, we're looking for the display line start with the
12690 minimum distance from the old window start. */
12691 pos
= it
.current
.pos
;
12692 min_distance
= INFINITY
;
12693 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12694 distance
< min_distance
)
12696 min_distance
= distance
;
12697 pos
= it
.current
.pos
;
12698 move_it_by_lines (&it
, 1, 0);
12701 /* Set the window start there. */
12702 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12703 window_start_changed_p
= 1;
12707 return window_start_changed_p
;
12711 /* Try cursor movement in case text has not changed in window WINDOW,
12712 with window start STARTP. Value is
12714 CURSOR_MOVEMENT_SUCCESS if successful
12716 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12718 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12719 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12720 we want to scroll as if scroll-step were set to 1. See the code.
12722 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12723 which case we have to abort this redisplay, and adjust matrices
12728 CURSOR_MOVEMENT_SUCCESS
,
12729 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12730 CURSOR_MOVEMENT_MUST_SCROLL
,
12731 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12735 try_cursor_movement (window
, startp
, scroll_step
)
12736 Lisp_Object window
;
12737 struct text_pos startp
;
12740 struct window
*w
= XWINDOW (window
);
12741 struct frame
*f
= XFRAME (w
->frame
);
12742 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12745 if (inhibit_try_cursor_movement
)
12749 /* Handle case where text has not changed, only point, and it has
12750 not moved off the frame. */
12751 if (/* Point may be in this window. */
12752 PT
>= CHARPOS (startp
)
12753 /* Selective display hasn't changed. */
12754 && !current_buffer
->clip_changed
12755 /* Function force-mode-line-update is used to force a thorough
12756 redisplay. It sets either windows_or_buffers_changed or
12757 update_mode_lines. So don't take a shortcut here for these
12759 && !update_mode_lines
12760 && !windows_or_buffers_changed
12761 && !cursor_type_changed
12762 /* Can't use this case if highlighting a region. When a
12763 region exists, cursor movement has to do more than just
12765 && !(!NILP (Vtransient_mark_mode
)
12766 && !NILP (current_buffer
->mark_active
))
12767 && NILP (w
->region_showing
)
12768 && NILP (Vshow_trailing_whitespace
)
12769 /* Right after splitting windows, last_point may be nil. */
12770 && INTEGERP (w
->last_point
)
12771 /* This code is not used for mini-buffer for the sake of the case
12772 of redisplaying to replace an echo area message; since in
12773 that case the mini-buffer contents per se are usually
12774 unchanged. This code is of no real use in the mini-buffer
12775 since the handling of this_line_start_pos, etc., in redisplay
12776 handles the same cases. */
12777 && !EQ (window
, minibuf_window
)
12778 /* When splitting windows or for new windows, it happens that
12779 redisplay is called with a nil window_end_vpos or one being
12780 larger than the window. This should really be fixed in
12781 window.c. I don't have this on my list, now, so we do
12782 approximately the same as the old redisplay code. --gerd. */
12783 && INTEGERP (w
->window_end_vpos
)
12784 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12785 && (FRAME_WINDOW_P (f
)
12786 || !overlay_arrow_in_current_buffer_p ()))
12788 int this_scroll_margin
, top_scroll_margin
;
12789 struct glyph_row
*row
= NULL
;
12792 debug_method_add (w
, "cursor movement");
12795 /* Scroll if point within this distance from the top or bottom
12796 of the window. This is a pixel value. */
12797 this_scroll_margin
= max (0, scroll_margin
);
12798 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12799 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12801 top_scroll_margin
= this_scroll_margin
;
12802 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12803 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12805 /* Start with the row the cursor was displayed during the last
12806 not paused redisplay. Give up if that row is not valid. */
12807 if (w
->last_cursor
.vpos
< 0
12808 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12809 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12812 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12813 if (row
->mode_line_p
)
12815 if (!row
->enabled_p
)
12816 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12819 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12822 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12824 if (PT
> XFASTINT (w
->last_point
))
12826 /* Point has moved forward. */
12827 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12828 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12830 xassert (row
->enabled_p
);
12834 /* The end position of a row equals the start position
12835 of the next row. If PT is there, we would rather
12836 display it in the next line. */
12837 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12838 && MATRIX_ROW_END_CHARPOS (row
) == PT
12839 && !cursor_row_p (w
, row
))
12842 /* If within the scroll margin, scroll. Note that
12843 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
12844 the next line would be drawn, and that
12845 this_scroll_margin can be zero. */
12846 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
12847 || PT
> MATRIX_ROW_END_CHARPOS (row
)
12848 /* Line is completely visible last line in window
12849 and PT is to be set in the next line. */
12850 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
12851 && PT
== MATRIX_ROW_END_CHARPOS (row
)
12852 && !row
->ends_at_zv_p
12853 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12856 else if (PT
< XFASTINT (w
->last_point
))
12858 /* Cursor has to be moved backward. Note that PT >=
12859 CHARPOS (startp) because of the outer if-statement. */
12860 while (!row
->mode_line_p
12861 && (MATRIX_ROW_START_CHARPOS (row
) > PT
12862 || (MATRIX_ROW_START_CHARPOS (row
) == PT
12863 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
12864 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
12865 row
> w
->current_matrix
->rows
12866 && (row
-1)->ends_in_newline_from_string_p
))))
12867 && (row
->y
> top_scroll_margin
12868 || CHARPOS (startp
) == BEGV
))
12870 xassert (row
->enabled_p
);
12874 /* Consider the following case: Window starts at BEGV,
12875 there is invisible, intangible text at BEGV, so that
12876 display starts at some point START > BEGV. It can
12877 happen that we are called with PT somewhere between
12878 BEGV and START. Try to handle that case. */
12879 if (row
< w
->current_matrix
->rows
12880 || row
->mode_line_p
)
12882 row
= w
->current_matrix
->rows
;
12883 if (row
->mode_line_p
)
12887 /* Due to newlines in overlay strings, we may have to
12888 skip forward over overlay strings. */
12889 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12890 && MATRIX_ROW_END_CHARPOS (row
) == PT
12891 && !cursor_row_p (w
, row
))
12894 /* If within the scroll margin, scroll. */
12895 if (row
->y
< top_scroll_margin
12896 && CHARPOS (startp
) != BEGV
)
12901 /* Cursor did not move. So don't scroll even if cursor line
12902 is partially visible, as it was so before. */
12903 rc
= CURSOR_MOVEMENT_SUCCESS
;
12906 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
12907 || PT
> MATRIX_ROW_END_CHARPOS (row
))
12909 /* if PT is not in the glyph row, give up. */
12910 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12912 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
12913 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
12914 && make_cursor_line_fully_visible_p
)
12916 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
12917 && !row
->ends_at_zv_p
12918 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12919 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12920 else if (row
->height
> window_box_height (w
))
12922 /* If we end up in a partially visible line, let's
12923 make it fully visible, except when it's taller
12924 than the window, in which case we can't do much
12927 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12931 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12932 if (!cursor_row_fully_visible_p (w
, 0, 1))
12933 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12935 rc
= CURSOR_MOVEMENT_SUCCESS
;
12939 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12944 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
12946 rc
= CURSOR_MOVEMENT_SUCCESS
;
12951 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12952 && MATRIX_ROW_START_CHARPOS (row
) == PT
12953 && cursor_row_p (w
, row
));
12962 set_vertical_scroll_bar (w
)
12965 int start
, end
, whole
;
12967 /* Calculate the start and end positions for the current window.
12968 At some point, it would be nice to choose between scrollbars
12969 which reflect the whole buffer size, with special markers
12970 indicating narrowing, and scrollbars which reflect only the
12973 Note that mini-buffers sometimes aren't displaying any text. */
12974 if (!MINI_WINDOW_P (w
)
12975 || (w
== XWINDOW (minibuf_window
)
12976 && NILP (echo_area_buffer
[0])))
12978 struct buffer
*buf
= XBUFFER (w
->buffer
);
12979 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
12980 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
12981 /* I don't think this is guaranteed to be right. For the
12982 moment, we'll pretend it is. */
12983 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
12987 if (whole
< (end
- start
))
12988 whole
= end
- start
;
12991 start
= end
= whole
= 0;
12993 /* Indicate what this scroll bar ought to be displaying now. */
12994 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
12995 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
12996 (w
, end
- start
, whole
, start
);
13000 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13001 selected_window is redisplayed.
13003 We can return without actually redisplaying the window if
13004 fonts_changed_p is nonzero. In that case, redisplay_internal will
13008 redisplay_window (window
, just_this_one_p
)
13009 Lisp_Object window
;
13010 int just_this_one_p
;
13012 struct window
*w
= XWINDOW (window
);
13013 struct frame
*f
= XFRAME (w
->frame
);
13014 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13015 struct buffer
*old
= current_buffer
;
13016 struct text_pos lpoint
, opoint
, startp
;
13017 int update_mode_line
;
13020 /* Record it now because it's overwritten. */
13021 int current_matrix_up_to_date_p
= 0;
13022 int used_current_matrix_p
= 0;
13023 /* This is less strict than current_matrix_up_to_date_p.
13024 It indictes that the buffer contents and narrowing are unchanged. */
13025 int buffer_unchanged_p
= 0;
13026 int temp_scroll_step
= 0;
13027 int count
= SPECPDL_INDEX ();
13029 int centering_position
= -1;
13030 int last_line_misfit
= 0;
13031 int beg_unchanged
, end_unchanged
;
13033 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13036 /* W must be a leaf window here. */
13037 xassert (!NILP (w
->buffer
));
13039 *w
->desired_matrix
->method
= 0;
13043 reconsider_clip_changes (w
, buffer
);
13045 /* Has the mode line to be updated? */
13046 update_mode_line
= (!NILP (w
->update_mode_line
)
13047 || update_mode_lines
13048 || buffer
->clip_changed
13049 || buffer
->prevent_redisplay_optimizations_p
);
13051 if (MINI_WINDOW_P (w
))
13053 if (w
== XWINDOW (echo_area_window
)
13054 && !NILP (echo_area_buffer
[0]))
13056 if (update_mode_line
)
13057 /* We may have to update a tty frame's menu bar or a
13058 tool-bar. Example `M-x C-h C-h C-g'. */
13059 goto finish_menu_bars
;
13061 /* We've already displayed the echo area glyphs in this window. */
13062 goto finish_scroll_bars
;
13064 else if ((w
!= XWINDOW (minibuf_window
)
13065 || minibuf_level
== 0)
13066 /* When buffer is nonempty, redisplay window normally. */
13067 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13068 /* Quail displays non-mini buffers in minibuffer window.
13069 In that case, redisplay the window normally. */
13070 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13072 /* W is a mini-buffer window, but it's not active, so clear
13074 int yb
= window_text_bottom_y (w
);
13075 struct glyph_row
*row
;
13078 for (y
= 0, row
= w
->desired_matrix
->rows
;
13080 y
+= row
->height
, ++row
)
13081 blank_row (w
, row
, y
);
13082 goto finish_scroll_bars
;
13085 clear_glyph_matrix (w
->desired_matrix
);
13088 /* Otherwise set up data on this window; select its buffer and point
13090 /* Really select the buffer, for the sake of buffer-local
13092 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13094 current_matrix_up_to_date_p
13095 = (!NILP (w
->window_end_valid
)
13096 && !current_buffer
->clip_changed
13097 && !current_buffer
->prevent_redisplay_optimizations_p
13098 && XFASTINT (w
->last_modified
) >= MODIFF
13099 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13101 /* Run the window-bottom-change-functions
13102 if it is possible that the text on the screen has changed
13103 (either due to modification of the text, or any other reason). */
13104 if (!current_matrix_up_to_date_p
13105 && !NILP (Vwindow_text_change_functions
))
13107 safe_run_hooks (Qwindow_text_change_functions
);
13111 beg_unchanged
= BEG_UNCHANGED
;
13112 end_unchanged
= END_UNCHANGED
;
13114 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13116 specbind (Qinhibit_point_motion_hooks
, Qt
);
13119 = (!NILP (w
->window_end_valid
)
13120 && !current_buffer
->clip_changed
13121 && XFASTINT (w
->last_modified
) >= MODIFF
13122 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13124 /* When windows_or_buffers_changed is non-zero, we can't rely on
13125 the window end being valid, so set it to nil there. */
13126 if (windows_or_buffers_changed
)
13128 /* If window starts on a continuation line, maybe adjust the
13129 window start in case the window's width changed. */
13130 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13131 compute_window_start_on_continuation_line (w
);
13133 w
->window_end_valid
= Qnil
;
13136 /* Some sanity checks. */
13137 CHECK_WINDOW_END (w
);
13138 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13140 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13143 /* If %c is in mode line, update it if needed. */
13144 if (!NILP (w
->column_number_displayed
)
13145 /* This alternative quickly identifies a common case
13146 where no change is needed. */
13147 && !(PT
== XFASTINT (w
->last_point
)
13148 && XFASTINT (w
->last_modified
) >= MODIFF
13149 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13150 && (XFASTINT (w
->column_number_displayed
)
13151 != (int) current_column ())) /* iftc */
13152 update_mode_line
= 1;
13154 /* Count number of windows showing the selected buffer. An indirect
13155 buffer counts as its base buffer. */
13156 if (!just_this_one_p
)
13158 struct buffer
*current_base
, *window_base
;
13159 current_base
= current_buffer
;
13160 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13161 if (current_base
->base_buffer
)
13162 current_base
= current_base
->base_buffer
;
13163 if (window_base
->base_buffer
)
13164 window_base
= window_base
->base_buffer
;
13165 if (current_base
== window_base
)
13169 /* Point refers normally to the selected window. For any other
13170 window, set up appropriate value. */
13171 if (!EQ (window
, selected_window
))
13173 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13174 int new_pt_byte
= marker_byte_position (w
->pointm
);
13178 new_pt_byte
= BEGV_BYTE
;
13179 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13181 else if (new_pt
> (ZV
- 1))
13184 new_pt_byte
= ZV_BYTE
;
13185 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13188 /* We don't use SET_PT so that the point-motion hooks don't run. */
13189 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13192 /* If any of the character widths specified in the display table
13193 have changed, invalidate the width run cache. It's true that
13194 this may be a bit late to catch such changes, but the rest of
13195 redisplay goes (non-fatally) haywire when the display table is
13196 changed, so why should we worry about doing any better? */
13197 if (current_buffer
->width_run_cache
)
13199 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13201 if (! disptab_matches_widthtab (disptab
,
13202 XVECTOR (current_buffer
->width_table
)))
13204 invalidate_region_cache (current_buffer
,
13205 current_buffer
->width_run_cache
,
13207 recompute_width_table (current_buffer
, disptab
);
13211 /* If window-start is screwed up, choose a new one. */
13212 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13215 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13217 /* If someone specified a new starting point but did not insist,
13218 check whether it can be used. */
13219 if (!NILP (w
->optional_new_start
)
13220 && CHARPOS (startp
) >= BEGV
13221 && CHARPOS (startp
) <= ZV
)
13223 w
->optional_new_start
= Qnil
;
13224 start_display (&it
, w
, startp
);
13225 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13226 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13227 if (IT_CHARPOS (it
) == PT
)
13228 w
->force_start
= Qt
;
13229 /* IT may overshoot PT if text at PT is invisible. */
13230 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13231 w
->force_start
= Qt
;
13236 /* Handle case where place to start displaying has been specified,
13237 unless the specified location is outside the accessible range. */
13238 if (!NILP (w
->force_start
)
13239 || w
->frozen_window_start_p
)
13241 /* We set this later on if we have to adjust point. */
13245 w
->force_start
= Qnil
;
13247 w
->window_end_valid
= Qnil
;
13249 /* Forget any recorded base line for line number display. */
13250 if (!buffer_unchanged_p
)
13251 w
->base_line_number
= Qnil
;
13253 /* Redisplay the mode line. Select the buffer properly for that.
13254 Also, run the hook window-scroll-functions
13255 because we have scrolled. */
13256 /* Note, we do this after clearing force_start because
13257 if there's an error, it is better to forget about force_start
13258 than to get into an infinite loop calling the hook functions
13259 and having them get more errors. */
13260 if (!update_mode_line
13261 || ! NILP (Vwindow_scroll_functions
))
13263 update_mode_line
= 1;
13264 w
->update_mode_line
= Qt
;
13265 startp
= run_window_scroll_functions (window
, startp
);
13268 w
->last_modified
= make_number (0);
13269 w
->last_overlay_modified
= make_number (0);
13270 if (CHARPOS (startp
) < BEGV
)
13271 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13272 else if (CHARPOS (startp
) > ZV
)
13273 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13275 /* Redisplay, then check if cursor has been set during the
13276 redisplay. Give up if new fonts were loaded. */
13277 val
= try_window (window
, startp
, 1);
13280 w
->force_start
= Qt
;
13281 clear_glyph_matrix (w
->desired_matrix
);
13282 goto need_larger_matrices
;
13284 /* Point was outside the scroll margins. */
13286 new_vpos
= window_box_height (w
) / 2;
13288 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13290 /* If point does not appear, try to move point so it does
13291 appear. The desired matrix has been built above, so we
13292 can use it here. */
13293 new_vpos
= window_box_height (w
) / 2;
13296 if (!cursor_row_fully_visible_p (w
, 0, 0))
13298 /* Point does appear, but on a line partly visible at end of window.
13299 Move it back to a fully-visible line. */
13300 new_vpos
= window_box_height (w
);
13303 /* If we need to move point for either of the above reasons,
13304 now actually do it. */
13307 struct glyph_row
*row
;
13309 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13310 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13313 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13314 MATRIX_ROW_START_BYTEPOS (row
));
13316 if (w
!= XWINDOW (selected_window
))
13317 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13318 else if (current_buffer
== old
)
13319 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13321 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13323 /* If we are highlighting the region, then we just changed
13324 the region, so redisplay to show it. */
13325 if (!NILP (Vtransient_mark_mode
)
13326 && !NILP (current_buffer
->mark_active
))
13328 clear_glyph_matrix (w
->desired_matrix
);
13329 if (!try_window (window
, startp
, 0))
13330 goto need_larger_matrices
;
13335 debug_method_add (w
, "forced window start");
13340 /* Handle case where text has not changed, only point, and it has
13341 not moved off the frame, and we are not retrying after hscroll.
13342 (current_matrix_up_to_date_p is nonzero when retrying.) */
13343 if (current_matrix_up_to_date_p
13344 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13345 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13349 case CURSOR_MOVEMENT_SUCCESS
:
13350 used_current_matrix_p
= 1;
13353 #if 0 /* try_cursor_movement never returns this value. */
13354 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13355 goto need_larger_matrices
;
13358 case CURSOR_MOVEMENT_MUST_SCROLL
:
13359 goto try_to_scroll
;
13365 /* If current starting point was originally the beginning of a line
13366 but no longer is, find a new starting point. */
13367 else if (!NILP (w
->start_at_line_beg
)
13368 && !(CHARPOS (startp
) <= BEGV
13369 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13372 debug_method_add (w
, "recenter 1");
13377 /* Try scrolling with try_window_id. Value is > 0 if update has
13378 been done, it is -1 if we know that the same window start will
13379 not work. It is 0 if unsuccessful for some other reason. */
13380 else if ((tem
= try_window_id (w
)) != 0)
13383 debug_method_add (w
, "try_window_id %d", tem
);
13386 if (fonts_changed_p
)
13387 goto need_larger_matrices
;
13391 /* Otherwise try_window_id has returned -1 which means that we
13392 don't want the alternative below this comment to execute. */
13394 else if (CHARPOS (startp
) >= BEGV
13395 && CHARPOS (startp
) <= ZV
13396 && PT
>= CHARPOS (startp
)
13397 && (CHARPOS (startp
) < ZV
13398 /* Avoid starting at end of buffer. */
13399 || CHARPOS (startp
) == BEGV
13400 || (XFASTINT (w
->last_modified
) >= MODIFF
13401 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13404 /* If first window line is a continuation line, and window start
13405 is inside the modified region, but the first change is before
13406 current window start, we must select a new window start.
13408 However, if this is the result of a down-mouse event (e.g. by
13409 extending the mouse-drag-overlay), we don't want to select a
13410 new window start, since that would change the position under
13411 the mouse, resulting in an unwanted mouse-movement rather
13412 than a simple mouse-click. */
13413 if (NILP (w
->start_at_line_beg
)
13414 && NILP (do_mouse_tracking
)
13415 && CHARPOS (startp
) > BEGV
13416 && CHARPOS (startp
) > BEG
+ beg_unchanged
13417 && CHARPOS (startp
) <= Z
- end_unchanged
)
13419 w
->force_start
= Qt
;
13420 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13421 compute_window_start_on_continuation_line (w
);
13422 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13427 debug_method_add (w
, "same window start");
13430 /* Try to redisplay starting at same place as before.
13431 If point has not moved off frame, accept the results. */
13432 if (!current_matrix_up_to_date_p
13433 /* Don't use try_window_reusing_current_matrix in this case
13434 because a window scroll function can have changed the
13436 || !NILP (Vwindow_scroll_functions
)
13437 || MINI_WINDOW_P (w
)
13438 || !(used_current_matrix_p
13439 = try_window_reusing_current_matrix (w
)))
13441 IF_DEBUG (debug_method_add (w
, "1"));
13442 if (try_window (window
, startp
, 1) < 0)
13443 /* -1 means we need to scroll.
13444 0 means we need new matrices, but fonts_changed_p
13445 is set in that case, so we will detect it below. */
13446 goto try_to_scroll
;
13449 if (fonts_changed_p
)
13450 goto need_larger_matrices
;
13452 if (w
->cursor
.vpos
>= 0)
13454 if (!just_this_one_p
13455 || current_buffer
->clip_changed
13456 || BEG_UNCHANGED
< CHARPOS (startp
))
13457 /* Forget any recorded base line for line number display. */
13458 w
->base_line_number
= Qnil
;
13460 if (!cursor_row_fully_visible_p (w
, 1, 0))
13462 clear_glyph_matrix (w
->desired_matrix
);
13463 last_line_misfit
= 1;
13465 /* Drop through and scroll. */
13470 clear_glyph_matrix (w
->desired_matrix
);
13475 w
->last_modified
= make_number (0);
13476 w
->last_overlay_modified
= make_number (0);
13478 /* Redisplay the mode line. Select the buffer properly for that. */
13479 if (!update_mode_line
)
13481 update_mode_line
= 1;
13482 w
->update_mode_line
= Qt
;
13485 /* Try to scroll by specified few lines. */
13486 if ((scroll_conservatively
13488 || temp_scroll_step
13489 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13490 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13491 && !current_buffer
->clip_changed
13492 && CHARPOS (startp
) >= BEGV
13493 && CHARPOS (startp
) <= ZV
)
13495 /* The function returns -1 if new fonts were loaded, 1 if
13496 successful, 0 if not successful. */
13497 int rc
= try_scrolling (window
, just_this_one_p
,
13498 scroll_conservatively
,
13500 temp_scroll_step
, last_line_misfit
);
13503 case SCROLLING_SUCCESS
:
13506 case SCROLLING_NEED_LARGER_MATRICES
:
13507 goto need_larger_matrices
;
13509 case SCROLLING_FAILED
:
13517 /* Finally, just choose place to start which centers point */
13520 if (centering_position
< 0)
13521 centering_position
= window_box_height (w
) / 2;
13524 debug_method_add (w
, "recenter");
13527 /* w->vscroll = 0; */
13529 /* Forget any previously recorded base line for line number display. */
13530 if (!buffer_unchanged_p
)
13531 w
->base_line_number
= Qnil
;
13533 /* Move backward half the height of the window. */
13534 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13535 it
.current_y
= it
.last_visible_y
;
13536 move_it_vertically_backward (&it
, centering_position
);
13537 xassert (IT_CHARPOS (it
) >= BEGV
);
13539 /* The function move_it_vertically_backward may move over more
13540 than the specified y-distance. If it->w is small, e.g. a
13541 mini-buffer window, we may end up in front of the window's
13542 display area. Start displaying at the start of the line
13543 containing PT in this case. */
13544 if (it
.current_y
<= 0)
13546 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13547 move_it_vertically_backward (&it
, 0);
13549 /* I think this assert is bogus if buffer contains
13550 invisible text or images. KFS. */
13551 xassert (IT_CHARPOS (it
) <= PT
);
13556 it
.current_x
= it
.hpos
= 0;
13558 /* Set startp here explicitly in case that helps avoid an infinite loop
13559 in case the window-scroll-functions functions get errors. */
13560 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13562 /* Run scroll hooks. */
13563 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13565 /* Redisplay the window. */
13566 if (!current_matrix_up_to_date_p
13567 || windows_or_buffers_changed
13568 || cursor_type_changed
13569 /* Don't use try_window_reusing_current_matrix in this case
13570 because it can have changed the buffer. */
13571 || !NILP (Vwindow_scroll_functions
)
13572 || !just_this_one_p
13573 || MINI_WINDOW_P (w
)
13574 || !(used_current_matrix_p
13575 = try_window_reusing_current_matrix (w
)))
13576 try_window (window
, startp
, 0);
13578 /* If new fonts have been loaded (due to fontsets), give up. We
13579 have to start a new redisplay since we need to re-adjust glyph
13581 if (fonts_changed_p
)
13582 goto need_larger_matrices
;
13584 /* If cursor did not appear assume that the middle of the window is
13585 in the first line of the window. Do it again with the next line.
13586 (Imagine a window of height 100, displaying two lines of height
13587 60. Moving back 50 from it->last_visible_y will end in the first
13589 if (w
->cursor
.vpos
< 0)
13591 if (!NILP (w
->window_end_valid
)
13592 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13594 clear_glyph_matrix (w
->desired_matrix
);
13595 move_it_by_lines (&it
, 1, 0);
13596 try_window (window
, it
.current
.pos
, 0);
13598 else if (PT
< IT_CHARPOS (it
))
13600 clear_glyph_matrix (w
->desired_matrix
);
13601 move_it_by_lines (&it
, -1, 0);
13602 try_window (window
, it
.current
.pos
, 0);
13606 /* Not much we can do about it. */
13610 /* Consider the following case: Window starts at BEGV, there is
13611 invisible, intangible text at BEGV, so that display starts at
13612 some point START > BEGV. It can happen that we are called with
13613 PT somewhere between BEGV and START. Try to handle that case. */
13614 if (w
->cursor
.vpos
< 0)
13616 struct glyph_row
*row
= w
->current_matrix
->rows
;
13617 if (row
->mode_line_p
)
13619 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13622 if (!cursor_row_fully_visible_p (w
, 0, 0))
13624 /* If vscroll is enabled, disable it and try again. */
13628 clear_glyph_matrix (w
->desired_matrix
);
13632 /* If centering point failed to make the whole line visible,
13633 put point at the top instead. That has to make the whole line
13634 visible, if it can be done. */
13635 if (centering_position
== 0)
13638 clear_glyph_matrix (w
->desired_matrix
);
13639 centering_position
= 0;
13645 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13646 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13647 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13650 /* Display the mode line, if we must. */
13651 if ((update_mode_line
13652 /* If window not full width, must redo its mode line
13653 if (a) the window to its side is being redone and
13654 (b) we do a frame-based redisplay. This is a consequence
13655 of how inverted lines are drawn in frame-based redisplay. */
13656 || (!just_this_one_p
13657 && !FRAME_WINDOW_P (f
)
13658 && !WINDOW_FULL_WIDTH_P (w
))
13659 /* Line number to display. */
13660 || INTEGERP (w
->base_line_pos
)
13661 /* Column number is displayed and different from the one displayed. */
13662 || (!NILP (w
->column_number_displayed
)
13663 && (XFASTINT (w
->column_number_displayed
)
13664 != (int) current_column ()))) /* iftc */
13665 /* This means that the window has a mode line. */
13666 && (WINDOW_WANTS_MODELINE_P (w
)
13667 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13669 display_mode_lines (w
);
13671 /* If mode line height has changed, arrange for a thorough
13672 immediate redisplay using the correct mode line height. */
13673 if (WINDOW_WANTS_MODELINE_P (w
)
13674 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13676 fonts_changed_p
= 1;
13677 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13678 = DESIRED_MODE_LINE_HEIGHT (w
);
13681 /* If top line height has changed, arrange for a thorough
13682 immediate redisplay using the correct mode line height. */
13683 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13684 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13686 fonts_changed_p
= 1;
13687 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13688 = DESIRED_HEADER_LINE_HEIGHT (w
);
13691 if (fonts_changed_p
)
13692 goto need_larger_matrices
;
13695 if (!line_number_displayed
13696 && !BUFFERP (w
->base_line_pos
))
13698 w
->base_line_pos
= Qnil
;
13699 w
->base_line_number
= Qnil
;
13704 /* When we reach a frame's selected window, redo the frame's menu bar. */
13705 if (update_mode_line
13706 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13708 int redisplay_menu_p
= 0;
13709 int redisplay_tool_bar_p
= 0;
13711 if (FRAME_WINDOW_P (f
))
13713 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
13714 || defined (USE_GTK)
13715 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13717 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13721 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13723 if (redisplay_menu_p
)
13724 display_menu_bar (w
);
13726 #ifdef HAVE_WINDOW_SYSTEM
13727 if (FRAME_WINDOW_P (f
))
13729 #if defined (USE_GTK) || USE_MAC_TOOLBAR
13730 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13732 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13733 && (FRAME_TOOL_BAR_LINES (f
) > 0
13734 || !NILP (Vauto_resize_tool_bars
));
13737 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13739 extern int ignore_mouse_drag_p
;
13740 ignore_mouse_drag_p
= 1;
13746 #ifdef HAVE_WINDOW_SYSTEM
13747 if (FRAME_WINDOW_P (f
)
13748 && update_window_fringes (w
, (just_this_one_p
13749 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13750 || w
->pseudo_window_p
)))
13754 if (draw_window_fringes (w
, 1))
13755 x_draw_vertical_border (w
);
13759 #endif /* HAVE_WINDOW_SYSTEM */
13761 /* We go to this label, with fonts_changed_p nonzero,
13762 if it is necessary to try again using larger glyph matrices.
13763 We have to redeem the scroll bar even in this case,
13764 because the loop in redisplay_internal expects that. */
13765 need_larger_matrices
:
13767 finish_scroll_bars
:
13769 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13771 /* Set the thumb's position and size. */
13772 set_vertical_scroll_bar (w
);
13774 /* Note that we actually used the scroll bar attached to this
13775 window, so it shouldn't be deleted at the end of redisplay. */
13776 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13777 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13780 /* Restore current_buffer and value of point in it. */
13781 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13782 set_buffer_internal_1 (old
);
13783 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13784 shorter. This can be caused by log truncation in *Messages*. */
13785 if (CHARPOS (lpoint
) <= ZV
)
13786 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13788 unbind_to (count
, Qnil
);
13792 /* Build the complete desired matrix of WINDOW with a window start
13793 buffer position POS.
13795 Value is 1 if successful. It is zero if fonts were loaded during
13796 redisplay which makes re-adjusting glyph matrices necessary, and -1
13797 if point would appear in the scroll margins.
13798 (We check that only if CHECK_MARGINS is nonzero. */
13801 try_window (window
, pos
, check_margins
)
13802 Lisp_Object window
;
13803 struct text_pos pos
;
13806 struct window
*w
= XWINDOW (window
);
13808 struct glyph_row
*last_text_row
= NULL
;
13809 struct frame
*f
= XFRAME (w
->frame
);
13811 /* Make POS the new window start. */
13812 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13814 /* Mark cursor position as unknown. No overlay arrow seen. */
13815 w
->cursor
.vpos
= -1;
13816 overlay_arrow_seen
= 0;
13818 /* Initialize iterator and info to start at POS. */
13819 start_display (&it
, w
, pos
);
13821 /* Display all lines of W. */
13822 while (it
.current_y
< it
.last_visible_y
)
13824 if (display_line (&it
))
13825 last_text_row
= it
.glyph_row
- 1;
13826 if (fonts_changed_p
)
13830 /* Don't let the cursor end in the scroll margins. */
13832 && !MINI_WINDOW_P (w
))
13834 int this_scroll_margin
;
13836 this_scroll_margin
= max (0, scroll_margin
);
13837 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13838 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13840 if ((w
->cursor
.y
>= 0 /* not vscrolled */
13841 && w
->cursor
.y
< this_scroll_margin
13842 && CHARPOS (pos
) > BEGV
13843 && IT_CHARPOS (it
) < ZV
)
13844 /* rms: considering make_cursor_line_fully_visible_p here
13845 seems to give wrong results. We don't want to recenter
13846 when the last line is partly visible, we want to allow
13847 that case to be handled in the usual way. */
13848 || (w
->cursor
.y
+ 1) > it
.last_visible_y
)
13850 w
->cursor
.vpos
= -1;
13851 clear_glyph_matrix (w
->desired_matrix
);
13856 /* If bottom moved off end of frame, change mode line percentage. */
13857 if (XFASTINT (w
->window_end_pos
) <= 0
13858 && Z
!= IT_CHARPOS (it
))
13859 w
->update_mode_line
= Qt
;
13861 /* Set window_end_pos to the offset of the last character displayed
13862 on the window from the end of current_buffer. Set
13863 window_end_vpos to its row number. */
13866 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
13867 w
->window_end_bytepos
13868 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13870 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13872 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13873 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
13874 ->displays_text_p
);
13878 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
13879 w
->window_end_pos
= make_number (Z
- ZV
);
13880 w
->window_end_vpos
= make_number (0);
13883 /* But that is not valid info until redisplay finishes. */
13884 w
->window_end_valid
= Qnil
;
13890 /************************************************************************
13891 Window redisplay reusing current matrix when buffer has not changed
13892 ************************************************************************/
13894 /* Try redisplay of window W showing an unchanged buffer with a
13895 different window start than the last time it was displayed by
13896 reusing its current matrix. Value is non-zero if successful.
13897 W->start is the new window start. */
13900 try_window_reusing_current_matrix (w
)
13903 struct frame
*f
= XFRAME (w
->frame
);
13904 struct glyph_row
*row
, *bottom_row
;
13907 struct text_pos start
, new_start
;
13908 int nrows_scrolled
, i
;
13909 struct glyph_row
*last_text_row
;
13910 struct glyph_row
*last_reused_text_row
;
13911 struct glyph_row
*start_row
;
13912 int start_vpos
, min_y
, max_y
;
13915 if (inhibit_try_window_reusing
)
13919 if (/* This function doesn't handle terminal frames. */
13920 !FRAME_WINDOW_P (f
)
13921 /* Don't try to reuse the display if windows have been split
13923 || windows_or_buffers_changed
13924 || cursor_type_changed
)
13927 /* Can't do this if region may have changed. */
13928 if ((!NILP (Vtransient_mark_mode
)
13929 && !NILP (current_buffer
->mark_active
))
13930 || !NILP (w
->region_showing
)
13931 || !NILP (Vshow_trailing_whitespace
))
13934 /* If top-line visibility has changed, give up. */
13935 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13936 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
13939 /* Give up if old or new display is scrolled vertically. We could
13940 make this function handle this, but right now it doesn't. */
13941 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
13942 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
13945 /* The variable new_start now holds the new window start. The old
13946 start `start' can be determined from the current matrix. */
13947 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
13948 start
= start_row
->start
.pos
;
13949 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
13951 /* Clear the desired matrix for the display below. */
13952 clear_glyph_matrix (w
->desired_matrix
);
13954 if (CHARPOS (new_start
) <= CHARPOS (start
))
13958 /* Don't use this method if the display starts with an ellipsis
13959 displayed for invisible text. It's not easy to handle that case
13960 below, and it's certainly not worth the effort since this is
13961 not a frequent case. */
13962 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
13965 IF_DEBUG (debug_method_add (w
, "twu1"));
13967 /* Display up to a row that can be reused. The variable
13968 last_text_row is set to the last row displayed that displays
13969 text. Note that it.vpos == 0 if or if not there is a
13970 header-line; it's not the same as the MATRIX_ROW_VPOS! */
13971 start_display (&it
, w
, new_start
);
13972 first_row_y
= it
.current_y
;
13973 w
->cursor
.vpos
= -1;
13974 last_text_row
= last_reused_text_row
= NULL
;
13976 while (it
.current_y
< it
.last_visible_y
13977 && !fonts_changed_p
)
13979 /* If we have reached into the characters in the START row,
13980 that means the line boundaries have changed. So we
13981 can't start copying with the row START. Maybe it will
13982 work to start copying with the following row. */
13983 while (IT_CHARPOS (it
) > CHARPOS (start
))
13985 /* Advance to the next row as the "start". */
13987 start
= start_row
->start
.pos
;
13988 /* If there are no more rows to try, or just one, give up. */
13989 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
13990 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
13991 || CHARPOS (start
) == ZV
)
13993 clear_glyph_matrix (w
->desired_matrix
);
13997 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
13999 /* If we have reached alignment,
14000 we can copy the rest of the rows. */
14001 if (IT_CHARPOS (it
) == CHARPOS (start
))
14004 if (display_line (&it
))
14005 last_text_row
= it
.glyph_row
- 1;
14008 /* A value of current_y < last_visible_y means that we stopped
14009 at the previous window start, which in turn means that we
14010 have at least one reusable row. */
14011 if (it
.current_y
< it
.last_visible_y
)
14013 /* IT.vpos always starts from 0; it counts text lines. */
14014 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14016 /* Find PT if not already found in the lines displayed. */
14017 if (w
->cursor
.vpos
< 0)
14019 int dy
= it
.current_y
- start_row
->y
;
14021 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14022 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14024 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14025 dy
, nrows_scrolled
);
14028 clear_glyph_matrix (w
->desired_matrix
);
14033 /* Scroll the display. Do it before the current matrix is
14034 changed. The problem here is that update has not yet
14035 run, i.e. part of the current matrix is not up to date.
14036 scroll_run_hook will clear the cursor, and use the
14037 current matrix to get the height of the row the cursor is
14039 run
.current_y
= start_row
->y
;
14040 run
.desired_y
= it
.current_y
;
14041 run
.height
= it
.last_visible_y
- it
.current_y
;
14043 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14046 FRAME_RIF (f
)->update_window_begin_hook (w
);
14047 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14048 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14049 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14053 /* Shift current matrix down by nrows_scrolled lines. */
14054 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14055 rotate_matrix (w
->current_matrix
,
14057 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14060 /* Disable lines that must be updated. */
14061 for (i
= 0; i
< nrows_scrolled
; ++i
)
14062 (start_row
+ i
)->enabled_p
= 0;
14064 /* Re-compute Y positions. */
14065 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14066 max_y
= it
.last_visible_y
;
14067 for (row
= start_row
+ nrows_scrolled
;
14071 row
->y
= it
.current_y
;
14072 row
->visible_height
= row
->height
;
14074 if (row
->y
< min_y
)
14075 row
->visible_height
-= min_y
- row
->y
;
14076 if (row
->y
+ row
->height
> max_y
)
14077 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14078 row
->redraw_fringe_bitmaps_p
= 1;
14080 it
.current_y
+= row
->height
;
14082 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14083 last_reused_text_row
= row
;
14084 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14088 /* Disable lines in the current matrix which are now
14089 below the window. */
14090 for (++row
; row
< bottom_row
; ++row
)
14091 row
->enabled_p
= row
->mode_line_p
= 0;
14094 /* Update window_end_pos etc.; last_reused_text_row is the last
14095 reused row from the current matrix containing text, if any.
14096 The value of last_text_row is the last displayed line
14097 containing text. */
14098 if (last_reused_text_row
)
14100 w
->window_end_bytepos
14101 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14103 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14105 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14106 w
->current_matrix
));
14108 else if (last_text_row
)
14110 w
->window_end_bytepos
14111 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14113 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14115 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14119 /* This window must be completely empty. */
14120 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14121 w
->window_end_pos
= make_number (Z
- ZV
);
14122 w
->window_end_vpos
= make_number (0);
14124 w
->window_end_valid
= Qnil
;
14126 /* Update hint: don't try scrolling again in update_window. */
14127 w
->desired_matrix
->no_scrolling_p
= 1;
14130 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14134 else if (CHARPOS (new_start
) > CHARPOS (start
))
14136 struct glyph_row
*pt_row
, *row
;
14137 struct glyph_row
*first_reusable_row
;
14138 struct glyph_row
*first_row_to_display
;
14140 int yb
= window_text_bottom_y (w
);
14142 /* Find the row starting at new_start, if there is one. Don't
14143 reuse a partially visible line at the end. */
14144 first_reusable_row
= start_row
;
14145 while (first_reusable_row
->enabled_p
14146 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14147 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14148 < CHARPOS (new_start
)))
14149 ++first_reusable_row
;
14151 /* Give up if there is no row to reuse. */
14152 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14153 || !first_reusable_row
->enabled_p
14154 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14155 != CHARPOS (new_start
)))
14158 /* We can reuse fully visible rows beginning with
14159 first_reusable_row to the end of the window. Set
14160 first_row_to_display to the first row that cannot be reused.
14161 Set pt_row to the row containing point, if there is any. */
14163 for (first_row_to_display
= first_reusable_row
;
14164 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14165 ++first_row_to_display
)
14167 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14168 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14169 pt_row
= first_row_to_display
;
14172 /* Start displaying at the start of first_row_to_display. */
14173 xassert (first_row_to_display
->y
< yb
);
14174 init_to_row_start (&it
, w
, first_row_to_display
);
14176 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14178 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14180 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14181 + WINDOW_HEADER_LINE_HEIGHT (w
));
14183 /* Display lines beginning with first_row_to_display in the
14184 desired matrix. Set last_text_row to the last row displayed
14185 that displays text. */
14186 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14187 if (pt_row
== NULL
)
14188 w
->cursor
.vpos
= -1;
14189 last_text_row
= NULL
;
14190 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14191 if (display_line (&it
))
14192 last_text_row
= it
.glyph_row
- 1;
14194 /* Give up If point isn't in a row displayed or reused. */
14195 if (w
->cursor
.vpos
< 0)
14197 clear_glyph_matrix (w
->desired_matrix
);
14201 /* If point is in a reused row, adjust y and vpos of the cursor
14205 w
->cursor
.vpos
-= nrows_scrolled
;
14206 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14209 /* Scroll the display. */
14210 run
.current_y
= first_reusable_row
->y
;
14211 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14212 run
.height
= it
.last_visible_y
- run
.current_y
;
14213 dy
= run
.current_y
- run
.desired_y
;
14218 FRAME_RIF (f
)->update_window_begin_hook (w
);
14219 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14220 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14221 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14225 /* Adjust Y positions of reused rows. */
14226 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14227 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14228 max_y
= it
.last_visible_y
;
14229 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14232 row
->visible_height
= row
->height
;
14233 if (row
->y
< min_y
)
14234 row
->visible_height
-= min_y
- row
->y
;
14235 if (row
->y
+ row
->height
> max_y
)
14236 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14237 row
->redraw_fringe_bitmaps_p
= 1;
14240 /* Scroll the current matrix. */
14241 xassert (nrows_scrolled
> 0);
14242 rotate_matrix (w
->current_matrix
,
14244 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14247 /* Disable rows not reused. */
14248 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14249 row
->enabled_p
= 0;
14251 /* Point may have moved to a different line, so we cannot assume that
14252 the previous cursor position is valid; locate the correct row. */
14255 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14256 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14260 w
->cursor
.y
= row
->y
;
14262 if (row
< bottom_row
)
14264 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14265 while (glyph
->charpos
< PT
)
14268 w
->cursor
.x
+= glyph
->pixel_width
;
14274 /* Adjust window end. A null value of last_text_row means that
14275 the window end is in reused rows which in turn means that
14276 only its vpos can have changed. */
14279 w
->window_end_bytepos
14280 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14282 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14284 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14289 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14292 w
->window_end_valid
= Qnil
;
14293 w
->desired_matrix
->no_scrolling_p
= 1;
14296 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14306 /************************************************************************
14307 Window redisplay reusing current matrix when buffer has changed
14308 ************************************************************************/
14310 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14311 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14313 static struct glyph_row
*
14314 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14315 struct glyph_row
*));
14318 /* Return the last row in MATRIX displaying text. If row START is
14319 non-null, start searching with that row. IT gives the dimensions
14320 of the display. Value is null if matrix is empty; otherwise it is
14321 a pointer to the row found. */
14323 static struct glyph_row
*
14324 find_last_row_displaying_text (matrix
, it
, start
)
14325 struct glyph_matrix
*matrix
;
14327 struct glyph_row
*start
;
14329 struct glyph_row
*row
, *row_found
;
14331 /* Set row_found to the last row in IT->w's current matrix
14332 displaying text. The loop looks funny but think of partially
14335 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14336 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14338 xassert (row
->enabled_p
);
14340 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14349 /* Return the last row in the current matrix of W that is not affected
14350 by changes at the start of current_buffer that occurred since W's
14351 current matrix was built. Value is null if no such row exists.
14353 BEG_UNCHANGED us the number of characters unchanged at the start of
14354 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14355 first changed character in current_buffer. Characters at positions <
14356 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14357 when the current matrix was built. */
14359 static struct glyph_row
*
14360 find_last_unchanged_at_beg_row (w
)
14363 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14364 struct glyph_row
*row
;
14365 struct glyph_row
*row_found
= NULL
;
14366 int yb
= window_text_bottom_y (w
);
14368 /* Find the last row displaying unchanged text. */
14369 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14370 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14371 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
14373 if (/* If row ends before first_changed_pos, it is unchanged,
14374 except in some case. */
14375 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14376 /* When row ends in ZV and we write at ZV it is not
14378 && !row
->ends_at_zv_p
14379 /* When first_changed_pos is the end of a continued line,
14380 row is not unchanged because it may be no longer
14382 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14383 && (row
->continued_p
14384 || row
->exact_window_width_line_p
)))
14387 /* Stop if last visible row. */
14388 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14398 /* Find the first glyph row in the current matrix of W that is not
14399 affected by changes at the end of current_buffer since the
14400 time W's current matrix was built.
14402 Return in *DELTA the number of chars by which buffer positions in
14403 unchanged text at the end of current_buffer must be adjusted.
14405 Return in *DELTA_BYTES the corresponding number of bytes.
14407 Value is null if no such row exists, i.e. all rows are affected by
14410 static struct glyph_row
*
14411 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14413 int *delta
, *delta_bytes
;
14415 struct glyph_row
*row
;
14416 struct glyph_row
*row_found
= NULL
;
14418 *delta
= *delta_bytes
= 0;
14420 /* Display must not have been paused, otherwise the current matrix
14421 is not up to date. */
14422 eassert (!NILP (w
->window_end_valid
));
14424 /* A value of window_end_pos >= END_UNCHANGED means that the window
14425 end is in the range of changed text. If so, there is no
14426 unchanged row at the end of W's current matrix. */
14427 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14430 /* Set row to the last row in W's current matrix displaying text. */
14431 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14433 /* If matrix is entirely empty, no unchanged row exists. */
14434 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14436 /* The value of row is the last glyph row in the matrix having a
14437 meaningful buffer position in it. The end position of row
14438 corresponds to window_end_pos. This allows us to translate
14439 buffer positions in the current matrix to current buffer
14440 positions for characters not in changed text. */
14441 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14442 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14443 int last_unchanged_pos
, last_unchanged_pos_old
;
14444 struct glyph_row
*first_text_row
14445 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14447 *delta
= Z
- Z_old
;
14448 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14450 /* Set last_unchanged_pos to the buffer position of the last
14451 character in the buffer that has not been changed. Z is the
14452 index + 1 of the last character in current_buffer, i.e. by
14453 subtracting END_UNCHANGED we get the index of the last
14454 unchanged character, and we have to add BEG to get its buffer
14456 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14457 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14459 /* Search backward from ROW for a row displaying a line that
14460 starts at a minimum position >= last_unchanged_pos_old. */
14461 for (; row
> first_text_row
; --row
)
14463 /* This used to abort, but it can happen.
14464 It is ok to just stop the search instead here. KFS. */
14465 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14468 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14473 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14479 /* Make sure that glyph rows in the current matrix of window W
14480 reference the same glyph memory as corresponding rows in the
14481 frame's frame matrix. This function is called after scrolling W's
14482 current matrix on a terminal frame in try_window_id and
14483 try_window_reusing_current_matrix. */
14486 sync_frame_with_window_matrix_rows (w
)
14489 struct frame
*f
= XFRAME (w
->frame
);
14490 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14492 /* Preconditions: W must be a leaf window and full-width. Its frame
14493 must have a frame matrix. */
14494 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14495 xassert (WINDOW_FULL_WIDTH_P (w
));
14496 xassert (!FRAME_WINDOW_P (f
));
14498 /* If W is a full-width window, glyph pointers in W's current matrix
14499 have, by definition, to be the same as glyph pointers in the
14500 corresponding frame matrix. Note that frame matrices have no
14501 marginal areas (see build_frame_matrix). */
14502 window_row
= w
->current_matrix
->rows
;
14503 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14504 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14505 while (window_row
< window_row_end
)
14507 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14508 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14510 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14511 frame_row
->glyphs
[TEXT_AREA
] = start
;
14512 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14513 frame_row
->glyphs
[LAST_AREA
] = end
;
14515 /* Disable frame rows whose corresponding window rows have
14516 been disabled in try_window_id. */
14517 if (!window_row
->enabled_p
)
14518 frame_row
->enabled_p
= 0;
14520 ++window_row
, ++frame_row
;
14525 /* Find the glyph row in window W containing CHARPOS. Consider all
14526 rows between START and END (not inclusive). END null means search
14527 all rows to the end of the display area of W. Value is the row
14528 containing CHARPOS or null. */
14531 row_containing_pos (w
, charpos
, start
, end
, dy
)
14534 struct glyph_row
*start
, *end
;
14537 struct glyph_row
*row
= start
;
14540 /* If we happen to start on a header-line, skip that. */
14541 if (row
->mode_line_p
)
14544 if ((end
&& row
>= end
) || !row
->enabled_p
)
14547 last_y
= window_text_bottom_y (w
) - dy
;
14551 /* Give up if we have gone too far. */
14552 if (end
&& row
>= end
)
14554 /* This formerly returned if they were equal.
14555 I think that both quantities are of a "last plus one" type;
14556 if so, when they are equal, the row is within the screen. -- rms. */
14557 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14560 /* If it is in this row, return this row. */
14561 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14562 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14563 /* The end position of a row equals the start
14564 position of the next row. If CHARPOS is there, we
14565 would rather display it in the next line, except
14566 when this line ends in ZV. */
14567 && !row
->ends_at_zv_p
14568 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14569 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14576 /* Try to redisplay window W by reusing its existing display. W's
14577 current matrix must be up to date when this function is called,
14578 i.e. window_end_valid must not be nil.
14582 1 if display has been updated
14583 0 if otherwise unsuccessful
14584 -1 if redisplay with same window start is known not to succeed
14586 The following steps are performed:
14588 1. Find the last row in the current matrix of W that is not
14589 affected by changes at the start of current_buffer. If no such row
14592 2. Find the first row in W's current matrix that is not affected by
14593 changes at the end of current_buffer. Maybe there is no such row.
14595 3. Display lines beginning with the row + 1 found in step 1 to the
14596 row found in step 2 or, if step 2 didn't find a row, to the end of
14599 4. If cursor is not known to appear on the window, give up.
14601 5. If display stopped at the row found in step 2, scroll the
14602 display and current matrix as needed.
14604 6. Maybe display some lines at the end of W, if we must. This can
14605 happen under various circumstances, like a partially visible line
14606 becoming fully visible, or because newly displayed lines are displayed
14607 in smaller font sizes.
14609 7. Update W's window end information. */
14615 struct frame
*f
= XFRAME (w
->frame
);
14616 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14617 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14618 struct glyph_row
*last_unchanged_at_beg_row
;
14619 struct glyph_row
*first_unchanged_at_end_row
;
14620 struct glyph_row
*row
;
14621 struct glyph_row
*bottom_row
;
14624 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14625 struct text_pos start_pos
;
14627 int first_unchanged_at_end_vpos
= 0;
14628 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14629 struct text_pos start
;
14630 int first_changed_charpos
, last_changed_charpos
;
14633 if (inhibit_try_window_id
)
14637 /* This is handy for debugging. */
14639 #define GIVE_UP(X) \
14641 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14645 #define GIVE_UP(X) return 0
14648 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14650 /* Don't use this for mini-windows because these can show
14651 messages and mini-buffers, and we don't handle that here. */
14652 if (MINI_WINDOW_P (w
))
14655 /* This flag is used to prevent redisplay optimizations. */
14656 if (windows_or_buffers_changed
|| cursor_type_changed
)
14659 /* Verify that narrowing has not changed.
14660 Also verify that we were not told to prevent redisplay optimizations.
14661 It would be nice to further
14662 reduce the number of cases where this prevents try_window_id. */
14663 if (current_buffer
->clip_changed
14664 || current_buffer
->prevent_redisplay_optimizations_p
)
14667 /* Window must either use window-based redisplay or be full width. */
14668 if (!FRAME_WINDOW_P (f
)
14669 && (!FRAME_LINE_INS_DEL_OK (f
)
14670 || !WINDOW_FULL_WIDTH_P (w
)))
14673 /* Give up if point is not known NOT to appear in W. */
14674 if (PT
< CHARPOS (start
))
14677 /* Another way to prevent redisplay optimizations. */
14678 if (XFASTINT (w
->last_modified
) == 0)
14681 /* Verify that window is not hscrolled. */
14682 if (XFASTINT (w
->hscroll
) != 0)
14685 /* Verify that display wasn't paused. */
14686 if (NILP (w
->window_end_valid
))
14689 /* Can't use this if highlighting a region because a cursor movement
14690 will do more than just set the cursor. */
14691 if (!NILP (Vtransient_mark_mode
)
14692 && !NILP (current_buffer
->mark_active
))
14695 /* Likewise if highlighting trailing whitespace. */
14696 if (!NILP (Vshow_trailing_whitespace
))
14699 /* Likewise if showing a region. */
14700 if (!NILP (w
->region_showing
))
14703 /* Can use this if overlay arrow position and or string have changed. */
14704 if (overlay_arrows_changed_p ())
14708 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14709 only if buffer has really changed. The reason is that the gap is
14710 initially at Z for freshly visited files. The code below would
14711 set end_unchanged to 0 in that case. */
14712 if (MODIFF
> SAVE_MODIFF
14713 /* This seems to happen sometimes after saving a buffer. */
14714 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14716 if (GPT
- BEG
< BEG_UNCHANGED
)
14717 BEG_UNCHANGED
= GPT
- BEG
;
14718 if (Z
- GPT
< END_UNCHANGED
)
14719 END_UNCHANGED
= Z
- GPT
;
14722 /* The position of the first and last character that has been changed. */
14723 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14724 last_changed_charpos
= Z
- END_UNCHANGED
;
14726 /* If window starts after a line end, and the last change is in
14727 front of that newline, then changes don't affect the display.
14728 This case happens with stealth-fontification. Note that although
14729 the display is unchanged, glyph positions in the matrix have to
14730 be adjusted, of course. */
14731 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14732 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14733 && ((last_changed_charpos
< CHARPOS (start
)
14734 && CHARPOS (start
) == BEGV
)
14735 || (last_changed_charpos
< CHARPOS (start
) - 1
14736 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14738 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14739 struct glyph_row
*r0
;
14741 /* Compute how many chars/bytes have been added to or removed
14742 from the buffer. */
14743 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14744 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14746 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14748 /* Give up if PT is not in the window. Note that it already has
14749 been checked at the start of try_window_id that PT is not in
14750 front of the window start. */
14751 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14754 /* If window start is unchanged, we can reuse the whole matrix
14755 as is, after adjusting glyph positions. No need to compute
14756 the window end again, since its offset from Z hasn't changed. */
14757 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14758 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14759 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14760 /* PT must not be in a partially visible line. */
14761 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14762 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14764 /* Adjust positions in the glyph matrix. */
14765 if (delta
|| delta_bytes
)
14767 struct glyph_row
*r1
14768 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14769 increment_matrix_positions (w
->current_matrix
,
14770 MATRIX_ROW_VPOS (r0
, current_matrix
),
14771 MATRIX_ROW_VPOS (r1
, current_matrix
),
14772 delta
, delta_bytes
);
14775 /* Set the cursor. */
14776 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14778 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14785 /* Handle the case that changes are all below what is displayed in
14786 the window, and that PT is in the window. This shortcut cannot
14787 be taken if ZV is visible in the window, and text has been added
14788 there that is visible in the window. */
14789 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14790 /* ZV is not visible in the window, or there are no
14791 changes at ZV, actually. */
14792 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14793 || first_changed_charpos
== last_changed_charpos
))
14795 struct glyph_row
*r0
;
14797 /* Give up if PT is not in the window. Note that it already has
14798 been checked at the start of try_window_id that PT is not in
14799 front of the window start. */
14800 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14803 /* If window start is unchanged, we can reuse the whole matrix
14804 as is, without changing glyph positions since no text has
14805 been added/removed in front of the window end. */
14806 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14807 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14808 /* PT must not be in a partially visible line. */
14809 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14810 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14812 /* We have to compute the window end anew since text
14813 can have been added/removed after it. */
14815 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14816 w
->window_end_bytepos
14817 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14819 /* Set the cursor. */
14820 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14822 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14829 /* Give up if window start is in the changed area.
14831 The condition used to read
14833 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
14835 but why that was tested escapes me at the moment. */
14836 if (CHARPOS (start
) >= first_changed_charpos
14837 && CHARPOS (start
) <= last_changed_charpos
)
14840 /* Check that window start agrees with the start of the first glyph
14841 row in its current matrix. Check this after we know the window
14842 start is not in changed text, otherwise positions would not be
14844 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14845 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
14848 /* Give up if the window ends in strings. Overlay strings
14849 at the end are difficult to handle, so don't try. */
14850 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
14851 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
14854 /* Compute the position at which we have to start displaying new
14855 lines. Some of the lines at the top of the window might be
14856 reusable because they are not displaying changed text. Find the
14857 last row in W's current matrix not affected by changes at the
14858 start of current_buffer. Value is null if changes start in the
14859 first line of window. */
14860 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
14861 if (last_unchanged_at_beg_row
)
14863 /* Avoid starting to display in the moddle of a character, a TAB
14864 for instance. This is easier than to set up the iterator
14865 exactly, and it's not a frequent case, so the additional
14866 effort wouldn't really pay off. */
14867 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
14868 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
14869 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
14870 --last_unchanged_at_beg_row
;
14872 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
14875 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
14877 start_pos
= it
.current
.pos
;
14879 /* Start displaying new lines in the desired matrix at the same
14880 vpos we would use in the current matrix, i.e. below
14881 last_unchanged_at_beg_row. */
14882 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
14884 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
14885 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
14887 xassert (it
.hpos
== 0 && it
.current_x
== 0);
14891 /* There are no reusable lines at the start of the window.
14892 Start displaying in the first text line. */
14893 start_display (&it
, w
, start
);
14894 it
.vpos
= it
.first_vpos
;
14895 start_pos
= it
.current
.pos
;
14898 /* Find the first row that is not affected by changes at the end of
14899 the buffer. Value will be null if there is no unchanged row, in
14900 which case we must redisplay to the end of the window. delta
14901 will be set to the value by which buffer positions beginning with
14902 first_unchanged_at_end_row have to be adjusted due to text
14904 first_unchanged_at_end_row
14905 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
14906 IF_DEBUG (debug_delta
= delta
);
14907 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
14909 /* Set stop_pos to the buffer position up to which we will have to
14910 display new lines. If first_unchanged_at_end_row != NULL, this
14911 is the buffer position of the start of the line displayed in that
14912 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
14913 that we don't stop at a buffer position. */
14915 if (first_unchanged_at_end_row
)
14917 xassert (last_unchanged_at_beg_row
== NULL
14918 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
14920 /* If this is a continuation line, move forward to the next one
14921 that isn't. Changes in lines above affect this line.
14922 Caution: this may move first_unchanged_at_end_row to a row
14923 not displaying text. */
14924 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
14925 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14926 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14927 < it
.last_visible_y
))
14928 ++first_unchanged_at_end_row
;
14930 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14931 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14932 >= it
.last_visible_y
))
14933 first_unchanged_at_end_row
= NULL
;
14936 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
14938 first_unchanged_at_end_vpos
14939 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
14940 xassert (stop_pos
>= Z
- END_UNCHANGED
);
14943 else if (last_unchanged_at_beg_row
== NULL
)
14949 /* Either there is no unchanged row at the end, or the one we have
14950 now displays text. This is a necessary condition for the window
14951 end pos calculation at the end of this function. */
14952 xassert (first_unchanged_at_end_row
== NULL
14953 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
14955 debug_last_unchanged_at_beg_vpos
14956 = (last_unchanged_at_beg_row
14957 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
14959 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
14961 #endif /* GLYPH_DEBUG != 0 */
14964 /* Display new lines. Set last_text_row to the last new line
14965 displayed which has text on it, i.e. might end up as being the
14966 line where the window_end_vpos is. */
14967 w
->cursor
.vpos
= -1;
14968 last_text_row
= NULL
;
14969 overlay_arrow_seen
= 0;
14970 while (it
.current_y
< it
.last_visible_y
14971 && !fonts_changed_p
14972 && (first_unchanged_at_end_row
== NULL
14973 || IT_CHARPOS (it
) < stop_pos
))
14975 if (display_line (&it
))
14976 last_text_row
= it
.glyph_row
- 1;
14979 if (fonts_changed_p
)
14983 /* Compute differences in buffer positions, y-positions etc. for
14984 lines reused at the bottom of the window. Compute what we can
14986 if (first_unchanged_at_end_row
14987 /* No lines reused because we displayed everything up to the
14988 bottom of the window. */
14989 && it
.current_y
< it
.last_visible_y
)
14992 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
14994 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
14995 run
.current_y
= first_unchanged_at_end_row
->y
;
14996 run
.desired_y
= run
.current_y
+ dy
;
14997 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15001 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
15002 first_unchanged_at_end_row
= NULL
;
15004 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15007 /* Find the cursor if not already found. We have to decide whether
15008 PT will appear on this window (it sometimes doesn't, but this is
15009 not a very frequent case.) This decision has to be made before
15010 the current matrix is altered. A value of cursor.vpos < 0 means
15011 that PT is either in one of the lines beginning at
15012 first_unchanged_at_end_row or below the window. Don't care for
15013 lines that might be displayed later at the window end; as
15014 mentioned, this is not a frequent case. */
15015 if (w
->cursor
.vpos
< 0)
15017 /* Cursor in unchanged rows at the top? */
15018 if (PT
< CHARPOS (start_pos
)
15019 && last_unchanged_at_beg_row
)
15021 row
= row_containing_pos (w
, PT
,
15022 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15023 last_unchanged_at_beg_row
+ 1, 0);
15025 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15028 /* Start from first_unchanged_at_end_row looking for PT. */
15029 else if (first_unchanged_at_end_row
)
15031 row
= row_containing_pos (w
, PT
- delta
,
15032 first_unchanged_at_end_row
, NULL
, 0);
15034 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15035 delta_bytes
, dy
, dvpos
);
15038 /* Give up if cursor was not found. */
15039 if (w
->cursor
.vpos
< 0)
15041 clear_glyph_matrix (w
->desired_matrix
);
15046 /* Don't let the cursor end in the scroll margins. */
15048 int this_scroll_margin
, cursor_height
;
15050 this_scroll_margin
= max (0, scroll_margin
);
15051 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15052 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15053 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15055 if ((w
->cursor
.y
< this_scroll_margin
15056 && CHARPOS (start
) > BEGV
)
15057 /* Old redisplay didn't take scroll margin into account at the bottom,
15058 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15059 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15060 ? cursor_height
+ this_scroll_margin
15061 : 1)) > it
.last_visible_y
)
15063 w
->cursor
.vpos
= -1;
15064 clear_glyph_matrix (w
->desired_matrix
);
15069 /* Scroll the display. Do it before changing the current matrix so
15070 that xterm.c doesn't get confused about where the cursor glyph is
15072 if (dy
&& run
.height
)
15076 if (FRAME_WINDOW_P (f
))
15078 FRAME_RIF (f
)->update_window_begin_hook (w
);
15079 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15080 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15081 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15085 /* Terminal frame. In this case, dvpos gives the number of
15086 lines to scroll by; dvpos < 0 means scroll up. */
15087 int first_unchanged_at_end_vpos
15088 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15089 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15090 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15091 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15092 + window_internal_height (w
));
15094 /* Perform the operation on the screen. */
15097 /* Scroll last_unchanged_at_beg_row to the end of the
15098 window down dvpos lines. */
15099 set_terminal_window (f
, end
);
15101 /* On dumb terminals delete dvpos lines at the end
15102 before inserting dvpos empty lines. */
15103 if (!FRAME_SCROLL_REGION_OK (f
))
15104 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15106 /* Insert dvpos empty lines in front of
15107 last_unchanged_at_beg_row. */
15108 ins_del_lines (f
, from
, dvpos
);
15110 else if (dvpos
< 0)
15112 /* Scroll up last_unchanged_at_beg_vpos to the end of
15113 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15114 set_terminal_window (f
, end
);
15116 /* Delete dvpos lines in front of
15117 last_unchanged_at_beg_vpos. ins_del_lines will set
15118 the cursor to the given vpos and emit |dvpos| delete
15120 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15122 /* On a dumb terminal insert dvpos empty lines at the
15124 if (!FRAME_SCROLL_REGION_OK (f
))
15125 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15128 set_terminal_window (f
, 0);
15134 /* Shift reused rows of the current matrix to the right position.
15135 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15137 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15138 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15141 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15142 bottom_vpos
, dvpos
);
15143 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15146 else if (dvpos
> 0)
15148 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15149 bottom_vpos
, dvpos
);
15150 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15151 first_unchanged_at_end_vpos
+ dvpos
, 0);
15154 /* For frame-based redisplay, make sure that current frame and window
15155 matrix are in sync with respect to glyph memory. */
15156 if (!FRAME_WINDOW_P (f
))
15157 sync_frame_with_window_matrix_rows (w
);
15159 /* Adjust buffer positions in reused rows. */
15160 if (delta
|| delta_bytes
)
15161 increment_matrix_positions (current_matrix
,
15162 first_unchanged_at_end_vpos
+ dvpos
,
15163 bottom_vpos
, delta
, delta_bytes
);
15165 /* Adjust Y positions. */
15167 shift_glyph_matrix (w
, current_matrix
,
15168 first_unchanged_at_end_vpos
+ dvpos
,
15171 if (first_unchanged_at_end_row
)
15173 first_unchanged_at_end_row
+= dvpos
;
15174 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15175 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15176 first_unchanged_at_end_row
= NULL
;
15179 /* If scrolling up, there may be some lines to display at the end of
15181 last_text_row_at_end
= NULL
;
15184 /* Scrolling up can leave for example a partially visible line
15185 at the end of the window to be redisplayed. */
15186 /* Set last_row to the glyph row in the current matrix where the
15187 window end line is found. It has been moved up or down in
15188 the matrix by dvpos. */
15189 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15190 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15192 /* If last_row is the window end line, it should display text. */
15193 xassert (last_row
->displays_text_p
);
15195 /* If window end line was partially visible before, begin
15196 displaying at that line. Otherwise begin displaying with the
15197 line following it. */
15198 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15200 init_to_row_start (&it
, w
, last_row
);
15201 it
.vpos
= last_vpos
;
15202 it
.current_y
= last_row
->y
;
15206 init_to_row_end (&it
, w
, last_row
);
15207 it
.vpos
= 1 + last_vpos
;
15208 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15212 /* We may start in a continuation line. If so, we have to
15213 get the right continuation_lines_width and current_x. */
15214 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15215 it
.hpos
= it
.current_x
= 0;
15217 /* Display the rest of the lines at the window end. */
15218 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15219 while (it
.current_y
< it
.last_visible_y
15220 && !fonts_changed_p
)
15222 /* Is it always sure that the display agrees with lines in
15223 the current matrix? I don't think so, so we mark rows
15224 displayed invalid in the current matrix by setting their
15225 enabled_p flag to zero. */
15226 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15227 if (display_line (&it
))
15228 last_text_row_at_end
= it
.glyph_row
- 1;
15232 /* Update window_end_pos and window_end_vpos. */
15233 if (first_unchanged_at_end_row
15234 && !last_text_row_at_end
)
15236 /* Window end line if one of the preserved rows from the current
15237 matrix. Set row to the last row displaying text in current
15238 matrix starting at first_unchanged_at_end_row, after
15240 xassert (first_unchanged_at_end_row
->displays_text_p
);
15241 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15242 first_unchanged_at_end_row
);
15243 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15245 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15246 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15248 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15249 xassert (w
->window_end_bytepos
>= 0);
15250 IF_DEBUG (debug_method_add (w
, "A"));
15252 else if (last_text_row_at_end
)
15255 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15256 w
->window_end_bytepos
15257 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15259 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15260 xassert (w
->window_end_bytepos
>= 0);
15261 IF_DEBUG (debug_method_add (w
, "B"));
15263 else if (last_text_row
)
15265 /* We have displayed either to the end of the window or at the
15266 end of the window, i.e. the last row with text is to be found
15267 in the desired matrix. */
15269 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15270 w
->window_end_bytepos
15271 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15273 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15274 xassert (w
->window_end_bytepos
>= 0);
15276 else if (first_unchanged_at_end_row
== NULL
15277 && last_text_row
== NULL
15278 && last_text_row_at_end
== NULL
)
15280 /* Displayed to end of window, but no line containing text was
15281 displayed. Lines were deleted at the end of the window. */
15282 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15283 int vpos
= XFASTINT (w
->window_end_vpos
);
15284 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15285 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15288 row
== NULL
&& vpos
>= first_vpos
;
15289 --vpos
, --current_row
, --desired_row
)
15291 if (desired_row
->enabled_p
)
15293 if (desired_row
->displays_text_p
)
15296 else if (current_row
->displays_text_p
)
15300 xassert (row
!= NULL
);
15301 w
->window_end_vpos
= make_number (vpos
+ 1);
15302 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15303 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15304 xassert (w
->window_end_bytepos
>= 0);
15305 IF_DEBUG (debug_method_add (w
, "C"));
15310 #if 0 /* This leads to problems, for instance when the cursor is
15311 at ZV, and the cursor line displays no text. */
15312 /* Disable rows below what's displayed in the window. This makes
15313 debugging easier. */
15314 enable_glyph_matrix_rows (current_matrix
,
15315 XFASTINT (w
->window_end_vpos
) + 1,
15319 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15320 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15322 /* Record that display has not been completed. */
15323 w
->window_end_valid
= Qnil
;
15324 w
->desired_matrix
->no_scrolling_p
= 1;
15332 /***********************************************************************
15333 More debugging support
15334 ***********************************************************************/
15338 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15339 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15340 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15343 /* Dump the contents of glyph matrix MATRIX on stderr.
15345 GLYPHS 0 means don't show glyph contents.
15346 GLYPHS 1 means show glyphs in short form
15347 GLYPHS > 1 means show glyphs in long form. */
15350 dump_glyph_matrix (matrix
, glyphs
)
15351 struct glyph_matrix
*matrix
;
15355 for (i
= 0; i
< matrix
->nrows
; ++i
)
15356 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15360 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15361 the glyph row and area where the glyph comes from. */
15364 dump_glyph (row
, glyph
, area
)
15365 struct glyph_row
*row
;
15366 struct glyph
*glyph
;
15369 if (glyph
->type
== CHAR_GLYPH
)
15372 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15373 glyph
- row
->glyphs
[TEXT_AREA
],
15376 (BUFFERP (glyph
->object
)
15378 : (STRINGP (glyph
->object
)
15381 glyph
->pixel_width
,
15383 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15387 glyph
->left_box_line_p
,
15388 glyph
->right_box_line_p
);
15390 else if (glyph
->type
== STRETCH_GLYPH
)
15393 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15394 glyph
- row
->glyphs
[TEXT_AREA
],
15397 (BUFFERP (glyph
->object
)
15399 : (STRINGP (glyph
->object
)
15402 glyph
->pixel_width
,
15406 glyph
->left_box_line_p
,
15407 glyph
->right_box_line_p
);
15409 else if (glyph
->type
== IMAGE_GLYPH
)
15412 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15413 glyph
- row
->glyphs
[TEXT_AREA
],
15416 (BUFFERP (glyph
->object
)
15418 : (STRINGP (glyph
->object
)
15421 glyph
->pixel_width
,
15425 glyph
->left_box_line_p
,
15426 glyph
->right_box_line_p
);
15428 else if (glyph
->type
== COMPOSITE_GLYPH
)
15431 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15432 glyph
- row
->glyphs
[TEXT_AREA
],
15435 (BUFFERP (glyph
->object
)
15437 : (STRINGP (glyph
->object
)
15440 glyph
->pixel_width
,
15444 glyph
->left_box_line_p
,
15445 glyph
->right_box_line_p
);
15450 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15451 GLYPHS 0 means don't show glyph contents.
15452 GLYPHS 1 means show glyphs in short form
15453 GLYPHS > 1 means show glyphs in long form. */
15456 dump_glyph_row (row
, vpos
, glyphs
)
15457 struct glyph_row
*row
;
15462 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15463 fprintf (stderr
, "======================================================================\n");
15465 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15466 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15468 MATRIX_ROW_START_CHARPOS (row
),
15469 MATRIX_ROW_END_CHARPOS (row
),
15470 row
->used
[TEXT_AREA
],
15471 row
->contains_overlapping_glyphs_p
,
15473 row
->truncated_on_left_p
,
15474 row
->truncated_on_right_p
,
15476 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15477 row
->displays_text_p
,
15480 row
->ends_in_middle_of_char_p
,
15481 row
->starts_in_middle_of_char_p
,
15487 row
->visible_height
,
15490 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15491 row
->end
.overlay_string_index
,
15492 row
->continuation_lines_width
);
15493 fprintf (stderr
, "%9d %5d\n",
15494 CHARPOS (row
->start
.string_pos
),
15495 CHARPOS (row
->end
.string_pos
));
15496 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15497 row
->end
.dpvec_index
);
15504 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15506 struct glyph
*glyph
= row
->glyphs
[area
];
15507 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15509 /* Glyph for a line end in text. */
15510 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15513 if (glyph
< glyph_end
)
15514 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15516 for (; glyph
< glyph_end
; ++glyph
)
15517 dump_glyph (row
, glyph
, area
);
15520 else if (glyphs
== 1)
15524 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15526 char *s
= (char *) alloca (row
->used
[area
] + 1);
15529 for (i
= 0; i
< row
->used
[area
]; ++i
)
15531 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15532 if (glyph
->type
== CHAR_GLYPH
15533 && glyph
->u
.ch
< 0x80
15534 && glyph
->u
.ch
>= ' ')
15535 s
[i
] = glyph
->u
.ch
;
15541 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15547 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15548 Sdump_glyph_matrix
, 0, 1, "p",
15549 doc
: /* Dump the current matrix of the selected window to stderr.
15550 Shows contents of glyph row structures. With non-nil
15551 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15552 glyphs in short form, otherwise show glyphs in long form. */)
15554 Lisp_Object glyphs
;
15556 struct window
*w
= XWINDOW (selected_window
);
15557 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15559 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15560 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15561 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15562 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15563 fprintf (stderr
, "=============================================\n");
15564 dump_glyph_matrix (w
->current_matrix
,
15565 NILP (glyphs
) ? 0 : XINT (glyphs
));
15570 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15571 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15574 struct frame
*f
= XFRAME (selected_frame
);
15575 dump_glyph_matrix (f
->current_matrix
, 1);
15580 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15581 doc
: /* Dump glyph row ROW to stderr.
15582 GLYPH 0 means don't dump glyphs.
15583 GLYPH 1 means dump glyphs in short form.
15584 GLYPH > 1 or omitted means dump glyphs in long form. */)
15586 Lisp_Object row
, glyphs
;
15588 struct glyph_matrix
*matrix
;
15591 CHECK_NUMBER (row
);
15592 matrix
= XWINDOW (selected_window
)->current_matrix
;
15594 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15595 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15597 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15602 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15603 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15604 GLYPH 0 means don't dump glyphs.
15605 GLYPH 1 means dump glyphs in short form.
15606 GLYPH > 1 or omitted means dump glyphs in long form. */)
15608 Lisp_Object row
, glyphs
;
15610 struct frame
*sf
= SELECTED_FRAME ();
15611 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15614 CHECK_NUMBER (row
);
15616 if (vpos
>= 0 && vpos
< m
->nrows
)
15617 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15618 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15623 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15624 doc
: /* Toggle tracing of redisplay.
15625 With ARG, turn tracing on if and only if ARG is positive. */)
15630 trace_redisplay_p
= !trace_redisplay_p
;
15633 arg
= Fprefix_numeric_value (arg
);
15634 trace_redisplay_p
= XINT (arg
) > 0;
15641 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15642 doc
: /* Like `format', but print result to stderr.
15643 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15648 Lisp_Object s
= Fformat (nargs
, args
);
15649 fprintf (stderr
, "%s", SDATA (s
));
15653 #endif /* GLYPH_DEBUG */
15657 /***********************************************************************
15658 Building Desired Matrix Rows
15659 ***********************************************************************/
15661 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15662 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15664 static struct glyph_row
*
15665 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15667 Lisp_Object overlay_arrow_string
;
15669 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15670 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15671 struct buffer
*old
= current_buffer
;
15672 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15673 int arrow_len
= SCHARS (overlay_arrow_string
);
15674 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15675 const unsigned char *p
;
15678 int n_glyphs_before
;
15680 set_buffer_temp (buffer
);
15681 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15682 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15683 SET_TEXT_POS (it
.position
, 0, 0);
15685 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15687 while (p
< arrow_end
)
15689 Lisp_Object face
, ilisp
;
15691 /* Get the next character. */
15693 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15695 it
.c
= *p
, it
.len
= 1;
15698 /* Get its face. */
15699 ilisp
= make_number (p
- arrow_string
);
15700 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15701 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15703 /* Compute its width, get its glyphs. */
15704 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15705 SET_TEXT_POS (it
.position
, -1, -1);
15706 PRODUCE_GLYPHS (&it
);
15708 /* If this character doesn't fit any more in the line, we have
15709 to remove some glyphs. */
15710 if (it
.current_x
> it
.last_visible_x
)
15712 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15717 set_buffer_temp (old
);
15718 return it
.glyph_row
;
15722 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15723 glyphs are only inserted for terminal frames since we can't really
15724 win with truncation glyphs when partially visible glyphs are
15725 involved. Which glyphs to insert is determined by
15726 produce_special_glyphs. */
15729 insert_left_trunc_glyphs (it
)
15732 struct it truncate_it
;
15733 struct glyph
*from
, *end
, *to
, *toend
;
15735 xassert (!FRAME_WINDOW_P (it
->f
));
15737 /* Get the truncation glyphs. */
15739 truncate_it
.current_x
= 0;
15740 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15741 truncate_it
.glyph_row
= &scratch_glyph_row
;
15742 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15743 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15744 truncate_it
.object
= make_number (0);
15745 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15747 /* Overwrite glyphs from IT with truncation glyphs. */
15748 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15749 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15750 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15751 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15756 /* There may be padding glyphs left over. Overwrite them too. */
15757 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15759 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15765 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15769 /* Compute the pixel height and width of IT->glyph_row.
15771 Most of the time, ascent and height of a display line will be equal
15772 to the max_ascent and max_height values of the display iterator
15773 structure. This is not the case if
15775 1. We hit ZV without displaying anything. In this case, max_ascent
15776 and max_height will be zero.
15778 2. We have some glyphs that don't contribute to the line height.
15779 (The glyph row flag contributes_to_line_height_p is for future
15780 pixmap extensions).
15782 The first case is easily covered by using default values because in
15783 these cases, the line height does not really matter, except that it
15784 must not be zero. */
15787 compute_line_metrics (it
)
15790 struct glyph_row
*row
= it
->glyph_row
;
15793 if (FRAME_WINDOW_P (it
->f
))
15795 int i
, min_y
, max_y
;
15797 /* The line may consist of one space only, that was added to
15798 place the cursor on it. If so, the row's height hasn't been
15800 if (row
->height
== 0)
15802 if (it
->max_ascent
+ it
->max_descent
== 0)
15803 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15804 row
->ascent
= it
->max_ascent
;
15805 row
->height
= it
->max_ascent
+ it
->max_descent
;
15806 row
->phys_ascent
= it
->max_phys_ascent
;
15807 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15808 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15811 /* Compute the width of this line. */
15812 row
->pixel_width
= row
->x
;
15813 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15814 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15816 xassert (row
->pixel_width
>= 0);
15817 xassert (row
->ascent
>= 0 && row
->height
> 0);
15819 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15820 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15822 /* If first line's physical ascent is larger than its logical
15823 ascent, use the physical ascent, and make the row taller.
15824 This makes accented characters fully visible. */
15825 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15826 && row
->phys_ascent
> row
->ascent
)
15828 row
->height
+= row
->phys_ascent
- row
->ascent
;
15829 row
->ascent
= row
->phys_ascent
;
15832 /* Compute how much of the line is visible. */
15833 row
->visible_height
= row
->height
;
15835 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
15836 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
15838 if (row
->y
< min_y
)
15839 row
->visible_height
-= min_y
- row
->y
;
15840 if (row
->y
+ row
->height
> max_y
)
15841 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15845 row
->pixel_width
= row
->used
[TEXT_AREA
];
15846 if (row
->continued_p
)
15847 row
->pixel_width
-= it
->continuation_pixel_width
;
15848 else if (row
->truncated_on_right_p
)
15849 row
->pixel_width
-= it
->truncation_pixel_width
;
15850 row
->ascent
= row
->phys_ascent
= 0;
15851 row
->height
= row
->phys_height
= row
->visible_height
= 1;
15852 row
->extra_line_spacing
= 0;
15855 /* Compute a hash code for this row. */
15857 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15858 for (i
= 0; i
< row
->used
[area
]; ++i
)
15859 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
15860 + row
->glyphs
[area
][i
].u
.val
15861 + row
->glyphs
[area
][i
].face_id
15862 + row
->glyphs
[area
][i
].padding_p
15863 + (row
->glyphs
[area
][i
].type
<< 2));
15865 it
->max_ascent
= it
->max_descent
= 0;
15866 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
15870 /* Append one space to the glyph row of iterator IT if doing a
15871 window-based redisplay. The space has the same face as
15872 IT->face_id. Value is non-zero if a space was added.
15874 This function is called to make sure that there is always one glyph
15875 at the end of a glyph row that the cursor can be set on under
15876 window-systems. (If there weren't such a glyph we would not know
15877 how wide and tall a box cursor should be displayed).
15879 At the same time this space let's a nicely handle clearing to the
15880 end of the line if the row ends in italic text. */
15883 append_space_for_newline (it
, default_face_p
)
15885 int default_face_p
;
15887 if (FRAME_WINDOW_P (it
->f
))
15889 int n
= it
->glyph_row
->used
[TEXT_AREA
];
15891 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
15892 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
15894 /* Save some values that must not be changed.
15895 Must save IT->c and IT->len because otherwise
15896 ITERATOR_AT_END_P wouldn't work anymore after
15897 append_space_for_newline has been called. */
15898 enum display_element_type saved_what
= it
->what
;
15899 int saved_c
= it
->c
, saved_len
= it
->len
;
15900 int saved_x
= it
->current_x
;
15901 int saved_face_id
= it
->face_id
;
15902 struct text_pos saved_pos
;
15903 Lisp_Object saved_object
;
15906 saved_object
= it
->object
;
15907 saved_pos
= it
->position
;
15909 it
->what
= IT_CHARACTER
;
15910 bzero (&it
->position
, sizeof it
->position
);
15911 it
->object
= make_number (0);
15915 if (default_face_p
)
15916 it
->face_id
= DEFAULT_FACE_ID
;
15917 else if (it
->face_before_selective_p
)
15918 it
->face_id
= it
->saved_face_id
;
15919 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
15920 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
15922 PRODUCE_GLYPHS (it
);
15924 it
->override_ascent
= -1;
15925 it
->constrain_row_ascent_descent_p
= 0;
15926 it
->current_x
= saved_x
;
15927 it
->object
= saved_object
;
15928 it
->position
= saved_pos
;
15929 it
->what
= saved_what
;
15930 it
->face_id
= saved_face_id
;
15931 it
->len
= saved_len
;
15941 /* Extend the face of the last glyph in the text area of IT->glyph_row
15942 to the end of the display line. Called from display_line.
15943 If the glyph row is empty, add a space glyph to it so that we
15944 know the face to draw. Set the glyph row flag fill_line_p. */
15947 extend_face_to_end_of_line (it
)
15951 struct frame
*f
= it
->f
;
15953 /* If line is already filled, do nothing. */
15954 if (it
->current_x
>= it
->last_visible_x
)
15957 /* Face extension extends the background and box of IT->face_id
15958 to the end of the line. If the background equals the background
15959 of the frame, we don't have to do anything. */
15960 if (it
->face_before_selective_p
)
15961 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
15963 face
= FACE_FROM_ID (f
, it
->face_id
);
15965 if (FRAME_WINDOW_P (f
)
15966 && it
->glyph_row
->displays_text_p
15967 && face
->box
== FACE_NO_BOX
15968 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
15972 /* Set the glyph row flag indicating that the face of the last glyph
15973 in the text area has to be drawn to the end of the text area. */
15974 it
->glyph_row
->fill_line_p
= 1;
15976 /* If current character of IT is not ASCII, make sure we have the
15977 ASCII face. This will be automatically undone the next time
15978 get_next_display_element returns a multibyte character. Note
15979 that the character will always be single byte in unibyte text. */
15980 if (!ASCII_CHAR_P (it
->c
))
15982 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
15985 if (FRAME_WINDOW_P (f
))
15987 /* If the row is empty, add a space with the current face of IT,
15988 so that we know which face to draw. */
15989 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
15991 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
15992 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
15993 it
->glyph_row
->used
[TEXT_AREA
] = 1;
15998 /* Save some values that must not be changed. */
15999 int saved_x
= it
->current_x
;
16000 struct text_pos saved_pos
;
16001 Lisp_Object saved_object
;
16002 enum display_element_type saved_what
= it
->what
;
16003 int saved_face_id
= it
->face_id
;
16005 saved_object
= it
->object
;
16006 saved_pos
= it
->position
;
16008 it
->what
= IT_CHARACTER
;
16009 bzero (&it
->position
, sizeof it
->position
);
16010 it
->object
= make_number (0);
16013 it
->face_id
= face
->id
;
16015 PRODUCE_GLYPHS (it
);
16017 while (it
->current_x
<= it
->last_visible_x
)
16018 PRODUCE_GLYPHS (it
);
16020 /* Don't count these blanks really. It would let us insert a left
16021 truncation glyph below and make us set the cursor on them, maybe. */
16022 it
->current_x
= saved_x
;
16023 it
->object
= saved_object
;
16024 it
->position
= saved_pos
;
16025 it
->what
= saved_what
;
16026 it
->face_id
= saved_face_id
;
16031 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16032 trailing whitespace. */
16035 trailing_whitespace_p (charpos
)
16038 int bytepos
= CHAR_TO_BYTE (charpos
);
16041 while (bytepos
< ZV_BYTE
16042 && (c
= FETCH_CHAR (bytepos
),
16043 c
== ' ' || c
== '\t'))
16046 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16048 if (bytepos
!= PT_BYTE
)
16055 /* Highlight trailing whitespace, if any, in ROW. */
16058 highlight_trailing_whitespace (f
, row
)
16060 struct glyph_row
*row
;
16062 int used
= row
->used
[TEXT_AREA
];
16066 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16067 struct glyph
*glyph
= start
+ used
- 1;
16069 /* Skip over glyphs inserted to display the cursor at the
16070 end of a line, for extending the face of the last glyph
16071 to the end of the line on terminals, and for truncation
16072 and continuation glyphs. */
16073 while (glyph
>= start
16074 && glyph
->type
== CHAR_GLYPH
16075 && INTEGERP (glyph
->object
))
16078 /* If last glyph is a space or stretch, and it's trailing
16079 whitespace, set the face of all trailing whitespace glyphs in
16080 IT->glyph_row to `trailing-whitespace'. */
16082 && BUFFERP (glyph
->object
)
16083 && (glyph
->type
== STRETCH_GLYPH
16084 || (glyph
->type
== CHAR_GLYPH
16085 && glyph
->u
.ch
== ' '))
16086 && trailing_whitespace_p (glyph
->charpos
))
16088 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16092 while (glyph
>= start
16093 && BUFFERP (glyph
->object
)
16094 && (glyph
->type
== STRETCH_GLYPH
16095 || (glyph
->type
== CHAR_GLYPH
16096 && glyph
->u
.ch
== ' ')))
16097 (glyph
--)->face_id
= face_id
;
16103 /* Value is non-zero if glyph row ROW in window W should be
16104 used to hold the cursor. */
16107 cursor_row_p (w
, row
)
16109 struct glyph_row
*row
;
16111 int cursor_row_p
= 1;
16113 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16115 /* Suppose the row ends on a string.
16116 Unless the row is continued, that means it ends on a newline
16117 in the string. If it's anything other than a display string
16118 (e.g. a before-string from an overlay), we don't want the
16119 cursor there. (This heuristic seems to give the optimal
16120 behavior for the various types of multi-line strings.) */
16121 if (CHARPOS (row
->end
.string_pos
) >= 0)
16123 if (row
->continued_p
)
16127 /* Check for `display' property. */
16128 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16129 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16130 struct glyph
*glyph
;
16133 for (glyph
= end
; glyph
>= beg
; --glyph
)
16134 if (STRINGP (glyph
->object
))
16137 = Fget_char_property (make_number (PT
),
16141 && display_prop_string_p (prop
, glyph
->object
));
16146 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16148 /* If the row ends in middle of a real character,
16149 and the line is continued, we want the cursor here.
16150 That's because MATRIX_ROW_END_CHARPOS would equal
16151 PT if PT is before the character. */
16152 if (!row
->ends_in_ellipsis_p
)
16153 cursor_row_p
= row
->continued_p
;
16155 /* If the row ends in an ellipsis, then
16156 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16157 We want that position to be displayed after the ellipsis. */
16160 /* If the row ends at ZV, display the cursor at the end of that
16161 row instead of at the start of the row below. */
16162 else if (row
->ends_at_zv_p
)
16168 return cursor_row_p
;
16172 /* Construct the glyph row IT->glyph_row in the desired matrix of
16173 IT->w from text at the current position of IT. See dispextern.h
16174 for an overview of struct it. Value is non-zero if
16175 IT->glyph_row displays text, as opposed to a line displaying ZV
16182 struct glyph_row
*row
= it
->glyph_row
;
16183 Lisp_Object overlay_arrow_string
;
16185 /* We always start displaying at hpos zero even if hscrolled. */
16186 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16188 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16189 >= it
->w
->desired_matrix
->nrows
)
16191 it
->w
->nrows_scale_factor
++;
16192 fonts_changed_p
= 1;
16196 /* Is IT->w showing the region? */
16197 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16199 /* Clear the result glyph row and enable it. */
16200 prepare_desired_row (row
);
16202 row
->y
= it
->current_y
;
16203 row
->start
= it
->start
;
16204 row
->continuation_lines_width
= it
->continuation_lines_width
;
16205 row
->displays_text_p
= 1;
16206 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16207 it
->starts_in_middle_of_char_p
= 0;
16209 /* Arrange the overlays nicely for our purposes. Usually, we call
16210 display_line on only one line at a time, in which case this
16211 can't really hurt too much, or we call it on lines which appear
16212 one after another in the buffer, in which case all calls to
16213 recenter_overlay_lists but the first will be pretty cheap. */
16214 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16216 /* Move over display elements that are not visible because we are
16217 hscrolled. This may stop at an x-position < IT->first_visible_x
16218 if the first glyph is partially visible or if we hit a line end. */
16219 if (it
->current_x
< it
->first_visible_x
)
16221 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16222 MOVE_TO_POS
| MOVE_TO_X
);
16225 /* Get the initial row height. This is either the height of the
16226 text hscrolled, if there is any, or zero. */
16227 row
->ascent
= it
->max_ascent
;
16228 row
->height
= it
->max_ascent
+ it
->max_descent
;
16229 row
->phys_ascent
= it
->max_phys_ascent
;
16230 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16231 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16233 /* Loop generating characters. The loop is left with IT on the next
16234 character to display. */
16237 int n_glyphs_before
, hpos_before
, x_before
;
16239 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16241 /* Retrieve the next thing to display. Value is zero if end of
16243 if (!get_next_display_element (it
))
16245 /* Maybe add a space at the end of this line that is used to
16246 display the cursor there under X. Set the charpos of the
16247 first glyph of blank lines not corresponding to any text
16249 #ifdef HAVE_WINDOW_SYSTEM
16250 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16251 row
->exact_window_width_line_p
= 1;
16253 #endif /* HAVE_WINDOW_SYSTEM */
16254 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16255 || row
->used
[TEXT_AREA
] == 0)
16257 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16258 row
->displays_text_p
= 0;
16260 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16261 && (!MINI_WINDOW_P (it
->w
)
16262 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16263 row
->indicate_empty_line_p
= 1;
16266 it
->continuation_lines_width
= 0;
16267 row
->ends_at_zv_p
= 1;
16271 /* Now, get the metrics of what we want to display. This also
16272 generates glyphs in `row' (which is IT->glyph_row). */
16273 n_glyphs_before
= row
->used
[TEXT_AREA
];
16276 /* Remember the line height so far in case the next element doesn't
16277 fit on the line. */
16278 if (!it
->truncate_lines_p
)
16280 ascent
= it
->max_ascent
;
16281 descent
= it
->max_descent
;
16282 phys_ascent
= it
->max_phys_ascent
;
16283 phys_descent
= it
->max_phys_descent
;
16286 PRODUCE_GLYPHS (it
);
16288 /* If this display element was in marginal areas, continue with
16290 if (it
->area
!= TEXT_AREA
)
16292 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16293 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16294 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16295 row
->phys_height
= max (row
->phys_height
,
16296 it
->max_phys_ascent
+ it
->max_phys_descent
);
16297 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16298 it
->max_extra_line_spacing
);
16299 set_iterator_to_next (it
, 1);
16303 /* Does the display element fit on the line? If we truncate
16304 lines, we should draw past the right edge of the window. If
16305 we don't truncate, we want to stop so that we can display the
16306 continuation glyph before the right margin. If lines are
16307 continued, there are two possible strategies for characters
16308 resulting in more than 1 glyph (e.g. tabs): Display as many
16309 glyphs as possible in this line and leave the rest for the
16310 continuation line, or display the whole element in the next
16311 line. Original redisplay did the former, so we do it also. */
16312 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16313 hpos_before
= it
->hpos
;
16316 if (/* Not a newline. */
16318 /* Glyphs produced fit entirely in the line. */
16319 && it
->current_x
< it
->last_visible_x
)
16321 it
->hpos
+= nglyphs
;
16322 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16323 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16324 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16325 row
->phys_height
= max (row
->phys_height
,
16326 it
->max_phys_ascent
+ it
->max_phys_descent
);
16327 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16328 it
->max_extra_line_spacing
);
16329 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16330 row
->x
= x
- it
->first_visible_x
;
16335 struct glyph
*glyph
;
16337 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16339 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16340 new_x
= x
+ glyph
->pixel_width
;
16342 if (/* Lines are continued. */
16343 !it
->truncate_lines_p
16344 && (/* Glyph doesn't fit on the line. */
16345 new_x
> it
->last_visible_x
16346 /* Or it fits exactly on a window system frame. */
16347 || (new_x
== it
->last_visible_x
16348 && FRAME_WINDOW_P (it
->f
))))
16350 /* End of a continued line. */
16353 || (new_x
== it
->last_visible_x
16354 && FRAME_WINDOW_P (it
->f
)))
16356 /* Current glyph is the only one on the line or
16357 fits exactly on the line. We must continue
16358 the line because we can't draw the cursor
16359 after the glyph. */
16360 row
->continued_p
= 1;
16361 it
->current_x
= new_x
;
16362 it
->continuation_lines_width
+= new_x
;
16364 if (i
== nglyphs
- 1)
16366 set_iterator_to_next (it
, 1);
16367 #ifdef HAVE_WINDOW_SYSTEM
16368 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16370 if (!get_next_display_element (it
))
16372 row
->exact_window_width_line_p
= 1;
16373 it
->continuation_lines_width
= 0;
16374 row
->continued_p
= 0;
16375 row
->ends_at_zv_p
= 1;
16377 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16379 row
->continued_p
= 0;
16380 row
->exact_window_width_line_p
= 1;
16383 #endif /* HAVE_WINDOW_SYSTEM */
16386 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16387 && !FRAME_WINDOW_P (it
->f
))
16389 /* A padding glyph that doesn't fit on this line.
16390 This means the whole character doesn't fit
16392 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16394 /* Fill the rest of the row with continuation
16395 glyphs like in 20.x. */
16396 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16397 < row
->glyphs
[1 + TEXT_AREA
])
16398 produce_special_glyphs (it
, IT_CONTINUATION
);
16400 row
->continued_p
= 1;
16401 it
->current_x
= x_before
;
16402 it
->continuation_lines_width
+= x_before
;
16404 /* Restore the height to what it was before the
16405 element not fitting on the line. */
16406 it
->max_ascent
= ascent
;
16407 it
->max_descent
= descent
;
16408 it
->max_phys_ascent
= phys_ascent
;
16409 it
->max_phys_descent
= phys_descent
;
16411 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16413 /* A TAB that extends past the right edge of the
16414 window. This produces a single glyph on
16415 window system frames. We leave the glyph in
16416 this row and let it fill the row, but don't
16417 consume the TAB. */
16418 it
->continuation_lines_width
+= it
->last_visible_x
;
16419 row
->ends_in_middle_of_char_p
= 1;
16420 row
->continued_p
= 1;
16421 glyph
->pixel_width
= it
->last_visible_x
- x
;
16422 it
->starts_in_middle_of_char_p
= 1;
16426 /* Something other than a TAB that draws past
16427 the right edge of the window. Restore
16428 positions to values before the element. */
16429 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16431 /* Display continuation glyphs. */
16432 if (!FRAME_WINDOW_P (it
->f
))
16433 produce_special_glyphs (it
, IT_CONTINUATION
);
16434 row
->continued_p
= 1;
16436 it
->current_x
= x_before
;
16437 it
->continuation_lines_width
+= x
;
16438 extend_face_to_end_of_line (it
);
16440 if (nglyphs
> 1 && i
> 0)
16442 row
->ends_in_middle_of_char_p
= 1;
16443 it
->starts_in_middle_of_char_p
= 1;
16446 /* Restore the height to what it was before the
16447 element not fitting on the line. */
16448 it
->max_ascent
= ascent
;
16449 it
->max_descent
= descent
;
16450 it
->max_phys_ascent
= phys_ascent
;
16451 it
->max_phys_descent
= phys_descent
;
16456 else if (new_x
> it
->first_visible_x
)
16458 /* Increment number of glyphs actually displayed. */
16461 if (x
< it
->first_visible_x
)
16462 /* Glyph is partially visible, i.e. row starts at
16463 negative X position. */
16464 row
->x
= x
- it
->first_visible_x
;
16468 /* Glyph is completely off the left margin of the
16469 window. This should not happen because of the
16470 move_it_in_display_line at the start of this
16471 function, unless the text display area of the
16472 window is empty. */
16473 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16477 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16478 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16479 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16480 row
->phys_height
= max (row
->phys_height
,
16481 it
->max_phys_ascent
+ it
->max_phys_descent
);
16482 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16483 it
->max_extra_line_spacing
);
16485 /* End of this display line if row is continued. */
16486 if (row
->continued_p
|| row
->ends_at_zv_p
)
16491 /* Is this a line end? If yes, we're also done, after making
16492 sure that a non-default face is extended up to the right
16493 margin of the window. */
16494 if (ITERATOR_AT_END_OF_LINE_P (it
))
16496 int used_before
= row
->used
[TEXT_AREA
];
16498 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16500 #ifdef HAVE_WINDOW_SYSTEM
16501 /* Add a space at the end of the line that is used to
16502 display the cursor there. */
16503 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16504 append_space_for_newline (it
, 0);
16505 #endif /* HAVE_WINDOW_SYSTEM */
16507 /* Extend the face to the end of the line. */
16508 extend_face_to_end_of_line (it
);
16510 /* Make sure we have the position. */
16511 if (used_before
== 0)
16512 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16514 /* Consume the line end. This skips over invisible lines. */
16515 set_iterator_to_next (it
, 1);
16516 it
->continuation_lines_width
= 0;
16520 /* Proceed with next display element. Note that this skips
16521 over lines invisible because of selective display. */
16522 set_iterator_to_next (it
, 1);
16524 /* If we truncate lines, we are done when the last displayed
16525 glyphs reach past the right margin of the window. */
16526 if (it
->truncate_lines_p
16527 && (FRAME_WINDOW_P (it
->f
)
16528 ? (it
->current_x
>= it
->last_visible_x
)
16529 : (it
->current_x
> it
->last_visible_x
)))
16531 /* Maybe add truncation glyphs. */
16532 if (!FRAME_WINDOW_P (it
->f
))
16536 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16537 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16540 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16542 row
->used
[TEXT_AREA
] = i
;
16543 produce_special_glyphs (it
, IT_TRUNCATION
);
16546 #ifdef HAVE_WINDOW_SYSTEM
16549 /* Don't truncate if we can overflow newline into fringe. */
16550 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16552 if (!get_next_display_element (it
))
16554 it
->continuation_lines_width
= 0;
16555 row
->ends_at_zv_p
= 1;
16556 row
->exact_window_width_line_p
= 1;
16559 if (ITERATOR_AT_END_OF_LINE_P (it
))
16561 row
->exact_window_width_line_p
= 1;
16562 goto at_end_of_line
;
16566 #endif /* HAVE_WINDOW_SYSTEM */
16568 row
->truncated_on_right_p
= 1;
16569 it
->continuation_lines_width
= 0;
16570 reseat_at_next_visible_line_start (it
, 0);
16571 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16572 it
->hpos
= hpos_before
;
16573 it
->current_x
= x_before
;
16578 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16579 at the left window margin. */
16580 if (it
->first_visible_x
16581 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16583 if (!FRAME_WINDOW_P (it
->f
))
16584 insert_left_trunc_glyphs (it
);
16585 row
->truncated_on_left_p
= 1;
16588 /* If the start of this line is the overlay arrow-position, then
16589 mark this glyph row as the one containing the overlay arrow.
16590 This is clearly a mess with variable size fonts. It would be
16591 better to let it be displayed like cursors under X. */
16592 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16593 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16594 !NILP (overlay_arrow_string
)))
16596 /* Overlay arrow in window redisplay is a fringe bitmap. */
16597 if (STRINGP (overlay_arrow_string
))
16599 struct glyph_row
*arrow_row
16600 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16601 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16602 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16603 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16604 struct glyph
*p2
, *end
;
16606 /* Copy the arrow glyphs. */
16607 while (glyph
< arrow_end
)
16610 /* Throw away padding glyphs. */
16612 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16613 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16619 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16624 xassert (INTEGERP (overlay_arrow_string
));
16625 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16627 overlay_arrow_seen
= 1;
16630 /* Compute pixel dimensions of this line. */
16631 compute_line_metrics (it
);
16633 /* Remember the position at which this line ends. */
16634 row
->end
= it
->current
;
16636 /* Record whether this row ends inside an ellipsis. */
16637 row
->ends_in_ellipsis_p
16638 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16639 && it
->ellipsis_p
);
16641 /* Save fringe bitmaps in this row. */
16642 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16643 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16644 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16645 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16647 it
->left_user_fringe_bitmap
= 0;
16648 it
->left_user_fringe_face_id
= 0;
16649 it
->right_user_fringe_bitmap
= 0;
16650 it
->right_user_fringe_face_id
= 0;
16652 /* Maybe set the cursor. */
16653 if (it
->w
->cursor
.vpos
< 0
16654 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16655 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16656 && cursor_row_p (it
->w
, row
))
16657 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16659 /* Highlight trailing whitespace. */
16660 if (!NILP (Vshow_trailing_whitespace
))
16661 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16663 /* Prepare for the next line. This line starts horizontally at (X
16664 HPOS) = (0 0). Vertical positions are incremented. As a
16665 convenience for the caller, IT->glyph_row is set to the next
16667 it
->current_x
= it
->hpos
= 0;
16668 it
->current_y
+= row
->height
;
16671 it
->start
= it
->current
;
16672 return row
->displays_text_p
;
16677 /***********************************************************************
16679 ***********************************************************************/
16681 /* Redisplay the menu bar in the frame for window W.
16683 The menu bar of X frames that don't have X toolkit support is
16684 displayed in a special window W->frame->menu_bar_window.
16686 The menu bar of terminal frames is treated specially as far as
16687 glyph matrices are concerned. Menu bar lines are not part of
16688 windows, so the update is done directly on the frame matrix rows
16689 for the menu bar. */
16692 display_menu_bar (w
)
16695 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16700 /* Don't do all this for graphical frames. */
16702 if (FRAME_W32_P (f
))
16705 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
16710 if (FRAME_MAC_P (f
))
16714 #ifdef USE_X_TOOLKIT
16715 xassert (!FRAME_WINDOW_P (f
));
16716 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
16717 it
.first_visible_x
= 0;
16718 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16719 #else /* not USE_X_TOOLKIT */
16720 if (FRAME_WINDOW_P (f
))
16722 /* Menu bar lines are displayed in the desired matrix of the
16723 dummy window menu_bar_window. */
16724 struct window
*menu_w
;
16725 xassert (WINDOWP (f
->menu_bar_window
));
16726 menu_w
= XWINDOW (f
->menu_bar_window
);
16727 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
16729 it
.first_visible_x
= 0;
16730 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16734 /* This is a TTY frame, i.e. character hpos/vpos are used as
16736 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
16738 it
.first_visible_x
= 0;
16739 it
.last_visible_x
= FRAME_COLS (f
);
16741 #endif /* not USE_X_TOOLKIT */
16743 if (! mode_line_inverse_video
)
16744 /* Force the menu-bar to be displayed in the default face. */
16745 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16747 /* Clear all rows of the menu bar. */
16748 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
16750 struct glyph_row
*row
= it
.glyph_row
+ i
;
16751 clear_glyph_row (row
);
16752 row
->enabled_p
= 1;
16753 row
->full_width_p
= 1;
16756 /* Display all items of the menu bar. */
16757 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
16758 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
16760 Lisp_Object string
;
16762 /* Stop at nil string. */
16763 string
= AREF (items
, i
+ 1);
16767 /* Remember where item was displayed. */
16768 ASET (items
, i
+ 3, make_number (it
.hpos
));
16770 /* Display the item, pad with one space. */
16771 if (it
.current_x
< it
.last_visible_x
)
16772 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
16773 SCHARS (string
) + 1, 0, 0, -1);
16776 /* Fill out the line with spaces. */
16777 if (it
.current_x
< it
.last_visible_x
)
16778 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
16780 /* Compute the total height of the lines. */
16781 compute_line_metrics (&it
);
16786 /***********************************************************************
16788 ***********************************************************************/
16790 /* Redisplay mode lines in the window tree whose root is WINDOW. If
16791 FORCE is non-zero, redisplay mode lines unconditionally.
16792 Otherwise, redisplay only mode lines that are garbaged. Value is
16793 the number of windows whose mode lines were redisplayed. */
16796 redisplay_mode_lines (window
, force
)
16797 Lisp_Object window
;
16802 while (!NILP (window
))
16804 struct window
*w
= XWINDOW (window
);
16806 if (WINDOWP (w
->hchild
))
16807 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
16808 else if (WINDOWP (w
->vchild
))
16809 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
16811 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
16812 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
16814 struct text_pos lpoint
;
16815 struct buffer
*old
= current_buffer
;
16817 /* Set the window's buffer for the mode line display. */
16818 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16819 set_buffer_internal_1 (XBUFFER (w
->buffer
));
16821 /* Point refers normally to the selected window. For any
16822 other window, set up appropriate value. */
16823 if (!EQ (window
, selected_window
))
16825 struct text_pos pt
;
16827 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
16828 if (CHARPOS (pt
) < BEGV
)
16829 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16830 else if (CHARPOS (pt
) > (ZV
- 1))
16831 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
16833 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
16836 /* Display mode lines. */
16837 clear_glyph_matrix (w
->desired_matrix
);
16838 if (display_mode_lines (w
))
16841 w
->must_be_updated_p
= 1;
16844 /* Restore old settings. */
16845 set_buffer_internal_1 (old
);
16846 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16856 /* Display the mode and/or top line of window W. Value is the number
16857 of mode lines displayed. */
16860 display_mode_lines (w
)
16863 Lisp_Object old_selected_window
, old_selected_frame
;
16866 old_selected_frame
= selected_frame
;
16867 selected_frame
= w
->frame
;
16868 old_selected_window
= selected_window
;
16869 XSETWINDOW (selected_window
, w
);
16871 /* These will be set while the mode line specs are processed. */
16872 line_number_displayed
= 0;
16873 w
->column_number_displayed
= Qnil
;
16875 if (WINDOW_WANTS_MODELINE_P (w
))
16877 struct window
*sel_w
= XWINDOW (old_selected_window
);
16879 /* Select mode line face based on the real selected window. */
16880 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
16881 current_buffer
->mode_line_format
);
16885 if (WINDOW_WANTS_HEADER_LINE_P (w
))
16887 display_mode_line (w
, HEADER_LINE_FACE_ID
,
16888 current_buffer
->header_line_format
);
16892 selected_frame
= old_selected_frame
;
16893 selected_window
= old_selected_window
;
16898 /* Display mode or top line of window W. FACE_ID specifies which line
16899 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
16900 FORMAT is the mode line format to display. Value is the pixel
16901 height of the mode line displayed. */
16904 display_mode_line (w
, face_id
, format
)
16906 enum face_id face_id
;
16907 Lisp_Object format
;
16911 int count
= SPECPDL_INDEX ();
16913 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
16914 /* Don't extend on a previously drawn mode-line.
16915 This may happen if called from pos_visible_p. */
16916 it
.glyph_row
->enabled_p
= 0;
16917 prepare_desired_row (it
.glyph_row
);
16919 it
.glyph_row
->mode_line_p
= 1;
16921 if (! mode_line_inverse_video
)
16922 /* Force the mode-line to be displayed in the default face. */
16923 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16925 record_unwind_protect (unwind_format_mode_line
,
16926 format_mode_line_unwind_data (NULL
, 0));
16928 mode_line_target
= MODE_LINE_DISPLAY
;
16930 /* Temporarily make frame's keyboard the current kboard so that
16931 kboard-local variables in the mode_line_format will get the right
16933 push_kboard (FRAME_KBOARD (it
.f
));
16934 record_unwind_save_match_data ();
16935 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
16938 unbind_to (count
, Qnil
);
16940 /* Fill up with spaces. */
16941 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
16943 compute_line_metrics (&it
);
16944 it
.glyph_row
->full_width_p
= 1;
16945 it
.glyph_row
->continued_p
= 0;
16946 it
.glyph_row
->truncated_on_left_p
= 0;
16947 it
.glyph_row
->truncated_on_right_p
= 0;
16949 /* Make a 3D mode-line have a shadow at its right end. */
16950 face
= FACE_FROM_ID (it
.f
, face_id
);
16951 extend_face_to_end_of_line (&it
);
16952 if (face
->box
!= FACE_NO_BOX
)
16954 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
16955 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
16956 last
->right_box_line_p
= 1;
16959 return it
.glyph_row
->height
;
16962 /* Move element ELT in LIST to the front of LIST.
16963 Return the updated list. */
16966 move_elt_to_front (elt
, list
)
16967 Lisp_Object elt
, list
;
16969 register Lisp_Object tail
, prev
;
16970 register Lisp_Object tem
;
16974 while (CONSP (tail
))
16980 /* Splice out the link TAIL. */
16982 list
= XCDR (tail
);
16984 Fsetcdr (prev
, XCDR (tail
));
16986 /* Now make it the first. */
16987 Fsetcdr (tail
, list
);
16992 tail
= XCDR (tail
);
16996 /* Not found--return unchanged LIST. */
17000 /* Contribute ELT to the mode line for window IT->w. How it
17001 translates into text depends on its data type.
17003 IT describes the display environment in which we display, as usual.
17005 DEPTH is the depth in recursion. It is used to prevent
17006 infinite recursion here.
17008 FIELD_WIDTH is the number of characters the display of ELT should
17009 occupy in the mode line, and PRECISION is the maximum number of
17010 characters to display from ELT's representation. See
17011 display_string for details.
17013 Returns the hpos of the end of the text generated by ELT.
17015 PROPS is a property list to add to any string we encounter.
17017 If RISKY is nonzero, remove (disregard) any properties in any string
17018 we encounter, and ignore :eval and :propertize.
17020 The global variable `mode_line_target' determines whether the
17021 output is passed to `store_mode_line_noprop',
17022 `store_mode_line_string', or `display_string'. */
17025 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17028 int field_width
, precision
;
17029 Lisp_Object elt
, props
;
17032 int n
= 0, field
, prec
;
17037 elt
= build_string ("*too-deep*");
17041 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17045 /* A string: output it and check for %-constructs within it. */
17049 if (SCHARS (elt
) > 0
17050 && (!NILP (props
) || risky
))
17052 Lisp_Object oprops
, aelt
;
17053 oprops
= Ftext_properties_at (make_number (0), elt
);
17055 /* If the starting string's properties are not what
17056 we want, translate the string. Also, if the string
17057 is risky, do that anyway. */
17059 if (NILP (Fequal (props
, oprops
)) || risky
)
17061 /* If the starting string has properties,
17062 merge the specified ones onto the existing ones. */
17063 if (! NILP (oprops
) && !risky
)
17067 oprops
= Fcopy_sequence (oprops
);
17069 while (CONSP (tem
))
17071 oprops
= Fplist_put (oprops
, XCAR (tem
),
17072 XCAR (XCDR (tem
)));
17073 tem
= XCDR (XCDR (tem
));
17078 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17079 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17081 /* AELT is what we want. Move it to the front
17082 without consing. */
17084 mode_line_proptrans_alist
17085 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17091 /* If AELT has the wrong props, it is useless.
17092 so get rid of it. */
17094 mode_line_proptrans_alist
17095 = Fdelq (aelt
, mode_line_proptrans_alist
);
17097 elt
= Fcopy_sequence (elt
);
17098 Fset_text_properties (make_number (0), Flength (elt
),
17100 /* Add this item to mode_line_proptrans_alist. */
17101 mode_line_proptrans_alist
17102 = Fcons (Fcons (elt
, props
),
17103 mode_line_proptrans_alist
);
17104 /* Truncate mode_line_proptrans_alist
17105 to at most 50 elements. */
17106 tem
= Fnthcdr (make_number (50),
17107 mode_line_proptrans_alist
);
17109 XSETCDR (tem
, Qnil
);
17118 prec
= precision
- n
;
17119 switch (mode_line_target
)
17121 case MODE_LINE_NOPROP
:
17122 case MODE_LINE_TITLE
:
17123 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17125 case MODE_LINE_STRING
:
17126 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17128 case MODE_LINE_DISPLAY
:
17129 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17130 0, prec
, 0, STRING_MULTIBYTE (elt
));
17137 /* Handle the non-literal case. */
17139 while ((precision
<= 0 || n
< precision
)
17140 && SREF (elt
, offset
) != 0
17141 && (mode_line_target
!= MODE_LINE_DISPLAY
17142 || it
->current_x
< it
->last_visible_x
))
17144 int last_offset
= offset
;
17146 /* Advance to end of string or next format specifier. */
17147 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17150 if (offset
- 1 != last_offset
)
17152 int nchars
, nbytes
;
17154 /* Output to end of string or up to '%'. Field width
17155 is length of string. Don't output more than
17156 PRECISION allows us. */
17159 prec
= c_string_width (SDATA (elt
) + last_offset
,
17160 offset
- last_offset
, precision
- n
,
17163 switch (mode_line_target
)
17165 case MODE_LINE_NOPROP
:
17166 case MODE_LINE_TITLE
:
17167 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17169 case MODE_LINE_STRING
:
17171 int bytepos
= last_offset
;
17172 int charpos
= string_byte_to_char (elt
, bytepos
);
17173 int endpos
= (precision
<= 0
17174 ? string_byte_to_char (elt
, offset
)
17175 : charpos
+ nchars
);
17177 n
+= store_mode_line_string (NULL
,
17178 Fsubstring (elt
, make_number (charpos
),
17179 make_number (endpos
)),
17183 case MODE_LINE_DISPLAY
:
17185 int bytepos
= last_offset
;
17186 int charpos
= string_byte_to_char (elt
, bytepos
);
17188 if (precision
<= 0)
17189 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17190 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17192 STRING_MULTIBYTE (elt
));
17197 else /* c == '%' */
17199 int percent_position
= offset
;
17201 /* Get the specified minimum width. Zero means
17204 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17205 field
= field
* 10 + c
- '0';
17207 /* Don't pad beyond the total padding allowed. */
17208 if (field_width
- n
> 0 && field
> field_width
- n
)
17209 field
= field_width
- n
;
17211 /* Note that either PRECISION <= 0 or N < PRECISION. */
17212 prec
= precision
- n
;
17215 n
+= display_mode_element (it
, depth
, field
, prec
,
17216 Vglobal_mode_string
, props
,
17221 int bytepos
, charpos
;
17222 unsigned char *spec
;
17223 Lisp_Object string
;
17225 bytepos
= percent_position
;
17226 charpos
= (STRING_MULTIBYTE (elt
)
17227 ? string_byte_to_char (elt
, bytepos
)
17229 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
,
17232 switch (mode_line_target
)
17234 case MODE_LINE_NOPROP
:
17235 case MODE_LINE_TITLE
:
17236 n
+= store_mode_line_noprop (spec
, field
, prec
);
17238 case MODE_LINE_STRING
:
17242 int len
= strlen (spec
);
17243 string
= make_string (spec
, len
);
17245 props
= Ftext_properties_at (make_number (charpos
), elt
);
17246 /* Should only keep face property in props */
17247 n
+= store_mode_line_string (NULL
, string
, 0, field
, prec
, props
);
17250 case MODE_LINE_DISPLAY
:
17252 int nglyphs_before
, nwritten
;
17254 if (STRINGP (string
))
17256 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17257 nwritten
= display_string (spec
, string
, elt
,
17262 /* Assign to the glyphs written above the
17263 string where the `%x' came from, position
17267 struct glyph
*glyph
17268 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17272 for (i
= 0; i
< nwritten
; ++i
)
17274 glyph
[i
].object
= elt
;
17275 glyph
[i
].charpos
= charpos
;
17292 /* A symbol: process the value of the symbol recursively
17293 as if it appeared here directly. Avoid error if symbol void.
17294 Special case: if value of symbol is a string, output the string
17297 register Lisp_Object tem
;
17299 /* If the variable is not marked as risky to set
17300 then its contents are risky to use. */
17301 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17304 tem
= Fboundp (elt
);
17307 tem
= Fsymbol_value (elt
);
17308 /* If value is a string, output that string literally:
17309 don't check for % within it. */
17313 if (!EQ (tem
, elt
))
17315 /* Give up right away for nil or t. */
17325 register Lisp_Object car
, tem
;
17327 /* A cons cell: five distinct cases.
17328 If first element is :eval or :propertize, do something special.
17329 If first element is a string or a cons, process all the elements
17330 and effectively concatenate them.
17331 If first element is a negative number, truncate displaying cdr to
17332 at most that many characters. If positive, pad (with spaces)
17333 to at least that many characters.
17334 If first element is a symbol, process the cadr or caddr recursively
17335 according to whether the symbol's value is non-nil or nil. */
17337 if (EQ (car
, QCeval
))
17339 /* An element of the form (:eval FORM) means evaluate FORM
17340 and use the result as mode line elements. */
17345 if (CONSP (XCDR (elt
)))
17348 spec
= safe_eval (XCAR (XCDR (elt
)));
17349 n
+= display_mode_element (it
, depth
, field_width
- n
,
17350 precision
- n
, spec
, props
,
17354 else if (EQ (car
, QCpropertize
))
17356 /* An element of the form (:propertize ELT PROPS...)
17357 means display ELT but applying properties PROPS. */
17362 if (CONSP (XCDR (elt
)))
17363 n
+= display_mode_element (it
, depth
, field_width
- n
,
17364 precision
- n
, XCAR (XCDR (elt
)),
17365 XCDR (XCDR (elt
)), risky
);
17367 else if (SYMBOLP (car
))
17369 tem
= Fboundp (car
);
17373 /* elt is now the cdr, and we know it is a cons cell.
17374 Use its car if CAR has a non-nil value. */
17377 tem
= Fsymbol_value (car
);
17384 /* Symbol's value is nil (or symbol is unbound)
17385 Get the cddr of the original list
17386 and if possible find the caddr and use that. */
17390 else if (!CONSP (elt
))
17395 else if (INTEGERP (car
))
17397 register int lim
= XINT (car
);
17401 /* Negative int means reduce maximum width. */
17402 if (precision
<= 0)
17405 precision
= min (precision
, -lim
);
17409 /* Padding specified. Don't let it be more than
17410 current maximum. */
17412 lim
= min (precision
, lim
);
17414 /* If that's more padding than already wanted, queue it.
17415 But don't reduce padding already specified even if
17416 that is beyond the current truncation point. */
17417 field_width
= max (lim
, field_width
);
17421 else if (STRINGP (car
) || CONSP (car
))
17423 register int limit
= 50;
17424 /* Limit is to protect against circular lists. */
17427 && (precision
<= 0 || n
< precision
))
17429 n
+= display_mode_element (it
, depth
,
17430 /* Do padding only after the last
17431 element in the list. */
17432 (! CONSP (XCDR (elt
))
17435 precision
- n
, XCAR (elt
),
17445 elt
= build_string ("*invalid*");
17449 /* Pad to FIELD_WIDTH. */
17450 if (field_width
> 0 && n
< field_width
)
17452 switch (mode_line_target
)
17454 case MODE_LINE_NOPROP
:
17455 case MODE_LINE_TITLE
:
17456 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17458 case MODE_LINE_STRING
:
17459 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17461 case MODE_LINE_DISPLAY
:
17462 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17471 /* Store a mode-line string element in mode_line_string_list.
17473 If STRING is non-null, display that C string. Otherwise, the Lisp
17474 string LISP_STRING is displayed.
17476 FIELD_WIDTH is the minimum number of output glyphs to produce.
17477 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17478 with spaces. FIELD_WIDTH <= 0 means don't pad.
17480 PRECISION is the maximum number of characters to output from
17481 STRING. PRECISION <= 0 means don't truncate the string.
17483 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17484 properties to the string.
17486 PROPS are the properties to add to the string.
17487 The mode_line_string_face face property is always added to the string.
17491 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17493 Lisp_Object lisp_string
;
17502 if (string
!= NULL
)
17504 len
= strlen (string
);
17505 if (precision
> 0 && len
> precision
)
17507 lisp_string
= make_string (string
, len
);
17509 props
= mode_line_string_face_prop
;
17510 else if (!NILP (mode_line_string_face
))
17512 Lisp_Object face
= Fplist_get (props
, Qface
);
17513 props
= Fcopy_sequence (props
);
17515 face
= mode_line_string_face
;
17517 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17518 props
= Fplist_put (props
, Qface
, face
);
17520 Fadd_text_properties (make_number (0), make_number (len
),
17521 props
, lisp_string
);
17525 len
= XFASTINT (Flength (lisp_string
));
17526 if (precision
> 0 && len
> precision
)
17529 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17532 if (!NILP (mode_line_string_face
))
17536 props
= Ftext_properties_at (make_number (0), lisp_string
);
17537 face
= Fplist_get (props
, Qface
);
17539 face
= mode_line_string_face
;
17541 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17542 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17544 lisp_string
= Fcopy_sequence (lisp_string
);
17547 Fadd_text_properties (make_number (0), make_number (len
),
17548 props
, lisp_string
);
17553 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17557 if (field_width
> len
)
17559 field_width
-= len
;
17560 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17562 Fadd_text_properties (make_number (0), make_number (field_width
),
17563 props
, lisp_string
);
17564 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17572 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17574 doc
: /* Format a string out of a mode line format specification.
17575 First arg FORMAT specifies the mode line format (see `mode-line-format'
17576 for details) to use.
17578 Optional second arg FACE specifies the face property to put
17579 on all characters for which no face is specified.
17580 The value t means whatever face the window's mode line currently uses
17581 \(either `mode-line' or `mode-line-inactive', depending).
17582 A value of nil means the default is no face property.
17583 If FACE is an integer, the value string has no text properties.
17585 Optional third and fourth args WINDOW and BUFFER specify the window
17586 and buffer to use as the context for the formatting (defaults
17587 are the selected window and the window's buffer). */)
17588 (format
, face
, window
, buffer
)
17589 Lisp_Object format
, face
, window
, buffer
;
17594 struct buffer
*old_buffer
= NULL
;
17596 int no_props
= INTEGERP (face
);
17597 int count
= SPECPDL_INDEX ();
17599 int string_start
= 0;
17602 window
= selected_window
;
17603 CHECK_WINDOW (window
);
17604 w
= XWINDOW (window
);
17607 buffer
= w
->buffer
;
17608 CHECK_BUFFER (buffer
);
17610 /* Make formatting the modeline a non-op when noninteractive, otherwise
17611 there will be problems later caused by a partially initialized frame. */
17612 if (NILP (format
) || noninteractive
)
17613 return empty_unibyte_string
;
17621 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17622 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17626 face_id
= DEFAULT_FACE_ID
;
17628 if (XBUFFER (buffer
) != current_buffer
)
17629 old_buffer
= current_buffer
;
17631 /* Save things including mode_line_proptrans_alist,
17632 and set that to nil so that we don't alter the outer value. */
17633 record_unwind_protect (unwind_format_mode_line
,
17634 format_mode_line_unwind_data (old_buffer
, 1));
17635 mode_line_proptrans_alist
= Qnil
;
17638 set_buffer_internal_1 (XBUFFER (buffer
));
17640 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17644 mode_line_target
= MODE_LINE_NOPROP
;
17645 mode_line_string_face_prop
= Qnil
;
17646 mode_line_string_list
= Qnil
;
17647 string_start
= MODE_LINE_NOPROP_LEN (0);
17651 mode_line_target
= MODE_LINE_STRING
;
17652 mode_line_string_list
= Qnil
;
17653 mode_line_string_face
= face
;
17654 mode_line_string_face_prop
17655 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17658 push_kboard (FRAME_KBOARD (it
.f
));
17659 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17664 len
= MODE_LINE_NOPROP_LEN (string_start
);
17665 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17669 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17670 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17671 empty_unibyte_string
);
17674 unbind_to (count
, Qnil
);
17678 /* Write a null-terminated, right justified decimal representation of
17679 the positive integer D to BUF using a minimal field width WIDTH. */
17682 pint2str (buf
, width
, d
)
17683 register char *buf
;
17684 register int width
;
17687 register char *p
= buf
;
17695 *p
++ = d
% 10 + '0';
17700 for (width
-= (int) (p
- buf
); width
> 0; --width
)
17711 /* Write a null-terminated, right justified decimal and "human
17712 readable" representation of the nonnegative integer D to BUF using
17713 a minimal field width WIDTH. D should be smaller than 999.5e24. */
17715 static const char power_letter
[] =
17729 pint2hrstr (buf
, width
, d
)
17734 /* We aim to represent the nonnegative integer D as
17735 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
17738 /* -1 means: do not use TENTHS. */
17742 /* Length of QUOTIENT.TENTHS as a string. */
17748 if (1000 <= quotient
)
17750 /* Scale to the appropriate EXPONENT. */
17753 remainder
= quotient
% 1000;
17757 while (1000 <= quotient
);
17759 /* Round to nearest and decide whether to use TENTHS or not. */
17762 tenths
= remainder
/ 100;
17763 if (50 <= remainder
% 100)
17770 if (quotient
== 10)
17778 if (500 <= remainder
)
17780 if (quotient
< 999)
17791 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
17792 if (tenths
== -1 && quotient
<= 99)
17799 p
= psuffix
= buf
+ max (width
, length
);
17801 /* Print EXPONENT. */
17803 *psuffix
++ = power_letter
[exponent
];
17806 /* Print TENTHS. */
17809 *--p
= '0' + tenths
;
17813 /* Print QUOTIENT. */
17816 int digit
= quotient
% 10;
17817 *--p
= '0' + digit
;
17819 while ((quotient
/= 10) != 0);
17821 /* Print leading spaces. */
17826 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
17827 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
17828 type of CODING_SYSTEM. Return updated pointer into BUF. */
17830 static unsigned char invalid_eol_type
[] = "(*invalid*)";
17833 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
17834 Lisp_Object coding_system
;
17835 register char *buf
;
17839 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
17840 const unsigned char *eol_str
;
17842 /* The EOL conversion we are using. */
17843 Lisp_Object eoltype
;
17845 val
= CODING_SYSTEM_SPEC (coding_system
);
17848 if (!VECTORP (val
)) /* Not yet decided. */
17853 eoltype
= eol_mnemonic_undecided
;
17854 /* Don't mention EOL conversion if it isn't decided. */
17859 Lisp_Object eolvalue
;
17861 attrs
= AREF (val
, 0);
17862 eolvalue
= AREF (val
, 2);
17865 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
17869 /* The EOL conversion that is normal on this system. */
17871 if (NILP (eolvalue
)) /* Not yet decided. */
17872 eoltype
= eol_mnemonic_undecided
;
17873 else if (VECTORP (eolvalue
)) /* Not yet decided. */
17874 eoltype
= eol_mnemonic_undecided
;
17875 else /* eolvalue is Qunix, Qdos, or Qmac. */
17876 eoltype
= (EQ (eolvalue
, Qunix
)
17877 ? eol_mnemonic_unix
17878 : (EQ (eolvalue
, Qdos
) == 1
17879 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
17885 /* Mention the EOL conversion if it is not the usual one. */
17886 if (STRINGP (eoltype
))
17888 eol_str
= SDATA (eoltype
);
17889 eol_str_len
= SBYTES (eoltype
);
17891 else if (CHARACTERP (eoltype
))
17893 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
17894 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
17899 eol_str
= invalid_eol_type
;
17900 eol_str_len
= sizeof (invalid_eol_type
) - 1;
17902 bcopy (eol_str
, buf
, eol_str_len
);
17903 buf
+= eol_str_len
;
17909 /* Return a string for the output of a mode line %-spec for window W,
17910 generated by character C. PRECISION >= 0 means don't return a
17911 string longer than that value. FIELD_WIDTH > 0 means pad the
17912 string returned with spaces to that value. Return 1 in *MULTIBYTE
17913 if the result is multibyte text.
17915 Note we operate on the current buffer for most purposes,
17916 the exception being w->base_line_pos. */
17918 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
17921 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
, string
)
17924 int field_width
, precision
;
17926 Lisp_Object
*string
;
17929 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17930 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
17931 struct buffer
*b
= current_buffer
;
17933 *string
= obj
= Qnil
;
17939 if (!NILP (b
->read_only
))
17941 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17946 /* This differs from %* only for a modified read-only buffer. */
17947 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17949 if (!NILP (b
->read_only
))
17954 /* This differs from %* in ignoring read-only-ness. */
17955 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17967 if (command_loop_level
> 5)
17969 p
= decode_mode_spec_buf
;
17970 for (i
= 0; i
< command_loop_level
; i
++)
17973 return decode_mode_spec_buf
;
17981 if (command_loop_level
> 5)
17983 p
= decode_mode_spec_buf
;
17984 for (i
= 0; i
< command_loop_level
; i
++)
17987 return decode_mode_spec_buf
;
17994 /* Let lots_of_dashes be a string of infinite length. */
17995 if (mode_line_target
== MODE_LINE_NOPROP
||
17996 mode_line_target
== MODE_LINE_STRING
)
17998 if (field_width
<= 0
17999 || field_width
> sizeof (lots_of_dashes
))
18001 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18002 decode_mode_spec_buf
[i
] = '-';
18003 decode_mode_spec_buf
[i
] = '\0';
18004 return decode_mode_spec_buf
;
18007 return lots_of_dashes
;
18015 /* %c and %l are ignored in `frame-title-format'.
18016 (In redisplay_internal, the frame title is drawn _before_ the
18017 windows are updated, so the stuff which depends on actual
18018 window contents (such as %l) may fail to render properly, or
18019 even crash emacs.) */
18020 if (mode_line_target
== MODE_LINE_TITLE
)
18024 int col
= (int) current_column (); /* iftc */
18025 w
->column_number_displayed
= make_number (col
);
18026 pint2str (decode_mode_spec_buf
, field_width
, col
);
18027 return decode_mode_spec_buf
;
18031 #ifndef SYSTEM_MALLOC
18033 if (NILP (Vmemory_full
))
18036 return "!MEM FULL! ";
18043 /* %F displays the frame name. */
18044 if (!NILP (f
->title
))
18045 return (char *) SDATA (f
->title
);
18046 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18047 return (char *) SDATA (f
->name
);
18056 int size
= ZV
- BEGV
;
18057 pint2str (decode_mode_spec_buf
, field_width
, size
);
18058 return decode_mode_spec_buf
;
18063 int size
= ZV
- BEGV
;
18064 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18065 return decode_mode_spec_buf
;
18070 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18071 int topline
, nlines
, junk
, height
;
18073 /* %c and %l are ignored in `frame-title-format'. */
18074 if (mode_line_target
== MODE_LINE_TITLE
)
18077 startpos
= XMARKER (w
->start
)->charpos
;
18078 startpos_byte
= marker_byte_position (w
->start
);
18079 height
= WINDOW_TOTAL_LINES (w
);
18081 /* If we decided that this buffer isn't suitable for line numbers,
18082 don't forget that too fast. */
18083 if (EQ (w
->base_line_pos
, w
->buffer
))
18085 /* But do forget it, if the window shows a different buffer now. */
18086 else if (BUFFERP (w
->base_line_pos
))
18087 w
->base_line_pos
= Qnil
;
18089 /* If the buffer is very big, don't waste time. */
18090 if (INTEGERP (Vline_number_display_limit
)
18091 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18093 w
->base_line_pos
= Qnil
;
18094 w
->base_line_number
= Qnil
;
18098 if (INTEGERP (w
->base_line_number
)
18099 && INTEGERP (w
->base_line_pos
)
18100 && XFASTINT (w
->base_line_pos
) <= startpos
)
18102 line
= XFASTINT (w
->base_line_number
);
18103 linepos
= XFASTINT (w
->base_line_pos
);
18104 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18109 linepos
= BUF_BEGV (b
);
18110 linepos_byte
= BUF_BEGV_BYTE (b
);
18113 /* Count lines from base line to window start position. */
18114 nlines
= display_count_lines (linepos
, linepos_byte
,
18118 topline
= nlines
+ line
;
18120 /* Determine a new base line, if the old one is too close
18121 or too far away, or if we did not have one.
18122 "Too close" means it's plausible a scroll-down would
18123 go back past it. */
18124 if (startpos
== BUF_BEGV (b
))
18126 w
->base_line_number
= make_number (topline
);
18127 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18129 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18130 || linepos
== BUF_BEGV (b
))
18132 int limit
= BUF_BEGV (b
);
18133 int limit_byte
= BUF_BEGV_BYTE (b
);
18135 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18137 if (startpos
- distance
> limit
)
18139 limit
= startpos
- distance
;
18140 limit_byte
= CHAR_TO_BYTE (limit
);
18143 nlines
= display_count_lines (startpos
, startpos_byte
,
18145 - (height
* 2 + 30),
18147 /* If we couldn't find the lines we wanted within
18148 line_number_display_limit_width chars per line,
18149 give up on line numbers for this window. */
18150 if (position
== limit_byte
&& limit
== startpos
- distance
)
18152 w
->base_line_pos
= w
->buffer
;
18153 w
->base_line_number
= Qnil
;
18157 w
->base_line_number
= make_number (topline
- nlines
);
18158 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18161 /* Now count lines from the start pos to point. */
18162 nlines
= display_count_lines (startpos
, startpos_byte
,
18163 PT_BYTE
, PT
, &junk
);
18165 /* Record that we did display the line number. */
18166 line_number_displayed
= 1;
18168 /* Make the string to show. */
18169 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18170 return decode_mode_spec_buf
;
18173 char* p
= decode_mode_spec_buf
;
18174 int pad
= field_width
- 2;
18180 return decode_mode_spec_buf
;
18186 obj
= b
->mode_name
;
18190 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18196 int pos
= marker_position (w
->start
);
18197 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18199 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18201 if (pos
<= BUF_BEGV (b
))
18206 else if (pos
<= BUF_BEGV (b
))
18210 if (total
> 1000000)
18211 /* Do it differently for a large value, to avoid overflow. */
18212 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18214 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18215 /* We can't normally display a 3-digit number,
18216 so get us a 2-digit number that is close. */
18219 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18220 return decode_mode_spec_buf
;
18224 /* Display percentage of size above the bottom of the screen. */
18227 int toppos
= marker_position (w
->start
);
18228 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18229 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18231 if (botpos
>= BUF_ZV (b
))
18233 if (toppos
<= BUF_BEGV (b
))
18240 if (total
> 1000000)
18241 /* Do it differently for a large value, to avoid overflow. */
18242 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18244 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18245 /* We can't normally display a 3-digit number,
18246 so get us a 2-digit number that is close. */
18249 if (toppos
<= BUF_BEGV (b
))
18250 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18252 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18253 return decode_mode_spec_buf
;
18258 /* status of process */
18259 obj
= Fget_buffer_process (Fcurrent_buffer ());
18261 return "no process";
18262 #ifdef subprocesses
18263 obj
= Fsymbol_name (Fprocess_status (obj
));
18270 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18277 case 't': /* indicate TEXT or BINARY */
18278 #ifdef MODE_LINE_BINARY_TEXT
18279 return MODE_LINE_BINARY_TEXT (b
);
18285 /* coding-system (not including end-of-line format) */
18287 /* coding-system (including end-of-line type) */
18289 int eol_flag
= (c
== 'Z');
18290 char *p
= decode_mode_spec_buf
;
18292 if (! FRAME_WINDOW_P (f
))
18294 /* No need to mention EOL here--the terminal never needs
18295 to do EOL conversion. */
18296 p
= decode_mode_spec_coding (CODING_ID_NAME
18297 (FRAME_KEYBOARD_CODING (f
)->id
),
18299 p
= decode_mode_spec_coding (CODING_ID_NAME
18300 (FRAME_TERMINAL_CODING (f
)->id
),
18303 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18306 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18307 #ifdef subprocesses
18308 obj
= Fget_buffer_process (Fcurrent_buffer ());
18309 if (PROCESSP (obj
))
18311 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18313 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18316 #endif /* subprocesses */
18319 return decode_mode_spec_buf
;
18325 *multibyte
= STRING_MULTIBYTE (obj
);
18327 return (char *) SDATA (obj
);
18334 /* Count up to COUNT lines starting from START / START_BYTE.
18335 But don't go beyond LIMIT_BYTE.
18336 Return the number of lines thus found (always nonnegative).
18338 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18341 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18342 int start
, start_byte
, limit_byte
, count
;
18345 register unsigned char *cursor
;
18346 unsigned char *base
;
18348 register int ceiling
;
18349 register unsigned char *ceiling_addr
;
18350 int orig_count
= count
;
18352 /* If we are not in selective display mode,
18353 check only for newlines. */
18354 int selective_display
= (!NILP (current_buffer
->selective_display
)
18355 && !INTEGERP (current_buffer
->selective_display
));
18359 while (start_byte
< limit_byte
)
18361 ceiling
= BUFFER_CEILING_OF (start_byte
);
18362 ceiling
= min (limit_byte
- 1, ceiling
);
18363 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18364 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18367 if (selective_display
)
18368 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18371 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18374 if (cursor
!= ceiling_addr
)
18378 start_byte
+= cursor
- base
+ 1;
18379 *byte_pos_ptr
= start_byte
;
18383 if (++cursor
== ceiling_addr
)
18389 start_byte
+= cursor
- base
;
18394 while (start_byte
> limit_byte
)
18396 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18397 ceiling
= max (limit_byte
, ceiling
);
18398 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18399 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18402 if (selective_display
)
18403 while (--cursor
!= ceiling_addr
18404 && *cursor
!= '\n' && *cursor
!= 015)
18407 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18410 if (cursor
!= ceiling_addr
)
18414 start_byte
+= cursor
- base
+ 1;
18415 *byte_pos_ptr
= start_byte
;
18416 /* When scanning backwards, we should
18417 not count the newline posterior to which we stop. */
18418 return - orig_count
- 1;
18424 /* Here we add 1 to compensate for the last decrement
18425 of CURSOR, which took it past the valid range. */
18426 start_byte
+= cursor
- base
+ 1;
18430 *byte_pos_ptr
= limit_byte
;
18433 return - orig_count
+ count
;
18434 return orig_count
- count
;
18440 /***********************************************************************
18442 ***********************************************************************/
18444 /* Display a NUL-terminated string, starting with index START.
18446 If STRING is non-null, display that C string. Otherwise, the Lisp
18447 string LISP_STRING is displayed.
18449 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18450 FACE_STRING. Display STRING or LISP_STRING with the face at
18451 FACE_STRING_POS in FACE_STRING:
18453 Display the string in the environment given by IT, but use the
18454 standard display table, temporarily.
18456 FIELD_WIDTH is the minimum number of output glyphs to produce.
18457 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18458 with spaces. If STRING has more characters, more than FIELD_WIDTH
18459 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18461 PRECISION is the maximum number of characters to output from
18462 STRING. PRECISION < 0 means don't truncate the string.
18464 This is roughly equivalent to printf format specifiers:
18466 FIELD_WIDTH PRECISION PRINTF
18467 ----------------------------------------
18473 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18474 display them, and < 0 means obey the current buffer's value of
18475 enable_multibyte_characters.
18477 Value is the number of columns displayed. */
18480 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18481 start
, it
, field_width
, precision
, max_x
, multibyte
)
18482 unsigned char *string
;
18483 Lisp_Object lisp_string
;
18484 Lisp_Object face_string
;
18485 int face_string_pos
;
18488 int field_width
, precision
, max_x
;
18491 int hpos_at_start
= it
->hpos
;
18492 int saved_face_id
= it
->face_id
;
18493 struct glyph_row
*row
= it
->glyph_row
;
18495 /* Initialize the iterator IT for iteration over STRING beginning
18496 with index START. */
18497 reseat_to_string (it
, string
, lisp_string
, start
,
18498 precision
, field_width
, multibyte
);
18500 /* If displaying STRING, set up the face of the iterator
18501 from LISP_STRING, if that's given. */
18502 if (STRINGP (face_string
))
18508 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18509 0, it
->region_beg_charpos
,
18510 it
->region_end_charpos
,
18511 &endptr
, it
->base_face_id
, 0);
18512 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18513 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18516 /* Set max_x to the maximum allowed X position. Don't let it go
18517 beyond the right edge of the window. */
18519 max_x
= it
->last_visible_x
;
18521 max_x
= min (max_x
, it
->last_visible_x
);
18523 /* Skip over display elements that are not visible. because IT->w is
18525 if (it
->current_x
< it
->first_visible_x
)
18526 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18527 MOVE_TO_POS
| MOVE_TO_X
);
18529 row
->ascent
= it
->max_ascent
;
18530 row
->height
= it
->max_ascent
+ it
->max_descent
;
18531 row
->phys_ascent
= it
->max_phys_ascent
;
18532 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18533 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18535 /* This condition is for the case that we are called with current_x
18536 past last_visible_x. */
18537 while (it
->current_x
< max_x
)
18539 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18541 /* Get the next display element. */
18542 if (!get_next_display_element (it
))
18545 /* Produce glyphs. */
18546 x_before
= it
->current_x
;
18547 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18548 PRODUCE_GLYPHS (it
);
18550 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18553 while (i
< nglyphs
)
18555 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18557 if (!it
->truncate_lines_p
18558 && x
+ glyph
->pixel_width
> max_x
)
18560 /* End of continued line or max_x reached. */
18561 if (CHAR_GLYPH_PADDING_P (*glyph
))
18563 /* A wide character is unbreakable. */
18564 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18565 it
->current_x
= x_before
;
18569 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18574 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18576 /* Glyph is at least partially visible. */
18578 if (x
< it
->first_visible_x
)
18579 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18583 /* Glyph is off the left margin of the display area.
18584 Should not happen. */
18588 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18589 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18590 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18591 row
->phys_height
= max (row
->phys_height
,
18592 it
->max_phys_ascent
+ it
->max_phys_descent
);
18593 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18594 it
->max_extra_line_spacing
);
18595 x
+= glyph
->pixel_width
;
18599 /* Stop if max_x reached. */
18603 /* Stop at line ends. */
18604 if (ITERATOR_AT_END_OF_LINE_P (it
))
18606 it
->continuation_lines_width
= 0;
18610 set_iterator_to_next (it
, 1);
18612 /* Stop if truncating at the right edge. */
18613 if (it
->truncate_lines_p
18614 && it
->current_x
>= it
->last_visible_x
)
18616 /* Add truncation mark, but don't do it if the line is
18617 truncated at a padding space. */
18618 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18620 if (!FRAME_WINDOW_P (it
->f
))
18624 if (it
->current_x
> it
->last_visible_x
)
18626 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18627 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18629 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18631 row
->used
[TEXT_AREA
] = i
;
18632 produce_special_glyphs (it
, IT_TRUNCATION
);
18635 produce_special_glyphs (it
, IT_TRUNCATION
);
18637 it
->glyph_row
->truncated_on_right_p
= 1;
18643 /* Maybe insert a truncation at the left. */
18644 if (it
->first_visible_x
18645 && IT_CHARPOS (*it
) > 0)
18647 if (!FRAME_WINDOW_P (it
->f
))
18648 insert_left_trunc_glyphs (it
);
18649 it
->glyph_row
->truncated_on_left_p
= 1;
18652 it
->face_id
= saved_face_id
;
18654 /* Value is number of columns displayed. */
18655 return it
->hpos
- hpos_at_start
;
18660 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18661 appears as an element of LIST or as the car of an element of LIST.
18662 If PROPVAL is a list, compare each element against LIST in that
18663 way, and return 1/2 if any element of PROPVAL is found in LIST.
18664 Otherwise return 0. This function cannot quit.
18665 The return value is 2 if the text is invisible but with an ellipsis
18666 and 1 if it's invisible and without an ellipsis. */
18669 invisible_p (propval
, list
)
18670 register Lisp_Object propval
;
18673 register Lisp_Object tail
, proptail
;
18675 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18677 register Lisp_Object tem
;
18679 if (EQ (propval
, tem
))
18681 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
18682 return NILP (XCDR (tem
)) ? 1 : 2;
18685 if (CONSP (propval
))
18687 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
18689 Lisp_Object propelt
;
18690 propelt
= XCAR (proptail
);
18691 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18693 register Lisp_Object tem
;
18695 if (EQ (propelt
, tem
))
18697 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
18698 return NILP (XCDR (tem
)) ? 1 : 2;
18706 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
18707 doc
: /* Non-nil if the property makes the text invisible.
18708 POS-OR-PROP can be a marker or number, in which case it is taken to be
18709 a position in the current buffer and the value of the `invisible' property
18710 is checked; or it can be some other value, which is then presumed to be the
18711 value of the `invisible' property of the text of interest.
18712 The non-nil value returned can be t for truly invisible text or something
18713 else if the text is replaced by an ellipsis. */)
18715 Lisp_Object pos_or_prop
;
18718 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
18719 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
18721 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
18722 return (invis
== 0 ? Qnil
18724 : make_number (invis
));
18727 /* Calculate a width or height in pixels from a specification using
18728 the following elements:
18731 NUM - a (fractional) multiple of the default font width/height
18732 (NUM) - specifies exactly NUM pixels
18733 UNIT - a fixed number of pixels, see below.
18734 ELEMENT - size of a display element in pixels, see below.
18735 (NUM . SPEC) - equals NUM * SPEC
18736 (+ SPEC SPEC ...) - add pixel values
18737 (- SPEC SPEC ...) - subtract pixel values
18738 (- SPEC) - negate pixel value
18741 INT or FLOAT - a number constant
18742 SYMBOL - use symbol's (buffer local) variable binding.
18745 in - pixels per inch *)
18746 mm - pixels per 1/1000 meter *)
18747 cm - pixels per 1/100 meter *)
18748 width - width of current font in pixels.
18749 height - height of current font in pixels.
18751 *) using the ratio(s) defined in display-pixels-per-inch.
18755 left-fringe - left fringe width in pixels
18756 right-fringe - right fringe width in pixels
18758 left-margin - left margin width in pixels
18759 right-margin - right margin width in pixels
18761 scroll-bar - scroll-bar area width in pixels
18765 Pixels corresponding to 5 inches:
18768 Total width of non-text areas on left side of window (if scroll-bar is on left):
18769 '(space :width (+ left-fringe left-margin scroll-bar))
18771 Align to first text column (in header line):
18772 '(space :align-to 0)
18774 Align to middle of text area minus half the width of variable `my-image'
18775 containing a loaded image:
18776 '(space :align-to (0.5 . (- text my-image)))
18778 Width of left margin minus width of 1 character in the default font:
18779 '(space :width (- left-margin 1))
18781 Width of left margin minus width of 2 characters in the current font:
18782 '(space :width (- left-margin (2 . width)))
18784 Center 1 character over left-margin (in header line):
18785 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
18787 Different ways to express width of left fringe plus left margin minus one pixel:
18788 '(space :width (- (+ left-fringe left-margin) (1)))
18789 '(space :width (+ left-fringe left-margin (- (1))))
18790 '(space :width (+ left-fringe left-margin (-1)))
18794 #define NUMVAL(X) \
18795 ((INTEGERP (X) || FLOATP (X)) \
18800 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
18805 int width_p
, *align_to
;
18809 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
18810 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
18813 return OK_PIXELS (0);
18815 xassert (FRAME_LIVE_P (it
->f
));
18817 if (SYMBOLP (prop
))
18819 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
18821 char *unit
= SDATA (SYMBOL_NAME (prop
));
18823 if (unit
[0] == 'i' && unit
[1] == 'n')
18825 else if (unit
[0] == 'm' && unit
[1] == 'm')
18827 else if (unit
[0] == 'c' && unit
[1] == 'm')
18834 #ifdef HAVE_WINDOW_SYSTEM
18835 if (FRAME_WINDOW_P (it
->f
)
18837 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
18838 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
18840 return OK_PIXELS (ppi
/ pixels
);
18843 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
18844 || (CONSP (Vdisplay_pixels_per_inch
)
18846 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
18847 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
18849 return OK_PIXELS (ppi
/ pixels
);
18855 #ifdef HAVE_WINDOW_SYSTEM
18856 if (EQ (prop
, Qheight
))
18857 return OK_PIXELS (font
? FONT_HEIGHT ((XFontStruct
*)font
) : FRAME_LINE_HEIGHT (it
->f
));
18858 if (EQ (prop
, Qwidth
))
18859 return OK_PIXELS (font
? FONT_WIDTH ((XFontStruct
*)font
) : FRAME_COLUMN_WIDTH (it
->f
));
18861 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
18862 return OK_PIXELS (1);
18865 if (EQ (prop
, Qtext
))
18866 return OK_PIXELS (width_p
18867 ? window_box_width (it
->w
, TEXT_AREA
)
18868 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
18870 if (align_to
&& *align_to
< 0)
18873 if (EQ (prop
, Qleft
))
18874 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
18875 if (EQ (prop
, Qright
))
18876 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
18877 if (EQ (prop
, Qcenter
))
18878 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
18879 + window_box_width (it
->w
, TEXT_AREA
) / 2);
18880 if (EQ (prop
, Qleft_fringe
))
18881 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18882 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
18883 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
18884 if (EQ (prop
, Qright_fringe
))
18885 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18886 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18887 : window_box_right_offset (it
->w
, TEXT_AREA
));
18888 if (EQ (prop
, Qleft_margin
))
18889 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
18890 if (EQ (prop
, Qright_margin
))
18891 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
18892 if (EQ (prop
, Qscroll_bar
))
18893 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
18895 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18896 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18897 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
18902 if (EQ (prop
, Qleft_fringe
))
18903 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
18904 if (EQ (prop
, Qright_fringe
))
18905 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
18906 if (EQ (prop
, Qleft_margin
))
18907 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
18908 if (EQ (prop
, Qright_margin
))
18909 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
18910 if (EQ (prop
, Qscroll_bar
))
18911 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
18914 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
18917 if (INTEGERP (prop
) || FLOATP (prop
))
18919 int base_unit
= (width_p
18920 ? FRAME_COLUMN_WIDTH (it
->f
)
18921 : FRAME_LINE_HEIGHT (it
->f
));
18922 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
18927 Lisp_Object car
= XCAR (prop
);
18928 Lisp_Object cdr
= XCDR (prop
);
18932 #ifdef HAVE_WINDOW_SYSTEM
18933 if (FRAME_WINDOW_P (it
->f
)
18934 && valid_image_p (prop
))
18936 int id
= lookup_image (it
->f
, prop
);
18937 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
18939 return OK_PIXELS (width_p
? img
->width
: img
->height
);
18942 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
18948 while (CONSP (cdr
))
18950 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
18951 font
, width_p
, align_to
))
18954 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
18959 if (EQ (car
, Qminus
))
18961 return OK_PIXELS (pixels
);
18964 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
18967 if (INTEGERP (car
) || FLOATP (car
))
18970 pixels
= XFLOATINT (car
);
18972 return OK_PIXELS (pixels
);
18973 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
18974 font
, width_p
, align_to
))
18975 return OK_PIXELS (pixels
* fact
);
18986 /***********************************************************************
18988 ***********************************************************************/
18990 #ifdef HAVE_WINDOW_SYSTEM
18995 dump_glyph_string (s
)
18996 struct glyph_string
*s
;
18998 fprintf (stderr
, "glyph string\n");
18999 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19000 s
->x
, s
->y
, s
->width
, s
->height
);
19001 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19002 fprintf (stderr
, " hl = %d\n", s
->hl
);
19003 fprintf (stderr
, " left overhang = %d, right = %d\n",
19004 s
->left_overhang
, s
->right_overhang
);
19005 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19006 fprintf (stderr
, " extends to end of line = %d\n",
19007 s
->extends_to_end_of_line_p
);
19008 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19009 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19012 #endif /* GLYPH_DEBUG */
19014 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19015 of XChar2b structures for S; it can't be allocated in
19016 init_glyph_string because it must be allocated via `alloca'. W
19017 is the window on which S is drawn. ROW and AREA are the glyph row
19018 and area within the row from which S is constructed. START is the
19019 index of the first glyph structure covered by S. HL is a
19020 face-override for drawing S. */
19023 #define OPTIONAL_HDC(hdc) hdc,
19024 #define DECLARE_HDC(hdc) HDC hdc;
19025 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19026 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19029 #ifndef OPTIONAL_HDC
19030 #define OPTIONAL_HDC(hdc)
19031 #define DECLARE_HDC(hdc)
19032 #define ALLOCATE_HDC(hdc, f)
19033 #define RELEASE_HDC(hdc, f)
19037 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19038 struct glyph_string
*s
;
19042 struct glyph_row
*row
;
19043 enum glyph_row_area area
;
19045 enum draw_glyphs_face hl
;
19047 bzero (s
, sizeof *s
);
19049 s
->f
= XFRAME (w
->frame
);
19053 s
->display
= FRAME_X_DISPLAY (s
->f
);
19054 s
->window
= FRAME_X_WINDOW (s
->f
);
19055 s
->char2b
= char2b
;
19059 s
->first_glyph
= row
->glyphs
[area
] + start
;
19060 s
->height
= row
->height
;
19061 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19063 /* Display the internal border below the tool-bar window. */
19064 if (WINDOWP (s
->f
->tool_bar_window
)
19065 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19066 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19068 s
->ybase
= s
->y
+ row
->ascent
;
19072 /* Append the list of glyph strings with head H and tail T to the list
19073 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19076 append_glyph_string_lists (head
, tail
, h
, t
)
19077 struct glyph_string
**head
, **tail
;
19078 struct glyph_string
*h
, *t
;
19092 /* Prepend the list of glyph strings with head H and tail T to the
19093 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19097 prepend_glyph_string_lists (head
, tail
, h
, t
)
19098 struct glyph_string
**head
, **tail
;
19099 struct glyph_string
*h
, *t
;
19113 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19114 Set *HEAD and *TAIL to the resulting list. */
19117 append_glyph_string (head
, tail
, s
)
19118 struct glyph_string
**head
, **tail
;
19119 struct glyph_string
*s
;
19121 s
->next
= s
->prev
= NULL
;
19122 append_glyph_string_lists (head
, tail
, s
, s
);
19126 /* Get face and two-byte form of character C in face FACE_ID on frame
19127 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19128 means we want to display multibyte text. DISPLAY_P non-zero means
19129 make sure that X resources for the face returned are allocated.
19130 Value is a pointer to a realized face that is ready for display if
19131 DISPLAY_P is non-zero. */
19133 static INLINE
struct face
*
19134 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19138 int multibyte_p
, display_p
;
19140 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19142 #ifdef USE_FONT_BACKEND
19143 if (enable_font_backend
)
19145 struct font
*font
= (struct font
*) face
->font_info
;
19149 unsigned code
= font
->driver
->encode_char (font
, c
);
19151 if (code
!= FONT_INVALID_CODE
)
19152 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19154 STORE_XCHAR2B (char2b
, 0, 0);
19158 #endif /* USE_FONT_BACKEND */
19161 /* Unibyte case. We don't have to encode, but we have to make
19162 sure to use a face suitable for unibyte. */
19163 STORE_XCHAR2B (char2b
, 0, c
);
19164 face_id
= FACE_FOR_CHAR (f
, face
, c
, -1, Qnil
);
19165 face
= FACE_FROM_ID (f
, face_id
);
19169 /* Case of ASCII in a face known to fit ASCII. */
19170 STORE_XCHAR2B (char2b
, 0, c
);
19172 else if (face
->font
!= NULL
)
19174 struct font_info
*font_info
19175 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19176 struct charset
*charset
= CHARSET_FROM_ID (font_info
->charset
);
19177 unsigned code
= ENCODE_CHAR (charset
, c
);
19179 if (CHARSET_DIMENSION (charset
) == 1)
19180 STORE_XCHAR2B (char2b
, 0, code
);
19182 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19183 /* Maybe encode the character in *CHAR2B. */
19184 FRAME_RIF (f
)->encode_char (c
, char2b
, font_info
, charset
, NULL
);
19187 /* Make sure X resources of the face are allocated. */
19188 #ifdef HAVE_X_WINDOWS
19192 xassert (face
!= NULL
);
19193 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19200 /* Get face and two-byte form of character glyph GLYPH on frame F.
19201 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19202 a pointer to a realized face that is ready for display. */
19204 static INLINE
struct face
*
19205 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19207 struct glyph
*glyph
;
19213 xassert (glyph
->type
== CHAR_GLYPH
);
19214 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19219 #ifdef USE_FONT_BACKEND
19220 if (enable_font_backend
)
19222 struct font
*font
= (struct font
*) face
->font_info
;
19226 unsigned code
= font
->driver
->encode_char (font
, glyph
->u
.ch
);
19228 if (code
!= FONT_INVALID_CODE
)
19229 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19231 STORE_XCHAR2B (char2b
, 0, code
);
19235 #endif /* USE_FONT_BACKEND */
19236 if (!glyph
->multibyte_p
)
19238 /* Unibyte case. We don't have to encode, but we have to make
19239 sure to use a face suitable for unibyte. */
19240 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
19242 else if (glyph
->u
.ch
< 128)
19244 /* Case of ASCII in a face known to fit ASCII. */
19245 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
19249 struct font_info
*font_info
19250 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19253 struct charset
*charset
= CHARSET_FROM_ID (font_info
->charset
);
19254 unsigned code
= ENCODE_CHAR (charset
, glyph
->u
.ch
);
19256 if (CHARSET_DIMENSION (charset
) == 1)
19257 STORE_XCHAR2B (char2b
, 0, code
);
19259 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19261 /* Maybe encode the character in *CHAR2B. */
19262 if (CHARSET_ID (charset
) != charset_ascii
)
19265 = FRAME_RIF (f
)->encode_char (glyph
->u
.ch
, char2b
, font_info
,
19266 charset
, two_byte_p
);
19271 /* Make sure X resources of the face are allocated. */
19272 xassert (face
!= NULL
);
19273 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19278 /* Fill glyph string S with composition components specified by S->cmp.
19280 BASE_FACE is the base face of the composition.
19281 S->gidx is the index of the first component for S.
19283 OVERLAPS non-zero means S should draw the foreground only, and use
19284 its physical height for clipping. See also draw_glyphs.
19286 Value is the index of a component not in S. */
19289 fill_composite_glyph_string (s
, base_face
, overlaps
)
19290 struct glyph_string
*s
;
19291 struct face
*base_face
;
19298 s
->for_overlaps
= overlaps
;
19300 #ifdef USE_FONT_BACKEND
19301 if (enable_font_backend
&& s
->cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
19303 Lisp_Object gstring
19304 = AREF (XHASH_TABLE (composition_hash_table
)->key_and_value
,
19305 s
->cmp
->hash_index
* 2);
19307 s
->face
= base_face
;
19308 s
->font_info
= base_face
->font_info
;
19309 s
->font
= s
->font_info
->font
;
19310 for (i
= 0, s
->nchars
= 0; i
< s
->cmp
->glyph_len
; i
++, s
->nchars
++)
19312 Lisp_Object g
= LGSTRING_GLYPH (gstring
, i
);
19314 XChar2b
* store_pos
;
19317 code
= LGLYPH_CODE (g
);
19318 store_pos
= s
->char2b
+ i
;
19319 STORE_XCHAR2B (store_pos
, code
>> 8, code
& 0xFF);
19321 s
->width
= s
->cmp
->pixel_width
;
19324 #endif /* USE_FONT_BACKEND */
19326 /* For all glyphs of this composition, starting at the offset
19327 S->gidx, until we reach the end of the definition or encounter a
19328 glyph that requires the different face, add it to S. */
19333 s
->font_info
= NULL
;
19334 for (i
= s
->gidx
; i
< s
->cmp
->glyph_len
; i
++)
19336 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19340 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19343 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19344 s
->char2b
+ i
, 1, 1);
19350 s
->font
= s
->face
->font
;
19351 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19353 else if (s
->face
!= face
)
19360 /* All glyph strings for the same composition has the same width,
19361 i.e. the width set for the first component of the composition. */
19362 s
->width
= s
->first_glyph
->pixel_width
;
19365 /* If the specified font could not be loaded, use the frame's
19366 default font, but record the fact that we couldn't load it in
19367 the glyph string so that we can draw rectangles for the
19368 characters of the glyph string. */
19369 if (s
->font
== NULL
)
19371 s
->font_not_found_p
= 1;
19372 s
->font
= FRAME_FONT (s
->f
);
19375 /* Adjust base line for subscript/superscript text. */
19376 s
->ybase
+= s
->first_glyph
->voffset
;
19378 /* This glyph string must always be drawn with 16-bit functions. */
19381 return s
->gidx
+ s
->nchars
;
19385 /* Fill glyph string S from a sequence of character glyphs.
19387 FACE_ID is the face id of the string. START is the index of the
19388 first glyph to consider, END is the index of the last + 1.
19389 OVERLAPS non-zero means S should draw the foreground only, and use
19390 its physical height for clipping. See also draw_glyphs.
19392 Value is the index of the first glyph not in S. */
19395 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19396 struct glyph_string
*s
;
19398 int start
, end
, overlaps
;
19400 struct glyph
*glyph
, *last
;
19402 int glyph_not_available_p
;
19404 xassert (s
->f
== XFRAME (s
->w
->frame
));
19405 xassert (s
->nchars
== 0);
19406 xassert (start
>= 0 && end
> start
);
19408 s
->for_overlaps
= overlaps
,
19409 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19410 last
= s
->row
->glyphs
[s
->area
] + end
;
19411 voffset
= glyph
->voffset
;
19413 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19415 while (glyph
< last
19416 && glyph
->type
== CHAR_GLYPH
19417 && glyph
->voffset
== voffset
19418 /* Same face id implies same font, nowadays. */
19419 && glyph
->face_id
== face_id
19420 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19424 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19425 s
->char2b
+ s
->nchars
,
19427 s
->two_byte_p
= two_byte_p
;
19429 xassert (s
->nchars
<= end
- start
);
19430 s
->width
+= glyph
->pixel_width
;
19434 s
->font
= s
->face
->font
;
19435 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19437 /* If the specified font could not be loaded, use the frame's font,
19438 but record the fact that we couldn't load it in
19439 S->font_not_found_p so that we can draw rectangles for the
19440 characters of the glyph string. */
19441 if (s
->font
== NULL
|| glyph_not_available_p
)
19443 s
->font_not_found_p
= 1;
19444 s
->font
= FRAME_FONT (s
->f
);
19447 /* Adjust base line for subscript/superscript text. */
19448 s
->ybase
+= voffset
;
19450 xassert (s
->face
&& s
->face
->gc
);
19451 return glyph
- s
->row
->glyphs
[s
->area
];
19455 /* Fill glyph string S from image glyph S->first_glyph. */
19458 fill_image_glyph_string (s
)
19459 struct glyph_string
*s
;
19461 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19462 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19464 s
->slice
= s
->first_glyph
->slice
;
19465 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19466 s
->font
= s
->face
->font
;
19467 s
->width
= s
->first_glyph
->pixel_width
;
19469 /* Adjust base line for subscript/superscript text. */
19470 s
->ybase
+= s
->first_glyph
->voffset
;
19474 /* Fill glyph string S from a sequence of stretch glyphs.
19476 ROW is the glyph row in which the glyphs are found, AREA is the
19477 area within the row. START is the index of the first glyph to
19478 consider, END is the index of the last + 1.
19480 Value is the index of the first glyph not in S. */
19483 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19484 struct glyph_string
*s
;
19485 struct glyph_row
*row
;
19486 enum glyph_row_area area
;
19489 struct glyph
*glyph
, *last
;
19490 int voffset
, face_id
;
19492 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19494 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19495 last
= s
->row
->glyphs
[s
->area
] + end
;
19496 face_id
= glyph
->face_id
;
19497 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19498 s
->font
= s
->face
->font
;
19499 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19500 s
->width
= glyph
->pixel_width
;
19502 voffset
= glyph
->voffset
;
19506 && glyph
->type
== STRETCH_GLYPH
19507 && glyph
->voffset
== voffset
19508 && glyph
->face_id
== face_id
);
19510 s
->width
+= glyph
->pixel_width
;
19512 /* Adjust base line for subscript/superscript text. */
19513 s
->ybase
+= voffset
;
19515 /* The case that face->gc == 0 is handled when drawing the glyph
19516 string by calling PREPARE_FACE_FOR_DISPLAY. */
19518 return glyph
- s
->row
->glyphs
[s
->area
];
19521 static XCharStruct
*
19522 get_per_char_metric (f
, font
, font_info
, char2b
, font_type
)
19525 struct font_info
*font_info
;
19529 #ifdef USE_FONT_BACKEND
19530 if (enable_font_backend
)
19532 static XCharStruct pcm_value
;
19533 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19534 struct font
*fontp
;
19535 struct font_metrics metrics
;
19537 if (! font_info
|| code
== FONT_INVALID_CODE
)
19539 fontp
= (struct font
*) font_info
;
19540 fontp
->driver
->text_extents (fontp
, &code
, 1, &metrics
);
19541 pcm_value
.lbearing
= metrics
.lbearing
;
19542 pcm_value
.rbearing
= metrics
.rbearing
;
19543 pcm_value
.ascent
= metrics
.ascent
;
19544 pcm_value
.descent
= metrics
.descent
;
19545 pcm_value
.width
= metrics
.width
;
19548 #endif /* USE_FONT_BACKEND */
19549 return FRAME_RIF (f
)->per_char_metric (font
, char2b
, font_type
);
19553 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19554 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19555 assumed to be zero. */
19558 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19559 struct glyph
*glyph
;
19563 *left
= *right
= 0;
19565 if (glyph
->type
== CHAR_GLYPH
)
19569 struct font_info
*font_info
;
19573 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19575 font_info
= FONT_INFO_FROM_FACE (f
, face
);
19576 if (font
/* ++KFS: Should this be font_info ? */
19577 && (pcm
= get_per_char_metric (f
, font
, font_info
, &char2b
, glyph
->font_type
)))
19579 if (pcm
->rbearing
> pcm
->width
)
19580 *right
= pcm
->rbearing
- pcm
->width
;
19581 if (pcm
->lbearing
< 0)
19582 *left
= -pcm
->lbearing
;
19585 else if (glyph
->type
== COMPOSITE_GLYPH
)
19587 struct composition
*cmp
= composition_table
[glyph
->u
.cmp_id
];
19589 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19590 *left
= - cmp
->lbearing
;
19595 /* Return the index of the first glyph preceding glyph string S that
19596 is overwritten by S because of S's left overhang. Value is -1
19597 if no glyphs are overwritten. */
19600 left_overwritten (s
)
19601 struct glyph_string
*s
;
19605 if (s
->left_overhang
)
19608 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19609 int first
= s
->first_glyph
- glyphs
;
19611 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19612 x
-= glyphs
[i
].pixel_width
;
19623 /* Return the index of the first glyph preceding glyph string S that
19624 is overwriting S because of its right overhang. Value is -1 if no
19625 glyph in front of S overwrites S. */
19628 left_overwriting (s
)
19629 struct glyph_string
*s
;
19632 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19633 int first
= s
->first_glyph
- glyphs
;
19637 for (i
= first
- 1; i
>= 0; --i
)
19640 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19643 x
-= glyphs
[i
].pixel_width
;
19650 /* Return the index of the last glyph following glyph string S that is
19651 not overwritten by S because of S's right overhang. Value is -1 if
19652 no such glyph is found. */
19655 right_overwritten (s
)
19656 struct glyph_string
*s
;
19660 if (s
->right_overhang
)
19663 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19664 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19665 int end
= s
->row
->used
[s
->area
];
19667 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19668 x
+= glyphs
[i
].pixel_width
;
19677 /* Return the index of the last glyph following glyph string S that
19678 overwrites S because of its left overhang. Value is negative
19679 if no such glyph is found. */
19682 right_overwriting (s
)
19683 struct glyph_string
*s
;
19686 int end
= s
->row
->used
[s
->area
];
19687 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19688 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19692 for (i
= first
; i
< end
; ++i
)
19695 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19698 x
+= glyphs
[i
].pixel_width
;
19705 /* Set background width of glyph string S. START is the index of the
19706 first glyph following S. LAST_X is the right-most x-position + 1
19707 in the drawing area. */
19710 set_glyph_string_background_width (s
, start
, last_x
)
19711 struct glyph_string
*s
;
19715 /* If the face of this glyph string has to be drawn to the end of
19716 the drawing area, set S->extends_to_end_of_line_p. */
19718 if (start
== s
->row
->used
[s
->area
]
19719 && s
->area
== TEXT_AREA
19720 && ((s
->row
->fill_line_p
19721 && (s
->hl
== DRAW_NORMAL_TEXT
19722 || s
->hl
== DRAW_IMAGE_RAISED
19723 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19724 || s
->hl
== DRAW_MOUSE_FACE
))
19725 s
->extends_to_end_of_line_p
= 1;
19727 /* If S extends its face to the end of the line, set its
19728 background_width to the distance to the right edge of the drawing
19730 if (s
->extends_to_end_of_line_p
)
19731 s
->background_width
= last_x
- s
->x
+ 1;
19733 s
->background_width
= s
->width
;
19737 /* Compute overhangs and x-positions for glyph string S and its
19738 predecessors, or successors. X is the starting x-position for S.
19739 BACKWARD_P non-zero means process predecessors. */
19742 compute_overhangs_and_x (s
, x
, backward_p
)
19743 struct glyph_string
*s
;
19751 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19752 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19762 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19763 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19773 /* The following macros are only called from draw_glyphs below.
19774 They reference the following parameters of that function directly:
19775 `w', `row', `area', and `overlap_p'
19776 as well as the following local variables:
19777 `s', `f', and `hdc' (in W32) */
19780 /* On W32, silently add local `hdc' variable to argument list of
19781 init_glyph_string. */
19782 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19783 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
19785 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19786 init_glyph_string (s, char2b, w, row, area, start, hl)
19789 /* Add a glyph string for a stretch glyph to the list of strings
19790 between HEAD and TAIL. START is the index of the stretch glyph in
19791 row area AREA of glyph row ROW. END is the index of the last glyph
19792 in that glyph row area. X is the current output position assigned
19793 to the new glyph string constructed. HL overrides that face of the
19794 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19795 is the right-most x-position of the drawing area. */
19797 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
19798 and below -- keep them on one line. */
19799 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19802 s = (struct glyph_string *) alloca (sizeof *s); \
19803 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19804 START = fill_stretch_glyph_string (s, row, area, START, END); \
19805 append_glyph_string (&HEAD, &TAIL, s); \
19811 /* Add a glyph string for an image glyph to the list of strings
19812 between HEAD and TAIL. START is the index of the image glyph in
19813 row area AREA of glyph row ROW. END is the index of the last glyph
19814 in that glyph row area. X is the current output position assigned
19815 to the new glyph string constructed. HL overrides that face of the
19816 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19817 is the right-most x-position of the drawing area. */
19819 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19822 s = (struct glyph_string *) alloca (sizeof *s); \
19823 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19824 fill_image_glyph_string (s); \
19825 append_glyph_string (&HEAD, &TAIL, s); \
19832 /* Add a glyph string for a sequence of character glyphs to the list
19833 of strings between HEAD and TAIL. START is the index of the first
19834 glyph in row area AREA of glyph row ROW that is part of the new
19835 glyph string. END is the index of the last glyph in that glyph row
19836 area. X is the current output position assigned to the new glyph
19837 string constructed. HL overrides that face of the glyph; e.g. it
19838 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
19839 right-most x-position of the drawing area. */
19841 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19847 face_id = (row)->glyphs[area][START].face_id; \
19849 s = (struct glyph_string *) alloca (sizeof *s); \
19850 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
19851 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19852 append_glyph_string (&HEAD, &TAIL, s); \
19854 START = fill_glyph_string (s, face_id, START, END, overlaps); \
19859 /* Add a glyph string for a composite sequence to the list of strings
19860 between HEAD and TAIL. START is the index of the first glyph in
19861 row area AREA of glyph row ROW that is part of the new glyph
19862 string. END is the index of the last glyph in that glyph row area.
19863 X is the current output position assigned to the new glyph string
19864 constructed. HL overrides that face of the glyph; e.g. it is
19865 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
19866 x-position of the drawing area. */
19868 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19870 int face_id = (row)->glyphs[area][START].face_id; \
19871 struct face *base_face = FACE_FROM_ID (f, face_id); \
19872 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
19873 struct composition *cmp = composition_table[cmp_id]; \
19875 struct glyph_string *first_s; \
19878 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
19880 /* Make glyph_strings for each glyph sequence that is drawable by \
19881 the same face, and append them to HEAD/TAIL. */ \
19882 for (n = 0; n < cmp->glyph_len;) \
19884 s = (struct glyph_string *) alloca (sizeof *s); \
19885 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19886 append_glyph_string (&(HEAD), &(TAIL), s); \
19892 n = fill_composite_glyph_string (s, base_face, overlaps); \
19900 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
19901 of AREA of glyph row ROW on window W between indices START and END.
19902 HL overrides the face for drawing glyph strings, e.g. it is
19903 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
19904 x-positions of the drawing area.
19906 This is an ugly monster macro construct because we must use alloca
19907 to allocate glyph strings (because draw_glyphs can be called
19908 asynchronously). */
19910 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19913 HEAD = TAIL = NULL; \
19914 while (START < END) \
19916 struct glyph *first_glyph = (row)->glyphs[area] + START; \
19917 switch (first_glyph->type) \
19920 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
19924 case COMPOSITE_GLYPH: \
19925 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
19929 case STRETCH_GLYPH: \
19930 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
19934 case IMAGE_GLYPH: \
19935 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
19945 set_glyph_string_background_width (s, START, LAST_X); \
19953 /* Draw glyphs between START and END in AREA of ROW on window W,
19954 starting at x-position X. X is relative to AREA in W. HL is a
19955 face-override with the following meaning:
19957 DRAW_NORMAL_TEXT draw normally
19958 DRAW_CURSOR draw in cursor face
19959 DRAW_MOUSE_FACE draw in mouse face.
19960 DRAW_INVERSE_VIDEO draw in mode line face
19961 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
19962 DRAW_IMAGE_RAISED draw an image with a raised relief around it
19964 If OVERLAPS is non-zero, draw only the foreground of characters and
19965 clip to the physical height of ROW. Non-zero value also defines
19966 the overlapping part to be drawn:
19968 OVERLAPS_PRED overlap with preceding rows
19969 OVERLAPS_SUCC overlap with succeeding rows
19970 OVERLAPS_BOTH overlap with both preceding/succeeding rows
19971 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
19973 Value is the x-position reached, relative to AREA of W. */
19976 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
19979 struct glyph_row
*row
;
19980 enum glyph_row_area area
;
19981 EMACS_INT start
, end
;
19982 enum draw_glyphs_face hl
;
19985 struct glyph_string
*head
, *tail
;
19986 struct glyph_string
*s
;
19987 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
19988 int last_x
, area_width
;
19991 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19994 ALLOCATE_HDC (hdc
, f
);
19996 /* Let's rather be paranoid than getting a SEGV. */
19997 end
= min (end
, row
->used
[area
]);
19998 start
= max (0, start
);
19999 start
= min (end
, start
);
20001 /* Translate X to frame coordinates. Set last_x to the right
20002 end of the drawing area. */
20003 if (row
->full_width_p
)
20005 /* X is relative to the left edge of W, without scroll bars
20007 x
+= WINDOW_LEFT_EDGE_X (w
);
20008 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20012 int area_left
= window_box_left (w
, area
);
20014 area_width
= window_box_width (w
, area
);
20015 last_x
= area_left
+ area_width
;
20018 /* Build a doubly-linked list of glyph_string structures between
20019 head and tail from what we have to draw. Note that the macro
20020 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20021 the reason we use a separate variable `i'. */
20023 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20025 x_reached
= tail
->x
+ tail
->background_width
;
20029 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20030 the row, redraw some glyphs in front or following the glyph
20031 strings built above. */
20032 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20035 struct glyph_string
*h
, *t
;
20037 /* Compute overhangs for all glyph strings. */
20038 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20039 for (s
= head
; s
; s
= s
->next
)
20040 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20042 /* Prepend glyph strings for glyphs in front of the first glyph
20043 string that are overwritten because of the first glyph
20044 string's left overhang. The background of all strings
20045 prepended must be drawn because the first glyph string
20047 i
= left_overwritten (head
);
20051 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20052 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
20054 compute_overhangs_and_x (t
, head
->x
, 1);
20055 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20059 /* Prepend glyph strings for glyphs in front of the first glyph
20060 string that overwrite that glyph string because of their
20061 right overhang. For these strings, only the foreground must
20062 be drawn, because it draws over the glyph string at `head'.
20063 The background must not be drawn because this would overwrite
20064 right overhangs of preceding glyphs for which no glyph
20066 i
= left_overwriting (head
);
20070 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20071 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
20072 for (s
= h
; s
; s
= s
->next
)
20073 s
->background_filled_p
= 1;
20074 compute_overhangs_and_x (t
, head
->x
, 1);
20075 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20078 /* Append glyphs strings for glyphs following the last glyph
20079 string tail that are overwritten by tail. The background of
20080 these strings has to be drawn because tail's foreground draws
20082 i
= right_overwritten (tail
);
20085 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20086 DRAW_NORMAL_TEXT
, x
, last_x
);
20087 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20088 append_glyph_string_lists (&head
, &tail
, h
, t
);
20092 /* Append glyph strings for glyphs following the last glyph
20093 string tail that overwrite tail. The foreground of such
20094 glyphs has to be drawn because it writes into the background
20095 of tail. The background must not be drawn because it could
20096 paint over the foreground of following glyphs. */
20097 i
= right_overwriting (tail
);
20101 i
++; /* We must include the Ith glyph. */
20102 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20103 DRAW_NORMAL_TEXT
, x
, last_x
);
20104 for (s
= h
; s
; s
= s
->next
)
20105 s
->background_filled_p
= 1;
20106 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20107 append_glyph_string_lists (&head
, &tail
, h
, t
);
20109 if (clip_head
|| clip_tail
)
20110 for (s
= head
; s
; s
= s
->next
)
20112 s
->clip_head
= clip_head
;
20113 s
->clip_tail
= clip_tail
;
20117 /* Draw all strings. */
20118 for (s
= head
; s
; s
= s
->next
)
20119 FRAME_RIF (f
)->draw_glyph_string (s
);
20121 if (area
== TEXT_AREA
20122 && !row
->full_width_p
20123 /* When drawing overlapping rows, only the glyph strings'
20124 foreground is drawn, which doesn't erase a cursor
20128 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20129 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20130 : (tail
? tail
->x
+ tail
->background_width
: x
));
20132 int text_left
= window_box_left (w
, TEXT_AREA
);
20136 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20137 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20140 /* Value is the x-position up to which drawn, relative to AREA of W.
20141 This doesn't include parts drawn because of overhangs. */
20142 if (row
->full_width_p
)
20143 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20145 x_reached
-= window_box_left (w
, area
);
20147 RELEASE_HDC (hdc
, f
);
20152 /* Expand row matrix if too narrow. Don't expand if area
20155 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20157 if (!fonts_changed_p \
20158 && (it->glyph_row->glyphs[area] \
20159 < it->glyph_row->glyphs[area + 1])) \
20161 it->w->ncols_scale_factor++; \
20162 fonts_changed_p = 1; \
20166 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20167 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20173 struct glyph
*glyph
;
20174 enum glyph_row_area area
= it
->area
;
20176 xassert (it
->glyph_row
);
20177 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20179 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20180 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20182 glyph
->charpos
= CHARPOS (it
->position
);
20183 glyph
->object
= it
->object
;
20184 glyph
->pixel_width
= it
->pixel_width
;
20185 glyph
->ascent
= it
->ascent
;
20186 glyph
->descent
= it
->descent
;
20187 glyph
->voffset
= it
->voffset
;
20188 glyph
->type
= CHAR_GLYPH
;
20189 glyph
->multibyte_p
= it
->multibyte_p
;
20190 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20191 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20192 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20193 || it
->phys_descent
> it
->descent
);
20194 glyph
->padding_p
= 0;
20195 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20196 glyph
->face_id
= it
->face_id
;
20197 glyph
->u
.ch
= it
->char_to_display
;
20198 glyph
->slice
= null_glyph_slice
;
20199 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20200 ++it
->glyph_row
->used
[area
];
20203 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20206 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
20207 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20210 append_composite_glyph (it
)
20213 struct glyph
*glyph
;
20214 enum glyph_row_area area
= it
->area
;
20216 xassert (it
->glyph_row
);
20218 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20219 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20221 glyph
->charpos
= CHARPOS (it
->position
);
20222 glyph
->object
= it
->object
;
20223 glyph
->pixel_width
= it
->pixel_width
;
20224 glyph
->ascent
= it
->ascent
;
20225 glyph
->descent
= it
->descent
;
20226 glyph
->voffset
= it
->voffset
;
20227 glyph
->type
= COMPOSITE_GLYPH
;
20228 glyph
->multibyte_p
= it
->multibyte_p
;
20229 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20230 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20231 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20232 || it
->phys_descent
> it
->descent
);
20233 glyph
->padding_p
= 0;
20234 glyph
->glyph_not_available_p
= 0;
20235 glyph
->face_id
= it
->face_id
;
20236 glyph
->u
.cmp_id
= it
->cmp_id
;
20237 glyph
->slice
= null_glyph_slice
;
20238 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20239 ++it
->glyph_row
->used
[area
];
20242 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20246 /* Change IT->ascent and IT->height according to the setting of
20250 take_vertical_position_into_account (it
)
20255 if (it
->voffset
< 0)
20256 /* Increase the ascent so that we can display the text higher
20258 it
->ascent
-= it
->voffset
;
20260 /* Increase the descent so that we can display the text lower
20262 it
->descent
+= it
->voffset
;
20267 /* Produce glyphs/get display metrics for the image IT is loaded with.
20268 See the description of struct display_iterator in dispextern.h for
20269 an overview of struct display_iterator. */
20272 produce_image_glyph (it
)
20277 int glyph_ascent
, crop
;
20278 struct glyph_slice slice
;
20280 xassert (it
->what
== IT_IMAGE
);
20282 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20284 /* Make sure X resources of the face is loaded. */
20285 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20287 if (it
->image_id
< 0)
20289 /* Fringe bitmap. */
20290 it
->ascent
= it
->phys_ascent
= 0;
20291 it
->descent
= it
->phys_descent
= 0;
20292 it
->pixel_width
= 0;
20297 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20299 /* Make sure X resources of the image is loaded. */
20300 prepare_image_for_display (it
->f
, img
);
20302 slice
.x
= slice
.y
= 0;
20303 slice
.width
= img
->width
;
20304 slice
.height
= img
->height
;
20306 if (INTEGERP (it
->slice
.x
))
20307 slice
.x
= XINT (it
->slice
.x
);
20308 else if (FLOATP (it
->slice
.x
))
20309 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20311 if (INTEGERP (it
->slice
.y
))
20312 slice
.y
= XINT (it
->slice
.y
);
20313 else if (FLOATP (it
->slice
.y
))
20314 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20316 if (INTEGERP (it
->slice
.width
))
20317 slice
.width
= XINT (it
->slice
.width
);
20318 else if (FLOATP (it
->slice
.width
))
20319 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20321 if (INTEGERP (it
->slice
.height
))
20322 slice
.height
= XINT (it
->slice
.height
);
20323 else if (FLOATP (it
->slice
.height
))
20324 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20326 if (slice
.x
>= img
->width
)
20327 slice
.x
= img
->width
;
20328 if (slice
.y
>= img
->height
)
20329 slice
.y
= img
->height
;
20330 if (slice
.x
+ slice
.width
>= img
->width
)
20331 slice
.width
= img
->width
- slice
.x
;
20332 if (slice
.y
+ slice
.height
> img
->height
)
20333 slice
.height
= img
->height
- slice
.y
;
20335 if (slice
.width
== 0 || slice
.height
== 0)
20338 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20340 it
->descent
= slice
.height
- glyph_ascent
;
20342 it
->descent
+= img
->vmargin
;
20343 if (slice
.y
+ slice
.height
== img
->height
)
20344 it
->descent
+= img
->vmargin
;
20345 it
->phys_descent
= it
->descent
;
20347 it
->pixel_width
= slice
.width
;
20349 it
->pixel_width
+= img
->hmargin
;
20350 if (slice
.x
+ slice
.width
== img
->width
)
20351 it
->pixel_width
+= img
->hmargin
;
20353 /* It's quite possible for images to have an ascent greater than
20354 their height, so don't get confused in that case. */
20355 if (it
->descent
< 0)
20358 #if 0 /* this breaks image tiling */
20359 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20360 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20361 if (face_ascent
> it
->ascent
)
20362 it
->ascent
= it
->phys_ascent
= face_ascent
;
20367 if (face
->box
!= FACE_NO_BOX
)
20369 if (face
->box_line_width
> 0)
20372 it
->ascent
+= face
->box_line_width
;
20373 if (slice
.y
+ slice
.height
== img
->height
)
20374 it
->descent
+= face
->box_line_width
;
20377 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20378 it
->pixel_width
+= eabs (face
->box_line_width
);
20379 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20380 it
->pixel_width
+= eabs (face
->box_line_width
);
20383 take_vertical_position_into_account (it
);
20385 /* Automatically crop wide image glyphs at right edge so we can
20386 draw the cursor on same display row. */
20387 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20388 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20390 it
->pixel_width
-= crop
;
20391 slice
.width
-= crop
;
20396 struct glyph
*glyph
;
20397 enum glyph_row_area area
= it
->area
;
20399 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20400 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20402 glyph
->charpos
= CHARPOS (it
->position
);
20403 glyph
->object
= it
->object
;
20404 glyph
->pixel_width
= it
->pixel_width
;
20405 glyph
->ascent
= glyph_ascent
;
20406 glyph
->descent
= it
->descent
;
20407 glyph
->voffset
= it
->voffset
;
20408 glyph
->type
= IMAGE_GLYPH
;
20409 glyph
->multibyte_p
= it
->multibyte_p
;
20410 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20411 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20412 glyph
->overlaps_vertically_p
= 0;
20413 glyph
->padding_p
= 0;
20414 glyph
->glyph_not_available_p
= 0;
20415 glyph
->face_id
= it
->face_id
;
20416 glyph
->u
.img_id
= img
->id
;
20417 glyph
->slice
= slice
;
20418 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20419 ++it
->glyph_row
->used
[area
];
20422 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20427 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20428 of the glyph, WIDTH and HEIGHT are the width and height of the
20429 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20432 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20434 Lisp_Object object
;
20438 struct glyph
*glyph
;
20439 enum glyph_row_area area
= it
->area
;
20441 xassert (ascent
>= 0 && ascent
<= height
);
20443 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20444 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20446 glyph
->charpos
= CHARPOS (it
->position
);
20447 glyph
->object
= object
;
20448 glyph
->pixel_width
= width
;
20449 glyph
->ascent
= ascent
;
20450 glyph
->descent
= height
- ascent
;
20451 glyph
->voffset
= it
->voffset
;
20452 glyph
->type
= STRETCH_GLYPH
;
20453 glyph
->multibyte_p
= it
->multibyte_p
;
20454 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20455 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20456 glyph
->overlaps_vertically_p
= 0;
20457 glyph
->padding_p
= 0;
20458 glyph
->glyph_not_available_p
= 0;
20459 glyph
->face_id
= it
->face_id
;
20460 glyph
->u
.stretch
.ascent
= ascent
;
20461 glyph
->u
.stretch
.height
= height
;
20462 glyph
->slice
= null_glyph_slice
;
20463 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20464 ++it
->glyph_row
->used
[area
];
20467 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20471 /* Produce a stretch glyph for iterator IT. IT->object is the value
20472 of the glyph property displayed. The value must be a list
20473 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20476 1. `:width WIDTH' specifies that the space should be WIDTH *
20477 canonical char width wide. WIDTH may be an integer or floating
20480 2. `:relative-width FACTOR' specifies that the width of the stretch
20481 should be computed from the width of the first character having the
20482 `glyph' property, and should be FACTOR times that width.
20484 3. `:align-to HPOS' specifies that the space should be wide enough
20485 to reach HPOS, a value in canonical character units.
20487 Exactly one of the above pairs must be present.
20489 4. `:height HEIGHT' specifies that the height of the stretch produced
20490 should be HEIGHT, measured in canonical character units.
20492 5. `:relative-height FACTOR' specifies that the height of the
20493 stretch should be FACTOR times the height of the characters having
20494 the glyph property.
20496 Either none or exactly one of 4 or 5 must be present.
20498 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20499 of the stretch should be used for the ascent of the stretch.
20500 ASCENT must be in the range 0 <= ASCENT <= 100. */
20503 produce_stretch_glyph (it
)
20506 /* (space :width WIDTH :height HEIGHT ...) */
20507 Lisp_Object prop
, plist
;
20508 int width
= 0, height
= 0, align_to
= -1;
20509 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20512 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20513 XFontStruct
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20515 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20517 /* List should start with `space'. */
20518 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20519 plist
= XCDR (it
->object
);
20521 /* Compute the width of the stretch. */
20522 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20523 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20525 /* Absolute width `:width WIDTH' specified and valid. */
20526 zero_width_ok_p
= 1;
20529 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20532 /* Relative width `:relative-width FACTOR' specified and valid.
20533 Compute the width of the characters having the `glyph'
20536 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20539 if (it
->multibyte_p
)
20541 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20542 - IT_BYTEPOS (*it
));
20543 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20546 it2
.c
= *p
, it2
.len
= 1;
20548 it2
.glyph_row
= NULL
;
20549 it2
.what
= IT_CHARACTER
;
20550 x_produce_glyphs (&it2
);
20551 width
= NUMVAL (prop
) * it2
.pixel_width
;
20553 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20554 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20556 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20557 align_to
= (align_to
< 0
20559 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20560 else if (align_to
< 0)
20561 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20562 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20563 zero_width_ok_p
= 1;
20566 /* Nothing specified -> width defaults to canonical char width. */
20567 width
= FRAME_COLUMN_WIDTH (it
->f
);
20569 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20572 /* Compute height. */
20573 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20574 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20577 zero_height_ok_p
= 1;
20579 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20581 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20583 height
= FONT_HEIGHT (font
);
20585 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20588 /* Compute percentage of height used for ascent. If
20589 `:ascent ASCENT' is present and valid, use that. Otherwise,
20590 derive the ascent from the font in use. */
20591 if (prop
= Fplist_get (plist
, QCascent
),
20592 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20593 ascent
= height
* NUMVAL (prop
) / 100.0;
20594 else if (!NILP (prop
)
20595 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20596 ascent
= min (max (0, (int)tem
), height
);
20598 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20600 if (width
> 0 && !it
->truncate_lines_p
20601 && it
->current_x
+ width
> it
->last_visible_x
)
20602 width
= it
->last_visible_x
- it
->current_x
- 1;
20604 if (width
> 0 && height
> 0 && it
->glyph_row
)
20606 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20607 if (!STRINGP (object
))
20608 object
= it
->w
->buffer
;
20609 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20612 it
->pixel_width
= width
;
20613 it
->ascent
= it
->phys_ascent
= ascent
;
20614 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20615 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20617 take_vertical_position_into_account (it
);
20620 /* Get line-height and line-spacing property at point.
20621 If line-height has format (HEIGHT TOTAL), return TOTAL
20622 in TOTAL_HEIGHT. */
20625 get_line_height_property (it
, prop
)
20629 Lisp_Object position
;
20631 if (STRINGP (it
->object
))
20632 position
= make_number (IT_STRING_CHARPOS (*it
));
20633 else if (BUFFERP (it
->object
))
20634 position
= make_number (IT_CHARPOS (*it
));
20638 return Fget_char_property (position
, prop
, it
->object
);
20641 /* Calculate line-height and line-spacing properties.
20642 An integer value specifies explicit pixel value.
20643 A float value specifies relative value to current face height.
20644 A cons (float . face-name) specifies relative value to
20645 height of specified face font.
20647 Returns height in pixels, or nil. */
20651 calc_line_height_property (it
, val
, font
, boff
, override
)
20655 int boff
, override
;
20657 Lisp_Object face_name
= Qnil
;
20658 int ascent
, descent
, height
;
20660 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
20665 face_name
= XCAR (val
);
20667 if (!NUMBERP (val
))
20668 val
= make_number (1);
20669 if (NILP (face_name
))
20671 height
= it
->ascent
+ it
->descent
;
20676 if (NILP (face_name
))
20678 font
= FRAME_FONT (it
->f
);
20679 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20681 else if (EQ (face_name
, Qt
))
20689 struct font_info
*font_info
;
20691 face_id
= lookup_named_face (it
->f
, face_name
, 0);
20693 return make_number (-1);
20695 face
= FACE_FROM_ID (it
->f
, face_id
);
20698 return make_number (-1);
20700 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
20701 boff
= font_info
->baseline_offset
;
20702 if (font_info
->vertical_centering
)
20703 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20706 ascent
= FONT_BASE (font
) + boff
;
20707 descent
= FONT_DESCENT (font
) - boff
;
20711 it
->override_ascent
= ascent
;
20712 it
->override_descent
= descent
;
20713 it
->override_boff
= boff
;
20716 height
= ascent
+ descent
;
20720 height
= (int)(XFLOAT_DATA (val
) * height
);
20721 else if (INTEGERP (val
))
20722 height
*= XINT (val
);
20724 return make_number (height
);
20729 Produce glyphs/get display metrics for the display element IT is
20730 loaded with. See the description of struct it in dispextern.h
20731 for an overview of struct it. */
20734 x_produce_glyphs (it
)
20737 int extra_line_spacing
= it
->extra_line_spacing
;
20739 it
->glyph_not_available_p
= 0;
20741 if (it
->what
== IT_CHARACTER
)
20745 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20747 int font_not_found_p
;
20748 struct font_info
*font_info
;
20749 int boff
; /* baseline offset */
20750 /* We may change it->multibyte_p upon unibyte<->multibyte
20751 conversion. So, save the current value now and restore it
20754 Note: It seems that we don't have to record multibyte_p in
20755 struct glyph because the character code itself tells if or
20756 not the character is multibyte. Thus, in the future, we must
20757 consider eliminating the field `multibyte_p' in the struct
20759 int saved_multibyte_p
= it
->multibyte_p
;
20761 /* Maybe translate single-byte characters to multibyte, or the
20763 it
->char_to_display
= it
->c
;
20764 if (!ASCII_BYTE_P (it
->c
)
20765 && ! it
->multibyte_p
)
20767 if (SINGLE_BYTE_CHAR_P (it
->c
)
20768 && unibyte_display_via_language_environment
)
20769 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20770 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
20772 it
->multibyte_p
= 1;
20773 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
20775 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20779 /* Get font to use. Encode IT->char_to_display. */
20780 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20781 &char2b
, it
->multibyte_p
, 0);
20784 /* When no suitable font found, use the default font. */
20785 font_not_found_p
= font
== NULL
;
20786 if (font_not_found_p
)
20788 font
= FRAME_FONT (it
->f
);
20789 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20794 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
20795 boff
= font_info
->baseline_offset
;
20796 if (font_info
->vertical_centering
)
20797 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20800 if (it
->char_to_display
>= ' '
20801 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
20803 /* Either unibyte or ASCII. */
20808 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
20809 FONT_TYPE_FOR_UNIBYTE (font
, it
->char_to_display
));
20811 if (it
->override_ascent
>= 0)
20813 it
->ascent
= it
->override_ascent
;
20814 it
->descent
= it
->override_descent
;
20815 boff
= it
->override_boff
;
20819 it
->ascent
= FONT_BASE (font
) + boff
;
20820 it
->descent
= FONT_DESCENT (font
) - boff
;
20825 it
->phys_ascent
= pcm
->ascent
+ boff
;
20826 it
->phys_descent
= pcm
->descent
- boff
;
20827 it
->pixel_width
= pcm
->width
;
20831 it
->glyph_not_available_p
= 1;
20832 it
->phys_ascent
= it
->ascent
;
20833 it
->phys_descent
= it
->descent
;
20834 it
->pixel_width
= FONT_WIDTH (font
);
20837 if (it
->constrain_row_ascent_descent_p
)
20839 if (it
->descent
> it
->max_descent
)
20841 it
->ascent
+= it
->descent
- it
->max_descent
;
20842 it
->descent
= it
->max_descent
;
20844 if (it
->ascent
> it
->max_ascent
)
20846 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20847 it
->ascent
= it
->max_ascent
;
20849 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20850 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20851 extra_line_spacing
= 0;
20854 /* If this is a space inside a region of text with
20855 `space-width' property, change its width. */
20856 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
20858 it
->pixel_width
*= XFLOATINT (it
->space_width
);
20860 /* If face has a box, add the box thickness to the character
20861 height. If character has a box line to the left and/or
20862 right, add the box line width to the character's width. */
20863 if (face
->box
!= FACE_NO_BOX
)
20865 int thick
= face
->box_line_width
;
20869 it
->ascent
+= thick
;
20870 it
->descent
+= thick
;
20875 if (it
->start_of_box_run_p
)
20876 it
->pixel_width
+= thick
;
20877 if (it
->end_of_box_run_p
)
20878 it
->pixel_width
+= thick
;
20881 /* If face has an overline, add the height of the overline
20882 (1 pixel) and a 1 pixel margin to the character height. */
20883 if (face
->overline_p
)
20884 it
->ascent
+= overline_margin
;
20886 if (it
->constrain_row_ascent_descent_p
)
20888 if (it
->ascent
> it
->max_ascent
)
20889 it
->ascent
= it
->max_ascent
;
20890 if (it
->descent
> it
->max_descent
)
20891 it
->descent
= it
->max_descent
;
20894 take_vertical_position_into_account (it
);
20896 /* If we have to actually produce glyphs, do it. */
20901 /* Translate a space with a `space-width' property
20902 into a stretch glyph. */
20903 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
20904 / FONT_HEIGHT (font
));
20905 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
20906 it
->ascent
+ it
->descent
, ascent
);
20911 /* If characters with lbearing or rbearing are displayed
20912 in this line, record that fact in a flag of the
20913 glyph row. This is used to optimize X output code. */
20914 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
20915 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
20918 else if (it
->char_to_display
== '\n')
20920 /* A newline has no width but we need the height of the line.
20921 But if previous part of the line set a height, don't
20922 increase that height */
20924 Lisp_Object height
;
20925 Lisp_Object total_height
= Qnil
;
20927 it
->override_ascent
= -1;
20928 it
->pixel_width
= 0;
20931 height
= get_line_height_property(it
, Qline_height
);
20932 /* Split (line-height total-height) list */
20934 && CONSP (XCDR (height
))
20935 && NILP (XCDR (XCDR (height
))))
20937 total_height
= XCAR (XCDR (height
));
20938 height
= XCAR (height
);
20940 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
20942 if (it
->override_ascent
>= 0)
20944 it
->ascent
= it
->override_ascent
;
20945 it
->descent
= it
->override_descent
;
20946 boff
= it
->override_boff
;
20950 it
->ascent
= FONT_BASE (font
) + boff
;
20951 it
->descent
= FONT_DESCENT (font
) - boff
;
20954 if (EQ (height
, Qt
))
20956 if (it
->descent
> it
->max_descent
)
20958 it
->ascent
+= it
->descent
- it
->max_descent
;
20959 it
->descent
= it
->max_descent
;
20961 if (it
->ascent
> it
->max_ascent
)
20963 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20964 it
->ascent
= it
->max_ascent
;
20966 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20967 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20968 it
->constrain_row_ascent_descent_p
= 1;
20969 extra_line_spacing
= 0;
20973 Lisp_Object spacing
;
20975 it
->phys_ascent
= it
->ascent
;
20976 it
->phys_descent
= it
->descent
;
20978 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
20979 && face
->box
!= FACE_NO_BOX
20980 && face
->box_line_width
> 0)
20982 it
->ascent
+= face
->box_line_width
;
20983 it
->descent
+= face
->box_line_width
;
20986 && XINT (height
) > it
->ascent
+ it
->descent
)
20987 it
->ascent
= XINT (height
) - it
->descent
;
20989 if (!NILP (total_height
))
20990 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
20993 spacing
= get_line_height_property(it
, Qline_spacing
);
20994 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
20996 if (INTEGERP (spacing
))
20998 extra_line_spacing
= XINT (spacing
);
20999 if (!NILP (total_height
))
21000 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21004 else if (it
->char_to_display
== '\t')
21006 int tab_width
= it
->tab_width
* FRAME_SPACE_WIDTH (it
->f
);
21007 int x
= it
->current_x
+ it
->continuation_lines_width
;
21008 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21010 /* If the distance from the current position to the next tab
21011 stop is less than a space character width, use the
21012 tab stop after that. */
21013 if (next_tab_x
- x
< FRAME_SPACE_WIDTH (it
->f
))
21014 next_tab_x
+= tab_width
;
21016 it
->pixel_width
= next_tab_x
- x
;
21018 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21019 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21023 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21024 it
->ascent
+ it
->descent
, it
->ascent
);
21029 /* A multi-byte character. Assume that the display width of the
21030 character is the width of the character multiplied by the
21031 width of the font. */
21033 /* If we found a font, this font should give us the right
21034 metrics. If we didn't find a font, use the frame's
21035 default font and calculate the width of the character by
21036 multiplying the width of font by the width of the
21039 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21040 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
));
21042 if (font_not_found_p
|| !pcm
)
21044 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21046 if (char_width
== 0)
21047 /* This is a non spacing character. But, as we are
21048 going to display an empty box, the box must occupy
21049 at least one column. */
21051 it
->glyph_not_available_p
= 1;
21052 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21053 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21054 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21058 it
->pixel_width
= pcm
->width
;
21059 it
->phys_ascent
= pcm
->ascent
+ boff
;
21060 it
->phys_descent
= pcm
->descent
- boff
;
21062 && (pcm
->lbearing
< 0
21063 || pcm
->rbearing
> pcm
->width
))
21064 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21067 it
->ascent
= FONT_BASE (font
) + boff
;
21068 it
->descent
= FONT_DESCENT (font
) - boff
;
21069 if (face
->box
!= FACE_NO_BOX
)
21071 int thick
= face
->box_line_width
;
21075 it
->ascent
+= thick
;
21076 it
->descent
+= thick
;
21081 if (it
->start_of_box_run_p
)
21082 it
->pixel_width
+= thick
;
21083 if (it
->end_of_box_run_p
)
21084 it
->pixel_width
+= thick
;
21087 /* If face has an overline, add the height of the overline
21088 (1 pixel) and a 1 pixel margin to the character height. */
21089 if (face
->overline_p
)
21090 it
->ascent
+= overline_margin
;
21092 take_vertical_position_into_account (it
);
21094 if (it
->ascent
< 0)
21096 if (it
->descent
< 0)
21102 it
->multibyte_p
= saved_multibyte_p
;
21104 else if (it
->what
== IT_COMPOSITION
)
21106 /* Note: A composition is represented as one glyph in the
21107 glyph matrix. There are no padding glyphs.
21109 Important is that pixel_width, ascent, and descent are the
21110 values of what is drawn by draw_glyphs (i.e. the values of
21111 the overall glyphs composed). */
21112 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21113 int boff
; /* baseline offset */
21114 struct composition
*cmp
= composition_table
[it
->cmp_id
];
21115 int glyph_len
= cmp
->glyph_len
;
21116 XFontStruct
*font
= face
->font
;
21120 #ifdef USE_FONT_BACKEND
21121 if (cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
21123 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21124 font_prepare_composition (cmp
, it
->f
);
21127 #endif /* USE_FONT_BACKEND */
21128 /* If we have not yet calculated pixel size data of glyphs of
21129 the composition for the current face font, calculate them
21130 now. Theoretically, we have to check all fonts for the
21131 glyphs, but that requires much time and memory space. So,
21132 here we check only the font of the first glyph. This leads
21133 to incorrect display, but it's very rare, and C-l (recenter)
21134 can correct the display anyway. */
21135 if (! cmp
->font
|| cmp
->font
!= font
)
21137 /* Ascent and descent of the font of the first character
21138 of this composition (adjusted by baseline offset).
21139 Ascent and descent of overall glyphs should not be less
21140 than them respectively. */
21141 int font_ascent
, font_descent
, font_height
;
21142 /* Bounding box of the overall glyphs. */
21143 int leftmost
, rightmost
, lowest
, highest
;
21144 int lbearing
, rbearing
;
21145 int i
, width
, ascent
, descent
;
21146 int left_padded
= 0, right_padded
= 0;
21151 int font_not_found_p
;
21152 struct font_info
*font_info
;
21155 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21156 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21158 if (glyph_len
< cmp
->glyph_len
)
21160 for (i
= 0; i
< glyph_len
; i
++)
21162 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21164 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21169 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21170 : IT_CHARPOS (*it
));
21171 /* When no suitable font found, use the default font. */
21172 font_not_found_p
= font
== NULL
;
21173 if (font_not_found_p
)
21175 face
= face
->ascii_face
;
21178 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
21179 boff
= font_info
->baseline_offset
;
21180 if (font_info
->vertical_centering
)
21181 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21182 font_ascent
= FONT_BASE (font
) + boff
;
21183 font_descent
= FONT_DESCENT (font
) - boff
;
21184 font_height
= FONT_HEIGHT (font
);
21186 cmp
->font
= (void *) font
;
21189 if (! font_not_found_p
)
21191 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21192 &char2b
, it
->multibyte_p
, 0);
21193 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21194 FONT_TYPE_FOR_MULTIBYTE (font
, c
));
21197 /* Initialize the bounding box. */
21200 width
= pcm
->width
;
21201 ascent
= pcm
->ascent
;
21202 descent
= pcm
->descent
;
21203 lbearing
= pcm
->lbearing
;
21204 rbearing
= pcm
->rbearing
;
21208 width
= FONT_WIDTH (font
);
21209 ascent
= FONT_BASE (font
);
21210 descent
= FONT_DESCENT (font
);
21217 lowest
= - descent
+ boff
;
21218 highest
= ascent
+ boff
;
21220 if (! font_not_found_p
21221 && font_info
->default_ascent
21222 && CHAR_TABLE_P (Vuse_default_ascent
)
21223 && !NILP (Faref (Vuse_default_ascent
,
21224 make_number (it
->char_to_display
))))
21225 highest
= font_info
->default_ascent
+ boff
;
21227 /* Draw the first glyph at the normal position. It may be
21228 shifted to right later if some other glyphs are drawn
21230 cmp
->offsets
[i
* 2] = 0;
21231 cmp
->offsets
[i
* 2 + 1] = boff
;
21232 cmp
->lbearing
= lbearing
;
21233 cmp
->rbearing
= rbearing
;
21235 /* Set cmp->offsets for the remaining glyphs. */
21236 for (i
++; i
< glyph_len
; i
++)
21238 int left
, right
, btm
, top
;
21239 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21241 struct face
*this_face
;
21246 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21247 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21248 font
= this_face
->font
;
21254 font_info
= FONT_INFO_FROM_FACE (it
->f
, this_face
);
21255 this_boff
= font_info
->baseline_offset
;
21256 if (font_info
->vertical_centering
)
21257 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21258 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21259 &char2b
, it
->multibyte_p
, 0);
21260 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21261 FONT_TYPE_FOR_MULTIBYTE (font
,
21265 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21268 width
= pcm
->width
;
21269 ascent
= pcm
->ascent
;
21270 descent
= pcm
->descent
;
21271 lbearing
= pcm
->lbearing
;
21272 rbearing
= pcm
->rbearing
;
21273 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21275 /* Relative composition with or without
21276 alternate chars. */
21277 left
= (leftmost
+ rightmost
- width
) / 2;
21278 btm
= - descent
+ boff
;
21279 if (font_info
->relative_compose
21280 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21281 || NILP (Faref (Vignore_relative_composition
,
21282 make_number (ch
)))))
21285 if (- descent
>= font_info
->relative_compose
)
21286 /* One extra pixel between two glyphs. */
21288 else if (ascent
<= 0)
21289 /* One extra pixel between two glyphs. */
21290 btm
= lowest
- 1 - ascent
- descent
;
21295 /* A composition rule is specified by an integer
21296 value that encodes global and new reference
21297 points (GREF and NREF). GREF and NREF are
21298 specified by numbers as below:
21300 0---1---2 -- ascent
21304 9--10--11 -- center
21306 ---3---4---5--- baseline
21308 6---7---8 -- descent
21310 int rule
= COMPOSITION_RULE (cmp
, i
);
21311 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21313 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21314 grefx
= gref
% 3, nrefx
= nref
% 3;
21315 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21317 xoff
= font_height
* (xoff
- 128) / 256;
21319 yoff
= font_height
* (yoff
- 128) / 256;
21322 + grefx
* (rightmost
- leftmost
) / 2
21323 - nrefx
* width
/ 2
21326 btm
= ((grefy
== 0 ? highest
21328 : grefy
== 2 ? lowest
21329 : (highest
+ lowest
) / 2)
21330 - (nrefy
== 0 ? ascent
+ descent
21331 : nrefy
== 1 ? descent
- boff
21333 : (ascent
+ descent
) / 2)
21337 cmp
->offsets
[i
* 2] = left
;
21338 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21340 /* Update the bounding box of the overall glyphs. */
21343 right
= left
+ width
;
21344 if (left
< leftmost
)
21346 if (right
> rightmost
)
21349 top
= btm
+ descent
+ ascent
;
21355 if (cmp
->lbearing
> left
+ lbearing
)
21356 cmp
->lbearing
= left
+ lbearing
;
21357 if (cmp
->rbearing
< left
+ rbearing
)
21358 cmp
->rbearing
= left
+ rbearing
;
21362 /* If there are glyphs whose x-offsets are negative,
21363 shift all glyphs to the right and make all x-offsets
21367 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21368 cmp
->offsets
[i
* 2] -= leftmost
;
21369 rightmost
-= leftmost
;
21370 cmp
->lbearing
-= leftmost
;
21371 cmp
->rbearing
-= leftmost
;
21374 if (left_padded
&& cmp
->lbearing
< 0)
21376 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21377 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21378 rightmost
-= cmp
->lbearing
;
21379 cmp
->rbearing
-= cmp
->lbearing
;
21382 if (right_padded
&& rightmost
< cmp
->rbearing
)
21384 rightmost
= cmp
->rbearing
;
21387 cmp
->pixel_width
= rightmost
;
21388 cmp
->ascent
= highest
;
21389 cmp
->descent
= - lowest
;
21390 if (cmp
->ascent
< font_ascent
)
21391 cmp
->ascent
= font_ascent
;
21392 if (cmp
->descent
< font_descent
)
21393 cmp
->descent
= font_descent
;
21397 && (cmp
->lbearing
< 0
21398 || cmp
->rbearing
> cmp
->pixel_width
))
21399 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21401 it
->pixel_width
= cmp
->pixel_width
;
21402 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21403 it
->descent
= it
->phys_descent
= cmp
->descent
;
21404 if (face
->box
!= FACE_NO_BOX
)
21406 int thick
= face
->box_line_width
;
21410 it
->ascent
+= thick
;
21411 it
->descent
+= thick
;
21416 if (it
->start_of_box_run_p
)
21417 it
->pixel_width
+= thick
;
21418 if (it
->end_of_box_run_p
)
21419 it
->pixel_width
+= thick
;
21422 /* If face has an overline, add the height of the overline
21423 (1 pixel) and a 1 pixel margin to the character height. */
21424 if (face
->overline_p
)
21425 it
->ascent
+= overline_margin
;
21427 take_vertical_position_into_account (it
);
21428 if (it
->ascent
< 0)
21430 if (it
->descent
< 0)
21434 append_composite_glyph (it
);
21436 else if (it
->what
== IT_IMAGE
)
21437 produce_image_glyph (it
);
21438 else if (it
->what
== IT_STRETCH
)
21439 produce_stretch_glyph (it
);
21441 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21442 because this isn't true for images with `:ascent 100'. */
21443 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21444 if (it
->area
== TEXT_AREA
)
21445 it
->current_x
+= it
->pixel_width
;
21447 if (extra_line_spacing
> 0)
21449 it
->descent
+= extra_line_spacing
;
21450 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21451 it
->max_extra_line_spacing
= extra_line_spacing
;
21454 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21455 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21456 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21457 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21461 Output LEN glyphs starting at START at the nominal cursor position.
21462 Advance the nominal cursor over the text. The global variable
21463 updated_window contains the window being updated, updated_row is
21464 the glyph row being updated, and updated_area is the area of that
21465 row being updated. */
21468 x_write_glyphs (start
, len
)
21469 struct glyph
*start
;
21474 xassert (updated_window
&& updated_row
);
21477 /* Write glyphs. */
21479 hpos
= start
- updated_row
->glyphs
[updated_area
];
21480 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21481 updated_row
, updated_area
,
21483 DRAW_NORMAL_TEXT
, 0);
21485 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21486 if (updated_area
== TEXT_AREA
21487 && updated_window
->phys_cursor_on_p
21488 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21489 && updated_window
->phys_cursor
.hpos
>= hpos
21490 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21491 updated_window
->phys_cursor_on_p
= 0;
21495 /* Advance the output cursor. */
21496 output_cursor
.hpos
+= len
;
21497 output_cursor
.x
= x
;
21502 Insert LEN glyphs from START at the nominal cursor position. */
21505 x_insert_glyphs (start
, len
)
21506 struct glyph
*start
;
21511 int line_height
, shift_by_width
, shifted_region_width
;
21512 struct glyph_row
*row
;
21513 struct glyph
*glyph
;
21514 int frame_x
, frame_y
;
21517 xassert (updated_window
&& updated_row
);
21519 w
= updated_window
;
21520 f
= XFRAME (WINDOW_FRAME (w
));
21522 /* Get the height of the line we are in. */
21524 line_height
= row
->height
;
21526 /* Get the width of the glyphs to insert. */
21527 shift_by_width
= 0;
21528 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21529 shift_by_width
+= glyph
->pixel_width
;
21531 /* Get the width of the region to shift right. */
21532 shifted_region_width
= (window_box_width (w
, updated_area
)
21537 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21538 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21540 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21541 line_height
, shift_by_width
);
21543 /* Write the glyphs. */
21544 hpos
= start
- row
->glyphs
[updated_area
];
21545 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21547 DRAW_NORMAL_TEXT
, 0);
21549 /* Advance the output cursor. */
21550 output_cursor
.hpos
+= len
;
21551 output_cursor
.x
+= shift_by_width
;
21557 Erase the current text line from the nominal cursor position
21558 (inclusive) to pixel column TO_X (exclusive). The idea is that
21559 everything from TO_X onward is already erased.
21561 TO_X is a pixel position relative to updated_area of
21562 updated_window. TO_X == -1 means clear to the end of this area. */
21565 x_clear_end_of_line (to_x
)
21569 struct window
*w
= updated_window
;
21570 int max_x
, min_y
, max_y
;
21571 int from_x
, from_y
, to_y
;
21573 xassert (updated_window
&& updated_row
);
21574 f
= XFRAME (w
->frame
);
21576 if (updated_row
->full_width_p
)
21577 max_x
= WINDOW_TOTAL_WIDTH (w
);
21579 max_x
= window_box_width (w
, updated_area
);
21580 max_y
= window_text_bottom_y (w
);
21582 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21583 of window. For TO_X > 0, truncate to end of drawing area. */
21589 to_x
= min (to_x
, max_x
);
21591 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21593 /* Notice if the cursor will be cleared by this operation. */
21594 if (!updated_row
->full_width_p
)
21595 notice_overwritten_cursor (w
, updated_area
,
21596 output_cursor
.x
, -1,
21598 MATRIX_ROW_BOTTOM_Y (updated_row
));
21600 from_x
= output_cursor
.x
;
21602 /* Translate to frame coordinates. */
21603 if (updated_row
->full_width_p
)
21605 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21606 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
21610 int area_left
= window_box_left (w
, updated_area
);
21611 from_x
+= area_left
;
21615 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
21616 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
21617 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
21619 /* Prevent inadvertently clearing to end of the X window. */
21620 if (to_x
> from_x
&& to_y
> from_y
)
21623 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
21624 to_x
- from_x
, to_y
- from_y
);
21629 #endif /* HAVE_WINDOW_SYSTEM */
21633 /***********************************************************************
21635 ***********************************************************************/
21637 /* Value is the internal representation of the specified cursor type
21638 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
21639 of the bar cursor. */
21641 static enum text_cursor_kinds
21642 get_specified_cursor_type (arg
, width
)
21646 enum text_cursor_kinds type
;
21651 if (EQ (arg
, Qbox
))
21652 return FILLED_BOX_CURSOR
;
21654 if (EQ (arg
, Qhollow
))
21655 return HOLLOW_BOX_CURSOR
;
21657 if (EQ (arg
, Qbar
))
21664 && EQ (XCAR (arg
), Qbar
)
21665 && INTEGERP (XCDR (arg
))
21666 && XINT (XCDR (arg
)) >= 0)
21668 *width
= XINT (XCDR (arg
));
21672 if (EQ (arg
, Qhbar
))
21675 return HBAR_CURSOR
;
21679 && EQ (XCAR (arg
), Qhbar
)
21680 && INTEGERP (XCDR (arg
))
21681 && XINT (XCDR (arg
)) >= 0)
21683 *width
= XINT (XCDR (arg
));
21684 return HBAR_CURSOR
;
21687 /* Treat anything unknown as "hollow box cursor".
21688 It was bad to signal an error; people have trouble fixing
21689 .Xdefaults with Emacs, when it has something bad in it. */
21690 type
= HOLLOW_BOX_CURSOR
;
21695 /* Set the default cursor types for specified frame. */
21697 set_frame_cursor_types (f
, arg
)
21704 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
21705 FRAME_CURSOR_WIDTH (f
) = width
;
21707 /* By default, set up the blink-off state depending on the on-state. */
21709 tem
= Fassoc (arg
, Vblink_cursor_alist
);
21712 FRAME_BLINK_OFF_CURSOR (f
)
21713 = get_specified_cursor_type (XCDR (tem
), &width
);
21714 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
21717 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
21721 /* Return the cursor we want to be displayed in window W. Return
21722 width of bar/hbar cursor through WIDTH arg. Return with
21723 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
21724 (i.e. if the `system caret' should track this cursor).
21726 In a mini-buffer window, we want the cursor only to appear if we
21727 are reading input from this window. For the selected window, we
21728 want the cursor type given by the frame parameter or buffer local
21729 setting of cursor-type. If explicitly marked off, draw no cursor.
21730 In all other cases, we want a hollow box cursor. */
21732 static enum text_cursor_kinds
21733 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
21735 struct glyph
*glyph
;
21737 int *active_cursor
;
21739 struct frame
*f
= XFRAME (w
->frame
);
21740 struct buffer
*b
= XBUFFER (w
->buffer
);
21741 int cursor_type
= DEFAULT_CURSOR
;
21742 Lisp_Object alt_cursor
;
21743 int non_selected
= 0;
21745 *active_cursor
= 1;
21748 if (cursor_in_echo_area
21749 && FRAME_HAS_MINIBUF_P (f
)
21750 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
21752 if (w
== XWINDOW (echo_area_window
))
21754 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
21756 *width
= FRAME_CURSOR_WIDTH (f
);
21757 return FRAME_DESIRED_CURSOR (f
);
21760 return get_specified_cursor_type (b
->cursor_type
, width
);
21763 *active_cursor
= 0;
21767 /* Detect a nonselected window or nonselected frame. */
21768 else if (w
!= XWINDOW (f
->selected_window
)
21769 #ifdef HAVE_WINDOW_SYSTEM
21770 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
21774 *active_cursor
= 0;
21776 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
21782 /* Never display a cursor in a window in which cursor-type is nil. */
21783 if (NILP (b
->cursor_type
))
21786 /* Get the normal cursor type for this window. */
21787 if (EQ (b
->cursor_type
, Qt
))
21789 cursor_type
= FRAME_DESIRED_CURSOR (f
);
21790 *width
= FRAME_CURSOR_WIDTH (f
);
21793 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
21795 /* Use cursor-in-non-selected-windows instead
21796 for non-selected window or frame. */
21799 alt_cursor
= b
->cursor_in_non_selected_windows
;
21800 if (!EQ (Qt
, alt_cursor
))
21801 return get_specified_cursor_type (alt_cursor
, width
);
21802 /* t means modify the normal cursor type. */
21803 if (cursor_type
== FILLED_BOX_CURSOR
)
21804 cursor_type
= HOLLOW_BOX_CURSOR
;
21805 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
21807 return cursor_type
;
21810 /* Use normal cursor if not blinked off. */
21811 if (!w
->cursor_off_p
)
21813 #ifdef HAVE_WINDOW_SYSTEM
21814 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
21816 if (cursor_type
== FILLED_BOX_CURSOR
)
21818 /* Using a block cursor on large images can be very annoying.
21819 So use a hollow cursor for "large" images.
21820 If image is not transparent (no mask), also use hollow cursor. */
21821 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
21822 if (img
!= NULL
&& IMAGEP (img
->spec
))
21824 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
21825 where N = size of default frame font size.
21826 This should cover most of the "tiny" icons people may use. */
21828 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
21829 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
21830 cursor_type
= HOLLOW_BOX_CURSOR
;
21833 else if (cursor_type
!= NO_CURSOR
)
21835 /* Display current only supports BOX and HOLLOW cursors for images.
21836 So for now, unconditionally use a HOLLOW cursor when cursor is
21837 not a solid box cursor. */
21838 cursor_type
= HOLLOW_BOX_CURSOR
;
21842 return cursor_type
;
21845 /* Cursor is blinked off, so determine how to "toggle" it. */
21847 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
21848 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
21849 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
21851 /* Then see if frame has specified a specific blink off cursor type. */
21852 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
21854 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
21855 return FRAME_BLINK_OFF_CURSOR (f
);
21859 /* Some people liked having a permanently visible blinking cursor,
21860 while others had very strong opinions against it. So it was
21861 decided to remove it. KFS 2003-09-03 */
21863 /* Finally perform built-in cursor blinking:
21864 filled box <-> hollow box
21865 wide [h]bar <-> narrow [h]bar
21866 narrow [h]bar <-> no cursor
21867 other type <-> no cursor */
21869 if (cursor_type
== FILLED_BOX_CURSOR
)
21870 return HOLLOW_BOX_CURSOR
;
21872 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
21875 return cursor_type
;
21883 #ifdef HAVE_WINDOW_SYSTEM
21885 /* Notice when the text cursor of window W has been completely
21886 overwritten by a drawing operation that outputs glyphs in AREA
21887 starting at X0 and ending at X1 in the line starting at Y0 and
21888 ending at Y1. X coordinates are area-relative. X1 < 0 means all
21889 the rest of the line after X0 has been written. Y coordinates
21890 are window-relative. */
21893 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
21895 enum glyph_row_area area
;
21896 int x0
, y0
, x1
, y1
;
21898 int cx0
, cx1
, cy0
, cy1
;
21899 struct glyph_row
*row
;
21901 if (!w
->phys_cursor_on_p
)
21903 if (area
!= TEXT_AREA
)
21906 if (w
->phys_cursor
.vpos
< 0
21907 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
21908 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
21909 !(row
->enabled_p
&& row
->displays_text_p
)))
21912 if (row
->cursor_in_fringe_p
)
21914 row
->cursor_in_fringe_p
= 0;
21915 draw_fringe_bitmap (w
, row
, 0);
21916 w
->phys_cursor_on_p
= 0;
21920 cx0
= w
->phys_cursor
.x
;
21921 cx1
= cx0
+ w
->phys_cursor_width
;
21922 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
21925 /* The cursor image will be completely removed from the
21926 screen if the output area intersects the cursor area in
21927 y-direction. When we draw in [y0 y1[, and some part of
21928 the cursor is at y < y0, that part must have been drawn
21929 before. When scrolling, the cursor is erased before
21930 actually scrolling, so we don't come here. When not
21931 scrolling, the rows above the old cursor row must have
21932 changed, and in this case these rows must have written
21933 over the cursor image.
21935 Likewise if part of the cursor is below y1, with the
21936 exception of the cursor being in the first blank row at
21937 the buffer and window end because update_text_area
21938 doesn't draw that row. (Except when it does, but
21939 that's handled in update_text_area.) */
21941 cy0
= w
->phys_cursor
.y
;
21942 cy1
= cy0
+ w
->phys_cursor_height
;
21943 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
21946 w
->phys_cursor_on_p
= 0;
21949 #endif /* HAVE_WINDOW_SYSTEM */
21952 /************************************************************************
21954 ************************************************************************/
21956 #ifdef HAVE_WINDOW_SYSTEM
21959 Fix the display of area AREA of overlapping row ROW in window W
21960 with respect to the overlapping part OVERLAPS. */
21963 x_fix_overlapping_area (w
, row
, area
, overlaps
)
21965 struct glyph_row
*row
;
21966 enum glyph_row_area area
;
21974 for (i
= 0; i
< row
->used
[area
];)
21976 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
21978 int start
= i
, start_x
= x
;
21982 x
+= row
->glyphs
[area
][i
].pixel_width
;
21985 while (i
< row
->used
[area
]
21986 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
21988 draw_glyphs (w
, start_x
, row
, area
,
21990 DRAW_NORMAL_TEXT
, overlaps
);
21994 x
+= row
->glyphs
[area
][i
].pixel_width
;
22004 Draw the cursor glyph of window W in glyph row ROW. See the
22005 comment of draw_glyphs for the meaning of HL. */
22008 draw_phys_cursor_glyph (w
, row
, hl
)
22010 struct glyph_row
*row
;
22011 enum draw_glyphs_face hl
;
22013 /* If cursor hpos is out of bounds, don't draw garbage. This can
22014 happen in mini-buffer windows when switching between echo area
22015 glyphs and mini-buffer. */
22016 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22018 int on_p
= w
->phys_cursor_on_p
;
22020 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22021 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22023 w
->phys_cursor_on_p
= on_p
;
22025 if (hl
== DRAW_CURSOR
)
22026 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22027 /* When we erase the cursor, and ROW is overlapped by other
22028 rows, make sure that these overlapping parts of other rows
22030 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22032 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22034 if (row
> w
->current_matrix
->rows
22035 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22036 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22037 OVERLAPS_ERASED_CURSOR
);
22039 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22040 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22041 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22042 OVERLAPS_ERASED_CURSOR
);
22049 Erase the image of a cursor of window W from the screen. */
22052 erase_phys_cursor (w
)
22055 struct frame
*f
= XFRAME (w
->frame
);
22056 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22057 int hpos
= w
->phys_cursor
.hpos
;
22058 int vpos
= w
->phys_cursor
.vpos
;
22059 int mouse_face_here_p
= 0;
22060 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22061 struct glyph_row
*cursor_row
;
22062 struct glyph
*cursor_glyph
;
22063 enum draw_glyphs_face hl
;
22065 /* No cursor displayed or row invalidated => nothing to do on the
22067 if (w
->phys_cursor_type
== NO_CURSOR
)
22068 goto mark_cursor_off
;
22070 /* VPOS >= active_glyphs->nrows means that window has been resized.
22071 Don't bother to erase the cursor. */
22072 if (vpos
>= active_glyphs
->nrows
)
22073 goto mark_cursor_off
;
22075 /* If row containing cursor is marked invalid, there is nothing we
22077 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22078 if (!cursor_row
->enabled_p
)
22079 goto mark_cursor_off
;
22081 /* If line spacing is > 0, old cursor may only be partially visible in
22082 window after split-window. So adjust visible height. */
22083 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22084 window_text_bottom_y (w
) - cursor_row
->y
);
22086 /* If row is completely invisible, don't attempt to delete a cursor which
22087 isn't there. This can happen if cursor is at top of a window, and
22088 we switch to a buffer with a header line in that window. */
22089 if (cursor_row
->visible_height
<= 0)
22090 goto mark_cursor_off
;
22092 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22093 if (cursor_row
->cursor_in_fringe_p
)
22095 cursor_row
->cursor_in_fringe_p
= 0;
22096 draw_fringe_bitmap (w
, cursor_row
, 0);
22097 goto mark_cursor_off
;
22100 /* This can happen when the new row is shorter than the old one.
22101 In this case, either draw_glyphs or clear_end_of_line
22102 should have cleared the cursor. Note that we wouldn't be
22103 able to erase the cursor in this case because we don't have a
22104 cursor glyph at hand. */
22105 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22106 goto mark_cursor_off
;
22108 /* If the cursor is in the mouse face area, redisplay that when
22109 we clear the cursor. */
22110 if (! NILP (dpyinfo
->mouse_face_window
)
22111 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22112 && (vpos
> dpyinfo
->mouse_face_beg_row
22113 || (vpos
== dpyinfo
->mouse_face_beg_row
22114 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22115 && (vpos
< dpyinfo
->mouse_face_end_row
22116 || (vpos
== dpyinfo
->mouse_face_end_row
22117 && hpos
< dpyinfo
->mouse_face_end_col
))
22118 /* Don't redraw the cursor's spot in mouse face if it is at the
22119 end of a line (on a newline). The cursor appears there, but
22120 mouse highlighting does not. */
22121 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22122 mouse_face_here_p
= 1;
22124 /* Maybe clear the display under the cursor. */
22125 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22128 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22131 cursor_glyph
= get_phys_cursor_glyph (w
);
22132 if (cursor_glyph
== NULL
)
22133 goto mark_cursor_off
;
22135 width
= cursor_glyph
->pixel_width
;
22136 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22137 x
= w
->phys_cursor
.x
;
22139 width
-= left_x
- x
;
22140 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22141 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22142 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22145 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22148 /* Erase the cursor by redrawing the character underneath it. */
22149 if (mouse_face_here_p
)
22150 hl
= DRAW_MOUSE_FACE
;
22152 hl
= DRAW_NORMAL_TEXT
;
22153 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22156 w
->phys_cursor_on_p
= 0;
22157 w
->phys_cursor_type
= NO_CURSOR
;
22162 Display or clear cursor of window W. If ON is zero, clear the
22163 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22164 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22167 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22169 int on
, hpos
, vpos
, x
, y
;
22171 struct frame
*f
= XFRAME (w
->frame
);
22172 int new_cursor_type
;
22173 int new_cursor_width
;
22175 struct glyph_row
*glyph_row
;
22176 struct glyph
*glyph
;
22178 /* This is pointless on invisible frames, and dangerous on garbaged
22179 windows and frames; in the latter case, the frame or window may
22180 be in the midst of changing its size, and x and y may be off the
22182 if (! FRAME_VISIBLE_P (f
)
22183 || FRAME_GARBAGED_P (f
)
22184 || vpos
>= w
->current_matrix
->nrows
22185 || hpos
>= w
->current_matrix
->matrix_w
)
22188 /* If cursor is off and we want it off, return quickly. */
22189 if (!on
&& !w
->phys_cursor_on_p
)
22192 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22193 /* If cursor row is not enabled, we don't really know where to
22194 display the cursor. */
22195 if (!glyph_row
->enabled_p
)
22197 w
->phys_cursor_on_p
= 0;
22202 if (!glyph_row
->exact_window_width_line_p
22203 || hpos
< glyph_row
->used
[TEXT_AREA
])
22204 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22206 xassert (interrupt_input_blocked
);
22208 /* Set new_cursor_type to the cursor we want to be displayed. */
22209 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22210 &new_cursor_width
, &active_cursor
);
22212 /* If cursor is currently being shown and we don't want it to be or
22213 it is in the wrong place, or the cursor type is not what we want,
22215 if (w
->phys_cursor_on_p
22217 || w
->phys_cursor
.x
!= x
22218 || w
->phys_cursor
.y
!= y
22219 || new_cursor_type
!= w
->phys_cursor_type
22220 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22221 && new_cursor_width
!= w
->phys_cursor_width
)))
22222 erase_phys_cursor (w
);
22224 /* Don't check phys_cursor_on_p here because that flag is only set
22225 to zero in some cases where we know that the cursor has been
22226 completely erased, to avoid the extra work of erasing the cursor
22227 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22228 still not be visible, or it has only been partly erased. */
22231 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22232 w
->phys_cursor_height
= glyph_row
->height
;
22234 /* Set phys_cursor_.* before x_draw_.* is called because some
22235 of them may need the information. */
22236 w
->phys_cursor
.x
= x
;
22237 w
->phys_cursor
.y
= glyph_row
->y
;
22238 w
->phys_cursor
.hpos
= hpos
;
22239 w
->phys_cursor
.vpos
= vpos
;
22242 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22243 new_cursor_type
, new_cursor_width
,
22244 on
, active_cursor
);
22248 /* Switch the display of W's cursor on or off, according to the value
22252 update_window_cursor (w
, on
)
22256 /* Don't update cursor in windows whose frame is in the process
22257 of being deleted. */
22258 if (w
->current_matrix
)
22261 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22262 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22268 /* Call update_window_cursor with parameter ON_P on all leaf windows
22269 in the window tree rooted at W. */
22272 update_cursor_in_window_tree (w
, on_p
)
22278 if (!NILP (w
->hchild
))
22279 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22280 else if (!NILP (w
->vchild
))
22281 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22283 update_window_cursor (w
, on_p
);
22285 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22291 Display the cursor on window W, or clear it, according to ON_P.
22292 Don't change the cursor's position. */
22295 x_update_cursor (f
, on_p
)
22299 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22304 Clear the cursor of window W to background color, and mark the
22305 cursor as not shown. This is used when the text where the cursor
22306 is is about to be rewritten. */
22312 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22313 update_window_cursor (w
, 0);
22318 Display the active region described by mouse_face_* according to DRAW. */
22321 show_mouse_face (dpyinfo
, draw
)
22322 Display_Info
*dpyinfo
;
22323 enum draw_glyphs_face draw
;
22325 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22326 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22328 if (/* If window is in the process of being destroyed, don't bother
22330 w
->current_matrix
!= NULL
22331 /* Don't update mouse highlight if hidden */
22332 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22333 /* Recognize when we are called to operate on rows that don't exist
22334 anymore. This can happen when a window is split. */
22335 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22337 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22338 struct glyph_row
*row
, *first
, *last
;
22340 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22341 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22343 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22345 int start_hpos
, end_hpos
, start_x
;
22347 /* For all but the first row, the highlight starts at column 0. */
22350 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22351 start_x
= dpyinfo
->mouse_face_beg_x
;
22360 end_hpos
= dpyinfo
->mouse_face_end_col
;
22363 end_hpos
= row
->used
[TEXT_AREA
];
22364 if (draw
== DRAW_NORMAL_TEXT
)
22365 row
->fill_line_p
= 1; /* Clear to end of line */
22368 if (end_hpos
> start_hpos
)
22370 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22371 start_hpos
, end_hpos
,
22375 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22379 /* When we've written over the cursor, arrange for it to
22380 be displayed again. */
22381 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22384 display_and_set_cursor (w
, 1,
22385 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22386 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22391 /* Change the mouse cursor. */
22392 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22393 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22394 else if (draw
== DRAW_MOUSE_FACE
)
22395 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22397 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22401 Clear out the mouse-highlighted active region.
22402 Redraw it un-highlighted first. Value is non-zero if mouse
22403 face was actually drawn unhighlighted. */
22406 clear_mouse_face (dpyinfo
)
22407 Display_Info
*dpyinfo
;
22411 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22413 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22417 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22418 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22419 dpyinfo
->mouse_face_window
= Qnil
;
22420 dpyinfo
->mouse_face_overlay
= Qnil
;
22426 Non-zero if physical cursor of window W is within mouse face. */
22429 cursor_in_mouse_face_p (w
)
22432 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22433 int in_mouse_face
= 0;
22435 if (WINDOWP (dpyinfo
->mouse_face_window
)
22436 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22438 int hpos
= w
->phys_cursor
.hpos
;
22439 int vpos
= w
->phys_cursor
.vpos
;
22441 if (vpos
>= dpyinfo
->mouse_face_beg_row
22442 && vpos
<= dpyinfo
->mouse_face_end_row
22443 && (vpos
> dpyinfo
->mouse_face_beg_row
22444 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22445 && (vpos
< dpyinfo
->mouse_face_end_row
22446 || hpos
< dpyinfo
->mouse_face_end_col
22447 || dpyinfo
->mouse_face_past_end
))
22451 return in_mouse_face
;
22457 /* Find the glyph matrix position of buffer position CHARPOS in window
22458 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22459 current glyphs must be up to date. If CHARPOS is above window
22460 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22461 of last line in W. In the row containing CHARPOS, stop before glyphs
22462 having STOP as object. */
22464 #if 1 /* This is a version of fast_find_position that's more correct
22465 in the presence of hscrolling, for example. I didn't install
22466 it right away because the problem fixed is minor, it failed
22467 in 20.x as well, and I think it's too risky to install
22468 so near the release of 21.1. 2001-09-25 gerd. */
22471 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22474 int *hpos
, *vpos
, *x
, *y
;
22477 struct glyph_row
*row
, *first
;
22478 struct glyph
*glyph
, *end
;
22481 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22482 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22487 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22491 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22494 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22498 /* If whole rows or last part of a row came from a display overlay,
22499 row_containing_pos will skip over such rows because their end pos
22500 equals the start pos of the overlay or interval.
22502 Move back if we have a STOP object and previous row's
22503 end glyph came from STOP. */
22506 struct glyph_row
*prev
;
22507 while ((prev
= row
- 1, prev
>= first
)
22508 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22509 && prev
->used
[TEXT_AREA
] > 0)
22511 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22512 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22513 while (--glyph
>= beg
22514 && INTEGERP (glyph
->object
));
22516 || !EQ (stop
, glyph
->object
))
22524 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22526 glyph
= row
->glyphs
[TEXT_AREA
];
22527 end
= glyph
+ row
->used
[TEXT_AREA
];
22529 /* Skip over glyphs not having an object at the start of the row.
22530 These are special glyphs like truncation marks on terminal
22532 if (row
->displays_text_p
)
22534 && INTEGERP (glyph
->object
)
22535 && !EQ (stop
, glyph
->object
)
22536 && glyph
->charpos
< 0)
22538 *x
+= glyph
->pixel_width
;
22543 && !INTEGERP (glyph
->object
)
22544 && !EQ (stop
, glyph
->object
)
22545 && (!BUFFERP (glyph
->object
)
22546 || glyph
->charpos
< charpos
))
22548 *x
+= glyph
->pixel_width
;
22552 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22559 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22562 int *hpos
, *vpos
, *x
, *y
;
22567 int maybe_next_line_p
= 0;
22568 int line_start_position
;
22569 int yb
= window_text_bottom_y (w
);
22570 struct glyph_row
*row
, *best_row
;
22571 int row_vpos
, best_row_vpos
;
22574 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22575 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22577 while (row
->y
< yb
)
22579 if (row
->used
[TEXT_AREA
])
22580 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
22582 line_start_position
= 0;
22584 if (line_start_position
> pos
)
22586 /* If the position sought is the end of the buffer,
22587 don't include the blank lines at the bottom of the window. */
22588 else if (line_start_position
== pos
22589 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
22591 maybe_next_line_p
= 1;
22594 else if (line_start_position
> 0)
22597 best_row_vpos
= row_vpos
;
22600 if (row
->y
+ row
->height
>= yb
)
22607 /* Find the right column within BEST_ROW. */
22609 current_x
= best_row
->x
;
22610 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
22612 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
22613 int charpos
= glyph
->charpos
;
22615 if (BUFFERP (glyph
->object
))
22617 if (charpos
== pos
)
22620 *vpos
= best_row_vpos
;
22625 else if (charpos
> pos
)
22628 else if (EQ (glyph
->object
, stop
))
22633 current_x
+= glyph
->pixel_width
;
22636 /* If we're looking for the end of the buffer,
22637 and we didn't find it in the line we scanned,
22638 use the start of the following line. */
22639 if (maybe_next_line_p
)
22644 current_x
= best_row
->x
;
22647 *vpos
= best_row_vpos
;
22648 *hpos
= lastcol
+ 1;
22657 /* Find the position of the glyph for position POS in OBJECT in
22658 window W's current matrix, and return in *X, *Y the pixel
22659 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
22661 RIGHT_P non-zero means return the position of the right edge of the
22662 glyph, RIGHT_P zero means return the left edge position.
22664 If no glyph for POS exists in the matrix, return the position of
22665 the glyph with the next smaller position that is in the matrix, if
22666 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
22667 exists in the matrix, return the position of the glyph with the
22668 next larger position in OBJECT.
22670 Value is non-zero if a glyph was found. */
22673 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
22676 Lisp_Object object
;
22677 int *hpos
, *vpos
, *x
, *y
;
22680 int yb
= window_text_bottom_y (w
);
22681 struct glyph_row
*r
;
22682 struct glyph
*best_glyph
= NULL
;
22683 struct glyph_row
*best_row
= NULL
;
22686 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22687 r
->enabled_p
&& r
->y
< yb
;
22690 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
22691 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
22694 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
22695 if (EQ (g
->object
, object
))
22697 if (g
->charpos
== pos
)
22704 else if (best_glyph
== NULL
22705 || ((eabs (g
->charpos
- pos
)
22706 < eabs (best_glyph
->charpos
- pos
))
22709 : g
->charpos
> pos
)))
22723 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
22727 *x
+= best_glyph
->pixel_width
;
22732 *vpos
= best_row
- w
->current_matrix
->rows
;
22735 return best_glyph
!= NULL
;
22739 /* See if position X, Y is within a hot-spot of an image. */
22742 on_hot_spot_p (hot_spot
, x
, y
)
22743 Lisp_Object hot_spot
;
22746 if (!CONSP (hot_spot
))
22749 if (EQ (XCAR (hot_spot
), Qrect
))
22751 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
22752 Lisp_Object rect
= XCDR (hot_spot
);
22756 if (!CONSP (XCAR (rect
)))
22758 if (!CONSP (XCDR (rect
)))
22760 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
22762 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
22764 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
22766 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
22770 else if (EQ (XCAR (hot_spot
), Qcircle
))
22772 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
22773 Lisp_Object circ
= XCDR (hot_spot
);
22774 Lisp_Object lr
, lx0
, ly0
;
22776 && CONSP (XCAR (circ
))
22777 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
22778 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
22779 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
22781 double r
= XFLOATINT (lr
);
22782 double dx
= XINT (lx0
) - x
;
22783 double dy
= XINT (ly0
) - y
;
22784 return (dx
* dx
+ dy
* dy
<= r
* r
);
22787 else if (EQ (XCAR (hot_spot
), Qpoly
))
22789 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
22790 if (VECTORP (XCDR (hot_spot
)))
22792 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
22793 Lisp_Object
*poly
= v
->contents
;
22797 Lisp_Object lx
, ly
;
22800 /* Need an even number of coordinates, and at least 3 edges. */
22801 if (n
< 6 || n
& 1)
22804 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
22805 If count is odd, we are inside polygon. Pixels on edges
22806 may or may not be included depending on actual geometry of the
22808 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
22809 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
22811 x0
= XINT (lx
), y0
= XINT (ly
);
22812 for (i
= 0; i
< n
; i
+= 2)
22814 int x1
= x0
, y1
= y0
;
22815 if ((lx
= poly
[i
], !INTEGERP (lx
))
22816 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
22818 x0
= XINT (lx
), y0
= XINT (ly
);
22820 /* Does this segment cross the X line? */
22828 if (y
> y0
&& y
> y1
)
22830 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
22840 find_hot_spot (map
, x
, y
)
22844 while (CONSP (map
))
22846 if (CONSP (XCAR (map
))
22847 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
22855 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
22857 doc
: /* Lookup in image map MAP coordinates X and Y.
22858 An image map is an alist where each element has the format (AREA ID PLIST).
22859 An AREA is specified as either a rectangle, a circle, or a polygon:
22860 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
22861 pixel coordinates of the upper left and bottom right corners.
22862 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
22863 and the radius of the circle; r may be a float or integer.
22864 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
22865 vector describes one corner in the polygon.
22866 Returns the alist element for the first matching AREA in MAP. */)
22877 return find_hot_spot (map
, XINT (x
), XINT (y
));
22881 /* Display frame CURSOR, optionally using shape defined by POINTER. */
22883 define_frame_cursor1 (f
, cursor
, pointer
)
22886 Lisp_Object pointer
;
22888 /* Do not change cursor shape while dragging mouse. */
22889 if (!NILP (do_mouse_tracking
))
22892 if (!NILP (pointer
))
22894 if (EQ (pointer
, Qarrow
))
22895 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22896 else if (EQ (pointer
, Qhand
))
22897 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
22898 else if (EQ (pointer
, Qtext
))
22899 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
22900 else if (EQ (pointer
, intern ("hdrag")))
22901 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
22902 #ifdef HAVE_X_WINDOWS
22903 else if (EQ (pointer
, intern ("vdrag")))
22904 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
22906 else if (EQ (pointer
, intern ("hourglass")))
22907 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
22908 else if (EQ (pointer
, Qmodeline
))
22909 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
22911 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22914 if (cursor
!= No_Cursor
)
22915 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
22918 /* Take proper action when mouse has moved to the mode or header line
22919 or marginal area AREA of window W, x-position X and y-position Y.
22920 X is relative to the start of the text display area of W, so the
22921 width of bitmap areas and scroll bars must be subtracted to get a
22922 position relative to the start of the mode line. */
22925 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
22926 Lisp_Object window
;
22928 enum window_part area
;
22930 struct window
*w
= XWINDOW (window
);
22931 struct frame
*f
= XFRAME (w
->frame
);
22932 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22933 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22934 Lisp_Object pointer
= Qnil
;
22935 int charpos
, dx
, dy
, width
, height
;
22936 Lisp_Object string
, object
= Qnil
;
22937 Lisp_Object pos
, help
;
22939 Lisp_Object mouse_face
;
22940 int original_x_pixel
= x
;
22941 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
22942 struct glyph_row
*row
;
22944 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
22949 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
22950 &object
, &dx
, &dy
, &width
, &height
);
22952 row
= (area
== ON_MODE_LINE
22953 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
22954 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
22957 if (row
->mode_line_p
&& row
->enabled_p
)
22959 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
22960 end
= glyph
+ row
->used
[TEXT_AREA
];
22962 for (x0
= original_x_pixel
;
22963 glyph
< end
&& x0
>= glyph
->pixel_width
;
22965 x0
-= glyph
->pixel_width
;
22973 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
22974 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
22975 &object
, &dx
, &dy
, &width
, &height
);
22980 if (IMAGEP (object
))
22982 Lisp_Object image_map
, hotspot
;
22983 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
22985 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
22987 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
22989 Lisp_Object area_id
, plist
;
22991 area_id
= XCAR (hotspot
);
22992 /* Could check AREA_ID to see if we enter/leave this hot-spot.
22993 If so, we could look for mouse-enter, mouse-leave
22994 properties in PLIST (and do something...). */
22995 hotspot
= XCDR (hotspot
);
22996 if (CONSP (hotspot
)
22997 && (plist
= XCAR (hotspot
), CONSP (plist
)))
22999 pointer
= Fplist_get (plist
, Qpointer
);
23000 if (NILP (pointer
))
23002 help
= Fplist_get (plist
, Qhelp_echo
);
23005 help_echo_string
= help
;
23006 /* Is this correct? ++kfs */
23007 XSETWINDOW (help_echo_window
, w
);
23008 help_echo_object
= w
->buffer
;
23009 help_echo_pos
= charpos
;
23013 if (NILP (pointer
))
23014 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23017 if (STRINGP (string
))
23019 pos
= make_number (charpos
);
23020 /* If we're on a string with `help-echo' text property, arrange
23021 for the help to be displayed. This is done by setting the
23022 global variable help_echo_string to the help string. */
23025 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23028 help_echo_string
= help
;
23029 XSETWINDOW (help_echo_window
, w
);
23030 help_echo_object
= string
;
23031 help_echo_pos
= charpos
;
23035 if (NILP (pointer
))
23036 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23038 /* Change the mouse pointer according to what is under X/Y. */
23039 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23042 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23043 if (!KEYMAPP (map
))
23044 map
= Fget_text_property (pos
, Qkeymap
, string
);
23045 if (!KEYMAPP (map
))
23046 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23049 /* Change the mouse face according to what is under X/Y. */
23050 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23051 if (!NILP (mouse_face
)
23052 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23057 struct glyph
* tmp_glyph
;
23061 int total_pixel_width
;
23066 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23067 Qmouse_face
, string
, Qnil
);
23069 b
= make_number (0);
23071 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23073 e
= make_number (SCHARS (string
));
23075 /* Calculate the position(glyph position: GPOS) of GLYPH in
23076 displayed string. GPOS is different from CHARPOS.
23078 CHARPOS is the position of glyph in internal string
23079 object. A mode line string format has structures which
23080 is converted to a flatten by emacs lisp interpreter.
23081 The internal string is an element of the structures.
23082 The displayed string is the flatten string. */
23084 if (glyph
> row_start_glyph
)
23086 tmp_glyph
= glyph
- 1;
23087 while (tmp_glyph
>= row_start_glyph
23088 && tmp_glyph
->charpos
>= XINT (b
)
23089 && EQ (tmp_glyph
->object
, glyph
->object
))
23096 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23097 displayed string holding GLYPH.
23099 GSEQ_LENGTH is different from SCHARS (STRING).
23100 SCHARS (STRING) returns the length of the internal string. */
23101 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23102 tmp_glyph
->charpos
< XINT (e
);
23103 tmp_glyph
++, gseq_length
++)
23105 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23109 total_pixel_width
= 0;
23110 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23111 total_pixel_width
+= tmp_glyph
->pixel_width
;
23113 /* Pre calculation of re-rendering position */
23115 hpos
= (area
== ON_MODE_LINE
23116 ? (w
->current_matrix
)->nrows
- 1
23119 /* If the re-rendering position is included in the last
23120 re-rendering area, we should do nothing. */
23121 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23122 && dpyinfo
->mouse_face_beg_col
<= vpos
23123 && vpos
< dpyinfo
->mouse_face_end_col
23124 && dpyinfo
->mouse_face_beg_row
== hpos
)
23127 if (clear_mouse_face (dpyinfo
))
23128 cursor
= No_Cursor
;
23130 dpyinfo
->mouse_face_beg_col
= vpos
;
23131 dpyinfo
->mouse_face_beg_row
= hpos
;
23133 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23134 dpyinfo
->mouse_face_beg_y
= 0;
23136 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23137 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23139 dpyinfo
->mouse_face_end_x
= 0;
23140 dpyinfo
->mouse_face_end_y
= 0;
23142 dpyinfo
->mouse_face_past_end
= 0;
23143 dpyinfo
->mouse_face_window
= window
;
23145 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23148 glyph
->face_id
, 1);
23149 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23151 if (NILP (pointer
))
23154 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23155 clear_mouse_face (dpyinfo
);
23157 define_frame_cursor1 (f
, cursor
, pointer
);
23162 Take proper action when the mouse has moved to position X, Y on
23163 frame F as regards highlighting characters that have mouse-face
23164 properties. Also de-highlighting chars where the mouse was before.
23165 X and Y can be negative or out of range. */
23168 note_mouse_highlight (f
, x
, y
)
23172 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23173 enum window_part part
;
23174 Lisp_Object window
;
23176 Cursor cursor
= No_Cursor
;
23177 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23180 /* When a menu is active, don't highlight because this looks odd. */
23181 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
23182 if (popup_activated ())
23186 if (NILP (Vmouse_highlight
)
23187 || !f
->glyphs_initialized_p
)
23190 dpyinfo
->mouse_face_mouse_x
= x
;
23191 dpyinfo
->mouse_face_mouse_y
= y
;
23192 dpyinfo
->mouse_face_mouse_frame
= f
;
23194 if (dpyinfo
->mouse_face_defer
)
23197 if (gc_in_progress
)
23199 dpyinfo
->mouse_face_deferred_gc
= 1;
23203 /* Which window is that in? */
23204 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23206 /* If we were displaying active text in another window, clear that.
23207 Also clear if we move out of text area in same window. */
23208 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23209 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23210 && !NILP (dpyinfo
->mouse_face_window
)))
23211 clear_mouse_face (dpyinfo
);
23213 /* Not on a window -> return. */
23214 if (!WINDOWP (window
))
23217 /* Reset help_echo_string. It will get recomputed below. */
23218 help_echo_string
= Qnil
;
23220 /* Convert to window-relative pixel coordinates. */
23221 w
= XWINDOW (window
);
23222 frame_to_window_pixel_xy (w
, &x
, &y
);
23224 /* Handle tool-bar window differently since it doesn't display a
23226 if (EQ (window
, f
->tool_bar_window
))
23228 note_tool_bar_highlight (f
, x
, y
);
23232 /* Mouse is on the mode, header line or margin? */
23233 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23234 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23236 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23240 if (part
== ON_VERTICAL_BORDER
)
23242 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23243 help_echo_string
= build_string ("drag-mouse-1: resize");
23245 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23246 || part
== ON_SCROLL_BAR
)
23247 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23249 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23251 /* Are we in a window whose display is up to date?
23252 And verify the buffer's text has not changed. */
23253 b
= XBUFFER (w
->buffer
);
23254 if (part
== ON_TEXT
23255 && EQ (w
->window_end_valid
, w
->buffer
)
23256 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23257 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23259 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23260 struct glyph
*glyph
;
23261 Lisp_Object object
;
23262 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23263 Lisp_Object
*overlay_vec
= NULL
;
23265 struct buffer
*obuf
;
23266 int obegv
, ozv
, same_region
;
23268 /* Find the glyph under X/Y. */
23269 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23271 /* Look for :pointer property on image. */
23272 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23274 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23275 if (img
!= NULL
&& IMAGEP (img
->spec
))
23277 Lisp_Object image_map
, hotspot
;
23278 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23280 && (hotspot
= find_hot_spot (image_map
,
23281 glyph
->slice
.x
+ dx
,
23282 glyph
->slice
.y
+ dy
),
23284 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23286 Lisp_Object area_id
, plist
;
23288 area_id
= XCAR (hotspot
);
23289 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23290 If so, we could look for mouse-enter, mouse-leave
23291 properties in PLIST (and do something...). */
23292 hotspot
= XCDR (hotspot
);
23293 if (CONSP (hotspot
)
23294 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23296 pointer
= Fplist_get (plist
, Qpointer
);
23297 if (NILP (pointer
))
23299 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23300 if (!NILP (help_echo_string
))
23302 help_echo_window
= window
;
23303 help_echo_object
= glyph
->object
;
23304 help_echo_pos
= glyph
->charpos
;
23308 if (NILP (pointer
))
23309 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23313 /* Clear mouse face if X/Y not over text. */
23315 || area
!= TEXT_AREA
23316 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23318 if (clear_mouse_face (dpyinfo
))
23319 cursor
= No_Cursor
;
23320 if (NILP (pointer
))
23322 if (area
!= TEXT_AREA
)
23323 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23325 pointer
= Vvoid_text_area_pointer
;
23330 pos
= glyph
->charpos
;
23331 object
= glyph
->object
;
23332 if (!STRINGP (object
) && !BUFFERP (object
))
23335 /* If we get an out-of-range value, return now; avoid an error. */
23336 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23339 /* Make the window's buffer temporarily current for
23340 overlays_at and compute_char_face. */
23341 obuf
= current_buffer
;
23342 current_buffer
= b
;
23348 /* Is this char mouse-active or does it have help-echo? */
23349 position
= make_number (pos
);
23351 if (BUFFERP (object
))
23353 /* Put all the overlays we want in a vector in overlay_vec. */
23354 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23355 /* Sort overlays into increasing priority order. */
23356 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23361 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23362 && vpos
>= dpyinfo
->mouse_face_beg_row
23363 && vpos
<= dpyinfo
->mouse_face_end_row
23364 && (vpos
> dpyinfo
->mouse_face_beg_row
23365 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23366 && (vpos
< dpyinfo
->mouse_face_end_row
23367 || hpos
< dpyinfo
->mouse_face_end_col
23368 || dpyinfo
->mouse_face_past_end
));
23371 cursor
= No_Cursor
;
23373 /* Check mouse-face highlighting. */
23375 /* If there exists an overlay with mouse-face overlapping
23376 the one we are currently highlighting, we have to
23377 check if we enter the overlapping overlay, and then
23378 highlight only that. */
23379 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23380 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23382 /* Find the highest priority overlay that has a mouse-face
23385 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23387 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23388 if (!NILP (mouse_face
))
23389 overlay
= overlay_vec
[i
];
23392 /* If we're actually highlighting the same overlay as
23393 before, there's no need to do that again. */
23394 if (!NILP (overlay
)
23395 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23396 goto check_help_echo
;
23398 dpyinfo
->mouse_face_overlay
= overlay
;
23400 /* Clear the display of the old active region, if any. */
23401 if (clear_mouse_face (dpyinfo
))
23402 cursor
= No_Cursor
;
23404 /* If no overlay applies, get a text property. */
23405 if (NILP (overlay
))
23406 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23408 /* Handle the overlay case. */
23409 if (!NILP (overlay
))
23411 /* Find the range of text around this char that
23412 should be active. */
23413 Lisp_Object before
, after
;
23416 before
= Foverlay_start (overlay
);
23417 after
= Foverlay_end (overlay
);
23418 /* Record this as the current active region. */
23419 fast_find_position (w
, XFASTINT (before
),
23420 &dpyinfo
->mouse_face_beg_col
,
23421 &dpyinfo
->mouse_face_beg_row
,
23422 &dpyinfo
->mouse_face_beg_x
,
23423 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23425 dpyinfo
->mouse_face_past_end
23426 = !fast_find_position (w
, XFASTINT (after
),
23427 &dpyinfo
->mouse_face_end_col
,
23428 &dpyinfo
->mouse_face_end_row
,
23429 &dpyinfo
->mouse_face_end_x
,
23430 &dpyinfo
->mouse_face_end_y
, Qnil
);
23431 dpyinfo
->mouse_face_window
= window
;
23433 dpyinfo
->mouse_face_face_id
23434 = face_at_buffer_position (w
, pos
, 0, 0,
23436 !dpyinfo
->mouse_face_hidden
);
23438 /* Display it as active. */
23439 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23440 cursor
= No_Cursor
;
23442 /* Handle the text property case. */
23443 else if (!NILP (mouse_face
) && BUFFERP (object
))
23445 /* Find the range of text around this char that
23446 should be active. */
23447 Lisp_Object before
, after
, beginning
, end
;
23450 beginning
= Fmarker_position (w
->start
);
23451 end
= make_number (BUF_Z (XBUFFER (object
))
23452 - XFASTINT (w
->window_end_pos
));
23454 = Fprevious_single_property_change (make_number (pos
+ 1),
23456 object
, beginning
);
23458 = Fnext_single_property_change (position
, Qmouse_face
,
23461 /* Record this as the current active region. */
23462 fast_find_position (w
, XFASTINT (before
),
23463 &dpyinfo
->mouse_face_beg_col
,
23464 &dpyinfo
->mouse_face_beg_row
,
23465 &dpyinfo
->mouse_face_beg_x
,
23466 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23467 dpyinfo
->mouse_face_past_end
23468 = !fast_find_position (w
, XFASTINT (after
),
23469 &dpyinfo
->mouse_face_end_col
,
23470 &dpyinfo
->mouse_face_end_row
,
23471 &dpyinfo
->mouse_face_end_x
,
23472 &dpyinfo
->mouse_face_end_y
, Qnil
);
23473 dpyinfo
->mouse_face_window
= window
;
23475 if (BUFFERP (object
))
23476 dpyinfo
->mouse_face_face_id
23477 = face_at_buffer_position (w
, pos
, 0, 0,
23479 !dpyinfo
->mouse_face_hidden
);
23481 /* Display it as active. */
23482 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23483 cursor
= No_Cursor
;
23485 else if (!NILP (mouse_face
) && STRINGP (object
))
23490 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23493 e
= Fnext_single_property_change (position
, Qmouse_face
,
23496 b
= make_number (0);
23498 e
= make_number (SCHARS (object
) - 1);
23500 fast_find_string_pos (w
, XINT (b
), object
,
23501 &dpyinfo
->mouse_face_beg_col
,
23502 &dpyinfo
->mouse_face_beg_row
,
23503 &dpyinfo
->mouse_face_beg_x
,
23504 &dpyinfo
->mouse_face_beg_y
, 0);
23505 fast_find_string_pos (w
, XINT (e
), object
,
23506 &dpyinfo
->mouse_face_end_col
,
23507 &dpyinfo
->mouse_face_end_row
,
23508 &dpyinfo
->mouse_face_end_x
,
23509 &dpyinfo
->mouse_face_end_y
, 1);
23510 dpyinfo
->mouse_face_past_end
= 0;
23511 dpyinfo
->mouse_face_window
= window
;
23512 dpyinfo
->mouse_face_face_id
23513 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23514 glyph
->face_id
, 1);
23515 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23516 cursor
= No_Cursor
;
23518 else if (STRINGP (object
) && NILP (mouse_face
))
23520 /* A string which doesn't have mouse-face, but
23521 the text ``under'' it might have. */
23522 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23523 int start
= MATRIX_ROW_START_CHARPOS (r
);
23525 pos
= string_buffer_position (w
, object
, start
);
23527 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23531 if (!NILP (mouse_face
) && !NILP (overlay
))
23533 Lisp_Object before
= Foverlay_start (overlay
);
23534 Lisp_Object after
= Foverlay_end (overlay
);
23537 /* Note that we might not be able to find position
23538 BEFORE in the glyph matrix if the overlay is
23539 entirely covered by a `display' property. In
23540 this case, we overshoot. So let's stop in
23541 the glyph matrix before glyphs for OBJECT. */
23542 fast_find_position (w
, XFASTINT (before
),
23543 &dpyinfo
->mouse_face_beg_col
,
23544 &dpyinfo
->mouse_face_beg_row
,
23545 &dpyinfo
->mouse_face_beg_x
,
23546 &dpyinfo
->mouse_face_beg_y
,
23549 dpyinfo
->mouse_face_past_end
23550 = !fast_find_position (w
, XFASTINT (after
),
23551 &dpyinfo
->mouse_face_end_col
,
23552 &dpyinfo
->mouse_face_end_row
,
23553 &dpyinfo
->mouse_face_end_x
,
23554 &dpyinfo
->mouse_face_end_y
,
23556 dpyinfo
->mouse_face_window
= window
;
23557 dpyinfo
->mouse_face_face_id
23558 = face_at_buffer_position (w
, pos
, 0, 0,
23560 !dpyinfo
->mouse_face_hidden
);
23562 /* Display it as active. */
23563 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23564 cursor
= No_Cursor
;
23571 /* Look for a `help-echo' property. */
23572 if (NILP (help_echo_string
)) {
23573 Lisp_Object help
, overlay
;
23575 /* Check overlays first. */
23576 help
= overlay
= Qnil
;
23577 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23579 overlay
= overlay_vec
[i
];
23580 help
= Foverlay_get (overlay
, Qhelp_echo
);
23585 help_echo_string
= help
;
23586 help_echo_window
= window
;
23587 help_echo_object
= overlay
;
23588 help_echo_pos
= pos
;
23592 Lisp_Object object
= glyph
->object
;
23593 int charpos
= glyph
->charpos
;
23595 /* Try text properties. */
23596 if (STRINGP (object
)
23598 && charpos
< SCHARS (object
))
23600 help
= Fget_text_property (make_number (charpos
),
23601 Qhelp_echo
, object
);
23604 /* If the string itself doesn't specify a help-echo,
23605 see if the buffer text ``under'' it does. */
23606 struct glyph_row
*r
23607 = MATRIX_ROW (w
->current_matrix
, vpos
);
23608 int start
= MATRIX_ROW_START_CHARPOS (r
);
23609 int pos
= string_buffer_position (w
, object
, start
);
23612 help
= Fget_char_property (make_number (pos
),
23613 Qhelp_echo
, w
->buffer
);
23617 object
= w
->buffer
;
23622 else if (BUFFERP (object
)
23625 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23630 help_echo_string
= help
;
23631 help_echo_window
= window
;
23632 help_echo_object
= object
;
23633 help_echo_pos
= charpos
;
23638 /* Look for a `pointer' property. */
23639 if (NILP (pointer
))
23641 /* Check overlays first. */
23642 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23643 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23645 if (NILP (pointer
))
23647 Lisp_Object object
= glyph
->object
;
23648 int charpos
= glyph
->charpos
;
23650 /* Try text properties. */
23651 if (STRINGP (object
)
23653 && charpos
< SCHARS (object
))
23655 pointer
= Fget_text_property (make_number (charpos
),
23657 if (NILP (pointer
))
23659 /* If the string itself doesn't specify a pointer,
23660 see if the buffer text ``under'' it does. */
23661 struct glyph_row
*r
23662 = MATRIX_ROW (w
->current_matrix
, vpos
);
23663 int start
= MATRIX_ROW_START_CHARPOS (r
);
23664 int pos
= string_buffer_position (w
, object
, start
);
23666 pointer
= Fget_char_property (make_number (pos
),
23667 Qpointer
, w
->buffer
);
23670 else if (BUFFERP (object
)
23673 pointer
= Fget_text_property (make_number (charpos
),
23680 current_buffer
= obuf
;
23685 define_frame_cursor1 (f
, cursor
, pointer
);
23690 Clear any mouse-face on window W. This function is part of the
23691 redisplay interface, and is called from try_window_id and similar
23692 functions to ensure the mouse-highlight is off. */
23695 x_clear_window_mouse_face (w
)
23698 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23699 Lisp_Object window
;
23702 XSETWINDOW (window
, w
);
23703 if (EQ (window
, dpyinfo
->mouse_face_window
))
23704 clear_mouse_face (dpyinfo
);
23710 Just discard the mouse face information for frame F, if any.
23711 This is used when the size of F is changed. */
23714 cancel_mouse_face (f
)
23717 Lisp_Object window
;
23718 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23720 window
= dpyinfo
->mouse_face_window
;
23721 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
23723 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23724 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23725 dpyinfo
->mouse_face_window
= Qnil
;
23730 #endif /* HAVE_WINDOW_SYSTEM */
23733 /***********************************************************************
23735 ***********************************************************************/
23737 #ifdef HAVE_WINDOW_SYSTEM
23739 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
23740 which intersects rectangle R. R is in window-relative coordinates. */
23743 expose_area (w
, row
, r
, area
)
23745 struct glyph_row
*row
;
23747 enum glyph_row_area area
;
23749 struct glyph
*first
= row
->glyphs
[area
];
23750 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
23751 struct glyph
*last
;
23752 int first_x
, start_x
, x
;
23754 if (area
== TEXT_AREA
&& row
->fill_line_p
)
23755 /* If row extends face to end of line write the whole line. */
23756 draw_glyphs (w
, 0, row
, area
,
23757 0, row
->used
[area
],
23758 DRAW_NORMAL_TEXT
, 0);
23761 /* Set START_X to the window-relative start position for drawing glyphs of
23762 AREA. The first glyph of the text area can be partially visible.
23763 The first glyphs of other areas cannot. */
23764 start_x
= window_box_left_offset (w
, area
);
23766 if (area
== TEXT_AREA
)
23769 /* Find the first glyph that must be redrawn. */
23771 && x
+ first
->pixel_width
< r
->x
)
23773 x
+= first
->pixel_width
;
23777 /* Find the last one. */
23781 && x
< r
->x
+ r
->width
)
23783 x
+= last
->pixel_width
;
23789 draw_glyphs (w
, first_x
- start_x
, row
, area
,
23790 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
23791 DRAW_NORMAL_TEXT
, 0);
23796 /* Redraw the parts of the glyph row ROW on window W intersecting
23797 rectangle R. R is in window-relative coordinates. Value is
23798 non-zero if mouse-face was overwritten. */
23801 expose_line (w
, row
, r
)
23803 struct glyph_row
*row
;
23806 xassert (row
->enabled_p
);
23808 if (row
->mode_line_p
|| w
->pseudo_window_p
)
23809 draw_glyphs (w
, 0, row
, TEXT_AREA
,
23810 0, row
->used
[TEXT_AREA
],
23811 DRAW_NORMAL_TEXT
, 0);
23814 if (row
->used
[LEFT_MARGIN_AREA
])
23815 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
23816 if (row
->used
[TEXT_AREA
])
23817 expose_area (w
, row
, r
, TEXT_AREA
);
23818 if (row
->used
[RIGHT_MARGIN_AREA
])
23819 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
23820 draw_row_fringe_bitmaps (w
, row
);
23823 return row
->mouse_face_p
;
23827 /* Redraw those parts of glyphs rows during expose event handling that
23828 overlap other rows. Redrawing of an exposed line writes over parts
23829 of lines overlapping that exposed line; this function fixes that.
23831 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
23832 row in W's current matrix that is exposed and overlaps other rows.
23833 LAST_OVERLAPPING_ROW is the last such row. */
23836 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
23838 struct glyph_row
*first_overlapping_row
;
23839 struct glyph_row
*last_overlapping_row
;
23842 struct glyph_row
*row
;
23844 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
23845 if (row
->overlapping_p
)
23847 xassert (row
->enabled_p
&& !row
->mode_line_p
);
23850 if (row
->used
[LEFT_MARGIN_AREA
])
23851 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
23853 if (row
->used
[TEXT_AREA
])
23854 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
23856 if (row
->used
[RIGHT_MARGIN_AREA
])
23857 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
23863 /* Return non-zero if W's cursor intersects rectangle R. */
23866 phys_cursor_in_rect_p (w
, r
)
23870 XRectangle cr
, result
;
23871 struct glyph
*cursor_glyph
;
23872 struct glyph_row
*row
;
23874 if (w
->phys_cursor
.vpos
>= 0
23875 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
23876 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
23878 && row
->cursor_in_fringe_p
)
23880 /* Cursor is in the fringe. */
23881 cr
.x
= window_box_right_offset (w
,
23882 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
23883 ? RIGHT_MARGIN_AREA
23886 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
23887 cr
.height
= row
->height
;
23888 return x_intersect_rectangles (&cr
, r
, &result
);
23891 cursor_glyph
= get_phys_cursor_glyph (w
);
23894 /* r is relative to W's box, but w->phys_cursor.x is relative
23895 to left edge of W's TEXT area. Adjust it. */
23896 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
23897 cr
.y
= w
->phys_cursor
.y
;
23898 cr
.width
= cursor_glyph
->pixel_width
;
23899 cr
.height
= w
->phys_cursor_height
;
23900 /* ++KFS: W32 version used W32-specific IntersectRect here, but
23901 I assume the effect is the same -- and this is portable. */
23902 return x_intersect_rectangles (&cr
, r
, &result
);
23904 /* If we don't understand the format, pretend we're not in the hot-spot. */
23910 Draw a vertical window border to the right of window W if W doesn't
23911 have vertical scroll bars. */
23914 x_draw_vertical_border (w
)
23917 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23919 /* We could do better, if we knew what type of scroll-bar the adjacent
23920 windows (on either side) have... But we don't :-(
23921 However, I think this works ok. ++KFS 2003-04-25 */
23923 /* Redraw borders between horizontally adjacent windows. Don't
23924 do it for frames with vertical scroll bars because either the
23925 right scroll bar of a window, or the left scroll bar of its
23926 neighbor will suffice as a border. */
23927 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
23930 if (!WINDOW_RIGHTMOST_P (w
)
23931 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
23933 int x0
, x1
, y0
, y1
;
23935 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23938 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23941 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
23943 else if (!WINDOW_LEFTMOST_P (w
)
23944 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
23946 int x0
, x1
, y0
, y1
;
23948 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23951 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23954 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
23959 /* Redraw the part of window W intersection rectangle FR. Pixel
23960 coordinates in FR are frame-relative. Call this function with
23961 input blocked. Value is non-zero if the exposure overwrites
23965 expose_window (w
, fr
)
23969 struct frame
*f
= XFRAME (w
->frame
);
23971 int mouse_face_overwritten_p
= 0;
23973 /* If window is not yet fully initialized, do nothing. This can
23974 happen when toolkit scroll bars are used and a window is split.
23975 Reconfiguring the scroll bar will generate an expose for a newly
23977 if (w
->current_matrix
== NULL
)
23980 /* When we're currently updating the window, display and current
23981 matrix usually don't agree. Arrange for a thorough display
23983 if (w
== updated_window
)
23985 SET_FRAME_GARBAGED (f
);
23989 /* Frame-relative pixel rectangle of W. */
23990 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
23991 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
23992 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
23993 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
23995 if (x_intersect_rectangles (fr
, &wr
, &r
))
23997 int yb
= window_text_bottom_y (w
);
23998 struct glyph_row
*row
;
23999 int cursor_cleared_p
;
24000 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24002 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24003 r
.x
, r
.y
, r
.width
, r
.height
));
24005 /* Convert to window coordinates. */
24006 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24007 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24009 /* Turn off the cursor. */
24010 if (!w
->pseudo_window_p
24011 && phys_cursor_in_rect_p (w
, &r
))
24013 x_clear_cursor (w
);
24014 cursor_cleared_p
= 1;
24017 cursor_cleared_p
= 0;
24019 /* Update lines intersecting rectangle R. */
24020 first_overlapping_row
= last_overlapping_row
= NULL
;
24021 for (row
= w
->current_matrix
->rows
;
24026 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24028 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24029 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24030 || (r
.y
>= y0
&& r
.y
< y1
)
24031 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24033 /* A header line may be overlapping, but there is no need
24034 to fix overlapping areas for them. KFS 2005-02-12 */
24035 if (row
->overlapping_p
&& !row
->mode_line_p
)
24037 if (first_overlapping_row
== NULL
)
24038 first_overlapping_row
= row
;
24039 last_overlapping_row
= row
;
24043 if (expose_line (w
, row
, &r
))
24044 mouse_face_overwritten_p
= 1;
24047 else if (row
->overlapping_p
)
24049 /* We must redraw a row overlapping the exposed area. */
24051 ? y0
+ row
->phys_height
> r
.y
24052 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24054 if (first_overlapping_row
== NULL
)
24055 first_overlapping_row
= row
;
24056 last_overlapping_row
= row
;
24064 /* Display the mode line if there is one. */
24065 if (WINDOW_WANTS_MODELINE_P (w
)
24066 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24068 && row
->y
< r
.y
+ r
.height
)
24070 if (expose_line (w
, row
, &r
))
24071 mouse_face_overwritten_p
= 1;
24074 if (!w
->pseudo_window_p
)
24076 /* Fix the display of overlapping rows. */
24077 if (first_overlapping_row
)
24078 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24081 /* Draw border between windows. */
24082 x_draw_vertical_border (w
);
24084 /* Turn the cursor on again. */
24085 if (cursor_cleared_p
)
24086 update_window_cursor (w
, 1);
24090 return mouse_face_overwritten_p
;
24095 /* Redraw (parts) of all windows in the window tree rooted at W that
24096 intersect R. R contains frame pixel coordinates. Value is
24097 non-zero if the exposure overwrites mouse-face. */
24100 expose_window_tree (w
, r
)
24104 struct frame
*f
= XFRAME (w
->frame
);
24105 int mouse_face_overwritten_p
= 0;
24107 while (w
&& !FRAME_GARBAGED_P (f
))
24109 if (!NILP (w
->hchild
))
24110 mouse_face_overwritten_p
24111 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24112 else if (!NILP (w
->vchild
))
24113 mouse_face_overwritten_p
24114 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24116 mouse_face_overwritten_p
|= expose_window (w
, r
);
24118 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24121 return mouse_face_overwritten_p
;
24126 Redisplay an exposed area of frame F. X and Y are the upper-left
24127 corner of the exposed rectangle. W and H are width and height of
24128 the exposed area. All are pixel values. W or H zero means redraw
24129 the entire frame. */
24132 expose_frame (f
, x
, y
, w
, h
)
24137 int mouse_face_overwritten_p
= 0;
24139 TRACE ((stderr
, "expose_frame "));
24141 /* No need to redraw if frame will be redrawn soon. */
24142 if (FRAME_GARBAGED_P (f
))
24144 TRACE ((stderr
, " garbaged\n"));
24148 /* If basic faces haven't been realized yet, there is no point in
24149 trying to redraw anything. This can happen when we get an expose
24150 event while Emacs is starting, e.g. by moving another window. */
24151 if (FRAME_FACE_CACHE (f
) == NULL
24152 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24154 TRACE ((stderr
, " no faces\n"));
24158 if (w
== 0 || h
== 0)
24161 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24162 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24172 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24173 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24175 if (WINDOWP (f
->tool_bar_window
))
24176 mouse_face_overwritten_p
24177 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24179 #ifdef HAVE_X_WINDOWS
24181 #ifndef USE_X_TOOLKIT
24182 if (WINDOWP (f
->menu_bar_window
))
24183 mouse_face_overwritten_p
24184 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24185 #endif /* not USE_X_TOOLKIT */
24189 /* Some window managers support a focus-follows-mouse style with
24190 delayed raising of frames. Imagine a partially obscured frame,
24191 and moving the mouse into partially obscured mouse-face on that
24192 frame. The visible part of the mouse-face will be highlighted,
24193 then the WM raises the obscured frame. With at least one WM, KDE
24194 2.1, Emacs is not getting any event for the raising of the frame
24195 (even tried with SubstructureRedirectMask), only Expose events.
24196 These expose events will draw text normally, i.e. not
24197 highlighted. Which means we must redo the highlight here.
24198 Subsume it under ``we love X''. --gerd 2001-08-15 */
24199 /* Included in Windows version because Windows most likely does not
24200 do the right thing if any third party tool offers
24201 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24202 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24204 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24205 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24207 int x
= dpyinfo
->mouse_face_mouse_x
;
24208 int y
= dpyinfo
->mouse_face_mouse_y
;
24209 clear_mouse_face (dpyinfo
);
24210 note_mouse_highlight (f
, x
, y
);
24217 Determine the intersection of two rectangles R1 and R2. Return
24218 the intersection in *RESULT. Value is non-zero if RESULT is not
24222 x_intersect_rectangles (r1
, r2
, result
)
24223 XRectangle
*r1
, *r2
, *result
;
24225 XRectangle
*left
, *right
;
24226 XRectangle
*upper
, *lower
;
24227 int intersection_p
= 0;
24229 /* Rearrange so that R1 is the left-most rectangle. */
24231 left
= r1
, right
= r2
;
24233 left
= r2
, right
= r1
;
24235 /* X0 of the intersection is right.x0, if this is inside R1,
24236 otherwise there is no intersection. */
24237 if (right
->x
<= left
->x
+ left
->width
)
24239 result
->x
= right
->x
;
24241 /* The right end of the intersection is the minimum of the
24242 the right ends of left and right. */
24243 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24246 /* Same game for Y. */
24248 upper
= r1
, lower
= r2
;
24250 upper
= r2
, lower
= r1
;
24252 /* The upper end of the intersection is lower.y0, if this is inside
24253 of upper. Otherwise, there is no intersection. */
24254 if (lower
->y
<= upper
->y
+ upper
->height
)
24256 result
->y
= lower
->y
;
24258 /* The lower end of the intersection is the minimum of the lower
24259 ends of upper and lower. */
24260 result
->height
= (min (lower
->y
+ lower
->height
,
24261 upper
->y
+ upper
->height
)
24263 intersection_p
= 1;
24267 return intersection_p
;
24270 #endif /* HAVE_WINDOW_SYSTEM */
24273 /***********************************************************************
24275 ***********************************************************************/
24280 Vwith_echo_area_save_vector
= Qnil
;
24281 staticpro (&Vwith_echo_area_save_vector
);
24283 Vmessage_stack
= Qnil
;
24284 staticpro (&Vmessage_stack
);
24286 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24287 staticpro (&Qinhibit_redisplay
);
24289 message_dolog_marker1
= Fmake_marker ();
24290 staticpro (&message_dolog_marker1
);
24291 message_dolog_marker2
= Fmake_marker ();
24292 staticpro (&message_dolog_marker2
);
24293 message_dolog_marker3
= Fmake_marker ();
24294 staticpro (&message_dolog_marker3
);
24297 defsubr (&Sdump_frame_glyph_matrix
);
24298 defsubr (&Sdump_glyph_matrix
);
24299 defsubr (&Sdump_glyph_row
);
24300 defsubr (&Sdump_tool_bar_row
);
24301 defsubr (&Strace_redisplay
);
24302 defsubr (&Strace_to_stderr
);
24304 #ifdef HAVE_WINDOW_SYSTEM
24305 defsubr (&Stool_bar_lines_needed
);
24306 defsubr (&Slookup_image_map
);
24308 defsubr (&Sformat_mode_line
);
24309 defsubr (&Sinvisible_p
);
24311 staticpro (&Qmenu_bar_update_hook
);
24312 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24314 staticpro (&Qoverriding_terminal_local_map
);
24315 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24317 staticpro (&Qoverriding_local_map
);
24318 Qoverriding_local_map
= intern ("overriding-local-map");
24320 staticpro (&Qwindow_scroll_functions
);
24321 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24323 staticpro (&Qwindow_text_change_functions
);
24324 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24326 staticpro (&Qredisplay_end_trigger_functions
);
24327 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24329 staticpro (&Qinhibit_point_motion_hooks
);
24330 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24332 QCdata
= intern (":data");
24333 staticpro (&QCdata
);
24334 Qdisplay
= intern ("display");
24335 staticpro (&Qdisplay
);
24336 Qspace_width
= intern ("space-width");
24337 staticpro (&Qspace_width
);
24338 Qraise
= intern ("raise");
24339 staticpro (&Qraise
);
24340 Qslice
= intern ("slice");
24341 staticpro (&Qslice
);
24342 Qspace
= intern ("space");
24343 staticpro (&Qspace
);
24344 Qmargin
= intern ("margin");
24345 staticpro (&Qmargin
);
24346 Qpointer
= intern ("pointer");
24347 staticpro (&Qpointer
);
24348 Qleft_margin
= intern ("left-margin");
24349 staticpro (&Qleft_margin
);
24350 Qright_margin
= intern ("right-margin");
24351 staticpro (&Qright_margin
);
24352 Qcenter
= intern ("center");
24353 staticpro (&Qcenter
);
24354 Qline_height
= intern ("line-height");
24355 staticpro (&Qline_height
);
24356 QCalign_to
= intern (":align-to");
24357 staticpro (&QCalign_to
);
24358 QCrelative_width
= intern (":relative-width");
24359 staticpro (&QCrelative_width
);
24360 QCrelative_height
= intern (":relative-height");
24361 staticpro (&QCrelative_height
);
24362 QCeval
= intern (":eval");
24363 staticpro (&QCeval
);
24364 QCpropertize
= intern (":propertize");
24365 staticpro (&QCpropertize
);
24366 QCfile
= intern (":file");
24367 staticpro (&QCfile
);
24368 Qfontified
= intern ("fontified");
24369 staticpro (&Qfontified
);
24370 Qfontification_functions
= intern ("fontification-functions");
24371 staticpro (&Qfontification_functions
);
24372 Qtrailing_whitespace
= intern ("trailing-whitespace");
24373 staticpro (&Qtrailing_whitespace
);
24374 Qescape_glyph
= intern ("escape-glyph");
24375 staticpro (&Qescape_glyph
);
24376 Qnobreak_space
= intern ("nobreak-space");
24377 staticpro (&Qnobreak_space
);
24378 Qimage
= intern ("image");
24379 staticpro (&Qimage
);
24380 QCmap
= intern (":map");
24381 staticpro (&QCmap
);
24382 QCpointer
= intern (":pointer");
24383 staticpro (&QCpointer
);
24384 Qrect
= intern ("rect");
24385 staticpro (&Qrect
);
24386 Qcircle
= intern ("circle");
24387 staticpro (&Qcircle
);
24388 Qpoly
= intern ("poly");
24389 staticpro (&Qpoly
);
24390 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24391 staticpro (&Qmessage_truncate_lines
);
24392 Qgrow_only
= intern ("grow-only");
24393 staticpro (&Qgrow_only
);
24394 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24395 staticpro (&Qinhibit_menubar_update
);
24396 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24397 staticpro (&Qinhibit_eval_during_redisplay
);
24398 Qposition
= intern ("position");
24399 staticpro (&Qposition
);
24400 Qbuffer_position
= intern ("buffer-position");
24401 staticpro (&Qbuffer_position
);
24402 Qobject
= intern ("object");
24403 staticpro (&Qobject
);
24404 Qbar
= intern ("bar");
24406 Qhbar
= intern ("hbar");
24407 staticpro (&Qhbar
);
24408 Qbox
= intern ("box");
24410 Qhollow
= intern ("hollow");
24411 staticpro (&Qhollow
);
24412 Qhand
= intern ("hand");
24413 staticpro (&Qhand
);
24414 Qarrow
= intern ("arrow");
24415 staticpro (&Qarrow
);
24416 Qtext
= intern ("text");
24417 staticpro (&Qtext
);
24418 Qrisky_local_variable
= intern ("risky-local-variable");
24419 staticpro (&Qrisky_local_variable
);
24420 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24421 staticpro (&Qinhibit_free_realized_faces
);
24423 list_of_error
= Fcons (Fcons (intern ("error"),
24424 Fcons (intern ("void-variable"), Qnil
)),
24426 staticpro (&list_of_error
);
24428 Qlast_arrow_position
= intern ("last-arrow-position");
24429 staticpro (&Qlast_arrow_position
);
24430 Qlast_arrow_string
= intern ("last-arrow-string");
24431 staticpro (&Qlast_arrow_string
);
24433 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24434 staticpro (&Qoverlay_arrow_string
);
24435 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24436 staticpro (&Qoverlay_arrow_bitmap
);
24438 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24439 staticpro (&echo_buffer
[0]);
24440 staticpro (&echo_buffer
[1]);
24442 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24443 staticpro (&echo_area_buffer
[0]);
24444 staticpro (&echo_area_buffer
[1]);
24446 Vmessages_buffer_name
= build_string ("*Messages*");
24447 staticpro (&Vmessages_buffer_name
);
24449 mode_line_proptrans_alist
= Qnil
;
24450 staticpro (&mode_line_proptrans_alist
);
24451 mode_line_string_list
= Qnil
;
24452 staticpro (&mode_line_string_list
);
24453 mode_line_string_face
= Qnil
;
24454 staticpro (&mode_line_string_face
);
24455 mode_line_string_face_prop
= Qnil
;
24456 staticpro (&mode_line_string_face_prop
);
24457 Vmode_line_unwind_vector
= Qnil
;
24458 staticpro (&Vmode_line_unwind_vector
);
24460 help_echo_string
= Qnil
;
24461 staticpro (&help_echo_string
);
24462 help_echo_object
= Qnil
;
24463 staticpro (&help_echo_object
);
24464 help_echo_window
= Qnil
;
24465 staticpro (&help_echo_window
);
24466 previous_help_echo_string
= Qnil
;
24467 staticpro (&previous_help_echo_string
);
24468 help_echo_pos
= -1;
24470 #ifdef HAVE_WINDOW_SYSTEM
24471 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24472 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24473 For example, if a block cursor is over a tab, it will be drawn as
24474 wide as that tab on the display. */);
24475 x_stretch_cursor_p
= 0;
24478 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24479 doc
: /* *Non-nil means highlight trailing whitespace.
24480 The face used for trailing whitespace is `trailing-whitespace'. */);
24481 Vshow_trailing_whitespace
= Qnil
;
24483 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24484 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24485 A value of t means highlight the character itself (for nobreak space,
24486 use face `nobreak-space').
24487 A value of nil means no highlighting.
24488 Other values mean display the escape glyph followed by an ordinary
24489 space or ordinary hyphen. */);
24490 Vnobreak_char_display
= Qt
;
24492 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24493 doc
: /* *The pointer shape to show in void text areas.
24494 A value of nil means to show the text pointer. Other options are `arrow',
24495 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24496 Vvoid_text_area_pointer
= Qarrow
;
24498 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24499 doc
: /* Non-nil means don't actually do any redisplay.
24500 This is used for internal purposes. */);
24501 Vinhibit_redisplay
= Qnil
;
24503 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24504 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24505 Vglobal_mode_string
= Qnil
;
24507 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24508 doc
: /* Marker for where to display an arrow on top of the buffer text.
24509 This must be the beginning of a line in order to work.
24510 See also `overlay-arrow-string'. */);
24511 Voverlay_arrow_position
= Qnil
;
24513 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24514 doc
: /* String to display as an arrow in non-window frames.
24515 See also `overlay-arrow-position'. */);
24516 Voverlay_arrow_string
= build_string ("=>");
24518 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24519 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24520 The symbols on this list are examined during redisplay to determine
24521 where to display overlay arrows. */);
24522 Voverlay_arrow_variable_list
24523 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24525 DEFVAR_INT ("scroll-step", &scroll_step
,
24526 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24527 If that fails to bring point back on frame, point is centered instead.
24528 If this is zero, point is always centered after it moves off frame.
24529 If you want scrolling to always be a line at a time, you should set
24530 `scroll-conservatively' to a large value rather than set this to 1. */);
24532 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24533 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24534 If point moves off-screen, redisplay will scroll by up to
24535 `scroll-conservatively' lines in order to bring point just barely
24536 onto the screen again. If that cannot be done, then redisplay
24537 recenters point as usual.
24539 A value of zero means always recenter point if it moves off screen. */);
24540 scroll_conservatively
= 0;
24542 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24543 doc
: /* *Number of lines of margin at the top and bottom of a window.
24544 Recenter the window whenever point gets within this many lines
24545 of the top or bottom of the window. */);
24548 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24549 doc
: /* Pixels per inch value for non-window system displays.
24550 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24551 Vdisplay_pixels_per_inch
= make_float (72.0);
24554 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24557 DEFVAR_BOOL ("truncate-partial-width-windows",
24558 &truncate_partial_width_windows
,
24559 doc
: /* *Non-nil means truncate lines in all windows less than full frame wide. */);
24560 truncate_partial_width_windows
= 1;
24562 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24563 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24564 Any other value means to use the appropriate face, `mode-line',
24565 `header-line', or `menu' respectively. */);
24566 mode_line_inverse_video
= 1;
24568 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24569 doc
: /* *Maximum buffer size for which line number should be displayed.
24570 If the buffer is bigger than this, the line number does not appear
24571 in the mode line. A value of nil means no limit. */);
24572 Vline_number_display_limit
= Qnil
;
24574 DEFVAR_INT ("line-number-display-limit-width",
24575 &line_number_display_limit_width
,
24576 doc
: /* *Maximum line width (in characters) for line number display.
24577 If the average length of the lines near point is bigger than this, then the
24578 line number may be omitted from the mode line. */);
24579 line_number_display_limit_width
= 200;
24581 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24582 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24583 highlight_nonselected_windows
= 0;
24585 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24586 doc
: /* Non-nil if more than one frame is visible on this display.
24587 Minibuffer-only frames don't count, but iconified frames do.
24588 This variable is not guaranteed to be accurate except while processing
24589 `frame-title-format' and `icon-title-format'. */);
24591 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24592 doc
: /* Template for displaying the title bar of visible frames.
24593 \(Assuming the window manager supports this feature.)
24595 This variable has the same structure as `mode-line-format', except that
24596 the %c and %l constructs are ignored. It is used only on frames for
24597 which no explicit name has been set \(see `modify-frame-parameters'). */);
24599 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24600 doc
: /* Template for displaying the title bar of an iconified frame.
24601 \(Assuming the window manager supports this feature.)
24602 This variable has the same structure as `mode-line-format' (which see),
24603 and is used only on frames for which no explicit name has been set
24604 \(see `modify-frame-parameters'). */);
24606 = Vframe_title_format
24607 = Fcons (intern ("multiple-frames"),
24608 Fcons (build_string ("%b"),
24609 Fcons (Fcons (empty_unibyte_string
,
24610 Fcons (intern ("invocation-name"),
24611 Fcons (build_string ("@"),
24612 Fcons (intern ("system-name"),
24616 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24617 doc
: /* Maximum number of lines to keep in the message log buffer.
24618 If nil, disable message logging. If t, log messages but don't truncate
24619 the buffer when it becomes large. */);
24620 Vmessage_log_max
= make_number (100);
24622 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24623 doc
: /* Functions called before redisplay, if window sizes have changed.
24624 The value should be a list of functions that take one argument.
24625 Just before redisplay, for each frame, if any of its windows have changed
24626 size since the last redisplay, or have been split or deleted,
24627 all the functions in the list are called, with the frame as argument. */);
24628 Vwindow_size_change_functions
= Qnil
;
24630 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24631 doc
: /* List of functions to call before redisplaying a window with scrolling.
24632 Each function is called with two arguments, the window
24633 and its new display-start position. Note that the value of `window-end'
24634 is not valid when these functions are called. */);
24635 Vwindow_scroll_functions
= Qnil
;
24637 DEFVAR_LISP ("window-text-change-functions",
24638 &Vwindow_text_change_functions
,
24639 doc
: /* Functions to call in redisplay when text in the window might change. */);
24640 Vwindow_text_change_functions
= Qnil
;
24642 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
24643 doc
: /* Functions called when redisplay of a window reaches the end trigger.
24644 Each function is called with two arguments, the window and the end trigger value.
24645 See `set-window-redisplay-end-trigger'. */);
24646 Vredisplay_end_trigger_functions
= Qnil
;
24648 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
24649 doc
: /* *Non-nil means autoselect window with mouse pointer.
24650 If nil, do not autoselect windows.
24651 A positive number means delay autoselection by that many seconds: a
24652 window is autoselected only after the mouse has remained in that
24653 window for the duration of the delay.
24654 A negative number has a similar effect, but causes windows to be
24655 autoselected only after the mouse has stopped moving. \(Because of
24656 the way Emacs compares mouse events, you will occasionally wait twice
24657 that time before the window gets selected.\)
24658 Any other value means to autoselect window instantaneously when the
24659 mouse pointer enters it.
24661 Autoselection selects the minibuffer only if it is active, and never
24662 unselects the minibuffer if it is active.
24664 When customizing this variable make sure that the actual value of
24665 `focus-follows-mouse' matches the behavior of your window manager. */);
24666 Vmouse_autoselect_window
= Qnil
;
24668 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
24669 doc
: /* *Non-nil means automatically resize tool-bars.
24670 This dynamically changes the tool-bar's height to the minimum height
24671 that is needed to make all tool-bar items visible.
24672 If value is `grow-only', the tool-bar's height is only increased
24673 automatically; to decrease the tool-bar height, use \\[recenter]. */);
24674 Vauto_resize_tool_bars
= Qt
;
24676 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
24677 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
24678 auto_raise_tool_bar_buttons_p
= 1;
24680 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
24681 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
24682 make_cursor_line_fully_visible_p
= 1;
24684 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
24685 doc
: /* *Border below tool-bar in pixels.
24686 If an integer, use it as the height of the border.
24687 If it is one of `internal-border-width' or `border-width', use the
24688 value of the corresponding frame parameter.
24689 Otherwise, no border is added below the tool-bar. */);
24690 Vtool_bar_border
= Qinternal_border_width
;
24692 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
24693 doc
: /* *Margin around tool-bar buttons in pixels.
24694 If an integer, use that for both horizontal and vertical margins.
24695 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
24696 HORZ specifying the horizontal margin, and VERT specifying the
24697 vertical margin. */);
24698 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
24700 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
24701 doc
: /* *Relief thickness of tool-bar buttons. */);
24702 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
24704 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
24705 doc
: /* List of functions to call to fontify regions of text.
24706 Each function is called with one argument POS. Functions must
24707 fontify a region starting at POS in the current buffer, and give
24708 fontified regions the property `fontified'. */);
24709 Vfontification_functions
= Qnil
;
24710 Fmake_variable_buffer_local (Qfontification_functions
);
24712 DEFVAR_BOOL ("unibyte-display-via-language-environment",
24713 &unibyte_display_via_language_environment
,
24714 doc
: /* *Non-nil means display unibyte text according to language environment.
24715 Specifically this means that unibyte non-ASCII characters
24716 are displayed by converting them to the equivalent multibyte characters
24717 according to the current language environment. As a result, they are
24718 displayed according to the current fontset. */);
24719 unibyte_display_via_language_environment
= 0;
24721 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
24722 doc
: /* *Maximum height for resizing mini-windows.
24723 If a float, it specifies a fraction of the mini-window frame's height.
24724 If an integer, it specifies a number of lines. */);
24725 Vmax_mini_window_height
= make_float (0.25);
24727 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
24728 doc
: /* *How to resize mini-windows.
24729 A value of nil means don't automatically resize mini-windows.
24730 A value of t means resize them to fit the text displayed in them.
24731 A value of `grow-only', the default, means let mini-windows grow
24732 only, until their display becomes empty, at which point the windows
24733 go back to their normal size. */);
24734 Vresize_mini_windows
= Qgrow_only
;
24736 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
24737 doc
: /* Alist specifying how to blink the cursor off.
24738 Each element has the form (ON-STATE . OFF-STATE). Whenever the
24739 `cursor-type' frame-parameter or variable equals ON-STATE,
24740 comparing using `equal', Emacs uses OFF-STATE to specify
24741 how to blink it off. ON-STATE and OFF-STATE are values for
24742 the `cursor-type' frame parameter.
24744 If a frame's ON-STATE has no entry in this list,
24745 the frame's other specifications determine how to blink the cursor off. */);
24746 Vblink_cursor_alist
= Qnil
;
24748 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
24749 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
24750 automatic_hscrolling_p
= 1;
24751 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
24752 staticpro (&Qauto_hscroll_mode
);
24754 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
24755 doc
: /* *How many columns away from the window edge point is allowed to get
24756 before automatic hscrolling will horizontally scroll the window. */);
24757 hscroll_margin
= 5;
24759 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
24760 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
24761 When point is less than `hscroll-margin' columns from the window
24762 edge, automatic hscrolling will scroll the window by the amount of columns
24763 determined by this variable. If its value is a positive integer, scroll that
24764 many columns. If it's a positive floating-point number, it specifies the
24765 fraction of the window's width to scroll. If it's nil or zero, point will be
24766 centered horizontally after the scroll. Any other value, including negative
24767 numbers, are treated as if the value were zero.
24769 Automatic hscrolling always moves point outside the scroll margin, so if
24770 point was more than scroll step columns inside the margin, the window will
24771 scroll more than the value given by the scroll step.
24773 Note that the lower bound for automatic hscrolling specified by `scroll-left'
24774 and `scroll-right' overrides this variable's effect. */);
24775 Vhscroll_step
= make_number (0);
24777 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
24778 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
24779 Bind this around calls to `message' to let it take effect. */);
24780 message_truncate_lines
= 0;
24782 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
24783 doc
: /* Normal hook run to update the menu bar definitions.
24784 Redisplay runs this hook before it redisplays the menu bar.
24785 This is used to update submenus such as Buffers,
24786 whose contents depend on various data. */);
24787 Vmenu_bar_update_hook
= Qnil
;
24789 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
24790 doc
: /* Frame for which we are updating a menu.
24791 The enable predicate for a menu binding should check this variable. */);
24792 Vmenu_updating_frame
= Qnil
;
24794 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
24795 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
24796 inhibit_menubar_update
= 0;
24798 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
24799 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
24800 inhibit_eval_during_redisplay
= 0;
24802 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
24803 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
24804 inhibit_free_realized_faces
= 0;
24807 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
24808 doc
: /* Inhibit try_window_id display optimization. */);
24809 inhibit_try_window_id
= 0;
24811 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
24812 doc
: /* Inhibit try_window_reusing display optimization. */);
24813 inhibit_try_window_reusing
= 0;
24815 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
24816 doc
: /* Inhibit try_cursor_movement display optimization. */);
24817 inhibit_try_cursor_movement
= 0;
24818 #endif /* GLYPH_DEBUG */
24820 DEFVAR_INT ("overline-margin", &overline_margin
,
24821 doc
: /* *Space between overline and text, in pixels.
24822 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
24823 margin to the caracter height. */);
24824 overline_margin
= 2;
24828 /* Initialize this module when Emacs starts. */
24833 Lisp_Object root_window
;
24834 struct window
*mini_w
;
24836 current_header_line_height
= current_mode_line_height
= -1;
24838 CHARPOS (this_line_start_pos
) = 0;
24840 mini_w
= XWINDOW (minibuf_window
);
24841 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
24843 if (!noninteractive
)
24845 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
24848 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
24849 set_window_height (root_window
,
24850 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
24852 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
24853 set_window_height (minibuf_window
, 1, 0);
24855 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
24856 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
24858 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
24859 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
24860 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
24862 /* The default ellipsis glyphs `...'. */
24863 for (i
= 0; i
< 3; ++i
)
24864 default_invis_vector
[i
] = make_number ('.');
24868 /* Allocate the buffer for frame titles.
24869 Also used for `format-mode-line'. */
24871 mode_line_noprop_buf
= (char *) xmalloc (size
);
24872 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
24873 mode_line_noprop_ptr
= mode_line_noprop_buf
;
24874 mode_line_target
= MODE_LINE_DISPLAY
;
24877 help_echo_showing_p
= 0;
24881 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
24882 (do not change this comment) */