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 of the License, or
11 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code. (Or,
35 let's say almost---see the description of direct update
38 The following diagram shows how redisplay code is invoked. As you
39 can see, Lisp calls redisplay and vice versa. Under window systems
40 like X, some portions of the redisplay code are also called
41 asynchronously during mouse movement or expose events. It is very
42 important that these code parts do NOT use the C library (malloc,
43 free) because many C libraries under Unix are not reentrant. They
44 may also NOT call functions of the Lisp interpreter which could
45 change the interpreter's state. If you don't follow these rules,
46 you will encounter bugs which are very hard to explain.
48 (Direct functions, see below)
49 direct_output_for_insert,
50 direct_forward_char (dispnew.c)
51 +---------------------------------+
54 +--------------+ redisplay +----------------+
55 | Lisp machine |---------------->| Redisplay code |<--+
56 +--------------+ (xdisp.c) +----------------+ |
58 +----------------------------------+ |
59 Don't use this path when called |
62 expose_window (asynchronous) |
64 X expose events -----+
66 What does redisplay do? Obviously, it has to figure out somehow what
67 has been changed since the last time the display has been updated,
68 and to make these changes visible. Preferably it would do that in
69 a moderately intelligent way, i.e. fast.
71 Changes in buffer text can be deduced from window and buffer
72 structures, and from some global variables like `beg_unchanged' and
73 `end_unchanged'. The contents of the display are additionally
74 recorded in a `glyph matrix', a two-dimensional matrix of glyph
75 structures. Each row in such a matrix corresponds to a line on the
76 display, and each glyph in a row corresponds to a column displaying
77 a character, an image, or what else. This matrix is called the
78 `current glyph matrix' or `current matrix' in redisplay
81 For buffer parts that have been changed since the last update, a
82 second glyph matrix is constructed, the so called `desired glyph
83 matrix' or short `desired matrix'. Current and desired matrix are
84 then compared to find a cheap way to update the display, e.g. by
85 reusing part of the display by scrolling lines.
90 You will find a lot of redisplay optimizations when you start
91 looking at the innards of redisplay. The overall goal of all these
92 optimizations is to make redisplay fast because it is done
95 Two optimizations are not found in xdisp.c. These are the direct
96 operations mentioned above. As the name suggests they follow a
97 different principle than the rest of redisplay. Instead of
98 building a desired matrix and then comparing it with the current
99 display, they perform their actions directly on the display and on
102 One direct operation updates the display after one character has
103 been entered. The other one moves the cursor by one position
104 forward or backward. You find these functions under the names
105 `direct_output_for_insert' and `direct_output_forward_char' in
111 Desired matrices are always built per Emacs window. The function
112 `display_line' is the central function to look at if you are
113 interested. It constructs one row in a desired matrix given an
114 iterator structure containing both a buffer position and a
115 description of the environment in which the text is to be
116 displayed. But this is too early, read on.
118 Characters and pixmaps displayed for a range of buffer text depend
119 on various settings of buffers and windows, on overlays and text
120 properties, on display tables, on selective display. The good news
121 is that all this hairy stuff is hidden behind a small set of
122 interface functions taking an iterator structure (struct it)
125 Iteration over things to be displayed is then simple. It is
126 started by initializing an iterator with a call to init_iterator.
127 Calls to get_next_display_element fill the iterator structure with
128 relevant information about the next thing to display. Calls to
129 set_iterator_to_next move the iterator to the next thing.
131 Besides this, an iterator also contains information about the
132 display environment in which glyphs for display elements are to be
133 produced. It has fields for the width and height of the display,
134 the information whether long lines are truncated or continued, a
135 current X and Y position, and lots of other stuff you can better
138 Glyphs in a desired matrix are normally constructed in a loop
139 calling get_next_display_element and then produce_glyphs. The call
140 to produce_glyphs will fill the iterator structure with pixel
141 information about the element being displayed and at the same time
142 produce glyphs for it. If the display element fits on the line
143 being displayed, set_iterator_to_next is called next, otherwise the
144 glyphs produced are discarded.
149 That just couldn't be all, could it? What about terminal types not
150 supporting operations on sub-windows of the screen? To update the
151 display on such a terminal, window-based glyph matrices are not
152 well suited. To be able to reuse part of the display (scrolling
153 lines up and down), we must instead have a view of the whole
154 screen. This is what `frame matrices' are for. They are a trick.
156 Frames on terminals like above have a glyph pool. Windows on such
157 a frame sub-allocate their glyph memory from their frame's glyph
158 pool. The frame itself is given its own glyph matrices. By
159 coincidence---or maybe something else---rows in window glyph
160 matrices are slices of corresponding rows in frame matrices. Thus
161 writing to window matrices implicitly updates a frame matrix which
162 provides us with the view of the whole screen that we originally
163 wanted to have without having to move many bytes around. To be
164 honest, there is a little bit more done, but not much more. If you
165 plan to extend that code, take a look at dispnew.c. The function
166 build_frame_matrix is a good starting point. */
173 #include "keyboard.h"
176 #include "termchar.h"
177 #include "dispextern.h"
179 #include "character.h"
182 #include "commands.h"
186 #include "termhooks.h"
187 #include "intervals.h"
190 #include "region-cache.h"
193 #include "blockinput.h"
195 #ifdef HAVE_X_WINDOWS
210 #ifndef FRAME_X_OUTPUT
211 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
214 #define INFINITY 10000000
216 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
217 || defined(HAVE_NS) || defined (USE_GTK)
218 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
219 extern int pending_menu_activation
;
222 extern int interrupt_input
;
223 extern int command_loop_level
;
225 extern Lisp_Object do_mouse_tracking
;
227 extern int minibuffer_auto_raise
;
228 extern Lisp_Object Vminibuffer_list
;
230 extern Lisp_Object Qface
;
231 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
233 extern Lisp_Object Voverriding_local_map
;
234 extern Lisp_Object Voverriding_local_map_menu_flag
;
235 extern Lisp_Object Qmenu_item
;
236 extern Lisp_Object Qwhen
;
237 extern Lisp_Object Qhelp_echo
;
239 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
240 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
241 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
242 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
243 Lisp_Object Qinhibit_point_motion_hooks
;
244 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
245 Lisp_Object Qfontified
;
246 Lisp_Object Qgrow_only
;
247 Lisp_Object Qinhibit_eval_during_redisplay
;
248 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
251 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
254 Lisp_Object Qarrow
, Qhand
, Qtext
;
256 Lisp_Object Qrisky_local_variable
;
258 /* Holds the list (error). */
259 Lisp_Object list_of_error
;
261 /* Functions called to fontify regions of text. */
263 Lisp_Object Vfontification_functions
;
264 Lisp_Object Qfontification_functions
;
266 /* Non-nil means automatically select any window when the mouse
267 cursor moves into it. */
268 Lisp_Object Vmouse_autoselect_window
;
270 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
271 Lisp_Object Vline_prefix
, Qline_prefix
;
273 /* Non-zero means draw tool bar buttons raised when the mouse moves
276 int auto_raise_tool_bar_buttons_p
;
278 /* Non-zero means to reposition window if cursor line is only partially visible. */
280 int make_cursor_line_fully_visible_p
;
282 /* Margin below tool bar in pixels. 0 or nil means no margin.
283 If value is `internal-border-width' or `border-width',
284 the corresponding frame parameter is used. */
286 Lisp_Object Vtool_bar_border
;
288 /* Margin around tool bar buttons in pixels. */
290 Lisp_Object Vtool_bar_button_margin
;
292 /* Thickness of shadow to draw around tool bar buttons. */
294 EMACS_INT tool_bar_button_relief
;
296 /* Non-nil means automatically resize tool-bars so that all tool-bar
297 items are visible, and no blank lines remain.
299 If value is `grow-only', only make tool-bar bigger. */
301 Lisp_Object Vauto_resize_tool_bars
;
303 /* Non-zero means draw block and hollow cursor as wide as the glyph
304 under it. For example, if a block cursor is over a tab, it will be
305 drawn as wide as that tab on the display. */
307 int x_stretch_cursor_p
;
309 /* Non-nil means don't actually do any redisplay. */
311 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
313 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
315 int inhibit_eval_during_redisplay
;
317 /* Names of text properties relevant for redisplay. */
319 Lisp_Object Qdisplay
;
320 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
322 /* Symbols used in text property values. */
324 Lisp_Object Vdisplay_pixels_per_inch
;
325 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
326 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
329 Lisp_Object Qmargin
, Qpointer
;
330 Lisp_Object Qline_height
;
331 extern Lisp_Object Qheight
;
332 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
333 extern Lisp_Object Qscroll_bar
;
334 extern Lisp_Object Qcursor
;
336 /* Non-nil means highlight trailing whitespace. */
338 Lisp_Object Vshow_trailing_whitespace
;
340 /* Non-nil means escape non-break space and hyphens. */
342 Lisp_Object Vnobreak_char_display
;
344 #ifdef HAVE_WINDOW_SYSTEM
345 extern Lisp_Object Voverflow_newline_into_fringe
;
347 /* Test if overflow newline into fringe. Called with iterator IT
348 at or past right window margin, and with IT->current_x set. */
350 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
351 (!NILP (Voverflow_newline_into_fringe) \
352 && FRAME_WINDOW_P (it->f) \
353 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
354 && it->current_x == it->last_visible_x \
355 && it->line_wrap != WORD_WRAP)
357 #endif /* HAVE_WINDOW_SYSTEM */
359 /* Test if the display element loaded in IT is a space or tab
360 character. This is used to determine word wrapping. */
362 #define IT_DISPLAYING_WHITESPACE(it) \
363 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
365 /* Non-nil means show the text cursor in void text areas
366 i.e. in blank areas after eol and eob. This used to be
367 the default in 21.3. */
369 Lisp_Object Vvoid_text_area_pointer
;
371 /* Name of the face used to highlight trailing whitespace. */
373 Lisp_Object Qtrailing_whitespace
;
375 /* Name and number of the face used to highlight escape glyphs. */
377 Lisp_Object Qescape_glyph
;
379 /* Name and number of the face used to highlight non-breaking spaces. */
381 Lisp_Object Qnobreak_space
;
383 /* The symbol `image' which is the car of the lists used to represent
388 /* The image map types. */
389 Lisp_Object QCmap
, QCpointer
;
390 Lisp_Object Qrect
, Qcircle
, Qpoly
;
392 /* Non-zero means print newline to stdout before next mini-buffer
395 int noninteractive_need_newline
;
397 /* Non-zero means print newline to message log before next message. */
399 static int message_log_need_newline
;
401 /* Three markers that message_dolog uses.
402 It could allocate them itself, but that causes trouble
403 in handling memory-full errors. */
404 static Lisp_Object message_dolog_marker1
;
405 static Lisp_Object message_dolog_marker2
;
406 static Lisp_Object message_dolog_marker3
;
408 /* The buffer position of the first character appearing entirely or
409 partially on the line of the selected window which contains the
410 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
411 redisplay optimization in redisplay_internal. */
413 static struct text_pos this_line_start_pos
;
415 /* Number of characters past the end of the line above, including the
416 terminating newline. */
418 static struct text_pos this_line_end_pos
;
420 /* The vertical positions and the height of this line. */
422 static int this_line_vpos
;
423 static int this_line_y
;
424 static int this_line_pixel_height
;
426 /* X position at which this display line starts. Usually zero;
427 negative if first character is partially visible. */
429 static int this_line_start_x
;
431 /* Buffer that this_line_.* variables are referring to. */
433 static struct buffer
*this_line_buffer
;
435 /* Nonzero means truncate lines in all windows less wide than the
438 Lisp_Object Vtruncate_partial_width_windows
;
440 /* A flag to control how to display unibyte 8-bit character. */
442 int unibyte_display_via_language_environment
;
444 /* Nonzero means we have more than one non-mini-buffer-only frame.
445 Not guaranteed to be accurate except while parsing
446 frame-title-format. */
450 Lisp_Object Vglobal_mode_string
;
453 /* List of variables (symbols) which hold markers for overlay arrows.
454 The symbols on this list are examined during redisplay to determine
455 where to display overlay arrows. */
457 Lisp_Object Voverlay_arrow_variable_list
;
459 /* Marker for where to display an arrow on top of the buffer text. */
461 Lisp_Object Voverlay_arrow_position
;
463 /* String to display for the arrow. Only used on terminal frames. */
465 Lisp_Object Voverlay_arrow_string
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 /* Like mode-line-format, but for the title bar on a visible frame. */
481 Lisp_Object Vframe_title_format
;
483 /* Like mode-line-format, but for the title bar on an iconified frame. */
485 Lisp_Object Vicon_title_format
;
487 /* List of functions to call when a window's size changes. These
488 functions get one arg, a frame on which one or more windows' sizes
491 static Lisp_Object Vwindow_size_change_functions
;
493 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
495 /* Nonzero if an overlay arrow has been displayed in this window. */
497 static int overlay_arrow_seen
;
499 /* Nonzero means highlight the region even in nonselected windows. */
501 int highlight_nonselected_windows
;
503 /* If cursor motion alone moves point off frame, try scrolling this
504 many lines up or down if that will bring it back. */
506 static EMACS_INT scroll_step
;
508 /* Nonzero means scroll just far enough to bring point back on the
509 screen, when appropriate. */
511 static EMACS_INT scroll_conservatively
;
513 /* Recenter the window whenever point gets within this many lines of
514 the top or bottom of the window. This value is translated into a
515 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
516 that there is really a fixed pixel height scroll margin. */
518 EMACS_INT scroll_margin
;
520 /* Number of windows showing the buffer of the selected window (or
521 another buffer with the same base buffer). keyboard.c refers to
526 /* Vector containing glyphs for an ellipsis `...'. */
528 static Lisp_Object default_invis_vector
[3];
530 /* Zero means display the mode-line/header-line/menu-bar in the default face
531 (this slightly odd definition is for compatibility with previous versions
532 of emacs), non-zero means display them using their respective faces.
534 This variable is deprecated. */
536 int mode_line_inverse_video
;
538 /* Prompt to display in front of the mini-buffer contents. */
540 Lisp_Object minibuf_prompt
;
542 /* Width of current mini-buffer prompt. Only set after display_line
543 of the line that contains the prompt. */
545 int minibuf_prompt_width
;
547 /* This is the window where the echo area message was displayed. It
548 is always a mini-buffer window, but it may not be the same window
549 currently active as a mini-buffer. */
551 Lisp_Object echo_area_window
;
553 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
554 pushes the current message and the value of
555 message_enable_multibyte on the stack, the function restore_message
556 pops the stack and displays MESSAGE again. */
558 Lisp_Object Vmessage_stack
;
560 /* Nonzero means multibyte characters were enabled when the echo area
561 message was specified. */
563 int message_enable_multibyte
;
565 /* Nonzero if we should redraw the mode lines on the next redisplay. */
567 int update_mode_lines
;
569 /* Nonzero if window sizes or contents have changed since last
570 redisplay that finished. */
572 int windows_or_buffers_changed
;
574 /* Nonzero means a frame's cursor type has been changed. */
576 int cursor_type_changed
;
578 /* Nonzero after display_mode_line if %l was used and it displayed a
581 int line_number_displayed
;
583 /* Maximum buffer size for which to display line numbers. */
585 Lisp_Object Vline_number_display_limit
;
587 /* Line width to consider when repositioning for line number display. */
589 static EMACS_INT line_number_display_limit_width
;
591 /* Number of lines to keep in the message log buffer. t means
592 infinite. nil means don't log at all. */
594 Lisp_Object Vmessage_log_max
;
596 /* The name of the *Messages* buffer, a string. */
598 static Lisp_Object Vmessages_buffer_name
;
600 /* Current, index 0, and last displayed echo area message. Either
601 buffers from echo_buffers, or nil to indicate no message. */
603 Lisp_Object echo_area_buffer
[2];
605 /* The buffers referenced from echo_area_buffer. */
607 static Lisp_Object echo_buffer
[2];
609 /* A vector saved used in with_area_buffer to reduce consing. */
611 static Lisp_Object Vwith_echo_area_save_vector
;
613 /* Non-zero means display_echo_area should display the last echo area
614 message again. Set by redisplay_preserve_echo_area. */
616 static int display_last_displayed_message_p
;
618 /* Nonzero if echo area is being used by print; zero if being used by
621 int message_buf_print
;
623 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
625 Lisp_Object Qinhibit_menubar_update
;
626 int inhibit_menubar_update
;
628 /* When evaluating expressions from menu bar items (enable conditions,
629 for instance), this is the frame they are being processed for. */
631 Lisp_Object Vmenu_updating_frame
;
633 /* Maximum height for resizing mini-windows. Either a float
634 specifying a fraction of the available height, or an integer
635 specifying a number of lines. */
637 Lisp_Object Vmax_mini_window_height
;
639 /* Non-zero means messages should be displayed with truncated
640 lines instead of being continued. */
642 int message_truncate_lines
;
643 Lisp_Object Qmessage_truncate_lines
;
645 /* Set to 1 in clear_message to make redisplay_internal aware
646 of an emptied echo area. */
648 static int message_cleared_p
;
650 /* How to blink the default frame cursor off. */
651 Lisp_Object Vblink_cursor_alist
;
653 /* A scratch glyph row with contents used for generating truncation
654 glyphs. Also used in direct_output_for_insert. */
656 #define MAX_SCRATCH_GLYPHS 100
657 struct glyph_row scratch_glyph_row
;
658 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
660 /* Ascent and height of the last line processed by move_it_to. */
662 static int last_max_ascent
, last_height
;
664 /* Non-zero if there's a help-echo in the echo area. */
666 int help_echo_showing_p
;
668 /* If >= 0, computed, exact values of mode-line and header-line height
669 to use in the macros CURRENT_MODE_LINE_HEIGHT and
670 CURRENT_HEADER_LINE_HEIGHT. */
672 int current_mode_line_height
, current_header_line_height
;
674 /* The maximum distance to look ahead for text properties. Values
675 that are too small let us call compute_char_face and similar
676 functions too often which is expensive. Values that are too large
677 let us call compute_char_face and alike too often because we
678 might not be interested in text properties that far away. */
680 #define TEXT_PROP_DISTANCE_LIMIT 100
684 /* Variables to turn off display optimizations from Lisp. */
686 int inhibit_try_window_id
, inhibit_try_window_reusing
;
687 int inhibit_try_cursor_movement
;
689 /* Non-zero means print traces of redisplay if compiled with
692 int trace_redisplay_p
;
694 #endif /* GLYPH_DEBUG */
696 #ifdef DEBUG_TRACE_MOVE
697 /* Non-zero means trace with TRACE_MOVE to stderr. */
700 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
702 #define TRACE_MOVE(x) (void) 0
705 /* Non-zero means automatically scroll windows horizontally to make
708 int automatic_hscrolling_p
;
709 Lisp_Object Qauto_hscroll_mode
;
711 /* How close to the margin can point get before the window is scrolled
713 EMACS_INT hscroll_margin
;
715 /* How much to scroll horizontally when point is inside the above margin. */
716 Lisp_Object Vhscroll_step
;
718 /* The variable `resize-mini-windows'. If nil, don't resize
719 mini-windows. If t, always resize them to fit the text they
720 display. If `grow-only', let mini-windows grow only until they
723 Lisp_Object Vresize_mini_windows
;
725 /* Buffer being redisplayed -- for redisplay_window_error. */
727 struct buffer
*displayed_buffer
;
729 /* Space between overline and text. */
731 EMACS_INT overline_margin
;
733 /* Require underline to be at least this many screen pixels below baseline
734 This to avoid underline "merging" with the base of letters at small
735 font sizes, particularly when x_use_underline_position_properties is on. */
737 EMACS_INT underline_minimum_offset
;
739 /* Value returned from text property handlers (see below). */
744 HANDLED_RECOMPUTE_PROPS
,
745 HANDLED_OVERLAY_STRING_CONSUMED
,
749 /* A description of text properties that redisplay is interested
754 /* The name of the property. */
757 /* A unique index for the property. */
760 /* A handler function called to set up iterator IT from the property
761 at IT's current position. Value is used to steer handle_stop. */
762 enum prop_handled (*handler
) P_ ((struct it
*it
));
765 static enum prop_handled handle_face_prop
P_ ((struct it
*));
766 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
767 static enum prop_handled handle_display_prop
P_ ((struct it
*));
768 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
769 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
770 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
772 /* Properties handled by iterators. */
774 static struct props it_props
[] =
776 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
777 /* Handle `face' before `display' because some sub-properties of
778 `display' need to know the face. */
779 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
780 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
781 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
782 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
786 /* Value is the position described by X. If X is a marker, value is
787 the marker_position of X. Otherwise, value is X. */
789 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
791 /* Enumeration returned by some move_it_.* functions internally. */
795 /* Not used. Undefined value. */
798 /* Move ended at the requested buffer position or ZV. */
799 MOVE_POS_MATCH_OR_ZV
,
801 /* Move ended at the requested X pixel position. */
804 /* Move within a line ended at the end of a line that must be
808 /* Move within a line ended at the end of a line that would
809 be displayed truncated. */
812 /* Move within a line ended at a line end. */
816 /* This counter is used to clear the face cache every once in a while
817 in redisplay_internal. It is incremented for each redisplay.
818 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
821 #define CLEAR_FACE_CACHE_COUNT 500
822 static int clear_face_cache_count
;
824 /* Similarly for the image cache. */
826 #ifdef HAVE_WINDOW_SYSTEM
827 #define CLEAR_IMAGE_CACHE_COUNT 101
828 static int clear_image_cache_count
;
831 /* Non-zero while redisplay_internal is in progress. */
835 /* Non-zero means don't free realized faces. Bound while freeing
836 realized faces is dangerous because glyph matrices might still
839 int inhibit_free_realized_faces
;
840 Lisp_Object Qinhibit_free_realized_faces
;
842 /* If a string, XTread_socket generates an event to display that string.
843 (The display is done in read_char.) */
845 Lisp_Object help_echo_string
;
846 Lisp_Object help_echo_window
;
847 Lisp_Object help_echo_object
;
850 /* Temporary variable for XTread_socket. */
852 Lisp_Object previous_help_echo_string
;
854 /* Null glyph slice */
856 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
858 /* Platform-independent portion of hourglass implementation. */
860 /* Non-zero means we're allowed to display a hourglass pointer. */
861 int display_hourglass_p
;
863 /* Non-zero means an hourglass cursor is currently shown. */
864 int hourglass_shown_p
;
866 /* If non-null, an asynchronous timer that, when it expires, displays
867 an hourglass cursor on all frames. */
868 struct atimer
*hourglass_atimer
;
870 /* Number of seconds to wait before displaying an hourglass cursor. */
871 Lisp_Object Vhourglass_delay
;
873 /* Default number of seconds to wait before displaying an hourglass
875 #define DEFAULT_HOURGLASS_DELAY 1
878 /* Function prototypes. */
880 static void setup_for_ellipsis
P_ ((struct it
*, int));
881 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
882 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
883 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
884 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
885 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
886 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
888 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
890 static void handle_line_prefix
P_ ((struct it
*));
892 static void pint2str
P_ ((char *, int, int));
893 static void pint2hrstr
P_ ((char *, int, int));
894 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
896 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
897 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
898 static void store_mode_line_noprop_char
P_ ((char));
899 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
900 static void x_consider_frame_title
P_ ((Lisp_Object
));
901 static void handle_stop
P_ ((struct it
*));
902 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
903 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
904 static void ensure_echo_area_buffers
P_ ((void));
905 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
906 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
907 static int with_echo_area_buffer
P_ ((struct window
*, int,
908 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
909 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
910 static void clear_garbaged_frames
P_ ((void));
911 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
912 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
913 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
914 static int display_echo_area
P_ ((struct window
*));
915 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
916 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
917 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
918 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
919 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
921 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
922 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
923 static void insert_left_trunc_glyphs
P_ ((struct it
*));
924 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
926 static void extend_face_to_end_of_line
P_ ((struct it
*));
927 static int append_space_for_newline
P_ ((struct it
*, int));
928 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
929 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
930 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
931 static int trailing_whitespace_p
P_ ((int));
932 static int message_log_check_duplicate
P_ ((int, int, int, int));
933 static void push_it
P_ ((struct it
*));
934 static void pop_it
P_ ((struct it
*));
935 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
936 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
937 static void redisplay_internal
P_ ((int));
938 static int echo_area_display
P_ ((int));
939 static void redisplay_windows
P_ ((Lisp_Object
));
940 static void redisplay_window
P_ ((Lisp_Object
, int));
941 static Lisp_Object
redisplay_window_error ();
942 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
943 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
944 static int update_menu_bar
P_ ((struct frame
*, int, int));
945 static int try_window_reusing_current_matrix
P_ ((struct window
*));
946 static int try_window_id
P_ ((struct window
*));
947 static int display_line
P_ ((struct it
*));
948 static int display_mode_lines
P_ ((struct window
*));
949 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
950 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
951 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
952 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
953 static void display_menu_bar
P_ ((struct window
*));
954 static int display_count_lines
P_ ((int, int, int, int, int *));
955 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
956 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
957 static void compute_line_metrics
P_ ((struct it
*));
958 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
959 static int get_overlay_strings
P_ ((struct it
*, int));
960 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
961 static void next_overlay_string
P_ ((struct it
*));
962 static void reseat
P_ ((struct it
*, struct text_pos
, int));
963 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
964 static void back_to_previous_visible_line_start
P_ ((struct it
*));
965 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
966 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
967 static int next_element_from_ellipsis
P_ ((struct it
*));
968 static int next_element_from_display_vector
P_ ((struct it
*));
969 static int next_element_from_string
P_ ((struct it
*));
970 static int next_element_from_c_string
P_ ((struct it
*));
971 static int next_element_from_buffer
P_ ((struct it
*));
972 static int next_element_from_composition
P_ ((struct it
*));
973 static int next_element_from_image
P_ ((struct it
*));
974 static int next_element_from_stretch
P_ ((struct it
*));
975 static void load_overlay_strings
P_ ((struct it
*, int));
976 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
977 struct display_pos
*));
978 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
979 Lisp_Object
, int, int, int, int));
980 static enum move_it_result
981 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
982 enum move_operation_enum
);
983 void move_it_vertically_backward
P_ ((struct it
*, int));
984 static void init_to_row_start
P_ ((struct it
*, struct window
*,
985 struct glyph_row
*));
986 static int init_to_row_end
P_ ((struct it
*, struct window
*,
987 struct glyph_row
*));
988 static void back_to_previous_line_start
P_ ((struct it
*));
989 static int forward_to_next_line_start
P_ ((struct it
*, int *));
990 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
992 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
993 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
994 static int number_of_chars
P_ ((unsigned char *, int));
995 static void compute_stop_pos
P_ ((struct it
*));
996 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
998 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
999 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
1000 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
1001 Lisp_Object
, Lisp_Object
,
1002 struct text_pos
*, int));
1003 static int underlying_face_id
P_ ((struct it
*));
1004 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
1007 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1008 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1010 #ifdef HAVE_WINDOW_SYSTEM
1012 static void update_tool_bar
P_ ((struct frame
*, int));
1013 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
1014 static int redisplay_tool_bar
P_ ((struct frame
*));
1015 static void display_tool_bar_line
P_ ((struct it
*, int));
1016 static void notice_overwritten_cursor
P_ ((struct window
*,
1017 enum glyph_row_area
,
1018 int, int, int, int));
1022 #endif /* HAVE_WINDOW_SYSTEM */
1025 /***********************************************************************
1026 Window display dimensions
1027 ***********************************************************************/
1029 /* Return the bottom boundary y-position for text lines in window W.
1030 This is the first y position at which a line cannot start.
1031 It is relative to the top of the window.
1033 This is the height of W minus the height of a mode line, if any. */
1036 window_text_bottom_y (w
)
1039 int height
= WINDOW_TOTAL_HEIGHT (w
);
1041 if (WINDOW_WANTS_MODELINE_P (w
))
1042 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1046 /* Return the pixel width of display area AREA of window W. AREA < 0
1047 means return the total width of W, not including fringes to
1048 the left and right of the window. */
1051 window_box_width (w
, area
)
1055 int cols
= XFASTINT (w
->total_cols
);
1058 if (!w
->pseudo_window_p
)
1060 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1062 if (area
== TEXT_AREA
)
1064 if (INTEGERP (w
->left_margin_cols
))
1065 cols
-= XFASTINT (w
->left_margin_cols
);
1066 if (INTEGERP (w
->right_margin_cols
))
1067 cols
-= XFASTINT (w
->right_margin_cols
);
1068 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1070 else if (area
== LEFT_MARGIN_AREA
)
1072 cols
= (INTEGERP (w
->left_margin_cols
)
1073 ? XFASTINT (w
->left_margin_cols
) : 0);
1076 else if (area
== RIGHT_MARGIN_AREA
)
1078 cols
= (INTEGERP (w
->right_margin_cols
)
1079 ? XFASTINT (w
->right_margin_cols
) : 0);
1084 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1088 /* Return the pixel height of the display area of window W, not
1089 including mode lines of W, if any. */
1092 window_box_height (w
)
1095 struct frame
*f
= XFRAME (w
->frame
);
1096 int height
= WINDOW_TOTAL_HEIGHT (w
);
1098 xassert (height
>= 0);
1100 /* Note: the code below that determines the mode-line/header-line
1101 height is essentially the same as that contained in the macro
1102 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1103 the appropriate glyph row has its `mode_line_p' flag set,
1104 and if it doesn't, uses estimate_mode_line_height instead. */
1106 if (WINDOW_WANTS_MODELINE_P (w
))
1108 struct glyph_row
*ml_row
1109 = (w
->current_matrix
&& w
->current_matrix
->rows
1110 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1112 if (ml_row
&& ml_row
->mode_line_p
)
1113 height
-= ml_row
->height
;
1115 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1118 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1120 struct glyph_row
*hl_row
1121 = (w
->current_matrix
&& w
->current_matrix
->rows
1122 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1124 if (hl_row
&& hl_row
->mode_line_p
)
1125 height
-= hl_row
->height
;
1127 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1130 /* With a very small font and a mode-line that's taller than
1131 default, we might end up with a negative height. */
1132 return max (0, height
);
1135 /* Return the window-relative coordinate of the left edge of display
1136 area AREA of window W. AREA < 0 means return the left edge of the
1137 whole window, to the right of the left fringe of W. */
1140 window_box_left_offset (w
, area
)
1146 if (w
->pseudo_window_p
)
1149 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1151 if (area
== TEXT_AREA
)
1152 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1153 + window_box_width (w
, LEFT_MARGIN_AREA
));
1154 else if (area
== RIGHT_MARGIN_AREA
)
1155 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1156 + window_box_width (w
, LEFT_MARGIN_AREA
)
1157 + window_box_width (w
, TEXT_AREA
)
1158 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1160 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1161 else if (area
== LEFT_MARGIN_AREA
1162 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1163 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1169 /* Return the window-relative coordinate of the right edge of display
1170 area AREA of window W. AREA < 0 means return the left edge of the
1171 whole window, to the left of the right fringe of W. */
1174 window_box_right_offset (w
, area
)
1178 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1181 /* Return the frame-relative coordinate of the left edge of display
1182 area AREA of window W. AREA < 0 means return the left edge of the
1183 whole window, to the right of the left fringe of W. */
1186 window_box_left (w
, area
)
1190 struct frame
*f
= XFRAME (w
->frame
);
1193 if (w
->pseudo_window_p
)
1194 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1196 x
= (WINDOW_LEFT_EDGE_X (w
)
1197 + window_box_left_offset (w
, area
));
1203 /* Return the frame-relative coordinate of the right edge of display
1204 area AREA of window W. AREA < 0 means return the left edge of the
1205 whole window, to the left of the right fringe of W. */
1208 window_box_right (w
, area
)
1212 return window_box_left (w
, area
) + window_box_width (w
, area
);
1215 /* Get the bounding box of the display area AREA of window W, without
1216 mode lines, in frame-relative coordinates. AREA < 0 means the
1217 whole window, not including the left and right fringes of
1218 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1219 coordinates of the upper-left corner of the box. Return in
1220 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1223 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1226 int *box_x
, *box_y
, *box_width
, *box_height
;
1229 *box_width
= window_box_width (w
, area
);
1231 *box_height
= window_box_height (w
);
1233 *box_x
= window_box_left (w
, area
);
1236 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1237 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1238 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1243 /* Get the bounding box of the display area AREA of window W, without
1244 mode lines. AREA < 0 means the whole window, not including the
1245 left and right fringe of the window. Return in *TOP_LEFT_X
1246 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1247 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1248 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1252 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1253 bottom_right_x
, bottom_right_y
)
1256 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1258 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1260 *bottom_right_x
+= *top_left_x
;
1261 *bottom_right_y
+= *top_left_y
;
1266 /***********************************************************************
1268 ***********************************************************************/
1270 /* Return the bottom y-position of the line the iterator IT is in.
1271 This can modify IT's settings. */
1277 int line_height
= it
->max_ascent
+ it
->max_descent
;
1278 int line_top_y
= it
->current_y
;
1280 if (line_height
== 0)
1283 line_height
= last_height
;
1284 else if (IT_CHARPOS (*it
) < ZV
)
1286 move_it_by_lines (it
, 1, 1);
1287 line_height
= (it
->max_ascent
|| it
->max_descent
1288 ? it
->max_ascent
+ it
->max_descent
1293 struct glyph_row
*row
= it
->glyph_row
;
1295 /* Use the default character height. */
1296 it
->glyph_row
= NULL
;
1297 it
->what
= IT_CHARACTER
;
1300 PRODUCE_GLYPHS (it
);
1301 line_height
= it
->ascent
+ it
->descent
;
1302 it
->glyph_row
= row
;
1306 return line_top_y
+ line_height
;
1310 /* Return 1 if position CHARPOS is visible in window W.
1311 CHARPOS < 0 means return info about WINDOW_END position.
1312 If visible, set *X and *Y to pixel coordinates of top left corner.
1313 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1314 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1317 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1319 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1322 struct text_pos top
;
1324 struct buffer
*old_buffer
= NULL
;
1329 if (XBUFFER (w
->buffer
) != current_buffer
)
1331 old_buffer
= current_buffer
;
1332 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1335 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1337 /* Compute exact mode line heights. */
1338 if (WINDOW_WANTS_MODELINE_P (w
))
1339 current_mode_line_height
1340 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1341 current_buffer
->mode_line_format
);
1343 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1344 current_header_line_height
1345 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1346 current_buffer
->header_line_format
);
1348 start_display (&it
, w
, top
);
1349 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1350 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1352 /* Note that we may overshoot because of invisible text. */
1353 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1355 int top_x
= it
.current_x
;
1356 int top_y
= it
.current_y
;
1357 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1358 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1360 if (top_y
< window_top_y
)
1361 visible_p
= bottom_y
> window_top_y
;
1362 else if (top_y
< it
.last_visible_y
)
1366 if (it
.method
== GET_FROM_BUFFER
)
1368 Lisp_Object window
, prop
;
1370 XSETWINDOW (window
, w
);
1371 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1372 Qinvisible
, window
);
1374 /* If charpos coincides with invisible text covered with an
1375 ellipsis, use the first glyph of the ellipsis to compute
1376 the pixel positions. */
1377 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1379 struct glyph_row
*row
= it
.glyph_row
;
1380 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1381 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1384 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1385 x
+= glyph
->pixel_width
;
1392 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1393 *rtop
= max (0, window_top_y
- top_y
);
1394 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1395 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1396 - max (top_y
, window_top_y
)));
1405 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1406 move_it_by_lines (&it
, 1, 0);
1407 if (charpos
< IT_CHARPOS (it
)
1408 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1411 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1413 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1414 *rtop
= max (0, -it2
.current_y
);
1415 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1416 - it
.last_visible_y
));
1417 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1419 - max (it2
.current_y
,
1420 WINDOW_HEADER_LINE_HEIGHT (w
))));
1426 set_buffer_internal_1 (old_buffer
);
1428 current_header_line_height
= current_mode_line_height
= -1;
1430 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1431 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1434 /* Debugging code. */
1436 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1437 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1439 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1446 /* Return the next character from STR which is MAXLEN bytes long.
1447 Return in *LEN the length of the character. This is like
1448 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1449 we find one, we return a `?', but with the length of the invalid
1453 string_char_and_length (str
, maxlen
, len
)
1454 const unsigned char *str
;
1459 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1460 if (!CHAR_VALID_P (c
, 1))
1461 /* We may not change the length here because other places in Emacs
1462 don't use this function, i.e. they silently accept invalid
1471 /* Given a position POS containing a valid character and byte position
1472 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1474 static struct text_pos
1475 string_pos_nchars_ahead (pos
, string
, nchars
)
1476 struct text_pos pos
;
1480 xassert (STRINGP (string
) && nchars
>= 0);
1482 if (STRING_MULTIBYTE (string
))
1484 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1485 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1490 string_char_and_length (p
, rest
, &len
);
1491 p
+= len
, rest
-= len
;
1492 xassert (rest
>= 0);
1494 BYTEPOS (pos
) += len
;
1498 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1504 /* Value is the text position, i.e. character and byte position,
1505 for character position CHARPOS in STRING. */
1507 static INLINE
struct text_pos
1508 string_pos (charpos
, string
)
1512 struct text_pos pos
;
1513 xassert (STRINGP (string
));
1514 xassert (charpos
>= 0);
1515 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1520 /* Value is a text position, i.e. character and byte position, for
1521 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1522 means recognize multibyte characters. */
1524 static struct text_pos
1525 c_string_pos (charpos
, s
, multibyte_p
)
1530 struct text_pos pos
;
1532 xassert (s
!= NULL
);
1533 xassert (charpos
>= 0);
1537 int rest
= strlen (s
), len
;
1539 SET_TEXT_POS (pos
, 0, 0);
1542 string_char_and_length (s
, rest
, &len
);
1543 s
+= len
, rest
-= len
;
1544 xassert (rest
>= 0);
1546 BYTEPOS (pos
) += len
;
1550 SET_TEXT_POS (pos
, charpos
, charpos
);
1556 /* Value is the number of characters in C string S. MULTIBYTE_P
1557 non-zero means recognize multibyte characters. */
1560 number_of_chars (s
, multibyte_p
)
1568 int rest
= strlen (s
), len
;
1569 unsigned char *p
= (unsigned char *) s
;
1571 for (nchars
= 0; rest
> 0; ++nchars
)
1573 string_char_and_length (p
, rest
, &len
);
1574 rest
-= len
, p
+= len
;
1578 nchars
= strlen (s
);
1584 /* Compute byte position NEWPOS->bytepos corresponding to
1585 NEWPOS->charpos. POS is a known position in string STRING.
1586 NEWPOS->charpos must be >= POS.charpos. */
1589 compute_string_pos (newpos
, pos
, string
)
1590 struct text_pos
*newpos
, pos
;
1593 xassert (STRINGP (string
));
1594 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1596 if (STRING_MULTIBYTE (string
))
1597 *newpos
= string_pos_nchars_ahead (pos
, string
,
1598 CHARPOS (*newpos
) - CHARPOS (pos
));
1600 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1604 Return an estimation of the pixel height of mode or top lines on
1605 frame F. FACE_ID specifies what line's height to estimate. */
1608 estimate_mode_line_height (f
, face_id
)
1610 enum face_id face_id
;
1612 #ifdef HAVE_WINDOW_SYSTEM
1613 if (FRAME_WINDOW_P (f
))
1615 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1617 /* This function is called so early when Emacs starts that the face
1618 cache and mode line face are not yet initialized. */
1619 if (FRAME_FACE_CACHE (f
))
1621 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1625 height
= FONT_HEIGHT (face
->font
);
1626 if (face
->box_line_width
> 0)
1627 height
+= 2 * face
->box_line_width
;
1638 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1639 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1640 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1641 not force the value into range. */
1644 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1646 register int pix_x
, pix_y
;
1648 NativeRectangle
*bounds
;
1652 #ifdef HAVE_WINDOW_SYSTEM
1653 if (FRAME_WINDOW_P (f
))
1655 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1656 even for negative values. */
1658 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1660 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1662 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1663 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1666 STORE_NATIVE_RECT (*bounds
,
1667 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1668 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1669 FRAME_COLUMN_WIDTH (f
) - 1,
1670 FRAME_LINE_HEIGHT (f
) - 1);
1676 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1677 pix_x
= FRAME_TOTAL_COLS (f
);
1681 else if (pix_y
> FRAME_LINES (f
))
1682 pix_y
= FRAME_LINES (f
);
1692 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1693 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1694 can't tell the positions because W's display is not up to date,
1698 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1701 int *frame_x
, *frame_y
;
1703 #ifdef HAVE_WINDOW_SYSTEM
1704 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1708 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1709 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1711 if (display_completed
)
1713 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1714 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1715 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1721 hpos
+= glyph
->pixel_width
;
1725 /* If first glyph is partially visible, its first visible position is still 0. */
1737 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1738 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1749 #ifdef HAVE_WINDOW_SYSTEM
1751 /* Find the glyph under window-relative coordinates X/Y in window W.
1752 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1753 strings. Return in *HPOS and *VPOS the row and column number of
1754 the glyph found. Return in *AREA the glyph area containing X.
1755 Value is a pointer to the glyph found or null if X/Y is not on
1756 text, or we can't tell because W's current matrix is not up to
1761 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1764 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1766 struct glyph
*glyph
, *end
;
1767 struct glyph_row
*row
= NULL
;
1770 /* Find row containing Y. Give up if some row is not enabled. */
1771 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1773 row
= MATRIX_ROW (w
->current_matrix
, i
);
1774 if (!row
->enabled_p
)
1776 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1783 /* Give up if Y is not in the window. */
1784 if (i
== w
->current_matrix
->nrows
)
1787 /* Get the glyph area containing X. */
1788 if (w
->pseudo_window_p
)
1795 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1797 *area
= LEFT_MARGIN_AREA
;
1798 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1800 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1803 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1807 *area
= RIGHT_MARGIN_AREA
;
1808 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1812 /* Find glyph containing X. */
1813 glyph
= row
->glyphs
[*area
];
1814 end
= glyph
+ row
->used
[*area
];
1816 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1818 x
-= glyph
->pixel_width
;
1828 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1831 *hpos
= glyph
- row
->glyphs
[*area
];
1837 Convert frame-relative x/y to coordinates relative to window W.
1838 Takes pseudo-windows into account. */
1841 frame_to_window_pixel_xy (w
, x
, y
)
1845 if (w
->pseudo_window_p
)
1847 /* A pseudo-window is always full-width, and starts at the
1848 left edge of the frame, plus a frame border. */
1849 struct frame
*f
= XFRAME (w
->frame
);
1850 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1851 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1855 *x
-= WINDOW_LEFT_EDGE_X (w
);
1856 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1861 Return in RECTS[] at most N clipping rectangles for glyph string S.
1862 Return the number of stored rectangles. */
1865 get_glyph_string_clip_rects (s
, rects
, n
)
1866 struct glyph_string
*s
;
1867 NativeRectangle
*rects
;
1875 if (s
->row
->full_width_p
)
1877 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1878 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1879 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1881 /* Unless displaying a mode or menu bar line, which are always
1882 fully visible, clip to the visible part of the row. */
1883 if (s
->w
->pseudo_window_p
)
1884 r
.height
= s
->row
->visible_height
;
1886 r
.height
= s
->height
;
1890 /* This is a text line that may be partially visible. */
1891 r
.x
= window_box_left (s
->w
, s
->area
);
1892 r
.width
= window_box_width (s
->w
, s
->area
);
1893 r
.height
= s
->row
->visible_height
;
1897 if (r
.x
< s
->clip_head
->x
)
1899 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1900 r
.width
-= s
->clip_head
->x
- r
.x
;
1903 r
.x
= s
->clip_head
->x
;
1906 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1908 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1909 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1914 /* If S draws overlapping rows, it's sufficient to use the top and
1915 bottom of the window for clipping because this glyph string
1916 intentionally draws over other lines. */
1917 if (s
->for_overlaps
)
1919 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1920 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1922 /* Alas, the above simple strategy does not work for the
1923 environments with anti-aliased text: if the same text is
1924 drawn onto the same place multiple times, it gets thicker.
1925 If the overlap we are processing is for the erased cursor, we
1926 take the intersection with the rectagle of the cursor. */
1927 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1929 XRectangle rc
, r_save
= r
;
1931 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1932 rc
.y
= s
->w
->phys_cursor
.y
;
1933 rc
.width
= s
->w
->phys_cursor_width
;
1934 rc
.height
= s
->w
->phys_cursor_height
;
1936 x_intersect_rectangles (&r_save
, &rc
, &r
);
1941 /* Don't use S->y for clipping because it doesn't take partially
1942 visible lines into account. For example, it can be negative for
1943 partially visible lines at the top of a window. */
1944 if (!s
->row
->full_width_p
1945 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1946 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1948 r
.y
= max (0, s
->row
->y
);
1950 /* If drawing a tool-bar window, draw it over the internal border
1951 at the top of the window. */
1952 if (WINDOWP (s
->f
->tool_bar_window
)
1953 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1954 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1957 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1959 /* If drawing the cursor, don't let glyph draw outside its
1960 advertised boundaries. Cleartype does this under some circumstances. */
1961 if (s
->hl
== DRAW_CURSOR
)
1963 struct glyph
*glyph
= s
->first_glyph
;
1968 r
.width
-= s
->x
- r
.x
;
1971 r
.width
= min (r
.width
, glyph
->pixel_width
);
1973 /* If r.y is below window bottom, ensure that we still see a cursor. */
1974 height
= min (glyph
->ascent
+ glyph
->descent
,
1975 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1976 max_y
= window_text_bottom_y (s
->w
) - height
;
1977 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1978 if (s
->ybase
- glyph
->ascent
> max_y
)
1985 /* Don't draw cursor glyph taller than our actual glyph. */
1986 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1987 if (height
< r
.height
)
1989 max_y
= r
.y
+ r
.height
;
1990 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1991 r
.height
= min (max_y
- r
.y
, height
);
1998 XRectangle r_save
= r
;
2000 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2004 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2005 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2007 #ifdef CONVERT_FROM_XRECT
2008 CONVERT_FROM_XRECT (r
, *rects
);
2016 /* If we are processing overlapping and allowed to return
2017 multiple clipping rectangles, we exclude the row of the glyph
2018 string from the clipping rectangle. This is to avoid drawing
2019 the same text on the environment with anti-aliasing. */
2020 #ifdef CONVERT_FROM_XRECT
2023 XRectangle
*rs
= rects
;
2025 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2027 if (s
->for_overlaps
& OVERLAPS_PRED
)
2030 if (r
.y
+ r
.height
> row_y
)
2033 rs
[i
].height
= row_y
- r
.y
;
2039 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2042 if (r
.y
< row_y
+ s
->row
->visible_height
)
2044 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2046 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2047 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2056 #ifdef CONVERT_FROM_XRECT
2057 for (i
= 0; i
< n
; i
++)
2058 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2065 Return in *NR the clipping rectangle for glyph string S. */
2068 get_glyph_string_clip_rect (s
, nr
)
2069 struct glyph_string
*s
;
2070 NativeRectangle
*nr
;
2072 get_glyph_string_clip_rects (s
, nr
, 1);
2077 Return the position and height of the phys cursor in window W.
2078 Set w->phys_cursor_width to width of phys cursor.
2082 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2084 struct glyph_row
*row
;
2085 struct glyph
*glyph
;
2086 int *xp
, *yp
, *heightp
;
2088 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2089 int x
, y
, wd
, h
, h0
, y0
;
2091 /* Compute the width of the rectangle to draw. If on a stretch
2092 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2093 rectangle as wide as the glyph, but use a canonical character
2095 wd
= glyph
->pixel_width
- 1;
2096 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2100 x
= w
->phys_cursor
.x
;
2107 if (glyph
->type
== STRETCH_GLYPH
2108 && !x_stretch_cursor_p
)
2109 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2110 w
->phys_cursor_width
= wd
;
2112 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2114 /* If y is below window bottom, ensure that we still see a cursor. */
2115 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2117 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2118 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2120 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2123 h
= max (h
- (y0
- y
) + 1, h0
);
2128 y0
= window_text_bottom_y (w
) - h0
;
2136 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2137 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2142 * Remember which glyph the mouse is over.
2146 remember_mouse_glyph (f
, gx
, gy
, rect
)
2149 NativeRectangle
*rect
;
2153 struct glyph_row
*r
, *gr
, *end_row
;
2154 enum window_part part
;
2155 enum glyph_row_area area
;
2156 int x
, y
, width
, height
;
2158 /* Try to determine frame pixel position and size of the glyph under
2159 frame pixel coordinates X/Y on frame F. */
2161 if (!f
->glyphs_initialized_p
2162 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2165 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2166 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2170 w
= XWINDOW (window
);
2171 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2172 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2174 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2175 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2177 if (w
->pseudo_window_p
)
2180 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2186 case ON_LEFT_MARGIN
:
2187 area
= LEFT_MARGIN_AREA
;
2190 case ON_RIGHT_MARGIN
:
2191 area
= RIGHT_MARGIN_AREA
;
2194 case ON_HEADER_LINE
:
2196 gr
= (part
== ON_HEADER_LINE
2197 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2198 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2201 goto text_glyph_row_found
;
2208 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2209 if (r
->y
+ r
->height
> y
)
2215 text_glyph_row_found
:
2218 struct glyph
*g
= gr
->glyphs
[area
];
2219 struct glyph
*end
= g
+ gr
->used
[area
];
2221 height
= gr
->height
;
2222 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2223 if (gx
+ g
->pixel_width
> x
)
2228 if (g
->type
== IMAGE_GLYPH
)
2230 /* Don't remember when mouse is over image, as
2231 image may have hot-spots. */
2232 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2235 width
= g
->pixel_width
;
2239 /* Use nominal char spacing at end of line. */
2241 gx
+= (x
/ width
) * width
;
2244 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2245 gx
+= window_box_left_offset (w
, area
);
2249 /* Use nominal line height at end of window. */
2250 gx
= (x
/ width
) * width
;
2252 gy
+= (y
/ height
) * height
;
2256 case ON_LEFT_FRINGE
:
2257 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2258 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2259 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2260 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2263 case ON_RIGHT_FRINGE
:
2264 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2265 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2266 : window_box_right_offset (w
, TEXT_AREA
));
2267 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2271 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2273 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2274 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2275 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2277 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2281 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2282 if (r
->y
+ r
->height
> y
)
2289 height
= gr
->height
;
2292 /* Use nominal line height at end of window. */
2294 gy
+= (y
/ height
) * height
;
2301 /* If there is no glyph under the mouse, then we divide the screen
2302 into a grid of the smallest glyph in the frame, and use that
2305 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2306 round down even for negative values. */
2312 gx
= (gx
/ width
) * width
;
2313 gy
= (gy
/ height
) * height
;
2318 gx
+= WINDOW_LEFT_EDGE_X (w
);
2319 gy
+= WINDOW_TOP_EDGE_Y (w
);
2322 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2324 /* Visible feedback for debugging. */
2327 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2328 f
->output_data
.x
->normal_gc
,
2329 gx
, gy
, width
, height
);
2335 #endif /* HAVE_WINDOW_SYSTEM */
2338 /***********************************************************************
2339 Lisp form evaluation
2340 ***********************************************************************/
2342 /* Error handler for safe_eval and safe_call. */
2345 safe_eval_handler (arg
)
2348 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2353 /* Evaluate SEXPR and return the result, or nil if something went
2354 wrong. Prevent redisplay during the evaluation. */
2356 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2357 Return the result, or nil if something went wrong. Prevent
2358 redisplay during the evaluation. */
2361 safe_call (nargs
, args
)
2367 if (inhibit_eval_during_redisplay
)
2371 int count
= SPECPDL_INDEX ();
2372 struct gcpro gcpro1
;
2375 gcpro1
.nvars
= nargs
;
2376 specbind (Qinhibit_redisplay
, Qt
);
2377 /* Use Qt to ensure debugger does not run,
2378 so there is no possibility of wanting to redisplay. */
2379 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2382 val
= unbind_to (count
, val
);
2389 /* Call function FN with one argument ARG.
2390 Return the result, or nil if something went wrong. */
2393 safe_call1 (fn
, arg
)
2394 Lisp_Object fn
, arg
;
2396 Lisp_Object args
[2];
2399 return safe_call (2, args
);
2402 static Lisp_Object Qeval
;
2405 safe_eval (Lisp_Object sexpr
)
2407 return safe_call1 (Qeval
, sexpr
);
2410 /* Call function FN with one argument ARG.
2411 Return the result, or nil if something went wrong. */
2414 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2416 Lisp_Object args
[3];
2420 return safe_call (3, args
);
2425 /***********************************************************************
2427 ***********************************************************************/
2431 /* Define CHECK_IT to perform sanity checks on iterators.
2432 This is for debugging. It is too slow to do unconditionally. */
2438 if (it
->method
== GET_FROM_STRING
)
2440 xassert (STRINGP (it
->string
));
2441 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2445 xassert (IT_STRING_CHARPOS (*it
) < 0);
2446 if (it
->method
== GET_FROM_BUFFER
)
2448 /* Check that character and byte positions agree. */
2449 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2454 xassert (it
->current
.dpvec_index
>= 0);
2456 xassert (it
->current
.dpvec_index
< 0);
2459 #define CHECK_IT(IT) check_it ((IT))
2463 #define CHECK_IT(IT) (void) 0
2470 /* Check that the window end of window W is what we expect it
2471 to be---the last row in the current matrix displaying text. */
2474 check_window_end (w
)
2477 if (!MINI_WINDOW_P (w
)
2478 && !NILP (w
->window_end_valid
))
2480 struct glyph_row
*row
;
2481 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2482 XFASTINT (w
->window_end_vpos
)),
2484 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2485 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2489 #define CHECK_WINDOW_END(W) check_window_end ((W))
2491 #else /* not GLYPH_DEBUG */
2493 #define CHECK_WINDOW_END(W) (void) 0
2495 #endif /* not GLYPH_DEBUG */
2499 /***********************************************************************
2500 Iterator initialization
2501 ***********************************************************************/
2503 /* Initialize IT for displaying current_buffer in window W, starting
2504 at character position CHARPOS. CHARPOS < 0 means that no buffer
2505 position is specified which is useful when the iterator is assigned
2506 a position later. BYTEPOS is the byte position corresponding to
2507 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2509 If ROW is not null, calls to produce_glyphs with IT as parameter
2510 will produce glyphs in that row.
2512 BASE_FACE_ID is the id of a base face to use. It must be one of
2513 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2514 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2515 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2517 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2518 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2519 will be initialized to use the corresponding mode line glyph row of
2520 the desired matrix of W. */
2523 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2526 int charpos
, bytepos
;
2527 struct glyph_row
*row
;
2528 enum face_id base_face_id
;
2530 int highlight_region_p
;
2531 enum face_id remapped_base_face_id
= base_face_id
;
2533 /* Some precondition checks. */
2534 xassert (w
!= NULL
&& it
!= NULL
);
2535 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2538 /* If face attributes have been changed since the last redisplay,
2539 free realized faces now because they depend on face definitions
2540 that might have changed. Don't free faces while there might be
2541 desired matrices pending which reference these faces. */
2542 if (face_change_count
&& !inhibit_free_realized_faces
)
2544 face_change_count
= 0;
2545 free_all_realized_faces (Qnil
);
2548 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2549 if (! NILP (Vface_remapping_alist
))
2550 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2552 /* Use one of the mode line rows of W's desired matrix if
2556 if (base_face_id
== MODE_LINE_FACE_ID
2557 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2558 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2559 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2560 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2564 bzero (it
, sizeof *it
);
2565 it
->current
.overlay_string_index
= -1;
2566 it
->current
.dpvec_index
= -1;
2567 it
->base_face_id
= remapped_base_face_id
;
2569 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2571 /* The window in which we iterate over current_buffer: */
2572 XSETWINDOW (it
->window
, w
);
2574 it
->f
= XFRAME (w
->frame
);
2578 /* Extra space between lines (on window systems only). */
2579 if (base_face_id
== DEFAULT_FACE_ID
2580 && FRAME_WINDOW_P (it
->f
))
2582 if (NATNUMP (current_buffer
->extra_line_spacing
))
2583 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2584 else if (FLOATP (current_buffer
->extra_line_spacing
))
2585 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2586 * FRAME_LINE_HEIGHT (it
->f
));
2587 else if (it
->f
->extra_line_spacing
> 0)
2588 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2589 it
->max_extra_line_spacing
= 0;
2592 /* If realized faces have been removed, e.g. because of face
2593 attribute changes of named faces, recompute them. When running
2594 in batch mode, the face cache of the initial frame is null. If
2595 we happen to get called, make a dummy face cache. */
2596 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2597 init_frame_faces (it
->f
);
2598 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2599 recompute_basic_faces (it
->f
);
2601 /* Current value of the `slice', `space-width', and 'height' properties. */
2602 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2603 it
->space_width
= Qnil
;
2604 it
->font_height
= Qnil
;
2605 it
->override_ascent
= -1;
2607 /* Are control characters displayed as `^C'? */
2608 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2610 /* -1 means everything between a CR and the following line end
2611 is invisible. >0 means lines indented more than this value are
2613 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2614 ? XFASTINT (current_buffer
->selective_display
)
2615 : (!NILP (current_buffer
->selective_display
)
2617 it
->selective_display_ellipsis_p
2618 = !NILP (current_buffer
->selective_display_ellipses
);
2620 /* Display table to use. */
2621 it
->dp
= window_display_table (w
);
2623 /* Are multibyte characters enabled in current_buffer? */
2624 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2626 /* Non-zero if we should highlight the region. */
2628 = (!NILP (Vtransient_mark_mode
)
2629 && !NILP (current_buffer
->mark_active
)
2630 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2632 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2633 start and end of a visible region in window IT->w. Set both to
2634 -1 to indicate no region. */
2635 if (highlight_region_p
2636 /* Maybe highlight only in selected window. */
2637 && (/* Either show region everywhere. */
2638 highlight_nonselected_windows
2639 /* Or show region in the selected window. */
2640 || w
== XWINDOW (selected_window
)
2641 /* Or show the region if we are in the mini-buffer and W is
2642 the window the mini-buffer refers to. */
2643 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2644 && WINDOWP (minibuf_selected_window
)
2645 && w
== XWINDOW (minibuf_selected_window
))))
2647 int charpos
= marker_position (current_buffer
->mark
);
2648 it
->region_beg_charpos
= min (PT
, charpos
);
2649 it
->region_end_charpos
= max (PT
, charpos
);
2652 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2654 /* Get the position at which the redisplay_end_trigger hook should
2655 be run, if it is to be run at all. */
2656 if (MARKERP (w
->redisplay_end_trigger
)
2657 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2658 it
->redisplay_end_trigger_charpos
2659 = marker_position (w
->redisplay_end_trigger
);
2660 else if (INTEGERP (w
->redisplay_end_trigger
))
2661 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2663 /* Correct bogus values of tab_width. */
2664 it
->tab_width
= XINT (current_buffer
->tab_width
);
2665 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2668 /* Are lines in the display truncated? */
2669 if (base_face_id
!= DEFAULT_FACE_ID
2670 || XINT (it
->w
->hscroll
)
2671 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2672 && ((!NILP (Vtruncate_partial_width_windows
)
2673 && !INTEGERP (Vtruncate_partial_width_windows
))
2674 || (INTEGERP (Vtruncate_partial_width_windows
)
2675 && (WINDOW_TOTAL_COLS (it
->w
)
2676 < XINT (Vtruncate_partial_width_windows
))))))
2677 it
->line_wrap
= TRUNCATE
;
2678 else if (NILP (current_buffer
->truncate_lines
))
2679 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2680 ? WINDOW_WRAP
: WORD_WRAP
;
2682 it
->line_wrap
= TRUNCATE
;
2684 /* Get dimensions of truncation and continuation glyphs. These are
2685 displayed as fringe bitmaps under X, so we don't need them for such
2687 if (!FRAME_WINDOW_P (it
->f
))
2689 if (it
->line_wrap
== TRUNCATE
)
2691 /* We will need the truncation glyph. */
2692 xassert (it
->glyph_row
== NULL
);
2693 produce_special_glyphs (it
, IT_TRUNCATION
);
2694 it
->truncation_pixel_width
= it
->pixel_width
;
2698 /* We will need the continuation glyph. */
2699 xassert (it
->glyph_row
== NULL
);
2700 produce_special_glyphs (it
, IT_CONTINUATION
);
2701 it
->continuation_pixel_width
= it
->pixel_width
;
2704 /* Reset these values to zero because the produce_special_glyphs
2705 above has changed them. */
2706 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2707 it
->phys_ascent
= it
->phys_descent
= 0;
2710 /* Set this after getting the dimensions of truncation and
2711 continuation glyphs, so that we don't produce glyphs when calling
2712 produce_special_glyphs, above. */
2713 it
->glyph_row
= row
;
2714 it
->area
= TEXT_AREA
;
2716 /* Get the dimensions of the display area. The display area
2717 consists of the visible window area plus a horizontally scrolled
2718 part to the left of the window. All x-values are relative to the
2719 start of this total display area. */
2720 if (base_face_id
!= DEFAULT_FACE_ID
)
2722 /* Mode lines, menu bar in terminal frames. */
2723 it
->first_visible_x
= 0;
2724 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2729 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2730 it
->last_visible_x
= (it
->first_visible_x
2731 + window_box_width (w
, TEXT_AREA
));
2733 /* If we truncate lines, leave room for the truncator glyph(s) at
2734 the right margin. Otherwise, leave room for the continuation
2735 glyph(s). Truncation and continuation glyphs are not inserted
2736 for window-based redisplay. */
2737 if (!FRAME_WINDOW_P (it
->f
))
2739 if (it
->line_wrap
== TRUNCATE
)
2740 it
->last_visible_x
-= it
->truncation_pixel_width
;
2742 it
->last_visible_x
-= it
->continuation_pixel_width
;
2745 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2746 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2749 /* Leave room for a border glyph. */
2750 if (!FRAME_WINDOW_P (it
->f
)
2751 && !WINDOW_RIGHTMOST_P (it
->w
))
2752 it
->last_visible_x
-= 1;
2754 it
->last_visible_y
= window_text_bottom_y (w
);
2756 /* For mode lines and alike, arrange for the first glyph having a
2757 left box line if the face specifies a box. */
2758 if (base_face_id
!= DEFAULT_FACE_ID
)
2762 it
->face_id
= remapped_base_face_id
;
2764 /* If we have a boxed mode line, make the first character appear
2765 with a left box line. */
2766 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2767 if (face
->box
!= FACE_NO_BOX
)
2768 it
->start_of_box_run_p
= 1;
2771 /* If a buffer position was specified, set the iterator there,
2772 getting overlays and face properties from that position. */
2773 if (charpos
>= BUF_BEG (current_buffer
))
2775 it
->end_charpos
= ZV
;
2777 IT_CHARPOS (*it
) = charpos
;
2779 /* Compute byte position if not specified. */
2780 if (bytepos
< charpos
)
2781 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2783 IT_BYTEPOS (*it
) = bytepos
;
2785 it
->start
= it
->current
;
2787 /* Compute faces etc. */
2788 reseat (it
, it
->current
.pos
, 1);
2795 /* Initialize IT for the display of window W with window start POS. */
2798 start_display (it
, w
, pos
)
2801 struct text_pos pos
;
2803 struct glyph_row
*row
;
2804 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2806 row
= w
->desired_matrix
->rows
+ first_vpos
;
2807 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2808 it
->first_vpos
= first_vpos
;
2810 /* Don't reseat to previous visible line start if current start
2811 position is in a string or image. */
2812 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2814 int start_at_line_beg_p
;
2815 int first_y
= it
->current_y
;
2817 /* If window start is not at a line start, skip forward to POS to
2818 get the correct continuation lines width. */
2819 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2820 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2821 if (!start_at_line_beg_p
)
2825 reseat_at_previous_visible_line_start (it
);
2826 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2828 new_x
= it
->current_x
+ it
->pixel_width
;
2830 /* If lines are continued, this line may end in the middle
2831 of a multi-glyph character (e.g. a control character
2832 displayed as \003, or in the middle of an overlay
2833 string). In this case move_it_to above will not have
2834 taken us to the start of the continuation line but to the
2835 end of the continued line. */
2836 if (it
->current_x
> 0
2837 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2838 && (/* And glyph doesn't fit on the line. */
2839 new_x
> it
->last_visible_x
2840 /* Or it fits exactly and we're on a window
2842 || (new_x
== it
->last_visible_x
2843 && FRAME_WINDOW_P (it
->f
))))
2845 if (it
->current
.dpvec_index
>= 0
2846 || it
->current
.overlay_string_index
>= 0)
2848 set_iterator_to_next (it
, 1);
2849 move_it_in_display_line_to (it
, -1, -1, 0);
2852 it
->continuation_lines_width
+= it
->current_x
;
2855 /* We're starting a new display line, not affected by the
2856 height of the continued line, so clear the appropriate
2857 fields in the iterator structure. */
2858 it
->max_ascent
= it
->max_descent
= 0;
2859 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2861 it
->current_y
= first_y
;
2863 it
->current_x
= it
->hpos
= 0;
2867 #if 0 /* Don't assert the following because start_display is sometimes
2868 called intentionally with a window start that is not at a
2869 line start. Please leave this code in as a comment. */
2871 /* Window start should be on a line start, now. */
2872 xassert (it
->continuation_lines_width
2873 || IT_CHARPOS (it
) == BEGV
2874 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2879 /* Return 1 if POS is a position in ellipses displayed for invisible
2880 text. W is the window we display, for text property lookup. */
2883 in_ellipses_for_invisible_text_p (pos
, w
)
2884 struct display_pos
*pos
;
2887 Lisp_Object prop
, window
;
2889 int charpos
= CHARPOS (pos
->pos
);
2891 /* If POS specifies a position in a display vector, this might
2892 be for an ellipsis displayed for invisible text. We won't
2893 get the iterator set up for delivering that ellipsis unless
2894 we make sure that it gets aware of the invisible text. */
2895 if (pos
->dpvec_index
>= 0
2896 && pos
->overlay_string_index
< 0
2897 && CHARPOS (pos
->string_pos
) < 0
2899 && (XSETWINDOW (window
, w
),
2900 prop
= Fget_char_property (make_number (charpos
),
2901 Qinvisible
, window
),
2902 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2904 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2906 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2913 /* Initialize IT for stepping through current_buffer in window W,
2914 starting at position POS that includes overlay string and display
2915 vector/ control character translation position information. Value
2916 is zero if there are overlay strings with newlines at POS. */
2919 init_from_display_pos (it
, w
, pos
)
2922 struct display_pos
*pos
;
2924 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2925 int i
, overlay_strings_with_newlines
= 0;
2927 /* If POS specifies a position in a display vector, this might
2928 be for an ellipsis displayed for invisible text. We won't
2929 get the iterator set up for delivering that ellipsis unless
2930 we make sure that it gets aware of the invisible text. */
2931 if (in_ellipses_for_invisible_text_p (pos
, w
))
2937 /* Keep in mind: the call to reseat in init_iterator skips invisible
2938 text, so we might end up at a position different from POS. This
2939 is only a problem when POS is a row start after a newline and an
2940 overlay starts there with an after-string, and the overlay has an
2941 invisible property. Since we don't skip invisible text in
2942 display_line and elsewhere immediately after consuming the
2943 newline before the row start, such a POS will not be in a string,
2944 but the call to init_iterator below will move us to the
2946 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2948 /* This only scans the current chunk -- it should scan all chunks.
2949 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2950 to 16 in 22.1 to make this a lesser problem. */
2951 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2953 const char *s
= SDATA (it
->overlay_strings
[i
]);
2954 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2956 while (s
< e
&& *s
!= '\n')
2961 overlay_strings_with_newlines
= 1;
2966 /* If position is within an overlay string, set up IT to the right
2968 if (pos
->overlay_string_index
>= 0)
2972 /* If the first overlay string happens to have a `display'
2973 property for an image, the iterator will be set up for that
2974 image, and we have to undo that setup first before we can
2975 correct the overlay string index. */
2976 if (it
->method
== GET_FROM_IMAGE
)
2979 /* We already have the first chunk of overlay strings in
2980 IT->overlay_strings. Load more until the one for
2981 pos->overlay_string_index is in IT->overlay_strings. */
2982 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2984 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2985 it
->current
.overlay_string_index
= 0;
2988 load_overlay_strings (it
, 0);
2989 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2993 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2994 relative_index
= (it
->current
.overlay_string_index
2995 % OVERLAY_STRING_CHUNK_SIZE
);
2996 it
->string
= it
->overlay_strings
[relative_index
];
2997 xassert (STRINGP (it
->string
));
2998 it
->current
.string_pos
= pos
->string_pos
;
2999 it
->method
= GET_FROM_STRING
;
3002 #if 0 /* This is bogus because POS not having an overlay string
3003 position does not mean it's after the string. Example: A
3004 line starting with a before-string and initialization of IT
3005 to the previous row's end position. */
3006 else if (it
->current
.overlay_string_index
>= 0)
3008 /* If POS says we're already after an overlay string ending at
3009 POS, make sure to pop the iterator because it will be in
3010 front of that overlay string. When POS is ZV, we've thereby
3011 also ``processed'' overlay strings at ZV. */
3014 xassert (it
->current
.overlay_string_index
== -1);
3015 xassert (it
->method
== GET_FROM_BUFFER
);
3016 if (CHARPOS (pos
->pos
) == ZV
)
3017 it
->overlay_strings_at_end_processed_p
= 1;
3021 if (CHARPOS (pos
->string_pos
) >= 0)
3023 /* Recorded position is not in an overlay string, but in another
3024 string. This can only be a string from a `display' property.
3025 IT should already be filled with that string. */
3026 it
->current
.string_pos
= pos
->string_pos
;
3027 xassert (STRINGP (it
->string
));
3030 /* Restore position in display vector translations, control
3031 character translations or ellipses. */
3032 if (pos
->dpvec_index
>= 0)
3034 if (it
->dpvec
== NULL
)
3035 get_next_display_element (it
);
3036 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3037 it
->current
.dpvec_index
= pos
->dpvec_index
;
3041 return !overlay_strings_with_newlines
;
3045 /* Initialize IT for stepping through current_buffer in window W
3046 starting at ROW->start. */
3049 init_to_row_start (it
, w
, row
)
3052 struct glyph_row
*row
;
3054 init_from_display_pos (it
, w
, &row
->start
);
3055 it
->start
= row
->start
;
3056 it
->continuation_lines_width
= row
->continuation_lines_width
;
3061 /* Initialize IT for stepping through current_buffer in window W
3062 starting in the line following ROW, i.e. starting at ROW->end.
3063 Value is zero if there are overlay strings with newlines at ROW's
3067 init_to_row_end (it
, w
, row
)
3070 struct glyph_row
*row
;
3074 if (init_from_display_pos (it
, w
, &row
->end
))
3076 if (row
->continued_p
)
3077 it
->continuation_lines_width
3078 = row
->continuation_lines_width
+ row
->pixel_width
;
3089 /***********************************************************************
3091 ***********************************************************************/
3093 /* Called when IT reaches IT->stop_charpos. Handle text property and
3094 overlay changes. Set IT->stop_charpos to the next position where
3101 enum prop_handled handled
;
3102 int handle_overlay_change_p
;
3106 it
->current
.dpvec_index
= -1;
3107 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3108 it
->ignore_overlay_strings_at_pos_p
= 0;
3111 /* Use face of preceding text for ellipsis (if invisible) */
3112 if (it
->selective_display_ellipsis_p
)
3113 it
->saved_face_id
= it
->face_id
;
3117 handled
= HANDLED_NORMALLY
;
3119 /* Call text property handlers. */
3120 for (p
= it_props
; p
->handler
; ++p
)
3122 handled
= p
->handler (it
);
3124 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3126 else if (handled
== HANDLED_RETURN
)
3128 /* We still want to show before and after strings from
3129 overlays even if the actual buffer text is replaced. */
3130 if (!handle_overlay_change_p
3132 || !get_overlay_strings_1 (it
, 0, 0))
3135 setup_for_ellipsis (it
, 0);
3138 it
->ignore_overlay_strings_at_pos_p
= 1;
3139 it
->string_from_display_prop_p
= 0;
3140 handle_overlay_change_p
= 0;
3141 handled
= HANDLED_RECOMPUTE_PROPS
;
3144 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3145 handle_overlay_change_p
= 0;
3148 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3150 /* Don't check for overlay strings below when set to deliver
3151 characters from a display vector. */
3152 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3153 handle_overlay_change_p
= 0;
3155 /* Handle overlay changes.
3156 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3157 if it finds overlays. */
3158 if (handle_overlay_change_p
)
3159 handled
= handle_overlay_change (it
);
3164 setup_for_ellipsis (it
, 0);
3168 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3170 /* Determine where to stop next. */
3171 if (handled
== HANDLED_NORMALLY
)
3172 compute_stop_pos (it
);
3176 /* Compute IT->stop_charpos from text property and overlay change
3177 information for IT's current position. */
3180 compute_stop_pos (it
)
3183 register INTERVAL iv
, next_iv
;
3184 Lisp_Object object
, limit
, position
;
3185 EMACS_INT charpos
, bytepos
;
3187 /* If nowhere else, stop at the end. */
3188 it
->stop_charpos
= it
->end_charpos
;
3190 if (STRINGP (it
->string
))
3192 /* Strings are usually short, so don't limit the search for
3194 object
= it
->string
;
3196 charpos
= IT_STRING_CHARPOS (*it
);
3197 bytepos
= IT_STRING_BYTEPOS (*it
);
3203 /* If next overlay change is in front of the current stop pos
3204 (which is IT->end_charpos), stop there. Note: value of
3205 next_overlay_change is point-max if no overlay change
3207 charpos
= IT_CHARPOS (*it
);
3208 bytepos
= IT_BYTEPOS (*it
);
3209 pos
= next_overlay_change (charpos
);
3210 if (pos
< it
->stop_charpos
)
3211 it
->stop_charpos
= pos
;
3213 /* If showing the region, we have to stop at the region
3214 start or end because the face might change there. */
3215 if (it
->region_beg_charpos
> 0)
3217 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3218 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3219 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3220 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3223 /* Set up variables for computing the stop position from text
3224 property changes. */
3225 XSETBUFFER (object
, current_buffer
);
3226 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3229 /* Get the interval containing IT's position. Value is a null
3230 interval if there isn't such an interval. */
3231 position
= make_number (charpos
);
3232 iv
= validate_interval_range (object
, &position
, &position
, 0);
3233 if (!NULL_INTERVAL_P (iv
))
3235 Lisp_Object values_here
[LAST_PROP_IDX
];
3238 /* Get properties here. */
3239 for (p
= it_props
; p
->handler
; ++p
)
3240 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3242 /* Look for an interval following iv that has different
3244 for (next_iv
= next_interval (iv
);
3245 (!NULL_INTERVAL_P (next_iv
)
3247 || XFASTINT (limit
) > next_iv
->position
));
3248 next_iv
= next_interval (next_iv
))
3250 for (p
= it_props
; p
->handler
; ++p
)
3252 Lisp_Object new_value
;
3254 new_value
= textget (next_iv
->plist
, *p
->name
);
3255 if (!EQ (values_here
[p
->idx
], new_value
))
3263 if (!NULL_INTERVAL_P (next_iv
))
3265 if (INTEGERP (limit
)
3266 && next_iv
->position
>= XFASTINT (limit
))
3267 /* No text property change up to limit. */
3268 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3270 /* Text properties change in next_iv. */
3271 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3275 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3276 it
->stop_charpos
, it
->string
);
3278 xassert (STRINGP (it
->string
)
3279 || (it
->stop_charpos
>= BEGV
3280 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3284 /* Return the position of the next overlay change after POS in
3285 current_buffer. Value is point-max if no overlay change
3286 follows. This is like `next-overlay-change' but doesn't use
3290 next_overlay_change (pos
)
3295 Lisp_Object
*overlays
;
3298 /* Get all overlays at the given position. */
3299 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3301 /* If any of these overlays ends before endpos,
3302 use its ending point instead. */
3303 for (i
= 0; i
< noverlays
; ++i
)
3308 oend
= OVERLAY_END (overlays
[i
]);
3309 oendpos
= OVERLAY_POSITION (oend
);
3310 endpos
= min (endpos
, oendpos
);
3318 /***********************************************************************
3320 ***********************************************************************/
3322 /* Handle changes in the `fontified' property of the current buffer by
3323 calling hook functions from Qfontification_functions to fontify
3326 static enum prop_handled
3327 handle_fontified_prop (it
)
3330 Lisp_Object prop
, pos
;
3331 enum prop_handled handled
= HANDLED_NORMALLY
;
3333 if (!NILP (Vmemory_full
))
3336 /* Get the value of the `fontified' property at IT's current buffer
3337 position. (The `fontified' property doesn't have a special
3338 meaning in strings.) If the value is nil, call functions from
3339 Qfontification_functions. */
3340 if (!STRINGP (it
->string
)
3342 && !NILP (Vfontification_functions
)
3343 && !NILP (Vrun_hooks
)
3344 && (pos
= make_number (IT_CHARPOS (*it
)),
3345 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3346 /* Ignore the special cased nil value always present at EOB since
3347 no amount of fontifying will be able to change it. */
3348 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3350 int count
= SPECPDL_INDEX ();
3353 val
= Vfontification_functions
;
3354 specbind (Qfontification_functions
, Qnil
);
3356 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3357 safe_call1 (val
, pos
);
3360 Lisp_Object globals
, fn
;
3361 struct gcpro gcpro1
, gcpro2
;
3364 GCPRO2 (val
, globals
);
3366 for (; CONSP (val
); val
= XCDR (val
))
3372 /* A value of t indicates this hook has a local
3373 binding; it means to run the global binding too.
3374 In a global value, t should not occur. If it
3375 does, we must ignore it to avoid an endless
3377 for (globals
= Fdefault_value (Qfontification_functions
);
3379 globals
= XCDR (globals
))
3381 fn
= XCAR (globals
);
3383 safe_call1 (fn
, pos
);
3387 safe_call1 (fn
, pos
);
3393 unbind_to (count
, Qnil
);
3395 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3396 something. This avoids an endless loop if they failed to
3397 fontify the text for which reason ever. */
3398 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3399 handled
= HANDLED_RECOMPUTE_PROPS
;
3407 /***********************************************************************
3409 ***********************************************************************/
3411 /* Set up iterator IT from face properties at its current position.
3412 Called from handle_stop. */
3414 static enum prop_handled
3415 handle_face_prop (it
)
3419 EMACS_INT next_stop
;
3421 if (!STRINGP (it
->string
))
3424 = face_at_buffer_position (it
->w
,
3426 it
->region_beg_charpos
,
3427 it
->region_end_charpos
,
3430 + TEXT_PROP_DISTANCE_LIMIT
),
3433 /* Is this a start of a run of characters with box face?
3434 Caveat: this can be called for a freshly initialized
3435 iterator; face_id is -1 in this case. We know that the new
3436 face will not change until limit, i.e. if the new face has a
3437 box, all characters up to limit will have one. But, as
3438 usual, we don't know whether limit is really the end. */
3439 if (new_face_id
!= it
->face_id
)
3441 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3443 /* If new face has a box but old face has not, this is
3444 the start of a run of characters with box, i.e. it has
3445 a shadow on the left side. The value of face_id of the
3446 iterator will be -1 if this is the initial call that gets
3447 the face. In this case, we have to look in front of IT's
3448 position and see whether there is a face != new_face_id. */
3449 it
->start_of_box_run_p
3450 = (new_face
->box
!= FACE_NO_BOX
3451 && (it
->face_id
>= 0
3452 || IT_CHARPOS (*it
) == BEG
3453 || new_face_id
!= face_before_it_pos (it
)));
3454 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3459 int base_face_id
, bufpos
;
3461 Lisp_Object from_overlay
3462 = (it
->current
.overlay_string_index
>= 0
3463 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3466 /* See if we got to this string directly or indirectly from
3467 an overlay property. That includes the before-string or
3468 after-string of an overlay, strings in display properties
3469 provided by an overlay, their text properties, etc.
3471 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3472 if (! NILP (from_overlay
))
3473 for (i
= it
->sp
- 1; i
>= 0; i
--)
3475 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3477 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3478 else if (! NILP (it
->stack
[i
].from_overlay
))
3479 from_overlay
= it
->stack
[i
].from_overlay
;
3481 if (!NILP (from_overlay
))
3485 if (! NILP (from_overlay
))
3487 bufpos
= IT_CHARPOS (*it
);
3488 /* For a string from an overlay, the base face depends
3489 only on text properties and ignores overlays. */
3491 = face_for_overlay_string (it
->w
,
3493 it
->region_beg_charpos
,
3494 it
->region_end_charpos
,
3497 + TEXT_PROP_DISTANCE_LIMIT
),
3505 /* For strings from a `display' property, use the face at
3506 IT's current buffer position as the base face to merge
3507 with, so that overlay strings appear in the same face as
3508 surrounding text, unless they specify their own
3510 base_face_id
= underlying_face_id (it
);
3513 new_face_id
= face_at_string_position (it
->w
,
3515 IT_STRING_CHARPOS (*it
),
3517 it
->region_beg_charpos
,
3518 it
->region_end_charpos
,
3522 #if 0 /* This shouldn't be neccessary. Let's check it. */
3523 /* If IT is used to display a mode line we would really like to
3524 use the mode line face instead of the frame's default face. */
3525 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3526 && new_face_id
== DEFAULT_FACE_ID
)
3527 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3530 /* Is this a start of a run of characters with box? Caveat:
3531 this can be called for a freshly allocated iterator; face_id
3532 is -1 is this case. We know that the new face will not
3533 change until the next check pos, i.e. if the new face has a
3534 box, all characters up to that position will have a
3535 box. But, as usual, we don't know whether that position
3536 is really the end. */
3537 if (new_face_id
!= it
->face_id
)
3539 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3540 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3542 /* If new face has a box but old face hasn't, this is the
3543 start of a run of characters with box, i.e. it has a
3544 shadow on the left side. */
3545 it
->start_of_box_run_p
3546 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3547 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3551 it
->face_id
= new_face_id
;
3552 return HANDLED_NORMALLY
;
3556 /* Return the ID of the face ``underlying'' IT's current position,
3557 which is in a string. If the iterator is associated with a
3558 buffer, return the face at IT's current buffer position.
3559 Otherwise, use the iterator's base_face_id. */
3562 underlying_face_id (it
)
3565 int face_id
= it
->base_face_id
, i
;
3567 xassert (STRINGP (it
->string
));
3569 for (i
= it
->sp
- 1; i
>= 0; --i
)
3570 if (NILP (it
->stack
[i
].string
))
3571 face_id
= it
->stack
[i
].face_id
;
3577 /* Compute the face one character before or after the current position
3578 of IT. BEFORE_P non-zero means get the face in front of IT's
3579 position. Value is the id of the face. */
3582 face_before_or_after_it_pos (it
, before_p
)
3587 EMACS_INT next_check_charpos
;
3588 struct text_pos pos
;
3590 xassert (it
->s
== NULL
);
3592 if (STRINGP (it
->string
))
3594 int bufpos
, base_face_id
;
3596 /* No face change past the end of the string (for the case
3597 we are padding with spaces). No face change before the
3599 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3600 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3603 /* Set pos to the position before or after IT's current position. */
3605 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3607 /* For composition, we must check the character after the
3609 pos
= (it
->what
== IT_COMPOSITION
3610 ? string_pos (IT_STRING_CHARPOS (*it
)
3611 + it
->cmp_it
.nchars
, it
->string
)
3612 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3614 if (it
->current
.overlay_string_index
>= 0)
3615 bufpos
= IT_CHARPOS (*it
);
3619 base_face_id
= underlying_face_id (it
);
3621 /* Get the face for ASCII, or unibyte. */
3622 face_id
= face_at_string_position (it
->w
,
3626 it
->region_beg_charpos
,
3627 it
->region_end_charpos
,
3628 &next_check_charpos
,
3631 /* Correct the face for charsets different from ASCII. Do it
3632 for the multibyte case only. The face returned above is
3633 suitable for unibyte text if IT->string is unibyte. */
3634 if (STRING_MULTIBYTE (it
->string
))
3636 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3637 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3639 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3641 c
= string_char_and_length (p
, rest
, &len
);
3642 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3647 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3648 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3651 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3652 pos
= it
->current
.pos
;
3655 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3658 if (it
->what
== IT_COMPOSITION
)
3659 /* For composition, we must check the position after the
3661 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3663 INC_TEXT_POS (pos
, it
->multibyte_p
);
3666 /* Determine face for CHARSET_ASCII, or unibyte. */
3667 face_id
= face_at_buffer_position (it
->w
,
3669 it
->region_beg_charpos
,
3670 it
->region_end_charpos
,
3671 &next_check_charpos
,
3674 /* Correct the face for charsets different from ASCII. Do it
3675 for the multibyte case only. The face returned above is
3676 suitable for unibyte text if current_buffer is unibyte. */
3677 if (it
->multibyte_p
)
3679 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3680 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3681 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3690 /***********************************************************************
3692 ***********************************************************************/
3694 /* Set up iterator IT from invisible properties at its current
3695 position. Called from handle_stop. */
3697 static enum prop_handled
3698 handle_invisible_prop (it
)
3701 enum prop_handled handled
= HANDLED_NORMALLY
;
3703 if (STRINGP (it
->string
))
3705 extern Lisp_Object Qinvisible
;
3706 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3708 /* Get the value of the invisible text property at the
3709 current position. Value will be nil if there is no such
3711 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3712 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3715 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3717 handled
= HANDLED_RECOMPUTE_PROPS
;
3719 /* Get the position at which the next change of the
3720 invisible text property can be found in IT->string.
3721 Value will be nil if the property value is the same for
3722 all the rest of IT->string. */
3723 XSETINT (limit
, SCHARS (it
->string
));
3724 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3727 /* Text at current position is invisible. The next
3728 change in the property is at position end_charpos.
3729 Move IT's current position to that position. */
3730 if (INTEGERP (end_charpos
)
3731 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3733 struct text_pos old
;
3734 old
= it
->current
.string_pos
;
3735 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3736 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3740 /* The rest of the string is invisible. If this is an
3741 overlay string, proceed with the next overlay string
3742 or whatever comes and return a character from there. */
3743 if (it
->current
.overlay_string_index
>= 0)
3745 next_overlay_string (it
);
3746 /* Don't check for overlay strings when we just
3747 finished processing them. */
3748 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3752 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3753 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3761 EMACS_INT newpos
, next_stop
, start_charpos
;
3762 Lisp_Object pos
, prop
, overlay
;
3764 /* First of all, is there invisible text at this position? */
3765 start_charpos
= IT_CHARPOS (*it
);
3766 pos
= make_number (IT_CHARPOS (*it
));
3767 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3769 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3771 /* If we are on invisible text, skip over it. */
3772 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3774 /* Record whether we have to display an ellipsis for the
3776 int display_ellipsis_p
= invis_p
== 2;
3778 handled
= HANDLED_RECOMPUTE_PROPS
;
3780 /* Loop skipping over invisible text. The loop is left at
3781 ZV or with IT on the first char being visible again. */
3784 /* Try to skip some invisible text. Return value is the
3785 position reached which can be equal to IT's position
3786 if there is nothing invisible here. This skips both
3787 over invisible text properties and overlays with
3788 invisible property. */
3789 newpos
= skip_invisible (IT_CHARPOS (*it
),
3790 &next_stop
, ZV
, it
->window
);
3792 /* If we skipped nothing at all we weren't at invisible
3793 text in the first place. If everything to the end of
3794 the buffer was skipped, end the loop. */
3795 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3799 /* We skipped some characters but not necessarily
3800 all there are. Check if we ended up on visible
3801 text. Fget_char_property returns the property of
3802 the char before the given position, i.e. if we
3803 get invis_p = 0, this means that the char at
3804 newpos is visible. */
3805 pos
= make_number (newpos
);
3806 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3807 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3810 /* If we ended up on invisible text, proceed to
3811 skip starting with next_stop. */
3813 IT_CHARPOS (*it
) = next_stop
;
3815 /* If there are adjacent invisible texts, don't lose the
3816 second one's ellipsis. */
3818 display_ellipsis_p
= 1;
3822 /* The position newpos is now either ZV or on visible text. */
3823 IT_CHARPOS (*it
) = newpos
;
3824 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3826 /* If there are before-strings at the start of invisible
3827 text, and the text is invisible because of a text
3828 property, arrange to show before-strings because 20.x did
3829 it that way. (If the text is invisible because of an
3830 overlay property instead of a text property, this is
3831 already handled in the overlay code.) */
3833 && get_overlay_strings (it
, start_charpos
))
3835 handled
= HANDLED_RECOMPUTE_PROPS
;
3836 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3838 else if (display_ellipsis_p
)
3840 /* Make sure that the glyphs of the ellipsis will get
3841 correct `charpos' values. If we would not update
3842 it->position here, the glyphs would belong to the
3843 last visible character _before_ the invisible
3844 text, which confuses `set_cursor_from_row'.
3846 We use the last invisible position instead of the
3847 first because this way the cursor is always drawn on
3848 the first "." of the ellipsis, whenever PT is inside
3849 the invisible text. Otherwise the cursor would be
3850 placed _after_ the ellipsis when the point is after the
3851 first invisible character. */
3852 if (!STRINGP (it
->object
))
3854 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3855 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3858 /* Let the ellipsis display before
3859 considering any properties of the following char.
3860 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3861 handled
= HANDLED_RETURN
;
3870 /* Make iterator IT return `...' next.
3871 Replaces LEN characters from buffer. */
3874 setup_for_ellipsis (it
, len
)
3878 /* Use the display table definition for `...'. Invalid glyphs
3879 will be handled by the method returning elements from dpvec. */
3880 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3882 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3883 it
->dpvec
= v
->contents
;
3884 it
->dpend
= v
->contents
+ v
->size
;
3888 /* Default `...'. */
3889 it
->dpvec
= default_invis_vector
;
3890 it
->dpend
= default_invis_vector
+ 3;
3893 it
->dpvec_char_len
= len
;
3894 it
->current
.dpvec_index
= 0;
3895 it
->dpvec_face_id
= -1;
3897 /* Remember the current face id in case glyphs specify faces.
3898 IT's face is restored in set_iterator_to_next.
3899 saved_face_id was set to preceding char's face in handle_stop. */
3900 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3901 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3903 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3909 /***********************************************************************
3911 ***********************************************************************/
3913 /* Set up iterator IT from `display' property at its current position.
3914 Called from handle_stop.
3915 We return HANDLED_RETURN if some part of the display property
3916 overrides the display of the buffer text itself.
3917 Otherwise we return HANDLED_NORMALLY. */
3919 static enum prop_handled
3920 handle_display_prop (it
)
3923 Lisp_Object prop
, object
, overlay
;
3924 struct text_pos
*position
;
3925 /* Nonzero if some property replaces the display of the text itself. */
3926 int display_replaced_p
= 0;
3928 if (STRINGP (it
->string
))
3930 object
= it
->string
;
3931 position
= &it
->current
.string_pos
;
3935 XSETWINDOW (object
, it
->w
);
3936 position
= &it
->current
.pos
;
3939 /* Reset those iterator values set from display property values. */
3940 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3941 it
->space_width
= Qnil
;
3942 it
->font_height
= Qnil
;
3945 /* We don't support recursive `display' properties, i.e. string
3946 values that have a string `display' property, that have a string
3947 `display' property etc. */
3948 if (!it
->string_from_display_prop_p
)
3949 it
->area
= TEXT_AREA
;
3951 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3952 Qdisplay
, object
, &overlay
);
3954 return HANDLED_NORMALLY
;
3955 /* Now OVERLAY is the overlay that gave us this property, or nil
3956 if it was a text property. */
3958 if (!STRINGP (it
->string
))
3959 object
= it
->w
->buffer
;
3962 /* Simple properties. */
3963 && !EQ (XCAR (prop
), Qimage
)
3964 && !EQ (XCAR (prop
), Qspace
)
3965 && !EQ (XCAR (prop
), Qwhen
)
3966 && !EQ (XCAR (prop
), Qslice
)
3967 && !EQ (XCAR (prop
), Qspace_width
)
3968 && !EQ (XCAR (prop
), Qheight
)
3969 && !EQ (XCAR (prop
), Qraise
)
3970 /* Marginal area specifications. */
3971 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3972 && !EQ (XCAR (prop
), Qleft_fringe
)
3973 && !EQ (XCAR (prop
), Qright_fringe
)
3974 && !NILP (XCAR (prop
)))
3976 for (; CONSP (prop
); prop
= XCDR (prop
))
3978 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3979 position
, display_replaced_p
))
3981 display_replaced_p
= 1;
3982 /* If some text in a string is replaced, `position' no
3983 longer points to the position of `object'. */
3984 if (STRINGP (object
))
3989 else if (VECTORP (prop
))
3992 for (i
= 0; i
< ASIZE (prop
); ++i
)
3993 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3994 position
, display_replaced_p
))
3996 display_replaced_p
= 1;
3997 /* If some text in a string is replaced, `position' no
3998 longer points to the position of `object'. */
3999 if (STRINGP (object
))
4005 int ret
= handle_single_display_spec (it
, prop
, object
, overlay
,
4007 if (ret
< 0) /* Replaced by "", i.e. nothing. */
4008 return HANDLED_RECOMPUTE_PROPS
;
4010 display_replaced_p
= 1;
4013 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4017 /* Value is the position of the end of the `display' property starting
4018 at START_POS in OBJECT. */
4020 static struct text_pos
4021 display_prop_end (it
, object
, start_pos
)
4024 struct text_pos start_pos
;
4027 struct text_pos end_pos
;
4029 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4030 Qdisplay
, object
, Qnil
);
4031 CHARPOS (end_pos
) = XFASTINT (end
);
4032 if (STRINGP (object
))
4033 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4035 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4041 /* Set up IT from a single `display' specification PROP. OBJECT
4042 is the object in which the `display' property was found. *POSITION
4043 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4044 means that we previously saw a display specification which already
4045 replaced text display with something else, for example an image;
4046 we ignore such properties after the first one has been processed.
4048 OVERLAY is the overlay this `display' property came from,
4049 or nil if it was a text property.
4051 If PROP is a `space' or `image' specification, and in some other
4052 cases too, set *POSITION to the position where the `display'
4055 Value is non-zero if something was found which replaces the display
4056 of buffer or string text. Specifically, the value is -1 if that
4057 "something" is "nothing". */
4060 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4061 display_replaced_before_p
)
4065 Lisp_Object overlay
;
4066 struct text_pos
*position
;
4067 int display_replaced_before_p
;
4070 Lisp_Object location
, value
;
4071 struct text_pos start_pos
, save_pos
;
4074 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4075 If the result is non-nil, use VALUE instead of SPEC. */
4077 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4086 if (!NILP (form
) && !EQ (form
, Qt
))
4088 int count
= SPECPDL_INDEX ();
4089 struct gcpro gcpro1
;
4091 /* Bind `object' to the object having the `display' property, a
4092 buffer or string. Bind `position' to the position in the
4093 object where the property was found, and `buffer-position'
4094 to the current position in the buffer. */
4095 specbind (Qobject
, object
);
4096 specbind (Qposition
, make_number (CHARPOS (*position
)));
4097 specbind (Qbuffer_position
,
4098 make_number (STRINGP (object
)
4099 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4101 form
= safe_eval (form
);
4103 unbind_to (count
, Qnil
);
4109 /* Handle `(height HEIGHT)' specifications. */
4111 && EQ (XCAR (spec
), Qheight
)
4112 && CONSP (XCDR (spec
)))
4114 if (!FRAME_WINDOW_P (it
->f
))
4117 it
->font_height
= XCAR (XCDR (spec
));
4118 if (!NILP (it
->font_height
))
4120 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4121 int new_height
= -1;
4123 if (CONSP (it
->font_height
)
4124 && (EQ (XCAR (it
->font_height
), Qplus
)
4125 || EQ (XCAR (it
->font_height
), Qminus
))
4126 && CONSP (XCDR (it
->font_height
))
4127 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4129 /* `(+ N)' or `(- N)' where N is an integer. */
4130 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4131 if (EQ (XCAR (it
->font_height
), Qplus
))
4133 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4135 else if (FUNCTIONP (it
->font_height
))
4137 /* Call function with current height as argument.
4138 Value is the new height. */
4140 height
= safe_call1 (it
->font_height
,
4141 face
->lface
[LFACE_HEIGHT_INDEX
]);
4142 if (NUMBERP (height
))
4143 new_height
= XFLOATINT (height
);
4145 else if (NUMBERP (it
->font_height
))
4147 /* Value is a multiple of the canonical char height. */
4150 face
= FACE_FROM_ID (it
->f
,
4151 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4152 new_height
= (XFLOATINT (it
->font_height
)
4153 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4157 /* Evaluate IT->font_height with `height' bound to the
4158 current specified height to get the new height. */
4159 int count
= SPECPDL_INDEX ();
4161 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4162 value
= safe_eval (it
->font_height
);
4163 unbind_to (count
, Qnil
);
4165 if (NUMBERP (value
))
4166 new_height
= XFLOATINT (value
);
4170 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4176 /* Handle `(space-width WIDTH)'. */
4178 && EQ (XCAR (spec
), Qspace_width
)
4179 && CONSP (XCDR (spec
)))
4181 if (!FRAME_WINDOW_P (it
->f
))
4184 value
= XCAR (XCDR (spec
));
4185 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4186 it
->space_width
= value
;
4191 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4193 && EQ (XCAR (spec
), Qslice
))
4197 if (!FRAME_WINDOW_P (it
->f
))
4200 if (tem
= XCDR (spec
), CONSP (tem
))
4202 it
->slice
.x
= XCAR (tem
);
4203 if (tem
= XCDR (tem
), CONSP (tem
))
4205 it
->slice
.y
= XCAR (tem
);
4206 if (tem
= XCDR (tem
), CONSP (tem
))
4208 it
->slice
.width
= XCAR (tem
);
4209 if (tem
= XCDR (tem
), CONSP (tem
))
4210 it
->slice
.height
= XCAR (tem
);
4218 /* Handle `(raise FACTOR)'. */
4220 && EQ (XCAR (spec
), Qraise
)
4221 && CONSP (XCDR (spec
)))
4223 if (!FRAME_WINDOW_P (it
->f
))
4226 #ifdef HAVE_WINDOW_SYSTEM
4227 value
= XCAR (XCDR (spec
));
4228 if (NUMBERP (value
))
4230 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4231 it
->voffset
= - (XFLOATINT (value
)
4232 * (FONT_HEIGHT (face
->font
)));
4234 #endif /* HAVE_WINDOW_SYSTEM */
4239 /* Don't handle the other kinds of display specifications
4240 inside a string that we got from a `display' property. */
4241 if (it
->string_from_display_prop_p
)
4244 /* Characters having this form of property are not displayed, so
4245 we have to find the end of the property. */
4246 start_pos
= *position
;
4247 *position
= display_prop_end (it
, object
, start_pos
);
4250 /* Stop the scan at that end position--we assume that all
4251 text properties change there. */
4252 it
->stop_charpos
= position
->charpos
;
4254 /* Handle `(left-fringe BITMAP [FACE])'
4255 and `(right-fringe BITMAP [FACE])'. */
4257 && (EQ (XCAR (spec
), Qleft_fringe
)
4258 || EQ (XCAR (spec
), Qright_fringe
))
4259 && CONSP (XCDR (spec
)))
4261 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4264 if (!FRAME_WINDOW_P (it
->f
))
4265 /* If we return here, POSITION has been advanced
4266 across the text with this property. */
4269 #ifdef HAVE_WINDOW_SYSTEM
4270 value
= XCAR (XCDR (spec
));
4271 if (!SYMBOLP (value
)
4272 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4273 /* If we return here, POSITION has been advanced
4274 across the text with this property. */
4277 if (CONSP (XCDR (XCDR (spec
))))
4279 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4280 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4286 /* Save current settings of IT so that we can restore them
4287 when we are finished with the glyph property value. */
4289 save_pos
= it
->position
;
4290 it
->position
= *position
;
4292 it
->position
= save_pos
;
4294 it
->area
= TEXT_AREA
;
4295 it
->what
= IT_IMAGE
;
4296 it
->image_id
= -1; /* no image */
4297 it
->position
= start_pos
;
4298 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4299 it
->method
= GET_FROM_IMAGE
;
4300 it
->from_overlay
= Qnil
;
4301 it
->face_id
= face_id
;
4303 /* Say that we haven't consumed the characters with
4304 `display' property yet. The call to pop_it in
4305 set_iterator_to_next will clean this up. */
4306 *position
= start_pos
;
4308 if (EQ (XCAR (spec
), Qleft_fringe
))
4310 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4311 it
->left_user_fringe_face_id
= face_id
;
4315 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4316 it
->right_user_fringe_face_id
= face_id
;
4318 #endif /* HAVE_WINDOW_SYSTEM */
4322 /* Prepare to handle `((margin left-margin) ...)',
4323 `((margin right-margin) ...)' and `((margin nil) ...)'
4324 prefixes for display specifications. */
4325 location
= Qunbound
;
4326 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4330 value
= XCDR (spec
);
4332 value
= XCAR (value
);
4335 if (EQ (XCAR (tem
), Qmargin
)
4336 && (tem
= XCDR (tem
),
4337 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4339 || EQ (tem
, Qleft_margin
)
4340 || EQ (tem
, Qright_margin
))))
4344 if (EQ (location
, Qunbound
))
4350 /* After this point, VALUE is the property after any
4351 margin prefix has been stripped. It must be a string,
4352 an image specification, or `(space ...)'.
4354 LOCATION specifies where to display: `left-margin',
4355 `right-margin' or nil. */
4357 valid_p
= (STRINGP (value
)
4358 #ifdef HAVE_WINDOW_SYSTEM
4359 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4360 #endif /* not HAVE_WINDOW_SYSTEM */
4361 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4363 if (valid_p
&& !display_replaced_before_p
)
4365 /* Save current settings of IT so that we can restore them
4366 when we are finished with the glyph property value. */
4367 save_pos
= it
->position
;
4368 it
->position
= *position
;
4370 it
->position
= save_pos
;
4371 it
->from_overlay
= overlay
;
4373 if (NILP (location
))
4374 it
->area
= TEXT_AREA
;
4375 else if (EQ (location
, Qleft_margin
))
4376 it
->area
= LEFT_MARGIN_AREA
;
4378 it
->area
= RIGHT_MARGIN_AREA
;
4380 if (STRINGP (value
))
4382 if (SCHARS (value
) == 0)
4385 return -1; /* Replaced by "", i.e. nothing. */
4388 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4389 it
->current
.overlay_string_index
= -1;
4390 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4391 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4392 it
->method
= GET_FROM_STRING
;
4393 it
->stop_charpos
= 0;
4394 it
->string_from_display_prop_p
= 1;
4395 /* Say that we haven't consumed the characters with
4396 `display' property yet. The call to pop_it in
4397 set_iterator_to_next will clean this up. */
4398 if (BUFFERP (object
))
4399 *position
= start_pos
;
4401 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4403 it
->method
= GET_FROM_STRETCH
;
4405 *position
= it
->position
= start_pos
;
4407 #ifdef HAVE_WINDOW_SYSTEM
4410 it
->what
= IT_IMAGE
;
4411 it
->image_id
= lookup_image (it
->f
, value
);
4412 it
->position
= start_pos
;
4413 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4414 it
->method
= GET_FROM_IMAGE
;
4416 /* Say that we haven't consumed the characters with
4417 `display' property yet. The call to pop_it in
4418 set_iterator_to_next will clean this up. */
4419 *position
= start_pos
;
4421 #endif /* HAVE_WINDOW_SYSTEM */
4426 /* Invalid property or property not supported. Restore
4427 POSITION to what it was before. */
4428 *position
= start_pos
;
4433 /* Check if SPEC is a display sub-property value whose text should be
4434 treated as intangible. */
4437 single_display_spec_intangible_p (prop
)
4440 /* Skip over `when FORM'. */
4441 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4455 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4456 we don't need to treat text as intangible. */
4457 if (EQ (XCAR (prop
), Qmargin
))
4465 || EQ (XCAR (prop
), Qleft_margin
)
4466 || EQ (XCAR (prop
), Qright_margin
))
4470 return (CONSP (prop
)
4471 && (EQ (XCAR (prop
), Qimage
)
4472 || EQ (XCAR (prop
), Qspace
)));
4476 /* Check if PROP is a display property value whose text should be
4477 treated as intangible. */
4480 display_prop_intangible_p (prop
)
4484 && CONSP (XCAR (prop
))
4485 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4487 /* A list of sub-properties. */
4488 while (CONSP (prop
))
4490 if (single_display_spec_intangible_p (XCAR (prop
)))
4495 else if (VECTORP (prop
))
4497 /* A vector of sub-properties. */
4499 for (i
= 0; i
< ASIZE (prop
); ++i
)
4500 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4504 return single_display_spec_intangible_p (prop
);
4510 /* Return 1 if PROP is a display sub-property value containing STRING. */
4513 single_display_spec_string_p (prop
, string
)
4514 Lisp_Object prop
, string
;
4516 if (EQ (string
, prop
))
4519 /* Skip over `when FORM'. */
4520 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4529 /* Skip over `margin LOCATION'. */
4530 if (EQ (XCAR (prop
), Qmargin
))
4541 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4545 /* Return 1 if STRING appears in the `display' property PROP. */
4548 display_prop_string_p (prop
, string
)
4549 Lisp_Object prop
, string
;
4552 && CONSP (XCAR (prop
))
4553 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4555 /* A list of sub-properties. */
4556 while (CONSP (prop
))
4558 if (single_display_spec_string_p (XCAR (prop
), string
))
4563 else if (VECTORP (prop
))
4565 /* A vector of sub-properties. */
4567 for (i
= 0; i
< ASIZE (prop
); ++i
)
4568 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4572 return single_display_spec_string_p (prop
, string
);
4578 /* Determine from which buffer position in W's buffer STRING comes
4579 from. AROUND_CHARPOS is an approximate position where it could
4580 be from. Value is the buffer position or 0 if it couldn't be
4583 W's buffer must be current.
4585 This function is necessary because we don't record buffer positions
4586 in glyphs generated from strings (to keep struct glyph small).
4587 This function may only use code that doesn't eval because it is
4588 called asynchronously from note_mouse_highlight. */
4591 string_buffer_position (w
, string
, around_charpos
)
4596 Lisp_Object limit
, prop
, pos
;
4597 const int MAX_DISTANCE
= 1000;
4600 pos
= make_number (around_charpos
);
4601 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4602 while (!found
&& !EQ (pos
, limit
))
4604 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4605 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4608 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4613 pos
= make_number (around_charpos
);
4614 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4615 while (!found
&& !EQ (pos
, limit
))
4617 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4618 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4621 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4626 return found
? XINT (pos
) : 0;
4631 /***********************************************************************
4632 `composition' property
4633 ***********************************************************************/
4635 /* Set up iterator IT from `composition' property at its current
4636 position. Called from handle_stop. */
4638 static enum prop_handled
4639 handle_composition_prop (it
)
4642 Lisp_Object prop
, string
;
4643 EMACS_INT pos
, pos_byte
, start
, end
;
4645 if (STRINGP (it
->string
))
4649 pos
= IT_STRING_CHARPOS (*it
);
4650 pos_byte
= IT_STRING_BYTEPOS (*it
);
4651 string
= it
->string
;
4652 s
= SDATA (string
) + pos_byte
;
4653 it
->c
= STRING_CHAR (s
, 0);
4657 pos
= IT_CHARPOS (*it
);
4658 pos_byte
= IT_BYTEPOS (*it
);
4660 it
->c
= FETCH_CHAR (pos_byte
);
4663 /* If there's a valid composition and point is not inside of the
4664 composition (in the case that the composition is from the current
4665 buffer), draw a glyph composed from the composition components. */
4666 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4667 && COMPOSITION_VALID_P (start
, end
, prop
)
4668 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4672 if (STRINGP (it
->string
))
4673 pos_byte
= string_char_to_byte (it
->string
, start
);
4675 pos_byte
= CHAR_TO_BYTE (start
);
4677 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4680 if (it
->cmp_it
.id
>= 0)
4683 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4684 it
->cmp_it
.nglyphs
= -1;
4688 return HANDLED_NORMALLY
;
4693 /***********************************************************************
4695 ***********************************************************************/
4697 /* The following structure is used to record overlay strings for
4698 later sorting in load_overlay_strings. */
4700 struct overlay_entry
4702 Lisp_Object overlay
;
4709 /* Set up iterator IT from overlay strings at its current position.
4710 Called from handle_stop. */
4712 static enum prop_handled
4713 handle_overlay_change (it
)
4716 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4717 return HANDLED_RECOMPUTE_PROPS
;
4719 return HANDLED_NORMALLY
;
4723 /* Set up the next overlay string for delivery by IT, if there is an
4724 overlay string to deliver. Called by set_iterator_to_next when the
4725 end of the current overlay string is reached. If there are more
4726 overlay strings to display, IT->string and
4727 IT->current.overlay_string_index are set appropriately here.
4728 Otherwise IT->string is set to nil. */
4731 next_overlay_string (it
)
4734 ++it
->current
.overlay_string_index
;
4735 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4737 /* No more overlay strings. Restore IT's settings to what
4738 they were before overlay strings were processed, and
4739 continue to deliver from current_buffer. */
4741 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4744 || (NILP (it
->string
)
4745 && it
->method
== GET_FROM_BUFFER
4746 && it
->stop_charpos
>= BEGV
4747 && it
->stop_charpos
<= it
->end_charpos
));
4748 it
->current
.overlay_string_index
= -1;
4749 it
->n_overlay_strings
= 0;
4751 /* If we're at the end of the buffer, record that we have
4752 processed the overlay strings there already, so that
4753 next_element_from_buffer doesn't try it again. */
4754 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4755 it
->overlay_strings_at_end_processed_p
= 1;
4759 /* There are more overlay strings to process. If
4760 IT->current.overlay_string_index has advanced to a position
4761 where we must load IT->overlay_strings with more strings, do
4763 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4765 if (it
->current
.overlay_string_index
&& i
== 0)
4766 load_overlay_strings (it
, 0);
4768 /* Initialize IT to deliver display elements from the overlay
4770 it
->string
= it
->overlay_strings
[i
];
4771 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4772 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4773 it
->method
= GET_FROM_STRING
;
4774 it
->stop_charpos
= 0;
4775 if (it
->cmp_it
.stop_pos
>= 0)
4776 it
->cmp_it
.stop_pos
= 0;
4783 /* Compare two overlay_entry structures E1 and E2. Used as a
4784 comparison function for qsort in load_overlay_strings. Overlay
4785 strings for the same position are sorted so that
4787 1. All after-strings come in front of before-strings, except
4788 when they come from the same overlay.
4790 2. Within after-strings, strings are sorted so that overlay strings
4791 from overlays with higher priorities come first.
4793 2. Within before-strings, strings are sorted so that overlay
4794 strings from overlays with higher priorities come last.
4796 Value is analogous to strcmp. */
4800 compare_overlay_entries (e1
, e2
)
4803 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4804 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4807 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4809 /* Let after-strings appear in front of before-strings if
4810 they come from different overlays. */
4811 if (EQ (entry1
->overlay
, entry2
->overlay
))
4812 result
= entry1
->after_string_p
? 1 : -1;
4814 result
= entry1
->after_string_p
? -1 : 1;
4816 else if (entry1
->after_string_p
)
4817 /* After-strings sorted in order of decreasing priority. */
4818 result
= entry2
->priority
- entry1
->priority
;
4820 /* Before-strings sorted in order of increasing priority. */
4821 result
= entry1
->priority
- entry2
->priority
;
4827 /* Load the vector IT->overlay_strings with overlay strings from IT's
4828 current buffer position, or from CHARPOS if that is > 0. Set
4829 IT->n_overlays to the total number of overlay strings found.
4831 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4832 a time. On entry into load_overlay_strings,
4833 IT->current.overlay_string_index gives the number of overlay
4834 strings that have already been loaded by previous calls to this
4837 IT->add_overlay_start contains an additional overlay start
4838 position to consider for taking overlay strings from, if non-zero.
4839 This position comes into play when the overlay has an `invisible'
4840 property, and both before and after-strings. When we've skipped to
4841 the end of the overlay, because of its `invisible' property, we
4842 nevertheless want its before-string to appear.
4843 IT->add_overlay_start will contain the overlay start position
4846 Overlay strings are sorted so that after-string strings come in
4847 front of before-string strings. Within before and after-strings,
4848 strings are sorted by overlay priority. See also function
4849 compare_overlay_entries. */
4852 load_overlay_strings (it
, charpos
)
4856 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4857 Lisp_Object overlay
, window
, str
, invisible
;
4858 struct Lisp_Overlay
*ov
;
4861 int n
= 0, i
, j
, invis_p
;
4862 struct overlay_entry
*entries
4863 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4866 charpos
= IT_CHARPOS (*it
);
4868 /* Append the overlay string STRING of overlay OVERLAY to vector
4869 `entries' which has size `size' and currently contains `n'
4870 elements. AFTER_P non-zero means STRING is an after-string of
4872 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4875 Lisp_Object priority; \
4879 int new_size = 2 * size; \
4880 struct overlay_entry *old = entries; \
4882 (struct overlay_entry *) alloca (new_size \
4883 * sizeof *entries); \
4884 bcopy (old, entries, size * sizeof *entries); \
4888 entries[n].string = (STRING); \
4889 entries[n].overlay = (OVERLAY); \
4890 priority = Foverlay_get ((OVERLAY), Qpriority); \
4891 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4892 entries[n].after_string_p = (AFTER_P); \
4897 /* Process overlay before the overlay center. */
4898 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4900 XSETMISC (overlay
, ov
);
4901 xassert (OVERLAYP (overlay
));
4902 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4903 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4908 /* Skip this overlay if it doesn't start or end at IT's current
4910 if (end
!= charpos
&& start
!= charpos
)
4913 /* Skip this overlay if it doesn't apply to IT->w. */
4914 window
= Foverlay_get (overlay
, Qwindow
);
4915 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4918 /* If the text ``under'' the overlay is invisible, both before-
4919 and after-strings from this overlay are visible; start and
4920 end position are indistinguishable. */
4921 invisible
= Foverlay_get (overlay
, Qinvisible
);
4922 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4924 /* If overlay has a non-empty before-string, record it. */
4925 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4926 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4928 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4930 /* If overlay has a non-empty after-string, record it. */
4931 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4932 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4934 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4937 /* Process overlays after the overlay center. */
4938 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4940 XSETMISC (overlay
, ov
);
4941 xassert (OVERLAYP (overlay
));
4942 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4943 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4945 if (start
> charpos
)
4948 /* Skip this overlay if it doesn't start or end at IT's current
4950 if (end
!= charpos
&& start
!= charpos
)
4953 /* Skip this overlay if it doesn't apply to IT->w. */
4954 window
= Foverlay_get (overlay
, Qwindow
);
4955 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4958 /* If the text ``under'' the overlay is invisible, it has a zero
4959 dimension, and both before- and after-strings apply. */
4960 invisible
= Foverlay_get (overlay
, Qinvisible
);
4961 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4963 /* If overlay has a non-empty before-string, record it. */
4964 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4965 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4967 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4969 /* If overlay has a non-empty after-string, record it. */
4970 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4971 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4973 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4976 #undef RECORD_OVERLAY_STRING
4980 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4982 /* Record the total number of strings to process. */
4983 it
->n_overlay_strings
= n
;
4985 /* IT->current.overlay_string_index is the number of overlay strings
4986 that have already been consumed by IT. Copy some of the
4987 remaining overlay strings to IT->overlay_strings. */
4989 j
= it
->current
.overlay_string_index
;
4990 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4992 it
->overlay_strings
[i
] = entries
[j
].string
;
4993 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5000 /* Get the first chunk of overlay strings at IT's current buffer
5001 position, or at CHARPOS if that is > 0. Value is non-zero if at
5002 least one overlay string was found. */
5005 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5010 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5011 process. This fills IT->overlay_strings with strings, and sets
5012 IT->n_overlay_strings to the total number of strings to process.
5013 IT->pos.overlay_string_index has to be set temporarily to zero
5014 because load_overlay_strings needs this; it must be set to -1
5015 when no overlay strings are found because a zero value would
5016 indicate a position in the first overlay string. */
5017 it
->current
.overlay_string_index
= 0;
5018 load_overlay_strings (it
, charpos
);
5020 /* If we found overlay strings, set up IT to deliver display
5021 elements from the first one. Otherwise set up IT to deliver
5022 from current_buffer. */
5023 if (it
->n_overlay_strings
)
5025 /* Make sure we know settings in current_buffer, so that we can
5026 restore meaningful values when we're done with the overlay
5029 compute_stop_pos (it
);
5030 xassert (it
->face_id
>= 0);
5032 /* Save IT's settings. They are restored after all overlay
5033 strings have been processed. */
5034 xassert (!compute_stop_p
|| it
->sp
== 0);
5037 /* Set up IT to deliver display elements from the first overlay
5039 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5040 it
->string
= it
->overlay_strings
[0];
5041 it
->from_overlay
= Qnil
;
5042 it
->stop_charpos
= 0;
5043 xassert (STRINGP (it
->string
));
5044 it
->end_charpos
= SCHARS (it
->string
);
5045 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5046 it
->method
= GET_FROM_STRING
;
5050 it
->current
.overlay_string_index
= -1;
5055 get_overlay_strings (it
, charpos
)
5060 it
->method
= GET_FROM_BUFFER
;
5062 (void) get_overlay_strings_1 (it
, charpos
, 1);
5066 /* Value is non-zero if we found at least one overlay string. */
5067 return STRINGP (it
->string
);
5072 /***********************************************************************
5073 Saving and restoring state
5074 ***********************************************************************/
5076 /* Save current settings of IT on IT->stack. Called, for example,
5077 before setting up IT for an overlay string, to be able to restore
5078 IT's settings to what they were after the overlay string has been
5085 struct iterator_stack_entry
*p
;
5087 xassert (it
->sp
< IT_STACK_SIZE
);
5088 p
= it
->stack
+ it
->sp
;
5090 p
->stop_charpos
= it
->stop_charpos
;
5091 p
->cmp_it
= it
->cmp_it
;
5092 xassert (it
->face_id
>= 0);
5093 p
->face_id
= it
->face_id
;
5094 p
->string
= it
->string
;
5095 p
->method
= it
->method
;
5096 p
->from_overlay
= it
->from_overlay
;
5099 case GET_FROM_IMAGE
:
5100 p
->u
.image
.object
= it
->object
;
5101 p
->u
.image
.image_id
= it
->image_id
;
5102 p
->u
.image
.slice
= it
->slice
;
5104 case GET_FROM_STRETCH
:
5105 p
->u
.stretch
.object
= it
->object
;
5108 p
->position
= it
->position
;
5109 p
->current
= it
->current
;
5110 p
->end_charpos
= it
->end_charpos
;
5111 p
->string_nchars
= it
->string_nchars
;
5113 p
->multibyte_p
= it
->multibyte_p
;
5114 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5115 p
->space_width
= it
->space_width
;
5116 p
->font_height
= it
->font_height
;
5117 p
->voffset
= it
->voffset
;
5118 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5119 p
->display_ellipsis_p
= 0;
5124 /* Restore IT's settings from IT->stack. Called, for example, when no
5125 more overlay strings must be processed, and we return to delivering
5126 display elements from a buffer, or when the end of a string from a
5127 `display' property is reached and we return to delivering display
5128 elements from an overlay string, or from a buffer. */
5134 struct iterator_stack_entry
*p
;
5136 xassert (it
->sp
> 0);
5138 p
= it
->stack
+ it
->sp
;
5139 it
->stop_charpos
= p
->stop_charpos
;
5140 it
->cmp_it
= p
->cmp_it
;
5141 it
->face_id
= p
->face_id
;
5142 it
->current
= p
->current
;
5143 it
->position
= p
->position
;
5144 it
->string
= p
->string
;
5145 it
->from_overlay
= p
->from_overlay
;
5146 if (NILP (it
->string
))
5147 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5148 it
->method
= p
->method
;
5151 case GET_FROM_IMAGE
:
5152 it
->image_id
= p
->u
.image
.image_id
;
5153 it
->object
= p
->u
.image
.object
;
5154 it
->slice
= p
->u
.image
.slice
;
5156 case GET_FROM_STRETCH
:
5157 it
->object
= p
->u
.comp
.object
;
5159 case GET_FROM_BUFFER
:
5160 it
->object
= it
->w
->buffer
;
5162 case GET_FROM_STRING
:
5163 it
->object
= it
->string
;
5166 it
->end_charpos
= p
->end_charpos
;
5167 it
->string_nchars
= p
->string_nchars
;
5169 it
->multibyte_p
= p
->multibyte_p
;
5170 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5171 it
->space_width
= p
->space_width
;
5172 it
->font_height
= p
->font_height
;
5173 it
->voffset
= p
->voffset
;
5174 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5179 /***********************************************************************
5181 ***********************************************************************/
5183 /* Set IT's current position to the previous line start. */
5186 back_to_previous_line_start (it
)
5189 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5190 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5194 /* Move IT to the next line start.
5196 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5197 we skipped over part of the text (as opposed to moving the iterator
5198 continuously over the text). Otherwise, don't change the value
5201 Newlines may come from buffer text, overlay strings, or strings
5202 displayed via the `display' property. That's the reason we can't
5203 simply use find_next_newline_no_quit.
5205 Note that this function may not skip over invisible text that is so
5206 because of text properties and immediately follows a newline. If
5207 it would, function reseat_at_next_visible_line_start, when called
5208 from set_iterator_to_next, would effectively make invisible
5209 characters following a newline part of the wrong glyph row, which
5210 leads to wrong cursor motion. */
5213 forward_to_next_line_start (it
, skipped_p
)
5217 int old_selective
, newline_found_p
, n
;
5218 const int MAX_NEWLINE_DISTANCE
= 500;
5220 /* If already on a newline, just consume it to avoid unintended
5221 skipping over invisible text below. */
5222 if (it
->what
== IT_CHARACTER
5224 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5226 set_iterator_to_next (it
, 0);
5231 /* Don't handle selective display in the following. It's (a)
5232 unnecessary because it's done by the caller, and (b) leads to an
5233 infinite recursion because next_element_from_ellipsis indirectly
5234 calls this function. */
5235 old_selective
= it
->selective
;
5238 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5239 from buffer text. */
5240 for (n
= newline_found_p
= 0;
5241 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5242 n
+= STRINGP (it
->string
) ? 0 : 1)
5244 if (!get_next_display_element (it
))
5246 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5247 set_iterator_to_next (it
, 0);
5250 /* If we didn't find a newline near enough, see if we can use a
5252 if (!newline_found_p
)
5254 int start
= IT_CHARPOS (*it
);
5255 int limit
= find_next_newline_no_quit (start
, 1);
5258 xassert (!STRINGP (it
->string
));
5260 /* If there isn't any `display' property in sight, and no
5261 overlays, we can just use the position of the newline in
5263 if (it
->stop_charpos
>= limit
5264 || ((pos
= Fnext_single_property_change (make_number (start
),
5266 Qnil
, make_number (limit
)),
5268 && next_overlay_change (start
) == ZV
))
5270 IT_CHARPOS (*it
) = limit
;
5271 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5272 *skipped_p
= newline_found_p
= 1;
5276 while (get_next_display_element (it
)
5277 && !newline_found_p
)
5279 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5280 set_iterator_to_next (it
, 0);
5285 it
->selective
= old_selective
;
5286 return newline_found_p
;
5290 /* Set IT's current position to the previous visible line start. Skip
5291 invisible text that is so either due to text properties or due to
5292 selective display. Caution: this does not change IT->current_x and
5296 back_to_previous_visible_line_start (it
)
5299 while (IT_CHARPOS (*it
) > BEGV
)
5301 back_to_previous_line_start (it
);
5303 if (IT_CHARPOS (*it
) <= BEGV
)
5306 /* If selective > 0, then lines indented more than that values
5308 if (it
->selective
> 0
5309 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5310 (double) it
->selective
)) /* iftc */
5313 /* Check the newline before point for invisibility. */
5316 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5317 Qinvisible
, it
->window
);
5318 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5322 if (IT_CHARPOS (*it
) <= BEGV
)
5329 Lisp_Object val
, overlay
;
5331 /* If newline is part of a composition, continue from start of composition */
5332 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5333 && beg
< IT_CHARPOS (*it
))
5336 /* If newline is replaced by a display property, find start of overlay
5337 or interval and continue search from that point. */
5339 pos
= --IT_CHARPOS (it2
);
5342 it2
.string_from_display_prop_p
= 0;
5343 if (handle_display_prop (&it2
) == HANDLED_RETURN
5344 && !NILP (val
= get_char_property_and_overlay
5345 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5346 && (OVERLAYP (overlay
)
5347 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5348 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5351 /* Newline is not replaced by anything -- so we are done. */
5357 IT_CHARPOS (*it
) = beg
;
5358 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5362 it
->continuation_lines_width
= 0;
5364 xassert (IT_CHARPOS (*it
) >= BEGV
);
5365 xassert (IT_CHARPOS (*it
) == BEGV
5366 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5371 /* Reseat iterator IT at the previous visible line start. Skip
5372 invisible text that is so either due to text properties or due to
5373 selective display. At the end, update IT's overlay information,
5374 face information etc. */
5377 reseat_at_previous_visible_line_start (it
)
5380 back_to_previous_visible_line_start (it
);
5381 reseat (it
, it
->current
.pos
, 1);
5386 /* Reseat iterator IT on the next visible line start in the current
5387 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5388 preceding the line start. Skip over invisible text that is so
5389 because of selective display. Compute faces, overlays etc at the
5390 new position. Note that this function does not skip over text that
5391 is invisible because of text properties. */
5394 reseat_at_next_visible_line_start (it
, on_newline_p
)
5398 int newline_found_p
, skipped_p
= 0;
5400 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5402 /* Skip over lines that are invisible because they are indented
5403 more than the value of IT->selective. */
5404 if (it
->selective
> 0)
5405 while (IT_CHARPOS (*it
) < ZV
5406 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5407 (double) it
->selective
)) /* iftc */
5409 xassert (IT_BYTEPOS (*it
) == BEGV
5410 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5411 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5414 /* Position on the newline if that's what's requested. */
5415 if (on_newline_p
&& newline_found_p
)
5417 if (STRINGP (it
->string
))
5419 if (IT_STRING_CHARPOS (*it
) > 0)
5421 --IT_STRING_CHARPOS (*it
);
5422 --IT_STRING_BYTEPOS (*it
);
5425 else if (IT_CHARPOS (*it
) > BEGV
)
5429 reseat (it
, it
->current
.pos
, 0);
5433 reseat (it
, it
->current
.pos
, 0);
5440 /***********************************************************************
5441 Changing an iterator's position
5442 ***********************************************************************/
5444 /* Change IT's current position to POS in current_buffer. If FORCE_P
5445 is non-zero, always check for text properties at the new position.
5446 Otherwise, text properties are only looked up if POS >=
5447 IT->check_charpos of a property. */
5450 reseat (it
, pos
, force_p
)
5452 struct text_pos pos
;
5455 int original_pos
= IT_CHARPOS (*it
);
5457 reseat_1 (it
, pos
, 0);
5459 /* Determine where to check text properties. Avoid doing it
5460 where possible because text property lookup is very expensive. */
5462 || CHARPOS (pos
) > it
->stop_charpos
5463 || CHARPOS (pos
) < original_pos
)
5470 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5471 IT->stop_pos to POS, also. */
5474 reseat_1 (it
, pos
, set_stop_p
)
5476 struct text_pos pos
;
5479 /* Don't call this function when scanning a C string. */
5480 xassert (it
->s
== NULL
);
5482 /* POS must be a reasonable value. */
5483 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5485 it
->current
.pos
= it
->position
= pos
;
5486 it
->end_charpos
= ZV
;
5488 it
->current
.dpvec_index
= -1;
5489 it
->current
.overlay_string_index
= -1;
5490 IT_STRING_CHARPOS (*it
) = -1;
5491 IT_STRING_BYTEPOS (*it
) = -1;
5493 it
->string_from_display_prop_p
= 0;
5494 it
->method
= GET_FROM_BUFFER
;
5495 it
->object
= it
->w
->buffer
;
5496 it
->area
= TEXT_AREA
;
5497 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5499 it
->string_from_display_prop_p
= 0;
5500 it
->face_before_selective_p
= 0;
5503 it
->stop_charpos
= CHARPOS (pos
);
5507 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5508 If S is non-null, it is a C string to iterate over. Otherwise,
5509 STRING gives a Lisp string to iterate over.
5511 If PRECISION > 0, don't return more then PRECISION number of
5512 characters from the string.
5514 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5515 characters have been returned. FIELD_WIDTH < 0 means an infinite
5518 MULTIBYTE = 0 means disable processing of multibyte characters,
5519 MULTIBYTE > 0 means enable it,
5520 MULTIBYTE < 0 means use IT->multibyte_p.
5522 IT must be initialized via a prior call to init_iterator before
5523 calling this function. */
5526 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5531 int precision
, field_width
, multibyte
;
5533 /* No region in strings. */
5534 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5536 /* No text property checks performed by default, but see below. */
5537 it
->stop_charpos
= -1;
5539 /* Set iterator position and end position. */
5540 bzero (&it
->current
, sizeof it
->current
);
5541 it
->current
.overlay_string_index
= -1;
5542 it
->current
.dpvec_index
= -1;
5543 xassert (charpos
>= 0);
5545 /* If STRING is specified, use its multibyteness, otherwise use the
5546 setting of MULTIBYTE, if specified. */
5548 it
->multibyte_p
= multibyte
> 0;
5552 xassert (STRINGP (string
));
5553 it
->string
= string
;
5555 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5556 it
->method
= GET_FROM_STRING
;
5557 it
->current
.string_pos
= string_pos (charpos
, string
);
5564 /* Note that we use IT->current.pos, not it->current.string_pos,
5565 for displaying C strings. */
5566 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5567 if (it
->multibyte_p
)
5569 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5570 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5574 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5575 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5578 it
->method
= GET_FROM_C_STRING
;
5581 /* PRECISION > 0 means don't return more than PRECISION characters
5583 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5584 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5586 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5587 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5588 FIELD_WIDTH < 0 means infinite field width. This is useful for
5589 padding with `-' at the end of a mode line. */
5590 if (field_width
< 0)
5591 field_width
= INFINITY
;
5592 if (field_width
> it
->end_charpos
- charpos
)
5593 it
->end_charpos
= charpos
+ field_width
;
5595 /* Use the standard display table for displaying strings. */
5596 if (DISP_TABLE_P (Vstandard_display_table
))
5597 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5599 it
->stop_charpos
= charpos
;
5605 /***********************************************************************
5607 ***********************************************************************/
5609 /* Map enum it_method value to corresponding next_element_from_* function. */
5611 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5613 next_element_from_buffer
,
5614 next_element_from_display_vector
,
5615 next_element_from_string
,
5616 next_element_from_c_string
,
5617 next_element_from_image
,
5618 next_element_from_stretch
5621 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5624 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5625 (possibly with the following characters). */
5627 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS) \
5628 ((IT)->cmp_it.id >= 0 \
5629 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5630 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5631 (IT)->end_charpos, (IT)->w, \
5632 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5636 /* Load IT's display element fields with information about the next
5637 display element from the current position of IT. Value is zero if
5638 end of buffer (or C string) is reached. */
5640 static struct frame
*last_escape_glyph_frame
= NULL
;
5641 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5642 static int last_escape_glyph_merged_face_id
= 0;
5645 get_next_display_element (it
)
5648 /* Non-zero means that we found a display element. Zero means that
5649 we hit the end of what we iterate over. Performance note: the
5650 function pointer `method' used here turns out to be faster than
5651 using a sequence of if-statements. */
5655 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5657 if (it
->what
== IT_CHARACTER
)
5659 /* Map via display table or translate control characters.
5660 IT->c, IT->len etc. have been set to the next character by
5661 the function call above. If we have a display table, and it
5662 contains an entry for IT->c, translate it. Don't do this if
5663 IT->c itself comes from a display table, otherwise we could
5664 end up in an infinite recursion. (An alternative could be to
5665 count the recursion depth of this function and signal an
5666 error when a certain maximum depth is reached.) Is it worth
5668 if (success_p
&& it
->dpvec
== NULL
)
5673 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5676 struct Lisp_Vector
*v
= XVECTOR (dv
);
5678 /* Return the first character from the display table
5679 entry, if not empty. If empty, don't display the
5680 current character. */
5683 it
->dpvec_char_len
= it
->len
;
5684 it
->dpvec
= v
->contents
;
5685 it
->dpend
= v
->contents
+ v
->size
;
5686 it
->current
.dpvec_index
= 0;
5687 it
->dpvec_face_id
= -1;
5688 it
->saved_face_id
= it
->face_id
;
5689 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5694 set_iterator_to_next (it
, 0);
5699 /* Translate control characters into `\003' or `^C' form.
5700 Control characters coming from a display table entry are
5701 currently not translated because we use IT->dpvec to hold
5702 the translation. This could easily be changed but I
5703 don't believe that it is worth doing.
5705 If it->multibyte_p is nonzero, non-printable non-ASCII
5706 characters are also translated to octal form.
5708 If it->multibyte_p is zero, eight-bit characters that
5709 don't have corresponding multibyte char code are also
5710 translated to octal form. */
5711 else if ((it
->c
< ' '
5712 ? (it
->area
!= TEXT_AREA
5713 /* In mode line, treat \n, \t like other crl chars. */
5715 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5716 || (it
->c
!= '\n' && it
->c
!= '\t'))
5718 ? (!CHAR_PRINTABLE_P (it
->c
)
5719 || (!NILP (Vnobreak_char_display
)
5720 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5721 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5723 && (! unibyte_display_via_language_environment
5724 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5726 /* IT->c is a control character which must be displayed
5727 either as '\003' or as `^C' where the '\\' and '^'
5728 can be defined in the display table. Fill
5729 IT->ctl_chars with glyphs for what we have to
5730 display. Then, set IT->dpvec to these glyphs. */
5733 int face_id
, lface_id
= 0 ;
5736 /* Handle control characters with ^. */
5738 if (it
->c
< 128 && it
->ctl_arrow_p
)
5742 g
= '^'; /* default glyph for Control */
5743 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5745 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5746 && GLYPH_CODE_CHAR_VALID_P (gc
))
5748 g
= GLYPH_CODE_CHAR (gc
);
5749 lface_id
= GLYPH_CODE_FACE (gc
);
5753 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5755 else if (it
->f
== last_escape_glyph_frame
5756 && it
->face_id
== last_escape_glyph_face_id
)
5758 face_id
= last_escape_glyph_merged_face_id
;
5762 /* Merge the escape-glyph face into the current face. */
5763 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5765 last_escape_glyph_frame
= it
->f
;
5766 last_escape_glyph_face_id
= it
->face_id
;
5767 last_escape_glyph_merged_face_id
= face_id
;
5770 XSETINT (it
->ctl_chars
[0], g
);
5771 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5773 goto display_control
;
5776 /* Handle non-break space in the mode where it only gets
5779 if (EQ (Vnobreak_char_display
, Qt
)
5782 /* Merge the no-break-space face into the current face. */
5783 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5787 XSETINT (it
->ctl_chars
[0], ' ');
5789 goto display_control
;
5792 /* Handle sequences that start with the "escape glyph". */
5794 /* the default escape glyph is \. */
5795 escape_glyph
= '\\';
5798 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5799 && GLYPH_CODE_CHAR_VALID_P (gc
))
5801 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5802 lface_id
= GLYPH_CODE_FACE (gc
);
5806 /* The display table specified a face.
5807 Merge it into face_id and also into escape_glyph. */
5808 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5811 else if (it
->f
== last_escape_glyph_frame
5812 && it
->face_id
== last_escape_glyph_face_id
)
5814 face_id
= last_escape_glyph_merged_face_id
;
5818 /* Merge the escape-glyph face into the current face. */
5819 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5821 last_escape_glyph_frame
= it
->f
;
5822 last_escape_glyph_face_id
= it
->face_id
;
5823 last_escape_glyph_merged_face_id
= face_id
;
5826 /* Handle soft hyphens in the mode where they only get
5829 if (EQ (Vnobreak_char_display
, Qt
)
5833 XSETINT (it
->ctl_chars
[0], '-');
5835 goto display_control
;
5838 /* Handle non-break space and soft hyphen
5839 with the escape glyph. */
5841 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5843 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5844 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5845 XSETINT (it
->ctl_chars
[1], it
->c
);
5847 goto display_control
;
5851 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5855 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5856 if (CHAR_BYTE8_P (it
->c
))
5858 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5861 else if (it
->c
< 256)
5868 /* It's an invalid character, which shouldn't
5869 happen actually, but due to bugs it may
5870 happen. Let's print the char as is, there's
5871 not much meaningful we can do with it. */
5873 str
[1] = it
->c
>> 8;
5874 str
[2] = it
->c
>> 16;
5875 str
[3] = it
->c
>> 24;
5879 for (i
= 0; i
< len
; i
++)
5882 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5883 /* Insert three more glyphs into IT->ctl_chars for
5884 the octal display of the character. */
5885 g
= ((str
[i
] >> 6) & 7) + '0';
5886 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5887 g
= ((str
[i
] >> 3) & 7) + '0';
5888 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5889 g
= (str
[i
] & 7) + '0';
5890 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5896 /* Set up IT->dpvec and return first character from it. */
5897 it
->dpvec_char_len
= it
->len
;
5898 it
->dpvec
= it
->ctl_chars
;
5899 it
->dpend
= it
->dpvec
+ ctl_len
;
5900 it
->current
.dpvec_index
= 0;
5901 it
->dpvec_face_id
= face_id
;
5902 it
->saved_face_id
= it
->face_id
;
5903 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5910 #ifdef HAVE_WINDOW_SYSTEM
5911 /* Adjust face id for a multibyte character. There are no multibyte
5912 character in unibyte text. */
5913 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5916 && FRAME_WINDOW_P (it
->f
))
5918 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5920 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5922 /* Automatic composition with glyph-string. */
5923 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5925 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5929 int pos
= (it
->s
? -1
5930 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5931 : IT_CHARPOS (*it
));
5933 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
5938 /* Is this character the last one of a run of characters with
5939 box? If yes, set IT->end_of_box_run_p to 1. */
5946 it
->end_of_box_run_p
5947 = ((face_id
= face_after_it_pos (it
),
5948 face_id
!= it
->face_id
)
5949 && (face
= FACE_FROM_ID (it
->f
, face_id
),
5950 face
->box
== FACE_NO_BOX
));
5953 /* Value is 0 if end of buffer or string reached. */
5958 /* Move IT to the next display element.
5960 RESEAT_P non-zero means if called on a newline in buffer text,
5961 skip to the next visible line start.
5963 Functions get_next_display_element and set_iterator_to_next are
5964 separate because I find this arrangement easier to handle than a
5965 get_next_display_element function that also increments IT's
5966 position. The way it is we can first look at an iterator's current
5967 display element, decide whether it fits on a line, and if it does,
5968 increment the iterator position. The other way around we probably
5969 would either need a flag indicating whether the iterator has to be
5970 incremented the next time, or we would have to implement a
5971 decrement position function which would not be easy to write. */
5974 set_iterator_to_next (it
, reseat_p
)
5978 /* Reset flags indicating start and end of a sequence of characters
5979 with box. Reset them at the start of this function because
5980 moving the iterator to a new position might set them. */
5981 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
5985 case GET_FROM_BUFFER
:
5986 /* The current display element of IT is a character from
5987 current_buffer. Advance in the buffer, and maybe skip over
5988 invisible lines that are so because of selective display. */
5989 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
5990 reseat_at_next_visible_line_start (it
, 0);
5991 else if (it
->cmp_it
.id
>= 0)
5993 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
5994 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
5995 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
5996 it
->cmp_it
.from
= it
->cmp_it
.to
;
6000 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6001 IT_BYTEPOS (*it
), it
->stop_charpos
,
6007 xassert (it
->len
!= 0);
6008 IT_BYTEPOS (*it
) += it
->len
;
6009 IT_CHARPOS (*it
) += 1;
6010 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6014 case GET_FROM_C_STRING
:
6015 /* Current display element of IT is from a C string. */
6016 IT_BYTEPOS (*it
) += it
->len
;
6017 IT_CHARPOS (*it
) += 1;
6020 case GET_FROM_DISPLAY_VECTOR
:
6021 /* Current display element of IT is from a display table entry.
6022 Advance in the display table definition. Reset it to null if
6023 end reached, and continue with characters from buffers/
6025 ++it
->current
.dpvec_index
;
6027 /* Restore face of the iterator to what they were before the
6028 display vector entry (these entries may contain faces). */
6029 it
->face_id
= it
->saved_face_id
;
6031 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6033 int recheck_faces
= it
->ellipsis_p
;
6036 it
->method
= GET_FROM_C_STRING
;
6037 else if (STRINGP (it
->string
))
6038 it
->method
= GET_FROM_STRING
;
6041 it
->method
= GET_FROM_BUFFER
;
6042 it
->object
= it
->w
->buffer
;
6046 it
->current
.dpvec_index
= -1;
6048 /* Skip over characters which were displayed via IT->dpvec. */
6049 if (it
->dpvec_char_len
< 0)
6050 reseat_at_next_visible_line_start (it
, 1);
6051 else if (it
->dpvec_char_len
> 0)
6053 if (it
->method
== GET_FROM_STRING
6054 && it
->n_overlay_strings
> 0)
6055 it
->ignore_overlay_strings_at_pos_p
= 1;
6056 it
->len
= it
->dpvec_char_len
;
6057 set_iterator_to_next (it
, reseat_p
);
6060 /* Maybe recheck faces after display vector */
6062 it
->stop_charpos
= IT_CHARPOS (*it
);
6066 case GET_FROM_STRING
:
6067 /* Current display element is a character from a Lisp string. */
6068 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6069 if (it
->cmp_it
.id
>= 0)
6071 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6072 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6073 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6074 it
->cmp_it
.from
= it
->cmp_it
.to
;
6078 composition_compute_stop_pos (&it
->cmp_it
,
6079 IT_STRING_CHARPOS (*it
),
6080 IT_STRING_BYTEPOS (*it
),
6081 it
->stop_charpos
, it
->string
);
6086 IT_STRING_BYTEPOS (*it
) += it
->len
;
6087 IT_STRING_CHARPOS (*it
) += 1;
6090 consider_string_end
:
6092 if (it
->current
.overlay_string_index
>= 0)
6094 /* IT->string is an overlay string. Advance to the
6095 next, if there is one. */
6096 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6099 next_overlay_string (it
);
6101 setup_for_ellipsis (it
, 0);
6106 /* IT->string is not an overlay string. If we reached
6107 its end, and there is something on IT->stack, proceed
6108 with what is on the stack. This can be either another
6109 string, this time an overlay string, or a buffer. */
6110 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6114 if (it
->method
== GET_FROM_STRING
)
6115 goto consider_string_end
;
6120 case GET_FROM_IMAGE
:
6121 case GET_FROM_STRETCH
:
6122 /* The position etc with which we have to proceed are on
6123 the stack. The position may be at the end of a string,
6124 if the `display' property takes up the whole string. */
6125 xassert (it
->sp
> 0);
6127 if (it
->method
== GET_FROM_STRING
)
6128 goto consider_string_end
;
6132 /* There are no other methods defined, so this should be a bug. */
6136 xassert (it
->method
!= GET_FROM_STRING
6137 || (STRINGP (it
->string
)
6138 && IT_STRING_CHARPOS (*it
) >= 0));
6141 /* Load IT's display element fields with information about the next
6142 display element which comes from a display table entry or from the
6143 result of translating a control character to one of the forms `^C'
6146 IT->dpvec holds the glyphs to return as characters.
6147 IT->saved_face_id holds the face id before the display vector--
6148 it is restored into IT->face_idin set_iterator_to_next. */
6151 next_element_from_display_vector (it
)
6157 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6159 it
->face_id
= it
->saved_face_id
;
6161 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6162 That seemed totally bogus - so I changed it... */
6163 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6165 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6167 it
->c
= GLYPH_CODE_CHAR (gc
);
6168 it
->len
= CHAR_BYTES (it
->c
);
6170 /* The entry may contain a face id to use. Such a face id is
6171 the id of a Lisp face, not a realized face. A face id of
6172 zero means no face is specified. */
6173 if (it
->dpvec_face_id
>= 0)
6174 it
->face_id
= it
->dpvec_face_id
;
6177 int lface_id
= GLYPH_CODE_FACE (gc
);
6179 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6184 /* Display table entry is invalid. Return a space. */
6185 it
->c
= ' ', it
->len
= 1;
6187 /* Don't change position and object of the iterator here. They are
6188 still the values of the character that had this display table
6189 entry or was translated, and that's what we want. */
6190 it
->what
= IT_CHARACTER
;
6195 /* Load IT with the next display element from Lisp string IT->string.
6196 IT->current.string_pos is the current position within the string.
6197 If IT->current.overlay_string_index >= 0, the Lisp string is an
6201 next_element_from_string (it
)
6204 struct text_pos position
;
6206 xassert (STRINGP (it
->string
));
6207 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6208 position
= it
->current
.string_pos
;
6210 /* Time to check for invisible text? */
6211 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6212 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6216 /* Since a handler may have changed IT->method, we must
6218 return GET_NEXT_DISPLAY_ELEMENT (it
);
6221 if (it
->current
.overlay_string_index
>= 0)
6223 /* Get the next character from an overlay string. In overlay
6224 strings, There is no field width or padding with spaces to
6226 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6231 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6232 IT_STRING_BYTEPOS (*it
))
6233 && next_element_from_composition (it
))
6237 else if (STRING_MULTIBYTE (it
->string
))
6239 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6240 const unsigned char *s
= (SDATA (it
->string
)
6241 + IT_STRING_BYTEPOS (*it
));
6242 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6246 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6252 /* Get the next character from a Lisp string that is not an
6253 overlay string. Such strings come from the mode line, for
6254 example. We may have to pad with spaces, or truncate the
6255 string. See also next_element_from_c_string. */
6256 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6261 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6263 /* Pad with spaces. */
6264 it
->c
= ' ', it
->len
= 1;
6265 CHARPOS (position
) = BYTEPOS (position
) = -1;
6267 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6268 IT_STRING_BYTEPOS (*it
))
6269 && next_element_from_composition (it
))
6273 else if (STRING_MULTIBYTE (it
->string
))
6275 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6276 const unsigned char *s
= (SDATA (it
->string
)
6277 + IT_STRING_BYTEPOS (*it
));
6278 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6282 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6287 /* Record what we have and where it came from. */
6288 it
->what
= IT_CHARACTER
;
6289 it
->object
= it
->string
;
6290 it
->position
= position
;
6295 /* Load IT with next display element from C string IT->s.
6296 IT->string_nchars is the maximum number of characters to return
6297 from the string. IT->end_charpos may be greater than
6298 IT->string_nchars when this function is called, in which case we
6299 may have to return padding spaces. Value is zero if end of string
6300 reached, including padding spaces. */
6303 next_element_from_c_string (it
)
6309 it
->what
= IT_CHARACTER
;
6310 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6313 /* IT's position can be greater IT->string_nchars in case a field
6314 width or precision has been specified when the iterator was
6316 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6318 /* End of the game. */
6322 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6324 /* Pad with spaces. */
6325 it
->c
= ' ', it
->len
= 1;
6326 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6328 else if (it
->multibyte_p
)
6330 /* Implementation note: The calls to strlen apparently aren't a
6331 performance problem because there is no noticeable performance
6332 difference between Emacs running in unibyte or multibyte mode. */
6333 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6334 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6338 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6344 /* Set up IT to return characters from an ellipsis, if appropriate.
6345 The definition of the ellipsis glyphs may come from a display table
6346 entry. This function Fills IT with the first glyph from the
6347 ellipsis if an ellipsis is to be displayed. */
6350 next_element_from_ellipsis (it
)
6353 if (it
->selective_display_ellipsis_p
)
6354 setup_for_ellipsis (it
, it
->len
);
6357 /* The face at the current position may be different from the
6358 face we find after the invisible text. Remember what it
6359 was in IT->saved_face_id, and signal that it's there by
6360 setting face_before_selective_p. */
6361 it
->saved_face_id
= it
->face_id
;
6362 it
->method
= GET_FROM_BUFFER
;
6363 it
->object
= it
->w
->buffer
;
6364 reseat_at_next_visible_line_start (it
, 1);
6365 it
->face_before_selective_p
= 1;
6368 return GET_NEXT_DISPLAY_ELEMENT (it
);
6372 /* Deliver an image display element. The iterator IT is already
6373 filled with image information (done in handle_display_prop). Value
6378 next_element_from_image (it
)
6381 it
->what
= IT_IMAGE
;
6386 /* Fill iterator IT with next display element from a stretch glyph
6387 property. IT->object is the value of the text property. Value is
6391 next_element_from_stretch (it
)
6394 it
->what
= IT_STRETCH
;
6399 /* Load IT with the next display element from current_buffer. Value
6400 is zero if end of buffer reached. IT->stop_charpos is the next
6401 position at which to stop and check for text properties or buffer
6405 next_element_from_buffer (it
)
6410 /* Check this assumption, otherwise, we would never enter the
6411 if-statement, below. */
6412 xassert (IT_CHARPOS (*it
) >= BEGV
6413 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6415 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6417 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6419 int overlay_strings_follow_p
;
6421 /* End of the game, except when overlay strings follow that
6422 haven't been returned yet. */
6423 if (it
->overlay_strings_at_end_processed_p
)
6424 overlay_strings_follow_p
= 0;
6427 it
->overlay_strings_at_end_processed_p
= 1;
6428 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6431 if (overlay_strings_follow_p
)
6432 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6436 it
->position
= it
->current
.pos
;
6443 return GET_NEXT_DISPLAY_ELEMENT (it
);
6448 /* No face changes, overlays etc. in sight, so just return a
6449 character from current_buffer. */
6452 /* Maybe run the redisplay end trigger hook. Performance note:
6453 This doesn't seem to cost measurable time. */
6454 if (it
->redisplay_end_trigger_charpos
6456 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6457 run_redisplay_end_trigger_hook (it
);
6459 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
))
6460 && next_element_from_composition (it
))
6465 /* Get the next character, maybe multibyte. */
6466 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6467 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6468 it
->c
= STRING_CHAR_AND_LENGTH (p
, 0, it
->len
);
6470 it
->c
= *p
, it
->len
= 1;
6472 /* Record what we have and where it came from. */
6473 it
->what
= IT_CHARACTER
;
6474 it
->object
= it
->w
->buffer
;
6475 it
->position
= it
->current
.pos
;
6477 /* Normally we return the character found above, except when we
6478 really want to return an ellipsis for selective display. */
6483 /* A value of selective > 0 means hide lines indented more
6484 than that number of columns. */
6485 if (it
->selective
> 0
6486 && IT_CHARPOS (*it
) + 1 < ZV
6487 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6488 IT_BYTEPOS (*it
) + 1,
6489 (double) it
->selective
)) /* iftc */
6491 success_p
= next_element_from_ellipsis (it
);
6492 it
->dpvec_char_len
= -1;
6495 else if (it
->c
== '\r' && it
->selective
== -1)
6497 /* A value of selective == -1 means that everything from the
6498 CR to the end of the line is invisible, with maybe an
6499 ellipsis displayed for it. */
6500 success_p
= next_element_from_ellipsis (it
);
6501 it
->dpvec_char_len
= -1;
6506 /* Value is zero if end of buffer reached. */
6507 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6512 /* Run the redisplay end trigger hook for IT. */
6515 run_redisplay_end_trigger_hook (it
)
6518 Lisp_Object args
[3];
6520 /* IT->glyph_row should be non-null, i.e. we should be actually
6521 displaying something, or otherwise we should not run the hook. */
6522 xassert (it
->glyph_row
);
6524 /* Set up hook arguments. */
6525 args
[0] = Qredisplay_end_trigger_functions
;
6526 args
[1] = it
->window
;
6527 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6528 it
->redisplay_end_trigger_charpos
= 0;
6530 /* Since we are *trying* to run these functions, don't try to run
6531 them again, even if they get an error. */
6532 it
->w
->redisplay_end_trigger
= Qnil
;
6533 Frun_hook_with_args (3, args
);
6535 /* Notice if it changed the face of the character we are on. */
6536 handle_face_prop (it
);
6540 /* Deliver a composition display element. Unlike the other
6541 next_element_from_XXX, this function is not registered in the array
6542 get_next_element[]. It is called from next_element_from_buffer and
6543 next_element_from_string when necessary. */
6546 next_element_from_composition (it
)
6549 it
->what
= IT_COMPOSITION
;
6550 it
->len
= it
->cmp_it
.nbytes
;
6551 if (STRINGP (it
->string
))
6555 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6556 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6559 it
->position
= it
->current
.string_pos
;
6560 it
->object
= it
->string
;
6561 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6562 IT_STRING_BYTEPOS (*it
), it
->string
);
6568 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6569 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6572 it
->position
= it
->current
.pos
;
6573 it
->object
= it
->w
->buffer
;
6574 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6575 IT_BYTEPOS (*it
), Qnil
);
6582 /***********************************************************************
6583 Moving an iterator without producing glyphs
6584 ***********************************************************************/
6586 /* Check if iterator is at a position corresponding to a valid buffer
6587 position after some move_it_ call. */
6589 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6590 ((it)->method == GET_FROM_STRING \
6591 ? IT_STRING_CHARPOS (*it) == 0 \
6595 /* Move iterator IT to a specified buffer or X position within one
6596 line on the display without producing glyphs.
6598 OP should be a bit mask including some or all of these bits:
6599 MOVE_TO_X: Stop on reaching x-position TO_X.
6600 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6601 Regardless of OP's value, stop in reaching the end of the display line.
6603 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6604 This means, in particular, that TO_X includes window's horizontal
6607 The return value has several possible values that
6608 say what condition caused the scan to stop:
6610 MOVE_POS_MATCH_OR_ZV
6611 - when TO_POS or ZV was reached.
6614 -when TO_X was reached before TO_POS or ZV were reached.
6617 - when we reached the end of the display area and the line must
6621 - when we reached the end of the display area and the line is
6625 - when we stopped at a line end, i.e. a newline or a CR and selective
6628 static enum move_it_result
6629 move_it_in_display_line_to (struct it
*it
,
6630 EMACS_INT to_charpos
, int to_x
,
6631 enum move_operation_enum op
)
6633 enum move_it_result result
= MOVE_UNDEFINED
;
6634 struct glyph_row
*saved_glyph_row
;
6635 struct it wrap_it
, atpos_it
, atx_it
;
6638 /* Don't produce glyphs in produce_glyphs. */
6639 saved_glyph_row
= it
->glyph_row
;
6640 it
->glyph_row
= NULL
;
6642 /* Use wrap_it to save a copy of IT wherever a word wrap could
6643 occur. Use atpos_it to save a copy of IT at the desired buffer
6644 position, if found, so that we can scan ahead and check if the
6645 word later overshoots the window edge. Use atx_it similarly, for
6651 #define BUFFER_POS_REACHED_P() \
6652 ((op & MOVE_TO_POS) != 0 \
6653 && BUFFERP (it->object) \
6654 && IT_CHARPOS (*it) >= to_charpos \
6655 && (it->method == GET_FROM_BUFFER \
6656 || (it->method == GET_FROM_DISPLAY_VECTOR \
6657 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6659 /* If there's a line-/wrap-prefix, handle it. */
6660 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6661 && it
->current_y
< it
->last_visible_y
)
6662 handle_line_prefix (it
);
6666 int x
, i
, ascent
= 0, descent
= 0;
6668 /* Utility macro to reset an iterator with x, ascent, and descent. */
6669 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6670 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6671 (IT)->max_descent = descent)
6673 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6675 if ((op
& MOVE_TO_POS
) != 0
6676 && BUFFERP (it
->object
)
6677 && it
->method
== GET_FROM_BUFFER
6678 && IT_CHARPOS (*it
) > to_charpos
)
6680 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6682 result
= MOVE_POS_MATCH_OR_ZV
;
6685 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6686 /* If wrap_it is valid, the current position might be in a
6687 word that is wrapped. So, save the iterator in
6688 atpos_it and continue to see if wrapping happens. */
6692 /* Stop when ZV reached.
6693 We used to stop here when TO_CHARPOS reached as well, but that is
6694 too soon if this glyph does not fit on this line. So we handle it
6695 explicitly below. */
6696 if (!get_next_display_element (it
))
6698 result
= MOVE_POS_MATCH_OR_ZV
;
6702 if (it
->line_wrap
== TRUNCATE
)
6704 if (BUFFER_POS_REACHED_P ())
6706 result
= MOVE_POS_MATCH_OR_ZV
;
6712 if (it
->line_wrap
== WORD_WRAP
)
6714 if (IT_DISPLAYING_WHITESPACE (it
))
6718 /* We have reached a glyph that follows one or more
6719 whitespace characters. If the position is
6720 already found, we are done. */
6721 if (atpos_it
.sp
>= 0)
6724 result
= MOVE_POS_MATCH_OR_ZV
;
6730 result
= MOVE_X_REACHED
;
6733 /* Otherwise, we can wrap here. */
6740 /* Remember the line height for the current line, in case
6741 the next element doesn't fit on the line. */
6742 ascent
= it
->max_ascent
;
6743 descent
= it
->max_descent
;
6745 /* The call to produce_glyphs will get the metrics of the
6746 display element IT is loaded with. Record the x-position
6747 before this display element, in case it doesn't fit on the
6751 PRODUCE_GLYPHS (it
);
6753 if (it
->area
!= TEXT_AREA
)
6755 set_iterator_to_next (it
, 1);
6759 /* The number of glyphs we get back in IT->nglyphs will normally
6760 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6761 character on a terminal frame, or (iii) a line end. For the
6762 second case, IT->nglyphs - 1 padding glyphs will be present
6763 (on X frames, there is only one glyph produced for a
6764 composite character.
6766 The behavior implemented below means, for continuation lines,
6767 that as many spaces of a TAB as fit on the current line are
6768 displayed there. For terminal frames, as many glyphs of a
6769 multi-glyph character are displayed in the current line, too.
6770 This is what the old redisplay code did, and we keep it that
6771 way. Under X, the whole shape of a complex character must
6772 fit on the line or it will be completely displayed in the
6775 Note that both for tabs and padding glyphs, all glyphs have
6779 /* More than one glyph or glyph doesn't fit on line. All
6780 glyphs have the same width. */
6781 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6783 int x_before_this_char
= x
;
6784 int hpos_before_this_char
= it
->hpos
;
6786 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6788 new_x
= x
+ single_glyph_width
;
6790 /* We want to leave anything reaching TO_X to the caller. */
6791 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6793 if (BUFFER_POS_REACHED_P ())
6795 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6796 goto buffer_pos_reached
;
6797 if (atpos_it
.sp
< 0)
6800 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6805 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6808 result
= MOVE_X_REACHED
;
6814 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
6819 if (/* Lines are continued. */
6820 it
->line_wrap
!= TRUNCATE
6821 && (/* And glyph doesn't fit on the line. */
6822 new_x
> it
->last_visible_x
6823 /* Or it fits exactly and we're on a window
6825 || (new_x
== it
->last_visible_x
6826 && FRAME_WINDOW_P (it
->f
))))
6828 if (/* IT->hpos == 0 means the very first glyph
6829 doesn't fit on the line, e.g. a wide image. */
6831 || (new_x
== it
->last_visible_x
6832 && FRAME_WINDOW_P (it
->f
)))
6835 it
->current_x
= new_x
;
6837 /* The character's last glyph just barely fits
6839 if (i
== it
->nglyphs
- 1)
6841 /* If this is the destination position,
6842 return a position *before* it in this row,
6843 now that we know it fits in this row. */
6844 if (BUFFER_POS_REACHED_P ())
6846 if (it
->line_wrap
!= WORD_WRAP
6849 it
->hpos
= hpos_before_this_char
;
6850 it
->current_x
= x_before_this_char
;
6851 result
= MOVE_POS_MATCH_OR_ZV
;
6854 if (it
->line_wrap
== WORD_WRAP
6858 atpos_it
.current_x
= x_before_this_char
;
6859 atpos_it
.hpos
= hpos_before_this_char
;
6863 set_iterator_to_next (it
, 1);
6864 #ifdef HAVE_WINDOW_SYSTEM
6865 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6867 if (!get_next_display_element (it
))
6869 result
= MOVE_POS_MATCH_OR_ZV
;
6872 if (BUFFER_POS_REACHED_P ())
6874 if (ITERATOR_AT_END_OF_LINE_P (it
))
6875 result
= MOVE_POS_MATCH_OR_ZV
;
6877 result
= MOVE_LINE_CONTINUED
;
6880 if (ITERATOR_AT_END_OF_LINE_P (it
))
6882 result
= MOVE_NEWLINE_OR_CR
;
6886 #endif /* HAVE_WINDOW_SYSTEM */
6890 IT_RESET_X_ASCENT_DESCENT (it
);
6892 if (wrap_it
.sp
>= 0)
6899 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6901 result
= MOVE_LINE_CONTINUED
;
6905 if (BUFFER_POS_REACHED_P ())
6907 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6908 goto buffer_pos_reached
;
6909 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6912 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6916 if (new_x
> it
->first_visible_x
)
6918 /* Glyph is visible. Increment number of glyphs that
6919 would be displayed. */
6924 if (result
!= MOVE_UNDEFINED
)
6927 else if (BUFFER_POS_REACHED_P ())
6930 IT_RESET_X_ASCENT_DESCENT (it
);
6931 result
= MOVE_POS_MATCH_OR_ZV
;
6934 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6936 /* Stop when TO_X specified and reached. This check is
6937 necessary here because of lines consisting of a line end,
6938 only. The line end will not produce any glyphs and we
6939 would never get MOVE_X_REACHED. */
6940 xassert (it
->nglyphs
== 0);
6941 result
= MOVE_X_REACHED
;
6945 /* Is this a line end? If yes, we're done. */
6946 if (ITERATOR_AT_END_OF_LINE_P (it
))
6948 result
= MOVE_NEWLINE_OR_CR
;
6952 /* The current display element has been consumed. Advance
6954 set_iterator_to_next (it
, 1);
6956 /* Stop if lines are truncated and IT's current x-position is
6957 past the right edge of the window now. */
6958 if (it
->line_wrap
== TRUNCATE
6959 && it
->current_x
>= it
->last_visible_x
)
6961 #ifdef HAVE_WINDOW_SYSTEM
6962 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6964 if (!get_next_display_element (it
)
6965 || BUFFER_POS_REACHED_P ())
6967 result
= MOVE_POS_MATCH_OR_ZV
;
6970 if (ITERATOR_AT_END_OF_LINE_P (it
))
6972 result
= MOVE_NEWLINE_OR_CR
;
6976 #endif /* HAVE_WINDOW_SYSTEM */
6977 result
= MOVE_LINE_TRUNCATED
;
6980 #undef IT_RESET_X_ASCENT_DESCENT
6983 #undef BUFFER_POS_REACHED_P
6985 /* If we scanned beyond to_pos and didn't find a point to wrap at,
6986 restore the saved iterator. */
6987 if (atpos_it
.sp
>= 0)
6989 else if (atx_it
.sp
>= 0)
6994 /* Restore the iterator settings altered at the beginning of this
6996 it
->glyph_row
= saved_glyph_row
;
7000 /* For external use. */
7002 move_it_in_display_line (struct it
*it
,
7003 EMACS_INT to_charpos
, int to_x
,
7004 enum move_operation_enum op
)
7006 if (it
->line_wrap
== WORD_WRAP
7007 && (op
& MOVE_TO_X
))
7009 struct it save_it
= *it
;
7010 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7011 /* When word-wrap is on, TO_X may lie past the end
7012 of a wrapped line. Then it->current is the
7013 character on the next line, so backtrack to the
7014 space before the wrap point. */
7015 if (skip
== MOVE_LINE_CONTINUED
)
7017 int prev_x
= max (it
->current_x
- 1, 0);
7019 move_it_in_display_line_to
7020 (it
, -1, prev_x
, MOVE_TO_X
);
7024 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7028 /* Move IT forward until it satisfies one or more of the criteria in
7029 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7031 OP is a bit-mask that specifies where to stop, and in particular,
7032 which of those four position arguments makes a difference. See the
7033 description of enum move_operation_enum.
7035 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7036 screen line, this function will set IT to the next position >
7040 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7042 int to_charpos
, to_x
, to_y
, to_vpos
;
7045 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7051 if (op
& MOVE_TO_VPOS
)
7053 /* If no TO_CHARPOS and no TO_X specified, stop at the
7054 start of the line TO_VPOS. */
7055 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7057 if (it
->vpos
== to_vpos
)
7063 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7067 /* TO_VPOS >= 0 means stop at TO_X in the line at
7068 TO_VPOS, or at TO_POS, whichever comes first. */
7069 if (it
->vpos
== to_vpos
)
7075 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7077 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7082 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7084 /* We have reached TO_X but not in the line we want. */
7085 skip
= move_it_in_display_line_to (it
, to_charpos
,
7087 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7095 else if (op
& MOVE_TO_Y
)
7097 struct it it_backup
;
7099 if (it
->line_wrap
== WORD_WRAP
)
7102 /* TO_Y specified means stop at TO_X in the line containing
7103 TO_Y---or at TO_CHARPOS if this is reached first. The
7104 problem is that we can't really tell whether the line
7105 contains TO_Y before we have completely scanned it, and
7106 this may skip past TO_X. What we do is to first scan to
7109 If TO_X is not specified, use a TO_X of zero. The reason
7110 is to make the outcome of this function more predictable.
7111 If we didn't use TO_X == 0, we would stop at the end of
7112 the line which is probably not what a caller would expect
7114 skip
= move_it_in_display_line_to
7115 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7116 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7118 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7119 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7121 else if (skip
== MOVE_X_REACHED
)
7123 /* If TO_X was reached, we want to know whether TO_Y is
7124 in the line. We know this is the case if the already
7125 scanned glyphs make the line tall enough. Otherwise,
7126 we must check by scanning the rest of the line. */
7127 line_height
= it
->max_ascent
+ it
->max_descent
;
7128 if (to_y
>= it
->current_y
7129 && to_y
< it
->current_y
+ line_height
)
7135 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7136 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7138 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7139 line_height
= it
->max_ascent
+ it
->max_descent
;
7140 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7142 if (to_y
>= it
->current_y
7143 && to_y
< it
->current_y
+ line_height
)
7145 /* If TO_Y is in this line and TO_X was reached
7146 above, we scanned too far. We have to restore
7147 IT's settings to the ones before skipping. */
7154 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7160 /* Check whether TO_Y is in this line. */
7161 line_height
= it
->max_ascent
+ it
->max_descent
;
7162 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7164 if (to_y
>= it
->current_y
7165 && to_y
< it
->current_y
+ line_height
)
7167 /* When word-wrap is on, TO_X may lie past the end
7168 of a wrapped line. Then it->current is the
7169 character on the next line, so backtrack to the
7170 space before the wrap point. */
7171 if (skip
== MOVE_LINE_CONTINUED
7172 && it
->line_wrap
== WORD_WRAP
)
7174 int prev_x
= max (it
->current_x
- 1, 0);
7176 skip
= move_it_in_display_line_to
7177 (it
, -1, prev_x
, MOVE_TO_X
);
7186 else if (BUFFERP (it
->object
)
7187 && it
->method
== GET_FROM_BUFFER
7188 && IT_CHARPOS (*it
) >= to_charpos
)
7189 skip
= MOVE_POS_MATCH_OR_ZV
;
7191 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7195 case MOVE_POS_MATCH_OR_ZV
:
7199 case MOVE_NEWLINE_OR_CR
:
7200 set_iterator_to_next (it
, 1);
7201 it
->continuation_lines_width
= 0;
7204 case MOVE_LINE_TRUNCATED
:
7205 it
->continuation_lines_width
= 0;
7206 reseat_at_next_visible_line_start (it
, 0);
7207 if ((op
& MOVE_TO_POS
) != 0
7208 && IT_CHARPOS (*it
) > to_charpos
)
7215 case MOVE_LINE_CONTINUED
:
7216 /* For continued lines ending in a tab, some of the glyphs
7217 associated with the tab are displayed on the current
7218 line. Since it->current_x does not include these glyphs,
7219 we use it->last_visible_x instead. */
7222 it
->continuation_lines_width
+= it
->last_visible_x
;
7223 /* When moving by vpos, ensure that the iterator really
7224 advances to the next line (bug#847). Fixme: do we
7225 need to do this in other circumstances? */
7226 if ((op
& MOVE_TO_VPOS
)
7227 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7228 set_iterator_to_next (it
, 0);
7231 it
->continuation_lines_width
+= it
->current_x
;
7238 /* Reset/increment for the next run. */
7239 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7240 it
->current_x
= it
->hpos
= 0;
7241 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7243 last_height
= it
->max_ascent
+ it
->max_descent
;
7244 last_max_ascent
= it
->max_ascent
;
7245 it
->max_ascent
= it
->max_descent
= 0;
7250 /* On text terminals, we may stop at the end of a line in the middle
7251 of a multi-character glyph. If the glyph itself is continued,
7252 i.e. it is actually displayed on the next line, don't treat this
7253 stopping point as valid; move to the next line instead (unless
7254 that brings us offscreen). */
7255 if (!FRAME_WINDOW_P (it
->f
)
7257 && IT_CHARPOS (*it
) == to_charpos
7258 && it
->what
== IT_CHARACTER
7260 && it
->line_wrap
== WINDOW_WRAP
7261 && it
->current_x
== it
->last_visible_x
- 1
7264 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7266 it
->continuation_lines_width
+= it
->current_x
;
7267 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7268 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7270 last_height
= it
->max_ascent
+ it
->max_descent
;
7271 last_max_ascent
= it
->max_ascent
;
7274 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7278 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7280 If DY > 0, move IT backward at least that many pixels. DY = 0
7281 means move IT backward to the preceding line start or BEGV. This
7282 function may move over more than DY pixels if IT->current_y - DY
7283 ends up in the middle of a line; in this case IT->current_y will be
7284 set to the top of the line moved to. */
7287 move_it_vertically_backward (it
, dy
)
7298 start_pos
= IT_CHARPOS (*it
);
7300 /* Estimate how many newlines we must move back. */
7301 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7303 /* Set the iterator's position that many lines back. */
7304 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7305 back_to_previous_visible_line_start (it
);
7307 /* Reseat the iterator here. When moving backward, we don't want
7308 reseat to skip forward over invisible text, set up the iterator
7309 to deliver from overlay strings at the new position etc. So,
7310 use reseat_1 here. */
7311 reseat_1 (it
, it
->current
.pos
, 1);
7313 /* We are now surely at a line start. */
7314 it
->current_x
= it
->hpos
= 0;
7315 it
->continuation_lines_width
= 0;
7317 /* Move forward and see what y-distance we moved. First move to the
7318 start of the next line so that we get its height. We need this
7319 height to be able to tell whether we reached the specified
7322 it2
.max_ascent
= it2
.max_descent
= 0;
7325 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7326 MOVE_TO_POS
| MOVE_TO_VPOS
);
7328 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7329 xassert (IT_CHARPOS (*it
) >= BEGV
);
7332 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7333 xassert (IT_CHARPOS (*it
) >= BEGV
);
7334 /* H is the actual vertical distance from the position in *IT
7335 and the starting position. */
7336 h
= it2
.current_y
- it
->current_y
;
7337 /* NLINES is the distance in number of lines. */
7338 nlines
= it2
.vpos
- it
->vpos
;
7340 /* Correct IT's y and vpos position
7341 so that they are relative to the starting point. */
7347 /* DY == 0 means move to the start of the screen line. The
7348 value of nlines is > 0 if continuation lines were involved. */
7350 move_it_by_lines (it
, nlines
, 1);
7352 /* I think this assert is bogus if buffer contains
7353 invisible text or images. KFS. */
7354 xassert (IT_CHARPOS (*it
) <= start_pos
);
7359 /* The y-position we try to reach, relative to *IT.
7360 Note that H has been subtracted in front of the if-statement. */
7361 int target_y
= it
->current_y
+ h
- dy
;
7362 int y0
= it3
.current_y
;
7363 int y1
= line_bottom_y (&it3
);
7364 int line_height
= y1
- y0
;
7366 /* If we did not reach target_y, try to move further backward if
7367 we can. If we moved too far backward, try to move forward. */
7368 if (target_y
< it
->current_y
7369 /* This is heuristic. In a window that's 3 lines high, with
7370 a line height of 13 pixels each, recentering with point
7371 on the bottom line will try to move -39/2 = 19 pixels
7372 backward. Try to avoid moving into the first line. */
7373 && (it
->current_y
- target_y
7374 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7375 && IT_CHARPOS (*it
) > BEGV
)
7377 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7378 target_y
- it
->current_y
));
7379 dy
= it
->current_y
- target_y
;
7380 goto move_further_back
;
7382 else if (target_y
>= it
->current_y
+ line_height
7383 && IT_CHARPOS (*it
) < ZV
)
7385 /* Should move forward by at least one line, maybe more.
7387 Note: Calling move_it_by_lines can be expensive on
7388 terminal frames, where compute_motion is used (via
7389 vmotion) to do the job, when there are very long lines
7390 and truncate-lines is nil. That's the reason for
7391 treating terminal frames specially here. */
7393 if (!FRAME_WINDOW_P (it
->f
))
7394 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7399 move_it_by_lines (it
, 1, 1);
7401 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7405 /* I think this assert is bogus if buffer contains
7406 invisible text or images. KFS. */
7407 xassert (IT_CHARPOS (*it
) >= BEGV
);
7414 /* Move IT by a specified amount of pixel lines DY. DY negative means
7415 move backwards. DY = 0 means move to start of screen line. At the
7416 end, IT will be on the start of a screen line. */
7419 move_it_vertically (it
, dy
)
7424 move_it_vertically_backward (it
, -dy
);
7427 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7428 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7429 MOVE_TO_POS
| MOVE_TO_Y
);
7430 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7432 /* If buffer ends in ZV without a newline, move to the start of
7433 the line to satisfy the post-condition. */
7434 if (IT_CHARPOS (*it
) == ZV
7436 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7437 move_it_by_lines (it
, 0, 0);
7442 /* Move iterator IT past the end of the text line it is in. */
7445 move_it_past_eol (it
)
7448 enum move_it_result rc
;
7450 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7451 if (rc
== MOVE_NEWLINE_OR_CR
)
7452 set_iterator_to_next (it
, 0);
7456 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7457 negative means move up. DVPOS == 0 means move to the start of the
7458 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7459 NEED_Y_P is zero, IT->current_y will be left unchanged.
7461 Further optimization ideas: If we would know that IT->f doesn't use
7462 a face with proportional font, we could be faster for
7463 truncate-lines nil. */
7466 move_it_by_lines (it
, dvpos
, need_y_p
)
7468 int dvpos
, need_y_p
;
7470 struct position pos
;
7472 /* The commented-out optimization uses vmotion on terminals. This
7473 gives bad results, because elements like it->what, on which
7474 callers such as pos_visible_p rely, aren't updated. */
7475 /* if (!FRAME_WINDOW_P (it->f))
7477 struct text_pos textpos;
7479 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7480 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7481 reseat (it, textpos, 1);
7482 it->vpos += pos.vpos;
7483 it->current_y += pos.vpos;
7489 /* DVPOS == 0 means move to the start of the screen line. */
7490 move_it_vertically_backward (it
, 0);
7491 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7492 /* Let next call to line_bottom_y calculate real line height */
7497 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7498 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7499 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7504 int start_charpos
, i
;
7506 /* Start at the beginning of the screen line containing IT's
7507 position. This may actually move vertically backwards,
7508 in case of overlays, so adjust dvpos accordingly. */
7510 move_it_vertically_backward (it
, 0);
7513 /* Go back -DVPOS visible lines and reseat the iterator there. */
7514 start_charpos
= IT_CHARPOS (*it
);
7515 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7516 back_to_previous_visible_line_start (it
);
7517 reseat (it
, it
->current
.pos
, 1);
7519 /* Move further back if we end up in a string or an image. */
7520 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7522 /* First try to move to start of display line. */
7524 move_it_vertically_backward (it
, 0);
7526 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7528 /* If start of line is still in string or image,
7529 move further back. */
7530 back_to_previous_visible_line_start (it
);
7531 reseat (it
, it
->current
.pos
, 1);
7535 it
->current_x
= it
->hpos
= 0;
7537 /* Above call may have moved too far if continuation lines
7538 are involved. Scan forward and see if it did. */
7540 it2
.vpos
= it2
.current_y
= 0;
7541 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7542 it
->vpos
-= it2
.vpos
;
7543 it
->current_y
-= it2
.current_y
;
7544 it
->current_x
= it
->hpos
= 0;
7546 /* If we moved too far back, move IT some lines forward. */
7547 if (it2
.vpos
> -dvpos
)
7549 int delta
= it2
.vpos
+ dvpos
;
7551 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7552 /* Move back again if we got too far ahead. */
7553 if (IT_CHARPOS (*it
) >= start_charpos
)
7559 /* Return 1 if IT points into the middle of a display vector. */
7562 in_display_vector_p (it
)
7565 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7566 && it
->current
.dpvec_index
> 0
7567 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7571 /***********************************************************************
7573 ***********************************************************************/
7576 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7580 add_to_log (format
, arg1
, arg2
)
7582 Lisp_Object arg1
, arg2
;
7584 Lisp_Object args
[3];
7585 Lisp_Object msg
, fmt
;
7588 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7591 /* Do nothing if called asynchronously. Inserting text into
7592 a buffer may call after-change-functions and alike and
7593 that would means running Lisp asynchronously. */
7594 if (handling_signal
)
7598 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7600 args
[0] = fmt
= build_string (format
);
7603 msg
= Fformat (3, args
);
7605 len
= SBYTES (msg
) + 1;
7606 SAFE_ALLOCA (buffer
, char *, len
);
7607 bcopy (SDATA (msg
), buffer
, len
);
7609 message_dolog (buffer
, len
- 1, 1, 0);
7616 /* Output a newline in the *Messages* buffer if "needs" one. */
7619 message_log_maybe_newline ()
7621 if (message_log_need_newline
)
7622 message_dolog ("", 0, 1, 0);
7626 /* Add a string M of length NBYTES to the message log, optionally
7627 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7628 nonzero, means interpret the contents of M as multibyte. This
7629 function calls low-level routines in order to bypass text property
7630 hooks, etc. which might not be safe to run.
7632 This may GC (insert may run before/after change hooks),
7633 so the buffer M must NOT point to a Lisp string. */
7636 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7638 int nbytes
, nlflag
, multibyte
;
7640 if (!NILP (Vmemory_full
))
7643 if (!NILP (Vmessage_log_max
))
7645 struct buffer
*oldbuf
;
7646 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7647 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7648 int point_at_end
= 0;
7650 Lisp_Object old_deactivate_mark
, tem
;
7651 struct gcpro gcpro1
;
7653 old_deactivate_mark
= Vdeactivate_mark
;
7654 oldbuf
= current_buffer
;
7655 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7656 current_buffer
->undo_list
= Qt
;
7658 oldpoint
= message_dolog_marker1
;
7659 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7660 oldbegv
= message_dolog_marker2
;
7661 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7662 oldzv
= message_dolog_marker3
;
7663 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7664 GCPRO1 (old_deactivate_mark
);
7672 BEGV_BYTE
= BEG_BYTE
;
7675 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7677 /* Insert the string--maybe converting multibyte to single byte
7678 or vice versa, so that all the text fits the buffer. */
7680 && NILP (current_buffer
->enable_multibyte_characters
))
7682 int i
, c
, char_bytes
;
7683 unsigned char work
[1];
7685 /* Convert a multibyte string to single-byte
7686 for the *Message* buffer. */
7687 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7689 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7690 work
[0] = (ASCII_CHAR_P (c
)
7692 : multibyte_char_to_unibyte (c
, Qnil
));
7693 insert_1_both (work
, 1, 1, 1, 0, 0);
7696 else if (! multibyte
7697 && ! NILP (current_buffer
->enable_multibyte_characters
))
7699 int i
, c
, char_bytes
;
7700 unsigned char *msg
= (unsigned char *) m
;
7701 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7702 /* Convert a single-byte string to multibyte
7703 for the *Message* buffer. */
7704 for (i
= 0; i
< nbytes
; i
++)
7707 c
= unibyte_char_to_multibyte (c
);
7708 char_bytes
= CHAR_STRING (c
, str
);
7709 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7713 insert_1 (m
, nbytes
, 1, 0, 0);
7717 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7718 insert_1 ("\n", 1, 1, 0, 0);
7720 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7722 this_bol_byte
= PT_BYTE
;
7724 /* See if this line duplicates the previous one.
7725 If so, combine duplicates. */
7728 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7730 prev_bol_byte
= PT_BYTE
;
7732 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7733 this_bol
, this_bol_byte
);
7736 del_range_both (prev_bol
, prev_bol_byte
,
7737 this_bol
, this_bol_byte
, 0);
7743 /* If you change this format, don't forget to also
7744 change message_log_check_duplicate. */
7745 sprintf (dupstr
, " [%d times]", dup
);
7746 duplen
= strlen (dupstr
);
7747 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7748 insert_1 (dupstr
, duplen
, 1, 0, 1);
7753 /* If we have more than the desired maximum number of lines
7754 in the *Messages* buffer now, delete the oldest ones.
7755 This is safe because we don't have undo in this buffer. */
7757 if (NATNUMP (Vmessage_log_max
))
7759 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7760 -XFASTINT (Vmessage_log_max
) - 1, 0);
7761 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7764 BEGV
= XMARKER (oldbegv
)->charpos
;
7765 BEGV_BYTE
= marker_byte_position (oldbegv
);
7774 ZV
= XMARKER (oldzv
)->charpos
;
7775 ZV_BYTE
= marker_byte_position (oldzv
);
7779 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7781 /* We can't do Fgoto_char (oldpoint) because it will run some
7783 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7784 XMARKER (oldpoint
)->bytepos
);
7787 unchain_marker (XMARKER (oldpoint
));
7788 unchain_marker (XMARKER (oldbegv
));
7789 unchain_marker (XMARKER (oldzv
));
7791 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7792 set_buffer_internal (oldbuf
);
7794 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7795 message_log_need_newline
= !nlflag
;
7796 Vdeactivate_mark
= old_deactivate_mark
;
7801 /* We are at the end of the buffer after just having inserted a newline.
7802 (Note: We depend on the fact we won't be crossing the gap.)
7803 Check to see if the most recent message looks a lot like the previous one.
7804 Return 0 if different, 1 if the new one should just replace it, or a
7805 value N > 1 if we should also append " [N times]". */
7808 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7809 int prev_bol
, this_bol
;
7810 int prev_bol_byte
, this_bol_byte
;
7813 int len
= Z_BYTE
- 1 - this_bol_byte
;
7815 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7816 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7818 for (i
= 0; i
< len
; i
++)
7820 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7828 if (*p1
++ == ' ' && *p1
++ == '[')
7831 while (*p1
>= '0' && *p1
<= '9')
7832 n
= n
* 10 + *p1
++ - '0';
7833 if (strncmp (p1
, " times]\n", 8) == 0)
7840 /* Display an echo area message M with a specified length of NBYTES
7841 bytes. The string may include null characters. If M is 0, clear
7842 out any existing message, and let the mini-buffer text show
7845 This may GC, so the buffer M must NOT point to a Lisp string. */
7848 message2 (m
, nbytes
, multibyte
)
7853 /* First flush out any partial line written with print. */
7854 message_log_maybe_newline ();
7856 message_dolog (m
, nbytes
, 1, multibyte
);
7857 message2_nolog (m
, nbytes
, multibyte
);
7861 /* The non-logging counterpart of message2. */
7864 message2_nolog (m
, nbytes
, multibyte
)
7866 int nbytes
, multibyte
;
7868 struct frame
*sf
= SELECTED_FRAME ();
7869 message_enable_multibyte
= multibyte
;
7873 if (noninteractive_need_newline
)
7874 putc ('\n', stderr
);
7875 noninteractive_need_newline
= 0;
7877 fwrite (m
, nbytes
, 1, stderr
);
7878 if (cursor_in_echo_area
== 0)
7879 fprintf (stderr
, "\n");
7882 /* A null message buffer means that the frame hasn't really been
7883 initialized yet. Error messages get reported properly by
7884 cmd_error, so this must be just an informative message; toss it. */
7885 else if (INTERACTIVE
7886 && sf
->glyphs_initialized_p
7887 && FRAME_MESSAGE_BUF (sf
))
7889 Lisp_Object mini_window
;
7892 /* Get the frame containing the mini-buffer
7893 that the selected frame is using. */
7894 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7895 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7897 FRAME_SAMPLE_VISIBILITY (f
);
7898 if (FRAME_VISIBLE_P (sf
)
7899 && ! FRAME_VISIBLE_P (f
))
7900 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7904 set_message (m
, Qnil
, nbytes
, multibyte
);
7905 if (minibuffer_auto_raise
)
7906 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7909 clear_message (1, 1);
7911 do_pending_window_change (0);
7912 echo_area_display (1);
7913 do_pending_window_change (0);
7914 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7915 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7920 /* Display an echo area message M with a specified length of NBYTES
7921 bytes. The string may include null characters. If M is not a
7922 string, clear out any existing message, and let the mini-buffer
7925 This function cancels echoing. */
7928 message3 (m
, nbytes
, multibyte
)
7933 struct gcpro gcpro1
;
7936 clear_message (1,1);
7939 /* First flush out any partial line written with print. */
7940 message_log_maybe_newline ();
7946 SAFE_ALLOCA (buffer
, char *, nbytes
);
7947 bcopy (SDATA (m
), buffer
, nbytes
);
7948 message_dolog (buffer
, nbytes
, 1, multibyte
);
7951 message3_nolog (m
, nbytes
, multibyte
);
7957 /* The non-logging version of message3.
7958 This does not cancel echoing, because it is used for echoing.
7959 Perhaps we need to make a separate function for echoing
7960 and make this cancel echoing. */
7963 message3_nolog (m
, nbytes
, multibyte
)
7965 int nbytes
, multibyte
;
7967 struct frame
*sf
= SELECTED_FRAME ();
7968 message_enable_multibyte
= multibyte
;
7972 if (noninteractive_need_newline
)
7973 putc ('\n', stderr
);
7974 noninteractive_need_newline
= 0;
7976 fwrite (SDATA (m
), nbytes
, 1, stderr
);
7977 if (cursor_in_echo_area
== 0)
7978 fprintf (stderr
, "\n");
7981 /* A null message buffer means that the frame hasn't really been
7982 initialized yet. Error messages get reported properly by
7983 cmd_error, so this must be just an informative message; toss it. */
7984 else if (INTERACTIVE
7985 && sf
->glyphs_initialized_p
7986 && FRAME_MESSAGE_BUF (sf
))
7988 Lisp_Object mini_window
;
7992 /* Get the frame containing the mini-buffer
7993 that the selected frame is using. */
7994 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7995 frame
= XWINDOW (mini_window
)->frame
;
7998 FRAME_SAMPLE_VISIBILITY (f
);
7999 if (FRAME_VISIBLE_P (sf
)
8000 && !FRAME_VISIBLE_P (f
))
8001 Fmake_frame_visible (frame
);
8003 if (STRINGP (m
) && SCHARS (m
) > 0)
8005 set_message (NULL
, m
, nbytes
, multibyte
);
8006 if (minibuffer_auto_raise
)
8007 Fraise_frame (frame
);
8008 /* Assume we are not echoing.
8009 (If we are, echo_now will override this.) */
8010 echo_message_buffer
= Qnil
;
8013 clear_message (1, 1);
8015 do_pending_window_change (0);
8016 echo_area_display (1);
8017 do_pending_window_change (0);
8018 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8019 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8024 /* Display a null-terminated echo area message M. If M is 0, clear
8025 out any existing message, and let the mini-buffer text show through.
8027 The buffer M must continue to exist until after the echo area gets
8028 cleared or some other message gets displayed there. Do not pass
8029 text that is stored in a Lisp string. Do not pass text in a buffer
8030 that was alloca'd. */
8036 message2 (m
, (m
? strlen (m
) : 0), 0);
8040 /* The non-logging counterpart of message1. */
8046 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8049 /* Display a message M which contains a single %s
8050 which gets replaced with STRING. */
8053 message_with_string (m
, string
, log
)
8058 CHECK_STRING (string
);
8064 if (noninteractive_need_newline
)
8065 putc ('\n', stderr
);
8066 noninteractive_need_newline
= 0;
8067 fprintf (stderr
, m
, SDATA (string
));
8068 if (cursor_in_echo_area
== 0)
8069 fprintf (stderr
, "\n");
8073 else if (INTERACTIVE
)
8075 /* The frame whose minibuffer we're going to display the message on.
8076 It may be larger than the selected frame, so we need
8077 to use its buffer, not the selected frame's buffer. */
8078 Lisp_Object mini_window
;
8079 struct frame
*f
, *sf
= SELECTED_FRAME ();
8081 /* Get the frame containing the minibuffer
8082 that the selected frame is using. */
8083 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8084 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8086 /* A null message buffer means that the frame hasn't really been
8087 initialized yet. Error messages get reported properly by
8088 cmd_error, so this must be just an informative message; toss it. */
8089 if (FRAME_MESSAGE_BUF (f
))
8091 Lisp_Object args
[2], message
;
8092 struct gcpro gcpro1
, gcpro2
;
8094 args
[0] = build_string (m
);
8095 args
[1] = message
= string
;
8096 GCPRO2 (args
[0], message
);
8099 message
= Fformat (2, args
);
8102 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8104 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8108 /* Print should start at the beginning of the message
8109 buffer next time. */
8110 message_buf_print
= 0;
8116 /* Dump an informative message to the minibuf. If M is 0, clear out
8117 any existing message, and let the mini-buffer text show through. */
8121 message (m
, a1
, a2
, a3
)
8123 EMACS_INT a1
, a2
, a3
;
8129 if (noninteractive_need_newline
)
8130 putc ('\n', stderr
);
8131 noninteractive_need_newline
= 0;
8132 fprintf (stderr
, m
, a1
, a2
, a3
);
8133 if (cursor_in_echo_area
== 0)
8134 fprintf (stderr
, "\n");
8138 else if (INTERACTIVE
)
8140 /* The frame whose mini-buffer we're going to display the message
8141 on. It may be larger than the selected frame, so we need to
8142 use its buffer, not the selected frame's buffer. */
8143 Lisp_Object mini_window
;
8144 struct frame
*f
, *sf
= SELECTED_FRAME ();
8146 /* Get the frame containing the mini-buffer
8147 that the selected frame is using. */
8148 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8149 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8151 /* A null message buffer means that the frame hasn't really been
8152 initialized yet. Error messages get reported properly by
8153 cmd_error, so this must be just an informative message; toss
8155 if (FRAME_MESSAGE_BUF (f
))
8166 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8167 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8169 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8170 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8172 #endif /* NO_ARG_ARRAY */
8174 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8179 /* Print should start at the beginning of the message
8180 buffer next time. */
8181 message_buf_print
= 0;
8187 /* The non-logging version of message. */
8190 message_nolog (m
, a1
, a2
, a3
)
8192 EMACS_INT a1
, a2
, a3
;
8194 Lisp_Object old_log_max
;
8195 old_log_max
= Vmessage_log_max
;
8196 Vmessage_log_max
= Qnil
;
8197 message (m
, a1
, a2
, a3
);
8198 Vmessage_log_max
= old_log_max
;
8202 /* Display the current message in the current mini-buffer. This is
8203 only called from error handlers in process.c, and is not time
8209 if (!NILP (echo_area_buffer
[0]))
8212 string
= Fcurrent_message ();
8213 message3 (string
, SBYTES (string
),
8214 !NILP (current_buffer
->enable_multibyte_characters
));
8219 /* Make sure echo area buffers in `echo_buffers' are live.
8220 If they aren't, make new ones. */
8223 ensure_echo_area_buffers ()
8227 for (i
= 0; i
< 2; ++i
)
8228 if (!BUFFERP (echo_buffer
[i
])
8229 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8232 Lisp_Object old_buffer
;
8235 old_buffer
= echo_buffer
[i
];
8236 sprintf (name
, " *Echo Area %d*", i
);
8237 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8238 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8239 /* to force word wrap in echo area -
8240 it was decided to postpone this*/
8241 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8243 for (j
= 0; j
< 2; ++j
)
8244 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8245 echo_area_buffer
[j
] = echo_buffer
[i
];
8250 /* Call FN with args A1..A4 with either the current or last displayed
8251 echo_area_buffer as current buffer.
8253 WHICH zero means use the current message buffer
8254 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8255 from echo_buffer[] and clear it.
8257 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8258 suitable buffer from echo_buffer[] and clear it.
8260 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8261 that the current message becomes the last displayed one, make
8262 choose a suitable buffer for echo_area_buffer[0], and clear it.
8264 Value is what FN returns. */
8267 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8270 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8276 int this_one
, the_other
, clear_buffer_p
, rc
;
8277 int count
= SPECPDL_INDEX ();
8279 /* If buffers aren't live, make new ones. */
8280 ensure_echo_area_buffers ();
8285 this_one
= 0, the_other
= 1;
8287 this_one
= 1, the_other
= 0;
8290 this_one
= 0, the_other
= 1;
8293 /* We need a fresh one in case the current echo buffer equals
8294 the one containing the last displayed echo area message. */
8295 if (!NILP (echo_area_buffer
[this_one
])
8296 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8297 echo_area_buffer
[this_one
] = Qnil
;
8300 /* Choose a suitable buffer from echo_buffer[] is we don't
8302 if (NILP (echo_area_buffer
[this_one
]))
8304 echo_area_buffer
[this_one
]
8305 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8306 ? echo_buffer
[the_other
]
8307 : echo_buffer
[this_one
]);
8311 buffer
= echo_area_buffer
[this_one
];
8313 /* Don't get confused by reusing the buffer used for echoing
8314 for a different purpose. */
8315 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8318 record_unwind_protect (unwind_with_echo_area_buffer
,
8319 with_echo_area_buffer_unwind_data (w
));
8321 /* Make the echo area buffer current. Note that for display
8322 purposes, it is not necessary that the displayed window's buffer
8323 == current_buffer, except for text property lookup. So, let's
8324 only set that buffer temporarily here without doing a full
8325 Fset_window_buffer. We must also change w->pointm, though,
8326 because otherwise an assertions in unshow_buffer fails, and Emacs
8328 set_buffer_internal_1 (XBUFFER (buffer
));
8332 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8335 current_buffer
->undo_list
= Qt
;
8336 current_buffer
->read_only
= Qnil
;
8337 specbind (Qinhibit_read_only
, Qt
);
8338 specbind (Qinhibit_modification_hooks
, Qt
);
8340 if (clear_buffer_p
&& Z
> BEG
)
8343 xassert (BEGV
>= BEG
);
8344 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8346 rc
= fn (a1
, a2
, a3
, a4
);
8348 xassert (BEGV
>= BEG
);
8349 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8351 unbind_to (count
, Qnil
);
8356 /* Save state that should be preserved around the call to the function
8357 FN called in with_echo_area_buffer. */
8360 with_echo_area_buffer_unwind_data (w
)
8364 Lisp_Object vector
, tmp
;
8366 /* Reduce consing by keeping one vector in
8367 Vwith_echo_area_save_vector. */
8368 vector
= Vwith_echo_area_save_vector
;
8369 Vwith_echo_area_save_vector
= Qnil
;
8372 vector
= Fmake_vector (make_number (7), Qnil
);
8374 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8375 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8376 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8380 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8381 ASET (vector
, i
, w
->buffer
); ++i
;
8382 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8383 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8388 for (; i
< end
; ++i
)
8389 ASET (vector
, i
, Qnil
);
8392 xassert (i
== ASIZE (vector
));
8397 /* Restore global state from VECTOR which was created by
8398 with_echo_area_buffer_unwind_data. */
8401 unwind_with_echo_area_buffer (vector
)
8404 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8405 Vdeactivate_mark
= AREF (vector
, 1);
8406 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8408 if (WINDOWP (AREF (vector
, 3)))
8411 Lisp_Object buffer
, charpos
, bytepos
;
8413 w
= XWINDOW (AREF (vector
, 3));
8414 buffer
= AREF (vector
, 4);
8415 charpos
= AREF (vector
, 5);
8416 bytepos
= AREF (vector
, 6);
8419 set_marker_both (w
->pointm
, buffer
,
8420 XFASTINT (charpos
), XFASTINT (bytepos
));
8423 Vwith_echo_area_save_vector
= vector
;
8428 /* Set up the echo area for use by print functions. MULTIBYTE_P
8429 non-zero means we will print multibyte. */
8432 setup_echo_area_for_printing (multibyte_p
)
8435 /* If we can't find an echo area any more, exit. */
8436 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8439 ensure_echo_area_buffers ();
8441 if (!message_buf_print
)
8443 /* A message has been output since the last time we printed.
8444 Choose a fresh echo area buffer. */
8445 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8446 echo_area_buffer
[0] = echo_buffer
[1];
8448 echo_area_buffer
[0] = echo_buffer
[0];
8450 /* Switch to that buffer and clear it. */
8451 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8452 current_buffer
->truncate_lines
= Qnil
;
8456 int count
= SPECPDL_INDEX ();
8457 specbind (Qinhibit_read_only
, Qt
);
8458 /* Note that undo recording is always disabled. */
8460 unbind_to (count
, Qnil
);
8462 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8464 /* Set up the buffer for the multibyteness we need. */
8466 != !NILP (current_buffer
->enable_multibyte_characters
))
8467 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8469 /* Raise the frame containing the echo area. */
8470 if (minibuffer_auto_raise
)
8472 struct frame
*sf
= SELECTED_FRAME ();
8473 Lisp_Object mini_window
;
8474 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8475 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8478 message_log_maybe_newline ();
8479 message_buf_print
= 1;
8483 if (NILP (echo_area_buffer
[0]))
8485 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8486 echo_area_buffer
[0] = echo_buffer
[1];
8488 echo_area_buffer
[0] = echo_buffer
[0];
8491 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8493 /* Someone switched buffers between print requests. */
8494 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8495 current_buffer
->truncate_lines
= Qnil
;
8501 /* Display an echo area message in window W. Value is non-zero if W's
8502 height is changed. If display_last_displayed_message_p is
8503 non-zero, display the message that was last displayed, otherwise
8504 display the current message. */
8507 display_echo_area (w
)
8510 int i
, no_message_p
, window_height_changed_p
, count
;
8512 /* Temporarily disable garbage collections while displaying the echo
8513 area. This is done because a GC can print a message itself.
8514 That message would modify the echo area buffer's contents while a
8515 redisplay of the buffer is going on, and seriously confuse
8517 count
= inhibit_garbage_collection ();
8519 /* If there is no message, we must call display_echo_area_1
8520 nevertheless because it resizes the window. But we will have to
8521 reset the echo_area_buffer in question to nil at the end because
8522 with_echo_area_buffer will sets it to an empty buffer. */
8523 i
= display_last_displayed_message_p
? 1 : 0;
8524 no_message_p
= NILP (echo_area_buffer
[i
]);
8526 window_height_changed_p
8527 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8528 display_echo_area_1
,
8529 (EMACS_INT
) w
, Qnil
, 0, 0);
8532 echo_area_buffer
[i
] = Qnil
;
8534 unbind_to (count
, Qnil
);
8535 return window_height_changed_p
;
8539 /* Helper for display_echo_area. Display the current buffer which
8540 contains the current echo area message in window W, a mini-window,
8541 a pointer to which is passed in A1. A2..A4 are currently not used.
8542 Change the height of W so that all of the message is displayed.
8543 Value is non-zero if height of W was changed. */
8546 display_echo_area_1 (a1
, a2
, a3
, a4
)
8551 struct window
*w
= (struct window
*) a1
;
8553 struct text_pos start
;
8554 int window_height_changed_p
= 0;
8556 /* Do this before displaying, so that we have a large enough glyph
8557 matrix for the display. If we can't get enough space for the
8558 whole text, display the last N lines. That works by setting w->start. */
8559 window_height_changed_p
= resize_mini_window (w
, 0);
8561 /* Use the starting position chosen by resize_mini_window. */
8562 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8565 clear_glyph_matrix (w
->desired_matrix
);
8566 XSETWINDOW (window
, w
);
8567 try_window (window
, start
, 0);
8569 return window_height_changed_p
;
8573 /* Resize the echo area window to exactly the size needed for the
8574 currently displayed message, if there is one. If a mini-buffer
8575 is active, don't shrink it. */
8578 resize_echo_area_exactly ()
8580 if (BUFFERP (echo_area_buffer
[0])
8581 && WINDOWP (echo_area_window
))
8583 struct window
*w
= XWINDOW (echo_area_window
);
8585 Lisp_Object resize_exactly
;
8587 if (minibuf_level
== 0)
8588 resize_exactly
= Qt
;
8590 resize_exactly
= Qnil
;
8592 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8593 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8596 ++windows_or_buffers_changed
;
8597 ++update_mode_lines
;
8598 redisplay_internal (0);
8604 /* Callback function for with_echo_area_buffer, when used from
8605 resize_echo_area_exactly. A1 contains a pointer to the window to
8606 resize, EXACTLY non-nil means resize the mini-window exactly to the
8607 size of the text displayed. A3 and A4 are not used. Value is what
8608 resize_mini_window returns. */
8611 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8613 Lisp_Object exactly
;
8616 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8620 /* Resize mini-window W to fit the size of its contents. EXACT_P
8621 means size the window exactly to the size needed. Otherwise, it's
8622 only enlarged until W's buffer is empty.
8624 Set W->start to the right place to begin display. If the whole
8625 contents fit, start at the beginning. Otherwise, start so as
8626 to make the end of the contents appear. This is particularly
8627 important for y-or-n-p, but seems desirable generally.
8629 Value is non-zero if the window height has been changed. */
8632 resize_mini_window (w
, exact_p
)
8636 struct frame
*f
= XFRAME (w
->frame
);
8637 int window_height_changed_p
= 0;
8639 xassert (MINI_WINDOW_P (w
));
8641 /* By default, start display at the beginning. */
8642 set_marker_both (w
->start
, w
->buffer
,
8643 BUF_BEGV (XBUFFER (w
->buffer
)),
8644 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8646 /* Don't resize windows while redisplaying a window; it would
8647 confuse redisplay functions when the size of the window they are
8648 displaying changes from under them. Such a resizing can happen,
8649 for instance, when which-func prints a long message while
8650 we are running fontification-functions. We're running these
8651 functions with safe_call which binds inhibit-redisplay to t. */
8652 if (!NILP (Vinhibit_redisplay
))
8655 /* Nil means don't try to resize. */
8656 if (NILP (Vresize_mini_windows
)
8657 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8660 if (!FRAME_MINIBUF_ONLY_P (f
))
8663 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8664 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8665 int height
, max_height
;
8666 int unit
= FRAME_LINE_HEIGHT (f
);
8667 struct text_pos start
;
8668 struct buffer
*old_current_buffer
= NULL
;
8670 if (current_buffer
!= XBUFFER (w
->buffer
))
8672 old_current_buffer
= current_buffer
;
8673 set_buffer_internal (XBUFFER (w
->buffer
));
8676 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8678 /* Compute the max. number of lines specified by the user. */
8679 if (FLOATP (Vmax_mini_window_height
))
8680 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8681 else if (INTEGERP (Vmax_mini_window_height
))
8682 max_height
= XINT (Vmax_mini_window_height
);
8684 max_height
= total_height
/ 4;
8686 /* Correct that max. height if it's bogus. */
8687 max_height
= max (1, max_height
);
8688 max_height
= min (total_height
, max_height
);
8690 /* Find out the height of the text in the window. */
8691 if (it
.line_wrap
== TRUNCATE
)
8696 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8697 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8698 height
= it
.current_y
+ last_height
;
8700 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8701 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8702 height
= (height
+ unit
- 1) / unit
;
8705 /* Compute a suitable window start. */
8706 if (height
> max_height
)
8708 height
= max_height
;
8709 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8710 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8711 start
= it
.current
.pos
;
8714 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8715 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8717 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8719 /* Let it grow only, until we display an empty message, in which
8720 case the window shrinks again. */
8721 if (height
> WINDOW_TOTAL_LINES (w
))
8723 int old_height
= WINDOW_TOTAL_LINES (w
);
8724 freeze_window_starts (f
, 1);
8725 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8726 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8728 else if (height
< WINDOW_TOTAL_LINES (w
)
8729 && (exact_p
|| BEGV
== ZV
))
8731 int old_height
= WINDOW_TOTAL_LINES (w
);
8732 freeze_window_starts (f
, 0);
8733 shrink_mini_window (w
);
8734 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8739 /* Always resize to exact size needed. */
8740 if (height
> WINDOW_TOTAL_LINES (w
))
8742 int old_height
= WINDOW_TOTAL_LINES (w
);
8743 freeze_window_starts (f
, 1);
8744 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8745 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8747 else if (height
< WINDOW_TOTAL_LINES (w
))
8749 int old_height
= WINDOW_TOTAL_LINES (w
);
8750 freeze_window_starts (f
, 0);
8751 shrink_mini_window (w
);
8755 freeze_window_starts (f
, 1);
8756 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8759 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8763 if (old_current_buffer
)
8764 set_buffer_internal (old_current_buffer
);
8767 return window_height_changed_p
;
8771 /* Value is the current message, a string, or nil if there is no
8779 if (!BUFFERP (echo_area_buffer
[0]))
8783 with_echo_area_buffer (0, 0, current_message_1
,
8784 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8786 echo_area_buffer
[0] = Qnil
;
8794 current_message_1 (a1
, a2
, a3
, a4
)
8799 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8802 *msg
= make_buffer_string (BEG
, Z
, 1);
8809 /* Push the current message on Vmessage_stack for later restauration
8810 by restore_message. Value is non-zero if the current message isn't
8811 empty. This is a relatively infrequent operation, so it's not
8812 worth optimizing. */
8818 msg
= current_message ();
8819 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8820 return STRINGP (msg
);
8824 /* Restore message display from the top of Vmessage_stack. */
8831 xassert (CONSP (Vmessage_stack
));
8832 msg
= XCAR (Vmessage_stack
);
8834 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8836 message3_nolog (msg
, 0, 0);
8840 /* Handler for record_unwind_protect calling pop_message. */
8843 pop_message_unwind (dummy
)
8850 /* Pop the top-most entry off Vmessage_stack. */
8855 xassert (CONSP (Vmessage_stack
));
8856 Vmessage_stack
= XCDR (Vmessage_stack
);
8860 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8861 exits. If the stack is not empty, we have a missing pop_message
8865 check_message_stack ()
8867 if (!NILP (Vmessage_stack
))
8872 /* Truncate to NCHARS what will be displayed in the echo area the next
8873 time we display it---but don't redisplay it now. */
8876 truncate_echo_area (nchars
)
8880 echo_area_buffer
[0] = Qnil
;
8881 /* A null message buffer means that the frame hasn't really been
8882 initialized yet. Error messages get reported properly by
8883 cmd_error, so this must be just an informative message; toss it. */
8884 else if (!noninteractive
8886 && !NILP (echo_area_buffer
[0]))
8888 struct frame
*sf
= SELECTED_FRAME ();
8889 if (FRAME_MESSAGE_BUF (sf
))
8890 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8895 /* Helper function for truncate_echo_area. Truncate the current
8896 message to at most NCHARS characters. */
8899 truncate_message_1 (nchars
, a2
, a3
, a4
)
8904 if (BEG
+ nchars
< Z
)
8905 del_range (BEG
+ nchars
, Z
);
8907 echo_area_buffer
[0] = Qnil
;
8912 /* Set the current message to a substring of S or STRING.
8914 If STRING is a Lisp string, set the message to the first NBYTES
8915 bytes from STRING. NBYTES zero means use the whole string. If
8916 STRING is multibyte, the message will be displayed multibyte.
8918 If S is not null, set the message to the first LEN bytes of S. LEN
8919 zero means use the whole string. MULTIBYTE_P non-zero means S is
8920 multibyte. Display the message multibyte in that case.
8922 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8923 to t before calling set_message_1 (which calls insert).
8927 set_message (s
, string
, nbytes
, multibyte_p
)
8930 int nbytes
, multibyte_p
;
8932 message_enable_multibyte
8933 = ((s
&& multibyte_p
)
8934 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8936 with_echo_area_buffer (0, -1, set_message_1
,
8937 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8938 message_buf_print
= 0;
8939 help_echo_showing_p
= 0;
8943 /* Helper function for set_message. Arguments have the same meaning
8944 as there, with A1 corresponding to S and A2 corresponding to STRING
8945 This function is called with the echo area buffer being
8949 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8952 EMACS_INT nbytes
, multibyte_p
;
8954 const char *s
= (const char *) a1
;
8955 Lisp_Object string
= a2
;
8957 /* Change multibyteness of the echo buffer appropriately. */
8958 if (message_enable_multibyte
8959 != !NILP (current_buffer
->enable_multibyte_characters
))
8960 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8962 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8964 /* Insert new message at BEG. */
8965 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8967 if (STRINGP (string
))
8972 nbytes
= SBYTES (string
);
8973 nchars
= string_byte_to_char (string
, nbytes
);
8975 /* This function takes care of single/multibyte conversion. We
8976 just have to ensure that the echo area buffer has the right
8977 setting of enable_multibyte_characters. */
8978 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
8983 nbytes
= strlen (s
);
8985 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
8987 /* Convert from multi-byte to single-byte. */
8989 unsigned char work
[1];
8991 /* Convert a multibyte string to single-byte. */
8992 for (i
= 0; i
< nbytes
; i
+= n
)
8994 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
8995 work
[0] = (ASCII_CHAR_P (c
)
8997 : multibyte_char_to_unibyte (c
, Qnil
));
8998 insert_1_both (work
, 1, 1, 1, 0, 0);
9001 else if (!multibyte_p
9002 && !NILP (current_buffer
->enable_multibyte_characters
))
9004 /* Convert from single-byte to multi-byte. */
9006 const unsigned char *msg
= (const unsigned char *) s
;
9007 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9009 /* Convert a single-byte string to multibyte. */
9010 for (i
= 0; i
< nbytes
; i
++)
9013 c
= unibyte_char_to_multibyte (c
);
9014 n
= CHAR_STRING (c
, str
);
9015 insert_1_both (str
, 1, n
, 1, 0, 0);
9019 insert_1 (s
, nbytes
, 1, 0, 0);
9026 /* Clear messages. CURRENT_P non-zero means clear the current
9027 message. LAST_DISPLAYED_P non-zero means clear the message
9031 clear_message (current_p
, last_displayed_p
)
9032 int current_p
, last_displayed_p
;
9036 echo_area_buffer
[0] = Qnil
;
9037 message_cleared_p
= 1;
9040 if (last_displayed_p
)
9041 echo_area_buffer
[1] = Qnil
;
9043 message_buf_print
= 0;
9046 /* Clear garbaged frames.
9048 This function is used where the old redisplay called
9049 redraw_garbaged_frames which in turn called redraw_frame which in
9050 turn called clear_frame. The call to clear_frame was a source of
9051 flickering. I believe a clear_frame is not necessary. It should
9052 suffice in the new redisplay to invalidate all current matrices,
9053 and ensure a complete redisplay of all windows. */
9056 clear_garbaged_frames ()
9060 Lisp_Object tail
, frame
;
9061 int changed_count
= 0;
9063 FOR_EACH_FRAME (tail
, frame
)
9065 struct frame
*f
= XFRAME (frame
);
9067 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9071 Fredraw_frame (frame
);
9072 f
->force_flush_display_p
= 1;
9074 clear_current_matrices (f
);
9083 ++windows_or_buffers_changed
;
9088 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9089 is non-zero update selected_frame. Value is non-zero if the
9090 mini-windows height has been changed. */
9093 echo_area_display (update_frame_p
)
9096 Lisp_Object mini_window
;
9099 int window_height_changed_p
= 0;
9100 struct frame
*sf
= SELECTED_FRAME ();
9102 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9103 w
= XWINDOW (mini_window
);
9104 f
= XFRAME (WINDOW_FRAME (w
));
9106 /* Don't display if frame is invisible or not yet initialized. */
9107 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9110 #ifdef HAVE_WINDOW_SYSTEM
9111 /* When Emacs starts, selected_frame may be the initial terminal
9112 frame. If we let this through, a message would be displayed on
9114 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9116 #endif /* HAVE_WINDOW_SYSTEM */
9118 /* Redraw garbaged frames. */
9120 clear_garbaged_frames ();
9122 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9124 echo_area_window
= mini_window
;
9125 window_height_changed_p
= display_echo_area (w
);
9126 w
->must_be_updated_p
= 1;
9128 /* Update the display, unless called from redisplay_internal.
9129 Also don't update the screen during redisplay itself. The
9130 update will happen at the end of redisplay, and an update
9131 here could cause confusion. */
9132 if (update_frame_p
&& !redisplaying_p
)
9136 /* If the display update has been interrupted by pending
9137 input, update mode lines in the frame. Due to the
9138 pending input, it might have been that redisplay hasn't
9139 been called, so that mode lines above the echo area are
9140 garbaged. This looks odd, so we prevent it here. */
9141 if (!display_completed
)
9142 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9144 if (window_height_changed_p
9145 /* Don't do this if Emacs is shutting down. Redisplay
9146 needs to run hooks. */
9147 && !NILP (Vrun_hooks
))
9149 /* Must update other windows. Likewise as in other
9150 cases, don't let this update be interrupted by
9152 int count
= SPECPDL_INDEX ();
9153 specbind (Qredisplay_dont_pause
, Qt
);
9154 windows_or_buffers_changed
= 1;
9155 redisplay_internal (0);
9156 unbind_to (count
, Qnil
);
9158 else if (FRAME_WINDOW_P (f
) && n
== 0)
9160 /* Window configuration is the same as before.
9161 Can do with a display update of the echo area,
9162 unless we displayed some mode lines. */
9163 update_single_window (w
, 1);
9164 FRAME_RIF (f
)->flush_display (f
);
9167 update_frame (f
, 1, 1);
9169 /* If cursor is in the echo area, make sure that the next
9170 redisplay displays the minibuffer, so that the cursor will
9171 be replaced with what the minibuffer wants. */
9172 if (cursor_in_echo_area
)
9173 ++windows_or_buffers_changed
;
9176 else if (!EQ (mini_window
, selected_window
))
9177 windows_or_buffers_changed
++;
9179 /* Last displayed message is now the current message. */
9180 echo_area_buffer
[1] = echo_area_buffer
[0];
9181 /* Inform read_char that we're not echoing. */
9182 echo_message_buffer
= Qnil
;
9184 /* Prevent redisplay optimization in redisplay_internal by resetting
9185 this_line_start_pos. This is done because the mini-buffer now
9186 displays the message instead of its buffer text. */
9187 if (EQ (mini_window
, selected_window
))
9188 CHARPOS (this_line_start_pos
) = 0;
9190 return window_height_changed_p
;
9195 /***********************************************************************
9196 Mode Lines and Frame Titles
9197 ***********************************************************************/
9199 /* A buffer for constructing non-propertized mode-line strings and
9200 frame titles in it; allocated from the heap in init_xdisp and
9201 resized as needed in store_mode_line_noprop_char. */
9203 static char *mode_line_noprop_buf
;
9205 /* The buffer's end, and a current output position in it. */
9207 static char *mode_line_noprop_buf_end
;
9208 static char *mode_line_noprop_ptr
;
9210 #define MODE_LINE_NOPROP_LEN(start) \
9211 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9214 MODE_LINE_DISPLAY
= 0,
9220 /* Alist that caches the results of :propertize.
9221 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9222 static Lisp_Object mode_line_proptrans_alist
;
9224 /* List of strings making up the mode-line. */
9225 static Lisp_Object mode_line_string_list
;
9227 /* Base face property when building propertized mode line string. */
9228 static Lisp_Object mode_line_string_face
;
9229 static Lisp_Object mode_line_string_face_prop
;
9232 /* Unwind data for mode line strings */
9234 static Lisp_Object Vmode_line_unwind_vector
;
9237 format_mode_line_unwind_data (struct buffer
*obuf
,
9241 Lisp_Object vector
, tmp
;
9243 /* Reduce consing by keeping one vector in
9244 Vwith_echo_area_save_vector. */
9245 vector
= Vmode_line_unwind_vector
;
9246 Vmode_line_unwind_vector
= Qnil
;
9249 vector
= Fmake_vector (make_number (8), Qnil
);
9251 ASET (vector
, 0, make_number (mode_line_target
));
9252 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9253 ASET (vector
, 2, mode_line_string_list
);
9254 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9255 ASET (vector
, 4, mode_line_string_face
);
9256 ASET (vector
, 5, mode_line_string_face_prop
);
9259 XSETBUFFER (tmp
, obuf
);
9262 ASET (vector
, 6, tmp
);
9263 ASET (vector
, 7, owin
);
9269 unwind_format_mode_line (vector
)
9272 mode_line_target
= XINT (AREF (vector
, 0));
9273 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9274 mode_line_string_list
= AREF (vector
, 2);
9275 if (! EQ (AREF (vector
, 3), Qt
))
9276 mode_line_proptrans_alist
= AREF (vector
, 3);
9277 mode_line_string_face
= AREF (vector
, 4);
9278 mode_line_string_face_prop
= AREF (vector
, 5);
9280 if (!NILP (AREF (vector
, 7)))
9281 /* Select window before buffer, since it may change the buffer. */
9282 Fselect_window (AREF (vector
, 7), Qt
);
9284 if (!NILP (AREF (vector
, 6)))
9286 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9287 ASET (vector
, 6, Qnil
);
9290 Vmode_line_unwind_vector
= vector
;
9295 /* Store a single character C for the frame title in mode_line_noprop_buf.
9296 Re-allocate mode_line_noprop_buf if necessary. */
9300 store_mode_line_noprop_char (char c
)
9302 store_mode_line_noprop_char (c
)
9306 /* If output position has reached the end of the allocated buffer,
9307 double the buffer's size. */
9308 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9310 int len
= MODE_LINE_NOPROP_LEN (0);
9311 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9312 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9313 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9314 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9317 *mode_line_noprop_ptr
++ = c
;
9321 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9322 mode_line_noprop_ptr. STR is the string to store. Do not copy
9323 characters that yield more columns than PRECISION; PRECISION <= 0
9324 means copy the whole string. Pad with spaces until FIELD_WIDTH
9325 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9326 pad. Called from display_mode_element when it is used to build a
9330 store_mode_line_noprop (str
, field_width
, precision
)
9331 const unsigned char *str
;
9332 int field_width
, precision
;
9337 /* Copy at most PRECISION chars from STR. */
9338 nbytes
= strlen (str
);
9339 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9341 store_mode_line_noprop_char (*str
++);
9343 /* Fill up with spaces until FIELD_WIDTH reached. */
9344 while (field_width
> 0
9347 store_mode_line_noprop_char (' ');
9354 /***********************************************************************
9356 ***********************************************************************/
9358 #ifdef HAVE_WINDOW_SYSTEM
9360 /* Set the title of FRAME, if it has changed. The title format is
9361 Vicon_title_format if FRAME is iconified, otherwise it is
9362 frame_title_format. */
9365 x_consider_frame_title (frame
)
9368 struct frame
*f
= XFRAME (frame
);
9370 if (FRAME_WINDOW_P (f
)
9371 || FRAME_MINIBUF_ONLY_P (f
)
9372 || f
->explicit_name
)
9374 /* Do we have more than one visible frame on this X display? */
9381 int count
= SPECPDL_INDEX ();
9383 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9385 Lisp_Object other_frame
= XCAR (tail
);
9386 struct frame
*tf
= XFRAME (other_frame
);
9389 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9390 && !FRAME_MINIBUF_ONLY_P (tf
)
9391 && !EQ (other_frame
, tip_frame
)
9392 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9396 /* Set global variable indicating that multiple frames exist. */
9397 multiple_frames
= CONSP (tail
);
9399 /* Switch to the buffer of selected window of the frame. Set up
9400 mode_line_target so that display_mode_element will output into
9401 mode_line_noprop_buf; then display the title. */
9402 record_unwind_protect (unwind_format_mode_line
,
9403 format_mode_line_unwind_data
9404 (current_buffer
, selected_window
, 0));
9406 Fselect_window (f
->selected_window
, Qt
);
9407 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9408 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9410 mode_line_target
= MODE_LINE_TITLE
;
9411 title_start
= MODE_LINE_NOPROP_LEN (0);
9412 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9413 NULL
, DEFAULT_FACE_ID
);
9414 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9415 len
= MODE_LINE_NOPROP_LEN (title_start
);
9416 title
= mode_line_noprop_buf
+ title_start
;
9417 unbind_to (count
, Qnil
);
9419 /* Set the title only if it's changed. This avoids consing in
9420 the common case where it hasn't. (If it turns out that we've
9421 already wasted too much time by walking through the list with
9422 display_mode_element, then we might need to optimize at a
9423 higher level than this.) */
9424 if (! STRINGP (f
->name
)
9425 || SBYTES (f
->name
) != len
9426 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9431 if (!MINI_WINDOW_P(XWINDOW(f
->selected_window
)))
9434 ns_set_name_as_filename (f
);
9436 x_implicitly_set_name (f
, make_string(title
, len
),
9442 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9447 /* do this also for frames with explicit names */
9448 ns_implicitly_set_icon_type(f
);
9449 ns_set_doc_edited(f
, Fbuffer_modified_p
9450 (XWINDOW (f
->selected_window
)->buffer
), Qnil
);
9456 #endif /* not HAVE_WINDOW_SYSTEM */
9461 /***********************************************************************
9463 ***********************************************************************/
9466 /* Prepare for redisplay by updating menu-bar item lists when
9467 appropriate. This can call eval. */
9470 prepare_menu_bars ()
9473 struct gcpro gcpro1
, gcpro2
;
9475 Lisp_Object tooltip_frame
;
9477 #ifdef HAVE_WINDOW_SYSTEM
9478 tooltip_frame
= tip_frame
;
9480 tooltip_frame
= Qnil
;
9483 /* Update all frame titles based on their buffer names, etc. We do
9484 this before the menu bars so that the buffer-menu will show the
9485 up-to-date frame titles. */
9486 #ifdef HAVE_WINDOW_SYSTEM
9487 if (windows_or_buffers_changed
|| update_mode_lines
)
9489 Lisp_Object tail
, frame
;
9491 FOR_EACH_FRAME (tail
, frame
)
9494 if (!EQ (frame
, tooltip_frame
)
9495 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9496 x_consider_frame_title (frame
);
9499 #endif /* HAVE_WINDOW_SYSTEM */
9501 /* Update the menu bar item lists, if appropriate. This has to be
9502 done before any actual redisplay or generation of display lines. */
9503 all_windows
= (update_mode_lines
9504 || buffer_shared
> 1
9505 || windows_or_buffers_changed
);
9508 Lisp_Object tail
, frame
;
9509 int count
= SPECPDL_INDEX ();
9510 /* 1 means that update_menu_bar has run its hooks
9511 so any further calls to update_menu_bar shouldn't do so again. */
9512 int menu_bar_hooks_run
= 0;
9514 record_unwind_save_match_data ();
9516 FOR_EACH_FRAME (tail
, frame
)
9520 /* Ignore tooltip frame. */
9521 if (EQ (frame
, tooltip_frame
))
9524 /* If a window on this frame changed size, report that to
9525 the user and clear the size-change flag. */
9526 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9528 Lisp_Object functions
;
9530 /* Clear flag first in case we get an error below. */
9531 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9532 functions
= Vwindow_size_change_functions
;
9533 GCPRO2 (tail
, functions
);
9535 while (CONSP (functions
))
9537 if (!EQ (XCAR (functions
), Qt
))
9538 call1 (XCAR (functions
), frame
);
9539 functions
= XCDR (functions
);
9545 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9546 #ifdef HAVE_WINDOW_SYSTEM
9547 update_tool_bar (f
, 0);
9552 unbind_to (count
, Qnil
);
9556 struct frame
*sf
= SELECTED_FRAME ();
9557 update_menu_bar (sf
, 1, 0);
9558 #ifdef HAVE_WINDOW_SYSTEM
9559 update_tool_bar (sf
, 1);
9563 /* Motif needs this. See comment in xmenu.c. Turn it off when
9564 pending_menu_activation is not defined. */
9565 #ifdef USE_X_TOOLKIT
9566 pending_menu_activation
= 0;
9571 /* Update the menu bar item list for frame F. This has to be done
9572 before we start to fill in any display lines, because it can call
9575 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9577 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9578 already ran the menu bar hooks for this redisplay, so there
9579 is no need to run them again. The return value is the
9580 updated value of this flag, to pass to the next call. */
9583 update_menu_bar (f
, save_match_data
, hooks_run
)
9585 int save_match_data
;
9589 register struct window
*w
;
9591 /* If called recursively during a menu update, do nothing. This can
9592 happen when, for instance, an activate-menubar-hook causes a
9594 if (inhibit_menubar_update
)
9597 window
= FRAME_SELECTED_WINDOW (f
);
9598 w
= XWINDOW (window
);
9600 if (FRAME_WINDOW_P (f
)
9602 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9603 || defined (HAVE_NS) || defined (USE_GTK)
9604 FRAME_EXTERNAL_MENU_BAR (f
)
9606 FRAME_MENU_BAR_LINES (f
) > 0
9608 : FRAME_MENU_BAR_LINES (f
) > 0)
9610 /* If the user has switched buffers or windows, we need to
9611 recompute to reflect the new bindings. But we'll
9612 recompute when update_mode_lines is set too; that means
9613 that people can use force-mode-line-update to request
9614 that the menu bar be recomputed. The adverse effect on
9615 the rest of the redisplay algorithm is about the same as
9616 windows_or_buffers_changed anyway. */
9617 if (windows_or_buffers_changed
9618 /* This used to test w->update_mode_line, but we believe
9619 there is no need to recompute the menu in that case. */
9620 || update_mode_lines
9621 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9622 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9623 != !NILP (w
->last_had_star
))
9624 || ((!NILP (Vtransient_mark_mode
)
9625 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9626 != !NILP (w
->region_showing
)))
9628 struct buffer
*prev
= current_buffer
;
9629 int count
= SPECPDL_INDEX ();
9631 specbind (Qinhibit_menubar_update
, Qt
);
9633 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9634 if (save_match_data
)
9635 record_unwind_save_match_data ();
9636 if (NILP (Voverriding_local_map_menu_flag
))
9638 specbind (Qoverriding_terminal_local_map
, Qnil
);
9639 specbind (Qoverriding_local_map
, Qnil
);
9644 /* Run the Lucid hook. */
9645 safe_run_hooks (Qactivate_menubar_hook
);
9647 /* If it has changed current-menubar from previous value,
9648 really recompute the menu-bar from the value. */
9649 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9650 call0 (Qrecompute_lucid_menubar
);
9652 safe_run_hooks (Qmenu_bar_update_hook
);
9657 XSETFRAME (Vmenu_updating_frame
, f
);
9658 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9660 /* Redisplay the menu bar in case we changed it. */
9661 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9662 || defined (HAVE_NS) || defined (USE_GTK)
9663 if (FRAME_WINDOW_P (f
))
9665 #if defined (HAVE_NS)
9666 /* All frames on Mac OS share the same menubar. So only
9667 the selected frame should be allowed to set it. */
9668 if (f
== SELECTED_FRAME ())
9670 set_frame_menubar (f
, 0, 0);
9673 /* On a terminal screen, the menu bar is an ordinary screen
9674 line, and this makes it get updated. */
9675 w
->update_mode_line
= Qt
;
9676 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9677 /* In the non-toolkit version, the menu bar is an ordinary screen
9678 line, and this makes it get updated. */
9679 w
->update_mode_line
= Qt
;
9680 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9682 unbind_to (count
, Qnil
);
9683 set_buffer_internal_1 (prev
);
9692 /***********************************************************************
9694 ***********************************************************************/
9696 #ifdef HAVE_WINDOW_SYSTEM
9699 Nominal cursor position -- where to draw output.
9700 HPOS and VPOS are window relative glyph matrix coordinates.
9701 X and Y are window relative pixel coordinates. */
9703 struct cursor_pos output_cursor
;
9707 Set the global variable output_cursor to CURSOR. All cursor
9708 positions are relative to updated_window. */
9711 set_output_cursor (cursor
)
9712 struct cursor_pos
*cursor
;
9714 output_cursor
.hpos
= cursor
->hpos
;
9715 output_cursor
.vpos
= cursor
->vpos
;
9716 output_cursor
.x
= cursor
->x
;
9717 output_cursor
.y
= cursor
->y
;
9722 Set a nominal cursor position.
9724 HPOS and VPOS are column/row positions in a window glyph matrix. X
9725 and Y are window text area relative pixel positions.
9727 If this is done during an update, updated_window will contain the
9728 window that is being updated and the position is the future output
9729 cursor position for that window. If updated_window is null, use
9730 selected_window and display the cursor at the given position. */
9733 x_cursor_to (vpos
, hpos
, y
, x
)
9734 int vpos
, hpos
, y
, x
;
9738 /* If updated_window is not set, work on selected_window. */
9742 w
= XWINDOW (selected_window
);
9744 /* Set the output cursor. */
9745 output_cursor
.hpos
= hpos
;
9746 output_cursor
.vpos
= vpos
;
9747 output_cursor
.x
= x
;
9748 output_cursor
.y
= y
;
9750 /* If not called as part of an update, really display the cursor.
9751 This will also set the cursor position of W. */
9752 if (updated_window
== NULL
)
9755 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9756 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9757 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9762 #endif /* HAVE_WINDOW_SYSTEM */
9765 /***********************************************************************
9767 ***********************************************************************/
9769 #ifdef HAVE_WINDOW_SYSTEM
9771 /* Where the mouse was last time we reported a mouse event. */
9773 FRAME_PTR last_mouse_frame
;
9775 /* Tool-bar item index of the item on which a mouse button was pressed
9778 int last_tool_bar_item
;
9782 update_tool_bar_unwind (frame
)
9785 selected_frame
= frame
;
9789 /* Update the tool-bar item list for frame F. This has to be done
9790 before we start to fill in any display lines. Called from
9791 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9792 and restore it here. */
9795 update_tool_bar (f
, save_match_data
)
9797 int save_match_data
;
9799 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
9800 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9802 int do_update
= WINDOWP (f
->tool_bar_window
)
9803 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9811 window
= FRAME_SELECTED_WINDOW (f
);
9812 w
= XWINDOW (window
);
9814 /* If the user has switched buffers or windows, we need to
9815 recompute to reflect the new bindings. But we'll
9816 recompute when update_mode_lines is set too; that means
9817 that people can use force-mode-line-update to request
9818 that the menu bar be recomputed. The adverse effect on
9819 the rest of the redisplay algorithm is about the same as
9820 windows_or_buffers_changed anyway. */
9821 if (windows_or_buffers_changed
9822 || !NILP (w
->update_mode_line
)
9823 || update_mode_lines
9824 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9825 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9826 != !NILP (w
->last_had_star
))
9827 || ((!NILP (Vtransient_mark_mode
)
9828 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9829 != !NILP (w
->region_showing
)))
9831 struct buffer
*prev
= current_buffer
;
9832 int count
= SPECPDL_INDEX ();
9833 Lisp_Object frame
, new_tool_bar
;
9835 struct gcpro gcpro1
;
9837 /* Set current_buffer to the buffer of the selected
9838 window of the frame, so that we get the right local
9840 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9842 /* Save match data, if we must. */
9843 if (save_match_data
)
9844 record_unwind_save_match_data ();
9846 /* Make sure that we don't accidentally use bogus keymaps. */
9847 if (NILP (Voverriding_local_map_menu_flag
))
9849 specbind (Qoverriding_terminal_local_map
, Qnil
);
9850 specbind (Qoverriding_local_map
, Qnil
);
9853 GCPRO1 (new_tool_bar
);
9855 /* We must temporarily set the selected frame to this frame
9856 before calling tool_bar_items, because the calculation of
9857 the tool-bar keymap uses the selected frame (see
9858 `tool-bar-make-keymap' in tool-bar.el). */
9859 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
9860 XSETFRAME (frame
, f
);
9861 selected_frame
= frame
;
9863 /* Build desired tool-bar items from keymaps. */
9864 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9867 /* Redisplay the tool-bar if we changed it. */
9868 if (new_n_tool_bar
!= f
->n_tool_bar_items
9869 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9871 /* Redisplay that happens asynchronously due to an expose event
9872 may access f->tool_bar_items. Make sure we update both
9873 variables within BLOCK_INPUT so no such event interrupts. */
9875 f
->tool_bar_items
= new_tool_bar
;
9876 f
->n_tool_bar_items
= new_n_tool_bar
;
9877 w
->update_mode_line
= Qt
;
9883 unbind_to (count
, Qnil
);
9884 set_buffer_internal_1 (prev
);
9890 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9891 F's desired tool-bar contents. F->tool_bar_items must have
9892 been set up previously by calling prepare_menu_bars. */
9895 build_desired_tool_bar_string (f
)
9898 int i
, size
, size_needed
;
9899 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9900 Lisp_Object image
, plist
, props
;
9902 image
= plist
= props
= Qnil
;
9903 GCPRO3 (image
, plist
, props
);
9905 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9906 Otherwise, make a new string. */
9908 /* The size of the string we might be able to reuse. */
9909 size
= (STRINGP (f
->desired_tool_bar_string
)
9910 ? SCHARS (f
->desired_tool_bar_string
)
9913 /* We need one space in the string for each image. */
9914 size_needed
= f
->n_tool_bar_items
;
9916 /* Reuse f->desired_tool_bar_string, if possible. */
9917 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9918 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9922 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9923 Fremove_text_properties (make_number (0), make_number (size
),
9924 props
, f
->desired_tool_bar_string
);
9927 /* Put a `display' property on the string for the images to display,
9928 put a `menu_item' property on tool-bar items with a value that
9929 is the index of the item in F's tool-bar item vector. */
9930 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9932 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9934 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9935 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9936 int hmargin
, vmargin
, relief
, idx
, end
;
9937 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9939 /* If image is a vector, choose the image according to the
9941 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9942 if (VECTORP (image
))
9946 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9947 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9950 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9951 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9953 xassert (ASIZE (image
) >= idx
);
9954 image
= AREF (image
, idx
);
9959 /* Ignore invalid image specifications. */
9960 if (!valid_image_p (image
))
9963 /* Display the tool-bar button pressed, or depressed. */
9964 plist
= Fcopy_sequence (XCDR (image
));
9966 /* Compute margin and relief to draw. */
9967 relief
= (tool_bar_button_relief
>= 0
9968 ? tool_bar_button_relief
9969 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9970 hmargin
= vmargin
= relief
;
9972 if (INTEGERP (Vtool_bar_button_margin
)
9973 && XINT (Vtool_bar_button_margin
) > 0)
9975 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9976 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
9978 else if (CONSP (Vtool_bar_button_margin
))
9980 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
9981 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
9982 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
9984 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
9985 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
9986 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
9989 if (auto_raise_tool_bar_buttons_p
)
9991 /* Add a `:relief' property to the image spec if the item is
9995 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10002 /* If image is selected, display it pressed, i.e. with a
10003 negative relief. If it's not selected, display it with a
10005 plist
= Fplist_put (plist
, QCrelief
,
10007 ? make_number (-relief
)
10008 : make_number (relief
)));
10013 /* Put a margin around the image. */
10014 if (hmargin
|| vmargin
)
10016 if (hmargin
== vmargin
)
10017 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10019 plist
= Fplist_put (plist
, QCmargin
,
10020 Fcons (make_number (hmargin
),
10021 make_number (vmargin
)));
10024 /* If button is not enabled, and we don't have special images
10025 for the disabled state, make the image appear disabled by
10026 applying an appropriate algorithm to it. */
10027 if (!enabled_p
&& idx
< 0)
10028 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10030 /* Put a `display' text property on the string for the image to
10031 display. Put a `menu-item' property on the string that gives
10032 the start of this item's properties in the tool-bar items
10034 image
= Fcons (Qimage
, plist
);
10035 props
= list4 (Qdisplay
, image
,
10036 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10038 /* Let the last image hide all remaining spaces in the tool bar
10039 string. The string can be longer than needed when we reuse a
10040 previous string. */
10041 if (i
+ 1 == f
->n_tool_bar_items
)
10042 end
= SCHARS (f
->desired_tool_bar_string
);
10045 Fadd_text_properties (make_number (i
), make_number (end
),
10046 props
, f
->desired_tool_bar_string
);
10054 /* Display one line of the tool-bar of frame IT->f.
10056 HEIGHT specifies the desired height of the tool-bar line.
10057 If the actual height of the glyph row is less than HEIGHT, the
10058 row's height is increased to HEIGHT, and the icons are centered
10059 vertically in the new height.
10061 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10062 count a final empty row in case the tool-bar width exactly matches
10067 display_tool_bar_line (it
, height
)
10071 struct glyph_row
*row
= it
->glyph_row
;
10072 int max_x
= it
->last_visible_x
;
10073 struct glyph
*last
;
10075 prepare_desired_row (row
);
10076 row
->y
= it
->current_y
;
10078 /* Note that this isn't made use of if the face hasn't a box,
10079 so there's no need to check the face here. */
10080 it
->start_of_box_run_p
= 1;
10082 while (it
->current_x
< max_x
)
10084 int x
, n_glyphs_before
, i
, nglyphs
;
10085 struct it it_before
;
10087 /* Get the next display element. */
10088 if (!get_next_display_element (it
))
10090 /* Don't count empty row if we are counting needed tool-bar lines. */
10091 if (height
< 0 && !it
->hpos
)
10096 /* Produce glyphs. */
10097 n_glyphs_before
= row
->used
[TEXT_AREA
];
10100 PRODUCE_GLYPHS (it
);
10102 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10104 x
= it_before
.current_x
;
10105 while (i
< nglyphs
)
10107 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10109 if (x
+ glyph
->pixel_width
> max_x
)
10111 /* Glyph doesn't fit on line. Backtrack. */
10112 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10114 /* If this is the only glyph on this line, it will never fit on the
10115 toolbar, so skip it. But ensure there is at least one glyph,
10116 so we don't accidentally disable the tool-bar. */
10117 if (n_glyphs_before
== 0
10118 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10124 x
+= glyph
->pixel_width
;
10128 /* Stop at line ends. */
10129 if (ITERATOR_AT_END_OF_LINE_P (it
))
10132 set_iterator_to_next (it
, 1);
10137 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10139 /* Use default face for the border below the tool bar.
10141 FIXME: When auto-resize-tool-bars is grow-only, there is
10142 no additional border below the possibly empty tool-bar lines.
10143 So to make the extra empty lines look "normal", we have to
10144 use the tool-bar face for the border too. */
10145 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10146 it
->face_id
= DEFAULT_FACE_ID
;
10148 extend_face_to_end_of_line (it
);
10149 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10150 last
->right_box_line_p
= 1;
10151 if (last
== row
->glyphs
[TEXT_AREA
])
10152 last
->left_box_line_p
= 1;
10154 /* Make line the desired height and center it vertically. */
10155 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10157 /* Don't add more than one line height. */
10158 height
%= FRAME_LINE_HEIGHT (it
->f
);
10159 it
->max_ascent
+= height
/ 2;
10160 it
->max_descent
+= (height
+ 1) / 2;
10163 compute_line_metrics (it
);
10165 /* If line is empty, make it occupy the rest of the tool-bar. */
10166 if (!row
->displays_text_p
)
10168 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10169 row
->visible_height
= row
->height
;
10170 row
->ascent
= row
->phys_ascent
= 0;
10171 row
->extra_line_spacing
= 0;
10174 row
->full_width_p
= 1;
10175 row
->continued_p
= 0;
10176 row
->truncated_on_left_p
= 0;
10177 row
->truncated_on_right_p
= 0;
10179 it
->current_x
= it
->hpos
= 0;
10180 it
->current_y
+= row
->height
;
10186 /* Max tool-bar height. */
10188 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10189 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10191 /* Value is the number of screen lines needed to make all tool-bar
10192 items of frame F visible. The number of actual rows needed is
10193 returned in *N_ROWS if non-NULL. */
10196 tool_bar_lines_needed (f
, n_rows
)
10200 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10202 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10203 the desired matrix, so use (unused) mode-line row as temporary row to
10204 avoid destroying the first tool-bar row. */
10205 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10207 /* Initialize an iterator for iteration over
10208 F->desired_tool_bar_string in the tool-bar window of frame F. */
10209 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10210 it
.first_visible_x
= 0;
10211 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10212 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10214 while (!ITERATOR_AT_END_P (&it
))
10216 clear_glyph_row (temp_row
);
10217 it
.glyph_row
= temp_row
;
10218 display_tool_bar_line (&it
, -1);
10220 clear_glyph_row (temp_row
);
10222 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10224 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10226 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10230 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10232 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10241 frame
= selected_frame
;
10243 CHECK_FRAME (frame
);
10244 f
= XFRAME (frame
);
10246 if (WINDOWP (f
->tool_bar_window
)
10247 || (w
= XWINDOW (f
->tool_bar_window
),
10248 WINDOW_TOTAL_LINES (w
) > 0))
10250 update_tool_bar (f
, 1);
10251 if (f
->n_tool_bar_items
)
10253 build_desired_tool_bar_string (f
);
10254 nlines
= tool_bar_lines_needed (f
, NULL
);
10258 return make_number (nlines
);
10262 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10263 height should be changed. */
10266 redisplay_tool_bar (f
)
10271 struct glyph_row
*row
;
10273 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
10274 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10275 update_frame_tool_bar (f
);
10279 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10280 do anything. This means you must start with tool-bar-lines
10281 non-zero to get the auto-sizing effect. Or in other words, you
10282 can turn off tool-bars by specifying tool-bar-lines zero. */
10283 if (!WINDOWP (f
->tool_bar_window
)
10284 || (w
= XWINDOW (f
->tool_bar_window
),
10285 WINDOW_TOTAL_LINES (w
) == 0))
10288 /* Set up an iterator for the tool-bar window. */
10289 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10290 it
.first_visible_x
= 0;
10291 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10292 row
= it
.glyph_row
;
10294 /* Build a string that represents the contents of the tool-bar. */
10295 build_desired_tool_bar_string (f
);
10296 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10298 if (f
->n_tool_bar_rows
== 0)
10302 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10303 nlines
!= WINDOW_TOTAL_LINES (w
)))
10305 extern Lisp_Object Qtool_bar_lines
;
10307 int old_height
= WINDOW_TOTAL_LINES (w
);
10309 XSETFRAME (frame
, f
);
10310 Fmodify_frame_parameters (frame
,
10311 Fcons (Fcons (Qtool_bar_lines
,
10312 make_number (nlines
)),
10314 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10316 clear_glyph_matrix (w
->desired_matrix
);
10317 fonts_changed_p
= 1;
10323 /* Display as many lines as needed to display all tool-bar items. */
10325 if (f
->n_tool_bar_rows
> 0)
10327 int border
, rows
, height
, extra
;
10329 if (INTEGERP (Vtool_bar_border
))
10330 border
= XINT (Vtool_bar_border
);
10331 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10332 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10333 else if (EQ (Vtool_bar_border
, Qborder_width
))
10334 border
= f
->border_width
;
10340 rows
= f
->n_tool_bar_rows
;
10341 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10342 extra
= it
.last_visible_y
- border
- height
* rows
;
10344 while (it
.current_y
< it
.last_visible_y
)
10347 if (extra
> 0 && rows
-- > 0)
10349 h
= (extra
+ rows
- 1) / rows
;
10352 display_tool_bar_line (&it
, height
+ h
);
10357 while (it
.current_y
< it
.last_visible_y
)
10358 display_tool_bar_line (&it
, 0);
10361 /* It doesn't make much sense to try scrolling in the tool-bar
10362 window, so don't do it. */
10363 w
->desired_matrix
->no_scrolling_p
= 1;
10364 w
->must_be_updated_p
= 1;
10366 if (!NILP (Vauto_resize_tool_bars
))
10368 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10369 int change_height_p
= 0;
10371 /* If we couldn't display everything, change the tool-bar's
10372 height if there is room for more. */
10373 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10374 && it
.current_y
< max_tool_bar_height
)
10375 change_height_p
= 1;
10377 row
= it
.glyph_row
- 1;
10379 /* If there are blank lines at the end, except for a partially
10380 visible blank line at the end that is smaller than
10381 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10382 if (!row
->displays_text_p
10383 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10384 change_height_p
= 1;
10386 /* If row displays tool-bar items, but is partially visible,
10387 change the tool-bar's height. */
10388 if (row
->displays_text_p
10389 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10390 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10391 change_height_p
= 1;
10393 /* Resize windows as needed by changing the `tool-bar-lines'
10394 frame parameter. */
10395 if (change_height_p
)
10397 extern Lisp_Object Qtool_bar_lines
;
10399 int old_height
= WINDOW_TOTAL_LINES (w
);
10401 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10403 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10404 && !f
->minimize_tool_bar_window_p
)
10405 ? (nlines
> old_height
)
10406 : (nlines
!= old_height
));
10407 f
->minimize_tool_bar_window_p
= 0;
10409 if (change_height_p
)
10411 XSETFRAME (frame
, f
);
10412 Fmodify_frame_parameters (frame
,
10413 Fcons (Fcons (Qtool_bar_lines
,
10414 make_number (nlines
)),
10416 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10418 clear_glyph_matrix (w
->desired_matrix
);
10419 f
->n_tool_bar_rows
= nrows
;
10420 fonts_changed_p
= 1;
10427 f
->minimize_tool_bar_window_p
= 0;
10432 /* Get information about the tool-bar item which is displayed in GLYPH
10433 on frame F. Return in *PROP_IDX the index where tool-bar item
10434 properties start in F->tool_bar_items. Value is zero if
10435 GLYPH doesn't display a tool-bar item. */
10438 tool_bar_item_info (f
, glyph
, prop_idx
)
10440 struct glyph
*glyph
;
10447 /* This function can be called asynchronously, which means we must
10448 exclude any possibility that Fget_text_property signals an
10450 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10451 charpos
= max (0, charpos
);
10453 /* Get the text property `menu-item' at pos. The value of that
10454 property is the start index of this item's properties in
10455 F->tool_bar_items. */
10456 prop
= Fget_text_property (make_number (charpos
),
10457 Qmenu_item
, f
->current_tool_bar_string
);
10458 if (INTEGERP (prop
))
10460 *prop_idx
= XINT (prop
);
10470 /* Get information about the tool-bar item at position X/Y on frame F.
10471 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10472 the current matrix of the tool-bar window of F, or NULL if not
10473 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10474 item in F->tool_bar_items. Value is
10476 -1 if X/Y is not on a tool-bar item
10477 0 if X/Y is on the same item that was highlighted before.
10481 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10484 struct glyph
**glyph
;
10485 int *hpos
, *vpos
, *prop_idx
;
10487 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10488 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10491 /* Find the glyph under X/Y. */
10492 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10493 if (*glyph
== NULL
)
10496 /* Get the start of this tool-bar item's properties in
10497 f->tool_bar_items. */
10498 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10501 /* Is mouse on the highlighted item? */
10502 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10503 && *vpos
>= dpyinfo
->mouse_face_beg_row
10504 && *vpos
<= dpyinfo
->mouse_face_end_row
10505 && (*vpos
> dpyinfo
->mouse_face_beg_row
10506 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10507 && (*vpos
< dpyinfo
->mouse_face_end_row
10508 || *hpos
< dpyinfo
->mouse_face_end_col
10509 || dpyinfo
->mouse_face_past_end
))
10517 Handle mouse button event on the tool-bar of frame F, at
10518 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10519 0 for button release. MODIFIERS is event modifiers for button
10523 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10526 unsigned int modifiers
;
10528 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10529 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10530 int hpos
, vpos
, prop_idx
;
10531 struct glyph
*glyph
;
10532 Lisp_Object enabled_p
;
10534 /* If not on the highlighted tool-bar item, return. */
10535 frame_to_window_pixel_xy (w
, &x
, &y
);
10536 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10539 /* If item is disabled, do nothing. */
10540 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10541 if (NILP (enabled_p
))
10546 /* Show item in pressed state. */
10547 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10548 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10549 last_tool_bar_item
= prop_idx
;
10553 Lisp_Object key
, frame
;
10554 struct input_event event
;
10555 EVENT_INIT (event
);
10557 /* Show item in released state. */
10558 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10559 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10561 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10563 XSETFRAME (frame
, f
);
10564 event
.kind
= TOOL_BAR_EVENT
;
10565 event
.frame_or_window
= frame
;
10567 kbd_buffer_store_event (&event
);
10569 event
.kind
= TOOL_BAR_EVENT
;
10570 event
.frame_or_window
= frame
;
10572 event
.modifiers
= modifiers
;
10573 kbd_buffer_store_event (&event
);
10574 last_tool_bar_item
= -1;
10579 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10580 tool-bar window-relative coordinates X/Y. Called from
10581 note_mouse_highlight. */
10584 note_tool_bar_highlight (f
, x
, y
)
10588 Lisp_Object window
= f
->tool_bar_window
;
10589 struct window
*w
= XWINDOW (window
);
10590 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10592 struct glyph
*glyph
;
10593 struct glyph_row
*row
;
10595 Lisp_Object enabled_p
;
10597 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10598 int mouse_down_p
, rc
;
10600 /* Function note_mouse_highlight is called with negative x(y
10601 values when mouse moves outside of the frame. */
10602 if (x
<= 0 || y
<= 0)
10604 clear_mouse_face (dpyinfo
);
10608 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10611 /* Not on tool-bar item. */
10612 clear_mouse_face (dpyinfo
);
10616 /* On same tool-bar item as before. */
10617 goto set_help_echo
;
10619 clear_mouse_face (dpyinfo
);
10621 /* Mouse is down, but on different tool-bar item? */
10622 mouse_down_p
= (dpyinfo
->grabbed
10623 && f
== last_mouse_frame
10624 && FRAME_LIVE_P (f
));
10626 && last_tool_bar_item
!= prop_idx
)
10629 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10630 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10632 /* If tool-bar item is not enabled, don't highlight it. */
10633 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10634 if (!NILP (enabled_p
))
10636 /* Compute the x-position of the glyph. In front and past the
10637 image is a space. We include this in the highlighted area. */
10638 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10639 for (i
= x
= 0; i
< hpos
; ++i
)
10640 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10642 /* Record this as the current active region. */
10643 dpyinfo
->mouse_face_beg_col
= hpos
;
10644 dpyinfo
->mouse_face_beg_row
= vpos
;
10645 dpyinfo
->mouse_face_beg_x
= x
;
10646 dpyinfo
->mouse_face_beg_y
= row
->y
;
10647 dpyinfo
->mouse_face_past_end
= 0;
10649 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10650 dpyinfo
->mouse_face_end_row
= vpos
;
10651 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10652 dpyinfo
->mouse_face_end_y
= row
->y
;
10653 dpyinfo
->mouse_face_window
= window
;
10654 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10656 /* Display it as active. */
10657 show_mouse_face (dpyinfo
, draw
);
10658 dpyinfo
->mouse_face_image_state
= draw
;
10663 /* Set help_echo_string to a help string to display for this tool-bar item.
10664 XTread_socket does the rest. */
10665 help_echo_object
= help_echo_window
= Qnil
;
10666 help_echo_pos
= -1;
10667 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10668 if (NILP (help_echo_string
))
10669 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10672 #endif /* HAVE_WINDOW_SYSTEM */
10676 /************************************************************************
10677 Horizontal scrolling
10678 ************************************************************************/
10680 static int hscroll_window_tree
P_ ((Lisp_Object
));
10681 static int hscroll_windows
P_ ((Lisp_Object
));
10683 /* For all leaf windows in the window tree rooted at WINDOW, set their
10684 hscroll value so that PT is (i) visible in the window, and (ii) so
10685 that it is not within a certain margin at the window's left and
10686 right border. Value is non-zero if any window's hscroll has been
10690 hscroll_window_tree (window
)
10691 Lisp_Object window
;
10693 int hscrolled_p
= 0;
10694 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10695 int hscroll_step_abs
= 0;
10696 double hscroll_step_rel
= 0;
10698 if (hscroll_relative_p
)
10700 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10701 if (hscroll_step_rel
< 0)
10703 hscroll_relative_p
= 0;
10704 hscroll_step_abs
= 0;
10707 else if (INTEGERP (Vhscroll_step
))
10709 hscroll_step_abs
= XINT (Vhscroll_step
);
10710 if (hscroll_step_abs
< 0)
10711 hscroll_step_abs
= 0;
10714 hscroll_step_abs
= 0;
10716 while (WINDOWP (window
))
10718 struct window
*w
= XWINDOW (window
);
10720 if (WINDOWP (w
->hchild
))
10721 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10722 else if (WINDOWP (w
->vchild
))
10723 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10724 else if (w
->cursor
.vpos
>= 0)
10727 int text_area_width
;
10728 struct glyph_row
*current_cursor_row
10729 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10730 struct glyph_row
*desired_cursor_row
10731 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10732 struct glyph_row
*cursor_row
10733 = (desired_cursor_row
->enabled_p
10734 ? desired_cursor_row
10735 : current_cursor_row
);
10737 text_area_width
= window_box_width (w
, TEXT_AREA
);
10739 /* Scroll when cursor is inside this scroll margin. */
10740 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10742 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10743 && ((XFASTINT (w
->hscroll
)
10744 && w
->cursor
.x
<= h_margin
)
10745 || (cursor_row
->enabled_p
10746 && cursor_row
->truncated_on_right_p
10747 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10751 struct buffer
*saved_current_buffer
;
10755 /* Find point in a display of infinite width. */
10756 saved_current_buffer
= current_buffer
;
10757 current_buffer
= XBUFFER (w
->buffer
);
10759 if (w
== XWINDOW (selected_window
))
10760 pt
= BUF_PT (current_buffer
);
10763 pt
= marker_position (w
->pointm
);
10764 pt
= max (BEGV
, pt
);
10768 /* Move iterator to pt starting at cursor_row->start in
10769 a line with infinite width. */
10770 init_to_row_start (&it
, w
, cursor_row
);
10771 it
.last_visible_x
= INFINITY
;
10772 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10773 current_buffer
= saved_current_buffer
;
10775 /* Position cursor in window. */
10776 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10777 hscroll
= max (0, (it
.current_x
10778 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10779 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10780 : (text_area_width
/ 2))))
10781 / FRAME_COLUMN_WIDTH (it
.f
);
10782 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10784 if (hscroll_relative_p
)
10785 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10788 wanted_x
= text_area_width
10789 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10792 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10796 if (hscroll_relative_p
)
10797 wanted_x
= text_area_width
* hscroll_step_rel
10800 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10803 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10805 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10807 /* Don't call Fset_window_hscroll if value hasn't
10808 changed because it will prevent redisplay
10810 if (XFASTINT (w
->hscroll
) != hscroll
)
10812 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10813 w
->hscroll
= make_number (hscroll
);
10822 /* Value is non-zero if hscroll of any leaf window has been changed. */
10823 return hscrolled_p
;
10827 /* Set hscroll so that cursor is visible and not inside horizontal
10828 scroll margins for all windows in the tree rooted at WINDOW. See
10829 also hscroll_window_tree above. Value is non-zero if any window's
10830 hscroll has been changed. If it has, desired matrices on the frame
10831 of WINDOW are cleared. */
10834 hscroll_windows (window
)
10835 Lisp_Object window
;
10837 int hscrolled_p
= hscroll_window_tree (window
);
10839 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10840 return hscrolled_p
;
10845 /************************************************************************
10847 ************************************************************************/
10849 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10850 to a non-zero value. This is sometimes handy to have in a debugger
10855 /* First and last unchanged row for try_window_id. */
10857 int debug_first_unchanged_at_end_vpos
;
10858 int debug_last_unchanged_at_beg_vpos
;
10860 /* Delta vpos and y. */
10862 int debug_dvpos
, debug_dy
;
10864 /* Delta in characters and bytes for try_window_id. */
10866 int debug_delta
, debug_delta_bytes
;
10868 /* Values of window_end_pos and window_end_vpos at the end of
10871 EMACS_INT debug_end_pos
, debug_end_vpos
;
10873 /* Append a string to W->desired_matrix->method. FMT is a printf
10874 format string. A1...A9 are a supplement for a variable-length
10875 argument list. If trace_redisplay_p is non-zero also printf the
10876 resulting string to stderr. */
10879 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10882 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10885 char *method
= w
->desired_matrix
->method
;
10886 int len
= strlen (method
);
10887 int size
= sizeof w
->desired_matrix
->method
;
10888 int remaining
= size
- len
- 1;
10890 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10891 if (len
&& remaining
)
10894 --remaining
, ++len
;
10897 strncpy (method
+ len
, buffer
, remaining
);
10899 if (trace_redisplay_p
)
10900 fprintf (stderr
, "%p (%s): %s\n",
10902 ((BUFFERP (w
->buffer
)
10903 && STRINGP (XBUFFER (w
->buffer
)->name
))
10904 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10909 #endif /* GLYPH_DEBUG */
10912 /* Value is non-zero if all changes in window W, which displays
10913 current_buffer, are in the text between START and END. START is a
10914 buffer position, END is given as a distance from Z. Used in
10915 redisplay_internal for display optimization. */
10918 text_outside_line_unchanged_p (w
, start
, end
)
10922 int unchanged_p
= 1;
10924 /* If text or overlays have changed, see where. */
10925 if (XFASTINT (w
->last_modified
) < MODIFF
10926 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10928 /* Gap in the line? */
10929 if (GPT
< start
|| Z
- GPT
< end
)
10932 /* Changes start in front of the line, or end after it? */
10934 && (BEG_UNCHANGED
< start
- 1
10935 || END_UNCHANGED
< end
))
10938 /* If selective display, can't optimize if changes start at the
10939 beginning of the line. */
10941 && INTEGERP (current_buffer
->selective_display
)
10942 && XINT (current_buffer
->selective_display
) > 0
10943 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10946 /* If there are overlays at the start or end of the line, these
10947 may have overlay strings with newlines in them. A change at
10948 START, for instance, may actually concern the display of such
10949 overlay strings as well, and they are displayed on different
10950 lines. So, quickly rule out this case. (For the future, it
10951 might be desirable to implement something more telling than
10952 just BEG/END_UNCHANGED.) */
10955 if (BEG
+ BEG_UNCHANGED
== start
10956 && overlay_touches_p (start
))
10958 if (END_UNCHANGED
== end
10959 && overlay_touches_p (Z
- end
))
10964 return unchanged_p
;
10968 /* Do a frame update, taking possible shortcuts into account. This is
10969 the main external entry point for redisplay.
10971 If the last redisplay displayed an echo area message and that message
10972 is no longer requested, we clear the echo area or bring back the
10973 mini-buffer if that is in use. */
10978 redisplay_internal (0);
10983 overlay_arrow_string_or_property (var
)
10988 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
10991 return Voverlay_arrow_string
;
10994 /* Return 1 if there are any overlay-arrows in current_buffer. */
10996 overlay_arrow_in_current_buffer_p ()
11000 for (vlist
= Voverlay_arrow_variable_list
;
11002 vlist
= XCDR (vlist
))
11004 Lisp_Object var
= XCAR (vlist
);
11007 if (!SYMBOLP (var
))
11009 val
= find_symbol_value (var
);
11011 && current_buffer
== XMARKER (val
)->buffer
)
11018 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11022 overlay_arrows_changed_p ()
11026 for (vlist
= Voverlay_arrow_variable_list
;
11028 vlist
= XCDR (vlist
))
11030 Lisp_Object var
= XCAR (vlist
);
11031 Lisp_Object val
, pstr
;
11033 if (!SYMBOLP (var
))
11035 val
= find_symbol_value (var
);
11036 if (!MARKERP (val
))
11038 if (! EQ (COERCE_MARKER (val
),
11039 Fget (var
, Qlast_arrow_position
))
11040 || ! (pstr
= overlay_arrow_string_or_property (var
),
11041 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11047 /* Mark overlay arrows to be updated on next redisplay. */
11050 update_overlay_arrows (up_to_date
)
11055 for (vlist
= Voverlay_arrow_variable_list
;
11057 vlist
= XCDR (vlist
))
11059 Lisp_Object var
= XCAR (vlist
);
11061 if (!SYMBOLP (var
))
11064 if (up_to_date
> 0)
11066 Lisp_Object val
= find_symbol_value (var
);
11067 Fput (var
, Qlast_arrow_position
,
11068 COERCE_MARKER (val
));
11069 Fput (var
, Qlast_arrow_string
,
11070 overlay_arrow_string_or_property (var
));
11072 else if (up_to_date
< 0
11073 || !NILP (Fget (var
, Qlast_arrow_position
)))
11075 Fput (var
, Qlast_arrow_position
, Qt
);
11076 Fput (var
, Qlast_arrow_string
, Qt
);
11082 /* Return overlay arrow string to display at row.
11083 Return integer (bitmap number) for arrow bitmap in left fringe.
11084 Return nil if no overlay arrow. */
11087 overlay_arrow_at_row (it
, row
)
11089 struct glyph_row
*row
;
11093 for (vlist
= Voverlay_arrow_variable_list
;
11095 vlist
= XCDR (vlist
))
11097 Lisp_Object var
= XCAR (vlist
);
11100 if (!SYMBOLP (var
))
11103 val
= find_symbol_value (var
);
11106 && current_buffer
== XMARKER (val
)->buffer
11107 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11109 if (FRAME_WINDOW_P (it
->f
)
11110 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11112 #ifdef HAVE_WINDOW_SYSTEM
11113 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11116 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11117 return make_number (fringe_bitmap
);
11120 return make_number (-1); /* Use default arrow bitmap */
11122 return overlay_arrow_string_or_property (var
);
11129 /* Return 1 if point moved out of or into a composition. Otherwise
11130 return 0. PREV_BUF and PREV_PT are the last point buffer and
11131 position. BUF and PT are the current point buffer and position. */
11134 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11135 struct buffer
*prev_buf
, *buf
;
11138 EMACS_INT start
, end
;
11140 Lisp_Object buffer
;
11142 XSETBUFFER (buffer
, buf
);
11143 /* Check a composition at the last point if point moved within the
11145 if (prev_buf
== buf
)
11148 /* Point didn't move. */
11151 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11152 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11153 && COMPOSITION_VALID_P (start
, end
, prop
)
11154 && start
< prev_pt
&& end
> prev_pt
)
11155 /* The last point was within the composition. Return 1 iff
11156 point moved out of the composition. */
11157 return (pt
<= start
|| pt
>= end
);
11160 /* Check a composition at the current point. */
11161 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11162 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11163 && COMPOSITION_VALID_P (start
, end
, prop
)
11164 && start
< pt
&& end
> pt
);
11168 /* Reconsider the setting of B->clip_changed which is displayed
11172 reconsider_clip_changes (w
, b
)
11176 if (b
->clip_changed
11177 && !NILP (w
->window_end_valid
)
11178 && w
->current_matrix
->buffer
== b
11179 && w
->current_matrix
->zv
== BUF_ZV (b
)
11180 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11181 b
->clip_changed
= 0;
11183 /* If display wasn't paused, and W is not a tool bar window, see if
11184 point has been moved into or out of a composition. In that case,
11185 we set b->clip_changed to 1 to force updating the screen. If
11186 b->clip_changed has already been set to 1, we can skip this
11188 if (!b
->clip_changed
11189 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11193 if (w
== XWINDOW (selected_window
))
11194 pt
= BUF_PT (current_buffer
);
11196 pt
= marker_position (w
->pointm
);
11198 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11199 || pt
!= XINT (w
->last_point
))
11200 && check_point_in_composition (w
->current_matrix
->buffer
,
11201 XINT (w
->last_point
),
11202 XBUFFER (w
->buffer
), pt
))
11203 b
->clip_changed
= 1;
11208 /* Select FRAME to forward the values of frame-local variables into C
11209 variables so that the redisplay routines can access those values
11213 select_frame_for_redisplay (frame
)
11216 Lisp_Object tail
, symbol
, val
;
11217 Lisp_Object old
= selected_frame
;
11218 struct Lisp_Symbol
*sym
;
11220 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11222 selected_frame
= frame
;
11226 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11227 if (CONSP (XCAR (tail
))
11228 && (symbol
= XCAR (XCAR (tail
)),
11230 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11232 (BUFFER_LOCAL_VALUEP (val
)))
11233 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11234 /* Use find_symbol_value rather than Fsymbol_value
11235 to avoid an error if it is void. */
11236 find_symbol_value (symbol
);
11237 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11241 #define STOP_POLLING \
11242 do { if (! polling_stopped_here) stop_polling (); \
11243 polling_stopped_here = 1; } while (0)
11245 #define RESUME_POLLING \
11246 do { if (polling_stopped_here) start_polling (); \
11247 polling_stopped_here = 0; } while (0)
11250 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11251 response to any user action; therefore, we should preserve the echo
11252 area. (Actually, our caller does that job.) Perhaps in the future
11253 avoid recentering windows if it is not necessary; currently that
11254 causes some problems. */
11257 redisplay_internal (preserve_echo_area
)
11258 int preserve_echo_area
;
11260 struct window
*w
= XWINDOW (selected_window
);
11263 int must_finish
= 0;
11264 struct text_pos tlbufpos
, tlendpos
;
11265 int number_of_visible_frames
;
11268 int polling_stopped_here
= 0;
11269 Lisp_Object old_frame
= selected_frame
;
11271 /* Non-zero means redisplay has to consider all windows on all
11272 frames. Zero means, only selected_window is considered. */
11273 int consider_all_windows_p
;
11275 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11277 /* No redisplay if running in batch mode or frame is not yet fully
11278 initialized, or redisplay is explicitly turned off by setting
11279 Vinhibit_redisplay. */
11281 || !NILP (Vinhibit_redisplay
))
11284 /* Don't examine these until after testing Vinhibit_redisplay.
11285 When Emacs is shutting down, perhaps because its connection to
11286 X has dropped, we should not look at them at all. */
11287 f
= XFRAME (w
->frame
);
11288 sf
= SELECTED_FRAME ();
11290 if (!f
->glyphs_initialized_p
)
11293 /* The flag redisplay_performed_directly_p is set by
11294 direct_output_for_insert when it already did the whole screen
11295 update necessary. */
11296 if (redisplay_performed_directly_p
)
11298 redisplay_performed_directly_p
= 0;
11299 if (!hscroll_windows (selected_window
))
11303 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11304 if (popup_activated ())
11308 /* I don't think this happens but let's be paranoid. */
11309 if (redisplaying_p
)
11312 /* Record a function that resets redisplaying_p to its old value
11313 when we leave this function. */
11314 count
= SPECPDL_INDEX ();
11315 record_unwind_protect (unwind_redisplay
,
11316 Fcons (make_number (redisplaying_p
), selected_frame
));
11318 specbind (Qinhibit_free_realized_faces
, Qnil
);
11321 Lisp_Object tail
, frame
;
11323 FOR_EACH_FRAME (tail
, frame
)
11325 struct frame
*f
= XFRAME (frame
);
11326 f
->already_hscrolled_p
= 0;
11331 if (!EQ (old_frame
, selected_frame
)
11332 && FRAME_LIVE_P (XFRAME (old_frame
)))
11333 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11334 selected_frame and selected_window to be temporarily out-of-sync so
11335 when we come back here via `goto retry', we need to resync because we
11336 may need to run Elisp code (via prepare_menu_bars). */
11337 select_frame_for_redisplay (old_frame
);
11340 reconsider_clip_changes (w
, current_buffer
);
11341 last_escape_glyph_frame
= NULL
;
11342 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11344 /* If new fonts have been loaded that make a glyph matrix adjustment
11345 necessary, do it. */
11346 if (fonts_changed_p
)
11348 adjust_glyphs (NULL
);
11349 ++windows_or_buffers_changed
;
11350 fonts_changed_p
= 0;
11353 /* If face_change_count is non-zero, init_iterator will free all
11354 realized faces, which includes the faces referenced from current
11355 matrices. So, we can't reuse current matrices in this case. */
11356 if (face_change_count
)
11357 ++windows_or_buffers_changed
;
11359 if (FRAME_TERMCAP_P (sf
)
11360 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11362 /* Since frames on a single ASCII terminal share the same
11363 display area, displaying a different frame means redisplay
11364 the whole thing. */
11365 windows_or_buffers_changed
++;
11366 SET_FRAME_GARBAGED (sf
);
11368 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11370 FRAME_TTY (sf
)->previous_frame
= sf
;
11373 /* Set the visible flags for all frames. Do this before checking
11374 for resized or garbaged frames; they want to know if their frames
11375 are visible. See the comment in frame.h for
11376 FRAME_SAMPLE_VISIBILITY. */
11378 Lisp_Object tail
, frame
;
11380 number_of_visible_frames
= 0;
11382 FOR_EACH_FRAME (tail
, frame
)
11384 struct frame
*f
= XFRAME (frame
);
11386 FRAME_SAMPLE_VISIBILITY (f
);
11387 if (FRAME_VISIBLE_P (f
))
11388 ++number_of_visible_frames
;
11389 clear_desired_matrices (f
);
11394 /* Notice any pending interrupt request to change frame size. */
11395 do_pending_window_change (1);
11397 /* Clear frames marked as garbaged. */
11398 if (frame_garbaged
)
11399 clear_garbaged_frames ();
11401 /* Build menubar and tool-bar items. */
11402 if (NILP (Vmemory_full
))
11403 prepare_menu_bars ();
11405 if (windows_or_buffers_changed
)
11406 update_mode_lines
++;
11408 /* Detect case that we need to write or remove a star in the mode line. */
11409 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11411 w
->update_mode_line
= Qt
;
11412 if (buffer_shared
> 1)
11413 update_mode_lines
++;
11416 /* Avoid invocation of point motion hooks by `current_column' below. */
11417 count1
= SPECPDL_INDEX ();
11418 specbind (Qinhibit_point_motion_hooks
, Qt
);
11420 /* If %c is in the mode line, update it if needed. */
11421 if (!NILP (w
->column_number_displayed
)
11422 /* This alternative quickly identifies a common case
11423 where no change is needed. */
11424 && !(PT
== XFASTINT (w
->last_point
)
11425 && XFASTINT (w
->last_modified
) >= MODIFF
11426 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11427 && (XFASTINT (w
->column_number_displayed
)
11428 != (int) current_column ())) /* iftc */
11429 w
->update_mode_line
= Qt
;
11431 unbind_to (count1
, Qnil
);
11433 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11435 /* The variable buffer_shared is set in redisplay_window and
11436 indicates that we redisplay a buffer in different windows. See
11438 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11439 || cursor_type_changed
);
11441 /* If specs for an arrow have changed, do thorough redisplay
11442 to ensure we remove any arrow that should no longer exist. */
11443 if (overlay_arrows_changed_p ())
11444 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11446 /* Normally the message* functions will have already displayed and
11447 updated the echo area, but the frame may have been trashed, or
11448 the update may have been preempted, so display the echo area
11449 again here. Checking message_cleared_p captures the case that
11450 the echo area should be cleared. */
11451 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11452 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11453 || (message_cleared_p
11454 && minibuf_level
== 0
11455 /* If the mini-window is currently selected, this means the
11456 echo-area doesn't show through. */
11457 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11459 int window_height_changed_p
= echo_area_display (0);
11462 /* If we don't display the current message, don't clear the
11463 message_cleared_p flag, because, if we did, we wouldn't clear
11464 the echo area in the next redisplay which doesn't preserve
11466 if (!display_last_displayed_message_p
)
11467 message_cleared_p
= 0;
11469 if (fonts_changed_p
)
11471 else if (window_height_changed_p
)
11473 consider_all_windows_p
= 1;
11474 ++update_mode_lines
;
11475 ++windows_or_buffers_changed
;
11477 /* If window configuration was changed, frames may have been
11478 marked garbaged. Clear them or we will experience
11479 surprises wrt scrolling. */
11480 if (frame_garbaged
)
11481 clear_garbaged_frames ();
11484 else if (EQ (selected_window
, minibuf_window
)
11485 && (current_buffer
->clip_changed
11486 || XFASTINT (w
->last_modified
) < MODIFF
11487 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11488 && resize_mini_window (w
, 0))
11490 /* Resized active mini-window to fit the size of what it is
11491 showing if its contents might have changed. */
11493 /* FIXME: this causes all frames to be updated, which seems unnecessary
11494 since only the current frame needs to be considered. This function needs
11495 to be rewritten with two variables, consider_all_windows and
11496 consider_all_frames. */
11497 consider_all_windows_p
= 1;
11498 ++windows_or_buffers_changed
;
11499 ++update_mode_lines
;
11501 /* If window configuration was changed, frames may have been
11502 marked garbaged. Clear them or we will experience
11503 surprises wrt scrolling. */
11504 if (frame_garbaged
)
11505 clear_garbaged_frames ();
11509 /* If showing the region, and mark has changed, we must redisplay
11510 the whole window. The assignment to this_line_start_pos prevents
11511 the optimization directly below this if-statement. */
11512 if (((!NILP (Vtransient_mark_mode
)
11513 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11514 != !NILP (w
->region_showing
))
11515 || (!NILP (w
->region_showing
)
11516 && !EQ (w
->region_showing
,
11517 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11518 CHARPOS (this_line_start_pos
) = 0;
11520 /* Optimize the case that only the line containing the cursor in the
11521 selected window has changed. Variables starting with this_ are
11522 set in display_line and record information about the line
11523 containing the cursor. */
11524 tlbufpos
= this_line_start_pos
;
11525 tlendpos
= this_line_end_pos
;
11526 if (!consider_all_windows_p
11527 && CHARPOS (tlbufpos
) > 0
11528 && NILP (w
->update_mode_line
)
11529 && !current_buffer
->clip_changed
11530 && !current_buffer
->prevent_redisplay_optimizations_p
11531 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11532 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11533 /* Make sure recorded data applies to current buffer, etc. */
11534 && this_line_buffer
== current_buffer
11535 && current_buffer
== XBUFFER (w
->buffer
)
11536 && NILP (w
->force_start
)
11537 && NILP (w
->optional_new_start
)
11538 /* Point must be on the line that we have info recorded about. */
11539 && PT
>= CHARPOS (tlbufpos
)
11540 && PT
<= Z
- CHARPOS (tlendpos
)
11541 /* All text outside that line, including its final newline,
11542 must be unchanged */
11543 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11544 CHARPOS (tlendpos
)))
11546 if (CHARPOS (tlbufpos
) > BEGV
11547 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11548 && (CHARPOS (tlbufpos
) == ZV
11549 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11550 /* Former continuation line has disappeared by becoming empty */
11552 else if (XFASTINT (w
->last_modified
) < MODIFF
11553 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11554 || MINI_WINDOW_P (w
))
11556 /* We have to handle the case of continuation around a
11557 wide-column character (See the comment in indent.c around
11560 For instance, in the following case:
11562 -------- Insert --------
11563 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11564 J_I_ ==> J_I_ `^^' are cursors.
11568 As we have to redraw the line above, we should goto cancel. */
11571 int line_height_before
= this_line_pixel_height
;
11573 /* Note that start_display will handle the case that the
11574 line starting at tlbufpos is a continuation lines. */
11575 start_display (&it
, w
, tlbufpos
);
11577 /* Implementation note: It this still necessary? */
11578 if (it
.current_x
!= this_line_start_x
)
11581 TRACE ((stderr
, "trying display optimization 1\n"));
11582 w
->cursor
.vpos
= -1;
11583 overlay_arrow_seen
= 0;
11584 it
.vpos
= this_line_vpos
;
11585 it
.current_y
= this_line_y
;
11586 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11587 display_line (&it
);
11589 /* If line contains point, is not continued,
11590 and ends at same distance from eob as before, we win */
11591 if (w
->cursor
.vpos
>= 0
11592 /* Line is not continued, otherwise this_line_start_pos
11593 would have been set to 0 in display_line. */
11594 && CHARPOS (this_line_start_pos
)
11595 /* Line ends as before. */
11596 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11597 /* Line has same height as before. Otherwise other lines
11598 would have to be shifted up or down. */
11599 && this_line_pixel_height
== line_height_before
)
11601 /* If this is not the window's last line, we must adjust
11602 the charstarts of the lines below. */
11603 if (it
.current_y
< it
.last_visible_y
)
11605 struct glyph_row
*row
11606 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11607 int delta
, delta_bytes
;
11609 if (Z
- CHARPOS (tlendpos
) == ZV
)
11611 /* This line ends at end of (accessible part of)
11612 buffer. There is no newline to count. */
11614 - CHARPOS (tlendpos
)
11615 - MATRIX_ROW_START_CHARPOS (row
));
11616 delta_bytes
= (Z_BYTE
11617 - BYTEPOS (tlendpos
)
11618 - MATRIX_ROW_START_BYTEPOS (row
));
11622 /* This line ends in a newline. Must take
11623 account of the newline and the rest of the
11624 text that follows. */
11626 - CHARPOS (tlendpos
)
11627 - MATRIX_ROW_START_CHARPOS (row
));
11628 delta_bytes
= (Z_BYTE
11629 - BYTEPOS (tlendpos
)
11630 - MATRIX_ROW_START_BYTEPOS (row
));
11633 increment_matrix_positions (w
->current_matrix
,
11634 this_line_vpos
+ 1,
11635 w
->current_matrix
->nrows
,
11636 delta
, delta_bytes
);
11639 /* If this row displays text now but previously didn't,
11640 or vice versa, w->window_end_vpos may have to be
11642 if ((it
.glyph_row
- 1)->displays_text_p
)
11644 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11645 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11647 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11648 && this_line_vpos
> 0)
11649 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11650 w
->window_end_valid
= Qnil
;
11652 /* Update hint: No need to try to scroll in update_window. */
11653 w
->desired_matrix
->no_scrolling_p
= 1;
11656 *w
->desired_matrix
->method
= 0;
11657 debug_method_add (w
, "optimization 1");
11659 #ifdef HAVE_WINDOW_SYSTEM
11660 update_window_fringes (w
, 0);
11667 else if (/* Cursor position hasn't changed. */
11668 PT
== XFASTINT (w
->last_point
)
11669 /* Make sure the cursor was last displayed
11670 in this window. Otherwise we have to reposition it. */
11671 && 0 <= w
->cursor
.vpos
11672 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11676 do_pending_window_change (1);
11678 /* We used to always goto end_of_redisplay here, but this
11679 isn't enough if we have a blinking cursor. */
11680 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11681 goto end_of_redisplay
;
11685 /* If highlighting the region, or if the cursor is in the echo area,
11686 then we can't just move the cursor. */
11687 else if (! (!NILP (Vtransient_mark_mode
)
11688 && !NILP (current_buffer
->mark_active
))
11689 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11690 || highlight_nonselected_windows
)
11691 && NILP (w
->region_showing
)
11692 && NILP (Vshow_trailing_whitespace
)
11693 && !cursor_in_echo_area
)
11696 struct glyph_row
*row
;
11698 /* Skip from tlbufpos to PT and see where it is. Note that
11699 PT may be in invisible text. If so, we will end at the
11700 next visible position. */
11701 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11702 NULL
, DEFAULT_FACE_ID
);
11703 it
.current_x
= this_line_start_x
;
11704 it
.current_y
= this_line_y
;
11705 it
.vpos
= this_line_vpos
;
11707 /* The call to move_it_to stops in front of PT, but
11708 moves over before-strings. */
11709 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11711 if (it
.vpos
== this_line_vpos
11712 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11715 xassert (this_line_vpos
== it
.vpos
);
11716 xassert (this_line_y
== it
.current_y
);
11717 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11719 *w
->desired_matrix
->method
= 0;
11720 debug_method_add (w
, "optimization 3");
11729 /* Text changed drastically or point moved off of line. */
11730 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11733 CHARPOS (this_line_start_pos
) = 0;
11734 consider_all_windows_p
|= buffer_shared
> 1;
11735 ++clear_face_cache_count
;
11736 #ifdef HAVE_WINDOW_SYSTEM
11737 ++clear_image_cache_count
;
11740 /* Build desired matrices, and update the display. If
11741 consider_all_windows_p is non-zero, do it for all windows on all
11742 frames. Otherwise do it for selected_window, only. */
11744 if (consider_all_windows_p
)
11746 Lisp_Object tail
, frame
;
11748 FOR_EACH_FRAME (tail
, frame
)
11749 XFRAME (frame
)->updated_p
= 0;
11751 /* Recompute # windows showing selected buffer. This will be
11752 incremented each time such a window is displayed. */
11755 FOR_EACH_FRAME (tail
, frame
)
11757 struct frame
*f
= XFRAME (frame
);
11759 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11761 if (! EQ (frame
, selected_frame
))
11762 /* Select the frame, for the sake of frame-local
11764 select_frame_for_redisplay (frame
);
11766 /* Mark all the scroll bars to be removed; we'll redeem
11767 the ones we want when we redisplay their windows. */
11768 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11769 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11771 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11772 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11774 /* Any scroll bars which redisplay_windows should have
11775 nuked should now go away. */
11776 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11777 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11779 /* If fonts changed, display again. */
11780 /* ??? rms: I suspect it is a mistake to jump all the way
11781 back to retry here. It should just retry this frame. */
11782 if (fonts_changed_p
)
11785 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11787 /* See if we have to hscroll. */
11788 if (!f
->already_hscrolled_p
)
11790 f
->already_hscrolled_p
= 1;
11791 if (hscroll_windows (f
->root_window
))
11795 /* Prevent various kinds of signals during display
11796 update. stdio is not robust about handling
11797 signals, which can cause an apparent I/O
11799 if (interrupt_input
)
11800 unrequest_sigio ();
11803 /* Update the display. */
11804 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11805 pause
|= update_frame (f
, 0, 0);
11811 if (!EQ (old_frame
, selected_frame
)
11812 && FRAME_LIVE_P (XFRAME (old_frame
)))
11813 /* We played a bit fast-and-loose above and allowed selected_frame
11814 and selected_window to be temporarily out-of-sync but let's make
11815 sure this stays contained. */
11816 select_frame_for_redisplay (old_frame
);
11817 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11821 /* Do the mark_window_display_accurate after all windows have
11822 been redisplayed because this call resets flags in buffers
11823 which are needed for proper redisplay. */
11824 FOR_EACH_FRAME (tail
, frame
)
11826 struct frame
*f
= XFRAME (frame
);
11829 mark_window_display_accurate (f
->root_window
, 1);
11830 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11831 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11836 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11838 Lisp_Object mini_window
;
11839 struct frame
*mini_frame
;
11841 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11842 /* Use list_of_error, not Qerror, so that
11843 we catch only errors and don't run the debugger. */
11844 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11846 redisplay_window_error
);
11848 /* Compare desired and current matrices, perform output. */
11851 /* If fonts changed, display again. */
11852 if (fonts_changed_p
)
11855 /* Prevent various kinds of signals during display update.
11856 stdio is not robust about handling signals,
11857 which can cause an apparent I/O error. */
11858 if (interrupt_input
)
11859 unrequest_sigio ();
11862 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11864 if (hscroll_windows (selected_window
))
11867 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11868 pause
= update_frame (sf
, 0, 0);
11871 /* We may have called echo_area_display at the top of this
11872 function. If the echo area is on another frame, that may
11873 have put text on a frame other than the selected one, so the
11874 above call to update_frame would not have caught it. Catch
11876 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11877 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11879 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11881 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11882 pause
|= update_frame (mini_frame
, 0, 0);
11883 if (!pause
&& hscroll_windows (mini_window
))
11888 /* If display was paused because of pending input, make sure we do a
11889 thorough update the next time. */
11892 /* Prevent the optimization at the beginning of
11893 redisplay_internal that tries a single-line update of the
11894 line containing the cursor in the selected window. */
11895 CHARPOS (this_line_start_pos
) = 0;
11897 /* Let the overlay arrow be updated the next time. */
11898 update_overlay_arrows (0);
11900 /* If we pause after scrolling, some rows in the current
11901 matrices of some windows are not valid. */
11902 if (!WINDOW_FULL_WIDTH_P (w
)
11903 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11904 update_mode_lines
= 1;
11908 if (!consider_all_windows_p
)
11910 /* This has already been done above if
11911 consider_all_windows_p is set. */
11912 mark_window_display_accurate_1 (w
, 1);
11914 /* Say overlay arrows are up to date. */
11915 update_overlay_arrows (1);
11917 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11918 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11921 update_mode_lines
= 0;
11922 windows_or_buffers_changed
= 0;
11923 cursor_type_changed
= 0;
11926 /* Start SIGIO interrupts coming again. Having them off during the
11927 code above makes it less likely one will discard output, but not
11928 impossible, since there might be stuff in the system buffer here.
11929 But it is much hairier to try to do anything about that. */
11930 if (interrupt_input
)
11934 /* If a frame has become visible which was not before, redisplay
11935 again, so that we display it. Expose events for such a frame
11936 (which it gets when becoming visible) don't call the parts of
11937 redisplay constructing glyphs, so simply exposing a frame won't
11938 display anything in this case. So, we have to display these
11939 frames here explicitly. */
11942 Lisp_Object tail
, frame
;
11945 FOR_EACH_FRAME (tail
, frame
)
11947 int this_is_visible
= 0;
11949 if (XFRAME (frame
)->visible
)
11950 this_is_visible
= 1;
11951 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11952 if (XFRAME (frame
)->visible
)
11953 this_is_visible
= 1;
11955 if (this_is_visible
)
11959 if (new_count
!= number_of_visible_frames
)
11960 windows_or_buffers_changed
++;
11963 /* Change frame size now if a change is pending. */
11964 do_pending_window_change (1);
11966 /* If we just did a pending size change, or have additional
11967 visible frames, redisplay again. */
11968 if (windows_or_buffers_changed
&& !pause
)
11971 /* Clear the face cache eventually. */
11972 if (consider_all_windows_p
)
11974 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11976 clear_face_cache (0);
11977 clear_face_cache_count
= 0;
11979 #ifdef HAVE_WINDOW_SYSTEM
11980 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
11982 clear_image_caches (Qnil
);
11983 clear_image_cache_count
= 0;
11985 #endif /* HAVE_WINDOW_SYSTEM */
11989 unbind_to (count
, Qnil
);
11994 /* Redisplay, but leave alone any recent echo area message unless
11995 another message has been requested in its place.
11997 This is useful in situations where you need to redisplay but no
11998 user action has occurred, making it inappropriate for the message
11999 area to be cleared. See tracking_off and
12000 wait_reading_process_output for examples of these situations.
12002 FROM_WHERE is an integer saying from where this function was
12003 called. This is useful for debugging. */
12006 redisplay_preserve_echo_area (from_where
)
12009 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12011 if (!NILP (echo_area_buffer
[1]))
12013 /* We have a previously displayed message, but no current
12014 message. Redisplay the previous message. */
12015 display_last_displayed_message_p
= 1;
12016 redisplay_internal (1);
12017 display_last_displayed_message_p
= 0;
12020 redisplay_internal (1);
12022 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12023 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12024 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12028 /* Function registered with record_unwind_protect in
12029 redisplay_internal. Reset redisplaying_p to the value it had
12030 before redisplay_internal was called, and clear
12031 prevent_freeing_realized_faces_p. It also selects the previously
12032 selected frame, unless it has been deleted (by an X connection
12033 failure during redisplay, for example). */
12036 unwind_redisplay (val
)
12039 Lisp_Object old_redisplaying_p
, old_frame
;
12041 old_redisplaying_p
= XCAR (val
);
12042 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12043 old_frame
= XCDR (val
);
12044 if (! EQ (old_frame
, selected_frame
)
12045 && FRAME_LIVE_P (XFRAME (old_frame
)))
12046 select_frame_for_redisplay (old_frame
);
12051 /* Mark the display of window W as accurate or inaccurate. If
12052 ACCURATE_P is non-zero mark display of W as accurate. If
12053 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12054 redisplay_internal is called. */
12057 mark_window_display_accurate_1 (w
, accurate_p
)
12061 if (BUFFERP (w
->buffer
))
12063 struct buffer
*b
= XBUFFER (w
->buffer
);
12066 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12067 w
->last_overlay_modified
12068 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12070 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12074 b
->clip_changed
= 0;
12075 b
->prevent_redisplay_optimizations_p
= 0;
12077 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12078 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12079 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12080 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12082 w
->current_matrix
->buffer
= b
;
12083 w
->current_matrix
->begv
= BUF_BEGV (b
);
12084 w
->current_matrix
->zv
= BUF_ZV (b
);
12086 w
->last_cursor
= w
->cursor
;
12087 w
->last_cursor_off_p
= w
->cursor_off_p
;
12089 if (w
== XWINDOW (selected_window
))
12090 w
->last_point
= make_number (BUF_PT (b
));
12092 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12098 w
->window_end_valid
= w
->buffer
;
12099 w
->update_mode_line
= Qnil
;
12104 /* Mark the display of windows in the window tree rooted at WINDOW as
12105 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12106 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12107 be redisplayed the next time redisplay_internal is called. */
12110 mark_window_display_accurate (window
, accurate_p
)
12111 Lisp_Object window
;
12116 for (; !NILP (window
); window
= w
->next
)
12118 w
= XWINDOW (window
);
12119 mark_window_display_accurate_1 (w
, accurate_p
);
12121 if (!NILP (w
->vchild
))
12122 mark_window_display_accurate (w
->vchild
, accurate_p
);
12123 if (!NILP (w
->hchild
))
12124 mark_window_display_accurate (w
->hchild
, accurate_p
);
12129 update_overlay_arrows (1);
12133 /* Force a thorough redisplay the next time by setting
12134 last_arrow_position and last_arrow_string to t, which is
12135 unequal to any useful value of Voverlay_arrow_... */
12136 update_overlay_arrows (-1);
12141 /* Return value in display table DP (Lisp_Char_Table *) for character
12142 C. Since a display table doesn't have any parent, we don't have to
12143 follow parent. Do not call this function directly but use the
12144 macro DISP_CHAR_VECTOR. */
12147 disp_char_vector (dp
, c
)
12148 struct Lisp_Char_Table
*dp
;
12153 if (ASCII_CHAR_P (c
))
12156 if (SUB_CHAR_TABLE_P (val
))
12157 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12163 XSETCHAR_TABLE (table
, dp
);
12164 val
= char_table_ref (table
, c
);
12173 /***********************************************************************
12175 ***********************************************************************/
12177 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12180 redisplay_windows (window
)
12181 Lisp_Object window
;
12183 while (!NILP (window
))
12185 struct window
*w
= XWINDOW (window
);
12187 if (!NILP (w
->hchild
))
12188 redisplay_windows (w
->hchild
);
12189 else if (!NILP (w
->vchild
))
12190 redisplay_windows (w
->vchild
);
12193 displayed_buffer
= XBUFFER (w
->buffer
);
12194 /* Use list_of_error, not Qerror, so that
12195 we catch only errors and don't run the debugger. */
12196 internal_condition_case_1 (redisplay_window_0
, window
,
12198 redisplay_window_error
);
12206 redisplay_window_error ()
12208 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12213 redisplay_window_0 (window
)
12214 Lisp_Object window
;
12216 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12217 redisplay_window (window
, 0);
12222 redisplay_window_1 (window
)
12223 Lisp_Object window
;
12225 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12226 redisplay_window (window
, 1);
12231 /* Increment GLYPH until it reaches END or CONDITION fails while
12232 adding (GLYPH)->pixel_width to X. */
12234 #define SKIP_GLYPHS(glyph, end, x, condition) \
12237 (x) += (glyph)->pixel_width; \
12240 while ((glyph) < (end) && (condition))
12243 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12244 DELTA is the number of bytes by which positions recorded in ROW
12245 differ from current buffer positions.
12247 Return 0 if cursor is not on this row. 1 otherwise. */
12250 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12252 struct glyph_row
*row
;
12253 struct glyph_matrix
*matrix
;
12254 int delta
, delta_bytes
, dy
, dvpos
;
12256 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12257 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12258 struct glyph
*cursor
= NULL
;
12259 /* The first glyph that starts a sequence of glyphs from string. */
12260 struct glyph
*string_start
;
12261 /* The X coordinate of string_start. */
12262 int string_start_x
;
12263 /* The last known character position. */
12264 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12265 /* The last known character position before string_start. */
12266 int string_before_pos
;
12269 int cursor_from_overlay_pos
= 0;
12270 int pt_old
= PT
- delta
;
12272 /* Skip over glyphs not having an object at the start of the row.
12273 These are special glyphs like truncation marks on terminal
12275 if (row
->displays_text_p
)
12277 && INTEGERP (glyph
->object
)
12278 && glyph
->charpos
< 0)
12280 x
+= glyph
->pixel_width
;
12284 string_start
= NULL
;
12286 && !INTEGERP (glyph
->object
)
12287 && (!BUFFERP (glyph
->object
)
12288 || (last_pos
= glyph
->charpos
) < pt_old
12289 || glyph
->avoid_cursor_p
))
12291 if (! STRINGP (glyph
->object
))
12293 string_start
= NULL
;
12294 x
+= glyph
->pixel_width
;
12296 if (cursor_from_overlay_pos
12297 && last_pos
>= cursor_from_overlay_pos
)
12299 cursor_from_overlay_pos
= 0;
12305 if (string_start
== NULL
)
12307 string_before_pos
= last_pos
;
12308 string_start
= glyph
;
12309 string_start_x
= x
;
12311 /* Skip all glyphs from string. */
12316 if ((cursor
== NULL
|| glyph
> cursor
)
12317 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12318 Qcursor
, (glyph
)->object
),
12320 && (pos
= string_buffer_position (w
, glyph
->object
,
12321 string_before_pos
),
12322 (pos
== 0 /* From overlay */
12323 || pos
== pt_old
)))
12325 /* Estimate overlay buffer position from the buffer
12326 positions of the glyphs before and after the overlay.
12327 Add 1 to last_pos so that if point corresponds to the
12328 glyph right after the overlay, we still use a 'cursor'
12329 property found in that overlay. */
12330 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12331 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12335 x
+= glyph
->pixel_width
;
12338 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12342 if (cursor
!= NULL
)
12347 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12349 /* Scan back over the ellipsis glyphs, decrementing positions. */
12350 while (glyph
> row
->glyphs
[TEXT_AREA
]
12351 && (glyph
- 1)->charpos
== last_pos
)
12352 glyph
--, x
-= glyph
->pixel_width
;
12353 /* That loop always goes one position too far,
12354 including the glyph before the ellipsis.
12355 So scan forward over that one. */
12356 x
+= glyph
->pixel_width
;
12359 else if (string_start
12360 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12362 /* We may have skipped over point because the previous glyphs
12363 are from string. As there's no easy way to know the
12364 character position of the current glyph, find the correct
12365 glyph on point by scanning from string_start again. */
12367 Lisp_Object string
;
12368 struct glyph
*stop
= glyph
;
12371 limit
= make_number (pt_old
+ 1);
12372 glyph
= string_start
;
12373 x
= string_start_x
;
12374 string
= glyph
->object
;
12375 pos
= string_buffer_position (w
, string
, string_before_pos
);
12376 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12377 because we always put cursor after overlay strings. */
12378 while (pos
== 0 && glyph
< stop
)
12380 string
= glyph
->object
;
12381 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12383 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12386 while (glyph
< stop
)
12388 pos
= XINT (Fnext_single_char_property_change
12389 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12392 /* Skip glyphs from the same string. */
12393 string
= glyph
->object
;
12394 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12395 /* Skip glyphs from an overlay. */
12396 while (glyph
< stop
12397 && ! string_buffer_position (w
, glyph
->object
, pos
))
12399 string
= glyph
->object
;
12400 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12404 /* If we reached the end of the line, and end was from a string,
12405 cursor is not on this line. */
12406 if (glyph
== end
&& row
->continued_p
)
12410 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12412 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12413 w
->cursor
.y
= row
->y
+ dy
;
12415 if (w
== XWINDOW (selected_window
))
12417 if (!row
->continued_p
12418 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12421 this_line_buffer
= XBUFFER (w
->buffer
);
12423 CHARPOS (this_line_start_pos
)
12424 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12425 BYTEPOS (this_line_start_pos
)
12426 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12428 CHARPOS (this_line_end_pos
)
12429 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12430 BYTEPOS (this_line_end_pos
)
12431 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12433 this_line_y
= w
->cursor
.y
;
12434 this_line_pixel_height
= row
->height
;
12435 this_line_vpos
= w
->cursor
.vpos
;
12436 this_line_start_x
= row
->x
;
12439 CHARPOS (this_line_start_pos
) = 0;
12446 /* Run window scroll functions, if any, for WINDOW with new window
12447 start STARTP. Sets the window start of WINDOW to that position.
12449 We assume that the window's buffer is really current. */
12451 static INLINE
struct text_pos
12452 run_window_scroll_functions (window
, startp
)
12453 Lisp_Object window
;
12454 struct text_pos startp
;
12456 struct window
*w
= XWINDOW (window
);
12457 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12459 if (current_buffer
!= XBUFFER (w
->buffer
))
12462 if (!NILP (Vwindow_scroll_functions
))
12464 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12465 make_number (CHARPOS (startp
)));
12466 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12467 /* In case the hook functions switch buffers. */
12468 if (current_buffer
!= XBUFFER (w
->buffer
))
12469 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12476 /* Make sure the line containing the cursor is fully visible.
12477 A value of 1 means there is nothing to be done.
12478 (Either the line is fully visible, or it cannot be made so,
12479 or we cannot tell.)
12481 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12482 is higher than window.
12484 A value of 0 means the caller should do scrolling
12485 as if point had gone off the screen. */
12488 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12491 int current_matrix_p
;
12493 struct glyph_matrix
*matrix
;
12494 struct glyph_row
*row
;
12497 if (!make_cursor_line_fully_visible_p
)
12500 /* It's not always possible to find the cursor, e.g, when a window
12501 is full of overlay strings. Don't do anything in that case. */
12502 if (w
->cursor
.vpos
< 0)
12505 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12506 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12508 /* If the cursor row is not partially visible, there's nothing to do. */
12509 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12512 /* If the row the cursor is in is taller than the window's height,
12513 it's not clear what to do, so do nothing. */
12514 window_height
= window_box_height (w
);
12515 if (row
->height
>= window_height
)
12517 if (!force_p
|| MINI_WINDOW_P (w
)
12518 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12524 /* This code used to try to scroll the window just enough to make
12525 the line visible. It returned 0 to say that the caller should
12526 allocate larger glyph matrices. */
12528 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12530 int dy
= row
->height
- row
->visible_height
;
12533 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12535 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12537 int dy
= - (row
->height
- row
->visible_height
);
12540 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12543 /* When we change the cursor y-position of the selected window,
12544 change this_line_y as well so that the display optimization for
12545 the cursor line of the selected window in redisplay_internal uses
12546 the correct y-position. */
12547 if (w
== XWINDOW (selected_window
))
12548 this_line_y
= w
->cursor
.y
;
12550 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12551 redisplay with larger matrices. */
12552 if (matrix
->nrows
< required_matrix_height (w
))
12554 fonts_changed_p
= 1;
12563 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12564 non-zero means only WINDOW is redisplayed in redisplay_internal.
12565 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12566 in redisplay_window to bring a partially visible line into view in
12567 the case that only the cursor has moved.
12569 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12570 last screen line's vertical height extends past the end of the screen.
12574 1 if scrolling succeeded
12576 0 if scrolling didn't find point.
12578 -1 if new fonts have been loaded so that we must interrupt
12579 redisplay, adjust glyph matrices, and try again. */
12585 SCROLLING_NEED_LARGER_MATRICES
12589 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12590 scroll_step
, temp_scroll_step
, last_line_misfit
)
12591 Lisp_Object window
;
12592 int just_this_one_p
;
12593 EMACS_INT scroll_conservatively
, scroll_step
;
12594 int temp_scroll_step
;
12595 int last_line_misfit
;
12597 struct window
*w
= XWINDOW (window
);
12598 struct frame
*f
= XFRAME (w
->frame
);
12599 struct text_pos pos
, startp
;
12601 int this_scroll_margin
, scroll_max
, rc
, height
;
12602 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12603 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12604 Lisp_Object aggressive
;
12605 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12608 debug_method_add (w
, "try_scrolling");
12611 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12613 /* Compute scroll margin height in pixels. We scroll when point is
12614 within this distance from the top or bottom of the window. */
12615 if (scroll_margin
> 0)
12617 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12618 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12621 this_scroll_margin
= 0;
12623 /* Force scroll_conservatively to have a reasonable value, to avoid
12624 overflow while computing how much to scroll. Note that it's
12625 fairly common for users to supply scroll-conservatively equal to
12626 `most-positive-fixnum', which can be larger than INT_MAX. */
12627 if (scroll_conservatively
> scroll_limit
)
12629 scroll_conservatively
= scroll_limit
;
12630 scroll_max
= INT_MAX
;
12632 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12633 /* Compute how much we should try to scroll maximally to bring
12634 point into view. */
12635 scroll_max
= (max (scroll_step
,
12636 max (scroll_conservatively
, temp_scroll_step
))
12637 * FRAME_LINE_HEIGHT (f
));
12638 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12639 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12640 /* We're trying to scroll because of aggressive scrolling but no
12641 scroll_step is set. Choose an arbitrary one. */
12642 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
12648 /* Decide whether we have to scroll down. */
12649 if (PT
> CHARPOS (startp
))
12651 int scroll_margin_y
;
12653 /* Compute the pixel ypos of the scroll margin, then move it to
12654 either that ypos or PT, whichever comes first. */
12655 start_display (&it
, w
, startp
);
12656 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
12657 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
12658 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
12659 (MOVE_TO_POS
| MOVE_TO_Y
));
12661 if (PT
> CHARPOS (it
.current
.pos
))
12663 /* Point is in the scroll margin at the bottom of the
12664 window, or below. Compute the distance from the scroll
12665 margin to PT, and give up if the distance is greater than
12667 move_it_to (&it
, PT
, -1, it
.last_visible_y
- 1, -1,
12668 MOVE_TO_POS
| MOVE_TO_Y
);
12670 /* To make point visible, we must move the window start down
12671 so that the cursor line is visible, which means we have
12672 to add in the height of the cursor line. */
12673 dy
= line_bottom_y (&it
) - scroll_margin_y
;
12675 if (dy
> scroll_max
)
12676 return SCROLLING_FAILED
;
12684 /* Move the window start down. If scrolling conservatively,
12685 move it just enough down to make point visible. If
12686 scroll_step is set, move it down by scroll_step. */
12687 start_display (&it
, w
, startp
);
12689 if (scroll_conservatively
)
12690 /* Set AMOUNT_TO_SCROLL to at least one line,
12691 and at most scroll_conservatively lines. */
12693 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12694 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12695 else if (scroll_step
|| temp_scroll_step
)
12696 amount_to_scroll
= scroll_max
;
12699 aggressive
= current_buffer
->scroll_up_aggressively
;
12700 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12701 if (NUMBERP (aggressive
))
12703 double float_amount
= XFLOATINT (aggressive
) * height
;
12704 amount_to_scroll
= float_amount
;
12705 if (amount_to_scroll
== 0 && float_amount
> 0)
12706 amount_to_scroll
= 1;
12710 if (amount_to_scroll
<= 0)
12711 return SCROLLING_FAILED
;
12713 /* If moving by amount_to_scroll leaves STARTP unchanged,
12714 move it down one screen line. */
12716 move_it_vertically (&it
, amount_to_scroll
);
12717 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12718 move_it_by_lines (&it
, 1, 1);
12719 startp
= it
.current
.pos
;
12723 struct text_pos scroll_margin_pos
= startp
;
12725 /* See if point is inside the scroll margin at the top of the
12727 if (this_scroll_margin
)
12729 start_display (&it
, w
, startp
);
12730 move_it_vertically (&it
, this_scroll_margin
);
12731 scroll_margin_pos
= it
.current
.pos
;
12734 if (PT
< CHARPOS (scroll_margin_pos
))
12736 /* Point is in the scroll margin at the top of the window or
12737 above what is displayed in the window. */
12740 /* Compute the vertical distance from PT to the scroll
12741 margin position. Give up if distance is greater than
12743 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12744 start_display (&it
, w
, pos
);
12746 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12747 it
.last_visible_y
, -1,
12748 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12749 dy
= it
.current_y
- y0
;
12750 if (dy
> scroll_max
)
12751 return SCROLLING_FAILED
;
12753 /* Compute new window start. */
12754 start_display (&it
, w
, startp
);
12756 if (scroll_conservatively
)
12758 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12759 else if (scroll_step
|| temp_scroll_step
)
12760 amount_to_scroll
= scroll_max
;
12763 aggressive
= current_buffer
->scroll_down_aggressively
;
12764 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12765 if (NUMBERP (aggressive
))
12767 double float_amount
= XFLOATINT (aggressive
) * height
;
12768 amount_to_scroll
= float_amount
;
12769 if (amount_to_scroll
== 0 && float_amount
> 0)
12770 amount_to_scroll
= 1;
12774 if (amount_to_scroll
<= 0)
12775 return SCROLLING_FAILED
;
12777 move_it_vertically_backward (&it
, amount_to_scroll
);
12778 startp
= it
.current
.pos
;
12782 /* Run window scroll functions. */
12783 startp
= run_window_scroll_functions (window
, startp
);
12785 /* Display the window. Give up if new fonts are loaded, or if point
12787 if (!try_window (window
, startp
, 0))
12788 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12789 else if (w
->cursor
.vpos
< 0)
12791 clear_glyph_matrix (w
->desired_matrix
);
12792 rc
= SCROLLING_FAILED
;
12796 /* Maybe forget recorded base line for line number display. */
12797 if (!just_this_one_p
12798 || current_buffer
->clip_changed
12799 || BEG_UNCHANGED
< CHARPOS (startp
))
12800 w
->base_line_number
= Qnil
;
12802 /* If cursor ends up on a partially visible line,
12803 treat that as being off the bottom of the screen. */
12804 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12806 clear_glyph_matrix (w
->desired_matrix
);
12807 ++extra_scroll_margin_lines
;
12810 rc
= SCROLLING_SUCCESS
;
12817 /* Compute a suitable window start for window W if display of W starts
12818 on a continuation line. Value is non-zero if a new window start
12821 The new window start will be computed, based on W's width, starting
12822 from the start of the continued line. It is the start of the
12823 screen line with the minimum distance from the old start W->start. */
12826 compute_window_start_on_continuation_line (w
)
12829 struct text_pos pos
, start_pos
;
12830 int window_start_changed_p
= 0;
12832 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12834 /* If window start is on a continuation line... Window start may be
12835 < BEGV in case there's invisible text at the start of the
12836 buffer (M-x rmail, for example). */
12837 if (CHARPOS (start_pos
) > BEGV
12838 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12841 struct glyph_row
*row
;
12843 /* Handle the case that the window start is out of range. */
12844 if (CHARPOS (start_pos
) < BEGV
)
12845 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12846 else if (CHARPOS (start_pos
) > ZV
)
12847 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12849 /* Find the start of the continued line. This should be fast
12850 because scan_buffer is fast (newline cache). */
12851 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12852 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12853 row
, DEFAULT_FACE_ID
);
12854 reseat_at_previous_visible_line_start (&it
);
12856 /* If the line start is "too far" away from the window start,
12857 say it takes too much time to compute a new window start. */
12858 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12859 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12861 int min_distance
, distance
;
12863 /* Move forward by display lines to find the new window
12864 start. If window width was enlarged, the new start can
12865 be expected to be > the old start. If window width was
12866 decreased, the new window start will be < the old start.
12867 So, we're looking for the display line start with the
12868 minimum distance from the old window start. */
12869 pos
= it
.current
.pos
;
12870 min_distance
= INFINITY
;
12871 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12872 distance
< min_distance
)
12874 min_distance
= distance
;
12875 pos
= it
.current
.pos
;
12876 move_it_by_lines (&it
, 1, 0);
12879 /* Set the window start there. */
12880 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12881 window_start_changed_p
= 1;
12885 return window_start_changed_p
;
12889 /* Try cursor movement in case text has not changed in window WINDOW,
12890 with window start STARTP. Value is
12892 CURSOR_MOVEMENT_SUCCESS if successful
12894 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12896 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12897 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12898 we want to scroll as if scroll-step were set to 1. See the code.
12900 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12901 which case we have to abort this redisplay, and adjust matrices
12906 CURSOR_MOVEMENT_SUCCESS
,
12907 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12908 CURSOR_MOVEMENT_MUST_SCROLL
,
12909 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12913 try_cursor_movement (window
, startp
, scroll_step
)
12914 Lisp_Object window
;
12915 struct text_pos startp
;
12918 struct window
*w
= XWINDOW (window
);
12919 struct frame
*f
= XFRAME (w
->frame
);
12920 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12923 if (inhibit_try_cursor_movement
)
12927 /* Handle case where text has not changed, only point, and it has
12928 not moved off the frame. */
12929 if (/* Point may be in this window. */
12930 PT
>= CHARPOS (startp
)
12931 /* Selective display hasn't changed. */
12932 && !current_buffer
->clip_changed
12933 /* Function force-mode-line-update is used to force a thorough
12934 redisplay. It sets either windows_or_buffers_changed or
12935 update_mode_lines. So don't take a shortcut here for these
12937 && !update_mode_lines
12938 && !windows_or_buffers_changed
12939 && !cursor_type_changed
12940 /* Can't use this case if highlighting a region. When a
12941 region exists, cursor movement has to do more than just
12943 && !(!NILP (Vtransient_mark_mode
)
12944 && !NILP (current_buffer
->mark_active
))
12945 && NILP (w
->region_showing
)
12946 && NILP (Vshow_trailing_whitespace
)
12947 /* Right after splitting windows, last_point may be nil. */
12948 && INTEGERP (w
->last_point
)
12949 /* This code is not used for mini-buffer for the sake of the case
12950 of redisplaying to replace an echo area message; since in
12951 that case the mini-buffer contents per se are usually
12952 unchanged. This code is of no real use in the mini-buffer
12953 since the handling of this_line_start_pos, etc., in redisplay
12954 handles the same cases. */
12955 && !EQ (window
, minibuf_window
)
12956 /* When splitting windows or for new windows, it happens that
12957 redisplay is called with a nil window_end_vpos or one being
12958 larger than the window. This should really be fixed in
12959 window.c. I don't have this on my list, now, so we do
12960 approximately the same as the old redisplay code. --gerd. */
12961 && INTEGERP (w
->window_end_vpos
)
12962 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12963 && (FRAME_WINDOW_P (f
)
12964 || !overlay_arrow_in_current_buffer_p ()))
12966 int this_scroll_margin
, top_scroll_margin
;
12967 struct glyph_row
*row
= NULL
;
12970 debug_method_add (w
, "cursor movement");
12973 /* Scroll if point within this distance from the top or bottom
12974 of the window. This is a pixel value. */
12975 if (scroll_margin
> 0)
12977 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12978 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12981 this_scroll_margin
= 0;
12983 top_scroll_margin
= this_scroll_margin
;
12984 if (WINDOW_WANTS_HEADER_LINE_P (w
))
12985 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
12987 /* Start with the row the cursor was displayed during the last
12988 not paused redisplay. Give up if that row is not valid. */
12989 if (w
->last_cursor
.vpos
< 0
12990 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
12991 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
12994 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
12995 if (row
->mode_line_p
)
12997 if (!row
->enabled_p
)
12998 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13001 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13004 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13006 if (PT
> XFASTINT (w
->last_point
))
13008 /* Point has moved forward. */
13009 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13010 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13012 xassert (row
->enabled_p
);
13016 /* The end position of a row equals the start position
13017 of the next row. If PT is there, we would rather
13018 display it in the next line. */
13019 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13020 && MATRIX_ROW_END_CHARPOS (row
) == PT
13021 && !cursor_row_p (w
, row
))
13024 /* If within the scroll margin, scroll. Note that
13025 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13026 the next line would be drawn, and that
13027 this_scroll_margin can be zero. */
13028 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13029 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13030 /* Line is completely visible last line in window
13031 and PT is to be set in the next line. */
13032 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13033 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13034 && !row
->ends_at_zv_p
13035 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13038 else if (PT
< XFASTINT (w
->last_point
))
13040 /* Cursor has to be moved backward. Note that PT >=
13041 CHARPOS (startp) because of the outer if-statement. */
13042 while (!row
->mode_line_p
13043 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13044 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13045 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13046 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13047 row
> w
->current_matrix
->rows
13048 && (row
-1)->ends_in_newline_from_string_p
))))
13049 && (row
->y
> top_scroll_margin
13050 || CHARPOS (startp
) == BEGV
))
13052 xassert (row
->enabled_p
);
13056 /* Consider the following case: Window starts at BEGV,
13057 there is invisible, intangible text at BEGV, so that
13058 display starts at some point START > BEGV. It can
13059 happen that we are called with PT somewhere between
13060 BEGV and START. Try to handle that case. */
13061 if (row
< w
->current_matrix
->rows
13062 || row
->mode_line_p
)
13064 row
= w
->current_matrix
->rows
;
13065 if (row
->mode_line_p
)
13069 /* Due to newlines in overlay strings, we may have to
13070 skip forward over overlay strings. */
13071 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13072 && MATRIX_ROW_END_CHARPOS (row
) == PT
13073 && !cursor_row_p (w
, row
))
13076 /* If within the scroll margin, scroll. */
13077 if (row
->y
< top_scroll_margin
13078 && CHARPOS (startp
) != BEGV
)
13083 /* Cursor did not move. So don't scroll even if cursor line
13084 is partially visible, as it was so before. */
13085 rc
= CURSOR_MOVEMENT_SUCCESS
;
13088 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13089 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13091 /* if PT is not in the glyph row, give up. */
13092 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13094 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13095 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13096 && make_cursor_line_fully_visible_p
)
13098 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13099 && !row
->ends_at_zv_p
13100 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13101 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13102 else if (row
->height
> window_box_height (w
))
13104 /* If we end up in a partially visible line, let's
13105 make it fully visible, except when it's taller
13106 than the window, in which case we can't do much
13109 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13113 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13114 if (!cursor_row_fully_visible_p (w
, 0, 1))
13115 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13117 rc
= CURSOR_MOVEMENT_SUCCESS
;
13121 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13126 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13128 rc
= CURSOR_MOVEMENT_SUCCESS
;
13133 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13134 && MATRIX_ROW_START_CHARPOS (row
) == PT
13135 && cursor_row_p (w
, row
));
13144 set_vertical_scroll_bar (w
)
13147 int start
, end
, whole
;
13149 /* Calculate the start and end positions for the current window.
13150 At some point, it would be nice to choose between scrollbars
13151 which reflect the whole buffer size, with special markers
13152 indicating narrowing, and scrollbars which reflect only the
13155 Note that mini-buffers sometimes aren't displaying any text. */
13156 if (!MINI_WINDOW_P (w
)
13157 || (w
== XWINDOW (minibuf_window
)
13158 && NILP (echo_area_buffer
[0])))
13160 struct buffer
*buf
= XBUFFER (w
->buffer
);
13161 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13162 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13163 /* I don't think this is guaranteed to be right. For the
13164 moment, we'll pretend it is. */
13165 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13169 if (whole
< (end
- start
))
13170 whole
= end
- start
;
13173 start
= end
= whole
= 0;
13175 /* Indicate what this scroll bar ought to be displaying now. */
13176 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13177 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13178 (w
, end
- start
, whole
, start
);
13182 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13183 selected_window is redisplayed.
13185 We can return without actually redisplaying the window if
13186 fonts_changed_p is nonzero. In that case, redisplay_internal will
13190 redisplay_window (window
, just_this_one_p
)
13191 Lisp_Object window
;
13192 int just_this_one_p
;
13194 struct window
*w
= XWINDOW (window
);
13195 struct frame
*f
= XFRAME (w
->frame
);
13196 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13197 struct buffer
*old
= current_buffer
;
13198 struct text_pos lpoint
, opoint
, startp
;
13199 int update_mode_line
;
13202 /* Record it now because it's overwritten. */
13203 int current_matrix_up_to_date_p
= 0;
13204 int used_current_matrix_p
= 0;
13205 /* This is less strict than current_matrix_up_to_date_p.
13206 It indictes that the buffer contents and narrowing are unchanged. */
13207 int buffer_unchanged_p
= 0;
13208 int temp_scroll_step
= 0;
13209 int count
= SPECPDL_INDEX ();
13211 int centering_position
= -1;
13212 int last_line_misfit
= 0;
13213 int beg_unchanged
, end_unchanged
;
13215 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13218 /* W must be a leaf window here. */
13219 xassert (!NILP (w
->buffer
));
13221 *w
->desired_matrix
->method
= 0;
13225 reconsider_clip_changes (w
, buffer
);
13227 /* Has the mode line to be updated? */
13228 update_mode_line
= (!NILP (w
->update_mode_line
)
13229 || update_mode_lines
13230 || buffer
->clip_changed
13231 || buffer
->prevent_redisplay_optimizations_p
);
13233 if (MINI_WINDOW_P (w
))
13235 if (w
== XWINDOW (echo_area_window
)
13236 && !NILP (echo_area_buffer
[0]))
13238 if (update_mode_line
)
13239 /* We may have to update a tty frame's menu bar or a
13240 tool-bar. Example `M-x C-h C-h C-g'. */
13241 goto finish_menu_bars
;
13243 /* We've already displayed the echo area glyphs in this window. */
13244 goto finish_scroll_bars
;
13246 else if ((w
!= XWINDOW (minibuf_window
)
13247 || minibuf_level
== 0)
13248 /* When buffer is nonempty, redisplay window normally. */
13249 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13250 /* Quail displays non-mini buffers in minibuffer window.
13251 In that case, redisplay the window normally. */
13252 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13254 /* W is a mini-buffer window, but it's not active, so clear
13256 int yb
= window_text_bottom_y (w
);
13257 struct glyph_row
*row
;
13260 for (y
= 0, row
= w
->desired_matrix
->rows
;
13262 y
+= row
->height
, ++row
)
13263 blank_row (w
, row
, y
);
13264 goto finish_scroll_bars
;
13267 clear_glyph_matrix (w
->desired_matrix
);
13270 /* Otherwise set up data on this window; select its buffer and point
13272 /* Really select the buffer, for the sake of buffer-local
13274 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13276 current_matrix_up_to_date_p
13277 = (!NILP (w
->window_end_valid
)
13278 && !current_buffer
->clip_changed
13279 && !current_buffer
->prevent_redisplay_optimizations_p
13280 && XFASTINT (w
->last_modified
) >= MODIFF
13281 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13283 /* Run the window-bottom-change-functions
13284 if it is possible that the text on the screen has changed
13285 (either due to modification of the text, or any other reason). */
13286 if (!current_matrix_up_to_date_p
13287 && !NILP (Vwindow_text_change_functions
))
13289 safe_run_hooks (Qwindow_text_change_functions
);
13293 beg_unchanged
= BEG_UNCHANGED
;
13294 end_unchanged
= END_UNCHANGED
;
13296 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13298 specbind (Qinhibit_point_motion_hooks
, Qt
);
13301 = (!NILP (w
->window_end_valid
)
13302 && !current_buffer
->clip_changed
13303 && XFASTINT (w
->last_modified
) >= MODIFF
13304 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13306 /* When windows_or_buffers_changed is non-zero, we can't rely on
13307 the window end being valid, so set it to nil there. */
13308 if (windows_or_buffers_changed
)
13310 /* If window starts on a continuation line, maybe adjust the
13311 window start in case the window's width changed. */
13312 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13313 compute_window_start_on_continuation_line (w
);
13315 w
->window_end_valid
= Qnil
;
13318 /* Some sanity checks. */
13319 CHECK_WINDOW_END (w
);
13320 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13322 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13325 /* If %c is in mode line, update it if needed. */
13326 if (!NILP (w
->column_number_displayed
)
13327 /* This alternative quickly identifies a common case
13328 where no change is needed. */
13329 && !(PT
== XFASTINT (w
->last_point
)
13330 && XFASTINT (w
->last_modified
) >= MODIFF
13331 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13332 && (XFASTINT (w
->column_number_displayed
)
13333 != (int) current_column ())) /* iftc */
13334 update_mode_line
= 1;
13336 /* Count number of windows showing the selected buffer. An indirect
13337 buffer counts as its base buffer. */
13338 if (!just_this_one_p
)
13340 struct buffer
*current_base
, *window_base
;
13341 current_base
= current_buffer
;
13342 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13343 if (current_base
->base_buffer
)
13344 current_base
= current_base
->base_buffer
;
13345 if (window_base
->base_buffer
)
13346 window_base
= window_base
->base_buffer
;
13347 if (current_base
== window_base
)
13351 /* Point refers normally to the selected window. For any other
13352 window, set up appropriate value. */
13353 if (!EQ (window
, selected_window
))
13355 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13356 int new_pt_byte
= marker_byte_position (w
->pointm
);
13360 new_pt_byte
= BEGV_BYTE
;
13361 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13363 else if (new_pt
> (ZV
- 1))
13366 new_pt_byte
= ZV_BYTE
;
13367 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13370 /* We don't use SET_PT so that the point-motion hooks don't run. */
13371 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13374 /* If any of the character widths specified in the display table
13375 have changed, invalidate the width run cache. It's true that
13376 this may be a bit late to catch such changes, but the rest of
13377 redisplay goes (non-fatally) haywire when the display table is
13378 changed, so why should we worry about doing any better? */
13379 if (current_buffer
->width_run_cache
)
13381 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13383 if (! disptab_matches_widthtab (disptab
,
13384 XVECTOR (current_buffer
->width_table
)))
13386 invalidate_region_cache (current_buffer
,
13387 current_buffer
->width_run_cache
,
13389 recompute_width_table (current_buffer
, disptab
);
13393 /* If window-start is screwed up, choose a new one. */
13394 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13397 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13399 /* If someone specified a new starting point but did not insist,
13400 check whether it can be used. */
13401 if (!NILP (w
->optional_new_start
)
13402 && CHARPOS (startp
) >= BEGV
13403 && CHARPOS (startp
) <= ZV
)
13405 w
->optional_new_start
= Qnil
;
13406 start_display (&it
, w
, startp
);
13407 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13408 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13409 if (IT_CHARPOS (it
) == PT
)
13410 w
->force_start
= Qt
;
13411 /* IT may overshoot PT if text at PT is invisible. */
13412 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13413 w
->force_start
= Qt
;
13418 /* Handle case where place to start displaying has been specified,
13419 unless the specified location is outside the accessible range. */
13420 if (!NILP (w
->force_start
)
13421 || w
->frozen_window_start_p
)
13423 /* We set this later on if we have to adjust point. */
13426 w
->force_start
= Qnil
;
13428 w
->window_end_valid
= Qnil
;
13430 /* Forget any recorded base line for line number display. */
13431 if (!buffer_unchanged_p
)
13432 w
->base_line_number
= Qnil
;
13434 /* Redisplay the mode line. Select the buffer properly for that.
13435 Also, run the hook window-scroll-functions
13436 because we have scrolled. */
13437 /* Note, we do this after clearing force_start because
13438 if there's an error, it is better to forget about force_start
13439 than to get into an infinite loop calling the hook functions
13440 and having them get more errors. */
13441 if (!update_mode_line
13442 || ! NILP (Vwindow_scroll_functions
))
13444 update_mode_line
= 1;
13445 w
->update_mode_line
= Qt
;
13446 startp
= run_window_scroll_functions (window
, startp
);
13449 w
->last_modified
= make_number (0);
13450 w
->last_overlay_modified
= make_number (0);
13451 if (CHARPOS (startp
) < BEGV
)
13452 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13453 else if (CHARPOS (startp
) > ZV
)
13454 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13456 /* Redisplay, then check if cursor has been set during the
13457 redisplay. Give up if new fonts were loaded. */
13458 /* We used to issue a CHECK_MARGINS argument to try_window here,
13459 but this causes scrolling to fail when point begins inside
13460 the scroll margin (bug#148) -- cyd */
13461 if (!try_window (window
, startp
, 0))
13463 w
->force_start
= Qt
;
13464 clear_glyph_matrix (w
->desired_matrix
);
13465 goto need_larger_matrices
;
13468 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13470 /* If point does not appear, try to move point so it does
13471 appear. The desired matrix has been built above, so we
13472 can use it here. */
13473 new_vpos
= window_box_height (w
) / 2;
13476 if (!cursor_row_fully_visible_p (w
, 0, 0))
13478 /* Point does appear, but on a line partly visible at end of window.
13479 Move it back to a fully-visible line. */
13480 new_vpos
= window_box_height (w
);
13483 /* If we need to move point for either of the above reasons,
13484 now actually do it. */
13487 struct glyph_row
*row
;
13489 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13490 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13493 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13494 MATRIX_ROW_START_BYTEPOS (row
));
13496 if (w
!= XWINDOW (selected_window
))
13497 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13498 else if (current_buffer
== old
)
13499 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13501 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13503 /* If we are highlighting the region, then we just changed
13504 the region, so redisplay to show it. */
13505 if (!NILP (Vtransient_mark_mode
)
13506 && !NILP (current_buffer
->mark_active
))
13508 clear_glyph_matrix (w
->desired_matrix
);
13509 if (!try_window (window
, startp
, 0))
13510 goto need_larger_matrices
;
13515 debug_method_add (w
, "forced window start");
13520 /* Handle case where text has not changed, only point, and it has
13521 not moved off the frame, and we are not retrying after hscroll.
13522 (current_matrix_up_to_date_p is nonzero when retrying.) */
13523 if (current_matrix_up_to_date_p
13524 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13525 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13529 case CURSOR_MOVEMENT_SUCCESS
:
13530 used_current_matrix_p
= 1;
13533 #if 0 /* try_cursor_movement never returns this value. */
13534 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13535 goto need_larger_matrices
;
13538 case CURSOR_MOVEMENT_MUST_SCROLL
:
13539 goto try_to_scroll
;
13545 /* If current starting point was originally the beginning of a line
13546 but no longer is, find a new starting point. */
13547 else if (!NILP (w
->start_at_line_beg
)
13548 && !(CHARPOS (startp
) <= BEGV
13549 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13552 debug_method_add (w
, "recenter 1");
13557 /* Try scrolling with try_window_id. Value is > 0 if update has
13558 been done, it is -1 if we know that the same window start will
13559 not work. It is 0 if unsuccessful for some other reason. */
13560 else if ((tem
= try_window_id (w
)) != 0)
13563 debug_method_add (w
, "try_window_id %d", tem
);
13566 if (fonts_changed_p
)
13567 goto need_larger_matrices
;
13571 /* Otherwise try_window_id has returned -1 which means that we
13572 don't want the alternative below this comment to execute. */
13574 else if (CHARPOS (startp
) >= BEGV
13575 && CHARPOS (startp
) <= ZV
13576 && PT
>= CHARPOS (startp
)
13577 && (CHARPOS (startp
) < ZV
13578 /* Avoid starting at end of buffer. */
13579 || CHARPOS (startp
) == BEGV
13580 || (XFASTINT (w
->last_modified
) >= MODIFF
13581 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13584 /* If first window line is a continuation line, and window start
13585 is inside the modified region, but the first change is before
13586 current window start, we must select a new window start.
13588 However, if this is the result of a down-mouse event (e.g. by
13589 extending the mouse-drag-overlay), we don't want to select a
13590 new window start, since that would change the position under
13591 the mouse, resulting in an unwanted mouse-movement rather
13592 than a simple mouse-click. */
13593 if (NILP (w
->start_at_line_beg
)
13594 && NILP (do_mouse_tracking
)
13595 && CHARPOS (startp
) > BEGV
13596 && CHARPOS (startp
) > BEG
+ beg_unchanged
13597 && CHARPOS (startp
) <= Z
- end_unchanged
13598 /* Even if w->start_at_line_beg is nil, a new window may
13599 start at a line_beg, since that's how set_buffer_window
13600 sets it. So, we need to check the return value of
13601 compute_window_start_on_continuation_line. (See also
13603 && XMARKER (w
->start
)->buffer
== current_buffer
13604 && compute_window_start_on_continuation_line (w
))
13606 w
->force_start
= Qt
;
13607 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13612 debug_method_add (w
, "same window start");
13615 /* Try to redisplay starting at same place as before.
13616 If point has not moved off frame, accept the results. */
13617 if (!current_matrix_up_to_date_p
13618 /* Don't use try_window_reusing_current_matrix in this case
13619 because a window scroll function can have changed the
13621 || !NILP (Vwindow_scroll_functions
)
13622 || MINI_WINDOW_P (w
)
13623 || !(used_current_matrix_p
13624 = try_window_reusing_current_matrix (w
)))
13626 IF_DEBUG (debug_method_add (w
, "1"));
13627 if (try_window (window
, startp
, 1) < 0)
13628 /* -1 means we need to scroll.
13629 0 means we need new matrices, but fonts_changed_p
13630 is set in that case, so we will detect it below. */
13631 goto try_to_scroll
;
13634 if (fonts_changed_p
)
13635 goto need_larger_matrices
;
13637 if (w
->cursor
.vpos
>= 0)
13639 if (!just_this_one_p
13640 || current_buffer
->clip_changed
13641 || BEG_UNCHANGED
< CHARPOS (startp
))
13642 /* Forget any recorded base line for line number display. */
13643 w
->base_line_number
= Qnil
;
13645 if (!cursor_row_fully_visible_p (w
, 1, 0))
13647 clear_glyph_matrix (w
->desired_matrix
);
13648 last_line_misfit
= 1;
13650 /* Drop through and scroll. */
13655 clear_glyph_matrix (w
->desired_matrix
);
13660 w
->last_modified
= make_number (0);
13661 w
->last_overlay_modified
= make_number (0);
13663 /* Redisplay the mode line. Select the buffer properly for that. */
13664 if (!update_mode_line
)
13666 update_mode_line
= 1;
13667 w
->update_mode_line
= Qt
;
13670 /* Try to scroll by specified few lines. */
13671 if ((scroll_conservatively
13673 || temp_scroll_step
13674 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13675 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13676 && !current_buffer
->clip_changed
13677 && CHARPOS (startp
) >= BEGV
13678 && CHARPOS (startp
) <= ZV
)
13680 /* The function returns -1 if new fonts were loaded, 1 if
13681 successful, 0 if not successful. */
13682 int rc
= try_scrolling (window
, just_this_one_p
,
13683 scroll_conservatively
,
13685 temp_scroll_step
, last_line_misfit
);
13688 case SCROLLING_SUCCESS
:
13691 case SCROLLING_NEED_LARGER_MATRICES
:
13692 goto need_larger_matrices
;
13694 case SCROLLING_FAILED
:
13702 /* Finally, just choose place to start which centers point */
13705 if (centering_position
< 0)
13706 centering_position
= window_box_height (w
) / 2;
13709 debug_method_add (w
, "recenter");
13712 /* w->vscroll = 0; */
13714 /* Forget any previously recorded base line for line number display. */
13715 if (!buffer_unchanged_p
)
13716 w
->base_line_number
= Qnil
;
13718 /* Move backward half the height of the window. */
13719 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13720 it
.current_y
= it
.last_visible_y
;
13721 move_it_vertically_backward (&it
, centering_position
);
13722 xassert (IT_CHARPOS (it
) >= BEGV
);
13724 /* The function move_it_vertically_backward may move over more
13725 than the specified y-distance. If it->w is small, e.g. a
13726 mini-buffer window, we may end up in front of the window's
13727 display area. Start displaying at the start of the line
13728 containing PT in this case. */
13729 if (it
.current_y
<= 0)
13731 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13732 move_it_vertically_backward (&it
, 0);
13736 it
.current_x
= it
.hpos
= 0;
13738 /* Set startp here explicitly in case that helps avoid an infinite loop
13739 in case the window-scroll-functions functions get errors. */
13740 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13742 /* Run scroll hooks. */
13743 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13745 /* Redisplay the window. */
13746 if (!current_matrix_up_to_date_p
13747 || windows_or_buffers_changed
13748 || cursor_type_changed
13749 /* Don't use try_window_reusing_current_matrix in this case
13750 because it can have changed the buffer. */
13751 || !NILP (Vwindow_scroll_functions
)
13752 || !just_this_one_p
13753 || MINI_WINDOW_P (w
)
13754 || !(used_current_matrix_p
13755 = try_window_reusing_current_matrix (w
)))
13756 try_window (window
, startp
, 0);
13758 /* If new fonts have been loaded (due to fontsets), give up. We
13759 have to start a new redisplay since we need to re-adjust glyph
13761 if (fonts_changed_p
)
13762 goto need_larger_matrices
;
13764 /* If cursor did not appear assume that the middle of the window is
13765 in the first line of the window. Do it again with the next line.
13766 (Imagine a window of height 100, displaying two lines of height
13767 60. Moving back 50 from it->last_visible_y will end in the first
13769 if (w
->cursor
.vpos
< 0)
13771 if (!NILP (w
->window_end_valid
)
13772 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13774 clear_glyph_matrix (w
->desired_matrix
);
13775 move_it_by_lines (&it
, 1, 0);
13776 try_window (window
, it
.current
.pos
, 0);
13778 else if (PT
< IT_CHARPOS (it
))
13780 clear_glyph_matrix (w
->desired_matrix
);
13781 move_it_by_lines (&it
, -1, 0);
13782 try_window (window
, it
.current
.pos
, 0);
13786 /* Not much we can do about it. */
13790 /* Consider the following case: Window starts at BEGV, there is
13791 invisible, intangible text at BEGV, so that display starts at
13792 some point START > BEGV. It can happen that we are called with
13793 PT somewhere between BEGV and START. Try to handle that case. */
13794 if (w
->cursor
.vpos
< 0)
13796 struct glyph_row
*row
= w
->current_matrix
->rows
;
13797 if (row
->mode_line_p
)
13799 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13802 if (!cursor_row_fully_visible_p (w
, 0, 0))
13804 /* If vscroll is enabled, disable it and try again. */
13808 clear_glyph_matrix (w
->desired_matrix
);
13812 /* If centering point failed to make the whole line visible,
13813 put point at the top instead. That has to make the whole line
13814 visible, if it can be done. */
13815 if (centering_position
== 0)
13818 clear_glyph_matrix (w
->desired_matrix
);
13819 centering_position
= 0;
13825 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13826 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13827 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13830 /* Display the mode line, if we must. */
13831 if ((update_mode_line
13832 /* If window not full width, must redo its mode line
13833 if (a) the window to its side is being redone and
13834 (b) we do a frame-based redisplay. This is a consequence
13835 of how inverted lines are drawn in frame-based redisplay. */
13836 || (!just_this_one_p
13837 && !FRAME_WINDOW_P (f
)
13838 && !WINDOW_FULL_WIDTH_P (w
))
13839 /* Line number to display. */
13840 || INTEGERP (w
->base_line_pos
)
13841 /* Column number is displayed and different from the one displayed. */
13842 || (!NILP (w
->column_number_displayed
)
13843 && (XFASTINT (w
->column_number_displayed
)
13844 != (int) current_column ()))) /* iftc */
13845 /* This means that the window has a mode line. */
13846 && (WINDOW_WANTS_MODELINE_P (w
)
13847 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13849 display_mode_lines (w
);
13851 /* If mode line height has changed, arrange for a thorough
13852 immediate redisplay using the correct mode line height. */
13853 if (WINDOW_WANTS_MODELINE_P (w
)
13854 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13856 fonts_changed_p
= 1;
13857 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13858 = DESIRED_MODE_LINE_HEIGHT (w
);
13861 /* If top line height has changed, arrange for a thorough
13862 immediate redisplay using the correct mode line height. */
13863 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13864 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13866 fonts_changed_p
= 1;
13867 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13868 = DESIRED_HEADER_LINE_HEIGHT (w
);
13871 if (fonts_changed_p
)
13872 goto need_larger_matrices
;
13875 if (!line_number_displayed
13876 && !BUFFERP (w
->base_line_pos
))
13878 w
->base_line_pos
= Qnil
;
13879 w
->base_line_number
= Qnil
;
13884 /* When we reach a frame's selected window, redo the frame's menu bar. */
13885 if (update_mode_line
13886 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13888 int redisplay_menu_p
= 0;
13889 int redisplay_tool_bar_p
= 0;
13891 if (FRAME_WINDOW_P (f
))
13893 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13894 || defined (HAVE_NS) || defined (USE_GTK)
13895 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13897 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13901 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13903 if (redisplay_menu_p
)
13904 display_menu_bar (w
);
13906 #ifdef HAVE_WINDOW_SYSTEM
13907 if (FRAME_WINDOW_P (f
))
13909 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
13910 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13912 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13913 && (FRAME_TOOL_BAR_LINES (f
) > 0
13914 || !NILP (Vauto_resize_tool_bars
));
13917 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13919 extern int ignore_mouse_drag_p
;
13920 ignore_mouse_drag_p
= 1;
13926 #ifdef HAVE_WINDOW_SYSTEM
13927 if (FRAME_WINDOW_P (f
)
13928 && update_window_fringes (w
, (just_this_one_p
13929 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13930 || w
->pseudo_window_p
)))
13934 if (draw_window_fringes (w
, 1))
13935 x_draw_vertical_border (w
);
13939 #endif /* HAVE_WINDOW_SYSTEM */
13941 /* We go to this label, with fonts_changed_p nonzero,
13942 if it is necessary to try again using larger glyph matrices.
13943 We have to redeem the scroll bar even in this case,
13944 because the loop in redisplay_internal expects that. */
13945 need_larger_matrices
:
13947 finish_scroll_bars
:
13949 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13951 /* Set the thumb's position and size. */
13952 set_vertical_scroll_bar (w
);
13954 /* Note that we actually used the scroll bar attached to this
13955 window, so it shouldn't be deleted at the end of redisplay. */
13956 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13957 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13960 /* Restore current_buffer and value of point in it. */
13961 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13962 set_buffer_internal_1 (old
);
13963 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13964 shorter. This can be caused by log truncation in *Messages*. */
13965 if (CHARPOS (lpoint
) <= ZV
)
13966 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13968 unbind_to (count
, Qnil
);
13972 /* Build the complete desired matrix of WINDOW with a window start
13973 buffer position POS.
13975 Value is 1 if successful. It is zero if fonts were loaded during
13976 redisplay which makes re-adjusting glyph matrices necessary, and -1
13977 if point would appear in the scroll margins.
13978 (We check that only if CHECK_MARGINS is nonzero. */
13981 try_window (window
, pos
, check_margins
)
13982 Lisp_Object window
;
13983 struct text_pos pos
;
13986 struct window
*w
= XWINDOW (window
);
13988 struct glyph_row
*last_text_row
= NULL
;
13989 struct frame
*f
= XFRAME (w
->frame
);
13991 /* Make POS the new window start. */
13992 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
13994 /* Mark cursor position as unknown. No overlay arrow seen. */
13995 w
->cursor
.vpos
= -1;
13996 overlay_arrow_seen
= 0;
13998 /* Initialize iterator and info to start at POS. */
13999 start_display (&it
, w
, pos
);
14001 /* Display all lines of W. */
14002 while (it
.current_y
< it
.last_visible_y
)
14004 if (display_line (&it
))
14005 last_text_row
= it
.glyph_row
- 1;
14006 if (fonts_changed_p
)
14010 /* Don't let the cursor end in the scroll margins. */
14012 && !MINI_WINDOW_P (w
))
14014 int this_scroll_margin
;
14016 if (scroll_margin
> 0)
14018 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14019 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14022 this_scroll_margin
= 0;
14024 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14025 && w
->cursor
.y
< this_scroll_margin
14026 && CHARPOS (pos
) > BEGV
14027 && IT_CHARPOS (it
) < ZV
)
14028 /* rms: considering make_cursor_line_fully_visible_p here
14029 seems to give wrong results. We don't want to recenter
14030 when the last line is partly visible, we want to allow
14031 that case to be handled in the usual way. */
14032 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14034 w
->cursor
.vpos
= -1;
14035 clear_glyph_matrix (w
->desired_matrix
);
14040 /* If bottom moved off end of frame, change mode line percentage. */
14041 if (XFASTINT (w
->window_end_pos
) <= 0
14042 && Z
!= IT_CHARPOS (it
))
14043 w
->update_mode_line
= Qt
;
14045 /* Set window_end_pos to the offset of the last character displayed
14046 on the window from the end of current_buffer. Set
14047 window_end_vpos to its row number. */
14050 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14051 w
->window_end_bytepos
14052 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14054 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14056 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14057 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14058 ->displays_text_p
);
14062 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14063 w
->window_end_pos
= make_number (Z
- ZV
);
14064 w
->window_end_vpos
= make_number (0);
14067 /* But that is not valid info until redisplay finishes. */
14068 w
->window_end_valid
= Qnil
;
14074 /************************************************************************
14075 Window redisplay reusing current matrix when buffer has not changed
14076 ************************************************************************/
14078 /* Try redisplay of window W showing an unchanged buffer with a
14079 different window start than the last time it was displayed by
14080 reusing its current matrix. Value is non-zero if successful.
14081 W->start is the new window start. */
14084 try_window_reusing_current_matrix (w
)
14087 struct frame
*f
= XFRAME (w
->frame
);
14088 struct glyph_row
*row
, *bottom_row
;
14091 struct text_pos start
, new_start
;
14092 int nrows_scrolled
, i
;
14093 struct glyph_row
*last_text_row
;
14094 struct glyph_row
*last_reused_text_row
;
14095 struct glyph_row
*start_row
;
14096 int start_vpos
, min_y
, max_y
;
14099 if (inhibit_try_window_reusing
)
14103 if (/* This function doesn't handle terminal frames. */
14104 !FRAME_WINDOW_P (f
)
14105 /* Don't try to reuse the display if windows have been split
14107 || windows_or_buffers_changed
14108 || cursor_type_changed
)
14111 /* Can't do this if region may have changed. */
14112 if ((!NILP (Vtransient_mark_mode
)
14113 && !NILP (current_buffer
->mark_active
))
14114 || !NILP (w
->region_showing
)
14115 || !NILP (Vshow_trailing_whitespace
))
14118 /* If top-line visibility has changed, give up. */
14119 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14120 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14123 /* Give up if old or new display is scrolled vertically. We could
14124 make this function handle this, but right now it doesn't. */
14125 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14126 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14129 /* The variable new_start now holds the new window start. The old
14130 start `start' can be determined from the current matrix. */
14131 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14132 start
= start_row
->start
.pos
;
14133 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14135 /* Clear the desired matrix for the display below. */
14136 clear_glyph_matrix (w
->desired_matrix
);
14138 if (CHARPOS (new_start
) <= CHARPOS (start
))
14142 /* Don't use this method if the display starts with an ellipsis
14143 displayed for invisible text. It's not easy to handle that case
14144 below, and it's certainly not worth the effort since this is
14145 not a frequent case. */
14146 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14149 IF_DEBUG (debug_method_add (w
, "twu1"));
14151 /* Display up to a row that can be reused. The variable
14152 last_text_row is set to the last row displayed that displays
14153 text. Note that it.vpos == 0 if or if not there is a
14154 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14155 start_display (&it
, w
, new_start
);
14156 first_row_y
= it
.current_y
;
14157 w
->cursor
.vpos
= -1;
14158 last_text_row
= last_reused_text_row
= NULL
;
14160 while (it
.current_y
< it
.last_visible_y
14161 && !fonts_changed_p
)
14163 /* If we have reached into the characters in the START row,
14164 that means the line boundaries have changed. So we
14165 can't start copying with the row START. Maybe it will
14166 work to start copying with the following row. */
14167 while (IT_CHARPOS (it
) > CHARPOS (start
))
14169 /* Advance to the next row as the "start". */
14171 start
= start_row
->start
.pos
;
14172 /* If there are no more rows to try, or just one, give up. */
14173 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14174 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14175 || CHARPOS (start
) == ZV
)
14177 clear_glyph_matrix (w
->desired_matrix
);
14181 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14183 /* If we have reached alignment,
14184 we can copy the rest of the rows. */
14185 if (IT_CHARPOS (it
) == CHARPOS (start
))
14188 if (display_line (&it
))
14189 last_text_row
= it
.glyph_row
- 1;
14192 /* A value of current_y < last_visible_y means that we stopped
14193 at the previous window start, which in turn means that we
14194 have at least one reusable row. */
14195 if (it
.current_y
< it
.last_visible_y
)
14197 /* IT.vpos always starts from 0; it counts text lines. */
14198 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14200 /* Find PT if not already found in the lines displayed. */
14201 if (w
->cursor
.vpos
< 0)
14203 int dy
= it
.current_y
- start_row
->y
;
14205 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14206 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14208 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14209 dy
, nrows_scrolled
);
14212 clear_glyph_matrix (w
->desired_matrix
);
14217 /* Scroll the display. Do it before the current matrix is
14218 changed. The problem here is that update has not yet
14219 run, i.e. part of the current matrix is not up to date.
14220 scroll_run_hook will clear the cursor, and use the
14221 current matrix to get the height of the row the cursor is
14223 run
.current_y
= start_row
->y
;
14224 run
.desired_y
= it
.current_y
;
14225 run
.height
= it
.last_visible_y
- it
.current_y
;
14227 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14230 FRAME_RIF (f
)->update_window_begin_hook (w
);
14231 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14232 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14233 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14237 /* Shift current matrix down by nrows_scrolled lines. */
14238 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14239 rotate_matrix (w
->current_matrix
,
14241 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14244 /* Disable lines that must be updated. */
14245 for (i
= 0; i
< nrows_scrolled
; ++i
)
14246 (start_row
+ i
)->enabled_p
= 0;
14248 /* Re-compute Y positions. */
14249 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14250 max_y
= it
.last_visible_y
;
14251 for (row
= start_row
+ nrows_scrolled
;
14255 row
->y
= it
.current_y
;
14256 row
->visible_height
= row
->height
;
14258 if (row
->y
< min_y
)
14259 row
->visible_height
-= min_y
- row
->y
;
14260 if (row
->y
+ row
->height
> max_y
)
14261 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14262 row
->redraw_fringe_bitmaps_p
= 1;
14264 it
.current_y
+= row
->height
;
14266 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14267 last_reused_text_row
= row
;
14268 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14272 /* Disable lines in the current matrix which are now
14273 below the window. */
14274 for (++row
; row
< bottom_row
; ++row
)
14275 row
->enabled_p
= row
->mode_line_p
= 0;
14278 /* Update window_end_pos etc.; last_reused_text_row is the last
14279 reused row from the current matrix containing text, if any.
14280 The value of last_text_row is the last displayed line
14281 containing text. */
14282 if (last_reused_text_row
)
14284 w
->window_end_bytepos
14285 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14287 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14289 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14290 w
->current_matrix
));
14292 else if (last_text_row
)
14294 w
->window_end_bytepos
14295 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14297 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14299 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14303 /* This window must be completely empty. */
14304 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14305 w
->window_end_pos
= make_number (Z
- ZV
);
14306 w
->window_end_vpos
= make_number (0);
14308 w
->window_end_valid
= Qnil
;
14310 /* Update hint: don't try scrolling again in update_window. */
14311 w
->desired_matrix
->no_scrolling_p
= 1;
14314 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14318 else if (CHARPOS (new_start
) > CHARPOS (start
))
14320 struct glyph_row
*pt_row
, *row
;
14321 struct glyph_row
*first_reusable_row
;
14322 struct glyph_row
*first_row_to_display
;
14324 int yb
= window_text_bottom_y (w
);
14326 /* Find the row starting at new_start, if there is one. Don't
14327 reuse a partially visible line at the end. */
14328 first_reusable_row
= start_row
;
14329 while (first_reusable_row
->enabled_p
14330 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14331 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14332 < CHARPOS (new_start
)))
14333 ++first_reusable_row
;
14335 /* Give up if there is no row to reuse. */
14336 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14337 || !first_reusable_row
->enabled_p
14338 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14339 != CHARPOS (new_start
)))
14342 /* We can reuse fully visible rows beginning with
14343 first_reusable_row to the end of the window. Set
14344 first_row_to_display to the first row that cannot be reused.
14345 Set pt_row to the row containing point, if there is any. */
14347 for (first_row_to_display
= first_reusable_row
;
14348 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14349 ++first_row_to_display
)
14351 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14352 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14353 pt_row
= first_row_to_display
;
14356 /* Start displaying at the start of first_row_to_display. */
14357 xassert (first_row_to_display
->y
< yb
);
14358 init_to_row_start (&it
, w
, first_row_to_display
);
14360 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14362 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14364 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14365 + WINDOW_HEADER_LINE_HEIGHT (w
));
14367 /* Display lines beginning with first_row_to_display in the
14368 desired matrix. Set last_text_row to the last row displayed
14369 that displays text. */
14370 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14371 if (pt_row
== NULL
)
14372 w
->cursor
.vpos
= -1;
14373 last_text_row
= NULL
;
14374 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14375 if (display_line (&it
))
14376 last_text_row
= it
.glyph_row
- 1;
14378 /* Give up If point isn't in a row displayed or reused. */
14379 if (w
->cursor
.vpos
< 0)
14381 clear_glyph_matrix (w
->desired_matrix
);
14385 /* If point is in a reused row, adjust y and vpos of the cursor
14389 w
->cursor
.vpos
-= nrows_scrolled
;
14390 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14393 /* Scroll the display. */
14394 run
.current_y
= first_reusable_row
->y
;
14395 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14396 run
.height
= it
.last_visible_y
- run
.current_y
;
14397 dy
= run
.current_y
- run
.desired_y
;
14402 FRAME_RIF (f
)->update_window_begin_hook (w
);
14403 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14404 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14405 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14409 /* Adjust Y positions of reused rows. */
14410 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14411 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14412 max_y
= it
.last_visible_y
;
14413 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14416 row
->visible_height
= row
->height
;
14417 if (row
->y
< min_y
)
14418 row
->visible_height
-= min_y
- row
->y
;
14419 if (row
->y
+ row
->height
> max_y
)
14420 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14421 row
->redraw_fringe_bitmaps_p
= 1;
14424 /* Scroll the current matrix. */
14425 xassert (nrows_scrolled
> 0);
14426 rotate_matrix (w
->current_matrix
,
14428 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14431 /* Disable rows not reused. */
14432 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14433 row
->enabled_p
= 0;
14435 /* Point may have moved to a different line, so we cannot assume that
14436 the previous cursor position is valid; locate the correct row. */
14439 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14440 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14444 w
->cursor
.y
= row
->y
;
14446 if (row
< bottom_row
)
14448 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14449 while (glyph
->charpos
< PT
)
14452 w
->cursor
.x
+= glyph
->pixel_width
;
14458 /* Adjust window end. A null value of last_text_row means that
14459 the window end is in reused rows which in turn means that
14460 only its vpos can have changed. */
14463 w
->window_end_bytepos
14464 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14466 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14468 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14473 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14476 w
->window_end_valid
= Qnil
;
14477 w
->desired_matrix
->no_scrolling_p
= 1;
14480 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14490 /************************************************************************
14491 Window redisplay reusing current matrix when buffer has changed
14492 ************************************************************************/
14494 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14495 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14497 static struct glyph_row
*
14498 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14499 struct glyph_row
*));
14502 /* Return the last row in MATRIX displaying text. If row START is
14503 non-null, start searching with that row. IT gives the dimensions
14504 of the display. Value is null if matrix is empty; otherwise it is
14505 a pointer to the row found. */
14507 static struct glyph_row
*
14508 find_last_row_displaying_text (matrix
, it
, start
)
14509 struct glyph_matrix
*matrix
;
14511 struct glyph_row
*start
;
14513 struct glyph_row
*row
, *row_found
;
14515 /* Set row_found to the last row in IT->w's current matrix
14516 displaying text. The loop looks funny but think of partially
14519 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14520 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14522 xassert (row
->enabled_p
);
14524 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14533 /* Return the last row in the current matrix of W that is not affected
14534 by changes at the start of current_buffer that occurred since W's
14535 current matrix was built. Value is null if no such row exists.
14537 BEG_UNCHANGED us the number of characters unchanged at the start of
14538 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14539 first changed character in current_buffer. Characters at positions <
14540 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14541 when the current matrix was built. */
14543 static struct glyph_row
*
14544 find_last_unchanged_at_beg_row (w
)
14547 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14548 struct glyph_row
*row
;
14549 struct glyph_row
*row_found
= NULL
;
14550 int yb
= window_text_bottom_y (w
);
14552 /* Find the last row displaying unchanged text. */
14553 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14554 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14555 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14558 if (/* If row ends before first_changed_pos, it is unchanged,
14559 except in some case. */
14560 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14561 /* When row ends in ZV and we write at ZV it is not
14563 && !row
->ends_at_zv_p
14564 /* When first_changed_pos is the end of a continued line,
14565 row is not unchanged because it may be no longer
14567 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14568 && (row
->continued_p
14569 || row
->exact_window_width_line_p
)))
14572 /* Stop if last visible row. */
14573 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14581 /* Find the first glyph row in the current matrix of W that is not
14582 affected by changes at the end of current_buffer since the
14583 time W's current matrix was built.
14585 Return in *DELTA the number of chars by which buffer positions in
14586 unchanged text at the end of current_buffer must be adjusted.
14588 Return in *DELTA_BYTES the corresponding number of bytes.
14590 Value is null if no such row exists, i.e. all rows are affected by
14593 static struct glyph_row
*
14594 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14596 int *delta
, *delta_bytes
;
14598 struct glyph_row
*row
;
14599 struct glyph_row
*row_found
= NULL
;
14601 *delta
= *delta_bytes
= 0;
14603 /* Display must not have been paused, otherwise the current matrix
14604 is not up to date. */
14605 eassert (!NILP (w
->window_end_valid
));
14607 /* A value of window_end_pos >= END_UNCHANGED means that the window
14608 end is in the range of changed text. If so, there is no
14609 unchanged row at the end of W's current matrix. */
14610 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14613 /* Set row to the last row in W's current matrix displaying text. */
14614 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14616 /* If matrix is entirely empty, no unchanged row exists. */
14617 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14619 /* The value of row is the last glyph row in the matrix having a
14620 meaningful buffer position in it. The end position of row
14621 corresponds to window_end_pos. This allows us to translate
14622 buffer positions in the current matrix to current buffer
14623 positions for characters not in changed text. */
14624 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14625 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14626 int last_unchanged_pos
, last_unchanged_pos_old
;
14627 struct glyph_row
*first_text_row
14628 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14630 *delta
= Z
- Z_old
;
14631 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14633 /* Set last_unchanged_pos to the buffer position of the last
14634 character in the buffer that has not been changed. Z is the
14635 index + 1 of the last character in current_buffer, i.e. by
14636 subtracting END_UNCHANGED we get the index of the last
14637 unchanged character, and we have to add BEG to get its buffer
14639 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14640 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14642 /* Search backward from ROW for a row displaying a line that
14643 starts at a minimum position >= last_unchanged_pos_old. */
14644 for (; row
> first_text_row
; --row
)
14646 /* This used to abort, but it can happen.
14647 It is ok to just stop the search instead here. KFS. */
14648 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14651 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14656 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14662 /* Make sure that glyph rows in the current matrix of window W
14663 reference the same glyph memory as corresponding rows in the
14664 frame's frame matrix. This function is called after scrolling W's
14665 current matrix on a terminal frame in try_window_id and
14666 try_window_reusing_current_matrix. */
14669 sync_frame_with_window_matrix_rows (w
)
14672 struct frame
*f
= XFRAME (w
->frame
);
14673 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14675 /* Preconditions: W must be a leaf window and full-width. Its frame
14676 must have a frame matrix. */
14677 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14678 xassert (WINDOW_FULL_WIDTH_P (w
));
14679 xassert (!FRAME_WINDOW_P (f
));
14681 /* If W is a full-width window, glyph pointers in W's current matrix
14682 have, by definition, to be the same as glyph pointers in the
14683 corresponding frame matrix. Note that frame matrices have no
14684 marginal areas (see build_frame_matrix). */
14685 window_row
= w
->current_matrix
->rows
;
14686 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14687 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14688 while (window_row
< window_row_end
)
14690 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14691 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14693 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14694 frame_row
->glyphs
[TEXT_AREA
] = start
;
14695 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14696 frame_row
->glyphs
[LAST_AREA
] = end
;
14698 /* Disable frame rows whose corresponding window rows have
14699 been disabled in try_window_id. */
14700 if (!window_row
->enabled_p
)
14701 frame_row
->enabled_p
= 0;
14703 ++window_row
, ++frame_row
;
14708 /* Find the glyph row in window W containing CHARPOS. Consider all
14709 rows between START and END (not inclusive). END null means search
14710 all rows to the end of the display area of W. Value is the row
14711 containing CHARPOS or null. */
14714 row_containing_pos (w
, charpos
, start
, end
, dy
)
14717 struct glyph_row
*start
, *end
;
14720 struct glyph_row
*row
= start
;
14723 /* If we happen to start on a header-line, skip that. */
14724 if (row
->mode_line_p
)
14727 if ((end
&& row
>= end
) || !row
->enabled_p
)
14730 last_y
= window_text_bottom_y (w
) - dy
;
14734 /* Give up if we have gone too far. */
14735 if (end
&& row
>= end
)
14737 /* This formerly returned if they were equal.
14738 I think that both quantities are of a "last plus one" type;
14739 if so, when they are equal, the row is within the screen. -- rms. */
14740 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14743 /* If it is in this row, return this row. */
14744 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14745 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14746 /* The end position of a row equals the start
14747 position of the next row. If CHARPOS is there, we
14748 would rather display it in the next line, except
14749 when this line ends in ZV. */
14750 && !row
->ends_at_zv_p
14751 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14752 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14759 /* Try to redisplay window W by reusing its existing display. W's
14760 current matrix must be up to date when this function is called,
14761 i.e. window_end_valid must not be nil.
14765 1 if display has been updated
14766 0 if otherwise unsuccessful
14767 -1 if redisplay with same window start is known not to succeed
14769 The following steps are performed:
14771 1. Find the last row in the current matrix of W that is not
14772 affected by changes at the start of current_buffer. If no such row
14775 2. Find the first row in W's current matrix that is not affected by
14776 changes at the end of current_buffer. Maybe there is no such row.
14778 3. Display lines beginning with the row + 1 found in step 1 to the
14779 row found in step 2 or, if step 2 didn't find a row, to the end of
14782 4. If cursor is not known to appear on the window, give up.
14784 5. If display stopped at the row found in step 2, scroll the
14785 display and current matrix as needed.
14787 6. Maybe display some lines at the end of W, if we must. This can
14788 happen under various circumstances, like a partially visible line
14789 becoming fully visible, or because newly displayed lines are displayed
14790 in smaller font sizes.
14792 7. Update W's window end information. */
14798 struct frame
*f
= XFRAME (w
->frame
);
14799 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14800 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14801 struct glyph_row
*last_unchanged_at_beg_row
;
14802 struct glyph_row
*first_unchanged_at_end_row
;
14803 struct glyph_row
*row
;
14804 struct glyph_row
*bottom_row
;
14807 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14808 struct text_pos start_pos
;
14810 int first_unchanged_at_end_vpos
= 0;
14811 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14812 struct text_pos start
;
14813 int first_changed_charpos
, last_changed_charpos
;
14816 if (inhibit_try_window_id
)
14820 /* This is handy for debugging. */
14822 #define GIVE_UP(X) \
14824 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14828 #define GIVE_UP(X) return 0
14831 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14833 /* Don't use this for mini-windows because these can show
14834 messages and mini-buffers, and we don't handle that here. */
14835 if (MINI_WINDOW_P (w
))
14838 /* This flag is used to prevent redisplay optimizations. */
14839 if (windows_or_buffers_changed
|| cursor_type_changed
)
14842 /* Verify that narrowing has not changed.
14843 Also verify that we were not told to prevent redisplay optimizations.
14844 It would be nice to further
14845 reduce the number of cases where this prevents try_window_id. */
14846 if (current_buffer
->clip_changed
14847 || current_buffer
->prevent_redisplay_optimizations_p
)
14850 /* Window must either use window-based redisplay or be full width. */
14851 if (!FRAME_WINDOW_P (f
)
14852 && (!FRAME_LINE_INS_DEL_OK (f
)
14853 || !WINDOW_FULL_WIDTH_P (w
)))
14856 /* Give up if point is not known NOT to appear in W. */
14857 if (PT
< CHARPOS (start
))
14860 /* Another way to prevent redisplay optimizations. */
14861 if (XFASTINT (w
->last_modified
) == 0)
14864 /* Verify that window is not hscrolled. */
14865 if (XFASTINT (w
->hscroll
) != 0)
14868 /* Verify that display wasn't paused. */
14869 if (NILP (w
->window_end_valid
))
14872 /* Can't use this if highlighting a region because a cursor movement
14873 will do more than just set the cursor. */
14874 if (!NILP (Vtransient_mark_mode
)
14875 && !NILP (current_buffer
->mark_active
))
14878 /* Likewise if highlighting trailing whitespace. */
14879 if (!NILP (Vshow_trailing_whitespace
))
14882 /* Likewise if showing a region. */
14883 if (!NILP (w
->region_showing
))
14886 /* Can use this if overlay arrow position and or string have changed. */
14887 if (overlay_arrows_changed_p ())
14890 /* When word-wrap is on, adding a space to the first word of a
14891 wrapped line can change the wrap position, altering the line
14892 above it. It might be worthwhile to handle this more
14893 intelligently, but for now just redisplay from scratch. */
14894 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14897 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14898 only if buffer has really changed. The reason is that the gap is
14899 initially at Z for freshly visited files. The code below would
14900 set end_unchanged to 0 in that case. */
14901 if (MODIFF
> SAVE_MODIFF
14902 /* This seems to happen sometimes after saving a buffer. */
14903 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14905 if (GPT
- BEG
< BEG_UNCHANGED
)
14906 BEG_UNCHANGED
= GPT
- BEG
;
14907 if (Z
- GPT
< END_UNCHANGED
)
14908 END_UNCHANGED
= Z
- GPT
;
14911 /* The position of the first and last character that has been changed. */
14912 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14913 last_changed_charpos
= Z
- END_UNCHANGED
;
14915 /* If window starts after a line end, and the last change is in
14916 front of that newline, then changes don't affect the display.
14917 This case happens with stealth-fontification. Note that although
14918 the display is unchanged, glyph positions in the matrix have to
14919 be adjusted, of course. */
14920 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14921 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14922 && ((last_changed_charpos
< CHARPOS (start
)
14923 && CHARPOS (start
) == BEGV
)
14924 || (last_changed_charpos
< CHARPOS (start
) - 1
14925 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14927 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14928 struct glyph_row
*r0
;
14930 /* Compute how many chars/bytes have been added to or removed
14931 from the buffer. */
14932 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14933 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14935 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14937 /* Give up if PT is not in the window. Note that it already has
14938 been checked at the start of try_window_id that PT is not in
14939 front of the window start. */
14940 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14943 /* If window start is unchanged, we can reuse the whole matrix
14944 as is, after adjusting glyph positions. No need to compute
14945 the window end again, since its offset from Z hasn't changed. */
14946 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14947 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14948 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14949 /* PT must not be in a partially visible line. */
14950 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14951 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14953 /* Adjust positions in the glyph matrix. */
14954 if (delta
|| delta_bytes
)
14956 struct glyph_row
*r1
14957 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14958 increment_matrix_positions (w
->current_matrix
,
14959 MATRIX_ROW_VPOS (r0
, current_matrix
),
14960 MATRIX_ROW_VPOS (r1
, current_matrix
),
14961 delta
, delta_bytes
);
14964 /* Set the cursor. */
14965 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14967 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14974 /* Handle the case that changes are all below what is displayed in
14975 the window, and that PT is in the window. This shortcut cannot
14976 be taken if ZV is visible in the window, and text has been added
14977 there that is visible in the window. */
14978 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14979 /* ZV is not visible in the window, or there are no
14980 changes at ZV, actually. */
14981 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
14982 || first_changed_charpos
== last_changed_charpos
))
14984 struct glyph_row
*r0
;
14986 /* Give up if PT is not in the window. Note that it already has
14987 been checked at the start of try_window_id that PT is not in
14988 front of the window start. */
14989 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
14992 /* If window start is unchanged, we can reuse the whole matrix
14993 as is, without changing glyph positions since no text has
14994 been added/removed in front of the window end. */
14995 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14996 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
14997 /* PT must not be in a partially visible line. */
14998 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
14999 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15001 /* We have to compute the window end anew since text
15002 can have been added/removed after it. */
15004 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15005 w
->window_end_bytepos
15006 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15008 /* Set the cursor. */
15009 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15011 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15018 /* Give up if window start is in the changed area.
15020 The condition used to read
15022 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15024 but why that was tested escapes me at the moment. */
15025 if (CHARPOS (start
) >= first_changed_charpos
15026 && CHARPOS (start
) <= last_changed_charpos
)
15029 /* Check that window start agrees with the start of the first glyph
15030 row in its current matrix. Check this after we know the window
15031 start is not in changed text, otherwise positions would not be
15033 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15034 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15037 /* Give up if the window ends in strings. Overlay strings
15038 at the end are difficult to handle, so don't try. */
15039 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15040 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15043 /* Compute the position at which we have to start displaying new
15044 lines. Some of the lines at the top of the window might be
15045 reusable because they are not displaying changed text. Find the
15046 last row in W's current matrix not affected by changes at the
15047 start of current_buffer. Value is null if changes start in the
15048 first line of window. */
15049 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15050 if (last_unchanged_at_beg_row
)
15052 /* Avoid starting to display in the moddle of a character, a TAB
15053 for instance. This is easier than to set up the iterator
15054 exactly, and it's not a frequent case, so the additional
15055 effort wouldn't really pay off. */
15056 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15057 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15058 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15059 --last_unchanged_at_beg_row
;
15061 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15064 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15066 start_pos
= it
.current
.pos
;
15068 /* Start displaying new lines in the desired matrix at the same
15069 vpos we would use in the current matrix, i.e. below
15070 last_unchanged_at_beg_row. */
15071 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15073 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15074 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15076 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15080 /* There are no reusable lines at the start of the window.
15081 Start displaying in the first text line. */
15082 start_display (&it
, w
, start
);
15083 it
.vpos
= it
.first_vpos
;
15084 start_pos
= it
.current
.pos
;
15087 /* Find the first row that is not affected by changes at the end of
15088 the buffer. Value will be null if there is no unchanged row, in
15089 which case we must redisplay to the end of the window. delta
15090 will be set to the value by which buffer positions beginning with
15091 first_unchanged_at_end_row have to be adjusted due to text
15093 first_unchanged_at_end_row
15094 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15095 IF_DEBUG (debug_delta
= delta
);
15096 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15098 /* Set stop_pos to the buffer position up to which we will have to
15099 display new lines. If first_unchanged_at_end_row != NULL, this
15100 is the buffer position of the start of the line displayed in that
15101 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15102 that we don't stop at a buffer position. */
15104 if (first_unchanged_at_end_row
)
15106 xassert (last_unchanged_at_beg_row
== NULL
15107 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15109 /* If this is a continuation line, move forward to the next one
15110 that isn't. Changes in lines above affect this line.
15111 Caution: this may move first_unchanged_at_end_row to a row
15112 not displaying text. */
15113 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15114 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15115 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15116 < it
.last_visible_y
))
15117 ++first_unchanged_at_end_row
;
15119 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15120 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15121 >= it
.last_visible_y
))
15122 first_unchanged_at_end_row
= NULL
;
15125 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15127 first_unchanged_at_end_vpos
15128 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15129 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15132 else if (last_unchanged_at_beg_row
== NULL
)
15138 /* Either there is no unchanged row at the end, or the one we have
15139 now displays text. This is a necessary condition for the window
15140 end pos calculation at the end of this function. */
15141 xassert (first_unchanged_at_end_row
== NULL
15142 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15144 debug_last_unchanged_at_beg_vpos
15145 = (last_unchanged_at_beg_row
15146 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15148 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15150 #endif /* GLYPH_DEBUG != 0 */
15153 /* Display new lines. Set last_text_row to the last new line
15154 displayed which has text on it, i.e. might end up as being the
15155 line where the window_end_vpos is. */
15156 w
->cursor
.vpos
= -1;
15157 last_text_row
= NULL
;
15158 overlay_arrow_seen
= 0;
15159 while (it
.current_y
< it
.last_visible_y
15160 && !fonts_changed_p
15161 && (first_unchanged_at_end_row
== NULL
15162 || IT_CHARPOS (it
) < stop_pos
))
15164 if (display_line (&it
))
15165 last_text_row
= it
.glyph_row
- 1;
15168 if (fonts_changed_p
)
15172 /* Compute differences in buffer positions, y-positions etc. for
15173 lines reused at the bottom of the window. Compute what we can
15175 if (first_unchanged_at_end_row
15176 /* No lines reused because we displayed everything up to the
15177 bottom of the window. */
15178 && it
.current_y
< it
.last_visible_y
)
15181 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15183 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15184 run
.current_y
= first_unchanged_at_end_row
->y
;
15185 run
.desired_y
= run
.current_y
+ dy
;
15186 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15190 delta
= delta_bytes
= dvpos
= dy
15191 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15192 first_unchanged_at_end_row
= NULL
;
15194 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15197 /* Find the cursor if not already found. We have to decide whether
15198 PT will appear on this window (it sometimes doesn't, but this is
15199 not a very frequent case.) This decision has to be made before
15200 the current matrix is altered. A value of cursor.vpos < 0 means
15201 that PT is either in one of the lines beginning at
15202 first_unchanged_at_end_row or below the window. Don't care for
15203 lines that might be displayed later at the window end; as
15204 mentioned, this is not a frequent case. */
15205 if (w
->cursor
.vpos
< 0)
15207 /* Cursor in unchanged rows at the top? */
15208 if (PT
< CHARPOS (start_pos
)
15209 && last_unchanged_at_beg_row
)
15211 row
= row_containing_pos (w
, PT
,
15212 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15213 last_unchanged_at_beg_row
+ 1, 0);
15215 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15218 /* Start from first_unchanged_at_end_row looking for PT. */
15219 else if (first_unchanged_at_end_row
)
15221 row
= row_containing_pos (w
, PT
- delta
,
15222 first_unchanged_at_end_row
, NULL
, 0);
15224 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15225 delta_bytes
, dy
, dvpos
);
15228 /* Give up if cursor was not found. */
15229 if (w
->cursor
.vpos
< 0)
15231 clear_glyph_matrix (w
->desired_matrix
);
15236 /* Don't let the cursor end in the scroll margins. */
15238 int this_scroll_margin
, cursor_height
;
15240 this_scroll_margin
= max (0, scroll_margin
);
15241 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15242 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15243 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15245 if ((w
->cursor
.y
< this_scroll_margin
15246 && CHARPOS (start
) > BEGV
)
15247 /* Old redisplay didn't take scroll margin into account at the bottom,
15248 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15249 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15250 ? cursor_height
+ this_scroll_margin
15251 : 1)) > it
.last_visible_y
)
15253 w
->cursor
.vpos
= -1;
15254 clear_glyph_matrix (w
->desired_matrix
);
15259 /* Scroll the display. Do it before changing the current matrix so
15260 that xterm.c doesn't get confused about where the cursor glyph is
15262 if (dy
&& run
.height
)
15266 if (FRAME_WINDOW_P (f
))
15268 FRAME_RIF (f
)->update_window_begin_hook (w
);
15269 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15270 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15271 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15275 /* Terminal frame. In this case, dvpos gives the number of
15276 lines to scroll by; dvpos < 0 means scroll up. */
15277 int first_unchanged_at_end_vpos
15278 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15279 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15280 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15281 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15282 + window_internal_height (w
));
15284 /* Perform the operation on the screen. */
15287 /* Scroll last_unchanged_at_beg_row to the end of the
15288 window down dvpos lines. */
15289 set_terminal_window (f
, end
);
15291 /* On dumb terminals delete dvpos lines at the end
15292 before inserting dvpos empty lines. */
15293 if (!FRAME_SCROLL_REGION_OK (f
))
15294 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15296 /* Insert dvpos empty lines in front of
15297 last_unchanged_at_beg_row. */
15298 ins_del_lines (f
, from
, dvpos
);
15300 else if (dvpos
< 0)
15302 /* Scroll up last_unchanged_at_beg_vpos to the end of
15303 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15304 set_terminal_window (f
, end
);
15306 /* Delete dvpos lines in front of
15307 last_unchanged_at_beg_vpos. ins_del_lines will set
15308 the cursor to the given vpos and emit |dvpos| delete
15310 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15312 /* On a dumb terminal insert dvpos empty lines at the
15314 if (!FRAME_SCROLL_REGION_OK (f
))
15315 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15318 set_terminal_window (f
, 0);
15324 /* Shift reused rows of the current matrix to the right position.
15325 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15327 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15328 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15331 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15332 bottom_vpos
, dvpos
);
15333 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15336 else if (dvpos
> 0)
15338 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15339 bottom_vpos
, dvpos
);
15340 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15341 first_unchanged_at_end_vpos
+ dvpos
, 0);
15344 /* For frame-based redisplay, make sure that current frame and window
15345 matrix are in sync with respect to glyph memory. */
15346 if (!FRAME_WINDOW_P (f
))
15347 sync_frame_with_window_matrix_rows (w
);
15349 /* Adjust buffer positions in reused rows. */
15350 if (delta
|| delta_bytes
)
15351 increment_matrix_positions (current_matrix
,
15352 first_unchanged_at_end_vpos
+ dvpos
,
15353 bottom_vpos
, delta
, delta_bytes
);
15355 /* Adjust Y positions. */
15357 shift_glyph_matrix (w
, current_matrix
,
15358 first_unchanged_at_end_vpos
+ dvpos
,
15361 if (first_unchanged_at_end_row
)
15363 first_unchanged_at_end_row
+= dvpos
;
15364 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15365 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15366 first_unchanged_at_end_row
= NULL
;
15369 /* If scrolling up, there may be some lines to display at the end of
15371 last_text_row_at_end
= NULL
;
15374 /* Scrolling up can leave for example a partially visible line
15375 at the end of the window to be redisplayed. */
15376 /* Set last_row to the glyph row in the current matrix where the
15377 window end line is found. It has been moved up or down in
15378 the matrix by dvpos. */
15379 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15380 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15382 /* If last_row is the window end line, it should display text. */
15383 xassert (last_row
->displays_text_p
);
15385 /* If window end line was partially visible before, begin
15386 displaying at that line. Otherwise begin displaying with the
15387 line following it. */
15388 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15390 init_to_row_start (&it
, w
, last_row
);
15391 it
.vpos
= last_vpos
;
15392 it
.current_y
= last_row
->y
;
15396 init_to_row_end (&it
, w
, last_row
);
15397 it
.vpos
= 1 + last_vpos
;
15398 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15402 /* We may start in a continuation line. If so, we have to
15403 get the right continuation_lines_width and current_x. */
15404 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15405 it
.hpos
= it
.current_x
= 0;
15407 /* Display the rest of the lines at the window end. */
15408 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15409 while (it
.current_y
< it
.last_visible_y
15410 && !fonts_changed_p
)
15412 /* Is it always sure that the display agrees with lines in
15413 the current matrix? I don't think so, so we mark rows
15414 displayed invalid in the current matrix by setting their
15415 enabled_p flag to zero. */
15416 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15417 if (display_line (&it
))
15418 last_text_row_at_end
= it
.glyph_row
- 1;
15422 /* Update window_end_pos and window_end_vpos. */
15423 if (first_unchanged_at_end_row
15424 && !last_text_row_at_end
)
15426 /* Window end line if one of the preserved rows from the current
15427 matrix. Set row to the last row displaying text in current
15428 matrix starting at first_unchanged_at_end_row, after
15430 xassert (first_unchanged_at_end_row
->displays_text_p
);
15431 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15432 first_unchanged_at_end_row
);
15433 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15435 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15436 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15438 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15439 xassert (w
->window_end_bytepos
>= 0);
15440 IF_DEBUG (debug_method_add (w
, "A"));
15442 else if (last_text_row_at_end
)
15445 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15446 w
->window_end_bytepos
15447 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15449 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15450 xassert (w
->window_end_bytepos
>= 0);
15451 IF_DEBUG (debug_method_add (w
, "B"));
15453 else if (last_text_row
)
15455 /* We have displayed either to the end of the window or at the
15456 end of the window, i.e. the last row with text is to be found
15457 in the desired matrix. */
15459 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15460 w
->window_end_bytepos
15461 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15463 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15464 xassert (w
->window_end_bytepos
>= 0);
15466 else if (first_unchanged_at_end_row
== NULL
15467 && last_text_row
== NULL
15468 && last_text_row_at_end
== NULL
)
15470 /* Displayed to end of window, but no line containing text was
15471 displayed. Lines were deleted at the end of the window. */
15472 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15473 int vpos
= XFASTINT (w
->window_end_vpos
);
15474 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15475 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15478 row
== NULL
&& vpos
>= first_vpos
;
15479 --vpos
, --current_row
, --desired_row
)
15481 if (desired_row
->enabled_p
)
15483 if (desired_row
->displays_text_p
)
15486 else if (current_row
->displays_text_p
)
15490 xassert (row
!= NULL
);
15491 w
->window_end_vpos
= make_number (vpos
+ 1);
15492 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15493 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15494 xassert (w
->window_end_bytepos
>= 0);
15495 IF_DEBUG (debug_method_add (w
, "C"));
15500 #if 0 /* This leads to problems, for instance when the cursor is
15501 at ZV, and the cursor line displays no text. */
15502 /* Disable rows below what's displayed in the window. This makes
15503 debugging easier. */
15504 enable_glyph_matrix_rows (current_matrix
,
15505 XFASTINT (w
->window_end_vpos
) + 1,
15509 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15510 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15512 /* Record that display has not been completed. */
15513 w
->window_end_valid
= Qnil
;
15514 w
->desired_matrix
->no_scrolling_p
= 1;
15522 /***********************************************************************
15523 More debugging support
15524 ***********************************************************************/
15528 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15529 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15530 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15533 /* Dump the contents of glyph matrix MATRIX on stderr.
15535 GLYPHS 0 means don't show glyph contents.
15536 GLYPHS 1 means show glyphs in short form
15537 GLYPHS > 1 means show glyphs in long form. */
15540 dump_glyph_matrix (matrix
, glyphs
)
15541 struct glyph_matrix
*matrix
;
15545 for (i
= 0; i
< matrix
->nrows
; ++i
)
15546 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15550 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15551 the glyph row and area where the glyph comes from. */
15554 dump_glyph (row
, glyph
, area
)
15555 struct glyph_row
*row
;
15556 struct glyph
*glyph
;
15559 if (glyph
->type
== CHAR_GLYPH
)
15562 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15563 glyph
- row
->glyphs
[TEXT_AREA
],
15566 (BUFFERP (glyph
->object
)
15568 : (STRINGP (glyph
->object
)
15571 glyph
->pixel_width
,
15573 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15577 glyph
->left_box_line_p
,
15578 glyph
->right_box_line_p
);
15580 else if (glyph
->type
== STRETCH_GLYPH
)
15583 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15584 glyph
- row
->glyphs
[TEXT_AREA
],
15587 (BUFFERP (glyph
->object
)
15589 : (STRINGP (glyph
->object
)
15592 glyph
->pixel_width
,
15596 glyph
->left_box_line_p
,
15597 glyph
->right_box_line_p
);
15599 else if (glyph
->type
== IMAGE_GLYPH
)
15602 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15603 glyph
- row
->glyphs
[TEXT_AREA
],
15606 (BUFFERP (glyph
->object
)
15608 : (STRINGP (glyph
->object
)
15611 glyph
->pixel_width
,
15615 glyph
->left_box_line_p
,
15616 glyph
->right_box_line_p
);
15618 else if (glyph
->type
== COMPOSITE_GLYPH
)
15621 " %5d %4c %6d %c %3d 0x%05x",
15622 glyph
- row
->glyphs
[TEXT_AREA
],
15625 (BUFFERP (glyph
->object
)
15627 : (STRINGP (glyph
->object
)
15630 glyph
->pixel_width
,
15632 if (glyph
->u
.cmp
.automatic
)
15635 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
15636 fprintf (stderr
, " . %4d %1.1d%1.1d\n"
15638 glyph
->left_box_line_p
,
15639 glyph
->right_box_line_p
);
15644 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15645 GLYPHS 0 means don't show glyph contents.
15646 GLYPHS 1 means show glyphs in short form
15647 GLYPHS > 1 means show glyphs in long form. */
15650 dump_glyph_row (row
, vpos
, glyphs
)
15651 struct glyph_row
*row
;
15656 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15657 fprintf (stderr
, "======================================================================\n");
15659 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15660 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15662 MATRIX_ROW_START_CHARPOS (row
),
15663 MATRIX_ROW_END_CHARPOS (row
),
15664 row
->used
[TEXT_AREA
],
15665 row
->contains_overlapping_glyphs_p
,
15667 row
->truncated_on_left_p
,
15668 row
->truncated_on_right_p
,
15670 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15671 row
->displays_text_p
,
15674 row
->ends_in_middle_of_char_p
,
15675 row
->starts_in_middle_of_char_p
,
15681 row
->visible_height
,
15684 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15685 row
->end
.overlay_string_index
,
15686 row
->continuation_lines_width
);
15687 fprintf (stderr
, "%9d %5d\n",
15688 CHARPOS (row
->start
.string_pos
),
15689 CHARPOS (row
->end
.string_pos
));
15690 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15691 row
->end
.dpvec_index
);
15698 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15700 struct glyph
*glyph
= row
->glyphs
[area
];
15701 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15703 /* Glyph for a line end in text. */
15704 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15707 if (glyph
< glyph_end
)
15708 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15710 for (; glyph
< glyph_end
; ++glyph
)
15711 dump_glyph (row
, glyph
, area
);
15714 else if (glyphs
== 1)
15718 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15720 char *s
= (char *) alloca (row
->used
[area
] + 1);
15723 for (i
= 0; i
< row
->used
[area
]; ++i
)
15725 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15726 if (glyph
->type
== CHAR_GLYPH
15727 && glyph
->u
.ch
< 0x80
15728 && glyph
->u
.ch
>= ' ')
15729 s
[i
] = glyph
->u
.ch
;
15735 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15741 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15742 Sdump_glyph_matrix
, 0, 1, "p",
15743 doc
: /* Dump the current matrix of the selected window to stderr.
15744 Shows contents of glyph row structures. With non-nil
15745 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15746 glyphs in short form, otherwise show glyphs in long form. */)
15748 Lisp_Object glyphs
;
15750 struct window
*w
= XWINDOW (selected_window
);
15751 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15753 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15754 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15755 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15756 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15757 fprintf (stderr
, "=============================================\n");
15758 dump_glyph_matrix (w
->current_matrix
,
15759 NILP (glyphs
) ? 0 : XINT (glyphs
));
15764 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15765 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15768 struct frame
*f
= XFRAME (selected_frame
);
15769 dump_glyph_matrix (f
->current_matrix
, 1);
15774 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15775 doc
: /* Dump glyph row ROW to stderr.
15776 GLYPH 0 means don't dump glyphs.
15777 GLYPH 1 means dump glyphs in short form.
15778 GLYPH > 1 or omitted means dump glyphs in long form. */)
15780 Lisp_Object row
, glyphs
;
15782 struct glyph_matrix
*matrix
;
15785 CHECK_NUMBER (row
);
15786 matrix
= XWINDOW (selected_window
)->current_matrix
;
15788 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15789 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15791 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15796 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15797 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15798 GLYPH 0 means don't dump glyphs.
15799 GLYPH 1 means dump glyphs in short form.
15800 GLYPH > 1 or omitted means dump glyphs in long form. */)
15802 Lisp_Object row
, glyphs
;
15804 struct frame
*sf
= SELECTED_FRAME ();
15805 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15808 CHECK_NUMBER (row
);
15810 if (vpos
>= 0 && vpos
< m
->nrows
)
15811 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15812 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15817 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15818 doc
: /* Toggle tracing of redisplay.
15819 With ARG, turn tracing on if and only if ARG is positive. */)
15824 trace_redisplay_p
= !trace_redisplay_p
;
15827 arg
= Fprefix_numeric_value (arg
);
15828 trace_redisplay_p
= XINT (arg
) > 0;
15835 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15836 doc
: /* Like `format', but print result to stderr.
15837 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15842 Lisp_Object s
= Fformat (nargs
, args
);
15843 fprintf (stderr
, "%s", SDATA (s
));
15847 #endif /* GLYPH_DEBUG */
15851 /***********************************************************************
15852 Building Desired Matrix Rows
15853 ***********************************************************************/
15855 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15856 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15858 static struct glyph_row
*
15859 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15861 Lisp_Object overlay_arrow_string
;
15863 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15864 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15865 struct buffer
*old
= current_buffer
;
15866 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15867 int arrow_len
= SCHARS (overlay_arrow_string
);
15868 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15869 const unsigned char *p
;
15872 int n_glyphs_before
;
15874 set_buffer_temp (buffer
);
15875 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15876 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15877 SET_TEXT_POS (it
.position
, 0, 0);
15879 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15881 while (p
< arrow_end
)
15883 Lisp_Object face
, ilisp
;
15885 /* Get the next character. */
15887 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15889 it
.c
= *p
, it
.len
= 1;
15892 /* Get its face. */
15893 ilisp
= make_number (p
- arrow_string
);
15894 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15895 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15897 /* Compute its width, get its glyphs. */
15898 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15899 SET_TEXT_POS (it
.position
, -1, -1);
15900 PRODUCE_GLYPHS (&it
);
15902 /* If this character doesn't fit any more in the line, we have
15903 to remove some glyphs. */
15904 if (it
.current_x
> it
.last_visible_x
)
15906 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15911 set_buffer_temp (old
);
15912 return it
.glyph_row
;
15916 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15917 glyphs are only inserted for terminal frames since we can't really
15918 win with truncation glyphs when partially visible glyphs are
15919 involved. Which glyphs to insert is determined by
15920 produce_special_glyphs. */
15923 insert_left_trunc_glyphs (it
)
15926 struct it truncate_it
;
15927 struct glyph
*from
, *end
, *to
, *toend
;
15929 xassert (!FRAME_WINDOW_P (it
->f
));
15931 /* Get the truncation glyphs. */
15933 truncate_it
.current_x
= 0;
15934 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15935 truncate_it
.glyph_row
= &scratch_glyph_row
;
15936 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15937 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15938 truncate_it
.object
= make_number (0);
15939 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15941 /* Overwrite glyphs from IT with truncation glyphs. */
15942 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15943 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15944 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15945 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15950 /* There may be padding glyphs left over. Overwrite them too. */
15951 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15953 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15959 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15963 /* Compute the pixel height and width of IT->glyph_row.
15965 Most of the time, ascent and height of a display line will be equal
15966 to the max_ascent and max_height values of the display iterator
15967 structure. This is not the case if
15969 1. We hit ZV without displaying anything. In this case, max_ascent
15970 and max_height will be zero.
15972 2. We have some glyphs that don't contribute to the line height.
15973 (The glyph row flag contributes_to_line_height_p is for future
15974 pixmap extensions).
15976 The first case is easily covered by using default values because in
15977 these cases, the line height does not really matter, except that it
15978 must not be zero. */
15981 compute_line_metrics (it
)
15984 struct glyph_row
*row
= it
->glyph_row
;
15987 if (FRAME_WINDOW_P (it
->f
))
15989 int i
, min_y
, max_y
;
15991 /* The line may consist of one space only, that was added to
15992 place the cursor on it. If so, the row's height hasn't been
15994 if (row
->height
== 0)
15996 if (it
->max_ascent
+ it
->max_descent
== 0)
15997 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
15998 row
->ascent
= it
->max_ascent
;
15999 row
->height
= it
->max_ascent
+ it
->max_descent
;
16000 row
->phys_ascent
= it
->max_phys_ascent
;
16001 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16002 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16005 /* Compute the width of this line. */
16006 row
->pixel_width
= row
->x
;
16007 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16008 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16010 xassert (row
->pixel_width
>= 0);
16011 xassert (row
->ascent
>= 0 && row
->height
> 0);
16013 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16014 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16016 /* If first line's physical ascent is larger than its logical
16017 ascent, use the physical ascent, and make the row taller.
16018 This makes accented characters fully visible. */
16019 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16020 && row
->phys_ascent
> row
->ascent
)
16022 row
->height
+= row
->phys_ascent
- row
->ascent
;
16023 row
->ascent
= row
->phys_ascent
;
16026 /* Compute how much of the line is visible. */
16027 row
->visible_height
= row
->height
;
16029 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16030 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16032 if (row
->y
< min_y
)
16033 row
->visible_height
-= min_y
- row
->y
;
16034 if (row
->y
+ row
->height
> max_y
)
16035 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16039 row
->pixel_width
= row
->used
[TEXT_AREA
];
16040 if (row
->continued_p
)
16041 row
->pixel_width
-= it
->continuation_pixel_width
;
16042 else if (row
->truncated_on_right_p
)
16043 row
->pixel_width
-= it
->truncation_pixel_width
;
16044 row
->ascent
= row
->phys_ascent
= 0;
16045 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16046 row
->extra_line_spacing
= 0;
16049 /* Compute a hash code for this row. */
16051 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16052 for (i
= 0; i
< row
->used
[area
]; ++i
)
16053 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16054 + row
->glyphs
[area
][i
].u
.val
16055 + row
->glyphs
[area
][i
].face_id
16056 + row
->glyphs
[area
][i
].padding_p
16057 + (row
->glyphs
[area
][i
].type
<< 2));
16059 it
->max_ascent
= it
->max_descent
= 0;
16060 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16064 /* Append one space to the glyph row of iterator IT if doing a
16065 window-based redisplay. The space has the same face as
16066 IT->face_id. Value is non-zero if a space was added.
16068 This function is called to make sure that there is always one glyph
16069 at the end of a glyph row that the cursor can be set on under
16070 window-systems. (If there weren't such a glyph we would not know
16071 how wide and tall a box cursor should be displayed).
16073 At the same time this space let's a nicely handle clearing to the
16074 end of the line if the row ends in italic text. */
16077 append_space_for_newline (it
, default_face_p
)
16079 int default_face_p
;
16081 if (FRAME_WINDOW_P (it
->f
))
16083 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16085 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16086 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16088 /* Save some values that must not be changed.
16089 Must save IT->c and IT->len because otherwise
16090 ITERATOR_AT_END_P wouldn't work anymore after
16091 append_space_for_newline has been called. */
16092 enum display_element_type saved_what
= it
->what
;
16093 int saved_c
= it
->c
, saved_len
= it
->len
;
16094 int saved_x
= it
->current_x
;
16095 int saved_face_id
= it
->face_id
;
16096 struct text_pos saved_pos
;
16097 Lisp_Object saved_object
;
16100 saved_object
= it
->object
;
16101 saved_pos
= it
->position
;
16103 it
->what
= IT_CHARACTER
;
16104 bzero (&it
->position
, sizeof it
->position
);
16105 it
->object
= make_number (0);
16109 if (default_face_p
)
16110 it
->face_id
= DEFAULT_FACE_ID
;
16111 else if (it
->face_before_selective_p
)
16112 it
->face_id
= it
->saved_face_id
;
16113 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16114 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16116 PRODUCE_GLYPHS (it
);
16118 it
->override_ascent
= -1;
16119 it
->constrain_row_ascent_descent_p
= 0;
16120 it
->current_x
= saved_x
;
16121 it
->object
= saved_object
;
16122 it
->position
= saved_pos
;
16123 it
->what
= saved_what
;
16124 it
->face_id
= saved_face_id
;
16125 it
->len
= saved_len
;
16135 /* Extend the face of the last glyph in the text area of IT->glyph_row
16136 to the end of the display line. Called from display_line.
16137 If the glyph row is empty, add a space glyph to it so that we
16138 know the face to draw. Set the glyph row flag fill_line_p. */
16141 extend_face_to_end_of_line (it
)
16145 struct frame
*f
= it
->f
;
16147 /* If line is already filled, do nothing. */
16148 if (it
->current_x
>= it
->last_visible_x
)
16151 /* Face extension extends the background and box of IT->face_id
16152 to the end of the line. If the background equals the background
16153 of the frame, we don't have to do anything. */
16154 if (it
->face_before_selective_p
)
16155 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16157 face
= FACE_FROM_ID (f
, it
->face_id
);
16159 if (FRAME_WINDOW_P (f
)
16160 && it
->glyph_row
->displays_text_p
16161 && face
->box
== FACE_NO_BOX
16162 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16166 /* Set the glyph row flag indicating that the face of the last glyph
16167 in the text area has to be drawn to the end of the text area. */
16168 it
->glyph_row
->fill_line_p
= 1;
16170 /* If current character of IT is not ASCII, make sure we have the
16171 ASCII face. This will be automatically undone the next time
16172 get_next_display_element returns a multibyte character. Note
16173 that the character will always be single byte in unibyte text. */
16174 if (!ASCII_CHAR_P (it
->c
))
16176 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16179 if (FRAME_WINDOW_P (f
))
16181 /* If the row is empty, add a space with the current face of IT,
16182 so that we know which face to draw. */
16183 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16185 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16186 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16187 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16192 /* Save some values that must not be changed. */
16193 int saved_x
= it
->current_x
;
16194 struct text_pos saved_pos
;
16195 Lisp_Object saved_object
;
16196 enum display_element_type saved_what
= it
->what
;
16197 int saved_face_id
= it
->face_id
;
16199 saved_object
= it
->object
;
16200 saved_pos
= it
->position
;
16202 it
->what
= IT_CHARACTER
;
16203 bzero (&it
->position
, sizeof it
->position
);
16204 it
->object
= make_number (0);
16207 it
->face_id
= face
->id
;
16209 PRODUCE_GLYPHS (it
);
16211 while (it
->current_x
<= it
->last_visible_x
)
16212 PRODUCE_GLYPHS (it
);
16214 /* Don't count these blanks really. It would let us insert a left
16215 truncation glyph below and make us set the cursor on them, maybe. */
16216 it
->current_x
= saved_x
;
16217 it
->object
= saved_object
;
16218 it
->position
= saved_pos
;
16219 it
->what
= saved_what
;
16220 it
->face_id
= saved_face_id
;
16225 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16226 trailing whitespace. */
16229 trailing_whitespace_p (charpos
)
16232 int bytepos
= CHAR_TO_BYTE (charpos
);
16235 while (bytepos
< ZV_BYTE
16236 && (c
= FETCH_CHAR (bytepos
),
16237 c
== ' ' || c
== '\t'))
16240 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16242 if (bytepos
!= PT_BYTE
)
16249 /* Highlight trailing whitespace, if any, in ROW. */
16252 highlight_trailing_whitespace (f
, row
)
16254 struct glyph_row
*row
;
16256 int used
= row
->used
[TEXT_AREA
];
16260 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16261 struct glyph
*glyph
= start
+ used
- 1;
16263 /* Skip over glyphs inserted to display the cursor at the
16264 end of a line, for extending the face of the last glyph
16265 to the end of the line on terminals, and for truncation
16266 and continuation glyphs. */
16267 while (glyph
>= start
16268 && glyph
->type
== CHAR_GLYPH
16269 && INTEGERP (glyph
->object
))
16272 /* If last glyph is a space or stretch, and it's trailing
16273 whitespace, set the face of all trailing whitespace glyphs in
16274 IT->glyph_row to `trailing-whitespace'. */
16276 && BUFFERP (glyph
->object
)
16277 && (glyph
->type
== STRETCH_GLYPH
16278 || (glyph
->type
== CHAR_GLYPH
16279 && glyph
->u
.ch
== ' '))
16280 && trailing_whitespace_p (glyph
->charpos
))
16282 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16286 while (glyph
>= start
16287 && BUFFERP (glyph
->object
)
16288 && (glyph
->type
== STRETCH_GLYPH
16289 || (glyph
->type
== CHAR_GLYPH
16290 && glyph
->u
.ch
== ' ')))
16291 (glyph
--)->face_id
= face_id
;
16297 /* Value is non-zero if glyph row ROW in window W should be
16298 used to hold the cursor. */
16301 cursor_row_p (w
, row
)
16303 struct glyph_row
*row
;
16305 int cursor_row_p
= 1;
16307 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16309 /* Suppose the row ends on a string.
16310 Unless the row is continued, that means it ends on a newline
16311 in the string. If it's anything other than a display string
16312 (e.g. a before-string from an overlay), we don't want the
16313 cursor there. (This heuristic seems to give the optimal
16314 behavior for the various types of multi-line strings.) */
16315 if (CHARPOS (row
->end
.string_pos
) >= 0)
16317 if (row
->continued_p
)
16321 /* Check for `display' property. */
16322 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16323 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16324 struct glyph
*glyph
;
16327 for (glyph
= end
; glyph
>= beg
; --glyph
)
16328 if (STRINGP (glyph
->object
))
16331 = Fget_char_property (make_number (PT
),
16335 && display_prop_string_p (prop
, glyph
->object
));
16340 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16342 /* If the row ends in middle of a real character,
16343 and the line is continued, we want the cursor here.
16344 That's because MATRIX_ROW_END_CHARPOS would equal
16345 PT if PT is before the character. */
16346 if (!row
->ends_in_ellipsis_p
)
16347 cursor_row_p
= row
->continued_p
;
16349 /* If the row ends in an ellipsis, then
16350 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16351 We want that position to be displayed after the ellipsis. */
16354 /* If the row ends at ZV, display the cursor at the end of that
16355 row instead of at the start of the row below. */
16356 else if (row
->ends_at_zv_p
)
16362 return cursor_row_p
;
16367 /* Push the display property PROP so that it will be rendered at the
16368 current position in IT. */
16371 push_display_prop (struct it
*it
, Lisp_Object prop
)
16375 /* Never display a cursor on the prefix. */
16376 it
->avoid_cursor_p
= 1;
16378 if (STRINGP (prop
))
16380 if (SCHARS (prop
) == 0)
16387 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16388 it
->current
.overlay_string_index
= -1;
16389 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16390 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16391 it
->method
= GET_FROM_STRING
;
16392 it
->stop_charpos
= 0;
16394 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16396 it
->method
= GET_FROM_STRETCH
;
16399 #ifdef HAVE_WINDOW_SYSTEM
16400 else if (IMAGEP (prop
))
16402 it
->what
= IT_IMAGE
;
16403 it
->image_id
= lookup_image (it
->f
, prop
);
16404 it
->method
= GET_FROM_IMAGE
;
16406 #endif /* HAVE_WINDOW_SYSTEM */
16409 pop_it (it
); /* bogus display property, give up */
16414 /* Return the character-property PROP at the current position in IT. */
16417 get_it_property (it
, prop
)
16421 Lisp_Object position
;
16423 if (STRINGP (it
->object
))
16424 position
= make_number (IT_STRING_CHARPOS (*it
));
16425 else if (BUFFERP (it
->object
))
16426 position
= make_number (IT_CHARPOS (*it
));
16430 return Fget_char_property (position
, prop
, it
->object
);
16433 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16436 handle_line_prefix (struct it
*it
)
16438 Lisp_Object prefix
;
16439 if (it
->continuation_lines_width
> 0)
16441 prefix
= get_it_property (it
, Qwrap_prefix
);
16443 prefix
= Vwrap_prefix
;
16447 prefix
= get_it_property (it
, Qline_prefix
);
16449 prefix
= Vline_prefix
;
16451 if (! NILP (prefix
))
16452 push_display_prop (it
, prefix
);
16457 /* Construct the glyph row IT->glyph_row in the desired matrix of
16458 IT->w from text at the current position of IT. See dispextern.h
16459 for an overview of struct it. Value is non-zero if
16460 IT->glyph_row displays text, as opposed to a line displaying ZV
16467 struct glyph_row
*row
= it
->glyph_row
;
16468 Lisp_Object overlay_arrow_string
;
16470 int may_wrap
= 0, wrap_x
;
16471 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16472 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16473 int wrap_row_extra_line_spacing
;
16475 /* We always start displaying at hpos zero even if hscrolled. */
16476 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16478 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16479 >= it
->w
->desired_matrix
->nrows
)
16481 it
->w
->nrows_scale_factor
++;
16482 fonts_changed_p
= 1;
16486 /* Is IT->w showing the region? */
16487 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16489 /* Clear the result glyph row and enable it. */
16490 prepare_desired_row (row
);
16492 row
->y
= it
->current_y
;
16493 row
->start
= it
->start
;
16494 row
->continuation_lines_width
= it
->continuation_lines_width
;
16495 row
->displays_text_p
= 1;
16496 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16497 it
->starts_in_middle_of_char_p
= 0;
16499 /* Arrange the overlays nicely for our purposes. Usually, we call
16500 display_line on only one line at a time, in which case this
16501 can't really hurt too much, or we call it on lines which appear
16502 one after another in the buffer, in which case all calls to
16503 recenter_overlay_lists but the first will be pretty cheap. */
16504 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16506 /* Move over display elements that are not visible because we are
16507 hscrolled. This may stop at an x-position < IT->first_visible_x
16508 if the first glyph is partially visible or if we hit a line end. */
16509 if (it
->current_x
< it
->first_visible_x
)
16511 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16512 MOVE_TO_POS
| MOVE_TO_X
);
16516 /* We only do this when not calling `move_it_in_display_line_to'
16517 above, because move_it_in_display_line_to calls
16518 handle_line_prefix itself. */
16519 handle_line_prefix (it
);
16522 /* Get the initial row height. This is either the height of the
16523 text hscrolled, if there is any, or zero. */
16524 row
->ascent
= it
->max_ascent
;
16525 row
->height
= it
->max_ascent
+ it
->max_descent
;
16526 row
->phys_ascent
= it
->max_phys_ascent
;
16527 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16528 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16530 /* Loop generating characters. The loop is left with IT on the next
16531 character to display. */
16534 int n_glyphs_before
, hpos_before
, x_before
;
16536 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16538 /* Retrieve the next thing to display. Value is zero if end of
16540 if (!get_next_display_element (it
))
16542 /* Maybe add a space at the end of this line that is used to
16543 display the cursor there under X. Set the charpos of the
16544 first glyph of blank lines not corresponding to any text
16546 #ifdef HAVE_WINDOW_SYSTEM
16547 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16548 row
->exact_window_width_line_p
= 1;
16550 #endif /* HAVE_WINDOW_SYSTEM */
16551 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16552 || row
->used
[TEXT_AREA
] == 0)
16554 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16555 row
->displays_text_p
= 0;
16557 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16558 && (!MINI_WINDOW_P (it
->w
)
16559 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16560 row
->indicate_empty_line_p
= 1;
16563 it
->continuation_lines_width
= 0;
16564 row
->ends_at_zv_p
= 1;
16568 /* Now, get the metrics of what we want to display. This also
16569 generates glyphs in `row' (which is IT->glyph_row). */
16570 n_glyphs_before
= row
->used
[TEXT_AREA
];
16573 /* Remember the line height so far in case the next element doesn't
16574 fit on the line. */
16575 if (it
->line_wrap
!= TRUNCATE
)
16577 ascent
= it
->max_ascent
;
16578 descent
= it
->max_descent
;
16579 phys_ascent
= it
->max_phys_ascent
;
16580 phys_descent
= it
->max_phys_descent
;
16582 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16584 if (IT_DISPLAYING_WHITESPACE (it
))
16590 wrap_row_used
= row
->used
[TEXT_AREA
];
16591 wrap_row_ascent
= row
->ascent
;
16592 wrap_row_height
= row
->height
;
16593 wrap_row_phys_ascent
= row
->phys_ascent
;
16594 wrap_row_phys_height
= row
->phys_height
;
16595 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16601 PRODUCE_GLYPHS (it
);
16603 /* If this display element was in marginal areas, continue with
16605 if (it
->area
!= TEXT_AREA
)
16607 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16608 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16609 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16610 row
->phys_height
= max (row
->phys_height
,
16611 it
->max_phys_ascent
+ it
->max_phys_descent
);
16612 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16613 it
->max_extra_line_spacing
);
16614 set_iterator_to_next (it
, 1);
16618 /* Does the display element fit on the line? If we truncate
16619 lines, we should draw past the right edge of the window. If
16620 we don't truncate, we want to stop so that we can display the
16621 continuation glyph before the right margin. If lines are
16622 continued, there are two possible strategies for characters
16623 resulting in more than 1 glyph (e.g. tabs): Display as many
16624 glyphs as possible in this line and leave the rest for the
16625 continuation line, or display the whole element in the next
16626 line. Original redisplay did the former, so we do it also. */
16627 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16628 hpos_before
= it
->hpos
;
16631 if (/* Not a newline. */
16633 /* Glyphs produced fit entirely in the line. */
16634 && it
->current_x
< it
->last_visible_x
)
16636 it
->hpos
+= nglyphs
;
16637 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16638 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16639 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16640 row
->phys_height
= max (row
->phys_height
,
16641 it
->max_phys_ascent
+ it
->max_phys_descent
);
16642 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16643 it
->max_extra_line_spacing
);
16644 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16645 row
->x
= x
- it
->first_visible_x
;
16650 struct glyph
*glyph
;
16652 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16654 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16655 new_x
= x
+ glyph
->pixel_width
;
16657 if (/* Lines are continued. */
16658 it
->line_wrap
!= TRUNCATE
16659 && (/* Glyph doesn't fit on the line. */
16660 new_x
> it
->last_visible_x
16661 /* Or it fits exactly on a window system frame. */
16662 || (new_x
== it
->last_visible_x
16663 && FRAME_WINDOW_P (it
->f
))))
16665 /* End of a continued line. */
16668 || (new_x
== it
->last_visible_x
16669 && FRAME_WINDOW_P (it
->f
)))
16671 /* Current glyph is the only one on the line or
16672 fits exactly on the line. We must continue
16673 the line because we can't draw the cursor
16674 after the glyph. */
16675 row
->continued_p
= 1;
16676 it
->current_x
= new_x
;
16677 it
->continuation_lines_width
+= new_x
;
16679 if (i
== nglyphs
- 1)
16681 /* If line-wrap is on, check if a previous
16682 wrap point was found. */
16683 if (wrap_row_used
> 0
16684 /* Even if there is a previous wrap
16685 point, continue the line here as
16686 usual, if (i) the previous character
16687 was a space or tab AND (ii) the
16688 current character is not. */
16690 || IT_DISPLAYING_WHITESPACE (it
)))
16693 set_iterator_to_next (it
, 1);
16694 #ifdef HAVE_WINDOW_SYSTEM
16695 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16697 if (!get_next_display_element (it
))
16699 row
->exact_window_width_line_p
= 1;
16700 it
->continuation_lines_width
= 0;
16701 row
->continued_p
= 0;
16702 row
->ends_at_zv_p
= 1;
16704 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16706 row
->continued_p
= 0;
16707 row
->exact_window_width_line_p
= 1;
16710 #endif /* HAVE_WINDOW_SYSTEM */
16713 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16714 && !FRAME_WINDOW_P (it
->f
))
16716 /* A padding glyph that doesn't fit on this line.
16717 This means the whole character doesn't fit
16719 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16721 /* Fill the rest of the row with continuation
16722 glyphs like in 20.x. */
16723 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16724 < row
->glyphs
[1 + TEXT_AREA
])
16725 produce_special_glyphs (it
, IT_CONTINUATION
);
16727 row
->continued_p
= 1;
16728 it
->current_x
= x_before
;
16729 it
->continuation_lines_width
+= x_before
;
16731 /* Restore the height to what it was before the
16732 element not fitting on the line. */
16733 it
->max_ascent
= ascent
;
16734 it
->max_descent
= descent
;
16735 it
->max_phys_ascent
= phys_ascent
;
16736 it
->max_phys_descent
= phys_descent
;
16738 else if (wrap_row_used
> 0)
16742 it
->continuation_lines_width
+= wrap_x
;
16743 row
->used
[TEXT_AREA
] = wrap_row_used
;
16744 row
->ascent
= wrap_row_ascent
;
16745 row
->height
= wrap_row_height
;
16746 row
->phys_ascent
= wrap_row_phys_ascent
;
16747 row
->phys_height
= wrap_row_phys_height
;
16748 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16749 row
->continued_p
= 1;
16750 row
->ends_at_zv_p
= 0;
16751 row
->exact_window_width_line_p
= 0;
16752 it
->continuation_lines_width
+= x
;
16754 /* Make sure that a non-default face is extended
16755 up to the right margin of the window. */
16756 extend_face_to_end_of_line (it
);
16758 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16760 /* A TAB that extends past the right edge of the
16761 window. This produces a single glyph on
16762 window system frames. We leave the glyph in
16763 this row and let it fill the row, but don't
16764 consume the TAB. */
16765 it
->continuation_lines_width
+= it
->last_visible_x
;
16766 row
->ends_in_middle_of_char_p
= 1;
16767 row
->continued_p
= 1;
16768 glyph
->pixel_width
= it
->last_visible_x
- x
;
16769 it
->starts_in_middle_of_char_p
= 1;
16773 /* Something other than a TAB that draws past
16774 the right edge of the window. Restore
16775 positions to values before the element. */
16776 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16778 /* Display continuation glyphs. */
16779 if (!FRAME_WINDOW_P (it
->f
))
16780 produce_special_glyphs (it
, IT_CONTINUATION
);
16781 row
->continued_p
= 1;
16783 it
->current_x
= x_before
;
16784 it
->continuation_lines_width
+= x
;
16785 extend_face_to_end_of_line (it
);
16787 if (nglyphs
> 1 && i
> 0)
16789 row
->ends_in_middle_of_char_p
= 1;
16790 it
->starts_in_middle_of_char_p
= 1;
16793 /* Restore the height to what it was before the
16794 element not fitting on the line. */
16795 it
->max_ascent
= ascent
;
16796 it
->max_descent
= descent
;
16797 it
->max_phys_ascent
= phys_ascent
;
16798 it
->max_phys_descent
= phys_descent
;
16803 else if (new_x
> it
->first_visible_x
)
16805 /* Increment number of glyphs actually displayed. */
16808 if (x
< it
->first_visible_x
)
16809 /* Glyph is partially visible, i.e. row starts at
16810 negative X position. */
16811 row
->x
= x
- it
->first_visible_x
;
16815 /* Glyph is completely off the left margin of the
16816 window. This should not happen because of the
16817 move_it_in_display_line at the start of this
16818 function, unless the text display area of the
16819 window is empty. */
16820 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16824 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16825 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16826 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16827 row
->phys_height
= max (row
->phys_height
,
16828 it
->max_phys_ascent
+ it
->max_phys_descent
);
16829 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16830 it
->max_extra_line_spacing
);
16832 /* End of this display line if row is continued. */
16833 if (row
->continued_p
|| row
->ends_at_zv_p
)
16838 /* Is this a line end? If yes, we're also done, after making
16839 sure that a non-default face is extended up to the right
16840 margin of the window. */
16841 if (ITERATOR_AT_END_OF_LINE_P (it
))
16843 int used_before
= row
->used
[TEXT_AREA
];
16845 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16847 #ifdef HAVE_WINDOW_SYSTEM
16848 /* Add a space at the end of the line that is used to
16849 display the cursor there. */
16850 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16851 append_space_for_newline (it
, 0);
16852 #endif /* HAVE_WINDOW_SYSTEM */
16854 /* Extend the face to the end of the line. */
16855 extend_face_to_end_of_line (it
);
16857 /* Make sure we have the position. */
16858 if (used_before
== 0)
16859 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16861 /* Consume the line end. This skips over invisible lines. */
16862 set_iterator_to_next (it
, 1);
16863 it
->continuation_lines_width
= 0;
16867 /* Proceed with next display element. Note that this skips
16868 over lines invisible because of selective display. */
16869 set_iterator_to_next (it
, 1);
16871 /* If we truncate lines, we are done when the last displayed
16872 glyphs reach past the right margin of the window. */
16873 if (it
->line_wrap
== TRUNCATE
16874 && (FRAME_WINDOW_P (it
->f
)
16875 ? (it
->current_x
>= it
->last_visible_x
)
16876 : (it
->current_x
> it
->last_visible_x
)))
16878 /* Maybe add truncation glyphs. */
16879 if (!FRAME_WINDOW_P (it
->f
))
16883 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16884 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16887 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16889 row
->used
[TEXT_AREA
] = i
;
16890 produce_special_glyphs (it
, IT_TRUNCATION
);
16893 #ifdef HAVE_WINDOW_SYSTEM
16896 /* Don't truncate if we can overflow newline into fringe. */
16897 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16899 if (!get_next_display_element (it
))
16901 it
->continuation_lines_width
= 0;
16902 row
->ends_at_zv_p
= 1;
16903 row
->exact_window_width_line_p
= 1;
16906 if (ITERATOR_AT_END_OF_LINE_P (it
))
16908 row
->exact_window_width_line_p
= 1;
16909 goto at_end_of_line
;
16913 #endif /* HAVE_WINDOW_SYSTEM */
16915 row
->truncated_on_right_p
= 1;
16916 it
->continuation_lines_width
= 0;
16917 reseat_at_next_visible_line_start (it
, 0);
16918 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16919 it
->hpos
= hpos_before
;
16920 it
->current_x
= x_before
;
16925 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16926 at the left window margin. */
16927 if (it
->first_visible_x
16928 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16930 if (!FRAME_WINDOW_P (it
->f
))
16931 insert_left_trunc_glyphs (it
);
16932 row
->truncated_on_left_p
= 1;
16935 /* If the start of this line is the overlay arrow-position, then
16936 mark this glyph row as the one containing the overlay arrow.
16937 This is clearly a mess with variable size fonts. It would be
16938 better to let it be displayed like cursors under X. */
16939 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16940 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16941 !NILP (overlay_arrow_string
)))
16943 /* Overlay arrow in window redisplay is a fringe bitmap. */
16944 if (STRINGP (overlay_arrow_string
))
16946 struct glyph_row
*arrow_row
16947 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16948 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16949 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16950 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16951 struct glyph
*p2
, *end
;
16953 /* Copy the arrow glyphs. */
16954 while (glyph
< arrow_end
)
16957 /* Throw away padding glyphs. */
16959 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16960 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16966 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16971 xassert (INTEGERP (overlay_arrow_string
));
16972 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16974 overlay_arrow_seen
= 1;
16977 /* Compute pixel dimensions of this line. */
16978 compute_line_metrics (it
);
16980 /* Remember the position at which this line ends. */
16981 row
->end
= it
->current
;
16983 /* Record whether this row ends inside an ellipsis. */
16984 row
->ends_in_ellipsis_p
16985 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16986 && it
->ellipsis_p
);
16988 /* Save fringe bitmaps in this row. */
16989 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
16990 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
16991 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
16992 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
16994 it
->left_user_fringe_bitmap
= 0;
16995 it
->left_user_fringe_face_id
= 0;
16996 it
->right_user_fringe_bitmap
= 0;
16997 it
->right_user_fringe_face_id
= 0;
16999 /* Maybe set the cursor. */
17000 if (it
->w
->cursor
.vpos
< 0
17001 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17002 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17003 && cursor_row_p (it
->w
, row
))
17004 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17006 /* Highlight trailing whitespace. */
17007 if (!NILP (Vshow_trailing_whitespace
))
17008 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17010 /* Prepare for the next line. This line starts horizontally at (X
17011 HPOS) = (0 0). Vertical positions are incremented. As a
17012 convenience for the caller, IT->glyph_row is set to the next
17014 it
->current_x
= it
->hpos
= 0;
17015 it
->current_y
+= row
->height
;
17018 it
->start
= it
->current
;
17019 return row
->displays_text_p
;
17024 /***********************************************************************
17026 ***********************************************************************/
17028 /* Redisplay the menu bar in the frame for window W.
17030 The menu bar of X frames that don't have X toolkit support is
17031 displayed in a special window W->frame->menu_bar_window.
17033 The menu bar of terminal frames is treated specially as far as
17034 glyph matrices are concerned. Menu bar lines are not part of
17035 windows, so the update is done directly on the frame matrix rows
17036 for the menu bar. */
17039 display_menu_bar (w
)
17042 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17047 /* Don't do all this for graphical frames. */
17049 if (FRAME_W32_P (f
))
17052 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17058 if (FRAME_NS_P (f
))
17060 #endif /* HAVE_NS */
17062 #ifdef USE_X_TOOLKIT
17063 xassert (!FRAME_WINDOW_P (f
));
17064 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17065 it
.first_visible_x
= 0;
17066 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17067 #else /* not USE_X_TOOLKIT */
17068 if (FRAME_WINDOW_P (f
))
17070 /* Menu bar lines are displayed in the desired matrix of the
17071 dummy window menu_bar_window. */
17072 struct window
*menu_w
;
17073 xassert (WINDOWP (f
->menu_bar_window
));
17074 menu_w
= XWINDOW (f
->menu_bar_window
);
17075 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17077 it
.first_visible_x
= 0;
17078 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17082 /* This is a TTY frame, i.e. character hpos/vpos are used as
17084 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17086 it
.first_visible_x
= 0;
17087 it
.last_visible_x
= FRAME_COLS (f
);
17089 #endif /* not USE_X_TOOLKIT */
17091 if (! mode_line_inverse_video
)
17092 /* Force the menu-bar to be displayed in the default face. */
17093 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17095 /* Clear all rows of the menu bar. */
17096 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17098 struct glyph_row
*row
= it
.glyph_row
+ i
;
17099 clear_glyph_row (row
);
17100 row
->enabled_p
= 1;
17101 row
->full_width_p
= 1;
17104 /* Display all items of the menu bar. */
17105 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17106 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17108 Lisp_Object string
;
17110 /* Stop at nil string. */
17111 string
= AREF (items
, i
+ 1);
17115 /* Remember where item was displayed. */
17116 ASET (items
, i
+ 3, make_number (it
.hpos
));
17118 /* Display the item, pad with one space. */
17119 if (it
.current_x
< it
.last_visible_x
)
17120 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17121 SCHARS (string
) + 1, 0, 0, -1);
17124 /* Fill out the line with spaces. */
17125 if (it
.current_x
< it
.last_visible_x
)
17126 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17128 /* Compute the total height of the lines. */
17129 compute_line_metrics (&it
);
17134 /***********************************************************************
17136 ***********************************************************************/
17138 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17139 FORCE is non-zero, redisplay mode lines unconditionally.
17140 Otherwise, redisplay only mode lines that are garbaged. Value is
17141 the number of windows whose mode lines were redisplayed. */
17144 redisplay_mode_lines (window
, force
)
17145 Lisp_Object window
;
17150 while (!NILP (window
))
17152 struct window
*w
= XWINDOW (window
);
17154 if (WINDOWP (w
->hchild
))
17155 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17156 else if (WINDOWP (w
->vchild
))
17157 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17159 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17160 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17162 struct text_pos lpoint
;
17163 struct buffer
*old
= current_buffer
;
17165 /* Set the window's buffer for the mode line display. */
17166 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17167 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17169 /* Point refers normally to the selected window. For any
17170 other window, set up appropriate value. */
17171 if (!EQ (window
, selected_window
))
17173 struct text_pos pt
;
17175 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17176 if (CHARPOS (pt
) < BEGV
)
17177 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17178 else if (CHARPOS (pt
) > (ZV
- 1))
17179 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17181 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17184 /* Display mode lines. */
17185 clear_glyph_matrix (w
->desired_matrix
);
17186 if (display_mode_lines (w
))
17189 w
->must_be_updated_p
= 1;
17192 /* Restore old settings. */
17193 set_buffer_internal_1 (old
);
17194 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17204 /* Display the mode and/or top line of window W. Value is the number
17205 of mode lines displayed. */
17208 display_mode_lines (w
)
17211 Lisp_Object old_selected_window
, old_selected_frame
;
17214 old_selected_frame
= selected_frame
;
17215 selected_frame
= w
->frame
;
17216 old_selected_window
= selected_window
;
17217 XSETWINDOW (selected_window
, w
);
17219 /* These will be set while the mode line specs are processed. */
17220 line_number_displayed
= 0;
17221 w
->column_number_displayed
= Qnil
;
17223 if (WINDOW_WANTS_MODELINE_P (w
))
17225 struct window
*sel_w
= XWINDOW (old_selected_window
);
17227 /* Select mode line face based on the real selected window. */
17228 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17229 current_buffer
->mode_line_format
);
17233 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17235 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17236 current_buffer
->header_line_format
);
17240 selected_frame
= old_selected_frame
;
17241 selected_window
= old_selected_window
;
17246 /* Display mode or top line of window W. FACE_ID specifies which line
17247 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
17248 FORMAT is the mode line format to display. Value is the pixel
17249 height of the mode line displayed. */
17252 display_mode_line (w
, face_id
, format
)
17254 enum face_id face_id
;
17255 Lisp_Object format
;
17259 int count
= SPECPDL_INDEX ();
17261 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17262 /* Don't extend on a previously drawn mode-line.
17263 This may happen if called from pos_visible_p. */
17264 it
.glyph_row
->enabled_p
= 0;
17265 prepare_desired_row (it
.glyph_row
);
17267 it
.glyph_row
->mode_line_p
= 1;
17269 if (! mode_line_inverse_video
)
17270 /* Force the mode-line to be displayed in the default face. */
17271 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17273 record_unwind_protect (unwind_format_mode_line
,
17274 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17276 mode_line_target
= MODE_LINE_DISPLAY
;
17278 /* Temporarily make frame's keyboard the current kboard so that
17279 kboard-local variables in the mode_line_format will get the right
17281 push_kboard (FRAME_KBOARD (it
.f
));
17282 record_unwind_save_match_data ();
17283 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17286 unbind_to (count
, Qnil
);
17288 /* Fill up with spaces. */
17289 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17291 compute_line_metrics (&it
);
17292 it
.glyph_row
->full_width_p
= 1;
17293 it
.glyph_row
->continued_p
= 0;
17294 it
.glyph_row
->truncated_on_left_p
= 0;
17295 it
.glyph_row
->truncated_on_right_p
= 0;
17297 /* Make a 3D mode-line have a shadow at its right end. */
17298 face
= FACE_FROM_ID (it
.f
, face_id
);
17299 extend_face_to_end_of_line (&it
);
17300 if (face
->box
!= FACE_NO_BOX
)
17302 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17303 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17304 last
->right_box_line_p
= 1;
17307 return it
.glyph_row
->height
;
17310 /* Move element ELT in LIST to the front of LIST.
17311 Return the updated list. */
17314 move_elt_to_front (elt
, list
)
17315 Lisp_Object elt
, list
;
17317 register Lisp_Object tail
, prev
;
17318 register Lisp_Object tem
;
17322 while (CONSP (tail
))
17328 /* Splice out the link TAIL. */
17330 list
= XCDR (tail
);
17332 Fsetcdr (prev
, XCDR (tail
));
17334 /* Now make it the first. */
17335 Fsetcdr (tail
, list
);
17340 tail
= XCDR (tail
);
17344 /* Not found--return unchanged LIST. */
17348 /* Contribute ELT to the mode line for window IT->w. How it
17349 translates into text depends on its data type.
17351 IT describes the display environment in which we display, as usual.
17353 DEPTH is the depth in recursion. It is used to prevent
17354 infinite recursion here.
17356 FIELD_WIDTH is the number of characters the display of ELT should
17357 occupy in the mode line, and PRECISION is the maximum number of
17358 characters to display from ELT's representation. See
17359 display_string for details.
17361 Returns the hpos of the end of the text generated by ELT.
17363 PROPS is a property list to add to any string we encounter.
17365 If RISKY is nonzero, remove (disregard) any properties in any string
17366 we encounter, and ignore :eval and :propertize.
17368 The global variable `mode_line_target' determines whether the
17369 output is passed to `store_mode_line_noprop',
17370 `store_mode_line_string', or `display_string'. */
17373 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17376 int field_width
, precision
;
17377 Lisp_Object elt
, props
;
17380 int n
= 0, field
, prec
;
17385 elt
= build_string ("*too-deep*");
17389 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17393 /* A string: output it and check for %-constructs within it. */
17397 if (SCHARS (elt
) > 0
17398 && (!NILP (props
) || risky
))
17400 Lisp_Object oprops
, aelt
;
17401 oprops
= Ftext_properties_at (make_number (0), elt
);
17403 /* If the starting string's properties are not what
17404 we want, translate the string. Also, if the string
17405 is risky, do that anyway. */
17407 if (NILP (Fequal (props
, oprops
)) || risky
)
17409 /* If the starting string has properties,
17410 merge the specified ones onto the existing ones. */
17411 if (! NILP (oprops
) && !risky
)
17415 oprops
= Fcopy_sequence (oprops
);
17417 while (CONSP (tem
))
17419 oprops
= Fplist_put (oprops
, XCAR (tem
),
17420 XCAR (XCDR (tem
)));
17421 tem
= XCDR (XCDR (tem
));
17426 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17427 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17429 /* AELT is what we want. Move it to the front
17430 without consing. */
17432 mode_line_proptrans_alist
17433 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17439 /* If AELT has the wrong props, it is useless.
17440 so get rid of it. */
17442 mode_line_proptrans_alist
17443 = Fdelq (aelt
, mode_line_proptrans_alist
);
17445 elt
= Fcopy_sequence (elt
);
17446 Fset_text_properties (make_number (0), Flength (elt
),
17448 /* Add this item to mode_line_proptrans_alist. */
17449 mode_line_proptrans_alist
17450 = Fcons (Fcons (elt
, props
),
17451 mode_line_proptrans_alist
);
17452 /* Truncate mode_line_proptrans_alist
17453 to at most 50 elements. */
17454 tem
= Fnthcdr (make_number (50),
17455 mode_line_proptrans_alist
);
17457 XSETCDR (tem
, Qnil
);
17466 prec
= precision
- n
;
17467 switch (mode_line_target
)
17469 case MODE_LINE_NOPROP
:
17470 case MODE_LINE_TITLE
:
17471 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17473 case MODE_LINE_STRING
:
17474 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17476 case MODE_LINE_DISPLAY
:
17477 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17478 0, prec
, 0, STRING_MULTIBYTE (elt
));
17485 /* Handle the non-literal case. */
17487 while ((precision
<= 0 || n
< precision
)
17488 && SREF (elt
, offset
) != 0
17489 && (mode_line_target
!= MODE_LINE_DISPLAY
17490 || it
->current_x
< it
->last_visible_x
))
17492 int last_offset
= offset
;
17494 /* Advance to end of string or next format specifier. */
17495 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17498 if (offset
- 1 != last_offset
)
17500 int nchars
, nbytes
;
17502 /* Output to end of string or up to '%'. Field width
17503 is length of string. Don't output more than
17504 PRECISION allows us. */
17507 prec
= c_string_width (SDATA (elt
) + last_offset
,
17508 offset
- last_offset
, precision
- n
,
17511 switch (mode_line_target
)
17513 case MODE_LINE_NOPROP
:
17514 case MODE_LINE_TITLE
:
17515 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17517 case MODE_LINE_STRING
:
17519 int bytepos
= last_offset
;
17520 int charpos
= string_byte_to_char (elt
, bytepos
);
17521 int endpos
= (precision
<= 0
17522 ? string_byte_to_char (elt
, offset
)
17523 : charpos
+ nchars
);
17525 n
+= store_mode_line_string (NULL
,
17526 Fsubstring (elt
, make_number (charpos
),
17527 make_number (endpos
)),
17531 case MODE_LINE_DISPLAY
:
17533 int bytepos
= last_offset
;
17534 int charpos
= string_byte_to_char (elt
, bytepos
);
17536 if (precision
<= 0)
17537 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17538 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17540 STRING_MULTIBYTE (elt
));
17545 else /* c == '%' */
17547 int percent_position
= offset
;
17549 /* Get the specified minimum width. Zero means
17552 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17553 field
= field
* 10 + c
- '0';
17555 /* Don't pad beyond the total padding allowed. */
17556 if (field_width
- n
> 0 && field
> field_width
- n
)
17557 field
= field_width
- n
;
17559 /* Note that either PRECISION <= 0 or N < PRECISION. */
17560 prec
= precision
- n
;
17563 n
+= display_mode_element (it
, depth
, field
, prec
,
17564 Vglobal_mode_string
, props
,
17569 int bytepos
, charpos
;
17570 unsigned char *spec
;
17572 bytepos
= percent_position
;
17573 charpos
= (STRING_MULTIBYTE (elt
)
17574 ? string_byte_to_char (elt
, bytepos
)
17577 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17579 switch (mode_line_target
)
17581 case MODE_LINE_NOPROP
:
17582 case MODE_LINE_TITLE
:
17583 n
+= store_mode_line_noprop (spec
, field
, prec
);
17585 case MODE_LINE_STRING
:
17587 int len
= strlen (spec
);
17588 Lisp_Object tem
= make_string (spec
, len
);
17589 props
= Ftext_properties_at (make_number (charpos
), elt
);
17590 /* Should only keep face property in props */
17591 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17594 case MODE_LINE_DISPLAY
:
17596 int nglyphs_before
, nwritten
;
17598 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17599 nwritten
= display_string (spec
, Qnil
, elt
,
17604 /* Assign to the glyphs written above the
17605 string where the `%x' came from, position
17609 struct glyph
*glyph
17610 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17614 for (i
= 0; i
< nwritten
; ++i
)
17616 glyph
[i
].object
= elt
;
17617 glyph
[i
].charpos
= charpos
;
17634 /* A symbol: process the value of the symbol recursively
17635 as if it appeared here directly. Avoid error if symbol void.
17636 Special case: if value of symbol is a string, output the string
17639 register Lisp_Object tem
;
17641 /* If the variable is not marked as risky to set
17642 then its contents are risky to use. */
17643 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17646 tem
= Fboundp (elt
);
17649 tem
= Fsymbol_value (elt
);
17650 /* If value is a string, output that string literally:
17651 don't check for % within it. */
17655 if (!EQ (tem
, elt
))
17657 /* Give up right away for nil or t. */
17667 register Lisp_Object car
, tem
;
17669 /* A cons cell: five distinct cases.
17670 If first element is :eval or :propertize, do something special.
17671 If first element is a string or a cons, process all the elements
17672 and effectively concatenate them.
17673 If first element is a negative number, truncate displaying cdr to
17674 at most that many characters. If positive, pad (with spaces)
17675 to at least that many characters.
17676 If first element is a symbol, process the cadr or caddr recursively
17677 according to whether the symbol's value is non-nil or nil. */
17679 if (EQ (car
, QCeval
))
17681 /* An element of the form (:eval FORM) means evaluate FORM
17682 and use the result as mode line elements. */
17687 if (CONSP (XCDR (elt
)))
17690 spec
= safe_eval (XCAR (XCDR (elt
)));
17691 n
+= display_mode_element (it
, depth
, field_width
- n
,
17692 precision
- n
, spec
, props
,
17696 else if (EQ (car
, QCpropertize
))
17698 /* An element of the form (:propertize ELT PROPS...)
17699 means display ELT but applying properties PROPS. */
17704 if (CONSP (XCDR (elt
)))
17705 n
+= display_mode_element (it
, depth
, field_width
- n
,
17706 precision
- n
, XCAR (XCDR (elt
)),
17707 XCDR (XCDR (elt
)), risky
);
17709 else if (SYMBOLP (car
))
17711 tem
= Fboundp (car
);
17715 /* elt is now the cdr, and we know it is a cons cell.
17716 Use its car if CAR has a non-nil value. */
17719 tem
= Fsymbol_value (car
);
17726 /* Symbol's value is nil (or symbol is unbound)
17727 Get the cddr of the original list
17728 and if possible find the caddr and use that. */
17732 else if (!CONSP (elt
))
17737 else if (INTEGERP (car
))
17739 register int lim
= XINT (car
);
17743 /* Negative int means reduce maximum width. */
17744 if (precision
<= 0)
17747 precision
= min (precision
, -lim
);
17751 /* Padding specified. Don't let it be more than
17752 current maximum. */
17754 lim
= min (precision
, lim
);
17756 /* If that's more padding than already wanted, queue it.
17757 But don't reduce padding already specified even if
17758 that is beyond the current truncation point. */
17759 field_width
= max (lim
, field_width
);
17763 else if (STRINGP (car
) || CONSP (car
))
17765 register int limit
= 50;
17766 /* Limit is to protect against circular lists. */
17769 && (precision
<= 0 || n
< precision
))
17771 n
+= display_mode_element (it
, depth
,
17772 /* Do padding only after the last
17773 element in the list. */
17774 (! CONSP (XCDR (elt
))
17777 precision
- n
, XCAR (elt
),
17787 elt
= build_string ("*invalid*");
17791 /* Pad to FIELD_WIDTH. */
17792 if (field_width
> 0 && n
< field_width
)
17794 switch (mode_line_target
)
17796 case MODE_LINE_NOPROP
:
17797 case MODE_LINE_TITLE
:
17798 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17800 case MODE_LINE_STRING
:
17801 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17803 case MODE_LINE_DISPLAY
:
17804 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17813 /* Store a mode-line string element in mode_line_string_list.
17815 If STRING is non-null, display that C string. Otherwise, the Lisp
17816 string LISP_STRING is displayed.
17818 FIELD_WIDTH is the minimum number of output glyphs to produce.
17819 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17820 with spaces. FIELD_WIDTH <= 0 means don't pad.
17822 PRECISION is the maximum number of characters to output from
17823 STRING. PRECISION <= 0 means don't truncate the string.
17825 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17826 properties to the string.
17828 PROPS are the properties to add to the string.
17829 The mode_line_string_face face property is always added to the string.
17833 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17835 Lisp_Object lisp_string
;
17844 if (string
!= NULL
)
17846 len
= strlen (string
);
17847 if (precision
> 0 && len
> precision
)
17849 lisp_string
= make_string (string
, len
);
17851 props
= mode_line_string_face_prop
;
17852 else if (!NILP (mode_line_string_face
))
17854 Lisp_Object face
= Fplist_get (props
, Qface
);
17855 props
= Fcopy_sequence (props
);
17857 face
= mode_line_string_face
;
17859 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17860 props
= Fplist_put (props
, Qface
, face
);
17862 Fadd_text_properties (make_number (0), make_number (len
),
17863 props
, lisp_string
);
17867 len
= XFASTINT (Flength (lisp_string
));
17868 if (precision
> 0 && len
> precision
)
17871 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17874 if (!NILP (mode_line_string_face
))
17878 props
= Ftext_properties_at (make_number (0), lisp_string
);
17879 face
= Fplist_get (props
, Qface
);
17881 face
= mode_line_string_face
;
17883 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17884 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17886 lisp_string
= Fcopy_sequence (lisp_string
);
17889 Fadd_text_properties (make_number (0), make_number (len
),
17890 props
, lisp_string
);
17895 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17899 if (field_width
> len
)
17901 field_width
-= len
;
17902 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17904 Fadd_text_properties (make_number (0), make_number (field_width
),
17905 props
, lisp_string
);
17906 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17914 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17916 doc
: /* Format a string out of a mode line format specification.
17917 First arg FORMAT specifies the mode line format (see `mode-line-format'
17918 for details) to use.
17920 Optional second arg FACE specifies the face property to put
17921 on all characters for which no face is specified.
17922 The value t means whatever face the window's mode line currently uses
17923 \(either `mode-line' or `mode-line-inactive', depending).
17924 A value of nil means the default is no face property.
17925 If FACE is an integer, the value string has no text properties.
17927 Optional third and fourth args WINDOW and BUFFER specify the window
17928 and buffer to use as the context for the formatting (defaults
17929 are the selected window and the window's buffer). */)
17930 (format
, face
, window
, buffer
)
17931 Lisp_Object format
, face
, window
, buffer
;
17936 struct buffer
*old_buffer
= NULL
;
17938 int no_props
= INTEGERP (face
);
17939 int count
= SPECPDL_INDEX ();
17941 int string_start
= 0;
17944 window
= selected_window
;
17945 CHECK_WINDOW (window
);
17946 w
= XWINDOW (window
);
17949 buffer
= w
->buffer
;
17950 CHECK_BUFFER (buffer
);
17952 /* Make formatting the modeline a non-op when noninteractive, otherwise
17953 there will be problems later caused by a partially initialized frame. */
17954 if (NILP (format
) || noninteractive
)
17955 return empty_unibyte_string
;
17963 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17964 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17968 face_id
= DEFAULT_FACE_ID
;
17970 if (XBUFFER (buffer
) != current_buffer
)
17971 old_buffer
= current_buffer
;
17973 /* Save things including mode_line_proptrans_alist,
17974 and set that to nil so that we don't alter the outer value. */
17975 record_unwind_protect (unwind_format_mode_line
,
17976 format_mode_line_unwind_data
17977 (old_buffer
, selected_window
, 1));
17978 mode_line_proptrans_alist
= Qnil
;
17980 Fselect_window (window
, Qt
);
17982 set_buffer_internal_1 (XBUFFER (buffer
));
17984 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17988 mode_line_target
= MODE_LINE_NOPROP
;
17989 mode_line_string_face_prop
= Qnil
;
17990 mode_line_string_list
= Qnil
;
17991 string_start
= MODE_LINE_NOPROP_LEN (0);
17995 mode_line_target
= MODE_LINE_STRING
;
17996 mode_line_string_list
= Qnil
;
17997 mode_line_string_face
= face
;
17998 mode_line_string_face_prop
17999 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18002 push_kboard (FRAME_KBOARD (it
.f
));
18003 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18008 len
= MODE_LINE_NOPROP_LEN (string_start
);
18009 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18013 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18014 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18015 empty_unibyte_string
);
18018 unbind_to (count
, Qnil
);
18022 /* Write a null-terminated, right justified decimal representation of
18023 the positive integer D to BUF using a minimal field width WIDTH. */
18026 pint2str (buf
, width
, d
)
18027 register char *buf
;
18028 register int width
;
18031 register char *p
= buf
;
18039 *p
++ = d
% 10 + '0';
18044 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18055 /* Write a null-terminated, right justified decimal and "human
18056 readable" representation of the nonnegative integer D to BUF using
18057 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18059 static const char power_letter
[] =
18073 pint2hrstr (buf
, width
, d
)
18078 /* We aim to represent the nonnegative integer D as
18079 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18082 /* -1 means: do not use TENTHS. */
18086 /* Length of QUOTIENT.TENTHS as a string. */
18092 if (1000 <= quotient
)
18094 /* Scale to the appropriate EXPONENT. */
18097 remainder
= quotient
% 1000;
18101 while (1000 <= quotient
);
18103 /* Round to nearest and decide whether to use TENTHS or not. */
18106 tenths
= remainder
/ 100;
18107 if (50 <= remainder
% 100)
18114 if (quotient
== 10)
18122 if (500 <= remainder
)
18124 if (quotient
< 999)
18135 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18136 if (tenths
== -1 && quotient
<= 99)
18143 p
= psuffix
= buf
+ max (width
, length
);
18145 /* Print EXPONENT. */
18147 *psuffix
++ = power_letter
[exponent
];
18150 /* Print TENTHS. */
18153 *--p
= '0' + tenths
;
18157 /* Print QUOTIENT. */
18160 int digit
= quotient
% 10;
18161 *--p
= '0' + digit
;
18163 while ((quotient
/= 10) != 0);
18165 /* Print leading spaces. */
18170 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18171 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18172 type of CODING_SYSTEM. Return updated pointer into BUF. */
18174 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18177 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18178 Lisp_Object coding_system
;
18179 register char *buf
;
18183 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18184 const unsigned char *eol_str
;
18186 /* The EOL conversion we are using. */
18187 Lisp_Object eoltype
;
18189 val
= CODING_SYSTEM_SPEC (coding_system
);
18192 if (!VECTORP (val
)) /* Not yet decided. */
18197 eoltype
= eol_mnemonic_undecided
;
18198 /* Don't mention EOL conversion if it isn't decided. */
18203 Lisp_Object eolvalue
;
18205 attrs
= AREF (val
, 0);
18206 eolvalue
= AREF (val
, 2);
18209 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18213 /* The EOL conversion that is normal on this system. */
18215 if (NILP (eolvalue
)) /* Not yet decided. */
18216 eoltype
= eol_mnemonic_undecided
;
18217 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18218 eoltype
= eol_mnemonic_undecided
;
18219 else /* eolvalue is Qunix, Qdos, or Qmac. */
18220 eoltype
= (EQ (eolvalue
, Qunix
)
18221 ? eol_mnemonic_unix
18222 : (EQ (eolvalue
, Qdos
) == 1
18223 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18229 /* Mention the EOL conversion if it is not the usual one. */
18230 if (STRINGP (eoltype
))
18232 eol_str
= SDATA (eoltype
);
18233 eol_str_len
= SBYTES (eoltype
);
18235 else if (CHARACTERP (eoltype
))
18237 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18238 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18243 eol_str
= invalid_eol_type
;
18244 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18246 bcopy (eol_str
, buf
, eol_str_len
);
18247 buf
+= eol_str_len
;
18253 /* Return a string for the output of a mode line %-spec for window W,
18254 generated by character C. PRECISION >= 0 means don't return a
18255 string longer than that value. FIELD_WIDTH > 0 means pad the
18256 string returned with spaces to that value. Return 1 in *MULTIBYTE
18257 if the result is multibyte text.
18259 Note we operate on the current buffer for most purposes,
18260 the exception being w->base_line_pos. */
18262 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18265 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
18268 int field_width
, precision
;
18272 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18273 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18274 struct buffer
*b
= current_buffer
;
18282 if (!NILP (b
->read_only
))
18284 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18289 /* This differs from %* only for a modified read-only buffer. */
18290 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18292 if (!NILP (b
->read_only
))
18297 /* This differs from %* in ignoring read-only-ness. */
18298 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18310 if (command_loop_level
> 5)
18312 p
= decode_mode_spec_buf
;
18313 for (i
= 0; i
< command_loop_level
; i
++)
18316 return decode_mode_spec_buf
;
18324 if (command_loop_level
> 5)
18326 p
= decode_mode_spec_buf
;
18327 for (i
= 0; i
< command_loop_level
; i
++)
18330 return decode_mode_spec_buf
;
18337 /* Let lots_of_dashes be a string of infinite length. */
18338 if (mode_line_target
== MODE_LINE_NOPROP
||
18339 mode_line_target
== MODE_LINE_STRING
)
18341 if (field_width
<= 0
18342 || field_width
> sizeof (lots_of_dashes
))
18344 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18345 decode_mode_spec_buf
[i
] = '-';
18346 decode_mode_spec_buf
[i
] = '\0';
18347 return decode_mode_spec_buf
;
18350 return lots_of_dashes
;
18358 /* %c and %l are ignored in `frame-title-format'.
18359 (In redisplay_internal, the frame title is drawn _before_ the
18360 windows are updated, so the stuff which depends on actual
18361 window contents (such as %l) may fail to render properly, or
18362 even crash emacs.) */
18363 if (mode_line_target
== MODE_LINE_TITLE
)
18367 int col
= (int) current_column (); /* iftc */
18368 w
->column_number_displayed
= make_number (col
);
18369 pint2str (decode_mode_spec_buf
, field_width
, col
);
18370 return decode_mode_spec_buf
;
18374 #ifndef SYSTEM_MALLOC
18376 if (NILP (Vmemory_full
))
18379 return "!MEM FULL! ";
18386 /* %F displays the frame name. */
18387 if (!NILP (f
->title
))
18388 return (char *) SDATA (f
->title
);
18389 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18390 return (char *) SDATA (f
->name
);
18399 int size
= ZV
- BEGV
;
18400 pint2str (decode_mode_spec_buf
, field_width
, size
);
18401 return decode_mode_spec_buf
;
18406 int size
= ZV
- BEGV
;
18407 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18408 return decode_mode_spec_buf
;
18413 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18414 int topline
, nlines
, junk
, height
;
18416 /* %c and %l are ignored in `frame-title-format'. */
18417 if (mode_line_target
== MODE_LINE_TITLE
)
18420 startpos
= XMARKER (w
->start
)->charpos
;
18421 startpos_byte
= marker_byte_position (w
->start
);
18422 height
= WINDOW_TOTAL_LINES (w
);
18424 /* If we decided that this buffer isn't suitable for line numbers,
18425 don't forget that too fast. */
18426 if (EQ (w
->base_line_pos
, w
->buffer
))
18428 /* But do forget it, if the window shows a different buffer now. */
18429 else if (BUFFERP (w
->base_line_pos
))
18430 w
->base_line_pos
= Qnil
;
18432 /* If the buffer is very big, don't waste time. */
18433 if (INTEGERP (Vline_number_display_limit
)
18434 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18436 w
->base_line_pos
= Qnil
;
18437 w
->base_line_number
= Qnil
;
18441 if (INTEGERP (w
->base_line_number
)
18442 && INTEGERP (w
->base_line_pos
)
18443 && XFASTINT (w
->base_line_pos
) <= startpos
)
18445 line
= XFASTINT (w
->base_line_number
);
18446 linepos
= XFASTINT (w
->base_line_pos
);
18447 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18452 linepos
= BUF_BEGV (b
);
18453 linepos_byte
= BUF_BEGV_BYTE (b
);
18456 /* Count lines from base line to window start position. */
18457 nlines
= display_count_lines (linepos
, linepos_byte
,
18461 topline
= nlines
+ line
;
18463 /* Determine a new base line, if the old one is too close
18464 or too far away, or if we did not have one.
18465 "Too close" means it's plausible a scroll-down would
18466 go back past it. */
18467 if (startpos
== BUF_BEGV (b
))
18469 w
->base_line_number
= make_number (topline
);
18470 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18472 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18473 || linepos
== BUF_BEGV (b
))
18475 int limit
= BUF_BEGV (b
);
18476 int limit_byte
= BUF_BEGV_BYTE (b
);
18478 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18480 if (startpos
- distance
> limit
)
18482 limit
= startpos
- distance
;
18483 limit_byte
= CHAR_TO_BYTE (limit
);
18486 nlines
= display_count_lines (startpos
, startpos_byte
,
18488 - (height
* 2 + 30),
18490 /* If we couldn't find the lines we wanted within
18491 line_number_display_limit_width chars per line,
18492 give up on line numbers for this window. */
18493 if (position
== limit_byte
&& limit
== startpos
- distance
)
18495 w
->base_line_pos
= w
->buffer
;
18496 w
->base_line_number
= Qnil
;
18500 w
->base_line_number
= make_number (topline
- nlines
);
18501 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18504 /* Now count lines from the start pos to point. */
18505 nlines
= display_count_lines (startpos
, startpos_byte
,
18506 PT_BYTE
, PT
, &junk
);
18508 /* Record that we did display the line number. */
18509 line_number_displayed
= 1;
18511 /* Make the string to show. */
18512 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18513 return decode_mode_spec_buf
;
18516 char* p
= decode_mode_spec_buf
;
18517 int pad
= field_width
- 2;
18523 return decode_mode_spec_buf
;
18529 obj
= b
->mode_name
;
18533 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18539 int pos
= marker_position (w
->start
);
18540 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18542 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18544 if (pos
<= BUF_BEGV (b
))
18549 else if (pos
<= BUF_BEGV (b
))
18553 if (total
> 1000000)
18554 /* Do it differently for a large value, to avoid overflow. */
18555 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18557 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18558 /* We can't normally display a 3-digit number,
18559 so get us a 2-digit number that is close. */
18562 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18563 return decode_mode_spec_buf
;
18567 /* Display percentage of size above the bottom of the screen. */
18570 int toppos
= marker_position (w
->start
);
18571 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18572 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18574 if (botpos
>= BUF_ZV (b
))
18576 if (toppos
<= BUF_BEGV (b
))
18583 if (total
> 1000000)
18584 /* Do it differently for a large value, to avoid overflow. */
18585 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18587 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18588 /* We can't normally display a 3-digit number,
18589 so get us a 2-digit number that is close. */
18592 if (toppos
<= BUF_BEGV (b
))
18593 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18595 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18596 return decode_mode_spec_buf
;
18601 /* status of process */
18602 obj
= Fget_buffer_process (Fcurrent_buffer ());
18604 return "no process";
18605 #ifdef subprocesses
18606 obj
= Fsymbol_name (Fprocess_status (obj
));
18613 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18620 case 't': /* indicate TEXT or BINARY */
18621 #ifdef MODE_LINE_BINARY_TEXT
18622 return MODE_LINE_BINARY_TEXT (b
);
18628 /* coding-system (not including end-of-line format) */
18630 /* coding-system (including end-of-line type) */
18632 int eol_flag
= (c
== 'Z');
18633 char *p
= decode_mode_spec_buf
;
18635 if (! FRAME_WINDOW_P (f
))
18637 /* No need to mention EOL here--the terminal never needs
18638 to do EOL conversion. */
18639 p
= decode_mode_spec_coding (CODING_ID_NAME
18640 (FRAME_KEYBOARD_CODING (f
)->id
),
18642 p
= decode_mode_spec_coding (CODING_ID_NAME
18643 (FRAME_TERMINAL_CODING (f
)->id
),
18646 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18649 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18650 #ifdef subprocesses
18651 obj
= Fget_buffer_process (Fcurrent_buffer ());
18652 if (PROCESSP (obj
))
18654 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18656 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18659 #endif /* subprocesses */
18662 return decode_mode_spec_buf
;
18668 *multibyte
= STRING_MULTIBYTE (obj
);
18669 return (char *) SDATA (obj
);
18676 /* Count up to COUNT lines starting from START / START_BYTE.
18677 But don't go beyond LIMIT_BYTE.
18678 Return the number of lines thus found (always nonnegative).
18680 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18683 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18684 int start
, start_byte
, limit_byte
, count
;
18687 register unsigned char *cursor
;
18688 unsigned char *base
;
18690 register int ceiling
;
18691 register unsigned char *ceiling_addr
;
18692 int orig_count
= count
;
18694 /* If we are not in selective display mode,
18695 check only for newlines. */
18696 int selective_display
= (!NILP (current_buffer
->selective_display
)
18697 && !INTEGERP (current_buffer
->selective_display
));
18701 while (start_byte
< limit_byte
)
18703 ceiling
= BUFFER_CEILING_OF (start_byte
);
18704 ceiling
= min (limit_byte
- 1, ceiling
);
18705 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18706 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18709 if (selective_display
)
18710 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18713 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18716 if (cursor
!= ceiling_addr
)
18720 start_byte
+= cursor
- base
+ 1;
18721 *byte_pos_ptr
= start_byte
;
18725 if (++cursor
== ceiling_addr
)
18731 start_byte
+= cursor
- base
;
18736 while (start_byte
> limit_byte
)
18738 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18739 ceiling
= max (limit_byte
, ceiling
);
18740 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18741 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18744 if (selective_display
)
18745 while (--cursor
!= ceiling_addr
18746 && *cursor
!= '\n' && *cursor
!= 015)
18749 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18752 if (cursor
!= ceiling_addr
)
18756 start_byte
+= cursor
- base
+ 1;
18757 *byte_pos_ptr
= start_byte
;
18758 /* When scanning backwards, we should
18759 not count the newline posterior to which we stop. */
18760 return - orig_count
- 1;
18766 /* Here we add 1 to compensate for the last decrement
18767 of CURSOR, which took it past the valid range. */
18768 start_byte
+= cursor
- base
+ 1;
18772 *byte_pos_ptr
= limit_byte
;
18775 return - orig_count
+ count
;
18776 return orig_count
- count
;
18782 /***********************************************************************
18784 ***********************************************************************/
18786 /* Display a NUL-terminated string, starting with index START.
18788 If STRING is non-null, display that C string. Otherwise, the Lisp
18789 string LISP_STRING is displayed.
18791 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18792 FACE_STRING. Display STRING or LISP_STRING with the face at
18793 FACE_STRING_POS in FACE_STRING:
18795 Display the string in the environment given by IT, but use the
18796 standard display table, temporarily.
18798 FIELD_WIDTH is the minimum number of output glyphs to produce.
18799 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18800 with spaces. If STRING has more characters, more than FIELD_WIDTH
18801 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18803 PRECISION is the maximum number of characters to output from
18804 STRING. PRECISION < 0 means don't truncate the string.
18806 This is roughly equivalent to printf format specifiers:
18808 FIELD_WIDTH PRECISION PRINTF
18809 ----------------------------------------
18815 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18816 display them, and < 0 means obey the current buffer's value of
18817 enable_multibyte_characters.
18819 Value is the number of columns displayed. */
18822 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18823 start
, it
, field_width
, precision
, max_x
, multibyte
)
18824 unsigned char *string
;
18825 Lisp_Object lisp_string
;
18826 Lisp_Object face_string
;
18827 EMACS_INT face_string_pos
;
18830 int field_width
, precision
, max_x
;
18833 int hpos_at_start
= it
->hpos
;
18834 int saved_face_id
= it
->face_id
;
18835 struct glyph_row
*row
= it
->glyph_row
;
18837 /* Initialize the iterator IT for iteration over STRING beginning
18838 with index START. */
18839 reseat_to_string (it
, string
, lisp_string
, start
,
18840 precision
, field_width
, multibyte
);
18842 /* If displaying STRING, set up the face of the iterator
18843 from LISP_STRING, if that's given. */
18844 if (STRINGP (face_string
))
18850 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18851 0, it
->region_beg_charpos
,
18852 it
->region_end_charpos
,
18853 &endptr
, it
->base_face_id
, 0);
18854 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18855 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18858 /* Set max_x to the maximum allowed X position. Don't let it go
18859 beyond the right edge of the window. */
18861 max_x
= it
->last_visible_x
;
18863 max_x
= min (max_x
, it
->last_visible_x
);
18865 /* Skip over display elements that are not visible. because IT->w is
18867 if (it
->current_x
< it
->first_visible_x
)
18868 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18869 MOVE_TO_POS
| MOVE_TO_X
);
18871 row
->ascent
= it
->max_ascent
;
18872 row
->height
= it
->max_ascent
+ it
->max_descent
;
18873 row
->phys_ascent
= it
->max_phys_ascent
;
18874 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18875 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18877 /* This condition is for the case that we are called with current_x
18878 past last_visible_x. */
18879 while (it
->current_x
< max_x
)
18881 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18883 /* Get the next display element. */
18884 if (!get_next_display_element (it
))
18887 /* Produce glyphs. */
18888 x_before
= it
->current_x
;
18889 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18890 PRODUCE_GLYPHS (it
);
18892 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18895 while (i
< nglyphs
)
18897 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18899 if (it
->line_wrap
!= TRUNCATE
18900 && x
+ glyph
->pixel_width
> max_x
)
18902 /* End of continued line or max_x reached. */
18903 if (CHAR_GLYPH_PADDING_P (*glyph
))
18905 /* A wide character is unbreakable. */
18906 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18907 it
->current_x
= x_before
;
18911 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18916 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18918 /* Glyph is at least partially visible. */
18920 if (x
< it
->first_visible_x
)
18921 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18925 /* Glyph is off the left margin of the display area.
18926 Should not happen. */
18930 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18931 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18932 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18933 row
->phys_height
= max (row
->phys_height
,
18934 it
->max_phys_ascent
+ it
->max_phys_descent
);
18935 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18936 it
->max_extra_line_spacing
);
18937 x
+= glyph
->pixel_width
;
18941 /* Stop if max_x reached. */
18945 /* Stop at line ends. */
18946 if (ITERATOR_AT_END_OF_LINE_P (it
))
18948 it
->continuation_lines_width
= 0;
18952 set_iterator_to_next (it
, 1);
18954 /* Stop if truncating at the right edge. */
18955 if (it
->line_wrap
== TRUNCATE
18956 && it
->current_x
>= it
->last_visible_x
)
18958 /* Add truncation mark, but don't do it if the line is
18959 truncated at a padding space. */
18960 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18962 if (!FRAME_WINDOW_P (it
->f
))
18966 if (it
->current_x
> it
->last_visible_x
)
18968 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18969 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18971 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18973 row
->used
[TEXT_AREA
] = i
;
18974 produce_special_glyphs (it
, IT_TRUNCATION
);
18977 produce_special_glyphs (it
, IT_TRUNCATION
);
18979 it
->glyph_row
->truncated_on_right_p
= 1;
18985 /* Maybe insert a truncation at the left. */
18986 if (it
->first_visible_x
18987 && IT_CHARPOS (*it
) > 0)
18989 if (!FRAME_WINDOW_P (it
->f
))
18990 insert_left_trunc_glyphs (it
);
18991 it
->glyph_row
->truncated_on_left_p
= 1;
18994 it
->face_id
= saved_face_id
;
18996 /* Value is number of columns displayed. */
18997 return it
->hpos
- hpos_at_start
;
19002 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19003 appears as an element of LIST or as the car of an element of LIST.
19004 If PROPVAL is a list, compare each element against LIST in that
19005 way, and return 1/2 if any element of PROPVAL is found in LIST.
19006 Otherwise return 0. This function cannot quit.
19007 The return value is 2 if the text is invisible but with an ellipsis
19008 and 1 if it's invisible and without an ellipsis. */
19011 invisible_p (propval
, list
)
19012 register Lisp_Object propval
;
19015 register Lisp_Object tail
, proptail
;
19017 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19019 register Lisp_Object tem
;
19021 if (EQ (propval
, tem
))
19023 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19024 return NILP (XCDR (tem
)) ? 1 : 2;
19027 if (CONSP (propval
))
19029 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19031 Lisp_Object propelt
;
19032 propelt
= XCAR (proptail
);
19033 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19035 register Lisp_Object tem
;
19037 if (EQ (propelt
, tem
))
19039 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19040 return NILP (XCDR (tem
)) ? 1 : 2;
19048 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19049 doc
: /* Non-nil if the property makes the text invisible.
19050 POS-OR-PROP can be a marker or number, in which case it is taken to be
19051 a position in the current buffer and the value of the `invisible' property
19052 is checked; or it can be some other value, which is then presumed to be the
19053 value of the `invisible' property of the text of interest.
19054 The non-nil value returned can be t for truly invisible text or something
19055 else if the text is replaced by an ellipsis. */)
19057 Lisp_Object pos_or_prop
;
19060 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19061 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19063 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19064 return (invis
== 0 ? Qnil
19066 : make_number (invis
));
19069 /* Calculate a width or height in pixels from a specification using
19070 the following elements:
19073 NUM - a (fractional) multiple of the default font width/height
19074 (NUM) - specifies exactly NUM pixels
19075 UNIT - a fixed number of pixels, see below.
19076 ELEMENT - size of a display element in pixels, see below.
19077 (NUM . SPEC) - equals NUM * SPEC
19078 (+ SPEC SPEC ...) - add pixel values
19079 (- SPEC SPEC ...) - subtract pixel values
19080 (- SPEC) - negate pixel value
19083 INT or FLOAT - a number constant
19084 SYMBOL - use symbol's (buffer local) variable binding.
19087 in - pixels per inch *)
19088 mm - pixels per 1/1000 meter *)
19089 cm - pixels per 1/100 meter *)
19090 width - width of current font in pixels.
19091 height - height of current font in pixels.
19093 *) using the ratio(s) defined in display-pixels-per-inch.
19097 left-fringe - left fringe width in pixels
19098 right-fringe - right fringe width in pixels
19100 left-margin - left margin width in pixels
19101 right-margin - right margin width in pixels
19103 scroll-bar - scroll-bar area width in pixels
19107 Pixels corresponding to 5 inches:
19110 Total width of non-text areas on left side of window (if scroll-bar is on left):
19111 '(space :width (+ left-fringe left-margin scroll-bar))
19113 Align to first text column (in header line):
19114 '(space :align-to 0)
19116 Align to middle of text area minus half the width of variable `my-image'
19117 containing a loaded image:
19118 '(space :align-to (0.5 . (- text my-image)))
19120 Width of left margin minus width of 1 character in the default font:
19121 '(space :width (- left-margin 1))
19123 Width of left margin minus width of 2 characters in the current font:
19124 '(space :width (- left-margin (2 . width)))
19126 Center 1 character over left-margin (in header line):
19127 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19129 Different ways to express width of left fringe plus left margin minus one pixel:
19130 '(space :width (- (+ left-fringe left-margin) (1)))
19131 '(space :width (+ left-fringe left-margin (- (1))))
19132 '(space :width (+ left-fringe left-margin (-1)))
19136 #define NUMVAL(X) \
19137 ((INTEGERP (X) || FLOATP (X)) \
19142 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19147 int width_p
, *align_to
;
19151 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19152 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19155 return OK_PIXELS (0);
19157 xassert (FRAME_LIVE_P (it
->f
));
19159 if (SYMBOLP (prop
))
19161 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19163 char *unit
= SDATA (SYMBOL_NAME (prop
));
19165 if (unit
[0] == 'i' && unit
[1] == 'n')
19167 else if (unit
[0] == 'm' && unit
[1] == 'm')
19169 else if (unit
[0] == 'c' && unit
[1] == 'm')
19176 #ifdef HAVE_WINDOW_SYSTEM
19177 if (FRAME_WINDOW_P (it
->f
)
19179 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19180 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19182 return OK_PIXELS (ppi
/ pixels
);
19185 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19186 || (CONSP (Vdisplay_pixels_per_inch
)
19188 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19189 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19191 return OK_PIXELS (ppi
/ pixels
);
19197 #ifdef HAVE_WINDOW_SYSTEM
19198 if (EQ (prop
, Qheight
))
19199 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19200 if (EQ (prop
, Qwidth
))
19201 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19203 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19204 return OK_PIXELS (1);
19207 if (EQ (prop
, Qtext
))
19208 return OK_PIXELS (width_p
19209 ? window_box_width (it
->w
, TEXT_AREA
)
19210 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19212 if (align_to
&& *align_to
< 0)
19215 if (EQ (prop
, Qleft
))
19216 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19217 if (EQ (prop
, Qright
))
19218 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19219 if (EQ (prop
, Qcenter
))
19220 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19221 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19222 if (EQ (prop
, Qleft_fringe
))
19223 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19224 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19225 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19226 if (EQ (prop
, Qright_fringe
))
19227 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19228 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19229 : window_box_right_offset (it
->w
, TEXT_AREA
));
19230 if (EQ (prop
, Qleft_margin
))
19231 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19232 if (EQ (prop
, Qright_margin
))
19233 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19234 if (EQ (prop
, Qscroll_bar
))
19235 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19237 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19238 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19239 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19244 if (EQ (prop
, Qleft_fringe
))
19245 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19246 if (EQ (prop
, Qright_fringe
))
19247 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19248 if (EQ (prop
, Qleft_margin
))
19249 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19250 if (EQ (prop
, Qright_margin
))
19251 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19252 if (EQ (prop
, Qscroll_bar
))
19253 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19256 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19259 if (INTEGERP (prop
) || FLOATP (prop
))
19261 int base_unit
= (width_p
19262 ? FRAME_COLUMN_WIDTH (it
->f
)
19263 : FRAME_LINE_HEIGHT (it
->f
));
19264 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19269 Lisp_Object car
= XCAR (prop
);
19270 Lisp_Object cdr
= XCDR (prop
);
19274 #ifdef HAVE_WINDOW_SYSTEM
19275 if (FRAME_WINDOW_P (it
->f
)
19276 && valid_image_p (prop
))
19278 int id
= lookup_image (it
->f
, prop
);
19279 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19281 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19284 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19290 while (CONSP (cdr
))
19292 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19293 font
, width_p
, align_to
))
19296 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19301 if (EQ (car
, Qminus
))
19303 return OK_PIXELS (pixels
);
19306 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19309 if (INTEGERP (car
) || FLOATP (car
))
19312 pixels
= XFLOATINT (car
);
19314 return OK_PIXELS (pixels
);
19315 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19316 font
, width_p
, align_to
))
19317 return OK_PIXELS (pixels
* fact
);
19328 /***********************************************************************
19330 ***********************************************************************/
19332 #ifdef HAVE_WINDOW_SYSTEM
19337 dump_glyph_string (s
)
19338 struct glyph_string
*s
;
19340 fprintf (stderr
, "glyph string\n");
19341 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19342 s
->x
, s
->y
, s
->width
, s
->height
);
19343 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19344 fprintf (stderr
, " hl = %d\n", s
->hl
);
19345 fprintf (stderr
, " left overhang = %d, right = %d\n",
19346 s
->left_overhang
, s
->right_overhang
);
19347 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19348 fprintf (stderr
, " extends to end of line = %d\n",
19349 s
->extends_to_end_of_line_p
);
19350 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19351 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19354 #endif /* GLYPH_DEBUG */
19356 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19357 of XChar2b structures for S; it can't be allocated in
19358 init_glyph_string because it must be allocated via `alloca'. W
19359 is the window on which S is drawn. ROW and AREA are the glyph row
19360 and area within the row from which S is constructed. START is the
19361 index of the first glyph structure covered by S. HL is a
19362 face-override for drawing S. */
19365 #define OPTIONAL_HDC(hdc) hdc,
19366 #define DECLARE_HDC(hdc) HDC hdc;
19367 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19368 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19371 #ifndef OPTIONAL_HDC
19372 #define OPTIONAL_HDC(hdc)
19373 #define DECLARE_HDC(hdc)
19374 #define ALLOCATE_HDC(hdc, f)
19375 #define RELEASE_HDC(hdc, f)
19379 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19380 struct glyph_string
*s
;
19384 struct glyph_row
*row
;
19385 enum glyph_row_area area
;
19387 enum draw_glyphs_face hl
;
19389 bzero (s
, sizeof *s
);
19391 s
->f
= XFRAME (w
->frame
);
19395 s
->display
= FRAME_X_DISPLAY (s
->f
);
19396 s
->window
= FRAME_X_WINDOW (s
->f
);
19397 s
->char2b
= char2b
;
19401 s
->first_glyph
= row
->glyphs
[area
] + start
;
19402 s
->height
= row
->height
;
19403 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19405 /* Display the internal border below the tool-bar window. */
19406 if (WINDOWP (s
->f
->tool_bar_window
)
19407 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19408 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19410 s
->ybase
= s
->y
+ row
->ascent
;
19414 /* Append the list of glyph strings with head H and tail T to the list
19415 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19418 append_glyph_string_lists (head
, tail
, h
, t
)
19419 struct glyph_string
**head
, **tail
;
19420 struct glyph_string
*h
, *t
;
19434 /* Prepend the list of glyph strings with head H and tail T to the
19435 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19439 prepend_glyph_string_lists (head
, tail
, h
, t
)
19440 struct glyph_string
**head
, **tail
;
19441 struct glyph_string
*h
, *t
;
19455 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19456 Set *HEAD and *TAIL to the resulting list. */
19459 append_glyph_string (head
, tail
, s
)
19460 struct glyph_string
**head
, **tail
;
19461 struct glyph_string
*s
;
19463 s
->next
= s
->prev
= NULL
;
19464 append_glyph_string_lists (head
, tail
, s
, s
);
19468 /* Get face and two-byte form of character C in face FACE_ID on frame
19469 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19470 means we want to display multibyte text. DISPLAY_P non-zero means
19471 make sure that X resources for the face returned are allocated.
19472 Value is a pointer to a realized face that is ready for display if
19473 DISPLAY_P is non-zero. */
19475 static INLINE
struct face
*
19476 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19480 int multibyte_p
, display_p
;
19482 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19486 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19488 if (code
!= FONT_INVALID_CODE
)
19489 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19491 STORE_XCHAR2B (char2b
, 0, 0);
19494 /* Make sure X resources of the face are allocated. */
19495 #ifdef HAVE_X_WINDOWS
19499 xassert (face
!= NULL
);
19500 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19507 /* Get face and two-byte form of character glyph GLYPH on frame F.
19508 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19509 a pointer to a realized face that is ready for display. */
19511 static INLINE
struct face
*
19512 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19514 struct glyph
*glyph
;
19520 xassert (glyph
->type
== CHAR_GLYPH
);
19521 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19528 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19530 if (code
!= FONT_INVALID_CODE
)
19531 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19533 STORE_XCHAR2B (char2b
, 0, 0);
19536 /* Make sure X resources of the face are allocated. */
19537 xassert (face
!= NULL
);
19538 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19543 /* Fill glyph string S with composition components specified by S->cmp.
19545 BASE_FACE is the base face of the composition.
19546 S->cmp_from is the index of the first component for S.
19548 OVERLAPS non-zero means S should draw the foreground only, and use
19549 its physical height for clipping. See also draw_glyphs.
19551 Value is the index of a component not in S. */
19554 fill_composite_glyph_string (s
, base_face
, overlaps
)
19555 struct glyph_string
*s
;
19556 struct face
*base_face
;
19560 /* For all glyphs of this composition, starting at the offset
19561 S->cmp_from, until we reach the end of the definition or encounter a
19562 glyph that requires the different face, add it to S. */
19567 s
->for_overlaps
= overlaps
;
19570 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
19572 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19576 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19579 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19580 s
->char2b
+ i
, 1, 1);
19586 s
->font
= s
->face
->font
;
19588 else if (s
->face
!= face
)
19596 /* All glyph strings for the same composition has the same width,
19597 i.e. the width set for the first component of the composition. */
19598 s
->width
= s
->first_glyph
->pixel_width
;
19600 /* If the specified font could not be loaded, use the frame's
19601 default font, but record the fact that we couldn't load it in
19602 the glyph string so that we can draw rectangles for the
19603 characters of the glyph string. */
19604 if (s
->font
== NULL
)
19606 s
->font_not_found_p
= 1;
19607 s
->font
= FRAME_FONT (s
->f
);
19610 /* Adjust base line for subscript/superscript text. */
19611 s
->ybase
+= s
->first_glyph
->voffset
;
19613 /* This glyph string must always be drawn with 16-bit functions. */
19620 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
19621 struct glyph_string
*s
;
19623 int start
, end
, overlaps
;
19625 struct glyph
*glyph
, *last
;
19626 Lisp_Object lgstring
;
19629 s
->for_overlaps
= overlaps
;
19630 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19631 last
= s
->row
->glyphs
[s
->area
] + end
;
19632 s
->cmp_id
= glyph
->u
.cmp
.id
;
19633 s
->cmp_from
= glyph
->u
.cmp
.from
;
19634 s
->cmp_to
= glyph
->u
.cmp
.to
;
19635 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19636 lgstring
= composition_gstring_from_id (s
->cmp_id
);
19637 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
19639 while (glyph
< last
19640 && glyph
->u
.cmp
.automatic
19641 && glyph
->u
.cmp
.id
== s
->cmp_id
)
19642 s
->cmp_to
= (glyph
++)->u
.cmp
.to
;
19644 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
19646 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
19647 unsigned code
= LGLYPH_CODE (lglyph
);
19649 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
19651 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
19652 return glyph
- s
->row
->glyphs
[s
->area
];
19656 /* Fill glyph string S from a sequence of character glyphs.
19658 FACE_ID is the face id of the string. START is the index of the
19659 first glyph to consider, END is the index of the last + 1.
19660 OVERLAPS non-zero means S should draw the foreground only, and use
19661 its physical height for clipping. See also draw_glyphs.
19663 Value is the index of the first glyph not in S. */
19666 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19667 struct glyph_string
*s
;
19669 int start
, end
, overlaps
;
19671 struct glyph
*glyph
, *last
;
19673 int glyph_not_available_p
;
19675 xassert (s
->f
== XFRAME (s
->w
->frame
));
19676 xassert (s
->nchars
== 0);
19677 xassert (start
>= 0 && end
> start
);
19679 s
->for_overlaps
= overlaps
,
19680 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19681 last
= s
->row
->glyphs
[s
->area
] + end
;
19682 voffset
= glyph
->voffset
;
19683 s
->padding_p
= glyph
->padding_p
;
19684 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19686 while (glyph
< last
19687 && glyph
->type
== CHAR_GLYPH
19688 && glyph
->voffset
== voffset
19689 /* Same face id implies same font, nowadays. */
19690 && glyph
->face_id
== face_id
19691 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19695 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19696 s
->char2b
+ s
->nchars
,
19698 s
->two_byte_p
= two_byte_p
;
19700 xassert (s
->nchars
<= end
- start
);
19701 s
->width
+= glyph
->pixel_width
;
19702 if (glyph
++->padding_p
!= s
->padding_p
)
19706 s
->font
= s
->face
->font
;
19708 /* If the specified font could not be loaded, use the frame's font,
19709 but record the fact that we couldn't load it in
19710 S->font_not_found_p so that we can draw rectangles for the
19711 characters of the glyph string. */
19712 if (s
->font
== NULL
|| glyph_not_available_p
)
19714 s
->font_not_found_p
= 1;
19715 s
->font
= FRAME_FONT (s
->f
);
19718 /* Adjust base line for subscript/superscript text. */
19719 s
->ybase
+= voffset
;
19721 xassert (s
->face
&& s
->face
->gc
);
19722 return glyph
- s
->row
->glyphs
[s
->area
];
19726 /* Fill glyph string S from image glyph S->first_glyph. */
19729 fill_image_glyph_string (s
)
19730 struct glyph_string
*s
;
19732 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19733 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19735 s
->slice
= s
->first_glyph
->slice
;
19736 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19737 s
->font
= s
->face
->font
;
19738 s
->width
= s
->first_glyph
->pixel_width
;
19740 /* Adjust base line for subscript/superscript text. */
19741 s
->ybase
+= s
->first_glyph
->voffset
;
19745 /* Fill glyph string S from a sequence of stretch glyphs.
19747 ROW is the glyph row in which the glyphs are found, AREA is the
19748 area within the row. START is the index of the first glyph to
19749 consider, END is the index of the last + 1.
19751 Value is the index of the first glyph not in S. */
19754 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19755 struct glyph_string
*s
;
19756 struct glyph_row
*row
;
19757 enum glyph_row_area area
;
19760 struct glyph
*glyph
, *last
;
19761 int voffset
, face_id
;
19763 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19765 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19766 last
= s
->row
->glyphs
[s
->area
] + end
;
19767 face_id
= glyph
->face_id
;
19768 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19769 s
->font
= s
->face
->font
;
19770 s
->width
= glyph
->pixel_width
;
19772 voffset
= glyph
->voffset
;
19776 && glyph
->type
== STRETCH_GLYPH
19777 && glyph
->voffset
== voffset
19778 && glyph
->face_id
== face_id
);
19780 s
->width
+= glyph
->pixel_width
;
19782 /* Adjust base line for subscript/superscript text. */
19783 s
->ybase
+= voffset
;
19785 /* The case that face->gc == 0 is handled when drawing the glyph
19786 string by calling PREPARE_FACE_FOR_DISPLAY. */
19788 return glyph
- s
->row
->glyphs
[s
->area
];
19791 static struct font_metrics
*
19792 get_per_char_metric (f
, font
, char2b
)
19797 static struct font_metrics metrics
;
19798 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19800 if (! font
|| code
== FONT_INVALID_CODE
)
19802 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19807 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19808 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19809 assumed to be zero. */
19812 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19813 struct glyph
*glyph
;
19817 *left
= *right
= 0;
19819 if (glyph
->type
== CHAR_GLYPH
)
19823 struct font_metrics
*pcm
;
19825 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19826 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19828 if (pcm
->rbearing
> pcm
->width
)
19829 *right
= pcm
->rbearing
- pcm
->width
;
19830 if (pcm
->lbearing
< 0)
19831 *left
= -pcm
->lbearing
;
19834 else if (glyph
->type
== COMPOSITE_GLYPH
)
19836 if (! glyph
->u
.cmp
.automatic
)
19838 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
19840 if (cmp
->rbearing
- cmp
->pixel_width
)
19841 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19842 if (cmp
->lbearing
< 0);
19843 *left
= - cmp
->lbearing
;
19847 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
19848 struct font_metrics metrics
;
19850 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
19851 glyph
->u
.cmp
.to
, &metrics
);
19852 if (metrics
.rbearing
> metrics
.width
)
19853 *right
= metrics
.rbearing
;
19854 if (metrics
.lbearing
< 0)
19855 *left
= - metrics
.lbearing
;
19861 /* Return the index of the first glyph preceding glyph string S that
19862 is overwritten by S because of S's left overhang. Value is -1
19863 if no glyphs are overwritten. */
19866 left_overwritten (s
)
19867 struct glyph_string
*s
;
19871 if (s
->left_overhang
)
19874 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19875 int first
= s
->first_glyph
- glyphs
;
19877 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19878 x
-= glyphs
[i
].pixel_width
;
19889 /* Return the index of the first glyph preceding glyph string S that
19890 is overwriting S because of its right overhang. Value is -1 if no
19891 glyph in front of S overwrites S. */
19894 left_overwriting (s
)
19895 struct glyph_string
*s
;
19898 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19899 int first
= s
->first_glyph
- glyphs
;
19903 for (i
= first
- 1; i
>= 0; --i
)
19906 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19909 x
-= glyphs
[i
].pixel_width
;
19916 /* Return the index of the last glyph following glyph string S that is
19917 overwritten by S because of S's right overhang. Value is -1 if
19918 no such glyph is found. */
19921 right_overwritten (s
)
19922 struct glyph_string
*s
;
19926 if (s
->right_overhang
)
19929 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19930 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19931 int end
= s
->row
->used
[s
->area
];
19933 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19934 x
+= glyphs
[i
].pixel_width
;
19943 /* Return the index of the last glyph following glyph string S that
19944 overwrites S because of its left overhang. Value is negative
19945 if no such glyph is found. */
19948 right_overwriting (s
)
19949 struct glyph_string
*s
;
19952 int end
= s
->row
->used
[s
->area
];
19953 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19954 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19958 for (i
= first
; i
< end
; ++i
)
19961 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19964 x
+= glyphs
[i
].pixel_width
;
19971 /* Set background width of glyph string S. START is the index of the
19972 first glyph following S. LAST_X is the right-most x-position + 1
19973 in the drawing area. */
19976 set_glyph_string_background_width (s
, start
, last_x
)
19977 struct glyph_string
*s
;
19981 /* If the face of this glyph string has to be drawn to the end of
19982 the drawing area, set S->extends_to_end_of_line_p. */
19984 if (start
== s
->row
->used
[s
->area
]
19985 && s
->area
== TEXT_AREA
19986 && ((s
->row
->fill_line_p
19987 && (s
->hl
== DRAW_NORMAL_TEXT
19988 || s
->hl
== DRAW_IMAGE_RAISED
19989 || s
->hl
== DRAW_IMAGE_SUNKEN
))
19990 || s
->hl
== DRAW_MOUSE_FACE
))
19991 s
->extends_to_end_of_line_p
= 1;
19993 /* If S extends its face to the end of the line, set its
19994 background_width to the distance to the right edge of the drawing
19996 if (s
->extends_to_end_of_line_p
)
19997 s
->background_width
= last_x
- s
->x
+ 1;
19999 s
->background_width
= s
->width
;
20003 /* Compute overhangs and x-positions for glyph string S and its
20004 predecessors, or successors. X is the starting x-position for S.
20005 BACKWARD_P non-zero means process predecessors. */
20008 compute_overhangs_and_x (s
, x
, backward_p
)
20009 struct glyph_string
*s
;
20017 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20018 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20028 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20029 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20039 /* The following macros are only called from draw_glyphs below.
20040 They reference the following parameters of that function directly:
20041 `w', `row', `area', and `overlap_p'
20042 as well as the following local variables:
20043 `s', `f', and `hdc' (in W32) */
20046 /* On W32, silently add local `hdc' variable to argument list of
20047 init_glyph_string. */
20048 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20049 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20051 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20052 init_glyph_string (s, char2b, w, row, area, start, hl)
20055 /* Add a glyph string for a stretch glyph to the list of strings
20056 between HEAD and TAIL. START is the index of the stretch glyph in
20057 row area AREA of glyph row ROW. END is the index of the last glyph
20058 in that glyph row area. X is the current output position assigned
20059 to the new glyph string constructed. HL overrides that face of the
20060 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20061 is the right-most x-position of the drawing area. */
20063 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20064 and below -- keep them on one line. */
20065 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20068 s = (struct glyph_string *) alloca (sizeof *s); \
20069 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20070 START = fill_stretch_glyph_string (s, row, area, START, END); \
20071 append_glyph_string (&HEAD, &TAIL, s); \
20077 /* Add a glyph string for an image glyph to the list of strings
20078 between HEAD and TAIL. START is the index of the image glyph in
20079 row area AREA of glyph row ROW. END is the index of the last glyph
20080 in that glyph row area. X is the current output position assigned
20081 to the new glyph string constructed. HL overrides that face of the
20082 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20083 is the right-most x-position of the drawing area. */
20085 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20088 s = (struct glyph_string *) alloca (sizeof *s); \
20089 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20090 fill_image_glyph_string (s); \
20091 append_glyph_string (&HEAD, &TAIL, s); \
20098 /* Add a glyph string for a sequence of character glyphs to the list
20099 of strings between HEAD and TAIL. START is the index of the first
20100 glyph in row area AREA of glyph row ROW that is part of the new
20101 glyph string. END is the index of the last glyph in that glyph row
20102 area. X is the current output position assigned to the new glyph
20103 string constructed. HL overrides that face of the glyph; e.g. it
20104 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20105 right-most x-position of the drawing area. */
20107 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20113 face_id = (row)->glyphs[area][START].face_id; \
20115 s = (struct glyph_string *) alloca (sizeof *s); \
20116 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20117 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20118 append_glyph_string (&HEAD, &TAIL, s); \
20120 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20125 /* Add a glyph string for a composite sequence to the list of strings
20126 between HEAD and TAIL. START is the index of the first glyph in
20127 row area AREA of glyph row ROW that is part of the new glyph
20128 string. END is the index of the last glyph in that glyph row area.
20129 X is the current output position assigned to the new glyph string
20130 constructed. HL overrides that face of the glyph; e.g. it is
20131 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20132 x-position of the drawing area. */
20134 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20136 int face_id = (row)->glyphs[area][START].face_id; \
20137 struct face *base_face = FACE_FROM_ID (f, face_id); \
20138 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20139 struct composition *cmp = composition_table[cmp_id]; \
20141 struct glyph_string *first_s; \
20144 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20146 /* Make glyph_strings for each glyph sequence that is drawable by \
20147 the same face, and append them to HEAD/TAIL. */ \
20148 for (n = 0; n < cmp->glyph_len;) \
20150 s = (struct glyph_string *) alloca (sizeof *s); \
20151 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20152 append_glyph_string (&(HEAD), &(TAIL), s); \
20158 n = fill_composite_glyph_string (s, base_face, overlaps); \
20166 /* Add a glyph string for a glyph-string sequence to the list of strings
20167 between HEAD and TAIL. */
20169 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20173 Lisp_Object gstring; \
20175 face_id = (row)->glyphs[area][START].face_id; \
20176 gstring = (composition_gstring_from_id \
20177 ((row)->glyphs[area][START].u.cmp.id)); \
20178 s = (struct glyph_string *) alloca (sizeof *s); \
20179 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20180 * LGSTRING_GLYPH_LEN (gstring)); \
20181 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20182 append_glyph_string (&(HEAD), &(TAIL), s); \
20184 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20188 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20189 of AREA of glyph row ROW on window W between indices START and END.
20190 HL overrides the face for drawing glyph strings, e.g. it is
20191 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20192 x-positions of the drawing area.
20194 This is an ugly monster macro construct because we must use alloca
20195 to allocate glyph strings (because draw_glyphs can be called
20196 asynchronously). */
20198 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20201 HEAD = TAIL = NULL; \
20202 while (START < END) \
20204 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20205 switch (first_glyph->type) \
20208 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20212 case COMPOSITE_GLYPH: \
20213 if (first_glyph->u.cmp.automatic) \
20214 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
20217 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20221 case STRETCH_GLYPH: \
20222 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20226 case IMAGE_GLYPH: \
20227 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20237 set_glyph_string_background_width (s, START, LAST_X); \
20244 /* Draw glyphs between START and END in AREA of ROW on window W,
20245 starting at x-position X. X is relative to AREA in W. HL is a
20246 face-override with the following meaning:
20248 DRAW_NORMAL_TEXT draw normally
20249 DRAW_CURSOR draw in cursor face
20250 DRAW_MOUSE_FACE draw in mouse face.
20251 DRAW_INVERSE_VIDEO draw in mode line face
20252 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20253 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20255 If OVERLAPS is non-zero, draw only the foreground of characters and
20256 clip to the physical height of ROW. Non-zero value also defines
20257 the overlapping part to be drawn:
20259 OVERLAPS_PRED overlap with preceding rows
20260 OVERLAPS_SUCC overlap with succeeding rows
20261 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20262 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20264 Value is the x-position reached, relative to AREA of W. */
20267 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20270 struct glyph_row
*row
;
20271 enum glyph_row_area area
;
20272 EMACS_INT start
, end
;
20273 enum draw_glyphs_face hl
;
20276 struct glyph_string
*head
, *tail
;
20277 struct glyph_string
*s
;
20278 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20279 int i
, j
, x_reached
, last_x
, area_left
= 0;
20280 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20283 ALLOCATE_HDC (hdc
, f
);
20285 /* Let's rather be paranoid than getting a SEGV. */
20286 end
= min (end
, row
->used
[area
]);
20287 start
= max (0, start
);
20288 start
= min (end
, start
);
20290 /* Translate X to frame coordinates. Set last_x to the right
20291 end of the drawing area. */
20292 if (row
->full_width_p
)
20294 /* X is relative to the left edge of W, without scroll bars
20296 area_left
= WINDOW_LEFT_EDGE_X (w
);
20297 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20301 area_left
= window_box_left (w
, area
);
20302 last_x
= area_left
+ window_box_width (w
, area
);
20306 /* Build a doubly-linked list of glyph_string structures between
20307 head and tail from what we have to draw. Note that the macro
20308 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20309 the reason we use a separate variable `i'. */
20311 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20313 x_reached
= tail
->x
+ tail
->background_width
;
20317 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20318 the row, redraw some glyphs in front or following the glyph
20319 strings built above. */
20320 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20322 struct glyph_string
*h
, *t
;
20323 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20324 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20327 /* If mouse highlighting is on, we may need to draw adjacent
20328 glyphs using mouse-face highlighting. */
20329 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20331 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20333 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20334 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20336 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20338 check_mouse_face
= 1;
20339 mouse_beg_col
= (row
== mouse_beg_row
)
20340 ? dpyinfo
->mouse_face_beg_col
: 0;
20341 mouse_end_col
= (row
== mouse_end_row
)
20342 ? dpyinfo
->mouse_face_end_col
20343 : row
->used
[TEXT_AREA
];
20347 /* Compute overhangs for all glyph strings. */
20348 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20349 for (s
= head
; s
; s
= s
->next
)
20350 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20352 /* Prepend glyph strings for glyphs in front of the first glyph
20353 string that are overwritten because of the first glyph
20354 string's left overhang. The background of all strings
20355 prepended must be drawn because the first glyph string
20357 i
= left_overwritten (head
);
20360 enum draw_glyphs_face overlap_hl
;
20362 /* If this row contains mouse highlighting, attempt to draw
20363 the overlapped glyphs with the correct highlight. This
20364 code fails if the overlap encompasses more than one glyph
20365 and mouse-highlight spans only some of these glyphs.
20366 However, making it work perfectly involves a lot more
20367 code, and I don't know if the pathological case occurs in
20368 practice, so we'll stick to this for now. --- cyd */
20369 if (check_mouse_face
20370 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20371 overlap_hl
= DRAW_MOUSE_FACE
;
20373 overlap_hl
= DRAW_NORMAL_TEXT
;
20376 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20377 overlap_hl
, dummy_x
, last_x
);
20378 compute_overhangs_and_x (t
, head
->x
, 1);
20379 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20383 /* Prepend glyph strings for glyphs in front of the first glyph
20384 string that overwrite that glyph string because of their
20385 right overhang. For these strings, only the foreground must
20386 be drawn, because it draws over the glyph string at `head'.
20387 The background must not be drawn because this would overwrite
20388 right overhangs of preceding glyphs for which no glyph
20390 i
= left_overwriting (head
);
20393 enum draw_glyphs_face overlap_hl
;
20395 if (check_mouse_face
20396 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20397 overlap_hl
= DRAW_MOUSE_FACE
;
20399 overlap_hl
= DRAW_NORMAL_TEXT
;
20402 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20403 overlap_hl
, dummy_x
, last_x
);
20404 for (s
= h
; s
; s
= s
->next
)
20405 s
->background_filled_p
= 1;
20406 compute_overhangs_and_x (t
, head
->x
, 1);
20407 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20410 /* Append glyphs strings for glyphs following the last glyph
20411 string tail that are overwritten by tail. The background of
20412 these strings has to be drawn because tail's foreground draws
20414 i
= right_overwritten (tail
);
20417 enum draw_glyphs_face overlap_hl
;
20419 if (check_mouse_face
20420 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20421 overlap_hl
= DRAW_MOUSE_FACE
;
20423 overlap_hl
= DRAW_NORMAL_TEXT
;
20425 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20426 overlap_hl
, x
, last_x
);
20427 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20428 append_glyph_string_lists (&head
, &tail
, h
, t
);
20432 /* Append glyph strings for glyphs following the last glyph
20433 string tail that overwrite tail. The foreground of such
20434 glyphs has to be drawn because it writes into the background
20435 of tail. The background must not be drawn because it could
20436 paint over the foreground of following glyphs. */
20437 i
= right_overwriting (tail
);
20440 enum draw_glyphs_face overlap_hl
;
20441 if (check_mouse_face
20442 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20443 overlap_hl
= DRAW_MOUSE_FACE
;
20445 overlap_hl
= DRAW_NORMAL_TEXT
;
20448 i
++; /* We must include the Ith glyph. */
20449 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20450 overlap_hl
, x
, last_x
);
20451 for (s
= h
; s
; s
= s
->next
)
20452 s
->background_filled_p
= 1;
20453 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20454 append_glyph_string_lists (&head
, &tail
, h
, t
);
20456 if (clip_head
|| clip_tail
)
20457 for (s
= head
; s
; s
= s
->next
)
20459 s
->clip_head
= clip_head
;
20460 s
->clip_tail
= clip_tail
;
20464 /* Draw all strings. */
20465 for (s
= head
; s
; s
= s
->next
)
20466 FRAME_RIF (f
)->draw_glyph_string (s
);
20468 if (area
== TEXT_AREA
20469 && !row
->full_width_p
20470 /* When drawing overlapping rows, only the glyph strings'
20471 foreground is drawn, which doesn't erase a cursor
20475 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20476 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20477 : (tail
? tail
->x
+ tail
->background_width
: x
));
20481 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20482 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20485 /* Value is the x-position up to which drawn, relative to AREA of W.
20486 This doesn't include parts drawn because of overhangs. */
20487 if (row
->full_width_p
)
20488 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20490 x_reached
-= area_left
;
20492 RELEASE_HDC (hdc
, f
);
20497 /* Expand row matrix if too narrow. Don't expand if area
20500 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20502 if (!fonts_changed_p \
20503 && (it->glyph_row->glyphs[area] \
20504 < it->glyph_row->glyphs[area + 1])) \
20506 it->w->ncols_scale_factor++; \
20507 fonts_changed_p = 1; \
20511 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20512 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20518 struct glyph
*glyph
;
20519 enum glyph_row_area area
= it
->area
;
20521 xassert (it
->glyph_row
);
20522 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20524 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20525 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20527 glyph
->charpos
= CHARPOS (it
->position
);
20528 glyph
->object
= it
->object
;
20529 if (it
->pixel_width
> 0)
20531 glyph
->pixel_width
= it
->pixel_width
;
20532 glyph
->padding_p
= 0;
20536 /* Assure at least 1-pixel width. Otherwise, cursor can't
20537 be displayed correctly. */
20538 glyph
->pixel_width
= 1;
20539 glyph
->padding_p
= 1;
20541 glyph
->ascent
= it
->ascent
;
20542 glyph
->descent
= it
->descent
;
20543 glyph
->voffset
= it
->voffset
;
20544 glyph
->type
= CHAR_GLYPH
;
20545 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20546 glyph
->multibyte_p
= it
->multibyte_p
;
20547 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20548 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20549 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20550 || it
->phys_descent
> it
->descent
);
20551 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20552 glyph
->face_id
= it
->face_id
;
20553 glyph
->u
.ch
= it
->char_to_display
;
20554 glyph
->slice
= null_glyph_slice
;
20555 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20556 ++it
->glyph_row
->used
[area
];
20559 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20562 /* Store one glyph for the composition IT->cmp_it.id in
20563 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
20567 append_composite_glyph (it
)
20570 struct glyph
*glyph
;
20571 enum glyph_row_area area
= it
->area
;
20573 xassert (it
->glyph_row
);
20575 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20576 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20578 glyph
->charpos
= CHARPOS (it
->position
);
20579 glyph
->object
= it
->object
;
20580 glyph
->pixel_width
= it
->pixel_width
;
20581 glyph
->ascent
= it
->ascent
;
20582 glyph
->descent
= it
->descent
;
20583 glyph
->voffset
= it
->voffset
;
20584 glyph
->type
= COMPOSITE_GLYPH
;
20585 if (it
->cmp_it
.ch
< 0)
20587 glyph
->u
.cmp
.automatic
= 0;
20588 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20592 glyph
->u
.cmp
.automatic
= 1;
20593 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20594 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
20595 glyph
->u
.cmp
.to
= it
->cmp_it
.to
;
20597 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20598 glyph
->multibyte_p
= it
->multibyte_p
;
20599 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20600 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20601 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20602 || it
->phys_descent
> it
->descent
);
20603 glyph
->padding_p
= 0;
20604 glyph
->glyph_not_available_p
= 0;
20605 glyph
->face_id
= it
->face_id
;
20606 glyph
->slice
= null_glyph_slice
;
20607 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20608 ++it
->glyph_row
->used
[area
];
20611 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20615 /* Change IT->ascent and IT->height according to the setting of
20619 take_vertical_position_into_account (it
)
20624 if (it
->voffset
< 0)
20625 /* Increase the ascent so that we can display the text higher
20627 it
->ascent
-= it
->voffset
;
20629 /* Increase the descent so that we can display the text lower
20631 it
->descent
+= it
->voffset
;
20636 /* Produce glyphs/get display metrics for the image IT is loaded with.
20637 See the description of struct display_iterator in dispextern.h for
20638 an overview of struct display_iterator. */
20641 produce_image_glyph (it
)
20646 int glyph_ascent
, crop
;
20647 struct glyph_slice slice
;
20649 xassert (it
->what
== IT_IMAGE
);
20651 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20653 /* Make sure X resources of the face is loaded. */
20654 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20656 if (it
->image_id
< 0)
20658 /* Fringe bitmap. */
20659 it
->ascent
= it
->phys_ascent
= 0;
20660 it
->descent
= it
->phys_descent
= 0;
20661 it
->pixel_width
= 0;
20666 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20668 /* Make sure X resources of the image is loaded. */
20669 prepare_image_for_display (it
->f
, img
);
20671 slice
.x
= slice
.y
= 0;
20672 slice
.width
= img
->width
;
20673 slice
.height
= img
->height
;
20675 if (INTEGERP (it
->slice
.x
))
20676 slice
.x
= XINT (it
->slice
.x
);
20677 else if (FLOATP (it
->slice
.x
))
20678 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20680 if (INTEGERP (it
->slice
.y
))
20681 slice
.y
= XINT (it
->slice
.y
);
20682 else if (FLOATP (it
->slice
.y
))
20683 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20685 if (INTEGERP (it
->slice
.width
))
20686 slice
.width
= XINT (it
->slice
.width
);
20687 else if (FLOATP (it
->slice
.width
))
20688 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20690 if (INTEGERP (it
->slice
.height
))
20691 slice
.height
= XINT (it
->slice
.height
);
20692 else if (FLOATP (it
->slice
.height
))
20693 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20695 if (slice
.x
>= img
->width
)
20696 slice
.x
= img
->width
;
20697 if (slice
.y
>= img
->height
)
20698 slice
.y
= img
->height
;
20699 if (slice
.x
+ slice
.width
>= img
->width
)
20700 slice
.width
= img
->width
- slice
.x
;
20701 if (slice
.y
+ slice
.height
> img
->height
)
20702 slice
.height
= img
->height
- slice
.y
;
20704 if (slice
.width
== 0 || slice
.height
== 0)
20707 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20709 it
->descent
= slice
.height
- glyph_ascent
;
20711 it
->descent
+= img
->vmargin
;
20712 if (slice
.y
+ slice
.height
== img
->height
)
20713 it
->descent
+= img
->vmargin
;
20714 it
->phys_descent
= it
->descent
;
20716 it
->pixel_width
= slice
.width
;
20718 it
->pixel_width
+= img
->hmargin
;
20719 if (slice
.x
+ slice
.width
== img
->width
)
20720 it
->pixel_width
+= img
->hmargin
;
20722 /* It's quite possible for images to have an ascent greater than
20723 their height, so don't get confused in that case. */
20724 if (it
->descent
< 0)
20727 #if 0 /* this breaks image tiling */
20728 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20729 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20730 if (face_ascent
> it
->ascent
)
20731 it
->ascent
= it
->phys_ascent
= face_ascent
;
20736 if (face
->box
!= FACE_NO_BOX
)
20738 if (face
->box_line_width
> 0)
20741 it
->ascent
+= face
->box_line_width
;
20742 if (slice
.y
+ slice
.height
== img
->height
)
20743 it
->descent
+= face
->box_line_width
;
20746 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20747 it
->pixel_width
+= eabs (face
->box_line_width
);
20748 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20749 it
->pixel_width
+= eabs (face
->box_line_width
);
20752 take_vertical_position_into_account (it
);
20754 /* Automatically crop wide image glyphs at right edge so we can
20755 draw the cursor on same display row. */
20756 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20757 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20759 it
->pixel_width
-= crop
;
20760 slice
.width
-= crop
;
20765 struct glyph
*glyph
;
20766 enum glyph_row_area area
= it
->area
;
20768 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20769 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20771 glyph
->charpos
= CHARPOS (it
->position
);
20772 glyph
->object
= it
->object
;
20773 glyph
->pixel_width
= it
->pixel_width
;
20774 glyph
->ascent
= glyph_ascent
;
20775 glyph
->descent
= it
->descent
;
20776 glyph
->voffset
= it
->voffset
;
20777 glyph
->type
= IMAGE_GLYPH
;
20778 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20779 glyph
->multibyte_p
= it
->multibyte_p
;
20780 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20781 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20782 glyph
->overlaps_vertically_p
= 0;
20783 glyph
->padding_p
= 0;
20784 glyph
->glyph_not_available_p
= 0;
20785 glyph
->face_id
= it
->face_id
;
20786 glyph
->u
.img_id
= img
->id
;
20787 glyph
->slice
= slice
;
20788 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20789 ++it
->glyph_row
->used
[area
];
20792 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20797 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20798 of the glyph, WIDTH and HEIGHT are the width and height of the
20799 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20802 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20804 Lisp_Object object
;
20808 struct glyph
*glyph
;
20809 enum glyph_row_area area
= it
->area
;
20811 xassert (ascent
>= 0 && ascent
<= height
);
20813 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20814 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20816 glyph
->charpos
= CHARPOS (it
->position
);
20817 glyph
->object
= object
;
20818 glyph
->pixel_width
= width
;
20819 glyph
->ascent
= ascent
;
20820 glyph
->descent
= height
- ascent
;
20821 glyph
->voffset
= it
->voffset
;
20822 glyph
->type
= STRETCH_GLYPH
;
20823 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20824 glyph
->multibyte_p
= it
->multibyte_p
;
20825 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20826 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20827 glyph
->overlaps_vertically_p
= 0;
20828 glyph
->padding_p
= 0;
20829 glyph
->glyph_not_available_p
= 0;
20830 glyph
->face_id
= it
->face_id
;
20831 glyph
->u
.stretch
.ascent
= ascent
;
20832 glyph
->u
.stretch
.height
= height
;
20833 glyph
->slice
= null_glyph_slice
;
20834 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20835 ++it
->glyph_row
->used
[area
];
20838 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20842 /* Produce a stretch glyph for iterator IT. IT->object is the value
20843 of the glyph property displayed. The value must be a list
20844 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20847 1. `:width WIDTH' specifies that the space should be WIDTH *
20848 canonical char width wide. WIDTH may be an integer or floating
20851 2. `:relative-width FACTOR' specifies that the width of the stretch
20852 should be computed from the width of the first character having the
20853 `glyph' property, and should be FACTOR times that width.
20855 3. `:align-to HPOS' specifies that the space should be wide enough
20856 to reach HPOS, a value in canonical character units.
20858 Exactly one of the above pairs must be present.
20860 4. `:height HEIGHT' specifies that the height of the stretch produced
20861 should be HEIGHT, measured in canonical character units.
20863 5. `:relative-height FACTOR' specifies that the height of the
20864 stretch should be FACTOR times the height of the characters having
20865 the glyph property.
20867 Either none or exactly one of 4 or 5 must be present.
20869 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20870 of the stretch should be used for the ascent of the stretch.
20871 ASCENT must be in the range 0 <= ASCENT <= 100. */
20874 produce_stretch_glyph (it
)
20877 /* (space :width WIDTH :height HEIGHT ...) */
20878 Lisp_Object prop
, plist
;
20879 int width
= 0, height
= 0, align_to
= -1;
20880 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20883 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20884 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20886 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20888 /* List should start with `space'. */
20889 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20890 plist
= XCDR (it
->object
);
20892 /* Compute the width of the stretch. */
20893 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20894 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20896 /* Absolute width `:width WIDTH' specified and valid. */
20897 zero_width_ok_p
= 1;
20900 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20903 /* Relative width `:relative-width FACTOR' specified and valid.
20904 Compute the width of the characters having the `glyph'
20907 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20910 if (it
->multibyte_p
)
20912 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20913 - IT_BYTEPOS (*it
));
20914 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20917 it2
.c
= *p
, it2
.len
= 1;
20919 it2
.glyph_row
= NULL
;
20920 it2
.what
= IT_CHARACTER
;
20921 x_produce_glyphs (&it2
);
20922 width
= NUMVAL (prop
) * it2
.pixel_width
;
20924 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20925 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20927 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20928 align_to
= (align_to
< 0
20930 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20931 else if (align_to
< 0)
20932 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20933 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20934 zero_width_ok_p
= 1;
20937 /* Nothing specified -> width defaults to canonical char width. */
20938 width
= FRAME_COLUMN_WIDTH (it
->f
);
20940 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20943 /* Compute height. */
20944 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20945 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20948 zero_height_ok_p
= 1;
20950 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20952 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20954 height
= FONT_HEIGHT (font
);
20956 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20959 /* Compute percentage of height used for ascent. If
20960 `:ascent ASCENT' is present and valid, use that. Otherwise,
20961 derive the ascent from the font in use. */
20962 if (prop
= Fplist_get (plist
, QCascent
),
20963 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20964 ascent
= height
* NUMVAL (prop
) / 100.0;
20965 else if (!NILP (prop
)
20966 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20967 ascent
= min (max (0, (int)tem
), height
);
20969 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20971 if (width
> 0 && it
->line_wrap
!= TRUNCATE
20972 && it
->current_x
+ width
> it
->last_visible_x
)
20973 width
= it
->last_visible_x
- it
->current_x
- 1;
20975 if (width
> 0 && height
> 0 && it
->glyph_row
)
20977 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20978 if (!STRINGP (object
))
20979 object
= it
->w
->buffer
;
20980 append_stretch_glyph (it
, object
, width
, height
, ascent
);
20983 it
->pixel_width
= width
;
20984 it
->ascent
= it
->phys_ascent
= ascent
;
20985 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
20986 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
20988 take_vertical_position_into_account (it
);
20991 /* Calculate line-height and line-spacing properties.
20992 An integer value specifies explicit pixel value.
20993 A float value specifies relative value to current face height.
20994 A cons (float . face-name) specifies relative value to
20995 height of specified face font.
20997 Returns height in pixels, or nil. */
21001 calc_line_height_property (it
, val
, font
, boff
, override
)
21005 int boff
, override
;
21007 Lisp_Object face_name
= Qnil
;
21008 int ascent
, descent
, height
;
21010 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21015 face_name
= XCAR (val
);
21017 if (!NUMBERP (val
))
21018 val
= make_number (1);
21019 if (NILP (face_name
))
21021 height
= it
->ascent
+ it
->descent
;
21026 if (NILP (face_name
))
21028 font
= FRAME_FONT (it
->f
);
21029 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21031 else if (EQ (face_name
, Qt
))
21040 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21042 return make_number (-1);
21044 face
= FACE_FROM_ID (it
->f
, face_id
);
21047 return make_number (-1);
21048 boff
= font
->baseline_offset
;
21049 if (font
->vertical_centering
)
21050 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21053 ascent
= FONT_BASE (font
) + boff
;
21054 descent
= FONT_DESCENT (font
) - boff
;
21058 it
->override_ascent
= ascent
;
21059 it
->override_descent
= descent
;
21060 it
->override_boff
= boff
;
21063 height
= ascent
+ descent
;
21067 height
= (int)(XFLOAT_DATA (val
) * height
);
21068 else if (INTEGERP (val
))
21069 height
*= XINT (val
);
21071 return make_number (height
);
21076 Produce glyphs/get display metrics for the display element IT is
21077 loaded with. See the description of struct it in dispextern.h
21078 for an overview of struct it. */
21081 x_produce_glyphs (it
)
21084 int extra_line_spacing
= it
->extra_line_spacing
;
21086 it
->glyph_not_available_p
= 0;
21088 if (it
->what
== IT_CHARACTER
)
21092 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21093 struct font_metrics
*pcm
;
21094 int font_not_found_p
;
21095 int boff
; /* baseline offset */
21096 /* We may change it->multibyte_p upon unibyte<->multibyte
21097 conversion. So, save the current value now and restore it
21100 Note: It seems that we don't have to record multibyte_p in
21101 struct glyph because the character code itself tells if or
21102 not the character is multibyte. Thus, in the future, we must
21103 consider eliminating the field `multibyte_p' in the struct
21105 int saved_multibyte_p
= it
->multibyte_p
;
21107 /* Maybe translate single-byte characters to multibyte, or the
21109 it
->char_to_display
= it
->c
;
21110 if (!ASCII_BYTE_P (it
->c
)
21111 && ! it
->multibyte_p
)
21113 if (SINGLE_BYTE_CHAR_P (it
->c
)
21114 && unibyte_display_via_language_environment
)
21115 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
21116 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
21118 it
->multibyte_p
= 1;
21119 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21121 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21125 /* Get font to use. Encode IT->char_to_display. */
21126 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21127 &char2b
, it
->multibyte_p
, 0);
21130 /* When no suitable font found, use the default font. */
21131 font_not_found_p
= font
== NULL
;
21132 if (font_not_found_p
)
21134 font
= FRAME_FONT (it
->f
);
21135 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21139 boff
= font
->baseline_offset
;
21140 if (font
->vertical_centering
)
21141 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21144 if (it
->char_to_display
>= ' '
21145 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21147 /* Either unibyte or ASCII. */
21152 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21154 if (it
->override_ascent
>= 0)
21156 it
->ascent
= it
->override_ascent
;
21157 it
->descent
= it
->override_descent
;
21158 boff
= it
->override_boff
;
21162 it
->ascent
= FONT_BASE (font
) + boff
;
21163 it
->descent
= FONT_DESCENT (font
) - boff
;
21168 it
->phys_ascent
= pcm
->ascent
+ boff
;
21169 it
->phys_descent
= pcm
->descent
- boff
;
21170 it
->pixel_width
= pcm
->width
;
21174 it
->glyph_not_available_p
= 1;
21175 it
->phys_ascent
= it
->ascent
;
21176 it
->phys_descent
= it
->descent
;
21177 it
->pixel_width
= FONT_WIDTH (font
);
21180 if (it
->constrain_row_ascent_descent_p
)
21182 if (it
->descent
> it
->max_descent
)
21184 it
->ascent
+= it
->descent
- it
->max_descent
;
21185 it
->descent
= it
->max_descent
;
21187 if (it
->ascent
> it
->max_ascent
)
21189 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21190 it
->ascent
= it
->max_ascent
;
21192 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21193 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21194 extra_line_spacing
= 0;
21197 /* If this is a space inside a region of text with
21198 `space-width' property, change its width. */
21199 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21201 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21203 /* If face has a box, add the box thickness to the character
21204 height. If character has a box line to the left and/or
21205 right, add the box line width to the character's width. */
21206 if (face
->box
!= FACE_NO_BOX
)
21208 int thick
= face
->box_line_width
;
21212 it
->ascent
+= thick
;
21213 it
->descent
+= thick
;
21218 if (it
->start_of_box_run_p
)
21219 it
->pixel_width
+= thick
;
21220 if (it
->end_of_box_run_p
)
21221 it
->pixel_width
+= thick
;
21224 /* If face has an overline, add the height of the overline
21225 (1 pixel) and a 1 pixel margin to the character height. */
21226 if (face
->overline_p
)
21227 it
->ascent
+= overline_margin
;
21229 if (it
->constrain_row_ascent_descent_p
)
21231 if (it
->ascent
> it
->max_ascent
)
21232 it
->ascent
= it
->max_ascent
;
21233 if (it
->descent
> it
->max_descent
)
21234 it
->descent
= it
->max_descent
;
21237 take_vertical_position_into_account (it
);
21239 /* If we have to actually produce glyphs, do it. */
21244 /* Translate a space with a `space-width' property
21245 into a stretch glyph. */
21246 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21247 / FONT_HEIGHT (font
));
21248 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21249 it
->ascent
+ it
->descent
, ascent
);
21254 /* If characters with lbearing or rbearing are displayed
21255 in this line, record that fact in a flag of the
21256 glyph row. This is used to optimize X output code. */
21257 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21258 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21260 if (! stretched_p
&& it
->pixel_width
== 0)
21261 /* We assure that all visible glyphs have at least 1-pixel
21263 it
->pixel_width
= 1;
21265 else if (it
->char_to_display
== '\n')
21267 /* A newline has no width but we need the height of the line.
21268 But if previous part of the line set a height, don't
21269 increase that height */
21271 Lisp_Object height
;
21272 Lisp_Object total_height
= Qnil
;
21274 it
->override_ascent
= -1;
21275 it
->pixel_width
= 0;
21278 height
= get_it_property(it
, Qline_height
);
21279 /* Split (line-height total-height) list */
21281 && CONSP (XCDR (height
))
21282 && NILP (XCDR (XCDR (height
))))
21284 total_height
= XCAR (XCDR (height
));
21285 height
= XCAR (height
);
21287 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21289 if (it
->override_ascent
>= 0)
21291 it
->ascent
= it
->override_ascent
;
21292 it
->descent
= it
->override_descent
;
21293 boff
= it
->override_boff
;
21297 it
->ascent
= FONT_BASE (font
) + boff
;
21298 it
->descent
= FONT_DESCENT (font
) - boff
;
21301 if (EQ (height
, Qt
))
21303 if (it
->descent
> it
->max_descent
)
21305 it
->ascent
+= it
->descent
- it
->max_descent
;
21306 it
->descent
= it
->max_descent
;
21308 if (it
->ascent
> it
->max_ascent
)
21310 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21311 it
->ascent
= it
->max_ascent
;
21313 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21314 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21315 it
->constrain_row_ascent_descent_p
= 1;
21316 extra_line_spacing
= 0;
21320 Lisp_Object spacing
;
21322 it
->phys_ascent
= it
->ascent
;
21323 it
->phys_descent
= it
->descent
;
21325 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21326 && face
->box
!= FACE_NO_BOX
21327 && face
->box_line_width
> 0)
21329 it
->ascent
+= face
->box_line_width
;
21330 it
->descent
+= face
->box_line_width
;
21333 && XINT (height
) > it
->ascent
+ it
->descent
)
21334 it
->ascent
= XINT (height
) - it
->descent
;
21336 if (!NILP (total_height
))
21337 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21340 spacing
= get_it_property(it
, Qline_spacing
);
21341 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21343 if (INTEGERP (spacing
))
21345 extra_line_spacing
= XINT (spacing
);
21346 if (!NILP (total_height
))
21347 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21351 else if (it
->char_to_display
== '\t')
21353 if (font
->space_width
> 0)
21355 int tab_width
= it
->tab_width
* font
->space_width
;
21356 int x
= it
->current_x
+ it
->continuation_lines_width
;
21357 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21359 /* If the distance from the current position to the next tab
21360 stop is less than a space character width, use the
21361 tab stop after that. */
21362 if (next_tab_x
- x
< font
->space_width
)
21363 next_tab_x
+= tab_width
;
21365 it
->pixel_width
= next_tab_x
- x
;
21367 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21368 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21372 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21373 it
->ascent
+ it
->descent
, it
->ascent
);
21378 it
->pixel_width
= 0;
21384 /* A multi-byte character. Assume that the display width of the
21385 character is the width of the character multiplied by the
21386 width of the font. */
21388 /* If we found a font, this font should give us the right
21389 metrics. If we didn't find a font, use the frame's
21390 default font and calculate the width of the character by
21391 multiplying the width of font by the width of the
21394 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21396 if (font_not_found_p
|| !pcm
)
21398 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21400 if (char_width
== 0)
21401 /* This is a non spacing character. But, as we are
21402 going to display an empty box, the box must occupy
21403 at least one column. */
21405 it
->glyph_not_available_p
= 1;
21406 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21407 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21408 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21412 it
->pixel_width
= pcm
->width
;
21413 it
->phys_ascent
= pcm
->ascent
+ boff
;
21414 it
->phys_descent
= pcm
->descent
- boff
;
21416 && (pcm
->lbearing
< 0
21417 || pcm
->rbearing
> pcm
->width
))
21418 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21421 it
->ascent
= FONT_BASE (font
) + boff
;
21422 it
->descent
= FONT_DESCENT (font
) - boff
;
21423 if (face
->box
!= FACE_NO_BOX
)
21425 int thick
= face
->box_line_width
;
21429 it
->ascent
+= thick
;
21430 it
->descent
+= thick
;
21435 if (it
->start_of_box_run_p
)
21436 it
->pixel_width
+= thick
;
21437 if (it
->end_of_box_run_p
)
21438 it
->pixel_width
+= thick
;
21441 /* If face has an overline, add the height of the overline
21442 (1 pixel) and a 1 pixel margin to the character height. */
21443 if (face
->overline_p
)
21444 it
->ascent
+= overline_margin
;
21446 take_vertical_position_into_account (it
);
21448 if (it
->ascent
< 0)
21450 if (it
->descent
< 0)
21455 if (it
->pixel_width
== 0)
21456 /* We assure that all visible glyphs have at least 1-pixel
21458 it
->pixel_width
= 1;
21460 it
->multibyte_p
= saved_multibyte_p
;
21462 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
21464 /* A static compositoin.
21466 Note: A composition is represented as one glyph in the
21467 glyph matrix. There are no padding glyphs.
21469 Important is that pixel_width, ascent, and descent are the
21470 values of what is drawn by draw_glyphs (i.e. the values of
21471 the overall glyphs composed). */
21472 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21473 int boff
; /* baseline offset */
21474 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
21475 int glyph_len
= cmp
->glyph_len
;
21476 struct font
*font
= face
->font
;
21480 /* If we have not yet calculated pixel size data of glyphs of
21481 the composition for the current face font, calculate them
21482 now. Theoretically, we have to check all fonts for the
21483 glyphs, but that requires much time and memory space. So,
21484 here we check only the font of the first glyph. This leads
21485 to incorrect display, but it's very rare, and C-l (recenter)
21486 can correct the display anyway. */
21487 if (! cmp
->font
|| cmp
->font
!= font
)
21489 /* Ascent and descent of the font of the first character
21490 of this composition (adjusted by baseline offset).
21491 Ascent and descent of overall glyphs should not be less
21492 than them respectively. */
21493 int font_ascent
, font_descent
, font_height
;
21494 /* Bounding box of the overall glyphs. */
21495 int leftmost
, rightmost
, lowest
, highest
;
21496 int lbearing
, rbearing
;
21497 int i
, width
, ascent
, descent
;
21498 int left_padded
= 0, right_padded
= 0;
21501 struct font_metrics
*pcm
;
21502 int font_not_found_p
;
21505 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21506 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21508 if (glyph_len
< cmp
->glyph_len
)
21510 for (i
= 0; i
< glyph_len
; i
++)
21512 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21514 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21519 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21520 : IT_CHARPOS (*it
));
21521 /* When no suitable font found, use the default font. */
21522 font_not_found_p
= font
== NULL
;
21523 if (font_not_found_p
)
21525 face
= face
->ascii_face
;
21528 boff
= font
->baseline_offset
;
21529 if (font
->vertical_centering
)
21530 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21531 font_ascent
= FONT_BASE (font
) + boff
;
21532 font_descent
= FONT_DESCENT (font
) - boff
;
21533 font_height
= FONT_HEIGHT (font
);
21535 cmp
->font
= (void *) font
;
21538 if (! font_not_found_p
)
21540 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21541 &char2b
, it
->multibyte_p
, 0);
21542 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21545 /* Initialize the bounding box. */
21548 width
= pcm
->width
;
21549 ascent
= pcm
->ascent
;
21550 descent
= pcm
->descent
;
21551 lbearing
= pcm
->lbearing
;
21552 rbearing
= pcm
->rbearing
;
21556 width
= FONT_WIDTH (font
);
21557 ascent
= FONT_BASE (font
);
21558 descent
= FONT_DESCENT (font
);
21565 lowest
= - descent
+ boff
;
21566 highest
= ascent
+ boff
;
21568 if (! font_not_found_p
21569 && font
->default_ascent
21570 && CHAR_TABLE_P (Vuse_default_ascent
)
21571 && !NILP (Faref (Vuse_default_ascent
,
21572 make_number (it
->char_to_display
))))
21573 highest
= font
->default_ascent
+ boff
;
21575 /* Draw the first glyph at the normal position. It may be
21576 shifted to right later if some other glyphs are drawn
21578 cmp
->offsets
[i
* 2] = 0;
21579 cmp
->offsets
[i
* 2 + 1] = boff
;
21580 cmp
->lbearing
= lbearing
;
21581 cmp
->rbearing
= rbearing
;
21583 /* Set cmp->offsets for the remaining glyphs. */
21584 for (i
++; i
< glyph_len
; i
++)
21586 int left
, right
, btm
, top
;
21587 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21589 struct face
*this_face
;
21594 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21595 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21596 font
= this_face
->font
;
21602 this_boff
= font
->baseline_offset
;
21603 if (font
->vertical_centering
)
21604 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21605 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21606 &char2b
, it
->multibyte_p
, 0);
21607 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21610 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21613 width
= pcm
->width
;
21614 ascent
= pcm
->ascent
;
21615 descent
= pcm
->descent
;
21616 lbearing
= pcm
->lbearing
;
21617 rbearing
= pcm
->rbearing
;
21618 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21620 /* Relative composition with or without
21621 alternate chars. */
21622 left
= (leftmost
+ rightmost
- width
) / 2;
21623 btm
= - descent
+ boff
;
21624 if (font
->relative_compose
21625 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21626 || NILP (Faref (Vignore_relative_composition
,
21627 make_number (ch
)))))
21630 if (- descent
>= font
->relative_compose
)
21631 /* One extra pixel between two glyphs. */
21633 else if (ascent
<= 0)
21634 /* One extra pixel between two glyphs. */
21635 btm
= lowest
- 1 - ascent
- descent
;
21640 /* A composition rule is specified by an integer
21641 value that encodes global and new reference
21642 points (GREF and NREF). GREF and NREF are
21643 specified by numbers as below:
21645 0---1---2 -- ascent
21649 9--10--11 -- center
21651 ---3---4---5--- baseline
21653 6---7---8 -- descent
21655 int rule
= COMPOSITION_RULE (cmp
, i
);
21656 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21658 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21659 grefx
= gref
% 3, nrefx
= nref
% 3;
21660 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21662 xoff
= font_height
* (xoff
- 128) / 256;
21664 yoff
= font_height
* (yoff
- 128) / 256;
21667 + grefx
* (rightmost
- leftmost
) / 2
21668 - nrefx
* width
/ 2
21671 btm
= ((grefy
== 0 ? highest
21673 : grefy
== 2 ? lowest
21674 : (highest
+ lowest
) / 2)
21675 - (nrefy
== 0 ? ascent
+ descent
21676 : nrefy
== 1 ? descent
- boff
21678 : (ascent
+ descent
) / 2)
21682 cmp
->offsets
[i
* 2] = left
;
21683 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21685 /* Update the bounding box of the overall glyphs. */
21688 right
= left
+ width
;
21689 if (left
< leftmost
)
21691 if (right
> rightmost
)
21694 top
= btm
+ descent
+ ascent
;
21700 if (cmp
->lbearing
> left
+ lbearing
)
21701 cmp
->lbearing
= left
+ lbearing
;
21702 if (cmp
->rbearing
< left
+ rbearing
)
21703 cmp
->rbearing
= left
+ rbearing
;
21707 /* If there are glyphs whose x-offsets are negative,
21708 shift all glyphs to the right and make all x-offsets
21712 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21713 cmp
->offsets
[i
* 2] -= leftmost
;
21714 rightmost
-= leftmost
;
21715 cmp
->lbearing
-= leftmost
;
21716 cmp
->rbearing
-= leftmost
;
21719 if (left_padded
&& cmp
->lbearing
< 0)
21721 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21722 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21723 rightmost
-= cmp
->lbearing
;
21724 cmp
->rbearing
-= cmp
->lbearing
;
21727 if (right_padded
&& rightmost
< cmp
->rbearing
)
21729 rightmost
= cmp
->rbearing
;
21732 cmp
->pixel_width
= rightmost
;
21733 cmp
->ascent
= highest
;
21734 cmp
->descent
= - lowest
;
21735 if (cmp
->ascent
< font_ascent
)
21736 cmp
->ascent
= font_ascent
;
21737 if (cmp
->descent
< font_descent
)
21738 cmp
->descent
= font_descent
;
21742 && (cmp
->lbearing
< 0
21743 || cmp
->rbearing
> cmp
->pixel_width
))
21744 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21746 it
->pixel_width
= cmp
->pixel_width
;
21747 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21748 it
->descent
= it
->phys_descent
= cmp
->descent
;
21749 if (face
->box
!= FACE_NO_BOX
)
21751 int thick
= face
->box_line_width
;
21755 it
->ascent
+= thick
;
21756 it
->descent
+= thick
;
21761 if (it
->start_of_box_run_p
)
21762 it
->pixel_width
+= thick
;
21763 if (it
->end_of_box_run_p
)
21764 it
->pixel_width
+= thick
;
21767 /* If face has an overline, add the height of the overline
21768 (1 pixel) and a 1 pixel margin to the character height. */
21769 if (face
->overline_p
)
21770 it
->ascent
+= overline_margin
;
21772 take_vertical_position_into_account (it
);
21773 if (it
->ascent
< 0)
21775 if (it
->descent
< 0)
21779 append_composite_glyph (it
);
21781 else if (it
->what
== IT_COMPOSITION
)
21783 /* A dynamic (automatic) composition. */
21784 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21785 Lisp_Object gstring
;
21786 struct font_metrics metrics
;
21788 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
21790 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
21793 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
21794 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21795 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
21796 it
->descent
= it
->phys_descent
= metrics
.descent
;
21797 if (face
->box
!= FACE_NO_BOX
)
21799 int thick
= face
->box_line_width
;
21803 it
->ascent
+= thick
;
21804 it
->descent
+= thick
;
21809 if (it
->start_of_box_run_p
)
21810 it
->pixel_width
+= thick
;
21811 if (it
->end_of_box_run_p
)
21812 it
->pixel_width
+= thick
;
21814 /* If face has an overline, add the height of the overline
21815 (1 pixel) and a 1 pixel margin to the character height. */
21816 if (face
->overline_p
)
21817 it
->ascent
+= overline_margin
;
21818 take_vertical_position_into_account (it
);
21819 if (it
->ascent
< 0)
21821 if (it
->descent
< 0)
21825 append_composite_glyph (it
);
21827 else if (it
->what
== IT_IMAGE
)
21828 produce_image_glyph (it
);
21829 else if (it
->what
== IT_STRETCH
)
21830 produce_stretch_glyph (it
);
21832 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21833 because this isn't true for images with `:ascent 100'. */
21834 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21835 if (it
->area
== TEXT_AREA
)
21836 it
->current_x
+= it
->pixel_width
;
21838 if (extra_line_spacing
> 0)
21840 it
->descent
+= extra_line_spacing
;
21841 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21842 it
->max_extra_line_spacing
= extra_line_spacing
;
21845 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21846 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21847 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21848 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21852 Output LEN glyphs starting at START at the nominal cursor position.
21853 Advance the nominal cursor over the text. The global variable
21854 updated_window contains the window being updated, updated_row is
21855 the glyph row being updated, and updated_area is the area of that
21856 row being updated. */
21859 x_write_glyphs (start
, len
)
21860 struct glyph
*start
;
21865 xassert (updated_window
&& updated_row
);
21868 /* Write glyphs. */
21870 hpos
= start
- updated_row
->glyphs
[updated_area
];
21871 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21872 updated_row
, updated_area
,
21874 DRAW_NORMAL_TEXT
, 0);
21876 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21877 if (updated_area
== TEXT_AREA
21878 && updated_window
->phys_cursor_on_p
21879 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21880 && updated_window
->phys_cursor
.hpos
>= hpos
21881 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21882 updated_window
->phys_cursor_on_p
= 0;
21886 /* Advance the output cursor. */
21887 output_cursor
.hpos
+= len
;
21888 output_cursor
.x
= x
;
21893 Insert LEN glyphs from START at the nominal cursor position. */
21896 x_insert_glyphs (start
, len
)
21897 struct glyph
*start
;
21902 int line_height
, shift_by_width
, shifted_region_width
;
21903 struct glyph_row
*row
;
21904 struct glyph
*glyph
;
21905 int frame_x
, frame_y
;
21908 xassert (updated_window
&& updated_row
);
21910 w
= updated_window
;
21911 f
= XFRAME (WINDOW_FRAME (w
));
21913 /* Get the height of the line we are in. */
21915 line_height
= row
->height
;
21917 /* Get the width of the glyphs to insert. */
21918 shift_by_width
= 0;
21919 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21920 shift_by_width
+= glyph
->pixel_width
;
21922 /* Get the width of the region to shift right. */
21923 shifted_region_width
= (window_box_width (w
, updated_area
)
21928 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21929 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21931 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21932 line_height
, shift_by_width
);
21934 /* Write the glyphs. */
21935 hpos
= start
- row
->glyphs
[updated_area
];
21936 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21938 DRAW_NORMAL_TEXT
, 0);
21940 /* Advance the output cursor. */
21941 output_cursor
.hpos
+= len
;
21942 output_cursor
.x
+= shift_by_width
;
21948 Erase the current text line from the nominal cursor position
21949 (inclusive) to pixel column TO_X (exclusive). The idea is that
21950 everything from TO_X onward is already erased.
21952 TO_X is a pixel position relative to updated_area of
21953 updated_window. TO_X == -1 means clear to the end of this area. */
21956 x_clear_end_of_line (to_x
)
21960 struct window
*w
= updated_window
;
21961 int max_x
, min_y
, max_y
;
21962 int from_x
, from_y
, to_y
;
21964 xassert (updated_window
&& updated_row
);
21965 f
= XFRAME (w
->frame
);
21967 if (updated_row
->full_width_p
)
21968 max_x
= WINDOW_TOTAL_WIDTH (w
);
21970 max_x
= window_box_width (w
, updated_area
);
21971 max_y
= window_text_bottom_y (w
);
21973 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21974 of window. For TO_X > 0, truncate to end of drawing area. */
21980 to_x
= min (to_x
, max_x
);
21982 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
21984 /* Notice if the cursor will be cleared by this operation. */
21985 if (!updated_row
->full_width_p
)
21986 notice_overwritten_cursor (w
, updated_area
,
21987 output_cursor
.x
, -1,
21989 MATRIX_ROW_BOTTOM_Y (updated_row
));
21991 from_x
= output_cursor
.x
;
21993 /* Translate to frame coordinates. */
21994 if (updated_row
->full_width_p
)
21996 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
21997 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22001 int area_left
= window_box_left (w
, updated_area
);
22002 from_x
+= area_left
;
22006 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22007 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22008 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22010 /* Prevent inadvertently clearing to end of the X window. */
22011 if (to_x
> from_x
&& to_y
> from_y
)
22014 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22015 to_x
- from_x
, to_y
- from_y
);
22020 #endif /* HAVE_WINDOW_SYSTEM */
22024 /***********************************************************************
22026 ***********************************************************************/
22028 /* Value is the internal representation of the specified cursor type
22029 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22030 of the bar cursor. */
22032 static enum text_cursor_kinds
22033 get_specified_cursor_type (arg
, width
)
22037 enum text_cursor_kinds type
;
22042 if (EQ (arg
, Qbox
))
22043 return FILLED_BOX_CURSOR
;
22045 if (EQ (arg
, Qhollow
))
22046 return HOLLOW_BOX_CURSOR
;
22048 if (EQ (arg
, Qbar
))
22055 && EQ (XCAR (arg
), Qbar
)
22056 && INTEGERP (XCDR (arg
))
22057 && XINT (XCDR (arg
)) >= 0)
22059 *width
= XINT (XCDR (arg
));
22063 if (EQ (arg
, Qhbar
))
22066 return HBAR_CURSOR
;
22070 && EQ (XCAR (arg
), Qhbar
)
22071 && INTEGERP (XCDR (arg
))
22072 && XINT (XCDR (arg
)) >= 0)
22074 *width
= XINT (XCDR (arg
));
22075 return HBAR_CURSOR
;
22078 /* Treat anything unknown as "hollow box cursor".
22079 It was bad to signal an error; people have trouble fixing
22080 .Xdefaults with Emacs, when it has something bad in it. */
22081 type
= HOLLOW_BOX_CURSOR
;
22086 /* Set the default cursor types for specified frame. */
22088 set_frame_cursor_types (f
, arg
)
22095 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22096 FRAME_CURSOR_WIDTH (f
) = width
;
22098 /* By default, set up the blink-off state depending on the on-state. */
22100 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22103 FRAME_BLINK_OFF_CURSOR (f
)
22104 = get_specified_cursor_type (XCDR (tem
), &width
);
22105 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22108 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22112 /* Return the cursor we want to be displayed in window W. Return
22113 width of bar/hbar cursor through WIDTH arg. Return with
22114 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22115 (i.e. if the `system caret' should track this cursor).
22117 In a mini-buffer window, we want the cursor only to appear if we
22118 are reading input from this window. For the selected window, we
22119 want the cursor type given by the frame parameter or buffer local
22120 setting of cursor-type. If explicitly marked off, draw no cursor.
22121 In all other cases, we want a hollow box cursor. */
22123 static enum text_cursor_kinds
22124 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22126 struct glyph
*glyph
;
22128 int *active_cursor
;
22130 struct frame
*f
= XFRAME (w
->frame
);
22131 struct buffer
*b
= XBUFFER (w
->buffer
);
22132 int cursor_type
= DEFAULT_CURSOR
;
22133 Lisp_Object alt_cursor
;
22134 int non_selected
= 0;
22136 *active_cursor
= 1;
22139 if (cursor_in_echo_area
22140 && FRAME_HAS_MINIBUF_P (f
)
22141 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22143 if (w
== XWINDOW (echo_area_window
))
22145 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22147 *width
= FRAME_CURSOR_WIDTH (f
);
22148 return FRAME_DESIRED_CURSOR (f
);
22151 return get_specified_cursor_type (b
->cursor_type
, width
);
22154 *active_cursor
= 0;
22158 /* Detect a nonselected window or nonselected frame. */
22159 else if (w
!= XWINDOW (f
->selected_window
)
22160 #ifdef HAVE_WINDOW_SYSTEM
22161 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22165 *active_cursor
= 0;
22167 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22173 /* Never display a cursor in a window in which cursor-type is nil. */
22174 if (NILP (b
->cursor_type
))
22177 /* Get the normal cursor type for this window. */
22178 if (EQ (b
->cursor_type
, Qt
))
22180 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22181 *width
= FRAME_CURSOR_WIDTH (f
);
22184 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22186 /* Use cursor-in-non-selected-windows instead
22187 for non-selected window or frame. */
22190 alt_cursor
= b
->cursor_in_non_selected_windows
;
22191 if (!EQ (Qt
, alt_cursor
))
22192 return get_specified_cursor_type (alt_cursor
, width
);
22193 /* t means modify the normal cursor type. */
22194 if (cursor_type
== FILLED_BOX_CURSOR
)
22195 cursor_type
= HOLLOW_BOX_CURSOR
;
22196 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22198 return cursor_type
;
22201 /* Use normal cursor if not blinked off. */
22202 if (!w
->cursor_off_p
)
22204 #ifdef HAVE_WINDOW_SYSTEM
22205 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22207 if (cursor_type
== FILLED_BOX_CURSOR
)
22209 /* Using a block cursor on large images can be very annoying.
22210 So use a hollow cursor for "large" images.
22211 If image is not transparent (no mask), also use hollow cursor. */
22212 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22213 if (img
!= NULL
&& IMAGEP (img
->spec
))
22215 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22216 where N = size of default frame font size.
22217 This should cover most of the "tiny" icons people may use. */
22219 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22220 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22221 cursor_type
= HOLLOW_BOX_CURSOR
;
22224 else if (cursor_type
!= NO_CURSOR
)
22226 /* Display current only supports BOX and HOLLOW cursors for images.
22227 So for now, unconditionally use a HOLLOW cursor when cursor is
22228 not a solid box cursor. */
22229 cursor_type
= HOLLOW_BOX_CURSOR
;
22233 return cursor_type
;
22236 /* Cursor is blinked off, so determine how to "toggle" it. */
22238 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22239 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22240 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22242 /* Then see if frame has specified a specific blink off cursor type. */
22243 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22245 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22246 return FRAME_BLINK_OFF_CURSOR (f
);
22250 /* Some people liked having a permanently visible blinking cursor,
22251 while others had very strong opinions against it. So it was
22252 decided to remove it. KFS 2003-09-03 */
22254 /* Finally perform built-in cursor blinking:
22255 filled box <-> hollow box
22256 wide [h]bar <-> narrow [h]bar
22257 narrow [h]bar <-> no cursor
22258 other type <-> no cursor */
22260 if (cursor_type
== FILLED_BOX_CURSOR
)
22261 return HOLLOW_BOX_CURSOR
;
22263 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22266 return cursor_type
;
22274 #ifdef HAVE_WINDOW_SYSTEM
22276 /* Notice when the text cursor of window W has been completely
22277 overwritten by a drawing operation that outputs glyphs in AREA
22278 starting at X0 and ending at X1 in the line starting at Y0 and
22279 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22280 the rest of the line after X0 has been written. Y coordinates
22281 are window-relative. */
22284 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22286 enum glyph_row_area area
;
22287 int x0
, y0
, x1
, y1
;
22289 int cx0
, cx1
, cy0
, cy1
;
22290 struct glyph_row
*row
;
22292 if (!w
->phys_cursor_on_p
)
22294 if (area
!= TEXT_AREA
)
22297 if (w
->phys_cursor
.vpos
< 0
22298 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22299 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22300 !(row
->enabled_p
&& row
->displays_text_p
)))
22303 if (row
->cursor_in_fringe_p
)
22305 row
->cursor_in_fringe_p
= 0;
22306 draw_fringe_bitmap (w
, row
, 0);
22307 w
->phys_cursor_on_p
= 0;
22311 cx0
= w
->phys_cursor
.x
;
22312 cx1
= cx0
+ w
->phys_cursor_width
;
22313 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22316 /* The cursor image will be completely removed from the
22317 screen if the output area intersects the cursor area in
22318 y-direction. When we draw in [y0 y1[, and some part of
22319 the cursor is at y < y0, that part must have been drawn
22320 before. When scrolling, the cursor is erased before
22321 actually scrolling, so we don't come here. When not
22322 scrolling, the rows above the old cursor row must have
22323 changed, and in this case these rows must have written
22324 over the cursor image.
22326 Likewise if part of the cursor is below y1, with the
22327 exception of the cursor being in the first blank row at
22328 the buffer and window end because update_text_area
22329 doesn't draw that row. (Except when it does, but
22330 that's handled in update_text_area.) */
22332 cy0
= w
->phys_cursor
.y
;
22333 cy1
= cy0
+ w
->phys_cursor_height
;
22334 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22337 w
->phys_cursor_on_p
= 0;
22340 #endif /* HAVE_WINDOW_SYSTEM */
22343 /************************************************************************
22345 ************************************************************************/
22347 #ifdef HAVE_WINDOW_SYSTEM
22350 Fix the display of area AREA of overlapping row ROW in window W
22351 with respect to the overlapping part OVERLAPS. */
22354 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22356 struct glyph_row
*row
;
22357 enum glyph_row_area area
;
22365 for (i
= 0; i
< row
->used
[area
];)
22367 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22369 int start
= i
, start_x
= x
;
22373 x
+= row
->glyphs
[area
][i
].pixel_width
;
22376 while (i
< row
->used
[area
]
22377 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22379 draw_glyphs (w
, start_x
, row
, area
,
22381 DRAW_NORMAL_TEXT
, overlaps
);
22385 x
+= row
->glyphs
[area
][i
].pixel_width
;
22395 Draw the cursor glyph of window W in glyph row ROW. See the
22396 comment of draw_glyphs for the meaning of HL. */
22399 draw_phys_cursor_glyph (w
, row
, hl
)
22401 struct glyph_row
*row
;
22402 enum draw_glyphs_face hl
;
22404 /* If cursor hpos is out of bounds, don't draw garbage. This can
22405 happen in mini-buffer windows when switching between echo area
22406 glyphs and mini-buffer. */
22407 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22409 int on_p
= w
->phys_cursor_on_p
;
22411 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22412 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22414 w
->phys_cursor_on_p
= on_p
;
22416 if (hl
== DRAW_CURSOR
)
22417 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22418 /* When we erase the cursor, and ROW is overlapped by other
22419 rows, make sure that these overlapping parts of other rows
22421 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22423 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22425 if (row
> w
->current_matrix
->rows
22426 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22427 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22428 OVERLAPS_ERASED_CURSOR
);
22430 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22431 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22432 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22433 OVERLAPS_ERASED_CURSOR
);
22440 Erase the image of a cursor of window W from the screen. */
22443 erase_phys_cursor (w
)
22446 struct frame
*f
= XFRAME (w
->frame
);
22447 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22448 int hpos
= w
->phys_cursor
.hpos
;
22449 int vpos
= w
->phys_cursor
.vpos
;
22450 int mouse_face_here_p
= 0;
22451 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22452 struct glyph_row
*cursor_row
;
22453 struct glyph
*cursor_glyph
;
22454 enum draw_glyphs_face hl
;
22456 /* No cursor displayed or row invalidated => nothing to do on the
22458 if (w
->phys_cursor_type
== NO_CURSOR
)
22459 goto mark_cursor_off
;
22461 /* VPOS >= active_glyphs->nrows means that window has been resized.
22462 Don't bother to erase the cursor. */
22463 if (vpos
>= active_glyphs
->nrows
)
22464 goto mark_cursor_off
;
22466 /* If row containing cursor is marked invalid, there is nothing we
22468 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22469 if (!cursor_row
->enabled_p
)
22470 goto mark_cursor_off
;
22472 /* If line spacing is > 0, old cursor may only be partially visible in
22473 window after split-window. So adjust visible height. */
22474 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22475 window_text_bottom_y (w
) - cursor_row
->y
);
22477 /* If row is completely invisible, don't attempt to delete a cursor which
22478 isn't there. This can happen if cursor is at top of a window, and
22479 we switch to a buffer with a header line in that window. */
22480 if (cursor_row
->visible_height
<= 0)
22481 goto mark_cursor_off
;
22483 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22484 if (cursor_row
->cursor_in_fringe_p
)
22486 cursor_row
->cursor_in_fringe_p
= 0;
22487 draw_fringe_bitmap (w
, cursor_row
, 0);
22488 goto mark_cursor_off
;
22491 /* This can happen when the new row is shorter than the old one.
22492 In this case, either draw_glyphs or clear_end_of_line
22493 should have cleared the cursor. Note that we wouldn't be
22494 able to erase the cursor in this case because we don't have a
22495 cursor glyph at hand. */
22496 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22497 goto mark_cursor_off
;
22499 /* If the cursor is in the mouse face area, redisplay that when
22500 we clear the cursor. */
22501 if (! NILP (dpyinfo
->mouse_face_window
)
22502 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22503 && (vpos
> dpyinfo
->mouse_face_beg_row
22504 || (vpos
== dpyinfo
->mouse_face_beg_row
22505 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22506 && (vpos
< dpyinfo
->mouse_face_end_row
22507 || (vpos
== dpyinfo
->mouse_face_end_row
22508 && hpos
< dpyinfo
->mouse_face_end_col
))
22509 /* Don't redraw the cursor's spot in mouse face if it is at the
22510 end of a line (on a newline). The cursor appears there, but
22511 mouse highlighting does not. */
22512 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22513 mouse_face_here_p
= 1;
22515 /* Maybe clear the display under the cursor. */
22516 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22519 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22522 cursor_glyph
= get_phys_cursor_glyph (w
);
22523 if (cursor_glyph
== NULL
)
22524 goto mark_cursor_off
;
22526 width
= cursor_glyph
->pixel_width
;
22527 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22528 x
= w
->phys_cursor
.x
;
22530 width
-= left_x
- x
;
22531 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22532 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22533 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22536 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22539 /* Erase the cursor by redrawing the character underneath it. */
22540 if (mouse_face_here_p
)
22541 hl
= DRAW_MOUSE_FACE
;
22543 hl
= DRAW_NORMAL_TEXT
;
22544 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22547 w
->phys_cursor_on_p
= 0;
22548 w
->phys_cursor_type
= NO_CURSOR
;
22553 Display or clear cursor of window W. If ON is zero, clear the
22554 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22555 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22558 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22560 int on
, hpos
, vpos
, x
, y
;
22562 struct frame
*f
= XFRAME (w
->frame
);
22563 int new_cursor_type
;
22564 int new_cursor_width
;
22566 struct glyph_row
*glyph_row
;
22567 struct glyph
*glyph
;
22569 /* This is pointless on invisible frames, and dangerous on garbaged
22570 windows and frames; in the latter case, the frame or window may
22571 be in the midst of changing its size, and x and y may be off the
22573 if (! FRAME_VISIBLE_P (f
)
22574 || FRAME_GARBAGED_P (f
)
22575 || vpos
>= w
->current_matrix
->nrows
22576 || hpos
>= w
->current_matrix
->matrix_w
)
22579 /* If cursor is off and we want it off, return quickly. */
22580 if (!on
&& !w
->phys_cursor_on_p
)
22583 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22584 /* If cursor row is not enabled, we don't really know where to
22585 display the cursor. */
22586 if (!glyph_row
->enabled_p
)
22588 w
->phys_cursor_on_p
= 0;
22593 if (!glyph_row
->exact_window_width_line_p
22594 || hpos
< glyph_row
->used
[TEXT_AREA
])
22595 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22597 xassert (interrupt_input_blocked
);
22599 /* Set new_cursor_type to the cursor we want to be displayed. */
22600 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22601 &new_cursor_width
, &active_cursor
);
22603 /* If cursor is currently being shown and we don't want it to be or
22604 it is in the wrong place, or the cursor type is not what we want,
22606 if (w
->phys_cursor_on_p
22608 || w
->phys_cursor
.x
!= x
22609 || w
->phys_cursor
.y
!= y
22610 || new_cursor_type
!= w
->phys_cursor_type
22611 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22612 && new_cursor_width
!= w
->phys_cursor_width
)))
22613 erase_phys_cursor (w
);
22615 /* Don't check phys_cursor_on_p here because that flag is only set
22616 to zero in some cases where we know that the cursor has been
22617 completely erased, to avoid the extra work of erasing the cursor
22618 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22619 still not be visible, or it has only been partly erased. */
22622 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22623 w
->phys_cursor_height
= glyph_row
->height
;
22625 /* Set phys_cursor_.* before x_draw_.* is called because some
22626 of them may need the information. */
22627 w
->phys_cursor
.x
= x
;
22628 w
->phys_cursor
.y
= glyph_row
->y
;
22629 w
->phys_cursor
.hpos
= hpos
;
22630 w
->phys_cursor
.vpos
= vpos
;
22633 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22634 new_cursor_type
, new_cursor_width
,
22635 on
, active_cursor
);
22639 /* Switch the display of W's cursor on or off, according to the value
22646 update_window_cursor (w
, on
)
22650 /* Don't update cursor in windows whose frame is in the process
22651 of being deleted. */
22652 if (w
->current_matrix
)
22655 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22656 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22662 /* Call update_window_cursor with parameter ON_P on all leaf windows
22663 in the window tree rooted at W. */
22666 update_cursor_in_window_tree (w
, on_p
)
22672 if (!NILP (w
->hchild
))
22673 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22674 else if (!NILP (w
->vchild
))
22675 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22677 update_window_cursor (w
, on_p
);
22679 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22685 Display the cursor on window W, or clear it, according to ON_P.
22686 Don't change the cursor's position. */
22689 x_update_cursor (f
, on_p
)
22693 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22698 Clear the cursor of window W to background color, and mark the
22699 cursor as not shown. This is used when the text where the cursor
22700 is is about to be rewritten. */
22706 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22707 update_window_cursor (w
, 0);
22712 Display the active region described by mouse_face_* according to DRAW. */
22715 show_mouse_face (dpyinfo
, draw
)
22716 Display_Info
*dpyinfo
;
22717 enum draw_glyphs_face draw
;
22719 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22720 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22722 if (/* If window is in the process of being destroyed, don't bother
22724 w
->current_matrix
!= NULL
22725 /* Don't update mouse highlight if hidden */
22726 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22727 /* Recognize when we are called to operate on rows that don't exist
22728 anymore. This can happen when a window is split. */
22729 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22731 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22732 struct glyph_row
*row
, *first
, *last
;
22734 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22735 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22737 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22739 int start_hpos
, end_hpos
, start_x
;
22741 /* For all but the first row, the highlight starts at column 0. */
22744 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22745 start_x
= dpyinfo
->mouse_face_beg_x
;
22754 end_hpos
= dpyinfo
->mouse_face_end_col
;
22757 end_hpos
= row
->used
[TEXT_AREA
];
22758 if (draw
== DRAW_NORMAL_TEXT
)
22759 row
->fill_line_p
= 1; /* Clear to end of line */
22762 if (end_hpos
> start_hpos
)
22764 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22765 start_hpos
, end_hpos
,
22769 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22773 /* When we've written over the cursor, arrange for it to
22774 be displayed again. */
22775 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22778 display_and_set_cursor (w
, 1,
22779 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22780 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22785 /* Change the mouse cursor. */
22786 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22787 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22788 else if (draw
== DRAW_MOUSE_FACE
)
22789 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22791 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22795 Clear out the mouse-highlighted active region.
22796 Redraw it un-highlighted first. Value is non-zero if mouse
22797 face was actually drawn unhighlighted. */
22800 clear_mouse_face (dpyinfo
)
22801 Display_Info
*dpyinfo
;
22805 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22807 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22811 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22812 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22813 dpyinfo
->mouse_face_window
= Qnil
;
22814 dpyinfo
->mouse_face_overlay
= Qnil
;
22820 Non-zero if physical cursor of window W is within mouse face. */
22823 cursor_in_mouse_face_p (w
)
22826 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22827 int in_mouse_face
= 0;
22829 if (WINDOWP (dpyinfo
->mouse_face_window
)
22830 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22832 int hpos
= w
->phys_cursor
.hpos
;
22833 int vpos
= w
->phys_cursor
.vpos
;
22835 if (vpos
>= dpyinfo
->mouse_face_beg_row
22836 && vpos
<= dpyinfo
->mouse_face_end_row
22837 && (vpos
> dpyinfo
->mouse_face_beg_row
22838 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22839 && (vpos
< dpyinfo
->mouse_face_end_row
22840 || hpos
< dpyinfo
->mouse_face_end_col
22841 || dpyinfo
->mouse_face_past_end
))
22845 return in_mouse_face
;
22851 /* Find the glyph matrix position of buffer position CHARPOS in window
22852 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22853 current glyphs must be up to date. If CHARPOS is above window
22854 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22855 of last line in W. In the row containing CHARPOS, stop before glyphs
22856 having STOP as object. */
22858 #if 1 /* This is a version of fast_find_position that's more correct
22859 in the presence of hscrolling, for example. I didn't install
22860 it right away because the problem fixed is minor, it failed
22861 in 20.x as well, and I think it's too risky to install
22862 so near the release of 21.1. 2001-09-25 gerd. */
22866 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22869 int *hpos
, *vpos
, *x
, *y
;
22872 struct glyph_row
*row
, *first
;
22873 struct glyph
*glyph
, *end
;
22876 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22877 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22882 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22886 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22889 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22893 /* If whole rows or last part of a row came from a display overlay,
22894 row_containing_pos will skip over such rows because their end pos
22895 equals the start pos of the overlay or interval.
22897 Move back if we have a STOP object and previous row's
22898 end glyph came from STOP. */
22901 struct glyph_row
*prev
;
22902 while ((prev
= row
- 1, prev
>= first
)
22903 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22904 && prev
->used
[TEXT_AREA
] > 0)
22906 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22907 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22908 while (--glyph
>= beg
22909 && INTEGERP (glyph
->object
));
22911 || !EQ (stop
, glyph
->object
))
22919 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22921 glyph
= row
->glyphs
[TEXT_AREA
];
22922 end
= glyph
+ row
->used
[TEXT_AREA
];
22924 /* Skip over glyphs not having an object at the start of the row.
22925 These are special glyphs like truncation marks on terminal
22927 if (row
->displays_text_p
)
22929 && INTEGERP (glyph
->object
)
22930 && !EQ (stop
, glyph
->object
)
22931 && glyph
->charpos
< 0)
22933 *x
+= glyph
->pixel_width
;
22938 && !INTEGERP (glyph
->object
)
22939 && !EQ (stop
, glyph
->object
)
22940 && (!BUFFERP (glyph
->object
)
22941 || glyph
->charpos
< charpos
))
22943 *x
+= glyph
->pixel_width
;
22947 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22954 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22957 int *hpos
, *vpos
, *x
, *y
;
22962 int maybe_next_line_p
= 0;
22963 int line_start_position
;
22964 int yb
= window_text_bottom_y (w
);
22965 struct glyph_row
*row
, *best_row
;
22966 int row_vpos
, best_row_vpos
;
22969 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22970 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22972 while (row
->y
< yb
)
22974 if (row
->used
[TEXT_AREA
])
22975 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
22977 line_start_position
= 0;
22979 if (line_start_position
> pos
)
22981 /* If the position sought is the end of the buffer,
22982 don't include the blank lines at the bottom of the window. */
22983 else if (line_start_position
== pos
22984 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
22986 maybe_next_line_p
= 1;
22989 else if (line_start_position
> 0)
22992 best_row_vpos
= row_vpos
;
22995 if (row
->y
+ row
->height
>= yb
)
23002 /* Find the right column within BEST_ROW. */
23004 current_x
= best_row
->x
;
23005 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
23007 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
23008 int charpos
= glyph
->charpos
;
23010 if (BUFFERP (glyph
->object
))
23012 if (charpos
== pos
)
23015 *vpos
= best_row_vpos
;
23020 else if (charpos
> pos
)
23023 else if (EQ (glyph
->object
, stop
))
23028 current_x
+= glyph
->pixel_width
;
23031 /* If we're looking for the end of the buffer,
23032 and we didn't find it in the line we scanned,
23033 use the start of the following line. */
23034 if (maybe_next_line_p
)
23039 current_x
= best_row
->x
;
23042 *vpos
= best_row_vpos
;
23043 *hpos
= lastcol
+ 1;
23052 /* Find the position of the glyph for position POS in OBJECT in
23053 window W's current matrix, and return in *X, *Y the pixel
23054 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23056 RIGHT_P non-zero means return the position of the right edge of the
23057 glyph, RIGHT_P zero means return the left edge position.
23059 If no glyph for POS exists in the matrix, return the position of
23060 the glyph with the next smaller position that is in the matrix, if
23061 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23062 exists in the matrix, return the position of the glyph with the
23063 next larger position in OBJECT.
23065 Value is non-zero if a glyph was found. */
23068 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23071 Lisp_Object object
;
23072 int *hpos
, *vpos
, *x
, *y
;
23075 int yb
= window_text_bottom_y (w
);
23076 struct glyph_row
*r
;
23077 struct glyph
*best_glyph
= NULL
;
23078 struct glyph_row
*best_row
= NULL
;
23081 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23082 r
->enabled_p
&& r
->y
< yb
;
23085 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23086 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23089 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23090 if (EQ (g
->object
, object
))
23092 if (g
->charpos
== pos
)
23099 else if (best_glyph
== NULL
23100 || ((eabs (g
->charpos
- pos
)
23101 < eabs (best_glyph
->charpos
- pos
))
23104 : g
->charpos
> pos
)))
23118 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23122 *x
+= best_glyph
->pixel_width
;
23127 *vpos
= best_row
- w
->current_matrix
->rows
;
23130 return best_glyph
!= NULL
;
23134 /* See if position X, Y is within a hot-spot of an image. */
23137 on_hot_spot_p (hot_spot
, x
, y
)
23138 Lisp_Object hot_spot
;
23141 if (!CONSP (hot_spot
))
23144 if (EQ (XCAR (hot_spot
), Qrect
))
23146 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23147 Lisp_Object rect
= XCDR (hot_spot
);
23151 if (!CONSP (XCAR (rect
)))
23153 if (!CONSP (XCDR (rect
)))
23155 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23157 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23159 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23161 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23165 else if (EQ (XCAR (hot_spot
), Qcircle
))
23167 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23168 Lisp_Object circ
= XCDR (hot_spot
);
23169 Lisp_Object lr
, lx0
, ly0
;
23171 && CONSP (XCAR (circ
))
23172 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23173 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23174 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23176 double r
= XFLOATINT (lr
);
23177 double dx
= XINT (lx0
) - x
;
23178 double dy
= XINT (ly0
) - y
;
23179 return (dx
* dx
+ dy
* dy
<= r
* r
);
23182 else if (EQ (XCAR (hot_spot
), Qpoly
))
23184 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23185 if (VECTORP (XCDR (hot_spot
)))
23187 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23188 Lisp_Object
*poly
= v
->contents
;
23192 Lisp_Object lx
, ly
;
23195 /* Need an even number of coordinates, and at least 3 edges. */
23196 if (n
< 6 || n
& 1)
23199 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23200 If count is odd, we are inside polygon. Pixels on edges
23201 may or may not be included depending on actual geometry of the
23203 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23204 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23206 x0
= XINT (lx
), y0
= XINT (ly
);
23207 for (i
= 0; i
< n
; i
+= 2)
23209 int x1
= x0
, y1
= y0
;
23210 if ((lx
= poly
[i
], !INTEGERP (lx
))
23211 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23213 x0
= XINT (lx
), y0
= XINT (ly
);
23215 /* Does this segment cross the X line? */
23223 if (y
> y0
&& y
> y1
)
23225 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23235 find_hot_spot (map
, x
, y
)
23239 while (CONSP (map
))
23241 if (CONSP (XCAR (map
))
23242 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23250 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23252 doc
: /* Lookup in image map MAP coordinates X and Y.
23253 An image map is an alist where each element has the format (AREA ID PLIST).
23254 An AREA is specified as either a rectangle, a circle, or a polygon:
23255 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23256 pixel coordinates of the upper left and bottom right corners.
23257 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23258 and the radius of the circle; r may be a float or integer.
23259 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23260 vector describes one corner in the polygon.
23261 Returns the alist element for the first matching AREA in MAP. */)
23272 return find_hot_spot (map
, XINT (x
), XINT (y
));
23276 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23278 define_frame_cursor1 (f
, cursor
, pointer
)
23281 Lisp_Object pointer
;
23283 /* Do not change cursor shape while dragging mouse. */
23284 if (!NILP (do_mouse_tracking
))
23287 if (!NILP (pointer
))
23289 if (EQ (pointer
, Qarrow
))
23290 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23291 else if (EQ (pointer
, Qhand
))
23292 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23293 else if (EQ (pointer
, Qtext
))
23294 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23295 else if (EQ (pointer
, intern ("hdrag")))
23296 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23297 #ifdef HAVE_X_WINDOWS
23298 else if (EQ (pointer
, intern ("vdrag")))
23299 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23301 else if (EQ (pointer
, intern ("hourglass")))
23302 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23303 else if (EQ (pointer
, Qmodeline
))
23304 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23306 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23309 if (cursor
!= No_Cursor
)
23310 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23313 /* Take proper action when mouse has moved to the mode or header line
23314 or marginal area AREA of window W, x-position X and y-position Y.
23315 X is relative to the start of the text display area of W, so the
23316 width of bitmap areas and scroll bars must be subtracted to get a
23317 position relative to the start of the mode line. */
23320 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23321 Lisp_Object window
;
23323 enum window_part area
;
23325 struct window
*w
= XWINDOW (window
);
23326 struct frame
*f
= XFRAME (w
->frame
);
23327 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23328 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23329 Lisp_Object pointer
= Qnil
;
23330 int charpos
, dx
, dy
, width
, height
;
23331 Lisp_Object string
, object
= Qnil
;
23332 Lisp_Object pos
, help
;
23334 Lisp_Object mouse_face
;
23335 int original_x_pixel
= x
;
23336 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23337 struct glyph_row
*row
;
23339 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23344 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23345 &object
, &dx
, &dy
, &width
, &height
);
23347 row
= (area
== ON_MODE_LINE
23348 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23349 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23352 if (row
->mode_line_p
&& row
->enabled_p
)
23354 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23355 end
= glyph
+ row
->used
[TEXT_AREA
];
23357 for (x0
= original_x_pixel
;
23358 glyph
< end
&& x0
>= glyph
->pixel_width
;
23360 x0
-= glyph
->pixel_width
;
23368 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23369 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23370 &object
, &dx
, &dy
, &width
, &height
);
23375 if (IMAGEP (object
))
23377 Lisp_Object image_map
, hotspot
;
23378 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23380 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23382 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23384 Lisp_Object area_id
, plist
;
23386 area_id
= XCAR (hotspot
);
23387 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23388 If so, we could look for mouse-enter, mouse-leave
23389 properties in PLIST (and do something...). */
23390 hotspot
= XCDR (hotspot
);
23391 if (CONSP (hotspot
)
23392 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23394 pointer
= Fplist_get (plist
, Qpointer
);
23395 if (NILP (pointer
))
23397 help
= Fplist_get (plist
, Qhelp_echo
);
23400 help_echo_string
= help
;
23401 /* Is this correct? ++kfs */
23402 XSETWINDOW (help_echo_window
, w
);
23403 help_echo_object
= w
->buffer
;
23404 help_echo_pos
= charpos
;
23408 if (NILP (pointer
))
23409 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23412 if (STRINGP (string
))
23414 pos
= make_number (charpos
);
23415 /* If we're on a string with `help-echo' text property, arrange
23416 for the help to be displayed. This is done by setting the
23417 global variable help_echo_string to the help string. */
23420 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23423 help_echo_string
= help
;
23424 XSETWINDOW (help_echo_window
, w
);
23425 help_echo_object
= string
;
23426 help_echo_pos
= charpos
;
23430 if (NILP (pointer
))
23431 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23433 /* Change the mouse pointer according to what is under X/Y. */
23434 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23437 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23438 if (!KEYMAPP (map
))
23439 map
= Fget_text_property (pos
, Qkeymap
, string
);
23440 if (!KEYMAPP (map
))
23441 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23444 /* Change the mouse face according to what is under X/Y. */
23445 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23446 if (!NILP (mouse_face
)
23447 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23452 struct glyph
* tmp_glyph
;
23456 int total_pixel_width
;
23461 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23462 Qmouse_face
, string
, Qnil
);
23464 b
= make_number (0);
23466 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23468 e
= make_number (SCHARS (string
));
23470 /* Calculate the position(glyph position: GPOS) of GLYPH in
23471 displayed string. GPOS is different from CHARPOS.
23473 CHARPOS is the position of glyph in internal string
23474 object. A mode line string format has structures which
23475 is converted to a flatten by emacs lisp interpreter.
23476 The internal string is an element of the structures.
23477 The displayed string is the flatten string. */
23479 if (glyph
> row_start_glyph
)
23481 tmp_glyph
= glyph
- 1;
23482 while (tmp_glyph
>= row_start_glyph
23483 && tmp_glyph
->charpos
>= XINT (b
)
23484 && EQ (tmp_glyph
->object
, glyph
->object
))
23491 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23492 displayed string holding GLYPH.
23494 GSEQ_LENGTH is different from SCHARS (STRING).
23495 SCHARS (STRING) returns the length of the internal string. */
23496 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23497 tmp_glyph
->charpos
< XINT (e
);
23498 tmp_glyph
++, gseq_length
++)
23500 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23504 total_pixel_width
= 0;
23505 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23506 total_pixel_width
+= tmp_glyph
->pixel_width
;
23508 /* Pre calculation of re-rendering position */
23510 hpos
= (area
== ON_MODE_LINE
23511 ? (w
->current_matrix
)->nrows
- 1
23514 /* If the re-rendering position is included in the last
23515 re-rendering area, we should do nothing. */
23516 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23517 && dpyinfo
->mouse_face_beg_col
<= vpos
23518 && vpos
< dpyinfo
->mouse_face_end_col
23519 && dpyinfo
->mouse_face_beg_row
== hpos
)
23522 if (clear_mouse_face (dpyinfo
))
23523 cursor
= No_Cursor
;
23525 dpyinfo
->mouse_face_beg_col
= vpos
;
23526 dpyinfo
->mouse_face_beg_row
= hpos
;
23528 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23529 dpyinfo
->mouse_face_beg_y
= 0;
23531 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23532 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23534 dpyinfo
->mouse_face_end_x
= 0;
23535 dpyinfo
->mouse_face_end_y
= 0;
23537 dpyinfo
->mouse_face_past_end
= 0;
23538 dpyinfo
->mouse_face_window
= window
;
23540 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23543 glyph
->face_id
, 1);
23544 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23546 if (NILP (pointer
))
23549 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23550 clear_mouse_face (dpyinfo
);
23552 define_frame_cursor1 (f
, cursor
, pointer
);
23557 Take proper action when the mouse has moved to position X, Y on
23558 frame F as regards highlighting characters that have mouse-face
23559 properties. Also de-highlighting chars where the mouse was before.
23560 X and Y can be negative or out of range. */
23563 note_mouse_highlight (f
, x
, y
)
23567 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23568 enum window_part part
;
23569 Lisp_Object window
;
23571 Cursor cursor
= No_Cursor
;
23572 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23575 /* When a menu is active, don't highlight because this looks odd. */
23576 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
23577 if (popup_activated ())
23581 if (NILP (Vmouse_highlight
)
23582 || !f
->glyphs_initialized_p
)
23585 dpyinfo
->mouse_face_mouse_x
= x
;
23586 dpyinfo
->mouse_face_mouse_y
= y
;
23587 dpyinfo
->mouse_face_mouse_frame
= f
;
23589 if (dpyinfo
->mouse_face_defer
)
23592 if (gc_in_progress
)
23594 dpyinfo
->mouse_face_deferred_gc
= 1;
23598 /* Which window is that in? */
23599 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23601 /* If we were displaying active text in another window, clear that.
23602 Also clear if we move out of text area in same window. */
23603 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23604 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23605 && !NILP (dpyinfo
->mouse_face_window
)))
23606 clear_mouse_face (dpyinfo
);
23608 /* Not on a window -> return. */
23609 if (!WINDOWP (window
))
23612 /* Reset help_echo_string. It will get recomputed below. */
23613 help_echo_string
= Qnil
;
23615 /* Convert to window-relative pixel coordinates. */
23616 w
= XWINDOW (window
);
23617 frame_to_window_pixel_xy (w
, &x
, &y
);
23619 /* Handle tool-bar window differently since it doesn't display a
23621 if (EQ (window
, f
->tool_bar_window
))
23623 note_tool_bar_highlight (f
, x
, y
);
23627 /* Mouse is on the mode, header line or margin? */
23628 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23629 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23631 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23635 if (part
== ON_VERTICAL_BORDER
)
23637 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23638 help_echo_string
= build_string ("drag-mouse-1: resize");
23640 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23641 || part
== ON_SCROLL_BAR
)
23642 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23644 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23646 /* Are we in a window whose display is up to date?
23647 And verify the buffer's text has not changed. */
23648 b
= XBUFFER (w
->buffer
);
23649 if (part
== ON_TEXT
23650 && EQ (w
->window_end_valid
, w
->buffer
)
23651 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23652 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23654 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23655 struct glyph
*glyph
;
23656 Lisp_Object object
;
23657 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23658 Lisp_Object
*overlay_vec
= NULL
;
23660 struct buffer
*obuf
;
23661 int obegv
, ozv
, same_region
;
23663 /* Find the glyph under X/Y. */
23664 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23666 /* Look for :pointer property on image. */
23667 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23669 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23670 if (img
!= NULL
&& IMAGEP (img
->spec
))
23672 Lisp_Object image_map
, hotspot
;
23673 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23675 && (hotspot
= find_hot_spot (image_map
,
23676 glyph
->slice
.x
+ dx
,
23677 glyph
->slice
.y
+ dy
),
23679 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23681 Lisp_Object area_id
, plist
;
23683 area_id
= XCAR (hotspot
);
23684 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23685 If so, we could look for mouse-enter, mouse-leave
23686 properties in PLIST (and do something...). */
23687 hotspot
= XCDR (hotspot
);
23688 if (CONSP (hotspot
)
23689 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23691 pointer
= Fplist_get (plist
, Qpointer
);
23692 if (NILP (pointer
))
23694 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23695 if (!NILP (help_echo_string
))
23697 help_echo_window
= window
;
23698 help_echo_object
= glyph
->object
;
23699 help_echo_pos
= glyph
->charpos
;
23703 if (NILP (pointer
))
23704 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23708 /* Clear mouse face if X/Y not over text. */
23710 || area
!= TEXT_AREA
23711 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23713 if (clear_mouse_face (dpyinfo
))
23714 cursor
= No_Cursor
;
23715 if (NILP (pointer
))
23717 if (area
!= TEXT_AREA
)
23718 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23720 pointer
= Vvoid_text_area_pointer
;
23725 pos
= glyph
->charpos
;
23726 object
= glyph
->object
;
23727 if (!STRINGP (object
) && !BUFFERP (object
))
23730 /* If we get an out-of-range value, return now; avoid an error. */
23731 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23734 /* Make the window's buffer temporarily current for
23735 overlays_at and compute_char_face. */
23736 obuf
= current_buffer
;
23737 current_buffer
= b
;
23743 /* Is this char mouse-active or does it have help-echo? */
23744 position
= make_number (pos
);
23746 if (BUFFERP (object
))
23748 /* Put all the overlays we want in a vector in overlay_vec. */
23749 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23750 /* Sort overlays into increasing priority order. */
23751 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23756 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23757 && vpos
>= dpyinfo
->mouse_face_beg_row
23758 && vpos
<= dpyinfo
->mouse_face_end_row
23759 && (vpos
> dpyinfo
->mouse_face_beg_row
23760 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23761 && (vpos
< dpyinfo
->mouse_face_end_row
23762 || hpos
< dpyinfo
->mouse_face_end_col
23763 || dpyinfo
->mouse_face_past_end
));
23766 cursor
= No_Cursor
;
23768 /* Check mouse-face highlighting. */
23770 /* If there exists an overlay with mouse-face overlapping
23771 the one we are currently highlighting, we have to
23772 check if we enter the overlapping overlay, and then
23773 highlight only that. */
23774 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23775 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23777 /* Find the highest priority overlay that has a mouse-face
23780 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23782 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23783 if (!NILP (mouse_face
))
23784 overlay
= overlay_vec
[i
];
23787 /* If we're actually highlighting the same overlay as
23788 before, there's no need to do that again. */
23789 if (!NILP (overlay
)
23790 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23791 goto check_help_echo
;
23793 dpyinfo
->mouse_face_overlay
= overlay
;
23795 /* Clear the display of the old active region, if any. */
23796 if (clear_mouse_face (dpyinfo
))
23797 cursor
= No_Cursor
;
23799 /* If no overlay applies, get a text property. */
23800 if (NILP (overlay
))
23801 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23803 /* Handle the overlay case. */
23804 if (!NILP (overlay
))
23806 /* Find the range of text around this char that
23807 should be active. */
23808 Lisp_Object before
, after
;
23811 before
= Foverlay_start (overlay
);
23812 after
= Foverlay_end (overlay
);
23813 /* Record this as the current active region. */
23814 fast_find_position (w
, XFASTINT (before
),
23815 &dpyinfo
->mouse_face_beg_col
,
23816 &dpyinfo
->mouse_face_beg_row
,
23817 &dpyinfo
->mouse_face_beg_x
,
23818 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23820 dpyinfo
->mouse_face_past_end
23821 = !fast_find_position (w
, XFASTINT (after
),
23822 &dpyinfo
->mouse_face_end_col
,
23823 &dpyinfo
->mouse_face_end_row
,
23824 &dpyinfo
->mouse_face_end_x
,
23825 &dpyinfo
->mouse_face_end_y
, Qnil
);
23826 dpyinfo
->mouse_face_window
= window
;
23828 dpyinfo
->mouse_face_face_id
23829 = face_at_buffer_position (w
, pos
, 0, 0,
23831 !dpyinfo
->mouse_face_hidden
);
23833 /* Display it as active. */
23834 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23835 cursor
= No_Cursor
;
23837 /* Handle the text property case. */
23838 else if (!NILP (mouse_face
) && BUFFERP (object
))
23840 /* Find the range of text around this char that
23841 should be active. */
23842 Lisp_Object before
, after
, beginning
, end
;
23845 beginning
= Fmarker_position (w
->start
);
23846 end
= make_number (BUF_Z (XBUFFER (object
))
23847 - XFASTINT (w
->window_end_pos
));
23849 = Fprevious_single_property_change (make_number (pos
+ 1),
23851 object
, beginning
);
23853 = Fnext_single_property_change (position
, Qmouse_face
,
23856 /* Record this as the current active region. */
23857 fast_find_position (w
, XFASTINT (before
),
23858 &dpyinfo
->mouse_face_beg_col
,
23859 &dpyinfo
->mouse_face_beg_row
,
23860 &dpyinfo
->mouse_face_beg_x
,
23861 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23862 dpyinfo
->mouse_face_past_end
23863 = !fast_find_position (w
, XFASTINT (after
),
23864 &dpyinfo
->mouse_face_end_col
,
23865 &dpyinfo
->mouse_face_end_row
,
23866 &dpyinfo
->mouse_face_end_x
,
23867 &dpyinfo
->mouse_face_end_y
, Qnil
);
23868 dpyinfo
->mouse_face_window
= window
;
23870 if (BUFFERP (object
))
23871 dpyinfo
->mouse_face_face_id
23872 = face_at_buffer_position (w
, pos
, 0, 0,
23874 !dpyinfo
->mouse_face_hidden
);
23876 /* Display it as active. */
23877 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23878 cursor
= No_Cursor
;
23880 else if (!NILP (mouse_face
) && STRINGP (object
))
23885 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23888 e
= Fnext_single_property_change (position
, Qmouse_face
,
23891 b
= make_number (0);
23893 e
= make_number (SCHARS (object
) - 1);
23895 fast_find_string_pos (w
, XINT (b
), object
,
23896 &dpyinfo
->mouse_face_beg_col
,
23897 &dpyinfo
->mouse_face_beg_row
,
23898 &dpyinfo
->mouse_face_beg_x
,
23899 &dpyinfo
->mouse_face_beg_y
, 0);
23900 fast_find_string_pos (w
, XINT (e
), object
,
23901 &dpyinfo
->mouse_face_end_col
,
23902 &dpyinfo
->mouse_face_end_row
,
23903 &dpyinfo
->mouse_face_end_x
,
23904 &dpyinfo
->mouse_face_end_y
, 1);
23905 dpyinfo
->mouse_face_past_end
= 0;
23906 dpyinfo
->mouse_face_window
= window
;
23907 dpyinfo
->mouse_face_face_id
23908 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23909 glyph
->face_id
, 1);
23910 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23911 cursor
= No_Cursor
;
23913 else if (STRINGP (object
) && NILP (mouse_face
))
23915 /* A string which doesn't have mouse-face, but
23916 the text ``under'' it might have. */
23917 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23918 int start
= MATRIX_ROW_START_CHARPOS (r
);
23920 pos
= string_buffer_position (w
, object
, start
);
23922 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23926 if (!NILP (mouse_face
) && !NILP (overlay
))
23928 Lisp_Object before
= Foverlay_start (overlay
);
23929 Lisp_Object after
= Foverlay_end (overlay
);
23932 /* Note that we might not be able to find position
23933 BEFORE in the glyph matrix if the overlay is
23934 entirely covered by a `display' property. In
23935 this case, we overshoot. So let's stop in
23936 the glyph matrix before glyphs for OBJECT. */
23937 fast_find_position (w
, XFASTINT (before
),
23938 &dpyinfo
->mouse_face_beg_col
,
23939 &dpyinfo
->mouse_face_beg_row
,
23940 &dpyinfo
->mouse_face_beg_x
,
23941 &dpyinfo
->mouse_face_beg_y
,
23944 dpyinfo
->mouse_face_past_end
23945 = !fast_find_position (w
, XFASTINT (after
),
23946 &dpyinfo
->mouse_face_end_col
,
23947 &dpyinfo
->mouse_face_end_row
,
23948 &dpyinfo
->mouse_face_end_x
,
23949 &dpyinfo
->mouse_face_end_y
,
23951 dpyinfo
->mouse_face_window
= window
;
23952 dpyinfo
->mouse_face_face_id
23953 = face_at_buffer_position (w
, pos
, 0, 0,
23955 !dpyinfo
->mouse_face_hidden
);
23957 /* Display it as active. */
23958 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23959 cursor
= No_Cursor
;
23966 /* Look for a `help-echo' property. */
23967 if (NILP (help_echo_string
)) {
23968 Lisp_Object help
, overlay
;
23970 /* Check overlays first. */
23971 help
= overlay
= Qnil
;
23972 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23974 overlay
= overlay_vec
[i
];
23975 help
= Foverlay_get (overlay
, Qhelp_echo
);
23980 help_echo_string
= help
;
23981 help_echo_window
= window
;
23982 help_echo_object
= overlay
;
23983 help_echo_pos
= pos
;
23987 Lisp_Object object
= glyph
->object
;
23988 int charpos
= glyph
->charpos
;
23990 /* Try text properties. */
23991 if (STRINGP (object
)
23993 && charpos
< SCHARS (object
))
23995 help
= Fget_text_property (make_number (charpos
),
23996 Qhelp_echo
, object
);
23999 /* If the string itself doesn't specify a help-echo,
24000 see if the buffer text ``under'' it does. */
24001 struct glyph_row
*r
24002 = MATRIX_ROW (w
->current_matrix
, vpos
);
24003 int start
= MATRIX_ROW_START_CHARPOS (r
);
24004 int pos
= string_buffer_position (w
, object
, start
);
24007 help
= Fget_char_property (make_number (pos
),
24008 Qhelp_echo
, w
->buffer
);
24012 object
= w
->buffer
;
24017 else if (BUFFERP (object
)
24020 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24025 help_echo_string
= help
;
24026 help_echo_window
= window
;
24027 help_echo_object
= object
;
24028 help_echo_pos
= charpos
;
24033 /* Look for a `pointer' property. */
24034 if (NILP (pointer
))
24036 /* Check overlays first. */
24037 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24038 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24040 if (NILP (pointer
))
24042 Lisp_Object object
= glyph
->object
;
24043 int charpos
= glyph
->charpos
;
24045 /* Try text properties. */
24046 if (STRINGP (object
)
24048 && charpos
< SCHARS (object
))
24050 pointer
= Fget_text_property (make_number (charpos
),
24052 if (NILP (pointer
))
24054 /* If the string itself doesn't specify a pointer,
24055 see if the buffer text ``under'' it does. */
24056 struct glyph_row
*r
24057 = MATRIX_ROW (w
->current_matrix
, vpos
);
24058 int start
= MATRIX_ROW_START_CHARPOS (r
);
24059 int pos
= string_buffer_position (w
, object
, start
);
24061 pointer
= Fget_char_property (make_number (pos
),
24062 Qpointer
, w
->buffer
);
24065 else if (BUFFERP (object
)
24068 pointer
= Fget_text_property (make_number (charpos
),
24075 current_buffer
= obuf
;
24080 define_frame_cursor1 (f
, cursor
, pointer
);
24085 Clear any mouse-face on window W. This function is part of the
24086 redisplay interface, and is called from try_window_id and similar
24087 functions to ensure the mouse-highlight is off. */
24090 x_clear_window_mouse_face (w
)
24093 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24094 Lisp_Object window
;
24097 XSETWINDOW (window
, w
);
24098 if (EQ (window
, dpyinfo
->mouse_face_window
))
24099 clear_mouse_face (dpyinfo
);
24105 Just discard the mouse face information for frame F, if any.
24106 This is used when the size of F is changed. */
24109 cancel_mouse_face (f
)
24112 Lisp_Object window
;
24113 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24115 window
= dpyinfo
->mouse_face_window
;
24116 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24118 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24119 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24120 dpyinfo
->mouse_face_window
= Qnil
;
24125 #endif /* HAVE_WINDOW_SYSTEM */
24128 /***********************************************************************
24130 ***********************************************************************/
24132 #ifdef HAVE_WINDOW_SYSTEM
24134 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24135 which intersects rectangle R. R is in window-relative coordinates. */
24138 expose_area (w
, row
, r
, area
)
24140 struct glyph_row
*row
;
24142 enum glyph_row_area area
;
24144 struct glyph
*first
= row
->glyphs
[area
];
24145 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24146 struct glyph
*last
;
24147 int first_x
, start_x
, x
;
24149 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24150 /* If row extends face to end of line write the whole line. */
24151 draw_glyphs (w
, 0, row
, area
,
24152 0, row
->used
[area
],
24153 DRAW_NORMAL_TEXT
, 0);
24156 /* Set START_X to the window-relative start position for drawing glyphs of
24157 AREA. The first glyph of the text area can be partially visible.
24158 The first glyphs of other areas cannot. */
24159 start_x
= window_box_left_offset (w
, area
);
24161 if (area
== TEXT_AREA
)
24164 /* Find the first glyph that must be redrawn. */
24166 && x
+ first
->pixel_width
< r
->x
)
24168 x
+= first
->pixel_width
;
24172 /* Find the last one. */
24176 && x
< r
->x
+ r
->width
)
24178 x
+= last
->pixel_width
;
24184 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24185 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24186 DRAW_NORMAL_TEXT
, 0);
24191 /* Redraw the parts of the glyph row ROW on window W intersecting
24192 rectangle R. R is in window-relative coordinates. Value is
24193 non-zero if mouse-face was overwritten. */
24196 expose_line (w
, row
, r
)
24198 struct glyph_row
*row
;
24201 xassert (row
->enabled_p
);
24203 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24204 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24205 0, row
->used
[TEXT_AREA
],
24206 DRAW_NORMAL_TEXT
, 0);
24209 if (row
->used
[LEFT_MARGIN_AREA
])
24210 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24211 if (row
->used
[TEXT_AREA
])
24212 expose_area (w
, row
, r
, TEXT_AREA
);
24213 if (row
->used
[RIGHT_MARGIN_AREA
])
24214 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24215 draw_row_fringe_bitmaps (w
, row
);
24218 return row
->mouse_face_p
;
24222 /* Redraw those parts of glyphs rows during expose event handling that
24223 overlap other rows. Redrawing of an exposed line writes over parts
24224 of lines overlapping that exposed line; this function fixes that.
24226 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24227 row in W's current matrix that is exposed and overlaps other rows.
24228 LAST_OVERLAPPING_ROW is the last such row. */
24231 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24233 struct glyph_row
*first_overlapping_row
;
24234 struct glyph_row
*last_overlapping_row
;
24237 struct glyph_row
*row
;
24239 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24240 if (row
->overlapping_p
)
24242 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24245 if (row
->used
[LEFT_MARGIN_AREA
])
24246 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24248 if (row
->used
[TEXT_AREA
])
24249 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24251 if (row
->used
[RIGHT_MARGIN_AREA
])
24252 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24258 /* Return non-zero if W's cursor intersects rectangle R. */
24261 phys_cursor_in_rect_p (w
, r
)
24265 XRectangle cr
, result
;
24266 struct glyph
*cursor_glyph
;
24267 struct glyph_row
*row
;
24269 if (w
->phys_cursor
.vpos
>= 0
24270 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24271 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24273 && row
->cursor_in_fringe_p
)
24275 /* Cursor is in the fringe. */
24276 cr
.x
= window_box_right_offset (w
,
24277 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24278 ? RIGHT_MARGIN_AREA
24281 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24282 cr
.height
= row
->height
;
24283 return x_intersect_rectangles (&cr
, r
, &result
);
24286 cursor_glyph
= get_phys_cursor_glyph (w
);
24289 /* r is relative to W's box, but w->phys_cursor.x is relative
24290 to left edge of W's TEXT area. Adjust it. */
24291 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24292 cr
.y
= w
->phys_cursor
.y
;
24293 cr
.width
= cursor_glyph
->pixel_width
;
24294 cr
.height
= w
->phys_cursor_height
;
24295 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24296 I assume the effect is the same -- and this is portable. */
24297 return x_intersect_rectangles (&cr
, r
, &result
);
24299 /* If we don't understand the format, pretend we're not in the hot-spot. */
24305 Draw a vertical window border to the right of window W if W doesn't
24306 have vertical scroll bars. */
24309 x_draw_vertical_border (w
)
24312 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24314 /* We could do better, if we knew what type of scroll-bar the adjacent
24315 windows (on either side) have... But we don't :-(
24316 However, I think this works ok. ++KFS 2003-04-25 */
24318 /* Redraw borders between horizontally adjacent windows. Don't
24319 do it for frames with vertical scroll bars because either the
24320 right scroll bar of a window, or the left scroll bar of its
24321 neighbor will suffice as a border. */
24322 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24325 if (!WINDOW_RIGHTMOST_P (w
)
24326 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24328 int x0
, x1
, y0
, y1
;
24330 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24333 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24336 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24338 else if (!WINDOW_LEFTMOST_P (w
)
24339 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24341 int x0
, x1
, y0
, y1
;
24343 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24346 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24349 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24354 /* Redraw the part of window W intersection rectangle FR. Pixel
24355 coordinates in FR are frame-relative. Call this function with
24356 input blocked. Value is non-zero if the exposure overwrites
24360 expose_window (w
, fr
)
24364 struct frame
*f
= XFRAME (w
->frame
);
24366 int mouse_face_overwritten_p
= 0;
24368 /* If window is not yet fully initialized, do nothing. This can
24369 happen when toolkit scroll bars are used and a window is split.
24370 Reconfiguring the scroll bar will generate an expose for a newly
24372 if (w
->current_matrix
== NULL
)
24375 /* When we're currently updating the window, display and current
24376 matrix usually don't agree. Arrange for a thorough display
24378 if (w
== updated_window
)
24380 SET_FRAME_GARBAGED (f
);
24384 /* Frame-relative pixel rectangle of W. */
24385 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24386 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24387 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24388 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24390 if (x_intersect_rectangles (fr
, &wr
, &r
))
24392 int yb
= window_text_bottom_y (w
);
24393 struct glyph_row
*row
;
24394 int cursor_cleared_p
;
24395 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24397 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24398 r
.x
, r
.y
, r
.width
, r
.height
));
24400 /* Convert to window coordinates. */
24401 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24402 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24404 /* Turn off the cursor. */
24405 if (!w
->pseudo_window_p
24406 && phys_cursor_in_rect_p (w
, &r
))
24408 x_clear_cursor (w
);
24409 cursor_cleared_p
= 1;
24412 cursor_cleared_p
= 0;
24414 /* Update lines intersecting rectangle R. */
24415 first_overlapping_row
= last_overlapping_row
= NULL
;
24416 for (row
= w
->current_matrix
->rows
;
24421 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24423 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24424 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24425 || (r
.y
>= y0
&& r
.y
< y1
)
24426 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24428 /* A header line may be overlapping, but there is no need
24429 to fix overlapping areas for them. KFS 2005-02-12 */
24430 if (row
->overlapping_p
&& !row
->mode_line_p
)
24432 if (first_overlapping_row
== NULL
)
24433 first_overlapping_row
= row
;
24434 last_overlapping_row
= row
;
24438 if (expose_line (w
, row
, &r
))
24439 mouse_face_overwritten_p
= 1;
24442 else if (row
->overlapping_p
)
24444 /* We must redraw a row overlapping the exposed area. */
24446 ? y0
+ row
->phys_height
> r
.y
24447 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24449 if (first_overlapping_row
== NULL
)
24450 first_overlapping_row
= row
;
24451 last_overlapping_row
= row
;
24459 /* Display the mode line if there is one. */
24460 if (WINDOW_WANTS_MODELINE_P (w
)
24461 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24463 && row
->y
< r
.y
+ r
.height
)
24465 if (expose_line (w
, row
, &r
))
24466 mouse_face_overwritten_p
= 1;
24469 if (!w
->pseudo_window_p
)
24471 /* Fix the display of overlapping rows. */
24472 if (first_overlapping_row
)
24473 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24476 /* Draw border between windows. */
24477 x_draw_vertical_border (w
);
24479 /* Turn the cursor on again. */
24480 if (cursor_cleared_p
)
24481 update_window_cursor (w
, 1);
24485 return mouse_face_overwritten_p
;
24490 /* Redraw (parts) of all windows in the window tree rooted at W that
24491 intersect R. R contains frame pixel coordinates. Value is
24492 non-zero if the exposure overwrites mouse-face. */
24495 expose_window_tree (w
, r
)
24499 struct frame
*f
= XFRAME (w
->frame
);
24500 int mouse_face_overwritten_p
= 0;
24502 while (w
&& !FRAME_GARBAGED_P (f
))
24504 if (!NILP (w
->hchild
))
24505 mouse_face_overwritten_p
24506 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24507 else if (!NILP (w
->vchild
))
24508 mouse_face_overwritten_p
24509 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24511 mouse_face_overwritten_p
|= expose_window (w
, r
);
24513 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24516 return mouse_face_overwritten_p
;
24521 Redisplay an exposed area of frame F. X and Y are the upper-left
24522 corner of the exposed rectangle. W and H are width and height of
24523 the exposed area. All are pixel values. W or H zero means redraw
24524 the entire frame. */
24527 expose_frame (f
, x
, y
, w
, h
)
24532 int mouse_face_overwritten_p
= 0;
24534 TRACE ((stderr
, "expose_frame "));
24536 /* No need to redraw if frame will be redrawn soon. */
24537 if (FRAME_GARBAGED_P (f
))
24539 TRACE ((stderr
, " garbaged\n"));
24543 /* If basic faces haven't been realized yet, there is no point in
24544 trying to redraw anything. This can happen when we get an expose
24545 event while Emacs is starting, e.g. by moving another window. */
24546 if (FRAME_FACE_CACHE (f
) == NULL
24547 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24549 TRACE ((stderr
, " no faces\n"));
24553 if (w
== 0 || h
== 0)
24556 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24557 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24567 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24568 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24570 if (WINDOWP (f
->tool_bar_window
))
24571 mouse_face_overwritten_p
24572 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24574 #ifdef HAVE_X_WINDOWS
24576 #ifndef USE_X_TOOLKIT
24577 if (WINDOWP (f
->menu_bar_window
))
24578 mouse_face_overwritten_p
24579 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24580 #endif /* not USE_X_TOOLKIT */
24584 /* Some window managers support a focus-follows-mouse style with
24585 delayed raising of frames. Imagine a partially obscured frame,
24586 and moving the mouse into partially obscured mouse-face on that
24587 frame. The visible part of the mouse-face will be highlighted,
24588 then the WM raises the obscured frame. With at least one WM, KDE
24589 2.1, Emacs is not getting any event for the raising of the frame
24590 (even tried with SubstructureRedirectMask), only Expose events.
24591 These expose events will draw text normally, i.e. not
24592 highlighted. Which means we must redo the highlight here.
24593 Subsume it under ``we love X''. --gerd 2001-08-15 */
24594 /* Included in Windows version because Windows most likely does not
24595 do the right thing if any third party tool offers
24596 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24597 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24599 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24600 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24602 int x
= dpyinfo
->mouse_face_mouse_x
;
24603 int y
= dpyinfo
->mouse_face_mouse_y
;
24604 clear_mouse_face (dpyinfo
);
24605 note_mouse_highlight (f
, x
, y
);
24612 Determine the intersection of two rectangles R1 and R2. Return
24613 the intersection in *RESULT. Value is non-zero if RESULT is not
24617 x_intersect_rectangles (r1
, r2
, result
)
24618 XRectangle
*r1
, *r2
, *result
;
24620 XRectangle
*left
, *right
;
24621 XRectangle
*upper
, *lower
;
24622 int intersection_p
= 0;
24624 /* Rearrange so that R1 is the left-most rectangle. */
24626 left
= r1
, right
= r2
;
24628 left
= r2
, right
= r1
;
24630 /* X0 of the intersection is right.x0, if this is inside R1,
24631 otherwise there is no intersection. */
24632 if (right
->x
<= left
->x
+ left
->width
)
24634 result
->x
= right
->x
;
24636 /* The right end of the intersection is the minimum of the
24637 the right ends of left and right. */
24638 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24641 /* Same game for Y. */
24643 upper
= r1
, lower
= r2
;
24645 upper
= r2
, lower
= r1
;
24647 /* The upper end of the intersection is lower.y0, if this is inside
24648 of upper. Otherwise, there is no intersection. */
24649 if (lower
->y
<= upper
->y
+ upper
->height
)
24651 result
->y
= lower
->y
;
24653 /* The lower end of the intersection is the minimum of the lower
24654 ends of upper and lower. */
24655 result
->height
= (min (lower
->y
+ lower
->height
,
24656 upper
->y
+ upper
->height
)
24658 intersection_p
= 1;
24662 return intersection_p
;
24665 #endif /* HAVE_WINDOW_SYSTEM */
24668 /***********************************************************************
24670 ***********************************************************************/
24675 Vwith_echo_area_save_vector
= Qnil
;
24676 staticpro (&Vwith_echo_area_save_vector
);
24678 Vmessage_stack
= Qnil
;
24679 staticpro (&Vmessage_stack
);
24681 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24682 staticpro (&Qinhibit_redisplay
);
24684 message_dolog_marker1
= Fmake_marker ();
24685 staticpro (&message_dolog_marker1
);
24686 message_dolog_marker2
= Fmake_marker ();
24687 staticpro (&message_dolog_marker2
);
24688 message_dolog_marker3
= Fmake_marker ();
24689 staticpro (&message_dolog_marker3
);
24692 defsubr (&Sdump_frame_glyph_matrix
);
24693 defsubr (&Sdump_glyph_matrix
);
24694 defsubr (&Sdump_glyph_row
);
24695 defsubr (&Sdump_tool_bar_row
);
24696 defsubr (&Strace_redisplay
);
24697 defsubr (&Strace_to_stderr
);
24699 #ifdef HAVE_WINDOW_SYSTEM
24700 defsubr (&Stool_bar_lines_needed
);
24701 defsubr (&Slookup_image_map
);
24703 defsubr (&Sformat_mode_line
);
24704 defsubr (&Sinvisible_p
);
24706 staticpro (&Qmenu_bar_update_hook
);
24707 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24709 staticpro (&Qoverriding_terminal_local_map
);
24710 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24712 staticpro (&Qoverriding_local_map
);
24713 Qoverriding_local_map
= intern ("overriding-local-map");
24715 staticpro (&Qwindow_scroll_functions
);
24716 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24718 staticpro (&Qwindow_text_change_functions
);
24719 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24721 staticpro (&Qredisplay_end_trigger_functions
);
24722 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24724 staticpro (&Qinhibit_point_motion_hooks
);
24725 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24727 Qeval
= intern ("eval");
24728 staticpro (&Qeval
);
24730 QCdata
= intern (":data");
24731 staticpro (&QCdata
);
24732 Qdisplay
= intern ("display");
24733 staticpro (&Qdisplay
);
24734 Qspace_width
= intern ("space-width");
24735 staticpro (&Qspace_width
);
24736 Qraise
= intern ("raise");
24737 staticpro (&Qraise
);
24738 Qslice
= intern ("slice");
24739 staticpro (&Qslice
);
24740 Qspace
= intern ("space");
24741 staticpro (&Qspace
);
24742 Qmargin
= intern ("margin");
24743 staticpro (&Qmargin
);
24744 Qpointer
= intern ("pointer");
24745 staticpro (&Qpointer
);
24746 Qleft_margin
= intern ("left-margin");
24747 staticpro (&Qleft_margin
);
24748 Qright_margin
= intern ("right-margin");
24749 staticpro (&Qright_margin
);
24750 Qcenter
= intern ("center");
24751 staticpro (&Qcenter
);
24752 Qline_height
= intern ("line-height");
24753 staticpro (&Qline_height
);
24754 QCalign_to
= intern (":align-to");
24755 staticpro (&QCalign_to
);
24756 QCrelative_width
= intern (":relative-width");
24757 staticpro (&QCrelative_width
);
24758 QCrelative_height
= intern (":relative-height");
24759 staticpro (&QCrelative_height
);
24760 QCeval
= intern (":eval");
24761 staticpro (&QCeval
);
24762 QCpropertize
= intern (":propertize");
24763 staticpro (&QCpropertize
);
24764 QCfile
= intern (":file");
24765 staticpro (&QCfile
);
24766 Qfontified
= intern ("fontified");
24767 staticpro (&Qfontified
);
24768 Qfontification_functions
= intern ("fontification-functions");
24769 staticpro (&Qfontification_functions
);
24770 Qtrailing_whitespace
= intern ("trailing-whitespace");
24771 staticpro (&Qtrailing_whitespace
);
24772 Qescape_glyph
= intern ("escape-glyph");
24773 staticpro (&Qescape_glyph
);
24774 Qnobreak_space
= intern ("nobreak-space");
24775 staticpro (&Qnobreak_space
);
24776 Qimage
= intern ("image");
24777 staticpro (&Qimage
);
24778 QCmap
= intern (":map");
24779 staticpro (&QCmap
);
24780 QCpointer
= intern (":pointer");
24781 staticpro (&QCpointer
);
24782 Qrect
= intern ("rect");
24783 staticpro (&Qrect
);
24784 Qcircle
= intern ("circle");
24785 staticpro (&Qcircle
);
24786 Qpoly
= intern ("poly");
24787 staticpro (&Qpoly
);
24788 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24789 staticpro (&Qmessage_truncate_lines
);
24790 Qgrow_only
= intern ("grow-only");
24791 staticpro (&Qgrow_only
);
24792 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24793 staticpro (&Qinhibit_menubar_update
);
24794 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24795 staticpro (&Qinhibit_eval_during_redisplay
);
24796 Qposition
= intern ("position");
24797 staticpro (&Qposition
);
24798 Qbuffer_position
= intern ("buffer-position");
24799 staticpro (&Qbuffer_position
);
24800 Qobject
= intern ("object");
24801 staticpro (&Qobject
);
24802 Qbar
= intern ("bar");
24804 Qhbar
= intern ("hbar");
24805 staticpro (&Qhbar
);
24806 Qbox
= intern ("box");
24808 Qhollow
= intern ("hollow");
24809 staticpro (&Qhollow
);
24810 Qhand
= intern ("hand");
24811 staticpro (&Qhand
);
24812 Qarrow
= intern ("arrow");
24813 staticpro (&Qarrow
);
24814 Qtext
= intern ("text");
24815 staticpro (&Qtext
);
24816 Qrisky_local_variable
= intern ("risky-local-variable");
24817 staticpro (&Qrisky_local_variable
);
24818 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24819 staticpro (&Qinhibit_free_realized_faces
);
24821 list_of_error
= Fcons (Fcons (intern ("error"),
24822 Fcons (intern ("void-variable"), Qnil
)),
24824 staticpro (&list_of_error
);
24826 Qlast_arrow_position
= intern ("last-arrow-position");
24827 staticpro (&Qlast_arrow_position
);
24828 Qlast_arrow_string
= intern ("last-arrow-string");
24829 staticpro (&Qlast_arrow_string
);
24831 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24832 staticpro (&Qoverlay_arrow_string
);
24833 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24834 staticpro (&Qoverlay_arrow_bitmap
);
24836 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24837 staticpro (&echo_buffer
[0]);
24838 staticpro (&echo_buffer
[1]);
24840 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24841 staticpro (&echo_area_buffer
[0]);
24842 staticpro (&echo_area_buffer
[1]);
24844 Vmessages_buffer_name
= build_string ("*Messages*");
24845 staticpro (&Vmessages_buffer_name
);
24847 mode_line_proptrans_alist
= Qnil
;
24848 staticpro (&mode_line_proptrans_alist
);
24849 mode_line_string_list
= Qnil
;
24850 staticpro (&mode_line_string_list
);
24851 mode_line_string_face
= Qnil
;
24852 staticpro (&mode_line_string_face
);
24853 mode_line_string_face_prop
= Qnil
;
24854 staticpro (&mode_line_string_face_prop
);
24855 Vmode_line_unwind_vector
= Qnil
;
24856 staticpro (&Vmode_line_unwind_vector
);
24858 help_echo_string
= Qnil
;
24859 staticpro (&help_echo_string
);
24860 help_echo_object
= Qnil
;
24861 staticpro (&help_echo_object
);
24862 help_echo_window
= Qnil
;
24863 staticpro (&help_echo_window
);
24864 previous_help_echo_string
= Qnil
;
24865 staticpro (&previous_help_echo_string
);
24866 help_echo_pos
= -1;
24868 #ifdef HAVE_WINDOW_SYSTEM
24869 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24870 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24871 For example, if a block cursor is over a tab, it will be drawn as
24872 wide as that tab on the display. */);
24873 x_stretch_cursor_p
= 0;
24876 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24877 doc
: /* *Non-nil means highlight trailing whitespace.
24878 The face used for trailing whitespace is `trailing-whitespace'. */);
24879 Vshow_trailing_whitespace
= Qnil
;
24881 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24882 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24883 A value of t means highlight the character itself (for nobreak space,
24884 use face `nobreak-space').
24885 A value of nil means no highlighting.
24886 Other values mean display the escape glyph followed by an ordinary
24887 space or ordinary hyphen. */);
24888 Vnobreak_char_display
= Qt
;
24890 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24891 doc
: /* *The pointer shape to show in void text areas.
24892 A value of nil means to show the text pointer. Other options are `arrow',
24893 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24894 Vvoid_text_area_pointer
= Qarrow
;
24896 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24897 doc
: /* Non-nil means don't actually do any redisplay.
24898 This is used for internal purposes. */);
24899 Vinhibit_redisplay
= Qnil
;
24901 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24902 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24903 Vglobal_mode_string
= Qnil
;
24905 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24906 doc
: /* Marker for where to display an arrow on top of the buffer text.
24907 This must be the beginning of a line in order to work.
24908 See also `overlay-arrow-string'. */);
24909 Voverlay_arrow_position
= Qnil
;
24911 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24912 doc
: /* String to display as an arrow in non-window frames.
24913 See also `overlay-arrow-position'. */);
24914 Voverlay_arrow_string
= build_string ("=>");
24916 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24917 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24918 The symbols on this list are examined during redisplay to determine
24919 where to display overlay arrows. */);
24920 Voverlay_arrow_variable_list
24921 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24923 DEFVAR_INT ("scroll-step", &scroll_step
,
24924 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24925 If that fails to bring point back on frame, point is centered instead.
24926 If this is zero, point is always centered after it moves off frame.
24927 If you want scrolling to always be a line at a time, you should set
24928 `scroll-conservatively' to a large value rather than set this to 1. */);
24930 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24931 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24932 If point moves off-screen, redisplay will scroll by up to
24933 `scroll-conservatively' lines in order to bring point just barely
24934 onto the screen again. If that cannot be done, then redisplay
24935 recenters point as usual.
24937 A value of zero means always recenter point if it moves off screen. */);
24938 scroll_conservatively
= 0;
24940 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24941 doc
: /* *Number of lines of margin at the top and bottom of a window.
24942 Recenter the window whenever point gets within this many lines
24943 of the top or bottom of the window. */);
24946 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24947 doc
: /* Pixels per inch value for non-window system displays.
24948 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24949 Vdisplay_pixels_per_inch
= make_float (72.0);
24952 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24955 DEFVAR_LISP ("truncate-partial-width-windows",
24956 &Vtruncate_partial_width_windows
,
24957 doc
: /* Non-nil means truncate lines in windows with less than the frame width.
24958 For an integer value, truncate lines in each window with less than the
24959 full frame width, provided the window width is less than that integer;
24960 otherwise, respect the value of `truncate-lines'.
24962 For any other non-nil value, truncate lines in all windows with
24963 less than the full frame width.
24965 A value of nil means to respect the value of `truncate-lines'.
24967 If `word-wrap' is enabled, you might want to reduce this. */);
24968 Vtruncate_partial_width_windows
= make_number (50);
24970 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24971 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24972 Any other value means to use the appropriate face, `mode-line',
24973 `header-line', or `menu' respectively. */);
24974 mode_line_inverse_video
= 1;
24976 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24977 doc
: /* *Maximum buffer size for which line number should be displayed.
24978 If the buffer is bigger than this, the line number does not appear
24979 in the mode line. A value of nil means no limit. */);
24980 Vline_number_display_limit
= Qnil
;
24982 DEFVAR_INT ("line-number-display-limit-width",
24983 &line_number_display_limit_width
,
24984 doc
: /* *Maximum line width (in characters) for line number display.
24985 If the average length of the lines near point is bigger than this, then the
24986 line number may be omitted from the mode line. */);
24987 line_number_display_limit_width
= 200;
24989 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24990 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24991 highlight_nonselected_windows
= 0;
24993 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24994 doc
: /* Non-nil if more than one frame is visible on this display.
24995 Minibuffer-only frames don't count, but iconified frames do.
24996 This variable is not guaranteed to be accurate except while processing
24997 `frame-title-format' and `icon-title-format'. */);
24999 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25000 doc
: /* Template for displaying the title bar of visible frames.
25001 \(Assuming the window manager supports this feature.)
25003 This variable has the same structure as `mode-line-format', except that
25004 the %c and %l constructs are ignored. It is used only on frames for
25005 which no explicit name has been set \(see `modify-frame-parameters'). */);
25007 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25008 doc
: /* Template for displaying the title bar of an iconified frame.
25009 \(Assuming the window manager supports this feature.)
25010 This variable has the same structure as `mode-line-format' (which see),
25011 and is used only on frames for which no explicit name has been set
25012 \(see `modify-frame-parameters'). */);
25014 = Vframe_title_format
25015 = Fcons (intern ("multiple-frames"),
25016 Fcons (build_string ("%b"),
25017 Fcons (Fcons (empty_unibyte_string
,
25018 Fcons (intern ("invocation-name"),
25019 Fcons (build_string ("@"),
25020 Fcons (intern ("system-name"),
25024 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25025 doc
: /* Maximum number of lines to keep in the message log buffer.
25026 If nil, disable message logging. If t, log messages but don't truncate
25027 the buffer when it becomes large. */);
25028 Vmessage_log_max
= make_number (100);
25030 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25031 doc
: /* Functions called before redisplay, if window sizes have changed.
25032 The value should be a list of functions that take one argument.
25033 Just before redisplay, for each frame, if any of its windows have changed
25034 size since the last redisplay, or have been split or deleted,
25035 all the functions in the list are called, with the frame as argument. */);
25036 Vwindow_size_change_functions
= Qnil
;
25038 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25039 doc
: /* List of functions to call before redisplaying a window with scrolling.
25040 Each function is called with two arguments, the window
25041 and its new display-start position. Note that the value of `window-end'
25042 is not valid when these functions are called. */);
25043 Vwindow_scroll_functions
= Qnil
;
25045 DEFVAR_LISP ("window-text-change-functions",
25046 &Vwindow_text_change_functions
,
25047 doc
: /* Functions to call in redisplay when text in the window might change. */);
25048 Vwindow_text_change_functions
= Qnil
;
25050 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25051 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25052 Each function is called with two arguments, the window and the end trigger value.
25053 See `set-window-redisplay-end-trigger'. */);
25054 Vredisplay_end_trigger_functions
= Qnil
;
25056 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25057 doc
: /* *Non-nil means autoselect window with mouse pointer.
25058 If nil, do not autoselect windows.
25059 A positive number means delay autoselection by that many seconds: a
25060 window is autoselected only after the mouse has remained in that
25061 window for the duration of the delay.
25062 A negative number has a similar effect, but causes windows to be
25063 autoselected only after the mouse has stopped moving. \(Because of
25064 the way Emacs compares mouse events, you will occasionally wait twice
25065 that time before the window gets selected.\)
25066 Any other value means to autoselect window instantaneously when the
25067 mouse pointer enters it.
25069 Autoselection selects the minibuffer only if it is active, and never
25070 unselects the minibuffer if it is active.
25072 When customizing this variable make sure that the actual value of
25073 `focus-follows-mouse' matches the behavior of your window manager. */);
25074 Vmouse_autoselect_window
= Qnil
;
25076 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25077 doc
: /* *Non-nil means automatically resize tool-bars.
25078 This dynamically changes the tool-bar's height to the minimum height
25079 that is needed to make all tool-bar items visible.
25080 If value is `grow-only', the tool-bar's height is only increased
25081 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25082 Vauto_resize_tool_bars
= Qt
;
25084 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25085 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25086 auto_raise_tool_bar_buttons_p
= 1;
25088 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25089 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25090 make_cursor_line_fully_visible_p
= 1;
25092 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25093 doc
: /* *Border below tool-bar in pixels.
25094 If an integer, use it as the height of the border.
25095 If it is one of `internal-border-width' or `border-width', use the
25096 value of the corresponding frame parameter.
25097 Otherwise, no border is added below the tool-bar. */);
25098 Vtool_bar_border
= Qinternal_border_width
;
25100 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25101 doc
: /* *Margin around tool-bar buttons in pixels.
25102 If an integer, use that for both horizontal and vertical margins.
25103 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25104 HORZ specifying the horizontal margin, and VERT specifying the
25105 vertical margin. */);
25106 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25108 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25109 doc
: /* *Relief thickness of tool-bar buttons. */);
25110 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25112 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25113 doc
: /* List of functions to call to fontify regions of text.
25114 Each function is called with one argument POS. Functions must
25115 fontify a region starting at POS in the current buffer, and give
25116 fontified regions the property `fontified'. */);
25117 Vfontification_functions
= Qnil
;
25118 Fmake_variable_buffer_local (Qfontification_functions
);
25120 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25121 &unibyte_display_via_language_environment
,
25122 doc
: /* *Non-nil means display unibyte text according to language environment.
25123 Specifically this means that unibyte non-ASCII characters
25124 are displayed by converting them to the equivalent multibyte characters
25125 according to the current language environment. As a result, they are
25126 displayed according to the current fontset. */);
25127 unibyte_display_via_language_environment
= 0;
25129 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25130 doc
: /* *Maximum height for resizing mini-windows.
25131 If a float, it specifies a fraction of the mini-window frame's height.
25132 If an integer, it specifies a number of lines. */);
25133 Vmax_mini_window_height
= make_float (0.25);
25135 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25136 doc
: /* *How to resize mini-windows.
25137 A value of nil means don't automatically resize mini-windows.
25138 A value of t means resize them to fit the text displayed in them.
25139 A value of `grow-only', the default, means let mini-windows grow
25140 only, until their display becomes empty, at which point the windows
25141 go back to their normal size. */);
25142 Vresize_mini_windows
= Qgrow_only
;
25144 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25145 doc
: /* Alist specifying how to blink the cursor off.
25146 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25147 `cursor-type' frame-parameter or variable equals ON-STATE,
25148 comparing using `equal', Emacs uses OFF-STATE to specify
25149 how to blink it off. ON-STATE and OFF-STATE are values for
25150 the `cursor-type' frame parameter.
25152 If a frame's ON-STATE has no entry in this list,
25153 the frame's other specifications determine how to blink the cursor off. */);
25154 Vblink_cursor_alist
= Qnil
;
25156 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25157 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25158 automatic_hscrolling_p
= 1;
25159 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
25160 staticpro (&Qauto_hscroll_mode
);
25162 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25163 doc
: /* *How many columns away from the window edge point is allowed to get
25164 before automatic hscrolling will horizontally scroll the window. */);
25165 hscroll_margin
= 5;
25167 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25168 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25169 When point is less than `hscroll-margin' columns from the window
25170 edge, automatic hscrolling will scroll the window by the amount of columns
25171 determined by this variable. If its value is a positive integer, scroll that
25172 many columns. If it's a positive floating-point number, it specifies the
25173 fraction of the window's width to scroll. If it's nil or zero, point will be
25174 centered horizontally after the scroll. Any other value, including negative
25175 numbers, are treated as if the value were zero.
25177 Automatic hscrolling always moves point outside the scroll margin, so if
25178 point was more than scroll step columns inside the margin, the window will
25179 scroll more than the value given by the scroll step.
25181 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25182 and `scroll-right' overrides this variable's effect. */);
25183 Vhscroll_step
= make_number (0);
25185 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25186 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25187 Bind this around calls to `message' to let it take effect. */);
25188 message_truncate_lines
= 0;
25190 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25191 doc
: /* Normal hook run to update the menu bar definitions.
25192 Redisplay runs this hook before it redisplays the menu bar.
25193 This is used to update submenus such as Buffers,
25194 whose contents depend on various data. */);
25195 Vmenu_bar_update_hook
= Qnil
;
25197 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25198 doc
: /* Frame for which we are updating a menu.
25199 The enable predicate for a menu binding should check this variable. */);
25200 Vmenu_updating_frame
= Qnil
;
25202 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25203 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25204 inhibit_menubar_update
= 0;
25206 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25207 doc
: /* Prefix added to the beginning of all continuation lines at display-time.
25208 May be a string, an image, or a stretch-glyph such as used by the
25209 `display' text-property.
25211 This variable is overridden by any `wrap-prefix' text-property.
25213 To add a prefix to non-continuation lines, use the `line-prefix' variable. */);
25214 Vwrap_prefix
= Qnil
;
25215 staticpro (&Qwrap_prefix
);
25216 Qwrap_prefix
= intern ("wrap-prefix");
25217 Fmake_variable_buffer_local (Qwrap_prefix
);
25219 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25220 doc
: /* Prefix added to the beginning of all non-continuation lines at display-time.
25221 May be a string, an image, or a stretch-glyph such as used by the
25222 `display' text-property.
25224 This variable is overridden by any `line-prefix' text-property.
25226 To add a prefix to continuation lines, use the `wrap-prefix' variable. */);
25227 Vline_prefix
= Qnil
;
25228 staticpro (&Qline_prefix
);
25229 Qline_prefix
= intern ("line-prefix");
25230 Fmake_variable_buffer_local (Qline_prefix
);
25232 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25233 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25234 inhibit_eval_during_redisplay
= 0;
25236 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25237 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25238 inhibit_free_realized_faces
= 0;
25241 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25242 doc
: /* Inhibit try_window_id display optimization. */);
25243 inhibit_try_window_id
= 0;
25245 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25246 doc
: /* Inhibit try_window_reusing display optimization. */);
25247 inhibit_try_window_reusing
= 0;
25249 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25250 doc
: /* Inhibit try_cursor_movement display optimization. */);
25251 inhibit_try_cursor_movement
= 0;
25252 #endif /* GLYPH_DEBUG */
25254 DEFVAR_INT ("overline-margin", &overline_margin
,
25255 doc
: /* *Space between overline and text, in pixels.
25256 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25257 margin to the caracter height. */);
25258 overline_margin
= 2;
25260 DEFVAR_INT ("underline-minimum-offset",
25261 &underline_minimum_offset
,
25262 doc
: /* Minimum distance between baseline and underline.
25263 This can improve legibility of underlined text at small font sizes,
25264 particularly when using variable `x-use-underline-position-properties'
25265 with fonts that specify an UNDERLINE_POSITION relatively close to the
25266 baseline. The default value is 1. */);
25267 underline_minimum_offset
= 1;
25269 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25270 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25271 display_hourglass_p
= 1;
25273 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25274 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25275 Value must be an integer or float. */);
25276 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25278 hourglass_atimer
= NULL
;
25279 hourglass_shown_p
= 0;
25283 /* Initialize this module when Emacs starts. */
25288 Lisp_Object root_window
;
25289 struct window
*mini_w
;
25291 current_header_line_height
= current_mode_line_height
= -1;
25293 CHARPOS (this_line_start_pos
) = 0;
25295 mini_w
= XWINDOW (minibuf_window
);
25296 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25298 if (!noninteractive
)
25300 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25303 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25304 set_window_height (root_window
,
25305 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25307 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25308 set_window_height (minibuf_window
, 1, 0);
25310 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25311 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25313 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25314 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25315 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25317 /* The default ellipsis glyphs `...'. */
25318 for (i
= 0; i
< 3; ++i
)
25319 default_invis_vector
[i
] = make_number ('.');
25323 /* Allocate the buffer for frame titles.
25324 Also used for `format-mode-line'. */
25326 mode_line_noprop_buf
= (char *) xmalloc (size
);
25327 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25328 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25329 mode_line_target
= MODE_LINE_DISPLAY
;
25332 help_echo_showing_p
= 0;
25335 /* Since w32 does not support atimers, it defines its own implementation of
25336 the following three functions in w32fns.c. */
25339 /* Platform-independent portion of hourglass implementation. */
25341 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25343 hourglass_started ()
25345 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25348 /* Cancel a currently active hourglass timer, and start a new one. */
25352 #if defined (HAVE_WINDOW_SYSTEM)
25354 int secs
, usecs
= 0;
25356 cancel_hourglass ();
25358 if (INTEGERP (Vhourglass_delay
)
25359 && XINT (Vhourglass_delay
) > 0)
25360 secs
= XFASTINT (Vhourglass_delay
);
25361 else if (FLOATP (Vhourglass_delay
)
25362 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25365 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25366 secs
= XFASTINT (tem
);
25367 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25370 secs
= DEFAULT_HOURGLASS_DELAY
;
25372 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25373 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25374 show_hourglass
, NULL
);
25379 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25382 cancel_hourglass ()
25384 #if defined (HAVE_WINDOW_SYSTEM)
25385 if (hourglass_atimer
)
25387 cancel_atimer (hourglass_atimer
);
25388 hourglass_atimer
= NULL
;
25391 if (hourglass_shown_p
)
25395 #endif /* ! WINDOWSNT */
25397 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25398 (do not change this comment) */