1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
27 Emacs separates the task of updating the display from code
28 modifying global state, e.g. buffer text. This way functions
29 operating on buffers don't also have to be concerned with updating
32 Updating the display is triggered by the Lisp interpreter when it
33 decides it's time to do it. This is done either automatically for
34 you as part of the interpreter's command loop or as the result of
35 calling Lisp functions like `sit-for'. The C function `redisplay'
36 in xdisp.c is the only entry into the inner redisplay code. (Or,
37 let's say almost---see the description of direct update
40 The following diagram shows how redisplay code is invoked. As you
41 can see, Lisp calls redisplay and vice versa. Under window systems
42 like X, some portions of the redisplay code are also called
43 asynchronously during mouse movement or expose events. It is very
44 important that these code parts do NOT use the C library (malloc,
45 free) because many C libraries under Unix are not reentrant. They
46 may also NOT call functions of the Lisp interpreter which could
47 change the interpreter's state. If you don't follow these rules,
48 you will encounter bugs which are very hard to explain.
50 (Direct functions, see below)
51 direct_output_for_insert,
52 direct_forward_char (dispnew.c)
53 +---------------------------------+
56 +--------------+ redisplay +----------------+
57 | Lisp machine |---------------->| Redisplay code |<--+
58 +--------------+ (xdisp.c) +----------------+ |
60 +----------------------------------+ |
61 Don't use this path when called |
64 expose_window (asynchronous) |
66 X expose events -----+
68 What does redisplay do? Obviously, it has to figure out somehow what
69 has been changed since the last time the display has been updated,
70 and to make these changes visible. Preferably it would do that in
71 a moderately intelligent way, i.e. fast.
73 Changes in buffer text can be deduced from window and buffer
74 structures, and from some global variables like `beg_unchanged' and
75 `end_unchanged'. The contents of the display are additionally
76 recorded in a `glyph matrix', a two-dimensional matrix of glyph
77 structures. Each row in such a matrix corresponds to a line on the
78 display, and each glyph in a row corresponds to a column displaying
79 a character, an image, or what else. This matrix is called the
80 `current glyph matrix' or `current matrix' in redisplay
83 For buffer parts that have been changed since the last update, a
84 second glyph matrix is constructed, the so called `desired glyph
85 matrix' or short `desired matrix'. Current and desired matrix are
86 then compared to find a cheap way to update the display, e.g. by
87 reusing part of the display by scrolling lines.
92 You will find a lot of redisplay optimizations when you start
93 looking at the innards of redisplay. The overall goal of all these
94 optimizations is to make redisplay fast because it is done
97 Two optimizations are not found in xdisp.c. These are the direct
98 operations mentioned above. As the name suggests they follow a
99 different principle than the rest of redisplay. Instead of
100 building a desired matrix and then comparing it with the current
101 display, they perform their actions directly on the display and on
104 One direct operation updates the display after one character has
105 been entered. The other one moves the cursor by one position
106 forward or backward. You find these functions under the names
107 `direct_output_for_insert' and `direct_output_forward_char' in
113 Desired matrices are always built per Emacs window. The function
114 `display_line' is the central function to look at if you are
115 interested. It constructs one row in a desired matrix given an
116 iterator structure containing both a buffer position and a
117 description of the environment in which the text is to be
118 displayed. But this is too early, read on.
120 Characters and pixmaps displayed for a range of buffer text depend
121 on various settings of buffers and windows, on overlays and text
122 properties, on display tables, on selective display. The good news
123 is that all this hairy stuff is hidden behind a small set of
124 interface functions taking an iterator structure (struct it)
127 Iteration over things to be displayed is then simple. It is
128 started by initializing an iterator with a call to init_iterator.
129 Calls to get_next_display_element fill the iterator structure with
130 relevant information about the next thing to display. Calls to
131 set_iterator_to_next move the iterator to the next thing.
133 Besides this, an iterator also contains information about the
134 display environment in which glyphs for display elements are to be
135 produced. It has fields for the width and height of the display,
136 the information whether long lines are truncated or continued, a
137 current X and Y position, and lots of other stuff you can better
140 Glyphs in a desired matrix are normally constructed in a loop
141 calling get_next_display_element and then produce_glyphs. The call
142 to produce_glyphs will fill the iterator structure with pixel
143 information about the element being displayed and at the same time
144 produce glyphs for it. If the display element fits on the line
145 being displayed, set_iterator_to_next is called next, otherwise the
146 glyphs produced are discarded.
151 That just couldn't be all, could it? What about terminal types not
152 supporting operations on sub-windows of the screen? To update the
153 display on such a terminal, window-based glyph matrices are not
154 well suited. To be able to reuse part of the display (scrolling
155 lines up and down), we must instead have a view of the whole
156 screen. This is what `frame matrices' are for. They are a trick.
158 Frames on terminals like above have a glyph pool. Windows on such
159 a frame sub-allocate their glyph memory from their frame's glyph
160 pool. The frame itself is given its own glyph matrices. By
161 coincidence---or maybe something else---rows in window glyph
162 matrices are slices of corresponding rows in frame matrices. Thus
163 writing to window matrices implicitly updates a frame matrix which
164 provides us with the view of the whole screen that we originally
165 wanted to have without having to move many bytes around. To be
166 honest, there is a little bit more done, but not much more. If you
167 plan to extend that code, take a look at dispnew.c. The function
168 build_frame_matrix is a good starting point. */
174 #include "keyboard.h"
177 #include "termchar.h"
178 #include "dispextern.h"
180 #include "character.h"
183 #include "commands.h"
187 #include "termhooks.h"
188 #include "intervals.h"
191 #include "region-cache.h"
193 #include "blockinput.h"
195 #ifdef HAVE_X_WINDOWS
205 #ifdef HAVE_WINDOW_SYSTEM
206 #ifdef USE_FONT_BACKEND
208 #endif /* USE_FONT_BACKEND */
209 #endif /* HAVE_WINDOW_SYSTEM */
211 #ifndef FRAME_X_OUTPUT
212 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
215 #define INFINITY 10000000
217 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
219 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
220 extern int pending_menu_activation
;
223 extern int interrupt_input
;
224 extern int command_loop_level
;
226 extern Lisp_Object do_mouse_tracking
;
228 extern int minibuffer_auto_raise
;
229 extern Lisp_Object Vminibuffer_list
;
231 extern Lisp_Object Qface
;
232 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
234 extern Lisp_Object Voverriding_local_map
;
235 extern Lisp_Object Voverriding_local_map_menu_flag
;
236 extern Lisp_Object Qmenu_item
;
237 extern Lisp_Object Qwhen
;
238 extern Lisp_Object Qhelp_echo
;
240 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
241 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
242 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
243 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
244 Lisp_Object Qinhibit_point_motion_hooks
;
245 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
246 Lisp_Object Qfontified
;
247 Lisp_Object Qgrow_only
;
248 Lisp_Object Qinhibit_eval_during_redisplay
;
249 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
252 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
255 Lisp_Object Qarrow
, Qhand
, Qtext
;
257 Lisp_Object Qrisky_local_variable
;
259 /* Holds the list (error). */
260 Lisp_Object list_of_error
;
262 /* Functions called to fontify regions of text. */
264 Lisp_Object Vfontification_functions
;
265 Lisp_Object Qfontification_functions
;
267 /* Non-nil means automatically select any window when the mouse
268 cursor moves into it. */
269 Lisp_Object Vmouse_autoselect_window
;
271 /* Non-zero means draw tool bar buttons raised when the mouse moves
274 int auto_raise_tool_bar_buttons_p
;
276 /* Non-zero means to reposition window if cursor line is only partially visible. */
278 int make_cursor_line_fully_visible_p
;
280 /* Margin below tool bar in pixels. 0 or nil means no margin.
281 If value is `internal-border-width' or `border-width',
282 the corresponding frame parameter is used. */
284 Lisp_Object Vtool_bar_border
;
286 /* Margin around tool bar buttons in pixels. */
288 Lisp_Object Vtool_bar_button_margin
;
290 /* Thickness of shadow to draw around tool bar buttons. */
292 EMACS_INT tool_bar_button_relief
;
294 /* Non-nil means automatically resize tool-bars so that all tool-bar
295 items are visible, and no blank lines remain.
297 If value is `grow-only', only make tool-bar bigger. */
299 Lisp_Object Vauto_resize_tool_bars
;
301 /* Non-zero means draw block and hollow cursor as wide as the glyph
302 under it. For example, if a block cursor is over a tab, it will be
303 drawn as wide as that tab on the display. */
305 int x_stretch_cursor_p
;
307 /* Non-nil means don't actually do any redisplay. */
309 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
311 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
313 int inhibit_eval_during_redisplay
;
315 /* Names of text properties relevant for redisplay. */
317 Lisp_Object Qdisplay
;
318 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
320 /* Symbols used in text property values. */
322 Lisp_Object Vdisplay_pixels_per_inch
;
323 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
324 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
327 Lisp_Object Qmargin
, Qpointer
;
328 Lisp_Object Qline_height
;
329 extern Lisp_Object Qheight
;
330 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
331 extern Lisp_Object Qscroll_bar
;
332 extern Lisp_Object Qcursor
;
334 /* Non-nil means highlight trailing whitespace. */
336 Lisp_Object Vshow_trailing_whitespace
;
338 /* Non-nil means escape non-break space and hyphens. */
340 Lisp_Object Vnobreak_char_display
;
342 #ifdef HAVE_WINDOW_SYSTEM
343 extern Lisp_Object Voverflow_newline_into_fringe
;
345 /* Test if overflow newline into fringe. Called with iterator IT
346 at or past right window margin, and with IT->current_x set. */
348 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
349 (!NILP (Voverflow_newline_into_fringe) \
350 && FRAME_WINDOW_P (it->f) \
351 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
352 && it->current_x == it->last_visible_x)
354 #endif /* HAVE_WINDOW_SYSTEM */
356 /* Non-nil means show the text cursor in void text areas
357 i.e. in blank areas after eol and eob. This used to be
358 the default in 21.3. */
360 Lisp_Object Vvoid_text_area_pointer
;
362 /* Name of the face used to highlight trailing whitespace. */
364 Lisp_Object Qtrailing_whitespace
;
366 /* Name and number of the face used to highlight escape glyphs. */
368 Lisp_Object Qescape_glyph
;
370 /* Name and number of the face used to highlight non-breaking spaces. */
372 Lisp_Object Qnobreak_space
;
374 /* The symbol `image' which is the car of the lists used to represent
379 /* The image map types. */
380 Lisp_Object QCmap
, QCpointer
;
381 Lisp_Object Qrect
, Qcircle
, Qpoly
;
383 /* Non-zero means print newline to stdout before next mini-buffer
386 int noninteractive_need_newline
;
388 /* Non-zero means print newline to message log before next message. */
390 static int message_log_need_newline
;
392 /* Three markers that message_dolog uses.
393 It could allocate them itself, but that causes trouble
394 in handling memory-full errors. */
395 static Lisp_Object message_dolog_marker1
;
396 static Lisp_Object message_dolog_marker2
;
397 static Lisp_Object message_dolog_marker3
;
399 /* The buffer position of the first character appearing entirely or
400 partially on the line of the selected window which contains the
401 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
402 redisplay optimization in redisplay_internal. */
404 static struct text_pos this_line_start_pos
;
406 /* Number of characters past the end of the line above, including the
407 terminating newline. */
409 static struct text_pos this_line_end_pos
;
411 /* The vertical positions and the height of this line. */
413 static int this_line_vpos
;
414 static int this_line_y
;
415 static int this_line_pixel_height
;
417 /* X position at which this display line starts. Usually zero;
418 negative if first character is partially visible. */
420 static int this_line_start_x
;
422 /* Buffer that this_line_.* variables are referring to. */
424 static struct buffer
*this_line_buffer
;
426 /* Nonzero means truncate lines in all windows less wide than the
429 int truncate_partial_width_windows
;
431 /* A flag to control how to display unibyte 8-bit character. */
433 int unibyte_display_via_language_environment
;
435 /* Nonzero means we have more than one non-mini-buffer-only frame.
436 Not guaranteed to be accurate except while parsing
437 frame-title-format. */
441 Lisp_Object Vglobal_mode_string
;
444 /* List of variables (symbols) which hold markers for overlay arrows.
445 The symbols on this list are examined during redisplay to determine
446 where to display overlay arrows. */
448 Lisp_Object Voverlay_arrow_variable_list
;
450 /* Marker for where to display an arrow on top of the buffer text. */
452 Lisp_Object Voverlay_arrow_position
;
454 /* String to display for the arrow. Only used on terminal frames. */
456 Lisp_Object Voverlay_arrow_string
;
458 /* Values of those variables at last redisplay are stored as
459 properties on `overlay-arrow-position' symbol. However, if
460 Voverlay_arrow_position is a marker, last-arrow-position is its
461 numerical position. */
463 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
465 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
466 properties on a symbol in overlay-arrow-variable-list. */
468 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
470 /* Like mode-line-format, but for the title bar on a visible frame. */
472 Lisp_Object Vframe_title_format
;
474 /* Like mode-line-format, but for the title bar on an iconified frame. */
476 Lisp_Object Vicon_title_format
;
478 /* List of functions to call when a window's size changes. These
479 functions get one arg, a frame on which one or more windows' sizes
482 static Lisp_Object Vwindow_size_change_functions
;
484 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
486 /* Nonzero if an overlay arrow has been displayed in this window. */
488 static int overlay_arrow_seen
;
490 /* Nonzero means highlight the region even in nonselected windows. */
492 int highlight_nonselected_windows
;
494 /* If cursor motion alone moves point off frame, try scrolling this
495 many lines up or down if that will bring it back. */
497 static EMACS_INT scroll_step
;
499 /* Nonzero means scroll just far enough to bring point back on the
500 screen, when appropriate. */
502 static EMACS_INT scroll_conservatively
;
504 /* Recenter the window whenever point gets within this many lines of
505 the top or bottom of the window. This value is translated into a
506 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
507 that there is really a fixed pixel height scroll margin. */
509 EMACS_INT scroll_margin
;
511 /* Number of windows showing the buffer of the selected window (or
512 another buffer with the same base buffer). keyboard.c refers to
517 /* Vector containing glyphs for an ellipsis `...'. */
519 static Lisp_Object default_invis_vector
[3];
521 /* Zero means display the mode-line/header-line/menu-bar in the default face
522 (this slightly odd definition is for compatibility with previous versions
523 of emacs), non-zero means display them using their respective faces.
525 This variable is deprecated. */
527 int mode_line_inverse_video
;
529 /* Prompt to display in front of the mini-buffer contents. */
531 Lisp_Object minibuf_prompt
;
533 /* Width of current mini-buffer prompt. Only set after display_line
534 of the line that contains the prompt. */
536 int minibuf_prompt_width
;
538 /* This is the window where the echo area message was displayed. It
539 is always a mini-buffer window, but it may not be the same window
540 currently active as a mini-buffer. */
542 Lisp_Object echo_area_window
;
544 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
545 pushes the current message and the value of
546 message_enable_multibyte on the stack, the function restore_message
547 pops the stack and displays MESSAGE again. */
549 Lisp_Object Vmessage_stack
;
551 /* Nonzero means multibyte characters were enabled when the echo area
552 message was specified. */
554 int message_enable_multibyte
;
556 /* Nonzero if we should redraw the mode lines on the next redisplay. */
558 int update_mode_lines
;
560 /* Nonzero if window sizes or contents have changed since last
561 redisplay that finished. */
563 int windows_or_buffers_changed
;
565 /* Nonzero means a frame's cursor type has been changed. */
567 int cursor_type_changed
;
569 /* Nonzero after display_mode_line if %l was used and it displayed a
572 int line_number_displayed
;
574 /* Maximum buffer size for which to display line numbers. */
576 Lisp_Object Vline_number_display_limit
;
578 /* Line width to consider when repositioning for line number display. */
580 static EMACS_INT line_number_display_limit_width
;
582 /* Number of lines to keep in the message log buffer. t means
583 infinite. nil means don't log at all. */
585 Lisp_Object Vmessage_log_max
;
587 /* The name of the *Messages* buffer, a string. */
589 static Lisp_Object Vmessages_buffer_name
;
591 /* Current, index 0, and last displayed echo area message. Either
592 buffers from echo_buffers, or nil to indicate no message. */
594 Lisp_Object echo_area_buffer
[2];
596 /* The buffers referenced from echo_area_buffer. */
598 static Lisp_Object echo_buffer
[2];
600 /* A vector saved used in with_area_buffer to reduce consing. */
602 static Lisp_Object Vwith_echo_area_save_vector
;
604 /* Non-zero means display_echo_area should display the last echo area
605 message again. Set by redisplay_preserve_echo_area. */
607 static int display_last_displayed_message_p
;
609 /* Nonzero if echo area is being used by print; zero if being used by
612 int message_buf_print
;
614 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
616 Lisp_Object Qinhibit_menubar_update
;
617 int inhibit_menubar_update
;
619 /* When evaluating expressions from menu bar items (enable conditions,
620 for instance), this is the frame they are being processed for. */
622 Lisp_Object Vmenu_updating_frame
;
624 /* Maximum height for resizing mini-windows. Either a float
625 specifying a fraction of the available height, or an integer
626 specifying a number of lines. */
628 Lisp_Object Vmax_mini_window_height
;
630 /* Non-zero means messages should be displayed with truncated
631 lines instead of being continued. */
633 int message_truncate_lines
;
634 Lisp_Object Qmessage_truncate_lines
;
636 /* Set to 1 in clear_message to make redisplay_internal aware
637 of an emptied echo area. */
639 static int message_cleared_p
;
641 /* How to blink the default frame cursor off. */
642 Lisp_Object Vblink_cursor_alist
;
644 /* A scratch glyph row with contents used for generating truncation
645 glyphs. Also used in direct_output_for_insert. */
647 #define MAX_SCRATCH_GLYPHS 100
648 struct glyph_row scratch_glyph_row
;
649 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
651 /* Ascent and height of the last line processed by move_it_to. */
653 static int last_max_ascent
, last_height
;
655 /* Non-zero if there's a help-echo in the echo area. */
657 int help_echo_showing_p
;
659 /* If >= 0, computed, exact values of mode-line and header-line height
660 to use in the macros CURRENT_MODE_LINE_HEIGHT and
661 CURRENT_HEADER_LINE_HEIGHT. */
663 int current_mode_line_height
, current_header_line_height
;
665 /* The maximum distance to look ahead for text properties. Values
666 that are too small let us call compute_char_face and similar
667 functions too often which is expensive. Values that are too large
668 let us call compute_char_face and alike too often because we
669 might not be interested in text properties that far away. */
671 #define TEXT_PROP_DISTANCE_LIMIT 100
675 /* Variables to turn off display optimizations from Lisp. */
677 int inhibit_try_window_id
, inhibit_try_window_reusing
;
678 int inhibit_try_cursor_movement
;
680 /* Non-zero means print traces of redisplay if compiled with
683 int trace_redisplay_p
;
685 #endif /* GLYPH_DEBUG */
687 #ifdef DEBUG_TRACE_MOVE
688 /* Non-zero means trace with TRACE_MOVE to stderr. */
691 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
693 #define TRACE_MOVE(x) (void) 0
696 /* Non-zero means automatically scroll windows horizontally to make
699 int automatic_hscrolling_p
;
700 Lisp_Object Qauto_hscroll_mode
;
702 /* How close to the margin can point get before the window is scrolled
704 EMACS_INT hscroll_margin
;
706 /* How much to scroll horizontally when point is inside the above margin. */
707 Lisp_Object Vhscroll_step
;
709 /* The variable `resize-mini-windows'. If nil, don't resize
710 mini-windows. If t, always resize them to fit the text they
711 display. If `grow-only', let mini-windows grow only until they
714 Lisp_Object Vresize_mini_windows
;
716 /* Buffer being redisplayed -- for redisplay_window_error. */
718 struct buffer
*displayed_buffer
;
720 /* Space between overline and text. */
722 EMACS_INT overline_margin
;
724 /* Value returned from text property handlers (see below). */
729 HANDLED_RECOMPUTE_PROPS
,
730 HANDLED_OVERLAY_STRING_CONSUMED
,
734 /* A description of text properties that redisplay is interested
739 /* The name of the property. */
742 /* A unique index for the property. */
745 /* A handler function called to set up iterator IT from the property
746 at IT's current position. Value is used to steer handle_stop. */
747 enum prop_handled (*handler
) P_ ((struct it
*it
));
750 static enum prop_handled handle_face_prop
P_ ((struct it
*));
751 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
752 static enum prop_handled handle_display_prop
P_ ((struct it
*));
753 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
754 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
755 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
756 static enum prop_handled handle_auto_composed_prop
P_ ((struct it
*));
758 /* Properties handled by iterators. */
760 static struct props it_props
[] =
762 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
763 /* Handle `face' before `display' because some sub-properties of
764 `display' need to know the face. */
765 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
766 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
767 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
768 {&Qauto_composed
, AUTO_COMPOSED_PROP_IDX
, handle_auto_composed_prop
},
769 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
773 /* Value is the position described by X. If X is a marker, value is
774 the marker_position of X. Otherwise, value is X. */
776 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
778 /* Enumeration returned by some move_it_.* functions internally. */
782 /* Not used. Undefined value. */
785 /* Move ended at the requested buffer position or ZV. */
786 MOVE_POS_MATCH_OR_ZV
,
788 /* Move ended at the requested X pixel position. */
791 /* Move within a line ended at the end of a line that must be
795 /* Move within a line ended at the end of a line that would
796 be displayed truncated. */
799 /* Move within a line ended at a line end. */
803 /* This counter is used to clear the face cache every once in a while
804 in redisplay_internal. It is incremented for each redisplay.
805 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
808 #define CLEAR_FACE_CACHE_COUNT 500
809 static int clear_face_cache_count
;
811 /* Similarly for the image cache. */
813 #ifdef HAVE_WINDOW_SYSTEM
814 #define CLEAR_IMAGE_CACHE_COUNT 101
815 static int clear_image_cache_count
;
818 /* Non-zero while redisplay_internal is in progress. */
822 /* Non-zero means don't free realized faces. Bound while freeing
823 realized faces is dangerous because glyph matrices might still
826 int inhibit_free_realized_faces
;
827 Lisp_Object Qinhibit_free_realized_faces
;
829 /* If a string, XTread_socket generates an event to display that string.
830 (The display is done in read_char.) */
832 Lisp_Object help_echo_string
;
833 Lisp_Object help_echo_window
;
834 Lisp_Object help_echo_object
;
837 /* Temporary variable for XTread_socket. */
839 Lisp_Object previous_help_echo_string
;
841 /* Null glyph slice */
843 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
846 /* Function prototypes. */
848 static void setup_for_ellipsis
P_ ((struct it
*, int));
849 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
850 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
851 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
852 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
853 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
854 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
857 static int invisible_text_between_p
P_ ((struct it
*, int, int));
860 static void pint2str
P_ ((char *, int, int));
861 static void pint2hrstr
P_ ((char *, int, int));
862 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
864 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
865 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
866 static void store_mode_line_noprop_char
P_ ((char));
867 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
868 static void x_consider_frame_title
P_ ((Lisp_Object
));
869 static void handle_stop
P_ ((struct it
*));
870 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
871 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
872 static void ensure_echo_area_buffers
P_ ((void));
873 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
874 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
875 static int with_echo_area_buffer
P_ ((struct window
*, int,
876 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
877 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
878 static void clear_garbaged_frames
P_ ((void));
879 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
880 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
881 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
882 static int display_echo_area
P_ ((struct window
*));
883 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
884 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
885 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
886 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
887 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
889 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
890 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
891 static void insert_left_trunc_glyphs
P_ ((struct it
*));
892 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
894 static void extend_face_to_end_of_line
P_ ((struct it
*));
895 static int append_space_for_newline
P_ ((struct it
*, int));
896 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
897 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
898 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
899 static int trailing_whitespace_p
P_ ((int));
900 static int message_log_check_duplicate
P_ ((int, int, int, int));
901 static void push_it
P_ ((struct it
*));
902 static void pop_it
P_ ((struct it
*));
903 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
904 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
905 static void redisplay_internal
P_ ((int));
906 static int echo_area_display
P_ ((int));
907 static void redisplay_windows
P_ ((Lisp_Object
));
908 static void redisplay_window
P_ ((Lisp_Object
, int));
909 static Lisp_Object
redisplay_window_error ();
910 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
911 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
912 static int update_menu_bar
P_ ((struct frame
*, int, int));
913 static int try_window_reusing_current_matrix
P_ ((struct window
*));
914 static int try_window_id
P_ ((struct window
*));
915 static int display_line
P_ ((struct it
*));
916 static int display_mode_lines
P_ ((struct window
*));
917 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
918 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
919 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
920 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
921 static void display_menu_bar
P_ ((struct window
*));
922 static int display_count_lines
P_ ((int, int, int, int, int *));
923 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
924 int, int, struct it
*, int, int, int, int));
925 static void compute_line_metrics
P_ ((struct it
*));
926 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
927 static int get_overlay_strings
P_ ((struct it
*, int));
928 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
929 static void next_overlay_string
P_ ((struct it
*));
930 static void reseat
P_ ((struct it
*, struct text_pos
, int));
931 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
932 static void back_to_previous_visible_line_start
P_ ((struct it
*));
933 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
934 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
935 static int next_element_from_ellipsis
P_ ((struct it
*));
936 static int next_element_from_display_vector
P_ ((struct it
*));
937 static int next_element_from_string
P_ ((struct it
*));
938 static int next_element_from_c_string
P_ ((struct it
*));
939 static int next_element_from_buffer
P_ ((struct it
*));
940 static int next_element_from_composition
P_ ((struct it
*));
941 static int next_element_from_image
P_ ((struct it
*));
942 static int next_element_from_stretch
P_ ((struct it
*));
943 static void load_overlay_strings
P_ ((struct it
*, int));
944 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
945 struct display_pos
*));
946 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
947 Lisp_Object
, int, int, int, int));
948 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
950 void move_it_vertically_backward
P_ ((struct it
*, int));
951 static void init_to_row_start
P_ ((struct it
*, struct window
*,
952 struct glyph_row
*));
953 static int init_to_row_end
P_ ((struct it
*, struct window
*,
954 struct glyph_row
*));
955 static void back_to_previous_line_start
P_ ((struct it
*));
956 static int forward_to_next_line_start
P_ ((struct it
*, int *));
957 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
959 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
960 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
961 static int number_of_chars
P_ ((unsigned char *, int));
962 static void compute_stop_pos
P_ ((struct it
*));
963 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
965 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
966 static int next_overlay_change
P_ ((int));
967 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
968 Lisp_Object
, Lisp_Object
,
969 struct text_pos
*, int));
970 static int underlying_face_id
P_ ((struct it
*));
971 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
974 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
975 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
977 #ifdef HAVE_WINDOW_SYSTEM
979 static void update_tool_bar
P_ ((struct frame
*, int));
980 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
981 static int redisplay_tool_bar
P_ ((struct frame
*));
982 static void display_tool_bar_line
P_ ((struct it
*, int));
983 static void notice_overwritten_cursor
P_ ((struct window
*,
985 int, int, int, int));
989 #endif /* HAVE_WINDOW_SYSTEM */
992 /***********************************************************************
993 Window display dimensions
994 ***********************************************************************/
996 /* Return the bottom boundary y-position for text lines in window W.
997 This is the first y position at which a line cannot start.
998 It is relative to the top of the window.
1000 This is the height of W minus the height of a mode line, if any. */
1003 window_text_bottom_y (w
)
1006 int height
= WINDOW_TOTAL_HEIGHT (w
);
1008 if (WINDOW_WANTS_MODELINE_P (w
))
1009 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1013 /* Return the pixel width of display area AREA of window W. AREA < 0
1014 means return the total width of W, not including fringes to
1015 the left and right of the window. */
1018 window_box_width (w
, area
)
1022 int cols
= XFASTINT (w
->total_cols
);
1025 if (!w
->pseudo_window_p
)
1027 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1029 if (area
== TEXT_AREA
)
1031 if (INTEGERP (w
->left_margin_cols
))
1032 cols
-= XFASTINT (w
->left_margin_cols
);
1033 if (INTEGERP (w
->right_margin_cols
))
1034 cols
-= XFASTINT (w
->right_margin_cols
);
1035 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1037 else if (area
== LEFT_MARGIN_AREA
)
1039 cols
= (INTEGERP (w
->left_margin_cols
)
1040 ? XFASTINT (w
->left_margin_cols
) : 0);
1043 else if (area
== RIGHT_MARGIN_AREA
)
1045 cols
= (INTEGERP (w
->right_margin_cols
)
1046 ? XFASTINT (w
->right_margin_cols
) : 0);
1051 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1055 /* Return the pixel height of the display area of window W, not
1056 including mode lines of W, if any. */
1059 window_box_height (w
)
1062 struct frame
*f
= XFRAME (w
->frame
);
1063 int height
= WINDOW_TOTAL_HEIGHT (w
);
1065 xassert (height
>= 0);
1067 /* Note: the code below that determines the mode-line/header-line
1068 height is essentially the same as that contained in the macro
1069 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1070 the appropriate glyph row has its `mode_line_p' flag set,
1071 and if it doesn't, uses estimate_mode_line_height instead. */
1073 if (WINDOW_WANTS_MODELINE_P (w
))
1075 struct glyph_row
*ml_row
1076 = (w
->current_matrix
&& w
->current_matrix
->rows
1077 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1079 if (ml_row
&& ml_row
->mode_line_p
)
1080 height
-= ml_row
->height
;
1082 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1085 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1087 struct glyph_row
*hl_row
1088 = (w
->current_matrix
&& w
->current_matrix
->rows
1089 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1091 if (hl_row
&& hl_row
->mode_line_p
)
1092 height
-= hl_row
->height
;
1094 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1097 /* With a very small font and a mode-line that's taller than
1098 default, we might end up with a negative height. */
1099 return max (0, height
);
1102 /* Return the window-relative coordinate of the left edge of display
1103 area AREA of window W. AREA < 0 means return the left edge of the
1104 whole window, to the right of the left fringe of W. */
1107 window_box_left_offset (w
, area
)
1113 if (w
->pseudo_window_p
)
1116 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1118 if (area
== TEXT_AREA
)
1119 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1120 + window_box_width (w
, LEFT_MARGIN_AREA
));
1121 else if (area
== RIGHT_MARGIN_AREA
)
1122 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1123 + window_box_width (w
, LEFT_MARGIN_AREA
)
1124 + window_box_width (w
, TEXT_AREA
)
1125 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1127 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1128 else if (area
== LEFT_MARGIN_AREA
1129 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1130 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1136 /* Return the window-relative coordinate of the right edge of display
1137 area AREA of window W. AREA < 0 means return the left edge of the
1138 whole window, to the left of the right fringe of W. */
1141 window_box_right_offset (w
, area
)
1145 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1148 /* Return the frame-relative coordinate of the left edge of display
1149 area AREA of window W. AREA < 0 means return the left edge of the
1150 whole window, to the right of the left fringe of W. */
1153 window_box_left (w
, area
)
1157 struct frame
*f
= XFRAME (w
->frame
);
1160 if (w
->pseudo_window_p
)
1161 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1163 x
= (WINDOW_LEFT_EDGE_X (w
)
1164 + window_box_left_offset (w
, area
));
1170 /* Return the frame-relative coordinate of the right edge of display
1171 area AREA of window W. AREA < 0 means return the left edge of the
1172 whole window, to the left of the right fringe of W. */
1175 window_box_right (w
, area
)
1179 return window_box_left (w
, area
) + window_box_width (w
, area
);
1182 /* Get the bounding box of the display area AREA of window W, without
1183 mode lines, in frame-relative coordinates. AREA < 0 means the
1184 whole window, not including the left and right fringes of
1185 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1186 coordinates of the upper-left corner of the box. Return in
1187 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1190 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1193 int *box_x
, *box_y
, *box_width
, *box_height
;
1196 *box_width
= window_box_width (w
, area
);
1198 *box_height
= window_box_height (w
);
1200 *box_x
= window_box_left (w
, area
);
1203 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1204 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1205 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1210 /* Get the bounding box of the display area AREA of window W, without
1211 mode lines. AREA < 0 means the whole window, not including the
1212 left and right fringe of the window. Return in *TOP_LEFT_X
1213 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1214 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1215 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1219 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1220 bottom_right_x
, bottom_right_y
)
1223 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1225 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1227 *bottom_right_x
+= *top_left_x
;
1228 *bottom_right_y
+= *top_left_y
;
1233 /***********************************************************************
1235 ***********************************************************************/
1237 /* Return the bottom y-position of the line the iterator IT is in.
1238 This can modify IT's settings. */
1244 int line_height
= it
->max_ascent
+ it
->max_descent
;
1245 int line_top_y
= it
->current_y
;
1247 if (line_height
== 0)
1250 line_height
= last_height
;
1251 else if (IT_CHARPOS (*it
) < ZV
)
1253 move_it_by_lines (it
, 1, 1);
1254 line_height
= (it
->max_ascent
|| it
->max_descent
1255 ? it
->max_ascent
+ it
->max_descent
1260 struct glyph_row
*row
= it
->glyph_row
;
1262 /* Use the default character height. */
1263 it
->glyph_row
= NULL
;
1264 it
->what
= IT_CHARACTER
;
1267 PRODUCE_GLYPHS (it
);
1268 line_height
= it
->ascent
+ it
->descent
;
1269 it
->glyph_row
= row
;
1273 return line_top_y
+ line_height
;
1277 /* Return 1 if position CHARPOS is visible in window W.
1278 CHARPOS < 0 means return info about WINDOW_END position.
1279 If visible, set *X and *Y to pixel coordinates of top left corner.
1280 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1281 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1284 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1286 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1289 struct text_pos top
;
1291 struct buffer
*old_buffer
= NULL
;
1296 if (XBUFFER (w
->buffer
) != current_buffer
)
1298 old_buffer
= current_buffer
;
1299 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1302 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1304 /* Compute exact mode line heights. */
1305 if (WINDOW_WANTS_MODELINE_P (w
))
1306 current_mode_line_height
1307 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1308 current_buffer
->mode_line_format
);
1310 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1311 current_header_line_height
1312 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1313 current_buffer
->header_line_format
);
1315 start_display (&it
, w
, top
);
1316 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1317 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1319 /* Note that we may overshoot because of invisible text. */
1320 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1322 int top_x
= it
.current_x
;
1323 int top_y
= it
.current_y
;
1324 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1325 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1327 if (top_y
< window_top_y
)
1328 visible_p
= bottom_y
> window_top_y
;
1329 else if (top_y
< it
.last_visible_y
)
1333 Lisp_Object window
, prop
;
1335 XSETWINDOW (window
, w
);
1336 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1337 Qinvisible
, window
);
1339 /* If charpos coincides with invisible text covered with an
1340 ellipsis, use the first glyph of the ellipsis to compute
1341 the pixel positions. */
1342 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1344 struct glyph_row
*row
= it
.glyph_row
;
1345 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1346 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1349 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1350 x
+= glyph
->pixel_width
;
1356 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1357 *rtop
= max (0, window_top_y
- top_y
);
1358 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1359 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1360 - max (top_y
, window_top_y
)));
1369 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1370 move_it_by_lines (&it
, 1, 0);
1371 if (charpos
< IT_CHARPOS (it
)
1372 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1375 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1377 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1378 *rtop
= max (0, -it2
.current_y
);
1379 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1380 - it
.last_visible_y
));
1381 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1383 - max (it2
.current_y
,
1384 WINDOW_HEADER_LINE_HEIGHT (w
))));
1390 set_buffer_internal_1 (old_buffer
);
1392 current_header_line_height
= current_mode_line_height
= -1;
1394 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1395 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1398 /* Debugging code. */
1400 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1401 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1403 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1410 /* Return the next character from STR which is MAXLEN bytes long.
1411 Return in *LEN the length of the character. This is like
1412 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1413 we find one, we return a `?', but with the length of the invalid
1417 string_char_and_length (str
, maxlen
, len
)
1418 const unsigned char *str
;
1423 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1424 if (!CHAR_VALID_P (c
, 1))
1425 /* We may not change the length here because other places in Emacs
1426 don't use this function, i.e. they silently accept invalid
1435 /* Given a position POS containing a valid character and byte position
1436 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1438 static struct text_pos
1439 string_pos_nchars_ahead (pos
, string
, nchars
)
1440 struct text_pos pos
;
1444 xassert (STRINGP (string
) && nchars
>= 0);
1446 if (STRING_MULTIBYTE (string
))
1448 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1449 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1454 string_char_and_length (p
, rest
, &len
);
1455 p
+= len
, rest
-= len
;
1456 xassert (rest
>= 0);
1458 BYTEPOS (pos
) += len
;
1462 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1468 /* Value is the text position, i.e. character and byte position,
1469 for character position CHARPOS in STRING. */
1471 static INLINE
struct text_pos
1472 string_pos (charpos
, string
)
1476 struct text_pos pos
;
1477 xassert (STRINGP (string
));
1478 xassert (charpos
>= 0);
1479 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1484 /* Value is a text position, i.e. character and byte position, for
1485 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1486 means recognize multibyte characters. */
1488 static struct text_pos
1489 c_string_pos (charpos
, s
, multibyte_p
)
1494 struct text_pos pos
;
1496 xassert (s
!= NULL
);
1497 xassert (charpos
>= 0);
1501 int rest
= strlen (s
), len
;
1503 SET_TEXT_POS (pos
, 0, 0);
1506 string_char_and_length (s
, rest
, &len
);
1507 s
+= len
, rest
-= len
;
1508 xassert (rest
>= 0);
1510 BYTEPOS (pos
) += len
;
1514 SET_TEXT_POS (pos
, charpos
, charpos
);
1520 /* Value is the number of characters in C string S. MULTIBYTE_P
1521 non-zero means recognize multibyte characters. */
1524 number_of_chars (s
, multibyte_p
)
1532 int rest
= strlen (s
), len
;
1533 unsigned char *p
= (unsigned char *) s
;
1535 for (nchars
= 0; rest
> 0; ++nchars
)
1537 string_char_and_length (p
, rest
, &len
);
1538 rest
-= len
, p
+= len
;
1542 nchars
= strlen (s
);
1548 /* Compute byte position NEWPOS->bytepos corresponding to
1549 NEWPOS->charpos. POS is a known position in string STRING.
1550 NEWPOS->charpos must be >= POS.charpos. */
1553 compute_string_pos (newpos
, pos
, string
)
1554 struct text_pos
*newpos
, pos
;
1557 xassert (STRINGP (string
));
1558 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1560 if (STRING_MULTIBYTE (string
))
1561 *newpos
= string_pos_nchars_ahead (pos
, string
,
1562 CHARPOS (*newpos
) - CHARPOS (pos
));
1564 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1568 Return an estimation of the pixel height of mode or top lines on
1569 frame F. FACE_ID specifies what line's height to estimate. */
1572 estimate_mode_line_height (f
, face_id
)
1574 enum face_id face_id
;
1576 #ifdef HAVE_WINDOW_SYSTEM
1577 if (FRAME_WINDOW_P (f
))
1579 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1581 /* This function is called so early when Emacs starts that the face
1582 cache and mode line face are not yet initialized. */
1583 if (FRAME_FACE_CACHE (f
))
1585 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1589 height
= FONT_HEIGHT (face
->font
);
1590 if (face
->box_line_width
> 0)
1591 height
+= 2 * face
->box_line_width
;
1602 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1603 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1604 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1605 not force the value into range. */
1608 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1610 register int pix_x
, pix_y
;
1612 NativeRectangle
*bounds
;
1616 #ifdef HAVE_WINDOW_SYSTEM
1617 if (FRAME_WINDOW_P (f
))
1619 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1620 even for negative values. */
1622 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1624 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1626 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1627 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1630 STORE_NATIVE_RECT (*bounds
,
1631 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1632 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1633 FRAME_COLUMN_WIDTH (f
) - 1,
1634 FRAME_LINE_HEIGHT (f
) - 1);
1640 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1641 pix_x
= FRAME_TOTAL_COLS (f
);
1645 else if (pix_y
> FRAME_LINES (f
))
1646 pix_y
= FRAME_LINES (f
);
1656 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1657 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1658 can't tell the positions because W's display is not up to date,
1662 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1665 int *frame_x
, *frame_y
;
1667 #ifdef HAVE_WINDOW_SYSTEM
1668 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1672 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1673 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1675 if (display_completed
)
1677 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1678 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1679 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1685 hpos
+= glyph
->pixel_width
;
1689 /* If first glyph is partially visible, its first visible position is still 0. */
1701 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1702 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1713 #ifdef HAVE_WINDOW_SYSTEM
1715 /* Find the glyph under window-relative coordinates X/Y in window W.
1716 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1717 strings. Return in *HPOS and *VPOS the row and column number of
1718 the glyph found. Return in *AREA the glyph area containing X.
1719 Value is a pointer to the glyph found or null if X/Y is not on
1720 text, or we can't tell because W's current matrix is not up to
1723 static struct glyph
*
1724 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1727 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1729 struct glyph
*glyph
, *end
;
1730 struct glyph_row
*row
= NULL
;
1733 /* Find row containing Y. Give up if some row is not enabled. */
1734 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1736 row
= MATRIX_ROW (w
->current_matrix
, i
);
1737 if (!row
->enabled_p
)
1739 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1746 /* Give up if Y is not in the window. */
1747 if (i
== w
->current_matrix
->nrows
)
1750 /* Get the glyph area containing X. */
1751 if (w
->pseudo_window_p
)
1758 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1760 *area
= LEFT_MARGIN_AREA
;
1761 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1763 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1766 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1770 *area
= RIGHT_MARGIN_AREA
;
1771 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1775 /* Find glyph containing X. */
1776 glyph
= row
->glyphs
[*area
];
1777 end
= glyph
+ row
->used
[*area
];
1779 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1781 x
-= glyph
->pixel_width
;
1791 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1794 *hpos
= glyph
- row
->glyphs
[*area
];
1800 Convert frame-relative x/y to coordinates relative to window W.
1801 Takes pseudo-windows into account. */
1804 frame_to_window_pixel_xy (w
, x
, y
)
1808 if (w
->pseudo_window_p
)
1810 /* A pseudo-window is always full-width, and starts at the
1811 left edge of the frame, plus a frame border. */
1812 struct frame
*f
= XFRAME (w
->frame
);
1813 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1814 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1818 *x
-= WINDOW_LEFT_EDGE_X (w
);
1819 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1824 Return in RECTS[] at most N clipping rectangles for glyph string S.
1825 Return the number of stored rectangles. */
1828 get_glyph_string_clip_rects (s
, rects
, n
)
1829 struct glyph_string
*s
;
1830 NativeRectangle
*rects
;
1838 if (s
->row
->full_width_p
)
1840 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1841 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1842 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1844 /* Unless displaying a mode or menu bar line, which are always
1845 fully visible, clip to the visible part of the row. */
1846 if (s
->w
->pseudo_window_p
)
1847 r
.height
= s
->row
->visible_height
;
1849 r
.height
= s
->height
;
1853 /* This is a text line that may be partially visible. */
1854 r
.x
= window_box_left (s
->w
, s
->area
);
1855 r
.width
= window_box_width (s
->w
, s
->area
);
1856 r
.height
= s
->row
->visible_height
;
1860 if (r
.x
< s
->clip_head
->x
)
1862 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1863 r
.width
-= s
->clip_head
->x
- r
.x
;
1866 r
.x
= s
->clip_head
->x
;
1869 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1871 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1872 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1877 /* If S draws overlapping rows, it's sufficient to use the top and
1878 bottom of the window for clipping because this glyph string
1879 intentionally draws over other lines. */
1880 if (s
->for_overlaps
)
1882 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1883 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1885 /* Alas, the above simple strategy does not work for the
1886 environments with anti-aliased text: if the same text is
1887 drawn onto the same place multiple times, it gets thicker.
1888 If the overlap we are processing is for the erased cursor, we
1889 take the intersection with the rectagle of the cursor. */
1890 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1892 XRectangle rc
, r_save
= r
;
1894 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1895 rc
.y
= s
->w
->phys_cursor
.y
;
1896 rc
.width
= s
->w
->phys_cursor_width
;
1897 rc
.height
= s
->w
->phys_cursor_height
;
1899 x_intersect_rectangles (&r_save
, &rc
, &r
);
1904 /* Don't use S->y for clipping because it doesn't take partially
1905 visible lines into account. For example, it can be negative for
1906 partially visible lines at the top of a window. */
1907 if (!s
->row
->full_width_p
1908 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1909 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1911 r
.y
= max (0, s
->row
->y
);
1913 /* If drawing a tool-bar window, draw it over the internal border
1914 at the top of the window. */
1915 if (WINDOWP (s
->f
->tool_bar_window
)
1916 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1917 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1920 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1922 /* If drawing the cursor, don't let glyph draw outside its
1923 advertised boundaries. Cleartype does this under some circumstances. */
1924 if (s
->hl
== DRAW_CURSOR
)
1926 struct glyph
*glyph
= s
->first_glyph
;
1931 r
.width
-= s
->x
- r
.x
;
1934 r
.width
= min (r
.width
, glyph
->pixel_width
);
1936 /* If r.y is below window bottom, ensure that we still see a cursor. */
1937 height
= min (glyph
->ascent
+ glyph
->descent
,
1938 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1939 max_y
= window_text_bottom_y (s
->w
) - height
;
1940 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1941 if (s
->ybase
- glyph
->ascent
> max_y
)
1948 /* Don't draw cursor glyph taller than our actual glyph. */
1949 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1950 if (height
< r
.height
)
1952 max_y
= r
.y
+ r
.height
;
1953 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1954 r
.height
= min (max_y
- r
.y
, height
);
1961 XRectangle r_save
= r
;
1963 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1967 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1968 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1970 #ifdef CONVERT_FROM_XRECT
1971 CONVERT_FROM_XRECT (r
, *rects
);
1979 /* If we are processing overlapping and allowed to return
1980 multiple clipping rectangles, we exclude the row of the glyph
1981 string from the clipping rectangle. This is to avoid drawing
1982 the same text on the environment with anti-aliasing. */
1983 #ifdef CONVERT_FROM_XRECT
1986 XRectangle
*rs
= rects
;
1988 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1990 if (s
->for_overlaps
& OVERLAPS_PRED
)
1993 if (r
.y
+ r
.height
> row_y
)
1996 rs
[i
].height
= row_y
- r
.y
;
2002 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2005 if (r
.y
< row_y
+ s
->row
->visible_height
)
2007 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2009 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2010 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2019 #ifdef CONVERT_FROM_XRECT
2020 for (i
= 0; i
< n
; i
++)
2021 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2028 Return in *NR the clipping rectangle for glyph string S. */
2031 get_glyph_string_clip_rect (s
, nr
)
2032 struct glyph_string
*s
;
2033 NativeRectangle
*nr
;
2035 get_glyph_string_clip_rects (s
, nr
, 1);
2040 Return the position and height of the phys cursor in window W.
2041 Set w->phys_cursor_width to width of phys cursor.
2045 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2047 struct glyph_row
*row
;
2048 struct glyph
*glyph
;
2049 int *xp
, *yp
, *heightp
;
2051 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2052 int x
, y
, wd
, h
, h0
, y0
;
2054 /* Compute the width of the rectangle to draw. If on a stretch
2055 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2056 rectangle as wide as the glyph, but use a canonical character
2058 wd
= glyph
->pixel_width
- 1;
2063 x
= w
->phys_cursor
.x
;
2070 if (glyph
->type
== STRETCH_GLYPH
2071 && !x_stretch_cursor_p
)
2072 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2073 w
->phys_cursor_width
= wd
;
2075 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2077 /* If y is below window bottom, ensure that we still see a cursor. */
2078 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2080 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2081 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2083 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2086 h
= max (h
- (y0
- y
) + 1, h0
);
2091 y0
= window_text_bottom_y (w
) - h0
;
2099 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2100 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2105 * Remember which glyph the mouse is over.
2109 remember_mouse_glyph (f
, gx
, gy
, rect
)
2112 NativeRectangle
*rect
;
2116 struct glyph_row
*r
, *gr
, *end_row
;
2117 enum window_part part
;
2118 enum glyph_row_area area
;
2119 int x
, y
, width
, height
;
2121 /* Try to determine frame pixel position and size of the glyph under
2122 frame pixel coordinates X/Y on frame F. */
2124 if (!f
->glyphs_initialized_p
2125 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2128 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2129 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2133 w
= XWINDOW (window
);
2134 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2135 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2137 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2138 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2140 if (w
->pseudo_window_p
)
2143 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2149 case ON_LEFT_MARGIN
:
2150 area
= LEFT_MARGIN_AREA
;
2153 case ON_RIGHT_MARGIN
:
2154 area
= RIGHT_MARGIN_AREA
;
2157 case ON_HEADER_LINE
:
2159 gr
= (part
== ON_HEADER_LINE
2160 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2161 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2164 goto text_glyph_row_found
;
2171 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2172 if (r
->y
+ r
->height
> y
)
2178 text_glyph_row_found
:
2181 struct glyph
*g
= gr
->glyphs
[area
];
2182 struct glyph
*end
= g
+ gr
->used
[area
];
2184 height
= gr
->height
;
2185 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2186 if (gx
+ g
->pixel_width
> x
)
2191 if (g
->type
== IMAGE_GLYPH
)
2193 /* Don't remember when mouse is over image, as
2194 image may have hot-spots. */
2195 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2198 width
= g
->pixel_width
;
2202 /* Use nominal char spacing at end of line. */
2204 gx
+= (x
/ width
) * width
;
2207 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2208 gx
+= window_box_left_offset (w
, area
);
2212 /* Use nominal line height at end of window. */
2213 gx
= (x
/ width
) * width
;
2215 gy
+= (y
/ height
) * height
;
2219 case ON_LEFT_FRINGE
:
2220 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2221 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2222 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2223 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2226 case ON_RIGHT_FRINGE
:
2227 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2228 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2229 : window_box_right_offset (w
, TEXT_AREA
));
2230 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2234 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2236 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2237 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2238 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2240 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2244 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2245 if (r
->y
+ r
->height
> y
)
2252 height
= gr
->height
;
2255 /* Use nominal line height at end of window. */
2257 gy
+= (y
/ height
) * height
;
2264 /* If there is no glyph under the mouse, then we divide the screen
2265 into a grid of the smallest glyph in the frame, and use that
2268 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2269 round down even for negative values. */
2275 gx
= (gx
/ width
) * width
;
2276 gy
= (gy
/ height
) * height
;
2281 gx
+= WINDOW_LEFT_EDGE_X (w
);
2282 gy
+= WINDOW_TOP_EDGE_Y (w
);
2285 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2287 /* Visible feedback for debugging. */
2290 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2291 f
->output_data
.x
->normal_gc
,
2292 gx
, gy
, width
, height
);
2298 #endif /* HAVE_WINDOW_SYSTEM */
2301 /***********************************************************************
2302 Lisp form evaluation
2303 ***********************************************************************/
2305 /* Error handler for safe_eval and safe_call. */
2308 safe_eval_handler (arg
)
2311 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2316 /* Evaluate SEXPR and return the result, or nil if something went
2317 wrong. Prevent redisplay during the evaluation. */
2325 if (inhibit_eval_during_redisplay
)
2329 int count
= SPECPDL_INDEX ();
2330 struct gcpro gcpro1
;
2333 specbind (Qinhibit_redisplay
, Qt
);
2334 /* Use Qt to ensure debugger does not run,
2335 so there is no possibility of wanting to redisplay. */
2336 val
= internal_condition_case_1 (Feval
, sexpr
, Qt
,
2339 val
= unbind_to (count
, val
);
2346 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2347 Return the result, or nil if something went wrong. Prevent
2348 redisplay during the evaluation. */
2351 safe_call (nargs
, args
)
2357 if (inhibit_eval_during_redisplay
)
2361 int count
= SPECPDL_INDEX ();
2362 struct gcpro gcpro1
;
2365 gcpro1
.nvars
= nargs
;
2366 specbind (Qinhibit_redisplay
, Qt
);
2367 /* Use Qt to ensure debugger does not run,
2368 so there is no possibility of wanting to redisplay. */
2369 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2372 val
= unbind_to (count
, val
);
2379 /* Call function FN with one argument ARG.
2380 Return the result, or nil if something went wrong. */
2383 safe_call1 (fn
, arg
)
2384 Lisp_Object fn
, arg
;
2386 Lisp_Object args
[2];
2389 return safe_call (2, args
);
2394 /***********************************************************************
2396 ***********************************************************************/
2400 /* Define CHECK_IT to perform sanity checks on iterators.
2401 This is for debugging. It is too slow to do unconditionally. */
2407 if (it
->method
== GET_FROM_STRING
)
2409 xassert (STRINGP (it
->string
));
2410 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2414 xassert (IT_STRING_CHARPOS (*it
) < 0);
2415 if (it
->method
== GET_FROM_BUFFER
)
2417 /* Check that character and byte positions agree. */
2418 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2423 xassert (it
->current
.dpvec_index
>= 0);
2425 xassert (it
->current
.dpvec_index
< 0);
2428 #define CHECK_IT(IT) check_it ((IT))
2432 #define CHECK_IT(IT) (void) 0
2439 /* Check that the window end of window W is what we expect it
2440 to be---the last row in the current matrix displaying text. */
2443 check_window_end (w
)
2446 if (!MINI_WINDOW_P (w
)
2447 && !NILP (w
->window_end_valid
))
2449 struct glyph_row
*row
;
2450 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2451 XFASTINT (w
->window_end_vpos
)),
2453 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2454 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2458 #define CHECK_WINDOW_END(W) check_window_end ((W))
2460 #else /* not GLYPH_DEBUG */
2462 #define CHECK_WINDOW_END(W) (void) 0
2464 #endif /* not GLYPH_DEBUG */
2468 /***********************************************************************
2469 Iterator initialization
2470 ***********************************************************************/
2472 /* Initialize IT for displaying current_buffer in window W, starting
2473 at character position CHARPOS. CHARPOS < 0 means that no buffer
2474 position is specified which is useful when the iterator is assigned
2475 a position later. BYTEPOS is the byte position corresponding to
2476 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2478 If ROW is not null, calls to produce_glyphs with IT as parameter
2479 will produce glyphs in that row.
2481 BASE_FACE_ID is the id of a base face to use. It must be one of
2482 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2483 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2484 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2486 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2487 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2488 will be initialized to use the corresponding mode line glyph row of
2489 the desired matrix of W. */
2492 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2495 int charpos
, bytepos
;
2496 struct glyph_row
*row
;
2497 enum face_id base_face_id
;
2499 int highlight_region_p
;
2501 /* Some precondition checks. */
2502 xassert (w
!= NULL
&& it
!= NULL
);
2503 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2506 /* If face attributes have been changed since the last redisplay,
2507 free realized faces now because they depend on face definitions
2508 that might have changed. Don't free faces while there might be
2509 desired matrices pending which reference these faces. */
2510 if (face_change_count
&& !inhibit_free_realized_faces
)
2512 face_change_count
= 0;
2513 free_all_realized_faces (Qnil
);
2516 /* Use one of the mode line rows of W's desired matrix if
2520 if (base_face_id
== MODE_LINE_FACE_ID
2521 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2522 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2523 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2524 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2528 bzero (it
, sizeof *it
);
2529 it
->current
.overlay_string_index
= -1;
2530 it
->current
.dpvec_index
= -1;
2531 it
->base_face_id
= base_face_id
;
2533 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2535 /* The window in which we iterate over current_buffer: */
2536 XSETWINDOW (it
->window
, w
);
2538 it
->f
= XFRAME (w
->frame
);
2540 /* Extra space between lines (on window systems only). */
2541 if (base_face_id
== DEFAULT_FACE_ID
2542 && FRAME_WINDOW_P (it
->f
))
2544 if (NATNUMP (current_buffer
->extra_line_spacing
))
2545 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2546 else if (FLOATP (current_buffer
->extra_line_spacing
))
2547 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2548 * FRAME_LINE_HEIGHT (it
->f
));
2549 else if (it
->f
->extra_line_spacing
> 0)
2550 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2551 it
->max_extra_line_spacing
= 0;
2554 /* If realized faces have been removed, e.g. because of face
2555 attribute changes of named faces, recompute them. When running
2556 in batch mode, the face cache of the initial frame is null. If
2557 we happen to get called, make a dummy face cache. */
2558 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2559 init_frame_faces (it
->f
);
2560 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2561 recompute_basic_faces (it
->f
);
2563 /* Current value of the `slice', `space-width', and 'height' properties. */
2564 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2565 it
->space_width
= Qnil
;
2566 it
->font_height
= Qnil
;
2567 it
->override_ascent
= -1;
2569 /* Are control characters displayed as `^C'? */
2570 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2572 /* -1 means everything between a CR and the following line end
2573 is invisible. >0 means lines indented more than this value are
2575 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2576 ? XFASTINT (current_buffer
->selective_display
)
2577 : (!NILP (current_buffer
->selective_display
)
2579 it
->selective_display_ellipsis_p
2580 = !NILP (current_buffer
->selective_display_ellipses
);
2582 /* Display table to use. */
2583 it
->dp
= window_display_table (w
);
2585 /* Are multibyte characters enabled in current_buffer? */
2586 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2588 /* Non-zero if we should highlight the region. */
2590 = (!NILP (Vtransient_mark_mode
)
2591 && !NILP (current_buffer
->mark_active
)
2592 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2594 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2595 start and end of a visible region in window IT->w. Set both to
2596 -1 to indicate no region. */
2597 if (highlight_region_p
2598 /* Maybe highlight only in selected window. */
2599 && (/* Either show region everywhere. */
2600 highlight_nonselected_windows
2601 /* Or show region in the selected window. */
2602 || w
== XWINDOW (selected_window
)
2603 /* Or show the region if we are in the mini-buffer and W is
2604 the window the mini-buffer refers to. */
2605 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2606 && WINDOWP (minibuf_selected_window
)
2607 && w
== XWINDOW (minibuf_selected_window
))))
2609 int charpos
= marker_position (current_buffer
->mark
);
2610 it
->region_beg_charpos
= min (PT
, charpos
);
2611 it
->region_end_charpos
= max (PT
, charpos
);
2614 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2616 /* Get the position at which the redisplay_end_trigger hook should
2617 be run, if it is to be run at all. */
2618 if (MARKERP (w
->redisplay_end_trigger
)
2619 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2620 it
->redisplay_end_trigger_charpos
2621 = marker_position (w
->redisplay_end_trigger
);
2622 else if (INTEGERP (w
->redisplay_end_trigger
))
2623 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2625 /* Correct bogus values of tab_width. */
2626 it
->tab_width
= XINT (current_buffer
->tab_width
);
2627 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2630 /* Are lines in the display truncated? */
2631 it
->truncate_lines_p
2632 = (base_face_id
!= DEFAULT_FACE_ID
2633 || XINT (it
->w
->hscroll
)
2634 || (truncate_partial_width_windows
2635 && !WINDOW_FULL_WIDTH_P (it
->w
))
2636 || !NILP (current_buffer
->truncate_lines
));
2638 /* Get dimensions of truncation and continuation glyphs. These are
2639 displayed as fringe bitmaps under X, so we don't need them for such
2641 if (!FRAME_WINDOW_P (it
->f
))
2643 if (it
->truncate_lines_p
)
2645 /* We will need the truncation glyph. */
2646 xassert (it
->glyph_row
== NULL
);
2647 produce_special_glyphs (it
, IT_TRUNCATION
);
2648 it
->truncation_pixel_width
= it
->pixel_width
;
2652 /* We will need the continuation glyph. */
2653 xassert (it
->glyph_row
== NULL
);
2654 produce_special_glyphs (it
, IT_CONTINUATION
);
2655 it
->continuation_pixel_width
= it
->pixel_width
;
2658 /* Reset these values to zero because the produce_special_glyphs
2659 above has changed them. */
2660 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2661 it
->phys_ascent
= it
->phys_descent
= 0;
2664 /* Set this after getting the dimensions of truncation and
2665 continuation glyphs, so that we don't produce glyphs when calling
2666 produce_special_glyphs, above. */
2667 it
->glyph_row
= row
;
2668 it
->area
= TEXT_AREA
;
2670 /* Get the dimensions of the display area. The display area
2671 consists of the visible window area plus a horizontally scrolled
2672 part to the left of the window. All x-values are relative to the
2673 start of this total display area. */
2674 if (base_face_id
!= DEFAULT_FACE_ID
)
2676 /* Mode lines, menu bar in terminal frames. */
2677 it
->first_visible_x
= 0;
2678 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2683 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2684 it
->last_visible_x
= (it
->first_visible_x
2685 + window_box_width (w
, TEXT_AREA
));
2687 /* If we truncate lines, leave room for the truncator glyph(s) at
2688 the right margin. Otherwise, leave room for the continuation
2689 glyph(s). Truncation and continuation glyphs are not inserted
2690 for window-based redisplay. */
2691 if (!FRAME_WINDOW_P (it
->f
))
2693 if (it
->truncate_lines_p
)
2694 it
->last_visible_x
-= it
->truncation_pixel_width
;
2696 it
->last_visible_x
-= it
->continuation_pixel_width
;
2699 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2700 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2703 /* Leave room for a border glyph. */
2704 if (!FRAME_WINDOW_P (it
->f
)
2705 && !WINDOW_RIGHTMOST_P (it
->w
))
2706 it
->last_visible_x
-= 1;
2708 it
->last_visible_y
= window_text_bottom_y (w
);
2710 /* For mode lines and alike, arrange for the first glyph having a
2711 left box line if the face specifies a box. */
2712 if (base_face_id
!= DEFAULT_FACE_ID
)
2716 it
->face_id
= base_face_id
;
2718 /* If we have a boxed mode line, make the first character appear
2719 with a left box line. */
2720 face
= FACE_FROM_ID (it
->f
, base_face_id
);
2721 if (face
->box
!= FACE_NO_BOX
)
2722 it
->start_of_box_run_p
= 1;
2725 /* If a buffer position was specified, set the iterator there,
2726 getting overlays and face properties from that position. */
2727 if (charpos
>= BUF_BEG (current_buffer
))
2729 it
->end_charpos
= ZV
;
2731 IT_CHARPOS (*it
) = charpos
;
2733 /* Compute byte position if not specified. */
2734 if (bytepos
< charpos
)
2735 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2737 IT_BYTEPOS (*it
) = bytepos
;
2739 it
->start
= it
->current
;
2741 /* Compute faces etc. */
2742 reseat (it
, it
->current
.pos
, 1);
2749 /* Initialize IT for the display of window W with window start POS. */
2752 start_display (it
, w
, pos
)
2755 struct text_pos pos
;
2757 struct glyph_row
*row
;
2758 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2760 row
= w
->desired_matrix
->rows
+ first_vpos
;
2761 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2762 it
->first_vpos
= first_vpos
;
2764 /* Don't reseat to previous visible line start if current start
2765 position is in a string or image. */
2766 if (it
->method
== GET_FROM_BUFFER
&& !it
->truncate_lines_p
)
2768 int start_at_line_beg_p
;
2769 int first_y
= it
->current_y
;
2771 /* If window start is not at a line start, skip forward to POS to
2772 get the correct continuation lines width. */
2773 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2774 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2775 if (!start_at_line_beg_p
)
2779 reseat_at_previous_visible_line_start (it
);
2780 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2782 new_x
= it
->current_x
+ it
->pixel_width
;
2784 /* If lines are continued, this line may end in the middle
2785 of a multi-glyph character (e.g. a control character
2786 displayed as \003, or in the middle of an overlay
2787 string). In this case move_it_to above will not have
2788 taken us to the start of the continuation line but to the
2789 end of the continued line. */
2790 if (it
->current_x
> 0
2791 && !it
->truncate_lines_p
/* Lines are continued. */
2792 && (/* And glyph doesn't fit on the line. */
2793 new_x
> it
->last_visible_x
2794 /* Or it fits exactly and we're on a window
2796 || (new_x
== it
->last_visible_x
2797 && FRAME_WINDOW_P (it
->f
))))
2799 if (it
->current
.dpvec_index
>= 0
2800 || it
->current
.overlay_string_index
>= 0)
2802 set_iterator_to_next (it
, 1);
2803 move_it_in_display_line_to (it
, -1, -1, 0);
2806 it
->continuation_lines_width
+= it
->current_x
;
2809 /* We're starting a new display line, not affected by the
2810 height of the continued line, so clear the appropriate
2811 fields in the iterator structure. */
2812 it
->max_ascent
= it
->max_descent
= 0;
2813 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2815 it
->current_y
= first_y
;
2817 it
->current_x
= it
->hpos
= 0;
2821 #if 0 /* Don't assert the following because start_display is sometimes
2822 called intentionally with a window start that is not at a
2823 line start. Please leave this code in as a comment. */
2825 /* Window start should be on a line start, now. */
2826 xassert (it
->continuation_lines_width
2827 || IT_CHARPOS (it
) == BEGV
2828 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2833 /* Return 1 if POS is a position in ellipses displayed for invisible
2834 text. W is the window we display, for text property lookup. */
2837 in_ellipses_for_invisible_text_p (pos
, w
)
2838 struct display_pos
*pos
;
2841 Lisp_Object prop
, window
;
2843 int charpos
= CHARPOS (pos
->pos
);
2845 /* If POS specifies a position in a display vector, this might
2846 be for an ellipsis displayed for invisible text. We won't
2847 get the iterator set up for delivering that ellipsis unless
2848 we make sure that it gets aware of the invisible text. */
2849 if (pos
->dpvec_index
>= 0
2850 && pos
->overlay_string_index
< 0
2851 && CHARPOS (pos
->string_pos
) < 0
2853 && (XSETWINDOW (window
, w
),
2854 prop
= Fget_char_property (make_number (charpos
),
2855 Qinvisible
, window
),
2856 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2858 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2860 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2867 /* Initialize IT for stepping through current_buffer in window W,
2868 starting at position POS that includes overlay string and display
2869 vector/ control character translation position information. Value
2870 is zero if there are overlay strings with newlines at POS. */
2873 init_from_display_pos (it
, w
, pos
)
2876 struct display_pos
*pos
;
2878 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2879 int i
, overlay_strings_with_newlines
= 0;
2881 /* If POS specifies a position in a display vector, this might
2882 be for an ellipsis displayed for invisible text. We won't
2883 get the iterator set up for delivering that ellipsis unless
2884 we make sure that it gets aware of the invisible text. */
2885 if (in_ellipses_for_invisible_text_p (pos
, w
))
2891 /* Keep in mind: the call to reseat in init_iterator skips invisible
2892 text, so we might end up at a position different from POS. This
2893 is only a problem when POS is a row start after a newline and an
2894 overlay starts there with an after-string, and the overlay has an
2895 invisible property. Since we don't skip invisible text in
2896 display_line and elsewhere immediately after consuming the
2897 newline before the row start, such a POS will not be in a string,
2898 but the call to init_iterator below will move us to the
2900 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2902 /* This only scans the current chunk -- it should scan all chunks.
2903 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2904 to 16 in 22.1 to make this a lesser problem. */
2905 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2907 const char *s
= SDATA (it
->overlay_strings
[i
]);
2908 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2910 while (s
< e
&& *s
!= '\n')
2915 overlay_strings_with_newlines
= 1;
2920 /* If position is within an overlay string, set up IT to the right
2922 if (pos
->overlay_string_index
>= 0)
2926 /* If the first overlay string happens to have a `display'
2927 property for an image, the iterator will be set up for that
2928 image, and we have to undo that setup first before we can
2929 correct the overlay string index. */
2930 if (it
->method
== GET_FROM_IMAGE
)
2933 /* We already have the first chunk of overlay strings in
2934 IT->overlay_strings. Load more until the one for
2935 pos->overlay_string_index is in IT->overlay_strings. */
2936 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2938 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2939 it
->current
.overlay_string_index
= 0;
2942 load_overlay_strings (it
, 0);
2943 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2947 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2948 relative_index
= (it
->current
.overlay_string_index
2949 % OVERLAY_STRING_CHUNK_SIZE
);
2950 it
->string
= it
->overlay_strings
[relative_index
];
2951 xassert (STRINGP (it
->string
));
2952 it
->current
.string_pos
= pos
->string_pos
;
2953 it
->method
= GET_FROM_STRING
;
2956 #if 0 /* This is bogus because POS not having an overlay string
2957 position does not mean it's after the string. Example: A
2958 line starting with a before-string and initialization of IT
2959 to the previous row's end position. */
2960 else if (it
->current
.overlay_string_index
>= 0)
2962 /* If POS says we're already after an overlay string ending at
2963 POS, make sure to pop the iterator because it will be in
2964 front of that overlay string. When POS is ZV, we've thereby
2965 also ``processed'' overlay strings at ZV. */
2968 xassert (it
->current
.overlay_string_index
== -1);
2969 xassert (it
->method
== GET_FROM_BUFFER
);
2970 if (CHARPOS (pos
->pos
) == ZV
)
2971 it
->overlay_strings_at_end_processed_p
= 1;
2975 if (CHARPOS (pos
->string_pos
) >= 0)
2977 /* Recorded position is not in an overlay string, but in another
2978 string. This can only be a string from a `display' property.
2979 IT should already be filled with that string. */
2980 it
->current
.string_pos
= pos
->string_pos
;
2981 xassert (STRINGP (it
->string
));
2984 /* Restore position in display vector translations, control
2985 character translations or ellipses. */
2986 if (pos
->dpvec_index
>= 0)
2988 if (it
->dpvec
== NULL
)
2989 get_next_display_element (it
);
2990 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2991 it
->current
.dpvec_index
= pos
->dpvec_index
;
2995 return !overlay_strings_with_newlines
;
2999 /* Initialize IT for stepping through current_buffer in window W
3000 starting at ROW->start. */
3003 init_to_row_start (it
, w
, row
)
3006 struct glyph_row
*row
;
3008 init_from_display_pos (it
, w
, &row
->start
);
3009 it
->start
= row
->start
;
3010 it
->continuation_lines_width
= row
->continuation_lines_width
;
3015 /* Initialize IT for stepping through current_buffer in window W
3016 starting in the line following ROW, i.e. starting at ROW->end.
3017 Value is zero if there are overlay strings with newlines at ROW's
3021 init_to_row_end (it
, w
, row
)
3024 struct glyph_row
*row
;
3028 if (init_from_display_pos (it
, w
, &row
->end
))
3030 if (row
->continued_p
)
3031 it
->continuation_lines_width
3032 = row
->continuation_lines_width
+ row
->pixel_width
;
3043 /***********************************************************************
3045 ***********************************************************************/
3047 /* Called when IT reaches IT->stop_charpos. Handle text property and
3048 overlay changes. Set IT->stop_charpos to the next position where
3055 enum prop_handled handled
;
3056 int handle_overlay_change_p
;
3060 it
->current
.dpvec_index
= -1;
3061 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3062 it
->ignore_overlay_strings_at_pos_p
= 0;
3064 /* Use face of preceding text for ellipsis (if invisible) */
3065 if (it
->selective_display_ellipsis_p
)
3066 it
->saved_face_id
= it
->face_id
;
3070 handled
= HANDLED_NORMALLY
;
3072 /* Call text property handlers. */
3073 for (p
= it_props
; p
->handler
; ++p
)
3075 handled
= p
->handler (it
);
3077 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3079 else if (handled
== HANDLED_RETURN
)
3081 /* We still want to show before and after strings from
3082 overlays even if the actual buffer text is replaced. */
3083 if (!handle_overlay_change_p
|| it
->sp
> 1)
3085 if (!get_overlay_strings_1 (it
, 0, 0))
3087 it
->ignore_overlay_strings_at_pos_p
= 1;
3088 it
->string_from_display_prop_p
= 0;
3089 handle_overlay_change_p
= 0;
3090 handled
= HANDLED_RECOMPUTE_PROPS
;
3093 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3094 handle_overlay_change_p
= 0;
3097 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3099 /* Don't check for overlay strings below when set to deliver
3100 characters from a display vector. */
3101 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3102 handle_overlay_change_p
= 0;
3104 /* Handle overlay changes.
3105 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3106 if it finds overlays. */
3107 if (handle_overlay_change_p
)
3108 handled
= handle_overlay_change (it
);
3111 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3113 /* Determine where to stop next. */
3114 if (handled
== HANDLED_NORMALLY
)
3115 compute_stop_pos (it
);
3119 /* Compute IT->stop_charpos from text property and overlay change
3120 information for IT's current position. */
3123 compute_stop_pos (it
)
3126 register INTERVAL iv
, next_iv
;
3127 Lisp_Object object
, limit
, position
;
3129 /* If nowhere else, stop at the end. */
3130 it
->stop_charpos
= it
->end_charpos
;
3132 if (STRINGP (it
->string
))
3134 /* Strings are usually short, so don't limit the search for
3136 object
= it
->string
;
3138 position
= make_number (IT_STRING_CHARPOS (*it
));
3144 /* If next overlay change is in front of the current stop pos
3145 (which is IT->end_charpos), stop there. Note: value of
3146 next_overlay_change is point-max if no overlay change
3148 charpos
= next_overlay_change (IT_CHARPOS (*it
));
3149 if (charpos
< it
->stop_charpos
)
3150 it
->stop_charpos
= charpos
;
3152 /* If showing the region, we have to stop at the region
3153 start or end because the face might change there. */
3154 if (it
->region_beg_charpos
> 0)
3156 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3157 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3158 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3159 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3162 /* Set up variables for computing the stop position from text
3163 property changes. */
3164 XSETBUFFER (object
, current_buffer
);
3165 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3166 position
= make_number (IT_CHARPOS (*it
));
3170 /* Get the interval containing IT's position. Value is a null
3171 interval if there isn't such an interval. */
3172 iv
= validate_interval_range (object
, &position
, &position
, 0);
3173 if (!NULL_INTERVAL_P (iv
))
3175 Lisp_Object values_here
[LAST_PROP_IDX
];
3178 /* Get properties here. */
3179 for (p
= it_props
; p
->handler
; ++p
)
3180 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3182 /* Look for an interval following iv that has different
3184 for (next_iv
= next_interval (iv
);
3185 (!NULL_INTERVAL_P (next_iv
)
3187 || XFASTINT (limit
) > next_iv
->position
));
3188 next_iv
= next_interval (next_iv
))
3190 for (p
= it_props
; p
->handler
; ++p
)
3192 Lisp_Object new_value
;
3194 new_value
= textget (next_iv
->plist
, *p
->name
);
3195 if (!EQ (values_here
[p
->idx
], new_value
))
3203 if (!NULL_INTERVAL_P (next_iv
))
3205 if (INTEGERP (limit
)
3206 && next_iv
->position
>= XFASTINT (limit
))
3207 /* No text property change up to limit. */
3208 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3210 /* Text properties change in next_iv. */
3211 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3215 xassert (STRINGP (it
->string
)
3216 || (it
->stop_charpos
>= BEGV
3217 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3221 /* Return the position of the next overlay change after POS in
3222 current_buffer. Value is point-max if no overlay change
3223 follows. This is like `next-overlay-change' but doesn't use
3227 next_overlay_change (pos
)
3232 Lisp_Object
*overlays
;
3235 /* Get all overlays at the given position. */
3236 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3238 /* If any of these overlays ends before endpos,
3239 use its ending point instead. */
3240 for (i
= 0; i
< noverlays
; ++i
)
3245 oend
= OVERLAY_END (overlays
[i
]);
3246 oendpos
= OVERLAY_POSITION (oend
);
3247 endpos
= min (endpos
, oendpos
);
3255 /***********************************************************************
3257 ***********************************************************************/
3259 /* Handle changes in the `fontified' property of the current buffer by
3260 calling hook functions from Qfontification_functions to fontify
3263 static enum prop_handled
3264 handle_fontified_prop (it
)
3267 Lisp_Object prop
, pos
;
3268 enum prop_handled handled
= HANDLED_NORMALLY
;
3270 if (!NILP (Vmemory_full
))
3273 /* Get the value of the `fontified' property at IT's current buffer
3274 position. (The `fontified' property doesn't have a special
3275 meaning in strings.) If the value is nil, call functions from
3276 Qfontification_functions. */
3277 if (!STRINGP (it
->string
)
3279 && !NILP (Vfontification_functions
)
3280 && !NILP (Vrun_hooks
)
3281 && (pos
= make_number (IT_CHARPOS (*it
)),
3282 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3283 /* Ignore the special cased nil value always present at EOB since
3284 no amount of fontifying will be able to change it. */
3285 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3287 int count
= SPECPDL_INDEX ();
3290 val
= Vfontification_functions
;
3291 specbind (Qfontification_functions
, Qnil
);
3293 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3294 safe_call1 (val
, pos
);
3297 Lisp_Object globals
, fn
;
3298 struct gcpro gcpro1
, gcpro2
;
3301 GCPRO2 (val
, globals
);
3303 for (; CONSP (val
); val
= XCDR (val
))
3309 /* A value of t indicates this hook has a local
3310 binding; it means to run the global binding too.
3311 In a global value, t should not occur. If it
3312 does, we must ignore it to avoid an endless
3314 for (globals
= Fdefault_value (Qfontification_functions
);
3316 globals
= XCDR (globals
))
3318 fn
= XCAR (globals
);
3320 safe_call1 (fn
, pos
);
3324 safe_call1 (fn
, pos
);
3330 unbind_to (count
, Qnil
);
3332 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3333 something. This avoids an endless loop if they failed to
3334 fontify the text for which reason ever. */
3335 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3336 handled
= HANDLED_RECOMPUTE_PROPS
;
3344 /***********************************************************************
3346 ***********************************************************************/
3348 /* Set up iterator IT from face properties at its current position.
3349 Called from handle_stop. */
3351 static enum prop_handled
3352 handle_face_prop (it
)
3355 int new_face_id
, next_stop
;
3357 if (!STRINGP (it
->string
))
3360 = face_at_buffer_position (it
->w
,
3362 it
->region_beg_charpos
,
3363 it
->region_end_charpos
,
3366 + TEXT_PROP_DISTANCE_LIMIT
),
3369 /* Is this a start of a run of characters with box face?
3370 Caveat: this can be called for a freshly initialized
3371 iterator; face_id is -1 in this case. We know that the new
3372 face will not change until limit, i.e. if the new face has a
3373 box, all characters up to limit will have one. But, as
3374 usual, we don't know whether limit is really the end. */
3375 if (new_face_id
!= it
->face_id
)
3377 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3379 /* If new face has a box but old face has not, this is
3380 the start of a run of characters with box, i.e. it has
3381 a shadow on the left side. The value of face_id of the
3382 iterator will be -1 if this is the initial call that gets
3383 the face. In this case, we have to look in front of IT's
3384 position and see whether there is a face != new_face_id. */
3385 it
->start_of_box_run_p
3386 = (new_face
->box
!= FACE_NO_BOX
3387 && (it
->face_id
>= 0
3388 || IT_CHARPOS (*it
) == BEG
3389 || new_face_id
!= face_before_it_pos (it
)));
3390 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3395 int base_face_id
, bufpos
;
3397 Lisp_Object from_overlay
3398 = (it
->current
.overlay_string_index
>= 0
3399 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3402 /* See if we got to this string directly or indirectly from
3403 an overlay property. That includes the before-string or
3404 after-string of an overlay, strings in display properties
3405 provided by an overlay, their text properties, etc.
3407 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3408 if (! NILP (from_overlay
))
3409 for (i
= it
->sp
- 1; i
>= 0; i
--)
3411 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3413 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3414 else if (! NILP (it
->stack
[i
].from_overlay
))
3415 from_overlay
= it
->stack
[i
].from_overlay
;
3417 if (!NILP (from_overlay
))
3421 if (! NILP (from_overlay
))
3423 bufpos
= IT_CHARPOS (*it
);
3424 /* For a string from an overlay, the base face depends
3425 only on text properties and ignores overlays. */
3427 = face_for_overlay_string (it
->w
,
3429 it
->region_beg_charpos
,
3430 it
->region_end_charpos
,
3433 + TEXT_PROP_DISTANCE_LIMIT
),
3441 /* For strings from a `display' property, use the face at
3442 IT's current buffer position as the base face to merge
3443 with, so that overlay strings appear in the same face as
3444 surrounding text, unless they specify their own
3446 base_face_id
= underlying_face_id (it
);
3449 new_face_id
= face_at_string_position (it
->w
,
3451 IT_STRING_CHARPOS (*it
),
3453 it
->region_beg_charpos
,
3454 it
->region_end_charpos
,
3458 #if 0 /* This shouldn't be neccessary. Let's check it. */
3459 /* If IT is used to display a mode line we would really like to
3460 use the mode line face instead of the frame's default face. */
3461 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3462 && new_face_id
== DEFAULT_FACE_ID
)
3463 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3466 /* Is this a start of a run of characters with box? Caveat:
3467 this can be called for a freshly allocated iterator; face_id
3468 is -1 is this case. We know that the new face will not
3469 change until the next check pos, i.e. if the new face has a
3470 box, all characters up to that position will have a
3471 box. But, as usual, we don't know whether that position
3472 is really the end. */
3473 if (new_face_id
!= it
->face_id
)
3475 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3476 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3478 /* If new face has a box but old face hasn't, this is the
3479 start of a run of characters with box, i.e. it has a
3480 shadow on the left side. */
3481 it
->start_of_box_run_p
3482 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3483 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3487 it
->face_id
= new_face_id
;
3488 return HANDLED_NORMALLY
;
3492 /* Return the ID of the face ``underlying'' IT's current position,
3493 which is in a string. If the iterator is associated with a
3494 buffer, return the face at IT's current buffer position.
3495 Otherwise, use the iterator's base_face_id. */
3498 underlying_face_id (it
)
3501 int face_id
= it
->base_face_id
, i
;
3503 xassert (STRINGP (it
->string
));
3505 for (i
= it
->sp
- 1; i
>= 0; --i
)
3506 if (NILP (it
->stack
[i
].string
))
3507 face_id
= it
->stack
[i
].face_id
;
3513 /* Compute the face one character before or after the current position
3514 of IT. BEFORE_P non-zero means get the face in front of IT's
3515 position. Value is the id of the face. */
3518 face_before_or_after_it_pos (it
, before_p
)
3523 int next_check_charpos
;
3524 struct text_pos pos
;
3526 xassert (it
->s
== NULL
);
3528 if (STRINGP (it
->string
))
3530 int bufpos
, base_face_id
;
3532 /* No face change past the end of the string (for the case
3533 we are padding with spaces). No face change before the
3535 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3536 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3539 /* Set pos to the position before or after IT's current position. */
3541 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3543 /* For composition, we must check the character after the
3545 pos
= (it
->what
== IT_COMPOSITION
3546 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
3547 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3549 if (it
->current
.overlay_string_index
>= 0)
3550 bufpos
= IT_CHARPOS (*it
);
3554 base_face_id
= underlying_face_id (it
);
3556 /* Get the face for ASCII, or unibyte. */
3557 face_id
= face_at_string_position (it
->w
,
3561 it
->region_beg_charpos
,
3562 it
->region_end_charpos
,
3563 &next_check_charpos
,
3566 /* Correct the face for charsets different from ASCII. Do it
3567 for the multibyte case only. The face returned above is
3568 suitable for unibyte text if IT->string is unibyte. */
3569 if (STRING_MULTIBYTE (it
->string
))
3571 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3572 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3574 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3576 c
= string_char_and_length (p
, rest
, &len
);
3577 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3582 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3583 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3586 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3587 pos
= it
->current
.pos
;
3590 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3593 if (it
->what
== IT_COMPOSITION
)
3594 /* For composition, we must check the position after the
3596 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
3598 INC_TEXT_POS (pos
, it
->multibyte_p
);
3601 /* Determine face for CHARSET_ASCII, or unibyte. */
3602 face_id
= face_at_buffer_position (it
->w
,
3604 it
->region_beg_charpos
,
3605 it
->region_end_charpos
,
3606 &next_check_charpos
,
3609 /* Correct the face for charsets different from ASCII. Do it
3610 for the multibyte case only. The face returned above is
3611 suitable for unibyte text if current_buffer is unibyte. */
3612 if (it
->multibyte_p
)
3614 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3615 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3616 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3625 /***********************************************************************
3627 ***********************************************************************/
3629 /* Set up iterator IT from invisible properties at its current
3630 position. Called from handle_stop. */
3632 static enum prop_handled
3633 handle_invisible_prop (it
)
3636 enum prop_handled handled
= HANDLED_NORMALLY
;
3638 if (STRINGP (it
->string
))
3640 extern Lisp_Object Qinvisible
;
3641 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3643 /* Get the value of the invisible text property at the
3644 current position. Value will be nil if there is no such
3646 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3647 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3650 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3652 handled
= HANDLED_RECOMPUTE_PROPS
;
3654 /* Get the position at which the next change of the
3655 invisible text property can be found in IT->string.
3656 Value will be nil if the property value is the same for
3657 all the rest of IT->string. */
3658 XSETINT (limit
, SCHARS (it
->string
));
3659 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3662 /* Text at current position is invisible. The next
3663 change in the property is at position end_charpos.
3664 Move IT's current position to that position. */
3665 if (INTEGERP (end_charpos
)
3666 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3668 struct text_pos old
;
3669 old
= it
->current
.string_pos
;
3670 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3671 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3675 /* The rest of the string is invisible. If this is an
3676 overlay string, proceed with the next overlay string
3677 or whatever comes and return a character from there. */
3678 if (it
->current
.overlay_string_index
>= 0)
3680 next_overlay_string (it
);
3681 /* Don't check for overlay strings when we just
3682 finished processing them. */
3683 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3687 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3688 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3696 EMACS_INT newpos
, next_stop
, start_charpos
;
3697 Lisp_Object pos
, prop
, overlay
;
3699 /* First of all, is there invisible text at this position? */
3700 start_charpos
= IT_CHARPOS (*it
);
3701 pos
= make_number (IT_CHARPOS (*it
));
3702 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3704 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3706 /* If we are on invisible text, skip over it. */
3707 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3709 /* Record whether we have to display an ellipsis for the
3711 int display_ellipsis_p
= invis_p
== 2;
3713 handled
= HANDLED_RECOMPUTE_PROPS
;
3715 /* Loop skipping over invisible text. The loop is left at
3716 ZV or with IT on the first char being visible again. */
3719 /* Try to skip some invisible text. Return value is the
3720 position reached which can be equal to IT's position
3721 if there is nothing invisible here. This skips both
3722 over invisible text properties and overlays with
3723 invisible property. */
3724 newpos
= skip_invisible (IT_CHARPOS (*it
),
3725 &next_stop
, ZV
, it
->window
);
3727 /* If we skipped nothing at all we weren't at invisible
3728 text in the first place. If everything to the end of
3729 the buffer was skipped, end the loop. */
3730 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3734 /* We skipped some characters but not necessarily
3735 all there are. Check if we ended up on visible
3736 text. Fget_char_property returns the property of
3737 the char before the given position, i.e. if we
3738 get invis_p = 0, this means that the char at
3739 newpos is visible. */
3740 pos
= make_number (newpos
);
3741 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3742 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3745 /* If we ended up on invisible text, proceed to
3746 skip starting with next_stop. */
3748 IT_CHARPOS (*it
) = next_stop
;
3750 /* If there are adjacent invisible texts, don't lose the
3751 second one's ellipsis. */
3753 display_ellipsis_p
= 1;
3757 /* The position newpos is now either ZV or on visible text. */
3758 IT_CHARPOS (*it
) = newpos
;
3759 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3761 /* If there are before-strings at the start of invisible
3762 text, and the text is invisible because of a text
3763 property, arrange to show before-strings because 20.x did
3764 it that way. (If the text is invisible because of an
3765 overlay property instead of a text property, this is
3766 already handled in the overlay code.) */
3768 && get_overlay_strings (it
, start_charpos
))
3770 handled
= HANDLED_RECOMPUTE_PROPS
;
3771 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3773 else if (display_ellipsis_p
)
3775 /* Make sure that the glyphs of the ellipsis will get
3776 correct `charpos' values. If we would not update
3777 it->position here, the glyphs would belong to the
3778 last visible character _before_ the invisible
3779 text, which confuses `set_cursor_from_row'.
3781 We use the last invisible position instead of the
3782 first because this way the cursor is always drawn on
3783 the first "." of the ellipsis, whenever PT is inside
3784 the invisible text. Otherwise the cursor would be
3785 placed _after_ the ellipsis when the point is after the
3786 first invisible character. */
3787 if (!STRINGP (it
->object
))
3789 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3790 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3792 setup_for_ellipsis (it
, 0);
3793 /* Let the ellipsis display before
3794 considering any properties of the following char.
3795 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3796 handled
= HANDLED_RETURN
;
3805 /* Make iterator IT return `...' next.
3806 Replaces LEN characters from buffer. */
3809 setup_for_ellipsis (it
, len
)
3813 /* Use the display table definition for `...'. Invalid glyphs
3814 will be handled by the method returning elements from dpvec. */
3815 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3817 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3818 it
->dpvec
= v
->contents
;
3819 it
->dpend
= v
->contents
+ v
->size
;
3823 /* Default `...'. */
3824 it
->dpvec
= default_invis_vector
;
3825 it
->dpend
= default_invis_vector
+ 3;
3828 it
->dpvec_char_len
= len
;
3829 it
->current
.dpvec_index
= 0;
3830 it
->dpvec_face_id
= -1;
3832 /* Remember the current face id in case glyphs specify faces.
3833 IT's face is restored in set_iterator_to_next.
3834 saved_face_id was set to preceding char's face in handle_stop. */
3835 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3836 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3838 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3844 /***********************************************************************
3846 ***********************************************************************/
3848 /* Set up iterator IT from `display' property at its current position.
3849 Called from handle_stop.
3850 We return HANDLED_RETURN if some part of the display property
3851 overrides the display of the buffer text itself.
3852 Otherwise we return HANDLED_NORMALLY. */
3854 static enum prop_handled
3855 handle_display_prop (it
)
3858 Lisp_Object prop
, object
, overlay
;
3859 struct text_pos
*position
;
3860 /* Nonzero if some property replaces the display of the text itself. */
3861 int display_replaced_p
= 0;
3863 if (STRINGP (it
->string
))
3865 object
= it
->string
;
3866 position
= &it
->current
.string_pos
;
3870 XSETWINDOW (object
, it
->w
);
3871 position
= &it
->current
.pos
;
3874 /* Reset those iterator values set from display property values. */
3875 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3876 it
->space_width
= Qnil
;
3877 it
->font_height
= Qnil
;
3880 /* We don't support recursive `display' properties, i.e. string
3881 values that have a string `display' property, that have a string
3882 `display' property etc. */
3883 if (!it
->string_from_display_prop_p
)
3884 it
->area
= TEXT_AREA
;
3886 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3887 Qdisplay
, object
, &overlay
);
3889 return HANDLED_NORMALLY
;
3890 /* Now OVERLAY is the overlay that gave us this property, or nil
3891 if it was a text property. */
3893 if (!STRINGP (it
->string
))
3894 object
= it
->w
->buffer
;
3897 /* Simple properties. */
3898 && !EQ (XCAR (prop
), Qimage
)
3899 && !EQ (XCAR (prop
), Qspace
)
3900 && !EQ (XCAR (prop
), Qwhen
)
3901 && !EQ (XCAR (prop
), Qslice
)
3902 && !EQ (XCAR (prop
), Qspace_width
)
3903 && !EQ (XCAR (prop
), Qheight
)
3904 && !EQ (XCAR (prop
), Qraise
)
3905 /* Marginal area specifications. */
3906 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3907 && !EQ (XCAR (prop
), Qleft_fringe
)
3908 && !EQ (XCAR (prop
), Qright_fringe
)
3909 && !NILP (XCAR (prop
)))
3911 for (; CONSP (prop
); prop
= XCDR (prop
))
3913 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3914 position
, display_replaced_p
))
3916 display_replaced_p
= 1;
3917 /* If some text in a string is replaced, `position' no
3918 longer points to the position of `object'. */
3919 if (STRINGP (object
))
3924 else if (VECTORP (prop
))
3927 for (i
= 0; i
< ASIZE (prop
); ++i
)
3928 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3929 position
, display_replaced_p
))
3931 display_replaced_p
= 1;
3932 /* If some text in a string is replaced, `position' no
3933 longer points to the position of `object'. */
3934 if (STRINGP (object
))
3940 int ret
= handle_single_display_spec (it
, prop
, object
, overlay
,
3942 if (ret
< 0) /* Replaced by "", i.e. nothing. */
3943 return HANDLED_RECOMPUTE_PROPS
;
3945 display_replaced_p
= 1;
3948 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3952 /* Value is the position of the end of the `display' property starting
3953 at START_POS in OBJECT. */
3955 static struct text_pos
3956 display_prop_end (it
, object
, start_pos
)
3959 struct text_pos start_pos
;
3962 struct text_pos end_pos
;
3964 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3965 Qdisplay
, object
, Qnil
);
3966 CHARPOS (end_pos
) = XFASTINT (end
);
3967 if (STRINGP (object
))
3968 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3970 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3976 /* Set up IT from a single `display' specification PROP. OBJECT
3977 is the object in which the `display' property was found. *POSITION
3978 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3979 means that we previously saw a display specification which already
3980 replaced text display with something else, for example an image;
3981 we ignore such properties after the first one has been processed.
3983 OVERLAY is the overlay this `display' property came from,
3984 or nil if it was a text property.
3986 If PROP is a `space' or `image' specification, and in some other
3987 cases too, set *POSITION to the position where the `display'
3990 Value is non-zero if something was found which replaces the display
3991 of buffer or string text. Specifically, the value is -1 if that
3992 "something" is "nothing". */
3995 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
3996 display_replaced_before_p
)
4000 Lisp_Object overlay
;
4001 struct text_pos
*position
;
4002 int display_replaced_before_p
;
4005 Lisp_Object location
, value
;
4006 struct text_pos start_pos
, save_pos
;
4009 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4010 If the result is non-nil, use VALUE instead of SPEC. */
4012 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4021 if (!NILP (form
) && !EQ (form
, Qt
))
4023 int count
= SPECPDL_INDEX ();
4024 struct gcpro gcpro1
;
4026 /* Bind `object' to the object having the `display' property, a
4027 buffer or string. Bind `position' to the position in the
4028 object where the property was found, and `buffer-position'
4029 to the current position in the buffer. */
4030 specbind (Qobject
, object
);
4031 specbind (Qposition
, make_number (CHARPOS (*position
)));
4032 specbind (Qbuffer_position
,
4033 make_number (STRINGP (object
)
4034 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4036 form
= safe_eval (form
);
4038 unbind_to (count
, Qnil
);
4044 /* Handle `(height HEIGHT)' specifications. */
4046 && EQ (XCAR (spec
), Qheight
)
4047 && CONSP (XCDR (spec
)))
4049 if (!FRAME_WINDOW_P (it
->f
))
4052 it
->font_height
= XCAR (XCDR (spec
));
4053 if (!NILP (it
->font_height
))
4055 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4056 int new_height
= -1;
4058 if (CONSP (it
->font_height
)
4059 && (EQ (XCAR (it
->font_height
), Qplus
)
4060 || EQ (XCAR (it
->font_height
), Qminus
))
4061 && CONSP (XCDR (it
->font_height
))
4062 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4064 /* `(+ N)' or `(- N)' where N is an integer. */
4065 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4066 if (EQ (XCAR (it
->font_height
), Qplus
))
4068 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4070 else if (FUNCTIONP (it
->font_height
))
4072 /* Call function with current height as argument.
4073 Value is the new height. */
4075 height
= safe_call1 (it
->font_height
,
4076 face
->lface
[LFACE_HEIGHT_INDEX
]);
4077 if (NUMBERP (height
))
4078 new_height
= XFLOATINT (height
);
4080 else if (NUMBERP (it
->font_height
))
4082 /* Value is a multiple of the canonical char height. */
4085 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
4086 new_height
= (XFLOATINT (it
->font_height
)
4087 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4091 /* Evaluate IT->font_height with `height' bound to the
4092 current specified height to get the new height. */
4093 int count
= SPECPDL_INDEX ();
4095 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4096 value
= safe_eval (it
->font_height
);
4097 unbind_to (count
, Qnil
);
4099 if (NUMBERP (value
))
4100 new_height
= XFLOATINT (value
);
4104 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4110 /* Handle `(space-width WIDTH)'. */
4112 && EQ (XCAR (spec
), Qspace_width
)
4113 && CONSP (XCDR (spec
)))
4115 if (!FRAME_WINDOW_P (it
->f
))
4118 value
= XCAR (XCDR (spec
));
4119 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4120 it
->space_width
= value
;
4125 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4127 && EQ (XCAR (spec
), Qslice
))
4131 if (!FRAME_WINDOW_P (it
->f
))
4134 if (tem
= XCDR (spec
), CONSP (tem
))
4136 it
->slice
.x
= XCAR (tem
);
4137 if (tem
= XCDR (tem
), CONSP (tem
))
4139 it
->slice
.y
= XCAR (tem
);
4140 if (tem
= XCDR (tem
), CONSP (tem
))
4142 it
->slice
.width
= XCAR (tem
);
4143 if (tem
= XCDR (tem
), CONSP (tem
))
4144 it
->slice
.height
= XCAR (tem
);
4152 /* Handle `(raise FACTOR)'. */
4154 && EQ (XCAR (spec
), Qraise
)
4155 && CONSP (XCDR (spec
)))
4157 if (!FRAME_WINDOW_P (it
->f
))
4160 #ifdef HAVE_WINDOW_SYSTEM
4161 value
= XCAR (XCDR (spec
));
4162 if (NUMBERP (value
))
4164 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4165 it
->voffset
= - (XFLOATINT (value
)
4166 * (FONT_HEIGHT (face
->font
)));
4168 #endif /* HAVE_WINDOW_SYSTEM */
4173 /* Don't handle the other kinds of display specifications
4174 inside a string that we got from a `display' property. */
4175 if (it
->string_from_display_prop_p
)
4178 /* Characters having this form of property are not displayed, so
4179 we have to find the end of the property. */
4180 start_pos
= *position
;
4181 *position
= display_prop_end (it
, object
, start_pos
);
4184 /* Stop the scan at that end position--we assume that all
4185 text properties change there. */
4186 it
->stop_charpos
= position
->charpos
;
4188 /* Handle `(left-fringe BITMAP [FACE])'
4189 and `(right-fringe BITMAP [FACE])'. */
4191 && (EQ (XCAR (spec
), Qleft_fringe
)
4192 || EQ (XCAR (spec
), Qright_fringe
))
4193 && CONSP (XCDR (spec
)))
4195 int face_id
= DEFAULT_FACE_ID
;
4198 if (!FRAME_WINDOW_P (it
->f
))
4199 /* If we return here, POSITION has been advanced
4200 across the text with this property. */
4203 #ifdef HAVE_WINDOW_SYSTEM
4204 value
= XCAR (XCDR (spec
));
4205 if (!SYMBOLP (value
)
4206 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4207 /* If we return here, POSITION has been advanced
4208 across the text with this property. */
4211 if (CONSP (XCDR (XCDR (spec
))))
4213 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4214 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4220 /* Save current settings of IT so that we can restore them
4221 when we are finished with the glyph property value. */
4223 save_pos
= it
->position
;
4224 it
->position
= *position
;
4226 it
->position
= save_pos
;
4228 it
->area
= TEXT_AREA
;
4229 it
->what
= IT_IMAGE
;
4230 it
->image_id
= -1; /* no image */
4231 it
->position
= start_pos
;
4232 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4233 it
->method
= GET_FROM_IMAGE
;
4234 it
->from_overlay
= Qnil
;
4235 it
->face_id
= face_id
;
4237 /* Say that we haven't consumed the characters with
4238 `display' property yet. The call to pop_it in
4239 set_iterator_to_next will clean this up. */
4240 *position
= start_pos
;
4242 if (EQ (XCAR (spec
), Qleft_fringe
))
4244 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4245 it
->left_user_fringe_face_id
= face_id
;
4249 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4250 it
->right_user_fringe_face_id
= face_id
;
4252 #endif /* HAVE_WINDOW_SYSTEM */
4256 /* Prepare to handle `((margin left-margin) ...)',
4257 `((margin right-margin) ...)' and `((margin nil) ...)'
4258 prefixes for display specifications. */
4259 location
= Qunbound
;
4260 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4264 value
= XCDR (spec
);
4266 value
= XCAR (value
);
4269 if (EQ (XCAR (tem
), Qmargin
)
4270 && (tem
= XCDR (tem
),
4271 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4273 || EQ (tem
, Qleft_margin
)
4274 || EQ (tem
, Qright_margin
))))
4278 if (EQ (location
, Qunbound
))
4284 /* After this point, VALUE is the property after any
4285 margin prefix has been stripped. It must be a string,
4286 an image specification, or `(space ...)'.
4288 LOCATION specifies where to display: `left-margin',
4289 `right-margin' or nil. */
4291 valid_p
= (STRINGP (value
)
4292 #ifdef HAVE_WINDOW_SYSTEM
4293 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4294 #endif /* not HAVE_WINDOW_SYSTEM */
4295 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4297 if (valid_p
&& !display_replaced_before_p
)
4299 /* Save current settings of IT so that we can restore them
4300 when we are finished with the glyph property value. */
4301 save_pos
= it
->position
;
4302 it
->position
= *position
;
4304 it
->position
= save_pos
;
4305 it
->from_overlay
= overlay
;
4307 if (NILP (location
))
4308 it
->area
= TEXT_AREA
;
4309 else if (EQ (location
, Qleft_margin
))
4310 it
->area
= LEFT_MARGIN_AREA
;
4312 it
->area
= RIGHT_MARGIN_AREA
;
4314 if (STRINGP (value
))
4316 if (SCHARS (value
) == 0)
4319 return -1; /* Replaced by "", i.e. nothing. */
4322 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4323 it
->current
.overlay_string_index
= -1;
4324 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4325 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4326 it
->method
= GET_FROM_STRING
;
4327 it
->stop_charpos
= 0;
4328 it
->string_from_display_prop_p
= 1;
4329 /* Say that we haven't consumed the characters with
4330 `display' property yet. The call to pop_it in
4331 set_iterator_to_next will clean this up. */
4332 if (BUFFERP (object
))
4333 it
->current
.pos
= start_pos
;
4335 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4337 it
->method
= GET_FROM_STRETCH
;
4339 it
->position
= start_pos
;
4340 if (BUFFERP (object
))
4341 it
->current
.pos
= start_pos
;
4343 #ifdef HAVE_WINDOW_SYSTEM
4346 it
->what
= IT_IMAGE
;
4347 it
->image_id
= lookup_image (it
->f
, value
);
4348 it
->position
= start_pos
;
4349 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4350 it
->method
= GET_FROM_IMAGE
;
4352 /* Say that we haven't consumed the characters with
4353 `display' property yet. The call to pop_it in
4354 set_iterator_to_next will clean this up. */
4355 if (BUFFERP (object
))
4356 it
->current
.pos
= start_pos
;
4358 #endif /* HAVE_WINDOW_SYSTEM */
4363 /* Invalid property or property not supported. Restore
4364 POSITION to what it was before. */
4365 *position
= start_pos
;
4370 /* Check if SPEC is a display sub-property value whose text should be
4371 treated as intangible. */
4374 single_display_spec_intangible_p (prop
)
4377 /* Skip over `when FORM'. */
4378 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4392 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4393 we don't need to treat text as intangible. */
4394 if (EQ (XCAR (prop
), Qmargin
))
4402 || EQ (XCAR (prop
), Qleft_margin
)
4403 || EQ (XCAR (prop
), Qright_margin
))
4407 return (CONSP (prop
)
4408 && (EQ (XCAR (prop
), Qimage
)
4409 || EQ (XCAR (prop
), Qspace
)));
4413 /* Check if PROP is a display property value whose text should be
4414 treated as intangible. */
4417 display_prop_intangible_p (prop
)
4421 && CONSP (XCAR (prop
))
4422 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4424 /* A list of sub-properties. */
4425 while (CONSP (prop
))
4427 if (single_display_spec_intangible_p (XCAR (prop
)))
4432 else if (VECTORP (prop
))
4434 /* A vector of sub-properties. */
4436 for (i
= 0; i
< ASIZE (prop
); ++i
)
4437 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4441 return single_display_spec_intangible_p (prop
);
4447 /* Return 1 if PROP is a display sub-property value containing STRING. */
4450 single_display_spec_string_p (prop
, string
)
4451 Lisp_Object prop
, string
;
4453 if (EQ (string
, prop
))
4456 /* Skip over `when FORM'. */
4457 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4466 /* Skip over `margin LOCATION'. */
4467 if (EQ (XCAR (prop
), Qmargin
))
4478 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4482 /* Return 1 if STRING appears in the `display' property PROP. */
4485 display_prop_string_p (prop
, string
)
4486 Lisp_Object prop
, string
;
4489 && CONSP (XCAR (prop
))
4490 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4492 /* A list of sub-properties. */
4493 while (CONSP (prop
))
4495 if (single_display_spec_string_p (XCAR (prop
), string
))
4500 else if (VECTORP (prop
))
4502 /* A vector of sub-properties. */
4504 for (i
= 0; i
< ASIZE (prop
); ++i
)
4505 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4509 return single_display_spec_string_p (prop
, string
);
4515 /* Determine from which buffer position in W's buffer STRING comes
4516 from. AROUND_CHARPOS is an approximate position where it could
4517 be from. Value is the buffer position or 0 if it couldn't be
4520 W's buffer must be current.
4522 This function is necessary because we don't record buffer positions
4523 in glyphs generated from strings (to keep struct glyph small).
4524 This function may only use code that doesn't eval because it is
4525 called asynchronously from note_mouse_highlight. */
4528 string_buffer_position (w
, string
, around_charpos
)
4533 Lisp_Object limit
, prop
, pos
;
4534 const int MAX_DISTANCE
= 1000;
4537 pos
= make_number (around_charpos
);
4538 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4539 while (!found
&& !EQ (pos
, limit
))
4541 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4542 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4545 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4550 pos
= make_number (around_charpos
);
4551 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4552 while (!found
&& !EQ (pos
, limit
))
4554 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4555 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4558 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4563 return found
? XINT (pos
) : 0;
4568 /***********************************************************************
4569 `composition' property
4570 ***********************************************************************/
4572 static enum prop_handled
4573 handle_auto_composed_prop (it
)
4576 enum prop_handled handled
= HANDLED_NORMALLY
;
4578 if (FUNCTIONP (Vauto_composition_function
))
4580 Lisp_Object val
= Qnil
;
4581 EMACS_INT pos
, limit
= -1;
4583 if (STRINGP (it
->string
))
4584 pos
= IT_STRING_CHARPOS (*it
);
4586 pos
= IT_CHARPOS (*it
);
4588 val
= Fget_text_property (make_number (pos
), Qauto_composed
, it
->string
);
4591 Lisp_Object cmp_prop
;
4592 EMACS_INT cmp_start
, cmp_end
;
4594 #ifdef USE_FONT_BACKEND
4595 if (enable_font_backend
4596 && get_property_and_range (pos
, Qcomposition
, &cmp_prop
,
4597 &cmp_start
, &cmp_end
, it
->string
)
4599 && COMPOSITION_METHOD (cmp_prop
) == COMPOSITION_WITH_GLYPH_STRING
)
4601 Lisp_Object gstring
= COMPOSITION_COMPONENTS (cmp_prop
);
4602 Lisp_Object font_object
= LGSTRING_FONT (gstring
);
4604 if (! EQ (font_object
,
4605 font_at (-1, pos
, FACE_FROM_ID (it
->f
, it
->face_id
),
4606 it
->w
, it
->string
)))
4607 /* We must re-compute the composition for the
4616 /* As Fnext_single_char_property_change is very slow, we
4617 limit the search to the current line. */
4618 if (STRINGP (it
->string
))
4619 limit
= SCHARS (it
->string
);
4621 limit
= find_next_newline_no_quit (pos
, 1);
4622 end
= Fnext_single_char_property_change (make_number (pos
),
4625 make_number (limit
));
4627 if (XINT (end
) < limit
)
4628 /* The current point is auto-composed, but there exist
4629 characters not yet composed beyond the
4630 auto-composed region. There's a possiblity that
4631 the last characters in the region may be newly
4639 limit
= (STRINGP (it
->string
) ? SCHARS (it
->string
)
4640 : find_next_newline_no_quit (pos
, 1));
4643 int count
= SPECPDL_INDEX ();
4644 Lisp_Object args
[5];
4646 args
[0] = Vauto_composition_function
;
4647 specbind (Qauto_composition_function
, Qnil
);
4648 args
[1] = make_number (pos
);
4649 args
[2] = make_number (limit
);
4650 #ifdef USE_FONT_BACKEND
4651 if (enable_font_backend
)
4652 args
[3] = it
->window
;
4654 #endif /* USE_FONT_BACKEND */
4656 args
[4] = it
->string
;
4657 safe_call (5, args
);
4658 unbind_to (count
, Qnil
);
4666 /* Set up iterator IT from `composition' property at its current
4667 position. Called from handle_stop. */
4669 static enum prop_handled
4670 handle_composition_prop (it
)
4673 Lisp_Object prop
, string
;
4674 EMACS_INT pos
, pos_byte
, start
, end
;
4675 enum prop_handled handled
= HANDLED_NORMALLY
;
4677 if (STRINGP (it
->string
))
4679 pos
= IT_STRING_CHARPOS (*it
);
4680 pos_byte
= IT_STRING_BYTEPOS (*it
);
4681 string
= it
->string
;
4685 pos
= IT_CHARPOS (*it
);
4686 pos_byte
= IT_BYTEPOS (*it
);
4690 /* If there's a valid composition and point is not inside of the
4691 composition (in the case that the composition is from the current
4692 buffer), draw a glyph composed from the composition components. */
4693 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4694 && COMPOSITION_VALID_P (start
, end
, prop
)
4695 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4701 if (STRINGP (it
->string
))
4702 pos_byte
= string_char_to_byte (it
->string
, start
);
4704 pos_byte
= CHAR_TO_BYTE (start
);
4706 id
= get_composition_id (start
, pos_byte
, end
- start
, prop
, string
);
4710 struct composition
*cmp
= composition_table
[id
];
4712 if (cmp
->glyph_len
== 0)
4715 if (STRINGP (it
->string
))
4717 IT_STRING_CHARPOS (*it
) = end
;
4718 IT_STRING_BYTEPOS (*it
) = string_char_to_byte (it
->string
,
4723 IT_CHARPOS (*it
) = end
;
4724 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (end
);
4726 return HANDLED_RECOMPUTE_PROPS
;
4729 it
->stop_charpos
= end
;
4732 it
->method
= GET_FROM_COMPOSITION
;
4734 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
4735 /* For a terminal, draw only the first (non-TAB) character
4736 of the components. */
4737 #ifdef USE_FONT_BACKEND
4738 if (composition_table
[id
]->method
== COMPOSITION_WITH_GLYPH_STRING
)
4740 Lisp_Object lgstring
= AREF (XHASH_TABLE (composition_hash_table
)
4742 cmp
->hash_index
* 2);
4744 it
->c
= LGLYPH_CHAR (LGSTRING_GLYPH (lgstring
, 0));
4747 #endif /* USE_FONT_BACKEND */
4751 for (i
= 0; i
< cmp
->glyph_len
; i
++)
4752 if ((it
->c
= COMPOSITION_GLYPH (composition_table
[id
], i
))
4758 it
->len
= (STRINGP (it
->string
)
4759 ? string_char_to_byte (it
->string
, end
)
4760 : CHAR_TO_BYTE (end
)) - pos_byte
;
4761 handled
= HANDLED_RETURN
;
4770 /***********************************************************************
4772 ***********************************************************************/
4774 /* The following structure is used to record overlay strings for
4775 later sorting in load_overlay_strings. */
4777 struct overlay_entry
4779 Lisp_Object overlay
;
4786 /* Set up iterator IT from overlay strings at its current position.
4787 Called from handle_stop. */
4789 static enum prop_handled
4790 handle_overlay_change (it
)
4793 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4794 return HANDLED_RECOMPUTE_PROPS
;
4796 return HANDLED_NORMALLY
;
4800 /* Set up the next overlay string for delivery by IT, if there is an
4801 overlay string to deliver. Called by set_iterator_to_next when the
4802 end of the current overlay string is reached. If there are more
4803 overlay strings to display, IT->string and
4804 IT->current.overlay_string_index are set appropriately here.
4805 Otherwise IT->string is set to nil. */
4808 next_overlay_string (it
)
4811 ++it
->current
.overlay_string_index
;
4812 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4814 /* No more overlay strings. Restore IT's settings to what
4815 they were before overlay strings were processed, and
4816 continue to deliver from current_buffer. */
4817 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4821 || it
->method
== GET_FROM_COMPOSITION
4822 || (NILP (it
->string
)
4823 && it
->method
== GET_FROM_BUFFER
4824 && it
->stop_charpos
>= BEGV
4825 && it
->stop_charpos
<= it
->end_charpos
));
4826 it
->current
.overlay_string_index
= -1;
4827 it
->n_overlay_strings
= 0;
4829 /* If we're at the end of the buffer, record that we have
4830 processed the overlay strings there already, so that
4831 next_element_from_buffer doesn't try it again. */
4832 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4833 it
->overlay_strings_at_end_processed_p
= 1;
4835 /* If we have to display `...' for invisible text, set
4836 the iterator up for that. */
4837 if (display_ellipsis_p
)
4838 setup_for_ellipsis (it
, 0);
4842 /* There are more overlay strings to process. If
4843 IT->current.overlay_string_index has advanced to a position
4844 where we must load IT->overlay_strings with more strings, do
4846 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4848 if (it
->current
.overlay_string_index
&& i
== 0)
4849 load_overlay_strings (it
, 0);
4851 /* Initialize IT to deliver display elements from the overlay
4853 it
->string
= it
->overlay_strings
[i
];
4854 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4855 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4856 it
->method
= GET_FROM_STRING
;
4857 it
->stop_charpos
= 0;
4864 /* Compare two overlay_entry structures E1 and E2. Used as a
4865 comparison function for qsort in load_overlay_strings. Overlay
4866 strings for the same position are sorted so that
4868 1. All after-strings come in front of before-strings, except
4869 when they come from the same overlay.
4871 2. Within after-strings, strings are sorted so that overlay strings
4872 from overlays with higher priorities come first.
4874 2. Within before-strings, strings are sorted so that overlay
4875 strings from overlays with higher priorities come last.
4877 Value is analogous to strcmp. */
4881 compare_overlay_entries (e1
, e2
)
4884 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4885 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4888 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4890 /* Let after-strings appear in front of before-strings if
4891 they come from different overlays. */
4892 if (EQ (entry1
->overlay
, entry2
->overlay
))
4893 result
= entry1
->after_string_p
? 1 : -1;
4895 result
= entry1
->after_string_p
? -1 : 1;
4897 else if (entry1
->after_string_p
)
4898 /* After-strings sorted in order of decreasing priority. */
4899 result
= entry2
->priority
- entry1
->priority
;
4901 /* Before-strings sorted in order of increasing priority. */
4902 result
= entry1
->priority
- entry2
->priority
;
4908 /* Load the vector IT->overlay_strings with overlay strings from IT's
4909 current buffer position, or from CHARPOS if that is > 0. Set
4910 IT->n_overlays to the total number of overlay strings found.
4912 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4913 a time. On entry into load_overlay_strings,
4914 IT->current.overlay_string_index gives the number of overlay
4915 strings that have already been loaded by previous calls to this
4918 IT->add_overlay_start contains an additional overlay start
4919 position to consider for taking overlay strings from, if non-zero.
4920 This position comes into play when the overlay has an `invisible'
4921 property, and both before and after-strings. When we've skipped to
4922 the end of the overlay, because of its `invisible' property, we
4923 nevertheless want its before-string to appear.
4924 IT->add_overlay_start will contain the overlay start position
4927 Overlay strings are sorted so that after-string strings come in
4928 front of before-string strings. Within before and after-strings,
4929 strings are sorted by overlay priority. See also function
4930 compare_overlay_entries. */
4933 load_overlay_strings (it
, charpos
)
4937 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4938 Lisp_Object overlay
, window
, str
, invisible
;
4939 struct Lisp_Overlay
*ov
;
4942 int n
= 0, i
, j
, invis_p
;
4943 struct overlay_entry
*entries
4944 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4947 charpos
= IT_CHARPOS (*it
);
4949 /* Append the overlay string STRING of overlay OVERLAY to vector
4950 `entries' which has size `size' and currently contains `n'
4951 elements. AFTER_P non-zero means STRING is an after-string of
4953 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4956 Lisp_Object priority; \
4960 int new_size = 2 * size; \
4961 struct overlay_entry *old = entries; \
4963 (struct overlay_entry *) alloca (new_size \
4964 * sizeof *entries); \
4965 bcopy (old, entries, size * sizeof *entries); \
4969 entries[n].string = (STRING); \
4970 entries[n].overlay = (OVERLAY); \
4971 priority = Foverlay_get ((OVERLAY), Qpriority); \
4972 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4973 entries[n].after_string_p = (AFTER_P); \
4978 /* Process overlay before the overlay center. */
4979 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4981 XSETMISC (overlay
, ov
);
4982 xassert (OVERLAYP (overlay
));
4983 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4984 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4989 /* Skip this overlay if it doesn't start or end at IT's current
4991 if (end
!= charpos
&& start
!= charpos
)
4994 /* Skip this overlay if it doesn't apply to IT->w. */
4995 window
= Foverlay_get (overlay
, Qwindow
);
4996 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4999 /* If the text ``under'' the overlay is invisible, both before-
5000 and after-strings from this overlay are visible; start and
5001 end position are indistinguishable. */
5002 invisible
= Foverlay_get (overlay
, Qinvisible
);
5003 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5005 /* If overlay has a non-empty before-string, record it. */
5006 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5007 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5009 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5011 /* If overlay has a non-empty after-string, record it. */
5012 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5013 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5015 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5018 /* Process overlays after the overlay center. */
5019 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5021 XSETMISC (overlay
, ov
);
5022 xassert (OVERLAYP (overlay
));
5023 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5024 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5026 if (start
> charpos
)
5029 /* Skip this overlay if it doesn't start or end at IT's current
5031 if (end
!= charpos
&& start
!= charpos
)
5034 /* Skip this overlay if it doesn't apply to IT->w. */
5035 window
= Foverlay_get (overlay
, Qwindow
);
5036 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5039 /* If the text ``under'' the overlay is invisible, it has a zero
5040 dimension, and both before- and after-strings apply. */
5041 invisible
= Foverlay_get (overlay
, Qinvisible
);
5042 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5044 /* If overlay has a non-empty before-string, record it. */
5045 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5046 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5048 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5050 /* If overlay has a non-empty after-string, record it. */
5051 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5052 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5054 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5057 #undef RECORD_OVERLAY_STRING
5061 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5063 /* Record the total number of strings to process. */
5064 it
->n_overlay_strings
= n
;
5066 /* IT->current.overlay_string_index is the number of overlay strings
5067 that have already been consumed by IT. Copy some of the
5068 remaining overlay strings to IT->overlay_strings. */
5070 j
= it
->current
.overlay_string_index
;
5071 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5073 it
->overlay_strings
[i
] = entries
[j
].string
;
5074 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5081 /* Get the first chunk of overlay strings at IT's current buffer
5082 position, or at CHARPOS if that is > 0. Value is non-zero if at
5083 least one overlay string was found. */
5086 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5090 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5091 process. This fills IT->overlay_strings with strings, and sets
5092 IT->n_overlay_strings to the total number of strings to process.
5093 IT->pos.overlay_string_index has to be set temporarily to zero
5094 because load_overlay_strings needs this; it must be set to -1
5095 when no overlay strings are found because a zero value would
5096 indicate a position in the first overlay string. */
5097 it
->current
.overlay_string_index
= 0;
5098 load_overlay_strings (it
, charpos
);
5100 /* If we found overlay strings, set up IT to deliver display
5101 elements from the first one. Otherwise set up IT to deliver
5102 from current_buffer. */
5103 if (it
->n_overlay_strings
)
5105 /* Make sure we know settings in current_buffer, so that we can
5106 restore meaningful values when we're done with the overlay
5109 compute_stop_pos (it
);
5110 xassert (it
->face_id
>= 0);
5112 /* Save IT's settings. They are restored after all overlay
5113 strings have been processed. */
5114 xassert (!compute_stop_p
|| it
->sp
== 0);
5117 /* Set up IT to deliver display elements from the first overlay
5119 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5120 it
->string
= it
->overlay_strings
[0];
5121 it
->from_overlay
= Qnil
;
5122 it
->stop_charpos
= 0;
5123 xassert (STRINGP (it
->string
));
5124 it
->end_charpos
= SCHARS (it
->string
);
5125 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5126 it
->method
= GET_FROM_STRING
;
5130 it
->current
.overlay_string_index
= -1;
5135 get_overlay_strings (it
, charpos
)
5140 it
->method
= GET_FROM_BUFFER
;
5142 (void) get_overlay_strings_1 (it
, charpos
, 1);
5146 /* Value is non-zero if we found at least one overlay string. */
5147 return STRINGP (it
->string
);
5152 /***********************************************************************
5153 Saving and restoring state
5154 ***********************************************************************/
5156 /* Save current settings of IT on IT->stack. Called, for example,
5157 before setting up IT for an overlay string, to be able to restore
5158 IT's settings to what they were after the overlay string has been
5165 struct iterator_stack_entry
*p
;
5167 xassert (it
->sp
< IT_STACK_SIZE
);
5168 p
= it
->stack
+ it
->sp
;
5170 p
->stop_charpos
= it
->stop_charpos
;
5171 xassert (it
->face_id
>= 0);
5172 p
->face_id
= it
->face_id
;
5173 p
->string
= it
->string
;
5174 p
->method
= it
->method
;
5175 p
->from_overlay
= it
->from_overlay
;
5178 case GET_FROM_IMAGE
:
5179 p
->u
.image
.object
= it
->object
;
5180 p
->u
.image
.image_id
= it
->image_id
;
5181 p
->u
.image
.slice
= it
->slice
;
5183 case GET_FROM_COMPOSITION
:
5184 p
->u
.comp
.object
= it
->object
;
5185 p
->u
.comp
.c
= it
->c
;
5186 p
->u
.comp
.len
= it
->len
;
5187 p
->u
.comp
.cmp_id
= it
->cmp_id
;
5188 p
->u
.comp
.cmp_len
= it
->cmp_len
;
5190 case GET_FROM_STRETCH
:
5191 p
->u
.stretch
.object
= it
->object
;
5194 p
->position
= it
->position
;
5195 p
->current
= it
->current
;
5196 p
->end_charpos
= it
->end_charpos
;
5197 p
->string_nchars
= it
->string_nchars
;
5199 p
->multibyte_p
= it
->multibyte_p
;
5200 p
->space_width
= it
->space_width
;
5201 p
->font_height
= it
->font_height
;
5202 p
->voffset
= it
->voffset
;
5203 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5204 p
->display_ellipsis_p
= 0;
5209 /* Restore IT's settings from IT->stack. Called, for example, when no
5210 more overlay strings must be processed, and we return to delivering
5211 display elements from a buffer, or when the end of a string from a
5212 `display' property is reached and we return to delivering display
5213 elements from an overlay string, or from a buffer. */
5219 struct iterator_stack_entry
*p
;
5221 xassert (it
->sp
> 0);
5223 p
= it
->stack
+ it
->sp
;
5224 it
->stop_charpos
= p
->stop_charpos
;
5225 it
->face_id
= p
->face_id
;
5226 it
->current
= p
->current
;
5227 it
->position
= p
->position
;
5228 it
->string
= p
->string
;
5229 it
->from_overlay
= p
->from_overlay
;
5230 if (NILP (it
->string
))
5231 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5232 it
->method
= p
->method
;
5235 case GET_FROM_IMAGE
:
5236 it
->image_id
= p
->u
.image
.image_id
;
5237 it
->object
= p
->u
.image
.object
;
5238 it
->slice
= p
->u
.image
.slice
;
5240 case GET_FROM_COMPOSITION
:
5241 it
->object
= p
->u
.comp
.object
;
5242 it
->c
= p
->u
.comp
.c
;
5243 it
->len
= p
->u
.comp
.len
;
5244 it
->cmp_id
= p
->u
.comp
.cmp_id
;
5245 it
->cmp_len
= p
->u
.comp
.cmp_len
;
5247 case GET_FROM_STRETCH
:
5248 it
->object
= p
->u
.comp
.object
;
5250 case GET_FROM_BUFFER
:
5251 it
->object
= it
->w
->buffer
;
5253 case GET_FROM_STRING
:
5254 it
->object
= it
->string
;
5257 it
->end_charpos
= p
->end_charpos
;
5258 it
->string_nchars
= p
->string_nchars
;
5260 it
->multibyte_p
= p
->multibyte_p
;
5261 it
->space_width
= p
->space_width
;
5262 it
->font_height
= p
->font_height
;
5263 it
->voffset
= p
->voffset
;
5264 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5269 /***********************************************************************
5271 ***********************************************************************/
5273 /* Set IT's current position to the previous line start. */
5276 back_to_previous_line_start (it
)
5279 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5280 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5284 /* Move IT to the next line start.
5286 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5287 we skipped over part of the text (as opposed to moving the iterator
5288 continuously over the text). Otherwise, don't change the value
5291 Newlines may come from buffer text, overlay strings, or strings
5292 displayed via the `display' property. That's the reason we can't
5293 simply use find_next_newline_no_quit.
5295 Note that this function may not skip over invisible text that is so
5296 because of text properties and immediately follows a newline. If
5297 it would, function reseat_at_next_visible_line_start, when called
5298 from set_iterator_to_next, would effectively make invisible
5299 characters following a newline part of the wrong glyph row, which
5300 leads to wrong cursor motion. */
5303 forward_to_next_line_start (it
, skipped_p
)
5307 int old_selective
, newline_found_p
, n
;
5308 const int MAX_NEWLINE_DISTANCE
= 500;
5310 /* If already on a newline, just consume it to avoid unintended
5311 skipping over invisible text below. */
5312 if (it
->what
== IT_CHARACTER
5314 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5316 set_iterator_to_next (it
, 0);
5321 /* Don't handle selective display in the following. It's (a)
5322 unnecessary because it's done by the caller, and (b) leads to an
5323 infinite recursion because next_element_from_ellipsis indirectly
5324 calls this function. */
5325 old_selective
= it
->selective
;
5328 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5329 from buffer text. */
5330 for (n
= newline_found_p
= 0;
5331 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5332 n
+= STRINGP (it
->string
) ? 0 : 1)
5334 if (!get_next_display_element (it
))
5336 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5337 set_iterator_to_next (it
, 0);
5340 /* If we didn't find a newline near enough, see if we can use a
5342 if (!newline_found_p
)
5344 int start
= IT_CHARPOS (*it
);
5345 int limit
= find_next_newline_no_quit (start
, 1);
5348 xassert (!STRINGP (it
->string
));
5350 /* If there isn't any `display' property in sight, and no
5351 overlays, we can just use the position of the newline in
5353 if (it
->stop_charpos
>= limit
5354 || ((pos
= Fnext_single_property_change (make_number (start
),
5356 Qnil
, make_number (limit
)),
5358 && next_overlay_change (start
) == ZV
))
5360 IT_CHARPOS (*it
) = limit
;
5361 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5362 *skipped_p
= newline_found_p
= 1;
5366 while (get_next_display_element (it
)
5367 && !newline_found_p
)
5369 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5370 set_iterator_to_next (it
, 0);
5375 it
->selective
= old_selective
;
5376 return newline_found_p
;
5380 /* Set IT's current position to the previous visible line start. Skip
5381 invisible text that is so either due to text properties or due to
5382 selective display. Caution: this does not change IT->current_x and
5386 back_to_previous_visible_line_start (it
)
5389 while (IT_CHARPOS (*it
) > BEGV
)
5391 back_to_previous_line_start (it
);
5393 if (IT_CHARPOS (*it
) <= BEGV
)
5396 /* If selective > 0, then lines indented more than that values
5398 if (it
->selective
> 0
5399 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5400 (double) it
->selective
)) /* iftc */
5403 /* Check the newline before point for invisibility. */
5406 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5407 Qinvisible
, it
->window
);
5408 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5412 if (IT_CHARPOS (*it
) <= BEGV
)
5419 Lisp_Object val
, overlay
;
5421 /* If newline is part of a composition, continue from start of composition */
5422 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5423 && beg
< IT_CHARPOS (*it
))
5426 /* If newline is replaced by a display property, find start of overlay
5427 or interval and continue search from that point. */
5429 pos
= --IT_CHARPOS (it2
);
5432 if (handle_display_prop (&it2
) == HANDLED_RETURN
5433 && !NILP (val
= get_char_property_and_overlay
5434 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5435 && (OVERLAYP (overlay
)
5436 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5437 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5440 /* Newline is not replaced by anything -- so we are done. */
5446 IT_CHARPOS (*it
) = beg
;
5447 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5451 it
->continuation_lines_width
= 0;
5453 xassert (IT_CHARPOS (*it
) >= BEGV
);
5454 xassert (IT_CHARPOS (*it
) == BEGV
5455 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5460 /* Reseat iterator IT at the previous visible line start. Skip
5461 invisible text that is so either due to text properties or due to
5462 selective display. At the end, update IT's overlay information,
5463 face information etc. */
5466 reseat_at_previous_visible_line_start (it
)
5469 back_to_previous_visible_line_start (it
);
5470 reseat (it
, it
->current
.pos
, 1);
5475 /* Reseat iterator IT on the next visible line start in the current
5476 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5477 preceding the line start. Skip over invisible text that is so
5478 because of selective display. Compute faces, overlays etc at the
5479 new position. Note that this function does not skip over text that
5480 is invisible because of text properties. */
5483 reseat_at_next_visible_line_start (it
, on_newline_p
)
5487 int newline_found_p
, skipped_p
= 0;
5489 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5491 /* Skip over lines that are invisible because they are indented
5492 more than the value of IT->selective. */
5493 if (it
->selective
> 0)
5494 while (IT_CHARPOS (*it
) < ZV
5495 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5496 (double) it
->selective
)) /* iftc */
5498 xassert (IT_BYTEPOS (*it
) == BEGV
5499 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5500 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5503 /* Position on the newline if that's what's requested. */
5504 if (on_newline_p
&& newline_found_p
)
5506 if (STRINGP (it
->string
))
5508 if (IT_STRING_CHARPOS (*it
) > 0)
5510 --IT_STRING_CHARPOS (*it
);
5511 --IT_STRING_BYTEPOS (*it
);
5514 else if (IT_CHARPOS (*it
) > BEGV
)
5518 reseat (it
, it
->current
.pos
, 0);
5522 reseat (it
, it
->current
.pos
, 0);
5529 /***********************************************************************
5530 Changing an iterator's position
5531 ***********************************************************************/
5533 /* Change IT's current position to POS in current_buffer. If FORCE_P
5534 is non-zero, always check for text properties at the new position.
5535 Otherwise, text properties are only looked up if POS >=
5536 IT->check_charpos of a property. */
5539 reseat (it
, pos
, force_p
)
5541 struct text_pos pos
;
5544 int original_pos
= IT_CHARPOS (*it
);
5546 reseat_1 (it
, pos
, 0);
5548 /* Determine where to check text properties. Avoid doing it
5549 where possible because text property lookup is very expensive. */
5551 || CHARPOS (pos
) > it
->stop_charpos
5552 || CHARPOS (pos
) < original_pos
)
5559 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5560 IT->stop_pos to POS, also. */
5563 reseat_1 (it
, pos
, set_stop_p
)
5565 struct text_pos pos
;
5568 /* Don't call this function when scanning a C string. */
5569 xassert (it
->s
== NULL
);
5571 /* POS must be a reasonable value. */
5572 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5574 it
->current
.pos
= it
->position
= pos
;
5575 it
->end_charpos
= ZV
;
5577 it
->current
.dpvec_index
= -1;
5578 it
->current
.overlay_string_index
= -1;
5579 IT_STRING_CHARPOS (*it
) = -1;
5580 IT_STRING_BYTEPOS (*it
) = -1;
5582 it
->method
= GET_FROM_BUFFER
;
5583 it
->object
= it
->w
->buffer
;
5584 it
->area
= TEXT_AREA
;
5585 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5587 it
->string_from_display_prop_p
= 0;
5588 it
->face_before_selective_p
= 0;
5591 it
->stop_charpos
= CHARPOS (pos
);
5595 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5596 If S is non-null, it is a C string to iterate over. Otherwise,
5597 STRING gives a Lisp string to iterate over.
5599 If PRECISION > 0, don't return more then PRECISION number of
5600 characters from the string.
5602 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5603 characters have been returned. FIELD_WIDTH < 0 means an infinite
5606 MULTIBYTE = 0 means disable processing of multibyte characters,
5607 MULTIBYTE > 0 means enable it,
5608 MULTIBYTE < 0 means use IT->multibyte_p.
5610 IT must be initialized via a prior call to init_iterator before
5611 calling this function. */
5614 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5619 int precision
, field_width
, multibyte
;
5621 /* No region in strings. */
5622 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5624 /* No text property checks performed by default, but see below. */
5625 it
->stop_charpos
= -1;
5627 /* Set iterator position and end position. */
5628 bzero (&it
->current
, sizeof it
->current
);
5629 it
->current
.overlay_string_index
= -1;
5630 it
->current
.dpvec_index
= -1;
5631 xassert (charpos
>= 0);
5633 /* If STRING is specified, use its multibyteness, otherwise use the
5634 setting of MULTIBYTE, if specified. */
5636 it
->multibyte_p
= multibyte
> 0;
5640 xassert (STRINGP (string
));
5641 it
->string
= string
;
5643 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5644 it
->method
= GET_FROM_STRING
;
5645 it
->current
.string_pos
= string_pos (charpos
, string
);
5652 /* Note that we use IT->current.pos, not it->current.string_pos,
5653 for displaying C strings. */
5654 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5655 if (it
->multibyte_p
)
5657 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5658 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5662 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5663 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5666 it
->method
= GET_FROM_C_STRING
;
5669 /* PRECISION > 0 means don't return more than PRECISION characters
5671 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5672 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5674 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5675 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5676 FIELD_WIDTH < 0 means infinite field width. This is useful for
5677 padding with `-' at the end of a mode line. */
5678 if (field_width
< 0)
5679 field_width
= INFINITY
;
5680 if (field_width
> it
->end_charpos
- charpos
)
5681 it
->end_charpos
= charpos
+ field_width
;
5683 /* Use the standard display table for displaying strings. */
5684 if (DISP_TABLE_P (Vstandard_display_table
))
5685 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5687 it
->stop_charpos
= charpos
;
5693 /***********************************************************************
5695 ***********************************************************************/
5697 /* Map enum it_method value to corresponding next_element_from_* function. */
5699 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5701 next_element_from_buffer
,
5702 next_element_from_display_vector
,
5703 next_element_from_composition
,
5704 next_element_from_string
,
5705 next_element_from_c_string
,
5706 next_element_from_image
,
5707 next_element_from_stretch
5711 /* Load IT's display element fields with information about the next
5712 display element from the current position of IT. Value is zero if
5713 end of buffer (or C string) is reached. */
5715 static struct frame
*last_escape_glyph_frame
= NULL
;
5716 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5717 static int last_escape_glyph_merged_face_id
= 0;
5720 get_next_display_element (it
)
5723 /* Non-zero means that we found a display element. Zero means that
5724 we hit the end of what we iterate over. Performance note: the
5725 function pointer `method' used here turns out to be faster than
5726 using a sequence of if-statements. */
5730 success_p
= (*get_next_element
[it
->method
]) (it
);
5732 if (it
->what
== IT_CHARACTER
)
5734 /* Map via display table or translate control characters.
5735 IT->c, IT->len etc. have been set to the next character by
5736 the function call above. If we have a display table, and it
5737 contains an entry for IT->c, translate it. Don't do this if
5738 IT->c itself comes from a display table, otherwise we could
5739 end up in an infinite recursion. (An alternative could be to
5740 count the recursion depth of this function and signal an
5741 error when a certain maximum depth is reached.) Is it worth
5743 if (success_p
&& it
->dpvec
== NULL
)
5748 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5751 struct Lisp_Vector
*v
= XVECTOR (dv
);
5753 /* Return the first character from the display table
5754 entry, if not empty. If empty, don't display the
5755 current character. */
5758 it
->dpvec_char_len
= it
->len
;
5759 it
->dpvec
= v
->contents
;
5760 it
->dpend
= v
->contents
+ v
->size
;
5761 it
->current
.dpvec_index
= 0;
5762 it
->dpvec_face_id
= -1;
5763 it
->saved_face_id
= it
->face_id
;
5764 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5769 set_iterator_to_next (it
, 0);
5774 /* Translate control characters into `\003' or `^C' form.
5775 Control characters coming from a display table entry are
5776 currently not translated because we use IT->dpvec to hold
5777 the translation. This could easily be changed but I
5778 don't believe that it is worth doing.
5780 If it->multibyte_p is nonzero, non-printable non-ASCII
5781 characters are also translated to octal form.
5783 If it->multibyte_p is zero, eight-bit characters that
5784 don't have corresponding multibyte char code are also
5785 translated to octal form. */
5786 else if ((it
->c
< ' '
5787 ? (it
->area
!= TEXT_AREA
5788 /* In mode line, treat \n, \t like other crl chars. */
5790 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5791 || (it
->c
!= '\n' && it
->c
!= '\t'))
5793 ? (!CHAR_PRINTABLE_P (it
->c
)
5794 || (!NILP (Vnobreak_char_display
)
5795 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5796 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5798 && (! unibyte_display_via_language_environment
5799 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5801 /* IT->c is a control character which must be displayed
5802 either as '\003' or as `^C' where the '\\' and '^'
5803 can be defined in the display table. Fill
5804 IT->ctl_chars with glyphs for what we have to
5805 display. Then, set IT->dpvec to these glyphs. */
5808 int face_id
, lface_id
= 0 ;
5811 /* Handle control characters with ^. */
5813 if (it
->c
< 128 && it
->ctl_arrow_p
)
5815 g
= '^'; /* default glyph for Control */
5816 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5818 && INTEGERP (DISP_CTRL_GLYPH (it
->dp
))
5819 && GLYPH_CHAR_VALID_P (XINT (DISP_CTRL_GLYPH (it
->dp
))))
5821 g
= XINT (DISP_CTRL_GLYPH (it
->dp
));
5822 lface_id
= FAST_GLYPH_FACE (g
);
5826 g
= FAST_GLYPH_CHAR (g
);
5827 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5830 else if (it
->f
== last_escape_glyph_frame
5831 && it
->face_id
== last_escape_glyph_face_id
)
5833 face_id
= last_escape_glyph_merged_face_id
;
5837 /* Merge the escape-glyph face into the current face. */
5838 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5840 last_escape_glyph_frame
= it
->f
;
5841 last_escape_glyph_face_id
= it
->face_id
;
5842 last_escape_glyph_merged_face_id
= face_id
;
5845 XSETINT (it
->ctl_chars
[0], g
);
5847 XSETINT (it
->ctl_chars
[1], g
);
5849 goto display_control
;
5852 /* Handle non-break space in the mode where it only gets
5855 if (EQ (Vnobreak_char_display
, Qt
)
5858 /* Merge the no-break-space face into the current face. */
5859 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5863 XSETINT (it
->ctl_chars
[0], g
);
5865 goto display_control
;
5868 /* Handle sequences that start with the "escape glyph". */
5870 /* the default escape glyph is \. */
5871 escape_glyph
= '\\';
5874 && INTEGERP (DISP_ESCAPE_GLYPH (it
->dp
))
5875 && GLYPH_CHAR_VALID_P (XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
))))
5877 escape_glyph
= XFASTINT (DISP_ESCAPE_GLYPH (it
->dp
));
5878 lface_id
= FAST_GLYPH_FACE (escape_glyph
);
5882 /* The display table specified a face.
5883 Merge it into face_id and also into escape_glyph. */
5884 escape_glyph
= FAST_GLYPH_CHAR (escape_glyph
);
5885 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5888 else if (it
->f
== last_escape_glyph_frame
5889 && it
->face_id
== last_escape_glyph_face_id
)
5891 face_id
= last_escape_glyph_merged_face_id
;
5895 /* Merge the escape-glyph face into the current face. */
5896 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5898 last_escape_glyph_frame
= it
->f
;
5899 last_escape_glyph_face_id
= it
->face_id
;
5900 last_escape_glyph_merged_face_id
= face_id
;
5903 /* Handle soft hyphens in the mode where they only get
5906 if (EQ (Vnobreak_char_display
, Qt
)
5910 XSETINT (it
->ctl_chars
[0], g
);
5912 goto display_control
;
5915 /* Handle non-break space and soft hyphen
5916 with the escape glyph. */
5918 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5920 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5921 g
= it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5922 XSETINT (it
->ctl_chars
[1], g
);
5924 goto display_control
;
5928 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5932 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5933 if (CHAR_BYTE8_P (it
->c
))
5935 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5938 else if (it
->c
< 256)
5945 /* It's an invalid character, which shouldn't
5946 happen actually, but due to bugs it may
5947 happen. Let's print the char as is, there's
5948 not much meaningful we can do with it. */
5950 str
[1] = it
->c
>> 8;
5951 str
[2] = it
->c
>> 16;
5952 str
[3] = it
->c
>> 24;
5956 for (i
= 0; i
< len
; i
++)
5958 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5959 /* Insert three more glyphs into IT->ctl_chars for
5960 the octal display of the character. */
5961 g
= ((str
[i
] >> 6) & 7) + '0';
5962 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5963 g
= ((str
[i
] >> 3) & 7) + '0';
5964 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5965 g
= (str
[i
] & 7) + '0';
5966 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5972 /* Set up IT->dpvec and return first character from it. */
5973 it
->dpvec_char_len
= it
->len
;
5974 it
->dpvec
= it
->ctl_chars
;
5975 it
->dpend
= it
->dpvec
+ ctl_len
;
5976 it
->current
.dpvec_index
= 0;
5977 it
->dpvec_face_id
= face_id
;
5978 it
->saved_face_id
= it
->face_id
;
5979 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5986 /* Adjust face id for a multibyte character. There are no multibyte
5987 character in unibyte text. */
5988 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5991 && FRAME_WINDOW_P (it
->f
))
5993 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5994 int pos
= (it
->s
? -1
5995 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5996 : IT_CHARPOS (*it
));
5998 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6001 /* Is this character the last one of a run of characters with
6002 box? If yes, set IT->end_of_box_run_p to 1. */
6009 it
->end_of_box_run_p
6010 = ((face_id
= face_after_it_pos (it
),
6011 face_id
!= it
->face_id
)
6012 && (face
= FACE_FROM_ID (it
->f
, face_id
),
6013 face
->box
== FACE_NO_BOX
));
6016 /* Value is 0 if end of buffer or string reached. */
6021 /* Move IT to the next display element.
6023 RESEAT_P non-zero means if called on a newline in buffer text,
6024 skip to the next visible line start.
6026 Functions get_next_display_element and set_iterator_to_next are
6027 separate because I find this arrangement easier to handle than a
6028 get_next_display_element function that also increments IT's
6029 position. The way it is we can first look at an iterator's current
6030 display element, decide whether it fits on a line, and if it does,
6031 increment the iterator position. The other way around we probably
6032 would either need a flag indicating whether the iterator has to be
6033 incremented the next time, or we would have to implement a
6034 decrement position function which would not be easy to write. */
6037 set_iterator_to_next (it
, reseat_p
)
6041 /* Reset flags indicating start and end of a sequence of characters
6042 with box. Reset them at the start of this function because
6043 moving the iterator to a new position might set them. */
6044 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6048 case GET_FROM_BUFFER
:
6049 /* The current display element of IT is a character from
6050 current_buffer. Advance in the buffer, and maybe skip over
6051 invisible lines that are so because of selective display. */
6052 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6053 reseat_at_next_visible_line_start (it
, 0);
6056 xassert (it
->len
!= 0);
6057 IT_BYTEPOS (*it
) += it
->len
;
6058 IT_CHARPOS (*it
) += 1;
6059 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6063 case GET_FROM_COMPOSITION
:
6064 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
6065 xassert (it
->sp
> 0);
6067 if (it
->method
== GET_FROM_STRING
)
6069 IT_STRING_BYTEPOS (*it
) += it
->len
;
6070 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
6071 goto consider_string_end
;
6073 else if (it
->method
== GET_FROM_BUFFER
)
6075 IT_BYTEPOS (*it
) += it
->len
;
6076 IT_CHARPOS (*it
) += it
->cmp_len
;
6080 case GET_FROM_C_STRING
:
6081 /* Current display element of IT is from a C string. */
6082 IT_BYTEPOS (*it
) += it
->len
;
6083 IT_CHARPOS (*it
) += 1;
6086 case GET_FROM_DISPLAY_VECTOR
:
6087 /* Current display element of IT is from a display table entry.
6088 Advance in the display table definition. Reset it to null if
6089 end reached, and continue with characters from buffers/
6091 ++it
->current
.dpvec_index
;
6093 /* Restore face of the iterator to what they were before the
6094 display vector entry (these entries may contain faces). */
6095 it
->face_id
= it
->saved_face_id
;
6097 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6099 int recheck_faces
= it
->ellipsis_p
;
6102 it
->method
= GET_FROM_C_STRING
;
6103 else if (STRINGP (it
->string
))
6104 it
->method
= GET_FROM_STRING
;
6107 it
->method
= GET_FROM_BUFFER
;
6108 it
->object
= it
->w
->buffer
;
6112 it
->current
.dpvec_index
= -1;
6114 /* Skip over characters which were displayed via IT->dpvec. */
6115 if (it
->dpvec_char_len
< 0)
6116 reseat_at_next_visible_line_start (it
, 1);
6117 else if (it
->dpvec_char_len
> 0)
6119 if (it
->method
== GET_FROM_STRING
6120 && it
->n_overlay_strings
> 0)
6121 it
->ignore_overlay_strings_at_pos_p
= 1;
6122 it
->len
= it
->dpvec_char_len
;
6123 set_iterator_to_next (it
, reseat_p
);
6126 /* Maybe recheck faces after display vector */
6128 it
->stop_charpos
= IT_CHARPOS (*it
);
6132 case GET_FROM_STRING
:
6133 /* Current display element is a character from a Lisp string. */
6134 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6135 IT_STRING_BYTEPOS (*it
) += it
->len
;
6136 IT_STRING_CHARPOS (*it
) += 1;
6138 consider_string_end
:
6140 if (it
->current
.overlay_string_index
>= 0)
6142 /* IT->string is an overlay string. Advance to the
6143 next, if there is one. */
6144 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6145 next_overlay_string (it
);
6149 /* IT->string is not an overlay string. If we reached
6150 its end, and there is something on IT->stack, proceed
6151 with what is on the stack. This can be either another
6152 string, this time an overlay string, or a buffer. */
6153 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6157 if (it
->method
== GET_FROM_STRING
)
6158 goto consider_string_end
;
6163 case GET_FROM_IMAGE
:
6164 case GET_FROM_STRETCH
:
6165 /* The position etc with which we have to proceed are on
6166 the stack. The position may be at the end of a string,
6167 if the `display' property takes up the whole string. */
6168 xassert (it
->sp
> 0);
6170 if (it
->method
== GET_FROM_STRING
)
6171 goto consider_string_end
;
6175 /* There are no other methods defined, so this should be a bug. */
6179 xassert (it
->method
!= GET_FROM_STRING
6180 || (STRINGP (it
->string
)
6181 && IT_STRING_CHARPOS (*it
) >= 0));
6184 /* Load IT's display element fields with information about the next
6185 display element which comes from a display table entry or from the
6186 result of translating a control character to one of the forms `^C'
6189 IT->dpvec holds the glyphs to return as characters.
6190 IT->saved_face_id holds the face id before the display vector--
6191 it is restored into IT->face_idin set_iterator_to_next. */
6194 next_element_from_display_vector (it
)
6198 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6200 it
->face_id
= it
->saved_face_id
;
6202 if (INTEGERP (*it
->dpvec
)
6203 && GLYPH_CHAR_VALID_P (XFASTINT (*it
->dpvec
)))
6207 g
= XFASTINT (it
->dpvec
[it
->current
.dpvec_index
]);
6208 it
->c
= FAST_GLYPH_CHAR (g
);
6209 it
->len
= CHAR_BYTES (it
->c
);
6211 /* The entry may contain a face id to use. Such a face id is
6212 the id of a Lisp face, not a realized face. A face id of
6213 zero means no face is specified. */
6214 if (it
->dpvec_face_id
>= 0)
6215 it
->face_id
= it
->dpvec_face_id
;
6218 int lface_id
= FAST_GLYPH_FACE (g
);
6220 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6225 /* Display table entry is invalid. Return a space. */
6226 it
->c
= ' ', it
->len
= 1;
6228 /* Don't change position and object of the iterator here. They are
6229 still the values of the character that had this display table
6230 entry or was translated, and that's what we want. */
6231 it
->what
= IT_CHARACTER
;
6236 /* Load IT with the next display element from Lisp string IT->string.
6237 IT->current.string_pos is the current position within the string.
6238 If IT->current.overlay_string_index >= 0, the Lisp string is an
6242 next_element_from_string (it
)
6245 struct text_pos position
;
6247 xassert (STRINGP (it
->string
));
6248 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6249 position
= it
->current
.string_pos
;
6251 /* Time to check for invisible text? */
6252 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6253 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6257 /* Since a handler may have changed IT->method, we must
6259 return get_next_display_element (it
);
6262 if (it
->current
.overlay_string_index
>= 0)
6264 /* Get the next character from an overlay string. In overlay
6265 strings, There is no field width or padding with spaces to
6267 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6272 else if (STRING_MULTIBYTE (it
->string
))
6274 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6275 const unsigned char *s
= (SDATA (it
->string
)
6276 + IT_STRING_BYTEPOS (*it
));
6277 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6281 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6287 /* Get the next character from a Lisp string that is not an
6288 overlay string. Such strings come from the mode line, for
6289 example. We may have to pad with spaces, or truncate the
6290 string. See also next_element_from_c_string. */
6291 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6296 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6298 /* Pad with spaces. */
6299 it
->c
= ' ', it
->len
= 1;
6300 CHARPOS (position
) = BYTEPOS (position
) = -1;
6302 else if (STRING_MULTIBYTE (it
->string
))
6304 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6305 const unsigned char *s
= (SDATA (it
->string
)
6306 + IT_STRING_BYTEPOS (*it
));
6307 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6311 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6316 /* Record what we have and where it came from. */
6317 it
->what
= IT_CHARACTER
;
6318 it
->object
= it
->string
;
6319 it
->position
= position
;
6324 /* Load IT with next display element from C string IT->s.
6325 IT->string_nchars is the maximum number of characters to return
6326 from the string. IT->end_charpos may be greater than
6327 IT->string_nchars when this function is called, in which case we
6328 may have to return padding spaces. Value is zero if end of string
6329 reached, including padding spaces. */
6332 next_element_from_c_string (it
)
6338 it
->what
= IT_CHARACTER
;
6339 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6342 /* IT's position can be greater IT->string_nchars in case a field
6343 width or precision has been specified when the iterator was
6345 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6347 /* End of the game. */
6351 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6353 /* Pad with spaces. */
6354 it
->c
= ' ', it
->len
= 1;
6355 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6357 else if (it
->multibyte_p
)
6359 /* Implementation note: The calls to strlen apparently aren't a
6360 performance problem because there is no noticeable performance
6361 difference between Emacs running in unibyte or multibyte mode. */
6362 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6363 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6367 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6373 /* Set up IT to return characters from an ellipsis, if appropriate.
6374 The definition of the ellipsis glyphs may come from a display table
6375 entry. This function Fills IT with the first glyph from the
6376 ellipsis if an ellipsis is to be displayed. */
6379 next_element_from_ellipsis (it
)
6382 if (it
->selective_display_ellipsis_p
)
6383 setup_for_ellipsis (it
, it
->len
);
6386 /* The face at the current position may be different from the
6387 face we find after the invisible text. Remember what it
6388 was in IT->saved_face_id, and signal that it's there by
6389 setting face_before_selective_p. */
6390 it
->saved_face_id
= it
->face_id
;
6391 it
->method
= GET_FROM_BUFFER
;
6392 it
->object
= it
->w
->buffer
;
6393 reseat_at_next_visible_line_start (it
, 1);
6394 it
->face_before_selective_p
= 1;
6397 return get_next_display_element (it
);
6401 /* Deliver an image display element. The iterator IT is already
6402 filled with image information (done in handle_display_prop). Value
6407 next_element_from_image (it
)
6410 it
->what
= IT_IMAGE
;
6415 /* Fill iterator IT with next display element from a stretch glyph
6416 property. IT->object is the value of the text property. Value is
6420 next_element_from_stretch (it
)
6423 it
->what
= IT_STRETCH
;
6428 /* Load IT with the next display element from current_buffer. Value
6429 is zero if end of buffer reached. IT->stop_charpos is the next
6430 position at which to stop and check for text properties or buffer
6434 next_element_from_buffer (it
)
6439 /* Check this assumption, otherwise, we would never enter the
6440 if-statement, below. */
6441 xassert (IT_CHARPOS (*it
) >= BEGV
6442 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6444 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6446 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6448 int overlay_strings_follow_p
;
6450 /* End of the game, except when overlay strings follow that
6451 haven't been returned yet. */
6452 if (it
->overlay_strings_at_end_processed_p
)
6453 overlay_strings_follow_p
= 0;
6456 it
->overlay_strings_at_end_processed_p
= 1;
6457 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6460 if (overlay_strings_follow_p
)
6461 success_p
= get_next_display_element (it
);
6465 it
->position
= it
->current
.pos
;
6472 return get_next_display_element (it
);
6477 /* No face changes, overlays etc. in sight, so just return a
6478 character from current_buffer. */
6481 /* Maybe run the redisplay end trigger hook. Performance note:
6482 This doesn't seem to cost measurable time. */
6483 if (it
->redisplay_end_trigger_charpos
6485 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6486 run_redisplay_end_trigger_hook (it
);
6488 /* Get the next character, maybe multibyte. */
6489 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6490 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6492 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
6493 - IT_BYTEPOS (*it
));
6494 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
6497 it
->c
= *p
, it
->len
= 1;
6499 /* Record what we have and where it came from. */
6500 it
->what
= IT_CHARACTER
;
6501 it
->object
= it
->w
->buffer
;
6502 it
->position
= it
->current
.pos
;
6504 /* Normally we return the character found above, except when we
6505 really want to return an ellipsis for selective display. */
6510 /* A value of selective > 0 means hide lines indented more
6511 than that number of columns. */
6512 if (it
->selective
> 0
6513 && IT_CHARPOS (*it
) + 1 < ZV
6514 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6515 IT_BYTEPOS (*it
) + 1,
6516 (double) it
->selective
)) /* iftc */
6518 success_p
= next_element_from_ellipsis (it
);
6519 it
->dpvec_char_len
= -1;
6522 else if (it
->c
== '\r' && it
->selective
== -1)
6524 /* A value of selective == -1 means that everything from the
6525 CR to the end of the line is invisible, with maybe an
6526 ellipsis displayed for it. */
6527 success_p
= next_element_from_ellipsis (it
);
6528 it
->dpvec_char_len
= -1;
6533 /* Value is zero if end of buffer reached. */
6534 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6539 /* Run the redisplay end trigger hook for IT. */
6542 run_redisplay_end_trigger_hook (it
)
6545 Lisp_Object args
[3];
6547 /* IT->glyph_row should be non-null, i.e. we should be actually
6548 displaying something, or otherwise we should not run the hook. */
6549 xassert (it
->glyph_row
);
6551 /* Set up hook arguments. */
6552 args
[0] = Qredisplay_end_trigger_functions
;
6553 args
[1] = it
->window
;
6554 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6555 it
->redisplay_end_trigger_charpos
= 0;
6557 /* Since we are *trying* to run these functions, don't try to run
6558 them again, even if they get an error. */
6559 it
->w
->redisplay_end_trigger
= Qnil
;
6560 Frun_hook_with_args (3, args
);
6562 /* Notice if it changed the face of the character we are on. */
6563 handle_face_prop (it
);
6567 /* Deliver a composition display element. The iterator IT is already
6568 filled with composition information (done in
6569 handle_composition_prop). Value is always 1. */
6572 next_element_from_composition (it
)
6575 it
->what
= IT_COMPOSITION
;
6576 it
->position
= (STRINGP (it
->string
)
6577 ? it
->current
.string_pos
6579 if (STRINGP (it
->string
))
6580 it
->object
= it
->string
;
6582 it
->object
= it
->w
->buffer
;
6588 /***********************************************************************
6589 Moving an iterator without producing glyphs
6590 ***********************************************************************/
6592 /* Check if iterator is at a position corresponding to a valid buffer
6593 position after some move_it_ call. */
6595 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6596 ((it)->method == GET_FROM_STRING \
6597 ? IT_STRING_CHARPOS (*it) == 0 \
6601 /* Move iterator IT to a specified buffer or X position within one
6602 line on the display without producing glyphs.
6604 OP should be a bit mask including some or all of these bits:
6605 MOVE_TO_X: Stop on reaching x-position TO_X.
6606 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6607 Regardless of OP's value, stop in reaching the end of the display line.
6609 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6610 This means, in particular, that TO_X includes window's horizontal
6613 The return value has several possible values that
6614 say what condition caused the scan to stop:
6616 MOVE_POS_MATCH_OR_ZV
6617 - when TO_POS or ZV was reached.
6620 -when TO_X was reached before TO_POS or ZV were reached.
6623 - when we reached the end of the display area and the line must
6627 - when we reached the end of the display area and the line is
6631 - when we stopped at a line end, i.e. a newline or a CR and selective
6634 static enum move_it_result
6635 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
6637 int to_charpos
, to_x
, op
;
6639 enum move_it_result result
= MOVE_UNDEFINED
;
6640 struct glyph_row
*saved_glyph_row
;
6642 /* Don't produce glyphs in produce_glyphs. */
6643 saved_glyph_row
= it
->glyph_row
;
6644 it
->glyph_row
= NULL
;
6646 #define BUFFER_POS_REACHED_P() \
6647 ((op & MOVE_TO_POS) != 0 \
6648 && BUFFERP (it->object) \
6649 && IT_CHARPOS (*it) >= to_charpos \
6650 && (it->method == GET_FROM_BUFFER \
6651 || (it->method == GET_FROM_DISPLAY_VECTOR \
6652 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6657 int x
, i
, ascent
= 0, descent
= 0;
6659 /* Stop if we move beyond TO_CHARPOS (after an image or stretch glyph). */
6660 if ((op
& MOVE_TO_POS
) != 0
6661 && BUFFERP (it
->object
)
6662 && it
->method
== GET_FROM_BUFFER
6663 && IT_CHARPOS (*it
) > to_charpos
)
6665 result
= MOVE_POS_MATCH_OR_ZV
;
6669 /* Stop when ZV reached.
6670 We used to stop here when TO_CHARPOS reached as well, but that is
6671 too soon if this glyph does not fit on this line. So we handle it
6672 explicitly below. */
6673 if (!get_next_display_element (it
)
6674 || (it
->truncate_lines_p
6675 && BUFFER_POS_REACHED_P ()))
6677 result
= MOVE_POS_MATCH_OR_ZV
;
6681 /* The call to produce_glyphs will get the metrics of the
6682 display element IT is loaded with. We record in x the
6683 x-position before this display element in case it does not
6687 /* Remember the line height so far in case the next element doesn't
6689 if (!it
->truncate_lines_p
)
6691 ascent
= it
->max_ascent
;
6692 descent
= it
->max_descent
;
6695 PRODUCE_GLYPHS (it
);
6697 if (it
->area
!= TEXT_AREA
)
6699 set_iterator_to_next (it
, 1);
6703 /* The number of glyphs we get back in IT->nglyphs will normally
6704 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6705 character on a terminal frame, or (iii) a line end. For the
6706 second case, IT->nglyphs - 1 padding glyphs will be present
6707 (on X frames, there is only one glyph produced for a
6708 composite character.
6710 The behavior implemented below means, for continuation lines,
6711 that as many spaces of a TAB as fit on the current line are
6712 displayed there. For terminal frames, as many glyphs of a
6713 multi-glyph character are displayed in the current line, too.
6714 This is what the old redisplay code did, and we keep it that
6715 way. Under X, the whole shape of a complex character must
6716 fit on the line or it will be completely displayed in the
6719 Note that both for tabs and padding glyphs, all glyphs have
6723 /* More than one glyph or glyph doesn't fit on line. All
6724 glyphs have the same width. */
6725 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6727 int x_before_this_char
= x
;
6728 int hpos_before_this_char
= it
->hpos
;
6730 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6732 new_x
= x
+ single_glyph_width
;
6734 /* We want to leave anything reaching TO_X to the caller. */
6735 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6737 if (BUFFER_POS_REACHED_P ())
6738 goto buffer_pos_reached
;
6740 result
= MOVE_X_REACHED
;
6743 else if (/* Lines are continued. */
6744 !it
->truncate_lines_p
6745 && (/* And glyph doesn't fit on the line. */
6746 new_x
> it
->last_visible_x
6747 /* Or it fits exactly and we're on a window
6749 || (new_x
== it
->last_visible_x
6750 && FRAME_WINDOW_P (it
->f
))))
6752 if (/* IT->hpos == 0 means the very first glyph
6753 doesn't fit on the line, e.g. a wide image. */
6755 || (new_x
== it
->last_visible_x
6756 && FRAME_WINDOW_P (it
->f
)))
6759 it
->current_x
= new_x
;
6761 /* The character's last glyph just barely fits
6763 if (i
== it
->nglyphs
- 1)
6765 /* If this is the destination position,
6766 return a position *before* it in this row,
6767 now that we know it fits in this row. */
6768 if (BUFFER_POS_REACHED_P ())
6770 it
->hpos
= hpos_before_this_char
;
6771 it
->current_x
= x_before_this_char
;
6772 result
= MOVE_POS_MATCH_OR_ZV
;
6776 set_iterator_to_next (it
, 1);
6777 #ifdef HAVE_WINDOW_SYSTEM
6778 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6780 if (!get_next_display_element (it
))
6782 result
= MOVE_POS_MATCH_OR_ZV
;
6785 if (BUFFER_POS_REACHED_P ())
6787 if (ITERATOR_AT_END_OF_LINE_P (it
))
6788 result
= MOVE_POS_MATCH_OR_ZV
;
6790 result
= MOVE_LINE_CONTINUED
;
6793 if (ITERATOR_AT_END_OF_LINE_P (it
))
6795 result
= MOVE_NEWLINE_OR_CR
;
6799 #endif /* HAVE_WINDOW_SYSTEM */
6805 it
->max_ascent
= ascent
;
6806 it
->max_descent
= descent
;
6809 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6811 result
= MOVE_LINE_CONTINUED
;
6814 else if (BUFFER_POS_REACHED_P ())
6815 goto buffer_pos_reached
;
6816 else if (new_x
> it
->first_visible_x
)
6818 /* Glyph is visible. Increment number of glyphs that
6819 would be displayed. */
6824 /* Glyph is completely off the left margin of the display
6825 area. Nothing to do. */
6829 if (result
!= MOVE_UNDEFINED
)
6832 else if (BUFFER_POS_REACHED_P ())
6836 it
->max_ascent
= ascent
;
6837 it
->max_descent
= descent
;
6838 result
= MOVE_POS_MATCH_OR_ZV
;
6841 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6843 /* Stop when TO_X specified and reached. This check is
6844 necessary here because of lines consisting of a line end,
6845 only. The line end will not produce any glyphs and we
6846 would never get MOVE_X_REACHED. */
6847 xassert (it
->nglyphs
== 0);
6848 result
= MOVE_X_REACHED
;
6852 /* Is this a line end? If yes, we're done. */
6853 if (ITERATOR_AT_END_OF_LINE_P (it
))
6855 result
= MOVE_NEWLINE_OR_CR
;
6859 /* The current display element has been consumed. Advance
6861 set_iterator_to_next (it
, 1);
6863 /* Stop if lines are truncated and IT's current x-position is
6864 past the right edge of the window now. */
6865 if (it
->truncate_lines_p
6866 && it
->current_x
>= it
->last_visible_x
)
6868 #ifdef HAVE_WINDOW_SYSTEM
6869 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6871 if (!get_next_display_element (it
)
6872 || BUFFER_POS_REACHED_P ())
6874 result
= MOVE_POS_MATCH_OR_ZV
;
6877 if (ITERATOR_AT_END_OF_LINE_P (it
))
6879 result
= MOVE_NEWLINE_OR_CR
;
6883 #endif /* HAVE_WINDOW_SYSTEM */
6884 result
= MOVE_LINE_TRUNCATED
;
6889 #undef BUFFER_POS_REACHED_P
6891 /* Restore the iterator settings altered at the beginning of this
6893 it
->glyph_row
= saved_glyph_row
;
6898 /* Move IT forward until it satisfies one or more of the criteria in
6899 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
6901 OP is a bit-mask that specifies where to stop, and in particular,
6902 which of those four position arguments makes a difference. See the
6903 description of enum move_operation_enum.
6905 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
6906 screen line, this function will set IT to the next position >
6910 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
6912 int to_charpos
, to_x
, to_y
, to_vpos
;
6915 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
6921 if (op
& MOVE_TO_VPOS
)
6923 /* If no TO_CHARPOS and no TO_X specified, stop at the
6924 start of the line TO_VPOS. */
6925 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
6927 if (it
->vpos
== to_vpos
)
6933 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
6937 /* TO_VPOS >= 0 means stop at TO_X in the line at
6938 TO_VPOS, or at TO_POS, whichever comes first. */
6939 if (it
->vpos
== to_vpos
)
6945 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
6947 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
6952 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
6954 /* We have reached TO_X but not in the line we want. */
6955 skip
= move_it_in_display_line_to (it
, to_charpos
,
6957 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6965 else if (op
& MOVE_TO_Y
)
6967 struct it it_backup
;
6969 /* TO_Y specified means stop at TO_X in the line containing
6970 TO_Y---or at TO_CHARPOS if this is reached first. The
6971 problem is that we can't really tell whether the line
6972 contains TO_Y before we have completely scanned it, and
6973 this may skip past TO_X. What we do is to first scan to
6976 If TO_X is not specified, use a TO_X of zero. The reason
6977 is to make the outcome of this function more predictable.
6978 If we didn't use TO_X == 0, we would stop at the end of
6979 the line which is probably not what a caller would expect
6981 skip
= move_it_in_display_line_to (it
, to_charpos
,
6985 | (op
& MOVE_TO_POS
)));
6987 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
6988 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6994 /* If TO_X was reached, we would like to know whether TO_Y
6995 is in the line. This can only be said if we know the
6996 total line height which requires us to scan the rest of
6998 if (skip
== MOVE_X_REACHED
)
7000 /* Wait! We can conclude that TO_Y is in the line if
7001 the already scanned glyphs make the line tall enough
7002 because further scanning doesn't make it shorter. */
7003 line_height
= it
->max_ascent
+ it
->max_descent
;
7004 if (to_y
>= it
->current_y
7005 && to_y
< it
->current_y
+ line_height
)
7011 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7012 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7014 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7017 /* Now, decide whether TO_Y is in this line. */
7018 line_height
= it
->max_ascent
+ it
->max_descent
;
7019 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7021 if (to_y
>= it
->current_y
7022 && to_y
< it
->current_y
+ line_height
)
7024 if (skip
== MOVE_X_REACHED
)
7025 /* If TO_Y is in this line and TO_X was reached above,
7026 we scanned too far. We have to restore IT's settings
7027 to the ones before skipping. */
7031 else if (skip
== MOVE_X_REACHED
)
7034 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7041 else if (BUFFERP (it
->object
)
7042 && it
->method
== GET_FROM_BUFFER
7043 && IT_CHARPOS (*it
) >= to_charpos
)
7044 skip
= MOVE_POS_MATCH_OR_ZV
;
7046 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7050 case MOVE_POS_MATCH_OR_ZV
:
7054 case MOVE_NEWLINE_OR_CR
:
7055 set_iterator_to_next (it
, 1);
7056 it
->continuation_lines_width
= 0;
7059 case MOVE_LINE_TRUNCATED
:
7060 it
->continuation_lines_width
= 0;
7061 reseat_at_next_visible_line_start (it
, 0);
7062 if ((op
& MOVE_TO_POS
) != 0
7063 && IT_CHARPOS (*it
) > to_charpos
)
7070 case MOVE_LINE_CONTINUED
:
7071 /* For continued lines ending in a tab, some of the glyphs
7072 associated with the tab are displayed on the current
7073 line. Since it->current_x does not include these glyphs,
7074 we use it->last_visible_x instead. */
7075 it
->continuation_lines_width
+=
7076 (it
->c
== '\t') ? it
->last_visible_x
: it
->current_x
;
7083 /* Reset/increment for the next run. */
7084 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7085 it
->current_x
= it
->hpos
= 0;
7086 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7088 last_height
= it
->max_ascent
+ it
->max_descent
;
7089 last_max_ascent
= it
->max_ascent
;
7090 it
->max_ascent
= it
->max_descent
= 0;
7095 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7099 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7101 If DY > 0, move IT backward at least that many pixels. DY = 0
7102 means move IT backward to the preceding line start or BEGV. This
7103 function may move over more than DY pixels if IT->current_y - DY
7104 ends up in the middle of a line; in this case IT->current_y will be
7105 set to the top of the line moved to. */
7108 move_it_vertically_backward (it
, dy
)
7119 start_pos
= IT_CHARPOS (*it
);
7121 /* Estimate how many newlines we must move back. */
7122 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7124 /* Set the iterator's position that many lines back. */
7125 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7126 back_to_previous_visible_line_start (it
);
7128 /* Reseat the iterator here. When moving backward, we don't want
7129 reseat to skip forward over invisible text, set up the iterator
7130 to deliver from overlay strings at the new position etc. So,
7131 use reseat_1 here. */
7132 reseat_1 (it
, it
->current
.pos
, 1);
7134 /* We are now surely at a line start. */
7135 it
->current_x
= it
->hpos
= 0;
7136 it
->continuation_lines_width
= 0;
7138 /* Move forward and see what y-distance we moved. First move to the
7139 start of the next line so that we get its height. We need this
7140 height to be able to tell whether we reached the specified
7143 it2
.max_ascent
= it2
.max_descent
= 0;
7146 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7147 MOVE_TO_POS
| MOVE_TO_VPOS
);
7149 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7150 xassert (IT_CHARPOS (*it
) >= BEGV
);
7153 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7154 xassert (IT_CHARPOS (*it
) >= BEGV
);
7155 /* H is the actual vertical distance from the position in *IT
7156 and the starting position. */
7157 h
= it2
.current_y
- it
->current_y
;
7158 /* NLINES is the distance in number of lines. */
7159 nlines
= it2
.vpos
- it
->vpos
;
7161 /* Correct IT's y and vpos position
7162 so that they are relative to the starting point. */
7168 /* DY == 0 means move to the start of the screen line. The
7169 value of nlines is > 0 if continuation lines were involved. */
7171 move_it_by_lines (it
, nlines
, 1);
7173 /* I think this assert is bogus if buffer contains
7174 invisible text or images. KFS. */
7175 xassert (IT_CHARPOS (*it
) <= start_pos
);
7180 /* The y-position we try to reach, relative to *IT.
7181 Note that H has been subtracted in front of the if-statement. */
7182 int target_y
= it
->current_y
+ h
- dy
;
7183 int y0
= it3
.current_y
;
7184 int y1
= line_bottom_y (&it3
);
7185 int line_height
= y1
- y0
;
7187 /* If we did not reach target_y, try to move further backward if
7188 we can. If we moved too far backward, try to move forward. */
7189 if (target_y
< it
->current_y
7190 /* This is heuristic. In a window that's 3 lines high, with
7191 a line height of 13 pixels each, recentering with point
7192 on the bottom line will try to move -39/2 = 19 pixels
7193 backward. Try to avoid moving into the first line. */
7194 && (it
->current_y
- target_y
7195 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7196 && IT_CHARPOS (*it
) > BEGV
)
7198 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7199 target_y
- it
->current_y
));
7200 dy
= it
->current_y
- target_y
;
7201 goto move_further_back
;
7203 else if (target_y
>= it
->current_y
+ line_height
7204 && IT_CHARPOS (*it
) < ZV
)
7206 /* Should move forward by at least one line, maybe more.
7208 Note: Calling move_it_by_lines can be expensive on
7209 terminal frames, where compute_motion is used (via
7210 vmotion) to do the job, when there are very long lines
7211 and truncate-lines is nil. That's the reason for
7212 treating terminal frames specially here. */
7214 if (!FRAME_WINDOW_P (it
->f
))
7215 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7220 move_it_by_lines (it
, 1, 1);
7222 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7226 /* I think this assert is bogus if buffer contains
7227 invisible text or images. KFS. */
7228 xassert (IT_CHARPOS (*it
) >= BEGV
);
7235 /* Move IT by a specified amount of pixel lines DY. DY negative means
7236 move backwards. DY = 0 means move to start of screen line. At the
7237 end, IT will be on the start of a screen line. */
7240 move_it_vertically (it
, dy
)
7245 move_it_vertically_backward (it
, -dy
);
7248 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7249 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7250 MOVE_TO_POS
| MOVE_TO_Y
);
7251 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7253 /* If buffer ends in ZV without a newline, move to the start of
7254 the line to satisfy the post-condition. */
7255 if (IT_CHARPOS (*it
) == ZV
7257 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7258 move_it_by_lines (it
, 0, 0);
7263 /* Move iterator IT past the end of the text line it is in. */
7266 move_it_past_eol (it
)
7269 enum move_it_result rc
;
7271 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7272 if (rc
== MOVE_NEWLINE_OR_CR
)
7273 set_iterator_to_next (it
, 0);
7277 #if 0 /* Currently not used. */
7279 /* Return non-zero if some text between buffer positions START_CHARPOS
7280 and END_CHARPOS is invisible. IT->window is the window for text
7284 invisible_text_between_p (it
, start_charpos
, end_charpos
)
7286 int start_charpos
, end_charpos
;
7288 Lisp_Object prop
, limit
;
7289 int invisible_found_p
;
7291 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
7293 /* Is text at START invisible? */
7294 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
7296 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
7297 invisible_found_p
= 1;
7300 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
7302 make_number (end_charpos
));
7303 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
7306 return invisible_found_p
;
7312 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7313 negative means move up. DVPOS == 0 means move to the start of the
7314 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7315 NEED_Y_P is zero, IT->current_y will be left unchanged.
7317 Further optimization ideas: If we would know that IT->f doesn't use
7318 a face with proportional font, we could be faster for
7319 truncate-lines nil. */
7322 move_it_by_lines (it
, dvpos
, need_y_p
)
7324 int dvpos
, need_y_p
;
7326 struct position pos
;
7328 /* The commented-out optimization uses vmotion on terminals. This
7329 gives bad results, because elements like it->what, on which
7330 callers such as pos_visible_p rely, aren't updated. */
7331 /* if (!FRAME_WINDOW_P (it->f))
7333 struct text_pos textpos;
7335 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7336 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7337 reseat (it, textpos, 1);
7338 it->vpos += pos.vpos;
7339 it->current_y += pos.vpos;
7345 /* DVPOS == 0 means move to the start of the screen line. */
7346 move_it_vertically_backward (it
, 0);
7347 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7348 /* Let next call to line_bottom_y calculate real line height */
7353 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7354 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7355 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7360 int start_charpos
, i
;
7362 /* Start at the beginning of the screen line containing IT's
7363 position. This may actually move vertically backwards,
7364 in case of overlays, so adjust dvpos accordingly. */
7366 move_it_vertically_backward (it
, 0);
7369 /* Go back -DVPOS visible lines and reseat the iterator there. */
7370 start_charpos
= IT_CHARPOS (*it
);
7371 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7372 back_to_previous_visible_line_start (it
);
7373 reseat (it
, it
->current
.pos
, 1);
7375 /* Move further back if we end up in a string or an image. */
7376 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7378 /* First try to move to start of display line. */
7380 move_it_vertically_backward (it
, 0);
7382 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7384 /* If start of line is still in string or image,
7385 move further back. */
7386 back_to_previous_visible_line_start (it
);
7387 reseat (it
, it
->current
.pos
, 1);
7391 it
->current_x
= it
->hpos
= 0;
7393 /* Above call may have moved too far if continuation lines
7394 are involved. Scan forward and see if it did. */
7396 it2
.vpos
= it2
.current_y
= 0;
7397 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7398 it
->vpos
-= it2
.vpos
;
7399 it
->current_y
-= it2
.current_y
;
7400 it
->current_x
= it
->hpos
= 0;
7402 /* If we moved too far back, move IT some lines forward. */
7403 if (it2
.vpos
> -dvpos
)
7405 int delta
= it2
.vpos
+ dvpos
;
7407 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7408 /* Move back again if we got too far ahead. */
7409 if (IT_CHARPOS (*it
) >= start_charpos
)
7415 /* Return 1 if IT points into the middle of a display vector. */
7418 in_display_vector_p (it
)
7421 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7422 && it
->current
.dpvec_index
> 0
7423 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7427 /***********************************************************************
7429 ***********************************************************************/
7432 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7436 add_to_log (format
, arg1
, arg2
)
7438 Lisp_Object arg1
, arg2
;
7440 Lisp_Object args
[3];
7441 Lisp_Object msg
, fmt
;
7444 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7447 /* Do nothing if called asynchronously. Inserting text into
7448 a buffer may call after-change-functions and alike and
7449 that would means running Lisp asynchronously. */
7450 if (handling_signal
)
7454 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7456 args
[0] = fmt
= build_string (format
);
7459 msg
= Fformat (3, args
);
7461 len
= SBYTES (msg
) + 1;
7462 SAFE_ALLOCA (buffer
, char *, len
);
7463 bcopy (SDATA (msg
), buffer
, len
);
7465 message_dolog (buffer
, len
- 1, 1, 0);
7472 /* Output a newline in the *Messages* buffer if "needs" one. */
7475 message_log_maybe_newline ()
7477 if (message_log_need_newline
)
7478 message_dolog ("", 0, 1, 0);
7482 /* Add a string M of length NBYTES to the message log, optionally
7483 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7484 nonzero, means interpret the contents of M as multibyte. This
7485 function calls low-level routines in order to bypass text property
7486 hooks, etc. which might not be safe to run.
7488 This may GC (insert may run before/after change hooks),
7489 so the buffer M must NOT point to a Lisp string. */
7492 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7494 int nbytes
, nlflag
, multibyte
;
7496 if (!NILP (Vmemory_full
))
7499 if (!NILP (Vmessage_log_max
))
7501 struct buffer
*oldbuf
;
7502 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7503 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7504 int point_at_end
= 0;
7506 Lisp_Object old_deactivate_mark
, tem
;
7507 struct gcpro gcpro1
;
7509 old_deactivate_mark
= Vdeactivate_mark
;
7510 oldbuf
= current_buffer
;
7511 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7512 current_buffer
->undo_list
= Qt
;
7514 oldpoint
= message_dolog_marker1
;
7515 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7516 oldbegv
= message_dolog_marker2
;
7517 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7518 oldzv
= message_dolog_marker3
;
7519 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7520 GCPRO1 (old_deactivate_mark
);
7528 BEGV_BYTE
= BEG_BYTE
;
7531 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7533 /* Insert the string--maybe converting multibyte to single byte
7534 or vice versa, so that all the text fits the buffer. */
7536 && NILP (current_buffer
->enable_multibyte_characters
))
7538 int i
, c
, char_bytes
;
7539 unsigned char work
[1];
7541 /* Convert a multibyte string to single-byte
7542 for the *Message* buffer. */
7543 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7545 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7546 work
[0] = (ASCII_CHAR_P (c
)
7548 : multibyte_char_to_unibyte (c
, Qnil
));
7549 insert_1_both (work
, 1, 1, 1, 0, 0);
7552 else if (! multibyte
7553 && ! NILP (current_buffer
->enable_multibyte_characters
))
7555 int i
, c
, char_bytes
;
7556 unsigned char *msg
= (unsigned char *) m
;
7557 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7558 /* Convert a single-byte string to multibyte
7559 for the *Message* buffer. */
7560 for (i
= 0; i
< nbytes
; i
++)
7563 c
= unibyte_char_to_multibyte (c
);
7564 char_bytes
= CHAR_STRING (c
, str
);
7565 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7569 insert_1 (m
, nbytes
, 1, 0, 0);
7573 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7574 insert_1 ("\n", 1, 1, 0, 0);
7576 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7578 this_bol_byte
= PT_BYTE
;
7580 /* See if this line duplicates the previous one.
7581 If so, combine duplicates. */
7584 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7586 prev_bol_byte
= PT_BYTE
;
7588 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7589 this_bol
, this_bol_byte
);
7592 del_range_both (prev_bol
, prev_bol_byte
,
7593 this_bol
, this_bol_byte
, 0);
7599 /* If you change this format, don't forget to also
7600 change message_log_check_duplicate. */
7601 sprintf (dupstr
, " [%d times]", dup
);
7602 duplen
= strlen (dupstr
);
7603 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7604 insert_1 (dupstr
, duplen
, 1, 0, 1);
7609 /* If we have more than the desired maximum number of lines
7610 in the *Messages* buffer now, delete the oldest ones.
7611 This is safe because we don't have undo in this buffer. */
7613 if (NATNUMP (Vmessage_log_max
))
7615 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7616 -XFASTINT (Vmessage_log_max
) - 1, 0);
7617 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7620 BEGV
= XMARKER (oldbegv
)->charpos
;
7621 BEGV_BYTE
= marker_byte_position (oldbegv
);
7630 ZV
= XMARKER (oldzv
)->charpos
;
7631 ZV_BYTE
= marker_byte_position (oldzv
);
7635 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7637 /* We can't do Fgoto_char (oldpoint) because it will run some
7639 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7640 XMARKER (oldpoint
)->bytepos
);
7643 unchain_marker (XMARKER (oldpoint
));
7644 unchain_marker (XMARKER (oldbegv
));
7645 unchain_marker (XMARKER (oldzv
));
7647 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7648 set_buffer_internal (oldbuf
);
7650 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7651 message_log_need_newline
= !nlflag
;
7652 Vdeactivate_mark
= old_deactivate_mark
;
7657 /* We are at the end of the buffer after just having inserted a newline.
7658 (Note: We depend on the fact we won't be crossing the gap.)
7659 Check to see if the most recent message looks a lot like the previous one.
7660 Return 0 if different, 1 if the new one should just replace it, or a
7661 value N > 1 if we should also append " [N times]". */
7664 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7665 int prev_bol
, this_bol
;
7666 int prev_bol_byte
, this_bol_byte
;
7669 int len
= Z_BYTE
- 1 - this_bol_byte
;
7671 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7672 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7674 for (i
= 0; i
< len
; i
++)
7676 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7684 if (*p1
++ == ' ' && *p1
++ == '[')
7687 while (*p1
>= '0' && *p1
<= '9')
7688 n
= n
* 10 + *p1
++ - '0';
7689 if (strncmp (p1
, " times]\n", 8) == 0)
7696 /* Display an echo area message M with a specified length of NBYTES
7697 bytes. The string may include null characters. If M is 0, clear
7698 out any existing message, and let the mini-buffer text show
7701 This may GC, so the buffer M must NOT point to a Lisp string. */
7704 message2 (m
, nbytes
, multibyte
)
7709 /* First flush out any partial line written with print. */
7710 message_log_maybe_newline ();
7712 message_dolog (m
, nbytes
, 1, multibyte
);
7713 message2_nolog (m
, nbytes
, multibyte
);
7717 /* The non-logging counterpart of message2. */
7720 message2_nolog (m
, nbytes
, multibyte
)
7722 int nbytes
, multibyte
;
7724 struct frame
*sf
= SELECTED_FRAME ();
7725 message_enable_multibyte
= multibyte
;
7729 if (noninteractive_need_newline
)
7730 putc ('\n', stderr
);
7731 noninteractive_need_newline
= 0;
7733 fwrite (m
, nbytes
, 1, stderr
);
7734 if (cursor_in_echo_area
== 0)
7735 fprintf (stderr
, "\n");
7738 /* A null message buffer means that the frame hasn't really been
7739 initialized yet. Error messages get reported properly by
7740 cmd_error, so this must be just an informative message; toss it. */
7741 else if (INTERACTIVE
7742 && sf
->glyphs_initialized_p
7743 && FRAME_MESSAGE_BUF (sf
))
7745 Lisp_Object mini_window
;
7748 /* Get the frame containing the mini-buffer
7749 that the selected frame is using. */
7750 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7751 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7753 FRAME_SAMPLE_VISIBILITY (f
);
7754 if (FRAME_VISIBLE_P (sf
)
7755 && ! FRAME_VISIBLE_P (f
))
7756 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7760 set_message (m
, Qnil
, nbytes
, multibyte
);
7761 if (minibuffer_auto_raise
)
7762 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7765 clear_message (1, 1);
7767 do_pending_window_change (0);
7768 echo_area_display (1);
7769 do_pending_window_change (0);
7770 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7771 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7776 /* Display an echo area message M with a specified length of NBYTES
7777 bytes. The string may include null characters. If M is not a
7778 string, clear out any existing message, and let the mini-buffer
7781 This function cancels echoing. */
7784 message3 (m
, nbytes
, multibyte
)
7789 struct gcpro gcpro1
;
7792 clear_message (1,1);
7795 /* First flush out any partial line written with print. */
7796 message_log_maybe_newline ();
7802 SAFE_ALLOCA (buffer
, char *, nbytes
);
7803 bcopy (SDATA (m
), buffer
, nbytes
);
7804 message_dolog (buffer
, nbytes
, 1, multibyte
);
7807 message3_nolog (m
, nbytes
, multibyte
);
7813 /* The non-logging version of message3.
7814 This does not cancel echoing, because it is used for echoing.
7815 Perhaps we need to make a separate function for echoing
7816 and make this cancel echoing. */
7819 message3_nolog (m
, nbytes
, multibyte
)
7821 int nbytes
, multibyte
;
7823 struct frame
*sf
= SELECTED_FRAME ();
7824 message_enable_multibyte
= multibyte
;
7828 if (noninteractive_need_newline
)
7829 putc ('\n', stderr
);
7830 noninteractive_need_newline
= 0;
7832 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7833 if (cursor_in_echo_area
== 0)
7834 fprintf (stderr
, "\n");
7837 /* A null message buffer means that the frame hasn't really been
7838 initialized yet. Error messages get reported properly by
7839 cmd_error, so this must be just an informative message; toss it. */
7840 else if (INTERACTIVE
7841 && sf
->glyphs_initialized_p
7842 && FRAME_MESSAGE_BUF (sf
))
7844 Lisp_Object mini_window
;
7848 /* Get the frame containing the mini-buffer
7849 that the selected frame is using. */
7850 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7851 frame
= XWINDOW (mini_window
)->frame
;
7854 FRAME_SAMPLE_VISIBILITY (f
);
7855 if (FRAME_VISIBLE_P (sf
)
7856 && !FRAME_VISIBLE_P (f
))
7857 Fmake_frame_visible (frame
);
7859 if (STRINGP (m
) && SCHARS (m
) > 0)
7861 set_message (NULL
, m
, nbytes
, multibyte
);
7862 if (minibuffer_auto_raise
)
7863 Fraise_frame (frame
);
7864 /* Assume we are not echoing.
7865 (If we are, echo_now will override this.) */
7866 echo_message_buffer
= Qnil
;
7869 clear_message (1, 1);
7871 do_pending_window_change (0);
7872 echo_area_display (1);
7873 do_pending_window_change (0);
7874 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7875 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7880 /* Display a null-terminated echo area message M. If M is 0, clear
7881 out any existing message, and let the mini-buffer text show through.
7883 The buffer M must continue to exist until after the echo area gets
7884 cleared or some other message gets displayed there. Do not pass
7885 text that is stored in a Lisp string. Do not pass text in a buffer
7886 that was alloca'd. */
7892 message2 (m
, (m
? strlen (m
) : 0), 0);
7896 /* The non-logging counterpart of message1. */
7902 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
7905 /* Display a message M which contains a single %s
7906 which gets replaced with STRING. */
7909 message_with_string (m
, string
, log
)
7914 CHECK_STRING (string
);
7920 if (noninteractive_need_newline
)
7921 putc ('\n', stderr
);
7922 noninteractive_need_newline
= 0;
7923 fprintf (stderr
, m
, SDATA (string
));
7924 if (cursor_in_echo_area
== 0)
7925 fprintf (stderr
, "\n");
7929 else if (INTERACTIVE
)
7931 /* The frame whose minibuffer we're going to display the message on.
7932 It may be larger than the selected frame, so we need
7933 to use its buffer, not the selected frame's buffer. */
7934 Lisp_Object mini_window
;
7935 struct frame
*f
, *sf
= SELECTED_FRAME ();
7937 /* Get the frame containing the minibuffer
7938 that the selected frame is using. */
7939 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7940 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7942 /* A null message buffer means that the frame hasn't really been
7943 initialized yet. Error messages get reported properly by
7944 cmd_error, so this must be just an informative message; toss it. */
7945 if (FRAME_MESSAGE_BUF (f
))
7947 Lisp_Object args
[2], message
;
7948 struct gcpro gcpro1
, gcpro2
;
7950 args
[0] = build_string (m
);
7951 args
[1] = message
= string
;
7952 GCPRO2 (args
[0], message
);
7955 message
= Fformat (2, args
);
7958 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7960 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7964 /* Print should start at the beginning of the message
7965 buffer next time. */
7966 message_buf_print
= 0;
7972 /* Dump an informative message to the minibuf. If M is 0, clear out
7973 any existing message, and let the mini-buffer text show through. */
7977 message (m
, a1
, a2
, a3
)
7979 EMACS_INT a1
, a2
, a3
;
7985 if (noninteractive_need_newline
)
7986 putc ('\n', stderr
);
7987 noninteractive_need_newline
= 0;
7988 fprintf (stderr
, m
, a1
, a2
, a3
);
7989 if (cursor_in_echo_area
== 0)
7990 fprintf (stderr
, "\n");
7994 else if (INTERACTIVE
)
7996 /* The frame whose mini-buffer we're going to display the message
7997 on. It may be larger than the selected frame, so we need to
7998 use its buffer, not the selected frame's buffer. */
7999 Lisp_Object mini_window
;
8000 struct frame
*f
, *sf
= SELECTED_FRAME ();
8002 /* Get the frame containing the mini-buffer
8003 that the selected frame is using. */
8004 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8005 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8007 /* A null message buffer means that the frame hasn't really been
8008 initialized yet. Error messages get reported properly by
8009 cmd_error, so this must be just an informative message; toss
8011 if (FRAME_MESSAGE_BUF (f
))
8022 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8023 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8025 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8026 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8028 #endif /* NO_ARG_ARRAY */
8030 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8035 /* Print should start at the beginning of the message
8036 buffer next time. */
8037 message_buf_print
= 0;
8043 /* The non-logging version of message. */
8046 message_nolog (m
, a1
, a2
, a3
)
8048 EMACS_INT a1
, a2
, a3
;
8050 Lisp_Object old_log_max
;
8051 old_log_max
= Vmessage_log_max
;
8052 Vmessage_log_max
= Qnil
;
8053 message (m
, a1
, a2
, a3
);
8054 Vmessage_log_max
= old_log_max
;
8058 /* Display the current message in the current mini-buffer. This is
8059 only called from error handlers in process.c, and is not time
8065 if (!NILP (echo_area_buffer
[0]))
8068 string
= Fcurrent_message ();
8069 message3 (string
, SBYTES (string
),
8070 !NILP (current_buffer
->enable_multibyte_characters
));
8075 /* Make sure echo area buffers in `echo_buffers' are live.
8076 If they aren't, make new ones. */
8079 ensure_echo_area_buffers ()
8083 for (i
= 0; i
< 2; ++i
)
8084 if (!BUFFERP (echo_buffer
[i
])
8085 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8088 Lisp_Object old_buffer
;
8091 old_buffer
= echo_buffer
[i
];
8092 sprintf (name
, " *Echo Area %d*", i
);
8093 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8094 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8096 for (j
= 0; j
< 2; ++j
)
8097 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8098 echo_area_buffer
[j
] = echo_buffer
[i
];
8103 /* Call FN with args A1..A4 with either the current or last displayed
8104 echo_area_buffer as current buffer.
8106 WHICH zero means use the current message buffer
8107 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8108 from echo_buffer[] and clear it.
8110 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8111 suitable buffer from echo_buffer[] and clear it.
8113 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8114 that the current message becomes the last displayed one, make
8115 choose a suitable buffer for echo_area_buffer[0], and clear it.
8117 Value is what FN returns. */
8120 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8123 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8129 int this_one
, the_other
, clear_buffer_p
, rc
;
8130 int count
= SPECPDL_INDEX ();
8132 /* If buffers aren't live, make new ones. */
8133 ensure_echo_area_buffers ();
8138 this_one
= 0, the_other
= 1;
8140 this_one
= 1, the_other
= 0;
8143 this_one
= 0, the_other
= 1;
8146 /* We need a fresh one in case the current echo buffer equals
8147 the one containing the last displayed echo area message. */
8148 if (!NILP (echo_area_buffer
[this_one
])
8149 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8150 echo_area_buffer
[this_one
] = Qnil
;
8153 /* Choose a suitable buffer from echo_buffer[] is we don't
8155 if (NILP (echo_area_buffer
[this_one
]))
8157 echo_area_buffer
[this_one
]
8158 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8159 ? echo_buffer
[the_other
]
8160 : echo_buffer
[this_one
]);
8164 buffer
= echo_area_buffer
[this_one
];
8166 /* Don't get confused by reusing the buffer used for echoing
8167 for a different purpose. */
8168 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8171 record_unwind_protect (unwind_with_echo_area_buffer
,
8172 with_echo_area_buffer_unwind_data (w
));
8174 /* Make the echo area buffer current. Note that for display
8175 purposes, it is not necessary that the displayed window's buffer
8176 == current_buffer, except for text property lookup. So, let's
8177 only set that buffer temporarily here without doing a full
8178 Fset_window_buffer. We must also change w->pointm, though,
8179 because otherwise an assertions in unshow_buffer fails, and Emacs
8181 set_buffer_internal_1 (XBUFFER (buffer
));
8185 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8188 current_buffer
->undo_list
= Qt
;
8189 current_buffer
->read_only
= Qnil
;
8190 specbind (Qinhibit_read_only
, Qt
);
8191 specbind (Qinhibit_modification_hooks
, Qt
);
8193 if (clear_buffer_p
&& Z
> BEG
)
8196 xassert (BEGV
>= BEG
);
8197 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8199 rc
= fn (a1
, a2
, a3
, a4
);
8201 xassert (BEGV
>= BEG
);
8202 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8204 unbind_to (count
, Qnil
);
8209 /* Save state that should be preserved around the call to the function
8210 FN called in with_echo_area_buffer. */
8213 with_echo_area_buffer_unwind_data (w
)
8219 /* Reduce consing by keeping one vector in
8220 Vwith_echo_area_save_vector. */
8221 vector
= Vwith_echo_area_save_vector
;
8222 Vwith_echo_area_save_vector
= Qnil
;
8225 vector
= Fmake_vector (make_number (7), Qnil
);
8227 XSETBUFFER (AREF (vector
, i
), current_buffer
); ++i
;
8228 AREF (vector
, i
) = Vdeactivate_mark
, ++i
;
8229 AREF (vector
, i
) = make_number (windows_or_buffers_changed
), ++i
;
8233 XSETWINDOW (AREF (vector
, i
), w
); ++i
;
8234 AREF (vector
, i
) = w
->buffer
; ++i
;
8235 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->charpos
); ++i
;
8236 AREF (vector
, i
) = make_number (XMARKER (w
->pointm
)->bytepos
); ++i
;
8241 for (; i
< end
; ++i
)
8242 AREF (vector
, i
) = Qnil
;
8245 xassert (i
== ASIZE (vector
));
8250 /* Restore global state from VECTOR which was created by
8251 with_echo_area_buffer_unwind_data. */
8254 unwind_with_echo_area_buffer (vector
)
8257 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8258 Vdeactivate_mark
= AREF (vector
, 1);
8259 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8261 if (WINDOWP (AREF (vector
, 3)))
8264 Lisp_Object buffer
, charpos
, bytepos
;
8266 w
= XWINDOW (AREF (vector
, 3));
8267 buffer
= AREF (vector
, 4);
8268 charpos
= AREF (vector
, 5);
8269 bytepos
= AREF (vector
, 6);
8272 set_marker_both (w
->pointm
, buffer
,
8273 XFASTINT (charpos
), XFASTINT (bytepos
));
8276 Vwith_echo_area_save_vector
= vector
;
8281 /* Set up the echo area for use by print functions. MULTIBYTE_P
8282 non-zero means we will print multibyte. */
8285 setup_echo_area_for_printing (multibyte_p
)
8288 /* If we can't find an echo area any more, exit. */
8289 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8292 ensure_echo_area_buffers ();
8294 if (!message_buf_print
)
8296 /* A message has been output since the last time we printed.
8297 Choose a fresh echo area buffer. */
8298 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8299 echo_area_buffer
[0] = echo_buffer
[1];
8301 echo_area_buffer
[0] = echo_buffer
[0];
8303 /* Switch to that buffer and clear it. */
8304 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8305 current_buffer
->truncate_lines
= Qnil
;
8309 int count
= SPECPDL_INDEX ();
8310 specbind (Qinhibit_read_only
, Qt
);
8311 /* Note that undo recording is always disabled. */
8313 unbind_to (count
, Qnil
);
8315 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8317 /* Set up the buffer for the multibyteness we need. */
8319 != !NILP (current_buffer
->enable_multibyte_characters
))
8320 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8322 /* Raise the frame containing the echo area. */
8323 if (minibuffer_auto_raise
)
8325 struct frame
*sf
= SELECTED_FRAME ();
8326 Lisp_Object mini_window
;
8327 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8328 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8331 message_log_maybe_newline ();
8332 message_buf_print
= 1;
8336 if (NILP (echo_area_buffer
[0]))
8338 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8339 echo_area_buffer
[0] = echo_buffer
[1];
8341 echo_area_buffer
[0] = echo_buffer
[0];
8344 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8346 /* Someone switched buffers between print requests. */
8347 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8348 current_buffer
->truncate_lines
= Qnil
;
8354 /* Display an echo area message in window W. Value is non-zero if W's
8355 height is changed. If display_last_displayed_message_p is
8356 non-zero, display the message that was last displayed, otherwise
8357 display the current message. */
8360 display_echo_area (w
)
8363 int i
, no_message_p
, window_height_changed_p
, count
;
8365 /* Temporarily disable garbage collections while displaying the echo
8366 area. This is done because a GC can print a message itself.
8367 That message would modify the echo area buffer's contents while a
8368 redisplay of the buffer is going on, and seriously confuse
8370 count
= inhibit_garbage_collection ();
8372 /* If there is no message, we must call display_echo_area_1
8373 nevertheless because it resizes the window. But we will have to
8374 reset the echo_area_buffer in question to nil at the end because
8375 with_echo_area_buffer will sets it to an empty buffer. */
8376 i
= display_last_displayed_message_p
? 1 : 0;
8377 no_message_p
= NILP (echo_area_buffer
[i
]);
8379 window_height_changed_p
8380 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8381 display_echo_area_1
,
8382 (EMACS_INT
) w
, Qnil
, 0, 0);
8385 echo_area_buffer
[i
] = Qnil
;
8387 unbind_to (count
, Qnil
);
8388 return window_height_changed_p
;
8392 /* Helper for display_echo_area. Display the current buffer which
8393 contains the current echo area message in window W, a mini-window,
8394 a pointer to which is passed in A1. A2..A4 are currently not used.
8395 Change the height of W so that all of the message is displayed.
8396 Value is non-zero if height of W was changed. */
8399 display_echo_area_1 (a1
, a2
, a3
, a4
)
8404 struct window
*w
= (struct window
*) a1
;
8406 struct text_pos start
;
8407 int window_height_changed_p
= 0;
8409 /* Do this before displaying, so that we have a large enough glyph
8410 matrix for the display. If we can't get enough space for the
8411 whole text, display the last N lines. That works by setting w->start. */
8412 window_height_changed_p
= resize_mini_window (w
, 0);
8414 /* Use the starting position chosen by resize_mini_window. */
8415 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8418 clear_glyph_matrix (w
->desired_matrix
);
8419 XSETWINDOW (window
, w
);
8420 try_window (window
, start
, 0);
8422 return window_height_changed_p
;
8426 /* Resize the echo area window to exactly the size needed for the
8427 currently displayed message, if there is one. If a mini-buffer
8428 is active, don't shrink it. */
8431 resize_echo_area_exactly ()
8433 if (BUFFERP (echo_area_buffer
[0])
8434 && WINDOWP (echo_area_window
))
8436 struct window
*w
= XWINDOW (echo_area_window
);
8438 Lisp_Object resize_exactly
;
8440 if (minibuf_level
== 0)
8441 resize_exactly
= Qt
;
8443 resize_exactly
= Qnil
;
8445 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8446 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8449 ++windows_or_buffers_changed
;
8450 ++update_mode_lines
;
8451 redisplay_internal (0);
8457 /* Callback function for with_echo_area_buffer, when used from
8458 resize_echo_area_exactly. A1 contains a pointer to the window to
8459 resize, EXACTLY non-nil means resize the mini-window exactly to the
8460 size of the text displayed. A3 and A4 are not used. Value is what
8461 resize_mini_window returns. */
8464 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8466 Lisp_Object exactly
;
8469 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8473 /* Resize mini-window W to fit the size of its contents. EXACT:P
8474 means size the window exactly to the size needed. Otherwise, it's
8475 only enlarged until W's buffer is empty.
8477 Set W->start to the right place to begin display. If the whole
8478 contents fit, start at the beginning. Otherwise, start so as
8479 to make the end of the contents appear. This is particularly
8480 important for y-or-n-p, but seems desirable generally.
8482 Value is non-zero if the window height has been changed. */
8485 resize_mini_window (w
, exact_p
)
8489 struct frame
*f
= XFRAME (w
->frame
);
8490 int window_height_changed_p
= 0;
8492 xassert (MINI_WINDOW_P (w
));
8494 /* By default, start display at the beginning. */
8495 set_marker_both (w
->start
, w
->buffer
,
8496 BUF_BEGV (XBUFFER (w
->buffer
)),
8497 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8499 /* Don't resize windows while redisplaying a window; it would
8500 confuse redisplay functions when the size of the window they are
8501 displaying changes from under them. Such a resizing can happen,
8502 for instance, when which-func prints a long message while
8503 we are running fontification-functions. We're running these
8504 functions with safe_call which binds inhibit-redisplay to t. */
8505 if (!NILP (Vinhibit_redisplay
))
8508 /* Nil means don't try to resize. */
8509 if (NILP (Vresize_mini_windows
)
8510 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8513 if (!FRAME_MINIBUF_ONLY_P (f
))
8516 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8517 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8518 int height
, max_height
;
8519 int unit
= FRAME_LINE_HEIGHT (f
);
8520 struct text_pos start
;
8521 struct buffer
*old_current_buffer
= NULL
;
8523 if (current_buffer
!= XBUFFER (w
->buffer
))
8525 old_current_buffer
= current_buffer
;
8526 set_buffer_internal (XBUFFER (w
->buffer
));
8529 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8531 /* Compute the max. number of lines specified by the user. */
8532 if (FLOATP (Vmax_mini_window_height
))
8533 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8534 else if (INTEGERP (Vmax_mini_window_height
))
8535 max_height
= XINT (Vmax_mini_window_height
);
8537 max_height
= total_height
/ 4;
8539 /* Correct that max. height if it's bogus. */
8540 max_height
= max (1, max_height
);
8541 max_height
= min (total_height
, max_height
);
8543 /* Find out the height of the text in the window. */
8544 if (it
.truncate_lines_p
)
8549 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8550 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8551 height
= it
.current_y
+ last_height
;
8553 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8554 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8555 height
= (height
+ unit
- 1) / unit
;
8558 /* Compute a suitable window start. */
8559 if (height
> max_height
)
8561 height
= max_height
;
8562 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8563 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8564 start
= it
.current
.pos
;
8567 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8568 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8570 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8572 /* Let it grow only, until we display an empty message, in which
8573 case the window shrinks again. */
8574 if (height
> WINDOW_TOTAL_LINES (w
))
8576 int old_height
= WINDOW_TOTAL_LINES (w
);
8577 freeze_window_starts (f
, 1);
8578 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8579 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8581 else if (height
< WINDOW_TOTAL_LINES (w
)
8582 && (exact_p
|| BEGV
== ZV
))
8584 int old_height
= WINDOW_TOTAL_LINES (w
);
8585 freeze_window_starts (f
, 0);
8586 shrink_mini_window (w
);
8587 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8592 /* Always resize to exact size needed. */
8593 if (height
> WINDOW_TOTAL_LINES (w
))
8595 int old_height
= WINDOW_TOTAL_LINES (w
);
8596 freeze_window_starts (f
, 1);
8597 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8598 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8600 else if (height
< WINDOW_TOTAL_LINES (w
))
8602 int old_height
= WINDOW_TOTAL_LINES (w
);
8603 freeze_window_starts (f
, 0);
8604 shrink_mini_window (w
);
8608 freeze_window_starts (f
, 1);
8609 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8612 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8616 if (old_current_buffer
)
8617 set_buffer_internal (old_current_buffer
);
8620 return window_height_changed_p
;
8624 /* Value is the current message, a string, or nil if there is no
8632 if (NILP (echo_area_buffer
[0]))
8636 with_echo_area_buffer (0, 0, current_message_1
,
8637 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8639 echo_area_buffer
[0] = Qnil
;
8647 current_message_1 (a1
, a2
, a3
, a4
)
8652 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8655 *msg
= make_buffer_string (BEG
, Z
, 1);
8662 /* Push the current message on Vmessage_stack for later restauration
8663 by restore_message. Value is non-zero if the current message isn't
8664 empty. This is a relatively infrequent operation, so it's not
8665 worth optimizing. */
8671 msg
= current_message ();
8672 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8673 return STRINGP (msg
);
8677 /* Restore message display from the top of Vmessage_stack. */
8684 xassert (CONSP (Vmessage_stack
));
8685 msg
= XCAR (Vmessage_stack
);
8687 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8689 message3_nolog (msg
, 0, 0);
8693 /* Handler for record_unwind_protect calling pop_message. */
8696 pop_message_unwind (dummy
)
8703 /* Pop the top-most entry off Vmessage_stack. */
8708 xassert (CONSP (Vmessage_stack
));
8709 Vmessage_stack
= XCDR (Vmessage_stack
);
8713 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8714 exits. If the stack is not empty, we have a missing pop_message
8718 check_message_stack ()
8720 if (!NILP (Vmessage_stack
))
8725 /* Truncate to NCHARS what will be displayed in the echo area the next
8726 time we display it---but don't redisplay it now. */
8729 truncate_echo_area (nchars
)
8733 echo_area_buffer
[0] = Qnil
;
8734 /* A null message buffer means that the frame hasn't really been
8735 initialized yet. Error messages get reported properly by
8736 cmd_error, so this must be just an informative message; toss it. */
8737 else if (!noninteractive
8739 && !NILP (echo_area_buffer
[0]))
8741 struct frame
*sf
= SELECTED_FRAME ();
8742 if (FRAME_MESSAGE_BUF (sf
))
8743 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8748 /* Helper function for truncate_echo_area. Truncate the current
8749 message to at most NCHARS characters. */
8752 truncate_message_1 (nchars
, a2
, a3
, a4
)
8757 if (BEG
+ nchars
< Z
)
8758 del_range (BEG
+ nchars
, Z
);
8760 echo_area_buffer
[0] = Qnil
;
8765 /* Set the current message to a substring of S or STRING.
8767 If STRING is a Lisp string, set the message to the first NBYTES
8768 bytes from STRING. NBYTES zero means use the whole string. If
8769 STRING is multibyte, the message will be displayed multibyte.
8771 If S is not null, set the message to the first LEN bytes of S. LEN
8772 zero means use the whole string. MULTIBYTE_P non-zero means S is
8773 multibyte. Display the message multibyte in that case.
8775 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8776 to t before calling set_message_1 (which calls insert).
8780 set_message (s
, string
, nbytes
, multibyte_p
)
8783 int nbytes
, multibyte_p
;
8785 message_enable_multibyte
8786 = ((s
&& multibyte_p
)
8787 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8789 with_echo_area_buffer (0, -1, set_message_1
,
8790 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8791 message_buf_print
= 0;
8792 help_echo_showing_p
= 0;
8796 /* Helper function for set_message. Arguments have the same meaning
8797 as there, with A1 corresponding to S and A2 corresponding to STRING
8798 This function is called with the echo area buffer being
8802 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8805 EMACS_INT nbytes
, multibyte_p
;
8807 const char *s
= (const char *) a1
;
8808 Lisp_Object string
= a2
;
8810 /* Change multibyteness of the echo buffer appropriately. */
8811 if (message_enable_multibyte
8812 != !NILP (current_buffer
->enable_multibyte_characters
))
8813 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8815 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8817 /* Insert new message at BEG. */
8818 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8820 if (STRINGP (string
))
8825 nbytes
= SBYTES (string
);
8826 nchars
= string_byte_to_char (string
, nbytes
);
8828 /* This function takes care of single/multibyte conversion. We
8829 just have to ensure that the echo area buffer has the right
8830 setting of enable_multibyte_characters. */
8831 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
8836 nbytes
= strlen (s
);
8838 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
8840 /* Convert from multi-byte to single-byte. */
8842 unsigned char work
[1];
8844 /* Convert a multibyte string to single-byte. */
8845 for (i
= 0; i
< nbytes
; i
+= n
)
8847 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
8848 work
[0] = (ASCII_CHAR_P (c
)
8850 : multibyte_char_to_unibyte (c
, Qnil
));
8851 insert_1_both (work
, 1, 1, 1, 0, 0);
8854 else if (!multibyte_p
8855 && !NILP (current_buffer
->enable_multibyte_characters
))
8857 /* Convert from single-byte to multi-byte. */
8859 const unsigned char *msg
= (const unsigned char *) s
;
8860 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8862 /* Convert a single-byte string to multibyte. */
8863 for (i
= 0; i
< nbytes
; i
++)
8866 c
= unibyte_char_to_multibyte (c
);
8867 n
= CHAR_STRING (c
, str
);
8868 insert_1_both (str
, 1, n
, 1, 0, 0);
8872 insert_1 (s
, nbytes
, 1, 0, 0);
8879 /* Clear messages. CURRENT_P non-zero means clear the current
8880 message. LAST_DISPLAYED_P non-zero means clear the message
8884 clear_message (current_p
, last_displayed_p
)
8885 int current_p
, last_displayed_p
;
8889 echo_area_buffer
[0] = Qnil
;
8890 message_cleared_p
= 1;
8893 if (last_displayed_p
)
8894 echo_area_buffer
[1] = Qnil
;
8896 message_buf_print
= 0;
8899 /* Clear garbaged frames.
8901 This function is used where the old redisplay called
8902 redraw_garbaged_frames which in turn called redraw_frame which in
8903 turn called clear_frame. The call to clear_frame was a source of
8904 flickering. I believe a clear_frame is not necessary. It should
8905 suffice in the new redisplay to invalidate all current matrices,
8906 and ensure a complete redisplay of all windows. */
8909 clear_garbaged_frames ()
8913 Lisp_Object tail
, frame
;
8914 int changed_count
= 0;
8916 FOR_EACH_FRAME (tail
, frame
)
8918 struct frame
*f
= XFRAME (frame
);
8920 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
8924 Fredraw_frame (frame
);
8925 f
->force_flush_display_p
= 1;
8927 clear_current_matrices (f
);
8936 ++windows_or_buffers_changed
;
8941 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
8942 is non-zero update selected_frame. Value is non-zero if the
8943 mini-windows height has been changed. */
8946 echo_area_display (update_frame_p
)
8949 Lisp_Object mini_window
;
8952 int window_height_changed_p
= 0;
8953 struct frame
*sf
= SELECTED_FRAME ();
8955 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8956 w
= XWINDOW (mini_window
);
8957 f
= XFRAME (WINDOW_FRAME (w
));
8959 /* Don't display if frame is invisible or not yet initialized. */
8960 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
8963 #ifdef HAVE_WINDOW_SYSTEM
8964 /* When Emacs starts, selected_frame may be the initial terminal
8965 frame. If we let this through, a message would be displayed on
8967 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
8969 #endif /* HAVE_WINDOW_SYSTEM */
8971 /* Redraw garbaged frames. */
8973 clear_garbaged_frames ();
8975 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
8977 echo_area_window
= mini_window
;
8978 window_height_changed_p
= display_echo_area (w
);
8979 w
->must_be_updated_p
= 1;
8981 /* Update the display, unless called from redisplay_internal.
8982 Also don't update the screen during redisplay itself. The
8983 update will happen at the end of redisplay, and an update
8984 here could cause confusion. */
8985 if (update_frame_p
&& !redisplaying_p
)
8989 /* If the display update has been interrupted by pending
8990 input, update mode lines in the frame. Due to the
8991 pending input, it might have been that redisplay hasn't
8992 been called, so that mode lines above the echo area are
8993 garbaged. This looks odd, so we prevent it here. */
8994 if (!display_completed
)
8995 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
8997 if (window_height_changed_p
8998 /* Don't do this if Emacs is shutting down. Redisplay
8999 needs to run hooks. */
9000 && !NILP (Vrun_hooks
))
9002 /* Must update other windows. Likewise as in other
9003 cases, don't let this update be interrupted by
9005 int count
= SPECPDL_INDEX ();
9006 specbind (Qredisplay_dont_pause
, Qt
);
9007 windows_or_buffers_changed
= 1;
9008 redisplay_internal (0);
9009 unbind_to (count
, Qnil
);
9011 else if (FRAME_WINDOW_P (f
) && n
== 0)
9013 /* Window configuration is the same as before.
9014 Can do with a display update of the echo area,
9015 unless we displayed some mode lines. */
9016 update_single_window (w
, 1);
9017 FRAME_RIF (f
)->flush_display (f
);
9020 update_frame (f
, 1, 1);
9022 /* If cursor is in the echo area, make sure that the next
9023 redisplay displays the minibuffer, so that the cursor will
9024 be replaced with what the minibuffer wants. */
9025 if (cursor_in_echo_area
)
9026 ++windows_or_buffers_changed
;
9029 else if (!EQ (mini_window
, selected_window
))
9030 windows_or_buffers_changed
++;
9032 /* Last displayed message is now the current message. */
9033 echo_area_buffer
[1] = echo_area_buffer
[0];
9034 /* Inform read_char that we're not echoing. */
9035 echo_message_buffer
= Qnil
;
9037 /* Prevent redisplay optimization in redisplay_internal by resetting
9038 this_line_start_pos. This is done because the mini-buffer now
9039 displays the message instead of its buffer text. */
9040 if (EQ (mini_window
, selected_window
))
9041 CHARPOS (this_line_start_pos
) = 0;
9043 return window_height_changed_p
;
9048 /***********************************************************************
9049 Mode Lines and Frame Titles
9050 ***********************************************************************/
9052 /* A buffer for constructing non-propertized mode-line strings and
9053 frame titles in it; allocated from the heap in init_xdisp and
9054 resized as needed in store_mode_line_noprop_char. */
9056 static char *mode_line_noprop_buf
;
9058 /* The buffer's end, and a current output position in it. */
9060 static char *mode_line_noprop_buf_end
;
9061 static char *mode_line_noprop_ptr
;
9063 #define MODE_LINE_NOPROP_LEN(start) \
9064 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9067 MODE_LINE_DISPLAY
= 0,
9073 /* Alist that caches the results of :propertize.
9074 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9075 static Lisp_Object mode_line_proptrans_alist
;
9077 /* List of strings making up the mode-line. */
9078 static Lisp_Object mode_line_string_list
;
9080 /* Base face property when building propertized mode line string. */
9081 static Lisp_Object mode_line_string_face
;
9082 static Lisp_Object mode_line_string_face_prop
;
9085 /* Unwind data for mode line strings */
9087 static Lisp_Object Vmode_line_unwind_vector
;
9090 format_mode_line_unwind_data (obuf
, save_proptrans
)
9091 struct buffer
*obuf
;
9095 /* Reduce consing by keeping one vector in
9096 Vwith_echo_area_save_vector. */
9097 vector
= Vmode_line_unwind_vector
;
9098 Vmode_line_unwind_vector
= Qnil
;
9101 vector
= Fmake_vector (make_number (7), Qnil
);
9103 AREF (vector
, 0) = make_number (mode_line_target
);
9104 AREF (vector
, 1) = make_number (MODE_LINE_NOPROP_LEN (0));
9105 AREF (vector
, 2) = mode_line_string_list
;
9106 AREF (vector
, 3) = (save_proptrans
? mode_line_proptrans_alist
: Qt
);
9107 AREF (vector
, 4) = mode_line_string_face
;
9108 AREF (vector
, 5) = mode_line_string_face_prop
;
9111 XSETBUFFER (AREF (vector
, 6), obuf
);
9113 AREF (vector
, 6) = Qnil
;
9119 unwind_format_mode_line (vector
)
9122 mode_line_target
= XINT (AREF (vector
, 0));
9123 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9124 mode_line_string_list
= AREF (vector
, 2);
9125 if (! EQ (AREF (vector
, 3), Qt
))
9126 mode_line_proptrans_alist
= AREF (vector
, 3);
9127 mode_line_string_face
= AREF (vector
, 4);
9128 mode_line_string_face_prop
= AREF (vector
, 5);
9130 if (!NILP (AREF (vector
, 6)))
9132 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9133 AREF (vector
, 6) = Qnil
;
9136 Vmode_line_unwind_vector
= vector
;
9141 /* Store a single character C for the frame title in mode_line_noprop_buf.
9142 Re-allocate mode_line_noprop_buf if necessary. */
9146 store_mode_line_noprop_char (char c
)
9148 store_mode_line_noprop_char (c
)
9152 /* If output position has reached the end of the allocated buffer,
9153 double the buffer's size. */
9154 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9156 int len
= MODE_LINE_NOPROP_LEN (0);
9157 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9158 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9159 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9160 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9163 *mode_line_noprop_ptr
++ = c
;
9167 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9168 mode_line_noprop_ptr. STR is the string to store. Do not copy
9169 characters that yield more columns than PRECISION; PRECISION <= 0
9170 means copy the whole string. Pad with spaces until FIELD_WIDTH
9171 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9172 pad. Called from display_mode_element when it is used to build a
9176 store_mode_line_noprop (str
, field_width
, precision
)
9177 const unsigned char *str
;
9178 int field_width
, precision
;
9183 /* Copy at most PRECISION chars from STR. */
9184 nbytes
= strlen (str
);
9185 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9187 store_mode_line_noprop_char (*str
++);
9189 /* Fill up with spaces until FIELD_WIDTH reached. */
9190 while (field_width
> 0
9193 store_mode_line_noprop_char (' ');
9200 /***********************************************************************
9202 ***********************************************************************/
9204 #ifdef HAVE_WINDOW_SYSTEM
9206 /* Set the title of FRAME, if it has changed. The title format is
9207 Vicon_title_format if FRAME is iconified, otherwise it is
9208 frame_title_format. */
9211 x_consider_frame_title (frame
)
9214 struct frame
*f
= XFRAME (frame
);
9216 if (FRAME_WINDOW_P (f
)
9217 || FRAME_MINIBUF_ONLY_P (f
)
9218 || f
->explicit_name
)
9220 /* Do we have more than one visible frame on this X display? */
9227 int count
= SPECPDL_INDEX ();
9229 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9231 Lisp_Object other_frame
= XCAR (tail
);
9232 struct frame
*tf
= XFRAME (other_frame
);
9235 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9236 && !FRAME_MINIBUF_ONLY_P (tf
)
9237 && !EQ (other_frame
, tip_frame
)
9238 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9242 /* Set global variable indicating that multiple frames exist. */
9243 multiple_frames
= CONSP (tail
);
9245 /* Switch to the buffer of selected window of the frame. Set up
9246 mode_line_target so that display_mode_element will output into
9247 mode_line_noprop_buf; then display the title. */
9248 record_unwind_protect (unwind_format_mode_line
,
9249 format_mode_line_unwind_data (current_buffer
, 0));
9251 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9252 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9254 mode_line_target
= MODE_LINE_TITLE
;
9255 title_start
= MODE_LINE_NOPROP_LEN (0);
9256 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9257 NULL
, DEFAULT_FACE_ID
);
9258 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9259 len
= MODE_LINE_NOPROP_LEN (title_start
);
9260 title
= mode_line_noprop_buf
+ title_start
;
9261 unbind_to (count
, Qnil
);
9263 /* Set the title only if it's changed. This avoids consing in
9264 the common case where it hasn't. (If it turns out that we've
9265 already wasted too much time by walking through the list with
9266 display_mode_element, then we might need to optimize at a
9267 higher level than this.) */
9268 if (! STRINGP (f
->name
)
9269 || SBYTES (f
->name
) != len
9270 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9271 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9275 #endif /* not HAVE_WINDOW_SYSTEM */
9280 /***********************************************************************
9282 ***********************************************************************/
9285 /* Prepare for redisplay by updating menu-bar item lists when
9286 appropriate. This can call eval. */
9289 prepare_menu_bars ()
9292 struct gcpro gcpro1
, gcpro2
;
9294 Lisp_Object tooltip_frame
;
9296 #ifdef HAVE_WINDOW_SYSTEM
9297 tooltip_frame
= tip_frame
;
9299 tooltip_frame
= Qnil
;
9302 /* Update all frame titles based on their buffer names, etc. We do
9303 this before the menu bars so that the buffer-menu will show the
9304 up-to-date frame titles. */
9305 #ifdef HAVE_WINDOW_SYSTEM
9306 if (windows_or_buffers_changed
|| update_mode_lines
)
9308 Lisp_Object tail
, frame
;
9310 FOR_EACH_FRAME (tail
, frame
)
9313 if (!EQ (frame
, tooltip_frame
)
9314 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9315 x_consider_frame_title (frame
);
9318 #endif /* HAVE_WINDOW_SYSTEM */
9320 /* Update the menu bar item lists, if appropriate. This has to be
9321 done before any actual redisplay or generation of display lines. */
9322 all_windows
= (update_mode_lines
9323 || buffer_shared
> 1
9324 || windows_or_buffers_changed
);
9327 Lisp_Object tail
, frame
;
9328 int count
= SPECPDL_INDEX ();
9329 /* 1 means that update_menu_bar has run its hooks
9330 so any further calls to update_menu_bar shouldn't do so again. */
9331 int menu_bar_hooks_run
= 0;
9333 record_unwind_save_match_data ();
9335 FOR_EACH_FRAME (tail
, frame
)
9339 /* Ignore tooltip frame. */
9340 if (EQ (frame
, tooltip_frame
))
9343 /* If a window on this frame changed size, report that to
9344 the user and clear the size-change flag. */
9345 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9347 Lisp_Object functions
;
9349 /* Clear flag first in case we get an error below. */
9350 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9351 functions
= Vwindow_size_change_functions
;
9352 GCPRO2 (tail
, functions
);
9354 while (CONSP (functions
))
9356 call1 (XCAR (functions
), frame
);
9357 functions
= XCDR (functions
);
9363 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9364 #ifdef HAVE_WINDOW_SYSTEM
9365 update_tool_bar (f
, 0);
9367 mac_update_title_bar (f
, 0);
9373 unbind_to (count
, Qnil
);
9377 struct frame
*sf
= SELECTED_FRAME ();
9378 update_menu_bar (sf
, 1, 0);
9379 #ifdef HAVE_WINDOW_SYSTEM
9380 update_tool_bar (sf
, 1);
9382 mac_update_title_bar (sf
, 1);
9387 /* Motif needs this. See comment in xmenu.c. Turn it off when
9388 pending_menu_activation is not defined. */
9389 #ifdef USE_X_TOOLKIT
9390 pending_menu_activation
= 0;
9395 /* Update the menu bar item list for frame F. This has to be done
9396 before we start to fill in any display lines, because it can call
9399 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9401 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9402 already ran the menu bar hooks for this redisplay, so there
9403 is no need to run them again. The return value is the
9404 updated value of this flag, to pass to the next call. */
9407 update_menu_bar (f
, save_match_data
, hooks_run
)
9409 int save_match_data
;
9413 register struct window
*w
;
9415 /* If called recursively during a menu update, do nothing. This can
9416 happen when, for instance, an activate-menubar-hook causes a
9418 if (inhibit_menubar_update
)
9421 window
= FRAME_SELECTED_WINDOW (f
);
9422 w
= XWINDOW (window
);
9424 #if 0 /* The if statement below this if statement used to include the
9425 condition !NILP (w->update_mode_line), rather than using
9426 update_mode_lines directly, and this if statement may have
9427 been added to make that condition work. Now the if
9428 statement below matches its comment, this isn't needed. */
9429 if (update_mode_lines
)
9430 w
->update_mode_line
= Qt
;
9433 if (FRAME_WINDOW_P (f
)
9435 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9436 || defined (USE_GTK)
9437 FRAME_EXTERNAL_MENU_BAR (f
)
9439 FRAME_MENU_BAR_LINES (f
) > 0
9441 : FRAME_MENU_BAR_LINES (f
) > 0)
9443 /* If the user has switched buffers or windows, we need to
9444 recompute to reflect the new bindings. But we'll
9445 recompute when update_mode_lines is set too; that means
9446 that people can use force-mode-line-update to request
9447 that the menu bar be recomputed. The adverse effect on
9448 the rest of the redisplay algorithm is about the same as
9449 windows_or_buffers_changed anyway. */
9450 if (windows_or_buffers_changed
9451 /* This used to test w->update_mode_line, but we believe
9452 there is no need to recompute the menu in that case. */
9453 || update_mode_lines
9454 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9455 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9456 != !NILP (w
->last_had_star
))
9457 || ((!NILP (Vtransient_mark_mode
)
9458 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9459 != !NILP (w
->region_showing
)))
9461 struct buffer
*prev
= current_buffer
;
9462 int count
= SPECPDL_INDEX ();
9464 specbind (Qinhibit_menubar_update
, Qt
);
9466 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9467 if (save_match_data
)
9468 record_unwind_save_match_data ();
9469 if (NILP (Voverriding_local_map_menu_flag
))
9471 specbind (Qoverriding_terminal_local_map
, Qnil
);
9472 specbind (Qoverriding_local_map
, Qnil
);
9477 /* Run the Lucid hook. */
9478 safe_run_hooks (Qactivate_menubar_hook
);
9480 /* If it has changed current-menubar from previous value,
9481 really recompute the menu-bar from the value. */
9482 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9483 call0 (Qrecompute_lucid_menubar
);
9485 safe_run_hooks (Qmenu_bar_update_hook
);
9490 XSETFRAME (Vmenu_updating_frame
, f
);
9491 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9493 /* Redisplay the menu bar in case we changed it. */
9494 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9495 || defined (USE_GTK)
9496 if (FRAME_WINDOW_P (f
))
9499 /* All frames on Mac OS share the same menubar. So only
9500 the selected frame should be allowed to set it. */
9501 if (f
== SELECTED_FRAME ())
9503 set_frame_menubar (f
, 0, 0);
9506 /* On a terminal screen, the menu bar is an ordinary screen
9507 line, and this makes it get updated. */
9508 w
->update_mode_line
= Qt
;
9509 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9510 /* In the non-toolkit version, the menu bar is an ordinary screen
9511 line, and this makes it get updated. */
9512 w
->update_mode_line
= Qt
;
9513 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9515 unbind_to (count
, Qnil
);
9516 set_buffer_internal_1 (prev
);
9525 /***********************************************************************
9527 ***********************************************************************/
9529 #ifdef HAVE_WINDOW_SYSTEM
9532 Nominal cursor position -- where to draw output.
9533 HPOS and VPOS are window relative glyph matrix coordinates.
9534 X and Y are window relative pixel coordinates. */
9536 struct cursor_pos output_cursor
;
9540 Set the global variable output_cursor to CURSOR. All cursor
9541 positions are relative to updated_window. */
9544 set_output_cursor (cursor
)
9545 struct cursor_pos
*cursor
;
9547 output_cursor
.hpos
= cursor
->hpos
;
9548 output_cursor
.vpos
= cursor
->vpos
;
9549 output_cursor
.x
= cursor
->x
;
9550 output_cursor
.y
= cursor
->y
;
9555 Set a nominal cursor position.
9557 HPOS and VPOS are column/row positions in a window glyph matrix. X
9558 and Y are window text area relative pixel positions.
9560 If this is done during an update, updated_window will contain the
9561 window that is being updated and the position is the future output
9562 cursor position for that window. If updated_window is null, use
9563 selected_window and display the cursor at the given position. */
9566 x_cursor_to (vpos
, hpos
, y
, x
)
9567 int vpos
, hpos
, y
, x
;
9571 /* If updated_window is not set, work on selected_window. */
9575 w
= XWINDOW (selected_window
);
9577 /* Set the output cursor. */
9578 output_cursor
.hpos
= hpos
;
9579 output_cursor
.vpos
= vpos
;
9580 output_cursor
.x
= x
;
9581 output_cursor
.y
= y
;
9583 /* If not called as part of an update, really display the cursor.
9584 This will also set the cursor position of W. */
9585 if (updated_window
== NULL
)
9588 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9589 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9590 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9595 #endif /* HAVE_WINDOW_SYSTEM */
9598 /***********************************************************************
9600 ***********************************************************************/
9602 #ifdef HAVE_WINDOW_SYSTEM
9604 /* Where the mouse was last time we reported a mouse event. */
9606 FRAME_PTR last_mouse_frame
;
9608 /* Tool-bar item index of the item on which a mouse button was pressed
9611 int last_tool_bar_item
;
9614 /* Update the tool-bar item list for frame F. This has to be done
9615 before we start to fill in any display lines. Called from
9616 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9617 and restore it here. */
9620 update_tool_bar (f
, save_match_data
)
9622 int save_match_data
;
9624 #if defined (USE_GTK) || USE_MAC_TOOLBAR
9625 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9627 int do_update
= WINDOWP (f
->tool_bar_window
)
9628 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9636 window
= FRAME_SELECTED_WINDOW (f
);
9637 w
= XWINDOW (window
);
9639 /* If the user has switched buffers or windows, we need to
9640 recompute to reflect the new bindings. But we'll
9641 recompute when update_mode_lines is set too; that means
9642 that people can use force-mode-line-update to request
9643 that the menu bar be recomputed. The adverse effect on
9644 the rest of the redisplay algorithm is about the same as
9645 windows_or_buffers_changed anyway. */
9646 if (windows_or_buffers_changed
9647 || !NILP (w
->update_mode_line
)
9648 || update_mode_lines
9649 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9650 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9651 != !NILP (w
->last_had_star
))
9652 || ((!NILP (Vtransient_mark_mode
)
9653 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9654 != !NILP (w
->region_showing
)))
9656 struct buffer
*prev
= current_buffer
;
9657 int count
= SPECPDL_INDEX ();
9658 Lisp_Object new_tool_bar
;
9660 struct gcpro gcpro1
;
9662 /* Set current_buffer to the buffer of the selected
9663 window of the frame, so that we get the right local
9665 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9667 /* Save match data, if we must. */
9668 if (save_match_data
)
9669 record_unwind_save_match_data ();
9671 /* Make sure that we don't accidentally use bogus keymaps. */
9672 if (NILP (Voverriding_local_map_menu_flag
))
9674 specbind (Qoverriding_terminal_local_map
, Qnil
);
9675 specbind (Qoverriding_local_map
, Qnil
);
9678 GCPRO1 (new_tool_bar
);
9680 /* Build desired tool-bar items from keymaps. */
9681 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9684 /* Redisplay the tool-bar if we changed it. */
9685 if (new_n_tool_bar
!= f
->n_tool_bar_items
9686 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9688 /* Redisplay that happens asynchronously due to an expose event
9689 may access f->tool_bar_items. Make sure we update both
9690 variables within BLOCK_INPUT so no such event interrupts. */
9692 f
->tool_bar_items
= new_tool_bar
;
9693 f
->n_tool_bar_items
= new_n_tool_bar
;
9694 w
->update_mode_line
= Qt
;
9700 unbind_to (count
, Qnil
);
9701 set_buffer_internal_1 (prev
);
9707 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9708 F's desired tool-bar contents. F->tool_bar_items must have
9709 been set up previously by calling prepare_menu_bars. */
9712 build_desired_tool_bar_string (f
)
9715 int i
, size
, size_needed
;
9716 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9717 Lisp_Object image
, plist
, props
;
9719 image
= plist
= props
= Qnil
;
9720 GCPRO3 (image
, plist
, props
);
9722 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9723 Otherwise, make a new string. */
9725 /* The size of the string we might be able to reuse. */
9726 size
= (STRINGP (f
->desired_tool_bar_string
)
9727 ? SCHARS (f
->desired_tool_bar_string
)
9730 /* We need one space in the string for each image. */
9731 size_needed
= f
->n_tool_bar_items
;
9733 /* Reuse f->desired_tool_bar_string, if possible. */
9734 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9735 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9739 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9740 Fremove_text_properties (make_number (0), make_number (size
),
9741 props
, f
->desired_tool_bar_string
);
9744 /* Put a `display' property on the string for the images to display,
9745 put a `menu_item' property on tool-bar items with a value that
9746 is the index of the item in F's tool-bar item vector. */
9747 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9749 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9751 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9752 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9753 int hmargin
, vmargin
, relief
, idx
, end
;
9754 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9756 /* If image is a vector, choose the image according to the
9758 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9759 if (VECTORP (image
))
9763 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9764 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9767 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9768 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9770 xassert (ASIZE (image
) >= idx
);
9771 image
= AREF (image
, idx
);
9776 /* Ignore invalid image specifications. */
9777 if (!valid_image_p (image
))
9780 /* Display the tool-bar button pressed, or depressed. */
9781 plist
= Fcopy_sequence (XCDR (image
));
9783 /* Compute margin and relief to draw. */
9784 relief
= (tool_bar_button_relief
>= 0
9785 ? tool_bar_button_relief
9786 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9787 hmargin
= vmargin
= relief
;
9789 if (INTEGERP (Vtool_bar_button_margin
)
9790 && XINT (Vtool_bar_button_margin
) > 0)
9792 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9793 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9795 else if (CONSP (Vtool_bar_button_margin
))
9797 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9798 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9799 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9801 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9802 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9803 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9806 if (auto_raise_tool_bar_buttons_p
)
9808 /* Add a `:relief' property to the image spec if the item is
9812 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
9819 /* If image is selected, display it pressed, i.e. with a
9820 negative relief. If it's not selected, display it with a
9822 plist
= Fplist_put (plist
, QCrelief
,
9824 ? make_number (-relief
)
9825 : make_number (relief
)));
9830 /* Put a margin around the image. */
9831 if (hmargin
|| vmargin
)
9833 if (hmargin
== vmargin
)
9834 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
9836 plist
= Fplist_put (plist
, QCmargin
,
9837 Fcons (make_number (hmargin
),
9838 make_number (vmargin
)));
9841 /* If button is not enabled, and we don't have special images
9842 for the disabled state, make the image appear disabled by
9843 applying an appropriate algorithm to it. */
9844 if (!enabled_p
&& idx
< 0)
9845 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
9847 /* Put a `display' text property on the string for the image to
9848 display. Put a `menu-item' property on the string that gives
9849 the start of this item's properties in the tool-bar items
9851 image
= Fcons (Qimage
, plist
);
9852 props
= list4 (Qdisplay
, image
,
9853 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
9855 /* Let the last image hide all remaining spaces in the tool bar
9856 string. The string can be longer than needed when we reuse a
9858 if (i
+ 1 == f
->n_tool_bar_items
)
9859 end
= SCHARS (f
->desired_tool_bar_string
);
9862 Fadd_text_properties (make_number (i
), make_number (end
),
9863 props
, f
->desired_tool_bar_string
);
9871 /* Display one line of the tool-bar of frame IT->f.
9873 HEIGHT specifies the desired height of the tool-bar line.
9874 If the actual height of the glyph row is less than HEIGHT, the
9875 row's height is increased to HEIGHT, and the icons are centered
9876 vertically in the new height.
9878 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
9879 count a final empty row in case the tool-bar width exactly matches
9884 display_tool_bar_line (it
, height
)
9888 struct glyph_row
*row
= it
->glyph_row
;
9889 int max_x
= it
->last_visible_x
;
9892 prepare_desired_row (row
);
9893 row
->y
= it
->current_y
;
9895 /* Note that this isn't made use of if the face hasn't a box,
9896 so there's no need to check the face here. */
9897 it
->start_of_box_run_p
= 1;
9899 while (it
->current_x
< max_x
)
9901 int x
, n_glyphs_before
, i
, nglyphs
;
9902 struct it it_before
;
9904 /* Get the next display element. */
9905 if (!get_next_display_element (it
))
9907 /* Don't count empty row if we are counting needed tool-bar lines. */
9908 if (height
< 0 && !it
->hpos
)
9913 /* Produce glyphs. */
9914 n_glyphs_before
= row
->used
[TEXT_AREA
];
9917 PRODUCE_GLYPHS (it
);
9919 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
9921 x
= it_before
.current_x
;
9924 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
9926 if (x
+ glyph
->pixel_width
> max_x
)
9928 /* Glyph doesn't fit on line. Backtrack. */
9929 row
->used
[TEXT_AREA
] = n_glyphs_before
;
9931 /* If this is the only glyph on this line, it will never fit on the
9932 toolbar, so skip it. But ensure there is at least one glyph,
9933 so we don't accidentally disable the tool-bar. */
9934 if (n_glyphs_before
== 0
9935 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
9941 x
+= glyph
->pixel_width
;
9945 /* Stop at line ends. */
9946 if (ITERATOR_AT_END_OF_LINE_P (it
))
9949 set_iterator_to_next (it
, 1);
9954 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
9956 /* Use default face for the border below the tool bar.
9958 FIXME: When auto-resize-tool-bars is grow-only, there is
9959 no additional border below the possibly empty tool-bar lines.
9960 So to make the extra empty lines look "normal", we have to
9961 use the tool-bar face for the border too. */
9962 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
9963 it
->face_id
= DEFAULT_FACE_ID
;
9965 extend_face_to_end_of_line (it
);
9966 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
9967 last
->right_box_line_p
= 1;
9968 if (last
== row
->glyphs
[TEXT_AREA
])
9969 last
->left_box_line_p
= 1;
9971 /* Make line the desired height and center it vertically. */
9972 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
9974 /* Don't add more than one line height. */
9975 height
%= FRAME_LINE_HEIGHT (it
->f
);
9976 it
->max_ascent
+= height
/ 2;
9977 it
->max_descent
+= (height
+ 1) / 2;
9980 compute_line_metrics (it
);
9982 /* If line is empty, make it occupy the rest of the tool-bar. */
9983 if (!row
->displays_text_p
)
9985 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
9986 row
->visible_height
= row
->height
;
9987 row
->ascent
= row
->phys_ascent
= 0;
9988 row
->extra_line_spacing
= 0;
9991 row
->full_width_p
= 1;
9992 row
->continued_p
= 0;
9993 row
->truncated_on_left_p
= 0;
9994 row
->truncated_on_right_p
= 0;
9996 it
->current_x
= it
->hpos
= 0;
9997 it
->current_y
+= row
->height
;
10003 /* Max tool-bar height. */
10005 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10006 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10008 /* Value is the number of screen lines needed to make all tool-bar
10009 items of frame F visible. The number of actual rows needed is
10010 returned in *N_ROWS if non-NULL. */
10013 tool_bar_lines_needed (f
, n_rows
)
10017 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10019 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10020 the desired matrix, so use (unused) mode-line row as temporary row to
10021 avoid destroying the first tool-bar row. */
10022 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10024 /* Initialize an iterator for iteration over
10025 F->desired_tool_bar_string in the tool-bar window of frame F. */
10026 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10027 it
.first_visible_x
= 0;
10028 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10029 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10031 while (!ITERATOR_AT_END_P (&it
))
10033 clear_glyph_row (temp_row
);
10034 it
.glyph_row
= temp_row
;
10035 display_tool_bar_line (&it
, -1);
10037 clear_glyph_row (temp_row
);
10039 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10041 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10043 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10047 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10049 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10058 frame
= selected_frame
;
10060 CHECK_FRAME (frame
);
10061 f
= XFRAME (frame
);
10063 if (WINDOWP (f
->tool_bar_window
)
10064 || (w
= XWINDOW (f
->tool_bar_window
),
10065 WINDOW_TOTAL_LINES (w
) > 0))
10067 update_tool_bar (f
, 1);
10068 if (f
->n_tool_bar_items
)
10070 build_desired_tool_bar_string (f
);
10071 nlines
= tool_bar_lines_needed (f
, NULL
);
10075 return make_number (nlines
);
10079 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10080 height should be changed. */
10083 redisplay_tool_bar (f
)
10088 struct glyph_row
*row
;
10090 #if defined (USE_GTK) || USE_MAC_TOOLBAR
10091 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10092 update_frame_tool_bar (f
);
10096 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10097 do anything. This means you must start with tool-bar-lines
10098 non-zero to get the auto-sizing effect. Or in other words, you
10099 can turn off tool-bars by specifying tool-bar-lines zero. */
10100 if (!WINDOWP (f
->tool_bar_window
)
10101 || (w
= XWINDOW (f
->tool_bar_window
),
10102 WINDOW_TOTAL_LINES (w
) == 0))
10105 /* Set up an iterator for the tool-bar window. */
10106 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10107 it
.first_visible_x
= 0;
10108 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10109 row
= it
.glyph_row
;
10111 /* Build a string that represents the contents of the tool-bar. */
10112 build_desired_tool_bar_string (f
);
10113 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10115 if (f
->n_tool_bar_rows
== 0)
10119 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10120 nlines
!= WINDOW_TOTAL_LINES (w
)))
10122 extern Lisp_Object Qtool_bar_lines
;
10124 int old_height
= WINDOW_TOTAL_LINES (w
);
10126 XSETFRAME (frame
, f
);
10127 Fmodify_frame_parameters (frame
,
10128 Fcons (Fcons (Qtool_bar_lines
,
10129 make_number (nlines
)),
10131 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10133 clear_glyph_matrix (w
->desired_matrix
);
10134 fonts_changed_p
= 1;
10140 /* Display as many lines as needed to display all tool-bar items. */
10142 if (f
->n_tool_bar_rows
> 0)
10144 int border
, rows
, height
, extra
;
10146 if (INTEGERP (Vtool_bar_border
))
10147 border
= XINT (Vtool_bar_border
);
10148 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10149 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10150 else if (EQ (Vtool_bar_border
, Qborder_width
))
10151 border
= f
->border_width
;
10157 rows
= f
->n_tool_bar_rows
;
10158 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10159 extra
= it
.last_visible_y
- border
- height
* rows
;
10161 while (it
.current_y
< it
.last_visible_y
)
10164 if (extra
> 0 && rows
-- > 0)
10166 h
= (extra
+ rows
- 1) / rows
;
10169 display_tool_bar_line (&it
, height
+ h
);
10174 while (it
.current_y
< it
.last_visible_y
)
10175 display_tool_bar_line (&it
, 0);
10178 /* It doesn't make much sense to try scrolling in the tool-bar
10179 window, so don't do it. */
10180 w
->desired_matrix
->no_scrolling_p
= 1;
10181 w
->must_be_updated_p
= 1;
10183 if (!NILP (Vauto_resize_tool_bars
))
10185 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10186 int change_height_p
= 0;
10188 /* If we couldn't display everything, change the tool-bar's
10189 height if there is room for more. */
10190 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10191 && it
.current_y
< max_tool_bar_height
)
10192 change_height_p
= 1;
10194 row
= it
.glyph_row
- 1;
10196 /* If there are blank lines at the end, except for a partially
10197 visible blank line at the end that is smaller than
10198 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10199 if (!row
->displays_text_p
10200 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10201 change_height_p
= 1;
10203 /* If row displays tool-bar items, but is partially visible,
10204 change the tool-bar's height. */
10205 if (row
->displays_text_p
10206 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10207 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10208 change_height_p
= 1;
10210 /* Resize windows as needed by changing the `tool-bar-lines'
10211 frame parameter. */
10212 if (change_height_p
)
10214 extern Lisp_Object Qtool_bar_lines
;
10216 int old_height
= WINDOW_TOTAL_LINES (w
);
10218 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10220 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10221 && !f
->minimize_tool_bar_window_p
)
10222 ? (nlines
> old_height
)
10223 : (nlines
!= old_height
));
10224 f
->minimize_tool_bar_window_p
= 0;
10226 if (change_height_p
)
10228 XSETFRAME (frame
, f
);
10229 Fmodify_frame_parameters (frame
,
10230 Fcons (Fcons (Qtool_bar_lines
,
10231 make_number (nlines
)),
10233 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10235 clear_glyph_matrix (w
->desired_matrix
);
10236 f
->n_tool_bar_rows
= nrows
;
10237 fonts_changed_p
= 1;
10244 f
->minimize_tool_bar_window_p
= 0;
10249 /* Get information about the tool-bar item which is displayed in GLYPH
10250 on frame F. Return in *PROP_IDX the index where tool-bar item
10251 properties start in F->tool_bar_items. Value is zero if
10252 GLYPH doesn't display a tool-bar item. */
10255 tool_bar_item_info (f
, glyph
, prop_idx
)
10257 struct glyph
*glyph
;
10264 /* This function can be called asynchronously, which means we must
10265 exclude any possibility that Fget_text_property signals an
10267 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10268 charpos
= max (0, charpos
);
10270 /* Get the text property `menu-item' at pos. The value of that
10271 property is the start index of this item's properties in
10272 F->tool_bar_items. */
10273 prop
= Fget_text_property (make_number (charpos
),
10274 Qmenu_item
, f
->current_tool_bar_string
);
10275 if (INTEGERP (prop
))
10277 *prop_idx
= XINT (prop
);
10287 /* Get information about the tool-bar item at position X/Y on frame F.
10288 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10289 the current matrix of the tool-bar window of F, or NULL if not
10290 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10291 item in F->tool_bar_items. Value is
10293 -1 if X/Y is not on a tool-bar item
10294 0 if X/Y is on the same item that was highlighted before.
10298 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10301 struct glyph
**glyph
;
10302 int *hpos
, *vpos
, *prop_idx
;
10304 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10305 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10308 /* Find the glyph under X/Y. */
10309 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10310 if (*glyph
== NULL
)
10313 /* Get the start of this tool-bar item's properties in
10314 f->tool_bar_items. */
10315 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10318 /* Is mouse on the highlighted item? */
10319 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10320 && *vpos
>= dpyinfo
->mouse_face_beg_row
10321 && *vpos
<= dpyinfo
->mouse_face_end_row
10322 && (*vpos
> dpyinfo
->mouse_face_beg_row
10323 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10324 && (*vpos
< dpyinfo
->mouse_face_end_row
10325 || *hpos
< dpyinfo
->mouse_face_end_col
10326 || dpyinfo
->mouse_face_past_end
))
10334 Handle mouse button event on the tool-bar of frame F, at
10335 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10336 0 for button release. MODIFIERS is event modifiers for button
10340 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10343 unsigned int modifiers
;
10345 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10346 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10347 int hpos
, vpos
, prop_idx
;
10348 struct glyph
*glyph
;
10349 Lisp_Object enabled_p
;
10351 /* If not on the highlighted tool-bar item, return. */
10352 frame_to_window_pixel_xy (w
, &x
, &y
);
10353 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10356 /* If item is disabled, do nothing. */
10357 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10358 if (NILP (enabled_p
))
10363 /* Show item in pressed state. */
10364 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10365 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10366 last_tool_bar_item
= prop_idx
;
10370 Lisp_Object key
, frame
;
10371 struct input_event event
;
10372 EVENT_INIT (event
);
10374 /* Show item in released state. */
10375 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10376 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10378 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10380 XSETFRAME (frame
, f
);
10381 event
.kind
= TOOL_BAR_EVENT
;
10382 event
.frame_or_window
= frame
;
10384 kbd_buffer_store_event (&event
);
10386 event
.kind
= TOOL_BAR_EVENT
;
10387 event
.frame_or_window
= frame
;
10389 event
.modifiers
= modifiers
;
10390 kbd_buffer_store_event (&event
);
10391 last_tool_bar_item
= -1;
10396 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10397 tool-bar window-relative coordinates X/Y. Called from
10398 note_mouse_highlight. */
10401 note_tool_bar_highlight (f
, x
, y
)
10405 Lisp_Object window
= f
->tool_bar_window
;
10406 struct window
*w
= XWINDOW (window
);
10407 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10409 struct glyph
*glyph
;
10410 struct glyph_row
*row
;
10412 Lisp_Object enabled_p
;
10414 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10415 int mouse_down_p
, rc
;
10417 /* Function note_mouse_highlight is called with negative x(y
10418 values when mouse moves outside of the frame. */
10419 if (x
<= 0 || y
<= 0)
10421 clear_mouse_face (dpyinfo
);
10425 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10428 /* Not on tool-bar item. */
10429 clear_mouse_face (dpyinfo
);
10433 /* On same tool-bar item as before. */
10434 goto set_help_echo
;
10436 clear_mouse_face (dpyinfo
);
10438 /* Mouse is down, but on different tool-bar item? */
10439 mouse_down_p
= (dpyinfo
->grabbed
10440 && f
== last_mouse_frame
10441 && FRAME_LIVE_P (f
));
10443 && last_tool_bar_item
!= prop_idx
)
10446 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10447 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10449 /* If tool-bar item is not enabled, don't highlight it. */
10450 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10451 if (!NILP (enabled_p
))
10453 /* Compute the x-position of the glyph. In front and past the
10454 image is a space. We include this in the highlighted area. */
10455 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10456 for (i
= x
= 0; i
< hpos
; ++i
)
10457 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10459 /* Record this as the current active region. */
10460 dpyinfo
->mouse_face_beg_col
= hpos
;
10461 dpyinfo
->mouse_face_beg_row
= vpos
;
10462 dpyinfo
->mouse_face_beg_x
= x
;
10463 dpyinfo
->mouse_face_beg_y
= row
->y
;
10464 dpyinfo
->mouse_face_past_end
= 0;
10466 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10467 dpyinfo
->mouse_face_end_row
= vpos
;
10468 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10469 dpyinfo
->mouse_face_end_y
= row
->y
;
10470 dpyinfo
->mouse_face_window
= window
;
10471 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10473 /* Display it as active. */
10474 show_mouse_face (dpyinfo
, draw
);
10475 dpyinfo
->mouse_face_image_state
= draw
;
10480 /* Set help_echo_string to a help string to display for this tool-bar item.
10481 XTread_socket does the rest. */
10482 help_echo_object
= help_echo_window
= Qnil
;
10483 help_echo_pos
= -1;
10484 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10485 if (NILP (help_echo_string
))
10486 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10489 #endif /* HAVE_WINDOW_SYSTEM */
10493 /************************************************************************
10494 Horizontal scrolling
10495 ************************************************************************/
10497 static int hscroll_window_tree
P_ ((Lisp_Object
));
10498 static int hscroll_windows
P_ ((Lisp_Object
));
10500 /* For all leaf windows in the window tree rooted at WINDOW, set their
10501 hscroll value so that PT is (i) visible in the window, and (ii) so
10502 that it is not within a certain margin at the window's left and
10503 right border. Value is non-zero if any window's hscroll has been
10507 hscroll_window_tree (window
)
10508 Lisp_Object window
;
10510 int hscrolled_p
= 0;
10511 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10512 int hscroll_step_abs
= 0;
10513 double hscroll_step_rel
= 0;
10515 if (hscroll_relative_p
)
10517 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10518 if (hscroll_step_rel
< 0)
10520 hscroll_relative_p
= 0;
10521 hscroll_step_abs
= 0;
10524 else if (INTEGERP (Vhscroll_step
))
10526 hscroll_step_abs
= XINT (Vhscroll_step
);
10527 if (hscroll_step_abs
< 0)
10528 hscroll_step_abs
= 0;
10531 hscroll_step_abs
= 0;
10533 while (WINDOWP (window
))
10535 struct window
*w
= XWINDOW (window
);
10537 if (WINDOWP (w
->hchild
))
10538 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10539 else if (WINDOWP (w
->vchild
))
10540 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10541 else if (w
->cursor
.vpos
>= 0)
10544 int text_area_width
;
10545 struct glyph_row
*current_cursor_row
10546 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10547 struct glyph_row
*desired_cursor_row
10548 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10549 struct glyph_row
*cursor_row
10550 = (desired_cursor_row
->enabled_p
10551 ? desired_cursor_row
10552 : current_cursor_row
);
10554 text_area_width
= window_box_width (w
, TEXT_AREA
);
10556 /* Scroll when cursor is inside this scroll margin. */
10557 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10559 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10560 && ((XFASTINT (w
->hscroll
)
10561 && w
->cursor
.x
<= h_margin
)
10562 || (cursor_row
->enabled_p
10563 && cursor_row
->truncated_on_right_p
10564 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10568 struct buffer
*saved_current_buffer
;
10572 /* Find point in a display of infinite width. */
10573 saved_current_buffer
= current_buffer
;
10574 current_buffer
= XBUFFER (w
->buffer
);
10576 if (w
== XWINDOW (selected_window
))
10577 pt
= BUF_PT (current_buffer
);
10580 pt
= marker_position (w
->pointm
);
10581 pt
= max (BEGV
, pt
);
10585 /* Move iterator to pt starting at cursor_row->start in
10586 a line with infinite width. */
10587 init_to_row_start (&it
, w
, cursor_row
);
10588 it
.last_visible_x
= INFINITY
;
10589 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10590 current_buffer
= saved_current_buffer
;
10592 /* Position cursor in window. */
10593 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10594 hscroll
= max (0, (it
.current_x
10595 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10596 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10597 : (text_area_width
/ 2))))
10598 / FRAME_COLUMN_WIDTH (it
.f
);
10599 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10601 if (hscroll_relative_p
)
10602 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10605 wanted_x
= text_area_width
10606 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10609 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10613 if (hscroll_relative_p
)
10614 wanted_x
= text_area_width
* hscroll_step_rel
10617 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10620 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10622 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10624 /* Don't call Fset_window_hscroll if value hasn't
10625 changed because it will prevent redisplay
10627 if (XFASTINT (w
->hscroll
) != hscroll
)
10629 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10630 w
->hscroll
= make_number (hscroll
);
10639 /* Value is non-zero if hscroll of any leaf window has been changed. */
10640 return hscrolled_p
;
10644 /* Set hscroll so that cursor is visible and not inside horizontal
10645 scroll margins for all windows in the tree rooted at WINDOW. See
10646 also hscroll_window_tree above. Value is non-zero if any window's
10647 hscroll has been changed. If it has, desired matrices on the frame
10648 of WINDOW are cleared. */
10651 hscroll_windows (window
)
10652 Lisp_Object window
;
10654 int hscrolled_p
= hscroll_window_tree (window
);
10656 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10657 return hscrolled_p
;
10662 /************************************************************************
10664 ************************************************************************/
10666 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10667 to a non-zero value. This is sometimes handy to have in a debugger
10672 /* First and last unchanged row for try_window_id. */
10674 int debug_first_unchanged_at_end_vpos
;
10675 int debug_last_unchanged_at_beg_vpos
;
10677 /* Delta vpos and y. */
10679 int debug_dvpos
, debug_dy
;
10681 /* Delta in characters and bytes for try_window_id. */
10683 int debug_delta
, debug_delta_bytes
;
10685 /* Values of window_end_pos and window_end_vpos at the end of
10688 EMACS_INT debug_end_pos
, debug_end_vpos
;
10690 /* Append a string to W->desired_matrix->method. FMT is a printf
10691 format string. A1...A9 are a supplement for a variable-length
10692 argument list. If trace_redisplay_p is non-zero also printf the
10693 resulting string to stderr. */
10696 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10699 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10702 char *method
= w
->desired_matrix
->method
;
10703 int len
= strlen (method
);
10704 int size
= sizeof w
->desired_matrix
->method
;
10705 int remaining
= size
- len
- 1;
10707 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10708 if (len
&& remaining
)
10711 --remaining
, ++len
;
10714 strncpy (method
+ len
, buffer
, remaining
);
10716 if (trace_redisplay_p
)
10717 fprintf (stderr
, "%p (%s): %s\n",
10719 ((BUFFERP (w
->buffer
)
10720 && STRINGP (XBUFFER (w
->buffer
)->name
))
10721 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10726 #endif /* GLYPH_DEBUG */
10729 /* Value is non-zero if all changes in window W, which displays
10730 current_buffer, are in the text between START and END. START is a
10731 buffer position, END is given as a distance from Z. Used in
10732 redisplay_internal for display optimization. */
10735 text_outside_line_unchanged_p (w
, start
, end
)
10739 int unchanged_p
= 1;
10741 /* If text or overlays have changed, see where. */
10742 if (XFASTINT (w
->last_modified
) < MODIFF
10743 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10745 /* Gap in the line? */
10746 if (GPT
< start
|| Z
- GPT
< end
)
10749 /* Changes start in front of the line, or end after it? */
10751 && (BEG_UNCHANGED
< start
- 1
10752 || END_UNCHANGED
< end
))
10755 /* If selective display, can't optimize if changes start at the
10756 beginning of the line. */
10758 && INTEGERP (current_buffer
->selective_display
)
10759 && XINT (current_buffer
->selective_display
) > 0
10760 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10763 /* If there are overlays at the start or end of the line, these
10764 may have overlay strings with newlines in them. A change at
10765 START, for instance, may actually concern the display of such
10766 overlay strings as well, and they are displayed on different
10767 lines. So, quickly rule out this case. (For the future, it
10768 might be desirable to implement something more telling than
10769 just BEG/END_UNCHANGED.) */
10772 if (BEG
+ BEG_UNCHANGED
== start
10773 && overlay_touches_p (start
))
10775 if (END_UNCHANGED
== end
10776 && overlay_touches_p (Z
- end
))
10781 return unchanged_p
;
10785 /* Do a frame update, taking possible shortcuts into account. This is
10786 the main external entry point for redisplay.
10788 If the last redisplay displayed an echo area message and that message
10789 is no longer requested, we clear the echo area or bring back the
10790 mini-buffer if that is in use. */
10795 redisplay_internal (0);
10800 overlay_arrow_string_or_property (var
)
10805 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10808 return Voverlay_arrow_string
;
10811 /* Return 1 if there are any overlay-arrows in current_buffer. */
10813 overlay_arrow_in_current_buffer_p ()
10817 for (vlist
= Voverlay_arrow_variable_list
;
10819 vlist
= XCDR (vlist
))
10821 Lisp_Object var
= XCAR (vlist
);
10824 if (!SYMBOLP (var
))
10826 val
= find_symbol_value (var
);
10828 && current_buffer
== XMARKER (val
)->buffer
)
10835 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
10839 overlay_arrows_changed_p ()
10843 for (vlist
= Voverlay_arrow_variable_list
;
10845 vlist
= XCDR (vlist
))
10847 Lisp_Object var
= XCAR (vlist
);
10848 Lisp_Object val
, pstr
;
10850 if (!SYMBOLP (var
))
10852 val
= find_symbol_value (var
);
10853 if (!MARKERP (val
))
10855 if (! EQ (COERCE_MARKER (val
),
10856 Fget (var
, Qlast_arrow_position
))
10857 || ! (pstr
= overlay_arrow_string_or_property (var
),
10858 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
10864 /* Mark overlay arrows to be updated on next redisplay. */
10867 update_overlay_arrows (up_to_date
)
10872 for (vlist
= Voverlay_arrow_variable_list
;
10874 vlist
= XCDR (vlist
))
10876 Lisp_Object var
= XCAR (vlist
);
10878 if (!SYMBOLP (var
))
10881 if (up_to_date
> 0)
10883 Lisp_Object val
= find_symbol_value (var
);
10884 Fput (var
, Qlast_arrow_position
,
10885 COERCE_MARKER (val
));
10886 Fput (var
, Qlast_arrow_string
,
10887 overlay_arrow_string_or_property (var
));
10889 else if (up_to_date
< 0
10890 || !NILP (Fget (var
, Qlast_arrow_position
)))
10892 Fput (var
, Qlast_arrow_position
, Qt
);
10893 Fput (var
, Qlast_arrow_string
, Qt
);
10899 /* Return overlay arrow string to display at row.
10900 Return integer (bitmap number) for arrow bitmap in left fringe.
10901 Return nil if no overlay arrow. */
10904 overlay_arrow_at_row (it
, row
)
10906 struct glyph_row
*row
;
10910 for (vlist
= Voverlay_arrow_variable_list
;
10912 vlist
= XCDR (vlist
))
10914 Lisp_Object var
= XCAR (vlist
);
10917 if (!SYMBOLP (var
))
10920 val
= find_symbol_value (var
);
10923 && current_buffer
== XMARKER (val
)->buffer
10924 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
10926 if (FRAME_WINDOW_P (it
->f
)
10927 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
10929 #ifdef HAVE_WINDOW_SYSTEM
10930 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
10933 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
10934 return make_number (fringe_bitmap
);
10937 return make_number (-1); /* Use default arrow bitmap */
10939 return overlay_arrow_string_or_property (var
);
10946 /* Return 1 if point moved out of or into a composition. Otherwise
10947 return 0. PREV_BUF and PREV_PT are the last point buffer and
10948 position. BUF and PT are the current point buffer and position. */
10951 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
10952 struct buffer
*prev_buf
, *buf
;
10955 EMACS_INT start
, end
;
10957 Lisp_Object buffer
;
10959 XSETBUFFER (buffer
, buf
);
10960 /* Check a composition at the last point if point moved within the
10962 if (prev_buf
== buf
)
10965 /* Point didn't move. */
10968 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
10969 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
10970 && COMPOSITION_VALID_P (start
, end
, prop
)
10971 && start
< prev_pt
&& end
> prev_pt
)
10972 /* The last point was within the composition. Return 1 iff
10973 point moved out of the composition. */
10974 return (pt
<= start
|| pt
>= end
);
10977 /* Check a composition at the current point. */
10978 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
10979 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
10980 && COMPOSITION_VALID_P (start
, end
, prop
)
10981 && start
< pt
&& end
> pt
);
10985 /* Reconsider the setting of B->clip_changed which is displayed
10989 reconsider_clip_changes (w
, b
)
10993 if (b
->clip_changed
10994 && !NILP (w
->window_end_valid
)
10995 && w
->current_matrix
->buffer
== b
10996 && w
->current_matrix
->zv
== BUF_ZV (b
)
10997 && w
->current_matrix
->begv
== BUF_BEGV (b
))
10998 b
->clip_changed
= 0;
11000 /* If display wasn't paused, and W is not a tool bar window, see if
11001 point has been moved into or out of a composition. In that case,
11002 we set b->clip_changed to 1 to force updating the screen. If
11003 b->clip_changed has already been set to 1, we can skip this
11005 if (!b
->clip_changed
11006 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11010 if (w
== XWINDOW (selected_window
))
11011 pt
= BUF_PT (current_buffer
);
11013 pt
= marker_position (w
->pointm
);
11015 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11016 || pt
!= XINT (w
->last_point
))
11017 && check_point_in_composition (w
->current_matrix
->buffer
,
11018 XINT (w
->last_point
),
11019 XBUFFER (w
->buffer
), pt
))
11020 b
->clip_changed
= 1;
11025 /* Select FRAME to forward the values of frame-local variables into C
11026 variables so that the redisplay routines can access those values
11030 select_frame_for_redisplay (frame
)
11033 Lisp_Object tail
, sym
, val
;
11034 Lisp_Object old
= selected_frame
;
11036 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11038 selected_frame
= frame
;
11040 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11041 if (CONSP (XCAR (tail
))
11042 && (sym
= XCAR (XCAR (tail
)),
11044 && (sym
= indirect_variable (sym
),
11045 val
= SYMBOL_VALUE (sym
),
11046 (BUFFER_LOCAL_VALUEP (val
)))
11047 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11048 /* Use find_symbol_value rather than Fsymbol_value
11049 to avoid an error if it is void. */
11050 find_symbol_value (sym
);
11052 for (tail
= XFRAME (old
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11053 if (CONSP (XCAR (tail
))
11054 && (sym
= XCAR (XCAR (tail
)),
11056 && (sym
= indirect_variable (sym
),
11057 val
= SYMBOL_VALUE (sym
),
11058 (BUFFER_LOCAL_VALUEP (val
)))
11059 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11060 find_symbol_value (sym
);
11064 #define STOP_POLLING \
11065 do { if (! polling_stopped_here) stop_polling (); \
11066 polling_stopped_here = 1; } while (0)
11068 #define RESUME_POLLING \
11069 do { if (polling_stopped_here) start_polling (); \
11070 polling_stopped_here = 0; } while (0)
11073 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11074 response to any user action; therefore, we should preserve the echo
11075 area. (Actually, our caller does that job.) Perhaps in the future
11076 avoid recentering windows if it is not necessary; currently that
11077 causes some problems. */
11080 redisplay_internal (preserve_echo_area
)
11081 int preserve_echo_area
;
11083 struct window
*w
= XWINDOW (selected_window
);
11086 int must_finish
= 0;
11087 struct text_pos tlbufpos
, tlendpos
;
11088 int number_of_visible_frames
;
11091 int polling_stopped_here
= 0;
11092 Lisp_Object old_frame
= selected_frame
;
11094 /* Non-zero means redisplay has to consider all windows on all
11095 frames. Zero means, only selected_window is considered. */
11096 int consider_all_windows_p
;
11098 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11100 /* No redisplay if running in batch mode or frame is not yet fully
11101 initialized, or redisplay is explicitly turned off by setting
11102 Vinhibit_redisplay. */
11104 || !NILP (Vinhibit_redisplay
))
11107 /* Don't examine these until after testing Vinhibit_redisplay.
11108 When Emacs is shutting down, perhaps because its connection to
11109 X has dropped, we should not look at them at all. */
11110 f
= XFRAME (w
->frame
);
11111 sf
= SELECTED_FRAME ();
11113 if (!f
->glyphs_initialized_p
)
11116 /* The flag redisplay_performed_directly_p is set by
11117 direct_output_for_insert when it already did the whole screen
11118 update necessary. */
11119 if (redisplay_performed_directly_p
)
11121 redisplay_performed_directly_p
= 0;
11122 if (!hscroll_windows (selected_window
))
11126 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
11127 if (popup_activated ())
11131 /* I don't think this happens but let's be paranoid. */
11132 if (redisplaying_p
)
11135 /* Record a function that resets redisplaying_p to its old value
11136 when we leave this function. */
11137 count
= SPECPDL_INDEX ();
11138 record_unwind_protect (unwind_redisplay
,
11139 Fcons (make_number (redisplaying_p
), selected_frame
));
11141 specbind (Qinhibit_free_realized_faces
, Qnil
);
11144 Lisp_Object tail
, frame
;
11146 FOR_EACH_FRAME (tail
, frame
)
11148 struct frame
*f
= XFRAME (frame
);
11149 f
->already_hscrolled_p
= 0;
11154 if (!EQ (old_frame
, selected_frame
)
11155 && FRAME_LIVE_P (XFRAME (old_frame
)))
11156 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11157 selected_frame and selected_window to be temporarily out-of-sync so
11158 when we come back here via `goto retry', we need to resync because we
11159 may need to run Elisp code (via prepare_menu_bars). */
11160 select_frame_for_redisplay (old_frame
);
11163 reconsider_clip_changes (w
, current_buffer
);
11164 last_escape_glyph_frame
= NULL
;
11165 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11167 /* If new fonts have been loaded that make a glyph matrix adjustment
11168 necessary, do it. */
11169 if (fonts_changed_p
)
11171 adjust_glyphs (NULL
);
11172 ++windows_or_buffers_changed
;
11173 fonts_changed_p
= 0;
11176 /* If face_change_count is non-zero, init_iterator will free all
11177 realized faces, which includes the faces referenced from current
11178 matrices. So, we can't reuse current matrices in this case. */
11179 if (face_change_count
)
11180 ++windows_or_buffers_changed
;
11182 if (FRAME_TERMCAP_P (sf
)
11183 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11185 /* Since frames on a single ASCII terminal share the same
11186 display area, displaying a different frame means redisplay
11187 the whole thing. */
11188 windows_or_buffers_changed
++;
11189 SET_FRAME_GARBAGED (sf
);
11190 FRAME_TTY (sf
)->previous_frame
= sf
;
11193 /* Set the visible flags for all frames. Do this before checking
11194 for resized or garbaged frames; they want to know if their frames
11195 are visible. See the comment in frame.h for
11196 FRAME_SAMPLE_VISIBILITY. */
11198 Lisp_Object tail
, frame
;
11200 number_of_visible_frames
= 0;
11202 FOR_EACH_FRAME (tail
, frame
)
11204 struct frame
*f
= XFRAME (frame
);
11206 FRAME_SAMPLE_VISIBILITY (f
);
11207 if (FRAME_VISIBLE_P (f
))
11208 ++number_of_visible_frames
;
11209 clear_desired_matrices (f
);
11214 /* Notice any pending interrupt request to change frame size. */
11215 do_pending_window_change (1);
11217 /* Clear frames marked as garbaged. */
11218 if (frame_garbaged
)
11219 clear_garbaged_frames ();
11221 /* Build menubar and tool-bar items. */
11222 if (NILP (Vmemory_full
))
11223 prepare_menu_bars ();
11225 if (windows_or_buffers_changed
)
11226 update_mode_lines
++;
11228 /* Detect case that we need to write or remove a star in the mode line. */
11229 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11231 w
->update_mode_line
= Qt
;
11232 if (buffer_shared
> 1)
11233 update_mode_lines
++;
11236 /* Avoid invocation of point motion hooks by `current_column' below. */
11237 count1
= SPECPDL_INDEX ();
11238 specbind (Qinhibit_point_motion_hooks
, Qt
);
11240 /* If %c is in the mode line, update it if needed. */
11241 if (!NILP (w
->column_number_displayed
)
11242 /* This alternative quickly identifies a common case
11243 where no change is needed. */
11244 && !(PT
== XFASTINT (w
->last_point
)
11245 && XFASTINT (w
->last_modified
) >= MODIFF
11246 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11247 && (XFASTINT (w
->column_number_displayed
)
11248 != (int) current_column ())) /* iftc */
11249 w
->update_mode_line
= Qt
;
11251 unbind_to (count1
, Qnil
);
11253 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11255 /* The variable buffer_shared is set in redisplay_window and
11256 indicates that we redisplay a buffer in different windows. See
11258 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11259 || cursor_type_changed
);
11261 /* If specs for an arrow have changed, do thorough redisplay
11262 to ensure we remove any arrow that should no longer exist. */
11263 if (overlay_arrows_changed_p ())
11264 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11266 /* Normally the message* functions will have already displayed and
11267 updated the echo area, but the frame may have been trashed, or
11268 the update may have been preempted, so display the echo area
11269 again here. Checking message_cleared_p captures the case that
11270 the echo area should be cleared. */
11271 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11272 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11273 || (message_cleared_p
11274 && minibuf_level
== 0
11275 /* If the mini-window is currently selected, this means the
11276 echo-area doesn't show through. */
11277 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11279 int window_height_changed_p
= echo_area_display (0);
11282 /* If we don't display the current message, don't clear the
11283 message_cleared_p flag, because, if we did, we wouldn't clear
11284 the echo area in the next redisplay which doesn't preserve
11286 if (!display_last_displayed_message_p
)
11287 message_cleared_p
= 0;
11289 if (fonts_changed_p
)
11291 else if (window_height_changed_p
)
11293 consider_all_windows_p
= 1;
11294 ++update_mode_lines
;
11295 ++windows_or_buffers_changed
;
11297 /* If window configuration was changed, frames may have been
11298 marked garbaged. Clear them or we will experience
11299 surprises wrt scrolling. */
11300 if (frame_garbaged
)
11301 clear_garbaged_frames ();
11304 else if (EQ (selected_window
, minibuf_window
)
11305 && (current_buffer
->clip_changed
11306 || XFASTINT (w
->last_modified
) < MODIFF
11307 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11308 && resize_mini_window (w
, 0))
11310 /* Resized active mini-window to fit the size of what it is
11311 showing if its contents might have changed. */
11313 consider_all_windows_p
= 1;
11314 ++windows_or_buffers_changed
;
11315 ++update_mode_lines
;
11317 /* If window configuration was changed, frames may have been
11318 marked garbaged. Clear them or we will experience
11319 surprises wrt scrolling. */
11320 if (frame_garbaged
)
11321 clear_garbaged_frames ();
11325 /* If showing the region, and mark has changed, we must redisplay
11326 the whole window. The assignment to this_line_start_pos prevents
11327 the optimization directly below this if-statement. */
11328 if (((!NILP (Vtransient_mark_mode
)
11329 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11330 != !NILP (w
->region_showing
))
11331 || (!NILP (w
->region_showing
)
11332 && !EQ (w
->region_showing
,
11333 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11334 CHARPOS (this_line_start_pos
) = 0;
11336 /* Optimize the case that only the line containing the cursor in the
11337 selected window has changed. Variables starting with this_ are
11338 set in display_line and record information about the line
11339 containing the cursor. */
11340 tlbufpos
= this_line_start_pos
;
11341 tlendpos
= this_line_end_pos
;
11342 if (!consider_all_windows_p
11343 && CHARPOS (tlbufpos
) > 0
11344 && NILP (w
->update_mode_line
)
11345 && !current_buffer
->clip_changed
11346 && !current_buffer
->prevent_redisplay_optimizations_p
11347 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11348 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11349 /* Make sure recorded data applies to current buffer, etc. */
11350 && this_line_buffer
== current_buffer
11351 && current_buffer
== XBUFFER (w
->buffer
)
11352 && NILP (w
->force_start
)
11353 && NILP (w
->optional_new_start
)
11354 /* Point must be on the line that we have info recorded about. */
11355 && PT
>= CHARPOS (tlbufpos
)
11356 && PT
<= Z
- CHARPOS (tlendpos
)
11357 /* All text outside that line, including its final newline,
11358 must be unchanged */
11359 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11360 CHARPOS (tlendpos
)))
11362 if (CHARPOS (tlbufpos
) > BEGV
11363 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11364 && (CHARPOS (tlbufpos
) == ZV
11365 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11366 /* Former continuation line has disappeared by becoming empty */
11368 else if (XFASTINT (w
->last_modified
) < MODIFF
11369 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11370 || MINI_WINDOW_P (w
))
11372 /* We have to handle the case of continuation around a
11373 wide-column character (See the comment in indent.c around
11376 For instance, in the following case:
11378 -------- Insert --------
11379 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11380 J_I_ ==> J_I_ `^^' are cursors.
11384 As we have to redraw the line above, we should goto cancel. */
11387 int line_height_before
= this_line_pixel_height
;
11389 /* Note that start_display will handle the case that the
11390 line starting at tlbufpos is a continuation lines. */
11391 start_display (&it
, w
, tlbufpos
);
11393 /* Implementation note: It this still necessary? */
11394 if (it
.current_x
!= this_line_start_x
)
11397 TRACE ((stderr
, "trying display optimization 1\n"));
11398 w
->cursor
.vpos
= -1;
11399 overlay_arrow_seen
= 0;
11400 it
.vpos
= this_line_vpos
;
11401 it
.current_y
= this_line_y
;
11402 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11403 display_line (&it
);
11405 /* If line contains point, is not continued,
11406 and ends at same distance from eob as before, we win */
11407 if (w
->cursor
.vpos
>= 0
11408 /* Line is not continued, otherwise this_line_start_pos
11409 would have been set to 0 in display_line. */
11410 && CHARPOS (this_line_start_pos
)
11411 /* Line ends as before. */
11412 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11413 /* Line has same height as before. Otherwise other lines
11414 would have to be shifted up or down. */
11415 && this_line_pixel_height
== line_height_before
)
11417 /* If this is not the window's last line, we must adjust
11418 the charstarts of the lines below. */
11419 if (it
.current_y
< it
.last_visible_y
)
11421 struct glyph_row
*row
11422 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11423 int delta
, delta_bytes
;
11425 if (Z
- CHARPOS (tlendpos
) == ZV
)
11427 /* This line ends at end of (accessible part of)
11428 buffer. There is no newline to count. */
11430 - CHARPOS (tlendpos
)
11431 - MATRIX_ROW_START_CHARPOS (row
));
11432 delta_bytes
= (Z_BYTE
11433 - BYTEPOS (tlendpos
)
11434 - MATRIX_ROW_START_BYTEPOS (row
));
11438 /* This line ends in a newline. Must take
11439 account of the newline and the rest of the
11440 text that follows. */
11442 - CHARPOS (tlendpos
)
11443 - MATRIX_ROW_START_CHARPOS (row
));
11444 delta_bytes
= (Z_BYTE
11445 - BYTEPOS (tlendpos
)
11446 - MATRIX_ROW_START_BYTEPOS (row
));
11449 increment_matrix_positions (w
->current_matrix
,
11450 this_line_vpos
+ 1,
11451 w
->current_matrix
->nrows
,
11452 delta
, delta_bytes
);
11455 /* If this row displays text now but previously didn't,
11456 or vice versa, w->window_end_vpos may have to be
11458 if ((it
.glyph_row
- 1)->displays_text_p
)
11460 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11461 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11463 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11464 && this_line_vpos
> 0)
11465 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11466 w
->window_end_valid
= Qnil
;
11468 /* Update hint: No need to try to scroll in update_window. */
11469 w
->desired_matrix
->no_scrolling_p
= 1;
11472 *w
->desired_matrix
->method
= 0;
11473 debug_method_add (w
, "optimization 1");
11475 #ifdef HAVE_WINDOW_SYSTEM
11476 update_window_fringes (w
, 0);
11483 else if (/* Cursor position hasn't changed. */
11484 PT
== XFASTINT (w
->last_point
)
11485 /* Make sure the cursor was last displayed
11486 in this window. Otherwise we have to reposition it. */
11487 && 0 <= w
->cursor
.vpos
11488 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11492 do_pending_window_change (1);
11494 /* We used to always goto end_of_redisplay here, but this
11495 isn't enough if we have a blinking cursor. */
11496 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11497 goto end_of_redisplay
;
11501 /* If highlighting the region, or if the cursor is in the echo area,
11502 then we can't just move the cursor. */
11503 else if (! (!NILP (Vtransient_mark_mode
)
11504 && !NILP (current_buffer
->mark_active
))
11505 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11506 || highlight_nonselected_windows
)
11507 && NILP (w
->region_showing
)
11508 && NILP (Vshow_trailing_whitespace
)
11509 && !cursor_in_echo_area
)
11512 struct glyph_row
*row
;
11514 /* Skip from tlbufpos to PT and see where it is. Note that
11515 PT may be in invisible text. If so, we will end at the
11516 next visible position. */
11517 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11518 NULL
, DEFAULT_FACE_ID
);
11519 it
.current_x
= this_line_start_x
;
11520 it
.current_y
= this_line_y
;
11521 it
.vpos
= this_line_vpos
;
11523 /* The call to move_it_to stops in front of PT, but
11524 moves over before-strings. */
11525 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11527 if (it
.vpos
== this_line_vpos
11528 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11531 xassert (this_line_vpos
== it
.vpos
);
11532 xassert (this_line_y
== it
.current_y
);
11533 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11535 *w
->desired_matrix
->method
= 0;
11536 debug_method_add (w
, "optimization 3");
11545 /* Text changed drastically or point moved off of line. */
11546 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11549 CHARPOS (this_line_start_pos
) = 0;
11550 consider_all_windows_p
|= buffer_shared
> 1;
11551 ++clear_face_cache_count
;
11552 #ifdef HAVE_WINDOW_SYSTEM
11553 ++clear_image_cache_count
;
11556 /* Build desired matrices, and update the display. If
11557 consider_all_windows_p is non-zero, do it for all windows on all
11558 frames. Otherwise do it for selected_window, only. */
11560 if (consider_all_windows_p
)
11562 Lisp_Object tail
, frame
;
11564 FOR_EACH_FRAME (tail
, frame
)
11565 XFRAME (frame
)->updated_p
= 0;
11567 /* Recompute # windows showing selected buffer. This will be
11568 incremented each time such a window is displayed. */
11571 FOR_EACH_FRAME (tail
, frame
)
11573 struct frame
*f
= XFRAME (frame
);
11575 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11577 if (! EQ (frame
, selected_frame
))
11578 /* Select the frame, for the sake of frame-local
11580 select_frame_for_redisplay (frame
);
11582 /* Mark all the scroll bars to be removed; we'll redeem
11583 the ones we want when we redisplay their windows. */
11584 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11585 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11587 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11588 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11590 /* Any scroll bars which redisplay_windows should have
11591 nuked should now go away. */
11592 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11593 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11595 /* If fonts changed, display again. */
11596 /* ??? rms: I suspect it is a mistake to jump all the way
11597 back to retry here. It should just retry this frame. */
11598 if (fonts_changed_p
)
11601 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11603 /* See if we have to hscroll. */
11604 if (!f
->already_hscrolled_p
)
11606 f
->already_hscrolled_p
= 1;
11607 if (hscroll_windows (f
->root_window
))
11611 /* Prevent various kinds of signals during display
11612 update. stdio is not robust about handling
11613 signals, which can cause an apparent I/O
11615 if (interrupt_input
)
11616 unrequest_sigio ();
11619 /* Update the display. */
11620 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11621 pause
|= update_frame (f
, 0, 0);
11622 #if 0 /* Exiting the loop can leave the wrong value for buffer_shared. */
11634 /* Do the mark_window_display_accurate after all windows have
11635 been redisplayed because this call resets flags in buffers
11636 which are needed for proper redisplay. */
11637 FOR_EACH_FRAME (tail
, frame
)
11639 struct frame
*f
= XFRAME (frame
);
11642 mark_window_display_accurate (f
->root_window
, 1);
11643 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11644 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11649 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11651 Lisp_Object mini_window
;
11652 struct frame
*mini_frame
;
11654 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11655 /* Use list_of_error, not Qerror, so that
11656 we catch only errors and don't run the debugger. */
11657 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11659 redisplay_window_error
);
11661 /* Compare desired and current matrices, perform output. */
11664 /* If fonts changed, display again. */
11665 if (fonts_changed_p
)
11668 /* Prevent various kinds of signals during display update.
11669 stdio is not robust about handling signals,
11670 which can cause an apparent I/O error. */
11671 if (interrupt_input
)
11672 unrequest_sigio ();
11675 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11677 if (hscroll_windows (selected_window
))
11680 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11681 pause
= update_frame (sf
, 0, 0);
11684 /* We may have called echo_area_display at the top of this
11685 function. If the echo area is on another frame, that may
11686 have put text on a frame other than the selected one, so the
11687 above call to update_frame would not have caught it. Catch
11689 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11690 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11692 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11694 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11695 pause
|= update_frame (mini_frame
, 0, 0);
11696 if (!pause
&& hscroll_windows (mini_window
))
11701 /* If display was paused because of pending input, make sure we do a
11702 thorough update the next time. */
11705 /* Prevent the optimization at the beginning of
11706 redisplay_internal that tries a single-line update of the
11707 line containing the cursor in the selected window. */
11708 CHARPOS (this_line_start_pos
) = 0;
11710 /* Let the overlay arrow be updated the next time. */
11711 update_overlay_arrows (0);
11713 /* If we pause after scrolling, some rows in the current
11714 matrices of some windows are not valid. */
11715 if (!WINDOW_FULL_WIDTH_P (w
)
11716 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11717 update_mode_lines
= 1;
11721 if (!consider_all_windows_p
)
11723 /* This has already been done above if
11724 consider_all_windows_p is set. */
11725 mark_window_display_accurate_1 (w
, 1);
11727 /* Say overlay arrows are up to date. */
11728 update_overlay_arrows (1);
11730 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11731 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11734 update_mode_lines
= 0;
11735 windows_or_buffers_changed
= 0;
11736 cursor_type_changed
= 0;
11739 /* Start SIGIO interrupts coming again. Having them off during the
11740 code above makes it less likely one will discard output, but not
11741 impossible, since there might be stuff in the system buffer here.
11742 But it is much hairier to try to do anything about that. */
11743 if (interrupt_input
)
11747 /* If a frame has become visible which was not before, redisplay
11748 again, so that we display it. Expose events for such a frame
11749 (which it gets when becoming visible) don't call the parts of
11750 redisplay constructing glyphs, so simply exposing a frame won't
11751 display anything in this case. So, we have to display these
11752 frames here explicitly. */
11755 Lisp_Object tail
, frame
;
11758 FOR_EACH_FRAME (tail
, frame
)
11760 int this_is_visible
= 0;
11762 if (XFRAME (frame
)->visible
)
11763 this_is_visible
= 1;
11764 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11765 if (XFRAME (frame
)->visible
)
11766 this_is_visible
= 1;
11768 if (this_is_visible
)
11772 if (new_count
!= number_of_visible_frames
)
11773 windows_or_buffers_changed
++;
11776 /* Change frame size now if a change is pending. */
11777 do_pending_window_change (1);
11779 /* If we just did a pending size change, or have additional
11780 visible frames, redisplay again. */
11781 if (windows_or_buffers_changed
&& !pause
)
11784 /* Clear the face cache eventually. */
11785 if (consider_all_windows_p
)
11787 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11789 clear_face_cache (0);
11790 clear_face_cache_count
= 0;
11792 #ifdef HAVE_WINDOW_SYSTEM
11793 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
11795 Lisp_Object tail
, frame
;
11796 FOR_EACH_FRAME (tail
, frame
)
11798 struct frame
*f
= XFRAME (frame
);
11799 if (FRAME_WINDOW_P (f
))
11800 clear_image_cache (f
, 0);
11802 clear_image_cache_count
= 0;
11804 #endif /* HAVE_WINDOW_SYSTEM */
11808 unbind_to (count
, Qnil
);
11813 /* Redisplay, but leave alone any recent echo area message unless
11814 another message has been requested in its place.
11816 This is useful in situations where you need to redisplay but no
11817 user action has occurred, making it inappropriate for the message
11818 area to be cleared. See tracking_off and
11819 wait_reading_process_output for examples of these situations.
11821 FROM_WHERE is an integer saying from where this function was
11822 called. This is useful for debugging. */
11825 redisplay_preserve_echo_area (from_where
)
11828 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
11830 if (!NILP (echo_area_buffer
[1]))
11832 /* We have a previously displayed message, but no current
11833 message. Redisplay the previous message. */
11834 display_last_displayed_message_p
= 1;
11835 redisplay_internal (1);
11836 display_last_displayed_message_p
= 0;
11839 redisplay_internal (1);
11841 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
11842 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11843 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
11847 /* Function registered with record_unwind_protect in
11848 redisplay_internal. Reset redisplaying_p to the value it had
11849 before redisplay_internal was called, and clear
11850 prevent_freeing_realized_faces_p. It also selects the previously
11851 selected frame, unless it has been deleted (by an X connection
11852 failure during redisplay, for example). */
11855 unwind_redisplay (val
)
11858 Lisp_Object old_redisplaying_p
, old_frame
;
11860 old_redisplaying_p
= XCAR (val
);
11861 redisplaying_p
= XFASTINT (old_redisplaying_p
);
11862 old_frame
= XCDR (val
);
11863 if (! EQ (old_frame
, selected_frame
)
11864 && FRAME_LIVE_P (XFRAME (old_frame
)))
11865 select_frame_for_redisplay (old_frame
);
11870 /* Mark the display of window W as accurate or inaccurate. If
11871 ACCURATE_P is non-zero mark display of W as accurate. If
11872 ACCURATE_P is zero, arrange for W to be redisplayed the next time
11873 redisplay_internal is called. */
11876 mark_window_display_accurate_1 (w
, accurate_p
)
11880 if (BUFFERP (w
->buffer
))
11882 struct buffer
*b
= XBUFFER (w
->buffer
);
11885 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
11886 w
->last_overlay_modified
11887 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
11889 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
11893 b
->clip_changed
= 0;
11894 b
->prevent_redisplay_optimizations_p
= 0;
11896 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
11897 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
11898 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
11899 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
11901 w
->current_matrix
->buffer
= b
;
11902 w
->current_matrix
->begv
= BUF_BEGV (b
);
11903 w
->current_matrix
->zv
= BUF_ZV (b
);
11905 w
->last_cursor
= w
->cursor
;
11906 w
->last_cursor_off_p
= w
->cursor_off_p
;
11908 if (w
== XWINDOW (selected_window
))
11909 w
->last_point
= make_number (BUF_PT (b
));
11911 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
11917 w
->window_end_valid
= w
->buffer
;
11918 #if 0 /* This is incorrect with variable-height lines. */
11919 xassert (XINT (w
->window_end_vpos
)
11920 < (WINDOW_TOTAL_LINES (w
)
11921 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
11923 w
->update_mode_line
= Qnil
;
11928 /* Mark the display of windows in the window tree rooted at WINDOW as
11929 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
11930 windows as accurate. If ACCURATE_P is zero, arrange for windows to
11931 be redisplayed the next time redisplay_internal is called. */
11934 mark_window_display_accurate (window
, accurate_p
)
11935 Lisp_Object window
;
11940 for (; !NILP (window
); window
= w
->next
)
11942 w
= XWINDOW (window
);
11943 mark_window_display_accurate_1 (w
, accurate_p
);
11945 if (!NILP (w
->vchild
))
11946 mark_window_display_accurate (w
->vchild
, accurate_p
);
11947 if (!NILP (w
->hchild
))
11948 mark_window_display_accurate (w
->hchild
, accurate_p
);
11953 update_overlay_arrows (1);
11957 /* Force a thorough redisplay the next time by setting
11958 last_arrow_position and last_arrow_string to t, which is
11959 unequal to any useful value of Voverlay_arrow_... */
11960 update_overlay_arrows (-1);
11965 /* Return value in display table DP (Lisp_Char_Table *) for character
11966 C. Since a display table doesn't have any parent, we don't have to
11967 follow parent. Do not call this function directly but use the
11968 macro DISP_CHAR_VECTOR. */
11971 disp_char_vector (dp
, c
)
11972 struct Lisp_Char_Table
*dp
;
11977 if (ASCII_CHAR_P (c
))
11980 if (SUB_CHAR_TABLE_P (val
))
11981 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
11987 XSETCHAR_TABLE (table
, dp
);
11988 val
= char_table_ref (table
, c
);
11997 /***********************************************************************
11999 ***********************************************************************/
12001 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12004 redisplay_windows (window
)
12005 Lisp_Object window
;
12007 while (!NILP (window
))
12009 struct window
*w
= XWINDOW (window
);
12011 if (!NILP (w
->hchild
))
12012 redisplay_windows (w
->hchild
);
12013 else if (!NILP (w
->vchild
))
12014 redisplay_windows (w
->vchild
);
12017 displayed_buffer
= XBUFFER (w
->buffer
);
12018 /* Use list_of_error, not Qerror, so that
12019 we catch only errors and don't run the debugger. */
12020 internal_condition_case_1 (redisplay_window_0
, window
,
12022 redisplay_window_error
);
12030 redisplay_window_error ()
12032 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12037 redisplay_window_0 (window
)
12038 Lisp_Object window
;
12040 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12041 redisplay_window (window
, 0);
12046 redisplay_window_1 (window
)
12047 Lisp_Object window
;
12049 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12050 redisplay_window (window
, 1);
12055 /* Increment GLYPH until it reaches END or CONDITION fails while
12056 adding (GLYPH)->pixel_width to X. */
12058 #define SKIP_GLYPHS(glyph, end, x, condition) \
12061 (x) += (glyph)->pixel_width; \
12064 while ((glyph) < (end) && (condition))
12067 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12068 DELTA is the number of bytes by which positions recorded in ROW
12069 differ from current buffer positions.
12071 Return 0 if cursor is not on this row. 1 otherwise. */
12074 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12076 struct glyph_row
*row
;
12077 struct glyph_matrix
*matrix
;
12078 int delta
, delta_bytes
, dy
, dvpos
;
12080 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12081 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12082 struct glyph
*cursor
= NULL
;
12083 /* The first glyph that starts a sequence of glyphs from string. */
12084 struct glyph
*string_start
;
12085 /* The X coordinate of string_start. */
12086 int string_start_x
;
12087 /* The last known character position. */
12088 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12089 /* The last known character position before string_start. */
12090 int string_before_pos
;
12093 int cursor_from_overlay_pos
= 0;
12094 int pt_old
= PT
- delta
;
12096 /* Skip over glyphs not having an object at the start of the row.
12097 These are special glyphs like truncation marks on terminal
12099 if (row
->displays_text_p
)
12101 && INTEGERP (glyph
->object
)
12102 && glyph
->charpos
< 0)
12104 x
+= glyph
->pixel_width
;
12108 string_start
= NULL
;
12110 && !INTEGERP (glyph
->object
)
12111 && (!BUFFERP (glyph
->object
)
12112 || (last_pos
= glyph
->charpos
) < pt_old
))
12114 if (! STRINGP (glyph
->object
))
12116 string_start
= NULL
;
12117 x
+= glyph
->pixel_width
;
12119 if (cursor_from_overlay_pos
12120 && last_pos
>= cursor_from_overlay_pos
)
12122 cursor_from_overlay_pos
= 0;
12128 if (string_start
== NULL
)
12130 string_before_pos
= last_pos
;
12131 string_start
= glyph
;
12132 string_start_x
= x
;
12134 /* Skip all glyphs from string. */
12139 if ((cursor
== NULL
|| glyph
> cursor
)
12140 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12141 Qcursor
, (glyph
)->object
),
12143 && (pos
= string_buffer_position (w
, glyph
->object
,
12144 string_before_pos
),
12145 (pos
== 0 /* From overlay */
12146 || pos
== pt_old
)))
12148 /* Estimate overlay buffer position from the buffer
12149 positions of the glyphs before and after the overlay.
12150 Add 1 to last_pos so that if point corresponds to the
12151 glyph right after the overlay, we still use a 'cursor'
12152 property found in that overlay. */
12153 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12154 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12158 x
+= glyph
->pixel_width
;
12161 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12165 if (cursor
!= NULL
)
12170 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12172 /* Scan back over the ellipsis glyphs, decrementing positions. */
12173 while (glyph
> row
->glyphs
[TEXT_AREA
]
12174 && (glyph
- 1)->charpos
== last_pos
)
12175 glyph
--, x
-= glyph
->pixel_width
;
12176 /* That loop always goes one position too far,
12177 including the glyph before the ellipsis.
12178 So scan forward over that one. */
12179 x
+= glyph
->pixel_width
;
12182 else if (string_start
12183 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12185 /* We may have skipped over point because the previous glyphs
12186 are from string. As there's no easy way to know the
12187 character position of the current glyph, find the correct
12188 glyph on point by scanning from string_start again. */
12190 Lisp_Object string
;
12191 struct glyph
*stop
= glyph
;
12194 limit
= make_number (pt_old
+ 1);
12195 glyph
= string_start
;
12196 x
= string_start_x
;
12197 string
= glyph
->object
;
12198 pos
= string_buffer_position (w
, string
, string_before_pos
);
12199 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12200 because we always put cursor after overlay strings. */
12201 while (pos
== 0 && glyph
< stop
)
12203 string
= glyph
->object
;
12204 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12206 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12209 while (glyph
< stop
)
12211 pos
= XINT (Fnext_single_char_property_change
12212 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12215 /* Skip glyphs from the same string. */
12216 string
= glyph
->object
;
12217 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12218 /* Skip glyphs from an overlay. */
12219 while (glyph
< stop
12220 && ! string_buffer_position (w
, glyph
->object
, pos
))
12222 string
= glyph
->object
;
12223 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12227 /* If we reached the end of the line, and end was from a string,
12228 cursor is not on this line. */
12229 if (glyph
== end
&& row
->continued_p
)
12233 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12235 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12236 w
->cursor
.y
= row
->y
+ dy
;
12238 if (w
== XWINDOW (selected_window
))
12240 if (!row
->continued_p
12241 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12244 this_line_buffer
= XBUFFER (w
->buffer
);
12246 CHARPOS (this_line_start_pos
)
12247 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12248 BYTEPOS (this_line_start_pos
)
12249 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12251 CHARPOS (this_line_end_pos
)
12252 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12253 BYTEPOS (this_line_end_pos
)
12254 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12256 this_line_y
= w
->cursor
.y
;
12257 this_line_pixel_height
= row
->height
;
12258 this_line_vpos
= w
->cursor
.vpos
;
12259 this_line_start_x
= row
->x
;
12262 CHARPOS (this_line_start_pos
) = 0;
12269 /* Run window scroll functions, if any, for WINDOW with new window
12270 start STARTP. Sets the window start of WINDOW to that position.
12272 We assume that the window's buffer is really current. */
12274 static INLINE
struct text_pos
12275 run_window_scroll_functions (window
, startp
)
12276 Lisp_Object window
;
12277 struct text_pos startp
;
12279 struct window
*w
= XWINDOW (window
);
12280 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12282 if (current_buffer
!= XBUFFER (w
->buffer
))
12285 if (!NILP (Vwindow_scroll_functions
))
12287 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12288 make_number (CHARPOS (startp
)));
12289 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12290 /* In case the hook functions switch buffers. */
12291 if (current_buffer
!= XBUFFER (w
->buffer
))
12292 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12299 /* Make sure the line containing the cursor is fully visible.
12300 A value of 1 means there is nothing to be done.
12301 (Either the line is fully visible, or it cannot be made so,
12302 or we cannot tell.)
12304 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12305 is higher than window.
12307 A value of 0 means the caller should do scrolling
12308 as if point had gone off the screen. */
12311 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12314 int current_matrix_p
;
12316 struct glyph_matrix
*matrix
;
12317 struct glyph_row
*row
;
12320 if (!make_cursor_line_fully_visible_p
)
12323 /* It's not always possible to find the cursor, e.g, when a window
12324 is full of overlay strings. Don't do anything in that case. */
12325 if (w
->cursor
.vpos
< 0)
12328 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12329 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12331 /* If the cursor row is not partially visible, there's nothing to do. */
12332 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12335 /* If the row the cursor is in is taller than the window's height,
12336 it's not clear what to do, so do nothing. */
12337 window_height
= window_box_height (w
);
12338 if (row
->height
>= window_height
)
12340 if (!force_p
|| MINI_WINDOW_P (w
)
12341 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12347 /* This code used to try to scroll the window just enough to make
12348 the line visible. It returned 0 to say that the caller should
12349 allocate larger glyph matrices. */
12351 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12353 int dy
= row
->height
- row
->visible_height
;
12356 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12358 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12360 int dy
= - (row
->height
- row
->visible_height
);
12363 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12366 /* When we change the cursor y-position of the selected window,
12367 change this_line_y as well so that the display optimization for
12368 the cursor line of the selected window in redisplay_internal uses
12369 the correct y-position. */
12370 if (w
== XWINDOW (selected_window
))
12371 this_line_y
= w
->cursor
.y
;
12373 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12374 redisplay with larger matrices. */
12375 if (matrix
->nrows
< required_matrix_height (w
))
12377 fonts_changed_p
= 1;
12386 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12387 non-zero means only WINDOW is redisplayed in redisplay_internal.
12388 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12389 in redisplay_window to bring a partially visible line into view in
12390 the case that only the cursor has moved.
12392 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12393 last screen line's vertical height extends past the end of the screen.
12397 1 if scrolling succeeded
12399 0 if scrolling didn't find point.
12401 -1 if new fonts have been loaded so that we must interrupt
12402 redisplay, adjust glyph matrices, and try again. */
12408 SCROLLING_NEED_LARGER_MATRICES
12412 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12413 scroll_step
, temp_scroll_step
, last_line_misfit
)
12414 Lisp_Object window
;
12415 int just_this_one_p
;
12416 EMACS_INT scroll_conservatively
, scroll_step
;
12417 int temp_scroll_step
;
12418 int last_line_misfit
;
12420 struct window
*w
= XWINDOW (window
);
12421 struct frame
*f
= XFRAME (w
->frame
);
12422 struct text_pos scroll_margin_pos
;
12423 struct text_pos pos
;
12424 struct text_pos startp
;
12426 Lisp_Object window_end
;
12427 int this_scroll_margin
;
12431 int amount_to_scroll
= 0;
12432 Lisp_Object aggressive
;
12434 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12437 debug_method_add (w
, "try_scrolling");
12440 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12442 /* Compute scroll margin height in pixels. We scroll when point is
12443 within this distance from the top or bottom of the window. */
12444 if (scroll_margin
> 0)
12446 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12447 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12450 this_scroll_margin
= 0;
12452 /* Force scroll_conservatively to have a reasonable value so it doesn't
12453 cause an overflow while computing how much to scroll. */
12454 if (scroll_conservatively
)
12455 scroll_conservatively
= min (scroll_conservatively
,
12456 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
12458 /* Compute how much we should try to scroll maximally to bring point
12460 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12461 scroll_max
= max (scroll_step
,
12462 max (scroll_conservatively
, temp_scroll_step
));
12463 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12464 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12465 /* We're trying to scroll because of aggressive scrolling
12466 but no scroll_step is set. Choose an arbitrary one. Maybe
12467 there should be a variable for this. */
12471 scroll_max
*= FRAME_LINE_HEIGHT (f
);
12473 /* Decide whether we have to scroll down. Start at the window end
12474 and move this_scroll_margin up to find the position of the scroll
12476 window_end
= Fwindow_end (window
, Qt
);
12480 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
12481 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
12483 if (this_scroll_margin
|| extra_scroll_margin_lines
)
12485 start_display (&it
, w
, scroll_margin_pos
);
12486 if (this_scroll_margin
)
12487 move_it_vertically_backward (&it
, this_scroll_margin
);
12488 if (extra_scroll_margin_lines
)
12489 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
12490 scroll_margin_pos
= it
.current
.pos
;
12493 if (PT
>= CHARPOS (scroll_margin_pos
))
12497 /* Point is in the scroll margin at the bottom of the window, or
12498 below. Compute a new window start that makes point visible. */
12500 /* Compute the distance from the scroll margin to PT.
12501 Give up if the distance is greater than scroll_max. */
12502 start_display (&it
, w
, scroll_margin_pos
);
12504 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12505 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12507 /* To make point visible, we have to move the window start
12508 down so that the line the cursor is in is visible, which
12509 means we have to add in the height of the cursor line. */
12510 dy
= line_bottom_y (&it
) - y0
;
12512 if (dy
> scroll_max
)
12513 return SCROLLING_FAILED
;
12515 /* Move the window start down. If scrolling conservatively,
12516 move it just enough down to make point visible. If
12517 scroll_step is set, move it down by scroll_step. */
12518 start_display (&it
, w
, startp
);
12520 if (scroll_conservatively
)
12521 /* Set AMOUNT_TO_SCROLL to at least one line,
12522 and at most scroll_conservatively lines. */
12524 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12525 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12526 else if (scroll_step
|| temp_scroll_step
)
12527 amount_to_scroll
= scroll_max
;
12530 aggressive
= current_buffer
->scroll_up_aggressively
;
12531 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12532 if (NUMBERP (aggressive
))
12534 double float_amount
= XFLOATINT (aggressive
) * height
;
12535 amount_to_scroll
= float_amount
;
12536 if (amount_to_scroll
== 0 && float_amount
> 0)
12537 amount_to_scroll
= 1;
12541 if (amount_to_scroll
<= 0)
12542 return SCROLLING_FAILED
;
12544 /* If moving by amount_to_scroll leaves STARTP unchanged,
12545 move it down one screen line. */
12547 move_it_vertically (&it
, amount_to_scroll
);
12548 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12549 move_it_by_lines (&it
, 1, 1);
12550 startp
= it
.current
.pos
;
12554 /* See if point is inside the scroll margin at the top of the
12556 scroll_margin_pos
= startp
;
12557 if (this_scroll_margin
)
12559 start_display (&it
, w
, startp
);
12560 move_it_vertically (&it
, this_scroll_margin
);
12561 scroll_margin_pos
= it
.current
.pos
;
12564 if (PT
< CHARPOS (scroll_margin_pos
))
12566 /* Point is in the scroll margin at the top of the window or
12567 above what is displayed in the window. */
12570 /* Compute the vertical distance from PT to the scroll
12571 margin position. Give up if distance is greater than
12573 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12574 start_display (&it
, w
, pos
);
12576 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12577 it
.last_visible_y
, -1,
12578 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12579 dy
= it
.current_y
- y0
;
12580 if (dy
> scroll_max
)
12581 return SCROLLING_FAILED
;
12583 /* Compute new window start. */
12584 start_display (&it
, w
, startp
);
12586 if (scroll_conservatively
)
12588 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12589 else if (scroll_step
|| temp_scroll_step
)
12590 amount_to_scroll
= scroll_max
;
12593 aggressive
= current_buffer
->scroll_down_aggressively
;
12594 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12595 if (NUMBERP (aggressive
))
12597 double float_amount
= XFLOATINT (aggressive
) * height
;
12598 amount_to_scroll
= float_amount
;
12599 if (amount_to_scroll
== 0 && float_amount
> 0)
12600 amount_to_scroll
= 1;
12604 if (amount_to_scroll
<= 0)
12605 return SCROLLING_FAILED
;
12607 move_it_vertically_backward (&it
, amount_to_scroll
);
12608 startp
= it
.current
.pos
;
12612 /* Run window scroll functions. */
12613 startp
= run_window_scroll_functions (window
, startp
);
12615 /* Display the window. Give up if new fonts are loaded, or if point
12617 if (!try_window (window
, startp
, 0))
12618 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12619 else if (w
->cursor
.vpos
< 0)
12621 clear_glyph_matrix (w
->desired_matrix
);
12622 rc
= SCROLLING_FAILED
;
12626 /* Maybe forget recorded base line for line number display. */
12627 if (!just_this_one_p
12628 || current_buffer
->clip_changed
12629 || BEG_UNCHANGED
< CHARPOS (startp
))
12630 w
->base_line_number
= Qnil
;
12632 /* If cursor ends up on a partially visible line,
12633 treat that as being off the bottom of the screen. */
12634 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12636 clear_glyph_matrix (w
->desired_matrix
);
12637 ++extra_scroll_margin_lines
;
12640 rc
= SCROLLING_SUCCESS
;
12647 /* Compute a suitable window start for window W if display of W starts
12648 on a continuation line. Value is non-zero if a new window start
12651 The new window start will be computed, based on W's width, starting
12652 from the start of the continued line. It is the start of the
12653 screen line with the minimum distance from the old start W->start. */
12656 compute_window_start_on_continuation_line (w
)
12659 struct text_pos pos
, start_pos
;
12660 int window_start_changed_p
= 0;
12662 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12664 /* If window start is on a continuation line... Window start may be
12665 < BEGV in case there's invisible text at the start of the
12666 buffer (M-x rmail, for example). */
12667 if (CHARPOS (start_pos
) > BEGV
12668 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12671 struct glyph_row
*row
;
12673 /* Handle the case that the window start is out of range. */
12674 if (CHARPOS (start_pos
) < BEGV
)
12675 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12676 else if (CHARPOS (start_pos
) > ZV
)
12677 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12679 /* Find the start of the continued line. This should be fast
12680 because scan_buffer is fast (newline cache). */
12681 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12682 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12683 row
, DEFAULT_FACE_ID
);
12684 reseat_at_previous_visible_line_start (&it
);
12686 /* If the line start is "too far" away from the window start,
12687 say it takes too much time to compute a new window start. */
12688 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12689 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12691 int min_distance
, distance
;
12693 /* Move forward by display lines to find the new window
12694 start. If window width was enlarged, the new start can
12695 be expected to be > the old start. If window width was
12696 decreased, the new window start will be < the old start.
12697 So, we're looking for the display line start with the
12698 minimum distance from the old window start. */
12699 pos
= it
.current
.pos
;
12700 min_distance
= INFINITY
;
12701 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12702 distance
< min_distance
)
12704 min_distance
= distance
;
12705 pos
= it
.current
.pos
;
12706 move_it_by_lines (&it
, 1, 0);
12709 /* Set the window start there. */
12710 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12711 window_start_changed_p
= 1;
12715 return window_start_changed_p
;
12719 /* Try cursor movement in case text has not changed in window WINDOW,
12720 with window start STARTP. Value is
12722 CURSOR_MOVEMENT_SUCCESS if successful
12724 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12726 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12727 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12728 we want to scroll as if scroll-step were set to 1. See the code.
12730 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12731 which case we have to abort this redisplay, and adjust matrices
12736 CURSOR_MOVEMENT_SUCCESS
,
12737 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12738 CURSOR_MOVEMENT_MUST_SCROLL
,
12739 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12743 try_cursor_movement (window
, startp
, scroll_step
)
12744 Lisp_Object window
;
12745 struct text_pos startp
;
12748 struct window
*w
= XWINDOW (window
);
12749 struct frame
*f
= XFRAME (w
->frame
);
12750 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12753 if (inhibit_try_cursor_movement
)
12757 /* Handle case where text has not changed, only point, and it has
12758 not moved off the frame. */
12759 if (/* Point may be in this window. */
12760 PT
>= CHARPOS (startp
)
12761 /* Selective display hasn't changed. */
12762 && !current_buffer
->clip_changed
12763 /* Function force-mode-line-update is used to force a thorough
12764 redisplay. It sets either windows_or_buffers_changed or
12765 update_mode_lines. So don't take a shortcut here for these
12767 && !update_mode_lines
12768 && !windows_or_buffers_changed
12769 && !cursor_type_changed
12770 /* Can't use this case if highlighting a region. When a
12771 region exists, cursor movement has to do more than just
12773 && !(!NILP (Vtransient_mark_mode
)
12774 && !NILP (current_buffer
->mark_active
))
12775 && NILP (w
->region_showing
)
12776 && NILP (Vshow_trailing_whitespace
)
12777 /* Right after splitting windows, last_point may be nil. */
12778 && INTEGERP (w
->last_point
)
12779 /* This code is not used for mini-buffer for the sake of the case
12780 of redisplaying to replace an echo area message; since in
12781 that case the mini-buffer contents per se are usually
12782 unchanged. This code is of no real use in the mini-buffer
12783 since the handling of this_line_start_pos, etc., in redisplay
12784 handles the same cases. */
12785 && !EQ (window
, minibuf_window
)
12786 /* When splitting windows or for new windows, it happens that
12787 redisplay is called with a nil window_end_vpos or one being
12788 larger than the window. This should really be fixed in
12789 window.c. I don't have this on my list, now, so we do
12790 approximately the same as the old redisplay code. --gerd. */
12791 && INTEGERP (w
->window_end_vpos
)
12792 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12793 && (FRAME_WINDOW_P (f
)
12794 || !overlay_arrow_in_current_buffer_p ()))
12796 int this_scroll_margin
, top_scroll_margin
;
12797 struct glyph_row
*row
= NULL
;
12800 debug_method_add (w
, "cursor movement");
12803 /* Scroll if point within this distance from the top or bottom
12804 of the window. This is a pixel value. */
12805 this_scroll_margin
= max (0, scroll_margin
);
12806 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12807 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12809 top_scroll_margin
= this_scroll_margin
;
12810 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12811 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12813 /* Start with the row the cursor was displayed during the last
12814 not paused redisplay. Give up if that row is not valid. */
12815 if (w
->last_cursor
.vpos
< 0
12816 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12817 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12820 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12821 if (row
->mode_line_p
)
12823 if (!row
->enabled_p
)
12824 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12827 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12830 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12832 if (PT
> XFASTINT (w
->last_point
))
12834 /* Point has moved forward. */
12835 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12836 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12838 xassert (row
->enabled_p
);
12842 /* The end position of a row equals the start position
12843 of the next row. If PT is there, we would rather
12844 display it in the next line. */
12845 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12846 && MATRIX_ROW_END_CHARPOS (row
) == PT
12847 && !cursor_row_p (w
, row
))
12850 /* If within the scroll margin, scroll. Note that
12851 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
12852 the next line would be drawn, and that
12853 this_scroll_margin can be zero. */
12854 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
12855 || PT
> MATRIX_ROW_END_CHARPOS (row
)
12856 /* Line is completely visible last line in window
12857 and PT is to be set in the next line. */
12858 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
12859 && PT
== MATRIX_ROW_END_CHARPOS (row
)
12860 && !row
->ends_at_zv_p
12861 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12864 else if (PT
< XFASTINT (w
->last_point
))
12866 /* Cursor has to be moved backward. Note that PT >=
12867 CHARPOS (startp) because of the outer if-statement. */
12868 while (!row
->mode_line_p
12869 && (MATRIX_ROW_START_CHARPOS (row
) > PT
12870 || (MATRIX_ROW_START_CHARPOS (row
) == PT
12871 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
12872 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
12873 row
> w
->current_matrix
->rows
12874 && (row
-1)->ends_in_newline_from_string_p
))))
12875 && (row
->y
> top_scroll_margin
12876 || CHARPOS (startp
) == BEGV
))
12878 xassert (row
->enabled_p
);
12882 /* Consider the following case: Window starts at BEGV,
12883 there is invisible, intangible text at BEGV, so that
12884 display starts at some point START > BEGV. It can
12885 happen that we are called with PT somewhere between
12886 BEGV and START. Try to handle that case. */
12887 if (row
< w
->current_matrix
->rows
12888 || row
->mode_line_p
)
12890 row
= w
->current_matrix
->rows
;
12891 if (row
->mode_line_p
)
12895 /* Due to newlines in overlay strings, we may have to
12896 skip forward over overlay strings. */
12897 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12898 && MATRIX_ROW_END_CHARPOS (row
) == PT
12899 && !cursor_row_p (w
, row
))
12902 /* If within the scroll margin, scroll. */
12903 if (row
->y
< top_scroll_margin
12904 && CHARPOS (startp
) != BEGV
)
12909 /* Cursor did not move. So don't scroll even if cursor line
12910 is partially visible, as it was so before. */
12911 rc
= CURSOR_MOVEMENT_SUCCESS
;
12914 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
12915 || PT
> MATRIX_ROW_END_CHARPOS (row
))
12917 /* if PT is not in the glyph row, give up. */
12918 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12920 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
12921 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
12922 && make_cursor_line_fully_visible_p
)
12924 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
12925 && !row
->ends_at_zv_p
12926 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12927 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12928 else if (row
->height
> window_box_height (w
))
12930 /* If we end up in a partially visible line, let's
12931 make it fully visible, except when it's taller
12932 than the window, in which case we can't do much
12935 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12939 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12940 if (!cursor_row_fully_visible_p (w
, 0, 1))
12941 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12943 rc
= CURSOR_MOVEMENT_SUCCESS
;
12947 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12952 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
12954 rc
= CURSOR_MOVEMENT_SUCCESS
;
12959 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12960 && MATRIX_ROW_START_CHARPOS (row
) == PT
12961 && cursor_row_p (w
, row
));
12970 set_vertical_scroll_bar (w
)
12973 int start
, end
, whole
;
12975 /* Calculate the start and end positions for the current window.
12976 At some point, it would be nice to choose between scrollbars
12977 which reflect the whole buffer size, with special markers
12978 indicating narrowing, and scrollbars which reflect only the
12981 Note that mini-buffers sometimes aren't displaying any text. */
12982 if (!MINI_WINDOW_P (w
)
12983 || (w
== XWINDOW (minibuf_window
)
12984 && NILP (echo_area_buffer
[0])))
12986 struct buffer
*buf
= XBUFFER (w
->buffer
);
12987 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
12988 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
12989 /* I don't think this is guaranteed to be right. For the
12990 moment, we'll pretend it is. */
12991 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
12995 if (whole
< (end
- start
))
12996 whole
= end
- start
;
12999 start
= end
= whole
= 0;
13001 /* Indicate what this scroll bar ought to be displaying now. */
13002 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13003 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13004 (w
, end
- start
, whole
, start
);
13008 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13009 selected_window is redisplayed.
13011 We can return without actually redisplaying the window if
13012 fonts_changed_p is nonzero. In that case, redisplay_internal will
13016 redisplay_window (window
, just_this_one_p
)
13017 Lisp_Object window
;
13018 int just_this_one_p
;
13020 struct window
*w
= XWINDOW (window
);
13021 struct frame
*f
= XFRAME (w
->frame
);
13022 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13023 struct buffer
*old
= current_buffer
;
13024 struct text_pos lpoint
, opoint
, startp
;
13025 int update_mode_line
;
13028 /* Record it now because it's overwritten. */
13029 int current_matrix_up_to_date_p
= 0;
13030 int used_current_matrix_p
= 0;
13031 /* This is less strict than current_matrix_up_to_date_p.
13032 It indictes that the buffer contents and narrowing are unchanged. */
13033 int buffer_unchanged_p
= 0;
13034 int temp_scroll_step
= 0;
13035 int count
= SPECPDL_INDEX ();
13037 int centering_position
= -1;
13038 int last_line_misfit
= 0;
13039 int beg_unchanged
, end_unchanged
;
13041 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13044 /* W must be a leaf window here. */
13045 xassert (!NILP (w
->buffer
));
13047 *w
->desired_matrix
->method
= 0;
13051 reconsider_clip_changes (w
, buffer
);
13053 /* Has the mode line to be updated? */
13054 update_mode_line
= (!NILP (w
->update_mode_line
)
13055 || update_mode_lines
13056 || buffer
->clip_changed
13057 || buffer
->prevent_redisplay_optimizations_p
);
13059 if (MINI_WINDOW_P (w
))
13061 if (w
== XWINDOW (echo_area_window
)
13062 && !NILP (echo_area_buffer
[0]))
13064 if (update_mode_line
)
13065 /* We may have to update a tty frame's menu bar or a
13066 tool-bar. Example `M-x C-h C-h C-g'. */
13067 goto finish_menu_bars
;
13069 /* We've already displayed the echo area glyphs in this window. */
13070 goto finish_scroll_bars
;
13072 else if ((w
!= XWINDOW (minibuf_window
)
13073 || minibuf_level
== 0)
13074 /* When buffer is nonempty, redisplay window normally. */
13075 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13076 /* Quail displays non-mini buffers in minibuffer window.
13077 In that case, redisplay the window normally. */
13078 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13080 /* W is a mini-buffer window, but it's not active, so clear
13082 int yb
= window_text_bottom_y (w
);
13083 struct glyph_row
*row
;
13086 for (y
= 0, row
= w
->desired_matrix
->rows
;
13088 y
+= row
->height
, ++row
)
13089 blank_row (w
, row
, y
);
13090 goto finish_scroll_bars
;
13093 clear_glyph_matrix (w
->desired_matrix
);
13096 /* Otherwise set up data on this window; select its buffer and point
13098 /* Really select the buffer, for the sake of buffer-local
13100 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13102 current_matrix_up_to_date_p
13103 = (!NILP (w
->window_end_valid
)
13104 && !current_buffer
->clip_changed
13105 && !current_buffer
->prevent_redisplay_optimizations_p
13106 && XFASTINT (w
->last_modified
) >= MODIFF
13107 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13109 /* Run the window-bottom-change-functions
13110 if it is possible that the text on the screen has changed
13111 (either due to modification of the text, or any other reason). */
13112 if (!current_matrix_up_to_date_p
13113 && !NILP (Vwindow_text_change_functions
))
13115 safe_run_hooks (Qwindow_text_change_functions
);
13119 beg_unchanged
= BEG_UNCHANGED
;
13120 end_unchanged
= END_UNCHANGED
;
13122 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13124 specbind (Qinhibit_point_motion_hooks
, Qt
);
13127 = (!NILP (w
->window_end_valid
)
13128 && !current_buffer
->clip_changed
13129 && XFASTINT (w
->last_modified
) >= MODIFF
13130 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13132 /* When windows_or_buffers_changed is non-zero, we can't rely on
13133 the window end being valid, so set it to nil there. */
13134 if (windows_or_buffers_changed
)
13136 /* If window starts on a continuation line, maybe adjust the
13137 window start in case the window's width changed. */
13138 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13139 compute_window_start_on_continuation_line (w
);
13141 w
->window_end_valid
= Qnil
;
13144 /* Some sanity checks. */
13145 CHECK_WINDOW_END (w
);
13146 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13148 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13151 /* If %c is in mode line, update it if needed. */
13152 if (!NILP (w
->column_number_displayed
)
13153 /* This alternative quickly identifies a common case
13154 where no change is needed. */
13155 && !(PT
== XFASTINT (w
->last_point
)
13156 && XFASTINT (w
->last_modified
) >= MODIFF
13157 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13158 && (XFASTINT (w
->column_number_displayed
)
13159 != (int) current_column ())) /* iftc */
13160 update_mode_line
= 1;
13162 /* Count number of windows showing the selected buffer. An indirect
13163 buffer counts as its base buffer. */
13164 if (!just_this_one_p
)
13166 struct buffer
*current_base
, *window_base
;
13167 current_base
= current_buffer
;
13168 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13169 if (current_base
->base_buffer
)
13170 current_base
= current_base
->base_buffer
;
13171 if (window_base
->base_buffer
)
13172 window_base
= window_base
->base_buffer
;
13173 if (current_base
== window_base
)
13177 /* Point refers normally to the selected window. For any other
13178 window, set up appropriate value. */
13179 if (!EQ (window
, selected_window
))
13181 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13182 int new_pt_byte
= marker_byte_position (w
->pointm
);
13186 new_pt_byte
= BEGV_BYTE
;
13187 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13189 else if (new_pt
> (ZV
- 1))
13192 new_pt_byte
= ZV_BYTE
;
13193 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13196 /* We don't use SET_PT so that the point-motion hooks don't run. */
13197 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13200 /* If any of the character widths specified in the display table
13201 have changed, invalidate the width run cache. It's true that
13202 this may be a bit late to catch such changes, but the rest of
13203 redisplay goes (non-fatally) haywire when the display table is
13204 changed, so why should we worry about doing any better? */
13205 if (current_buffer
->width_run_cache
)
13207 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13209 if (! disptab_matches_widthtab (disptab
,
13210 XVECTOR (current_buffer
->width_table
)))
13212 invalidate_region_cache (current_buffer
,
13213 current_buffer
->width_run_cache
,
13215 recompute_width_table (current_buffer
, disptab
);
13219 /* If window-start is screwed up, choose a new one. */
13220 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13223 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13225 /* If someone specified a new starting point but did not insist,
13226 check whether it can be used. */
13227 if (!NILP (w
->optional_new_start
)
13228 && CHARPOS (startp
) >= BEGV
13229 && CHARPOS (startp
) <= ZV
)
13231 w
->optional_new_start
= Qnil
;
13232 start_display (&it
, w
, startp
);
13233 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13234 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13235 if (IT_CHARPOS (it
) == PT
)
13236 w
->force_start
= Qt
;
13237 /* IT may overshoot PT if text at PT is invisible. */
13238 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13239 w
->force_start
= Qt
;
13244 /* Handle case where place to start displaying has been specified,
13245 unless the specified location is outside the accessible range. */
13246 if (!NILP (w
->force_start
)
13247 || w
->frozen_window_start_p
)
13249 /* We set this later on if we have to adjust point. */
13253 w
->force_start
= Qnil
;
13255 w
->window_end_valid
= Qnil
;
13257 /* Forget any recorded base line for line number display. */
13258 if (!buffer_unchanged_p
)
13259 w
->base_line_number
= Qnil
;
13261 /* Redisplay the mode line. Select the buffer properly for that.
13262 Also, run the hook window-scroll-functions
13263 because we have scrolled. */
13264 /* Note, we do this after clearing force_start because
13265 if there's an error, it is better to forget about force_start
13266 than to get into an infinite loop calling the hook functions
13267 and having them get more errors. */
13268 if (!update_mode_line
13269 || ! NILP (Vwindow_scroll_functions
))
13271 update_mode_line
= 1;
13272 w
->update_mode_line
= Qt
;
13273 startp
= run_window_scroll_functions (window
, startp
);
13276 w
->last_modified
= make_number (0);
13277 w
->last_overlay_modified
= make_number (0);
13278 if (CHARPOS (startp
) < BEGV
)
13279 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13280 else if (CHARPOS (startp
) > ZV
)
13281 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13283 /* Redisplay, then check if cursor has been set during the
13284 redisplay. Give up if new fonts were loaded. */
13285 val
= try_window (window
, startp
, 1);
13288 w
->force_start
= Qt
;
13289 clear_glyph_matrix (w
->desired_matrix
);
13290 goto need_larger_matrices
;
13292 /* Point was outside the scroll margins. */
13294 new_vpos
= window_box_height (w
) / 2;
13296 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13298 /* If point does not appear, try to move point so it does
13299 appear. The desired matrix has been built above, so we
13300 can use it here. */
13301 new_vpos
= window_box_height (w
) / 2;
13304 if (!cursor_row_fully_visible_p (w
, 0, 0))
13306 /* Point does appear, but on a line partly visible at end of window.
13307 Move it back to a fully-visible line. */
13308 new_vpos
= window_box_height (w
);
13311 /* If we need to move point for either of the above reasons,
13312 now actually do it. */
13315 struct glyph_row
*row
;
13317 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13318 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13321 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13322 MATRIX_ROW_START_BYTEPOS (row
));
13324 if (w
!= XWINDOW (selected_window
))
13325 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13326 else if (current_buffer
== old
)
13327 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13329 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13331 /* If we are highlighting the region, then we just changed
13332 the region, so redisplay to show it. */
13333 if (!NILP (Vtransient_mark_mode
)
13334 && !NILP (current_buffer
->mark_active
))
13336 clear_glyph_matrix (w
->desired_matrix
);
13337 if (!try_window (window
, startp
, 0))
13338 goto need_larger_matrices
;
13343 debug_method_add (w
, "forced window start");
13348 /* Handle case where text has not changed, only point, and it has
13349 not moved off the frame, and we are not retrying after hscroll.
13350 (current_matrix_up_to_date_p is nonzero when retrying.) */
13351 if (current_matrix_up_to_date_p
13352 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13353 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13357 case CURSOR_MOVEMENT_SUCCESS
:
13358 used_current_matrix_p
= 1;
13361 #if 0 /* try_cursor_movement never returns this value. */
13362 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13363 goto need_larger_matrices
;
13366 case CURSOR_MOVEMENT_MUST_SCROLL
:
13367 goto try_to_scroll
;
13373 /* If current starting point was originally the beginning of a line
13374 but no longer is, find a new starting point. */
13375 else if (!NILP (w
->start_at_line_beg
)
13376 && !(CHARPOS (startp
) <= BEGV
13377 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13380 debug_method_add (w
, "recenter 1");
13385 /* Try scrolling with try_window_id. Value is > 0 if update has
13386 been done, it is -1 if we know that the same window start will
13387 not work. It is 0 if unsuccessful for some other reason. */
13388 else if ((tem
= try_window_id (w
)) != 0)
13391 debug_method_add (w
, "try_window_id %d", tem
);
13394 if (fonts_changed_p
)
13395 goto need_larger_matrices
;
13399 /* Otherwise try_window_id has returned -1 which means that we
13400 don't want the alternative below this comment to execute. */
13402 else if (CHARPOS (startp
) >= BEGV
13403 && CHARPOS (startp
) <= ZV
13404 && PT
>= CHARPOS (startp
)
13405 && (CHARPOS (startp
) < ZV
13406 /* Avoid starting at end of buffer. */
13407 || CHARPOS (startp
) == BEGV
13408 || (XFASTINT (w
->last_modified
) >= MODIFF
13409 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13412 /* If first window line is a continuation line, and window start
13413 is inside the modified region, but the first change is before
13414 current window start, we must select a new window start.
13416 However, if this is the result of a down-mouse event (e.g. by
13417 extending the mouse-drag-overlay), we don't want to select a
13418 new window start, since that would change the position under
13419 the mouse, resulting in an unwanted mouse-movement rather
13420 than a simple mouse-click. */
13421 if (NILP (w
->start_at_line_beg
)
13422 && NILP (do_mouse_tracking
)
13423 && CHARPOS (startp
) > BEGV
13424 && CHARPOS (startp
) > BEG
+ beg_unchanged
13425 && CHARPOS (startp
) <= Z
- end_unchanged
)
13427 w
->force_start
= Qt
;
13428 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13429 compute_window_start_on_continuation_line (w
);
13430 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13435 debug_method_add (w
, "same window start");
13438 /* Try to redisplay starting at same place as before.
13439 If point has not moved off frame, accept the results. */
13440 if (!current_matrix_up_to_date_p
13441 /* Don't use try_window_reusing_current_matrix in this case
13442 because a window scroll function can have changed the
13444 || !NILP (Vwindow_scroll_functions
)
13445 || MINI_WINDOW_P (w
)
13446 || !(used_current_matrix_p
13447 = try_window_reusing_current_matrix (w
)))
13449 IF_DEBUG (debug_method_add (w
, "1"));
13450 if (try_window (window
, startp
, 1) < 0)
13451 /* -1 means we need to scroll.
13452 0 means we need new matrices, but fonts_changed_p
13453 is set in that case, so we will detect it below. */
13454 goto try_to_scroll
;
13457 if (fonts_changed_p
)
13458 goto need_larger_matrices
;
13460 if (w
->cursor
.vpos
>= 0)
13462 if (!just_this_one_p
13463 || current_buffer
->clip_changed
13464 || BEG_UNCHANGED
< CHARPOS (startp
))
13465 /* Forget any recorded base line for line number display. */
13466 w
->base_line_number
= Qnil
;
13468 if (!cursor_row_fully_visible_p (w
, 1, 0))
13470 clear_glyph_matrix (w
->desired_matrix
);
13471 last_line_misfit
= 1;
13473 /* Drop through and scroll. */
13478 clear_glyph_matrix (w
->desired_matrix
);
13483 w
->last_modified
= make_number (0);
13484 w
->last_overlay_modified
= make_number (0);
13486 /* Redisplay the mode line. Select the buffer properly for that. */
13487 if (!update_mode_line
)
13489 update_mode_line
= 1;
13490 w
->update_mode_line
= Qt
;
13493 /* Try to scroll by specified few lines. */
13494 if ((scroll_conservatively
13496 || temp_scroll_step
13497 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13498 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13499 && !current_buffer
->clip_changed
13500 && CHARPOS (startp
) >= BEGV
13501 && CHARPOS (startp
) <= ZV
)
13503 /* The function returns -1 if new fonts were loaded, 1 if
13504 successful, 0 if not successful. */
13505 int rc
= try_scrolling (window
, just_this_one_p
,
13506 scroll_conservatively
,
13508 temp_scroll_step
, last_line_misfit
);
13511 case SCROLLING_SUCCESS
:
13514 case SCROLLING_NEED_LARGER_MATRICES
:
13515 goto need_larger_matrices
;
13517 case SCROLLING_FAILED
:
13525 /* Finally, just choose place to start which centers point */
13528 if (centering_position
< 0)
13529 centering_position
= window_box_height (w
) / 2;
13532 debug_method_add (w
, "recenter");
13535 /* w->vscroll = 0; */
13537 /* Forget any previously recorded base line for line number display. */
13538 if (!buffer_unchanged_p
)
13539 w
->base_line_number
= Qnil
;
13541 /* Move backward half the height of the window. */
13542 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13543 it
.current_y
= it
.last_visible_y
;
13544 move_it_vertically_backward (&it
, centering_position
);
13545 xassert (IT_CHARPOS (it
) >= BEGV
);
13547 /* The function move_it_vertically_backward may move over more
13548 than the specified y-distance. If it->w is small, e.g. a
13549 mini-buffer window, we may end up in front of the window's
13550 display area. Start displaying at the start of the line
13551 containing PT in this case. */
13552 if (it
.current_y
<= 0)
13554 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13555 move_it_vertically_backward (&it
, 0);
13557 /* I think this assert is bogus if buffer contains
13558 invisible text or images. KFS. */
13559 xassert (IT_CHARPOS (it
) <= PT
);
13564 it
.current_x
= it
.hpos
= 0;
13566 /* Set startp here explicitly in case that helps avoid an infinite loop
13567 in case the window-scroll-functions functions get errors. */
13568 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13570 /* Run scroll hooks. */
13571 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13573 /* Redisplay the window. */
13574 if (!current_matrix_up_to_date_p
13575 || windows_or_buffers_changed
13576 || cursor_type_changed
13577 /* Don't use try_window_reusing_current_matrix in this case
13578 because it can have changed the buffer. */
13579 || !NILP (Vwindow_scroll_functions
)
13580 || !just_this_one_p
13581 || MINI_WINDOW_P (w
)
13582 || !(used_current_matrix_p
13583 = try_window_reusing_current_matrix (w
)))
13584 try_window (window
, startp
, 0);
13586 /* If new fonts have been loaded (due to fontsets), give up. We
13587 have to start a new redisplay since we need to re-adjust glyph
13589 if (fonts_changed_p
)
13590 goto need_larger_matrices
;
13592 /* If cursor did not appear assume that the middle of the window is
13593 in the first line of the window. Do it again with the next line.
13594 (Imagine a window of height 100, displaying two lines of height
13595 60. Moving back 50 from it->last_visible_y will end in the first
13597 if (w
->cursor
.vpos
< 0)
13599 if (!NILP (w
->window_end_valid
)
13600 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13602 clear_glyph_matrix (w
->desired_matrix
);
13603 move_it_by_lines (&it
, 1, 0);
13604 try_window (window
, it
.current
.pos
, 0);
13606 else if (PT
< IT_CHARPOS (it
))
13608 clear_glyph_matrix (w
->desired_matrix
);
13609 move_it_by_lines (&it
, -1, 0);
13610 try_window (window
, it
.current
.pos
, 0);
13614 /* Not much we can do about it. */
13618 /* Consider the following case: Window starts at BEGV, there is
13619 invisible, intangible text at BEGV, so that display starts at
13620 some point START > BEGV. It can happen that we are called with
13621 PT somewhere between BEGV and START. Try to handle that case. */
13622 if (w
->cursor
.vpos
< 0)
13624 struct glyph_row
*row
= w
->current_matrix
->rows
;
13625 if (row
->mode_line_p
)
13627 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13630 if (!cursor_row_fully_visible_p (w
, 0, 0))
13632 /* If vscroll is enabled, disable it and try again. */
13636 clear_glyph_matrix (w
->desired_matrix
);
13640 /* If centering point failed to make the whole line visible,
13641 put point at the top instead. That has to make the whole line
13642 visible, if it can be done. */
13643 if (centering_position
== 0)
13646 clear_glyph_matrix (w
->desired_matrix
);
13647 centering_position
= 0;
13653 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13654 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13655 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13658 /* Display the mode line, if we must. */
13659 if ((update_mode_line
13660 /* If window not full width, must redo its mode line
13661 if (a) the window to its side is being redone and
13662 (b) we do a frame-based redisplay. This is a consequence
13663 of how inverted lines are drawn in frame-based redisplay. */
13664 || (!just_this_one_p
13665 && !FRAME_WINDOW_P (f
)
13666 && !WINDOW_FULL_WIDTH_P (w
))
13667 /* Line number to display. */
13668 || INTEGERP (w
->base_line_pos
)
13669 /* Column number is displayed and different from the one displayed. */
13670 || (!NILP (w
->column_number_displayed
)
13671 && (XFASTINT (w
->column_number_displayed
)
13672 != (int) current_column ()))) /* iftc */
13673 /* This means that the window has a mode line. */
13674 && (WINDOW_WANTS_MODELINE_P (w
)
13675 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13677 display_mode_lines (w
);
13679 /* If mode line height has changed, arrange for a thorough
13680 immediate redisplay using the correct mode line height. */
13681 if (WINDOW_WANTS_MODELINE_P (w
)
13682 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13684 fonts_changed_p
= 1;
13685 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13686 = DESIRED_MODE_LINE_HEIGHT (w
);
13689 /* If top line height has changed, arrange for a thorough
13690 immediate redisplay using the correct mode line height. */
13691 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13692 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13694 fonts_changed_p
= 1;
13695 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13696 = DESIRED_HEADER_LINE_HEIGHT (w
);
13699 if (fonts_changed_p
)
13700 goto need_larger_matrices
;
13703 if (!line_number_displayed
13704 && !BUFFERP (w
->base_line_pos
))
13706 w
->base_line_pos
= Qnil
;
13707 w
->base_line_number
= Qnil
;
13712 /* When we reach a frame's selected window, redo the frame's menu bar. */
13713 if (update_mode_line
13714 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13716 int redisplay_menu_p
= 0;
13717 int redisplay_tool_bar_p
= 0;
13719 if (FRAME_WINDOW_P (f
))
13721 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
13722 || defined (USE_GTK)
13723 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13725 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13729 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13731 if (redisplay_menu_p
)
13732 display_menu_bar (w
);
13734 #ifdef HAVE_WINDOW_SYSTEM
13735 if (FRAME_WINDOW_P (f
))
13737 #if defined (USE_GTK) || USE_MAC_TOOLBAR
13738 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13740 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13741 && (FRAME_TOOL_BAR_LINES (f
) > 0
13742 || !NILP (Vauto_resize_tool_bars
));
13745 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13747 extern int ignore_mouse_drag_p
;
13748 ignore_mouse_drag_p
= 1;
13754 #ifdef HAVE_WINDOW_SYSTEM
13755 if (FRAME_WINDOW_P (f
)
13756 && update_window_fringes (w
, (just_this_one_p
13757 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13758 || w
->pseudo_window_p
)))
13762 if (draw_window_fringes (w
, 1))
13763 x_draw_vertical_border (w
);
13767 #endif /* HAVE_WINDOW_SYSTEM */
13769 /* We go to this label, with fonts_changed_p nonzero,
13770 if it is necessary to try again using larger glyph matrices.
13771 We have to redeem the scroll bar even in this case,
13772 because the loop in redisplay_internal expects that. */
13773 need_larger_matrices
:
13775 finish_scroll_bars
:
13777 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13779 /* Set the thumb's position and size. */
13780 set_vertical_scroll_bar (w
);
13782 /* Note that we actually used the scroll bar attached to this
13783 window, so it shouldn't be deleted at the end of redisplay. */
13784 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13785 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13788 /* Restore current_buffer and value of point in it. */
13789 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13790 set_buffer_internal_1 (old
);
13791 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13792 shorter. This can be caused by log truncation in *Messages*. */
13793 if (CHARPOS (lpoint
) <= ZV
)
13794 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13796 unbind_to (count
, Qnil
);
13800 /* Build the complete desired matrix of WINDOW with a window start
13801 buffer position POS.
13803 Value is 1 if successful. It is zero if fonts were loaded during
13804 redisplay which makes re-adjusting glyph matrices necessary, and -1
13805 if point would appear in the scroll margins.
13806 (We check that only if CHECK_MARGINS is nonzero. */
13809 try_window (window
, pos
, check_margins
)
13810 Lisp_Object window
;
13811 struct text_pos pos
;
13814 struct window
*w
= XWINDOW (window
);
13816 struct glyph_row
*last_text_row
= NULL
;
13817 struct frame
*f
= XFRAME (w
->frame
);
13819 /* Make POS the new window start. */
13820 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13822 /* Mark cursor position as unknown. No overlay arrow seen. */
13823 w
->cursor
.vpos
= -1;
13824 overlay_arrow_seen
= 0;
13826 /* Initialize iterator and info to start at POS. */
13827 start_display (&it
, w
, pos
);
13829 /* Display all lines of W. */
13830 while (it
.current_y
< it
.last_visible_y
)
13832 if (display_line (&it
))
13833 last_text_row
= it
.glyph_row
- 1;
13834 if (fonts_changed_p
)
13838 /* Don't let the cursor end in the scroll margins. */
13840 && !MINI_WINDOW_P (w
))
13842 int this_scroll_margin
;
13844 this_scroll_margin
= max (0, scroll_margin
);
13845 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13846 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13848 if ((w
->cursor
.y
>= 0 /* not vscrolled */
13849 && w
->cursor
.y
< this_scroll_margin
13850 && CHARPOS (pos
) > BEGV
13851 && IT_CHARPOS (it
) < ZV
)
13852 /* rms: considering make_cursor_line_fully_visible_p here
13853 seems to give wrong results. We don't want to recenter
13854 when the last line is partly visible, we want to allow
13855 that case to be handled in the usual way. */
13856 || (w
->cursor
.y
+ 1) > it
.last_visible_y
)
13858 w
->cursor
.vpos
= -1;
13859 clear_glyph_matrix (w
->desired_matrix
);
13864 /* If bottom moved off end of frame, change mode line percentage. */
13865 if (XFASTINT (w
->window_end_pos
) <= 0
13866 && Z
!= IT_CHARPOS (it
))
13867 w
->update_mode_line
= Qt
;
13869 /* Set window_end_pos to the offset of the last character displayed
13870 on the window from the end of current_buffer. Set
13871 window_end_vpos to its row number. */
13874 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
13875 w
->window_end_bytepos
13876 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13878 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13880 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13881 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
13882 ->displays_text_p
);
13886 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
13887 w
->window_end_pos
= make_number (Z
- ZV
);
13888 w
->window_end_vpos
= make_number (0);
13891 /* But that is not valid info until redisplay finishes. */
13892 w
->window_end_valid
= Qnil
;
13898 /************************************************************************
13899 Window redisplay reusing current matrix when buffer has not changed
13900 ************************************************************************/
13902 /* Try redisplay of window W showing an unchanged buffer with a
13903 different window start than the last time it was displayed by
13904 reusing its current matrix. Value is non-zero if successful.
13905 W->start is the new window start. */
13908 try_window_reusing_current_matrix (w
)
13911 struct frame
*f
= XFRAME (w
->frame
);
13912 struct glyph_row
*row
, *bottom_row
;
13915 struct text_pos start
, new_start
;
13916 int nrows_scrolled
, i
;
13917 struct glyph_row
*last_text_row
;
13918 struct glyph_row
*last_reused_text_row
;
13919 struct glyph_row
*start_row
;
13920 int start_vpos
, min_y
, max_y
;
13923 if (inhibit_try_window_reusing
)
13927 if (/* This function doesn't handle terminal frames. */
13928 !FRAME_WINDOW_P (f
)
13929 /* Don't try to reuse the display if windows have been split
13931 || windows_or_buffers_changed
13932 || cursor_type_changed
)
13935 /* Can't do this if region may have changed. */
13936 if ((!NILP (Vtransient_mark_mode
)
13937 && !NILP (current_buffer
->mark_active
))
13938 || !NILP (w
->region_showing
)
13939 || !NILP (Vshow_trailing_whitespace
))
13942 /* If top-line visibility has changed, give up. */
13943 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13944 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
13947 /* Give up if old or new display is scrolled vertically. We could
13948 make this function handle this, but right now it doesn't. */
13949 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
13950 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
13953 /* The variable new_start now holds the new window start. The old
13954 start `start' can be determined from the current matrix. */
13955 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
13956 start
= start_row
->start
.pos
;
13957 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
13959 /* Clear the desired matrix for the display below. */
13960 clear_glyph_matrix (w
->desired_matrix
);
13962 if (CHARPOS (new_start
) <= CHARPOS (start
))
13966 /* Don't use this method if the display starts with an ellipsis
13967 displayed for invisible text. It's not easy to handle that case
13968 below, and it's certainly not worth the effort since this is
13969 not a frequent case. */
13970 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
13973 IF_DEBUG (debug_method_add (w
, "twu1"));
13975 /* Display up to a row that can be reused. The variable
13976 last_text_row is set to the last row displayed that displays
13977 text. Note that it.vpos == 0 if or if not there is a
13978 header-line; it's not the same as the MATRIX_ROW_VPOS! */
13979 start_display (&it
, w
, new_start
);
13980 first_row_y
= it
.current_y
;
13981 w
->cursor
.vpos
= -1;
13982 last_text_row
= last_reused_text_row
= NULL
;
13984 while (it
.current_y
< it
.last_visible_y
13985 && !fonts_changed_p
)
13987 /* If we have reached into the characters in the START row,
13988 that means the line boundaries have changed. So we
13989 can't start copying with the row START. Maybe it will
13990 work to start copying with the following row. */
13991 while (IT_CHARPOS (it
) > CHARPOS (start
))
13993 /* Advance to the next row as the "start". */
13995 start
= start_row
->start
.pos
;
13996 /* If there are no more rows to try, or just one, give up. */
13997 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
13998 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
13999 || CHARPOS (start
) == ZV
)
14001 clear_glyph_matrix (w
->desired_matrix
);
14005 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14007 /* If we have reached alignment,
14008 we can copy the rest of the rows. */
14009 if (IT_CHARPOS (it
) == CHARPOS (start
))
14012 if (display_line (&it
))
14013 last_text_row
= it
.glyph_row
- 1;
14016 /* A value of current_y < last_visible_y means that we stopped
14017 at the previous window start, which in turn means that we
14018 have at least one reusable row. */
14019 if (it
.current_y
< it
.last_visible_y
)
14021 /* IT.vpos always starts from 0; it counts text lines. */
14022 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14024 /* Find PT if not already found in the lines displayed. */
14025 if (w
->cursor
.vpos
< 0)
14027 int dy
= it
.current_y
- start_row
->y
;
14029 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14030 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14032 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14033 dy
, nrows_scrolled
);
14036 clear_glyph_matrix (w
->desired_matrix
);
14041 /* Scroll the display. Do it before the current matrix is
14042 changed. The problem here is that update has not yet
14043 run, i.e. part of the current matrix is not up to date.
14044 scroll_run_hook will clear the cursor, and use the
14045 current matrix to get the height of the row the cursor is
14047 run
.current_y
= start_row
->y
;
14048 run
.desired_y
= it
.current_y
;
14049 run
.height
= it
.last_visible_y
- it
.current_y
;
14051 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14054 FRAME_RIF (f
)->update_window_begin_hook (w
);
14055 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14056 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14057 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14061 /* Shift current matrix down by nrows_scrolled lines. */
14062 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14063 rotate_matrix (w
->current_matrix
,
14065 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14068 /* Disable lines that must be updated. */
14069 for (i
= 0; i
< nrows_scrolled
; ++i
)
14070 (start_row
+ i
)->enabled_p
= 0;
14072 /* Re-compute Y positions. */
14073 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14074 max_y
= it
.last_visible_y
;
14075 for (row
= start_row
+ nrows_scrolled
;
14079 row
->y
= it
.current_y
;
14080 row
->visible_height
= row
->height
;
14082 if (row
->y
< min_y
)
14083 row
->visible_height
-= min_y
- row
->y
;
14084 if (row
->y
+ row
->height
> max_y
)
14085 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14086 row
->redraw_fringe_bitmaps_p
= 1;
14088 it
.current_y
+= row
->height
;
14090 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14091 last_reused_text_row
= row
;
14092 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14096 /* Disable lines in the current matrix which are now
14097 below the window. */
14098 for (++row
; row
< bottom_row
; ++row
)
14099 row
->enabled_p
= row
->mode_line_p
= 0;
14102 /* Update window_end_pos etc.; last_reused_text_row is the last
14103 reused row from the current matrix containing text, if any.
14104 The value of last_text_row is the last displayed line
14105 containing text. */
14106 if (last_reused_text_row
)
14108 w
->window_end_bytepos
14109 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14111 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14113 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14114 w
->current_matrix
));
14116 else if (last_text_row
)
14118 w
->window_end_bytepos
14119 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14121 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14123 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14127 /* This window must be completely empty. */
14128 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14129 w
->window_end_pos
= make_number (Z
- ZV
);
14130 w
->window_end_vpos
= make_number (0);
14132 w
->window_end_valid
= Qnil
;
14134 /* Update hint: don't try scrolling again in update_window. */
14135 w
->desired_matrix
->no_scrolling_p
= 1;
14138 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14142 else if (CHARPOS (new_start
) > CHARPOS (start
))
14144 struct glyph_row
*pt_row
, *row
;
14145 struct glyph_row
*first_reusable_row
;
14146 struct glyph_row
*first_row_to_display
;
14148 int yb
= window_text_bottom_y (w
);
14150 /* Find the row starting at new_start, if there is one. Don't
14151 reuse a partially visible line at the end. */
14152 first_reusable_row
= start_row
;
14153 while (first_reusable_row
->enabled_p
14154 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14155 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14156 < CHARPOS (new_start
)))
14157 ++first_reusable_row
;
14159 /* Give up if there is no row to reuse. */
14160 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14161 || !first_reusable_row
->enabled_p
14162 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14163 != CHARPOS (new_start
)))
14166 /* We can reuse fully visible rows beginning with
14167 first_reusable_row to the end of the window. Set
14168 first_row_to_display to the first row that cannot be reused.
14169 Set pt_row to the row containing point, if there is any. */
14171 for (first_row_to_display
= first_reusable_row
;
14172 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14173 ++first_row_to_display
)
14175 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14176 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14177 pt_row
= first_row_to_display
;
14180 /* Start displaying at the start of first_row_to_display. */
14181 xassert (first_row_to_display
->y
< yb
);
14182 init_to_row_start (&it
, w
, first_row_to_display
);
14184 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14186 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14188 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14189 + WINDOW_HEADER_LINE_HEIGHT (w
));
14191 /* Display lines beginning with first_row_to_display in the
14192 desired matrix. Set last_text_row to the last row displayed
14193 that displays text. */
14194 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14195 if (pt_row
== NULL
)
14196 w
->cursor
.vpos
= -1;
14197 last_text_row
= NULL
;
14198 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14199 if (display_line (&it
))
14200 last_text_row
= it
.glyph_row
- 1;
14202 /* Give up If point isn't in a row displayed or reused. */
14203 if (w
->cursor
.vpos
< 0)
14205 clear_glyph_matrix (w
->desired_matrix
);
14209 /* If point is in a reused row, adjust y and vpos of the cursor
14213 w
->cursor
.vpos
-= nrows_scrolled
;
14214 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14217 /* Scroll the display. */
14218 run
.current_y
= first_reusable_row
->y
;
14219 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14220 run
.height
= it
.last_visible_y
- run
.current_y
;
14221 dy
= run
.current_y
- run
.desired_y
;
14226 FRAME_RIF (f
)->update_window_begin_hook (w
);
14227 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14228 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14229 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14233 /* Adjust Y positions of reused rows. */
14234 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14235 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14236 max_y
= it
.last_visible_y
;
14237 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14240 row
->visible_height
= row
->height
;
14241 if (row
->y
< min_y
)
14242 row
->visible_height
-= min_y
- row
->y
;
14243 if (row
->y
+ row
->height
> max_y
)
14244 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14245 row
->redraw_fringe_bitmaps_p
= 1;
14248 /* Scroll the current matrix. */
14249 xassert (nrows_scrolled
> 0);
14250 rotate_matrix (w
->current_matrix
,
14252 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14255 /* Disable rows not reused. */
14256 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14257 row
->enabled_p
= 0;
14259 /* Point may have moved to a different line, so we cannot assume that
14260 the previous cursor position is valid; locate the correct row. */
14263 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14264 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14268 w
->cursor
.y
= row
->y
;
14270 if (row
< bottom_row
)
14272 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14273 while (glyph
->charpos
< PT
)
14276 w
->cursor
.x
+= glyph
->pixel_width
;
14282 /* Adjust window end. A null value of last_text_row means that
14283 the window end is in reused rows which in turn means that
14284 only its vpos can have changed. */
14287 w
->window_end_bytepos
14288 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14290 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14292 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14297 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14300 w
->window_end_valid
= Qnil
;
14301 w
->desired_matrix
->no_scrolling_p
= 1;
14304 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14314 /************************************************************************
14315 Window redisplay reusing current matrix when buffer has changed
14316 ************************************************************************/
14318 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14319 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14321 static struct glyph_row
*
14322 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14323 struct glyph_row
*));
14326 /* Return the last row in MATRIX displaying text. If row START is
14327 non-null, start searching with that row. IT gives the dimensions
14328 of the display. Value is null if matrix is empty; otherwise it is
14329 a pointer to the row found. */
14331 static struct glyph_row
*
14332 find_last_row_displaying_text (matrix
, it
, start
)
14333 struct glyph_matrix
*matrix
;
14335 struct glyph_row
*start
;
14337 struct glyph_row
*row
, *row_found
;
14339 /* Set row_found to the last row in IT->w's current matrix
14340 displaying text. The loop looks funny but think of partially
14343 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14344 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14346 xassert (row
->enabled_p
);
14348 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14357 /* Return the last row in the current matrix of W that is not affected
14358 by changes at the start of current_buffer that occurred since W's
14359 current matrix was built. Value is null if no such row exists.
14361 BEG_UNCHANGED us the number of characters unchanged at the start of
14362 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14363 first changed character in current_buffer. Characters at positions <
14364 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14365 when the current matrix was built. */
14367 static struct glyph_row
*
14368 find_last_unchanged_at_beg_row (w
)
14371 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14372 struct glyph_row
*row
;
14373 struct glyph_row
*row_found
= NULL
;
14374 int yb
= window_text_bottom_y (w
);
14376 /* Find the last row displaying unchanged text. */
14377 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14378 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14379 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
14381 if (/* If row ends before first_changed_pos, it is unchanged,
14382 except in some case. */
14383 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14384 /* When row ends in ZV and we write at ZV it is not
14386 && !row
->ends_at_zv_p
14387 /* When first_changed_pos is the end of a continued line,
14388 row is not unchanged because it may be no longer
14390 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14391 && (row
->continued_p
14392 || row
->exact_window_width_line_p
)))
14395 /* Stop if last visible row. */
14396 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14406 /* Find the first glyph row in the current matrix of W that is not
14407 affected by changes at the end of current_buffer since the
14408 time W's current matrix was built.
14410 Return in *DELTA the number of chars by which buffer positions in
14411 unchanged text at the end of current_buffer must be adjusted.
14413 Return in *DELTA_BYTES the corresponding number of bytes.
14415 Value is null if no such row exists, i.e. all rows are affected by
14418 static struct glyph_row
*
14419 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14421 int *delta
, *delta_bytes
;
14423 struct glyph_row
*row
;
14424 struct glyph_row
*row_found
= NULL
;
14426 *delta
= *delta_bytes
= 0;
14428 /* Display must not have been paused, otherwise the current matrix
14429 is not up to date. */
14430 if (NILP (w
->window_end_valid
))
14433 /* A value of window_end_pos >= END_UNCHANGED means that the window
14434 end is in the range of changed text. If so, there is no
14435 unchanged row at the end of W's current matrix. */
14436 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14439 /* Set row to the last row in W's current matrix displaying text. */
14440 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14442 /* If matrix is entirely empty, no unchanged row exists. */
14443 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14445 /* The value of row is the last glyph row in the matrix having a
14446 meaningful buffer position in it. The end position of row
14447 corresponds to window_end_pos. This allows us to translate
14448 buffer positions in the current matrix to current buffer
14449 positions for characters not in changed text. */
14450 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14451 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14452 int last_unchanged_pos
, last_unchanged_pos_old
;
14453 struct glyph_row
*first_text_row
14454 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14456 *delta
= Z
- Z_old
;
14457 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14459 /* Set last_unchanged_pos to the buffer position of the last
14460 character in the buffer that has not been changed. Z is the
14461 index + 1 of the last character in current_buffer, i.e. by
14462 subtracting END_UNCHANGED we get the index of the last
14463 unchanged character, and we have to add BEG to get its buffer
14465 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14466 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14468 /* Search backward from ROW for a row displaying a line that
14469 starts at a minimum position >= last_unchanged_pos_old. */
14470 for (; row
> first_text_row
; --row
)
14472 /* This used to abort, but it can happen.
14473 It is ok to just stop the search instead here. KFS. */
14474 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14477 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14482 if (row_found
&& !MATRIX_ROW_DISPLAYS_TEXT_P (row_found
))
14489 /* Make sure that glyph rows in the current matrix of window W
14490 reference the same glyph memory as corresponding rows in the
14491 frame's frame matrix. This function is called after scrolling W's
14492 current matrix on a terminal frame in try_window_id and
14493 try_window_reusing_current_matrix. */
14496 sync_frame_with_window_matrix_rows (w
)
14499 struct frame
*f
= XFRAME (w
->frame
);
14500 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14502 /* Preconditions: W must be a leaf window and full-width. Its frame
14503 must have a frame matrix. */
14504 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14505 xassert (WINDOW_FULL_WIDTH_P (w
));
14506 xassert (!FRAME_WINDOW_P (f
));
14508 /* If W is a full-width window, glyph pointers in W's current matrix
14509 have, by definition, to be the same as glyph pointers in the
14510 corresponding frame matrix. Note that frame matrices have no
14511 marginal areas (see build_frame_matrix). */
14512 window_row
= w
->current_matrix
->rows
;
14513 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14514 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14515 while (window_row
< window_row_end
)
14517 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14518 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14520 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14521 frame_row
->glyphs
[TEXT_AREA
] = start
;
14522 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14523 frame_row
->glyphs
[LAST_AREA
] = end
;
14525 /* Disable frame rows whose corresponding window rows have
14526 been disabled in try_window_id. */
14527 if (!window_row
->enabled_p
)
14528 frame_row
->enabled_p
= 0;
14530 ++window_row
, ++frame_row
;
14535 /* Find the glyph row in window W containing CHARPOS. Consider all
14536 rows between START and END (not inclusive). END null means search
14537 all rows to the end of the display area of W. Value is the row
14538 containing CHARPOS or null. */
14541 row_containing_pos (w
, charpos
, start
, end
, dy
)
14544 struct glyph_row
*start
, *end
;
14547 struct glyph_row
*row
= start
;
14550 /* If we happen to start on a header-line, skip that. */
14551 if (row
->mode_line_p
)
14554 if ((end
&& row
>= end
) || !row
->enabled_p
)
14557 last_y
= window_text_bottom_y (w
) - dy
;
14561 /* Give up if we have gone too far. */
14562 if (end
&& row
>= end
)
14564 /* This formerly returned if they were equal.
14565 I think that both quantities are of a "last plus one" type;
14566 if so, when they are equal, the row is within the screen. -- rms. */
14567 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14570 /* If it is in this row, return this row. */
14571 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14572 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14573 /* The end position of a row equals the start
14574 position of the next row. If CHARPOS is there, we
14575 would rather display it in the next line, except
14576 when this line ends in ZV. */
14577 && !row
->ends_at_zv_p
14578 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14579 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14586 /* Try to redisplay window W by reusing its existing display. W's
14587 current matrix must be up to date when this function is called,
14588 i.e. window_end_valid must not be nil.
14592 1 if display has been updated
14593 0 if otherwise unsuccessful
14594 -1 if redisplay with same window start is known not to succeed
14596 The following steps are performed:
14598 1. Find the last row in the current matrix of W that is not
14599 affected by changes at the start of current_buffer. If no such row
14602 2. Find the first row in W's current matrix that is not affected by
14603 changes at the end of current_buffer. Maybe there is no such row.
14605 3. Display lines beginning with the row + 1 found in step 1 to the
14606 row found in step 2 or, if step 2 didn't find a row, to the end of
14609 4. If cursor is not known to appear on the window, give up.
14611 5. If display stopped at the row found in step 2, scroll the
14612 display and current matrix as needed.
14614 6. Maybe display some lines at the end of W, if we must. This can
14615 happen under various circumstances, like a partially visible line
14616 becoming fully visible, or because newly displayed lines are displayed
14617 in smaller font sizes.
14619 7. Update W's window end information. */
14625 struct frame
*f
= XFRAME (w
->frame
);
14626 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14627 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14628 struct glyph_row
*last_unchanged_at_beg_row
;
14629 struct glyph_row
*first_unchanged_at_end_row
;
14630 struct glyph_row
*row
;
14631 struct glyph_row
*bottom_row
;
14634 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14635 struct text_pos start_pos
;
14637 int first_unchanged_at_end_vpos
= 0;
14638 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14639 struct text_pos start
;
14640 int first_changed_charpos
, last_changed_charpos
;
14643 if (inhibit_try_window_id
)
14647 /* This is handy for debugging. */
14649 #define GIVE_UP(X) \
14651 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14655 #define GIVE_UP(X) return 0
14658 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14660 /* Don't use this for mini-windows because these can show
14661 messages and mini-buffers, and we don't handle that here. */
14662 if (MINI_WINDOW_P (w
))
14665 /* This flag is used to prevent redisplay optimizations. */
14666 if (windows_or_buffers_changed
|| cursor_type_changed
)
14669 /* Verify that narrowing has not changed.
14670 Also verify that we were not told to prevent redisplay optimizations.
14671 It would be nice to further
14672 reduce the number of cases where this prevents try_window_id. */
14673 if (current_buffer
->clip_changed
14674 || current_buffer
->prevent_redisplay_optimizations_p
)
14677 /* Window must either use window-based redisplay or be full width. */
14678 if (!FRAME_WINDOW_P (f
)
14679 && (!FRAME_LINE_INS_DEL_OK (f
)
14680 || !WINDOW_FULL_WIDTH_P (w
)))
14683 /* Give up if point is not known NOT to appear in W. */
14684 if (PT
< CHARPOS (start
))
14687 /* Another way to prevent redisplay optimizations. */
14688 if (XFASTINT (w
->last_modified
) == 0)
14691 /* Verify that window is not hscrolled. */
14692 if (XFASTINT (w
->hscroll
) != 0)
14695 /* Verify that display wasn't paused. */
14696 if (NILP (w
->window_end_valid
))
14699 /* Can't use this if highlighting a region because a cursor movement
14700 will do more than just set the cursor. */
14701 if (!NILP (Vtransient_mark_mode
)
14702 && !NILP (current_buffer
->mark_active
))
14705 /* Likewise if highlighting trailing whitespace. */
14706 if (!NILP (Vshow_trailing_whitespace
))
14709 /* Likewise if showing a region. */
14710 if (!NILP (w
->region_showing
))
14713 /* Can use this if overlay arrow position and or string have changed. */
14714 if (overlay_arrows_changed_p ())
14718 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14719 only if buffer has really changed. The reason is that the gap is
14720 initially at Z for freshly visited files. The code below would
14721 set end_unchanged to 0 in that case. */
14722 if (MODIFF
> SAVE_MODIFF
14723 /* This seems to happen sometimes after saving a buffer. */
14724 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14726 if (GPT
- BEG
< BEG_UNCHANGED
)
14727 BEG_UNCHANGED
= GPT
- BEG
;
14728 if (Z
- GPT
< END_UNCHANGED
)
14729 END_UNCHANGED
= Z
- GPT
;
14732 /* The position of the first and last character that has been changed. */
14733 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14734 last_changed_charpos
= Z
- END_UNCHANGED
;
14736 /* If window starts after a line end, and the last change is in
14737 front of that newline, then changes don't affect the display.
14738 This case happens with stealth-fontification. Note that although
14739 the display is unchanged, glyph positions in the matrix have to
14740 be adjusted, of course. */
14741 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14742 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14743 && ((last_changed_charpos
< CHARPOS (start
)
14744 && CHARPOS (start
) == BEGV
)
14745 || (last_changed_charpos
< CHARPOS (start
) - 1
14746 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14748 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14749 struct glyph_row
*r0
;
14751 /* Compute how many chars/bytes have been added to or removed
14752 from the buffer. */
14753 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14754 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14756 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14758 /* Give up if PT is not in the window. Note that it already has
14759 been checked at the start of try_window_id that PT is not in
14760 front of the window start. */
14761 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14764 /* If window start is unchanged, we can reuse the whole matrix
14765 as is, after adjusting glyph positions. No need to compute
14766 the window end again, since its offset from Z hasn't changed. */
14767 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14768 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14769 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14770 /* PT must not be in a partially visible line. */
14771 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14772 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14774 /* Adjust positions in the glyph matrix. */
14775 if (delta
|| delta_bytes
)
14777 struct glyph_row
*r1
14778 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14779 increment_matrix_positions (w
->current_matrix
,
14780 MATRIX_ROW_VPOS (r0
, current_matrix
),
14781 MATRIX_ROW_VPOS (r1
, current_matrix
),
14782 delta
, delta_bytes
);
14785 /* Set the cursor. */
14786 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14788 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14795 /* Handle the case that changes are all below what is displayed in
14796 the window, and that PT is in the window. This shortcut cannot
14797 be taken if ZV is visible in the window, and text has been added
14798 there that is visible in the window. */
14799 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14800 /* ZV is not visible in the window, or there are no
14801 changes at ZV, actually. */
14802 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14803 || first_changed_charpos
== last_changed_charpos
))
14805 struct glyph_row
*r0
;
14807 /* Give up if PT is not in the window. Note that it already has
14808 been checked at the start of try_window_id that PT is not in
14809 front of the window start. */
14810 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14813 /* If window start is unchanged, we can reuse the whole matrix
14814 as is, without changing glyph positions since no text has
14815 been added/removed in front of the window end. */
14816 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14817 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14818 /* PT must not be in a partially visible line. */
14819 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14820 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14822 /* We have to compute the window end anew since text
14823 can have been added/removed after it. */
14825 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14826 w
->window_end_bytepos
14827 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14829 /* Set the cursor. */
14830 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14832 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14839 /* Give up if window start is in the changed area.
14841 The condition used to read
14843 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
14845 but why that was tested escapes me at the moment. */
14846 if (CHARPOS (start
) >= first_changed_charpos
14847 && CHARPOS (start
) <= last_changed_charpos
)
14850 /* Check that window start agrees with the start of the first glyph
14851 row in its current matrix. Check this after we know the window
14852 start is not in changed text, otherwise positions would not be
14854 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14855 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
14858 /* Give up if the window ends in strings. Overlay strings
14859 at the end are difficult to handle, so don't try. */
14860 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
14861 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
14864 /* Compute the position at which we have to start displaying new
14865 lines. Some of the lines at the top of the window might be
14866 reusable because they are not displaying changed text. Find the
14867 last row in W's current matrix not affected by changes at the
14868 start of current_buffer. Value is null if changes start in the
14869 first line of window. */
14870 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
14871 if (last_unchanged_at_beg_row
)
14873 /* Avoid starting to display in the moddle of a character, a TAB
14874 for instance. This is easier than to set up the iterator
14875 exactly, and it's not a frequent case, so the additional
14876 effort wouldn't really pay off. */
14877 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
14878 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
14879 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
14880 --last_unchanged_at_beg_row
;
14882 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
14885 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
14887 start_pos
= it
.current
.pos
;
14889 /* Start displaying new lines in the desired matrix at the same
14890 vpos we would use in the current matrix, i.e. below
14891 last_unchanged_at_beg_row. */
14892 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
14894 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
14895 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
14897 xassert (it
.hpos
== 0 && it
.current_x
== 0);
14901 /* There are no reusable lines at the start of the window.
14902 Start displaying in the first text line. */
14903 start_display (&it
, w
, start
);
14904 it
.vpos
= it
.first_vpos
;
14905 start_pos
= it
.current
.pos
;
14908 /* Find the first row that is not affected by changes at the end of
14909 the buffer. Value will be null if there is no unchanged row, in
14910 which case we must redisplay to the end of the window. delta
14911 will be set to the value by which buffer positions beginning with
14912 first_unchanged_at_end_row have to be adjusted due to text
14914 first_unchanged_at_end_row
14915 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
14916 IF_DEBUG (debug_delta
= delta
);
14917 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
14919 /* Set stop_pos to the buffer position up to which we will have to
14920 display new lines. If first_unchanged_at_end_row != NULL, this
14921 is the buffer position of the start of the line displayed in that
14922 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
14923 that we don't stop at a buffer position. */
14925 if (first_unchanged_at_end_row
)
14927 xassert (last_unchanged_at_beg_row
== NULL
14928 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
14930 /* If this is a continuation line, move forward to the next one
14931 that isn't. Changes in lines above affect this line.
14932 Caution: this may move first_unchanged_at_end_row to a row
14933 not displaying text. */
14934 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
14935 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14936 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14937 < it
.last_visible_y
))
14938 ++first_unchanged_at_end_row
;
14940 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14941 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14942 >= it
.last_visible_y
))
14943 first_unchanged_at_end_row
= NULL
;
14946 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
14948 first_unchanged_at_end_vpos
14949 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
14950 xassert (stop_pos
>= Z
- END_UNCHANGED
);
14953 else if (last_unchanged_at_beg_row
== NULL
)
14959 /* Either there is no unchanged row at the end, or the one we have
14960 now displays text. This is a necessary condition for the window
14961 end pos calculation at the end of this function. */
14962 xassert (first_unchanged_at_end_row
== NULL
14963 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
14965 debug_last_unchanged_at_beg_vpos
14966 = (last_unchanged_at_beg_row
14967 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
14969 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
14971 #endif /* GLYPH_DEBUG != 0 */
14974 /* Display new lines. Set last_text_row to the last new line
14975 displayed which has text on it, i.e. might end up as being the
14976 line where the window_end_vpos is. */
14977 w
->cursor
.vpos
= -1;
14978 last_text_row
= NULL
;
14979 overlay_arrow_seen
= 0;
14980 while (it
.current_y
< it
.last_visible_y
14981 && !fonts_changed_p
14982 && (first_unchanged_at_end_row
== NULL
14983 || IT_CHARPOS (it
) < stop_pos
))
14985 if (display_line (&it
))
14986 last_text_row
= it
.glyph_row
- 1;
14989 if (fonts_changed_p
)
14993 /* Compute differences in buffer positions, y-positions etc. for
14994 lines reused at the bottom of the window. Compute what we can
14996 if (first_unchanged_at_end_row
14997 /* No lines reused because we displayed everything up to the
14998 bottom of the window. */
14999 && it
.current_y
< it
.last_visible_y
)
15002 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15004 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15005 run
.current_y
= first_unchanged_at_end_row
->y
;
15006 run
.desired_y
= run
.current_y
+ dy
;
15007 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15011 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
15012 first_unchanged_at_end_row
= NULL
;
15014 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15017 /* Find the cursor if not already found. We have to decide whether
15018 PT will appear on this window (it sometimes doesn't, but this is
15019 not a very frequent case.) This decision has to be made before
15020 the current matrix is altered. A value of cursor.vpos < 0 means
15021 that PT is either in one of the lines beginning at
15022 first_unchanged_at_end_row or below the window. Don't care for
15023 lines that might be displayed later at the window end; as
15024 mentioned, this is not a frequent case. */
15025 if (w
->cursor
.vpos
< 0)
15027 /* Cursor in unchanged rows at the top? */
15028 if (PT
< CHARPOS (start_pos
)
15029 && last_unchanged_at_beg_row
)
15031 row
= row_containing_pos (w
, PT
,
15032 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15033 last_unchanged_at_beg_row
+ 1, 0);
15035 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15038 /* Start from first_unchanged_at_end_row looking for PT. */
15039 else if (first_unchanged_at_end_row
)
15041 row
= row_containing_pos (w
, PT
- delta
,
15042 first_unchanged_at_end_row
, NULL
, 0);
15044 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15045 delta_bytes
, dy
, dvpos
);
15048 /* Give up if cursor was not found. */
15049 if (w
->cursor
.vpos
< 0)
15051 clear_glyph_matrix (w
->desired_matrix
);
15056 /* Don't let the cursor end in the scroll margins. */
15058 int this_scroll_margin
, cursor_height
;
15060 this_scroll_margin
= max (0, scroll_margin
);
15061 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15062 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15063 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15065 if ((w
->cursor
.y
< this_scroll_margin
15066 && CHARPOS (start
) > BEGV
)
15067 /* Old redisplay didn't take scroll margin into account at the bottom,
15068 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15069 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15070 ? cursor_height
+ this_scroll_margin
15071 : 1)) > it
.last_visible_y
)
15073 w
->cursor
.vpos
= -1;
15074 clear_glyph_matrix (w
->desired_matrix
);
15079 /* Scroll the display. Do it before changing the current matrix so
15080 that xterm.c doesn't get confused about where the cursor glyph is
15082 if (dy
&& run
.height
)
15086 if (FRAME_WINDOW_P (f
))
15088 FRAME_RIF (f
)->update_window_begin_hook (w
);
15089 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15090 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15091 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15095 /* Terminal frame. In this case, dvpos gives the number of
15096 lines to scroll by; dvpos < 0 means scroll up. */
15097 int first_unchanged_at_end_vpos
15098 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15099 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15100 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15101 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15102 + window_internal_height (w
));
15104 /* Perform the operation on the screen. */
15107 /* Scroll last_unchanged_at_beg_row to the end of the
15108 window down dvpos lines. */
15109 set_terminal_window (f
, end
);
15111 /* On dumb terminals delete dvpos lines at the end
15112 before inserting dvpos empty lines. */
15113 if (!FRAME_SCROLL_REGION_OK (f
))
15114 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15116 /* Insert dvpos empty lines in front of
15117 last_unchanged_at_beg_row. */
15118 ins_del_lines (f
, from
, dvpos
);
15120 else if (dvpos
< 0)
15122 /* Scroll up last_unchanged_at_beg_vpos to the end of
15123 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15124 set_terminal_window (f
, end
);
15126 /* Delete dvpos lines in front of
15127 last_unchanged_at_beg_vpos. ins_del_lines will set
15128 the cursor to the given vpos and emit |dvpos| delete
15130 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15132 /* On a dumb terminal insert dvpos empty lines at the
15134 if (!FRAME_SCROLL_REGION_OK (f
))
15135 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15138 set_terminal_window (f
, 0);
15144 /* Shift reused rows of the current matrix to the right position.
15145 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15147 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15148 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15151 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15152 bottom_vpos
, dvpos
);
15153 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15156 else if (dvpos
> 0)
15158 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15159 bottom_vpos
, dvpos
);
15160 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15161 first_unchanged_at_end_vpos
+ dvpos
, 0);
15164 /* For frame-based redisplay, make sure that current frame and window
15165 matrix are in sync with respect to glyph memory. */
15166 if (!FRAME_WINDOW_P (f
))
15167 sync_frame_with_window_matrix_rows (w
);
15169 /* Adjust buffer positions in reused rows. */
15170 if (delta
|| delta_bytes
)
15171 increment_matrix_positions (current_matrix
,
15172 first_unchanged_at_end_vpos
+ dvpos
,
15173 bottom_vpos
, delta
, delta_bytes
);
15175 /* Adjust Y positions. */
15177 shift_glyph_matrix (w
, current_matrix
,
15178 first_unchanged_at_end_vpos
+ dvpos
,
15181 if (first_unchanged_at_end_row
)
15183 first_unchanged_at_end_row
+= dvpos
;
15184 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15185 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15186 first_unchanged_at_end_row
= NULL
;
15189 /* If scrolling up, there may be some lines to display at the end of
15191 last_text_row_at_end
= NULL
;
15194 /* Scrolling up can leave for example a partially visible line
15195 at the end of the window to be redisplayed. */
15196 /* Set last_row to the glyph row in the current matrix where the
15197 window end line is found. It has been moved up or down in
15198 the matrix by dvpos. */
15199 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15200 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15202 /* If last_row is the window end line, it should display text. */
15203 xassert (last_row
->displays_text_p
);
15205 /* If window end line was partially visible before, begin
15206 displaying at that line. Otherwise begin displaying with the
15207 line following it. */
15208 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15210 init_to_row_start (&it
, w
, last_row
);
15211 it
.vpos
= last_vpos
;
15212 it
.current_y
= last_row
->y
;
15216 init_to_row_end (&it
, w
, last_row
);
15217 it
.vpos
= 1 + last_vpos
;
15218 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15222 /* We may start in a continuation line. If so, we have to
15223 get the right continuation_lines_width and current_x. */
15224 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15225 it
.hpos
= it
.current_x
= 0;
15227 /* Display the rest of the lines at the window end. */
15228 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15229 while (it
.current_y
< it
.last_visible_y
15230 && !fonts_changed_p
)
15232 /* Is it always sure that the display agrees with lines in
15233 the current matrix? I don't think so, so we mark rows
15234 displayed invalid in the current matrix by setting their
15235 enabled_p flag to zero. */
15236 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15237 if (display_line (&it
))
15238 last_text_row_at_end
= it
.glyph_row
- 1;
15242 /* Update window_end_pos and window_end_vpos. */
15243 if (first_unchanged_at_end_row
15244 && !last_text_row_at_end
)
15246 /* Window end line if one of the preserved rows from the current
15247 matrix. Set row to the last row displaying text in current
15248 matrix starting at first_unchanged_at_end_row, after
15250 xassert (first_unchanged_at_end_row
->displays_text_p
);
15251 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15252 first_unchanged_at_end_row
);
15253 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15255 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15256 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15258 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15259 xassert (w
->window_end_bytepos
>= 0);
15260 IF_DEBUG (debug_method_add (w
, "A"));
15262 else if (last_text_row_at_end
)
15265 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15266 w
->window_end_bytepos
15267 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15269 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15270 xassert (w
->window_end_bytepos
>= 0);
15271 IF_DEBUG (debug_method_add (w
, "B"));
15273 else if (last_text_row
)
15275 /* We have displayed either to the end of the window or at the
15276 end of the window, i.e. the last row with text is to be found
15277 in the desired matrix. */
15279 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15280 w
->window_end_bytepos
15281 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15283 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15284 xassert (w
->window_end_bytepos
>= 0);
15286 else if (first_unchanged_at_end_row
== NULL
15287 && last_text_row
== NULL
15288 && last_text_row_at_end
== NULL
)
15290 /* Displayed to end of window, but no line containing text was
15291 displayed. Lines were deleted at the end of the window. */
15292 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15293 int vpos
= XFASTINT (w
->window_end_vpos
);
15294 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15295 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15298 row
== NULL
&& vpos
>= first_vpos
;
15299 --vpos
, --current_row
, --desired_row
)
15301 if (desired_row
->enabled_p
)
15303 if (desired_row
->displays_text_p
)
15306 else if (current_row
->displays_text_p
)
15310 xassert (row
!= NULL
);
15311 w
->window_end_vpos
= make_number (vpos
+ 1);
15312 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15313 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15314 xassert (w
->window_end_bytepos
>= 0);
15315 IF_DEBUG (debug_method_add (w
, "C"));
15320 #if 0 /* This leads to problems, for instance when the cursor is
15321 at ZV, and the cursor line displays no text. */
15322 /* Disable rows below what's displayed in the window. This makes
15323 debugging easier. */
15324 enable_glyph_matrix_rows (current_matrix
,
15325 XFASTINT (w
->window_end_vpos
) + 1,
15329 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15330 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15332 /* Record that display has not been completed. */
15333 w
->window_end_valid
= Qnil
;
15334 w
->desired_matrix
->no_scrolling_p
= 1;
15342 /***********************************************************************
15343 More debugging support
15344 ***********************************************************************/
15348 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15349 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15350 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15353 /* Dump the contents of glyph matrix MATRIX on stderr.
15355 GLYPHS 0 means don't show glyph contents.
15356 GLYPHS 1 means show glyphs in short form
15357 GLYPHS > 1 means show glyphs in long form. */
15360 dump_glyph_matrix (matrix
, glyphs
)
15361 struct glyph_matrix
*matrix
;
15365 for (i
= 0; i
< matrix
->nrows
; ++i
)
15366 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15370 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15371 the glyph row and area where the glyph comes from. */
15374 dump_glyph (row
, glyph
, area
)
15375 struct glyph_row
*row
;
15376 struct glyph
*glyph
;
15379 if (glyph
->type
== CHAR_GLYPH
)
15382 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15383 glyph
- row
->glyphs
[TEXT_AREA
],
15386 (BUFFERP (glyph
->object
)
15388 : (STRINGP (glyph
->object
)
15391 glyph
->pixel_width
,
15393 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15397 glyph
->left_box_line_p
,
15398 glyph
->right_box_line_p
);
15400 else if (glyph
->type
== STRETCH_GLYPH
)
15403 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15404 glyph
- row
->glyphs
[TEXT_AREA
],
15407 (BUFFERP (glyph
->object
)
15409 : (STRINGP (glyph
->object
)
15412 glyph
->pixel_width
,
15416 glyph
->left_box_line_p
,
15417 glyph
->right_box_line_p
);
15419 else if (glyph
->type
== IMAGE_GLYPH
)
15422 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15423 glyph
- row
->glyphs
[TEXT_AREA
],
15426 (BUFFERP (glyph
->object
)
15428 : (STRINGP (glyph
->object
)
15431 glyph
->pixel_width
,
15435 glyph
->left_box_line_p
,
15436 glyph
->right_box_line_p
);
15438 else if (glyph
->type
== COMPOSITE_GLYPH
)
15441 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15442 glyph
- row
->glyphs
[TEXT_AREA
],
15445 (BUFFERP (glyph
->object
)
15447 : (STRINGP (glyph
->object
)
15450 glyph
->pixel_width
,
15454 glyph
->left_box_line_p
,
15455 glyph
->right_box_line_p
);
15460 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15461 GLYPHS 0 means don't show glyph contents.
15462 GLYPHS 1 means show glyphs in short form
15463 GLYPHS > 1 means show glyphs in long form. */
15466 dump_glyph_row (row
, vpos
, glyphs
)
15467 struct glyph_row
*row
;
15472 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15473 fprintf (stderr
, "======================================================================\n");
15475 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15476 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15478 MATRIX_ROW_START_CHARPOS (row
),
15479 MATRIX_ROW_END_CHARPOS (row
),
15480 row
->used
[TEXT_AREA
],
15481 row
->contains_overlapping_glyphs_p
,
15483 row
->truncated_on_left_p
,
15484 row
->truncated_on_right_p
,
15486 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15487 row
->displays_text_p
,
15490 row
->ends_in_middle_of_char_p
,
15491 row
->starts_in_middle_of_char_p
,
15497 row
->visible_height
,
15500 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15501 row
->end
.overlay_string_index
,
15502 row
->continuation_lines_width
);
15503 fprintf (stderr
, "%9d %5d\n",
15504 CHARPOS (row
->start
.string_pos
),
15505 CHARPOS (row
->end
.string_pos
));
15506 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15507 row
->end
.dpvec_index
);
15514 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15516 struct glyph
*glyph
= row
->glyphs
[area
];
15517 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15519 /* Glyph for a line end in text. */
15520 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15523 if (glyph
< glyph_end
)
15524 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15526 for (; glyph
< glyph_end
; ++glyph
)
15527 dump_glyph (row
, glyph
, area
);
15530 else if (glyphs
== 1)
15534 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15536 char *s
= (char *) alloca (row
->used
[area
] + 1);
15539 for (i
= 0; i
< row
->used
[area
]; ++i
)
15541 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15542 if (glyph
->type
== CHAR_GLYPH
15543 && glyph
->u
.ch
< 0x80
15544 && glyph
->u
.ch
>= ' ')
15545 s
[i
] = glyph
->u
.ch
;
15551 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15557 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15558 Sdump_glyph_matrix
, 0, 1, "p",
15559 doc
: /* Dump the current matrix of the selected window to stderr.
15560 Shows contents of glyph row structures. With non-nil
15561 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15562 glyphs in short form, otherwise show glyphs in long form. */)
15564 Lisp_Object glyphs
;
15566 struct window
*w
= XWINDOW (selected_window
);
15567 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15569 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15570 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15571 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15572 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15573 fprintf (stderr
, "=============================================\n");
15574 dump_glyph_matrix (w
->current_matrix
,
15575 NILP (glyphs
) ? 0 : XINT (glyphs
));
15580 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15581 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15584 struct frame
*f
= XFRAME (selected_frame
);
15585 dump_glyph_matrix (f
->current_matrix
, 1);
15590 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15591 doc
: /* Dump glyph row ROW to stderr.
15592 GLYPH 0 means don't dump glyphs.
15593 GLYPH 1 means dump glyphs in short form.
15594 GLYPH > 1 or omitted means dump glyphs in long form. */)
15596 Lisp_Object row
, glyphs
;
15598 struct glyph_matrix
*matrix
;
15601 CHECK_NUMBER (row
);
15602 matrix
= XWINDOW (selected_window
)->current_matrix
;
15604 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15605 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15607 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15612 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15613 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15614 GLYPH 0 means don't dump glyphs.
15615 GLYPH 1 means dump glyphs in short form.
15616 GLYPH > 1 or omitted means dump glyphs in long form. */)
15618 Lisp_Object row
, glyphs
;
15620 struct frame
*sf
= SELECTED_FRAME ();
15621 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15624 CHECK_NUMBER (row
);
15626 if (vpos
>= 0 && vpos
< m
->nrows
)
15627 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15628 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15633 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15634 doc
: /* Toggle tracing of redisplay.
15635 With ARG, turn tracing on if and only if ARG is positive. */)
15640 trace_redisplay_p
= !trace_redisplay_p
;
15643 arg
= Fprefix_numeric_value (arg
);
15644 trace_redisplay_p
= XINT (arg
) > 0;
15651 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15652 doc
: /* Like `format', but print result to stderr.
15653 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15658 Lisp_Object s
= Fformat (nargs
, args
);
15659 fprintf (stderr
, "%s", SDATA (s
));
15663 #endif /* GLYPH_DEBUG */
15667 /***********************************************************************
15668 Building Desired Matrix Rows
15669 ***********************************************************************/
15671 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15672 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15674 static struct glyph_row
*
15675 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15677 Lisp_Object overlay_arrow_string
;
15679 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15680 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15681 struct buffer
*old
= current_buffer
;
15682 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15683 int arrow_len
= SCHARS (overlay_arrow_string
);
15684 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15685 const unsigned char *p
;
15688 int n_glyphs_before
;
15690 set_buffer_temp (buffer
);
15691 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15692 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15693 SET_TEXT_POS (it
.position
, 0, 0);
15695 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15697 while (p
< arrow_end
)
15699 Lisp_Object face
, ilisp
;
15701 /* Get the next character. */
15703 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15705 it
.c
= *p
, it
.len
= 1;
15708 /* Get its face. */
15709 ilisp
= make_number (p
- arrow_string
);
15710 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15711 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15713 /* Compute its width, get its glyphs. */
15714 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15715 SET_TEXT_POS (it
.position
, -1, -1);
15716 PRODUCE_GLYPHS (&it
);
15718 /* If this character doesn't fit any more in the line, we have
15719 to remove some glyphs. */
15720 if (it
.current_x
> it
.last_visible_x
)
15722 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15727 set_buffer_temp (old
);
15728 return it
.glyph_row
;
15732 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15733 glyphs are only inserted for terminal frames since we can't really
15734 win with truncation glyphs when partially visible glyphs are
15735 involved. Which glyphs to insert is determined by
15736 produce_special_glyphs. */
15739 insert_left_trunc_glyphs (it
)
15742 struct it truncate_it
;
15743 struct glyph
*from
, *end
, *to
, *toend
;
15745 xassert (!FRAME_WINDOW_P (it
->f
));
15747 /* Get the truncation glyphs. */
15749 truncate_it
.current_x
= 0;
15750 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15751 truncate_it
.glyph_row
= &scratch_glyph_row
;
15752 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15753 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15754 truncate_it
.object
= make_number (0);
15755 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15757 /* Overwrite glyphs from IT with truncation glyphs. */
15758 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15759 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15760 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15761 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15766 /* There may be padding glyphs left over. Overwrite them too. */
15767 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15769 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15775 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15779 /* Compute the pixel height and width of IT->glyph_row.
15781 Most of the time, ascent and height of a display line will be equal
15782 to the max_ascent and max_height values of the display iterator
15783 structure. This is not the case if
15785 1. We hit ZV without displaying anything. In this case, max_ascent
15786 and max_height will be zero.
15788 2. We have some glyphs that don't contribute to the line height.
15789 (The glyph row flag contributes_to_line_height_p is for future
15790 pixmap extensions).
15792 The first case is easily covered by using default values because in
15793 these cases, the line height does not really matter, except that it
15794 must not be zero. */
15797 compute_line_metrics (it
)
15800 struct glyph_row
*row
= it
->glyph_row
;
15803 if (FRAME_WINDOW_P (it
->f
))
15805 int i
, min_y
, max_y
;
15807 /* The line may consist of one space only, that was added to
15808 place the cursor on it. If so, the row's height hasn't been
15810 if (row
->height
== 0)
15812 if (it
->max_ascent
+ it
->max_descent
== 0)
15813 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15814 row
->ascent
= it
->max_ascent
;
15815 row
->height
= it
->max_ascent
+ it
->max_descent
;
15816 row
->phys_ascent
= it
->max_phys_ascent
;
15817 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15818 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15821 /* Compute the width of this line. */
15822 row
->pixel_width
= row
->x
;
15823 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15824 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15826 xassert (row
->pixel_width
>= 0);
15827 xassert (row
->ascent
>= 0 && row
->height
> 0);
15829 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15830 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15832 /* If first line's physical ascent is larger than its logical
15833 ascent, use the physical ascent, and make the row taller.
15834 This makes accented characters fully visible. */
15835 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15836 && row
->phys_ascent
> row
->ascent
)
15838 row
->height
+= row
->phys_ascent
- row
->ascent
;
15839 row
->ascent
= row
->phys_ascent
;
15842 /* Compute how much of the line is visible. */
15843 row
->visible_height
= row
->height
;
15845 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
15846 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
15848 if (row
->y
< min_y
)
15849 row
->visible_height
-= min_y
- row
->y
;
15850 if (row
->y
+ row
->height
> max_y
)
15851 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15855 row
->pixel_width
= row
->used
[TEXT_AREA
];
15856 if (row
->continued_p
)
15857 row
->pixel_width
-= it
->continuation_pixel_width
;
15858 else if (row
->truncated_on_right_p
)
15859 row
->pixel_width
-= it
->truncation_pixel_width
;
15860 row
->ascent
= row
->phys_ascent
= 0;
15861 row
->height
= row
->phys_height
= row
->visible_height
= 1;
15862 row
->extra_line_spacing
= 0;
15865 /* Compute a hash code for this row. */
15867 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15868 for (i
= 0; i
< row
->used
[area
]; ++i
)
15869 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
15870 + row
->glyphs
[area
][i
].u
.val
15871 + row
->glyphs
[area
][i
].face_id
15872 + row
->glyphs
[area
][i
].padding_p
15873 + (row
->glyphs
[area
][i
].type
<< 2));
15875 it
->max_ascent
= it
->max_descent
= 0;
15876 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
15880 /* Append one space to the glyph row of iterator IT if doing a
15881 window-based redisplay. The space has the same face as
15882 IT->face_id. Value is non-zero if a space was added.
15884 This function is called to make sure that there is always one glyph
15885 at the end of a glyph row that the cursor can be set on under
15886 window-systems. (If there weren't such a glyph we would not know
15887 how wide and tall a box cursor should be displayed).
15889 At the same time this space let's a nicely handle clearing to the
15890 end of the line if the row ends in italic text. */
15893 append_space_for_newline (it
, default_face_p
)
15895 int default_face_p
;
15897 if (FRAME_WINDOW_P (it
->f
))
15899 int n
= it
->glyph_row
->used
[TEXT_AREA
];
15901 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
15902 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
15904 /* Save some values that must not be changed.
15905 Must save IT->c and IT->len because otherwise
15906 ITERATOR_AT_END_P wouldn't work anymore after
15907 append_space_for_newline has been called. */
15908 enum display_element_type saved_what
= it
->what
;
15909 int saved_c
= it
->c
, saved_len
= it
->len
;
15910 int saved_x
= it
->current_x
;
15911 int saved_face_id
= it
->face_id
;
15912 struct text_pos saved_pos
;
15913 Lisp_Object saved_object
;
15916 saved_object
= it
->object
;
15917 saved_pos
= it
->position
;
15919 it
->what
= IT_CHARACTER
;
15920 bzero (&it
->position
, sizeof it
->position
);
15921 it
->object
= make_number (0);
15925 if (default_face_p
)
15926 it
->face_id
= DEFAULT_FACE_ID
;
15927 else if (it
->face_before_selective_p
)
15928 it
->face_id
= it
->saved_face_id
;
15929 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
15930 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
15932 PRODUCE_GLYPHS (it
);
15934 it
->override_ascent
= -1;
15935 it
->constrain_row_ascent_descent_p
= 0;
15936 it
->current_x
= saved_x
;
15937 it
->object
= saved_object
;
15938 it
->position
= saved_pos
;
15939 it
->what
= saved_what
;
15940 it
->face_id
= saved_face_id
;
15941 it
->len
= saved_len
;
15951 /* Extend the face of the last glyph in the text area of IT->glyph_row
15952 to the end of the display line. Called from display_line.
15953 If the glyph row is empty, add a space glyph to it so that we
15954 know the face to draw. Set the glyph row flag fill_line_p. */
15957 extend_face_to_end_of_line (it
)
15961 struct frame
*f
= it
->f
;
15963 /* If line is already filled, do nothing. */
15964 if (it
->current_x
>= it
->last_visible_x
)
15967 /* Face extension extends the background and box of IT->face_id
15968 to the end of the line. If the background equals the background
15969 of the frame, we don't have to do anything. */
15970 if (it
->face_before_selective_p
)
15971 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
15973 face
= FACE_FROM_ID (f
, it
->face_id
);
15975 if (FRAME_WINDOW_P (f
)
15976 && it
->glyph_row
->displays_text_p
15977 && face
->box
== FACE_NO_BOX
15978 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
15982 /* Set the glyph row flag indicating that the face of the last glyph
15983 in the text area has to be drawn to the end of the text area. */
15984 it
->glyph_row
->fill_line_p
= 1;
15986 /* If current character of IT is not ASCII, make sure we have the
15987 ASCII face. This will be automatically undone the next time
15988 get_next_display_element returns a multibyte character. Note
15989 that the character will always be single byte in unibyte text. */
15990 if (!ASCII_CHAR_P (it
->c
))
15992 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
15995 if (FRAME_WINDOW_P (f
))
15997 /* If the row is empty, add a space with the current face of IT,
15998 so that we know which face to draw. */
15999 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16001 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16002 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16003 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16008 /* Save some values that must not be changed. */
16009 int saved_x
= it
->current_x
;
16010 struct text_pos saved_pos
;
16011 Lisp_Object saved_object
;
16012 enum display_element_type saved_what
= it
->what
;
16013 int saved_face_id
= it
->face_id
;
16015 saved_object
= it
->object
;
16016 saved_pos
= it
->position
;
16018 it
->what
= IT_CHARACTER
;
16019 bzero (&it
->position
, sizeof it
->position
);
16020 it
->object
= make_number (0);
16023 it
->face_id
= face
->id
;
16025 PRODUCE_GLYPHS (it
);
16027 while (it
->current_x
<= it
->last_visible_x
)
16028 PRODUCE_GLYPHS (it
);
16030 /* Don't count these blanks really. It would let us insert a left
16031 truncation glyph below and make us set the cursor on them, maybe. */
16032 it
->current_x
= saved_x
;
16033 it
->object
= saved_object
;
16034 it
->position
= saved_pos
;
16035 it
->what
= saved_what
;
16036 it
->face_id
= saved_face_id
;
16041 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16042 trailing whitespace. */
16045 trailing_whitespace_p (charpos
)
16048 int bytepos
= CHAR_TO_BYTE (charpos
);
16051 while (bytepos
< ZV_BYTE
16052 && (c
= FETCH_CHAR (bytepos
),
16053 c
== ' ' || c
== '\t'))
16056 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16058 if (bytepos
!= PT_BYTE
)
16065 /* Highlight trailing whitespace, if any, in ROW. */
16068 highlight_trailing_whitespace (f
, row
)
16070 struct glyph_row
*row
;
16072 int used
= row
->used
[TEXT_AREA
];
16076 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16077 struct glyph
*glyph
= start
+ used
- 1;
16079 /* Skip over glyphs inserted to display the cursor at the
16080 end of a line, for extending the face of the last glyph
16081 to the end of the line on terminals, and for truncation
16082 and continuation glyphs. */
16083 while (glyph
>= start
16084 && glyph
->type
== CHAR_GLYPH
16085 && INTEGERP (glyph
->object
))
16088 /* If last glyph is a space or stretch, and it's trailing
16089 whitespace, set the face of all trailing whitespace glyphs in
16090 IT->glyph_row to `trailing-whitespace'. */
16092 && BUFFERP (glyph
->object
)
16093 && (glyph
->type
== STRETCH_GLYPH
16094 || (glyph
->type
== CHAR_GLYPH
16095 && glyph
->u
.ch
== ' '))
16096 && trailing_whitespace_p (glyph
->charpos
))
16098 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16102 while (glyph
>= start
16103 && BUFFERP (glyph
->object
)
16104 && (glyph
->type
== STRETCH_GLYPH
16105 || (glyph
->type
== CHAR_GLYPH
16106 && glyph
->u
.ch
== ' ')))
16107 (glyph
--)->face_id
= face_id
;
16113 /* Value is non-zero if glyph row ROW in window W should be
16114 used to hold the cursor. */
16117 cursor_row_p (w
, row
)
16119 struct glyph_row
*row
;
16121 int cursor_row_p
= 1;
16123 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16125 /* Suppose the row ends on a string.
16126 Unless the row is continued, that means it ends on a newline
16127 in the string. If it's anything other than a display string
16128 (e.g. a before-string from an overlay), we don't want the
16129 cursor there. (This heuristic seems to give the optimal
16130 behavior for the various types of multi-line strings.) */
16131 if (CHARPOS (row
->end
.string_pos
) >= 0)
16133 if (row
->continued_p
)
16137 /* Check for `display' property. */
16138 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16139 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16140 struct glyph
*glyph
;
16143 for (glyph
= end
; glyph
>= beg
; --glyph
)
16144 if (STRINGP (glyph
->object
))
16147 = Fget_char_property (make_number (PT
),
16151 && display_prop_string_p (prop
, glyph
->object
));
16156 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16158 /* If the row ends in middle of a real character,
16159 and the line is continued, we want the cursor here.
16160 That's because MATRIX_ROW_END_CHARPOS would equal
16161 PT if PT is before the character. */
16162 if (!row
->ends_in_ellipsis_p
)
16163 cursor_row_p
= row
->continued_p
;
16165 /* If the row ends in an ellipsis, then
16166 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16167 We want that position to be displayed after the ellipsis. */
16170 /* If the row ends at ZV, display the cursor at the end of that
16171 row instead of at the start of the row below. */
16172 else if (row
->ends_at_zv_p
)
16178 return cursor_row_p
;
16182 /* Construct the glyph row IT->glyph_row in the desired matrix of
16183 IT->w from text at the current position of IT. See dispextern.h
16184 for an overview of struct it. Value is non-zero if
16185 IT->glyph_row displays text, as opposed to a line displaying ZV
16192 struct glyph_row
*row
= it
->glyph_row
;
16193 Lisp_Object overlay_arrow_string
;
16195 /* We always start displaying at hpos zero even if hscrolled. */
16196 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16198 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16199 >= it
->w
->desired_matrix
->nrows
)
16201 it
->w
->nrows_scale_factor
++;
16202 fonts_changed_p
= 1;
16206 /* Is IT->w showing the region? */
16207 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16209 /* Clear the result glyph row and enable it. */
16210 prepare_desired_row (row
);
16212 row
->y
= it
->current_y
;
16213 row
->start
= it
->start
;
16214 row
->continuation_lines_width
= it
->continuation_lines_width
;
16215 row
->displays_text_p
= 1;
16216 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16217 it
->starts_in_middle_of_char_p
= 0;
16219 /* Arrange the overlays nicely for our purposes. Usually, we call
16220 display_line on only one line at a time, in which case this
16221 can't really hurt too much, or we call it on lines which appear
16222 one after another in the buffer, in which case all calls to
16223 recenter_overlay_lists but the first will be pretty cheap. */
16224 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16226 /* Move over display elements that are not visible because we are
16227 hscrolled. This may stop at an x-position < IT->first_visible_x
16228 if the first glyph is partially visible or if we hit a line end. */
16229 if (it
->current_x
< it
->first_visible_x
)
16231 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16232 MOVE_TO_POS
| MOVE_TO_X
);
16235 /* Get the initial row height. This is either the height of the
16236 text hscrolled, if there is any, or zero. */
16237 row
->ascent
= it
->max_ascent
;
16238 row
->height
= it
->max_ascent
+ it
->max_descent
;
16239 row
->phys_ascent
= it
->max_phys_ascent
;
16240 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16241 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16243 /* Loop generating characters. The loop is left with IT on the next
16244 character to display. */
16247 int n_glyphs_before
, hpos_before
, x_before
;
16249 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16251 /* Retrieve the next thing to display. Value is zero if end of
16253 if (!get_next_display_element (it
))
16255 /* Maybe add a space at the end of this line that is used to
16256 display the cursor there under X. Set the charpos of the
16257 first glyph of blank lines not corresponding to any text
16259 #ifdef HAVE_WINDOW_SYSTEM
16260 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16261 row
->exact_window_width_line_p
= 1;
16263 #endif /* HAVE_WINDOW_SYSTEM */
16264 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16265 || row
->used
[TEXT_AREA
] == 0)
16267 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16268 row
->displays_text_p
= 0;
16270 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16271 && (!MINI_WINDOW_P (it
->w
)
16272 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16273 row
->indicate_empty_line_p
= 1;
16276 it
->continuation_lines_width
= 0;
16277 row
->ends_at_zv_p
= 1;
16281 /* Now, get the metrics of what we want to display. This also
16282 generates glyphs in `row' (which is IT->glyph_row). */
16283 n_glyphs_before
= row
->used
[TEXT_AREA
];
16286 /* Remember the line height so far in case the next element doesn't
16287 fit on the line. */
16288 if (!it
->truncate_lines_p
)
16290 ascent
= it
->max_ascent
;
16291 descent
= it
->max_descent
;
16292 phys_ascent
= it
->max_phys_ascent
;
16293 phys_descent
= it
->max_phys_descent
;
16296 PRODUCE_GLYPHS (it
);
16298 /* If this display element was in marginal areas, continue with
16300 if (it
->area
!= TEXT_AREA
)
16302 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16303 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16304 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16305 row
->phys_height
= max (row
->phys_height
,
16306 it
->max_phys_ascent
+ it
->max_phys_descent
);
16307 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16308 it
->max_extra_line_spacing
);
16309 set_iterator_to_next (it
, 1);
16313 /* Does the display element fit on the line? If we truncate
16314 lines, we should draw past the right edge of the window. If
16315 we don't truncate, we want to stop so that we can display the
16316 continuation glyph before the right margin. If lines are
16317 continued, there are two possible strategies for characters
16318 resulting in more than 1 glyph (e.g. tabs): Display as many
16319 glyphs as possible in this line and leave the rest for the
16320 continuation line, or display the whole element in the next
16321 line. Original redisplay did the former, so we do it also. */
16322 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16323 hpos_before
= it
->hpos
;
16326 if (/* Not a newline. */
16328 /* Glyphs produced fit entirely in the line. */
16329 && it
->current_x
< it
->last_visible_x
)
16331 it
->hpos
+= nglyphs
;
16332 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16333 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16334 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16335 row
->phys_height
= max (row
->phys_height
,
16336 it
->max_phys_ascent
+ it
->max_phys_descent
);
16337 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16338 it
->max_extra_line_spacing
);
16339 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16340 row
->x
= x
- it
->first_visible_x
;
16345 struct glyph
*glyph
;
16347 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16349 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16350 new_x
= x
+ glyph
->pixel_width
;
16352 if (/* Lines are continued. */
16353 !it
->truncate_lines_p
16354 && (/* Glyph doesn't fit on the line. */
16355 new_x
> it
->last_visible_x
16356 /* Or it fits exactly on a window system frame. */
16357 || (new_x
== it
->last_visible_x
16358 && FRAME_WINDOW_P (it
->f
))))
16360 /* End of a continued line. */
16363 || (new_x
== it
->last_visible_x
16364 && FRAME_WINDOW_P (it
->f
)))
16366 /* Current glyph is the only one on the line or
16367 fits exactly on the line. We must continue
16368 the line because we can't draw the cursor
16369 after the glyph. */
16370 row
->continued_p
= 1;
16371 it
->current_x
= new_x
;
16372 it
->continuation_lines_width
+= new_x
;
16374 if (i
== nglyphs
- 1)
16376 set_iterator_to_next (it
, 1);
16377 #ifdef HAVE_WINDOW_SYSTEM
16378 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16380 if (!get_next_display_element (it
))
16382 row
->exact_window_width_line_p
= 1;
16383 it
->continuation_lines_width
= 0;
16384 row
->continued_p
= 0;
16385 row
->ends_at_zv_p
= 1;
16387 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16389 row
->continued_p
= 0;
16390 row
->exact_window_width_line_p
= 1;
16393 #endif /* HAVE_WINDOW_SYSTEM */
16396 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16397 && !FRAME_WINDOW_P (it
->f
))
16399 /* A padding glyph that doesn't fit on this line.
16400 This means the whole character doesn't fit
16402 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16404 /* Fill the rest of the row with continuation
16405 glyphs like in 20.x. */
16406 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16407 < row
->glyphs
[1 + TEXT_AREA
])
16408 produce_special_glyphs (it
, IT_CONTINUATION
);
16410 row
->continued_p
= 1;
16411 it
->current_x
= x_before
;
16412 it
->continuation_lines_width
+= x_before
;
16414 /* Restore the height to what it was before the
16415 element not fitting on the line. */
16416 it
->max_ascent
= ascent
;
16417 it
->max_descent
= descent
;
16418 it
->max_phys_ascent
= phys_ascent
;
16419 it
->max_phys_descent
= phys_descent
;
16421 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16423 /* A TAB that extends past the right edge of the
16424 window. This produces a single glyph on
16425 window system frames. We leave the glyph in
16426 this row and let it fill the row, but don't
16427 consume the TAB. */
16428 it
->continuation_lines_width
+= it
->last_visible_x
;
16429 row
->ends_in_middle_of_char_p
= 1;
16430 row
->continued_p
= 1;
16431 glyph
->pixel_width
= it
->last_visible_x
- x
;
16432 it
->starts_in_middle_of_char_p
= 1;
16436 /* Something other than a TAB that draws past
16437 the right edge of the window. Restore
16438 positions to values before the element. */
16439 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16441 /* Display continuation glyphs. */
16442 if (!FRAME_WINDOW_P (it
->f
))
16443 produce_special_glyphs (it
, IT_CONTINUATION
);
16444 row
->continued_p
= 1;
16446 it
->current_x
= x_before
;
16447 it
->continuation_lines_width
+= x
;
16448 extend_face_to_end_of_line (it
);
16450 if (nglyphs
> 1 && i
> 0)
16452 row
->ends_in_middle_of_char_p
= 1;
16453 it
->starts_in_middle_of_char_p
= 1;
16456 /* Restore the height to what it was before the
16457 element not fitting on the line. */
16458 it
->max_ascent
= ascent
;
16459 it
->max_descent
= descent
;
16460 it
->max_phys_ascent
= phys_ascent
;
16461 it
->max_phys_descent
= phys_descent
;
16466 else if (new_x
> it
->first_visible_x
)
16468 /* Increment number of glyphs actually displayed. */
16471 if (x
< it
->first_visible_x
)
16472 /* Glyph is partially visible, i.e. row starts at
16473 negative X position. */
16474 row
->x
= x
- it
->first_visible_x
;
16478 /* Glyph is completely off the left margin of the
16479 window. This should not happen because of the
16480 move_it_in_display_line at the start of this
16481 function, unless the text display area of the
16482 window is empty. */
16483 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16487 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16488 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16489 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16490 row
->phys_height
= max (row
->phys_height
,
16491 it
->max_phys_ascent
+ it
->max_phys_descent
);
16492 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16493 it
->max_extra_line_spacing
);
16495 /* End of this display line if row is continued. */
16496 if (row
->continued_p
|| row
->ends_at_zv_p
)
16501 /* Is this a line end? If yes, we're also done, after making
16502 sure that a non-default face is extended up to the right
16503 margin of the window. */
16504 if (ITERATOR_AT_END_OF_LINE_P (it
))
16506 int used_before
= row
->used
[TEXT_AREA
];
16508 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16510 #ifdef HAVE_WINDOW_SYSTEM
16511 /* Add a space at the end of the line that is used to
16512 display the cursor there. */
16513 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16514 append_space_for_newline (it
, 0);
16515 #endif /* HAVE_WINDOW_SYSTEM */
16517 /* Extend the face to the end of the line. */
16518 extend_face_to_end_of_line (it
);
16520 /* Make sure we have the position. */
16521 if (used_before
== 0)
16522 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16524 /* Consume the line end. This skips over invisible lines. */
16525 set_iterator_to_next (it
, 1);
16526 it
->continuation_lines_width
= 0;
16530 /* Proceed with next display element. Note that this skips
16531 over lines invisible because of selective display. */
16532 set_iterator_to_next (it
, 1);
16534 /* If we truncate lines, we are done when the last displayed
16535 glyphs reach past the right margin of the window. */
16536 if (it
->truncate_lines_p
16537 && (FRAME_WINDOW_P (it
->f
)
16538 ? (it
->current_x
>= it
->last_visible_x
)
16539 : (it
->current_x
> it
->last_visible_x
)))
16541 /* Maybe add truncation glyphs. */
16542 if (!FRAME_WINDOW_P (it
->f
))
16546 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16547 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16550 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16552 row
->used
[TEXT_AREA
] = i
;
16553 produce_special_glyphs (it
, IT_TRUNCATION
);
16556 #ifdef HAVE_WINDOW_SYSTEM
16559 /* Don't truncate if we can overflow newline into fringe. */
16560 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16562 if (!get_next_display_element (it
))
16564 it
->continuation_lines_width
= 0;
16565 row
->ends_at_zv_p
= 1;
16566 row
->exact_window_width_line_p
= 1;
16569 if (ITERATOR_AT_END_OF_LINE_P (it
))
16571 row
->exact_window_width_line_p
= 1;
16572 goto at_end_of_line
;
16576 #endif /* HAVE_WINDOW_SYSTEM */
16578 row
->truncated_on_right_p
= 1;
16579 it
->continuation_lines_width
= 0;
16580 reseat_at_next_visible_line_start (it
, 0);
16581 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16582 it
->hpos
= hpos_before
;
16583 it
->current_x
= x_before
;
16588 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16589 at the left window margin. */
16590 if (it
->first_visible_x
16591 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16593 if (!FRAME_WINDOW_P (it
->f
))
16594 insert_left_trunc_glyphs (it
);
16595 row
->truncated_on_left_p
= 1;
16598 /* If the start of this line is the overlay arrow-position, then
16599 mark this glyph row as the one containing the overlay arrow.
16600 This is clearly a mess with variable size fonts. It would be
16601 better to let it be displayed like cursors under X. */
16602 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16603 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16604 !NILP (overlay_arrow_string
)))
16606 /* Overlay arrow in window redisplay is a fringe bitmap. */
16607 if (STRINGP (overlay_arrow_string
))
16609 struct glyph_row
*arrow_row
16610 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16611 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16612 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16613 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16614 struct glyph
*p2
, *end
;
16616 /* Copy the arrow glyphs. */
16617 while (glyph
< arrow_end
)
16620 /* Throw away padding glyphs. */
16622 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16623 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16629 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16634 xassert (INTEGERP (overlay_arrow_string
));
16635 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16637 overlay_arrow_seen
= 1;
16640 /* Compute pixel dimensions of this line. */
16641 compute_line_metrics (it
);
16643 /* Remember the position at which this line ends. */
16644 row
->end
= it
->current
;
16646 /* Record whether this row ends inside an ellipsis. */
16647 row
->ends_in_ellipsis_p
16648 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16649 && it
->ellipsis_p
);
16651 /* Save fringe bitmaps in this row. */
16652 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16653 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16654 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16655 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16657 it
->left_user_fringe_bitmap
= 0;
16658 it
->left_user_fringe_face_id
= 0;
16659 it
->right_user_fringe_bitmap
= 0;
16660 it
->right_user_fringe_face_id
= 0;
16662 /* Maybe set the cursor. */
16663 if (it
->w
->cursor
.vpos
< 0
16664 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16665 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16666 && cursor_row_p (it
->w
, row
))
16667 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16669 /* Highlight trailing whitespace. */
16670 if (!NILP (Vshow_trailing_whitespace
))
16671 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16673 /* Prepare for the next line. This line starts horizontally at (X
16674 HPOS) = (0 0). Vertical positions are incremented. As a
16675 convenience for the caller, IT->glyph_row is set to the next
16677 it
->current_x
= it
->hpos
= 0;
16678 it
->current_y
+= row
->height
;
16681 it
->start
= it
->current
;
16682 return row
->displays_text_p
;
16687 /***********************************************************************
16689 ***********************************************************************/
16691 /* Redisplay the menu bar in the frame for window W.
16693 The menu bar of X frames that don't have X toolkit support is
16694 displayed in a special window W->frame->menu_bar_window.
16696 The menu bar of terminal frames is treated specially as far as
16697 glyph matrices are concerned. Menu bar lines are not part of
16698 windows, so the update is done directly on the frame matrix rows
16699 for the menu bar. */
16702 display_menu_bar (w
)
16705 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16710 /* Don't do all this for graphical frames. */
16712 if (FRAME_W32_P (f
))
16715 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
16720 if (FRAME_MAC_P (f
))
16724 #ifdef USE_X_TOOLKIT
16725 xassert (!FRAME_WINDOW_P (f
));
16726 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
16727 it
.first_visible_x
= 0;
16728 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16729 #else /* not USE_X_TOOLKIT */
16730 if (FRAME_WINDOW_P (f
))
16732 /* Menu bar lines are displayed in the desired matrix of the
16733 dummy window menu_bar_window. */
16734 struct window
*menu_w
;
16735 xassert (WINDOWP (f
->menu_bar_window
));
16736 menu_w
= XWINDOW (f
->menu_bar_window
);
16737 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
16739 it
.first_visible_x
= 0;
16740 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16744 /* This is a TTY frame, i.e. character hpos/vpos are used as
16746 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
16748 it
.first_visible_x
= 0;
16749 it
.last_visible_x
= FRAME_COLS (f
);
16751 #endif /* not USE_X_TOOLKIT */
16753 if (! mode_line_inverse_video
)
16754 /* Force the menu-bar to be displayed in the default face. */
16755 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16757 /* Clear all rows of the menu bar. */
16758 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
16760 struct glyph_row
*row
= it
.glyph_row
+ i
;
16761 clear_glyph_row (row
);
16762 row
->enabled_p
= 1;
16763 row
->full_width_p
= 1;
16766 /* Display all items of the menu bar. */
16767 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
16768 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
16770 Lisp_Object string
;
16772 /* Stop at nil string. */
16773 string
= AREF (items
, i
+ 1);
16777 /* Remember where item was displayed. */
16778 AREF (items
, i
+ 3) = make_number (it
.hpos
);
16780 /* Display the item, pad with one space. */
16781 if (it
.current_x
< it
.last_visible_x
)
16782 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
16783 SCHARS (string
) + 1, 0, 0, -1);
16786 /* Fill out the line with spaces. */
16787 if (it
.current_x
< it
.last_visible_x
)
16788 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
16790 /* Compute the total height of the lines. */
16791 compute_line_metrics (&it
);
16796 /***********************************************************************
16798 ***********************************************************************/
16800 /* Redisplay mode lines in the window tree whose root is WINDOW. If
16801 FORCE is non-zero, redisplay mode lines unconditionally.
16802 Otherwise, redisplay only mode lines that are garbaged. Value is
16803 the number of windows whose mode lines were redisplayed. */
16806 redisplay_mode_lines (window
, force
)
16807 Lisp_Object window
;
16812 while (!NILP (window
))
16814 struct window
*w
= XWINDOW (window
);
16816 if (WINDOWP (w
->hchild
))
16817 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
16818 else if (WINDOWP (w
->vchild
))
16819 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
16821 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
16822 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
16824 struct text_pos lpoint
;
16825 struct buffer
*old
= current_buffer
;
16827 /* Set the window's buffer for the mode line display. */
16828 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16829 set_buffer_internal_1 (XBUFFER (w
->buffer
));
16831 /* Point refers normally to the selected window. For any
16832 other window, set up appropriate value. */
16833 if (!EQ (window
, selected_window
))
16835 struct text_pos pt
;
16837 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
16838 if (CHARPOS (pt
) < BEGV
)
16839 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16840 else if (CHARPOS (pt
) > (ZV
- 1))
16841 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
16843 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
16846 /* Display mode lines. */
16847 clear_glyph_matrix (w
->desired_matrix
);
16848 if (display_mode_lines (w
))
16851 w
->must_be_updated_p
= 1;
16854 /* Restore old settings. */
16855 set_buffer_internal_1 (old
);
16856 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16866 /* Display the mode and/or top line of window W. Value is the number
16867 of mode lines displayed. */
16870 display_mode_lines (w
)
16873 Lisp_Object old_selected_window
, old_selected_frame
;
16876 old_selected_frame
= selected_frame
;
16877 selected_frame
= w
->frame
;
16878 old_selected_window
= selected_window
;
16879 XSETWINDOW (selected_window
, w
);
16881 /* These will be set while the mode line specs are processed. */
16882 line_number_displayed
= 0;
16883 w
->column_number_displayed
= Qnil
;
16885 if (WINDOW_WANTS_MODELINE_P (w
))
16887 struct window
*sel_w
= XWINDOW (old_selected_window
);
16889 /* Select mode line face based on the real selected window. */
16890 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
16891 current_buffer
->mode_line_format
);
16895 if (WINDOW_WANTS_HEADER_LINE_P (w
))
16897 display_mode_line (w
, HEADER_LINE_FACE_ID
,
16898 current_buffer
->header_line_format
);
16902 selected_frame
= old_selected_frame
;
16903 selected_window
= old_selected_window
;
16908 /* Display mode or top line of window W. FACE_ID specifies which line
16909 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
16910 FORMAT is the mode line format to display. Value is the pixel
16911 height of the mode line displayed. */
16914 display_mode_line (w
, face_id
, format
)
16916 enum face_id face_id
;
16917 Lisp_Object format
;
16921 int count
= SPECPDL_INDEX ();
16923 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
16924 /* Don't extend on a previously drawn mode-line.
16925 This may happen if called from pos_visible_p. */
16926 it
.glyph_row
->enabled_p
= 0;
16927 prepare_desired_row (it
.glyph_row
);
16929 it
.glyph_row
->mode_line_p
= 1;
16931 if (! mode_line_inverse_video
)
16932 /* Force the mode-line to be displayed in the default face. */
16933 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16935 record_unwind_protect (unwind_format_mode_line
,
16936 format_mode_line_unwind_data (NULL
, 0));
16938 mode_line_target
= MODE_LINE_DISPLAY
;
16940 /* Temporarily make frame's keyboard the current kboard so that
16941 kboard-local variables in the mode_line_format will get the right
16943 push_kboard (FRAME_KBOARD (it
.f
));
16944 record_unwind_save_match_data ();
16945 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
16948 unbind_to (count
, Qnil
);
16950 /* Fill up with spaces. */
16951 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
16953 compute_line_metrics (&it
);
16954 it
.glyph_row
->full_width_p
= 1;
16955 it
.glyph_row
->continued_p
= 0;
16956 it
.glyph_row
->truncated_on_left_p
= 0;
16957 it
.glyph_row
->truncated_on_right_p
= 0;
16959 /* Make a 3D mode-line have a shadow at its right end. */
16960 face
= FACE_FROM_ID (it
.f
, face_id
);
16961 extend_face_to_end_of_line (&it
);
16962 if (face
->box
!= FACE_NO_BOX
)
16964 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
16965 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
16966 last
->right_box_line_p
= 1;
16969 return it
.glyph_row
->height
;
16972 /* Move element ELT in LIST to the front of LIST.
16973 Return the updated list. */
16976 move_elt_to_front (elt
, list
)
16977 Lisp_Object elt
, list
;
16979 register Lisp_Object tail
, prev
;
16980 register Lisp_Object tem
;
16984 while (CONSP (tail
))
16990 /* Splice out the link TAIL. */
16992 list
= XCDR (tail
);
16994 Fsetcdr (prev
, XCDR (tail
));
16996 /* Now make it the first. */
16997 Fsetcdr (tail
, list
);
17002 tail
= XCDR (tail
);
17006 /* Not found--return unchanged LIST. */
17010 /* Contribute ELT to the mode line for window IT->w. How it
17011 translates into text depends on its data type.
17013 IT describes the display environment in which we display, as usual.
17015 DEPTH is the depth in recursion. It is used to prevent
17016 infinite recursion here.
17018 FIELD_WIDTH is the number of characters the display of ELT should
17019 occupy in the mode line, and PRECISION is the maximum number of
17020 characters to display from ELT's representation. See
17021 display_string for details.
17023 Returns the hpos of the end of the text generated by ELT.
17025 PROPS is a property list to add to any string we encounter.
17027 If RISKY is nonzero, remove (disregard) any properties in any string
17028 we encounter, and ignore :eval and :propertize.
17030 The global variable `mode_line_target' determines whether the
17031 output is passed to `store_mode_line_noprop',
17032 `store_mode_line_string', or `display_string'. */
17035 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17038 int field_width
, precision
;
17039 Lisp_Object elt
, props
;
17042 int n
= 0, field
, prec
;
17047 elt
= build_string ("*too-deep*");
17051 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17055 /* A string: output it and check for %-constructs within it. */
17059 if (SCHARS (elt
) > 0
17060 && (!NILP (props
) || risky
))
17062 Lisp_Object oprops
, aelt
;
17063 oprops
= Ftext_properties_at (make_number (0), elt
);
17065 /* If the starting string's properties are not what
17066 we want, translate the string. Also, if the string
17067 is risky, do that anyway. */
17069 if (NILP (Fequal (props
, oprops
)) || risky
)
17071 /* If the starting string has properties,
17072 merge the specified ones onto the existing ones. */
17073 if (! NILP (oprops
) && !risky
)
17077 oprops
= Fcopy_sequence (oprops
);
17079 while (CONSP (tem
))
17081 oprops
= Fplist_put (oprops
, XCAR (tem
),
17082 XCAR (XCDR (tem
)));
17083 tem
= XCDR (XCDR (tem
));
17088 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17089 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17091 /* AELT is what we want. Move it to the front
17092 without consing. */
17094 mode_line_proptrans_alist
17095 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17101 /* If AELT has the wrong props, it is useless.
17102 so get rid of it. */
17104 mode_line_proptrans_alist
17105 = Fdelq (aelt
, mode_line_proptrans_alist
);
17107 elt
= Fcopy_sequence (elt
);
17108 Fset_text_properties (make_number (0), Flength (elt
),
17110 /* Add this item to mode_line_proptrans_alist. */
17111 mode_line_proptrans_alist
17112 = Fcons (Fcons (elt
, props
),
17113 mode_line_proptrans_alist
);
17114 /* Truncate mode_line_proptrans_alist
17115 to at most 50 elements. */
17116 tem
= Fnthcdr (make_number (50),
17117 mode_line_proptrans_alist
);
17119 XSETCDR (tem
, Qnil
);
17128 prec
= precision
- n
;
17129 switch (mode_line_target
)
17131 case MODE_LINE_NOPROP
:
17132 case MODE_LINE_TITLE
:
17133 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17135 case MODE_LINE_STRING
:
17136 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17138 case MODE_LINE_DISPLAY
:
17139 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17140 0, prec
, 0, STRING_MULTIBYTE (elt
));
17147 /* Handle the non-literal case. */
17149 while ((precision
<= 0 || n
< precision
)
17150 && SREF (elt
, offset
) != 0
17151 && (mode_line_target
!= MODE_LINE_DISPLAY
17152 || it
->current_x
< it
->last_visible_x
))
17154 int last_offset
= offset
;
17156 /* Advance to end of string or next format specifier. */
17157 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17160 if (offset
- 1 != last_offset
)
17162 int nchars
, nbytes
;
17164 /* Output to end of string or up to '%'. Field width
17165 is length of string. Don't output more than
17166 PRECISION allows us. */
17169 prec
= c_string_width (SDATA (elt
) + last_offset
,
17170 offset
- last_offset
, precision
- n
,
17173 switch (mode_line_target
)
17175 case MODE_LINE_NOPROP
:
17176 case MODE_LINE_TITLE
:
17177 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17179 case MODE_LINE_STRING
:
17181 int bytepos
= last_offset
;
17182 int charpos
= string_byte_to_char (elt
, bytepos
);
17183 int endpos
= (precision
<= 0
17184 ? string_byte_to_char (elt
, offset
)
17185 : charpos
+ nchars
);
17187 n
+= store_mode_line_string (NULL
,
17188 Fsubstring (elt
, make_number (charpos
),
17189 make_number (endpos
)),
17193 case MODE_LINE_DISPLAY
:
17195 int bytepos
= last_offset
;
17196 int charpos
= string_byte_to_char (elt
, bytepos
);
17198 if (precision
<= 0)
17199 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17200 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17202 STRING_MULTIBYTE (elt
));
17207 else /* c == '%' */
17209 int percent_position
= offset
;
17211 /* Get the specified minimum width. Zero means
17214 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17215 field
= field
* 10 + c
- '0';
17217 /* Don't pad beyond the total padding allowed. */
17218 if (field_width
- n
> 0 && field
> field_width
- n
)
17219 field
= field_width
- n
;
17221 /* Note that either PRECISION <= 0 or N < PRECISION. */
17222 prec
= precision
- n
;
17225 n
+= display_mode_element (it
, depth
, field
, prec
,
17226 Vglobal_mode_string
, props
,
17231 int bytepos
, charpos
;
17232 unsigned char *spec
;
17234 bytepos
= percent_position
;
17235 charpos
= (STRING_MULTIBYTE (elt
)
17236 ? string_byte_to_char (elt
, bytepos
)
17240 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17242 switch (mode_line_target
)
17244 case MODE_LINE_NOPROP
:
17245 case MODE_LINE_TITLE
:
17246 n
+= store_mode_line_noprop (spec
, field
, prec
);
17248 case MODE_LINE_STRING
:
17250 int len
= strlen (spec
);
17251 Lisp_Object tem
= make_string (spec
, len
);
17252 props
= Ftext_properties_at (make_number (charpos
), elt
);
17253 /* Should only keep face property in props */
17254 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17257 case MODE_LINE_DISPLAY
:
17259 int nglyphs_before
, nwritten
;
17261 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17262 nwritten
= display_string (spec
, Qnil
, elt
,
17267 /* Assign to the glyphs written above the
17268 string where the `%x' came from, position
17272 struct glyph
*glyph
17273 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17277 for (i
= 0; i
< nwritten
; ++i
)
17279 glyph
[i
].object
= elt
;
17280 glyph
[i
].charpos
= charpos
;
17297 /* A symbol: process the value of the symbol recursively
17298 as if it appeared here directly. Avoid error if symbol void.
17299 Special case: if value of symbol is a string, output the string
17302 register Lisp_Object tem
;
17304 /* If the variable is not marked as risky to set
17305 then its contents are risky to use. */
17306 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17309 tem
= Fboundp (elt
);
17312 tem
= Fsymbol_value (elt
);
17313 /* If value is a string, output that string literally:
17314 don't check for % within it. */
17318 if (!EQ (tem
, elt
))
17320 /* Give up right away for nil or t. */
17330 register Lisp_Object car
, tem
;
17332 /* A cons cell: five distinct cases.
17333 If first element is :eval or :propertize, do something special.
17334 If first element is a string or a cons, process all the elements
17335 and effectively concatenate them.
17336 If first element is a negative number, truncate displaying cdr to
17337 at most that many characters. If positive, pad (with spaces)
17338 to at least that many characters.
17339 If first element is a symbol, process the cadr or caddr recursively
17340 according to whether the symbol's value is non-nil or nil. */
17342 if (EQ (car
, QCeval
))
17344 /* An element of the form (:eval FORM) means evaluate FORM
17345 and use the result as mode line elements. */
17350 if (CONSP (XCDR (elt
)))
17353 spec
= safe_eval (XCAR (XCDR (elt
)));
17354 n
+= display_mode_element (it
, depth
, field_width
- n
,
17355 precision
- n
, spec
, props
,
17359 else if (EQ (car
, QCpropertize
))
17361 /* An element of the form (:propertize ELT PROPS...)
17362 means display ELT but applying properties PROPS. */
17367 if (CONSP (XCDR (elt
)))
17368 n
+= display_mode_element (it
, depth
, field_width
- n
,
17369 precision
- n
, XCAR (XCDR (elt
)),
17370 XCDR (XCDR (elt
)), risky
);
17372 else if (SYMBOLP (car
))
17374 tem
= Fboundp (car
);
17378 /* elt is now the cdr, and we know it is a cons cell.
17379 Use its car if CAR has a non-nil value. */
17382 tem
= Fsymbol_value (car
);
17389 /* Symbol's value is nil (or symbol is unbound)
17390 Get the cddr of the original list
17391 and if possible find the caddr and use that. */
17395 else if (!CONSP (elt
))
17400 else if (INTEGERP (car
))
17402 register int lim
= XINT (car
);
17406 /* Negative int means reduce maximum width. */
17407 if (precision
<= 0)
17410 precision
= min (precision
, -lim
);
17414 /* Padding specified. Don't let it be more than
17415 current maximum. */
17417 lim
= min (precision
, lim
);
17419 /* If that's more padding than already wanted, queue it.
17420 But don't reduce padding already specified even if
17421 that is beyond the current truncation point. */
17422 field_width
= max (lim
, field_width
);
17426 else if (STRINGP (car
) || CONSP (car
))
17428 register int limit
= 50;
17429 /* Limit is to protect against circular lists. */
17432 && (precision
<= 0 || n
< precision
))
17434 n
+= display_mode_element (it
, depth
,
17435 /* Do padding only after the last
17436 element in the list. */
17437 (! CONSP (XCDR (elt
))
17440 precision
- n
, XCAR (elt
),
17450 elt
= build_string ("*invalid*");
17454 /* Pad to FIELD_WIDTH. */
17455 if (field_width
> 0 && n
< field_width
)
17457 switch (mode_line_target
)
17459 case MODE_LINE_NOPROP
:
17460 case MODE_LINE_TITLE
:
17461 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17463 case MODE_LINE_STRING
:
17464 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17466 case MODE_LINE_DISPLAY
:
17467 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17476 /* Store a mode-line string element in mode_line_string_list.
17478 If STRING is non-null, display that C string. Otherwise, the Lisp
17479 string LISP_STRING is displayed.
17481 FIELD_WIDTH is the minimum number of output glyphs to produce.
17482 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17483 with spaces. FIELD_WIDTH <= 0 means don't pad.
17485 PRECISION is the maximum number of characters to output from
17486 STRING. PRECISION <= 0 means don't truncate the string.
17488 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17489 properties to the string.
17491 PROPS are the properties to add to the string.
17492 The mode_line_string_face face property is always added to the string.
17496 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17498 Lisp_Object lisp_string
;
17507 if (string
!= NULL
)
17509 len
= strlen (string
);
17510 if (precision
> 0 && len
> precision
)
17512 lisp_string
= make_string (string
, len
);
17514 props
= mode_line_string_face_prop
;
17515 else if (!NILP (mode_line_string_face
))
17517 Lisp_Object face
= Fplist_get (props
, Qface
);
17518 props
= Fcopy_sequence (props
);
17520 face
= mode_line_string_face
;
17522 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17523 props
= Fplist_put (props
, Qface
, face
);
17525 Fadd_text_properties (make_number (0), make_number (len
),
17526 props
, lisp_string
);
17530 len
= XFASTINT (Flength (lisp_string
));
17531 if (precision
> 0 && len
> precision
)
17534 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17537 if (!NILP (mode_line_string_face
))
17541 props
= Ftext_properties_at (make_number (0), lisp_string
);
17542 face
= Fplist_get (props
, Qface
);
17544 face
= mode_line_string_face
;
17546 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17547 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17549 lisp_string
= Fcopy_sequence (lisp_string
);
17552 Fadd_text_properties (make_number (0), make_number (len
),
17553 props
, lisp_string
);
17558 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17562 if (field_width
> len
)
17564 field_width
-= len
;
17565 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17567 Fadd_text_properties (make_number (0), make_number (field_width
),
17568 props
, lisp_string
);
17569 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17577 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17579 doc
: /* Format a string out of a mode line format specification.
17580 First arg FORMAT specifies the mode line format (see `mode-line-format'
17581 for details) to use.
17583 Optional second arg FACE specifies the face property to put
17584 on all characters for which no face is specified.
17585 The value t means whatever face the window's mode line currently uses
17586 \(either `mode-line' or `mode-line-inactive', depending).
17587 A value of nil means the default is no face property.
17588 If FACE is an integer, the value string has no text properties.
17590 Optional third and fourth args WINDOW and BUFFER specify the window
17591 and buffer to use as the context for the formatting (defaults
17592 are the selected window and the window's buffer). */)
17593 (format
, face
, window
, buffer
)
17594 Lisp_Object format
, face
, window
, buffer
;
17599 struct buffer
*old_buffer
= NULL
;
17601 int no_props
= INTEGERP (face
);
17602 int count
= SPECPDL_INDEX ();
17604 int string_start
= 0;
17607 window
= selected_window
;
17608 CHECK_WINDOW (window
);
17609 w
= XWINDOW (window
);
17612 buffer
= w
->buffer
;
17613 CHECK_BUFFER (buffer
);
17615 /* Make formatting the modeline a non-op when noninteractive, otherwise
17616 there will be problems later caused by a partially initialized frame. */
17617 if (NILP (format
) || noninteractive
)
17618 return empty_unibyte_string
;
17626 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17627 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17631 face_id
= DEFAULT_FACE_ID
;
17633 if (XBUFFER (buffer
) != current_buffer
)
17634 old_buffer
= current_buffer
;
17636 /* Save things including mode_line_proptrans_alist,
17637 and set that to nil so that we don't alter the outer value. */
17638 record_unwind_protect (unwind_format_mode_line
,
17639 format_mode_line_unwind_data (old_buffer
, 1));
17640 mode_line_proptrans_alist
= Qnil
;
17643 set_buffer_internal_1 (XBUFFER (buffer
));
17645 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17649 mode_line_target
= MODE_LINE_NOPROP
;
17650 mode_line_string_face_prop
= Qnil
;
17651 mode_line_string_list
= Qnil
;
17652 string_start
= MODE_LINE_NOPROP_LEN (0);
17656 mode_line_target
= MODE_LINE_STRING
;
17657 mode_line_string_list
= Qnil
;
17658 mode_line_string_face
= face
;
17659 mode_line_string_face_prop
17660 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17663 push_kboard (FRAME_KBOARD (it
.f
));
17664 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17669 len
= MODE_LINE_NOPROP_LEN (string_start
);
17670 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17674 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17675 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17676 empty_unibyte_string
);
17679 unbind_to (count
, Qnil
);
17683 /* Write a null-terminated, right justified decimal representation of
17684 the positive integer D to BUF using a minimal field width WIDTH. */
17687 pint2str (buf
, width
, d
)
17688 register char *buf
;
17689 register int width
;
17692 register char *p
= buf
;
17700 *p
++ = d
% 10 + '0';
17705 for (width
-= (int) (p
- buf
); width
> 0; --width
)
17716 /* Write a null-terminated, right justified decimal and "human
17717 readable" representation of the nonnegative integer D to BUF using
17718 a minimal field width WIDTH. D should be smaller than 999.5e24. */
17720 static const char power_letter
[] =
17734 pint2hrstr (buf
, width
, d
)
17739 /* We aim to represent the nonnegative integer D as
17740 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
17743 /* -1 means: do not use TENTHS. */
17747 /* Length of QUOTIENT.TENTHS as a string. */
17753 if (1000 <= quotient
)
17755 /* Scale to the appropriate EXPONENT. */
17758 remainder
= quotient
% 1000;
17762 while (1000 <= quotient
);
17764 /* Round to nearest and decide whether to use TENTHS or not. */
17767 tenths
= remainder
/ 100;
17768 if (50 <= remainder
% 100)
17775 if (quotient
== 10)
17783 if (500 <= remainder
)
17785 if (quotient
< 999)
17796 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
17797 if (tenths
== -1 && quotient
<= 99)
17804 p
= psuffix
= buf
+ max (width
, length
);
17806 /* Print EXPONENT. */
17808 *psuffix
++ = power_letter
[exponent
];
17811 /* Print TENTHS. */
17814 *--p
= '0' + tenths
;
17818 /* Print QUOTIENT. */
17821 int digit
= quotient
% 10;
17822 *--p
= '0' + digit
;
17824 while ((quotient
/= 10) != 0);
17826 /* Print leading spaces. */
17831 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
17832 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
17833 type of CODING_SYSTEM. Return updated pointer into BUF. */
17835 static unsigned char invalid_eol_type
[] = "(*invalid*)";
17838 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
17839 Lisp_Object coding_system
;
17840 register char *buf
;
17844 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
17845 const unsigned char *eol_str
;
17847 /* The EOL conversion we are using. */
17848 Lisp_Object eoltype
;
17850 val
= CODING_SYSTEM_SPEC (coding_system
);
17853 if (!VECTORP (val
)) /* Not yet decided. */
17858 eoltype
= eol_mnemonic_undecided
;
17859 /* Don't mention EOL conversion if it isn't decided. */
17864 Lisp_Object eolvalue
;
17866 attrs
= AREF (val
, 0);
17867 eolvalue
= AREF (val
, 2);
17870 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
17874 /* The EOL conversion that is normal on this system. */
17876 if (NILP (eolvalue
)) /* Not yet decided. */
17877 eoltype
= eol_mnemonic_undecided
;
17878 else if (VECTORP (eolvalue
)) /* Not yet decided. */
17879 eoltype
= eol_mnemonic_undecided
;
17880 else /* eolvalue is Qunix, Qdos, or Qmac. */
17881 eoltype
= (EQ (eolvalue
, Qunix
)
17882 ? eol_mnemonic_unix
17883 : (EQ (eolvalue
, Qdos
) == 1
17884 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
17890 /* Mention the EOL conversion if it is not the usual one. */
17891 if (STRINGP (eoltype
))
17893 eol_str
= SDATA (eoltype
);
17894 eol_str_len
= SBYTES (eoltype
);
17896 else if (CHARACTERP (eoltype
))
17898 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
17899 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
17904 eol_str
= invalid_eol_type
;
17905 eol_str_len
= sizeof (invalid_eol_type
) - 1;
17907 bcopy (eol_str
, buf
, eol_str_len
);
17908 buf
+= eol_str_len
;
17914 /* Return a string for the output of a mode line %-spec for window W,
17915 generated by character C. PRECISION >= 0 means don't return a
17916 string longer than that value. FIELD_WIDTH > 0 means pad the
17917 string returned with spaces to that value. Return 1 in *MULTIBYTE
17918 if the result is multibyte text.
17920 Note we operate on the current buffer for most purposes,
17921 the exception being w->base_line_pos. */
17923 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
17926 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
17929 int field_width
, precision
;
17933 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17934 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
17935 struct buffer
*b
= current_buffer
;
17943 if (!NILP (b
->read_only
))
17945 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17950 /* This differs from %* only for a modified read-only buffer. */
17951 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17953 if (!NILP (b
->read_only
))
17958 /* This differs from %* in ignoring read-only-ness. */
17959 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17971 if (command_loop_level
> 5)
17973 p
= decode_mode_spec_buf
;
17974 for (i
= 0; i
< command_loop_level
; i
++)
17977 return decode_mode_spec_buf
;
17985 if (command_loop_level
> 5)
17987 p
= decode_mode_spec_buf
;
17988 for (i
= 0; i
< command_loop_level
; i
++)
17991 return decode_mode_spec_buf
;
17998 /* Let lots_of_dashes be a string of infinite length. */
17999 if (mode_line_target
== MODE_LINE_NOPROP
||
18000 mode_line_target
== MODE_LINE_STRING
)
18002 if (field_width
<= 0
18003 || field_width
> sizeof (lots_of_dashes
))
18005 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18006 decode_mode_spec_buf
[i
] = '-';
18007 decode_mode_spec_buf
[i
] = '\0';
18008 return decode_mode_spec_buf
;
18011 return lots_of_dashes
;
18019 /* %c and %l are ignored in `frame-title-format'.
18020 (In redisplay_internal, the frame title is drawn _before_ the
18021 windows are updated, so the stuff which depends on actual
18022 window contents (such as %l) may fail to render properly, or
18023 even crash emacs.) */
18024 if (mode_line_target
== MODE_LINE_TITLE
)
18028 int col
= (int) current_column (); /* iftc */
18029 w
->column_number_displayed
= make_number (col
);
18030 pint2str (decode_mode_spec_buf
, field_width
, col
);
18031 return decode_mode_spec_buf
;
18035 #ifndef SYSTEM_MALLOC
18037 if (NILP (Vmemory_full
))
18040 return "!MEM FULL! ";
18047 /* %F displays the frame name. */
18048 if (!NILP (f
->title
))
18049 return (char *) SDATA (f
->title
);
18050 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18051 return (char *) SDATA (f
->name
);
18060 int size
= ZV
- BEGV
;
18061 pint2str (decode_mode_spec_buf
, field_width
, size
);
18062 return decode_mode_spec_buf
;
18067 int size
= ZV
- BEGV
;
18068 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18069 return decode_mode_spec_buf
;
18074 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18075 int topline
, nlines
, junk
, height
;
18077 /* %c and %l are ignored in `frame-title-format'. */
18078 if (mode_line_target
== MODE_LINE_TITLE
)
18081 startpos
= XMARKER (w
->start
)->charpos
;
18082 startpos_byte
= marker_byte_position (w
->start
);
18083 height
= WINDOW_TOTAL_LINES (w
);
18085 /* If we decided that this buffer isn't suitable for line numbers,
18086 don't forget that too fast. */
18087 if (EQ (w
->base_line_pos
, w
->buffer
))
18089 /* But do forget it, if the window shows a different buffer now. */
18090 else if (BUFFERP (w
->base_line_pos
))
18091 w
->base_line_pos
= Qnil
;
18093 /* If the buffer is very big, don't waste time. */
18094 if (INTEGERP (Vline_number_display_limit
)
18095 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18097 w
->base_line_pos
= Qnil
;
18098 w
->base_line_number
= Qnil
;
18102 if (!NILP (w
->base_line_number
)
18103 && !NILP (w
->base_line_pos
)
18104 && XFASTINT (w
->base_line_pos
) <= startpos
)
18106 line
= XFASTINT (w
->base_line_number
);
18107 linepos
= XFASTINT (w
->base_line_pos
);
18108 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18113 linepos
= BUF_BEGV (b
);
18114 linepos_byte
= BUF_BEGV_BYTE (b
);
18117 /* Count lines from base line to window start position. */
18118 nlines
= display_count_lines (linepos
, linepos_byte
,
18122 topline
= nlines
+ line
;
18124 /* Determine a new base line, if the old one is too close
18125 or too far away, or if we did not have one.
18126 "Too close" means it's plausible a scroll-down would
18127 go back past it. */
18128 if (startpos
== BUF_BEGV (b
))
18130 w
->base_line_number
= make_number (topline
);
18131 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18133 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18134 || linepos
== BUF_BEGV (b
))
18136 int limit
= BUF_BEGV (b
);
18137 int limit_byte
= BUF_BEGV_BYTE (b
);
18139 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18141 if (startpos
- distance
> limit
)
18143 limit
= startpos
- distance
;
18144 limit_byte
= CHAR_TO_BYTE (limit
);
18147 nlines
= display_count_lines (startpos
, startpos_byte
,
18149 - (height
* 2 + 30),
18151 /* If we couldn't find the lines we wanted within
18152 line_number_display_limit_width chars per line,
18153 give up on line numbers for this window. */
18154 if (position
== limit_byte
&& limit
== startpos
- distance
)
18156 w
->base_line_pos
= w
->buffer
;
18157 w
->base_line_number
= Qnil
;
18161 w
->base_line_number
= make_number (topline
- nlines
);
18162 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18165 /* Now count lines from the start pos to point. */
18166 nlines
= display_count_lines (startpos
, startpos_byte
,
18167 PT_BYTE
, PT
, &junk
);
18169 /* Record that we did display the line number. */
18170 line_number_displayed
= 1;
18172 /* Make the string to show. */
18173 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18174 return decode_mode_spec_buf
;
18177 char* p
= decode_mode_spec_buf
;
18178 int pad
= field_width
- 2;
18184 return decode_mode_spec_buf
;
18190 obj
= b
->mode_name
;
18194 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18200 int pos
= marker_position (w
->start
);
18201 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18203 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18205 if (pos
<= BUF_BEGV (b
))
18210 else if (pos
<= BUF_BEGV (b
))
18214 if (total
> 1000000)
18215 /* Do it differently for a large value, to avoid overflow. */
18216 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18218 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18219 /* We can't normally display a 3-digit number,
18220 so get us a 2-digit number that is close. */
18223 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18224 return decode_mode_spec_buf
;
18228 /* Display percentage of size above the bottom of the screen. */
18231 int toppos
= marker_position (w
->start
);
18232 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18233 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18235 if (botpos
>= BUF_ZV (b
))
18237 if (toppos
<= BUF_BEGV (b
))
18244 if (total
> 1000000)
18245 /* Do it differently for a large value, to avoid overflow. */
18246 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18248 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18249 /* We can't normally display a 3-digit number,
18250 so get us a 2-digit number that is close. */
18253 if (toppos
<= BUF_BEGV (b
))
18254 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18256 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18257 return decode_mode_spec_buf
;
18262 /* status of process */
18263 obj
= Fget_buffer_process (Fcurrent_buffer ());
18265 return "no process";
18266 #ifdef subprocesses
18267 obj
= Fsymbol_name (Fprocess_status (obj
));
18274 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18281 case 't': /* indicate TEXT or BINARY */
18282 #ifdef MODE_LINE_BINARY_TEXT
18283 return MODE_LINE_BINARY_TEXT (b
);
18289 /* coding-system (not including end-of-line format) */
18291 /* coding-system (including end-of-line type) */
18293 int eol_flag
= (c
== 'Z');
18294 char *p
= decode_mode_spec_buf
;
18296 if (! FRAME_WINDOW_P (f
))
18298 /* No need to mention EOL here--the terminal never needs
18299 to do EOL conversion. */
18300 p
= decode_mode_spec_coding (CODING_ID_NAME
18301 (FRAME_KEYBOARD_CODING (f
)->id
),
18303 p
= decode_mode_spec_coding (CODING_ID_NAME
18304 (FRAME_TERMINAL_CODING (f
)->id
),
18307 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18310 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18311 #ifdef subprocesses
18312 obj
= Fget_buffer_process (Fcurrent_buffer ());
18313 if (PROCESSP (obj
))
18315 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18317 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18320 #endif /* subprocesses */
18323 return decode_mode_spec_buf
;
18329 *multibyte
= STRING_MULTIBYTE (obj
);
18330 return (char *) SDATA (obj
);
18337 /* Count up to COUNT lines starting from START / START_BYTE.
18338 But don't go beyond LIMIT_BYTE.
18339 Return the number of lines thus found (always nonnegative).
18341 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18344 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18345 int start
, start_byte
, limit_byte
, count
;
18348 register unsigned char *cursor
;
18349 unsigned char *base
;
18351 register int ceiling
;
18352 register unsigned char *ceiling_addr
;
18353 int orig_count
= count
;
18355 /* If we are not in selective display mode,
18356 check only for newlines. */
18357 int selective_display
= (!NILP (current_buffer
->selective_display
)
18358 && !INTEGERP (current_buffer
->selective_display
));
18362 while (start_byte
< limit_byte
)
18364 ceiling
= BUFFER_CEILING_OF (start_byte
);
18365 ceiling
= min (limit_byte
- 1, ceiling
);
18366 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18367 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18370 if (selective_display
)
18371 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18374 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18377 if (cursor
!= ceiling_addr
)
18381 start_byte
+= cursor
- base
+ 1;
18382 *byte_pos_ptr
= start_byte
;
18386 if (++cursor
== ceiling_addr
)
18392 start_byte
+= cursor
- base
;
18397 while (start_byte
> limit_byte
)
18399 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18400 ceiling
= max (limit_byte
, ceiling
);
18401 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18402 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18405 if (selective_display
)
18406 while (--cursor
!= ceiling_addr
18407 && *cursor
!= '\n' && *cursor
!= 015)
18410 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18413 if (cursor
!= ceiling_addr
)
18417 start_byte
+= cursor
- base
+ 1;
18418 *byte_pos_ptr
= start_byte
;
18419 /* When scanning backwards, we should
18420 not count the newline posterior to which we stop. */
18421 return - orig_count
- 1;
18427 /* Here we add 1 to compensate for the last decrement
18428 of CURSOR, which took it past the valid range. */
18429 start_byte
+= cursor
- base
+ 1;
18433 *byte_pos_ptr
= limit_byte
;
18436 return - orig_count
+ count
;
18437 return orig_count
- count
;
18443 /***********************************************************************
18445 ***********************************************************************/
18447 /* Display a NUL-terminated string, starting with index START.
18449 If STRING is non-null, display that C string. Otherwise, the Lisp
18450 string LISP_STRING is displayed.
18452 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18453 FACE_STRING. Display STRING or LISP_STRING with the face at
18454 FACE_STRING_POS in FACE_STRING:
18456 Display the string in the environment given by IT, but use the
18457 standard display table, temporarily.
18459 FIELD_WIDTH is the minimum number of output glyphs to produce.
18460 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18461 with spaces. If STRING has more characters, more than FIELD_WIDTH
18462 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18464 PRECISION is the maximum number of characters to output from
18465 STRING. PRECISION < 0 means don't truncate the string.
18467 This is roughly equivalent to printf format specifiers:
18469 FIELD_WIDTH PRECISION PRINTF
18470 ----------------------------------------
18476 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18477 display them, and < 0 means obey the current buffer's value of
18478 enable_multibyte_characters.
18480 Value is the number of columns displayed. */
18483 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18484 start
, it
, field_width
, precision
, max_x
, multibyte
)
18485 unsigned char *string
;
18486 Lisp_Object lisp_string
;
18487 Lisp_Object face_string
;
18488 int face_string_pos
;
18491 int field_width
, precision
, max_x
;
18494 int hpos_at_start
= it
->hpos
;
18495 int saved_face_id
= it
->face_id
;
18496 struct glyph_row
*row
= it
->glyph_row
;
18498 /* Initialize the iterator IT for iteration over STRING beginning
18499 with index START. */
18500 reseat_to_string (it
, string
, lisp_string
, start
,
18501 precision
, field_width
, multibyte
);
18503 /* If displaying STRING, set up the face of the iterator
18504 from LISP_STRING, if that's given. */
18505 if (STRINGP (face_string
))
18511 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18512 0, it
->region_beg_charpos
,
18513 it
->region_end_charpos
,
18514 &endptr
, it
->base_face_id
, 0);
18515 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18516 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18519 /* Set max_x to the maximum allowed X position. Don't let it go
18520 beyond the right edge of the window. */
18522 max_x
= it
->last_visible_x
;
18524 max_x
= min (max_x
, it
->last_visible_x
);
18526 /* Skip over display elements that are not visible. because IT->w is
18528 if (it
->current_x
< it
->first_visible_x
)
18529 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18530 MOVE_TO_POS
| MOVE_TO_X
);
18532 row
->ascent
= it
->max_ascent
;
18533 row
->height
= it
->max_ascent
+ it
->max_descent
;
18534 row
->phys_ascent
= it
->max_phys_ascent
;
18535 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18536 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18538 /* This condition is for the case that we are called with current_x
18539 past last_visible_x. */
18540 while (it
->current_x
< max_x
)
18542 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18544 /* Get the next display element. */
18545 if (!get_next_display_element (it
))
18548 /* Produce glyphs. */
18549 x_before
= it
->current_x
;
18550 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18551 PRODUCE_GLYPHS (it
);
18553 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18556 while (i
< nglyphs
)
18558 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18560 if (!it
->truncate_lines_p
18561 && x
+ glyph
->pixel_width
> max_x
)
18563 /* End of continued line or max_x reached. */
18564 if (CHAR_GLYPH_PADDING_P (*glyph
))
18566 /* A wide character is unbreakable. */
18567 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18568 it
->current_x
= x_before
;
18572 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18577 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18579 /* Glyph is at least partially visible. */
18581 if (x
< it
->first_visible_x
)
18582 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18586 /* Glyph is off the left margin of the display area.
18587 Should not happen. */
18591 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18592 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18593 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18594 row
->phys_height
= max (row
->phys_height
,
18595 it
->max_phys_ascent
+ it
->max_phys_descent
);
18596 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18597 it
->max_extra_line_spacing
);
18598 x
+= glyph
->pixel_width
;
18602 /* Stop if max_x reached. */
18606 /* Stop at line ends. */
18607 if (ITERATOR_AT_END_OF_LINE_P (it
))
18609 it
->continuation_lines_width
= 0;
18613 set_iterator_to_next (it
, 1);
18615 /* Stop if truncating at the right edge. */
18616 if (it
->truncate_lines_p
18617 && it
->current_x
>= it
->last_visible_x
)
18619 /* Add truncation mark, but don't do it if the line is
18620 truncated at a padding space. */
18621 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18623 if (!FRAME_WINDOW_P (it
->f
))
18627 if (it
->current_x
> it
->last_visible_x
)
18629 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18630 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18632 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18634 row
->used
[TEXT_AREA
] = i
;
18635 produce_special_glyphs (it
, IT_TRUNCATION
);
18638 produce_special_glyphs (it
, IT_TRUNCATION
);
18640 it
->glyph_row
->truncated_on_right_p
= 1;
18646 /* Maybe insert a truncation at the left. */
18647 if (it
->first_visible_x
18648 && IT_CHARPOS (*it
) > 0)
18650 if (!FRAME_WINDOW_P (it
->f
))
18651 insert_left_trunc_glyphs (it
);
18652 it
->glyph_row
->truncated_on_left_p
= 1;
18655 it
->face_id
= saved_face_id
;
18657 /* Value is number of columns displayed. */
18658 return it
->hpos
- hpos_at_start
;
18663 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18664 appears as an element of LIST or as the car of an element of LIST.
18665 If PROPVAL is a list, compare each element against LIST in that
18666 way, and return 1/2 if any element of PROPVAL is found in LIST.
18667 Otherwise return 0. This function cannot quit.
18668 The return value is 2 if the text is invisible but with an ellipsis
18669 and 1 if it's invisible and without an ellipsis. */
18672 invisible_p (propval
, list
)
18673 register Lisp_Object propval
;
18676 register Lisp_Object tail
, proptail
;
18678 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18680 register Lisp_Object tem
;
18682 if (EQ (propval
, tem
))
18684 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
18685 return NILP (XCDR (tem
)) ? 1 : 2;
18688 if (CONSP (propval
))
18690 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
18692 Lisp_Object propelt
;
18693 propelt
= XCAR (proptail
);
18694 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18696 register Lisp_Object tem
;
18698 if (EQ (propelt
, tem
))
18700 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
18701 return NILP (XCDR (tem
)) ? 1 : 2;
18709 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
18710 doc
: /* Non-nil if the property makes the text invisible.
18711 POS-OR-PROP can be a marker or number, in which case it is taken to be
18712 a position in the current buffer and the value of the `invisible' property
18713 is checked; or it can be some other value, which is then presumed to be the
18714 value of the `invisible' property of the text of interest.
18715 The non-nil value returned can be t for truly invisible text or something
18716 else if the text is replaced by an ellipsis. */)
18718 Lisp_Object pos_or_prop
;
18721 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
18722 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
18724 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
18725 return (invis
== 0 ? Qnil
18727 : make_number (invis
));
18730 /* Calculate a width or height in pixels from a specification using
18731 the following elements:
18734 NUM - a (fractional) multiple of the default font width/height
18735 (NUM) - specifies exactly NUM pixels
18736 UNIT - a fixed number of pixels, see below.
18737 ELEMENT - size of a display element in pixels, see below.
18738 (NUM . SPEC) - equals NUM * SPEC
18739 (+ SPEC SPEC ...) - add pixel values
18740 (- SPEC SPEC ...) - subtract pixel values
18741 (- SPEC) - negate pixel value
18744 INT or FLOAT - a number constant
18745 SYMBOL - use symbol's (buffer local) variable binding.
18748 in - pixels per inch *)
18749 mm - pixels per 1/1000 meter *)
18750 cm - pixels per 1/100 meter *)
18751 width - width of current font in pixels.
18752 height - height of current font in pixels.
18754 *) using the ratio(s) defined in display-pixels-per-inch.
18758 left-fringe - left fringe width in pixels
18759 right-fringe - right fringe width in pixels
18761 left-margin - left margin width in pixels
18762 right-margin - right margin width in pixels
18764 scroll-bar - scroll-bar area width in pixels
18768 Pixels corresponding to 5 inches:
18771 Total width of non-text areas on left side of window (if scroll-bar is on left):
18772 '(space :width (+ left-fringe left-margin scroll-bar))
18774 Align to first text column (in header line):
18775 '(space :align-to 0)
18777 Align to middle of text area minus half the width of variable `my-image'
18778 containing a loaded image:
18779 '(space :align-to (0.5 . (- text my-image)))
18781 Width of left margin minus width of 1 character in the default font:
18782 '(space :width (- left-margin 1))
18784 Width of left margin minus width of 2 characters in the current font:
18785 '(space :width (- left-margin (2 . width)))
18787 Center 1 character over left-margin (in header line):
18788 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
18790 Different ways to express width of left fringe plus left margin minus one pixel:
18791 '(space :width (- (+ left-fringe left-margin) (1)))
18792 '(space :width (+ left-fringe left-margin (- (1))))
18793 '(space :width (+ left-fringe left-margin (-1)))
18797 #define NUMVAL(X) \
18798 ((INTEGERP (X) || FLOATP (X)) \
18803 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
18808 int width_p
, *align_to
;
18812 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
18813 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
18816 return OK_PIXELS (0);
18818 xassert (FRAME_LIVE_P (it
->f
));
18820 if (SYMBOLP (prop
))
18822 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
18824 char *unit
= SDATA (SYMBOL_NAME (prop
));
18826 if (unit
[0] == 'i' && unit
[1] == 'n')
18828 else if (unit
[0] == 'm' && unit
[1] == 'm')
18830 else if (unit
[0] == 'c' && unit
[1] == 'm')
18837 #ifdef HAVE_WINDOW_SYSTEM
18838 if (FRAME_WINDOW_P (it
->f
)
18840 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
18841 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
18843 return OK_PIXELS (ppi
/ pixels
);
18846 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
18847 || (CONSP (Vdisplay_pixels_per_inch
)
18849 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
18850 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
18852 return OK_PIXELS (ppi
/ pixels
);
18858 #ifdef HAVE_WINDOW_SYSTEM
18859 if (EQ (prop
, Qheight
))
18860 return OK_PIXELS (font
? FONT_HEIGHT ((XFontStruct
*)font
) : FRAME_LINE_HEIGHT (it
->f
));
18861 if (EQ (prop
, Qwidth
))
18862 return OK_PIXELS (font
? FONT_WIDTH ((XFontStruct
*)font
) : FRAME_COLUMN_WIDTH (it
->f
));
18864 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
18865 return OK_PIXELS (1);
18868 if (EQ (prop
, Qtext
))
18869 return OK_PIXELS (width_p
18870 ? window_box_width (it
->w
, TEXT_AREA
)
18871 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
18873 if (align_to
&& *align_to
< 0)
18876 if (EQ (prop
, Qleft
))
18877 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
18878 if (EQ (prop
, Qright
))
18879 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
18880 if (EQ (prop
, Qcenter
))
18881 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
18882 + window_box_width (it
->w
, TEXT_AREA
) / 2);
18883 if (EQ (prop
, Qleft_fringe
))
18884 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18885 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
18886 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
18887 if (EQ (prop
, Qright_fringe
))
18888 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18889 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18890 : window_box_right_offset (it
->w
, TEXT_AREA
));
18891 if (EQ (prop
, Qleft_margin
))
18892 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
18893 if (EQ (prop
, Qright_margin
))
18894 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
18895 if (EQ (prop
, Qscroll_bar
))
18896 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
18898 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18899 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18900 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
18905 if (EQ (prop
, Qleft_fringe
))
18906 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
18907 if (EQ (prop
, Qright_fringe
))
18908 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
18909 if (EQ (prop
, Qleft_margin
))
18910 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
18911 if (EQ (prop
, Qright_margin
))
18912 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
18913 if (EQ (prop
, Qscroll_bar
))
18914 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
18917 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
18920 if (INTEGERP (prop
) || FLOATP (prop
))
18922 int base_unit
= (width_p
18923 ? FRAME_COLUMN_WIDTH (it
->f
)
18924 : FRAME_LINE_HEIGHT (it
->f
));
18925 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
18930 Lisp_Object car
= XCAR (prop
);
18931 Lisp_Object cdr
= XCDR (prop
);
18935 #ifdef HAVE_WINDOW_SYSTEM
18936 if (FRAME_WINDOW_P (it
->f
)
18937 && valid_image_p (prop
))
18939 int id
= lookup_image (it
->f
, prop
);
18940 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
18942 return OK_PIXELS (width_p
? img
->width
: img
->height
);
18945 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
18951 while (CONSP (cdr
))
18953 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
18954 font
, width_p
, align_to
))
18957 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
18962 if (EQ (car
, Qminus
))
18964 return OK_PIXELS (pixels
);
18967 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
18970 if (INTEGERP (car
) || FLOATP (car
))
18973 pixels
= XFLOATINT (car
);
18975 return OK_PIXELS (pixels
);
18976 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
18977 font
, width_p
, align_to
))
18978 return OK_PIXELS (pixels
* fact
);
18989 /***********************************************************************
18991 ***********************************************************************/
18993 #ifdef HAVE_WINDOW_SYSTEM
18998 dump_glyph_string (s
)
18999 struct glyph_string
*s
;
19001 fprintf (stderr
, "glyph string\n");
19002 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19003 s
->x
, s
->y
, s
->width
, s
->height
);
19004 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19005 fprintf (stderr
, " hl = %d\n", s
->hl
);
19006 fprintf (stderr
, " left overhang = %d, right = %d\n",
19007 s
->left_overhang
, s
->right_overhang
);
19008 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19009 fprintf (stderr
, " extends to end of line = %d\n",
19010 s
->extends_to_end_of_line_p
);
19011 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19012 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19015 #endif /* GLYPH_DEBUG */
19017 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19018 of XChar2b structures for S; it can't be allocated in
19019 init_glyph_string because it must be allocated via `alloca'. W
19020 is the window on which S is drawn. ROW and AREA are the glyph row
19021 and area within the row from which S is constructed. START is the
19022 index of the first glyph structure covered by S. HL is a
19023 face-override for drawing S. */
19026 #define OPTIONAL_HDC(hdc) hdc,
19027 #define DECLARE_HDC(hdc) HDC hdc;
19028 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19029 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19032 #ifndef OPTIONAL_HDC
19033 #define OPTIONAL_HDC(hdc)
19034 #define DECLARE_HDC(hdc)
19035 #define ALLOCATE_HDC(hdc, f)
19036 #define RELEASE_HDC(hdc, f)
19040 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19041 struct glyph_string
*s
;
19045 struct glyph_row
*row
;
19046 enum glyph_row_area area
;
19048 enum draw_glyphs_face hl
;
19050 bzero (s
, sizeof *s
);
19052 s
->f
= XFRAME (w
->frame
);
19056 s
->display
= FRAME_X_DISPLAY (s
->f
);
19057 s
->window
= FRAME_X_WINDOW (s
->f
);
19058 s
->char2b
= char2b
;
19062 s
->first_glyph
= row
->glyphs
[area
] + start
;
19063 s
->height
= row
->height
;
19064 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19066 /* Display the internal border below the tool-bar window. */
19067 if (WINDOWP (s
->f
->tool_bar_window
)
19068 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19069 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19071 s
->ybase
= s
->y
+ row
->ascent
;
19075 /* Append the list of glyph strings with head H and tail T to the list
19076 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19079 append_glyph_string_lists (head
, tail
, h
, t
)
19080 struct glyph_string
**head
, **tail
;
19081 struct glyph_string
*h
, *t
;
19095 /* Prepend the list of glyph strings with head H and tail T to the
19096 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19100 prepend_glyph_string_lists (head
, tail
, h
, t
)
19101 struct glyph_string
**head
, **tail
;
19102 struct glyph_string
*h
, *t
;
19116 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19117 Set *HEAD and *TAIL to the resulting list. */
19120 append_glyph_string (head
, tail
, s
)
19121 struct glyph_string
**head
, **tail
;
19122 struct glyph_string
*s
;
19124 s
->next
= s
->prev
= NULL
;
19125 append_glyph_string_lists (head
, tail
, s
, s
);
19129 /* Get face and two-byte form of character C in face FACE_ID on frame
19130 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19131 means we want to display multibyte text. DISPLAY_P non-zero means
19132 make sure that X resources for the face returned are allocated.
19133 Value is a pointer to a realized face that is ready for display if
19134 DISPLAY_P is non-zero. */
19136 static INLINE
struct face
*
19137 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19141 int multibyte_p
, display_p
;
19143 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19145 #ifdef USE_FONT_BACKEND
19146 if (enable_font_backend
)
19148 struct font
*font
= (struct font
*) face
->font_info
;
19152 unsigned code
= font
->driver
->encode_char (font
, c
);
19154 if (code
!= FONT_INVALID_CODE
)
19155 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19157 STORE_XCHAR2B (char2b
, 0, 0);
19161 #endif /* USE_FONT_BACKEND */
19164 /* Unibyte case. We don't have to encode, but we have to make
19165 sure to use a face suitable for unibyte. */
19166 STORE_XCHAR2B (char2b
, 0, c
);
19167 face_id
= FACE_FOR_CHAR (f
, face
, c
, -1, Qnil
);
19168 face
= FACE_FROM_ID (f
, face_id
);
19172 /* Case of ASCII in a face known to fit ASCII. */
19173 STORE_XCHAR2B (char2b
, 0, c
);
19175 else if (face
->font
!= NULL
)
19177 struct font_info
*font_info
19178 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19179 struct charset
*charset
= CHARSET_FROM_ID (font_info
->charset
);
19180 unsigned code
= ENCODE_CHAR (charset
, c
);
19182 if (CHARSET_DIMENSION (charset
) == 1)
19183 STORE_XCHAR2B (char2b
, 0, code
);
19185 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19186 /* Maybe encode the character in *CHAR2B. */
19187 FRAME_RIF (f
)->encode_char (c
, char2b
, font_info
, charset
, NULL
);
19190 /* Make sure X resources of the face are allocated. */
19191 #ifdef HAVE_X_WINDOWS
19195 xassert (face
!= NULL
);
19196 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19203 /* Get face and two-byte form of character glyph GLYPH on frame F.
19204 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19205 a pointer to a realized face that is ready for display. */
19207 static INLINE
struct face
*
19208 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19210 struct glyph
*glyph
;
19216 xassert (glyph
->type
== CHAR_GLYPH
);
19217 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19222 #ifdef USE_FONT_BACKEND
19223 if (enable_font_backend
)
19225 struct font
*font
= (struct font
*) face
->font_info
;
19229 unsigned code
= font
->driver
->encode_char (font
, glyph
->u
.ch
);
19231 if (code
!= FONT_INVALID_CODE
)
19232 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19234 STORE_XCHAR2B (char2b
, 0, code
);
19238 #endif /* USE_FONT_BACKEND */
19239 if (!glyph
->multibyte_p
)
19241 /* Unibyte case. We don't have to encode, but we have to make
19242 sure to use a face suitable for unibyte. */
19243 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
19245 else if (glyph
->u
.ch
< 128)
19247 /* Case of ASCII in a face known to fit ASCII. */
19248 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
19252 struct font_info
*font_info
19253 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19256 struct charset
*charset
= CHARSET_FROM_ID (font_info
->charset
);
19257 unsigned code
= ENCODE_CHAR (charset
, glyph
->u
.ch
);
19259 if (CHARSET_DIMENSION (charset
) == 1)
19260 STORE_XCHAR2B (char2b
, 0, code
);
19262 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19264 /* Maybe encode the character in *CHAR2B. */
19265 if (CHARSET_ID (charset
) != charset_ascii
)
19268 = FRAME_RIF (f
)->encode_char (glyph
->u
.ch
, char2b
, font_info
,
19269 charset
, two_byte_p
);
19274 /* Make sure X resources of the face are allocated. */
19275 xassert (face
!= NULL
);
19276 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19281 /* Fill glyph string S with composition components specified by S->cmp.
19283 BASE_FACE is the base face of the composition.
19284 S->gidx is the index of the first component for S.
19286 OVERLAPS non-zero means S should draw the foreground only, and use
19287 its physical height for clipping. See also draw_glyphs.
19289 Value is the index of a component not in S. */
19292 fill_composite_glyph_string (s
, base_face
, overlaps
)
19293 struct glyph_string
*s
;
19294 struct face
*base_face
;
19301 s
->for_overlaps
= overlaps
;
19303 #ifdef USE_FONT_BACKEND
19304 if (enable_font_backend
&& s
->cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
19306 Lisp_Object gstring
19307 = AREF (XHASH_TABLE (composition_hash_table
)->key_and_value
,
19308 s
->cmp
->hash_index
* 2);
19310 s
->face
= base_face
;
19311 s
->font_info
= s
->cmp
->font
;
19312 s
->font
= s
->font_info
->font
;
19313 for (i
= 0, s
->nchars
= 0; i
< s
->cmp
->glyph_len
; i
++, s
->nchars
++)
19315 Lisp_Object g
= LGSTRING_GLYPH (gstring
, i
);
19317 XChar2b
* store_pos
;
19320 code
= LGLYPH_CODE (g
);
19321 store_pos
= s
->char2b
+ i
;
19322 STORE_XCHAR2B (store_pos
, code
>> 8, code
& 0xFF);
19324 s
->width
= s
->cmp
->pixel_width
;
19327 #endif /* USE_FONT_BACKEND */
19329 /* For all glyphs of this composition, starting at the offset
19330 S->gidx, until we reach the end of the definition or encounter a
19331 glyph that requires the different face, add it to S. */
19336 s
->font_info
= NULL
;
19337 for (i
= s
->gidx
; i
< s
->cmp
->glyph_len
; i
++)
19339 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19343 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
, c
, -1, Qnil
);
19345 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19346 s
->char2b
+ i
, 1, 1);
19352 s
->font
= s
->face
->font
;
19353 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19355 else if (s
->face
!= face
)
19362 /* All glyph strings for the same composition has the same width,
19363 i.e. the width set for the first component of the composition. */
19364 s
->width
= s
->first_glyph
->pixel_width
;
19367 /* If the specified font could not be loaded, use the frame's
19368 default font, but record the fact that we couldn't load it in
19369 the glyph string so that we can draw rectangles for the
19370 characters of the glyph string. */
19371 if (s
->font
== NULL
)
19373 s
->font_not_found_p
= 1;
19374 s
->font
= FRAME_FONT (s
->f
);
19377 /* Adjust base line for subscript/superscript text. */
19378 s
->ybase
+= s
->first_glyph
->voffset
;
19380 /* This glyph string must always be drawn with 16-bit functions. */
19383 return s
->gidx
+ s
->nchars
;
19387 /* Fill glyph string S from a sequence of character glyphs.
19389 FACE_ID is the face id of the string. START is the index of the
19390 first glyph to consider, END is the index of the last + 1.
19391 OVERLAPS non-zero means S should draw the foreground only, and use
19392 its physical height for clipping. See also draw_glyphs.
19394 Value is the index of the first glyph not in S. */
19397 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19398 struct glyph_string
*s
;
19400 int start
, end
, overlaps
;
19402 struct glyph
*glyph
, *last
;
19404 int glyph_not_available_p
;
19406 xassert (s
->f
== XFRAME (s
->w
->frame
));
19407 xassert (s
->nchars
== 0);
19408 xassert (start
>= 0 && end
> start
);
19410 s
->for_overlaps
= overlaps
,
19411 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19412 last
= s
->row
->glyphs
[s
->area
] + end
;
19413 voffset
= glyph
->voffset
;
19415 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19417 while (glyph
< last
19418 && glyph
->type
== CHAR_GLYPH
19419 && glyph
->voffset
== voffset
19420 /* Same face id implies same font, nowadays. */
19421 && glyph
->face_id
== face_id
19422 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19426 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19427 s
->char2b
+ s
->nchars
,
19429 s
->two_byte_p
= two_byte_p
;
19431 xassert (s
->nchars
<= end
- start
);
19432 s
->width
+= glyph
->pixel_width
;
19436 s
->font
= s
->face
->font
;
19437 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19439 /* If the specified font could not be loaded, use the frame's font,
19440 but record the fact that we couldn't load it in
19441 S->font_not_found_p so that we can draw rectangles for the
19442 characters of the glyph string. */
19443 if (s
->font
== NULL
|| glyph_not_available_p
)
19445 s
->font_not_found_p
= 1;
19446 s
->font
= FRAME_FONT (s
->f
);
19449 /* Adjust base line for subscript/superscript text. */
19450 s
->ybase
+= voffset
;
19452 xassert (s
->face
&& s
->face
->gc
);
19453 return glyph
- s
->row
->glyphs
[s
->area
];
19457 /* Fill glyph string S from image glyph S->first_glyph. */
19460 fill_image_glyph_string (s
)
19461 struct glyph_string
*s
;
19463 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19464 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19466 s
->slice
= s
->first_glyph
->slice
;
19467 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19468 s
->font
= s
->face
->font
;
19469 s
->width
= s
->first_glyph
->pixel_width
;
19471 /* Adjust base line for subscript/superscript text. */
19472 s
->ybase
+= s
->first_glyph
->voffset
;
19476 /* Fill glyph string S from a sequence of stretch glyphs.
19478 ROW is the glyph row in which the glyphs are found, AREA is the
19479 area within the row. START is the index of the first glyph to
19480 consider, END is the index of the last + 1.
19482 Value is the index of the first glyph not in S. */
19485 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19486 struct glyph_string
*s
;
19487 struct glyph_row
*row
;
19488 enum glyph_row_area area
;
19491 struct glyph
*glyph
, *last
;
19492 int voffset
, face_id
;
19494 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19496 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19497 last
= s
->row
->glyphs
[s
->area
] + end
;
19498 face_id
= glyph
->face_id
;
19499 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19500 s
->font
= s
->face
->font
;
19501 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19502 s
->width
= glyph
->pixel_width
;
19504 voffset
= glyph
->voffset
;
19508 && glyph
->type
== STRETCH_GLYPH
19509 && glyph
->voffset
== voffset
19510 && glyph
->face_id
== face_id
);
19512 s
->width
+= glyph
->pixel_width
;
19514 /* Adjust base line for subscript/superscript text. */
19515 s
->ybase
+= voffset
;
19517 /* The case that face->gc == 0 is handled when drawing the glyph
19518 string by calling PREPARE_FACE_FOR_DISPLAY. */
19520 return glyph
- s
->row
->glyphs
[s
->area
];
19523 static XCharStruct
*
19524 get_per_char_metric (f
, font
, font_info
, char2b
, font_type
)
19527 struct font_info
*font_info
;
19531 #ifdef USE_FONT_BACKEND
19532 if (enable_font_backend
)
19534 static XCharStruct pcm_value
;
19535 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19536 struct font
*fontp
;
19537 struct font_metrics metrics
;
19539 if (! font_info
|| code
== FONT_INVALID_CODE
)
19541 fontp
= (struct font
*) font_info
;
19542 fontp
->driver
->text_extents (fontp
, &code
, 1, &metrics
);
19543 pcm_value
.lbearing
= metrics
.lbearing
;
19544 pcm_value
.rbearing
= metrics
.rbearing
;
19545 pcm_value
.ascent
= metrics
.ascent
;
19546 pcm_value
.descent
= metrics
.descent
;
19547 pcm_value
.width
= metrics
.width
;
19550 #endif /* USE_FONT_BACKEND */
19551 return FRAME_RIF (f
)->per_char_metric (font
, char2b
, font_type
);
19555 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19556 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19557 assumed to be zero. */
19560 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19561 struct glyph
*glyph
;
19565 *left
= *right
= 0;
19567 if (glyph
->type
== CHAR_GLYPH
)
19571 struct font_info
*font_info
;
19575 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19577 font_info
= FONT_INFO_FROM_FACE (f
, face
);
19578 if (font
/* ++KFS: Should this be font_info ? */
19579 && (pcm
= get_per_char_metric (f
, font
, font_info
, &char2b
, glyph
->font_type
)))
19581 if (pcm
->rbearing
> pcm
->width
)
19582 *right
= pcm
->rbearing
- pcm
->width
;
19583 if (pcm
->lbearing
< 0)
19584 *left
= -pcm
->lbearing
;
19587 else if (glyph
->type
== COMPOSITE_GLYPH
)
19589 struct composition
*cmp
= composition_table
[glyph
->u
.cmp_id
];
19591 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19592 *left
= - cmp
->lbearing
;
19597 /* Return the index of the first glyph preceding glyph string S that
19598 is overwritten by S because of S's left overhang. Value is -1
19599 if no glyphs are overwritten. */
19602 left_overwritten (s
)
19603 struct glyph_string
*s
;
19607 if (s
->left_overhang
)
19610 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19611 int first
= s
->first_glyph
- glyphs
;
19613 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19614 x
-= glyphs
[i
].pixel_width
;
19625 /* Return the index of the first glyph preceding glyph string S that
19626 is overwriting S because of its right overhang. Value is -1 if no
19627 glyph in front of S overwrites S. */
19630 left_overwriting (s
)
19631 struct glyph_string
*s
;
19634 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19635 int first
= s
->first_glyph
- glyphs
;
19639 for (i
= first
- 1; i
>= 0; --i
)
19642 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19645 x
-= glyphs
[i
].pixel_width
;
19652 /* Return the index of the last glyph following glyph string S that is
19653 not overwritten by S because of S's right overhang. Value is -1 if
19654 no such glyph is found. */
19657 right_overwritten (s
)
19658 struct glyph_string
*s
;
19662 if (s
->right_overhang
)
19665 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19666 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19667 int end
= s
->row
->used
[s
->area
];
19669 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19670 x
+= glyphs
[i
].pixel_width
;
19679 /* Return the index of the last glyph following glyph string S that
19680 overwrites S because of its left overhang. Value is negative
19681 if no such glyph is found. */
19684 right_overwriting (s
)
19685 struct glyph_string
*s
;
19688 int end
= s
->row
->used
[s
->area
];
19689 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19690 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19694 for (i
= first
; i
< end
; ++i
)
19697 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19700 x
+= glyphs
[i
].pixel_width
;
19707 /* Set background width of glyph string S. START is the index of the
19708 first glyph following S. LAST_X is the right-most x-position + 1
19709 in the drawing area. */
19712 set_glyph_string_background_width (s
, start
, last_x
)
19713 struct glyph_string
*s
;
19717 /* If the face of this glyph string has to be drawn to the end of
19718 the drawing area, set S->extends_to_end_of_line_p. */
19720 if (start
== s
->row
->used
[s
->area
]
19721 && s
->area
== TEXT_AREA
19722 && ((s
->row
->fill_line_p
19723 && (s
->hl
== DRAW_NORMAL_TEXT
19724 || s
->hl
== DRAW_IMAGE_RAISED
19725 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19726 || s
->hl
== DRAW_MOUSE_FACE
))
19727 s
->extends_to_end_of_line_p
= 1;
19729 /* If S extends its face to the end of the line, set its
19730 background_width to the distance to the right edge of the drawing
19732 if (s
->extends_to_end_of_line_p
)
19733 s
->background_width
= last_x
- s
->x
+ 1;
19735 s
->background_width
= s
->width
;
19739 /* Compute overhangs and x-positions for glyph string S and its
19740 predecessors, or successors. X is the starting x-position for S.
19741 BACKWARD_P non-zero means process predecessors. */
19744 compute_overhangs_and_x (s
, x
, backward_p
)
19745 struct glyph_string
*s
;
19753 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19754 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19764 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19765 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19775 /* The following macros are only called from draw_glyphs below.
19776 They reference the following parameters of that function directly:
19777 `w', `row', `area', and `overlap_p'
19778 as well as the following local variables:
19779 `s', `f', and `hdc' (in W32) */
19782 /* On W32, silently add local `hdc' variable to argument list of
19783 init_glyph_string. */
19784 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19785 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
19787 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19788 init_glyph_string (s, char2b, w, row, area, start, hl)
19791 /* Add a glyph string for a stretch glyph to the list of strings
19792 between HEAD and TAIL. START is the index of the stretch glyph in
19793 row area AREA of glyph row ROW. END is the index of the last glyph
19794 in that glyph row area. X is the current output position assigned
19795 to the new glyph string constructed. HL overrides that face of the
19796 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19797 is the right-most x-position of the drawing area. */
19799 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
19800 and below -- keep them on one line. */
19801 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19804 s = (struct glyph_string *) alloca (sizeof *s); \
19805 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19806 START = fill_stretch_glyph_string (s, row, area, START, END); \
19807 append_glyph_string (&HEAD, &TAIL, s); \
19813 /* Add a glyph string for an image glyph to the list of strings
19814 between HEAD and TAIL. START is the index of the image glyph in
19815 row area AREA of glyph row ROW. END is the index of the last glyph
19816 in that glyph row area. X is the current output position assigned
19817 to the new glyph string constructed. HL overrides that face of the
19818 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19819 is the right-most x-position of the drawing area. */
19821 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19824 s = (struct glyph_string *) alloca (sizeof *s); \
19825 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19826 fill_image_glyph_string (s); \
19827 append_glyph_string (&HEAD, &TAIL, s); \
19834 /* Add a glyph string for a sequence of character glyphs to the list
19835 of strings between HEAD and TAIL. START is the index of the first
19836 glyph in row area AREA of glyph row ROW that is part of the new
19837 glyph string. END is the index of the last glyph in that glyph row
19838 area. X is the current output position assigned to the new glyph
19839 string constructed. HL overrides that face of the glyph; e.g. it
19840 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
19841 right-most x-position of the drawing area. */
19843 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19849 face_id = (row)->glyphs[area][START].face_id; \
19851 s = (struct glyph_string *) alloca (sizeof *s); \
19852 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
19853 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19854 append_glyph_string (&HEAD, &TAIL, s); \
19856 START = fill_glyph_string (s, face_id, START, END, overlaps); \
19861 /* Add a glyph string for a composite sequence to the list of strings
19862 between HEAD and TAIL. START is the index of the first glyph in
19863 row area AREA of glyph row ROW that is part of the new glyph
19864 string. END is the index of the last glyph in that glyph row area.
19865 X is the current output position assigned to the new glyph string
19866 constructed. HL overrides that face of the glyph; e.g. it is
19867 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
19868 x-position of the drawing area. */
19870 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19872 int face_id = (row)->glyphs[area][START].face_id; \
19873 struct face *base_face = FACE_FROM_ID (f, face_id); \
19874 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
19875 struct composition *cmp = composition_table[cmp_id]; \
19877 struct glyph_string *first_s; \
19880 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
19881 base_face = base_face->ascii_face; \
19883 /* Make glyph_strings for each glyph sequence that is drawable by \
19884 the same face, and append them to HEAD/TAIL. */ \
19885 for (n = 0; n < cmp->glyph_len;) \
19887 s = (struct glyph_string *) alloca (sizeof *s); \
19888 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19889 append_glyph_string (&(HEAD), &(TAIL), s); \
19895 n = fill_composite_glyph_string (s, base_face, overlaps); \
19903 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
19904 of AREA of glyph row ROW on window W between indices START and END.
19905 HL overrides the face for drawing glyph strings, e.g. it is
19906 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
19907 x-positions of the drawing area.
19909 This is an ugly monster macro construct because we must use alloca
19910 to allocate glyph strings (because draw_glyphs can be called
19911 asynchronously). */
19913 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19916 HEAD = TAIL = NULL; \
19917 while (START < END) \
19919 struct glyph *first_glyph = (row)->glyphs[area] + START; \
19920 switch (first_glyph->type) \
19923 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
19927 case COMPOSITE_GLYPH: \
19928 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
19932 case STRETCH_GLYPH: \
19933 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
19937 case IMAGE_GLYPH: \
19938 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
19948 set_glyph_string_background_width (s, START, LAST_X); \
19956 /* Draw glyphs between START and END in AREA of ROW on window W,
19957 starting at x-position X. X is relative to AREA in W. HL is a
19958 face-override with the following meaning:
19960 DRAW_NORMAL_TEXT draw normally
19961 DRAW_CURSOR draw in cursor face
19962 DRAW_MOUSE_FACE draw in mouse face.
19963 DRAW_INVERSE_VIDEO draw in mode line face
19964 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
19965 DRAW_IMAGE_RAISED draw an image with a raised relief around it
19967 If OVERLAPS is non-zero, draw only the foreground of characters and
19968 clip to the physical height of ROW. Non-zero value also defines
19969 the overlapping part to be drawn:
19971 OVERLAPS_PRED overlap with preceding rows
19972 OVERLAPS_SUCC overlap with succeeding rows
19973 OVERLAPS_BOTH overlap with both preceding/succeeding rows
19974 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
19976 Value is the x-position reached, relative to AREA of W. */
19979 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
19982 struct glyph_row
*row
;
19983 enum glyph_row_area area
;
19984 EMACS_INT start
, end
;
19985 enum draw_glyphs_face hl
;
19988 struct glyph_string
*head
, *tail
;
19989 struct glyph_string
*s
;
19990 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
19991 int last_x
, area_width
;
19994 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19997 ALLOCATE_HDC (hdc
, f
);
19999 /* Let's rather be paranoid than getting a SEGV. */
20000 end
= min (end
, row
->used
[area
]);
20001 start
= max (0, start
);
20002 start
= min (end
, start
);
20004 /* Translate X to frame coordinates. Set last_x to the right
20005 end of the drawing area. */
20006 if (row
->full_width_p
)
20008 /* X is relative to the left edge of W, without scroll bars
20010 x
+= WINDOW_LEFT_EDGE_X (w
);
20011 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20015 int area_left
= window_box_left (w
, area
);
20017 area_width
= window_box_width (w
, area
);
20018 last_x
= area_left
+ area_width
;
20021 /* Build a doubly-linked list of glyph_string structures between
20022 head and tail from what we have to draw. Note that the macro
20023 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20024 the reason we use a separate variable `i'. */
20026 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20028 x_reached
= tail
->x
+ tail
->background_width
;
20032 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20033 the row, redraw some glyphs in front or following the glyph
20034 strings built above. */
20035 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20038 struct glyph_string
*h
, *t
;
20040 /* Compute overhangs for all glyph strings. */
20041 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20042 for (s
= head
; s
; s
= s
->next
)
20043 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20045 /* Prepend glyph strings for glyphs in front of the first glyph
20046 string that are overwritten because of the first glyph
20047 string's left overhang. The background of all strings
20048 prepended must be drawn because the first glyph string
20050 i
= left_overwritten (head
);
20054 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20055 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
20057 compute_overhangs_and_x (t
, head
->x
, 1);
20058 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20062 /* Prepend glyph strings for glyphs in front of the first glyph
20063 string that overwrite that glyph string because of their
20064 right overhang. For these strings, only the foreground must
20065 be drawn, because it draws over the glyph string at `head'.
20066 The background must not be drawn because this would overwrite
20067 right overhangs of preceding glyphs for which no glyph
20069 i
= left_overwriting (head
);
20073 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20074 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
20075 for (s
= h
; s
; s
= s
->next
)
20076 s
->background_filled_p
= 1;
20077 compute_overhangs_and_x (t
, head
->x
, 1);
20078 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20081 /* Append glyphs strings for glyphs following the last glyph
20082 string tail that are overwritten by tail. The background of
20083 these strings has to be drawn because tail's foreground draws
20085 i
= right_overwritten (tail
);
20088 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20089 DRAW_NORMAL_TEXT
, x
, last_x
);
20090 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20091 append_glyph_string_lists (&head
, &tail
, h
, t
);
20095 /* Append glyph strings for glyphs following the last glyph
20096 string tail that overwrite tail. The foreground of such
20097 glyphs has to be drawn because it writes into the background
20098 of tail. The background must not be drawn because it could
20099 paint over the foreground of following glyphs. */
20100 i
= right_overwriting (tail
);
20104 i
++; /* We must include the Ith glyph. */
20105 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20106 DRAW_NORMAL_TEXT
, x
, last_x
);
20107 for (s
= h
; s
; s
= s
->next
)
20108 s
->background_filled_p
= 1;
20109 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20110 append_glyph_string_lists (&head
, &tail
, h
, t
);
20112 if (clip_head
|| clip_tail
)
20113 for (s
= head
; s
; s
= s
->next
)
20115 s
->clip_head
= clip_head
;
20116 s
->clip_tail
= clip_tail
;
20120 /* Draw all strings. */
20121 for (s
= head
; s
; s
= s
->next
)
20122 FRAME_RIF (f
)->draw_glyph_string (s
);
20124 if (area
== TEXT_AREA
20125 && !row
->full_width_p
20126 /* When drawing overlapping rows, only the glyph strings'
20127 foreground is drawn, which doesn't erase a cursor
20131 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20132 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20133 : (tail
? tail
->x
+ tail
->background_width
: x
));
20135 int text_left
= window_box_left (w
, TEXT_AREA
);
20139 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20140 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20143 /* Value is the x-position up to which drawn, relative to AREA of W.
20144 This doesn't include parts drawn because of overhangs. */
20145 if (row
->full_width_p
)
20146 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20148 x_reached
-= window_box_left (w
, area
);
20150 RELEASE_HDC (hdc
, f
);
20155 /* Expand row matrix if too narrow. Don't expand if area
20158 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20160 if (!fonts_changed_p \
20161 && (it->glyph_row->glyphs[area] \
20162 < it->glyph_row->glyphs[area + 1])) \
20164 it->w->ncols_scale_factor++; \
20165 fonts_changed_p = 1; \
20169 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20170 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20176 struct glyph
*glyph
;
20177 enum glyph_row_area area
= it
->area
;
20179 xassert (it
->glyph_row
);
20180 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20182 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20183 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20185 glyph
->charpos
= CHARPOS (it
->position
);
20186 glyph
->object
= it
->object
;
20187 glyph
->pixel_width
= it
->pixel_width
;
20188 glyph
->ascent
= it
->ascent
;
20189 glyph
->descent
= it
->descent
;
20190 glyph
->voffset
= it
->voffset
;
20191 glyph
->type
= CHAR_GLYPH
;
20192 glyph
->multibyte_p
= it
->multibyte_p
;
20193 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20194 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20195 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20196 || it
->phys_descent
> it
->descent
);
20197 glyph
->padding_p
= 0;
20198 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20199 glyph
->face_id
= it
->face_id
;
20200 glyph
->u
.ch
= it
->char_to_display
;
20201 glyph
->slice
= null_glyph_slice
;
20202 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20203 ++it
->glyph_row
->used
[area
];
20206 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20209 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
20210 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20213 append_composite_glyph (it
)
20216 struct glyph
*glyph
;
20217 enum glyph_row_area area
= it
->area
;
20219 xassert (it
->glyph_row
);
20221 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20222 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20224 glyph
->charpos
= CHARPOS (it
->position
);
20225 glyph
->object
= it
->object
;
20226 glyph
->pixel_width
= it
->pixel_width
;
20227 glyph
->ascent
= it
->ascent
;
20228 glyph
->descent
= it
->descent
;
20229 glyph
->voffset
= it
->voffset
;
20230 glyph
->type
= COMPOSITE_GLYPH
;
20231 glyph
->multibyte_p
= it
->multibyte_p
;
20232 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20233 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20234 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20235 || it
->phys_descent
> it
->descent
);
20236 glyph
->padding_p
= 0;
20237 glyph
->glyph_not_available_p
= 0;
20238 glyph
->face_id
= it
->face_id
;
20239 glyph
->u
.cmp_id
= it
->cmp_id
;
20240 glyph
->slice
= null_glyph_slice
;
20241 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20242 ++it
->glyph_row
->used
[area
];
20245 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20249 /* Change IT->ascent and IT->height according to the setting of
20253 take_vertical_position_into_account (it
)
20258 if (it
->voffset
< 0)
20259 /* Increase the ascent so that we can display the text higher
20261 it
->ascent
-= it
->voffset
;
20263 /* Increase the descent so that we can display the text lower
20265 it
->descent
+= it
->voffset
;
20270 /* Produce glyphs/get display metrics for the image IT is loaded with.
20271 See the description of struct display_iterator in dispextern.h for
20272 an overview of struct display_iterator. */
20275 produce_image_glyph (it
)
20280 int glyph_ascent
, crop
;
20281 struct glyph_slice slice
;
20283 xassert (it
->what
== IT_IMAGE
);
20285 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20287 /* Make sure X resources of the face is loaded. */
20288 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20290 if (it
->image_id
< 0)
20292 /* Fringe bitmap. */
20293 it
->ascent
= it
->phys_ascent
= 0;
20294 it
->descent
= it
->phys_descent
= 0;
20295 it
->pixel_width
= 0;
20300 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20302 /* Make sure X resources of the image is loaded. */
20303 prepare_image_for_display (it
->f
, img
);
20305 slice
.x
= slice
.y
= 0;
20306 slice
.width
= img
->width
;
20307 slice
.height
= img
->height
;
20309 if (INTEGERP (it
->slice
.x
))
20310 slice
.x
= XINT (it
->slice
.x
);
20311 else if (FLOATP (it
->slice
.x
))
20312 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20314 if (INTEGERP (it
->slice
.y
))
20315 slice
.y
= XINT (it
->slice
.y
);
20316 else if (FLOATP (it
->slice
.y
))
20317 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20319 if (INTEGERP (it
->slice
.width
))
20320 slice
.width
= XINT (it
->slice
.width
);
20321 else if (FLOATP (it
->slice
.width
))
20322 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20324 if (INTEGERP (it
->slice
.height
))
20325 slice
.height
= XINT (it
->slice
.height
);
20326 else if (FLOATP (it
->slice
.height
))
20327 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20329 if (slice
.x
>= img
->width
)
20330 slice
.x
= img
->width
;
20331 if (slice
.y
>= img
->height
)
20332 slice
.y
= img
->height
;
20333 if (slice
.x
+ slice
.width
>= img
->width
)
20334 slice
.width
= img
->width
- slice
.x
;
20335 if (slice
.y
+ slice
.height
> img
->height
)
20336 slice
.height
= img
->height
- slice
.y
;
20338 if (slice
.width
== 0 || slice
.height
== 0)
20341 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20343 it
->descent
= slice
.height
- glyph_ascent
;
20345 it
->descent
+= img
->vmargin
;
20346 if (slice
.y
+ slice
.height
== img
->height
)
20347 it
->descent
+= img
->vmargin
;
20348 it
->phys_descent
= it
->descent
;
20350 it
->pixel_width
= slice
.width
;
20352 it
->pixel_width
+= img
->hmargin
;
20353 if (slice
.x
+ slice
.width
== img
->width
)
20354 it
->pixel_width
+= img
->hmargin
;
20356 /* It's quite possible for images to have an ascent greater than
20357 their height, so don't get confused in that case. */
20358 if (it
->descent
< 0)
20361 #if 0 /* this breaks image tiling */
20362 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20363 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20364 if (face_ascent
> it
->ascent
)
20365 it
->ascent
= it
->phys_ascent
= face_ascent
;
20370 if (face
->box
!= FACE_NO_BOX
)
20372 if (face
->box_line_width
> 0)
20375 it
->ascent
+= face
->box_line_width
;
20376 if (slice
.y
+ slice
.height
== img
->height
)
20377 it
->descent
+= face
->box_line_width
;
20380 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20381 it
->pixel_width
+= eabs (face
->box_line_width
);
20382 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20383 it
->pixel_width
+= eabs (face
->box_line_width
);
20386 take_vertical_position_into_account (it
);
20388 /* Automatically crop wide image glyphs at right edge so we can
20389 draw the cursor on same display row. */
20390 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20391 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20393 it
->pixel_width
-= crop
;
20394 slice
.width
-= crop
;
20399 struct glyph
*glyph
;
20400 enum glyph_row_area area
= it
->area
;
20402 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20403 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20405 glyph
->charpos
= CHARPOS (it
->position
);
20406 glyph
->object
= it
->object
;
20407 glyph
->pixel_width
= it
->pixel_width
;
20408 glyph
->ascent
= glyph_ascent
;
20409 glyph
->descent
= it
->descent
;
20410 glyph
->voffset
= it
->voffset
;
20411 glyph
->type
= IMAGE_GLYPH
;
20412 glyph
->multibyte_p
= it
->multibyte_p
;
20413 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20414 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20415 glyph
->overlaps_vertically_p
= 0;
20416 glyph
->padding_p
= 0;
20417 glyph
->glyph_not_available_p
= 0;
20418 glyph
->face_id
= it
->face_id
;
20419 glyph
->u
.img_id
= img
->id
;
20420 glyph
->slice
= slice
;
20421 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20422 ++it
->glyph_row
->used
[area
];
20425 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20430 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20431 of the glyph, WIDTH and HEIGHT are the width and height of the
20432 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20435 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20437 Lisp_Object object
;
20441 struct glyph
*glyph
;
20442 enum glyph_row_area area
= it
->area
;
20444 xassert (ascent
>= 0 && ascent
<= height
);
20446 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20447 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20449 glyph
->charpos
= CHARPOS (it
->position
);
20450 glyph
->object
= object
;
20451 glyph
->pixel_width
= width
;
20452 glyph
->ascent
= ascent
;
20453 glyph
->descent
= height
- ascent
;
20454 glyph
->voffset
= it
->voffset
;
20455 glyph
->type
= STRETCH_GLYPH
;
20456 glyph
->multibyte_p
= it
->multibyte_p
;
20457 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20458 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20459 glyph
->overlaps_vertically_p
= 0;
20460 glyph
->padding_p
= 0;
20461 glyph
->glyph_not_available_p
= 0;
20462 glyph
->face_id
= it
->face_id
;
20463 glyph
->u
.stretch
.ascent
= ascent
;
20464 glyph
->u
.stretch
.height
= height
;
20465 glyph
->slice
= null_glyph_slice
;
20466 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20467 ++it
->glyph_row
->used
[area
];
20470 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20474 /* Produce a stretch glyph for iterator IT. IT->object is the value
20475 of the glyph property displayed. The value must be a list
20476 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20479 1. `:width WIDTH' specifies that the space should be WIDTH *
20480 canonical char width wide. WIDTH may be an integer or floating
20483 2. `:relative-width FACTOR' specifies that the width of the stretch
20484 should be computed from the width of the first character having the
20485 `glyph' property, and should be FACTOR times that width.
20487 3. `:align-to HPOS' specifies that the space should be wide enough
20488 to reach HPOS, a value in canonical character units.
20490 Exactly one of the above pairs must be present.
20492 4. `:height HEIGHT' specifies that the height of the stretch produced
20493 should be HEIGHT, measured in canonical character units.
20495 5. `:relative-height FACTOR' specifies that the height of the
20496 stretch should be FACTOR times the height of the characters having
20497 the glyph property.
20499 Either none or exactly one of 4 or 5 must be present.
20501 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20502 of the stretch should be used for the ascent of the stretch.
20503 ASCENT must be in the range 0 <= ASCENT <= 100. */
20506 produce_stretch_glyph (it
)
20509 /* (space :width WIDTH :height HEIGHT ...) */
20510 Lisp_Object prop
, plist
;
20511 int width
= 0, height
= 0, align_to
= -1;
20512 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20515 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20516 XFontStruct
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20518 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20520 /* List should start with `space'. */
20521 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20522 plist
= XCDR (it
->object
);
20524 /* Compute the width of the stretch. */
20525 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20526 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20528 /* Absolute width `:width WIDTH' specified and valid. */
20529 zero_width_ok_p
= 1;
20532 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20535 /* Relative width `:relative-width FACTOR' specified and valid.
20536 Compute the width of the characters having the `glyph'
20539 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20542 if (it
->multibyte_p
)
20544 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20545 - IT_BYTEPOS (*it
));
20546 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20549 it2
.c
= *p
, it2
.len
= 1;
20551 it2
.glyph_row
= NULL
;
20552 it2
.what
= IT_CHARACTER
;
20553 x_produce_glyphs (&it2
);
20554 width
= NUMVAL (prop
) * it2
.pixel_width
;
20556 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20557 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20559 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20560 align_to
= (align_to
< 0
20562 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20563 else if (align_to
< 0)
20564 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20565 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20566 zero_width_ok_p
= 1;
20569 /* Nothing specified -> width defaults to canonical char width. */
20570 width
= FRAME_COLUMN_WIDTH (it
->f
);
20572 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20575 /* Compute height. */
20576 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20577 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20580 zero_height_ok_p
= 1;
20582 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20584 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20586 height
= FONT_HEIGHT (font
);
20588 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20591 /* Compute percentage of height used for ascent. If
20592 `:ascent ASCENT' is present and valid, use that. Otherwise,
20593 derive the ascent from the font in use. */
20594 if (prop
= Fplist_get (plist
, QCascent
),
20595 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20596 ascent
= height
* NUMVAL (prop
) / 100.0;
20597 else if (!NILP (prop
)
20598 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20599 ascent
= min (max (0, (int)tem
), height
);
20601 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20603 if (width
> 0 && !it
->truncate_lines_p
20604 && it
->current_x
+ width
> it
->last_visible_x
)
20605 width
= it
->last_visible_x
- it
->current_x
- 1;
20607 if (width
> 0 && height
> 0 && it
->glyph_row
)
20609 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20610 if (!STRINGP (object
))
20611 object
= it
->w
->buffer
;
20612 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20615 it
->pixel_width
= width
;
20616 it
->ascent
= it
->phys_ascent
= ascent
;
20617 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20618 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20620 take_vertical_position_into_account (it
);
20623 /* Get line-height and line-spacing property at point.
20624 If line-height has format (HEIGHT TOTAL), return TOTAL
20625 in TOTAL_HEIGHT. */
20628 get_line_height_property (it
, prop
)
20632 Lisp_Object position
;
20634 if (STRINGP (it
->object
))
20635 position
= make_number (IT_STRING_CHARPOS (*it
));
20636 else if (BUFFERP (it
->object
))
20637 position
= make_number (IT_CHARPOS (*it
));
20641 return Fget_char_property (position
, prop
, it
->object
);
20644 /* Calculate line-height and line-spacing properties.
20645 An integer value specifies explicit pixel value.
20646 A float value specifies relative value to current face height.
20647 A cons (float . face-name) specifies relative value to
20648 height of specified face font.
20650 Returns height in pixels, or nil. */
20654 calc_line_height_property (it
, val
, font
, boff
, override
)
20658 int boff
, override
;
20660 Lisp_Object face_name
= Qnil
;
20661 int ascent
, descent
, height
;
20663 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
20668 face_name
= XCAR (val
);
20670 if (!NUMBERP (val
))
20671 val
= make_number (1);
20672 if (NILP (face_name
))
20674 height
= it
->ascent
+ it
->descent
;
20679 if (NILP (face_name
))
20681 font
= FRAME_FONT (it
->f
);
20682 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20684 else if (EQ (face_name
, Qt
))
20692 struct font_info
*font_info
;
20694 face_id
= lookup_named_face (it
->f
, face_name
, 0);
20696 return make_number (-1);
20698 face
= FACE_FROM_ID (it
->f
, face_id
);
20701 return make_number (-1);
20703 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
20704 boff
= font_info
->baseline_offset
;
20705 if (font_info
->vertical_centering
)
20706 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20709 ascent
= FONT_BASE (font
) + boff
;
20710 descent
= FONT_DESCENT (font
) - boff
;
20714 it
->override_ascent
= ascent
;
20715 it
->override_descent
= descent
;
20716 it
->override_boff
= boff
;
20719 height
= ascent
+ descent
;
20723 height
= (int)(XFLOAT_DATA (val
) * height
);
20724 else if (INTEGERP (val
))
20725 height
*= XINT (val
);
20727 return make_number (height
);
20732 Produce glyphs/get display metrics for the display element IT is
20733 loaded with. See the description of struct it in dispextern.h
20734 for an overview of struct it. */
20737 x_produce_glyphs (it
)
20740 int extra_line_spacing
= it
->extra_line_spacing
;
20742 it
->glyph_not_available_p
= 0;
20744 if (it
->what
== IT_CHARACTER
)
20748 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20750 int font_not_found_p
;
20751 struct font_info
*font_info
;
20752 int boff
; /* baseline offset */
20753 /* We may change it->multibyte_p upon unibyte<->multibyte
20754 conversion. So, save the current value now and restore it
20757 Note: It seems that we don't have to record multibyte_p in
20758 struct glyph because the character code itself tells if or
20759 not the character is multibyte. Thus, in the future, we must
20760 consider eliminating the field `multibyte_p' in the struct
20762 int saved_multibyte_p
= it
->multibyte_p
;
20764 /* Maybe translate single-byte characters to multibyte, or the
20766 it
->char_to_display
= it
->c
;
20767 if (!ASCII_BYTE_P (it
->c
)
20768 && ! it
->multibyte_p
)
20770 if (SINGLE_BYTE_CHAR_P (it
->c
)
20771 && unibyte_display_via_language_environment
)
20772 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20773 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
20775 it
->multibyte_p
= 1;
20776 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
20778 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20782 /* Get font to use. Encode IT->char_to_display. */
20783 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20784 &char2b
, it
->multibyte_p
, 0);
20787 /* When no suitable font found, use the default font. */
20788 font_not_found_p
= font
== NULL
;
20789 if (font_not_found_p
)
20791 font
= FRAME_FONT (it
->f
);
20792 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20797 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
20798 boff
= font_info
->baseline_offset
;
20799 if (font_info
->vertical_centering
)
20800 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20803 if (it
->char_to_display
>= ' '
20804 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
20806 /* Either unibyte or ASCII. */
20811 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
20812 FONT_TYPE_FOR_UNIBYTE (font
, it
->char_to_display
));
20814 if (it
->override_ascent
>= 0)
20816 it
->ascent
= it
->override_ascent
;
20817 it
->descent
= it
->override_descent
;
20818 boff
= it
->override_boff
;
20822 it
->ascent
= FONT_BASE (font
) + boff
;
20823 it
->descent
= FONT_DESCENT (font
) - boff
;
20828 it
->phys_ascent
= pcm
->ascent
+ boff
;
20829 it
->phys_descent
= pcm
->descent
- boff
;
20830 it
->pixel_width
= pcm
->width
;
20834 it
->glyph_not_available_p
= 1;
20835 it
->phys_ascent
= it
->ascent
;
20836 it
->phys_descent
= it
->descent
;
20837 it
->pixel_width
= FONT_WIDTH (font
);
20840 if (it
->constrain_row_ascent_descent_p
)
20842 if (it
->descent
> it
->max_descent
)
20844 it
->ascent
+= it
->descent
- it
->max_descent
;
20845 it
->descent
= it
->max_descent
;
20847 if (it
->ascent
> it
->max_ascent
)
20849 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20850 it
->ascent
= it
->max_ascent
;
20852 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20853 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20854 extra_line_spacing
= 0;
20857 /* If this is a space inside a region of text with
20858 `space-width' property, change its width. */
20859 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
20861 it
->pixel_width
*= XFLOATINT (it
->space_width
);
20863 /* If face has a box, add the box thickness to the character
20864 height. If character has a box line to the left and/or
20865 right, add the box line width to the character's width. */
20866 if (face
->box
!= FACE_NO_BOX
)
20868 int thick
= face
->box_line_width
;
20872 it
->ascent
+= thick
;
20873 it
->descent
+= thick
;
20878 if (it
->start_of_box_run_p
)
20879 it
->pixel_width
+= thick
;
20880 if (it
->end_of_box_run_p
)
20881 it
->pixel_width
+= thick
;
20884 /* If face has an overline, add the height of the overline
20885 (1 pixel) and a 1 pixel margin to the character height. */
20886 if (face
->overline_p
)
20887 it
->ascent
+= overline_margin
;
20889 if (it
->constrain_row_ascent_descent_p
)
20891 if (it
->ascent
> it
->max_ascent
)
20892 it
->ascent
= it
->max_ascent
;
20893 if (it
->descent
> it
->max_descent
)
20894 it
->descent
= it
->max_descent
;
20897 take_vertical_position_into_account (it
);
20899 /* If we have to actually produce glyphs, do it. */
20904 /* Translate a space with a `space-width' property
20905 into a stretch glyph. */
20906 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
20907 / FONT_HEIGHT (font
));
20908 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
20909 it
->ascent
+ it
->descent
, ascent
);
20914 /* If characters with lbearing or rbearing are displayed
20915 in this line, record that fact in a flag of the
20916 glyph row. This is used to optimize X output code. */
20917 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
20918 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
20921 else if (it
->char_to_display
== '\n')
20923 /* A newline has no width but we need the height of the line.
20924 But if previous part of the line set a height, don't
20925 increase that height */
20927 Lisp_Object height
;
20928 Lisp_Object total_height
= Qnil
;
20930 it
->override_ascent
= -1;
20931 it
->pixel_width
= 0;
20934 height
= get_line_height_property(it
, Qline_height
);
20935 /* Split (line-height total-height) list */
20937 && CONSP (XCDR (height
))
20938 && NILP (XCDR (XCDR (height
))))
20940 total_height
= XCAR (XCDR (height
));
20941 height
= XCAR (height
);
20943 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
20945 if (it
->override_ascent
>= 0)
20947 it
->ascent
= it
->override_ascent
;
20948 it
->descent
= it
->override_descent
;
20949 boff
= it
->override_boff
;
20953 it
->ascent
= FONT_BASE (font
) + boff
;
20954 it
->descent
= FONT_DESCENT (font
) - boff
;
20957 if (EQ (height
, Qt
))
20959 if (it
->descent
> it
->max_descent
)
20961 it
->ascent
+= it
->descent
- it
->max_descent
;
20962 it
->descent
= it
->max_descent
;
20964 if (it
->ascent
> it
->max_ascent
)
20966 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20967 it
->ascent
= it
->max_ascent
;
20969 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20970 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20971 it
->constrain_row_ascent_descent_p
= 1;
20972 extra_line_spacing
= 0;
20976 Lisp_Object spacing
;
20978 it
->phys_ascent
= it
->ascent
;
20979 it
->phys_descent
= it
->descent
;
20981 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
20982 && face
->box
!= FACE_NO_BOX
20983 && face
->box_line_width
> 0)
20985 it
->ascent
+= face
->box_line_width
;
20986 it
->descent
+= face
->box_line_width
;
20989 && XINT (height
) > it
->ascent
+ it
->descent
)
20990 it
->ascent
= XINT (height
) - it
->descent
;
20992 if (!NILP (total_height
))
20993 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
20996 spacing
= get_line_height_property(it
, Qline_spacing
);
20997 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
20999 if (INTEGERP (spacing
))
21001 extra_line_spacing
= XINT (spacing
);
21002 if (!NILP (total_height
))
21003 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21007 else if (it
->char_to_display
== '\t')
21009 int tab_width
= it
->tab_width
* FRAME_SPACE_WIDTH (it
->f
);
21010 int x
= it
->current_x
+ it
->continuation_lines_width
;
21011 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21013 /* If the distance from the current position to the next tab
21014 stop is less than a space character width, use the
21015 tab stop after that. */
21016 if (next_tab_x
- x
< FRAME_SPACE_WIDTH (it
->f
))
21017 next_tab_x
+= tab_width
;
21019 it
->pixel_width
= next_tab_x
- x
;
21021 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21022 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21026 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21027 it
->ascent
+ it
->descent
, it
->ascent
);
21032 /* A multi-byte character. Assume that the display width of the
21033 character is the width of the character multiplied by the
21034 width of the font. */
21036 /* If we found a font, this font should give us the right
21037 metrics. If we didn't find a font, use the frame's
21038 default font and calculate the width of the character by
21039 multiplying the width of font by the width of the
21042 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21043 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
));
21045 if (font_not_found_p
|| !pcm
)
21047 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21049 if (char_width
== 0)
21050 /* This is a non spacing character. But, as we are
21051 going to display an empty box, the box must occupy
21052 at least one column. */
21054 it
->glyph_not_available_p
= 1;
21055 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21056 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21057 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21061 it
->pixel_width
= pcm
->width
;
21062 it
->phys_ascent
= pcm
->ascent
+ boff
;
21063 it
->phys_descent
= pcm
->descent
- boff
;
21065 && (pcm
->lbearing
< 0
21066 || pcm
->rbearing
> pcm
->width
))
21067 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21070 it
->ascent
= FONT_BASE (font
) + boff
;
21071 it
->descent
= FONT_DESCENT (font
) - boff
;
21072 if (face
->box
!= FACE_NO_BOX
)
21074 int thick
= face
->box_line_width
;
21078 it
->ascent
+= thick
;
21079 it
->descent
+= thick
;
21084 if (it
->start_of_box_run_p
)
21085 it
->pixel_width
+= thick
;
21086 if (it
->end_of_box_run_p
)
21087 it
->pixel_width
+= thick
;
21090 /* If face has an overline, add the height of the overline
21091 (1 pixel) and a 1 pixel margin to the character height. */
21092 if (face
->overline_p
)
21093 it
->ascent
+= overline_margin
;
21095 take_vertical_position_into_account (it
);
21100 it
->multibyte_p
= saved_multibyte_p
;
21102 else if (it
->what
== IT_COMPOSITION
)
21104 /* Note: A composition is represented as one glyph in the
21105 glyph matrix. There are no padding glyphs.
21107 Important is that pixel_width, ascent, and descent are the
21108 values of what is drawn by draw_glyphs (i.e. the values of
21109 the overall glyphs composed). */
21110 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21111 int boff
; /* baseline offset */
21112 struct composition
*cmp
= composition_table
[it
->cmp_id
];
21113 int glyph_len
= cmp
->glyph_len
;
21114 XFontStruct
*font
= face
->font
;
21118 #ifdef USE_FONT_BACKEND
21119 if (cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
21121 if (! cmp
->font
|| cmp
->font
!= font
)
21122 font_prepare_composition (cmp
, it
->f
);
21125 #endif /* USE_FONT_BACKEND */
21126 /* If we have not yet calculated pixel size data of glyphs of
21127 the composition for the current face font, calculate them
21128 now. Theoretically, we have to check all fonts for the
21129 glyphs, but that requires much time and memory space. So,
21130 here we check only the font of the first glyph. This leads
21131 to incorrect display, but it's very rare, and C-l (recenter)
21132 can correct the display anyway. */
21133 if (! cmp
->font
|| cmp
->font
!= font
)
21135 /* Ascent and descent of the font of the first character
21136 of this composition (adjusted by baseline offset).
21137 Ascent and descent of overall glyphs should not be less
21138 than them respectively. */
21139 int font_ascent
, font_descent
, font_height
;
21140 /* Bounding box of the overall glyphs. */
21141 int leftmost
, rightmost
, lowest
, highest
;
21142 int lbearing
, rbearing
;
21143 int i
, width
, ascent
, descent
;
21144 int left_padded
= 0, right_padded
= 0;
21149 int font_not_found_p
;
21150 struct font_info
*font_info
;
21153 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21154 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21156 if (glyph_len
< cmp
->glyph_len
)
21158 for (i
= 0; i
< glyph_len
; i
++)
21160 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21162 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21167 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21168 : IT_CHARPOS (*it
));
21169 /* When no suitable font found, use the default font. */
21170 font_not_found_p
= font
== NULL
;
21171 if (font_not_found_p
)
21173 face
= face
->ascii_face
;
21176 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
21177 boff
= font_info
->baseline_offset
;
21178 if (font_info
->vertical_centering
)
21179 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21180 font_ascent
= FONT_BASE (font
) + boff
;
21181 font_descent
= FONT_DESCENT (font
) - boff
;
21182 font_height
= FONT_HEIGHT (font
);
21184 cmp
->font
= (void *) font
;
21187 if (! font_not_found_p
)
21189 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21190 &char2b
, it
->multibyte_p
, 0);
21191 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21192 FONT_TYPE_FOR_MULTIBYTE (font
, c
));
21195 /* Initialize the bounding box. */
21198 width
= pcm
->width
;
21199 ascent
= pcm
->ascent
;
21200 descent
= pcm
->descent
;
21201 lbearing
= pcm
->lbearing
;
21202 rbearing
= pcm
->rbearing
;
21206 width
= FONT_WIDTH (font
);
21207 ascent
= FONT_BASE (font
);
21208 descent
= FONT_DESCENT (font
);
21215 lowest
= - descent
+ boff
;
21216 highest
= ascent
+ boff
;
21218 if (! font_not_found_p
21219 && font_info
->default_ascent
21220 && CHAR_TABLE_P (Vuse_default_ascent
)
21221 && !NILP (Faref (Vuse_default_ascent
,
21222 make_number (it
->char_to_display
))))
21223 highest
= font_info
->default_ascent
+ boff
;
21225 /* Draw the first glyph at the normal position. It may be
21226 shifted to right later if some other glyphs are drawn
21228 cmp
->offsets
[i
* 2] = 0;
21229 cmp
->offsets
[i
* 2 + 1] = boff
;
21230 cmp
->lbearing
= lbearing
;
21231 cmp
->rbearing
= rbearing
;
21233 /* Set cmp->offsets for the remaining glyphs. */
21234 for (i
++; i
< glyph_len
; i
++)
21236 int left
, right
, btm
, top
;
21237 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21239 struct face
*this_face
;
21244 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21245 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21246 font
= this_face
->font
;
21252 font_info
= FONT_INFO_FROM_FACE (it
->f
, this_face
);
21253 this_boff
= font_info
->baseline_offset
;
21254 if (font_info
->vertical_centering
)
21255 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21256 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21257 &char2b
, it
->multibyte_p
, 0);
21258 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21259 FONT_TYPE_FOR_MULTIBYTE (font
,
21263 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21266 width
= pcm
->width
;
21267 ascent
= pcm
->ascent
;
21268 descent
= pcm
->descent
;
21269 lbearing
= pcm
->lbearing
;
21270 rbearing
= pcm
->rbearing
;
21271 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21273 /* Relative composition with or without
21274 alternate chars. */
21275 left
= (leftmost
+ rightmost
- width
) / 2;
21276 btm
= - descent
+ boff
;
21277 if (font_info
->relative_compose
21278 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21279 || NILP (Faref (Vignore_relative_composition
,
21280 make_number (ch
)))))
21283 if (- descent
>= font_info
->relative_compose
)
21284 /* One extra pixel between two glyphs. */
21286 else if (ascent
<= 0)
21287 /* One extra pixel between two glyphs. */
21288 btm
= lowest
- 1 - ascent
- descent
;
21293 /* A composition rule is specified by an integer
21294 value that encodes global and new reference
21295 points (GREF and NREF). GREF and NREF are
21296 specified by numbers as below:
21298 0---1---2 -- ascent
21302 9--10--11 -- center
21304 ---3---4---5--- baseline
21306 6---7---8 -- descent
21308 int rule
= COMPOSITION_RULE (cmp
, i
);
21309 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21311 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21312 grefx
= gref
% 3, nrefx
= nref
% 3;
21313 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21315 xoff
= font_height
* (xoff
- 128) / 256;
21317 yoff
= font_height
* (yoff
- 128) / 256;
21320 + grefx
* (rightmost
- leftmost
) / 2
21321 - nrefx
* width
/ 2
21324 btm
= ((grefy
== 0 ? highest
21326 : grefy
== 2 ? lowest
21327 : (highest
+ lowest
) / 2)
21328 - (nrefy
== 0 ? ascent
+ descent
21329 : nrefy
== 1 ? descent
- boff
21331 : (ascent
+ descent
) / 2)
21335 cmp
->offsets
[i
* 2] = left
;
21336 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21338 /* Update the bounding box of the overall glyphs. */
21341 right
= left
+ width
;
21342 if (left
< leftmost
)
21344 if (right
> rightmost
)
21347 top
= btm
+ descent
+ ascent
;
21353 if (cmp
->lbearing
> left
+ lbearing
)
21354 cmp
->lbearing
= left
+ lbearing
;
21355 if (cmp
->rbearing
< left
+ rbearing
)
21356 cmp
->rbearing
= left
+ rbearing
;
21360 /* If there are glyphs whose x-offsets are negative,
21361 shift all glyphs to the right and make all x-offsets
21365 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21366 cmp
->offsets
[i
* 2] -= leftmost
;
21367 rightmost
-= leftmost
;
21368 cmp
->lbearing
-= leftmost
;
21369 cmp
->rbearing
-= leftmost
;
21372 if (left_padded
&& cmp
->lbearing
< 0)
21374 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21375 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21376 rightmost
-= cmp
->lbearing
;
21377 cmp
->rbearing
-= cmp
->lbearing
;
21380 if (right_padded
&& rightmost
< cmp
->rbearing
)
21382 rightmost
= cmp
->rbearing
;
21385 cmp
->pixel_width
= rightmost
;
21386 cmp
->ascent
= highest
;
21387 cmp
->descent
= - lowest
;
21388 if (cmp
->ascent
< font_ascent
)
21389 cmp
->ascent
= font_ascent
;
21390 if (cmp
->descent
< font_descent
)
21391 cmp
->descent
= font_descent
;
21395 && (cmp
->lbearing
< 0
21396 || cmp
->rbearing
> cmp
->pixel_width
))
21397 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21399 it
->pixel_width
= cmp
->pixel_width
;
21400 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21401 it
->descent
= it
->phys_descent
= cmp
->descent
;
21403 if (face
->box
!= FACE_NO_BOX
)
21405 int thick
= face
->box_line_width
;
21409 it
->ascent
+= thick
;
21410 it
->descent
+= thick
;
21415 if (it
->start_of_box_run_p
)
21416 it
->pixel_width
+= thick
;
21417 if (it
->end_of_box_run_p
)
21418 it
->pixel_width
+= thick
;
21421 /* If face has an overline, add the height of the overline
21422 (1 pixel) and a 1 pixel margin to the character height. */
21423 if (face
->overline_p
)
21424 it
->ascent
+= overline_margin
;
21426 take_vertical_position_into_account (it
);
21429 append_composite_glyph (it
);
21431 else if (it
->what
== IT_IMAGE
)
21432 produce_image_glyph (it
);
21433 else if (it
->what
== IT_STRETCH
)
21434 produce_stretch_glyph (it
);
21436 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21437 because this isn't true for images with `:ascent 100'. */
21438 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21439 if (it
->area
== TEXT_AREA
)
21440 it
->current_x
+= it
->pixel_width
;
21442 if (extra_line_spacing
> 0)
21444 it
->descent
+= extra_line_spacing
;
21445 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21446 it
->max_extra_line_spacing
= extra_line_spacing
;
21449 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21450 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21451 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21452 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21456 Output LEN glyphs starting at START at the nominal cursor position.
21457 Advance the nominal cursor over the text. The global variable
21458 updated_window contains the window being updated, updated_row is
21459 the glyph row being updated, and updated_area is the area of that
21460 row being updated. */
21463 x_write_glyphs (start
, len
)
21464 struct glyph
*start
;
21469 xassert (updated_window
&& updated_row
);
21472 /* Write glyphs. */
21474 hpos
= start
- updated_row
->glyphs
[updated_area
];
21475 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21476 updated_row
, updated_area
,
21478 DRAW_NORMAL_TEXT
, 0);
21480 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21481 if (updated_area
== TEXT_AREA
21482 && updated_window
->phys_cursor_on_p
21483 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21484 && updated_window
->phys_cursor
.hpos
>= hpos
21485 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21486 updated_window
->phys_cursor_on_p
= 0;
21490 /* Advance the output cursor. */
21491 output_cursor
.hpos
+= len
;
21492 output_cursor
.x
= x
;
21497 Insert LEN glyphs from START at the nominal cursor position. */
21500 x_insert_glyphs (start
, len
)
21501 struct glyph
*start
;
21506 int line_height
, shift_by_width
, shifted_region_width
;
21507 struct glyph_row
*row
;
21508 struct glyph
*glyph
;
21509 int frame_x
, frame_y
;
21512 xassert (updated_window
&& updated_row
);
21514 w
= updated_window
;
21515 f
= XFRAME (WINDOW_FRAME (w
));
21517 /* Get the height of the line we are in. */
21519 line_height
= row
->height
;
21521 /* Get the width of the glyphs to insert. */
21522 shift_by_width
= 0;
21523 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21524 shift_by_width
+= glyph
->pixel_width
;
21526 /* Get the width of the region to shift right. */
21527 shifted_region_width
= (window_box_width (w
, updated_area
)
21532 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21533 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21535 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21536 line_height
, shift_by_width
);
21538 /* Write the glyphs. */
21539 hpos
= start
- row
->glyphs
[updated_area
];
21540 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21542 DRAW_NORMAL_TEXT
, 0);
21544 /* Advance the output cursor. */
21545 output_cursor
.hpos
+= len
;
21546 output_cursor
.x
+= shift_by_width
;
21552 Erase the current text line from the nominal cursor position
21553 (inclusive) to pixel column TO_X (exclusive). The idea is that
21554 everything from TO_X onward is already erased.
21556 TO_X is a pixel position relative to updated_area of
21557 updated_window. TO_X == -1 means clear to the end of this area. */
21560 x_clear_end_of_line (to_x
)
21564 struct window
*w
= updated_window
;
21565 int max_x
, min_y
, max_y
;
21566 int from_x
, from_y
, to_y
;
21568 xassert (updated_window
&& updated_row
);
21569 f
= XFRAME (w
->frame
);
21571 if (updated_row
->full_width_p
)
21572 max_x
= WINDOW_TOTAL_WIDTH (w
);
21574 max_x
= window_box_width (w
, updated_area
);
21575 max_y
= window_text_bottom_y (w
);
21577 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21578 of window. For TO_X > 0, truncate to end of drawing area. */
21584 to_x
= min (to_x
, max_x
);
21586 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21588 /* Notice if the cursor will be cleared by this operation. */
21589 if (!updated_row
->full_width_p
)
21590 notice_overwritten_cursor (w
, updated_area
,
21591 output_cursor
.x
, -1,
21593 MATRIX_ROW_BOTTOM_Y (updated_row
));
21595 from_x
= output_cursor
.x
;
21597 /* Translate to frame coordinates. */
21598 if (updated_row
->full_width_p
)
21600 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21601 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
21605 int area_left
= window_box_left (w
, updated_area
);
21606 from_x
+= area_left
;
21610 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
21611 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
21612 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
21614 /* Prevent inadvertently clearing to end of the X window. */
21615 if (to_x
> from_x
&& to_y
> from_y
)
21618 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
21619 to_x
- from_x
, to_y
- from_y
);
21624 #endif /* HAVE_WINDOW_SYSTEM */
21628 /***********************************************************************
21630 ***********************************************************************/
21632 /* Value is the internal representation of the specified cursor type
21633 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
21634 of the bar cursor. */
21636 static enum text_cursor_kinds
21637 get_specified_cursor_type (arg
, width
)
21641 enum text_cursor_kinds type
;
21646 if (EQ (arg
, Qbox
))
21647 return FILLED_BOX_CURSOR
;
21649 if (EQ (arg
, Qhollow
))
21650 return HOLLOW_BOX_CURSOR
;
21652 if (EQ (arg
, Qbar
))
21659 && EQ (XCAR (arg
), Qbar
)
21660 && INTEGERP (XCDR (arg
))
21661 && XINT (XCDR (arg
)) >= 0)
21663 *width
= XINT (XCDR (arg
));
21667 if (EQ (arg
, Qhbar
))
21670 return HBAR_CURSOR
;
21674 && EQ (XCAR (arg
), Qhbar
)
21675 && INTEGERP (XCDR (arg
))
21676 && XINT (XCDR (arg
)) >= 0)
21678 *width
= XINT (XCDR (arg
));
21679 return HBAR_CURSOR
;
21682 /* Treat anything unknown as "hollow box cursor".
21683 It was bad to signal an error; people have trouble fixing
21684 .Xdefaults with Emacs, when it has something bad in it. */
21685 type
= HOLLOW_BOX_CURSOR
;
21690 /* Set the default cursor types for specified frame. */
21692 set_frame_cursor_types (f
, arg
)
21699 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
21700 FRAME_CURSOR_WIDTH (f
) = width
;
21702 /* By default, set up the blink-off state depending on the on-state. */
21704 tem
= Fassoc (arg
, Vblink_cursor_alist
);
21707 FRAME_BLINK_OFF_CURSOR (f
)
21708 = get_specified_cursor_type (XCDR (tem
), &width
);
21709 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
21712 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
21716 /* Return the cursor we want to be displayed in window W. Return
21717 width of bar/hbar cursor through WIDTH arg. Return with
21718 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
21719 (i.e. if the `system caret' should track this cursor).
21721 In a mini-buffer window, we want the cursor only to appear if we
21722 are reading input from this window. For the selected window, we
21723 want the cursor type given by the frame parameter or buffer local
21724 setting of cursor-type. If explicitly marked off, draw no cursor.
21725 In all other cases, we want a hollow box cursor. */
21727 static enum text_cursor_kinds
21728 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
21730 struct glyph
*glyph
;
21732 int *active_cursor
;
21734 struct frame
*f
= XFRAME (w
->frame
);
21735 struct buffer
*b
= XBUFFER (w
->buffer
);
21736 int cursor_type
= DEFAULT_CURSOR
;
21737 Lisp_Object alt_cursor
;
21738 int non_selected
= 0;
21740 *active_cursor
= 1;
21743 if (cursor_in_echo_area
21744 && FRAME_HAS_MINIBUF_P (f
)
21745 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
21747 if (w
== XWINDOW (echo_area_window
))
21749 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
21751 *width
= FRAME_CURSOR_WIDTH (f
);
21752 return FRAME_DESIRED_CURSOR (f
);
21755 return get_specified_cursor_type (b
->cursor_type
, width
);
21758 *active_cursor
= 0;
21762 /* Detect a nonselected window or nonselected frame. */
21763 else if (w
!= XWINDOW (f
->selected_window
)
21764 #ifdef HAVE_WINDOW_SYSTEM
21765 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
21769 *active_cursor
= 0;
21771 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
21777 /* Never display a cursor in a window in which cursor-type is nil. */
21778 if (NILP (b
->cursor_type
))
21781 /* Get the normal cursor type for this window. */
21782 if (EQ (b
->cursor_type
, Qt
))
21784 cursor_type
= FRAME_DESIRED_CURSOR (f
);
21785 *width
= FRAME_CURSOR_WIDTH (f
);
21788 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
21790 /* Use cursor-in-non-selected-windows instead
21791 for non-selected window or frame. */
21794 alt_cursor
= b
->cursor_in_non_selected_windows
;
21795 if (!EQ (Qt
, alt_cursor
))
21796 return get_specified_cursor_type (alt_cursor
, width
);
21797 /* t means modify the normal cursor type. */
21798 if (cursor_type
== FILLED_BOX_CURSOR
)
21799 cursor_type
= HOLLOW_BOX_CURSOR
;
21800 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
21802 return cursor_type
;
21805 /* Use normal cursor if not blinked off. */
21806 if (!w
->cursor_off_p
)
21808 #ifdef HAVE_WINDOW_SYSTEM
21809 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
21811 if (cursor_type
== FILLED_BOX_CURSOR
)
21813 /* Using a block cursor on large images can be very annoying.
21814 So use a hollow cursor for "large" images.
21815 If image is not transparent (no mask), also use hollow cursor. */
21816 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
21817 if (img
!= NULL
&& IMAGEP (img
->spec
))
21819 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
21820 where N = size of default frame font size.
21821 This should cover most of the "tiny" icons people may use. */
21823 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
21824 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
21825 cursor_type
= HOLLOW_BOX_CURSOR
;
21828 else if (cursor_type
!= NO_CURSOR
)
21830 /* Display current only supports BOX and HOLLOW cursors for images.
21831 So for now, unconditionally use a HOLLOW cursor when cursor is
21832 not a solid box cursor. */
21833 cursor_type
= HOLLOW_BOX_CURSOR
;
21837 return cursor_type
;
21840 /* Cursor is blinked off, so determine how to "toggle" it. */
21842 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
21843 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
21844 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
21846 /* Then see if frame has specified a specific blink off cursor type. */
21847 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
21849 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
21850 return FRAME_BLINK_OFF_CURSOR (f
);
21854 /* Some people liked having a permanently visible blinking cursor,
21855 while others had very strong opinions against it. So it was
21856 decided to remove it. KFS 2003-09-03 */
21858 /* Finally perform built-in cursor blinking:
21859 filled box <-> hollow box
21860 wide [h]bar <-> narrow [h]bar
21861 narrow [h]bar <-> no cursor
21862 other type <-> no cursor */
21864 if (cursor_type
== FILLED_BOX_CURSOR
)
21865 return HOLLOW_BOX_CURSOR
;
21867 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
21870 return cursor_type
;
21878 #ifdef HAVE_WINDOW_SYSTEM
21880 /* Notice when the text cursor of window W has been completely
21881 overwritten by a drawing operation that outputs glyphs in AREA
21882 starting at X0 and ending at X1 in the line starting at Y0 and
21883 ending at Y1. X coordinates are area-relative. X1 < 0 means all
21884 the rest of the line after X0 has been written. Y coordinates
21885 are window-relative. */
21888 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
21890 enum glyph_row_area area
;
21891 int x0
, y0
, x1
, y1
;
21893 int cx0
, cx1
, cy0
, cy1
;
21894 struct glyph_row
*row
;
21896 if (!w
->phys_cursor_on_p
)
21898 if (area
!= TEXT_AREA
)
21901 if (w
->phys_cursor
.vpos
< 0
21902 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
21903 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
21904 !(row
->enabled_p
&& row
->displays_text_p
)))
21907 if (row
->cursor_in_fringe_p
)
21909 row
->cursor_in_fringe_p
= 0;
21910 draw_fringe_bitmap (w
, row
, 0);
21911 w
->phys_cursor_on_p
= 0;
21915 cx0
= w
->phys_cursor
.x
;
21916 cx1
= cx0
+ w
->phys_cursor_width
;
21917 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
21920 /* The cursor image will be completely removed from the
21921 screen if the output area intersects the cursor area in
21922 y-direction. When we draw in [y0 y1[, and some part of
21923 the cursor is at y < y0, that part must have been drawn
21924 before. When scrolling, the cursor is erased before
21925 actually scrolling, so we don't come here. When not
21926 scrolling, the rows above the old cursor row must have
21927 changed, and in this case these rows must have written
21928 over the cursor image.
21930 Likewise if part of the cursor is below y1, with the
21931 exception of the cursor being in the first blank row at
21932 the buffer and window end because update_text_area
21933 doesn't draw that row. (Except when it does, but
21934 that's handled in update_text_area.) */
21936 cy0
= w
->phys_cursor
.y
;
21937 cy1
= cy0
+ w
->phys_cursor_height
;
21938 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
21941 w
->phys_cursor_on_p
= 0;
21944 #endif /* HAVE_WINDOW_SYSTEM */
21947 /************************************************************************
21949 ************************************************************************/
21951 #ifdef HAVE_WINDOW_SYSTEM
21954 Fix the display of area AREA of overlapping row ROW in window W
21955 with respect to the overlapping part OVERLAPS. */
21958 x_fix_overlapping_area (w
, row
, area
, overlaps
)
21960 struct glyph_row
*row
;
21961 enum glyph_row_area area
;
21969 for (i
= 0; i
< row
->used
[area
];)
21971 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
21973 int start
= i
, start_x
= x
;
21977 x
+= row
->glyphs
[area
][i
].pixel_width
;
21980 while (i
< row
->used
[area
]
21981 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
21983 draw_glyphs (w
, start_x
, row
, area
,
21985 DRAW_NORMAL_TEXT
, overlaps
);
21989 x
+= row
->glyphs
[area
][i
].pixel_width
;
21999 Draw the cursor glyph of window W in glyph row ROW. See the
22000 comment of draw_glyphs for the meaning of HL. */
22003 draw_phys_cursor_glyph (w
, row
, hl
)
22005 struct glyph_row
*row
;
22006 enum draw_glyphs_face hl
;
22008 /* If cursor hpos is out of bounds, don't draw garbage. This can
22009 happen in mini-buffer windows when switching between echo area
22010 glyphs and mini-buffer. */
22011 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22013 int on_p
= w
->phys_cursor_on_p
;
22015 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22016 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22018 w
->phys_cursor_on_p
= on_p
;
22020 if (hl
== DRAW_CURSOR
)
22021 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22022 /* When we erase the cursor, and ROW is overlapped by other
22023 rows, make sure that these overlapping parts of other rows
22025 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22027 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22029 if (row
> w
->current_matrix
->rows
22030 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22031 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22032 OVERLAPS_ERASED_CURSOR
);
22034 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22035 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22036 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22037 OVERLAPS_ERASED_CURSOR
);
22044 Erase the image of a cursor of window W from the screen. */
22047 erase_phys_cursor (w
)
22050 struct frame
*f
= XFRAME (w
->frame
);
22051 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22052 int hpos
= w
->phys_cursor
.hpos
;
22053 int vpos
= w
->phys_cursor
.vpos
;
22054 int mouse_face_here_p
= 0;
22055 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22056 struct glyph_row
*cursor_row
;
22057 struct glyph
*cursor_glyph
;
22058 enum draw_glyphs_face hl
;
22060 /* No cursor displayed or row invalidated => nothing to do on the
22062 if (w
->phys_cursor_type
== NO_CURSOR
)
22063 goto mark_cursor_off
;
22065 /* VPOS >= active_glyphs->nrows means that window has been resized.
22066 Don't bother to erase the cursor. */
22067 if (vpos
>= active_glyphs
->nrows
)
22068 goto mark_cursor_off
;
22070 /* If row containing cursor is marked invalid, there is nothing we
22072 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22073 if (!cursor_row
->enabled_p
)
22074 goto mark_cursor_off
;
22076 /* If line spacing is > 0, old cursor may only be partially visible in
22077 window after split-window. So adjust visible height. */
22078 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22079 window_text_bottom_y (w
) - cursor_row
->y
);
22081 /* If row is completely invisible, don't attempt to delete a cursor which
22082 isn't there. This can happen if cursor is at top of a window, and
22083 we switch to a buffer with a header line in that window. */
22084 if (cursor_row
->visible_height
<= 0)
22085 goto mark_cursor_off
;
22087 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22088 if (cursor_row
->cursor_in_fringe_p
)
22090 cursor_row
->cursor_in_fringe_p
= 0;
22091 draw_fringe_bitmap (w
, cursor_row
, 0);
22092 goto mark_cursor_off
;
22095 /* This can happen when the new row is shorter than the old one.
22096 In this case, either draw_glyphs or clear_end_of_line
22097 should have cleared the cursor. Note that we wouldn't be
22098 able to erase the cursor in this case because we don't have a
22099 cursor glyph at hand. */
22100 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22101 goto mark_cursor_off
;
22103 /* If the cursor is in the mouse face area, redisplay that when
22104 we clear the cursor. */
22105 if (! NILP (dpyinfo
->mouse_face_window
)
22106 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22107 && (vpos
> dpyinfo
->mouse_face_beg_row
22108 || (vpos
== dpyinfo
->mouse_face_beg_row
22109 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22110 && (vpos
< dpyinfo
->mouse_face_end_row
22111 || (vpos
== dpyinfo
->mouse_face_end_row
22112 && hpos
< dpyinfo
->mouse_face_end_col
))
22113 /* Don't redraw the cursor's spot in mouse face if it is at the
22114 end of a line (on a newline). The cursor appears there, but
22115 mouse highlighting does not. */
22116 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22117 mouse_face_here_p
= 1;
22119 /* Maybe clear the display under the cursor. */
22120 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22123 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22126 cursor_glyph
= get_phys_cursor_glyph (w
);
22127 if (cursor_glyph
== NULL
)
22128 goto mark_cursor_off
;
22130 width
= cursor_glyph
->pixel_width
;
22131 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22132 x
= w
->phys_cursor
.x
;
22134 width
-= left_x
- x
;
22135 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22136 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22137 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22140 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22143 /* Erase the cursor by redrawing the character underneath it. */
22144 if (mouse_face_here_p
)
22145 hl
= DRAW_MOUSE_FACE
;
22147 hl
= DRAW_NORMAL_TEXT
;
22148 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22151 w
->phys_cursor_on_p
= 0;
22152 w
->phys_cursor_type
= NO_CURSOR
;
22157 Display or clear cursor of window W. If ON is zero, clear the
22158 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22159 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22162 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22164 int on
, hpos
, vpos
, x
, y
;
22166 struct frame
*f
= XFRAME (w
->frame
);
22167 int new_cursor_type
;
22168 int new_cursor_width
;
22170 struct glyph_row
*glyph_row
;
22171 struct glyph
*glyph
;
22173 /* This is pointless on invisible frames, and dangerous on garbaged
22174 windows and frames; in the latter case, the frame or window may
22175 be in the midst of changing its size, and x and y may be off the
22177 if (! FRAME_VISIBLE_P (f
)
22178 || FRAME_GARBAGED_P (f
)
22179 || vpos
>= w
->current_matrix
->nrows
22180 || hpos
>= w
->current_matrix
->matrix_w
)
22183 /* If cursor is off and we want it off, return quickly. */
22184 if (!on
&& !w
->phys_cursor_on_p
)
22187 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22188 /* If cursor row is not enabled, we don't really know where to
22189 display the cursor. */
22190 if (!glyph_row
->enabled_p
)
22192 w
->phys_cursor_on_p
= 0;
22197 if (!glyph_row
->exact_window_width_line_p
22198 || hpos
< glyph_row
->used
[TEXT_AREA
])
22199 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22201 xassert (interrupt_input_blocked
);
22203 /* Set new_cursor_type to the cursor we want to be displayed. */
22204 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22205 &new_cursor_width
, &active_cursor
);
22207 /* If cursor is currently being shown and we don't want it to be or
22208 it is in the wrong place, or the cursor type is not what we want,
22210 if (w
->phys_cursor_on_p
22212 || w
->phys_cursor
.x
!= x
22213 || w
->phys_cursor
.y
!= y
22214 || new_cursor_type
!= w
->phys_cursor_type
22215 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22216 && new_cursor_width
!= w
->phys_cursor_width
)))
22217 erase_phys_cursor (w
);
22219 /* Don't check phys_cursor_on_p here because that flag is only set
22220 to zero in some cases where we know that the cursor has been
22221 completely erased, to avoid the extra work of erasing the cursor
22222 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22223 still not be visible, or it has only been partly erased. */
22226 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22227 w
->phys_cursor_height
= glyph_row
->height
;
22229 /* Set phys_cursor_.* before x_draw_.* is called because some
22230 of them may need the information. */
22231 w
->phys_cursor
.x
= x
;
22232 w
->phys_cursor
.y
= glyph_row
->y
;
22233 w
->phys_cursor
.hpos
= hpos
;
22234 w
->phys_cursor
.vpos
= vpos
;
22237 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22238 new_cursor_type
, new_cursor_width
,
22239 on
, active_cursor
);
22243 /* Switch the display of W's cursor on or off, according to the value
22247 update_window_cursor (w
, on
)
22251 /* Don't update cursor in windows whose frame is in the process
22252 of being deleted. */
22253 if (w
->current_matrix
)
22256 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22257 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22263 /* Call update_window_cursor with parameter ON_P on all leaf windows
22264 in the window tree rooted at W. */
22267 update_cursor_in_window_tree (w
, on_p
)
22273 if (!NILP (w
->hchild
))
22274 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22275 else if (!NILP (w
->vchild
))
22276 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22278 update_window_cursor (w
, on_p
);
22280 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22286 Display the cursor on window W, or clear it, according to ON_P.
22287 Don't change the cursor's position. */
22290 x_update_cursor (f
, on_p
)
22294 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22299 Clear the cursor of window W to background color, and mark the
22300 cursor as not shown. This is used when the text where the cursor
22301 is is about to be rewritten. */
22307 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22308 update_window_cursor (w
, 0);
22313 Display the active region described by mouse_face_* according to DRAW. */
22316 show_mouse_face (dpyinfo
, draw
)
22317 Display_Info
*dpyinfo
;
22318 enum draw_glyphs_face draw
;
22320 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22321 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22323 if (/* If window is in the process of being destroyed, don't bother
22325 w
->current_matrix
!= NULL
22326 /* Don't update mouse highlight if hidden */
22327 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22328 /* Recognize when we are called to operate on rows that don't exist
22329 anymore. This can happen when a window is split. */
22330 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22332 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22333 struct glyph_row
*row
, *first
, *last
;
22335 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22336 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22338 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22340 int start_hpos
, end_hpos
, start_x
;
22342 /* For all but the first row, the highlight starts at column 0. */
22345 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22346 start_x
= dpyinfo
->mouse_face_beg_x
;
22355 end_hpos
= dpyinfo
->mouse_face_end_col
;
22358 end_hpos
= row
->used
[TEXT_AREA
];
22359 if (draw
== DRAW_NORMAL_TEXT
)
22360 row
->fill_line_p
= 1; /* Clear to end of line */
22363 if (end_hpos
> start_hpos
)
22365 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22366 start_hpos
, end_hpos
,
22370 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22374 /* When we've written over the cursor, arrange for it to
22375 be displayed again. */
22376 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22379 display_and_set_cursor (w
, 1,
22380 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22381 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22386 /* Change the mouse cursor. */
22387 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22388 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22389 else if (draw
== DRAW_MOUSE_FACE
)
22390 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22392 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22396 Clear out the mouse-highlighted active region.
22397 Redraw it un-highlighted first. Value is non-zero if mouse
22398 face was actually drawn unhighlighted. */
22401 clear_mouse_face (dpyinfo
)
22402 Display_Info
*dpyinfo
;
22406 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22408 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22412 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22413 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22414 dpyinfo
->mouse_face_window
= Qnil
;
22415 dpyinfo
->mouse_face_overlay
= Qnil
;
22421 Non-zero if physical cursor of window W is within mouse face. */
22424 cursor_in_mouse_face_p (w
)
22427 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22428 int in_mouse_face
= 0;
22430 if (WINDOWP (dpyinfo
->mouse_face_window
)
22431 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22433 int hpos
= w
->phys_cursor
.hpos
;
22434 int vpos
= w
->phys_cursor
.vpos
;
22436 if (vpos
>= dpyinfo
->mouse_face_beg_row
22437 && vpos
<= dpyinfo
->mouse_face_end_row
22438 && (vpos
> dpyinfo
->mouse_face_beg_row
22439 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22440 && (vpos
< dpyinfo
->mouse_face_end_row
22441 || hpos
< dpyinfo
->mouse_face_end_col
22442 || dpyinfo
->mouse_face_past_end
))
22446 return in_mouse_face
;
22452 /* Find the glyph matrix position of buffer position CHARPOS in window
22453 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22454 current glyphs must be up to date. If CHARPOS is above window
22455 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22456 of last line in W. In the row containing CHARPOS, stop before glyphs
22457 having STOP as object. */
22459 #if 1 /* This is a version of fast_find_position that's more correct
22460 in the presence of hscrolling, for example. I didn't install
22461 it right away because the problem fixed is minor, it failed
22462 in 20.x as well, and I think it's too risky to install
22463 so near the release of 21.1. 2001-09-25 gerd. */
22466 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22469 int *hpos
, *vpos
, *x
, *y
;
22472 struct glyph_row
*row
, *first
;
22473 struct glyph
*glyph
, *end
;
22476 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22477 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22482 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22486 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22489 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22493 /* If whole rows or last part of a row came from a display overlay,
22494 row_containing_pos will skip over such rows because their end pos
22495 equals the start pos of the overlay or interval.
22497 Move back if we have a STOP object and previous row's
22498 end glyph came from STOP. */
22501 struct glyph_row
*prev
;
22502 while ((prev
= row
- 1, prev
>= first
)
22503 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22504 && prev
->used
[TEXT_AREA
] > 0)
22506 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22507 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22508 while (--glyph
>= beg
22509 && INTEGERP (glyph
->object
));
22511 || !EQ (stop
, glyph
->object
))
22519 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22521 glyph
= row
->glyphs
[TEXT_AREA
];
22522 end
= glyph
+ row
->used
[TEXT_AREA
];
22524 /* Skip over glyphs not having an object at the start of the row.
22525 These are special glyphs like truncation marks on terminal
22527 if (row
->displays_text_p
)
22529 && INTEGERP (glyph
->object
)
22530 && !EQ (stop
, glyph
->object
)
22531 && glyph
->charpos
< 0)
22533 *x
+= glyph
->pixel_width
;
22538 && !INTEGERP (glyph
->object
)
22539 && !EQ (stop
, glyph
->object
)
22540 && (!BUFFERP (glyph
->object
)
22541 || glyph
->charpos
< charpos
))
22543 *x
+= glyph
->pixel_width
;
22547 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22554 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22557 int *hpos
, *vpos
, *x
, *y
;
22562 int maybe_next_line_p
= 0;
22563 int line_start_position
;
22564 int yb
= window_text_bottom_y (w
);
22565 struct glyph_row
*row
, *best_row
;
22566 int row_vpos
, best_row_vpos
;
22569 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22570 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22572 while (row
->y
< yb
)
22574 if (row
->used
[TEXT_AREA
])
22575 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
22577 line_start_position
= 0;
22579 if (line_start_position
> pos
)
22581 /* If the position sought is the end of the buffer,
22582 don't include the blank lines at the bottom of the window. */
22583 else if (line_start_position
== pos
22584 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
22586 maybe_next_line_p
= 1;
22589 else if (line_start_position
> 0)
22592 best_row_vpos
= row_vpos
;
22595 if (row
->y
+ row
->height
>= yb
)
22602 /* Find the right column within BEST_ROW. */
22604 current_x
= best_row
->x
;
22605 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
22607 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
22608 int charpos
= glyph
->charpos
;
22610 if (BUFFERP (glyph
->object
))
22612 if (charpos
== pos
)
22615 *vpos
= best_row_vpos
;
22620 else if (charpos
> pos
)
22623 else if (EQ (glyph
->object
, stop
))
22628 current_x
+= glyph
->pixel_width
;
22631 /* If we're looking for the end of the buffer,
22632 and we didn't find it in the line we scanned,
22633 use the start of the following line. */
22634 if (maybe_next_line_p
)
22639 current_x
= best_row
->x
;
22642 *vpos
= best_row_vpos
;
22643 *hpos
= lastcol
+ 1;
22652 /* Find the position of the glyph for position POS in OBJECT in
22653 window W's current matrix, and return in *X, *Y the pixel
22654 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
22656 RIGHT_P non-zero means return the position of the right edge of the
22657 glyph, RIGHT_P zero means return the left edge position.
22659 If no glyph for POS exists in the matrix, return the position of
22660 the glyph with the next smaller position that is in the matrix, if
22661 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
22662 exists in the matrix, return the position of the glyph with the
22663 next larger position in OBJECT.
22665 Value is non-zero if a glyph was found. */
22668 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
22671 Lisp_Object object
;
22672 int *hpos
, *vpos
, *x
, *y
;
22675 int yb
= window_text_bottom_y (w
);
22676 struct glyph_row
*r
;
22677 struct glyph
*best_glyph
= NULL
;
22678 struct glyph_row
*best_row
= NULL
;
22681 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22682 r
->enabled_p
&& r
->y
< yb
;
22685 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
22686 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
22689 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
22690 if (EQ (g
->object
, object
))
22692 if (g
->charpos
== pos
)
22699 else if (best_glyph
== NULL
22700 || ((eabs (g
->charpos
- pos
)
22701 < eabs (best_glyph
->charpos
- pos
))
22704 : g
->charpos
> pos
)))
22718 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
22722 *x
+= best_glyph
->pixel_width
;
22727 *vpos
= best_row
- w
->current_matrix
->rows
;
22730 return best_glyph
!= NULL
;
22734 /* See if position X, Y is within a hot-spot of an image. */
22737 on_hot_spot_p (hot_spot
, x
, y
)
22738 Lisp_Object hot_spot
;
22741 if (!CONSP (hot_spot
))
22744 if (EQ (XCAR (hot_spot
), Qrect
))
22746 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
22747 Lisp_Object rect
= XCDR (hot_spot
);
22751 if (!CONSP (XCAR (rect
)))
22753 if (!CONSP (XCDR (rect
)))
22755 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
22757 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
22759 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
22761 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
22765 else if (EQ (XCAR (hot_spot
), Qcircle
))
22767 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
22768 Lisp_Object circ
= XCDR (hot_spot
);
22769 Lisp_Object lr
, lx0
, ly0
;
22771 && CONSP (XCAR (circ
))
22772 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
22773 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
22774 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
22776 double r
= XFLOATINT (lr
);
22777 double dx
= XINT (lx0
) - x
;
22778 double dy
= XINT (ly0
) - y
;
22779 return (dx
* dx
+ dy
* dy
<= r
* r
);
22782 else if (EQ (XCAR (hot_spot
), Qpoly
))
22784 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
22785 if (VECTORP (XCDR (hot_spot
)))
22787 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
22788 Lisp_Object
*poly
= v
->contents
;
22792 Lisp_Object lx
, ly
;
22795 /* Need an even number of coordinates, and at least 3 edges. */
22796 if (n
< 6 || n
& 1)
22799 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
22800 If count is odd, we are inside polygon. Pixels on edges
22801 may or may not be included depending on actual geometry of the
22803 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
22804 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
22806 x0
= XINT (lx
), y0
= XINT (ly
);
22807 for (i
= 0; i
< n
; i
+= 2)
22809 int x1
= x0
, y1
= y0
;
22810 if ((lx
= poly
[i
], !INTEGERP (lx
))
22811 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
22813 x0
= XINT (lx
), y0
= XINT (ly
);
22815 /* Does this segment cross the X line? */
22823 if (y
> y0
&& y
> y1
)
22825 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
22835 find_hot_spot (map
, x
, y
)
22839 while (CONSP (map
))
22841 if (CONSP (XCAR (map
))
22842 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
22850 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
22852 doc
: /* Lookup in image map MAP coordinates X and Y.
22853 An image map is an alist where each element has the format (AREA ID PLIST).
22854 An AREA is specified as either a rectangle, a circle, or a polygon:
22855 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
22856 pixel coordinates of the upper left and bottom right corners.
22857 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
22858 and the radius of the circle; r may be a float or integer.
22859 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
22860 vector describes one corner in the polygon.
22861 Returns the alist element for the first matching AREA in MAP. */)
22872 return find_hot_spot (map
, XINT (x
), XINT (y
));
22876 /* Display frame CURSOR, optionally using shape defined by POINTER. */
22878 define_frame_cursor1 (f
, cursor
, pointer
)
22881 Lisp_Object pointer
;
22883 /* Do not change cursor shape while dragging mouse. */
22884 if (!NILP (do_mouse_tracking
))
22887 if (!NILP (pointer
))
22889 if (EQ (pointer
, Qarrow
))
22890 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22891 else if (EQ (pointer
, Qhand
))
22892 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
22893 else if (EQ (pointer
, Qtext
))
22894 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
22895 else if (EQ (pointer
, intern ("hdrag")))
22896 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
22897 #ifdef HAVE_X_WINDOWS
22898 else if (EQ (pointer
, intern ("vdrag")))
22899 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
22901 else if (EQ (pointer
, intern ("hourglass")))
22902 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
22903 else if (EQ (pointer
, Qmodeline
))
22904 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
22906 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22909 if (cursor
!= No_Cursor
)
22910 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
22913 /* Take proper action when mouse has moved to the mode or header line
22914 or marginal area AREA of window W, x-position X and y-position Y.
22915 X is relative to the start of the text display area of W, so the
22916 width of bitmap areas and scroll bars must be subtracted to get a
22917 position relative to the start of the mode line. */
22920 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
22921 Lisp_Object window
;
22923 enum window_part area
;
22925 struct window
*w
= XWINDOW (window
);
22926 struct frame
*f
= XFRAME (w
->frame
);
22927 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22928 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22929 Lisp_Object pointer
= Qnil
;
22930 int charpos
, dx
, dy
, width
, height
;
22931 Lisp_Object string
, object
= Qnil
;
22932 Lisp_Object pos
, help
;
22934 Lisp_Object mouse_face
;
22935 int original_x_pixel
= x
;
22936 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
22937 struct glyph_row
*row
;
22939 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
22944 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
22945 &object
, &dx
, &dy
, &width
, &height
);
22947 row
= (area
== ON_MODE_LINE
22948 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
22949 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
22952 if (row
->mode_line_p
&& row
->enabled_p
)
22954 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
22955 end
= glyph
+ row
->used
[TEXT_AREA
];
22957 for (x0
= original_x_pixel
;
22958 glyph
< end
&& x0
>= glyph
->pixel_width
;
22960 x0
-= glyph
->pixel_width
;
22968 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
22969 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
22970 &object
, &dx
, &dy
, &width
, &height
);
22975 if (IMAGEP (object
))
22977 Lisp_Object image_map
, hotspot
;
22978 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
22980 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
22982 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
22984 Lisp_Object area_id
, plist
;
22986 area_id
= XCAR (hotspot
);
22987 /* Could check AREA_ID to see if we enter/leave this hot-spot.
22988 If so, we could look for mouse-enter, mouse-leave
22989 properties in PLIST (and do something...). */
22990 hotspot
= XCDR (hotspot
);
22991 if (CONSP (hotspot
)
22992 && (plist
= XCAR (hotspot
), CONSP (plist
)))
22994 pointer
= Fplist_get (plist
, Qpointer
);
22995 if (NILP (pointer
))
22997 help
= Fplist_get (plist
, Qhelp_echo
);
23000 help_echo_string
= help
;
23001 /* Is this correct? ++kfs */
23002 XSETWINDOW (help_echo_window
, w
);
23003 help_echo_object
= w
->buffer
;
23004 help_echo_pos
= charpos
;
23008 if (NILP (pointer
))
23009 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23012 if (STRINGP (string
))
23014 pos
= make_number (charpos
);
23015 /* If we're on a string with `help-echo' text property, arrange
23016 for the help to be displayed. This is done by setting the
23017 global variable help_echo_string to the help string. */
23020 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23023 help_echo_string
= help
;
23024 XSETWINDOW (help_echo_window
, w
);
23025 help_echo_object
= string
;
23026 help_echo_pos
= charpos
;
23030 if (NILP (pointer
))
23031 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23033 /* Change the mouse pointer according to what is under X/Y. */
23034 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23037 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23038 if (!KEYMAPP (map
))
23039 map
= Fget_text_property (pos
, Qkeymap
, string
);
23040 if (!KEYMAPP (map
))
23041 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23044 /* Change the mouse face according to what is under X/Y. */
23045 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23046 if (!NILP (mouse_face
)
23047 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23052 struct glyph
* tmp_glyph
;
23056 int total_pixel_width
;
23061 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23062 Qmouse_face
, string
, Qnil
);
23064 b
= make_number (0);
23066 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23068 e
= make_number (SCHARS (string
));
23070 /* Calculate the position(glyph position: GPOS) of GLYPH in
23071 displayed string. GPOS is different from CHARPOS.
23073 CHARPOS is the position of glyph in internal string
23074 object. A mode line string format has structures which
23075 is converted to a flatten by emacs lisp interpreter.
23076 The internal string is an element of the structures.
23077 The displayed string is the flatten string. */
23079 if (glyph
> row_start_glyph
)
23081 tmp_glyph
= glyph
- 1;
23082 while (tmp_glyph
>= row_start_glyph
23083 && tmp_glyph
->charpos
>= XINT (b
)
23084 && EQ (tmp_glyph
->object
, glyph
->object
))
23091 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23092 displayed string holding GLYPH.
23094 GSEQ_LENGTH is different from SCHARS (STRING).
23095 SCHARS (STRING) returns the length of the internal string. */
23096 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23097 tmp_glyph
->charpos
< XINT (e
);
23098 tmp_glyph
++, gseq_length
++)
23100 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23104 total_pixel_width
= 0;
23105 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23106 total_pixel_width
+= tmp_glyph
->pixel_width
;
23108 /* Pre calculation of re-rendering position */
23110 hpos
= (area
== ON_MODE_LINE
23111 ? (w
->current_matrix
)->nrows
- 1
23114 /* If the re-rendering position is included in the last
23115 re-rendering area, we should do nothing. */
23116 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23117 && dpyinfo
->mouse_face_beg_col
<= vpos
23118 && vpos
< dpyinfo
->mouse_face_end_col
23119 && dpyinfo
->mouse_face_beg_row
== hpos
)
23122 if (clear_mouse_face (dpyinfo
))
23123 cursor
= No_Cursor
;
23125 dpyinfo
->mouse_face_beg_col
= vpos
;
23126 dpyinfo
->mouse_face_beg_row
= hpos
;
23128 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23129 dpyinfo
->mouse_face_beg_y
= 0;
23131 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23132 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23134 dpyinfo
->mouse_face_end_x
= 0;
23135 dpyinfo
->mouse_face_end_y
= 0;
23137 dpyinfo
->mouse_face_past_end
= 0;
23138 dpyinfo
->mouse_face_window
= window
;
23140 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23143 glyph
->face_id
, 1);
23144 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23146 if (NILP (pointer
))
23149 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23150 clear_mouse_face (dpyinfo
);
23152 define_frame_cursor1 (f
, cursor
, pointer
);
23157 Take proper action when the mouse has moved to position X, Y on
23158 frame F as regards highlighting characters that have mouse-face
23159 properties. Also de-highlighting chars where the mouse was before.
23160 X and Y can be negative or out of range. */
23163 note_mouse_highlight (f
, x
, y
)
23167 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23168 enum window_part part
;
23169 Lisp_Object window
;
23171 Cursor cursor
= No_Cursor
;
23172 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23175 /* When a menu is active, don't highlight because this looks odd. */
23176 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
23177 if (popup_activated ())
23181 if (NILP (Vmouse_highlight
)
23182 || !f
->glyphs_initialized_p
)
23185 dpyinfo
->mouse_face_mouse_x
= x
;
23186 dpyinfo
->mouse_face_mouse_y
= y
;
23187 dpyinfo
->mouse_face_mouse_frame
= f
;
23189 if (dpyinfo
->mouse_face_defer
)
23192 if (gc_in_progress
)
23194 dpyinfo
->mouse_face_deferred_gc
= 1;
23198 /* Which window is that in? */
23199 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23201 /* If we were displaying active text in another window, clear that.
23202 Also clear if we move out of text area in same window. */
23203 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23204 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23205 && !NILP (dpyinfo
->mouse_face_window
)))
23206 clear_mouse_face (dpyinfo
);
23208 /* Not on a window -> return. */
23209 if (!WINDOWP (window
))
23212 /* Reset help_echo_string. It will get recomputed below. */
23213 help_echo_string
= Qnil
;
23215 /* Convert to window-relative pixel coordinates. */
23216 w
= XWINDOW (window
);
23217 frame_to_window_pixel_xy (w
, &x
, &y
);
23219 /* Handle tool-bar window differently since it doesn't display a
23221 if (EQ (window
, f
->tool_bar_window
))
23223 note_tool_bar_highlight (f
, x
, y
);
23227 /* Mouse is on the mode, header line or margin? */
23228 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23229 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23231 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23235 if (part
== ON_VERTICAL_BORDER
)
23237 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23238 help_echo_string
= build_string ("drag-mouse-1: resize");
23240 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23241 || part
== ON_SCROLL_BAR
)
23242 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23244 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23246 /* Are we in a window whose display is up to date?
23247 And verify the buffer's text has not changed. */
23248 b
= XBUFFER (w
->buffer
);
23249 if (part
== ON_TEXT
23250 && EQ (w
->window_end_valid
, w
->buffer
)
23251 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23252 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23254 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23255 struct glyph
*glyph
;
23256 Lisp_Object object
;
23257 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23258 Lisp_Object
*overlay_vec
= NULL
;
23260 struct buffer
*obuf
;
23261 int obegv
, ozv
, same_region
;
23263 /* Find the glyph under X/Y. */
23264 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23266 /* Look for :pointer property on image. */
23267 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23269 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23270 if (img
!= NULL
&& IMAGEP (img
->spec
))
23272 Lisp_Object image_map
, hotspot
;
23273 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23275 && (hotspot
= find_hot_spot (image_map
,
23276 glyph
->slice
.x
+ dx
,
23277 glyph
->slice
.y
+ dy
),
23279 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23281 Lisp_Object area_id
, plist
;
23283 area_id
= XCAR (hotspot
);
23284 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23285 If so, we could look for mouse-enter, mouse-leave
23286 properties in PLIST (and do something...). */
23287 hotspot
= XCDR (hotspot
);
23288 if (CONSP (hotspot
)
23289 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23291 pointer
= Fplist_get (plist
, Qpointer
);
23292 if (NILP (pointer
))
23294 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23295 if (!NILP (help_echo_string
))
23297 help_echo_window
= window
;
23298 help_echo_object
= glyph
->object
;
23299 help_echo_pos
= glyph
->charpos
;
23303 if (NILP (pointer
))
23304 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23308 /* Clear mouse face if X/Y not over text. */
23310 || area
!= TEXT_AREA
23311 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23313 if (clear_mouse_face (dpyinfo
))
23314 cursor
= No_Cursor
;
23315 if (NILP (pointer
))
23317 if (area
!= TEXT_AREA
)
23318 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23320 pointer
= Vvoid_text_area_pointer
;
23325 pos
= glyph
->charpos
;
23326 object
= glyph
->object
;
23327 if (!STRINGP (object
) && !BUFFERP (object
))
23330 /* If we get an out-of-range value, return now; avoid an error. */
23331 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23334 /* Make the window's buffer temporarily current for
23335 overlays_at and compute_char_face. */
23336 obuf
= current_buffer
;
23337 current_buffer
= b
;
23343 /* Is this char mouse-active or does it have help-echo? */
23344 position
= make_number (pos
);
23346 if (BUFFERP (object
))
23348 /* Put all the overlays we want in a vector in overlay_vec. */
23349 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23350 /* Sort overlays into increasing priority order. */
23351 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23356 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23357 && vpos
>= dpyinfo
->mouse_face_beg_row
23358 && vpos
<= dpyinfo
->mouse_face_end_row
23359 && (vpos
> dpyinfo
->mouse_face_beg_row
23360 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23361 && (vpos
< dpyinfo
->mouse_face_end_row
23362 || hpos
< dpyinfo
->mouse_face_end_col
23363 || dpyinfo
->mouse_face_past_end
));
23366 cursor
= No_Cursor
;
23368 /* Check mouse-face highlighting. */
23370 /* If there exists an overlay with mouse-face overlapping
23371 the one we are currently highlighting, we have to
23372 check if we enter the overlapping overlay, and then
23373 highlight only that. */
23374 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23375 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23377 /* Find the highest priority overlay that has a mouse-face
23380 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23382 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23383 if (!NILP (mouse_face
))
23384 overlay
= overlay_vec
[i
];
23387 /* If we're actually highlighting the same overlay as
23388 before, there's no need to do that again. */
23389 if (!NILP (overlay
)
23390 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23391 goto check_help_echo
;
23393 dpyinfo
->mouse_face_overlay
= overlay
;
23395 /* Clear the display of the old active region, if any. */
23396 if (clear_mouse_face (dpyinfo
))
23397 cursor
= No_Cursor
;
23399 /* If no overlay applies, get a text property. */
23400 if (NILP (overlay
))
23401 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23403 /* Handle the overlay case. */
23404 if (!NILP (overlay
))
23406 /* Find the range of text around this char that
23407 should be active. */
23408 Lisp_Object before
, after
;
23411 before
= Foverlay_start (overlay
);
23412 after
= Foverlay_end (overlay
);
23413 /* Record this as the current active region. */
23414 fast_find_position (w
, XFASTINT (before
),
23415 &dpyinfo
->mouse_face_beg_col
,
23416 &dpyinfo
->mouse_face_beg_row
,
23417 &dpyinfo
->mouse_face_beg_x
,
23418 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23420 dpyinfo
->mouse_face_past_end
23421 = !fast_find_position (w
, XFASTINT (after
),
23422 &dpyinfo
->mouse_face_end_col
,
23423 &dpyinfo
->mouse_face_end_row
,
23424 &dpyinfo
->mouse_face_end_x
,
23425 &dpyinfo
->mouse_face_end_y
, Qnil
);
23426 dpyinfo
->mouse_face_window
= window
;
23428 dpyinfo
->mouse_face_face_id
23429 = face_at_buffer_position (w
, pos
, 0, 0,
23431 !dpyinfo
->mouse_face_hidden
);
23433 /* Display it as active. */
23434 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23435 cursor
= No_Cursor
;
23437 /* Handle the text property case. */
23438 else if (!NILP (mouse_face
) && BUFFERP (object
))
23440 /* Find the range of text around this char that
23441 should be active. */
23442 Lisp_Object before
, after
, beginning
, end
;
23445 beginning
= Fmarker_position (w
->start
);
23446 end
= make_number (BUF_Z (XBUFFER (object
))
23447 - XFASTINT (w
->window_end_pos
));
23449 = Fprevious_single_property_change (make_number (pos
+ 1),
23451 object
, beginning
);
23453 = Fnext_single_property_change (position
, Qmouse_face
,
23456 /* Record this as the current active region. */
23457 fast_find_position (w
, XFASTINT (before
),
23458 &dpyinfo
->mouse_face_beg_col
,
23459 &dpyinfo
->mouse_face_beg_row
,
23460 &dpyinfo
->mouse_face_beg_x
,
23461 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23462 dpyinfo
->mouse_face_past_end
23463 = !fast_find_position (w
, XFASTINT (after
),
23464 &dpyinfo
->mouse_face_end_col
,
23465 &dpyinfo
->mouse_face_end_row
,
23466 &dpyinfo
->mouse_face_end_x
,
23467 &dpyinfo
->mouse_face_end_y
, Qnil
);
23468 dpyinfo
->mouse_face_window
= window
;
23470 if (BUFFERP (object
))
23471 dpyinfo
->mouse_face_face_id
23472 = face_at_buffer_position (w
, pos
, 0, 0,
23474 !dpyinfo
->mouse_face_hidden
);
23476 /* Display it as active. */
23477 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23478 cursor
= No_Cursor
;
23480 else if (!NILP (mouse_face
) && STRINGP (object
))
23485 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23488 e
= Fnext_single_property_change (position
, Qmouse_face
,
23491 b
= make_number (0);
23493 e
= make_number (SCHARS (object
) - 1);
23495 fast_find_string_pos (w
, XINT (b
), object
,
23496 &dpyinfo
->mouse_face_beg_col
,
23497 &dpyinfo
->mouse_face_beg_row
,
23498 &dpyinfo
->mouse_face_beg_x
,
23499 &dpyinfo
->mouse_face_beg_y
, 0);
23500 fast_find_string_pos (w
, XINT (e
), object
,
23501 &dpyinfo
->mouse_face_end_col
,
23502 &dpyinfo
->mouse_face_end_row
,
23503 &dpyinfo
->mouse_face_end_x
,
23504 &dpyinfo
->mouse_face_end_y
, 1);
23505 dpyinfo
->mouse_face_past_end
= 0;
23506 dpyinfo
->mouse_face_window
= window
;
23507 dpyinfo
->mouse_face_face_id
23508 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23509 glyph
->face_id
, 1);
23510 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23511 cursor
= No_Cursor
;
23513 else if (STRINGP (object
) && NILP (mouse_face
))
23515 /* A string which doesn't have mouse-face, but
23516 the text ``under'' it might have. */
23517 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23518 int start
= MATRIX_ROW_START_CHARPOS (r
);
23520 pos
= string_buffer_position (w
, object
, start
);
23522 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23526 if (!NILP (mouse_face
) && !NILP (overlay
))
23528 Lisp_Object before
= Foverlay_start (overlay
);
23529 Lisp_Object after
= Foverlay_end (overlay
);
23532 /* Note that we might not be able to find position
23533 BEFORE in the glyph matrix if the overlay is
23534 entirely covered by a `display' property. In
23535 this case, we overshoot. So let's stop in
23536 the glyph matrix before glyphs for OBJECT. */
23537 fast_find_position (w
, XFASTINT (before
),
23538 &dpyinfo
->mouse_face_beg_col
,
23539 &dpyinfo
->mouse_face_beg_row
,
23540 &dpyinfo
->mouse_face_beg_x
,
23541 &dpyinfo
->mouse_face_beg_y
,
23544 dpyinfo
->mouse_face_past_end
23545 = !fast_find_position (w
, XFASTINT (after
),
23546 &dpyinfo
->mouse_face_end_col
,
23547 &dpyinfo
->mouse_face_end_row
,
23548 &dpyinfo
->mouse_face_end_x
,
23549 &dpyinfo
->mouse_face_end_y
,
23551 dpyinfo
->mouse_face_window
= window
;
23552 dpyinfo
->mouse_face_face_id
23553 = face_at_buffer_position (w
, pos
, 0, 0,
23555 !dpyinfo
->mouse_face_hidden
);
23557 /* Display it as active. */
23558 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23559 cursor
= No_Cursor
;
23566 /* Look for a `help-echo' property. */
23567 if (NILP (help_echo_string
)) {
23568 Lisp_Object help
, overlay
;
23570 /* Check overlays first. */
23571 help
= overlay
= Qnil
;
23572 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23574 overlay
= overlay_vec
[i
];
23575 help
= Foverlay_get (overlay
, Qhelp_echo
);
23580 help_echo_string
= help
;
23581 help_echo_window
= window
;
23582 help_echo_object
= overlay
;
23583 help_echo_pos
= pos
;
23587 Lisp_Object object
= glyph
->object
;
23588 int charpos
= glyph
->charpos
;
23590 /* Try text properties. */
23591 if (STRINGP (object
)
23593 && charpos
< SCHARS (object
))
23595 help
= Fget_text_property (make_number (charpos
),
23596 Qhelp_echo
, object
);
23599 /* If the string itself doesn't specify a help-echo,
23600 see if the buffer text ``under'' it does. */
23601 struct glyph_row
*r
23602 = MATRIX_ROW (w
->current_matrix
, vpos
);
23603 int start
= MATRIX_ROW_START_CHARPOS (r
);
23604 int pos
= string_buffer_position (w
, object
, start
);
23607 help
= Fget_char_property (make_number (pos
),
23608 Qhelp_echo
, w
->buffer
);
23612 object
= w
->buffer
;
23617 else if (BUFFERP (object
)
23620 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23625 help_echo_string
= help
;
23626 help_echo_window
= window
;
23627 help_echo_object
= object
;
23628 help_echo_pos
= charpos
;
23633 /* Look for a `pointer' property. */
23634 if (NILP (pointer
))
23636 /* Check overlays first. */
23637 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23638 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23640 if (NILP (pointer
))
23642 Lisp_Object object
= glyph
->object
;
23643 int charpos
= glyph
->charpos
;
23645 /* Try text properties. */
23646 if (STRINGP (object
)
23648 && charpos
< SCHARS (object
))
23650 pointer
= Fget_text_property (make_number (charpos
),
23652 if (NILP (pointer
))
23654 /* If the string itself doesn't specify a pointer,
23655 see if the buffer text ``under'' it does. */
23656 struct glyph_row
*r
23657 = MATRIX_ROW (w
->current_matrix
, vpos
);
23658 int start
= MATRIX_ROW_START_CHARPOS (r
);
23659 int pos
= string_buffer_position (w
, object
, start
);
23661 pointer
= Fget_char_property (make_number (pos
),
23662 Qpointer
, w
->buffer
);
23665 else if (BUFFERP (object
)
23668 pointer
= Fget_text_property (make_number (charpos
),
23675 current_buffer
= obuf
;
23680 define_frame_cursor1 (f
, cursor
, pointer
);
23685 Clear any mouse-face on window W. This function is part of the
23686 redisplay interface, and is called from try_window_id and similar
23687 functions to ensure the mouse-highlight is off. */
23690 x_clear_window_mouse_face (w
)
23693 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23694 Lisp_Object window
;
23697 XSETWINDOW (window
, w
);
23698 if (EQ (window
, dpyinfo
->mouse_face_window
))
23699 clear_mouse_face (dpyinfo
);
23705 Just discard the mouse face information for frame F, if any.
23706 This is used when the size of F is changed. */
23709 cancel_mouse_face (f
)
23712 Lisp_Object window
;
23713 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23715 window
= dpyinfo
->mouse_face_window
;
23716 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
23718 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23719 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23720 dpyinfo
->mouse_face_window
= Qnil
;
23725 #endif /* HAVE_WINDOW_SYSTEM */
23728 /***********************************************************************
23730 ***********************************************************************/
23732 #ifdef HAVE_WINDOW_SYSTEM
23734 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
23735 which intersects rectangle R. R is in window-relative coordinates. */
23738 expose_area (w
, row
, r
, area
)
23740 struct glyph_row
*row
;
23742 enum glyph_row_area area
;
23744 struct glyph
*first
= row
->glyphs
[area
];
23745 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
23746 struct glyph
*last
;
23747 int first_x
, start_x
, x
;
23749 if (area
== TEXT_AREA
&& row
->fill_line_p
)
23750 /* If row extends face to end of line write the whole line. */
23751 draw_glyphs (w
, 0, row
, area
,
23752 0, row
->used
[area
],
23753 DRAW_NORMAL_TEXT
, 0);
23756 /* Set START_X to the window-relative start position for drawing glyphs of
23757 AREA. The first glyph of the text area can be partially visible.
23758 The first glyphs of other areas cannot. */
23759 start_x
= window_box_left_offset (w
, area
);
23761 if (area
== TEXT_AREA
)
23764 /* Find the first glyph that must be redrawn. */
23766 && x
+ first
->pixel_width
< r
->x
)
23768 x
+= first
->pixel_width
;
23772 /* Find the last one. */
23776 && x
< r
->x
+ r
->width
)
23778 x
+= last
->pixel_width
;
23784 draw_glyphs (w
, first_x
- start_x
, row
, area
,
23785 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
23786 DRAW_NORMAL_TEXT
, 0);
23791 /* Redraw the parts of the glyph row ROW on window W intersecting
23792 rectangle R. R is in window-relative coordinates. Value is
23793 non-zero if mouse-face was overwritten. */
23796 expose_line (w
, row
, r
)
23798 struct glyph_row
*row
;
23801 xassert (row
->enabled_p
);
23803 if (row
->mode_line_p
|| w
->pseudo_window_p
)
23804 draw_glyphs (w
, 0, row
, TEXT_AREA
,
23805 0, row
->used
[TEXT_AREA
],
23806 DRAW_NORMAL_TEXT
, 0);
23809 if (row
->used
[LEFT_MARGIN_AREA
])
23810 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
23811 if (row
->used
[TEXT_AREA
])
23812 expose_area (w
, row
, r
, TEXT_AREA
);
23813 if (row
->used
[RIGHT_MARGIN_AREA
])
23814 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
23815 draw_row_fringe_bitmaps (w
, row
);
23818 return row
->mouse_face_p
;
23822 /* Redraw those parts of glyphs rows during expose event handling that
23823 overlap other rows. Redrawing of an exposed line writes over parts
23824 of lines overlapping that exposed line; this function fixes that.
23826 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
23827 row in W's current matrix that is exposed and overlaps other rows.
23828 LAST_OVERLAPPING_ROW is the last such row. */
23831 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
23833 struct glyph_row
*first_overlapping_row
;
23834 struct glyph_row
*last_overlapping_row
;
23837 struct glyph_row
*row
;
23839 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
23840 if (row
->overlapping_p
)
23842 xassert (row
->enabled_p
&& !row
->mode_line_p
);
23845 if (row
->used
[LEFT_MARGIN_AREA
])
23846 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
23848 if (row
->used
[TEXT_AREA
])
23849 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
23851 if (row
->used
[RIGHT_MARGIN_AREA
])
23852 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
23858 /* Return non-zero if W's cursor intersects rectangle R. */
23861 phys_cursor_in_rect_p (w
, r
)
23865 XRectangle cr
, result
;
23866 struct glyph
*cursor_glyph
;
23867 struct glyph_row
*row
;
23869 if (w
->phys_cursor
.vpos
>= 0
23870 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
23871 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
23873 && row
->cursor_in_fringe_p
)
23875 /* Cursor is in the fringe. */
23876 cr
.x
= window_box_right_offset (w
,
23877 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
23878 ? RIGHT_MARGIN_AREA
23881 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
23882 cr
.height
= row
->height
;
23883 return x_intersect_rectangles (&cr
, r
, &result
);
23886 cursor_glyph
= get_phys_cursor_glyph (w
);
23889 /* r is relative to W's box, but w->phys_cursor.x is relative
23890 to left edge of W's TEXT area. Adjust it. */
23891 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
23892 cr
.y
= w
->phys_cursor
.y
;
23893 cr
.width
= cursor_glyph
->pixel_width
;
23894 cr
.height
= w
->phys_cursor_height
;
23895 /* ++KFS: W32 version used W32-specific IntersectRect here, but
23896 I assume the effect is the same -- and this is portable. */
23897 return x_intersect_rectangles (&cr
, r
, &result
);
23899 /* If we don't understand the format, pretend we're not in the hot-spot. */
23905 Draw a vertical window border to the right of window W if W doesn't
23906 have vertical scroll bars. */
23909 x_draw_vertical_border (w
)
23912 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23914 /* We could do better, if we knew what type of scroll-bar the adjacent
23915 windows (on either side) have... But we don't :-(
23916 However, I think this works ok. ++KFS 2003-04-25 */
23918 /* Redraw borders between horizontally adjacent windows. Don't
23919 do it for frames with vertical scroll bars because either the
23920 right scroll bar of a window, or the left scroll bar of its
23921 neighbor will suffice as a border. */
23922 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
23925 if (!WINDOW_RIGHTMOST_P (w
)
23926 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
23928 int x0
, x1
, y0
, y1
;
23930 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23933 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23936 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
23938 else if (!WINDOW_LEFTMOST_P (w
)
23939 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
23941 int x0
, x1
, y0
, y1
;
23943 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23946 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23949 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
23954 /* Redraw the part of window W intersection rectangle FR. Pixel
23955 coordinates in FR are frame-relative. Call this function with
23956 input blocked. Value is non-zero if the exposure overwrites
23960 expose_window (w
, fr
)
23964 struct frame
*f
= XFRAME (w
->frame
);
23966 int mouse_face_overwritten_p
= 0;
23968 /* If window is not yet fully initialized, do nothing. This can
23969 happen when toolkit scroll bars are used and a window is split.
23970 Reconfiguring the scroll bar will generate an expose for a newly
23972 if (w
->current_matrix
== NULL
)
23975 /* When we're currently updating the window, display and current
23976 matrix usually don't agree. Arrange for a thorough display
23978 if (w
== updated_window
)
23980 SET_FRAME_GARBAGED (f
);
23984 /* Frame-relative pixel rectangle of W. */
23985 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
23986 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
23987 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
23988 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
23990 if (x_intersect_rectangles (fr
, &wr
, &r
))
23992 int yb
= window_text_bottom_y (w
);
23993 struct glyph_row
*row
;
23994 int cursor_cleared_p
;
23995 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
23997 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
23998 r
.x
, r
.y
, r
.width
, r
.height
));
24000 /* Convert to window coordinates. */
24001 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24002 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24004 /* Turn off the cursor. */
24005 if (!w
->pseudo_window_p
24006 && phys_cursor_in_rect_p (w
, &r
))
24008 x_clear_cursor (w
);
24009 cursor_cleared_p
= 1;
24012 cursor_cleared_p
= 0;
24014 /* Update lines intersecting rectangle R. */
24015 first_overlapping_row
= last_overlapping_row
= NULL
;
24016 for (row
= w
->current_matrix
->rows
;
24021 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24023 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24024 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24025 || (r
.y
>= y0
&& r
.y
< y1
)
24026 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24028 /* A header line may be overlapping, but there is no need
24029 to fix overlapping areas for them. KFS 2005-02-12 */
24030 if (row
->overlapping_p
&& !row
->mode_line_p
)
24032 if (first_overlapping_row
== NULL
)
24033 first_overlapping_row
= row
;
24034 last_overlapping_row
= row
;
24038 if (expose_line (w
, row
, &r
))
24039 mouse_face_overwritten_p
= 1;
24042 else if (row
->overlapping_p
)
24044 /* We must redraw a row overlapping the exposed area. */
24046 ? y0
+ row
->phys_height
> r
.y
24047 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24049 if (first_overlapping_row
== NULL
)
24050 first_overlapping_row
= row
;
24051 last_overlapping_row
= row
;
24059 /* Display the mode line if there is one. */
24060 if (WINDOW_WANTS_MODELINE_P (w
)
24061 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24063 && row
->y
< r
.y
+ r
.height
)
24065 if (expose_line (w
, row
, &r
))
24066 mouse_face_overwritten_p
= 1;
24069 if (!w
->pseudo_window_p
)
24071 /* Fix the display of overlapping rows. */
24072 if (first_overlapping_row
)
24073 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24076 /* Draw border between windows. */
24077 x_draw_vertical_border (w
);
24079 /* Turn the cursor on again. */
24080 if (cursor_cleared_p
)
24081 update_window_cursor (w
, 1);
24085 return mouse_face_overwritten_p
;
24090 /* Redraw (parts) of all windows in the window tree rooted at W that
24091 intersect R. R contains frame pixel coordinates. Value is
24092 non-zero if the exposure overwrites mouse-face. */
24095 expose_window_tree (w
, r
)
24099 struct frame
*f
= XFRAME (w
->frame
);
24100 int mouse_face_overwritten_p
= 0;
24102 while (w
&& !FRAME_GARBAGED_P (f
))
24104 if (!NILP (w
->hchild
))
24105 mouse_face_overwritten_p
24106 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24107 else if (!NILP (w
->vchild
))
24108 mouse_face_overwritten_p
24109 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24111 mouse_face_overwritten_p
|= expose_window (w
, r
);
24113 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24116 return mouse_face_overwritten_p
;
24121 Redisplay an exposed area of frame F. X and Y are the upper-left
24122 corner of the exposed rectangle. W and H are width and height of
24123 the exposed area. All are pixel values. W or H zero means redraw
24124 the entire frame. */
24127 expose_frame (f
, x
, y
, w
, h
)
24132 int mouse_face_overwritten_p
= 0;
24134 TRACE ((stderr
, "expose_frame "));
24136 /* No need to redraw if frame will be redrawn soon. */
24137 if (FRAME_GARBAGED_P (f
))
24139 TRACE ((stderr
, " garbaged\n"));
24143 /* If basic faces haven't been realized yet, there is no point in
24144 trying to redraw anything. This can happen when we get an expose
24145 event while Emacs is starting, e.g. by moving another window. */
24146 if (FRAME_FACE_CACHE (f
) == NULL
24147 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24149 TRACE ((stderr
, " no faces\n"));
24153 if (w
== 0 || h
== 0)
24156 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24157 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24167 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24168 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24170 if (WINDOWP (f
->tool_bar_window
))
24171 mouse_face_overwritten_p
24172 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24174 #ifdef HAVE_X_WINDOWS
24176 #ifndef USE_X_TOOLKIT
24177 if (WINDOWP (f
->menu_bar_window
))
24178 mouse_face_overwritten_p
24179 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24180 #endif /* not USE_X_TOOLKIT */
24184 /* Some window managers support a focus-follows-mouse style with
24185 delayed raising of frames. Imagine a partially obscured frame,
24186 and moving the mouse into partially obscured mouse-face on that
24187 frame. The visible part of the mouse-face will be highlighted,
24188 then the WM raises the obscured frame. With at least one WM, KDE
24189 2.1, Emacs is not getting any event for the raising of the frame
24190 (even tried with SubstructureRedirectMask), only Expose events.
24191 These expose events will draw text normally, i.e. not
24192 highlighted. Which means we must redo the highlight here.
24193 Subsume it under ``we love X''. --gerd 2001-08-15 */
24194 /* Included in Windows version because Windows most likely does not
24195 do the right thing if any third party tool offers
24196 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24197 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24199 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24200 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24202 int x
= dpyinfo
->mouse_face_mouse_x
;
24203 int y
= dpyinfo
->mouse_face_mouse_y
;
24204 clear_mouse_face (dpyinfo
);
24205 note_mouse_highlight (f
, x
, y
);
24212 Determine the intersection of two rectangles R1 and R2. Return
24213 the intersection in *RESULT. Value is non-zero if RESULT is not
24217 x_intersect_rectangles (r1
, r2
, result
)
24218 XRectangle
*r1
, *r2
, *result
;
24220 XRectangle
*left
, *right
;
24221 XRectangle
*upper
, *lower
;
24222 int intersection_p
= 0;
24224 /* Rearrange so that R1 is the left-most rectangle. */
24226 left
= r1
, right
= r2
;
24228 left
= r2
, right
= r1
;
24230 /* X0 of the intersection is right.x0, if this is inside R1,
24231 otherwise there is no intersection. */
24232 if (right
->x
<= left
->x
+ left
->width
)
24234 result
->x
= right
->x
;
24236 /* The right end of the intersection is the minimum of the
24237 the right ends of left and right. */
24238 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24241 /* Same game for Y. */
24243 upper
= r1
, lower
= r2
;
24245 upper
= r2
, lower
= r1
;
24247 /* The upper end of the intersection is lower.y0, if this is inside
24248 of upper. Otherwise, there is no intersection. */
24249 if (lower
->y
<= upper
->y
+ upper
->height
)
24251 result
->y
= lower
->y
;
24253 /* The lower end of the intersection is the minimum of the lower
24254 ends of upper and lower. */
24255 result
->height
= (min (lower
->y
+ lower
->height
,
24256 upper
->y
+ upper
->height
)
24258 intersection_p
= 1;
24262 return intersection_p
;
24265 #endif /* HAVE_WINDOW_SYSTEM */
24268 /***********************************************************************
24270 ***********************************************************************/
24275 Vwith_echo_area_save_vector
= Qnil
;
24276 staticpro (&Vwith_echo_area_save_vector
);
24278 Vmessage_stack
= Qnil
;
24279 staticpro (&Vmessage_stack
);
24281 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24282 staticpro (&Qinhibit_redisplay
);
24284 message_dolog_marker1
= Fmake_marker ();
24285 staticpro (&message_dolog_marker1
);
24286 message_dolog_marker2
= Fmake_marker ();
24287 staticpro (&message_dolog_marker2
);
24288 message_dolog_marker3
= Fmake_marker ();
24289 staticpro (&message_dolog_marker3
);
24292 defsubr (&Sdump_frame_glyph_matrix
);
24293 defsubr (&Sdump_glyph_matrix
);
24294 defsubr (&Sdump_glyph_row
);
24295 defsubr (&Sdump_tool_bar_row
);
24296 defsubr (&Strace_redisplay
);
24297 defsubr (&Strace_to_stderr
);
24299 #ifdef HAVE_WINDOW_SYSTEM
24300 defsubr (&Stool_bar_lines_needed
);
24301 defsubr (&Slookup_image_map
);
24303 defsubr (&Sformat_mode_line
);
24304 defsubr (&Sinvisible_p
);
24306 staticpro (&Qmenu_bar_update_hook
);
24307 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24309 staticpro (&Qoverriding_terminal_local_map
);
24310 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24312 staticpro (&Qoverriding_local_map
);
24313 Qoverriding_local_map
= intern ("overriding-local-map");
24315 staticpro (&Qwindow_scroll_functions
);
24316 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24318 staticpro (&Qwindow_text_change_functions
);
24319 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24321 staticpro (&Qredisplay_end_trigger_functions
);
24322 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24324 staticpro (&Qinhibit_point_motion_hooks
);
24325 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24327 QCdata
= intern (":data");
24328 staticpro (&QCdata
);
24329 Qdisplay
= intern ("display");
24330 staticpro (&Qdisplay
);
24331 Qspace_width
= intern ("space-width");
24332 staticpro (&Qspace_width
);
24333 Qraise
= intern ("raise");
24334 staticpro (&Qraise
);
24335 Qslice
= intern ("slice");
24336 staticpro (&Qslice
);
24337 Qspace
= intern ("space");
24338 staticpro (&Qspace
);
24339 Qmargin
= intern ("margin");
24340 staticpro (&Qmargin
);
24341 Qpointer
= intern ("pointer");
24342 staticpro (&Qpointer
);
24343 Qleft_margin
= intern ("left-margin");
24344 staticpro (&Qleft_margin
);
24345 Qright_margin
= intern ("right-margin");
24346 staticpro (&Qright_margin
);
24347 Qcenter
= intern ("center");
24348 staticpro (&Qcenter
);
24349 Qline_height
= intern ("line-height");
24350 staticpro (&Qline_height
);
24351 QCalign_to
= intern (":align-to");
24352 staticpro (&QCalign_to
);
24353 QCrelative_width
= intern (":relative-width");
24354 staticpro (&QCrelative_width
);
24355 QCrelative_height
= intern (":relative-height");
24356 staticpro (&QCrelative_height
);
24357 QCeval
= intern (":eval");
24358 staticpro (&QCeval
);
24359 QCpropertize
= intern (":propertize");
24360 staticpro (&QCpropertize
);
24361 QCfile
= intern (":file");
24362 staticpro (&QCfile
);
24363 Qfontified
= intern ("fontified");
24364 staticpro (&Qfontified
);
24365 Qfontification_functions
= intern ("fontification-functions");
24366 staticpro (&Qfontification_functions
);
24367 Qtrailing_whitespace
= intern ("trailing-whitespace");
24368 staticpro (&Qtrailing_whitespace
);
24369 Qescape_glyph
= intern ("escape-glyph");
24370 staticpro (&Qescape_glyph
);
24371 Qnobreak_space
= intern ("nobreak-space");
24372 staticpro (&Qnobreak_space
);
24373 Qimage
= intern ("image");
24374 staticpro (&Qimage
);
24375 QCmap
= intern (":map");
24376 staticpro (&QCmap
);
24377 QCpointer
= intern (":pointer");
24378 staticpro (&QCpointer
);
24379 Qrect
= intern ("rect");
24380 staticpro (&Qrect
);
24381 Qcircle
= intern ("circle");
24382 staticpro (&Qcircle
);
24383 Qpoly
= intern ("poly");
24384 staticpro (&Qpoly
);
24385 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24386 staticpro (&Qmessage_truncate_lines
);
24387 Qgrow_only
= intern ("grow-only");
24388 staticpro (&Qgrow_only
);
24389 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24390 staticpro (&Qinhibit_menubar_update
);
24391 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24392 staticpro (&Qinhibit_eval_during_redisplay
);
24393 Qposition
= intern ("position");
24394 staticpro (&Qposition
);
24395 Qbuffer_position
= intern ("buffer-position");
24396 staticpro (&Qbuffer_position
);
24397 Qobject
= intern ("object");
24398 staticpro (&Qobject
);
24399 Qbar
= intern ("bar");
24401 Qhbar
= intern ("hbar");
24402 staticpro (&Qhbar
);
24403 Qbox
= intern ("box");
24405 Qhollow
= intern ("hollow");
24406 staticpro (&Qhollow
);
24407 Qhand
= intern ("hand");
24408 staticpro (&Qhand
);
24409 Qarrow
= intern ("arrow");
24410 staticpro (&Qarrow
);
24411 Qtext
= intern ("text");
24412 staticpro (&Qtext
);
24413 Qrisky_local_variable
= intern ("risky-local-variable");
24414 staticpro (&Qrisky_local_variable
);
24415 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24416 staticpro (&Qinhibit_free_realized_faces
);
24418 list_of_error
= Fcons (Fcons (intern ("error"),
24419 Fcons (intern ("void-variable"), Qnil
)),
24421 staticpro (&list_of_error
);
24423 Qlast_arrow_position
= intern ("last-arrow-position");
24424 staticpro (&Qlast_arrow_position
);
24425 Qlast_arrow_string
= intern ("last-arrow-string");
24426 staticpro (&Qlast_arrow_string
);
24428 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24429 staticpro (&Qoverlay_arrow_string
);
24430 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24431 staticpro (&Qoverlay_arrow_bitmap
);
24433 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24434 staticpro (&echo_buffer
[0]);
24435 staticpro (&echo_buffer
[1]);
24437 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24438 staticpro (&echo_area_buffer
[0]);
24439 staticpro (&echo_area_buffer
[1]);
24441 Vmessages_buffer_name
= build_string ("*Messages*");
24442 staticpro (&Vmessages_buffer_name
);
24444 mode_line_proptrans_alist
= Qnil
;
24445 staticpro (&mode_line_proptrans_alist
);
24446 mode_line_string_list
= Qnil
;
24447 staticpro (&mode_line_string_list
);
24448 mode_line_string_face
= Qnil
;
24449 staticpro (&mode_line_string_face
);
24450 mode_line_string_face_prop
= Qnil
;
24451 staticpro (&mode_line_string_face_prop
);
24452 Vmode_line_unwind_vector
= Qnil
;
24453 staticpro (&Vmode_line_unwind_vector
);
24455 help_echo_string
= Qnil
;
24456 staticpro (&help_echo_string
);
24457 help_echo_object
= Qnil
;
24458 staticpro (&help_echo_object
);
24459 help_echo_window
= Qnil
;
24460 staticpro (&help_echo_window
);
24461 previous_help_echo_string
= Qnil
;
24462 staticpro (&previous_help_echo_string
);
24463 help_echo_pos
= -1;
24465 #ifdef HAVE_WINDOW_SYSTEM
24466 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24467 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24468 For example, if a block cursor is over a tab, it will be drawn as
24469 wide as that tab on the display. */);
24470 x_stretch_cursor_p
= 0;
24473 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24474 doc
: /* *Non-nil means highlight trailing whitespace.
24475 The face used for trailing whitespace is `trailing-whitespace'. */);
24476 Vshow_trailing_whitespace
= Qnil
;
24478 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24479 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24480 A value of t means highlight the character itself (for nobreak space,
24481 use face `nobreak-space').
24482 A value of nil means no highlighting.
24483 Other values mean display the escape glyph followed by an ordinary
24484 space or ordinary hyphen. */);
24485 Vnobreak_char_display
= Qt
;
24487 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24488 doc
: /* *The pointer shape to show in void text areas.
24489 A value of nil means to show the text pointer. Other options are `arrow',
24490 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24491 Vvoid_text_area_pointer
= Qarrow
;
24493 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24494 doc
: /* Non-nil means don't actually do any redisplay.
24495 This is used for internal purposes. */);
24496 Vinhibit_redisplay
= Qnil
;
24498 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24499 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24500 Vglobal_mode_string
= Qnil
;
24502 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24503 doc
: /* Marker for where to display an arrow on top of the buffer text.
24504 This must be the beginning of a line in order to work.
24505 See also `overlay-arrow-string'. */);
24506 Voverlay_arrow_position
= Qnil
;
24508 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24509 doc
: /* String to display as an arrow in non-window frames.
24510 See also `overlay-arrow-position'. */);
24511 Voverlay_arrow_string
= build_string ("=>");
24513 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24514 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24515 The symbols on this list are examined during redisplay to determine
24516 where to display overlay arrows. */);
24517 Voverlay_arrow_variable_list
24518 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24520 DEFVAR_INT ("scroll-step", &scroll_step
,
24521 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24522 If that fails to bring point back on frame, point is centered instead.
24523 If this is zero, point is always centered after it moves off frame.
24524 If you want scrolling to always be a line at a time, you should set
24525 `scroll-conservatively' to a large value rather than set this to 1. */);
24527 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24528 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24529 If point moves off-screen, redisplay will scroll by up to
24530 `scroll-conservatively' lines in order to bring point just barely
24531 onto the screen again. If that cannot be done, then redisplay
24532 recenters point as usual.
24534 A value of zero means always recenter point if it moves off screen. */);
24535 scroll_conservatively
= 0;
24537 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24538 doc
: /* *Number of lines of margin at the top and bottom of a window.
24539 Recenter the window whenever point gets within this many lines
24540 of the top or bottom of the window. */);
24543 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24544 doc
: /* Pixels per inch value for non-window system displays.
24545 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24546 Vdisplay_pixels_per_inch
= make_float (72.0);
24549 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24552 DEFVAR_BOOL ("truncate-partial-width-windows",
24553 &truncate_partial_width_windows
,
24554 doc
: /* *Non-nil means truncate lines in all windows less than full frame wide. */);
24555 truncate_partial_width_windows
= 1;
24557 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24558 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24559 Any other value means to use the appropriate face, `mode-line',
24560 `header-line', or `menu' respectively. */);
24561 mode_line_inverse_video
= 1;
24563 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24564 doc
: /* *Maximum buffer size for which line number should be displayed.
24565 If the buffer is bigger than this, the line number does not appear
24566 in the mode line. A value of nil means no limit. */);
24567 Vline_number_display_limit
= Qnil
;
24569 DEFVAR_INT ("line-number-display-limit-width",
24570 &line_number_display_limit_width
,
24571 doc
: /* *Maximum line width (in characters) for line number display.
24572 If the average length of the lines near point is bigger than this, then the
24573 line number may be omitted from the mode line. */);
24574 line_number_display_limit_width
= 200;
24576 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24577 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24578 highlight_nonselected_windows
= 0;
24580 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24581 doc
: /* Non-nil if more than one frame is visible on this display.
24582 Minibuffer-only frames don't count, but iconified frames do.
24583 This variable is not guaranteed to be accurate except while processing
24584 `frame-title-format' and `icon-title-format'. */);
24586 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24587 doc
: /* Template for displaying the title bar of visible frames.
24588 \(Assuming the window manager supports this feature.)
24590 This variable has the same structure as `mode-line-format', except that
24591 the %c and %l constructs are ignored. It is used only on frames for
24592 which no explicit name has been set \(see `modify-frame-parameters'). */);
24594 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24595 doc
: /* Template for displaying the title bar of an iconified frame.
24596 \(Assuming the window manager supports this feature.)
24597 This variable has the same structure as `mode-line-format' (which see),
24598 and is used only on frames for which no explicit name has been set
24599 \(see `modify-frame-parameters'). */);
24601 = Vframe_title_format
24602 = Fcons (intern ("multiple-frames"),
24603 Fcons (build_string ("%b"),
24604 Fcons (Fcons (empty_unibyte_string
,
24605 Fcons (intern ("invocation-name"),
24606 Fcons (build_string ("@"),
24607 Fcons (intern ("system-name"),
24611 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24612 doc
: /* Maximum number of lines to keep in the message log buffer.
24613 If nil, disable message logging. If t, log messages but don't truncate
24614 the buffer when it becomes large. */);
24615 Vmessage_log_max
= make_number (100);
24617 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24618 doc
: /* Functions called before redisplay, if window sizes have changed.
24619 The value should be a list of functions that take one argument.
24620 Just before redisplay, for each frame, if any of its windows have changed
24621 size since the last redisplay, or have been split or deleted,
24622 all the functions in the list are called, with the frame as argument. */);
24623 Vwindow_size_change_functions
= Qnil
;
24625 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24626 doc
: /* List of functions to call before redisplaying a window with scrolling.
24627 Each function is called with two arguments, the window
24628 and its new display-start position. Note that the value of `window-end'
24629 is not valid when these functions are called. */);
24630 Vwindow_scroll_functions
= Qnil
;
24632 DEFVAR_LISP ("window-text-change-functions",
24633 &Vwindow_text_change_functions
,
24634 doc
: /* Functions to call in redisplay when text in the window might change. */);
24635 Vwindow_text_change_functions
= Qnil
;
24637 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
24638 doc
: /* Functions called when redisplay of a window reaches the end trigger.
24639 Each function is called with two arguments, the window and the end trigger value.
24640 See `set-window-redisplay-end-trigger'. */);
24641 Vredisplay_end_trigger_functions
= Qnil
;
24643 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
24644 doc
: /* *Non-nil means autoselect window with mouse pointer.
24645 If nil, do not autoselect windows.
24646 A positive number means delay autoselection by that many seconds: a
24647 window is autoselected only after the mouse has remained in that
24648 window for the duration of the delay.
24649 A negative number has a similar effect, but causes windows to be
24650 autoselected only after the mouse has stopped moving. \(Because of
24651 the way Emacs compares mouse events, you will occasionally wait twice
24652 that time before the window gets selected.\)
24653 Any other value means to autoselect window instantaneously when the
24654 mouse pointer enters it.
24656 Autoselection selects the minibuffer only if it is active, and never
24657 unselects the minibuffer if it is active.
24659 When customizing this variable make sure that the actual value of
24660 `focus-follows-mouse' matches the behavior of your window manager. */);
24661 Vmouse_autoselect_window
= Qnil
;
24663 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
24664 doc
: /* *Non-nil means automatically resize tool-bars.
24665 This dynamically changes the tool-bar's height to the minimum height
24666 that is needed to make all tool-bar items visible.
24667 If value is `grow-only', the tool-bar's height is only increased
24668 automatically; to decrease the tool-bar height, use \\[recenter]. */);
24669 Vauto_resize_tool_bars
= Qt
;
24671 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
24672 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
24673 auto_raise_tool_bar_buttons_p
= 1;
24675 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
24676 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
24677 make_cursor_line_fully_visible_p
= 1;
24679 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
24680 doc
: /* *Border below tool-bar in pixels.
24681 If an integer, use it as the height of the border.
24682 If it is one of `internal-border-width' or `border-width', use the
24683 value of the corresponding frame parameter.
24684 Otherwise, no border is added below the tool-bar. */);
24685 Vtool_bar_border
= Qinternal_border_width
;
24687 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
24688 doc
: /* *Margin around tool-bar buttons in pixels.
24689 If an integer, use that for both horizontal and vertical margins.
24690 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
24691 HORZ specifying the horizontal margin, and VERT specifying the
24692 vertical margin. */);
24693 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
24695 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
24696 doc
: /* *Relief thickness of tool-bar buttons. */);
24697 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
24699 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
24700 doc
: /* List of functions to call to fontify regions of text.
24701 Each function is called with one argument POS. Functions must
24702 fontify a region starting at POS in the current buffer, and give
24703 fontified regions the property `fontified'. */);
24704 Vfontification_functions
= Qnil
;
24705 Fmake_variable_buffer_local (Qfontification_functions
);
24707 DEFVAR_BOOL ("unibyte-display-via-language-environment",
24708 &unibyte_display_via_language_environment
,
24709 doc
: /* *Non-nil means display unibyte text according to language environment.
24710 Specifically this means that unibyte non-ASCII characters
24711 are displayed by converting them to the equivalent multibyte characters
24712 according to the current language environment. As a result, they are
24713 displayed according to the current fontset. */);
24714 unibyte_display_via_language_environment
= 0;
24716 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
24717 doc
: /* *Maximum height for resizing mini-windows.
24718 If a float, it specifies a fraction of the mini-window frame's height.
24719 If an integer, it specifies a number of lines. */);
24720 Vmax_mini_window_height
= make_float (0.25);
24722 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
24723 doc
: /* *How to resize mini-windows.
24724 A value of nil means don't automatically resize mini-windows.
24725 A value of t means resize them to fit the text displayed in them.
24726 A value of `grow-only', the default, means let mini-windows grow
24727 only, until their display becomes empty, at which point the windows
24728 go back to their normal size. */);
24729 Vresize_mini_windows
= Qgrow_only
;
24731 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
24732 doc
: /* Alist specifying how to blink the cursor off.
24733 Each element has the form (ON-STATE . OFF-STATE). Whenever the
24734 `cursor-type' frame-parameter or variable equals ON-STATE,
24735 comparing using `equal', Emacs uses OFF-STATE to specify
24736 how to blink it off. ON-STATE and OFF-STATE are values for
24737 the `cursor-type' frame parameter.
24739 If a frame's ON-STATE has no entry in this list,
24740 the frame's other specifications determine how to blink the cursor off. */);
24741 Vblink_cursor_alist
= Qnil
;
24743 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
24744 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
24745 automatic_hscrolling_p
= 1;
24746 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
24747 staticpro (&Qauto_hscroll_mode
);
24749 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
24750 doc
: /* *How many columns away from the window edge point is allowed to get
24751 before automatic hscrolling will horizontally scroll the window. */);
24752 hscroll_margin
= 5;
24754 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
24755 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
24756 When point is less than `hscroll-margin' columns from the window
24757 edge, automatic hscrolling will scroll the window by the amount of columns
24758 determined by this variable. If its value is a positive integer, scroll that
24759 many columns. If it's a positive floating-point number, it specifies the
24760 fraction of the window's width to scroll. If it's nil or zero, point will be
24761 centered horizontally after the scroll. Any other value, including negative
24762 numbers, are treated as if the value were zero.
24764 Automatic hscrolling always moves point outside the scroll margin, so if
24765 point was more than scroll step columns inside the margin, the window will
24766 scroll more than the value given by the scroll step.
24768 Note that the lower bound for automatic hscrolling specified by `scroll-left'
24769 and `scroll-right' overrides this variable's effect. */);
24770 Vhscroll_step
= make_number (0);
24772 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
24773 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
24774 Bind this around calls to `message' to let it take effect. */);
24775 message_truncate_lines
= 0;
24777 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
24778 doc
: /* Normal hook run to update the menu bar definitions.
24779 Redisplay runs this hook before it redisplays the menu bar.
24780 This is used to update submenus such as Buffers,
24781 whose contents depend on various data. */);
24782 Vmenu_bar_update_hook
= Qnil
;
24784 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
24785 doc
: /* Frame for which we are updating a menu.
24786 The enable predicate for a menu binding should check this variable. */);
24787 Vmenu_updating_frame
= Qnil
;
24789 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
24790 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
24791 inhibit_menubar_update
= 0;
24793 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
24794 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
24795 inhibit_eval_during_redisplay
= 0;
24797 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
24798 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
24799 inhibit_free_realized_faces
= 0;
24802 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
24803 doc
: /* Inhibit try_window_id display optimization. */);
24804 inhibit_try_window_id
= 0;
24806 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
24807 doc
: /* Inhibit try_window_reusing display optimization. */);
24808 inhibit_try_window_reusing
= 0;
24810 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
24811 doc
: /* Inhibit try_cursor_movement display optimization. */);
24812 inhibit_try_cursor_movement
= 0;
24813 #endif /* GLYPH_DEBUG */
24815 DEFVAR_INT ("overline-margin", &overline_margin
,
24816 doc
: /* *Space between overline and text, in pixels.
24817 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
24818 margin to the caracter height. */);
24819 overline_margin
= 2;
24823 /* Initialize this module when Emacs starts. */
24828 Lisp_Object root_window
;
24829 struct window
*mini_w
;
24831 current_header_line_height
= current_mode_line_height
= -1;
24833 CHARPOS (this_line_start_pos
) = 0;
24835 mini_w
= XWINDOW (minibuf_window
);
24836 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
24838 if (!noninteractive
)
24840 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
24843 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
24844 set_window_height (root_window
,
24845 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
24847 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
24848 set_window_height (minibuf_window
, 1, 0);
24850 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
24851 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
24853 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
24854 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
24855 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
24857 /* The default ellipsis glyphs `...'. */
24858 for (i
= 0; i
< 3; ++i
)
24859 default_invis_vector
[i
] = make_number ('.');
24863 /* Allocate the buffer for frame titles.
24864 Also used for `format-mode-line'. */
24866 mode_line_noprop_buf
= (char *) xmalloc (size
);
24867 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
24868 mode_line_noprop_ptr
= mode_line_noprop_buf
;
24869 mode_line_target
= MODE_LINE_DISPLAY
;
24872 help_echo_showing_p
= 0;
24876 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
24877 (do not change this comment) */