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
;
1326 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
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 (CHARPOS (pos
->string_pos
) >= 0)
3004 /* Recorded position is not in an overlay string, but in another
3005 string. This can only be a string from a `display' property.
3006 IT should already be filled with that string. */
3007 it
->current
.string_pos
= pos
->string_pos
;
3008 xassert (STRINGP (it
->string
));
3011 /* Restore position in display vector translations, control
3012 character translations or ellipses. */
3013 if (pos
->dpvec_index
>= 0)
3015 if (it
->dpvec
== NULL
)
3016 get_next_display_element (it
);
3017 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3018 it
->current
.dpvec_index
= pos
->dpvec_index
;
3022 return !overlay_strings_with_newlines
;
3026 /* Initialize IT for stepping through current_buffer in window W
3027 starting at ROW->start. */
3030 init_to_row_start (it
, w
, row
)
3033 struct glyph_row
*row
;
3035 init_from_display_pos (it
, w
, &row
->start
);
3036 it
->start
= row
->start
;
3037 it
->continuation_lines_width
= row
->continuation_lines_width
;
3042 /* Initialize IT for stepping through current_buffer in window W
3043 starting in the line following ROW, i.e. starting at ROW->end.
3044 Value is zero if there are overlay strings with newlines at ROW's
3048 init_to_row_end (it
, w
, row
)
3051 struct glyph_row
*row
;
3055 if (init_from_display_pos (it
, w
, &row
->end
))
3057 if (row
->continued_p
)
3058 it
->continuation_lines_width
3059 = row
->continuation_lines_width
+ row
->pixel_width
;
3070 /***********************************************************************
3072 ***********************************************************************/
3074 /* Called when IT reaches IT->stop_charpos. Handle text property and
3075 overlay changes. Set IT->stop_charpos to the next position where
3082 enum prop_handled handled
;
3083 int handle_overlay_change_p
;
3087 it
->current
.dpvec_index
= -1;
3088 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3089 it
->ignore_overlay_strings_at_pos_p
= 0;
3092 /* Use face of preceding text for ellipsis (if invisible) */
3093 if (it
->selective_display_ellipsis_p
)
3094 it
->saved_face_id
= it
->face_id
;
3098 handled
= HANDLED_NORMALLY
;
3100 /* Call text property handlers. */
3101 for (p
= it_props
; p
->handler
; ++p
)
3103 handled
= p
->handler (it
);
3105 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3107 else if (handled
== HANDLED_RETURN
)
3109 /* We still want to show before and after strings from
3110 overlays even if the actual buffer text is replaced. */
3111 if (!handle_overlay_change_p
3113 || !get_overlay_strings_1 (it
, 0, 0))
3116 setup_for_ellipsis (it
, 0);
3117 /* When handling a display spec, we might load an
3118 empty string. In that case, discard it here. We
3119 used to discard it in handle_single_display_spec,
3120 but that causes get_overlay_strings_1, above, to
3121 ignore overlay strings that we must check. */
3122 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3126 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3130 it
->ignore_overlay_strings_at_pos_p
= 1;
3131 it
->string_from_display_prop_p
= 0;
3132 handle_overlay_change_p
= 0;
3134 handled
= HANDLED_RECOMPUTE_PROPS
;
3137 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3138 handle_overlay_change_p
= 0;
3141 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3143 /* Don't check for overlay strings below when set to deliver
3144 characters from a display vector. */
3145 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3146 handle_overlay_change_p
= 0;
3148 /* Handle overlay changes.
3149 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3150 if it finds overlays. */
3151 if (handle_overlay_change_p
)
3152 handled
= handle_overlay_change (it
);
3157 setup_for_ellipsis (it
, 0);
3161 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3163 /* Determine where to stop next. */
3164 if (handled
== HANDLED_NORMALLY
)
3165 compute_stop_pos (it
);
3169 /* Compute IT->stop_charpos from text property and overlay change
3170 information for IT's current position. */
3173 compute_stop_pos (it
)
3176 register INTERVAL iv
, next_iv
;
3177 Lisp_Object object
, limit
, position
;
3178 EMACS_INT charpos
, bytepos
;
3180 /* If nowhere else, stop at the end. */
3181 it
->stop_charpos
= it
->end_charpos
;
3183 if (STRINGP (it
->string
))
3185 /* Strings are usually short, so don't limit the search for
3187 object
= it
->string
;
3189 charpos
= IT_STRING_CHARPOS (*it
);
3190 bytepos
= IT_STRING_BYTEPOS (*it
);
3196 /* If next overlay change is in front of the current stop pos
3197 (which is IT->end_charpos), stop there. Note: value of
3198 next_overlay_change is point-max if no overlay change
3200 charpos
= IT_CHARPOS (*it
);
3201 bytepos
= IT_BYTEPOS (*it
);
3202 pos
= next_overlay_change (charpos
);
3203 if (pos
< it
->stop_charpos
)
3204 it
->stop_charpos
= pos
;
3206 /* If showing the region, we have to stop at the region
3207 start or end because the face might change there. */
3208 if (it
->region_beg_charpos
> 0)
3210 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3211 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3212 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3213 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3216 /* Set up variables for computing the stop position from text
3217 property changes. */
3218 XSETBUFFER (object
, current_buffer
);
3219 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3222 /* Get the interval containing IT's position. Value is a null
3223 interval if there isn't such an interval. */
3224 position
= make_number (charpos
);
3225 iv
= validate_interval_range (object
, &position
, &position
, 0);
3226 if (!NULL_INTERVAL_P (iv
))
3228 Lisp_Object values_here
[LAST_PROP_IDX
];
3231 /* Get properties here. */
3232 for (p
= it_props
; p
->handler
; ++p
)
3233 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3235 /* Look for an interval following iv that has different
3237 for (next_iv
= next_interval (iv
);
3238 (!NULL_INTERVAL_P (next_iv
)
3240 || XFASTINT (limit
) > next_iv
->position
));
3241 next_iv
= next_interval (next_iv
))
3243 for (p
= it_props
; p
->handler
; ++p
)
3245 Lisp_Object new_value
;
3247 new_value
= textget (next_iv
->plist
, *p
->name
);
3248 if (!EQ (values_here
[p
->idx
], new_value
))
3256 if (!NULL_INTERVAL_P (next_iv
))
3258 if (INTEGERP (limit
)
3259 && next_iv
->position
>= XFASTINT (limit
))
3260 /* No text property change up to limit. */
3261 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3263 /* Text properties change in next_iv. */
3264 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3268 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3269 it
->stop_charpos
, it
->string
);
3271 xassert (STRINGP (it
->string
)
3272 || (it
->stop_charpos
>= BEGV
3273 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3277 /* Return the position of the next overlay change after POS in
3278 current_buffer. Value is point-max if no overlay change
3279 follows. This is like `next-overlay-change' but doesn't use
3283 next_overlay_change (pos
)
3288 Lisp_Object
*overlays
;
3291 /* Get all overlays at the given position. */
3292 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3294 /* If any of these overlays ends before endpos,
3295 use its ending point instead. */
3296 for (i
= 0; i
< noverlays
; ++i
)
3301 oend
= OVERLAY_END (overlays
[i
]);
3302 oendpos
= OVERLAY_POSITION (oend
);
3303 endpos
= min (endpos
, oendpos
);
3311 /***********************************************************************
3313 ***********************************************************************/
3315 /* Handle changes in the `fontified' property of the current buffer by
3316 calling hook functions from Qfontification_functions to fontify
3319 static enum prop_handled
3320 handle_fontified_prop (it
)
3323 Lisp_Object prop
, pos
;
3324 enum prop_handled handled
= HANDLED_NORMALLY
;
3326 if (!NILP (Vmemory_full
))
3329 /* Get the value of the `fontified' property at IT's current buffer
3330 position. (The `fontified' property doesn't have a special
3331 meaning in strings.) If the value is nil, call functions from
3332 Qfontification_functions. */
3333 if (!STRINGP (it
->string
)
3335 && !NILP (Vfontification_functions
)
3336 && !NILP (Vrun_hooks
)
3337 && (pos
= make_number (IT_CHARPOS (*it
)),
3338 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3339 /* Ignore the special cased nil value always present at EOB since
3340 no amount of fontifying will be able to change it. */
3341 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3343 int count
= SPECPDL_INDEX ();
3346 val
= Vfontification_functions
;
3347 specbind (Qfontification_functions
, Qnil
);
3349 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3350 safe_call1 (val
, pos
);
3353 Lisp_Object globals
, fn
;
3354 struct gcpro gcpro1
, gcpro2
;
3357 GCPRO2 (val
, globals
);
3359 for (; CONSP (val
); val
= XCDR (val
))
3365 /* A value of t indicates this hook has a local
3366 binding; it means to run the global binding too.
3367 In a global value, t should not occur. If it
3368 does, we must ignore it to avoid an endless
3370 for (globals
= Fdefault_value (Qfontification_functions
);
3372 globals
= XCDR (globals
))
3374 fn
= XCAR (globals
);
3376 safe_call1 (fn
, pos
);
3380 safe_call1 (fn
, pos
);
3386 unbind_to (count
, Qnil
);
3388 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3389 something. This avoids an endless loop if they failed to
3390 fontify the text for which reason ever. */
3391 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3392 handled
= HANDLED_RECOMPUTE_PROPS
;
3400 /***********************************************************************
3402 ***********************************************************************/
3404 /* Set up iterator IT from face properties at its current position.
3405 Called from handle_stop. */
3407 static enum prop_handled
3408 handle_face_prop (it
)
3412 EMACS_INT next_stop
;
3414 if (!STRINGP (it
->string
))
3417 = face_at_buffer_position (it
->w
,
3419 it
->region_beg_charpos
,
3420 it
->region_end_charpos
,
3423 + TEXT_PROP_DISTANCE_LIMIT
),
3426 /* Is this a start of a run of characters with box face?
3427 Caveat: this can be called for a freshly initialized
3428 iterator; face_id is -1 in this case. We know that the new
3429 face will not change until limit, i.e. if the new face has a
3430 box, all characters up to limit will have one. But, as
3431 usual, we don't know whether limit is really the end. */
3432 if (new_face_id
!= it
->face_id
)
3434 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3436 /* If new face has a box but old face has not, this is
3437 the start of a run of characters with box, i.e. it has
3438 a shadow on the left side. The value of face_id of the
3439 iterator will be -1 if this is the initial call that gets
3440 the face. In this case, we have to look in front of IT's
3441 position and see whether there is a face != new_face_id. */
3442 it
->start_of_box_run_p
3443 = (new_face
->box
!= FACE_NO_BOX
3444 && (it
->face_id
>= 0
3445 || IT_CHARPOS (*it
) == BEG
3446 || new_face_id
!= face_before_it_pos (it
)));
3447 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3452 int base_face_id
, bufpos
;
3454 Lisp_Object from_overlay
3455 = (it
->current
.overlay_string_index
>= 0
3456 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3459 /* See if we got to this string directly or indirectly from
3460 an overlay property. That includes the before-string or
3461 after-string of an overlay, strings in display properties
3462 provided by an overlay, their text properties, etc.
3464 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3465 if (! NILP (from_overlay
))
3466 for (i
= it
->sp
- 1; i
>= 0; i
--)
3468 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3470 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3471 else if (! NILP (it
->stack
[i
].from_overlay
))
3472 from_overlay
= it
->stack
[i
].from_overlay
;
3474 if (!NILP (from_overlay
))
3478 if (! NILP (from_overlay
))
3480 bufpos
= IT_CHARPOS (*it
);
3481 /* For a string from an overlay, the base face depends
3482 only on text properties and ignores overlays. */
3484 = face_for_overlay_string (it
->w
,
3486 it
->region_beg_charpos
,
3487 it
->region_end_charpos
,
3490 + TEXT_PROP_DISTANCE_LIMIT
),
3498 /* For strings from a `display' property, use the face at
3499 IT's current buffer position as the base face to merge
3500 with, so that overlay strings appear in the same face as
3501 surrounding text, unless they specify their own
3503 base_face_id
= underlying_face_id (it
);
3506 new_face_id
= face_at_string_position (it
->w
,
3508 IT_STRING_CHARPOS (*it
),
3510 it
->region_beg_charpos
,
3511 it
->region_end_charpos
,
3515 #if 0 /* This shouldn't be neccessary. Let's check it. */
3516 /* If IT is used to display a mode line we would really like to
3517 use the mode line face instead of the frame's default face. */
3518 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3519 && new_face_id
== DEFAULT_FACE_ID
)
3520 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3523 /* Is this a start of a run of characters with box? Caveat:
3524 this can be called for a freshly allocated iterator; face_id
3525 is -1 is this case. We know that the new face will not
3526 change until the next check pos, i.e. if the new face has a
3527 box, all characters up to that position will have a
3528 box. But, as usual, we don't know whether that position
3529 is really the end. */
3530 if (new_face_id
!= it
->face_id
)
3532 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3533 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3535 /* If new face has a box but old face hasn't, this is the
3536 start of a run of characters with box, i.e. it has a
3537 shadow on the left side. */
3538 it
->start_of_box_run_p
3539 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3540 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3544 it
->face_id
= new_face_id
;
3545 return HANDLED_NORMALLY
;
3549 /* Return the ID of the face ``underlying'' IT's current position,
3550 which is in a string. If the iterator is associated with a
3551 buffer, return the face at IT's current buffer position.
3552 Otherwise, use the iterator's base_face_id. */
3555 underlying_face_id (it
)
3558 int face_id
= it
->base_face_id
, i
;
3560 xassert (STRINGP (it
->string
));
3562 for (i
= it
->sp
- 1; i
>= 0; --i
)
3563 if (NILP (it
->stack
[i
].string
))
3564 face_id
= it
->stack
[i
].face_id
;
3570 /* Compute the face one character before or after the current position
3571 of IT. BEFORE_P non-zero means get the face in front of IT's
3572 position. Value is the id of the face. */
3575 face_before_or_after_it_pos (it
, before_p
)
3580 EMACS_INT next_check_charpos
;
3581 struct text_pos pos
;
3583 xassert (it
->s
== NULL
);
3585 if (STRINGP (it
->string
))
3587 int bufpos
, base_face_id
;
3589 /* No face change past the end of the string (for the case
3590 we are padding with spaces). No face change before the
3592 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3593 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3596 /* Set pos to the position before or after IT's current position. */
3598 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3600 /* For composition, we must check the character after the
3602 pos
= (it
->what
== IT_COMPOSITION
3603 ? string_pos (IT_STRING_CHARPOS (*it
)
3604 + it
->cmp_it
.nchars
, it
->string
)
3605 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3607 if (it
->current
.overlay_string_index
>= 0)
3608 bufpos
= IT_CHARPOS (*it
);
3612 base_face_id
= underlying_face_id (it
);
3614 /* Get the face for ASCII, or unibyte. */
3615 face_id
= face_at_string_position (it
->w
,
3619 it
->region_beg_charpos
,
3620 it
->region_end_charpos
,
3621 &next_check_charpos
,
3624 /* Correct the face for charsets different from ASCII. Do it
3625 for the multibyte case only. The face returned above is
3626 suitable for unibyte text if IT->string is unibyte. */
3627 if (STRING_MULTIBYTE (it
->string
))
3629 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3630 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3632 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3634 c
= string_char_and_length (p
, rest
, &len
);
3635 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3640 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3641 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3644 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3645 pos
= it
->current
.pos
;
3648 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3651 if (it
->what
== IT_COMPOSITION
)
3652 /* For composition, we must check the position after the
3654 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3656 INC_TEXT_POS (pos
, it
->multibyte_p
);
3659 /* Determine face for CHARSET_ASCII, or unibyte. */
3660 face_id
= face_at_buffer_position (it
->w
,
3662 it
->region_beg_charpos
,
3663 it
->region_end_charpos
,
3664 &next_check_charpos
,
3667 /* Correct the face for charsets different from ASCII. Do it
3668 for the multibyte case only. The face returned above is
3669 suitable for unibyte text if current_buffer is unibyte. */
3670 if (it
->multibyte_p
)
3672 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3673 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3674 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3683 /***********************************************************************
3685 ***********************************************************************/
3687 /* Set up iterator IT from invisible properties at its current
3688 position. Called from handle_stop. */
3690 static enum prop_handled
3691 handle_invisible_prop (it
)
3694 enum prop_handled handled
= HANDLED_NORMALLY
;
3696 if (STRINGP (it
->string
))
3698 extern Lisp_Object Qinvisible
;
3699 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3701 /* Get the value of the invisible text property at the
3702 current position. Value will be nil if there is no such
3704 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3705 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3708 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3710 handled
= HANDLED_RECOMPUTE_PROPS
;
3712 /* Get the position at which the next change of the
3713 invisible text property can be found in IT->string.
3714 Value will be nil if the property value is the same for
3715 all the rest of IT->string. */
3716 XSETINT (limit
, SCHARS (it
->string
));
3717 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3720 /* Text at current position is invisible. The next
3721 change in the property is at position end_charpos.
3722 Move IT's current position to that position. */
3723 if (INTEGERP (end_charpos
)
3724 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3726 struct text_pos old
;
3727 old
= it
->current
.string_pos
;
3728 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3729 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3733 /* The rest of the string is invisible. If this is an
3734 overlay string, proceed with the next overlay string
3735 or whatever comes and return a character from there. */
3736 if (it
->current
.overlay_string_index
>= 0)
3738 next_overlay_string (it
);
3739 /* Don't check for overlay strings when we just
3740 finished processing them. */
3741 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3745 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3746 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3754 EMACS_INT newpos
, next_stop
, start_charpos
;
3755 Lisp_Object pos
, prop
, overlay
;
3757 /* First of all, is there invisible text at this position? */
3758 start_charpos
= IT_CHARPOS (*it
);
3759 pos
= make_number (IT_CHARPOS (*it
));
3760 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3762 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3764 /* If we are on invisible text, skip over it. */
3765 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3767 /* Record whether we have to display an ellipsis for the
3769 int display_ellipsis_p
= invis_p
== 2;
3771 handled
= HANDLED_RECOMPUTE_PROPS
;
3773 /* Loop skipping over invisible text. The loop is left at
3774 ZV or with IT on the first char being visible again. */
3777 /* Try to skip some invisible text. Return value is the
3778 position reached which can be equal to IT's position
3779 if there is nothing invisible here. This skips both
3780 over invisible text properties and overlays with
3781 invisible property. */
3782 newpos
= skip_invisible (IT_CHARPOS (*it
),
3783 &next_stop
, ZV
, it
->window
);
3785 /* If we skipped nothing at all we weren't at invisible
3786 text in the first place. If everything to the end of
3787 the buffer was skipped, end the loop. */
3788 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3792 /* We skipped some characters but not necessarily
3793 all there are. Check if we ended up on visible
3794 text. Fget_char_property returns the property of
3795 the char before the given position, i.e. if we
3796 get invis_p = 0, this means that the char at
3797 newpos is visible. */
3798 pos
= make_number (newpos
);
3799 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3800 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3803 /* If we ended up on invisible text, proceed to
3804 skip starting with next_stop. */
3806 IT_CHARPOS (*it
) = next_stop
;
3808 /* If there are adjacent invisible texts, don't lose the
3809 second one's ellipsis. */
3811 display_ellipsis_p
= 1;
3815 /* The position newpos is now either ZV or on visible text. */
3816 IT_CHARPOS (*it
) = newpos
;
3817 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3819 /* If there are before-strings at the start of invisible
3820 text, and the text is invisible because of a text
3821 property, arrange to show before-strings because 20.x did
3822 it that way. (If the text is invisible because of an
3823 overlay property instead of a text property, this is
3824 already handled in the overlay code.) */
3826 && get_overlay_strings (it
, start_charpos
))
3828 handled
= HANDLED_RECOMPUTE_PROPS
;
3829 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3831 else if (display_ellipsis_p
)
3833 /* Make sure that the glyphs of the ellipsis will get
3834 correct `charpos' values. If we would not update
3835 it->position here, the glyphs would belong to the
3836 last visible character _before_ the invisible
3837 text, which confuses `set_cursor_from_row'.
3839 We use the last invisible position instead of the
3840 first because this way the cursor is always drawn on
3841 the first "." of the ellipsis, whenever PT is inside
3842 the invisible text. Otherwise the cursor would be
3843 placed _after_ the ellipsis when the point is after the
3844 first invisible character. */
3845 if (!STRINGP (it
->object
))
3847 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3848 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3851 /* Let the ellipsis display before
3852 considering any properties of the following char.
3853 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3854 handled
= HANDLED_RETURN
;
3863 /* Make iterator IT return `...' next.
3864 Replaces LEN characters from buffer. */
3867 setup_for_ellipsis (it
, len
)
3871 /* Use the display table definition for `...'. Invalid glyphs
3872 will be handled by the method returning elements from dpvec. */
3873 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3875 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3876 it
->dpvec
= v
->contents
;
3877 it
->dpend
= v
->contents
+ v
->size
;
3881 /* Default `...'. */
3882 it
->dpvec
= default_invis_vector
;
3883 it
->dpend
= default_invis_vector
+ 3;
3886 it
->dpvec_char_len
= len
;
3887 it
->current
.dpvec_index
= 0;
3888 it
->dpvec_face_id
= -1;
3890 /* Remember the current face id in case glyphs specify faces.
3891 IT's face is restored in set_iterator_to_next.
3892 saved_face_id was set to preceding char's face in handle_stop. */
3893 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3894 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3896 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3902 /***********************************************************************
3904 ***********************************************************************/
3906 /* Set up iterator IT from `display' property at its current position.
3907 Called from handle_stop.
3908 We return HANDLED_RETURN if some part of the display property
3909 overrides the display of the buffer text itself.
3910 Otherwise we return HANDLED_NORMALLY. */
3912 static enum prop_handled
3913 handle_display_prop (it
)
3916 Lisp_Object prop
, object
, overlay
;
3917 struct text_pos
*position
;
3918 /* Nonzero if some property replaces the display of the text itself. */
3919 int display_replaced_p
= 0;
3921 if (STRINGP (it
->string
))
3923 object
= it
->string
;
3924 position
= &it
->current
.string_pos
;
3928 XSETWINDOW (object
, it
->w
);
3929 position
= &it
->current
.pos
;
3932 /* Reset those iterator values set from display property values. */
3933 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3934 it
->space_width
= Qnil
;
3935 it
->font_height
= Qnil
;
3938 /* We don't support recursive `display' properties, i.e. string
3939 values that have a string `display' property, that have a string
3940 `display' property etc. */
3941 if (!it
->string_from_display_prop_p
)
3942 it
->area
= TEXT_AREA
;
3944 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3945 Qdisplay
, object
, &overlay
);
3947 return HANDLED_NORMALLY
;
3948 /* Now OVERLAY is the overlay that gave us this property, or nil
3949 if it was a text property. */
3951 if (!STRINGP (it
->string
))
3952 object
= it
->w
->buffer
;
3955 /* Simple properties. */
3956 && !EQ (XCAR (prop
), Qimage
)
3957 && !EQ (XCAR (prop
), Qspace
)
3958 && !EQ (XCAR (prop
), Qwhen
)
3959 && !EQ (XCAR (prop
), Qslice
)
3960 && !EQ (XCAR (prop
), Qspace_width
)
3961 && !EQ (XCAR (prop
), Qheight
)
3962 && !EQ (XCAR (prop
), Qraise
)
3963 /* Marginal area specifications. */
3964 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3965 && !EQ (XCAR (prop
), Qleft_fringe
)
3966 && !EQ (XCAR (prop
), Qright_fringe
)
3967 && !NILP (XCAR (prop
)))
3969 for (; CONSP (prop
); prop
= XCDR (prop
))
3971 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3972 position
, display_replaced_p
))
3974 display_replaced_p
= 1;
3975 /* If some text in a string is replaced, `position' no
3976 longer points to the position of `object'. */
3977 if (STRINGP (object
))
3982 else if (VECTORP (prop
))
3985 for (i
= 0; i
< ASIZE (prop
); ++i
)
3986 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3987 position
, display_replaced_p
))
3989 display_replaced_p
= 1;
3990 /* If some text in a string is replaced, `position' no
3991 longer points to the position of `object'. */
3992 if (STRINGP (object
))
3998 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4000 display_replaced_p
= 1;
4003 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4007 /* Value is the position of the end of the `display' property starting
4008 at START_POS in OBJECT. */
4010 static struct text_pos
4011 display_prop_end (it
, object
, start_pos
)
4014 struct text_pos start_pos
;
4017 struct text_pos end_pos
;
4019 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4020 Qdisplay
, object
, Qnil
);
4021 CHARPOS (end_pos
) = XFASTINT (end
);
4022 if (STRINGP (object
))
4023 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4025 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4031 /* Set up IT from a single `display' specification PROP. OBJECT
4032 is the object in which the `display' property was found. *POSITION
4033 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4034 means that we previously saw a display specification which already
4035 replaced text display with something else, for example an image;
4036 we ignore such properties after the first one has been processed.
4038 OVERLAY is the overlay this `display' property came from,
4039 or nil if it was a text property.
4041 If PROP is a `space' or `image' specification, and in some other
4042 cases too, set *POSITION to the position where the `display'
4045 Value is non-zero if something was found which replaces the display
4046 of buffer or string text. */
4049 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4050 display_replaced_before_p
)
4054 Lisp_Object overlay
;
4055 struct text_pos
*position
;
4056 int display_replaced_before_p
;
4059 Lisp_Object location
, value
;
4060 struct text_pos start_pos
, save_pos
;
4063 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4064 If the result is non-nil, use VALUE instead of SPEC. */
4066 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4075 if (!NILP (form
) && !EQ (form
, Qt
))
4077 int count
= SPECPDL_INDEX ();
4078 struct gcpro gcpro1
;
4080 /* Bind `object' to the object having the `display' property, a
4081 buffer or string. Bind `position' to the position in the
4082 object where the property was found, and `buffer-position'
4083 to the current position in the buffer. */
4084 specbind (Qobject
, object
);
4085 specbind (Qposition
, make_number (CHARPOS (*position
)));
4086 specbind (Qbuffer_position
,
4087 make_number (STRINGP (object
)
4088 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4090 form
= safe_eval (form
);
4092 unbind_to (count
, Qnil
);
4098 /* Handle `(height HEIGHT)' specifications. */
4100 && EQ (XCAR (spec
), Qheight
)
4101 && CONSP (XCDR (spec
)))
4103 if (!FRAME_WINDOW_P (it
->f
))
4106 it
->font_height
= XCAR (XCDR (spec
));
4107 if (!NILP (it
->font_height
))
4109 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4110 int new_height
= -1;
4112 if (CONSP (it
->font_height
)
4113 && (EQ (XCAR (it
->font_height
), Qplus
)
4114 || EQ (XCAR (it
->font_height
), Qminus
))
4115 && CONSP (XCDR (it
->font_height
))
4116 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4118 /* `(+ N)' or `(- N)' where N is an integer. */
4119 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4120 if (EQ (XCAR (it
->font_height
), Qplus
))
4122 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4124 else if (FUNCTIONP (it
->font_height
))
4126 /* Call function with current height as argument.
4127 Value is the new height. */
4129 height
= safe_call1 (it
->font_height
,
4130 face
->lface
[LFACE_HEIGHT_INDEX
]);
4131 if (NUMBERP (height
))
4132 new_height
= XFLOATINT (height
);
4134 else if (NUMBERP (it
->font_height
))
4136 /* Value is a multiple of the canonical char height. */
4139 face
= FACE_FROM_ID (it
->f
,
4140 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4141 new_height
= (XFLOATINT (it
->font_height
)
4142 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4146 /* Evaluate IT->font_height with `height' bound to the
4147 current specified height to get the new height. */
4148 int count
= SPECPDL_INDEX ();
4150 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4151 value
= safe_eval (it
->font_height
);
4152 unbind_to (count
, Qnil
);
4154 if (NUMBERP (value
))
4155 new_height
= XFLOATINT (value
);
4159 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4165 /* Handle `(space-width WIDTH)'. */
4167 && EQ (XCAR (spec
), Qspace_width
)
4168 && CONSP (XCDR (spec
)))
4170 if (!FRAME_WINDOW_P (it
->f
))
4173 value
= XCAR (XCDR (spec
));
4174 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4175 it
->space_width
= value
;
4180 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4182 && EQ (XCAR (spec
), Qslice
))
4186 if (!FRAME_WINDOW_P (it
->f
))
4189 if (tem
= XCDR (spec
), CONSP (tem
))
4191 it
->slice
.x
= XCAR (tem
);
4192 if (tem
= XCDR (tem
), CONSP (tem
))
4194 it
->slice
.y
= XCAR (tem
);
4195 if (tem
= XCDR (tem
), CONSP (tem
))
4197 it
->slice
.width
= XCAR (tem
);
4198 if (tem
= XCDR (tem
), CONSP (tem
))
4199 it
->slice
.height
= XCAR (tem
);
4207 /* Handle `(raise FACTOR)'. */
4209 && EQ (XCAR (spec
), Qraise
)
4210 && CONSP (XCDR (spec
)))
4212 if (!FRAME_WINDOW_P (it
->f
))
4215 #ifdef HAVE_WINDOW_SYSTEM
4216 value
= XCAR (XCDR (spec
));
4217 if (NUMBERP (value
))
4219 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4220 it
->voffset
= - (XFLOATINT (value
)
4221 * (FONT_HEIGHT (face
->font
)));
4223 #endif /* HAVE_WINDOW_SYSTEM */
4228 /* Don't handle the other kinds of display specifications
4229 inside a string that we got from a `display' property. */
4230 if (it
->string_from_display_prop_p
)
4233 /* Characters having this form of property are not displayed, so
4234 we have to find the end of the property. */
4235 start_pos
= *position
;
4236 *position
= display_prop_end (it
, object
, start_pos
);
4239 /* Stop the scan at that end position--we assume that all
4240 text properties change there. */
4241 it
->stop_charpos
= position
->charpos
;
4243 /* Handle `(left-fringe BITMAP [FACE])'
4244 and `(right-fringe BITMAP [FACE])'. */
4246 && (EQ (XCAR (spec
), Qleft_fringe
)
4247 || EQ (XCAR (spec
), Qright_fringe
))
4248 && CONSP (XCDR (spec
)))
4250 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4253 if (!FRAME_WINDOW_P (it
->f
))
4254 /* If we return here, POSITION has been advanced
4255 across the text with this property. */
4258 #ifdef HAVE_WINDOW_SYSTEM
4259 value
= XCAR (XCDR (spec
));
4260 if (!SYMBOLP (value
)
4261 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4262 /* If we return here, POSITION has been advanced
4263 across the text with this property. */
4266 if (CONSP (XCDR (XCDR (spec
))))
4268 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4269 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4275 /* Save current settings of IT so that we can restore them
4276 when we are finished with the glyph property value. */
4278 save_pos
= it
->position
;
4279 it
->position
= *position
;
4281 it
->position
= save_pos
;
4283 it
->area
= TEXT_AREA
;
4284 it
->what
= IT_IMAGE
;
4285 it
->image_id
= -1; /* no image */
4286 it
->position
= start_pos
;
4287 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4288 it
->method
= GET_FROM_IMAGE
;
4289 it
->from_overlay
= Qnil
;
4290 it
->face_id
= face_id
;
4292 /* Say that we haven't consumed the characters with
4293 `display' property yet. The call to pop_it in
4294 set_iterator_to_next will clean this up. */
4295 *position
= start_pos
;
4297 if (EQ (XCAR (spec
), Qleft_fringe
))
4299 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4300 it
->left_user_fringe_face_id
= face_id
;
4304 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4305 it
->right_user_fringe_face_id
= face_id
;
4307 #endif /* HAVE_WINDOW_SYSTEM */
4311 /* Prepare to handle `((margin left-margin) ...)',
4312 `((margin right-margin) ...)' and `((margin nil) ...)'
4313 prefixes for display specifications. */
4314 location
= Qunbound
;
4315 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4319 value
= XCDR (spec
);
4321 value
= XCAR (value
);
4324 if (EQ (XCAR (tem
), Qmargin
)
4325 && (tem
= XCDR (tem
),
4326 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4328 || EQ (tem
, Qleft_margin
)
4329 || EQ (tem
, Qright_margin
))))
4333 if (EQ (location
, Qunbound
))
4339 /* After this point, VALUE is the property after any
4340 margin prefix has been stripped. It must be a string,
4341 an image specification, or `(space ...)'.
4343 LOCATION specifies where to display: `left-margin',
4344 `right-margin' or nil. */
4346 valid_p
= (STRINGP (value
)
4347 #ifdef HAVE_WINDOW_SYSTEM
4348 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4349 #endif /* not HAVE_WINDOW_SYSTEM */
4350 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4352 if (valid_p
&& !display_replaced_before_p
)
4354 /* Save current settings of IT so that we can restore them
4355 when we are finished with the glyph property value. */
4356 save_pos
= it
->position
;
4357 it
->position
= *position
;
4359 it
->position
= save_pos
;
4360 it
->from_overlay
= overlay
;
4362 if (NILP (location
))
4363 it
->area
= TEXT_AREA
;
4364 else if (EQ (location
, Qleft_margin
))
4365 it
->area
= LEFT_MARGIN_AREA
;
4367 it
->area
= RIGHT_MARGIN_AREA
;
4369 if (STRINGP (value
))
4372 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4373 it
->current
.overlay_string_index
= -1;
4374 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4375 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4376 it
->method
= GET_FROM_STRING
;
4377 it
->stop_charpos
= 0;
4378 it
->string_from_display_prop_p
= 1;
4379 /* Say that we haven't consumed the characters with
4380 `display' property yet. The call to pop_it in
4381 set_iterator_to_next will clean this up. */
4382 if (BUFFERP (object
))
4383 *position
= start_pos
;
4385 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4387 it
->method
= GET_FROM_STRETCH
;
4389 *position
= it
->position
= start_pos
;
4391 #ifdef HAVE_WINDOW_SYSTEM
4394 it
->what
= IT_IMAGE
;
4395 it
->image_id
= lookup_image (it
->f
, value
);
4396 it
->position
= start_pos
;
4397 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4398 it
->method
= GET_FROM_IMAGE
;
4400 /* Say that we haven't consumed the characters with
4401 `display' property yet. The call to pop_it in
4402 set_iterator_to_next will clean this up. */
4403 *position
= start_pos
;
4405 #endif /* HAVE_WINDOW_SYSTEM */
4410 /* Invalid property or property not supported. Restore
4411 POSITION to what it was before. */
4412 *position
= start_pos
;
4417 /* Check if SPEC is a display sub-property value whose text should be
4418 treated as intangible. */
4421 single_display_spec_intangible_p (prop
)
4424 /* Skip over `when FORM'. */
4425 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4439 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4440 we don't need to treat text as intangible. */
4441 if (EQ (XCAR (prop
), Qmargin
))
4449 || EQ (XCAR (prop
), Qleft_margin
)
4450 || EQ (XCAR (prop
), Qright_margin
))
4454 return (CONSP (prop
)
4455 && (EQ (XCAR (prop
), Qimage
)
4456 || EQ (XCAR (prop
), Qspace
)));
4460 /* Check if PROP is a display property value whose text should be
4461 treated as intangible. */
4464 display_prop_intangible_p (prop
)
4468 && CONSP (XCAR (prop
))
4469 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4471 /* A list of sub-properties. */
4472 while (CONSP (prop
))
4474 if (single_display_spec_intangible_p (XCAR (prop
)))
4479 else if (VECTORP (prop
))
4481 /* A vector of sub-properties. */
4483 for (i
= 0; i
< ASIZE (prop
); ++i
)
4484 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4488 return single_display_spec_intangible_p (prop
);
4494 /* Return 1 if PROP is a display sub-property value containing STRING. */
4497 single_display_spec_string_p (prop
, string
)
4498 Lisp_Object prop
, string
;
4500 if (EQ (string
, prop
))
4503 /* Skip over `when FORM'. */
4504 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4513 /* Skip over `margin LOCATION'. */
4514 if (EQ (XCAR (prop
), Qmargin
))
4525 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4529 /* Return 1 if STRING appears in the `display' property PROP. */
4532 display_prop_string_p (prop
, string
)
4533 Lisp_Object prop
, string
;
4536 && CONSP (XCAR (prop
))
4537 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4539 /* A list of sub-properties. */
4540 while (CONSP (prop
))
4542 if (single_display_spec_string_p (XCAR (prop
), string
))
4547 else if (VECTORP (prop
))
4549 /* A vector of sub-properties. */
4551 for (i
= 0; i
< ASIZE (prop
); ++i
)
4552 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4556 return single_display_spec_string_p (prop
, string
);
4562 /* Determine from which buffer position in W's buffer STRING comes
4563 from. AROUND_CHARPOS is an approximate position where it could
4564 be from. Value is the buffer position or 0 if it couldn't be
4567 W's buffer must be current.
4569 This function is necessary because we don't record buffer positions
4570 in glyphs generated from strings (to keep struct glyph small).
4571 This function may only use code that doesn't eval because it is
4572 called asynchronously from note_mouse_highlight. */
4575 string_buffer_position (w
, string
, around_charpos
)
4580 Lisp_Object limit
, prop
, pos
;
4581 const int MAX_DISTANCE
= 1000;
4584 pos
= make_number (around_charpos
);
4585 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4586 while (!found
&& !EQ (pos
, limit
))
4588 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4589 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4592 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4597 pos
= make_number (around_charpos
);
4598 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4599 while (!found
&& !EQ (pos
, limit
))
4601 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4602 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4605 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4610 return found
? XINT (pos
) : 0;
4615 /***********************************************************************
4616 `composition' property
4617 ***********************************************************************/
4619 /* Set up iterator IT from `composition' property at its current
4620 position. Called from handle_stop. */
4622 static enum prop_handled
4623 handle_composition_prop (it
)
4626 Lisp_Object prop
, string
;
4627 EMACS_INT pos
, pos_byte
, start
, end
;
4629 if (STRINGP (it
->string
))
4633 pos
= IT_STRING_CHARPOS (*it
);
4634 pos_byte
= IT_STRING_BYTEPOS (*it
);
4635 string
= it
->string
;
4636 s
= SDATA (string
) + pos_byte
;
4637 it
->c
= STRING_CHAR (s
, 0);
4641 pos
= IT_CHARPOS (*it
);
4642 pos_byte
= IT_BYTEPOS (*it
);
4644 it
->c
= FETCH_CHAR (pos_byte
);
4647 /* If there's a valid composition and point is not inside of the
4648 composition (in the case that the composition is from the current
4649 buffer), draw a glyph composed from the composition components. */
4650 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4651 && COMPOSITION_VALID_P (start
, end
, prop
)
4652 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4656 if (STRINGP (it
->string
))
4657 pos_byte
= string_char_to_byte (it
->string
, start
);
4659 pos_byte
= CHAR_TO_BYTE (start
);
4661 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4664 if (it
->cmp_it
.id
>= 0)
4667 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4668 it
->cmp_it
.nglyphs
= -1;
4672 return HANDLED_NORMALLY
;
4677 /***********************************************************************
4679 ***********************************************************************/
4681 /* The following structure is used to record overlay strings for
4682 later sorting in load_overlay_strings. */
4684 struct overlay_entry
4686 Lisp_Object overlay
;
4693 /* Set up iterator IT from overlay strings at its current position.
4694 Called from handle_stop. */
4696 static enum prop_handled
4697 handle_overlay_change (it
)
4700 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4701 return HANDLED_RECOMPUTE_PROPS
;
4703 return HANDLED_NORMALLY
;
4707 /* Set up the next overlay string for delivery by IT, if there is an
4708 overlay string to deliver. Called by set_iterator_to_next when the
4709 end of the current overlay string is reached. If there are more
4710 overlay strings to display, IT->string and
4711 IT->current.overlay_string_index are set appropriately here.
4712 Otherwise IT->string is set to nil. */
4715 next_overlay_string (it
)
4718 ++it
->current
.overlay_string_index
;
4719 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4721 /* No more overlay strings. Restore IT's settings to what
4722 they were before overlay strings were processed, and
4723 continue to deliver from current_buffer. */
4725 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4728 || (NILP (it
->string
)
4729 && it
->method
== GET_FROM_BUFFER
4730 && it
->stop_charpos
>= BEGV
4731 && it
->stop_charpos
<= it
->end_charpos
));
4732 it
->current
.overlay_string_index
= -1;
4733 it
->n_overlay_strings
= 0;
4735 /* If we're at the end of the buffer, record that we have
4736 processed the overlay strings there already, so that
4737 next_element_from_buffer doesn't try it again. */
4738 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4739 it
->overlay_strings_at_end_processed_p
= 1;
4743 /* There are more overlay strings to process. If
4744 IT->current.overlay_string_index has advanced to a position
4745 where we must load IT->overlay_strings with more strings, do
4747 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4749 if (it
->current
.overlay_string_index
&& i
== 0)
4750 load_overlay_strings (it
, 0);
4752 /* Initialize IT to deliver display elements from the overlay
4754 it
->string
= it
->overlay_strings
[i
];
4755 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4756 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4757 it
->method
= GET_FROM_STRING
;
4758 it
->stop_charpos
= 0;
4759 if (it
->cmp_it
.stop_pos
>= 0)
4760 it
->cmp_it
.stop_pos
= 0;
4767 /* Compare two overlay_entry structures E1 and E2. Used as a
4768 comparison function for qsort in load_overlay_strings. Overlay
4769 strings for the same position are sorted so that
4771 1. All after-strings come in front of before-strings, except
4772 when they come from the same overlay.
4774 2. Within after-strings, strings are sorted so that overlay strings
4775 from overlays with higher priorities come first.
4777 2. Within before-strings, strings are sorted so that overlay
4778 strings from overlays with higher priorities come last.
4780 Value is analogous to strcmp. */
4784 compare_overlay_entries (e1
, e2
)
4787 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4788 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4791 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4793 /* Let after-strings appear in front of before-strings if
4794 they come from different overlays. */
4795 if (EQ (entry1
->overlay
, entry2
->overlay
))
4796 result
= entry1
->after_string_p
? 1 : -1;
4798 result
= entry1
->after_string_p
? -1 : 1;
4800 else if (entry1
->after_string_p
)
4801 /* After-strings sorted in order of decreasing priority. */
4802 result
= entry2
->priority
- entry1
->priority
;
4804 /* Before-strings sorted in order of increasing priority. */
4805 result
= entry1
->priority
- entry2
->priority
;
4811 /* Load the vector IT->overlay_strings with overlay strings from IT's
4812 current buffer position, or from CHARPOS if that is > 0. Set
4813 IT->n_overlays to the total number of overlay strings found.
4815 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4816 a time. On entry into load_overlay_strings,
4817 IT->current.overlay_string_index gives the number of overlay
4818 strings that have already been loaded by previous calls to this
4821 IT->add_overlay_start contains an additional overlay start
4822 position to consider for taking overlay strings from, if non-zero.
4823 This position comes into play when the overlay has an `invisible'
4824 property, and both before and after-strings. When we've skipped to
4825 the end of the overlay, because of its `invisible' property, we
4826 nevertheless want its before-string to appear.
4827 IT->add_overlay_start will contain the overlay start position
4830 Overlay strings are sorted so that after-string strings come in
4831 front of before-string strings. Within before and after-strings,
4832 strings are sorted by overlay priority. See also function
4833 compare_overlay_entries. */
4836 load_overlay_strings (it
, charpos
)
4840 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4841 Lisp_Object overlay
, window
, str
, invisible
;
4842 struct Lisp_Overlay
*ov
;
4845 int n
= 0, i
, j
, invis_p
;
4846 struct overlay_entry
*entries
4847 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4850 charpos
= IT_CHARPOS (*it
);
4852 /* Append the overlay string STRING of overlay OVERLAY to vector
4853 `entries' which has size `size' and currently contains `n'
4854 elements. AFTER_P non-zero means STRING is an after-string of
4856 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4859 Lisp_Object priority; \
4863 int new_size = 2 * size; \
4864 struct overlay_entry *old = entries; \
4866 (struct overlay_entry *) alloca (new_size \
4867 * sizeof *entries); \
4868 bcopy (old, entries, size * sizeof *entries); \
4872 entries[n].string = (STRING); \
4873 entries[n].overlay = (OVERLAY); \
4874 priority = Foverlay_get ((OVERLAY), Qpriority); \
4875 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4876 entries[n].after_string_p = (AFTER_P); \
4881 /* Process overlay before the overlay center. */
4882 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4884 XSETMISC (overlay
, ov
);
4885 xassert (OVERLAYP (overlay
));
4886 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4887 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4892 /* Skip this overlay if it doesn't start or end at IT's current
4894 if (end
!= charpos
&& start
!= charpos
)
4897 /* Skip this overlay if it doesn't apply to IT->w. */
4898 window
= Foverlay_get (overlay
, Qwindow
);
4899 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4902 /* If the text ``under'' the overlay is invisible, both before-
4903 and after-strings from this overlay are visible; start and
4904 end position are indistinguishable. */
4905 invisible
= Foverlay_get (overlay
, Qinvisible
);
4906 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4908 /* If overlay has a non-empty before-string, record it. */
4909 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4910 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4912 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4914 /* If overlay has a non-empty after-string, record it. */
4915 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4916 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4918 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4921 /* Process overlays after the overlay center. */
4922 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4924 XSETMISC (overlay
, ov
);
4925 xassert (OVERLAYP (overlay
));
4926 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4927 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4929 if (start
> charpos
)
4932 /* Skip this overlay if it doesn't start or end at IT's current
4934 if (end
!= charpos
&& start
!= charpos
)
4937 /* Skip this overlay if it doesn't apply to IT->w. */
4938 window
= Foverlay_get (overlay
, Qwindow
);
4939 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4942 /* If the text ``under'' the overlay is invisible, it has a zero
4943 dimension, and both before- and after-strings apply. */
4944 invisible
= Foverlay_get (overlay
, Qinvisible
);
4945 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4947 /* If overlay has a non-empty before-string, record it. */
4948 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4949 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4951 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4953 /* If overlay has a non-empty after-string, record it. */
4954 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4955 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4957 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4960 #undef RECORD_OVERLAY_STRING
4964 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4966 /* Record the total number of strings to process. */
4967 it
->n_overlay_strings
= n
;
4969 /* IT->current.overlay_string_index is the number of overlay strings
4970 that have already been consumed by IT. Copy some of the
4971 remaining overlay strings to IT->overlay_strings. */
4973 j
= it
->current
.overlay_string_index
;
4974 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4976 it
->overlay_strings
[i
] = entries
[j
].string
;
4977 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4984 /* Get the first chunk of overlay strings at IT's current buffer
4985 position, or at CHARPOS if that is > 0. Value is non-zero if at
4986 least one overlay string was found. */
4989 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
4994 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4995 process. This fills IT->overlay_strings with strings, and sets
4996 IT->n_overlay_strings to the total number of strings to process.
4997 IT->pos.overlay_string_index has to be set temporarily to zero
4998 because load_overlay_strings needs this; it must be set to -1
4999 when no overlay strings are found because a zero value would
5000 indicate a position in the first overlay string. */
5001 it
->current
.overlay_string_index
= 0;
5002 load_overlay_strings (it
, charpos
);
5004 /* If we found overlay strings, set up IT to deliver display
5005 elements from the first one. Otherwise set up IT to deliver
5006 from current_buffer. */
5007 if (it
->n_overlay_strings
)
5009 /* Make sure we know settings in current_buffer, so that we can
5010 restore meaningful values when we're done with the overlay
5013 compute_stop_pos (it
);
5014 xassert (it
->face_id
>= 0);
5016 /* Save IT's settings. They are restored after all overlay
5017 strings have been processed. */
5018 xassert (!compute_stop_p
|| it
->sp
== 0);
5020 /* When called from handle_stop, there might be an empty display
5021 string loaded. In that case, don't bother saving it. */
5022 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5025 /* Set up IT to deliver display elements from the first overlay
5027 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5028 it
->string
= it
->overlay_strings
[0];
5029 it
->from_overlay
= Qnil
;
5030 it
->stop_charpos
= 0;
5031 xassert (STRINGP (it
->string
));
5032 it
->end_charpos
= SCHARS (it
->string
);
5033 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5034 it
->method
= GET_FROM_STRING
;
5038 it
->current
.overlay_string_index
= -1;
5043 get_overlay_strings (it
, charpos
)
5048 it
->method
= GET_FROM_BUFFER
;
5050 (void) get_overlay_strings_1 (it
, charpos
, 1);
5054 /* Value is non-zero if we found at least one overlay string. */
5055 return STRINGP (it
->string
);
5060 /***********************************************************************
5061 Saving and restoring state
5062 ***********************************************************************/
5064 /* Save current settings of IT on IT->stack. Called, for example,
5065 before setting up IT for an overlay string, to be able to restore
5066 IT's settings to what they were after the overlay string has been
5073 struct iterator_stack_entry
*p
;
5075 xassert (it
->sp
< IT_STACK_SIZE
);
5076 p
= it
->stack
+ it
->sp
;
5078 p
->stop_charpos
= it
->stop_charpos
;
5079 p
->cmp_it
= it
->cmp_it
;
5080 xassert (it
->face_id
>= 0);
5081 p
->face_id
= it
->face_id
;
5082 p
->string
= it
->string
;
5083 p
->method
= it
->method
;
5084 p
->from_overlay
= it
->from_overlay
;
5087 case GET_FROM_IMAGE
:
5088 p
->u
.image
.object
= it
->object
;
5089 p
->u
.image
.image_id
= it
->image_id
;
5090 p
->u
.image
.slice
= it
->slice
;
5092 case GET_FROM_STRETCH
:
5093 p
->u
.stretch
.object
= it
->object
;
5096 p
->position
= it
->position
;
5097 p
->current
= it
->current
;
5098 p
->end_charpos
= it
->end_charpos
;
5099 p
->string_nchars
= it
->string_nchars
;
5101 p
->multibyte_p
= it
->multibyte_p
;
5102 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5103 p
->space_width
= it
->space_width
;
5104 p
->font_height
= it
->font_height
;
5105 p
->voffset
= it
->voffset
;
5106 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5107 p
->display_ellipsis_p
= 0;
5112 /* Restore IT's settings from IT->stack. Called, for example, when no
5113 more overlay strings must be processed, and we return to delivering
5114 display elements from a buffer, or when the end of a string from a
5115 `display' property is reached and we return to delivering display
5116 elements from an overlay string, or from a buffer. */
5122 struct iterator_stack_entry
*p
;
5124 xassert (it
->sp
> 0);
5126 p
= it
->stack
+ it
->sp
;
5127 it
->stop_charpos
= p
->stop_charpos
;
5128 it
->cmp_it
= p
->cmp_it
;
5129 it
->face_id
= p
->face_id
;
5130 it
->current
= p
->current
;
5131 it
->position
= p
->position
;
5132 it
->string
= p
->string
;
5133 it
->from_overlay
= p
->from_overlay
;
5134 if (NILP (it
->string
))
5135 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5136 it
->method
= p
->method
;
5139 case GET_FROM_IMAGE
:
5140 it
->image_id
= p
->u
.image
.image_id
;
5141 it
->object
= p
->u
.image
.object
;
5142 it
->slice
= p
->u
.image
.slice
;
5144 case GET_FROM_STRETCH
:
5145 it
->object
= p
->u
.comp
.object
;
5147 case GET_FROM_BUFFER
:
5148 it
->object
= it
->w
->buffer
;
5150 case GET_FROM_STRING
:
5151 it
->object
= it
->string
;
5154 it
->end_charpos
= p
->end_charpos
;
5155 it
->string_nchars
= p
->string_nchars
;
5157 it
->multibyte_p
= p
->multibyte_p
;
5158 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5159 it
->space_width
= p
->space_width
;
5160 it
->font_height
= p
->font_height
;
5161 it
->voffset
= p
->voffset
;
5162 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5167 /***********************************************************************
5169 ***********************************************************************/
5171 /* Set IT's current position to the previous line start. */
5174 back_to_previous_line_start (it
)
5177 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5178 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5182 /* Move IT to the next line start.
5184 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5185 we skipped over part of the text (as opposed to moving the iterator
5186 continuously over the text). Otherwise, don't change the value
5189 Newlines may come from buffer text, overlay strings, or strings
5190 displayed via the `display' property. That's the reason we can't
5191 simply use find_next_newline_no_quit.
5193 Note that this function may not skip over invisible text that is so
5194 because of text properties and immediately follows a newline. If
5195 it would, function reseat_at_next_visible_line_start, when called
5196 from set_iterator_to_next, would effectively make invisible
5197 characters following a newline part of the wrong glyph row, which
5198 leads to wrong cursor motion. */
5201 forward_to_next_line_start (it
, skipped_p
)
5205 int old_selective
, newline_found_p
, n
;
5206 const int MAX_NEWLINE_DISTANCE
= 500;
5208 /* If already on a newline, just consume it to avoid unintended
5209 skipping over invisible text below. */
5210 if (it
->what
== IT_CHARACTER
5212 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5214 set_iterator_to_next (it
, 0);
5219 /* Don't handle selective display in the following. It's (a)
5220 unnecessary because it's done by the caller, and (b) leads to an
5221 infinite recursion because next_element_from_ellipsis indirectly
5222 calls this function. */
5223 old_selective
= it
->selective
;
5226 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5227 from buffer text. */
5228 for (n
= newline_found_p
= 0;
5229 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5230 n
+= STRINGP (it
->string
) ? 0 : 1)
5232 if (!get_next_display_element (it
))
5234 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5235 set_iterator_to_next (it
, 0);
5238 /* If we didn't find a newline near enough, see if we can use a
5240 if (!newline_found_p
)
5242 int start
= IT_CHARPOS (*it
);
5243 int limit
= find_next_newline_no_quit (start
, 1);
5246 xassert (!STRINGP (it
->string
));
5248 /* If there isn't any `display' property in sight, and no
5249 overlays, we can just use the position of the newline in
5251 if (it
->stop_charpos
>= limit
5252 || ((pos
= Fnext_single_property_change (make_number (start
),
5254 Qnil
, make_number (limit
)),
5256 && next_overlay_change (start
) == ZV
))
5258 IT_CHARPOS (*it
) = limit
;
5259 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5260 *skipped_p
= newline_found_p
= 1;
5264 while (get_next_display_element (it
)
5265 && !newline_found_p
)
5267 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5268 set_iterator_to_next (it
, 0);
5273 it
->selective
= old_selective
;
5274 return newline_found_p
;
5278 /* Set IT's current position to the previous visible line start. Skip
5279 invisible text that is so either due to text properties or due to
5280 selective display. Caution: this does not change IT->current_x and
5284 back_to_previous_visible_line_start (it
)
5287 while (IT_CHARPOS (*it
) > BEGV
)
5289 back_to_previous_line_start (it
);
5291 if (IT_CHARPOS (*it
) <= BEGV
)
5294 /* If selective > 0, then lines indented more than that values
5296 if (it
->selective
> 0
5297 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5298 (double) it
->selective
)) /* iftc */
5301 /* Check the newline before point for invisibility. */
5304 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5305 Qinvisible
, it
->window
);
5306 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5310 if (IT_CHARPOS (*it
) <= BEGV
)
5317 Lisp_Object val
, overlay
;
5319 /* If newline is part of a composition, continue from start of composition */
5320 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5321 && beg
< IT_CHARPOS (*it
))
5324 /* If newline is replaced by a display property, find start of overlay
5325 or interval and continue search from that point. */
5327 pos
= --IT_CHARPOS (it2
);
5330 it2
.string_from_display_prop_p
= 0;
5331 if (handle_display_prop (&it2
) == HANDLED_RETURN
5332 && !NILP (val
= get_char_property_and_overlay
5333 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5334 && (OVERLAYP (overlay
)
5335 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5336 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5339 /* Newline is not replaced by anything -- so we are done. */
5345 IT_CHARPOS (*it
) = beg
;
5346 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5350 it
->continuation_lines_width
= 0;
5352 xassert (IT_CHARPOS (*it
) >= BEGV
);
5353 xassert (IT_CHARPOS (*it
) == BEGV
5354 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5359 /* Reseat iterator IT at the previous visible line start. Skip
5360 invisible text that is so either due to text properties or due to
5361 selective display. At the end, update IT's overlay information,
5362 face information etc. */
5365 reseat_at_previous_visible_line_start (it
)
5368 back_to_previous_visible_line_start (it
);
5369 reseat (it
, it
->current
.pos
, 1);
5374 /* Reseat iterator IT on the next visible line start in the current
5375 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5376 preceding the line start. Skip over invisible text that is so
5377 because of selective display. Compute faces, overlays etc at the
5378 new position. Note that this function does not skip over text that
5379 is invisible because of text properties. */
5382 reseat_at_next_visible_line_start (it
, on_newline_p
)
5386 int newline_found_p
, skipped_p
= 0;
5388 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5390 /* Skip over lines that are invisible because they are indented
5391 more than the value of IT->selective. */
5392 if (it
->selective
> 0)
5393 while (IT_CHARPOS (*it
) < ZV
5394 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5395 (double) it
->selective
)) /* iftc */
5397 xassert (IT_BYTEPOS (*it
) == BEGV
5398 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5399 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5402 /* Position on the newline if that's what's requested. */
5403 if (on_newline_p
&& newline_found_p
)
5405 if (STRINGP (it
->string
))
5407 if (IT_STRING_CHARPOS (*it
) > 0)
5409 --IT_STRING_CHARPOS (*it
);
5410 --IT_STRING_BYTEPOS (*it
);
5413 else if (IT_CHARPOS (*it
) > BEGV
)
5417 reseat (it
, it
->current
.pos
, 0);
5421 reseat (it
, it
->current
.pos
, 0);
5428 /***********************************************************************
5429 Changing an iterator's position
5430 ***********************************************************************/
5432 /* Change IT's current position to POS in current_buffer. If FORCE_P
5433 is non-zero, always check for text properties at the new position.
5434 Otherwise, text properties are only looked up if POS >=
5435 IT->check_charpos of a property. */
5438 reseat (it
, pos
, force_p
)
5440 struct text_pos pos
;
5443 int original_pos
= IT_CHARPOS (*it
);
5445 reseat_1 (it
, pos
, 0);
5447 /* Determine where to check text properties. Avoid doing it
5448 where possible because text property lookup is very expensive. */
5450 || CHARPOS (pos
) > it
->stop_charpos
5451 || CHARPOS (pos
) < original_pos
)
5458 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5459 IT->stop_pos to POS, also. */
5462 reseat_1 (it
, pos
, set_stop_p
)
5464 struct text_pos pos
;
5467 /* Don't call this function when scanning a C string. */
5468 xassert (it
->s
== NULL
);
5470 /* POS must be a reasonable value. */
5471 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5473 it
->current
.pos
= it
->position
= pos
;
5474 it
->end_charpos
= ZV
;
5476 it
->current
.dpvec_index
= -1;
5477 it
->current
.overlay_string_index
= -1;
5478 IT_STRING_CHARPOS (*it
) = -1;
5479 IT_STRING_BYTEPOS (*it
) = -1;
5481 it
->string_from_display_prop_p
= 0;
5482 it
->method
= GET_FROM_BUFFER
;
5483 it
->object
= it
->w
->buffer
;
5484 it
->area
= TEXT_AREA
;
5485 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5487 it
->string_from_display_prop_p
= 0;
5488 it
->face_before_selective_p
= 0;
5491 it
->stop_charpos
= CHARPOS (pos
);
5495 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5496 If S is non-null, it is a C string to iterate over. Otherwise,
5497 STRING gives a Lisp string to iterate over.
5499 If PRECISION > 0, don't return more then PRECISION number of
5500 characters from the string.
5502 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5503 characters have been returned. FIELD_WIDTH < 0 means an infinite
5506 MULTIBYTE = 0 means disable processing of multibyte characters,
5507 MULTIBYTE > 0 means enable it,
5508 MULTIBYTE < 0 means use IT->multibyte_p.
5510 IT must be initialized via a prior call to init_iterator before
5511 calling this function. */
5514 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5519 int precision
, field_width
, multibyte
;
5521 /* No region in strings. */
5522 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5524 /* No text property checks performed by default, but see below. */
5525 it
->stop_charpos
= -1;
5527 /* Set iterator position and end position. */
5528 bzero (&it
->current
, sizeof it
->current
);
5529 it
->current
.overlay_string_index
= -1;
5530 it
->current
.dpvec_index
= -1;
5531 xassert (charpos
>= 0);
5533 /* If STRING is specified, use its multibyteness, otherwise use the
5534 setting of MULTIBYTE, if specified. */
5536 it
->multibyte_p
= multibyte
> 0;
5540 xassert (STRINGP (string
));
5541 it
->string
= string
;
5543 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5544 it
->method
= GET_FROM_STRING
;
5545 it
->current
.string_pos
= string_pos (charpos
, string
);
5552 /* Note that we use IT->current.pos, not it->current.string_pos,
5553 for displaying C strings. */
5554 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5555 if (it
->multibyte_p
)
5557 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5558 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5562 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5563 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5566 it
->method
= GET_FROM_C_STRING
;
5569 /* PRECISION > 0 means don't return more than PRECISION characters
5571 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5572 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5574 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5575 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5576 FIELD_WIDTH < 0 means infinite field width. This is useful for
5577 padding with `-' at the end of a mode line. */
5578 if (field_width
< 0)
5579 field_width
= INFINITY
;
5580 if (field_width
> it
->end_charpos
- charpos
)
5581 it
->end_charpos
= charpos
+ field_width
;
5583 /* Use the standard display table for displaying strings. */
5584 if (DISP_TABLE_P (Vstandard_display_table
))
5585 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5587 it
->stop_charpos
= charpos
;
5593 /***********************************************************************
5595 ***********************************************************************/
5597 /* Map enum it_method value to corresponding next_element_from_* function. */
5599 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5601 next_element_from_buffer
,
5602 next_element_from_display_vector
,
5603 next_element_from_string
,
5604 next_element_from_c_string
,
5605 next_element_from_image
,
5606 next_element_from_stretch
5609 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5612 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5613 (possibly with the following characters). */
5615 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS) \
5616 ((IT)->cmp_it.id >= 0 \
5617 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5618 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5619 (IT)->end_charpos, (IT)->w, \
5620 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5624 /* Load IT's display element fields with information about the next
5625 display element from the current position of IT. Value is zero if
5626 end of buffer (or C string) is reached. */
5628 static struct frame
*last_escape_glyph_frame
= NULL
;
5629 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5630 static int last_escape_glyph_merged_face_id
= 0;
5633 get_next_display_element (it
)
5636 /* Non-zero means that we found a display element. Zero means that
5637 we hit the end of what we iterate over. Performance note: the
5638 function pointer `method' used here turns out to be faster than
5639 using a sequence of if-statements. */
5643 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5645 if (it
->what
== IT_CHARACTER
)
5647 /* Map via display table or translate control characters.
5648 IT->c, IT->len etc. have been set to the next character by
5649 the function call above. If we have a display table, and it
5650 contains an entry for IT->c, translate it. Don't do this if
5651 IT->c itself comes from a display table, otherwise we could
5652 end up in an infinite recursion. (An alternative could be to
5653 count the recursion depth of this function and signal an
5654 error when a certain maximum depth is reached.) Is it worth
5656 if (success_p
&& it
->dpvec
== NULL
)
5661 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5664 struct Lisp_Vector
*v
= XVECTOR (dv
);
5666 /* Return the first character from the display table
5667 entry, if not empty. If empty, don't display the
5668 current character. */
5671 it
->dpvec_char_len
= it
->len
;
5672 it
->dpvec
= v
->contents
;
5673 it
->dpend
= v
->contents
+ v
->size
;
5674 it
->current
.dpvec_index
= 0;
5675 it
->dpvec_face_id
= -1;
5676 it
->saved_face_id
= it
->face_id
;
5677 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5682 set_iterator_to_next (it
, 0);
5687 /* Translate control characters into `\003' or `^C' form.
5688 Control characters coming from a display table entry are
5689 currently not translated because we use IT->dpvec to hold
5690 the translation. This could easily be changed but I
5691 don't believe that it is worth doing.
5693 If it->multibyte_p is nonzero, non-printable non-ASCII
5694 characters are also translated to octal form.
5696 If it->multibyte_p is zero, eight-bit characters that
5697 don't have corresponding multibyte char code are also
5698 translated to octal form. */
5699 else if ((it
->c
< ' '
5700 ? (it
->area
!= TEXT_AREA
5701 /* In mode line, treat \n, \t like other crl chars. */
5703 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5704 || (it
->c
!= '\n' && it
->c
!= '\t'))
5706 ? (!CHAR_PRINTABLE_P (it
->c
)
5707 || (!NILP (Vnobreak_char_display
)
5708 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5709 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5711 && (! unibyte_display_via_language_environment
5712 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5714 /* IT->c is a control character which must be displayed
5715 either as '\003' or as `^C' where the '\\' and '^'
5716 can be defined in the display table. Fill
5717 IT->ctl_chars with glyphs for what we have to
5718 display. Then, set IT->dpvec to these glyphs. */
5721 int face_id
, lface_id
= 0 ;
5724 /* Handle control characters with ^. */
5726 if (it
->c
< 128 && it
->ctl_arrow_p
)
5730 g
= '^'; /* default glyph for Control */
5731 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5733 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5734 && GLYPH_CODE_CHAR_VALID_P (gc
))
5736 g
= GLYPH_CODE_CHAR (gc
);
5737 lface_id
= GLYPH_CODE_FACE (gc
);
5741 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5743 else if (it
->f
== last_escape_glyph_frame
5744 && it
->face_id
== last_escape_glyph_face_id
)
5746 face_id
= last_escape_glyph_merged_face_id
;
5750 /* Merge the escape-glyph face into the current face. */
5751 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5753 last_escape_glyph_frame
= it
->f
;
5754 last_escape_glyph_face_id
= it
->face_id
;
5755 last_escape_glyph_merged_face_id
= face_id
;
5758 XSETINT (it
->ctl_chars
[0], g
);
5759 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5761 goto display_control
;
5764 /* Handle non-break space in the mode where it only gets
5767 if (EQ (Vnobreak_char_display
, Qt
)
5770 /* Merge the no-break-space face into the current face. */
5771 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5775 XSETINT (it
->ctl_chars
[0], ' ');
5777 goto display_control
;
5780 /* Handle sequences that start with the "escape glyph". */
5782 /* the default escape glyph is \. */
5783 escape_glyph
= '\\';
5786 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5787 && GLYPH_CODE_CHAR_VALID_P (gc
))
5789 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5790 lface_id
= GLYPH_CODE_FACE (gc
);
5794 /* The display table specified a face.
5795 Merge it into face_id and also into escape_glyph. */
5796 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5799 else if (it
->f
== last_escape_glyph_frame
5800 && it
->face_id
== last_escape_glyph_face_id
)
5802 face_id
= last_escape_glyph_merged_face_id
;
5806 /* Merge the escape-glyph face into the current face. */
5807 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5809 last_escape_glyph_frame
= it
->f
;
5810 last_escape_glyph_face_id
= it
->face_id
;
5811 last_escape_glyph_merged_face_id
= face_id
;
5814 /* Handle soft hyphens in the mode where they only get
5817 if (EQ (Vnobreak_char_display
, Qt
)
5821 XSETINT (it
->ctl_chars
[0], '-');
5823 goto display_control
;
5826 /* Handle non-break space and soft hyphen
5827 with the escape glyph. */
5829 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5831 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5832 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5833 XSETINT (it
->ctl_chars
[1], it
->c
);
5835 goto display_control
;
5839 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5843 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5844 if (CHAR_BYTE8_P (it
->c
))
5846 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5849 else if (it
->c
< 256)
5856 /* It's an invalid character, which shouldn't
5857 happen actually, but due to bugs it may
5858 happen. Let's print the char as is, there's
5859 not much meaningful we can do with it. */
5861 str
[1] = it
->c
>> 8;
5862 str
[2] = it
->c
>> 16;
5863 str
[3] = it
->c
>> 24;
5867 for (i
= 0; i
< len
; i
++)
5870 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5871 /* Insert three more glyphs into IT->ctl_chars for
5872 the octal display of the character. */
5873 g
= ((str
[i
] >> 6) & 7) + '0';
5874 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5875 g
= ((str
[i
] >> 3) & 7) + '0';
5876 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5877 g
= (str
[i
] & 7) + '0';
5878 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5884 /* Set up IT->dpvec and return first character from it. */
5885 it
->dpvec_char_len
= it
->len
;
5886 it
->dpvec
= it
->ctl_chars
;
5887 it
->dpend
= it
->dpvec
+ ctl_len
;
5888 it
->current
.dpvec_index
= 0;
5889 it
->dpvec_face_id
= face_id
;
5890 it
->saved_face_id
= it
->face_id
;
5891 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5898 #ifdef HAVE_WINDOW_SYSTEM
5899 /* Adjust face id for a multibyte character. There are no multibyte
5900 character in unibyte text. */
5901 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5904 && FRAME_WINDOW_P (it
->f
))
5906 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5908 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5910 /* Automatic composition with glyph-string. */
5911 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5913 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5917 int pos
= (it
->s
? -1
5918 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5919 : IT_CHARPOS (*it
));
5921 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
5926 /* Is this character the last one of a run of characters with
5927 box? If yes, set IT->end_of_box_run_p to 1. */
5931 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5933 int face_id
= underlying_face_id (it
);
5934 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5938 if (face
->box
== FACE_NO_BOX
)
5940 /* If the box comes from face properties in a
5941 display string, check faces in that string. */
5942 int string_face_id
= face_after_it_pos (it
);
5943 it
->end_of_box_run_p
5944 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5947 /* Otherwise, the box comes from the underlying face.
5948 If this is the last string character displayed, check
5949 the next buffer location. */
5950 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5951 && (it
->current
.overlay_string_index
5952 == it
->n_overlay_strings
- 1))
5956 struct text_pos pos
= it
->current
.pos
;
5957 INC_TEXT_POS (pos
, it
->multibyte_p
);
5959 next_face_id
= face_at_buffer_position
5960 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5961 it
->region_end_charpos
, &ignore
,
5962 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0);
5963 it
->end_of_box_run_p
5964 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5971 int face_id
= face_after_it_pos (it
);
5972 it
->end_of_box_run_p
5973 = (face_id
!= it
->face_id
5974 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5978 /* Value is 0 if end of buffer or string reached. */
5983 /* Move IT to the next display element.
5985 RESEAT_P non-zero means if called on a newline in buffer text,
5986 skip to the next visible line start.
5988 Functions get_next_display_element and set_iterator_to_next are
5989 separate because I find this arrangement easier to handle than a
5990 get_next_display_element function that also increments IT's
5991 position. The way it is we can first look at an iterator's current
5992 display element, decide whether it fits on a line, and if it does,
5993 increment the iterator position. The other way around we probably
5994 would either need a flag indicating whether the iterator has to be
5995 incremented the next time, or we would have to implement a
5996 decrement position function which would not be easy to write. */
5999 set_iterator_to_next (it
, reseat_p
)
6003 /* Reset flags indicating start and end of a sequence of characters
6004 with box. Reset them at the start of this function because
6005 moving the iterator to a new position might set them. */
6006 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6010 case GET_FROM_BUFFER
:
6011 /* The current display element of IT is a character from
6012 current_buffer. Advance in the buffer, and maybe skip over
6013 invisible lines that are so because of selective display. */
6014 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6015 reseat_at_next_visible_line_start (it
, 0);
6016 else if (it
->cmp_it
.id
>= 0)
6018 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6019 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6020 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6021 it
->cmp_it
.from
= it
->cmp_it
.to
;
6025 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6026 IT_BYTEPOS (*it
), it
->stop_charpos
,
6032 xassert (it
->len
!= 0);
6033 IT_BYTEPOS (*it
) += it
->len
;
6034 IT_CHARPOS (*it
) += 1;
6035 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6039 case GET_FROM_C_STRING
:
6040 /* Current display element of IT is from a C string. */
6041 IT_BYTEPOS (*it
) += it
->len
;
6042 IT_CHARPOS (*it
) += 1;
6045 case GET_FROM_DISPLAY_VECTOR
:
6046 /* Current display element of IT is from a display table entry.
6047 Advance in the display table definition. Reset it to null if
6048 end reached, and continue with characters from buffers/
6050 ++it
->current
.dpvec_index
;
6052 /* Restore face of the iterator to what they were before the
6053 display vector entry (these entries may contain faces). */
6054 it
->face_id
= it
->saved_face_id
;
6056 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6058 int recheck_faces
= it
->ellipsis_p
;
6061 it
->method
= GET_FROM_C_STRING
;
6062 else if (STRINGP (it
->string
))
6063 it
->method
= GET_FROM_STRING
;
6066 it
->method
= GET_FROM_BUFFER
;
6067 it
->object
= it
->w
->buffer
;
6071 it
->current
.dpvec_index
= -1;
6073 /* Skip over characters which were displayed via IT->dpvec. */
6074 if (it
->dpvec_char_len
< 0)
6075 reseat_at_next_visible_line_start (it
, 1);
6076 else if (it
->dpvec_char_len
> 0)
6078 if (it
->method
== GET_FROM_STRING
6079 && it
->n_overlay_strings
> 0)
6080 it
->ignore_overlay_strings_at_pos_p
= 1;
6081 it
->len
= it
->dpvec_char_len
;
6082 set_iterator_to_next (it
, reseat_p
);
6085 /* Maybe recheck faces after display vector */
6087 it
->stop_charpos
= IT_CHARPOS (*it
);
6091 case GET_FROM_STRING
:
6092 /* Current display element is a character from a Lisp string. */
6093 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6094 if (it
->cmp_it
.id
>= 0)
6096 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6097 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6098 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6099 it
->cmp_it
.from
= it
->cmp_it
.to
;
6103 composition_compute_stop_pos (&it
->cmp_it
,
6104 IT_STRING_CHARPOS (*it
),
6105 IT_STRING_BYTEPOS (*it
),
6106 it
->stop_charpos
, it
->string
);
6111 IT_STRING_BYTEPOS (*it
) += it
->len
;
6112 IT_STRING_CHARPOS (*it
) += 1;
6115 consider_string_end
:
6117 if (it
->current
.overlay_string_index
>= 0)
6119 /* IT->string is an overlay string. Advance to the
6120 next, if there is one. */
6121 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6124 next_overlay_string (it
);
6126 setup_for_ellipsis (it
, 0);
6131 /* IT->string is not an overlay string. If we reached
6132 its end, and there is something on IT->stack, proceed
6133 with what is on the stack. This can be either another
6134 string, this time an overlay string, or a buffer. */
6135 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6139 if (it
->method
== GET_FROM_STRING
)
6140 goto consider_string_end
;
6145 case GET_FROM_IMAGE
:
6146 case GET_FROM_STRETCH
:
6147 /* The position etc with which we have to proceed are on
6148 the stack. The position may be at the end of a string,
6149 if the `display' property takes up the whole string. */
6150 xassert (it
->sp
> 0);
6152 if (it
->method
== GET_FROM_STRING
)
6153 goto consider_string_end
;
6157 /* There are no other methods defined, so this should be a bug. */
6161 xassert (it
->method
!= GET_FROM_STRING
6162 || (STRINGP (it
->string
)
6163 && IT_STRING_CHARPOS (*it
) >= 0));
6166 /* Load IT's display element fields with information about the next
6167 display element which comes from a display table entry or from the
6168 result of translating a control character to one of the forms `^C'
6171 IT->dpvec holds the glyphs to return as characters.
6172 IT->saved_face_id holds the face id before the display vector--
6173 it is restored into IT->face_idin set_iterator_to_next. */
6176 next_element_from_display_vector (it
)
6182 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6184 it
->face_id
= it
->saved_face_id
;
6186 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6187 That seemed totally bogus - so I changed it... */
6188 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6190 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6192 it
->c
= GLYPH_CODE_CHAR (gc
);
6193 it
->len
= CHAR_BYTES (it
->c
);
6195 /* The entry may contain a face id to use. Such a face id is
6196 the id of a Lisp face, not a realized face. A face id of
6197 zero means no face is specified. */
6198 if (it
->dpvec_face_id
>= 0)
6199 it
->face_id
= it
->dpvec_face_id
;
6202 int lface_id
= GLYPH_CODE_FACE (gc
);
6204 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6209 /* Display table entry is invalid. Return a space. */
6210 it
->c
= ' ', it
->len
= 1;
6212 /* Don't change position and object of the iterator here. They are
6213 still the values of the character that had this display table
6214 entry or was translated, and that's what we want. */
6215 it
->what
= IT_CHARACTER
;
6220 /* Load IT with the next display element from Lisp string IT->string.
6221 IT->current.string_pos is the current position within the string.
6222 If IT->current.overlay_string_index >= 0, the Lisp string is an
6226 next_element_from_string (it
)
6229 struct text_pos position
;
6231 xassert (STRINGP (it
->string
));
6232 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6233 position
= it
->current
.string_pos
;
6235 /* Time to check for invisible text? */
6236 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6237 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6241 /* Since a handler may have changed IT->method, we must
6243 return GET_NEXT_DISPLAY_ELEMENT (it
);
6246 if (it
->current
.overlay_string_index
>= 0)
6248 /* Get the next character from an overlay string. In overlay
6249 strings, There is no field width or padding with spaces to
6251 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6256 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6257 IT_STRING_BYTEPOS (*it
))
6258 && next_element_from_composition (it
))
6262 else if (STRING_MULTIBYTE (it
->string
))
6264 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6265 const unsigned char *s
= (SDATA (it
->string
)
6266 + IT_STRING_BYTEPOS (*it
));
6267 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6271 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6277 /* Get the next character from a Lisp string that is not an
6278 overlay string. Such strings come from the mode line, for
6279 example. We may have to pad with spaces, or truncate the
6280 string. See also next_element_from_c_string. */
6281 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6286 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6288 /* Pad with spaces. */
6289 it
->c
= ' ', it
->len
= 1;
6290 CHARPOS (position
) = BYTEPOS (position
) = -1;
6292 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6293 IT_STRING_BYTEPOS (*it
))
6294 && next_element_from_composition (it
))
6298 else if (STRING_MULTIBYTE (it
->string
))
6300 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6301 const unsigned char *s
= (SDATA (it
->string
)
6302 + IT_STRING_BYTEPOS (*it
));
6303 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6307 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6312 /* Record what we have and where it came from. */
6313 it
->what
= IT_CHARACTER
;
6314 it
->object
= it
->string
;
6315 it
->position
= position
;
6320 /* Load IT with next display element from C string IT->s.
6321 IT->string_nchars is the maximum number of characters to return
6322 from the string. IT->end_charpos may be greater than
6323 IT->string_nchars when this function is called, in which case we
6324 may have to return padding spaces. Value is zero if end of string
6325 reached, including padding spaces. */
6328 next_element_from_c_string (it
)
6334 it
->what
= IT_CHARACTER
;
6335 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6338 /* IT's position can be greater IT->string_nchars in case a field
6339 width or precision has been specified when the iterator was
6341 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6343 /* End of the game. */
6347 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6349 /* Pad with spaces. */
6350 it
->c
= ' ', it
->len
= 1;
6351 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6353 else if (it
->multibyte_p
)
6355 /* Implementation note: The calls to strlen apparently aren't a
6356 performance problem because there is no noticeable performance
6357 difference between Emacs running in unibyte or multibyte mode. */
6358 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6359 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6363 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6369 /* Set up IT to return characters from an ellipsis, if appropriate.
6370 The definition of the ellipsis glyphs may come from a display table
6371 entry. This function Fills IT with the first glyph from the
6372 ellipsis if an ellipsis is to be displayed. */
6375 next_element_from_ellipsis (it
)
6378 if (it
->selective_display_ellipsis_p
)
6379 setup_for_ellipsis (it
, it
->len
);
6382 /* The face at the current position may be different from the
6383 face we find after the invisible text. Remember what it
6384 was in IT->saved_face_id, and signal that it's there by
6385 setting face_before_selective_p. */
6386 it
->saved_face_id
= it
->face_id
;
6387 it
->method
= GET_FROM_BUFFER
;
6388 it
->object
= it
->w
->buffer
;
6389 reseat_at_next_visible_line_start (it
, 1);
6390 it
->face_before_selective_p
= 1;
6393 return GET_NEXT_DISPLAY_ELEMENT (it
);
6397 /* Deliver an image display element. The iterator IT is already
6398 filled with image information (done in handle_display_prop). Value
6403 next_element_from_image (it
)
6406 it
->what
= IT_IMAGE
;
6411 /* Fill iterator IT with next display element from a stretch glyph
6412 property. IT->object is the value of the text property. Value is
6416 next_element_from_stretch (it
)
6419 it
->what
= IT_STRETCH
;
6424 /* Load IT with the next display element from current_buffer. Value
6425 is zero if end of buffer reached. IT->stop_charpos is the next
6426 position at which to stop and check for text properties or buffer
6430 next_element_from_buffer (it
)
6435 xassert (IT_CHARPOS (*it
) >= BEGV
);
6437 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6439 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6441 int overlay_strings_follow_p
;
6443 /* End of the game, except when overlay strings follow that
6444 haven't been returned yet. */
6445 if (it
->overlay_strings_at_end_processed_p
)
6446 overlay_strings_follow_p
= 0;
6449 it
->overlay_strings_at_end_processed_p
= 1;
6450 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6453 if (overlay_strings_follow_p
)
6454 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6458 it
->position
= it
->current
.pos
;
6465 return GET_NEXT_DISPLAY_ELEMENT (it
);
6470 /* No face changes, overlays etc. in sight, so just return a
6471 character from current_buffer. */
6474 /* Maybe run the redisplay end trigger hook. Performance note:
6475 This doesn't seem to cost measurable time. */
6476 if (it
->redisplay_end_trigger_charpos
6478 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6479 run_redisplay_end_trigger_hook (it
);
6481 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
))
6482 && next_element_from_composition (it
))
6487 /* Get the next character, maybe multibyte. */
6488 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6489 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6490 it
->c
= STRING_CHAR_AND_LENGTH (p
, 0, it
->len
);
6492 it
->c
= *p
, it
->len
= 1;
6494 /* Record what we have and where it came from. */
6495 it
->what
= IT_CHARACTER
;
6496 it
->object
= it
->w
->buffer
;
6497 it
->position
= it
->current
.pos
;
6499 /* Normally we return the character found above, except when we
6500 really want to return an ellipsis for selective display. */
6505 /* A value of selective > 0 means hide lines indented more
6506 than that number of columns. */
6507 if (it
->selective
> 0
6508 && IT_CHARPOS (*it
) + 1 < ZV
6509 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6510 IT_BYTEPOS (*it
) + 1,
6511 (double) it
->selective
)) /* iftc */
6513 success_p
= next_element_from_ellipsis (it
);
6514 it
->dpvec_char_len
= -1;
6517 else if (it
->c
== '\r' && it
->selective
== -1)
6519 /* A value of selective == -1 means that everything from the
6520 CR to the end of the line is invisible, with maybe an
6521 ellipsis displayed for it. */
6522 success_p
= next_element_from_ellipsis (it
);
6523 it
->dpvec_char_len
= -1;
6528 /* Value is zero if end of buffer reached. */
6529 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6534 /* Run the redisplay end trigger hook for IT. */
6537 run_redisplay_end_trigger_hook (it
)
6540 Lisp_Object args
[3];
6542 /* IT->glyph_row should be non-null, i.e. we should be actually
6543 displaying something, or otherwise we should not run the hook. */
6544 xassert (it
->glyph_row
);
6546 /* Set up hook arguments. */
6547 args
[0] = Qredisplay_end_trigger_functions
;
6548 args
[1] = it
->window
;
6549 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6550 it
->redisplay_end_trigger_charpos
= 0;
6552 /* Since we are *trying* to run these functions, don't try to run
6553 them again, even if they get an error. */
6554 it
->w
->redisplay_end_trigger
= Qnil
;
6555 Frun_hook_with_args (3, args
);
6557 /* Notice if it changed the face of the character we are on. */
6558 handle_face_prop (it
);
6562 /* Deliver a composition display element. Unlike the other
6563 next_element_from_XXX, this function is not registered in the array
6564 get_next_element[]. It is called from next_element_from_buffer and
6565 next_element_from_string when necessary. */
6568 next_element_from_composition (it
)
6571 it
->what
= IT_COMPOSITION
;
6572 it
->len
= it
->cmp_it
.nbytes
;
6573 if (STRINGP (it
->string
))
6577 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6578 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6581 it
->position
= it
->current
.string_pos
;
6582 it
->object
= it
->string
;
6583 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6584 IT_STRING_BYTEPOS (*it
), it
->string
);
6590 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6591 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6594 it
->position
= it
->current
.pos
;
6595 it
->object
= it
->w
->buffer
;
6596 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6597 IT_BYTEPOS (*it
), Qnil
);
6604 /***********************************************************************
6605 Moving an iterator without producing glyphs
6606 ***********************************************************************/
6608 /* Check if iterator is at a position corresponding to a valid buffer
6609 position after some move_it_ call. */
6611 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6612 ((it)->method == GET_FROM_STRING \
6613 ? IT_STRING_CHARPOS (*it) == 0 \
6617 /* Move iterator IT to a specified buffer or X position within one
6618 line on the display without producing glyphs.
6620 OP should be a bit mask including some or all of these bits:
6621 MOVE_TO_X: Stop on reaching x-position TO_X.
6622 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6623 Regardless of OP's value, stop in reaching the end of the display line.
6625 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6626 This means, in particular, that TO_X includes window's horizontal
6629 The return value has several possible values that
6630 say what condition caused the scan to stop:
6632 MOVE_POS_MATCH_OR_ZV
6633 - when TO_POS or ZV was reached.
6636 -when TO_X was reached before TO_POS or ZV were reached.
6639 - when we reached the end of the display area and the line must
6643 - when we reached the end of the display area and the line is
6647 - when we stopped at a line end, i.e. a newline or a CR and selective
6650 static enum move_it_result
6651 move_it_in_display_line_to (struct it
*it
,
6652 EMACS_INT to_charpos
, int to_x
,
6653 enum move_operation_enum op
)
6655 enum move_it_result result
= MOVE_UNDEFINED
;
6656 struct glyph_row
*saved_glyph_row
;
6657 struct it wrap_it
, atpos_it
, atx_it
;
6660 /* Don't produce glyphs in produce_glyphs. */
6661 saved_glyph_row
= it
->glyph_row
;
6662 it
->glyph_row
= NULL
;
6664 /* Use wrap_it to save a copy of IT wherever a word wrap could
6665 occur. Use atpos_it to save a copy of IT at the desired buffer
6666 position, if found, so that we can scan ahead and check if the
6667 word later overshoots the window edge. Use atx_it similarly, for
6673 #define BUFFER_POS_REACHED_P() \
6674 ((op & MOVE_TO_POS) != 0 \
6675 && BUFFERP (it->object) \
6676 && IT_CHARPOS (*it) >= to_charpos \
6677 && (it->method == GET_FROM_BUFFER \
6678 || (it->method == GET_FROM_DISPLAY_VECTOR \
6679 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6681 /* If there's a line-/wrap-prefix, handle it. */
6682 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6683 && it
->current_y
< it
->last_visible_y
)
6684 handle_line_prefix (it
);
6688 int x
, i
, ascent
= 0, descent
= 0;
6690 /* Utility macro to reset an iterator with x, ascent, and descent. */
6691 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6692 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6693 (IT)->max_descent = descent)
6695 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6697 if ((op
& MOVE_TO_POS
) != 0
6698 && BUFFERP (it
->object
)
6699 && it
->method
== GET_FROM_BUFFER
6700 && IT_CHARPOS (*it
) > to_charpos
)
6702 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6704 result
= MOVE_POS_MATCH_OR_ZV
;
6707 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6708 /* If wrap_it is valid, the current position might be in a
6709 word that is wrapped. So, save the iterator in
6710 atpos_it and continue to see if wrapping happens. */
6714 /* Stop when ZV reached.
6715 We used to stop here when TO_CHARPOS reached as well, but that is
6716 too soon if this glyph does not fit on this line. So we handle it
6717 explicitly below. */
6718 if (!get_next_display_element (it
))
6720 result
= MOVE_POS_MATCH_OR_ZV
;
6724 if (it
->line_wrap
== TRUNCATE
)
6726 if (BUFFER_POS_REACHED_P ())
6728 result
= MOVE_POS_MATCH_OR_ZV
;
6734 if (it
->line_wrap
== WORD_WRAP
)
6736 if (IT_DISPLAYING_WHITESPACE (it
))
6740 /* We have reached a glyph that follows one or more
6741 whitespace characters. If the position is
6742 already found, we are done. */
6743 if (atpos_it
.sp
>= 0)
6746 result
= MOVE_POS_MATCH_OR_ZV
;
6752 result
= MOVE_X_REACHED
;
6755 /* Otherwise, we can wrap here. */
6762 /* Remember the line height for the current line, in case
6763 the next element doesn't fit on the line. */
6764 ascent
= it
->max_ascent
;
6765 descent
= it
->max_descent
;
6767 /* The call to produce_glyphs will get the metrics of the
6768 display element IT is loaded with. Record the x-position
6769 before this display element, in case it doesn't fit on the
6773 PRODUCE_GLYPHS (it
);
6775 if (it
->area
!= TEXT_AREA
)
6777 set_iterator_to_next (it
, 1);
6781 /* The number of glyphs we get back in IT->nglyphs will normally
6782 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6783 character on a terminal frame, or (iii) a line end. For the
6784 second case, IT->nglyphs - 1 padding glyphs will be present
6785 (on X frames, there is only one glyph produced for a
6786 composite character.
6788 The behavior implemented below means, for continuation lines,
6789 that as many spaces of a TAB as fit on the current line are
6790 displayed there. For terminal frames, as many glyphs of a
6791 multi-glyph character are displayed in the current line, too.
6792 This is what the old redisplay code did, and we keep it that
6793 way. Under X, the whole shape of a complex character must
6794 fit on the line or it will be completely displayed in the
6797 Note that both for tabs and padding glyphs, all glyphs have
6801 /* More than one glyph or glyph doesn't fit on line. All
6802 glyphs have the same width. */
6803 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6805 int x_before_this_char
= x
;
6806 int hpos_before_this_char
= it
->hpos
;
6808 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6810 new_x
= x
+ single_glyph_width
;
6812 /* We want to leave anything reaching TO_X to the caller. */
6813 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6815 if (BUFFER_POS_REACHED_P ())
6817 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6818 goto buffer_pos_reached
;
6819 if (atpos_it
.sp
< 0)
6822 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6827 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6830 result
= MOVE_X_REACHED
;
6836 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
6841 if (/* Lines are continued. */
6842 it
->line_wrap
!= TRUNCATE
6843 && (/* And glyph doesn't fit on the line. */
6844 new_x
> it
->last_visible_x
6845 /* Or it fits exactly and we're on a window
6847 || (new_x
== it
->last_visible_x
6848 && FRAME_WINDOW_P (it
->f
))))
6850 if (/* IT->hpos == 0 means the very first glyph
6851 doesn't fit on the line, e.g. a wide image. */
6853 || (new_x
== it
->last_visible_x
6854 && FRAME_WINDOW_P (it
->f
)))
6857 it
->current_x
= new_x
;
6859 /* The character's last glyph just barely fits
6861 if (i
== it
->nglyphs
- 1)
6863 /* If this is the destination position,
6864 return a position *before* it in this row,
6865 now that we know it fits in this row. */
6866 if (BUFFER_POS_REACHED_P ())
6868 if (it
->line_wrap
!= WORD_WRAP
6871 it
->hpos
= hpos_before_this_char
;
6872 it
->current_x
= x_before_this_char
;
6873 result
= MOVE_POS_MATCH_OR_ZV
;
6876 if (it
->line_wrap
== WORD_WRAP
6880 atpos_it
.current_x
= x_before_this_char
;
6881 atpos_it
.hpos
= hpos_before_this_char
;
6885 set_iterator_to_next (it
, 1);
6886 #ifdef HAVE_WINDOW_SYSTEM
6887 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6889 if (!get_next_display_element (it
))
6891 result
= MOVE_POS_MATCH_OR_ZV
;
6894 if (BUFFER_POS_REACHED_P ())
6896 if (ITERATOR_AT_END_OF_LINE_P (it
))
6897 result
= MOVE_POS_MATCH_OR_ZV
;
6899 result
= MOVE_LINE_CONTINUED
;
6902 if (ITERATOR_AT_END_OF_LINE_P (it
))
6904 result
= MOVE_NEWLINE_OR_CR
;
6908 #endif /* HAVE_WINDOW_SYSTEM */
6912 IT_RESET_X_ASCENT_DESCENT (it
);
6914 if (wrap_it
.sp
>= 0)
6921 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6923 result
= MOVE_LINE_CONTINUED
;
6927 if (BUFFER_POS_REACHED_P ())
6929 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6930 goto buffer_pos_reached
;
6931 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6934 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6938 if (new_x
> it
->first_visible_x
)
6940 /* Glyph is visible. Increment number of glyphs that
6941 would be displayed. */
6946 if (result
!= MOVE_UNDEFINED
)
6949 else if (BUFFER_POS_REACHED_P ())
6952 IT_RESET_X_ASCENT_DESCENT (it
);
6953 result
= MOVE_POS_MATCH_OR_ZV
;
6956 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6958 /* Stop when TO_X specified and reached. This check is
6959 necessary here because of lines consisting of a line end,
6960 only. The line end will not produce any glyphs and we
6961 would never get MOVE_X_REACHED. */
6962 xassert (it
->nglyphs
== 0);
6963 result
= MOVE_X_REACHED
;
6967 /* Is this a line end? If yes, we're done. */
6968 if (ITERATOR_AT_END_OF_LINE_P (it
))
6970 result
= MOVE_NEWLINE_OR_CR
;
6974 /* The current display element has been consumed. Advance
6976 set_iterator_to_next (it
, 1);
6978 /* Stop if lines are truncated and IT's current x-position is
6979 past the right edge of the window now. */
6980 if (it
->line_wrap
== TRUNCATE
6981 && it
->current_x
>= it
->last_visible_x
)
6983 #ifdef HAVE_WINDOW_SYSTEM
6984 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6986 if (!get_next_display_element (it
)
6987 || BUFFER_POS_REACHED_P ())
6989 result
= MOVE_POS_MATCH_OR_ZV
;
6992 if (ITERATOR_AT_END_OF_LINE_P (it
))
6994 result
= MOVE_NEWLINE_OR_CR
;
6998 #endif /* HAVE_WINDOW_SYSTEM */
6999 result
= MOVE_LINE_TRUNCATED
;
7002 #undef IT_RESET_X_ASCENT_DESCENT
7005 #undef BUFFER_POS_REACHED_P
7007 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7008 restore the saved iterator. */
7009 if (atpos_it
.sp
>= 0)
7011 else if (atx_it
.sp
>= 0)
7016 /* Restore the iterator settings altered at the beginning of this
7018 it
->glyph_row
= saved_glyph_row
;
7022 /* For external use. */
7024 move_it_in_display_line (struct it
*it
,
7025 EMACS_INT to_charpos
, int to_x
,
7026 enum move_operation_enum op
)
7028 if (it
->line_wrap
== WORD_WRAP
7029 && (op
& MOVE_TO_X
))
7031 struct it save_it
= *it
;
7032 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7033 /* When word-wrap is on, TO_X may lie past the end
7034 of a wrapped line. Then it->current is the
7035 character on the next line, so backtrack to the
7036 space before the wrap point. */
7037 if (skip
== MOVE_LINE_CONTINUED
)
7039 int prev_x
= max (it
->current_x
- 1, 0);
7041 move_it_in_display_line_to
7042 (it
, -1, prev_x
, MOVE_TO_X
);
7046 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7050 /* Move IT forward until it satisfies one or more of the criteria in
7051 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7053 OP is a bit-mask that specifies where to stop, and in particular,
7054 which of those four position arguments makes a difference. See the
7055 description of enum move_operation_enum.
7057 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7058 screen line, this function will set IT to the next position >
7062 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7064 int to_charpos
, to_x
, to_y
, to_vpos
;
7067 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7073 if (op
& MOVE_TO_VPOS
)
7075 /* If no TO_CHARPOS and no TO_X specified, stop at the
7076 start of the line TO_VPOS. */
7077 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7079 if (it
->vpos
== to_vpos
)
7085 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7089 /* TO_VPOS >= 0 means stop at TO_X in the line at
7090 TO_VPOS, or at TO_POS, whichever comes first. */
7091 if (it
->vpos
== to_vpos
)
7097 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7099 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7104 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7106 /* We have reached TO_X but not in the line we want. */
7107 skip
= move_it_in_display_line_to (it
, to_charpos
,
7109 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7117 else if (op
& MOVE_TO_Y
)
7119 struct it it_backup
;
7121 if (it
->line_wrap
== WORD_WRAP
)
7124 /* TO_Y specified means stop at TO_X in the line containing
7125 TO_Y---or at TO_CHARPOS if this is reached first. The
7126 problem is that we can't really tell whether the line
7127 contains TO_Y before we have completely scanned it, and
7128 this may skip past TO_X. What we do is to first scan to
7131 If TO_X is not specified, use a TO_X of zero. The reason
7132 is to make the outcome of this function more predictable.
7133 If we didn't use TO_X == 0, we would stop at the end of
7134 the line which is probably not what a caller would expect
7136 skip
= move_it_in_display_line_to
7137 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7138 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7140 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7141 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7143 else if (skip
== MOVE_X_REACHED
)
7145 /* If TO_X was reached, we want to know whether TO_Y is
7146 in the line. We know this is the case if the already
7147 scanned glyphs make the line tall enough. Otherwise,
7148 we must check by scanning the rest of the line. */
7149 line_height
= it
->max_ascent
+ it
->max_descent
;
7150 if (to_y
>= it
->current_y
7151 && to_y
< it
->current_y
+ line_height
)
7157 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7158 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7160 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
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 /* If TO_Y is in this line and TO_X was reached
7168 above, we scanned too far. We have to restore
7169 IT's settings to the ones before skipping. */
7176 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7182 /* Check whether TO_Y is in this line. */
7183 line_height
= it
->max_ascent
+ it
->max_descent
;
7184 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7186 if (to_y
>= it
->current_y
7187 && to_y
< it
->current_y
+ line_height
)
7189 /* When word-wrap is on, TO_X may lie past the end
7190 of a wrapped line. Then it->current is the
7191 character on the next line, so backtrack to the
7192 space before the wrap point. */
7193 if (skip
== MOVE_LINE_CONTINUED
7194 && it
->line_wrap
== WORD_WRAP
)
7196 int prev_x
= max (it
->current_x
- 1, 0);
7198 skip
= move_it_in_display_line_to
7199 (it
, -1, prev_x
, MOVE_TO_X
);
7208 else if (BUFFERP (it
->object
)
7209 && it
->method
== GET_FROM_BUFFER
7210 && IT_CHARPOS (*it
) >= to_charpos
)
7211 skip
= MOVE_POS_MATCH_OR_ZV
;
7213 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7217 case MOVE_POS_MATCH_OR_ZV
:
7221 case MOVE_NEWLINE_OR_CR
:
7222 set_iterator_to_next (it
, 1);
7223 it
->continuation_lines_width
= 0;
7226 case MOVE_LINE_TRUNCATED
:
7227 it
->continuation_lines_width
= 0;
7228 reseat_at_next_visible_line_start (it
, 0);
7229 if ((op
& MOVE_TO_POS
) != 0
7230 && IT_CHARPOS (*it
) > to_charpos
)
7237 case MOVE_LINE_CONTINUED
:
7238 /* For continued lines ending in a tab, some of the glyphs
7239 associated with the tab are displayed on the current
7240 line. Since it->current_x does not include these glyphs,
7241 we use it->last_visible_x instead. */
7244 it
->continuation_lines_width
+= it
->last_visible_x
;
7245 /* When moving by vpos, ensure that the iterator really
7246 advances to the next line (bug#847, bug#969). Fixme:
7247 do we need to do this in other circumstances? */
7248 if (it
->current_x
!= it
->last_visible_x
7249 && (op
& MOVE_TO_VPOS
)
7250 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7251 set_iterator_to_next (it
, 0);
7254 it
->continuation_lines_width
+= it
->current_x
;
7261 /* Reset/increment for the next run. */
7262 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7263 it
->current_x
= it
->hpos
= 0;
7264 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7266 last_height
= it
->max_ascent
+ it
->max_descent
;
7267 last_max_ascent
= it
->max_ascent
;
7268 it
->max_ascent
= it
->max_descent
= 0;
7273 /* On text terminals, we may stop at the end of a line in the middle
7274 of a multi-character glyph. If the glyph itself is continued,
7275 i.e. it is actually displayed on the next line, don't treat this
7276 stopping point as valid; move to the next line instead (unless
7277 that brings us offscreen). */
7278 if (!FRAME_WINDOW_P (it
->f
)
7280 && IT_CHARPOS (*it
) == to_charpos
7281 && it
->what
== IT_CHARACTER
7283 && it
->line_wrap
== WINDOW_WRAP
7284 && it
->current_x
== it
->last_visible_x
- 1
7287 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7289 it
->continuation_lines_width
+= it
->current_x
;
7290 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7291 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7293 last_height
= it
->max_ascent
+ it
->max_descent
;
7294 last_max_ascent
= it
->max_ascent
;
7297 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7301 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7303 If DY > 0, move IT backward at least that many pixels. DY = 0
7304 means move IT backward to the preceding line start or BEGV. This
7305 function may move over more than DY pixels if IT->current_y - DY
7306 ends up in the middle of a line; in this case IT->current_y will be
7307 set to the top of the line moved to. */
7310 move_it_vertically_backward (it
, dy
)
7321 start_pos
= IT_CHARPOS (*it
);
7323 /* Estimate how many newlines we must move back. */
7324 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7326 /* Set the iterator's position that many lines back. */
7327 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7328 back_to_previous_visible_line_start (it
);
7330 /* Reseat the iterator here. When moving backward, we don't want
7331 reseat to skip forward over invisible text, set up the iterator
7332 to deliver from overlay strings at the new position etc. So,
7333 use reseat_1 here. */
7334 reseat_1 (it
, it
->current
.pos
, 1);
7336 /* We are now surely at a line start. */
7337 it
->current_x
= it
->hpos
= 0;
7338 it
->continuation_lines_width
= 0;
7340 /* Move forward and see what y-distance we moved. First move to the
7341 start of the next line so that we get its height. We need this
7342 height to be able to tell whether we reached the specified
7345 it2
.max_ascent
= it2
.max_descent
= 0;
7348 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7349 MOVE_TO_POS
| MOVE_TO_VPOS
);
7351 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7352 xassert (IT_CHARPOS (*it
) >= BEGV
);
7355 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7356 xassert (IT_CHARPOS (*it
) >= BEGV
);
7357 /* H is the actual vertical distance from the position in *IT
7358 and the starting position. */
7359 h
= it2
.current_y
- it
->current_y
;
7360 /* NLINES is the distance in number of lines. */
7361 nlines
= it2
.vpos
- it
->vpos
;
7363 /* Correct IT's y and vpos position
7364 so that they are relative to the starting point. */
7370 /* DY == 0 means move to the start of the screen line. The
7371 value of nlines is > 0 if continuation lines were involved. */
7373 move_it_by_lines (it
, nlines
, 1);
7375 /* I think this assert is bogus if buffer contains
7376 invisible text or images. KFS. */
7377 xassert (IT_CHARPOS (*it
) <= start_pos
);
7382 /* The y-position we try to reach, relative to *IT.
7383 Note that H has been subtracted in front of the if-statement. */
7384 int target_y
= it
->current_y
+ h
- dy
;
7385 int y0
= it3
.current_y
;
7386 int y1
= line_bottom_y (&it3
);
7387 int line_height
= y1
- y0
;
7389 /* If we did not reach target_y, try to move further backward if
7390 we can. If we moved too far backward, try to move forward. */
7391 if (target_y
< it
->current_y
7392 /* This is heuristic. In a window that's 3 lines high, with
7393 a line height of 13 pixels each, recentering with point
7394 on the bottom line will try to move -39/2 = 19 pixels
7395 backward. Try to avoid moving into the first line. */
7396 && (it
->current_y
- target_y
7397 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7398 && IT_CHARPOS (*it
) > BEGV
)
7400 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7401 target_y
- it
->current_y
));
7402 dy
= it
->current_y
- target_y
;
7403 goto move_further_back
;
7405 else if (target_y
>= it
->current_y
+ line_height
7406 && IT_CHARPOS (*it
) < ZV
)
7408 /* Should move forward by at least one line, maybe more.
7410 Note: Calling move_it_by_lines can be expensive on
7411 terminal frames, where compute_motion is used (via
7412 vmotion) to do the job, when there are very long lines
7413 and truncate-lines is nil. That's the reason for
7414 treating terminal frames specially here. */
7416 if (!FRAME_WINDOW_P (it
->f
))
7417 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7422 move_it_by_lines (it
, 1, 1);
7424 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7428 /* I think this assert is bogus if buffer contains
7429 invisible text or images. KFS. */
7430 xassert (IT_CHARPOS (*it
) >= BEGV
);
7437 /* Move IT by a specified amount of pixel lines DY. DY negative means
7438 move backwards. DY = 0 means move to start of screen line. At the
7439 end, IT will be on the start of a screen line. */
7442 move_it_vertically (it
, dy
)
7447 move_it_vertically_backward (it
, -dy
);
7450 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7451 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7452 MOVE_TO_POS
| MOVE_TO_Y
);
7453 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7455 /* If buffer ends in ZV without a newline, move to the start of
7456 the line to satisfy the post-condition. */
7457 if (IT_CHARPOS (*it
) == ZV
7459 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7460 move_it_by_lines (it
, 0, 0);
7465 /* Move iterator IT past the end of the text line it is in. */
7468 move_it_past_eol (it
)
7471 enum move_it_result rc
;
7473 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7474 if (rc
== MOVE_NEWLINE_OR_CR
)
7475 set_iterator_to_next (it
, 0);
7479 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7480 negative means move up. DVPOS == 0 means move to the start of the
7481 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7482 NEED_Y_P is zero, IT->current_y will be left unchanged.
7484 Further optimization ideas: If we would know that IT->f doesn't use
7485 a face with proportional font, we could be faster for
7486 truncate-lines nil. */
7489 move_it_by_lines (it
, dvpos
, need_y_p
)
7491 int dvpos
, need_y_p
;
7493 struct position pos
;
7495 /* The commented-out optimization uses vmotion on terminals. This
7496 gives bad results, because elements like it->what, on which
7497 callers such as pos_visible_p rely, aren't updated. */
7498 /* if (!FRAME_WINDOW_P (it->f))
7500 struct text_pos textpos;
7502 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7503 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7504 reseat (it, textpos, 1);
7505 it->vpos += pos.vpos;
7506 it->current_y += pos.vpos;
7512 /* DVPOS == 0 means move to the start of the screen line. */
7513 move_it_vertically_backward (it
, 0);
7514 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7515 /* Let next call to line_bottom_y calculate real line height */
7520 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7521 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7522 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7527 int start_charpos
, i
;
7529 /* Start at the beginning of the screen line containing IT's
7530 position. This may actually move vertically backwards,
7531 in case of overlays, so adjust dvpos accordingly. */
7533 move_it_vertically_backward (it
, 0);
7536 /* Go back -DVPOS visible lines and reseat the iterator there. */
7537 start_charpos
= IT_CHARPOS (*it
);
7538 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7539 back_to_previous_visible_line_start (it
);
7540 reseat (it
, it
->current
.pos
, 1);
7542 /* Move further back if we end up in a string or an image. */
7543 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7545 /* First try to move to start of display line. */
7547 move_it_vertically_backward (it
, 0);
7549 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7551 /* If start of line is still in string or image,
7552 move further back. */
7553 back_to_previous_visible_line_start (it
);
7554 reseat (it
, it
->current
.pos
, 1);
7558 it
->current_x
= it
->hpos
= 0;
7560 /* Above call may have moved too far if continuation lines
7561 are involved. Scan forward and see if it did. */
7563 it2
.vpos
= it2
.current_y
= 0;
7564 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7565 it
->vpos
-= it2
.vpos
;
7566 it
->current_y
-= it2
.current_y
;
7567 it
->current_x
= it
->hpos
= 0;
7569 /* If we moved too far back, move IT some lines forward. */
7570 if (it2
.vpos
> -dvpos
)
7572 int delta
= it2
.vpos
+ dvpos
;
7574 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7575 /* Move back again if we got too far ahead. */
7576 if (IT_CHARPOS (*it
) >= start_charpos
)
7582 /* Return 1 if IT points into the middle of a display vector. */
7585 in_display_vector_p (it
)
7588 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7589 && it
->current
.dpvec_index
> 0
7590 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7594 /***********************************************************************
7596 ***********************************************************************/
7599 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7603 add_to_log (format
, arg1
, arg2
)
7605 Lisp_Object arg1
, arg2
;
7607 Lisp_Object args
[3];
7608 Lisp_Object msg
, fmt
;
7611 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7614 /* Do nothing if called asynchronously. Inserting text into
7615 a buffer may call after-change-functions and alike and
7616 that would means running Lisp asynchronously. */
7617 if (handling_signal
)
7621 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7623 args
[0] = fmt
= build_string (format
);
7626 msg
= Fformat (3, args
);
7628 len
= SBYTES (msg
) + 1;
7629 SAFE_ALLOCA (buffer
, char *, len
);
7630 bcopy (SDATA (msg
), buffer
, len
);
7632 message_dolog (buffer
, len
- 1, 1, 0);
7639 /* Output a newline in the *Messages* buffer if "needs" one. */
7642 message_log_maybe_newline ()
7644 if (message_log_need_newline
)
7645 message_dolog ("", 0, 1, 0);
7649 /* Add a string M of length NBYTES to the message log, optionally
7650 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7651 nonzero, means interpret the contents of M as multibyte. This
7652 function calls low-level routines in order to bypass text property
7653 hooks, etc. which might not be safe to run.
7655 This may GC (insert may run before/after change hooks),
7656 so the buffer M must NOT point to a Lisp string. */
7659 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7661 int nbytes
, nlflag
, multibyte
;
7663 if (!NILP (Vmemory_full
))
7666 if (!NILP (Vmessage_log_max
))
7668 struct buffer
*oldbuf
;
7669 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7670 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7671 int point_at_end
= 0;
7673 Lisp_Object old_deactivate_mark
, tem
;
7674 struct gcpro gcpro1
;
7676 old_deactivate_mark
= Vdeactivate_mark
;
7677 oldbuf
= current_buffer
;
7678 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7679 current_buffer
->undo_list
= Qt
;
7681 oldpoint
= message_dolog_marker1
;
7682 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7683 oldbegv
= message_dolog_marker2
;
7684 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7685 oldzv
= message_dolog_marker3
;
7686 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7687 GCPRO1 (old_deactivate_mark
);
7695 BEGV_BYTE
= BEG_BYTE
;
7698 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7700 /* Insert the string--maybe converting multibyte to single byte
7701 or vice versa, so that all the text fits the buffer. */
7703 && NILP (current_buffer
->enable_multibyte_characters
))
7705 int i
, c
, char_bytes
;
7706 unsigned char work
[1];
7708 /* Convert a multibyte string to single-byte
7709 for the *Message* buffer. */
7710 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7712 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7713 work
[0] = (ASCII_CHAR_P (c
)
7715 : multibyte_char_to_unibyte (c
, Qnil
));
7716 insert_1_both (work
, 1, 1, 1, 0, 0);
7719 else if (! multibyte
7720 && ! NILP (current_buffer
->enable_multibyte_characters
))
7722 int i
, c
, char_bytes
;
7723 unsigned char *msg
= (unsigned char *) m
;
7724 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7725 /* Convert a single-byte string to multibyte
7726 for the *Message* buffer. */
7727 for (i
= 0; i
< nbytes
; i
++)
7730 c
= unibyte_char_to_multibyte (c
);
7731 char_bytes
= CHAR_STRING (c
, str
);
7732 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7736 insert_1 (m
, nbytes
, 1, 0, 0);
7740 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7741 insert_1 ("\n", 1, 1, 0, 0);
7743 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7745 this_bol_byte
= PT_BYTE
;
7747 /* See if this line duplicates the previous one.
7748 If so, combine duplicates. */
7751 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7753 prev_bol_byte
= PT_BYTE
;
7755 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7756 this_bol
, this_bol_byte
);
7759 del_range_both (prev_bol
, prev_bol_byte
,
7760 this_bol
, this_bol_byte
, 0);
7766 /* If you change this format, don't forget to also
7767 change message_log_check_duplicate. */
7768 sprintf (dupstr
, " [%d times]", dup
);
7769 duplen
= strlen (dupstr
);
7770 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7771 insert_1 (dupstr
, duplen
, 1, 0, 1);
7776 /* If we have more than the desired maximum number of lines
7777 in the *Messages* buffer now, delete the oldest ones.
7778 This is safe because we don't have undo in this buffer. */
7780 if (NATNUMP (Vmessage_log_max
))
7782 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7783 -XFASTINT (Vmessage_log_max
) - 1, 0);
7784 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7787 BEGV
= XMARKER (oldbegv
)->charpos
;
7788 BEGV_BYTE
= marker_byte_position (oldbegv
);
7797 ZV
= XMARKER (oldzv
)->charpos
;
7798 ZV_BYTE
= marker_byte_position (oldzv
);
7802 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7804 /* We can't do Fgoto_char (oldpoint) because it will run some
7806 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7807 XMARKER (oldpoint
)->bytepos
);
7810 unchain_marker (XMARKER (oldpoint
));
7811 unchain_marker (XMARKER (oldbegv
));
7812 unchain_marker (XMARKER (oldzv
));
7814 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7815 set_buffer_internal (oldbuf
);
7817 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7818 message_log_need_newline
= !nlflag
;
7819 Vdeactivate_mark
= old_deactivate_mark
;
7824 /* We are at the end of the buffer after just having inserted a newline.
7825 (Note: We depend on the fact we won't be crossing the gap.)
7826 Check to see if the most recent message looks a lot like the previous one.
7827 Return 0 if different, 1 if the new one should just replace it, or a
7828 value N > 1 if we should also append " [N times]". */
7831 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7832 int prev_bol
, this_bol
;
7833 int prev_bol_byte
, this_bol_byte
;
7836 int len
= Z_BYTE
- 1 - this_bol_byte
;
7838 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7839 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7841 for (i
= 0; i
< len
; i
++)
7843 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7851 if (*p1
++ == ' ' && *p1
++ == '[')
7854 while (*p1
>= '0' && *p1
<= '9')
7855 n
= n
* 10 + *p1
++ - '0';
7856 if (strncmp (p1
, " times]\n", 8) == 0)
7863 /* Display an echo area message M with a specified length of NBYTES
7864 bytes. The string may include null characters. If M is 0, clear
7865 out any existing message, and let the mini-buffer text show
7868 This may GC, so the buffer M must NOT point to a Lisp string. */
7871 message2 (m
, nbytes
, multibyte
)
7876 /* First flush out any partial line written with print. */
7877 message_log_maybe_newline ();
7879 message_dolog (m
, nbytes
, 1, multibyte
);
7880 message2_nolog (m
, nbytes
, multibyte
);
7884 /* The non-logging counterpart of message2. */
7887 message2_nolog (m
, nbytes
, multibyte
)
7889 int nbytes
, multibyte
;
7891 struct frame
*sf
= SELECTED_FRAME ();
7892 message_enable_multibyte
= multibyte
;
7894 if (FRAME_INITIAL_P (sf
))
7896 if (noninteractive_need_newline
)
7897 putc ('\n', stderr
);
7898 noninteractive_need_newline
= 0;
7900 fwrite (m
, nbytes
, 1, stderr
);
7901 if (cursor_in_echo_area
== 0)
7902 fprintf (stderr
, "\n");
7905 /* A null message buffer means that the frame hasn't really been
7906 initialized yet. Error messages get reported properly by
7907 cmd_error, so this must be just an informative message; toss it. */
7908 else if (INTERACTIVE
7909 && sf
->glyphs_initialized_p
7910 && FRAME_MESSAGE_BUF (sf
))
7912 Lisp_Object mini_window
;
7915 /* Get the frame containing the mini-buffer
7916 that the selected frame is using. */
7917 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7918 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7920 FRAME_SAMPLE_VISIBILITY (f
);
7921 if (FRAME_VISIBLE_P (sf
)
7922 && ! FRAME_VISIBLE_P (f
))
7923 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7927 set_message (m
, Qnil
, nbytes
, multibyte
);
7928 if (minibuffer_auto_raise
)
7929 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7932 clear_message (1, 1);
7934 do_pending_window_change (0);
7935 echo_area_display (1);
7936 do_pending_window_change (0);
7937 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7938 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7943 /* Display an echo area message M with a specified length of NBYTES
7944 bytes. The string may include null characters. If M is not a
7945 string, clear out any existing message, and let the mini-buffer
7948 This function cancels echoing. */
7951 message3 (m
, nbytes
, multibyte
)
7956 struct gcpro gcpro1
;
7959 clear_message (1,1);
7962 /* First flush out any partial line written with print. */
7963 message_log_maybe_newline ();
7969 SAFE_ALLOCA (buffer
, char *, nbytes
);
7970 bcopy (SDATA (m
), buffer
, nbytes
);
7971 message_dolog (buffer
, nbytes
, 1, multibyte
);
7974 message3_nolog (m
, nbytes
, multibyte
);
7980 /* The non-logging version of message3.
7981 This does not cancel echoing, because it is used for echoing.
7982 Perhaps we need to make a separate function for echoing
7983 and make this cancel echoing. */
7986 message3_nolog (m
, nbytes
, multibyte
)
7988 int nbytes
, multibyte
;
7990 struct frame
*sf
= SELECTED_FRAME ();
7991 message_enable_multibyte
= multibyte
;
7993 if (FRAME_INITIAL_P (sf
))
7995 if (noninteractive_need_newline
)
7996 putc ('\n', stderr
);
7997 noninteractive_need_newline
= 0;
7999 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8000 if (cursor_in_echo_area
== 0)
8001 fprintf (stderr
, "\n");
8004 /* A null message buffer means that the frame hasn't really been
8005 initialized yet. Error messages get reported properly by
8006 cmd_error, so this must be just an informative message; toss it. */
8007 else if (INTERACTIVE
8008 && sf
->glyphs_initialized_p
8009 && FRAME_MESSAGE_BUF (sf
))
8011 Lisp_Object mini_window
;
8015 /* Get the frame containing the mini-buffer
8016 that the selected frame is using. */
8017 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8018 frame
= XWINDOW (mini_window
)->frame
;
8021 FRAME_SAMPLE_VISIBILITY (f
);
8022 if (FRAME_VISIBLE_P (sf
)
8023 && !FRAME_VISIBLE_P (f
))
8024 Fmake_frame_visible (frame
);
8026 if (STRINGP (m
) && SCHARS (m
) > 0)
8028 set_message (NULL
, m
, nbytes
, multibyte
);
8029 if (minibuffer_auto_raise
)
8030 Fraise_frame (frame
);
8031 /* Assume we are not echoing.
8032 (If we are, echo_now will override this.) */
8033 echo_message_buffer
= Qnil
;
8036 clear_message (1, 1);
8038 do_pending_window_change (0);
8039 echo_area_display (1);
8040 do_pending_window_change (0);
8041 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8042 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8047 /* Display a null-terminated echo area message M. If M is 0, clear
8048 out any existing message, and let the mini-buffer text show through.
8050 The buffer M must continue to exist until after the echo area gets
8051 cleared or some other message gets displayed there. Do not pass
8052 text that is stored in a Lisp string. Do not pass text in a buffer
8053 that was alloca'd. */
8059 message2 (m
, (m
? strlen (m
) : 0), 0);
8063 /* The non-logging counterpart of message1. */
8069 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8072 /* Display a message M which contains a single %s
8073 which gets replaced with STRING. */
8076 message_with_string (m
, string
, log
)
8081 CHECK_STRING (string
);
8087 if (noninteractive_need_newline
)
8088 putc ('\n', stderr
);
8089 noninteractive_need_newline
= 0;
8090 fprintf (stderr
, m
, SDATA (string
));
8091 if (!cursor_in_echo_area
)
8092 fprintf (stderr
, "\n");
8096 else if (INTERACTIVE
)
8098 /* The frame whose minibuffer we're going to display the message on.
8099 It may be larger than the selected frame, so we need
8100 to use its buffer, not the selected frame's buffer. */
8101 Lisp_Object mini_window
;
8102 struct frame
*f
, *sf
= SELECTED_FRAME ();
8104 /* Get the frame containing the minibuffer
8105 that the selected frame is using. */
8106 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8107 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8109 /* A null message buffer means that the frame hasn't really been
8110 initialized yet. Error messages get reported properly by
8111 cmd_error, so this must be just an informative message; toss it. */
8112 if (FRAME_MESSAGE_BUF (f
))
8114 Lisp_Object args
[2], message
;
8115 struct gcpro gcpro1
, gcpro2
;
8117 args
[0] = build_string (m
);
8118 args
[1] = message
= string
;
8119 GCPRO2 (args
[0], message
);
8122 message
= Fformat (2, args
);
8125 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8127 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8131 /* Print should start at the beginning of the message
8132 buffer next time. */
8133 message_buf_print
= 0;
8139 /* Dump an informative message to the minibuf. If M is 0, clear out
8140 any existing message, and let the mini-buffer text show through. */
8144 message (m
, a1
, a2
, a3
)
8146 EMACS_INT a1
, a2
, a3
;
8152 if (noninteractive_need_newline
)
8153 putc ('\n', stderr
);
8154 noninteractive_need_newline
= 0;
8155 fprintf (stderr
, m
, a1
, a2
, a3
);
8156 if (cursor_in_echo_area
== 0)
8157 fprintf (stderr
, "\n");
8161 else if (INTERACTIVE
)
8163 /* The frame whose mini-buffer we're going to display the message
8164 on. It may be larger than the selected frame, so we need to
8165 use its buffer, not the selected frame's buffer. */
8166 Lisp_Object mini_window
;
8167 struct frame
*f
, *sf
= SELECTED_FRAME ();
8169 /* Get the frame containing the mini-buffer
8170 that the selected frame is using. */
8171 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8172 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8174 /* A null message buffer means that the frame hasn't really been
8175 initialized yet. Error messages get reported properly by
8176 cmd_error, so this must be just an informative message; toss
8178 if (FRAME_MESSAGE_BUF (f
))
8189 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8190 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8192 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8193 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8195 #endif /* NO_ARG_ARRAY */
8197 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8202 /* Print should start at the beginning of the message
8203 buffer next time. */
8204 message_buf_print
= 0;
8210 /* The non-logging version of message. */
8213 message_nolog (m
, a1
, a2
, a3
)
8215 EMACS_INT a1
, a2
, a3
;
8217 Lisp_Object old_log_max
;
8218 old_log_max
= Vmessage_log_max
;
8219 Vmessage_log_max
= Qnil
;
8220 message (m
, a1
, a2
, a3
);
8221 Vmessage_log_max
= old_log_max
;
8225 /* Display the current message in the current mini-buffer. This is
8226 only called from error handlers in process.c, and is not time
8232 if (!NILP (echo_area_buffer
[0]))
8235 string
= Fcurrent_message ();
8236 message3 (string
, SBYTES (string
),
8237 !NILP (current_buffer
->enable_multibyte_characters
));
8242 /* Make sure echo area buffers in `echo_buffers' are live.
8243 If they aren't, make new ones. */
8246 ensure_echo_area_buffers ()
8250 for (i
= 0; i
< 2; ++i
)
8251 if (!BUFFERP (echo_buffer
[i
])
8252 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8255 Lisp_Object old_buffer
;
8258 old_buffer
= echo_buffer
[i
];
8259 sprintf (name
, " *Echo Area %d*", i
);
8260 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8261 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8262 /* to force word wrap in echo area -
8263 it was decided to postpone this*/
8264 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8266 for (j
= 0; j
< 2; ++j
)
8267 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8268 echo_area_buffer
[j
] = echo_buffer
[i
];
8273 /* Call FN with args A1..A4 with either the current or last displayed
8274 echo_area_buffer as current buffer.
8276 WHICH zero means use the current message buffer
8277 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8278 from echo_buffer[] and clear it.
8280 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8281 suitable buffer from echo_buffer[] and clear it.
8283 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8284 that the current message becomes the last displayed one, make
8285 choose a suitable buffer for echo_area_buffer[0], and clear it.
8287 Value is what FN returns. */
8290 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8293 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8299 int this_one
, the_other
, clear_buffer_p
, rc
;
8300 int count
= SPECPDL_INDEX ();
8302 /* If buffers aren't live, make new ones. */
8303 ensure_echo_area_buffers ();
8308 this_one
= 0, the_other
= 1;
8310 this_one
= 1, the_other
= 0;
8313 this_one
= 0, the_other
= 1;
8316 /* We need a fresh one in case the current echo buffer equals
8317 the one containing the last displayed echo area message. */
8318 if (!NILP (echo_area_buffer
[this_one
])
8319 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8320 echo_area_buffer
[this_one
] = Qnil
;
8323 /* Choose a suitable buffer from echo_buffer[] is we don't
8325 if (NILP (echo_area_buffer
[this_one
]))
8327 echo_area_buffer
[this_one
]
8328 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8329 ? echo_buffer
[the_other
]
8330 : echo_buffer
[this_one
]);
8334 buffer
= echo_area_buffer
[this_one
];
8336 /* Don't get confused by reusing the buffer used for echoing
8337 for a different purpose. */
8338 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8341 record_unwind_protect (unwind_with_echo_area_buffer
,
8342 with_echo_area_buffer_unwind_data (w
));
8344 /* Make the echo area buffer current. Note that for display
8345 purposes, it is not necessary that the displayed window's buffer
8346 == current_buffer, except for text property lookup. So, let's
8347 only set that buffer temporarily here without doing a full
8348 Fset_window_buffer. We must also change w->pointm, though,
8349 because otherwise an assertions in unshow_buffer fails, and Emacs
8351 set_buffer_internal_1 (XBUFFER (buffer
));
8355 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8358 current_buffer
->undo_list
= Qt
;
8359 current_buffer
->read_only
= Qnil
;
8360 specbind (Qinhibit_read_only
, Qt
);
8361 specbind (Qinhibit_modification_hooks
, Qt
);
8363 if (clear_buffer_p
&& Z
> BEG
)
8366 xassert (BEGV
>= BEG
);
8367 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8369 rc
= fn (a1
, a2
, a3
, a4
);
8371 xassert (BEGV
>= BEG
);
8372 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8374 unbind_to (count
, Qnil
);
8379 /* Save state that should be preserved around the call to the function
8380 FN called in with_echo_area_buffer. */
8383 with_echo_area_buffer_unwind_data (w
)
8387 Lisp_Object vector
, tmp
;
8389 /* Reduce consing by keeping one vector in
8390 Vwith_echo_area_save_vector. */
8391 vector
= Vwith_echo_area_save_vector
;
8392 Vwith_echo_area_save_vector
= Qnil
;
8395 vector
= Fmake_vector (make_number (7), Qnil
);
8397 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8398 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8399 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8403 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8404 ASET (vector
, i
, w
->buffer
); ++i
;
8405 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8406 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8411 for (; i
< end
; ++i
)
8412 ASET (vector
, i
, Qnil
);
8415 xassert (i
== ASIZE (vector
));
8420 /* Restore global state from VECTOR which was created by
8421 with_echo_area_buffer_unwind_data. */
8424 unwind_with_echo_area_buffer (vector
)
8427 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8428 Vdeactivate_mark
= AREF (vector
, 1);
8429 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8431 if (WINDOWP (AREF (vector
, 3)))
8434 Lisp_Object buffer
, charpos
, bytepos
;
8436 w
= XWINDOW (AREF (vector
, 3));
8437 buffer
= AREF (vector
, 4);
8438 charpos
= AREF (vector
, 5);
8439 bytepos
= AREF (vector
, 6);
8442 set_marker_both (w
->pointm
, buffer
,
8443 XFASTINT (charpos
), XFASTINT (bytepos
));
8446 Vwith_echo_area_save_vector
= vector
;
8451 /* Set up the echo area for use by print functions. MULTIBYTE_P
8452 non-zero means we will print multibyte. */
8455 setup_echo_area_for_printing (multibyte_p
)
8458 /* If we can't find an echo area any more, exit. */
8459 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8462 ensure_echo_area_buffers ();
8464 if (!message_buf_print
)
8466 /* A message has been output since the last time we printed.
8467 Choose a fresh echo area buffer. */
8468 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8469 echo_area_buffer
[0] = echo_buffer
[1];
8471 echo_area_buffer
[0] = echo_buffer
[0];
8473 /* Switch to that buffer and clear it. */
8474 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8475 current_buffer
->truncate_lines
= Qnil
;
8479 int count
= SPECPDL_INDEX ();
8480 specbind (Qinhibit_read_only
, Qt
);
8481 /* Note that undo recording is always disabled. */
8483 unbind_to (count
, Qnil
);
8485 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8487 /* Set up the buffer for the multibyteness we need. */
8489 != !NILP (current_buffer
->enable_multibyte_characters
))
8490 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8492 /* Raise the frame containing the echo area. */
8493 if (minibuffer_auto_raise
)
8495 struct frame
*sf
= SELECTED_FRAME ();
8496 Lisp_Object mini_window
;
8497 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8498 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8501 message_log_maybe_newline ();
8502 message_buf_print
= 1;
8506 if (NILP (echo_area_buffer
[0]))
8508 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8509 echo_area_buffer
[0] = echo_buffer
[1];
8511 echo_area_buffer
[0] = echo_buffer
[0];
8514 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8516 /* Someone switched buffers between print requests. */
8517 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8518 current_buffer
->truncate_lines
= Qnil
;
8524 /* Display an echo area message in window W. Value is non-zero if W's
8525 height is changed. If display_last_displayed_message_p is
8526 non-zero, display the message that was last displayed, otherwise
8527 display the current message. */
8530 display_echo_area (w
)
8533 int i
, no_message_p
, window_height_changed_p
, count
;
8535 /* Temporarily disable garbage collections while displaying the echo
8536 area. This is done because a GC can print a message itself.
8537 That message would modify the echo area buffer's contents while a
8538 redisplay of the buffer is going on, and seriously confuse
8540 count
= inhibit_garbage_collection ();
8542 /* If there is no message, we must call display_echo_area_1
8543 nevertheless because it resizes the window. But we will have to
8544 reset the echo_area_buffer in question to nil at the end because
8545 with_echo_area_buffer will sets it to an empty buffer. */
8546 i
= display_last_displayed_message_p
? 1 : 0;
8547 no_message_p
= NILP (echo_area_buffer
[i
]);
8549 window_height_changed_p
8550 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8551 display_echo_area_1
,
8552 (EMACS_INT
) w
, Qnil
, 0, 0);
8555 echo_area_buffer
[i
] = Qnil
;
8557 unbind_to (count
, Qnil
);
8558 return window_height_changed_p
;
8562 /* Helper for display_echo_area. Display the current buffer which
8563 contains the current echo area message in window W, a mini-window,
8564 a pointer to which is passed in A1. A2..A4 are currently not used.
8565 Change the height of W so that all of the message is displayed.
8566 Value is non-zero if height of W was changed. */
8569 display_echo_area_1 (a1
, a2
, a3
, a4
)
8574 struct window
*w
= (struct window
*) a1
;
8576 struct text_pos start
;
8577 int window_height_changed_p
= 0;
8579 /* Do this before displaying, so that we have a large enough glyph
8580 matrix for the display. If we can't get enough space for the
8581 whole text, display the last N lines. That works by setting w->start. */
8582 window_height_changed_p
= resize_mini_window (w
, 0);
8584 /* Use the starting position chosen by resize_mini_window. */
8585 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8588 clear_glyph_matrix (w
->desired_matrix
);
8589 XSETWINDOW (window
, w
);
8590 try_window (window
, start
, 0);
8592 return window_height_changed_p
;
8596 /* Resize the echo area window to exactly the size needed for the
8597 currently displayed message, if there is one. If a mini-buffer
8598 is active, don't shrink it. */
8601 resize_echo_area_exactly ()
8603 if (BUFFERP (echo_area_buffer
[0])
8604 && WINDOWP (echo_area_window
))
8606 struct window
*w
= XWINDOW (echo_area_window
);
8608 Lisp_Object resize_exactly
;
8610 if (minibuf_level
== 0)
8611 resize_exactly
= Qt
;
8613 resize_exactly
= Qnil
;
8615 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8616 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8619 ++windows_or_buffers_changed
;
8620 ++update_mode_lines
;
8621 redisplay_internal (0);
8627 /* Callback function for with_echo_area_buffer, when used from
8628 resize_echo_area_exactly. A1 contains a pointer to the window to
8629 resize, EXACTLY non-nil means resize the mini-window exactly to the
8630 size of the text displayed. A3 and A4 are not used. Value is what
8631 resize_mini_window returns. */
8634 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8636 Lisp_Object exactly
;
8639 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8643 /* Resize mini-window W to fit the size of its contents. EXACT_P
8644 means size the window exactly to the size needed. Otherwise, it's
8645 only enlarged until W's buffer is empty.
8647 Set W->start to the right place to begin display. If the whole
8648 contents fit, start at the beginning. Otherwise, start so as
8649 to make the end of the contents appear. This is particularly
8650 important for y-or-n-p, but seems desirable generally.
8652 Value is non-zero if the window height has been changed. */
8655 resize_mini_window (w
, exact_p
)
8659 struct frame
*f
= XFRAME (w
->frame
);
8660 int window_height_changed_p
= 0;
8662 xassert (MINI_WINDOW_P (w
));
8664 /* By default, start display at the beginning. */
8665 set_marker_both (w
->start
, w
->buffer
,
8666 BUF_BEGV (XBUFFER (w
->buffer
)),
8667 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8669 /* Don't resize windows while redisplaying a window; it would
8670 confuse redisplay functions when the size of the window they are
8671 displaying changes from under them. Such a resizing can happen,
8672 for instance, when which-func prints a long message while
8673 we are running fontification-functions. We're running these
8674 functions with safe_call which binds inhibit-redisplay to t. */
8675 if (!NILP (Vinhibit_redisplay
))
8678 /* Nil means don't try to resize. */
8679 if (NILP (Vresize_mini_windows
)
8680 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8683 if (!FRAME_MINIBUF_ONLY_P (f
))
8686 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8687 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8688 int height
, max_height
;
8689 int unit
= FRAME_LINE_HEIGHT (f
);
8690 struct text_pos start
;
8691 struct buffer
*old_current_buffer
= NULL
;
8693 if (current_buffer
!= XBUFFER (w
->buffer
))
8695 old_current_buffer
= current_buffer
;
8696 set_buffer_internal (XBUFFER (w
->buffer
));
8699 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8701 /* Compute the max. number of lines specified by the user. */
8702 if (FLOATP (Vmax_mini_window_height
))
8703 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8704 else if (INTEGERP (Vmax_mini_window_height
))
8705 max_height
= XINT (Vmax_mini_window_height
);
8707 max_height
= total_height
/ 4;
8709 /* Correct that max. height if it's bogus. */
8710 max_height
= max (1, max_height
);
8711 max_height
= min (total_height
, max_height
);
8713 /* Find out the height of the text in the window. */
8714 if (it
.line_wrap
== TRUNCATE
)
8719 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8720 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8721 height
= it
.current_y
+ last_height
;
8723 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8724 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8725 height
= (height
+ unit
- 1) / unit
;
8728 /* Compute a suitable window start. */
8729 if (height
> max_height
)
8731 height
= max_height
;
8732 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8733 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8734 start
= it
.current
.pos
;
8737 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8738 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8740 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8742 /* Let it grow only, until we display an empty message, in which
8743 case the window shrinks again. */
8744 if (height
> WINDOW_TOTAL_LINES (w
))
8746 int old_height
= WINDOW_TOTAL_LINES (w
);
8747 freeze_window_starts (f
, 1);
8748 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8749 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8751 else if (height
< WINDOW_TOTAL_LINES (w
)
8752 && (exact_p
|| BEGV
== ZV
))
8754 int old_height
= WINDOW_TOTAL_LINES (w
);
8755 freeze_window_starts (f
, 0);
8756 shrink_mini_window (w
);
8757 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8762 /* Always resize to exact size needed. */
8763 if (height
> WINDOW_TOTAL_LINES (w
))
8765 int old_height
= WINDOW_TOTAL_LINES (w
);
8766 freeze_window_starts (f
, 1);
8767 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8768 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8770 else if (height
< WINDOW_TOTAL_LINES (w
))
8772 int old_height
= WINDOW_TOTAL_LINES (w
);
8773 freeze_window_starts (f
, 0);
8774 shrink_mini_window (w
);
8778 freeze_window_starts (f
, 1);
8779 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8782 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8786 if (old_current_buffer
)
8787 set_buffer_internal (old_current_buffer
);
8790 return window_height_changed_p
;
8794 /* Value is the current message, a string, or nil if there is no
8802 if (!BUFFERP (echo_area_buffer
[0]))
8806 with_echo_area_buffer (0, 0, current_message_1
,
8807 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8809 echo_area_buffer
[0] = Qnil
;
8817 current_message_1 (a1
, a2
, a3
, a4
)
8822 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8825 *msg
= make_buffer_string (BEG
, Z
, 1);
8832 /* Push the current message on Vmessage_stack for later restauration
8833 by restore_message. Value is non-zero if the current message isn't
8834 empty. This is a relatively infrequent operation, so it's not
8835 worth optimizing. */
8841 msg
= current_message ();
8842 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8843 return STRINGP (msg
);
8847 /* Restore message display from the top of Vmessage_stack. */
8854 xassert (CONSP (Vmessage_stack
));
8855 msg
= XCAR (Vmessage_stack
);
8857 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8859 message3_nolog (msg
, 0, 0);
8863 /* Handler for record_unwind_protect calling pop_message. */
8866 pop_message_unwind (dummy
)
8873 /* Pop the top-most entry off Vmessage_stack. */
8878 xassert (CONSP (Vmessage_stack
));
8879 Vmessage_stack
= XCDR (Vmessage_stack
);
8883 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8884 exits. If the stack is not empty, we have a missing pop_message
8888 check_message_stack ()
8890 if (!NILP (Vmessage_stack
))
8895 /* Truncate to NCHARS what will be displayed in the echo area the next
8896 time we display it---but don't redisplay it now. */
8899 truncate_echo_area (nchars
)
8903 echo_area_buffer
[0] = Qnil
;
8904 /* A null message buffer means that the frame hasn't really been
8905 initialized yet. Error messages get reported properly by
8906 cmd_error, so this must be just an informative message; toss it. */
8907 else if (!noninteractive
8909 && !NILP (echo_area_buffer
[0]))
8911 struct frame
*sf
= SELECTED_FRAME ();
8912 if (FRAME_MESSAGE_BUF (sf
))
8913 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8918 /* Helper function for truncate_echo_area. Truncate the current
8919 message to at most NCHARS characters. */
8922 truncate_message_1 (nchars
, a2
, a3
, a4
)
8927 if (BEG
+ nchars
< Z
)
8928 del_range (BEG
+ nchars
, Z
);
8930 echo_area_buffer
[0] = Qnil
;
8935 /* Set the current message to a substring of S or STRING.
8937 If STRING is a Lisp string, set the message to the first NBYTES
8938 bytes from STRING. NBYTES zero means use the whole string. If
8939 STRING is multibyte, the message will be displayed multibyte.
8941 If S is not null, set the message to the first LEN bytes of S. LEN
8942 zero means use the whole string. MULTIBYTE_P non-zero means S is
8943 multibyte. Display the message multibyte in that case.
8945 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8946 to t before calling set_message_1 (which calls insert).
8950 set_message (s
, string
, nbytes
, multibyte_p
)
8953 int nbytes
, multibyte_p
;
8955 message_enable_multibyte
8956 = ((s
&& multibyte_p
)
8957 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8959 with_echo_area_buffer (0, -1, set_message_1
,
8960 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8961 message_buf_print
= 0;
8962 help_echo_showing_p
= 0;
8966 /* Helper function for set_message. Arguments have the same meaning
8967 as there, with A1 corresponding to S and A2 corresponding to STRING
8968 This function is called with the echo area buffer being
8972 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8975 EMACS_INT nbytes
, multibyte_p
;
8977 const char *s
= (const char *) a1
;
8978 Lisp_Object string
= a2
;
8980 /* Change multibyteness of the echo buffer appropriately. */
8981 if (message_enable_multibyte
8982 != !NILP (current_buffer
->enable_multibyte_characters
))
8983 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8985 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8987 /* Insert new message at BEG. */
8988 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8990 if (STRINGP (string
))
8995 nbytes
= SBYTES (string
);
8996 nchars
= string_byte_to_char (string
, nbytes
);
8998 /* This function takes care of single/multibyte conversion. We
8999 just have to ensure that the echo area buffer has the right
9000 setting of enable_multibyte_characters. */
9001 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9006 nbytes
= strlen (s
);
9008 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9010 /* Convert from multi-byte to single-byte. */
9012 unsigned char work
[1];
9014 /* Convert a multibyte string to single-byte. */
9015 for (i
= 0; i
< nbytes
; i
+= n
)
9017 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
9018 work
[0] = (ASCII_CHAR_P (c
)
9020 : multibyte_char_to_unibyte (c
, Qnil
));
9021 insert_1_both (work
, 1, 1, 1, 0, 0);
9024 else if (!multibyte_p
9025 && !NILP (current_buffer
->enable_multibyte_characters
))
9027 /* Convert from single-byte to multi-byte. */
9029 const unsigned char *msg
= (const unsigned char *) s
;
9030 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9032 /* Convert a single-byte string to multibyte. */
9033 for (i
= 0; i
< nbytes
; i
++)
9036 c
= unibyte_char_to_multibyte (c
);
9037 n
= CHAR_STRING (c
, str
);
9038 insert_1_both (str
, 1, n
, 1, 0, 0);
9042 insert_1 (s
, nbytes
, 1, 0, 0);
9049 /* Clear messages. CURRENT_P non-zero means clear the current
9050 message. LAST_DISPLAYED_P non-zero means clear the message
9054 clear_message (current_p
, last_displayed_p
)
9055 int current_p
, last_displayed_p
;
9059 echo_area_buffer
[0] = Qnil
;
9060 message_cleared_p
= 1;
9063 if (last_displayed_p
)
9064 echo_area_buffer
[1] = Qnil
;
9066 message_buf_print
= 0;
9069 /* Clear garbaged frames.
9071 This function is used where the old redisplay called
9072 redraw_garbaged_frames which in turn called redraw_frame which in
9073 turn called clear_frame. The call to clear_frame was a source of
9074 flickering. I believe a clear_frame is not necessary. It should
9075 suffice in the new redisplay to invalidate all current matrices,
9076 and ensure a complete redisplay of all windows. */
9079 clear_garbaged_frames ()
9083 Lisp_Object tail
, frame
;
9084 int changed_count
= 0;
9086 FOR_EACH_FRAME (tail
, frame
)
9088 struct frame
*f
= XFRAME (frame
);
9090 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9094 Fredraw_frame (frame
);
9095 f
->force_flush_display_p
= 1;
9097 clear_current_matrices (f
);
9106 ++windows_or_buffers_changed
;
9111 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9112 is non-zero update selected_frame. Value is non-zero if the
9113 mini-windows height has been changed. */
9116 echo_area_display (update_frame_p
)
9119 Lisp_Object mini_window
;
9122 int window_height_changed_p
= 0;
9123 struct frame
*sf
= SELECTED_FRAME ();
9125 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9126 w
= XWINDOW (mini_window
);
9127 f
= XFRAME (WINDOW_FRAME (w
));
9129 /* Don't display if frame is invisible or not yet initialized. */
9130 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9133 #ifdef HAVE_WINDOW_SYSTEM
9134 /* When Emacs starts, selected_frame may be the initial terminal
9135 frame. If we let this through, a message would be displayed on
9137 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9139 #endif /* HAVE_WINDOW_SYSTEM */
9141 /* Redraw garbaged frames. */
9143 clear_garbaged_frames ();
9145 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9147 echo_area_window
= mini_window
;
9148 window_height_changed_p
= display_echo_area (w
);
9149 w
->must_be_updated_p
= 1;
9151 /* Update the display, unless called from redisplay_internal.
9152 Also don't update the screen during redisplay itself. The
9153 update will happen at the end of redisplay, and an update
9154 here could cause confusion. */
9155 if (update_frame_p
&& !redisplaying_p
)
9159 /* If the display update has been interrupted by pending
9160 input, update mode lines in the frame. Due to the
9161 pending input, it might have been that redisplay hasn't
9162 been called, so that mode lines above the echo area are
9163 garbaged. This looks odd, so we prevent it here. */
9164 if (!display_completed
)
9165 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9167 if (window_height_changed_p
9168 /* Don't do this if Emacs is shutting down. Redisplay
9169 needs to run hooks. */
9170 && !NILP (Vrun_hooks
))
9172 /* Must update other windows. Likewise as in other
9173 cases, don't let this update be interrupted by
9175 int count
= SPECPDL_INDEX ();
9176 specbind (Qredisplay_dont_pause
, Qt
);
9177 windows_or_buffers_changed
= 1;
9178 redisplay_internal (0);
9179 unbind_to (count
, Qnil
);
9181 else if (FRAME_WINDOW_P (f
) && n
== 0)
9183 /* Window configuration is the same as before.
9184 Can do with a display update of the echo area,
9185 unless we displayed some mode lines. */
9186 update_single_window (w
, 1);
9187 FRAME_RIF (f
)->flush_display (f
);
9190 update_frame (f
, 1, 1);
9192 /* If cursor is in the echo area, make sure that the next
9193 redisplay displays the minibuffer, so that the cursor will
9194 be replaced with what the minibuffer wants. */
9195 if (cursor_in_echo_area
)
9196 ++windows_or_buffers_changed
;
9199 else if (!EQ (mini_window
, selected_window
))
9200 windows_or_buffers_changed
++;
9202 /* Last displayed message is now the current message. */
9203 echo_area_buffer
[1] = echo_area_buffer
[0];
9204 /* Inform read_char that we're not echoing. */
9205 echo_message_buffer
= Qnil
;
9207 /* Prevent redisplay optimization in redisplay_internal by resetting
9208 this_line_start_pos. This is done because the mini-buffer now
9209 displays the message instead of its buffer text. */
9210 if (EQ (mini_window
, selected_window
))
9211 CHARPOS (this_line_start_pos
) = 0;
9213 return window_height_changed_p
;
9218 /***********************************************************************
9219 Mode Lines and Frame Titles
9220 ***********************************************************************/
9222 /* A buffer for constructing non-propertized mode-line strings and
9223 frame titles in it; allocated from the heap in init_xdisp and
9224 resized as needed in store_mode_line_noprop_char. */
9226 static char *mode_line_noprop_buf
;
9228 /* The buffer's end, and a current output position in it. */
9230 static char *mode_line_noprop_buf_end
;
9231 static char *mode_line_noprop_ptr
;
9233 #define MODE_LINE_NOPROP_LEN(start) \
9234 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9237 MODE_LINE_DISPLAY
= 0,
9243 /* Alist that caches the results of :propertize.
9244 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9245 static Lisp_Object mode_line_proptrans_alist
;
9247 /* List of strings making up the mode-line. */
9248 static Lisp_Object mode_line_string_list
;
9250 /* Base face property when building propertized mode line string. */
9251 static Lisp_Object mode_line_string_face
;
9252 static Lisp_Object mode_line_string_face_prop
;
9255 /* Unwind data for mode line strings */
9257 static Lisp_Object Vmode_line_unwind_vector
;
9260 format_mode_line_unwind_data (struct buffer
*obuf
,
9264 Lisp_Object vector
, tmp
;
9266 /* Reduce consing by keeping one vector in
9267 Vwith_echo_area_save_vector. */
9268 vector
= Vmode_line_unwind_vector
;
9269 Vmode_line_unwind_vector
= Qnil
;
9272 vector
= Fmake_vector (make_number (8), Qnil
);
9274 ASET (vector
, 0, make_number (mode_line_target
));
9275 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9276 ASET (vector
, 2, mode_line_string_list
);
9277 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9278 ASET (vector
, 4, mode_line_string_face
);
9279 ASET (vector
, 5, mode_line_string_face_prop
);
9282 XSETBUFFER (tmp
, obuf
);
9285 ASET (vector
, 6, tmp
);
9286 ASET (vector
, 7, owin
);
9292 unwind_format_mode_line (vector
)
9295 mode_line_target
= XINT (AREF (vector
, 0));
9296 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9297 mode_line_string_list
= AREF (vector
, 2);
9298 if (! EQ (AREF (vector
, 3), Qt
))
9299 mode_line_proptrans_alist
= AREF (vector
, 3);
9300 mode_line_string_face
= AREF (vector
, 4);
9301 mode_line_string_face_prop
= AREF (vector
, 5);
9303 if (!NILP (AREF (vector
, 7)))
9304 /* Select window before buffer, since it may change the buffer. */
9305 Fselect_window (AREF (vector
, 7), Qt
);
9307 if (!NILP (AREF (vector
, 6)))
9309 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9310 ASET (vector
, 6, Qnil
);
9313 Vmode_line_unwind_vector
= vector
;
9318 /* Store a single character C for the frame title in mode_line_noprop_buf.
9319 Re-allocate mode_line_noprop_buf if necessary. */
9323 store_mode_line_noprop_char (char c
)
9325 store_mode_line_noprop_char (c
)
9329 /* If output position has reached the end of the allocated buffer,
9330 double the buffer's size. */
9331 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9333 int len
= MODE_LINE_NOPROP_LEN (0);
9334 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9335 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9336 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9337 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9340 *mode_line_noprop_ptr
++ = c
;
9344 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9345 mode_line_noprop_ptr. STR is the string to store. Do not copy
9346 characters that yield more columns than PRECISION; PRECISION <= 0
9347 means copy the whole string. Pad with spaces until FIELD_WIDTH
9348 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9349 pad. Called from display_mode_element when it is used to build a
9353 store_mode_line_noprop (str
, field_width
, precision
)
9354 const unsigned char *str
;
9355 int field_width
, precision
;
9360 /* Copy at most PRECISION chars from STR. */
9361 nbytes
= strlen (str
);
9362 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9364 store_mode_line_noprop_char (*str
++);
9366 /* Fill up with spaces until FIELD_WIDTH reached. */
9367 while (field_width
> 0
9370 store_mode_line_noprop_char (' ');
9377 /***********************************************************************
9379 ***********************************************************************/
9381 #ifdef HAVE_WINDOW_SYSTEM
9383 /* Set the title of FRAME, if it has changed. The title format is
9384 Vicon_title_format if FRAME is iconified, otherwise it is
9385 frame_title_format. */
9388 x_consider_frame_title (frame
)
9391 struct frame
*f
= XFRAME (frame
);
9393 if (FRAME_WINDOW_P (f
)
9394 || FRAME_MINIBUF_ONLY_P (f
)
9395 || f
->explicit_name
)
9397 /* Do we have more than one visible frame on this X display? */
9404 int count
= SPECPDL_INDEX ();
9406 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9408 Lisp_Object other_frame
= XCAR (tail
);
9409 struct frame
*tf
= XFRAME (other_frame
);
9412 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9413 && !FRAME_MINIBUF_ONLY_P (tf
)
9414 && !EQ (other_frame
, tip_frame
)
9415 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9419 /* Set global variable indicating that multiple frames exist. */
9420 multiple_frames
= CONSP (tail
);
9422 /* Switch to the buffer of selected window of the frame. Set up
9423 mode_line_target so that display_mode_element will output into
9424 mode_line_noprop_buf; then display the title. */
9425 record_unwind_protect (unwind_format_mode_line
,
9426 format_mode_line_unwind_data
9427 (current_buffer
, selected_window
, 0));
9429 Fselect_window (f
->selected_window
, Qt
);
9430 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9431 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9433 mode_line_target
= MODE_LINE_TITLE
;
9434 title_start
= MODE_LINE_NOPROP_LEN (0);
9435 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9436 NULL
, DEFAULT_FACE_ID
);
9437 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9438 len
= MODE_LINE_NOPROP_LEN (title_start
);
9439 title
= mode_line_noprop_buf
+ title_start
;
9440 unbind_to (count
, Qnil
);
9442 /* Set the title only if it's changed. This avoids consing in
9443 the common case where it hasn't. (If it turns out that we've
9444 already wasted too much time by walking through the list with
9445 display_mode_element, then we might need to optimize at a
9446 higher level than this.) */
9447 if (! STRINGP (f
->name
)
9448 || SBYTES (f
->name
) != len
9449 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9454 if (!MINI_WINDOW_P(XWINDOW(f
->selected_window
)))
9457 ns_set_name_as_filename (f
);
9459 x_implicitly_set_name (f
, make_string(title
, len
),
9465 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9470 /* do this also for frames with explicit names */
9471 ns_implicitly_set_icon_type(f
);
9472 ns_set_doc_edited(f
, Fbuffer_modified_p
9473 (XWINDOW (f
->selected_window
)->buffer
), Qnil
);
9479 #endif /* not HAVE_WINDOW_SYSTEM */
9484 /***********************************************************************
9486 ***********************************************************************/
9489 /* Prepare for redisplay by updating menu-bar item lists when
9490 appropriate. This can call eval. */
9493 prepare_menu_bars ()
9496 struct gcpro gcpro1
, gcpro2
;
9498 Lisp_Object tooltip_frame
;
9500 #ifdef HAVE_WINDOW_SYSTEM
9501 tooltip_frame
= tip_frame
;
9503 tooltip_frame
= Qnil
;
9506 /* Update all frame titles based on their buffer names, etc. We do
9507 this before the menu bars so that the buffer-menu will show the
9508 up-to-date frame titles. */
9509 #ifdef HAVE_WINDOW_SYSTEM
9510 if (windows_or_buffers_changed
|| update_mode_lines
)
9512 Lisp_Object tail
, frame
;
9514 FOR_EACH_FRAME (tail
, frame
)
9517 if (!EQ (frame
, tooltip_frame
)
9518 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9519 x_consider_frame_title (frame
);
9522 #endif /* HAVE_WINDOW_SYSTEM */
9524 /* Update the menu bar item lists, if appropriate. This has to be
9525 done before any actual redisplay or generation of display lines. */
9526 all_windows
= (update_mode_lines
9527 || buffer_shared
> 1
9528 || windows_or_buffers_changed
);
9531 Lisp_Object tail
, frame
;
9532 int count
= SPECPDL_INDEX ();
9533 /* 1 means that update_menu_bar has run its hooks
9534 so any further calls to update_menu_bar shouldn't do so again. */
9535 int menu_bar_hooks_run
= 0;
9537 record_unwind_save_match_data ();
9539 FOR_EACH_FRAME (tail
, frame
)
9543 /* Ignore tooltip frame. */
9544 if (EQ (frame
, tooltip_frame
))
9547 /* If a window on this frame changed size, report that to
9548 the user and clear the size-change flag. */
9549 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9551 Lisp_Object functions
;
9553 /* Clear flag first in case we get an error below. */
9554 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9555 functions
= Vwindow_size_change_functions
;
9556 GCPRO2 (tail
, functions
);
9558 while (CONSP (functions
))
9560 if (!EQ (XCAR (functions
), Qt
))
9561 call1 (XCAR (functions
), frame
);
9562 functions
= XCDR (functions
);
9568 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9569 #ifdef HAVE_WINDOW_SYSTEM
9570 update_tool_bar (f
, 0);
9575 unbind_to (count
, Qnil
);
9579 struct frame
*sf
= SELECTED_FRAME ();
9580 update_menu_bar (sf
, 1, 0);
9581 #ifdef HAVE_WINDOW_SYSTEM
9582 update_tool_bar (sf
, 1);
9586 /* Motif needs this. See comment in xmenu.c. Turn it off when
9587 pending_menu_activation is not defined. */
9588 #ifdef USE_X_TOOLKIT
9589 pending_menu_activation
= 0;
9594 /* Update the menu bar item list for frame F. This has to be done
9595 before we start to fill in any display lines, because it can call
9598 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9600 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9601 already ran the menu bar hooks for this redisplay, so there
9602 is no need to run them again. The return value is the
9603 updated value of this flag, to pass to the next call. */
9606 update_menu_bar (f
, save_match_data
, hooks_run
)
9608 int save_match_data
;
9612 register struct window
*w
;
9614 /* If called recursively during a menu update, do nothing. This can
9615 happen when, for instance, an activate-menubar-hook causes a
9617 if (inhibit_menubar_update
)
9620 window
= FRAME_SELECTED_WINDOW (f
);
9621 w
= XWINDOW (window
);
9623 if (FRAME_WINDOW_P (f
)
9625 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9626 || defined (HAVE_NS) || defined (USE_GTK)
9627 FRAME_EXTERNAL_MENU_BAR (f
)
9629 FRAME_MENU_BAR_LINES (f
) > 0
9631 : FRAME_MENU_BAR_LINES (f
) > 0)
9633 /* If the user has switched buffers or windows, we need to
9634 recompute to reflect the new bindings. But we'll
9635 recompute when update_mode_lines is set too; that means
9636 that people can use force-mode-line-update to request
9637 that the menu bar be recomputed. The adverse effect on
9638 the rest of the redisplay algorithm is about the same as
9639 windows_or_buffers_changed anyway. */
9640 if (windows_or_buffers_changed
9641 /* This used to test w->update_mode_line, but we believe
9642 there is no need to recompute the menu in that case. */
9643 || update_mode_lines
9644 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9645 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9646 != !NILP (w
->last_had_star
))
9647 || ((!NILP (Vtransient_mark_mode
)
9648 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9649 != !NILP (w
->region_showing
)))
9651 struct buffer
*prev
= current_buffer
;
9652 int count
= SPECPDL_INDEX ();
9654 specbind (Qinhibit_menubar_update
, Qt
);
9656 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9657 if (save_match_data
)
9658 record_unwind_save_match_data ();
9659 if (NILP (Voverriding_local_map_menu_flag
))
9661 specbind (Qoverriding_terminal_local_map
, Qnil
);
9662 specbind (Qoverriding_local_map
, Qnil
);
9667 /* Run the Lucid hook. */
9668 safe_run_hooks (Qactivate_menubar_hook
);
9670 /* If it has changed current-menubar from previous value,
9671 really recompute the menu-bar from the value. */
9672 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9673 call0 (Qrecompute_lucid_menubar
);
9675 safe_run_hooks (Qmenu_bar_update_hook
);
9680 XSETFRAME (Vmenu_updating_frame
, f
);
9681 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9683 /* Redisplay the menu bar in case we changed it. */
9684 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9685 || defined (HAVE_NS) || defined (USE_GTK)
9686 if (FRAME_WINDOW_P (f
))
9688 #if defined (HAVE_NS)
9689 /* All frames on Mac OS share the same menubar. So only
9690 the selected frame should be allowed to set it. */
9691 if (f
== SELECTED_FRAME ())
9693 set_frame_menubar (f
, 0, 0);
9696 /* On a terminal screen, the menu bar is an ordinary screen
9697 line, and this makes it get updated. */
9698 w
->update_mode_line
= Qt
;
9699 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9700 /* In the non-toolkit version, the menu bar is an ordinary screen
9701 line, and this makes it get updated. */
9702 w
->update_mode_line
= Qt
;
9703 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9705 unbind_to (count
, Qnil
);
9706 set_buffer_internal_1 (prev
);
9715 /***********************************************************************
9717 ***********************************************************************/
9719 #ifdef HAVE_WINDOW_SYSTEM
9722 Nominal cursor position -- where to draw output.
9723 HPOS and VPOS are window relative glyph matrix coordinates.
9724 X and Y are window relative pixel coordinates. */
9726 struct cursor_pos output_cursor
;
9730 Set the global variable output_cursor to CURSOR. All cursor
9731 positions are relative to updated_window. */
9734 set_output_cursor (cursor
)
9735 struct cursor_pos
*cursor
;
9737 output_cursor
.hpos
= cursor
->hpos
;
9738 output_cursor
.vpos
= cursor
->vpos
;
9739 output_cursor
.x
= cursor
->x
;
9740 output_cursor
.y
= cursor
->y
;
9745 Set a nominal cursor position.
9747 HPOS and VPOS are column/row positions in a window glyph matrix. X
9748 and Y are window text area relative pixel positions.
9750 If this is done during an update, updated_window will contain the
9751 window that is being updated and the position is the future output
9752 cursor position for that window. If updated_window is null, use
9753 selected_window and display the cursor at the given position. */
9756 x_cursor_to (vpos
, hpos
, y
, x
)
9757 int vpos
, hpos
, y
, x
;
9761 /* If updated_window is not set, work on selected_window. */
9765 w
= XWINDOW (selected_window
);
9767 /* Set the output cursor. */
9768 output_cursor
.hpos
= hpos
;
9769 output_cursor
.vpos
= vpos
;
9770 output_cursor
.x
= x
;
9771 output_cursor
.y
= y
;
9773 /* If not called as part of an update, really display the cursor.
9774 This will also set the cursor position of W. */
9775 if (updated_window
== NULL
)
9778 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9779 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9780 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9785 #endif /* HAVE_WINDOW_SYSTEM */
9788 /***********************************************************************
9790 ***********************************************************************/
9792 #ifdef HAVE_WINDOW_SYSTEM
9794 /* Where the mouse was last time we reported a mouse event. */
9796 FRAME_PTR last_mouse_frame
;
9798 /* Tool-bar item index of the item on which a mouse button was pressed
9801 int last_tool_bar_item
;
9805 update_tool_bar_unwind (frame
)
9808 selected_frame
= frame
;
9812 /* Update the tool-bar item list for frame F. This has to be done
9813 before we start to fill in any display lines. Called from
9814 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9815 and restore it here. */
9818 update_tool_bar (f
, save_match_data
)
9820 int save_match_data
;
9822 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
9823 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9825 int do_update
= WINDOWP (f
->tool_bar_window
)
9826 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9834 window
= FRAME_SELECTED_WINDOW (f
);
9835 w
= XWINDOW (window
);
9837 /* If the user has switched buffers or windows, we need to
9838 recompute to reflect the new bindings. But we'll
9839 recompute when update_mode_lines is set too; that means
9840 that people can use force-mode-line-update to request
9841 that the menu bar be recomputed. The adverse effect on
9842 the rest of the redisplay algorithm is about the same as
9843 windows_or_buffers_changed anyway. */
9844 if (windows_or_buffers_changed
9845 || !NILP (w
->update_mode_line
)
9846 || update_mode_lines
9847 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9848 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9849 != !NILP (w
->last_had_star
))
9850 || ((!NILP (Vtransient_mark_mode
)
9851 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9852 != !NILP (w
->region_showing
)))
9854 struct buffer
*prev
= current_buffer
;
9855 int count
= SPECPDL_INDEX ();
9856 Lisp_Object frame
, new_tool_bar
;
9858 struct gcpro gcpro1
;
9860 /* Set current_buffer to the buffer of the selected
9861 window of the frame, so that we get the right local
9863 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9865 /* Save match data, if we must. */
9866 if (save_match_data
)
9867 record_unwind_save_match_data ();
9869 /* Make sure that we don't accidentally use bogus keymaps. */
9870 if (NILP (Voverriding_local_map_menu_flag
))
9872 specbind (Qoverriding_terminal_local_map
, Qnil
);
9873 specbind (Qoverriding_local_map
, Qnil
);
9876 GCPRO1 (new_tool_bar
);
9878 /* We must temporarily set the selected frame to this frame
9879 before calling tool_bar_items, because the calculation of
9880 the tool-bar keymap uses the selected frame (see
9881 `tool-bar-make-keymap' in tool-bar.el). */
9882 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
9883 XSETFRAME (frame
, f
);
9884 selected_frame
= frame
;
9886 /* Build desired tool-bar items from keymaps. */
9887 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9890 /* Redisplay the tool-bar if we changed it. */
9891 if (new_n_tool_bar
!= f
->n_tool_bar_items
9892 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9894 /* Redisplay that happens asynchronously due to an expose event
9895 may access f->tool_bar_items. Make sure we update both
9896 variables within BLOCK_INPUT so no such event interrupts. */
9898 f
->tool_bar_items
= new_tool_bar
;
9899 f
->n_tool_bar_items
= new_n_tool_bar
;
9900 w
->update_mode_line
= Qt
;
9906 unbind_to (count
, Qnil
);
9907 set_buffer_internal_1 (prev
);
9913 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9914 F's desired tool-bar contents. F->tool_bar_items must have
9915 been set up previously by calling prepare_menu_bars. */
9918 build_desired_tool_bar_string (f
)
9921 int i
, size
, size_needed
;
9922 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9923 Lisp_Object image
, plist
, props
;
9925 image
= plist
= props
= Qnil
;
9926 GCPRO3 (image
, plist
, props
);
9928 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9929 Otherwise, make a new string. */
9931 /* The size of the string we might be able to reuse. */
9932 size
= (STRINGP (f
->desired_tool_bar_string
)
9933 ? SCHARS (f
->desired_tool_bar_string
)
9936 /* We need one space in the string for each image. */
9937 size_needed
= f
->n_tool_bar_items
;
9939 /* Reuse f->desired_tool_bar_string, if possible. */
9940 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9941 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9945 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9946 Fremove_text_properties (make_number (0), make_number (size
),
9947 props
, f
->desired_tool_bar_string
);
9950 /* Put a `display' property on the string for the images to display,
9951 put a `menu_item' property on tool-bar items with a value that
9952 is the index of the item in F's tool-bar item vector. */
9953 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9955 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9957 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9958 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9959 int hmargin
, vmargin
, relief
, idx
, end
;
9960 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9962 /* If image is a vector, choose the image according to the
9964 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9965 if (VECTORP (image
))
9969 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9970 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9973 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9974 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9976 xassert (ASIZE (image
) >= idx
);
9977 image
= AREF (image
, idx
);
9982 /* Ignore invalid image specifications. */
9983 if (!valid_image_p (image
))
9986 /* Display the tool-bar button pressed, or depressed. */
9987 plist
= Fcopy_sequence (XCDR (image
));
9989 /* Compute margin and relief to draw. */
9990 relief
= (tool_bar_button_relief
>= 0
9991 ? tool_bar_button_relief
9992 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9993 hmargin
= vmargin
= relief
;
9995 if (INTEGERP (Vtool_bar_button_margin
)
9996 && XINT (Vtool_bar_button_margin
) > 0)
9998 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
9999 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10001 else if (CONSP (Vtool_bar_button_margin
))
10003 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10004 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10005 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10007 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10008 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10009 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10012 if (auto_raise_tool_bar_buttons_p
)
10014 /* Add a `:relief' property to the image spec if the item is
10018 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10025 /* If image is selected, display it pressed, i.e. with a
10026 negative relief. If it's not selected, display it with a
10028 plist
= Fplist_put (plist
, QCrelief
,
10030 ? make_number (-relief
)
10031 : make_number (relief
)));
10036 /* Put a margin around the image. */
10037 if (hmargin
|| vmargin
)
10039 if (hmargin
== vmargin
)
10040 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10042 plist
= Fplist_put (plist
, QCmargin
,
10043 Fcons (make_number (hmargin
),
10044 make_number (vmargin
)));
10047 /* If button is not enabled, and we don't have special images
10048 for the disabled state, make the image appear disabled by
10049 applying an appropriate algorithm to it. */
10050 if (!enabled_p
&& idx
< 0)
10051 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10053 /* Put a `display' text property on the string for the image to
10054 display. Put a `menu-item' property on the string that gives
10055 the start of this item's properties in the tool-bar items
10057 image
= Fcons (Qimage
, plist
);
10058 props
= list4 (Qdisplay
, image
,
10059 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10061 /* Let the last image hide all remaining spaces in the tool bar
10062 string. The string can be longer than needed when we reuse a
10063 previous string. */
10064 if (i
+ 1 == f
->n_tool_bar_items
)
10065 end
= SCHARS (f
->desired_tool_bar_string
);
10068 Fadd_text_properties (make_number (i
), make_number (end
),
10069 props
, f
->desired_tool_bar_string
);
10077 /* Display one line of the tool-bar of frame IT->f.
10079 HEIGHT specifies the desired height of the tool-bar line.
10080 If the actual height of the glyph row is less than HEIGHT, the
10081 row's height is increased to HEIGHT, and the icons are centered
10082 vertically in the new height.
10084 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10085 count a final empty row in case the tool-bar width exactly matches
10090 display_tool_bar_line (it
, height
)
10094 struct glyph_row
*row
= it
->glyph_row
;
10095 int max_x
= it
->last_visible_x
;
10096 struct glyph
*last
;
10098 prepare_desired_row (row
);
10099 row
->y
= it
->current_y
;
10101 /* Note that this isn't made use of if the face hasn't a box,
10102 so there's no need to check the face here. */
10103 it
->start_of_box_run_p
= 1;
10105 while (it
->current_x
< max_x
)
10107 int x
, n_glyphs_before
, i
, nglyphs
;
10108 struct it it_before
;
10110 /* Get the next display element. */
10111 if (!get_next_display_element (it
))
10113 /* Don't count empty row if we are counting needed tool-bar lines. */
10114 if (height
< 0 && !it
->hpos
)
10119 /* Produce glyphs. */
10120 n_glyphs_before
= row
->used
[TEXT_AREA
];
10123 PRODUCE_GLYPHS (it
);
10125 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10127 x
= it_before
.current_x
;
10128 while (i
< nglyphs
)
10130 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10132 if (x
+ glyph
->pixel_width
> max_x
)
10134 /* Glyph doesn't fit on line. Backtrack. */
10135 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10137 /* If this is the only glyph on this line, it will never fit on the
10138 toolbar, so skip it. But ensure there is at least one glyph,
10139 so we don't accidentally disable the tool-bar. */
10140 if (n_glyphs_before
== 0
10141 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10147 x
+= glyph
->pixel_width
;
10151 /* Stop at line ends. */
10152 if (ITERATOR_AT_END_OF_LINE_P (it
))
10155 set_iterator_to_next (it
, 1);
10160 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10162 /* Use default face for the border below the tool bar.
10164 FIXME: When auto-resize-tool-bars is grow-only, there is
10165 no additional border below the possibly empty tool-bar lines.
10166 So to make the extra empty lines look "normal", we have to
10167 use the tool-bar face for the border too. */
10168 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10169 it
->face_id
= DEFAULT_FACE_ID
;
10171 extend_face_to_end_of_line (it
);
10172 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10173 last
->right_box_line_p
= 1;
10174 if (last
== row
->glyphs
[TEXT_AREA
])
10175 last
->left_box_line_p
= 1;
10177 /* Make line the desired height and center it vertically. */
10178 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10180 /* Don't add more than one line height. */
10181 height
%= FRAME_LINE_HEIGHT (it
->f
);
10182 it
->max_ascent
+= height
/ 2;
10183 it
->max_descent
+= (height
+ 1) / 2;
10186 compute_line_metrics (it
);
10188 /* If line is empty, make it occupy the rest of the tool-bar. */
10189 if (!row
->displays_text_p
)
10191 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10192 row
->visible_height
= row
->height
;
10193 row
->ascent
= row
->phys_ascent
= 0;
10194 row
->extra_line_spacing
= 0;
10197 row
->full_width_p
= 1;
10198 row
->continued_p
= 0;
10199 row
->truncated_on_left_p
= 0;
10200 row
->truncated_on_right_p
= 0;
10202 it
->current_x
= it
->hpos
= 0;
10203 it
->current_y
+= row
->height
;
10209 /* Max tool-bar height. */
10211 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10212 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10214 /* Value is the number of screen lines needed to make all tool-bar
10215 items of frame F visible. The number of actual rows needed is
10216 returned in *N_ROWS if non-NULL. */
10219 tool_bar_lines_needed (f
, n_rows
)
10223 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10225 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10226 the desired matrix, so use (unused) mode-line row as temporary row to
10227 avoid destroying the first tool-bar row. */
10228 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10230 /* Initialize an iterator for iteration over
10231 F->desired_tool_bar_string in the tool-bar window of frame F. */
10232 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10233 it
.first_visible_x
= 0;
10234 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10235 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10237 while (!ITERATOR_AT_END_P (&it
))
10239 clear_glyph_row (temp_row
);
10240 it
.glyph_row
= temp_row
;
10241 display_tool_bar_line (&it
, -1);
10243 clear_glyph_row (temp_row
);
10245 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10247 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10249 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10253 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10255 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10264 frame
= selected_frame
;
10266 CHECK_FRAME (frame
);
10267 f
= XFRAME (frame
);
10269 if (WINDOWP (f
->tool_bar_window
)
10270 || (w
= XWINDOW (f
->tool_bar_window
),
10271 WINDOW_TOTAL_LINES (w
) > 0))
10273 update_tool_bar (f
, 1);
10274 if (f
->n_tool_bar_items
)
10276 build_desired_tool_bar_string (f
);
10277 nlines
= tool_bar_lines_needed (f
, NULL
);
10281 return make_number (nlines
);
10285 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10286 height should be changed. */
10289 redisplay_tool_bar (f
)
10294 struct glyph_row
*row
;
10296 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
10297 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10298 update_frame_tool_bar (f
);
10302 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10303 do anything. This means you must start with tool-bar-lines
10304 non-zero to get the auto-sizing effect. Or in other words, you
10305 can turn off tool-bars by specifying tool-bar-lines zero. */
10306 if (!WINDOWP (f
->tool_bar_window
)
10307 || (w
= XWINDOW (f
->tool_bar_window
),
10308 WINDOW_TOTAL_LINES (w
) == 0))
10311 /* Set up an iterator for the tool-bar window. */
10312 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10313 it
.first_visible_x
= 0;
10314 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10315 row
= it
.glyph_row
;
10317 /* Build a string that represents the contents of the tool-bar. */
10318 build_desired_tool_bar_string (f
);
10319 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10321 if (f
->n_tool_bar_rows
== 0)
10325 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10326 nlines
!= WINDOW_TOTAL_LINES (w
)))
10328 extern Lisp_Object Qtool_bar_lines
;
10330 int old_height
= WINDOW_TOTAL_LINES (w
);
10332 XSETFRAME (frame
, f
);
10333 Fmodify_frame_parameters (frame
,
10334 Fcons (Fcons (Qtool_bar_lines
,
10335 make_number (nlines
)),
10337 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10339 clear_glyph_matrix (w
->desired_matrix
);
10340 fonts_changed_p
= 1;
10346 /* Display as many lines as needed to display all tool-bar items. */
10348 if (f
->n_tool_bar_rows
> 0)
10350 int border
, rows
, height
, extra
;
10352 if (INTEGERP (Vtool_bar_border
))
10353 border
= XINT (Vtool_bar_border
);
10354 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10355 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10356 else if (EQ (Vtool_bar_border
, Qborder_width
))
10357 border
= f
->border_width
;
10363 rows
= f
->n_tool_bar_rows
;
10364 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10365 extra
= it
.last_visible_y
- border
- height
* rows
;
10367 while (it
.current_y
< it
.last_visible_y
)
10370 if (extra
> 0 && rows
-- > 0)
10372 h
= (extra
+ rows
- 1) / rows
;
10375 display_tool_bar_line (&it
, height
+ h
);
10380 while (it
.current_y
< it
.last_visible_y
)
10381 display_tool_bar_line (&it
, 0);
10384 /* It doesn't make much sense to try scrolling in the tool-bar
10385 window, so don't do it. */
10386 w
->desired_matrix
->no_scrolling_p
= 1;
10387 w
->must_be_updated_p
= 1;
10389 if (!NILP (Vauto_resize_tool_bars
))
10391 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10392 int change_height_p
= 0;
10394 /* If we couldn't display everything, change the tool-bar's
10395 height if there is room for more. */
10396 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10397 && it
.current_y
< max_tool_bar_height
)
10398 change_height_p
= 1;
10400 row
= it
.glyph_row
- 1;
10402 /* If there are blank lines at the end, except for a partially
10403 visible blank line at the end that is smaller than
10404 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10405 if (!row
->displays_text_p
10406 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10407 change_height_p
= 1;
10409 /* If row displays tool-bar items, but is partially visible,
10410 change the tool-bar's height. */
10411 if (row
->displays_text_p
10412 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10413 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10414 change_height_p
= 1;
10416 /* Resize windows as needed by changing the `tool-bar-lines'
10417 frame parameter. */
10418 if (change_height_p
)
10420 extern Lisp_Object Qtool_bar_lines
;
10422 int old_height
= WINDOW_TOTAL_LINES (w
);
10424 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10426 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10427 && !f
->minimize_tool_bar_window_p
)
10428 ? (nlines
> old_height
)
10429 : (nlines
!= old_height
));
10430 f
->minimize_tool_bar_window_p
= 0;
10432 if (change_height_p
)
10434 XSETFRAME (frame
, f
);
10435 Fmodify_frame_parameters (frame
,
10436 Fcons (Fcons (Qtool_bar_lines
,
10437 make_number (nlines
)),
10439 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10441 clear_glyph_matrix (w
->desired_matrix
);
10442 f
->n_tool_bar_rows
= nrows
;
10443 fonts_changed_p
= 1;
10450 f
->minimize_tool_bar_window_p
= 0;
10455 /* Get information about the tool-bar item which is displayed in GLYPH
10456 on frame F. Return in *PROP_IDX the index where tool-bar item
10457 properties start in F->tool_bar_items. Value is zero if
10458 GLYPH doesn't display a tool-bar item. */
10461 tool_bar_item_info (f
, glyph
, prop_idx
)
10463 struct glyph
*glyph
;
10470 /* This function can be called asynchronously, which means we must
10471 exclude any possibility that Fget_text_property signals an
10473 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10474 charpos
= max (0, charpos
);
10476 /* Get the text property `menu-item' at pos. The value of that
10477 property is the start index of this item's properties in
10478 F->tool_bar_items. */
10479 prop
= Fget_text_property (make_number (charpos
),
10480 Qmenu_item
, f
->current_tool_bar_string
);
10481 if (INTEGERP (prop
))
10483 *prop_idx
= XINT (prop
);
10493 /* Get information about the tool-bar item at position X/Y on frame F.
10494 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10495 the current matrix of the tool-bar window of F, or NULL if not
10496 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10497 item in F->tool_bar_items. Value is
10499 -1 if X/Y is not on a tool-bar item
10500 0 if X/Y is on the same item that was highlighted before.
10504 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10507 struct glyph
**glyph
;
10508 int *hpos
, *vpos
, *prop_idx
;
10510 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10511 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10514 /* Find the glyph under X/Y. */
10515 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10516 if (*glyph
== NULL
)
10519 /* Get the start of this tool-bar item's properties in
10520 f->tool_bar_items. */
10521 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10524 /* Is mouse on the highlighted item? */
10525 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10526 && *vpos
>= dpyinfo
->mouse_face_beg_row
10527 && *vpos
<= dpyinfo
->mouse_face_end_row
10528 && (*vpos
> dpyinfo
->mouse_face_beg_row
10529 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10530 && (*vpos
< dpyinfo
->mouse_face_end_row
10531 || *hpos
< dpyinfo
->mouse_face_end_col
10532 || dpyinfo
->mouse_face_past_end
))
10540 Handle mouse button event on the tool-bar of frame F, at
10541 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10542 0 for button release. MODIFIERS is event modifiers for button
10546 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10549 unsigned int modifiers
;
10551 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10552 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10553 int hpos
, vpos
, prop_idx
;
10554 struct glyph
*glyph
;
10555 Lisp_Object enabled_p
;
10557 /* If not on the highlighted tool-bar item, return. */
10558 frame_to_window_pixel_xy (w
, &x
, &y
);
10559 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10562 /* If item is disabled, do nothing. */
10563 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10564 if (NILP (enabled_p
))
10569 /* Show item in pressed state. */
10570 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10571 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10572 last_tool_bar_item
= prop_idx
;
10576 Lisp_Object key
, frame
;
10577 struct input_event event
;
10578 EVENT_INIT (event
);
10580 /* Show item in released state. */
10581 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10582 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10584 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10586 XSETFRAME (frame
, f
);
10587 event
.kind
= TOOL_BAR_EVENT
;
10588 event
.frame_or_window
= frame
;
10590 kbd_buffer_store_event (&event
);
10592 event
.kind
= TOOL_BAR_EVENT
;
10593 event
.frame_or_window
= frame
;
10595 event
.modifiers
= modifiers
;
10596 kbd_buffer_store_event (&event
);
10597 last_tool_bar_item
= -1;
10602 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10603 tool-bar window-relative coordinates X/Y. Called from
10604 note_mouse_highlight. */
10607 note_tool_bar_highlight (f
, x
, y
)
10611 Lisp_Object window
= f
->tool_bar_window
;
10612 struct window
*w
= XWINDOW (window
);
10613 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10615 struct glyph
*glyph
;
10616 struct glyph_row
*row
;
10618 Lisp_Object enabled_p
;
10620 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10621 int mouse_down_p
, rc
;
10623 /* Function note_mouse_highlight is called with negative x(y
10624 values when mouse moves outside of the frame. */
10625 if (x
<= 0 || y
<= 0)
10627 clear_mouse_face (dpyinfo
);
10631 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10634 /* Not on tool-bar item. */
10635 clear_mouse_face (dpyinfo
);
10639 /* On same tool-bar item as before. */
10640 goto set_help_echo
;
10642 clear_mouse_face (dpyinfo
);
10644 /* Mouse is down, but on different tool-bar item? */
10645 mouse_down_p
= (dpyinfo
->grabbed
10646 && f
== last_mouse_frame
10647 && FRAME_LIVE_P (f
));
10649 && last_tool_bar_item
!= prop_idx
)
10652 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10653 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10655 /* If tool-bar item is not enabled, don't highlight it. */
10656 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10657 if (!NILP (enabled_p
))
10659 /* Compute the x-position of the glyph. In front and past the
10660 image is a space. We include this in the highlighted area. */
10661 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10662 for (i
= x
= 0; i
< hpos
; ++i
)
10663 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10665 /* Record this as the current active region. */
10666 dpyinfo
->mouse_face_beg_col
= hpos
;
10667 dpyinfo
->mouse_face_beg_row
= vpos
;
10668 dpyinfo
->mouse_face_beg_x
= x
;
10669 dpyinfo
->mouse_face_beg_y
= row
->y
;
10670 dpyinfo
->mouse_face_past_end
= 0;
10672 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10673 dpyinfo
->mouse_face_end_row
= vpos
;
10674 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10675 dpyinfo
->mouse_face_end_y
= row
->y
;
10676 dpyinfo
->mouse_face_window
= window
;
10677 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10679 /* Display it as active. */
10680 show_mouse_face (dpyinfo
, draw
);
10681 dpyinfo
->mouse_face_image_state
= draw
;
10686 /* Set help_echo_string to a help string to display for this tool-bar item.
10687 XTread_socket does the rest. */
10688 help_echo_object
= help_echo_window
= Qnil
;
10689 help_echo_pos
= -1;
10690 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10691 if (NILP (help_echo_string
))
10692 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10695 #endif /* HAVE_WINDOW_SYSTEM */
10699 /************************************************************************
10700 Horizontal scrolling
10701 ************************************************************************/
10703 static int hscroll_window_tree
P_ ((Lisp_Object
));
10704 static int hscroll_windows
P_ ((Lisp_Object
));
10706 /* For all leaf windows in the window tree rooted at WINDOW, set their
10707 hscroll value so that PT is (i) visible in the window, and (ii) so
10708 that it is not within a certain margin at the window's left and
10709 right border. Value is non-zero if any window's hscroll has been
10713 hscroll_window_tree (window
)
10714 Lisp_Object window
;
10716 int hscrolled_p
= 0;
10717 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10718 int hscroll_step_abs
= 0;
10719 double hscroll_step_rel
= 0;
10721 if (hscroll_relative_p
)
10723 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10724 if (hscroll_step_rel
< 0)
10726 hscroll_relative_p
= 0;
10727 hscroll_step_abs
= 0;
10730 else if (INTEGERP (Vhscroll_step
))
10732 hscroll_step_abs
= XINT (Vhscroll_step
);
10733 if (hscroll_step_abs
< 0)
10734 hscroll_step_abs
= 0;
10737 hscroll_step_abs
= 0;
10739 while (WINDOWP (window
))
10741 struct window
*w
= XWINDOW (window
);
10743 if (WINDOWP (w
->hchild
))
10744 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10745 else if (WINDOWP (w
->vchild
))
10746 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10747 else if (w
->cursor
.vpos
>= 0)
10750 int text_area_width
;
10751 struct glyph_row
*current_cursor_row
10752 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10753 struct glyph_row
*desired_cursor_row
10754 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10755 struct glyph_row
*cursor_row
10756 = (desired_cursor_row
->enabled_p
10757 ? desired_cursor_row
10758 : current_cursor_row
);
10760 text_area_width
= window_box_width (w
, TEXT_AREA
);
10762 /* Scroll when cursor is inside this scroll margin. */
10763 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10765 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10766 && ((XFASTINT (w
->hscroll
)
10767 && w
->cursor
.x
<= h_margin
)
10768 || (cursor_row
->enabled_p
10769 && cursor_row
->truncated_on_right_p
10770 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10774 struct buffer
*saved_current_buffer
;
10778 /* Find point in a display of infinite width. */
10779 saved_current_buffer
= current_buffer
;
10780 current_buffer
= XBUFFER (w
->buffer
);
10782 if (w
== XWINDOW (selected_window
))
10783 pt
= BUF_PT (current_buffer
);
10786 pt
= marker_position (w
->pointm
);
10787 pt
= max (BEGV
, pt
);
10791 /* Move iterator to pt starting at cursor_row->start in
10792 a line with infinite width. */
10793 init_to_row_start (&it
, w
, cursor_row
);
10794 it
.last_visible_x
= INFINITY
;
10795 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10796 current_buffer
= saved_current_buffer
;
10798 /* Position cursor in window. */
10799 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10800 hscroll
= max (0, (it
.current_x
10801 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10802 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10803 : (text_area_width
/ 2))))
10804 / FRAME_COLUMN_WIDTH (it
.f
);
10805 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10807 if (hscroll_relative_p
)
10808 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10811 wanted_x
= text_area_width
10812 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10815 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10819 if (hscroll_relative_p
)
10820 wanted_x
= text_area_width
* hscroll_step_rel
10823 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10826 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10828 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10830 /* Don't call Fset_window_hscroll if value hasn't
10831 changed because it will prevent redisplay
10833 if (XFASTINT (w
->hscroll
) != hscroll
)
10835 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10836 w
->hscroll
= make_number (hscroll
);
10845 /* Value is non-zero if hscroll of any leaf window has been changed. */
10846 return hscrolled_p
;
10850 /* Set hscroll so that cursor is visible and not inside horizontal
10851 scroll margins for all windows in the tree rooted at WINDOW. See
10852 also hscroll_window_tree above. Value is non-zero if any window's
10853 hscroll has been changed. If it has, desired matrices on the frame
10854 of WINDOW are cleared. */
10857 hscroll_windows (window
)
10858 Lisp_Object window
;
10860 int hscrolled_p
= hscroll_window_tree (window
);
10862 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10863 return hscrolled_p
;
10868 /************************************************************************
10870 ************************************************************************/
10872 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10873 to a non-zero value. This is sometimes handy to have in a debugger
10878 /* First and last unchanged row for try_window_id. */
10880 int debug_first_unchanged_at_end_vpos
;
10881 int debug_last_unchanged_at_beg_vpos
;
10883 /* Delta vpos and y. */
10885 int debug_dvpos
, debug_dy
;
10887 /* Delta in characters and bytes for try_window_id. */
10889 int debug_delta
, debug_delta_bytes
;
10891 /* Values of window_end_pos and window_end_vpos at the end of
10894 EMACS_INT debug_end_pos
, debug_end_vpos
;
10896 /* Append a string to W->desired_matrix->method. FMT is a printf
10897 format string. A1...A9 are a supplement for a variable-length
10898 argument list. If trace_redisplay_p is non-zero also printf the
10899 resulting string to stderr. */
10902 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10905 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10908 char *method
= w
->desired_matrix
->method
;
10909 int len
= strlen (method
);
10910 int size
= sizeof w
->desired_matrix
->method
;
10911 int remaining
= size
- len
- 1;
10913 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10914 if (len
&& remaining
)
10917 --remaining
, ++len
;
10920 strncpy (method
+ len
, buffer
, remaining
);
10922 if (trace_redisplay_p
)
10923 fprintf (stderr
, "%p (%s): %s\n",
10925 ((BUFFERP (w
->buffer
)
10926 && STRINGP (XBUFFER (w
->buffer
)->name
))
10927 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10932 #endif /* GLYPH_DEBUG */
10935 /* Value is non-zero if all changes in window W, which displays
10936 current_buffer, are in the text between START and END. START is a
10937 buffer position, END is given as a distance from Z. Used in
10938 redisplay_internal for display optimization. */
10941 text_outside_line_unchanged_p (w
, start
, end
)
10945 int unchanged_p
= 1;
10947 /* If text or overlays have changed, see where. */
10948 if (XFASTINT (w
->last_modified
) < MODIFF
10949 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10951 /* Gap in the line? */
10952 if (GPT
< start
|| Z
- GPT
< end
)
10955 /* Changes start in front of the line, or end after it? */
10957 && (BEG_UNCHANGED
< start
- 1
10958 || END_UNCHANGED
< end
))
10961 /* If selective display, can't optimize if changes start at the
10962 beginning of the line. */
10964 && INTEGERP (current_buffer
->selective_display
)
10965 && XINT (current_buffer
->selective_display
) > 0
10966 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10969 /* If there are overlays at the start or end of the line, these
10970 may have overlay strings with newlines in them. A change at
10971 START, for instance, may actually concern the display of such
10972 overlay strings as well, and they are displayed on different
10973 lines. So, quickly rule out this case. (For the future, it
10974 might be desirable to implement something more telling than
10975 just BEG/END_UNCHANGED.) */
10978 if (BEG
+ BEG_UNCHANGED
== start
10979 && overlay_touches_p (start
))
10981 if (END_UNCHANGED
== end
10982 && overlay_touches_p (Z
- end
))
10987 return unchanged_p
;
10991 /* Do a frame update, taking possible shortcuts into account. This is
10992 the main external entry point for redisplay.
10994 If the last redisplay displayed an echo area message and that message
10995 is no longer requested, we clear the echo area or bring back the
10996 mini-buffer if that is in use. */
11001 redisplay_internal (0);
11006 overlay_arrow_string_or_property (var
)
11011 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11014 return Voverlay_arrow_string
;
11017 /* Return 1 if there are any overlay-arrows in current_buffer. */
11019 overlay_arrow_in_current_buffer_p ()
11023 for (vlist
= Voverlay_arrow_variable_list
;
11025 vlist
= XCDR (vlist
))
11027 Lisp_Object var
= XCAR (vlist
);
11030 if (!SYMBOLP (var
))
11032 val
= find_symbol_value (var
);
11034 && current_buffer
== XMARKER (val
)->buffer
)
11041 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11045 overlay_arrows_changed_p ()
11049 for (vlist
= Voverlay_arrow_variable_list
;
11051 vlist
= XCDR (vlist
))
11053 Lisp_Object var
= XCAR (vlist
);
11054 Lisp_Object val
, pstr
;
11056 if (!SYMBOLP (var
))
11058 val
= find_symbol_value (var
);
11059 if (!MARKERP (val
))
11061 if (! EQ (COERCE_MARKER (val
),
11062 Fget (var
, Qlast_arrow_position
))
11063 || ! (pstr
= overlay_arrow_string_or_property (var
),
11064 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11070 /* Mark overlay arrows to be updated on next redisplay. */
11073 update_overlay_arrows (up_to_date
)
11078 for (vlist
= Voverlay_arrow_variable_list
;
11080 vlist
= XCDR (vlist
))
11082 Lisp_Object var
= XCAR (vlist
);
11084 if (!SYMBOLP (var
))
11087 if (up_to_date
> 0)
11089 Lisp_Object val
= find_symbol_value (var
);
11090 Fput (var
, Qlast_arrow_position
,
11091 COERCE_MARKER (val
));
11092 Fput (var
, Qlast_arrow_string
,
11093 overlay_arrow_string_or_property (var
));
11095 else if (up_to_date
< 0
11096 || !NILP (Fget (var
, Qlast_arrow_position
)))
11098 Fput (var
, Qlast_arrow_position
, Qt
);
11099 Fput (var
, Qlast_arrow_string
, Qt
);
11105 /* Return overlay arrow string to display at row.
11106 Return integer (bitmap number) for arrow bitmap in left fringe.
11107 Return nil if no overlay arrow. */
11110 overlay_arrow_at_row (it
, row
)
11112 struct glyph_row
*row
;
11116 for (vlist
= Voverlay_arrow_variable_list
;
11118 vlist
= XCDR (vlist
))
11120 Lisp_Object var
= XCAR (vlist
);
11123 if (!SYMBOLP (var
))
11126 val
= find_symbol_value (var
);
11129 && current_buffer
== XMARKER (val
)->buffer
11130 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11132 if (FRAME_WINDOW_P (it
->f
)
11133 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11135 #ifdef HAVE_WINDOW_SYSTEM
11136 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11139 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11140 return make_number (fringe_bitmap
);
11143 return make_number (-1); /* Use default arrow bitmap */
11145 return overlay_arrow_string_or_property (var
);
11152 /* Return 1 if point moved out of or into a composition. Otherwise
11153 return 0. PREV_BUF and PREV_PT are the last point buffer and
11154 position. BUF and PT are the current point buffer and position. */
11157 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11158 struct buffer
*prev_buf
, *buf
;
11161 EMACS_INT start
, end
;
11163 Lisp_Object buffer
;
11165 XSETBUFFER (buffer
, buf
);
11166 /* Check a composition at the last point if point moved within the
11168 if (prev_buf
== buf
)
11171 /* Point didn't move. */
11174 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11175 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11176 && COMPOSITION_VALID_P (start
, end
, prop
)
11177 && start
< prev_pt
&& end
> prev_pt
)
11178 /* The last point was within the composition. Return 1 iff
11179 point moved out of the composition. */
11180 return (pt
<= start
|| pt
>= end
);
11183 /* Check a composition at the current point. */
11184 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11185 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11186 && COMPOSITION_VALID_P (start
, end
, prop
)
11187 && start
< pt
&& end
> pt
);
11191 /* Reconsider the setting of B->clip_changed which is displayed
11195 reconsider_clip_changes (w
, b
)
11199 if (b
->clip_changed
11200 && !NILP (w
->window_end_valid
)
11201 && w
->current_matrix
->buffer
== b
11202 && w
->current_matrix
->zv
== BUF_ZV (b
)
11203 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11204 b
->clip_changed
= 0;
11206 /* If display wasn't paused, and W is not a tool bar window, see if
11207 point has been moved into or out of a composition. In that case,
11208 we set b->clip_changed to 1 to force updating the screen. If
11209 b->clip_changed has already been set to 1, we can skip this
11211 if (!b
->clip_changed
11212 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11216 if (w
== XWINDOW (selected_window
))
11217 pt
= BUF_PT (current_buffer
);
11219 pt
= marker_position (w
->pointm
);
11221 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11222 || pt
!= XINT (w
->last_point
))
11223 && check_point_in_composition (w
->current_matrix
->buffer
,
11224 XINT (w
->last_point
),
11225 XBUFFER (w
->buffer
), pt
))
11226 b
->clip_changed
= 1;
11231 /* Select FRAME to forward the values of frame-local variables into C
11232 variables so that the redisplay routines can access those values
11236 select_frame_for_redisplay (frame
)
11239 Lisp_Object tail
, symbol
, val
;
11240 Lisp_Object old
= selected_frame
;
11241 struct Lisp_Symbol
*sym
;
11243 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11245 selected_frame
= frame
;
11249 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11250 if (CONSP (XCAR (tail
))
11251 && (symbol
= XCAR (XCAR (tail
)),
11253 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11255 (BUFFER_LOCAL_VALUEP (val
)))
11256 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11257 /* Use find_symbol_value rather than Fsymbol_value
11258 to avoid an error if it is void. */
11259 find_symbol_value (symbol
);
11260 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11264 #define STOP_POLLING \
11265 do { if (! polling_stopped_here) stop_polling (); \
11266 polling_stopped_here = 1; } while (0)
11268 #define RESUME_POLLING \
11269 do { if (polling_stopped_here) start_polling (); \
11270 polling_stopped_here = 0; } while (0)
11273 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11274 response to any user action; therefore, we should preserve the echo
11275 area. (Actually, our caller does that job.) Perhaps in the future
11276 avoid recentering windows if it is not necessary; currently that
11277 causes some problems. */
11280 redisplay_internal (preserve_echo_area
)
11281 int preserve_echo_area
;
11283 struct window
*w
= XWINDOW (selected_window
);
11286 int must_finish
= 0;
11287 struct text_pos tlbufpos
, tlendpos
;
11288 int number_of_visible_frames
;
11291 int polling_stopped_here
= 0;
11292 Lisp_Object old_frame
= selected_frame
;
11294 /* Non-zero means redisplay has to consider all windows on all
11295 frames. Zero means, only selected_window is considered. */
11296 int consider_all_windows_p
;
11298 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11300 /* No redisplay if running in batch mode or frame is not yet fully
11301 initialized, or redisplay is explicitly turned off by setting
11302 Vinhibit_redisplay. */
11303 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11304 || !NILP (Vinhibit_redisplay
))
11307 /* Don't examine these until after testing Vinhibit_redisplay.
11308 When Emacs is shutting down, perhaps because its connection to
11309 X has dropped, we should not look at them at all. */
11310 f
= XFRAME (w
->frame
);
11311 sf
= SELECTED_FRAME ();
11313 if (!f
->glyphs_initialized_p
)
11316 /* The flag redisplay_performed_directly_p is set by
11317 direct_output_for_insert when it already did the whole screen
11318 update necessary. */
11319 if (redisplay_performed_directly_p
)
11321 redisplay_performed_directly_p
= 0;
11322 if (!hscroll_windows (selected_window
))
11326 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11327 if (popup_activated ())
11331 /* I don't think this happens but let's be paranoid. */
11332 if (redisplaying_p
)
11335 /* Record a function that resets redisplaying_p to its old value
11336 when we leave this function. */
11337 count
= SPECPDL_INDEX ();
11338 record_unwind_protect (unwind_redisplay
,
11339 Fcons (make_number (redisplaying_p
), selected_frame
));
11341 specbind (Qinhibit_free_realized_faces
, Qnil
);
11344 Lisp_Object tail
, frame
;
11346 FOR_EACH_FRAME (tail
, frame
)
11348 struct frame
*f
= XFRAME (frame
);
11349 f
->already_hscrolled_p
= 0;
11354 if (!EQ (old_frame
, selected_frame
)
11355 && FRAME_LIVE_P (XFRAME (old_frame
)))
11356 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11357 selected_frame and selected_window to be temporarily out-of-sync so
11358 when we come back here via `goto retry', we need to resync because we
11359 may need to run Elisp code (via prepare_menu_bars). */
11360 select_frame_for_redisplay (old_frame
);
11363 reconsider_clip_changes (w
, current_buffer
);
11364 last_escape_glyph_frame
= NULL
;
11365 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11367 /* If new fonts have been loaded that make a glyph matrix adjustment
11368 necessary, do it. */
11369 if (fonts_changed_p
)
11371 adjust_glyphs (NULL
);
11372 ++windows_or_buffers_changed
;
11373 fonts_changed_p
= 0;
11376 /* If face_change_count is non-zero, init_iterator will free all
11377 realized faces, which includes the faces referenced from current
11378 matrices. So, we can't reuse current matrices in this case. */
11379 if (face_change_count
)
11380 ++windows_or_buffers_changed
;
11382 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11383 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11385 /* Since frames on a single ASCII terminal share the same
11386 display area, displaying a different frame means redisplay
11387 the whole thing. */
11388 windows_or_buffers_changed
++;
11389 SET_FRAME_GARBAGED (sf
);
11391 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11393 FRAME_TTY (sf
)->previous_frame
= sf
;
11396 /* Set the visible flags for all frames. Do this before checking
11397 for resized or garbaged frames; they want to know if their frames
11398 are visible. See the comment in frame.h for
11399 FRAME_SAMPLE_VISIBILITY. */
11401 Lisp_Object tail
, frame
;
11403 number_of_visible_frames
= 0;
11405 FOR_EACH_FRAME (tail
, frame
)
11407 struct frame
*f
= XFRAME (frame
);
11409 FRAME_SAMPLE_VISIBILITY (f
);
11410 if (FRAME_VISIBLE_P (f
))
11411 ++number_of_visible_frames
;
11412 clear_desired_matrices (f
);
11417 /* Notice any pending interrupt request to change frame size. */
11418 do_pending_window_change (1);
11420 /* Clear frames marked as garbaged. */
11421 if (frame_garbaged
)
11422 clear_garbaged_frames ();
11424 /* Build menubar and tool-bar items. */
11425 if (NILP (Vmemory_full
))
11426 prepare_menu_bars ();
11428 if (windows_or_buffers_changed
)
11429 update_mode_lines
++;
11431 /* Detect case that we need to write or remove a star in the mode line. */
11432 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11434 w
->update_mode_line
= Qt
;
11435 if (buffer_shared
> 1)
11436 update_mode_lines
++;
11439 /* Avoid invocation of point motion hooks by `current_column' below. */
11440 count1
= SPECPDL_INDEX ();
11441 specbind (Qinhibit_point_motion_hooks
, Qt
);
11443 /* If %c is in the mode line, update it if needed. */
11444 if (!NILP (w
->column_number_displayed
)
11445 /* This alternative quickly identifies a common case
11446 where no change is needed. */
11447 && !(PT
== XFASTINT (w
->last_point
)
11448 && XFASTINT (w
->last_modified
) >= MODIFF
11449 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11450 && (XFASTINT (w
->column_number_displayed
)
11451 != (int) current_column ())) /* iftc */
11452 w
->update_mode_line
= Qt
;
11454 unbind_to (count1
, Qnil
);
11456 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11458 /* The variable buffer_shared is set in redisplay_window and
11459 indicates that we redisplay a buffer in different windows. See
11461 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11462 || cursor_type_changed
);
11464 /* If specs for an arrow have changed, do thorough redisplay
11465 to ensure we remove any arrow that should no longer exist. */
11466 if (overlay_arrows_changed_p ())
11467 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11469 /* Normally the message* functions will have already displayed and
11470 updated the echo area, but the frame may have been trashed, or
11471 the update may have been preempted, so display the echo area
11472 again here. Checking message_cleared_p captures the case that
11473 the echo area should be cleared. */
11474 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11475 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11476 || (message_cleared_p
11477 && minibuf_level
== 0
11478 /* If the mini-window is currently selected, this means the
11479 echo-area doesn't show through. */
11480 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11482 int window_height_changed_p
= echo_area_display (0);
11485 /* If we don't display the current message, don't clear the
11486 message_cleared_p flag, because, if we did, we wouldn't clear
11487 the echo area in the next redisplay which doesn't preserve
11489 if (!display_last_displayed_message_p
)
11490 message_cleared_p
= 0;
11492 if (fonts_changed_p
)
11494 else if (window_height_changed_p
)
11496 consider_all_windows_p
= 1;
11497 ++update_mode_lines
;
11498 ++windows_or_buffers_changed
;
11500 /* If window configuration was changed, frames may have been
11501 marked garbaged. Clear them or we will experience
11502 surprises wrt scrolling. */
11503 if (frame_garbaged
)
11504 clear_garbaged_frames ();
11507 else if (EQ (selected_window
, minibuf_window
)
11508 && (current_buffer
->clip_changed
11509 || XFASTINT (w
->last_modified
) < MODIFF
11510 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11511 && resize_mini_window (w
, 0))
11513 /* Resized active mini-window to fit the size of what it is
11514 showing if its contents might have changed. */
11516 /* FIXME: this causes all frames to be updated, which seems unnecessary
11517 since only the current frame needs to be considered. This function needs
11518 to be rewritten with two variables, consider_all_windows and
11519 consider_all_frames. */
11520 consider_all_windows_p
= 1;
11521 ++windows_or_buffers_changed
;
11522 ++update_mode_lines
;
11524 /* If window configuration was changed, frames may have been
11525 marked garbaged. Clear them or we will experience
11526 surprises wrt scrolling. */
11527 if (frame_garbaged
)
11528 clear_garbaged_frames ();
11532 /* If showing the region, and mark has changed, we must redisplay
11533 the whole window. The assignment to this_line_start_pos prevents
11534 the optimization directly below this if-statement. */
11535 if (((!NILP (Vtransient_mark_mode
)
11536 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11537 != !NILP (w
->region_showing
))
11538 || (!NILP (w
->region_showing
)
11539 && !EQ (w
->region_showing
,
11540 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11541 CHARPOS (this_line_start_pos
) = 0;
11543 /* Optimize the case that only the line containing the cursor in the
11544 selected window has changed. Variables starting with this_ are
11545 set in display_line and record information about the line
11546 containing the cursor. */
11547 tlbufpos
= this_line_start_pos
;
11548 tlendpos
= this_line_end_pos
;
11549 if (!consider_all_windows_p
11550 && CHARPOS (tlbufpos
) > 0
11551 && NILP (w
->update_mode_line
)
11552 && !current_buffer
->clip_changed
11553 && !current_buffer
->prevent_redisplay_optimizations_p
11554 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11555 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11556 /* Make sure recorded data applies to current buffer, etc. */
11557 && this_line_buffer
== current_buffer
11558 && current_buffer
== XBUFFER (w
->buffer
)
11559 && NILP (w
->force_start
)
11560 && NILP (w
->optional_new_start
)
11561 /* Point must be on the line that we have info recorded about. */
11562 && PT
>= CHARPOS (tlbufpos
)
11563 && PT
<= Z
- CHARPOS (tlendpos
)
11564 /* All text outside that line, including its final newline,
11565 must be unchanged */
11566 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11567 CHARPOS (tlendpos
)))
11569 if (CHARPOS (tlbufpos
) > BEGV
11570 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11571 && (CHARPOS (tlbufpos
) == ZV
11572 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11573 /* Former continuation line has disappeared by becoming empty */
11575 else if (XFASTINT (w
->last_modified
) < MODIFF
11576 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11577 || MINI_WINDOW_P (w
))
11579 /* We have to handle the case of continuation around a
11580 wide-column character (See the comment in indent.c around
11583 For instance, in the following case:
11585 -------- Insert --------
11586 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11587 J_I_ ==> J_I_ `^^' are cursors.
11591 As we have to redraw the line above, we should goto cancel. */
11594 int line_height_before
= this_line_pixel_height
;
11596 /* Note that start_display will handle the case that the
11597 line starting at tlbufpos is a continuation lines. */
11598 start_display (&it
, w
, tlbufpos
);
11600 /* Implementation note: It this still necessary? */
11601 if (it
.current_x
!= this_line_start_x
)
11604 TRACE ((stderr
, "trying display optimization 1\n"));
11605 w
->cursor
.vpos
= -1;
11606 overlay_arrow_seen
= 0;
11607 it
.vpos
= this_line_vpos
;
11608 it
.current_y
= this_line_y
;
11609 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11610 display_line (&it
);
11612 /* If line contains point, is not continued,
11613 and ends at same distance from eob as before, we win */
11614 if (w
->cursor
.vpos
>= 0
11615 /* Line is not continued, otherwise this_line_start_pos
11616 would have been set to 0 in display_line. */
11617 && CHARPOS (this_line_start_pos
)
11618 /* Line ends as before. */
11619 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11620 /* Line has same height as before. Otherwise other lines
11621 would have to be shifted up or down. */
11622 && this_line_pixel_height
== line_height_before
)
11624 /* If this is not the window's last line, we must adjust
11625 the charstarts of the lines below. */
11626 if (it
.current_y
< it
.last_visible_y
)
11628 struct glyph_row
*row
11629 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11630 int delta
, delta_bytes
;
11632 if (Z
- CHARPOS (tlendpos
) == ZV
)
11634 /* This line ends at end of (accessible part of)
11635 buffer. There is no newline to count. */
11637 - CHARPOS (tlendpos
)
11638 - MATRIX_ROW_START_CHARPOS (row
));
11639 delta_bytes
= (Z_BYTE
11640 - BYTEPOS (tlendpos
)
11641 - MATRIX_ROW_START_BYTEPOS (row
));
11645 /* This line ends in a newline. Must take
11646 account of the newline and the rest of the
11647 text that follows. */
11649 - CHARPOS (tlendpos
)
11650 - MATRIX_ROW_START_CHARPOS (row
));
11651 delta_bytes
= (Z_BYTE
11652 - BYTEPOS (tlendpos
)
11653 - MATRIX_ROW_START_BYTEPOS (row
));
11656 increment_matrix_positions (w
->current_matrix
,
11657 this_line_vpos
+ 1,
11658 w
->current_matrix
->nrows
,
11659 delta
, delta_bytes
);
11662 /* If this row displays text now but previously didn't,
11663 or vice versa, w->window_end_vpos may have to be
11665 if ((it
.glyph_row
- 1)->displays_text_p
)
11667 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11668 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11670 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11671 && this_line_vpos
> 0)
11672 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11673 w
->window_end_valid
= Qnil
;
11675 /* Update hint: No need to try to scroll in update_window. */
11676 w
->desired_matrix
->no_scrolling_p
= 1;
11679 *w
->desired_matrix
->method
= 0;
11680 debug_method_add (w
, "optimization 1");
11682 #ifdef HAVE_WINDOW_SYSTEM
11683 update_window_fringes (w
, 0);
11690 else if (/* Cursor position hasn't changed. */
11691 PT
== XFASTINT (w
->last_point
)
11692 /* Make sure the cursor was last displayed
11693 in this window. Otherwise we have to reposition it. */
11694 && 0 <= w
->cursor
.vpos
11695 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11699 do_pending_window_change (1);
11701 /* We used to always goto end_of_redisplay here, but this
11702 isn't enough if we have a blinking cursor. */
11703 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11704 goto end_of_redisplay
;
11708 /* If highlighting the region, or if the cursor is in the echo area,
11709 then we can't just move the cursor. */
11710 else if (! (!NILP (Vtransient_mark_mode
)
11711 && !NILP (current_buffer
->mark_active
))
11712 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11713 || highlight_nonselected_windows
)
11714 && NILP (w
->region_showing
)
11715 && NILP (Vshow_trailing_whitespace
)
11716 && !cursor_in_echo_area
)
11719 struct glyph_row
*row
;
11721 /* Skip from tlbufpos to PT and see where it is. Note that
11722 PT may be in invisible text. If so, we will end at the
11723 next visible position. */
11724 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11725 NULL
, DEFAULT_FACE_ID
);
11726 it
.current_x
= this_line_start_x
;
11727 it
.current_y
= this_line_y
;
11728 it
.vpos
= this_line_vpos
;
11730 /* The call to move_it_to stops in front of PT, but
11731 moves over before-strings. */
11732 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11734 if (it
.vpos
== this_line_vpos
11735 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11738 xassert (this_line_vpos
== it
.vpos
);
11739 xassert (this_line_y
== it
.current_y
);
11740 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11742 *w
->desired_matrix
->method
= 0;
11743 debug_method_add (w
, "optimization 3");
11752 /* Text changed drastically or point moved off of line. */
11753 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11756 CHARPOS (this_line_start_pos
) = 0;
11757 consider_all_windows_p
|= buffer_shared
> 1;
11758 ++clear_face_cache_count
;
11759 #ifdef HAVE_WINDOW_SYSTEM
11760 ++clear_image_cache_count
;
11763 /* Build desired matrices, and update the display. If
11764 consider_all_windows_p is non-zero, do it for all windows on all
11765 frames. Otherwise do it for selected_window, only. */
11767 if (consider_all_windows_p
)
11769 Lisp_Object tail
, frame
;
11771 FOR_EACH_FRAME (tail
, frame
)
11772 XFRAME (frame
)->updated_p
= 0;
11774 /* Recompute # windows showing selected buffer. This will be
11775 incremented each time such a window is displayed. */
11778 FOR_EACH_FRAME (tail
, frame
)
11780 struct frame
*f
= XFRAME (frame
);
11782 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11784 if (! EQ (frame
, selected_frame
))
11785 /* Select the frame, for the sake of frame-local
11787 select_frame_for_redisplay (frame
);
11789 /* Mark all the scroll bars to be removed; we'll redeem
11790 the ones we want when we redisplay their windows. */
11791 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11792 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11794 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11795 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11797 /* Any scroll bars which redisplay_windows should have
11798 nuked should now go away. */
11799 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11800 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11802 /* If fonts changed, display again. */
11803 /* ??? rms: I suspect it is a mistake to jump all the way
11804 back to retry here. It should just retry this frame. */
11805 if (fonts_changed_p
)
11808 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11810 /* See if we have to hscroll. */
11811 if (!f
->already_hscrolled_p
)
11813 f
->already_hscrolled_p
= 1;
11814 if (hscroll_windows (f
->root_window
))
11818 /* Prevent various kinds of signals during display
11819 update. stdio is not robust about handling
11820 signals, which can cause an apparent I/O
11822 if (interrupt_input
)
11823 unrequest_sigio ();
11826 /* Update the display. */
11827 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11828 pause
|= update_frame (f
, 0, 0);
11834 if (!EQ (old_frame
, selected_frame
)
11835 && FRAME_LIVE_P (XFRAME (old_frame
)))
11836 /* We played a bit fast-and-loose above and allowed selected_frame
11837 and selected_window to be temporarily out-of-sync but let's make
11838 sure this stays contained. */
11839 select_frame_for_redisplay (old_frame
);
11840 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11844 /* Do the mark_window_display_accurate after all windows have
11845 been redisplayed because this call resets flags in buffers
11846 which are needed for proper redisplay. */
11847 FOR_EACH_FRAME (tail
, frame
)
11849 struct frame
*f
= XFRAME (frame
);
11852 mark_window_display_accurate (f
->root_window
, 1);
11853 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11854 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11859 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11861 Lisp_Object mini_window
;
11862 struct frame
*mini_frame
;
11864 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11865 /* Use list_of_error, not Qerror, so that
11866 we catch only errors and don't run the debugger. */
11867 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11869 redisplay_window_error
);
11871 /* Compare desired and current matrices, perform output. */
11874 /* If fonts changed, display again. */
11875 if (fonts_changed_p
)
11878 /* Prevent various kinds of signals during display update.
11879 stdio is not robust about handling signals,
11880 which can cause an apparent I/O error. */
11881 if (interrupt_input
)
11882 unrequest_sigio ();
11885 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11887 if (hscroll_windows (selected_window
))
11890 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11891 pause
= update_frame (sf
, 0, 0);
11894 /* We may have called echo_area_display at the top of this
11895 function. If the echo area is on another frame, that may
11896 have put text on a frame other than the selected one, so the
11897 above call to update_frame would not have caught it. Catch
11899 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11900 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11902 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11904 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11905 pause
|= update_frame (mini_frame
, 0, 0);
11906 if (!pause
&& hscroll_windows (mini_window
))
11911 /* If display was paused because of pending input, make sure we do a
11912 thorough update the next time. */
11915 /* Prevent the optimization at the beginning of
11916 redisplay_internal that tries a single-line update of the
11917 line containing the cursor in the selected window. */
11918 CHARPOS (this_line_start_pos
) = 0;
11920 /* Let the overlay arrow be updated the next time. */
11921 update_overlay_arrows (0);
11923 /* If we pause after scrolling, some rows in the current
11924 matrices of some windows are not valid. */
11925 if (!WINDOW_FULL_WIDTH_P (w
)
11926 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11927 update_mode_lines
= 1;
11931 if (!consider_all_windows_p
)
11933 /* This has already been done above if
11934 consider_all_windows_p is set. */
11935 mark_window_display_accurate_1 (w
, 1);
11937 /* Say overlay arrows are up to date. */
11938 update_overlay_arrows (1);
11940 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11941 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11944 update_mode_lines
= 0;
11945 windows_or_buffers_changed
= 0;
11946 cursor_type_changed
= 0;
11949 /* Start SIGIO interrupts coming again. Having them off during the
11950 code above makes it less likely one will discard output, but not
11951 impossible, since there might be stuff in the system buffer here.
11952 But it is much hairier to try to do anything about that. */
11953 if (interrupt_input
)
11957 /* If a frame has become visible which was not before, redisplay
11958 again, so that we display it. Expose events for such a frame
11959 (which it gets when becoming visible) don't call the parts of
11960 redisplay constructing glyphs, so simply exposing a frame won't
11961 display anything in this case. So, we have to display these
11962 frames here explicitly. */
11965 Lisp_Object tail
, frame
;
11968 FOR_EACH_FRAME (tail
, frame
)
11970 int this_is_visible
= 0;
11972 if (XFRAME (frame
)->visible
)
11973 this_is_visible
= 1;
11974 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11975 if (XFRAME (frame
)->visible
)
11976 this_is_visible
= 1;
11978 if (this_is_visible
)
11982 if (new_count
!= number_of_visible_frames
)
11983 windows_or_buffers_changed
++;
11986 /* Change frame size now if a change is pending. */
11987 do_pending_window_change (1);
11989 /* If we just did a pending size change, or have additional
11990 visible frames, redisplay again. */
11991 if (windows_or_buffers_changed
&& !pause
)
11994 /* Clear the face cache eventually. */
11995 if (consider_all_windows_p
)
11997 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
11999 clear_face_cache (0);
12000 clear_face_cache_count
= 0;
12002 #ifdef HAVE_WINDOW_SYSTEM
12003 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12005 clear_image_caches (Qnil
);
12006 clear_image_cache_count
= 0;
12008 #endif /* HAVE_WINDOW_SYSTEM */
12012 unbind_to (count
, Qnil
);
12017 /* Redisplay, but leave alone any recent echo area message unless
12018 another message has been requested in its place.
12020 This is useful in situations where you need to redisplay but no
12021 user action has occurred, making it inappropriate for the message
12022 area to be cleared. See tracking_off and
12023 wait_reading_process_output for examples of these situations.
12025 FROM_WHERE is an integer saying from where this function was
12026 called. This is useful for debugging. */
12029 redisplay_preserve_echo_area (from_where
)
12032 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12034 if (!NILP (echo_area_buffer
[1]))
12036 /* We have a previously displayed message, but no current
12037 message. Redisplay the previous message. */
12038 display_last_displayed_message_p
= 1;
12039 redisplay_internal (1);
12040 display_last_displayed_message_p
= 0;
12043 redisplay_internal (1);
12045 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12046 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12047 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12051 /* Function registered with record_unwind_protect in
12052 redisplay_internal. Reset redisplaying_p to the value it had
12053 before redisplay_internal was called, and clear
12054 prevent_freeing_realized_faces_p. It also selects the previously
12055 selected frame, unless it has been deleted (by an X connection
12056 failure during redisplay, for example). */
12059 unwind_redisplay (val
)
12062 Lisp_Object old_redisplaying_p
, old_frame
;
12064 old_redisplaying_p
= XCAR (val
);
12065 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12066 old_frame
= XCDR (val
);
12067 if (! EQ (old_frame
, selected_frame
)
12068 && FRAME_LIVE_P (XFRAME (old_frame
)))
12069 select_frame_for_redisplay (old_frame
);
12074 /* Mark the display of window W as accurate or inaccurate. If
12075 ACCURATE_P is non-zero mark display of W as accurate. If
12076 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12077 redisplay_internal is called. */
12080 mark_window_display_accurate_1 (w
, accurate_p
)
12084 if (BUFFERP (w
->buffer
))
12086 struct buffer
*b
= XBUFFER (w
->buffer
);
12089 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12090 w
->last_overlay_modified
12091 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12093 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12097 b
->clip_changed
= 0;
12098 b
->prevent_redisplay_optimizations_p
= 0;
12100 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12101 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12102 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12103 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12105 w
->current_matrix
->buffer
= b
;
12106 w
->current_matrix
->begv
= BUF_BEGV (b
);
12107 w
->current_matrix
->zv
= BUF_ZV (b
);
12109 w
->last_cursor
= w
->cursor
;
12110 w
->last_cursor_off_p
= w
->cursor_off_p
;
12112 if (w
== XWINDOW (selected_window
))
12113 w
->last_point
= make_number (BUF_PT (b
));
12115 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12121 w
->window_end_valid
= w
->buffer
;
12122 w
->update_mode_line
= Qnil
;
12127 /* Mark the display of windows in the window tree rooted at WINDOW as
12128 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12129 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12130 be redisplayed the next time redisplay_internal is called. */
12133 mark_window_display_accurate (window
, accurate_p
)
12134 Lisp_Object window
;
12139 for (; !NILP (window
); window
= w
->next
)
12141 w
= XWINDOW (window
);
12142 mark_window_display_accurate_1 (w
, accurate_p
);
12144 if (!NILP (w
->vchild
))
12145 mark_window_display_accurate (w
->vchild
, accurate_p
);
12146 if (!NILP (w
->hchild
))
12147 mark_window_display_accurate (w
->hchild
, accurate_p
);
12152 update_overlay_arrows (1);
12156 /* Force a thorough redisplay the next time by setting
12157 last_arrow_position and last_arrow_string to t, which is
12158 unequal to any useful value of Voverlay_arrow_... */
12159 update_overlay_arrows (-1);
12164 /* Return value in display table DP (Lisp_Char_Table *) for character
12165 C. Since a display table doesn't have any parent, we don't have to
12166 follow parent. Do not call this function directly but use the
12167 macro DISP_CHAR_VECTOR. */
12170 disp_char_vector (dp
, c
)
12171 struct Lisp_Char_Table
*dp
;
12176 if (ASCII_CHAR_P (c
))
12179 if (SUB_CHAR_TABLE_P (val
))
12180 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12186 XSETCHAR_TABLE (table
, dp
);
12187 val
= char_table_ref (table
, c
);
12196 /***********************************************************************
12198 ***********************************************************************/
12200 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12203 redisplay_windows (window
)
12204 Lisp_Object window
;
12206 while (!NILP (window
))
12208 struct window
*w
= XWINDOW (window
);
12210 if (!NILP (w
->hchild
))
12211 redisplay_windows (w
->hchild
);
12212 else if (!NILP (w
->vchild
))
12213 redisplay_windows (w
->vchild
);
12216 displayed_buffer
= XBUFFER (w
->buffer
);
12217 /* Use list_of_error, not Qerror, so that
12218 we catch only errors and don't run the debugger. */
12219 internal_condition_case_1 (redisplay_window_0
, window
,
12221 redisplay_window_error
);
12229 redisplay_window_error ()
12231 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12236 redisplay_window_0 (window
)
12237 Lisp_Object window
;
12239 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12240 redisplay_window (window
, 0);
12245 redisplay_window_1 (window
)
12246 Lisp_Object window
;
12248 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12249 redisplay_window (window
, 1);
12254 /* Increment GLYPH until it reaches END or CONDITION fails while
12255 adding (GLYPH)->pixel_width to X. */
12257 #define SKIP_GLYPHS(glyph, end, x, condition) \
12260 (x) += (glyph)->pixel_width; \
12263 while ((glyph) < (end) && (condition))
12266 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12267 DELTA is the number of bytes by which positions recorded in ROW
12268 differ from current buffer positions.
12270 Return 0 if cursor is not on this row. 1 otherwise. */
12273 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12275 struct glyph_row
*row
;
12276 struct glyph_matrix
*matrix
;
12277 int delta
, delta_bytes
, dy
, dvpos
;
12279 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12280 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12281 struct glyph
*cursor
= NULL
;
12282 /* The first glyph that starts a sequence of glyphs from string. */
12283 struct glyph
*string_start
;
12284 /* The X coordinate of string_start. */
12285 int string_start_x
;
12286 /* The last known character position. */
12287 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12288 /* The last known character position before string_start. */
12289 int string_before_pos
;
12292 int cursor_from_overlay_pos
= 0;
12293 int pt_old
= PT
- delta
;
12295 /* Skip over glyphs not having an object at the start of the row.
12296 These are special glyphs like truncation marks on terminal
12298 if (row
->displays_text_p
)
12300 && INTEGERP (glyph
->object
)
12301 && glyph
->charpos
< 0)
12303 x
+= glyph
->pixel_width
;
12307 string_start
= NULL
;
12309 && !INTEGERP (glyph
->object
)
12310 && (!BUFFERP (glyph
->object
)
12311 || (last_pos
= glyph
->charpos
) < pt_old
12312 || glyph
->avoid_cursor_p
))
12314 if (! STRINGP (glyph
->object
))
12316 string_start
= NULL
;
12317 x
+= glyph
->pixel_width
;
12319 if (cursor_from_overlay_pos
12320 && last_pos
>= cursor_from_overlay_pos
)
12322 cursor_from_overlay_pos
= 0;
12328 if (string_start
== NULL
)
12330 string_before_pos
= last_pos
;
12331 string_start
= glyph
;
12332 string_start_x
= x
;
12334 /* Skip all glyphs from string. */
12339 if ((cursor
== NULL
|| glyph
> cursor
)
12340 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12341 Qcursor
, (glyph
)->object
),
12343 && (pos
= string_buffer_position (w
, glyph
->object
,
12344 string_before_pos
),
12345 (pos
== 0 /* From overlay */
12346 || pos
== pt_old
)))
12348 /* Estimate overlay buffer position from the buffer
12349 positions of the glyphs before and after the overlay.
12350 Add 1 to last_pos so that if point corresponds to the
12351 glyph right after the overlay, we still use a 'cursor'
12352 property found in that overlay. */
12353 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12354 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12358 x
+= glyph
->pixel_width
;
12361 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12365 if (cursor
!= NULL
)
12370 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12372 /* Scan back over the ellipsis glyphs, decrementing positions. */
12373 while (glyph
> row
->glyphs
[TEXT_AREA
]
12374 && (glyph
- 1)->charpos
== last_pos
)
12375 glyph
--, x
-= glyph
->pixel_width
;
12376 /* That loop always goes one position too far,
12377 including the glyph before the ellipsis.
12378 So scan forward over that one. */
12379 x
+= glyph
->pixel_width
;
12382 else if (string_start
12383 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12385 /* We may have skipped over point because the previous glyphs
12386 are from string. As there's no easy way to know the
12387 character position of the current glyph, find the correct
12388 glyph on point by scanning from string_start again. */
12390 Lisp_Object string
;
12391 struct glyph
*stop
= glyph
;
12394 limit
= make_number (pt_old
+ 1);
12395 glyph
= string_start
;
12396 x
= string_start_x
;
12397 string
= glyph
->object
;
12398 pos
= string_buffer_position (w
, string
, string_before_pos
);
12399 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12400 because we always put cursor after overlay strings. */
12401 while (pos
== 0 && glyph
< stop
)
12403 string
= glyph
->object
;
12404 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12406 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12409 while (glyph
< stop
)
12411 pos
= XINT (Fnext_single_char_property_change
12412 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12415 /* Skip glyphs from the same string. */
12416 string
= glyph
->object
;
12417 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12418 /* Skip glyphs from an overlay. */
12419 while (glyph
< stop
12420 && ! string_buffer_position (w
, glyph
->object
, pos
))
12422 string
= glyph
->object
;
12423 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12427 /* If we reached the end of the line, and end was from a string,
12428 cursor is not on this line. */
12429 if (glyph
== end
&& row
->continued_p
)
12433 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12435 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12436 w
->cursor
.y
= row
->y
+ dy
;
12438 if (w
== XWINDOW (selected_window
))
12440 if (!row
->continued_p
12441 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12444 this_line_buffer
= XBUFFER (w
->buffer
);
12446 CHARPOS (this_line_start_pos
)
12447 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12448 BYTEPOS (this_line_start_pos
)
12449 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12451 CHARPOS (this_line_end_pos
)
12452 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12453 BYTEPOS (this_line_end_pos
)
12454 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12456 this_line_y
= w
->cursor
.y
;
12457 this_line_pixel_height
= row
->height
;
12458 this_line_vpos
= w
->cursor
.vpos
;
12459 this_line_start_x
= row
->x
;
12462 CHARPOS (this_line_start_pos
) = 0;
12469 /* Run window scroll functions, if any, for WINDOW with new window
12470 start STARTP. Sets the window start of WINDOW to that position.
12472 We assume that the window's buffer is really current. */
12474 static INLINE
struct text_pos
12475 run_window_scroll_functions (window
, startp
)
12476 Lisp_Object window
;
12477 struct text_pos startp
;
12479 struct window
*w
= XWINDOW (window
);
12480 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12482 if (current_buffer
!= XBUFFER (w
->buffer
))
12485 if (!NILP (Vwindow_scroll_functions
))
12487 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12488 make_number (CHARPOS (startp
)));
12489 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12490 /* In case the hook functions switch buffers. */
12491 if (current_buffer
!= XBUFFER (w
->buffer
))
12492 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12499 /* Make sure the line containing the cursor is fully visible.
12500 A value of 1 means there is nothing to be done.
12501 (Either the line is fully visible, or it cannot be made so,
12502 or we cannot tell.)
12504 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12505 is higher than window.
12507 A value of 0 means the caller should do scrolling
12508 as if point had gone off the screen. */
12511 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12514 int current_matrix_p
;
12516 struct glyph_matrix
*matrix
;
12517 struct glyph_row
*row
;
12520 if (!make_cursor_line_fully_visible_p
)
12523 /* It's not always possible to find the cursor, e.g, when a window
12524 is full of overlay strings. Don't do anything in that case. */
12525 if (w
->cursor
.vpos
< 0)
12528 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12529 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12531 /* If the cursor row is not partially visible, there's nothing to do. */
12532 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12535 /* If the row the cursor is in is taller than the window's height,
12536 it's not clear what to do, so do nothing. */
12537 window_height
= window_box_height (w
);
12538 if (row
->height
>= window_height
)
12540 if (!force_p
|| MINI_WINDOW_P (w
)
12541 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12547 /* This code used to try to scroll the window just enough to make
12548 the line visible. It returned 0 to say that the caller should
12549 allocate larger glyph matrices. */
12551 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12553 int dy
= row
->height
- row
->visible_height
;
12556 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12558 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12560 int dy
= - (row
->height
- row
->visible_height
);
12563 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12566 /* When we change the cursor y-position of the selected window,
12567 change this_line_y as well so that the display optimization for
12568 the cursor line of the selected window in redisplay_internal uses
12569 the correct y-position. */
12570 if (w
== XWINDOW (selected_window
))
12571 this_line_y
= w
->cursor
.y
;
12573 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12574 redisplay with larger matrices. */
12575 if (matrix
->nrows
< required_matrix_height (w
))
12577 fonts_changed_p
= 1;
12586 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12587 non-zero means only WINDOW is redisplayed in redisplay_internal.
12588 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12589 in redisplay_window to bring a partially visible line into view in
12590 the case that only the cursor has moved.
12592 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12593 last screen line's vertical height extends past the end of the screen.
12597 1 if scrolling succeeded
12599 0 if scrolling didn't find point.
12601 -1 if new fonts have been loaded so that we must interrupt
12602 redisplay, adjust glyph matrices, and try again. */
12608 SCROLLING_NEED_LARGER_MATRICES
12612 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12613 scroll_step
, temp_scroll_step
, last_line_misfit
)
12614 Lisp_Object window
;
12615 int just_this_one_p
;
12616 EMACS_INT scroll_conservatively
, scroll_step
;
12617 int temp_scroll_step
;
12618 int last_line_misfit
;
12620 struct window
*w
= XWINDOW (window
);
12621 struct frame
*f
= XFRAME (w
->frame
);
12622 struct text_pos pos
, startp
;
12624 int this_scroll_margin
, scroll_max
, rc
, height
;
12625 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12626 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12627 Lisp_Object aggressive
;
12628 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12631 debug_method_add (w
, "try_scrolling");
12634 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12636 /* Compute scroll margin height in pixels. We scroll when point is
12637 within this distance from the top or bottom of the window. */
12638 if (scroll_margin
> 0)
12639 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
12640 * FRAME_LINE_HEIGHT (f
);
12642 this_scroll_margin
= 0;
12644 /* Force scroll_conservatively to have a reasonable value, to avoid
12645 overflow while computing how much to scroll. Note that the user
12646 can supply scroll-conservatively equal to `most-positive-fixnum',
12647 which can be larger than INT_MAX. */
12648 if (scroll_conservatively
> scroll_limit
)
12650 scroll_conservatively
= scroll_limit
;
12651 scroll_max
= INT_MAX
;
12653 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12654 /* Compute how much we should try to scroll maximally to bring
12655 point into view. */
12656 scroll_max
= (max (scroll_step
,
12657 max (scroll_conservatively
, temp_scroll_step
))
12658 * FRAME_LINE_HEIGHT (f
));
12659 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12660 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12661 /* We're trying to scroll because of aggressive scrolling but no
12662 scroll_step is set. Choose an arbitrary one. */
12663 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
12669 /* Decide whether to scroll down. */
12670 if (PT
> CHARPOS (startp
))
12672 int scroll_margin_y
;
12674 /* Compute the pixel ypos of the scroll margin, then move it to
12675 either that ypos or PT, whichever comes first. */
12676 start_display (&it
, w
, startp
);
12677 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
12678 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
12679 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
12680 (MOVE_TO_POS
| MOVE_TO_Y
));
12682 if (PT
> CHARPOS (it
.current
.pos
))
12684 int y0
= line_bottom_y (&it
);
12686 /* Compute the distance from the scroll margin to PT
12687 (including the height of the cursor line). Moving the
12688 iterator unconditionally to PT can be slow if PT is far
12689 away, so stop 10 lines past the window bottom (is there a
12690 way to do the right thing quickly?). */
12691 move_it_to (&it
, PT
, -1,
12692 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
12693 -1, MOVE_TO_POS
| MOVE_TO_Y
);
12694 dy
= line_bottom_y (&it
) - y0
;
12696 if (dy
> scroll_max
)
12697 return SCROLLING_FAILED
;
12705 /* Point is in or below the bottom scroll margin, so move the
12706 window start down. If scrolling conservatively, move it just
12707 enough down to make point visible. If scroll_step is set,
12708 move it down by scroll_step. */
12709 if (scroll_conservatively
)
12711 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12712 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12713 else if (scroll_step
|| temp_scroll_step
)
12714 amount_to_scroll
= scroll_max
;
12717 aggressive
= current_buffer
->scroll_up_aggressively
;
12718 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12719 if (NUMBERP (aggressive
))
12721 double float_amount
= XFLOATINT (aggressive
) * height
;
12722 amount_to_scroll
= float_amount
;
12723 if (amount_to_scroll
== 0 && float_amount
> 0)
12724 amount_to_scroll
= 1;
12728 if (amount_to_scroll
<= 0)
12729 return SCROLLING_FAILED
;
12731 start_display (&it
, w
, startp
);
12732 move_it_vertically (&it
, amount_to_scroll
);
12734 /* If STARTP is unchanged, move it down another screen line. */
12735 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12736 move_it_by_lines (&it
, 1, 1);
12737 startp
= it
.current
.pos
;
12741 struct text_pos scroll_margin_pos
= startp
;
12743 /* See if point is inside the scroll margin at the top of the
12745 if (this_scroll_margin
)
12747 start_display (&it
, w
, startp
);
12748 move_it_vertically (&it
, this_scroll_margin
);
12749 scroll_margin_pos
= it
.current
.pos
;
12752 if (PT
< CHARPOS (scroll_margin_pos
))
12754 /* Point is in the scroll margin at the top of the window or
12755 above what is displayed in the window. */
12758 /* Compute the vertical distance from PT to the scroll
12759 margin position. Give up if distance is greater than
12761 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12762 start_display (&it
, w
, pos
);
12764 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12765 it
.last_visible_y
, -1,
12766 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12767 dy
= it
.current_y
- y0
;
12768 if (dy
> scroll_max
)
12769 return SCROLLING_FAILED
;
12771 /* Compute new window start. */
12772 start_display (&it
, w
, startp
);
12774 if (scroll_conservatively
)
12776 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12777 else if (scroll_step
|| temp_scroll_step
)
12778 amount_to_scroll
= scroll_max
;
12781 aggressive
= current_buffer
->scroll_down_aggressively
;
12782 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12783 if (NUMBERP (aggressive
))
12785 double float_amount
= XFLOATINT (aggressive
) * height
;
12786 amount_to_scroll
= float_amount
;
12787 if (amount_to_scroll
== 0 && float_amount
> 0)
12788 amount_to_scroll
= 1;
12792 if (amount_to_scroll
<= 0)
12793 return SCROLLING_FAILED
;
12795 move_it_vertically_backward (&it
, amount_to_scroll
);
12796 startp
= it
.current
.pos
;
12800 /* Run window scroll functions. */
12801 startp
= run_window_scroll_functions (window
, startp
);
12803 /* Display the window. Give up if new fonts are loaded, or if point
12805 if (!try_window (window
, startp
, 0))
12806 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12807 else if (w
->cursor
.vpos
< 0)
12809 clear_glyph_matrix (w
->desired_matrix
);
12810 rc
= SCROLLING_FAILED
;
12814 /* Maybe forget recorded base line for line number display. */
12815 if (!just_this_one_p
12816 || current_buffer
->clip_changed
12817 || BEG_UNCHANGED
< CHARPOS (startp
))
12818 w
->base_line_number
= Qnil
;
12820 /* If cursor ends up on a partially visible line,
12821 treat that as being off the bottom of the screen. */
12822 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12824 clear_glyph_matrix (w
->desired_matrix
);
12825 ++extra_scroll_margin_lines
;
12828 rc
= SCROLLING_SUCCESS
;
12835 /* Compute a suitable window start for window W if display of W starts
12836 on a continuation line. Value is non-zero if a new window start
12839 The new window start will be computed, based on W's width, starting
12840 from the start of the continued line. It is the start of the
12841 screen line with the minimum distance from the old start W->start. */
12844 compute_window_start_on_continuation_line (w
)
12847 struct text_pos pos
, start_pos
;
12848 int window_start_changed_p
= 0;
12850 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12852 /* If window start is on a continuation line... Window start may be
12853 < BEGV in case there's invisible text at the start of the
12854 buffer (M-x rmail, for example). */
12855 if (CHARPOS (start_pos
) > BEGV
12856 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12859 struct glyph_row
*row
;
12861 /* Handle the case that the window start is out of range. */
12862 if (CHARPOS (start_pos
) < BEGV
)
12863 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12864 else if (CHARPOS (start_pos
) > ZV
)
12865 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12867 /* Find the start of the continued line. This should be fast
12868 because scan_buffer is fast (newline cache). */
12869 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12870 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12871 row
, DEFAULT_FACE_ID
);
12872 reseat_at_previous_visible_line_start (&it
);
12874 /* If the line start is "too far" away from the window start,
12875 say it takes too much time to compute a new window start. */
12876 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12877 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12879 int min_distance
, distance
;
12881 /* Move forward by display lines to find the new window
12882 start. If window width was enlarged, the new start can
12883 be expected to be > the old start. If window width was
12884 decreased, the new window start will be < the old start.
12885 So, we're looking for the display line start with the
12886 minimum distance from the old window start. */
12887 pos
= it
.current
.pos
;
12888 min_distance
= INFINITY
;
12889 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12890 distance
< min_distance
)
12892 min_distance
= distance
;
12893 pos
= it
.current
.pos
;
12894 move_it_by_lines (&it
, 1, 0);
12897 /* Set the window start there. */
12898 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12899 window_start_changed_p
= 1;
12903 return window_start_changed_p
;
12907 /* Try cursor movement in case text has not changed in window WINDOW,
12908 with window start STARTP. Value is
12910 CURSOR_MOVEMENT_SUCCESS if successful
12912 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12914 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12915 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12916 we want to scroll as if scroll-step were set to 1. See the code.
12918 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12919 which case we have to abort this redisplay, and adjust matrices
12924 CURSOR_MOVEMENT_SUCCESS
,
12925 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12926 CURSOR_MOVEMENT_MUST_SCROLL
,
12927 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12931 try_cursor_movement (window
, startp
, scroll_step
)
12932 Lisp_Object window
;
12933 struct text_pos startp
;
12936 struct window
*w
= XWINDOW (window
);
12937 struct frame
*f
= XFRAME (w
->frame
);
12938 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12941 if (inhibit_try_cursor_movement
)
12945 /* Handle case where text has not changed, only point, and it has
12946 not moved off the frame. */
12947 if (/* Point may be in this window. */
12948 PT
>= CHARPOS (startp
)
12949 /* Selective display hasn't changed. */
12950 && !current_buffer
->clip_changed
12951 /* Function force-mode-line-update is used to force a thorough
12952 redisplay. It sets either windows_or_buffers_changed or
12953 update_mode_lines. So don't take a shortcut here for these
12955 && !update_mode_lines
12956 && !windows_or_buffers_changed
12957 && !cursor_type_changed
12958 /* Can't use this case if highlighting a region. When a
12959 region exists, cursor movement has to do more than just
12961 && !(!NILP (Vtransient_mark_mode
)
12962 && !NILP (current_buffer
->mark_active
))
12963 && NILP (w
->region_showing
)
12964 && NILP (Vshow_trailing_whitespace
)
12965 /* Right after splitting windows, last_point may be nil. */
12966 && INTEGERP (w
->last_point
)
12967 /* This code is not used for mini-buffer for the sake of the case
12968 of redisplaying to replace an echo area message; since in
12969 that case the mini-buffer contents per se are usually
12970 unchanged. This code is of no real use in the mini-buffer
12971 since the handling of this_line_start_pos, etc., in redisplay
12972 handles the same cases. */
12973 && !EQ (window
, minibuf_window
)
12974 /* When splitting windows or for new windows, it happens that
12975 redisplay is called with a nil window_end_vpos or one being
12976 larger than the window. This should really be fixed in
12977 window.c. I don't have this on my list, now, so we do
12978 approximately the same as the old redisplay code. --gerd. */
12979 && INTEGERP (w
->window_end_vpos
)
12980 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12981 && (FRAME_WINDOW_P (f
)
12982 || !overlay_arrow_in_current_buffer_p ()))
12984 int this_scroll_margin
, top_scroll_margin
;
12985 struct glyph_row
*row
= NULL
;
12988 debug_method_add (w
, "cursor movement");
12991 /* Scroll if point within this distance from the top or bottom
12992 of the window. This is a pixel value. */
12993 if (scroll_margin
> 0)
12995 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12996 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12999 this_scroll_margin
= 0;
13001 top_scroll_margin
= this_scroll_margin
;
13002 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13003 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13005 /* Start with the row the cursor was displayed during the last
13006 not paused redisplay. Give up if that row is not valid. */
13007 if (w
->last_cursor
.vpos
< 0
13008 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13009 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13012 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13013 if (row
->mode_line_p
)
13015 if (!row
->enabled_p
)
13016 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13019 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13022 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13024 if (PT
> XFASTINT (w
->last_point
))
13026 /* Point has moved forward. */
13027 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13028 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13030 xassert (row
->enabled_p
);
13034 /* The end position of a row equals the start position
13035 of the next row. If PT is there, we would rather
13036 display it in the next line. */
13037 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13038 && MATRIX_ROW_END_CHARPOS (row
) == PT
13039 && !cursor_row_p (w
, row
))
13042 /* If within the scroll margin, scroll. Note that
13043 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13044 the next line would be drawn, and that
13045 this_scroll_margin can be zero. */
13046 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13047 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13048 /* Line is completely visible last line in window
13049 and PT is to be set in the next line. */
13050 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13051 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13052 && !row
->ends_at_zv_p
13053 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13056 else if (PT
< XFASTINT (w
->last_point
))
13058 /* Cursor has to be moved backward. Note that PT >=
13059 CHARPOS (startp) because of the outer if-statement. */
13060 while (!row
->mode_line_p
13061 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13062 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13063 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13064 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13065 row
> w
->current_matrix
->rows
13066 && (row
-1)->ends_in_newline_from_string_p
))))
13067 && (row
->y
> top_scroll_margin
13068 || CHARPOS (startp
) == BEGV
))
13070 xassert (row
->enabled_p
);
13074 /* Consider the following case: Window starts at BEGV,
13075 there is invisible, intangible text at BEGV, so that
13076 display starts at some point START > BEGV. It can
13077 happen that we are called with PT somewhere between
13078 BEGV and START. Try to handle that case. */
13079 if (row
< w
->current_matrix
->rows
13080 || row
->mode_line_p
)
13082 row
= w
->current_matrix
->rows
;
13083 if (row
->mode_line_p
)
13087 /* Due to newlines in overlay strings, we may have to
13088 skip forward over overlay strings. */
13089 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13090 && MATRIX_ROW_END_CHARPOS (row
) == PT
13091 && !cursor_row_p (w
, row
))
13094 /* If within the scroll margin, scroll. */
13095 if (row
->y
< top_scroll_margin
13096 && CHARPOS (startp
) != BEGV
)
13101 /* Cursor did not move. So don't scroll even if cursor line
13102 is partially visible, as it was so before. */
13103 rc
= CURSOR_MOVEMENT_SUCCESS
;
13106 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13107 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13109 /* if PT is not in the glyph row, give up. */
13110 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13112 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13113 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13114 && make_cursor_line_fully_visible_p
)
13116 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13117 && !row
->ends_at_zv_p
13118 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13119 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13120 else if (row
->height
> window_box_height (w
))
13122 /* If we end up in a partially visible line, let's
13123 make it fully visible, except when it's taller
13124 than the window, in which case we can't do much
13127 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13131 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13132 if (!cursor_row_fully_visible_p (w
, 0, 1))
13133 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13135 rc
= CURSOR_MOVEMENT_SUCCESS
;
13139 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13144 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13146 rc
= CURSOR_MOVEMENT_SUCCESS
;
13151 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13152 && MATRIX_ROW_START_CHARPOS (row
) == PT
13153 && cursor_row_p (w
, row
));
13162 set_vertical_scroll_bar (w
)
13165 int start
, end
, whole
;
13167 /* Calculate the start and end positions for the current window.
13168 At some point, it would be nice to choose between scrollbars
13169 which reflect the whole buffer size, with special markers
13170 indicating narrowing, and scrollbars which reflect only the
13173 Note that mini-buffers sometimes aren't displaying any text. */
13174 if (!MINI_WINDOW_P (w
)
13175 || (w
== XWINDOW (minibuf_window
)
13176 && NILP (echo_area_buffer
[0])))
13178 struct buffer
*buf
= XBUFFER (w
->buffer
);
13179 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13180 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13181 /* I don't think this is guaranteed to be right. For the
13182 moment, we'll pretend it is. */
13183 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13187 if (whole
< (end
- start
))
13188 whole
= end
- start
;
13191 start
= end
= whole
= 0;
13193 /* Indicate what this scroll bar ought to be displaying now. */
13194 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13195 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13196 (w
, end
- start
, whole
, start
);
13200 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13201 selected_window is redisplayed.
13203 We can return without actually redisplaying the window if
13204 fonts_changed_p is nonzero. In that case, redisplay_internal will
13208 redisplay_window (window
, just_this_one_p
)
13209 Lisp_Object window
;
13210 int just_this_one_p
;
13212 struct window
*w
= XWINDOW (window
);
13213 struct frame
*f
= XFRAME (w
->frame
);
13214 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13215 struct buffer
*old
= current_buffer
;
13216 struct text_pos lpoint
, opoint
, startp
;
13217 int update_mode_line
;
13220 /* Record it now because it's overwritten. */
13221 int current_matrix_up_to_date_p
= 0;
13222 int used_current_matrix_p
= 0;
13223 /* This is less strict than current_matrix_up_to_date_p.
13224 It indictes that the buffer contents and narrowing are unchanged. */
13225 int buffer_unchanged_p
= 0;
13226 int temp_scroll_step
= 0;
13227 int count
= SPECPDL_INDEX ();
13229 int centering_position
= -1;
13230 int last_line_misfit
= 0;
13231 int beg_unchanged
, end_unchanged
;
13233 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13236 /* W must be a leaf window here. */
13237 xassert (!NILP (w
->buffer
));
13239 *w
->desired_matrix
->method
= 0;
13243 reconsider_clip_changes (w
, buffer
);
13245 /* Has the mode line to be updated? */
13246 update_mode_line
= (!NILP (w
->update_mode_line
)
13247 || update_mode_lines
13248 || buffer
->clip_changed
13249 || buffer
->prevent_redisplay_optimizations_p
);
13251 if (MINI_WINDOW_P (w
))
13253 if (w
== XWINDOW (echo_area_window
)
13254 && !NILP (echo_area_buffer
[0]))
13256 if (update_mode_line
)
13257 /* We may have to update a tty frame's menu bar or a
13258 tool-bar. Example `M-x C-h C-h C-g'. */
13259 goto finish_menu_bars
;
13261 /* We've already displayed the echo area glyphs in this window. */
13262 goto finish_scroll_bars
;
13264 else if ((w
!= XWINDOW (minibuf_window
)
13265 || minibuf_level
== 0)
13266 /* When buffer is nonempty, redisplay window normally. */
13267 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13268 /* Quail displays non-mini buffers in minibuffer window.
13269 In that case, redisplay the window normally. */
13270 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13272 /* W is a mini-buffer window, but it's not active, so clear
13274 int yb
= window_text_bottom_y (w
);
13275 struct glyph_row
*row
;
13278 for (y
= 0, row
= w
->desired_matrix
->rows
;
13280 y
+= row
->height
, ++row
)
13281 blank_row (w
, row
, y
);
13282 goto finish_scroll_bars
;
13285 clear_glyph_matrix (w
->desired_matrix
);
13288 /* Otherwise set up data on this window; select its buffer and point
13290 /* Really select the buffer, for the sake of buffer-local
13292 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13294 current_matrix_up_to_date_p
13295 = (!NILP (w
->window_end_valid
)
13296 && !current_buffer
->clip_changed
13297 && !current_buffer
->prevent_redisplay_optimizations_p
13298 && XFASTINT (w
->last_modified
) >= MODIFF
13299 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13301 /* Run the window-bottom-change-functions
13302 if it is possible that the text on the screen has changed
13303 (either due to modification of the text, or any other reason). */
13304 if (!current_matrix_up_to_date_p
13305 && !NILP (Vwindow_text_change_functions
))
13307 safe_run_hooks (Qwindow_text_change_functions
);
13311 beg_unchanged
= BEG_UNCHANGED
;
13312 end_unchanged
= END_UNCHANGED
;
13314 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13316 specbind (Qinhibit_point_motion_hooks
, Qt
);
13319 = (!NILP (w
->window_end_valid
)
13320 && !current_buffer
->clip_changed
13321 && XFASTINT (w
->last_modified
) >= MODIFF
13322 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13324 /* When windows_or_buffers_changed is non-zero, we can't rely on
13325 the window end being valid, so set it to nil there. */
13326 if (windows_or_buffers_changed
)
13328 /* If window starts on a continuation line, maybe adjust the
13329 window start in case the window's width changed. */
13330 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13331 compute_window_start_on_continuation_line (w
);
13333 w
->window_end_valid
= Qnil
;
13336 /* Some sanity checks. */
13337 CHECK_WINDOW_END (w
);
13338 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13340 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13343 /* If %c is in mode line, update it if needed. */
13344 if (!NILP (w
->column_number_displayed
)
13345 /* This alternative quickly identifies a common case
13346 where no change is needed. */
13347 && !(PT
== XFASTINT (w
->last_point
)
13348 && XFASTINT (w
->last_modified
) >= MODIFF
13349 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13350 && (XFASTINT (w
->column_number_displayed
)
13351 != (int) current_column ())) /* iftc */
13352 update_mode_line
= 1;
13354 /* Count number of windows showing the selected buffer. An indirect
13355 buffer counts as its base buffer. */
13356 if (!just_this_one_p
)
13358 struct buffer
*current_base
, *window_base
;
13359 current_base
= current_buffer
;
13360 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13361 if (current_base
->base_buffer
)
13362 current_base
= current_base
->base_buffer
;
13363 if (window_base
->base_buffer
)
13364 window_base
= window_base
->base_buffer
;
13365 if (current_base
== window_base
)
13369 /* Point refers normally to the selected window. For any other
13370 window, set up appropriate value. */
13371 if (!EQ (window
, selected_window
))
13373 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13374 int new_pt_byte
= marker_byte_position (w
->pointm
);
13378 new_pt_byte
= BEGV_BYTE
;
13379 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13381 else if (new_pt
> (ZV
- 1))
13384 new_pt_byte
= ZV_BYTE
;
13385 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13388 /* We don't use SET_PT so that the point-motion hooks don't run. */
13389 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13392 /* If any of the character widths specified in the display table
13393 have changed, invalidate the width run cache. It's true that
13394 this may be a bit late to catch such changes, but the rest of
13395 redisplay goes (non-fatally) haywire when the display table is
13396 changed, so why should we worry about doing any better? */
13397 if (current_buffer
->width_run_cache
)
13399 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13401 if (! disptab_matches_widthtab (disptab
,
13402 XVECTOR (current_buffer
->width_table
)))
13404 invalidate_region_cache (current_buffer
,
13405 current_buffer
->width_run_cache
,
13407 recompute_width_table (current_buffer
, disptab
);
13411 /* If window-start is screwed up, choose a new one. */
13412 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13415 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13417 /* If someone specified a new starting point but did not insist,
13418 check whether it can be used. */
13419 if (!NILP (w
->optional_new_start
)
13420 && CHARPOS (startp
) >= BEGV
13421 && CHARPOS (startp
) <= ZV
)
13423 w
->optional_new_start
= Qnil
;
13424 start_display (&it
, w
, startp
);
13425 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13426 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13427 if (IT_CHARPOS (it
) == PT
)
13428 w
->force_start
= Qt
;
13429 /* IT may overshoot PT if text at PT is invisible. */
13430 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13431 w
->force_start
= Qt
;
13436 /* Handle case where place to start displaying has been specified,
13437 unless the specified location is outside the accessible range. */
13438 if (!NILP (w
->force_start
)
13439 || w
->frozen_window_start_p
)
13441 /* We set this later on if we have to adjust point. */
13444 w
->force_start
= Qnil
;
13446 w
->window_end_valid
= Qnil
;
13448 /* Forget any recorded base line for line number display. */
13449 if (!buffer_unchanged_p
)
13450 w
->base_line_number
= Qnil
;
13452 /* Redisplay the mode line. Select the buffer properly for that.
13453 Also, run the hook window-scroll-functions
13454 because we have scrolled. */
13455 /* Note, we do this after clearing force_start because
13456 if there's an error, it is better to forget about force_start
13457 than to get into an infinite loop calling the hook functions
13458 and having them get more errors. */
13459 if (!update_mode_line
13460 || ! NILP (Vwindow_scroll_functions
))
13462 update_mode_line
= 1;
13463 w
->update_mode_line
= Qt
;
13464 startp
= run_window_scroll_functions (window
, startp
);
13467 w
->last_modified
= make_number (0);
13468 w
->last_overlay_modified
= make_number (0);
13469 if (CHARPOS (startp
) < BEGV
)
13470 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13471 else if (CHARPOS (startp
) > ZV
)
13472 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13474 /* Redisplay, then check if cursor has been set during the
13475 redisplay. Give up if new fonts were loaded. */
13476 /* We used to issue a CHECK_MARGINS argument to try_window here,
13477 but this causes scrolling to fail when point begins inside
13478 the scroll margin (bug#148) -- cyd */
13479 if (!try_window (window
, startp
, 0))
13481 w
->force_start
= Qt
;
13482 clear_glyph_matrix (w
->desired_matrix
);
13483 goto need_larger_matrices
;
13486 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13488 /* If point does not appear, try to move point so it does
13489 appear. The desired matrix has been built above, so we
13490 can use it here. */
13491 new_vpos
= window_box_height (w
) / 2;
13494 if (!cursor_row_fully_visible_p (w
, 0, 0))
13496 /* Point does appear, but on a line partly visible at end of window.
13497 Move it back to a fully-visible line. */
13498 new_vpos
= window_box_height (w
);
13501 /* If we need to move point for either of the above reasons,
13502 now actually do it. */
13505 struct glyph_row
*row
;
13507 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13508 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13511 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13512 MATRIX_ROW_START_BYTEPOS (row
));
13514 if (w
!= XWINDOW (selected_window
))
13515 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13516 else if (current_buffer
== old
)
13517 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13519 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13521 /* If we are highlighting the region, then we just changed
13522 the region, so redisplay to show it. */
13523 if (!NILP (Vtransient_mark_mode
)
13524 && !NILP (current_buffer
->mark_active
))
13526 clear_glyph_matrix (w
->desired_matrix
);
13527 if (!try_window (window
, startp
, 0))
13528 goto need_larger_matrices
;
13533 debug_method_add (w
, "forced window start");
13538 /* Handle case where text has not changed, only point, and it has
13539 not moved off the frame, and we are not retrying after hscroll.
13540 (current_matrix_up_to_date_p is nonzero when retrying.) */
13541 if (current_matrix_up_to_date_p
13542 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13543 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13547 case CURSOR_MOVEMENT_SUCCESS
:
13548 used_current_matrix_p
= 1;
13551 #if 0 /* try_cursor_movement never returns this value. */
13552 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13553 goto need_larger_matrices
;
13556 case CURSOR_MOVEMENT_MUST_SCROLL
:
13557 goto try_to_scroll
;
13563 /* If current starting point was originally the beginning of a line
13564 but no longer is, find a new starting point. */
13565 else if (!NILP (w
->start_at_line_beg
)
13566 && !(CHARPOS (startp
) <= BEGV
13567 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13570 debug_method_add (w
, "recenter 1");
13575 /* Try scrolling with try_window_id. Value is > 0 if update has
13576 been done, it is -1 if we know that the same window start will
13577 not work. It is 0 if unsuccessful for some other reason. */
13578 else if ((tem
= try_window_id (w
)) != 0)
13581 debug_method_add (w
, "try_window_id %d", tem
);
13584 if (fonts_changed_p
)
13585 goto need_larger_matrices
;
13589 /* Otherwise try_window_id has returned -1 which means that we
13590 don't want the alternative below this comment to execute. */
13592 else if (CHARPOS (startp
) >= BEGV
13593 && CHARPOS (startp
) <= ZV
13594 && PT
>= CHARPOS (startp
)
13595 && (CHARPOS (startp
) < ZV
13596 /* Avoid starting at end of buffer. */
13597 || CHARPOS (startp
) == BEGV
13598 || (XFASTINT (w
->last_modified
) >= MODIFF
13599 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13602 /* If first window line is a continuation line, and window start
13603 is inside the modified region, but the first change is before
13604 current window start, we must select a new window start.
13606 However, if this is the result of a down-mouse event (e.g. by
13607 extending the mouse-drag-overlay), we don't want to select a
13608 new window start, since that would change the position under
13609 the mouse, resulting in an unwanted mouse-movement rather
13610 than a simple mouse-click. */
13611 if (NILP (w
->start_at_line_beg
)
13612 && NILP (do_mouse_tracking
)
13613 && CHARPOS (startp
) > BEGV
13614 && CHARPOS (startp
) > BEG
+ beg_unchanged
13615 && CHARPOS (startp
) <= Z
- end_unchanged
13616 /* Even if w->start_at_line_beg is nil, a new window may
13617 start at a line_beg, since that's how set_buffer_window
13618 sets it. So, we need to check the return value of
13619 compute_window_start_on_continuation_line. (See also
13621 && XMARKER (w
->start
)->buffer
== current_buffer
13622 && compute_window_start_on_continuation_line (w
))
13624 w
->force_start
= Qt
;
13625 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13630 debug_method_add (w
, "same window start");
13633 /* Try to redisplay starting at same place as before.
13634 If point has not moved off frame, accept the results. */
13635 if (!current_matrix_up_to_date_p
13636 /* Don't use try_window_reusing_current_matrix in this case
13637 because a window scroll function can have changed the
13639 || !NILP (Vwindow_scroll_functions
)
13640 || MINI_WINDOW_P (w
)
13641 || !(used_current_matrix_p
13642 = try_window_reusing_current_matrix (w
)))
13644 IF_DEBUG (debug_method_add (w
, "1"));
13645 if (try_window (window
, startp
, 1) < 0)
13646 /* -1 means we need to scroll.
13647 0 means we need new matrices, but fonts_changed_p
13648 is set in that case, so we will detect it below. */
13649 goto try_to_scroll
;
13652 if (fonts_changed_p
)
13653 goto need_larger_matrices
;
13655 if (w
->cursor
.vpos
>= 0)
13657 if (!just_this_one_p
13658 || current_buffer
->clip_changed
13659 || BEG_UNCHANGED
< CHARPOS (startp
))
13660 /* Forget any recorded base line for line number display. */
13661 w
->base_line_number
= Qnil
;
13663 if (!cursor_row_fully_visible_p (w
, 1, 0))
13665 clear_glyph_matrix (w
->desired_matrix
);
13666 last_line_misfit
= 1;
13668 /* Drop through and scroll. */
13673 clear_glyph_matrix (w
->desired_matrix
);
13678 w
->last_modified
= make_number (0);
13679 w
->last_overlay_modified
= make_number (0);
13681 /* Redisplay the mode line. Select the buffer properly for that. */
13682 if (!update_mode_line
)
13684 update_mode_line
= 1;
13685 w
->update_mode_line
= Qt
;
13688 /* Try to scroll by specified few lines. */
13689 if ((scroll_conservatively
13691 || temp_scroll_step
13692 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13693 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13694 && !current_buffer
->clip_changed
13695 && CHARPOS (startp
) >= BEGV
13696 && CHARPOS (startp
) <= ZV
)
13698 /* The function returns -1 if new fonts were loaded, 1 if
13699 successful, 0 if not successful. */
13700 int rc
= try_scrolling (window
, just_this_one_p
,
13701 scroll_conservatively
,
13703 temp_scroll_step
, last_line_misfit
);
13706 case SCROLLING_SUCCESS
:
13709 case SCROLLING_NEED_LARGER_MATRICES
:
13710 goto need_larger_matrices
;
13712 case SCROLLING_FAILED
:
13720 /* Finally, just choose place to start which centers point */
13723 if (centering_position
< 0)
13724 centering_position
= window_box_height (w
) / 2;
13727 debug_method_add (w
, "recenter");
13730 /* w->vscroll = 0; */
13732 /* Forget any previously recorded base line for line number display. */
13733 if (!buffer_unchanged_p
)
13734 w
->base_line_number
= Qnil
;
13736 /* Move backward half the height of the window. */
13737 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13738 it
.current_y
= it
.last_visible_y
;
13739 move_it_vertically_backward (&it
, centering_position
);
13740 xassert (IT_CHARPOS (it
) >= BEGV
);
13742 /* The function move_it_vertically_backward may move over more
13743 than the specified y-distance. If it->w is small, e.g. a
13744 mini-buffer window, we may end up in front of the window's
13745 display area. Start displaying at the start of the line
13746 containing PT in this case. */
13747 if (it
.current_y
<= 0)
13749 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13750 move_it_vertically_backward (&it
, 0);
13754 it
.current_x
= it
.hpos
= 0;
13756 /* Set startp here explicitly in case that helps avoid an infinite loop
13757 in case the window-scroll-functions functions get errors. */
13758 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13760 /* Run scroll hooks. */
13761 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13763 /* Redisplay the window. */
13764 if (!current_matrix_up_to_date_p
13765 || windows_or_buffers_changed
13766 || cursor_type_changed
13767 /* Don't use try_window_reusing_current_matrix in this case
13768 because it can have changed the buffer. */
13769 || !NILP (Vwindow_scroll_functions
)
13770 || !just_this_one_p
13771 || MINI_WINDOW_P (w
)
13772 || !(used_current_matrix_p
13773 = try_window_reusing_current_matrix (w
)))
13774 try_window (window
, startp
, 0);
13776 /* If new fonts have been loaded (due to fontsets), give up. We
13777 have to start a new redisplay since we need to re-adjust glyph
13779 if (fonts_changed_p
)
13780 goto need_larger_matrices
;
13782 /* If cursor did not appear assume that the middle of the window is
13783 in the first line of the window. Do it again with the next line.
13784 (Imagine a window of height 100, displaying two lines of height
13785 60. Moving back 50 from it->last_visible_y will end in the first
13787 if (w
->cursor
.vpos
< 0)
13789 if (!NILP (w
->window_end_valid
)
13790 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13792 clear_glyph_matrix (w
->desired_matrix
);
13793 move_it_by_lines (&it
, 1, 0);
13794 try_window (window
, it
.current
.pos
, 0);
13796 else if (PT
< IT_CHARPOS (it
))
13798 clear_glyph_matrix (w
->desired_matrix
);
13799 move_it_by_lines (&it
, -1, 0);
13800 try_window (window
, it
.current
.pos
, 0);
13804 /* Not much we can do about it. */
13808 /* Consider the following case: Window starts at BEGV, there is
13809 invisible, intangible text at BEGV, so that display starts at
13810 some point START > BEGV. It can happen that we are called with
13811 PT somewhere between BEGV and START. Try to handle that case. */
13812 if (w
->cursor
.vpos
< 0)
13814 struct glyph_row
*row
= w
->current_matrix
->rows
;
13815 if (row
->mode_line_p
)
13817 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13820 if (!cursor_row_fully_visible_p (w
, 0, 0))
13822 /* If vscroll is enabled, disable it and try again. */
13826 clear_glyph_matrix (w
->desired_matrix
);
13830 /* If centering point failed to make the whole line visible,
13831 put point at the top instead. That has to make the whole line
13832 visible, if it can be done. */
13833 if (centering_position
== 0)
13836 clear_glyph_matrix (w
->desired_matrix
);
13837 centering_position
= 0;
13843 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13844 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13845 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13848 /* Display the mode line, if we must. */
13849 if ((update_mode_line
13850 /* If window not full width, must redo its mode line
13851 if (a) the window to its side is being redone and
13852 (b) we do a frame-based redisplay. This is a consequence
13853 of how inverted lines are drawn in frame-based redisplay. */
13854 || (!just_this_one_p
13855 && !FRAME_WINDOW_P (f
)
13856 && !WINDOW_FULL_WIDTH_P (w
))
13857 /* Line number to display. */
13858 || INTEGERP (w
->base_line_pos
)
13859 /* Column number is displayed and different from the one displayed. */
13860 || (!NILP (w
->column_number_displayed
)
13861 && (XFASTINT (w
->column_number_displayed
)
13862 != (int) current_column ()))) /* iftc */
13863 /* This means that the window has a mode line. */
13864 && (WINDOW_WANTS_MODELINE_P (w
)
13865 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13867 display_mode_lines (w
);
13869 /* If mode line height has changed, arrange for a thorough
13870 immediate redisplay using the correct mode line height. */
13871 if (WINDOW_WANTS_MODELINE_P (w
)
13872 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13874 fonts_changed_p
= 1;
13875 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13876 = DESIRED_MODE_LINE_HEIGHT (w
);
13879 /* If top line height has changed, arrange for a thorough
13880 immediate redisplay using the correct mode line height. */
13881 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13882 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13884 fonts_changed_p
= 1;
13885 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13886 = DESIRED_HEADER_LINE_HEIGHT (w
);
13889 if (fonts_changed_p
)
13890 goto need_larger_matrices
;
13893 if (!line_number_displayed
13894 && !BUFFERP (w
->base_line_pos
))
13896 w
->base_line_pos
= Qnil
;
13897 w
->base_line_number
= Qnil
;
13902 /* When we reach a frame's selected window, redo the frame's menu bar. */
13903 if (update_mode_line
13904 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13906 int redisplay_menu_p
= 0;
13907 int redisplay_tool_bar_p
= 0;
13909 if (FRAME_WINDOW_P (f
))
13911 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13912 || defined (HAVE_NS) || defined (USE_GTK)
13913 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13915 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13919 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13921 if (redisplay_menu_p
)
13922 display_menu_bar (w
);
13924 #ifdef HAVE_WINDOW_SYSTEM
13925 if (FRAME_WINDOW_P (f
))
13927 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
13928 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13930 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13931 && (FRAME_TOOL_BAR_LINES (f
) > 0
13932 || !NILP (Vauto_resize_tool_bars
));
13935 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13937 extern int ignore_mouse_drag_p
;
13938 ignore_mouse_drag_p
= 1;
13944 #ifdef HAVE_WINDOW_SYSTEM
13945 if (FRAME_WINDOW_P (f
)
13946 && update_window_fringes (w
, (just_this_one_p
13947 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13948 || w
->pseudo_window_p
)))
13952 if (draw_window_fringes (w
, 1))
13953 x_draw_vertical_border (w
);
13957 #endif /* HAVE_WINDOW_SYSTEM */
13959 /* We go to this label, with fonts_changed_p nonzero,
13960 if it is necessary to try again using larger glyph matrices.
13961 We have to redeem the scroll bar even in this case,
13962 because the loop in redisplay_internal expects that. */
13963 need_larger_matrices
:
13965 finish_scroll_bars
:
13967 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13969 /* Set the thumb's position and size. */
13970 set_vertical_scroll_bar (w
);
13972 /* Note that we actually used the scroll bar attached to this
13973 window, so it shouldn't be deleted at the end of redisplay. */
13974 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13975 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13978 /* Restore current_buffer and value of point in it. */
13979 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13980 set_buffer_internal_1 (old
);
13981 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13982 shorter. This can be caused by log truncation in *Messages*. */
13983 if (CHARPOS (lpoint
) <= ZV
)
13984 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13986 unbind_to (count
, Qnil
);
13990 /* Build the complete desired matrix of WINDOW with a window start
13991 buffer position POS.
13993 Value is 1 if successful. It is zero if fonts were loaded during
13994 redisplay which makes re-adjusting glyph matrices necessary, and -1
13995 if point would appear in the scroll margins.
13996 (We check that only if CHECK_MARGINS is nonzero. */
13999 try_window (window
, pos
, check_margins
)
14000 Lisp_Object window
;
14001 struct text_pos pos
;
14004 struct window
*w
= XWINDOW (window
);
14006 struct glyph_row
*last_text_row
= NULL
;
14007 struct frame
*f
= XFRAME (w
->frame
);
14009 /* Make POS the new window start. */
14010 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14012 /* Mark cursor position as unknown. No overlay arrow seen. */
14013 w
->cursor
.vpos
= -1;
14014 overlay_arrow_seen
= 0;
14016 /* Initialize iterator and info to start at POS. */
14017 start_display (&it
, w
, pos
);
14019 /* Display all lines of W. */
14020 while (it
.current_y
< it
.last_visible_y
)
14022 if (display_line (&it
))
14023 last_text_row
= it
.glyph_row
- 1;
14024 if (fonts_changed_p
)
14028 /* Don't let the cursor end in the scroll margins. */
14030 && !MINI_WINDOW_P (w
))
14032 int this_scroll_margin
;
14034 if (scroll_margin
> 0)
14036 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14037 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14040 this_scroll_margin
= 0;
14042 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14043 && w
->cursor
.y
< this_scroll_margin
14044 && CHARPOS (pos
) > BEGV
14045 && IT_CHARPOS (it
) < ZV
)
14046 /* rms: considering make_cursor_line_fully_visible_p here
14047 seems to give wrong results. We don't want to recenter
14048 when the last line is partly visible, we want to allow
14049 that case to be handled in the usual way. */
14050 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14052 w
->cursor
.vpos
= -1;
14053 clear_glyph_matrix (w
->desired_matrix
);
14058 /* If bottom moved off end of frame, change mode line percentage. */
14059 if (XFASTINT (w
->window_end_pos
) <= 0
14060 && Z
!= IT_CHARPOS (it
))
14061 w
->update_mode_line
= Qt
;
14063 /* Set window_end_pos to the offset of the last character displayed
14064 on the window from the end of current_buffer. Set
14065 window_end_vpos to its row number. */
14068 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14069 w
->window_end_bytepos
14070 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14072 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14074 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14075 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14076 ->displays_text_p
);
14080 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14081 w
->window_end_pos
= make_number (Z
- ZV
);
14082 w
->window_end_vpos
= make_number (0);
14085 /* But that is not valid info until redisplay finishes. */
14086 w
->window_end_valid
= Qnil
;
14092 /************************************************************************
14093 Window redisplay reusing current matrix when buffer has not changed
14094 ************************************************************************/
14096 /* Try redisplay of window W showing an unchanged buffer with a
14097 different window start than the last time it was displayed by
14098 reusing its current matrix. Value is non-zero if successful.
14099 W->start is the new window start. */
14102 try_window_reusing_current_matrix (w
)
14105 struct frame
*f
= XFRAME (w
->frame
);
14106 struct glyph_row
*row
, *bottom_row
;
14109 struct text_pos start
, new_start
;
14110 int nrows_scrolled
, i
;
14111 struct glyph_row
*last_text_row
;
14112 struct glyph_row
*last_reused_text_row
;
14113 struct glyph_row
*start_row
;
14114 int start_vpos
, min_y
, max_y
;
14117 if (inhibit_try_window_reusing
)
14121 if (/* This function doesn't handle terminal frames. */
14122 !FRAME_WINDOW_P (f
)
14123 /* Don't try to reuse the display if windows have been split
14125 || windows_or_buffers_changed
14126 || cursor_type_changed
)
14129 /* Can't do this if region may have changed. */
14130 if ((!NILP (Vtransient_mark_mode
)
14131 && !NILP (current_buffer
->mark_active
))
14132 || !NILP (w
->region_showing
)
14133 || !NILP (Vshow_trailing_whitespace
))
14136 /* If top-line visibility has changed, give up. */
14137 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14138 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14141 /* Give up if old or new display is scrolled vertically. We could
14142 make this function handle this, but right now it doesn't. */
14143 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14144 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14147 /* The variable new_start now holds the new window start. The old
14148 start `start' can be determined from the current matrix. */
14149 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14150 start
= start_row
->start
.pos
;
14151 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14153 /* Clear the desired matrix for the display below. */
14154 clear_glyph_matrix (w
->desired_matrix
);
14156 if (CHARPOS (new_start
) <= CHARPOS (start
))
14160 /* Don't use this method if the display starts with an ellipsis
14161 displayed for invisible text. It's not easy to handle that case
14162 below, and it's certainly not worth the effort since this is
14163 not a frequent case. */
14164 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14167 IF_DEBUG (debug_method_add (w
, "twu1"));
14169 /* Display up to a row that can be reused. The variable
14170 last_text_row is set to the last row displayed that displays
14171 text. Note that it.vpos == 0 if or if not there is a
14172 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14173 start_display (&it
, w
, new_start
);
14174 first_row_y
= it
.current_y
;
14175 w
->cursor
.vpos
= -1;
14176 last_text_row
= last_reused_text_row
= NULL
;
14178 while (it
.current_y
< it
.last_visible_y
14179 && !fonts_changed_p
)
14181 /* If we have reached into the characters in the START row,
14182 that means the line boundaries have changed. So we
14183 can't start copying with the row START. Maybe it will
14184 work to start copying with the following row. */
14185 while (IT_CHARPOS (it
) > CHARPOS (start
))
14187 /* Advance to the next row as the "start". */
14189 start
= start_row
->start
.pos
;
14190 /* If there are no more rows to try, or just one, give up. */
14191 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14192 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14193 || CHARPOS (start
) == ZV
)
14195 clear_glyph_matrix (w
->desired_matrix
);
14199 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14201 /* If we have reached alignment,
14202 we can copy the rest of the rows. */
14203 if (IT_CHARPOS (it
) == CHARPOS (start
))
14206 if (display_line (&it
))
14207 last_text_row
= it
.glyph_row
- 1;
14210 /* A value of current_y < last_visible_y means that we stopped
14211 at the previous window start, which in turn means that we
14212 have at least one reusable row. */
14213 if (it
.current_y
< it
.last_visible_y
)
14215 /* IT.vpos always starts from 0; it counts text lines. */
14216 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14218 /* Find PT if not already found in the lines displayed. */
14219 if (w
->cursor
.vpos
< 0)
14221 int dy
= it
.current_y
- start_row
->y
;
14223 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14224 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14226 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14227 dy
, nrows_scrolled
);
14230 clear_glyph_matrix (w
->desired_matrix
);
14235 /* Scroll the display. Do it before the current matrix is
14236 changed. The problem here is that update has not yet
14237 run, i.e. part of the current matrix is not up to date.
14238 scroll_run_hook will clear the cursor, and use the
14239 current matrix to get the height of the row the cursor is
14241 run
.current_y
= start_row
->y
;
14242 run
.desired_y
= it
.current_y
;
14243 run
.height
= it
.last_visible_y
- it
.current_y
;
14245 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14248 FRAME_RIF (f
)->update_window_begin_hook (w
);
14249 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14250 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14251 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14255 /* Shift current matrix down by nrows_scrolled lines. */
14256 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14257 rotate_matrix (w
->current_matrix
,
14259 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14262 /* Disable lines that must be updated. */
14263 for (i
= 0; i
< nrows_scrolled
; ++i
)
14264 (start_row
+ i
)->enabled_p
= 0;
14266 /* Re-compute Y positions. */
14267 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14268 max_y
= it
.last_visible_y
;
14269 for (row
= start_row
+ nrows_scrolled
;
14273 row
->y
= it
.current_y
;
14274 row
->visible_height
= row
->height
;
14276 if (row
->y
< min_y
)
14277 row
->visible_height
-= min_y
- row
->y
;
14278 if (row
->y
+ row
->height
> max_y
)
14279 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14280 row
->redraw_fringe_bitmaps_p
= 1;
14282 it
.current_y
+= row
->height
;
14284 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14285 last_reused_text_row
= row
;
14286 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14290 /* Disable lines in the current matrix which are now
14291 below the window. */
14292 for (++row
; row
< bottom_row
; ++row
)
14293 row
->enabled_p
= row
->mode_line_p
= 0;
14296 /* Update window_end_pos etc.; last_reused_text_row is the last
14297 reused row from the current matrix containing text, if any.
14298 The value of last_text_row is the last displayed line
14299 containing text. */
14300 if (last_reused_text_row
)
14302 w
->window_end_bytepos
14303 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14305 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14307 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14308 w
->current_matrix
));
14310 else if (last_text_row
)
14312 w
->window_end_bytepos
14313 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14315 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14317 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14321 /* This window must be completely empty. */
14322 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14323 w
->window_end_pos
= make_number (Z
- ZV
);
14324 w
->window_end_vpos
= make_number (0);
14326 w
->window_end_valid
= Qnil
;
14328 /* Update hint: don't try scrolling again in update_window. */
14329 w
->desired_matrix
->no_scrolling_p
= 1;
14332 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14336 else if (CHARPOS (new_start
) > CHARPOS (start
))
14338 struct glyph_row
*pt_row
, *row
;
14339 struct glyph_row
*first_reusable_row
;
14340 struct glyph_row
*first_row_to_display
;
14342 int yb
= window_text_bottom_y (w
);
14344 /* Find the row starting at new_start, if there is one. Don't
14345 reuse a partially visible line at the end. */
14346 first_reusable_row
= start_row
;
14347 while (first_reusable_row
->enabled_p
14348 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14349 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14350 < CHARPOS (new_start
)))
14351 ++first_reusable_row
;
14353 /* Give up if there is no row to reuse. */
14354 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14355 || !first_reusable_row
->enabled_p
14356 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14357 != CHARPOS (new_start
)))
14360 /* We can reuse fully visible rows beginning with
14361 first_reusable_row to the end of the window. Set
14362 first_row_to_display to the first row that cannot be reused.
14363 Set pt_row to the row containing point, if there is any. */
14365 for (first_row_to_display
= first_reusable_row
;
14366 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14367 ++first_row_to_display
)
14369 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14370 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14371 pt_row
= first_row_to_display
;
14374 /* Start displaying at the start of first_row_to_display. */
14375 xassert (first_row_to_display
->y
< yb
);
14376 init_to_row_start (&it
, w
, first_row_to_display
);
14378 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14380 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14382 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14383 + WINDOW_HEADER_LINE_HEIGHT (w
));
14385 /* Display lines beginning with first_row_to_display in the
14386 desired matrix. Set last_text_row to the last row displayed
14387 that displays text. */
14388 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14389 if (pt_row
== NULL
)
14390 w
->cursor
.vpos
= -1;
14391 last_text_row
= NULL
;
14392 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14393 if (display_line (&it
))
14394 last_text_row
= it
.glyph_row
- 1;
14396 /* Give up If point isn't in a row displayed or reused. */
14397 if (w
->cursor
.vpos
< 0)
14399 clear_glyph_matrix (w
->desired_matrix
);
14403 /* If point is in a reused row, adjust y and vpos of the cursor
14407 w
->cursor
.vpos
-= nrows_scrolled
;
14408 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14411 /* Scroll the display. */
14412 run
.current_y
= first_reusable_row
->y
;
14413 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14414 run
.height
= it
.last_visible_y
- run
.current_y
;
14415 dy
= run
.current_y
- run
.desired_y
;
14420 FRAME_RIF (f
)->update_window_begin_hook (w
);
14421 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14422 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14423 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14427 /* Adjust Y positions of reused rows. */
14428 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14429 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14430 max_y
= it
.last_visible_y
;
14431 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14434 row
->visible_height
= row
->height
;
14435 if (row
->y
< min_y
)
14436 row
->visible_height
-= min_y
- row
->y
;
14437 if (row
->y
+ row
->height
> max_y
)
14438 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14439 row
->redraw_fringe_bitmaps_p
= 1;
14442 /* Scroll the current matrix. */
14443 xassert (nrows_scrolled
> 0);
14444 rotate_matrix (w
->current_matrix
,
14446 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14449 /* Disable rows not reused. */
14450 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14451 row
->enabled_p
= 0;
14453 /* Point may have moved to a different line, so we cannot assume that
14454 the previous cursor position is valid; locate the correct row. */
14457 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14458 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14462 w
->cursor
.y
= row
->y
;
14464 if (row
< bottom_row
)
14466 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14467 while (glyph
->charpos
< PT
)
14470 w
->cursor
.x
+= glyph
->pixel_width
;
14476 /* Adjust window end. A null value of last_text_row means that
14477 the window end is in reused rows which in turn means that
14478 only its vpos can have changed. */
14481 w
->window_end_bytepos
14482 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14484 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14486 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14491 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14494 w
->window_end_valid
= Qnil
;
14495 w
->desired_matrix
->no_scrolling_p
= 1;
14498 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14508 /************************************************************************
14509 Window redisplay reusing current matrix when buffer has changed
14510 ************************************************************************/
14512 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14513 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14515 static struct glyph_row
*
14516 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14517 struct glyph_row
*));
14520 /* Return the last row in MATRIX displaying text. If row START is
14521 non-null, start searching with that row. IT gives the dimensions
14522 of the display. Value is null if matrix is empty; otherwise it is
14523 a pointer to the row found. */
14525 static struct glyph_row
*
14526 find_last_row_displaying_text (matrix
, it
, start
)
14527 struct glyph_matrix
*matrix
;
14529 struct glyph_row
*start
;
14531 struct glyph_row
*row
, *row_found
;
14533 /* Set row_found to the last row in IT->w's current matrix
14534 displaying text. The loop looks funny but think of partially
14537 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14538 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14540 xassert (row
->enabled_p
);
14542 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14551 /* Return the last row in the current matrix of W that is not affected
14552 by changes at the start of current_buffer that occurred since W's
14553 current matrix was built. Value is null if no such row exists.
14555 BEG_UNCHANGED us the number of characters unchanged at the start of
14556 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14557 first changed character in current_buffer. Characters at positions <
14558 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14559 when the current matrix was built. */
14561 static struct glyph_row
*
14562 find_last_unchanged_at_beg_row (w
)
14565 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14566 struct glyph_row
*row
;
14567 struct glyph_row
*row_found
= NULL
;
14568 int yb
= window_text_bottom_y (w
);
14570 /* Find the last row displaying unchanged text. */
14571 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14572 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14573 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14576 if (/* If row ends before first_changed_pos, it is unchanged,
14577 except in some case. */
14578 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14579 /* When row ends in ZV and we write at ZV it is not
14581 && !row
->ends_at_zv_p
14582 /* When first_changed_pos is the end of a continued line,
14583 row is not unchanged because it may be no longer
14585 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14586 && (row
->continued_p
14587 || row
->exact_window_width_line_p
)))
14590 /* Stop if last visible row. */
14591 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14599 /* Find the first glyph row in the current matrix of W that is not
14600 affected by changes at the end of current_buffer since the
14601 time W's current matrix was built.
14603 Return in *DELTA the number of chars by which buffer positions in
14604 unchanged text at the end of current_buffer must be adjusted.
14606 Return in *DELTA_BYTES the corresponding number of bytes.
14608 Value is null if no such row exists, i.e. all rows are affected by
14611 static struct glyph_row
*
14612 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14614 int *delta
, *delta_bytes
;
14616 struct glyph_row
*row
;
14617 struct glyph_row
*row_found
= NULL
;
14619 *delta
= *delta_bytes
= 0;
14621 /* Display must not have been paused, otherwise the current matrix
14622 is not up to date. */
14623 eassert (!NILP (w
->window_end_valid
));
14625 /* A value of window_end_pos >= END_UNCHANGED means that the window
14626 end is in the range of changed text. If so, there is no
14627 unchanged row at the end of W's current matrix. */
14628 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14631 /* Set row to the last row in W's current matrix displaying text. */
14632 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14634 /* If matrix is entirely empty, no unchanged row exists. */
14635 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14637 /* The value of row is the last glyph row in the matrix having a
14638 meaningful buffer position in it. The end position of row
14639 corresponds to window_end_pos. This allows us to translate
14640 buffer positions in the current matrix to current buffer
14641 positions for characters not in changed text. */
14642 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14643 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14644 int last_unchanged_pos
, last_unchanged_pos_old
;
14645 struct glyph_row
*first_text_row
14646 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14648 *delta
= Z
- Z_old
;
14649 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14651 /* Set last_unchanged_pos to the buffer position of the last
14652 character in the buffer that has not been changed. Z is the
14653 index + 1 of the last character in current_buffer, i.e. by
14654 subtracting END_UNCHANGED we get the index of the last
14655 unchanged character, and we have to add BEG to get its buffer
14657 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14658 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14660 /* Search backward from ROW for a row displaying a line that
14661 starts at a minimum position >= last_unchanged_pos_old. */
14662 for (; row
> first_text_row
; --row
)
14664 /* This used to abort, but it can happen.
14665 It is ok to just stop the search instead here. KFS. */
14666 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14669 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14674 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14680 /* Make sure that glyph rows in the current matrix of window W
14681 reference the same glyph memory as corresponding rows in the
14682 frame's frame matrix. This function is called after scrolling W's
14683 current matrix on a terminal frame in try_window_id and
14684 try_window_reusing_current_matrix. */
14687 sync_frame_with_window_matrix_rows (w
)
14690 struct frame
*f
= XFRAME (w
->frame
);
14691 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14693 /* Preconditions: W must be a leaf window and full-width. Its frame
14694 must have a frame matrix. */
14695 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14696 xassert (WINDOW_FULL_WIDTH_P (w
));
14697 xassert (!FRAME_WINDOW_P (f
));
14699 /* If W is a full-width window, glyph pointers in W's current matrix
14700 have, by definition, to be the same as glyph pointers in the
14701 corresponding frame matrix. Note that frame matrices have no
14702 marginal areas (see build_frame_matrix). */
14703 window_row
= w
->current_matrix
->rows
;
14704 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14705 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14706 while (window_row
< window_row_end
)
14708 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14709 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14711 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14712 frame_row
->glyphs
[TEXT_AREA
] = start
;
14713 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14714 frame_row
->glyphs
[LAST_AREA
] = end
;
14716 /* Disable frame rows whose corresponding window rows have
14717 been disabled in try_window_id. */
14718 if (!window_row
->enabled_p
)
14719 frame_row
->enabled_p
= 0;
14721 ++window_row
, ++frame_row
;
14726 /* Find the glyph row in window W containing CHARPOS. Consider all
14727 rows between START and END (not inclusive). END null means search
14728 all rows to the end of the display area of W. Value is the row
14729 containing CHARPOS or null. */
14732 row_containing_pos (w
, charpos
, start
, end
, dy
)
14735 struct glyph_row
*start
, *end
;
14738 struct glyph_row
*row
= start
;
14741 /* If we happen to start on a header-line, skip that. */
14742 if (row
->mode_line_p
)
14745 if ((end
&& row
>= end
) || !row
->enabled_p
)
14748 last_y
= window_text_bottom_y (w
) - dy
;
14752 /* Give up if we have gone too far. */
14753 if (end
&& row
>= end
)
14755 /* This formerly returned if they were equal.
14756 I think that both quantities are of a "last plus one" type;
14757 if so, when they are equal, the row is within the screen. -- rms. */
14758 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14761 /* If it is in this row, return this row. */
14762 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14763 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14764 /* The end position of a row equals the start
14765 position of the next row. If CHARPOS is there, we
14766 would rather display it in the next line, except
14767 when this line ends in ZV. */
14768 && !row
->ends_at_zv_p
14769 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14770 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14777 /* Try to redisplay window W by reusing its existing display. W's
14778 current matrix must be up to date when this function is called,
14779 i.e. window_end_valid must not be nil.
14783 1 if display has been updated
14784 0 if otherwise unsuccessful
14785 -1 if redisplay with same window start is known not to succeed
14787 The following steps are performed:
14789 1. Find the last row in the current matrix of W that is not
14790 affected by changes at the start of current_buffer. If no such row
14793 2. Find the first row in W's current matrix that is not affected by
14794 changes at the end of current_buffer. Maybe there is no such row.
14796 3. Display lines beginning with the row + 1 found in step 1 to the
14797 row found in step 2 or, if step 2 didn't find a row, to the end of
14800 4. If cursor is not known to appear on the window, give up.
14802 5. If display stopped at the row found in step 2, scroll the
14803 display and current matrix as needed.
14805 6. Maybe display some lines at the end of W, if we must. This can
14806 happen under various circumstances, like a partially visible line
14807 becoming fully visible, or because newly displayed lines are displayed
14808 in smaller font sizes.
14810 7. Update W's window end information. */
14816 struct frame
*f
= XFRAME (w
->frame
);
14817 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14818 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14819 struct glyph_row
*last_unchanged_at_beg_row
;
14820 struct glyph_row
*first_unchanged_at_end_row
;
14821 struct glyph_row
*row
;
14822 struct glyph_row
*bottom_row
;
14825 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14826 struct text_pos start_pos
;
14828 int first_unchanged_at_end_vpos
= 0;
14829 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14830 struct text_pos start
;
14831 int first_changed_charpos
, last_changed_charpos
;
14834 if (inhibit_try_window_id
)
14838 /* This is handy for debugging. */
14840 #define GIVE_UP(X) \
14842 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14846 #define GIVE_UP(X) return 0
14849 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14851 /* Don't use this for mini-windows because these can show
14852 messages and mini-buffers, and we don't handle that here. */
14853 if (MINI_WINDOW_P (w
))
14856 /* This flag is used to prevent redisplay optimizations. */
14857 if (windows_or_buffers_changed
|| cursor_type_changed
)
14860 /* Verify that narrowing has not changed.
14861 Also verify that we were not told to prevent redisplay optimizations.
14862 It would be nice to further
14863 reduce the number of cases where this prevents try_window_id. */
14864 if (current_buffer
->clip_changed
14865 || current_buffer
->prevent_redisplay_optimizations_p
)
14868 /* Window must either use window-based redisplay or be full width. */
14869 if (!FRAME_WINDOW_P (f
)
14870 && (!FRAME_LINE_INS_DEL_OK (f
)
14871 || !WINDOW_FULL_WIDTH_P (w
)))
14874 /* Give up if point is not known NOT to appear in W. */
14875 if (PT
< CHARPOS (start
))
14878 /* Another way to prevent redisplay optimizations. */
14879 if (XFASTINT (w
->last_modified
) == 0)
14882 /* Verify that window is not hscrolled. */
14883 if (XFASTINT (w
->hscroll
) != 0)
14886 /* Verify that display wasn't paused. */
14887 if (NILP (w
->window_end_valid
))
14890 /* Can't use this if highlighting a region because a cursor movement
14891 will do more than just set the cursor. */
14892 if (!NILP (Vtransient_mark_mode
)
14893 && !NILP (current_buffer
->mark_active
))
14896 /* Likewise if highlighting trailing whitespace. */
14897 if (!NILP (Vshow_trailing_whitespace
))
14900 /* Likewise if showing a region. */
14901 if (!NILP (w
->region_showing
))
14904 /* Can use this if overlay arrow position and or string have changed. */
14905 if (overlay_arrows_changed_p ())
14908 /* When word-wrap is on, adding a space to the first word of a
14909 wrapped line can change the wrap position, altering the line
14910 above it. It might be worthwhile to handle this more
14911 intelligently, but for now just redisplay from scratch. */
14912 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14915 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14916 only if buffer has really changed. The reason is that the gap is
14917 initially at Z for freshly visited files. The code below would
14918 set end_unchanged to 0 in that case. */
14919 if (MODIFF
> SAVE_MODIFF
14920 /* This seems to happen sometimes after saving a buffer. */
14921 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14923 if (GPT
- BEG
< BEG_UNCHANGED
)
14924 BEG_UNCHANGED
= GPT
- BEG
;
14925 if (Z
- GPT
< END_UNCHANGED
)
14926 END_UNCHANGED
= Z
- GPT
;
14929 /* The position of the first and last character that has been changed. */
14930 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14931 last_changed_charpos
= Z
- END_UNCHANGED
;
14933 /* If window starts after a line end, and the last change is in
14934 front of that newline, then changes don't affect the display.
14935 This case happens with stealth-fontification. Note that although
14936 the display is unchanged, glyph positions in the matrix have to
14937 be adjusted, of course. */
14938 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14939 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14940 && ((last_changed_charpos
< CHARPOS (start
)
14941 && CHARPOS (start
) == BEGV
)
14942 || (last_changed_charpos
< CHARPOS (start
) - 1
14943 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14945 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14946 struct glyph_row
*r0
;
14948 /* Compute how many chars/bytes have been added to or removed
14949 from the buffer. */
14950 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14951 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14953 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14955 /* Give up if PT is not in the window. Note that it already has
14956 been checked at the start of try_window_id that PT is not in
14957 front of the window start. */
14958 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14961 /* If window start is unchanged, we can reuse the whole matrix
14962 as is, after adjusting glyph positions. No need to compute
14963 the window end again, since its offset from Z hasn't changed. */
14964 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14965 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14966 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14967 /* PT must not be in a partially visible line. */
14968 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14969 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14971 /* Adjust positions in the glyph matrix. */
14972 if (delta
|| delta_bytes
)
14974 struct glyph_row
*r1
14975 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14976 increment_matrix_positions (w
->current_matrix
,
14977 MATRIX_ROW_VPOS (r0
, current_matrix
),
14978 MATRIX_ROW_VPOS (r1
, current_matrix
),
14979 delta
, delta_bytes
);
14982 /* Set the cursor. */
14983 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14985 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14992 /* Handle the case that changes are all below what is displayed in
14993 the window, and that PT is in the window. This shortcut cannot
14994 be taken if ZV is visible in the window, and text has been added
14995 there that is visible in the window. */
14996 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
14997 /* ZV is not visible in the window, or there are no
14998 changes at ZV, actually. */
14999 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15000 || first_changed_charpos
== last_changed_charpos
))
15002 struct glyph_row
*r0
;
15004 /* Give up if PT is not in the window. Note that it already has
15005 been checked at the start of try_window_id that PT is not in
15006 front of the window start. */
15007 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15010 /* If window start is unchanged, we can reuse the whole matrix
15011 as is, without changing glyph positions since no text has
15012 been added/removed in front of the window end. */
15013 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15014 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15015 /* PT must not be in a partially visible line. */
15016 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15017 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15019 /* We have to compute the window end anew since text
15020 can have been added/removed after it. */
15022 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15023 w
->window_end_bytepos
15024 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15026 /* Set the cursor. */
15027 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15029 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15036 /* Give up if window start is in the changed area.
15038 The condition used to read
15040 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15042 but why that was tested escapes me at the moment. */
15043 if (CHARPOS (start
) >= first_changed_charpos
15044 && CHARPOS (start
) <= last_changed_charpos
)
15047 /* Check that window start agrees with the start of the first glyph
15048 row in its current matrix. Check this after we know the window
15049 start is not in changed text, otherwise positions would not be
15051 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15052 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15055 /* Give up if the window ends in strings. Overlay strings
15056 at the end are difficult to handle, so don't try. */
15057 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15058 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15061 /* Compute the position at which we have to start displaying new
15062 lines. Some of the lines at the top of the window might be
15063 reusable because they are not displaying changed text. Find the
15064 last row in W's current matrix not affected by changes at the
15065 start of current_buffer. Value is null if changes start in the
15066 first line of window. */
15067 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15068 if (last_unchanged_at_beg_row
)
15070 /* Avoid starting to display in the moddle of a character, a TAB
15071 for instance. This is easier than to set up the iterator
15072 exactly, and it's not a frequent case, so the additional
15073 effort wouldn't really pay off. */
15074 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15075 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15076 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15077 --last_unchanged_at_beg_row
;
15079 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15082 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15084 start_pos
= it
.current
.pos
;
15086 /* Start displaying new lines in the desired matrix at the same
15087 vpos we would use in the current matrix, i.e. below
15088 last_unchanged_at_beg_row. */
15089 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15091 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15092 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15094 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15098 /* There are no reusable lines at the start of the window.
15099 Start displaying in the first text line. */
15100 start_display (&it
, w
, start
);
15101 it
.vpos
= it
.first_vpos
;
15102 start_pos
= it
.current
.pos
;
15105 /* Find the first row that is not affected by changes at the end of
15106 the buffer. Value will be null if there is no unchanged row, in
15107 which case we must redisplay to the end of the window. delta
15108 will be set to the value by which buffer positions beginning with
15109 first_unchanged_at_end_row have to be adjusted due to text
15111 first_unchanged_at_end_row
15112 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15113 IF_DEBUG (debug_delta
= delta
);
15114 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15116 /* Set stop_pos to the buffer position up to which we will have to
15117 display new lines. If first_unchanged_at_end_row != NULL, this
15118 is the buffer position of the start of the line displayed in that
15119 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15120 that we don't stop at a buffer position. */
15122 if (first_unchanged_at_end_row
)
15124 xassert (last_unchanged_at_beg_row
== NULL
15125 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15127 /* If this is a continuation line, move forward to the next one
15128 that isn't. Changes in lines above affect this line.
15129 Caution: this may move first_unchanged_at_end_row to a row
15130 not displaying text. */
15131 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15132 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15133 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15134 < it
.last_visible_y
))
15135 ++first_unchanged_at_end_row
;
15137 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15138 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15139 >= it
.last_visible_y
))
15140 first_unchanged_at_end_row
= NULL
;
15143 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15145 first_unchanged_at_end_vpos
15146 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15147 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15150 else if (last_unchanged_at_beg_row
== NULL
)
15156 /* Either there is no unchanged row at the end, or the one we have
15157 now displays text. This is a necessary condition for the window
15158 end pos calculation at the end of this function. */
15159 xassert (first_unchanged_at_end_row
== NULL
15160 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15162 debug_last_unchanged_at_beg_vpos
15163 = (last_unchanged_at_beg_row
15164 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15166 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15168 #endif /* GLYPH_DEBUG != 0 */
15171 /* Display new lines. Set last_text_row to the last new line
15172 displayed which has text on it, i.e. might end up as being the
15173 line where the window_end_vpos is. */
15174 w
->cursor
.vpos
= -1;
15175 last_text_row
= NULL
;
15176 overlay_arrow_seen
= 0;
15177 while (it
.current_y
< it
.last_visible_y
15178 && !fonts_changed_p
15179 && (first_unchanged_at_end_row
== NULL
15180 || IT_CHARPOS (it
) < stop_pos
))
15182 if (display_line (&it
))
15183 last_text_row
= it
.glyph_row
- 1;
15186 if (fonts_changed_p
)
15190 /* Compute differences in buffer positions, y-positions etc. for
15191 lines reused at the bottom of the window. Compute what we can
15193 if (first_unchanged_at_end_row
15194 /* No lines reused because we displayed everything up to the
15195 bottom of the window. */
15196 && it
.current_y
< it
.last_visible_y
)
15199 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15201 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15202 run
.current_y
= first_unchanged_at_end_row
->y
;
15203 run
.desired_y
= run
.current_y
+ dy
;
15204 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15208 delta
= delta_bytes
= dvpos
= dy
15209 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15210 first_unchanged_at_end_row
= NULL
;
15212 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15215 /* Find the cursor if not already found. We have to decide whether
15216 PT will appear on this window (it sometimes doesn't, but this is
15217 not a very frequent case.) This decision has to be made before
15218 the current matrix is altered. A value of cursor.vpos < 0 means
15219 that PT is either in one of the lines beginning at
15220 first_unchanged_at_end_row or below the window. Don't care for
15221 lines that might be displayed later at the window end; as
15222 mentioned, this is not a frequent case. */
15223 if (w
->cursor
.vpos
< 0)
15225 /* Cursor in unchanged rows at the top? */
15226 if (PT
< CHARPOS (start_pos
)
15227 && last_unchanged_at_beg_row
)
15229 row
= row_containing_pos (w
, PT
,
15230 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15231 last_unchanged_at_beg_row
+ 1, 0);
15233 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15236 /* Start from first_unchanged_at_end_row looking for PT. */
15237 else if (first_unchanged_at_end_row
)
15239 row
= row_containing_pos (w
, PT
- delta
,
15240 first_unchanged_at_end_row
, NULL
, 0);
15242 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15243 delta_bytes
, dy
, dvpos
);
15246 /* Give up if cursor was not found. */
15247 if (w
->cursor
.vpos
< 0)
15249 clear_glyph_matrix (w
->desired_matrix
);
15254 /* Don't let the cursor end in the scroll margins. */
15256 int this_scroll_margin
, cursor_height
;
15258 this_scroll_margin
= max (0, scroll_margin
);
15259 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15260 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15261 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15263 if ((w
->cursor
.y
< this_scroll_margin
15264 && CHARPOS (start
) > BEGV
)
15265 /* Old redisplay didn't take scroll margin into account at the bottom,
15266 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15267 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15268 ? cursor_height
+ this_scroll_margin
15269 : 1)) > it
.last_visible_y
)
15271 w
->cursor
.vpos
= -1;
15272 clear_glyph_matrix (w
->desired_matrix
);
15277 /* Scroll the display. Do it before changing the current matrix so
15278 that xterm.c doesn't get confused about where the cursor glyph is
15280 if (dy
&& run
.height
)
15284 if (FRAME_WINDOW_P (f
))
15286 FRAME_RIF (f
)->update_window_begin_hook (w
);
15287 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15288 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15289 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15293 /* Terminal frame. In this case, dvpos gives the number of
15294 lines to scroll by; dvpos < 0 means scroll up. */
15295 int first_unchanged_at_end_vpos
15296 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15297 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15298 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15299 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15300 + window_internal_height (w
));
15302 /* Perform the operation on the screen. */
15305 /* Scroll last_unchanged_at_beg_row to the end of the
15306 window down dvpos lines. */
15307 set_terminal_window (f
, end
);
15309 /* On dumb terminals delete dvpos lines at the end
15310 before inserting dvpos empty lines. */
15311 if (!FRAME_SCROLL_REGION_OK (f
))
15312 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15314 /* Insert dvpos empty lines in front of
15315 last_unchanged_at_beg_row. */
15316 ins_del_lines (f
, from
, dvpos
);
15318 else if (dvpos
< 0)
15320 /* Scroll up last_unchanged_at_beg_vpos to the end of
15321 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15322 set_terminal_window (f
, end
);
15324 /* Delete dvpos lines in front of
15325 last_unchanged_at_beg_vpos. ins_del_lines will set
15326 the cursor to the given vpos and emit |dvpos| delete
15328 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15330 /* On a dumb terminal insert dvpos empty lines at the
15332 if (!FRAME_SCROLL_REGION_OK (f
))
15333 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15336 set_terminal_window (f
, 0);
15342 /* Shift reused rows of the current matrix to the right position.
15343 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15345 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15346 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15349 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15350 bottom_vpos
, dvpos
);
15351 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15354 else if (dvpos
> 0)
15356 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15357 bottom_vpos
, dvpos
);
15358 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15359 first_unchanged_at_end_vpos
+ dvpos
, 0);
15362 /* For frame-based redisplay, make sure that current frame and window
15363 matrix are in sync with respect to glyph memory. */
15364 if (!FRAME_WINDOW_P (f
))
15365 sync_frame_with_window_matrix_rows (w
);
15367 /* Adjust buffer positions in reused rows. */
15368 if (delta
|| delta_bytes
)
15369 increment_matrix_positions (current_matrix
,
15370 first_unchanged_at_end_vpos
+ dvpos
,
15371 bottom_vpos
, delta
, delta_bytes
);
15373 /* Adjust Y positions. */
15375 shift_glyph_matrix (w
, current_matrix
,
15376 first_unchanged_at_end_vpos
+ dvpos
,
15379 if (first_unchanged_at_end_row
)
15381 first_unchanged_at_end_row
+= dvpos
;
15382 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15383 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15384 first_unchanged_at_end_row
= NULL
;
15387 /* If scrolling up, there may be some lines to display at the end of
15389 last_text_row_at_end
= NULL
;
15392 /* Scrolling up can leave for example a partially visible line
15393 at the end of the window to be redisplayed. */
15394 /* Set last_row to the glyph row in the current matrix where the
15395 window end line is found. It has been moved up or down in
15396 the matrix by dvpos. */
15397 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15398 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15400 /* If last_row is the window end line, it should display text. */
15401 xassert (last_row
->displays_text_p
);
15403 /* If window end line was partially visible before, begin
15404 displaying at that line. Otherwise begin displaying with the
15405 line following it. */
15406 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15408 init_to_row_start (&it
, w
, last_row
);
15409 it
.vpos
= last_vpos
;
15410 it
.current_y
= last_row
->y
;
15414 init_to_row_end (&it
, w
, last_row
);
15415 it
.vpos
= 1 + last_vpos
;
15416 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15420 /* We may start in a continuation line. If so, we have to
15421 get the right continuation_lines_width and current_x. */
15422 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15423 it
.hpos
= it
.current_x
= 0;
15425 /* Display the rest of the lines at the window end. */
15426 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15427 while (it
.current_y
< it
.last_visible_y
15428 && !fonts_changed_p
)
15430 /* Is it always sure that the display agrees with lines in
15431 the current matrix? I don't think so, so we mark rows
15432 displayed invalid in the current matrix by setting their
15433 enabled_p flag to zero. */
15434 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15435 if (display_line (&it
))
15436 last_text_row_at_end
= it
.glyph_row
- 1;
15440 /* Update window_end_pos and window_end_vpos. */
15441 if (first_unchanged_at_end_row
15442 && !last_text_row_at_end
)
15444 /* Window end line if one of the preserved rows from the current
15445 matrix. Set row to the last row displaying text in current
15446 matrix starting at first_unchanged_at_end_row, after
15448 xassert (first_unchanged_at_end_row
->displays_text_p
);
15449 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15450 first_unchanged_at_end_row
);
15451 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15453 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15454 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15456 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15457 xassert (w
->window_end_bytepos
>= 0);
15458 IF_DEBUG (debug_method_add (w
, "A"));
15460 else if (last_text_row_at_end
)
15463 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15464 w
->window_end_bytepos
15465 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15467 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15468 xassert (w
->window_end_bytepos
>= 0);
15469 IF_DEBUG (debug_method_add (w
, "B"));
15471 else if (last_text_row
)
15473 /* We have displayed either to the end of the window or at the
15474 end of the window, i.e. the last row with text is to be found
15475 in the desired matrix. */
15477 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15478 w
->window_end_bytepos
15479 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15481 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15482 xassert (w
->window_end_bytepos
>= 0);
15484 else if (first_unchanged_at_end_row
== NULL
15485 && last_text_row
== NULL
15486 && last_text_row_at_end
== NULL
)
15488 /* Displayed to end of window, but no line containing text was
15489 displayed. Lines were deleted at the end of the window. */
15490 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15491 int vpos
= XFASTINT (w
->window_end_vpos
);
15492 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15493 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15496 row
== NULL
&& vpos
>= first_vpos
;
15497 --vpos
, --current_row
, --desired_row
)
15499 if (desired_row
->enabled_p
)
15501 if (desired_row
->displays_text_p
)
15504 else if (current_row
->displays_text_p
)
15508 xassert (row
!= NULL
);
15509 w
->window_end_vpos
= make_number (vpos
+ 1);
15510 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15511 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15512 xassert (w
->window_end_bytepos
>= 0);
15513 IF_DEBUG (debug_method_add (w
, "C"));
15518 #if 0 /* This leads to problems, for instance when the cursor is
15519 at ZV, and the cursor line displays no text. */
15520 /* Disable rows below what's displayed in the window. This makes
15521 debugging easier. */
15522 enable_glyph_matrix_rows (current_matrix
,
15523 XFASTINT (w
->window_end_vpos
) + 1,
15527 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15528 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15530 /* Record that display has not been completed. */
15531 w
->window_end_valid
= Qnil
;
15532 w
->desired_matrix
->no_scrolling_p
= 1;
15540 /***********************************************************************
15541 More debugging support
15542 ***********************************************************************/
15546 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15547 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15548 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15551 /* Dump the contents of glyph matrix MATRIX on stderr.
15553 GLYPHS 0 means don't show glyph contents.
15554 GLYPHS 1 means show glyphs in short form
15555 GLYPHS > 1 means show glyphs in long form. */
15558 dump_glyph_matrix (matrix
, glyphs
)
15559 struct glyph_matrix
*matrix
;
15563 for (i
= 0; i
< matrix
->nrows
; ++i
)
15564 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15568 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15569 the glyph row and area where the glyph comes from. */
15572 dump_glyph (row
, glyph
, area
)
15573 struct glyph_row
*row
;
15574 struct glyph
*glyph
;
15577 if (glyph
->type
== CHAR_GLYPH
)
15580 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15581 glyph
- row
->glyphs
[TEXT_AREA
],
15584 (BUFFERP (glyph
->object
)
15586 : (STRINGP (glyph
->object
)
15589 glyph
->pixel_width
,
15591 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15595 glyph
->left_box_line_p
,
15596 glyph
->right_box_line_p
);
15598 else if (glyph
->type
== STRETCH_GLYPH
)
15601 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15602 glyph
- row
->glyphs
[TEXT_AREA
],
15605 (BUFFERP (glyph
->object
)
15607 : (STRINGP (glyph
->object
)
15610 glyph
->pixel_width
,
15614 glyph
->left_box_line_p
,
15615 glyph
->right_box_line_p
);
15617 else if (glyph
->type
== IMAGE_GLYPH
)
15620 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15621 glyph
- row
->glyphs
[TEXT_AREA
],
15624 (BUFFERP (glyph
->object
)
15626 : (STRINGP (glyph
->object
)
15629 glyph
->pixel_width
,
15633 glyph
->left_box_line_p
,
15634 glyph
->right_box_line_p
);
15636 else if (glyph
->type
== COMPOSITE_GLYPH
)
15639 " %5d %4c %6d %c %3d 0x%05x",
15640 glyph
- row
->glyphs
[TEXT_AREA
],
15643 (BUFFERP (glyph
->object
)
15645 : (STRINGP (glyph
->object
)
15648 glyph
->pixel_width
,
15650 if (glyph
->u
.cmp
.automatic
)
15653 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
15654 fprintf (stderr
, " . %4d %1.1d%1.1d\n"
15656 glyph
->left_box_line_p
,
15657 glyph
->right_box_line_p
);
15662 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15663 GLYPHS 0 means don't show glyph contents.
15664 GLYPHS 1 means show glyphs in short form
15665 GLYPHS > 1 means show glyphs in long form. */
15668 dump_glyph_row (row
, vpos
, glyphs
)
15669 struct glyph_row
*row
;
15674 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15675 fprintf (stderr
, "======================================================================\n");
15677 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15678 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15680 MATRIX_ROW_START_CHARPOS (row
),
15681 MATRIX_ROW_END_CHARPOS (row
),
15682 row
->used
[TEXT_AREA
],
15683 row
->contains_overlapping_glyphs_p
,
15685 row
->truncated_on_left_p
,
15686 row
->truncated_on_right_p
,
15688 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15689 row
->displays_text_p
,
15692 row
->ends_in_middle_of_char_p
,
15693 row
->starts_in_middle_of_char_p
,
15699 row
->visible_height
,
15702 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15703 row
->end
.overlay_string_index
,
15704 row
->continuation_lines_width
);
15705 fprintf (stderr
, "%9d %5d\n",
15706 CHARPOS (row
->start
.string_pos
),
15707 CHARPOS (row
->end
.string_pos
));
15708 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15709 row
->end
.dpvec_index
);
15716 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15718 struct glyph
*glyph
= row
->glyphs
[area
];
15719 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15721 /* Glyph for a line end in text. */
15722 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15725 if (glyph
< glyph_end
)
15726 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15728 for (; glyph
< glyph_end
; ++glyph
)
15729 dump_glyph (row
, glyph
, area
);
15732 else if (glyphs
== 1)
15736 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15738 char *s
= (char *) alloca (row
->used
[area
] + 1);
15741 for (i
= 0; i
< row
->used
[area
]; ++i
)
15743 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15744 if (glyph
->type
== CHAR_GLYPH
15745 && glyph
->u
.ch
< 0x80
15746 && glyph
->u
.ch
>= ' ')
15747 s
[i
] = glyph
->u
.ch
;
15753 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15759 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15760 Sdump_glyph_matrix
, 0, 1, "p",
15761 doc
: /* Dump the current matrix of the selected window to stderr.
15762 Shows contents of glyph row structures. With non-nil
15763 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15764 glyphs in short form, otherwise show glyphs in long form. */)
15766 Lisp_Object glyphs
;
15768 struct window
*w
= XWINDOW (selected_window
);
15769 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15771 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15772 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15773 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15774 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15775 fprintf (stderr
, "=============================================\n");
15776 dump_glyph_matrix (w
->current_matrix
,
15777 NILP (glyphs
) ? 0 : XINT (glyphs
));
15782 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15783 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15786 struct frame
*f
= XFRAME (selected_frame
);
15787 dump_glyph_matrix (f
->current_matrix
, 1);
15792 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15793 doc
: /* Dump glyph row ROW to stderr.
15794 GLYPH 0 means don't dump glyphs.
15795 GLYPH 1 means dump glyphs in short form.
15796 GLYPH > 1 or omitted means dump glyphs in long form. */)
15798 Lisp_Object row
, glyphs
;
15800 struct glyph_matrix
*matrix
;
15803 CHECK_NUMBER (row
);
15804 matrix
= XWINDOW (selected_window
)->current_matrix
;
15806 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15807 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15809 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15814 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15815 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15816 GLYPH 0 means don't dump glyphs.
15817 GLYPH 1 means dump glyphs in short form.
15818 GLYPH > 1 or omitted means dump glyphs in long form. */)
15820 Lisp_Object row
, glyphs
;
15822 struct frame
*sf
= SELECTED_FRAME ();
15823 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15826 CHECK_NUMBER (row
);
15828 if (vpos
>= 0 && vpos
< m
->nrows
)
15829 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15830 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15835 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15836 doc
: /* Toggle tracing of redisplay.
15837 With ARG, turn tracing on if and only if ARG is positive. */)
15842 trace_redisplay_p
= !trace_redisplay_p
;
15845 arg
= Fprefix_numeric_value (arg
);
15846 trace_redisplay_p
= XINT (arg
) > 0;
15853 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15854 doc
: /* Like `format', but print result to stderr.
15855 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15860 Lisp_Object s
= Fformat (nargs
, args
);
15861 fprintf (stderr
, "%s", SDATA (s
));
15865 #endif /* GLYPH_DEBUG */
15869 /***********************************************************************
15870 Building Desired Matrix Rows
15871 ***********************************************************************/
15873 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15874 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15876 static struct glyph_row
*
15877 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15879 Lisp_Object overlay_arrow_string
;
15881 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15882 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15883 struct buffer
*old
= current_buffer
;
15884 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15885 int arrow_len
= SCHARS (overlay_arrow_string
);
15886 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15887 const unsigned char *p
;
15890 int n_glyphs_before
;
15892 set_buffer_temp (buffer
);
15893 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15894 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15895 SET_TEXT_POS (it
.position
, 0, 0);
15897 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15899 while (p
< arrow_end
)
15901 Lisp_Object face
, ilisp
;
15903 /* Get the next character. */
15905 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15907 it
.c
= *p
, it
.len
= 1;
15910 /* Get its face. */
15911 ilisp
= make_number (p
- arrow_string
);
15912 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15913 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15915 /* Compute its width, get its glyphs. */
15916 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15917 SET_TEXT_POS (it
.position
, -1, -1);
15918 PRODUCE_GLYPHS (&it
);
15920 /* If this character doesn't fit any more in the line, we have
15921 to remove some glyphs. */
15922 if (it
.current_x
> it
.last_visible_x
)
15924 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15929 set_buffer_temp (old
);
15930 return it
.glyph_row
;
15934 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15935 glyphs are only inserted for terminal frames since we can't really
15936 win with truncation glyphs when partially visible glyphs are
15937 involved. Which glyphs to insert is determined by
15938 produce_special_glyphs. */
15941 insert_left_trunc_glyphs (it
)
15944 struct it truncate_it
;
15945 struct glyph
*from
, *end
, *to
, *toend
;
15947 xassert (!FRAME_WINDOW_P (it
->f
));
15949 /* Get the truncation glyphs. */
15951 truncate_it
.current_x
= 0;
15952 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15953 truncate_it
.glyph_row
= &scratch_glyph_row
;
15954 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15955 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15956 truncate_it
.object
= make_number (0);
15957 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15959 /* Overwrite glyphs from IT with truncation glyphs. */
15960 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15961 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15962 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15963 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15968 /* There may be padding glyphs left over. Overwrite them too. */
15969 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15971 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15977 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15981 /* Compute the pixel height and width of IT->glyph_row.
15983 Most of the time, ascent and height of a display line will be equal
15984 to the max_ascent and max_height values of the display iterator
15985 structure. This is not the case if
15987 1. We hit ZV without displaying anything. In this case, max_ascent
15988 and max_height will be zero.
15990 2. We have some glyphs that don't contribute to the line height.
15991 (The glyph row flag contributes_to_line_height_p is for future
15992 pixmap extensions).
15994 The first case is easily covered by using default values because in
15995 these cases, the line height does not really matter, except that it
15996 must not be zero. */
15999 compute_line_metrics (it
)
16002 struct glyph_row
*row
= it
->glyph_row
;
16005 if (FRAME_WINDOW_P (it
->f
))
16007 int i
, min_y
, max_y
;
16009 /* The line may consist of one space only, that was added to
16010 place the cursor on it. If so, the row's height hasn't been
16012 if (row
->height
== 0)
16014 if (it
->max_ascent
+ it
->max_descent
== 0)
16015 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16016 row
->ascent
= it
->max_ascent
;
16017 row
->height
= it
->max_ascent
+ it
->max_descent
;
16018 row
->phys_ascent
= it
->max_phys_ascent
;
16019 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16020 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16023 /* Compute the width of this line. */
16024 row
->pixel_width
= row
->x
;
16025 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16026 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16028 xassert (row
->pixel_width
>= 0);
16029 xassert (row
->ascent
>= 0 && row
->height
> 0);
16031 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16032 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16034 /* If first line's physical ascent is larger than its logical
16035 ascent, use the physical ascent, and make the row taller.
16036 This makes accented characters fully visible. */
16037 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16038 && row
->phys_ascent
> row
->ascent
)
16040 row
->height
+= row
->phys_ascent
- row
->ascent
;
16041 row
->ascent
= row
->phys_ascent
;
16044 /* Compute how much of the line is visible. */
16045 row
->visible_height
= row
->height
;
16047 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16048 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16050 if (row
->y
< min_y
)
16051 row
->visible_height
-= min_y
- row
->y
;
16052 if (row
->y
+ row
->height
> max_y
)
16053 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16057 row
->pixel_width
= row
->used
[TEXT_AREA
];
16058 if (row
->continued_p
)
16059 row
->pixel_width
-= it
->continuation_pixel_width
;
16060 else if (row
->truncated_on_right_p
)
16061 row
->pixel_width
-= it
->truncation_pixel_width
;
16062 row
->ascent
= row
->phys_ascent
= 0;
16063 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16064 row
->extra_line_spacing
= 0;
16067 /* Compute a hash code for this row. */
16069 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16070 for (i
= 0; i
< row
->used
[area
]; ++i
)
16071 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16072 + row
->glyphs
[area
][i
].u
.val
16073 + row
->glyphs
[area
][i
].face_id
16074 + row
->glyphs
[area
][i
].padding_p
16075 + (row
->glyphs
[area
][i
].type
<< 2));
16077 it
->max_ascent
= it
->max_descent
= 0;
16078 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16082 /* Append one space to the glyph row of iterator IT if doing a
16083 window-based redisplay. The space has the same face as
16084 IT->face_id. Value is non-zero if a space was added.
16086 This function is called to make sure that there is always one glyph
16087 at the end of a glyph row that the cursor can be set on under
16088 window-systems. (If there weren't such a glyph we would not know
16089 how wide and tall a box cursor should be displayed).
16091 At the same time this space let's a nicely handle clearing to the
16092 end of the line if the row ends in italic text. */
16095 append_space_for_newline (it
, default_face_p
)
16097 int default_face_p
;
16099 if (FRAME_WINDOW_P (it
->f
))
16101 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16103 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16104 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16106 /* Save some values that must not be changed.
16107 Must save IT->c and IT->len because otherwise
16108 ITERATOR_AT_END_P wouldn't work anymore after
16109 append_space_for_newline has been called. */
16110 enum display_element_type saved_what
= it
->what
;
16111 int saved_c
= it
->c
, saved_len
= it
->len
;
16112 int saved_x
= it
->current_x
;
16113 int saved_face_id
= it
->face_id
;
16114 struct text_pos saved_pos
;
16115 Lisp_Object saved_object
;
16118 saved_object
= it
->object
;
16119 saved_pos
= it
->position
;
16121 it
->what
= IT_CHARACTER
;
16122 bzero (&it
->position
, sizeof it
->position
);
16123 it
->object
= make_number (0);
16127 if (default_face_p
)
16128 it
->face_id
= DEFAULT_FACE_ID
;
16129 else if (it
->face_before_selective_p
)
16130 it
->face_id
= it
->saved_face_id
;
16131 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16132 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16134 PRODUCE_GLYPHS (it
);
16136 it
->override_ascent
= -1;
16137 it
->constrain_row_ascent_descent_p
= 0;
16138 it
->current_x
= saved_x
;
16139 it
->object
= saved_object
;
16140 it
->position
= saved_pos
;
16141 it
->what
= saved_what
;
16142 it
->face_id
= saved_face_id
;
16143 it
->len
= saved_len
;
16153 /* Extend the face of the last glyph in the text area of IT->glyph_row
16154 to the end of the display line. Called from display_line.
16155 If the glyph row is empty, add a space glyph to it so that we
16156 know the face to draw. Set the glyph row flag fill_line_p. */
16159 extend_face_to_end_of_line (it
)
16163 struct frame
*f
= it
->f
;
16165 /* If line is already filled, do nothing. */
16166 if (it
->current_x
>= it
->last_visible_x
)
16169 /* Face extension extends the background and box of IT->face_id
16170 to the end of the line. If the background equals the background
16171 of the frame, we don't have to do anything. */
16172 if (it
->face_before_selective_p
)
16173 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16175 face
= FACE_FROM_ID (f
, it
->face_id
);
16177 if (FRAME_WINDOW_P (f
)
16178 && it
->glyph_row
->displays_text_p
16179 && face
->box
== FACE_NO_BOX
16180 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16184 /* Set the glyph row flag indicating that the face of the last glyph
16185 in the text area has to be drawn to the end of the text area. */
16186 it
->glyph_row
->fill_line_p
= 1;
16188 /* If current character of IT is not ASCII, make sure we have the
16189 ASCII face. This will be automatically undone the next time
16190 get_next_display_element returns a multibyte character. Note
16191 that the character will always be single byte in unibyte text. */
16192 if (!ASCII_CHAR_P (it
->c
))
16194 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16197 if (FRAME_WINDOW_P (f
))
16199 /* If the row is empty, add a space with the current face of IT,
16200 so that we know which face to draw. */
16201 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16203 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16204 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16205 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16210 /* Save some values that must not be changed. */
16211 int saved_x
= it
->current_x
;
16212 struct text_pos saved_pos
;
16213 Lisp_Object saved_object
;
16214 enum display_element_type saved_what
= it
->what
;
16215 int saved_face_id
= it
->face_id
;
16217 saved_object
= it
->object
;
16218 saved_pos
= it
->position
;
16220 it
->what
= IT_CHARACTER
;
16221 bzero (&it
->position
, sizeof it
->position
);
16222 it
->object
= make_number (0);
16225 it
->face_id
= face
->id
;
16227 PRODUCE_GLYPHS (it
);
16229 while (it
->current_x
<= it
->last_visible_x
)
16230 PRODUCE_GLYPHS (it
);
16232 /* Don't count these blanks really. It would let us insert a left
16233 truncation glyph below and make us set the cursor on them, maybe. */
16234 it
->current_x
= saved_x
;
16235 it
->object
= saved_object
;
16236 it
->position
= saved_pos
;
16237 it
->what
= saved_what
;
16238 it
->face_id
= saved_face_id
;
16243 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16244 trailing whitespace. */
16247 trailing_whitespace_p (charpos
)
16250 int bytepos
= CHAR_TO_BYTE (charpos
);
16253 while (bytepos
< ZV_BYTE
16254 && (c
= FETCH_CHAR (bytepos
),
16255 c
== ' ' || c
== '\t'))
16258 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16260 if (bytepos
!= PT_BYTE
)
16267 /* Highlight trailing whitespace, if any, in ROW. */
16270 highlight_trailing_whitespace (f
, row
)
16272 struct glyph_row
*row
;
16274 int used
= row
->used
[TEXT_AREA
];
16278 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16279 struct glyph
*glyph
= start
+ used
- 1;
16281 /* Skip over glyphs inserted to display the cursor at the
16282 end of a line, for extending the face of the last glyph
16283 to the end of the line on terminals, and for truncation
16284 and continuation glyphs. */
16285 while (glyph
>= start
16286 && glyph
->type
== CHAR_GLYPH
16287 && INTEGERP (glyph
->object
))
16290 /* If last glyph is a space or stretch, and it's trailing
16291 whitespace, set the face of all trailing whitespace glyphs in
16292 IT->glyph_row to `trailing-whitespace'. */
16294 && BUFFERP (glyph
->object
)
16295 && (glyph
->type
== STRETCH_GLYPH
16296 || (glyph
->type
== CHAR_GLYPH
16297 && glyph
->u
.ch
== ' '))
16298 && trailing_whitespace_p (glyph
->charpos
))
16300 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16304 while (glyph
>= start
16305 && BUFFERP (glyph
->object
)
16306 && (glyph
->type
== STRETCH_GLYPH
16307 || (glyph
->type
== CHAR_GLYPH
16308 && glyph
->u
.ch
== ' ')))
16309 (glyph
--)->face_id
= face_id
;
16315 /* Value is non-zero if glyph row ROW in window W should be
16316 used to hold the cursor. */
16319 cursor_row_p (w
, row
)
16321 struct glyph_row
*row
;
16323 int cursor_row_p
= 1;
16325 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16327 /* Suppose the row ends on a string.
16328 Unless the row is continued, that means it ends on a newline
16329 in the string. If it's anything other than a display string
16330 (e.g. a before-string from an overlay), we don't want the
16331 cursor there. (This heuristic seems to give the optimal
16332 behavior for the various types of multi-line strings.) */
16333 if (CHARPOS (row
->end
.string_pos
) >= 0)
16335 if (row
->continued_p
)
16339 /* Check for `display' property. */
16340 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16341 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16342 struct glyph
*glyph
;
16345 for (glyph
= end
; glyph
>= beg
; --glyph
)
16346 if (STRINGP (glyph
->object
))
16349 = Fget_char_property (make_number (PT
),
16353 && display_prop_string_p (prop
, glyph
->object
));
16358 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16360 /* If the row ends in middle of a real character,
16361 and the line is continued, we want the cursor here.
16362 That's because MATRIX_ROW_END_CHARPOS would equal
16363 PT if PT is before the character. */
16364 if (!row
->ends_in_ellipsis_p
)
16365 cursor_row_p
= row
->continued_p
;
16367 /* If the row ends in an ellipsis, then
16368 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16369 We want that position to be displayed after the ellipsis. */
16372 /* If the row ends at ZV, display the cursor at the end of that
16373 row instead of at the start of the row below. */
16374 else if (row
->ends_at_zv_p
)
16380 return cursor_row_p
;
16385 /* Push the display property PROP so that it will be rendered at the
16386 current position in IT. */
16389 push_display_prop (struct it
*it
, Lisp_Object prop
)
16393 /* Never display a cursor on the prefix. */
16394 it
->avoid_cursor_p
= 1;
16396 if (STRINGP (prop
))
16398 if (SCHARS (prop
) == 0)
16405 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16406 it
->current
.overlay_string_index
= -1;
16407 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16408 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16409 it
->method
= GET_FROM_STRING
;
16410 it
->stop_charpos
= 0;
16412 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16414 it
->method
= GET_FROM_STRETCH
;
16417 #ifdef HAVE_WINDOW_SYSTEM
16418 else if (IMAGEP (prop
))
16420 it
->what
= IT_IMAGE
;
16421 it
->image_id
= lookup_image (it
->f
, prop
);
16422 it
->method
= GET_FROM_IMAGE
;
16424 #endif /* HAVE_WINDOW_SYSTEM */
16427 pop_it (it
); /* bogus display property, give up */
16432 /* Return the character-property PROP at the current position in IT. */
16435 get_it_property (it
, prop
)
16439 Lisp_Object position
;
16441 if (STRINGP (it
->object
))
16442 position
= make_number (IT_STRING_CHARPOS (*it
));
16443 else if (BUFFERP (it
->object
))
16444 position
= make_number (IT_CHARPOS (*it
));
16448 return Fget_char_property (position
, prop
, it
->object
);
16451 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16454 handle_line_prefix (struct it
*it
)
16456 Lisp_Object prefix
;
16457 if (it
->continuation_lines_width
> 0)
16459 prefix
= get_it_property (it
, Qwrap_prefix
);
16461 prefix
= Vwrap_prefix
;
16465 prefix
= get_it_property (it
, Qline_prefix
);
16467 prefix
= Vline_prefix
;
16469 if (! NILP (prefix
))
16470 push_display_prop (it
, prefix
);
16475 /* Construct the glyph row IT->glyph_row in the desired matrix of
16476 IT->w from text at the current position of IT. See dispextern.h
16477 for an overview of struct it. Value is non-zero if
16478 IT->glyph_row displays text, as opposed to a line displaying ZV
16485 struct glyph_row
*row
= it
->glyph_row
;
16486 Lisp_Object overlay_arrow_string
;
16488 int may_wrap
= 0, wrap_x
;
16489 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16490 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16491 int wrap_row_extra_line_spacing
;
16493 /* We always start displaying at hpos zero even if hscrolled. */
16494 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16496 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16497 >= it
->w
->desired_matrix
->nrows
)
16499 it
->w
->nrows_scale_factor
++;
16500 fonts_changed_p
= 1;
16504 /* Is IT->w showing the region? */
16505 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16507 /* Clear the result glyph row and enable it. */
16508 prepare_desired_row (row
);
16510 row
->y
= it
->current_y
;
16511 row
->start
= it
->start
;
16512 row
->continuation_lines_width
= it
->continuation_lines_width
;
16513 row
->displays_text_p
= 1;
16514 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16515 it
->starts_in_middle_of_char_p
= 0;
16517 /* Arrange the overlays nicely for our purposes. Usually, we call
16518 display_line on only one line at a time, in which case this
16519 can't really hurt too much, or we call it on lines which appear
16520 one after another in the buffer, in which case all calls to
16521 recenter_overlay_lists but the first will be pretty cheap. */
16522 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16524 /* Move over display elements that are not visible because we are
16525 hscrolled. This may stop at an x-position < IT->first_visible_x
16526 if the first glyph is partially visible or if we hit a line end. */
16527 if (it
->current_x
< it
->first_visible_x
)
16529 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16530 MOVE_TO_POS
| MOVE_TO_X
);
16534 /* We only do this when not calling `move_it_in_display_line_to'
16535 above, because move_it_in_display_line_to calls
16536 handle_line_prefix itself. */
16537 handle_line_prefix (it
);
16540 /* Get the initial row height. This is either the height of the
16541 text hscrolled, if there is any, or zero. */
16542 row
->ascent
= it
->max_ascent
;
16543 row
->height
= it
->max_ascent
+ it
->max_descent
;
16544 row
->phys_ascent
= it
->max_phys_ascent
;
16545 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16546 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16548 /* Loop generating characters. The loop is left with IT on the next
16549 character to display. */
16552 int n_glyphs_before
, hpos_before
, x_before
;
16554 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16556 /* Retrieve the next thing to display. Value is zero if end of
16558 if (!get_next_display_element (it
))
16560 /* Maybe add a space at the end of this line that is used to
16561 display the cursor there under X. Set the charpos of the
16562 first glyph of blank lines not corresponding to any text
16564 #ifdef HAVE_WINDOW_SYSTEM
16565 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16566 row
->exact_window_width_line_p
= 1;
16568 #endif /* HAVE_WINDOW_SYSTEM */
16569 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16570 || row
->used
[TEXT_AREA
] == 0)
16572 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16573 row
->displays_text_p
= 0;
16575 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16576 && (!MINI_WINDOW_P (it
->w
)
16577 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16578 row
->indicate_empty_line_p
= 1;
16581 it
->continuation_lines_width
= 0;
16582 row
->ends_at_zv_p
= 1;
16586 /* Now, get the metrics of what we want to display. This also
16587 generates glyphs in `row' (which is IT->glyph_row). */
16588 n_glyphs_before
= row
->used
[TEXT_AREA
];
16591 /* Remember the line height so far in case the next element doesn't
16592 fit on the line. */
16593 if (it
->line_wrap
!= TRUNCATE
)
16595 ascent
= it
->max_ascent
;
16596 descent
= it
->max_descent
;
16597 phys_ascent
= it
->max_phys_ascent
;
16598 phys_descent
= it
->max_phys_descent
;
16600 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16602 if (IT_DISPLAYING_WHITESPACE (it
))
16608 wrap_row_used
= row
->used
[TEXT_AREA
];
16609 wrap_row_ascent
= row
->ascent
;
16610 wrap_row_height
= row
->height
;
16611 wrap_row_phys_ascent
= row
->phys_ascent
;
16612 wrap_row_phys_height
= row
->phys_height
;
16613 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16619 PRODUCE_GLYPHS (it
);
16621 /* If this display element was in marginal areas, continue with
16623 if (it
->area
!= TEXT_AREA
)
16625 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16626 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16627 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16628 row
->phys_height
= max (row
->phys_height
,
16629 it
->max_phys_ascent
+ it
->max_phys_descent
);
16630 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16631 it
->max_extra_line_spacing
);
16632 set_iterator_to_next (it
, 1);
16636 /* Does the display element fit on the line? If we truncate
16637 lines, we should draw past the right edge of the window. If
16638 we don't truncate, we want to stop so that we can display the
16639 continuation glyph before the right margin. If lines are
16640 continued, there are two possible strategies for characters
16641 resulting in more than 1 glyph (e.g. tabs): Display as many
16642 glyphs as possible in this line and leave the rest for the
16643 continuation line, or display the whole element in the next
16644 line. Original redisplay did the former, so we do it also. */
16645 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16646 hpos_before
= it
->hpos
;
16649 if (/* Not a newline. */
16651 /* Glyphs produced fit entirely in the line. */
16652 && it
->current_x
< it
->last_visible_x
)
16654 it
->hpos
+= nglyphs
;
16655 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16656 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16657 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16658 row
->phys_height
= max (row
->phys_height
,
16659 it
->max_phys_ascent
+ it
->max_phys_descent
);
16660 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16661 it
->max_extra_line_spacing
);
16662 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16663 row
->x
= x
- it
->first_visible_x
;
16668 struct glyph
*glyph
;
16670 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16672 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16673 new_x
= x
+ glyph
->pixel_width
;
16675 if (/* Lines are continued. */
16676 it
->line_wrap
!= TRUNCATE
16677 && (/* Glyph doesn't fit on the line. */
16678 new_x
> it
->last_visible_x
16679 /* Or it fits exactly on a window system frame. */
16680 || (new_x
== it
->last_visible_x
16681 && FRAME_WINDOW_P (it
->f
))))
16683 /* End of a continued line. */
16686 || (new_x
== it
->last_visible_x
16687 && FRAME_WINDOW_P (it
->f
)))
16689 /* Current glyph is the only one on the line or
16690 fits exactly on the line. We must continue
16691 the line because we can't draw the cursor
16692 after the glyph. */
16693 row
->continued_p
= 1;
16694 it
->current_x
= new_x
;
16695 it
->continuation_lines_width
+= new_x
;
16697 if (i
== nglyphs
- 1)
16699 /* If line-wrap is on, check if a previous
16700 wrap point was found. */
16701 if (wrap_row_used
> 0
16702 /* Even if there is a previous wrap
16703 point, continue the line here as
16704 usual, if (i) the previous character
16705 was a space or tab AND (ii) the
16706 current character is not. */
16708 || IT_DISPLAYING_WHITESPACE (it
)))
16711 set_iterator_to_next (it
, 1);
16712 #ifdef HAVE_WINDOW_SYSTEM
16713 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16715 if (!get_next_display_element (it
))
16717 row
->exact_window_width_line_p
= 1;
16718 it
->continuation_lines_width
= 0;
16719 row
->continued_p
= 0;
16720 row
->ends_at_zv_p
= 1;
16722 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16724 row
->continued_p
= 0;
16725 row
->exact_window_width_line_p
= 1;
16728 #endif /* HAVE_WINDOW_SYSTEM */
16731 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16732 && !FRAME_WINDOW_P (it
->f
))
16734 /* A padding glyph that doesn't fit on this line.
16735 This means the whole character doesn't fit
16737 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16739 /* Fill the rest of the row with continuation
16740 glyphs like in 20.x. */
16741 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16742 < row
->glyphs
[1 + TEXT_AREA
])
16743 produce_special_glyphs (it
, IT_CONTINUATION
);
16745 row
->continued_p
= 1;
16746 it
->current_x
= x_before
;
16747 it
->continuation_lines_width
+= x_before
;
16749 /* Restore the height to what it was before the
16750 element not fitting on the line. */
16751 it
->max_ascent
= ascent
;
16752 it
->max_descent
= descent
;
16753 it
->max_phys_ascent
= phys_ascent
;
16754 it
->max_phys_descent
= phys_descent
;
16756 else if (wrap_row_used
> 0)
16760 it
->continuation_lines_width
+= wrap_x
;
16761 row
->used
[TEXT_AREA
] = wrap_row_used
;
16762 row
->ascent
= wrap_row_ascent
;
16763 row
->height
= wrap_row_height
;
16764 row
->phys_ascent
= wrap_row_phys_ascent
;
16765 row
->phys_height
= wrap_row_phys_height
;
16766 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16767 row
->continued_p
= 1;
16768 row
->ends_at_zv_p
= 0;
16769 row
->exact_window_width_line_p
= 0;
16770 it
->continuation_lines_width
+= x
;
16772 /* Make sure that a non-default face is extended
16773 up to the right margin of the window. */
16774 extend_face_to_end_of_line (it
);
16776 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16778 /* A TAB that extends past the right edge of the
16779 window. This produces a single glyph on
16780 window system frames. We leave the glyph in
16781 this row and let it fill the row, but don't
16782 consume the TAB. */
16783 it
->continuation_lines_width
+= it
->last_visible_x
;
16784 row
->ends_in_middle_of_char_p
= 1;
16785 row
->continued_p
= 1;
16786 glyph
->pixel_width
= it
->last_visible_x
- x
;
16787 it
->starts_in_middle_of_char_p
= 1;
16791 /* Something other than a TAB that draws past
16792 the right edge of the window. Restore
16793 positions to values before the element. */
16794 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16796 /* Display continuation glyphs. */
16797 if (!FRAME_WINDOW_P (it
->f
))
16798 produce_special_glyphs (it
, IT_CONTINUATION
);
16799 row
->continued_p
= 1;
16801 it
->current_x
= x_before
;
16802 it
->continuation_lines_width
+= x
;
16803 extend_face_to_end_of_line (it
);
16805 if (nglyphs
> 1 && i
> 0)
16807 row
->ends_in_middle_of_char_p
= 1;
16808 it
->starts_in_middle_of_char_p
= 1;
16811 /* Restore the height to what it was before the
16812 element not fitting on the line. */
16813 it
->max_ascent
= ascent
;
16814 it
->max_descent
= descent
;
16815 it
->max_phys_ascent
= phys_ascent
;
16816 it
->max_phys_descent
= phys_descent
;
16821 else if (new_x
> it
->first_visible_x
)
16823 /* Increment number of glyphs actually displayed. */
16826 if (x
< it
->first_visible_x
)
16827 /* Glyph is partially visible, i.e. row starts at
16828 negative X position. */
16829 row
->x
= x
- it
->first_visible_x
;
16833 /* Glyph is completely off the left margin of the
16834 window. This should not happen because of the
16835 move_it_in_display_line at the start of this
16836 function, unless the text display area of the
16837 window is empty. */
16838 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16842 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16843 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16844 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16845 row
->phys_height
= max (row
->phys_height
,
16846 it
->max_phys_ascent
+ it
->max_phys_descent
);
16847 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16848 it
->max_extra_line_spacing
);
16850 /* End of this display line if row is continued. */
16851 if (row
->continued_p
|| row
->ends_at_zv_p
)
16856 /* Is this a line end? If yes, we're also done, after making
16857 sure that a non-default face is extended up to the right
16858 margin of the window. */
16859 if (ITERATOR_AT_END_OF_LINE_P (it
))
16861 int used_before
= row
->used
[TEXT_AREA
];
16863 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16865 #ifdef HAVE_WINDOW_SYSTEM
16866 /* Add a space at the end of the line that is used to
16867 display the cursor there. */
16868 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16869 append_space_for_newline (it
, 0);
16870 #endif /* HAVE_WINDOW_SYSTEM */
16872 /* Extend the face to the end of the line. */
16873 extend_face_to_end_of_line (it
);
16875 /* Make sure we have the position. */
16876 if (used_before
== 0)
16877 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16879 /* Consume the line end. This skips over invisible lines. */
16880 set_iterator_to_next (it
, 1);
16881 it
->continuation_lines_width
= 0;
16885 /* Proceed with next display element. Note that this skips
16886 over lines invisible because of selective display. */
16887 set_iterator_to_next (it
, 1);
16889 /* If we truncate lines, we are done when the last displayed
16890 glyphs reach past the right margin of the window. */
16891 if (it
->line_wrap
== TRUNCATE
16892 && (FRAME_WINDOW_P (it
->f
)
16893 ? (it
->current_x
>= it
->last_visible_x
)
16894 : (it
->current_x
> it
->last_visible_x
)))
16896 /* Maybe add truncation glyphs. */
16897 if (!FRAME_WINDOW_P (it
->f
))
16901 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16902 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16905 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16907 row
->used
[TEXT_AREA
] = i
;
16908 produce_special_glyphs (it
, IT_TRUNCATION
);
16911 #ifdef HAVE_WINDOW_SYSTEM
16914 /* Don't truncate if we can overflow newline into fringe. */
16915 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16917 if (!get_next_display_element (it
))
16919 it
->continuation_lines_width
= 0;
16920 row
->ends_at_zv_p
= 1;
16921 row
->exact_window_width_line_p
= 1;
16924 if (ITERATOR_AT_END_OF_LINE_P (it
))
16926 row
->exact_window_width_line_p
= 1;
16927 goto at_end_of_line
;
16931 #endif /* HAVE_WINDOW_SYSTEM */
16933 row
->truncated_on_right_p
= 1;
16934 it
->continuation_lines_width
= 0;
16935 reseat_at_next_visible_line_start (it
, 0);
16936 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16937 it
->hpos
= hpos_before
;
16938 it
->current_x
= x_before
;
16943 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16944 at the left window margin. */
16945 if (it
->first_visible_x
16946 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16948 if (!FRAME_WINDOW_P (it
->f
))
16949 insert_left_trunc_glyphs (it
);
16950 row
->truncated_on_left_p
= 1;
16953 /* If the start of this line is the overlay arrow-position, then
16954 mark this glyph row as the one containing the overlay arrow.
16955 This is clearly a mess with variable size fonts. It would be
16956 better to let it be displayed like cursors under X. */
16957 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16958 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16959 !NILP (overlay_arrow_string
)))
16961 /* Overlay arrow in window redisplay is a fringe bitmap. */
16962 if (STRINGP (overlay_arrow_string
))
16964 struct glyph_row
*arrow_row
16965 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16966 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16967 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16968 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16969 struct glyph
*p2
, *end
;
16971 /* Copy the arrow glyphs. */
16972 while (glyph
< arrow_end
)
16975 /* Throw away padding glyphs. */
16977 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16978 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16984 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16989 xassert (INTEGERP (overlay_arrow_string
));
16990 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16992 overlay_arrow_seen
= 1;
16995 /* Compute pixel dimensions of this line. */
16996 compute_line_metrics (it
);
16998 /* Remember the position at which this line ends. */
16999 row
->end
= it
->current
;
17001 /* Record whether this row ends inside an ellipsis. */
17002 row
->ends_in_ellipsis_p
17003 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17004 && it
->ellipsis_p
);
17006 /* Save fringe bitmaps in this row. */
17007 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17008 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17009 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17010 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17012 it
->left_user_fringe_bitmap
= 0;
17013 it
->left_user_fringe_face_id
= 0;
17014 it
->right_user_fringe_bitmap
= 0;
17015 it
->right_user_fringe_face_id
= 0;
17017 /* Maybe set the cursor. */
17018 if (it
->w
->cursor
.vpos
< 0
17019 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17020 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17021 && cursor_row_p (it
->w
, row
))
17022 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17024 /* Highlight trailing whitespace. */
17025 if (!NILP (Vshow_trailing_whitespace
))
17026 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17028 /* Prepare for the next line. This line starts horizontally at (X
17029 HPOS) = (0 0). Vertical positions are incremented. As a
17030 convenience for the caller, IT->glyph_row is set to the next
17032 it
->current_x
= it
->hpos
= 0;
17033 it
->current_y
+= row
->height
;
17036 it
->start
= it
->current
;
17037 return row
->displays_text_p
;
17042 /***********************************************************************
17044 ***********************************************************************/
17046 /* Redisplay the menu bar in the frame for window W.
17048 The menu bar of X frames that don't have X toolkit support is
17049 displayed in a special window W->frame->menu_bar_window.
17051 The menu bar of terminal frames is treated specially as far as
17052 glyph matrices are concerned. Menu bar lines are not part of
17053 windows, so the update is done directly on the frame matrix rows
17054 for the menu bar. */
17057 display_menu_bar (w
)
17060 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17065 /* Don't do all this for graphical frames. */
17067 if (FRAME_W32_P (f
))
17070 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17076 if (FRAME_NS_P (f
))
17078 #endif /* HAVE_NS */
17080 #ifdef USE_X_TOOLKIT
17081 xassert (!FRAME_WINDOW_P (f
));
17082 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17083 it
.first_visible_x
= 0;
17084 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17085 #else /* not USE_X_TOOLKIT */
17086 if (FRAME_WINDOW_P (f
))
17088 /* Menu bar lines are displayed in the desired matrix of the
17089 dummy window menu_bar_window. */
17090 struct window
*menu_w
;
17091 xassert (WINDOWP (f
->menu_bar_window
));
17092 menu_w
= XWINDOW (f
->menu_bar_window
);
17093 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17095 it
.first_visible_x
= 0;
17096 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17100 /* This is a TTY frame, i.e. character hpos/vpos are used as
17102 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17104 it
.first_visible_x
= 0;
17105 it
.last_visible_x
= FRAME_COLS (f
);
17107 #endif /* not USE_X_TOOLKIT */
17109 if (! mode_line_inverse_video
)
17110 /* Force the menu-bar to be displayed in the default face. */
17111 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17113 /* Clear all rows of the menu bar. */
17114 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17116 struct glyph_row
*row
= it
.glyph_row
+ i
;
17117 clear_glyph_row (row
);
17118 row
->enabled_p
= 1;
17119 row
->full_width_p
= 1;
17122 /* Display all items of the menu bar. */
17123 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17124 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17126 Lisp_Object string
;
17128 /* Stop at nil string. */
17129 string
= AREF (items
, i
+ 1);
17133 /* Remember where item was displayed. */
17134 ASET (items
, i
+ 3, make_number (it
.hpos
));
17136 /* Display the item, pad with one space. */
17137 if (it
.current_x
< it
.last_visible_x
)
17138 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17139 SCHARS (string
) + 1, 0, 0, -1);
17142 /* Fill out the line with spaces. */
17143 if (it
.current_x
< it
.last_visible_x
)
17144 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17146 /* Compute the total height of the lines. */
17147 compute_line_metrics (&it
);
17152 /***********************************************************************
17154 ***********************************************************************/
17156 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17157 FORCE is non-zero, redisplay mode lines unconditionally.
17158 Otherwise, redisplay only mode lines that are garbaged. Value is
17159 the number of windows whose mode lines were redisplayed. */
17162 redisplay_mode_lines (window
, force
)
17163 Lisp_Object window
;
17168 while (!NILP (window
))
17170 struct window
*w
= XWINDOW (window
);
17172 if (WINDOWP (w
->hchild
))
17173 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17174 else if (WINDOWP (w
->vchild
))
17175 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17177 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17178 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17180 struct text_pos lpoint
;
17181 struct buffer
*old
= current_buffer
;
17183 /* Set the window's buffer for the mode line display. */
17184 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17185 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17187 /* Point refers normally to the selected window. For any
17188 other window, set up appropriate value. */
17189 if (!EQ (window
, selected_window
))
17191 struct text_pos pt
;
17193 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17194 if (CHARPOS (pt
) < BEGV
)
17195 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17196 else if (CHARPOS (pt
) > (ZV
- 1))
17197 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17199 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17202 /* Display mode lines. */
17203 clear_glyph_matrix (w
->desired_matrix
);
17204 if (display_mode_lines (w
))
17207 w
->must_be_updated_p
= 1;
17210 /* Restore old settings. */
17211 set_buffer_internal_1 (old
);
17212 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17222 /* Display the mode and/or top line of window W. Value is the number
17223 of mode lines displayed. */
17226 display_mode_lines (w
)
17229 Lisp_Object old_selected_window
, old_selected_frame
;
17232 old_selected_frame
= selected_frame
;
17233 selected_frame
= w
->frame
;
17234 old_selected_window
= selected_window
;
17235 XSETWINDOW (selected_window
, w
);
17237 /* These will be set while the mode line specs are processed. */
17238 line_number_displayed
= 0;
17239 w
->column_number_displayed
= Qnil
;
17241 if (WINDOW_WANTS_MODELINE_P (w
))
17243 struct window
*sel_w
= XWINDOW (old_selected_window
);
17245 /* Select mode line face based on the real selected window. */
17246 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17247 current_buffer
->mode_line_format
);
17251 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17253 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17254 current_buffer
->header_line_format
);
17258 selected_frame
= old_selected_frame
;
17259 selected_window
= old_selected_window
;
17264 /* Display mode or top line of window W. FACE_ID specifies which line
17265 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
17266 FORMAT is the mode line format to display. Value is the pixel
17267 height of the mode line displayed. */
17270 display_mode_line (w
, face_id
, format
)
17272 enum face_id face_id
;
17273 Lisp_Object format
;
17277 int count
= SPECPDL_INDEX ();
17279 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17280 /* Don't extend on a previously drawn mode-line.
17281 This may happen if called from pos_visible_p. */
17282 it
.glyph_row
->enabled_p
= 0;
17283 prepare_desired_row (it
.glyph_row
);
17285 it
.glyph_row
->mode_line_p
= 1;
17287 if (! mode_line_inverse_video
)
17288 /* Force the mode-line to be displayed in the default face. */
17289 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17291 record_unwind_protect (unwind_format_mode_line
,
17292 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17294 mode_line_target
= MODE_LINE_DISPLAY
;
17296 /* Temporarily make frame's keyboard the current kboard so that
17297 kboard-local variables in the mode_line_format will get the right
17299 push_kboard (FRAME_KBOARD (it
.f
));
17300 record_unwind_save_match_data ();
17301 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17304 unbind_to (count
, Qnil
);
17306 /* Fill up with spaces. */
17307 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17309 compute_line_metrics (&it
);
17310 it
.glyph_row
->full_width_p
= 1;
17311 it
.glyph_row
->continued_p
= 0;
17312 it
.glyph_row
->truncated_on_left_p
= 0;
17313 it
.glyph_row
->truncated_on_right_p
= 0;
17315 /* Make a 3D mode-line have a shadow at its right end. */
17316 face
= FACE_FROM_ID (it
.f
, face_id
);
17317 extend_face_to_end_of_line (&it
);
17318 if (face
->box
!= FACE_NO_BOX
)
17320 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17321 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17322 last
->right_box_line_p
= 1;
17325 return it
.glyph_row
->height
;
17328 /* Move element ELT in LIST to the front of LIST.
17329 Return the updated list. */
17332 move_elt_to_front (elt
, list
)
17333 Lisp_Object elt
, list
;
17335 register Lisp_Object tail
, prev
;
17336 register Lisp_Object tem
;
17340 while (CONSP (tail
))
17346 /* Splice out the link TAIL. */
17348 list
= XCDR (tail
);
17350 Fsetcdr (prev
, XCDR (tail
));
17352 /* Now make it the first. */
17353 Fsetcdr (tail
, list
);
17358 tail
= XCDR (tail
);
17362 /* Not found--return unchanged LIST. */
17366 /* Contribute ELT to the mode line for window IT->w. How it
17367 translates into text depends on its data type.
17369 IT describes the display environment in which we display, as usual.
17371 DEPTH is the depth in recursion. It is used to prevent
17372 infinite recursion here.
17374 FIELD_WIDTH is the number of characters the display of ELT should
17375 occupy in the mode line, and PRECISION is the maximum number of
17376 characters to display from ELT's representation. See
17377 display_string for details.
17379 Returns the hpos of the end of the text generated by ELT.
17381 PROPS is a property list to add to any string we encounter.
17383 If RISKY is nonzero, remove (disregard) any properties in any string
17384 we encounter, and ignore :eval and :propertize.
17386 The global variable `mode_line_target' determines whether the
17387 output is passed to `store_mode_line_noprop',
17388 `store_mode_line_string', or `display_string'. */
17391 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17394 int field_width
, precision
;
17395 Lisp_Object elt
, props
;
17398 int n
= 0, field
, prec
;
17403 elt
= build_string ("*too-deep*");
17407 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17411 /* A string: output it and check for %-constructs within it. */
17415 if (SCHARS (elt
) > 0
17416 && (!NILP (props
) || risky
))
17418 Lisp_Object oprops
, aelt
;
17419 oprops
= Ftext_properties_at (make_number (0), elt
);
17421 /* If the starting string's properties are not what
17422 we want, translate the string. Also, if the string
17423 is risky, do that anyway. */
17425 if (NILP (Fequal (props
, oprops
)) || risky
)
17427 /* If the starting string has properties,
17428 merge the specified ones onto the existing ones. */
17429 if (! NILP (oprops
) && !risky
)
17433 oprops
= Fcopy_sequence (oprops
);
17435 while (CONSP (tem
))
17437 oprops
= Fplist_put (oprops
, XCAR (tem
),
17438 XCAR (XCDR (tem
)));
17439 tem
= XCDR (XCDR (tem
));
17444 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17445 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17447 /* AELT is what we want. Move it to the front
17448 without consing. */
17450 mode_line_proptrans_alist
17451 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17457 /* If AELT has the wrong props, it is useless.
17458 so get rid of it. */
17460 mode_line_proptrans_alist
17461 = Fdelq (aelt
, mode_line_proptrans_alist
);
17463 elt
= Fcopy_sequence (elt
);
17464 Fset_text_properties (make_number (0), Flength (elt
),
17466 /* Add this item to mode_line_proptrans_alist. */
17467 mode_line_proptrans_alist
17468 = Fcons (Fcons (elt
, props
),
17469 mode_line_proptrans_alist
);
17470 /* Truncate mode_line_proptrans_alist
17471 to at most 50 elements. */
17472 tem
= Fnthcdr (make_number (50),
17473 mode_line_proptrans_alist
);
17475 XSETCDR (tem
, Qnil
);
17484 prec
= precision
- n
;
17485 switch (mode_line_target
)
17487 case MODE_LINE_NOPROP
:
17488 case MODE_LINE_TITLE
:
17489 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17491 case MODE_LINE_STRING
:
17492 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17494 case MODE_LINE_DISPLAY
:
17495 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17496 0, prec
, 0, STRING_MULTIBYTE (elt
));
17503 /* Handle the non-literal case. */
17505 while ((precision
<= 0 || n
< precision
)
17506 && SREF (elt
, offset
) != 0
17507 && (mode_line_target
!= MODE_LINE_DISPLAY
17508 || it
->current_x
< it
->last_visible_x
))
17510 int last_offset
= offset
;
17512 /* Advance to end of string or next format specifier. */
17513 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17516 if (offset
- 1 != last_offset
)
17518 int nchars
, nbytes
;
17520 /* Output to end of string or up to '%'. Field width
17521 is length of string. Don't output more than
17522 PRECISION allows us. */
17525 prec
= c_string_width (SDATA (elt
) + last_offset
,
17526 offset
- last_offset
, precision
- n
,
17529 switch (mode_line_target
)
17531 case MODE_LINE_NOPROP
:
17532 case MODE_LINE_TITLE
:
17533 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17535 case MODE_LINE_STRING
:
17537 int bytepos
= last_offset
;
17538 int charpos
= string_byte_to_char (elt
, bytepos
);
17539 int endpos
= (precision
<= 0
17540 ? string_byte_to_char (elt
, offset
)
17541 : charpos
+ nchars
);
17543 n
+= store_mode_line_string (NULL
,
17544 Fsubstring (elt
, make_number (charpos
),
17545 make_number (endpos
)),
17549 case MODE_LINE_DISPLAY
:
17551 int bytepos
= last_offset
;
17552 int charpos
= string_byte_to_char (elt
, bytepos
);
17554 if (precision
<= 0)
17555 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17556 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17558 STRING_MULTIBYTE (elt
));
17563 else /* c == '%' */
17565 int percent_position
= offset
;
17567 /* Get the specified minimum width. Zero means
17570 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17571 field
= field
* 10 + c
- '0';
17573 /* Don't pad beyond the total padding allowed. */
17574 if (field_width
- n
> 0 && field
> field_width
- n
)
17575 field
= field_width
- n
;
17577 /* Note that either PRECISION <= 0 or N < PRECISION. */
17578 prec
= precision
- n
;
17581 n
+= display_mode_element (it
, depth
, field
, prec
,
17582 Vglobal_mode_string
, props
,
17587 int bytepos
, charpos
;
17588 unsigned char *spec
;
17590 bytepos
= percent_position
;
17591 charpos
= (STRING_MULTIBYTE (elt
)
17592 ? string_byte_to_char (elt
, bytepos
)
17595 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17597 switch (mode_line_target
)
17599 case MODE_LINE_NOPROP
:
17600 case MODE_LINE_TITLE
:
17601 n
+= store_mode_line_noprop (spec
, field
, prec
);
17603 case MODE_LINE_STRING
:
17605 int len
= strlen (spec
);
17606 Lisp_Object tem
= make_string (spec
, len
);
17607 props
= Ftext_properties_at (make_number (charpos
), elt
);
17608 /* Should only keep face property in props */
17609 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17612 case MODE_LINE_DISPLAY
:
17614 int nglyphs_before
, nwritten
;
17616 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17617 nwritten
= display_string (spec
, Qnil
, elt
,
17622 /* Assign to the glyphs written above the
17623 string where the `%x' came from, position
17627 struct glyph
*glyph
17628 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17632 for (i
= 0; i
< nwritten
; ++i
)
17634 glyph
[i
].object
= elt
;
17635 glyph
[i
].charpos
= charpos
;
17652 /* A symbol: process the value of the symbol recursively
17653 as if it appeared here directly. Avoid error if symbol void.
17654 Special case: if value of symbol is a string, output the string
17657 register Lisp_Object tem
;
17659 /* If the variable is not marked as risky to set
17660 then its contents are risky to use. */
17661 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17664 tem
= Fboundp (elt
);
17667 tem
= Fsymbol_value (elt
);
17668 /* If value is a string, output that string literally:
17669 don't check for % within it. */
17673 if (!EQ (tem
, elt
))
17675 /* Give up right away for nil or t. */
17685 register Lisp_Object car
, tem
;
17687 /* A cons cell: five distinct cases.
17688 If first element is :eval or :propertize, do something special.
17689 If first element is a string or a cons, process all the elements
17690 and effectively concatenate them.
17691 If first element is a negative number, truncate displaying cdr to
17692 at most that many characters. If positive, pad (with spaces)
17693 to at least that many characters.
17694 If first element is a symbol, process the cadr or caddr recursively
17695 according to whether the symbol's value is non-nil or nil. */
17697 if (EQ (car
, QCeval
))
17699 /* An element of the form (:eval FORM) means evaluate FORM
17700 and use the result as mode line elements. */
17705 if (CONSP (XCDR (elt
)))
17708 spec
= safe_eval (XCAR (XCDR (elt
)));
17709 n
+= display_mode_element (it
, depth
, field_width
- n
,
17710 precision
- n
, spec
, props
,
17714 else if (EQ (car
, QCpropertize
))
17716 /* An element of the form (:propertize ELT PROPS...)
17717 means display ELT but applying properties PROPS. */
17722 if (CONSP (XCDR (elt
)))
17723 n
+= display_mode_element (it
, depth
, field_width
- n
,
17724 precision
- n
, XCAR (XCDR (elt
)),
17725 XCDR (XCDR (elt
)), risky
);
17727 else if (SYMBOLP (car
))
17729 tem
= Fboundp (car
);
17733 /* elt is now the cdr, and we know it is a cons cell.
17734 Use its car if CAR has a non-nil value. */
17737 tem
= Fsymbol_value (car
);
17744 /* Symbol's value is nil (or symbol is unbound)
17745 Get the cddr of the original list
17746 and if possible find the caddr and use that. */
17750 else if (!CONSP (elt
))
17755 else if (INTEGERP (car
))
17757 register int lim
= XINT (car
);
17761 /* Negative int means reduce maximum width. */
17762 if (precision
<= 0)
17765 precision
= min (precision
, -lim
);
17769 /* Padding specified. Don't let it be more than
17770 current maximum. */
17772 lim
= min (precision
, lim
);
17774 /* If that's more padding than already wanted, queue it.
17775 But don't reduce padding already specified even if
17776 that is beyond the current truncation point. */
17777 field_width
= max (lim
, field_width
);
17781 else if (STRINGP (car
) || CONSP (car
))
17783 register int limit
= 50;
17784 /* Limit is to protect against circular lists. */
17787 && (precision
<= 0 || n
< precision
))
17789 n
+= display_mode_element (it
, depth
,
17790 /* Do padding only after the last
17791 element in the list. */
17792 (! CONSP (XCDR (elt
))
17795 precision
- n
, XCAR (elt
),
17805 elt
= build_string ("*invalid*");
17809 /* Pad to FIELD_WIDTH. */
17810 if (field_width
> 0 && n
< field_width
)
17812 switch (mode_line_target
)
17814 case MODE_LINE_NOPROP
:
17815 case MODE_LINE_TITLE
:
17816 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17818 case MODE_LINE_STRING
:
17819 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17821 case MODE_LINE_DISPLAY
:
17822 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17831 /* Store a mode-line string element in mode_line_string_list.
17833 If STRING is non-null, display that C string. Otherwise, the Lisp
17834 string LISP_STRING is displayed.
17836 FIELD_WIDTH is the minimum number of output glyphs to produce.
17837 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17838 with spaces. FIELD_WIDTH <= 0 means don't pad.
17840 PRECISION is the maximum number of characters to output from
17841 STRING. PRECISION <= 0 means don't truncate the string.
17843 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17844 properties to the string.
17846 PROPS are the properties to add to the string.
17847 The mode_line_string_face face property is always added to the string.
17851 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17853 Lisp_Object lisp_string
;
17862 if (string
!= NULL
)
17864 len
= strlen (string
);
17865 if (precision
> 0 && len
> precision
)
17867 lisp_string
= make_string (string
, len
);
17869 props
= mode_line_string_face_prop
;
17870 else if (!NILP (mode_line_string_face
))
17872 Lisp_Object face
= Fplist_get (props
, Qface
);
17873 props
= Fcopy_sequence (props
);
17875 face
= mode_line_string_face
;
17877 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17878 props
= Fplist_put (props
, Qface
, face
);
17880 Fadd_text_properties (make_number (0), make_number (len
),
17881 props
, lisp_string
);
17885 len
= XFASTINT (Flength (lisp_string
));
17886 if (precision
> 0 && len
> precision
)
17889 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17892 if (!NILP (mode_line_string_face
))
17896 props
= Ftext_properties_at (make_number (0), lisp_string
);
17897 face
= Fplist_get (props
, Qface
);
17899 face
= mode_line_string_face
;
17901 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17902 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17904 lisp_string
= Fcopy_sequence (lisp_string
);
17907 Fadd_text_properties (make_number (0), make_number (len
),
17908 props
, lisp_string
);
17913 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17917 if (field_width
> len
)
17919 field_width
-= len
;
17920 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17922 Fadd_text_properties (make_number (0), make_number (field_width
),
17923 props
, lisp_string
);
17924 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17932 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17934 doc
: /* Format a string out of a mode line format specification.
17935 First arg FORMAT specifies the mode line format (see `mode-line-format'
17936 for details) to use.
17938 Optional second arg FACE specifies the face property to put
17939 on all characters for which no face is specified.
17940 The value t means whatever face the window's mode line currently uses
17941 \(either `mode-line' or `mode-line-inactive', depending).
17942 A value of nil means the default is no face property.
17943 If FACE is an integer, the value string has no text properties.
17945 Optional third and fourth args WINDOW and BUFFER specify the window
17946 and buffer to use as the context for the formatting (defaults
17947 are the selected window and the window's buffer). */)
17948 (format
, face
, window
, buffer
)
17949 Lisp_Object format
, face
, window
, buffer
;
17954 struct buffer
*old_buffer
= NULL
;
17956 int no_props
= INTEGERP (face
);
17957 int count
= SPECPDL_INDEX ();
17959 int string_start
= 0;
17962 window
= selected_window
;
17963 CHECK_WINDOW (window
);
17964 w
= XWINDOW (window
);
17967 buffer
= w
->buffer
;
17968 CHECK_BUFFER (buffer
);
17970 /* Make formatting the modeline a non-op when noninteractive, otherwise
17971 there will be problems later caused by a partially initialized frame. */
17972 if (NILP (format
) || noninteractive
)
17973 return empty_unibyte_string
;
17981 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17982 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17986 face_id
= DEFAULT_FACE_ID
;
17988 if (XBUFFER (buffer
) != current_buffer
)
17989 old_buffer
= current_buffer
;
17991 /* Save things including mode_line_proptrans_alist,
17992 and set that to nil so that we don't alter the outer value. */
17993 record_unwind_protect (unwind_format_mode_line
,
17994 format_mode_line_unwind_data
17995 (old_buffer
, selected_window
, 1));
17996 mode_line_proptrans_alist
= Qnil
;
17998 Fselect_window (window
, Qt
);
18000 set_buffer_internal_1 (XBUFFER (buffer
));
18002 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18006 mode_line_target
= MODE_LINE_NOPROP
;
18007 mode_line_string_face_prop
= Qnil
;
18008 mode_line_string_list
= Qnil
;
18009 string_start
= MODE_LINE_NOPROP_LEN (0);
18013 mode_line_target
= MODE_LINE_STRING
;
18014 mode_line_string_list
= Qnil
;
18015 mode_line_string_face
= face
;
18016 mode_line_string_face_prop
18017 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18020 push_kboard (FRAME_KBOARD (it
.f
));
18021 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18026 len
= MODE_LINE_NOPROP_LEN (string_start
);
18027 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18031 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18032 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18033 empty_unibyte_string
);
18036 unbind_to (count
, Qnil
);
18040 /* Write a null-terminated, right justified decimal representation of
18041 the positive integer D to BUF using a minimal field width WIDTH. */
18044 pint2str (buf
, width
, d
)
18045 register char *buf
;
18046 register int width
;
18049 register char *p
= buf
;
18057 *p
++ = d
% 10 + '0';
18062 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18073 /* Write a null-terminated, right justified decimal and "human
18074 readable" representation of the nonnegative integer D to BUF using
18075 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18077 static const char power_letter
[] =
18091 pint2hrstr (buf
, width
, d
)
18096 /* We aim to represent the nonnegative integer D as
18097 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18100 /* -1 means: do not use TENTHS. */
18104 /* Length of QUOTIENT.TENTHS as a string. */
18110 if (1000 <= quotient
)
18112 /* Scale to the appropriate EXPONENT. */
18115 remainder
= quotient
% 1000;
18119 while (1000 <= quotient
);
18121 /* Round to nearest and decide whether to use TENTHS or not. */
18124 tenths
= remainder
/ 100;
18125 if (50 <= remainder
% 100)
18132 if (quotient
== 10)
18140 if (500 <= remainder
)
18142 if (quotient
< 999)
18153 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18154 if (tenths
== -1 && quotient
<= 99)
18161 p
= psuffix
= buf
+ max (width
, length
);
18163 /* Print EXPONENT. */
18165 *psuffix
++ = power_letter
[exponent
];
18168 /* Print TENTHS. */
18171 *--p
= '0' + tenths
;
18175 /* Print QUOTIENT. */
18178 int digit
= quotient
% 10;
18179 *--p
= '0' + digit
;
18181 while ((quotient
/= 10) != 0);
18183 /* Print leading spaces. */
18188 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18189 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18190 type of CODING_SYSTEM. Return updated pointer into BUF. */
18192 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18195 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18196 Lisp_Object coding_system
;
18197 register char *buf
;
18201 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18202 const unsigned char *eol_str
;
18204 /* The EOL conversion we are using. */
18205 Lisp_Object eoltype
;
18207 val
= CODING_SYSTEM_SPEC (coding_system
);
18210 if (!VECTORP (val
)) /* Not yet decided. */
18215 eoltype
= eol_mnemonic_undecided
;
18216 /* Don't mention EOL conversion if it isn't decided. */
18221 Lisp_Object eolvalue
;
18223 attrs
= AREF (val
, 0);
18224 eolvalue
= AREF (val
, 2);
18227 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18231 /* The EOL conversion that is normal on this system. */
18233 if (NILP (eolvalue
)) /* Not yet decided. */
18234 eoltype
= eol_mnemonic_undecided
;
18235 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18236 eoltype
= eol_mnemonic_undecided
;
18237 else /* eolvalue is Qunix, Qdos, or Qmac. */
18238 eoltype
= (EQ (eolvalue
, Qunix
)
18239 ? eol_mnemonic_unix
18240 : (EQ (eolvalue
, Qdos
) == 1
18241 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18247 /* Mention the EOL conversion if it is not the usual one. */
18248 if (STRINGP (eoltype
))
18250 eol_str
= SDATA (eoltype
);
18251 eol_str_len
= SBYTES (eoltype
);
18253 else if (CHARACTERP (eoltype
))
18255 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18256 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18261 eol_str
= invalid_eol_type
;
18262 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18264 bcopy (eol_str
, buf
, eol_str_len
);
18265 buf
+= eol_str_len
;
18271 /* Return a string for the output of a mode line %-spec for window W,
18272 generated by character C. PRECISION >= 0 means don't return a
18273 string longer than that value. FIELD_WIDTH > 0 means pad the
18274 string returned with spaces to that value. Return 1 in *MULTIBYTE
18275 if the result is multibyte text.
18277 Note we operate on the current buffer for most purposes,
18278 the exception being w->base_line_pos. */
18280 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18283 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
18286 int field_width
, precision
;
18290 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18291 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18292 struct buffer
*b
= current_buffer
;
18300 if (!NILP (b
->read_only
))
18302 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18307 /* This differs from %* only for a modified read-only buffer. */
18308 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18310 if (!NILP (b
->read_only
))
18315 /* This differs from %* in ignoring read-only-ness. */
18316 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18328 if (command_loop_level
> 5)
18330 p
= decode_mode_spec_buf
;
18331 for (i
= 0; i
< command_loop_level
; i
++)
18334 return decode_mode_spec_buf
;
18342 if (command_loop_level
> 5)
18344 p
= decode_mode_spec_buf
;
18345 for (i
= 0; i
< command_loop_level
; i
++)
18348 return decode_mode_spec_buf
;
18355 /* Let lots_of_dashes be a string of infinite length. */
18356 if (mode_line_target
== MODE_LINE_NOPROP
||
18357 mode_line_target
== MODE_LINE_STRING
)
18359 if (field_width
<= 0
18360 || field_width
> sizeof (lots_of_dashes
))
18362 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18363 decode_mode_spec_buf
[i
] = '-';
18364 decode_mode_spec_buf
[i
] = '\0';
18365 return decode_mode_spec_buf
;
18368 return lots_of_dashes
;
18376 /* %c and %l are ignored in `frame-title-format'.
18377 (In redisplay_internal, the frame title is drawn _before_ the
18378 windows are updated, so the stuff which depends on actual
18379 window contents (such as %l) may fail to render properly, or
18380 even crash emacs.) */
18381 if (mode_line_target
== MODE_LINE_TITLE
)
18385 int col
= (int) current_column (); /* iftc */
18386 w
->column_number_displayed
= make_number (col
);
18387 pint2str (decode_mode_spec_buf
, field_width
, col
);
18388 return decode_mode_spec_buf
;
18392 #ifndef SYSTEM_MALLOC
18394 if (NILP (Vmemory_full
))
18397 return "!MEM FULL! ";
18404 /* %F displays the frame name. */
18405 if (!NILP (f
->title
))
18406 return (char *) SDATA (f
->title
);
18407 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18408 return (char *) SDATA (f
->name
);
18417 int size
= ZV
- BEGV
;
18418 pint2str (decode_mode_spec_buf
, field_width
, size
);
18419 return decode_mode_spec_buf
;
18424 int size
= ZV
- BEGV
;
18425 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18426 return decode_mode_spec_buf
;
18431 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18432 int topline
, nlines
, junk
, height
;
18434 /* %c and %l are ignored in `frame-title-format'. */
18435 if (mode_line_target
== MODE_LINE_TITLE
)
18438 startpos
= XMARKER (w
->start
)->charpos
;
18439 startpos_byte
= marker_byte_position (w
->start
);
18440 height
= WINDOW_TOTAL_LINES (w
);
18442 /* If we decided that this buffer isn't suitable for line numbers,
18443 don't forget that too fast. */
18444 if (EQ (w
->base_line_pos
, w
->buffer
))
18446 /* But do forget it, if the window shows a different buffer now. */
18447 else if (BUFFERP (w
->base_line_pos
))
18448 w
->base_line_pos
= Qnil
;
18450 /* If the buffer is very big, don't waste time. */
18451 if (INTEGERP (Vline_number_display_limit
)
18452 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18454 w
->base_line_pos
= Qnil
;
18455 w
->base_line_number
= Qnil
;
18459 if (INTEGERP (w
->base_line_number
)
18460 && INTEGERP (w
->base_line_pos
)
18461 && XFASTINT (w
->base_line_pos
) <= startpos
)
18463 line
= XFASTINT (w
->base_line_number
);
18464 linepos
= XFASTINT (w
->base_line_pos
);
18465 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18470 linepos
= BUF_BEGV (b
);
18471 linepos_byte
= BUF_BEGV_BYTE (b
);
18474 /* Count lines from base line to window start position. */
18475 nlines
= display_count_lines (linepos
, linepos_byte
,
18479 topline
= nlines
+ line
;
18481 /* Determine a new base line, if the old one is too close
18482 or too far away, or if we did not have one.
18483 "Too close" means it's plausible a scroll-down would
18484 go back past it. */
18485 if (startpos
== BUF_BEGV (b
))
18487 w
->base_line_number
= make_number (topline
);
18488 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18490 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18491 || linepos
== BUF_BEGV (b
))
18493 int limit
= BUF_BEGV (b
);
18494 int limit_byte
= BUF_BEGV_BYTE (b
);
18496 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18498 if (startpos
- distance
> limit
)
18500 limit
= startpos
- distance
;
18501 limit_byte
= CHAR_TO_BYTE (limit
);
18504 nlines
= display_count_lines (startpos
, startpos_byte
,
18506 - (height
* 2 + 30),
18508 /* If we couldn't find the lines we wanted within
18509 line_number_display_limit_width chars per line,
18510 give up on line numbers for this window. */
18511 if (position
== limit_byte
&& limit
== startpos
- distance
)
18513 w
->base_line_pos
= w
->buffer
;
18514 w
->base_line_number
= Qnil
;
18518 w
->base_line_number
= make_number (topline
- nlines
);
18519 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18522 /* Now count lines from the start pos to point. */
18523 nlines
= display_count_lines (startpos
, startpos_byte
,
18524 PT_BYTE
, PT
, &junk
);
18526 /* Record that we did display the line number. */
18527 line_number_displayed
= 1;
18529 /* Make the string to show. */
18530 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18531 return decode_mode_spec_buf
;
18534 char* p
= decode_mode_spec_buf
;
18535 int pad
= field_width
- 2;
18541 return decode_mode_spec_buf
;
18547 obj
= b
->mode_name
;
18551 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18557 int pos
= marker_position (w
->start
);
18558 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18560 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18562 if (pos
<= BUF_BEGV (b
))
18567 else if (pos
<= BUF_BEGV (b
))
18571 if (total
> 1000000)
18572 /* Do it differently for a large value, to avoid overflow. */
18573 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18575 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18576 /* We can't normally display a 3-digit number,
18577 so get us a 2-digit number that is close. */
18580 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18581 return decode_mode_spec_buf
;
18585 /* Display percentage of size above the bottom of the screen. */
18588 int toppos
= marker_position (w
->start
);
18589 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18590 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18592 if (botpos
>= BUF_ZV (b
))
18594 if (toppos
<= BUF_BEGV (b
))
18601 if (total
> 1000000)
18602 /* Do it differently for a large value, to avoid overflow. */
18603 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18605 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18606 /* We can't normally display a 3-digit number,
18607 so get us a 2-digit number that is close. */
18610 if (toppos
<= BUF_BEGV (b
))
18611 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18613 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18614 return decode_mode_spec_buf
;
18619 /* status of process */
18620 obj
= Fget_buffer_process (Fcurrent_buffer ());
18622 return "no process";
18623 #ifdef subprocesses
18624 obj
= Fsymbol_name (Fprocess_status (obj
));
18631 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18638 case 't': /* indicate TEXT or BINARY */
18639 #ifdef MODE_LINE_BINARY_TEXT
18640 return MODE_LINE_BINARY_TEXT (b
);
18646 /* coding-system (not including end-of-line format) */
18648 /* coding-system (including end-of-line type) */
18650 int eol_flag
= (c
== 'Z');
18651 char *p
= decode_mode_spec_buf
;
18653 if (! FRAME_WINDOW_P (f
))
18655 /* No need to mention EOL here--the terminal never needs
18656 to do EOL conversion. */
18657 p
= decode_mode_spec_coding (CODING_ID_NAME
18658 (FRAME_KEYBOARD_CODING (f
)->id
),
18660 p
= decode_mode_spec_coding (CODING_ID_NAME
18661 (FRAME_TERMINAL_CODING (f
)->id
),
18664 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18667 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18668 #ifdef subprocesses
18669 obj
= Fget_buffer_process (Fcurrent_buffer ());
18670 if (PROCESSP (obj
))
18672 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18674 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18677 #endif /* subprocesses */
18680 return decode_mode_spec_buf
;
18686 *multibyte
= STRING_MULTIBYTE (obj
);
18687 return (char *) SDATA (obj
);
18694 /* Count up to COUNT lines starting from START / START_BYTE.
18695 But don't go beyond LIMIT_BYTE.
18696 Return the number of lines thus found (always nonnegative).
18698 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18701 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18702 int start
, start_byte
, limit_byte
, count
;
18705 register unsigned char *cursor
;
18706 unsigned char *base
;
18708 register int ceiling
;
18709 register unsigned char *ceiling_addr
;
18710 int orig_count
= count
;
18712 /* If we are not in selective display mode,
18713 check only for newlines. */
18714 int selective_display
= (!NILP (current_buffer
->selective_display
)
18715 && !INTEGERP (current_buffer
->selective_display
));
18719 while (start_byte
< limit_byte
)
18721 ceiling
= BUFFER_CEILING_OF (start_byte
);
18722 ceiling
= min (limit_byte
- 1, ceiling
);
18723 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18724 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18727 if (selective_display
)
18728 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18731 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18734 if (cursor
!= ceiling_addr
)
18738 start_byte
+= cursor
- base
+ 1;
18739 *byte_pos_ptr
= start_byte
;
18743 if (++cursor
== ceiling_addr
)
18749 start_byte
+= cursor
- base
;
18754 while (start_byte
> limit_byte
)
18756 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18757 ceiling
= max (limit_byte
, ceiling
);
18758 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18759 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18762 if (selective_display
)
18763 while (--cursor
!= ceiling_addr
18764 && *cursor
!= '\n' && *cursor
!= 015)
18767 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18770 if (cursor
!= ceiling_addr
)
18774 start_byte
+= cursor
- base
+ 1;
18775 *byte_pos_ptr
= start_byte
;
18776 /* When scanning backwards, we should
18777 not count the newline posterior to which we stop. */
18778 return - orig_count
- 1;
18784 /* Here we add 1 to compensate for the last decrement
18785 of CURSOR, which took it past the valid range. */
18786 start_byte
+= cursor
- base
+ 1;
18790 *byte_pos_ptr
= limit_byte
;
18793 return - orig_count
+ count
;
18794 return orig_count
- count
;
18800 /***********************************************************************
18802 ***********************************************************************/
18804 /* Display a NUL-terminated string, starting with index START.
18806 If STRING is non-null, display that C string. Otherwise, the Lisp
18807 string LISP_STRING is displayed.
18809 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18810 FACE_STRING. Display STRING or LISP_STRING with the face at
18811 FACE_STRING_POS in FACE_STRING:
18813 Display the string in the environment given by IT, but use the
18814 standard display table, temporarily.
18816 FIELD_WIDTH is the minimum number of output glyphs to produce.
18817 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18818 with spaces. If STRING has more characters, more than FIELD_WIDTH
18819 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18821 PRECISION is the maximum number of characters to output from
18822 STRING. PRECISION < 0 means don't truncate the string.
18824 This is roughly equivalent to printf format specifiers:
18826 FIELD_WIDTH PRECISION PRINTF
18827 ----------------------------------------
18833 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18834 display them, and < 0 means obey the current buffer's value of
18835 enable_multibyte_characters.
18837 Value is the number of columns displayed. */
18840 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18841 start
, it
, field_width
, precision
, max_x
, multibyte
)
18842 unsigned char *string
;
18843 Lisp_Object lisp_string
;
18844 Lisp_Object face_string
;
18845 EMACS_INT face_string_pos
;
18848 int field_width
, precision
, max_x
;
18851 int hpos_at_start
= it
->hpos
;
18852 int saved_face_id
= it
->face_id
;
18853 struct glyph_row
*row
= it
->glyph_row
;
18855 /* Initialize the iterator IT for iteration over STRING beginning
18856 with index START. */
18857 reseat_to_string (it
, string
, lisp_string
, start
,
18858 precision
, field_width
, multibyte
);
18860 /* If displaying STRING, set up the face of the iterator
18861 from LISP_STRING, if that's given. */
18862 if (STRINGP (face_string
))
18868 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18869 0, it
->region_beg_charpos
,
18870 it
->region_end_charpos
,
18871 &endptr
, it
->base_face_id
, 0);
18872 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18873 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18876 /* Set max_x to the maximum allowed X position. Don't let it go
18877 beyond the right edge of the window. */
18879 max_x
= it
->last_visible_x
;
18881 max_x
= min (max_x
, it
->last_visible_x
);
18883 /* Skip over display elements that are not visible. because IT->w is
18885 if (it
->current_x
< it
->first_visible_x
)
18886 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18887 MOVE_TO_POS
| MOVE_TO_X
);
18889 row
->ascent
= it
->max_ascent
;
18890 row
->height
= it
->max_ascent
+ it
->max_descent
;
18891 row
->phys_ascent
= it
->max_phys_ascent
;
18892 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18893 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18895 /* This condition is for the case that we are called with current_x
18896 past last_visible_x. */
18897 while (it
->current_x
< max_x
)
18899 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18901 /* Get the next display element. */
18902 if (!get_next_display_element (it
))
18905 /* Produce glyphs. */
18906 x_before
= it
->current_x
;
18907 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18908 PRODUCE_GLYPHS (it
);
18910 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18913 while (i
< nglyphs
)
18915 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18917 if (it
->line_wrap
!= TRUNCATE
18918 && x
+ glyph
->pixel_width
> max_x
)
18920 /* End of continued line or max_x reached. */
18921 if (CHAR_GLYPH_PADDING_P (*glyph
))
18923 /* A wide character is unbreakable. */
18924 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18925 it
->current_x
= x_before
;
18929 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18934 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18936 /* Glyph is at least partially visible. */
18938 if (x
< it
->first_visible_x
)
18939 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18943 /* Glyph is off the left margin of the display area.
18944 Should not happen. */
18948 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18949 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18950 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18951 row
->phys_height
= max (row
->phys_height
,
18952 it
->max_phys_ascent
+ it
->max_phys_descent
);
18953 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18954 it
->max_extra_line_spacing
);
18955 x
+= glyph
->pixel_width
;
18959 /* Stop if max_x reached. */
18963 /* Stop at line ends. */
18964 if (ITERATOR_AT_END_OF_LINE_P (it
))
18966 it
->continuation_lines_width
= 0;
18970 set_iterator_to_next (it
, 1);
18972 /* Stop if truncating at the right edge. */
18973 if (it
->line_wrap
== TRUNCATE
18974 && it
->current_x
>= it
->last_visible_x
)
18976 /* Add truncation mark, but don't do it if the line is
18977 truncated at a padding space. */
18978 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18980 if (!FRAME_WINDOW_P (it
->f
))
18984 if (it
->current_x
> it
->last_visible_x
)
18986 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18987 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18989 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18991 row
->used
[TEXT_AREA
] = i
;
18992 produce_special_glyphs (it
, IT_TRUNCATION
);
18995 produce_special_glyphs (it
, IT_TRUNCATION
);
18997 it
->glyph_row
->truncated_on_right_p
= 1;
19003 /* Maybe insert a truncation at the left. */
19004 if (it
->first_visible_x
19005 && IT_CHARPOS (*it
) > 0)
19007 if (!FRAME_WINDOW_P (it
->f
))
19008 insert_left_trunc_glyphs (it
);
19009 it
->glyph_row
->truncated_on_left_p
= 1;
19012 it
->face_id
= saved_face_id
;
19014 /* Value is number of columns displayed. */
19015 return it
->hpos
- hpos_at_start
;
19020 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19021 appears as an element of LIST or as the car of an element of LIST.
19022 If PROPVAL is a list, compare each element against LIST in that
19023 way, and return 1/2 if any element of PROPVAL is found in LIST.
19024 Otherwise return 0. This function cannot quit.
19025 The return value is 2 if the text is invisible but with an ellipsis
19026 and 1 if it's invisible and without an ellipsis. */
19029 invisible_p (propval
, list
)
19030 register Lisp_Object propval
;
19033 register Lisp_Object tail
, proptail
;
19035 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19037 register Lisp_Object tem
;
19039 if (EQ (propval
, tem
))
19041 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19042 return NILP (XCDR (tem
)) ? 1 : 2;
19045 if (CONSP (propval
))
19047 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19049 Lisp_Object propelt
;
19050 propelt
= XCAR (proptail
);
19051 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19053 register Lisp_Object tem
;
19055 if (EQ (propelt
, tem
))
19057 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19058 return NILP (XCDR (tem
)) ? 1 : 2;
19066 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19067 doc
: /* Non-nil if the property makes the text invisible.
19068 POS-OR-PROP can be a marker or number, in which case it is taken to be
19069 a position in the current buffer and the value of the `invisible' property
19070 is checked; or it can be some other value, which is then presumed to be the
19071 value of the `invisible' property of the text of interest.
19072 The non-nil value returned can be t for truly invisible text or something
19073 else if the text is replaced by an ellipsis. */)
19075 Lisp_Object pos_or_prop
;
19078 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19079 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19081 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19082 return (invis
== 0 ? Qnil
19084 : make_number (invis
));
19087 /* Calculate a width or height in pixels from a specification using
19088 the following elements:
19091 NUM - a (fractional) multiple of the default font width/height
19092 (NUM) - specifies exactly NUM pixels
19093 UNIT - a fixed number of pixels, see below.
19094 ELEMENT - size of a display element in pixels, see below.
19095 (NUM . SPEC) - equals NUM * SPEC
19096 (+ SPEC SPEC ...) - add pixel values
19097 (- SPEC SPEC ...) - subtract pixel values
19098 (- SPEC) - negate pixel value
19101 INT or FLOAT - a number constant
19102 SYMBOL - use symbol's (buffer local) variable binding.
19105 in - pixels per inch *)
19106 mm - pixels per 1/1000 meter *)
19107 cm - pixels per 1/100 meter *)
19108 width - width of current font in pixels.
19109 height - height of current font in pixels.
19111 *) using the ratio(s) defined in display-pixels-per-inch.
19115 left-fringe - left fringe width in pixels
19116 right-fringe - right fringe width in pixels
19118 left-margin - left margin width in pixels
19119 right-margin - right margin width in pixels
19121 scroll-bar - scroll-bar area width in pixels
19125 Pixels corresponding to 5 inches:
19128 Total width of non-text areas on left side of window (if scroll-bar is on left):
19129 '(space :width (+ left-fringe left-margin scroll-bar))
19131 Align to first text column (in header line):
19132 '(space :align-to 0)
19134 Align to middle of text area minus half the width of variable `my-image'
19135 containing a loaded image:
19136 '(space :align-to (0.5 . (- text my-image)))
19138 Width of left margin minus width of 1 character in the default font:
19139 '(space :width (- left-margin 1))
19141 Width of left margin minus width of 2 characters in the current font:
19142 '(space :width (- left-margin (2 . width)))
19144 Center 1 character over left-margin (in header line):
19145 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19147 Different ways to express width of left fringe plus left margin minus one pixel:
19148 '(space :width (- (+ left-fringe left-margin) (1)))
19149 '(space :width (+ left-fringe left-margin (- (1))))
19150 '(space :width (+ left-fringe left-margin (-1)))
19154 #define NUMVAL(X) \
19155 ((INTEGERP (X) || FLOATP (X)) \
19160 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19165 int width_p
, *align_to
;
19169 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19170 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19173 return OK_PIXELS (0);
19175 xassert (FRAME_LIVE_P (it
->f
));
19177 if (SYMBOLP (prop
))
19179 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19181 char *unit
= SDATA (SYMBOL_NAME (prop
));
19183 if (unit
[0] == 'i' && unit
[1] == 'n')
19185 else if (unit
[0] == 'm' && unit
[1] == 'm')
19187 else if (unit
[0] == 'c' && unit
[1] == 'm')
19194 #ifdef HAVE_WINDOW_SYSTEM
19195 if (FRAME_WINDOW_P (it
->f
)
19197 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19198 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19200 return OK_PIXELS (ppi
/ pixels
);
19203 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19204 || (CONSP (Vdisplay_pixels_per_inch
)
19206 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19207 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19209 return OK_PIXELS (ppi
/ pixels
);
19215 #ifdef HAVE_WINDOW_SYSTEM
19216 if (EQ (prop
, Qheight
))
19217 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19218 if (EQ (prop
, Qwidth
))
19219 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19221 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19222 return OK_PIXELS (1);
19225 if (EQ (prop
, Qtext
))
19226 return OK_PIXELS (width_p
19227 ? window_box_width (it
->w
, TEXT_AREA
)
19228 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19230 if (align_to
&& *align_to
< 0)
19233 if (EQ (prop
, Qleft
))
19234 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19235 if (EQ (prop
, Qright
))
19236 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19237 if (EQ (prop
, Qcenter
))
19238 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19239 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19240 if (EQ (prop
, Qleft_fringe
))
19241 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19242 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19243 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19244 if (EQ (prop
, Qright_fringe
))
19245 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19246 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19247 : window_box_right_offset (it
->w
, TEXT_AREA
));
19248 if (EQ (prop
, Qleft_margin
))
19249 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19250 if (EQ (prop
, Qright_margin
))
19251 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19252 if (EQ (prop
, Qscroll_bar
))
19253 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19255 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19256 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19257 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19262 if (EQ (prop
, Qleft_fringe
))
19263 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19264 if (EQ (prop
, Qright_fringe
))
19265 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19266 if (EQ (prop
, Qleft_margin
))
19267 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19268 if (EQ (prop
, Qright_margin
))
19269 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19270 if (EQ (prop
, Qscroll_bar
))
19271 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19274 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19277 if (INTEGERP (prop
) || FLOATP (prop
))
19279 int base_unit
= (width_p
19280 ? FRAME_COLUMN_WIDTH (it
->f
)
19281 : FRAME_LINE_HEIGHT (it
->f
));
19282 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19287 Lisp_Object car
= XCAR (prop
);
19288 Lisp_Object cdr
= XCDR (prop
);
19292 #ifdef HAVE_WINDOW_SYSTEM
19293 if (FRAME_WINDOW_P (it
->f
)
19294 && valid_image_p (prop
))
19296 int id
= lookup_image (it
->f
, prop
);
19297 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19299 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19302 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19308 while (CONSP (cdr
))
19310 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19311 font
, width_p
, align_to
))
19314 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19319 if (EQ (car
, Qminus
))
19321 return OK_PIXELS (pixels
);
19324 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19327 if (INTEGERP (car
) || FLOATP (car
))
19330 pixels
= XFLOATINT (car
);
19332 return OK_PIXELS (pixels
);
19333 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19334 font
, width_p
, align_to
))
19335 return OK_PIXELS (pixels
* fact
);
19346 /***********************************************************************
19348 ***********************************************************************/
19350 #ifdef HAVE_WINDOW_SYSTEM
19355 dump_glyph_string (s
)
19356 struct glyph_string
*s
;
19358 fprintf (stderr
, "glyph string\n");
19359 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19360 s
->x
, s
->y
, s
->width
, s
->height
);
19361 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19362 fprintf (stderr
, " hl = %d\n", s
->hl
);
19363 fprintf (stderr
, " left overhang = %d, right = %d\n",
19364 s
->left_overhang
, s
->right_overhang
);
19365 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19366 fprintf (stderr
, " extends to end of line = %d\n",
19367 s
->extends_to_end_of_line_p
);
19368 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19369 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19372 #endif /* GLYPH_DEBUG */
19374 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19375 of XChar2b structures for S; it can't be allocated in
19376 init_glyph_string because it must be allocated via `alloca'. W
19377 is the window on which S is drawn. ROW and AREA are the glyph row
19378 and area within the row from which S is constructed. START is the
19379 index of the first glyph structure covered by S. HL is a
19380 face-override for drawing S. */
19383 #define OPTIONAL_HDC(hdc) hdc,
19384 #define DECLARE_HDC(hdc) HDC hdc;
19385 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19386 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19389 #ifndef OPTIONAL_HDC
19390 #define OPTIONAL_HDC(hdc)
19391 #define DECLARE_HDC(hdc)
19392 #define ALLOCATE_HDC(hdc, f)
19393 #define RELEASE_HDC(hdc, f)
19397 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19398 struct glyph_string
*s
;
19402 struct glyph_row
*row
;
19403 enum glyph_row_area area
;
19405 enum draw_glyphs_face hl
;
19407 bzero (s
, sizeof *s
);
19409 s
->f
= XFRAME (w
->frame
);
19413 s
->display
= FRAME_X_DISPLAY (s
->f
);
19414 s
->window
= FRAME_X_WINDOW (s
->f
);
19415 s
->char2b
= char2b
;
19419 s
->first_glyph
= row
->glyphs
[area
] + start
;
19420 s
->height
= row
->height
;
19421 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19423 /* Display the internal border below the tool-bar window. */
19424 if (WINDOWP (s
->f
->tool_bar_window
)
19425 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19426 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19428 s
->ybase
= s
->y
+ row
->ascent
;
19432 /* Append the list of glyph strings with head H and tail T to the list
19433 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19436 append_glyph_string_lists (head
, tail
, h
, t
)
19437 struct glyph_string
**head
, **tail
;
19438 struct glyph_string
*h
, *t
;
19452 /* Prepend the list of glyph strings with head H and tail T to the
19453 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19457 prepend_glyph_string_lists (head
, tail
, h
, t
)
19458 struct glyph_string
**head
, **tail
;
19459 struct glyph_string
*h
, *t
;
19473 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19474 Set *HEAD and *TAIL to the resulting list. */
19477 append_glyph_string (head
, tail
, s
)
19478 struct glyph_string
**head
, **tail
;
19479 struct glyph_string
*s
;
19481 s
->next
= s
->prev
= NULL
;
19482 append_glyph_string_lists (head
, tail
, s
, s
);
19486 /* Get face and two-byte form of character C in face FACE_ID on frame
19487 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19488 means we want to display multibyte text. DISPLAY_P non-zero means
19489 make sure that X resources for the face returned are allocated.
19490 Value is a pointer to a realized face that is ready for display if
19491 DISPLAY_P is non-zero. */
19493 static INLINE
struct face
*
19494 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19498 int multibyte_p
, display_p
;
19500 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19504 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19506 if (code
!= FONT_INVALID_CODE
)
19507 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19509 STORE_XCHAR2B (char2b
, 0, 0);
19512 /* Make sure X resources of the face are allocated. */
19513 #ifdef HAVE_X_WINDOWS
19517 xassert (face
!= NULL
);
19518 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19525 /* Get face and two-byte form of character glyph GLYPH on frame F.
19526 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19527 a pointer to a realized face that is ready for display. */
19529 static INLINE
struct face
*
19530 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19532 struct glyph
*glyph
;
19538 xassert (glyph
->type
== CHAR_GLYPH
);
19539 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19546 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19548 if (code
!= FONT_INVALID_CODE
)
19549 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19551 STORE_XCHAR2B (char2b
, 0, 0);
19554 /* Make sure X resources of the face are allocated. */
19555 xassert (face
!= NULL
);
19556 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19561 /* Fill glyph string S with composition components specified by S->cmp.
19563 BASE_FACE is the base face of the composition.
19564 S->cmp_from is the index of the first component for S.
19566 OVERLAPS non-zero means S should draw the foreground only, and use
19567 its physical height for clipping. See also draw_glyphs.
19569 Value is the index of a component not in S. */
19572 fill_composite_glyph_string (s
, base_face
, overlaps
)
19573 struct glyph_string
*s
;
19574 struct face
*base_face
;
19578 /* For all glyphs of this composition, starting at the offset
19579 S->cmp_from, until we reach the end of the definition or encounter a
19580 glyph that requires the different face, add it to S. */
19585 s
->for_overlaps
= overlaps
;
19588 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
19590 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19594 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19597 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19598 s
->char2b
+ i
, 1, 1);
19604 s
->font
= s
->face
->font
;
19606 else if (s
->face
!= face
)
19614 /* All glyph strings for the same composition has the same width,
19615 i.e. the width set for the first component of the composition. */
19616 s
->width
= s
->first_glyph
->pixel_width
;
19618 /* If the specified font could not be loaded, use the frame's
19619 default font, but record the fact that we couldn't load it in
19620 the glyph string so that we can draw rectangles for the
19621 characters of the glyph string. */
19622 if (s
->font
== NULL
)
19624 s
->font_not_found_p
= 1;
19625 s
->font
= FRAME_FONT (s
->f
);
19628 /* Adjust base line for subscript/superscript text. */
19629 s
->ybase
+= s
->first_glyph
->voffset
;
19631 /* This glyph string must always be drawn with 16-bit functions. */
19638 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
19639 struct glyph_string
*s
;
19641 int start
, end
, overlaps
;
19643 struct glyph
*glyph
, *last
;
19644 Lisp_Object lgstring
;
19647 s
->for_overlaps
= overlaps
;
19648 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19649 last
= s
->row
->glyphs
[s
->area
] + end
;
19650 s
->cmp_id
= glyph
->u
.cmp
.id
;
19651 s
->cmp_from
= glyph
->u
.cmp
.from
;
19652 s
->cmp_to
= glyph
->u
.cmp
.to
;
19653 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19654 lgstring
= composition_gstring_from_id (s
->cmp_id
);
19655 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
19657 while (glyph
< last
19658 && glyph
->u
.cmp
.automatic
19659 && glyph
->u
.cmp
.id
== s
->cmp_id
)
19660 s
->cmp_to
= (glyph
++)->u
.cmp
.to
;
19662 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
19664 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
19665 unsigned code
= LGLYPH_CODE (lglyph
);
19667 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
19669 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
19670 return glyph
- s
->row
->glyphs
[s
->area
];
19674 /* Fill glyph string S from a sequence of character glyphs.
19676 FACE_ID is the face id of the string. START is the index of the
19677 first glyph to consider, END is the index of the last + 1.
19678 OVERLAPS non-zero means S should draw the foreground only, and use
19679 its physical height for clipping. See also draw_glyphs.
19681 Value is the index of the first glyph not in S. */
19684 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19685 struct glyph_string
*s
;
19687 int start
, end
, overlaps
;
19689 struct glyph
*glyph
, *last
;
19691 int glyph_not_available_p
;
19693 xassert (s
->f
== XFRAME (s
->w
->frame
));
19694 xassert (s
->nchars
== 0);
19695 xassert (start
>= 0 && end
> start
);
19697 s
->for_overlaps
= overlaps
;
19698 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19699 last
= s
->row
->glyphs
[s
->area
] + end
;
19700 voffset
= glyph
->voffset
;
19701 s
->padding_p
= glyph
->padding_p
;
19702 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19704 while (glyph
< last
19705 && glyph
->type
== CHAR_GLYPH
19706 && glyph
->voffset
== voffset
19707 /* Same face id implies same font, nowadays. */
19708 && glyph
->face_id
== face_id
19709 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19713 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19714 s
->char2b
+ s
->nchars
,
19716 s
->two_byte_p
= two_byte_p
;
19718 xassert (s
->nchars
<= end
- start
);
19719 s
->width
+= glyph
->pixel_width
;
19720 if (glyph
++->padding_p
!= s
->padding_p
)
19724 s
->font
= s
->face
->font
;
19726 /* If the specified font could not be loaded, use the frame's font,
19727 but record the fact that we couldn't load it in
19728 S->font_not_found_p so that we can draw rectangles for the
19729 characters of the glyph string. */
19730 if (s
->font
== NULL
|| glyph_not_available_p
)
19732 s
->font_not_found_p
= 1;
19733 s
->font
= FRAME_FONT (s
->f
);
19736 /* Adjust base line for subscript/superscript text. */
19737 s
->ybase
+= voffset
;
19739 xassert (s
->face
&& s
->face
->gc
);
19740 return glyph
- s
->row
->glyphs
[s
->area
];
19744 /* Fill glyph string S from image glyph S->first_glyph. */
19747 fill_image_glyph_string (s
)
19748 struct glyph_string
*s
;
19750 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19751 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19753 s
->slice
= s
->first_glyph
->slice
;
19754 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19755 s
->font
= s
->face
->font
;
19756 s
->width
= s
->first_glyph
->pixel_width
;
19758 /* Adjust base line for subscript/superscript text. */
19759 s
->ybase
+= s
->first_glyph
->voffset
;
19763 /* Fill glyph string S from a sequence of stretch glyphs.
19765 ROW is the glyph row in which the glyphs are found, AREA is the
19766 area within the row. START is the index of the first glyph to
19767 consider, END is the index of the last + 1.
19769 Value is the index of the first glyph not in S. */
19772 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19773 struct glyph_string
*s
;
19774 struct glyph_row
*row
;
19775 enum glyph_row_area area
;
19778 struct glyph
*glyph
, *last
;
19779 int voffset
, face_id
;
19781 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19783 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19784 last
= s
->row
->glyphs
[s
->area
] + end
;
19785 face_id
= glyph
->face_id
;
19786 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19787 s
->font
= s
->face
->font
;
19788 s
->width
= glyph
->pixel_width
;
19790 voffset
= glyph
->voffset
;
19794 && glyph
->type
== STRETCH_GLYPH
19795 && glyph
->voffset
== voffset
19796 && glyph
->face_id
== face_id
);
19798 s
->width
+= glyph
->pixel_width
;
19800 /* Adjust base line for subscript/superscript text. */
19801 s
->ybase
+= voffset
;
19803 /* The case that face->gc == 0 is handled when drawing the glyph
19804 string by calling PREPARE_FACE_FOR_DISPLAY. */
19806 return glyph
- s
->row
->glyphs
[s
->area
];
19809 static struct font_metrics
*
19810 get_per_char_metric (f
, font
, char2b
)
19815 static struct font_metrics metrics
;
19816 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19818 if (! font
|| code
== FONT_INVALID_CODE
)
19820 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19825 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19826 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19827 assumed to be zero. */
19830 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19831 struct glyph
*glyph
;
19835 *left
= *right
= 0;
19837 if (glyph
->type
== CHAR_GLYPH
)
19841 struct font_metrics
*pcm
;
19843 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19844 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19846 if (pcm
->rbearing
> pcm
->width
)
19847 *right
= pcm
->rbearing
- pcm
->width
;
19848 if (pcm
->lbearing
< 0)
19849 *left
= -pcm
->lbearing
;
19852 else if (glyph
->type
== COMPOSITE_GLYPH
)
19854 if (! glyph
->u
.cmp
.automatic
)
19856 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
19858 if (cmp
->rbearing
- cmp
->pixel_width
)
19859 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19860 if (cmp
->lbearing
< 0);
19861 *left
= - cmp
->lbearing
;
19865 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
19866 struct font_metrics metrics
;
19868 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
19869 glyph
->u
.cmp
.to
, &metrics
);
19870 if (metrics
.rbearing
> metrics
.width
)
19871 *right
= metrics
.rbearing
;
19872 if (metrics
.lbearing
< 0)
19873 *left
= - metrics
.lbearing
;
19879 /* Return the index of the first glyph preceding glyph string S that
19880 is overwritten by S because of S's left overhang. Value is -1
19881 if no glyphs are overwritten. */
19884 left_overwritten (s
)
19885 struct glyph_string
*s
;
19889 if (s
->left_overhang
)
19892 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19893 int first
= s
->first_glyph
- glyphs
;
19895 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19896 x
-= glyphs
[i
].pixel_width
;
19907 /* Return the index of the first glyph preceding glyph string S that
19908 is overwriting S because of its right overhang. Value is -1 if no
19909 glyph in front of S overwrites S. */
19912 left_overwriting (s
)
19913 struct glyph_string
*s
;
19916 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19917 int first
= s
->first_glyph
- glyphs
;
19921 for (i
= first
- 1; i
>= 0; --i
)
19924 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19927 x
-= glyphs
[i
].pixel_width
;
19934 /* Return the index of the last glyph following glyph string S that is
19935 overwritten by S because of S's right overhang. Value is -1 if
19936 no such glyph is found. */
19939 right_overwritten (s
)
19940 struct glyph_string
*s
;
19944 if (s
->right_overhang
)
19947 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19948 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19949 int end
= s
->row
->used
[s
->area
];
19951 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19952 x
+= glyphs
[i
].pixel_width
;
19961 /* Return the index of the last glyph following glyph string S that
19962 overwrites S because of its left overhang. Value is negative
19963 if no such glyph is found. */
19966 right_overwriting (s
)
19967 struct glyph_string
*s
;
19970 int end
= s
->row
->used
[s
->area
];
19971 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19972 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19976 for (i
= first
; i
< end
; ++i
)
19979 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19982 x
+= glyphs
[i
].pixel_width
;
19989 /* Set background width of glyph string S. START is the index of the
19990 first glyph following S. LAST_X is the right-most x-position + 1
19991 in the drawing area. */
19994 set_glyph_string_background_width (s
, start
, last_x
)
19995 struct glyph_string
*s
;
19999 /* If the face of this glyph string has to be drawn to the end of
20000 the drawing area, set S->extends_to_end_of_line_p. */
20002 if (start
== s
->row
->used
[s
->area
]
20003 && s
->area
== TEXT_AREA
20004 && ((s
->row
->fill_line_p
20005 && (s
->hl
== DRAW_NORMAL_TEXT
20006 || s
->hl
== DRAW_IMAGE_RAISED
20007 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20008 || s
->hl
== DRAW_MOUSE_FACE
))
20009 s
->extends_to_end_of_line_p
= 1;
20011 /* If S extends its face to the end of the line, set its
20012 background_width to the distance to the right edge of the drawing
20014 if (s
->extends_to_end_of_line_p
)
20015 s
->background_width
= last_x
- s
->x
+ 1;
20017 s
->background_width
= s
->width
;
20021 /* Compute overhangs and x-positions for glyph string S and its
20022 predecessors, or successors. X is the starting x-position for S.
20023 BACKWARD_P non-zero means process predecessors. */
20026 compute_overhangs_and_x (s
, x
, backward_p
)
20027 struct glyph_string
*s
;
20035 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20036 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20046 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20047 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20057 /* The following macros are only called from draw_glyphs below.
20058 They reference the following parameters of that function directly:
20059 `w', `row', `area', and `overlap_p'
20060 as well as the following local variables:
20061 `s', `f', and `hdc' (in W32) */
20064 /* On W32, silently add local `hdc' variable to argument list of
20065 init_glyph_string. */
20066 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20067 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20069 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20070 init_glyph_string (s, char2b, w, row, area, start, hl)
20073 /* Add a glyph string for a stretch glyph to the list of strings
20074 between HEAD and TAIL. START is the index of the stretch glyph in
20075 row area AREA of glyph row ROW. END is the index of the last glyph
20076 in that glyph row area. X is the current output position assigned
20077 to the new glyph string constructed. HL overrides that face of the
20078 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20079 is the right-most x-position of the drawing area. */
20081 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20082 and below -- keep them on one line. */
20083 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20086 s = (struct glyph_string *) alloca (sizeof *s); \
20087 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20088 START = fill_stretch_glyph_string (s, row, area, START, END); \
20089 append_glyph_string (&HEAD, &TAIL, s); \
20095 /* Add a glyph string for an image glyph to the list of strings
20096 between HEAD and TAIL. START is the index of the image glyph in
20097 row area AREA of glyph row ROW. END is the index of the last glyph
20098 in that glyph row area. X is the current output position assigned
20099 to the new glyph string constructed. HL overrides that face of the
20100 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20101 is the right-most x-position of the drawing area. */
20103 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20106 s = (struct glyph_string *) alloca (sizeof *s); \
20107 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20108 fill_image_glyph_string (s); \
20109 append_glyph_string (&HEAD, &TAIL, s); \
20116 /* Add a glyph string for a sequence of character glyphs to the list
20117 of strings between HEAD and TAIL. START is the index of the first
20118 glyph in row area AREA of glyph row ROW that is part of the new
20119 glyph string. END is the index of the last glyph in that glyph row
20120 area. X is the current output position assigned to the new glyph
20121 string constructed. HL overrides that face of the glyph; e.g. it
20122 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20123 right-most x-position of the drawing area. */
20125 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20131 face_id = (row)->glyphs[area][START].face_id; \
20133 s = (struct glyph_string *) alloca (sizeof *s); \
20134 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20135 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20136 append_glyph_string (&HEAD, &TAIL, s); \
20138 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20143 /* Add a glyph string for a composite sequence to the list of strings
20144 between HEAD and TAIL. START is the index of the first glyph in
20145 row area AREA of glyph row ROW that is part of the new glyph
20146 string. END is the index of the last glyph in that glyph row area.
20147 X is the current output position assigned to the new glyph string
20148 constructed. HL overrides that face of the glyph; e.g. it is
20149 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20150 x-position of the drawing area. */
20152 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20154 int face_id = (row)->glyphs[area][START].face_id; \
20155 struct face *base_face = FACE_FROM_ID (f, face_id); \
20156 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20157 struct composition *cmp = composition_table[cmp_id]; \
20159 struct glyph_string *first_s; \
20162 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20164 /* Make glyph_strings for each glyph sequence that is drawable by \
20165 the same face, and append them to HEAD/TAIL. */ \
20166 for (n = 0; n < cmp->glyph_len;) \
20168 s = (struct glyph_string *) alloca (sizeof *s); \
20169 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20170 append_glyph_string (&(HEAD), &(TAIL), s); \
20176 n = fill_composite_glyph_string (s, base_face, overlaps); \
20184 /* Add a glyph string for a glyph-string sequence to the list of strings
20185 between HEAD and TAIL. */
20187 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20191 Lisp_Object gstring; \
20193 face_id = (row)->glyphs[area][START].face_id; \
20194 gstring = (composition_gstring_from_id \
20195 ((row)->glyphs[area][START].u.cmp.id)); \
20196 s = (struct glyph_string *) alloca (sizeof *s); \
20197 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20198 * LGSTRING_GLYPH_LEN (gstring)); \
20199 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20200 append_glyph_string (&(HEAD), &(TAIL), s); \
20202 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20206 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20207 of AREA of glyph row ROW on window W between indices START and END.
20208 HL overrides the face for drawing glyph strings, e.g. it is
20209 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20210 x-positions of the drawing area.
20212 This is an ugly monster macro construct because we must use alloca
20213 to allocate glyph strings (because draw_glyphs can be called
20214 asynchronously). */
20216 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20219 HEAD = TAIL = NULL; \
20220 while (START < END) \
20222 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20223 switch (first_glyph->type) \
20226 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20230 case COMPOSITE_GLYPH: \
20231 if (first_glyph->u.cmp.automatic) \
20232 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
20235 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20239 case STRETCH_GLYPH: \
20240 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20244 case IMAGE_GLYPH: \
20245 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20255 set_glyph_string_background_width (s, START, LAST_X); \
20262 /* Draw glyphs between START and END in AREA of ROW on window W,
20263 starting at x-position X. X is relative to AREA in W. HL is a
20264 face-override with the following meaning:
20266 DRAW_NORMAL_TEXT draw normally
20267 DRAW_CURSOR draw in cursor face
20268 DRAW_MOUSE_FACE draw in mouse face.
20269 DRAW_INVERSE_VIDEO draw in mode line face
20270 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20271 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20273 If OVERLAPS is non-zero, draw only the foreground of characters and
20274 clip to the physical height of ROW. Non-zero value also defines
20275 the overlapping part to be drawn:
20277 OVERLAPS_PRED overlap with preceding rows
20278 OVERLAPS_SUCC overlap with succeeding rows
20279 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20280 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20282 Value is the x-position reached, relative to AREA of W. */
20285 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20288 struct glyph_row
*row
;
20289 enum glyph_row_area area
;
20290 EMACS_INT start
, end
;
20291 enum draw_glyphs_face hl
;
20294 struct glyph_string
*head
, *tail
;
20295 struct glyph_string
*s
;
20296 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20297 int i
, j
, x_reached
, last_x
, area_left
= 0;
20298 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20301 ALLOCATE_HDC (hdc
, f
);
20303 /* Let's rather be paranoid than getting a SEGV. */
20304 end
= min (end
, row
->used
[area
]);
20305 start
= max (0, start
);
20306 start
= min (end
, start
);
20308 /* Translate X to frame coordinates. Set last_x to the right
20309 end of the drawing area. */
20310 if (row
->full_width_p
)
20312 /* X is relative to the left edge of W, without scroll bars
20314 area_left
= WINDOW_LEFT_EDGE_X (w
);
20315 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20319 area_left
= window_box_left (w
, area
);
20320 last_x
= area_left
+ window_box_width (w
, area
);
20324 /* Build a doubly-linked list of glyph_string structures between
20325 head and tail from what we have to draw. Note that the macro
20326 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20327 the reason we use a separate variable `i'. */
20329 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20331 x_reached
= tail
->x
+ tail
->background_width
;
20335 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20336 the row, redraw some glyphs in front or following the glyph
20337 strings built above. */
20338 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20340 struct glyph_string
*h
, *t
;
20341 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20342 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20345 /* If mouse highlighting is on, we may need to draw adjacent
20346 glyphs using mouse-face highlighting. */
20347 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20349 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20351 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20352 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20354 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20356 check_mouse_face
= 1;
20357 mouse_beg_col
= (row
== mouse_beg_row
)
20358 ? dpyinfo
->mouse_face_beg_col
: 0;
20359 mouse_end_col
= (row
== mouse_end_row
)
20360 ? dpyinfo
->mouse_face_end_col
20361 : row
->used
[TEXT_AREA
];
20365 /* Compute overhangs for all glyph strings. */
20366 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20367 for (s
= head
; s
; s
= s
->next
)
20368 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20370 /* Prepend glyph strings for glyphs in front of the first glyph
20371 string that are overwritten because of the first glyph
20372 string's left overhang. The background of all strings
20373 prepended must be drawn because the first glyph string
20375 i
= left_overwritten (head
);
20378 enum draw_glyphs_face overlap_hl
;
20380 /* If this row contains mouse highlighting, attempt to draw
20381 the overlapped glyphs with the correct highlight. This
20382 code fails if the overlap encompasses more than one glyph
20383 and mouse-highlight spans only some of these glyphs.
20384 However, making it work perfectly involves a lot more
20385 code, and I don't know if the pathological case occurs in
20386 practice, so we'll stick to this for now. --- cyd */
20387 if (check_mouse_face
20388 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20389 overlap_hl
= DRAW_MOUSE_FACE
;
20391 overlap_hl
= DRAW_NORMAL_TEXT
;
20394 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20395 overlap_hl
, dummy_x
, last_x
);
20396 compute_overhangs_and_x (t
, head
->x
, 1);
20397 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20401 /* Prepend glyph strings for glyphs in front of the first glyph
20402 string that overwrite that glyph string because of their
20403 right overhang. For these strings, only the foreground must
20404 be drawn, because it draws over the glyph string at `head'.
20405 The background must not be drawn because this would overwrite
20406 right overhangs of preceding glyphs for which no glyph
20408 i
= left_overwriting (head
);
20411 enum draw_glyphs_face overlap_hl
;
20413 if (check_mouse_face
20414 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20415 overlap_hl
= DRAW_MOUSE_FACE
;
20417 overlap_hl
= DRAW_NORMAL_TEXT
;
20420 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20421 overlap_hl
, dummy_x
, last_x
);
20422 for (s
= h
; s
; s
= s
->next
)
20423 s
->background_filled_p
= 1;
20424 compute_overhangs_and_x (t
, head
->x
, 1);
20425 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20428 /* Append glyphs strings for glyphs following the last glyph
20429 string tail that are overwritten by tail. The background of
20430 these strings has to be drawn because tail's foreground draws
20432 i
= right_overwritten (tail
);
20435 enum draw_glyphs_face overlap_hl
;
20437 if (check_mouse_face
20438 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20439 overlap_hl
= DRAW_MOUSE_FACE
;
20441 overlap_hl
= DRAW_NORMAL_TEXT
;
20443 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20444 overlap_hl
, x
, last_x
);
20445 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20446 append_glyph_string_lists (&head
, &tail
, h
, t
);
20450 /* Append glyph strings for glyphs following the last glyph
20451 string tail that overwrite tail. The foreground of such
20452 glyphs has to be drawn because it writes into the background
20453 of tail. The background must not be drawn because it could
20454 paint over the foreground of following glyphs. */
20455 i
= right_overwriting (tail
);
20458 enum draw_glyphs_face overlap_hl
;
20459 if (check_mouse_face
20460 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20461 overlap_hl
= DRAW_MOUSE_FACE
;
20463 overlap_hl
= DRAW_NORMAL_TEXT
;
20466 i
++; /* We must include the Ith glyph. */
20467 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20468 overlap_hl
, x
, last_x
);
20469 for (s
= h
; s
; s
= s
->next
)
20470 s
->background_filled_p
= 1;
20471 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20472 append_glyph_string_lists (&head
, &tail
, h
, t
);
20474 if (clip_head
|| clip_tail
)
20475 for (s
= head
; s
; s
= s
->next
)
20477 s
->clip_head
= clip_head
;
20478 s
->clip_tail
= clip_tail
;
20482 /* Draw all strings. */
20483 for (s
= head
; s
; s
= s
->next
)
20484 FRAME_RIF (f
)->draw_glyph_string (s
);
20487 /* When focus a sole frame and move horizontally, this sets on_p to 0
20488 causing a failure to erase prev cursor position. */
20489 if (area
== TEXT_AREA
20490 && !row
->full_width_p
20491 /* When drawing overlapping rows, only the glyph strings'
20492 foreground is drawn, which doesn't erase a cursor
20496 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20497 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20498 : (tail
? tail
->x
+ tail
->background_width
: x
));
20502 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20503 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20507 /* Value is the x-position up to which drawn, relative to AREA of W.
20508 This doesn't include parts drawn because of overhangs. */
20509 if (row
->full_width_p
)
20510 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20512 x_reached
-= area_left
;
20514 RELEASE_HDC (hdc
, f
);
20519 /* Expand row matrix if too narrow. Don't expand if area
20522 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20524 if (!fonts_changed_p \
20525 && (it->glyph_row->glyphs[area] \
20526 < it->glyph_row->glyphs[area + 1])) \
20528 it->w->ncols_scale_factor++; \
20529 fonts_changed_p = 1; \
20533 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20534 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20540 struct glyph
*glyph
;
20541 enum glyph_row_area area
= it
->area
;
20543 xassert (it
->glyph_row
);
20544 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20546 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20547 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20549 glyph
->charpos
= CHARPOS (it
->position
);
20550 glyph
->object
= it
->object
;
20551 if (it
->pixel_width
> 0)
20553 glyph
->pixel_width
= it
->pixel_width
;
20554 glyph
->padding_p
= 0;
20558 /* Assure at least 1-pixel width. Otherwise, cursor can't
20559 be displayed correctly. */
20560 glyph
->pixel_width
= 1;
20561 glyph
->padding_p
= 1;
20563 glyph
->ascent
= it
->ascent
;
20564 glyph
->descent
= it
->descent
;
20565 glyph
->voffset
= it
->voffset
;
20566 glyph
->type
= CHAR_GLYPH
;
20567 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20568 glyph
->multibyte_p
= it
->multibyte_p
;
20569 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20570 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20571 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20572 || it
->phys_descent
> it
->descent
);
20573 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20574 glyph
->face_id
= it
->face_id
;
20575 glyph
->u
.ch
= it
->char_to_display
;
20576 glyph
->slice
= null_glyph_slice
;
20577 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20578 ++it
->glyph_row
->used
[area
];
20581 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20584 /* Store one glyph for the composition IT->cmp_it.id in
20585 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
20589 append_composite_glyph (it
)
20592 struct glyph
*glyph
;
20593 enum glyph_row_area area
= it
->area
;
20595 xassert (it
->glyph_row
);
20597 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20598 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20600 glyph
->charpos
= CHARPOS (it
->position
);
20601 glyph
->object
= it
->object
;
20602 glyph
->pixel_width
= it
->pixel_width
;
20603 glyph
->ascent
= it
->ascent
;
20604 glyph
->descent
= it
->descent
;
20605 glyph
->voffset
= it
->voffset
;
20606 glyph
->type
= COMPOSITE_GLYPH
;
20607 if (it
->cmp_it
.ch
< 0)
20609 glyph
->u
.cmp
.automatic
= 0;
20610 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20614 glyph
->u
.cmp
.automatic
= 1;
20615 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20616 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
20617 glyph
->u
.cmp
.to
= it
->cmp_it
.to
;
20619 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20620 glyph
->multibyte_p
= it
->multibyte_p
;
20621 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20622 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20623 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20624 || it
->phys_descent
> it
->descent
);
20625 glyph
->padding_p
= 0;
20626 glyph
->glyph_not_available_p
= 0;
20627 glyph
->face_id
= it
->face_id
;
20628 glyph
->slice
= null_glyph_slice
;
20629 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20630 ++it
->glyph_row
->used
[area
];
20633 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20637 /* Change IT->ascent and IT->height according to the setting of
20641 take_vertical_position_into_account (it
)
20646 if (it
->voffset
< 0)
20647 /* Increase the ascent so that we can display the text higher
20649 it
->ascent
-= it
->voffset
;
20651 /* Increase the descent so that we can display the text lower
20653 it
->descent
+= it
->voffset
;
20658 /* Produce glyphs/get display metrics for the image IT is loaded with.
20659 See the description of struct display_iterator in dispextern.h for
20660 an overview of struct display_iterator. */
20663 produce_image_glyph (it
)
20668 int glyph_ascent
, crop
;
20669 struct glyph_slice slice
;
20671 xassert (it
->what
== IT_IMAGE
);
20673 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20675 /* Make sure X resources of the face is loaded. */
20676 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20678 if (it
->image_id
< 0)
20680 /* Fringe bitmap. */
20681 it
->ascent
= it
->phys_ascent
= 0;
20682 it
->descent
= it
->phys_descent
= 0;
20683 it
->pixel_width
= 0;
20688 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20690 /* Make sure X resources of the image is loaded. */
20691 prepare_image_for_display (it
->f
, img
);
20693 slice
.x
= slice
.y
= 0;
20694 slice
.width
= img
->width
;
20695 slice
.height
= img
->height
;
20697 if (INTEGERP (it
->slice
.x
))
20698 slice
.x
= XINT (it
->slice
.x
);
20699 else if (FLOATP (it
->slice
.x
))
20700 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20702 if (INTEGERP (it
->slice
.y
))
20703 slice
.y
= XINT (it
->slice
.y
);
20704 else if (FLOATP (it
->slice
.y
))
20705 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20707 if (INTEGERP (it
->slice
.width
))
20708 slice
.width
= XINT (it
->slice
.width
);
20709 else if (FLOATP (it
->slice
.width
))
20710 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20712 if (INTEGERP (it
->slice
.height
))
20713 slice
.height
= XINT (it
->slice
.height
);
20714 else if (FLOATP (it
->slice
.height
))
20715 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20717 if (slice
.x
>= img
->width
)
20718 slice
.x
= img
->width
;
20719 if (slice
.y
>= img
->height
)
20720 slice
.y
= img
->height
;
20721 if (slice
.x
+ slice
.width
>= img
->width
)
20722 slice
.width
= img
->width
- slice
.x
;
20723 if (slice
.y
+ slice
.height
> img
->height
)
20724 slice
.height
= img
->height
- slice
.y
;
20726 if (slice
.width
== 0 || slice
.height
== 0)
20729 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20731 it
->descent
= slice
.height
- glyph_ascent
;
20733 it
->descent
+= img
->vmargin
;
20734 if (slice
.y
+ slice
.height
== img
->height
)
20735 it
->descent
+= img
->vmargin
;
20736 it
->phys_descent
= it
->descent
;
20738 it
->pixel_width
= slice
.width
;
20740 it
->pixel_width
+= img
->hmargin
;
20741 if (slice
.x
+ slice
.width
== img
->width
)
20742 it
->pixel_width
+= img
->hmargin
;
20744 /* It's quite possible for images to have an ascent greater than
20745 their height, so don't get confused in that case. */
20746 if (it
->descent
< 0)
20749 #if 0 /* this breaks image tiling */
20750 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20751 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20752 if (face_ascent
> it
->ascent
)
20753 it
->ascent
= it
->phys_ascent
= face_ascent
;
20758 if (face
->box
!= FACE_NO_BOX
)
20760 if (face
->box_line_width
> 0)
20763 it
->ascent
+= face
->box_line_width
;
20764 if (slice
.y
+ slice
.height
== img
->height
)
20765 it
->descent
+= face
->box_line_width
;
20768 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20769 it
->pixel_width
+= eabs (face
->box_line_width
);
20770 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20771 it
->pixel_width
+= eabs (face
->box_line_width
);
20774 take_vertical_position_into_account (it
);
20776 /* Automatically crop wide image glyphs at right edge so we can
20777 draw the cursor on same display row. */
20778 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20779 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20781 it
->pixel_width
-= crop
;
20782 slice
.width
-= crop
;
20787 struct glyph
*glyph
;
20788 enum glyph_row_area area
= it
->area
;
20790 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20791 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20793 glyph
->charpos
= CHARPOS (it
->position
);
20794 glyph
->object
= it
->object
;
20795 glyph
->pixel_width
= it
->pixel_width
;
20796 glyph
->ascent
= glyph_ascent
;
20797 glyph
->descent
= it
->descent
;
20798 glyph
->voffset
= it
->voffset
;
20799 glyph
->type
= IMAGE_GLYPH
;
20800 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20801 glyph
->multibyte_p
= it
->multibyte_p
;
20802 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20803 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20804 glyph
->overlaps_vertically_p
= 0;
20805 glyph
->padding_p
= 0;
20806 glyph
->glyph_not_available_p
= 0;
20807 glyph
->face_id
= it
->face_id
;
20808 glyph
->u
.img_id
= img
->id
;
20809 glyph
->slice
= slice
;
20810 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20811 ++it
->glyph_row
->used
[area
];
20814 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20819 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20820 of the glyph, WIDTH and HEIGHT are the width and height of the
20821 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20824 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20826 Lisp_Object object
;
20830 struct glyph
*glyph
;
20831 enum glyph_row_area area
= it
->area
;
20833 xassert (ascent
>= 0 && ascent
<= height
);
20835 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20836 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20838 glyph
->charpos
= CHARPOS (it
->position
);
20839 glyph
->object
= object
;
20840 glyph
->pixel_width
= width
;
20841 glyph
->ascent
= ascent
;
20842 glyph
->descent
= height
- ascent
;
20843 glyph
->voffset
= it
->voffset
;
20844 glyph
->type
= STRETCH_GLYPH
;
20845 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20846 glyph
->multibyte_p
= it
->multibyte_p
;
20847 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20848 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20849 glyph
->overlaps_vertically_p
= 0;
20850 glyph
->padding_p
= 0;
20851 glyph
->glyph_not_available_p
= 0;
20852 glyph
->face_id
= it
->face_id
;
20853 glyph
->u
.stretch
.ascent
= ascent
;
20854 glyph
->u
.stretch
.height
= height
;
20855 glyph
->slice
= null_glyph_slice
;
20856 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20857 ++it
->glyph_row
->used
[area
];
20860 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20864 /* Produce a stretch glyph for iterator IT. IT->object is the value
20865 of the glyph property displayed. The value must be a list
20866 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20869 1. `:width WIDTH' specifies that the space should be WIDTH *
20870 canonical char width wide. WIDTH may be an integer or floating
20873 2. `:relative-width FACTOR' specifies that the width of the stretch
20874 should be computed from the width of the first character having the
20875 `glyph' property, and should be FACTOR times that width.
20877 3. `:align-to HPOS' specifies that the space should be wide enough
20878 to reach HPOS, a value in canonical character units.
20880 Exactly one of the above pairs must be present.
20882 4. `:height HEIGHT' specifies that the height of the stretch produced
20883 should be HEIGHT, measured in canonical character units.
20885 5. `:relative-height FACTOR' specifies that the height of the
20886 stretch should be FACTOR times the height of the characters having
20887 the glyph property.
20889 Either none or exactly one of 4 or 5 must be present.
20891 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20892 of the stretch should be used for the ascent of the stretch.
20893 ASCENT must be in the range 0 <= ASCENT <= 100. */
20896 produce_stretch_glyph (it
)
20899 /* (space :width WIDTH :height HEIGHT ...) */
20900 Lisp_Object prop
, plist
;
20901 int width
= 0, height
= 0, align_to
= -1;
20902 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20905 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20906 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20908 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20910 /* List should start with `space'. */
20911 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20912 plist
= XCDR (it
->object
);
20914 /* Compute the width of the stretch. */
20915 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20916 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20918 /* Absolute width `:width WIDTH' specified and valid. */
20919 zero_width_ok_p
= 1;
20922 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20925 /* Relative width `:relative-width FACTOR' specified and valid.
20926 Compute the width of the characters having the `glyph'
20929 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20932 if (it
->multibyte_p
)
20934 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20935 - IT_BYTEPOS (*it
));
20936 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20939 it2
.c
= *p
, it2
.len
= 1;
20941 it2
.glyph_row
= NULL
;
20942 it2
.what
= IT_CHARACTER
;
20943 x_produce_glyphs (&it2
);
20944 width
= NUMVAL (prop
) * it2
.pixel_width
;
20946 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20947 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20949 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20950 align_to
= (align_to
< 0
20952 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20953 else if (align_to
< 0)
20954 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20955 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20956 zero_width_ok_p
= 1;
20959 /* Nothing specified -> width defaults to canonical char width. */
20960 width
= FRAME_COLUMN_WIDTH (it
->f
);
20962 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20965 /* Compute height. */
20966 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20967 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20970 zero_height_ok_p
= 1;
20972 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20974 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20976 height
= FONT_HEIGHT (font
);
20978 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20981 /* Compute percentage of height used for ascent. If
20982 `:ascent ASCENT' is present and valid, use that. Otherwise,
20983 derive the ascent from the font in use. */
20984 if (prop
= Fplist_get (plist
, QCascent
),
20985 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20986 ascent
= height
* NUMVAL (prop
) / 100.0;
20987 else if (!NILP (prop
)
20988 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20989 ascent
= min (max (0, (int)tem
), height
);
20991 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20993 if (width
> 0 && it
->line_wrap
!= TRUNCATE
20994 && it
->current_x
+ width
> it
->last_visible_x
)
20995 width
= it
->last_visible_x
- it
->current_x
- 1;
20997 if (width
> 0 && height
> 0 && it
->glyph_row
)
20999 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21000 if (!STRINGP (object
))
21001 object
= it
->w
->buffer
;
21002 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21005 it
->pixel_width
= width
;
21006 it
->ascent
= it
->phys_ascent
= ascent
;
21007 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21008 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21010 take_vertical_position_into_account (it
);
21013 /* Calculate line-height and line-spacing properties.
21014 An integer value specifies explicit pixel value.
21015 A float value specifies relative value to current face height.
21016 A cons (float . face-name) specifies relative value to
21017 height of specified face font.
21019 Returns height in pixels, or nil. */
21023 calc_line_height_property (it
, val
, font
, boff
, override
)
21027 int boff
, override
;
21029 Lisp_Object face_name
= Qnil
;
21030 int ascent
, descent
, height
;
21032 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21037 face_name
= XCAR (val
);
21039 if (!NUMBERP (val
))
21040 val
= make_number (1);
21041 if (NILP (face_name
))
21043 height
= it
->ascent
+ it
->descent
;
21048 if (NILP (face_name
))
21050 font
= FRAME_FONT (it
->f
);
21051 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21053 else if (EQ (face_name
, Qt
))
21062 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21064 return make_number (-1);
21066 face
= FACE_FROM_ID (it
->f
, face_id
);
21069 return make_number (-1);
21070 boff
= font
->baseline_offset
;
21071 if (font
->vertical_centering
)
21072 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21075 ascent
= FONT_BASE (font
) + boff
;
21076 descent
= FONT_DESCENT (font
) - boff
;
21080 it
->override_ascent
= ascent
;
21081 it
->override_descent
= descent
;
21082 it
->override_boff
= boff
;
21085 height
= ascent
+ descent
;
21089 height
= (int)(XFLOAT_DATA (val
) * height
);
21090 else if (INTEGERP (val
))
21091 height
*= XINT (val
);
21093 return make_number (height
);
21098 Produce glyphs/get display metrics for the display element IT is
21099 loaded with. See the description of struct it in dispextern.h
21100 for an overview of struct it. */
21103 x_produce_glyphs (it
)
21106 int extra_line_spacing
= it
->extra_line_spacing
;
21108 it
->glyph_not_available_p
= 0;
21110 if (it
->what
== IT_CHARACTER
)
21114 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21115 struct font_metrics
*pcm
;
21116 int font_not_found_p
;
21117 int boff
; /* baseline offset */
21118 /* We may change it->multibyte_p upon unibyte<->multibyte
21119 conversion. So, save the current value now and restore it
21122 Note: It seems that we don't have to record multibyte_p in
21123 struct glyph because the character code itself tells if or
21124 not the character is multibyte. Thus, in the future, we must
21125 consider eliminating the field `multibyte_p' in the struct
21127 int saved_multibyte_p
= it
->multibyte_p
;
21129 /* Maybe translate single-byte characters to multibyte, or the
21131 it
->char_to_display
= it
->c
;
21132 if (!ASCII_BYTE_P (it
->c
)
21133 && ! it
->multibyte_p
)
21135 if (SINGLE_BYTE_CHAR_P (it
->c
)
21136 && unibyte_display_via_language_environment
)
21137 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
21138 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
21140 it
->multibyte_p
= 1;
21141 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21143 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21147 /* Get font to use. Encode IT->char_to_display. */
21148 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21149 &char2b
, it
->multibyte_p
, 0);
21152 /* When no suitable font found, use the default font. */
21153 font_not_found_p
= font
== NULL
;
21154 if (font_not_found_p
)
21156 font
= FRAME_FONT (it
->f
);
21157 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21161 boff
= font
->baseline_offset
;
21162 if (font
->vertical_centering
)
21163 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21166 if (it
->char_to_display
>= ' '
21167 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21169 /* Either unibyte or ASCII. */
21174 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21176 if (it
->override_ascent
>= 0)
21178 it
->ascent
= it
->override_ascent
;
21179 it
->descent
= it
->override_descent
;
21180 boff
= it
->override_boff
;
21184 it
->ascent
= FONT_BASE (font
) + boff
;
21185 it
->descent
= FONT_DESCENT (font
) - boff
;
21190 it
->phys_ascent
= pcm
->ascent
+ boff
;
21191 it
->phys_descent
= pcm
->descent
- boff
;
21192 it
->pixel_width
= pcm
->width
;
21196 it
->glyph_not_available_p
= 1;
21197 it
->phys_ascent
= it
->ascent
;
21198 it
->phys_descent
= it
->descent
;
21199 it
->pixel_width
= FONT_WIDTH (font
);
21202 if (it
->constrain_row_ascent_descent_p
)
21204 if (it
->descent
> it
->max_descent
)
21206 it
->ascent
+= it
->descent
- it
->max_descent
;
21207 it
->descent
= it
->max_descent
;
21209 if (it
->ascent
> it
->max_ascent
)
21211 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21212 it
->ascent
= it
->max_ascent
;
21214 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21215 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21216 extra_line_spacing
= 0;
21219 /* If this is a space inside a region of text with
21220 `space-width' property, change its width. */
21221 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21223 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21225 /* If face has a box, add the box thickness to the character
21226 height. If character has a box line to the left and/or
21227 right, add the box line width to the character's width. */
21228 if (face
->box
!= FACE_NO_BOX
)
21230 int thick
= face
->box_line_width
;
21234 it
->ascent
+= thick
;
21235 it
->descent
+= thick
;
21240 if (it
->start_of_box_run_p
)
21241 it
->pixel_width
+= thick
;
21242 if (it
->end_of_box_run_p
)
21243 it
->pixel_width
+= thick
;
21246 /* If face has an overline, add the height of the overline
21247 (1 pixel) and a 1 pixel margin to the character height. */
21248 if (face
->overline_p
)
21249 it
->ascent
+= overline_margin
;
21251 if (it
->constrain_row_ascent_descent_p
)
21253 if (it
->ascent
> it
->max_ascent
)
21254 it
->ascent
= it
->max_ascent
;
21255 if (it
->descent
> it
->max_descent
)
21256 it
->descent
= it
->max_descent
;
21259 take_vertical_position_into_account (it
);
21261 /* If we have to actually produce glyphs, do it. */
21266 /* Translate a space with a `space-width' property
21267 into a stretch glyph. */
21268 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21269 / FONT_HEIGHT (font
));
21270 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21271 it
->ascent
+ it
->descent
, ascent
);
21276 /* If characters with lbearing or rbearing are displayed
21277 in this line, record that fact in a flag of the
21278 glyph row. This is used to optimize X output code. */
21279 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21280 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21282 if (! stretched_p
&& it
->pixel_width
== 0)
21283 /* We assure that all visible glyphs have at least 1-pixel
21285 it
->pixel_width
= 1;
21287 else if (it
->char_to_display
== '\n')
21289 /* A newline has no width but we need the height of the line.
21290 But if previous part of the line set a height, don't
21291 increase that height */
21293 Lisp_Object height
;
21294 Lisp_Object total_height
= Qnil
;
21296 it
->override_ascent
= -1;
21297 it
->pixel_width
= 0;
21300 height
= get_it_property(it
, Qline_height
);
21301 /* Split (line-height total-height) list */
21303 && CONSP (XCDR (height
))
21304 && NILP (XCDR (XCDR (height
))))
21306 total_height
= XCAR (XCDR (height
));
21307 height
= XCAR (height
);
21309 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21311 if (it
->override_ascent
>= 0)
21313 it
->ascent
= it
->override_ascent
;
21314 it
->descent
= it
->override_descent
;
21315 boff
= it
->override_boff
;
21319 it
->ascent
= FONT_BASE (font
) + boff
;
21320 it
->descent
= FONT_DESCENT (font
) - boff
;
21323 if (EQ (height
, Qt
))
21325 if (it
->descent
> it
->max_descent
)
21327 it
->ascent
+= it
->descent
- it
->max_descent
;
21328 it
->descent
= it
->max_descent
;
21330 if (it
->ascent
> it
->max_ascent
)
21332 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21333 it
->ascent
= it
->max_ascent
;
21335 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21336 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21337 it
->constrain_row_ascent_descent_p
= 1;
21338 extra_line_spacing
= 0;
21342 Lisp_Object spacing
;
21344 it
->phys_ascent
= it
->ascent
;
21345 it
->phys_descent
= it
->descent
;
21347 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21348 && face
->box
!= FACE_NO_BOX
21349 && face
->box_line_width
> 0)
21351 it
->ascent
+= face
->box_line_width
;
21352 it
->descent
+= face
->box_line_width
;
21355 && XINT (height
) > it
->ascent
+ it
->descent
)
21356 it
->ascent
= XINT (height
) - it
->descent
;
21358 if (!NILP (total_height
))
21359 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21362 spacing
= get_it_property(it
, Qline_spacing
);
21363 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21365 if (INTEGERP (spacing
))
21367 extra_line_spacing
= XINT (spacing
);
21368 if (!NILP (total_height
))
21369 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21373 else if (it
->char_to_display
== '\t')
21375 if (font
->space_width
> 0)
21377 int tab_width
= it
->tab_width
* font
->space_width
;
21378 int x
= it
->current_x
+ it
->continuation_lines_width
;
21379 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21381 /* If the distance from the current position to the next tab
21382 stop is less than a space character width, use the
21383 tab stop after that. */
21384 if (next_tab_x
- x
< font
->space_width
)
21385 next_tab_x
+= tab_width
;
21387 it
->pixel_width
= next_tab_x
- x
;
21389 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21390 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21394 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21395 it
->ascent
+ it
->descent
, it
->ascent
);
21400 it
->pixel_width
= 0;
21406 /* A multi-byte character. Assume that the display width of the
21407 character is the width of the character multiplied by the
21408 width of the font. */
21410 /* If we found a font, this font should give us the right
21411 metrics. If we didn't find a font, use the frame's
21412 default font and calculate the width of the character by
21413 multiplying the width of font by the width of the
21416 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21418 if (font_not_found_p
|| !pcm
)
21420 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21422 if (char_width
== 0)
21423 /* This is a non spacing character. But, as we are
21424 going to display an empty box, the box must occupy
21425 at least one column. */
21427 it
->glyph_not_available_p
= 1;
21428 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21429 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21430 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21434 it
->pixel_width
= pcm
->width
;
21435 it
->phys_ascent
= pcm
->ascent
+ boff
;
21436 it
->phys_descent
= pcm
->descent
- boff
;
21438 && (pcm
->lbearing
< 0
21439 || pcm
->rbearing
> pcm
->width
))
21440 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21443 it
->ascent
= FONT_BASE (font
) + boff
;
21444 it
->descent
= FONT_DESCENT (font
) - boff
;
21445 if (face
->box
!= FACE_NO_BOX
)
21447 int thick
= face
->box_line_width
;
21451 it
->ascent
+= thick
;
21452 it
->descent
+= thick
;
21457 if (it
->start_of_box_run_p
)
21458 it
->pixel_width
+= thick
;
21459 if (it
->end_of_box_run_p
)
21460 it
->pixel_width
+= thick
;
21463 /* If face has an overline, add the height of the overline
21464 (1 pixel) and a 1 pixel margin to the character height. */
21465 if (face
->overline_p
)
21466 it
->ascent
+= overline_margin
;
21468 take_vertical_position_into_account (it
);
21470 if (it
->ascent
< 0)
21472 if (it
->descent
< 0)
21477 if (it
->pixel_width
== 0)
21478 /* We assure that all visible glyphs have at least 1-pixel
21480 it
->pixel_width
= 1;
21482 it
->multibyte_p
= saved_multibyte_p
;
21484 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
21486 /* A static compositoin.
21488 Note: A composition is represented as one glyph in the
21489 glyph matrix. There are no padding glyphs.
21491 Important is that pixel_width, ascent, and descent are the
21492 values of what is drawn by draw_glyphs (i.e. the values of
21493 the overall glyphs composed). */
21494 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21495 int boff
; /* baseline offset */
21496 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
21497 int glyph_len
= cmp
->glyph_len
;
21498 struct font
*font
= face
->font
;
21502 /* If we have not yet calculated pixel size data of glyphs of
21503 the composition for the current face font, calculate them
21504 now. Theoretically, we have to check all fonts for the
21505 glyphs, but that requires much time and memory space. So,
21506 here we check only the font of the first glyph. This leads
21507 to incorrect display, but it's very rare, and C-l (recenter)
21508 can correct the display anyway. */
21509 if (! cmp
->font
|| cmp
->font
!= font
)
21511 /* Ascent and descent of the font of the first character
21512 of this composition (adjusted by baseline offset).
21513 Ascent and descent of overall glyphs should not be less
21514 than them respectively. */
21515 int font_ascent
, font_descent
, font_height
;
21516 /* Bounding box of the overall glyphs. */
21517 int leftmost
, rightmost
, lowest
, highest
;
21518 int lbearing
, rbearing
;
21519 int i
, width
, ascent
, descent
;
21520 int left_padded
= 0, right_padded
= 0;
21523 struct font_metrics
*pcm
;
21524 int font_not_found_p
;
21527 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21528 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21530 if (glyph_len
< cmp
->glyph_len
)
21532 for (i
= 0; i
< glyph_len
; i
++)
21534 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21536 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21541 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21542 : IT_CHARPOS (*it
));
21543 /* When no suitable font found, use the default font. */
21544 font_not_found_p
= font
== NULL
;
21545 if (font_not_found_p
)
21547 face
= face
->ascii_face
;
21550 boff
= font
->baseline_offset
;
21551 if (font
->vertical_centering
)
21552 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21553 font_ascent
= FONT_BASE (font
) + boff
;
21554 font_descent
= FONT_DESCENT (font
) - boff
;
21555 font_height
= FONT_HEIGHT (font
);
21557 cmp
->font
= (void *) font
;
21560 if (! font_not_found_p
)
21562 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21563 &char2b
, it
->multibyte_p
, 0);
21564 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21567 /* Initialize the bounding box. */
21570 width
= pcm
->width
;
21571 ascent
= pcm
->ascent
;
21572 descent
= pcm
->descent
;
21573 lbearing
= pcm
->lbearing
;
21574 rbearing
= pcm
->rbearing
;
21578 width
= FONT_WIDTH (font
);
21579 ascent
= FONT_BASE (font
);
21580 descent
= FONT_DESCENT (font
);
21587 lowest
= - descent
+ boff
;
21588 highest
= ascent
+ boff
;
21590 if (! font_not_found_p
21591 && font
->default_ascent
21592 && CHAR_TABLE_P (Vuse_default_ascent
)
21593 && !NILP (Faref (Vuse_default_ascent
,
21594 make_number (it
->char_to_display
))))
21595 highest
= font
->default_ascent
+ boff
;
21597 /* Draw the first glyph at the normal position. It may be
21598 shifted to right later if some other glyphs are drawn
21600 cmp
->offsets
[i
* 2] = 0;
21601 cmp
->offsets
[i
* 2 + 1] = boff
;
21602 cmp
->lbearing
= lbearing
;
21603 cmp
->rbearing
= rbearing
;
21605 /* Set cmp->offsets for the remaining glyphs. */
21606 for (i
++; i
< glyph_len
; i
++)
21608 int left
, right
, btm
, top
;
21609 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21611 struct face
*this_face
;
21616 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21617 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21618 font
= this_face
->font
;
21624 this_boff
= font
->baseline_offset
;
21625 if (font
->vertical_centering
)
21626 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21627 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21628 &char2b
, it
->multibyte_p
, 0);
21629 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21632 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21635 width
= pcm
->width
;
21636 ascent
= pcm
->ascent
;
21637 descent
= pcm
->descent
;
21638 lbearing
= pcm
->lbearing
;
21639 rbearing
= pcm
->rbearing
;
21640 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21642 /* Relative composition with or without
21643 alternate chars. */
21644 left
= (leftmost
+ rightmost
- width
) / 2;
21645 btm
= - descent
+ boff
;
21646 if (font
->relative_compose
21647 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21648 || NILP (Faref (Vignore_relative_composition
,
21649 make_number (ch
)))))
21652 if (- descent
>= font
->relative_compose
)
21653 /* One extra pixel between two glyphs. */
21655 else if (ascent
<= 0)
21656 /* One extra pixel between two glyphs. */
21657 btm
= lowest
- 1 - ascent
- descent
;
21662 /* A composition rule is specified by an integer
21663 value that encodes global and new reference
21664 points (GREF and NREF). GREF and NREF are
21665 specified by numbers as below:
21667 0---1---2 -- ascent
21671 9--10--11 -- center
21673 ---3---4---5--- baseline
21675 6---7---8 -- descent
21677 int rule
= COMPOSITION_RULE (cmp
, i
);
21678 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21680 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21681 grefx
= gref
% 3, nrefx
= nref
% 3;
21682 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21684 xoff
= font_height
* (xoff
- 128) / 256;
21686 yoff
= font_height
* (yoff
- 128) / 256;
21689 + grefx
* (rightmost
- leftmost
) / 2
21690 - nrefx
* width
/ 2
21693 btm
= ((grefy
== 0 ? highest
21695 : grefy
== 2 ? lowest
21696 : (highest
+ lowest
) / 2)
21697 - (nrefy
== 0 ? ascent
+ descent
21698 : nrefy
== 1 ? descent
- boff
21700 : (ascent
+ descent
) / 2)
21704 cmp
->offsets
[i
* 2] = left
;
21705 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21707 /* Update the bounding box of the overall glyphs. */
21710 right
= left
+ width
;
21711 if (left
< leftmost
)
21713 if (right
> rightmost
)
21716 top
= btm
+ descent
+ ascent
;
21722 if (cmp
->lbearing
> left
+ lbearing
)
21723 cmp
->lbearing
= left
+ lbearing
;
21724 if (cmp
->rbearing
< left
+ rbearing
)
21725 cmp
->rbearing
= left
+ rbearing
;
21729 /* If there are glyphs whose x-offsets are negative,
21730 shift all glyphs to the right and make all x-offsets
21734 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21735 cmp
->offsets
[i
* 2] -= leftmost
;
21736 rightmost
-= leftmost
;
21737 cmp
->lbearing
-= leftmost
;
21738 cmp
->rbearing
-= leftmost
;
21741 if (left_padded
&& cmp
->lbearing
< 0)
21743 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21744 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21745 rightmost
-= cmp
->lbearing
;
21746 cmp
->rbearing
-= cmp
->lbearing
;
21749 if (right_padded
&& rightmost
< cmp
->rbearing
)
21751 rightmost
= cmp
->rbearing
;
21754 cmp
->pixel_width
= rightmost
;
21755 cmp
->ascent
= highest
;
21756 cmp
->descent
= - lowest
;
21757 if (cmp
->ascent
< font_ascent
)
21758 cmp
->ascent
= font_ascent
;
21759 if (cmp
->descent
< font_descent
)
21760 cmp
->descent
= font_descent
;
21764 && (cmp
->lbearing
< 0
21765 || cmp
->rbearing
> cmp
->pixel_width
))
21766 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21768 it
->pixel_width
= cmp
->pixel_width
;
21769 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21770 it
->descent
= it
->phys_descent
= cmp
->descent
;
21771 if (face
->box
!= FACE_NO_BOX
)
21773 int thick
= face
->box_line_width
;
21777 it
->ascent
+= thick
;
21778 it
->descent
+= thick
;
21783 if (it
->start_of_box_run_p
)
21784 it
->pixel_width
+= thick
;
21785 if (it
->end_of_box_run_p
)
21786 it
->pixel_width
+= thick
;
21789 /* If face has an overline, add the height of the overline
21790 (1 pixel) and a 1 pixel margin to the character height. */
21791 if (face
->overline_p
)
21792 it
->ascent
+= overline_margin
;
21794 take_vertical_position_into_account (it
);
21795 if (it
->ascent
< 0)
21797 if (it
->descent
< 0)
21801 append_composite_glyph (it
);
21803 else if (it
->what
== IT_COMPOSITION
)
21805 /* A dynamic (automatic) composition. */
21806 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21807 Lisp_Object gstring
;
21808 struct font_metrics metrics
;
21810 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
21812 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
21815 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
21816 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21817 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
21818 it
->descent
= it
->phys_descent
= metrics
.descent
;
21819 if (face
->box
!= FACE_NO_BOX
)
21821 int thick
= face
->box_line_width
;
21825 it
->ascent
+= thick
;
21826 it
->descent
+= thick
;
21831 if (it
->start_of_box_run_p
)
21832 it
->pixel_width
+= thick
;
21833 if (it
->end_of_box_run_p
)
21834 it
->pixel_width
+= thick
;
21836 /* If face has an overline, add the height of the overline
21837 (1 pixel) and a 1 pixel margin to the character height. */
21838 if (face
->overline_p
)
21839 it
->ascent
+= overline_margin
;
21840 take_vertical_position_into_account (it
);
21841 if (it
->ascent
< 0)
21843 if (it
->descent
< 0)
21847 append_composite_glyph (it
);
21849 else if (it
->what
== IT_IMAGE
)
21850 produce_image_glyph (it
);
21851 else if (it
->what
== IT_STRETCH
)
21852 produce_stretch_glyph (it
);
21854 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21855 because this isn't true for images with `:ascent 100'. */
21856 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21857 if (it
->area
== TEXT_AREA
)
21858 it
->current_x
+= it
->pixel_width
;
21860 if (extra_line_spacing
> 0)
21862 it
->descent
+= extra_line_spacing
;
21863 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21864 it
->max_extra_line_spacing
= extra_line_spacing
;
21867 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21868 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21869 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21870 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21874 Output LEN glyphs starting at START at the nominal cursor position.
21875 Advance the nominal cursor over the text. The global variable
21876 updated_window contains the window being updated, updated_row is
21877 the glyph row being updated, and updated_area is the area of that
21878 row being updated. */
21881 x_write_glyphs (start
, len
)
21882 struct glyph
*start
;
21887 xassert (updated_window
&& updated_row
);
21890 /* Write glyphs. */
21892 hpos
= start
- updated_row
->glyphs
[updated_area
];
21893 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21894 updated_row
, updated_area
,
21896 DRAW_NORMAL_TEXT
, 0);
21898 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21899 if (updated_area
== TEXT_AREA
21900 && updated_window
->phys_cursor_on_p
21901 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21902 && updated_window
->phys_cursor
.hpos
>= hpos
21903 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21904 updated_window
->phys_cursor_on_p
= 0;
21908 /* Advance the output cursor. */
21909 output_cursor
.hpos
+= len
;
21910 output_cursor
.x
= x
;
21915 Insert LEN glyphs from START at the nominal cursor position. */
21918 x_insert_glyphs (start
, len
)
21919 struct glyph
*start
;
21924 int line_height
, shift_by_width
, shifted_region_width
;
21925 struct glyph_row
*row
;
21926 struct glyph
*glyph
;
21927 int frame_x
, frame_y
;
21930 xassert (updated_window
&& updated_row
);
21932 w
= updated_window
;
21933 f
= XFRAME (WINDOW_FRAME (w
));
21935 /* Get the height of the line we are in. */
21937 line_height
= row
->height
;
21939 /* Get the width of the glyphs to insert. */
21940 shift_by_width
= 0;
21941 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21942 shift_by_width
+= glyph
->pixel_width
;
21944 /* Get the width of the region to shift right. */
21945 shifted_region_width
= (window_box_width (w
, updated_area
)
21950 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21951 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21953 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21954 line_height
, shift_by_width
);
21956 /* Write the glyphs. */
21957 hpos
= start
- row
->glyphs
[updated_area
];
21958 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21960 DRAW_NORMAL_TEXT
, 0);
21962 /* Advance the output cursor. */
21963 output_cursor
.hpos
+= len
;
21964 output_cursor
.x
+= shift_by_width
;
21970 Erase the current text line from the nominal cursor position
21971 (inclusive) to pixel column TO_X (exclusive). The idea is that
21972 everything from TO_X onward is already erased.
21974 TO_X is a pixel position relative to updated_area of
21975 updated_window. TO_X == -1 means clear to the end of this area. */
21978 x_clear_end_of_line (to_x
)
21982 struct window
*w
= updated_window
;
21983 int max_x
, min_y
, max_y
;
21984 int from_x
, from_y
, to_y
;
21986 xassert (updated_window
&& updated_row
);
21987 f
= XFRAME (w
->frame
);
21989 if (updated_row
->full_width_p
)
21990 max_x
= WINDOW_TOTAL_WIDTH (w
);
21992 max_x
= window_box_width (w
, updated_area
);
21993 max_y
= window_text_bottom_y (w
);
21995 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
21996 of window. For TO_X > 0, truncate to end of drawing area. */
22002 to_x
= min (to_x
, max_x
);
22004 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22006 /* Notice if the cursor will be cleared by this operation. */
22007 if (!updated_row
->full_width_p
)
22008 notice_overwritten_cursor (w
, updated_area
,
22009 output_cursor
.x
, -1,
22011 MATRIX_ROW_BOTTOM_Y (updated_row
));
22013 from_x
= output_cursor
.x
;
22015 /* Translate to frame coordinates. */
22016 if (updated_row
->full_width_p
)
22018 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22019 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22023 int area_left
= window_box_left (w
, updated_area
);
22024 from_x
+= area_left
;
22028 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22029 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22030 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22032 /* Prevent inadvertently clearing to end of the X window. */
22033 if (to_x
> from_x
&& to_y
> from_y
)
22036 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22037 to_x
- from_x
, to_y
- from_y
);
22042 #endif /* HAVE_WINDOW_SYSTEM */
22046 /***********************************************************************
22048 ***********************************************************************/
22050 /* Value is the internal representation of the specified cursor type
22051 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22052 of the bar cursor. */
22054 static enum text_cursor_kinds
22055 get_specified_cursor_type (arg
, width
)
22059 enum text_cursor_kinds type
;
22064 if (EQ (arg
, Qbox
))
22065 return FILLED_BOX_CURSOR
;
22067 if (EQ (arg
, Qhollow
))
22068 return HOLLOW_BOX_CURSOR
;
22070 if (EQ (arg
, Qbar
))
22077 && EQ (XCAR (arg
), Qbar
)
22078 && INTEGERP (XCDR (arg
))
22079 && XINT (XCDR (arg
)) >= 0)
22081 *width
= XINT (XCDR (arg
));
22085 if (EQ (arg
, Qhbar
))
22088 return HBAR_CURSOR
;
22092 && EQ (XCAR (arg
), Qhbar
)
22093 && INTEGERP (XCDR (arg
))
22094 && XINT (XCDR (arg
)) >= 0)
22096 *width
= XINT (XCDR (arg
));
22097 return HBAR_CURSOR
;
22100 /* Treat anything unknown as "hollow box cursor".
22101 It was bad to signal an error; people have trouble fixing
22102 .Xdefaults with Emacs, when it has something bad in it. */
22103 type
= HOLLOW_BOX_CURSOR
;
22108 /* Set the default cursor types for specified frame. */
22110 set_frame_cursor_types (f
, arg
)
22117 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22118 FRAME_CURSOR_WIDTH (f
) = width
;
22120 /* By default, set up the blink-off state depending on the on-state. */
22122 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22125 FRAME_BLINK_OFF_CURSOR (f
)
22126 = get_specified_cursor_type (XCDR (tem
), &width
);
22127 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22130 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22134 /* Return the cursor we want to be displayed in window W. Return
22135 width of bar/hbar cursor through WIDTH arg. Return with
22136 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22137 (i.e. if the `system caret' should track this cursor).
22139 In a mini-buffer window, we want the cursor only to appear if we
22140 are reading input from this window. For the selected window, we
22141 want the cursor type given by the frame parameter or buffer local
22142 setting of cursor-type. If explicitly marked off, draw no cursor.
22143 In all other cases, we want a hollow box cursor. */
22145 static enum text_cursor_kinds
22146 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22148 struct glyph
*glyph
;
22150 int *active_cursor
;
22152 struct frame
*f
= XFRAME (w
->frame
);
22153 struct buffer
*b
= XBUFFER (w
->buffer
);
22154 int cursor_type
= DEFAULT_CURSOR
;
22155 Lisp_Object alt_cursor
;
22156 int non_selected
= 0;
22158 *active_cursor
= 1;
22161 if (cursor_in_echo_area
22162 && FRAME_HAS_MINIBUF_P (f
)
22163 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22165 if (w
== XWINDOW (echo_area_window
))
22167 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22169 *width
= FRAME_CURSOR_WIDTH (f
);
22170 return FRAME_DESIRED_CURSOR (f
);
22173 return get_specified_cursor_type (b
->cursor_type
, width
);
22176 *active_cursor
= 0;
22180 /* Detect a nonselected window or nonselected frame. */
22181 else if (w
!= XWINDOW (f
->selected_window
)
22182 #ifdef HAVE_WINDOW_SYSTEM
22183 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22187 *active_cursor
= 0;
22189 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22195 /* Never display a cursor in a window in which cursor-type is nil. */
22196 if (NILP (b
->cursor_type
))
22199 /* Get the normal cursor type for this window. */
22200 if (EQ (b
->cursor_type
, Qt
))
22202 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22203 *width
= FRAME_CURSOR_WIDTH (f
);
22206 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22208 /* Use cursor-in-non-selected-windows instead
22209 for non-selected window or frame. */
22212 alt_cursor
= b
->cursor_in_non_selected_windows
;
22213 if (!EQ (Qt
, alt_cursor
))
22214 return get_specified_cursor_type (alt_cursor
, width
);
22215 /* t means modify the normal cursor type. */
22216 if (cursor_type
== FILLED_BOX_CURSOR
)
22217 cursor_type
= HOLLOW_BOX_CURSOR
;
22218 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22220 return cursor_type
;
22223 /* Use normal cursor if not blinked off. */
22224 if (!w
->cursor_off_p
)
22226 #ifdef HAVE_WINDOW_SYSTEM
22227 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22229 if (cursor_type
== FILLED_BOX_CURSOR
)
22231 /* Using a block cursor on large images can be very annoying.
22232 So use a hollow cursor for "large" images.
22233 If image is not transparent (no mask), also use hollow cursor. */
22234 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22235 if (img
!= NULL
&& IMAGEP (img
->spec
))
22237 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22238 where N = size of default frame font size.
22239 This should cover most of the "tiny" icons people may use. */
22241 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22242 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22243 cursor_type
= HOLLOW_BOX_CURSOR
;
22246 else if (cursor_type
!= NO_CURSOR
)
22248 /* Display current only supports BOX and HOLLOW cursors for images.
22249 So for now, unconditionally use a HOLLOW cursor when cursor is
22250 not a solid box cursor. */
22251 cursor_type
= HOLLOW_BOX_CURSOR
;
22255 return cursor_type
;
22258 /* Cursor is blinked off, so determine how to "toggle" it. */
22260 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22261 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22262 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22264 /* Then see if frame has specified a specific blink off cursor type. */
22265 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22267 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22268 return FRAME_BLINK_OFF_CURSOR (f
);
22272 /* Some people liked having a permanently visible blinking cursor,
22273 while others had very strong opinions against it. So it was
22274 decided to remove it. KFS 2003-09-03 */
22276 /* Finally perform built-in cursor blinking:
22277 filled box <-> hollow box
22278 wide [h]bar <-> narrow [h]bar
22279 narrow [h]bar <-> no cursor
22280 other type <-> no cursor */
22282 if (cursor_type
== FILLED_BOX_CURSOR
)
22283 return HOLLOW_BOX_CURSOR
;
22285 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22288 return cursor_type
;
22296 #ifdef HAVE_WINDOW_SYSTEM
22298 /* Notice when the text cursor of window W has been completely
22299 overwritten by a drawing operation that outputs glyphs in AREA
22300 starting at X0 and ending at X1 in the line starting at Y0 and
22301 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22302 the rest of the line after X0 has been written. Y coordinates
22303 are window-relative. */
22306 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22308 enum glyph_row_area area
;
22309 int x0
, y0
, x1
, y1
;
22311 int cx0
, cx1
, cy0
, cy1
;
22312 struct glyph_row
*row
;
22314 if (!w
->phys_cursor_on_p
)
22316 if (area
!= TEXT_AREA
)
22319 if (w
->phys_cursor
.vpos
< 0
22320 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22321 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22322 !(row
->enabled_p
&& row
->displays_text_p
)))
22325 if (row
->cursor_in_fringe_p
)
22327 row
->cursor_in_fringe_p
= 0;
22328 draw_fringe_bitmap (w
, row
, 0);
22329 w
->phys_cursor_on_p
= 0;
22333 cx0
= w
->phys_cursor
.x
;
22334 cx1
= cx0
+ w
->phys_cursor_width
;
22335 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22338 /* The cursor image will be completely removed from the
22339 screen if the output area intersects the cursor area in
22340 y-direction. When we draw in [y0 y1[, and some part of
22341 the cursor is at y < y0, that part must have been drawn
22342 before. When scrolling, the cursor is erased before
22343 actually scrolling, so we don't come here. When not
22344 scrolling, the rows above the old cursor row must have
22345 changed, and in this case these rows must have written
22346 over the cursor image.
22348 Likewise if part of the cursor is below y1, with the
22349 exception of the cursor being in the first blank row at
22350 the buffer and window end because update_text_area
22351 doesn't draw that row. (Except when it does, but
22352 that's handled in update_text_area.) */
22354 cy0
= w
->phys_cursor
.y
;
22355 cy1
= cy0
+ w
->phys_cursor_height
;
22356 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22359 w
->phys_cursor_on_p
= 0;
22362 #endif /* HAVE_WINDOW_SYSTEM */
22365 /************************************************************************
22367 ************************************************************************/
22369 #ifdef HAVE_WINDOW_SYSTEM
22372 Fix the display of area AREA of overlapping row ROW in window W
22373 with respect to the overlapping part OVERLAPS. */
22376 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22378 struct glyph_row
*row
;
22379 enum glyph_row_area area
;
22387 for (i
= 0; i
< row
->used
[area
];)
22389 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22391 int start
= i
, start_x
= x
;
22395 x
+= row
->glyphs
[area
][i
].pixel_width
;
22398 while (i
< row
->used
[area
]
22399 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22401 draw_glyphs (w
, start_x
, row
, area
,
22403 DRAW_NORMAL_TEXT
, overlaps
);
22407 x
+= row
->glyphs
[area
][i
].pixel_width
;
22417 Draw the cursor glyph of window W in glyph row ROW. See the
22418 comment of draw_glyphs for the meaning of HL. */
22421 draw_phys_cursor_glyph (w
, row
, hl
)
22423 struct glyph_row
*row
;
22424 enum draw_glyphs_face hl
;
22426 /* If cursor hpos is out of bounds, don't draw garbage. This can
22427 happen in mini-buffer windows when switching between echo area
22428 glyphs and mini-buffer. */
22429 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22431 int on_p
= w
->phys_cursor_on_p
;
22433 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22434 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22436 w
->phys_cursor_on_p
= on_p
;
22438 if (hl
== DRAW_CURSOR
)
22439 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22440 /* When we erase the cursor, and ROW is overlapped by other
22441 rows, make sure that these overlapping parts of other rows
22443 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22445 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22447 if (row
> w
->current_matrix
->rows
22448 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22449 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22450 OVERLAPS_ERASED_CURSOR
);
22452 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22453 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22454 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22455 OVERLAPS_ERASED_CURSOR
);
22462 Erase the image of a cursor of window W from the screen. */
22465 erase_phys_cursor (w
)
22468 struct frame
*f
= XFRAME (w
->frame
);
22469 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22470 int hpos
= w
->phys_cursor
.hpos
;
22471 int vpos
= w
->phys_cursor
.vpos
;
22472 int mouse_face_here_p
= 0;
22473 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22474 struct glyph_row
*cursor_row
;
22475 struct glyph
*cursor_glyph
;
22476 enum draw_glyphs_face hl
;
22478 /* No cursor displayed or row invalidated => nothing to do on the
22480 if (w
->phys_cursor_type
== NO_CURSOR
)
22481 goto mark_cursor_off
;
22483 /* VPOS >= active_glyphs->nrows means that window has been resized.
22484 Don't bother to erase the cursor. */
22485 if (vpos
>= active_glyphs
->nrows
)
22486 goto mark_cursor_off
;
22488 /* If row containing cursor is marked invalid, there is nothing we
22490 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22491 if (!cursor_row
->enabled_p
)
22492 goto mark_cursor_off
;
22494 /* If line spacing is > 0, old cursor may only be partially visible in
22495 window after split-window. So adjust visible height. */
22496 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22497 window_text_bottom_y (w
) - cursor_row
->y
);
22499 /* If row is completely invisible, don't attempt to delete a cursor which
22500 isn't there. This can happen if cursor is at top of a window, and
22501 we switch to a buffer with a header line in that window. */
22502 if (cursor_row
->visible_height
<= 0)
22503 goto mark_cursor_off
;
22505 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22506 if (cursor_row
->cursor_in_fringe_p
)
22508 cursor_row
->cursor_in_fringe_p
= 0;
22509 draw_fringe_bitmap (w
, cursor_row
, 0);
22510 goto mark_cursor_off
;
22513 /* This can happen when the new row is shorter than the old one.
22514 In this case, either draw_glyphs or clear_end_of_line
22515 should have cleared the cursor. Note that we wouldn't be
22516 able to erase the cursor in this case because we don't have a
22517 cursor glyph at hand. */
22518 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22519 goto mark_cursor_off
;
22521 /* If the cursor is in the mouse face area, redisplay that when
22522 we clear the cursor. */
22523 if (! NILP (dpyinfo
->mouse_face_window
)
22524 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22525 && (vpos
> dpyinfo
->mouse_face_beg_row
22526 || (vpos
== dpyinfo
->mouse_face_beg_row
22527 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22528 && (vpos
< dpyinfo
->mouse_face_end_row
22529 || (vpos
== dpyinfo
->mouse_face_end_row
22530 && hpos
< dpyinfo
->mouse_face_end_col
))
22531 /* Don't redraw the cursor's spot in mouse face if it is at the
22532 end of a line (on a newline). The cursor appears there, but
22533 mouse highlighting does not. */
22534 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22535 mouse_face_here_p
= 1;
22537 /* Maybe clear the display under the cursor. */
22538 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22541 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22544 cursor_glyph
= get_phys_cursor_glyph (w
);
22545 if (cursor_glyph
== NULL
)
22546 goto mark_cursor_off
;
22548 width
= cursor_glyph
->pixel_width
;
22549 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22550 x
= w
->phys_cursor
.x
;
22552 width
-= left_x
- x
;
22553 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22554 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22555 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22558 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22561 /* Erase the cursor by redrawing the character underneath it. */
22562 if (mouse_face_here_p
)
22563 hl
= DRAW_MOUSE_FACE
;
22565 hl
= DRAW_NORMAL_TEXT
;
22566 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22569 w
->phys_cursor_on_p
= 0;
22570 w
->phys_cursor_type
= NO_CURSOR
;
22575 Display or clear cursor of window W. If ON is zero, clear the
22576 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22577 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22580 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22582 int on
, hpos
, vpos
, x
, y
;
22584 struct frame
*f
= XFRAME (w
->frame
);
22585 int new_cursor_type
;
22586 int new_cursor_width
;
22588 struct glyph_row
*glyph_row
;
22589 struct glyph
*glyph
;
22591 /* This is pointless on invisible frames, and dangerous on garbaged
22592 windows and frames; in the latter case, the frame or window may
22593 be in the midst of changing its size, and x and y may be off the
22595 if (! FRAME_VISIBLE_P (f
)
22596 || FRAME_GARBAGED_P (f
)
22597 || vpos
>= w
->current_matrix
->nrows
22598 || hpos
>= w
->current_matrix
->matrix_w
)
22601 /* If cursor is off and we want it off, return quickly. */
22602 if (!on
&& !w
->phys_cursor_on_p
)
22605 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22606 /* If cursor row is not enabled, we don't really know where to
22607 display the cursor. */
22608 if (!glyph_row
->enabled_p
)
22610 w
->phys_cursor_on_p
= 0;
22615 if (!glyph_row
->exact_window_width_line_p
22616 || hpos
< glyph_row
->used
[TEXT_AREA
])
22617 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22619 xassert (interrupt_input_blocked
);
22621 /* Set new_cursor_type to the cursor we want to be displayed. */
22622 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22623 &new_cursor_width
, &active_cursor
);
22625 /* If cursor is currently being shown and we don't want it to be or
22626 it is in the wrong place, or the cursor type is not what we want,
22628 if (w
->phys_cursor_on_p
22630 || w
->phys_cursor
.x
!= x
22631 || w
->phys_cursor
.y
!= y
22632 || new_cursor_type
!= w
->phys_cursor_type
22633 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22634 && new_cursor_width
!= w
->phys_cursor_width
)))
22635 erase_phys_cursor (w
);
22637 /* Don't check phys_cursor_on_p here because that flag is only set
22638 to zero in some cases where we know that the cursor has been
22639 completely erased, to avoid the extra work of erasing the cursor
22640 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22641 still not be visible, or it has only been partly erased. */
22644 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22645 w
->phys_cursor_height
= glyph_row
->height
;
22647 /* Set phys_cursor_.* before x_draw_.* is called because some
22648 of them may need the information. */
22649 w
->phys_cursor
.x
= x
;
22650 w
->phys_cursor
.y
= glyph_row
->y
;
22651 w
->phys_cursor
.hpos
= hpos
;
22652 w
->phys_cursor
.vpos
= vpos
;
22655 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22656 new_cursor_type
, new_cursor_width
,
22657 on
, active_cursor
);
22661 /* Switch the display of W's cursor on or off, according to the value
22668 update_window_cursor (w
, on
)
22672 /* Don't update cursor in windows whose frame is in the process
22673 of being deleted. */
22674 if (w
->current_matrix
)
22677 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22678 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22684 /* Call update_window_cursor with parameter ON_P on all leaf windows
22685 in the window tree rooted at W. */
22688 update_cursor_in_window_tree (w
, on_p
)
22694 if (!NILP (w
->hchild
))
22695 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22696 else if (!NILP (w
->vchild
))
22697 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22699 update_window_cursor (w
, on_p
);
22701 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22707 Display the cursor on window W, or clear it, according to ON_P.
22708 Don't change the cursor's position. */
22711 x_update_cursor (f
, on_p
)
22715 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22720 Clear the cursor of window W to background color, and mark the
22721 cursor as not shown. This is used when the text where the cursor
22722 is is about to be rewritten. */
22728 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22729 update_window_cursor (w
, 0);
22734 Display the active region described by mouse_face_* according to DRAW. */
22737 show_mouse_face (dpyinfo
, draw
)
22738 Display_Info
*dpyinfo
;
22739 enum draw_glyphs_face draw
;
22741 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22742 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22744 if (/* If window is in the process of being destroyed, don't bother
22746 w
->current_matrix
!= NULL
22747 /* Don't update mouse highlight if hidden */
22748 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22749 /* Recognize when we are called to operate on rows that don't exist
22750 anymore. This can happen when a window is split. */
22751 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22753 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22754 struct glyph_row
*row
, *first
, *last
;
22756 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22757 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22759 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22761 int start_hpos
, end_hpos
, start_x
;
22763 /* For all but the first row, the highlight starts at column 0. */
22766 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22767 start_x
= dpyinfo
->mouse_face_beg_x
;
22776 end_hpos
= dpyinfo
->mouse_face_end_col
;
22779 end_hpos
= row
->used
[TEXT_AREA
];
22780 if (draw
== DRAW_NORMAL_TEXT
)
22781 row
->fill_line_p
= 1; /* Clear to end of line */
22784 if (end_hpos
> start_hpos
)
22786 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22787 start_hpos
, end_hpos
,
22791 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22795 /* When we've written over the cursor, arrange for it to
22796 be displayed again. */
22797 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22800 display_and_set_cursor (w
, 1,
22801 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22802 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22807 /* Change the mouse cursor. */
22808 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22809 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22810 else if (draw
== DRAW_MOUSE_FACE
)
22811 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22813 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22817 Clear out the mouse-highlighted active region.
22818 Redraw it un-highlighted first. Value is non-zero if mouse
22819 face was actually drawn unhighlighted. */
22822 clear_mouse_face (dpyinfo
)
22823 Display_Info
*dpyinfo
;
22827 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22829 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22833 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22834 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22835 dpyinfo
->mouse_face_window
= Qnil
;
22836 dpyinfo
->mouse_face_overlay
= Qnil
;
22842 Non-zero if physical cursor of window W is within mouse face. */
22845 cursor_in_mouse_face_p (w
)
22848 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22849 int in_mouse_face
= 0;
22851 if (WINDOWP (dpyinfo
->mouse_face_window
)
22852 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22854 int hpos
= w
->phys_cursor
.hpos
;
22855 int vpos
= w
->phys_cursor
.vpos
;
22857 if (vpos
>= dpyinfo
->mouse_face_beg_row
22858 && vpos
<= dpyinfo
->mouse_face_end_row
22859 && (vpos
> dpyinfo
->mouse_face_beg_row
22860 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22861 && (vpos
< dpyinfo
->mouse_face_end_row
22862 || hpos
< dpyinfo
->mouse_face_end_col
22863 || dpyinfo
->mouse_face_past_end
))
22867 return in_mouse_face
;
22873 /* Find the glyph matrix position of buffer position CHARPOS in window
22874 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22875 current glyphs must be up to date. If CHARPOS is above window
22876 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22877 of last line in W. In the row containing CHARPOS, stop before glyphs
22878 having STOP as object. */
22880 #if 1 /* This is a version of fast_find_position that's more correct
22881 in the presence of hscrolling, for example. I didn't install
22882 it right away because the problem fixed is minor, it failed
22883 in 20.x as well, and I think it's too risky to install
22884 so near the release of 21.1. 2001-09-25 gerd. */
22888 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22891 int *hpos
, *vpos
, *x
, *y
;
22894 struct glyph_row
*row
, *first
;
22895 struct glyph
*glyph
, *end
;
22898 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22899 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22904 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22908 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22911 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22915 /* If whole rows or last part of a row came from a display overlay,
22916 row_containing_pos will skip over such rows because their end pos
22917 equals the start pos of the overlay or interval.
22919 Move back if we have a STOP object and previous row's
22920 end glyph came from STOP. */
22923 struct glyph_row
*prev
;
22924 while ((prev
= row
- 1, prev
>= first
)
22925 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22926 && prev
->used
[TEXT_AREA
] > 0)
22928 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22929 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22930 while (--glyph
>= beg
22931 && INTEGERP (glyph
->object
));
22933 || !EQ (stop
, glyph
->object
))
22941 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22943 glyph
= row
->glyphs
[TEXT_AREA
];
22944 end
= glyph
+ row
->used
[TEXT_AREA
];
22946 /* Skip over glyphs not having an object at the start of the row.
22947 These are special glyphs like truncation marks on terminal
22949 if (row
->displays_text_p
)
22951 && INTEGERP (glyph
->object
)
22952 && !EQ (stop
, glyph
->object
)
22953 && glyph
->charpos
< 0)
22955 *x
+= glyph
->pixel_width
;
22960 && !INTEGERP (glyph
->object
)
22961 && !EQ (stop
, glyph
->object
)
22962 && (!BUFFERP (glyph
->object
)
22963 || glyph
->charpos
< charpos
))
22965 *x
+= glyph
->pixel_width
;
22969 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22976 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22979 int *hpos
, *vpos
, *x
, *y
;
22984 int maybe_next_line_p
= 0;
22985 int line_start_position
;
22986 int yb
= window_text_bottom_y (w
);
22987 struct glyph_row
*row
, *best_row
;
22988 int row_vpos
, best_row_vpos
;
22991 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22992 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22994 while (row
->y
< yb
)
22996 if (row
->used
[TEXT_AREA
])
22997 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
22999 line_start_position
= 0;
23001 if (line_start_position
> pos
)
23003 /* If the position sought is the end of the buffer,
23004 don't include the blank lines at the bottom of the window. */
23005 else if (line_start_position
== pos
23006 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
23008 maybe_next_line_p
= 1;
23011 else if (line_start_position
> 0)
23014 best_row_vpos
= row_vpos
;
23017 if (row
->y
+ row
->height
>= yb
)
23024 /* Find the right column within BEST_ROW. */
23026 current_x
= best_row
->x
;
23027 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
23029 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
23030 int charpos
= glyph
->charpos
;
23032 if (BUFFERP (glyph
->object
))
23034 if (charpos
== pos
)
23037 *vpos
= best_row_vpos
;
23042 else if (charpos
> pos
)
23045 else if (EQ (glyph
->object
, stop
))
23050 current_x
+= glyph
->pixel_width
;
23053 /* If we're looking for the end of the buffer,
23054 and we didn't find it in the line we scanned,
23055 use the start of the following line. */
23056 if (maybe_next_line_p
)
23061 current_x
= best_row
->x
;
23064 *vpos
= best_row_vpos
;
23065 *hpos
= lastcol
+ 1;
23074 /* Find the position of the glyph for position POS in OBJECT in
23075 window W's current matrix, and return in *X, *Y the pixel
23076 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23078 RIGHT_P non-zero means return the position of the right edge of the
23079 glyph, RIGHT_P zero means return the left edge position.
23081 If no glyph for POS exists in the matrix, return the position of
23082 the glyph with the next smaller position that is in the matrix, if
23083 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23084 exists in the matrix, return the position of the glyph with the
23085 next larger position in OBJECT.
23087 Value is non-zero if a glyph was found. */
23090 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23093 Lisp_Object object
;
23094 int *hpos
, *vpos
, *x
, *y
;
23097 int yb
= window_text_bottom_y (w
);
23098 struct glyph_row
*r
;
23099 struct glyph
*best_glyph
= NULL
;
23100 struct glyph_row
*best_row
= NULL
;
23103 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23104 r
->enabled_p
&& r
->y
< yb
;
23107 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23108 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23111 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23112 if (EQ (g
->object
, object
))
23114 if (g
->charpos
== pos
)
23121 else if (best_glyph
== NULL
23122 || ((eabs (g
->charpos
- pos
)
23123 < eabs (best_glyph
->charpos
- pos
))
23126 : g
->charpos
> pos
)))
23140 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23144 *x
+= best_glyph
->pixel_width
;
23149 *vpos
= best_row
- w
->current_matrix
->rows
;
23152 return best_glyph
!= NULL
;
23156 /* See if position X, Y is within a hot-spot of an image. */
23159 on_hot_spot_p (hot_spot
, x
, y
)
23160 Lisp_Object hot_spot
;
23163 if (!CONSP (hot_spot
))
23166 if (EQ (XCAR (hot_spot
), Qrect
))
23168 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23169 Lisp_Object rect
= XCDR (hot_spot
);
23173 if (!CONSP (XCAR (rect
)))
23175 if (!CONSP (XCDR (rect
)))
23177 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23179 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23181 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23183 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23187 else if (EQ (XCAR (hot_spot
), Qcircle
))
23189 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23190 Lisp_Object circ
= XCDR (hot_spot
);
23191 Lisp_Object lr
, lx0
, ly0
;
23193 && CONSP (XCAR (circ
))
23194 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23195 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23196 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23198 double r
= XFLOATINT (lr
);
23199 double dx
= XINT (lx0
) - x
;
23200 double dy
= XINT (ly0
) - y
;
23201 return (dx
* dx
+ dy
* dy
<= r
* r
);
23204 else if (EQ (XCAR (hot_spot
), Qpoly
))
23206 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23207 if (VECTORP (XCDR (hot_spot
)))
23209 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23210 Lisp_Object
*poly
= v
->contents
;
23214 Lisp_Object lx
, ly
;
23217 /* Need an even number of coordinates, and at least 3 edges. */
23218 if (n
< 6 || n
& 1)
23221 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23222 If count is odd, we are inside polygon. Pixels on edges
23223 may or may not be included depending on actual geometry of the
23225 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23226 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23228 x0
= XINT (lx
), y0
= XINT (ly
);
23229 for (i
= 0; i
< n
; i
+= 2)
23231 int x1
= x0
, y1
= y0
;
23232 if ((lx
= poly
[i
], !INTEGERP (lx
))
23233 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23235 x0
= XINT (lx
), y0
= XINT (ly
);
23237 /* Does this segment cross the X line? */
23245 if (y
> y0
&& y
> y1
)
23247 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23257 find_hot_spot (map
, x
, y
)
23261 while (CONSP (map
))
23263 if (CONSP (XCAR (map
))
23264 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23272 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23274 doc
: /* Lookup in image map MAP coordinates X and Y.
23275 An image map is an alist where each element has the format (AREA ID PLIST).
23276 An AREA is specified as either a rectangle, a circle, or a polygon:
23277 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23278 pixel coordinates of the upper left and bottom right corners.
23279 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23280 and the radius of the circle; r may be a float or integer.
23281 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23282 vector describes one corner in the polygon.
23283 Returns the alist element for the first matching AREA in MAP. */)
23294 return find_hot_spot (map
, XINT (x
), XINT (y
));
23298 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23300 define_frame_cursor1 (f
, cursor
, pointer
)
23303 Lisp_Object pointer
;
23305 /* Do not change cursor shape while dragging mouse. */
23306 if (!NILP (do_mouse_tracking
))
23309 if (!NILP (pointer
))
23311 if (EQ (pointer
, Qarrow
))
23312 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23313 else if (EQ (pointer
, Qhand
))
23314 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23315 else if (EQ (pointer
, Qtext
))
23316 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23317 else if (EQ (pointer
, intern ("hdrag")))
23318 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23319 #ifdef HAVE_X_WINDOWS
23320 else if (EQ (pointer
, intern ("vdrag")))
23321 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23323 else if (EQ (pointer
, intern ("hourglass")))
23324 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23325 else if (EQ (pointer
, Qmodeline
))
23326 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23328 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23331 if (cursor
!= No_Cursor
)
23332 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23335 /* Take proper action when mouse has moved to the mode or header line
23336 or marginal area AREA of window W, x-position X and y-position Y.
23337 X is relative to the start of the text display area of W, so the
23338 width of bitmap areas and scroll bars must be subtracted to get a
23339 position relative to the start of the mode line. */
23342 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23343 Lisp_Object window
;
23345 enum window_part area
;
23347 struct window
*w
= XWINDOW (window
);
23348 struct frame
*f
= XFRAME (w
->frame
);
23349 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23350 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23351 Lisp_Object pointer
= Qnil
;
23352 int charpos
, dx
, dy
, width
, height
;
23353 Lisp_Object string
, object
= Qnil
;
23354 Lisp_Object pos
, help
;
23356 Lisp_Object mouse_face
;
23357 int original_x_pixel
= x
;
23358 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23359 struct glyph_row
*row
;
23361 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23366 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23367 &object
, &dx
, &dy
, &width
, &height
);
23369 row
= (area
== ON_MODE_LINE
23370 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23371 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23374 if (row
->mode_line_p
&& row
->enabled_p
)
23376 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23377 end
= glyph
+ row
->used
[TEXT_AREA
];
23379 for (x0
= original_x_pixel
;
23380 glyph
< end
&& x0
>= glyph
->pixel_width
;
23382 x0
-= glyph
->pixel_width
;
23390 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23391 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23392 &object
, &dx
, &dy
, &width
, &height
);
23397 if (IMAGEP (object
))
23399 Lisp_Object image_map
, hotspot
;
23400 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23402 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23404 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23406 Lisp_Object area_id
, plist
;
23408 area_id
= XCAR (hotspot
);
23409 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23410 If so, we could look for mouse-enter, mouse-leave
23411 properties in PLIST (and do something...). */
23412 hotspot
= XCDR (hotspot
);
23413 if (CONSP (hotspot
)
23414 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23416 pointer
= Fplist_get (plist
, Qpointer
);
23417 if (NILP (pointer
))
23419 help
= Fplist_get (plist
, Qhelp_echo
);
23422 help_echo_string
= help
;
23423 /* Is this correct? ++kfs */
23424 XSETWINDOW (help_echo_window
, w
);
23425 help_echo_object
= w
->buffer
;
23426 help_echo_pos
= charpos
;
23430 if (NILP (pointer
))
23431 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23434 if (STRINGP (string
))
23436 pos
= make_number (charpos
);
23437 /* If we're on a string with `help-echo' text property, arrange
23438 for the help to be displayed. This is done by setting the
23439 global variable help_echo_string to the help string. */
23442 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23445 help_echo_string
= help
;
23446 XSETWINDOW (help_echo_window
, w
);
23447 help_echo_object
= string
;
23448 help_echo_pos
= charpos
;
23452 if (NILP (pointer
))
23453 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23455 /* Change the mouse pointer according to what is under X/Y. */
23456 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23459 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23460 if (!KEYMAPP (map
))
23461 map
= Fget_text_property (pos
, Qkeymap
, string
);
23462 if (!KEYMAPP (map
))
23463 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23466 /* Change the mouse face according to what is under X/Y. */
23467 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23468 if (!NILP (mouse_face
)
23469 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23474 struct glyph
* tmp_glyph
;
23478 int total_pixel_width
;
23483 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23484 Qmouse_face
, string
, Qnil
);
23486 b
= make_number (0);
23488 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23490 e
= make_number (SCHARS (string
));
23492 /* Calculate the position(glyph position: GPOS) of GLYPH in
23493 displayed string. GPOS is different from CHARPOS.
23495 CHARPOS is the position of glyph in internal string
23496 object. A mode line string format has structures which
23497 is converted to a flatten by emacs lisp interpreter.
23498 The internal string is an element of the structures.
23499 The displayed string is the flatten string. */
23501 if (glyph
> row_start_glyph
)
23503 tmp_glyph
= glyph
- 1;
23504 while (tmp_glyph
>= row_start_glyph
23505 && tmp_glyph
->charpos
>= XINT (b
)
23506 && EQ (tmp_glyph
->object
, glyph
->object
))
23513 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23514 displayed string holding GLYPH.
23516 GSEQ_LENGTH is different from SCHARS (STRING).
23517 SCHARS (STRING) returns the length of the internal string. */
23518 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23519 tmp_glyph
->charpos
< XINT (e
);
23520 tmp_glyph
++, gseq_length
++)
23522 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23526 total_pixel_width
= 0;
23527 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23528 total_pixel_width
+= tmp_glyph
->pixel_width
;
23530 /* Pre calculation of re-rendering position */
23532 hpos
= (area
== ON_MODE_LINE
23533 ? (w
->current_matrix
)->nrows
- 1
23536 /* If the re-rendering position is included in the last
23537 re-rendering area, we should do nothing. */
23538 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23539 && dpyinfo
->mouse_face_beg_col
<= vpos
23540 && vpos
< dpyinfo
->mouse_face_end_col
23541 && dpyinfo
->mouse_face_beg_row
== hpos
)
23544 if (clear_mouse_face (dpyinfo
))
23545 cursor
= No_Cursor
;
23547 dpyinfo
->mouse_face_beg_col
= vpos
;
23548 dpyinfo
->mouse_face_beg_row
= hpos
;
23550 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23551 dpyinfo
->mouse_face_beg_y
= 0;
23553 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23554 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23556 dpyinfo
->mouse_face_end_x
= 0;
23557 dpyinfo
->mouse_face_end_y
= 0;
23559 dpyinfo
->mouse_face_past_end
= 0;
23560 dpyinfo
->mouse_face_window
= window
;
23562 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23565 glyph
->face_id
, 1);
23566 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23568 if (NILP (pointer
))
23571 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23572 clear_mouse_face (dpyinfo
);
23574 define_frame_cursor1 (f
, cursor
, pointer
);
23579 Take proper action when the mouse has moved to position X, Y on
23580 frame F as regards highlighting characters that have mouse-face
23581 properties. Also de-highlighting chars where the mouse was before.
23582 X and Y can be negative or out of range. */
23585 note_mouse_highlight (f
, x
, y
)
23589 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23590 enum window_part part
;
23591 Lisp_Object window
;
23593 Cursor cursor
= No_Cursor
;
23594 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23597 /* When a menu is active, don't highlight because this looks odd. */
23598 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
23599 if (popup_activated ())
23603 if (NILP (Vmouse_highlight
)
23604 || !f
->glyphs_initialized_p
)
23607 dpyinfo
->mouse_face_mouse_x
= x
;
23608 dpyinfo
->mouse_face_mouse_y
= y
;
23609 dpyinfo
->mouse_face_mouse_frame
= f
;
23611 if (dpyinfo
->mouse_face_defer
)
23614 if (gc_in_progress
)
23616 dpyinfo
->mouse_face_deferred_gc
= 1;
23620 /* Which window is that in? */
23621 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23623 /* If we were displaying active text in another window, clear that.
23624 Also clear if we move out of text area in same window. */
23625 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23626 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23627 && !NILP (dpyinfo
->mouse_face_window
)))
23628 clear_mouse_face (dpyinfo
);
23630 /* Not on a window -> return. */
23631 if (!WINDOWP (window
))
23634 /* Reset help_echo_string. It will get recomputed below. */
23635 help_echo_string
= Qnil
;
23637 /* Convert to window-relative pixel coordinates. */
23638 w
= XWINDOW (window
);
23639 frame_to_window_pixel_xy (w
, &x
, &y
);
23641 /* Handle tool-bar window differently since it doesn't display a
23643 if (EQ (window
, f
->tool_bar_window
))
23645 note_tool_bar_highlight (f
, x
, y
);
23649 /* Mouse is on the mode, header line or margin? */
23650 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23651 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23653 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23657 if (part
== ON_VERTICAL_BORDER
)
23659 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23660 help_echo_string
= build_string ("drag-mouse-1: resize");
23662 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23663 || part
== ON_SCROLL_BAR
)
23664 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23666 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23668 /* Are we in a window whose display is up to date?
23669 And verify the buffer's text has not changed. */
23670 b
= XBUFFER (w
->buffer
);
23671 if (part
== ON_TEXT
23672 && EQ (w
->window_end_valid
, w
->buffer
)
23673 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23674 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23676 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23677 struct glyph
*glyph
;
23678 Lisp_Object object
;
23679 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23680 Lisp_Object
*overlay_vec
= NULL
;
23682 struct buffer
*obuf
;
23683 int obegv
, ozv
, same_region
;
23685 /* Find the glyph under X/Y. */
23686 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23688 /* Look for :pointer property on image. */
23689 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23691 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23692 if (img
!= NULL
&& IMAGEP (img
->spec
))
23694 Lisp_Object image_map
, hotspot
;
23695 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23697 && (hotspot
= find_hot_spot (image_map
,
23698 glyph
->slice
.x
+ dx
,
23699 glyph
->slice
.y
+ dy
),
23701 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23703 Lisp_Object area_id
, plist
;
23705 area_id
= XCAR (hotspot
);
23706 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23707 If so, we could look for mouse-enter, mouse-leave
23708 properties in PLIST (and do something...). */
23709 hotspot
= XCDR (hotspot
);
23710 if (CONSP (hotspot
)
23711 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23713 pointer
= Fplist_get (plist
, Qpointer
);
23714 if (NILP (pointer
))
23716 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23717 if (!NILP (help_echo_string
))
23719 help_echo_window
= window
;
23720 help_echo_object
= glyph
->object
;
23721 help_echo_pos
= glyph
->charpos
;
23725 if (NILP (pointer
))
23726 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23730 /* Clear mouse face if X/Y not over text. */
23732 || area
!= TEXT_AREA
23733 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23735 if (clear_mouse_face (dpyinfo
))
23736 cursor
= No_Cursor
;
23737 if (NILP (pointer
))
23739 if (area
!= TEXT_AREA
)
23740 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23742 pointer
= Vvoid_text_area_pointer
;
23747 pos
= glyph
->charpos
;
23748 object
= glyph
->object
;
23749 if (!STRINGP (object
) && !BUFFERP (object
))
23752 /* If we get an out-of-range value, return now; avoid an error. */
23753 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23756 /* Make the window's buffer temporarily current for
23757 overlays_at and compute_char_face. */
23758 obuf
= current_buffer
;
23759 current_buffer
= b
;
23765 /* Is this char mouse-active or does it have help-echo? */
23766 position
= make_number (pos
);
23768 if (BUFFERP (object
))
23770 /* Put all the overlays we want in a vector in overlay_vec. */
23771 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23772 /* Sort overlays into increasing priority order. */
23773 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23778 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23779 && vpos
>= dpyinfo
->mouse_face_beg_row
23780 && vpos
<= dpyinfo
->mouse_face_end_row
23781 && (vpos
> dpyinfo
->mouse_face_beg_row
23782 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23783 && (vpos
< dpyinfo
->mouse_face_end_row
23784 || hpos
< dpyinfo
->mouse_face_end_col
23785 || dpyinfo
->mouse_face_past_end
));
23788 cursor
= No_Cursor
;
23790 /* Check mouse-face highlighting. */
23792 /* If there exists an overlay with mouse-face overlapping
23793 the one we are currently highlighting, we have to
23794 check if we enter the overlapping overlay, and then
23795 highlight only that. */
23796 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23797 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23799 /* Find the highest priority overlay that has a mouse-face
23802 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23804 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23805 if (!NILP (mouse_face
))
23806 overlay
= overlay_vec
[i
];
23809 /* If we're actually highlighting the same overlay as
23810 before, there's no need to do that again. */
23811 if (!NILP (overlay
)
23812 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23813 goto check_help_echo
;
23815 dpyinfo
->mouse_face_overlay
= overlay
;
23817 /* Clear the display of the old active region, if any. */
23818 if (clear_mouse_face (dpyinfo
))
23819 cursor
= No_Cursor
;
23821 /* If no overlay applies, get a text property. */
23822 if (NILP (overlay
))
23823 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23825 /* Handle the overlay case. */
23826 if (!NILP (overlay
))
23828 /* Find the range of text around this char that
23829 should be active. */
23830 Lisp_Object before
, after
;
23833 before
= Foverlay_start (overlay
);
23834 after
= Foverlay_end (overlay
);
23835 /* Record this as the current active region. */
23836 fast_find_position (w
, XFASTINT (before
),
23837 &dpyinfo
->mouse_face_beg_col
,
23838 &dpyinfo
->mouse_face_beg_row
,
23839 &dpyinfo
->mouse_face_beg_x
,
23840 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23842 dpyinfo
->mouse_face_past_end
23843 = !fast_find_position (w
, XFASTINT (after
),
23844 &dpyinfo
->mouse_face_end_col
,
23845 &dpyinfo
->mouse_face_end_row
,
23846 &dpyinfo
->mouse_face_end_x
,
23847 &dpyinfo
->mouse_face_end_y
, Qnil
);
23848 dpyinfo
->mouse_face_window
= window
;
23850 dpyinfo
->mouse_face_face_id
23851 = face_at_buffer_position (w
, pos
, 0, 0,
23853 !dpyinfo
->mouse_face_hidden
);
23855 /* Display it as active. */
23856 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23857 cursor
= No_Cursor
;
23859 /* Handle the text property case. */
23860 else if (!NILP (mouse_face
) && BUFFERP (object
))
23862 /* Find the range of text around this char that
23863 should be active. */
23864 Lisp_Object before
, after
, beginning
, end
;
23867 beginning
= Fmarker_position (w
->start
);
23868 end
= make_number (BUF_Z (XBUFFER (object
))
23869 - XFASTINT (w
->window_end_pos
));
23871 = Fprevious_single_property_change (make_number (pos
+ 1),
23873 object
, beginning
);
23875 = Fnext_single_property_change (position
, Qmouse_face
,
23878 /* Record this as the current active region. */
23879 fast_find_position (w
, XFASTINT (before
),
23880 &dpyinfo
->mouse_face_beg_col
,
23881 &dpyinfo
->mouse_face_beg_row
,
23882 &dpyinfo
->mouse_face_beg_x
,
23883 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23884 dpyinfo
->mouse_face_past_end
23885 = !fast_find_position (w
, XFASTINT (after
),
23886 &dpyinfo
->mouse_face_end_col
,
23887 &dpyinfo
->mouse_face_end_row
,
23888 &dpyinfo
->mouse_face_end_x
,
23889 &dpyinfo
->mouse_face_end_y
, Qnil
);
23890 dpyinfo
->mouse_face_window
= window
;
23892 if (BUFFERP (object
))
23893 dpyinfo
->mouse_face_face_id
23894 = face_at_buffer_position (w
, pos
, 0, 0,
23896 !dpyinfo
->mouse_face_hidden
);
23898 /* Display it as active. */
23899 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23900 cursor
= No_Cursor
;
23902 else if (!NILP (mouse_face
) && STRINGP (object
))
23907 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23910 e
= Fnext_single_property_change (position
, Qmouse_face
,
23913 b
= make_number (0);
23915 e
= make_number (SCHARS (object
) - 1);
23917 fast_find_string_pos (w
, XINT (b
), object
,
23918 &dpyinfo
->mouse_face_beg_col
,
23919 &dpyinfo
->mouse_face_beg_row
,
23920 &dpyinfo
->mouse_face_beg_x
,
23921 &dpyinfo
->mouse_face_beg_y
, 0);
23922 fast_find_string_pos (w
, XINT (e
), object
,
23923 &dpyinfo
->mouse_face_end_col
,
23924 &dpyinfo
->mouse_face_end_row
,
23925 &dpyinfo
->mouse_face_end_x
,
23926 &dpyinfo
->mouse_face_end_y
, 1);
23927 dpyinfo
->mouse_face_past_end
= 0;
23928 dpyinfo
->mouse_face_window
= window
;
23929 dpyinfo
->mouse_face_face_id
23930 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23931 glyph
->face_id
, 1);
23932 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23933 cursor
= No_Cursor
;
23935 else if (STRINGP (object
) && NILP (mouse_face
))
23937 /* A string which doesn't have mouse-face, but
23938 the text ``under'' it might have. */
23939 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23940 int start
= MATRIX_ROW_START_CHARPOS (r
);
23942 pos
= string_buffer_position (w
, object
, start
);
23944 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23948 if (!NILP (mouse_face
) && !NILP (overlay
))
23950 Lisp_Object before
= Foverlay_start (overlay
);
23951 Lisp_Object after
= Foverlay_end (overlay
);
23954 /* Note that we might not be able to find position
23955 BEFORE in the glyph matrix if the overlay is
23956 entirely covered by a `display' property. In
23957 this case, we overshoot. So let's stop in
23958 the glyph matrix before glyphs for OBJECT. */
23959 fast_find_position (w
, XFASTINT (before
),
23960 &dpyinfo
->mouse_face_beg_col
,
23961 &dpyinfo
->mouse_face_beg_row
,
23962 &dpyinfo
->mouse_face_beg_x
,
23963 &dpyinfo
->mouse_face_beg_y
,
23966 dpyinfo
->mouse_face_past_end
23967 = !fast_find_position (w
, XFASTINT (after
),
23968 &dpyinfo
->mouse_face_end_col
,
23969 &dpyinfo
->mouse_face_end_row
,
23970 &dpyinfo
->mouse_face_end_x
,
23971 &dpyinfo
->mouse_face_end_y
,
23973 dpyinfo
->mouse_face_window
= window
;
23974 dpyinfo
->mouse_face_face_id
23975 = face_at_buffer_position (w
, pos
, 0, 0,
23977 !dpyinfo
->mouse_face_hidden
);
23979 /* Display it as active. */
23980 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23981 cursor
= No_Cursor
;
23988 /* Look for a `help-echo' property. */
23989 if (NILP (help_echo_string
)) {
23990 Lisp_Object help
, overlay
;
23992 /* Check overlays first. */
23993 help
= overlay
= Qnil
;
23994 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23996 overlay
= overlay_vec
[i
];
23997 help
= Foverlay_get (overlay
, Qhelp_echo
);
24002 help_echo_string
= help
;
24003 help_echo_window
= window
;
24004 help_echo_object
= overlay
;
24005 help_echo_pos
= pos
;
24009 Lisp_Object object
= glyph
->object
;
24010 int charpos
= glyph
->charpos
;
24012 /* Try text properties. */
24013 if (STRINGP (object
)
24015 && charpos
< SCHARS (object
))
24017 help
= Fget_text_property (make_number (charpos
),
24018 Qhelp_echo
, object
);
24021 /* If the string itself doesn't specify a help-echo,
24022 see if the buffer text ``under'' it does. */
24023 struct glyph_row
*r
24024 = MATRIX_ROW (w
->current_matrix
, vpos
);
24025 int start
= MATRIX_ROW_START_CHARPOS (r
);
24026 int pos
= string_buffer_position (w
, object
, start
);
24029 help
= Fget_char_property (make_number (pos
),
24030 Qhelp_echo
, w
->buffer
);
24034 object
= w
->buffer
;
24039 else if (BUFFERP (object
)
24042 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24047 help_echo_string
= help
;
24048 help_echo_window
= window
;
24049 help_echo_object
= object
;
24050 help_echo_pos
= charpos
;
24055 /* Look for a `pointer' property. */
24056 if (NILP (pointer
))
24058 /* Check overlays first. */
24059 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24060 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24062 if (NILP (pointer
))
24064 Lisp_Object object
= glyph
->object
;
24065 int charpos
= glyph
->charpos
;
24067 /* Try text properties. */
24068 if (STRINGP (object
)
24070 && charpos
< SCHARS (object
))
24072 pointer
= Fget_text_property (make_number (charpos
),
24074 if (NILP (pointer
))
24076 /* If the string itself doesn't specify a pointer,
24077 see if the buffer text ``under'' it does. */
24078 struct glyph_row
*r
24079 = MATRIX_ROW (w
->current_matrix
, vpos
);
24080 int start
= MATRIX_ROW_START_CHARPOS (r
);
24081 int pos
= string_buffer_position (w
, object
, start
);
24083 pointer
= Fget_char_property (make_number (pos
),
24084 Qpointer
, w
->buffer
);
24087 else if (BUFFERP (object
)
24090 pointer
= Fget_text_property (make_number (charpos
),
24097 current_buffer
= obuf
;
24102 define_frame_cursor1 (f
, cursor
, pointer
);
24107 Clear any mouse-face on window W. This function is part of the
24108 redisplay interface, and is called from try_window_id and similar
24109 functions to ensure the mouse-highlight is off. */
24112 x_clear_window_mouse_face (w
)
24115 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24116 Lisp_Object window
;
24119 XSETWINDOW (window
, w
);
24120 if (EQ (window
, dpyinfo
->mouse_face_window
))
24121 clear_mouse_face (dpyinfo
);
24127 Just discard the mouse face information for frame F, if any.
24128 This is used when the size of F is changed. */
24131 cancel_mouse_face (f
)
24134 Lisp_Object window
;
24135 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24137 window
= dpyinfo
->mouse_face_window
;
24138 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24140 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24141 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24142 dpyinfo
->mouse_face_window
= Qnil
;
24147 #endif /* HAVE_WINDOW_SYSTEM */
24150 /***********************************************************************
24152 ***********************************************************************/
24154 #ifdef HAVE_WINDOW_SYSTEM
24156 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24157 which intersects rectangle R. R is in window-relative coordinates. */
24160 expose_area (w
, row
, r
, area
)
24162 struct glyph_row
*row
;
24164 enum glyph_row_area area
;
24166 struct glyph
*first
= row
->glyphs
[area
];
24167 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24168 struct glyph
*last
;
24169 int first_x
, start_x
, x
;
24171 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24172 /* If row extends face to end of line write the whole line. */
24173 draw_glyphs (w
, 0, row
, area
,
24174 0, row
->used
[area
],
24175 DRAW_NORMAL_TEXT
, 0);
24178 /* Set START_X to the window-relative start position for drawing glyphs of
24179 AREA. The first glyph of the text area can be partially visible.
24180 The first glyphs of other areas cannot. */
24181 start_x
= window_box_left_offset (w
, area
);
24183 if (area
== TEXT_AREA
)
24186 /* Find the first glyph that must be redrawn. */
24188 && x
+ first
->pixel_width
< r
->x
)
24190 x
+= first
->pixel_width
;
24194 /* Find the last one. */
24198 && x
< r
->x
+ r
->width
)
24200 x
+= last
->pixel_width
;
24206 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24207 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24208 DRAW_NORMAL_TEXT
, 0);
24213 /* Redraw the parts of the glyph row ROW on window W intersecting
24214 rectangle R. R is in window-relative coordinates. Value is
24215 non-zero if mouse-face was overwritten. */
24218 expose_line (w
, row
, r
)
24220 struct glyph_row
*row
;
24223 xassert (row
->enabled_p
);
24225 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24226 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24227 0, row
->used
[TEXT_AREA
],
24228 DRAW_NORMAL_TEXT
, 0);
24231 if (row
->used
[LEFT_MARGIN_AREA
])
24232 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24233 if (row
->used
[TEXT_AREA
])
24234 expose_area (w
, row
, r
, TEXT_AREA
);
24235 if (row
->used
[RIGHT_MARGIN_AREA
])
24236 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24237 draw_row_fringe_bitmaps (w
, row
);
24240 return row
->mouse_face_p
;
24244 /* Redraw those parts of glyphs rows during expose event handling that
24245 overlap other rows. Redrawing of an exposed line writes over parts
24246 of lines overlapping that exposed line; this function fixes that.
24248 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24249 row in W's current matrix that is exposed and overlaps other rows.
24250 LAST_OVERLAPPING_ROW is the last such row. */
24253 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24255 struct glyph_row
*first_overlapping_row
;
24256 struct glyph_row
*last_overlapping_row
;
24259 struct glyph_row
*row
;
24261 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24262 if (row
->overlapping_p
)
24264 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24267 if (row
->used
[LEFT_MARGIN_AREA
])
24268 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24270 if (row
->used
[TEXT_AREA
])
24271 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24273 if (row
->used
[RIGHT_MARGIN_AREA
])
24274 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24280 /* Return non-zero if W's cursor intersects rectangle R. */
24283 phys_cursor_in_rect_p (w
, r
)
24287 XRectangle cr
, result
;
24288 struct glyph
*cursor_glyph
;
24289 struct glyph_row
*row
;
24291 if (w
->phys_cursor
.vpos
>= 0
24292 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24293 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24295 && row
->cursor_in_fringe_p
)
24297 /* Cursor is in the fringe. */
24298 cr
.x
= window_box_right_offset (w
,
24299 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24300 ? RIGHT_MARGIN_AREA
24303 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24304 cr
.height
= row
->height
;
24305 return x_intersect_rectangles (&cr
, r
, &result
);
24308 cursor_glyph
= get_phys_cursor_glyph (w
);
24311 /* r is relative to W's box, but w->phys_cursor.x is relative
24312 to left edge of W's TEXT area. Adjust it. */
24313 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24314 cr
.y
= w
->phys_cursor
.y
;
24315 cr
.width
= cursor_glyph
->pixel_width
;
24316 cr
.height
= w
->phys_cursor_height
;
24317 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24318 I assume the effect is the same -- and this is portable. */
24319 return x_intersect_rectangles (&cr
, r
, &result
);
24321 /* If we don't understand the format, pretend we're not in the hot-spot. */
24327 Draw a vertical window border to the right of window W if W doesn't
24328 have vertical scroll bars. */
24331 x_draw_vertical_border (w
)
24334 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24336 /* We could do better, if we knew what type of scroll-bar the adjacent
24337 windows (on either side) have... But we don't :-(
24338 However, I think this works ok. ++KFS 2003-04-25 */
24340 /* Redraw borders between horizontally adjacent windows. Don't
24341 do it for frames with vertical scroll bars because either the
24342 right scroll bar of a window, or the left scroll bar of its
24343 neighbor will suffice as a border. */
24344 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24347 if (!WINDOW_RIGHTMOST_P (w
)
24348 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24350 int x0
, x1
, y0
, y1
;
24352 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24355 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24358 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24360 else if (!WINDOW_LEFTMOST_P (w
)
24361 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24363 int x0
, x1
, y0
, y1
;
24365 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24368 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24371 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24376 /* Redraw the part of window W intersection rectangle FR. Pixel
24377 coordinates in FR are frame-relative. Call this function with
24378 input blocked. Value is non-zero if the exposure overwrites
24382 expose_window (w
, fr
)
24386 struct frame
*f
= XFRAME (w
->frame
);
24388 int mouse_face_overwritten_p
= 0;
24390 /* If window is not yet fully initialized, do nothing. This can
24391 happen when toolkit scroll bars are used and a window is split.
24392 Reconfiguring the scroll bar will generate an expose for a newly
24394 if (w
->current_matrix
== NULL
)
24397 /* When we're currently updating the window, display and current
24398 matrix usually don't agree. Arrange for a thorough display
24400 if (w
== updated_window
)
24402 SET_FRAME_GARBAGED (f
);
24406 /* Frame-relative pixel rectangle of W. */
24407 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24408 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24409 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24410 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24412 if (x_intersect_rectangles (fr
, &wr
, &r
))
24414 int yb
= window_text_bottom_y (w
);
24415 struct glyph_row
*row
;
24416 int cursor_cleared_p
;
24417 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24419 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24420 r
.x
, r
.y
, r
.width
, r
.height
));
24422 /* Convert to window coordinates. */
24423 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24424 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24426 /* Turn off the cursor. */
24427 if (!w
->pseudo_window_p
24428 && phys_cursor_in_rect_p (w
, &r
))
24430 x_clear_cursor (w
);
24431 cursor_cleared_p
= 1;
24434 cursor_cleared_p
= 0;
24436 /* Update lines intersecting rectangle R. */
24437 first_overlapping_row
= last_overlapping_row
= NULL
;
24438 for (row
= w
->current_matrix
->rows
;
24443 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24445 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24446 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24447 || (r
.y
>= y0
&& r
.y
< y1
)
24448 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24450 /* A header line may be overlapping, but there is no need
24451 to fix overlapping areas for them. KFS 2005-02-12 */
24452 if (row
->overlapping_p
&& !row
->mode_line_p
)
24454 if (first_overlapping_row
== NULL
)
24455 first_overlapping_row
= row
;
24456 last_overlapping_row
= row
;
24460 if (expose_line (w
, row
, &r
))
24461 mouse_face_overwritten_p
= 1;
24464 else if (row
->overlapping_p
)
24466 /* We must redraw a row overlapping the exposed area. */
24468 ? y0
+ row
->phys_height
> r
.y
24469 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24471 if (first_overlapping_row
== NULL
)
24472 first_overlapping_row
= row
;
24473 last_overlapping_row
= row
;
24481 /* Display the mode line if there is one. */
24482 if (WINDOW_WANTS_MODELINE_P (w
)
24483 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24485 && row
->y
< r
.y
+ r
.height
)
24487 if (expose_line (w
, row
, &r
))
24488 mouse_face_overwritten_p
= 1;
24491 if (!w
->pseudo_window_p
)
24493 /* Fix the display of overlapping rows. */
24494 if (first_overlapping_row
)
24495 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24498 /* Draw border between windows. */
24499 x_draw_vertical_border (w
);
24501 /* Turn the cursor on again. */
24502 if (cursor_cleared_p
)
24503 update_window_cursor (w
, 1);
24507 return mouse_face_overwritten_p
;
24512 /* Redraw (parts) of all windows in the window tree rooted at W that
24513 intersect R. R contains frame pixel coordinates. Value is
24514 non-zero if the exposure overwrites mouse-face. */
24517 expose_window_tree (w
, r
)
24521 struct frame
*f
= XFRAME (w
->frame
);
24522 int mouse_face_overwritten_p
= 0;
24524 while (w
&& !FRAME_GARBAGED_P (f
))
24526 if (!NILP (w
->hchild
))
24527 mouse_face_overwritten_p
24528 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24529 else if (!NILP (w
->vchild
))
24530 mouse_face_overwritten_p
24531 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24533 mouse_face_overwritten_p
|= expose_window (w
, r
);
24535 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24538 return mouse_face_overwritten_p
;
24543 Redisplay an exposed area of frame F. X and Y are the upper-left
24544 corner of the exposed rectangle. W and H are width and height of
24545 the exposed area. All are pixel values. W or H zero means redraw
24546 the entire frame. */
24549 expose_frame (f
, x
, y
, w
, h
)
24554 int mouse_face_overwritten_p
= 0;
24556 TRACE ((stderr
, "expose_frame "));
24558 /* No need to redraw if frame will be redrawn soon. */
24559 if (FRAME_GARBAGED_P (f
))
24561 TRACE ((stderr
, " garbaged\n"));
24565 /* If basic faces haven't been realized yet, there is no point in
24566 trying to redraw anything. This can happen when we get an expose
24567 event while Emacs is starting, e.g. by moving another window. */
24568 if (FRAME_FACE_CACHE (f
) == NULL
24569 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24571 TRACE ((stderr
, " no faces\n"));
24575 if (w
== 0 || h
== 0)
24578 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24579 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24589 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24590 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24592 if (WINDOWP (f
->tool_bar_window
))
24593 mouse_face_overwritten_p
24594 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24596 #ifdef HAVE_X_WINDOWS
24598 #ifndef USE_X_TOOLKIT
24599 if (WINDOWP (f
->menu_bar_window
))
24600 mouse_face_overwritten_p
24601 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24602 #endif /* not USE_X_TOOLKIT */
24606 /* Some window managers support a focus-follows-mouse style with
24607 delayed raising of frames. Imagine a partially obscured frame,
24608 and moving the mouse into partially obscured mouse-face on that
24609 frame. The visible part of the mouse-face will be highlighted,
24610 then the WM raises the obscured frame. With at least one WM, KDE
24611 2.1, Emacs is not getting any event for the raising of the frame
24612 (even tried with SubstructureRedirectMask), only Expose events.
24613 These expose events will draw text normally, i.e. not
24614 highlighted. Which means we must redo the highlight here.
24615 Subsume it under ``we love X''. --gerd 2001-08-15 */
24616 /* Included in Windows version because Windows most likely does not
24617 do the right thing if any third party tool offers
24618 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24619 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24621 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24622 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24624 int x
= dpyinfo
->mouse_face_mouse_x
;
24625 int y
= dpyinfo
->mouse_face_mouse_y
;
24626 clear_mouse_face (dpyinfo
);
24627 note_mouse_highlight (f
, x
, y
);
24634 Determine the intersection of two rectangles R1 and R2. Return
24635 the intersection in *RESULT. Value is non-zero if RESULT is not
24639 x_intersect_rectangles (r1
, r2
, result
)
24640 XRectangle
*r1
, *r2
, *result
;
24642 XRectangle
*left
, *right
;
24643 XRectangle
*upper
, *lower
;
24644 int intersection_p
= 0;
24646 /* Rearrange so that R1 is the left-most rectangle. */
24648 left
= r1
, right
= r2
;
24650 left
= r2
, right
= r1
;
24652 /* X0 of the intersection is right.x0, if this is inside R1,
24653 otherwise there is no intersection. */
24654 if (right
->x
<= left
->x
+ left
->width
)
24656 result
->x
= right
->x
;
24658 /* The right end of the intersection is the minimum of the
24659 the right ends of left and right. */
24660 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24663 /* Same game for Y. */
24665 upper
= r1
, lower
= r2
;
24667 upper
= r2
, lower
= r1
;
24669 /* The upper end of the intersection is lower.y0, if this is inside
24670 of upper. Otherwise, there is no intersection. */
24671 if (lower
->y
<= upper
->y
+ upper
->height
)
24673 result
->y
= lower
->y
;
24675 /* The lower end of the intersection is the minimum of the lower
24676 ends of upper and lower. */
24677 result
->height
= (min (lower
->y
+ lower
->height
,
24678 upper
->y
+ upper
->height
)
24680 intersection_p
= 1;
24684 return intersection_p
;
24687 #endif /* HAVE_WINDOW_SYSTEM */
24690 /***********************************************************************
24692 ***********************************************************************/
24697 Vwith_echo_area_save_vector
= Qnil
;
24698 staticpro (&Vwith_echo_area_save_vector
);
24700 Vmessage_stack
= Qnil
;
24701 staticpro (&Vmessage_stack
);
24703 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24704 staticpro (&Qinhibit_redisplay
);
24706 message_dolog_marker1
= Fmake_marker ();
24707 staticpro (&message_dolog_marker1
);
24708 message_dolog_marker2
= Fmake_marker ();
24709 staticpro (&message_dolog_marker2
);
24710 message_dolog_marker3
= Fmake_marker ();
24711 staticpro (&message_dolog_marker3
);
24714 defsubr (&Sdump_frame_glyph_matrix
);
24715 defsubr (&Sdump_glyph_matrix
);
24716 defsubr (&Sdump_glyph_row
);
24717 defsubr (&Sdump_tool_bar_row
);
24718 defsubr (&Strace_redisplay
);
24719 defsubr (&Strace_to_stderr
);
24721 #ifdef HAVE_WINDOW_SYSTEM
24722 defsubr (&Stool_bar_lines_needed
);
24723 defsubr (&Slookup_image_map
);
24725 defsubr (&Sformat_mode_line
);
24726 defsubr (&Sinvisible_p
);
24728 staticpro (&Qmenu_bar_update_hook
);
24729 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24731 staticpro (&Qoverriding_terminal_local_map
);
24732 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24734 staticpro (&Qoverriding_local_map
);
24735 Qoverriding_local_map
= intern ("overriding-local-map");
24737 staticpro (&Qwindow_scroll_functions
);
24738 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24740 staticpro (&Qwindow_text_change_functions
);
24741 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24743 staticpro (&Qredisplay_end_trigger_functions
);
24744 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24746 staticpro (&Qinhibit_point_motion_hooks
);
24747 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24749 Qeval
= intern ("eval");
24750 staticpro (&Qeval
);
24752 QCdata
= intern (":data");
24753 staticpro (&QCdata
);
24754 Qdisplay
= intern ("display");
24755 staticpro (&Qdisplay
);
24756 Qspace_width
= intern ("space-width");
24757 staticpro (&Qspace_width
);
24758 Qraise
= intern ("raise");
24759 staticpro (&Qraise
);
24760 Qslice
= intern ("slice");
24761 staticpro (&Qslice
);
24762 Qspace
= intern ("space");
24763 staticpro (&Qspace
);
24764 Qmargin
= intern ("margin");
24765 staticpro (&Qmargin
);
24766 Qpointer
= intern ("pointer");
24767 staticpro (&Qpointer
);
24768 Qleft_margin
= intern ("left-margin");
24769 staticpro (&Qleft_margin
);
24770 Qright_margin
= intern ("right-margin");
24771 staticpro (&Qright_margin
);
24772 Qcenter
= intern ("center");
24773 staticpro (&Qcenter
);
24774 Qline_height
= intern ("line-height");
24775 staticpro (&Qline_height
);
24776 QCalign_to
= intern (":align-to");
24777 staticpro (&QCalign_to
);
24778 QCrelative_width
= intern (":relative-width");
24779 staticpro (&QCrelative_width
);
24780 QCrelative_height
= intern (":relative-height");
24781 staticpro (&QCrelative_height
);
24782 QCeval
= intern (":eval");
24783 staticpro (&QCeval
);
24784 QCpropertize
= intern (":propertize");
24785 staticpro (&QCpropertize
);
24786 QCfile
= intern (":file");
24787 staticpro (&QCfile
);
24788 Qfontified
= intern ("fontified");
24789 staticpro (&Qfontified
);
24790 Qfontification_functions
= intern ("fontification-functions");
24791 staticpro (&Qfontification_functions
);
24792 Qtrailing_whitespace
= intern ("trailing-whitespace");
24793 staticpro (&Qtrailing_whitespace
);
24794 Qescape_glyph
= intern ("escape-glyph");
24795 staticpro (&Qescape_glyph
);
24796 Qnobreak_space
= intern ("nobreak-space");
24797 staticpro (&Qnobreak_space
);
24798 Qimage
= intern ("image");
24799 staticpro (&Qimage
);
24800 QCmap
= intern (":map");
24801 staticpro (&QCmap
);
24802 QCpointer
= intern (":pointer");
24803 staticpro (&QCpointer
);
24804 Qrect
= intern ("rect");
24805 staticpro (&Qrect
);
24806 Qcircle
= intern ("circle");
24807 staticpro (&Qcircle
);
24808 Qpoly
= intern ("poly");
24809 staticpro (&Qpoly
);
24810 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24811 staticpro (&Qmessage_truncate_lines
);
24812 Qgrow_only
= intern ("grow-only");
24813 staticpro (&Qgrow_only
);
24814 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24815 staticpro (&Qinhibit_menubar_update
);
24816 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24817 staticpro (&Qinhibit_eval_during_redisplay
);
24818 Qposition
= intern ("position");
24819 staticpro (&Qposition
);
24820 Qbuffer_position
= intern ("buffer-position");
24821 staticpro (&Qbuffer_position
);
24822 Qobject
= intern ("object");
24823 staticpro (&Qobject
);
24824 Qbar
= intern ("bar");
24826 Qhbar
= intern ("hbar");
24827 staticpro (&Qhbar
);
24828 Qbox
= intern ("box");
24830 Qhollow
= intern ("hollow");
24831 staticpro (&Qhollow
);
24832 Qhand
= intern ("hand");
24833 staticpro (&Qhand
);
24834 Qarrow
= intern ("arrow");
24835 staticpro (&Qarrow
);
24836 Qtext
= intern ("text");
24837 staticpro (&Qtext
);
24838 Qrisky_local_variable
= intern ("risky-local-variable");
24839 staticpro (&Qrisky_local_variable
);
24840 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24841 staticpro (&Qinhibit_free_realized_faces
);
24843 list_of_error
= Fcons (Fcons (intern ("error"),
24844 Fcons (intern ("void-variable"), Qnil
)),
24846 staticpro (&list_of_error
);
24848 Qlast_arrow_position
= intern ("last-arrow-position");
24849 staticpro (&Qlast_arrow_position
);
24850 Qlast_arrow_string
= intern ("last-arrow-string");
24851 staticpro (&Qlast_arrow_string
);
24853 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24854 staticpro (&Qoverlay_arrow_string
);
24855 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24856 staticpro (&Qoverlay_arrow_bitmap
);
24858 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24859 staticpro (&echo_buffer
[0]);
24860 staticpro (&echo_buffer
[1]);
24862 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24863 staticpro (&echo_area_buffer
[0]);
24864 staticpro (&echo_area_buffer
[1]);
24866 Vmessages_buffer_name
= build_string ("*Messages*");
24867 staticpro (&Vmessages_buffer_name
);
24869 mode_line_proptrans_alist
= Qnil
;
24870 staticpro (&mode_line_proptrans_alist
);
24871 mode_line_string_list
= Qnil
;
24872 staticpro (&mode_line_string_list
);
24873 mode_line_string_face
= Qnil
;
24874 staticpro (&mode_line_string_face
);
24875 mode_line_string_face_prop
= Qnil
;
24876 staticpro (&mode_line_string_face_prop
);
24877 Vmode_line_unwind_vector
= Qnil
;
24878 staticpro (&Vmode_line_unwind_vector
);
24880 help_echo_string
= Qnil
;
24881 staticpro (&help_echo_string
);
24882 help_echo_object
= Qnil
;
24883 staticpro (&help_echo_object
);
24884 help_echo_window
= Qnil
;
24885 staticpro (&help_echo_window
);
24886 previous_help_echo_string
= Qnil
;
24887 staticpro (&previous_help_echo_string
);
24888 help_echo_pos
= -1;
24890 #ifdef HAVE_WINDOW_SYSTEM
24891 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24892 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24893 For example, if a block cursor is over a tab, it will be drawn as
24894 wide as that tab on the display. */);
24895 x_stretch_cursor_p
= 0;
24898 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24899 doc
: /* *Non-nil means highlight trailing whitespace.
24900 The face used for trailing whitespace is `trailing-whitespace'. */);
24901 Vshow_trailing_whitespace
= Qnil
;
24903 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24904 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24905 A value of t means highlight the character itself (for nobreak space,
24906 use face `nobreak-space').
24907 A value of nil means no highlighting.
24908 Other values mean display the escape glyph followed by an ordinary
24909 space or ordinary hyphen. */);
24910 Vnobreak_char_display
= Qt
;
24912 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24913 doc
: /* *The pointer shape to show in void text areas.
24914 A value of nil means to show the text pointer. Other options are `arrow',
24915 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24916 Vvoid_text_area_pointer
= Qarrow
;
24918 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24919 doc
: /* Non-nil means don't actually do any redisplay.
24920 This is used for internal purposes. */);
24921 Vinhibit_redisplay
= Qnil
;
24923 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24924 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24925 Vglobal_mode_string
= Qnil
;
24927 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24928 doc
: /* Marker for where to display an arrow on top of the buffer text.
24929 This must be the beginning of a line in order to work.
24930 See also `overlay-arrow-string'. */);
24931 Voverlay_arrow_position
= Qnil
;
24933 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24934 doc
: /* String to display as an arrow in non-window frames.
24935 See also `overlay-arrow-position'. */);
24936 Voverlay_arrow_string
= build_string ("=>");
24938 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24939 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24940 The symbols on this list are examined during redisplay to determine
24941 where to display overlay arrows. */);
24942 Voverlay_arrow_variable_list
24943 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24945 DEFVAR_INT ("scroll-step", &scroll_step
,
24946 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24947 If that fails to bring point back on frame, point is centered instead.
24948 If this is zero, point is always centered after it moves off frame.
24949 If you want scrolling to always be a line at a time, you should set
24950 `scroll-conservatively' to a large value rather than set this to 1. */);
24952 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24953 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24954 If point moves off-screen, redisplay will scroll by up to
24955 `scroll-conservatively' lines in order to bring point just barely
24956 onto the screen again. If that cannot be done, then redisplay
24957 recenters point as usual.
24959 A value of zero means always recenter point if it moves off screen. */);
24960 scroll_conservatively
= 0;
24962 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24963 doc
: /* *Number of lines of margin at the top and bottom of a window.
24964 Recenter the window whenever point gets within this many lines
24965 of the top or bottom of the window. */);
24968 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24969 doc
: /* Pixels per inch value for non-window system displays.
24970 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24971 Vdisplay_pixels_per_inch
= make_float (72.0);
24974 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24977 DEFVAR_LISP ("truncate-partial-width-windows",
24978 &Vtruncate_partial_width_windows
,
24979 doc
: /* Non-nil means truncate lines in windows with less than the frame width.
24980 For an integer value, truncate lines in each window with less than the
24981 full frame width, provided the window width is less than that integer;
24982 otherwise, respect the value of `truncate-lines'.
24984 For any other non-nil value, truncate lines in all windows with
24985 less than the full frame width.
24987 A value of nil means to respect the value of `truncate-lines'.
24989 If `word-wrap' is enabled, you might want to reduce this. */);
24990 Vtruncate_partial_width_windows
= make_number (50);
24992 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24993 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24994 Any other value means to use the appropriate face, `mode-line',
24995 `header-line', or `menu' respectively. */);
24996 mode_line_inverse_video
= 1;
24998 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24999 doc
: /* *Maximum buffer size for which line number should be displayed.
25000 If the buffer is bigger than this, the line number does not appear
25001 in the mode line. A value of nil means no limit. */);
25002 Vline_number_display_limit
= Qnil
;
25004 DEFVAR_INT ("line-number-display-limit-width",
25005 &line_number_display_limit_width
,
25006 doc
: /* *Maximum line width (in characters) for line number display.
25007 If the average length of the lines near point is bigger than this, then the
25008 line number may be omitted from the mode line. */);
25009 line_number_display_limit_width
= 200;
25011 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25012 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25013 highlight_nonselected_windows
= 0;
25015 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25016 doc
: /* Non-nil if more than one frame is visible on this display.
25017 Minibuffer-only frames don't count, but iconified frames do.
25018 This variable is not guaranteed to be accurate except while processing
25019 `frame-title-format' and `icon-title-format'. */);
25021 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25022 doc
: /* Template for displaying the title bar of visible frames.
25023 \(Assuming the window manager supports this feature.)
25025 This variable has the same structure as `mode-line-format', except that
25026 the %c and %l constructs are ignored. It is used only on frames for
25027 which no explicit name has been set \(see `modify-frame-parameters'). */);
25029 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25030 doc
: /* Template for displaying the title bar of an iconified frame.
25031 \(Assuming the window manager supports this feature.)
25032 This variable has the same structure as `mode-line-format' (which see),
25033 and is used only on frames for which no explicit name has been set
25034 \(see `modify-frame-parameters'). */);
25036 = Vframe_title_format
25037 = Fcons (intern ("multiple-frames"),
25038 Fcons (build_string ("%b"),
25039 Fcons (Fcons (empty_unibyte_string
,
25040 Fcons (intern ("invocation-name"),
25041 Fcons (build_string ("@"),
25042 Fcons (intern ("system-name"),
25046 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25047 doc
: /* Maximum number of lines to keep in the message log buffer.
25048 If nil, disable message logging. If t, log messages but don't truncate
25049 the buffer when it becomes large. */);
25050 Vmessage_log_max
= make_number (100);
25052 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25053 doc
: /* Functions called before redisplay, if window sizes have changed.
25054 The value should be a list of functions that take one argument.
25055 Just before redisplay, for each frame, if any of its windows have changed
25056 size since the last redisplay, or have been split or deleted,
25057 all the functions in the list are called, with the frame as argument. */);
25058 Vwindow_size_change_functions
= Qnil
;
25060 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25061 doc
: /* List of functions to call before redisplaying a window with scrolling.
25062 Each function is called with two arguments, the window and its new
25063 display-start position. Note that these functions are also called by
25064 `set-window-buffer'. Also note that the value of `window-end' is not
25065 valid when these functions are called. */);
25066 Vwindow_scroll_functions
= Qnil
;
25068 DEFVAR_LISP ("window-text-change-functions",
25069 &Vwindow_text_change_functions
,
25070 doc
: /* Functions to call in redisplay when text in the window might change. */);
25071 Vwindow_text_change_functions
= Qnil
;
25073 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25074 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25075 Each function is called with two arguments, the window and the end trigger value.
25076 See `set-window-redisplay-end-trigger'. */);
25077 Vredisplay_end_trigger_functions
= Qnil
;
25079 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25080 doc
: /* *Non-nil means autoselect window with mouse pointer.
25081 If nil, do not autoselect windows.
25082 A positive number means delay autoselection by that many seconds: a
25083 window is autoselected only after the mouse has remained in that
25084 window for the duration of the delay.
25085 A negative number has a similar effect, but causes windows to be
25086 autoselected only after the mouse has stopped moving. \(Because of
25087 the way Emacs compares mouse events, you will occasionally wait twice
25088 that time before the window gets selected.\)
25089 Any other value means to autoselect window instantaneously when the
25090 mouse pointer enters it.
25092 Autoselection selects the minibuffer only if it is active, and never
25093 unselects the minibuffer if it is active.
25095 When customizing this variable make sure that the actual value of
25096 `focus-follows-mouse' matches the behavior of your window manager. */);
25097 Vmouse_autoselect_window
= Qnil
;
25099 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25100 doc
: /* *Non-nil means automatically resize tool-bars.
25101 This dynamically changes the tool-bar's height to the minimum height
25102 that is needed to make all tool-bar items visible.
25103 If value is `grow-only', the tool-bar's height is only increased
25104 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25105 Vauto_resize_tool_bars
= Qt
;
25107 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25108 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25109 auto_raise_tool_bar_buttons_p
= 1;
25111 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25112 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25113 make_cursor_line_fully_visible_p
= 1;
25115 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25116 doc
: /* *Border below tool-bar in pixels.
25117 If an integer, use it as the height of the border.
25118 If it is one of `internal-border-width' or `border-width', use the
25119 value of the corresponding frame parameter.
25120 Otherwise, no border is added below the tool-bar. */);
25121 Vtool_bar_border
= Qinternal_border_width
;
25123 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25124 doc
: /* *Margin around tool-bar buttons in pixels.
25125 If an integer, use that for both horizontal and vertical margins.
25126 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25127 HORZ specifying the horizontal margin, and VERT specifying the
25128 vertical margin. */);
25129 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25131 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25132 doc
: /* *Relief thickness of tool-bar buttons. */);
25133 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25135 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25136 doc
: /* List of functions to call to fontify regions of text.
25137 Each function is called with one argument POS. Functions must
25138 fontify a region starting at POS in the current buffer, and give
25139 fontified regions the property `fontified'. */);
25140 Vfontification_functions
= Qnil
;
25141 Fmake_variable_buffer_local (Qfontification_functions
);
25143 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25144 &unibyte_display_via_language_environment
,
25145 doc
: /* *Non-nil means display unibyte text according to language environment.
25146 Specifically this means that unibyte non-ASCII characters
25147 are displayed by converting them to the equivalent multibyte characters
25148 according to the current language environment. As a result, they are
25149 displayed according to the current fontset. */);
25150 unibyte_display_via_language_environment
= 0;
25152 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25153 doc
: /* *Maximum height for resizing mini-windows.
25154 If a float, it specifies a fraction of the mini-window frame's height.
25155 If an integer, it specifies a number of lines. */);
25156 Vmax_mini_window_height
= make_float (0.25);
25158 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25159 doc
: /* *How to resize mini-windows.
25160 A value of nil means don't automatically resize mini-windows.
25161 A value of t means resize them to fit the text displayed in them.
25162 A value of `grow-only', the default, means let mini-windows grow
25163 only, until their display becomes empty, at which point the windows
25164 go back to their normal size. */);
25165 Vresize_mini_windows
= Qgrow_only
;
25167 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25168 doc
: /* Alist specifying how to blink the cursor off.
25169 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25170 `cursor-type' frame-parameter or variable equals ON-STATE,
25171 comparing using `equal', Emacs uses OFF-STATE to specify
25172 how to blink it off. ON-STATE and OFF-STATE are values for
25173 the `cursor-type' frame parameter.
25175 If a frame's ON-STATE has no entry in this list,
25176 the frame's other specifications determine how to blink the cursor off. */);
25177 Vblink_cursor_alist
= Qnil
;
25179 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25180 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25181 automatic_hscrolling_p
= 1;
25182 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
25183 staticpro (&Qauto_hscroll_mode
);
25185 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25186 doc
: /* *How many columns away from the window edge point is allowed to get
25187 before automatic hscrolling will horizontally scroll the window. */);
25188 hscroll_margin
= 5;
25190 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25191 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25192 When point is less than `hscroll-margin' columns from the window
25193 edge, automatic hscrolling will scroll the window by the amount of columns
25194 determined by this variable. If its value is a positive integer, scroll that
25195 many columns. If it's a positive floating-point number, it specifies the
25196 fraction of the window's width to scroll. If it's nil or zero, point will be
25197 centered horizontally after the scroll. Any other value, including negative
25198 numbers, are treated as if the value were zero.
25200 Automatic hscrolling always moves point outside the scroll margin, so if
25201 point was more than scroll step columns inside the margin, the window will
25202 scroll more than the value given by the scroll step.
25204 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25205 and `scroll-right' overrides this variable's effect. */);
25206 Vhscroll_step
= make_number (0);
25208 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25209 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25210 Bind this around calls to `message' to let it take effect. */);
25211 message_truncate_lines
= 0;
25213 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25214 doc
: /* Normal hook run to update the menu bar definitions.
25215 Redisplay runs this hook before it redisplays the menu bar.
25216 This is used to update submenus such as Buffers,
25217 whose contents depend on various data. */);
25218 Vmenu_bar_update_hook
= Qnil
;
25220 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25221 doc
: /* Frame for which we are updating a menu.
25222 The enable predicate for a menu binding should check this variable. */);
25223 Vmenu_updating_frame
= Qnil
;
25225 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25226 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25227 inhibit_menubar_update
= 0;
25229 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25230 doc
: /* Prefix added to the beginning of all continuation lines at display-time.
25231 May be a string, an image, or a stretch-glyph such as used by the
25232 `display' text-property.
25234 This variable is overridden by any `wrap-prefix' text-property.
25236 To add a prefix to non-continuation lines, use the `line-prefix' variable. */);
25237 Vwrap_prefix
= Qnil
;
25238 staticpro (&Qwrap_prefix
);
25239 Qwrap_prefix
= intern ("wrap-prefix");
25240 Fmake_variable_buffer_local (Qwrap_prefix
);
25242 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25243 doc
: /* Prefix added to the beginning of all non-continuation lines at display-time.
25244 May be a string, an image, or a stretch-glyph such as used by the
25245 `display' text-property.
25247 This variable is overridden by any `line-prefix' text-property.
25249 To add a prefix to continuation lines, use the `wrap-prefix' variable. */);
25250 Vline_prefix
= Qnil
;
25251 staticpro (&Qline_prefix
);
25252 Qline_prefix
= intern ("line-prefix");
25253 Fmake_variable_buffer_local (Qline_prefix
);
25255 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25256 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25257 inhibit_eval_during_redisplay
= 0;
25259 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25260 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25261 inhibit_free_realized_faces
= 0;
25264 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25265 doc
: /* Inhibit try_window_id display optimization. */);
25266 inhibit_try_window_id
= 0;
25268 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25269 doc
: /* Inhibit try_window_reusing display optimization. */);
25270 inhibit_try_window_reusing
= 0;
25272 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25273 doc
: /* Inhibit try_cursor_movement display optimization. */);
25274 inhibit_try_cursor_movement
= 0;
25275 #endif /* GLYPH_DEBUG */
25277 DEFVAR_INT ("overline-margin", &overline_margin
,
25278 doc
: /* *Space between overline and text, in pixels.
25279 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25280 margin to the caracter height. */);
25281 overline_margin
= 2;
25283 DEFVAR_INT ("underline-minimum-offset",
25284 &underline_minimum_offset
,
25285 doc
: /* Minimum distance between baseline and underline.
25286 This can improve legibility of underlined text at small font sizes,
25287 particularly when using variable `x-use-underline-position-properties'
25288 with fonts that specify an UNDERLINE_POSITION relatively close to the
25289 baseline. The default value is 1. */);
25290 underline_minimum_offset
= 1;
25292 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25293 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25294 display_hourglass_p
= 1;
25296 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25297 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25298 Value must be an integer or float. */);
25299 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25301 hourglass_atimer
= NULL
;
25302 hourglass_shown_p
= 0;
25306 /* Initialize this module when Emacs starts. */
25311 Lisp_Object root_window
;
25312 struct window
*mini_w
;
25314 current_header_line_height
= current_mode_line_height
= -1;
25316 CHARPOS (this_line_start_pos
) = 0;
25318 mini_w
= XWINDOW (minibuf_window
);
25319 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25321 if (!noninteractive
)
25323 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25326 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25327 set_window_height (root_window
,
25328 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25330 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25331 set_window_height (minibuf_window
, 1, 0);
25333 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25334 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25336 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25337 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25338 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25340 /* The default ellipsis glyphs `...'. */
25341 for (i
= 0; i
< 3; ++i
)
25342 default_invis_vector
[i
] = make_number ('.');
25346 /* Allocate the buffer for frame titles.
25347 Also used for `format-mode-line'. */
25349 mode_line_noprop_buf
= (char *) xmalloc (size
);
25350 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25351 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25352 mode_line_target
= MODE_LINE_DISPLAY
;
25355 help_echo_showing_p
= 0;
25358 /* Since w32 does not support atimers, it defines its own implementation of
25359 the following three functions in w32fns.c. */
25362 /* Platform-independent portion of hourglass implementation. */
25364 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25366 hourglass_started ()
25368 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25371 /* Cancel a currently active hourglass timer, and start a new one. */
25375 #if defined (HAVE_WINDOW_SYSTEM)
25377 int secs
, usecs
= 0;
25379 cancel_hourglass ();
25381 if (INTEGERP (Vhourglass_delay
)
25382 && XINT (Vhourglass_delay
) > 0)
25383 secs
= XFASTINT (Vhourglass_delay
);
25384 else if (FLOATP (Vhourglass_delay
)
25385 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25388 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25389 secs
= XFASTINT (tem
);
25390 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25393 secs
= DEFAULT_HOURGLASS_DELAY
;
25395 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25396 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25397 show_hourglass
, NULL
);
25402 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25405 cancel_hourglass ()
25407 #if defined (HAVE_WINDOW_SYSTEM)
25408 if (hourglass_atimer
)
25410 cancel_atimer (hourglass_atimer
);
25411 hourglass_atimer
= NULL
;
25414 if (hourglass_shown_p
)
25418 #endif /* ! WINDOWSNT */
25420 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25421 (do not change this comment) */