1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
27 Emacs separates the task of updating the display from code
28 modifying global state, e.g. buffer text. This way functions
29 operating on buffers don't also have to be concerned with updating
32 Updating the display is triggered by the Lisp interpreter when it
33 decides it's time to do it. This is done either automatically for
34 you as part of the interpreter's command loop or as the result of
35 calling Lisp functions like `sit-for'. The C function `redisplay'
36 in xdisp.c is the only entry into the inner redisplay code. (Or,
37 let's say almost---see the description of direct update
40 The following diagram shows how redisplay code is invoked. As you
41 can see, Lisp calls redisplay and vice versa. Under window systems
42 like X, some portions of the redisplay code are also called
43 asynchronously during mouse movement or expose events. It is very
44 important that these code parts do NOT use the C library (malloc,
45 free) because many C libraries under Unix are not reentrant. They
46 may also NOT call functions of the Lisp interpreter which could
47 change the interpreter's state. If you don't follow these rules,
48 you will encounter bugs which are very hard to explain.
50 (Direct functions, see below)
51 direct_output_for_insert,
52 direct_forward_char (dispnew.c)
53 +---------------------------------+
56 +--------------+ redisplay +----------------+
57 | Lisp machine |---------------->| Redisplay code |<--+
58 +--------------+ (xdisp.c) +----------------+ |
60 +----------------------------------+ |
61 Don't use this path when called |
64 expose_window (asynchronous) |
66 X expose events -----+
68 What does redisplay do? Obviously, it has to figure out somehow what
69 has been changed since the last time the display has been updated,
70 and to make these changes visible. Preferably it would do that in
71 a moderately intelligent way, i.e. fast.
73 Changes in buffer text can be deduced from window and buffer
74 structures, and from some global variables like `beg_unchanged' and
75 `end_unchanged'. The contents of the display are additionally
76 recorded in a `glyph matrix', a two-dimensional matrix of glyph
77 structures. Each row in such a matrix corresponds to a line on the
78 display, and each glyph in a row corresponds to a column displaying
79 a character, an image, or what else. This matrix is called the
80 `current glyph matrix' or `current matrix' in redisplay
83 For buffer parts that have been changed since the last update, a
84 second glyph matrix is constructed, the so called `desired glyph
85 matrix' or short `desired matrix'. Current and desired matrix are
86 then compared to find a cheap way to update the display, e.g. by
87 reusing part of the display by scrolling lines.
92 You will find a lot of redisplay optimizations when you start
93 looking at the innards of redisplay. The overall goal of all these
94 optimizations is to make redisplay fast because it is done
97 Two optimizations are not found in xdisp.c. These are the direct
98 operations mentioned above. As the name suggests they follow a
99 different principle than the rest of redisplay. Instead of
100 building a desired matrix and then comparing it with the current
101 display, they perform their actions directly on the display and on
104 One direct operation updates the display after one character has
105 been entered. The other one moves the cursor by one position
106 forward or backward. You find these functions under the names
107 `direct_output_for_insert' and `direct_output_forward_char' in
113 Desired matrices are always built per Emacs window. The function
114 `display_line' is the central function to look at if you are
115 interested. It constructs one row in a desired matrix given an
116 iterator structure containing both a buffer position and a
117 description of the environment in which the text is to be
118 displayed. But this is too early, read on.
120 Characters and pixmaps displayed for a range of buffer text depend
121 on various settings of buffers and windows, on overlays and text
122 properties, on display tables, on selective display. The good news
123 is that all this hairy stuff is hidden behind a small set of
124 interface functions taking an iterator structure (struct it)
127 Iteration over things to be displayed is then simple. It is
128 started by initializing an iterator with a call to init_iterator.
129 Calls to get_next_display_element fill the iterator structure with
130 relevant information about the next thing to display. Calls to
131 set_iterator_to_next move the iterator to the next thing.
133 Besides this, an iterator also contains information about the
134 display environment in which glyphs for display elements are to be
135 produced. It has fields for the width and height of the display,
136 the information whether long lines are truncated or continued, a
137 current X and Y position, and lots of other stuff you can better
140 Glyphs in a desired matrix are normally constructed in a loop
141 calling get_next_display_element and then produce_glyphs. The call
142 to produce_glyphs will fill the iterator structure with pixel
143 information about the element being displayed and at the same time
144 produce glyphs for it. If the display element fits on the line
145 being displayed, set_iterator_to_next is called next, otherwise the
146 glyphs produced are discarded.
151 That just couldn't be all, could it? What about terminal types not
152 supporting operations on sub-windows of the screen? To update the
153 display on such a terminal, window-based glyph matrices are not
154 well suited. To be able to reuse part of the display (scrolling
155 lines up and down), we must instead have a view of the whole
156 screen. This is what `frame matrices' are for. They are a trick.
158 Frames on terminals like above have a glyph pool. Windows on such
159 a frame sub-allocate their glyph memory from their frame's glyph
160 pool. The frame itself is given its own glyph matrices. By
161 coincidence---or maybe something else---rows in window glyph
162 matrices are slices of corresponding rows in frame matrices. Thus
163 writing to window matrices implicitly updates a frame matrix which
164 provides us with the view of the whole screen that we originally
165 wanted to have without having to move many bytes around. To be
166 honest, there is a little bit more done, but not much more. If you
167 plan to extend that code, take a look at dispnew.c. The function
168 build_frame_matrix is a good starting point. */
174 #include "keyboard.h"
177 #include "termchar.h"
178 #include "dispextern.h"
180 #include "character.h"
183 #include "commands.h"
187 #include "termhooks.h"
188 #include "intervals.h"
191 #include "region-cache.h"
193 #include "blockinput.h"
195 #ifdef HAVE_X_WINDOWS
205 #ifdef HAVE_WINDOW_SYSTEM
206 #ifdef USE_FONT_BACKEND
208 #endif /* USE_FONT_BACKEND */
209 #endif /* HAVE_WINDOW_SYSTEM */
211 #ifndef FRAME_X_OUTPUT
212 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
215 #define INFINITY 10000000
217 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
219 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
220 extern int pending_menu_activation
;
223 extern int interrupt_input
;
224 extern int command_loop_level
;
226 extern Lisp_Object do_mouse_tracking
;
228 extern int minibuffer_auto_raise
;
229 extern Lisp_Object Vminibuffer_list
;
231 extern Lisp_Object Qface
;
232 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
234 extern Lisp_Object Voverriding_local_map
;
235 extern Lisp_Object Voverriding_local_map_menu_flag
;
236 extern Lisp_Object Qmenu_item
;
237 extern Lisp_Object Qwhen
;
238 extern Lisp_Object Qhelp_echo
;
240 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
241 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
242 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
243 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
244 Lisp_Object Qinhibit_point_motion_hooks
;
245 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
246 Lisp_Object Qfontified
;
247 Lisp_Object Qgrow_only
;
248 Lisp_Object Qinhibit_eval_during_redisplay
;
249 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
252 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
255 Lisp_Object Qarrow
, Qhand
, Qtext
;
257 Lisp_Object Qrisky_local_variable
;
259 /* Holds the list (error). */
260 Lisp_Object list_of_error
;
262 /* Functions called to fontify regions of text. */
264 Lisp_Object Vfontification_functions
;
265 Lisp_Object Qfontification_functions
;
267 /* Non-nil means automatically select any window when the mouse
268 cursor moves into it. */
269 Lisp_Object Vmouse_autoselect_window
;
271 /* Non-zero means draw tool bar buttons raised when the mouse moves
274 int auto_raise_tool_bar_buttons_p
;
276 /* Non-zero means to reposition window if cursor line is only partially visible. */
278 int make_cursor_line_fully_visible_p
;
280 /* Margin below tool bar in pixels. 0 or nil means no margin.
281 If value is `internal-border-width' or `border-width',
282 the corresponding frame parameter is used. */
284 Lisp_Object Vtool_bar_border
;
286 /* Margin around tool bar buttons in pixels. */
288 Lisp_Object Vtool_bar_button_margin
;
290 /* Thickness of shadow to draw around tool bar buttons. */
292 EMACS_INT tool_bar_button_relief
;
294 /* Non-nil means automatically resize tool-bars so that all tool-bar
295 items are visible, and no blank lines remain.
297 If value is `grow-only', only make tool-bar bigger. */
299 Lisp_Object Vauto_resize_tool_bars
;
301 /* Non-zero means draw block and hollow cursor as wide as the glyph
302 under it. For example, if a block cursor is over a tab, it will be
303 drawn as wide as that tab on the display. */
305 int x_stretch_cursor_p
;
307 /* Non-nil means don't actually do any redisplay. */
309 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
311 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
313 int inhibit_eval_during_redisplay
;
315 /* Names of text properties relevant for redisplay. */
317 Lisp_Object Qdisplay
;
318 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
320 /* Symbols used in text property values. */
322 Lisp_Object Vdisplay_pixels_per_inch
;
323 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
324 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
327 Lisp_Object Qmargin
, Qpointer
;
328 Lisp_Object Qline_height
;
329 extern Lisp_Object Qheight
;
330 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
331 extern Lisp_Object Qscroll_bar
;
332 extern Lisp_Object Qcursor
;
334 /* Non-nil means highlight trailing whitespace. */
336 Lisp_Object Vshow_trailing_whitespace
;
338 /* Non-nil means escape non-break space and hyphens. */
340 Lisp_Object Vnobreak_char_display
;
342 #ifdef HAVE_WINDOW_SYSTEM
343 extern Lisp_Object Voverflow_newline_into_fringe
;
345 /* Test if overflow newline into fringe. Called with iterator IT
346 at or past right window margin, and with IT->current_x set. */
348 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
349 (!NILP (Voverflow_newline_into_fringe) \
350 && FRAME_WINDOW_P (it->f) \
351 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
352 && it->current_x == it->last_visible_x)
354 #endif /* HAVE_WINDOW_SYSTEM */
356 /* Non-nil means show the text cursor in void text areas
357 i.e. in blank areas after eol and eob. This used to be
358 the default in 21.3. */
360 Lisp_Object Vvoid_text_area_pointer
;
362 /* Name of the face used to highlight trailing whitespace. */
364 Lisp_Object Qtrailing_whitespace
;
366 /* Name and number of the face used to highlight escape glyphs. */
368 Lisp_Object Qescape_glyph
;
370 /* Name and number of the face used to highlight non-breaking spaces. */
372 Lisp_Object Qnobreak_space
;
374 /* The symbol `image' which is the car of the lists used to represent
379 /* The image map types. */
380 Lisp_Object QCmap
, QCpointer
;
381 Lisp_Object Qrect
, Qcircle
, Qpoly
;
383 /* Non-zero means print newline to stdout before next mini-buffer
386 int noninteractive_need_newline
;
388 /* Non-zero means print newline to message log before next message. */
390 static int message_log_need_newline
;
392 /* Three markers that message_dolog uses.
393 It could allocate them itself, but that causes trouble
394 in handling memory-full errors. */
395 static Lisp_Object message_dolog_marker1
;
396 static Lisp_Object message_dolog_marker2
;
397 static Lisp_Object message_dolog_marker3
;
399 /* The buffer position of the first character appearing entirely or
400 partially on the line of the selected window which contains the
401 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
402 redisplay optimization in redisplay_internal. */
404 static struct text_pos this_line_start_pos
;
406 /* Number of characters past the end of the line above, including the
407 terminating newline. */
409 static struct text_pos this_line_end_pos
;
411 /* The vertical positions and the height of this line. */
413 static int this_line_vpos
;
414 static int this_line_y
;
415 static int this_line_pixel_height
;
417 /* X position at which this display line starts. Usually zero;
418 negative if first character is partially visible. */
420 static int this_line_start_x
;
422 /* Buffer that this_line_.* variables are referring to. */
424 static struct buffer
*this_line_buffer
;
426 /* Nonzero means truncate lines in all windows less wide than the
429 int truncate_partial_width_windows
;
431 /* A flag to control how to display unibyte 8-bit character. */
433 int unibyte_display_via_language_environment
;
435 /* Nonzero means we have more than one non-mini-buffer-only frame.
436 Not guaranteed to be accurate except while parsing
437 frame-title-format. */
441 Lisp_Object Vglobal_mode_string
;
444 /* List of variables (symbols) which hold markers for overlay arrows.
445 The symbols on this list are examined during redisplay to determine
446 where to display overlay arrows. */
448 Lisp_Object Voverlay_arrow_variable_list
;
450 /* Marker for where to display an arrow on top of the buffer text. */
452 Lisp_Object Voverlay_arrow_position
;
454 /* String to display for the arrow. Only used on terminal frames. */
456 Lisp_Object Voverlay_arrow_string
;
458 /* Values of those variables at last redisplay are stored as
459 properties on `overlay-arrow-position' symbol. However, if
460 Voverlay_arrow_position is a marker, last-arrow-position is its
461 numerical position. */
463 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
465 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
466 properties on a symbol in overlay-arrow-variable-list. */
468 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
470 /* Like mode-line-format, but for the title bar on a visible frame. */
472 Lisp_Object Vframe_title_format
;
474 /* Like mode-line-format, but for the title bar on an iconified frame. */
476 Lisp_Object Vicon_title_format
;
478 /* List of functions to call when a window's size changes. These
479 functions get one arg, a frame on which one or more windows' sizes
482 static Lisp_Object Vwindow_size_change_functions
;
484 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
486 /* Nonzero if an overlay arrow has been displayed in this window. */
488 static int overlay_arrow_seen
;
490 /* Nonzero means highlight the region even in nonselected windows. */
492 int highlight_nonselected_windows
;
494 /* If cursor motion alone moves point off frame, try scrolling this
495 many lines up or down if that will bring it back. */
497 static EMACS_INT scroll_step
;
499 /* Nonzero means scroll just far enough to bring point back on the
500 screen, when appropriate. */
502 static EMACS_INT scroll_conservatively
;
504 /* Recenter the window whenever point gets within this many lines of
505 the top or bottom of the window. This value is translated into a
506 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
507 that there is really a fixed pixel height scroll margin. */
509 EMACS_INT scroll_margin
;
511 /* Number of windows showing the buffer of the selected window (or
512 another buffer with the same base buffer). keyboard.c refers to
517 /* Vector containing glyphs for an ellipsis `...'. */
519 static Lisp_Object default_invis_vector
[3];
521 /* Zero means display the mode-line/header-line/menu-bar in the default face
522 (this slightly odd definition is for compatibility with previous versions
523 of emacs), non-zero means display them using their respective faces.
525 This variable is deprecated. */
527 int mode_line_inverse_video
;
529 /* Prompt to display in front of the mini-buffer contents. */
531 Lisp_Object minibuf_prompt
;
533 /* Width of current mini-buffer prompt. Only set after display_line
534 of the line that contains the prompt. */
536 int minibuf_prompt_width
;
538 /* This is the window where the echo area message was displayed. It
539 is always a mini-buffer window, but it may not be the same window
540 currently active as a mini-buffer. */
542 Lisp_Object echo_area_window
;
544 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
545 pushes the current message and the value of
546 message_enable_multibyte on the stack, the function restore_message
547 pops the stack and displays MESSAGE again. */
549 Lisp_Object Vmessage_stack
;
551 /* Nonzero means multibyte characters were enabled when the echo area
552 message was specified. */
554 int message_enable_multibyte
;
556 /* Nonzero if we should redraw the mode lines on the next redisplay. */
558 int update_mode_lines
;
560 /* Nonzero if window sizes or contents have changed since last
561 redisplay that finished. */
563 int windows_or_buffers_changed
;
565 /* Nonzero means a frame's cursor type has been changed. */
567 int cursor_type_changed
;
569 /* Nonzero after display_mode_line if %l was used and it displayed a
572 int line_number_displayed
;
574 /* Maximum buffer size for which to display line numbers. */
576 Lisp_Object Vline_number_display_limit
;
578 /* Line width to consider when repositioning for line number display. */
580 static EMACS_INT line_number_display_limit_width
;
582 /* Number of lines to keep in the message log buffer. t means
583 infinite. nil means don't log at all. */
585 Lisp_Object Vmessage_log_max
;
587 /* The name of the *Messages* buffer, a string. */
589 static Lisp_Object Vmessages_buffer_name
;
591 /* Current, index 0, and last displayed echo area message. Either
592 buffers from echo_buffers, or nil to indicate no message. */
594 Lisp_Object echo_area_buffer
[2];
596 /* The buffers referenced from echo_area_buffer. */
598 static Lisp_Object echo_buffer
[2];
600 /* A vector saved used in with_area_buffer to reduce consing. */
602 static Lisp_Object Vwith_echo_area_save_vector
;
604 /* Non-zero means display_echo_area should display the last echo area
605 message again. Set by redisplay_preserve_echo_area. */
607 static int display_last_displayed_message_p
;
609 /* Nonzero if echo area is being used by print; zero if being used by
612 int message_buf_print
;
614 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
616 Lisp_Object Qinhibit_menubar_update
;
617 int inhibit_menubar_update
;
619 /* When evaluating expressions from menu bar items (enable conditions,
620 for instance), this is the frame they are being processed for. */
622 Lisp_Object Vmenu_updating_frame
;
624 /* Maximum height for resizing mini-windows. Either a float
625 specifying a fraction of the available height, or an integer
626 specifying a number of lines. */
628 Lisp_Object Vmax_mini_window_height
;
630 /* Non-zero means messages should be displayed with truncated
631 lines instead of being continued. */
633 int message_truncate_lines
;
634 Lisp_Object Qmessage_truncate_lines
;
636 /* Set to 1 in clear_message to make redisplay_internal aware
637 of an emptied echo area. */
639 static int message_cleared_p
;
641 /* How to blink the default frame cursor off. */
642 Lisp_Object Vblink_cursor_alist
;
644 /* A scratch glyph row with contents used for generating truncation
645 glyphs. Also used in direct_output_for_insert. */
647 #define MAX_SCRATCH_GLYPHS 100
648 struct glyph_row scratch_glyph_row
;
649 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
651 /* Ascent and height of the last line processed by move_it_to. */
653 static int last_max_ascent
, last_height
;
655 /* Non-zero if there's a help-echo in the echo area. */
657 int help_echo_showing_p
;
659 /* If >= 0, computed, exact values of mode-line and header-line height
660 to use in the macros CURRENT_MODE_LINE_HEIGHT and
661 CURRENT_HEADER_LINE_HEIGHT. */
663 int current_mode_line_height
, current_header_line_height
;
665 /* The maximum distance to look ahead for text properties. Values
666 that are too small let us call compute_char_face and similar
667 functions too often which is expensive. Values that are too large
668 let us call compute_char_face and alike too often because we
669 might not be interested in text properties that far away. */
671 #define TEXT_PROP_DISTANCE_LIMIT 100
675 /* Variables to turn off display optimizations from Lisp. */
677 int inhibit_try_window_id
, inhibit_try_window_reusing
;
678 int inhibit_try_cursor_movement
;
680 /* Non-zero means print traces of redisplay if compiled with
683 int trace_redisplay_p
;
685 #endif /* GLYPH_DEBUG */
687 #ifdef DEBUG_TRACE_MOVE
688 /* Non-zero means trace with TRACE_MOVE to stderr. */
691 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
693 #define TRACE_MOVE(x) (void) 0
696 /* Non-zero means automatically scroll windows horizontally to make
699 int automatic_hscrolling_p
;
700 Lisp_Object Qauto_hscroll_mode
;
702 /* How close to the margin can point get before the window is scrolled
704 EMACS_INT hscroll_margin
;
706 /* How much to scroll horizontally when point is inside the above margin. */
707 Lisp_Object Vhscroll_step
;
709 /* The variable `resize-mini-windows'. If nil, don't resize
710 mini-windows. If t, always resize them to fit the text they
711 display. If `grow-only', let mini-windows grow only until they
714 Lisp_Object Vresize_mini_windows
;
716 /* Buffer being redisplayed -- for redisplay_window_error. */
718 struct buffer
*displayed_buffer
;
720 /* Space between overline and text. */
722 EMACS_INT overline_margin
;
724 /* Value returned from text property handlers (see below). */
729 HANDLED_RECOMPUTE_PROPS
,
730 HANDLED_OVERLAY_STRING_CONSUMED
,
734 /* A description of text properties that redisplay is interested
739 /* The name of the property. */
742 /* A unique index for the property. */
745 /* A handler function called to set up iterator IT from the property
746 at IT's current position. Value is used to steer handle_stop. */
747 enum prop_handled (*handler
) P_ ((struct it
*it
));
750 static enum prop_handled handle_face_prop
P_ ((struct it
*));
751 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
752 static enum prop_handled handle_display_prop
P_ ((struct it
*));
753 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
754 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
755 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
756 static enum prop_handled handle_auto_composed_prop
P_ ((struct it
*));
758 /* Properties handled by iterators. */
760 static struct props it_props
[] =
762 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
763 /* Handle `face' before `display' because some sub-properties of
764 `display' need to know the face. */
765 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
766 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
767 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
768 {&Qauto_composed
, AUTO_COMPOSED_PROP_IDX
, handle_auto_composed_prop
},
769 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
773 /* Value is the position described by X. If X is a marker, value is
774 the marker_position of X. Otherwise, value is X. */
776 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
778 /* Enumeration returned by some move_it_.* functions internally. */
782 /* Not used. Undefined value. */
785 /* Move ended at the requested buffer position or ZV. */
786 MOVE_POS_MATCH_OR_ZV
,
788 /* Move ended at the requested X pixel position. */
791 /* Move within a line ended at the end of a line that must be
795 /* Move within a line ended at the end of a line that would
796 be displayed truncated. */
799 /* Move within a line ended at a line end. */
803 /* This counter is used to clear the face cache every once in a while
804 in redisplay_internal. It is incremented for each redisplay.
805 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
808 #define CLEAR_FACE_CACHE_COUNT 500
809 static int clear_face_cache_count
;
811 /* Similarly for the image cache. */
813 #ifdef HAVE_WINDOW_SYSTEM
814 #define CLEAR_IMAGE_CACHE_COUNT 101
815 static int clear_image_cache_count
;
818 /* Non-zero while redisplay_internal is in progress. */
822 /* Non-zero means don't free realized faces. Bound while freeing
823 realized faces is dangerous because glyph matrices might still
826 int inhibit_free_realized_faces
;
827 Lisp_Object Qinhibit_free_realized_faces
;
829 /* If a string, XTread_socket generates an event to display that string.
830 (The display is done in read_char.) */
832 Lisp_Object help_echo_string
;
833 Lisp_Object help_echo_window
;
834 Lisp_Object help_echo_object
;
837 /* Temporary variable for XTread_socket. */
839 Lisp_Object previous_help_echo_string
;
841 /* Null glyph slice */
843 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
846 /* Function prototypes. */
848 static void setup_for_ellipsis
P_ ((struct it
*, int));
849 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
850 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
851 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
852 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
853 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
854 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
857 static int invisible_text_between_p
P_ ((struct it
*, int, int));
860 static void pint2str
P_ ((char *, int, int));
861 static void pint2hrstr
P_ ((char *, int, int));
862 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
864 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
865 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
866 static void store_mode_line_noprop_char
P_ ((char));
867 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
868 static void x_consider_frame_title
P_ ((Lisp_Object
));
869 static void handle_stop
P_ ((struct it
*));
870 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
871 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
872 static void ensure_echo_area_buffers
P_ ((void));
873 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
874 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
875 static int with_echo_area_buffer
P_ ((struct window
*, int,
876 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
877 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
878 static void clear_garbaged_frames
P_ ((void));
879 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
880 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
881 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
882 static int display_echo_area
P_ ((struct window
*));
883 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
884 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
885 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
886 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
887 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
889 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
890 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
891 static void insert_left_trunc_glyphs
P_ ((struct it
*));
892 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
894 static void extend_face_to_end_of_line
P_ ((struct it
*));
895 static int append_space_for_newline
P_ ((struct it
*, int));
896 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
897 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
898 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
899 static int trailing_whitespace_p
P_ ((int));
900 static int message_log_check_duplicate
P_ ((int, int, int, int));
901 static void push_it
P_ ((struct it
*));
902 static void pop_it
P_ ((struct it
*));
903 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
904 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
905 static void redisplay_internal
P_ ((int));
906 static int echo_area_display
P_ ((int));
907 static void redisplay_windows
P_ ((Lisp_Object
));
908 static void redisplay_window
P_ ((Lisp_Object
, int));
909 static Lisp_Object
redisplay_window_error ();
910 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
911 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
912 static int update_menu_bar
P_ ((struct frame
*, int, int));
913 static int try_window_reusing_current_matrix
P_ ((struct window
*));
914 static int try_window_id
P_ ((struct window
*));
915 static int display_line
P_ ((struct it
*));
916 static int display_mode_lines
P_ ((struct window
*));
917 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
918 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
919 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
920 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
921 static void display_menu_bar
P_ ((struct window
*));
922 static int display_count_lines
P_ ((int, int, int, int, int *));
923 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
924 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
925 static void compute_line_metrics
P_ ((struct it
*));
926 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
927 static int get_overlay_strings
P_ ((struct it
*, int));
928 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
929 static void next_overlay_string
P_ ((struct it
*));
930 static void reseat
P_ ((struct it
*, struct text_pos
, int));
931 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
932 static void back_to_previous_visible_line_start
P_ ((struct it
*));
933 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
934 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
935 static int next_element_from_ellipsis
P_ ((struct it
*));
936 static int next_element_from_display_vector
P_ ((struct it
*));
937 static int next_element_from_string
P_ ((struct it
*));
938 static int next_element_from_c_string
P_ ((struct it
*));
939 static int next_element_from_buffer
P_ ((struct it
*));
940 static int next_element_from_composition
P_ ((struct it
*));
941 static int next_element_from_image
P_ ((struct it
*));
942 static int next_element_from_stretch
P_ ((struct it
*));
943 static void load_overlay_strings
P_ ((struct it
*, int));
944 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
945 struct display_pos
*));
946 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
947 Lisp_Object
, int, int, int, int));
948 static enum move_it_result move_it_in_display_line_to
P_ ((struct it
*,
950 void move_it_vertically_backward
P_ ((struct it
*, int));
951 static void init_to_row_start
P_ ((struct it
*, struct window
*,
952 struct glyph_row
*));
953 static int init_to_row_end
P_ ((struct it
*, struct window
*,
954 struct glyph_row
*));
955 static void back_to_previous_line_start
P_ ((struct it
*));
956 static int forward_to_next_line_start
P_ ((struct it
*, int *));
957 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
959 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
960 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
961 static int number_of_chars
P_ ((unsigned char *, int));
962 static void compute_stop_pos
P_ ((struct it
*));
963 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
965 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
966 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
967 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
968 Lisp_Object
, Lisp_Object
,
969 struct text_pos
*, int));
970 static int underlying_face_id
P_ ((struct it
*));
971 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
974 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
975 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
977 #ifdef HAVE_WINDOW_SYSTEM
979 static void update_tool_bar
P_ ((struct frame
*, int));
980 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
981 static int redisplay_tool_bar
P_ ((struct frame
*));
982 static void display_tool_bar_line
P_ ((struct it
*, int));
983 static void notice_overwritten_cursor
P_ ((struct window
*,
985 int, int, int, int));
989 #endif /* HAVE_WINDOW_SYSTEM */
992 /***********************************************************************
993 Window display dimensions
994 ***********************************************************************/
996 /* Return the bottom boundary y-position for text lines in window W.
997 This is the first y position at which a line cannot start.
998 It is relative to the top of the window.
1000 This is the height of W minus the height of a mode line, if any. */
1003 window_text_bottom_y (w
)
1006 int height
= WINDOW_TOTAL_HEIGHT (w
);
1008 if (WINDOW_WANTS_MODELINE_P (w
))
1009 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1013 /* Return the pixel width of display area AREA of window W. AREA < 0
1014 means return the total width of W, not including fringes to
1015 the left and right of the window. */
1018 window_box_width (w
, area
)
1022 int cols
= XFASTINT (w
->total_cols
);
1025 if (!w
->pseudo_window_p
)
1027 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1029 if (area
== TEXT_AREA
)
1031 if (INTEGERP (w
->left_margin_cols
))
1032 cols
-= XFASTINT (w
->left_margin_cols
);
1033 if (INTEGERP (w
->right_margin_cols
))
1034 cols
-= XFASTINT (w
->right_margin_cols
);
1035 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1037 else if (area
== LEFT_MARGIN_AREA
)
1039 cols
= (INTEGERP (w
->left_margin_cols
)
1040 ? XFASTINT (w
->left_margin_cols
) : 0);
1043 else if (area
== RIGHT_MARGIN_AREA
)
1045 cols
= (INTEGERP (w
->right_margin_cols
)
1046 ? XFASTINT (w
->right_margin_cols
) : 0);
1051 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1055 /* Return the pixel height of the display area of window W, not
1056 including mode lines of W, if any. */
1059 window_box_height (w
)
1062 struct frame
*f
= XFRAME (w
->frame
);
1063 int height
= WINDOW_TOTAL_HEIGHT (w
);
1065 xassert (height
>= 0);
1067 /* Note: the code below that determines the mode-line/header-line
1068 height is essentially the same as that contained in the macro
1069 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1070 the appropriate glyph row has its `mode_line_p' flag set,
1071 and if it doesn't, uses estimate_mode_line_height instead. */
1073 if (WINDOW_WANTS_MODELINE_P (w
))
1075 struct glyph_row
*ml_row
1076 = (w
->current_matrix
&& w
->current_matrix
->rows
1077 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1079 if (ml_row
&& ml_row
->mode_line_p
)
1080 height
-= ml_row
->height
;
1082 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1085 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1087 struct glyph_row
*hl_row
1088 = (w
->current_matrix
&& w
->current_matrix
->rows
1089 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1091 if (hl_row
&& hl_row
->mode_line_p
)
1092 height
-= hl_row
->height
;
1094 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1097 /* With a very small font and a mode-line that's taller than
1098 default, we might end up with a negative height. */
1099 return max (0, height
);
1102 /* Return the window-relative coordinate of the left edge of display
1103 area AREA of window W. AREA < 0 means return the left edge of the
1104 whole window, to the right of the left fringe of W. */
1107 window_box_left_offset (w
, area
)
1113 if (w
->pseudo_window_p
)
1116 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1118 if (area
== TEXT_AREA
)
1119 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1120 + window_box_width (w
, LEFT_MARGIN_AREA
));
1121 else if (area
== RIGHT_MARGIN_AREA
)
1122 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1123 + window_box_width (w
, LEFT_MARGIN_AREA
)
1124 + window_box_width (w
, TEXT_AREA
)
1125 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1127 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1128 else if (area
== LEFT_MARGIN_AREA
1129 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1130 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1136 /* Return the window-relative coordinate of the right edge of display
1137 area AREA of window W. AREA < 0 means return the left edge of the
1138 whole window, to the left of the right fringe of W. */
1141 window_box_right_offset (w
, area
)
1145 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1148 /* Return the frame-relative coordinate of the left edge of display
1149 area AREA of window W. AREA < 0 means return the left edge of the
1150 whole window, to the right of the left fringe of W. */
1153 window_box_left (w
, area
)
1157 struct frame
*f
= XFRAME (w
->frame
);
1160 if (w
->pseudo_window_p
)
1161 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1163 x
= (WINDOW_LEFT_EDGE_X (w
)
1164 + window_box_left_offset (w
, area
));
1170 /* Return the frame-relative coordinate of the right edge of display
1171 area AREA of window W. AREA < 0 means return the left edge of the
1172 whole window, to the left of the right fringe of W. */
1175 window_box_right (w
, area
)
1179 return window_box_left (w
, area
) + window_box_width (w
, area
);
1182 /* Get the bounding box of the display area AREA of window W, without
1183 mode lines, in frame-relative coordinates. AREA < 0 means the
1184 whole window, not including the left and right fringes of
1185 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1186 coordinates of the upper-left corner of the box. Return in
1187 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1190 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1193 int *box_x
, *box_y
, *box_width
, *box_height
;
1196 *box_width
= window_box_width (w
, area
);
1198 *box_height
= window_box_height (w
);
1200 *box_x
= window_box_left (w
, area
);
1203 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1204 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1205 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1210 /* Get the bounding box of the display area AREA of window W, without
1211 mode lines. AREA < 0 means the whole window, not including the
1212 left and right fringe of the window. Return in *TOP_LEFT_X
1213 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1214 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1215 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1219 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1220 bottom_right_x
, bottom_right_y
)
1223 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1225 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1227 *bottom_right_x
+= *top_left_x
;
1228 *bottom_right_y
+= *top_left_y
;
1233 /***********************************************************************
1235 ***********************************************************************/
1237 /* Return the bottom y-position of the line the iterator IT is in.
1238 This can modify IT's settings. */
1244 int line_height
= it
->max_ascent
+ it
->max_descent
;
1245 int line_top_y
= it
->current_y
;
1247 if (line_height
== 0)
1250 line_height
= last_height
;
1251 else if (IT_CHARPOS (*it
) < ZV
)
1253 move_it_by_lines (it
, 1, 1);
1254 line_height
= (it
->max_ascent
|| it
->max_descent
1255 ? it
->max_ascent
+ it
->max_descent
1260 struct glyph_row
*row
= it
->glyph_row
;
1262 /* Use the default character height. */
1263 it
->glyph_row
= NULL
;
1264 it
->what
= IT_CHARACTER
;
1267 PRODUCE_GLYPHS (it
);
1268 line_height
= it
->ascent
+ it
->descent
;
1269 it
->glyph_row
= row
;
1273 return line_top_y
+ line_height
;
1277 /* Return 1 if position CHARPOS is visible in window W.
1278 CHARPOS < 0 means return info about WINDOW_END position.
1279 If visible, set *X and *Y to pixel coordinates of top left corner.
1280 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1281 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1284 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1286 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1289 struct text_pos top
;
1291 struct buffer
*old_buffer
= NULL
;
1296 if (XBUFFER (w
->buffer
) != current_buffer
)
1298 old_buffer
= current_buffer
;
1299 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1302 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1304 /* Compute exact mode line heights. */
1305 if (WINDOW_WANTS_MODELINE_P (w
))
1306 current_mode_line_height
1307 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1308 current_buffer
->mode_line_format
);
1310 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1311 current_header_line_height
1312 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1313 current_buffer
->header_line_format
);
1315 start_display (&it
, w
, top
);
1316 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1317 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1319 /* Note that we may overshoot because of invisible text. */
1320 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1322 int top_x
= it
.current_x
;
1323 int top_y
= it
.current_y
;
1324 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1325 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1327 if (top_y
< window_top_y
)
1328 visible_p
= bottom_y
> window_top_y
;
1329 else if (top_y
< it
.last_visible_y
)
1333 Lisp_Object window
, prop
;
1335 XSETWINDOW (window
, w
);
1336 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1337 Qinvisible
, window
);
1339 /* If charpos coincides with invisible text covered with an
1340 ellipsis, use the first glyph of the ellipsis to compute
1341 the pixel positions. */
1342 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1344 struct glyph_row
*row
= it
.glyph_row
;
1345 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1346 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1349 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1350 x
+= glyph
->pixel_width
;
1356 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1357 *rtop
= max (0, window_top_y
- top_y
);
1358 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1359 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1360 - max (top_y
, window_top_y
)));
1369 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1370 move_it_by_lines (&it
, 1, 0);
1371 if (charpos
< IT_CHARPOS (it
)
1372 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1375 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1377 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1378 *rtop
= max (0, -it2
.current_y
);
1379 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1380 - it
.last_visible_y
));
1381 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1383 - max (it2
.current_y
,
1384 WINDOW_HEADER_LINE_HEIGHT (w
))));
1390 set_buffer_internal_1 (old_buffer
);
1392 current_header_line_height
= current_mode_line_height
= -1;
1394 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1395 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1398 /* Debugging code. */
1400 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1401 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1403 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1410 /* Return the next character from STR which is MAXLEN bytes long.
1411 Return in *LEN the length of the character. This is like
1412 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1413 we find one, we return a `?', but with the length of the invalid
1417 string_char_and_length (str
, maxlen
, len
)
1418 const unsigned char *str
;
1423 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1424 if (!CHAR_VALID_P (c
, 1))
1425 /* We may not change the length here because other places in Emacs
1426 don't use this function, i.e. they silently accept invalid
1435 /* Given a position POS containing a valid character and byte position
1436 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1438 static struct text_pos
1439 string_pos_nchars_ahead (pos
, string
, nchars
)
1440 struct text_pos pos
;
1444 xassert (STRINGP (string
) && nchars
>= 0);
1446 if (STRING_MULTIBYTE (string
))
1448 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1449 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1454 string_char_and_length (p
, rest
, &len
);
1455 p
+= len
, rest
-= len
;
1456 xassert (rest
>= 0);
1458 BYTEPOS (pos
) += len
;
1462 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1468 /* Value is the text position, i.e. character and byte position,
1469 for character position CHARPOS in STRING. */
1471 static INLINE
struct text_pos
1472 string_pos (charpos
, string
)
1476 struct text_pos pos
;
1477 xassert (STRINGP (string
));
1478 xassert (charpos
>= 0);
1479 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1484 /* Value is a text position, i.e. character and byte position, for
1485 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1486 means recognize multibyte characters. */
1488 static struct text_pos
1489 c_string_pos (charpos
, s
, multibyte_p
)
1494 struct text_pos pos
;
1496 xassert (s
!= NULL
);
1497 xassert (charpos
>= 0);
1501 int rest
= strlen (s
), len
;
1503 SET_TEXT_POS (pos
, 0, 0);
1506 string_char_and_length (s
, rest
, &len
);
1507 s
+= len
, rest
-= len
;
1508 xassert (rest
>= 0);
1510 BYTEPOS (pos
) += len
;
1514 SET_TEXT_POS (pos
, charpos
, charpos
);
1520 /* Value is the number of characters in C string S. MULTIBYTE_P
1521 non-zero means recognize multibyte characters. */
1524 number_of_chars (s
, multibyte_p
)
1532 int rest
= strlen (s
), len
;
1533 unsigned char *p
= (unsigned char *) s
;
1535 for (nchars
= 0; rest
> 0; ++nchars
)
1537 string_char_and_length (p
, rest
, &len
);
1538 rest
-= len
, p
+= len
;
1542 nchars
= strlen (s
);
1548 /* Compute byte position NEWPOS->bytepos corresponding to
1549 NEWPOS->charpos. POS is a known position in string STRING.
1550 NEWPOS->charpos must be >= POS.charpos. */
1553 compute_string_pos (newpos
, pos
, string
)
1554 struct text_pos
*newpos
, pos
;
1557 xassert (STRINGP (string
));
1558 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1560 if (STRING_MULTIBYTE (string
))
1561 *newpos
= string_pos_nchars_ahead (pos
, string
,
1562 CHARPOS (*newpos
) - CHARPOS (pos
));
1564 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1568 Return an estimation of the pixel height of mode or top lines on
1569 frame F. FACE_ID specifies what line's height to estimate. */
1572 estimate_mode_line_height (f
, face_id
)
1574 enum face_id face_id
;
1576 #ifdef HAVE_WINDOW_SYSTEM
1577 if (FRAME_WINDOW_P (f
))
1579 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1581 /* This function is called so early when Emacs starts that the face
1582 cache and mode line face are not yet initialized. */
1583 if (FRAME_FACE_CACHE (f
))
1585 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1589 height
= FONT_HEIGHT (face
->font
);
1590 if (face
->box_line_width
> 0)
1591 height
+= 2 * face
->box_line_width
;
1602 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1603 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1604 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1605 not force the value into range. */
1608 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1610 register int pix_x
, pix_y
;
1612 NativeRectangle
*bounds
;
1616 #ifdef HAVE_WINDOW_SYSTEM
1617 if (FRAME_WINDOW_P (f
))
1619 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1620 even for negative values. */
1622 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1624 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1626 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1627 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1630 STORE_NATIVE_RECT (*bounds
,
1631 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1632 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1633 FRAME_COLUMN_WIDTH (f
) - 1,
1634 FRAME_LINE_HEIGHT (f
) - 1);
1640 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1641 pix_x
= FRAME_TOTAL_COLS (f
);
1645 else if (pix_y
> FRAME_LINES (f
))
1646 pix_y
= FRAME_LINES (f
);
1656 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1657 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1658 can't tell the positions because W's display is not up to date,
1662 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1665 int *frame_x
, *frame_y
;
1667 #ifdef HAVE_WINDOW_SYSTEM
1668 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1672 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1673 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1675 if (display_completed
)
1677 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1678 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1679 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1685 hpos
+= glyph
->pixel_width
;
1689 /* If first glyph is partially visible, its first visible position is still 0. */
1701 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1702 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1713 #ifdef HAVE_WINDOW_SYSTEM
1715 /* Find the glyph under window-relative coordinates X/Y in window W.
1716 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1717 strings. Return in *HPOS and *VPOS the row and column number of
1718 the glyph found. Return in *AREA the glyph area containing X.
1719 Value is a pointer to the glyph found or null if X/Y is not on
1720 text, or we can't tell because W's current matrix is not up to
1723 static struct glyph
*
1724 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1727 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1729 struct glyph
*glyph
, *end
;
1730 struct glyph_row
*row
= NULL
;
1733 /* Find row containing Y. Give up if some row is not enabled. */
1734 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1736 row
= MATRIX_ROW (w
->current_matrix
, i
);
1737 if (!row
->enabled_p
)
1739 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1746 /* Give up if Y is not in the window. */
1747 if (i
== w
->current_matrix
->nrows
)
1750 /* Get the glyph area containing X. */
1751 if (w
->pseudo_window_p
)
1758 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1760 *area
= LEFT_MARGIN_AREA
;
1761 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1763 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1766 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1770 *area
= RIGHT_MARGIN_AREA
;
1771 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1775 /* Find glyph containing X. */
1776 glyph
= row
->glyphs
[*area
];
1777 end
= glyph
+ row
->used
[*area
];
1779 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1781 x
-= glyph
->pixel_width
;
1791 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1794 *hpos
= glyph
- row
->glyphs
[*area
];
1800 Convert frame-relative x/y to coordinates relative to window W.
1801 Takes pseudo-windows into account. */
1804 frame_to_window_pixel_xy (w
, x
, y
)
1808 if (w
->pseudo_window_p
)
1810 /* A pseudo-window is always full-width, and starts at the
1811 left edge of the frame, plus a frame border. */
1812 struct frame
*f
= XFRAME (w
->frame
);
1813 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1814 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1818 *x
-= WINDOW_LEFT_EDGE_X (w
);
1819 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1824 Return in RECTS[] at most N clipping rectangles for glyph string S.
1825 Return the number of stored rectangles. */
1828 get_glyph_string_clip_rects (s
, rects
, n
)
1829 struct glyph_string
*s
;
1830 NativeRectangle
*rects
;
1838 if (s
->row
->full_width_p
)
1840 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1841 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1842 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1844 /* Unless displaying a mode or menu bar line, which are always
1845 fully visible, clip to the visible part of the row. */
1846 if (s
->w
->pseudo_window_p
)
1847 r
.height
= s
->row
->visible_height
;
1849 r
.height
= s
->height
;
1853 /* This is a text line that may be partially visible. */
1854 r
.x
= window_box_left (s
->w
, s
->area
);
1855 r
.width
= window_box_width (s
->w
, s
->area
);
1856 r
.height
= s
->row
->visible_height
;
1860 if (r
.x
< s
->clip_head
->x
)
1862 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1863 r
.width
-= s
->clip_head
->x
- r
.x
;
1866 r
.x
= s
->clip_head
->x
;
1869 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1871 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1872 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1877 /* If S draws overlapping rows, it's sufficient to use the top and
1878 bottom of the window for clipping because this glyph string
1879 intentionally draws over other lines. */
1880 if (s
->for_overlaps
)
1882 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1883 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1885 /* Alas, the above simple strategy does not work for the
1886 environments with anti-aliased text: if the same text is
1887 drawn onto the same place multiple times, it gets thicker.
1888 If the overlap we are processing is for the erased cursor, we
1889 take the intersection with the rectagle of the cursor. */
1890 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1892 XRectangle rc
, r_save
= r
;
1894 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1895 rc
.y
= s
->w
->phys_cursor
.y
;
1896 rc
.width
= s
->w
->phys_cursor_width
;
1897 rc
.height
= s
->w
->phys_cursor_height
;
1899 x_intersect_rectangles (&r_save
, &rc
, &r
);
1904 /* Don't use S->y for clipping because it doesn't take partially
1905 visible lines into account. For example, it can be negative for
1906 partially visible lines at the top of a window. */
1907 if (!s
->row
->full_width_p
1908 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1909 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1911 r
.y
= max (0, s
->row
->y
);
1913 /* If drawing a tool-bar window, draw it over the internal border
1914 at the top of the window. */
1915 if (WINDOWP (s
->f
->tool_bar_window
)
1916 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1917 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1920 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1922 /* If drawing the cursor, don't let glyph draw outside its
1923 advertised boundaries. Cleartype does this under some circumstances. */
1924 if (s
->hl
== DRAW_CURSOR
)
1926 struct glyph
*glyph
= s
->first_glyph
;
1931 r
.width
-= s
->x
- r
.x
;
1934 r
.width
= min (r
.width
, glyph
->pixel_width
);
1936 /* If r.y is below window bottom, ensure that we still see a cursor. */
1937 height
= min (glyph
->ascent
+ glyph
->descent
,
1938 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1939 max_y
= window_text_bottom_y (s
->w
) - height
;
1940 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1941 if (s
->ybase
- glyph
->ascent
> max_y
)
1948 /* Don't draw cursor glyph taller than our actual glyph. */
1949 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1950 if (height
< r
.height
)
1952 max_y
= r
.y
+ r
.height
;
1953 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1954 r
.height
= min (max_y
- r
.y
, height
);
1961 XRectangle r_save
= r
;
1963 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1967 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1968 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1970 #ifdef CONVERT_FROM_XRECT
1971 CONVERT_FROM_XRECT (r
, *rects
);
1979 /* If we are processing overlapping and allowed to return
1980 multiple clipping rectangles, we exclude the row of the glyph
1981 string from the clipping rectangle. This is to avoid drawing
1982 the same text on the environment with anti-aliasing. */
1983 #ifdef CONVERT_FROM_XRECT
1986 XRectangle
*rs
= rects
;
1988 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1990 if (s
->for_overlaps
& OVERLAPS_PRED
)
1993 if (r
.y
+ r
.height
> row_y
)
1996 rs
[i
].height
= row_y
- r
.y
;
2002 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2005 if (r
.y
< row_y
+ s
->row
->visible_height
)
2007 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2009 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2010 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2019 #ifdef CONVERT_FROM_XRECT
2020 for (i
= 0; i
< n
; i
++)
2021 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2028 Return in *NR the clipping rectangle for glyph string S. */
2031 get_glyph_string_clip_rect (s
, nr
)
2032 struct glyph_string
*s
;
2033 NativeRectangle
*nr
;
2035 get_glyph_string_clip_rects (s
, nr
, 1);
2040 Return the position and height of the phys cursor in window W.
2041 Set w->phys_cursor_width to width of phys cursor.
2045 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2047 struct glyph_row
*row
;
2048 struct glyph
*glyph
;
2049 int *xp
, *yp
, *heightp
;
2051 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2052 int x
, y
, wd
, h
, h0
, y0
;
2054 /* Compute the width of the rectangle to draw. If on a stretch
2055 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2056 rectangle as wide as the glyph, but use a canonical character
2058 wd
= glyph
->pixel_width
- 1;
2063 x
= w
->phys_cursor
.x
;
2070 if (glyph
->type
== STRETCH_GLYPH
2071 && !x_stretch_cursor_p
)
2072 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2073 w
->phys_cursor_width
= wd
;
2075 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2077 /* If y is below window bottom, ensure that we still see a cursor. */
2078 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2080 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2081 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2083 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2086 h
= max (h
- (y0
- y
) + 1, h0
);
2091 y0
= window_text_bottom_y (w
) - h0
;
2099 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2100 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2105 * Remember which glyph the mouse is over.
2109 remember_mouse_glyph (f
, gx
, gy
, rect
)
2112 NativeRectangle
*rect
;
2116 struct glyph_row
*r
, *gr
, *end_row
;
2117 enum window_part part
;
2118 enum glyph_row_area area
;
2119 int x
, y
, width
, height
;
2121 /* Try to determine frame pixel position and size of the glyph under
2122 frame pixel coordinates X/Y on frame F. */
2124 if (!f
->glyphs_initialized_p
2125 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2128 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2129 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2133 w
= XWINDOW (window
);
2134 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2135 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2137 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2138 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2140 if (w
->pseudo_window_p
)
2143 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2149 case ON_LEFT_MARGIN
:
2150 area
= LEFT_MARGIN_AREA
;
2153 case ON_RIGHT_MARGIN
:
2154 area
= RIGHT_MARGIN_AREA
;
2157 case ON_HEADER_LINE
:
2159 gr
= (part
== ON_HEADER_LINE
2160 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2161 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2164 goto text_glyph_row_found
;
2171 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2172 if (r
->y
+ r
->height
> y
)
2178 text_glyph_row_found
:
2181 struct glyph
*g
= gr
->glyphs
[area
];
2182 struct glyph
*end
= g
+ gr
->used
[area
];
2184 height
= gr
->height
;
2185 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2186 if (gx
+ g
->pixel_width
> x
)
2191 if (g
->type
== IMAGE_GLYPH
)
2193 /* Don't remember when mouse is over image, as
2194 image may have hot-spots. */
2195 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2198 width
= g
->pixel_width
;
2202 /* Use nominal char spacing at end of line. */
2204 gx
+= (x
/ width
) * width
;
2207 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2208 gx
+= window_box_left_offset (w
, area
);
2212 /* Use nominal line height at end of window. */
2213 gx
= (x
/ width
) * width
;
2215 gy
+= (y
/ height
) * height
;
2219 case ON_LEFT_FRINGE
:
2220 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2221 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2222 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2223 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2226 case ON_RIGHT_FRINGE
:
2227 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2228 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2229 : window_box_right_offset (w
, TEXT_AREA
));
2230 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2234 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2236 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2237 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2238 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2240 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2244 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2245 if (r
->y
+ r
->height
> y
)
2252 height
= gr
->height
;
2255 /* Use nominal line height at end of window. */
2257 gy
+= (y
/ height
) * height
;
2264 /* If there is no glyph under the mouse, then we divide the screen
2265 into a grid of the smallest glyph in the frame, and use that
2268 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2269 round down even for negative values. */
2275 gx
= (gx
/ width
) * width
;
2276 gy
= (gy
/ height
) * height
;
2281 gx
+= WINDOW_LEFT_EDGE_X (w
);
2282 gy
+= WINDOW_TOP_EDGE_Y (w
);
2285 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2287 /* Visible feedback for debugging. */
2290 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2291 f
->output_data
.x
->normal_gc
,
2292 gx
, gy
, width
, height
);
2298 #endif /* HAVE_WINDOW_SYSTEM */
2301 /***********************************************************************
2302 Lisp form evaluation
2303 ***********************************************************************/
2305 /* Error handler for safe_eval and safe_call. */
2308 safe_eval_handler (arg
)
2311 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2316 /* Evaluate SEXPR and return the result, or nil if something went
2317 wrong. Prevent redisplay during the evaluation. */
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
)
3356 EMACS_INT next_stop
;
3358 if (!STRINGP (it
->string
))
3361 = face_at_buffer_position (it
->w
,
3363 it
->region_beg_charpos
,
3364 it
->region_end_charpos
,
3367 + TEXT_PROP_DISTANCE_LIMIT
),
3370 /* Is this a start of a run of characters with box face?
3371 Caveat: this can be called for a freshly initialized
3372 iterator; face_id is -1 in this case. We know that the new
3373 face will not change until limit, i.e. if the new face has a
3374 box, all characters up to limit will have one. But, as
3375 usual, we don't know whether limit is really the end. */
3376 if (new_face_id
!= it
->face_id
)
3378 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3380 /* If new face has a box but old face has not, this is
3381 the start of a run of characters with box, i.e. it has
3382 a shadow on the left side. The value of face_id of the
3383 iterator will be -1 if this is the initial call that gets
3384 the face. In this case, we have to look in front of IT's
3385 position and see whether there is a face != new_face_id. */
3386 it
->start_of_box_run_p
3387 = (new_face
->box
!= FACE_NO_BOX
3388 && (it
->face_id
>= 0
3389 || IT_CHARPOS (*it
) == BEG
3390 || new_face_id
!= face_before_it_pos (it
)));
3391 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3396 int base_face_id
, bufpos
;
3398 Lisp_Object from_overlay
3399 = (it
->current
.overlay_string_index
>= 0
3400 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3403 /* See if we got to this string directly or indirectly from
3404 an overlay property. That includes the before-string or
3405 after-string of an overlay, strings in display properties
3406 provided by an overlay, their text properties, etc.
3408 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3409 if (! NILP (from_overlay
))
3410 for (i
= it
->sp
- 1; i
>= 0; i
--)
3412 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3414 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3415 else if (! NILP (it
->stack
[i
].from_overlay
))
3416 from_overlay
= it
->stack
[i
].from_overlay
;
3418 if (!NILP (from_overlay
))
3422 if (! NILP (from_overlay
))
3424 bufpos
= IT_CHARPOS (*it
);
3425 /* For a string from an overlay, the base face depends
3426 only on text properties and ignores overlays. */
3428 = face_for_overlay_string (it
->w
,
3430 it
->region_beg_charpos
,
3431 it
->region_end_charpos
,
3434 + TEXT_PROP_DISTANCE_LIMIT
),
3442 /* For strings from a `display' property, use the face at
3443 IT's current buffer position as the base face to merge
3444 with, so that overlay strings appear in the same face as
3445 surrounding text, unless they specify their own
3447 base_face_id
= underlying_face_id (it
);
3450 new_face_id
= face_at_string_position (it
->w
,
3452 IT_STRING_CHARPOS (*it
),
3454 it
->region_beg_charpos
,
3455 it
->region_end_charpos
,
3459 #if 0 /* This shouldn't be neccessary. Let's check it. */
3460 /* If IT is used to display a mode line we would really like to
3461 use the mode line face instead of the frame's default face. */
3462 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3463 && new_face_id
== DEFAULT_FACE_ID
)
3464 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3467 /* Is this a start of a run of characters with box? Caveat:
3468 this can be called for a freshly allocated iterator; face_id
3469 is -1 is this case. We know that the new face will not
3470 change until the next check pos, i.e. if the new face has a
3471 box, all characters up to that position will have a
3472 box. But, as usual, we don't know whether that position
3473 is really the end. */
3474 if (new_face_id
!= it
->face_id
)
3476 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3477 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3479 /* If new face has a box but old face hasn't, this is the
3480 start of a run of characters with box, i.e. it has a
3481 shadow on the left side. */
3482 it
->start_of_box_run_p
3483 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3484 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3488 it
->face_id
= new_face_id
;
3489 return HANDLED_NORMALLY
;
3493 /* Return the ID of the face ``underlying'' IT's current position,
3494 which is in a string. If the iterator is associated with a
3495 buffer, return the face at IT's current buffer position.
3496 Otherwise, use the iterator's base_face_id. */
3499 underlying_face_id (it
)
3502 int face_id
= it
->base_face_id
, i
;
3504 xassert (STRINGP (it
->string
));
3506 for (i
= it
->sp
- 1; i
>= 0; --i
)
3507 if (NILP (it
->stack
[i
].string
))
3508 face_id
= it
->stack
[i
].face_id
;
3514 /* Compute the face one character before or after the current position
3515 of IT. BEFORE_P non-zero means get the face in front of IT's
3516 position. Value is the id of the face. */
3519 face_before_or_after_it_pos (it
, before_p
)
3524 EMACS_INT next_check_charpos
;
3525 struct text_pos pos
;
3527 xassert (it
->s
== NULL
);
3529 if (STRINGP (it
->string
))
3531 int bufpos
, base_face_id
;
3533 /* No face change past the end of the string (for the case
3534 we are padding with spaces). No face change before the
3536 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3537 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3540 /* Set pos to the position before or after IT's current position. */
3542 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3544 /* For composition, we must check the character after the
3546 pos
= (it
->what
== IT_COMPOSITION
3547 ? string_pos (IT_STRING_CHARPOS (*it
) + it
->cmp_len
, it
->string
)
3548 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3550 if (it
->current
.overlay_string_index
>= 0)
3551 bufpos
= IT_CHARPOS (*it
);
3555 base_face_id
= underlying_face_id (it
);
3557 /* Get the face for ASCII, or unibyte. */
3558 face_id
= face_at_string_position (it
->w
,
3562 it
->region_beg_charpos
,
3563 it
->region_end_charpos
,
3564 &next_check_charpos
,
3567 /* Correct the face for charsets different from ASCII. Do it
3568 for the multibyte case only. The face returned above is
3569 suitable for unibyte text if IT->string is unibyte. */
3570 if (STRING_MULTIBYTE (it
->string
))
3572 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3573 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3575 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3577 c
= string_char_and_length (p
, rest
, &len
);
3578 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3583 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3584 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3587 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3588 pos
= it
->current
.pos
;
3591 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3594 if (it
->what
== IT_COMPOSITION
)
3595 /* For composition, we must check the position after the
3597 pos
.charpos
+= it
->cmp_len
, pos
.bytepos
+= it
->len
;
3599 INC_TEXT_POS (pos
, it
->multibyte_p
);
3602 /* Determine face for CHARSET_ASCII, or unibyte. */
3603 face_id
= face_at_buffer_position (it
->w
,
3605 it
->region_beg_charpos
,
3606 it
->region_end_charpos
,
3607 &next_check_charpos
,
3610 /* Correct the face for charsets different from ASCII. Do it
3611 for the multibyte case only. The face returned above is
3612 suitable for unibyte text if current_buffer is unibyte. */
3613 if (it
->multibyte_p
)
3615 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3616 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3617 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3626 /***********************************************************************
3628 ***********************************************************************/
3630 /* Set up iterator IT from invisible properties at its current
3631 position. Called from handle_stop. */
3633 static enum prop_handled
3634 handle_invisible_prop (it
)
3637 enum prop_handled handled
= HANDLED_NORMALLY
;
3639 if (STRINGP (it
->string
))
3641 extern Lisp_Object Qinvisible
;
3642 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3644 /* Get the value of the invisible text property at the
3645 current position. Value will be nil if there is no such
3647 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3648 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3651 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3653 handled
= HANDLED_RECOMPUTE_PROPS
;
3655 /* Get the position at which the next change of the
3656 invisible text property can be found in IT->string.
3657 Value will be nil if the property value is the same for
3658 all the rest of IT->string. */
3659 XSETINT (limit
, SCHARS (it
->string
));
3660 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3663 /* Text at current position is invisible. The next
3664 change in the property is at position end_charpos.
3665 Move IT's current position to that position. */
3666 if (INTEGERP (end_charpos
)
3667 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3669 struct text_pos old
;
3670 old
= it
->current
.string_pos
;
3671 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3672 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3676 /* The rest of the string is invisible. If this is an
3677 overlay string, proceed with the next overlay string
3678 or whatever comes and return a character from there. */
3679 if (it
->current
.overlay_string_index
>= 0)
3681 next_overlay_string (it
);
3682 /* Don't check for overlay strings when we just
3683 finished processing them. */
3684 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3688 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3689 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3697 EMACS_INT newpos
, next_stop
, start_charpos
;
3698 Lisp_Object pos
, prop
, overlay
;
3700 /* First of all, is there invisible text at this position? */
3701 start_charpos
= IT_CHARPOS (*it
);
3702 pos
= make_number (IT_CHARPOS (*it
));
3703 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3705 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3707 /* If we are on invisible text, skip over it. */
3708 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3710 /* Record whether we have to display an ellipsis for the
3712 int display_ellipsis_p
= invis_p
== 2;
3714 handled
= HANDLED_RECOMPUTE_PROPS
;
3716 /* Loop skipping over invisible text. The loop is left at
3717 ZV or with IT on the first char being visible again. */
3720 /* Try to skip some invisible text. Return value is the
3721 position reached which can be equal to IT's position
3722 if there is nothing invisible here. This skips both
3723 over invisible text properties and overlays with
3724 invisible property. */
3725 newpos
= skip_invisible (IT_CHARPOS (*it
),
3726 &next_stop
, ZV
, it
->window
);
3728 /* If we skipped nothing at all we weren't at invisible
3729 text in the first place. If everything to the end of
3730 the buffer was skipped, end the loop. */
3731 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3735 /* We skipped some characters but not necessarily
3736 all there are. Check if we ended up on visible
3737 text. Fget_char_property returns the property of
3738 the char before the given position, i.e. if we
3739 get invis_p = 0, this means that the char at
3740 newpos is visible. */
3741 pos
= make_number (newpos
);
3742 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3743 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3746 /* If we ended up on invisible text, proceed to
3747 skip starting with next_stop. */
3749 IT_CHARPOS (*it
) = next_stop
;
3751 /* If there are adjacent invisible texts, don't lose the
3752 second one's ellipsis. */
3754 display_ellipsis_p
= 1;
3758 /* The position newpos is now either ZV or on visible text. */
3759 IT_CHARPOS (*it
) = newpos
;
3760 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3762 /* If there are before-strings at the start of invisible
3763 text, and the text is invisible because of a text
3764 property, arrange to show before-strings because 20.x did
3765 it that way. (If the text is invisible because of an
3766 overlay property instead of a text property, this is
3767 already handled in the overlay code.) */
3769 && get_overlay_strings (it
, start_charpos
))
3771 handled
= HANDLED_RECOMPUTE_PROPS
;
3772 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3774 else if (display_ellipsis_p
)
3776 /* Make sure that the glyphs of the ellipsis will get
3777 correct `charpos' values. If we would not update
3778 it->position here, the glyphs would belong to the
3779 last visible character _before_ the invisible
3780 text, which confuses `set_cursor_from_row'.
3782 We use the last invisible position instead of the
3783 first because this way the cursor is always drawn on
3784 the first "." of the ellipsis, whenever PT is inside
3785 the invisible text. Otherwise the cursor would be
3786 placed _after_ the ellipsis when the point is after the
3787 first invisible character. */
3788 if (!STRINGP (it
->object
))
3790 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3791 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3793 setup_for_ellipsis (it
, 0);
3794 /* Let the ellipsis display before
3795 considering any properties of the following char.
3796 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3797 handled
= HANDLED_RETURN
;
3806 /* Make iterator IT return `...' next.
3807 Replaces LEN characters from buffer. */
3810 setup_for_ellipsis (it
, len
)
3814 /* Use the display table definition for `...'. Invalid glyphs
3815 will be handled by the method returning elements from dpvec. */
3816 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3818 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3819 it
->dpvec
= v
->contents
;
3820 it
->dpend
= v
->contents
+ v
->size
;
3824 /* Default `...'. */
3825 it
->dpvec
= default_invis_vector
;
3826 it
->dpend
= default_invis_vector
+ 3;
3829 it
->dpvec_char_len
= len
;
3830 it
->current
.dpvec_index
= 0;
3831 it
->dpvec_face_id
= -1;
3833 /* Remember the current face id in case glyphs specify faces.
3834 IT's face is restored in set_iterator_to_next.
3835 saved_face_id was set to preceding char's face in handle_stop. */
3836 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3837 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3839 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3845 /***********************************************************************
3847 ***********************************************************************/
3849 /* Set up iterator IT from `display' property at its current position.
3850 Called from handle_stop.
3851 We return HANDLED_RETURN if some part of the display property
3852 overrides the display of the buffer text itself.
3853 Otherwise we return HANDLED_NORMALLY. */
3855 static enum prop_handled
3856 handle_display_prop (it
)
3859 Lisp_Object prop
, object
, overlay
;
3860 struct text_pos
*position
;
3861 /* Nonzero if some property replaces the display of the text itself. */
3862 int display_replaced_p
= 0;
3864 if (STRINGP (it
->string
))
3866 object
= it
->string
;
3867 position
= &it
->current
.string_pos
;
3871 XSETWINDOW (object
, it
->w
);
3872 position
= &it
->current
.pos
;
3875 /* Reset those iterator values set from display property values. */
3876 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3877 it
->space_width
= Qnil
;
3878 it
->font_height
= Qnil
;
3881 /* We don't support recursive `display' properties, i.e. string
3882 values that have a string `display' property, that have a string
3883 `display' property etc. */
3884 if (!it
->string_from_display_prop_p
)
3885 it
->area
= TEXT_AREA
;
3887 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3888 Qdisplay
, object
, &overlay
);
3890 return HANDLED_NORMALLY
;
3891 /* Now OVERLAY is the overlay that gave us this property, or nil
3892 if it was a text property. */
3894 if (!STRINGP (it
->string
))
3895 object
= it
->w
->buffer
;
3898 /* Simple properties. */
3899 && !EQ (XCAR (prop
), Qimage
)
3900 && !EQ (XCAR (prop
), Qspace
)
3901 && !EQ (XCAR (prop
), Qwhen
)
3902 && !EQ (XCAR (prop
), Qslice
)
3903 && !EQ (XCAR (prop
), Qspace_width
)
3904 && !EQ (XCAR (prop
), Qheight
)
3905 && !EQ (XCAR (prop
), Qraise
)
3906 /* Marginal area specifications. */
3907 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3908 && !EQ (XCAR (prop
), Qleft_fringe
)
3909 && !EQ (XCAR (prop
), Qright_fringe
)
3910 && !NILP (XCAR (prop
)))
3912 for (; CONSP (prop
); prop
= XCDR (prop
))
3914 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3915 position
, display_replaced_p
))
3917 display_replaced_p
= 1;
3918 /* If some text in a string is replaced, `position' no
3919 longer points to the position of `object'. */
3920 if (STRINGP (object
))
3925 else if (VECTORP (prop
))
3928 for (i
= 0; i
< ASIZE (prop
); ++i
)
3929 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3930 position
, display_replaced_p
))
3932 display_replaced_p
= 1;
3933 /* If some text in a string is replaced, `position' no
3934 longer points to the position of `object'. */
3935 if (STRINGP (object
))
3941 int ret
= handle_single_display_spec (it
, prop
, object
, overlay
,
3943 if (ret
< 0) /* Replaced by "", i.e. nothing. */
3944 return HANDLED_RECOMPUTE_PROPS
;
3946 display_replaced_p
= 1;
3949 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
3953 /* Value is the position of the end of the `display' property starting
3954 at START_POS in OBJECT. */
3956 static struct text_pos
3957 display_prop_end (it
, object
, start_pos
)
3960 struct text_pos start_pos
;
3963 struct text_pos end_pos
;
3965 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
3966 Qdisplay
, object
, Qnil
);
3967 CHARPOS (end_pos
) = XFASTINT (end
);
3968 if (STRINGP (object
))
3969 compute_string_pos (&end_pos
, start_pos
, it
->string
);
3971 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
3977 /* Set up IT from a single `display' specification PROP. OBJECT
3978 is the object in which the `display' property was found. *POSITION
3979 is the position at which it was found. DISPLAY_REPLACED_P non-zero
3980 means that we previously saw a display specification which already
3981 replaced text display with something else, for example an image;
3982 we ignore such properties after the first one has been processed.
3984 OVERLAY is the overlay this `display' property came from,
3985 or nil if it was a text property.
3987 If PROP is a `space' or `image' specification, and in some other
3988 cases too, set *POSITION to the position where the `display'
3991 Value is non-zero if something was found which replaces the display
3992 of buffer or string text. Specifically, the value is -1 if that
3993 "something" is "nothing". */
3996 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
3997 display_replaced_before_p
)
4001 Lisp_Object overlay
;
4002 struct text_pos
*position
;
4003 int display_replaced_before_p
;
4006 Lisp_Object location
, value
;
4007 struct text_pos start_pos
, save_pos
;
4010 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4011 If the result is non-nil, use VALUE instead of SPEC. */
4013 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4022 if (!NILP (form
) && !EQ (form
, Qt
))
4024 int count
= SPECPDL_INDEX ();
4025 struct gcpro gcpro1
;
4027 /* Bind `object' to the object having the `display' property, a
4028 buffer or string. Bind `position' to the position in the
4029 object where the property was found, and `buffer-position'
4030 to the current position in the buffer. */
4031 specbind (Qobject
, object
);
4032 specbind (Qposition
, make_number (CHARPOS (*position
)));
4033 specbind (Qbuffer_position
,
4034 make_number (STRINGP (object
)
4035 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4037 form
= safe_eval (form
);
4039 unbind_to (count
, Qnil
);
4045 /* Handle `(height HEIGHT)' specifications. */
4047 && EQ (XCAR (spec
), Qheight
)
4048 && CONSP (XCDR (spec
)))
4050 if (!FRAME_WINDOW_P (it
->f
))
4053 it
->font_height
= XCAR (XCDR (spec
));
4054 if (!NILP (it
->font_height
))
4056 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4057 int new_height
= -1;
4059 if (CONSP (it
->font_height
)
4060 && (EQ (XCAR (it
->font_height
), Qplus
)
4061 || EQ (XCAR (it
->font_height
), Qminus
))
4062 && CONSP (XCDR (it
->font_height
))
4063 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4065 /* `(+ N)' or `(- N)' where N is an integer. */
4066 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4067 if (EQ (XCAR (it
->font_height
), Qplus
))
4069 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4071 else if (FUNCTIONP (it
->font_height
))
4073 /* Call function with current height as argument.
4074 Value is the new height. */
4076 height
= safe_call1 (it
->font_height
,
4077 face
->lface
[LFACE_HEIGHT_INDEX
]);
4078 if (NUMBERP (height
))
4079 new_height
= XFLOATINT (height
);
4081 else if (NUMBERP (it
->font_height
))
4083 /* Value is a multiple of the canonical char height. */
4086 face
= FACE_FROM_ID (it
->f
, DEFAULT_FACE_ID
);
4087 new_height
= (XFLOATINT (it
->font_height
)
4088 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4092 /* Evaluate IT->font_height with `height' bound to the
4093 current specified height to get the new height. */
4094 int count
= SPECPDL_INDEX ();
4096 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4097 value
= safe_eval (it
->font_height
);
4098 unbind_to (count
, Qnil
);
4100 if (NUMBERP (value
))
4101 new_height
= XFLOATINT (value
);
4105 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4111 /* Handle `(space-width WIDTH)'. */
4113 && EQ (XCAR (spec
), Qspace_width
)
4114 && CONSP (XCDR (spec
)))
4116 if (!FRAME_WINDOW_P (it
->f
))
4119 value
= XCAR (XCDR (spec
));
4120 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4121 it
->space_width
= value
;
4126 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4128 && EQ (XCAR (spec
), Qslice
))
4132 if (!FRAME_WINDOW_P (it
->f
))
4135 if (tem
= XCDR (spec
), CONSP (tem
))
4137 it
->slice
.x
= XCAR (tem
);
4138 if (tem
= XCDR (tem
), CONSP (tem
))
4140 it
->slice
.y
= XCAR (tem
);
4141 if (tem
= XCDR (tem
), CONSP (tem
))
4143 it
->slice
.width
= XCAR (tem
);
4144 if (tem
= XCDR (tem
), CONSP (tem
))
4145 it
->slice
.height
= XCAR (tem
);
4153 /* Handle `(raise FACTOR)'. */
4155 && EQ (XCAR (spec
), Qraise
)
4156 && CONSP (XCDR (spec
)))
4158 if (!FRAME_WINDOW_P (it
->f
))
4161 #ifdef HAVE_WINDOW_SYSTEM
4162 value
= XCAR (XCDR (spec
));
4163 if (NUMBERP (value
))
4165 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4166 it
->voffset
= - (XFLOATINT (value
)
4167 * (FONT_HEIGHT (face
->font
)));
4169 #endif /* HAVE_WINDOW_SYSTEM */
4174 /* Don't handle the other kinds of display specifications
4175 inside a string that we got from a `display' property. */
4176 if (it
->string_from_display_prop_p
)
4179 /* Characters having this form of property are not displayed, so
4180 we have to find the end of the property. */
4181 start_pos
= *position
;
4182 *position
= display_prop_end (it
, object
, start_pos
);
4185 /* Stop the scan at that end position--we assume that all
4186 text properties change there. */
4187 it
->stop_charpos
= position
->charpos
;
4189 /* Handle `(left-fringe BITMAP [FACE])'
4190 and `(right-fringe BITMAP [FACE])'. */
4192 && (EQ (XCAR (spec
), Qleft_fringe
)
4193 || EQ (XCAR (spec
), Qright_fringe
))
4194 && CONSP (XCDR (spec
)))
4196 int face_id
= DEFAULT_FACE_ID
;
4199 if (!FRAME_WINDOW_P (it
->f
))
4200 /* If we return here, POSITION has been advanced
4201 across the text with this property. */
4204 #ifdef HAVE_WINDOW_SYSTEM
4205 value
= XCAR (XCDR (spec
));
4206 if (!SYMBOLP (value
)
4207 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4208 /* If we return here, POSITION has been advanced
4209 across the text with this property. */
4212 if (CONSP (XCDR (XCDR (spec
))))
4214 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4215 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4221 /* Save current settings of IT so that we can restore them
4222 when we are finished with the glyph property value. */
4224 save_pos
= it
->position
;
4225 it
->position
= *position
;
4227 it
->position
= save_pos
;
4229 it
->area
= TEXT_AREA
;
4230 it
->what
= IT_IMAGE
;
4231 it
->image_id
= -1; /* no image */
4232 it
->position
= start_pos
;
4233 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4234 it
->method
= GET_FROM_IMAGE
;
4235 it
->from_overlay
= Qnil
;
4236 it
->face_id
= face_id
;
4238 /* Say that we haven't consumed the characters with
4239 `display' property yet. The call to pop_it in
4240 set_iterator_to_next will clean this up. */
4241 *position
= start_pos
;
4243 if (EQ (XCAR (spec
), Qleft_fringe
))
4245 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4246 it
->left_user_fringe_face_id
= face_id
;
4250 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4251 it
->right_user_fringe_face_id
= face_id
;
4253 #endif /* HAVE_WINDOW_SYSTEM */
4257 /* Prepare to handle `((margin left-margin) ...)',
4258 `((margin right-margin) ...)' and `((margin nil) ...)'
4259 prefixes for display specifications. */
4260 location
= Qunbound
;
4261 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4265 value
= XCDR (spec
);
4267 value
= XCAR (value
);
4270 if (EQ (XCAR (tem
), Qmargin
)
4271 && (tem
= XCDR (tem
),
4272 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4274 || EQ (tem
, Qleft_margin
)
4275 || EQ (tem
, Qright_margin
))))
4279 if (EQ (location
, Qunbound
))
4285 /* After this point, VALUE is the property after any
4286 margin prefix has been stripped. It must be a string,
4287 an image specification, or `(space ...)'.
4289 LOCATION specifies where to display: `left-margin',
4290 `right-margin' or nil. */
4292 valid_p
= (STRINGP (value
)
4293 #ifdef HAVE_WINDOW_SYSTEM
4294 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4295 #endif /* not HAVE_WINDOW_SYSTEM */
4296 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4298 if (valid_p
&& !display_replaced_before_p
)
4300 /* Save current settings of IT so that we can restore them
4301 when we are finished with the glyph property value. */
4302 save_pos
= it
->position
;
4303 it
->position
= *position
;
4305 it
->position
= save_pos
;
4306 it
->from_overlay
= overlay
;
4308 if (NILP (location
))
4309 it
->area
= TEXT_AREA
;
4310 else if (EQ (location
, Qleft_margin
))
4311 it
->area
= LEFT_MARGIN_AREA
;
4313 it
->area
= RIGHT_MARGIN_AREA
;
4315 if (STRINGP (value
))
4317 if (SCHARS (value
) == 0)
4320 return -1; /* Replaced by "", i.e. nothing. */
4323 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4324 it
->current
.overlay_string_index
= -1;
4325 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4326 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4327 it
->method
= GET_FROM_STRING
;
4328 it
->stop_charpos
= 0;
4329 it
->string_from_display_prop_p
= 1;
4330 /* Say that we haven't consumed the characters with
4331 `display' property yet. The call to pop_it in
4332 set_iterator_to_next will clean this up. */
4333 if (BUFFERP (object
))
4334 it
->current
.pos
= start_pos
;
4336 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4338 it
->method
= GET_FROM_STRETCH
;
4340 it
->position
= start_pos
;
4341 if (BUFFERP (object
))
4342 it
->current
.pos
= start_pos
;
4344 #ifdef HAVE_WINDOW_SYSTEM
4347 it
->what
= IT_IMAGE
;
4348 it
->image_id
= lookup_image (it
->f
, value
);
4349 it
->position
= start_pos
;
4350 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4351 it
->method
= GET_FROM_IMAGE
;
4353 /* Say that we haven't consumed the characters with
4354 `display' property yet. The call to pop_it in
4355 set_iterator_to_next will clean this up. */
4356 if (BUFFERP (object
))
4357 it
->current
.pos
= start_pos
;
4359 #endif /* HAVE_WINDOW_SYSTEM */
4364 /* Invalid property or property not supported. Restore
4365 POSITION to what it was before. */
4366 *position
= start_pos
;
4371 /* Check if SPEC is a display sub-property value whose text should be
4372 treated as intangible. */
4375 single_display_spec_intangible_p (prop
)
4378 /* Skip over `when FORM'. */
4379 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4393 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4394 we don't need to treat text as intangible. */
4395 if (EQ (XCAR (prop
), Qmargin
))
4403 || EQ (XCAR (prop
), Qleft_margin
)
4404 || EQ (XCAR (prop
), Qright_margin
))
4408 return (CONSP (prop
)
4409 && (EQ (XCAR (prop
), Qimage
)
4410 || EQ (XCAR (prop
), Qspace
)));
4414 /* Check if PROP is a display property value whose text should be
4415 treated as intangible. */
4418 display_prop_intangible_p (prop
)
4422 && CONSP (XCAR (prop
))
4423 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4425 /* A list of sub-properties. */
4426 while (CONSP (prop
))
4428 if (single_display_spec_intangible_p (XCAR (prop
)))
4433 else if (VECTORP (prop
))
4435 /* A vector of sub-properties. */
4437 for (i
= 0; i
< ASIZE (prop
); ++i
)
4438 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4442 return single_display_spec_intangible_p (prop
);
4448 /* Return 1 if PROP is a display sub-property value containing STRING. */
4451 single_display_spec_string_p (prop
, string
)
4452 Lisp_Object prop
, string
;
4454 if (EQ (string
, prop
))
4457 /* Skip over `when FORM'. */
4458 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4467 /* Skip over `margin LOCATION'. */
4468 if (EQ (XCAR (prop
), Qmargin
))
4479 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4483 /* Return 1 if STRING appears in the `display' property PROP. */
4486 display_prop_string_p (prop
, string
)
4487 Lisp_Object prop
, string
;
4490 && CONSP (XCAR (prop
))
4491 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4493 /* A list of sub-properties. */
4494 while (CONSP (prop
))
4496 if (single_display_spec_string_p (XCAR (prop
), string
))
4501 else if (VECTORP (prop
))
4503 /* A vector of sub-properties. */
4505 for (i
= 0; i
< ASIZE (prop
); ++i
)
4506 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4510 return single_display_spec_string_p (prop
, string
);
4516 /* Determine from which buffer position in W's buffer STRING comes
4517 from. AROUND_CHARPOS is an approximate position where it could
4518 be from. Value is the buffer position or 0 if it couldn't be
4521 W's buffer must be current.
4523 This function is necessary because we don't record buffer positions
4524 in glyphs generated from strings (to keep struct glyph small).
4525 This function may only use code that doesn't eval because it is
4526 called asynchronously from note_mouse_highlight. */
4529 string_buffer_position (w
, string
, around_charpos
)
4534 Lisp_Object limit
, prop
, pos
;
4535 const int MAX_DISTANCE
= 1000;
4538 pos
= make_number (around_charpos
);
4539 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4540 while (!found
&& !EQ (pos
, limit
))
4542 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4543 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4546 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4551 pos
= make_number (around_charpos
);
4552 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4553 while (!found
&& !EQ (pos
, limit
))
4555 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4556 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4559 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4564 return found
? XINT (pos
) : 0;
4569 /***********************************************************************
4570 `composition' property
4571 ***********************************************************************/
4573 static enum prop_handled
4574 handle_auto_composed_prop (it
)
4577 enum prop_handled handled
= HANDLED_NORMALLY
;
4579 if (FUNCTIONP (Vauto_composition_function
))
4581 Lisp_Object val
= Qnil
;
4582 EMACS_INT pos
, limit
= -1;
4584 if (STRINGP (it
->string
))
4585 pos
= IT_STRING_CHARPOS (*it
);
4587 pos
= IT_CHARPOS (*it
);
4589 val
= Fget_text_property (make_number (pos
), Qauto_composed
, it
->string
);
4592 Lisp_Object cmp_prop
;
4593 EMACS_INT cmp_start
, cmp_end
;
4595 #ifdef USE_FONT_BACKEND
4596 if (enable_font_backend
4597 && get_property_and_range (pos
, Qcomposition
, &cmp_prop
,
4598 &cmp_start
, &cmp_end
, it
->string
)
4600 && COMPOSITION_METHOD (cmp_prop
) == COMPOSITION_WITH_GLYPH_STRING
)
4602 Lisp_Object gstring
= COMPOSITION_COMPONENTS (cmp_prop
);
4603 Lisp_Object font_object
= LGSTRING_FONT (gstring
);
4605 if (! EQ (font_object
,
4606 font_at (-1, pos
, FACE_FROM_ID (it
->f
, it
->face_id
),
4607 it
->w
, it
->string
)))
4608 /* We must re-compute the composition for the
4617 /* As Fnext_single_char_property_change is very slow, we
4618 limit the search to the current line. */
4619 if (STRINGP (it
->string
))
4620 limit
= SCHARS (it
->string
);
4622 limit
= find_next_newline_no_quit (pos
, 1);
4623 end
= Fnext_single_char_property_change (make_number (pos
),
4626 make_number (limit
));
4628 if (XINT (end
) < limit
)
4629 /* The current point is auto-composed, but there exist
4630 characters not yet composed beyond the
4631 auto-composed region. There's a possiblity that
4632 the last characters in the region may be newly
4637 if (NILP (val
) && ! STRINGP (it
->string
))
4640 limit
= (STRINGP (it
->string
) ? SCHARS (it
->string
)
4641 : find_next_newline_no_quit (pos
, 1));
4644 int count
= SPECPDL_INDEX ();
4645 Lisp_Object args
[5];
4647 args
[0] = Vauto_composition_function
;
4648 specbind (Qauto_composition_function
, Qnil
);
4649 args
[1] = make_number (pos
);
4650 args
[2] = make_number (limit
);
4651 #ifdef USE_FONT_BACKEND
4652 if (enable_font_backend
)
4653 args
[3] = it
->window
;
4655 #endif /* USE_FONT_BACKEND */
4657 args
[4] = it
->string
;
4658 safe_call (5, args
);
4659 unbind_to (count
, Qnil
);
4667 /* Set up iterator IT from `composition' property at its current
4668 position. Called from handle_stop. */
4670 static enum prop_handled
4671 handle_composition_prop (it
)
4674 Lisp_Object prop
, string
;
4675 EMACS_INT pos
, pos_byte
, start
, end
;
4676 enum prop_handled handled
= HANDLED_NORMALLY
;
4678 if (STRINGP (it
->string
))
4682 pos
= IT_STRING_CHARPOS (*it
);
4683 pos_byte
= IT_STRING_BYTEPOS (*it
);
4684 string
= it
->string
;
4685 s
= SDATA (string
) + pos_byte
;
4686 it
->c
= STRING_CHAR (s
, 0);
4690 pos
= IT_CHARPOS (*it
);
4691 pos_byte
= IT_BYTEPOS (*it
);
4693 it
->c
= FETCH_CHAR (pos_byte
);
4696 /* If there's a valid composition and point is not inside of the
4697 composition (in the case that the composition is from the current
4698 buffer), draw a glyph composed from the composition components. */
4699 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4700 && COMPOSITION_VALID_P (start
, end
, prop
)
4701 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4707 if (STRINGP (it
->string
))
4708 pos_byte
= string_char_to_byte (it
->string
, start
);
4710 pos_byte
= CHAR_TO_BYTE (start
);
4712 id
= get_composition_id (start
, pos_byte
, end
- start
, prop
, string
);
4716 struct composition
*cmp
= composition_table
[id
];
4718 if (cmp
->glyph_len
== 0)
4721 if (STRINGP (it
->string
))
4723 IT_STRING_CHARPOS (*it
) = end
;
4724 IT_STRING_BYTEPOS (*it
) = string_char_to_byte (it
->string
,
4729 IT_CHARPOS (*it
) = end
;
4730 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (end
);
4732 return HANDLED_RECOMPUTE_PROPS
;
4735 it
->stop_charpos
= end
;
4738 it
->method
= GET_FROM_COMPOSITION
;
4740 it
->cmp_len
= COMPOSITION_LENGTH (prop
);
4741 /* For a terminal, draw only the first (non-TAB) character
4742 of the components. */
4743 #ifdef USE_FONT_BACKEND
4744 if (composition_table
[id
]->method
== COMPOSITION_WITH_GLYPH_STRING
)
4746 /* FIXME: This doesn't do anything!?! */
4747 Lisp_Object lgstring
= AREF (XHASH_TABLE (composition_hash_table
)
4749 cmp
->hash_index
* 2);
4752 #endif /* USE_FONT_BACKEND */
4756 for (i
= 0; i
< cmp
->glyph_len
; i
++)
4757 if ((it
->c
= COMPOSITION_GLYPH (composition_table
[id
], i
))
4763 it
->len
= (STRINGP (it
->string
)
4764 ? string_char_to_byte (it
->string
, end
)
4765 : CHAR_TO_BYTE (end
)) - pos_byte
;
4766 handled
= HANDLED_RETURN
;
4775 /***********************************************************************
4777 ***********************************************************************/
4779 /* The following structure is used to record overlay strings for
4780 later sorting in load_overlay_strings. */
4782 struct overlay_entry
4784 Lisp_Object overlay
;
4791 /* Set up iterator IT from overlay strings at its current position.
4792 Called from handle_stop. */
4794 static enum prop_handled
4795 handle_overlay_change (it
)
4798 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4799 return HANDLED_RECOMPUTE_PROPS
;
4801 return HANDLED_NORMALLY
;
4805 /* Set up the next overlay string for delivery by IT, if there is an
4806 overlay string to deliver. Called by set_iterator_to_next when the
4807 end of the current overlay string is reached. If there are more
4808 overlay strings to display, IT->string and
4809 IT->current.overlay_string_index are set appropriately here.
4810 Otherwise IT->string is set to nil. */
4813 next_overlay_string (it
)
4816 ++it
->current
.overlay_string_index
;
4817 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4819 /* No more overlay strings. Restore IT's settings to what
4820 they were before overlay strings were processed, and
4821 continue to deliver from current_buffer. */
4822 int display_ellipsis_p
= it
->stack
[it
->sp
- 1].display_ellipsis_p
;
4826 || it
->method
== GET_FROM_COMPOSITION
4827 || (NILP (it
->string
)
4828 && it
->method
== GET_FROM_BUFFER
4829 && it
->stop_charpos
>= BEGV
4830 && it
->stop_charpos
<= it
->end_charpos
));
4831 it
->current
.overlay_string_index
= -1;
4832 it
->n_overlay_strings
= 0;
4834 /* If we're at the end of the buffer, record that we have
4835 processed the overlay strings there already, so that
4836 next_element_from_buffer doesn't try it again. */
4837 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
4838 it
->overlay_strings_at_end_processed_p
= 1;
4840 /* If we have to display `...' for invisible text, set
4841 the iterator up for that. */
4842 if (display_ellipsis_p
)
4843 setup_for_ellipsis (it
, 0);
4847 /* There are more overlay strings to process. If
4848 IT->current.overlay_string_index has advanced to a position
4849 where we must load IT->overlay_strings with more strings, do
4851 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4853 if (it
->current
.overlay_string_index
&& i
== 0)
4854 load_overlay_strings (it
, 0);
4856 /* Initialize IT to deliver display elements from the overlay
4858 it
->string
= it
->overlay_strings
[i
];
4859 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4860 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4861 it
->method
= GET_FROM_STRING
;
4862 it
->stop_charpos
= 0;
4869 /* Compare two overlay_entry structures E1 and E2. Used as a
4870 comparison function for qsort in load_overlay_strings. Overlay
4871 strings for the same position are sorted so that
4873 1. All after-strings come in front of before-strings, except
4874 when they come from the same overlay.
4876 2. Within after-strings, strings are sorted so that overlay strings
4877 from overlays with higher priorities come first.
4879 2. Within before-strings, strings are sorted so that overlay
4880 strings from overlays with higher priorities come last.
4882 Value is analogous to strcmp. */
4886 compare_overlay_entries (e1
, e2
)
4889 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4890 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4893 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4895 /* Let after-strings appear in front of before-strings if
4896 they come from different overlays. */
4897 if (EQ (entry1
->overlay
, entry2
->overlay
))
4898 result
= entry1
->after_string_p
? 1 : -1;
4900 result
= entry1
->after_string_p
? -1 : 1;
4902 else if (entry1
->after_string_p
)
4903 /* After-strings sorted in order of decreasing priority. */
4904 result
= entry2
->priority
- entry1
->priority
;
4906 /* Before-strings sorted in order of increasing priority. */
4907 result
= entry1
->priority
- entry2
->priority
;
4913 /* Load the vector IT->overlay_strings with overlay strings from IT's
4914 current buffer position, or from CHARPOS if that is > 0. Set
4915 IT->n_overlays to the total number of overlay strings found.
4917 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4918 a time. On entry into load_overlay_strings,
4919 IT->current.overlay_string_index gives the number of overlay
4920 strings that have already been loaded by previous calls to this
4923 IT->add_overlay_start contains an additional overlay start
4924 position to consider for taking overlay strings from, if non-zero.
4925 This position comes into play when the overlay has an `invisible'
4926 property, and both before and after-strings. When we've skipped to
4927 the end of the overlay, because of its `invisible' property, we
4928 nevertheless want its before-string to appear.
4929 IT->add_overlay_start will contain the overlay start position
4932 Overlay strings are sorted so that after-string strings come in
4933 front of before-string strings. Within before and after-strings,
4934 strings are sorted by overlay priority. See also function
4935 compare_overlay_entries. */
4938 load_overlay_strings (it
, charpos
)
4942 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4943 Lisp_Object overlay
, window
, str
, invisible
;
4944 struct Lisp_Overlay
*ov
;
4947 int n
= 0, i
, j
, invis_p
;
4948 struct overlay_entry
*entries
4949 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4952 charpos
= IT_CHARPOS (*it
);
4954 /* Append the overlay string STRING of overlay OVERLAY to vector
4955 `entries' which has size `size' and currently contains `n'
4956 elements. AFTER_P non-zero means STRING is an after-string of
4958 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4961 Lisp_Object priority; \
4965 int new_size = 2 * size; \
4966 struct overlay_entry *old = entries; \
4968 (struct overlay_entry *) alloca (new_size \
4969 * sizeof *entries); \
4970 bcopy (old, entries, size * sizeof *entries); \
4974 entries[n].string = (STRING); \
4975 entries[n].overlay = (OVERLAY); \
4976 priority = Foverlay_get ((OVERLAY), Qpriority); \
4977 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4978 entries[n].after_string_p = (AFTER_P); \
4983 /* Process overlay before the overlay center. */
4984 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4986 XSETMISC (overlay
, ov
);
4987 xassert (OVERLAYP (overlay
));
4988 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4989 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4994 /* Skip this overlay if it doesn't start or end at IT's current
4996 if (end
!= charpos
&& start
!= charpos
)
4999 /* Skip this overlay if it doesn't apply to IT->w. */
5000 window
= Foverlay_get (overlay
, Qwindow
);
5001 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5004 /* If the text ``under'' the overlay is invisible, both before-
5005 and after-strings from this overlay are visible; start and
5006 end position are indistinguishable. */
5007 invisible
= Foverlay_get (overlay
, Qinvisible
);
5008 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5010 /* If overlay has a non-empty before-string, record it. */
5011 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5012 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5014 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5016 /* If overlay has a non-empty after-string, record it. */
5017 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5018 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5020 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5023 /* Process overlays after the overlay center. */
5024 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5026 XSETMISC (overlay
, ov
);
5027 xassert (OVERLAYP (overlay
));
5028 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5029 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5031 if (start
> charpos
)
5034 /* Skip this overlay if it doesn't start or end at IT's current
5036 if (end
!= charpos
&& start
!= charpos
)
5039 /* Skip this overlay if it doesn't apply to IT->w. */
5040 window
= Foverlay_get (overlay
, Qwindow
);
5041 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5044 /* If the text ``under'' the overlay is invisible, it has a zero
5045 dimension, and both before- and after-strings apply. */
5046 invisible
= Foverlay_get (overlay
, Qinvisible
);
5047 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5049 /* If overlay has a non-empty before-string, record it. */
5050 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5051 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5053 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5055 /* If overlay has a non-empty after-string, record it. */
5056 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5057 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5059 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5062 #undef RECORD_OVERLAY_STRING
5066 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5068 /* Record the total number of strings to process. */
5069 it
->n_overlay_strings
= n
;
5071 /* IT->current.overlay_string_index is the number of overlay strings
5072 that have already been consumed by IT. Copy some of the
5073 remaining overlay strings to IT->overlay_strings. */
5075 j
= it
->current
.overlay_string_index
;
5076 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5078 it
->overlay_strings
[i
] = entries
[j
].string
;
5079 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5086 /* Get the first chunk of overlay strings at IT's current buffer
5087 position, or at CHARPOS if that is > 0. Value is non-zero if at
5088 least one overlay string was found. */
5091 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5095 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5096 process. This fills IT->overlay_strings with strings, and sets
5097 IT->n_overlay_strings to the total number of strings to process.
5098 IT->pos.overlay_string_index has to be set temporarily to zero
5099 because load_overlay_strings needs this; it must be set to -1
5100 when no overlay strings are found because a zero value would
5101 indicate a position in the first overlay string. */
5102 it
->current
.overlay_string_index
= 0;
5103 load_overlay_strings (it
, charpos
);
5105 /* If we found overlay strings, set up IT to deliver display
5106 elements from the first one. Otherwise set up IT to deliver
5107 from current_buffer. */
5108 if (it
->n_overlay_strings
)
5110 /* Make sure we know settings in current_buffer, so that we can
5111 restore meaningful values when we're done with the overlay
5114 compute_stop_pos (it
);
5115 xassert (it
->face_id
>= 0);
5117 /* Save IT's settings. They are restored after all overlay
5118 strings have been processed. */
5119 xassert (!compute_stop_p
|| it
->sp
== 0);
5122 /* Set up IT to deliver display elements from the first overlay
5124 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5125 it
->string
= it
->overlay_strings
[0];
5126 it
->from_overlay
= Qnil
;
5127 it
->stop_charpos
= 0;
5128 xassert (STRINGP (it
->string
));
5129 it
->end_charpos
= SCHARS (it
->string
);
5130 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5131 it
->method
= GET_FROM_STRING
;
5135 it
->current
.overlay_string_index
= -1;
5140 get_overlay_strings (it
, charpos
)
5145 it
->method
= GET_FROM_BUFFER
;
5147 (void) get_overlay_strings_1 (it
, charpos
, 1);
5151 /* Value is non-zero if we found at least one overlay string. */
5152 return STRINGP (it
->string
);
5157 /***********************************************************************
5158 Saving and restoring state
5159 ***********************************************************************/
5161 /* Save current settings of IT on IT->stack. Called, for example,
5162 before setting up IT for an overlay string, to be able to restore
5163 IT's settings to what they were after the overlay string has been
5170 struct iterator_stack_entry
*p
;
5172 xassert (it
->sp
< IT_STACK_SIZE
);
5173 p
= it
->stack
+ it
->sp
;
5175 p
->stop_charpos
= it
->stop_charpos
;
5176 xassert (it
->face_id
>= 0);
5177 p
->face_id
= it
->face_id
;
5178 p
->string
= it
->string
;
5179 p
->method
= it
->method
;
5180 p
->from_overlay
= it
->from_overlay
;
5183 case GET_FROM_IMAGE
:
5184 p
->u
.image
.object
= it
->object
;
5185 p
->u
.image
.image_id
= it
->image_id
;
5186 p
->u
.image
.slice
= it
->slice
;
5188 case GET_FROM_COMPOSITION
:
5189 p
->u
.comp
.object
= it
->object
;
5190 p
->u
.comp
.c
= it
->c
;
5191 p
->u
.comp
.len
= it
->len
;
5192 p
->u
.comp
.cmp_id
= it
->cmp_id
;
5193 p
->u
.comp
.cmp_len
= it
->cmp_len
;
5195 case GET_FROM_STRETCH
:
5196 p
->u
.stretch
.object
= it
->object
;
5199 p
->position
= it
->position
;
5200 p
->current
= it
->current
;
5201 p
->end_charpos
= it
->end_charpos
;
5202 p
->string_nchars
= it
->string_nchars
;
5204 p
->multibyte_p
= it
->multibyte_p
;
5205 p
->space_width
= it
->space_width
;
5206 p
->font_height
= it
->font_height
;
5207 p
->voffset
= it
->voffset
;
5208 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5209 p
->display_ellipsis_p
= 0;
5214 /* Restore IT's settings from IT->stack. Called, for example, when no
5215 more overlay strings must be processed, and we return to delivering
5216 display elements from a buffer, or when the end of a string from a
5217 `display' property is reached and we return to delivering display
5218 elements from an overlay string, or from a buffer. */
5224 struct iterator_stack_entry
*p
;
5226 xassert (it
->sp
> 0);
5228 p
= it
->stack
+ it
->sp
;
5229 it
->stop_charpos
= p
->stop_charpos
;
5230 it
->face_id
= p
->face_id
;
5231 it
->current
= p
->current
;
5232 it
->position
= p
->position
;
5233 it
->string
= p
->string
;
5234 it
->from_overlay
= p
->from_overlay
;
5235 if (NILP (it
->string
))
5236 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5237 it
->method
= p
->method
;
5240 case GET_FROM_IMAGE
:
5241 it
->image_id
= p
->u
.image
.image_id
;
5242 it
->object
= p
->u
.image
.object
;
5243 it
->slice
= p
->u
.image
.slice
;
5245 case GET_FROM_COMPOSITION
:
5246 it
->object
= p
->u
.comp
.object
;
5247 it
->c
= p
->u
.comp
.c
;
5248 it
->len
= p
->u
.comp
.len
;
5249 it
->cmp_id
= p
->u
.comp
.cmp_id
;
5250 it
->cmp_len
= p
->u
.comp
.cmp_len
;
5252 case GET_FROM_STRETCH
:
5253 it
->object
= p
->u
.comp
.object
;
5255 case GET_FROM_BUFFER
:
5256 it
->object
= it
->w
->buffer
;
5258 case GET_FROM_STRING
:
5259 it
->object
= it
->string
;
5262 it
->end_charpos
= p
->end_charpos
;
5263 it
->string_nchars
= p
->string_nchars
;
5265 it
->multibyte_p
= p
->multibyte_p
;
5266 it
->space_width
= p
->space_width
;
5267 it
->font_height
= p
->font_height
;
5268 it
->voffset
= p
->voffset
;
5269 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5274 /***********************************************************************
5276 ***********************************************************************/
5278 /* Set IT's current position to the previous line start. */
5281 back_to_previous_line_start (it
)
5284 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5285 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5289 /* Move IT to the next line start.
5291 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5292 we skipped over part of the text (as opposed to moving the iterator
5293 continuously over the text). Otherwise, don't change the value
5296 Newlines may come from buffer text, overlay strings, or strings
5297 displayed via the `display' property. That's the reason we can't
5298 simply use find_next_newline_no_quit.
5300 Note that this function may not skip over invisible text that is so
5301 because of text properties and immediately follows a newline. If
5302 it would, function reseat_at_next_visible_line_start, when called
5303 from set_iterator_to_next, would effectively make invisible
5304 characters following a newline part of the wrong glyph row, which
5305 leads to wrong cursor motion. */
5308 forward_to_next_line_start (it
, skipped_p
)
5312 int old_selective
, newline_found_p
, n
;
5313 const int MAX_NEWLINE_DISTANCE
= 500;
5315 /* If already on a newline, just consume it to avoid unintended
5316 skipping over invisible text below. */
5317 if (it
->what
== IT_CHARACTER
5319 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5321 set_iterator_to_next (it
, 0);
5326 /* Don't handle selective display in the following. It's (a)
5327 unnecessary because it's done by the caller, and (b) leads to an
5328 infinite recursion because next_element_from_ellipsis indirectly
5329 calls this function. */
5330 old_selective
= it
->selective
;
5333 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5334 from buffer text. */
5335 for (n
= newline_found_p
= 0;
5336 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5337 n
+= STRINGP (it
->string
) ? 0 : 1)
5339 if (!get_next_display_element (it
))
5341 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5342 set_iterator_to_next (it
, 0);
5345 /* If we didn't find a newline near enough, see if we can use a
5347 if (!newline_found_p
)
5349 int start
= IT_CHARPOS (*it
);
5350 int limit
= find_next_newline_no_quit (start
, 1);
5353 xassert (!STRINGP (it
->string
));
5355 /* If there isn't any `display' property in sight, and no
5356 overlays, we can just use the position of the newline in
5358 if (it
->stop_charpos
>= limit
5359 || ((pos
= Fnext_single_property_change (make_number (start
),
5361 Qnil
, make_number (limit
)),
5363 && next_overlay_change (start
) == ZV
))
5365 IT_CHARPOS (*it
) = limit
;
5366 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5367 *skipped_p
= newline_found_p
= 1;
5371 while (get_next_display_element (it
)
5372 && !newline_found_p
)
5374 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5375 set_iterator_to_next (it
, 0);
5380 it
->selective
= old_selective
;
5381 return newline_found_p
;
5385 /* Set IT's current position to the previous visible line start. Skip
5386 invisible text that is so either due to text properties or due to
5387 selective display. Caution: this does not change IT->current_x and
5391 back_to_previous_visible_line_start (it
)
5394 while (IT_CHARPOS (*it
) > BEGV
)
5396 back_to_previous_line_start (it
);
5398 if (IT_CHARPOS (*it
) <= BEGV
)
5401 /* If selective > 0, then lines indented more than that values
5403 if (it
->selective
> 0
5404 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5405 (double) it
->selective
)) /* iftc */
5408 /* Check the newline before point for invisibility. */
5411 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5412 Qinvisible
, it
->window
);
5413 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5417 if (IT_CHARPOS (*it
) <= BEGV
)
5424 Lisp_Object val
, overlay
;
5426 /* If newline is part of a composition, continue from start of composition */
5427 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5428 && beg
< IT_CHARPOS (*it
))
5431 /* If newline is replaced by a display property, find start of overlay
5432 or interval and continue search from that point. */
5434 pos
= --IT_CHARPOS (it2
);
5437 if (handle_display_prop (&it2
) == HANDLED_RETURN
5438 && !NILP (val
= get_char_property_and_overlay
5439 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5440 && (OVERLAYP (overlay
)
5441 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5442 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5445 /* Newline is not replaced by anything -- so we are done. */
5451 IT_CHARPOS (*it
) = beg
;
5452 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5456 it
->continuation_lines_width
= 0;
5458 xassert (IT_CHARPOS (*it
) >= BEGV
);
5459 xassert (IT_CHARPOS (*it
) == BEGV
5460 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5465 /* Reseat iterator IT at the previous visible line start. Skip
5466 invisible text that is so either due to text properties or due to
5467 selective display. At the end, update IT's overlay information,
5468 face information etc. */
5471 reseat_at_previous_visible_line_start (it
)
5474 back_to_previous_visible_line_start (it
);
5475 reseat (it
, it
->current
.pos
, 1);
5480 /* Reseat iterator IT on the next visible line start in the current
5481 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5482 preceding the line start. Skip over invisible text that is so
5483 because of selective display. Compute faces, overlays etc at the
5484 new position. Note that this function does not skip over text that
5485 is invisible because of text properties. */
5488 reseat_at_next_visible_line_start (it
, on_newline_p
)
5492 int newline_found_p
, skipped_p
= 0;
5494 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5496 /* Skip over lines that are invisible because they are indented
5497 more than the value of IT->selective. */
5498 if (it
->selective
> 0)
5499 while (IT_CHARPOS (*it
) < ZV
5500 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5501 (double) it
->selective
)) /* iftc */
5503 xassert (IT_BYTEPOS (*it
) == BEGV
5504 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5505 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5508 /* Position on the newline if that's what's requested. */
5509 if (on_newline_p
&& newline_found_p
)
5511 if (STRINGP (it
->string
))
5513 if (IT_STRING_CHARPOS (*it
) > 0)
5515 --IT_STRING_CHARPOS (*it
);
5516 --IT_STRING_BYTEPOS (*it
);
5519 else if (IT_CHARPOS (*it
) > BEGV
)
5523 reseat (it
, it
->current
.pos
, 0);
5527 reseat (it
, it
->current
.pos
, 0);
5534 /***********************************************************************
5535 Changing an iterator's position
5536 ***********************************************************************/
5538 /* Change IT's current position to POS in current_buffer. If FORCE_P
5539 is non-zero, always check for text properties at the new position.
5540 Otherwise, text properties are only looked up if POS >=
5541 IT->check_charpos of a property. */
5544 reseat (it
, pos
, force_p
)
5546 struct text_pos pos
;
5549 int original_pos
= IT_CHARPOS (*it
);
5551 reseat_1 (it
, pos
, 0);
5553 /* Determine where to check text properties. Avoid doing it
5554 where possible because text property lookup is very expensive. */
5556 || CHARPOS (pos
) > it
->stop_charpos
5557 || CHARPOS (pos
) < original_pos
)
5564 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5565 IT->stop_pos to POS, also. */
5568 reseat_1 (it
, pos
, set_stop_p
)
5570 struct text_pos pos
;
5573 /* Don't call this function when scanning a C string. */
5574 xassert (it
->s
== NULL
);
5576 /* POS must be a reasonable value. */
5577 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5579 it
->current
.pos
= it
->position
= pos
;
5580 it
->end_charpos
= ZV
;
5582 it
->current
.dpvec_index
= -1;
5583 it
->current
.overlay_string_index
= -1;
5584 IT_STRING_CHARPOS (*it
) = -1;
5585 IT_STRING_BYTEPOS (*it
) = -1;
5587 it
->method
= GET_FROM_BUFFER
;
5588 it
->object
= it
->w
->buffer
;
5589 it
->area
= TEXT_AREA
;
5590 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5592 it
->string_from_display_prop_p
= 0;
5593 it
->face_before_selective_p
= 0;
5596 it
->stop_charpos
= CHARPOS (pos
);
5600 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5601 If S is non-null, it is a C string to iterate over. Otherwise,
5602 STRING gives a Lisp string to iterate over.
5604 If PRECISION > 0, don't return more then PRECISION number of
5605 characters from the string.
5607 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5608 characters have been returned. FIELD_WIDTH < 0 means an infinite
5611 MULTIBYTE = 0 means disable processing of multibyte characters,
5612 MULTIBYTE > 0 means enable it,
5613 MULTIBYTE < 0 means use IT->multibyte_p.
5615 IT must be initialized via a prior call to init_iterator before
5616 calling this function. */
5619 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5624 int precision
, field_width
, multibyte
;
5626 /* No region in strings. */
5627 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5629 /* No text property checks performed by default, but see below. */
5630 it
->stop_charpos
= -1;
5632 /* Set iterator position and end position. */
5633 bzero (&it
->current
, sizeof it
->current
);
5634 it
->current
.overlay_string_index
= -1;
5635 it
->current
.dpvec_index
= -1;
5636 xassert (charpos
>= 0);
5638 /* If STRING is specified, use its multibyteness, otherwise use the
5639 setting of MULTIBYTE, if specified. */
5641 it
->multibyte_p
= multibyte
> 0;
5645 xassert (STRINGP (string
));
5646 it
->string
= string
;
5648 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5649 it
->method
= GET_FROM_STRING
;
5650 it
->current
.string_pos
= string_pos (charpos
, string
);
5657 /* Note that we use IT->current.pos, not it->current.string_pos,
5658 for displaying C strings. */
5659 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5660 if (it
->multibyte_p
)
5662 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5663 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5667 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5668 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5671 it
->method
= GET_FROM_C_STRING
;
5674 /* PRECISION > 0 means don't return more than PRECISION characters
5676 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5677 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5679 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5680 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5681 FIELD_WIDTH < 0 means infinite field width. This is useful for
5682 padding with `-' at the end of a mode line. */
5683 if (field_width
< 0)
5684 field_width
= INFINITY
;
5685 if (field_width
> it
->end_charpos
- charpos
)
5686 it
->end_charpos
= charpos
+ field_width
;
5688 /* Use the standard display table for displaying strings. */
5689 if (DISP_TABLE_P (Vstandard_display_table
))
5690 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5692 it
->stop_charpos
= charpos
;
5698 /***********************************************************************
5700 ***********************************************************************/
5702 /* Map enum it_method value to corresponding next_element_from_* function. */
5704 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5706 next_element_from_buffer
,
5707 next_element_from_display_vector
,
5708 next_element_from_composition
,
5709 next_element_from_string
,
5710 next_element_from_c_string
,
5711 next_element_from_image
,
5712 next_element_from_stretch
5716 /* Load IT's display element fields with information about the next
5717 display element from the current position of IT. Value is zero if
5718 end of buffer (or C string) is reached. */
5720 static struct frame
*last_escape_glyph_frame
= NULL
;
5721 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5722 static int last_escape_glyph_merged_face_id
= 0;
5725 get_next_display_element (it
)
5728 /* Non-zero means that we found a display element. Zero means that
5729 we hit the end of what we iterate over. Performance note: the
5730 function pointer `method' used here turns out to be faster than
5731 using a sequence of if-statements. */
5735 success_p
= (*get_next_element
[it
->method
]) (it
);
5737 if (it
->what
== IT_CHARACTER
)
5739 /* Map via display table or translate control characters.
5740 IT->c, IT->len etc. have been set to the next character by
5741 the function call above. If we have a display table, and it
5742 contains an entry for IT->c, translate it. Don't do this if
5743 IT->c itself comes from a display table, otherwise we could
5744 end up in an infinite recursion. (An alternative could be to
5745 count the recursion depth of this function and signal an
5746 error when a certain maximum depth is reached.) Is it worth
5748 if (success_p
&& it
->dpvec
== NULL
)
5753 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5756 struct Lisp_Vector
*v
= XVECTOR (dv
);
5758 /* Return the first character from the display table
5759 entry, if not empty. If empty, don't display the
5760 current character. */
5763 it
->dpvec_char_len
= it
->len
;
5764 it
->dpvec
= v
->contents
;
5765 it
->dpend
= v
->contents
+ v
->size
;
5766 it
->current
.dpvec_index
= 0;
5767 it
->dpvec_face_id
= -1;
5768 it
->saved_face_id
= it
->face_id
;
5769 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5774 set_iterator_to_next (it
, 0);
5779 /* Translate control characters into `\003' or `^C' form.
5780 Control characters coming from a display table entry are
5781 currently not translated because we use IT->dpvec to hold
5782 the translation. This could easily be changed but I
5783 don't believe that it is worth doing.
5785 If it->multibyte_p is nonzero, non-printable non-ASCII
5786 characters are also translated to octal form.
5788 If it->multibyte_p is zero, eight-bit characters that
5789 don't have corresponding multibyte char code are also
5790 translated to octal form. */
5791 else if ((it
->c
< ' '
5792 ? (it
->area
!= TEXT_AREA
5793 /* In mode line, treat \n, \t like other crl chars. */
5795 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5796 || (it
->c
!= '\n' && it
->c
!= '\t'))
5798 ? (!CHAR_PRINTABLE_P (it
->c
)
5799 || (!NILP (Vnobreak_char_display
)
5800 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5801 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5803 && (! unibyte_display_via_language_environment
5804 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5806 /* IT->c is a control character which must be displayed
5807 either as '\003' or as `^C' where the '\\' and '^'
5808 can be defined in the display table. Fill
5809 IT->ctl_chars with glyphs for what we have to
5810 display. Then, set IT->dpvec to these glyphs. */
5813 int face_id
, lface_id
= 0 ;
5816 /* Handle control characters with ^. */
5818 if (it
->c
< 128 && it
->ctl_arrow_p
)
5822 g
= '^'; /* default glyph for Control */
5823 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5825 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5826 && GLYPH_CODE_CHAR_VALID_P (gc
))
5828 g
= GLYPH_CODE_CHAR (gc
);
5829 lface_id
= GLYPH_CODE_FACE (gc
);
5833 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5835 else if (it
->f
== last_escape_glyph_frame
5836 && it
->face_id
== last_escape_glyph_face_id
)
5838 face_id
= last_escape_glyph_merged_face_id
;
5842 /* Merge the escape-glyph face into the current face. */
5843 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5845 last_escape_glyph_frame
= it
->f
;
5846 last_escape_glyph_face_id
= it
->face_id
;
5847 last_escape_glyph_merged_face_id
= face_id
;
5850 XSETINT (it
->ctl_chars
[0], g
);
5851 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5853 goto display_control
;
5856 /* Handle non-break space in the mode where it only gets
5859 if (EQ (Vnobreak_char_display
, Qt
)
5862 /* Merge the no-break-space face into the current face. */
5863 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5867 XSETINT (it
->ctl_chars
[0], ' ');
5869 goto display_control
;
5872 /* Handle sequences that start with the "escape glyph". */
5874 /* the default escape glyph is \. */
5875 escape_glyph
= '\\';
5878 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5879 && GLYPH_CODE_CHAR_VALID_P (gc
))
5881 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5882 lface_id
= GLYPH_CODE_FACE (gc
);
5886 /* The display table specified a face.
5887 Merge it into face_id and also into escape_glyph. */
5888 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5891 else if (it
->f
== last_escape_glyph_frame
5892 && it
->face_id
== last_escape_glyph_face_id
)
5894 face_id
= last_escape_glyph_merged_face_id
;
5898 /* Merge the escape-glyph face into the current face. */
5899 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5901 last_escape_glyph_frame
= it
->f
;
5902 last_escape_glyph_face_id
= it
->face_id
;
5903 last_escape_glyph_merged_face_id
= face_id
;
5906 /* Handle soft hyphens in the mode where they only get
5909 if (EQ (Vnobreak_char_display
, Qt
)
5913 XSETINT (it
->ctl_chars
[0], '-');
5915 goto display_control
;
5918 /* Handle non-break space and soft hyphen
5919 with the escape glyph. */
5921 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5923 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5924 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5925 XSETINT (it
->ctl_chars
[1], it
->c
);
5927 goto display_control
;
5931 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5935 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5936 if (CHAR_BYTE8_P (it
->c
))
5938 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5941 else if (it
->c
< 256)
5948 /* It's an invalid character, which shouldn't
5949 happen actually, but due to bugs it may
5950 happen. Let's print the char as is, there's
5951 not much meaningful we can do with it. */
5953 str
[1] = it
->c
>> 8;
5954 str
[2] = it
->c
>> 16;
5955 str
[3] = it
->c
>> 24;
5959 for (i
= 0; i
< len
; i
++)
5962 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5963 /* Insert three more glyphs into IT->ctl_chars for
5964 the octal display of the character. */
5965 g
= ((str
[i
] >> 6) & 7) + '0';
5966 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5967 g
= ((str
[i
] >> 3) & 7) + '0';
5968 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5969 g
= (str
[i
] & 7) + '0';
5970 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5976 /* Set up IT->dpvec and return first character from it. */
5977 it
->dpvec_char_len
= it
->len
;
5978 it
->dpvec
= it
->ctl_chars
;
5979 it
->dpend
= it
->dpvec
+ ctl_len
;
5980 it
->current
.dpvec_index
= 0;
5981 it
->dpvec_face_id
= face_id
;
5982 it
->saved_face_id
= it
->face_id
;
5983 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5990 /* Adjust face id for a multibyte character. There are no multibyte
5991 character in unibyte text. */
5992 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5995 && FRAME_WINDOW_P (it
->f
))
5997 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5998 int pos
= (it
->s
? -1
5999 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6000 : IT_CHARPOS (*it
));
6002 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6005 /* Is this character the last one of a run of characters with
6006 box? If yes, set IT->end_of_box_run_p to 1. */
6013 it
->end_of_box_run_p
6014 = ((face_id
= face_after_it_pos (it
),
6015 face_id
!= it
->face_id
)
6016 && (face
= FACE_FROM_ID (it
->f
, face_id
),
6017 face
->box
== FACE_NO_BOX
));
6020 /* Value is 0 if end of buffer or string reached. */
6025 /* Move IT to the next display element.
6027 RESEAT_P non-zero means if called on a newline in buffer text,
6028 skip to the next visible line start.
6030 Functions get_next_display_element and set_iterator_to_next are
6031 separate because I find this arrangement easier to handle than a
6032 get_next_display_element function that also increments IT's
6033 position. The way it is we can first look at an iterator's current
6034 display element, decide whether it fits on a line, and if it does,
6035 increment the iterator position. The other way around we probably
6036 would either need a flag indicating whether the iterator has to be
6037 incremented the next time, or we would have to implement a
6038 decrement position function which would not be easy to write. */
6041 set_iterator_to_next (it
, reseat_p
)
6045 /* Reset flags indicating start and end of a sequence of characters
6046 with box. Reset them at the start of this function because
6047 moving the iterator to a new position might set them. */
6048 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6052 case GET_FROM_BUFFER
:
6053 /* The current display element of IT is a character from
6054 current_buffer. Advance in the buffer, and maybe skip over
6055 invisible lines that are so because of selective display. */
6056 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6057 reseat_at_next_visible_line_start (it
, 0);
6060 xassert (it
->len
!= 0);
6061 IT_BYTEPOS (*it
) += it
->len
;
6062 IT_CHARPOS (*it
) += 1;
6063 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6067 case GET_FROM_COMPOSITION
:
6068 xassert (it
->cmp_id
>= 0 && it
->cmp_id
< n_compositions
);
6069 xassert (it
->sp
> 0);
6071 if (it
->method
== GET_FROM_STRING
)
6073 IT_STRING_BYTEPOS (*it
) += it
->len
;
6074 IT_STRING_CHARPOS (*it
) += it
->cmp_len
;
6075 goto consider_string_end
;
6077 else if (it
->method
== GET_FROM_BUFFER
)
6079 IT_BYTEPOS (*it
) += it
->len
;
6080 IT_CHARPOS (*it
) += it
->cmp_len
;
6084 case GET_FROM_C_STRING
:
6085 /* Current display element of IT is from a C string. */
6086 IT_BYTEPOS (*it
) += it
->len
;
6087 IT_CHARPOS (*it
) += 1;
6090 case GET_FROM_DISPLAY_VECTOR
:
6091 /* Current display element of IT is from a display table entry.
6092 Advance in the display table definition. Reset it to null if
6093 end reached, and continue with characters from buffers/
6095 ++it
->current
.dpvec_index
;
6097 /* Restore face of the iterator to what they were before the
6098 display vector entry (these entries may contain faces). */
6099 it
->face_id
= it
->saved_face_id
;
6101 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6103 int recheck_faces
= it
->ellipsis_p
;
6106 it
->method
= GET_FROM_C_STRING
;
6107 else if (STRINGP (it
->string
))
6108 it
->method
= GET_FROM_STRING
;
6111 it
->method
= GET_FROM_BUFFER
;
6112 it
->object
= it
->w
->buffer
;
6116 it
->current
.dpvec_index
= -1;
6118 /* Skip over characters which were displayed via IT->dpvec. */
6119 if (it
->dpvec_char_len
< 0)
6120 reseat_at_next_visible_line_start (it
, 1);
6121 else if (it
->dpvec_char_len
> 0)
6123 if (it
->method
== GET_FROM_STRING
6124 && it
->n_overlay_strings
> 0)
6125 it
->ignore_overlay_strings_at_pos_p
= 1;
6126 it
->len
= it
->dpvec_char_len
;
6127 set_iterator_to_next (it
, reseat_p
);
6130 /* Maybe recheck faces after display vector */
6132 it
->stop_charpos
= IT_CHARPOS (*it
);
6136 case GET_FROM_STRING
:
6137 /* Current display element is a character from a Lisp string. */
6138 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6139 IT_STRING_BYTEPOS (*it
) += it
->len
;
6140 IT_STRING_CHARPOS (*it
) += 1;
6142 consider_string_end
:
6144 if (it
->current
.overlay_string_index
>= 0)
6146 /* IT->string is an overlay string. Advance to the
6147 next, if there is one. */
6148 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6149 next_overlay_string (it
);
6153 /* IT->string is not an overlay string. If we reached
6154 its end, and there is something on IT->stack, proceed
6155 with what is on the stack. This can be either another
6156 string, this time an overlay string, or a buffer. */
6157 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6161 if (it
->method
== GET_FROM_STRING
)
6162 goto consider_string_end
;
6167 case GET_FROM_IMAGE
:
6168 case GET_FROM_STRETCH
:
6169 /* The position etc with which we have to proceed are on
6170 the stack. The position may be at the end of a string,
6171 if the `display' property takes up the whole string. */
6172 xassert (it
->sp
> 0);
6174 if (it
->method
== GET_FROM_STRING
)
6175 goto consider_string_end
;
6179 /* There are no other methods defined, so this should be a bug. */
6183 xassert (it
->method
!= GET_FROM_STRING
6184 || (STRINGP (it
->string
)
6185 && IT_STRING_CHARPOS (*it
) >= 0));
6188 /* Load IT's display element fields with information about the next
6189 display element which comes from a display table entry or from the
6190 result of translating a control character to one of the forms `^C'
6193 IT->dpvec holds the glyphs to return as characters.
6194 IT->saved_face_id holds the face id before the display vector--
6195 it is restored into IT->face_idin set_iterator_to_next. */
6198 next_element_from_display_vector (it
)
6204 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6206 it
->face_id
= it
->saved_face_id
;
6208 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6209 That seemed totally bogus - so I changed it... */
6211 if ((gc
= it
->dpvec
[it
->current
.dpvec_index
], GLYPH_CODE_P (gc
))
6212 && GLYPH_CODE_CHAR_VALID_P (gc
))
6214 it
->c
= GLYPH_CODE_CHAR (gc
);
6215 it
->len
= CHAR_BYTES (it
->c
);
6217 /* The entry may contain a face id to use. Such a face id is
6218 the id of a Lisp face, not a realized face. A face id of
6219 zero means no face is specified. */
6220 if (it
->dpvec_face_id
>= 0)
6221 it
->face_id
= it
->dpvec_face_id
;
6224 int lface_id
= GLYPH_CODE_FACE (gc
);
6226 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6231 /* Display table entry is invalid. Return a space. */
6232 it
->c
= ' ', it
->len
= 1;
6234 /* Don't change position and object of the iterator here. They are
6235 still the values of the character that had this display table
6236 entry or was translated, and that's what we want. */
6237 it
->what
= IT_CHARACTER
;
6242 /* Load IT with the next display element from Lisp string IT->string.
6243 IT->current.string_pos is the current position within the string.
6244 If IT->current.overlay_string_index >= 0, the Lisp string is an
6248 next_element_from_string (it
)
6251 struct text_pos position
;
6253 xassert (STRINGP (it
->string
));
6254 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6255 position
= it
->current
.string_pos
;
6257 /* Time to check for invisible text? */
6258 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6259 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6263 /* Since a handler may have changed IT->method, we must
6265 return get_next_display_element (it
);
6268 if (it
->current
.overlay_string_index
>= 0)
6270 /* Get the next character from an overlay string. In overlay
6271 strings, There is no field width or padding with spaces to
6273 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6278 else if (STRING_MULTIBYTE (it
->string
))
6280 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6281 const unsigned char *s
= (SDATA (it
->string
)
6282 + IT_STRING_BYTEPOS (*it
));
6283 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6287 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6293 /* Get the next character from a Lisp string that is not an
6294 overlay string. Such strings come from the mode line, for
6295 example. We may have to pad with spaces, or truncate the
6296 string. See also next_element_from_c_string. */
6297 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6302 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6304 /* Pad with spaces. */
6305 it
->c
= ' ', it
->len
= 1;
6306 CHARPOS (position
) = BYTEPOS (position
) = -1;
6308 else if (STRING_MULTIBYTE (it
->string
))
6310 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6311 const unsigned char *s
= (SDATA (it
->string
)
6312 + IT_STRING_BYTEPOS (*it
));
6313 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6317 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6322 /* Record what we have and where it came from. */
6323 it
->what
= IT_CHARACTER
;
6324 it
->object
= it
->string
;
6325 it
->position
= position
;
6330 /* Load IT with next display element from C string IT->s.
6331 IT->string_nchars is the maximum number of characters to return
6332 from the string. IT->end_charpos may be greater than
6333 IT->string_nchars when this function is called, in which case we
6334 may have to return padding spaces. Value is zero if end of string
6335 reached, including padding spaces. */
6338 next_element_from_c_string (it
)
6344 it
->what
= IT_CHARACTER
;
6345 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6348 /* IT's position can be greater IT->string_nchars in case a field
6349 width or precision has been specified when the iterator was
6351 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6353 /* End of the game. */
6357 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6359 /* Pad with spaces. */
6360 it
->c
= ' ', it
->len
= 1;
6361 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6363 else if (it
->multibyte_p
)
6365 /* Implementation note: The calls to strlen apparently aren't a
6366 performance problem because there is no noticeable performance
6367 difference between Emacs running in unibyte or multibyte mode. */
6368 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6369 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6373 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6379 /* Set up IT to return characters from an ellipsis, if appropriate.
6380 The definition of the ellipsis glyphs may come from a display table
6381 entry. This function Fills IT with the first glyph from the
6382 ellipsis if an ellipsis is to be displayed. */
6385 next_element_from_ellipsis (it
)
6388 if (it
->selective_display_ellipsis_p
)
6389 setup_for_ellipsis (it
, it
->len
);
6392 /* The face at the current position may be different from the
6393 face we find after the invisible text. Remember what it
6394 was in IT->saved_face_id, and signal that it's there by
6395 setting face_before_selective_p. */
6396 it
->saved_face_id
= it
->face_id
;
6397 it
->method
= GET_FROM_BUFFER
;
6398 it
->object
= it
->w
->buffer
;
6399 reseat_at_next_visible_line_start (it
, 1);
6400 it
->face_before_selective_p
= 1;
6403 return get_next_display_element (it
);
6407 /* Deliver an image display element. The iterator IT is already
6408 filled with image information (done in handle_display_prop). Value
6413 next_element_from_image (it
)
6416 it
->what
= IT_IMAGE
;
6421 /* Fill iterator IT with next display element from a stretch glyph
6422 property. IT->object is the value of the text property. Value is
6426 next_element_from_stretch (it
)
6429 it
->what
= IT_STRETCH
;
6434 /* Load IT with the next display element from current_buffer. Value
6435 is zero if end of buffer reached. IT->stop_charpos is the next
6436 position at which to stop and check for text properties or buffer
6440 next_element_from_buffer (it
)
6445 /* Check this assumption, otherwise, we would never enter the
6446 if-statement, below. */
6447 xassert (IT_CHARPOS (*it
) >= BEGV
6448 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6450 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6452 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6454 int overlay_strings_follow_p
;
6456 /* End of the game, except when overlay strings follow that
6457 haven't been returned yet. */
6458 if (it
->overlay_strings_at_end_processed_p
)
6459 overlay_strings_follow_p
= 0;
6462 it
->overlay_strings_at_end_processed_p
= 1;
6463 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6466 if (overlay_strings_follow_p
)
6467 success_p
= get_next_display_element (it
);
6471 it
->position
= it
->current
.pos
;
6478 return get_next_display_element (it
);
6483 /* No face changes, overlays etc. in sight, so just return a
6484 character from current_buffer. */
6487 /* Maybe run the redisplay end trigger hook. Performance note:
6488 This doesn't seem to cost measurable time. */
6489 if (it
->redisplay_end_trigger_charpos
6491 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6492 run_redisplay_end_trigger_hook (it
);
6494 /* Get the next character, maybe multibyte. */
6495 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6496 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6498 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT_BYTE
? ZV_BYTE
: GPT_BYTE
)
6499 - IT_BYTEPOS (*it
));
6500 it
->c
= string_char_and_length (p
, maxlen
, &it
->len
);
6503 it
->c
= *p
, it
->len
= 1;
6505 /* Record what we have and where it came from. */
6506 it
->what
= IT_CHARACTER
;
6507 it
->object
= it
->w
->buffer
;
6508 it
->position
= it
->current
.pos
;
6510 /* Normally we return the character found above, except when we
6511 really want to return an ellipsis for selective display. */
6516 /* A value of selective > 0 means hide lines indented more
6517 than that number of columns. */
6518 if (it
->selective
> 0
6519 && IT_CHARPOS (*it
) + 1 < ZV
6520 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6521 IT_BYTEPOS (*it
) + 1,
6522 (double) it
->selective
)) /* iftc */
6524 success_p
= next_element_from_ellipsis (it
);
6525 it
->dpvec_char_len
= -1;
6528 else if (it
->c
== '\r' && it
->selective
== -1)
6530 /* A value of selective == -1 means that everything from the
6531 CR to the end of the line is invisible, with maybe an
6532 ellipsis displayed for it. */
6533 success_p
= next_element_from_ellipsis (it
);
6534 it
->dpvec_char_len
= -1;
6539 /* Value is zero if end of buffer reached. */
6540 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6545 /* Run the redisplay end trigger hook for IT. */
6548 run_redisplay_end_trigger_hook (it
)
6551 Lisp_Object args
[3];
6553 /* IT->glyph_row should be non-null, i.e. we should be actually
6554 displaying something, or otherwise we should not run the hook. */
6555 xassert (it
->glyph_row
);
6557 /* Set up hook arguments. */
6558 args
[0] = Qredisplay_end_trigger_functions
;
6559 args
[1] = it
->window
;
6560 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6561 it
->redisplay_end_trigger_charpos
= 0;
6563 /* Since we are *trying* to run these functions, don't try to run
6564 them again, even if they get an error. */
6565 it
->w
->redisplay_end_trigger
= Qnil
;
6566 Frun_hook_with_args (3, args
);
6568 /* Notice if it changed the face of the character we are on. */
6569 handle_face_prop (it
);
6573 /* Deliver a composition display element. The iterator IT is already
6574 filled with composition information (done in
6575 handle_composition_prop). Value is always 1. */
6578 next_element_from_composition (it
)
6581 it
->what
= IT_COMPOSITION
;
6582 it
->position
= (STRINGP (it
->string
)
6583 ? it
->current
.string_pos
6585 if (STRINGP (it
->string
))
6586 it
->object
= it
->string
;
6588 it
->object
= it
->w
->buffer
;
6594 /***********************************************************************
6595 Moving an iterator without producing glyphs
6596 ***********************************************************************/
6598 /* Check if iterator is at a position corresponding to a valid buffer
6599 position after some move_it_ call. */
6601 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6602 ((it)->method == GET_FROM_STRING \
6603 ? IT_STRING_CHARPOS (*it) == 0 \
6607 /* Move iterator IT to a specified buffer or X position within one
6608 line on the display without producing glyphs.
6610 OP should be a bit mask including some or all of these bits:
6611 MOVE_TO_X: Stop on reaching x-position TO_X.
6612 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6613 Regardless of OP's value, stop in reaching the end of the display line.
6615 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6616 This means, in particular, that TO_X includes window's horizontal
6619 The return value has several possible values that
6620 say what condition caused the scan to stop:
6622 MOVE_POS_MATCH_OR_ZV
6623 - when TO_POS or ZV was reached.
6626 -when TO_X was reached before TO_POS or ZV were reached.
6629 - when we reached the end of the display area and the line must
6633 - when we reached the end of the display area and the line is
6637 - when we stopped at a line end, i.e. a newline or a CR and selective
6640 static enum move_it_result
6641 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
)
6643 int to_charpos
, to_x
, op
;
6645 enum move_it_result result
= MOVE_UNDEFINED
;
6646 struct glyph_row
*saved_glyph_row
;
6648 /* Don't produce glyphs in produce_glyphs. */
6649 saved_glyph_row
= it
->glyph_row
;
6650 it
->glyph_row
= NULL
;
6652 #define BUFFER_POS_REACHED_P() \
6653 ((op & MOVE_TO_POS) != 0 \
6654 && BUFFERP (it->object) \
6655 && IT_CHARPOS (*it) >= to_charpos \
6656 && (it->method == GET_FROM_BUFFER \
6657 || (it->method == GET_FROM_DISPLAY_VECTOR \
6658 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6663 int x
, i
, ascent
= 0, descent
= 0;
6665 /* Stop if we move beyond TO_CHARPOS (after an image or stretch glyph). */
6666 if ((op
& MOVE_TO_POS
) != 0
6667 && BUFFERP (it
->object
)
6668 && it
->method
== GET_FROM_BUFFER
6669 && IT_CHARPOS (*it
) > to_charpos
)
6671 result
= MOVE_POS_MATCH_OR_ZV
;
6675 /* Stop when ZV reached.
6676 We used to stop here when TO_CHARPOS reached as well, but that is
6677 too soon if this glyph does not fit on this line. So we handle it
6678 explicitly below. */
6679 if (!get_next_display_element (it
)
6680 || (it
->truncate_lines_p
6681 && BUFFER_POS_REACHED_P ()))
6683 result
= MOVE_POS_MATCH_OR_ZV
;
6687 /* The call to produce_glyphs will get the metrics of the
6688 display element IT is loaded with. We record in x the
6689 x-position before this display element in case it does not
6693 /* Remember the line height so far in case the next element doesn't
6695 if (!it
->truncate_lines_p
)
6697 ascent
= it
->max_ascent
;
6698 descent
= it
->max_descent
;
6701 PRODUCE_GLYPHS (it
);
6703 if (it
->area
!= TEXT_AREA
)
6705 set_iterator_to_next (it
, 1);
6709 /* The number of glyphs we get back in IT->nglyphs will normally
6710 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6711 character on a terminal frame, or (iii) a line end. For the
6712 second case, IT->nglyphs - 1 padding glyphs will be present
6713 (on X frames, there is only one glyph produced for a
6714 composite character.
6716 The behavior implemented below means, for continuation lines,
6717 that as many spaces of a TAB as fit on the current line are
6718 displayed there. For terminal frames, as many glyphs of a
6719 multi-glyph character are displayed in the current line, too.
6720 This is what the old redisplay code did, and we keep it that
6721 way. Under X, the whole shape of a complex character must
6722 fit on the line or it will be completely displayed in the
6725 Note that both for tabs and padding glyphs, all glyphs have
6729 /* More than one glyph or glyph doesn't fit on line. All
6730 glyphs have the same width. */
6731 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6733 int x_before_this_char
= x
;
6734 int hpos_before_this_char
= it
->hpos
;
6736 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6738 new_x
= x
+ single_glyph_width
;
6740 /* We want to leave anything reaching TO_X to the caller. */
6741 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6743 if (BUFFER_POS_REACHED_P ())
6744 goto buffer_pos_reached
;
6746 result
= MOVE_X_REACHED
;
6749 else if (/* Lines are continued. */
6750 !it
->truncate_lines_p
6751 && (/* And glyph doesn't fit on the line. */
6752 new_x
> it
->last_visible_x
6753 /* Or it fits exactly and we're on a window
6755 || (new_x
== it
->last_visible_x
6756 && FRAME_WINDOW_P (it
->f
))))
6758 if (/* IT->hpos == 0 means the very first glyph
6759 doesn't fit on the line, e.g. a wide image. */
6761 || (new_x
== it
->last_visible_x
6762 && FRAME_WINDOW_P (it
->f
)))
6765 it
->current_x
= new_x
;
6767 /* The character's last glyph just barely fits
6769 if (i
== it
->nglyphs
- 1)
6771 /* If this is the destination position,
6772 return a position *before* it in this row,
6773 now that we know it fits in this row. */
6774 if (BUFFER_POS_REACHED_P ())
6776 it
->hpos
= hpos_before_this_char
;
6777 it
->current_x
= x_before_this_char
;
6778 result
= MOVE_POS_MATCH_OR_ZV
;
6782 set_iterator_to_next (it
, 1);
6783 #ifdef HAVE_WINDOW_SYSTEM
6784 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6786 if (!get_next_display_element (it
))
6788 result
= MOVE_POS_MATCH_OR_ZV
;
6791 if (BUFFER_POS_REACHED_P ())
6793 if (ITERATOR_AT_END_OF_LINE_P (it
))
6794 result
= MOVE_POS_MATCH_OR_ZV
;
6796 result
= MOVE_LINE_CONTINUED
;
6799 if (ITERATOR_AT_END_OF_LINE_P (it
))
6801 result
= MOVE_NEWLINE_OR_CR
;
6805 #endif /* HAVE_WINDOW_SYSTEM */
6811 it
->max_ascent
= ascent
;
6812 it
->max_descent
= descent
;
6815 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6817 result
= MOVE_LINE_CONTINUED
;
6820 else if (BUFFER_POS_REACHED_P ())
6821 goto buffer_pos_reached
;
6822 else if (new_x
> it
->first_visible_x
)
6824 /* Glyph is visible. Increment number of glyphs that
6825 would be displayed. */
6830 /* Glyph is completely off the left margin of the display
6831 area. Nothing to do. */
6835 if (result
!= MOVE_UNDEFINED
)
6838 else if (BUFFER_POS_REACHED_P ())
6842 it
->max_ascent
= ascent
;
6843 it
->max_descent
= descent
;
6844 result
= MOVE_POS_MATCH_OR_ZV
;
6847 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6849 /* Stop when TO_X specified and reached. This check is
6850 necessary here because of lines consisting of a line end,
6851 only. The line end will not produce any glyphs and we
6852 would never get MOVE_X_REACHED. */
6853 xassert (it
->nglyphs
== 0);
6854 result
= MOVE_X_REACHED
;
6858 /* Is this a line end? If yes, we're done. */
6859 if (ITERATOR_AT_END_OF_LINE_P (it
))
6861 result
= MOVE_NEWLINE_OR_CR
;
6865 /* The current display element has been consumed. Advance
6867 set_iterator_to_next (it
, 1);
6869 /* Stop if lines are truncated and IT's current x-position is
6870 past the right edge of the window now. */
6871 if (it
->truncate_lines_p
6872 && it
->current_x
>= it
->last_visible_x
)
6874 #ifdef HAVE_WINDOW_SYSTEM
6875 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6877 if (!get_next_display_element (it
)
6878 || BUFFER_POS_REACHED_P ())
6880 result
= MOVE_POS_MATCH_OR_ZV
;
6883 if (ITERATOR_AT_END_OF_LINE_P (it
))
6885 result
= MOVE_NEWLINE_OR_CR
;
6889 #endif /* HAVE_WINDOW_SYSTEM */
6890 result
= MOVE_LINE_TRUNCATED
;
6895 #undef BUFFER_POS_REACHED_P
6897 /* Restore the iterator settings altered at the beginning of this
6899 it
->glyph_row
= saved_glyph_row
;
6904 /* Move IT forward until it satisfies one or more of the criteria in
6905 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
6907 OP is a bit-mask that specifies where to stop, and in particular,
6908 which of those four position arguments makes a difference. See the
6909 description of enum move_operation_enum.
6911 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
6912 screen line, this function will set IT to the next position >
6916 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
6918 int to_charpos
, to_x
, to_y
, to_vpos
;
6921 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
6927 if (op
& MOVE_TO_VPOS
)
6929 /* If no TO_CHARPOS and no TO_X specified, stop at the
6930 start of the line TO_VPOS. */
6931 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
6933 if (it
->vpos
== to_vpos
)
6939 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
6943 /* TO_VPOS >= 0 means stop at TO_X in the line at
6944 TO_VPOS, or at TO_POS, whichever comes first. */
6945 if (it
->vpos
== to_vpos
)
6951 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
6953 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
6958 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
6960 /* We have reached TO_X but not in the line we want. */
6961 skip
= move_it_in_display_line_to (it
, to_charpos
,
6963 if (skip
== MOVE_POS_MATCH_OR_ZV
)
6971 else if (op
& MOVE_TO_Y
)
6973 struct it it_backup
;
6975 /* TO_Y specified means stop at TO_X in the line containing
6976 TO_Y---or at TO_CHARPOS if this is reached first. The
6977 problem is that we can't really tell whether the line
6978 contains TO_Y before we have completely scanned it, and
6979 this may skip past TO_X. What we do is to first scan to
6982 If TO_X is not specified, use a TO_X of zero. The reason
6983 is to make the outcome of this function more predictable.
6984 If we didn't use TO_X == 0, we would stop at the end of
6985 the line which is probably not what a caller would expect
6987 skip
= move_it_in_display_line_to (it
, to_charpos
,
6991 | (op
& MOVE_TO_POS
)));
6993 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
6994 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7000 /* If TO_X was reached, we would like to know whether TO_Y
7001 is in the line. This can only be said if we know the
7002 total line height which requires us to scan the rest of
7004 if (skip
== MOVE_X_REACHED
)
7006 /* Wait! We can conclude that TO_Y is in the line if
7007 the already scanned glyphs make the line tall enough
7008 because further scanning doesn't make it shorter. */
7009 line_height
= it
->max_ascent
+ it
->max_descent
;
7010 if (to_y
>= it
->current_y
7011 && to_y
< it
->current_y
+ line_height
)
7017 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7018 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7020 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7023 /* Now, decide whether TO_Y is in this line. */
7024 line_height
= it
->max_ascent
+ it
->max_descent
;
7025 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7027 if (to_y
>= it
->current_y
7028 && to_y
< it
->current_y
+ line_height
)
7030 if (skip
== MOVE_X_REACHED
)
7031 /* If TO_Y is in this line and TO_X was reached above,
7032 we scanned too far. We have to restore IT's settings
7033 to the ones before skipping. */
7037 else if (skip
== MOVE_X_REACHED
)
7040 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7047 else if (BUFFERP (it
->object
)
7048 && it
->method
== GET_FROM_BUFFER
7049 && IT_CHARPOS (*it
) >= to_charpos
)
7050 skip
= MOVE_POS_MATCH_OR_ZV
;
7052 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7056 case MOVE_POS_MATCH_OR_ZV
:
7060 case MOVE_NEWLINE_OR_CR
:
7061 set_iterator_to_next (it
, 1);
7062 it
->continuation_lines_width
= 0;
7065 case MOVE_LINE_TRUNCATED
:
7066 it
->continuation_lines_width
= 0;
7067 reseat_at_next_visible_line_start (it
, 0);
7068 if ((op
& MOVE_TO_POS
) != 0
7069 && IT_CHARPOS (*it
) > to_charpos
)
7076 case MOVE_LINE_CONTINUED
:
7077 /* For continued lines ending in a tab, some of the glyphs
7078 associated with the tab are displayed on the current
7079 line. Since it->current_x does not include these glyphs,
7080 we use it->last_visible_x instead. */
7081 it
->continuation_lines_width
+=
7082 (it
->c
== '\t') ? it
->last_visible_x
: it
->current_x
;
7089 /* Reset/increment for the next run. */
7090 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7091 it
->current_x
= it
->hpos
= 0;
7092 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7094 last_height
= it
->max_ascent
+ it
->max_descent
;
7095 last_max_ascent
= it
->max_ascent
;
7096 it
->max_ascent
= it
->max_descent
= 0;
7101 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7105 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7107 If DY > 0, move IT backward at least that many pixels. DY = 0
7108 means move IT backward to the preceding line start or BEGV. This
7109 function may move over more than DY pixels if IT->current_y - DY
7110 ends up in the middle of a line; in this case IT->current_y will be
7111 set to the top of the line moved to. */
7114 move_it_vertically_backward (it
, dy
)
7125 start_pos
= IT_CHARPOS (*it
);
7127 /* Estimate how many newlines we must move back. */
7128 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7130 /* Set the iterator's position that many lines back. */
7131 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7132 back_to_previous_visible_line_start (it
);
7134 /* Reseat the iterator here. When moving backward, we don't want
7135 reseat to skip forward over invisible text, set up the iterator
7136 to deliver from overlay strings at the new position etc. So,
7137 use reseat_1 here. */
7138 reseat_1 (it
, it
->current
.pos
, 1);
7140 /* We are now surely at a line start. */
7141 it
->current_x
= it
->hpos
= 0;
7142 it
->continuation_lines_width
= 0;
7144 /* Move forward and see what y-distance we moved. First move to the
7145 start of the next line so that we get its height. We need this
7146 height to be able to tell whether we reached the specified
7149 it2
.max_ascent
= it2
.max_descent
= 0;
7152 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7153 MOVE_TO_POS
| MOVE_TO_VPOS
);
7155 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7156 xassert (IT_CHARPOS (*it
) >= BEGV
);
7159 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7160 xassert (IT_CHARPOS (*it
) >= BEGV
);
7161 /* H is the actual vertical distance from the position in *IT
7162 and the starting position. */
7163 h
= it2
.current_y
- it
->current_y
;
7164 /* NLINES is the distance in number of lines. */
7165 nlines
= it2
.vpos
- it
->vpos
;
7167 /* Correct IT's y and vpos position
7168 so that they are relative to the starting point. */
7174 /* DY == 0 means move to the start of the screen line. The
7175 value of nlines is > 0 if continuation lines were involved. */
7177 move_it_by_lines (it
, nlines
, 1);
7179 /* I think this assert is bogus if buffer contains
7180 invisible text or images. KFS. */
7181 xassert (IT_CHARPOS (*it
) <= start_pos
);
7186 /* The y-position we try to reach, relative to *IT.
7187 Note that H has been subtracted in front of the if-statement. */
7188 int target_y
= it
->current_y
+ h
- dy
;
7189 int y0
= it3
.current_y
;
7190 int y1
= line_bottom_y (&it3
);
7191 int line_height
= y1
- y0
;
7193 /* If we did not reach target_y, try to move further backward if
7194 we can. If we moved too far backward, try to move forward. */
7195 if (target_y
< it
->current_y
7196 /* This is heuristic. In a window that's 3 lines high, with
7197 a line height of 13 pixels each, recentering with point
7198 on the bottom line will try to move -39/2 = 19 pixels
7199 backward. Try to avoid moving into the first line. */
7200 && (it
->current_y
- target_y
7201 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7202 && IT_CHARPOS (*it
) > BEGV
)
7204 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7205 target_y
- it
->current_y
));
7206 dy
= it
->current_y
- target_y
;
7207 goto move_further_back
;
7209 else if (target_y
>= it
->current_y
+ line_height
7210 && IT_CHARPOS (*it
) < ZV
)
7212 /* Should move forward by at least one line, maybe more.
7214 Note: Calling move_it_by_lines can be expensive on
7215 terminal frames, where compute_motion is used (via
7216 vmotion) to do the job, when there are very long lines
7217 and truncate-lines is nil. That's the reason for
7218 treating terminal frames specially here. */
7220 if (!FRAME_WINDOW_P (it
->f
))
7221 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7226 move_it_by_lines (it
, 1, 1);
7228 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7232 /* I think this assert is bogus if buffer contains
7233 invisible text or images. KFS. */
7234 xassert (IT_CHARPOS (*it
) >= BEGV
);
7241 /* Move IT by a specified amount of pixel lines DY. DY negative means
7242 move backwards. DY = 0 means move to start of screen line. At the
7243 end, IT will be on the start of a screen line. */
7246 move_it_vertically (it
, dy
)
7251 move_it_vertically_backward (it
, -dy
);
7254 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7255 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7256 MOVE_TO_POS
| MOVE_TO_Y
);
7257 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7259 /* If buffer ends in ZV without a newline, move to the start of
7260 the line to satisfy the post-condition. */
7261 if (IT_CHARPOS (*it
) == ZV
7263 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7264 move_it_by_lines (it
, 0, 0);
7269 /* Move iterator IT past the end of the text line it is in. */
7272 move_it_past_eol (it
)
7275 enum move_it_result rc
;
7277 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7278 if (rc
== MOVE_NEWLINE_OR_CR
)
7279 set_iterator_to_next (it
, 0);
7283 #if 0 /* Currently not used. */
7285 /* Return non-zero if some text between buffer positions START_CHARPOS
7286 and END_CHARPOS is invisible. IT->window is the window for text
7290 invisible_text_between_p (it
, start_charpos
, end_charpos
)
7292 int start_charpos
, end_charpos
;
7294 Lisp_Object prop
, limit
;
7295 int invisible_found_p
;
7297 xassert (it
!= NULL
&& start_charpos
<= end_charpos
);
7299 /* Is text at START invisible? */
7300 prop
= Fget_char_property (make_number (start_charpos
), Qinvisible
,
7302 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
7303 invisible_found_p
= 1;
7306 limit
= Fnext_single_char_property_change (make_number (start_charpos
),
7308 make_number (end_charpos
));
7309 invisible_found_p
= XFASTINT (limit
) < end_charpos
;
7312 return invisible_found_p
;
7318 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7319 negative means move up. DVPOS == 0 means move to the start of the
7320 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7321 NEED_Y_P is zero, IT->current_y will be left unchanged.
7323 Further optimization ideas: If we would know that IT->f doesn't use
7324 a face with proportional font, we could be faster for
7325 truncate-lines nil. */
7328 move_it_by_lines (it
, dvpos
, need_y_p
)
7330 int dvpos
, need_y_p
;
7332 struct position pos
;
7334 /* The commented-out optimization uses vmotion on terminals. This
7335 gives bad results, because elements like it->what, on which
7336 callers such as pos_visible_p rely, aren't updated. */
7337 /* if (!FRAME_WINDOW_P (it->f))
7339 struct text_pos textpos;
7341 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7342 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7343 reseat (it, textpos, 1);
7344 it->vpos += pos.vpos;
7345 it->current_y += pos.vpos;
7351 /* DVPOS == 0 means move to the start of the screen line. */
7352 move_it_vertically_backward (it
, 0);
7353 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7354 /* Let next call to line_bottom_y calculate real line height */
7359 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7360 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7361 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7366 int start_charpos
, i
;
7368 /* Start at the beginning of the screen line containing IT's
7369 position. This may actually move vertically backwards,
7370 in case of overlays, so adjust dvpos accordingly. */
7372 move_it_vertically_backward (it
, 0);
7375 /* Go back -DVPOS visible lines and reseat the iterator there. */
7376 start_charpos
= IT_CHARPOS (*it
);
7377 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7378 back_to_previous_visible_line_start (it
);
7379 reseat (it
, it
->current
.pos
, 1);
7381 /* Move further back if we end up in a string or an image. */
7382 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7384 /* First try to move to start of display line. */
7386 move_it_vertically_backward (it
, 0);
7388 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7390 /* If start of line is still in string or image,
7391 move further back. */
7392 back_to_previous_visible_line_start (it
);
7393 reseat (it
, it
->current
.pos
, 1);
7397 it
->current_x
= it
->hpos
= 0;
7399 /* Above call may have moved too far if continuation lines
7400 are involved. Scan forward and see if it did. */
7402 it2
.vpos
= it2
.current_y
= 0;
7403 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7404 it
->vpos
-= it2
.vpos
;
7405 it
->current_y
-= it2
.current_y
;
7406 it
->current_x
= it
->hpos
= 0;
7408 /* If we moved too far back, move IT some lines forward. */
7409 if (it2
.vpos
> -dvpos
)
7411 int delta
= it2
.vpos
+ dvpos
;
7413 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7414 /* Move back again if we got too far ahead. */
7415 if (IT_CHARPOS (*it
) >= start_charpos
)
7421 /* Return 1 if IT points into the middle of a display vector. */
7424 in_display_vector_p (it
)
7427 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7428 && it
->current
.dpvec_index
> 0
7429 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7433 /***********************************************************************
7435 ***********************************************************************/
7438 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7442 add_to_log (format
, arg1
, arg2
)
7444 Lisp_Object arg1
, arg2
;
7446 Lisp_Object args
[3];
7447 Lisp_Object msg
, fmt
;
7450 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7453 /* Do nothing if called asynchronously. Inserting text into
7454 a buffer may call after-change-functions and alike and
7455 that would means running Lisp asynchronously. */
7456 if (handling_signal
)
7460 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7462 args
[0] = fmt
= build_string (format
);
7465 msg
= Fformat (3, args
);
7467 len
= SBYTES (msg
) + 1;
7468 SAFE_ALLOCA (buffer
, char *, len
);
7469 bcopy (SDATA (msg
), buffer
, len
);
7471 message_dolog (buffer
, len
- 1, 1, 0);
7478 /* Output a newline in the *Messages* buffer if "needs" one. */
7481 message_log_maybe_newline ()
7483 if (message_log_need_newline
)
7484 message_dolog ("", 0, 1, 0);
7488 /* Add a string M of length NBYTES to the message log, optionally
7489 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7490 nonzero, means interpret the contents of M as multibyte. This
7491 function calls low-level routines in order to bypass text property
7492 hooks, etc. which might not be safe to run.
7494 This may GC (insert may run before/after change hooks),
7495 so the buffer M must NOT point to a Lisp string. */
7498 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7500 int nbytes
, nlflag
, multibyte
;
7502 if (!NILP (Vmemory_full
))
7505 if (!NILP (Vmessage_log_max
))
7507 struct buffer
*oldbuf
;
7508 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7509 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7510 int point_at_end
= 0;
7512 Lisp_Object old_deactivate_mark
, tem
;
7513 struct gcpro gcpro1
;
7515 old_deactivate_mark
= Vdeactivate_mark
;
7516 oldbuf
= current_buffer
;
7517 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7518 current_buffer
->undo_list
= Qt
;
7520 oldpoint
= message_dolog_marker1
;
7521 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7522 oldbegv
= message_dolog_marker2
;
7523 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7524 oldzv
= message_dolog_marker3
;
7525 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7526 GCPRO1 (old_deactivate_mark
);
7534 BEGV_BYTE
= BEG_BYTE
;
7537 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7539 /* Insert the string--maybe converting multibyte to single byte
7540 or vice versa, so that all the text fits the buffer. */
7542 && NILP (current_buffer
->enable_multibyte_characters
))
7544 int i
, c
, char_bytes
;
7545 unsigned char work
[1];
7547 /* Convert a multibyte string to single-byte
7548 for the *Message* buffer. */
7549 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7551 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7552 work
[0] = (ASCII_CHAR_P (c
)
7554 : multibyte_char_to_unibyte (c
, Qnil
));
7555 insert_1_both (work
, 1, 1, 1, 0, 0);
7558 else if (! multibyte
7559 && ! NILP (current_buffer
->enable_multibyte_characters
))
7561 int i
, c
, char_bytes
;
7562 unsigned char *msg
= (unsigned char *) m
;
7563 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7564 /* Convert a single-byte string to multibyte
7565 for the *Message* buffer. */
7566 for (i
= 0; i
< nbytes
; i
++)
7569 c
= unibyte_char_to_multibyte (c
);
7570 char_bytes
= CHAR_STRING (c
, str
);
7571 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7575 insert_1 (m
, nbytes
, 1, 0, 0);
7579 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7580 insert_1 ("\n", 1, 1, 0, 0);
7582 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7584 this_bol_byte
= PT_BYTE
;
7586 /* See if this line duplicates the previous one.
7587 If so, combine duplicates. */
7590 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7592 prev_bol_byte
= PT_BYTE
;
7594 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7595 this_bol
, this_bol_byte
);
7598 del_range_both (prev_bol
, prev_bol_byte
,
7599 this_bol
, this_bol_byte
, 0);
7605 /* If you change this format, don't forget to also
7606 change message_log_check_duplicate. */
7607 sprintf (dupstr
, " [%d times]", dup
);
7608 duplen
= strlen (dupstr
);
7609 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7610 insert_1 (dupstr
, duplen
, 1, 0, 1);
7615 /* If we have more than the desired maximum number of lines
7616 in the *Messages* buffer now, delete the oldest ones.
7617 This is safe because we don't have undo in this buffer. */
7619 if (NATNUMP (Vmessage_log_max
))
7621 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7622 -XFASTINT (Vmessage_log_max
) - 1, 0);
7623 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7626 BEGV
= XMARKER (oldbegv
)->charpos
;
7627 BEGV_BYTE
= marker_byte_position (oldbegv
);
7636 ZV
= XMARKER (oldzv
)->charpos
;
7637 ZV_BYTE
= marker_byte_position (oldzv
);
7641 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7643 /* We can't do Fgoto_char (oldpoint) because it will run some
7645 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7646 XMARKER (oldpoint
)->bytepos
);
7649 unchain_marker (XMARKER (oldpoint
));
7650 unchain_marker (XMARKER (oldbegv
));
7651 unchain_marker (XMARKER (oldzv
));
7653 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7654 set_buffer_internal (oldbuf
);
7656 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7657 message_log_need_newline
= !nlflag
;
7658 Vdeactivate_mark
= old_deactivate_mark
;
7663 /* We are at the end of the buffer after just having inserted a newline.
7664 (Note: We depend on the fact we won't be crossing the gap.)
7665 Check to see if the most recent message looks a lot like the previous one.
7666 Return 0 if different, 1 if the new one should just replace it, or a
7667 value N > 1 if we should also append " [N times]". */
7670 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7671 int prev_bol
, this_bol
;
7672 int prev_bol_byte
, this_bol_byte
;
7675 int len
= Z_BYTE
- 1 - this_bol_byte
;
7677 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7678 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7680 for (i
= 0; i
< len
; i
++)
7682 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7690 if (*p1
++ == ' ' && *p1
++ == '[')
7693 while (*p1
>= '0' && *p1
<= '9')
7694 n
= n
* 10 + *p1
++ - '0';
7695 if (strncmp (p1
, " times]\n", 8) == 0)
7702 /* Display an echo area message M with a specified length of NBYTES
7703 bytes. The string may include null characters. If M is 0, clear
7704 out any existing message, and let the mini-buffer text show
7707 This may GC, so the buffer M must NOT point to a Lisp string. */
7710 message2 (m
, nbytes
, multibyte
)
7715 /* First flush out any partial line written with print. */
7716 message_log_maybe_newline ();
7718 message_dolog (m
, nbytes
, 1, multibyte
);
7719 message2_nolog (m
, nbytes
, multibyte
);
7723 /* The non-logging counterpart of message2. */
7726 message2_nolog (m
, nbytes
, multibyte
)
7728 int nbytes
, multibyte
;
7730 struct frame
*sf
= SELECTED_FRAME ();
7731 message_enable_multibyte
= multibyte
;
7735 if (noninteractive_need_newline
)
7736 putc ('\n', stderr
);
7737 noninteractive_need_newline
= 0;
7739 fwrite (m
, nbytes
, 1, stderr
);
7740 if (cursor_in_echo_area
== 0)
7741 fprintf (stderr
, "\n");
7744 /* A null message buffer means that the frame hasn't really been
7745 initialized yet. Error messages get reported properly by
7746 cmd_error, so this must be just an informative message; toss it. */
7747 else if (INTERACTIVE
7748 && sf
->glyphs_initialized_p
7749 && FRAME_MESSAGE_BUF (sf
))
7751 Lisp_Object mini_window
;
7754 /* Get the frame containing the mini-buffer
7755 that the selected frame is using. */
7756 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7757 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7759 FRAME_SAMPLE_VISIBILITY (f
);
7760 if (FRAME_VISIBLE_P (sf
)
7761 && ! FRAME_VISIBLE_P (f
))
7762 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7766 set_message (m
, Qnil
, nbytes
, multibyte
);
7767 if (minibuffer_auto_raise
)
7768 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7771 clear_message (1, 1);
7773 do_pending_window_change (0);
7774 echo_area_display (1);
7775 do_pending_window_change (0);
7776 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7777 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7782 /* Display an echo area message M with a specified length of NBYTES
7783 bytes. The string may include null characters. If M is not a
7784 string, clear out any existing message, and let the mini-buffer
7787 This function cancels echoing. */
7790 message3 (m
, nbytes
, multibyte
)
7795 struct gcpro gcpro1
;
7798 clear_message (1,1);
7801 /* First flush out any partial line written with print. */
7802 message_log_maybe_newline ();
7808 SAFE_ALLOCA (buffer
, char *, nbytes
);
7809 bcopy (SDATA (m
), buffer
, nbytes
);
7810 message_dolog (buffer
, nbytes
, 1, multibyte
);
7813 message3_nolog (m
, nbytes
, multibyte
);
7819 /* The non-logging version of message3.
7820 This does not cancel echoing, because it is used for echoing.
7821 Perhaps we need to make a separate function for echoing
7822 and make this cancel echoing. */
7825 message3_nolog (m
, nbytes
, multibyte
)
7827 int nbytes
, multibyte
;
7829 struct frame
*sf
= SELECTED_FRAME ();
7830 message_enable_multibyte
= multibyte
;
7834 if (noninteractive_need_newline
)
7835 putc ('\n', stderr
);
7836 noninteractive_need_newline
= 0;
7838 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7839 if (cursor_in_echo_area
== 0)
7840 fprintf (stderr
, "\n");
7843 /* A null message buffer means that the frame hasn't really been
7844 initialized yet. Error messages get reported properly by
7845 cmd_error, so this must be just an informative message; toss it. */
7846 else if (INTERACTIVE
7847 && sf
->glyphs_initialized_p
7848 && FRAME_MESSAGE_BUF (sf
))
7850 Lisp_Object mini_window
;
7854 /* Get the frame containing the mini-buffer
7855 that the selected frame is using. */
7856 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7857 frame
= XWINDOW (mini_window
)->frame
;
7860 FRAME_SAMPLE_VISIBILITY (f
);
7861 if (FRAME_VISIBLE_P (sf
)
7862 && !FRAME_VISIBLE_P (f
))
7863 Fmake_frame_visible (frame
);
7865 if (STRINGP (m
) && SCHARS (m
) > 0)
7867 set_message (NULL
, m
, nbytes
, multibyte
);
7868 if (minibuffer_auto_raise
)
7869 Fraise_frame (frame
);
7870 /* Assume we are not echoing.
7871 (If we are, echo_now will override this.) */
7872 echo_message_buffer
= Qnil
;
7875 clear_message (1, 1);
7877 do_pending_window_change (0);
7878 echo_area_display (1);
7879 do_pending_window_change (0);
7880 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7881 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7886 /* Display a null-terminated echo area message M. If M is 0, clear
7887 out any existing message, and let the mini-buffer text show through.
7889 The buffer M must continue to exist until after the echo area gets
7890 cleared or some other message gets displayed there. Do not pass
7891 text that is stored in a Lisp string. Do not pass text in a buffer
7892 that was alloca'd. */
7898 message2 (m
, (m
? strlen (m
) : 0), 0);
7902 /* The non-logging counterpart of message1. */
7908 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
7911 /* Display a message M which contains a single %s
7912 which gets replaced with STRING. */
7915 message_with_string (m
, string
, log
)
7920 CHECK_STRING (string
);
7926 if (noninteractive_need_newline
)
7927 putc ('\n', stderr
);
7928 noninteractive_need_newline
= 0;
7929 fprintf (stderr
, m
, SDATA (string
));
7930 if (cursor_in_echo_area
== 0)
7931 fprintf (stderr
, "\n");
7935 else if (INTERACTIVE
)
7937 /* The frame whose minibuffer we're going to display the message on.
7938 It may be larger than the selected frame, so we need
7939 to use its buffer, not the selected frame's buffer. */
7940 Lisp_Object mini_window
;
7941 struct frame
*f
, *sf
= SELECTED_FRAME ();
7943 /* Get the frame containing the minibuffer
7944 that the selected frame is using. */
7945 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7946 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7948 /* A null message buffer means that the frame hasn't really been
7949 initialized yet. Error messages get reported properly by
7950 cmd_error, so this must be just an informative message; toss it. */
7951 if (FRAME_MESSAGE_BUF (f
))
7953 Lisp_Object args
[2], message
;
7954 struct gcpro gcpro1
, gcpro2
;
7956 args
[0] = build_string (m
);
7957 args
[1] = message
= string
;
7958 GCPRO2 (args
[0], message
);
7961 message
= Fformat (2, args
);
7964 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7966 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
7970 /* Print should start at the beginning of the message
7971 buffer next time. */
7972 message_buf_print
= 0;
7978 /* Dump an informative message to the minibuf. If M is 0, clear out
7979 any existing message, and let the mini-buffer text show through. */
7983 message (m
, a1
, a2
, a3
)
7985 EMACS_INT a1
, a2
, a3
;
7991 if (noninteractive_need_newline
)
7992 putc ('\n', stderr
);
7993 noninteractive_need_newline
= 0;
7994 fprintf (stderr
, m
, a1
, a2
, a3
);
7995 if (cursor_in_echo_area
== 0)
7996 fprintf (stderr
, "\n");
8000 else if (INTERACTIVE
)
8002 /* The frame whose mini-buffer we're going to display the message
8003 on. It may be larger than the selected frame, so we need to
8004 use its buffer, not the selected frame's buffer. */
8005 Lisp_Object mini_window
;
8006 struct frame
*f
, *sf
= SELECTED_FRAME ();
8008 /* Get the frame containing the mini-buffer
8009 that the selected frame is using. */
8010 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8011 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8013 /* A null message buffer means that the frame hasn't really been
8014 initialized yet. Error messages get reported properly by
8015 cmd_error, so this must be just an informative message; toss
8017 if (FRAME_MESSAGE_BUF (f
))
8028 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8029 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8031 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8032 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8034 #endif /* NO_ARG_ARRAY */
8036 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8041 /* Print should start at the beginning of the message
8042 buffer next time. */
8043 message_buf_print
= 0;
8049 /* The non-logging version of message. */
8052 message_nolog (m
, a1
, a2
, a3
)
8054 EMACS_INT a1
, a2
, a3
;
8056 Lisp_Object old_log_max
;
8057 old_log_max
= Vmessage_log_max
;
8058 Vmessage_log_max
= Qnil
;
8059 message (m
, a1
, a2
, a3
);
8060 Vmessage_log_max
= old_log_max
;
8064 /* Display the current message in the current mini-buffer. This is
8065 only called from error handlers in process.c, and is not time
8071 if (!NILP (echo_area_buffer
[0]))
8074 string
= Fcurrent_message ();
8075 message3 (string
, SBYTES (string
),
8076 !NILP (current_buffer
->enable_multibyte_characters
));
8081 /* Make sure echo area buffers in `echo_buffers' are live.
8082 If they aren't, make new ones. */
8085 ensure_echo_area_buffers ()
8089 for (i
= 0; i
< 2; ++i
)
8090 if (!BUFFERP (echo_buffer
[i
])
8091 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8094 Lisp_Object old_buffer
;
8097 old_buffer
= echo_buffer
[i
];
8098 sprintf (name
, " *Echo Area %d*", i
);
8099 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8100 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8102 for (j
= 0; j
< 2; ++j
)
8103 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8104 echo_area_buffer
[j
] = echo_buffer
[i
];
8109 /* Call FN with args A1..A4 with either the current or last displayed
8110 echo_area_buffer as current buffer.
8112 WHICH zero means use the current message buffer
8113 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8114 from echo_buffer[] and clear it.
8116 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8117 suitable buffer from echo_buffer[] and clear it.
8119 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8120 that the current message becomes the last displayed one, make
8121 choose a suitable buffer for echo_area_buffer[0], and clear it.
8123 Value is what FN returns. */
8126 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8129 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8135 int this_one
, the_other
, clear_buffer_p
, rc
;
8136 int count
= SPECPDL_INDEX ();
8138 /* If buffers aren't live, make new ones. */
8139 ensure_echo_area_buffers ();
8144 this_one
= 0, the_other
= 1;
8146 this_one
= 1, the_other
= 0;
8149 this_one
= 0, the_other
= 1;
8152 /* We need a fresh one in case the current echo buffer equals
8153 the one containing the last displayed echo area message. */
8154 if (!NILP (echo_area_buffer
[this_one
])
8155 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8156 echo_area_buffer
[this_one
] = Qnil
;
8159 /* Choose a suitable buffer from echo_buffer[] is we don't
8161 if (NILP (echo_area_buffer
[this_one
]))
8163 echo_area_buffer
[this_one
]
8164 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8165 ? echo_buffer
[the_other
]
8166 : echo_buffer
[this_one
]);
8170 buffer
= echo_area_buffer
[this_one
];
8172 /* Don't get confused by reusing the buffer used for echoing
8173 for a different purpose. */
8174 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8177 record_unwind_protect (unwind_with_echo_area_buffer
,
8178 with_echo_area_buffer_unwind_data (w
));
8180 /* Make the echo area buffer current. Note that for display
8181 purposes, it is not necessary that the displayed window's buffer
8182 == current_buffer, except for text property lookup. So, let's
8183 only set that buffer temporarily here without doing a full
8184 Fset_window_buffer. We must also change w->pointm, though,
8185 because otherwise an assertions in unshow_buffer fails, and Emacs
8187 set_buffer_internal_1 (XBUFFER (buffer
));
8191 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8194 current_buffer
->undo_list
= Qt
;
8195 current_buffer
->read_only
= Qnil
;
8196 specbind (Qinhibit_read_only
, Qt
);
8197 specbind (Qinhibit_modification_hooks
, Qt
);
8199 if (clear_buffer_p
&& Z
> BEG
)
8202 xassert (BEGV
>= BEG
);
8203 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8205 rc
= fn (a1
, a2
, a3
, a4
);
8207 xassert (BEGV
>= BEG
);
8208 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8210 unbind_to (count
, Qnil
);
8215 /* Save state that should be preserved around the call to the function
8216 FN called in with_echo_area_buffer. */
8219 with_echo_area_buffer_unwind_data (w
)
8223 Lisp_Object vector
, tmp
;
8225 /* Reduce consing by keeping one vector in
8226 Vwith_echo_area_save_vector. */
8227 vector
= Vwith_echo_area_save_vector
;
8228 Vwith_echo_area_save_vector
= Qnil
;
8231 vector
= Fmake_vector (make_number (7), Qnil
);
8233 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8234 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8235 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8239 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8240 ASET (vector
, i
, w
->buffer
); ++i
;
8241 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8242 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8247 for (; i
< end
; ++i
)
8248 ASET (vector
, i
, Qnil
);
8251 xassert (i
== ASIZE (vector
));
8256 /* Restore global state from VECTOR which was created by
8257 with_echo_area_buffer_unwind_data. */
8260 unwind_with_echo_area_buffer (vector
)
8263 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8264 Vdeactivate_mark
= AREF (vector
, 1);
8265 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8267 if (WINDOWP (AREF (vector
, 3)))
8270 Lisp_Object buffer
, charpos
, bytepos
;
8272 w
= XWINDOW (AREF (vector
, 3));
8273 buffer
= AREF (vector
, 4);
8274 charpos
= AREF (vector
, 5);
8275 bytepos
= AREF (vector
, 6);
8278 set_marker_both (w
->pointm
, buffer
,
8279 XFASTINT (charpos
), XFASTINT (bytepos
));
8282 Vwith_echo_area_save_vector
= vector
;
8287 /* Set up the echo area for use by print functions. MULTIBYTE_P
8288 non-zero means we will print multibyte. */
8291 setup_echo_area_for_printing (multibyte_p
)
8294 /* If we can't find an echo area any more, exit. */
8295 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8298 ensure_echo_area_buffers ();
8300 if (!message_buf_print
)
8302 /* A message has been output since the last time we printed.
8303 Choose a fresh echo area buffer. */
8304 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8305 echo_area_buffer
[0] = echo_buffer
[1];
8307 echo_area_buffer
[0] = echo_buffer
[0];
8309 /* Switch to that buffer and clear it. */
8310 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8311 current_buffer
->truncate_lines
= Qnil
;
8315 int count
= SPECPDL_INDEX ();
8316 specbind (Qinhibit_read_only
, Qt
);
8317 /* Note that undo recording is always disabled. */
8319 unbind_to (count
, Qnil
);
8321 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8323 /* Set up the buffer for the multibyteness we need. */
8325 != !NILP (current_buffer
->enable_multibyte_characters
))
8326 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8328 /* Raise the frame containing the echo area. */
8329 if (minibuffer_auto_raise
)
8331 struct frame
*sf
= SELECTED_FRAME ();
8332 Lisp_Object mini_window
;
8333 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8334 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8337 message_log_maybe_newline ();
8338 message_buf_print
= 1;
8342 if (NILP (echo_area_buffer
[0]))
8344 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8345 echo_area_buffer
[0] = echo_buffer
[1];
8347 echo_area_buffer
[0] = echo_buffer
[0];
8350 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8352 /* Someone switched buffers between print requests. */
8353 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8354 current_buffer
->truncate_lines
= Qnil
;
8360 /* Display an echo area message in window W. Value is non-zero if W's
8361 height is changed. If display_last_displayed_message_p is
8362 non-zero, display the message that was last displayed, otherwise
8363 display the current message. */
8366 display_echo_area (w
)
8369 int i
, no_message_p
, window_height_changed_p
, count
;
8371 /* Temporarily disable garbage collections while displaying the echo
8372 area. This is done because a GC can print a message itself.
8373 That message would modify the echo area buffer's contents while a
8374 redisplay of the buffer is going on, and seriously confuse
8376 count
= inhibit_garbage_collection ();
8378 /* If there is no message, we must call display_echo_area_1
8379 nevertheless because it resizes the window. But we will have to
8380 reset the echo_area_buffer in question to nil at the end because
8381 with_echo_area_buffer will sets it to an empty buffer. */
8382 i
= display_last_displayed_message_p
? 1 : 0;
8383 no_message_p
= NILP (echo_area_buffer
[i
]);
8385 window_height_changed_p
8386 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8387 display_echo_area_1
,
8388 (EMACS_INT
) w
, Qnil
, 0, 0);
8391 echo_area_buffer
[i
] = Qnil
;
8393 unbind_to (count
, Qnil
);
8394 return window_height_changed_p
;
8398 /* Helper for display_echo_area. Display the current buffer which
8399 contains the current echo area message in window W, a mini-window,
8400 a pointer to which is passed in A1. A2..A4 are currently not used.
8401 Change the height of W so that all of the message is displayed.
8402 Value is non-zero if height of W was changed. */
8405 display_echo_area_1 (a1
, a2
, a3
, a4
)
8410 struct window
*w
= (struct window
*) a1
;
8412 struct text_pos start
;
8413 int window_height_changed_p
= 0;
8415 /* Do this before displaying, so that we have a large enough glyph
8416 matrix for the display. If we can't get enough space for the
8417 whole text, display the last N lines. That works by setting w->start. */
8418 window_height_changed_p
= resize_mini_window (w
, 0);
8420 /* Use the starting position chosen by resize_mini_window. */
8421 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8424 clear_glyph_matrix (w
->desired_matrix
);
8425 XSETWINDOW (window
, w
);
8426 try_window (window
, start
, 0);
8428 return window_height_changed_p
;
8432 /* Resize the echo area window to exactly the size needed for the
8433 currently displayed message, if there is one. If a mini-buffer
8434 is active, don't shrink it. */
8437 resize_echo_area_exactly ()
8439 if (BUFFERP (echo_area_buffer
[0])
8440 && WINDOWP (echo_area_window
))
8442 struct window
*w
= XWINDOW (echo_area_window
);
8444 Lisp_Object resize_exactly
;
8446 if (minibuf_level
== 0)
8447 resize_exactly
= Qt
;
8449 resize_exactly
= Qnil
;
8451 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8452 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8455 ++windows_or_buffers_changed
;
8456 ++update_mode_lines
;
8457 redisplay_internal (0);
8463 /* Callback function for with_echo_area_buffer, when used from
8464 resize_echo_area_exactly. A1 contains a pointer to the window to
8465 resize, EXACTLY non-nil means resize the mini-window exactly to the
8466 size of the text displayed. A3 and A4 are not used. Value is what
8467 resize_mini_window returns. */
8470 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8472 Lisp_Object exactly
;
8475 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8479 /* Resize mini-window W to fit the size of its contents. EXACT_P
8480 means size the window exactly to the size needed. Otherwise, it's
8481 only enlarged until W's buffer is empty.
8483 Set W->start to the right place to begin display. If the whole
8484 contents fit, start at the beginning. Otherwise, start so as
8485 to make the end of the contents appear. This is particularly
8486 important for y-or-n-p, but seems desirable generally.
8488 Value is non-zero if the window height has been changed. */
8491 resize_mini_window (w
, exact_p
)
8495 struct frame
*f
= XFRAME (w
->frame
);
8496 int window_height_changed_p
= 0;
8498 xassert (MINI_WINDOW_P (w
));
8500 /* By default, start display at the beginning. */
8501 set_marker_both (w
->start
, w
->buffer
,
8502 BUF_BEGV (XBUFFER (w
->buffer
)),
8503 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8505 /* Don't resize windows while redisplaying a window; it would
8506 confuse redisplay functions when the size of the window they are
8507 displaying changes from under them. Such a resizing can happen,
8508 for instance, when which-func prints a long message while
8509 we are running fontification-functions. We're running these
8510 functions with safe_call which binds inhibit-redisplay to t. */
8511 if (!NILP (Vinhibit_redisplay
))
8514 /* Nil means don't try to resize. */
8515 if (NILP (Vresize_mini_windows
)
8516 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8519 if (!FRAME_MINIBUF_ONLY_P (f
))
8522 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8523 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8524 int height
, max_height
;
8525 int unit
= FRAME_LINE_HEIGHT (f
);
8526 struct text_pos start
;
8527 struct buffer
*old_current_buffer
= NULL
;
8529 if (current_buffer
!= XBUFFER (w
->buffer
))
8531 old_current_buffer
= current_buffer
;
8532 set_buffer_internal (XBUFFER (w
->buffer
));
8535 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8537 /* Compute the max. number of lines specified by the user. */
8538 if (FLOATP (Vmax_mini_window_height
))
8539 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8540 else if (INTEGERP (Vmax_mini_window_height
))
8541 max_height
= XINT (Vmax_mini_window_height
);
8543 max_height
= total_height
/ 4;
8545 /* Correct that max. height if it's bogus. */
8546 max_height
= max (1, max_height
);
8547 max_height
= min (total_height
, max_height
);
8549 /* Find out the height of the text in the window. */
8550 if (it
.truncate_lines_p
)
8555 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8556 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8557 height
= it
.current_y
+ last_height
;
8559 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8560 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8561 height
= (height
+ unit
- 1) / unit
;
8564 /* Compute a suitable window start. */
8565 if (height
> max_height
)
8567 height
= max_height
;
8568 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8569 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8570 start
= it
.current
.pos
;
8573 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8574 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8576 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8578 /* Let it grow only, until we display an empty message, in which
8579 case the window shrinks again. */
8580 if (height
> WINDOW_TOTAL_LINES (w
))
8582 int old_height
= WINDOW_TOTAL_LINES (w
);
8583 freeze_window_starts (f
, 1);
8584 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8585 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8587 else if (height
< WINDOW_TOTAL_LINES (w
)
8588 && (exact_p
|| BEGV
== ZV
))
8590 int old_height
= WINDOW_TOTAL_LINES (w
);
8591 freeze_window_starts (f
, 0);
8592 shrink_mini_window (w
);
8593 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8598 /* Always resize to exact size needed. */
8599 if (height
> WINDOW_TOTAL_LINES (w
))
8601 int old_height
= WINDOW_TOTAL_LINES (w
);
8602 freeze_window_starts (f
, 1);
8603 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8604 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8606 else if (height
< WINDOW_TOTAL_LINES (w
))
8608 int old_height
= WINDOW_TOTAL_LINES (w
);
8609 freeze_window_starts (f
, 0);
8610 shrink_mini_window (w
);
8614 freeze_window_starts (f
, 1);
8615 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8618 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8622 if (old_current_buffer
)
8623 set_buffer_internal (old_current_buffer
);
8626 return window_height_changed_p
;
8630 /* Value is the current message, a string, or nil if there is no
8638 if (NILP (echo_area_buffer
[0]))
8642 with_echo_area_buffer (0, 0, current_message_1
,
8643 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8645 echo_area_buffer
[0] = Qnil
;
8653 current_message_1 (a1
, a2
, a3
, a4
)
8658 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8661 *msg
= make_buffer_string (BEG
, Z
, 1);
8668 /* Push the current message on Vmessage_stack for later restauration
8669 by restore_message. Value is non-zero if the current message isn't
8670 empty. This is a relatively infrequent operation, so it's not
8671 worth optimizing. */
8677 msg
= current_message ();
8678 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8679 return STRINGP (msg
);
8683 /* Restore message display from the top of Vmessage_stack. */
8690 xassert (CONSP (Vmessage_stack
));
8691 msg
= XCAR (Vmessage_stack
);
8693 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8695 message3_nolog (msg
, 0, 0);
8699 /* Handler for record_unwind_protect calling pop_message. */
8702 pop_message_unwind (dummy
)
8709 /* Pop the top-most entry off Vmessage_stack. */
8714 xassert (CONSP (Vmessage_stack
));
8715 Vmessage_stack
= XCDR (Vmessage_stack
);
8719 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8720 exits. If the stack is not empty, we have a missing pop_message
8724 check_message_stack ()
8726 if (!NILP (Vmessage_stack
))
8731 /* Truncate to NCHARS what will be displayed in the echo area the next
8732 time we display it---but don't redisplay it now. */
8735 truncate_echo_area (nchars
)
8739 echo_area_buffer
[0] = Qnil
;
8740 /* A null message buffer means that the frame hasn't really been
8741 initialized yet. Error messages get reported properly by
8742 cmd_error, so this must be just an informative message; toss it. */
8743 else if (!noninteractive
8745 && !NILP (echo_area_buffer
[0]))
8747 struct frame
*sf
= SELECTED_FRAME ();
8748 if (FRAME_MESSAGE_BUF (sf
))
8749 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8754 /* Helper function for truncate_echo_area. Truncate the current
8755 message to at most NCHARS characters. */
8758 truncate_message_1 (nchars
, a2
, a3
, a4
)
8763 if (BEG
+ nchars
< Z
)
8764 del_range (BEG
+ nchars
, Z
);
8766 echo_area_buffer
[0] = Qnil
;
8771 /* Set the current message to a substring of S or STRING.
8773 If STRING is a Lisp string, set the message to the first NBYTES
8774 bytes from STRING. NBYTES zero means use the whole string. If
8775 STRING is multibyte, the message will be displayed multibyte.
8777 If S is not null, set the message to the first LEN bytes of S. LEN
8778 zero means use the whole string. MULTIBYTE_P non-zero means S is
8779 multibyte. Display the message multibyte in that case.
8781 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8782 to t before calling set_message_1 (which calls insert).
8786 set_message (s
, string
, nbytes
, multibyte_p
)
8789 int nbytes
, multibyte_p
;
8791 message_enable_multibyte
8792 = ((s
&& multibyte_p
)
8793 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8795 with_echo_area_buffer (0, -1, set_message_1
,
8796 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8797 message_buf_print
= 0;
8798 help_echo_showing_p
= 0;
8802 /* Helper function for set_message. Arguments have the same meaning
8803 as there, with A1 corresponding to S and A2 corresponding to STRING
8804 This function is called with the echo area buffer being
8808 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8811 EMACS_INT nbytes
, multibyte_p
;
8813 const char *s
= (const char *) a1
;
8814 Lisp_Object string
= a2
;
8816 /* Change multibyteness of the echo buffer appropriately. */
8817 if (message_enable_multibyte
8818 != !NILP (current_buffer
->enable_multibyte_characters
))
8819 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8821 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8823 /* Insert new message at BEG. */
8824 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8826 if (STRINGP (string
))
8831 nbytes
= SBYTES (string
);
8832 nchars
= string_byte_to_char (string
, nbytes
);
8834 /* This function takes care of single/multibyte conversion. We
8835 just have to ensure that the echo area buffer has the right
8836 setting of enable_multibyte_characters. */
8837 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
8842 nbytes
= strlen (s
);
8844 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
8846 /* Convert from multi-byte to single-byte. */
8848 unsigned char work
[1];
8850 /* Convert a multibyte string to single-byte. */
8851 for (i
= 0; i
< nbytes
; i
+= n
)
8853 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
8854 work
[0] = (ASCII_CHAR_P (c
)
8856 : multibyte_char_to_unibyte (c
, Qnil
));
8857 insert_1_both (work
, 1, 1, 1, 0, 0);
8860 else if (!multibyte_p
8861 && !NILP (current_buffer
->enable_multibyte_characters
))
8863 /* Convert from single-byte to multi-byte. */
8865 const unsigned char *msg
= (const unsigned char *) s
;
8866 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8868 /* Convert a single-byte string to multibyte. */
8869 for (i
= 0; i
< nbytes
; i
++)
8872 c
= unibyte_char_to_multibyte (c
);
8873 n
= CHAR_STRING (c
, str
);
8874 insert_1_both (str
, 1, n
, 1, 0, 0);
8878 insert_1 (s
, nbytes
, 1, 0, 0);
8885 /* Clear messages. CURRENT_P non-zero means clear the current
8886 message. LAST_DISPLAYED_P non-zero means clear the message
8890 clear_message (current_p
, last_displayed_p
)
8891 int current_p
, last_displayed_p
;
8895 echo_area_buffer
[0] = Qnil
;
8896 message_cleared_p
= 1;
8899 if (last_displayed_p
)
8900 echo_area_buffer
[1] = Qnil
;
8902 message_buf_print
= 0;
8905 /* Clear garbaged frames.
8907 This function is used where the old redisplay called
8908 redraw_garbaged_frames which in turn called redraw_frame which in
8909 turn called clear_frame. The call to clear_frame was a source of
8910 flickering. I believe a clear_frame is not necessary. It should
8911 suffice in the new redisplay to invalidate all current matrices,
8912 and ensure a complete redisplay of all windows. */
8915 clear_garbaged_frames ()
8919 Lisp_Object tail
, frame
;
8920 int changed_count
= 0;
8922 FOR_EACH_FRAME (tail
, frame
)
8924 struct frame
*f
= XFRAME (frame
);
8926 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
8930 Fredraw_frame (frame
);
8931 f
->force_flush_display_p
= 1;
8933 clear_current_matrices (f
);
8942 ++windows_or_buffers_changed
;
8947 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
8948 is non-zero update selected_frame. Value is non-zero if the
8949 mini-windows height has been changed. */
8952 echo_area_display (update_frame_p
)
8955 Lisp_Object mini_window
;
8958 int window_height_changed_p
= 0;
8959 struct frame
*sf
= SELECTED_FRAME ();
8961 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8962 w
= XWINDOW (mini_window
);
8963 f
= XFRAME (WINDOW_FRAME (w
));
8965 /* Don't display if frame is invisible or not yet initialized. */
8966 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
8969 #ifdef HAVE_WINDOW_SYSTEM
8970 /* When Emacs starts, selected_frame may be the initial terminal
8971 frame. If we let this through, a message would be displayed on
8973 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
8975 #endif /* HAVE_WINDOW_SYSTEM */
8977 /* Redraw garbaged frames. */
8979 clear_garbaged_frames ();
8981 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
8983 echo_area_window
= mini_window
;
8984 window_height_changed_p
= display_echo_area (w
);
8985 w
->must_be_updated_p
= 1;
8987 /* Update the display, unless called from redisplay_internal.
8988 Also don't update the screen during redisplay itself. The
8989 update will happen at the end of redisplay, and an update
8990 here could cause confusion. */
8991 if (update_frame_p
&& !redisplaying_p
)
8995 /* If the display update has been interrupted by pending
8996 input, update mode lines in the frame. Due to the
8997 pending input, it might have been that redisplay hasn't
8998 been called, so that mode lines above the echo area are
8999 garbaged. This looks odd, so we prevent it here. */
9000 if (!display_completed
)
9001 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9003 if (window_height_changed_p
9004 /* Don't do this if Emacs is shutting down. Redisplay
9005 needs to run hooks. */
9006 && !NILP (Vrun_hooks
))
9008 /* Must update other windows. Likewise as in other
9009 cases, don't let this update be interrupted by
9011 int count
= SPECPDL_INDEX ();
9012 specbind (Qredisplay_dont_pause
, Qt
);
9013 windows_or_buffers_changed
= 1;
9014 redisplay_internal (0);
9015 unbind_to (count
, Qnil
);
9017 else if (FRAME_WINDOW_P (f
) && n
== 0)
9019 /* Window configuration is the same as before.
9020 Can do with a display update of the echo area,
9021 unless we displayed some mode lines. */
9022 update_single_window (w
, 1);
9023 FRAME_RIF (f
)->flush_display (f
);
9026 update_frame (f
, 1, 1);
9028 /* If cursor is in the echo area, make sure that the next
9029 redisplay displays the minibuffer, so that the cursor will
9030 be replaced with what the minibuffer wants. */
9031 if (cursor_in_echo_area
)
9032 ++windows_or_buffers_changed
;
9035 else if (!EQ (mini_window
, selected_window
))
9036 windows_or_buffers_changed
++;
9038 /* Last displayed message is now the current message. */
9039 echo_area_buffer
[1] = echo_area_buffer
[0];
9040 /* Inform read_char that we're not echoing. */
9041 echo_message_buffer
= Qnil
;
9043 /* Prevent redisplay optimization in redisplay_internal by resetting
9044 this_line_start_pos. This is done because the mini-buffer now
9045 displays the message instead of its buffer text. */
9046 if (EQ (mini_window
, selected_window
))
9047 CHARPOS (this_line_start_pos
) = 0;
9049 return window_height_changed_p
;
9054 /***********************************************************************
9055 Mode Lines and Frame Titles
9056 ***********************************************************************/
9058 /* A buffer for constructing non-propertized mode-line strings and
9059 frame titles in it; allocated from the heap in init_xdisp and
9060 resized as needed in store_mode_line_noprop_char. */
9062 static char *mode_line_noprop_buf
;
9064 /* The buffer's end, and a current output position in it. */
9066 static char *mode_line_noprop_buf_end
;
9067 static char *mode_line_noprop_ptr
;
9069 #define MODE_LINE_NOPROP_LEN(start) \
9070 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9073 MODE_LINE_DISPLAY
= 0,
9079 /* Alist that caches the results of :propertize.
9080 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9081 static Lisp_Object mode_line_proptrans_alist
;
9083 /* List of strings making up the mode-line. */
9084 static Lisp_Object mode_line_string_list
;
9086 /* Base face property when building propertized mode line string. */
9087 static Lisp_Object mode_line_string_face
;
9088 static Lisp_Object mode_line_string_face_prop
;
9091 /* Unwind data for mode line strings */
9093 static Lisp_Object Vmode_line_unwind_vector
;
9096 format_mode_line_unwind_data (obuf
, save_proptrans
)
9097 struct buffer
*obuf
;
9099 Lisp_Object vector
, tmp
;
9101 /* Reduce consing by keeping one vector in
9102 Vwith_echo_area_save_vector. */
9103 vector
= Vmode_line_unwind_vector
;
9104 Vmode_line_unwind_vector
= Qnil
;
9107 vector
= Fmake_vector (make_number (7), Qnil
);
9109 ASET (vector
, 0, make_number (mode_line_target
));
9110 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9111 ASET (vector
, 2, mode_line_string_list
);
9112 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9113 ASET (vector
, 4, mode_line_string_face
);
9114 ASET (vector
, 5, mode_line_string_face_prop
);
9117 XSETBUFFER (tmp
, obuf
);
9120 ASET (vector
, 6, tmp
);
9126 unwind_format_mode_line (vector
)
9129 mode_line_target
= XINT (AREF (vector
, 0));
9130 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9131 mode_line_string_list
= AREF (vector
, 2);
9132 if (! EQ (AREF (vector
, 3), Qt
))
9133 mode_line_proptrans_alist
= AREF (vector
, 3);
9134 mode_line_string_face
= AREF (vector
, 4);
9135 mode_line_string_face_prop
= AREF (vector
, 5);
9137 if (!NILP (AREF (vector
, 6)))
9139 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9140 ASET (vector
, 6, Qnil
);
9143 Vmode_line_unwind_vector
= vector
;
9148 /* Store a single character C for the frame title in mode_line_noprop_buf.
9149 Re-allocate mode_line_noprop_buf if necessary. */
9153 store_mode_line_noprop_char (char c
)
9155 store_mode_line_noprop_char (c
)
9159 /* If output position has reached the end of the allocated buffer,
9160 double the buffer's size. */
9161 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9163 int len
= MODE_LINE_NOPROP_LEN (0);
9164 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9165 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9166 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9167 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9170 *mode_line_noprop_ptr
++ = c
;
9174 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9175 mode_line_noprop_ptr. STR is the string to store. Do not copy
9176 characters that yield more columns than PRECISION; PRECISION <= 0
9177 means copy the whole string. Pad with spaces until FIELD_WIDTH
9178 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9179 pad. Called from display_mode_element when it is used to build a
9183 store_mode_line_noprop (str
, field_width
, precision
)
9184 const unsigned char *str
;
9185 int field_width
, precision
;
9190 /* Copy at most PRECISION chars from STR. */
9191 nbytes
= strlen (str
);
9192 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9194 store_mode_line_noprop_char (*str
++);
9196 /* Fill up with spaces until FIELD_WIDTH reached. */
9197 while (field_width
> 0
9200 store_mode_line_noprop_char (' ');
9207 /***********************************************************************
9209 ***********************************************************************/
9211 #ifdef HAVE_WINDOW_SYSTEM
9213 /* Set the title of FRAME, if it has changed. The title format is
9214 Vicon_title_format if FRAME is iconified, otherwise it is
9215 frame_title_format. */
9218 x_consider_frame_title (frame
)
9221 struct frame
*f
= XFRAME (frame
);
9223 if (FRAME_WINDOW_P (f
)
9224 || FRAME_MINIBUF_ONLY_P (f
)
9225 || f
->explicit_name
)
9227 /* Do we have more than one visible frame on this X display? */
9234 int count
= SPECPDL_INDEX ();
9236 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9238 Lisp_Object other_frame
= XCAR (tail
);
9239 struct frame
*tf
= XFRAME (other_frame
);
9242 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9243 && !FRAME_MINIBUF_ONLY_P (tf
)
9244 && !EQ (other_frame
, tip_frame
)
9245 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9249 /* Set global variable indicating that multiple frames exist. */
9250 multiple_frames
= CONSP (tail
);
9252 /* Switch to the buffer of selected window of the frame. Set up
9253 mode_line_target so that display_mode_element will output into
9254 mode_line_noprop_buf; then display the title. */
9255 record_unwind_protect (unwind_format_mode_line
,
9256 format_mode_line_unwind_data (current_buffer
, 0));
9258 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9259 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9261 mode_line_target
= MODE_LINE_TITLE
;
9262 title_start
= MODE_LINE_NOPROP_LEN (0);
9263 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9264 NULL
, DEFAULT_FACE_ID
);
9265 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9266 len
= MODE_LINE_NOPROP_LEN (title_start
);
9267 title
= mode_line_noprop_buf
+ title_start
;
9268 unbind_to (count
, Qnil
);
9270 /* Set the title only if it's changed. This avoids consing in
9271 the common case where it hasn't. (If it turns out that we've
9272 already wasted too much time by walking through the list with
9273 display_mode_element, then we might need to optimize at a
9274 higher level than this.) */
9275 if (! STRINGP (f
->name
)
9276 || SBYTES (f
->name
) != len
9277 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9278 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9282 #endif /* not HAVE_WINDOW_SYSTEM */
9287 /***********************************************************************
9289 ***********************************************************************/
9292 /* Prepare for redisplay by updating menu-bar item lists when
9293 appropriate. This can call eval. */
9296 prepare_menu_bars ()
9299 struct gcpro gcpro1
, gcpro2
;
9301 Lisp_Object tooltip_frame
;
9303 #ifdef HAVE_WINDOW_SYSTEM
9304 tooltip_frame
= tip_frame
;
9306 tooltip_frame
= Qnil
;
9309 /* Update all frame titles based on their buffer names, etc. We do
9310 this before the menu bars so that the buffer-menu will show the
9311 up-to-date frame titles. */
9312 #ifdef HAVE_WINDOW_SYSTEM
9313 if (windows_or_buffers_changed
|| update_mode_lines
)
9315 Lisp_Object tail
, frame
;
9317 FOR_EACH_FRAME (tail
, frame
)
9320 if (!EQ (frame
, tooltip_frame
)
9321 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9322 x_consider_frame_title (frame
);
9325 #endif /* HAVE_WINDOW_SYSTEM */
9327 /* Update the menu bar item lists, if appropriate. This has to be
9328 done before any actual redisplay or generation of display lines. */
9329 all_windows
= (update_mode_lines
9330 || buffer_shared
> 1
9331 || windows_or_buffers_changed
);
9334 Lisp_Object tail
, frame
;
9335 int count
= SPECPDL_INDEX ();
9336 /* 1 means that update_menu_bar has run its hooks
9337 so any further calls to update_menu_bar shouldn't do so again. */
9338 int menu_bar_hooks_run
= 0;
9340 record_unwind_save_match_data ();
9342 FOR_EACH_FRAME (tail
, frame
)
9346 /* Ignore tooltip frame. */
9347 if (EQ (frame
, tooltip_frame
))
9350 /* If a window on this frame changed size, report that to
9351 the user and clear the size-change flag. */
9352 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9354 Lisp_Object functions
;
9356 /* Clear flag first in case we get an error below. */
9357 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9358 functions
= Vwindow_size_change_functions
;
9359 GCPRO2 (tail
, functions
);
9361 while (CONSP (functions
))
9363 call1 (XCAR (functions
), frame
);
9364 functions
= XCDR (functions
);
9370 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9371 #ifdef HAVE_WINDOW_SYSTEM
9372 update_tool_bar (f
, 0);
9374 mac_update_title_bar (f
, 0);
9380 unbind_to (count
, Qnil
);
9384 struct frame
*sf
= SELECTED_FRAME ();
9385 update_menu_bar (sf
, 1, 0);
9386 #ifdef HAVE_WINDOW_SYSTEM
9387 update_tool_bar (sf
, 1);
9389 mac_update_title_bar (sf
, 1);
9394 /* Motif needs this. See comment in xmenu.c. Turn it off when
9395 pending_menu_activation is not defined. */
9396 #ifdef USE_X_TOOLKIT
9397 pending_menu_activation
= 0;
9402 /* Update the menu bar item list for frame F. This has to be done
9403 before we start to fill in any display lines, because it can call
9406 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9408 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9409 already ran the menu bar hooks for this redisplay, so there
9410 is no need to run them again. The return value is the
9411 updated value of this flag, to pass to the next call. */
9414 update_menu_bar (f
, save_match_data
, hooks_run
)
9416 int save_match_data
;
9420 register struct window
*w
;
9422 /* If called recursively during a menu update, do nothing. This can
9423 happen when, for instance, an activate-menubar-hook causes a
9425 if (inhibit_menubar_update
)
9428 window
= FRAME_SELECTED_WINDOW (f
);
9429 w
= XWINDOW (window
);
9431 #if 0 /* The if statement below this if statement used to include the
9432 condition !NILP (w->update_mode_line), rather than using
9433 update_mode_lines directly, and this if statement may have
9434 been added to make that condition work. Now the if
9435 statement below matches its comment, this isn't needed. */
9436 if (update_mode_lines
)
9437 w
->update_mode_line
= Qt
;
9440 if (FRAME_WINDOW_P (f
)
9442 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9443 || defined (USE_GTK)
9444 FRAME_EXTERNAL_MENU_BAR (f
)
9446 FRAME_MENU_BAR_LINES (f
) > 0
9448 : FRAME_MENU_BAR_LINES (f
) > 0)
9450 /* If the user has switched buffers or windows, we need to
9451 recompute to reflect the new bindings. But we'll
9452 recompute when update_mode_lines is set too; that means
9453 that people can use force-mode-line-update to request
9454 that the menu bar be recomputed. The adverse effect on
9455 the rest of the redisplay algorithm is about the same as
9456 windows_or_buffers_changed anyway. */
9457 if (windows_or_buffers_changed
9458 /* This used to test w->update_mode_line, but we believe
9459 there is no need to recompute the menu in that case. */
9460 || update_mode_lines
9461 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9462 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9463 != !NILP (w
->last_had_star
))
9464 || ((!NILP (Vtransient_mark_mode
)
9465 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9466 != !NILP (w
->region_showing
)))
9468 struct buffer
*prev
= current_buffer
;
9469 int count
= SPECPDL_INDEX ();
9471 specbind (Qinhibit_menubar_update
, Qt
);
9473 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9474 if (save_match_data
)
9475 record_unwind_save_match_data ();
9476 if (NILP (Voverriding_local_map_menu_flag
))
9478 specbind (Qoverriding_terminal_local_map
, Qnil
);
9479 specbind (Qoverriding_local_map
, Qnil
);
9484 /* Run the Lucid hook. */
9485 safe_run_hooks (Qactivate_menubar_hook
);
9487 /* If it has changed current-menubar from previous value,
9488 really recompute the menu-bar from the value. */
9489 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9490 call0 (Qrecompute_lucid_menubar
);
9492 safe_run_hooks (Qmenu_bar_update_hook
);
9497 XSETFRAME (Vmenu_updating_frame
, f
);
9498 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9500 /* Redisplay the menu bar in case we changed it. */
9501 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
9502 || defined (USE_GTK)
9503 if (FRAME_WINDOW_P (f
))
9506 /* All frames on Mac OS share the same menubar. So only
9507 the selected frame should be allowed to set it. */
9508 if (f
== SELECTED_FRAME ())
9510 set_frame_menubar (f
, 0, 0);
9513 /* On a terminal screen, the menu bar is an ordinary screen
9514 line, and this makes it get updated. */
9515 w
->update_mode_line
= Qt
;
9516 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9517 /* In the non-toolkit version, the menu bar is an ordinary screen
9518 line, and this makes it get updated. */
9519 w
->update_mode_line
= Qt
;
9520 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || MAC_OS || USE_GTK) */
9522 unbind_to (count
, Qnil
);
9523 set_buffer_internal_1 (prev
);
9532 /***********************************************************************
9534 ***********************************************************************/
9536 #ifdef HAVE_WINDOW_SYSTEM
9539 Nominal cursor position -- where to draw output.
9540 HPOS and VPOS are window relative glyph matrix coordinates.
9541 X and Y are window relative pixel coordinates. */
9543 struct cursor_pos output_cursor
;
9547 Set the global variable output_cursor to CURSOR. All cursor
9548 positions are relative to updated_window. */
9551 set_output_cursor (cursor
)
9552 struct cursor_pos
*cursor
;
9554 output_cursor
.hpos
= cursor
->hpos
;
9555 output_cursor
.vpos
= cursor
->vpos
;
9556 output_cursor
.x
= cursor
->x
;
9557 output_cursor
.y
= cursor
->y
;
9562 Set a nominal cursor position.
9564 HPOS and VPOS are column/row positions in a window glyph matrix. X
9565 and Y are window text area relative pixel positions.
9567 If this is done during an update, updated_window will contain the
9568 window that is being updated and the position is the future output
9569 cursor position for that window. If updated_window is null, use
9570 selected_window and display the cursor at the given position. */
9573 x_cursor_to (vpos
, hpos
, y
, x
)
9574 int vpos
, hpos
, y
, x
;
9578 /* If updated_window is not set, work on selected_window. */
9582 w
= XWINDOW (selected_window
);
9584 /* Set the output cursor. */
9585 output_cursor
.hpos
= hpos
;
9586 output_cursor
.vpos
= vpos
;
9587 output_cursor
.x
= x
;
9588 output_cursor
.y
= y
;
9590 /* If not called as part of an update, really display the cursor.
9591 This will also set the cursor position of W. */
9592 if (updated_window
== NULL
)
9595 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9596 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9597 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9602 #endif /* HAVE_WINDOW_SYSTEM */
9605 /***********************************************************************
9607 ***********************************************************************/
9609 #ifdef HAVE_WINDOW_SYSTEM
9611 /* Where the mouse was last time we reported a mouse event. */
9613 FRAME_PTR last_mouse_frame
;
9615 /* Tool-bar item index of the item on which a mouse button was pressed
9618 int last_tool_bar_item
;
9621 /* Update the tool-bar item list for frame F. This has to be done
9622 before we start to fill in any display lines. Called from
9623 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9624 and restore it here. */
9627 update_tool_bar (f
, save_match_data
)
9629 int save_match_data
;
9631 #if defined (USE_GTK) || USE_MAC_TOOLBAR
9632 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9634 int do_update
= WINDOWP (f
->tool_bar_window
)
9635 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9643 window
= FRAME_SELECTED_WINDOW (f
);
9644 w
= XWINDOW (window
);
9646 /* If the user has switched buffers or windows, we need to
9647 recompute to reflect the new bindings. But we'll
9648 recompute when update_mode_lines is set too; that means
9649 that people can use force-mode-line-update to request
9650 that the menu bar be recomputed. The adverse effect on
9651 the rest of the redisplay algorithm is about the same as
9652 windows_or_buffers_changed anyway. */
9653 if (windows_or_buffers_changed
9654 || !NILP (w
->update_mode_line
)
9655 || update_mode_lines
9656 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9657 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9658 != !NILP (w
->last_had_star
))
9659 || ((!NILP (Vtransient_mark_mode
)
9660 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9661 != !NILP (w
->region_showing
)))
9663 struct buffer
*prev
= current_buffer
;
9664 int count
= SPECPDL_INDEX ();
9665 Lisp_Object new_tool_bar
;
9667 struct gcpro gcpro1
;
9669 /* Set current_buffer to the buffer of the selected
9670 window of the frame, so that we get the right local
9672 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9674 /* Save match data, if we must. */
9675 if (save_match_data
)
9676 record_unwind_save_match_data ();
9678 /* Make sure that we don't accidentally use bogus keymaps. */
9679 if (NILP (Voverriding_local_map_menu_flag
))
9681 specbind (Qoverriding_terminal_local_map
, Qnil
);
9682 specbind (Qoverriding_local_map
, Qnil
);
9685 GCPRO1 (new_tool_bar
);
9687 /* Build desired tool-bar items from keymaps. */
9688 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9691 /* Redisplay the tool-bar if we changed it. */
9692 if (new_n_tool_bar
!= f
->n_tool_bar_items
9693 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9695 /* Redisplay that happens asynchronously due to an expose event
9696 may access f->tool_bar_items. Make sure we update both
9697 variables within BLOCK_INPUT so no such event interrupts. */
9699 f
->tool_bar_items
= new_tool_bar
;
9700 f
->n_tool_bar_items
= new_n_tool_bar
;
9701 w
->update_mode_line
= Qt
;
9707 unbind_to (count
, Qnil
);
9708 set_buffer_internal_1 (prev
);
9714 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9715 F's desired tool-bar contents. F->tool_bar_items must have
9716 been set up previously by calling prepare_menu_bars. */
9719 build_desired_tool_bar_string (f
)
9722 int i
, size
, size_needed
;
9723 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9724 Lisp_Object image
, plist
, props
;
9726 image
= plist
= props
= Qnil
;
9727 GCPRO3 (image
, plist
, props
);
9729 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9730 Otherwise, make a new string. */
9732 /* The size of the string we might be able to reuse. */
9733 size
= (STRINGP (f
->desired_tool_bar_string
)
9734 ? SCHARS (f
->desired_tool_bar_string
)
9737 /* We need one space in the string for each image. */
9738 size_needed
= f
->n_tool_bar_items
;
9740 /* Reuse f->desired_tool_bar_string, if possible. */
9741 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9742 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9746 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9747 Fremove_text_properties (make_number (0), make_number (size
),
9748 props
, f
->desired_tool_bar_string
);
9751 /* Put a `display' property on the string for the images to display,
9752 put a `menu_item' property on tool-bar items with a value that
9753 is the index of the item in F's tool-bar item vector. */
9754 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9756 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9758 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9759 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9760 int hmargin
, vmargin
, relief
, idx
, end
;
9761 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9763 /* If image is a vector, choose the image according to the
9765 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9766 if (VECTORP (image
))
9770 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9771 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9774 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9775 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9777 xassert (ASIZE (image
) >= idx
);
9778 image
= AREF (image
, idx
);
9783 /* Ignore invalid image specifications. */
9784 if (!valid_image_p (image
))
9787 /* Display the tool-bar button pressed, or depressed. */
9788 plist
= Fcopy_sequence (XCDR (image
));
9790 /* Compute margin and relief to draw. */
9791 relief
= (tool_bar_button_relief
>= 0
9792 ? tool_bar_button_relief
9793 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9794 hmargin
= vmargin
= relief
;
9796 if (INTEGERP (Vtool_bar_button_margin
)
9797 && XINT (Vtool_bar_button_margin
) > 0)
9799 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9800 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9802 else if (CONSP (Vtool_bar_button_margin
))
9804 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9805 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9806 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9808 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9809 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9810 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9813 if (auto_raise_tool_bar_buttons_p
)
9815 /* Add a `:relief' property to the image spec if the item is
9819 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
9826 /* If image is selected, display it pressed, i.e. with a
9827 negative relief. If it's not selected, display it with a
9829 plist
= Fplist_put (plist
, QCrelief
,
9831 ? make_number (-relief
)
9832 : make_number (relief
)));
9837 /* Put a margin around the image. */
9838 if (hmargin
|| vmargin
)
9840 if (hmargin
== vmargin
)
9841 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
9843 plist
= Fplist_put (plist
, QCmargin
,
9844 Fcons (make_number (hmargin
),
9845 make_number (vmargin
)));
9848 /* If button is not enabled, and we don't have special images
9849 for the disabled state, make the image appear disabled by
9850 applying an appropriate algorithm to it. */
9851 if (!enabled_p
&& idx
< 0)
9852 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
9854 /* Put a `display' text property on the string for the image to
9855 display. Put a `menu-item' property on the string that gives
9856 the start of this item's properties in the tool-bar items
9858 image
= Fcons (Qimage
, plist
);
9859 props
= list4 (Qdisplay
, image
,
9860 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
9862 /* Let the last image hide all remaining spaces in the tool bar
9863 string. The string can be longer than needed when we reuse a
9865 if (i
+ 1 == f
->n_tool_bar_items
)
9866 end
= SCHARS (f
->desired_tool_bar_string
);
9869 Fadd_text_properties (make_number (i
), make_number (end
),
9870 props
, f
->desired_tool_bar_string
);
9878 /* Display one line of the tool-bar of frame IT->f.
9880 HEIGHT specifies the desired height of the tool-bar line.
9881 If the actual height of the glyph row is less than HEIGHT, the
9882 row's height is increased to HEIGHT, and the icons are centered
9883 vertically in the new height.
9885 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
9886 count a final empty row in case the tool-bar width exactly matches
9891 display_tool_bar_line (it
, height
)
9895 struct glyph_row
*row
= it
->glyph_row
;
9896 int max_x
= it
->last_visible_x
;
9899 prepare_desired_row (row
);
9900 row
->y
= it
->current_y
;
9902 /* Note that this isn't made use of if the face hasn't a box,
9903 so there's no need to check the face here. */
9904 it
->start_of_box_run_p
= 1;
9906 while (it
->current_x
< max_x
)
9908 int x
, n_glyphs_before
, i
, nglyphs
;
9909 struct it it_before
;
9911 /* Get the next display element. */
9912 if (!get_next_display_element (it
))
9914 /* Don't count empty row if we are counting needed tool-bar lines. */
9915 if (height
< 0 && !it
->hpos
)
9920 /* Produce glyphs. */
9921 n_glyphs_before
= row
->used
[TEXT_AREA
];
9924 PRODUCE_GLYPHS (it
);
9926 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
9928 x
= it_before
.current_x
;
9931 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
9933 if (x
+ glyph
->pixel_width
> max_x
)
9935 /* Glyph doesn't fit on line. Backtrack. */
9936 row
->used
[TEXT_AREA
] = n_glyphs_before
;
9938 /* If this is the only glyph on this line, it will never fit on the
9939 toolbar, so skip it. But ensure there is at least one glyph,
9940 so we don't accidentally disable the tool-bar. */
9941 if (n_glyphs_before
== 0
9942 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
9948 x
+= glyph
->pixel_width
;
9952 /* Stop at line ends. */
9953 if (ITERATOR_AT_END_OF_LINE_P (it
))
9956 set_iterator_to_next (it
, 1);
9961 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
9963 /* Use default face for the border below the tool bar.
9965 FIXME: When auto-resize-tool-bars is grow-only, there is
9966 no additional border below the possibly empty tool-bar lines.
9967 So to make the extra empty lines look "normal", we have to
9968 use the tool-bar face for the border too. */
9969 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
9970 it
->face_id
= DEFAULT_FACE_ID
;
9972 extend_face_to_end_of_line (it
);
9973 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
9974 last
->right_box_line_p
= 1;
9975 if (last
== row
->glyphs
[TEXT_AREA
])
9976 last
->left_box_line_p
= 1;
9978 /* Make line the desired height and center it vertically. */
9979 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
9981 /* Don't add more than one line height. */
9982 height
%= FRAME_LINE_HEIGHT (it
->f
);
9983 it
->max_ascent
+= height
/ 2;
9984 it
->max_descent
+= (height
+ 1) / 2;
9987 compute_line_metrics (it
);
9989 /* If line is empty, make it occupy the rest of the tool-bar. */
9990 if (!row
->displays_text_p
)
9992 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
9993 row
->visible_height
= row
->height
;
9994 row
->ascent
= row
->phys_ascent
= 0;
9995 row
->extra_line_spacing
= 0;
9998 row
->full_width_p
= 1;
9999 row
->continued_p
= 0;
10000 row
->truncated_on_left_p
= 0;
10001 row
->truncated_on_right_p
= 0;
10003 it
->current_x
= it
->hpos
= 0;
10004 it
->current_y
+= row
->height
;
10010 /* Max tool-bar height. */
10012 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10013 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10015 /* Value is the number of screen lines needed to make all tool-bar
10016 items of frame F visible. The number of actual rows needed is
10017 returned in *N_ROWS if non-NULL. */
10020 tool_bar_lines_needed (f
, n_rows
)
10024 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10026 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10027 the desired matrix, so use (unused) mode-line row as temporary row to
10028 avoid destroying the first tool-bar row. */
10029 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10031 /* Initialize an iterator for iteration over
10032 F->desired_tool_bar_string in the tool-bar window of frame F. */
10033 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10034 it
.first_visible_x
= 0;
10035 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10036 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10038 while (!ITERATOR_AT_END_P (&it
))
10040 clear_glyph_row (temp_row
);
10041 it
.glyph_row
= temp_row
;
10042 display_tool_bar_line (&it
, -1);
10044 clear_glyph_row (temp_row
);
10046 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10048 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10050 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10054 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10056 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10065 frame
= selected_frame
;
10067 CHECK_FRAME (frame
);
10068 f
= XFRAME (frame
);
10070 if (WINDOWP (f
->tool_bar_window
)
10071 || (w
= XWINDOW (f
->tool_bar_window
),
10072 WINDOW_TOTAL_LINES (w
) > 0))
10074 update_tool_bar (f
, 1);
10075 if (f
->n_tool_bar_items
)
10077 build_desired_tool_bar_string (f
);
10078 nlines
= tool_bar_lines_needed (f
, NULL
);
10082 return make_number (nlines
);
10086 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10087 height should be changed. */
10090 redisplay_tool_bar (f
)
10095 struct glyph_row
*row
;
10097 #if defined (USE_GTK) || USE_MAC_TOOLBAR
10098 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10099 update_frame_tool_bar (f
);
10103 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10104 do anything. This means you must start with tool-bar-lines
10105 non-zero to get the auto-sizing effect. Or in other words, you
10106 can turn off tool-bars by specifying tool-bar-lines zero. */
10107 if (!WINDOWP (f
->tool_bar_window
)
10108 || (w
= XWINDOW (f
->tool_bar_window
),
10109 WINDOW_TOTAL_LINES (w
) == 0))
10112 /* Set up an iterator for the tool-bar window. */
10113 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10114 it
.first_visible_x
= 0;
10115 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10116 row
= it
.glyph_row
;
10118 /* Build a string that represents the contents of the tool-bar. */
10119 build_desired_tool_bar_string (f
);
10120 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10122 if (f
->n_tool_bar_rows
== 0)
10126 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10127 nlines
!= WINDOW_TOTAL_LINES (w
)))
10129 extern Lisp_Object Qtool_bar_lines
;
10131 int old_height
= WINDOW_TOTAL_LINES (w
);
10133 XSETFRAME (frame
, f
);
10134 Fmodify_frame_parameters (frame
,
10135 Fcons (Fcons (Qtool_bar_lines
,
10136 make_number (nlines
)),
10138 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10140 clear_glyph_matrix (w
->desired_matrix
);
10141 fonts_changed_p
= 1;
10147 /* Display as many lines as needed to display all tool-bar items. */
10149 if (f
->n_tool_bar_rows
> 0)
10151 int border
, rows
, height
, extra
;
10153 if (INTEGERP (Vtool_bar_border
))
10154 border
= XINT (Vtool_bar_border
);
10155 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10156 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10157 else if (EQ (Vtool_bar_border
, Qborder_width
))
10158 border
= f
->border_width
;
10164 rows
= f
->n_tool_bar_rows
;
10165 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10166 extra
= it
.last_visible_y
- border
- height
* rows
;
10168 while (it
.current_y
< it
.last_visible_y
)
10171 if (extra
> 0 && rows
-- > 0)
10173 h
= (extra
+ rows
- 1) / rows
;
10176 display_tool_bar_line (&it
, height
+ h
);
10181 while (it
.current_y
< it
.last_visible_y
)
10182 display_tool_bar_line (&it
, 0);
10185 /* It doesn't make much sense to try scrolling in the tool-bar
10186 window, so don't do it. */
10187 w
->desired_matrix
->no_scrolling_p
= 1;
10188 w
->must_be_updated_p
= 1;
10190 if (!NILP (Vauto_resize_tool_bars
))
10192 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10193 int change_height_p
= 0;
10195 /* If we couldn't display everything, change the tool-bar's
10196 height if there is room for more. */
10197 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10198 && it
.current_y
< max_tool_bar_height
)
10199 change_height_p
= 1;
10201 row
= it
.glyph_row
- 1;
10203 /* If there are blank lines at the end, except for a partially
10204 visible blank line at the end that is smaller than
10205 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10206 if (!row
->displays_text_p
10207 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10208 change_height_p
= 1;
10210 /* If row displays tool-bar items, but is partially visible,
10211 change the tool-bar's height. */
10212 if (row
->displays_text_p
10213 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10214 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10215 change_height_p
= 1;
10217 /* Resize windows as needed by changing the `tool-bar-lines'
10218 frame parameter. */
10219 if (change_height_p
)
10221 extern Lisp_Object Qtool_bar_lines
;
10223 int old_height
= WINDOW_TOTAL_LINES (w
);
10225 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10227 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10228 && !f
->minimize_tool_bar_window_p
)
10229 ? (nlines
> old_height
)
10230 : (nlines
!= old_height
));
10231 f
->minimize_tool_bar_window_p
= 0;
10233 if (change_height_p
)
10235 XSETFRAME (frame
, f
);
10236 Fmodify_frame_parameters (frame
,
10237 Fcons (Fcons (Qtool_bar_lines
,
10238 make_number (nlines
)),
10240 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10242 clear_glyph_matrix (w
->desired_matrix
);
10243 f
->n_tool_bar_rows
= nrows
;
10244 fonts_changed_p
= 1;
10251 f
->minimize_tool_bar_window_p
= 0;
10256 /* Get information about the tool-bar item which is displayed in GLYPH
10257 on frame F. Return in *PROP_IDX the index where tool-bar item
10258 properties start in F->tool_bar_items. Value is zero if
10259 GLYPH doesn't display a tool-bar item. */
10262 tool_bar_item_info (f
, glyph
, prop_idx
)
10264 struct glyph
*glyph
;
10271 /* This function can be called asynchronously, which means we must
10272 exclude any possibility that Fget_text_property signals an
10274 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10275 charpos
= max (0, charpos
);
10277 /* Get the text property `menu-item' at pos. The value of that
10278 property is the start index of this item's properties in
10279 F->tool_bar_items. */
10280 prop
= Fget_text_property (make_number (charpos
),
10281 Qmenu_item
, f
->current_tool_bar_string
);
10282 if (INTEGERP (prop
))
10284 *prop_idx
= XINT (prop
);
10294 /* Get information about the tool-bar item at position X/Y on frame F.
10295 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10296 the current matrix of the tool-bar window of F, or NULL if not
10297 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10298 item in F->tool_bar_items. Value is
10300 -1 if X/Y is not on a tool-bar item
10301 0 if X/Y is on the same item that was highlighted before.
10305 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10308 struct glyph
**glyph
;
10309 int *hpos
, *vpos
, *prop_idx
;
10311 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10312 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10315 /* Find the glyph under X/Y. */
10316 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10317 if (*glyph
== NULL
)
10320 /* Get the start of this tool-bar item's properties in
10321 f->tool_bar_items. */
10322 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10325 /* Is mouse on the highlighted item? */
10326 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10327 && *vpos
>= dpyinfo
->mouse_face_beg_row
10328 && *vpos
<= dpyinfo
->mouse_face_end_row
10329 && (*vpos
> dpyinfo
->mouse_face_beg_row
10330 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10331 && (*vpos
< dpyinfo
->mouse_face_end_row
10332 || *hpos
< dpyinfo
->mouse_face_end_col
10333 || dpyinfo
->mouse_face_past_end
))
10341 Handle mouse button event on the tool-bar of frame F, at
10342 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10343 0 for button release. MODIFIERS is event modifiers for button
10347 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10350 unsigned int modifiers
;
10352 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10353 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10354 int hpos
, vpos
, prop_idx
;
10355 struct glyph
*glyph
;
10356 Lisp_Object enabled_p
;
10358 /* If not on the highlighted tool-bar item, return. */
10359 frame_to_window_pixel_xy (w
, &x
, &y
);
10360 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10363 /* If item is disabled, do nothing. */
10364 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10365 if (NILP (enabled_p
))
10370 /* Show item in pressed state. */
10371 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10372 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10373 last_tool_bar_item
= prop_idx
;
10377 Lisp_Object key
, frame
;
10378 struct input_event event
;
10379 EVENT_INIT (event
);
10381 /* Show item in released state. */
10382 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10383 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10385 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10387 XSETFRAME (frame
, f
);
10388 event
.kind
= TOOL_BAR_EVENT
;
10389 event
.frame_or_window
= frame
;
10391 kbd_buffer_store_event (&event
);
10393 event
.kind
= TOOL_BAR_EVENT
;
10394 event
.frame_or_window
= frame
;
10396 event
.modifiers
= modifiers
;
10397 kbd_buffer_store_event (&event
);
10398 last_tool_bar_item
= -1;
10403 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10404 tool-bar window-relative coordinates X/Y. Called from
10405 note_mouse_highlight. */
10408 note_tool_bar_highlight (f
, x
, y
)
10412 Lisp_Object window
= f
->tool_bar_window
;
10413 struct window
*w
= XWINDOW (window
);
10414 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10416 struct glyph
*glyph
;
10417 struct glyph_row
*row
;
10419 Lisp_Object enabled_p
;
10421 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10422 int mouse_down_p
, rc
;
10424 /* Function note_mouse_highlight is called with negative x(y
10425 values when mouse moves outside of the frame. */
10426 if (x
<= 0 || y
<= 0)
10428 clear_mouse_face (dpyinfo
);
10432 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10435 /* Not on tool-bar item. */
10436 clear_mouse_face (dpyinfo
);
10440 /* On same tool-bar item as before. */
10441 goto set_help_echo
;
10443 clear_mouse_face (dpyinfo
);
10445 /* Mouse is down, but on different tool-bar item? */
10446 mouse_down_p
= (dpyinfo
->grabbed
10447 && f
== last_mouse_frame
10448 && FRAME_LIVE_P (f
));
10450 && last_tool_bar_item
!= prop_idx
)
10453 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10454 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10456 /* If tool-bar item is not enabled, don't highlight it. */
10457 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10458 if (!NILP (enabled_p
))
10460 /* Compute the x-position of the glyph. In front and past the
10461 image is a space. We include this in the highlighted area. */
10462 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10463 for (i
= x
= 0; i
< hpos
; ++i
)
10464 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10466 /* Record this as the current active region. */
10467 dpyinfo
->mouse_face_beg_col
= hpos
;
10468 dpyinfo
->mouse_face_beg_row
= vpos
;
10469 dpyinfo
->mouse_face_beg_x
= x
;
10470 dpyinfo
->mouse_face_beg_y
= row
->y
;
10471 dpyinfo
->mouse_face_past_end
= 0;
10473 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10474 dpyinfo
->mouse_face_end_row
= vpos
;
10475 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10476 dpyinfo
->mouse_face_end_y
= row
->y
;
10477 dpyinfo
->mouse_face_window
= window
;
10478 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10480 /* Display it as active. */
10481 show_mouse_face (dpyinfo
, draw
);
10482 dpyinfo
->mouse_face_image_state
= draw
;
10487 /* Set help_echo_string to a help string to display for this tool-bar item.
10488 XTread_socket does the rest. */
10489 help_echo_object
= help_echo_window
= Qnil
;
10490 help_echo_pos
= -1;
10491 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10492 if (NILP (help_echo_string
))
10493 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10496 #endif /* HAVE_WINDOW_SYSTEM */
10500 /************************************************************************
10501 Horizontal scrolling
10502 ************************************************************************/
10504 static int hscroll_window_tree
P_ ((Lisp_Object
));
10505 static int hscroll_windows
P_ ((Lisp_Object
));
10507 /* For all leaf windows in the window tree rooted at WINDOW, set their
10508 hscroll value so that PT is (i) visible in the window, and (ii) so
10509 that it is not within a certain margin at the window's left and
10510 right border. Value is non-zero if any window's hscroll has been
10514 hscroll_window_tree (window
)
10515 Lisp_Object window
;
10517 int hscrolled_p
= 0;
10518 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10519 int hscroll_step_abs
= 0;
10520 double hscroll_step_rel
= 0;
10522 if (hscroll_relative_p
)
10524 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10525 if (hscroll_step_rel
< 0)
10527 hscroll_relative_p
= 0;
10528 hscroll_step_abs
= 0;
10531 else if (INTEGERP (Vhscroll_step
))
10533 hscroll_step_abs
= XINT (Vhscroll_step
);
10534 if (hscroll_step_abs
< 0)
10535 hscroll_step_abs
= 0;
10538 hscroll_step_abs
= 0;
10540 while (WINDOWP (window
))
10542 struct window
*w
= XWINDOW (window
);
10544 if (WINDOWP (w
->hchild
))
10545 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10546 else if (WINDOWP (w
->vchild
))
10547 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10548 else if (w
->cursor
.vpos
>= 0)
10551 int text_area_width
;
10552 struct glyph_row
*current_cursor_row
10553 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10554 struct glyph_row
*desired_cursor_row
10555 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10556 struct glyph_row
*cursor_row
10557 = (desired_cursor_row
->enabled_p
10558 ? desired_cursor_row
10559 : current_cursor_row
);
10561 text_area_width
= window_box_width (w
, TEXT_AREA
);
10563 /* Scroll when cursor is inside this scroll margin. */
10564 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10566 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10567 && ((XFASTINT (w
->hscroll
)
10568 && w
->cursor
.x
<= h_margin
)
10569 || (cursor_row
->enabled_p
10570 && cursor_row
->truncated_on_right_p
10571 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10575 struct buffer
*saved_current_buffer
;
10579 /* Find point in a display of infinite width. */
10580 saved_current_buffer
= current_buffer
;
10581 current_buffer
= XBUFFER (w
->buffer
);
10583 if (w
== XWINDOW (selected_window
))
10584 pt
= BUF_PT (current_buffer
);
10587 pt
= marker_position (w
->pointm
);
10588 pt
= max (BEGV
, pt
);
10592 /* Move iterator to pt starting at cursor_row->start in
10593 a line with infinite width. */
10594 init_to_row_start (&it
, w
, cursor_row
);
10595 it
.last_visible_x
= INFINITY
;
10596 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10597 current_buffer
= saved_current_buffer
;
10599 /* Position cursor in window. */
10600 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10601 hscroll
= max (0, (it
.current_x
10602 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10603 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10604 : (text_area_width
/ 2))))
10605 / FRAME_COLUMN_WIDTH (it
.f
);
10606 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10608 if (hscroll_relative_p
)
10609 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10612 wanted_x
= text_area_width
10613 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10616 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10620 if (hscroll_relative_p
)
10621 wanted_x
= text_area_width
* hscroll_step_rel
10624 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10627 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10629 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10631 /* Don't call Fset_window_hscroll if value hasn't
10632 changed because it will prevent redisplay
10634 if (XFASTINT (w
->hscroll
) != hscroll
)
10636 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10637 w
->hscroll
= make_number (hscroll
);
10646 /* Value is non-zero if hscroll of any leaf window has been changed. */
10647 return hscrolled_p
;
10651 /* Set hscroll so that cursor is visible and not inside horizontal
10652 scroll margins for all windows in the tree rooted at WINDOW. See
10653 also hscroll_window_tree above. Value is non-zero if any window's
10654 hscroll has been changed. If it has, desired matrices on the frame
10655 of WINDOW are cleared. */
10658 hscroll_windows (window
)
10659 Lisp_Object window
;
10661 int hscrolled_p
= hscroll_window_tree (window
);
10663 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10664 return hscrolled_p
;
10669 /************************************************************************
10671 ************************************************************************/
10673 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10674 to a non-zero value. This is sometimes handy to have in a debugger
10679 /* First and last unchanged row for try_window_id. */
10681 int debug_first_unchanged_at_end_vpos
;
10682 int debug_last_unchanged_at_beg_vpos
;
10684 /* Delta vpos and y. */
10686 int debug_dvpos
, debug_dy
;
10688 /* Delta in characters and bytes for try_window_id. */
10690 int debug_delta
, debug_delta_bytes
;
10692 /* Values of window_end_pos and window_end_vpos at the end of
10695 EMACS_INT debug_end_pos
, debug_end_vpos
;
10697 /* Append a string to W->desired_matrix->method. FMT is a printf
10698 format string. A1...A9 are a supplement for a variable-length
10699 argument list. If trace_redisplay_p is non-zero also printf the
10700 resulting string to stderr. */
10703 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10706 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10709 char *method
= w
->desired_matrix
->method
;
10710 int len
= strlen (method
);
10711 int size
= sizeof w
->desired_matrix
->method
;
10712 int remaining
= size
- len
- 1;
10714 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10715 if (len
&& remaining
)
10718 --remaining
, ++len
;
10721 strncpy (method
+ len
, buffer
, remaining
);
10723 if (trace_redisplay_p
)
10724 fprintf (stderr
, "%p (%s): %s\n",
10726 ((BUFFERP (w
->buffer
)
10727 && STRINGP (XBUFFER (w
->buffer
)->name
))
10728 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10733 #endif /* GLYPH_DEBUG */
10736 /* Value is non-zero if all changes in window W, which displays
10737 current_buffer, are in the text between START and END. START is a
10738 buffer position, END is given as a distance from Z. Used in
10739 redisplay_internal for display optimization. */
10742 text_outside_line_unchanged_p (w
, start
, end
)
10746 int unchanged_p
= 1;
10748 /* If text or overlays have changed, see where. */
10749 if (XFASTINT (w
->last_modified
) < MODIFF
10750 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10752 /* Gap in the line? */
10753 if (GPT
< start
|| Z
- GPT
< end
)
10756 /* Changes start in front of the line, or end after it? */
10758 && (BEG_UNCHANGED
< start
- 1
10759 || END_UNCHANGED
< end
))
10762 /* If selective display, can't optimize if changes start at the
10763 beginning of the line. */
10765 && INTEGERP (current_buffer
->selective_display
)
10766 && XINT (current_buffer
->selective_display
) > 0
10767 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10770 /* If there are overlays at the start or end of the line, these
10771 may have overlay strings with newlines in them. A change at
10772 START, for instance, may actually concern the display of such
10773 overlay strings as well, and they are displayed on different
10774 lines. So, quickly rule out this case. (For the future, it
10775 might be desirable to implement something more telling than
10776 just BEG/END_UNCHANGED.) */
10779 if (BEG
+ BEG_UNCHANGED
== start
10780 && overlay_touches_p (start
))
10782 if (END_UNCHANGED
== end
10783 && overlay_touches_p (Z
- end
))
10788 return unchanged_p
;
10792 /* Do a frame update, taking possible shortcuts into account. This is
10793 the main external entry point for redisplay.
10795 If the last redisplay displayed an echo area message and that message
10796 is no longer requested, we clear the echo area or bring back the
10797 mini-buffer if that is in use. */
10802 redisplay_internal (0);
10807 overlay_arrow_string_or_property (var
)
10812 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10815 return Voverlay_arrow_string
;
10818 /* Return 1 if there are any overlay-arrows in current_buffer. */
10820 overlay_arrow_in_current_buffer_p ()
10824 for (vlist
= Voverlay_arrow_variable_list
;
10826 vlist
= XCDR (vlist
))
10828 Lisp_Object var
= XCAR (vlist
);
10831 if (!SYMBOLP (var
))
10833 val
= find_symbol_value (var
);
10835 && current_buffer
== XMARKER (val
)->buffer
)
10842 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
10846 overlay_arrows_changed_p ()
10850 for (vlist
= Voverlay_arrow_variable_list
;
10852 vlist
= XCDR (vlist
))
10854 Lisp_Object var
= XCAR (vlist
);
10855 Lisp_Object val
, pstr
;
10857 if (!SYMBOLP (var
))
10859 val
= find_symbol_value (var
);
10860 if (!MARKERP (val
))
10862 if (! EQ (COERCE_MARKER (val
),
10863 Fget (var
, Qlast_arrow_position
))
10864 || ! (pstr
= overlay_arrow_string_or_property (var
),
10865 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
10871 /* Mark overlay arrows to be updated on next redisplay. */
10874 update_overlay_arrows (up_to_date
)
10879 for (vlist
= Voverlay_arrow_variable_list
;
10881 vlist
= XCDR (vlist
))
10883 Lisp_Object var
= XCAR (vlist
);
10885 if (!SYMBOLP (var
))
10888 if (up_to_date
> 0)
10890 Lisp_Object val
= find_symbol_value (var
);
10891 Fput (var
, Qlast_arrow_position
,
10892 COERCE_MARKER (val
));
10893 Fput (var
, Qlast_arrow_string
,
10894 overlay_arrow_string_or_property (var
));
10896 else if (up_to_date
< 0
10897 || !NILP (Fget (var
, Qlast_arrow_position
)))
10899 Fput (var
, Qlast_arrow_position
, Qt
);
10900 Fput (var
, Qlast_arrow_string
, Qt
);
10906 /* Return overlay arrow string to display at row.
10907 Return integer (bitmap number) for arrow bitmap in left fringe.
10908 Return nil if no overlay arrow. */
10911 overlay_arrow_at_row (it
, row
)
10913 struct glyph_row
*row
;
10917 for (vlist
= Voverlay_arrow_variable_list
;
10919 vlist
= XCDR (vlist
))
10921 Lisp_Object var
= XCAR (vlist
);
10924 if (!SYMBOLP (var
))
10927 val
= find_symbol_value (var
);
10930 && current_buffer
== XMARKER (val
)->buffer
10931 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
10933 if (FRAME_WINDOW_P (it
->f
)
10934 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
10936 #ifdef HAVE_WINDOW_SYSTEM
10937 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
10940 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
10941 return make_number (fringe_bitmap
);
10944 return make_number (-1); /* Use default arrow bitmap */
10946 return overlay_arrow_string_or_property (var
);
10953 /* Return 1 if point moved out of or into a composition. Otherwise
10954 return 0. PREV_BUF and PREV_PT are the last point buffer and
10955 position. BUF and PT are the current point buffer and position. */
10958 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
10959 struct buffer
*prev_buf
, *buf
;
10962 EMACS_INT start
, end
;
10964 Lisp_Object buffer
;
10966 XSETBUFFER (buffer
, buf
);
10967 /* Check a composition at the last point if point moved within the
10969 if (prev_buf
== buf
)
10972 /* Point didn't move. */
10975 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
10976 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
10977 && COMPOSITION_VALID_P (start
, end
, prop
)
10978 && start
< prev_pt
&& end
> prev_pt
)
10979 /* The last point was within the composition. Return 1 iff
10980 point moved out of the composition. */
10981 return (pt
<= start
|| pt
>= end
);
10984 /* Check a composition at the current point. */
10985 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
10986 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
10987 && COMPOSITION_VALID_P (start
, end
, prop
)
10988 && start
< pt
&& end
> pt
);
10992 /* Reconsider the setting of B->clip_changed which is displayed
10996 reconsider_clip_changes (w
, b
)
11000 if (b
->clip_changed
11001 && !NILP (w
->window_end_valid
)
11002 && w
->current_matrix
->buffer
== b
11003 && w
->current_matrix
->zv
== BUF_ZV (b
)
11004 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11005 b
->clip_changed
= 0;
11007 /* If display wasn't paused, and W is not a tool bar window, see if
11008 point has been moved into or out of a composition. In that case,
11009 we set b->clip_changed to 1 to force updating the screen. If
11010 b->clip_changed has already been set to 1, we can skip this
11012 if (!b
->clip_changed
11013 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11017 if (w
== XWINDOW (selected_window
))
11018 pt
= BUF_PT (current_buffer
);
11020 pt
= marker_position (w
->pointm
);
11022 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11023 || pt
!= XINT (w
->last_point
))
11024 && check_point_in_composition (w
->current_matrix
->buffer
,
11025 XINT (w
->last_point
),
11026 XBUFFER (w
->buffer
), pt
))
11027 b
->clip_changed
= 1;
11032 /* Select FRAME to forward the values of frame-local variables into C
11033 variables so that the redisplay routines can access those values
11037 select_frame_for_redisplay (frame
)
11040 Lisp_Object tail
, sym
, val
;
11041 Lisp_Object old
= selected_frame
;
11043 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11045 selected_frame
= frame
;
11049 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11050 if (CONSP (XCAR (tail
))
11051 && (sym
= XCAR (XCAR (tail
)),
11053 && (sym
= indirect_variable (sym
),
11054 val
= SYMBOL_VALUE (sym
),
11055 (BUFFER_LOCAL_VALUEP (val
)))
11056 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11057 /* Use find_symbol_value rather than Fsymbol_value
11058 to avoid an error if it is void. */
11059 find_symbol_value (sym
);
11060 } while (!EQ (frame
, old
) && (frame
= old
, 1));
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 clear_image_caches (Qnil
);
11796 clear_image_cache_count
= 0;
11798 #endif /* HAVE_WINDOW_SYSTEM */
11802 unbind_to (count
, Qnil
);
11807 /* Redisplay, but leave alone any recent echo area message unless
11808 another message has been requested in its place.
11810 This is useful in situations where you need to redisplay but no
11811 user action has occurred, making it inappropriate for the message
11812 area to be cleared. See tracking_off and
11813 wait_reading_process_output for examples of these situations.
11815 FROM_WHERE is an integer saying from where this function was
11816 called. This is useful for debugging. */
11819 redisplay_preserve_echo_area (from_where
)
11822 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
11824 if (!NILP (echo_area_buffer
[1]))
11826 /* We have a previously displayed message, but no current
11827 message. Redisplay the previous message. */
11828 display_last_displayed_message_p
= 1;
11829 redisplay_internal (1);
11830 display_last_displayed_message_p
= 0;
11833 redisplay_internal (1);
11835 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
11836 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11837 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
11841 /* Function registered with record_unwind_protect in
11842 redisplay_internal. Reset redisplaying_p to the value it had
11843 before redisplay_internal was called, and clear
11844 prevent_freeing_realized_faces_p. It also selects the previously
11845 selected frame, unless it has been deleted (by an X connection
11846 failure during redisplay, for example). */
11849 unwind_redisplay (val
)
11852 Lisp_Object old_redisplaying_p
, old_frame
;
11854 old_redisplaying_p
= XCAR (val
);
11855 redisplaying_p
= XFASTINT (old_redisplaying_p
);
11856 old_frame
= XCDR (val
);
11857 if (! EQ (old_frame
, selected_frame
)
11858 && FRAME_LIVE_P (XFRAME (old_frame
)))
11859 select_frame_for_redisplay (old_frame
);
11864 /* Mark the display of window W as accurate or inaccurate. If
11865 ACCURATE_P is non-zero mark display of W as accurate. If
11866 ACCURATE_P is zero, arrange for W to be redisplayed the next time
11867 redisplay_internal is called. */
11870 mark_window_display_accurate_1 (w
, accurate_p
)
11874 if (BUFFERP (w
->buffer
))
11876 struct buffer
*b
= XBUFFER (w
->buffer
);
11879 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
11880 w
->last_overlay_modified
11881 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
11883 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
11887 b
->clip_changed
= 0;
11888 b
->prevent_redisplay_optimizations_p
= 0;
11890 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
11891 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
11892 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
11893 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
11895 w
->current_matrix
->buffer
= b
;
11896 w
->current_matrix
->begv
= BUF_BEGV (b
);
11897 w
->current_matrix
->zv
= BUF_ZV (b
);
11899 w
->last_cursor
= w
->cursor
;
11900 w
->last_cursor_off_p
= w
->cursor_off_p
;
11902 if (w
== XWINDOW (selected_window
))
11903 w
->last_point
= make_number (BUF_PT (b
));
11905 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
11911 w
->window_end_valid
= w
->buffer
;
11912 #if 0 /* This is incorrect with variable-height lines. */
11913 xassert (XINT (w
->window_end_vpos
)
11914 < (WINDOW_TOTAL_LINES (w
)
11915 - (WINDOW_WANTS_MODELINE_P (w
) ? 1 : 0)));
11917 w
->update_mode_line
= Qnil
;
11922 /* Mark the display of windows in the window tree rooted at WINDOW as
11923 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
11924 windows as accurate. If ACCURATE_P is zero, arrange for windows to
11925 be redisplayed the next time redisplay_internal is called. */
11928 mark_window_display_accurate (window
, accurate_p
)
11929 Lisp_Object window
;
11934 for (; !NILP (window
); window
= w
->next
)
11936 w
= XWINDOW (window
);
11937 mark_window_display_accurate_1 (w
, accurate_p
);
11939 if (!NILP (w
->vchild
))
11940 mark_window_display_accurate (w
->vchild
, accurate_p
);
11941 if (!NILP (w
->hchild
))
11942 mark_window_display_accurate (w
->hchild
, accurate_p
);
11947 update_overlay_arrows (1);
11951 /* Force a thorough redisplay the next time by setting
11952 last_arrow_position and last_arrow_string to t, which is
11953 unequal to any useful value of Voverlay_arrow_... */
11954 update_overlay_arrows (-1);
11959 /* Return value in display table DP (Lisp_Char_Table *) for character
11960 C. Since a display table doesn't have any parent, we don't have to
11961 follow parent. Do not call this function directly but use the
11962 macro DISP_CHAR_VECTOR. */
11965 disp_char_vector (dp
, c
)
11966 struct Lisp_Char_Table
*dp
;
11971 if (ASCII_CHAR_P (c
))
11974 if (SUB_CHAR_TABLE_P (val
))
11975 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
11981 XSETCHAR_TABLE (table
, dp
);
11982 val
= char_table_ref (table
, c
);
11991 /***********************************************************************
11993 ***********************************************************************/
11995 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
11998 redisplay_windows (window
)
11999 Lisp_Object window
;
12001 while (!NILP (window
))
12003 struct window
*w
= XWINDOW (window
);
12005 if (!NILP (w
->hchild
))
12006 redisplay_windows (w
->hchild
);
12007 else if (!NILP (w
->vchild
))
12008 redisplay_windows (w
->vchild
);
12011 displayed_buffer
= XBUFFER (w
->buffer
);
12012 /* Use list_of_error, not Qerror, so that
12013 we catch only errors and don't run the debugger. */
12014 internal_condition_case_1 (redisplay_window_0
, window
,
12016 redisplay_window_error
);
12024 redisplay_window_error ()
12026 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12031 redisplay_window_0 (window
)
12032 Lisp_Object window
;
12034 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12035 redisplay_window (window
, 0);
12040 redisplay_window_1 (window
)
12041 Lisp_Object window
;
12043 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12044 redisplay_window (window
, 1);
12049 /* Increment GLYPH until it reaches END or CONDITION fails while
12050 adding (GLYPH)->pixel_width to X. */
12052 #define SKIP_GLYPHS(glyph, end, x, condition) \
12055 (x) += (glyph)->pixel_width; \
12058 while ((glyph) < (end) && (condition))
12061 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12062 DELTA is the number of bytes by which positions recorded in ROW
12063 differ from current buffer positions.
12065 Return 0 if cursor is not on this row. 1 otherwise. */
12068 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12070 struct glyph_row
*row
;
12071 struct glyph_matrix
*matrix
;
12072 int delta
, delta_bytes
, dy
, dvpos
;
12074 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12075 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12076 struct glyph
*cursor
= NULL
;
12077 /* The first glyph that starts a sequence of glyphs from string. */
12078 struct glyph
*string_start
;
12079 /* The X coordinate of string_start. */
12080 int string_start_x
;
12081 /* The last known character position. */
12082 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12083 /* The last known character position before string_start. */
12084 int string_before_pos
;
12087 int cursor_from_overlay_pos
= 0;
12088 int pt_old
= PT
- delta
;
12090 /* Skip over glyphs not having an object at the start of the row.
12091 These are special glyphs like truncation marks on terminal
12093 if (row
->displays_text_p
)
12095 && INTEGERP (glyph
->object
)
12096 && glyph
->charpos
< 0)
12098 x
+= glyph
->pixel_width
;
12102 string_start
= NULL
;
12104 && !INTEGERP (glyph
->object
)
12105 && (!BUFFERP (glyph
->object
)
12106 || (last_pos
= glyph
->charpos
) < pt_old
))
12108 if (! STRINGP (glyph
->object
))
12110 string_start
= NULL
;
12111 x
+= glyph
->pixel_width
;
12113 if (cursor_from_overlay_pos
12114 && last_pos
>= cursor_from_overlay_pos
)
12116 cursor_from_overlay_pos
= 0;
12122 if (string_start
== NULL
)
12124 string_before_pos
= last_pos
;
12125 string_start
= glyph
;
12126 string_start_x
= x
;
12128 /* Skip all glyphs from string. */
12133 if ((cursor
== NULL
|| glyph
> cursor
)
12134 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12135 Qcursor
, (glyph
)->object
),
12137 && (pos
= string_buffer_position (w
, glyph
->object
,
12138 string_before_pos
),
12139 (pos
== 0 /* From overlay */
12140 || pos
== pt_old
)))
12142 /* Estimate overlay buffer position from the buffer
12143 positions of the glyphs before and after the overlay.
12144 Add 1 to last_pos so that if point corresponds to the
12145 glyph right after the overlay, we still use a 'cursor'
12146 property found in that overlay. */
12147 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12148 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12152 x
+= glyph
->pixel_width
;
12155 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12159 if (cursor
!= NULL
)
12164 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12166 /* Scan back over the ellipsis glyphs, decrementing positions. */
12167 while (glyph
> row
->glyphs
[TEXT_AREA
]
12168 && (glyph
- 1)->charpos
== last_pos
)
12169 glyph
--, x
-= glyph
->pixel_width
;
12170 /* That loop always goes one position too far,
12171 including the glyph before the ellipsis.
12172 So scan forward over that one. */
12173 x
+= glyph
->pixel_width
;
12176 else if (string_start
12177 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12179 /* We may have skipped over point because the previous glyphs
12180 are from string. As there's no easy way to know the
12181 character position of the current glyph, find the correct
12182 glyph on point by scanning from string_start again. */
12184 Lisp_Object string
;
12185 struct glyph
*stop
= glyph
;
12188 limit
= make_number (pt_old
+ 1);
12189 glyph
= string_start
;
12190 x
= string_start_x
;
12191 string
= glyph
->object
;
12192 pos
= string_buffer_position (w
, string
, string_before_pos
);
12193 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12194 because we always put cursor after overlay strings. */
12195 while (pos
== 0 && glyph
< stop
)
12197 string
= glyph
->object
;
12198 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12200 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12203 while (glyph
< stop
)
12205 pos
= XINT (Fnext_single_char_property_change
12206 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12209 /* Skip glyphs from the same string. */
12210 string
= glyph
->object
;
12211 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12212 /* Skip glyphs from an overlay. */
12213 while (glyph
< stop
12214 && ! string_buffer_position (w
, glyph
->object
, pos
))
12216 string
= glyph
->object
;
12217 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12221 /* If we reached the end of the line, and end was from a string,
12222 cursor is not on this line. */
12223 if (glyph
== end
&& row
->continued_p
)
12227 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12229 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12230 w
->cursor
.y
= row
->y
+ dy
;
12232 if (w
== XWINDOW (selected_window
))
12234 if (!row
->continued_p
12235 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12238 this_line_buffer
= XBUFFER (w
->buffer
);
12240 CHARPOS (this_line_start_pos
)
12241 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12242 BYTEPOS (this_line_start_pos
)
12243 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12245 CHARPOS (this_line_end_pos
)
12246 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12247 BYTEPOS (this_line_end_pos
)
12248 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12250 this_line_y
= w
->cursor
.y
;
12251 this_line_pixel_height
= row
->height
;
12252 this_line_vpos
= w
->cursor
.vpos
;
12253 this_line_start_x
= row
->x
;
12256 CHARPOS (this_line_start_pos
) = 0;
12263 /* Run window scroll functions, if any, for WINDOW with new window
12264 start STARTP. Sets the window start of WINDOW to that position.
12266 We assume that the window's buffer is really current. */
12268 static INLINE
struct text_pos
12269 run_window_scroll_functions (window
, startp
)
12270 Lisp_Object window
;
12271 struct text_pos startp
;
12273 struct window
*w
= XWINDOW (window
);
12274 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12276 if (current_buffer
!= XBUFFER (w
->buffer
))
12279 if (!NILP (Vwindow_scroll_functions
))
12281 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12282 make_number (CHARPOS (startp
)));
12283 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12284 /* In case the hook functions switch buffers. */
12285 if (current_buffer
!= XBUFFER (w
->buffer
))
12286 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12293 /* Make sure the line containing the cursor is fully visible.
12294 A value of 1 means there is nothing to be done.
12295 (Either the line is fully visible, or it cannot be made so,
12296 or we cannot tell.)
12298 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12299 is higher than window.
12301 A value of 0 means the caller should do scrolling
12302 as if point had gone off the screen. */
12305 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12308 int current_matrix_p
;
12310 struct glyph_matrix
*matrix
;
12311 struct glyph_row
*row
;
12314 if (!make_cursor_line_fully_visible_p
)
12317 /* It's not always possible to find the cursor, e.g, when a window
12318 is full of overlay strings. Don't do anything in that case. */
12319 if (w
->cursor
.vpos
< 0)
12322 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12323 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12325 /* If the cursor row is not partially visible, there's nothing to do. */
12326 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12329 /* If the row the cursor is in is taller than the window's height,
12330 it's not clear what to do, so do nothing. */
12331 window_height
= window_box_height (w
);
12332 if (row
->height
>= window_height
)
12334 if (!force_p
|| MINI_WINDOW_P (w
)
12335 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12341 /* This code used to try to scroll the window just enough to make
12342 the line visible. It returned 0 to say that the caller should
12343 allocate larger glyph matrices. */
12345 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12347 int dy
= row
->height
- row
->visible_height
;
12350 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12352 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12354 int dy
= - (row
->height
- row
->visible_height
);
12357 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12360 /* When we change the cursor y-position of the selected window,
12361 change this_line_y as well so that the display optimization for
12362 the cursor line of the selected window in redisplay_internal uses
12363 the correct y-position. */
12364 if (w
== XWINDOW (selected_window
))
12365 this_line_y
= w
->cursor
.y
;
12367 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12368 redisplay with larger matrices. */
12369 if (matrix
->nrows
< required_matrix_height (w
))
12371 fonts_changed_p
= 1;
12380 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12381 non-zero means only WINDOW is redisplayed in redisplay_internal.
12382 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12383 in redisplay_window to bring a partially visible line into view in
12384 the case that only the cursor has moved.
12386 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12387 last screen line's vertical height extends past the end of the screen.
12391 1 if scrolling succeeded
12393 0 if scrolling didn't find point.
12395 -1 if new fonts have been loaded so that we must interrupt
12396 redisplay, adjust glyph matrices, and try again. */
12402 SCROLLING_NEED_LARGER_MATRICES
12406 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12407 scroll_step
, temp_scroll_step
, last_line_misfit
)
12408 Lisp_Object window
;
12409 int just_this_one_p
;
12410 EMACS_INT scroll_conservatively
, scroll_step
;
12411 int temp_scroll_step
;
12412 int last_line_misfit
;
12414 struct window
*w
= XWINDOW (window
);
12415 struct frame
*f
= XFRAME (w
->frame
);
12416 struct text_pos scroll_margin_pos
;
12417 struct text_pos pos
;
12418 struct text_pos startp
;
12420 Lisp_Object window_end
;
12421 int this_scroll_margin
;
12425 int amount_to_scroll
= 0;
12426 Lisp_Object aggressive
;
12428 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12431 debug_method_add (w
, "try_scrolling");
12434 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12436 /* Compute scroll margin height in pixels. We scroll when point is
12437 within this distance from the top or bottom of the window. */
12438 if (scroll_margin
> 0)
12440 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12441 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12444 this_scroll_margin
= 0;
12446 /* Force scroll_conservatively to have a reasonable value so it doesn't
12447 cause an overflow while computing how much to scroll. */
12448 if (scroll_conservatively
)
12449 scroll_conservatively
= min (scroll_conservatively
,
12450 MOST_POSITIVE_FIXNUM
/ FRAME_LINE_HEIGHT (f
));
12452 /* Compute how much we should try to scroll maximally to bring point
12454 if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12455 scroll_max
= max (scroll_step
,
12456 max (scroll_conservatively
, temp_scroll_step
));
12457 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12458 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12459 /* We're trying to scroll because of aggressive scrolling
12460 but no scroll_step is set. Choose an arbitrary one. Maybe
12461 there should be a variable for this. */
12465 scroll_max
*= FRAME_LINE_HEIGHT (f
);
12467 /* Decide whether we have to scroll down. Start at the window end
12468 and move this_scroll_margin up to find the position of the scroll
12470 window_end
= Fwindow_end (window
, Qt
);
12474 CHARPOS (scroll_margin_pos
) = XINT (window_end
);
12475 BYTEPOS (scroll_margin_pos
) = CHAR_TO_BYTE (CHARPOS (scroll_margin_pos
));
12477 if (this_scroll_margin
|| extra_scroll_margin_lines
)
12479 start_display (&it
, w
, scroll_margin_pos
);
12480 if (this_scroll_margin
)
12481 move_it_vertically_backward (&it
, this_scroll_margin
);
12482 if (extra_scroll_margin_lines
)
12483 move_it_by_lines (&it
, - extra_scroll_margin_lines
, 0);
12484 scroll_margin_pos
= it
.current
.pos
;
12487 if (PT
>= CHARPOS (scroll_margin_pos
))
12491 /* Point is in the scroll margin at the bottom of the window, or
12492 below. Compute a new window start that makes point visible. */
12494 /* Compute the distance from the scroll margin to PT.
12495 Give up if the distance is greater than scroll_max. */
12496 start_display (&it
, w
, scroll_margin_pos
);
12498 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
12499 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12501 /* To make point visible, we have to move the window start
12502 down so that the line the cursor is in is visible, which
12503 means we have to add in the height of the cursor line. */
12504 dy
= line_bottom_y (&it
) - y0
;
12506 if (dy
> scroll_max
)
12507 return SCROLLING_FAILED
;
12509 /* Move the window start down. If scrolling conservatively,
12510 move it just enough down to make point visible. If
12511 scroll_step is set, move it down by scroll_step. */
12512 start_display (&it
, w
, startp
);
12514 if (scroll_conservatively
)
12515 /* Set AMOUNT_TO_SCROLL to at least one line,
12516 and at most scroll_conservatively lines. */
12518 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12519 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12520 else if (scroll_step
|| temp_scroll_step
)
12521 amount_to_scroll
= scroll_max
;
12524 aggressive
= current_buffer
->scroll_up_aggressively
;
12525 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12526 if (NUMBERP (aggressive
))
12528 double float_amount
= XFLOATINT (aggressive
) * height
;
12529 amount_to_scroll
= float_amount
;
12530 if (amount_to_scroll
== 0 && float_amount
> 0)
12531 amount_to_scroll
= 1;
12535 if (amount_to_scroll
<= 0)
12536 return SCROLLING_FAILED
;
12538 /* If moving by amount_to_scroll leaves STARTP unchanged,
12539 move it down one screen line. */
12541 move_it_vertically (&it
, amount_to_scroll
);
12542 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12543 move_it_by_lines (&it
, 1, 1);
12544 startp
= it
.current
.pos
;
12548 /* See if point is inside the scroll margin at the top of the
12550 scroll_margin_pos
= startp
;
12551 if (this_scroll_margin
)
12553 start_display (&it
, w
, startp
);
12554 move_it_vertically (&it
, this_scroll_margin
);
12555 scroll_margin_pos
= it
.current
.pos
;
12558 if (PT
< CHARPOS (scroll_margin_pos
))
12560 /* Point is in the scroll margin at the top of the window or
12561 above what is displayed in the window. */
12564 /* Compute the vertical distance from PT to the scroll
12565 margin position. Give up if distance is greater than
12567 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12568 start_display (&it
, w
, pos
);
12570 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12571 it
.last_visible_y
, -1,
12572 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12573 dy
= it
.current_y
- y0
;
12574 if (dy
> scroll_max
)
12575 return SCROLLING_FAILED
;
12577 /* Compute new window start. */
12578 start_display (&it
, w
, startp
);
12580 if (scroll_conservatively
)
12582 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12583 else if (scroll_step
|| temp_scroll_step
)
12584 amount_to_scroll
= scroll_max
;
12587 aggressive
= current_buffer
->scroll_down_aggressively
;
12588 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12589 if (NUMBERP (aggressive
))
12591 double float_amount
= XFLOATINT (aggressive
) * height
;
12592 amount_to_scroll
= float_amount
;
12593 if (amount_to_scroll
== 0 && float_amount
> 0)
12594 amount_to_scroll
= 1;
12598 if (amount_to_scroll
<= 0)
12599 return SCROLLING_FAILED
;
12601 move_it_vertically_backward (&it
, amount_to_scroll
);
12602 startp
= it
.current
.pos
;
12606 /* Run window scroll functions. */
12607 startp
= run_window_scroll_functions (window
, startp
);
12609 /* Display the window. Give up if new fonts are loaded, or if point
12611 if (!try_window (window
, startp
, 0))
12612 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12613 else if (w
->cursor
.vpos
< 0)
12615 clear_glyph_matrix (w
->desired_matrix
);
12616 rc
= SCROLLING_FAILED
;
12620 /* Maybe forget recorded base line for line number display. */
12621 if (!just_this_one_p
12622 || current_buffer
->clip_changed
12623 || BEG_UNCHANGED
< CHARPOS (startp
))
12624 w
->base_line_number
= Qnil
;
12626 /* If cursor ends up on a partially visible line,
12627 treat that as being off the bottom of the screen. */
12628 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12630 clear_glyph_matrix (w
->desired_matrix
);
12631 ++extra_scroll_margin_lines
;
12634 rc
= SCROLLING_SUCCESS
;
12641 /* Compute a suitable window start for window W if display of W starts
12642 on a continuation line. Value is non-zero if a new window start
12645 The new window start will be computed, based on W's width, starting
12646 from the start of the continued line. It is the start of the
12647 screen line with the minimum distance from the old start W->start. */
12650 compute_window_start_on_continuation_line (w
)
12653 struct text_pos pos
, start_pos
;
12654 int window_start_changed_p
= 0;
12656 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12658 /* If window start is on a continuation line... Window start may be
12659 < BEGV in case there's invisible text at the start of the
12660 buffer (M-x rmail, for example). */
12661 if (CHARPOS (start_pos
) > BEGV
12662 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12665 struct glyph_row
*row
;
12667 /* Handle the case that the window start is out of range. */
12668 if (CHARPOS (start_pos
) < BEGV
)
12669 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12670 else if (CHARPOS (start_pos
) > ZV
)
12671 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12673 /* Find the start of the continued line. This should be fast
12674 because scan_buffer is fast (newline cache). */
12675 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12676 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12677 row
, DEFAULT_FACE_ID
);
12678 reseat_at_previous_visible_line_start (&it
);
12680 /* If the line start is "too far" away from the window start,
12681 say it takes too much time to compute a new window start. */
12682 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12683 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12685 int min_distance
, distance
;
12687 /* Move forward by display lines to find the new window
12688 start. If window width was enlarged, the new start can
12689 be expected to be > the old start. If window width was
12690 decreased, the new window start will be < the old start.
12691 So, we're looking for the display line start with the
12692 minimum distance from the old window start. */
12693 pos
= it
.current
.pos
;
12694 min_distance
= INFINITY
;
12695 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12696 distance
< min_distance
)
12698 min_distance
= distance
;
12699 pos
= it
.current
.pos
;
12700 move_it_by_lines (&it
, 1, 0);
12703 /* Set the window start there. */
12704 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12705 window_start_changed_p
= 1;
12709 return window_start_changed_p
;
12713 /* Try cursor movement in case text has not changed in window WINDOW,
12714 with window start STARTP. Value is
12716 CURSOR_MOVEMENT_SUCCESS if successful
12718 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12720 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12721 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12722 we want to scroll as if scroll-step were set to 1. See the code.
12724 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12725 which case we have to abort this redisplay, and adjust matrices
12730 CURSOR_MOVEMENT_SUCCESS
,
12731 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12732 CURSOR_MOVEMENT_MUST_SCROLL
,
12733 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12737 try_cursor_movement (window
, startp
, scroll_step
)
12738 Lisp_Object window
;
12739 struct text_pos startp
;
12742 struct window
*w
= XWINDOW (window
);
12743 struct frame
*f
= XFRAME (w
->frame
);
12744 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12747 if (inhibit_try_cursor_movement
)
12751 /* Handle case where text has not changed, only point, and it has
12752 not moved off the frame. */
12753 if (/* Point may be in this window. */
12754 PT
>= CHARPOS (startp
)
12755 /* Selective display hasn't changed. */
12756 && !current_buffer
->clip_changed
12757 /* Function force-mode-line-update is used to force a thorough
12758 redisplay. It sets either windows_or_buffers_changed or
12759 update_mode_lines. So don't take a shortcut here for these
12761 && !update_mode_lines
12762 && !windows_or_buffers_changed
12763 && !cursor_type_changed
12764 /* Can't use this case if highlighting a region. When a
12765 region exists, cursor movement has to do more than just
12767 && !(!NILP (Vtransient_mark_mode
)
12768 && !NILP (current_buffer
->mark_active
))
12769 && NILP (w
->region_showing
)
12770 && NILP (Vshow_trailing_whitespace
)
12771 /* Right after splitting windows, last_point may be nil. */
12772 && INTEGERP (w
->last_point
)
12773 /* This code is not used for mini-buffer for the sake of the case
12774 of redisplaying to replace an echo area message; since in
12775 that case the mini-buffer contents per se are usually
12776 unchanged. This code is of no real use in the mini-buffer
12777 since the handling of this_line_start_pos, etc., in redisplay
12778 handles the same cases. */
12779 && !EQ (window
, minibuf_window
)
12780 /* When splitting windows or for new windows, it happens that
12781 redisplay is called with a nil window_end_vpos or one being
12782 larger than the window. This should really be fixed in
12783 window.c. I don't have this on my list, now, so we do
12784 approximately the same as the old redisplay code. --gerd. */
12785 && INTEGERP (w
->window_end_vpos
)
12786 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12787 && (FRAME_WINDOW_P (f
)
12788 || !overlay_arrow_in_current_buffer_p ()))
12790 int this_scroll_margin
, top_scroll_margin
;
12791 struct glyph_row
*row
= NULL
;
12794 debug_method_add (w
, "cursor movement");
12797 /* Scroll if point within this distance from the top or bottom
12798 of the window. This is a pixel value. */
12799 this_scroll_margin
= max (0, scroll_margin
);
12800 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12801 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12803 top_scroll_margin
= this_scroll_margin
;
12804 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12805 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12807 /* Start with the row the cursor was displayed during the last
12808 not paused redisplay. Give up if that row is not valid. */
12809 if (w
->last_cursor
.vpos
< 0
12810 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12811 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12814 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12815 if (row
->mode_line_p
)
12817 if (!row
->enabled_p
)
12818 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12821 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
12824 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
12826 if (PT
> XFASTINT (w
->last_point
))
12828 /* Point has moved forward. */
12829 while (MATRIX_ROW_END_CHARPOS (row
) < PT
12830 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
12832 xassert (row
->enabled_p
);
12836 /* The end position of a row equals the start position
12837 of the next row. If PT is there, we would rather
12838 display it in the next line. */
12839 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12840 && MATRIX_ROW_END_CHARPOS (row
) == PT
12841 && !cursor_row_p (w
, row
))
12844 /* If within the scroll margin, scroll. Note that
12845 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
12846 the next line would be drawn, and that
12847 this_scroll_margin can be zero. */
12848 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
12849 || PT
> MATRIX_ROW_END_CHARPOS (row
)
12850 /* Line is completely visible last line in window
12851 and PT is to be set in the next line. */
12852 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
12853 && PT
== MATRIX_ROW_END_CHARPOS (row
)
12854 && !row
->ends_at_zv_p
12855 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
12858 else if (PT
< XFASTINT (w
->last_point
))
12860 /* Cursor has to be moved backward. Note that PT >=
12861 CHARPOS (startp) because of the outer if-statement. */
12862 while (!row
->mode_line_p
12863 && (MATRIX_ROW_START_CHARPOS (row
) > PT
12864 || (MATRIX_ROW_START_CHARPOS (row
) == PT
12865 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
12866 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
12867 row
> w
->current_matrix
->rows
12868 && (row
-1)->ends_in_newline_from_string_p
))))
12869 && (row
->y
> top_scroll_margin
12870 || CHARPOS (startp
) == BEGV
))
12872 xassert (row
->enabled_p
);
12876 /* Consider the following case: Window starts at BEGV,
12877 there is invisible, intangible text at BEGV, so that
12878 display starts at some point START > BEGV. It can
12879 happen that we are called with PT somewhere between
12880 BEGV and START. Try to handle that case. */
12881 if (row
< w
->current_matrix
->rows
12882 || row
->mode_line_p
)
12884 row
= w
->current_matrix
->rows
;
12885 if (row
->mode_line_p
)
12889 /* Due to newlines in overlay strings, we may have to
12890 skip forward over overlay strings. */
12891 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12892 && MATRIX_ROW_END_CHARPOS (row
) == PT
12893 && !cursor_row_p (w
, row
))
12896 /* If within the scroll margin, scroll. */
12897 if (row
->y
< top_scroll_margin
12898 && CHARPOS (startp
) != BEGV
)
12903 /* Cursor did not move. So don't scroll even if cursor line
12904 is partially visible, as it was so before. */
12905 rc
= CURSOR_MOVEMENT_SUCCESS
;
12908 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
12909 || PT
> MATRIX_ROW_END_CHARPOS (row
))
12911 /* if PT is not in the glyph row, give up. */
12912 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12914 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
12915 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
12916 && make_cursor_line_fully_visible_p
)
12918 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
12919 && !row
->ends_at_zv_p
12920 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
12921 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12922 else if (row
->height
> window_box_height (w
))
12924 /* If we end up in a partially visible line, let's
12925 make it fully visible, except when it's taller
12926 than the window, in which case we can't do much
12929 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12933 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12934 if (!cursor_row_fully_visible_p (w
, 0, 1))
12935 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12937 rc
= CURSOR_MOVEMENT_SUCCESS
;
12941 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12946 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
12948 rc
= CURSOR_MOVEMENT_SUCCESS
;
12953 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
12954 && MATRIX_ROW_START_CHARPOS (row
) == PT
12955 && cursor_row_p (w
, row
));
12964 set_vertical_scroll_bar (w
)
12967 int start
, end
, whole
;
12969 /* Calculate the start and end positions for the current window.
12970 At some point, it would be nice to choose between scrollbars
12971 which reflect the whole buffer size, with special markers
12972 indicating narrowing, and scrollbars which reflect only the
12975 Note that mini-buffers sometimes aren't displaying any text. */
12976 if (!MINI_WINDOW_P (w
)
12977 || (w
== XWINDOW (minibuf_window
)
12978 && NILP (echo_area_buffer
[0])))
12980 struct buffer
*buf
= XBUFFER (w
->buffer
);
12981 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
12982 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
12983 /* I don't think this is guaranteed to be right. For the
12984 moment, we'll pretend it is. */
12985 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
12989 if (whole
< (end
- start
))
12990 whole
= end
- start
;
12993 start
= end
= whole
= 0;
12995 /* Indicate what this scroll bar ought to be displaying now. */
12996 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
12997 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
12998 (w
, end
- start
, whole
, start
);
13002 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13003 selected_window is redisplayed.
13005 We can return without actually redisplaying the window if
13006 fonts_changed_p is nonzero. In that case, redisplay_internal will
13010 redisplay_window (window
, just_this_one_p
)
13011 Lisp_Object window
;
13012 int just_this_one_p
;
13014 struct window
*w
= XWINDOW (window
);
13015 struct frame
*f
= XFRAME (w
->frame
);
13016 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13017 struct buffer
*old
= current_buffer
;
13018 struct text_pos lpoint
, opoint
, startp
;
13019 int update_mode_line
;
13022 /* Record it now because it's overwritten. */
13023 int current_matrix_up_to_date_p
= 0;
13024 int used_current_matrix_p
= 0;
13025 /* This is less strict than current_matrix_up_to_date_p.
13026 It indictes that the buffer contents and narrowing are unchanged. */
13027 int buffer_unchanged_p
= 0;
13028 int temp_scroll_step
= 0;
13029 int count
= SPECPDL_INDEX ();
13031 int centering_position
= -1;
13032 int last_line_misfit
= 0;
13033 int beg_unchanged
, end_unchanged
;
13035 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13038 /* W must be a leaf window here. */
13039 xassert (!NILP (w
->buffer
));
13041 *w
->desired_matrix
->method
= 0;
13045 reconsider_clip_changes (w
, buffer
);
13047 /* Has the mode line to be updated? */
13048 update_mode_line
= (!NILP (w
->update_mode_line
)
13049 || update_mode_lines
13050 || buffer
->clip_changed
13051 || buffer
->prevent_redisplay_optimizations_p
);
13053 if (MINI_WINDOW_P (w
))
13055 if (w
== XWINDOW (echo_area_window
)
13056 && !NILP (echo_area_buffer
[0]))
13058 if (update_mode_line
)
13059 /* We may have to update a tty frame's menu bar or a
13060 tool-bar. Example `M-x C-h C-h C-g'. */
13061 goto finish_menu_bars
;
13063 /* We've already displayed the echo area glyphs in this window. */
13064 goto finish_scroll_bars
;
13066 else if ((w
!= XWINDOW (minibuf_window
)
13067 || minibuf_level
== 0)
13068 /* When buffer is nonempty, redisplay window normally. */
13069 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13070 /* Quail displays non-mini buffers in minibuffer window.
13071 In that case, redisplay the window normally. */
13072 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13074 /* W is a mini-buffer window, but it's not active, so clear
13076 int yb
= window_text_bottom_y (w
);
13077 struct glyph_row
*row
;
13080 for (y
= 0, row
= w
->desired_matrix
->rows
;
13082 y
+= row
->height
, ++row
)
13083 blank_row (w
, row
, y
);
13084 goto finish_scroll_bars
;
13087 clear_glyph_matrix (w
->desired_matrix
);
13090 /* Otherwise set up data on this window; select its buffer and point
13092 /* Really select the buffer, for the sake of buffer-local
13094 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13096 current_matrix_up_to_date_p
13097 = (!NILP (w
->window_end_valid
)
13098 && !current_buffer
->clip_changed
13099 && !current_buffer
->prevent_redisplay_optimizations_p
13100 && XFASTINT (w
->last_modified
) >= MODIFF
13101 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13103 /* Run the window-bottom-change-functions
13104 if it is possible that the text on the screen has changed
13105 (either due to modification of the text, or any other reason). */
13106 if (!current_matrix_up_to_date_p
13107 && !NILP (Vwindow_text_change_functions
))
13109 safe_run_hooks (Qwindow_text_change_functions
);
13113 beg_unchanged
= BEG_UNCHANGED
;
13114 end_unchanged
= END_UNCHANGED
;
13116 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13118 specbind (Qinhibit_point_motion_hooks
, Qt
);
13121 = (!NILP (w
->window_end_valid
)
13122 && !current_buffer
->clip_changed
13123 && XFASTINT (w
->last_modified
) >= MODIFF
13124 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13126 /* When windows_or_buffers_changed is non-zero, we can't rely on
13127 the window end being valid, so set it to nil there. */
13128 if (windows_or_buffers_changed
)
13130 /* If window starts on a continuation line, maybe adjust the
13131 window start in case the window's width changed. */
13132 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13133 compute_window_start_on_continuation_line (w
);
13135 w
->window_end_valid
= Qnil
;
13138 /* Some sanity checks. */
13139 CHECK_WINDOW_END (w
);
13140 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13142 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13145 /* If %c is in mode line, update it if needed. */
13146 if (!NILP (w
->column_number_displayed
)
13147 /* This alternative quickly identifies a common case
13148 where no change is needed. */
13149 && !(PT
== XFASTINT (w
->last_point
)
13150 && XFASTINT (w
->last_modified
) >= MODIFF
13151 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13152 && (XFASTINT (w
->column_number_displayed
)
13153 != (int) current_column ())) /* iftc */
13154 update_mode_line
= 1;
13156 /* Count number of windows showing the selected buffer. An indirect
13157 buffer counts as its base buffer. */
13158 if (!just_this_one_p
)
13160 struct buffer
*current_base
, *window_base
;
13161 current_base
= current_buffer
;
13162 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13163 if (current_base
->base_buffer
)
13164 current_base
= current_base
->base_buffer
;
13165 if (window_base
->base_buffer
)
13166 window_base
= window_base
->base_buffer
;
13167 if (current_base
== window_base
)
13171 /* Point refers normally to the selected window. For any other
13172 window, set up appropriate value. */
13173 if (!EQ (window
, selected_window
))
13175 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13176 int new_pt_byte
= marker_byte_position (w
->pointm
);
13180 new_pt_byte
= BEGV_BYTE
;
13181 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13183 else if (new_pt
> (ZV
- 1))
13186 new_pt_byte
= ZV_BYTE
;
13187 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13190 /* We don't use SET_PT so that the point-motion hooks don't run. */
13191 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13194 /* If any of the character widths specified in the display table
13195 have changed, invalidate the width run cache. It's true that
13196 this may be a bit late to catch such changes, but the rest of
13197 redisplay goes (non-fatally) haywire when the display table is
13198 changed, so why should we worry about doing any better? */
13199 if (current_buffer
->width_run_cache
)
13201 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13203 if (! disptab_matches_widthtab (disptab
,
13204 XVECTOR (current_buffer
->width_table
)))
13206 invalidate_region_cache (current_buffer
,
13207 current_buffer
->width_run_cache
,
13209 recompute_width_table (current_buffer
, disptab
);
13213 /* If window-start is screwed up, choose a new one. */
13214 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13217 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13219 /* If someone specified a new starting point but did not insist,
13220 check whether it can be used. */
13221 if (!NILP (w
->optional_new_start
)
13222 && CHARPOS (startp
) >= BEGV
13223 && CHARPOS (startp
) <= ZV
)
13225 w
->optional_new_start
= Qnil
;
13226 start_display (&it
, w
, startp
);
13227 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13228 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13229 if (IT_CHARPOS (it
) == PT
)
13230 w
->force_start
= Qt
;
13231 /* IT may overshoot PT if text at PT is invisible. */
13232 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13233 w
->force_start
= Qt
;
13238 /* Handle case where place to start displaying has been specified,
13239 unless the specified location is outside the accessible range. */
13240 if (!NILP (w
->force_start
)
13241 || w
->frozen_window_start_p
)
13243 /* We set this later on if we have to adjust point. */
13247 w
->force_start
= Qnil
;
13249 w
->window_end_valid
= Qnil
;
13251 /* Forget any recorded base line for line number display. */
13252 if (!buffer_unchanged_p
)
13253 w
->base_line_number
= Qnil
;
13255 /* Redisplay the mode line. Select the buffer properly for that.
13256 Also, run the hook window-scroll-functions
13257 because we have scrolled. */
13258 /* Note, we do this after clearing force_start because
13259 if there's an error, it is better to forget about force_start
13260 than to get into an infinite loop calling the hook functions
13261 and having them get more errors. */
13262 if (!update_mode_line
13263 || ! NILP (Vwindow_scroll_functions
))
13265 update_mode_line
= 1;
13266 w
->update_mode_line
= Qt
;
13267 startp
= run_window_scroll_functions (window
, startp
);
13270 w
->last_modified
= make_number (0);
13271 w
->last_overlay_modified
= make_number (0);
13272 if (CHARPOS (startp
) < BEGV
)
13273 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13274 else if (CHARPOS (startp
) > ZV
)
13275 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13277 /* Redisplay, then check if cursor has been set during the
13278 redisplay. Give up if new fonts were loaded. */
13279 val
= try_window (window
, startp
, 1);
13282 w
->force_start
= Qt
;
13283 clear_glyph_matrix (w
->desired_matrix
);
13284 goto need_larger_matrices
;
13286 /* Point was outside the scroll margins. */
13288 new_vpos
= window_box_height (w
) / 2;
13290 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13292 /* If point does not appear, try to move point so it does
13293 appear. The desired matrix has been built above, so we
13294 can use it here. */
13295 new_vpos
= window_box_height (w
) / 2;
13298 if (!cursor_row_fully_visible_p (w
, 0, 0))
13300 /* Point does appear, but on a line partly visible at end of window.
13301 Move it back to a fully-visible line. */
13302 new_vpos
= window_box_height (w
);
13305 /* If we need to move point for either of the above reasons,
13306 now actually do it. */
13309 struct glyph_row
*row
;
13311 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13312 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13315 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13316 MATRIX_ROW_START_BYTEPOS (row
));
13318 if (w
!= XWINDOW (selected_window
))
13319 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13320 else if (current_buffer
== old
)
13321 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13323 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13325 /* If we are highlighting the region, then we just changed
13326 the region, so redisplay to show it. */
13327 if (!NILP (Vtransient_mark_mode
)
13328 && !NILP (current_buffer
->mark_active
))
13330 clear_glyph_matrix (w
->desired_matrix
);
13331 if (!try_window (window
, startp
, 0))
13332 goto need_larger_matrices
;
13337 debug_method_add (w
, "forced window start");
13342 /* Handle case where text has not changed, only point, and it has
13343 not moved off the frame, and we are not retrying after hscroll.
13344 (current_matrix_up_to_date_p is nonzero when retrying.) */
13345 if (current_matrix_up_to_date_p
13346 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13347 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13351 case CURSOR_MOVEMENT_SUCCESS
:
13352 used_current_matrix_p
= 1;
13355 #if 0 /* try_cursor_movement never returns this value. */
13356 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13357 goto need_larger_matrices
;
13360 case CURSOR_MOVEMENT_MUST_SCROLL
:
13361 goto try_to_scroll
;
13367 /* If current starting point was originally the beginning of a line
13368 but no longer is, find a new starting point. */
13369 else if (!NILP (w
->start_at_line_beg
)
13370 && !(CHARPOS (startp
) <= BEGV
13371 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13374 debug_method_add (w
, "recenter 1");
13379 /* Try scrolling with try_window_id. Value is > 0 if update has
13380 been done, it is -1 if we know that the same window start will
13381 not work. It is 0 if unsuccessful for some other reason. */
13382 else if ((tem
= try_window_id (w
)) != 0)
13385 debug_method_add (w
, "try_window_id %d", tem
);
13388 if (fonts_changed_p
)
13389 goto need_larger_matrices
;
13393 /* Otherwise try_window_id has returned -1 which means that we
13394 don't want the alternative below this comment to execute. */
13396 else if (CHARPOS (startp
) >= BEGV
13397 && CHARPOS (startp
) <= ZV
13398 && PT
>= CHARPOS (startp
)
13399 && (CHARPOS (startp
) < ZV
13400 /* Avoid starting at end of buffer. */
13401 || CHARPOS (startp
) == BEGV
13402 || (XFASTINT (w
->last_modified
) >= MODIFF
13403 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13406 /* If first window line is a continuation line, and window start
13407 is inside the modified region, but the first change is before
13408 current window start, we must select a new window start.
13410 However, if this is the result of a down-mouse event (e.g. by
13411 extending the mouse-drag-overlay), we don't want to select a
13412 new window start, since that would change the position under
13413 the mouse, resulting in an unwanted mouse-movement rather
13414 than a simple mouse-click. */
13415 if (NILP (w
->start_at_line_beg
)
13416 && NILP (do_mouse_tracking
)
13417 && CHARPOS (startp
) > BEGV
13418 && CHARPOS (startp
) > BEG
+ beg_unchanged
13419 && CHARPOS (startp
) <= Z
- end_unchanged
)
13421 w
->force_start
= Qt
;
13422 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13423 compute_window_start_on_continuation_line (w
);
13424 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13429 debug_method_add (w
, "same window start");
13432 /* Try to redisplay starting at same place as before.
13433 If point has not moved off frame, accept the results. */
13434 if (!current_matrix_up_to_date_p
13435 /* Don't use try_window_reusing_current_matrix in this case
13436 because a window scroll function can have changed the
13438 || !NILP (Vwindow_scroll_functions
)
13439 || MINI_WINDOW_P (w
)
13440 || !(used_current_matrix_p
13441 = try_window_reusing_current_matrix (w
)))
13443 IF_DEBUG (debug_method_add (w
, "1"));
13444 if (try_window (window
, startp
, 1) < 0)
13445 /* -1 means we need to scroll.
13446 0 means we need new matrices, but fonts_changed_p
13447 is set in that case, so we will detect it below. */
13448 goto try_to_scroll
;
13451 if (fonts_changed_p
)
13452 goto need_larger_matrices
;
13454 if (w
->cursor
.vpos
>= 0)
13456 if (!just_this_one_p
13457 || current_buffer
->clip_changed
13458 || BEG_UNCHANGED
< CHARPOS (startp
))
13459 /* Forget any recorded base line for line number display. */
13460 w
->base_line_number
= Qnil
;
13462 if (!cursor_row_fully_visible_p (w
, 1, 0))
13464 clear_glyph_matrix (w
->desired_matrix
);
13465 last_line_misfit
= 1;
13467 /* Drop through and scroll. */
13472 clear_glyph_matrix (w
->desired_matrix
);
13477 w
->last_modified
= make_number (0);
13478 w
->last_overlay_modified
= make_number (0);
13480 /* Redisplay the mode line. Select the buffer properly for that. */
13481 if (!update_mode_line
)
13483 update_mode_line
= 1;
13484 w
->update_mode_line
= Qt
;
13487 /* Try to scroll by specified few lines. */
13488 if ((scroll_conservatively
13490 || temp_scroll_step
13491 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13492 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13493 && !current_buffer
->clip_changed
13494 && CHARPOS (startp
) >= BEGV
13495 && CHARPOS (startp
) <= ZV
)
13497 /* The function returns -1 if new fonts were loaded, 1 if
13498 successful, 0 if not successful. */
13499 int rc
= try_scrolling (window
, just_this_one_p
,
13500 scroll_conservatively
,
13502 temp_scroll_step
, last_line_misfit
);
13505 case SCROLLING_SUCCESS
:
13508 case SCROLLING_NEED_LARGER_MATRICES
:
13509 goto need_larger_matrices
;
13511 case SCROLLING_FAILED
:
13519 /* Finally, just choose place to start which centers point */
13522 if (centering_position
< 0)
13523 centering_position
= window_box_height (w
) / 2;
13526 debug_method_add (w
, "recenter");
13529 /* w->vscroll = 0; */
13531 /* Forget any previously recorded base line for line number display. */
13532 if (!buffer_unchanged_p
)
13533 w
->base_line_number
= Qnil
;
13535 /* Move backward half the height of the window. */
13536 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13537 it
.current_y
= it
.last_visible_y
;
13538 move_it_vertically_backward (&it
, centering_position
);
13539 xassert (IT_CHARPOS (it
) >= BEGV
);
13541 /* The function move_it_vertically_backward may move over more
13542 than the specified y-distance. If it->w is small, e.g. a
13543 mini-buffer window, we may end up in front of the window's
13544 display area. Start displaying at the start of the line
13545 containing PT in this case. */
13546 if (it
.current_y
<= 0)
13548 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13549 move_it_vertically_backward (&it
, 0);
13551 /* I think this assert is bogus if buffer contains
13552 invisible text or images. KFS. */
13553 xassert (IT_CHARPOS (it
) <= PT
);
13558 it
.current_x
= it
.hpos
= 0;
13560 /* Set startp here explicitly in case that helps avoid an infinite loop
13561 in case the window-scroll-functions functions get errors. */
13562 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13564 /* Run scroll hooks. */
13565 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13567 /* Redisplay the window. */
13568 if (!current_matrix_up_to_date_p
13569 || windows_or_buffers_changed
13570 || cursor_type_changed
13571 /* Don't use try_window_reusing_current_matrix in this case
13572 because it can have changed the buffer. */
13573 || !NILP (Vwindow_scroll_functions
)
13574 || !just_this_one_p
13575 || MINI_WINDOW_P (w
)
13576 || !(used_current_matrix_p
13577 = try_window_reusing_current_matrix (w
)))
13578 try_window (window
, startp
, 0);
13580 /* If new fonts have been loaded (due to fontsets), give up. We
13581 have to start a new redisplay since we need to re-adjust glyph
13583 if (fonts_changed_p
)
13584 goto need_larger_matrices
;
13586 /* If cursor did not appear assume that the middle of the window is
13587 in the first line of the window. Do it again with the next line.
13588 (Imagine a window of height 100, displaying two lines of height
13589 60. Moving back 50 from it->last_visible_y will end in the first
13591 if (w
->cursor
.vpos
< 0)
13593 if (!NILP (w
->window_end_valid
)
13594 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13596 clear_glyph_matrix (w
->desired_matrix
);
13597 move_it_by_lines (&it
, 1, 0);
13598 try_window (window
, it
.current
.pos
, 0);
13600 else if (PT
< IT_CHARPOS (it
))
13602 clear_glyph_matrix (w
->desired_matrix
);
13603 move_it_by_lines (&it
, -1, 0);
13604 try_window (window
, it
.current
.pos
, 0);
13608 /* Not much we can do about it. */
13612 /* Consider the following case: Window starts at BEGV, there is
13613 invisible, intangible text at BEGV, so that display starts at
13614 some point START > BEGV. It can happen that we are called with
13615 PT somewhere between BEGV and START. Try to handle that case. */
13616 if (w
->cursor
.vpos
< 0)
13618 struct glyph_row
*row
= w
->current_matrix
->rows
;
13619 if (row
->mode_line_p
)
13621 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13624 if (!cursor_row_fully_visible_p (w
, 0, 0))
13626 /* If vscroll is enabled, disable it and try again. */
13630 clear_glyph_matrix (w
->desired_matrix
);
13634 /* If centering point failed to make the whole line visible,
13635 put point at the top instead. That has to make the whole line
13636 visible, if it can be done. */
13637 if (centering_position
== 0)
13640 clear_glyph_matrix (w
->desired_matrix
);
13641 centering_position
= 0;
13647 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13648 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13649 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13652 /* Display the mode line, if we must. */
13653 if ((update_mode_line
13654 /* If window not full width, must redo its mode line
13655 if (a) the window to its side is being redone and
13656 (b) we do a frame-based redisplay. This is a consequence
13657 of how inverted lines are drawn in frame-based redisplay. */
13658 || (!just_this_one_p
13659 && !FRAME_WINDOW_P (f
)
13660 && !WINDOW_FULL_WIDTH_P (w
))
13661 /* Line number to display. */
13662 || INTEGERP (w
->base_line_pos
)
13663 /* Column number is displayed and different from the one displayed. */
13664 || (!NILP (w
->column_number_displayed
)
13665 && (XFASTINT (w
->column_number_displayed
)
13666 != (int) current_column ()))) /* iftc */
13667 /* This means that the window has a mode line. */
13668 && (WINDOW_WANTS_MODELINE_P (w
)
13669 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13671 display_mode_lines (w
);
13673 /* If mode line height has changed, arrange for a thorough
13674 immediate redisplay using the correct mode line height. */
13675 if (WINDOW_WANTS_MODELINE_P (w
)
13676 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13678 fonts_changed_p
= 1;
13679 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13680 = DESIRED_MODE_LINE_HEIGHT (w
);
13683 /* If top line height has changed, arrange for a thorough
13684 immediate redisplay using the correct mode line height. */
13685 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13686 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13688 fonts_changed_p
= 1;
13689 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13690 = DESIRED_HEADER_LINE_HEIGHT (w
);
13693 if (fonts_changed_p
)
13694 goto need_larger_matrices
;
13697 if (!line_number_displayed
13698 && !BUFFERP (w
->base_line_pos
))
13700 w
->base_line_pos
= Qnil
;
13701 w
->base_line_number
= Qnil
;
13706 /* When we reach a frame's selected window, redo the frame's menu bar. */
13707 if (update_mode_line
13708 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13710 int redisplay_menu_p
= 0;
13711 int redisplay_tool_bar_p
= 0;
13713 if (FRAME_WINDOW_P (f
))
13715 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
13716 || defined (USE_GTK)
13717 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13719 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13723 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13725 if (redisplay_menu_p
)
13726 display_menu_bar (w
);
13728 #ifdef HAVE_WINDOW_SYSTEM
13729 if (FRAME_WINDOW_P (f
))
13731 #if defined (USE_GTK) || USE_MAC_TOOLBAR
13732 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13734 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13735 && (FRAME_TOOL_BAR_LINES (f
) > 0
13736 || !NILP (Vauto_resize_tool_bars
));
13739 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13741 extern int ignore_mouse_drag_p
;
13742 ignore_mouse_drag_p
= 1;
13748 #ifdef HAVE_WINDOW_SYSTEM
13749 if (FRAME_WINDOW_P (f
)
13750 && update_window_fringes (w
, (just_this_one_p
13751 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13752 || w
->pseudo_window_p
)))
13756 if (draw_window_fringes (w
, 1))
13757 x_draw_vertical_border (w
);
13761 #endif /* HAVE_WINDOW_SYSTEM */
13763 /* We go to this label, with fonts_changed_p nonzero,
13764 if it is necessary to try again using larger glyph matrices.
13765 We have to redeem the scroll bar even in this case,
13766 because the loop in redisplay_internal expects that. */
13767 need_larger_matrices
:
13769 finish_scroll_bars
:
13771 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13773 /* Set the thumb's position and size. */
13774 set_vertical_scroll_bar (w
);
13776 /* Note that we actually used the scroll bar attached to this
13777 window, so it shouldn't be deleted at the end of redisplay. */
13778 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13779 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13782 /* Restore current_buffer and value of point in it. */
13783 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13784 set_buffer_internal_1 (old
);
13785 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13786 shorter. This can be caused by log truncation in *Messages*. */
13787 if (CHARPOS (lpoint
) <= ZV
)
13788 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13790 unbind_to (count
, Qnil
);
13794 /* Build the complete desired matrix of WINDOW with a window start
13795 buffer position POS.
13797 Value is 1 if successful. It is zero if fonts were loaded during
13798 redisplay which makes re-adjusting glyph matrices necessary, and -1
13799 if point would appear in the scroll margins.
13800 (We check that only if CHECK_MARGINS is nonzero. */
13803 try_window (window
, pos
, check_margins
)
13804 Lisp_Object window
;
13805 struct text_pos pos
;
13808 struct window
*w
= XWINDOW (window
);
13810 struct glyph_row
*last_text_row
= NULL
;
13811 struct frame
*f
= XFRAME (w
->frame
);
13813 /* Make POS the new window start. */
13814 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13816 /* Mark cursor position as unknown. No overlay arrow seen. */
13817 w
->cursor
.vpos
= -1;
13818 overlay_arrow_seen
= 0;
13820 /* Initialize iterator and info to start at POS. */
13821 start_display (&it
, w
, pos
);
13823 /* Display all lines of W. */
13824 while (it
.current_y
< it
.last_visible_y
)
13826 if (display_line (&it
))
13827 last_text_row
= it
.glyph_row
- 1;
13828 if (fonts_changed_p
)
13832 /* Don't let the cursor end in the scroll margins. */
13834 && !MINI_WINDOW_P (w
))
13836 int this_scroll_margin
;
13838 this_scroll_margin
= max (0, scroll_margin
);
13839 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13840 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
13842 if ((w
->cursor
.y
>= 0 /* not vscrolled */
13843 && w
->cursor
.y
< this_scroll_margin
13844 && CHARPOS (pos
) > BEGV
13845 && IT_CHARPOS (it
) < ZV
)
13846 /* rms: considering make_cursor_line_fully_visible_p here
13847 seems to give wrong results. We don't want to recenter
13848 when the last line is partly visible, we want to allow
13849 that case to be handled in the usual way. */
13850 || (w
->cursor
.y
+ 1) > it
.last_visible_y
)
13852 w
->cursor
.vpos
= -1;
13853 clear_glyph_matrix (w
->desired_matrix
);
13858 /* If bottom moved off end of frame, change mode line percentage. */
13859 if (XFASTINT (w
->window_end_pos
) <= 0
13860 && Z
!= IT_CHARPOS (it
))
13861 w
->update_mode_line
= Qt
;
13863 /* Set window_end_pos to the offset of the last character displayed
13864 on the window from the end of current_buffer. Set
13865 window_end_vpos to its row number. */
13868 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
13869 w
->window_end_bytepos
13870 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
13872 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
13874 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
13875 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
13876 ->displays_text_p
);
13880 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
13881 w
->window_end_pos
= make_number (Z
- ZV
);
13882 w
->window_end_vpos
= make_number (0);
13885 /* But that is not valid info until redisplay finishes. */
13886 w
->window_end_valid
= Qnil
;
13892 /************************************************************************
13893 Window redisplay reusing current matrix when buffer has not changed
13894 ************************************************************************/
13896 /* Try redisplay of window W showing an unchanged buffer with a
13897 different window start than the last time it was displayed by
13898 reusing its current matrix. Value is non-zero if successful.
13899 W->start is the new window start. */
13902 try_window_reusing_current_matrix (w
)
13905 struct frame
*f
= XFRAME (w
->frame
);
13906 struct glyph_row
*row
, *bottom_row
;
13909 struct text_pos start
, new_start
;
13910 int nrows_scrolled
, i
;
13911 struct glyph_row
*last_text_row
;
13912 struct glyph_row
*last_reused_text_row
;
13913 struct glyph_row
*start_row
;
13914 int start_vpos
, min_y
, max_y
;
13917 if (inhibit_try_window_reusing
)
13921 if (/* This function doesn't handle terminal frames. */
13922 !FRAME_WINDOW_P (f
)
13923 /* Don't try to reuse the display if windows have been split
13925 || windows_or_buffers_changed
13926 || cursor_type_changed
)
13929 /* Can't do this if region may have changed. */
13930 if ((!NILP (Vtransient_mark_mode
)
13931 && !NILP (current_buffer
->mark_active
))
13932 || !NILP (w
->region_showing
)
13933 || !NILP (Vshow_trailing_whitespace
))
13936 /* If top-line visibility has changed, give up. */
13937 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13938 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
13941 /* Give up if old or new display is scrolled vertically. We could
13942 make this function handle this, but right now it doesn't. */
13943 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
13944 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
13947 /* The variable new_start now holds the new window start. The old
13948 start `start' can be determined from the current matrix. */
13949 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
13950 start
= start_row
->start
.pos
;
13951 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
13953 /* Clear the desired matrix for the display below. */
13954 clear_glyph_matrix (w
->desired_matrix
);
13956 if (CHARPOS (new_start
) <= CHARPOS (start
))
13960 /* Don't use this method if the display starts with an ellipsis
13961 displayed for invisible text. It's not easy to handle that case
13962 below, and it's certainly not worth the effort since this is
13963 not a frequent case. */
13964 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
13967 IF_DEBUG (debug_method_add (w
, "twu1"));
13969 /* Display up to a row that can be reused. The variable
13970 last_text_row is set to the last row displayed that displays
13971 text. Note that it.vpos == 0 if or if not there is a
13972 header-line; it's not the same as the MATRIX_ROW_VPOS! */
13973 start_display (&it
, w
, new_start
);
13974 first_row_y
= it
.current_y
;
13975 w
->cursor
.vpos
= -1;
13976 last_text_row
= last_reused_text_row
= NULL
;
13978 while (it
.current_y
< it
.last_visible_y
13979 && !fonts_changed_p
)
13981 /* If we have reached into the characters in the START row,
13982 that means the line boundaries have changed. So we
13983 can't start copying with the row START. Maybe it will
13984 work to start copying with the following row. */
13985 while (IT_CHARPOS (it
) > CHARPOS (start
))
13987 /* Advance to the next row as the "start". */
13989 start
= start_row
->start
.pos
;
13990 /* If there are no more rows to try, or just one, give up. */
13991 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
13992 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
13993 || CHARPOS (start
) == ZV
)
13995 clear_glyph_matrix (w
->desired_matrix
);
13999 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14001 /* If we have reached alignment,
14002 we can copy the rest of the rows. */
14003 if (IT_CHARPOS (it
) == CHARPOS (start
))
14006 if (display_line (&it
))
14007 last_text_row
= it
.glyph_row
- 1;
14010 /* A value of current_y < last_visible_y means that we stopped
14011 at the previous window start, which in turn means that we
14012 have at least one reusable row. */
14013 if (it
.current_y
< it
.last_visible_y
)
14015 /* IT.vpos always starts from 0; it counts text lines. */
14016 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14018 /* Find PT if not already found in the lines displayed. */
14019 if (w
->cursor
.vpos
< 0)
14021 int dy
= it
.current_y
- start_row
->y
;
14023 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14024 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14026 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14027 dy
, nrows_scrolled
);
14030 clear_glyph_matrix (w
->desired_matrix
);
14035 /* Scroll the display. Do it before the current matrix is
14036 changed. The problem here is that update has not yet
14037 run, i.e. part of the current matrix is not up to date.
14038 scroll_run_hook will clear the cursor, and use the
14039 current matrix to get the height of the row the cursor is
14041 run
.current_y
= start_row
->y
;
14042 run
.desired_y
= it
.current_y
;
14043 run
.height
= it
.last_visible_y
- it
.current_y
;
14045 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14048 FRAME_RIF (f
)->update_window_begin_hook (w
);
14049 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14050 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14051 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14055 /* Shift current matrix down by nrows_scrolled lines. */
14056 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14057 rotate_matrix (w
->current_matrix
,
14059 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14062 /* Disable lines that must be updated. */
14063 for (i
= 0; i
< nrows_scrolled
; ++i
)
14064 (start_row
+ i
)->enabled_p
= 0;
14066 /* Re-compute Y positions. */
14067 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14068 max_y
= it
.last_visible_y
;
14069 for (row
= start_row
+ nrows_scrolled
;
14073 row
->y
= it
.current_y
;
14074 row
->visible_height
= row
->height
;
14076 if (row
->y
< min_y
)
14077 row
->visible_height
-= min_y
- row
->y
;
14078 if (row
->y
+ row
->height
> max_y
)
14079 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14080 row
->redraw_fringe_bitmaps_p
= 1;
14082 it
.current_y
+= row
->height
;
14084 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14085 last_reused_text_row
= row
;
14086 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14090 /* Disable lines in the current matrix which are now
14091 below the window. */
14092 for (++row
; row
< bottom_row
; ++row
)
14093 row
->enabled_p
= row
->mode_line_p
= 0;
14096 /* Update window_end_pos etc.; last_reused_text_row is the last
14097 reused row from the current matrix containing text, if any.
14098 The value of last_text_row is the last displayed line
14099 containing text. */
14100 if (last_reused_text_row
)
14102 w
->window_end_bytepos
14103 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14105 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14107 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14108 w
->current_matrix
));
14110 else if (last_text_row
)
14112 w
->window_end_bytepos
14113 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14115 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14117 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14121 /* This window must be completely empty. */
14122 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14123 w
->window_end_pos
= make_number (Z
- ZV
);
14124 w
->window_end_vpos
= make_number (0);
14126 w
->window_end_valid
= Qnil
;
14128 /* Update hint: don't try scrolling again in update_window. */
14129 w
->desired_matrix
->no_scrolling_p
= 1;
14132 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14136 else if (CHARPOS (new_start
) > CHARPOS (start
))
14138 struct glyph_row
*pt_row
, *row
;
14139 struct glyph_row
*first_reusable_row
;
14140 struct glyph_row
*first_row_to_display
;
14142 int yb
= window_text_bottom_y (w
);
14144 /* Find the row starting at new_start, if there is one. Don't
14145 reuse a partially visible line at the end. */
14146 first_reusable_row
= start_row
;
14147 while (first_reusable_row
->enabled_p
14148 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14149 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14150 < CHARPOS (new_start
)))
14151 ++first_reusable_row
;
14153 /* Give up if there is no row to reuse. */
14154 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14155 || !first_reusable_row
->enabled_p
14156 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14157 != CHARPOS (new_start
)))
14160 /* We can reuse fully visible rows beginning with
14161 first_reusable_row to the end of the window. Set
14162 first_row_to_display to the first row that cannot be reused.
14163 Set pt_row to the row containing point, if there is any. */
14165 for (first_row_to_display
= first_reusable_row
;
14166 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14167 ++first_row_to_display
)
14169 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14170 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14171 pt_row
= first_row_to_display
;
14174 /* Start displaying at the start of first_row_to_display. */
14175 xassert (first_row_to_display
->y
< yb
);
14176 init_to_row_start (&it
, w
, first_row_to_display
);
14178 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14180 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14182 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14183 + WINDOW_HEADER_LINE_HEIGHT (w
));
14185 /* Display lines beginning with first_row_to_display in the
14186 desired matrix. Set last_text_row to the last row displayed
14187 that displays text. */
14188 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14189 if (pt_row
== NULL
)
14190 w
->cursor
.vpos
= -1;
14191 last_text_row
= NULL
;
14192 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14193 if (display_line (&it
))
14194 last_text_row
= it
.glyph_row
- 1;
14196 /* Give up If point isn't in a row displayed or reused. */
14197 if (w
->cursor
.vpos
< 0)
14199 clear_glyph_matrix (w
->desired_matrix
);
14203 /* If point is in a reused row, adjust y and vpos of the cursor
14207 w
->cursor
.vpos
-= nrows_scrolled
;
14208 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14211 /* Scroll the display. */
14212 run
.current_y
= first_reusable_row
->y
;
14213 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14214 run
.height
= it
.last_visible_y
- run
.current_y
;
14215 dy
= run
.current_y
- run
.desired_y
;
14220 FRAME_RIF (f
)->update_window_begin_hook (w
);
14221 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14222 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14223 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14227 /* Adjust Y positions of reused rows. */
14228 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14229 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14230 max_y
= it
.last_visible_y
;
14231 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14234 row
->visible_height
= row
->height
;
14235 if (row
->y
< min_y
)
14236 row
->visible_height
-= min_y
- row
->y
;
14237 if (row
->y
+ row
->height
> max_y
)
14238 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14239 row
->redraw_fringe_bitmaps_p
= 1;
14242 /* Scroll the current matrix. */
14243 xassert (nrows_scrolled
> 0);
14244 rotate_matrix (w
->current_matrix
,
14246 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14249 /* Disable rows not reused. */
14250 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14251 row
->enabled_p
= 0;
14253 /* Point may have moved to a different line, so we cannot assume that
14254 the previous cursor position is valid; locate the correct row. */
14257 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14258 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14262 w
->cursor
.y
= row
->y
;
14264 if (row
< bottom_row
)
14266 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14267 while (glyph
->charpos
< PT
)
14270 w
->cursor
.x
+= glyph
->pixel_width
;
14276 /* Adjust window end. A null value of last_text_row means that
14277 the window end is in reused rows which in turn means that
14278 only its vpos can have changed. */
14281 w
->window_end_bytepos
14282 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14284 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14286 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14291 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14294 w
->window_end_valid
= Qnil
;
14295 w
->desired_matrix
->no_scrolling_p
= 1;
14298 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14308 /************************************************************************
14309 Window redisplay reusing current matrix when buffer has changed
14310 ************************************************************************/
14312 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14313 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14315 static struct glyph_row
*
14316 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14317 struct glyph_row
*));
14320 /* Return the last row in MATRIX displaying text. If row START is
14321 non-null, start searching with that row. IT gives the dimensions
14322 of the display. Value is null if matrix is empty; otherwise it is
14323 a pointer to the row found. */
14325 static struct glyph_row
*
14326 find_last_row_displaying_text (matrix
, it
, start
)
14327 struct glyph_matrix
*matrix
;
14329 struct glyph_row
*start
;
14331 struct glyph_row
*row
, *row_found
;
14333 /* Set row_found to the last row in IT->w's current matrix
14334 displaying text. The loop looks funny but think of partially
14337 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14338 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14340 xassert (row
->enabled_p
);
14342 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14351 /* Return the last row in the current matrix of W that is not affected
14352 by changes at the start of current_buffer that occurred since W's
14353 current matrix was built. Value is null if no such row exists.
14355 BEG_UNCHANGED us the number of characters unchanged at the start of
14356 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14357 first changed character in current_buffer. Characters at positions <
14358 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14359 when the current matrix was built. */
14361 static struct glyph_row
*
14362 find_last_unchanged_at_beg_row (w
)
14365 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14366 struct glyph_row
*row
;
14367 struct glyph_row
*row_found
= NULL
;
14368 int yb
= window_text_bottom_y (w
);
14370 /* Find the last row displaying unchanged text. */
14371 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14372 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14373 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
)
14375 if (/* If row ends before first_changed_pos, it is unchanged,
14376 except in some case. */
14377 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14378 /* When row ends in ZV and we write at ZV it is not
14380 && !row
->ends_at_zv_p
14381 /* When first_changed_pos is the end of a continued line,
14382 row is not unchanged because it may be no longer
14384 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14385 && (row
->continued_p
14386 || row
->exact_window_width_line_p
)))
14389 /* Stop if last visible row. */
14390 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14400 /* Find the first glyph row in the current matrix of W that is not
14401 affected by changes at the end of current_buffer since the
14402 time W's current matrix was built.
14404 Return in *DELTA the number of chars by which buffer positions in
14405 unchanged text at the end of current_buffer must be adjusted.
14407 Return in *DELTA_BYTES the corresponding number of bytes.
14409 Value is null if no such row exists, i.e. all rows are affected by
14412 static struct glyph_row
*
14413 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14415 int *delta
, *delta_bytes
;
14417 struct glyph_row
*row
;
14418 struct glyph_row
*row_found
= NULL
;
14420 *delta
= *delta_bytes
= 0;
14422 /* Display must not have been paused, otherwise the current matrix
14423 is not up to date. */
14424 eassert (!NILP (w
->window_end_valid
));
14426 /* A value of window_end_pos >= END_UNCHANGED means that the window
14427 end is in the range of changed text. If so, there is no
14428 unchanged row at the end of W's current matrix. */
14429 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14432 /* Set row to the last row in W's current matrix displaying text. */
14433 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14435 /* If matrix is entirely empty, no unchanged row exists. */
14436 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14438 /* The value of row is the last glyph row in the matrix having a
14439 meaningful buffer position in it. The end position of row
14440 corresponds to window_end_pos. This allows us to translate
14441 buffer positions in the current matrix to current buffer
14442 positions for characters not in changed text. */
14443 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14444 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14445 int last_unchanged_pos
, last_unchanged_pos_old
;
14446 struct glyph_row
*first_text_row
14447 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14449 *delta
= Z
- Z_old
;
14450 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14452 /* Set last_unchanged_pos to the buffer position of the last
14453 character in the buffer that has not been changed. Z is the
14454 index + 1 of the last character in current_buffer, i.e. by
14455 subtracting END_UNCHANGED we get the index of the last
14456 unchanged character, and we have to add BEG to get its buffer
14458 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14459 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14461 /* Search backward from ROW for a row displaying a line that
14462 starts at a minimum position >= last_unchanged_pos_old. */
14463 for (; row
> first_text_row
; --row
)
14465 /* This used to abort, but it can happen.
14466 It is ok to just stop the search instead here. KFS. */
14467 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14470 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14475 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14481 /* Make sure that glyph rows in the current matrix of window W
14482 reference the same glyph memory as corresponding rows in the
14483 frame's frame matrix. This function is called after scrolling W's
14484 current matrix on a terminal frame in try_window_id and
14485 try_window_reusing_current_matrix. */
14488 sync_frame_with_window_matrix_rows (w
)
14491 struct frame
*f
= XFRAME (w
->frame
);
14492 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14494 /* Preconditions: W must be a leaf window and full-width. Its frame
14495 must have a frame matrix. */
14496 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14497 xassert (WINDOW_FULL_WIDTH_P (w
));
14498 xassert (!FRAME_WINDOW_P (f
));
14500 /* If W is a full-width window, glyph pointers in W's current matrix
14501 have, by definition, to be the same as glyph pointers in the
14502 corresponding frame matrix. Note that frame matrices have no
14503 marginal areas (see build_frame_matrix). */
14504 window_row
= w
->current_matrix
->rows
;
14505 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14506 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14507 while (window_row
< window_row_end
)
14509 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14510 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14512 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14513 frame_row
->glyphs
[TEXT_AREA
] = start
;
14514 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14515 frame_row
->glyphs
[LAST_AREA
] = end
;
14517 /* Disable frame rows whose corresponding window rows have
14518 been disabled in try_window_id. */
14519 if (!window_row
->enabled_p
)
14520 frame_row
->enabled_p
= 0;
14522 ++window_row
, ++frame_row
;
14527 /* Find the glyph row in window W containing CHARPOS. Consider all
14528 rows between START and END (not inclusive). END null means search
14529 all rows to the end of the display area of W. Value is the row
14530 containing CHARPOS or null. */
14533 row_containing_pos (w
, charpos
, start
, end
, dy
)
14536 struct glyph_row
*start
, *end
;
14539 struct glyph_row
*row
= start
;
14542 /* If we happen to start on a header-line, skip that. */
14543 if (row
->mode_line_p
)
14546 if ((end
&& row
>= end
) || !row
->enabled_p
)
14549 last_y
= window_text_bottom_y (w
) - dy
;
14553 /* Give up if we have gone too far. */
14554 if (end
&& row
>= end
)
14556 /* This formerly returned if they were equal.
14557 I think that both quantities are of a "last plus one" type;
14558 if so, when they are equal, the row is within the screen. -- rms. */
14559 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14562 /* If it is in this row, return this row. */
14563 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14564 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14565 /* The end position of a row equals the start
14566 position of the next row. If CHARPOS is there, we
14567 would rather display it in the next line, except
14568 when this line ends in ZV. */
14569 && !row
->ends_at_zv_p
14570 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14571 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14578 /* Try to redisplay window W by reusing its existing display. W's
14579 current matrix must be up to date when this function is called,
14580 i.e. window_end_valid must not be nil.
14584 1 if display has been updated
14585 0 if otherwise unsuccessful
14586 -1 if redisplay with same window start is known not to succeed
14588 The following steps are performed:
14590 1. Find the last row in the current matrix of W that is not
14591 affected by changes at the start of current_buffer. If no such row
14594 2. Find the first row in W's current matrix that is not affected by
14595 changes at the end of current_buffer. Maybe there is no such row.
14597 3. Display lines beginning with the row + 1 found in step 1 to the
14598 row found in step 2 or, if step 2 didn't find a row, to the end of
14601 4. If cursor is not known to appear on the window, give up.
14603 5. If display stopped at the row found in step 2, scroll the
14604 display and current matrix as needed.
14606 6. Maybe display some lines at the end of W, if we must. This can
14607 happen under various circumstances, like a partially visible line
14608 becoming fully visible, or because newly displayed lines are displayed
14609 in smaller font sizes.
14611 7. Update W's window end information. */
14617 struct frame
*f
= XFRAME (w
->frame
);
14618 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14619 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14620 struct glyph_row
*last_unchanged_at_beg_row
;
14621 struct glyph_row
*first_unchanged_at_end_row
;
14622 struct glyph_row
*row
;
14623 struct glyph_row
*bottom_row
;
14626 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14627 struct text_pos start_pos
;
14629 int first_unchanged_at_end_vpos
= 0;
14630 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14631 struct text_pos start
;
14632 int first_changed_charpos
, last_changed_charpos
;
14635 if (inhibit_try_window_id
)
14639 /* This is handy for debugging. */
14641 #define GIVE_UP(X) \
14643 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14647 #define GIVE_UP(X) return 0
14650 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14652 /* Don't use this for mini-windows because these can show
14653 messages and mini-buffers, and we don't handle that here. */
14654 if (MINI_WINDOW_P (w
))
14657 /* This flag is used to prevent redisplay optimizations. */
14658 if (windows_or_buffers_changed
|| cursor_type_changed
)
14661 /* Verify that narrowing has not changed.
14662 Also verify that we were not told to prevent redisplay optimizations.
14663 It would be nice to further
14664 reduce the number of cases where this prevents try_window_id. */
14665 if (current_buffer
->clip_changed
14666 || current_buffer
->prevent_redisplay_optimizations_p
)
14669 /* Window must either use window-based redisplay or be full width. */
14670 if (!FRAME_WINDOW_P (f
)
14671 && (!FRAME_LINE_INS_DEL_OK (f
)
14672 || !WINDOW_FULL_WIDTH_P (w
)))
14675 /* Give up if point is not known NOT to appear in W. */
14676 if (PT
< CHARPOS (start
))
14679 /* Another way to prevent redisplay optimizations. */
14680 if (XFASTINT (w
->last_modified
) == 0)
14683 /* Verify that window is not hscrolled. */
14684 if (XFASTINT (w
->hscroll
) != 0)
14687 /* Verify that display wasn't paused. */
14688 if (NILP (w
->window_end_valid
))
14691 /* Can't use this if highlighting a region because a cursor movement
14692 will do more than just set the cursor. */
14693 if (!NILP (Vtransient_mark_mode
)
14694 && !NILP (current_buffer
->mark_active
))
14697 /* Likewise if highlighting trailing whitespace. */
14698 if (!NILP (Vshow_trailing_whitespace
))
14701 /* Likewise if showing a region. */
14702 if (!NILP (w
->region_showing
))
14705 /* Can use this if overlay arrow position and or string have changed. */
14706 if (overlay_arrows_changed_p ())
14710 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14711 only if buffer has really changed. The reason is that the gap is
14712 initially at Z for freshly visited files. The code below would
14713 set end_unchanged to 0 in that case. */
14714 if (MODIFF
> SAVE_MODIFF
14715 /* This seems to happen sometimes after saving a buffer. */
14716 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14718 if (GPT
- BEG
< BEG_UNCHANGED
)
14719 BEG_UNCHANGED
= GPT
- BEG
;
14720 if (Z
- GPT
< END_UNCHANGED
)
14721 END_UNCHANGED
= Z
- GPT
;
14724 /* The position of the first and last character that has been changed. */
14725 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14726 last_changed_charpos
= Z
- END_UNCHANGED
;
14728 /* If window starts after a line end, and the last change is in
14729 front of that newline, then changes don't affect the display.
14730 This case happens with stealth-fontification. Note that although
14731 the display is unchanged, glyph positions in the matrix have to
14732 be adjusted, of course. */
14733 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14734 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14735 && ((last_changed_charpos
< CHARPOS (start
)
14736 && CHARPOS (start
) == BEGV
)
14737 || (last_changed_charpos
< CHARPOS (start
) - 1
14738 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14740 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14741 struct glyph_row
*r0
;
14743 /* Compute how many chars/bytes have been added to or removed
14744 from the buffer. */
14745 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14746 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14748 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14750 /* Give up if PT is not in the window. Note that it already has
14751 been checked at the start of try_window_id that PT is not in
14752 front of the window start. */
14753 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14756 /* If window start is unchanged, we can reuse the whole matrix
14757 as is, after adjusting glyph positions. No need to compute
14758 the window end again, since its offset from Z hasn't changed. */
14759 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14760 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14761 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14762 /* PT must not be in a partially visible line. */
14763 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14764 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14766 /* Adjust positions in the glyph matrix. */
14767 if (delta
|| delta_bytes
)
14769 struct glyph_row
*r1
14770 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14771 increment_matrix_positions (w
->current_matrix
,
14772 MATRIX_ROW_VPOS (r0
, current_matrix
),
14773 MATRIX_ROW_VPOS (r1
, current_matrix
),
14774 delta
, delta_bytes
);
14777 /* Set the cursor. */
14778 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14780 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14787 /* Handle the case that changes are all below what is displayed in
14788 the window, and that PT is in the window. This shortcut cannot
14789 be taken if ZV is visible in the window, and text has been added
14790 there that is visible in the window. */
14791 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14792 /* ZV is not visible in the window, or there are no
14793 changes at ZV, actually. */
14794 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14795 || first_changed_charpos
== last_changed_charpos
))
14797 struct glyph_row
*r0
;
14799 /* Give up if PT is not in the window. Note that it already has
14800 been checked at the start of try_window_id that PT is not in
14801 front of the window start. */
14802 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14805 /* If window start is unchanged, we can reuse the whole matrix
14806 as is, without changing glyph positions since no text has
14807 been added/removed in front of the window end. */
14808 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14809 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14810 /* PT must not be in a partially visible line. */
14811 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14812 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14814 /* We have to compute the window end anew since text
14815 can have been added/removed after it. */
14817 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
14818 w
->window_end_bytepos
14819 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
14821 /* Set the cursor. */
14822 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14824 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14831 /* Give up if window start is in the changed area.
14833 The condition used to read
14835 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
14837 but why that was tested escapes me at the moment. */
14838 if (CHARPOS (start
) >= first_changed_charpos
14839 && CHARPOS (start
) <= last_changed_charpos
)
14842 /* Check that window start agrees with the start of the first glyph
14843 row in its current matrix. Check this after we know the window
14844 start is not in changed text, otherwise positions would not be
14846 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14847 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
14850 /* Give up if the window ends in strings. Overlay strings
14851 at the end are difficult to handle, so don't try. */
14852 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
14853 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
14856 /* Compute the position at which we have to start displaying new
14857 lines. Some of the lines at the top of the window might be
14858 reusable because they are not displaying changed text. Find the
14859 last row in W's current matrix not affected by changes at the
14860 start of current_buffer. Value is null if changes start in the
14861 first line of window. */
14862 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
14863 if (last_unchanged_at_beg_row
)
14865 /* Avoid starting to display in the moddle of a character, a TAB
14866 for instance. This is easier than to set up the iterator
14867 exactly, and it's not a frequent case, so the additional
14868 effort wouldn't really pay off. */
14869 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
14870 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
14871 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
14872 --last_unchanged_at_beg_row
;
14874 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
14877 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
14879 start_pos
= it
.current
.pos
;
14881 /* Start displaying new lines in the desired matrix at the same
14882 vpos we would use in the current matrix, i.e. below
14883 last_unchanged_at_beg_row. */
14884 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
14886 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
14887 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
14889 xassert (it
.hpos
== 0 && it
.current_x
== 0);
14893 /* There are no reusable lines at the start of the window.
14894 Start displaying in the first text line. */
14895 start_display (&it
, w
, start
);
14896 it
.vpos
= it
.first_vpos
;
14897 start_pos
= it
.current
.pos
;
14900 /* Find the first row that is not affected by changes at the end of
14901 the buffer. Value will be null if there is no unchanged row, in
14902 which case we must redisplay to the end of the window. delta
14903 will be set to the value by which buffer positions beginning with
14904 first_unchanged_at_end_row have to be adjusted due to text
14906 first_unchanged_at_end_row
14907 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
14908 IF_DEBUG (debug_delta
= delta
);
14909 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
14911 /* Set stop_pos to the buffer position up to which we will have to
14912 display new lines. If first_unchanged_at_end_row != NULL, this
14913 is the buffer position of the start of the line displayed in that
14914 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
14915 that we don't stop at a buffer position. */
14917 if (first_unchanged_at_end_row
)
14919 xassert (last_unchanged_at_beg_row
== NULL
14920 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
14922 /* If this is a continuation line, move forward to the next one
14923 that isn't. Changes in lines above affect this line.
14924 Caution: this may move first_unchanged_at_end_row to a row
14925 not displaying text. */
14926 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
14927 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14928 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14929 < it
.last_visible_y
))
14930 ++first_unchanged_at_end_row
;
14932 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
14933 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
14934 >= it
.last_visible_y
))
14935 first_unchanged_at_end_row
= NULL
;
14938 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
14940 first_unchanged_at_end_vpos
14941 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
14942 xassert (stop_pos
>= Z
- END_UNCHANGED
);
14945 else if (last_unchanged_at_beg_row
== NULL
)
14951 /* Either there is no unchanged row at the end, or the one we have
14952 now displays text. This is a necessary condition for the window
14953 end pos calculation at the end of this function. */
14954 xassert (first_unchanged_at_end_row
== NULL
14955 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
14957 debug_last_unchanged_at_beg_vpos
14958 = (last_unchanged_at_beg_row
14959 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
14961 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
14963 #endif /* GLYPH_DEBUG != 0 */
14966 /* Display new lines. Set last_text_row to the last new line
14967 displayed which has text on it, i.e. might end up as being the
14968 line where the window_end_vpos is. */
14969 w
->cursor
.vpos
= -1;
14970 last_text_row
= NULL
;
14971 overlay_arrow_seen
= 0;
14972 while (it
.current_y
< it
.last_visible_y
14973 && !fonts_changed_p
14974 && (first_unchanged_at_end_row
== NULL
14975 || IT_CHARPOS (it
) < stop_pos
))
14977 if (display_line (&it
))
14978 last_text_row
= it
.glyph_row
- 1;
14981 if (fonts_changed_p
)
14985 /* Compute differences in buffer positions, y-positions etc. for
14986 lines reused at the bottom of the window. Compute what we can
14988 if (first_unchanged_at_end_row
14989 /* No lines reused because we displayed everything up to the
14990 bottom of the window. */
14991 && it
.current_y
< it
.last_visible_y
)
14994 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
14996 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
14997 run
.current_y
= first_unchanged_at_end_row
->y
;
14998 run
.desired_y
= run
.current_y
+ dy
;
14999 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15003 delta
= dvpos
= dy
= run
.current_y
= run
.desired_y
= run
.height
= 0;
15004 first_unchanged_at_end_row
= NULL
;
15006 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15009 /* Find the cursor if not already found. We have to decide whether
15010 PT will appear on this window (it sometimes doesn't, but this is
15011 not a very frequent case.) This decision has to be made before
15012 the current matrix is altered. A value of cursor.vpos < 0 means
15013 that PT is either in one of the lines beginning at
15014 first_unchanged_at_end_row or below the window. Don't care for
15015 lines that might be displayed later at the window end; as
15016 mentioned, this is not a frequent case. */
15017 if (w
->cursor
.vpos
< 0)
15019 /* Cursor in unchanged rows at the top? */
15020 if (PT
< CHARPOS (start_pos
)
15021 && last_unchanged_at_beg_row
)
15023 row
= row_containing_pos (w
, PT
,
15024 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15025 last_unchanged_at_beg_row
+ 1, 0);
15027 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15030 /* Start from first_unchanged_at_end_row looking for PT. */
15031 else if (first_unchanged_at_end_row
)
15033 row
= row_containing_pos (w
, PT
- delta
,
15034 first_unchanged_at_end_row
, NULL
, 0);
15036 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15037 delta_bytes
, dy
, dvpos
);
15040 /* Give up if cursor was not found. */
15041 if (w
->cursor
.vpos
< 0)
15043 clear_glyph_matrix (w
->desired_matrix
);
15048 /* Don't let the cursor end in the scroll margins. */
15050 int this_scroll_margin
, cursor_height
;
15052 this_scroll_margin
= max (0, scroll_margin
);
15053 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15054 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15055 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15057 if ((w
->cursor
.y
< this_scroll_margin
15058 && CHARPOS (start
) > BEGV
)
15059 /* Old redisplay didn't take scroll margin into account at the bottom,
15060 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15061 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15062 ? cursor_height
+ this_scroll_margin
15063 : 1)) > it
.last_visible_y
)
15065 w
->cursor
.vpos
= -1;
15066 clear_glyph_matrix (w
->desired_matrix
);
15071 /* Scroll the display. Do it before changing the current matrix so
15072 that xterm.c doesn't get confused about where the cursor glyph is
15074 if (dy
&& run
.height
)
15078 if (FRAME_WINDOW_P (f
))
15080 FRAME_RIF (f
)->update_window_begin_hook (w
);
15081 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15082 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15083 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15087 /* Terminal frame. In this case, dvpos gives the number of
15088 lines to scroll by; dvpos < 0 means scroll up. */
15089 int first_unchanged_at_end_vpos
15090 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15091 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15092 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15093 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15094 + window_internal_height (w
));
15096 /* Perform the operation on the screen. */
15099 /* Scroll last_unchanged_at_beg_row to the end of the
15100 window down dvpos lines. */
15101 set_terminal_window (f
, end
);
15103 /* On dumb terminals delete dvpos lines at the end
15104 before inserting dvpos empty lines. */
15105 if (!FRAME_SCROLL_REGION_OK (f
))
15106 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15108 /* Insert dvpos empty lines in front of
15109 last_unchanged_at_beg_row. */
15110 ins_del_lines (f
, from
, dvpos
);
15112 else if (dvpos
< 0)
15114 /* Scroll up last_unchanged_at_beg_vpos to the end of
15115 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15116 set_terminal_window (f
, end
);
15118 /* Delete dvpos lines in front of
15119 last_unchanged_at_beg_vpos. ins_del_lines will set
15120 the cursor to the given vpos and emit |dvpos| delete
15122 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15124 /* On a dumb terminal insert dvpos empty lines at the
15126 if (!FRAME_SCROLL_REGION_OK (f
))
15127 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15130 set_terminal_window (f
, 0);
15136 /* Shift reused rows of the current matrix to the right position.
15137 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15139 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15140 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15143 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15144 bottom_vpos
, dvpos
);
15145 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15148 else if (dvpos
> 0)
15150 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15151 bottom_vpos
, dvpos
);
15152 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15153 first_unchanged_at_end_vpos
+ dvpos
, 0);
15156 /* For frame-based redisplay, make sure that current frame and window
15157 matrix are in sync with respect to glyph memory. */
15158 if (!FRAME_WINDOW_P (f
))
15159 sync_frame_with_window_matrix_rows (w
);
15161 /* Adjust buffer positions in reused rows. */
15162 if (delta
|| delta_bytes
)
15163 increment_matrix_positions (current_matrix
,
15164 first_unchanged_at_end_vpos
+ dvpos
,
15165 bottom_vpos
, delta
, delta_bytes
);
15167 /* Adjust Y positions. */
15169 shift_glyph_matrix (w
, current_matrix
,
15170 first_unchanged_at_end_vpos
+ dvpos
,
15173 if (first_unchanged_at_end_row
)
15175 first_unchanged_at_end_row
+= dvpos
;
15176 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15177 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15178 first_unchanged_at_end_row
= NULL
;
15181 /* If scrolling up, there may be some lines to display at the end of
15183 last_text_row_at_end
= NULL
;
15186 /* Scrolling up can leave for example a partially visible line
15187 at the end of the window to be redisplayed. */
15188 /* Set last_row to the glyph row in the current matrix where the
15189 window end line is found. It has been moved up or down in
15190 the matrix by dvpos. */
15191 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15192 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15194 /* If last_row is the window end line, it should display text. */
15195 xassert (last_row
->displays_text_p
);
15197 /* If window end line was partially visible before, begin
15198 displaying at that line. Otherwise begin displaying with the
15199 line following it. */
15200 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15202 init_to_row_start (&it
, w
, last_row
);
15203 it
.vpos
= last_vpos
;
15204 it
.current_y
= last_row
->y
;
15208 init_to_row_end (&it
, w
, last_row
);
15209 it
.vpos
= 1 + last_vpos
;
15210 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15214 /* We may start in a continuation line. If so, we have to
15215 get the right continuation_lines_width and current_x. */
15216 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15217 it
.hpos
= it
.current_x
= 0;
15219 /* Display the rest of the lines at the window end. */
15220 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15221 while (it
.current_y
< it
.last_visible_y
15222 && !fonts_changed_p
)
15224 /* Is it always sure that the display agrees with lines in
15225 the current matrix? I don't think so, so we mark rows
15226 displayed invalid in the current matrix by setting their
15227 enabled_p flag to zero. */
15228 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15229 if (display_line (&it
))
15230 last_text_row_at_end
= it
.glyph_row
- 1;
15234 /* Update window_end_pos and window_end_vpos. */
15235 if (first_unchanged_at_end_row
15236 && !last_text_row_at_end
)
15238 /* Window end line if one of the preserved rows from the current
15239 matrix. Set row to the last row displaying text in current
15240 matrix starting at first_unchanged_at_end_row, after
15242 xassert (first_unchanged_at_end_row
->displays_text_p
);
15243 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15244 first_unchanged_at_end_row
);
15245 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15247 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15248 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15250 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15251 xassert (w
->window_end_bytepos
>= 0);
15252 IF_DEBUG (debug_method_add (w
, "A"));
15254 else if (last_text_row_at_end
)
15257 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15258 w
->window_end_bytepos
15259 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15261 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15262 xassert (w
->window_end_bytepos
>= 0);
15263 IF_DEBUG (debug_method_add (w
, "B"));
15265 else if (last_text_row
)
15267 /* We have displayed either to the end of the window or at the
15268 end of the window, i.e. the last row with text is to be found
15269 in the desired matrix. */
15271 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15272 w
->window_end_bytepos
15273 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15275 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15276 xassert (w
->window_end_bytepos
>= 0);
15278 else if (first_unchanged_at_end_row
== NULL
15279 && last_text_row
== NULL
15280 && last_text_row_at_end
== NULL
)
15282 /* Displayed to end of window, but no line containing text was
15283 displayed. Lines were deleted at the end of the window. */
15284 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15285 int vpos
= XFASTINT (w
->window_end_vpos
);
15286 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15287 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15290 row
== NULL
&& vpos
>= first_vpos
;
15291 --vpos
, --current_row
, --desired_row
)
15293 if (desired_row
->enabled_p
)
15295 if (desired_row
->displays_text_p
)
15298 else if (current_row
->displays_text_p
)
15302 xassert (row
!= NULL
);
15303 w
->window_end_vpos
= make_number (vpos
+ 1);
15304 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15305 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15306 xassert (w
->window_end_bytepos
>= 0);
15307 IF_DEBUG (debug_method_add (w
, "C"));
15312 #if 0 /* This leads to problems, for instance when the cursor is
15313 at ZV, and the cursor line displays no text. */
15314 /* Disable rows below what's displayed in the window. This makes
15315 debugging easier. */
15316 enable_glyph_matrix_rows (current_matrix
,
15317 XFASTINT (w
->window_end_vpos
) + 1,
15321 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15322 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15324 /* Record that display has not been completed. */
15325 w
->window_end_valid
= Qnil
;
15326 w
->desired_matrix
->no_scrolling_p
= 1;
15334 /***********************************************************************
15335 More debugging support
15336 ***********************************************************************/
15340 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15341 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15342 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15345 /* Dump the contents of glyph matrix MATRIX on stderr.
15347 GLYPHS 0 means don't show glyph contents.
15348 GLYPHS 1 means show glyphs in short form
15349 GLYPHS > 1 means show glyphs in long form. */
15352 dump_glyph_matrix (matrix
, glyphs
)
15353 struct glyph_matrix
*matrix
;
15357 for (i
= 0; i
< matrix
->nrows
; ++i
)
15358 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15362 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15363 the glyph row and area where the glyph comes from. */
15366 dump_glyph (row
, glyph
, area
)
15367 struct glyph_row
*row
;
15368 struct glyph
*glyph
;
15371 if (glyph
->type
== CHAR_GLYPH
)
15374 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15375 glyph
- row
->glyphs
[TEXT_AREA
],
15378 (BUFFERP (glyph
->object
)
15380 : (STRINGP (glyph
->object
)
15383 glyph
->pixel_width
,
15385 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15389 glyph
->left_box_line_p
,
15390 glyph
->right_box_line_p
);
15392 else if (glyph
->type
== STRETCH_GLYPH
)
15395 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15396 glyph
- row
->glyphs
[TEXT_AREA
],
15399 (BUFFERP (glyph
->object
)
15401 : (STRINGP (glyph
->object
)
15404 glyph
->pixel_width
,
15408 glyph
->left_box_line_p
,
15409 glyph
->right_box_line_p
);
15411 else if (glyph
->type
== IMAGE_GLYPH
)
15414 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15415 glyph
- row
->glyphs
[TEXT_AREA
],
15418 (BUFFERP (glyph
->object
)
15420 : (STRINGP (glyph
->object
)
15423 glyph
->pixel_width
,
15427 glyph
->left_box_line_p
,
15428 glyph
->right_box_line_p
);
15430 else if (glyph
->type
== COMPOSITE_GLYPH
)
15433 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15434 glyph
- row
->glyphs
[TEXT_AREA
],
15437 (BUFFERP (glyph
->object
)
15439 : (STRINGP (glyph
->object
)
15442 glyph
->pixel_width
,
15446 glyph
->left_box_line_p
,
15447 glyph
->right_box_line_p
);
15452 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15453 GLYPHS 0 means don't show glyph contents.
15454 GLYPHS 1 means show glyphs in short form
15455 GLYPHS > 1 means show glyphs in long form. */
15458 dump_glyph_row (row
, vpos
, glyphs
)
15459 struct glyph_row
*row
;
15464 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15465 fprintf (stderr
, "======================================================================\n");
15467 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15468 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15470 MATRIX_ROW_START_CHARPOS (row
),
15471 MATRIX_ROW_END_CHARPOS (row
),
15472 row
->used
[TEXT_AREA
],
15473 row
->contains_overlapping_glyphs_p
,
15475 row
->truncated_on_left_p
,
15476 row
->truncated_on_right_p
,
15478 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15479 row
->displays_text_p
,
15482 row
->ends_in_middle_of_char_p
,
15483 row
->starts_in_middle_of_char_p
,
15489 row
->visible_height
,
15492 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15493 row
->end
.overlay_string_index
,
15494 row
->continuation_lines_width
);
15495 fprintf (stderr
, "%9d %5d\n",
15496 CHARPOS (row
->start
.string_pos
),
15497 CHARPOS (row
->end
.string_pos
));
15498 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15499 row
->end
.dpvec_index
);
15506 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15508 struct glyph
*glyph
= row
->glyphs
[area
];
15509 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15511 /* Glyph for a line end in text. */
15512 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15515 if (glyph
< glyph_end
)
15516 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15518 for (; glyph
< glyph_end
; ++glyph
)
15519 dump_glyph (row
, glyph
, area
);
15522 else if (glyphs
== 1)
15526 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15528 char *s
= (char *) alloca (row
->used
[area
] + 1);
15531 for (i
= 0; i
< row
->used
[area
]; ++i
)
15533 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15534 if (glyph
->type
== CHAR_GLYPH
15535 && glyph
->u
.ch
< 0x80
15536 && glyph
->u
.ch
>= ' ')
15537 s
[i
] = glyph
->u
.ch
;
15543 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15549 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15550 Sdump_glyph_matrix
, 0, 1, "p",
15551 doc
: /* Dump the current matrix of the selected window to stderr.
15552 Shows contents of glyph row structures. With non-nil
15553 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15554 glyphs in short form, otherwise show glyphs in long form. */)
15556 Lisp_Object glyphs
;
15558 struct window
*w
= XWINDOW (selected_window
);
15559 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15561 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15562 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15563 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15564 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15565 fprintf (stderr
, "=============================================\n");
15566 dump_glyph_matrix (w
->current_matrix
,
15567 NILP (glyphs
) ? 0 : XINT (glyphs
));
15572 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15573 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15576 struct frame
*f
= XFRAME (selected_frame
);
15577 dump_glyph_matrix (f
->current_matrix
, 1);
15582 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15583 doc
: /* Dump glyph row ROW to stderr.
15584 GLYPH 0 means don't dump glyphs.
15585 GLYPH 1 means dump glyphs in short form.
15586 GLYPH > 1 or omitted means dump glyphs in long form. */)
15588 Lisp_Object row
, glyphs
;
15590 struct glyph_matrix
*matrix
;
15593 CHECK_NUMBER (row
);
15594 matrix
= XWINDOW (selected_window
)->current_matrix
;
15596 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15597 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15599 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15604 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15605 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15606 GLYPH 0 means don't dump glyphs.
15607 GLYPH 1 means dump glyphs in short form.
15608 GLYPH > 1 or omitted means dump glyphs in long form. */)
15610 Lisp_Object row
, glyphs
;
15612 struct frame
*sf
= SELECTED_FRAME ();
15613 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15616 CHECK_NUMBER (row
);
15618 if (vpos
>= 0 && vpos
< m
->nrows
)
15619 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15620 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15625 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15626 doc
: /* Toggle tracing of redisplay.
15627 With ARG, turn tracing on if and only if ARG is positive. */)
15632 trace_redisplay_p
= !trace_redisplay_p
;
15635 arg
= Fprefix_numeric_value (arg
);
15636 trace_redisplay_p
= XINT (arg
) > 0;
15643 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15644 doc
: /* Like `format', but print result to stderr.
15645 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15650 Lisp_Object s
= Fformat (nargs
, args
);
15651 fprintf (stderr
, "%s", SDATA (s
));
15655 #endif /* GLYPH_DEBUG */
15659 /***********************************************************************
15660 Building Desired Matrix Rows
15661 ***********************************************************************/
15663 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15664 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15666 static struct glyph_row
*
15667 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15669 Lisp_Object overlay_arrow_string
;
15671 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15672 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15673 struct buffer
*old
= current_buffer
;
15674 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15675 int arrow_len
= SCHARS (overlay_arrow_string
);
15676 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15677 const unsigned char *p
;
15680 int n_glyphs_before
;
15682 set_buffer_temp (buffer
);
15683 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15684 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15685 SET_TEXT_POS (it
.position
, 0, 0);
15687 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15689 while (p
< arrow_end
)
15691 Lisp_Object face
, ilisp
;
15693 /* Get the next character. */
15695 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15697 it
.c
= *p
, it
.len
= 1;
15700 /* Get its face. */
15701 ilisp
= make_number (p
- arrow_string
);
15702 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15703 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15705 /* Compute its width, get its glyphs. */
15706 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15707 SET_TEXT_POS (it
.position
, -1, -1);
15708 PRODUCE_GLYPHS (&it
);
15710 /* If this character doesn't fit any more in the line, we have
15711 to remove some glyphs. */
15712 if (it
.current_x
> it
.last_visible_x
)
15714 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15719 set_buffer_temp (old
);
15720 return it
.glyph_row
;
15724 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15725 glyphs are only inserted for terminal frames since we can't really
15726 win with truncation glyphs when partially visible glyphs are
15727 involved. Which glyphs to insert is determined by
15728 produce_special_glyphs. */
15731 insert_left_trunc_glyphs (it
)
15734 struct it truncate_it
;
15735 struct glyph
*from
, *end
, *to
, *toend
;
15737 xassert (!FRAME_WINDOW_P (it
->f
));
15739 /* Get the truncation glyphs. */
15741 truncate_it
.current_x
= 0;
15742 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15743 truncate_it
.glyph_row
= &scratch_glyph_row
;
15744 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15745 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15746 truncate_it
.object
= make_number (0);
15747 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15749 /* Overwrite glyphs from IT with truncation glyphs. */
15750 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15751 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15752 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15753 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15758 /* There may be padding glyphs left over. Overwrite them too. */
15759 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15761 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15767 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15771 /* Compute the pixel height and width of IT->glyph_row.
15773 Most of the time, ascent and height of a display line will be equal
15774 to the max_ascent and max_height values of the display iterator
15775 structure. This is not the case if
15777 1. We hit ZV without displaying anything. In this case, max_ascent
15778 and max_height will be zero.
15780 2. We have some glyphs that don't contribute to the line height.
15781 (The glyph row flag contributes_to_line_height_p is for future
15782 pixmap extensions).
15784 The first case is easily covered by using default values because in
15785 these cases, the line height does not really matter, except that it
15786 must not be zero. */
15789 compute_line_metrics (it
)
15792 struct glyph_row
*row
= it
->glyph_row
;
15795 if (FRAME_WINDOW_P (it
->f
))
15797 int i
, min_y
, max_y
;
15799 /* The line may consist of one space only, that was added to
15800 place the cursor on it. If so, the row's height hasn't been
15802 if (row
->height
== 0)
15804 if (it
->max_ascent
+ it
->max_descent
== 0)
15805 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15806 row
->ascent
= it
->max_ascent
;
15807 row
->height
= it
->max_ascent
+ it
->max_descent
;
15808 row
->phys_ascent
= it
->max_phys_ascent
;
15809 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
15810 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
15813 /* Compute the width of this line. */
15814 row
->pixel_width
= row
->x
;
15815 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
15816 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
15818 xassert (row
->pixel_width
>= 0);
15819 xassert (row
->ascent
>= 0 && row
->height
> 0);
15821 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
15822 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
15824 /* If first line's physical ascent is larger than its logical
15825 ascent, use the physical ascent, and make the row taller.
15826 This makes accented characters fully visible. */
15827 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
15828 && row
->phys_ascent
> row
->ascent
)
15830 row
->height
+= row
->phys_ascent
- row
->ascent
;
15831 row
->ascent
= row
->phys_ascent
;
15834 /* Compute how much of the line is visible. */
15835 row
->visible_height
= row
->height
;
15837 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
15838 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
15840 if (row
->y
< min_y
)
15841 row
->visible_height
-= min_y
- row
->y
;
15842 if (row
->y
+ row
->height
> max_y
)
15843 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15847 row
->pixel_width
= row
->used
[TEXT_AREA
];
15848 if (row
->continued_p
)
15849 row
->pixel_width
-= it
->continuation_pixel_width
;
15850 else if (row
->truncated_on_right_p
)
15851 row
->pixel_width
-= it
->truncation_pixel_width
;
15852 row
->ascent
= row
->phys_ascent
= 0;
15853 row
->height
= row
->phys_height
= row
->visible_height
= 1;
15854 row
->extra_line_spacing
= 0;
15857 /* Compute a hash code for this row. */
15859 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15860 for (i
= 0; i
< row
->used
[area
]; ++i
)
15861 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
15862 + row
->glyphs
[area
][i
].u
.val
15863 + row
->glyphs
[area
][i
].face_id
15864 + row
->glyphs
[area
][i
].padding_p
15865 + (row
->glyphs
[area
][i
].type
<< 2));
15867 it
->max_ascent
= it
->max_descent
= 0;
15868 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
15872 /* Append one space to the glyph row of iterator IT if doing a
15873 window-based redisplay. The space has the same face as
15874 IT->face_id. Value is non-zero if a space was added.
15876 This function is called to make sure that there is always one glyph
15877 at the end of a glyph row that the cursor can be set on under
15878 window-systems. (If there weren't such a glyph we would not know
15879 how wide and tall a box cursor should be displayed).
15881 At the same time this space let's a nicely handle clearing to the
15882 end of the line if the row ends in italic text. */
15885 append_space_for_newline (it
, default_face_p
)
15887 int default_face_p
;
15889 if (FRAME_WINDOW_P (it
->f
))
15891 int n
= it
->glyph_row
->used
[TEXT_AREA
];
15893 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
15894 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
15896 /* Save some values that must not be changed.
15897 Must save IT->c and IT->len because otherwise
15898 ITERATOR_AT_END_P wouldn't work anymore after
15899 append_space_for_newline has been called. */
15900 enum display_element_type saved_what
= it
->what
;
15901 int saved_c
= it
->c
, saved_len
= it
->len
;
15902 int saved_x
= it
->current_x
;
15903 int saved_face_id
= it
->face_id
;
15904 struct text_pos saved_pos
;
15905 Lisp_Object saved_object
;
15908 saved_object
= it
->object
;
15909 saved_pos
= it
->position
;
15911 it
->what
= IT_CHARACTER
;
15912 bzero (&it
->position
, sizeof it
->position
);
15913 it
->object
= make_number (0);
15917 if (default_face_p
)
15918 it
->face_id
= DEFAULT_FACE_ID
;
15919 else if (it
->face_before_selective_p
)
15920 it
->face_id
= it
->saved_face_id
;
15921 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
15922 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
15924 PRODUCE_GLYPHS (it
);
15926 it
->override_ascent
= -1;
15927 it
->constrain_row_ascent_descent_p
= 0;
15928 it
->current_x
= saved_x
;
15929 it
->object
= saved_object
;
15930 it
->position
= saved_pos
;
15931 it
->what
= saved_what
;
15932 it
->face_id
= saved_face_id
;
15933 it
->len
= saved_len
;
15943 /* Extend the face of the last glyph in the text area of IT->glyph_row
15944 to the end of the display line. Called from display_line.
15945 If the glyph row is empty, add a space glyph to it so that we
15946 know the face to draw. Set the glyph row flag fill_line_p. */
15949 extend_face_to_end_of_line (it
)
15953 struct frame
*f
= it
->f
;
15955 /* If line is already filled, do nothing. */
15956 if (it
->current_x
>= it
->last_visible_x
)
15959 /* Face extension extends the background and box of IT->face_id
15960 to the end of the line. If the background equals the background
15961 of the frame, we don't have to do anything. */
15962 if (it
->face_before_selective_p
)
15963 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
15965 face
= FACE_FROM_ID (f
, it
->face_id
);
15967 if (FRAME_WINDOW_P (f
)
15968 && it
->glyph_row
->displays_text_p
15969 && face
->box
== FACE_NO_BOX
15970 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
15974 /* Set the glyph row flag indicating that the face of the last glyph
15975 in the text area has to be drawn to the end of the text area. */
15976 it
->glyph_row
->fill_line_p
= 1;
15978 /* If current character of IT is not ASCII, make sure we have the
15979 ASCII face. This will be automatically undone the next time
15980 get_next_display_element returns a multibyte character. Note
15981 that the character will always be single byte in unibyte text. */
15982 if (!ASCII_CHAR_P (it
->c
))
15984 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
15987 if (FRAME_WINDOW_P (f
))
15989 /* If the row is empty, add a space with the current face of IT,
15990 so that we know which face to draw. */
15991 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
15993 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
15994 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
15995 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16000 /* Save some values that must not be changed. */
16001 int saved_x
= it
->current_x
;
16002 struct text_pos saved_pos
;
16003 Lisp_Object saved_object
;
16004 enum display_element_type saved_what
= it
->what
;
16005 int saved_face_id
= it
->face_id
;
16007 saved_object
= it
->object
;
16008 saved_pos
= it
->position
;
16010 it
->what
= IT_CHARACTER
;
16011 bzero (&it
->position
, sizeof it
->position
);
16012 it
->object
= make_number (0);
16015 it
->face_id
= face
->id
;
16017 PRODUCE_GLYPHS (it
);
16019 while (it
->current_x
<= it
->last_visible_x
)
16020 PRODUCE_GLYPHS (it
);
16022 /* Don't count these blanks really. It would let us insert a left
16023 truncation glyph below and make us set the cursor on them, maybe. */
16024 it
->current_x
= saved_x
;
16025 it
->object
= saved_object
;
16026 it
->position
= saved_pos
;
16027 it
->what
= saved_what
;
16028 it
->face_id
= saved_face_id
;
16033 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16034 trailing whitespace. */
16037 trailing_whitespace_p (charpos
)
16040 int bytepos
= CHAR_TO_BYTE (charpos
);
16043 while (bytepos
< ZV_BYTE
16044 && (c
= FETCH_CHAR (bytepos
),
16045 c
== ' ' || c
== '\t'))
16048 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16050 if (bytepos
!= PT_BYTE
)
16057 /* Highlight trailing whitespace, if any, in ROW. */
16060 highlight_trailing_whitespace (f
, row
)
16062 struct glyph_row
*row
;
16064 int used
= row
->used
[TEXT_AREA
];
16068 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16069 struct glyph
*glyph
= start
+ used
- 1;
16071 /* Skip over glyphs inserted to display the cursor at the
16072 end of a line, for extending the face of the last glyph
16073 to the end of the line on terminals, and for truncation
16074 and continuation glyphs. */
16075 while (glyph
>= start
16076 && glyph
->type
== CHAR_GLYPH
16077 && INTEGERP (glyph
->object
))
16080 /* If last glyph is a space or stretch, and it's trailing
16081 whitespace, set the face of all trailing whitespace glyphs in
16082 IT->glyph_row to `trailing-whitespace'. */
16084 && BUFFERP (glyph
->object
)
16085 && (glyph
->type
== STRETCH_GLYPH
16086 || (glyph
->type
== CHAR_GLYPH
16087 && glyph
->u
.ch
== ' '))
16088 && trailing_whitespace_p (glyph
->charpos
))
16090 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16094 while (glyph
>= start
16095 && BUFFERP (glyph
->object
)
16096 && (glyph
->type
== STRETCH_GLYPH
16097 || (glyph
->type
== CHAR_GLYPH
16098 && glyph
->u
.ch
== ' ')))
16099 (glyph
--)->face_id
= face_id
;
16105 /* Value is non-zero if glyph row ROW in window W should be
16106 used to hold the cursor. */
16109 cursor_row_p (w
, row
)
16111 struct glyph_row
*row
;
16113 int cursor_row_p
= 1;
16115 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16117 /* Suppose the row ends on a string.
16118 Unless the row is continued, that means it ends on a newline
16119 in the string. If it's anything other than a display string
16120 (e.g. a before-string from an overlay), we don't want the
16121 cursor there. (This heuristic seems to give the optimal
16122 behavior for the various types of multi-line strings.) */
16123 if (CHARPOS (row
->end
.string_pos
) >= 0)
16125 if (row
->continued_p
)
16129 /* Check for `display' property. */
16130 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16131 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16132 struct glyph
*glyph
;
16135 for (glyph
= end
; glyph
>= beg
; --glyph
)
16136 if (STRINGP (glyph
->object
))
16139 = Fget_char_property (make_number (PT
),
16143 && display_prop_string_p (prop
, glyph
->object
));
16148 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16150 /* If the row ends in middle of a real character,
16151 and the line is continued, we want the cursor here.
16152 That's because MATRIX_ROW_END_CHARPOS would equal
16153 PT if PT is before the character. */
16154 if (!row
->ends_in_ellipsis_p
)
16155 cursor_row_p
= row
->continued_p
;
16157 /* If the row ends in an ellipsis, then
16158 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16159 We want that position to be displayed after the ellipsis. */
16162 /* If the row ends at ZV, display the cursor at the end of that
16163 row instead of at the start of the row below. */
16164 else if (row
->ends_at_zv_p
)
16170 return cursor_row_p
;
16174 /* Construct the glyph row IT->glyph_row in the desired matrix of
16175 IT->w from text at the current position of IT. See dispextern.h
16176 for an overview of struct it. Value is non-zero if
16177 IT->glyph_row displays text, as opposed to a line displaying ZV
16184 struct glyph_row
*row
= it
->glyph_row
;
16185 Lisp_Object overlay_arrow_string
;
16187 /* We always start displaying at hpos zero even if hscrolled. */
16188 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16190 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16191 >= it
->w
->desired_matrix
->nrows
)
16193 it
->w
->nrows_scale_factor
++;
16194 fonts_changed_p
= 1;
16198 /* Is IT->w showing the region? */
16199 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16201 /* Clear the result glyph row and enable it. */
16202 prepare_desired_row (row
);
16204 row
->y
= it
->current_y
;
16205 row
->start
= it
->start
;
16206 row
->continuation_lines_width
= it
->continuation_lines_width
;
16207 row
->displays_text_p
= 1;
16208 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16209 it
->starts_in_middle_of_char_p
= 0;
16211 /* Arrange the overlays nicely for our purposes. Usually, we call
16212 display_line on only one line at a time, in which case this
16213 can't really hurt too much, or we call it on lines which appear
16214 one after another in the buffer, in which case all calls to
16215 recenter_overlay_lists but the first will be pretty cheap. */
16216 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16218 /* Move over display elements that are not visible because we are
16219 hscrolled. This may stop at an x-position < IT->first_visible_x
16220 if the first glyph is partially visible or if we hit a line end. */
16221 if (it
->current_x
< it
->first_visible_x
)
16223 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16224 MOVE_TO_POS
| MOVE_TO_X
);
16227 /* Get the initial row height. This is either the height of the
16228 text hscrolled, if there is any, or zero. */
16229 row
->ascent
= it
->max_ascent
;
16230 row
->height
= it
->max_ascent
+ it
->max_descent
;
16231 row
->phys_ascent
= it
->max_phys_ascent
;
16232 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16233 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16235 /* Loop generating characters. The loop is left with IT on the next
16236 character to display. */
16239 int n_glyphs_before
, hpos_before
, x_before
;
16241 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16243 /* Retrieve the next thing to display. Value is zero if end of
16245 if (!get_next_display_element (it
))
16247 /* Maybe add a space at the end of this line that is used to
16248 display the cursor there under X. Set the charpos of the
16249 first glyph of blank lines not corresponding to any text
16251 #ifdef HAVE_WINDOW_SYSTEM
16252 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16253 row
->exact_window_width_line_p
= 1;
16255 #endif /* HAVE_WINDOW_SYSTEM */
16256 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16257 || row
->used
[TEXT_AREA
] == 0)
16259 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16260 row
->displays_text_p
= 0;
16262 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16263 && (!MINI_WINDOW_P (it
->w
)
16264 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16265 row
->indicate_empty_line_p
= 1;
16268 it
->continuation_lines_width
= 0;
16269 row
->ends_at_zv_p
= 1;
16273 /* Now, get the metrics of what we want to display. This also
16274 generates glyphs in `row' (which is IT->glyph_row). */
16275 n_glyphs_before
= row
->used
[TEXT_AREA
];
16278 /* Remember the line height so far in case the next element doesn't
16279 fit on the line. */
16280 if (!it
->truncate_lines_p
)
16282 ascent
= it
->max_ascent
;
16283 descent
= it
->max_descent
;
16284 phys_ascent
= it
->max_phys_ascent
;
16285 phys_descent
= it
->max_phys_descent
;
16288 PRODUCE_GLYPHS (it
);
16290 /* If this display element was in marginal areas, continue with
16292 if (it
->area
!= TEXT_AREA
)
16294 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16295 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16296 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16297 row
->phys_height
= max (row
->phys_height
,
16298 it
->max_phys_ascent
+ it
->max_phys_descent
);
16299 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16300 it
->max_extra_line_spacing
);
16301 set_iterator_to_next (it
, 1);
16305 /* Does the display element fit on the line? If we truncate
16306 lines, we should draw past the right edge of the window. If
16307 we don't truncate, we want to stop so that we can display the
16308 continuation glyph before the right margin. If lines are
16309 continued, there are two possible strategies for characters
16310 resulting in more than 1 glyph (e.g. tabs): Display as many
16311 glyphs as possible in this line and leave the rest for the
16312 continuation line, or display the whole element in the next
16313 line. Original redisplay did the former, so we do it also. */
16314 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16315 hpos_before
= it
->hpos
;
16318 if (/* Not a newline. */
16320 /* Glyphs produced fit entirely in the line. */
16321 && it
->current_x
< it
->last_visible_x
)
16323 it
->hpos
+= nglyphs
;
16324 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16325 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16326 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16327 row
->phys_height
= max (row
->phys_height
,
16328 it
->max_phys_ascent
+ it
->max_phys_descent
);
16329 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16330 it
->max_extra_line_spacing
);
16331 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16332 row
->x
= x
- it
->first_visible_x
;
16337 struct glyph
*glyph
;
16339 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16341 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16342 new_x
= x
+ glyph
->pixel_width
;
16344 if (/* Lines are continued. */
16345 !it
->truncate_lines_p
16346 && (/* Glyph doesn't fit on the line. */
16347 new_x
> it
->last_visible_x
16348 /* Or it fits exactly on a window system frame. */
16349 || (new_x
== it
->last_visible_x
16350 && FRAME_WINDOW_P (it
->f
))))
16352 /* End of a continued line. */
16355 || (new_x
== it
->last_visible_x
16356 && FRAME_WINDOW_P (it
->f
)))
16358 /* Current glyph is the only one on the line or
16359 fits exactly on the line. We must continue
16360 the line because we can't draw the cursor
16361 after the glyph. */
16362 row
->continued_p
= 1;
16363 it
->current_x
= new_x
;
16364 it
->continuation_lines_width
+= new_x
;
16366 if (i
== nglyphs
- 1)
16368 set_iterator_to_next (it
, 1);
16369 #ifdef HAVE_WINDOW_SYSTEM
16370 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16372 if (!get_next_display_element (it
))
16374 row
->exact_window_width_line_p
= 1;
16375 it
->continuation_lines_width
= 0;
16376 row
->continued_p
= 0;
16377 row
->ends_at_zv_p
= 1;
16379 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16381 row
->continued_p
= 0;
16382 row
->exact_window_width_line_p
= 1;
16385 #endif /* HAVE_WINDOW_SYSTEM */
16388 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16389 && !FRAME_WINDOW_P (it
->f
))
16391 /* A padding glyph that doesn't fit on this line.
16392 This means the whole character doesn't fit
16394 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16396 /* Fill the rest of the row with continuation
16397 glyphs like in 20.x. */
16398 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16399 < row
->glyphs
[1 + TEXT_AREA
])
16400 produce_special_glyphs (it
, IT_CONTINUATION
);
16402 row
->continued_p
= 1;
16403 it
->current_x
= x_before
;
16404 it
->continuation_lines_width
+= x_before
;
16406 /* Restore the height to what it was before the
16407 element not fitting on the line. */
16408 it
->max_ascent
= ascent
;
16409 it
->max_descent
= descent
;
16410 it
->max_phys_ascent
= phys_ascent
;
16411 it
->max_phys_descent
= phys_descent
;
16413 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16415 /* A TAB that extends past the right edge of the
16416 window. This produces a single glyph on
16417 window system frames. We leave the glyph in
16418 this row and let it fill the row, but don't
16419 consume the TAB. */
16420 it
->continuation_lines_width
+= it
->last_visible_x
;
16421 row
->ends_in_middle_of_char_p
= 1;
16422 row
->continued_p
= 1;
16423 glyph
->pixel_width
= it
->last_visible_x
- x
;
16424 it
->starts_in_middle_of_char_p
= 1;
16428 /* Something other than a TAB that draws past
16429 the right edge of the window. Restore
16430 positions to values before the element. */
16431 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16433 /* Display continuation glyphs. */
16434 if (!FRAME_WINDOW_P (it
->f
))
16435 produce_special_glyphs (it
, IT_CONTINUATION
);
16436 row
->continued_p
= 1;
16438 it
->current_x
= x_before
;
16439 it
->continuation_lines_width
+= x
;
16440 extend_face_to_end_of_line (it
);
16442 if (nglyphs
> 1 && i
> 0)
16444 row
->ends_in_middle_of_char_p
= 1;
16445 it
->starts_in_middle_of_char_p
= 1;
16448 /* Restore the height to what it was before the
16449 element not fitting on the line. */
16450 it
->max_ascent
= ascent
;
16451 it
->max_descent
= descent
;
16452 it
->max_phys_ascent
= phys_ascent
;
16453 it
->max_phys_descent
= phys_descent
;
16458 else if (new_x
> it
->first_visible_x
)
16460 /* Increment number of glyphs actually displayed. */
16463 if (x
< it
->first_visible_x
)
16464 /* Glyph is partially visible, i.e. row starts at
16465 negative X position. */
16466 row
->x
= x
- it
->first_visible_x
;
16470 /* Glyph is completely off the left margin of the
16471 window. This should not happen because of the
16472 move_it_in_display_line at the start of this
16473 function, unless the text display area of the
16474 window is empty. */
16475 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16479 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16480 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16481 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16482 row
->phys_height
= max (row
->phys_height
,
16483 it
->max_phys_ascent
+ it
->max_phys_descent
);
16484 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16485 it
->max_extra_line_spacing
);
16487 /* End of this display line if row is continued. */
16488 if (row
->continued_p
|| row
->ends_at_zv_p
)
16493 /* Is this a line end? If yes, we're also done, after making
16494 sure that a non-default face is extended up to the right
16495 margin of the window. */
16496 if (ITERATOR_AT_END_OF_LINE_P (it
))
16498 int used_before
= row
->used
[TEXT_AREA
];
16500 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16502 #ifdef HAVE_WINDOW_SYSTEM
16503 /* Add a space at the end of the line that is used to
16504 display the cursor there. */
16505 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16506 append_space_for_newline (it
, 0);
16507 #endif /* HAVE_WINDOW_SYSTEM */
16509 /* Extend the face to the end of the line. */
16510 extend_face_to_end_of_line (it
);
16512 /* Make sure we have the position. */
16513 if (used_before
== 0)
16514 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16516 /* Consume the line end. This skips over invisible lines. */
16517 set_iterator_to_next (it
, 1);
16518 it
->continuation_lines_width
= 0;
16522 /* Proceed with next display element. Note that this skips
16523 over lines invisible because of selective display. */
16524 set_iterator_to_next (it
, 1);
16526 /* If we truncate lines, we are done when the last displayed
16527 glyphs reach past the right margin of the window. */
16528 if (it
->truncate_lines_p
16529 && (FRAME_WINDOW_P (it
->f
)
16530 ? (it
->current_x
>= it
->last_visible_x
)
16531 : (it
->current_x
> it
->last_visible_x
)))
16533 /* Maybe add truncation glyphs. */
16534 if (!FRAME_WINDOW_P (it
->f
))
16538 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16539 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16542 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16544 row
->used
[TEXT_AREA
] = i
;
16545 produce_special_glyphs (it
, IT_TRUNCATION
);
16548 #ifdef HAVE_WINDOW_SYSTEM
16551 /* Don't truncate if we can overflow newline into fringe. */
16552 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16554 if (!get_next_display_element (it
))
16556 it
->continuation_lines_width
= 0;
16557 row
->ends_at_zv_p
= 1;
16558 row
->exact_window_width_line_p
= 1;
16561 if (ITERATOR_AT_END_OF_LINE_P (it
))
16563 row
->exact_window_width_line_p
= 1;
16564 goto at_end_of_line
;
16568 #endif /* HAVE_WINDOW_SYSTEM */
16570 row
->truncated_on_right_p
= 1;
16571 it
->continuation_lines_width
= 0;
16572 reseat_at_next_visible_line_start (it
, 0);
16573 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16574 it
->hpos
= hpos_before
;
16575 it
->current_x
= x_before
;
16580 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16581 at the left window margin. */
16582 if (it
->first_visible_x
16583 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16585 if (!FRAME_WINDOW_P (it
->f
))
16586 insert_left_trunc_glyphs (it
);
16587 row
->truncated_on_left_p
= 1;
16590 /* If the start of this line is the overlay arrow-position, then
16591 mark this glyph row as the one containing the overlay arrow.
16592 This is clearly a mess with variable size fonts. It would be
16593 better to let it be displayed like cursors under X. */
16594 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16595 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16596 !NILP (overlay_arrow_string
)))
16598 /* Overlay arrow in window redisplay is a fringe bitmap. */
16599 if (STRINGP (overlay_arrow_string
))
16601 struct glyph_row
*arrow_row
16602 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16603 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16604 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16605 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16606 struct glyph
*p2
, *end
;
16608 /* Copy the arrow glyphs. */
16609 while (glyph
< arrow_end
)
16612 /* Throw away padding glyphs. */
16614 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16615 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16621 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16626 xassert (INTEGERP (overlay_arrow_string
));
16627 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16629 overlay_arrow_seen
= 1;
16632 /* Compute pixel dimensions of this line. */
16633 compute_line_metrics (it
);
16635 /* Remember the position at which this line ends. */
16636 row
->end
= it
->current
;
16638 /* Record whether this row ends inside an ellipsis. */
16639 row
->ends_in_ellipsis_p
16640 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16641 && it
->ellipsis_p
);
16643 /* Save fringe bitmaps in this row. */
16644 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16645 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16646 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16647 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16649 it
->left_user_fringe_bitmap
= 0;
16650 it
->left_user_fringe_face_id
= 0;
16651 it
->right_user_fringe_bitmap
= 0;
16652 it
->right_user_fringe_face_id
= 0;
16654 /* Maybe set the cursor. */
16655 if (it
->w
->cursor
.vpos
< 0
16656 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
16657 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
16658 && cursor_row_p (it
->w
, row
))
16659 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
16661 /* Highlight trailing whitespace. */
16662 if (!NILP (Vshow_trailing_whitespace
))
16663 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
16665 /* Prepare for the next line. This line starts horizontally at (X
16666 HPOS) = (0 0). Vertical positions are incremented. As a
16667 convenience for the caller, IT->glyph_row is set to the next
16669 it
->current_x
= it
->hpos
= 0;
16670 it
->current_y
+= row
->height
;
16673 it
->start
= it
->current
;
16674 return row
->displays_text_p
;
16679 /***********************************************************************
16681 ***********************************************************************/
16683 /* Redisplay the menu bar in the frame for window W.
16685 The menu bar of X frames that don't have X toolkit support is
16686 displayed in a special window W->frame->menu_bar_window.
16688 The menu bar of terminal frames is treated specially as far as
16689 glyph matrices are concerned. Menu bar lines are not part of
16690 windows, so the update is done directly on the frame matrix rows
16691 for the menu bar. */
16694 display_menu_bar (w
)
16697 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16702 /* Don't do all this for graphical frames. */
16704 if (FRAME_W32_P (f
))
16707 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
16712 if (FRAME_MAC_P (f
))
16716 #ifdef USE_X_TOOLKIT
16717 xassert (!FRAME_WINDOW_P (f
));
16718 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
16719 it
.first_visible_x
= 0;
16720 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16721 #else /* not USE_X_TOOLKIT */
16722 if (FRAME_WINDOW_P (f
))
16724 /* Menu bar lines are displayed in the desired matrix of the
16725 dummy window menu_bar_window. */
16726 struct window
*menu_w
;
16727 xassert (WINDOWP (f
->menu_bar_window
));
16728 menu_w
= XWINDOW (f
->menu_bar_window
);
16729 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
16731 it
.first_visible_x
= 0;
16732 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
16736 /* This is a TTY frame, i.e. character hpos/vpos are used as
16738 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
16740 it
.first_visible_x
= 0;
16741 it
.last_visible_x
= FRAME_COLS (f
);
16743 #endif /* not USE_X_TOOLKIT */
16745 if (! mode_line_inverse_video
)
16746 /* Force the menu-bar to be displayed in the default face. */
16747 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16749 /* Clear all rows of the menu bar. */
16750 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
16752 struct glyph_row
*row
= it
.glyph_row
+ i
;
16753 clear_glyph_row (row
);
16754 row
->enabled_p
= 1;
16755 row
->full_width_p
= 1;
16758 /* Display all items of the menu bar. */
16759 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
16760 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
16762 Lisp_Object string
;
16764 /* Stop at nil string. */
16765 string
= AREF (items
, i
+ 1);
16769 /* Remember where item was displayed. */
16770 ASET (items
, i
+ 3, make_number (it
.hpos
));
16772 /* Display the item, pad with one space. */
16773 if (it
.current_x
< it
.last_visible_x
)
16774 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
16775 SCHARS (string
) + 1, 0, 0, -1);
16778 /* Fill out the line with spaces. */
16779 if (it
.current_x
< it
.last_visible_x
)
16780 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
16782 /* Compute the total height of the lines. */
16783 compute_line_metrics (&it
);
16788 /***********************************************************************
16790 ***********************************************************************/
16792 /* Redisplay mode lines in the window tree whose root is WINDOW. If
16793 FORCE is non-zero, redisplay mode lines unconditionally.
16794 Otherwise, redisplay only mode lines that are garbaged. Value is
16795 the number of windows whose mode lines were redisplayed. */
16798 redisplay_mode_lines (window
, force
)
16799 Lisp_Object window
;
16804 while (!NILP (window
))
16806 struct window
*w
= XWINDOW (window
);
16808 if (WINDOWP (w
->hchild
))
16809 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
16810 else if (WINDOWP (w
->vchild
))
16811 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
16813 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
16814 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
16816 struct text_pos lpoint
;
16817 struct buffer
*old
= current_buffer
;
16819 /* Set the window's buffer for the mode line display. */
16820 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16821 set_buffer_internal_1 (XBUFFER (w
->buffer
));
16823 /* Point refers normally to the selected window. For any
16824 other window, set up appropriate value. */
16825 if (!EQ (window
, selected_window
))
16827 struct text_pos pt
;
16829 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
16830 if (CHARPOS (pt
) < BEGV
)
16831 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16832 else if (CHARPOS (pt
) > (ZV
- 1))
16833 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
16835 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
16838 /* Display mode lines. */
16839 clear_glyph_matrix (w
->desired_matrix
);
16840 if (display_mode_lines (w
))
16843 w
->must_be_updated_p
= 1;
16846 /* Restore old settings. */
16847 set_buffer_internal_1 (old
);
16848 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16858 /* Display the mode and/or top line of window W. Value is the number
16859 of mode lines displayed. */
16862 display_mode_lines (w
)
16865 Lisp_Object old_selected_window
, old_selected_frame
;
16868 old_selected_frame
= selected_frame
;
16869 selected_frame
= w
->frame
;
16870 old_selected_window
= selected_window
;
16871 XSETWINDOW (selected_window
, w
);
16873 /* These will be set while the mode line specs are processed. */
16874 line_number_displayed
= 0;
16875 w
->column_number_displayed
= Qnil
;
16877 if (WINDOW_WANTS_MODELINE_P (w
))
16879 struct window
*sel_w
= XWINDOW (old_selected_window
);
16881 /* Select mode line face based on the real selected window. */
16882 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
16883 current_buffer
->mode_line_format
);
16887 if (WINDOW_WANTS_HEADER_LINE_P (w
))
16889 display_mode_line (w
, HEADER_LINE_FACE_ID
,
16890 current_buffer
->header_line_format
);
16894 selected_frame
= old_selected_frame
;
16895 selected_window
= old_selected_window
;
16900 /* Display mode or top line of window W. FACE_ID specifies which line
16901 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
16902 FORMAT is the mode line format to display. Value is the pixel
16903 height of the mode line displayed. */
16906 display_mode_line (w
, face_id
, format
)
16908 enum face_id face_id
;
16909 Lisp_Object format
;
16913 int count
= SPECPDL_INDEX ();
16915 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
16916 /* Don't extend on a previously drawn mode-line.
16917 This may happen if called from pos_visible_p. */
16918 it
.glyph_row
->enabled_p
= 0;
16919 prepare_desired_row (it
.glyph_row
);
16921 it
.glyph_row
->mode_line_p
= 1;
16923 if (! mode_line_inverse_video
)
16924 /* Force the mode-line to be displayed in the default face. */
16925 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
16927 record_unwind_protect (unwind_format_mode_line
,
16928 format_mode_line_unwind_data (NULL
, 0));
16930 mode_line_target
= MODE_LINE_DISPLAY
;
16932 /* Temporarily make frame's keyboard the current kboard so that
16933 kboard-local variables in the mode_line_format will get the right
16935 push_kboard (FRAME_KBOARD (it
.f
));
16936 record_unwind_save_match_data ();
16937 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
16940 unbind_to (count
, Qnil
);
16942 /* Fill up with spaces. */
16943 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
16945 compute_line_metrics (&it
);
16946 it
.glyph_row
->full_width_p
= 1;
16947 it
.glyph_row
->continued_p
= 0;
16948 it
.glyph_row
->truncated_on_left_p
= 0;
16949 it
.glyph_row
->truncated_on_right_p
= 0;
16951 /* Make a 3D mode-line have a shadow at its right end. */
16952 face
= FACE_FROM_ID (it
.f
, face_id
);
16953 extend_face_to_end_of_line (&it
);
16954 if (face
->box
!= FACE_NO_BOX
)
16956 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
16957 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
16958 last
->right_box_line_p
= 1;
16961 return it
.glyph_row
->height
;
16964 /* Move element ELT in LIST to the front of LIST.
16965 Return the updated list. */
16968 move_elt_to_front (elt
, list
)
16969 Lisp_Object elt
, list
;
16971 register Lisp_Object tail
, prev
;
16972 register Lisp_Object tem
;
16976 while (CONSP (tail
))
16982 /* Splice out the link TAIL. */
16984 list
= XCDR (tail
);
16986 Fsetcdr (prev
, XCDR (tail
));
16988 /* Now make it the first. */
16989 Fsetcdr (tail
, list
);
16994 tail
= XCDR (tail
);
16998 /* Not found--return unchanged LIST. */
17002 /* Contribute ELT to the mode line for window IT->w. How it
17003 translates into text depends on its data type.
17005 IT describes the display environment in which we display, as usual.
17007 DEPTH is the depth in recursion. It is used to prevent
17008 infinite recursion here.
17010 FIELD_WIDTH is the number of characters the display of ELT should
17011 occupy in the mode line, and PRECISION is the maximum number of
17012 characters to display from ELT's representation. See
17013 display_string for details.
17015 Returns the hpos of the end of the text generated by ELT.
17017 PROPS is a property list to add to any string we encounter.
17019 If RISKY is nonzero, remove (disregard) any properties in any string
17020 we encounter, and ignore :eval and :propertize.
17022 The global variable `mode_line_target' determines whether the
17023 output is passed to `store_mode_line_noprop',
17024 `store_mode_line_string', or `display_string'. */
17027 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17030 int field_width
, precision
;
17031 Lisp_Object elt
, props
;
17034 int n
= 0, field
, prec
;
17039 elt
= build_string ("*too-deep*");
17043 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17047 /* A string: output it and check for %-constructs within it. */
17051 if (SCHARS (elt
) > 0
17052 && (!NILP (props
) || risky
))
17054 Lisp_Object oprops
, aelt
;
17055 oprops
= Ftext_properties_at (make_number (0), elt
);
17057 /* If the starting string's properties are not what
17058 we want, translate the string. Also, if the string
17059 is risky, do that anyway. */
17061 if (NILP (Fequal (props
, oprops
)) || risky
)
17063 /* If the starting string has properties,
17064 merge the specified ones onto the existing ones. */
17065 if (! NILP (oprops
) && !risky
)
17069 oprops
= Fcopy_sequence (oprops
);
17071 while (CONSP (tem
))
17073 oprops
= Fplist_put (oprops
, XCAR (tem
),
17074 XCAR (XCDR (tem
)));
17075 tem
= XCDR (XCDR (tem
));
17080 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17081 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17083 /* AELT is what we want. Move it to the front
17084 without consing. */
17086 mode_line_proptrans_alist
17087 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17093 /* If AELT has the wrong props, it is useless.
17094 so get rid of it. */
17096 mode_line_proptrans_alist
17097 = Fdelq (aelt
, mode_line_proptrans_alist
);
17099 elt
= Fcopy_sequence (elt
);
17100 Fset_text_properties (make_number (0), Flength (elt
),
17102 /* Add this item to mode_line_proptrans_alist. */
17103 mode_line_proptrans_alist
17104 = Fcons (Fcons (elt
, props
),
17105 mode_line_proptrans_alist
);
17106 /* Truncate mode_line_proptrans_alist
17107 to at most 50 elements. */
17108 tem
= Fnthcdr (make_number (50),
17109 mode_line_proptrans_alist
);
17111 XSETCDR (tem
, Qnil
);
17120 prec
= precision
- n
;
17121 switch (mode_line_target
)
17123 case MODE_LINE_NOPROP
:
17124 case MODE_LINE_TITLE
:
17125 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17127 case MODE_LINE_STRING
:
17128 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17130 case MODE_LINE_DISPLAY
:
17131 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17132 0, prec
, 0, STRING_MULTIBYTE (elt
));
17139 /* Handle the non-literal case. */
17141 while ((precision
<= 0 || n
< precision
)
17142 && SREF (elt
, offset
) != 0
17143 && (mode_line_target
!= MODE_LINE_DISPLAY
17144 || it
->current_x
< it
->last_visible_x
))
17146 int last_offset
= offset
;
17148 /* Advance to end of string or next format specifier. */
17149 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17152 if (offset
- 1 != last_offset
)
17154 int nchars
, nbytes
;
17156 /* Output to end of string or up to '%'. Field width
17157 is length of string. Don't output more than
17158 PRECISION allows us. */
17161 prec
= c_string_width (SDATA (elt
) + last_offset
,
17162 offset
- last_offset
, precision
- n
,
17165 switch (mode_line_target
)
17167 case MODE_LINE_NOPROP
:
17168 case MODE_LINE_TITLE
:
17169 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17171 case MODE_LINE_STRING
:
17173 int bytepos
= last_offset
;
17174 int charpos
= string_byte_to_char (elt
, bytepos
);
17175 int endpos
= (precision
<= 0
17176 ? string_byte_to_char (elt
, offset
)
17177 : charpos
+ nchars
);
17179 n
+= store_mode_line_string (NULL
,
17180 Fsubstring (elt
, make_number (charpos
),
17181 make_number (endpos
)),
17185 case MODE_LINE_DISPLAY
:
17187 int bytepos
= last_offset
;
17188 int charpos
= string_byte_to_char (elt
, bytepos
);
17190 if (precision
<= 0)
17191 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17192 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17194 STRING_MULTIBYTE (elt
));
17199 else /* c == '%' */
17201 int percent_position
= offset
;
17203 /* Get the specified minimum width. Zero means
17206 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17207 field
= field
* 10 + c
- '0';
17209 /* Don't pad beyond the total padding allowed. */
17210 if (field_width
- n
> 0 && field
> field_width
- n
)
17211 field
= field_width
- n
;
17213 /* Note that either PRECISION <= 0 or N < PRECISION. */
17214 prec
= precision
- n
;
17217 n
+= display_mode_element (it
, depth
, field
, prec
,
17218 Vglobal_mode_string
, props
,
17223 int bytepos
, charpos
;
17224 unsigned char *spec
;
17226 bytepos
= percent_position
;
17227 charpos
= (STRING_MULTIBYTE (elt
)
17228 ? string_byte_to_char (elt
, bytepos
)
17231 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17233 switch (mode_line_target
)
17235 case MODE_LINE_NOPROP
:
17236 case MODE_LINE_TITLE
:
17237 n
+= store_mode_line_noprop (spec
, field
, prec
);
17239 case MODE_LINE_STRING
:
17241 int len
= strlen (spec
);
17242 Lisp_Object tem
= make_string (spec
, len
);
17243 props
= Ftext_properties_at (make_number (charpos
), elt
);
17244 /* Should only keep face property in props */
17245 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17248 case MODE_LINE_DISPLAY
:
17250 int nglyphs_before
, nwritten
;
17252 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17253 nwritten
= display_string (spec
, Qnil
, elt
,
17258 /* Assign to the glyphs written above the
17259 string where the `%x' came from, position
17263 struct glyph
*glyph
17264 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17268 for (i
= 0; i
< nwritten
; ++i
)
17270 glyph
[i
].object
= elt
;
17271 glyph
[i
].charpos
= charpos
;
17288 /* A symbol: process the value of the symbol recursively
17289 as if it appeared here directly. Avoid error if symbol void.
17290 Special case: if value of symbol is a string, output the string
17293 register Lisp_Object tem
;
17295 /* If the variable is not marked as risky to set
17296 then its contents are risky to use. */
17297 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17300 tem
= Fboundp (elt
);
17303 tem
= Fsymbol_value (elt
);
17304 /* If value is a string, output that string literally:
17305 don't check for % within it. */
17309 if (!EQ (tem
, elt
))
17311 /* Give up right away for nil or t. */
17321 register Lisp_Object car
, tem
;
17323 /* A cons cell: five distinct cases.
17324 If first element is :eval or :propertize, do something special.
17325 If first element is a string or a cons, process all the elements
17326 and effectively concatenate them.
17327 If first element is a negative number, truncate displaying cdr to
17328 at most that many characters. If positive, pad (with spaces)
17329 to at least that many characters.
17330 If first element is a symbol, process the cadr or caddr recursively
17331 according to whether the symbol's value is non-nil or nil. */
17333 if (EQ (car
, QCeval
))
17335 /* An element of the form (:eval FORM) means evaluate FORM
17336 and use the result as mode line elements. */
17341 if (CONSP (XCDR (elt
)))
17344 spec
= safe_eval (XCAR (XCDR (elt
)));
17345 n
+= display_mode_element (it
, depth
, field_width
- n
,
17346 precision
- n
, spec
, props
,
17350 else if (EQ (car
, QCpropertize
))
17352 /* An element of the form (:propertize ELT PROPS...)
17353 means display ELT but applying properties PROPS. */
17358 if (CONSP (XCDR (elt
)))
17359 n
+= display_mode_element (it
, depth
, field_width
- n
,
17360 precision
- n
, XCAR (XCDR (elt
)),
17361 XCDR (XCDR (elt
)), risky
);
17363 else if (SYMBOLP (car
))
17365 tem
= Fboundp (car
);
17369 /* elt is now the cdr, and we know it is a cons cell.
17370 Use its car if CAR has a non-nil value. */
17373 tem
= Fsymbol_value (car
);
17380 /* Symbol's value is nil (or symbol is unbound)
17381 Get the cddr of the original list
17382 and if possible find the caddr and use that. */
17386 else if (!CONSP (elt
))
17391 else if (INTEGERP (car
))
17393 register int lim
= XINT (car
);
17397 /* Negative int means reduce maximum width. */
17398 if (precision
<= 0)
17401 precision
= min (precision
, -lim
);
17405 /* Padding specified. Don't let it be more than
17406 current maximum. */
17408 lim
= min (precision
, lim
);
17410 /* If that's more padding than already wanted, queue it.
17411 But don't reduce padding already specified even if
17412 that is beyond the current truncation point. */
17413 field_width
= max (lim
, field_width
);
17417 else if (STRINGP (car
) || CONSP (car
))
17419 register int limit
= 50;
17420 /* Limit is to protect against circular lists. */
17423 && (precision
<= 0 || n
< precision
))
17425 n
+= display_mode_element (it
, depth
,
17426 /* Do padding only after the last
17427 element in the list. */
17428 (! CONSP (XCDR (elt
))
17431 precision
- n
, XCAR (elt
),
17441 elt
= build_string ("*invalid*");
17445 /* Pad to FIELD_WIDTH. */
17446 if (field_width
> 0 && n
< field_width
)
17448 switch (mode_line_target
)
17450 case MODE_LINE_NOPROP
:
17451 case MODE_LINE_TITLE
:
17452 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17454 case MODE_LINE_STRING
:
17455 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17457 case MODE_LINE_DISPLAY
:
17458 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17467 /* Store a mode-line string element in mode_line_string_list.
17469 If STRING is non-null, display that C string. Otherwise, the Lisp
17470 string LISP_STRING is displayed.
17472 FIELD_WIDTH is the minimum number of output glyphs to produce.
17473 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17474 with spaces. FIELD_WIDTH <= 0 means don't pad.
17476 PRECISION is the maximum number of characters to output from
17477 STRING. PRECISION <= 0 means don't truncate the string.
17479 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17480 properties to the string.
17482 PROPS are the properties to add to the string.
17483 The mode_line_string_face face property is always added to the string.
17487 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17489 Lisp_Object lisp_string
;
17498 if (string
!= NULL
)
17500 len
= strlen (string
);
17501 if (precision
> 0 && len
> precision
)
17503 lisp_string
= make_string (string
, len
);
17505 props
= mode_line_string_face_prop
;
17506 else if (!NILP (mode_line_string_face
))
17508 Lisp_Object face
= Fplist_get (props
, Qface
);
17509 props
= Fcopy_sequence (props
);
17511 face
= mode_line_string_face
;
17513 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17514 props
= Fplist_put (props
, Qface
, face
);
17516 Fadd_text_properties (make_number (0), make_number (len
),
17517 props
, lisp_string
);
17521 len
= XFASTINT (Flength (lisp_string
));
17522 if (precision
> 0 && len
> precision
)
17525 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17528 if (!NILP (mode_line_string_face
))
17532 props
= Ftext_properties_at (make_number (0), lisp_string
);
17533 face
= Fplist_get (props
, Qface
);
17535 face
= mode_line_string_face
;
17537 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17538 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17540 lisp_string
= Fcopy_sequence (lisp_string
);
17543 Fadd_text_properties (make_number (0), make_number (len
),
17544 props
, lisp_string
);
17549 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17553 if (field_width
> len
)
17555 field_width
-= len
;
17556 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17558 Fadd_text_properties (make_number (0), make_number (field_width
),
17559 props
, lisp_string
);
17560 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17568 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17570 doc
: /* Format a string out of a mode line format specification.
17571 First arg FORMAT specifies the mode line format (see `mode-line-format'
17572 for details) to use.
17574 Optional second arg FACE specifies the face property to put
17575 on all characters for which no face is specified.
17576 The value t means whatever face the window's mode line currently uses
17577 \(either `mode-line' or `mode-line-inactive', depending).
17578 A value of nil means the default is no face property.
17579 If FACE is an integer, the value string has no text properties.
17581 Optional third and fourth args WINDOW and BUFFER specify the window
17582 and buffer to use as the context for the formatting (defaults
17583 are the selected window and the window's buffer). */)
17584 (format
, face
, window
, buffer
)
17585 Lisp_Object format
, face
, window
, buffer
;
17590 struct buffer
*old_buffer
= NULL
;
17592 int no_props
= INTEGERP (face
);
17593 int count
= SPECPDL_INDEX ();
17595 int string_start
= 0;
17598 window
= selected_window
;
17599 CHECK_WINDOW (window
);
17600 w
= XWINDOW (window
);
17603 buffer
= w
->buffer
;
17604 CHECK_BUFFER (buffer
);
17606 /* Make formatting the modeline a non-op when noninteractive, otherwise
17607 there will be problems later caused by a partially initialized frame. */
17608 if (NILP (format
) || noninteractive
)
17609 return empty_unibyte_string
;
17617 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17618 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17622 face_id
= DEFAULT_FACE_ID
;
17624 if (XBUFFER (buffer
) != current_buffer
)
17625 old_buffer
= current_buffer
;
17627 /* Save things including mode_line_proptrans_alist,
17628 and set that to nil so that we don't alter the outer value. */
17629 record_unwind_protect (unwind_format_mode_line
,
17630 format_mode_line_unwind_data (old_buffer
, 1));
17631 mode_line_proptrans_alist
= Qnil
;
17634 set_buffer_internal_1 (XBUFFER (buffer
));
17636 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17640 mode_line_target
= MODE_LINE_NOPROP
;
17641 mode_line_string_face_prop
= Qnil
;
17642 mode_line_string_list
= Qnil
;
17643 string_start
= MODE_LINE_NOPROP_LEN (0);
17647 mode_line_target
= MODE_LINE_STRING
;
17648 mode_line_string_list
= Qnil
;
17649 mode_line_string_face
= face
;
17650 mode_line_string_face_prop
17651 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
17654 push_kboard (FRAME_KBOARD (it
.f
));
17655 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17660 len
= MODE_LINE_NOPROP_LEN (string_start
);
17661 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
17665 mode_line_string_list
= Fnreverse (mode_line_string_list
);
17666 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
17667 empty_unibyte_string
);
17670 unbind_to (count
, Qnil
);
17674 /* Write a null-terminated, right justified decimal representation of
17675 the positive integer D to BUF using a minimal field width WIDTH. */
17678 pint2str (buf
, width
, d
)
17679 register char *buf
;
17680 register int width
;
17683 register char *p
= buf
;
17691 *p
++ = d
% 10 + '0';
17696 for (width
-= (int) (p
- buf
); width
> 0; --width
)
17707 /* Write a null-terminated, right justified decimal and "human
17708 readable" representation of the nonnegative integer D to BUF using
17709 a minimal field width WIDTH. D should be smaller than 999.5e24. */
17711 static const char power_letter
[] =
17725 pint2hrstr (buf
, width
, d
)
17730 /* We aim to represent the nonnegative integer D as
17731 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
17734 /* -1 means: do not use TENTHS. */
17738 /* Length of QUOTIENT.TENTHS as a string. */
17744 if (1000 <= quotient
)
17746 /* Scale to the appropriate EXPONENT. */
17749 remainder
= quotient
% 1000;
17753 while (1000 <= quotient
);
17755 /* Round to nearest and decide whether to use TENTHS or not. */
17758 tenths
= remainder
/ 100;
17759 if (50 <= remainder
% 100)
17766 if (quotient
== 10)
17774 if (500 <= remainder
)
17776 if (quotient
< 999)
17787 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
17788 if (tenths
== -1 && quotient
<= 99)
17795 p
= psuffix
= buf
+ max (width
, length
);
17797 /* Print EXPONENT. */
17799 *psuffix
++ = power_letter
[exponent
];
17802 /* Print TENTHS. */
17805 *--p
= '0' + tenths
;
17809 /* Print QUOTIENT. */
17812 int digit
= quotient
% 10;
17813 *--p
= '0' + digit
;
17815 while ((quotient
/= 10) != 0);
17817 /* Print leading spaces. */
17822 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
17823 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
17824 type of CODING_SYSTEM. Return updated pointer into BUF. */
17826 static unsigned char invalid_eol_type
[] = "(*invalid*)";
17829 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
17830 Lisp_Object coding_system
;
17831 register char *buf
;
17835 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
17836 const unsigned char *eol_str
;
17838 /* The EOL conversion we are using. */
17839 Lisp_Object eoltype
;
17841 val
= CODING_SYSTEM_SPEC (coding_system
);
17844 if (!VECTORP (val
)) /* Not yet decided. */
17849 eoltype
= eol_mnemonic_undecided
;
17850 /* Don't mention EOL conversion if it isn't decided. */
17855 Lisp_Object eolvalue
;
17857 attrs
= AREF (val
, 0);
17858 eolvalue
= AREF (val
, 2);
17861 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
17865 /* The EOL conversion that is normal on this system. */
17867 if (NILP (eolvalue
)) /* Not yet decided. */
17868 eoltype
= eol_mnemonic_undecided
;
17869 else if (VECTORP (eolvalue
)) /* Not yet decided. */
17870 eoltype
= eol_mnemonic_undecided
;
17871 else /* eolvalue is Qunix, Qdos, or Qmac. */
17872 eoltype
= (EQ (eolvalue
, Qunix
)
17873 ? eol_mnemonic_unix
17874 : (EQ (eolvalue
, Qdos
) == 1
17875 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
17881 /* Mention the EOL conversion if it is not the usual one. */
17882 if (STRINGP (eoltype
))
17884 eol_str
= SDATA (eoltype
);
17885 eol_str_len
= SBYTES (eoltype
);
17887 else if (CHARACTERP (eoltype
))
17889 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
17890 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
17895 eol_str
= invalid_eol_type
;
17896 eol_str_len
= sizeof (invalid_eol_type
) - 1;
17898 bcopy (eol_str
, buf
, eol_str_len
);
17899 buf
+= eol_str_len
;
17905 /* Return a string for the output of a mode line %-spec for window W,
17906 generated by character C. PRECISION >= 0 means don't return a
17907 string longer than that value. FIELD_WIDTH > 0 means pad the
17908 string returned with spaces to that value. Return 1 in *MULTIBYTE
17909 if the result is multibyte text.
17911 Note we operate on the current buffer for most purposes,
17912 the exception being w->base_line_pos. */
17914 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
17917 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
17920 int field_width
, precision
;
17924 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17925 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
17926 struct buffer
*b
= current_buffer
;
17934 if (!NILP (b
->read_only
))
17936 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17941 /* This differs from %* only for a modified read-only buffer. */
17942 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17944 if (!NILP (b
->read_only
))
17949 /* This differs from %* in ignoring read-only-ness. */
17950 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
17962 if (command_loop_level
> 5)
17964 p
= decode_mode_spec_buf
;
17965 for (i
= 0; i
< command_loop_level
; i
++)
17968 return decode_mode_spec_buf
;
17976 if (command_loop_level
> 5)
17978 p
= decode_mode_spec_buf
;
17979 for (i
= 0; i
< command_loop_level
; i
++)
17982 return decode_mode_spec_buf
;
17989 /* Let lots_of_dashes be a string of infinite length. */
17990 if (mode_line_target
== MODE_LINE_NOPROP
||
17991 mode_line_target
== MODE_LINE_STRING
)
17993 if (field_width
<= 0
17994 || field_width
> sizeof (lots_of_dashes
))
17996 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
17997 decode_mode_spec_buf
[i
] = '-';
17998 decode_mode_spec_buf
[i
] = '\0';
17999 return decode_mode_spec_buf
;
18002 return lots_of_dashes
;
18010 /* %c and %l are ignored in `frame-title-format'.
18011 (In redisplay_internal, the frame title is drawn _before_ the
18012 windows are updated, so the stuff which depends on actual
18013 window contents (such as %l) may fail to render properly, or
18014 even crash emacs.) */
18015 if (mode_line_target
== MODE_LINE_TITLE
)
18019 int col
= (int) current_column (); /* iftc */
18020 w
->column_number_displayed
= make_number (col
);
18021 pint2str (decode_mode_spec_buf
, field_width
, col
);
18022 return decode_mode_spec_buf
;
18026 #ifndef SYSTEM_MALLOC
18028 if (NILP (Vmemory_full
))
18031 return "!MEM FULL! ";
18038 /* %F displays the frame name. */
18039 if (!NILP (f
->title
))
18040 return (char *) SDATA (f
->title
);
18041 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18042 return (char *) SDATA (f
->name
);
18051 int size
= ZV
- BEGV
;
18052 pint2str (decode_mode_spec_buf
, field_width
, size
);
18053 return decode_mode_spec_buf
;
18058 int size
= ZV
- BEGV
;
18059 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18060 return decode_mode_spec_buf
;
18065 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18066 int topline
, nlines
, junk
, height
;
18068 /* %c and %l are ignored in `frame-title-format'. */
18069 if (mode_line_target
== MODE_LINE_TITLE
)
18072 startpos
= XMARKER (w
->start
)->charpos
;
18073 startpos_byte
= marker_byte_position (w
->start
);
18074 height
= WINDOW_TOTAL_LINES (w
);
18076 /* If we decided that this buffer isn't suitable for line numbers,
18077 don't forget that too fast. */
18078 if (EQ (w
->base_line_pos
, w
->buffer
))
18080 /* But do forget it, if the window shows a different buffer now. */
18081 else if (BUFFERP (w
->base_line_pos
))
18082 w
->base_line_pos
= Qnil
;
18084 /* If the buffer is very big, don't waste time. */
18085 if (INTEGERP (Vline_number_display_limit
)
18086 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18088 w
->base_line_pos
= Qnil
;
18089 w
->base_line_number
= Qnil
;
18093 if (INTEGERP (w
->base_line_number
)
18094 && INTEGERP (w
->base_line_pos
)
18095 && XFASTINT (w
->base_line_pos
) <= startpos
)
18097 line
= XFASTINT (w
->base_line_number
);
18098 linepos
= XFASTINT (w
->base_line_pos
);
18099 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18104 linepos
= BUF_BEGV (b
);
18105 linepos_byte
= BUF_BEGV_BYTE (b
);
18108 /* Count lines from base line to window start position. */
18109 nlines
= display_count_lines (linepos
, linepos_byte
,
18113 topline
= nlines
+ line
;
18115 /* Determine a new base line, if the old one is too close
18116 or too far away, or if we did not have one.
18117 "Too close" means it's plausible a scroll-down would
18118 go back past it. */
18119 if (startpos
== BUF_BEGV (b
))
18121 w
->base_line_number
= make_number (topline
);
18122 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18124 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18125 || linepos
== BUF_BEGV (b
))
18127 int limit
= BUF_BEGV (b
);
18128 int limit_byte
= BUF_BEGV_BYTE (b
);
18130 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18132 if (startpos
- distance
> limit
)
18134 limit
= startpos
- distance
;
18135 limit_byte
= CHAR_TO_BYTE (limit
);
18138 nlines
= display_count_lines (startpos
, startpos_byte
,
18140 - (height
* 2 + 30),
18142 /* If we couldn't find the lines we wanted within
18143 line_number_display_limit_width chars per line,
18144 give up on line numbers for this window. */
18145 if (position
== limit_byte
&& limit
== startpos
- distance
)
18147 w
->base_line_pos
= w
->buffer
;
18148 w
->base_line_number
= Qnil
;
18152 w
->base_line_number
= make_number (topline
- nlines
);
18153 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18156 /* Now count lines from the start pos to point. */
18157 nlines
= display_count_lines (startpos
, startpos_byte
,
18158 PT_BYTE
, PT
, &junk
);
18160 /* Record that we did display the line number. */
18161 line_number_displayed
= 1;
18163 /* Make the string to show. */
18164 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18165 return decode_mode_spec_buf
;
18168 char* p
= decode_mode_spec_buf
;
18169 int pad
= field_width
- 2;
18175 return decode_mode_spec_buf
;
18181 obj
= b
->mode_name
;
18185 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18191 int pos
= marker_position (w
->start
);
18192 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18194 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18196 if (pos
<= BUF_BEGV (b
))
18201 else if (pos
<= BUF_BEGV (b
))
18205 if (total
> 1000000)
18206 /* Do it differently for a large value, to avoid overflow. */
18207 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18209 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18210 /* We can't normally display a 3-digit number,
18211 so get us a 2-digit number that is close. */
18214 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18215 return decode_mode_spec_buf
;
18219 /* Display percentage of size above the bottom of the screen. */
18222 int toppos
= marker_position (w
->start
);
18223 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18224 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18226 if (botpos
>= BUF_ZV (b
))
18228 if (toppos
<= BUF_BEGV (b
))
18235 if (total
> 1000000)
18236 /* Do it differently for a large value, to avoid overflow. */
18237 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18239 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18240 /* We can't normally display a 3-digit number,
18241 so get us a 2-digit number that is close. */
18244 if (toppos
<= BUF_BEGV (b
))
18245 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18247 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18248 return decode_mode_spec_buf
;
18253 /* status of process */
18254 obj
= Fget_buffer_process (Fcurrent_buffer ());
18256 return "no process";
18257 #ifdef subprocesses
18258 obj
= Fsymbol_name (Fprocess_status (obj
));
18265 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18272 case 't': /* indicate TEXT or BINARY */
18273 #ifdef MODE_LINE_BINARY_TEXT
18274 return MODE_LINE_BINARY_TEXT (b
);
18280 /* coding-system (not including end-of-line format) */
18282 /* coding-system (including end-of-line type) */
18284 int eol_flag
= (c
== 'Z');
18285 char *p
= decode_mode_spec_buf
;
18287 if (! FRAME_WINDOW_P (f
))
18289 /* No need to mention EOL here--the terminal never needs
18290 to do EOL conversion. */
18291 p
= decode_mode_spec_coding (CODING_ID_NAME
18292 (FRAME_KEYBOARD_CODING (f
)->id
),
18294 p
= decode_mode_spec_coding (CODING_ID_NAME
18295 (FRAME_TERMINAL_CODING (f
)->id
),
18298 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18301 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18302 #ifdef subprocesses
18303 obj
= Fget_buffer_process (Fcurrent_buffer ());
18304 if (PROCESSP (obj
))
18306 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18308 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18311 #endif /* subprocesses */
18314 return decode_mode_spec_buf
;
18320 *multibyte
= STRING_MULTIBYTE (obj
);
18321 return (char *) SDATA (obj
);
18328 /* Count up to COUNT lines starting from START / START_BYTE.
18329 But don't go beyond LIMIT_BYTE.
18330 Return the number of lines thus found (always nonnegative).
18332 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18335 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18336 int start
, start_byte
, limit_byte
, count
;
18339 register unsigned char *cursor
;
18340 unsigned char *base
;
18342 register int ceiling
;
18343 register unsigned char *ceiling_addr
;
18344 int orig_count
= count
;
18346 /* If we are not in selective display mode,
18347 check only for newlines. */
18348 int selective_display
= (!NILP (current_buffer
->selective_display
)
18349 && !INTEGERP (current_buffer
->selective_display
));
18353 while (start_byte
< limit_byte
)
18355 ceiling
= BUFFER_CEILING_OF (start_byte
);
18356 ceiling
= min (limit_byte
- 1, ceiling
);
18357 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18358 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18361 if (selective_display
)
18362 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18365 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18368 if (cursor
!= ceiling_addr
)
18372 start_byte
+= cursor
- base
+ 1;
18373 *byte_pos_ptr
= start_byte
;
18377 if (++cursor
== ceiling_addr
)
18383 start_byte
+= cursor
- base
;
18388 while (start_byte
> limit_byte
)
18390 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18391 ceiling
= max (limit_byte
, ceiling
);
18392 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18393 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18396 if (selective_display
)
18397 while (--cursor
!= ceiling_addr
18398 && *cursor
!= '\n' && *cursor
!= 015)
18401 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18404 if (cursor
!= ceiling_addr
)
18408 start_byte
+= cursor
- base
+ 1;
18409 *byte_pos_ptr
= start_byte
;
18410 /* When scanning backwards, we should
18411 not count the newline posterior to which we stop. */
18412 return - orig_count
- 1;
18418 /* Here we add 1 to compensate for the last decrement
18419 of CURSOR, which took it past the valid range. */
18420 start_byte
+= cursor
- base
+ 1;
18424 *byte_pos_ptr
= limit_byte
;
18427 return - orig_count
+ count
;
18428 return orig_count
- count
;
18434 /***********************************************************************
18436 ***********************************************************************/
18438 /* Display a NUL-terminated string, starting with index START.
18440 If STRING is non-null, display that C string. Otherwise, the Lisp
18441 string LISP_STRING is displayed.
18443 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18444 FACE_STRING. Display STRING or LISP_STRING with the face at
18445 FACE_STRING_POS in FACE_STRING:
18447 Display the string in the environment given by IT, but use the
18448 standard display table, temporarily.
18450 FIELD_WIDTH is the minimum number of output glyphs to produce.
18451 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18452 with spaces. If STRING has more characters, more than FIELD_WIDTH
18453 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18455 PRECISION is the maximum number of characters to output from
18456 STRING. PRECISION < 0 means don't truncate the string.
18458 This is roughly equivalent to printf format specifiers:
18460 FIELD_WIDTH PRECISION PRINTF
18461 ----------------------------------------
18467 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18468 display them, and < 0 means obey the current buffer's value of
18469 enable_multibyte_characters.
18471 Value is the number of columns displayed. */
18474 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18475 start
, it
, field_width
, precision
, max_x
, multibyte
)
18476 unsigned char *string
;
18477 Lisp_Object lisp_string
;
18478 Lisp_Object face_string
;
18479 EMACS_INT face_string_pos
;
18482 int field_width
, precision
, max_x
;
18485 int hpos_at_start
= it
->hpos
;
18486 int saved_face_id
= it
->face_id
;
18487 struct glyph_row
*row
= it
->glyph_row
;
18489 /* Initialize the iterator IT for iteration over STRING beginning
18490 with index START. */
18491 reseat_to_string (it
, string
, lisp_string
, start
,
18492 precision
, field_width
, multibyte
);
18494 /* If displaying STRING, set up the face of the iterator
18495 from LISP_STRING, if that's given. */
18496 if (STRINGP (face_string
))
18502 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18503 0, it
->region_beg_charpos
,
18504 it
->region_end_charpos
,
18505 &endptr
, it
->base_face_id
, 0);
18506 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18507 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18510 /* Set max_x to the maximum allowed X position. Don't let it go
18511 beyond the right edge of the window. */
18513 max_x
= it
->last_visible_x
;
18515 max_x
= min (max_x
, it
->last_visible_x
);
18517 /* Skip over display elements that are not visible. because IT->w is
18519 if (it
->current_x
< it
->first_visible_x
)
18520 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18521 MOVE_TO_POS
| MOVE_TO_X
);
18523 row
->ascent
= it
->max_ascent
;
18524 row
->height
= it
->max_ascent
+ it
->max_descent
;
18525 row
->phys_ascent
= it
->max_phys_ascent
;
18526 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18527 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18529 /* This condition is for the case that we are called with current_x
18530 past last_visible_x. */
18531 while (it
->current_x
< max_x
)
18533 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18535 /* Get the next display element. */
18536 if (!get_next_display_element (it
))
18539 /* Produce glyphs. */
18540 x_before
= it
->current_x
;
18541 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18542 PRODUCE_GLYPHS (it
);
18544 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18547 while (i
< nglyphs
)
18549 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18551 if (!it
->truncate_lines_p
18552 && x
+ glyph
->pixel_width
> max_x
)
18554 /* End of continued line or max_x reached. */
18555 if (CHAR_GLYPH_PADDING_P (*glyph
))
18557 /* A wide character is unbreakable. */
18558 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18559 it
->current_x
= x_before
;
18563 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18568 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18570 /* Glyph is at least partially visible. */
18572 if (x
< it
->first_visible_x
)
18573 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18577 /* Glyph is off the left margin of the display area.
18578 Should not happen. */
18582 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18583 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18584 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18585 row
->phys_height
= max (row
->phys_height
,
18586 it
->max_phys_ascent
+ it
->max_phys_descent
);
18587 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18588 it
->max_extra_line_spacing
);
18589 x
+= glyph
->pixel_width
;
18593 /* Stop if max_x reached. */
18597 /* Stop at line ends. */
18598 if (ITERATOR_AT_END_OF_LINE_P (it
))
18600 it
->continuation_lines_width
= 0;
18604 set_iterator_to_next (it
, 1);
18606 /* Stop if truncating at the right edge. */
18607 if (it
->truncate_lines_p
18608 && it
->current_x
>= it
->last_visible_x
)
18610 /* Add truncation mark, but don't do it if the line is
18611 truncated at a padding space. */
18612 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18614 if (!FRAME_WINDOW_P (it
->f
))
18618 if (it
->current_x
> it
->last_visible_x
)
18620 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18621 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18623 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18625 row
->used
[TEXT_AREA
] = i
;
18626 produce_special_glyphs (it
, IT_TRUNCATION
);
18629 produce_special_glyphs (it
, IT_TRUNCATION
);
18631 it
->glyph_row
->truncated_on_right_p
= 1;
18637 /* Maybe insert a truncation at the left. */
18638 if (it
->first_visible_x
18639 && IT_CHARPOS (*it
) > 0)
18641 if (!FRAME_WINDOW_P (it
->f
))
18642 insert_left_trunc_glyphs (it
);
18643 it
->glyph_row
->truncated_on_left_p
= 1;
18646 it
->face_id
= saved_face_id
;
18648 /* Value is number of columns displayed. */
18649 return it
->hpos
- hpos_at_start
;
18654 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
18655 appears as an element of LIST or as the car of an element of LIST.
18656 If PROPVAL is a list, compare each element against LIST in that
18657 way, and return 1/2 if any element of PROPVAL is found in LIST.
18658 Otherwise return 0. This function cannot quit.
18659 The return value is 2 if the text is invisible but with an ellipsis
18660 and 1 if it's invisible and without an ellipsis. */
18663 invisible_p (propval
, list
)
18664 register Lisp_Object propval
;
18667 register Lisp_Object tail
, proptail
;
18669 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18671 register Lisp_Object tem
;
18673 if (EQ (propval
, tem
))
18675 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
18676 return NILP (XCDR (tem
)) ? 1 : 2;
18679 if (CONSP (propval
))
18681 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
18683 Lisp_Object propelt
;
18684 propelt
= XCAR (proptail
);
18685 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
18687 register Lisp_Object tem
;
18689 if (EQ (propelt
, tem
))
18691 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
18692 return NILP (XCDR (tem
)) ? 1 : 2;
18700 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
18701 doc
: /* Non-nil if the property makes the text invisible.
18702 POS-OR-PROP can be a marker or number, in which case it is taken to be
18703 a position in the current buffer and the value of the `invisible' property
18704 is checked; or it can be some other value, which is then presumed to be the
18705 value of the `invisible' property of the text of interest.
18706 The non-nil value returned can be t for truly invisible text or something
18707 else if the text is replaced by an ellipsis. */)
18709 Lisp_Object pos_or_prop
;
18712 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
18713 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
18715 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
18716 return (invis
== 0 ? Qnil
18718 : make_number (invis
));
18721 /* Calculate a width or height in pixels from a specification using
18722 the following elements:
18725 NUM - a (fractional) multiple of the default font width/height
18726 (NUM) - specifies exactly NUM pixels
18727 UNIT - a fixed number of pixels, see below.
18728 ELEMENT - size of a display element in pixels, see below.
18729 (NUM . SPEC) - equals NUM * SPEC
18730 (+ SPEC SPEC ...) - add pixel values
18731 (- SPEC SPEC ...) - subtract pixel values
18732 (- SPEC) - negate pixel value
18735 INT or FLOAT - a number constant
18736 SYMBOL - use symbol's (buffer local) variable binding.
18739 in - pixels per inch *)
18740 mm - pixels per 1/1000 meter *)
18741 cm - pixels per 1/100 meter *)
18742 width - width of current font in pixels.
18743 height - height of current font in pixels.
18745 *) using the ratio(s) defined in display-pixels-per-inch.
18749 left-fringe - left fringe width in pixels
18750 right-fringe - right fringe width in pixels
18752 left-margin - left margin width in pixels
18753 right-margin - right margin width in pixels
18755 scroll-bar - scroll-bar area width in pixels
18759 Pixels corresponding to 5 inches:
18762 Total width of non-text areas on left side of window (if scroll-bar is on left):
18763 '(space :width (+ left-fringe left-margin scroll-bar))
18765 Align to first text column (in header line):
18766 '(space :align-to 0)
18768 Align to middle of text area minus half the width of variable `my-image'
18769 containing a loaded image:
18770 '(space :align-to (0.5 . (- text my-image)))
18772 Width of left margin minus width of 1 character in the default font:
18773 '(space :width (- left-margin 1))
18775 Width of left margin minus width of 2 characters in the current font:
18776 '(space :width (- left-margin (2 . width)))
18778 Center 1 character over left-margin (in header line):
18779 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
18781 Different ways to express width of left fringe plus left margin minus one pixel:
18782 '(space :width (- (+ left-fringe left-margin) (1)))
18783 '(space :width (+ left-fringe left-margin (- (1))))
18784 '(space :width (+ left-fringe left-margin (-1)))
18788 #define NUMVAL(X) \
18789 ((INTEGERP (X) || FLOATP (X)) \
18794 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
18799 int width_p
, *align_to
;
18803 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
18804 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
18807 return OK_PIXELS (0);
18809 xassert (FRAME_LIVE_P (it
->f
));
18811 if (SYMBOLP (prop
))
18813 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
18815 char *unit
= SDATA (SYMBOL_NAME (prop
));
18817 if (unit
[0] == 'i' && unit
[1] == 'n')
18819 else if (unit
[0] == 'm' && unit
[1] == 'm')
18821 else if (unit
[0] == 'c' && unit
[1] == 'm')
18828 #ifdef HAVE_WINDOW_SYSTEM
18829 if (FRAME_WINDOW_P (it
->f
)
18831 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
18832 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
18834 return OK_PIXELS (ppi
/ pixels
);
18837 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
18838 || (CONSP (Vdisplay_pixels_per_inch
)
18840 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
18841 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
18843 return OK_PIXELS (ppi
/ pixels
);
18849 #ifdef HAVE_WINDOW_SYSTEM
18850 if (EQ (prop
, Qheight
))
18851 return OK_PIXELS (font
? FONT_HEIGHT ((XFontStruct
*)font
) : FRAME_LINE_HEIGHT (it
->f
));
18852 if (EQ (prop
, Qwidth
))
18853 return OK_PIXELS (font
? FONT_WIDTH ((XFontStruct
*)font
) : FRAME_COLUMN_WIDTH (it
->f
));
18855 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
18856 return OK_PIXELS (1);
18859 if (EQ (prop
, Qtext
))
18860 return OK_PIXELS (width_p
18861 ? window_box_width (it
->w
, TEXT_AREA
)
18862 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
18864 if (align_to
&& *align_to
< 0)
18867 if (EQ (prop
, Qleft
))
18868 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
18869 if (EQ (prop
, Qright
))
18870 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
18871 if (EQ (prop
, Qcenter
))
18872 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
18873 + window_box_width (it
->w
, TEXT_AREA
) / 2);
18874 if (EQ (prop
, Qleft_fringe
))
18875 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18876 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
18877 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
18878 if (EQ (prop
, Qright_fringe
))
18879 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18880 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18881 : window_box_right_offset (it
->w
, TEXT_AREA
));
18882 if (EQ (prop
, Qleft_margin
))
18883 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
18884 if (EQ (prop
, Qright_margin
))
18885 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
18886 if (EQ (prop
, Qscroll_bar
))
18887 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
18889 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
18890 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
18891 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
18896 if (EQ (prop
, Qleft_fringe
))
18897 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
18898 if (EQ (prop
, Qright_fringe
))
18899 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
18900 if (EQ (prop
, Qleft_margin
))
18901 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
18902 if (EQ (prop
, Qright_margin
))
18903 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
18904 if (EQ (prop
, Qscroll_bar
))
18905 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
18908 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
18911 if (INTEGERP (prop
) || FLOATP (prop
))
18913 int base_unit
= (width_p
18914 ? FRAME_COLUMN_WIDTH (it
->f
)
18915 : FRAME_LINE_HEIGHT (it
->f
));
18916 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
18921 Lisp_Object car
= XCAR (prop
);
18922 Lisp_Object cdr
= XCDR (prop
);
18926 #ifdef HAVE_WINDOW_SYSTEM
18927 if (FRAME_WINDOW_P (it
->f
)
18928 && valid_image_p (prop
))
18930 int id
= lookup_image (it
->f
, prop
);
18931 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
18933 return OK_PIXELS (width_p
? img
->width
: img
->height
);
18936 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
18942 while (CONSP (cdr
))
18944 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
18945 font
, width_p
, align_to
))
18948 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
18953 if (EQ (car
, Qminus
))
18955 return OK_PIXELS (pixels
);
18958 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
18961 if (INTEGERP (car
) || FLOATP (car
))
18964 pixels
= XFLOATINT (car
);
18966 return OK_PIXELS (pixels
);
18967 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
18968 font
, width_p
, align_to
))
18969 return OK_PIXELS (pixels
* fact
);
18980 /***********************************************************************
18982 ***********************************************************************/
18984 #ifdef HAVE_WINDOW_SYSTEM
18989 dump_glyph_string (s
)
18990 struct glyph_string
*s
;
18992 fprintf (stderr
, "glyph string\n");
18993 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
18994 s
->x
, s
->y
, s
->width
, s
->height
);
18995 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
18996 fprintf (stderr
, " hl = %d\n", s
->hl
);
18997 fprintf (stderr
, " left overhang = %d, right = %d\n",
18998 s
->left_overhang
, s
->right_overhang
);
18999 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19000 fprintf (stderr
, " extends to end of line = %d\n",
19001 s
->extends_to_end_of_line_p
);
19002 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19003 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19006 #endif /* GLYPH_DEBUG */
19008 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19009 of XChar2b structures for S; it can't be allocated in
19010 init_glyph_string because it must be allocated via `alloca'. W
19011 is the window on which S is drawn. ROW and AREA are the glyph row
19012 and area within the row from which S is constructed. START is the
19013 index of the first glyph structure covered by S. HL is a
19014 face-override for drawing S. */
19017 #define OPTIONAL_HDC(hdc) hdc,
19018 #define DECLARE_HDC(hdc) HDC hdc;
19019 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19020 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19023 #ifndef OPTIONAL_HDC
19024 #define OPTIONAL_HDC(hdc)
19025 #define DECLARE_HDC(hdc)
19026 #define ALLOCATE_HDC(hdc, f)
19027 #define RELEASE_HDC(hdc, f)
19031 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19032 struct glyph_string
*s
;
19036 struct glyph_row
*row
;
19037 enum glyph_row_area area
;
19039 enum draw_glyphs_face hl
;
19041 bzero (s
, sizeof *s
);
19043 s
->f
= XFRAME (w
->frame
);
19047 s
->display
= FRAME_X_DISPLAY (s
->f
);
19048 s
->window
= FRAME_X_WINDOW (s
->f
);
19049 s
->char2b
= char2b
;
19053 s
->first_glyph
= row
->glyphs
[area
] + start
;
19054 s
->height
= row
->height
;
19055 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19057 /* Display the internal border below the tool-bar window. */
19058 if (WINDOWP (s
->f
->tool_bar_window
)
19059 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19060 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19062 s
->ybase
= s
->y
+ row
->ascent
;
19066 /* Append the list of glyph strings with head H and tail T to the list
19067 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19070 append_glyph_string_lists (head
, tail
, h
, t
)
19071 struct glyph_string
**head
, **tail
;
19072 struct glyph_string
*h
, *t
;
19086 /* Prepend the list of glyph strings with head H and tail T to the
19087 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19091 prepend_glyph_string_lists (head
, tail
, h
, t
)
19092 struct glyph_string
**head
, **tail
;
19093 struct glyph_string
*h
, *t
;
19107 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19108 Set *HEAD and *TAIL to the resulting list. */
19111 append_glyph_string (head
, tail
, s
)
19112 struct glyph_string
**head
, **tail
;
19113 struct glyph_string
*s
;
19115 s
->next
= s
->prev
= NULL
;
19116 append_glyph_string_lists (head
, tail
, s
, s
);
19120 /* Get face and two-byte form of character C in face FACE_ID on frame
19121 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19122 means we want to display multibyte text. DISPLAY_P non-zero means
19123 make sure that X resources for the face returned are allocated.
19124 Value is a pointer to a realized face that is ready for display if
19125 DISPLAY_P is non-zero. */
19127 static INLINE
struct face
*
19128 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19132 int multibyte_p
, display_p
;
19134 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19136 #ifdef USE_FONT_BACKEND
19137 if (enable_font_backend
)
19139 struct font
*font
= (struct font
*) face
->font_info
;
19143 unsigned code
= font
->driver
->encode_char (font
, c
);
19145 if (code
!= FONT_INVALID_CODE
)
19146 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19148 STORE_XCHAR2B (char2b
, 0, 0);
19152 #endif /* USE_FONT_BACKEND */
19155 /* Unibyte case. We don't have to encode, but we have to make
19156 sure to use a face suitable for unibyte. */
19157 STORE_XCHAR2B (char2b
, 0, c
);
19158 face_id
= FACE_FOR_CHAR (f
, face
, c
, -1, Qnil
);
19159 face
= FACE_FROM_ID (f
, face_id
);
19163 /* Case of ASCII in a face known to fit ASCII. */
19164 STORE_XCHAR2B (char2b
, 0, c
);
19166 else if (face
->font
!= NULL
)
19168 struct font_info
*font_info
19169 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19170 struct charset
*charset
= CHARSET_FROM_ID (font_info
->charset
);
19171 unsigned code
= ENCODE_CHAR (charset
, c
);
19173 if (CHARSET_DIMENSION (charset
) == 1)
19174 STORE_XCHAR2B (char2b
, 0, code
);
19176 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19177 /* Maybe encode the character in *CHAR2B. */
19178 FRAME_RIF (f
)->encode_char (c
, char2b
, font_info
, charset
, NULL
);
19181 /* Make sure X resources of the face are allocated. */
19182 #ifdef HAVE_X_WINDOWS
19186 xassert (face
!= NULL
);
19187 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19194 /* Get face and two-byte form of character glyph GLYPH on frame F.
19195 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19196 a pointer to a realized face that is ready for display. */
19198 static INLINE
struct face
*
19199 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19201 struct glyph
*glyph
;
19207 xassert (glyph
->type
== CHAR_GLYPH
);
19208 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19213 #ifdef USE_FONT_BACKEND
19214 if (enable_font_backend
)
19216 struct font
*font
= (struct font
*) face
->font_info
;
19220 unsigned code
= font
->driver
->encode_char (font
, glyph
->u
.ch
);
19222 if (code
!= FONT_INVALID_CODE
)
19223 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19225 STORE_XCHAR2B (char2b
, 0, code
);
19229 #endif /* USE_FONT_BACKEND */
19230 if (!glyph
->multibyte_p
)
19232 /* Unibyte case. We don't have to encode, but we have to make
19233 sure to use a face suitable for unibyte. */
19234 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
19236 else if (glyph
->u
.ch
< 128)
19238 /* Case of ASCII in a face known to fit ASCII. */
19239 STORE_XCHAR2B (char2b
, 0, glyph
->u
.ch
);
19243 struct font_info
*font_info
19244 = FONT_INFO_FROM_ID (f
, face
->font_info_id
);
19247 struct charset
*charset
= CHARSET_FROM_ID (font_info
->charset
);
19248 unsigned code
= ENCODE_CHAR (charset
, glyph
->u
.ch
);
19250 if (CHARSET_DIMENSION (charset
) == 1)
19251 STORE_XCHAR2B (char2b
, 0, code
);
19253 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19255 /* Maybe encode the character in *CHAR2B. */
19256 if (CHARSET_ID (charset
) != charset_ascii
)
19259 = FRAME_RIF (f
)->encode_char (glyph
->u
.ch
, char2b
, font_info
,
19260 charset
, two_byte_p
);
19265 /* Make sure X resources of the face are allocated. */
19266 xassert (face
!= NULL
);
19267 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19272 /* Fill glyph string S with composition components specified by S->cmp.
19274 BASE_FACE is the base face of the composition.
19275 S->gidx is the index of the first component for S.
19277 OVERLAPS non-zero means S should draw the foreground only, and use
19278 its physical height for clipping. See also draw_glyphs.
19280 Value is the index of a component not in S. */
19283 fill_composite_glyph_string (s
, base_face
, overlaps
)
19284 struct glyph_string
*s
;
19285 struct face
*base_face
;
19292 s
->for_overlaps
= overlaps
;
19294 #ifdef USE_FONT_BACKEND
19295 if (enable_font_backend
&& s
->cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
19297 Lisp_Object gstring
19298 = AREF (XHASH_TABLE (composition_hash_table
)->key_and_value
,
19299 s
->cmp
->hash_index
* 2);
19301 s
->face
= base_face
;
19302 s
->font_info
= base_face
->font_info
;
19303 s
->font
= s
->font_info
->font
;
19304 for (i
= 0, s
->nchars
= 0; i
< s
->cmp
->glyph_len
; i
++, s
->nchars
++)
19306 Lisp_Object g
= LGSTRING_GLYPH (gstring
, i
);
19308 XChar2b
* store_pos
;
19311 code
= LGLYPH_CODE (g
);
19312 store_pos
= s
->char2b
+ i
;
19313 STORE_XCHAR2B (store_pos
, code
>> 8, code
& 0xFF);
19315 s
->width
= s
->cmp
->pixel_width
;
19318 #endif /* USE_FONT_BACKEND */
19320 /* For all glyphs of this composition, starting at the offset
19321 S->gidx, until we reach the end of the definition or encounter a
19322 glyph that requires the different face, add it to S. */
19327 s
->font_info
= NULL
;
19328 for (i
= s
->gidx
; i
< s
->cmp
->glyph_len
; i
++)
19330 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19334 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19337 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19338 s
->char2b
+ i
, 1, 1);
19344 s
->font
= s
->face
->font
;
19345 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19347 else if (s
->face
!= face
)
19354 /* All glyph strings for the same composition has the same width,
19355 i.e. the width set for the first component of the composition. */
19356 s
->width
= s
->first_glyph
->pixel_width
;
19359 /* If the specified font could not be loaded, use the frame's
19360 default font, but record the fact that we couldn't load it in
19361 the glyph string so that we can draw rectangles for the
19362 characters of the glyph string. */
19363 if (s
->font
== NULL
)
19365 s
->font_not_found_p
= 1;
19366 s
->font
= FRAME_FONT (s
->f
);
19369 /* Adjust base line for subscript/superscript text. */
19370 s
->ybase
+= s
->first_glyph
->voffset
;
19372 /* This glyph string must always be drawn with 16-bit functions. */
19375 return s
->gidx
+ s
->nchars
;
19379 /* Fill glyph string S from a sequence of character glyphs.
19381 FACE_ID is the face id of the string. START is the index of the
19382 first glyph to consider, END is the index of the last + 1.
19383 OVERLAPS non-zero means S should draw the foreground only, and use
19384 its physical height for clipping. See also draw_glyphs.
19386 Value is the index of the first glyph not in S. */
19389 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19390 struct glyph_string
*s
;
19392 int start
, end
, overlaps
;
19394 struct glyph
*glyph
, *last
;
19396 int glyph_not_available_p
;
19398 xassert (s
->f
== XFRAME (s
->w
->frame
));
19399 xassert (s
->nchars
== 0);
19400 xassert (start
>= 0 && end
> start
);
19402 s
->for_overlaps
= overlaps
,
19403 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19404 last
= s
->row
->glyphs
[s
->area
] + end
;
19405 voffset
= glyph
->voffset
;
19406 s
->padding_p
= glyph
->padding_p
;
19407 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19409 while (glyph
< last
19410 && glyph
->type
== CHAR_GLYPH
19411 && glyph
->voffset
== voffset
19412 /* Same face id implies same font, nowadays. */
19413 && glyph
->face_id
== face_id
19414 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19418 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19419 s
->char2b
+ s
->nchars
,
19421 s
->two_byte_p
= two_byte_p
;
19423 xassert (s
->nchars
<= end
- start
);
19424 s
->width
+= glyph
->pixel_width
;
19425 if (glyph
++->padding_p
!= s
->padding_p
)
19429 s
->font
= s
->face
->font
;
19430 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19432 /* If the specified font could not be loaded, use the frame's font,
19433 but record the fact that we couldn't load it in
19434 S->font_not_found_p so that we can draw rectangles for the
19435 characters of the glyph string. */
19436 if (s
->font
== NULL
|| glyph_not_available_p
)
19438 s
->font_not_found_p
= 1;
19439 s
->font
= FRAME_FONT (s
->f
);
19442 /* Adjust base line for subscript/superscript text. */
19443 s
->ybase
+= voffset
;
19445 xassert (s
->face
&& s
->face
->gc
);
19446 return glyph
- s
->row
->glyphs
[s
->area
];
19450 /* Fill glyph string S from image glyph S->first_glyph. */
19453 fill_image_glyph_string (s
)
19454 struct glyph_string
*s
;
19456 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19457 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19459 s
->slice
= s
->first_glyph
->slice
;
19460 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19461 s
->font
= s
->face
->font
;
19462 s
->width
= s
->first_glyph
->pixel_width
;
19464 /* Adjust base line for subscript/superscript text. */
19465 s
->ybase
+= s
->first_glyph
->voffset
;
19469 /* Fill glyph string S from a sequence of stretch glyphs.
19471 ROW is the glyph row in which the glyphs are found, AREA is the
19472 area within the row. START is the index of the first glyph to
19473 consider, END is the index of the last + 1.
19475 Value is the index of the first glyph not in S. */
19478 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19479 struct glyph_string
*s
;
19480 struct glyph_row
*row
;
19481 enum glyph_row_area area
;
19484 struct glyph
*glyph
, *last
;
19485 int voffset
, face_id
;
19487 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19489 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19490 last
= s
->row
->glyphs
[s
->area
] + end
;
19491 face_id
= glyph
->face_id
;
19492 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19493 s
->font
= s
->face
->font
;
19494 s
->font_info
= FONT_INFO_FROM_FACE (s
->f
, s
->face
);
19495 s
->width
= glyph
->pixel_width
;
19497 voffset
= glyph
->voffset
;
19501 && glyph
->type
== STRETCH_GLYPH
19502 && glyph
->voffset
== voffset
19503 && glyph
->face_id
== face_id
);
19505 s
->width
+= glyph
->pixel_width
;
19507 /* Adjust base line for subscript/superscript text. */
19508 s
->ybase
+= voffset
;
19510 /* The case that face->gc == 0 is handled when drawing the glyph
19511 string by calling PREPARE_FACE_FOR_DISPLAY. */
19513 return glyph
- s
->row
->glyphs
[s
->area
];
19516 static XCharStruct
*
19517 get_per_char_metric (f
, font
, font_info
, char2b
, font_type
)
19520 struct font_info
*font_info
;
19524 #ifdef USE_FONT_BACKEND
19525 if (enable_font_backend
)
19527 static XCharStruct pcm_value
;
19528 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19529 struct font
*fontp
;
19530 struct font_metrics metrics
;
19532 if (! font_info
|| code
== FONT_INVALID_CODE
)
19534 fontp
= (struct font
*) font_info
;
19535 fontp
->driver
->text_extents (fontp
, &code
, 1, &metrics
);
19536 pcm_value
.lbearing
= metrics
.lbearing
;
19537 pcm_value
.rbearing
= metrics
.rbearing
;
19538 pcm_value
.ascent
= metrics
.ascent
;
19539 pcm_value
.descent
= metrics
.descent
;
19540 pcm_value
.width
= metrics
.width
;
19543 #endif /* USE_FONT_BACKEND */
19544 return FRAME_RIF (f
)->per_char_metric (font
, char2b
, font_type
);
19548 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19549 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19550 assumed to be zero. */
19553 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19554 struct glyph
*glyph
;
19558 *left
= *right
= 0;
19560 if (glyph
->type
== CHAR_GLYPH
)
19564 struct font_info
*font_info
;
19568 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19570 font_info
= FONT_INFO_FROM_FACE (f
, face
);
19571 if (font
/* ++KFS: Should this be font_info ? */
19572 && (pcm
= get_per_char_metric (f
, font
, font_info
, &char2b
, glyph
->font_type
)))
19574 if (pcm
->rbearing
> pcm
->width
)
19575 *right
= pcm
->rbearing
- pcm
->width
;
19576 if (pcm
->lbearing
< 0)
19577 *left
= -pcm
->lbearing
;
19580 else if (glyph
->type
== COMPOSITE_GLYPH
)
19582 struct composition
*cmp
= composition_table
[glyph
->u
.cmp_id
];
19584 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19585 *left
= - cmp
->lbearing
;
19590 /* Return the index of the first glyph preceding glyph string S that
19591 is overwritten by S because of S's left overhang. Value is -1
19592 if no glyphs are overwritten. */
19595 left_overwritten (s
)
19596 struct glyph_string
*s
;
19600 if (s
->left_overhang
)
19603 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19604 int first
= s
->first_glyph
- glyphs
;
19606 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19607 x
-= glyphs
[i
].pixel_width
;
19618 /* Return the index of the first glyph preceding glyph string S that
19619 is overwriting S because of its right overhang. Value is -1 if no
19620 glyph in front of S overwrites S. */
19623 left_overwriting (s
)
19624 struct glyph_string
*s
;
19627 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19628 int first
= s
->first_glyph
- glyphs
;
19632 for (i
= first
- 1; i
>= 0; --i
)
19635 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19638 x
-= glyphs
[i
].pixel_width
;
19645 /* Return the index of the last glyph following glyph string S that is
19646 not overwritten by S because of S's right overhang. Value is -1 if
19647 no such glyph is found. */
19650 right_overwritten (s
)
19651 struct glyph_string
*s
;
19655 if (s
->right_overhang
)
19658 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19659 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19660 int end
= s
->row
->used
[s
->area
];
19662 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19663 x
+= glyphs
[i
].pixel_width
;
19672 /* Return the index of the last glyph following glyph string S that
19673 overwrites S because of its left overhang. Value is negative
19674 if no such glyph is found. */
19677 right_overwriting (s
)
19678 struct glyph_string
*s
;
19681 int end
= s
->row
->used
[s
->area
];
19682 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19683 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19687 for (i
= first
; i
< end
; ++i
)
19690 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19693 x
+= glyphs
[i
].pixel_width
;
19700 /* Set background width of glyph string S. START is the index of the
19701 first glyph following S. LAST_X is the right-most x-position + 1
19702 in the drawing area. */
19705 set_glyph_string_background_width (s
, start
, last_x
)
19706 struct glyph_string
*s
;
19710 /* If the face of this glyph string has to be drawn to the end of
19711 the drawing area, set S->extends_to_end_of_line_p. */
19713 if (start
== s
->row
->used
[s
->area
]
19714 && s
->area
== TEXT_AREA
19715 && ((s
->row
->fill_line_p
19716 && (s
->hl
== DRAW_NORMAL_TEXT
19717 || s
->hl
== DRAW_IMAGE_RAISED
19718 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19719 || s
->hl
== DRAW_MOUSE_FACE
))
19720 s
->extends_to_end_of_line_p
= 1;
19722 /* If S extends its face to the end of the line, set its
19723 background_width to the distance to the right edge of the drawing
19725 if (s
->extends_to_end_of_line_p
)
19726 s
->background_width
= last_x
- s
->x
+ 1;
19728 s
->background_width
= s
->width
;
19732 /* Compute overhangs and x-positions for glyph string S and its
19733 predecessors, or successors. X is the starting x-position for S.
19734 BACKWARD_P non-zero means process predecessors. */
19737 compute_overhangs_and_x (s
, x
, backward_p
)
19738 struct glyph_string
*s
;
19746 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19747 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19757 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
19758 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
19768 /* The following macros are only called from draw_glyphs below.
19769 They reference the following parameters of that function directly:
19770 `w', `row', `area', and `overlap_p'
19771 as well as the following local variables:
19772 `s', `f', and `hdc' (in W32) */
19775 /* On W32, silently add local `hdc' variable to argument list of
19776 init_glyph_string. */
19777 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19778 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
19780 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
19781 init_glyph_string (s, char2b, w, row, area, start, hl)
19784 /* Add a glyph string for a stretch glyph to the list of strings
19785 between HEAD and TAIL. START is the index of the stretch glyph in
19786 row area AREA of glyph row ROW. END is the index of the last glyph
19787 in that glyph row area. X is the current output position assigned
19788 to the new glyph string constructed. HL overrides that face of the
19789 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19790 is the right-most x-position of the drawing area. */
19792 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
19793 and below -- keep them on one line. */
19794 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19797 s = (struct glyph_string *) alloca (sizeof *s); \
19798 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19799 START = fill_stretch_glyph_string (s, row, area, START, END); \
19800 append_glyph_string (&HEAD, &TAIL, s); \
19806 /* Add a glyph string for an image glyph to the list of strings
19807 between HEAD and TAIL. START is the index of the image glyph in
19808 row area AREA of glyph row ROW. END is the index of the last glyph
19809 in that glyph row area. X is the current output position assigned
19810 to the new glyph string constructed. HL overrides that face of the
19811 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
19812 is the right-most x-position of the drawing area. */
19814 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19817 s = (struct glyph_string *) alloca (sizeof *s); \
19818 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
19819 fill_image_glyph_string (s); \
19820 append_glyph_string (&HEAD, &TAIL, s); \
19827 /* Add a glyph string for a sequence of character glyphs to the list
19828 of strings between HEAD and TAIL. START is the index of the first
19829 glyph in row area AREA of glyph row ROW that is part of the new
19830 glyph string. END is the index of the last glyph in that glyph row
19831 area. X is the current output position assigned to the new glyph
19832 string constructed. HL overrides that face of the glyph; e.g. it
19833 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
19834 right-most x-position of the drawing area. */
19836 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19842 face_id = (row)->glyphs[area][START].face_id; \
19844 s = (struct glyph_string *) alloca (sizeof *s); \
19845 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
19846 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19847 append_glyph_string (&HEAD, &TAIL, s); \
19849 START = fill_glyph_string (s, face_id, START, END, overlaps); \
19854 /* Add a glyph string for a composite sequence to the list of strings
19855 between HEAD and TAIL. START is the index of the first glyph in
19856 row area AREA of glyph row ROW that is part of the new glyph
19857 string. END is the index of the last glyph in that glyph row area.
19858 X is the current output position assigned to the new glyph string
19859 constructed. HL overrides that face of the glyph; e.g. it is
19860 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
19861 x-position of the drawing area. */
19863 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
19865 int face_id = (row)->glyphs[area][START].face_id; \
19866 struct face *base_face = FACE_FROM_ID (f, face_id); \
19867 int cmp_id = (row)->glyphs[area][START].u.cmp_id; \
19868 struct composition *cmp = composition_table[cmp_id]; \
19870 struct glyph_string *first_s; \
19873 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
19875 /* Make glyph_strings for each glyph sequence that is drawable by \
19876 the same face, and append them to HEAD/TAIL. */ \
19877 for (n = 0; n < cmp->glyph_len;) \
19879 s = (struct glyph_string *) alloca (sizeof *s); \
19880 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
19881 append_glyph_string (&(HEAD), &(TAIL), s); \
19887 n = fill_composite_glyph_string (s, base_face, overlaps); \
19895 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
19896 of AREA of glyph row ROW on window W between indices START and END.
19897 HL overrides the face for drawing glyph strings, e.g. it is
19898 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
19899 x-positions of the drawing area.
19901 This is an ugly monster macro construct because we must use alloca
19902 to allocate glyph strings (because draw_glyphs can be called
19903 asynchronously). */
19905 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
19908 HEAD = TAIL = NULL; \
19909 while (START < END) \
19911 struct glyph *first_glyph = (row)->glyphs[area] + START; \
19912 switch (first_glyph->type) \
19915 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
19919 case COMPOSITE_GLYPH: \
19920 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
19924 case STRETCH_GLYPH: \
19925 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
19929 case IMAGE_GLYPH: \
19930 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
19940 set_glyph_string_background_width (s, START, LAST_X); \
19948 /* Draw glyphs between START and END in AREA of ROW on window W,
19949 starting at x-position X. X is relative to AREA in W. HL is a
19950 face-override with the following meaning:
19952 DRAW_NORMAL_TEXT draw normally
19953 DRAW_CURSOR draw in cursor face
19954 DRAW_MOUSE_FACE draw in mouse face.
19955 DRAW_INVERSE_VIDEO draw in mode line face
19956 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
19957 DRAW_IMAGE_RAISED draw an image with a raised relief around it
19959 If OVERLAPS is non-zero, draw only the foreground of characters and
19960 clip to the physical height of ROW. Non-zero value also defines
19961 the overlapping part to be drawn:
19963 OVERLAPS_PRED overlap with preceding rows
19964 OVERLAPS_SUCC overlap with succeeding rows
19965 OVERLAPS_BOTH overlap with both preceding/succeeding rows
19966 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
19968 Value is the x-position reached, relative to AREA of W. */
19971 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
19974 struct glyph_row
*row
;
19975 enum glyph_row_area area
;
19976 EMACS_INT start
, end
;
19977 enum draw_glyphs_face hl
;
19980 struct glyph_string
*head
, *tail
;
19981 struct glyph_string
*s
;
19982 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
19983 int last_x
, area_width
;
19986 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19989 ALLOCATE_HDC (hdc
, f
);
19991 /* Let's rather be paranoid than getting a SEGV. */
19992 end
= min (end
, row
->used
[area
]);
19993 start
= max (0, start
);
19994 start
= min (end
, start
);
19996 /* Translate X to frame coordinates. Set last_x to the right
19997 end of the drawing area. */
19998 if (row
->full_width_p
)
20000 /* X is relative to the left edge of W, without scroll bars
20002 x
+= WINDOW_LEFT_EDGE_X (w
);
20003 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20007 int area_left
= window_box_left (w
, area
);
20009 area_width
= window_box_width (w
, area
);
20010 last_x
= area_left
+ area_width
;
20013 /* Build a doubly-linked list of glyph_string structures between
20014 head and tail from what we have to draw. Note that the macro
20015 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20016 the reason we use a separate variable `i'. */
20018 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20020 x_reached
= tail
->x
+ tail
->background_width
;
20024 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20025 the row, redraw some glyphs in front or following the glyph
20026 strings built above. */
20027 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20030 struct glyph_string
*h
, *t
;
20032 /* Compute overhangs for all glyph strings. */
20033 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20034 for (s
= head
; s
; s
= s
->next
)
20035 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20037 /* Prepend glyph strings for glyphs in front of the first glyph
20038 string that are overwritten because of the first glyph
20039 string's left overhang. The background of all strings
20040 prepended must be drawn because the first glyph string
20042 i
= left_overwritten (head
);
20046 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20047 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
20049 compute_overhangs_and_x (t
, head
->x
, 1);
20050 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20054 /* Prepend glyph strings for glyphs in front of the first glyph
20055 string that overwrite that glyph string because of their
20056 right overhang. For these strings, only the foreground must
20057 be drawn, because it draws over the glyph string at `head'.
20058 The background must not be drawn because this would overwrite
20059 right overhangs of preceding glyphs for which no glyph
20061 i
= left_overwriting (head
);
20065 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20066 DRAW_NORMAL_TEXT
, dummy_x
, last_x
);
20067 for (s
= h
; s
; s
= s
->next
)
20068 s
->background_filled_p
= 1;
20069 compute_overhangs_and_x (t
, head
->x
, 1);
20070 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20073 /* Append glyphs strings for glyphs following the last glyph
20074 string tail that are overwritten by tail. The background of
20075 these strings has to be drawn because tail's foreground draws
20077 i
= right_overwritten (tail
);
20080 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20081 DRAW_NORMAL_TEXT
, x
, last_x
);
20082 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20083 append_glyph_string_lists (&head
, &tail
, h
, t
);
20087 /* Append glyph strings for glyphs following the last glyph
20088 string tail that overwrite tail. The foreground of such
20089 glyphs has to be drawn because it writes into the background
20090 of tail. The background must not be drawn because it could
20091 paint over the foreground of following glyphs. */
20092 i
= right_overwriting (tail
);
20096 i
++; /* We must include the Ith glyph. */
20097 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20098 DRAW_NORMAL_TEXT
, x
, last_x
);
20099 for (s
= h
; s
; s
= s
->next
)
20100 s
->background_filled_p
= 1;
20101 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20102 append_glyph_string_lists (&head
, &tail
, h
, t
);
20104 if (clip_head
|| clip_tail
)
20105 for (s
= head
; s
; s
= s
->next
)
20107 s
->clip_head
= clip_head
;
20108 s
->clip_tail
= clip_tail
;
20112 /* Draw all strings. */
20113 for (s
= head
; s
; s
= s
->next
)
20114 FRAME_RIF (f
)->draw_glyph_string (s
);
20116 if (area
== TEXT_AREA
20117 && !row
->full_width_p
20118 /* When drawing overlapping rows, only the glyph strings'
20119 foreground is drawn, which doesn't erase a cursor
20123 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20124 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20125 : (tail
? tail
->x
+ tail
->background_width
: x
));
20127 int text_left
= window_box_left (w
, TEXT_AREA
);
20131 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20132 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20135 /* Value is the x-position up to which drawn, relative to AREA of W.
20136 This doesn't include parts drawn because of overhangs. */
20137 if (row
->full_width_p
)
20138 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20140 x_reached
-= window_box_left (w
, area
);
20142 RELEASE_HDC (hdc
, f
);
20147 /* Expand row matrix if too narrow. Don't expand if area
20150 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20152 if (!fonts_changed_p \
20153 && (it->glyph_row->glyphs[area] \
20154 < it->glyph_row->glyphs[area + 1])) \
20156 it->w->ncols_scale_factor++; \
20157 fonts_changed_p = 1; \
20161 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20162 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20168 struct glyph
*glyph
;
20169 enum glyph_row_area area
= it
->area
;
20171 xassert (it
->glyph_row
);
20172 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20174 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20175 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20177 glyph
->charpos
= CHARPOS (it
->position
);
20178 glyph
->object
= it
->object
;
20179 if (it
->pixel_width
> 0)
20181 glyph
->pixel_width
= it
->pixel_width
;
20182 glyph
->padding_p
= 0;
20186 /* Assure at least 1-pixel width. Otherwise, cursor can't
20187 be displayed correctly. */
20188 glyph
->pixel_width
= 1;
20189 glyph
->padding_p
= 1;
20191 glyph
->ascent
= it
->ascent
;
20192 glyph
->descent
= it
->descent
;
20193 glyph
->voffset
= it
->voffset
;
20194 glyph
->type
= CHAR_GLYPH
;
20195 glyph
->multibyte_p
= it
->multibyte_p
;
20196 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20197 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20198 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20199 || it
->phys_descent
> it
->descent
);
20200 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20201 glyph
->face_id
= it
->face_id
;
20202 glyph
->u
.ch
= it
->char_to_display
;
20203 glyph
->slice
= null_glyph_slice
;
20204 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20205 ++it
->glyph_row
->used
[area
];
20208 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20211 /* Store one glyph for the composition IT->cmp_id in IT->glyph_row.
20212 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20215 append_composite_glyph (it
)
20218 struct glyph
*glyph
;
20219 enum glyph_row_area area
= it
->area
;
20221 xassert (it
->glyph_row
);
20223 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20224 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20226 glyph
->charpos
= CHARPOS (it
->position
);
20227 glyph
->object
= it
->object
;
20228 glyph
->pixel_width
= it
->pixel_width
;
20229 glyph
->ascent
= it
->ascent
;
20230 glyph
->descent
= it
->descent
;
20231 glyph
->voffset
= it
->voffset
;
20232 glyph
->type
= COMPOSITE_GLYPH
;
20233 glyph
->multibyte_p
= it
->multibyte_p
;
20234 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20235 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20236 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20237 || it
->phys_descent
> it
->descent
);
20238 glyph
->padding_p
= 0;
20239 glyph
->glyph_not_available_p
= 0;
20240 glyph
->face_id
= it
->face_id
;
20241 glyph
->u
.cmp_id
= it
->cmp_id
;
20242 glyph
->slice
= null_glyph_slice
;
20243 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20244 ++it
->glyph_row
->used
[area
];
20247 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20251 /* Change IT->ascent and IT->height according to the setting of
20255 take_vertical_position_into_account (it
)
20260 if (it
->voffset
< 0)
20261 /* Increase the ascent so that we can display the text higher
20263 it
->ascent
-= it
->voffset
;
20265 /* Increase the descent so that we can display the text lower
20267 it
->descent
+= it
->voffset
;
20272 /* Produce glyphs/get display metrics for the image IT is loaded with.
20273 See the description of struct display_iterator in dispextern.h for
20274 an overview of struct display_iterator. */
20277 produce_image_glyph (it
)
20282 int glyph_ascent
, crop
;
20283 struct glyph_slice slice
;
20285 xassert (it
->what
== IT_IMAGE
);
20287 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20289 /* Make sure X resources of the face is loaded. */
20290 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20292 if (it
->image_id
< 0)
20294 /* Fringe bitmap. */
20295 it
->ascent
= it
->phys_ascent
= 0;
20296 it
->descent
= it
->phys_descent
= 0;
20297 it
->pixel_width
= 0;
20302 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20304 /* Make sure X resources of the image is loaded. */
20305 prepare_image_for_display (it
->f
, img
);
20307 slice
.x
= slice
.y
= 0;
20308 slice
.width
= img
->width
;
20309 slice
.height
= img
->height
;
20311 if (INTEGERP (it
->slice
.x
))
20312 slice
.x
= XINT (it
->slice
.x
);
20313 else if (FLOATP (it
->slice
.x
))
20314 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20316 if (INTEGERP (it
->slice
.y
))
20317 slice
.y
= XINT (it
->slice
.y
);
20318 else if (FLOATP (it
->slice
.y
))
20319 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20321 if (INTEGERP (it
->slice
.width
))
20322 slice
.width
= XINT (it
->slice
.width
);
20323 else if (FLOATP (it
->slice
.width
))
20324 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20326 if (INTEGERP (it
->slice
.height
))
20327 slice
.height
= XINT (it
->slice
.height
);
20328 else if (FLOATP (it
->slice
.height
))
20329 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20331 if (slice
.x
>= img
->width
)
20332 slice
.x
= img
->width
;
20333 if (slice
.y
>= img
->height
)
20334 slice
.y
= img
->height
;
20335 if (slice
.x
+ slice
.width
>= img
->width
)
20336 slice
.width
= img
->width
- slice
.x
;
20337 if (slice
.y
+ slice
.height
> img
->height
)
20338 slice
.height
= img
->height
- slice
.y
;
20340 if (slice
.width
== 0 || slice
.height
== 0)
20343 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20345 it
->descent
= slice
.height
- glyph_ascent
;
20347 it
->descent
+= img
->vmargin
;
20348 if (slice
.y
+ slice
.height
== img
->height
)
20349 it
->descent
+= img
->vmargin
;
20350 it
->phys_descent
= it
->descent
;
20352 it
->pixel_width
= slice
.width
;
20354 it
->pixel_width
+= img
->hmargin
;
20355 if (slice
.x
+ slice
.width
== img
->width
)
20356 it
->pixel_width
+= img
->hmargin
;
20358 /* It's quite possible for images to have an ascent greater than
20359 their height, so don't get confused in that case. */
20360 if (it
->descent
< 0)
20363 #if 0 /* this breaks image tiling */
20364 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20365 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20366 if (face_ascent
> it
->ascent
)
20367 it
->ascent
= it
->phys_ascent
= face_ascent
;
20372 if (face
->box
!= FACE_NO_BOX
)
20374 if (face
->box_line_width
> 0)
20377 it
->ascent
+= face
->box_line_width
;
20378 if (slice
.y
+ slice
.height
== img
->height
)
20379 it
->descent
+= face
->box_line_width
;
20382 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20383 it
->pixel_width
+= eabs (face
->box_line_width
);
20384 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20385 it
->pixel_width
+= eabs (face
->box_line_width
);
20388 take_vertical_position_into_account (it
);
20390 /* Automatically crop wide image glyphs at right edge so we can
20391 draw the cursor on same display row. */
20392 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20393 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20395 it
->pixel_width
-= crop
;
20396 slice
.width
-= crop
;
20401 struct glyph
*glyph
;
20402 enum glyph_row_area area
= it
->area
;
20404 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20405 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20407 glyph
->charpos
= CHARPOS (it
->position
);
20408 glyph
->object
= it
->object
;
20409 glyph
->pixel_width
= it
->pixel_width
;
20410 glyph
->ascent
= glyph_ascent
;
20411 glyph
->descent
= it
->descent
;
20412 glyph
->voffset
= it
->voffset
;
20413 glyph
->type
= IMAGE_GLYPH
;
20414 glyph
->multibyte_p
= it
->multibyte_p
;
20415 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20416 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20417 glyph
->overlaps_vertically_p
= 0;
20418 glyph
->padding_p
= 0;
20419 glyph
->glyph_not_available_p
= 0;
20420 glyph
->face_id
= it
->face_id
;
20421 glyph
->u
.img_id
= img
->id
;
20422 glyph
->slice
= slice
;
20423 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20424 ++it
->glyph_row
->used
[area
];
20427 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20432 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20433 of the glyph, WIDTH and HEIGHT are the width and height of the
20434 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20437 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20439 Lisp_Object object
;
20443 struct glyph
*glyph
;
20444 enum glyph_row_area area
= it
->area
;
20446 xassert (ascent
>= 0 && ascent
<= height
);
20448 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20449 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20451 glyph
->charpos
= CHARPOS (it
->position
);
20452 glyph
->object
= object
;
20453 glyph
->pixel_width
= width
;
20454 glyph
->ascent
= ascent
;
20455 glyph
->descent
= height
- ascent
;
20456 glyph
->voffset
= it
->voffset
;
20457 glyph
->type
= STRETCH_GLYPH
;
20458 glyph
->multibyte_p
= it
->multibyte_p
;
20459 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20460 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20461 glyph
->overlaps_vertically_p
= 0;
20462 glyph
->padding_p
= 0;
20463 glyph
->glyph_not_available_p
= 0;
20464 glyph
->face_id
= it
->face_id
;
20465 glyph
->u
.stretch
.ascent
= ascent
;
20466 glyph
->u
.stretch
.height
= height
;
20467 glyph
->slice
= null_glyph_slice
;
20468 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20469 ++it
->glyph_row
->used
[area
];
20472 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20476 /* Produce a stretch glyph for iterator IT. IT->object is the value
20477 of the glyph property displayed. The value must be a list
20478 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20481 1. `:width WIDTH' specifies that the space should be WIDTH *
20482 canonical char width wide. WIDTH may be an integer or floating
20485 2. `:relative-width FACTOR' specifies that the width of the stretch
20486 should be computed from the width of the first character having the
20487 `glyph' property, and should be FACTOR times that width.
20489 3. `:align-to HPOS' specifies that the space should be wide enough
20490 to reach HPOS, a value in canonical character units.
20492 Exactly one of the above pairs must be present.
20494 4. `:height HEIGHT' specifies that the height of the stretch produced
20495 should be HEIGHT, measured in canonical character units.
20497 5. `:relative-height FACTOR' specifies that the height of the
20498 stretch should be FACTOR times the height of the characters having
20499 the glyph property.
20501 Either none or exactly one of 4 or 5 must be present.
20503 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20504 of the stretch should be used for the ascent of the stretch.
20505 ASCENT must be in the range 0 <= ASCENT <= 100. */
20508 produce_stretch_glyph (it
)
20511 /* (space :width WIDTH :height HEIGHT ...) */
20512 Lisp_Object prop
, plist
;
20513 int width
= 0, height
= 0, align_to
= -1;
20514 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20517 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20518 XFontStruct
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20520 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20522 /* List should start with `space'. */
20523 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20524 plist
= XCDR (it
->object
);
20526 /* Compute the width of the stretch. */
20527 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20528 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20530 /* Absolute width `:width WIDTH' specified and valid. */
20531 zero_width_ok_p
= 1;
20534 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20537 /* Relative width `:relative-width FACTOR' specified and valid.
20538 Compute the width of the characters having the `glyph'
20541 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20544 if (it
->multibyte_p
)
20546 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20547 - IT_BYTEPOS (*it
));
20548 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20551 it2
.c
= *p
, it2
.len
= 1;
20553 it2
.glyph_row
= NULL
;
20554 it2
.what
= IT_CHARACTER
;
20555 x_produce_glyphs (&it2
);
20556 width
= NUMVAL (prop
) * it2
.pixel_width
;
20558 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20559 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20561 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20562 align_to
= (align_to
< 0
20564 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20565 else if (align_to
< 0)
20566 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20567 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20568 zero_width_ok_p
= 1;
20571 /* Nothing specified -> width defaults to canonical char width. */
20572 width
= FRAME_COLUMN_WIDTH (it
->f
);
20574 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20577 /* Compute height. */
20578 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20579 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20582 zero_height_ok_p
= 1;
20584 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20586 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20588 height
= FONT_HEIGHT (font
);
20590 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20593 /* Compute percentage of height used for ascent. If
20594 `:ascent ASCENT' is present and valid, use that. Otherwise,
20595 derive the ascent from the font in use. */
20596 if (prop
= Fplist_get (plist
, QCascent
),
20597 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20598 ascent
= height
* NUMVAL (prop
) / 100.0;
20599 else if (!NILP (prop
)
20600 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20601 ascent
= min (max (0, (int)tem
), height
);
20603 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20605 if (width
> 0 && !it
->truncate_lines_p
20606 && it
->current_x
+ width
> it
->last_visible_x
)
20607 width
= it
->last_visible_x
- it
->current_x
- 1;
20609 if (width
> 0 && height
> 0 && it
->glyph_row
)
20611 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20612 if (!STRINGP (object
))
20613 object
= it
->w
->buffer
;
20614 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20617 it
->pixel_width
= width
;
20618 it
->ascent
= it
->phys_ascent
= ascent
;
20619 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20620 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20622 take_vertical_position_into_account (it
);
20625 /* Get line-height and line-spacing property at point.
20626 If line-height has format (HEIGHT TOTAL), return TOTAL
20627 in TOTAL_HEIGHT. */
20630 get_line_height_property (it
, prop
)
20634 Lisp_Object position
;
20636 if (STRINGP (it
->object
))
20637 position
= make_number (IT_STRING_CHARPOS (*it
));
20638 else if (BUFFERP (it
->object
))
20639 position
= make_number (IT_CHARPOS (*it
));
20643 return Fget_char_property (position
, prop
, it
->object
);
20646 /* Calculate line-height and line-spacing properties.
20647 An integer value specifies explicit pixel value.
20648 A float value specifies relative value to current face height.
20649 A cons (float . face-name) specifies relative value to
20650 height of specified face font.
20652 Returns height in pixels, or nil. */
20656 calc_line_height_property (it
, val
, font
, boff
, override
)
20660 int boff
, override
;
20662 Lisp_Object face_name
= Qnil
;
20663 int ascent
, descent
, height
;
20665 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
20670 face_name
= XCAR (val
);
20672 if (!NUMBERP (val
))
20673 val
= make_number (1);
20674 if (NILP (face_name
))
20676 height
= it
->ascent
+ it
->descent
;
20681 if (NILP (face_name
))
20683 font
= FRAME_FONT (it
->f
);
20684 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20686 else if (EQ (face_name
, Qt
))
20694 struct font_info
*font_info
;
20696 face_id
= lookup_named_face (it
->f
, face_name
, 0);
20698 return make_number (-1);
20700 face
= FACE_FROM_ID (it
->f
, face_id
);
20703 return make_number (-1);
20705 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
20706 boff
= font_info
->baseline_offset
;
20707 if (font_info
->vertical_centering
)
20708 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20711 ascent
= FONT_BASE (font
) + boff
;
20712 descent
= FONT_DESCENT (font
) - boff
;
20716 it
->override_ascent
= ascent
;
20717 it
->override_descent
= descent
;
20718 it
->override_boff
= boff
;
20721 height
= ascent
+ descent
;
20725 height
= (int)(XFLOAT_DATA (val
) * height
);
20726 else if (INTEGERP (val
))
20727 height
*= XINT (val
);
20729 return make_number (height
);
20734 Produce glyphs/get display metrics for the display element IT is
20735 loaded with. See the description of struct it in dispextern.h
20736 for an overview of struct it. */
20739 x_produce_glyphs (it
)
20742 int extra_line_spacing
= it
->extra_line_spacing
;
20744 it
->glyph_not_available_p
= 0;
20746 if (it
->what
== IT_CHARACTER
)
20750 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20752 int font_not_found_p
;
20753 struct font_info
*font_info
;
20754 int boff
; /* baseline offset */
20755 /* We may change it->multibyte_p upon unibyte<->multibyte
20756 conversion. So, save the current value now and restore it
20759 Note: It seems that we don't have to record multibyte_p in
20760 struct glyph because the character code itself tells if or
20761 not the character is multibyte. Thus, in the future, we must
20762 consider eliminating the field `multibyte_p' in the struct
20764 int saved_multibyte_p
= it
->multibyte_p
;
20766 /* Maybe translate single-byte characters to multibyte, or the
20768 it
->char_to_display
= it
->c
;
20769 if (!ASCII_BYTE_P (it
->c
)
20770 && ! it
->multibyte_p
)
20772 if (SINGLE_BYTE_CHAR_P (it
->c
)
20773 && unibyte_display_via_language_environment
)
20774 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
20775 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
20777 it
->multibyte_p
= 1;
20778 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
20780 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20784 /* Get font to use. Encode IT->char_to_display. */
20785 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
20786 &char2b
, it
->multibyte_p
, 0);
20789 /* When no suitable font found, use the default font. */
20790 font_not_found_p
= font
== NULL
;
20791 if (font_not_found_p
)
20793 font
= FRAME_FONT (it
->f
);
20794 boff
= FRAME_BASELINE_OFFSET (it
->f
);
20799 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
20800 boff
= font_info
->baseline_offset
;
20801 if (font_info
->vertical_centering
)
20802 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
20805 if (it
->char_to_display
>= ' '
20806 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
20808 /* Either unibyte or ASCII. */
20813 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
20814 FONT_TYPE_FOR_UNIBYTE (font
, it
->char_to_display
));
20816 if (it
->override_ascent
>= 0)
20818 it
->ascent
= it
->override_ascent
;
20819 it
->descent
= it
->override_descent
;
20820 boff
= it
->override_boff
;
20824 it
->ascent
= FONT_BASE (font
) + boff
;
20825 it
->descent
= FONT_DESCENT (font
) - boff
;
20830 it
->phys_ascent
= pcm
->ascent
+ boff
;
20831 it
->phys_descent
= pcm
->descent
- boff
;
20832 it
->pixel_width
= pcm
->width
;
20836 it
->glyph_not_available_p
= 1;
20837 it
->phys_ascent
= it
->ascent
;
20838 it
->phys_descent
= it
->descent
;
20839 it
->pixel_width
= FONT_WIDTH (font
);
20842 if (it
->constrain_row_ascent_descent_p
)
20844 if (it
->descent
> it
->max_descent
)
20846 it
->ascent
+= it
->descent
- it
->max_descent
;
20847 it
->descent
= it
->max_descent
;
20849 if (it
->ascent
> it
->max_ascent
)
20851 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20852 it
->ascent
= it
->max_ascent
;
20854 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20855 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20856 extra_line_spacing
= 0;
20859 /* If this is a space inside a region of text with
20860 `space-width' property, change its width. */
20861 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
20863 it
->pixel_width
*= XFLOATINT (it
->space_width
);
20865 /* If face has a box, add the box thickness to the character
20866 height. If character has a box line to the left and/or
20867 right, add the box line width to the character's width. */
20868 if (face
->box
!= FACE_NO_BOX
)
20870 int thick
= face
->box_line_width
;
20874 it
->ascent
+= thick
;
20875 it
->descent
+= thick
;
20880 if (it
->start_of_box_run_p
)
20881 it
->pixel_width
+= thick
;
20882 if (it
->end_of_box_run_p
)
20883 it
->pixel_width
+= thick
;
20886 /* If face has an overline, add the height of the overline
20887 (1 pixel) and a 1 pixel margin to the character height. */
20888 if (face
->overline_p
)
20889 it
->ascent
+= overline_margin
;
20891 if (it
->constrain_row_ascent_descent_p
)
20893 if (it
->ascent
> it
->max_ascent
)
20894 it
->ascent
= it
->max_ascent
;
20895 if (it
->descent
> it
->max_descent
)
20896 it
->descent
= it
->max_descent
;
20899 take_vertical_position_into_account (it
);
20901 /* If we have to actually produce glyphs, do it. */
20906 /* Translate a space with a `space-width' property
20907 into a stretch glyph. */
20908 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
20909 / FONT_HEIGHT (font
));
20910 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
20911 it
->ascent
+ it
->descent
, ascent
);
20916 /* If characters with lbearing or rbearing are displayed
20917 in this line, record that fact in a flag of the
20918 glyph row. This is used to optimize X output code. */
20919 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
20920 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
20922 if (! stretched_p
&& it
->pixel_width
== 0)
20923 /* We assure that all visible glyphs have at least 1-pixel
20925 it
->pixel_width
= 1;
20927 else if (it
->char_to_display
== '\n')
20929 /* A newline has no width but we need the height of the line.
20930 But if previous part of the line set a height, don't
20931 increase that height */
20933 Lisp_Object height
;
20934 Lisp_Object total_height
= Qnil
;
20936 it
->override_ascent
= -1;
20937 it
->pixel_width
= 0;
20940 height
= get_line_height_property(it
, Qline_height
);
20941 /* Split (line-height total-height) list */
20943 && CONSP (XCDR (height
))
20944 && NILP (XCDR (XCDR (height
))))
20946 total_height
= XCAR (XCDR (height
));
20947 height
= XCAR (height
);
20949 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
20951 if (it
->override_ascent
>= 0)
20953 it
->ascent
= it
->override_ascent
;
20954 it
->descent
= it
->override_descent
;
20955 boff
= it
->override_boff
;
20959 it
->ascent
= FONT_BASE (font
) + boff
;
20960 it
->descent
= FONT_DESCENT (font
) - boff
;
20963 if (EQ (height
, Qt
))
20965 if (it
->descent
> it
->max_descent
)
20967 it
->ascent
+= it
->descent
- it
->max_descent
;
20968 it
->descent
= it
->max_descent
;
20970 if (it
->ascent
> it
->max_ascent
)
20972 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
20973 it
->ascent
= it
->max_ascent
;
20975 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
20976 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
20977 it
->constrain_row_ascent_descent_p
= 1;
20978 extra_line_spacing
= 0;
20982 Lisp_Object spacing
;
20984 it
->phys_ascent
= it
->ascent
;
20985 it
->phys_descent
= it
->descent
;
20987 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
20988 && face
->box
!= FACE_NO_BOX
20989 && face
->box_line_width
> 0)
20991 it
->ascent
+= face
->box_line_width
;
20992 it
->descent
+= face
->box_line_width
;
20995 && XINT (height
) > it
->ascent
+ it
->descent
)
20996 it
->ascent
= XINT (height
) - it
->descent
;
20998 if (!NILP (total_height
))
20999 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21002 spacing
= get_line_height_property(it
, Qline_spacing
);
21003 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21005 if (INTEGERP (spacing
))
21007 extra_line_spacing
= XINT (spacing
);
21008 if (!NILP (total_height
))
21009 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21013 else if (it
->char_to_display
== '\t')
21015 int tab_width
= it
->tab_width
* FRAME_SPACE_WIDTH (it
->f
);
21016 int x
= it
->current_x
+ it
->continuation_lines_width
;
21017 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21019 /* If the distance from the current position to the next tab
21020 stop is less than a space character width, use the
21021 tab stop after that. */
21022 if (next_tab_x
- x
< FRAME_SPACE_WIDTH (it
->f
))
21023 next_tab_x
+= tab_width
;
21025 it
->pixel_width
= next_tab_x
- x
;
21027 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21028 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21032 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21033 it
->ascent
+ it
->descent
, it
->ascent
);
21038 /* A multi-byte character. Assume that the display width of the
21039 character is the width of the character multiplied by the
21040 width of the font. */
21042 /* If we found a font, this font should give us the right
21043 metrics. If we didn't find a font, use the frame's
21044 default font and calculate the width of the character by
21045 multiplying the width of font by the width of the
21048 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21049 FONT_TYPE_FOR_MULTIBYTE (font
, it
->c
));
21051 if (font_not_found_p
|| !pcm
)
21053 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21055 if (char_width
== 0)
21056 /* This is a non spacing character. But, as we are
21057 going to display an empty box, the box must occupy
21058 at least one column. */
21060 it
->glyph_not_available_p
= 1;
21061 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21062 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21063 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21067 it
->pixel_width
= pcm
->width
;
21068 it
->phys_ascent
= pcm
->ascent
+ boff
;
21069 it
->phys_descent
= pcm
->descent
- boff
;
21071 && (pcm
->lbearing
< 0
21072 || pcm
->rbearing
> pcm
->width
))
21073 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21076 it
->ascent
= FONT_BASE (font
) + boff
;
21077 it
->descent
= FONT_DESCENT (font
) - boff
;
21078 if (face
->box
!= FACE_NO_BOX
)
21080 int thick
= face
->box_line_width
;
21084 it
->ascent
+= thick
;
21085 it
->descent
+= thick
;
21090 if (it
->start_of_box_run_p
)
21091 it
->pixel_width
+= thick
;
21092 if (it
->end_of_box_run_p
)
21093 it
->pixel_width
+= thick
;
21096 /* If face has an overline, add the height of the overline
21097 (1 pixel) and a 1 pixel margin to the character height. */
21098 if (face
->overline_p
)
21099 it
->ascent
+= overline_margin
;
21101 take_vertical_position_into_account (it
);
21103 if (it
->ascent
< 0)
21105 if (it
->descent
< 0)
21110 if (it
->pixel_width
== 0)
21111 /* We assure that all visible glyphs have at least 1-pixel
21113 it
->pixel_width
= 1;
21115 it
->multibyte_p
= saved_multibyte_p
;
21117 else if (it
->what
== IT_COMPOSITION
)
21119 /* Note: A composition is represented as one glyph in the
21120 glyph matrix. There are no padding glyphs.
21122 Important is that pixel_width, ascent, and descent are the
21123 values of what is drawn by draw_glyphs (i.e. the values of
21124 the overall glyphs composed). */
21125 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21126 int boff
; /* baseline offset */
21127 struct composition
*cmp
= composition_table
[it
->cmp_id
];
21128 int glyph_len
= cmp
->glyph_len
;
21129 XFontStruct
*font
= face
->font
;
21133 #ifdef USE_FONT_BACKEND
21134 if (cmp
->method
== COMPOSITION_WITH_GLYPH_STRING
)
21136 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21137 font_prepare_composition (cmp
, it
->f
);
21140 #endif /* USE_FONT_BACKEND */
21141 /* If we have not yet calculated pixel size data of glyphs of
21142 the composition for the current face font, calculate them
21143 now. Theoretically, we have to check all fonts for the
21144 glyphs, but that requires much time and memory space. So,
21145 here we check only the font of the first glyph. This leads
21146 to incorrect display, but it's very rare, and C-l (recenter)
21147 can correct the display anyway. */
21148 if (! cmp
->font
|| cmp
->font
!= font
)
21150 /* Ascent and descent of the font of the first character
21151 of this composition (adjusted by baseline offset).
21152 Ascent and descent of overall glyphs should not be less
21153 than them respectively. */
21154 int font_ascent
, font_descent
, font_height
;
21155 /* Bounding box of the overall glyphs. */
21156 int leftmost
, rightmost
, lowest
, highest
;
21157 int lbearing
, rbearing
;
21158 int i
, width
, ascent
, descent
;
21159 int left_padded
= 0, right_padded
= 0;
21164 int font_not_found_p
;
21165 struct font_info
*font_info
;
21168 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21169 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21171 if (glyph_len
< cmp
->glyph_len
)
21173 for (i
= 0; i
< glyph_len
; i
++)
21175 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21177 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21182 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21183 : IT_CHARPOS (*it
));
21184 /* When no suitable font found, use the default font. */
21185 font_not_found_p
= font
== NULL
;
21186 if (font_not_found_p
)
21188 face
= face
->ascii_face
;
21191 font_info
= FONT_INFO_FROM_FACE (it
->f
, face
);
21192 boff
= font_info
->baseline_offset
;
21193 if (font_info
->vertical_centering
)
21194 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21195 font_ascent
= FONT_BASE (font
) + boff
;
21196 font_descent
= FONT_DESCENT (font
) - boff
;
21197 font_height
= FONT_HEIGHT (font
);
21199 cmp
->font
= (void *) font
;
21202 if (! font_not_found_p
)
21204 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21205 &char2b
, it
->multibyte_p
, 0);
21206 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21207 FONT_TYPE_FOR_MULTIBYTE (font
, c
));
21210 /* Initialize the bounding box. */
21213 width
= pcm
->width
;
21214 ascent
= pcm
->ascent
;
21215 descent
= pcm
->descent
;
21216 lbearing
= pcm
->lbearing
;
21217 rbearing
= pcm
->rbearing
;
21221 width
= FONT_WIDTH (font
);
21222 ascent
= FONT_BASE (font
);
21223 descent
= FONT_DESCENT (font
);
21230 lowest
= - descent
+ boff
;
21231 highest
= ascent
+ boff
;
21233 if (! font_not_found_p
21234 && font_info
->default_ascent
21235 && CHAR_TABLE_P (Vuse_default_ascent
)
21236 && !NILP (Faref (Vuse_default_ascent
,
21237 make_number (it
->char_to_display
))))
21238 highest
= font_info
->default_ascent
+ boff
;
21240 /* Draw the first glyph at the normal position. It may be
21241 shifted to right later if some other glyphs are drawn
21243 cmp
->offsets
[i
* 2] = 0;
21244 cmp
->offsets
[i
* 2 + 1] = boff
;
21245 cmp
->lbearing
= lbearing
;
21246 cmp
->rbearing
= rbearing
;
21248 /* Set cmp->offsets for the remaining glyphs. */
21249 for (i
++; i
< glyph_len
; i
++)
21251 int left
, right
, btm
, top
;
21252 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21254 struct face
*this_face
;
21259 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21260 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21261 font
= this_face
->font
;
21267 font_info
= FONT_INFO_FROM_FACE (it
->f
, this_face
);
21268 this_boff
= font_info
->baseline_offset
;
21269 if (font_info
->vertical_centering
)
21270 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21271 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21272 &char2b
, it
->multibyte_p
, 0);
21273 pcm
= get_per_char_metric (it
->f
, font
, font_info
, &char2b
,
21274 FONT_TYPE_FOR_MULTIBYTE (font
,
21278 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21281 width
= pcm
->width
;
21282 ascent
= pcm
->ascent
;
21283 descent
= pcm
->descent
;
21284 lbearing
= pcm
->lbearing
;
21285 rbearing
= pcm
->rbearing
;
21286 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21288 /* Relative composition with or without
21289 alternate chars. */
21290 left
= (leftmost
+ rightmost
- width
) / 2;
21291 btm
= - descent
+ boff
;
21292 if (font_info
->relative_compose
21293 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21294 || NILP (Faref (Vignore_relative_composition
,
21295 make_number (ch
)))))
21298 if (- descent
>= font_info
->relative_compose
)
21299 /* One extra pixel between two glyphs. */
21301 else if (ascent
<= 0)
21302 /* One extra pixel between two glyphs. */
21303 btm
= lowest
- 1 - ascent
- descent
;
21308 /* A composition rule is specified by an integer
21309 value that encodes global and new reference
21310 points (GREF and NREF). GREF and NREF are
21311 specified by numbers as below:
21313 0---1---2 -- ascent
21317 9--10--11 -- center
21319 ---3---4---5--- baseline
21321 6---7---8 -- descent
21323 int rule
= COMPOSITION_RULE (cmp
, i
);
21324 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21326 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21327 grefx
= gref
% 3, nrefx
= nref
% 3;
21328 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21330 xoff
= font_height
* (xoff
- 128) / 256;
21332 yoff
= font_height
* (yoff
- 128) / 256;
21335 + grefx
* (rightmost
- leftmost
) / 2
21336 - nrefx
* width
/ 2
21339 btm
= ((grefy
== 0 ? highest
21341 : grefy
== 2 ? lowest
21342 : (highest
+ lowest
) / 2)
21343 - (nrefy
== 0 ? ascent
+ descent
21344 : nrefy
== 1 ? descent
- boff
21346 : (ascent
+ descent
) / 2)
21350 cmp
->offsets
[i
* 2] = left
;
21351 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21353 /* Update the bounding box of the overall glyphs. */
21356 right
= left
+ width
;
21357 if (left
< leftmost
)
21359 if (right
> rightmost
)
21362 top
= btm
+ descent
+ ascent
;
21368 if (cmp
->lbearing
> left
+ lbearing
)
21369 cmp
->lbearing
= left
+ lbearing
;
21370 if (cmp
->rbearing
< left
+ rbearing
)
21371 cmp
->rbearing
= left
+ rbearing
;
21375 /* If there are glyphs whose x-offsets are negative,
21376 shift all glyphs to the right and make all x-offsets
21380 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21381 cmp
->offsets
[i
* 2] -= leftmost
;
21382 rightmost
-= leftmost
;
21383 cmp
->lbearing
-= leftmost
;
21384 cmp
->rbearing
-= leftmost
;
21387 if (left_padded
&& cmp
->lbearing
< 0)
21389 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21390 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21391 rightmost
-= cmp
->lbearing
;
21392 cmp
->rbearing
-= cmp
->lbearing
;
21395 if (right_padded
&& rightmost
< cmp
->rbearing
)
21397 rightmost
= cmp
->rbearing
;
21400 cmp
->pixel_width
= rightmost
;
21401 cmp
->ascent
= highest
;
21402 cmp
->descent
= - lowest
;
21403 if (cmp
->ascent
< font_ascent
)
21404 cmp
->ascent
= font_ascent
;
21405 if (cmp
->descent
< font_descent
)
21406 cmp
->descent
= font_descent
;
21410 && (cmp
->lbearing
< 0
21411 || cmp
->rbearing
> cmp
->pixel_width
))
21412 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21414 it
->pixel_width
= cmp
->pixel_width
;
21415 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21416 it
->descent
= it
->phys_descent
= cmp
->descent
;
21417 if (face
->box
!= FACE_NO_BOX
)
21419 int thick
= face
->box_line_width
;
21423 it
->ascent
+= thick
;
21424 it
->descent
+= thick
;
21429 if (it
->start_of_box_run_p
)
21430 it
->pixel_width
+= thick
;
21431 if (it
->end_of_box_run_p
)
21432 it
->pixel_width
+= thick
;
21435 /* If face has an overline, add the height of the overline
21436 (1 pixel) and a 1 pixel margin to the character height. */
21437 if (face
->overline_p
)
21438 it
->ascent
+= overline_margin
;
21440 take_vertical_position_into_account (it
);
21441 if (it
->ascent
< 0)
21443 if (it
->descent
< 0)
21447 append_composite_glyph (it
);
21449 else if (it
->what
== IT_IMAGE
)
21450 produce_image_glyph (it
);
21451 else if (it
->what
== IT_STRETCH
)
21452 produce_stretch_glyph (it
);
21454 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21455 because this isn't true for images with `:ascent 100'. */
21456 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21457 if (it
->area
== TEXT_AREA
)
21458 it
->current_x
+= it
->pixel_width
;
21460 if (extra_line_spacing
> 0)
21462 it
->descent
+= extra_line_spacing
;
21463 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21464 it
->max_extra_line_spacing
= extra_line_spacing
;
21467 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21468 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21469 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21470 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21474 Output LEN glyphs starting at START at the nominal cursor position.
21475 Advance the nominal cursor over the text. The global variable
21476 updated_window contains the window being updated, updated_row is
21477 the glyph row being updated, and updated_area is the area of that
21478 row being updated. */
21481 x_write_glyphs (start
, len
)
21482 struct glyph
*start
;
21487 xassert (updated_window
&& updated_row
);
21490 /* Write glyphs. */
21492 hpos
= start
- updated_row
->glyphs
[updated_area
];
21493 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21494 updated_row
, updated_area
,
21496 DRAW_NORMAL_TEXT
, 0);
21498 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21499 if (updated_area
== TEXT_AREA
21500 && updated_window
->phys_cursor_on_p
21501 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21502 && updated_window
->phys_cursor
.hpos
>= hpos
21503 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21504 updated_window
->phys_cursor_on_p
= 0;
21508 /* Advance the output cursor. */
21509 output_cursor
.hpos
+= len
;
21510 output_cursor
.x
= x
;
21515 Insert LEN glyphs from START at the nominal cursor position. */
21518 x_insert_glyphs (start
, len
)
21519 struct glyph
*start
;
21524 int line_height
, shift_by_width
, shifted_region_width
;
21525 struct glyph_row
*row
;
21526 struct glyph
*glyph
;
21527 int frame_x
, frame_y
;
21530 xassert (updated_window
&& updated_row
);
21532 w
= updated_window
;
21533 f
= XFRAME (WINDOW_FRAME (w
));
21535 /* Get the height of the line we are in. */
21537 line_height
= row
->height
;
21539 /* Get the width of the glyphs to insert. */
21540 shift_by_width
= 0;
21541 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21542 shift_by_width
+= glyph
->pixel_width
;
21544 /* Get the width of the region to shift right. */
21545 shifted_region_width
= (window_box_width (w
, updated_area
)
21550 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21551 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21553 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21554 line_height
, shift_by_width
);
21556 /* Write the glyphs. */
21557 hpos
= start
- row
->glyphs
[updated_area
];
21558 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21560 DRAW_NORMAL_TEXT
, 0);
21562 /* Advance the output cursor. */
21563 output_cursor
.hpos
+= len
;
21564 output_cursor
.x
+= shift_by_width
;
21570 Erase the current text line from the nominal cursor position
21571 (inclusive) to pixel column TO_X (exclusive). The idea is that
21572 everything from TO_X onward is already erased.
21574 TO_X is a pixel position relative to updated_area of
21575 updated_window. TO_X == -1 means clear to the end of this area. */
21578 x_clear_end_of_line (to_x
)
21582 struct window
*w
= updated_window
;
21583 int max_x
, min_y
, max_y
;
21584 int from_x
, from_y
, to_y
;
21586 xassert (updated_window
&& updated_row
);
21587 f
= XFRAME (w
->frame
);
21589 if (updated_row
->full_width_p
)
21590 max_x
= WINDOW_TOTAL_WIDTH (w
);
21592 max_x
= window_box_width (w
, updated_area
);
21593 max_y
= window_text_bottom_y (w
);
21595 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21596 of window. For TO_X > 0, truncate to end of drawing area. */
21602 to_x
= min (to_x
, max_x
);
21604 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21606 /* Notice if the cursor will be cleared by this operation. */
21607 if (!updated_row
->full_width_p
)
21608 notice_overwritten_cursor (w
, updated_area
,
21609 output_cursor
.x
, -1,
21611 MATRIX_ROW_BOTTOM_Y (updated_row
));
21613 from_x
= output_cursor
.x
;
21615 /* Translate to frame coordinates. */
21616 if (updated_row
->full_width_p
)
21618 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21619 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
21623 int area_left
= window_box_left (w
, updated_area
);
21624 from_x
+= area_left
;
21628 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
21629 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
21630 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
21632 /* Prevent inadvertently clearing to end of the X window. */
21633 if (to_x
> from_x
&& to_y
> from_y
)
21636 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
21637 to_x
- from_x
, to_y
- from_y
);
21642 #endif /* HAVE_WINDOW_SYSTEM */
21646 /***********************************************************************
21648 ***********************************************************************/
21650 /* Value is the internal representation of the specified cursor type
21651 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
21652 of the bar cursor. */
21654 static enum text_cursor_kinds
21655 get_specified_cursor_type (arg
, width
)
21659 enum text_cursor_kinds type
;
21664 if (EQ (arg
, Qbox
))
21665 return FILLED_BOX_CURSOR
;
21667 if (EQ (arg
, Qhollow
))
21668 return HOLLOW_BOX_CURSOR
;
21670 if (EQ (arg
, Qbar
))
21677 && EQ (XCAR (arg
), Qbar
)
21678 && INTEGERP (XCDR (arg
))
21679 && XINT (XCDR (arg
)) >= 0)
21681 *width
= XINT (XCDR (arg
));
21685 if (EQ (arg
, Qhbar
))
21688 return HBAR_CURSOR
;
21692 && EQ (XCAR (arg
), Qhbar
)
21693 && INTEGERP (XCDR (arg
))
21694 && XINT (XCDR (arg
)) >= 0)
21696 *width
= XINT (XCDR (arg
));
21697 return HBAR_CURSOR
;
21700 /* Treat anything unknown as "hollow box cursor".
21701 It was bad to signal an error; people have trouble fixing
21702 .Xdefaults with Emacs, when it has something bad in it. */
21703 type
= HOLLOW_BOX_CURSOR
;
21708 /* Set the default cursor types for specified frame. */
21710 set_frame_cursor_types (f
, arg
)
21717 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
21718 FRAME_CURSOR_WIDTH (f
) = width
;
21720 /* By default, set up the blink-off state depending on the on-state. */
21722 tem
= Fassoc (arg
, Vblink_cursor_alist
);
21725 FRAME_BLINK_OFF_CURSOR (f
)
21726 = get_specified_cursor_type (XCDR (tem
), &width
);
21727 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
21730 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
21734 /* Return the cursor we want to be displayed in window W. Return
21735 width of bar/hbar cursor through WIDTH arg. Return with
21736 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
21737 (i.e. if the `system caret' should track this cursor).
21739 In a mini-buffer window, we want the cursor only to appear if we
21740 are reading input from this window. For the selected window, we
21741 want the cursor type given by the frame parameter or buffer local
21742 setting of cursor-type. If explicitly marked off, draw no cursor.
21743 In all other cases, we want a hollow box cursor. */
21745 static enum text_cursor_kinds
21746 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
21748 struct glyph
*glyph
;
21750 int *active_cursor
;
21752 struct frame
*f
= XFRAME (w
->frame
);
21753 struct buffer
*b
= XBUFFER (w
->buffer
);
21754 int cursor_type
= DEFAULT_CURSOR
;
21755 Lisp_Object alt_cursor
;
21756 int non_selected
= 0;
21758 *active_cursor
= 1;
21761 if (cursor_in_echo_area
21762 && FRAME_HAS_MINIBUF_P (f
)
21763 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
21765 if (w
== XWINDOW (echo_area_window
))
21767 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
21769 *width
= FRAME_CURSOR_WIDTH (f
);
21770 return FRAME_DESIRED_CURSOR (f
);
21773 return get_specified_cursor_type (b
->cursor_type
, width
);
21776 *active_cursor
= 0;
21780 /* Detect a nonselected window or nonselected frame. */
21781 else if (w
!= XWINDOW (f
->selected_window
)
21782 #ifdef HAVE_WINDOW_SYSTEM
21783 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
21787 *active_cursor
= 0;
21789 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
21795 /* Never display a cursor in a window in which cursor-type is nil. */
21796 if (NILP (b
->cursor_type
))
21799 /* Get the normal cursor type for this window. */
21800 if (EQ (b
->cursor_type
, Qt
))
21802 cursor_type
= FRAME_DESIRED_CURSOR (f
);
21803 *width
= FRAME_CURSOR_WIDTH (f
);
21806 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
21808 /* Use cursor-in-non-selected-windows instead
21809 for non-selected window or frame. */
21812 alt_cursor
= b
->cursor_in_non_selected_windows
;
21813 if (!EQ (Qt
, alt_cursor
))
21814 return get_specified_cursor_type (alt_cursor
, width
);
21815 /* t means modify the normal cursor type. */
21816 if (cursor_type
== FILLED_BOX_CURSOR
)
21817 cursor_type
= HOLLOW_BOX_CURSOR
;
21818 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
21820 return cursor_type
;
21823 /* Use normal cursor if not blinked off. */
21824 if (!w
->cursor_off_p
)
21826 #ifdef HAVE_WINDOW_SYSTEM
21827 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
21829 if (cursor_type
== FILLED_BOX_CURSOR
)
21831 /* Using a block cursor on large images can be very annoying.
21832 So use a hollow cursor for "large" images.
21833 If image is not transparent (no mask), also use hollow cursor. */
21834 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
21835 if (img
!= NULL
&& IMAGEP (img
->spec
))
21837 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
21838 where N = size of default frame font size.
21839 This should cover most of the "tiny" icons people may use. */
21841 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
21842 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
21843 cursor_type
= HOLLOW_BOX_CURSOR
;
21846 else if (cursor_type
!= NO_CURSOR
)
21848 /* Display current only supports BOX and HOLLOW cursors for images.
21849 So for now, unconditionally use a HOLLOW cursor when cursor is
21850 not a solid box cursor. */
21851 cursor_type
= HOLLOW_BOX_CURSOR
;
21855 return cursor_type
;
21858 /* Cursor is blinked off, so determine how to "toggle" it. */
21860 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
21861 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
21862 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
21864 /* Then see if frame has specified a specific blink off cursor type. */
21865 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
21867 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
21868 return FRAME_BLINK_OFF_CURSOR (f
);
21872 /* Some people liked having a permanently visible blinking cursor,
21873 while others had very strong opinions against it. So it was
21874 decided to remove it. KFS 2003-09-03 */
21876 /* Finally perform built-in cursor blinking:
21877 filled box <-> hollow box
21878 wide [h]bar <-> narrow [h]bar
21879 narrow [h]bar <-> no cursor
21880 other type <-> no cursor */
21882 if (cursor_type
== FILLED_BOX_CURSOR
)
21883 return HOLLOW_BOX_CURSOR
;
21885 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
21888 return cursor_type
;
21896 #ifdef HAVE_WINDOW_SYSTEM
21898 /* Notice when the text cursor of window W has been completely
21899 overwritten by a drawing operation that outputs glyphs in AREA
21900 starting at X0 and ending at X1 in the line starting at Y0 and
21901 ending at Y1. X coordinates are area-relative. X1 < 0 means all
21902 the rest of the line after X0 has been written. Y coordinates
21903 are window-relative. */
21906 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
21908 enum glyph_row_area area
;
21909 int x0
, y0
, x1
, y1
;
21911 int cx0
, cx1
, cy0
, cy1
;
21912 struct glyph_row
*row
;
21914 if (!w
->phys_cursor_on_p
)
21916 if (area
!= TEXT_AREA
)
21919 if (w
->phys_cursor
.vpos
< 0
21920 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
21921 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
21922 !(row
->enabled_p
&& row
->displays_text_p
)))
21925 if (row
->cursor_in_fringe_p
)
21927 row
->cursor_in_fringe_p
= 0;
21928 draw_fringe_bitmap (w
, row
, 0);
21929 w
->phys_cursor_on_p
= 0;
21933 cx0
= w
->phys_cursor
.x
;
21934 cx1
= cx0
+ w
->phys_cursor_width
;
21935 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
21938 /* The cursor image will be completely removed from the
21939 screen if the output area intersects the cursor area in
21940 y-direction. When we draw in [y0 y1[, and some part of
21941 the cursor is at y < y0, that part must have been drawn
21942 before. When scrolling, the cursor is erased before
21943 actually scrolling, so we don't come here. When not
21944 scrolling, the rows above the old cursor row must have
21945 changed, and in this case these rows must have written
21946 over the cursor image.
21948 Likewise if part of the cursor is below y1, with the
21949 exception of the cursor being in the first blank row at
21950 the buffer and window end because update_text_area
21951 doesn't draw that row. (Except when it does, but
21952 that's handled in update_text_area.) */
21954 cy0
= w
->phys_cursor
.y
;
21955 cy1
= cy0
+ w
->phys_cursor_height
;
21956 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
21959 w
->phys_cursor_on_p
= 0;
21962 #endif /* HAVE_WINDOW_SYSTEM */
21965 /************************************************************************
21967 ************************************************************************/
21969 #ifdef HAVE_WINDOW_SYSTEM
21972 Fix the display of area AREA of overlapping row ROW in window W
21973 with respect to the overlapping part OVERLAPS. */
21976 x_fix_overlapping_area (w
, row
, area
, overlaps
)
21978 struct glyph_row
*row
;
21979 enum glyph_row_area area
;
21987 for (i
= 0; i
< row
->used
[area
];)
21989 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
21991 int start
= i
, start_x
= x
;
21995 x
+= row
->glyphs
[area
][i
].pixel_width
;
21998 while (i
< row
->used
[area
]
21999 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22001 draw_glyphs (w
, start_x
, row
, area
,
22003 DRAW_NORMAL_TEXT
, overlaps
);
22007 x
+= row
->glyphs
[area
][i
].pixel_width
;
22017 Draw the cursor glyph of window W in glyph row ROW. See the
22018 comment of draw_glyphs for the meaning of HL. */
22021 draw_phys_cursor_glyph (w
, row
, hl
)
22023 struct glyph_row
*row
;
22024 enum draw_glyphs_face hl
;
22026 /* If cursor hpos is out of bounds, don't draw garbage. This can
22027 happen in mini-buffer windows when switching between echo area
22028 glyphs and mini-buffer. */
22029 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22031 int on_p
= w
->phys_cursor_on_p
;
22033 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22034 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22036 w
->phys_cursor_on_p
= on_p
;
22038 if (hl
== DRAW_CURSOR
)
22039 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22040 /* When we erase the cursor, and ROW is overlapped by other
22041 rows, make sure that these overlapping parts of other rows
22043 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22045 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22047 if (row
> w
->current_matrix
->rows
22048 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22049 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22050 OVERLAPS_ERASED_CURSOR
);
22052 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22053 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22054 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22055 OVERLAPS_ERASED_CURSOR
);
22062 Erase the image of a cursor of window W from the screen. */
22065 erase_phys_cursor (w
)
22068 struct frame
*f
= XFRAME (w
->frame
);
22069 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22070 int hpos
= w
->phys_cursor
.hpos
;
22071 int vpos
= w
->phys_cursor
.vpos
;
22072 int mouse_face_here_p
= 0;
22073 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22074 struct glyph_row
*cursor_row
;
22075 struct glyph
*cursor_glyph
;
22076 enum draw_glyphs_face hl
;
22078 /* No cursor displayed or row invalidated => nothing to do on the
22080 if (w
->phys_cursor_type
== NO_CURSOR
)
22081 goto mark_cursor_off
;
22083 /* VPOS >= active_glyphs->nrows means that window has been resized.
22084 Don't bother to erase the cursor. */
22085 if (vpos
>= active_glyphs
->nrows
)
22086 goto mark_cursor_off
;
22088 /* If row containing cursor is marked invalid, there is nothing we
22090 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22091 if (!cursor_row
->enabled_p
)
22092 goto mark_cursor_off
;
22094 /* If line spacing is > 0, old cursor may only be partially visible in
22095 window after split-window. So adjust visible height. */
22096 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22097 window_text_bottom_y (w
) - cursor_row
->y
);
22099 /* If row is completely invisible, don't attempt to delete a cursor which
22100 isn't there. This can happen if cursor is at top of a window, and
22101 we switch to a buffer with a header line in that window. */
22102 if (cursor_row
->visible_height
<= 0)
22103 goto mark_cursor_off
;
22105 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22106 if (cursor_row
->cursor_in_fringe_p
)
22108 cursor_row
->cursor_in_fringe_p
= 0;
22109 draw_fringe_bitmap (w
, cursor_row
, 0);
22110 goto mark_cursor_off
;
22113 /* This can happen when the new row is shorter than the old one.
22114 In this case, either draw_glyphs or clear_end_of_line
22115 should have cleared the cursor. Note that we wouldn't be
22116 able to erase the cursor in this case because we don't have a
22117 cursor glyph at hand. */
22118 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22119 goto mark_cursor_off
;
22121 /* If the cursor is in the mouse face area, redisplay that when
22122 we clear the cursor. */
22123 if (! NILP (dpyinfo
->mouse_face_window
)
22124 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22125 && (vpos
> dpyinfo
->mouse_face_beg_row
22126 || (vpos
== dpyinfo
->mouse_face_beg_row
22127 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22128 && (vpos
< dpyinfo
->mouse_face_end_row
22129 || (vpos
== dpyinfo
->mouse_face_end_row
22130 && hpos
< dpyinfo
->mouse_face_end_col
))
22131 /* Don't redraw the cursor's spot in mouse face if it is at the
22132 end of a line (on a newline). The cursor appears there, but
22133 mouse highlighting does not. */
22134 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22135 mouse_face_here_p
= 1;
22137 /* Maybe clear the display under the cursor. */
22138 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22141 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22144 cursor_glyph
= get_phys_cursor_glyph (w
);
22145 if (cursor_glyph
== NULL
)
22146 goto mark_cursor_off
;
22148 width
= cursor_glyph
->pixel_width
;
22149 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22150 x
= w
->phys_cursor
.x
;
22152 width
-= left_x
- x
;
22153 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22154 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22155 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22158 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22161 /* Erase the cursor by redrawing the character underneath it. */
22162 if (mouse_face_here_p
)
22163 hl
= DRAW_MOUSE_FACE
;
22165 hl
= DRAW_NORMAL_TEXT
;
22166 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22169 w
->phys_cursor_on_p
= 0;
22170 w
->phys_cursor_type
= NO_CURSOR
;
22175 Display or clear cursor of window W. If ON is zero, clear the
22176 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22177 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22180 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22182 int on
, hpos
, vpos
, x
, y
;
22184 struct frame
*f
= XFRAME (w
->frame
);
22185 int new_cursor_type
;
22186 int new_cursor_width
;
22188 struct glyph_row
*glyph_row
;
22189 struct glyph
*glyph
;
22191 /* This is pointless on invisible frames, and dangerous on garbaged
22192 windows and frames; in the latter case, the frame or window may
22193 be in the midst of changing its size, and x and y may be off the
22195 if (! FRAME_VISIBLE_P (f
)
22196 || FRAME_GARBAGED_P (f
)
22197 || vpos
>= w
->current_matrix
->nrows
22198 || hpos
>= w
->current_matrix
->matrix_w
)
22201 /* If cursor is off and we want it off, return quickly. */
22202 if (!on
&& !w
->phys_cursor_on_p
)
22205 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22206 /* If cursor row is not enabled, we don't really know where to
22207 display the cursor. */
22208 if (!glyph_row
->enabled_p
)
22210 w
->phys_cursor_on_p
= 0;
22215 if (!glyph_row
->exact_window_width_line_p
22216 || hpos
< glyph_row
->used
[TEXT_AREA
])
22217 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22219 xassert (interrupt_input_blocked
);
22221 /* Set new_cursor_type to the cursor we want to be displayed. */
22222 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22223 &new_cursor_width
, &active_cursor
);
22225 /* If cursor is currently being shown and we don't want it to be or
22226 it is in the wrong place, or the cursor type is not what we want,
22228 if (w
->phys_cursor_on_p
22230 || w
->phys_cursor
.x
!= x
22231 || w
->phys_cursor
.y
!= y
22232 || new_cursor_type
!= w
->phys_cursor_type
22233 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22234 && new_cursor_width
!= w
->phys_cursor_width
)))
22235 erase_phys_cursor (w
);
22237 /* Don't check phys_cursor_on_p here because that flag is only set
22238 to zero in some cases where we know that the cursor has been
22239 completely erased, to avoid the extra work of erasing the cursor
22240 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22241 still not be visible, or it has only been partly erased. */
22244 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22245 w
->phys_cursor_height
= glyph_row
->height
;
22247 /* Set phys_cursor_.* before x_draw_.* is called because some
22248 of them may need the information. */
22249 w
->phys_cursor
.x
= x
;
22250 w
->phys_cursor
.y
= glyph_row
->y
;
22251 w
->phys_cursor
.hpos
= hpos
;
22252 w
->phys_cursor
.vpos
= vpos
;
22255 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22256 new_cursor_type
, new_cursor_width
,
22257 on
, active_cursor
);
22261 /* Switch the display of W's cursor on or off, according to the value
22265 update_window_cursor (w
, on
)
22269 /* Don't update cursor in windows whose frame is in the process
22270 of being deleted. */
22271 if (w
->current_matrix
)
22274 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22275 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22281 /* Call update_window_cursor with parameter ON_P on all leaf windows
22282 in the window tree rooted at W. */
22285 update_cursor_in_window_tree (w
, on_p
)
22291 if (!NILP (w
->hchild
))
22292 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22293 else if (!NILP (w
->vchild
))
22294 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22296 update_window_cursor (w
, on_p
);
22298 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22304 Display the cursor on window W, or clear it, according to ON_P.
22305 Don't change the cursor's position. */
22308 x_update_cursor (f
, on_p
)
22312 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22317 Clear the cursor of window W to background color, and mark the
22318 cursor as not shown. This is used when the text where the cursor
22319 is is about to be rewritten. */
22325 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22326 update_window_cursor (w
, 0);
22331 Display the active region described by mouse_face_* according to DRAW. */
22334 show_mouse_face (dpyinfo
, draw
)
22335 Display_Info
*dpyinfo
;
22336 enum draw_glyphs_face draw
;
22338 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22339 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22341 if (/* If window is in the process of being destroyed, don't bother
22343 w
->current_matrix
!= NULL
22344 /* Don't update mouse highlight if hidden */
22345 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22346 /* Recognize when we are called to operate on rows that don't exist
22347 anymore. This can happen when a window is split. */
22348 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22350 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22351 struct glyph_row
*row
, *first
, *last
;
22353 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22354 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22356 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22358 int start_hpos
, end_hpos
, start_x
;
22360 /* For all but the first row, the highlight starts at column 0. */
22363 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22364 start_x
= dpyinfo
->mouse_face_beg_x
;
22373 end_hpos
= dpyinfo
->mouse_face_end_col
;
22376 end_hpos
= row
->used
[TEXT_AREA
];
22377 if (draw
== DRAW_NORMAL_TEXT
)
22378 row
->fill_line_p
= 1; /* Clear to end of line */
22381 if (end_hpos
> start_hpos
)
22383 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22384 start_hpos
, end_hpos
,
22388 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22392 /* When we've written over the cursor, arrange for it to
22393 be displayed again. */
22394 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22397 display_and_set_cursor (w
, 1,
22398 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22399 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22404 /* Change the mouse cursor. */
22405 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22406 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22407 else if (draw
== DRAW_MOUSE_FACE
)
22408 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22410 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22414 Clear out the mouse-highlighted active region.
22415 Redraw it un-highlighted first. Value is non-zero if mouse
22416 face was actually drawn unhighlighted. */
22419 clear_mouse_face (dpyinfo
)
22420 Display_Info
*dpyinfo
;
22424 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22426 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22430 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22431 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22432 dpyinfo
->mouse_face_window
= Qnil
;
22433 dpyinfo
->mouse_face_overlay
= Qnil
;
22439 Non-zero if physical cursor of window W is within mouse face. */
22442 cursor_in_mouse_face_p (w
)
22445 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22446 int in_mouse_face
= 0;
22448 if (WINDOWP (dpyinfo
->mouse_face_window
)
22449 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22451 int hpos
= w
->phys_cursor
.hpos
;
22452 int vpos
= w
->phys_cursor
.vpos
;
22454 if (vpos
>= dpyinfo
->mouse_face_beg_row
22455 && vpos
<= dpyinfo
->mouse_face_end_row
22456 && (vpos
> dpyinfo
->mouse_face_beg_row
22457 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22458 && (vpos
< dpyinfo
->mouse_face_end_row
22459 || hpos
< dpyinfo
->mouse_face_end_col
22460 || dpyinfo
->mouse_face_past_end
))
22464 return in_mouse_face
;
22470 /* Find the glyph matrix position of buffer position CHARPOS in window
22471 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22472 current glyphs must be up to date. If CHARPOS is above window
22473 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22474 of last line in W. In the row containing CHARPOS, stop before glyphs
22475 having STOP as object. */
22477 #if 1 /* This is a version of fast_find_position that's more correct
22478 in the presence of hscrolling, for example. I didn't install
22479 it right away because the problem fixed is minor, it failed
22480 in 20.x as well, and I think it's too risky to install
22481 so near the release of 21.1. 2001-09-25 gerd. */
22484 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22487 int *hpos
, *vpos
, *x
, *y
;
22490 struct glyph_row
*row
, *first
;
22491 struct glyph
*glyph
, *end
;
22494 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22495 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22500 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22504 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22507 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22511 /* If whole rows or last part of a row came from a display overlay,
22512 row_containing_pos will skip over such rows because their end pos
22513 equals the start pos of the overlay or interval.
22515 Move back if we have a STOP object and previous row's
22516 end glyph came from STOP. */
22519 struct glyph_row
*prev
;
22520 while ((prev
= row
- 1, prev
>= first
)
22521 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22522 && prev
->used
[TEXT_AREA
] > 0)
22524 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22525 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22526 while (--glyph
>= beg
22527 && INTEGERP (glyph
->object
));
22529 || !EQ (stop
, glyph
->object
))
22537 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22539 glyph
= row
->glyphs
[TEXT_AREA
];
22540 end
= glyph
+ row
->used
[TEXT_AREA
];
22542 /* Skip over glyphs not having an object at the start of the row.
22543 These are special glyphs like truncation marks on terminal
22545 if (row
->displays_text_p
)
22547 && INTEGERP (glyph
->object
)
22548 && !EQ (stop
, glyph
->object
)
22549 && glyph
->charpos
< 0)
22551 *x
+= glyph
->pixel_width
;
22556 && !INTEGERP (glyph
->object
)
22557 && !EQ (stop
, glyph
->object
)
22558 && (!BUFFERP (glyph
->object
)
22559 || glyph
->charpos
< charpos
))
22561 *x
+= glyph
->pixel_width
;
22565 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22572 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22575 int *hpos
, *vpos
, *x
, *y
;
22580 int maybe_next_line_p
= 0;
22581 int line_start_position
;
22582 int yb
= window_text_bottom_y (w
);
22583 struct glyph_row
*row
, *best_row
;
22584 int row_vpos
, best_row_vpos
;
22587 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22588 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22590 while (row
->y
< yb
)
22592 if (row
->used
[TEXT_AREA
])
22593 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
22595 line_start_position
= 0;
22597 if (line_start_position
> pos
)
22599 /* If the position sought is the end of the buffer,
22600 don't include the blank lines at the bottom of the window. */
22601 else if (line_start_position
== pos
22602 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
22604 maybe_next_line_p
= 1;
22607 else if (line_start_position
> 0)
22610 best_row_vpos
= row_vpos
;
22613 if (row
->y
+ row
->height
>= yb
)
22620 /* Find the right column within BEST_ROW. */
22622 current_x
= best_row
->x
;
22623 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
22625 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
22626 int charpos
= glyph
->charpos
;
22628 if (BUFFERP (glyph
->object
))
22630 if (charpos
== pos
)
22633 *vpos
= best_row_vpos
;
22638 else if (charpos
> pos
)
22641 else if (EQ (glyph
->object
, stop
))
22646 current_x
+= glyph
->pixel_width
;
22649 /* If we're looking for the end of the buffer,
22650 and we didn't find it in the line we scanned,
22651 use the start of the following line. */
22652 if (maybe_next_line_p
)
22657 current_x
= best_row
->x
;
22660 *vpos
= best_row_vpos
;
22661 *hpos
= lastcol
+ 1;
22670 /* Find the position of the glyph for position POS in OBJECT in
22671 window W's current matrix, and return in *X, *Y the pixel
22672 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
22674 RIGHT_P non-zero means return the position of the right edge of the
22675 glyph, RIGHT_P zero means return the left edge position.
22677 If no glyph for POS exists in the matrix, return the position of
22678 the glyph with the next smaller position that is in the matrix, if
22679 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
22680 exists in the matrix, return the position of the glyph with the
22681 next larger position in OBJECT.
22683 Value is non-zero if a glyph was found. */
22686 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
22689 Lisp_Object object
;
22690 int *hpos
, *vpos
, *x
, *y
;
22693 int yb
= window_text_bottom_y (w
);
22694 struct glyph_row
*r
;
22695 struct glyph
*best_glyph
= NULL
;
22696 struct glyph_row
*best_row
= NULL
;
22699 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22700 r
->enabled_p
&& r
->y
< yb
;
22703 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
22704 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
22707 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
22708 if (EQ (g
->object
, object
))
22710 if (g
->charpos
== pos
)
22717 else if (best_glyph
== NULL
22718 || ((eabs (g
->charpos
- pos
)
22719 < eabs (best_glyph
->charpos
- pos
))
22722 : g
->charpos
> pos
)))
22736 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
22740 *x
+= best_glyph
->pixel_width
;
22745 *vpos
= best_row
- w
->current_matrix
->rows
;
22748 return best_glyph
!= NULL
;
22752 /* See if position X, Y is within a hot-spot of an image. */
22755 on_hot_spot_p (hot_spot
, x
, y
)
22756 Lisp_Object hot_spot
;
22759 if (!CONSP (hot_spot
))
22762 if (EQ (XCAR (hot_spot
), Qrect
))
22764 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
22765 Lisp_Object rect
= XCDR (hot_spot
);
22769 if (!CONSP (XCAR (rect
)))
22771 if (!CONSP (XCDR (rect
)))
22773 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
22775 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
22777 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
22779 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
22783 else if (EQ (XCAR (hot_spot
), Qcircle
))
22785 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
22786 Lisp_Object circ
= XCDR (hot_spot
);
22787 Lisp_Object lr
, lx0
, ly0
;
22789 && CONSP (XCAR (circ
))
22790 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
22791 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
22792 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
22794 double r
= XFLOATINT (lr
);
22795 double dx
= XINT (lx0
) - x
;
22796 double dy
= XINT (ly0
) - y
;
22797 return (dx
* dx
+ dy
* dy
<= r
* r
);
22800 else if (EQ (XCAR (hot_spot
), Qpoly
))
22802 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
22803 if (VECTORP (XCDR (hot_spot
)))
22805 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
22806 Lisp_Object
*poly
= v
->contents
;
22810 Lisp_Object lx
, ly
;
22813 /* Need an even number of coordinates, and at least 3 edges. */
22814 if (n
< 6 || n
& 1)
22817 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
22818 If count is odd, we are inside polygon. Pixels on edges
22819 may or may not be included depending on actual geometry of the
22821 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
22822 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
22824 x0
= XINT (lx
), y0
= XINT (ly
);
22825 for (i
= 0; i
< n
; i
+= 2)
22827 int x1
= x0
, y1
= y0
;
22828 if ((lx
= poly
[i
], !INTEGERP (lx
))
22829 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
22831 x0
= XINT (lx
), y0
= XINT (ly
);
22833 /* Does this segment cross the X line? */
22841 if (y
> y0
&& y
> y1
)
22843 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
22853 find_hot_spot (map
, x
, y
)
22857 while (CONSP (map
))
22859 if (CONSP (XCAR (map
))
22860 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
22868 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
22870 doc
: /* Lookup in image map MAP coordinates X and Y.
22871 An image map is an alist where each element has the format (AREA ID PLIST).
22872 An AREA is specified as either a rectangle, a circle, or a polygon:
22873 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
22874 pixel coordinates of the upper left and bottom right corners.
22875 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
22876 and the radius of the circle; r may be a float or integer.
22877 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
22878 vector describes one corner in the polygon.
22879 Returns the alist element for the first matching AREA in MAP. */)
22890 return find_hot_spot (map
, XINT (x
), XINT (y
));
22894 /* Display frame CURSOR, optionally using shape defined by POINTER. */
22896 define_frame_cursor1 (f
, cursor
, pointer
)
22899 Lisp_Object pointer
;
22901 /* Do not change cursor shape while dragging mouse. */
22902 if (!NILP (do_mouse_tracking
))
22905 if (!NILP (pointer
))
22907 if (EQ (pointer
, Qarrow
))
22908 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22909 else if (EQ (pointer
, Qhand
))
22910 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
22911 else if (EQ (pointer
, Qtext
))
22912 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
22913 else if (EQ (pointer
, intern ("hdrag")))
22914 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
22915 #ifdef HAVE_X_WINDOWS
22916 else if (EQ (pointer
, intern ("vdrag")))
22917 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
22919 else if (EQ (pointer
, intern ("hourglass")))
22920 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
22921 else if (EQ (pointer
, Qmodeline
))
22922 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
22924 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22927 if (cursor
!= No_Cursor
)
22928 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
22931 /* Take proper action when mouse has moved to the mode or header line
22932 or marginal area AREA of window W, x-position X and y-position Y.
22933 X is relative to the start of the text display area of W, so the
22934 width of bitmap areas and scroll bars must be subtracted to get a
22935 position relative to the start of the mode line. */
22938 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
22939 Lisp_Object window
;
22941 enum window_part area
;
22943 struct window
*w
= XWINDOW (window
);
22944 struct frame
*f
= XFRAME (w
->frame
);
22945 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22946 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
22947 Lisp_Object pointer
= Qnil
;
22948 int charpos
, dx
, dy
, width
, height
;
22949 Lisp_Object string
, object
= Qnil
;
22950 Lisp_Object pos
, help
;
22952 Lisp_Object mouse_face
;
22953 int original_x_pixel
= x
;
22954 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
22955 struct glyph_row
*row
;
22957 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
22962 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
22963 &object
, &dx
, &dy
, &width
, &height
);
22965 row
= (area
== ON_MODE_LINE
22966 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
22967 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
22970 if (row
->mode_line_p
&& row
->enabled_p
)
22972 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
22973 end
= glyph
+ row
->used
[TEXT_AREA
];
22975 for (x0
= original_x_pixel
;
22976 glyph
< end
&& x0
>= glyph
->pixel_width
;
22978 x0
-= glyph
->pixel_width
;
22986 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
22987 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
22988 &object
, &dx
, &dy
, &width
, &height
);
22993 if (IMAGEP (object
))
22995 Lisp_Object image_map
, hotspot
;
22996 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
22998 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23000 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23002 Lisp_Object area_id
, plist
;
23004 area_id
= XCAR (hotspot
);
23005 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23006 If so, we could look for mouse-enter, mouse-leave
23007 properties in PLIST (and do something...). */
23008 hotspot
= XCDR (hotspot
);
23009 if (CONSP (hotspot
)
23010 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23012 pointer
= Fplist_get (plist
, Qpointer
);
23013 if (NILP (pointer
))
23015 help
= Fplist_get (plist
, Qhelp_echo
);
23018 help_echo_string
= help
;
23019 /* Is this correct? ++kfs */
23020 XSETWINDOW (help_echo_window
, w
);
23021 help_echo_object
= w
->buffer
;
23022 help_echo_pos
= charpos
;
23026 if (NILP (pointer
))
23027 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23030 if (STRINGP (string
))
23032 pos
= make_number (charpos
);
23033 /* If we're on a string with `help-echo' text property, arrange
23034 for the help to be displayed. This is done by setting the
23035 global variable help_echo_string to the help string. */
23038 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23041 help_echo_string
= help
;
23042 XSETWINDOW (help_echo_window
, w
);
23043 help_echo_object
= string
;
23044 help_echo_pos
= charpos
;
23048 if (NILP (pointer
))
23049 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23051 /* Change the mouse pointer according to what is under X/Y. */
23052 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23055 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23056 if (!KEYMAPP (map
))
23057 map
= Fget_text_property (pos
, Qkeymap
, string
);
23058 if (!KEYMAPP (map
))
23059 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23062 /* Change the mouse face according to what is under X/Y. */
23063 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23064 if (!NILP (mouse_face
)
23065 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23070 struct glyph
* tmp_glyph
;
23074 int total_pixel_width
;
23079 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23080 Qmouse_face
, string
, Qnil
);
23082 b
= make_number (0);
23084 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23086 e
= make_number (SCHARS (string
));
23088 /* Calculate the position(glyph position: GPOS) of GLYPH in
23089 displayed string. GPOS is different from CHARPOS.
23091 CHARPOS is the position of glyph in internal string
23092 object. A mode line string format has structures which
23093 is converted to a flatten by emacs lisp interpreter.
23094 The internal string is an element of the structures.
23095 The displayed string is the flatten string. */
23097 if (glyph
> row_start_glyph
)
23099 tmp_glyph
= glyph
- 1;
23100 while (tmp_glyph
>= row_start_glyph
23101 && tmp_glyph
->charpos
>= XINT (b
)
23102 && EQ (tmp_glyph
->object
, glyph
->object
))
23109 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23110 displayed string holding GLYPH.
23112 GSEQ_LENGTH is different from SCHARS (STRING).
23113 SCHARS (STRING) returns the length of the internal string. */
23114 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23115 tmp_glyph
->charpos
< XINT (e
);
23116 tmp_glyph
++, gseq_length
++)
23118 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23122 total_pixel_width
= 0;
23123 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23124 total_pixel_width
+= tmp_glyph
->pixel_width
;
23126 /* Pre calculation of re-rendering position */
23128 hpos
= (area
== ON_MODE_LINE
23129 ? (w
->current_matrix
)->nrows
- 1
23132 /* If the re-rendering position is included in the last
23133 re-rendering area, we should do nothing. */
23134 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23135 && dpyinfo
->mouse_face_beg_col
<= vpos
23136 && vpos
< dpyinfo
->mouse_face_end_col
23137 && dpyinfo
->mouse_face_beg_row
== hpos
)
23140 if (clear_mouse_face (dpyinfo
))
23141 cursor
= No_Cursor
;
23143 dpyinfo
->mouse_face_beg_col
= vpos
;
23144 dpyinfo
->mouse_face_beg_row
= hpos
;
23146 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23147 dpyinfo
->mouse_face_beg_y
= 0;
23149 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23150 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23152 dpyinfo
->mouse_face_end_x
= 0;
23153 dpyinfo
->mouse_face_end_y
= 0;
23155 dpyinfo
->mouse_face_past_end
= 0;
23156 dpyinfo
->mouse_face_window
= window
;
23158 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23161 glyph
->face_id
, 1);
23162 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23164 if (NILP (pointer
))
23167 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23168 clear_mouse_face (dpyinfo
);
23170 define_frame_cursor1 (f
, cursor
, pointer
);
23175 Take proper action when the mouse has moved to position X, Y on
23176 frame F as regards highlighting characters that have mouse-face
23177 properties. Also de-highlighting chars where the mouse was before.
23178 X and Y can be negative or out of range. */
23181 note_mouse_highlight (f
, x
, y
)
23185 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23186 enum window_part part
;
23187 Lisp_Object window
;
23189 Cursor cursor
= No_Cursor
;
23190 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23193 /* When a menu is active, don't highlight because this looks odd. */
23194 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (MAC_OS)
23195 if (popup_activated ())
23199 if (NILP (Vmouse_highlight
)
23200 || !f
->glyphs_initialized_p
)
23203 dpyinfo
->mouse_face_mouse_x
= x
;
23204 dpyinfo
->mouse_face_mouse_y
= y
;
23205 dpyinfo
->mouse_face_mouse_frame
= f
;
23207 if (dpyinfo
->mouse_face_defer
)
23210 if (gc_in_progress
)
23212 dpyinfo
->mouse_face_deferred_gc
= 1;
23216 /* Which window is that in? */
23217 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23219 /* If we were displaying active text in another window, clear that.
23220 Also clear if we move out of text area in same window. */
23221 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23222 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23223 && !NILP (dpyinfo
->mouse_face_window
)))
23224 clear_mouse_face (dpyinfo
);
23226 /* Not on a window -> return. */
23227 if (!WINDOWP (window
))
23230 /* Reset help_echo_string. It will get recomputed below. */
23231 help_echo_string
= Qnil
;
23233 /* Convert to window-relative pixel coordinates. */
23234 w
= XWINDOW (window
);
23235 frame_to_window_pixel_xy (w
, &x
, &y
);
23237 /* Handle tool-bar window differently since it doesn't display a
23239 if (EQ (window
, f
->tool_bar_window
))
23241 note_tool_bar_highlight (f
, x
, y
);
23245 /* Mouse is on the mode, header line or margin? */
23246 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23247 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23249 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23253 if (part
== ON_VERTICAL_BORDER
)
23255 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23256 help_echo_string
= build_string ("drag-mouse-1: resize");
23258 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23259 || part
== ON_SCROLL_BAR
)
23260 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23262 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23264 /* Are we in a window whose display is up to date?
23265 And verify the buffer's text has not changed. */
23266 b
= XBUFFER (w
->buffer
);
23267 if (part
== ON_TEXT
23268 && EQ (w
->window_end_valid
, w
->buffer
)
23269 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23270 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23272 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23273 struct glyph
*glyph
;
23274 Lisp_Object object
;
23275 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23276 Lisp_Object
*overlay_vec
= NULL
;
23278 struct buffer
*obuf
;
23279 int obegv
, ozv
, same_region
;
23281 /* Find the glyph under X/Y. */
23282 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23284 /* Look for :pointer property on image. */
23285 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23287 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23288 if (img
!= NULL
&& IMAGEP (img
->spec
))
23290 Lisp_Object image_map
, hotspot
;
23291 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23293 && (hotspot
= find_hot_spot (image_map
,
23294 glyph
->slice
.x
+ dx
,
23295 glyph
->slice
.y
+ dy
),
23297 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23299 Lisp_Object area_id
, plist
;
23301 area_id
= XCAR (hotspot
);
23302 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23303 If so, we could look for mouse-enter, mouse-leave
23304 properties in PLIST (and do something...). */
23305 hotspot
= XCDR (hotspot
);
23306 if (CONSP (hotspot
)
23307 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23309 pointer
= Fplist_get (plist
, Qpointer
);
23310 if (NILP (pointer
))
23312 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23313 if (!NILP (help_echo_string
))
23315 help_echo_window
= window
;
23316 help_echo_object
= glyph
->object
;
23317 help_echo_pos
= glyph
->charpos
;
23321 if (NILP (pointer
))
23322 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23326 /* Clear mouse face if X/Y not over text. */
23328 || area
!= TEXT_AREA
23329 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23331 if (clear_mouse_face (dpyinfo
))
23332 cursor
= No_Cursor
;
23333 if (NILP (pointer
))
23335 if (area
!= TEXT_AREA
)
23336 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23338 pointer
= Vvoid_text_area_pointer
;
23343 pos
= glyph
->charpos
;
23344 object
= glyph
->object
;
23345 if (!STRINGP (object
) && !BUFFERP (object
))
23348 /* If we get an out-of-range value, return now; avoid an error. */
23349 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23352 /* Make the window's buffer temporarily current for
23353 overlays_at and compute_char_face. */
23354 obuf
= current_buffer
;
23355 current_buffer
= b
;
23361 /* Is this char mouse-active or does it have help-echo? */
23362 position
= make_number (pos
);
23364 if (BUFFERP (object
))
23366 /* Put all the overlays we want in a vector in overlay_vec. */
23367 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23368 /* Sort overlays into increasing priority order. */
23369 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23374 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23375 && vpos
>= dpyinfo
->mouse_face_beg_row
23376 && vpos
<= dpyinfo
->mouse_face_end_row
23377 && (vpos
> dpyinfo
->mouse_face_beg_row
23378 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23379 && (vpos
< dpyinfo
->mouse_face_end_row
23380 || hpos
< dpyinfo
->mouse_face_end_col
23381 || dpyinfo
->mouse_face_past_end
));
23384 cursor
= No_Cursor
;
23386 /* Check mouse-face highlighting. */
23388 /* If there exists an overlay with mouse-face overlapping
23389 the one we are currently highlighting, we have to
23390 check if we enter the overlapping overlay, and then
23391 highlight only that. */
23392 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23393 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23395 /* Find the highest priority overlay that has a mouse-face
23398 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23400 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23401 if (!NILP (mouse_face
))
23402 overlay
= overlay_vec
[i
];
23405 /* If we're actually highlighting the same overlay as
23406 before, there's no need to do that again. */
23407 if (!NILP (overlay
)
23408 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23409 goto check_help_echo
;
23411 dpyinfo
->mouse_face_overlay
= overlay
;
23413 /* Clear the display of the old active region, if any. */
23414 if (clear_mouse_face (dpyinfo
))
23415 cursor
= No_Cursor
;
23417 /* If no overlay applies, get a text property. */
23418 if (NILP (overlay
))
23419 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23421 /* Handle the overlay case. */
23422 if (!NILP (overlay
))
23424 /* Find the range of text around this char that
23425 should be active. */
23426 Lisp_Object before
, after
;
23429 before
= Foverlay_start (overlay
);
23430 after
= Foverlay_end (overlay
);
23431 /* Record this as the current active region. */
23432 fast_find_position (w
, XFASTINT (before
),
23433 &dpyinfo
->mouse_face_beg_col
,
23434 &dpyinfo
->mouse_face_beg_row
,
23435 &dpyinfo
->mouse_face_beg_x
,
23436 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23438 dpyinfo
->mouse_face_past_end
23439 = !fast_find_position (w
, XFASTINT (after
),
23440 &dpyinfo
->mouse_face_end_col
,
23441 &dpyinfo
->mouse_face_end_row
,
23442 &dpyinfo
->mouse_face_end_x
,
23443 &dpyinfo
->mouse_face_end_y
, Qnil
);
23444 dpyinfo
->mouse_face_window
= window
;
23446 dpyinfo
->mouse_face_face_id
23447 = face_at_buffer_position (w
, pos
, 0, 0,
23449 !dpyinfo
->mouse_face_hidden
);
23451 /* Display it as active. */
23452 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23453 cursor
= No_Cursor
;
23455 /* Handle the text property case. */
23456 else if (!NILP (mouse_face
) && BUFFERP (object
))
23458 /* Find the range of text around this char that
23459 should be active. */
23460 Lisp_Object before
, after
, beginning
, end
;
23463 beginning
= Fmarker_position (w
->start
);
23464 end
= make_number (BUF_Z (XBUFFER (object
))
23465 - XFASTINT (w
->window_end_pos
));
23467 = Fprevious_single_property_change (make_number (pos
+ 1),
23469 object
, beginning
);
23471 = Fnext_single_property_change (position
, Qmouse_face
,
23474 /* Record this as the current active region. */
23475 fast_find_position (w
, XFASTINT (before
),
23476 &dpyinfo
->mouse_face_beg_col
,
23477 &dpyinfo
->mouse_face_beg_row
,
23478 &dpyinfo
->mouse_face_beg_x
,
23479 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23480 dpyinfo
->mouse_face_past_end
23481 = !fast_find_position (w
, XFASTINT (after
),
23482 &dpyinfo
->mouse_face_end_col
,
23483 &dpyinfo
->mouse_face_end_row
,
23484 &dpyinfo
->mouse_face_end_x
,
23485 &dpyinfo
->mouse_face_end_y
, Qnil
);
23486 dpyinfo
->mouse_face_window
= window
;
23488 if (BUFFERP (object
))
23489 dpyinfo
->mouse_face_face_id
23490 = face_at_buffer_position (w
, pos
, 0, 0,
23492 !dpyinfo
->mouse_face_hidden
);
23494 /* Display it as active. */
23495 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23496 cursor
= No_Cursor
;
23498 else if (!NILP (mouse_face
) && STRINGP (object
))
23503 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23506 e
= Fnext_single_property_change (position
, Qmouse_face
,
23509 b
= make_number (0);
23511 e
= make_number (SCHARS (object
) - 1);
23513 fast_find_string_pos (w
, XINT (b
), object
,
23514 &dpyinfo
->mouse_face_beg_col
,
23515 &dpyinfo
->mouse_face_beg_row
,
23516 &dpyinfo
->mouse_face_beg_x
,
23517 &dpyinfo
->mouse_face_beg_y
, 0);
23518 fast_find_string_pos (w
, XINT (e
), object
,
23519 &dpyinfo
->mouse_face_end_col
,
23520 &dpyinfo
->mouse_face_end_row
,
23521 &dpyinfo
->mouse_face_end_x
,
23522 &dpyinfo
->mouse_face_end_y
, 1);
23523 dpyinfo
->mouse_face_past_end
= 0;
23524 dpyinfo
->mouse_face_window
= window
;
23525 dpyinfo
->mouse_face_face_id
23526 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23527 glyph
->face_id
, 1);
23528 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23529 cursor
= No_Cursor
;
23531 else if (STRINGP (object
) && NILP (mouse_face
))
23533 /* A string which doesn't have mouse-face, but
23534 the text ``under'' it might have. */
23535 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23536 int start
= MATRIX_ROW_START_CHARPOS (r
);
23538 pos
= string_buffer_position (w
, object
, start
);
23540 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23544 if (!NILP (mouse_face
) && !NILP (overlay
))
23546 Lisp_Object before
= Foverlay_start (overlay
);
23547 Lisp_Object after
= Foverlay_end (overlay
);
23550 /* Note that we might not be able to find position
23551 BEFORE in the glyph matrix if the overlay is
23552 entirely covered by a `display' property. In
23553 this case, we overshoot. So let's stop in
23554 the glyph matrix before glyphs for OBJECT. */
23555 fast_find_position (w
, XFASTINT (before
),
23556 &dpyinfo
->mouse_face_beg_col
,
23557 &dpyinfo
->mouse_face_beg_row
,
23558 &dpyinfo
->mouse_face_beg_x
,
23559 &dpyinfo
->mouse_face_beg_y
,
23562 dpyinfo
->mouse_face_past_end
23563 = !fast_find_position (w
, XFASTINT (after
),
23564 &dpyinfo
->mouse_face_end_col
,
23565 &dpyinfo
->mouse_face_end_row
,
23566 &dpyinfo
->mouse_face_end_x
,
23567 &dpyinfo
->mouse_face_end_y
,
23569 dpyinfo
->mouse_face_window
= window
;
23570 dpyinfo
->mouse_face_face_id
23571 = face_at_buffer_position (w
, pos
, 0, 0,
23573 !dpyinfo
->mouse_face_hidden
);
23575 /* Display it as active. */
23576 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23577 cursor
= No_Cursor
;
23584 /* Look for a `help-echo' property. */
23585 if (NILP (help_echo_string
)) {
23586 Lisp_Object help
, overlay
;
23588 /* Check overlays first. */
23589 help
= overlay
= Qnil
;
23590 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23592 overlay
= overlay_vec
[i
];
23593 help
= Foverlay_get (overlay
, Qhelp_echo
);
23598 help_echo_string
= help
;
23599 help_echo_window
= window
;
23600 help_echo_object
= overlay
;
23601 help_echo_pos
= pos
;
23605 Lisp_Object object
= glyph
->object
;
23606 int charpos
= glyph
->charpos
;
23608 /* Try text properties. */
23609 if (STRINGP (object
)
23611 && charpos
< SCHARS (object
))
23613 help
= Fget_text_property (make_number (charpos
),
23614 Qhelp_echo
, object
);
23617 /* If the string itself doesn't specify a help-echo,
23618 see if the buffer text ``under'' it does. */
23619 struct glyph_row
*r
23620 = MATRIX_ROW (w
->current_matrix
, vpos
);
23621 int start
= MATRIX_ROW_START_CHARPOS (r
);
23622 int pos
= string_buffer_position (w
, object
, start
);
23625 help
= Fget_char_property (make_number (pos
),
23626 Qhelp_echo
, w
->buffer
);
23630 object
= w
->buffer
;
23635 else if (BUFFERP (object
)
23638 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23643 help_echo_string
= help
;
23644 help_echo_window
= window
;
23645 help_echo_object
= object
;
23646 help_echo_pos
= charpos
;
23651 /* Look for a `pointer' property. */
23652 if (NILP (pointer
))
23654 /* Check overlays first. */
23655 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23656 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23658 if (NILP (pointer
))
23660 Lisp_Object object
= glyph
->object
;
23661 int charpos
= glyph
->charpos
;
23663 /* Try text properties. */
23664 if (STRINGP (object
)
23666 && charpos
< SCHARS (object
))
23668 pointer
= Fget_text_property (make_number (charpos
),
23670 if (NILP (pointer
))
23672 /* If the string itself doesn't specify a pointer,
23673 see if the buffer text ``under'' it does. */
23674 struct glyph_row
*r
23675 = MATRIX_ROW (w
->current_matrix
, vpos
);
23676 int start
= MATRIX_ROW_START_CHARPOS (r
);
23677 int pos
= string_buffer_position (w
, object
, start
);
23679 pointer
= Fget_char_property (make_number (pos
),
23680 Qpointer
, w
->buffer
);
23683 else if (BUFFERP (object
)
23686 pointer
= Fget_text_property (make_number (charpos
),
23693 current_buffer
= obuf
;
23698 define_frame_cursor1 (f
, cursor
, pointer
);
23703 Clear any mouse-face on window W. This function is part of the
23704 redisplay interface, and is called from try_window_id and similar
23705 functions to ensure the mouse-highlight is off. */
23708 x_clear_window_mouse_face (w
)
23711 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23712 Lisp_Object window
;
23715 XSETWINDOW (window
, w
);
23716 if (EQ (window
, dpyinfo
->mouse_face_window
))
23717 clear_mouse_face (dpyinfo
);
23723 Just discard the mouse face information for frame F, if any.
23724 This is used when the size of F is changed. */
23727 cancel_mouse_face (f
)
23730 Lisp_Object window
;
23731 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23733 window
= dpyinfo
->mouse_face_window
;
23734 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
23736 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23737 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23738 dpyinfo
->mouse_face_window
= Qnil
;
23743 #endif /* HAVE_WINDOW_SYSTEM */
23746 /***********************************************************************
23748 ***********************************************************************/
23750 #ifdef HAVE_WINDOW_SYSTEM
23752 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
23753 which intersects rectangle R. R is in window-relative coordinates. */
23756 expose_area (w
, row
, r
, area
)
23758 struct glyph_row
*row
;
23760 enum glyph_row_area area
;
23762 struct glyph
*first
= row
->glyphs
[area
];
23763 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
23764 struct glyph
*last
;
23765 int first_x
, start_x
, x
;
23767 if (area
== TEXT_AREA
&& row
->fill_line_p
)
23768 /* If row extends face to end of line write the whole line. */
23769 draw_glyphs (w
, 0, row
, area
,
23770 0, row
->used
[area
],
23771 DRAW_NORMAL_TEXT
, 0);
23774 /* Set START_X to the window-relative start position for drawing glyphs of
23775 AREA. The first glyph of the text area can be partially visible.
23776 The first glyphs of other areas cannot. */
23777 start_x
= window_box_left_offset (w
, area
);
23779 if (area
== TEXT_AREA
)
23782 /* Find the first glyph that must be redrawn. */
23784 && x
+ first
->pixel_width
< r
->x
)
23786 x
+= first
->pixel_width
;
23790 /* Find the last one. */
23794 && x
< r
->x
+ r
->width
)
23796 x
+= last
->pixel_width
;
23802 draw_glyphs (w
, first_x
- start_x
, row
, area
,
23803 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
23804 DRAW_NORMAL_TEXT
, 0);
23809 /* Redraw the parts of the glyph row ROW on window W intersecting
23810 rectangle R. R is in window-relative coordinates. Value is
23811 non-zero if mouse-face was overwritten. */
23814 expose_line (w
, row
, r
)
23816 struct glyph_row
*row
;
23819 xassert (row
->enabled_p
);
23821 if (row
->mode_line_p
|| w
->pseudo_window_p
)
23822 draw_glyphs (w
, 0, row
, TEXT_AREA
,
23823 0, row
->used
[TEXT_AREA
],
23824 DRAW_NORMAL_TEXT
, 0);
23827 if (row
->used
[LEFT_MARGIN_AREA
])
23828 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
23829 if (row
->used
[TEXT_AREA
])
23830 expose_area (w
, row
, r
, TEXT_AREA
);
23831 if (row
->used
[RIGHT_MARGIN_AREA
])
23832 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
23833 draw_row_fringe_bitmaps (w
, row
);
23836 return row
->mouse_face_p
;
23840 /* Redraw those parts of glyphs rows during expose event handling that
23841 overlap other rows. Redrawing of an exposed line writes over parts
23842 of lines overlapping that exposed line; this function fixes that.
23844 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
23845 row in W's current matrix that is exposed and overlaps other rows.
23846 LAST_OVERLAPPING_ROW is the last such row. */
23849 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
23851 struct glyph_row
*first_overlapping_row
;
23852 struct glyph_row
*last_overlapping_row
;
23855 struct glyph_row
*row
;
23857 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
23858 if (row
->overlapping_p
)
23860 xassert (row
->enabled_p
&& !row
->mode_line_p
);
23863 if (row
->used
[LEFT_MARGIN_AREA
])
23864 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
23866 if (row
->used
[TEXT_AREA
])
23867 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
23869 if (row
->used
[RIGHT_MARGIN_AREA
])
23870 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
23876 /* Return non-zero if W's cursor intersects rectangle R. */
23879 phys_cursor_in_rect_p (w
, r
)
23883 XRectangle cr
, result
;
23884 struct glyph
*cursor_glyph
;
23885 struct glyph_row
*row
;
23887 if (w
->phys_cursor
.vpos
>= 0
23888 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
23889 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
23891 && row
->cursor_in_fringe_p
)
23893 /* Cursor is in the fringe. */
23894 cr
.x
= window_box_right_offset (w
,
23895 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
23896 ? RIGHT_MARGIN_AREA
23899 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
23900 cr
.height
= row
->height
;
23901 return x_intersect_rectangles (&cr
, r
, &result
);
23904 cursor_glyph
= get_phys_cursor_glyph (w
);
23907 /* r is relative to W's box, but w->phys_cursor.x is relative
23908 to left edge of W's TEXT area. Adjust it. */
23909 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
23910 cr
.y
= w
->phys_cursor
.y
;
23911 cr
.width
= cursor_glyph
->pixel_width
;
23912 cr
.height
= w
->phys_cursor_height
;
23913 /* ++KFS: W32 version used W32-specific IntersectRect here, but
23914 I assume the effect is the same -- and this is portable. */
23915 return x_intersect_rectangles (&cr
, r
, &result
);
23917 /* If we don't understand the format, pretend we're not in the hot-spot. */
23923 Draw a vertical window border to the right of window W if W doesn't
23924 have vertical scroll bars. */
23927 x_draw_vertical_border (w
)
23930 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23932 /* We could do better, if we knew what type of scroll-bar the adjacent
23933 windows (on either side) have... But we don't :-(
23934 However, I think this works ok. ++KFS 2003-04-25 */
23936 /* Redraw borders between horizontally adjacent windows. Don't
23937 do it for frames with vertical scroll bars because either the
23938 right scroll bar of a window, or the left scroll bar of its
23939 neighbor will suffice as a border. */
23940 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
23943 if (!WINDOW_RIGHTMOST_P (w
)
23944 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
23946 int x0
, x1
, y0
, y1
;
23948 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23951 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23954 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
23956 else if (!WINDOW_LEFTMOST_P (w
)
23957 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
23959 int x0
, x1
, y0
, y1
;
23961 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
23964 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
23967 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
23972 /* Redraw the part of window W intersection rectangle FR. Pixel
23973 coordinates in FR are frame-relative. Call this function with
23974 input blocked. Value is non-zero if the exposure overwrites
23978 expose_window (w
, fr
)
23982 struct frame
*f
= XFRAME (w
->frame
);
23984 int mouse_face_overwritten_p
= 0;
23986 /* If window is not yet fully initialized, do nothing. This can
23987 happen when toolkit scroll bars are used and a window is split.
23988 Reconfiguring the scroll bar will generate an expose for a newly
23990 if (w
->current_matrix
== NULL
)
23993 /* When we're currently updating the window, display and current
23994 matrix usually don't agree. Arrange for a thorough display
23996 if (w
== updated_window
)
23998 SET_FRAME_GARBAGED (f
);
24002 /* Frame-relative pixel rectangle of W. */
24003 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24004 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24005 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24006 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24008 if (x_intersect_rectangles (fr
, &wr
, &r
))
24010 int yb
= window_text_bottom_y (w
);
24011 struct glyph_row
*row
;
24012 int cursor_cleared_p
;
24013 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24015 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24016 r
.x
, r
.y
, r
.width
, r
.height
));
24018 /* Convert to window coordinates. */
24019 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24020 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24022 /* Turn off the cursor. */
24023 if (!w
->pseudo_window_p
24024 && phys_cursor_in_rect_p (w
, &r
))
24026 x_clear_cursor (w
);
24027 cursor_cleared_p
= 1;
24030 cursor_cleared_p
= 0;
24032 /* Update lines intersecting rectangle R. */
24033 first_overlapping_row
= last_overlapping_row
= NULL
;
24034 for (row
= w
->current_matrix
->rows
;
24039 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24041 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24042 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24043 || (r
.y
>= y0
&& r
.y
< y1
)
24044 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24046 /* A header line may be overlapping, but there is no need
24047 to fix overlapping areas for them. KFS 2005-02-12 */
24048 if (row
->overlapping_p
&& !row
->mode_line_p
)
24050 if (first_overlapping_row
== NULL
)
24051 first_overlapping_row
= row
;
24052 last_overlapping_row
= row
;
24056 if (expose_line (w
, row
, &r
))
24057 mouse_face_overwritten_p
= 1;
24060 else if (row
->overlapping_p
)
24062 /* We must redraw a row overlapping the exposed area. */
24064 ? y0
+ row
->phys_height
> r
.y
24065 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24067 if (first_overlapping_row
== NULL
)
24068 first_overlapping_row
= row
;
24069 last_overlapping_row
= row
;
24077 /* Display the mode line if there is one. */
24078 if (WINDOW_WANTS_MODELINE_P (w
)
24079 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24081 && row
->y
< r
.y
+ r
.height
)
24083 if (expose_line (w
, row
, &r
))
24084 mouse_face_overwritten_p
= 1;
24087 if (!w
->pseudo_window_p
)
24089 /* Fix the display of overlapping rows. */
24090 if (first_overlapping_row
)
24091 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24094 /* Draw border between windows. */
24095 x_draw_vertical_border (w
);
24097 /* Turn the cursor on again. */
24098 if (cursor_cleared_p
)
24099 update_window_cursor (w
, 1);
24103 return mouse_face_overwritten_p
;
24108 /* Redraw (parts) of all windows in the window tree rooted at W that
24109 intersect R. R contains frame pixel coordinates. Value is
24110 non-zero if the exposure overwrites mouse-face. */
24113 expose_window_tree (w
, r
)
24117 struct frame
*f
= XFRAME (w
->frame
);
24118 int mouse_face_overwritten_p
= 0;
24120 while (w
&& !FRAME_GARBAGED_P (f
))
24122 if (!NILP (w
->hchild
))
24123 mouse_face_overwritten_p
24124 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24125 else if (!NILP (w
->vchild
))
24126 mouse_face_overwritten_p
24127 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24129 mouse_face_overwritten_p
|= expose_window (w
, r
);
24131 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24134 return mouse_face_overwritten_p
;
24139 Redisplay an exposed area of frame F. X and Y are the upper-left
24140 corner of the exposed rectangle. W and H are width and height of
24141 the exposed area. All are pixel values. W or H zero means redraw
24142 the entire frame. */
24145 expose_frame (f
, x
, y
, w
, h
)
24150 int mouse_face_overwritten_p
= 0;
24152 TRACE ((stderr
, "expose_frame "));
24154 /* No need to redraw if frame will be redrawn soon. */
24155 if (FRAME_GARBAGED_P (f
))
24157 TRACE ((stderr
, " garbaged\n"));
24161 /* If basic faces haven't been realized yet, there is no point in
24162 trying to redraw anything. This can happen when we get an expose
24163 event while Emacs is starting, e.g. by moving another window. */
24164 if (FRAME_FACE_CACHE (f
) == NULL
24165 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24167 TRACE ((stderr
, " no faces\n"));
24171 if (w
== 0 || h
== 0)
24174 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24175 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24185 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24186 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24188 if (WINDOWP (f
->tool_bar_window
))
24189 mouse_face_overwritten_p
24190 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24192 #ifdef HAVE_X_WINDOWS
24194 #ifndef USE_X_TOOLKIT
24195 if (WINDOWP (f
->menu_bar_window
))
24196 mouse_face_overwritten_p
24197 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24198 #endif /* not USE_X_TOOLKIT */
24202 /* Some window managers support a focus-follows-mouse style with
24203 delayed raising of frames. Imagine a partially obscured frame,
24204 and moving the mouse into partially obscured mouse-face on that
24205 frame. The visible part of the mouse-face will be highlighted,
24206 then the WM raises the obscured frame. With at least one WM, KDE
24207 2.1, Emacs is not getting any event for the raising of the frame
24208 (even tried with SubstructureRedirectMask), only Expose events.
24209 These expose events will draw text normally, i.e. not
24210 highlighted. Which means we must redo the highlight here.
24211 Subsume it under ``we love X''. --gerd 2001-08-15 */
24212 /* Included in Windows version because Windows most likely does not
24213 do the right thing if any third party tool offers
24214 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24215 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24217 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24218 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24220 int x
= dpyinfo
->mouse_face_mouse_x
;
24221 int y
= dpyinfo
->mouse_face_mouse_y
;
24222 clear_mouse_face (dpyinfo
);
24223 note_mouse_highlight (f
, x
, y
);
24230 Determine the intersection of two rectangles R1 and R2. Return
24231 the intersection in *RESULT. Value is non-zero if RESULT is not
24235 x_intersect_rectangles (r1
, r2
, result
)
24236 XRectangle
*r1
, *r2
, *result
;
24238 XRectangle
*left
, *right
;
24239 XRectangle
*upper
, *lower
;
24240 int intersection_p
= 0;
24242 /* Rearrange so that R1 is the left-most rectangle. */
24244 left
= r1
, right
= r2
;
24246 left
= r2
, right
= r1
;
24248 /* X0 of the intersection is right.x0, if this is inside R1,
24249 otherwise there is no intersection. */
24250 if (right
->x
<= left
->x
+ left
->width
)
24252 result
->x
= right
->x
;
24254 /* The right end of the intersection is the minimum of the
24255 the right ends of left and right. */
24256 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24259 /* Same game for Y. */
24261 upper
= r1
, lower
= r2
;
24263 upper
= r2
, lower
= r1
;
24265 /* The upper end of the intersection is lower.y0, if this is inside
24266 of upper. Otherwise, there is no intersection. */
24267 if (lower
->y
<= upper
->y
+ upper
->height
)
24269 result
->y
= lower
->y
;
24271 /* The lower end of the intersection is the minimum of the lower
24272 ends of upper and lower. */
24273 result
->height
= (min (lower
->y
+ lower
->height
,
24274 upper
->y
+ upper
->height
)
24276 intersection_p
= 1;
24280 return intersection_p
;
24283 #endif /* HAVE_WINDOW_SYSTEM */
24286 /***********************************************************************
24288 ***********************************************************************/
24293 Vwith_echo_area_save_vector
= Qnil
;
24294 staticpro (&Vwith_echo_area_save_vector
);
24296 Vmessage_stack
= Qnil
;
24297 staticpro (&Vmessage_stack
);
24299 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24300 staticpro (&Qinhibit_redisplay
);
24302 message_dolog_marker1
= Fmake_marker ();
24303 staticpro (&message_dolog_marker1
);
24304 message_dolog_marker2
= Fmake_marker ();
24305 staticpro (&message_dolog_marker2
);
24306 message_dolog_marker3
= Fmake_marker ();
24307 staticpro (&message_dolog_marker3
);
24310 defsubr (&Sdump_frame_glyph_matrix
);
24311 defsubr (&Sdump_glyph_matrix
);
24312 defsubr (&Sdump_glyph_row
);
24313 defsubr (&Sdump_tool_bar_row
);
24314 defsubr (&Strace_redisplay
);
24315 defsubr (&Strace_to_stderr
);
24317 #ifdef HAVE_WINDOW_SYSTEM
24318 defsubr (&Stool_bar_lines_needed
);
24319 defsubr (&Slookup_image_map
);
24321 defsubr (&Sformat_mode_line
);
24322 defsubr (&Sinvisible_p
);
24324 staticpro (&Qmenu_bar_update_hook
);
24325 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24327 staticpro (&Qoverriding_terminal_local_map
);
24328 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24330 staticpro (&Qoverriding_local_map
);
24331 Qoverriding_local_map
= intern ("overriding-local-map");
24333 staticpro (&Qwindow_scroll_functions
);
24334 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24336 staticpro (&Qwindow_text_change_functions
);
24337 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24339 staticpro (&Qredisplay_end_trigger_functions
);
24340 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24342 staticpro (&Qinhibit_point_motion_hooks
);
24343 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24345 QCdata
= intern (":data");
24346 staticpro (&QCdata
);
24347 Qdisplay
= intern ("display");
24348 staticpro (&Qdisplay
);
24349 Qspace_width
= intern ("space-width");
24350 staticpro (&Qspace_width
);
24351 Qraise
= intern ("raise");
24352 staticpro (&Qraise
);
24353 Qslice
= intern ("slice");
24354 staticpro (&Qslice
);
24355 Qspace
= intern ("space");
24356 staticpro (&Qspace
);
24357 Qmargin
= intern ("margin");
24358 staticpro (&Qmargin
);
24359 Qpointer
= intern ("pointer");
24360 staticpro (&Qpointer
);
24361 Qleft_margin
= intern ("left-margin");
24362 staticpro (&Qleft_margin
);
24363 Qright_margin
= intern ("right-margin");
24364 staticpro (&Qright_margin
);
24365 Qcenter
= intern ("center");
24366 staticpro (&Qcenter
);
24367 Qline_height
= intern ("line-height");
24368 staticpro (&Qline_height
);
24369 QCalign_to
= intern (":align-to");
24370 staticpro (&QCalign_to
);
24371 QCrelative_width
= intern (":relative-width");
24372 staticpro (&QCrelative_width
);
24373 QCrelative_height
= intern (":relative-height");
24374 staticpro (&QCrelative_height
);
24375 QCeval
= intern (":eval");
24376 staticpro (&QCeval
);
24377 QCpropertize
= intern (":propertize");
24378 staticpro (&QCpropertize
);
24379 QCfile
= intern (":file");
24380 staticpro (&QCfile
);
24381 Qfontified
= intern ("fontified");
24382 staticpro (&Qfontified
);
24383 Qfontification_functions
= intern ("fontification-functions");
24384 staticpro (&Qfontification_functions
);
24385 Qtrailing_whitespace
= intern ("trailing-whitespace");
24386 staticpro (&Qtrailing_whitespace
);
24387 Qescape_glyph
= intern ("escape-glyph");
24388 staticpro (&Qescape_glyph
);
24389 Qnobreak_space
= intern ("nobreak-space");
24390 staticpro (&Qnobreak_space
);
24391 Qimage
= intern ("image");
24392 staticpro (&Qimage
);
24393 QCmap
= intern (":map");
24394 staticpro (&QCmap
);
24395 QCpointer
= intern (":pointer");
24396 staticpro (&QCpointer
);
24397 Qrect
= intern ("rect");
24398 staticpro (&Qrect
);
24399 Qcircle
= intern ("circle");
24400 staticpro (&Qcircle
);
24401 Qpoly
= intern ("poly");
24402 staticpro (&Qpoly
);
24403 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24404 staticpro (&Qmessage_truncate_lines
);
24405 Qgrow_only
= intern ("grow-only");
24406 staticpro (&Qgrow_only
);
24407 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24408 staticpro (&Qinhibit_menubar_update
);
24409 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24410 staticpro (&Qinhibit_eval_during_redisplay
);
24411 Qposition
= intern ("position");
24412 staticpro (&Qposition
);
24413 Qbuffer_position
= intern ("buffer-position");
24414 staticpro (&Qbuffer_position
);
24415 Qobject
= intern ("object");
24416 staticpro (&Qobject
);
24417 Qbar
= intern ("bar");
24419 Qhbar
= intern ("hbar");
24420 staticpro (&Qhbar
);
24421 Qbox
= intern ("box");
24423 Qhollow
= intern ("hollow");
24424 staticpro (&Qhollow
);
24425 Qhand
= intern ("hand");
24426 staticpro (&Qhand
);
24427 Qarrow
= intern ("arrow");
24428 staticpro (&Qarrow
);
24429 Qtext
= intern ("text");
24430 staticpro (&Qtext
);
24431 Qrisky_local_variable
= intern ("risky-local-variable");
24432 staticpro (&Qrisky_local_variable
);
24433 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24434 staticpro (&Qinhibit_free_realized_faces
);
24436 list_of_error
= Fcons (Fcons (intern ("error"),
24437 Fcons (intern ("void-variable"), Qnil
)),
24439 staticpro (&list_of_error
);
24441 Qlast_arrow_position
= intern ("last-arrow-position");
24442 staticpro (&Qlast_arrow_position
);
24443 Qlast_arrow_string
= intern ("last-arrow-string");
24444 staticpro (&Qlast_arrow_string
);
24446 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24447 staticpro (&Qoverlay_arrow_string
);
24448 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24449 staticpro (&Qoverlay_arrow_bitmap
);
24451 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24452 staticpro (&echo_buffer
[0]);
24453 staticpro (&echo_buffer
[1]);
24455 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24456 staticpro (&echo_area_buffer
[0]);
24457 staticpro (&echo_area_buffer
[1]);
24459 Vmessages_buffer_name
= build_string ("*Messages*");
24460 staticpro (&Vmessages_buffer_name
);
24462 mode_line_proptrans_alist
= Qnil
;
24463 staticpro (&mode_line_proptrans_alist
);
24464 mode_line_string_list
= Qnil
;
24465 staticpro (&mode_line_string_list
);
24466 mode_line_string_face
= Qnil
;
24467 staticpro (&mode_line_string_face
);
24468 mode_line_string_face_prop
= Qnil
;
24469 staticpro (&mode_line_string_face_prop
);
24470 Vmode_line_unwind_vector
= Qnil
;
24471 staticpro (&Vmode_line_unwind_vector
);
24473 help_echo_string
= Qnil
;
24474 staticpro (&help_echo_string
);
24475 help_echo_object
= Qnil
;
24476 staticpro (&help_echo_object
);
24477 help_echo_window
= Qnil
;
24478 staticpro (&help_echo_window
);
24479 previous_help_echo_string
= Qnil
;
24480 staticpro (&previous_help_echo_string
);
24481 help_echo_pos
= -1;
24483 #ifdef HAVE_WINDOW_SYSTEM
24484 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24485 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24486 For example, if a block cursor is over a tab, it will be drawn as
24487 wide as that tab on the display. */);
24488 x_stretch_cursor_p
= 0;
24491 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24492 doc
: /* *Non-nil means highlight trailing whitespace.
24493 The face used for trailing whitespace is `trailing-whitespace'. */);
24494 Vshow_trailing_whitespace
= Qnil
;
24496 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24497 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24498 A value of t means highlight the character itself (for nobreak space,
24499 use face `nobreak-space').
24500 A value of nil means no highlighting.
24501 Other values mean display the escape glyph followed by an ordinary
24502 space or ordinary hyphen. */);
24503 Vnobreak_char_display
= Qt
;
24505 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24506 doc
: /* *The pointer shape to show in void text areas.
24507 A value of nil means to show the text pointer. Other options are `arrow',
24508 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24509 Vvoid_text_area_pointer
= Qarrow
;
24511 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24512 doc
: /* Non-nil means don't actually do any redisplay.
24513 This is used for internal purposes. */);
24514 Vinhibit_redisplay
= Qnil
;
24516 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24517 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24518 Vglobal_mode_string
= Qnil
;
24520 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24521 doc
: /* Marker for where to display an arrow on top of the buffer text.
24522 This must be the beginning of a line in order to work.
24523 See also `overlay-arrow-string'. */);
24524 Voverlay_arrow_position
= Qnil
;
24526 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24527 doc
: /* String to display as an arrow in non-window frames.
24528 See also `overlay-arrow-position'. */);
24529 Voverlay_arrow_string
= build_string ("=>");
24531 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24532 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24533 The symbols on this list are examined during redisplay to determine
24534 where to display overlay arrows. */);
24535 Voverlay_arrow_variable_list
24536 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24538 DEFVAR_INT ("scroll-step", &scroll_step
,
24539 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24540 If that fails to bring point back on frame, point is centered instead.
24541 If this is zero, point is always centered after it moves off frame.
24542 If you want scrolling to always be a line at a time, you should set
24543 `scroll-conservatively' to a large value rather than set this to 1. */);
24545 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24546 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24547 If point moves off-screen, redisplay will scroll by up to
24548 `scroll-conservatively' lines in order to bring point just barely
24549 onto the screen again. If that cannot be done, then redisplay
24550 recenters point as usual.
24552 A value of zero means always recenter point if it moves off screen. */);
24553 scroll_conservatively
= 0;
24555 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24556 doc
: /* *Number of lines of margin at the top and bottom of a window.
24557 Recenter the window whenever point gets within this many lines
24558 of the top or bottom of the window. */);
24561 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24562 doc
: /* Pixels per inch value for non-window system displays.
24563 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24564 Vdisplay_pixels_per_inch
= make_float (72.0);
24567 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24570 DEFVAR_BOOL ("truncate-partial-width-windows",
24571 &truncate_partial_width_windows
,
24572 doc
: /* *Non-nil means truncate lines in all windows less than full frame wide. */);
24573 truncate_partial_width_windows
= 1;
24575 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24576 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24577 Any other value means to use the appropriate face, `mode-line',
24578 `header-line', or `menu' respectively. */);
24579 mode_line_inverse_video
= 1;
24581 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24582 doc
: /* *Maximum buffer size for which line number should be displayed.
24583 If the buffer is bigger than this, the line number does not appear
24584 in the mode line. A value of nil means no limit. */);
24585 Vline_number_display_limit
= Qnil
;
24587 DEFVAR_INT ("line-number-display-limit-width",
24588 &line_number_display_limit_width
,
24589 doc
: /* *Maximum line width (in characters) for line number display.
24590 If the average length of the lines near point is bigger than this, then the
24591 line number may be omitted from the mode line. */);
24592 line_number_display_limit_width
= 200;
24594 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24595 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24596 highlight_nonselected_windows
= 0;
24598 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24599 doc
: /* Non-nil if more than one frame is visible on this display.
24600 Minibuffer-only frames don't count, but iconified frames do.
24601 This variable is not guaranteed to be accurate except while processing
24602 `frame-title-format' and `icon-title-format'. */);
24604 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24605 doc
: /* Template for displaying the title bar of visible frames.
24606 \(Assuming the window manager supports this feature.)
24608 This variable has the same structure as `mode-line-format', except that
24609 the %c and %l constructs are ignored. It is used only on frames for
24610 which no explicit name has been set \(see `modify-frame-parameters'). */);
24612 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24613 doc
: /* Template for displaying the title bar of an iconified frame.
24614 \(Assuming the window manager supports this feature.)
24615 This variable has the same structure as `mode-line-format' (which see),
24616 and is used only on frames for which no explicit name has been set
24617 \(see `modify-frame-parameters'). */);
24619 = Vframe_title_format
24620 = Fcons (intern ("multiple-frames"),
24621 Fcons (build_string ("%b"),
24622 Fcons (Fcons (empty_unibyte_string
,
24623 Fcons (intern ("invocation-name"),
24624 Fcons (build_string ("@"),
24625 Fcons (intern ("system-name"),
24629 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24630 doc
: /* Maximum number of lines to keep in the message log buffer.
24631 If nil, disable message logging. If t, log messages but don't truncate
24632 the buffer when it becomes large. */);
24633 Vmessage_log_max
= make_number (100);
24635 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24636 doc
: /* Functions called before redisplay, if window sizes have changed.
24637 The value should be a list of functions that take one argument.
24638 Just before redisplay, for each frame, if any of its windows have changed
24639 size since the last redisplay, or have been split or deleted,
24640 all the functions in the list are called, with the frame as argument. */);
24641 Vwindow_size_change_functions
= Qnil
;
24643 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24644 doc
: /* List of functions to call before redisplaying a window with scrolling.
24645 Each function is called with two arguments, the window
24646 and its new display-start position. Note that the value of `window-end'
24647 is not valid when these functions are called. */);
24648 Vwindow_scroll_functions
= Qnil
;
24650 DEFVAR_LISP ("window-text-change-functions",
24651 &Vwindow_text_change_functions
,
24652 doc
: /* Functions to call in redisplay when text in the window might change. */);
24653 Vwindow_text_change_functions
= Qnil
;
24655 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
24656 doc
: /* Functions called when redisplay of a window reaches the end trigger.
24657 Each function is called with two arguments, the window and the end trigger value.
24658 See `set-window-redisplay-end-trigger'. */);
24659 Vredisplay_end_trigger_functions
= Qnil
;
24661 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
24662 doc
: /* *Non-nil means autoselect window with mouse pointer.
24663 If nil, do not autoselect windows.
24664 A positive number means delay autoselection by that many seconds: a
24665 window is autoselected only after the mouse has remained in that
24666 window for the duration of the delay.
24667 A negative number has a similar effect, but causes windows to be
24668 autoselected only after the mouse has stopped moving. \(Because of
24669 the way Emacs compares mouse events, you will occasionally wait twice
24670 that time before the window gets selected.\)
24671 Any other value means to autoselect window instantaneously when the
24672 mouse pointer enters it.
24674 Autoselection selects the minibuffer only if it is active, and never
24675 unselects the minibuffer if it is active.
24677 When customizing this variable make sure that the actual value of
24678 `focus-follows-mouse' matches the behavior of your window manager. */);
24679 Vmouse_autoselect_window
= Qnil
;
24681 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
24682 doc
: /* *Non-nil means automatically resize tool-bars.
24683 This dynamically changes the tool-bar's height to the minimum height
24684 that is needed to make all tool-bar items visible.
24685 If value is `grow-only', the tool-bar's height is only increased
24686 automatically; to decrease the tool-bar height, use \\[recenter]. */);
24687 Vauto_resize_tool_bars
= Qt
;
24689 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
24690 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
24691 auto_raise_tool_bar_buttons_p
= 1;
24693 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
24694 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
24695 make_cursor_line_fully_visible_p
= 1;
24697 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
24698 doc
: /* *Border below tool-bar in pixels.
24699 If an integer, use it as the height of the border.
24700 If it is one of `internal-border-width' or `border-width', use the
24701 value of the corresponding frame parameter.
24702 Otherwise, no border is added below the tool-bar. */);
24703 Vtool_bar_border
= Qinternal_border_width
;
24705 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
24706 doc
: /* *Margin around tool-bar buttons in pixels.
24707 If an integer, use that for both horizontal and vertical margins.
24708 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
24709 HORZ specifying the horizontal margin, and VERT specifying the
24710 vertical margin. */);
24711 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
24713 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
24714 doc
: /* *Relief thickness of tool-bar buttons. */);
24715 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
24717 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
24718 doc
: /* List of functions to call to fontify regions of text.
24719 Each function is called with one argument POS. Functions must
24720 fontify a region starting at POS in the current buffer, and give
24721 fontified regions the property `fontified'. */);
24722 Vfontification_functions
= Qnil
;
24723 Fmake_variable_buffer_local (Qfontification_functions
);
24725 DEFVAR_BOOL ("unibyte-display-via-language-environment",
24726 &unibyte_display_via_language_environment
,
24727 doc
: /* *Non-nil means display unibyte text according to language environment.
24728 Specifically this means that unibyte non-ASCII characters
24729 are displayed by converting them to the equivalent multibyte characters
24730 according to the current language environment. As a result, they are
24731 displayed according to the current fontset. */);
24732 unibyte_display_via_language_environment
= 0;
24734 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
24735 doc
: /* *Maximum height for resizing mini-windows.
24736 If a float, it specifies a fraction of the mini-window frame's height.
24737 If an integer, it specifies a number of lines. */);
24738 Vmax_mini_window_height
= make_float (0.25);
24740 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
24741 doc
: /* *How to resize mini-windows.
24742 A value of nil means don't automatically resize mini-windows.
24743 A value of t means resize them to fit the text displayed in them.
24744 A value of `grow-only', the default, means let mini-windows grow
24745 only, until their display becomes empty, at which point the windows
24746 go back to their normal size. */);
24747 Vresize_mini_windows
= Qgrow_only
;
24749 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
24750 doc
: /* Alist specifying how to blink the cursor off.
24751 Each element has the form (ON-STATE . OFF-STATE). Whenever the
24752 `cursor-type' frame-parameter or variable equals ON-STATE,
24753 comparing using `equal', Emacs uses OFF-STATE to specify
24754 how to blink it off. ON-STATE and OFF-STATE are values for
24755 the `cursor-type' frame parameter.
24757 If a frame's ON-STATE has no entry in this list,
24758 the frame's other specifications determine how to blink the cursor off. */);
24759 Vblink_cursor_alist
= Qnil
;
24761 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
24762 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
24763 automatic_hscrolling_p
= 1;
24764 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
24765 staticpro (&Qauto_hscroll_mode
);
24767 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
24768 doc
: /* *How many columns away from the window edge point is allowed to get
24769 before automatic hscrolling will horizontally scroll the window. */);
24770 hscroll_margin
= 5;
24772 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
24773 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
24774 When point is less than `hscroll-margin' columns from the window
24775 edge, automatic hscrolling will scroll the window by the amount of columns
24776 determined by this variable. If its value is a positive integer, scroll that
24777 many columns. If it's a positive floating-point number, it specifies the
24778 fraction of the window's width to scroll. If it's nil or zero, point will be
24779 centered horizontally after the scroll. Any other value, including negative
24780 numbers, are treated as if the value were zero.
24782 Automatic hscrolling always moves point outside the scroll margin, so if
24783 point was more than scroll step columns inside the margin, the window will
24784 scroll more than the value given by the scroll step.
24786 Note that the lower bound for automatic hscrolling specified by `scroll-left'
24787 and `scroll-right' overrides this variable's effect. */);
24788 Vhscroll_step
= make_number (0);
24790 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
24791 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
24792 Bind this around calls to `message' to let it take effect. */);
24793 message_truncate_lines
= 0;
24795 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
24796 doc
: /* Normal hook run to update the menu bar definitions.
24797 Redisplay runs this hook before it redisplays the menu bar.
24798 This is used to update submenus such as Buffers,
24799 whose contents depend on various data. */);
24800 Vmenu_bar_update_hook
= Qnil
;
24802 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
24803 doc
: /* Frame for which we are updating a menu.
24804 The enable predicate for a menu binding should check this variable. */);
24805 Vmenu_updating_frame
= Qnil
;
24807 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
24808 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
24809 inhibit_menubar_update
= 0;
24811 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
24812 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
24813 inhibit_eval_during_redisplay
= 0;
24815 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
24816 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
24817 inhibit_free_realized_faces
= 0;
24820 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
24821 doc
: /* Inhibit try_window_id display optimization. */);
24822 inhibit_try_window_id
= 0;
24824 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
24825 doc
: /* Inhibit try_window_reusing display optimization. */);
24826 inhibit_try_window_reusing
= 0;
24828 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
24829 doc
: /* Inhibit try_cursor_movement display optimization. */);
24830 inhibit_try_cursor_movement
= 0;
24831 #endif /* GLYPH_DEBUG */
24833 DEFVAR_INT ("overline-margin", &overline_margin
,
24834 doc
: /* *Space between overline and text, in pixels.
24835 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
24836 margin to the caracter height. */);
24837 overline_margin
= 2;
24841 /* Initialize this module when Emacs starts. */
24846 Lisp_Object root_window
;
24847 struct window
*mini_w
;
24849 current_header_line_height
= current_mode_line_height
= -1;
24851 CHARPOS (this_line_start_pos
) = 0;
24853 mini_w
= XWINDOW (minibuf_window
);
24854 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
24856 if (!noninteractive
)
24858 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
24861 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
24862 set_window_height (root_window
,
24863 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
24865 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
24866 set_window_height (minibuf_window
, 1, 0);
24868 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
24869 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
24871 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
24872 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
24873 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
24875 /* The default ellipsis glyphs `...'. */
24876 for (i
= 0; i
< 3; ++i
)
24877 default_invis_vector
[i
] = make_number ('.');
24881 /* Allocate the buffer for frame titles.
24882 Also used for `format-mode-line'. */
24884 mode_line_noprop_buf
= (char *) xmalloc (size
);
24885 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
24886 mode_line_noprop_ptr
= mode_line_noprop_buf
;
24887 mode_line_target
= MODE_LINE_DISPLAY
;
24890 help_echo_showing_p
= 0;
24894 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
24895 (do not change this comment) */