1 /* Display generation from window structure and buffer text.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code. (Or,
35 let's say almost---see the description of direct update
38 The following diagram shows how redisplay code is invoked. As you
39 can see, Lisp calls redisplay and vice versa. Under window systems
40 like X, some portions of the redisplay code are also called
41 asynchronously during mouse movement or expose events. It is very
42 important that these code parts do NOT use the C library (malloc,
43 free) because many C libraries under Unix are not reentrant. They
44 may also NOT call functions of the Lisp interpreter which could
45 change the interpreter's state. If you don't follow these rules,
46 you will encounter bugs which are very hard to explain.
48 (Direct functions, see below)
49 direct_output_for_insert,
50 direct_forward_char (dispnew.c)
51 +---------------------------------+
54 +--------------+ redisplay +----------------+
55 | Lisp machine |---------------->| Redisplay code |<--+
56 +--------------+ (xdisp.c) +----------------+ |
58 +----------------------------------+ |
59 Don't use this path when called |
62 expose_window (asynchronous) |
64 X expose events -----+
66 What does redisplay do? Obviously, it has to figure out somehow what
67 has been changed since the last time the display has been updated,
68 and to make these changes visible. Preferably it would do that in
69 a moderately intelligent way, i.e. fast.
71 Changes in buffer text can be deduced from window and buffer
72 structures, and from some global variables like `beg_unchanged' and
73 `end_unchanged'. The contents of the display are additionally
74 recorded in a `glyph matrix', a two-dimensional matrix of glyph
75 structures. Each row in such a matrix corresponds to a line on the
76 display, and each glyph in a row corresponds to a column displaying
77 a character, an image, or what else. This matrix is called the
78 `current glyph matrix' or `current matrix' in redisplay
81 For buffer parts that have been changed since the last update, a
82 second glyph matrix is constructed, the so called `desired glyph
83 matrix' or short `desired matrix'. Current and desired matrix are
84 then compared to find a cheap way to update the display, e.g. by
85 reusing part of the display by scrolling lines.
90 You will find a lot of redisplay optimizations when you start
91 looking at the innards of redisplay. The overall goal of all these
92 optimizations is to make redisplay fast because it is done
95 Two optimizations are not found in xdisp.c. These are the direct
96 operations mentioned above. As the name suggests they follow a
97 different principle than the rest of redisplay. Instead of
98 building a desired matrix and then comparing it with the current
99 display, they perform their actions directly on the display and on
102 One direct operation updates the display after one character has
103 been entered. The other one moves the cursor by one position
104 forward or backward. You find these functions under the names
105 `direct_output_for_insert' and `direct_output_forward_char' in
111 Desired matrices are always built per Emacs window. The function
112 `display_line' is the central function to look at if you are
113 interested. It constructs one row in a desired matrix given an
114 iterator structure containing both a buffer position and a
115 description of the environment in which the text is to be
116 displayed. But this is too early, read on.
118 Characters and pixmaps displayed for a range of buffer text depend
119 on various settings of buffers and windows, on overlays and text
120 properties, on display tables, on selective display. The good news
121 is that all this hairy stuff is hidden behind a small set of
122 interface functions taking an iterator structure (struct it)
125 Iteration over things to be displayed is then simple. It is
126 started by initializing an iterator with a call to init_iterator.
127 Calls to get_next_display_element fill the iterator structure with
128 relevant information about the next thing to display. Calls to
129 set_iterator_to_next move the iterator to the next thing.
131 Besides this, an iterator also contains information about the
132 display environment in which glyphs for display elements are to be
133 produced. It has fields for the width and height of the display,
134 the information whether long lines are truncated or continued, a
135 current X and Y position, and lots of other stuff you can better
138 Glyphs in a desired matrix are normally constructed in a loop
139 calling get_next_display_element and then produce_glyphs. The call
140 to produce_glyphs will fill the iterator structure with pixel
141 information about the element being displayed and at the same time
142 produce glyphs for it. If the display element fits on the line
143 being displayed, set_iterator_to_next is called next, otherwise the
144 glyphs produced are discarded.
149 That just couldn't be all, could it? What about terminal types not
150 supporting operations on sub-windows of the screen? To update the
151 display on such a terminal, window-based glyph matrices are not
152 well suited. To be able to reuse part of the display (scrolling
153 lines up and down), we must instead have a view of the whole
154 screen. This is what `frame matrices' are for. They are a trick.
156 Frames on terminals like above have a glyph pool. Windows on such
157 a frame sub-allocate their glyph memory from their frame's glyph
158 pool. The frame itself is given its own glyph matrices. By
159 coincidence---or maybe something else---rows in window glyph
160 matrices are slices of corresponding rows in frame matrices. Thus
161 writing to window matrices implicitly updates a frame matrix which
162 provides us with the view of the whole screen that we originally
163 wanted to have without having to move many bytes around. To be
164 honest, there is a little bit more done, but not much more. If you
165 plan to extend that code, take a look at dispnew.c. The function
166 build_frame_matrix is a good starting point. */
173 #include "keyboard.h"
176 #include "termchar.h"
177 #include "dispextern.h"
179 #include "character.h"
182 #include "commands.h"
186 #include "termhooks.h"
187 #include "intervals.h"
190 #include "region-cache.h"
193 #include "blockinput.h"
195 #ifdef HAVE_X_WINDOWS
210 #ifndef FRAME_X_OUTPUT
211 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
214 #define INFINITY 10000000
216 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
217 || defined(HAVE_NS) || defined (USE_GTK)
218 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
219 extern int pending_menu_activation
;
222 extern int interrupt_input
;
223 extern int command_loop_level
;
225 extern Lisp_Object do_mouse_tracking
;
227 extern int minibuffer_auto_raise
;
228 extern Lisp_Object Vminibuffer_list
;
230 extern Lisp_Object Qface
;
231 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
233 extern Lisp_Object Voverriding_local_map
;
234 extern Lisp_Object Voverriding_local_map_menu_flag
;
235 extern Lisp_Object Qmenu_item
;
236 extern Lisp_Object Qwhen
;
237 extern Lisp_Object Qhelp_echo
;
239 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
240 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
241 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
242 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
243 Lisp_Object Qinhibit_point_motion_hooks
;
244 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
245 Lisp_Object Qfontified
;
246 Lisp_Object Qgrow_only
;
247 Lisp_Object Qinhibit_eval_during_redisplay
;
248 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
251 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
254 Lisp_Object Qarrow
, Qhand
, Qtext
;
256 Lisp_Object Qrisky_local_variable
;
258 /* Holds the list (error). */
259 Lisp_Object list_of_error
;
261 /* Functions called to fontify regions of text. */
263 Lisp_Object Vfontification_functions
;
264 Lisp_Object Qfontification_functions
;
266 /* Non-nil means automatically select any window when the mouse
267 cursor moves into it. */
268 Lisp_Object Vmouse_autoselect_window
;
270 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
271 Lisp_Object Vline_prefix
, Qline_prefix
;
273 /* Non-zero means draw tool bar buttons raised when the mouse moves
276 int auto_raise_tool_bar_buttons_p
;
278 /* Non-zero means to reposition window if cursor line is only partially visible. */
280 int make_cursor_line_fully_visible_p
;
282 /* Margin below tool bar in pixels. 0 or nil means no margin.
283 If value is `internal-border-width' or `border-width',
284 the corresponding frame parameter is used. */
286 Lisp_Object Vtool_bar_border
;
288 /* Margin around tool bar buttons in pixels. */
290 Lisp_Object Vtool_bar_button_margin
;
292 /* Thickness of shadow to draw around tool bar buttons. */
294 EMACS_INT tool_bar_button_relief
;
296 /* Non-nil means automatically resize tool-bars so that all tool-bar
297 items are visible, and no blank lines remain.
299 If value is `grow-only', only make tool-bar bigger. */
301 Lisp_Object Vauto_resize_tool_bars
;
303 /* Non-zero means draw block and hollow cursor as wide as the glyph
304 under it. For example, if a block cursor is over a tab, it will be
305 drawn as wide as that tab on the display. */
307 int x_stretch_cursor_p
;
309 /* Non-nil means don't actually do any redisplay. */
311 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
313 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
315 int inhibit_eval_during_redisplay
;
317 /* Names of text properties relevant for redisplay. */
319 Lisp_Object Qdisplay
;
320 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
322 /* Symbols used in text property values. */
324 Lisp_Object Vdisplay_pixels_per_inch
;
325 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
326 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
329 Lisp_Object Qmargin
, Qpointer
;
330 Lisp_Object Qline_height
;
331 extern Lisp_Object Qheight
;
332 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
333 extern Lisp_Object Qscroll_bar
;
334 extern Lisp_Object Qcursor
;
336 /* Non-nil means highlight trailing whitespace. */
338 Lisp_Object Vshow_trailing_whitespace
;
340 /* Non-nil means escape non-break space and hyphens. */
342 Lisp_Object Vnobreak_char_display
;
344 #ifdef HAVE_WINDOW_SYSTEM
345 extern Lisp_Object Voverflow_newline_into_fringe
;
347 /* Test if overflow newline into fringe. Called with iterator IT
348 at or past right window margin, and with IT->current_x set. */
350 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
351 (!NILP (Voverflow_newline_into_fringe) \
352 && FRAME_WINDOW_P (it->f) \
353 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
354 && it->current_x == it->last_visible_x \
355 && it->line_wrap != WORD_WRAP)
357 #endif /* HAVE_WINDOW_SYSTEM */
359 /* Test if the display element loaded in IT is a space or tab
360 character. This is used to determine word wrapping. */
362 #define IT_DISPLAYING_WHITESPACE(it) \
363 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
365 /* Non-nil means show the text cursor in void text areas
366 i.e. in blank areas after eol and eob. This used to be
367 the default in 21.3. */
369 Lisp_Object Vvoid_text_area_pointer
;
371 /* Name of the face used to highlight trailing whitespace. */
373 Lisp_Object Qtrailing_whitespace
;
375 /* Name and number of the face used to highlight escape glyphs. */
377 Lisp_Object Qescape_glyph
;
379 /* Name and number of the face used to highlight non-breaking spaces. */
381 Lisp_Object Qnobreak_space
;
383 /* The symbol `image' which is the car of the lists used to represent
388 /* The image map types. */
389 Lisp_Object QCmap
, QCpointer
;
390 Lisp_Object Qrect
, Qcircle
, Qpoly
;
392 /* Non-zero means print newline to stdout before next mini-buffer
395 int noninteractive_need_newline
;
397 /* Non-zero means print newline to message log before next message. */
399 static int message_log_need_newline
;
401 /* Three markers that message_dolog uses.
402 It could allocate them itself, but that causes trouble
403 in handling memory-full errors. */
404 static Lisp_Object message_dolog_marker1
;
405 static Lisp_Object message_dolog_marker2
;
406 static Lisp_Object message_dolog_marker3
;
408 /* The buffer position of the first character appearing entirely or
409 partially on the line of the selected window which contains the
410 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
411 redisplay optimization in redisplay_internal. */
413 static struct text_pos this_line_start_pos
;
415 /* Number of characters past the end of the line above, including the
416 terminating newline. */
418 static struct text_pos this_line_end_pos
;
420 /* The vertical positions and the height of this line. */
422 static int this_line_vpos
;
423 static int this_line_y
;
424 static int this_line_pixel_height
;
426 /* X position at which this display line starts. Usually zero;
427 negative if first character is partially visible. */
429 static int this_line_start_x
;
431 /* Buffer that this_line_.* variables are referring to. */
433 static struct buffer
*this_line_buffer
;
435 /* Nonzero means truncate lines in all windows less wide than the
438 Lisp_Object Vtruncate_partial_width_windows
;
440 /* A flag to control how to display unibyte 8-bit character. */
442 int unibyte_display_via_language_environment
;
444 /* Nonzero means we have more than one non-mini-buffer-only frame.
445 Not guaranteed to be accurate except while parsing
446 frame-title-format. */
450 Lisp_Object Vglobal_mode_string
;
453 /* List of variables (symbols) which hold markers for overlay arrows.
454 The symbols on this list are examined during redisplay to determine
455 where to display overlay arrows. */
457 Lisp_Object Voverlay_arrow_variable_list
;
459 /* Marker for where to display an arrow on top of the buffer text. */
461 Lisp_Object Voverlay_arrow_position
;
463 /* String to display for the arrow. Only used on terminal frames. */
465 Lisp_Object Voverlay_arrow_string
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 /* Like mode-line-format, but for the title bar on a visible frame. */
481 Lisp_Object Vframe_title_format
;
483 /* Like mode-line-format, but for the title bar on an iconified frame. */
485 Lisp_Object Vicon_title_format
;
487 /* List of functions to call when a window's size changes. These
488 functions get one arg, a frame on which one or more windows' sizes
491 static Lisp_Object Vwindow_size_change_functions
;
493 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
495 /* Nonzero if an overlay arrow has been displayed in this window. */
497 static int overlay_arrow_seen
;
499 /* Nonzero means highlight the region even in nonselected windows. */
501 int highlight_nonselected_windows
;
503 /* If cursor motion alone moves point off frame, try scrolling this
504 many lines up or down if that will bring it back. */
506 static EMACS_INT scroll_step
;
508 /* Nonzero means scroll just far enough to bring point back on the
509 screen, when appropriate. */
511 static EMACS_INT scroll_conservatively
;
513 /* Recenter the window whenever point gets within this many lines of
514 the top or bottom of the window. This value is translated into a
515 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
516 that there is really a fixed pixel height scroll margin. */
518 EMACS_INT scroll_margin
;
520 /* Number of windows showing the buffer of the selected window (or
521 another buffer with the same base buffer). keyboard.c refers to
526 /* Vector containing glyphs for an ellipsis `...'. */
528 static Lisp_Object default_invis_vector
[3];
530 /* Zero means display the mode-line/header-line/menu-bar in the default face
531 (this slightly odd definition is for compatibility with previous versions
532 of emacs), non-zero means display them using their respective faces.
534 This variable is deprecated. */
536 int mode_line_inverse_video
;
538 /* Prompt to display in front of the mini-buffer contents. */
540 Lisp_Object minibuf_prompt
;
542 /* Width of current mini-buffer prompt. Only set after display_line
543 of the line that contains the prompt. */
545 int minibuf_prompt_width
;
547 /* This is the window where the echo area message was displayed. It
548 is always a mini-buffer window, but it may not be the same window
549 currently active as a mini-buffer. */
551 Lisp_Object echo_area_window
;
553 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
554 pushes the current message and the value of
555 message_enable_multibyte on the stack, the function restore_message
556 pops the stack and displays MESSAGE again. */
558 Lisp_Object Vmessage_stack
;
560 /* Nonzero means multibyte characters were enabled when the echo area
561 message was specified. */
563 int message_enable_multibyte
;
565 /* Nonzero if we should redraw the mode lines on the next redisplay. */
567 int update_mode_lines
;
569 /* Nonzero if window sizes or contents have changed since last
570 redisplay that finished. */
572 int windows_or_buffers_changed
;
574 /* Nonzero means a frame's cursor type has been changed. */
576 int cursor_type_changed
;
578 /* Nonzero after display_mode_line if %l was used and it displayed a
581 int line_number_displayed
;
583 /* Maximum buffer size for which to display line numbers. */
585 Lisp_Object Vline_number_display_limit
;
587 /* Line width to consider when repositioning for line number display. */
589 static EMACS_INT line_number_display_limit_width
;
591 /* Number of lines to keep in the message log buffer. t means
592 infinite. nil means don't log at all. */
594 Lisp_Object Vmessage_log_max
;
596 /* The name of the *Messages* buffer, a string. */
598 static Lisp_Object Vmessages_buffer_name
;
600 /* Current, index 0, and last displayed echo area message. Either
601 buffers from echo_buffers, or nil to indicate no message. */
603 Lisp_Object echo_area_buffer
[2];
605 /* The buffers referenced from echo_area_buffer. */
607 static Lisp_Object echo_buffer
[2];
609 /* A vector saved used in with_area_buffer to reduce consing. */
611 static Lisp_Object Vwith_echo_area_save_vector
;
613 /* Non-zero means display_echo_area should display the last echo area
614 message again. Set by redisplay_preserve_echo_area. */
616 static int display_last_displayed_message_p
;
618 /* Nonzero if echo area is being used by print; zero if being used by
621 int message_buf_print
;
623 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
625 Lisp_Object Qinhibit_menubar_update
;
626 int inhibit_menubar_update
;
628 /* When evaluating expressions from menu bar items (enable conditions,
629 for instance), this is the frame they are being processed for. */
631 Lisp_Object Vmenu_updating_frame
;
633 /* Maximum height for resizing mini-windows. Either a float
634 specifying a fraction of the available height, or an integer
635 specifying a number of lines. */
637 Lisp_Object Vmax_mini_window_height
;
639 /* Non-zero means messages should be displayed with truncated
640 lines instead of being continued. */
642 int message_truncate_lines
;
643 Lisp_Object Qmessage_truncate_lines
;
645 /* Set to 1 in clear_message to make redisplay_internal aware
646 of an emptied echo area. */
648 static int message_cleared_p
;
650 /* How to blink the default frame cursor off. */
651 Lisp_Object Vblink_cursor_alist
;
653 /* A scratch glyph row with contents used for generating truncation
654 glyphs. Also used in direct_output_for_insert. */
656 #define MAX_SCRATCH_GLYPHS 100
657 struct glyph_row scratch_glyph_row
;
658 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
660 /* Ascent and height of the last line processed by move_it_to. */
662 static int last_max_ascent
, last_height
;
664 /* Non-zero if there's a help-echo in the echo area. */
666 int help_echo_showing_p
;
668 /* If >= 0, computed, exact values of mode-line and header-line height
669 to use in the macros CURRENT_MODE_LINE_HEIGHT and
670 CURRENT_HEADER_LINE_HEIGHT. */
672 int current_mode_line_height
, current_header_line_height
;
674 /* The maximum distance to look ahead for text properties. Values
675 that are too small let us call compute_char_face and similar
676 functions too often which is expensive. Values that are too large
677 let us call compute_char_face and alike too often because we
678 might not be interested in text properties that far away. */
680 #define TEXT_PROP_DISTANCE_LIMIT 100
684 /* Variables to turn off display optimizations from Lisp. */
686 int inhibit_try_window_id
, inhibit_try_window_reusing
;
687 int inhibit_try_cursor_movement
;
689 /* Non-zero means print traces of redisplay if compiled with
692 int trace_redisplay_p
;
694 #endif /* GLYPH_DEBUG */
696 #ifdef DEBUG_TRACE_MOVE
697 /* Non-zero means trace with TRACE_MOVE to stderr. */
700 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
702 #define TRACE_MOVE(x) (void) 0
705 /* Non-zero means automatically scroll windows horizontally to make
708 int automatic_hscrolling_p
;
709 Lisp_Object Qauto_hscroll_mode
;
711 /* How close to the margin can point get before the window is scrolled
713 EMACS_INT hscroll_margin
;
715 /* How much to scroll horizontally when point is inside the above margin. */
716 Lisp_Object Vhscroll_step
;
718 /* The variable `resize-mini-windows'. If nil, don't resize
719 mini-windows. If t, always resize them to fit the text they
720 display. If `grow-only', let mini-windows grow only until they
723 Lisp_Object Vresize_mini_windows
;
725 /* Buffer being redisplayed -- for redisplay_window_error. */
727 struct buffer
*displayed_buffer
;
729 /* Space between overline and text. */
731 EMACS_INT overline_margin
;
733 /* Require underline to be at least this many screen pixels below baseline
734 This to avoid underline "merging" with the base of letters at small
735 font sizes, particularly when x_use_underline_position_properties is on. */
737 EMACS_INT underline_minimum_offset
;
739 /* Value returned from text property handlers (see below). */
744 HANDLED_RECOMPUTE_PROPS
,
745 HANDLED_OVERLAY_STRING_CONSUMED
,
749 /* A description of text properties that redisplay is interested
754 /* The name of the property. */
757 /* A unique index for the property. */
760 /* A handler function called to set up iterator IT from the property
761 at IT's current position. Value is used to steer handle_stop. */
762 enum prop_handled (*handler
) P_ ((struct it
*it
));
765 static enum prop_handled handle_face_prop
P_ ((struct it
*));
766 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
767 static enum prop_handled handle_display_prop
P_ ((struct it
*));
768 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
769 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
770 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
772 /* Properties handled by iterators. */
774 static struct props it_props
[] =
776 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
777 /* Handle `face' before `display' because some sub-properties of
778 `display' need to know the face. */
779 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
780 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
781 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
782 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
786 /* Value is the position described by X. If X is a marker, value is
787 the marker_position of X. Otherwise, value is X. */
789 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
791 /* Enumeration returned by some move_it_.* functions internally. */
795 /* Not used. Undefined value. */
798 /* Move ended at the requested buffer position or ZV. */
799 MOVE_POS_MATCH_OR_ZV
,
801 /* Move ended at the requested X pixel position. */
804 /* Move within a line ended at the end of a line that must be
808 /* Move within a line ended at the end of a line that would
809 be displayed truncated. */
812 /* Move within a line ended at a line end. */
816 /* This counter is used to clear the face cache every once in a while
817 in redisplay_internal. It is incremented for each redisplay.
818 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
821 #define CLEAR_FACE_CACHE_COUNT 500
822 static int clear_face_cache_count
;
824 /* Similarly for the image cache. */
826 #ifdef HAVE_WINDOW_SYSTEM
827 #define CLEAR_IMAGE_CACHE_COUNT 101
828 static int clear_image_cache_count
;
831 /* Non-zero while redisplay_internal is in progress. */
835 /* Non-zero means don't free realized faces. Bound while freeing
836 realized faces is dangerous because glyph matrices might still
839 int inhibit_free_realized_faces
;
840 Lisp_Object Qinhibit_free_realized_faces
;
842 /* If a string, XTread_socket generates an event to display that string.
843 (The display is done in read_char.) */
845 Lisp_Object help_echo_string
;
846 Lisp_Object help_echo_window
;
847 Lisp_Object help_echo_object
;
850 /* Temporary variable for XTread_socket. */
852 Lisp_Object previous_help_echo_string
;
854 /* Null glyph slice */
856 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
858 /* Platform-independent portion of hourglass implementation. */
860 /* Non-zero means we're allowed to display a hourglass pointer. */
861 int display_hourglass_p
;
863 /* Non-zero means an hourglass cursor is currently shown. */
864 int hourglass_shown_p
;
866 /* If non-null, an asynchronous timer that, when it expires, displays
867 an hourglass cursor on all frames. */
868 struct atimer
*hourglass_atimer
;
870 /* Number of seconds to wait before displaying an hourglass cursor. */
871 Lisp_Object Vhourglass_delay
;
873 /* Default number of seconds to wait before displaying an hourglass
875 #define DEFAULT_HOURGLASS_DELAY 1
878 /* Function prototypes. */
880 static void setup_for_ellipsis
P_ ((struct it
*, int));
881 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
882 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
883 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
884 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
885 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
886 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
888 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
890 static void handle_line_prefix
P_ ((struct it
*));
892 static void pint2str
P_ ((char *, int, int));
893 static void pint2hrstr
P_ ((char *, int, int));
894 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
896 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
897 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
898 static void store_mode_line_noprop_char
P_ ((char));
899 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
900 static void x_consider_frame_title
P_ ((Lisp_Object
));
901 static void handle_stop
P_ ((struct it
*));
902 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
903 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
904 static void ensure_echo_area_buffers
P_ ((void));
905 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
906 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
907 static int with_echo_area_buffer
P_ ((struct window
*, int,
908 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
909 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
910 static void clear_garbaged_frames
P_ ((void));
911 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
912 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
913 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
914 static int display_echo_area
P_ ((struct window
*));
915 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
916 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
917 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
918 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
919 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
921 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
922 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
923 static void insert_left_trunc_glyphs
P_ ((struct it
*));
924 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
926 static void extend_face_to_end_of_line
P_ ((struct it
*));
927 static int append_space_for_newline
P_ ((struct it
*, int));
928 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
929 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
930 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
931 static int trailing_whitespace_p
P_ ((int));
932 static int message_log_check_duplicate
P_ ((int, int, int, int));
933 static void push_it
P_ ((struct it
*));
934 static void pop_it
P_ ((struct it
*));
935 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
936 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
937 static void redisplay_internal
P_ ((int));
938 static int echo_area_display
P_ ((int));
939 static void redisplay_windows
P_ ((Lisp_Object
));
940 static void redisplay_window
P_ ((Lisp_Object
, int));
941 static Lisp_Object
redisplay_window_error ();
942 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
943 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
944 static int update_menu_bar
P_ ((struct frame
*, int, int));
945 static int try_window_reusing_current_matrix
P_ ((struct window
*));
946 static int try_window_id
P_ ((struct window
*));
947 static int display_line
P_ ((struct it
*));
948 static int display_mode_lines
P_ ((struct window
*));
949 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
950 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
951 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
952 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
953 static void display_menu_bar
P_ ((struct window
*));
954 static int display_count_lines
P_ ((int, int, int, int, int *));
955 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
956 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
957 static void compute_line_metrics
P_ ((struct it
*));
958 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
959 static int get_overlay_strings
P_ ((struct it
*, int));
960 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
961 static void next_overlay_string
P_ ((struct it
*));
962 static void reseat
P_ ((struct it
*, struct text_pos
, int));
963 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
964 static void back_to_previous_visible_line_start
P_ ((struct it
*));
965 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
966 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
967 static int next_element_from_ellipsis
P_ ((struct it
*));
968 static int next_element_from_display_vector
P_ ((struct it
*));
969 static int next_element_from_string
P_ ((struct it
*));
970 static int next_element_from_c_string
P_ ((struct it
*));
971 static int next_element_from_buffer
P_ ((struct it
*));
972 static int next_element_from_composition
P_ ((struct it
*));
973 static int next_element_from_image
P_ ((struct it
*));
974 static int next_element_from_stretch
P_ ((struct it
*));
975 static void load_overlay_strings
P_ ((struct it
*, int));
976 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
977 struct display_pos
*));
978 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
979 Lisp_Object
, int, int, int, int));
980 static enum move_it_result
981 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
982 enum move_operation_enum
);
983 void move_it_vertically_backward
P_ ((struct it
*, int));
984 static void init_to_row_start
P_ ((struct it
*, struct window
*,
985 struct glyph_row
*));
986 static int init_to_row_end
P_ ((struct it
*, struct window
*,
987 struct glyph_row
*));
988 static void back_to_previous_line_start
P_ ((struct it
*));
989 static int forward_to_next_line_start
P_ ((struct it
*, int *));
990 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
992 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
993 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
994 static int number_of_chars
P_ ((unsigned char *, int));
995 static void compute_stop_pos
P_ ((struct it
*));
996 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
998 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
999 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
1000 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
1001 Lisp_Object
, Lisp_Object
,
1002 struct text_pos
*, int));
1003 static int underlying_face_id
P_ ((struct it
*));
1004 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
1007 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1008 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1010 #ifdef HAVE_WINDOW_SYSTEM
1012 static void update_tool_bar
P_ ((struct frame
*, int));
1013 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
1014 static int redisplay_tool_bar
P_ ((struct frame
*));
1015 static void display_tool_bar_line
P_ ((struct it
*, int));
1016 static void notice_overwritten_cursor
P_ ((struct window
*,
1017 enum glyph_row_area
,
1018 int, int, int, int));
1022 #endif /* HAVE_WINDOW_SYSTEM */
1025 /***********************************************************************
1026 Window display dimensions
1027 ***********************************************************************/
1029 /* Return the bottom boundary y-position for text lines in window W.
1030 This is the first y position at which a line cannot start.
1031 It is relative to the top of the window.
1033 This is the height of W minus the height of a mode line, if any. */
1036 window_text_bottom_y (w
)
1039 int height
= WINDOW_TOTAL_HEIGHT (w
);
1041 if (WINDOW_WANTS_MODELINE_P (w
))
1042 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1046 /* Return the pixel width of display area AREA of window W. AREA < 0
1047 means return the total width of W, not including fringes to
1048 the left and right of the window. */
1051 window_box_width (w
, area
)
1055 int cols
= XFASTINT (w
->total_cols
);
1058 if (!w
->pseudo_window_p
)
1060 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1062 if (area
== TEXT_AREA
)
1064 if (INTEGERP (w
->left_margin_cols
))
1065 cols
-= XFASTINT (w
->left_margin_cols
);
1066 if (INTEGERP (w
->right_margin_cols
))
1067 cols
-= XFASTINT (w
->right_margin_cols
);
1068 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1070 else if (area
== LEFT_MARGIN_AREA
)
1072 cols
= (INTEGERP (w
->left_margin_cols
)
1073 ? XFASTINT (w
->left_margin_cols
) : 0);
1076 else if (area
== RIGHT_MARGIN_AREA
)
1078 cols
= (INTEGERP (w
->right_margin_cols
)
1079 ? XFASTINT (w
->right_margin_cols
) : 0);
1084 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1088 /* Return the pixel height of the display area of window W, not
1089 including mode lines of W, if any. */
1092 window_box_height (w
)
1095 struct frame
*f
= XFRAME (w
->frame
);
1096 int height
= WINDOW_TOTAL_HEIGHT (w
);
1098 xassert (height
>= 0);
1100 /* Note: the code below that determines the mode-line/header-line
1101 height is essentially the same as that contained in the macro
1102 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1103 the appropriate glyph row has its `mode_line_p' flag set,
1104 and if it doesn't, uses estimate_mode_line_height instead. */
1106 if (WINDOW_WANTS_MODELINE_P (w
))
1108 struct glyph_row
*ml_row
1109 = (w
->current_matrix
&& w
->current_matrix
->rows
1110 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1112 if (ml_row
&& ml_row
->mode_line_p
)
1113 height
-= ml_row
->height
;
1115 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1118 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1120 struct glyph_row
*hl_row
1121 = (w
->current_matrix
&& w
->current_matrix
->rows
1122 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1124 if (hl_row
&& hl_row
->mode_line_p
)
1125 height
-= hl_row
->height
;
1127 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1130 /* With a very small font and a mode-line that's taller than
1131 default, we might end up with a negative height. */
1132 return max (0, height
);
1135 /* Return the window-relative coordinate of the left edge of display
1136 area AREA of window W. AREA < 0 means return the left edge of the
1137 whole window, to the right of the left fringe of W. */
1140 window_box_left_offset (w
, area
)
1146 if (w
->pseudo_window_p
)
1149 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1151 if (area
== TEXT_AREA
)
1152 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1153 + window_box_width (w
, LEFT_MARGIN_AREA
));
1154 else if (area
== RIGHT_MARGIN_AREA
)
1155 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1156 + window_box_width (w
, LEFT_MARGIN_AREA
)
1157 + window_box_width (w
, TEXT_AREA
)
1158 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1160 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1161 else if (area
== LEFT_MARGIN_AREA
1162 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1163 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1169 /* Return the window-relative coordinate of the right edge of display
1170 area AREA of window W. AREA < 0 means return the left edge of the
1171 whole window, to the left of the right fringe of W. */
1174 window_box_right_offset (w
, area
)
1178 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1181 /* Return the frame-relative coordinate of the left edge of display
1182 area AREA of window W. AREA < 0 means return the left edge of the
1183 whole window, to the right of the left fringe of W. */
1186 window_box_left (w
, area
)
1190 struct frame
*f
= XFRAME (w
->frame
);
1193 if (w
->pseudo_window_p
)
1194 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1196 x
= (WINDOW_LEFT_EDGE_X (w
)
1197 + window_box_left_offset (w
, area
));
1203 /* Return the frame-relative coordinate of the right edge of display
1204 area AREA of window W. AREA < 0 means return the left edge of the
1205 whole window, to the left of the right fringe of W. */
1208 window_box_right (w
, area
)
1212 return window_box_left (w
, area
) + window_box_width (w
, area
);
1215 /* Get the bounding box of the display area AREA of window W, without
1216 mode lines, in frame-relative coordinates. AREA < 0 means the
1217 whole window, not including the left and right fringes of
1218 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1219 coordinates of the upper-left corner of the box. Return in
1220 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1223 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1226 int *box_x
, *box_y
, *box_width
, *box_height
;
1229 *box_width
= window_box_width (w
, area
);
1231 *box_height
= window_box_height (w
);
1233 *box_x
= window_box_left (w
, area
);
1236 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1237 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1238 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1243 /* Get the bounding box of the display area AREA of window W, without
1244 mode lines. AREA < 0 means the whole window, not including the
1245 left and right fringe of the window. Return in *TOP_LEFT_X
1246 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1247 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1248 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1252 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1253 bottom_right_x
, bottom_right_y
)
1256 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1258 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1260 *bottom_right_x
+= *top_left_x
;
1261 *bottom_right_y
+= *top_left_y
;
1266 /***********************************************************************
1268 ***********************************************************************/
1270 /* Return the bottom y-position of the line the iterator IT is in.
1271 This can modify IT's settings. */
1277 int line_height
= it
->max_ascent
+ it
->max_descent
;
1278 int line_top_y
= it
->current_y
;
1280 if (line_height
== 0)
1283 line_height
= last_height
;
1284 else if (IT_CHARPOS (*it
) < ZV
)
1286 move_it_by_lines (it
, 1, 1);
1287 line_height
= (it
->max_ascent
|| it
->max_descent
1288 ? it
->max_ascent
+ it
->max_descent
1293 struct glyph_row
*row
= it
->glyph_row
;
1295 /* Use the default character height. */
1296 it
->glyph_row
= NULL
;
1297 it
->what
= IT_CHARACTER
;
1300 PRODUCE_GLYPHS (it
);
1301 line_height
= it
->ascent
+ it
->descent
;
1302 it
->glyph_row
= row
;
1306 return line_top_y
+ line_height
;
1310 /* Return 1 if position CHARPOS is visible in window W.
1311 CHARPOS < 0 means return info about WINDOW_END position.
1312 If visible, set *X and *Y to pixel coordinates of top left corner.
1313 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1314 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1317 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1319 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1322 struct text_pos top
;
1324 struct buffer
*old_buffer
= NULL
;
1329 if (XBUFFER (w
->buffer
) != current_buffer
)
1331 old_buffer
= current_buffer
;
1332 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1335 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1337 /* Compute exact mode line heights. */
1338 if (WINDOW_WANTS_MODELINE_P (w
))
1339 current_mode_line_height
1340 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1341 current_buffer
->mode_line_format
);
1343 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1344 current_header_line_height
1345 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1346 current_buffer
->header_line_format
);
1348 start_display (&it
, w
, top
);
1349 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1350 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1352 /* Note that we may overshoot because of invisible text. */
1353 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1355 int top_x
= it
.current_x
;
1356 int top_y
= it
.current_y
;
1357 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1358 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1360 if (top_y
< window_top_y
)
1361 visible_p
= bottom_y
> window_top_y
;
1362 else if (top_y
< it
.last_visible_y
)
1366 if (it
.method
== GET_FROM_BUFFER
)
1368 Lisp_Object window
, prop
;
1370 XSETWINDOW (window
, w
);
1371 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1372 Qinvisible
, window
);
1374 /* If charpos coincides with invisible text covered with an
1375 ellipsis, use the first glyph of the ellipsis to compute
1376 the pixel positions. */
1377 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1379 struct glyph_row
*row
= it
.glyph_row
;
1380 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1381 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1384 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1385 x
+= glyph
->pixel_width
;
1392 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1393 *rtop
= max (0, window_top_y
- top_y
);
1394 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1395 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1396 - max (top_y
, window_top_y
)));
1405 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1406 move_it_by_lines (&it
, 1, 0);
1407 if (charpos
< IT_CHARPOS (it
)
1408 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1411 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1413 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1414 *rtop
= max (0, -it2
.current_y
);
1415 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1416 - it
.last_visible_y
));
1417 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1419 - max (it2
.current_y
,
1420 WINDOW_HEADER_LINE_HEIGHT (w
))));
1426 set_buffer_internal_1 (old_buffer
);
1428 current_header_line_height
= current_mode_line_height
= -1;
1430 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1431 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1434 /* Debugging code. */
1436 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1437 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1439 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1446 /* Return the next character from STR which is MAXLEN bytes long.
1447 Return in *LEN the length of the character. This is like
1448 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1449 we find one, we return a `?', but with the length of the invalid
1453 string_char_and_length (str
, maxlen
, len
)
1454 const unsigned char *str
;
1459 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1460 if (!CHAR_VALID_P (c
, 1))
1461 /* We may not change the length here because other places in Emacs
1462 don't use this function, i.e. they silently accept invalid
1471 /* Given a position POS containing a valid character and byte position
1472 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1474 static struct text_pos
1475 string_pos_nchars_ahead (pos
, string
, nchars
)
1476 struct text_pos pos
;
1480 xassert (STRINGP (string
) && nchars
>= 0);
1482 if (STRING_MULTIBYTE (string
))
1484 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1485 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1490 string_char_and_length (p
, rest
, &len
);
1491 p
+= len
, rest
-= len
;
1492 xassert (rest
>= 0);
1494 BYTEPOS (pos
) += len
;
1498 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1504 /* Value is the text position, i.e. character and byte position,
1505 for character position CHARPOS in STRING. */
1507 static INLINE
struct text_pos
1508 string_pos (charpos
, string
)
1512 struct text_pos pos
;
1513 xassert (STRINGP (string
));
1514 xassert (charpos
>= 0);
1515 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1520 /* Value is a text position, i.e. character and byte position, for
1521 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1522 means recognize multibyte characters. */
1524 static struct text_pos
1525 c_string_pos (charpos
, s
, multibyte_p
)
1530 struct text_pos pos
;
1532 xassert (s
!= NULL
);
1533 xassert (charpos
>= 0);
1537 int rest
= strlen (s
), len
;
1539 SET_TEXT_POS (pos
, 0, 0);
1542 string_char_and_length (s
, rest
, &len
);
1543 s
+= len
, rest
-= len
;
1544 xassert (rest
>= 0);
1546 BYTEPOS (pos
) += len
;
1550 SET_TEXT_POS (pos
, charpos
, charpos
);
1556 /* Value is the number of characters in C string S. MULTIBYTE_P
1557 non-zero means recognize multibyte characters. */
1560 number_of_chars (s
, multibyte_p
)
1568 int rest
= strlen (s
), len
;
1569 unsigned char *p
= (unsigned char *) s
;
1571 for (nchars
= 0; rest
> 0; ++nchars
)
1573 string_char_and_length (p
, rest
, &len
);
1574 rest
-= len
, p
+= len
;
1578 nchars
= strlen (s
);
1584 /* Compute byte position NEWPOS->bytepos corresponding to
1585 NEWPOS->charpos. POS is a known position in string STRING.
1586 NEWPOS->charpos must be >= POS.charpos. */
1589 compute_string_pos (newpos
, pos
, string
)
1590 struct text_pos
*newpos
, pos
;
1593 xassert (STRINGP (string
));
1594 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1596 if (STRING_MULTIBYTE (string
))
1597 *newpos
= string_pos_nchars_ahead (pos
, string
,
1598 CHARPOS (*newpos
) - CHARPOS (pos
));
1600 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1604 Return an estimation of the pixel height of mode or top lines on
1605 frame F. FACE_ID specifies what line's height to estimate. */
1608 estimate_mode_line_height (f
, face_id
)
1610 enum face_id face_id
;
1612 #ifdef HAVE_WINDOW_SYSTEM
1613 if (FRAME_WINDOW_P (f
))
1615 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1617 /* This function is called so early when Emacs starts that the face
1618 cache and mode line face are not yet initialized. */
1619 if (FRAME_FACE_CACHE (f
))
1621 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1625 height
= FONT_HEIGHT (face
->font
);
1626 if (face
->box_line_width
> 0)
1627 height
+= 2 * face
->box_line_width
;
1638 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1639 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1640 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1641 not force the value into range. */
1644 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1646 register int pix_x
, pix_y
;
1648 NativeRectangle
*bounds
;
1652 #ifdef HAVE_WINDOW_SYSTEM
1653 if (FRAME_WINDOW_P (f
))
1655 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1656 even for negative values. */
1658 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1660 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1662 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1663 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1666 STORE_NATIVE_RECT (*bounds
,
1667 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1668 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1669 FRAME_COLUMN_WIDTH (f
) - 1,
1670 FRAME_LINE_HEIGHT (f
) - 1);
1676 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1677 pix_x
= FRAME_TOTAL_COLS (f
);
1681 else if (pix_y
> FRAME_LINES (f
))
1682 pix_y
= FRAME_LINES (f
);
1692 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1693 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1694 can't tell the positions because W's display is not up to date,
1698 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1701 int *frame_x
, *frame_y
;
1703 #ifdef HAVE_WINDOW_SYSTEM
1704 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1708 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1709 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1711 if (display_completed
)
1713 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1714 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1715 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1721 hpos
+= glyph
->pixel_width
;
1725 /* If first glyph is partially visible, its first visible position is still 0. */
1737 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1738 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1749 #ifdef HAVE_WINDOW_SYSTEM
1751 /* Find the glyph under window-relative coordinates X/Y in window W.
1752 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1753 strings. Return in *HPOS and *VPOS the row and column number of
1754 the glyph found. Return in *AREA the glyph area containing X.
1755 Value is a pointer to the glyph found or null if X/Y is not on
1756 text, or we can't tell because W's current matrix is not up to
1761 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1764 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1766 struct glyph
*glyph
, *end
;
1767 struct glyph_row
*row
= NULL
;
1770 /* Find row containing Y. Give up if some row is not enabled. */
1771 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1773 row
= MATRIX_ROW (w
->current_matrix
, i
);
1774 if (!row
->enabled_p
)
1776 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1783 /* Give up if Y is not in the window. */
1784 if (i
== w
->current_matrix
->nrows
)
1787 /* Get the glyph area containing X. */
1788 if (w
->pseudo_window_p
)
1795 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1797 *area
= LEFT_MARGIN_AREA
;
1798 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1800 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1803 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1807 *area
= RIGHT_MARGIN_AREA
;
1808 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1812 /* Find glyph containing X. */
1813 glyph
= row
->glyphs
[*area
];
1814 end
= glyph
+ row
->used
[*area
];
1816 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1818 x
-= glyph
->pixel_width
;
1828 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1831 *hpos
= glyph
- row
->glyphs
[*area
];
1837 Convert frame-relative x/y to coordinates relative to window W.
1838 Takes pseudo-windows into account. */
1841 frame_to_window_pixel_xy (w
, x
, y
)
1845 if (w
->pseudo_window_p
)
1847 /* A pseudo-window is always full-width, and starts at the
1848 left edge of the frame, plus a frame border. */
1849 struct frame
*f
= XFRAME (w
->frame
);
1850 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1851 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1855 *x
-= WINDOW_LEFT_EDGE_X (w
);
1856 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1861 Return in RECTS[] at most N clipping rectangles for glyph string S.
1862 Return the number of stored rectangles. */
1865 get_glyph_string_clip_rects (s
, rects
, n
)
1866 struct glyph_string
*s
;
1867 NativeRectangle
*rects
;
1875 if (s
->row
->full_width_p
)
1877 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1878 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1879 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1881 /* Unless displaying a mode or menu bar line, which are always
1882 fully visible, clip to the visible part of the row. */
1883 if (s
->w
->pseudo_window_p
)
1884 r
.height
= s
->row
->visible_height
;
1886 r
.height
= s
->height
;
1890 /* This is a text line that may be partially visible. */
1891 r
.x
= window_box_left (s
->w
, s
->area
);
1892 r
.width
= window_box_width (s
->w
, s
->area
);
1893 r
.height
= s
->row
->visible_height
;
1897 if (r
.x
< s
->clip_head
->x
)
1899 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1900 r
.width
-= s
->clip_head
->x
- r
.x
;
1903 r
.x
= s
->clip_head
->x
;
1906 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1908 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1909 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1914 /* If S draws overlapping rows, it's sufficient to use the top and
1915 bottom of the window for clipping because this glyph string
1916 intentionally draws over other lines. */
1917 if (s
->for_overlaps
)
1919 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1920 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1922 /* Alas, the above simple strategy does not work for the
1923 environments with anti-aliased text: if the same text is
1924 drawn onto the same place multiple times, it gets thicker.
1925 If the overlap we are processing is for the erased cursor, we
1926 take the intersection with the rectagle of the cursor. */
1927 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1929 XRectangle rc
, r_save
= r
;
1931 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1932 rc
.y
= s
->w
->phys_cursor
.y
;
1933 rc
.width
= s
->w
->phys_cursor_width
;
1934 rc
.height
= s
->w
->phys_cursor_height
;
1936 x_intersect_rectangles (&r_save
, &rc
, &r
);
1941 /* Don't use S->y for clipping because it doesn't take partially
1942 visible lines into account. For example, it can be negative for
1943 partially visible lines at the top of a window. */
1944 if (!s
->row
->full_width_p
1945 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1946 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1948 r
.y
= max (0, s
->row
->y
);
1950 /* If drawing a tool-bar window, draw it over the internal border
1951 at the top of the window. */
1952 if (WINDOWP (s
->f
->tool_bar_window
)
1953 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1954 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1957 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1959 /* If drawing the cursor, don't let glyph draw outside its
1960 advertised boundaries. Cleartype does this under some circumstances. */
1961 if (s
->hl
== DRAW_CURSOR
)
1963 struct glyph
*glyph
= s
->first_glyph
;
1968 r
.width
-= s
->x
- r
.x
;
1971 r
.width
= min (r
.width
, glyph
->pixel_width
);
1973 /* If r.y is below window bottom, ensure that we still see a cursor. */
1974 height
= min (glyph
->ascent
+ glyph
->descent
,
1975 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1976 max_y
= window_text_bottom_y (s
->w
) - height
;
1977 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1978 if (s
->ybase
- glyph
->ascent
> max_y
)
1985 /* Don't draw cursor glyph taller than our actual glyph. */
1986 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1987 if (height
< r
.height
)
1989 max_y
= r
.y
+ r
.height
;
1990 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1991 r
.height
= min (max_y
- r
.y
, height
);
1998 XRectangle r_save
= r
;
2000 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2004 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2005 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2007 #ifdef CONVERT_FROM_XRECT
2008 CONVERT_FROM_XRECT (r
, *rects
);
2016 /* If we are processing overlapping and allowed to return
2017 multiple clipping rectangles, we exclude the row of the glyph
2018 string from the clipping rectangle. This is to avoid drawing
2019 the same text on the environment with anti-aliasing. */
2020 #ifdef CONVERT_FROM_XRECT
2023 XRectangle
*rs
= rects
;
2025 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2027 if (s
->for_overlaps
& OVERLAPS_PRED
)
2030 if (r
.y
+ r
.height
> row_y
)
2033 rs
[i
].height
= row_y
- r
.y
;
2039 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2042 if (r
.y
< row_y
+ s
->row
->visible_height
)
2044 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2046 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2047 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2056 #ifdef CONVERT_FROM_XRECT
2057 for (i
= 0; i
< n
; i
++)
2058 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2065 Return in *NR the clipping rectangle for glyph string S. */
2068 get_glyph_string_clip_rect (s
, nr
)
2069 struct glyph_string
*s
;
2070 NativeRectangle
*nr
;
2072 get_glyph_string_clip_rects (s
, nr
, 1);
2077 Return the position and height of the phys cursor in window W.
2078 Set w->phys_cursor_width to width of phys cursor.
2082 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2084 struct glyph_row
*row
;
2085 struct glyph
*glyph
;
2086 int *xp
, *yp
, *heightp
;
2088 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2089 int x
, y
, wd
, h
, h0
, y0
;
2091 /* Compute the width of the rectangle to draw. If on a stretch
2092 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2093 rectangle as wide as the glyph, but use a canonical character
2095 wd
= glyph
->pixel_width
- 1;
2096 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2100 x
= w
->phys_cursor
.x
;
2107 if (glyph
->type
== STRETCH_GLYPH
2108 && !x_stretch_cursor_p
)
2109 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2110 w
->phys_cursor_width
= wd
;
2112 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2114 /* If y is below window bottom, ensure that we still see a cursor. */
2115 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2117 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2118 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2120 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2123 h
= max (h
- (y0
- y
) + 1, h0
);
2128 y0
= window_text_bottom_y (w
) - h0
;
2136 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2137 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2142 * Remember which glyph the mouse is over.
2146 remember_mouse_glyph (f
, gx
, gy
, rect
)
2149 NativeRectangle
*rect
;
2153 struct glyph_row
*r
, *gr
, *end_row
;
2154 enum window_part part
;
2155 enum glyph_row_area area
;
2156 int x
, y
, width
, height
;
2158 /* Try to determine frame pixel position and size of the glyph under
2159 frame pixel coordinates X/Y on frame F. */
2161 if (!f
->glyphs_initialized_p
2162 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2165 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2166 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2170 w
= XWINDOW (window
);
2171 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2172 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2174 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2175 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2177 if (w
->pseudo_window_p
)
2180 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2186 case ON_LEFT_MARGIN
:
2187 area
= LEFT_MARGIN_AREA
;
2190 case ON_RIGHT_MARGIN
:
2191 area
= RIGHT_MARGIN_AREA
;
2194 case ON_HEADER_LINE
:
2196 gr
= (part
== ON_HEADER_LINE
2197 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2198 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2201 goto text_glyph_row_found
;
2208 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2209 if (r
->y
+ r
->height
> y
)
2215 text_glyph_row_found
:
2218 struct glyph
*g
= gr
->glyphs
[area
];
2219 struct glyph
*end
= g
+ gr
->used
[area
];
2221 height
= gr
->height
;
2222 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2223 if (gx
+ g
->pixel_width
> x
)
2228 if (g
->type
== IMAGE_GLYPH
)
2230 /* Don't remember when mouse is over image, as
2231 image may have hot-spots. */
2232 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2235 width
= g
->pixel_width
;
2239 /* Use nominal char spacing at end of line. */
2241 gx
+= (x
/ width
) * width
;
2244 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2245 gx
+= window_box_left_offset (w
, area
);
2249 /* Use nominal line height at end of window. */
2250 gx
= (x
/ width
) * width
;
2252 gy
+= (y
/ height
) * height
;
2256 case ON_LEFT_FRINGE
:
2257 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2258 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2259 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2260 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2263 case ON_RIGHT_FRINGE
:
2264 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2265 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2266 : window_box_right_offset (w
, TEXT_AREA
));
2267 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2271 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2273 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2274 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2275 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2277 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2281 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2282 if (r
->y
+ r
->height
> y
)
2289 height
= gr
->height
;
2292 /* Use nominal line height at end of window. */
2294 gy
+= (y
/ height
) * height
;
2301 /* If there is no glyph under the mouse, then we divide the screen
2302 into a grid of the smallest glyph in the frame, and use that
2305 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2306 round down even for negative values. */
2312 gx
= (gx
/ width
) * width
;
2313 gy
= (gy
/ height
) * height
;
2318 gx
+= WINDOW_LEFT_EDGE_X (w
);
2319 gy
+= WINDOW_TOP_EDGE_Y (w
);
2322 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2324 /* Visible feedback for debugging. */
2327 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2328 f
->output_data
.x
->normal_gc
,
2329 gx
, gy
, width
, height
);
2335 #endif /* HAVE_WINDOW_SYSTEM */
2338 /***********************************************************************
2339 Lisp form evaluation
2340 ***********************************************************************/
2342 /* Error handler for safe_eval and safe_call. */
2345 safe_eval_handler (arg
)
2348 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2353 /* Evaluate SEXPR and return the result, or nil if something went
2354 wrong. Prevent redisplay during the evaluation. */
2356 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2357 Return the result, or nil if something went wrong. Prevent
2358 redisplay during the evaluation. */
2361 safe_call (nargs
, args
)
2367 if (inhibit_eval_during_redisplay
)
2371 int count
= SPECPDL_INDEX ();
2372 struct gcpro gcpro1
;
2375 gcpro1
.nvars
= nargs
;
2376 specbind (Qinhibit_redisplay
, Qt
);
2377 /* Use Qt to ensure debugger does not run,
2378 so there is no possibility of wanting to redisplay. */
2379 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2382 val
= unbind_to (count
, val
);
2389 /* Call function FN with one argument ARG.
2390 Return the result, or nil if something went wrong. */
2393 safe_call1 (fn
, arg
)
2394 Lisp_Object fn
, arg
;
2396 Lisp_Object args
[2];
2399 return safe_call (2, args
);
2402 static Lisp_Object Qeval
;
2405 safe_eval (Lisp_Object sexpr
)
2407 return safe_call1 (Qeval
, sexpr
);
2410 /* Call function FN with one argument ARG.
2411 Return the result, or nil if something went wrong. */
2414 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2416 Lisp_Object args
[3];
2420 return safe_call (3, args
);
2425 /***********************************************************************
2427 ***********************************************************************/
2431 /* Define CHECK_IT to perform sanity checks on iterators.
2432 This is for debugging. It is too slow to do unconditionally. */
2438 if (it
->method
== GET_FROM_STRING
)
2440 xassert (STRINGP (it
->string
));
2441 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2445 xassert (IT_STRING_CHARPOS (*it
) < 0);
2446 if (it
->method
== GET_FROM_BUFFER
)
2448 /* Check that character and byte positions agree. */
2449 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2454 xassert (it
->current
.dpvec_index
>= 0);
2456 xassert (it
->current
.dpvec_index
< 0);
2459 #define CHECK_IT(IT) check_it ((IT))
2463 #define CHECK_IT(IT) (void) 0
2470 /* Check that the window end of window W is what we expect it
2471 to be---the last row in the current matrix displaying text. */
2474 check_window_end (w
)
2477 if (!MINI_WINDOW_P (w
)
2478 && !NILP (w
->window_end_valid
))
2480 struct glyph_row
*row
;
2481 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2482 XFASTINT (w
->window_end_vpos
)),
2484 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2485 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2489 #define CHECK_WINDOW_END(W) check_window_end ((W))
2491 #else /* not GLYPH_DEBUG */
2493 #define CHECK_WINDOW_END(W) (void) 0
2495 #endif /* not GLYPH_DEBUG */
2499 /***********************************************************************
2500 Iterator initialization
2501 ***********************************************************************/
2503 /* Initialize IT for displaying current_buffer in window W, starting
2504 at character position CHARPOS. CHARPOS < 0 means that no buffer
2505 position is specified which is useful when the iterator is assigned
2506 a position later. BYTEPOS is the byte position corresponding to
2507 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2509 If ROW is not null, calls to produce_glyphs with IT as parameter
2510 will produce glyphs in that row.
2512 BASE_FACE_ID is the id of a base face to use. It must be one of
2513 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2514 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2515 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2517 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2518 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2519 will be initialized to use the corresponding mode line glyph row of
2520 the desired matrix of W. */
2523 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2526 int charpos
, bytepos
;
2527 struct glyph_row
*row
;
2528 enum face_id base_face_id
;
2530 int highlight_region_p
;
2531 enum face_id remapped_base_face_id
= base_face_id
;
2533 /* Some precondition checks. */
2534 xassert (w
!= NULL
&& it
!= NULL
);
2535 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2538 /* If face attributes have been changed since the last redisplay,
2539 free realized faces now because they depend on face definitions
2540 that might have changed. Don't free faces while there might be
2541 desired matrices pending which reference these faces. */
2542 if (face_change_count
&& !inhibit_free_realized_faces
)
2544 face_change_count
= 0;
2545 free_all_realized_faces (Qnil
);
2548 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2549 if (! NILP (Vface_remapping_alist
))
2550 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2552 /* Use one of the mode line rows of W's desired matrix if
2556 if (base_face_id
== MODE_LINE_FACE_ID
2557 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2558 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2559 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2560 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2564 bzero (it
, sizeof *it
);
2565 it
->current
.overlay_string_index
= -1;
2566 it
->current
.dpvec_index
= -1;
2567 it
->base_face_id
= remapped_base_face_id
;
2569 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2571 /* The window in which we iterate over current_buffer: */
2572 XSETWINDOW (it
->window
, w
);
2574 it
->f
= XFRAME (w
->frame
);
2578 /* Extra space between lines (on window systems only). */
2579 if (base_face_id
== DEFAULT_FACE_ID
2580 && FRAME_WINDOW_P (it
->f
))
2582 if (NATNUMP (current_buffer
->extra_line_spacing
))
2583 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2584 else if (FLOATP (current_buffer
->extra_line_spacing
))
2585 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2586 * FRAME_LINE_HEIGHT (it
->f
));
2587 else if (it
->f
->extra_line_spacing
> 0)
2588 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2589 it
->max_extra_line_spacing
= 0;
2592 /* If realized faces have been removed, e.g. because of face
2593 attribute changes of named faces, recompute them. When running
2594 in batch mode, the face cache of the initial frame is null. If
2595 we happen to get called, make a dummy face cache. */
2596 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2597 init_frame_faces (it
->f
);
2598 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2599 recompute_basic_faces (it
->f
);
2601 /* Current value of the `slice', `space-width', and 'height' properties. */
2602 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2603 it
->space_width
= Qnil
;
2604 it
->font_height
= Qnil
;
2605 it
->override_ascent
= -1;
2607 /* Are control characters displayed as `^C'? */
2608 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2610 /* -1 means everything between a CR and the following line end
2611 is invisible. >0 means lines indented more than this value are
2613 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2614 ? XFASTINT (current_buffer
->selective_display
)
2615 : (!NILP (current_buffer
->selective_display
)
2617 it
->selective_display_ellipsis_p
2618 = !NILP (current_buffer
->selective_display_ellipses
);
2620 /* Display table to use. */
2621 it
->dp
= window_display_table (w
);
2623 /* Are multibyte characters enabled in current_buffer? */
2624 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2626 /* Non-zero if we should highlight the region. */
2628 = (!NILP (Vtransient_mark_mode
)
2629 && !NILP (current_buffer
->mark_active
)
2630 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2632 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2633 start and end of a visible region in window IT->w. Set both to
2634 -1 to indicate no region. */
2635 if (highlight_region_p
2636 /* Maybe highlight only in selected window. */
2637 && (/* Either show region everywhere. */
2638 highlight_nonselected_windows
2639 /* Or show region in the selected window. */
2640 || w
== XWINDOW (selected_window
)
2641 /* Or show the region if we are in the mini-buffer and W is
2642 the window the mini-buffer refers to. */
2643 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2644 && WINDOWP (minibuf_selected_window
)
2645 && w
== XWINDOW (minibuf_selected_window
))))
2647 int charpos
= marker_position (current_buffer
->mark
);
2648 it
->region_beg_charpos
= min (PT
, charpos
);
2649 it
->region_end_charpos
= max (PT
, charpos
);
2652 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2654 /* Get the position at which the redisplay_end_trigger hook should
2655 be run, if it is to be run at all. */
2656 if (MARKERP (w
->redisplay_end_trigger
)
2657 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2658 it
->redisplay_end_trigger_charpos
2659 = marker_position (w
->redisplay_end_trigger
);
2660 else if (INTEGERP (w
->redisplay_end_trigger
))
2661 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2663 /* Correct bogus values of tab_width. */
2664 it
->tab_width
= XINT (current_buffer
->tab_width
);
2665 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2668 /* Are lines in the display truncated? */
2669 if (base_face_id
!= DEFAULT_FACE_ID
2670 || XINT (it
->w
->hscroll
)
2671 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2672 && ((!NILP (Vtruncate_partial_width_windows
)
2673 && !INTEGERP (Vtruncate_partial_width_windows
))
2674 || (INTEGERP (Vtruncate_partial_width_windows
)
2675 && (WINDOW_TOTAL_COLS (it
->w
)
2676 < XINT (Vtruncate_partial_width_windows
))))))
2677 it
->line_wrap
= TRUNCATE
;
2678 else if (NILP (current_buffer
->truncate_lines
))
2679 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2680 ? WINDOW_WRAP
: WORD_WRAP
;
2682 it
->line_wrap
= TRUNCATE
;
2684 /* Get dimensions of truncation and continuation glyphs. These are
2685 displayed as fringe bitmaps under X, so we don't need them for such
2687 if (!FRAME_WINDOW_P (it
->f
))
2689 if (it
->line_wrap
== TRUNCATE
)
2691 /* We will need the truncation glyph. */
2692 xassert (it
->glyph_row
== NULL
);
2693 produce_special_glyphs (it
, IT_TRUNCATION
);
2694 it
->truncation_pixel_width
= it
->pixel_width
;
2698 /* We will need the continuation glyph. */
2699 xassert (it
->glyph_row
== NULL
);
2700 produce_special_glyphs (it
, IT_CONTINUATION
);
2701 it
->continuation_pixel_width
= it
->pixel_width
;
2704 /* Reset these values to zero because the produce_special_glyphs
2705 above has changed them. */
2706 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2707 it
->phys_ascent
= it
->phys_descent
= 0;
2710 /* Set this after getting the dimensions of truncation and
2711 continuation glyphs, so that we don't produce glyphs when calling
2712 produce_special_glyphs, above. */
2713 it
->glyph_row
= row
;
2714 it
->area
= TEXT_AREA
;
2716 /* Get the dimensions of the display area. The display area
2717 consists of the visible window area plus a horizontally scrolled
2718 part to the left of the window. All x-values are relative to the
2719 start of this total display area. */
2720 if (base_face_id
!= DEFAULT_FACE_ID
)
2722 /* Mode lines, menu bar in terminal frames. */
2723 it
->first_visible_x
= 0;
2724 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2729 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2730 it
->last_visible_x
= (it
->first_visible_x
2731 + window_box_width (w
, TEXT_AREA
));
2733 /* If we truncate lines, leave room for the truncator glyph(s) at
2734 the right margin. Otherwise, leave room for the continuation
2735 glyph(s). Truncation and continuation glyphs are not inserted
2736 for window-based redisplay. */
2737 if (!FRAME_WINDOW_P (it
->f
))
2739 if (it
->line_wrap
== TRUNCATE
)
2740 it
->last_visible_x
-= it
->truncation_pixel_width
;
2742 it
->last_visible_x
-= it
->continuation_pixel_width
;
2745 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2746 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2749 /* Leave room for a border glyph. */
2750 if (!FRAME_WINDOW_P (it
->f
)
2751 && !WINDOW_RIGHTMOST_P (it
->w
))
2752 it
->last_visible_x
-= 1;
2754 it
->last_visible_y
= window_text_bottom_y (w
);
2756 /* For mode lines and alike, arrange for the first glyph having a
2757 left box line if the face specifies a box. */
2758 if (base_face_id
!= DEFAULT_FACE_ID
)
2762 it
->face_id
= remapped_base_face_id
;
2764 /* If we have a boxed mode line, make the first character appear
2765 with a left box line. */
2766 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2767 if (face
->box
!= FACE_NO_BOX
)
2768 it
->start_of_box_run_p
= 1;
2771 /* If a buffer position was specified, set the iterator there,
2772 getting overlays and face properties from that position. */
2773 if (charpos
>= BUF_BEG (current_buffer
))
2775 it
->end_charpos
= ZV
;
2777 IT_CHARPOS (*it
) = charpos
;
2779 /* Compute byte position if not specified. */
2780 if (bytepos
< charpos
)
2781 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2783 IT_BYTEPOS (*it
) = bytepos
;
2785 it
->start
= it
->current
;
2787 /* Compute faces etc. */
2788 reseat (it
, it
->current
.pos
, 1);
2795 /* Initialize IT for the display of window W with window start POS. */
2798 start_display (it
, w
, pos
)
2801 struct text_pos pos
;
2803 struct glyph_row
*row
;
2804 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2806 row
= w
->desired_matrix
->rows
+ first_vpos
;
2807 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2808 it
->first_vpos
= first_vpos
;
2810 /* Don't reseat to previous visible line start if current start
2811 position is in a string or image. */
2812 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2814 int start_at_line_beg_p
;
2815 int first_y
= it
->current_y
;
2817 /* If window start is not at a line start, skip forward to POS to
2818 get the correct continuation lines width. */
2819 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2820 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2821 if (!start_at_line_beg_p
)
2825 reseat_at_previous_visible_line_start (it
);
2826 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2828 new_x
= it
->current_x
+ it
->pixel_width
;
2830 /* If lines are continued, this line may end in the middle
2831 of a multi-glyph character (e.g. a control character
2832 displayed as \003, or in the middle of an overlay
2833 string). In this case move_it_to above will not have
2834 taken us to the start of the continuation line but to the
2835 end of the continued line. */
2836 if (it
->current_x
> 0
2837 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2838 && (/* And glyph doesn't fit on the line. */
2839 new_x
> it
->last_visible_x
2840 /* Or it fits exactly and we're on a window
2842 || (new_x
== it
->last_visible_x
2843 && FRAME_WINDOW_P (it
->f
))))
2845 if (it
->current
.dpvec_index
>= 0
2846 || it
->current
.overlay_string_index
>= 0)
2848 set_iterator_to_next (it
, 1);
2849 move_it_in_display_line_to (it
, -1, -1, 0);
2852 it
->continuation_lines_width
+= it
->current_x
;
2855 /* We're starting a new display line, not affected by the
2856 height of the continued line, so clear the appropriate
2857 fields in the iterator structure. */
2858 it
->max_ascent
= it
->max_descent
= 0;
2859 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2861 it
->current_y
= first_y
;
2863 it
->current_x
= it
->hpos
= 0;
2867 #if 0 /* Don't assert the following because start_display is sometimes
2868 called intentionally with a window start that is not at a
2869 line start. Please leave this code in as a comment. */
2871 /* Window start should be on a line start, now. */
2872 xassert (it
->continuation_lines_width
2873 || IT_CHARPOS (it
) == BEGV
2874 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2879 /* Return 1 if POS is a position in ellipses displayed for invisible
2880 text. W is the window we display, for text property lookup. */
2883 in_ellipses_for_invisible_text_p (pos
, w
)
2884 struct display_pos
*pos
;
2887 Lisp_Object prop
, window
;
2889 int charpos
= CHARPOS (pos
->pos
);
2891 /* If POS specifies a position in a display vector, this might
2892 be for an ellipsis displayed for invisible text. We won't
2893 get the iterator set up for delivering that ellipsis unless
2894 we make sure that it gets aware of the invisible text. */
2895 if (pos
->dpvec_index
>= 0
2896 && pos
->overlay_string_index
< 0
2897 && CHARPOS (pos
->string_pos
) < 0
2899 && (XSETWINDOW (window
, w
),
2900 prop
= Fget_char_property (make_number (charpos
),
2901 Qinvisible
, window
),
2902 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2904 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2906 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2913 /* Initialize IT for stepping through current_buffer in window W,
2914 starting at position POS that includes overlay string and display
2915 vector/ control character translation position information. Value
2916 is zero if there are overlay strings with newlines at POS. */
2919 init_from_display_pos (it
, w
, pos
)
2922 struct display_pos
*pos
;
2924 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2925 int i
, overlay_strings_with_newlines
= 0;
2927 /* If POS specifies a position in a display vector, this might
2928 be for an ellipsis displayed for invisible text. We won't
2929 get the iterator set up for delivering that ellipsis unless
2930 we make sure that it gets aware of the invisible text. */
2931 if (in_ellipses_for_invisible_text_p (pos
, w
))
2937 /* Keep in mind: the call to reseat in init_iterator skips invisible
2938 text, so we might end up at a position different from POS. This
2939 is only a problem when POS is a row start after a newline and an
2940 overlay starts there with an after-string, and the overlay has an
2941 invisible property. Since we don't skip invisible text in
2942 display_line and elsewhere immediately after consuming the
2943 newline before the row start, such a POS will not be in a string,
2944 but the call to init_iterator below will move us to the
2946 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2948 /* This only scans the current chunk -- it should scan all chunks.
2949 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2950 to 16 in 22.1 to make this a lesser problem. */
2951 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2953 const char *s
= SDATA (it
->overlay_strings
[i
]);
2954 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2956 while (s
< e
&& *s
!= '\n')
2961 overlay_strings_with_newlines
= 1;
2966 /* If position is within an overlay string, set up IT to the right
2968 if (pos
->overlay_string_index
>= 0)
2972 /* If the first overlay string happens to have a `display'
2973 property for an image, the iterator will be set up for that
2974 image, and we have to undo that setup first before we can
2975 correct the overlay string index. */
2976 if (it
->method
== GET_FROM_IMAGE
)
2979 /* We already have the first chunk of overlay strings in
2980 IT->overlay_strings. Load more until the one for
2981 pos->overlay_string_index is in IT->overlay_strings. */
2982 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2984 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2985 it
->current
.overlay_string_index
= 0;
2988 load_overlay_strings (it
, 0);
2989 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2993 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2994 relative_index
= (it
->current
.overlay_string_index
2995 % OVERLAY_STRING_CHUNK_SIZE
);
2996 it
->string
= it
->overlay_strings
[relative_index
];
2997 xassert (STRINGP (it
->string
));
2998 it
->current
.string_pos
= pos
->string_pos
;
2999 it
->method
= GET_FROM_STRING
;
3002 #if 0 /* This is bogus because POS not having an overlay string
3003 position does not mean it's after the string. Example: A
3004 line starting with a before-string and initialization of IT
3005 to the previous row's end position. */
3006 else if (it
->current
.overlay_string_index
>= 0)
3008 /* If POS says we're already after an overlay string ending at
3009 POS, make sure to pop the iterator because it will be in
3010 front of that overlay string. When POS is ZV, we've thereby
3011 also ``processed'' overlay strings at ZV. */
3014 xassert (it
->current
.overlay_string_index
== -1);
3015 xassert (it
->method
== GET_FROM_BUFFER
);
3016 if (CHARPOS (pos
->pos
) == ZV
)
3017 it
->overlay_strings_at_end_processed_p
= 1;
3021 if (CHARPOS (pos
->string_pos
) >= 0)
3023 /* Recorded position is not in an overlay string, but in another
3024 string. This can only be a string from a `display' property.
3025 IT should already be filled with that string. */
3026 it
->current
.string_pos
= pos
->string_pos
;
3027 xassert (STRINGP (it
->string
));
3030 /* Restore position in display vector translations, control
3031 character translations or ellipses. */
3032 if (pos
->dpvec_index
>= 0)
3034 if (it
->dpvec
== NULL
)
3035 get_next_display_element (it
);
3036 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3037 it
->current
.dpvec_index
= pos
->dpvec_index
;
3041 return !overlay_strings_with_newlines
;
3045 /* Initialize IT for stepping through current_buffer in window W
3046 starting at ROW->start. */
3049 init_to_row_start (it
, w
, row
)
3052 struct glyph_row
*row
;
3054 init_from_display_pos (it
, w
, &row
->start
);
3055 it
->start
= row
->start
;
3056 it
->continuation_lines_width
= row
->continuation_lines_width
;
3061 /* Initialize IT for stepping through current_buffer in window W
3062 starting in the line following ROW, i.e. starting at ROW->end.
3063 Value is zero if there are overlay strings with newlines at ROW's
3067 init_to_row_end (it
, w
, row
)
3070 struct glyph_row
*row
;
3074 if (init_from_display_pos (it
, w
, &row
->end
))
3076 if (row
->continued_p
)
3077 it
->continuation_lines_width
3078 = row
->continuation_lines_width
+ row
->pixel_width
;
3089 /***********************************************************************
3091 ***********************************************************************/
3093 /* Called when IT reaches IT->stop_charpos. Handle text property and
3094 overlay changes. Set IT->stop_charpos to the next position where
3101 enum prop_handled handled
;
3102 int handle_overlay_change_p
;
3106 it
->current
.dpvec_index
= -1;
3107 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3108 it
->ignore_overlay_strings_at_pos_p
= 0;
3111 /* Use face of preceding text for ellipsis (if invisible) */
3112 if (it
->selective_display_ellipsis_p
)
3113 it
->saved_face_id
= it
->face_id
;
3117 handled
= HANDLED_NORMALLY
;
3119 /* Call text property handlers. */
3120 for (p
= it_props
; p
->handler
; ++p
)
3122 handled
= p
->handler (it
);
3124 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3126 else if (handled
== HANDLED_RETURN
)
3128 /* We still want to show before and after strings from
3129 overlays even if the actual buffer text is replaced. */
3130 if (!handle_overlay_change_p
3132 || !get_overlay_strings_1 (it
, 0, 0))
3135 setup_for_ellipsis (it
, 0);
3138 it
->ignore_overlay_strings_at_pos_p
= 1;
3139 it
->string_from_display_prop_p
= 0;
3140 handle_overlay_change_p
= 0;
3141 handled
= HANDLED_RECOMPUTE_PROPS
;
3144 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3145 handle_overlay_change_p
= 0;
3148 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3150 /* Don't check for overlay strings below when set to deliver
3151 characters from a display vector. */
3152 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3153 handle_overlay_change_p
= 0;
3155 /* Handle overlay changes.
3156 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3157 if it finds overlays. */
3158 if (handle_overlay_change_p
)
3159 handled
= handle_overlay_change (it
);
3164 setup_for_ellipsis (it
, 0);
3168 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3170 /* Determine where to stop next. */
3171 if (handled
== HANDLED_NORMALLY
)
3172 compute_stop_pos (it
);
3176 /* Compute IT->stop_charpos from text property and overlay change
3177 information for IT's current position. */
3180 compute_stop_pos (it
)
3183 register INTERVAL iv
, next_iv
;
3184 Lisp_Object object
, limit
, position
;
3185 EMACS_INT charpos
, bytepos
;
3187 /* If nowhere else, stop at the end. */
3188 it
->stop_charpos
= it
->end_charpos
;
3190 if (STRINGP (it
->string
))
3192 /* Strings are usually short, so don't limit the search for
3194 object
= it
->string
;
3196 charpos
= IT_STRING_CHARPOS (*it
);
3197 bytepos
= IT_STRING_BYTEPOS (*it
);
3203 /* If next overlay change is in front of the current stop pos
3204 (which is IT->end_charpos), stop there. Note: value of
3205 next_overlay_change is point-max if no overlay change
3207 charpos
= IT_CHARPOS (*it
);
3208 bytepos
= IT_BYTEPOS (*it
);
3209 pos
= next_overlay_change (charpos
);
3210 if (pos
< it
->stop_charpos
)
3211 it
->stop_charpos
= pos
;
3213 /* If showing the region, we have to stop at the region
3214 start or end because the face might change there. */
3215 if (it
->region_beg_charpos
> 0)
3217 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3218 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3219 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3220 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3223 /* Set up variables for computing the stop position from text
3224 property changes. */
3225 XSETBUFFER (object
, current_buffer
);
3226 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3229 /* Get the interval containing IT's position. Value is a null
3230 interval if there isn't such an interval. */
3231 position
= make_number (charpos
);
3232 iv
= validate_interval_range (object
, &position
, &position
, 0);
3233 if (!NULL_INTERVAL_P (iv
))
3235 Lisp_Object values_here
[LAST_PROP_IDX
];
3238 /* Get properties here. */
3239 for (p
= it_props
; p
->handler
; ++p
)
3240 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3242 /* Look for an interval following iv that has different
3244 for (next_iv
= next_interval (iv
);
3245 (!NULL_INTERVAL_P (next_iv
)
3247 || XFASTINT (limit
) > next_iv
->position
));
3248 next_iv
= next_interval (next_iv
))
3250 for (p
= it_props
; p
->handler
; ++p
)
3252 Lisp_Object new_value
;
3254 new_value
= textget (next_iv
->plist
, *p
->name
);
3255 if (!EQ (values_here
[p
->idx
], new_value
))
3263 if (!NULL_INTERVAL_P (next_iv
))
3265 if (INTEGERP (limit
)
3266 && next_iv
->position
>= XFASTINT (limit
))
3267 /* No text property change up to limit. */
3268 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3270 /* Text properties change in next_iv. */
3271 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3275 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3276 it
->stop_charpos
, it
->string
);
3278 xassert (STRINGP (it
->string
)
3279 || (it
->stop_charpos
>= BEGV
3280 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3284 /* Return the position of the next overlay change after POS in
3285 current_buffer. Value is point-max if no overlay change
3286 follows. This is like `next-overlay-change' but doesn't use
3290 next_overlay_change (pos
)
3295 Lisp_Object
*overlays
;
3298 /* Get all overlays at the given position. */
3299 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3301 /* If any of these overlays ends before endpos,
3302 use its ending point instead. */
3303 for (i
= 0; i
< noverlays
; ++i
)
3308 oend
= OVERLAY_END (overlays
[i
]);
3309 oendpos
= OVERLAY_POSITION (oend
);
3310 endpos
= min (endpos
, oendpos
);
3318 /***********************************************************************
3320 ***********************************************************************/
3322 /* Handle changes in the `fontified' property of the current buffer by
3323 calling hook functions from Qfontification_functions to fontify
3326 static enum prop_handled
3327 handle_fontified_prop (it
)
3330 Lisp_Object prop
, pos
;
3331 enum prop_handled handled
= HANDLED_NORMALLY
;
3333 if (!NILP (Vmemory_full
))
3336 /* Get the value of the `fontified' property at IT's current buffer
3337 position. (The `fontified' property doesn't have a special
3338 meaning in strings.) If the value is nil, call functions from
3339 Qfontification_functions. */
3340 if (!STRINGP (it
->string
)
3342 && !NILP (Vfontification_functions
)
3343 && !NILP (Vrun_hooks
)
3344 && (pos
= make_number (IT_CHARPOS (*it
)),
3345 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3346 /* Ignore the special cased nil value always present at EOB since
3347 no amount of fontifying will be able to change it. */
3348 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3350 int count
= SPECPDL_INDEX ();
3353 val
= Vfontification_functions
;
3354 specbind (Qfontification_functions
, Qnil
);
3356 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3357 safe_call1 (val
, pos
);
3360 Lisp_Object globals
, fn
;
3361 struct gcpro gcpro1
, gcpro2
;
3364 GCPRO2 (val
, globals
);
3366 for (; CONSP (val
); val
= XCDR (val
))
3372 /* A value of t indicates this hook has a local
3373 binding; it means to run the global binding too.
3374 In a global value, t should not occur. If it
3375 does, we must ignore it to avoid an endless
3377 for (globals
= Fdefault_value (Qfontification_functions
);
3379 globals
= XCDR (globals
))
3381 fn
= XCAR (globals
);
3383 safe_call1 (fn
, pos
);
3387 safe_call1 (fn
, pos
);
3393 unbind_to (count
, Qnil
);
3395 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3396 something. This avoids an endless loop if they failed to
3397 fontify the text for which reason ever. */
3398 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3399 handled
= HANDLED_RECOMPUTE_PROPS
;
3407 /***********************************************************************
3409 ***********************************************************************/
3411 /* Set up iterator IT from face properties at its current position.
3412 Called from handle_stop. */
3414 static enum prop_handled
3415 handle_face_prop (it
)
3419 EMACS_INT next_stop
;
3421 if (!STRINGP (it
->string
))
3424 = face_at_buffer_position (it
->w
,
3426 it
->region_beg_charpos
,
3427 it
->region_end_charpos
,
3430 + TEXT_PROP_DISTANCE_LIMIT
),
3433 /* Is this a start of a run of characters with box face?
3434 Caveat: this can be called for a freshly initialized
3435 iterator; face_id is -1 in this case. We know that the new
3436 face will not change until limit, i.e. if the new face has a
3437 box, all characters up to limit will have one. But, as
3438 usual, we don't know whether limit is really the end. */
3439 if (new_face_id
!= it
->face_id
)
3441 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3443 /* If new face has a box but old face has not, this is
3444 the start of a run of characters with box, i.e. it has
3445 a shadow on the left side. The value of face_id of the
3446 iterator will be -1 if this is the initial call that gets
3447 the face. In this case, we have to look in front of IT's
3448 position and see whether there is a face != new_face_id. */
3449 it
->start_of_box_run_p
3450 = (new_face
->box
!= FACE_NO_BOX
3451 && (it
->face_id
>= 0
3452 || IT_CHARPOS (*it
) == BEG
3453 || new_face_id
!= face_before_it_pos (it
)));
3454 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3459 int base_face_id
, bufpos
;
3461 Lisp_Object from_overlay
3462 = (it
->current
.overlay_string_index
>= 0
3463 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3466 /* See if we got to this string directly or indirectly from
3467 an overlay property. That includes the before-string or
3468 after-string of an overlay, strings in display properties
3469 provided by an overlay, their text properties, etc.
3471 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3472 if (! NILP (from_overlay
))
3473 for (i
= it
->sp
- 1; i
>= 0; i
--)
3475 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3477 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3478 else if (! NILP (it
->stack
[i
].from_overlay
))
3479 from_overlay
= it
->stack
[i
].from_overlay
;
3481 if (!NILP (from_overlay
))
3485 if (! NILP (from_overlay
))
3487 bufpos
= IT_CHARPOS (*it
);
3488 /* For a string from an overlay, the base face depends
3489 only on text properties and ignores overlays. */
3491 = face_for_overlay_string (it
->w
,
3493 it
->region_beg_charpos
,
3494 it
->region_end_charpos
,
3497 + TEXT_PROP_DISTANCE_LIMIT
),
3505 /* For strings from a `display' property, use the face at
3506 IT's current buffer position as the base face to merge
3507 with, so that overlay strings appear in the same face as
3508 surrounding text, unless they specify their own
3510 base_face_id
= underlying_face_id (it
);
3513 new_face_id
= face_at_string_position (it
->w
,
3515 IT_STRING_CHARPOS (*it
),
3517 it
->region_beg_charpos
,
3518 it
->region_end_charpos
,
3522 #if 0 /* This shouldn't be neccessary. Let's check it. */
3523 /* If IT is used to display a mode line we would really like to
3524 use the mode line face instead of the frame's default face. */
3525 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3526 && new_face_id
== DEFAULT_FACE_ID
)
3527 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3530 /* Is this a start of a run of characters with box? Caveat:
3531 this can be called for a freshly allocated iterator; face_id
3532 is -1 is this case. We know that the new face will not
3533 change until the next check pos, i.e. if the new face has a
3534 box, all characters up to that position will have a
3535 box. But, as usual, we don't know whether that position
3536 is really the end. */
3537 if (new_face_id
!= it
->face_id
)
3539 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3540 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3542 /* If new face has a box but old face hasn't, this is the
3543 start of a run of characters with box, i.e. it has a
3544 shadow on the left side. */
3545 it
->start_of_box_run_p
3546 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3547 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3551 it
->face_id
= new_face_id
;
3552 return HANDLED_NORMALLY
;
3556 /* Return the ID of the face ``underlying'' IT's current position,
3557 which is in a string. If the iterator is associated with a
3558 buffer, return the face at IT's current buffer position.
3559 Otherwise, use the iterator's base_face_id. */
3562 underlying_face_id (it
)
3565 int face_id
= it
->base_face_id
, i
;
3567 xassert (STRINGP (it
->string
));
3569 for (i
= it
->sp
- 1; i
>= 0; --i
)
3570 if (NILP (it
->stack
[i
].string
))
3571 face_id
= it
->stack
[i
].face_id
;
3577 /* Compute the face one character before or after the current position
3578 of IT. BEFORE_P non-zero means get the face in front of IT's
3579 position. Value is the id of the face. */
3582 face_before_or_after_it_pos (it
, before_p
)
3587 EMACS_INT next_check_charpos
;
3588 struct text_pos pos
;
3590 xassert (it
->s
== NULL
);
3592 if (STRINGP (it
->string
))
3594 int bufpos
, base_face_id
;
3596 /* No face change past the end of the string (for the case
3597 we are padding with spaces). No face change before the
3599 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3600 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3603 /* Set pos to the position before or after IT's current position. */
3605 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3607 /* For composition, we must check the character after the
3609 pos
= (it
->what
== IT_COMPOSITION
3610 ? string_pos (IT_STRING_CHARPOS (*it
)
3611 + it
->cmp_it
.nchars
, it
->string
)
3612 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3614 if (it
->current
.overlay_string_index
>= 0)
3615 bufpos
= IT_CHARPOS (*it
);
3619 base_face_id
= underlying_face_id (it
);
3621 /* Get the face for ASCII, or unibyte. */
3622 face_id
= face_at_string_position (it
->w
,
3626 it
->region_beg_charpos
,
3627 it
->region_end_charpos
,
3628 &next_check_charpos
,
3631 /* Correct the face for charsets different from ASCII. Do it
3632 for the multibyte case only. The face returned above is
3633 suitable for unibyte text if IT->string is unibyte. */
3634 if (STRING_MULTIBYTE (it
->string
))
3636 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3637 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3639 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3641 c
= string_char_and_length (p
, rest
, &len
);
3642 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3647 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3648 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3651 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3652 pos
= it
->current
.pos
;
3655 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3658 if (it
->what
== IT_COMPOSITION
)
3659 /* For composition, we must check the position after the
3661 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3663 INC_TEXT_POS (pos
, it
->multibyte_p
);
3666 /* Determine face for CHARSET_ASCII, or unibyte. */
3667 face_id
= face_at_buffer_position (it
->w
,
3669 it
->region_beg_charpos
,
3670 it
->region_end_charpos
,
3671 &next_check_charpos
,
3674 /* Correct the face for charsets different from ASCII. Do it
3675 for the multibyte case only. The face returned above is
3676 suitable for unibyte text if current_buffer is unibyte. */
3677 if (it
->multibyte_p
)
3679 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3680 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3681 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3690 /***********************************************************************
3692 ***********************************************************************/
3694 /* Set up iterator IT from invisible properties at its current
3695 position. Called from handle_stop. */
3697 static enum prop_handled
3698 handle_invisible_prop (it
)
3701 enum prop_handled handled
= HANDLED_NORMALLY
;
3703 if (STRINGP (it
->string
))
3705 extern Lisp_Object Qinvisible
;
3706 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3708 /* Get the value of the invisible text property at the
3709 current position. Value will be nil if there is no such
3711 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3712 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3715 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3717 handled
= HANDLED_RECOMPUTE_PROPS
;
3719 /* Get the position at which the next change of the
3720 invisible text property can be found in IT->string.
3721 Value will be nil if the property value is the same for
3722 all the rest of IT->string. */
3723 XSETINT (limit
, SCHARS (it
->string
));
3724 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3727 /* Text at current position is invisible. The next
3728 change in the property is at position end_charpos.
3729 Move IT's current position to that position. */
3730 if (INTEGERP (end_charpos
)
3731 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3733 struct text_pos old
;
3734 old
= it
->current
.string_pos
;
3735 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3736 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3740 /* The rest of the string is invisible. If this is an
3741 overlay string, proceed with the next overlay string
3742 or whatever comes and return a character from there. */
3743 if (it
->current
.overlay_string_index
>= 0)
3745 next_overlay_string (it
);
3746 /* Don't check for overlay strings when we just
3747 finished processing them. */
3748 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3752 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3753 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3761 EMACS_INT newpos
, next_stop
, start_charpos
;
3762 Lisp_Object pos
, prop
, overlay
;
3764 /* First of all, is there invisible text at this position? */
3765 start_charpos
= IT_CHARPOS (*it
);
3766 pos
= make_number (IT_CHARPOS (*it
));
3767 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3769 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3771 /* If we are on invisible text, skip over it. */
3772 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3774 /* Record whether we have to display an ellipsis for the
3776 int display_ellipsis_p
= invis_p
== 2;
3778 handled
= HANDLED_RECOMPUTE_PROPS
;
3780 /* Loop skipping over invisible text. The loop is left at
3781 ZV or with IT on the first char being visible again. */
3784 /* Try to skip some invisible text. Return value is the
3785 position reached which can be equal to IT's position
3786 if there is nothing invisible here. This skips both
3787 over invisible text properties and overlays with
3788 invisible property. */
3789 newpos
= skip_invisible (IT_CHARPOS (*it
),
3790 &next_stop
, ZV
, it
->window
);
3792 /* If we skipped nothing at all we weren't at invisible
3793 text in the first place. If everything to the end of
3794 the buffer was skipped, end the loop. */
3795 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3799 /* We skipped some characters but not necessarily
3800 all there are. Check if we ended up on visible
3801 text. Fget_char_property returns the property of
3802 the char before the given position, i.e. if we
3803 get invis_p = 0, this means that the char at
3804 newpos is visible. */
3805 pos
= make_number (newpos
);
3806 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3807 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3810 /* If we ended up on invisible text, proceed to
3811 skip starting with next_stop. */
3813 IT_CHARPOS (*it
) = next_stop
;
3815 /* If there are adjacent invisible texts, don't lose the
3816 second one's ellipsis. */
3818 display_ellipsis_p
= 1;
3822 /* The position newpos is now either ZV or on visible text. */
3823 IT_CHARPOS (*it
) = newpos
;
3824 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3826 /* If there are before-strings at the start of invisible
3827 text, and the text is invisible because of a text
3828 property, arrange to show before-strings because 20.x did
3829 it that way. (If the text is invisible because of an
3830 overlay property instead of a text property, this is
3831 already handled in the overlay code.) */
3833 && get_overlay_strings (it
, start_charpos
))
3835 handled
= HANDLED_RECOMPUTE_PROPS
;
3836 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3838 else if (display_ellipsis_p
)
3840 /* Make sure that the glyphs of the ellipsis will get
3841 correct `charpos' values. If we would not update
3842 it->position here, the glyphs would belong to the
3843 last visible character _before_ the invisible
3844 text, which confuses `set_cursor_from_row'.
3846 We use the last invisible position instead of the
3847 first because this way the cursor is always drawn on
3848 the first "." of the ellipsis, whenever PT is inside
3849 the invisible text. Otherwise the cursor would be
3850 placed _after_ the ellipsis when the point is after the
3851 first invisible character. */
3852 if (!STRINGP (it
->object
))
3854 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3855 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3858 /* Let the ellipsis display before
3859 considering any properties of the following char.
3860 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3861 handled
= HANDLED_RETURN
;
3870 /* Make iterator IT return `...' next.
3871 Replaces LEN characters from buffer. */
3874 setup_for_ellipsis (it
, len
)
3878 /* Use the display table definition for `...'. Invalid glyphs
3879 will be handled by the method returning elements from dpvec. */
3880 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3882 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3883 it
->dpvec
= v
->contents
;
3884 it
->dpend
= v
->contents
+ v
->size
;
3888 /* Default `...'. */
3889 it
->dpvec
= default_invis_vector
;
3890 it
->dpend
= default_invis_vector
+ 3;
3893 it
->dpvec_char_len
= len
;
3894 it
->current
.dpvec_index
= 0;
3895 it
->dpvec_face_id
= -1;
3897 /* Remember the current face id in case glyphs specify faces.
3898 IT's face is restored in set_iterator_to_next.
3899 saved_face_id was set to preceding char's face in handle_stop. */
3900 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3901 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3903 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3909 /***********************************************************************
3911 ***********************************************************************/
3913 /* Set up iterator IT from `display' property at its current position.
3914 Called from handle_stop.
3915 We return HANDLED_RETURN if some part of the display property
3916 overrides the display of the buffer text itself.
3917 Otherwise we return HANDLED_NORMALLY. */
3919 static enum prop_handled
3920 handle_display_prop (it
)
3923 Lisp_Object prop
, object
, overlay
;
3924 struct text_pos
*position
;
3925 /* Nonzero if some property replaces the display of the text itself. */
3926 int display_replaced_p
= 0;
3928 if (STRINGP (it
->string
))
3930 object
= it
->string
;
3931 position
= &it
->current
.string_pos
;
3935 XSETWINDOW (object
, it
->w
);
3936 position
= &it
->current
.pos
;
3939 /* Reset those iterator values set from display property values. */
3940 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3941 it
->space_width
= Qnil
;
3942 it
->font_height
= Qnil
;
3945 /* We don't support recursive `display' properties, i.e. string
3946 values that have a string `display' property, that have a string
3947 `display' property etc. */
3948 if (!it
->string_from_display_prop_p
)
3949 it
->area
= TEXT_AREA
;
3951 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3952 Qdisplay
, object
, &overlay
);
3954 return HANDLED_NORMALLY
;
3955 /* Now OVERLAY is the overlay that gave us this property, or nil
3956 if it was a text property. */
3958 if (!STRINGP (it
->string
))
3959 object
= it
->w
->buffer
;
3962 /* Simple properties. */
3963 && !EQ (XCAR (prop
), Qimage
)
3964 && !EQ (XCAR (prop
), Qspace
)
3965 && !EQ (XCAR (prop
), Qwhen
)
3966 && !EQ (XCAR (prop
), Qslice
)
3967 && !EQ (XCAR (prop
), Qspace_width
)
3968 && !EQ (XCAR (prop
), Qheight
)
3969 && !EQ (XCAR (prop
), Qraise
)
3970 /* Marginal area specifications. */
3971 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3972 && !EQ (XCAR (prop
), Qleft_fringe
)
3973 && !EQ (XCAR (prop
), Qright_fringe
)
3974 && !NILP (XCAR (prop
)))
3976 for (; CONSP (prop
); prop
= XCDR (prop
))
3978 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3979 position
, display_replaced_p
))
3981 display_replaced_p
= 1;
3982 /* If some text in a string is replaced, `position' no
3983 longer points to the position of `object'. */
3984 if (STRINGP (object
))
3989 else if (VECTORP (prop
))
3992 for (i
= 0; i
< ASIZE (prop
); ++i
)
3993 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3994 position
, display_replaced_p
))
3996 display_replaced_p
= 1;
3997 /* If some text in a string is replaced, `position' no
3998 longer points to the position of `object'. */
3999 if (STRINGP (object
))
4005 int ret
= handle_single_display_spec (it
, prop
, object
, overlay
,
4007 if (ret
< 0) /* Replaced by "", i.e. nothing. */
4008 return HANDLED_RECOMPUTE_PROPS
;
4010 display_replaced_p
= 1;
4013 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4017 /* Value is the position of the end of the `display' property starting
4018 at START_POS in OBJECT. */
4020 static struct text_pos
4021 display_prop_end (it
, object
, start_pos
)
4024 struct text_pos start_pos
;
4027 struct text_pos end_pos
;
4029 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4030 Qdisplay
, object
, Qnil
);
4031 CHARPOS (end_pos
) = XFASTINT (end
);
4032 if (STRINGP (object
))
4033 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4035 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4041 /* Set up IT from a single `display' specification PROP. OBJECT
4042 is the object in which the `display' property was found. *POSITION
4043 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4044 means that we previously saw a display specification which already
4045 replaced text display with something else, for example an image;
4046 we ignore such properties after the first one has been processed.
4048 OVERLAY is the overlay this `display' property came from,
4049 or nil if it was a text property.
4051 If PROP is a `space' or `image' specification, and in some other
4052 cases too, set *POSITION to the position where the `display'
4055 Value is non-zero if something was found which replaces the display
4056 of buffer or string text. Specifically, the value is -1 if that
4057 "something" is "nothing". */
4060 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4061 display_replaced_before_p
)
4065 Lisp_Object overlay
;
4066 struct text_pos
*position
;
4067 int display_replaced_before_p
;
4070 Lisp_Object location
, value
;
4071 struct text_pos start_pos
, save_pos
;
4074 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4075 If the result is non-nil, use VALUE instead of SPEC. */
4077 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4086 if (!NILP (form
) && !EQ (form
, Qt
))
4088 int count
= SPECPDL_INDEX ();
4089 struct gcpro gcpro1
;
4091 /* Bind `object' to the object having the `display' property, a
4092 buffer or string. Bind `position' to the position in the
4093 object where the property was found, and `buffer-position'
4094 to the current position in the buffer. */
4095 specbind (Qobject
, object
);
4096 specbind (Qposition
, make_number (CHARPOS (*position
)));
4097 specbind (Qbuffer_position
,
4098 make_number (STRINGP (object
)
4099 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4101 form
= safe_eval (form
);
4103 unbind_to (count
, Qnil
);
4109 /* Handle `(height HEIGHT)' specifications. */
4111 && EQ (XCAR (spec
), Qheight
)
4112 && CONSP (XCDR (spec
)))
4114 if (!FRAME_WINDOW_P (it
->f
))
4117 it
->font_height
= XCAR (XCDR (spec
));
4118 if (!NILP (it
->font_height
))
4120 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4121 int new_height
= -1;
4123 if (CONSP (it
->font_height
)
4124 && (EQ (XCAR (it
->font_height
), Qplus
)
4125 || EQ (XCAR (it
->font_height
), Qminus
))
4126 && CONSP (XCDR (it
->font_height
))
4127 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4129 /* `(+ N)' or `(- N)' where N is an integer. */
4130 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4131 if (EQ (XCAR (it
->font_height
), Qplus
))
4133 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4135 else if (FUNCTIONP (it
->font_height
))
4137 /* Call function with current height as argument.
4138 Value is the new height. */
4140 height
= safe_call1 (it
->font_height
,
4141 face
->lface
[LFACE_HEIGHT_INDEX
]);
4142 if (NUMBERP (height
))
4143 new_height
= XFLOATINT (height
);
4145 else if (NUMBERP (it
->font_height
))
4147 /* Value is a multiple of the canonical char height. */
4150 face
= FACE_FROM_ID (it
->f
,
4151 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4152 new_height
= (XFLOATINT (it
->font_height
)
4153 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4157 /* Evaluate IT->font_height with `height' bound to the
4158 current specified height to get the new height. */
4159 int count
= SPECPDL_INDEX ();
4161 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4162 value
= safe_eval (it
->font_height
);
4163 unbind_to (count
, Qnil
);
4165 if (NUMBERP (value
))
4166 new_height
= XFLOATINT (value
);
4170 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4176 /* Handle `(space-width WIDTH)'. */
4178 && EQ (XCAR (spec
), Qspace_width
)
4179 && CONSP (XCDR (spec
)))
4181 if (!FRAME_WINDOW_P (it
->f
))
4184 value
= XCAR (XCDR (spec
));
4185 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4186 it
->space_width
= value
;
4191 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4193 && EQ (XCAR (spec
), Qslice
))
4197 if (!FRAME_WINDOW_P (it
->f
))
4200 if (tem
= XCDR (spec
), CONSP (tem
))
4202 it
->slice
.x
= XCAR (tem
);
4203 if (tem
= XCDR (tem
), CONSP (tem
))
4205 it
->slice
.y
= XCAR (tem
);
4206 if (tem
= XCDR (tem
), CONSP (tem
))
4208 it
->slice
.width
= XCAR (tem
);
4209 if (tem
= XCDR (tem
), CONSP (tem
))
4210 it
->slice
.height
= XCAR (tem
);
4218 /* Handle `(raise FACTOR)'. */
4220 && EQ (XCAR (spec
), Qraise
)
4221 && CONSP (XCDR (spec
)))
4223 if (!FRAME_WINDOW_P (it
->f
))
4226 #ifdef HAVE_WINDOW_SYSTEM
4227 value
= XCAR (XCDR (spec
));
4228 if (NUMBERP (value
))
4230 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4231 it
->voffset
= - (XFLOATINT (value
)
4232 * (FONT_HEIGHT (face
->font
)));
4234 #endif /* HAVE_WINDOW_SYSTEM */
4239 /* Don't handle the other kinds of display specifications
4240 inside a string that we got from a `display' property. */
4241 if (it
->string_from_display_prop_p
)
4244 /* Characters having this form of property are not displayed, so
4245 we have to find the end of the property. */
4246 start_pos
= *position
;
4247 *position
= display_prop_end (it
, object
, start_pos
);
4250 /* Stop the scan at that end position--we assume that all
4251 text properties change there. */
4252 it
->stop_charpos
= position
->charpos
;
4254 /* Handle `(left-fringe BITMAP [FACE])'
4255 and `(right-fringe BITMAP [FACE])'. */
4257 && (EQ (XCAR (spec
), Qleft_fringe
)
4258 || EQ (XCAR (spec
), Qright_fringe
))
4259 && CONSP (XCDR (spec
)))
4261 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4264 if (!FRAME_WINDOW_P (it
->f
))
4265 /* If we return here, POSITION has been advanced
4266 across the text with this property. */
4269 #ifdef HAVE_WINDOW_SYSTEM
4270 value
= XCAR (XCDR (spec
));
4271 if (!SYMBOLP (value
)
4272 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4273 /* If we return here, POSITION has been advanced
4274 across the text with this property. */
4277 if (CONSP (XCDR (XCDR (spec
))))
4279 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4280 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4286 /* Save current settings of IT so that we can restore them
4287 when we are finished with the glyph property value. */
4289 save_pos
= it
->position
;
4290 it
->position
= *position
;
4292 it
->position
= save_pos
;
4294 it
->area
= TEXT_AREA
;
4295 it
->what
= IT_IMAGE
;
4296 it
->image_id
= -1; /* no image */
4297 it
->position
= start_pos
;
4298 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4299 it
->method
= GET_FROM_IMAGE
;
4300 it
->from_overlay
= Qnil
;
4301 it
->face_id
= face_id
;
4303 /* Say that we haven't consumed the characters with
4304 `display' property yet. The call to pop_it in
4305 set_iterator_to_next will clean this up. */
4306 *position
= start_pos
;
4308 if (EQ (XCAR (spec
), Qleft_fringe
))
4310 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4311 it
->left_user_fringe_face_id
= face_id
;
4315 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4316 it
->right_user_fringe_face_id
= face_id
;
4318 #endif /* HAVE_WINDOW_SYSTEM */
4322 /* Prepare to handle `((margin left-margin) ...)',
4323 `((margin right-margin) ...)' and `((margin nil) ...)'
4324 prefixes for display specifications. */
4325 location
= Qunbound
;
4326 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4330 value
= XCDR (spec
);
4332 value
= XCAR (value
);
4335 if (EQ (XCAR (tem
), Qmargin
)
4336 && (tem
= XCDR (tem
),
4337 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4339 || EQ (tem
, Qleft_margin
)
4340 || EQ (tem
, Qright_margin
))))
4344 if (EQ (location
, Qunbound
))
4350 /* After this point, VALUE is the property after any
4351 margin prefix has been stripped. It must be a string,
4352 an image specification, or `(space ...)'.
4354 LOCATION specifies where to display: `left-margin',
4355 `right-margin' or nil. */
4357 valid_p
= (STRINGP (value
)
4358 #ifdef HAVE_WINDOW_SYSTEM
4359 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4360 #endif /* not HAVE_WINDOW_SYSTEM */
4361 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4363 if (valid_p
&& !display_replaced_before_p
)
4365 /* Save current settings of IT so that we can restore them
4366 when we are finished with the glyph property value. */
4367 save_pos
= it
->position
;
4368 it
->position
= *position
;
4370 it
->position
= save_pos
;
4371 it
->from_overlay
= overlay
;
4373 if (NILP (location
))
4374 it
->area
= TEXT_AREA
;
4375 else if (EQ (location
, Qleft_margin
))
4376 it
->area
= LEFT_MARGIN_AREA
;
4378 it
->area
= RIGHT_MARGIN_AREA
;
4380 if (STRINGP (value
))
4382 if (SCHARS (value
) == 0)
4385 return -1; /* Replaced by "", i.e. nothing. */
4388 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4389 it
->current
.overlay_string_index
= -1;
4390 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4391 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4392 it
->method
= GET_FROM_STRING
;
4393 it
->stop_charpos
= 0;
4394 it
->string_from_display_prop_p
= 1;
4395 /* Say that we haven't consumed the characters with
4396 `display' property yet. The call to pop_it in
4397 set_iterator_to_next will clean this up. */
4398 if (BUFFERP (object
))
4399 *position
= start_pos
;
4401 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4403 it
->method
= GET_FROM_STRETCH
;
4405 *position
= it
->position
= start_pos
;
4407 #ifdef HAVE_WINDOW_SYSTEM
4410 it
->what
= IT_IMAGE
;
4411 it
->image_id
= lookup_image (it
->f
, value
);
4412 it
->position
= start_pos
;
4413 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4414 it
->method
= GET_FROM_IMAGE
;
4416 /* Say that we haven't consumed the characters with
4417 `display' property yet. The call to pop_it in
4418 set_iterator_to_next will clean this up. */
4419 *position
= start_pos
;
4421 #endif /* HAVE_WINDOW_SYSTEM */
4426 /* Invalid property or property not supported. Restore
4427 POSITION to what it was before. */
4428 *position
= start_pos
;
4433 /* Check if SPEC is a display sub-property value whose text should be
4434 treated as intangible. */
4437 single_display_spec_intangible_p (prop
)
4440 /* Skip over `when FORM'. */
4441 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4455 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4456 we don't need to treat text as intangible. */
4457 if (EQ (XCAR (prop
), Qmargin
))
4465 || EQ (XCAR (prop
), Qleft_margin
)
4466 || EQ (XCAR (prop
), Qright_margin
))
4470 return (CONSP (prop
)
4471 && (EQ (XCAR (prop
), Qimage
)
4472 || EQ (XCAR (prop
), Qspace
)));
4476 /* Check if PROP is a display property value whose text should be
4477 treated as intangible. */
4480 display_prop_intangible_p (prop
)
4484 && CONSP (XCAR (prop
))
4485 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4487 /* A list of sub-properties. */
4488 while (CONSP (prop
))
4490 if (single_display_spec_intangible_p (XCAR (prop
)))
4495 else if (VECTORP (prop
))
4497 /* A vector of sub-properties. */
4499 for (i
= 0; i
< ASIZE (prop
); ++i
)
4500 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4504 return single_display_spec_intangible_p (prop
);
4510 /* Return 1 if PROP is a display sub-property value containing STRING. */
4513 single_display_spec_string_p (prop
, string
)
4514 Lisp_Object prop
, string
;
4516 if (EQ (string
, prop
))
4519 /* Skip over `when FORM'. */
4520 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4529 /* Skip over `margin LOCATION'. */
4530 if (EQ (XCAR (prop
), Qmargin
))
4541 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4545 /* Return 1 if STRING appears in the `display' property PROP. */
4548 display_prop_string_p (prop
, string
)
4549 Lisp_Object prop
, string
;
4552 && CONSP (XCAR (prop
))
4553 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4555 /* A list of sub-properties. */
4556 while (CONSP (prop
))
4558 if (single_display_spec_string_p (XCAR (prop
), string
))
4563 else if (VECTORP (prop
))
4565 /* A vector of sub-properties. */
4567 for (i
= 0; i
< ASIZE (prop
); ++i
)
4568 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4572 return single_display_spec_string_p (prop
, string
);
4578 /* Determine from which buffer position in W's buffer STRING comes
4579 from. AROUND_CHARPOS is an approximate position where it could
4580 be from. Value is the buffer position or 0 if it couldn't be
4583 W's buffer must be current.
4585 This function is necessary because we don't record buffer positions
4586 in glyphs generated from strings (to keep struct glyph small).
4587 This function may only use code that doesn't eval because it is
4588 called asynchronously from note_mouse_highlight. */
4591 string_buffer_position (w
, string
, around_charpos
)
4596 Lisp_Object limit
, prop
, pos
;
4597 const int MAX_DISTANCE
= 1000;
4600 pos
= make_number (around_charpos
);
4601 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4602 while (!found
&& !EQ (pos
, limit
))
4604 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4605 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4608 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4613 pos
= make_number (around_charpos
);
4614 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4615 while (!found
&& !EQ (pos
, limit
))
4617 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4618 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4621 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4626 return found
? XINT (pos
) : 0;
4631 /***********************************************************************
4632 `composition' property
4633 ***********************************************************************/
4635 /* Set up iterator IT from `composition' property at its current
4636 position. Called from handle_stop. */
4638 static enum prop_handled
4639 handle_composition_prop (it
)
4642 Lisp_Object prop
, string
;
4643 EMACS_INT pos
, pos_byte
, start
, end
;
4645 if (STRINGP (it
->string
))
4649 pos
= IT_STRING_CHARPOS (*it
);
4650 pos_byte
= IT_STRING_BYTEPOS (*it
);
4651 string
= it
->string
;
4652 s
= SDATA (string
) + pos_byte
;
4653 it
->c
= STRING_CHAR (s
, 0);
4657 pos
= IT_CHARPOS (*it
);
4658 pos_byte
= IT_BYTEPOS (*it
);
4660 it
->c
= FETCH_CHAR (pos_byte
);
4663 /* If there's a valid composition and point is not inside of the
4664 composition (in the case that the composition is from the current
4665 buffer), draw a glyph composed from the composition components. */
4666 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4667 && COMPOSITION_VALID_P (start
, end
, prop
)
4668 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4672 if (STRINGP (it
->string
))
4673 pos_byte
= string_char_to_byte (it
->string
, start
);
4675 pos_byte
= CHAR_TO_BYTE (start
);
4677 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4680 if (it
->cmp_it
.id
>= 0)
4683 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4684 it
->cmp_it
.nglyphs
= -1;
4688 return HANDLED_NORMALLY
;
4693 /***********************************************************************
4695 ***********************************************************************/
4697 /* The following structure is used to record overlay strings for
4698 later sorting in load_overlay_strings. */
4700 struct overlay_entry
4702 Lisp_Object overlay
;
4709 /* Set up iterator IT from overlay strings at its current position.
4710 Called from handle_stop. */
4712 static enum prop_handled
4713 handle_overlay_change (it
)
4716 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4717 return HANDLED_RECOMPUTE_PROPS
;
4719 return HANDLED_NORMALLY
;
4723 /* Set up the next overlay string for delivery by IT, if there is an
4724 overlay string to deliver. Called by set_iterator_to_next when the
4725 end of the current overlay string is reached. If there are more
4726 overlay strings to display, IT->string and
4727 IT->current.overlay_string_index are set appropriately here.
4728 Otherwise IT->string is set to nil. */
4731 next_overlay_string (it
)
4734 ++it
->current
.overlay_string_index
;
4735 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4737 /* No more overlay strings. Restore IT's settings to what
4738 they were before overlay strings were processed, and
4739 continue to deliver from current_buffer. */
4741 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4744 || (NILP (it
->string
)
4745 && it
->method
== GET_FROM_BUFFER
4746 && it
->stop_charpos
>= BEGV
4747 && it
->stop_charpos
<= it
->end_charpos
));
4748 it
->current
.overlay_string_index
= -1;
4749 it
->n_overlay_strings
= 0;
4751 /* If we're at the end of the buffer, record that we have
4752 processed the overlay strings there already, so that
4753 next_element_from_buffer doesn't try it again. */
4754 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4755 it
->overlay_strings_at_end_processed_p
= 1;
4759 /* There are more overlay strings to process. If
4760 IT->current.overlay_string_index has advanced to a position
4761 where we must load IT->overlay_strings with more strings, do
4763 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4765 if (it
->current
.overlay_string_index
&& i
== 0)
4766 load_overlay_strings (it
, 0);
4768 /* Initialize IT to deliver display elements from the overlay
4770 it
->string
= it
->overlay_strings
[i
];
4771 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4772 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4773 it
->method
= GET_FROM_STRING
;
4774 it
->stop_charpos
= 0;
4775 if (it
->cmp_it
.stop_pos
>= 0)
4776 it
->cmp_it
.stop_pos
= 0;
4783 /* Compare two overlay_entry structures E1 and E2. Used as a
4784 comparison function for qsort in load_overlay_strings. Overlay
4785 strings for the same position are sorted so that
4787 1. All after-strings come in front of before-strings, except
4788 when they come from the same overlay.
4790 2. Within after-strings, strings are sorted so that overlay strings
4791 from overlays with higher priorities come first.
4793 2. Within before-strings, strings are sorted so that overlay
4794 strings from overlays with higher priorities come last.
4796 Value is analogous to strcmp. */
4800 compare_overlay_entries (e1
, e2
)
4803 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4804 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4807 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4809 /* Let after-strings appear in front of before-strings if
4810 they come from different overlays. */
4811 if (EQ (entry1
->overlay
, entry2
->overlay
))
4812 result
= entry1
->after_string_p
? 1 : -1;
4814 result
= entry1
->after_string_p
? -1 : 1;
4816 else if (entry1
->after_string_p
)
4817 /* After-strings sorted in order of decreasing priority. */
4818 result
= entry2
->priority
- entry1
->priority
;
4820 /* Before-strings sorted in order of increasing priority. */
4821 result
= entry1
->priority
- entry2
->priority
;
4827 /* Load the vector IT->overlay_strings with overlay strings from IT's
4828 current buffer position, or from CHARPOS if that is > 0. Set
4829 IT->n_overlays to the total number of overlay strings found.
4831 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4832 a time. On entry into load_overlay_strings,
4833 IT->current.overlay_string_index gives the number of overlay
4834 strings that have already been loaded by previous calls to this
4837 IT->add_overlay_start contains an additional overlay start
4838 position to consider for taking overlay strings from, if non-zero.
4839 This position comes into play when the overlay has an `invisible'
4840 property, and both before and after-strings. When we've skipped to
4841 the end of the overlay, because of its `invisible' property, we
4842 nevertheless want its before-string to appear.
4843 IT->add_overlay_start will contain the overlay start position
4846 Overlay strings are sorted so that after-string strings come in
4847 front of before-string strings. Within before and after-strings,
4848 strings are sorted by overlay priority. See also function
4849 compare_overlay_entries. */
4852 load_overlay_strings (it
, charpos
)
4856 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4857 Lisp_Object overlay
, window
, str
, invisible
;
4858 struct Lisp_Overlay
*ov
;
4861 int n
= 0, i
, j
, invis_p
;
4862 struct overlay_entry
*entries
4863 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4866 charpos
= IT_CHARPOS (*it
);
4868 /* Append the overlay string STRING of overlay OVERLAY to vector
4869 `entries' which has size `size' and currently contains `n'
4870 elements. AFTER_P non-zero means STRING is an after-string of
4872 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4875 Lisp_Object priority; \
4879 int new_size = 2 * size; \
4880 struct overlay_entry *old = entries; \
4882 (struct overlay_entry *) alloca (new_size \
4883 * sizeof *entries); \
4884 bcopy (old, entries, size * sizeof *entries); \
4888 entries[n].string = (STRING); \
4889 entries[n].overlay = (OVERLAY); \
4890 priority = Foverlay_get ((OVERLAY), Qpriority); \
4891 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4892 entries[n].after_string_p = (AFTER_P); \
4897 /* Process overlay before the overlay center. */
4898 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4900 XSETMISC (overlay
, ov
);
4901 xassert (OVERLAYP (overlay
));
4902 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4903 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4908 /* Skip this overlay if it doesn't start or end at IT's current
4910 if (end
!= charpos
&& start
!= charpos
)
4913 /* Skip this overlay if it doesn't apply to IT->w. */
4914 window
= Foverlay_get (overlay
, Qwindow
);
4915 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4918 /* If the text ``under'' the overlay is invisible, both before-
4919 and after-strings from this overlay are visible; start and
4920 end position are indistinguishable. */
4921 invisible
= Foverlay_get (overlay
, Qinvisible
);
4922 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4924 /* If overlay has a non-empty before-string, record it. */
4925 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4926 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4928 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4930 /* If overlay has a non-empty after-string, record it. */
4931 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4932 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4934 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4937 /* Process overlays after the overlay center. */
4938 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4940 XSETMISC (overlay
, ov
);
4941 xassert (OVERLAYP (overlay
));
4942 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4943 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4945 if (start
> charpos
)
4948 /* Skip this overlay if it doesn't start or end at IT's current
4950 if (end
!= charpos
&& start
!= charpos
)
4953 /* Skip this overlay if it doesn't apply to IT->w. */
4954 window
= Foverlay_get (overlay
, Qwindow
);
4955 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4958 /* If the text ``under'' the overlay is invisible, it has a zero
4959 dimension, and both before- and after-strings apply. */
4960 invisible
= Foverlay_get (overlay
, Qinvisible
);
4961 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4963 /* If overlay has a non-empty before-string, record it. */
4964 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4965 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4967 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4969 /* If overlay has a non-empty after-string, record it. */
4970 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4971 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4973 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4976 #undef RECORD_OVERLAY_STRING
4980 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4982 /* Record the total number of strings to process. */
4983 it
->n_overlay_strings
= n
;
4985 /* IT->current.overlay_string_index is the number of overlay strings
4986 that have already been consumed by IT. Copy some of the
4987 remaining overlay strings to IT->overlay_strings. */
4989 j
= it
->current
.overlay_string_index
;
4990 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4992 it
->overlay_strings
[i
] = entries
[j
].string
;
4993 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5000 /* Get the first chunk of overlay strings at IT's current buffer
5001 position, or at CHARPOS if that is > 0. Value is non-zero if at
5002 least one overlay string was found. */
5005 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5010 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5011 process. This fills IT->overlay_strings with strings, and sets
5012 IT->n_overlay_strings to the total number of strings to process.
5013 IT->pos.overlay_string_index has to be set temporarily to zero
5014 because load_overlay_strings needs this; it must be set to -1
5015 when no overlay strings are found because a zero value would
5016 indicate a position in the first overlay string. */
5017 it
->current
.overlay_string_index
= 0;
5018 load_overlay_strings (it
, charpos
);
5020 /* If we found overlay strings, set up IT to deliver display
5021 elements from the first one. Otherwise set up IT to deliver
5022 from current_buffer. */
5023 if (it
->n_overlay_strings
)
5025 /* Make sure we know settings in current_buffer, so that we can
5026 restore meaningful values when we're done with the overlay
5029 compute_stop_pos (it
);
5030 xassert (it
->face_id
>= 0);
5032 /* Save IT's settings. They are restored after all overlay
5033 strings have been processed. */
5034 xassert (!compute_stop_p
|| it
->sp
== 0);
5037 /* Set up IT to deliver display elements from the first overlay
5039 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5040 it
->string
= it
->overlay_strings
[0];
5041 it
->from_overlay
= Qnil
;
5042 it
->stop_charpos
= 0;
5043 xassert (STRINGP (it
->string
));
5044 it
->end_charpos
= SCHARS (it
->string
);
5045 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5046 it
->method
= GET_FROM_STRING
;
5050 it
->current
.overlay_string_index
= -1;
5055 get_overlay_strings (it
, charpos
)
5060 it
->method
= GET_FROM_BUFFER
;
5062 (void) get_overlay_strings_1 (it
, charpos
, 1);
5066 /* Value is non-zero if we found at least one overlay string. */
5067 return STRINGP (it
->string
);
5072 /***********************************************************************
5073 Saving and restoring state
5074 ***********************************************************************/
5076 /* Save current settings of IT on IT->stack. Called, for example,
5077 before setting up IT for an overlay string, to be able to restore
5078 IT's settings to what they were after the overlay string has been
5085 struct iterator_stack_entry
*p
;
5087 xassert (it
->sp
< IT_STACK_SIZE
);
5088 p
= it
->stack
+ it
->sp
;
5090 p
->stop_charpos
= it
->stop_charpos
;
5091 p
->cmp_it
= it
->cmp_it
;
5092 xassert (it
->face_id
>= 0);
5093 p
->face_id
= it
->face_id
;
5094 p
->string
= it
->string
;
5095 p
->method
= it
->method
;
5096 p
->from_overlay
= it
->from_overlay
;
5099 case GET_FROM_IMAGE
:
5100 p
->u
.image
.object
= it
->object
;
5101 p
->u
.image
.image_id
= it
->image_id
;
5102 p
->u
.image
.slice
= it
->slice
;
5104 case GET_FROM_STRETCH
:
5105 p
->u
.stretch
.object
= it
->object
;
5108 p
->position
= it
->position
;
5109 p
->current
= it
->current
;
5110 p
->end_charpos
= it
->end_charpos
;
5111 p
->string_nchars
= it
->string_nchars
;
5113 p
->multibyte_p
= it
->multibyte_p
;
5114 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5115 p
->space_width
= it
->space_width
;
5116 p
->font_height
= it
->font_height
;
5117 p
->voffset
= it
->voffset
;
5118 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5119 p
->display_ellipsis_p
= 0;
5124 /* Restore IT's settings from IT->stack. Called, for example, when no
5125 more overlay strings must be processed, and we return to delivering
5126 display elements from a buffer, or when the end of a string from a
5127 `display' property is reached and we return to delivering display
5128 elements from an overlay string, or from a buffer. */
5134 struct iterator_stack_entry
*p
;
5136 xassert (it
->sp
> 0);
5138 p
= it
->stack
+ it
->sp
;
5139 it
->stop_charpos
= p
->stop_charpos
;
5140 it
->cmp_it
= p
->cmp_it
;
5141 it
->face_id
= p
->face_id
;
5142 it
->current
= p
->current
;
5143 it
->position
= p
->position
;
5144 it
->string
= p
->string
;
5145 it
->from_overlay
= p
->from_overlay
;
5146 if (NILP (it
->string
))
5147 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5148 it
->method
= p
->method
;
5151 case GET_FROM_IMAGE
:
5152 it
->image_id
= p
->u
.image
.image_id
;
5153 it
->object
= p
->u
.image
.object
;
5154 it
->slice
= p
->u
.image
.slice
;
5156 case GET_FROM_STRETCH
:
5157 it
->object
= p
->u
.comp
.object
;
5159 case GET_FROM_BUFFER
:
5160 it
->object
= it
->w
->buffer
;
5162 case GET_FROM_STRING
:
5163 it
->object
= it
->string
;
5166 it
->end_charpos
= p
->end_charpos
;
5167 it
->string_nchars
= p
->string_nchars
;
5169 it
->multibyte_p
= p
->multibyte_p
;
5170 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5171 it
->space_width
= p
->space_width
;
5172 it
->font_height
= p
->font_height
;
5173 it
->voffset
= p
->voffset
;
5174 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5179 /***********************************************************************
5181 ***********************************************************************/
5183 /* Set IT's current position to the previous line start. */
5186 back_to_previous_line_start (it
)
5189 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5190 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5194 /* Move IT to the next line start.
5196 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5197 we skipped over part of the text (as opposed to moving the iterator
5198 continuously over the text). Otherwise, don't change the value
5201 Newlines may come from buffer text, overlay strings, or strings
5202 displayed via the `display' property. That's the reason we can't
5203 simply use find_next_newline_no_quit.
5205 Note that this function may not skip over invisible text that is so
5206 because of text properties and immediately follows a newline. If
5207 it would, function reseat_at_next_visible_line_start, when called
5208 from set_iterator_to_next, would effectively make invisible
5209 characters following a newline part of the wrong glyph row, which
5210 leads to wrong cursor motion. */
5213 forward_to_next_line_start (it
, skipped_p
)
5217 int old_selective
, newline_found_p
, n
;
5218 const int MAX_NEWLINE_DISTANCE
= 500;
5220 /* If already on a newline, just consume it to avoid unintended
5221 skipping over invisible text below. */
5222 if (it
->what
== IT_CHARACTER
5224 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5226 set_iterator_to_next (it
, 0);
5231 /* Don't handle selective display in the following. It's (a)
5232 unnecessary because it's done by the caller, and (b) leads to an
5233 infinite recursion because next_element_from_ellipsis indirectly
5234 calls this function. */
5235 old_selective
= it
->selective
;
5238 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5239 from buffer text. */
5240 for (n
= newline_found_p
= 0;
5241 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5242 n
+= STRINGP (it
->string
) ? 0 : 1)
5244 if (!get_next_display_element (it
))
5246 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5247 set_iterator_to_next (it
, 0);
5250 /* If we didn't find a newline near enough, see if we can use a
5252 if (!newline_found_p
)
5254 int start
= IT_CHARPOS (*it
);
5255 int limit
= find_next_newline_no_quit (start
, 1);
5258 xassert (!STRINGP (it
->string
));
5260 /* If there isn't any `display' property in sight, and no
5261 overlays, we can just use the position of the newline in
5263 if (it
->stop_charpos
>= limit
5264 || ((pos
= Fnext_single_property_change (make_number (start
),
5266 Qnil
, make_number (limit
)),
5268 && next_overlay_change (start
) == ZV
))
5270 IT_CHARPOS (*it
) = limit
;
5271 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5272 *skipped_p
= newline_found_p
= 1;
5276 while (get_next_display_element (it
)
5277 && !newline_found_p
)
5279 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5280 set_iterator_to_next (it
, 0);
5285 it
->selective
= old_selective
;
5286 return newline_found_p
;
5290 /* Set IT's current position to the previous visible line start. Skip
5291 invisible text that is so either due to text properties or due to
5292 selective display. Caution: this does not change IT->current_x and
5296 back_to_previous_visible_line_start (it
)
5299 while (IT_CHARPOS (*it
) > BEGV
)
5301 back_to_previous_line_start (it
);
5303 if (IT_CHARPOS (*it
) <= BEGV
)
5306 /* If selective > 0, then lines indented more than that values
5308 if (it
->selective
> 0
5309 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5310 (double) it
->selective
)) /* iftc */
5313 /* Check the newline before point for invisibility. */
5316 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5317 Qinvisible
, it
->window
);
5318 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5322 if (IT_CHARPOS (*it
) <= BEGV
)
5329 Lisp_Object val
, overlay
;
5331 /* If newline is part of a composition, continue from start of composition */
5332 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5333 && beg
< IT_CHARPOS (*it
))
5336 /* If newline is replaced by a display property, find start of overlay
5337 or interval and continue search from that point. */
5339 pos
= --IT_CHARPOS (it2
);
5342 it2
.string_from_display_prop_p
= 0;
5343 if (handle_display_prop (&it2
) == HANDLED_RETURN
5344 && !NILP (val
= get_char_property_and_overlay
5345 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5346 && (OVERLAYP (overlay
)
5347 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5348 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5351 /* Newline is not replaced by anything -- so we are done. */
5357 IT_CHARPOS (*it
) = beg
;
5358 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5362 it
->continuation_lines_width
= 0;
5364 xassert (IT_CHARPOS (*it
) >= BEGV
);
5365 xassert (IT_CHARPOS (*it
) == BEGV
5366 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5371 /* Reseat iterator IT at the previous visible line start. Skip
5372 invisible text that is so either due to text properties or due to
5373 selective display. At the end, update IT's overlay information,
5374 face information etc. */
5377 reseat_at_previous_visible_line_start (it
)
5380 back_to_previous_visible_line_start (it
);
5381 reseat (it
, it
->current
.pos
, 1);
5386 /* Reseat iterator IT on the next visible line start in the current
5387 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5388 preceding the line start. Skip over invisible text that is so
5389 because of selective display. Compute faces, overlays etc at the
5390 new position. Note that this function does not skip over text that
5391 is invisible because of text properties. */
5394 reseat_at_next_visible_line_start (it
, on_newline_p
)
5398 int newline_found_p
, skipped_p
= 0;
5400 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5402 /* Skip over lines that are invisible because they are indented
5403 more than the value of IT->selective. */
5404 if (it
->selective
> 0)
5405 while (IT_CHARPOS (*it
) < ZV
5406 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5407 (double) it
->selective
)) /* iftc */
5409 xassert (IT_BYTEPOS (*it
) == BEGV
5410 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5411 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5414 /* Position on the newline if that's what's requested. */
5415 if (on_newline_p
&& newline_found_p
)
5417 if (STRINGP (it
->string
))
5419 if (IT_STRING_CHARPOS (*it
) > 0)
5421 --IT_STRING_CHARPOS (*it
);
5422 --IT_STRING_BYTEPOS (*it
);
5425 else if (IT_CHARPOS (*it
) > BEGV
)
5429 reseat (it
, it
->current
.pos
, 0);
5433 reseat (it
, it
->current
.pos
, 0);
5440 /***********************************************************************
5441 Changing an iterator's position
5442 ***********************************************************************/
5444 /* Change IT's current position to POS in current_buffer. If FORCE_P
5445 is non-zero, always check for text properties at the new position.
5446 Otherwise, text properties are only looked up if POS >=
5447 IT->check_charpos of a property. */
5450 reseat (it
, pos
, force_p
)
5452 struct text_pos pos
;
5455 int original_pos
= IT_CHARPOS (*it
);
5457 reseat_1 (it
, pos
, 0);
5459 /* Determine where to check text properties. Avoid doing it
5460 where possible because text property lookup is very expensive. */
5462 || CHARPOS (pos
) > it
->stop_charpos
5463 || CHARPOS (pos
) < original_pos
)
5470 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5471 IT->stop_pos to POS, also. */
5474 reseat_1 (it
, pos
, set_stop_p
)
5476 struct text_pos pos
;
5479 /* Don't call this function when scanning a C string. */
5480 xassert (it
->s
== NULL
);
5482 /* POS must be a reasonable value. */
5483 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5485 it
->current
.pos
= it
->position
= pos
;
5486 it
->end_charpos
= ZV
;
5488 it
->current
.dpvec_index
= -1;
5489 it
->current
.overlay_string_index
= -1;
5490 IT_STRING_CHARPOS (*it
) = -1;
5491 IT_STRING_BYTEPOS (*it
) = -1;
5493 it
->string_from_display_prop_p
= 0;
5494 it
->method
= GET_FROM_BUFFER
;
5495 it
->object
= it
->w
->buffer
;
5496 it
->area
= TEXT_AREA
;
5497 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5499 it
->string_from_display_prop_p
= 0;
5500 it
->face_before_selective_p
= 0;
5503 it
->stop_charpos
= CHARPOS (pos
);
5507 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5508 If S is non-null, it is a C string to iterate over. Otherwise,
5509 STRING gives a Lisp string to iterate over.
5511 If PRECISION > 0, don't return more then PRECISION number of
5512 characters from the string.
5514 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5515 characters have been returned. FIELD_WIDTH < 0 means an infinite
5518 MULTIBYTE = 0 means disable processing of multibyte characters,
5519 MULTIBYTE > 0 means enable it,
5520 MULTIBYTE < 0 means use IT->multibyte_p.
5522 IT must be initialized via a prior call to init_iterator before
5523 calling this function. */
5526 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5531 int precision
, field_width
, multibyte
;
5533 /* No region in strings. */
5534 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5536 /* No text property checks performed by default, but see below. */
5537 it
->stop_charpos
= -1;
5539 /* Set iterator position and end position. */
5540 bzero (&it
->current
, sizeof it
->current
);
5541 it
->current
.overlay_string_index
= -1;
5542 it
->current
.dpvec_index
= -1;
5543 xassert (charpos
>= 0);
5545 /* If STRING is specified, use its multibyteness, otherwise use the
5546 setting of MULTIBYTE, if specified. */
5548 it
->multibyte_p
= multibyte
> 0;
5552 xassert (STRINGP (string
));
5553 it
->string
= string
;
5555 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5556 it
->method
= GET_FROM_STRING
;
5557 it
->current
.string_pos
= string_pos (charpos
, string
);
5564 /* Note that we use IT->current.pos, not it->current.string_pos,
5565 for displaying C strings. */
5566 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5567 if (it
->multibyte_p
)
5569 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5570 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5574 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5575 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5578 it
->method
= GET_FROM_C_STRING
;
5581 /* PRECISION > 0 means don't return more than PRECISION characters
5583 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5584 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5586 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5587 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5588 FIELD_WIDTH < 0 means infinite field width. This is useful for
5589 padding with `-' at the end of a mode line. */
5590 if (field_width
< 0)
5591 field_width
= INFINITY
;
5592 if (field_width
> it
->end_charpos
- charpos
)
5593 it
->end_charpos
= charpos
+ field_width
;
5595 /* Use the standard display table for displaying strings. */
5596 if (DISP_TABLE_P (Vstandard_display_table
))
5597 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5599 it
->stop_charpos
= charpos
;
5605 /***********************************************************************
5607 ***********************************************************************/
5609 /* Map enum it_method value to corresponding next_element_from_* function. */
5611 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5613 next_element_from_buffer
,
5614 next_element_from_display_vector
,
5615 next_element_from_string
,
5616 next_element_from_c_string
,
5617 next_element_from_image
,
5618 next_element_from_stretch
5621 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5624 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5625 (possibly with the following characters). */
5627 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS) \
5628 ((IT)->cmp_it.id >= 0 \
5629 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5630 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5631 (IT)->end_charpos, (IT)->w, \
5632 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5636 /* Load IT's display element fields with information about the next
5637 display element from the current position of IT. Value is zero if
5638 end of buffer (or C string) is reached. */
5640 static struct frame
*last_escape_glyph_frame
= NULL
;
5641 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5642 static int last_escape_glyph_merged_face_id
= 0;
5645 get_next_display_element (it
)
5648 /* Non-zero means that we found a display element. Zero means that
5649 we hit the end of what we iterate over. Performance note: the
5650 function pointer `method' used here turns out to be faster than
5651 using a sequence of if-statements. */
5655 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5657 if (it
->what
== IT_CHARACTER
)
5659 /* Map via display table or translate control characters.
5660 IT->c, IT->len etc. have been set to the next character by
5661 the function call above. If we have a display table, and it
5662 contains an entry for IT->c, translate it. Don't do this if
5663 IT->c itself comes from a display table, otherwise we could
5664 end up in an infinite recursion. (An alternative could be to
5665 count the recursion depth of this function and signal an
5666 error when a certain maximum depth is reached.) Is it worth
5668 if (success_p
&& it
->dpvec
== NULL
)
5673 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5676 struct Lisp_Vector
*v
= XVECTOR (dv
);
5678 /* Return the first character from the display table
5679 entry, if not empty. If empty, don't display the
5680 current character. */
5683 it
->dpvec_char_len
= it
->len
;
5684 it
->dpvec
= v
->contents
;
5685 it
->dpend
= v
->contents
+ v
->size
;
5686 it
->current
.dpvec_index
= 0;
5687 it
->dpvec_face_id
= -1;
5688 it
->saved_face_id
= it
->face_id
;
5689 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5694 set_iterator_to_next (it
, 0);
5699 /* Translate control characters into `\003' or `^C' form.
5700 Control characters coming from a display table entry are
5701 currently not translated because we use IT->dpvec to hold
5702 the translation. This could easily be changed but I
5703 don't believe that it is worth doing.
5705 If it->multibyte_p is nonzero, non-printable non-ASCII
5706 characters are also translated to octal form.
5708 If it->multibyte_p is zero, eight-bit characters that
5709 don't have corresponding multibyte char code are also
5710 translated to octal form. */
5711 else if ((it
->c
< ' '
5712 ? (it
->area
!= TEXT_AREA
5713 /* In mode line, treat \n, \t like other crl chars. */
5715 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5716 || (it
->c
!= '\n' && it
->c
!= '\t'))
5718 ? (!CHAR_PRINTABLE_P (it
->c
)
5719 || (!NILP (Vnobreak_char_display
)
5720 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5721 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5723 && (! unibyte_display_via_language_environment
5724 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5726 /* IT->c is a control character which must be displayed
5727 either as '\003' or as `^C' where the '\\' and '^'
5728 can be defined in the display table. Fill
5729 IT->ctl_chars with glyphs for what we have to
5730 display. Then, set IT->dpvec to these glyphs. */
5733 int face_id
, lface_id
= 0 ;
5736 /* Handle control characters with ^. */
5738 if (it
->c
< 128 && it
->ctl_arrow_p
)
5742 g
= '^'; /* default glyph for Control */
5743 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5745 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5746 && GLYPH_CODE_CHAR_VALID_P (gc
))
5748 g
= GLYPH_CODE_CHAR (gc
);
5749 lface_id
= GLYPH_CODE_FACE (gc
);
5753 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5755 else if (it
->f
== last_escape_glyph_frame
5756 && it
->face_id
== last_escape_glyph_face_id
)
5758 face_id
= last_escape_glyph_merged_face_id
;
5762 /* Merge the escape-glyph face into the current face. */
5763 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5765 last_escape_glyph_frame
= it
->f
;
5766 last_escape_glyph_face_id
= it
->face_id
;
5767 last_escape_glyph_merged_face_id
= face_id
;
5770 XSETINT (it
->ctl_chars
[0], g
);
5771 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5773 goto display_control
;
5776 /* Handle non-break space in the mode where it only gets
5779 if (EQ (Vnobreak_char_display
, Qt
)
5782 /* Merge the no-break-space face into the current face. */
5783 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5787 XSETINT (it
->ctl_chars
[0], ' ');
5789 goto display_control
;
5792 /* Handle sequences that start with the "escape glyph". */
5794 /* the default escape glyph is \. */
5795 escape_glyph
= '\\';
5798 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5799 && GLYPH_CODE_CHAR_VALID_P (gc
))
5801 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5802 lface_id
= GLYPH_CODE_FACE (gc
);
5806 /* The display table specified a face.
5807 Merge it into face_id and also into escape_glyph. */
5808 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5811 else if (it
->f
== last_escape_glyph_frame
5812 && it
->face_id
== last_escape_glyph_face_id
)
5814 face_id
= last_escape_glyph_merged_face_id
;
5818 /* Merge the escape-glyph face into the current face. */
5819 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5821 last_escape_glyph_frame
= it
->f
;
5822 last_escape_glyph_face_id
= it
->face_id
;
5823 last_escape_glyph_merged_face_id
= face_id
;
5826 /* Handle soft hyphens in the mode where they only get
5829 if (EQ (Vnobreak_char_display
, Qt
)
5833 XSETINT (it
->ctl_chars
[0], '-');
5835 goto display_control
;
5838 /* Handle non-break space and soft hyphen
5839 with the escape glyph. */
5841 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5843 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5844 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5845 XSETINT (it
->ctl_chars
[1], it
->c
);
5847 goto display_control
;
5851 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5855 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5856 if (CHAR_BYTE8_P (it
->c
))
5858 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5861 else if (it
->c
< 256)
5868 /* It's an invalid character, which shouldn't
5869 happen actually, but due to bugs it may
5870 happen. Let's print the char as is, there's
5871 not much meaningful we can do with it. */
5873 str
[1] = it
->c
>> 8;
5874 str
[2] = it
->c
>> 16;
5875 str
[3] = it
->c
>> 24;
5879 for (i
= 0; i
< len
; i
++)
5882 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5883 /* Insert three more glyphs into IT->ctl_chars for
5884 the octal display of the character. */
5885 g
= ((str
[i
] >> 6) & 7) + '0';
5886 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5887 g
= ((str
[i
] >> 3) & 7) + '0';
5888 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5889 g
= (str
[i
] & 7) + '0';
5890 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5896 /* Set up IT->dpvec and return first character from it. */
5897 it
->dpvec_char_len
= it
->len
;
5898 it
->dpvec
= it
->ctl_chars
;
5899 it
->dpend
= it
->dpvec
+ ctl_len
;
5900 it
->current
.dpvec_index
= 0;
5901 it
->dpvec_face_id
= face_id
;
5902 it
->saved_face_id
= it
->face_id
;
5903 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5910 #ifdef HAVE_WINDOW_SYSTEM
5911 /* Adjust face id for a multibyte character. There are no multibyte
5912 character in unibyte text. */
5913 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5916 && FRAME_WINDOW_P (it
->f
))
5918 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5920 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5922 /* Automatic composition with glyph-string. */
5923 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5925 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5929 int pos
= (it
->s
? -1
5930 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5931 : IT_CHARPOS (*it
));
5933 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
5938 /* Is this character the last one of a run of characters with
5939 box? If yes, set IT->end_of_box_run_p to 1. */
5943 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5945 int face_id
= underlying_face_id (it
);
5946 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5950 if (face
->box
== FACE_NO_BOX
)
5952 /* If the box comes from face properties in a
5953 display string, check faces in that string. */
5954 int string_face_id
= face_after_it_pos (it
);
5955 it
->end_of_box_run_p
5956 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5959 /* Otherwise, the box comes from the underlying face.
5960 If this is the last string character displayed, check
5961 the next buffer location. */
5962 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5963 && (it
->current
.overlay_string_index
5964 == it
->n_overlay_strings
- 1))
5968 struct text_pos pos
= it
->current
.pos
;
5969 INC_TEXT_POS (pos
, it
->multibyte_p
);
5971 next_face_id
= face_at_buffer_position
5972 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5973 it
->region_end_charpos
, &ignore
,
5974 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0);
5975 it
->end_of_box_run_p
5976 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5983 int face_id
= face_after_it_pos (it
);
5984 it
->end_of_box_run_p
5985 = (face_id
!= it
->face_id
5986 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5990 /* Value is 0 if end of buffer or string reached. */
5995 /* Move IT to the next display element.
5997 RESEAT_P non-zero means if called on a newline in buffer text,
5998 skip to the next visible line start.
6000 Functions get_next_display_element and set_iterator_to_next are
6001 separate because I find this arrangement easier to handle than a
6002 get_next_display_element function that also increments IT's
6003 position. The way it is we can first look at an iterator's current
6004 display element, decide whether it fits on a line, and if it does,
6005 increment the iterator position. The other way around we probably
6006 would either need a flag indicating whether the iterator has to be
6007 incremented the next time, or we would have to implement a
6008 decrement position function which would not be easy to write. */
6011 set_iterator_to_next (it
, reseat_p
)
6015 /* Reset flags indicating start and end of a sequence of characters
6016 with box. Reset them at the start of this function because
6017 moving the iterator to a new position might set them. */
6018 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6022 case GET_FROM_BUFFER
:
6023 /* The current display element of IT is a character from
6024 current_buffer. Advance in the buffer, and maybe skip over
6025 invisible lines that are so because of selective display. */
6026 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6027 reseat_at_next_visible_line_start (it
, 0);
6028 else if (it
->cmp_it
.id
>= 0)
6030 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6031 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6032 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6033 it
->cmp_it
.from
= it
->cmp_it
.to
;
6037 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6038 IT_BYTEPOS (*it
), it
->stop_charpos
,
6044 xassert (it
->len
!= 0);
6045 IT_BYTEPOS (*it
) += it
->len
;
6046 IT_CHARPOS (*it
) += 1;
6047 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6051 case GET_FROM_C_STRING
:
6052 /* Current display element of IT is from a C string. */
6053 IT_BYTEPOS (*it
) += it
->len
;
6054 IT_CHARPOS (*it
) += 1;
6057 case GET_FROM_DISPLAY_VECTOR
:
6058 /* Current display element of IT is from a display table entry.
6059 Advance in the display table definition. Reset it to null if
6060 end reached, and continue with characters from buffers/
6062 ++it
->current
.dpvec_index
;
6064 /* Restore face of the iterator to what they were before the
6065 display vector entry (these entries may contain faces). */
6066 it
->face_id
= it
->saved_face_id
;
6068 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6070 int recheck_faces
= it
->ellipsis_p
;
6073 it
->method
= GET_FROM_C_STRING
;
6074 else if (STRINGP (it
->string
))
6075 it
->method
= GET_FROM_STRING
;
6078 it
->method
= GET_FROM_BUFFER
;
6079 it
->object
= it
->w
->buffer
;
6083 it
->current
.dpvec_index
= -1;
6085 /* Skip over characters which were displayed via IT->dpvec. */
6086 if (it
->dpvec_char_len
< 0)
6087 reseat_at_next_visible_line_start (it
, 1);
6088 else if (it
->dpvec_char_len
> 0)
6090 if (it
->method
== GET_FROM_STRING
6091 && it
->n_overlay_strings
> 0)
6092 it
->ignore_overlay_strings_at_pos_p
= 1;
6093 it
->len
= it
->dpvec_char_len
;
6094 set_iterator_to_next (it
, reseat_p
);
6097 /* Maybe recheck faces after display vector */
6099 it
->stop_charpos
= IT_CHARPOS (*it
);
6103 case GET_FROM_STRING
:
6104 /* Current display element is a character from a Lisp string. */
6105 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6106 if (it
->cmp_it
.id
>= 0)
6108 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6109 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6110 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6111 it
->cmp_it
.from
= it
->cmp_it
.to
;
6115 composition_compute_stop_pos (&it
->cmp_it
,
6116 IT_STRING_CHARPOS (*it
),
6117 IT_STRING_BYTEPOS (*it
),
6118 it
->stop_charpos
, it
->string
);
6123 IT_STRING_BYTEPOS (*it
) += it
->len
;
6124 IT_STRING_CHARPOS (*it
) += 1;
6127 consider_string_end
:
6129 if (it
->current
.overlay_string_index
>= 0)
6131 /* IT->string is an overlay string. Advance to the
6132 next, if there is one. */
6133 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6136 next_overlay_string (it
);
6138 setup_for_ellipsis (it
, 0);
6143 /* IT->string is not an overlay string. If we reached
6144 its end, and there is something on IT->stack, proceed
6145 with what is on the stack. This can be either another
6146 string, this time an overlay string, or a buffer. */
6147 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6151 if (it
->method
== GET_FROM_STRING
)
6152 goto consider_string_end
;
6157 case GET_FROM_IMAGE
:
6158 case GET_FROM_STRETCH
:
6159 /* The position etc with which we have to proceed are on
6160 the stack. The position may be at the end of a string,
6161 if the `display' property takes up the whole string. */
6162 xassert (it
->sp
> 0);
6164 if (it
->method
== GET_FROM_STRING
)
6165 goto consider_string_end
;
6169 /* There are no other methods defined, so this should be a bug. */
6173 xassert (it
->method
!= GET_FROM_STRING
6174 || (STRINGP (it
->string
)
6175 && IT_STRING_CHARPOS (*it
) >= 0));
6178 /* Load IT's display element fields with information about the next
6179 display element which comes from a display table entry or from the
6180 result of translating a control character to one of the forms `^C'
6183 IT->dpvec holds the glyphs to return as characters.
6184 IT->saved_face_id holds the face id before the display vector--
6185 it is restored into IT->face_idin set_iterator_to_next. */
6188 next_element_from_display_vector (it
)
6194 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6196 it
->face_id
= it
->saved_face_id
;
6198 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6199 That seemed totally bogus - so I changed it... */
6200 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6202 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6204 it
->c
= GLYPH_CODE_CHAR (gc
);
6205 it
->len
= CHAR_BYTES (it
->c
);
6207 /* The entry may contain a face id to use. Such a face id is
6208 the id of a Lisp face, not a realized face. A face id of
6209 zero means no face is specified. */
6210 if (it
->dpvec_face_id
>= 0)
6211 it
->face_id
= it
->dpvec_face_id
;
6214 int lface_id
= GLYPH_CODE_FACE (gc
);
6216 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6221 /* Display table entry is invalid. Return a space. */
6222 it
->c
= ' ', it
->len
= 1;
6224 /* Don't change position and object of the iterator here. They are
6225 still the values of the character that had this display table
6226 entry or was translated, and that's what we want. */
6227 it
->what
= IT_CHARACTER
;
6232 /* Load IT with the next display element from Lisp string IT->string.
6233 IT->current.string_pos is the current position within the string.
6234 If IT->current.overlay_string_index >= 0, the Lisp string is an
6238 next_element_from_string (it
)
6241 struct text_pos position
;
6243 xassert (STRINGP (it
->string
));
6244 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6245 position
= it
->current
.string_pos
;
6247 /* Time to check for invisible text? */
6248 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6249 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6253 /* Since a handler may have changed IT->method, we must
6255 return GET_NEXT_DISPLAY_ELEMENT (it
);
6258 if (it
->current
.overlay_string_index
>= 0)
6260 /* Get the next character from an overlay string. In overlay
6261 strings, There is no field width or padding with spaces to
6263 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6268 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6269 IT_STRING_BYTEPOS (*it
))
6270 && next_element_from_composition (it
))
6274 else if (STRING_MULTIBYTE (it
->string
))
6276 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6277 const unsigned char *s
= (SDATA (it
->string
)
6278 + IT_STRING_BYTEPOS (*it
));
6279 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6283 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6289 /* Get the next character from a Lisp string that is not an
6290 overlay string. Such strings come from the mode line, for
6291 example. We may have to pad with spaces, or truncate the
6292 string. See also next_element_from_c_string. */
6293 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6298 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6300 /* Pad with spaces. */
6301 it
->c
= ' ', it
->len
= 1;
6302 CHARPOS (position
) = BYTEPOS (position
) = -1;
6304 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6305 IT_STRING_BYTEPOS (*it
))
6306 && next_element_from_composition (it
))
6310 else if (STRING_MULTIBYTE (it
->string
))
6312 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6313 const unsigned char *s
= (SDATA (it
->string
)
6314 + IT_STRING_BYTEPOS (*it
));
6315 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6319 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6324 /* Record what we have and where it came from. */
6325 it
->what
= IT_CHARACTER
;
6326 it
->object
= it
->string
;
6327 it
->position
= position
;
6332 /* Load IT with next display element from C string IT->s.
6333 IT->string_nchars is the maximum number of characters to return
6334 from the string. IT->end_charpos may be greater than
6335 IT->string_nchars when this function is called, in which case we
6336 may have to return padding spaces. Value is zero if end of string
6337 reached, including padding spaces. */
6340 next_element_from_c_string (it
)
6346 it
->what
= IT_CHARACTER
;
6347 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6350 /* IT's position can be greater IT->string_nchars in case a field
6351 width or precision has been specified when the iterator was
6353 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6355 /* End of the game. */
6359 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6361 /* Pad with spaces. */
6362 it
->c
= ' ', it
->len
= 1;
6363 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6365 else if (it
->multibyte_p
)
6367 /* Implementation note: The calls to strlen apparently aren't a
6368 performance problem because there is no noticeable performance
6369 difference between Emacs running in unibyte or multibyte mode. */
6370 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6371 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6375 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6381 /* Set up IT to return characters from an ellipsis, if appropriate.
6382 The definition of the ellipsis glyphs may come from a display table
6383 entry. This function Fills IT with the first glyph from the
6384 ellipsis if an ellipsis is to be displayed. */
6387 next_element_from_ellipsis (it
)
6390 if (it
->selective_display_ellipsis_p
)
6391 setup_for_ellipsis (it
, it
->len
);
6394 /* The face at the current position may be different from the
6395 face we find after the invisible text. Remember what it
6396 was in IT->saved_face_id, and signal that it's there by
6397 setting face_before_selective_p. */
6398 it
->saved_face_id
= it
->face_id
;
6399 it
->method
= GET_FROM_BUFFER
;
6400 it
->object
= it
->w
->buffer
;
6401 reseat_at_next_visible_line_start (it
, 1);
6402 it
->face_before_selective_p
= 1;
6405 return GET_NEXT_DISPLAY_ELEMENT (it
);
6409 /* Deliver an image display element. The iterator IT is already
6410 filled with image information (done in handle_display_prop). Value
6415 next_element_from_image (it
)
6418 it
->what
= IT_IMAGE
;
6423 /* Fill iterator IT with next display element from a stretch glyph
6424 property. IT->object is the value of the text property. Value is
6428 next_element_from_stretch (it
)
6431 it
->what
= IT_STRETCH
;
6436 /* Load IT with the next display element from current_buffer. Value
6437 is zero if end of buffer reached. IT->stop_charpos is the next
6438 position at which to stop and check for text properties or buffer
6442 next_element_from_buffer (it
)
6447 /* Check this assumption, otherwise, we would never enter the
6448 if-statement, below. */
6449 xassert (IT_CHARPOS (*it
) >= BEGV
6450 && IT_CHARPOS (*it
) <= it
->stop_charpos
);
6452 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6454 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6456 int overlay_strings_follow_p
;
6458 /* End of the game, except when overlay strings follow that
6459 haven't been returned yet. */
6460 if (it
->overlay_strings_at_end_processed_p
)
6461 overlay_strings_follow_p
= 0;
6464 it
->overlay_strings_at_end_processed_p
= 1;
6465 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6468 if (overlay_strings_follow_p
)
6469 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6473 it
->position
= it
->current
.pos
;
6480 return GET_NEXT_DISPLAY_ELEMENT (it
);
6485 /* No face changes, overlays etc. in sight, so just return a
6486 character from current_buffer. */
6489 /* Maybe run the redisplay end trigger hook. Performance note:
6490 This doesn't seem to cost measurable time. */
6491 if (it
->redisplay_end_trigger_charpos
6493 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6494 run_redisplay_end_trigger_hook (it
);
6496 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
))
6497 && next_element_from_composition (it
))
6502 /* Get the next character, maybe multibyte. */
6503 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6504 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6505 it
->c
= STRING_CHAR_AND_LENGTH (p
, 0, it
->len
);
6507 it
->c
= *p
, it
->len
= 1;
6509 /* Record what we have and where it came from. */
6510 it
->what
= IT_CHARACTER
;
6511 it
->object
= it
->w
->buffer
;
6512 it
->position
= it
->current
.pos
;
6514 /* Normally we return the character found above, except when we
6515 really want to return an ellipsis for selective display. */
6520 /* A value of selective > 0 means hide lines indented more
6521 than that number of columns. */
6522 if (it
->selective
> 0
6523 && IT_CHARPOS (*it
) + 1 < ZV
6524 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6525 IT_BYTEPOS (*it
) + 1,
6526 (double) it
->selective
)) /* iftc */
6528 success_p
= next_element_from_ellipsis (it
);
6529 it
->dpvec_char_len
= -1;
6532 else if (it
->c
== '\r' && it
->selective
== -1)
6534 /* A value of selective == -1 means that everything from the
6535 CR to the end of the line is invisible, with maybe an
6536 ellipsis displayed for it. */
6537 success_p
= next_element_from_ellipsis (it
);
6538 it
->dpvec_char_len
= -1;
6543 /* Value is zero if end of buffer reached. */
6544 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6549 /* Run the redisplay end trigger hook for IT. */
6552 run_redisplay_end_trigger_hook (it
)
6555 Lisp_Object args
[3];
6557 /* IT->glyph_row should be non-null, i.e. we should be actually
6558 displaying something, or otherwise we should not run the hook. */
6559 xassert (it
->glyph_row
);
6561 /* Set up hook arguments. */
6562 args
[0] = Qredisplay_end_trigger_functions
;
6563 args
[1] = it
->window
;
6564 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6565 it
->redisplay_end_trigger_charpos
= 0;
6567 /* Since we are *trying* to run these functions, don't try to run
6568 them again, even if they get an error. */
6569 it
->w
->redisplay_end_trigger
= Qnil
;
6570 Frun_hook_with_args (3, args
);
6572 /* Notice if it changed the face of the character we are on. */
6573 handle_face_prop (it
);
6577 /* Deliver a composition display element. Unlike the other
6578 next_element_from_XXX, this function is not registered in the array
6579 get_next_element[]. It is called from next_element_from_buffer and
6580 next_element_from_string when necessary. */
6583 next_element_from_composition (it
)
6586 it
->what
= IT_COMPOSITION
;
6587 it
->len
= it
->cmp_it
.nbytes
;
6588 if (STRINGP (it
->string
))
6592 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6593 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6596 it
->position
= it
->current
.string_pos
;
6597 it
->object
= it
->string
;
6598 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6599 IT_STRING_BYTEPOS (*it
), it
->string
);
6605 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6606 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6609 it
->position
= it
->current
.pos
;
6610 it
->object
= it
->w
->buffer
;
6611 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6612 IT_BYTEPOS (*it
), Qnil
);
6619 /***********************************************************************
6620 Moving an iterator without producing glyphs
6621 ***********************************************************************/
6623 /* Check if iterator is at a position corresponding to a valid buffer
6624 position after some move_it_ call. */
6626 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6627 ((it)->method == GET_FROM_STRING \
6628 ? IT_STRING_CHARPOS (*it) == 0 \
6632 /* Move iterator IT to a specified buffer or X position within one
6633 line on the display without producing glyphs.
6635 OP should be a bit mask including some or all of these bits:
6636 MOVE_TO_X: Stop on reaching x-position TO_X.
6637 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6638 Regardless of OP's value, stop in reaching the end of the display line.
6640 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6641 This means, in particular, that TO_X includes window's horizontal
6644 The return value has several possible values that
6645 say what condition caused the scan to stop:
6647 MOVE_POS_MATCH_OR_ZV
6648 - when TO_POS or ZV was reached.
6651 -when TO_X was reached before TO_POS or ZV were reached.
6654 - when we reached the end of the display area and the line must
6658 - when we reached the end of the display area and the line is
6662 - when we stopped at a line end, i.e. a newline or a CR and selective
6665 static enum move_it_result
6666 move_it_in_display_line_to (struct it
*it
,
6667 EMACS_INT to_charpos
, int to_x
,
6668 enum move_operation_enum op
)
6670 enum move_it_result result
= MOVE_UNDEFINED
;
6671 struct glyph_row
*saved_glyph_row
;
6672 struct it wrap_it
, atpos_it
, atx_it
;
6675 /* Don't produce glyphs in produce_glyphs. */
6676 saved_glyph_row
= it
->glyph_row
;
6677 it
->glyph_row
= NULL
;
6679 /* Use wrap_it to save a copy of IT wherever a word wrap could
6680 occur. Use atpos_it to save a copy of IT at the desired buffer
6681 position, if found, so that we can scan ahead and check if the
6682 word later overshoots the window edge. Use atx_it similarly, for
6688 #define BUFFER_POS_REACHED_P() \
6689 ((op & MOVE_TO_POS) != 0 \
6690 && BUFFERP (it->object) \
6691 && IT_CHARPOS (*it) >= to_charpos \
6692 && (it->method == GET_FROM_BUFFER \
6693 || (it->method == GET_FROM_DISPLAY_VECTOR \
6694 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6696 /* If there's a line-/wrap-prefix, handle it. */
6697 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6698 && it
->current_y
< it
->last_visible_y
)
6699 handle_line_prefix (it
);
6703 int x
, i
, ascent
= 0, descent
= 0;
6705 /* Utility macro to reset an iterator with x, ascent, and descent. */
6706 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6707 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6708 (IT)->max_descent = descent)
6710 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6712 if ((op
& MOVE_TO_POS
) != 0
6713 && BUFFERP (it
->object
)
6714 && it
->method
== GET_FROM_BUFFER
6715 && IT_CHARPOS (*it
) > to_charpos
)
6717 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6719 result
= MOVE_POS_MATCH_OR_ZV
;
6722 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6723 /* If wrap_it is valid, the current position might be in a
6724 word that is wrapped. So, save the iterator in
6725 atpos_it and continue to see if wrapping happens. */
6729 /* Stop when ZV reached.
6730 We used to stop here when TO_CHARPOS reached as well, but that is
6731 too soon if this glyph does not fit on this line. So we handle it
6732 explicitly below. */
6733 if (!get_next_display_element (it
))
6735 result
= MOVE_POS_MATCH_OR_ZV
;
6739 if (it
->line_wrap
== TRUNCATE
)
6741 if (BUFFER_POS_REACHED_P ())
6743 result
= MOVE_POS_MATCH_OR_ZV
;
6749 if (it
->line_wrap
== WORD_WRAP
)
6751 if (IT_DISPLAYING_WHITESPACE (it
))
6755 /* We have reached a glyph that follows one or more
6756 whitespace characters. If the position is
6757 already found, we are done. */
6758 if (atpos_it
.sp
>= 0)
6761 result
= MOVE_POS_MATCH_OR_ZV
;
6767 result
= MOVE_X_REACHED
;
6770 /* Otherwise, we can wrap here. */
6777 /* Remember the line height for the current line, in case
6778 the next element doesn't fit on the line. */
6779 ascent
= it
->max_ascent
;
6780 descent
= it
->max_descent
;
6782 /* The call to produce_glyphs will get the metrics of the
6783 display element IT is loaded with. Record the x-position
6784 before this display element, in case it doesn't fit on the
6788 PRODUCE_GLYPHS (it
);
6790 if (it
->area
!= TEXT_AREA
)
6792 set_iterator_to_next (it
, 1);
6796 /* The number of glyphs we get back in IT->nglyphs will normally
6797 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6798 character on a terminal frame, or (iii) a line end. For the
6799 second case, IT->nglyphs - 1 padding glyphs will be present
6800 (on X frames, there is only one glyph produced for a
6801 composite character.
6803 The behavior implemented below means, for continuation lines,
6804 that as many spaces of a TAB as fit on the current line are
6805 displayed there. For terminal frames, as many glyphs of a
6806 multi-glyph character are displayed in the current line, too.
6807 This is what the old redisplay code did, and we keep it that
6808 way. Under X, the whole shape of a complex character must
6809 fit on the line or it will be completely displayed in the
6812 Note that both for tabs and padding glyphs, all glyphs have
6816 /* More than one glyph or glyph doesn't fit on line. All
6817 glyphs have the same width. */
6818 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6820 int x_before_this_char
= x
;
6821 int hpos_before_this_char
= it
->hpos
;
6823 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6825 new_x
= x
+ single_glyph_width
;
6827 /* We want to leave anything reaching TO_X to the caller. */
6828 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6830 if (BUFFER_POS_REACHED_P ())
6832 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6833 goto buffer_pos_reached
;
6834 if (atpos_it
.sp
< 0)
6837 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6842 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6845 result
= MOVE_X_REACHED
;
6851 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
6856 if (/* Lines are continued. */
6857 it
->line_wrap
!= TRUNCATE
6858 && (/* And glyph doesn't fit on the line. */
6859 new_x
> it
->last_visible_x
6860 /* Or it fits exactly and we're on a window
6862 || (new_x
== it
->last_visible_x
6863 && FRAME_WINDOW_P (it
->f
))))
6865 if (/* IT->hpos == 0 means the very first glyph
6866 doesn't fit on the line, e.g. a wide image. */
6868 || (new_x
== it
->last_visible_x
6869 && FRAME_WINDOW_P (it
->f
)))
6872 it
->current_x
= new_x
;
6874 /* The character's last glyph just barely fits
6876 if (i
== it
->nglyphs
- 1)
6878 /* If this is the destination position,
6879 return a position *before* it in this row,
6880 now that we know it fits in this row. */
6881 if (BUFFER_POS_REACHED_P ())
6883 if (it
->line_wrap
!= WORD_WRAP
6886 it
->hpos
= hpos_before_this_char
;
6887 it
->current_x
= x_before_this_char
;
6888 result
= MOVE_POS_MATCH_OR_ZV
;
6891 if (it
->line_wrap
== WORD_WRAP
6895 atpos_it
.current_x
= x_before_this_char
;
6896 atpos_it
.hpos
= hpos_before_this_char
;
6900 set_iterator_to_next (it
, 1);
6901 #ifdef HAVE_WINDOW_SYSTEM
6902 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6904 if (!get_next_display_element (it
))
6906 result
= MOVE_POS_MATCH_OR_ZV
;
6909 if (BUFFER_POS_REACHED_P ())
6911 if (ITERATOR_AT_END_OF_LINE_P (it
))
6912 result
= MOVE_POS_MATCH_OR_ZV
;
6914 result
= MOVE_LINE_CONTINUED
;
6917 if (ITERATOR_AT_END_OF_LINE_P (it
))
6919 result
= MOVE_NEWLINE_OR_CR
;
6923 #endif /* HAVE_WINDOW_SYSTEM */
6927 IT_RESET_X_ASCENT_DESCENT (it
);
6929 if (wrap_it
.sp
>= 0)
6936 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6938 result
= MOVE_LINE_CONTINUED
;
6942 if (BUFFER_POS_REACHED_P ())
6944 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6945 goto buffer_pos_reached
;
6946 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6949 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6953 if (new_x
> it
->first_visible_x
)
6955 /* Glyph is visible. Increment number of glyphs that
6956 would be displayed. */
6961 if (result
!= MOVE_UNDEFINED
)
6964 else if (BUFFER_POS_REACHED_P ())
6967 IT_RESET_X_ASCENT_DESCENT (it
);
6968 result
= MOVE_POS_MATCH_OR_ZV
;
6971 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6973 /* Stop when TO_X specified and reached. This check is
6974 necessary here because of lines consisting of a line end,
6975 only. The line end will not produce any glyphs and we
6976 would never get MOVE_X_REACHED. */
6977 xassert (it
->nglyphs
== 0);
6978 result
= MOVE_X_REACHED
;
6982 /* Is this a line end? If yes, we're done. */
6983 if (ITERATOR_AT_END_OF_LINE_P (it
))
6985 result
= MOVE_NEWLINE_OR_CR
;
6989 /* The current display element has been consumed. Advance
6991 set_iterator_to_next (it
, 1);
6993 /* Stop if lines are truncated and IT's current x-position is
6994 past the right edge of the window now. */
6995 if (it
->line_wrap
== TRUNCATE
6996 && it
->current_x
>= it
->last_visible_x
)
6998 #ifdef HAVE_WINDOW_SYSTEM
6999 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7001 if (!get_next_display_element (it
)
7002 || BUFFER_POS_REACHED_P ())
7004 result
= MOVE_POS_MATCH_OR_ZV
;
7007 if (ITERATOR_AT_END_OF_LINE_P (it
))
7009 result
= MOVE_NEWLINE_OR_CR
;
7013 #endif /* HAVE_WINDOW_SYSTEM */
7014 result
= MOVE_LINE_TRUNCATED
;
7017 #undef IT_RESET_X_ASCENT_DESCENT
7020 #undef BUFFER_POS_REACHED_P
7022 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7023 restore the saved iterator. */
7024 if (atpos_it
.sp
>= 0)
7026 else if (atx_it
.sp
>= 0)
7031 /* Restore the iterator settings altered at the beginning of this
7033 it
->glyph_row
= saved_glyph_row
;
7037 /* For external use. */
7039 move_it_in_display_line (struct it
*it
,
7040 EMACS_INT to_charpos
, int to_x
,
7041 enum move_operation_enum op
)
7043 if (it
->line_wrap
== WORD_WRAP
7044 && (op
& MOVE_TO_X
))
7046 struct it save_it
= *it
;
7047 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7048 /* When word-wrap is on, TO_X may lie past the end
7049 of a wrapped line. Then it->current is the
7050 character on the next line, so backtrack to the
7051 space before the wrap point. */
7052 if (skip
== MOVE_LINE_CONTINUED
)
7054 int prev_x
= max (it
->current_x
- 1, 0);
7056 move_it_in_display_line_to
7057 (it
, -1, prev_x
, MOVE_TO_X
);
7061 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7065 /* Move IT forward until it satisfies one or more of the criteria in
7066 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7068 OP is a bit-mask that specifies where to stop, and in particular,
7069 which of those four position arguments makes a difference. See the
7070 description of enum move_operation_enum.
7072 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7073 screen line, this function will set IT to the next position >
7077 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7079 int to_charpos
, to_x
, to_y
, to_vpos
;
7082 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7088 if (op
& MOVE_TO_VPOS
)
7090 /* If no TO_CHARPOS and no TO_X specified, stop at the
7091 start of the line TO_VPOS. */
7092 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7094 if (it
->vpos
== to_vpos
)
7100 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7104 /* TO_VPOS >= 0 means stop at TO_X in the line at
7105 TO_VPOS, or at TO_POS, whichever comes first. */
7106 if (it
->vpos
== to_vpos
)
7112 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7114 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7119 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7121 /* We have reached TO_X but not in the line we want. */
7122 skip
= move_it_in_display_line_to (it
, to_charpos
,
7124 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7132 else if (op
& MOVE_TO_Y
)
7134 struct it it_backup
;
7136 if (it
->line_wrap
== WORD_WRAP
)
7139 /* TO_Y specified means stop at TO_X in the line containing
7140 TO_Y---or at TO_CHARPOS if this is reached first. The
7141 problem is that we can't really tell whether the line
7142 contains TO_Y before we have completely scanned it, and
7143 this may skip past TO_X. What we do is to first scan to
7146 If TO_X is not specified, use a TO_X of zero. The reason
7147 is to make the outcome of this function more predictable.
7148 If we didn't use TO_X == 0, we would stop at the end of
7149 the line which is probably not what a caller would expect
7151 skip
= move_it_in_display_line_to
7152 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7153 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7155 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7156 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7158 else if (skip
== MOVE_X_REACHED
)
7160 /* If TO_X was reached, we want to know whether TO_Y is
7161 in the line. We know this is the case if the already
7162 scanned glyphs make the line tall enough. Otherwise,
7163 we must check by scanning the rest of the line. */
7164 line_height
= it
->max_ascent
+ it
->max_descent
;
7165 if (to_y
>= it
->current_y
7166 && to_y
< it
->current_y
+ line_height
)
7172 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7173 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7175 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7176 line_height
= it
->max_ascent
+ it
->max_descent
;
7177 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7179 if (to_y
>= it
->current_y
7180 && to_y
< it
->current_y
+ line_height
)
7182 /* If TO_Y is in this line and TO_X was reached
7183 above, we scanned too far. We have to restore
7184 IT's settings to the ones before skipping. */
7191 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7197 /* Check whether TO_Y is in this line. */
7198 line_height
= it
->max_ascent
+ it
->max_descent
;
7199 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7201 if (to_y
>= it
->current_y
7202 && to_y
< it
->current_y
+ line_height
)
7204 /* When word-wrap is on, TO_X may lie past the end
7205 of a wrapped line. Then it->current is the
7206 character on the next line, so backtrack to the
7207 space before the wrap point. */
7208 if (skip
== MOVE_LINE_CONTINUED
7209 && it
->line_wrap
== WORD_WRAP
)
7211 int prev_x
= max (it
->current_x
- 1, 0);
7213 skip
= move_it_in_display_line_to
7214 (it
, -1, prev_x
, MOVE_TO_X
);
7223 else if (BUFFERP (it
->object
)
7224 && it
->method
== GET_FROM_BUFFER
7225 && IT_CHARPOS (*it
) >= to_charpos
)
7226 skip
= MOVE_POS_MATCH_OR_ZV
;
7228 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7232 case MOVE_POS_MATCH_OR_ZV
:
7236 case MOVE_NEWLINE_OR_CR
:
7237 set_iterator_to_next (it
, 1);
7238 it
->continuation_lines_width
= 0;
7241 case MOVE_LINE_TRUNCATED
:
7242 it
->continuation_lines_width
= 0;
7243 reseat_at_next_visible_line_start (it
, 0);
7244 if ((op
& MOVE_TO_POS
) != 0
7245 && IT_CHARPOS (*it
) > to_charpos
)
7252 case MOVE_LINE_CONTINUED
:
7253 /* For continued lines ending in a tab, some of the glyphs
7254 associated with the tab are displayed on the current
7255 line. Since it->current_x does not include these glyphs,
7256 we use it->last_visible_x instead. */
7259 it
->continuation_lines_width
+= it
->last_visible_x
;
7260 /* When moving by vpos, ensure that the iterator really
7261 advances to the next line (bug#847, bug#969). Fixme:
7262 do we need to do this in other circumstances? */
7263 if (it
->current_x
!= it
->last_visible_x
7264 && (op
& MOVE_TO_VPOS
)
7265 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7266 set_iterator_to_next (it
, 0);
7269 it
->continuation_lines_width
+= it
->current_x
;
7276 /* Reset/increment for the next run. */
7277 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7278 it
->current_x
= it
->hpos
= 0;
7279 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7281 last_height
= it
->max_ascent
+ it
->max_descent
;
7282 last_max_ascent
= it
->max_ascent
;
7283 it
->max_ascent
= it
->max_descent
= 0;
7288 /* On text terminals, we may stop at the end of a line in the middle
7289 of a multi-character glyph. If the glyph itself is continued,
7290 i.e. it is actually displayed on the next line, don't treat this
7291 stopping point as valid; move to the next line instead (unless
7292 that brings us offscreen). */
7293 if (!FRAME_WINDOW_P (it
->f
)
7295 && IT_CHARPOS (*it
) == to_charpos
7296 && it
->what
== IT_CHARACTER
7298 && it
->line_wrap
== WINDOW_WRAP
7299 && it
->current_x
== it
->last_visible_x
- 1
7302 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7304 it
->continuation_lines_width
+= it
->current_x
;
7305 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7306 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7308 last_height
= it
->max_ascent
+ it
->max_descent
;
7309 last_max_ascent
= it
->max_ascent
;
7312 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7316 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7318 If DY > 0, move IT backward at least that many pixels. DY = 0
7319 means move IT backward to the preceding line start or BEGV. This
7320 function may move over more than DY pixels if IT->current_y - DY
7321 ends up in the middle of a line; in this case IT->current_y will be
7322 set to the top of the line moved to. */
7325 move_it_vertically_backward (it
, dy
)
7336 start_pos
= IT_CHARPOS (*it
);
7338 /* Estimate how many newlines we must move back. */
7339 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7341 /* Set the iterator's position that many lines back. */
7342 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7343 back_to_previous_visible_line_start (it
);
7345 /* Reseat the iterator here. When moving backward, we don't want
7346 reseat to skip forward over invisible text, set up the iterator
7347 to deliver from overlay strings at the new position etc. So,
7348 use reseat_1 here. */
7349 reseat_1 (it
, it
->current
.pos
, 1);
7351 /* We are now surely at a line start. */
7352 it
->current_x
= it
->hpos
= 0;
7353 it
->continuation_lines_width
= 0;
7355 /* Move forward and see what y-distance we moved. First move to the
7356 start of the next line so that we get its height. We need this
7357 height to be able to tell whether we reached the specified
7360 it2
.max_ascent
= it2
.max_descent
= 0;
7363 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7364 MOVE_TO_POS
| MOVE_TO_VPOS
);
7366 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7367 xassert (IT_CHARPOS (*it
) >= BEGV
);
7370 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7371 xassert (IT_CHARPOS (*it
) >= BEGV
);
7372 /* H is the actual vertical distance from the position in *IT
7373 and the starting position. */
7374 h
= it2
.current_y
- it
->current_y
;
7375 /* NLINES is the distance in number of lines. */
7376 nlines
= it2
.vpos
- it
->vpos
;
7378 /* Correct IT's y and vpos position
7379 so that they are relative to the starting point. */
7385 /* DY == 0 means move to the start of the screen line. The
7386 value of nlines is > 0 if continuation lines were involved. */
7388 move_it_by_lines (it
, nlines
, 1);
7390 /* I think this assert is bogus if buffer contains
7391 invisible text or images. KFS. */
7392 xassert (IT_CHARPOS (*it
) <= start_pos
);
7397 /* The y-position we try to reach, relative to *IT.
7398 Note that H has been subtracted in front of the if-statement. */
7399 int target_y
= it
->current_y
+ h
- dy
;
7400 int y0
= it3
.current_y
;
7401 int y1
= line_bottom_y (&it3
);
7402 int line_height
= y1
- y0
;
7404 /* If we did not reach target_y, try to move further backward if
7405 we can. If we moved too far backward, try to move forward. */
7406 if (target_y
< it
->current_y
7407 /* This is heuristic. In a window that's 3 lines high, with
7408 a line height of 13 pixels each, recentering with point
7409 on the bottom line will try to move -39/2 = 19 pixels
7410 backward. Try to avoid moving into the first line. */
7411 && (it
->current_y
- target_y
7412 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7413 && IT_CHARPOS (*it
) > BEGV
)
7415 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7416 target_y
- it
->current_y
));
7417 dy
= it
->current_y
- target_y
;
7418 goto move_further_back
;
7420 else if (target_y
>= it
->current_y
+ line_height
7421 && IT_CHARPOS (*it
) < ZV
)
7423 /* Should move forward by at least one line, maybe more.
7425 Note: Calling move_it_by_lines can be expensive on
7426 terminal frames, where compute_motion is used (via
7427 vmotion) to do the job, when there are very long lines
7428 and truncate-lines is nil. That's the reason for
7429 treating terminal frames specially here. */
7431 if (!FRAME_WINDOW_P (it
->f
))
7432 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7437 move_it_by_lines (it
, 1, 1);
7439 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7443 /* I think this assert is bogus if buffer contains
7444 invisible text or images. KFS. */
7445 xassert (IT_CHARPOS (*it
) >= BEGV
);
7452 /* Move IT by a specified amount of pixel lines DY. DY negative means
7453 move backwards. DY = 0 means move to start of screen line. At the
7454 end, IT will be on the start of a screen line. */
7457 move_it_vertically (it
, dy
)
7462 move_it_vertically_backward (it
, -dy
);
7465 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7466 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7467 MOVE_TO_POS
| MOVE_TO_Y
);
7468 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7470 /* If buffer ends in ZV without a newline, move to the start of
7471 the line to satisfy the post-condition. */
7472 if (IT_CHARPOS (*it
) == ZV
7474 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7475 move_it_by_lines (it
, 0, 0);
7480 /* Move iterator IT past the end of the text line it is in. */
7483 move_it_past_eol (it
)
7486 enum move_it_result rc
;
7488 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7489 if (rc
== MOVE_NEWLINE_OR_CR
)
7490 set_iterator_to_next (it
, 0);
7494 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7495 negative means move up. DVPOS == 0 means move to the start of the
7496 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7497 NEED_Y_P is zero, IT->current_y will be left unchanged.
7499 Further optimization ideas: If we would know that IT->f doesn't use
7500 a face with proportional font, we could be faster for
7501 truncate-lines nil. */
7504 move_it_by_lines (it
, dvpos
, need_y_p
)
7506 int dvpos
, need_y_p
;
7508 struct position pos
;
7510 /* The commented-out optimization uses vmotion on terminals. This
7511 gives bad results, because elements like it->what, on which
7512 callers such as pos_visible_p rely, aren't updated. */
7513 /* if (!FRAME_WINDOW_P (it->f))
7515 struct text_pos textpos;
7517 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7518 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7519 reseat (it, textpos, 1);
7520 it->vpos += pos.vpos;
7521 it->current_y += pos.vpos;
7527 /* DVPOS == 0 means move to the start of the screen line. */
7528 move_it_vertically_backward (it
, 0);
7529 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7530 /* Let next call to line_bottom_y calculate real line height */
7535 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7536 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7537 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7542 int start_charpos
, i
;
7544 /* Start at the beginning of the screen line containing IT's
7545 position. This may actually move vertically backwards,
7546 in case of overlays, so adjust dvpos accordingly. */
7548 move_it_vertically_backward (it
, 0);
7551 /* Go back -DVPOS visible lines and reseat the iterator there. */
7552 start_charpos
= IT_CHARPOS (*it
);
7553 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7554 back_to_previous_visible_line_start (it
);
7555 reseat (it
, it
->current
.pos
, 1);
7557 /* Move further back if we end up in a string or an image. */
7558 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7560 /* First try to move to start of display line. */
7562 move_it_vertically_backward (it
, 0);
7564 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7566 /* If start of line is still in string or image,
7567 move further back. */
7568 back_to_previous_visible_line_start (it
);
7569 reseat (it
, it
->current
.pos
, 1);
7573 it
->current_x
= it
->hpos
= 0;
7575 /* Above call may have moved too far if continuation lines
7576 are involved. Scan forward and see if it did. */
7578 it2
.vpos
= it2
.current_y
= 0;
7579 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7580 it
->vpos
-= it2
.vpos
;
7581 it
->current_y
-= it2
.current_y
;
7582 it
->current_x
= it
->hpos
= 0;
7584 /* If we moved too far back, move IT some lines forward. */
7585 if (it2
.vpos
> -dvpos
)
7587 int delta
= it2
.vpos
+ dvpos
;
7589 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7590 /* Move back again if we got too far ahead. */
7591 if (IT_CHARPOS (*it
) >= start_charpos
)
7597 /* Return 1 if IT points into the middle of a display vector. */
7600 in_display_vector_p (it
)
7603 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7604 && it
->current
.dpvec_index
> 0
7605 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7609 /***********************************************************************
7611 ***********************************************************************/
7614 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7618 add_to_log (format
, arg1
, arg2
)
7620 Lisp_Object arg1
, arg2
;
7622 Lisp_Object args
[3];
7623 Lisp_Object msg
, fmt
;
7626 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7629 /* Do nothing if called asynchronously. Inserting text into
7630 a buffer may call after-change-functions and alike and
7631 that would means running Lisp asynchronously. */
7632 if (handling_signal
)
7636 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7638 args
[0] = fmt
= build_string (format
);
7641 msg
= Fformat (3, args
);
7643 len
= SBYTES (msg
) + 1;
7644 SAFE_ALLOCA (buffer
, char *, len
);
7645 bcopy (SDATA (msg
), buffer
, len
);
7647 message_dolog (buffer
, len
- 1, 1, 0);
7654 /* Output a newline in the *Messages* buffer if "needs" one. */
7657 message_log_maybe_newline ()
7659 if (message_log_need_newline
)
7660 message_dolog ("", 0, 1, 0);
7664 /* Add a string M of length NBYTES to the message log, optionally
7665 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7666 nonzero, means interpret the contents of M as multibyte. This
7667 function calls low-level routines in order to bypass text property
7668 hooks, etc. which might not be safe to run.
7670 This may GC (insert may run before/after change hooks),
7671 so the buffer M must NOT point to a Lisp string. */
7674 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7676 int nbytes
, nlflag
, multibyte
;
7678 if (!NILP (Vmemory_full
))
7681 if (!NILP (Vmessage_log_max
))
7683 struct buffer
*oldbuf
;
7684 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7685 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7686 int point_at_end
= 0;
7688 Lisp_Object old_deactivate_mark
, tem
;
7689 struct gcpro gcpro1
;
7691 old_deactivate_mark
= Vdeactivate_mark
;
7692 oldbuf
= current_buffer
;
7693 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7694 current_buffer
->undo_list
= Qt
;
7696 oldpoint
= message_dolog_marker1
;
7697 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7698 oldbegv
= message_dolog_marker2
;
7699 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7700 oldzv
= message_dolog_marker3
;
7701 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7702 GCPRO1 (old_deactivate_mark
);
7710 BEGV_BYTE
= BEG_BYTE
;
7713 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7715 /* Insert the string--maybe converting multibyte to single byte
7716 or vice versa, so that all the text fits the buffer. */
7718 && NILP (current_buffer
->enable_multibyte_characters
))
7720 int i
, c
, char_bytes
;
7721 unsigned char work
[1];
7723 /* Convert a multibyte string to single-byte
7724 for the *Message* buffer. */
7725 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7727 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7728 work
[0] = (ASCII_CHAR_P (c
)
7730 : multibyte_char_to_unibyte (c
, Qnil
));
7731 insert_1_both (work
, 1, 1, 1, 0, 0);
7734 else if (! multibyte
7735 && ! NILP (current_buffer
->enable_multibyte_characters
))
7737 int i
, c
, char_bytes
;
7738 unsigned char *msg
= (unsigned char *) m
;
7739 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7740 /* Convert a single-byte string to multibyte
7741 for the *Message* buffer. */
7742 for (i
= 0; i
< nbytes
; i
++)
7745 c
= unibyte_char_to_multibyte (c
);
7746 char_bytes
= CHAR_STRING (c
, str
);
7747 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7751 insert_1 (m
, nbytes
, 1, 0, 0);
7755 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7756 insert_1 ("\n", 1, 1, 0, 0);
7758 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7760 this_bol_byte
= PT_BYTE
;
7762 /* See if this line duplicates the previous one.
7763 If so, combine duplicates. */
7766 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7768 prev_bol_byte
= PT_BYTE
;
7770 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7771 this_bol
, this_bol_byte
);
7774 del_range_both (prev_bol
, prev_bol_byte
,
7775 this_bol
, this_bol_byte
, 0);
7781 /* If you change this format, don't forget to also
7782 change message_log_check_duplicate. */
7783 sprintf (dupstr
, " [%d times]", dup
);
7784 duplen
= strlen (dupstr
);
7785 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7786 insert_1 (dupstr
, duplen
, 1, 0, 1);
7791 /* If we have more than the desired maximum number of lines
7792 in the *Messages* buffer now, delete the oldest ones.
7793 This is safe because we don't have undo in this buffer. */
7795 if (NATNUMP (Vmessage_log_max
))
7797 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7798 -XFASTINT (Vmessage_log_max
) - 1, 0);
7799 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7802 BEGV
= XMARKER (oldbegv
)->charpos
;
7803 BEGV_BYTE
= marker_byte_position (oldbegv
);
7812 ZV
= XMARKER (oldzv
)->charpos
;
7813 ZV_BYTE
= marker_byte_position (oldzv
);
7817 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7819 /* We can't do Fgoto_char (oldpoint) because it will run some
7821 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7822 XMARKER (oldpoint
)->bytepos
);
7825 unchain_marker (XMARKER (oldpoint
));
7826 unchain_marker (XMARKER (oldbegv
));
7827 unchain_marker (XMARKER (oldzv
));
7829 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7830 set_buffer_internal (oldbuf
);
7832 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7833 message_log_need_newline
= !nlflag
;
7834 Vdeactivate_mark
= old_deactivate_mark
;
7839 /* We are at the end of the buffer after just having inserted a newline.
7840 (Note: We depend on the fact we won't be crossing the gap.)
7841 Check to see if the most recent message looks a lot like the previous one.
7842 Return 0 if different, 1 if the new one should just replace it, or a
7843 value N > 1 if we should also append " [N times]". */
7846 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7847 int prev_bol
, this_bol
;
7848 int prev_bol_byte
, this_bol_byte
;
7851 int len
= Z_BYTE
- 1 - this_bol_byte
;
7853 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7854 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7856 for (i
= 0; i
< len
; i
++)
7858 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7866 if (*p1
++ == ' ' && *p1
++ == '[')
7869 while (*p1
>= '0' && *p1
<= '9')
7870 n
= n
* 10 + *p1
++ - '0';
7871 if (strncmp (p1
, " times]\n", 8) == 0)
7878 /* Display an echo area message M with a specified length of NBYTES
7879 bytes. The string may include null characters. If M is 0, clear
7880 out any existing message, and let the mini-buffer text show
7883 This may GC, so the buffer M must NOT point to a Lisp string. */
7886 message2 (m
, nbytes
, multibyte
)
7891 /* First flush out any partial line written with print. */
7892 message_log_maybe_newline ();
7894 message_dolog (m
, nbytes
, 1, multibyte
);
7895 message2_nolog (m
, nbytes
, multibyte
);
7899 /* The non-logging counterpart of message2. */
7902 message2_nolog (m
, nbytes
, multibyte
)
7904 int nbytes
, multibyte
;
7906 struct frame
*sf
= SELECTED_FRAME ();
7907 message_enable_multibyte
= multibyte
;
7911 if (noninteractive_need_newline
)
7912 putc ('\n', stderr
);
7913 noninteractive_need_newline
= 0;
7915 fwrite (m
, nbytes
, 1, stderr
);
7916 if (cursor_in_echo_area
== 0)
7917 fprintf (stderr
, "\n");
7920 /* A null message buffer means that the frame hasn't really been
7921 initialized yet. Error messages get reported properly by
7922 cmd_error, so this must be just an informative message; toss it. */
7923 else if (INTERACTIVE
7924 && sf
->glyphs_initialized_p
7925 && FRAME_MESSAGE_BUF (sf
))
7927 Lisp_Object mini_window
;
7930 /* Get the frame containing the mini-buffer
7931 that the selected frame is using. */
7932 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7933 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7935 FRAME_SAMPLE_VISIBILITY (f
);
7936 if (FRAME_VISIBLE_P (sf
)
7937 && ! FRAME_VISIBLE_P (f
))
7938 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7942 set_message (m
, Qnil
, nbytes
, multibyte
);
7943 if (minibuffer_auto_raise
)
7944 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7947 clear_message (1, 1);
7949 do_pending_window_change (0);
7950 echo_area_display (1);
7951 do_pending_window_change (0);
7952 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7953 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7958 /* Display an echo area message M with a specified length of NBYTES
7959 bytes. The string may include null characters. If M is not a
7960 string, clear out any existing message, and let the mini-buffer
7963 This function cancels echoing. */
7966 message3 (m
, nbytes
, multibyte
)
7971 struct gcpro gcpro1
;
7974 clear_message (1,1);
7977 /* First flush out any partial line written with print. */
7978 message_log_maybe_newline ();
7984 SAFE_ALLOCA (buffer
, char *, nbytes
);
7985 bcopy (SDATA (m
), buffer
, nbytes
);
7986 message_dolog (buffer
, nbytes
, 1, multibyte
);
7989 message3_nolog (m
, nbytes
, multibyte
);
7995 /* The non-logging version of message3.
7996 This does not cancel echoing, because it is used for echoing.
7997 Perhaps we need to make a separate function for echoing
7998 and make this cancel echoing. */
8001 message3_nolog (m
, nbytes
, multibyte
)
8003 int nbytes
, multibyte
;
8005 struct frame
*sf
= SELECTED_FRAME ();
8006 message_enable_multibyte
= multibyte
;
8010 if (noninteractive_need_newline
)
8011 putc ('\n', stderr
);
8012 noninteractive_need_newline
= 0;
8014 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8015 if (cursor_in_echo_area
== 0)
8016 fprintf (stderr
, "\n");
8019 /* A null message buffer means that the frame hasn't really been
8020 initialized yet. Error messages get reported properly by
8021 cmd_error, so this must be just an informative message; toss it. */
8022 else if (INTERACTIVE
8023 && sf
->glyphs_initialized_p
8024 && FRAME_MESSAGE_BUF (sf
))
8026 Lisp_Object mini_window
;
8030 /* Get the frame containing the mini-buffer
8031 that the selected frame is using. */
8032 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8033 frame
= XWINDOW (mini_window
)->frame
;
8036 FRAME_SAMPLE_VISIBILITY (f
);
8037 if (FRAME_VISIBLE_P (sf
)
8038 && !FRAME_VISIBLE_P (f
))
8039 Fmake_frame_visible (frame
);
8041 if (STRINGP (m
) && SCHARS (m
) > 0)
8043 set_message (NULL
, m
, nbytes
, multibyte
);
8044 if (minibuffer_auto_raise
)
8045 Fraise_frame (frame
);
8046 /* Assume we are not echoing.
8047 (If we are, echo_now will override this.) */
8048 echo_message_buffer
= Qnil
;
8051 clear_message (1, 1);
8053 do_pending_window_change (0);
8054 echo_area_display (1);
8055 do_pending_window_change (0);
8056 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8057 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8062 /* Display a null-terminated echo area message M. If M is 0, clear
8063 out any existing message, and let the mini-buffer text show through.
8065 The buffer M must continue to exist until after the echo area gets
8066 cleared or some other message gets displayed there. Do not pass
8067 text that is stored in a Lisp string. Do not pass text in a buffer
8068 that was alloca'd. */
8074 message2 (m
, (m
? strlen (m
) : 0), 0);
8078 /* The non-logging counterpart of message1. */
8084 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8087 /* Display a message M which contains a single %s
8088 which gets replaced with STRING. */
8091 message_with_string (m
, string
, log
)
8096 CHECK_STRING (string
);
8102 if (noninteractive_need_newline
)
8103 putc ('\n', stderr
);
8104 noninteractive_need_newline
= 0;
8105 fprintf (stderr
, m
, SDATA (string
));
8106 if (cursor_in_echo_area
== 0)
8107 fprintf (stderr
, "\n");
8111 else if (INTERACTIVE
)
8113 /* The frame whose minibuffer we're going to display the message on.
8114 It may be larger than the selected frame, so we need
8115 to use its buffer, not the selected frame's buffer. */
8116 Lisp_Object mini_window
;
8117 struct frame
*f
, *sf
= SELECTED_FRAME ();
8119 /* Get the frame containing the minibuffer
8120 that the selected frame is using. */
8121 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8122 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8124 /* A null message buffer means that the frame hasn't really been
8125 initialized yet. Error messages get reported properly by
8126 cmd_error, so this must be just an informative message; toss it. */
8127 if (FRAME_MESSAGE_BUF (f
))
8129 Lisp_Object args
[2], message
;
8130 struct gcpro gcpro1
, gcpro2
;
8132 args
[0] = build_string (m
);
8133 args
[1] = message
= string
;
8134 GCPRO2 (args
[0], message
);
8137 message
= Fformat (2, args
);
8140 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8142 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8146 /* Print should start at the beginning of the message
8147 buffer next time. */
8148 message_buf_print
= 0;
8154 /* Dump an informative message to the minibuf. If M is 0, clear out
8155 any existing message, and let the mini-buffer text show through. */
8159 message (m
, a1
, a2
, a3
)
8161 EMACS_INT a1
, a2
, a3
;
8167 if (noninteractive_need_newline
)
8168 putc ('\n', stderr
);
8169 noninteractive_need_newline
= 0;
8170 fprintf (stderr
, m
, a1
, a2
, a3
);
8171 if (cursor_in_echo_area
== 0)
8172 fprintf (stderr
, "\n");
8176 else if (INTERACTIVE
)
8178 /* The frame whose mini-buffer we're going to display the message
8179 on. It may be larger than the selected frame, so we need to
8180 use its buffer, not the selected frame's buffer. */
8181 Lisp_Object mini_window
;
8182 struct frame
*f
, *sf
= SELECTED_FRAME ();
8184 /* Get the frame containing the mini-buffer
8185 that the selected frame is using. */
8186 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8187 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8189 /* A null message buffer means that the frame hasn't really been
8190 initialized yet. Error messages get reported properly by
8191 cmd_error, so this must be just an informative message; toss
8193 if (FRAME_MESSAGE_BUF (f
))
8204 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8205 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8207 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8208 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8210 #endif /* NO_ARG_ARRAY */
8212 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8217 /* Print should start at the beginning of the message
8218 buffer next time. */
8219 message_buf_print
= 0;
8225 /* The non-logging version of message. */
8228 message_nolog (m
, a1
, a2
, a3
)
8230 EMACS_INT a1
, a2
, a3
;
8232 Lisp_Object old_log_max
;
8233 old_log_max
= Vmessage_log_max
;
8234 Vmessage_log_max
= Qnil
;
8235 message (m
, a1
, a2
, a3
);
8236 Vmessage_log_max
= old_log_max
;
8240 /* Display the current message in the current mini-buffer. This is
8241 only called from error handlers in process.c, and is not time
8247 if (!NILP (echo_area_buffer
[0]))
8250 string
= Fcurrent_message ();
8251 message3 (string
, SBYTES (string
),
8252 !NILP (current_buffer
->enable_multibyte_characters
));
8257 /* Make sure echo area buffers in `echo_buffers' are live.
8258 If they aren't, make new ones. */
8261 ensure_echo_area_buffers ()
8265 for (i
= 0; i
< 2; ++i
)
8266 if (!BUFFERP (echo_buffer
[i
])
8267 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8270 Lisp_Object old_buffer
;
8273 old_buffer
= echo_buffer
[i
];
8274 sprintf (name
, " *Echo Area %d*", i
);
8275 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8276 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8277 /* to force word wrap in echo area -
8278 it was decided to postpone this*/
8279 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8281 for (j
= 0; j
< 2; ++j
)
8282 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8283 echo_area_buffer
[j
] = echo_buffer
[i
];
8288 /* Call FN with args A1..A4 with either the current or last displayed
8289 echo_area_buffer as current buffer.
8291 WHICH zero means use the current message buffer
8292 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8293 from echo_buffer[] and clear it.
8295 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8296 suitable buffer from echo_buffer[] and clear it.
8298 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8299 that the current message becomes the last displayed one, make
8300 choose a suitable buffer for echo_area_buffer[0], and clear it.
8302 Value is what FN returns. */
8305 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8308 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8314 int this_one
, the_other
, clear_buffer_p
, rc
;
8315 int count
= SPECPDL_INDEX ();
8317 /* If buffers aren't live, make new ones. */
8318 ensure_echo_area_buffers ();
8323 this_one
= 0, the_other
= 1;
8325 this_one
= 1, the_other
= 0;
8328 this_one
= 0, the_other
= 1;
8331 /* We need a fresh one in case the current echo buffer equals
8332 the one containing the last displayed echo area message. */
8333 if (!NILP (echo_area_buffer
[this_one
])
8334 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8335 echo_area_buffer
[this_one
] = Qnil
;
8338 /* Choose a suitable buffer from echo_buffer[] is we don't
8340 if (NILP (echo_area_buffer
[this_one
]))
8342 echo_area_buffer
[this_one
]
8343 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8344 ? echo_buffer
[the_other
]
8345 : echo_buffer
[this_one
]);
8349 buffer
= echo_area_buffer
[this_one
];
8351 /* Don't get confused by reusing the buffer used for echoing
8352 for a different purpose. */
8353 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8356 record_unwind_protect (unwind_with_echo_area_buffer
,
8357 with_echo_area_buffer_unwind_data (w
));
8359 /* Make the echo area buffer current. Note that for display
8360 purposes, it is not necessary that the displayed window's buffer
8361 == current_buffer, except for text property lookup. So, let's
8362 only set that buffer temporarily here without doing a full
8363 Fset_window_buffer. We must also change w->pointm, though,
8364 because otherwise an assertions in unshow_buffer fails, and Emacs
8366 set_buffer_internal_1 (XBUFFER (buffer
));
8370 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8373 current_buffer
->undo_list
= Qt
;
8374 current_buffer
->read_only
= Qnil
;
8375 specbind (Qinhibit_read_only
, Qt
);
8376 specbind (Qinhibit_modification_hooks
, Qt
);
8378 if (clear_buffer_p
&& Z
> BEG
)
8381 xassert (BEGV
>= BEG
);
8382 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8384 rc
= fn (a1
, a2
, a3
, a4
);
8386 xassert (BEGV
>= BEG
);
8387 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8389 unbind_to (count
, Qnil
);
8394 /* Save state that should be preserved around the call to the function
8395 FN called in with_echo_area_buffer. */
8398 with_echo_area_buffer_unwind_data (w
)
8402 Lisp_Object vector
, tmp
;
8404 /* Reduce consing by keeping one vector in
8405 Vwith_echo_area_save_vector. */
8406 vector
= Vwith_echo_area_save_vector
;
8407 Vwith_echo_area_save_vector
= Qnil
;
8410 vector
= Fmake_vector (make_number (7), Qnil
);
8412 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8413 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8414 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8418 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8419 ASET (vector
, i
, w
->buffer
); ++i
;
8420 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8421 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8426 for (; i
< end
; ++i
)
8427 ASET (vector
, i
, Qnil
);
8430 xassert (i
== ASIZE (vector
));
8435 /* Restore global state from VECTOR which was created by
8436 with_echo_area_buffer_unwind_data. */
8439 unwind_with_echo_area_buffer (vector
)
8442 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8443 Vdeactivate_mark
= AREF (vector
, 1);
8444 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8446 if (WINDOWP (AREF (vector
, 3)))
8449 Lisp_Object buffer
, charpos
, bytepos
;
8451 w
= XWINDOW (AREF (vector
, 3));
8452 buffer
= AREF (vector
, 4);
8453 charpos
= AREF (vector
, 5);
8454 bytepos
= AREF (vector
, 6);
8457 set_marker_both (w
->pointm
, buffer
,
8458 XFASTINT (charpos
), XFASTINT (bytepos
));
8461 Vwith_echo_area_save_vector
= vector
;
8466 /* Set up the echo area for use by print functions. MULTIBYTE_P
8467 non-zero means we will print multibyte. */
8470 setup_echo_area_for_printing (multibyte_p
)
8473 /* If we can't find an echo area any more, exit. */
8474 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8477 ensure_echo_area_buffers ();
8479 if (!message_buf_print
)
8481 /* A message has been output since the last time we printed.
8482 Choose a fresh echo area buffer. */
8483 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8484 echo_area_buffer
[0] = echo_buffer
[1];
8486 echo_area_buffer
[0] = echo_buffer
[0];
8488 /* Switch to that buffer and clear it. */
8489 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8490 current_buffer
->truncate_lines
= Qnil
;
8494 int count
= SPECPDL_INDEX ();
8495 specbind (Qinhibit_read_only
, Qt
);
8496 /* Note that undo recording is always disabled. */
8498 unbind_to (count
, Qnil
);
8500 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8502 /* Set up the buffer for the multibyteness we need. */
8504 != !NILP (current_buffer
->enable_multibyte_characters
))
8505 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8507 /* Raise the frame containing the echo area. */
8508 if (minibuffer_auto_raise
)
8510 struct frame
*sf
= SELECTED_FRAME ();
8511 Lisp_Object mini_window
;
8512 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8513 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8516 message_log_maybe_newline ();
8517 message_buf_print
= 1;
8521 if (NILP (echo_area_buffer
[0]))
8523 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8524 echo_area_buffer
[0] = echo_buffer
[1];
8526 echo_area_buffer
[0] = echo_buffer
[0];
8529 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8531 /* Someone switched buffers between print requests. */
8532 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8533 current_buffer
->truncate_lines
= Qnil
;
8539 /* Display an echo area message in window W. Value is non-zero if W's
8540 height is changed. If display_last_displayed_message_p is
8541 non-zero, display the message that was last displayed, otherwise
8542 display the current message. */
8545 display_echo_area (w
)
8548 int i
, no_message_p
, window_height_changed_p
, count
;
8550 /* Temporarily disable garbage collections while displaying the echo
8551 area. This is done because a GC can print a message itself.
8552 That message would modify the echo area buffer's contents while a
8553 redisplay of the buffer is going on, and seriously confuse
8555 count
= inhibit_garbage_collection ();
8557 /* If there is no message, we must call display_echo_area_1
8558 nevertheless because it resizes the window. But we will have to
8559 reset the echo_area_buffer in question to nil at the end because
8560 with_echo_area_buffer will sets it to an empty buffer. */
8561 i
= display_last_displayed_message_p
? 1 : 0;
8562 no_message_p
= NILP (echo_area_buffer
[i
]);
8564 window_height_changed_p
8565 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8566 display_echo_area_1
,
8567 (EMACS_INT
) w
, Qnil
, 0, 0);
8570 echo_area_buffer
[i
] = Qnil
;
8572 unbind_to (count
, Qnil
);
8573 return window_height_changed_p
;
8577 /* Helper for display_echo_area. Display the current buffer which
8578 contains the current echo area message in window W, a mini-window,
8579 a pointer to which is passed in A1. A2..A4 are currently not used.
8580 Change the height of W so that all of the message is displayed.
8581 Value is non-zero if height of W was changed. */
8584 display_echo_area_1 (a1
, a2
, a3
, a4
)
8589 struct window
*w
= (struct window
*) a1
;
8591 struct text_pos start
;
8592 int window_height_changed_p
= 0;
8594 /* Do this before displaying, so that we have a large enough glyph
8595 matrix for the display. If we can't get enough space for the
8596 whole text, display the last N lines. That works by setting w->start. */
8597 window_height_changed_p
= resize_mini_window (w
, 0);
8599 /* Use the starting position chosen by resize_mini_window. */
8600 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8603 clear_glyph_matrix (w
->desired_matrix
);
8604 XSETWINDOW (window
, w
);
8605 try_window (window
, start
, 0);
8607 return window_height_changed_p
;
8611 /* Resize the echo area window to exactly the size needed for the
8612 currently displayed message, if there is one. If a mini-buffer
8613 is active, don't shrink it. */
8616 resize_echo_area_exactly ()
8618 if (BUFFERP (echo_area_buffer
[0])
8619 && WINDOWP (echo_area_window
))
8621 struct window
*w
= XWINDOW (echo_area_window
);
8623 Lisp_Object resize_exactly
;
8625 if (minibuf_level
== 0)
8626 resize_exactly
= Qt
;
8628 resize_exactly
= Qnil
;
8630 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8631 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8634 ++windows_or_buffers_changed
;
8635 ++update_mode_lines
;
8636 redisplay_internal (0);
8642 /* Callback function for with_echo_area_buffer, when used from
8643 resize_echo_area_exactly. A1 contains a pointer to the window to
8644 resize, EXACTLY non-nil means resize the mini-window exactly to the
8645 size of the text displayed. A3 and A4 are not used. Value is what
8646 resize_mini_window returns. */
8649 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8651 Lisp_Object exactly
;
8654 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8658 /* Resize mini-window W to fit the size of its contents. EXACT_P
8659 means size the window exactly to the size needed. Otherwise, it's
8660 only enlarged until W's buffer is empty.
8662 Set W->start to the right place to begin display. If the whole
8663 contents fit, start at the beginning. Otherwise, start so as
8664 to make the end of the contents appear. This is particularly
8665 important for y-or-n-p, but seems desirable generally.
8667 Value is non-zero if the window height has been changed. */
8670 resize_mini_window (w
, exact_p
)
8674 struct frame
*f
= XFRAME (w
->frame
);
8675 int window_height_changed_p
= 0;
8677 xassert (MINI_WINDOW_P (w
));
8679 /* By default, start display at the beginning. */
8680 set_marker_both (w
->start
, w
->buffer
,
8681 BUF_BEGV (XBUFFER (w
->buffer
)),
8682 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8684 /* Don't resize windows while redisplaying a window; it would
8685 confuse redisplay functions when the size of the window they are
8686 displaying changes from under them. Such a resizing can happen,
8687 for instance, when which-func prints a long message while
8688 we are running fontification-functions. We're running these
8689 functions with safe_call which binds inhibit-redisplay to t. */
8690 if (!NILP (Vinhibit_redisplay
))
8693 /* Nil means don't try to resize. */
8694 if (NILP (Vresize_mini_windows
)
8695 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8698 if (!FRAME_MINIBUF_ONLY_P (f
))
8701 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8702 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8703 int height
, max_height
;
8704 int unit
= FRAME_LINE_HEIGHT (f
);
8705 struct text_pos start
;
8706 struct buffer
*old_current_buffer
= NULL
;
8708 if (current_buffer
!= XBUFFER (w
->buffer
))
8710 old_current_buffer
= current_buffer
;
8711 set_buffer_internal (XBUFFER (w
->buffer
));
8714 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8716 /* Compute the max. number of lines specified by the user. */
8717 if (FLOATP (Vmax_mini_window_height
))
8718 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8719 else if (INTEGERP (Vmax_mini_window_height
))
8720 max_height
= XINT (Vmax_mini_window_height
);
8722 max_height
= total_height
/ 4;
8724 /* Correct that max. height if it's bogus. */
8725 max_height
= max (1, max_height
);
8726 max_height
= min (total_height
, max_height
);
8728 /* Find out the height of the text in the window. */
8729 if (it
.line_wrap
== TRUNCATE
)
8734 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8735 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8736 height
= it
.current_y
+ last_height
;
8738 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8739 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8740 height
= (height
+ unit
- 1) / unit
;
8743 /* Compute a suitable window start. */
8744 if (height
> max_height
)
8746 height
= max_height
;
8747 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8748 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8749 start
= it
.current
.pos
;
8752 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8753 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8755 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8757 /* Let it grow only, until we display an empty message, in which
8758 case the window shrinks again. */
8759 if (height
> WINDOW_TOTAL_LINES (w
))
8761 int old_height
= WINDOW_TOTAL_LINES (w
);
8762 freeze_window_starts (f
, 1);
8763 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8764 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8766 else if (height
< WINDOW_TOTAL_LINES (w
)
8767 && (exact_p
|| BEGV
== ZV
))
8769 int old_height
= WINDOW_TOTAL_LINES (w
);
8770 freeze_window_starts (f
, 0);
8771 shrink_mini_window (w
);
8772 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8777 /* Always resize to exact size needed. */
8778 if (height
> WINDOW_TOTAL_LINES (w
))
8780 int old_height
= WINDOW_TOTAL_LINES (w
);
8781 freeze_window_starts (f
, 1);
8782 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8783 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8785 else if (height
< WINDOW_TOTAL_LINES (w
))
8787 int old_height
= WINDOW_TOTAL_LINES (w
);
8788 freeze_window_starts (f
, 0);
8789 shrink_mini_window (w
);
8793 freeze_window_starts (f
, 1);
8794 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8797 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8801 if (old_current_buffer
)
8802 set_buffer_internal (old_current_buffer
);
8805 return window_height_changed_p
;
8809 /* Value is the current message, a string, or nil if there is no
8817 if (!BUFFERP (echo_area_buffer
[0]))
8821 with_echo_area_buffer (0, 0, current_message_1
,
8822 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8824 echo_area_buffer
[0] = Qnil
;
8832 current_message_1 (a1
, a2
, a3
, a4
)
8837 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8840 *msg
= make_buffer_string (BEG
, Z
, 1);
8847 /* Push the current message on Vmessage_stack for later restauration
8848 by restore_message. Value is non-zero if the current message isn't
8849 empty. This is a relatively infrequent operation, so it's not
8850 worth optimizing. */
8856 msg
= current_message ();
8857 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8858 return STRINGP (msg
);
8862 /* Restore message display from the top of Vmessage_stack. */
8869 xassert (CONSP (Vmessage_stack
));
8870 msg
= XCAR (Vmessage_stack
);
8872 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8874 message3_nolog (msg
, 0, 0);
8878 /* Handler for record_unwind_protect calling pop_message. */
8881 pop_message_unwind (dummy
)
8888 /* Pop the top-most entry off Vmessage_stack. */
8893 xassert (CONSP (Vmessage_stack
));
8894 Vmessage_stack
= XCDR (Vmessage_stack
);
8898 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8899 exits. If the stack is not empty, we have a missing pop_message
8903 check_message_stack ()
8905 if (!NILP (Vmessage_stack
))
8910 /* Truncate to NCHARS what will be displayed in the echo area the next
8911 time we display it---but don't redisplay it now. */
8914 truncate_echo_area (nchars
)
8918 echo_area_buffer
[0] = Qnil
;
8919 /* A null message buffer means that the frame hasn't really been
8920 initialized yet. Error messages get reported properly by
8921 cmd_error, so this must be just an informative message; toss it. */
8922 else if (!noninteractive
8924 && !NILP (echo_area_buffer
[0]))
8926 struct frame
*sf
= SELECTED_FRAME ();
8927 if (FRAME_MESSAGE_BUF (sf
))
8928 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8933 /* Helper function for truncate_echo_area. Truncate the current
8934 message to at most NCHARS characters. */
8937 truncate_message_1 (nchars
, a2
, a3
, a4
)
8942 if (BEG
+ nchars
< Z
)
8943 del_range (BEG
+ nchars
, Z
);
8945 echo_area_buffer
[0] = Qnil
;
8950 /* Set the current message to a substring of S or STRING.
8952 If STRING is a Lisp string, set the message to the first NBYTES
8953 bytes from STRING. NBYTES zero means use the whole string. If
8954 STRING is multibyte, the message will be displayed multibyte.
8956 If S is not null, set the message to the first LEN bytes of S. LEN
8957 zero means use the whole string. MULTIBYTE_P non-zero means S is
8958 multibyte. Display the message multibyte in that case.
8960 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8961 to t before calling set_message_1 (which calls insert).
8965 set_message (s
, string
, nbytes
, multibyte_p
)
8968 int nbytes
, multibyte_p
;
8970 message_enable_multibyte
8971 = ((s
&& multibyte_p
)
8972 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8974 with_echo_area_buffer (0, -1, set_message_1
,
8975 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8976 message_buf_print
= 0;
8977 help_echo_showing_p
= 0;
8981 /* Helper function for set_message. Arguments have the same meaning
8982 as there, with A1 corresponding to S and A2 corresponding to STRING
8983 This function is called with the echo area buffer being
8987 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8990 EMACS_INT nbytes
, multibyte_p
;
8992 const char *s
= (const char *) a1
;
8993 Lisp_Object string
= a2
;
8995 /* Change multibyteness of the echo buffer appropriately. */
8996 if (message_enable_multibyte
8997 != !NILP (current_buffer
->enable_multibyte_characters
))
8998 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9000 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9002 /* Insert new message at BEG. */
9003 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9005 if (STRINGP (string
))
9010 nbytes
= SBYTES (string
);
9011 nchars
= string_byte_to_char (string
, nbytes
);
9013 /* This function takes care of single/multibyte conversion. We
9014 just have to ensure that the echo area buffer has the right
9015 setting of enable_multibyte_characters. */
9016 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9021 nbytes
= strlen (s
);
9023 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9025 /* Convert from multi-byte to single-byte. */
9027 unsigned char work
[1];
9029 /* Convert a multibyte string to single-byte. */
9030 for (i
= 0; i
< nbytes
; i
+= n
)
9032 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
9033 work
[0] = (ASCII_CHAR_P (c
)
9035 : multibyte_char_to_unibyte (c
, Qnil
));
9036 insert_1_both (work
, 1, 1, 1, 0, 0);
9039 else if (!multibyte_p
9040 && !NILP (current_buffer
->enable_multibyte_characters
))
9042 /* Convert from single-byte to multi-byte. */
9044 const unsigned char *msg
= (const unsigned char *) s
;
9045 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9047 /* Convert a single-byte string to multibyte. */
9048 for (i
= 0; i
< nbytes
; i
++)
9051 c
= unibyte_char_to_multibyte (c
);
9052 n
= CHAR_STRING (c
, str
);
9053 insert_1_both (str
, 1, n
, 1, 0, 0);
9057 insert_1 (s
, nbytes
, 1, 0, 0);
9064 /* Clear messages. CURRENT_P non-zero means clear the current
9065 message. LAST_DISPLAYED_P non-zero means clear the message
9069 clear_message (current_p
, last_displayed_p
)
9070 int current_p
, last_displayed_p
;
9074 echo_area_buffer
[0] = Qnil
;
9075 message_cleared_p
= 1;
9078 if (last_displayed_p
)
9079 echo_area_buffer
[1] = Qnil
;
9081 message_buf_print
= 0;
9084 /* Clear garbaged frames.
9086 This function is used where the old redisplay called
9087 redraw_garbaged_frames which in turn called redraw_frame which in
9088 turn called clear_frame. The call to clear_frame was a source of
9089 flickering. I believe a clear_frame is not necessary. It should
9090 suffice in the new redisplay to invalidate all current matrices,
9091 and ensure a complete redisplay of all windows. */
9094 clear_garbaged_frames ()
9098 Lisp_Object tail
, frame
;
9099 int changed_count
= 0;
9101 FOR_EACH_FRAME (tail
, frame
)
9103 struct frame
*f
= XFRAME (frame
);
9105 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9109 Fredraw_frame (frame
);
9110 f
->force_flush_display_p
= 1;
9112 clear_current_matrices (f
);
9121 ++windows_or_buffers_changed
;
9126 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9127 is non-zero update selected_frame. Value is non-zero if the
9128 mini-windows height has been changed. */
9131 echo_area_display (update_frame_p
)
9134 Lisp_Object mini_window
;
9137 int window_height_changed_p
= 0;
9138 struct frame
*sf
= SELECTED_FRAME ();
9140 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9141 w
= XWINDOW (mini_window
);
9142 f
= XFRAME (WINDOW_FRAME (w
));
9144 /* Don't display if frame is invisible or not yet initialized. */
9145 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9148 #ifdef HAVE_WINDOW_SYSTEM
9149 /* When Emacs starts, selected_frame may be the initial terminal
9150 frame. If we let this through, a message would be displayed on
9152 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9154 #endif /* HAVE_WINDOW_SYSTEM */
9156 /* Redraw garbaged frames. */
9158 clear_garbaged_frames ();
9160 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9162 echo_area_window
= mini_window
;
9163 window_height_changed_p
= display_echo_area (w
);
9164 w
->must_be_updated_p
= 1;
9166 /* Update the display, unless called from redisplay_internal.
9167 Also don't update the screen during redisplay itself. The
9168 update will happen at the end of redisplay, and an update
9169 here could cause confusion. */
9170 if (update_frame_p
&& !redisplaying_p
)
9174 /* If the display update has been interrupted by pending
9175 input, update mode lines in the frame. Due to the
9176 pending input, it might have been that redisplay hasn't
9177 been called, so that mode lines above the echo area are
9178 garbaged. This looks odd, so we prevent it here. */
9179 if (!display_completed
)
9180 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9182 if (window_height_changed_p
9183 /* Don't do this if Emacs is shutting down. Redisplay
9184 needs to run hooks. */
9185 && !NILP (Vrun_hooks
))
9187 /* Must update other windows. Likewise as in other
9188 cases, don't let this update be interrupted by
9190 int count
= SPECPDL_INDEX ();
9191 specbind (Qredisplay_dont_pause
, Qt
);
9192 windows_or_buffers_changed
= 1;
9193 redisplay_internal (0);
9194 unbind_to (count
, Qnil
);
9196 else if (FRAME_WINDOW_P (f
) && n
== 0)
9198 /* Window configuration is the same as before.
9199 Can do with a display update of the echo area,
9200 unless we displayed some mode lines. */
9201 update_single_window (w
, 1);
9202 FRAME_RIF (f
)->flush_display (f
);
9205 update_frame (f
, 1, 1);
9207 /* If cursor is in the echo area, make sure that the next
9208 redisplay displays the minibuffer, so that the cursor will
9209 be replaced with what the minibuffer wants. */
9210 if (cursor_in_echo_area
)
9211 ++windows_or_buffers_changed
;
9214 else if (!EQ (mini_window
, selected_window
))
9215 windows_or_buffers_changed
++;
9217 /* Last displayed message is now the current message. */
9218 echo_area_buffer
[1] = echo_area_buffer
[0];
9219 /* Inform read_char that we're not echoing. */
9220 echo_message_buffer
= Qnil
;
9222 /* Prevent redisplay optimization in redisplay_internal by resetting
9223 this_line_start_pos. This is done because the mini-buffer now
9224 displays the message instead of its buffer text. */
9225 if (EQ (mini_window
, selected_window
))
9226 CHARPOS (this_line_start_pos
) = 0;
9228 return window_height_changed_p
;
9233 /***********************************************************************
9234 Mode Lines and Frame Titles
9235 ***********************************************************************/
9237 /* A buffer for constructing non-propertized mode-line strings and
9238 frame titles in it; allocated from the heap in init_xdisp and
9239 resized as needed in store_mode_line_noprop_char. */
9241 static char *mode_line_noprop_buf
;
9243 /* The buffer's end, and a current output position in it. */
9245 static char *mode_line_noprop_buf_end
;
9246 static char *mode_line_noprop_ptr
;
9248 #define MODE_LINE_NOPROP_LEN(start) \
9249 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9252 MODE_LINE_DISPLAY
= 0,
9258 /* Alist that caches the results of :propertize.
9259 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9260 static Lisp_Object mode_line_proptrans_alist
;
9262 /* List of strings making up the mode-line. */
9263 static Lisp_Object mode_line_string_list
;
9265 /* Base face property when building propertized mode line string. */
9266 static Lisp_Object mode_line_string_face
;
9267 static Lisp_Object mode_line_string_face_prop
;
9270 /* Unwind data for mode line strings */
9272 static Lisp_Object Vmode_line_unwind_vector
;
9275 format_mode_line_unwind_data (struct buffer
*obuf
,
9279 Lisp_Object vector
, tmp
;
9281 /* Reduce consing by keeping one vector in
9282 Vwith_echo_area_save_vector. */
9283 vector
= Vmode_line_unwind_vector
;
9284 Vmode_line_unwind_vector
= Qnil
;
9287 vector
= Fmake_vector (make_number (8), Qnil
);
9289 ASET (vector
, 0, make_number (mode_line_target
));
9290 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9291 ASET (vector
, 2, mode_line_string_list
);
9292 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9293 ASET (vector
, 4, mode_line_string_face
);
9294 ASET (vector
, 5, mode_line_string_face_prop
);
9297 XSETBUFFER (tmp
, obuf
);
9300 ASET (vector
, 6, tmp
);
9301 ASET (vector
, 7, owin
);
9307 unwind_format_mode_line (vector
)
9310 mode_line_target
= XINT (AREF (vector
, 0));
9311 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9312 mode_line_string_list
= AREF (vector
, 2);
9313 if (! EQ (AREF (vector
, 3), Qt
))
9314 mode_line_proptrans_alist
= AREF (vector
, 3);
9315 mode_line_string_face
= AREF (vector
, 4);
9316 mode_line_string_face_prop
= AREF (vector
, 5);
9318 if (!NILP (AREF (vector
, 7)))
9319 /* Select window before buffer, since it may change the buffer. */
9320 Fselect_window (AREF (vector
, 7), Qt
);
9322 if (!NILP (AREF (vector
, 6)))
9324 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9325 ASET (vector
, 6, Qnil
);
9328 Vmode_line_unwind_vector
= vector
;
9333 /* Store a single character C for the frame title in mode_line_noprop_buf.
9334 Re-allocate mode_line_noprop_buf if necessary. */
9338 store_mode_line_noprop_char (char c
)
9340 store_mode_line_noprop_char (c
)
9344 /* If output position has reached the end of the allocated buffer,
9345 double the buffer's size. */
9346 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9348 int len
= MODE_LINE_NOPROP_LEN (0);
9349 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9350 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9351 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9352 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9355 *mode_line_noprop_ptr
++ = c
;
9359 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9360 mode_line_noprop_ptr. STR is the string to store. Do not copy
9361 characters that yield more columns than PRECISION; PRECISION <= 0
9362 means copy the whole string. Pad with spaces until FIELD_WIDTH
9363 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9364 pad. Called from display_mode_element when it is used to build a
9368 store_mode_line_noprop (str
, field_width
, precision
)
9369 const unsigned char *str
;
9370 int field_width
, precision
;
9375 /* Copy at most PRECISION chars from STR. */
9376 nbytes
= strlen (str
);
9377 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9379 store_mode_line_noprop_char (*str
++);
9381 /* Fill up with spaces until FIELD_WIDTH reached. */
9382 while (field_width
> 0
9385 store_mode_line_noprop_char (' ');
9392 /***********************************************************************
9394 ***********************************************************************/
9396 #ifdef HAVE_WINDOW_SYSTEM
9398 /* Set the title of FRAME, if it has changed. The title format is
9399 Vicon_title_format if FRAME is iconified, otherwise it is
9400 frame_title_format. */
9403 x_consider_frame_title (frame
)
9406 struct frame
*f
= XFRAME (frame
);
9408 if (FRAME_WINDOW_P (f
)
9409 || FRAME_MINIBUF_ONLY_P (f
)
9410 || f
->explicit_name
)
9412 /* Do we have more than one visible frame on this X display? */
9419 int count
= SPECPDL_INDEX ();
9421 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9423 Lisp_Object other_frame
= XCAR (tail
);
9424 struct frame
*tf
= XFRAME (other_frame
);
9427 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9428 && !FRAME_MINIBUF_ONLY_P (tf
)
9429 && !EQ (other_frame
, tip_frame
)
9430 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9434 /* Set global variable indicating that multiple frames exist. */
9435 multiple_frames
= CONSP (tail
);
9437 /* Switch to the buffer of selected window of the frame. Set up
9438 mode_line_target so that display_mode_element will output into
9439 mode_line_noprop_buf; then display the title. */
9440 record_unwind_protect (unwind_format_mode_line
,
9441 format_mode_line_unwind_data
9442 (current_buffer
, selected_window
, 0));
9444 Fselect_window (f
->selected_window
, Qt
);
9445 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9446 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9448 mode_line_target
= MODE_LINE_TITLE
;
9449 title_start
= MODE_LINE_NOPROP_LEN (0);
9450 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9451 NULL
, DEFAULT_FACE_ID
);
9452 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9453 len
= MODE_LINE_NOPROP_LEN (title_start
);
9454 title
= mode_line_noprop_buf
+ title_start
;
9455 unbind_to (count
, Qnil
);
9457 /* Set the title only if it's changed. This avoids consing in
9458 the common case where it hasn't. (If it turns out that we've
9459 already wasted too much time by walking through the list with
9460 display_mode_element, then we might need to optimize at a
9461 higher level than this.) */
9462 if (! STRINGP (f
->name
)
9463 || SBYTES (f
->name
) != len
9464 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9469 if (!MINI_WINDOW_P(XWINDOW(f
->selected_window
)))
9472 ns_set_name_as_filename (f
);
9474 x_implicitly_set_name (f
, make_string(title
, len
),
9480 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9485 /* do this also for frames with explicit names */
9486 ns_implicitly_set_icon_type(f
);
9487 ns_set_doc_edited(f
, Fbuffer_modified_p
9488 (XWINDOW (f
->selected_window
)->buffer
), Qnil
);
9494 #endif /* not HAVE_WINDOW_SYSTEM */
9499 /***********************************************************************
9501 ***********************************************************************/
9504 /* Prepare for redisplay by updating menu-bar item lists when
9505 appropriate. This can call eval. */
9508 prepare_menu_bars ()
9511 struct gcpro gcpro1
, gcpro2
;
9513 Lisp_Object tooltip_frame
;
9515 #ifdef HAVE_WINDOW_SYSTEM
9516 tooltip_frame
= tip_frame
;
9518 tooltip_frame
= Qnil
;
9521 /* Update all frame titles based on their buffer names, etc. We do
9522 this before the menu bars so that the buffer-menu will show the
9523 up-to-date frame titles. */
9524 #ifdef HAVE_WINDOW_SYSTEM
9525 if (windows_or_buffers_changed
|| update_mode_lines
)
9527 Lisp_Object tail
, frame
;
9529 FOR_EACH_FRAME (tail
, frame
)
9532 if (!EQ (frame
, tooltip_frame
)
9533 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9534 x_consider_frame_title (frame
);
9537 #endif /* HAVE_WINDOW_SYSTEM */
9539 /* Update the menu bar item lists, if appropriate. This has to be
9540 done before any actual redisplay or generation of display lines. */
9541 all_windows
= (update_mode_lines
9542 || buffer_shared
> 1
9543 || windows_or_buffers_changed
);
9546 Lisp_Object tail
, frame
;
9547 int count
= SPECPDL_INDEX ();
9548 /* 1 means that update_menu_bar has run its hooks
9549 so any further calls to update_menu_bar shouldn't do so again. */
9550 int menu_bar_hooks_run
= 0;
9552 record_unwind_save_match_data ();
9554 FOR_EACH_FRAME (tail
, frame
)
9558 /* Ignore tooltip frame. */
9559 if (EQ (frame
, tooltip_frame
))
9562 /* If a window on this frame changed size, report that to
9563 the user and clear the size-change flag. */
9564 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9566 Lisp_Object functions
;
9568 /* Clear flag first in case we get an error below. */
9569 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9570 functions
= Vwindow_size_change_functions
;
9571 GCPRO2 (tail
, functions
);
9573 while (CONSP (functions
))
9575 if (!EQ (XCAR (functions
), Qt
))
9576 call1 (XCAR (functions
), frame
);
9577 functions
= XCDR (functions
);
9583 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9584 #ifdef HAVE_WINDOW_SYSTEM
9585 update_tool_bar (f
, 0);
9590 unbind_to (count
, Qnil
);
9594 struct frame
*sf
= SELECTED_FRAME ();
9595 update_menu_bar (sf
, 1, 0);
9596 #ifdef HAVE_WINDOW_SYSTEM
9597 update_tool_bar (sf
, 1);
9601 /* Motif needs this. See comment in xmenu.c. Turn it off when
9602 pending_menu_activation is not defined. */
9603 #ifdef USE_X_TOOLKIT
9604 pending_menu_activation
= 0;
9609 /* Update the menu bar item list for frame F. This has to be done
9610 before we start to fill in any display lines, because it can call
9613 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9615 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9616 already ran the menu bar hooks for this redisplay, so there
9617 is no need to run them again. The return value is the
9618 updated value of this flag, to pass to the next call. */
9621 update_menu_bar (f
, save_match_data
, hooks_run
)
9623 int save_match_data
;
9627 register struct window
*w
;
9629 /* If called recursively during a menu update, do nothing. This can
9630 happen when, for instance, an activate-menubar-hook causes a
9632 if (inhibit_menubar_update
)
9635 window
= FRAME_SELECTED_WINDOW (f
);
9636 w
= XWINDOW (window
);
9638 if (FRAME_WINDOW_P (f
)
9640 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9641 || defined (HAVE_NS) || defined (USE_GTK)
9642 FRAME_EXTERNAL_MENU_BAR (f
)
9644 FRAME_MENU_BAR_LINES (f
) > 0
9646 : FRAME_MENU_BAR_LINES (f
) > 0)
9648 /* If the user has switched buffers or windows, we need to
9649 recompute to reflect the new bindings. But we'll
9650 recompute when update_mode_lines is set too; that means
9651 that people can use force-mode-line-update to request
9652 that the menu bar be recomputed. The adverse effect on
9653 the rest of the redisplay algorithm is about the same as
9654 windows_or_buffers_changed anyway. */
9655 if (windows_or_buffers_changed
9656 /* This used to test w->update_mode_line, but we believe
9657 there is no need to recompute the menu in that case. */
9658 || update_mode_lines
9659 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9660 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9661 != !NILP (w
->last_had_star
))
9662 || ((!NILP (Vtransient_mark_mode
)
9663 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9664 != !NILP (w
->region_showing
)))
9666 struct buffer
*prev
= current_buffer
;
9667 int count
= SPECPDL_INDEX ();
9669 specbind (Qinhibit_menubar_update
, Qt
);
9671 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9672 if (save_match_data
)
9673 record_unwind_save_match_data ();
9674 if (NILP (Voverriding_local_map_menu_flag
))
9676 specbind (Qoverriding_terminal_local_map
, Qnil
);
9677 specbind (Qoverriding_local_map
, Qnil
);
9682 /* Run the Lucid hook. */
9683 safe_run_hooks (Qactivate_menubar_hook
);
9685 /* If it has changed current-menubar from previous value,
9686 really recompute the menu-bar from the value. */
9687 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9688 call0 (Qrecompute_lucid_menubar
);
9690 safe_run_hooks (Qmenu_bar_update_hook
);
9695 XSETFRAME (Vmenu_updating_frame
, f
);
9696 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9698 /* Redisplay the menu bar in case we changed it. */
9699 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9700 || defined (HAVE_NS) || defined (USE_GTK)
9701 if (FRAME_WINDOW_P (f
))
9703 #if defined (HAVE_NS)
9704 /* All frames on Mac OS share the same menubar. So only
9705 the selected frame should be allowed to set it. */
9706 if (f
== SELECTED_FRAME ())
9708 set_frame_menubar (f
, 0, 0);
9711 /* On a terminal screen, the menu bar is an ordinary screen
9712 line, and this makes it get updated. */
9713 w
->update_mode_line
= Qt
;
9714 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9715 /* In the non-toolkit version, the menu bar is an ordinary screen
9716 line, and this makes it get updated. */
9717 w
->update_mode_line
= Qt
;
9718 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9720 unbind_to (count
, Qnil
);
9721 set_buffer_internal_1 (prev
);
9730 /***********************************************************************
9732 ***********************************************************************/
9734 #ifdef HAVE_WINDOW_SYSTEM
9737 Nominal cursor position -- where to draw output.
9738 HPOS and VPOS are window relative glyph matrix coordinates.
9739 X and Y are window relative pixel coordinates. */
9741 struct cursor_pos output_cursor
;
9745 Set the global variable output_cursor to CURSOR. All cursor
9746 positions are relative to updated_window. */
9749 set_output_cursor (cursor
)
9750 struct cursor_pos
*cursor
;
9752 output_cursor
.hpos
= cursor
->hpos
;
9753 output_cursor
.vpos
= cursor
->vpos
;
9754 output_cursor
.x
= cursor
->x
;
9755 output_cursor
.y
= cursor
->y
;
9760 Set a nominal cursor position.
9762 HPOS and VPOS are column/row positions in a window glyph matrix. X
9763 and Y are window text area relative pixel positions.
9765 If this is done during an update, updated_window will contain the
9766 window that is being updated and the position is the future output
9767 cursor position for that window. If updated_window is null, use
9768 selected_window and display the cursor at the given position. */
9771 x_cursor_to (vpos
, hpos
, y
, x
)
9772 int vpos
, hpos
, y
, x
;
9776 /* If updated_window is not set, work on selected_window. */
9780 w
= XWINDOW (selected_window
);
9782 /* Set the output cursor. */
9783 output_cursor
.hpos
= hpos
;
9784 output_cursor
.vpos
= vpos
;
9785 output_cursor
.x
= x
;
9786 output_cursor
.y
= y
;
9788 /* If not called as part of an update, really display the cursor.
9789 This will also set the cursor position of W. */
9790 if (updated_window
== NULL
)
9793 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9794 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9795 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9800 #endif /* HAVE_WINDOW_SYSTEM */
9803 /***********************************************************************
9805 ***********************************************************************/
9807 #ifdef HAVE_WINDOW_SYSTEM
9809 /* Where the mouse was last time we reported a mouse event. */
9811 FRAME_PTR last_mouse_frame
;
9813 /* Tool-bar item index of the item on which a mouse button was pressed
9816 int last_tool_bar_item
;
9820 update_tool_bar_unwind (frame
)
9823 selected_frame
= frame
;
9827 /* Update the tool-bar item list for frame F. This has to be done
9828 before we start to fill in any display lines. Called from
9829 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9830 and restore it here. */
9833 update_tool_bar (f
, save_match_data
)
9835 int save_match_data
;
9837 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
9838 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9840 int do_update
= WINDOWP (f
->tool_bar_window
)
9841 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9849 window
= FRAME_SELECTED_WINDOW (f
);
9850 w
= XWINDOW (window
);
9852 /* If the user has switched buffers or windows, we need to
9853 recompute to reflect the new bindings. But we'll
9854 recompute when update_mode_lines is set too; that means
9855 that people can use force-mode-line-update to request
9856 that the menu bar be recomputed. The adverse effect on
9857 the rest of the redisplay algorithm is about the same as
9858 windows_or_buffers_changed anyway. */
9859 if (windows_or_buffers_changed
9860 || !NILP (w
->update_mode_line
)
9861 || update_mode_lines
9862 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9863 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9864 != !NILP (w
->last_had_star
))
9865 || ((!NILP (Vtransient_mark_mode
)
9866 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9867 != !NILP (w
->region_showing
)))
9869 struct buffer
*prev
= current_buffer
;
9870 int count
= SPECPDL_INDEX ();
9871 Lisp_Object frame
, new_tool_bar
;
9873 struct gcpro gcpro1
;
9875 /* Set current_buffer to the buffer of the selected
9876 window of the frame, so that we get the right local
9878 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9880 /* Save match data, if we must. */
9881 if (save_match_data
)
9882 record_unwind_save_match_data ();
9884 /* Make sure that we don't accidentally use bogus keymaps. */
9885 if (NILP (Voverriding_local_map_menu_flag
))
9887 specbind (Qoverriding_terminal_local_map
, Qnil
);
9888 specbind (Qoverriding_local_map
, Qnil
);
9891 GCPRO1 (new_tool_bar
);
9893 /* We must temporarily set the selected frame to this frame
9894 before calling tool_bar_items, because the calculation of
9895 the tool-bar keymap uses the selected frame (see
9896 `tool-bar-make-keymap' in tool-bar.el). */
9897 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
9898 XSETFRAME (frame
, f
);
9899 selected_frame
= frame
;
9901 /* Build desired tool-bar items from keymaps. */
9902 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9905 /* Redisplay the tool-bar if we changed it. */
9906 if (new_n_tool_bar
!= f
->n_tool_bar_items
9907 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9909 /* Redisplay that happens asynchronously due to an expose event
9910 may access f->tool_bar_items. Make sure we update both
9911 variables within BLOCK_INPUT so no such event interrupts. */
9913 f
->tool_bar_items
= new_tool_bar
;
9914 f
->n_tool_bar_items
= new_n_tool_bar
;
9915 w
->update_mode_line
= Qt
;
9921 unbind_to (count
, Qnil
);
9922 set_buffer_internal_1 (prev
);
9928 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9929 F's desired tool-bar contents. F->tool_bar_items must have
9930 been set up previously by calling prepare_menu_bars. */
9933 build_desired_tool_bar_string (f
)
9936 int i
, size
, size_needed
;
9937 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9938 Lisp_Object image
, plist
, props
;
9940 image
= plist
= props
= Qnil
;
9941 GCPRO3 (image
, plist
, props
);
9943 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9944 Otherwise, make a new string. */
9946 /* The size of the string we might be able to reuse. */
9947 size
= (STRINGP (f
->desired_tool_bar_string
)
9948 ? SCHARS (f
->desired_tool_bar_string
)
9951 /* We need one space in the string for each image. */
9952 size_needed
= f
->n_tool_bar_items
;
9954 /* Reuse f->desired_tool_bar_string, if possible. */
9955 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9956 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9960 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9961 Fremove_text_properties (make_number (0), make_number (size
),
9962 props
, f
->desired_tool_bar_string
);
9965 /* Put a `display' property on the string for the images to display,
9966 put a `menu_item' property on tool-bar items with a value that
9967 is the index of the item in F's tool-bar item vector. */
9968 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9970 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9972 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9973 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9974 int hmargin
, vmargin
, relief
, idx
, end
;
9975 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9977 /* If image is a vector, choose the image according to the
9979 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9980 if (VECTORP (image
))
9984 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9985 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9988 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9989 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9991 xassert (ASIZE (image
) >= idx
);
9992 image
= AREF (image
, idx
);
9997 /* Ignore invalid image specifications. */
9998 if (!valid_image_p (image
))
10001 /* Display the tool-bar button pressed, or depressed. */
10002 plist
= Fcopy_sequence (XCDR (image
));
10004 /* Compute margin and relief to draw. */
10005 relief
= (tool_bar_button_relief
>= 0
10006 ? tool_bar_button_relief
10007 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10008 hmargin
= vmargin
= relief
;
10010 if (INTEGERP (Vtool_bar_button_margin
)
10011 && XINT (Vtool_bar_button_margin
) > 0)
10013 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10014 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10016 else if (CONSP (Vtool_bar_button_margin
))
10018 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10019 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10020 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10022 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10023 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10024 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10027 if (auto_raise_tool_bar_buttons_p
)
10029 /* Add a `:relief' property to the image spec if the item is
10033 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10040 /* If image is selected, display it pressed, i.e. with a
10041 negative relief. If it's not selected, display it with a
10043 plist
= Fplist_put (plist
, QCrelief
,
10045 ? make_number (-relief
)
10046 : make_number (relief
)));
10051 /* Put a margin around the image. */
10052 if (hmargin
|| vmargin
)
10054 if (hmargin
== vmargin
)
10055 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10057 plist
= Fplist_put (plist
, QCmargin
,
10058 Fcons (make_number (hmargin
),
10059 make_number (vmargin
)));
10062 /* If button is not enabled, and we don't have special images
10063 for the disabled state, make the image appear disabled by
10064 applying an appropriate algorithm to it. */
10065 if (!enabled_p
&& idx
< 0)
10066 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10068 /* Put a `display' text property on the string for the image to
10069 display. Put a `menu-item' property on the string that gives
10070 the start of this item's properties in the tool-bar items
10072 image
= Fcons (Qimage
, plist
);
10073 props
= list4 (Qdisplay
, image
,
10074 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10076 /* Let the last image hide all remaining spaces in the tool bar
10077 string. The string can be longer than needed when we reuse a
10078 previous string. */
10079 if (i
+ 1 == f
->n_tool_bar_items
)
10080 end
= SCHARS (f
->desired_tool_bar_string
);
10083 Fadd_text_properties (make_number (i
), make_number (end
),
10084 props
, f
->desired_tool_bar_string
);
10092 /* Display one line of the tool-bar of frame IT->f.
10094 HEIGHT specifies the desired height of the tool-bar line.
10095 If the actual height of the glyph row is less than HEIGHT, the
10096 row's height is increased to HEIGHT, and the icons are centered
10097 vertically in the new height.
10099 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10100 count a final empty row in case the tool-bar width exactly matches
10105 display_tool_bar_line (it
, height
)
10109 struct glyph_row
*row
= it
->glyph_row
;
10110 int max_x
= it
->last_visible_x
;
10111 struct glyph
*last
;
10113 prepare_desired_row (row
);
10114 row
->y
= it
->current_y
;
10116 /* Note that this isn't made use of if the face hasn't a box,
10117 so there's no need to check the face here. */
10118 it
->start_of_box_run_p
= 1;
10120 while (it
->current_x
< max_x
)
10122 int x
, n_glyphs_before
, i
, nglyphs
;
10123 struct it it_before
;
10125 /* Get the next display element. */
10126 if (!get_next_display_element (it
))
10128 /* Don't count empty row if we are counting needed tool-bar lines. */
10129 if (height
< 0 && !it
->hpos
)
10134 /* Produce glyphs. */
10135 n_glyphs_before
= row
->used
[TEXT_AREA
];
10138 PRODUCE_GLYPHS (it
);
10140 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10142 x
= it_before
.current_x
;
10143 while (i
< nglyphs
)
10145 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10147 if (x
+ glyph
->pixel_width
> max_x
)
10149 /* Glyph doesn't fit on line. Backtrack. */
10150 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10152 /* If this is the only glyph on this line, it will never fit on the
10153 toolbar, so skip it. But ensure there is at least one glyph,
10154 so we don't accidentally disable the tool-bar. */
10155 if (n_glyphs_before
== 0
10156 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10162 x
+= glyph
->pixel_width
;
10166 /* Stop at line ends. */
10167 if (ITERATOR_AT_END_OF_LINE_P (it
))
10170 set_iterator_to_next (it
, 1);
10175 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10177 /* Use default face for the border below the tool bar.
10179 FIXME: When auto-resize-tool-bars is grow-only, there is
10180 no additional border below the possibly empty tool-bar lines.
10181 So to make the extra empty lines look "normal", we have to
10182 use the tool-bar face for the border too. */
10183 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10184 it
->face_id
= DEFAULT_FACE_ID
;
10186 extend_face_to_end_of_line (it
);
10187 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10188 last
->right_box_line_p
= 1;
10189 if (last
== row
->glyphs
[TEXT_AREA
])
10190 last
->left_box_line_p
= 1;
10192 /* Make line the desired height and center it vertically. */
10193 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10195 /* Don't add more than one line height. */
10196 height
%= FRAME_LINE_HEIGHT (it
->f
);
10197 it
->max_ascent
+= height
/ 2;
10198 it
->max_descent
+= (height
+ 1) / 2;
10201 compute_line_metrics (it
);
10203 /* If line is empty, make it occupy the rest of the tool-bar. */
10204 if (!row
->displays_text_p
)
10206 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10207 row
->visible_height
= row
->height
;
10208 row
->ascent
= row
->phys_ascent
= 0;
10209 row
->extra_line_spacing
= 0;
10212 row
->full_width_p
= 1;
10213 row
->continued_p
= 0;
10214 row
->truncated_on_left_p
= 0;
10215 row
->truncated_on_right_p
= 0;
10217 it
->current_x
= it
->hpos
= 0;
10218 it
->current_y
+= row
->height
;
10224 /* Max tool-bar height. */
10226 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10227 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10229 /* Value is the number of screen lines needed to make all tool-bar
10230 items of frame F visible. The number of actual rows needed is
10231 returned in *N_ROWS if non-NULL. */
10234 tool_bar_lines_needed (f
, n_rows
)
10238 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10240 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10241 the desired matrix, so use (unused) mode-line row as temporary row to
10242 avoid destroying the first tool-bar row. */
10243 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10245 /* Initialize an iterator for iteration over
10246 F->desired_tool_bar_string in the tool-bar window of frame F. */
10247 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10248 it
.first_visible_x
= 0;
10249 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10250 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10252 while (!ITERATOR_AT_END_P (&it
))
10254 clear_glyph_row (temp_row
);
10255 it
.glyph_row
= temp_row
;
10256 display_tool_bar_line (&it
, -1);
10258 clear_glyph_row (temp_row
);
10260 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10262 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10264 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10268 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10270 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10279 frame
= selected_frame
;
10281 CHECK_FRAME (frame
);
10282 f
= XFRAME (frame
);
10284 if (WINDOWP (f
->tool_bar_window
)
10285 || (w
= XWINDOW (f
->tool_bar_window
),
10286 WINDOW_TOTAL_LINES (w
) > 0))
10288 update_tool_bar (f
, 1);
10289 if (f
->n_tool_bar_items
)
10291 build_desired_tool_bar_string (f
);
10292 nlines
= tool_bar_lines_needed (f
, NULL
);
10296 return make_number (nlines
);
10300 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10301 height should be changed. */
10304 redisplay_tool_bar (f
)
10309 struct glyph_row
*row
;
10311 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
10312 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10313 update_frame_tool_bar (f
);
10317 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10318 do anything. This means you must start with tool-bar-lines
10319 non-zero to get the auto-sizing effect. Or in other words, you
10320 can turn off tool-bars by specifying tool-bar-lines zero. */
10321 if (!WINDOWP (f
->tool_bar_window
)
10322 || (w
= XWINDOW (f
->tool_bar_window
),
10323 WINDOW_TOTAL_LINES (w
) == 0))
10326 /* Set up an iterator for the tool-bar window. */
10327 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10328 it
.first_visible_x
= 0;
10329 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10330 row
= it
.glyph_row
;
10332 /* Build a string that represents the contents of the tool-bar. */
10333 build_desired_tool_bar_string (f
);
10334 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10336 if (f
->n_tool_bar_rows
== 0)
10340 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10341 nlines
!= WINDOW_TOTAL_LINES (w
)))
10343 extern Lisp_Object Qtool_bar_lines
;
10345 int old_height
= WINDOW_TOTAL_LINES (w
);
10347 XSETFRAME (frame
, f
);
10348 Fmodify_frame_parameters (frame
,
10349 Fcons (Fcons (Qtool_bar_lines
,
10350 make_number (nlines
)),
10352 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10354 clear_glyph_matrix (w
->desired_matrix
);
10355 fonts_changed_p
= 1;
10361 /* Display as many lines as needed to display all tool-bar items. */
10363 if (f
->n_tool_bar_rows
> 0)
10365 int border
, rows
, height
, extra
;
10367 if (INTEGERP (Vtool_bar_border
))
10368 border
= XINT (Vtool_bar_border
);
10369 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10370 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10371 else if (EQ (Vtool_bar_border
, Qborder_width
))
10372 border
= f
->border_width
;
10378 rows
= f
->n_tool_bar_rows
;
10379 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10380 extra
= it
.last_visible_y
- border
- height
* rows
;
10382 while (it
.current_y
< it
.last_visible_y
)
10385 if (extra
> 0 && rows
-- > 0)
10387 h
= (extra
+ rows
- 1) / rows
;
10390 display_tool_bar_line (&it
, height
+ h
);
10395 while (it
.current_y
< it
.last_visible_y
)
10396 display_tool_bar_line (&it
, 0);
10399 /* It doesn't make much sense to try scrolling in the tool-bar
10400 window, so don't do it. */
10401 w
->desired_matrix
->no_scrolling_p
= 1;
10402 w
->must_be_updated_p
= 1;
10404 if (!NILP (Vauto_resize_tool_bars
))
10406 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10407 int change_height_p
= 0;
10409 /* If we couldn't display everything, change the tool-bar's
10410 height if there is room for more. */
10411 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10412 && it
.current_y
< max_tool_bar_height
)
10413 change_height_p
= 1;
10415 row
= it
.glyph_row
- 1;
10417 /* If there are blank lines at the end, except for a partially
10418 visible blank line at the end that is smaller than
10419 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10420 if (!row
->displays_text_p
10421 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10422 change_height_p
= 1;
10424 /* If row displays tool-bar items, but is partially visible,
10425 change the tool-bar's height. */
10426 if (row
->displays_text_p
10427 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10428 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10429 change_height_p
= 1;
10431 /* Resize windows as needed by changing the `tool-bar-lines'
10432 frame parameter. */
10433 if (change_height_p
)
10435 extern Lisp_Object Qtool_bar_lines
;
10437 int old_height
= WINDOW_TOTAL_LINES (w
);
10439 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10441 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10442 && !f
->minimize_tool_bar_window_p
)
10443 ? (nlines
> old_height
)
10444 : (nlines
!= old_height
));
10445 f
->minimize_tool_bar_window_p
= 0;
10447 if (change_height_p
)
10449 XSETFRAME (frame
, f
);
10450 Fmodify_frame_parameters (frame
,
10451 Fcons (Fcons (Qtool_bar_lines
,
10452 make_number (nlines
)),
10454 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10456 clear_glyph_matrix (w
->desired_matrix
);
10457 f
->n_tool_bar_rows
= nrows
;
10458 fonts_changed_p
= 1;
10465 f
->minimize_tool_bar_window_p
= 0;
10470 /* Get information about the tool-bar item which is displayed in GLYPH
10471 on frame F. Return in *PROP_IDX the index where tool-bar item
10472 properties start in F->tool_bar_items. Value is zero if
10473 GLYPH doesn't display a tool-bar item. */
10476 tool_bar_item_info (f
, glyph
, prop_idx
)
10478 struct glyph
*glyph
;
10485 /* This function can be called asynchronously, which means we must
10486 exclude any possibility that Fget_text_property signals an
10488 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10489 charpos
= max (0, charpos
);
10491 /* Get the text property `menu-item' at pos. The value of that
10492 property is the start index of this item's properties in
10493 F->tool_bar_items. */
10494 prop
= Fget_text_property (make_number (charpos
),
10495 Qmenu_item
, f
->current_tool_bar_string
);
10496 if (INTEGERP (prop
))
10498 *prop_idx
= XINT (prop
);
10508 /* Get information about the tool-bar item at position X/Y on frame F.
10509 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10510 the current matrix of the tool-bar window of F, or NULL if not
10511 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10512 item in F->tool_bar_items. Value is
10514 -1 if X/Y is not on a tool-bar item
10515 0 if X/Y is on the same item that was highlighted before.
10519 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10522 struct glyph
**glyph
;
10523 int *hpos
, *vpos
, *prop_idx
;
10525 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10526 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10529 /* Find the glyph under X/Y. */
10530 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10531 if (*glyph
== NULL
)
10534 /* Get the start of this tool-bar item's properties in
10535 f->tool_bar_items. */
10536 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10539 /* Is mouse on the highlighted item? */
10540 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10541 && *vpos
>= dpyinfo
->mouse_face_beg_row
10542 && *vpos
<= dpyinfo
->mouse_face_end_row
10543 && (*vpos
> dpyinfo
->mouse_face_beg_row
10544 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10545 && (*vpos
< dpyinfo
->mouse_face_end_row
10546 || *hpos
< dpyinfo
->mouse_face_end_col
10547 || dpyinfo
->mouse_face_past_end
))
10555 Handle mouse button event on the tool-bar of frame F, at
10556 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10557 0 for button release. MODIFIERS is event modifiers for button
10561 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10564 unsigned int modifiers
;
10566 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10567 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10568 int hpos
, vpos
, prop_idx
;
10569 struct glyph
*glyph
;
10570 Lisp_Object enabled_p
;
10572 /* If not on the highlighted tool-bar item, return. */
10573 frame_to_window_pixel_xy (w
, &x
, &y
);
10574 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10577 /* If item is disabled, do nothing. */
10578 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10579 if (NILP (enabled_p
))
10584 /* Show item in pressed state. */
10585 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10586 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10587 last_tool_bar_item
= prop_idx
;
10591 Lisp_Object key
, frame
;
10592 struct input_event event
;
10593 EVENT_INIT (event
);
10595 /* Show item in released state. */
10596 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10597 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10599 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10601 XSETFRAME (frame
, f
);
10602 event
.kind
= TOOL_BAR_EVENT
;
10603 event
.frame_or_window
= frame
;
10605 kbd_buffer_store_event (&event
);
10607 event
.kind
= TOOL_BAR_EVENT
;
10608 event
.frame_or_window
= frame
;
10610 event
.modifiers
= modifiers
;
10611 kbd_buffer_store_event (&event
);
10612 last_tool_bar_item
= -1;
10617 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10618 tool-bar window-relative coordinates X/Y. Called from
10619 note_mouse_highlight. */
10622 note_tool_bar_highlight (f
, x
, y
)
10626 Lisp_Object window
= f
->tool_bar_window
;
10627 struct window
*w
= XWINDOW (window
);
10628 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10630 struct glyph
*glyph
;
10631 struct glyph_row
*row
;
10633 Lisp_Object enabled_p
;
10635 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10636 int mouse_down_p
, rc
;
10638 /* Function note_mouse_highlight is called with negative x(y
10639 values when mouse moves outside of the frame. */
10640 if (x
<= 0 || y
<= 0)
10642 clear_mouse_face (dpyinfo
);
10646 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10649 /* Not on tool-bar item. */
10650 clear_mouse_face (dpyinfo
);
10654 /* On same tool-bar item as before. */
10655 goto set_help_echo
;
10657 clear_mouse_face (dpyinfo
);
10659 /* Mouse is down, but on different tool-bar item? */
10660 mouse_down_p
= (dpyinfo
->grabbed
10661 && f
== last_mouse_frame
10662 && FRAME_LIVE_P (f
));
10664 && last_tool_bar_item
!= prop_idx
)
10667 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10668 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10670 /* If tool-bar item is not enabled, don't highlight it. */
10671 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10672 if (!NILP (enabled_p
))
10674 /* Compute the x-position of the glyph. In front and past the
10675 image is a space. We include this in the highlighted area. */
10676 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10677 for (i
= x
= 0; i
< hpos
; ++i
)
10678 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10680 /* Record this as the current active region. */
10681 dpyinfo
->mouse_face_beg_col
= hpos
;
10682 dpyinfo
->mouse_face_beg_row
= vpos
;
10683 dpyinfo
->mouse_face_beg_x
= x
;
10684 dpyinfo
->mouse_face_beg_y
= row
->y
;
10685 dpyinfo
->mouse_face_past_end
= 0;
10687 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10688 dpyinfo
->mouse_face_end_row
= vpos
;
10689 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10690 dpyinfo
->mouse_face_end_y
= row
->y
;
10691 dpyinfo
->mouse_face_window
= window
;
10692 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10694 /* Display it as active. */
10695 show_mouse_face (dpyinfo
, draw
);
10696 dpyinfo
->mouse_face_image_state
= draw
;
10701 /* Set help_echo_string to a help string to display for this tool-bar item.
10702 XTread_socket does the rest. */
10703 help_echo_object
= help_echo_window
= Qnil
;
10704 help_echo_pos
= -1;
10705 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10706 if (NILP (help_echo_string
))
10707 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10710 #endif /* HAVE_WINDOW_SYSTEM */
10714 /************************************************************************
10715 Horizontal scrolling
10716 ************************************************************************/
10718 static int hscroll_window_tree
P_ ((Lisp_Object
));
10719 static int hscroll_windows
P_ ((Lisp_Object
));
10721 /* For all leaf windows in the window tree rooted at WINDOW, set their
10722 hscroll value so that PT is (i) visible in the window, and (ii) so
10723 that it is not within a certain margin at the window's left and
10724 right border. Value is non-zero if any window's hscroll has been
10728 hscroll_window_tree (window
)
10729 Lisp_Object window
;
10731 int hscrolled_p
= 0;
10732 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10733 int hscroll_step_abs
= 0;
10734 double hscroll_step_rel
= 0;
10736 if (hscroll_relative_p
)
10738 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10739 if (hscroll_step_rel
< 0)
10741 hscroll_relative_p
= 0;
10742 hscroll_step_abs
= 0;
10745 else if (INTEGERP (Vhscroll_step
))
10747 hscroll_step_abs
= XINT (Vhscroll_step
);
10748 if (hscroll_step_abs
< 0)
10749 hscroll_step_abs
= 0;
10752 hscroll_step_abs
= 0;
10754 while (WINDOWP (window
))
10756 struct window
*w
= XWINDOW (window
);
10758 if (WINDOWP (w
->hchild
))
10759 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10760 else if (WINDOWP (w
->vchild
))
10761 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10762 else if (w
->cursor
.vpos
>= 0)
10765 int text_area_width
;
10766 struct glyph_row
*current_cursor_row
10767 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10768 struct glyph_row
*desired_cursor_row
10769 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10770 struct glyph_row
*cursor_row
10771 = (desired_cursor_row
->enabled_p
10772 ? desired_cursor_row
10773 : current_cursor_row
);
10775 text_area_width
= window_box_width (w
, TEXT_AREA
);
10777 /* Scroll when cursor is inside this scroll margin. */
10778 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10780 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10781 && ((XFASTINT (w
->hscroll
)
10782 && w
->cursor
.x
<= h_margin
)
10783 || (cursor_row
->enabled_p
10784 && cursor_row
->truncated_on_right_p
10785 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10789 struct buffer
*saved_current_buffer
;
10793 /* Find point in a display of infinite width. */
10794 saved_current_buffer
= current_buffer
;
10795 current_buffer
= XBUFFER (w
->buffer
);
10797 if (w
== XWINDOW (selected_window
))
10798 pt
= BUF_PT (current_buffer
);
10801 pt
= marker_position (w
->pointm
);
10802 pt
= max (BEGV
, pt
);
10806 /* Move iterator to pt starting at cursor_row->start in
10807 a line with infinite width. */
10808 init_to_row_start (&it
, w
, cursor_row
);
10809 it
.last_visible_x
= INFINITY
;
10810 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10811 current_buffer
= saved_current_buffer
;
10813 /* Position cursor in window. */
10814 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10815 hscroll
= max (0, (it
.current_x
10816 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10817 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10818 : (text_area_width
/ 2))))
10819 / FRAME_COLUMN_WIDTH (it
.f
);
10820 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10822 if (hscroll_relative_p
)
10823 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10826 wanted_x
= text_area_width
10827 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10830 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10834 if (hscroll_relative_p
)
10835 wanted_x
= text_area_width
* hscroll_step_rel
10838 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10841 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10843 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10845 /* Don't call Fset_window_hscroll if value hasn't
10846 changed because it will prevent redisplay
10848 if (XFASTINT (w
->hscroll
) != hscroll
)
10850 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10851 w
->hscroll
= make_number (hscroll
);
10860 /* Value is non-zero if hscroll of any leaf window has been changed. */
10861 return hscrolled_p
;
10865 /* Set hscroll so that cursor is visible and not inside horizontal
10866 scroll margins for all windows in the tree rooted at WINDOW. See
10867 also hscroll_window_tree above. Value is non-zero if any window's
10868 hscroll has been changed. If it has, desired matrices on the frame
10869 of WINDOW are cleared. */
10872 hscroll_windows (window
)
10873 Lisp_Object window
;
10875 int hscrolled_p
= hscroll_window_tree (window
);
10877 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10878 return hscrolled_p
;
10883 /************************************************************************
10885 ************************************************************************/
10887 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10888 to a non-zero value. This is sometimes handy to have in a debugger
10893 /* First and last unchanged row for try_window_id. */
10895 int debug_first_unchanged_at_end_vpos
;
10896 int debug_last_unchanged_at_beg_vpos
;
10898 /* Delta vpos and y. */
10900 int debug_dvpos
, debug_dy
;
10902 /* Delta in characters and bytes for try_window_id. */
10904 int debug_delta
, debug_delta_bytes
;
10906 /* Values of window_end_pos and window_end_vpos at the end of
10909 EMACS_INT debug_end_pos
, debug_end_vpos
;
10911 /* Append a string to W->desired_matrix->method. FMT is a printf
10912 format string. A1...A9 are a supplement for a variable-length
10913 argument list. If trace_redisplay_p is non-zero also printf the
10914 resulting string to stderr. */
10917 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10920 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10923 char *method
= w
->desired_matrix
->method
;
10924 int len
= strlen (method
);
10925 int size
= sizeof w
->desired_matrix
->method
;
10926 int remaining
= size
- len
- 1;
10928 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10929 if (len
&& remaining
)
10932 --remaining
, ++len
;
10935 strncpy (method
+ len
, buffer
, remaining
);
10937 if (trace_redisplay_p
)
10938 fprintf (stderr
, "%p (%s): %s\n",
10940 ((BUFFERP (w
->buffer
)
10941 && STRINGP (XBUFFER (w
->buffer
)->name
))
10942 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10947 #endif /* GLYPH_DEBUG */
10950 /* Value is non-zero if all changes in window W, which displays
10951 current_buffer, are in the text between START and END. START is a
10952 buffer position, END is given as a distance from Z. Used in
10953 redisplay_internal for display optimization. */
10956 text_outside_line_unchanged_p (w
, start
, end
)
10960 int unchanged_p
= 1;
10962 /* If text or overlays have changed, see where. */
10963 if (XFASTINT (w
->last_modified
) < MODIFF
10964 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10966 /* Gap in the line? */
10967 if (GPT
< start
|| Z
- GPT
< end
)
10970 /* Changes start in front of the line, or end after it? */
10972 && (BEG_UNCHANGED
< start
- 1
10973 || END_UNCHANGED
< end
))
10976 /* If selective display, can't optimize if changes start at the
10977 beginning of the line. */
10979 && INTEGERP (current_buffer
->selective_display
)
10980 && XINT (current_buffer
->selective_display
) > 0
10981 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10984 /* If there are overlays at the start or end of the line, these
10985 may have overlay strings with newlines in them. A change at
10986 START, for instance, may actually concern the display of such
10987 overlay strings as well, and they are displayed on different
10988 lines. So, quickly rule out this case. (For the future, it
10989 might be desirable to implement something more telling than
10990 just BEG/END_UNCHANGED.) */
10993 if (BEG
+ BEG_UNCHANGED
== start
10994 && overlay_touches_p (start
))
10996 if (END_UNCHANGED
== end
10997 && overlay_touches_p (Z
- end
))
11002 return unchanged_p
;
11006 /* Do a frame update, taking possible shortcuts into account. This is
11007 the main external entry point for redisplay.
11009 If the last redisplay displayed an echo area message and that message
11010 is no longer requested, we clear the echo area or bring back the
11011 mini-buffer if that is in use. */
11016 redisplay_internal (0);
11021 overlay_arrow_string_or_property (var
)
11026 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11029 return Voverlay_arrow_string
;
11032 /* Return 1 if there are any overlay-arrows in current_buffer. */
11034 overlay_arrow_in_current_buffer_p ()
11038 for (vlist
= Voverlay_arrow_variable_list
;
11040 vlist
= XCDR (vlist
))
11042 Lisp_Object var
= XCAR (vlist
);
11045 if (!SYMBOLP (var
))
11047 val
= find_symbol_value (var
);
11049 && current_buffer
== XMARKER (val
)->buffer
)
11056 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11060 overlay_arrows_changed_p ()
11064 for (vlist
= Voverlay_arrow_variable_list
;
11066 vlist
= XCDR (vlist
))
11068 Lisp_Object var
= XCAR (vlist
);
11069 Lisp_Object val
, pstr
;
11071 if (!SYMBOLP (var
))
11073 val
= find_symbol_value (var
);
11074 if (!MARKERP (val
))
11076 if (! EQ (COERCE_MARKER (val
),
11077 Fget (var
, Qlast_arrow_position
))
11078 || ! (pstr
= overlay_arrow_string_or_property (var
),
11079 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11085 /* Mark overlay arrows to be updated on next redisplay. */
11088 update_overlay_arrows (up_to_date
)
11093 for (vlist
= Voverlay_arrow_variable_list
;
11095 vlist
= XCDR (vlist
))
11097 Lisp_Object var
= XCAR (vlist
);
11099 if (!SYMBOLP (var
))
11102 if (up_to_date
> 0)
11104 Lisp_Object val
= find_symbol_value (var
);
11105 Fput (var
, Qlast_arrow_position
,
11106 COERCE_MARKER (val
));
11107 Fput (var
, Qlast_arrow_string
,
11108 overlay_arrow_string_or_property (var
));
11110 else if (up_to_date
< 0
11111 || !NILP (Fget (var
, Qlast_arrow_position
)))
11113 Fput (var
, Qlast_arrow_position
, Qt
);
11114 Fput (var
, Qlast_arrow_string
, Qt
);
11120 /* Return overlay arrow string to display at row.
11121 Return integer (bitmap number) for arrow bitmap in left fringe.
11122 Return nil if no overlay arrow. */
11125 overlay_arrow_at_row (it
, row
)
11127 struct glyph_row
*row
;
11131 for (vlist
= Voverlay_arrow_variable_list
;
11133 vlist
= XCDR (vlist
))
11135 Lisp_Object var
= XCAR (vlist
);
11138 if (!SYMBOLP (var
))
11141 val
= find_symbol_value (var
);
11144 && current_buffer
== XMARKER (val
)->buffer
11145 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11147 if (FRAME_WINDOW_P (it
->f
)
11148 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11150 #ifdef HAVE_WINDOW_SYSTEM
11151 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11154 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11155 return make_number (fringe_bitmap
);
11158 return make_number (-1); /* Use default arrow bitmap */
11160 return overlay_arrow_string_or_property (var
);
11167 /* Return 1 if point moved out of or into a composition. Otherwise
11168 return 0. PREV_BUF and PREV_PT are the last point buffer and
11169 position. BUF and PT are the current point buffer and position. */
11172 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11173 struct buffer
*prev_buf
, *buf
;
11176 EMACS_INT start
, end
;
11178 Lisp_Object buffer
;
11180 XSETBUFFER (buffer
, buf
);
11181 /* Check a composition at the last point if point moved within the
11183 if (prev_buf
== buf
)
11186 /* Point didn't move. */
11189 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11190 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11191 && COMPOSITION_VALID_P (start
, end
, prop
)
11192 && start
< prev_pt
&& end
> prev_pt
)
11193 /* The last point was within the composition. Return 1 iff
11194 point moved out of the composition. */
11195 return (pt
<= start
|| pt
>= end
);
11198 /* Check a composition at the current point. */
11199 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11200 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11201 && COMPOSITION_VALID_P (start
, end
, prop
)
11202 && start
< pt
&& end
> pt
);
11206 /* Reconsider the setting of B->clip_changed which is displayed
11210 reconsider_clip_changes (w
, b
)
11214 if (b
->clip_changed
11215 && !NILP (w
->window_end_valid
)
11216 && w
->current_matrix
->buffer
== b
11217 && w
->current_matrix
->zv
== BUF_ZV (b
)
11218 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11219 b
->clip_changed
= 0;
11221 /* If display wasn't paused, and W is not a tool bar window, see if
11222 point has been moved into or out of a composition. In that case,
11223 we set b->clip_changed to 1 to force updating the screen. If
11224 b->clip_changed has already been set to 1, we can skip this
11226 if (!b
->clip_changed
11227 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11231 if (w
== XWINDOW (selected_window
))
11232 pt
= BUF_PT (current_buffer
);
11234 pt
= marker_position (w
->pointm
);
11236 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11237 || pt
!= XINT (w
->last_point
))
11238 && check_point_in_composition (w
->current_matrix
->buffer
,
11239 XINT (w
->last_point
),
11240 XBUFFER (w
->buffer
), pt
))
11241 b
->clip_changed
= 1;
11246 /* Select FRAME to forward the values of frame-local variables into C
11247 variables so that the redisplay routines can access those values
11251 select_frame_for_redisplay (frame
)
11254 Lisp_Object tail
, symbol
, val
;
11255 Lisp_Object old
= selected_frame
;
11256 struct Lisp_Symbol
*sym
;
11258 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11260 selected_frame
= frame
;
11264 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11265 if (CONSP (XCAR (tail
))
11266 && (symbol
= XCAR (XCAR (tail
)),
11268 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11270 (BUFFER_LOCAL_VALUEP (val
)))
11271 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11272 /* Use find_symbol_value rather than Fsymbol_value
11273 to avoid an error if it is void. */
11274 find_symbol_value (symbol
);
11275 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11279 #define STOP_POLLING \
11280 do { if (! polling_stopped_here) stop_polling (); \
11281 polling_stopped_here = 1; } while (0)
11283 #define RESUME_POLLING \
11284 do { if (polling_stopped_here) start_polling (); \
11285 polling_stopped_here = 0; } while (0)
11288 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11289 response to any user action; therefore, we should preserve the echo
11290 area. (Actually, our caller does that job.) Perhaps in the future
11291 avoid recentering windows if it is not necessary; currently that
11292 causes some problems. */
11295 redisplay_internal (preserve_echo_area
)
11296 int preserve_echo_area
;
11298 struct window
*w
= XWINDOW (selected_window
);
11301 int must_finish
= 0;
11302 struct text_pos tlbufpos
, tlendpos
;
11303 int number_of_visible_frames
;
11306 int polling_stopped_here
= 0;
11307 Lisp_Object old_frame
= selected_frame
;
11309 /* Non-zero means redisplay has to consider all windows on all
11310 frames. Zero means, only selected_window is considered. */
11311 int consider_all_windows_p
;
11313 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11315 /* No redisplay if running in batch mode or frame is not yet fully
11316 initialized, or redisplay is explicitly turned off by setting
11317 Vinhibit_redisplay. */
11319 || !NILP (Vinhibit_redisplay
))
11322 /* Don't examine these until after testing Vinhibit_redisplay.
11323 When Emacs is shutting down, perhaps because its connection to
11324 X has dropped, we should not look at them at all. */
11325 f
= XFRAME (w
->frame
);
11326 sf
= SELECTED_FRAME ();
11328 if (!f
->glyphs_initialized_p
)
11331 /* The flag redisplay_performed_directly_p is set by
11332 direct_output_for_insert when it already did the whole screen
11333 update necessary. */
11334 if (redisplay_performed_directly_p
)
11336 redisplay_performed_directly_p
= 0;
11337 if (!hscroll_windows (selected_window
))
11341 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11342 if (popup_activated ())
11346 /* I don't think this happens but let's be paranoid. */
11347 if (redisplaying_p
)
11350 /* Record a function that resets redisplaying_p to its old value
11351 when we leave this function. */
11352 count
= SPECPDL_INDEX ();
11353 record_unwind_protect (unwind_redisplay
,
11354 Fcons (make_number (redisplaying_p
), selected_frame
));
11356 specbind (Qinhibit_free_realized_faces
, Qnil
);
11359 Lisp_Object tail
, frame
;
11361 FOR_EACH_FRAME (tail
, frame
)
11363 struct frame
*f
= XFRAME (frame
);
11364 f
->already_hscrolled_p
= 0;
11369 if (!EQ (old_frame
, selected_frame
)
11370 && FRAME_LIVE_P (XFRAME (old_frame
)))
11371 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11372 selected_frame and selected_window to be temporarily out-of-sync so
11373 when we come back here via `goto retry', we need to resync because we
11374 may need to run Elisp code (via prepare_menu_bars). */
11375 select_frame_for_redisplay (old_frame
);
11378 reconsider_clip_changes (w
, current_buffer
);
11379 last_escape_glyph_frame
= NULL
;
11380 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11382 /* If new fonts have been loaded that make a glyph matrix adjustment
11383 necessary, do it. */
11384 if (fonts_changed_p
)
11386 adjust_glyphs (NULL
);
11387 ++windows_or_buffers_changed
;
11388 fonts_changed_p
= 0;
11391 /* If face_change_count is non-zero, init_iterator will free all
11392 realized faces, which includes the faces referenced from current
11393 matrices. So, we can't reuse current matrices in this case. */
11394 if (face_change_count
)
11395 ++windows_or_buffers_changed
;
11397 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11398 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11400 /* Since frames on a single ASCII terminal share the same
11401 display area, displaying a different frame means redisplay
11402 the whole thing. */
11403 windows_or_buffers_changed
++;
11404 SET_FRAME_GARBAGED (sf
);
11406 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11408 FRAME_TTY (sf
)->previous_frame
= sf
;
11411 /* Set the visible flags for all frames. Do this before checking
11412 for resized or garbaged frames; they want to know if their frames
11413 are visible. See the comment in frame.h for
11414 FRAME_SAMPLE_VISIBILITY. */
11416 Lisp_Object tail
, frame
;
11418 number_of_visible_frames
= 0;
11420 FOR_EACH_FRAME (tail
, frame
)
11422 struct frame
*f
= XFRAME (frame
);
11424 FRAME_SAMPLE_VISIBILITY (f
);
11425 if (FRAME_VISIBLE_P (f
))
11426 ++number_of_visible_frames
;
11427 clear_desired_matrices (f
);
11432 /* Notice any pending interrupt request to change frame size. */
11433 do_pending_window_change (1);
11435 /* Clear frames marked as garbaged. */
11436 if (frame_garbaged
)
11437 clear_garbaged_frames ();
11439 /* Build menubar and tool-bar items. */
11440 if (NILP (Vmemory_full
))
11441 prepare_menu_bars ();
11443 if (windows_or_buffers_changed
)
11444 update_mode_lines
++;
11446 /* Detect case that we need to write or remove a star in the mode line. */
11447 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11449 w
->update_mode_line
= Qt
;
11450 if (buffer_shared
> 1)
11451 update_mode_lines
++;
11454 /* Avoid invocation of point motion hooks by `current_column' below. */
11455 count1
= SPECPDL_INDEX ();
11456 specbind (Qinhibit_point_motion_hooks
, Qt
);
11458 /* If %c is in the mode line, update it if needed. */
11459 if (!NILP (w
->column_number_displayed
)
11460 /* This alternative quickly identifies a common case
11461 where no change is needed. */
11462 && !(PT
== XFASTINT (w
->last_point
)
11463 && XFASTINT (w
->last_modified
) >= MODIFF
11464 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11465 && (XFASTINT (w
->column_number_displayed
)
11466 != (int) current_column ())) /* iftc */
11467 w
->update_mode_line
= Qt
;
11469 unbind_to (count1
, Qnil
);
11471 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11473 /* The variable buffer_shared is set in redisplay_window and
11474 indicates that we redisplay a buffer in different windows. See
11476 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11477 || cursor_type_changed
);
11479 /* If specs for an arrow have changed, do thorough redisplay
11480 to ensure we remove any arrow that should no longer exist. */
11481 if (overlay_arrows_changed_p ())
11482 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11484 /* Normally the message* functions will have already displayed and
11485 updated the echo area, but the frame may have been trashed, or
11486 the update may have been preempted, so display the echo area
11487 again here. Checking message_cleared_p captures the case that
11488 the echo area should be cleared. */
11489 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11490 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11491 || (message_cleared_p
11492 && minibuf_level
== 0
11493 /* If the mini-window is currently selected, this means the
11494 echo-area doesn't show through. */
11495 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11497 int window_height_changed_p
= echo_area_display (0);
11500 /* If we don't display the current message, don't clear the
11501 message_cleared_p flag, because, if we did, we wouldn't clear
11502 the echo area in the next redisplay which doesn't preserve
11504 if (!display_last_displayed_message_p
)
11505 message_cleared_p
= 0;
11507 if (fonts_changed_p
)
11509 else if (window_height_changed_p
)
11511 consider_all_windows_p
= 1;
11512 ++update_mode_lines
;
11513 ++windows_or_buffers_changed
;
11515 /* If window configuration was changed, frames may have been
11516 marked garbaged. Clear them or we will experience
11517 surprises wrt scrolling. */
11518 if (frame_garbaged
)
11519 clear_garbaged_frames ();
11522 else if (EQ (selected_window
, minibuf_window
)
11523 && (current_buffer
->clip_changed
11524 || XFASTINT (w
->last_modified
) < MODIFF
11525 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11526 && resize_mini_window (w
, 0))
11528 /* Resized active mini-window to fit the size of what it is
11529 showing if its contents might have changed. */
11531 /* FIXME: this causes all frames to be updated, which seems unnecessary
11532 since only the current frame needs to be considered. This function needs
11533 to be rewritten with two variables, consider_all_windows and
11534 consider_all_frames. */
11535 consider_all_windows_p
= 1;
11536 ++windows_or_buffers_changed
;
11537 ++update_mode_lines
;
11539 /* If window configuration was changed, frames may have been
11540 marked garbaged. Clear them or we will experience
11541 surprises wrt scrolling. */
11542 if (frame_garbaged
)
11543 clear_garbaged_frames ();
11547 /* If showing the region, and mark has changed, we must redisplay
11548 the whole window. The assignment to this_line_start_pos prevents
11549 the optimization directly below this if-statement. */
11550 if (((!NILP (Vtransient_mark_mode
)
11551 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11552 != !NILP (w
->region_showing
))
11553 || (!NILP (w
->region_showing
)
11554 && !EQ (w
->region_showing
,
11555 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11556 CHARPOS (this_line_start_pos
) = 0;
11558 /* Optimize the case that only the line containing the cursor in the
11559 selected window has changed. Variables starting with this_ are
11560 set in display_line and record information about the line
11561 containing the cursor. */
11562 tlbufpos
= this_line_start_pos
;
11563 tlendpos
= this_line_end_pos
;
11564 if (!consider_all_windows_p
11565 && CHARPOS (tlbufpos
) > 0
11566 && NILP (w
->update_mode_line
)
11567 && !current_buffer
->clip_changed
11568 && !current_buffer
->prevent_redisplay_optimizations_p
11569 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11570 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11571 /* Make sure recorded data applies to current buffer, etc. */
11572 && this_line_buffer
== current_buffer
11573 && current_buffer
== XBUFFER (w
->buffer
)
11574 && NILP (w
->force_start
)
11575 && NILP (w
->optional_new_start
)
11576 /* Point must be on the line that we have info recorded about. */
11577 && PT
>= CHARPOS (tlbufpos
)
11578 && PT
<= Z
- CHARPOS (tlendpos
)
11579 /* All text outside that line, including its final newline,
11580 must be unchanged */
11581 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11582 CHARPOS (tlendpos
)))
11584 if (CHARPOS (tlbufpos
) > BEGV
11585 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11586 && (CHARPOS (tlbufpos
) == ZV
11587 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11588 /* Former continuation line has disappeared by becoming empty */
11590 else if (XFASTINT (w
->last_modified
) < MODIFF
11591 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11592 || MINI_WINDOW_P (w
))
11594 /* We have to handle the case of continuation around a
11595 wide-column character (See the comment in indent.c around
11598 For instance, in the following case:
11600 -------- Insert --------
11601 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11602 J_I_ ==> J_I_ `^^' are cursors.
11606 As we have to redraw the line above, we should goto cancel. */
11609 int line_height_before
= this_line_pixel_height
;
11611 /* Note that start_display will handle the case that the
11612 line starting at tlbufpos is a continuation lines. */
11613 start_display (&it
, w
, tlbufpos
);
11615 /* Implementation note: It this still necessary? */
11616 if (it
.current_x
!= this_line_start_x
)
11619 TRACE ((stderr
, "trying display optimization 1\n"));
11620 w
->cursor
.vpos
= -1;
11621 overlay_arrow_seen
= 0;
11622 it
.vpos
= this_line_vpos
;
11623 it
.current_y
= this_line_y
;
11624 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11625 display_line (&it
);
11627 /* If line contains point, is not continued,
11628 and ends at same distance from eob as before, we win */
11629 if (w
->cursor
.vpos
>= 0
11630 /* Line is not continued, otherwise this_line_start_pos
11631 would have been set to 0 in display_line. */
11632 && CHARPOS (this_line_start_pos
)
11633 /* Line ends as before. */
11634 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11635 /* Line has same height as before. Otherwise other lines
11636 would have to be shifted up or down. */
11637 && this_line_pixel_height
== line_height_before
)
11639 /* If this is not the window's last line, we must adjust
11640 the charstarts of the lines below. */
11641 if (it
.current_y
< it
.last_visible_y
)
11643 struct glyph_row
*row
11644 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11645 int delta
, delta_bytes
;
11647 if (Z
- CHARPOS (tlendpos
) == ZV
)
11649 /* This line ends at end of (accessible part of)
11650 buffer. There is no newline to count. */
11652 - CHARPOS (tlendpos
)
11653 - MATRIX_ROW_START_CHARPOS (row
));
11654 delta_bytes
= (Z_BYTE
11655 - BYTEPOS (tlendpos
)
11656 - MATRIX_ROW_START_BYTEPOS (row
));
11660 /* This line ends in a newline. Must take
11661 account of the newline and the rest of the
11662 text that follows. */
11664 - CHARPOS (tlendpos
)
11665 - MATRIX_ROW_START_CHARPOS (row
));
11666 delta_bytes
= (Z_BYTE
11667 - BYTEPOS (tlendpos
)
11668 - MATRIX_ROW_START_BYTEPOS (row
));
11671 increment_matrix_positions (w
->current_matrix
,
11672 this_line_vpos
+ 1,
11673 w
->current_matrix
->nrows
,
11674 delta
, delta_bytes
);
11677 /* If this row displays text now but previously didn't,
11678 or vice versa, w->window_end_vpos may have to be
11680 if ((it
.glyph_row
- 1)->displays_text_p
)
11682 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11683 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11685 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11686 && this_line_vpos
> 0)
11687 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11688 w
->window_end_valid
= Qnil
;
11690 /* Update hint: No need to try to scroll in update_window. */
11691 w
->desired_matrix
->no_scrolling_p
= 1;
11694 *w
->desired_matrix
->method
= 0;
11695 debug_method_add (w
, "optimization 1");
11697 #ifdef HAVE_WINDOW_SYSTEM
11698 update_window_fringes (w
, 0);
11705 else if (/* Cursor position hasn't changed. */
11706 PT
== XFASTINT (w
->last_point
)
11707 /* Make sure the cursor was last displayed
11708 in this window. Otherwise we have to reposition it. */
11709 && 0 <= w
->cursor
.vpos
11710 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11714 do_pending_window_change (1);
11716 /* We used to always goto end_of_redisplay here, but this
11717 isn't enough if we have a blinking cursor. */
11718 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11719 goto end_of_redisplay
;
11723 /* If highlighting the region, or if the cursor is in the echo area,
11724 then we can't just move the cursor. */
11725 else if (! (!NILP (Vtransient_mark_mode
)
11726 && !NILP (current_buffer
->mark_active
))
11727 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11728 || highlight_nonselected_windows
)
11729 && NILP (w
->region_showing
)
11730 && NILP (Vshow_trailing_whitespace
)
11731 && !cursor_in_echo_area
)
11734 struct glyph_row
*row
;
11736 /* Skip from tlbufpos to PT and see where it is. Note that
11737 PT may be in invisible text. If so, we will end at the
11738 next visible position. */
11739 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11740 NULL
, DEFAULT_FACE_ID
);
11741 it
.current_x
= this_line_start_x
;
11742 it
.current_y
= this_line_y
;
11743 it
.vpos
= this_line_vpos
;
11745 /* The call to move_it_to stops in front of PT, but
11746 moves over before-strings. */
11747 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11749 if (it
.vpos
== this_line_vpos
11750 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11753 xassert (this_line_vpos
== it
.vpos
);
11754 xassert (this_line_y
== it
.current_y
);
11755 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11757 *w
->desired_matrix
->method
= 0;
11758 debug_method_add (w
, "optimization 3");
11767 /* Text changed drastically or point moved off of line. */
11768 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11771 CHARPOS (this_line_start_pos
) = 0;
11772 consider_all_windows_p
|= buffer_shared
> 1;
11773 ++clear_face_cache_count
;
11774 #ifdef HAVE_WINDOW_SYSTEM
11775 ++clear_image_cache_count
;
11778 /* Build desired matrices, and update the display. If
11779 consider_all_windows_p is non-zero, do it for all windows on all
11780 frames. Otherwise do it for selected_window, only. */
11782 if (consider_all_windows_p
)
11784 Lisp_Object tail
, frame
;
11786 FOR_EACH_FRAME (tail
, frame
)
11787 XFRAME (frame
)->updated_p
= 0;
11789 /* Recompute # windows showing selected buffer. This will be
11790 incremented each time such a window is displayed. */
11793 FOR_EACH_FRAME (tail
, frame
)
11795 struct frame
*f
= XFRAME (frame
);
11797 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11799 if (! EQ (frame
, selected_frame
))
11800 /* Select the frame, for the sake of frame-local
11802 select_frame_for_redisplay (frame
);
11804 /* Mark all the scroll bars to be removed; we'll redeem
11805 the ones we want when we redisplay their windows. */
11806 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11807 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11809 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11810 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11812 /* Any scroll bars which redisplay_windows should have
11813 nuked should now go away. */
11814 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11815 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11817 /* If fonts changed, display again. */
11818 /* ??? rms: I suspect it is a mistake to jump all the way
11819 back to retry here. It should just retry this frame. */
11820 if (fonts_changed_p
)
11823 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11825 /* See if we have to hscroll. */
11826 if (!f
->already_hscrolled_p
)
11828 f
->already_hscrolled_p
= 1;
11829 if (hscroll_windows (f
->root_window
))
11833 /* Prevent various kinds of signals during display
11834 update. stdio is not robust about handling
11835 signals, which can cause an apparent I/O
11837 if (interrupt_input
)
11838 unrequest_sigio ();
11841 /* Update the display. */
11842 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11843 pause
|= update_frame (f
, 0, 0);
11849 if (!EQ (old_frame
, selected_frame
)
11850 && FRAME_LIVE_P (XFRAME (old_frame
)))
11851 /* We played a bit fast-and-loose above and allowed selected_frame
11852 and selected_window to be temporarily out-of-sync but let's make
11853 sure this stays contained. */
11854 select_frame_for_redisplay (old_frame
);
11855 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11859 /* Do the mark_window_display_accurate after all windows have
11860 been redisplayed because this call resets flags in buffers
11861 which are needed for proper redisplay. */
11862 FOR_EACH_FRAME (tail
, frame
)
11864 struct frame
*f
= XFRAME (frame
);
11867 mark_window_display_accurate (f
->root_window
, 1);
11868 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11869 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11874 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11876 Lisp_Object mini_window
;
11877 struct frame
*mini_frame
;
11879 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11880 /* Use list_of_error, not Qerror, so that
11881 we catch only errors and don't run the debugger. */
11882 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11884 redisplay_window_error
);
11886 /* Compare desired and current matrices, perform output. */
11889 /* If fonts changed, display again. */
11890 if (fonts_changed_p
)
11893 /* Prevent various kinds of signals during display update.
11894 stdio is not robust about handling signals,
11895 which can cause an apparent I/O error. */
11896 if (interrupt_input
)
11897 unrequest_sigio ();
11900 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11902 if (hscroll_windows (selected_window
))
11905 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11906 pause
= update_frame (sf
, 0, 0);
11909 /* We may have called echo_area_display at the top of this
11910 function. If the echo area is on another frame, that may
11911 have put text on a frame other than the selected one, so the
11912 above call to update_frame would not have caught it. Catch
11914 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11915 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11917 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11919 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11920 pause
|= update_frame (mini_frame
, 0, 0);
11921 if (!pause
&& hscroll_windows (mini_window
))
11926 /* If display was paused because of pending input, make sure we do a
11927 thorough update the next time. */
11930 /* Prevent the optimization at the beginning of
11931 redisplay_internal that tries a single-line update of the
11932 line containing the cursor in the selected window. */
11933 CHARPOS (this_line_start_pos
) = 0;
11935 /* Let the overlay arrow be updated the next time. */
11936 update_overlay_arrows (0);
11938 /* If we pause after scrolling, some rows in the current
11939 matrices of some windows are not valid. */
11940 if (!WINDOW_FULL_WIDTH_P (w
)
11941 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11942 update_mode_lines
= 1;
11946 if (!consider_all_windows_p
)
11948 /* This has already been done above if
11949 consider_all_windows_p is set. */
11950 mark_window_display_accurate_1 (w
, 1);
11952 /* Say overlay arrows are up to date. */
11953 update_overlay_arrows (1);
11955 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11956 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11959 update_mode_lines
= 0;
11960 windows_or_buffers_changed
= 0;
11961 cursor_type_changed
= 0;
11964 /* Start SIGIO interrupts coming again. Having them off during the
11965 code above makes it less likely one will discard output, but not
11966 impossible, since there might be stuff in the system buffer here.
11967 But it is much hairier to try to do anything about that. */
11968 if (interrupt_input
)
11972 /* If a frame has become visible which was not before, redisplay
11973 again, so that we display it. Expose events for such a frame
11974 (which it gets when becoming visible) don't call the parts of
11975 redisplay constructing glyphs, so simply exposing a frame won't
11976 display anything in this case. So, we have to display these
11977 frames here explicitly. */
11980 Lisp_Object tail
, frame
;
11983 FOR_EACH_FRAME (tail
, frame
)
11985 int this_is_visible
= 0;
11987 if (XFRAME (frame
)->visible
)
11988 this_is_visible
= 1;
11989 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11990 if (XFRAME (frame
)->visible
)
11991 this_is_visible
= 1;
11993 if (this_is_visible
)
11997 if (new_count
!= number_of_visible_frames
)
11998 windows_or_buffers_changed
++;
12001 /* Change frame size now if a change is pending. */
12002 do_pending_window_change (1);
12004 /* If we just did a pending size change, or have additional
12005 visible frames, redisplay again. */
12006 if (windows_or_buffers_changed
&& !pause
)
12009 /* Clear the face cache eventually. */
12010 if (consider_all_windows_p
)
12012 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12014 clear_face_cache (0);
12015 clear_face_cache_count
= 0;
12017 #ifdef HAVE_WINDOW_SYSTEM
12018 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12020 clear_image_caches (Qnil
);
12021 clear_image_cache_count
= 0;
12023 #endif /* HAVE_WINDOW_SYSTEM */
12027 unbind_to (count
, Qnil
);
12032 /* Redisplay, but leave alone any recent echo area message unless
12033 another message has been requested in its place.
12035 This is useful in situations where you need to redisplay but no
12036 user action has occurred, making it inappropriate for the message
12037 area to be cleared. See tracking_off and
12038 wait_reading_process_output for examples of these situations.
12040 FROM_WHERE is an integer saying from where this function was
12041 called. This is useful for debugging. */
12044 redisplay_preserve_echo_area (from_where
)
12047 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12049 if (!NILP (echo_area_buffer
[1]))
12051 /* We have a previously displayed message, but no current
12052 message. Redisplay the previous message. */
12053 display_last_displayed_message_p
= 1;
12054 redisplay_internal (1);
12055 display_last_displayed_message_p
= 0;
12058 redisplay_internal (1);
12060 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12061 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12062 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12066 /* Function registered with record_unwind_protect in
12067 redisplay_internal. Reset redisplaying_p to the value it had
12068 before redisplay_internal was called, and clear
12069 prevent_freeing_realized_faces_p. It also selects the previously
12070 selected frame, unless it has been deleted (by an X connection
12071 failure during redisplay, for example). */
12074 unwind_redisplay (val
)
12077 Lisp_Object old_redisplaying_p
, old_frame
;
12079 old_redisplaying_p
= XCAR (val
);
12080 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12081 old_frame
= XCDR (val
);
12082 if (! EQ (old_frame
, selected_frame
)
12083 && FRAME_LIVE_P (XFRAME (old_frame
)))
12084 select_frame_for_redisplay (old_frame
);
12089 /* Mark the display of window W as accurate or inaccurate. If
12090 ACCURATE_P is non-zero mark display of W as accurate. If
12091 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12092 redisplay_internal is called. */
12095 mark_window_display_accurate_1 (w
, accurate_p
)
12099 if (BUFFERP (w
->buffer
))
12101 struct buffer
*b
= XBUFFER (w
->buffer
);
12104 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12105 w
->last_overlay_modified
12106 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12108 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12112 b
->clip_changed
= 0;
12113 b
->prevent_redisplay_optimizations_p
= 0;
12115 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12116 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12117 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12118 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12120 w
->current_matrix
->buffer
= b
;
12121 w
->current_matrix
->begv
= BUF_BEGV (b
);
12122 w
->current_matrix
->zv
= BUF_ZV (b
);
12124 w
->last_cursor
= w
->cursor
;
12125 w
->last_cursor_off_p
= w
->cursor_off_p
;
12127 if (w
== XWINDOW (selected_window
))
12128 w
->last_point
= make_number (BUF_PT (b
));
12130 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12136 w
->window_end_valid
= w
->buffer
;
12137 w
->update_mode_line
= Qnil
;
12142 /* Mark the display of windows in the window tree rooted at WINDOW as
12143 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12144 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12145 be redisplayed the next time redisplay_internal is called. */
12148 mark_window_display_accurate (window
, accurate_p
)
12149 Lisp_Object window
;
12154 for (; !NILP (window
); window
= w
->next
)
12156 w
= XWINDOW (window
);
12157 mark_window_display_accurate_1 (w
, accurate_p
);
12159 if (!NILP (w
->vchild
))
12160 mark_window_display_accurate (w
->vchild
, accurate_p
);
12161 if (!NILP (w
->hchild
))
12162 mark_window_display_accurate (w
->hchild
, accurate_p
);
12167 update_overlay_arrows (1);
12171 /* Force a thorough redisplay the next time by setting
12172 last_arrow_position and last_arrow_string to t, which is
12173 unequal to any useful value of Voverlay_arrow_... */
12174 update_overlay_arrows (-1);
12179 /* Return value in display table DP (Lisp_Char_Table *) for character
12180 C. Since a display table doesn't have any parent, we don't have to
12181 follow parent. Do not call this function directly but use the
12182 macro DISP_CHAR_VECTOR. */
12185 disp_char_vector (dp
, c
)
12186 struct Lisp_Char_Table
*dp
;
12191 if (ASCII_CHAR_P (c
))
12194 if (SUB_CHAR_TABLE_P (val
))
12195 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12201 XSETCHAR_TABLE (table
, dp
);
12202 val
= char_table_ref (table
, c
);
12211 /***********************************************************************
12213 ***********************************************************************/
12215 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12218 redisplay_windows (window
)
12219 Lisp_Object window
;
12221 while (!NILP (window
))
12223 struct window
*w
= XWINDOW (window
);
12225 if (!NILP (w
->hchild
))
12226 redisplay_windows (w
->hchild
);
12227 else if (!NILP (w
->vchild
))
12228 redisplay_windows (w
->vchild
);
12231 displayed_buffer
= XBUFFER (w
->buffer
);
12232 /* Use list_of_error, not Qerror, so that
12233 we catch only errors and don't run the debugger. */
12234 internal_condition_case_1 (redisplay_window_0
, window
,
12236 redisplay_window_error
);
12244 redisplay_window_error ()
12246 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12251 redisplay_window_0 (window
)
12252 Lisp_Object window
;
12254 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12255 redisplay_window (window
, 0);
12260 redisplay_window_1 (window
)
12261 Lisp_Object window
;
12263 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12264 redisplay_window (window
, 1);
12269 /* Increment GLYPH until it reaches END or CONDITION fails while
12270 adding (GLYPH)->pixel_width to X. */
12272 #define SKIP_GLYPHS(glyph, end, x, condition) \
12275 (x) += (glyph)->pixel_width; \
12278 while ((glyph) < (end) && (condition))
12281 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12282 DELTA is the number of bytes by which positions recorded in ROW
12283 differ from current buffer positions.
12285 Return 0 if cursor is not on this row. 1 otherwise. */
12288 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12290 struct glyph_row
*row
;
12291 struct glyph_matrix
*matrix
;
12292 int delta
, delta_bytes
, dy
, dvpos
;
12294 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12295 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12296 struct glyph
*cursor
= NULL
;
12297 /* The first glyph that starts a sequence of glyphs from string. */
12298 struct glyph
*string_start
;
12299 /* The X coordinate of string_start. */
12300 int string_start_x
;
12301 /* The last known character position. */
12302 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12303 /* The last known character position before string_start. */
12304 int string_before_pos
;
12307 int cursor_from_overlay_pos
= 0;
12308 int pt_old
= PT
- delta
;
12310 /* Skip over glyphs not having an object at the start of the row.
12311 These are special glyphs like truncation marks on terminal
12313 if (row
->displays_text_p
)
12315 && INTEGERP (glyph
->object
)
12316 && glyph
->charpos
< 0)
12318 x
+= glyph
->pixel_width
;
12322 string_start
= NULL
;
12324 && !INTEGERP (glyph
->object
)
12325 && (!BUFFERP (glyph
->object
)
12326 || (last_pos
= glyph
->charpos
) < pt_old
12327 || glyph
->avoid_cursor_p
))
12329 if (! STRINGP (glyph
->object
))
12331 string_start
= NULL
;
12332 x
+= glyph
->pixel_width
;
12334 if (cursor_from_overlay_pos
12335 && last_pos
>= cursor_from_overlay_pos
)
12337 cursor_from_overlay_pos
= 0;
12343 if (string_start
== NULL
)
12345 string_before_pos
= last_pos
;
12346 string_start
= glyph
;
12347 string_start_x
= x
;
12349 /* Skip all glyphs from string. */
12354 if ((cursor
== NULL
|| glyph
> cursor
)
12355 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12356 Qcursor
, (glyph
)->object
),
12358 && (pos
= string_buffer_position (w
, glyph
->object
,
12359 string_before_pos
),
12360 (pos
== 0 /* From overlay */
12361 || pos
== pt_old
)))
12363 /* Estimate overlay buffer position from the buffer
12364 positions of the glyphs before and after the overlay.
12365 Add 1 to last_pos so that if point corresponds to the
12366 glyph right after the overlay, we still use a 'cursor'
12367 property found in that overlay. */
12368 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12369 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12373 x
+= glyph
->pixel_width
;
12376 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12380 if (cursor
!= NULL
)
12385 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12387 /* Scan back over the ellipsis glyphs, decrementing positions. */
12388 while (glyph
> row
->glyphs
[TEXT_AREA
]
12389 && (glyph
- 1)->charpos
== last_pos
)
12390 glyph
--, x
-= glyph
->pixel_width
;
12391 /* That loop always goes one position too far,
12392 including the glyph before the ellipsis.
12393 So scan forward over that one. */
12394 x
+= glyph
->pixel_width
;
12397 else if (string_start
12398 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12400 /* We may have skipped over point because the previous glyphs
12401 are from string. As there's no easy way to know the
12402 character position of the current glyph, find the correct
12403 glyph on point by scanning from string_start again. */
12405 Lisp_Object string
;
12406 struct glyph
*stop
= glyph
;
12409 limit
= make_number (pt_old
+ 1);
12410 glyph
= string_start
;
12411 x
= string_start_x
;
12412 string
= glyph
->object
;
12413 pos
= string_buffer_position (w
, string
, string_before_pos
);
12414 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12415 because we always put cursor after overlay strings. */
12416 while (pos
== 0 && glyph
< stop
)
12418 string
= glyph
->object
;
12419 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12421 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12424 while (glyph
< stop
)
12426 pos
= XINT (Fnext_single_char_property_change
12427 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12430 /* Skip glyphs from the same string. */
12431 string
= glyph
->object
;
12432 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12433 /* Skip glyphs from an overlay. */
12434 while (glyph
< stop
12435 && ! string_buffer_position (w
, glyph
->object
, pos
))
12437 string
= glyph
->object
;
12438 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12442 /* If we reached the end of the line, and end was from a string,
12443 cursor is not on this line. */
12444 if (glyph
== end
&& row
->continued_p
)
12448 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12450 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12451 w
->cursor
.y
= row
->y
+ dy
;
12453 if (w
== XWINDOW (selected_window
))
12455 if (!row
->continued_p
12456 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12459 this_line_buffer
= XBUFFER (w
->buffer
);
12461 CHARPOS (this_line_start_pos
)
12462 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12463 BYTEPOS (this_line_start_pos
)
12464 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12466 CHARPOS (this_line_end_pos
)
12467 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12468 BYTEPOS (this_line_end_pos
)
12469 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12471 this_line_y
= w
->cursor
.y
;
12472 this_line_pixel_height
= row
->height
;
12473 this_line_vpos
= w
->cursor
.vpos
;
12474 this_line_start_x
= row
->x
;
12477 CHARPOS (this_line_start_pos
) = 0;
12484 /* Run window scroll functions, if any, for WINDOW with new window
12485 start STARTP. Sets the window start of WINDOW to that position.
12487 We assume that the window's buffer is really current. */
12489 static INLINE
struct text_pos
12490 run_window_scroll_functions (window
, startp
)
12491 Lisp_Object window
;
12492 struct text_pos startp
;
12494 struct window
*w
= XWINDOW (window
);
12495 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12497 if (current_buffer
!= XBUFFER (w
->buffer
))
12500 if (!NILP (Vwindow_scroll_functions
))
12502 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12503 make_number (CHARPOS (startp
)));
12504 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12505 /* In case the hook functions switch buffers. */
12506 if (current_buffer
!= XBUFFER (w
->buffer
))
12507 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12514 /* Make sure the line containing the cursor is fully visible.
12515 A value of 1 means there is nothing to be done.
12516 (Either the line is fully visible, or it cannot be made so,
12517 or we cannot tell.)
12519 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12520 is higher than window.
12522 A value of 0 means the caller should do scrolling
12523 as if point had gone off the screen. */
12526 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12529 int current_matrix_p
;
12531 struct glyph_matrix
*matrix
;
12532 struct glyph_row
*row
;
12535 if (!make_cursor_line_fully_visible_p
)
12538 /* It's not always possible to find the cursor, e.g, when a window
12539 is full of overlay strings. Don't do anything in that case. */
12540 if (w
->cursor
.vpos
< 0)
12543 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12544 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12546 /* If the cursor row is not partially visible, there's nothing to do. */
12547 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12550 /* If the row the cursor is in is taller than the window's height,
12551 it's not clear what to do, so do nothing. */
12552 window_height
= window_box_height (w
);
12553 if (row
->height
>= window_height
)
12555 if (!force_p
|| MINI_WINDOW_P (w
)
12556 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12562 /* This code used to try to scroll the window just enough to make
12563 the line visible. It returned 0 to say that the caller should
12564 allocate larger glyph matrices. */
12566 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12568 int dy
= row
->height
- row
->visible_height
;
12571 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12573 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12575 int dy
= - (row
->height
- row
->visible_height
);
12578 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12581 /* When we change the cursor y-position of the selected window,
12582 change this_line_y as well so that the display optimization for
12583 the cursor line of the selected window in redisplay_internal uses
12584 the correct y-position. */
12585 if (w
== XWINDOW (selected_window
))
12586 this_line_y
= w
->cursor
.y
;
12588 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12589 redisplay with larger matrices. */
12590 if (matrix
->nrows
< required_matrix_height (w
))
12592 fonts_changed_p
= 1;
12601 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12602 non-zero means only WINDOW is redisplayed in redisplay_internal.
12603 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12604 in redisplay_window to bring a partially visible line into view in
12605 the case that only the cursor has moved.
12607 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12608 last screen line's vertical height extends past the end of the screen.
12612 1 if scrolling succeeded
12614 0 if scrolling didn't find point.
12616 -1 if new fonts have been loaded so that we must interrupt
12617 redisplay, adjust glyph matrices, and try again. */
12623 SCROLLING_NEED_LARGER_MATRICES
12627 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12628 scroll_step
, temp_scroll_step
, last_line_misfit
)
12629 Lisp_Object window
;
12630 int just_this_one_p
;
12631 EMACS_INT scroll_conservatively
, scroll_step
;
12632 int temp_scroll_step
;
12633 int last_line_misfit
;
12635 struct window
*w
= XWINDOW (window
);
12636 struct frame
*f
= XFRAME (w
->frame
);
12637 struct text_pos pos
, startp
;
12639 int this_scroll_margin
, scroll_max
, rc
, height
;
12640 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12641 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12642 Lisp_Object aggressive
;
12643 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12646 debug_method_add (w
, "try_scrolling");
12649 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12651 /* Compute scroll margin height in pixels. We scroll when point is
12652 within this distance from the top or bottom of the window. */
12653 if (scroll_margin
> 0)
12655 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12656 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12659 this_scroll_margin
= 0;
12661 /* Force scroll_conservatively to have a reasonable value, to avoid
12662 overflow while computing how much to scroll. Note that it's
12663 fairly common for users to supply scroll-conservatively equal to
12664 `most-positive-fixnum', which can be larger than INT_MAX. */
12665 if (scroll_conservatively
> scroll_limit
)
12667 scroll_conservatively
= scroll_limit
;
12668 scroll_max
= INT_MAX
;
12670 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12671 /* Compute how much we should try to scroll maximally to bring
12672 point into view. */
12673 scroll_max
= (max (scroll_step
,
12674 max (scroll_conservatively
, temp_scroll_step
))
12675 * FRAME_LINE_HEIGHT (f
));
12676 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12677 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12678 /* We're trying to scroll because of aggressive scrolling but no
12679 scroll_step is set. Choose an arbitrary one. */
12680 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
12686 /* Decide whether we have to scroll down. */
12687 if (PT
> CHARPOS (startp
))
12689 int scroll_margin_y
;
12691 /* Compute the pixel ypos of the scroll margin, then move it to
12692 either that ypos or PT, whichever comes first. */
12693 start_display (&it
, w
, startp
);
12694 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
12695 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
12696 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
12697 (MOVE_TO_POS
| MOVE_TO_Y
));
12699 if (PT
> CHARPOS (it
.current
.pos
))
12701 /* Point is in the scroll margin at the bottom of the
12702 window, or below. Compute the distance from the scroll
12703 margin to PT, and give up if the distance is greater than
12705 move_it_to (&it
, PT
, -1, it
.last_visible_y
- 1, -1,
12706 MOVE_TO_POS
| MOVE_TO_Y
);
12708 /* To make point visible, we must move the window start down
12709 so that the cursor line is visible, which means we have
12710 to add in the height of the cursor line. */
12711 dy
= line_bottom_y (&it
) - scroll_margin_y
;
12713 if (dy
> scroll_max
)
12714 return SCROLLING_FAILED
;
12722 /* Move the window start down. If scrolling conservatively,
12723 move it just enough down to make point visible. If
12724 scroll_step is set, move it down by scroll_step. */
12725 start_display (&it
, w
, startp
);
12727 if (scroll_conservatively
)
12728 /* Set AMOUNT_TO_SCROLL to at least one line,
12729 and at most scroll_conservatively lines. */
12731 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12732 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12733 else if (scroll_step
|| temp_scroll_step
)
12734 amount_to_scroll
= scroll_max
;
12737 aggressive
= current_buffer
->scroll_up_aggressively
;
12738 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12739 if (NUMBERP (aggressive
))
12741 double float_amount
= XFLOATINT (aggressive
) * height
;
12742 amount_to_scroll
= float_amount
;
12743 if (amount_to_scroll
== 0 && float_amount
> 0)
12744 amount_to_scroll
= 1;
12748 if (amount_to_scroll
<= 0)
12749 return SCROLLING_FAILED
;
12751 /* If moving by amount_to_scroll leaves STARTP unchanged,
12752 move it down one screen line. */
12754 move_it_vertically (&it
, amount_to_scroll
);
12755 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12756 move_it_by_lines (&it
, 1, 1);
12757 startp
= it
.current
.pos
;
12761 struct text_pos scroll_margin_pos
= startp
;
12763 /* See if point is inside the scroll margin at the top of the
12765 if (this_scroll_margin
)
12767 start_display (&it
, w
, startp
);
12768 move_it_vertically (&it
, this_scroll_margin
);
12769 scroll_margin_pos
= it
.current
.pos
;
12772 if (PT
< CHARPOS (scroll_margin_pos
))
12774 /* Point is in the scroll margin at the top of the window or
12775 above what is displayed in the window. */
12778 /* Compute the vertical distance from PT to the scroll
12779 margin position. Give up if distance is greater than
12781 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12782 start_display (&it
, w
, pos
);
12784 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12785 it
.last_visible_y
, -1,
12786 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12787 dy
= it
.current_y
- y0
;
12788 if (dy
> scroll_max
)
12789 return SCROLLING_FAILED
;
12791 /* Compute new window start. */
12792 start_display (&it
, w
, startp
);
12794 if (scroll_conservatively
)
12796 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12797 else if (scroll_step
|| temp_scroll_step
)
12798 amount_to_scroll
= scroll_max
;
12801 aggressive
= current_buffer
->scroll_down_aggressively
;
12802 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12803 if (NUMBERP (aggressive
))
12805 double float_amount
= XFLOATINT (aggressive
) * height
;
12806 amount_to_scroll
= float_amount
;
12807 if (amount_to_scroll
== 0 && float_amount
> 0)
12808 amount_to_scroll
= 1;
12812 if (amount_to_scroll
<= 0)
12813 return SCROLLING_FAILED
;
12815 move_it_vertically_backward (&it
, amount_to_scroll
);
12816 startp
= it
.current
.pos
;
12820 /* Run window scroll functions. */
12821 startp
= run_window_scroll_functions (window
, startp
);
12823 /* Display the window. Give up if new fonts are loaded, or if point
12825 if (!try_window (window
, startp
, 0))
12826 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12827 else if (w
->cursor
.vpos
< 0)
12829 clear_glyph_matrix (w
->desired_matrix
);
12830 rc
= SCROLLING_FAILED
;
12834 /* Maybe forget recorded base line for line number display. */
12835 if (!just_this_one_p
12836 || current_buffer
->clip_changed
12837 || BEG_UNCHANGED
< CHARPOS (startp
))
12838 w
->base_line_number
= Qnil
;
12840 /* If cursor ends up on a partially visible line,
12841 treat that as being off the bottom of the screen. */
12842 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12844 clear_glyph_matrix (w
->desired_matrix
);
12845 ++extra_scroll_margin_lines
;
12848 rc
= SCROLLING_SUCCESS
;
12855 /* Compute a suitable window start for window W if display of W starts
12856 on a continuation line. Value is non-zero if a new window start
12859 The new window start will be computed, based on W's width, starting
12860 from the start of the continued line. It is the start of the
12861 screen line with the minimum distance from the old start W->start. */
12864 compute_window_start_on_continuation_line (w
)
12867 struct text_pos pos
, start_pos
;
12868 int window_start_changed_p
= 0;
12870 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12872 /* If window start is on a continuation line... Window start may be
12873 < BEGV in case there's invisible text at the start of the
12874 buffer (M-x rmail, for example). */
12875 if (CHARPOS (start_pos
) > BEGV
12876 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12879 struct glyph_row
*row
;
12881 /* Handle the case that the window start is out of range. */
12882 if (CHARPOS (start_pos
) < BEGV
)
12883 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12884 else if (CHARPOS (start_pos
) > ZV
)
12885 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12887 /* Find the start of the continued line. This should be fast
12888 because scan_buffer is fast (newline cache). */
12889 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12890 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12891 row
, DEFAULT_FACE_ID
);
12892 reseat_at_previous_visible_line_start (&it
);
12894 /* If the line start is "too far" away from the window start,
12895 say it takes too much time to compute a new window start. */
12896 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12897 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12899 int min_distance
, distance
;
12901 /* Move forward by display lines to find the new window
12902 start. If window width was enlarged, the new start can
12903 be expected to be > the old start. If window width was
12904 decreased, the new window start will be < the old start.
12905 So, we're looking for the display line start with the
12906 minimum distance from the old window start. */
12907 pos
= it
.current
.pos
;
12908 min_distance
= INFINITY
;
12909 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12910 distance
< min_distance
)
12912 min_distance
= distance
;
12913 pos
= it
.current
.pos
;
12914 move_it_by_lines (&it
, 1, 0);
12917 /* Set the window start there. */
12918 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12919 window_start_changed_p
= 1;
12923 return window_start_changed_p
;
12927 /* Try cursor movement in case text has not changed in window WINDOW,
12928 with window start STARTP. Value is
12930 CURSOR_MOVEMENT_SUCCESS if successful
12932 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12934 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12935 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12936 we want to scroll as if scroll-step were set to 1. See the code.
12938 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12939 which case we have to abort this redisplay, and adjust matrices
12944 CURSOR_MOVEMENT_SUCCESS
,
12945 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12946 CURSOR_MOVEMENT_MUST_SCROLL
,
12947 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12951 try_cursor_movement (window
, startp
, scroll_step
)
12952 Lisp_Object window
;
12953 struct text_pos startp
;
12956 struct window
*w
= XWINDOW (window
);
12957 struct frame
*f
= XFRAME (w
->frame
);
12958 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12961 if (inhibit_try_cursor_movement
)
12965 /* Handle case where text has not changed, only point, and it has
12966 not moved off the frame. */
12967 if (/* Point may be in this window. */
12968 PT
>= CHARPOS (startp
)
12969 /* Selective display hasn't changed. */
12970 && !current_buffer
->clip_changed
12971 /* Function force-mode-line-update is used to force a thorough
12972 redisplay. It sets either windows_or_buffers_changed or
12973 update_mode_lines. So don't take a shortcut here for these
12975 && !update_mode_lines
12976 && !windows_or_buffers_changed
12977 && !cursor_type_changed
12978 /* Can't use this case if highlighting a region. When a
12979 region exists, cursor movement has to do more than just
12981 && !(!NILP (Vtransient_mark_mode
)
12982 && !NILP (current_buffer
->mark_active
))
12983 && NILP (w
->region_showing
)
12984 && NILP (Vshow_trailing_whitespace
)
12985 /* Right after splitting windows, last_point may be nil. */
12986 && INTEGERP (w
->last_point
)
12987 /* This code is not used for mini-buffer for the sake of the case
12988 of redisplaying to replace an echo area message; since in
12989 that case the mini-buffer contents per se are usually
12990 unchanged. This code is of no real use in the mini-buffer
12991 since the handling of this_line_start_pos, etc., in redisplay
12992 handles the same cases. */
12993 && !EQ (window
, minibuf_window
)
12994 /* When splitting windows or for new windows, it happens that
12995 redisplay is called with a nil window_end_vpos or one being
12996 larger than the window. This should really be fixed in
12997 window.c. I don't have this on my list, now, so we do
12998 approximately the same as the old redisplay code. --gerd. */
12999 && INTEGERP (w
->window_end_vpos
)
13000 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13001 && (FRAME_WINDOW_P (f
)
13002 || !overlay_arrow_in_current_buffer_p ()))
13004 int this_scroll_margin
, top_scroll_margin
;
13005 struct glyph_row
*row
= NULL
;
13008 debug_method_add (w
, "cursor movement");
13011 /* Scroll if point within this distance from the top or bottom
13012 of the window. This is a pixel value. */
13013 if (scroll_margin
> 0)
13015 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13016 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13019 this_scroll_margin
= 0;
13021 top_scroll_margin
= this_scroll_margin
;
13022 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13023 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13025 /* Start with the row the cursor was displayed during the last
13026 not paused redisplay. Give up if that row is not valid. */
13027 if (w
->last_cursor
.vpos
< 0
13028 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13029 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13032 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13033 if (row
->mode_line_p
)
13035 if (!row
->enabled_p
)
13036 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13039 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13042 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13044 if (PT
> XFASTINT (w
->last_point
))
13046 /* Point has moved forward. */
13047 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13048 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13050 xassert (row
->enabled_p
);
13054 /* The end position of a row equals the start position
13055 of the next row. If PT is there, we would rather
13056 display it in the next line. */
13057 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13058 && MATRIX_ROW_END_CHARPOS (row
) == PT
13059 && !cursor_row_p (w
, row
))
13062 /* If within the scroll margin, scroll. Note that
13063 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13064 the next line would be drawn, and that
13065 this_scroll_margin can be zero. */
13066 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13067 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13068 /* Line is completely visible last line in window
13069 and PT is to be set in the next line. */
13070 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13071 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13072 && !row
->ends_at_zv_p
13073 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13076 else if (PT
< XFASTINT (w
->last_point
))
13078 /* Cursor has to be moved backward. Note that PT >=
13079 CHARPOS (startp) because of the outer if-statement. */
13080 while (!row
->mode_line_p
13081 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13082 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13083 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13084 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13085 row
> w
->current_matrix
->rows
13086 && (row
-1)->ends_in_newline_from_string_p
))))
13087 && (row
->y
> top_scroll_margin
13088 || CHARPOS (startp
) == BEGV
))
13090 xassert (row
->enabled_p
);
13094 /* Consider the following case: Window starts at BEGV,
13095 there is invisible, intangible text at BEGV, so that
13096 display starts at some point START > BEGV. It can
13097 happen that we are called with PT somewhere between
13098 BEGV and START. Try to handle that case. */
13099 if (row
< w
->current_matrix
->rows
13100 || row
->mode_line_p
)
13102 row
= w
->current_matrix
->rows
;
13103 if (row
->mode_line_p
)
13107 /* Due to newlines in overlay strings, we may have to
13108 skip forward over overlay strings. */
13109 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13110 && MATRIX_ROW_END_CHARPOS (row
) == PT
13111 && !cursor_row_p (w
, row
))
13114 /* If within the scroll margin, scroll. */
13115 if (row
->y
< top_scroll_margin
13116 && CHARPOS (startp
) != BEGV
)
13121 /* Cursor did not move. So don't scroll even if cursor line
13122 is partially visible, as it was so before. */
13123 rc
= CURSOR_MOVEMENT_SUCCESS
;
13126 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13127 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13129 /* if PT is not in the glyph row, give up. */
13130 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13132 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13133 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13134 && make_cursor_line_fully_visible_p
)
13136 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13137 && !row
->ends_at_zv_p
13138 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13139 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13140 else if (row
->height
> window_box_height (w
))
13142 /* If we end up in a partially visible line, let's
13143 make it fully visible, except when it's taller
13144 than the window, in which case we can't do much
13147 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13151 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13152 if (!cursor_row_fully_visible_p (w
, 0, 1))
13153 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13155 rc
= CURSOR_MOVEMENT_SUCCESS
;
13159 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13164 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13166 rc
= CURSOR_MOVEMENT_SUCCESS
;
13171 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13172 && MATRIX_ROW_START_CHARPOS (row
) == PT
13173 && cursor_row_p (w
, row
));
13182 set_vertical_scroll_bar (w
)
13185 int start
, end
, whole
;
13187 /* Calculate the start and end positions for the current window.
13188 At some point, it would be nice to choose between scrollbars
13189 which reflect the whole buffer size, with special markers
13190 indicating narrowing, and scrollbars which reflect only the
13193 Note that mini-buffers sometimes aren't displaying any text. */
13194 if (!MINI_WINDOW_P (w
)
13195 || (w
== XWINDOW (minibuf_window
)
13196 && NILP (echo_area_buffer
[0])))
13198 struct buffer
*buf
= XBUFFER (w
->buffer
);
13199 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13200 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13201 /* I don't think this is guaranteed to be right. For the
13202 moment, we'll pretend it is. */
13203 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13207 if (whole
< (end
- start
))
13208 whole
= end
- start
;
13211 start
= end
= whole
= 0;
13213 /* Indicate what this scroll bar ought to be displaying now. */
13214 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13215 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13216 (w
, end
- start
, whole
, start
);
13220 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13221 selected_window is redisplayed.
13223 We can return without actually redisplaying the window if
13224 fonts_changed_p is nonzero. In that case, redisplay_internal will
13228 redisplay_window (window
, just_this_one_p
)
13229 Lisp_Object window
;
13230 int just_this_one_p
;
13232 struct window
*w
= XWINDOW (window
);
13233 struct frame
*f
= XFRAME (w
->frame
);
13234 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13235 struct buffer
*old
= current_buffer
;
13236 struct text_pos lpoint
, opoint
, startp
;
13237 int update_mode_line
;
13240 /* Record it now because it's overwritten. */
13241 int current_matrix_up_to_date_p
= 0;
13242 int used_current_matrix_p
= 0;
13243 /* This is less strict than current_matrix_up_to_date_p.
13244 It indictes that the buffer contents and narrowing are unchanged. */
13245 int buffer_unchanged_p
= 0;
13246 int temp_scroll_step
= 0;
13247 int count
= SPECPDL_INDEX ();
13249 int centering_position
= -1;
13250 int last_line_misfit
= 0;
13251 int beg_unchanged
, end_unchanged
;
13253 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13256 /* W must be a leaf window here. */
13257 xassert (!NILP (w
->buffer
));
13259 *w
->desired_matrix
->method
= 0;
13263 reconsider_clip_changes (w
, buffer
);
13265 /* Has the mode line to be updated? */
13266 update_mode_line
= (!NILP (w
->update_mode_line
)
13267 || update_mode_lines
13268 || buffer
->clip_changed
13269 || buffer
->prevent_redisplay_optimizations_p
);
13271 if (MINI_WINDOW_P (w
))
13273 if (w
== XWINDOW (echo_area_window
)
13274 && !NILP (echo_area_buffer
[0]))
13276 if (update_mode_line
)
13277 /* We may have to update a tty frame's menu bar or a
13278 tool-bar. Example `M-x C-h C-h C-g'. */
13279 goto finish_menu_bars
;
13281 /* We've already displayed the echo area glyphs in this window. */
13282 goto finish_scroll_bars
;
13284 else if ((w
!= XWINDOW (minibuf_window
)
13285 || minibuf_level
== 0)
13286 /* When buffer is nonempty, redisplay window normally. */
13287 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13288 /* Quail displays non-mini buffers in minibuffer window.
13289 In that case, redisplay the window normally. */
13290 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13292 /* W is a mini-buffer window, but it's not active, so clear
13294 int yb
= window_text_bottom_y (w
);
13295 struct glyph_row
*row
;
13298 for (y
= 0, row
= w
->desired_matrix
->rows
;
13300 y
+= row
->height
, ++row
)
13301 blank_row (w
, row
, y
);
13302 goto finish_scroll_bars
;
13305 clear_glyph_matrix (w
->desired_matrix
);
13308 /* Otherwise set up data on this window; select its buffer and point
13310 /* Really select the buffer, for the sake of buffer-local
13312 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13314 current_matrix_up_to_date_p
13315 = (!NILP (w
->window_end_valid
)
13316 && !current_buffer
->clip_changed
13317 && !current_buffer
->prevent_redisplay_optimizations_p
13318 && XFASTINT (w
->last_modified
) >= MODIFF
13319 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13321 /* Run the window-bottom-change-functions
13322 if it is possible that the text on the screen has changed
13323 (either due to modification of the text, or any other reason). */
13324 if (!current_matrix_up_to_date_p
13325 && !NILP (Vwindow_text_change_functions
))
13327 safe_run_hooks (Qwindow_text_change_functions
);
13331 beg_unchanged
= BEG_UNCHANGED
;
13332 end_unchanged
= END_UNCHANGED
;
13334 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13336 specbind (Qinhibit_point_motion_hooks
, Qt
);
13339 = (!NILP (w
->window_end_valid
)
13340 && !current_buffer
->clip_changed
13341 && XFASTINT (w
->last_modified
) >= MODIFF
13342 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13344 /* When windows_or_buffers_changed is non-zero, we can't rely on
13345 the window end being valid, so set it to nil there. */
13346 if (windows_or_buffers_changed
)
13348 /* If window starts on a continuation line, maybe adjust the
13349 window start in case the window's width changed. */
13350 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13351 compute_window_start_on_continuation_line (w
);
13353 w
->window_end_valid
= Qnil
;
13356 /* Some sanity checks. */
13357 CHECK_WINDOW_END (w
);
13358 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13360 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13363 /* If %c is in mode line, update it if needed. */
13364 if (!NILP (w
->column_number_displayed
)
13365 /* This alternative quickly identifies a common case
13366 where no change is needed. */
13367 && !(PT
== XFASTINT (w
->last_point
)
13368 && XFASTINT (w
->last_modified
) >= MODIFF
13369 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13370 && (XFASTINT (w
->column_number_displayed
)
13371 != (int) current_column ())) /* iftc */
13372 update_mode_line
= 1;
13374 /* Count number of windows showing the selected buffer. An indirect
13375 buffer counts as its base buffer. */
13376 if (!just_this_one_p
)
13378 struct buffer
*current_base
, *window_base
;
13379 current_base
= current_buffer
;
13380 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13381 if (current_base
->base_buffer
)
13382 current_base
= current_base
->base_buffer
;
13383 if (window_base
->base_buffer
)
13384 window_base
= window_base
->base_buffer
;
13385 if (current_base
== window_base
)
13389 /* Point refers normally to the selected window. For any other
13390 window, set up appropriate value. */
13391 if (!EQ (window
, selected_window
))
13393 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13394 int new_pt_byte
= marker_byte_position (w
->pointm
);
13398 new_pt_byte
= BEGV_BYTE
;
13399 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13401 else if (new_pt
> (ZV
- 1))
13404 new_pt_byte
= ZV_BYTE
;
13405 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13408 /* We don't use SET_PT so that the point-motion hooks don't run. */
13409 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13412 /* If any of the character widths specified in the display table
13413 have changed, invalidate the width run cache. It's true that
13414 this may be a bit late to catch such changes, but the rest of
13415 redisplay goes (non-fatally) haywire when the display table is
13416 changed, so why should we worry about doing any better? */
13417 if (current_buffer
->width_run_cache
)
13419 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13421 if (! disptab_matches_widthtab (disptab
,
13422 XVECTOR (current_buffer
->width_table
)))
13424 invalidate_region_cache (current_buffer
,
13425 current_buffer
->width_run_cache
,
13427 recompute_width_table (current_buffer
, disptab
);
13431 /* If window-start is screwed up, choose a new one. */
13432 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13435 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13437 /* If someone specified a new starting point but did not insist,
13438 check whether it can be used. */
13439 if (!NILP (w
->optional_new_start
)
13440 && CHARPOS (startp
) >= BEGV
13441 && CHARPOS (startp
) <= ZV
)
13443 w
->optional_new_start
= Qnil
;
13444 start_display (&it
, w
, startp
);
13445 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13446 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13447 if (IT_CHARPOS (it
) == PT
)
13448 w
->force_start
= Qt
;
13449 /* IT may overshoot PT if text at PT is invisible. */
13450 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13451 w
->force_start
= Qt
;
13456 /* Handle case where place to start displaying has been specified,
13457 unless the specified location is outside the accessible range. */
13458 if (!NILP (w
->force_start
)
13459 || w
->frozen_window_start_p
)
13461 /* We set this later on if we have to adjust point. */
13464 w
->force_start
= Qnil
;
13466 w
->window_end_valid
= Qnil
;
13468 /* Forget any recorded base line for line number display. */
13469 if (!buffer_unchanged_p
)
13470 w
->base_line_number
= Qnil
;
13472 /* Redisplay the mode line. Select the buffer properly for that.
13473 Also, run the hook window-scroll-functions
13474 because we have scrolled. */
13475 /* Note, we do this after clearing force_start because
13476 if there's an error, it is better to forget about force_start
13477 than to get into an infinite loop calling the hook functions
13478 and having them get more errors. */
13479 if (!update_mode_line
13480 || ! NILP (Vwindow_scroll_functions
))
13482 update_mode_line
= 1;
13483 w
->update_mode_line
= Qt
;
13484 startp
= run_window_scroll_functions (window
, startp
);
13487 w
->last_modified
= make_number (0);
13488 w
->last_overlay_modified
= make_number (0);
13489 if (CHARPOS (startp
) < BEGV
)
13490 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13491 else if (CHARPOS (startp
) > ZV
)
13492 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13494 /* Redisplay, then check if cursor has been set during the
13495 redisplay. Give up if new fonts were loaded. */
13496 /* We used to issue a CHECK_MARGINS argument to try_window here,
13497 but this causes scrolling to fail when point begins inside
13498 the scroll margin (bug#148) -- cyd */
13499 if (!try_window (window
, startp
, 0))
13501 w
->force_start
= Qt
;
13502 clear_glyph_matrix (w
->desired_matrix
);
13503 goto need_larger_matrices
;
13506 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13508 /* If point does not appear, try to move point so it does
13509 appear. The desired matrix has been built above, so we
13510 can use it here. */
13511 new_vpos
= window_box_height (w
) / 2;
13514 if (!cursor_row_fully_visible_p (w
, 0, 0))
13516 /* Point does appear, but on a line partly visible at end of window.
13517 Move it back to a fully-visible line. */
13518 new_vpos
= window_box_height (w
);
13521 /* If we need to move point for either of the above reasons,
13522 now actually do it. */
13525 struct glyph_row
*row
;
13527 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13528 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13531 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13532 MATRIX_ROW_START_BYTEPOS (row
));
13534 if (w
!= XWINDOW (selected_window
))
13535 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13536 else if (current_buffer
== old
)
13537 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13539 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13541 /* If we are highlighting the region, then we just changed
13542 the region, so redisplay to show it. */
13543 if (!NILP (Vtransient_mark_mode
)
13544 && !NILP (current_buffer
->mark_active
))
13546 clear_glyph_matrix (w
->desired_matrix
);
13547 if (!try_window (window
, startp
, 0))
13548 goto need_larger_matrices
;
13553 debug_method_add (w
, "forced window start");
13558 /* Handle case where text has not changed, only point, and it has
13559 not moved off the frame, and we are not retrying after hscroll.
13560 (current_matrix_up_to_date_p is nonzero when retrying.) */
13561 if (current_matrix_up_to_date_p
13562 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13563 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13567 case CURSOR_MOVEMENT_SUCCESS
:
13568 used_current_matrix_p
= 1;
13571 #if 0 /* try_cursor_movement never returns this value. */
13572 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13573 goto need_larger_matrices
;
13576 case CURSOR_MOVEMENT_MUST_SCROLL
:
13577 goto try_to_scroll
;
13583 /* If current starting point was originally the beginning of a line
13584 but no longer is, find a new starting point. */
13585 else if (!NILP (w
->start_at_line_beg
)
13586 && !(CHARPOS (startp
) <= BEGV
13587 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13590 debug_method_add (w
, "recenter 1");
13595 /* Try scrolling with try_window_id. Value is > 0 if update has
13596 been done, it is -1 if we know that the same window start will
13597 not work. It is 0 if unsuccessful for some other reason. */
13598 else if ((tem
= try_window_id (w
)) != 0)
13601 debug_method_add (w
, "try_window_id %d", tem
);
13604 if (fonts_changed_p
)
13605 goto need_larger_matrices
;
13609 /* Otherwise try_window_id has returned -1 which means that we
13610 don't want the alternative below this comment to execute. */
13612 else if (CHARPOS (startp
) >= BEGV
13613 && CHARPOS (startp
) <= ZV
13614 && PT
>= CHARPOS (startp
)
13615 && (CHARPOS (startp
) < ZV
13616 /* Avoid starting at end of buffer. */
13617 || CHARPOS (startp
) == BEGV
13618 || (XFASTINT (w
->last_modified
) >= MODIFF
13619 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13622 /* If first window line is a continuation line, and window start
13623 is inside the modified region, but the first change is before
13624 current window start, we must select a new window start.
13626 However, if this is the result of a down-mouse event (e.g. by
13627 extending the mouse-drag-overlay), we don't want to select a
13628 new window start, since that would change the position under
13629 the mouse, resulting in an unwanted mouse-movement rather
13630 than a simple mouse-click. */
13631 if (NILP (w
->start_at_line_beg
)
13632 && NILP (do_mouse_tracking
)
13633 && CHARPOS (startp
) > BEGV
13634 && CHARPOS (startp
) > BEG
+ beg_unchanged
13635 && CHARPOS (startp
) <= Z
- end_unchanged
13636 /* Even if w->start_at_line_beg is nil, a new window may
13637 start at a line_beg, since that's how set_buffer_window
13638 sets it. So, we need to check the return value of
13639 compute_window_start_on_continuation_line. (See also
13641 && XMARKER (w
->start
)->buffer
== current_buffer
13642 && compute_window_start_on_continuation_line (w
))
13644 w
->force_start
= Qt
;
13645 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13650 debug_method_add (w
, "same window start");
13653 /* Try to redisplay starting at same place as before.
13654 If point has not moved off frame, accept the results. */
13655 if (!current_matrix_up_to_date_p
13656 /* Don't use try_window_reusing_current_matrix in this case
13657 because a window scroll function can have changed the
13659 || !NILP (Vwindow_scroll_functions
)
13660 || MINI_WINDOW_P (w
)
13661 || !(used_current_matrix_p
13662 = try_window_reusing_current_matrix (w
)))
13664 IF_DEBUG (debug_method_add (w
, "1"));
13665 if (try_window (window
, startp
, 1) < 0)
13666 /* -1 means we need to scroll.
13667 0 means we need new matrices, but fonts_changed_p
13668 is set in that case, so we will detect it below. */
13669 goto try_to_scroll
;
13672 if (fonts_changed_p
)
13673 goto need_larger_matrices
;
13675 if (w
->cursor
.vpos
>= 0)
13677 if (!just_this_one_p
13678 || current_buffer
->clip_changed
13679 || BEG_UNCHANGED
< CHARPOS (startp
))
13680 /* Forget any recorded base line for line number display. */
13681 w
->base_line_number
= Qnil
;
13683 if (!cursor_row_fully_visible_p (w
, 1, 0))
13685 clear_glyph_matrix (w
->desired_matrix
);
13686 last_line_misfit
= 1;
13688 /* Drop through and scroll. */
13693 clear_glyph_matrix (w
->desired_matrix
);
13698 w
->last_modified
= make_number (0);
13699 w
->last_overlay_modified
= make_number (0);
13701 /* Redisplay the mode line. Select the buffer properly for that. */
13702 if (!update_mode_line
)
13704 update_mode_line
= 1;
13705 w
->update_mode_line
= Qt
;
13708 /* Try to scroll by specified few lines. */
13709 if ((scroll_conservatively
13711 || temp_scroll_step
13712 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13713 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13714 && !current_buffer
->clip_changed
13715 && CHARPOS (startp
) >= BEGV
13716 && CHARPOS (startp
) <= ZV
)
13718 /* The function returns -1 if new fonts were loaded, 1 if
13719 successful, 0 if not successful. */
13720 int rc
= try_scrolling (window
, just_this_one_p
,
13721 scroll_conservatively
,
13723 temp_scroll_step
, last_line_misfit
);
13726 case SCROLLING_SUCCESS
:
13729 case SCROLLING_NEED_LARGER_MATRICES
:
13730 goto need_larger_matrices
;
13732 case SCROLLING_FAILED
:
13740 /* Finally, just choose place to start which centers point */
13743 if (centering_position
< 0)
13744 centering_position
= window_box_height (w
) / 2;
13747 debug_method_add (w
, "recenter");
13750 /* w->vscroll = 0; */
13752 /* Forget any previously recorded base line for line number display. */
13753 if (!buffer_unchanged_p
)
13754 w
->base_line_number
= Qnil
;
13756 /* Move backward half the height of the window. */
13757 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13758 it
.current_y
= it
.last_visible_y
;
13759 move_it_vertically_backward (&it
, centering_position
);
13760 xassert (IT_CHARPOS (it
) >= BEGV
);
13762 /* The function move_it_vertically_backward may move over more
13763 than the specified y-distance. If it->w is small, e.g. a
13764 mini-buffer window, we may end up in front of the window's
13765 display area. Start displaying at the start of the line
13766 containing PT in this case. */
13767 if (it
.current_y
<= 0)
13769 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13770 move_it_vertically_backward (&it
, 0);
13774 it
.current_x
= it
.hpos
= 0;
13776 /* Set startp here explicitly in case that helps avoid an infinite loop
13777 in case the window-scroll-functions functions get errors. */
13778 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13780 /* Run scroll hooks. */
13781 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13783 /* Redisplay the window. */
13784 if (!current_matrix_up_to_date_p
13785 || windows_or_buffers_changed
13786 || cursor_type_changed
13787 /* Don't use try_window_reusing_current_matrix in this case
13788 because it can have changed the buffer. */
13789 || !NILP (Vwindow_scroll_functions
)
13790 || !just_this_one_p
13791 || MINI_WINDOW_P (w
)
13792 || !(used_current_matrix_p
13793 = try_window_reusing_current_matrix (w
)))
13794 try_window (window
, startp
, 0);
13796 /* If new fonts have been loaded (due to fontsets), give up. We
13797 have to start a new redisplay since we need to re-adjust glyph
13799 if (fonts_changed_p
)
13800 goto need_larger_matrices
;
13802 /* If cursor did not appear assume that the middle of the window is
13803 in the first line of the window. Do it again with the next line.
13804 (Imagine a window of height 100, displaying two lines of height
13805 60. Moving back 50 from it->last_visible_y will end in the first
13807 if (w
->cursor
.vpos
< 0)
13809 if (!NILP (w
->window_end_valid
)
13810 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13812 clear_glyph_matrix (w
->desired_matrix
);
13813 move_it_by_lines (&it
, 1, 0);
13814 try_window (window
, it
.current
.pos
, 0);
13816 else if (PT
< IT_CHARPOS (it
))
13818 clear_glyph_matrix (w
->desired_matrix
);
13819 move_it_by_lines (&it
, -1, 0);
13820 try_window (window
, it
.current
.pos
, 0);
13824 /* Not much we can do about it. */
13828 /* Consider the following case: Window starts at BEGV, there is
13829 invisible, intangible text at BEGV, so that display starts at
13830 some point START > BEGV. It can happen that we are called with
13831 PT somewhere between BEGV and START. Try to handle that case. */
13832 if (w
->cursor
.vpos
< 0)
13834 struct glyph_row
*row
= w
->current_matrix
->rows
;
13835 if (row
->mode_line_p
)
13837 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13840 if (!cursor_row_fully_visible_p (w
, 0, 0))
13842 /* If vscroll is enabled, disable it and try again. */
13846 clear_glyph_matrix (w
->desired_matrix
);
13850 /* If centering point failed to make the whole line visible,
13851 put point at the top instead. That has to make the whole line
13852 visible, if it can be done. */
13853 if (centering_position
== 0)
13856 clear_glyph_matrix (w
->desired_matrix
);
13857 centering_position
= 0;
13863 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13864 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13865 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13868 /* Display the mode line, if we must. */
13869 if ((update_mode_line
13870 /* If window not full width, must redo its mode line
13871 if (a) the window to its side is being redone and
13872 (b) we do a frame-based redisplay. This is a consequence
13873 of how inverted lines are drawn in frame-based redisplay. */
13874 || (!just_this_one_p
13875 && !FRAME_WINDOW_P (f
)
13876 && !WINDOW_FULL_WIDTH_P (w
))
13877 /* Line number to display. */
13878 || INTEGERP (w
->base_line_pos
)
13879 /* Column number is displayed and different from the one displayed. */
13880 || (!NILP (w
->column_number_displayed
)
13881 && (XFASTINT (w
->column_number_displayed
)
13882 != (int) current_column ()))) /* iftc */
13883 /* This means that the window has a mode line. */
13884 && (WINDOW_WANTS_MODELINE_P (w
)
13885 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13887 display_mode_lines (w
);
13889 /* If mode line height has changed, arrange for a thorough
13890 immediate redisplay using the correct mode line height. */
13891 if (WINDOW_WANTS_MODELINE_P (w
)
13892 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13894 fonts_changed_p
= 1;
13895 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13896 = DESIRED_MODE_LINE_HEIGHT (w
);
13899 /* If top line height has changed, arrange for a thorough
13900 immediate redisplay using the correct mode line height. */
13901 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13902 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13904 fonts_changed_p
= 1;
13905 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13906 = DESIRED_HEADER_LINE_HEIGHT (w
);
13909 if (fonts_changed_p
)
13910 goto need_larger_matrices
;
13913 if (!line_number_displayed
13914 && !BUFFERP (w
->base_line_pos
))
13916 w
->base_line_pos
= Qnil
;
13917 w
->base_line_number
= Qnil
;
13922 /* When we reach a frame's selected window, redo the frame's menu bar. */
13923 if (update_mode_line
13924 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13926 int redisplay_menu_p
= 0;
13927 int redisplay_tool_bar_p
= 0;
13929 if (FRAME_WINDOW_P (f
))
13931 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13932 || defined (HAVE_NS) || defined (USE_GTK)
13933 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13935 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13939 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13941 if (redisplay_menu_p
)
13942 display_menu_bar (w
);
13944 #ifdef HAVE_WINDOW_SYSTEM
13945 if (FRAME_WINDOW_P (f
))
13947 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
13948 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13950 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13951 && (FRAME_TOOL_BAR_LINES (f
) > 0
13952 || !NILP (Vauto_resize_tool_bars
));
13955 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13957 extern int ignore_mouse_drag_p
;
13958 ignore_mouse_drag_p
= 1;
13964 #ifdef HAVE_WINDOW_SYSTEM
13965 if (FRAME_WINDOW_P (f
)
13966 && update_window_fringes (w
, (just_this_one_p
13967 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13968 || w
->pseudo_window_p
)))
13972 if (draw_window_fringes (w
, 1))
13973 x_draw_vertical_border (w
);
13977 #endif /* HAVE_WINDOW_SYSTEM */
13979 /* We go to this label, with fonts_changed_p nonzero,
13980 if it is necessary to try again using larger glyph matrices.
13981 We have to redeem the scroll bar even in this case,
13982 because the loop in redisplay_internal expects that. */
13983 need_larger_matrices
:
13985 finish_scroll_bars
:
13987 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13989 /* Set the thumb's position and size. */
13990 set_vertical_scroll_bar (w
);
13992 /* Note that we actually used the scroll bar attached to this
13993 window, so it shouldn't be deleted at the end of redisplay. */
13994 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13995 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13998 /* Restore current_buffer and value of point in it. */
13999 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14000 set_buffer_internal_1 (old
);
14001 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14002 shorter. This can be caused by log truncation in *Messages*. */
14003 if (CHARPOS (lpoint
) <= ZV
)
14004 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14006 unbind_to (count
, Qnil
);
14010 /* Build the complete desired matrix of WINDOW with a window start
14011 buffer position POS.
14013 Value is 1 if successful. It is zero if fonts were loaded during
14014 redisplay which makes re-adjusting glyph matrices necessary, and -1
14015 if point would appear in the scroll margins.
14016 (We check that only if CHECK_MARGINS is nonzero. */
14019 try_window (window
, pos
, check_margins
)
14020 Lisp_Object window
;
14021 struct text_pos pos
;
14024 struct window
*w
= XWINDOW (window
);
14026 struct glyph_row
*last_text_row
= NULL
;
14027 struct frame
*f
= XFRAME (w
->frame
);
14029 /* Make POS the new window start. */
14030 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14032 /* Mark cursor position as unknown. No overlay arrow seen. */
14033 w
->cursor
.vpos
= -1;
14034 overlay_arrow_seen
= 0;
14036 /* Initialize iterator and info to start at POS. */
14037 start_display (&it
, w
, pos
);
14039 /* Display all lines of W. */
14040 while (it
.current_y
< it
.last_visible_y
)
14042 if (display_line (&it
))
14043 last_text_row
= it
.glyph_row
- 1;
14044 if (fonts_changed_p
)
14048 /* Don't let the cursor end in the scroll margins. */
14050 && !MINI_WINDOW_P (w
))
14052 int this_scroll_margin
;
14054 if (scroll_margin
> 0)
14056 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14057 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14060 this_scroll_margin
= 0;
14062 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14063 && w
->cursor
.y
< this_scroll_margin
14064 && CHARPOS (pos
) > BEGV
14065 && IT_CHARPOS (it
) < ZV
)
14066 /* rms: considering make_cursor_line_fully_visible_p here
14067 seems to give wrong results. We don't want to recenter
14068 when the last line is partly visible, we want to allow
14069 that case to be handled in the usual way. */
14070 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14072 w
->cursor
.vpos
= -1;
14073 clear_glyph_matrix (w
->desired_matrix
);
14078 /* If bottom moved off end of frame, change mode line percentage. */
14079 if (XFASTINT (w
->window_end_pos
) <= 0
14080 && Z
!= IT_CHARPOS (it
))
14081 w
->update_mode_line
= Qt
;
14083 /* Set window_end_pos to the offset of the last character displayed
14084 on the window from the end of current_buffer. Set
14085 window_end_vpos to its row number. */
14088 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14089 w
->window_end_bytepos
14090 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14092 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14094 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14095 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14096 ->displays_text_p
);
14100 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14101 w
->window_end_pos
= make_number (Z
- ZV
);
14102 w
->window_end_vpos
= make_number (0);
14105 /* But that is not valid info until redisplay finishes. */
14106 w
->window_end_valid
= Qnil
;
14112 /************************************************************************
14113 Window redisplay reusing current matrix when buffer has not changed
14114 ************************************************************************/
14116 /* Try redisplay of window W showing an unchanged buffer with a
14117 different window start than the last time it was displayed by
14118 reusing its current matrix. Value is non-zero if successful.
14119 W->start is the new window start. */
14122 try_window_reusing_current_matrix (w
)
14125 struct frame
*f
= XFRAME (w
->frame
);
14126 struct glyph_row
*row
, *bottom_row
;
14129 struct text_pos start
, new_start
;
14130 int nrows_scrolled
, i
;
14131 struct glyph_row
*last_text_row
;
14132 struct glyph_row
*last_reused_text_row
;
14133 struct glyph_row
*start_row
;
14134 int start_vpos
, min_y
, max_y
;
14137 if (inhibit_try_window_reusing
)
14141 if (/* This function doesn't handle terminal frames. */
14142 !FRAME_WINDOW_P (f
)
14143 /* Don't try to reuse the display if windows have been split
14145 || windows_or_buffers_changed
14146 || cursor_type_changed
)
14149 /* Can't do this if region may have changed. */
14150 if ((!NILP (Vtransient_mark_mode
)
14151 && !NILP (current_buffer
->mark_active
))
14152 || !NILP (w
->region_showing
)
14153 || !NILP (Vshow_trailing_whitespace
))
14156 /* If top-line visibility has changed, give up. */
14157 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14158 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14161 /* Give up if old or new display is scrolled vertically. We could
14162 make this function handle this, but right now it doesn't. */
14163 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14164 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14167 /* The variable new_start now holds the new window start. The old
14168 start `start' can be determined from the current matrix. */
14169 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14170 start
= start_row
->start
.pos
;
14171 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14173 /* Clear the desired matrix for the display below. */
14174 clear_glyph_matrix (w
->desired_matrix
);
14176 if (CHARPOS (new_start
) <= CHARPOS (start
))
14180 /* Don't use this method if the display starts with an ellipsis
14181 displayed for invisible text. It's not easy to handle that case
14182 below, and it's certainly not worth the effort since this is
14183 not a frequent case. */
14184 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14187 IF_DEBUG (debug_method_add (w
, "twu1"));
14189 /* Display up to a row that can be reused. The variable
14190 last_text_row is set to the last row displayed that displays
14191 text. Note that it.vpos == 0 if or if not there is a
14192 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14193 start_display (&it
, w
, new_start
);
14194 first_row_y
= it
.current_y
;
14195 w
->cursor
.vpos
= -1;
14196 last_text_row
= last_reused_text_row
= NULL
;
14198 while (it
.current_y
< it
.last_visible_y
14199 && !fonts_changed_p
)
14201 /* If we have reached into the characters in the START row,
14202 that means the line boundaries have changed. So we
14203 can't start copying with the row START. Maybe it will
14204 work to start copying with the following row. */
14205 while (IT_CHARPOS (it
) > CHARPOS (start
))
14207 /* Advance to the next row as the "start". */
14209 start
= start_row
->start
.pos
;
14210 /* If there are no more rows to try, or just one, give up. */
14211 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14212 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14213 || CHARPOS (start
) == ZV
)
14215 clear_glyph_matrix (w
->desired_matrix
);
14219 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14221 /* If we have reached alignment,
14222 we can copy the rest of the rows. */
14223 if (IT_CHARPOS (it
) == CHARPOS (start
))
14226 if (display_line (&it
))
14227 last_text_row
= it
.glyph_row
- 1;
14230 /* A value of current_y < last_visible_y means that we stopped
14231 at the previous window start, which in turn means that we
14232 have at least one reusable row. */
14233 if (it
.current_y
< it
.last_visible_y
)
14235 /* IT.vpos always starts from 0; it counts text lines. */
14236 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14238 /* Find PT if not already found in the lines displayed. */
14239 if (w
->cursor
.vpos
< 0)
14241 int dy
= it
.current_y
- start_row
->y
;
14243 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14244 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14246 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14247 dy
, nrows_scrolled
);
14250 clear_glyph_matrix (w
->desired_matrix
);
14255 /* Scroll the display. Do it before the current matrix is
14256 changed. The problem here is that update has not yet
14257 run, i.e. part of the current matrix is not up to date.
14258 scroll_run_hook will clear the cursor, and use the
14259 current matrix to get the height of the row the cursor is
14261 run
.current_y
= start_row
->y
;
14262 run
.desired_y
= it
.current_y
;
14263 run
.height
= it
.last_visible_y
- it
.current_y
;
14265 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14268 FRAME_RIF (f
)->update_window_begin_hook (w
);
14269 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14270 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14271 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14275 /* Shift current matrix down by nrows_scrolled lines. */
14276 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14277 rotate_matrix (w
->current_matrix
,
14279 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14282 /* Disable lines that must be updated. */
14283 for (i
= 0; i
< nrows_scrolled
; ++i
)
14284 (start_row
+ i
)->enabled_p
= 0;
14286 /* Re-compute Y positions. */
14287 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14288 max_y
= it
.last_visible_y
;
14289 for (row
= start_row
+ nrows_scrolled
;
14293 row
->y
= it
.current_y
;
14294 row
->visible_height
= row
->height
;
14296 if (row
->y
< min_y
)
14297 row
->visible_height
-= min_y
- row
->y
;
14298 if (row
->y
+ row
->height
> max_y
)
14299 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14300 row
->redraw_fringe_bitmaps_p
= 1;
14302 it
.current_y
+= row
->height
;
14304 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14305 last_reused_text_row
= row
;
14306 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14310 /* Disable lines in the current matrix which are now
14311 below the window. */
14312 for (++row
; row
< bottom_row
; ++row
)
14313 row
->enabled_p
= row
->mode_line_p
= 0;
14316 /* Update window_end_pos etc.; last_reused_text_row is the last
14317 reused row from the current matrix containing text, if any.
14318 The value of last_text_row is the last displayed line
14319 containing text. */
14320 if (last_reused_text_row
)
14322 w
->window_end_bytepos
14323 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14325 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14327 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14328 w
->current_matrix
));
14330 else if (last_text_row
)
14332 w
->window_end_bytepos
14333 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14335 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14337 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14341 /* This window must be completely empty. */
14342 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14343 w
->window_end_pos
= make_number (Z
- ZV
);
14344 w
->window_end_vpos
= make_number (0);
14346 w
->window_end_valid
= Qnil
;
14348 /* Update hint: don't try scrolling again in update_window. */
14349 w
->desired_matrix
->no_scrolling_p
= 1;
14352 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14356 else if (CHARPOS (new_start
) > CHARPOS (start
))
14358 struct glyph_row
*pt_row
, *row
;
14359 struct glyph_row
*first_reusable_row
;
14360 struct glyph_row
*first_row_to_display
;
14362 int yb
= window_text_bottom_y (w
);
14364 /* Find the row starting at new_start, if there is one. Don't
14365 reuse a partially visible line at the end. */
14366 first_reusable_row
= start_row
;
14367 while (first_reusable_row
->enabled_p
14368 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14369 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14370 < CHARPOS (new_start
)))
14371 ++first_reusable_row
;
14373 /* Give up if there is no row to reuse. */
14374 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14375 || !first_reusable_row
->enabled_p
14376 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14377 != CHARPOS (new_start
)))
14380 /* We can reuse fully visible rows beginning with
14381 first_reusable_row to the end of the window. Set
14382 first_row_to_display to the first row that cannot be reused.
14383 Set pt_row to the row containing point, if there is any. */
14385 for (first_row_to_display
= first_reusable_row
;
14386 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14387 ++first_row_to_display
)
14389 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14390 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14391 pt_row
= first_row_to_display
;
14394 /* Start displaying at the start of first_row_to_display. */
14395 xassert (first_row_to_display
->y
< yb
);
14396 init_to_row_start (&it
, w
, first_row_to_display
);
14398 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14400 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14402 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14403 + WINDOW_HEADER_LINE_HEIGHT (w
));
14405 /* Display lines beginning with first_row_to_display in the
14406 desired matrix. Set last_text_row to the last row displayed
14407 that displays text. */
14408 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14409 if (pt_row
== NULL
)
14410 w
->cursor
.vpos
= -1;
14411 last_text_row
= NULL
;
14412 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14413 if (display_line (&it
))
14414 last_text_row
= it
.glyph_row
- 1;
14416 /* Give up If point isn't in a row displayed or reused. */
14417 if (w
->cursor
.vpos
< 0)
14419 clear_glyph_matrix (w
->desired_matrix
);
14423 /* If point is in a reused row, adjust y and vpos of the cursor
14427 w
->cursor
.vpos
-= nrows_scrolled
;
14428 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14431 /* Scroll the display. */
14432 run
.current_y
= first_reusable_row
->y
;
14433 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14434 run
.height
= it
.last_visible_y
- run
.current_y
;
14435 dy
= run
.current_y
- run
.desired_y
;
14440 FRAME_RIF (f
)->update_window_begin_hook (w
);
14441 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14442 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14443 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14447 /* Adjust Y positions of reused rows. */
14448 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14449 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14450 max_y
= it
.last_visible_y
;
14451 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14454 row
->visible_height
= row
->height
;
14455 if (row
->y
< min_y
)
14456 row
->visible_height
-= min_y
- row
->y
;
14457 if (row
->y
+ row
->height
> max_y
)
14458 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14459 row
->redraw_fringe_bitmaps_p
= 1;
14462 /* Scroll the current matrix. */
14463 xassert (nrows_scrolled
> 0);
14464 rotate_matrix (w
->current_matrix
,
14466 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14469 /* Disable rows not reused. */
14470 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14471 row
->enabled_p
= 0;
14473 /* Point may have moved to a different line, so we cannot assume that
14474 the previous cursor position is valid; locate the correct row. */
14477 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14478 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14482 w
->cursor
.y
= row
->y
;
14484 if (row
< bottom_row
)
14486 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14487 while (glyph
->charpos
< PT
)
14490 w
->cursor
.x
+= glyph
->pixel_width
;
14496 /* Adjust window end. A null value of last_text_row means that
14497 the window end is in reused rows which in turn means that
14498 only its vpos can have changed. */
14501 w
->window_end_bytepos
14502 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14504 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14506 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14511 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14514 w
->window_end_valid
= Qnil
;
14515 w
->desired_matrix
->no_scrolling_p
= 1;
14518 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14528 /************************************************************************
14529 Window redisplay reusing current matrix when buffer has changed
14530 ************************************************************************/
14532 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14533 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14535 static struct glyph_row
*
14536 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14537 struct glyph_row
*));
14540 /* Return the last row in MATRIX displaying text. If row START is
14541 non-null, start searching with that row. IT gives the dimensions
14542 of the display. Value is null if matrix is empty; otherwise it is
14543 a pointer to the row found. */
14545 static struct glyph_row
*
14546 find_last_row_displaying_text (matrix
, it
, start
)
14547 struct glyph_matrix
*matrix
;
14549 struct glyph_row
*start
;
14551 struct glyph_row
*row
, *row_found
;
14553 /* Set row_found to the last row in IT->w's current matrix
14554 displaying text. The loop looks funny but think of partially
14557 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14558 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14560 xassert (row
->enabled_p
);
14562 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14571 /* Return the last row in the current matrix of W that is not affected
14572 by changes at the start of current_buffer that occurred since W's
14573 current matrix was built. Value is null if no such row exists.
14575 BEG_UNCHANGED us the number of characters unchanged at the start of
14576 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14577 first changed character in current_buffer. Characters at positions <
14578 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14579 when the current matrix was built. */
14581 static struct glyph_row
*
14582 find_last_unchanged_at_beg_row (w
)
14585 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14586 struct glyph_row
*row
;
14587 struct glyph_row
*row_found
= NULL
;
14588 int yb
= window_text_bottom_y (w
);
14590 /* Find the last row displaying unchanged text. */
14591 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14592 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14593 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14596 if (/* If row ends before first_changed_pos, it is unchanged,
14597 except in some case. */
14598 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14599 /* When row ends in ZV and we write at ZV it is not
14601 && !row
->ends_at_zv_p
14602 /* When first_changed_pos is the end of a continued line,
14603 row is not unchanged because it may be no longer
14605 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14606 && (row
->continued_p
14607 || row
->exact_window_width_line_p
)))
14610 /* Stop if last visible row. */
14611 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14619 /* Find the first glyph row in the current matrix of W that is not
14620 affected by changes at the end of current_buffer since the
14621 time W's current matrix was built.
14623 Return in *DELTA the number of chars by which buffer positions in
14624 unchanged text at the end of current_buffer must be adjusted.
14626 Return in *DELTA_BYTES the corresponding number of bytes.
14628 Value is null if no such row exists, i.e. all rows are affected by
14631 static struct glyph_row
*
14632 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14634 int *delta
, *delta_bytes
;
14636 struct glyph_row
*row
;
14637 struct glyph_row
*row_found
= NULL
;
14639 *delta
= *delta_bytes
= 0;
14641 /* Display must not have been paused, otherwise the current matrix
14642 is not up to date. */
14643 eassert (!NILP (w
->window_end_valid
));
14645 /* A value of window_end_pos >= END_UNCHANGED means that the window
14646 end is in the range of changed text. If so, there is no
14647 unchanged row at the end of W's current matrix. */
14648 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14651 /* Set row to the last row in W's current matrix displaying text. */
14652 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14654 /* If matrix is entirely empty, no unchanged row exists. */
14655 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14657 /* The value of row is the last glyph row in the matrix having a
14658 meaningful buffer position in it. The end position of row
14659 corresponds to window_end_pos. This allows us to translate
14660 buffer positions in the current matrix to current buffer
14661 positions for characters not in changed text. */
14662 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14663 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14664 int last_unchanged_pos
, last_unchanged_pos_old
;
14665 struct glyph_row
*first_text_row
14666 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14668 *delta
= Z
- Z_old
;
14669 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14671 /* Set last_unchanged_pos to the buffer position of the last
14672 character in the buffer that has not been changed. Z is the
14673 index + 1 of the last character in current_buffer, i.e. by
14674 subtracting END_UNCHANGED we get the index of the last
14675 unchanged character, and we have to add BEG to get its buffer
14677 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14678 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14680 /* Search backward from ROW for a row displaying a line that
14681 starts at a minimum position >= last_unchanged_pos_old. */
14682 for (; row
> first_text_row
; --row
)
14684 /* This used to abort, but it can happen.
14685 It is ok to just stop the search instead here. KFS. */
14686 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14689 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14694 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14700 /* Make sure that glyph rows in the current matrix of window W
14701 reference the same glyph memory as corresponding rows in the
14702 frame's frame matrix. This function is called after scrolling W's
14703 current matrix on a terminal frame in try_window_id and
14704 try_window_reusing_current_matrix. */
14707 sync_frame_with_window_matrix_rows (w
)
14710 struct frame
*f
= XFRAME (w
->frame
);
14711 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14713 /* Preconditions: W must be a leaf window and full-width. Its frame
14714 must have a frame matrix. */
14715 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14716 xassert (WINDOW_FULL_WIDTH_P (w
));
14717 xassert (!FRAME_WINDOW_P (f
));
14719 /* If W is a full-width window, glyph pointers in W's current matrix
14720 have, by definition, to be the same as glyph pointers in the
14721 corresponding frame matrix. Note that frame matrices have no
14722 marginal areas (see build_frame_matrix). */
14723 window_row
= w
->current_matrix
->rows
;
14724 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14725 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14726 while (window_row
< window_row_end
)
14728 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14729 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14731 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14732 frame_row
->glyphs
[TEXT_AREA
] = start
;
14733 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14734 frame_row
->glyphs
[LAST_AREA
] = end
;
14736 /* Disable frame rows whose corresponding window rows have
14737 been disabled in try_window_id. */
14738 if (!window_row
->enabled_p
)
14739 frame_row
->enabled_p
= 0;
14741 ++window_row
, ++frame_row
;
14746 /* Find the glyph row in window W containing CHARPOS. Consider all
14747 rows between START and END (not inclusive). END null means search
14748 all rows to the end of the display area of W. Value is the row
14749 containing CHARPOS or null. */
14752 row_containing_pos (w
, charpos
, start
, end
, dy
)
14755 struct glyph_row
*start
, *end
;
14758 struct glyph_row
*row
= start
;
14761 /* If we happen to start on a header-line, skip that. */
14762 if (row
->mode_line_p
)
14765 if ((end
&& row
>= end
) || !row
->enabled_p
)
14768 last_y
= window_text_bottom_y (w
) - dy
;
14772 /* Give up if we have gone too far. */
14773 if (end
&& row
>= end
)
14775 /* This formerly returned if they were equal.
14776 I think that both quantities are of a "last plus one" type;
14777 if so, when they are equal, the row is within the screen. -- rms. */
14778 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14781 /* If it is in this row, return this row. */
14782 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14783 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14784 /* The end position of a row equals the start
14785 position of the next row. If CHARPOS is there, we
14786 would rather display it in the next line, except
14787 when this line ends in ZV. */
14788 && !row
->ends_at_zv_p
14789 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14790 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14797 /* Try to redisplay window W by reusing its existing display. W's
14798 current matrix must be up to date when this function is called,
14799 i.e. window_end_valid must not be nil.
14803 1 if display has been updated
14804 0 if otherwise unsuccessful
14805 -1 if redisplay with same window start is known not to succeed
14807 The following steps are performed:
14809 1. Find the last row in the current matrix of W that is not
14810 affected by changes at the start of current_buffer. If no such row
14813 2. Find the first row in W's current matrix that is not affected by
14814 changes at the end of current_buffer. Maybe there is no such row.
14816 3. Display lines beginning with the row + 1 found in step 1 to the
14817 row found in step 2 or, if step 2 didn't find a row, to the end of
14820 4. If cursor is not known to appear on the window, give up.
14822 5. If display stopped at the row found in step 2, scroll the
14823 display and current matrix as needed.
14825 6. Maybe display some lines at the end of W, if we must. This can
14826 happen under various circumstances, like a partially visible line
14827 becoming fully visible, or because newly displayed lines are displayed
14828 in smaller font sizes.
14830 7. Update W's window end information. */
14836 struct frame
*f
= XFRAME (w
->frame
);
14837 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14838 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14839 struct glyph_row
*last_unchanged_at_beg_row
;
14840 struct glyph_row
*first_unchanged_at_end_row
;
14841 struct glyph_row
*row
;
14842 struct glyph_row
*bottom_row
;
14845 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14846 struct text_pos start_pos
;
14848 int first_unchanged_at_end_vpos
= 0;
14849 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14850 struct text_pos start
;
14851 int first_changed_charpos
, last_changed_charpos
;
14854 if (inhibit_try_window_id
)
14858 /* This is handy for debugging. */
14860 #define GIVE_UP(X) \
14862 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14866 #define GIVE_UP(X) return 0
14869 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14871 /* Don't use this for mini-windows because these can show
14872 messages and mini-buffers, and we don't handle that here. */
14873 if (MINI_WINDOW_P (w
))
14876 /* This flag is used to prevent redisplay optimizations. */
14877 if (windows_or_buffers_changed
|| cursor_type_changed
)
14880 /* Verify that narrowing has not changed.
14881 Also verify that we were not told to prevent redisplay optimizations.
14882 It would be nice to further
14883 reduce the number of cases where this prevents try_window_id. */
14884 if (current_buffer
->clip_changed
14885 || current_buffer
->prevent_redisplay_optimizations_p
)
14888 /* Window must either use window-based redisplay or be full width. */
14889 if (!FRAME_WINDOW_P (f
)
14890 && (!FRAME_LINE_INS_DEL_OK (f
)
14891 || !WINDOW_FULL_WIDTH_P (w
)))
14894 /* Give up if point is not known NOT to appear in W. */
14895 if (PT
< CHARPOS (start
))
14898 /* Another way to prevent redisplay optimizations. */
14899 if (XFASTINT (w
->last_modified
) == 0)
14902 /* Verify that window is not hscrolled. */
14903 if (XFASTINT (w
->hscroll
) != 0)
14906 /* Verify that display wasn't paused. */
14907 if (NILP (w
->window_end_valid
))
14910 /* Can't use this if highlighting a region because a cursor movement
14911 will do more than just set the cursor. */
14912 if (!NILP (Vtransient_mark_mode
)
14913 && !NILP (current_buffer
->mark_active
))
14916 /* Likewise if highlighting trailing whitespace. */
14917 if (!NILP (Vshow_trailing_whitespace
))
14920 /* Likewise if showing a region. */
14921 if (!NILP (w
->region_showing
))
14924 /* Can use this if overlay arrow position and or string have changed. */
14925 if (overlay_arrows_changed_p ())
14928 /* When word-wrap is on, adding a space to the first word of a
14929 wrapped line can change the wrap position, altering the line
14930 above it. It might be worthwhile to handle this more
14931 intelligently, but for now just redisplay from scratch. */
14932 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14935 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14936 only if buffer has really changed. The reason is that the gap is
14937 initially at Z for freshly visited files. The code below would
14938 set end_unchanged to 0 in that case. */
14939 if (MODIFF
> SAVE_MODIFF
14940 /* This seems to happen sometimes after saving a buffer. */
14941 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14943 if (GPT
- BEG
< BEG_UNCHANGED
)
14944 BEG_UNCHANGED
= GPT
- BEG
;
14945 if (Z
- GPT
< END_UNCHANGED
)
14946 END_UNCHANGED
= Z
- GPT
;
14949 /* The position of the first and last character that has been changed. */
14950 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14951 last_changed_charpos
= Z
- END_UNCHANGED
;
14953 /* If window starts after a line end, and the last change is in
14954 front of that newline, then changes don't affect the display.
14955 This case happens with stealth-fontification. Note that although
14956 the display is unchanged, glyph positions in the matrix have to
14957 be adjusted, of course. */
14958 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14959 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14960 && ((last_changed_charpos
< CHARPOS (start
)
14961 && CHARPOS (start
) == BEGV
)
14962 || (last_changed_charpos
< CHARPOS (start
) - 1
14963 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14965 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14966 struct glyph_row
*r0
;
14968 /* Compute how many chars/bytes have been added to or removed
14969 from the buffer. */
14970 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14971 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14973 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14975 /* Give up if PT is not in the window. Note that it already has
14976 been checked at the start of try_window_id that PT is not in
14977 front of the window start. */
14978 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14981 /* If window start is unchanged, we can reuse the whole matrix
14982 as is, after adjusting glyph positions. No need to compute
14983 the window end again, since its offset from Z hasn't changed. */
14984 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14985 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14986 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14987 /* PT must not be in a partially visible line. */
14988 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14989 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14991 /* Adjust positions in the glyph matrix. */
14992 if (delta
|| delta_bytes
)
14994 struct glyph_row
*r1
14995 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14996 increment_matrix_positions (w
->current_matrix
,
14997 MATRIX_ROW_VPOS (r0
, current_matrix
),
14998 MATRIX_ROW_VPOS (r1
, current_matrix
),
14999 delta
, delta_bytes
);
15002 /* Set the cursor. */
15003 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15005 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15012 /* Handle the case that changes are all below what is displayed in
15013 the window, and that PT is in the window. This shortcut cannot
15014 be taken if ZV is visible in the window, and text has been added
15015 there that is visible in the window. */
15016 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15017 /* ZV is not visible in the window, or there are no
15018 changes at ZV, actually. */
15019 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15020 || first_changed_charpos
== last_changed_charpos
))
15022 struct glyph_row
*r0
;
15024 /* Give up if PT is not in the window. Note that it already has
15025 been checked at the start of try_window_id that PT is not in
15026 front of the window start. */
15027 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15030 /* If window start is unchanged, we can reuse the whole matrix
15031 as is, without changing glyph positions since no text has
15032 been added/removed in front of the window end. */
15033 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15034 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15035 /* PT must not be in a partially visible line. */
15036 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15037 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15039 /* We have to compute the window end anew since text
15040 can have been added/removed after it. */
15042 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15043 w
->window_end_bytepos
15044 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15046 /* Set the cursor. */
15047 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15049 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15056 /* Give up if window start is in the changed area.
15058 The condition used to read
15060 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15062 but why that was tested escapes me at the moment. */
15063 if (CHARPOS (start
) >= first_changed_charpos
15064 && CHARPOS (start
) <= last_changed_charpos
)
15067 /* Check that window start agrees with the start of the first glyph
15068 row in its current matrix. Check this after we know the window
15069 start is not in changed text, otherwise positions would not be
15071 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15072 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15075 /* Give up if the window ends in strings. Overlay strings
15076 at the end are difficult to handle, so don't try. */
15077 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15078 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15081 /* Compute the position at which we have to start displaying new
15082 lines. Some of the lines at the top of the window might be
15083 reusable because they are not displaying changed text. Find the
15084 last row in W's current matrix not affected by changes at the
15085 start of current_buffer. Value is null if changes start in the
15086 first line of window. */
15087 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15088 if (last_unchanged_at_beg_row
)
15090 /* Avoid starting to display in the moddle of a character, a TAB
15091 for instance. This is easier than to set up the iterator
15092 exactly, and it's not a frequent case, so the additional
15093 effort wouldn't really pay off. */
15094 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15095 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15096 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15097 --last_unchanged_at_beg_row
;
15099 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15102 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15104 start_pos
= it
.current
.pos
;
15106 /* Start displaying new lines in the desired matrix at the same
15107 vpos we would use in the current matrix, i.e. below
15108 last_unchanged_at_beg_row. */
15109 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15111 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15112 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15114 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15118 /* There are no reusable lines at the start of the window.
15119 Start displaying in the first text line. */
15120 start_display (&it
, w
, start
);
15121 it
.vpos
= it
.first_vpos
;
15122 start_pos
= it
.current
.pos
;
15125 /* Find the first row that is not affected by changes at the end of
15126 the buffer. Value will be null if there is no unchanged row, in
15127 which case we must redisplay to the end of the window. delta
15128 will be set to the value by which buffer positions beginning with
15129 first_unchanged_at_end_row have to be adjusted due to text
15131 first_unchanged_at_end_row
15132 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15133 IF_DEBUG (debug_delta
= delta
);
15134 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15136 /* Set stop_pos to the buffer position up to which we will have to
15137 display new lines. If first_unchanged_at_end_row != NULL, this
15138 is the buffer position of the start of the line displayed in that
15139 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15140 that we don't stop at a buffer position. */
15142 if (first_unchanged_at_end_row
)
15144 xassert (last_unchanged_at_beg_row
== NULL
15145 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15147 /* If this is a continuation line, move forward to the next one
15148 that isn't. Changes in lines above affect this line.
15149 Caution: this may move first_unchanged_at_end_row to a row
15150 not displaying text. */
15151 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15152 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15153 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15154 < it
.last_visible_y
))
15155 ++first_unchanged_at_end_row
;
15157 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15158 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15159 >= it
.last_visible_y
))
15160 first_unchanged_at_end_row
= NULL
;
15163 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15165 first_unchanged_at_end_vpos
15166 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15167 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15170 else if (last_unchanged_at_beg_row
== NULL
)
15176 /* Either there is no unchanged row at the end, or the one we have
15177 now displays text. This is a necessary condition for the window
15178 end pos calculation at the end of this function. */
15179 xassert (first_unchanged_at_end_row
== NULL
15180 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15182 debug_last_unchanged_at_beg_vpos
15183 = (last_unchanged_at_beg_row
15184 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15186 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15188 #endif /* GLYPH_DEBUG != 0 */
15191 /* Display new lines. Set last_text_row to the last new line
15192 displayed which has text on it, i.e. might end up as being the
15193 line where the window_end_vpos is. */
15194 w
->cursor
.vpos
= -1;
15195 last_text_row
= NULL
;
15196 overlay_arrow_seen
= 0;
15197 while (it
.current_y
< it
.last_visible_y
15198 && !fonts_changed_p
15199 && (first_unchanged_at_end_row
== NULL
15200 || IT_CHARPOS (it
) < stop_pos
))
15202 if (display_line (&it
))
15203 last_text_row
= it
.glyph_row
- 1;
15206 if (fonts_changed_p
)
15210 /* Compute differences in buffer positions, y-positions etc. for
15211 lines reused at the bottom of the window. Compute what we can
15213 if (first_unchanged_at_end_row
15214 /* No lines reused because we displayed everything up to the
15215 bottom of the window. */
15216 && it
.current_y
< it
.last_visible_y
)
15219 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15221 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15222 run
.current_y
= first_unchanged_at_end_row
->y
;
15223 run
.desired_y
= run
.current_y
+ dy
;
15224 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15228 delta
= delta_bytes
= dvpos
= dy
15229 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15230 first_unchanged_at_end_row
= NULL
;
15232 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15235 /* Find the cursor if not already found. We have to decide whether
15236 PT will appear on this window (it sometimes doesn't, but this is
15237 not a very frequent case.) This decision has to be made before
15238 the current matrix is altered. A value of cursor.vpos < 0 means
15239 that PT is either in one of the lines beginning at
15240 first_unchanged_at_end_row or below the window. Don't care for
15241 lines that might be displayed later at the window end; as
15242 mentioned, this is not a frequent case. */
15243 if (w
->cursor
.vpos
< 0)
15245 /* Cursor in unchanged rows at the top? */
15246 if (PT
< CHARPOS (start_pos
)
15247 && last_unchanged_at_beg_row
)
15249 row
= row_containing_pos (w
, PT
,
15250 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15251 last_unchanged_at_beg_row
+ 1, 0);
15253 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15256 /* Start from first_unchanged_at_end_row looking for PT. */
15257 else if (first_unchanged_at_end_row
)
15259 row
= row_containing_pos (w
, PT
- delta
,
15260 first_unchanged_at_end_row
, NULL
, 0);
15262 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15263 delta_bytes
, dy
, dvpos
);
15266 /* Give up if cursor was not found. */
15267 if (w
->cursor
.vpos
< 0)
15269 clear_glyph_matrix (w
->desired_matrix
);
15274 /* Don't let the cursor end in the scroll margins. */
15276 int this_scroll_margin
, cursor_height
;
15278 this_scroll_margin
= max (0, scroll_margin
);
15279 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15280 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15281 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15283 if ((w
->cursor
.y
< this_scroll_margin
15284 && CHARPOS (start
) > BEGV
)
15285 /* Old redisplay didn't take scroll margin into account at the bottom,
15286 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15287 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15288 ? cursor_height
+ this_scroll_margin
15289 : 1)) > it
.last_visible_y
)
15291 w
->cursor
.vpos
= -1;
15292 clear_glyph_matrix (w
->desired_matrix
);
15297 /* Scroll the display. Do it before changing the current matrix so
15298 that xterm.c doesn't get confused about where the cursor glyph is
15300 if (dy
&& run
.height
)
15304 if (FRAME_WINDOW_P (f
))
15306 FRAME_RIF (f
)->update_window_begin_hook (w
);
15307 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15308 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15309 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15313 /* Terminal frame. In this case, dvpos gives the number of
15314 lines to scroll by; dvpos < 0 means scroll up. */
15315 int first_unchanged_at_end_vpos
15316 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15317 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15318 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15319 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15320 + window_internal_height (w
));
15322 /* Perform the operation on the screen. */
15325 /* Scroll last_unchanged_at_beg_row to the end of the
15326 window down dvpos lines. */
15327 set_terminal_window (f
, end
);
15329 /* On dumb terminals delete dvpos lines at the end
15330 before inserting dvpos empty lines. */
15331 if (!FRAME_SCROLL_REGION_OK (f
))
15332 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15334 /* Insert dvpos empty lines in front of
15335 last_unchanged_at_beg_row. */
15336 ins_del_lines (f
, from
, dvpos
);
15338 else if (dvpos
< 0)
15340 /* Scroll up last_unchanged_at_beg_vpos to the end of
15341 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15342 set_terminal_window (f
, end
);
15344 /* Delete dvpos lines in front of
15345 last_unchanged_at_beg_vpos. ins_del_lines will set
15346 the cursor to the given vpos and emit |dvpos| delete
15348 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15350 /* On a dumb terminal insert dvpos empty lines at the
15352 if (!FRAME_SCROLL_REGION_OK (f
))
15353 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15356 set_terminal_window (f
, 0);
15362 /* Shift reused rows of the current matrix to the right position.
15363 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15365 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15366 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15369 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15370 bottom_vpos
, dvpos
);
15371 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15374 else if (dvpos
> 0)
15376 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15377 bottom_vpos
, dvpos
);
15378 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15379 first_unchanged_at_end_vpos
+ dvpos
, 0);
15382 /* For frame-based redisplay, make sure that current frame and window
15383 matrix are in sync with respect to glyph memory. */
15384 if (!FRAME_WINDOW_P (f
))
15385 sync_frame_with_window_matrix_rows (w
);
15387 /* Adjust buffer positions in reused rows. */
15388 if (delta
|| delta_bytes
)
15389 increment_matrix_positions (current_matrix
,
15390 first_unchanged_at_end_vpos
+ dvpos
,
15391 bottom_vpos
, delta
, delta_bytes
);
15393 /* Adjust Y positions. */
15395 shift_glyph_matrix (w
, current_matrix
,
15396 first_unchanged_at_end_vpos
+ dvpos
,
15399 if (first_unchanged_at_end_row
)
15401 first_unchanged_at_end_row
+= dvpos
;
15402 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15403 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15404 first_unchanged_at_end_row
= NULL
;
15407 /* If scrolling up, there may be some lines to display at the end of
15409 last_text_row_at_end
= NULL
;
15412 /* Scrolling up can leave for example a partially visible line
15413 at the end of the window to be redisplayed. */
15414 /* Set last_row to the glyph row in the current matrix where the
15415 window end line is found. It has been moved up or down in
15416 the matrix by dvpos. */
15417 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15418 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15420 /* If last_row is the window end line, it should display text. */
15421 xassert (last_row
->displays_text_p
);
15423 /* If window end line was partially visible before, begin
15424 displaying at that line. Otherwise begin displaying with the
15425 line following it. */
15426 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15428 init_to_row_start (&it
, w
, last_row
);
15429 it
.vpos
= last_vpos
;
15430 it
.current_y
= last_row
->y
;
15434 init_to_row_end (&it
, w
, last_row
);
15435 it
.vpos
= 1 + last_vpos
;
15436 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15440 /* We may start in a continuation line. If so, we have to
15441 get the right continuation_lines_width and current_x. */
15442 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15443 it
.hpos
= it
.current_x
= 0;
15445 /* Display the rest of the lines at the window end. */
15446 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15447 while (it
.current_y
< it
.last_visible_y
15448 && !fonts_changed_p
)
15450 /* Is it always sure that the display agrees with lines in
15451 the current matrix? I don't think so, so we mark rows
15452 displayed invalid in the current matrix by setting their
15453 enabled_p flag to zero. */
15454 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15455 if (display_line (&it
))
15456 last_text_row_at_end
= it
.glyph_row
- 1;
15460 /* Update window_end_pos and window_end_vpos. */
15461 if (first_unchanged_at_end_row
15462 && !last_text_row_at_end
)
15464 /* Window end line if one of the preserved rows from the current
15465 matrix. Set row to the last row displaying text in current
15466 matrix starting at first_unchanged_at_end_row, after
15468 xassert (first_unchanged_at_end_row
->displays_text_p
);
15469 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15470 first_unchanged_at_end_row
);
15471 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15473 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15474 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15476 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15477 xassert (w
->window_end_bytepos
>= 0);
15478 IF_DEBUG (debug_method_add (w
, "A"));
15480 else if (last_text_row_at_end
)
15483 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15484 w
->window_end_bytepos
15485 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15487 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15488 xassert (w
->window_end_bytepos
>= 0);
15489 IF_DEBUG (debug_method_add (w
, "B"));
15491 else if (last_text_row
)
15493 /* We have displayed either to the end of the window or at the
15494 end of the window, i.e. the last row with text is to be found
15495 in the desired matrix. */
15497 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15498 w
->window_end_bytepos
15499 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15501 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15502 xassert (w
->window_end_bytepos
>= 0);
15504 else if (first_unchanged_at_end_row
== NULL
15505 && last_text_row
== NULL
15506 && last_text_row_at_end
== NULL
)
15508 /* Displayed to end of window, but no line containing text was
15509 displayed. Lines were deleted at the end of the window. */
15510 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15511 int vpos
= XFASTINT (w
->window_end_vpos
);
15512 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15513 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15516 row
== NULL
&& vpos
>= first_vpos
;
15517 --vpos
, --current_row
, --desired_row
)
15519 if (desired_row
->enabled_p
)
15521 if (desired_row
->displays_text_p
)
15524 else if (current_row
->displays_text_p
)
15528 xassert (row
!= NULL
);
15529 w
->window_end_vpos
= make_number (vpos
+ 1);
15530 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15531 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15532 xassert (w
->window_end_bytepos
>= 0);
15533 IF_DEBUG (debug_method_add (w
, "C"));
15538 #if 0 /* This leads to problems, for instance when the cursor is
15539 at ZV, and the cursor line displays no text. */
15540 /* Disable rows below what's displayed in the window. This makes
15541 debugging easier. */
15542 enable_glyph_matrix_rows (current_matrix
,
15543 XFASTINT (w
->window_end_vpos
) + 1,
15547 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15548 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15550 /* Record that display has not been completed. */
15551 w
->window_end_valid
= Qnil
;
15552 w
->desired_matrix
->no_scrolling_p
= 1;
15560 /***********************************************************************
15561 More debugging support
15562 ***********************************************************************/
15566 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15567 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15568 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15571 /* Dump the contents of glyph matrix MATRIX on stderr.
15573 GLYPHS 0 means don't show glyph contents.
15574 GLYPHS 1 means show glyphs in short form
15575 GLYPHS > 1 means show glyphs in long form. */
15578 dump_glyph_matrix (matrix
, glyphs
)
15579 struct glyph_matrix
*matrix
;
15583 for (i
= 0; i
< matrix
->nrows
; ++i
)
15584 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15588 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15589 the glyph row and area where the glyph comes from. */
15592 dump_glyph (row
, glyph
, area
)
15593 struct glyph_row
*row
;
15594 struct glyph
*glyph
;
15597 if (glyph
->type
== CHAR_GLYPH
)
15600 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15601 glyph
- row
->glyphs
[TEXT_AREA
],
15604 (BUFFERP (glyph
->object
)
15606 : (STRINGP (glyph
->object
)
15609 glyph
->pixel_width
,
15611 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15615 glyph
->left_box_line_p
,
15616 glyph
->right_box_line_p
);
15618 else if (glyph
->type
== STRETCH_GLYPH
)
15621 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15622 glyph
- row
->glyphs
[TEXT_AREA
],
15625 (BUFFERP (glyph
->object
)
15627 : (STRINGP (glyph
->object
)
15630 glyph
->pixel_width
,
15634 glyph
->left_box_line_p
,
15635 glyph
->right_box_line_p
);
15637 else if (glyph
->type
== IMAGE_GLYPH
)
15640 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15641 glyph
- row
->glyphs
[TEXT_AREA
],
15644 (BUFFERP (glyph
->object
)
15646 : (STRINGP (glyph
->object
)
15649 glyph
->pixel_width
,
15653 glyph
->left_box_line_p
,
15654 glyph
->right_box_line_p
);
15656 else if (glyph
->type
== COMPOSITE_GLYPH
)
15659 " %5d %4c %6d %c %3d 0x%05x",
15660 glyph
- row
->glyphs
[TEXT_AREA
],
15663 (BUFFERP (glyph
->object
)
15665 : (STRINGP (glyph
->object
)
15668 glyph
->pixel_width
,
15670 if (glyph
->u
.cmp
.automatic
)
15673 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
15674 fprintf (stderr
, " . %4d %1.1d%1.1d\n"
15676 glyph
->left_box_line_p
,
15677 glyph
->right_box_line_p
);
15682 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15683 GLYPHS 0 means don't show glyph contents.
15684 GLYPHS 1 means show glyphs in short form
15685 GLYPHS > 1 means show glyphs in long form. */
15688 dump_glyph_row (row
, vpos
, glyphs
)
15689 struct glyph_row
*row
;
15694 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15695 fprintf (stderr
, "======================================================================\n");
15697 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15698 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15700 MATRIX_ROW_START_CHARPOS (row
),
15701 MATRIX_ROW_END_CHARPOS (row
),
15702 row
->used
[TEXT_AREA
],
15703 row
->contains_overlapping_glyphs_p
,
15705 row
->truncated_on_left_p
,
15706 row
->truncated_on_right_p
,
15708 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15709 row
->displays_text_p
,
15712 row
->ends_in_middle_of_char_p
,
15713 row
->starts_in_middle_of_char_p
,
15719 row
->visible_height
,
15722 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15723 row
->end
.overlay_string_index
,
15724 row
->continuation_lines_width
);
15725 fprintf (stderr
, "%9d %5d\n",
15726 CHARPOS (row
->start
.string_pos
),
15727 CHARPOS (row
->end
.string_pos
));
15728 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15729 row
->end
.dpvec_index
);
15736 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15738 struct glyph
*glyph
= row
->glyphs
[area
];
15739 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15741 /* Glyph for a line end in text. */
15742 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15745 if (glyph
< glyph_end
)
15746 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15748 for (; glyph
< glyph_end
; ++glyph
)
15749 dump_glyph (row
, glyph
, area
);
15752 else if (glyphs
== 1)
15756 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15758 char *s
= (char *) alloca (row
->used
[area
] + 1);
15761 for (i
= 0; i
< row
->used
[area
]; ++i
)
15763 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15764 if (glyph
->type
== CHAR_GLYPH
15765 && glyph
->u
.ch
< 0x80
15766 && glyph
->u
.ch
>= ' ')
15767 s
[i
] = glyph
->u
.ch
;
15773 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15779 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15780 Sdump_glyph_matrix
, 0, 1, "p",
15781 doc
: /* Dump the current matrix of the selected window to stderr.
15782 Shows contents of glyph row structures. With non-nil
15783 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15784 glyphs in short form, otherwise show glyphs in long form. */)
15786 Lisp_Object glyphs
;
15788 struct window
*w
= XWINDOW (selected_window
);
15789 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15791 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15792 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15793 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15794 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15795 fprintf (stderr
, "=============================================\n");
15796 dump_glyph_matrix (w
->current_matrix
,
15797 NILP (glyphs
) ? 0 : XINT (glyphs
));
15802 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15803 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15806 struct frame
*f
= XFRAME (selected_frame
);
15807 dump_glyph_matrix (f
->current_matrix
, 1);
15812 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15813 doc
: /* Dump glyph row ROW to stderr.
15814 GLYPH 0 means don't dump glyphs.
15815 GLYPH 1 means dump glyphs in short form.
15816 GLYPH > 1 or omitted means dump glyphs in long form. */)
15818 Lisp_Object row
, glyphs
;
15820 struct glyph_matrix
*matrix
;
15823 CHECK_NUMBER (row
);
15824 matrix
= XWINDOW (selected_window
)->current_matrix
;
15826 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15827 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15829 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15834 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15835 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15836 GLYPH 0 means don't dump glyphs.
15837 GLYPH 1 means dump glyphs in short form.
15838 GLYPH > 1 or omitted means dump glyphs in long form. */)
15840 Lisp_Object row
, glyphs
;
15842 struct frame
*sf
= SELECTED_FRAME ();
15843 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15846 CHECK_NUMBER (row
);
15848 if (vpos
>= 0 && vpos
< m
->nrows
)
15849 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15850 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15855 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15856 doc
: /* Toggle tracing of redisplay.
15857 With ARG, turn tracing on if and only if ARG is positive. */)
15862 trace_redisplay_p
= !trace_redisplay_p
;
15865 arg
= Fprefix_numeric_value (arg
);
15866 trace_redisplay_p
= XINT (arg
) > 0;
15873 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15874 doc
: /* Like `format', but print result to stderr.
15875 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15880 Lisp_Object s
= Fformat (nargs
, args
);
15881 fprintf (stderr
, "%s", SDATA (s
));
15885 #endif /* GLYPH_DEBUG */
15889 /***********************************************************************
15890 Building Desired Matrix Rows
15891 ***********************************************************************/
15893 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15894 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15896 static struct glyph_row
*
15897 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15899 Lisp_Object overlay_arrow_string
;
15901 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15902 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15903 struct buffer
*old
= current_buffer
;
15904 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15905 int arrow_len
= SCHARS (overlay_arrow_string
);
15906 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15907 const unsigned char *p
;
15910 int n_glyphs_before
;
15912 set_buffer_temp (buffer
);
15913 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15914 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15915 SET_TEXT_POS (it
.position
, 0, 0);
15917 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15919 while (p
< arrow_end
)
15921 Lisp_Object face
, ilisp
;
15923 /* Get the next character. */
15925 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15927 it
.c
= *p
, it
.len
= 1;
15930 /* Get its face. */
15931 ilisp
= make_number (p
- arrow_string
);
15932 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15933 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15935 /* Compute its width, get its glyphs. */
15936 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15937 SET_TEXT_POS (it
.position
, -1, -1);
15938 PRODUCE_GLYPHS (&it
);
15940 /* If this character doesn't fit any more in the line, we have
15941 to remove some glyphs. */
15942 if (it
.current_x
> it
.last_visible_x
)
15944 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15949 set_buffer_temp (old
);
15950 return it
.glyph_row
;
15954 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15955 glyphs are only inserted for terminal frames since we can't really
15956 win with truncation glyphs when partially visible glyphs are
15957 involved. Which glyphs to insert is determined by
15958 produce_special_glyphs. */
15961 insert_left_trunc_glyphs (it
)
15964 struct it truncate_it
;
15965 struct glyph
*from
, *end
, *to
, *toend
;
15967 xassert (!FRAME_WINDOW_P (it
->f
));
15969 /* Get the truncation glyphs. */
15971 truncate_it
.current_x
= 0;
15972 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15973 truncate_it
.glyph_row
= &scratch_glyph_row
;
15974 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15975 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15976 truncate_it
.object
= make_number (0);
15977 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15979 /* Overwrite glyphs from IT with truncation glyphs. */
15980 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15981 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15982 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15983 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15988 /* There may be padding glyphs left over. Overwrite them too. */
15989 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15991 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15997 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16001 /* Compute the pixel height and width of IT->glyph_row.
16003 Most of the time, ascent and height of a display line will be equal
16004 to the max_ascent and max_height values of the display iterator
16005 structure. This is not the case if
16007 1. We hit ZV without displaying anything. In this case, max_ascent
16008 and max_height will be zero.
16010 2. We have some glyphs that don't contribute to the line height.
16011 (The glyph row flag contributes_to_line_height_p is for future
16012 pixmap extensions).
16014 The first case is easily covered by using default values because in
16015 these cases, the line height does not really matter, except that it
16016 must not be zero. */
16019 compute_line_metrics (it
)
16022 struct glyph_row
*row
= it
->glyph_row
;
16025 if (FRAME_WINDOW_P (it
->f
))
16027 int i
, min_y
, max_y
;
16029 /* The line may consist of one space only, that was added to
16030 place the cursor on it. If so, the row's height hasn't been
16032 if (row
->height
== 0)
16034 if (it
->max_ascent
+ it
->max_descent
== 0)
16035 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16036 row
->ascent
= it
->max_ascent
;
16037 row
->height
= it
->max_ascent
+ it
->max_descent
;
16038 row
->phys_ascent
= it
->max_phys_ascent
;
16039 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16040 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16043 /* Compute the width of this line. */
16044 row
->pixel_width
= row
->x
;
16045 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16046 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16048 xassert (row
->pixel_width
>= 0);
16049 xassert (row
->ascent
>= 0 && row
->height
> 0);
16051 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16052 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16054 /* If first line's physical ascent is larger than its logical
16055 ascent, use the physical ascent, and make the row taller.
16056 This makes accented characters fully visible. */
16057 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16058 && row
->phys_ascent
> row
->ascent
)
16060 row
->height
+= row
->phys_ascent
- row
->ascent
;
16061 row
->ascent
= row
->phys_ascent
;
16064 /* Compute how much of the line is visible. */
16065 row
->visible_height
= row
->height
;
16067 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16068 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16070 if (row
->y
< min_y
)
16071 row
->visible_height
-= min_y
- row
->y
;
16072 if (row
->y
+ row
->height
> max_y
)
16073 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16077 row
->pixel_width
= row
->used
[TEXT_AREA
];
16078 if (row
->continued_p
)
16079 row
->pixel_width
-= it
->continuation_pixel_width
;
16080 else if (row
->truncated_on_right_p
)
16081 row
->pixel_width
-= it
->truncation_pixel_width
;
16082 row
->ascent
= row
->phys_ascent
= 0;
16083 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16084 row
->extra_line_spacing
= 0;
16087 /* Compute a hash code for this row. */
16089 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16090 for (i
= 0; i
< row
->used
[area
]; ++i
)
16091 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16092 + row
->glyphs
[area
][i
].u
.val
16093 + row
->glyphs
[area
][i
].face_id
16094 + row
->glyphs
[area
][i
].padding_p
16095 + (row
->glyphs
[area
][i
].type
<< 2));
16097 it
->max_ascent
= it
->max_descent
= 0;
16098 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16102 /* Append one space to the glyph row of iterator IT if doing a
16103 window-based redisplay. The space has the same face as
16104 IT->face_id. Value is non-zero if a space was added.
16106 This function is called to make sure that there is always one glyph
16107 at the end of a glyph row that the cursor can be set on under
16108 window-systems. (If there weren't such a glyph we would not know
16109 how wide and tall a box cursor should be displayed).
16111 At the same time this space let's a nicely handle clearing to the
16112 end of the line if the row ends in italic text. */
16115 append_space_for_newline (it
, default_face_p
)
16117 int default_face_p
;
16119 if (FRAME_WINDOW_P (it
->f
))
16121 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16123 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16124 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16126 /* Save some values that must not be changed.
16127 Must save IT->c and IT->len because otherwise
16128 ITERATOR_AT_END_P wouldn't work anymore after
16129 append_space_for_newline has been called. */
16130 enum display_element_type saved_what
= it
->what
;
16131 int saved_c
= it
->c
, saved_len
= it
->len
;
16132 int saved_x
= it
->current_x
;
16133 int saved_face_id
= it
->face_id
;
16134 struct text_pos saved_pos
;
16135 Lisp_Object saved_object
;
16138 saved_object
= it
->object
;
16139 saved_pos
= it
->position
;
16141 it
->what
= IT_CHARACTER
;
16142 bzero (&it
->position
, sizeof it
->position
);
16143 it
->object
= make_number (0);
16147 if (default_face_p
)
16148 it
->face_id
= DEFAULT_FACE_ID
;
16149 else if (it
->face_before_selective_p
)
16150 it
->face_id
= it
->saved_face_id
;
16151 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16152 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16154 PRODUCE_GLYPHS (it
);
16156 it
->override_ascent
= -1;
16157 it
->constrain_row_ascent_descent_p
= 0;
16158 it
->current_x
= saved_x
;
16159 it
->object
= saved_object
;
16160 it
->position
= saved_pos
;
16161 it
->what
= saved_what
;
16162 it
->face_id
= saved_face_id
;
16163 it
->len
= saved_len
;
16173 /* Extend the face of the last glyph in the text area of IT->glyph_row
16174 to the end of the display line. Called from display_line.
16175 If the glyph row is empty, add a space glyph to it so that we
16176 know the face to draw. Set the glyph row flag fill_line_p. */
16179 extend_face_to_end_of_line (it
)
16183 struct frame
*f
= it
->f
;
16185 /* If line is already filled, do nothing. */
16186 if (it
->current_x
>= it
->last_visible_x
)
16189 /* Face extension extends the background and box of IT->face_id
16190 to the end of the line. If the background equals the background
16191 of the frame, we don't have to do anything. */
16192 if (it
->face_before_selective_p
)
16193 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16195 face
= FACE_FROM_ID (f
, it
->face_id
);
16197 if (FRAME_WINDOW_P (f
)
16198 && it
->glyph_row
->displays_text_p
16199 && face
->box
== FACE_NO_BOX
16200 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16204 /* Set the glyph row flag indicating that the face of the last glyph
16205 in the text area has to be drawn to the end of the text area. */
16206 it
->glyph_row
->fill_line_p
= 1;
16208 /* If current character of IT is not ASCII, make sure we have the
16209 ASCII face. This will be automatically undone the next time
16210 get_next_display_element returns a multibyte character. Note
16211 that the character will always be single byte in unibyte text. */
16212 if (!ASCII_CHAR_P (it
->c
))
16214 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16217 if (FRAME_WINDOW_P (f
))
16219 /* If the row is empty, add a space with the current face of IT,
16220 so that we know which face to draw. */
16221 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16223 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16224 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16225 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16230 /* Save some values that must not be changed. */
16231 int saved_x
= it
->current_x
;
16232 struct text_pos saved_pos
;
16233 Lisp_Object saved_object
;
16234 enum display_element_type saved_what
= it
->what
;
16235 int saved_face_id
= it
->face_id
;
16237 saved_object
= it
->object
;
16238 saved_pos
= it
->position
;
16240 it
->what
= IT_CHARACTER
;
16241 bzero (&it
->position
, sizeof it
->position
);
16242 it
->object
= make_number (0);
16245 it
->face_id
= face
->id
;
16247 PRODUCE_GLYPHS (it
);
16249 while (it
->current_x
<= it
->last_visible_x
)
16250 PRODUCE_GLYPHS (it
);
16252 /* Don't count these blanks really. It would let us insert a left
16253 truncation glyph below and make us set the cursor on them, maybe. */
16254 it
->current_x
= saved_x
;
16255 it
->object
= saved_object
;
16256 it
->position
= saved_pos
;
16257 it
->what
= saved_what
;
16258 it
->face_id
= saved_face_id
;
16263 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16264 trailing whitespace. */
16267 trailing_whitespace_p (charpos
)
16270 int bytepos
= CHAR_TO_BYTE (charpos
);
16273 while (bytepos
< ZV_BYTE
16274 && (c
= FETCH_CHAR (bytepos
),
16275 c
== ' ' || c
== '\t'))
16278 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16280 if (bytepos
!= PT_BYTE
)
16287 /* Highlight trailing whitespace, if any, in ROW. */
16290 highlight_trailing_whitespace (f
, row
)
16292 struct glyph_row
*row
;
16294 int used
= row
->used
[TEXT_AREA
];
16298 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16299 struct glyph
*glyph
= start
+ used
- 1;
16301 /* Skip over glyphs inserted to display the cursor at the
16302 end of a line, for extending the face of the last glyph
16303 to the end of the line on terminals, and for truncation
16304 and continuation glyphs. */
16305 while (glyph
>= start
16306 && glyph
->type
== CHAR_GLYPH
16307 && INTEGERP (glyph
->object
))
16310 /* If last glyph is a space or stretch, and it's trailing
16311 whitespace, set the face of all trailing whitespace glyphs in
16312 IT->glyph_row to `trailing-whitespace'. */
16314 && BUFFERP (glyph
->object
)
16315 && (glyph
->type
== STRETCH_GLYPH
16316 || (glyph
->type
== CHAR_GLYPH
16317 && glyph
->u
.ch
== ' '))
16318 && trailing_whitespace_p (glyph
->charpos
))
16320 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16324 while (glyph
>= start
16325 && BUFFERP (glyph
->object
)
16326 && (glyph
->type
== STRETCH_GLYPH
16327 || (glyph
->type
== CHAR_GLYPH
16328 && glyph
->u
.ch
== ' ')))
16329 (glyph
--)->face_id
= face_id
;
16335 /* Value is non-zero if glyph row ROW in window W should be
16336 used to hold the cursor. */
16339 cursor_row_p (w
, row
)
16341 struct glyph_row
*row
;
16343 int cursor_row_p
= 1;
16345 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16347 /* Suppose the row ends on a string.
16348 Unless the row is continued, that means it ends on a newline
16349 in the string. If it's anything other than a display string
16350 (e.g. a before-string from an overlay), we don't want the
16351 cursor there. (This heuristic seems to give the optimal
16352 behavior for the various types of multi-line strings.) */
16353 if (CHARPOS (row
->end
.string_pos
) >= 0)
16355 if (row
->continued_p
)
16359 /* Check for `display' property. */
16360 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16361 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16362 struct glyph
*glyph
;
16365 for (glyph
= end
; glyph
>= beg
; --glyph
)
16366 if (STRINGP (glyph
->object
))
16369 = Fget_char_property (make_number (PT
),
16373 && display_prop_string_p (prop
, glyph
->object
));
16378 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16380 /* If the row ends in middle of a real character,
16381 and the line is continued, we want the cursor here.
16382 That's because MATRIX_ROW_END_CHARPOS would equal
16383 PT if PT is before the character. */
16384 if (!row
->ends_in_ellipsis_p
)
16385 cursor_row_p
= row
->continued_p
;
16387 /* If the row ends in an ellipsis, then
16388 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16389 We want that position to be displayed after the ellipsis. */
16392 /* If the row ends at ZV, display the cursor at the end of that
16393 row instead of at the start of the row below. */
16394 else if (row
->ends_at_zv_p
)
16400 return cursor_row_p
;
16405 /* Push the display property PROP so that it will be rendered at the
16406 current position in IT. */
16409 push_display_prop (struct it
*it
, Lisp_Object prop
)
16413 /* Never display a cursor on the prefix. */
16414 it
->avoid_cursor_p
= 1;
16416 if (STRINGP (prop
))
16418 if (SCHARS (prop
) == 0)
16425 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16426 it
->current
.overlay_string_index
= -1;
16427 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16428 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16429 it
->method
= GET_FROM_STRING
;
16430 it
->stop_charpos
= 0;
16432 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16434 it
->method
= GET_FROM_STRETCH
;
16437 #ifdef HAVE_WINDOW_SYSTEM
16438 else if (IMAGEP (prop
))
16440 it
->what
= IT_IMAGE
;
16441 it
->image_id
= lookup_image (it
->f
, prop
);
16442 it
->method
= GET_FROM_IMAGE
;
16444 #endif /* HAVE_WINDOW_SYSTEM */
16447 pop_it (it
); /* bogus display property, give up */
16452 /* Return the character-property PROP at the current position in IT. */
16455 get_it_property (it
, prop
)
16459 Lisp_Object position
;
16461 if (STRINGP (it
->object
))
16462 position
= make_number (IT_STRING_CHARPOS (*it
));
16463 else if (BUFFERP (it
->object
))
16464 position
= make_number (IT_CHARPOS (*it
));
16468 return Fget_char_property (position
, prop
, it
->object
);
16471 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16474 handle_line_prefix (struct it
*it
)
16476 Lisp_Object prefix
;
16477 if (it
->continuation_lines_width
> 0)
16479 prefix
= get_it_property (it
, Qwrap_prefix
);
16481 prefix
= Vwrap_prefix
;
16485 prefix
= get_it_property (it
, Qline_prefix
);
16487 prefix
= Vline_prefix
;
16489 if (! NILP (prefix
))
16490 push_display_prop (it
, prefix
);
16495 /* Construct the glyph row IT->glyph_row in the desired matrix of
16496 IT->w from text at the current position of IT. See dispextern.h
16497 for an overview of struct it. Value is non-zero if
16498 IT->glyph_row displays text, as opposed to a line displaying ZV
16505 struct glyph_row
*row
= it
->glyph_row
;
16506 Lisp_Object overlay_arrow_string
;
16508 int may_wrap
= 0, wrap_x
;
16509 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16510 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16511 int wrap_row_extra_line_spacing
;
16513 /* We always start displaying at hpos zero even if hscrolled. */
16514 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16516 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16517 >= it
->w
->desired_matrix
->nrows
)
16519 it
->w
->nrows_scale_factor
++;
16520 fonts_changed_p
= 1;
16524 /* Is IT->w showing the region? */
16525 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16527 /* Clear the result glyph row and enable it. */
16528 prepare_desired_row (row
);
16530 row
->y
= it
->current_y
;
16531 row
->start
= it
->start
;
16532 row
->continuation_lines_width
= it
->continuation_lines_width
;
16533 row
->displays_text_p
= 1;
16534 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16535 it
->starts_in_middle_of_char_p
= 0;
16537 /* Arrange the overlays nicely for our purposes. Usually, we call
16538 display_line on only one line at a time, in which case this
16539 can't really hurt too much, or we call it on lines which appear
16540 one after another in the buffer, in which case all calls to
16541 recenter_overlay_lists but the first will be pretty cheap. */
16542 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16544 /* Move over display elements that are not visible because we are
16545 hscrolled. This may stop at an x-position < IT->first_visible_x
16546 if the first glyph is partially visible or if we hit a line end. */
16547 if (it
->current_x
< it
->first_visible_x
)
16549 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16550 MOVE_TO_POS
| MOVE_TO_X
);
16554 /* We only do this when not calling `move_it_in_display_line_to'
16555 above, because move_it_in_display_line_to calls
16556 handle_line_prefix itself. */
16557 handle_line_prefix (it
);
16560 /* Get the initial row height. This is either the height of the
16561 text hscrolled, if there is any, or zero. */
16562 row
->ascent
= it
->max_ascent
;
16563 row
->height
= it
->max_ascent
+ it
->max_descent
;
16564 row
->phys_ascent
= it
->max_phys_ascent
;
16565 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16566 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16568 /* Loop generating characters. The loop is left with IT on the next
16569 character to display. */
16572 int n_glyphs_before
, hpos_before
, x_before
;
16574 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16576 /* Retrieve the next thing to display. Value is zero if end of
16578 if (!get_next_display_element (it
))
16580 /* Maybe add a space at the end of this line that is used to
16581 display the cursor there under X. Set the charpos of the
16582 first glyph of blank lines not corresponding to any text
16584 #ifdef HAVE_WINDOW_SYSTEM
16585 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16586 row
->exact_window_width_line_p
= 1;
16588 #endif /* HAVE_WINDOW_SYSTEM */
16589 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16590 || row
->used
[TEXT_AREA
] == 0)
16592 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16593 row
->displays_text_p
= 0;
16595 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16596 && (!MINI_WINDOW_P (it
->w
)
16597 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16598 row
->indicate_empty_line_p
= 1;
16601 it
->continuation_lines_width
= 0;
16602 row
->ends_at_zv_p
= 1;
16606 /* Now, get the metrics of what we want to display. This also
16607 generates glyphs in `row' (which is IT->glyph_row). */
16608 n_glyphs_before
= row
->used
[TEXT_AREA
];
16611 /* Remember the line height so far in case the next element doesn't
16612 fit on the line. */
16613 if (it
->line_wrap
!= TRUNCATE
)
16615 ascent
= it
->max_ascent
;
16616 descent
= it
->max_descent
;
16617 phys_ascent
= it
->max_phys_ascent
;
16618 phys_descent
= it
->max_phys_descent
;
16620 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16622 if (IT_DISPLAYING_WHITESPACE (it
))
16628 wrap_row_used
= row
->used
[TEXT_AREA
];
16629 wrap_row_ascent
= row
->ascent
;
16630 wrap_row_height
= row
->height
;
16631 wrap_row_phys_ascent
= row
->phys_ascent
;
16632 wrap_row_phys_height
= row
->phys_height
;
16633 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16639 PRODUCE_GLYPHS (it
);
16641 /* If this display element was in marginal areas, continue with
16643 if (it
->area
!= TEXT_AREA
)
16645 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16646 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16647 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16648 row
->phys_height
= max (row
->phys_height
,
16649 it
->max_phys_ascent
+ it
->max_phys_descent
);
16650 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16651 it
->max_extra_line_spacing
);
16652 set_iterator_to_next (it
, 1);
16656 /* Does the display element fit on the line? If we truncate
16657 lines, we should draw past the right edge of the window. If
16658 we don't truncate, we want to stop so that we can display the
16659 continuation glyph before the right margin. If lines are
16660 continued, there are two possible strategies for characters
16661 resulting in more than 1 glyph (e.g. tabs): Display as many
16662 glyphs as possible in this line and leave the rest for the
16663 continuation line, or display the whole element in the next
16664 line. Original redisplay did the former, so we do it also. */
16665 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16666 hpos_before
= it
->hpos
;
16669 if (/* Not a newline. */
16671 /* Glyphs produced fit entirely in the line. */
16672 && it
->current_x
< it
->last_visible_x
)
16674 it
->hpos
+= nglyphs
;
16675 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16676 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16677 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16678 row
->phys_height
= max (row
->phys_height
,
16679 it
->max_phys_ascent
+ it
->max_phys_descent
);
16680 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16681 it
->max_extra_line_spacing
);
16682 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16683 row
->x
= x
- it
->first_visible_x
;
16688 struct glyph
*glyph
;
16690 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16692 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16693 new_x
= x
+ glyph
->pixel_width
;
16695 if (/* Lines are continued. */
16696 it
->line_wrap
!= TRUNCATE
16697 && (/* Glyph doesn't fit on the line. */
16698 new_x
> it
->last_visible_x
16699 /* Or it fits exactly on a window system frame. */
16700 || (new_x
== it
->last_visible_x
16701 && FRAME_WINDOW_P (it
->f
))))
16703 /* End of a continued line. */
16706 || (new_x
== it
->last_visible_x
16707 && FRAME_WINDOW_P (it
->f
)))
16709 /* Current glyph is the only one on the line or
16710 fits exactly on the line. We must continue
16711 the line because we can't draw the cursor
16712 after the glyph. */
16713 row
->continued_p
= 1;
16714 it
->current_x
= new_x
;
16715 it
->continuation_lines_width
+= new_x
;
16717 if (i
== nglyphs
- 1)
16719 /* If line-wrap is on, check if a previous
16720 wrap point was found. */
16721 if (wrap_row_used
> 0
16722 /* Even if there is a previous wrap
16723 point, continue the line here as
16724 usual, if (i) the previous character
16725 was a space or tab AND (ii) the
16726 current character is not. */
16728 || IT_DISPLAYING_WHITESPACE (it
)))
16731 set_iterator_to_next (it
, 1);
16732 #ifdef HAVE_WINDOW_SYSTEM
16733 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16735 if (!get_next_display_element (it
))
16737 row
->exact_window_width_line_p
= 1;
16738 it
->continuation_lines_width
= 0;
16739 row
->continued_p
= 0;
16740 row
->ends_at_zv_p
= 1;
16742 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16744 row
->continued_p
= 0;
16745 row
->exact_window_width_line_p
= 1;
16748 #endif /* HAVE_WINDOW_SYSTEM */
16751 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16752 && !FRAME_WINDOW_P (it
->f
))
16754 /* A padding glyph that doesn't fit on this line.
16755 This means the whole character doesn't fit
16757 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16759 /* Fill the rest of the row with continuation
16760 glyphs like in 20.x. */
16761 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16762 < row
->glyphs
[1 + TEXT_AREA
])
16763 produce_special_glyphs (it
, IT_CONTINUATION
);
16765 row
->continued_p
= 1;
16766 it
->current_x
= x_before
;
16767 it
->continuation_lines_width
+= x_before
;
16769 /* Restore the height to what it was before the
16770 element not fitting on the line. */
16771 it
->max_ascent
= ascent
;
16772 it
->max_descent
= descent
;
16773 it
->max_phys_ascent
= phys_ascent
;
16774 it
->max_phys_descent
= phys_descent
;
16776 else if (wrap_row_used
> 0)
16780 it
->continuation_lines_width
+= wrap_x
;
16781 row
->used
[TEXT_AREA
] = wrap_row_used
;
16782 row
->ascent
= wrap_row_ascent
;
16783 row
->height
= wrap_row_height
;
16784 row
->phys_ascent
= wrap_row_phys_ascent
;
16785 row
->phys_height
= wrap_row_phys_height
;
16786 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16787 row
->continued_p
= 1;
16788 row
->ends_at_zv_p
= 0;
16789 row
->exact_window_width_line_p
= 0;
16790 it
->continuation_lines_width
+= x
;
16792 /* Make sure that a non-default face is extended
16793 up to the right margin of the window. */
16794 extend_face_to_end_of_line (it
);
16796 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16798 /* A TAB that extends past the right edge of the
16799 window. This produces a single glyph on
16800 window system frames. We leave the glyph in
16801 this row and let it fill the row, but don't
16802 consume the TAB. */
16803 it
->continuation_lines_width
+= it
->last_visible_x
;
16804 row
->ends_in_middle_of_char_p
= 1;
16805 row
->continued_p
= 1;
16806 glyph
->pixel_width
= it
->last_visible_x
- x
;
16807 it
->starts_in_middle_of_char_p
= 1;
16811 /* Something other than a TAB that draws past
16812 the right edge of the window. Restore
16813 positions to values before the element. */
16814 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16816 /* Display continuation glyphs. */
16817 if (!FRAME_WINDOW_P (it
->f
))
16818 produce_special_glyphs (it
, IT_CONTINUATION
);
16819 row
->continued_p
= 1;
16821 it
->current_x
= x_before
;
16822 it
->continuation_lines_width
+= x
;
16823 extend_face_to_end_of_line (it
);
16825 if (nglyphs
> 1 && i
> 0)
16827 row
->ends_in_middle_of_char_p
= 1;
16828 it
->starts_in_middle_of_char_p
= 1;
16831 /* Restore the height to what it was before the
16832 element not fitting on the line. */
16833 it
->max_ascent
= ascent
;
16834 it
->max_descent
= descent
;
16835 it
->max_phys_ascent
= phys_ascent
;
16836 it
->max_phys_descent
= phys_descent
;
16841 else if (new_x
> it
->first_visible_x
)
16843 /* Increment number of glyphs actually displayed. */
16846 if (x
< it
->first_visible_x
)
16847 /* Glyph is partially visible, i.e. row starts at
16848 negative X position. */
16849 row
->x
= x
- it
->first_visible_x
;
16853 /* Glyph is completely off the left margin of the
16854 window. This should not happen because of the
16855 move_it_in_display_line at the start of this
16856 function, unless the text display area of the
16857 window is empty. */
16858 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16862 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16863 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16864 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16865 row
->phys_height
= max (row
->phys_height
,
16866 it
->max_phys_ascent
+ it
->max_phys_descent
);
16867 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16868 it
->max_extra_line_spacing
);
16870 /* End of this display line if row is continued. */
16871 if (row
->continued_p
|| row
->ends_at_zv_p
)
16876 /* Is this a line end? If yes, we're also done, after making
16877 sure that a non-default face is extended up to the right
16878 margin of the window. */
16879 if (ITERATOR_AT_END_OF_LINE_P (it
))
16881 int used_before
= row
->used
[TEXT_AREA
];
16883 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16885 #ifdef HAVE_WINDOW_SYSTEM
16886 /* Add a space at the end of the line that is used to
16887 display the cursor there. */
16888 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16889 append_space_for_newline (it
, 0);
16890 #endif /* HAVE_WINDOW_SYSTEM */
16892 /* Extend the face to the end of the line. */
16893 extend_face_to_end_of_line (it
);
16895 /* Make sure we have the position. */
16896 if (used_before
== 0)
16897 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16899 /* Consume the line end. This skips over invisible lines. */
16900 set_iterator_to_next (it
, 1);
16901 it
->continuation_lines_width
= 0;
16905 /* Proceed with next display element. Note that this skips
16906 over lines invisible because of selective display. */
16907 set_iterator_to_next (it
, 1);
16909 /* If we truncate lines, we are done when the last displayed
16910 glyphs reach past the right margin of the window. */
16911 if (it
->line_wrap
== TRUNCATE
16912 && (FRAME_WINDOW_P (it
->f
)
16913 ? (it
->current_x
>= it
->last_visible_x
)
16914 : (it
->current_x
> it
->last_visible_x
)))
16916 /* Maybe add truncation glyphs. */
16917 if (!FRAME_WINDOW_P (it
->f
))
16921 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16922 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16925 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16927 row
->used
[TEXT_AREA
] = i
;
16928 produce_special_glyphs (it
, IT_TRUNCATION
);
16931 #ifdef HAVE_WINDOW_SYSTEM
16934 /* Don't truncate if we can overflow newline into fringe. */
16935 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16937 if (!get_next_display_element (it
))
16939 it
->continuation_lines_width
= 0;
16940 row
->ends_at_zv_p
= 1;
16941 row
->exact_window_width_line_p
= 1;
16944 if (ITERATOR_AT_END_OF_LINE_P (it
))
16946 row
->exact_window_width_line_p
= 1;
16947 goto at_end_of_line
;
16951 #endif /* HAVE_WINDOW_SYSTEM */
16953 row
->truncated_on_right_p
= 1;
16954 it
->continuation_lines_width
= 0;
16955 reseat_at_next_visible_line_start (it
, 0);
16956 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16957 it
->hpos
= hpos_before
;
16958 it
->current_x
= x_before
;
16963 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16964 at the left window margin. */
16965 if (it
->first_visible_x
16966 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16968 if (!FRAME_WINDOW_P (it
->f
))
16969 insert_left_trunc_glyphs (it
);
16970 row
->truncated_on_left_p
= 1;
16973 /* If the start of this line is the overlay arrow-position, then
16974 mark this glyph row as the one containing the overlay arrow.
16975 This is clearly a mess with variable size fonts. It would be
16976 better to let it be displayed like cursors under X. */
16977 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16978 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16979 !NILP (overlay_arrow_string
)))
16981 /* Overlay arrow in window redisplay is a fringe bitmap. */
16982 if (STRINGP (overlay_arrow_string
))
16984 struct glyph_row
*arrow_row
16985 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16986 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16987 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16988 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16989 struct glyph
*p2
, *end
;
16991 /* Copy the arrow glyphs. */
16992 while (glyph
< arrow_end
)
16995 /* Throw away padding glyphs. */
16997 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16998 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17004 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17009 xassert (INTEGERP (overlay_arrow_string
));
17010 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17012 overlay_arrow_seen
= 1;
17015 /* Compute pixel dimensions of this line. */
17016 compute_line_metrics (it
);
17018 /* Remember the position at which this line ends. */
17019 row
->end
= it
->current
;
17021 /* Record whether this row ends inside an ellipsis. */
17022 row
->ends_in_ellipsis_p
17023 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17024 && it
->ellipsis_p
);
17026 /* Save fringe bitmaps in this row. */
17027 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17028 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17029 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17030 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17032 it
->left_user_fringe_bitmap
= 0;
17033 it
->left_user_fringe_face_id
= 0;
17034 it
->right_user_fringe_bitmap
= 0;
17035 it
->right_user_fringe_face_id
= 0;
17037 /* Maybe set the cursor. */
17038 if (it
->w
->cursor
.vpos
< 0
17039 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17040 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17041 && cursor_row_p (it
->w
, row
))
17042 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17044 /* Highlight trailing whitespace. */
17045 if (!NILP (Vshow_trailing_whitespace
))
17046 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17048 /* Prepare for the next line. This line starts horizontally at (X
17049 HPOS) = (0 0). Vertical positions are incremented. As a
17050 convenience for the caller, IT->glyph_row is set to the next
17052 it
->current_x
= it
->hpos
= 0;
17053 it
->current_y
+= row
->height
;
17056 it
->start
= it
->current
;
17057 return row
->displays_text_p
;
17062 /***********************************************************************
17064 ***********************************************************************/
17066 /* Redisplay the menu bar in the frame for window W.
17068 The menu bar of X frames that don't have X toolkit support is
17069 displayed in a special window W->frame->menu_bar_window.
17071 The menu bar of terminal frames is treated specially as far as
17072 glyph matrices are concerned. Menu bar lines are not part of
17073 windows, so the update is done directly on the frame matrix rows
17074 for the menu bar. */
17077 display_menu_bar (w
)
17080 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17085 /* Don't do all this for graphical frames. */
17087 if (FRAME_W32_P (f
))
17090 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17096 if (FRAME_NS_P (f
))
17098 #endif /* HAVE_NS */
17100 #ifdef USE_X_TOOLKIT
17101 xassert (!FRAME_WINDOW_P (f
));
17102 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17103 it
.first_visible_x
= 0;
17104 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17105 #else /* not USE_X_TOOLKIT */
17106 if (FRAME_WINDOW_P (f
))
17108 /* Menu bar lines are displayed in the desired matrix of the
17109 dummy window menu_bar_window. */
17110 struct window
*menu_w
;
17111 xassert (WINDOWP (f
->menu_bar_window
));
17112 menu_w
= XWINDOW (f
->menu_bar_window
);
17113 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17115 it
.first_visible_x
= 0;
17116 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17120 /* This is a TTY frame, i.e. character hpos/vpos are used as
17122 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17124 it
.first_visible_x
= 0;
17125 it
.last_visible_x
= FRAME_COLS (f
);
17127 #endif /* not USE_X_TOOLKIT */
17129 if (! mode_line_inverse_video
)
17130 /* Force the menu-bar to be displayed in the default face. */
17131 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17133 /* Clear all rows of the menu bar. */
17134 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17136 struct glyph_row
*row
= it
.glyph_row
+ i
;
17137 clear_glyph_row (row
);
17138 row
->enabled_p
= 1;
17139 row
->full_width_p
= 1;
17142 /* Display all items of the menu bar. */
17143 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17144 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17146 Lisp_Object string
;
17148 /* Stop at nil string. */
17149 string
= AREF (items
, i
+ 1);
17153 /* Remember where item was displayed. */
17154 ASET (items
, i
+ 3, make_number (it
.hpos
));
17156 /* Display the item, pad with one space. */
17157 if (it
.current_x
< it
.last_visible_x
)
17158 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17159 SCHARS (string
) + 1, 0, 0, -1);
17162 /* Fill out the line with spaces. */
17163 if (it
.current_x
< it
.last_visible_x
)
17164 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17166 /* Compute the total height of the lines. */
17167 compute_line_metrics (&it
);
17172 /***********************************************************************
17174 ***********************************************************************/
17176 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17177 FORCE is non-zero, redisplay mode lines unconditionally.
17178 Otherwise, redisplay only mode lines that are garbaged. Value is
17179 the number of windows whose mode lines were redisplayed. */
17182 redisplay_mode_lines (window
, force
)
17183 Lisp_Object window
;
17188 while (!NILP (window
))
17190 struct window
*w
= XWINDOW (window
);
17192 if (WINDOWP (w
->hchild
))
17193 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17194 else if (WINDOWP (w
->vchild
))
17195 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17197 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17198 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17200 struct text_pos lpoint
;
17201 struct buffer
*old
= current_buffer
;
17203 /* Set the window's buffer for the mode line display. */
17204 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17205 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17207 /* Point refers normally to the selected window. For any
17208 other window, set up appropriate value. */
17209 if (!EQ (window
, selected_window
))
17211 struct text_pos pt
;
17213 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17214 if (CHARPOS (pt
) < BEGV
)
17215 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17216 else if (CHARPOS (pt
) > (ZV
- 1))
17217 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17219 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17222 /* Display mode lines. */
17223 clear_glyph_matrix (w
->desired_matrix
);
17224 if (display_mode_lines (w
))
17227 w
->must_be_updated_p
= 1;
17230 /* Restore old settings. */
17231 set_buffer_internal_1 (old
);
17232 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17242 /* Display the mode and/or top line of window W. Value is the number
17243 of mode lines displayed. */
17246 display_mode_lines (w
)
17249 Lisp_Object old_selected_window
, old_selected_frame
;
17252 old_selected_frame
= selected_frame
;
17253 selected_frame
= w
->frame
;
17254 old_selected_window
= selected_window
;
17255 XSETWINDOW (selected_window
, w
);
17257 /* These will be set while the mode line specs are processed. */
17258 line_number_displayed
= 0;
17259 w
->column_number_displayed
= Qnil
;
17261 if (WINDOW_WANTS_MODELINE_P (w
))
17263 struct window
*sel_w
= XWINDOW (old_selected_window
);
17265 /* Select mode line face based on the real selected window. */
17266 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17267 current_buffer
->mode_line_format
);
17271 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17273 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17274 current_buffer
->header_line_format
);
17278 selected_frame
= old_selected_frame
;
17279 selected_window
= old_selected_window
;
17284 /* Display mode or top line of window W. FACE_ID specifies which line
17285 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
17286 FORMAT is the mode line format to display. Value is the pixel
17287 height of the mode line displayed. */
17290 display_mode_line (w
, face_id
, format
)
17292 enum face_id face_id
;
17293 Lisp_Object format
;
17297 int count
= SPECPDL_INDEX ();
17299 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17300 /* Don't extend on a previously drawn mode-line.
17301 This may happen if called from pos_visible_p. */
17302 it
.glyph_row
->enabled_p
= 0;
17303 prepare_desired_row (it
.glyph_row
);
17305 it
.glyph_row
->mode_line_p
= 1;
17307 if (! mode_line_inverse_video
)
17308 /* Force the mode-line to be displayed in the default face. */
17309 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17311 record_unwind_protect (unwind_format_mode_line
,
17312 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17314 mode_line_target
= MODE_LINE_DISPLAY
;
17316 /* Temporarily make frame's keyboard the current kboard so that
17317 kboard-local variables in the mode_line_format will get the right
17319 push_kboard (FRAME_KBOARD (it
.f
));
17320 record_unwind_save_match_data ();
17321 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17324 unbind_to (count
, Qnil
);
17326 /* Fill up with spaces. */
17327 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17329 compute_line_metrics (&it
);
17330 it
.glyph_row
->full_width_p
= 1;
17331 it
.glyph_row
->continued_p
= 0;
17332 it
.glyph_row
->truncated_on_left_p
= 0;
17333 it
.glyph_row
->truncated_on_right_p
= 0;
17335 /* Make a 3D mode-line have a shadow at its right end. */
17336 face
= FACE_FROM_ID (it
.f
, face_id
);
17337 extend_face_to_end_of_line (&it
);
17338 if (face
->box
!= FACE_NO_BOX
)
17340 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17341 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17342 last
->right_box_line_p
= 1;
17345 return it
.glyph_row
->height
;
17348 /* Move element ELT in LIST to the front of LIST.
17349 Return the updated list. */
17352 move_elt_to_front (elt
, list
)
17353 Lisp_Object elt
, list
;
17355 register Lisp_Object tail
, prev
;
17356 register Lisp_Object tem
;
17360 while (CONSP (tail
))
17366 /* Splice out the link TAIL. */
17368 list
= XCDR (tail
);
17370 Fsetcdr (prev
, XCDR (tail
));
17372 /* Now make it the first. */
17373 Fsetcdr (tail
, list
);
17378 tail
= XCDR (tail
);
17382 /* Not found--return unchanged LIST. */
17386 /* Contribute ELT to the mode line for window IT->w. How it
17387 translates into text depends on its data type.
17389 IT describes the display environment in which we display, as usual.
17391 DEPTH is the depth in recursion. It is used to prevent
17392 infinite recursion here.
17394 FIELD_WIDTH is the number of characters the display of ELT should
17395 occupy in the mode line, and PRECISION is the maximum number of
17396 characters to display from ELT's representation. See
17397 display_string for details.
17399 Returns the hpos of the end of the text generated by ELT.
17401 PROPS is a property list to add to any string we encounter.
17403 If RISKY is nonzero, remove (disregard) any properties in any string
17404 we encounter, and ignore :eval and :propertize.
17406 The global variable `mode_line_target' determines whether the
17407 output is passed to `store_mode_line_noprop',
17408 `store_mode_line_string', or `display_string'. */
17411 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17414 int field_width
, precision
;
17415 Lisp_Object elt
, props
;
17418 int n
= 0, field
, prec
;
17423 elt
= build_string ("*too-deep*");
17427 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17431 /* A string: output it and check for %-constructs within it. */
17435 if (SCHARS (elt
) > 0
17436 && (!NILP (props
) || risky
))
17438 Lisp_Object oprops
, aelt
;
17439 oprops
= Ftext_properties_at (make_number (0), elt
);
17441 /* If the starting string's properties are not what
17442 we want, translate the string. Also, if the string
17443 is risky, do that anyway. */
17445 if (NILP (Fequal (props
, oprops
)) || risky
)
17447 /* If the starting string has properties,
17448 merge the specified ones onto the existing ones. */
17449 if (! NILP (oprops
) && !risky
)
17453 oprops
= Fcopy_sequence (oprops
);
17455 while (CONSP (tem
))
17457 oprops
= Fplist_put (oprops
, XCAR (tem
),
17458 XCAR (XCDR (tem
)));
17459 tem
= XCDR (XCDR (tem
));
17464 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17465 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17467 /* AELT is what we want. Move it to the front
17468 without consing. */
17470 mode_line_proptrans_alist
17471 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17477 /* If AELT has the wrong props, it is useless.
17478 so get rid of it. */
17480 mode_line_proptrans_alist
17481 = Fdelq (aelt
, mode_line_proptrans_alist
);
17483 elt
= Fcopy_sequence (elt
);
17484 Fset_text_properties (make_number (0), Flength (elt
),
17486 /* Add this item to mode_line_proptrans_alist. */
17487 mode_line_proptrans_alist
17488 = Fcons (Fcons (elt
, props
),
17489 mode_line_proptrans_alist
);
17490 /* Truncate mode_line_proptrans_alist
17491 to at most 50 elements. */
17492 tem
= Fnthcdr (make_number (50),
17493 mode_line_proptrans_alist
);
17495 XSETCDR (tem
, Qnil
);
17504 prec
= precision
- n
;
17505 switch (mode_line_target
)
17507 case MODE_LINE_NOPROP
:
17508 case MODE_LINE_TITLE
:
17509 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17511 case MODE_LINE_STRING
:
17512 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17514 case MODE_LINE_DISPLAY
:
17515 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17516 0, prec
, 0, STRING_MULTIBYTE (elt
));
17523 /* Handle the non-literal case. */
17525 while ((precision
<= 0 || n
< precision
)
17526 && SREF (elt
, offset
) != 0
17527 && (mode_line_target
!= MODE_LINE_DISPLAY
17528 || it
->current_x
< it
->last_visible_x
))
17530 int last_offset
= offset
;
17532 /* Advance to end of string or next format specifier. */
17533 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17536 if (offset
- 1 != last_offset
)
17538 int nchars
, nbytes
;
17540 /* Output to end of string or up to '%'. Field width
17541 is length of string. Don't output more than
17542 PRECISION allows us. */
17545 prec
= c_string_width (SDATA (elt
) + last_offset
,
17546 offset
- last_offset
, precision
- n
,
17549 switch (mode_line_target
)
17551 case MODE_LINE_NOPROP
:
17552 case MODE_LINE_TITLE
:
17553 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17555 case MODE_LINE_STRING
:
17557 int bytepos
= last_offset
;
17558 int charpos
= string_byte_to_char (elt
, bytepos
);
17559 int endpos
= (precision
<= 0
17560 ? string_byte_to_char (elt
, offset
)
17561 : charpos
+ nchars
);
17563 n
+= store_mode_line_string (NULL
,
17564 Fsubstring (elt
, make_number (charpos
),
17565 make_number (endpos
)),
17569 case MODE_LINE_DISPLAY
:
17571 int bytepos
= last_offset
;
17572 int charpos
= string_byte_to_char (elt
, bytepos
);
17574 if (precision
<= 0)
17575 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17576 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17578 STRING_MULTIBYTE (elt
));
17583 else /* c == '%' */
17585 int percent_position
= offset
;
17587 /* Get the specified minimum width. Zero means
17590 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17591 field
= field
* 10 + c
- '0';
17593 /* Don't pad beyond the total padding allowed. */
17594 if (field_width
- n
> 0 && field
> field_width
- n
)
17595 field
= field_width
- n
;
17597 /* Note that either PRECISION <= 0 or N < PRECISION. */
17598 prec
= precision
- n
;
17601 n
+= display_mode_element (it
, depth
, field
, prec
,
17602 Vglobal_mode_string
, props
,
17607 int bytepos
, charpos
;
17608 unsigned char *spec
;
17610 bytepos
= percent_position
;
17611 charpos
= (STRING_MULTIBYTE (elt
)
17612 ? string_byte_to_char (elt
, bytepos
)
17615 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17617 switch (mode_line_target
)
17619 case MODE_LINE_NOPROP
:
17620 case MODE_LINE_TITLE
:
17621 n
+= store_mode_line_noprop (spec
, field
, prec
);
17623 case MODE_LINE_STRING
:
17625 int len
= strlen (spec
);
17626 Lisp_Object tem
= make_string (spec
, len
);
17627 props
= Ftext_properties_at (make_number (charpos
), elt
);
17628 /* Should only keep face property in props */
17629 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17632 case MODE_LINE_DISPLAY
:
17634 int nglyphs_before
, nwritten
;
17636 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17637 nwritten
= display_string (spec
, Qnil
, elt
,
17642 /* Assign to the glyphs written above the
17643 string where the `%x' came from, position
17647 struct glyph
*glyph
17648 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17652 for (i
= 0; i
< nwritten
; ++i
)
17654 glyph
[i
].object
= elt
;
17655 glyph
[i
].charpos
= charpos
;
17672 /* A symbol: process the value of the symbol recursively
17673 as if it appeared here directly. Avoid error if symbol void.
17674 Special case: if value of symbol is a string, output the string
17677 register Lisp_Object tem
;
17679 /* If the variable is not marked as risky to set
17680 then its contents are risky to use. */
17681 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17684 tem
= Fboundp (elt
);
17687 tem
= Fsymbol_value (elt
);
17688 /* If value is a string, output that string literally:
17689 don't check for % within it. */
17693 if (!EQ (tem
, elt
))
17695 /* Give up right away for nil or t. */
17705 register Lisp_Object car
, tem
;
17707 /* A cons cell: five distinct cases.
17708 If first element is :eval or :propertize, do something special.
17709 If first element is a string or a cons, process all the elements
17710 and effectively concatenate them.
17711 If first element is a negative number, truncate displaying cdr to
17712 at most that many characters. If positive, pad (with spaces)
17713 to at least that many characters.
17714 If first element is a symbol, process the cadr or caddr recursively
17715 according to whether the symbol's value is non-nil or nil. */
17717 if (EQ (car
, QCeval
))
17719 /* An element of the form (:eval FORM) means evaluate FORM
17720 and use the result as mode line elements. */
17725 if (CONSP (XCDR (elt
)))
17728 spec
= safe_eval (XCAR (XCDR (elt
)));
17729 n
+= display_mode_element (it
, depth
, field_width
- n
,
17730 precision
- n
, spec
, props
,
17734 else if (EQ (car
, QCpropertize
))
17736 /* An element of the form (:propertize ELT PROPS...)
17737 means display ELT but applying properties PROPS. */
17742 if (CONSP (XCDR (elt
)))
17743 n
+= display_mode_element (it
, depth
, field_width
- n
,
17744 precision
- n
, XCAR (XCDR (elt
)),
17745 XCDR (XCDR (elt
)), risky
);
17747 else if (SYMBOLP (car
))
17749 tem
= Fboundp (car
);
17753 /* elt is now the cdr, and we know it is a cons cell.
17754 Use its car if CAR has a non-nil value. */
17757 tem
= Fsymbol_value (car
);
17764 /* Symbol's value is nil (or symbol is unbound)
17765 Get the cddr of the original list
17766 and if possible find the caddr and use that. */
17770 else if (!CONSP (elt
))
17775 else if (INTEGERP (car
))
17777 register int lim
= XINT (car
);
17781 /* Negative int means reduce maximum width. */
17782 if (precision
<= 0)
17785 precision
= min (precision
, -lim
);
17789 /* Padding specified. Don't let it be more than
17790 current maximum. */
17792 lim
= min (precision
, lim
);
17794 /* If that's more padding than already wanted, queue it.
17795 But don't reduce padding already specified even if
17796 that is beyond the current truncation point. */
17797 field_width
= max (lim
, field_width
);
17801 else if (STRINGP (car
) || CONSP (car
))
17803 register int limit
= 50;
17804 /* Limit is to protect against circular lists. */
17807 && (precision
<= 0 || n
< precision
))
17809 n
+= display_mode_element (it
, depth
,
17810 /* Do padding only after the last
17811 element in the list. */
17812 (! CONSP (XCDR (elt
))
17815 precision
- n
, XCAR (elt
),
17825 elt
= build_string ("*invalid*");
17829 /* Pad to FIELD_WIDTH. */
17830 if (field_width
> 0 && n
< field_width
)
17832 switch (mode_line_target
)
17834 case MODE_LINE_NOPROP
:
17835 case MODE_LINE_TITLE
:
17836 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17838 case MODE_LINE_STRING
:
17839 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17841 case MODE_LINE_DISPLAY
:
17842 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17851 /* Store a mode-line string element in mode_line_string_list.
17853 If STRING is non-null, display that C string. Otherwise, the Lisp
17854 string LISP_STRING is displayed.
17856 FIELD_WIDTH is the minimum number of output glyphs to produce.
17857 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17858 with spaces. FIELD_WIDTH <= 0 means don't pad.
17860 PRECISION is the maximum number of characters to output from
17861 STRING. PRECISION <= 0 means don't truncate the string.
17863 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17864 properties to the string.
17866 PROPS are the properties to add to the string.
17867 The mode_line_string_face face property is always added to the string.
17871 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17873 Lisp_Object lisp_string
;
17882 if (string
!= NULL
)
17884 len
= strlen (string
);
17885 if (precision
> 0 && len
> precision
)
17887 lisp_string
= make_string (string
, len
);
17889 props
= mode_line_string_face_prop
;
17890 else if (!NILP (mode_line_string_face
))
17892 Lisp_Object face
= Fplist_get (props
, Qface
);
17893 props
= Fcopy_sequence (props
);
17895 face
= mode_line_string_face
;
17897 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17898 props
= Fplist_put (props
, Qface
, face
);
17900 Fadd_text_properties (make_number (0), make_number (len
),
17901 props
, lisp_string
);
17905 len
= XFASTINT (Flength (lisp_string
));
17906 if (precision
> 0 && len
> precision
)
17909 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17912 if (!NILP (mode_line_string_face
))
17916 props
= Ftext_properties_at (make_number (0), lisp_string
);
17917 face
= Fplist_get (props
, Qface
);
17919 face
= mode_line_string_face
;
17921 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17922 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17924 lisp_string
= Fcopy_sequence (lisp_string
);
17927 Fadd_text_properties (make_number (0), make_number (len
),
17928 props
, lisp_string
);
17933 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17937 if (field_width
> len
)
17939 field_width
-= len
;
17940 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17942 Fadd_text_properties (make_number (0), make_number (field_width
),
17943 props
, lisp_string
);
17944 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17952 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17954 doc
: /* Format a string out of a mode line format specification.
17955 First arg FORMAT specifies the mode line format (see `mode-line-format'
17956 for details) to use.
17958 Optional second arg FACE specifies the face property to put
17959 on all characters for which no face is specified.
17960 The value t means whatever face the window's mode line currently uses
17961 \(either `mode-line' or `mode-line-inactive', depending).
17962 A value of nil means the default is no face property.
17963 If FACE is an integer, the value string has no text properties.
17965 Optional third and fourth args WINDOW and BUFFER specify the window
17966 and buffer to use as the context for the formatting (defaults
17967 are the selected window and the window's buffer). */)
17968 (format
, face
, window
, buffer
)
17969 Lisp_Object format
, face
, window
, buffer
;
17974 struct buffer
*old_buffer
= NULL
;
17976 int no_props
= INTEGERP (face
);
17977 int count
= SPECPDL_INDEX ();
17979 int string_start
= 0;
17982 window
= selected_window
;
17983 CHECK_WINDOW (window
);
17984 w
= XWINDOW (window
);
17987 buffer
= w
->buffer
;
17988 CHECK_BUFFER (buffer
);
17990 /* Make formatting the modeline a non-op when noninteractive, otherwise
17991 there will be problems later caused by a partially initialized frame. */
17992 if (NILP (format
) || noninteractive
)
17993 return empty_unibyte_string
;
18001 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18002 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18006 face_id
= DEFAULT_FACE_ID
;
18008 if (XBUFFER (buffer
) != current_buffer
)
18009 old_buffer
= current_buffer
;
18011 /* Save things including mode_line_proptrans_alist,
18012 and set that to nil so that we don't alter the outer value. */
18013 record_unwind_protect (unwind_format_mode_line
,
18014 format_mode_line_unwind_data
18015 (old_buffer
, selected_window
, 1));
18016 mode_line_proptrans_alist
= Qnil
;
18018 Fselect_window (window
, Qt
);
18020 set_buffer_internal_1 (XBUFFER (buffer
));
18022 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18026 mode_line_target
= MODE_LINE_NOPROP
;
18027 mode_line_string_face_prop
= Qnil
;
18028 mode_line_string_list
= Qnil
;
18029 string_start
= MODE_LINE_NOPROP_LEN (0);
18033 mode_line_target
= MODE_LINE_STRING
;
18034 mode_line_string_list
= Qnil
;
18035 mode_line_string_face
= face
;
18036 mode_line_string_face_prop
18037 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18040 push_kboard (FRAME_KBOARD (it
.f
));
18041 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18046 len
= MODE_LINE_NOPROP_LEN (string_start
);
18047 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18051 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18052 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18053 empty_unibyte_string
);
18056 unbind_to (count
, Qnil
);
18060 /* Write a null-terminated, right justified decimal representation of
18061 the positive integer D to BUF using a minimal field width WIDTH. */
18064 pint2str (buf
, width
, d
)
18065 register char *buf
;
18066 register int width
;
18069 register char *p
= buf
;
18077 *p
++ = d
% 10 + '0';
18082 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18093 /* Write a null-terminated, right justified decimal and "human
18094 readable" representation of the nonnegative integer D to BUF using
18095 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18097 static const char power_letter
[] =
18111 pint2hrstr (buf
, width
, d
)
18116 /* We aim to represent the nonnegative integer D as
18117 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18120 /* -1 means: do not use TENTHS. */
18124 /* Length of QUOTIENT.TENTHS as a string. */
18130 if (1000 <= quotient
)
18132 /* Scale to the appropriate EXPONENT. */
18135 remainder
= quotient
% 1000;
18139 while (1000 <= quotient
);
18141 /* Round to nearest and decide whether to use TENTHS or not. */
18144 tenths
= remainder
/ 100;
18145 if (50 <= remainder
% 100)
18152 if (quotient
== 10)
18160 if (500 <= remainder
)
18162 if (quotient
< 999)
18173 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18174 if (tenths
== -1 && quotient
<= 99)
18181 p
= psuffix
= buf
+ max (width
, length
);
18183 /* Print EXPONENT. */
18185 *psuffix
++ = power_letter
[exponent
];
18188 /* Print TENTHS. */
18191 *--p
= '0' + tenths
;
18195 /* Print QUOTIENT. */
18198 int digit
= quotient
% 10;
18199 *--p
= '0' + digit
;
18201 while ((quotient
/= 10) != 0);
18203 /* Print leading spaces. */
18208 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18209 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18210 type of CODING_SYSTEM. Return updated pointer into BUF. */
18212 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18215 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18216 Lisp_Object coding_system
;
18217 register char *buf
;
18221 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18222 const unsigned char *eol_str
;
18224 /* The EOL conversion we are using. */
18225 Lisp_Object eoltype
;
18227 val
= CODING_SYSTEM_SPEC (coding_system
);
18230 if (!VECTORP (val
)) /* Not yet decided. */
18235 eoltype
= eol_mnemonic_undecided
;
18236 /* Don't mention EOL conversion if it isn't decided. */
18241 Lisp_Object eolvalue
;
18243 attrs
= AREF (val
, 0);
18244 eolvalue
= AREF (val
, 2);
18247 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18251 /* The EOL conversion that is normal on this system. */
18253 if (NILP (eolvalue
)) /* Not yet decided. */
18254 eoltype
= eol_mnemonic_undecided
;
18255 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18256 eoltype
= eol_mnemonic_undecided
;
18257 else /* eolvalue is Qunix, Qdos, or Qmac. */
18258 eoltype
= (EQ (eolvalue
, Qunix
)
18259 ? eol_mnemonic_unix
18260 : (EQ (eolvalue
, Qdos
) == 1
18261 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18267 /* Mention the EOL conversion if it is not the usual one. */
18268 if (STRINGP (eoltype
))
18270 eol_str
= SDATA (eoltype
);
18271 eol_str_len
= SBYTES (eoltype
);
18273 else if (CHARACTERP (eoltype
))
18275 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18276 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18281 eol_str
= invalid_eol_type
;
18282 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18284 bcopy (eol_str
, buf
, eol_str_len
);
18285 buf
+= eol_str_len
;
18291 /* Return a string for the output of a mode line %-spec for window W,
18292 generated by character C. PRECISION >= 0 means don't return a
18293 string longer than that value. FIELD_WIDTH > 0 means pad the
18294 string returned with spaces to that value. Return 1 in *MULTIBYTE
18295 if the result is multibyte text.
18297 Note we operate on the current buffer for most purposes,
18298 the exception being w->base_line_pos. */
18300 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18303 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
18306 int field_width
, precision
;
18310 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18311 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18312 struct buffer
*b
= current_buffer
;
18320 if (!NILP (b
->read_only
))
18322 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18327 /* This differs from %* only for a modified read-only buffer. */
18328 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18330 if (!NILP (b
->read_only
))
18335 /* This differs from %* in ignoring read-only-ness. */
18336 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18348 if (command_loop_level
> 5)
18350 p
= decode_mode_spec_buf
;
18351 for (i
= 0; i
< command_loop_level
; i
++)
18354 return decode_mode_spec_buf
;
18362 if (command_loop_level
> 5)
18364 p
= decode_mode_spec_buf
;
18365 for (i
= 0; i
< command_loop_level
; i
++)
18368 return decode_mode_spec_buf
;
18375 /* Let lots_of_dashes be a string of infinite length. */
18376 if (mode_line_target
== MODE_LINE_NOPROP
||
18377 mode_line_target
== MODE_LINE_STRING
)
18379 if (field_width
<= 0
18380 || field_width
> sizeof (lots_of_dashes
))
18382 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18383 decode_mode_spec_buf
[i
] = '-';
18384 decode_mode_spec_buf
[i
] = '\0';
18385 return decode_mode_spec_buf
;
18388 return lots_of_dashes
;
18396 /* %c and %l are ignored in `frame-title-format'.
18397 (In redisplay_internal, the frame title is drawn _before_ the
18398 windows are updated, so the stuff which depends on actual
18399 window contents (such as %l) may fail to render properly, or
18400 even crash emacs.) */
18401 if (mode_line_target
== MODE_LINE_TITLE
)
18405 int col
= (int) current_column (); /* iftc */
18406 w
->column_number_displayed
= make_number (col
);
18407 pint2str (decode_mode_spec_buf
, field_width
, col
);
18408 return decode_mode_spec_buf
;
18412 #ifndef SYSTEM_MALLOC
18414 if (NILP (Vmemory_full
))
18417 return "!MEM FULL! ";
18424 /* %F displays the frame name. */
18425 if (!NILP (f
->title
))
18426 return (char *) SDATA (f
->title
);
18427 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18428 return (char *) SDATA (f
->name
);
18437 int size
= ZV
- BEGV
;
18438 pint2str (decode_mode_spec_buf
, field_width
, size
);
18439 return decode_mode_spec_buf
;
18444 int size
= ZV
- BEGV
;
18445 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18446 return decode_mode_spec_buf
;
18451 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18452 int topline
, nlines
, junk
, height
;
18454 /* %c and %l are ignored in `frame-title-format'. */
18455 if (mode_line_target
== MODE_LINE_TITLE
)
18458 startpos
= XMARKER (w
->start
)->charpos
;
18459 startpos_byte
= marker_byte_position (w
->start
);
18460 height
= WINDOW_TOTAL_LINES (w
);
18462 /* If we decided that this buffer isn't suitable for line numbers,
18463 don't forget that too fast. */
18464 if (EQ (w
->base_line_pos
, w
->buffer
))
18466 /* But do forget it, if the window shows a different buffer now. */
18467 else if (BUFFERP (w
->base_line_pos
))
18468 w
->base_line_pos
= Qnil
;
18470 /* If the buffer is very big, don't waste time. */
18471 if (INTEGERP (Vline_number_display_limit
)
18472 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18474 w
->base_line_pos
= Qnil
;
18475 w
->base_line_number
= Qnil
;
18479 if (INTEGERP (w
->base_line_number
)
18480 && INTEGERP (w
->base_line_pos
)
18481 && XFASTINT (w
->base_line_pos
) <= startpos
)
18483 line
= XFASTINT (w
->base_line_number
);
18484 linepos
= XFASTINT (w
->base_line_pos
);
18485 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18490 linepos
= BUF_BEGV (b
);
18491 linepos_byte
= BUF_BEGV_BYTE (b
);
18494 /* Count lines from base line to window start position. */
18495 nlines
= display_count_lines (linepos
, linepos_byte
,
18499 topline
= nlines
+ line
;
18501 /* Determine a new base line, if the old one is too close
18502 or too far away, or if we did not have one.
18503 "Too close" means it's plausible a scroll-down would
18504 go back past it. */
18505 if (startpos
== BUF_BEGV (b
))
18507 w
->base_line_number
= make_number (topline
);
18508 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18510 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18511 || linepos
== BUF_BEGV (b
))
18513 int limit
= BUF_BEGV (b
);
18514 int limit_byte
= BUF_BEGV_BYTE (b
);
18516 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18518 if (startpos
- distance
> limit
)
18520 limit
= startpos
- distance
;
18521 limit_byte
= CHAR_TO_BYTE (limit
);
18524 nlines
= display_count_lines (startpos
, startpos_byte
,
18526 - (height
* 2 + 30),
18528 /* If we couldn't find the lines we wanted within
18529 line_number_display_limit_width chars per line,
18530 give up on line numbers for this window. */
18531 if (position
== limit_byte
&& limit
== startpos
- distance
)
18533 w
->base_line_pos
= w
->buffer
;
18534 w
->base_line_number
= Qnil
;
18538 w
->base_line_number
= make_number (topline
- nlines
);
18539 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18542 /* Now count lines from the start pos to point. */
18543 nlines
= display_count_lines (startpos
, startpos_byte
,
18544 PT_BYTE
, PT
, &junk
);
18546 /* Record that we did display the line number. */
18547 line_number_displayed
= 1;
18549 /* Make the string to show. */
18550 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18551 return decode_mode_spec_buf
;
18554 char* p
= decode_mode_spec_buf
;
18555 int pad
= field_width
- 2;
18561 return decode_mode_spec_buf
;
18567 obj
= b
->mode_name
;
18571 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18577 int pos
= marker_position (w
->start
);
18578 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18580 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18582 if (pos
<= BUF_BEGV (b
))
18587 else if (pos
<= BUF_BEGV (b
))
18591 if (total
> 1000000)
18592 /* Do it differently for a large value, to avoid overflow. */
18593 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18595 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18596 /* We can't normally display a 3-digit number,
18597 so get us a 2-digit number that is close. */
18600 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18601 return decode_mode_spec_buf
;
18605 /* Display percentage of size above the bottom of the screen. */
18608 int toppos
= marker_position (w
->start
);
18609 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18610 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18612 if (botpos
>= BUF_ZV (b
))
18614 if (toppos
<= BUF_BEGV (b
))
18621 if (total
> 1000000)
18622 /* Do it differently for a large value, to avoid overflow. */
18623 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18625 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18626 /* We can't normally display a 3-digit number,
18627 so get us a 2-digit number that is close. */
18630 if (toppos
<= BUF_BEGV (b
))
18631 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18633 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18634 return decode_mode_spec_buf
;
18639 /* status of process */
18640 obj
= Fget_buffer_process (Fcurrent_buffer ());
18642 return "no process";
18643 #ifdef subprocesses
18644 obj
= Fsymbol_name (Fprocess_status (obj
));
18651 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18658 case 't': /* indicate TEXT or BINARY */
18659 #ifdef MODE_LINE_BINARY_TEXT
18660 return MODE_LINE_BINARY_TEXT (b
);
18666 /* coding-system (not including end-of-line format) */
18668 /* coding-system (including end-of-line type) */
18670 int eol_flag
= (c
== 'Z');
18671 char *p
= decode_mode_spec_buf
;
18673 if (! FRAME_WINDOW_P (f
))
18675 /* No need to mention EOL here--the terminal never needs
18676 to do EOL conversion. */
18677 p
= decode_mode_spec_coding (CODING_ID_NAME
18678 (FRAME_KEYBOARD_CODING (f
)->id
),
18680 p
= decode_mode_spec_coding (CODING_ID_NAME
18681 (FRAME_TERMINAL_CODING (f
)->id
),
18684 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18687 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18688 #ifdef subprocesses
18689 obj
= Fget_buffer_process (Fcurrent_buffer ());
18690 if (PROCESSP (obj
))
18692 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18694 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18697 #endif /* subprocesses */
18700 return decode_mode_spec_buf
;
18706 *multibyte
= STRING_MULTIBYTE (obj
);
18707 return (char *) SDATA (obj
);
18714 /* Count up to COUNT lines starting from START / START_BYTE.
18715 But don't go beyond LIMIT_BYTE.
18716 Return the number of lines thus found (always nonnegative).
18718 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18721 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18722 int start
, start_byte
, limit_byte
, count
;
18725 register unsigned char *cursor
;
18726 unsigned char *base
;
18728 register int ceiling
;
18729 register unsigned char *ceiling_addr
;
18730 int orig_count
= count
;
18732 /* If we are not in selective display mode,
18733 check only for newlines. */
18734 int selective_display
= (!NILP (current_buffer
->selective_display
)
18735 && !INTEGERP (current_buffer
->selective_display
));
18739 while (start_byte
< limit_byte
)
18741 ceiling
= BUFFER_CEILING_OF (start_byte
);
18742 ceiling
= min (limit_byte
- 1, ceiling
);
18743 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18744 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18747 if (selective_display
)
18748 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18751 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18754 if (cursor
!= ceiling_addr
)
18758 start_byte
+= cursor
- base
+ 1;
18759 *byte_pos_ptr
= start_byte
;
18763 if (++cursor
== ceiling_addr
)
18769 start_byte
+= cursor
- base
;
18774 while (start_byte
> limit_byte
)
18776 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18777 ceiling
= max (limit_byte
, ceiling
);
18778 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18779 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18782 if (selective_display
)
18783 while (--cursor
!= ceiling_addr
18784 && *cursor
!= '\n' && *cursor
!= 015)
18787 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18790 if (cursor
!= ceiling_addr
)
18794 start_byte
+= cursor
- base
+ 1;
18795 *byte_pos_ptr
= start_byte
;
18796 /* When scanning backwards, we should
18797 not count the newline posterior to which we stop. */
18798 return - orig_count
- 1;
18804 /* Here we add 1 to compensate for the last decrement
18805 of CURSOR, which took it past the valid range. */
18806 start_byte
+= cursor
- base
+ 1;
18810 *byte_pos_ptr
= limit_byte
;
18813 return - orig_count
+ count
;
18814 return orig_count
- count
;
18820 /***********************************************************************
18822 ***********************************************************************/
18824 /* Display a NUL-terminated string, starting with index START.
18826 If STRING is non-null, display that C string. Otherwise, the Lisp
18827 string LISP_STRING is displayed.
18829 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18830 FACE_STRING. Display STRING or LISP_STRING with the face at
18831 FACE_STRING_POS in FACE_STRING:
18833 Display the string in the environment given by IT, but use the
18834 standard display table, temporarily.
18836 FIELD_WIDTH is the minimum number of output glyphs to produce.
18837 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18838 with spaces. If STRING has more characters, more than FIELD_WIDTH
18839 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18841 PRECISION is the maximum number of characters to output from
18842 STRING. PRECISION < 0 means don't truncate the string.
18844 This is roughly equivalent to printf format specifiers:
18846 FIELD_WIDTH PRECISION PRINTF
18847 ----------------------------------------
18853 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18854 display them, and < 0 means obey the current buffer's value of
18855 enable_multibyte_characters.
18857 Value is the number of columns displayed. */
18860 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18861 start
, it
, field_width
, precision
, max_x
, multibyte
)
18862 unsigned char *string
;
18863 Lisp_Object lisp_string
;
18864 Lisp_Object face_string
;
18865 EMACS_INT face_string_pos
;
18868 int field_width
, precision
, max_x
;
18871 int hpos_at_start
= it
->hpos
;
18872 int saved_face_id
= it
->face_id
;
18873 struct glyph_row
*row
= it
->glyph_row
;
18875 /* Initialize the iterator IT for iteration over STRING beginning
18876 with index START. */
18877 reseat_to_string (it
, string
, lisp_string
, start
,
18878 precision
, field_width
, multibyte
);
18880 /* If displaying STRING, set up the face of the iterator
18881 from LISP_STRING, if that's given. */
18882 if (STRINGP (face_string
))
18888 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18889 0, it
->region_beg_charpos
,
18890 it
->region_end_charpos
,
18891 &endptr
, it
->base_face_id
, 0);
18892 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18893 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18896 /* Set max_x to the maximum allowed X position. Don't let it go
18897 beyond the right edge of the window. */
18899 max_x
= it
->last_visible_x
;
18901 max_x
= min (max_x
, it
->last_visible_x
);
18903 /* Skip over display elements that are not visible. because IT->w is
18905 if (it
->current_x
< it
->first_visible_x
)
18906 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18907 MOVE_TO_POS
| MOVE_TO_X
);
18909 row
->ascent
= it
->max_ascent
;
18910 row
->height
= it
->max_ascent
+ it
->max_descent
;
18911 row
->phys_ascent
= it
->max_phys_ascent
;
18912 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18913 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18915 /* This condition is for the case that we are called with current_x
18916 past last_visible_x. */
18917 while (it
->current_x
< max_x
)
18919 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18921 /* Get the next display element. */
18922 if (!get_next_display_element (it
))
18925 /* Produce glyphs. */
18926 x_before
= it
->current_x
;
18927 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18928 PRODUCE_GLYPHS (it
);
18930 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18933 while (i
< nglyphs
)
18935 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18937 if (it
->line_wrap
!= TRUNCATE
18938 && x
+ glyph
->pixel_width
> max_x
)
18940 /* End of continued line or max_x reached. */
18941 if (CHAR_GLYPH_PADDING_P (*glyph
))
18943 /* A wide character is unbreakable. */
18944 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18945 it
->current_x
= x_before
;
18949 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18954 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18956 /* Glyph is at least partially visible. */
18958 if (x
< it
->first_visible_x
)
18959 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18963 /* Glyph is off the left margin of the display area.
18964 Should not happen. */
18968 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18969 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18970 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18971 row
->phys_height
= max (row
->phys_height
,
18972 it
->max_phys_ascent
+ it
->max_phys_descent
);
18973 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18974 it
->max_extra_line_spacing
);
18975 x
+= glyph
->pixel_width
;
18979 /* Stop if max_x reached. */
18983 /* Stop at line ends. */
18984 if (ITERATOR_AT_END_OF_LINE_P (it
))
18986 it
->continuation_lines_width
= 0;
18990 set_iterator_to_next (it
, 1);
18992 /* Stop if truncating at the right edge. */
18993 if (it
->line_wrap
== TRUNCATE
18994 && it
->current_x
>= it
->last_visible_x
)
18996 /* Add truncation mark, but don't do it if the line is
18997 truncated at a padding space. */
18998 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19000 if (!FRAME_WINDOW_P (it
->f
))
19004 if (it
->current_x
> it
->last_visible_x
)
19006 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19007 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19009 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19011 row
->used
[TEXT_AREA
] = i
;
19012 produce_special_glyphs (it
, IT_TRUNCATION
);
19015 produce_special_glyphs (it
, IT_TRUNCATION
);
19017 it
->glyph_row
->truncated_on_right_p
= 1;
19023 /* Maybe insert a truncation at the left. */
19024 if (it
->first_visible_x
19025 && IT_CHARPOS (*it
) > 0)
19027 if (!FRAME_WINDOW_P (it
->f
))
19028 insert_left_trunc_glyphs (it
);
19029 it
->glyph_row
->truncated_on_left_p
= 1;
19032 it
->face_id
= saved_face_id
;
19034 /* Value is number of columns displayed. */
19035 return it
->hpos
- hpos_at_start
;
19040 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19041 appears as an element of LIST or as the car of an element of LIST.
19042 If PROPVAL is a list, compare each element against LIST in that
19043 way, and return 1/2 if any element of PROPVAL is found in LIST.
19044 Otherwise return 0. This function cannot quit.
19045 The return value is 2 if the text is invisible but with an ellipsis
19046 and 1 if it's invisible and without an ellipsis. */
19049 invisible_p (propval
, list
)
19050 register Lisp_Object propval
;
19053 register Lisp_Object tail
, proptail
;
19055 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19057 register Lisp_Object tem
;
19059 if (EQ (propval
, tem
))
19061 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19062 return NILP (XCDR (tem
)) ? 1 : 2;
19065 if (CONSP (propval
))
19067 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19069 Lisp_Object propelt
;
19070 propelt
= XCAR (proptail
);
19071 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19073 register Lisp_Object tem
;
19075 if (EQ (propelt
, tem
))
19077 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19078 return NILP (XCDR (tem
)) ? 1 : 2;
19086 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19087 doc
: /* Non-nil if the property makes the text invisible.
19088 POS-OR-PROP can be a marker or number, in which case it is taken to be
19089 a position in the current buffer and the value of the `invisible' property
19090 is checked; or it can be some other value, which is then presumed to be the
19091 value of the `invisible' property of the text of interest.
19092 The non-nil value returned can be t for truly invisible text or something
19093 else if the text is replaced by an ellipsis. */)
19095 Lisp_Object pos_or_prop
;
19098 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19099 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19101 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19102 return (invis
== 0 ? Qnil
19104 : make_number (invis
));
19107 /* Calculate a width or height in pixels from a specification using
19108 the following elements:
19111 NUM - a (fractional) multiple of the default font width/height
19112 (NUM) - specifies exactly NUM pixels
19113 UNIT - a fixed number of pixels, see below.
19114 ELEMENT - size of a display element in pixels, see below.
19115 (NUM . SPEC) - equals NUM * SPEC
19116 (+ SPEC SPEC ...) - add pixel values
19117 (- SPEC SPEC ...) - subtract pixel values
19118 (- SPEC) - negate pixel value
19121 INT or FLOAT - a number constant
19122 SYMBOL - use symbol's (buffer local) variable binding.
19125 in - pixels per inch *)
19126 mm - pixels per 1/1000 meter *)
19127 cm - pixels per 1/100 meter *)
19128 width - width of current font in pixels.
19129 height - height of current font in pixels.
19131 *) using the ratio(s) defined in display-pixels-per-inch.
19135 left-fringe - left fringe width in pixels
19136 right-fringe - right fringe width in pixels
19138 left-margin - left margin width in pixels
19139 right-margin - right margin width in pixels
19141 scroll-bar - scroll-bar area width in pixels
19145 Pixels corresponding to 5 inches:
19148 Total width of non-text areas on left side of window (if scroll-bar is on left):
19149 '(space :width (+ left-fringe left-margin scroll-bar))
19151 Align to first text column (in header line):
19152 '(space :align-to 0)
19154 Align to middle of text area minus half the width of variable `my-image'
19155 containing a loaded image:
19156 '(space :align-to (0.5 . (- text my-image)))
19158 Width of left margin minus width of 1 character in the default font:
19159 '(space :width (- left-margin 1))
19161 Width of left margin minus width of 2 characters in the current font:
19162 '(space :width (- left-margin (2 . width)))
19164 Center 1 character over left-margin (in header line):
19165 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19167 Different ways to express width of left fringe plus left margin minus one pixel:
19168 '(space :width (- (+ left-fringe left-margin) (1)))
19169 '(space :width (+ left-fringe left-margin (- (1))))
19170 '(space :width (+ left-fringe left-margin (-1)))
19174 #define NUMVAL(X) \
19175 ((INTEGERP (X) || FLOATP (X)) \
19180 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19185 int width_p
, *align_to
;
19189 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19190 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19193 return OK_PIXELS (0);
19195 xassert (FRAME_LIVE_P (it
->f
));
19197 if (SYMBOLP (prop
))
19199 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19201 char *unit
= SDATA (SYMBOL_NAME (prop
));
19203 if (unit
[0] == 'i' && unit
[1] == 'n')
19205 else if (unit
[0] == 'm' && unit
[1] == 'm')
19207 else if (unit
[0] == 'c' && unit
[1] == 'm')
19214 #ifdef HAVE_WINDOW_SYSTEM
19215 if (FRAME_WINDOW_P (it
->f
)
19217 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19218 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19220 return OK_PIXELS (ppi
/ pixels
);
19223 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19224 || (CONSP (Vdisplay_pixels_per_inch
)
19226 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19227 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19229 return OK_PIXELS (ppi
/ pixels
);
19235 #ifdef HAVE_WINDOW_SYSTEM
19236 if (EQ (prop
, Qheight
))
19237 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19238 if (EQ (prop
, Qwidth
))
19239 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19241 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19242 return OK_PIXELS (1);
19245 if (EQ (prop
, Qtext
))
19246 return OK_PIXELS (width_p
19247 ? window_box_width (it
->w
, TEXT_AREA
)
19248 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19250 if (align_to
&& *align_to
< 0)
19253 if (EQ (prop
, Qleft
))
19254 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19255 if (EQ (prop
, Qright
))
19256 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19257 if (EQ (prop
, Qcenter
))
19258 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19259 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19260 if (EQ (prop
, Qleft_fringe
))
19261 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19262 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19263 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19264 if (EQ (prop
, Qright_fringe
))
19265 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19266 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19267 : window_box_right_offset (it
->w
, TEXT_AREA
));
19268 if (EQ (prop
, Qleft_margin
))
19269 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19270 if (EQ (prop
, Qright_margin
))
19271 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19272 if (EQ (prop
, Qscroll_bar
))
19273 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19275 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19276 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19277 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19282 if (EQ (prop
, Qleft_fringe
))
19283 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19284 if (EQ (prop
, Qright_fringe
))
19285 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19286 if (EQ (prop
, Qleft_margin
))
19287 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19288 if (EQ (prop
, Qright_margin
))
19289 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19290 if (EQ (prop
, Qscroll_bar
))
19291 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19294 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19297 if (INTEGERP (prop
) || FLOATP (prop
))
19299 int base_unit
= (width_p
19300 ? FRAME_COLUMN_WIDTH (it
->f
)
19301 : FRAME_LINE_HEIGHT (it
->f
));
19302 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19307 Lisp_Object car
= XCAR (prop
);
19308 Lisp_Object cdr
= XCDR (prop
);
19312 #ifdef HAVE_WINDOW_SYSTEM
19313 if (FRAME_WINDOW_P (it
->f
)
19314 && valid_image_p (prop
))
19316 int id
= lookup_image (it
->f
, prop
);
19317 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19319 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19322 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19328 while (CONSP (cdr
))
19330 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19331 font
, width_p
, align_to
))
19334 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19339 if (EQ (car
, Qminus
))
19341 return OK_PIXELS (pixels
);
19344 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19347 if (INTEGERP (car
) || FLOATP (car
))
19350 pixels
= XFLOATINT (car
);
19352 return OK_PIXELS (pixels
);
19353 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19354 font
, width_p
, align_to
))
19355 return OK_PIXELS (pixels
* fact
);
19366 /***********************************************************************
19368 ***********************************************************************/
19370 #ifdef HAVE_WINDOW_SYSTEM
19375 dump_glyph_string (s
)
19376 struct glyph_string
*s
;
19378 fprintf (stderr
, "glyph string\n");
19379 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19380 s
->x
, s
->y
, s
->width
, s
->height
);
19381 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19382 fprintf (stderr
, " hl = %d\n", s
->hl
);
19383 fprintf (stderr
, " left overhang = %d, right = %d\n",
19384 s
->left_overhang
, s
->right_overhang
);
19385 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19386 fprintf (stderr
, " extends to end of line = %d\n",
19387 s
->extends_to_end_of_line_p
);
19388 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19389 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19392 #endif /* GLYPH_DEBUG */
19394 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19395 of XChar2b structures for S; it can't be allocated in
19396 init_glyph_string because it must be allocated via `alloca'. W
19397 is the window on which S is drawn. ROW and AREA are the glyph row
19398 and area within the row from which S is constructed. START is the
19399 index of the first glyph structure covered by S. HL is a
19400 face-override for drawing S. */
19403 #define OPTIONAL_HDC(hdc) hdc,
19404 #define DECLARE_HDC(hdc) HDC hdc;
19405 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19406 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19409 #ifndef OPTIONAL_HDC
19410 #define OPTIONAL_HDC(hdc)
19411 #define DECLARE_HDC(hdc)
19412 #define ALLOCATE_HDC(hdc, f)
19413 #define RELEASE_HDC(hdc, f)
19417 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19418 struct glyph_string
*s
;
19422 struct glyph_row
*row
;
19423 enum glyph_row_area area
;
19425 enum draw_glyphs_face hl
;
19427 bzero (s
, sizeof *s
);
19429 s
->f
= XFRAME (w
->frame
);
19433 s
->display
= FRAME_X_DISPLAY (s
->f
);
19434 s
->window
= FRAME_X_WINDOW (s
->f
);
19435 s
->char2b
= char2b
;
19439 s
->first_glyph
= row
->glyphs
[area
] + start
;
19440 s
->height
= row
->height
;
19441 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19443 /* Display the internal border below the tool-bar window. */
19444 if (WINDOWP (s
->f
->tool_bar_window
)
19445 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19446 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19448 s
->ybase
= s
->y
+ row
->ascent
;
19452 /* Append the list of glyph strings with head H and tail T to the list
19453 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19456 append_glyph_string_lists (head
, tail
, h
, t
)
19457 struct glyph_string
**head
, **tail
;
19458 struct glyph_string
*h
, *t
;
19472 /* Prepend the list of glyph strings with head H and tail T to the
19473 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19477 prepend_glyph_string_lists (head
, tail
, h
, t
)
19478 struct glyph_string
**head
, **tail
;
19479 struct glyph_string
*h
, *t
;
19493 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19494 Set *HEAD and *TAIL to the resulting list. */
19497 append_glyph_string (head
, tail
, s
)
19498 struct glyph_string
**head
, **tail
;
19499 struct glyph_string
*s
;
19501 s
->next
= s
->prev
= NULL
;
19502 append_glyph_string_lists (head
, tail
, s
, s
);
19506 /* Get face and two-byte form of character C in face FACE_ID on frame
19507 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19508 means we want to display multibyte text. DISPLAY_P non-zero means
19509 make sure that X resources for the face returned are allocated.
19510 Value is a pointer to a realized face that is ready for display if
19511 DISPLAY_P is non-zero. */
19513 static INLINE
struct face
*
19514 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19518 int multibyte_p
, display_p
;
19520 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19524 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19526 if (code
!= FONT_INVALID_CODE
)
19527 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19529 STORE_XCHAR2B (char2b
, 0, 0);
19532 /* Make sure X resources of the face are allocated. */
19533 #ifdef HAVE_X_WINDOWS
19537 xassert (face
!= NULL
);
19538 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19545 /* Get face and two-byte form of character glyph GLYPH on frame F.
19546 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19547 a pointer to a realized face that is ready for display. */
19549 static INLINE
struct face
*
19550 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19552 struct glyph
*glyph
;
19558 xassert (glyph
->type
== CHAR_GLYPH
);
19559 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19566 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19568 if (code
!= FONT_INVALID_CODE
)
19569 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19571 STORE_XCHAR2B (char2b
, 0, 0);
19574 /* Make sure X resources of the face are allocated. */
19575 xassert (face
!= NULL
);
19576 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19581 /* Fill glyph string S with composition components specified by S->cmp.
19583 BASE_FACE is the base face of the composition.
19584 S->cmp_from is the index of the first component for S.
19586 OVERLAPS non-zero means S should draw the foreground only, and use
19587 its physical height for clipping. See also draw_glyphs.
19589 Value is the index of a component not in S. */
19592 fill_composite_glyph_string (s
, base_face
, overlaps
)
19593 struct glyph_string
*s
;
19594 struct face
*base_face
;
19598 /* For all glyphs of this composition, starting at the offset
19599 S->cmp_from, until we reach the end of the definition or encounter a
19600 glyph that requires the different face, add it to S. */
19605 s
->for_overlaps
= overlaps
;
19608 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
19610 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19614 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19617 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19618 s
->char2b
+ i
, 1, 1);
19624 s
->font
= s
->face
->font
;
19626 else if (s
->face
!= face
)
19634 /* All glyph strings for the same composition has the same width,
19635 i.e. the width set for the first component of the composition. */
19636 s
->width
= s
->first_glyph
->pixel_width
;
19638 /* If the specified font could not be loaded, use the frame's
19639 default font, but record the fact that we couldn't load it in
19640 the glyph string so that we can draw rectangles for the
19641 characters of the glyph string. */
19642 if (s
->font
== NULL
)
19644 s
->font_not_found_p
= 1;
19645 s
->font
= FRAME_FONT (s
->f
);
19648 /* Adjust base line for subscript/superscript text. */
19649 s
->ybase
+= s
->first_glyph
->voffset
;
19651 /* This glyph string must always be drawn with 16-bit functions. */
19658 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
19659 struct glyph_string
*s
;
19661 int start
, end
, overlaps
;
19663 struct glyph
*glyph
, *last
;
19664 Lisp_Object lgstring
;
19667 s
->for_overlaps
= overlaps
;
19668 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19669 last
= s
->row
->glyphs
[s
->area
] + end
;
19670 s
->cmp_id
= glyph
->u
.cmp
.id
;
19671 s
->cmp_from
= glyph
->u
.cmp
.from
;
19672 s
->cmp_to
= glyph
->u
.cmp
.to
;
19673 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19674 lgstring
= composition_gstring_from_id (s
->cmp_id
);
19675 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
19677 while (glyph
< last
19678 && glyph
->u
.cmp
.automatic
19679 && glyph
->u
.cmp
.id
== s
->cmp_id
)
19680 s
->cmp_to
= (glyph
++)->u
.cmp
.to
;
19682 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
19684 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
19685 unsigned code
= LGLYPH_CODE (lglyph
);
19687 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
19689 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
19690 return glyph
- s
->row
->glyphs
[s
->area
];
19694 /* Fill glyph string S from a sequence of character glyphs.
19696 FACE_ID is the face id of the string. START is the index of the
19697 first glyph to consider, END is the index of the last + 1.
19698 OVERLAPS non-zero means S should draw the foreground only, and use
19699 its physical height for clipping. See also draw_glyphs.
19701 Value is the index of the first glyph not in S. */
19704 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19705 struct glyph_string
*s
;
19707 int start
, end
, overlaps
;
19709 struct glyph
*glyph
, *last
;
19711 int glyph_not_available_p
;
19713 xassert (s
->f
== XFRAME (s
->w
->frame
));
19714 xassert (s
->nchars
== 0);
19715 xassert (start
>= 0 && end
> start
);
19717 s
->for_overlaps
= overlaps
,
19718 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19719 last
= s
->row
->glyphs
[s
->area
] + end
;
19720 voffset
= glyph
->voffset
;
19721 s
->padding_p
= glyph
->padding_p
;
19722 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19724 while (glyph
< last
19725 && glyph
->type
== CHAR_GLYPH
19726 && glyph
->voffset
== voffset
19727 /* Same face id implies same font, nowadays. */
19728 && glyph
->face_id
== face_id
19729 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19733 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19734 s
->char2b
+ s
->nchars
,
19736 s
->two_byte_p
= two_byte_p
;
19738 xassert (s
->nchars
<= end
- start
);
19739 s
->width
+= glyph
->pixel_width
;
19740 if (glyph
++->padding_p
!= s
->padding_p
)
19744 s
->font
= s
->face
->font
;
19746 /* If the specified font could not be loaded, use the frame's font,
19747 but record the fact that we couldn't load it in
19748 S->font_not_found_p so that we can draw rectangles for the
19749 characters of the glyph string. */
19750 if (s
->font
== NULL
|| glyph_not_available_p
)
19752 s
->font_not_found_p
= 1;
19753 s
->font
= FRAME_FONT (s
->f
);
19756 /* Adjust base line for subscript/superscript text. */
19757 s
->ybase
+= voffset
;
19759 xassert (s
->face
&& s
->face
->gc
);
19760 return glyph
- s
->row
->glyphs
[s
->area
];
19764 /* Fill glyph string S from image glyph S->first_glyph. */
19767 fill_image_glyph_string (s
)
19768 struct glyph_string
*s
;
19770 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19771 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19773 s
->slice
= s
->first_glyph
->slice
;
19774 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19775 s
->font
= s
->face
->font
;
19776 s
->width
= s
->first_glyph
->pixel_width
;
19778 /* Adjust base line for subscript/superscript text. */
19779 s
->ybase
+= s
->first_glyph
->voffset
;
19783 /* Fill glyph string S from a sequence of stretch glyphs.
19785 ROW is the glyph row in which the glyphs are found, AREA is the
19786 area within the row. START is the index of the first glyph to
19787 consider, END is the index of the last + 1.
19789 Value is the index of the first glyph not in S. */
19792 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19793 struct glyph_string
*s
;
19794 struct glyph_row
*row
;
19795 enum glyph_row_area area
;
19798 struct glyph
*glyph
, *last
;
19799 int voffset
, face_id
;
19801 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19803 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19804 last
= s
->row
->glyphs
[s
->area
] + end
;
19805 face_id
= glyph
->face_id
;
19806 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19807 s
->font
= s
->face
->font
;
19808 s
->width
= glyph
->pixel_width
;
19810 voffset
= glyph
->voffset
;
19814 && glyph
->type
== STRETCH_GLYPH
19815 && glyph
->voffset
== voffset
19816 && glyph
->face_id
== face_id
);
19818 s
->width
+= glyph
->pixel_width
;
19820 /* Adjust base line for subscript/superscript text. */
19821 s
->ybase
+= voffset
;
19823 /* The case that face->gc == 0 is handled when drawing the glyph
19824 string by calling PREPARE_FACE_FOR_DISPLAY. */
19826 return glyph
- s
->row
->glyphs
[s
->area
];
19829 static struct font_metrics
*
19830 get_per_char_metric (f
, font
, char2b
)
19835 static struct font_metrics metrics
;
19836 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19838 if (! font
|| code
== FONT_INVALID_CODE
)
19840 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19845 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19846 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19847 assumed to be zero. */
19850 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19851 struct glyph
*glyph
;
19855 *left
= *right
= 0;
19857 if (glyph
->type
== CHAR_GLYPH
)
19861 struct font_metrics
*pcm
;
19863 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19864 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19866 if (pcm
->rbearing
> pcm
->width
)
19867 *right
= pcm
->rbearing
- pcm
->width
;
19868 if (pcm
->lbearing
< 0)
19869 *left
= -pcm
->lbearing
;
19872 else if (glyph
->type
== COMPOSITE_GLYPH
)
19874 if (! glyph
->u
.cmp
.automatic
)
19876 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
19878 if (cmp
->rbearing
- cmp
->pixel_width
)
19879 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19880 if (cmp
->lbearing
< 0);
19881 *left
= - cmp
->lbearing
;
19885 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
19886 struct font_metrics metrics
;
19888 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
19889 glyph
->u
.cmp
.to
, &metrics
);
19890 if (metrics
.rbearing
> metrics
.width
)
19891 *right
= metrics
.rbearing
;
19892 if (metrics
.lbearing
< 0)
19893 *left
= - metrics
.lbearing
;
19899 /* Return the index of the first glyph preceding glyph string S that
19900 is overwritten by S because of S's left overhang. Value is -1
19901 if no glyphs are overwritten. */
19904 left_overwritten (s
)
19905 struct glyph_string
*s
;
19909 if (s
->left_overhang
)
19912 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19913 int first
= s
->first_glyph
- glyphs
;
19915 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19916 x
-= glyphs
[i
].pixel_width
;
19927 /* Return the index of the first glyph preceding glyph string S that
19928 is overwriting S because of its right overhang. Value is -1 if no
19929 glyph in front of S overwrites S. */
19932 left_overwriting (s
)
19933 struct glyph_string
*s
;
19936 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19937 int first
= s
->first_glyph
- glyphs
;
19941 for (i
= first
- 1; i
>= 0; --i
)
19944 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19947 x
-= glyphs
[i
].pixel_width
;
19954 /* Return the index of the last glyph following glyph string S that is
19955 overwritten by S because of S's right overhang. Value is -1 if
19956 no such glyph is found. */
19959 right_overwritten (s
)
19960 struct glyph_string
*s
;
19964 if (s
->right_overhang
)
19967 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19968 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19969 int end
= s
->row
->used
[s
->area
];
19971 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19972 x
+= glyphs
[i
].pixel_width
;
19981 /* Return the index of the last glyph following glyph string S that
19982 overwrites S because of its left overhang. Value is negative
19983 if no such glyph is found. */
19986 right_overwriting (s
)
19987 struct glyph_string
*s
;
19990 int end
= s
->row
->used
[s
->area
];
19991 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19992 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19996 for (i
= first
; i
< end
; ++i
)
19999 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20002 x
+= glyphs
[i
].pixel_width
;
20009 /* Set background width of glyph string S. START is the index of the
20010 first glyph following S. LAST_X is the right-most x-position + 1
20011 in the drawing area. */
20014 set_glyph_string_background_width (s
, start
, last_x
)
20015 struct glyph_string
*s
;
20019 /* If the face of this glyph string has to be drawn to the end of
20020 the drawing area, set S->extends_to_end_of_line_p. */
20022 if (start
== s
->row
->used
[s
->area
]
20023 && s
->area
== TEXT_AREA
20024 && ((s
->row
->fill_line_p
20025 && (s
->hl
== DRAW_NORMAL_TEXT
20026 || s
->hl
== DRAW_IMAGE_RAISED
20027 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20028 || s
->hl
== DRAW_MOUSE_FACE
))
20029 s
->extends_to_end_of_line_p
= 1;
20031 /* If S extends its face to the end of the line, set its
20032 background_width to the distance to the right edge of the drawing
20034 if (s
->extends_to_end_of_line_p
)
20035 s
->background_width
= last_x
- s
->x
+ 1;
20037 s
->background_width
= s
->width
;
20041 /* Compute overhangs and x-positions for glyph string S and its
20042 predecessors, or successors. X is the starting x-position for S.
20043 BACKWARD_P non-zero means process predecessors. */
20046 compute_overhangs_and_x (s
, x
, backward_p
)
20047 struct glyph_string
*s
;
20055 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20056 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20066 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20067 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20077 /* The following macros are only called from draw_glyphs below.
20078 They reference the following parameters of that function directly:
20079 `w', `row', `area', and `overlap_p'
20080 as well as the following local variables:
20081 `s', `f', and `hdc' (in W32) */
20084 /* On W32, silently add local `hdc' variable to argument list of
20085 init_glyph_string. */
20086 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20087 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20089 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20090 init_glyph_string (s, char2b, w, row, area, start, hl)
20093 /* Add a glyph string for a stretch glyph to the list of strings
20094 between HEAD and TAIL. START is the index of the stretch glyph in
20095 row area AREA of glyph row ROW. END is the index of the last glyph
20096 in that glyph row area. X is the current output position assigned
20097 to the new glyph string constructed. HL overrides that face of the
20098 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20099 is the right-most x-position of the drawing area. */
20101 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20102 and below -- keep them on one line. */
20103 #define BUILD_STRETCH_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 START = fill_stretch_glyph_string (s, row, area, START, END); \
20109 append_glyph_string (&HEAD, &TAIL, s); \
20115 /* Add a glyph string for an image glyph to the list of strings
20116 between HEAD and TAIL. START is the index of the image glyph in
20117 row area AREA of glyph row ROW. END is the index of the last glyph
20118 in that glyph row area. X is the current output position assigned
20119 to the new glyph string constructed. HL overrides that face of the
20120 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20121 is the right-most x-position of the drawing area. */
20123 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20126 s = (struct glyph_string *) alloca (sizeof *s); \
20127 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20128 fill_image_glyph_string (s); \
20129 append_glyph_string (&HEAD, &TAIL, s); \
20136 /* Add a glyph string for a sequence of character glyphs to the list
20137 of strings between HEAD and TAIL. START is the index of the first
20138 glyph in row area AREA of glyph row ROW that is part of the new
20139 glyph string. END is the index of the last glyph in that glyph row
20140 area. X is the current output position assigned to the new glyph
20141 string constructed. HL overrides that face of the glyph; e.g. it
20142 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20143 right-most x-position of the drawing area. */
20145 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20151 face_id = (row)->glyphs[area][START].face_id; \
20153 s = (struct glyph_string *) alloca (sizeof *s); \
20154 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20155 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20156 append_glyph_string (&HEAD, &TAIL, s); \
20158 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20163 /* Add a glyph string for a composite sequence to the list of strings
20164 between HEAD and TAIL. START is the index of the first glyph in
20165 row area AREA of glyph row ROW that is part of the new glyph
20166 string. END is the index of the last glyph in that glyph row area.
20167 X is the current output position assigned to the new glyph string
20168 constructed. HL overrides that face of the glyph; e.g. it is
20169 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20170 x-position of the drawing area. */
20172 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20174 int face_id = (row)->glyphs[area][START].face_id; \
20175 struct face *base_face = FACE_FROM_ID (f, face_id); \
20176 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20177 struct composition *cmp = composition_table[cmp_id]; \
20179 struct glyph_string *first_s; \
20182 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20184 /* Make glyph_strings for each glyph sequence that is drawable by \
20185 the same face, and append them to HEAD/TAIL. */ \
20186 for (n = 0; n < cmp->glyph_len;) \
20188 s = (struct glyph_string *) alloca (sizeof *s); \
20189 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20190 append_glyph_string (&(HEAD), &(TAIL), s); \
20196 n = fill_composite_glyph_string (s, base_face, overlaps); \
20204 /* Add a glyph string for a glyph-string sequence to the list of strings
20205 between HEAD and TAIL. */
20207 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20211 Lisp_Object gstring; \
20213 face_id = (row)->glyphs[area][START].face_id; \
20214 gstring = (composition_gstring_from_id \
20215 ((row)->glyphs[area][START].u.cmp.id)); \
20216 s = (struct glyph_string *) alloca (sizeof *s); \
20217 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20218 * LGSTRING_GLYPH_LEN (gstring)); \
20219 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20220 append_glyph_string (&(HEAD), &(TAIL), s); \
20222 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20226 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20227 of AREA of glyph row ROW on window W between indices START and END.
20228 HL overrides the face for drawing glyph strings, e.g. it is
20229 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20230 x-positions of the drawing area.
20232 This is an ugly monster macro construct because we must use alloca
20233 to allocate glyph strings (because draw_glyphs can be called
20234 asynchronously). */
20236 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20239 HEAD = TAIL = NULL; \
20240 while (START < END) \
20242 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20243 switch (first_glyph->type) \
20246 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20250 case COMPOSITE_GLYPH: \
20251 if (first_glyph->u.cmp.automatic) \
20252 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
20255 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20259 case STRETCH_GLYPH: \
20260 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20264 case IMAGE_GLYPH: \
20265 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20275 set_glyph_string_background_width (s, START, LAST_X); \
20282 /* Draw glyphs between START and END in AREA of ROW on window W,
20283 starting at x-position X. X is relative to AREA in W. HL is a
20284 face-override with the following meaning:
20286 DRAW_NORMAL_TEXT draw normally
20287 DRAW_CURSOR draw in cursor face
20288 DRAW_MOUSE_FACE draw in mouse face.
20289 DRAW_INVERSE_VIDEO draw in mode line face
20290 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20291 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20293 If OVERLAPS is non-zero, draw only the foreground of characters and
20294 clip to the physical height of ROW. Non-zero value also defines
20295 the overlapping part to be drawn:
20297 OVERLAPS_PRED overlap with preceding rows
20298 OVERLAPS_SUCC overlap with succeeding rows
20299 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20300 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20302 Value is the x-position reached, relative to AREA of W. */
20305 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20308 struct glyph_row
*row
;
20309 enum glyph_row_area area
;
20310 EMACS_INT start
, end
;
20311 enum draw_glyphs_face hl
;
20314 struct glyph_string
*head
, *tail
;
20315 struct glyph_string
*s
;
20316 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20317 int i
, j
, x_reached
, last_x
, area_left
= 0;
20318 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20321 ALLOCATE_HDC (hdc
, f
);
20323 /* Let's rather be paranoid than getting a SEGV. */
20324 end
= min (end
, row
->used
[area
]);
20325 start
= max (0, start
);
20326 start
= min (end
, start
);
20328 /* Translate X to frame coordinates. Set last_x to the right
20329 end of the drawing area. */
20330 if (row
->full_width_p
)
20332 /* X is relative to the left edge of W, without scroll bars
20334 area_left
= WINDOW_LEFT_EDGE_X (w
);
20335 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20339 area_left
= window_box_left (w
, area
);
20340 last_x
= area_left
+ window_box_width (w
, area
);
20344 /* Build a doubly-linked list of glyph_string structures between
20345 head and tail from what we have to draw. Note that the macro
20346 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20347 the reason we use a separate variable `i'. */
20349 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20351 x_reached
= tail
->x
+ tail
->background_width
;
20355 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20356 the row, redraw some glyphs in front or following the glyph
20357 strings built above. */
20358 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20360 struct glyph_string
*h
, *t
;
20361 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20362 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20365 /* If mouse highlighting is on, we may need to draw adjacent
20366 glyphs using mouse-face highlighting. */
20367 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20369 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20371 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20372 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20374 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20376 check_mouse_face
= 1;
20377 mouse_beg_col
= (row
== mouse_beg_row
)
20378 ? dpyinfo
->mouse_face_beg_col
: 0;
20379 mouse_end_col
= (row
== mouse_end_row
)
20380 ? dpyinfo
->mouse_face_end_col
20381 : row
->used
[TEXT_AREA
];
20385 /* Compute overhangs for all glyph strings. */
20386 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20387 for (s
= head
; s
; s
= s
->next
)
20388 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20390 /* Prepend glyph strings for glyphs in front of the first glyph
20391 string that are overwritten because of the first glyph
20392 string's left overhang. The background of all strings
20393 prepended must be drawn because the first glyph string
20395 i
= left_overwritten (head
);
20398 enum draw_glyphs_face overlap_hl
;
20400 /* If this row contains mouse highlighting, attempt to draw
20401 the overlapped glyphs with the correct highlight. This
20402 code fails if the overlap encompasses more than one glyph
20403 and mouse-highlight spans only some of these glyphs.
20404 However, making it work perfectly involves a lot more
20405 code, and I don't know if the pathological case occurs in
20406 practice, so we'll stick to this for now. --- cyd */
20407 if (check_mouse_face
20408 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20409 overlap_hl
= DRAW_MOUSE_FACE
;
20411 overlap_hl
= DRAW_NORMAL_TEXT
;
20414 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20415 overlap_hl
, dummy_x
, last_x
);
20416 compute_overhangs_and_x (t
, head
->x
, 1);
20417 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20421 /* Prepend glyph strings for glyphs in front of the first glyph
20422 string that overwrite that glyph string because of their
20423 right overhang. For these strings, only the foreground must
20424 be drawn, because it draws over the glyph string at `head'.
20425 The background must not be drawn because this would overwrite
20426 right overhangs of preceding glyphs for which no glyph
20428 i
= left_overwriting (head
);
20431 enum draw_glyphs_face overlap_hl
;
20433 if (check_mouse_face
20434 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20435 overlap_hl
= DRAW_MOUSE_FACE
;
20437 overlap_hl
= DRAW_NORMAL_TEXT
;
20440 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20441 overlap_hl
, dummy_x
, last_x
);
20442 for (s
= h
; s
; s
= s
->next
)
20443 s
->background_filled_p
= 1;
20444 compute_overhangs_and_x (t
, head
->x
, 1);
20445 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20448 /* Append glyphs strings for glyphs following the last glyph
20449 string tail that are overwritten by tail. The background of
20450 these strings has to be drawn because tail's foreground draws
20452 i
= right_overwritten (tail
);
20455 enum draw_glyphs_face overlap_hl
;
20457 if (check_mouse_face
20458 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20459 overlap_hl
= DRAW_MOUSE_FACE
;
20461 overlap_hl
= DRAW_NORMAL_TEXT
;
20463 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20464 overlap_hl
, x
, last_x
);
20465 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20466 append_glyph_string_lists (&head
, &tail
, h
, t
);
20470 /* Append glyph strings for glyphs following the last glyph
20471 string tail that overwrite tail. The foreground of such
20472 glyphs has to be drawn because it writes into the background
20473 of tail. The background must not be drawn because it could
20474 paint over the foreground of following glyphs. */
20475 i
= right_overwriting (tail
);
20478 enum draw_glyphs_face overlap_hl
;
20479 if (check_mouse_face
20480 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20481 overlap_hl
= DRAW_MOUSE_FACE
;
20483 overlap_hl
= DRAW_NORMAL_TEXT
;
20486 i
++; /* We must include the Ith glyph. */
20487 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20488 overlap_hl
, x
, last_x
);
20489 for (s
= h
; s
; s
= s
->next
)
20490 s
->background_filled_p
= 1;
20491 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20492 append_glyph_string_lists (&head
, &tail
, h
, t
);
20494 if (clip_head
|| clip_tail
)
20495 for (s
= head
; s
; s
= s
->next
)
20497 s
->clip_head
= clip_head
;
20498 s
->clip_tail
= clip_tail
;
20502 /* Draw all strings. */
20503 for (s
= head
; s
; s
= s
->next
)
20504 FRAME_RIF (f
)->draw_glyph_string (s
);
20507 /* When focus a sole frame and move horizontally, this sets on_p to 0
20508 causing a failure to erase prev cursor position. */
20509 if (area
== TEXT_AREA
20510 && !row
->full_width_p
20511 /* When drawing overlapping rows, only the glyph strings'
20512 foreground is drawn, which doesn't erase a cursor
20516 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20517 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20518 : (tail
? tail
->x
+ tail
->background_width
: x
));
20522 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20523 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20527 /* Value is the x-position up to which drawn, relative to AREA of W.
20528 This doesn't include parts drawn because of overhangs. */
20529 if (row
->full_width_p
)
20530 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20532 x_reached
-= area_left
;
20534 RELEASE_HDC (hdc
, f
);
20539 /* Expand row matrix if too narrow. Don't expand if area
20542 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20544 if (!fonts_changed_p \
20545 && (it->glyph_row->glyphs[area] \
20546 < it->glyph_row->glyphs[area + 1])) \
20548 it->w->ncols_scale_factor++; \
20549 fonts_changed_p = 1; \
20553 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20554 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20560 struct glyph
*glyph
;
20561 enum glyph_row_area area
= it
->area
;
20563 xassert (it
->glyph_row
);
20564 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20566 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20567 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20569 glyph
->charpos
= CHARPOS (it
->position
);
20570 glyph
->object
= it
->object
;
20571 if (it
->pixel_width
> 0)
20573 glyph
->pixel_width
= it
->pixel_width
;
20574 glyph
->padding_p
= 0;
20578 /* Assure at least 1-pixel width. Otherwise, cursor can't
20579 be displayed correctly. */
20580 glyph
->pixel_width
= 1;
20581 glyph
->padding_p
= 1;
20583 glyph
->ascent
= it
->ascent
;
20584 glyph
->descent
= it
->descent
;
20585 glyph
->voffset
= it
->voffset
;
20586 glyph
->type
= CHAR_GLYPH
;
20587 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20588 glyph
->multibyte_p
= it
->multibyte_p
;
20589 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20590 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20591 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20592 || it
->phys_descent
> it
->descent
);
20593 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20594 glyph
->face_id
= it
->face_id
;
20595 glyph
->u
.ch
= it
->char_to_display
;
20596 glyph
->slice
= null_glyph_slice
;
20597 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20598 ++it
->glyph_row
->used
[area
];
20601 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20604 /* Store one glyph for the composition IT->cmp_it.id in
20605 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
20609 append_composite_glyph (it
)
20612 struct glyph
*glyph
;
20613 enum glyph_row_area area
= it
->area
;
20615 xassert (it
->glyph_row
);
20617 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20618 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20620 glyph
->charpos
= CHARPOS (it
->position
);
20621 glyph
->object
= it
->object
;
20622 glyph
->pixel_width
= it
->pixel_width
;
20623 glyph
->ascent
= it
->ascent
;
20624 glyph
->descent
= it
->descent
;
20625 glyph
->voffset
= it
->voffset
;
20626 glyph
->type
= COMPOSITE_GLYPH
;
20627 if (it
->cmp_it
.ch
< 0)
20629 glyph
->u
.cmp
.automatic
= 0;
20630 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20634 glyph
->u
.cmp
.automatic
= 1;
20635 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20636 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
20637 glyph
->u
.cmp
.to
= it
->cmp_it
.to
;
20639 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20640 glyph
->multibyte_p
= it
->multibyte_p
;
20641 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20642 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20643 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20644 || it
->phys_descent
> it
->descent
);
20645 glyph
->padding_p
= 0;
20646 glyph
->glyph_not_available_p
= 0;
20647 glyph
->face_id
= it
->face_id
;
20648 glyph
->slice
= null_glyph_slice
;
20649 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20650 ++it
->glyph_row
->used
[area
];
20653 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20657 /* Change IT->ascent and IT->height according to the setting of
20661 take_vertical_position_into_account (it
)
20666 if (it
->voffset
< 0)
20667 /* Increase the ascent so that we can display the text higher
20669 it
->ascent
-= it
->voffset
;
20671 /* Increase the descent so that we can display the text lower
20673 it
->descent
+= it
->voffset
;
20678 /* Produce glyphs/get display metrics for the image IT is loaded with.
20679 See the description of struct display_iterator in dispextern.h for
20680 an overview of struct display_iterator. */
20683 produce_image_glyph (it
)
20688 int glyph_ascent
, crop
;
20689 struct glyph_slice slice
;
20691 xassert (it
->what
== IT_IMAGE
);
20693 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20695 /* Make sure X resources of the face is loaded. */
20696 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20698 if (it
->image_id
< 0)
20700 /* Fringe bitmap. */
20701 it
->ascent
= it
->phys_ascent
= 0;
20702 it
->descent
= it
->phys_descent
= 0;
20703 it
->pixel_width
= 0;
20708 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20710 /* Make sure X resources of the image is loaded. */
20711 prepare_image_for_display (it
->f
, img
);
20713 slice
.x
= slice
.y
= 0;
20714 slice
.width
= img
->width
;
20715 slice
.height
= img
->height
;
20717 if (INTEGERP (it
->slice
.x
))
20718 slice
.x
= XINT (it
->slice
.x
);
20719 else if (FLOATP (it
->slice
.x
))
20720 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20722 if (INTEGERP (it
->slice
.y
))
20723 slice
.y
= XINT (it
->slice
.y
);
20724 else if (FLOATP (it
->slice
.y
))
20725 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20727 if (INTEGERP (it
->slice
.width
))
20728 slice
.width
= XINT (it
->slice
.width
);
20729 else if (FLOATP (it
->slice
.width
))
20730 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20732 if (INTEGERP (it
->slice
.height
))
20733 slice
.height
= XINT (it
->slice
.height
);
20734 else if (FLOATP (it
->slice
.height
))
20735 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20737 if (slice
.x
>= img
->width
)
20738 slice
.x
= img
->width
;
20739 if (slice
.y
>= img
->height
)
20740 slice
.y
= img
->height
;
20741 if (slice
.x
+ slice
.width
>= img
->width
)
20742 slice
.width
= img
->width
- slice
.x
;
20743 if (slice
.y
+ slice
.height
> img
->height
)
20744 slice
.height
= img
->height
- slice
.y
;
20746 if (slice
.width
== 0 || slice
.height
== 0)
20749 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20751 it
->descent
= slice
.height
- glyph_ascent
;
20753 it
->descent
+= img
->vmargin
;
20754 if (slice
.y
+ slice
.height
== img
->height
)
20755 it
->descent
+= img
->vmargin
;
20756 it
->phys_descent
= it
->descent
;
20758 it
->pixel_width
= slice
.width
;
20760 it
->pixel_width
+= img
->hmargin
;
20761 if (slice
.x
+ slice
.width
== img
->width
)
20762 it
->pixel_width
+= img
->hmargin
;
20764 /* It's quite possible for images to have an ascent greater than
20765 their height, so don't get confused in that case. */
20766 if (it
->descent
< 0)
20769 #if 0 /* this breaks image tiling */
20770 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20771 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20772 if (face_ascent
> it
->ascent
)
20773 it
->ascent
= it
->phys_ascent
= face_ascent
;
20778 if (face
->box
!= FACE_NO_BOX
)
20780 if (face
->box_line_width
> 0)
20783 it
->ascent
+= face
->box_line_width
;
20784 if (slice
.y
+ slice
.height
== img
->height
)
20785 it
->descent
+= face
->box_line_width
;
20788 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20789 it
->pixel_width
+= eabs (face
->box_line_width
);
20790 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20791 it
->pixel_width
+= eabs (face
->box_line_width
);
20794 take_vertical_position_into_account (it
);
20796 /* Automatically crop wide image glyphs at right edge so we can
20797 draw the cursor on same display row. */
20798 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20799 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20801 it
->pixel_width
-= crop
;
20802 slice
.width
-= crop
;
20807 struct glyph
*glyph
;
20808 enum glyph_row_area area
= it
->area
;
20810 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20811 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20813 glyph
->charpos
= CHARPOS (it
->position
);
20814 glyph
->object
= it
->object
;
20815 glyph
->pixel_width
= it
->pixel_width
;
20816 glyph
->ascent
= glyph_ascent
;
20817 glyph
->descent
= it
->descent
;
20818 glyph
->voffset
= it
->voffset
;
20819 glyph
->type
= IMAGE_GLYPH
;
20820 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20821 glyph
->multibyte_p
= it
->multibyte_p
;
20822 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20823 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20824 glyph
->overlaps_vertically_p
= 0;
20825 glyph
->padding_p
= 0;
20826 glyph
->glyph_not_available_p
= 0;
20827 glyph
->face_id
= it
->face_id
;
20828 glyph
->u
.img_id
= img
->id
;
20829 glyph
->slice
= slice
;
20830 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20831 ++it
->glyph_row
->used
[area
];
20834 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20839 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20840 of the glyph, WIDTH and HEIGHT are the width and height of the
20841 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20844 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20846 Lisp_Object object
;
20850 struct glyph
*glyph
;
20851 enum glyph_row_area area
= it
->area
;
20853 xassert (ascent
>= 0 && ascent
<= height
);
20855 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20856 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20858 glyph
->charpos
= CHARPOS (it
->position
);
20859 glyph
->object
= object
;
20860 glyph
->pixel_width
= width
;
20861 glyph
->ascent
= ascent
;
20862 glyph
->descent
= height
- ascent
;
20863 glyph
->voffset
= it
->voffset
;
20864 glyph
->type
= STRETCH_GLYPH
;
20865 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20866 glyph
->multibyte_p
= it
->multibyte_p
;
20867 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20868 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20869 glyph
->overlaps_vertically_p
= 0;
20870 glyph
->padding_p
= 0;
20871 glyph
->glyph_not_available_p
= 0;
20872 glyph
->face_id
= it
->face_id
;
20873 glyph
->u
.stretch
.ascent
= ascent
;
20874 glyph
->u
.stretch
.height
= height
;
20875 glyph
->slice
= null_glyph_slice
;
20876 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20877 ++it
->glyph_row
->used
[area
];
20880 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20884 /* Produce a stretch glyph for iterator IT. IT->object is the value
20885 of the glyph property displayed. The value must be a list
20886 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20889 1. `:width WIDTH' specifies that the space should be WIDTH *
20890 canonical char width wide. WIDTH may be an integer or floating
20893 2. `:relative-width FACTOR' specifies that the width of the stretch
20894 should be computed from the width of the first character having the
20895 `glyph' property, and should be FACTOR times that width.
20897 3. `:align-to HPOS' specifies that the space should be wide enough
20898 to reach HPOS, a value in canonical character units.
20900 Exactly one of the above pairs must be present.
20902 4. `:height HEIGHT' specifies that the height of the stretch produced
20903 should be HEIGHT, measured in canonical character units.
20905 5. `:relative-height FACTOR' specifies that the height of the
20906 stretch should be FACTOR times the height of the characters having
20907 the glyph property.
20909 Either none or exactly one of 4 or 5 must be present.
20911 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20912 of the stretch should be used for the ascent of the stretch.
20913 ASCENT must be in the range 0 <= ASCENT <= 100. */
20916 produce_stretch_glyph (it
)
20919 /* (space :width WIDTH :height HEIGHT ...) */
20920 Lisp_Object prop
, plist
;
20921 int width
= 0, height
= 0, align_to
= -1;
20922 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20925 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20926 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20928 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20930 /* List should start with `space'. */
20931 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20932 plist
= XCDR (it
->object
);
20934 /* Compute the width of the stretch. */
20935 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20936 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20938 /* Absolute width `:width WIDTH' specified and valid. */
20939 zero_width_ok_p
= 1;
20942 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20945 /* Relative width `:relative-width FACTOR' specified and valid.
20946 Compute the width of the characters having the `glyph'
20949 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20952 if (it
->multibyte_p
)
20954 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20955 - IT_BYTEPOS (*it
));
20956 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20959 it2
.c
= *p
, it2
.len
= 1;
20961 it2
.glyph_row
= NULL
;
20962 it2
.what
= IT_CHARACTER
;
20963 x_produce_glyphs (&it2
);
20964 width
= NUMVAL (prop
) * it2
.pixel_width
;
20966 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20967 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20969 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20970 align_to
= (align_to
< 0
20972 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20973 else if (align_to
< 0)
20974 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20975 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20976 zero_width_ok_p
= 1;
20979 /* Nothing specified -> width defaults to canonical char width. */
20980 width
= FRAME_COLUMN_WIDTH (it
->f
);
20982 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20985 /* Compute height. */
20986 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20987 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20990 zero_height_ok_p
= 1;
20992 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20994 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20996 height
= FONT_HEIGHT (font
);
20998 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21001 /* Compute percentage of height used for ascent. If
21002 `:ascent ASCENT' is present and valid, use that. Otherwise,
21003 derive the ascent from the font in use. */
21004 if (prop
= Fplist_get (plist
, QCascent
),
21005 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21006 ascent
= height
* NUMVAL (prop
) / 100.0;
21007 else if (!NILP (prop
)
21008 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21009 ascent
= min (max (0, (int)tem
), height
);
21011 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21013 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21014 && it
->current_x
+ width
> it
->last_visible_x
)
21015 width
= it
->last_visible_x
- it
->current_x
- 1;
21017 if (width
> 0 && height
> 0 && it
->glyph_row
)
21019 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21020 if (!STRINGP (object
))
21021 object
= it
->w
->buffer
;
21022 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21025 it
->pixel_width
= width
;
21026 it
->ascent
= it
->phys_ascent
= ascent
;
21027 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21028 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21030 take_vertical_position_into_account (it
);
21033 /* Calculate line-height and line-spacing properties.
21034 An integer value specifies explicit pixel value.
21035 A float value specifies relative value to current face height.
21036 A cons (float . face-name) specifies relative value to
21037 height of specified face font.
21039 Returns height in pixels, or nil. */
21043 calc_line_height_property (it
, val
, font
, boff
, override
)
21047 int boff
, override
;
21049 Lisp_Object face_name
= Qnil
;
21050 int ascent
, descent
, height
;
21052 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21057 face_name
= XCAR (val
);
21059 if (!NUMBERP (val
))
21060 val
= make_number (1);
21061 if (NILP (face_name
))
21063 height
= it
->ascent
+ it
->descent
;
21068 if (NILP (face_name
))
21070 font
= FRAME_FONT (it
->f
);
21071 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21073 else if (EQ (face_name
, Qt
))
21082 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21084 return make_number (-1);
21086 face
= FACE_FROM_ID (it
->f
, face_id
);
21089 return make_number (-1);
21090 boff
= font
->baseline_offset
;
21091 if (font
->vertical_centering
)
21092 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21095 ascent
= FONT_BASE (font
) + boff
;
21096 descent
= FONT_DESCENT (font
) - boff
;
21100 it
->override_ascent
= ascent
;
21101 it
->override_descent
= descent
;
21102 it
->override_boff
= boff
;
21105 height
= ascent
+ descent
;
21109 height
= (int)(XFLOAT_DATA (val
) * height
);
21110 else if (INTEGERP (val
))
21111 height
*= XINT (val
);
21113 return make_number (height
);
21118 Produce glyphs/get display metrics for the display element IT is
21119 loaded with. See the description of struct it in dispextern.h
21120 for an overview of struct it. */
21123 x_produce_glyphs (it
)
21126 int extra_line_spacing
= it
->extra_line_spacing
;
21128 it
->glyph_not_available_p
= 0;
21130 if (it
->what
== IT_CHARACTER
)
21134 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21135 struct font_metrics
*pcm
;
21136 int font_not_found_p
;
21137 int boff
; /* baseline offset */
21138 /* We may change it->multibyte_p upon unibyte<->multibyte
21139 conversion. So, save the current value now and restore it
21142 Note: It seems that we don't have to record multibyte_p in
21143 struct glyph because the character code itself tells if or
21144 not the character is multibyte. Thus, in the future, we must
21145 consider eliminating the field `multibyte_p' in the struct
21147 int saved_multibyte_p
= it
->multibyte_p
;
21149 /* Maybe translate single-byte characters to multibyte, or the
21151 it
->char_to_display
= it
->c
;
21152 if (!ASCII_BYTE_P (it
->c
)
21153 && ! it
->multibyte_p
)
21155 if (SINGLE_BYTE_CHAR_P (it
->c
)
21156 && unibyte_display_via_language_environment
)
21157 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
21158 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
21160 it
->multibyte_p
= 1;
21161 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21163 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21167 /* Get font to use. Encode IT->char_to_display. */
21168 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21169 &char2b
, it
->multibyte_p
, 0);
21172 /* When no suitable font found, use the default font. */
21173 font_not_found_p
= font
== NULL
;
21174 if (font_not_found_p
)
21176 font
= FRAME_FONT (it
->f
);
21177 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21181 boff
= font
->baseline_offset
;
21182 if (font
->vertical_centering
)
21183 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21186 if (it
->char_to_display
>= ' '
21187 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21189 /* Either unibyte or ASCII. */
21194 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21196 if (it
->override_ascent
>= 0)
21198 it
->ascent
= it
->override_ascent
;
21199 it
->descent
= it
->override_descent
;
21200 boff
= it
->override_boff
;
21204 it
->ascent
= FONT_BASE (font
) + boff
;
21205 it
->descent
= FONT_DESCENT (font
) - boff
;
21210 it
->phys_ascent
= pcm
->ascent
+ boff
;
21211 it
->phys_descent
= pcm
->descent
- boff
;
21212 it
->pixel_width
= pcm
->width
;
21216 it
->glyph_not_available_p
= 1;
21217 it
->phys_ascent
= it
->ascent
;
21218 it
->phys_descent
= it
->descent
;
21219 it
->pixel_width
= FONT_WIDTH (font
);
21222 if (it
->constrain_row_ascent_descent_p
)
21224 if (it
->descent
> it
->max_descent
)
21226 it
->ascent
+= it
->descent
- it
->max_descent
;
21227 it
->descent
= it
->max_descent
;
21229 if (it
->ascent
> it
->max_ascent
)
21231 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21232 it
->ascent
= it
->max_ascent
;
21234 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21235 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21236 extra_line_spacing
= 0;
21239 /* If this is a space inside a region of text with
21240 `space-width' property, change its width. */
21241 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21243 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21245 /* If face has a box, add the box thickness to the character
21246 height. If character has a box line to the left and/or
21247 right, add the box line width to the character's width. */
21248 if (face
->box
!= FACE_NO_BOX
)
21250 int thick
= face
->box_line_width
;
21254 it
->ascent
+= thick
;
21255 it
->descent
+= thick
;
21260 if (it
->start_of_box_run_p
)
21261 it
->pixel_width
+= thick
;
21262 if (it
->end_of_box_run_p
)
21263 it
->pixel_width
+= thick
;
21266 /* If face has an overline, add the height of the overline
21267 (1 pixel) and a 1 pixel margin to the character height. */
21268 if (face
->overline_p
)
21269 it
->ascent
+= overline_margin
;
21271 if (it
->constrain_row_ascent_descent_p
)
21273 if (it
->ascent
> it
->max_ascent
)
21274 it
->ascent
= it
->max_ascent
;
21275 if (it
->descent
> it
->max_descent
)
21276 it
->descent
= it
->max_descent
;
21279 take_vertical_position_into_account (it
);
21281 /* If we have to actually produce glyphs, do it. */
21286 /* Translate a space with a `space-width' property
21287 into a stretch glyph. */
21288 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21289 / FONT_HEIGHT (font
));
21290 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21291 it
->ascent
+ it
->descent
, ascent
);
21296 /* If characters with lbearing or rbearing are displayed
21297 in this line, record that fact in a flag of the
21298 glyph row. This is used to optimize X output code. */
21299 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21300 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21302 if (! stretched_p
&& it
->pixel_width
== 0)
21303 /* We assure that all visible glyphs have at least 1-pixel
21305 it
->pixel_width
= 1;
21307 else if (it
->char_to_display
== '\n')
21309 /* A newline has no width but we need the height of the line.
21310 But if previous part of the line set a height, don't
21311 increase that height */
21313 Lisp_Object height
;
21314 Lisp_Object total_height
= Qnil
;
21316 it
->override_ascent
= -1;
21317 it
->pixel_width
= 0;
21320 height
= get_it_property(it
, Qline_height
);
21321 /* Split (line-height total-height) list */
21323 && CONSP (XCDR (height
))
21324 && NILP (XCDR (XCDR (height
))))
21326 total_height
= XCAR (XCDR (height
));
21327 height
= XCAR (height
);
21329 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21331 if (it
->override_ascent
>= 0)
21333 it
->ascent
= it
->override_ascent
;
21334 it
->descent
= it
->override_descent
;
21335 boff
= it
->override_boff
;
21339 it
->ascent
= FONT_BASE (font
) + boff
;
21340 it
->descent
= FONT_DESCENT (font
) - boff
;
21343 if (EQ (height
, Qt
))
21345 if (it
->descent
> it
->max_descent
)
21347 it
->ascent
+= it
->descent
- it
->max_descent
;
21348 it
->descent
= it
->max_descent
;
21350 if (it
->ascent
> it
->max_ascent
)
21352 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21353 it
->ascent
= it
->max_ascent
;
21355 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21356 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21357 it
->constrain_row_ascent_descent_p
= 1;
21358 extra_line_spacing
= 0;
21362 Lisp_Object spacing
;
21364 it
->phys_ascent
= it
->ascent
;
21365 it
->phys_descent
= it
->descent
;
21367 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21368 && face
->box
!= FACE_NO_BOX
21369 && face
->box_line_width
> 0)
21371 it
->ascent
+= face
->box_line_width
;
21372 it
->descent
+= face
->box_line_width
;
21375 && XINT (height
) > it
->ascent
+ it
->descent
)
21376 it
->ascent
= XINT (height
) - it
->descent
;
21378 if (!NILP (total_height
))
21379 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21382 spacing
= get_it_property(it
, Qline_spacing
);
21383 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21385 if (INTEGERP (spacing
))
21387 extra_line_spacing
= XINT (spacing
);
21388 if (!NILP (total_height
))
21389 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21393 else if (it
->char_to_display
== '\t')
21395 if (font
->space_width
> 0)
21397 int tab_width
= it
->tab_width
* font
->space_width
;
21398 int x
= it
->current_x
+ it
->continuation_lines_width
;
21399 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21401 /* If the distance from the current position to the next tab
21402 stop is less than a space character width, use the
21403 tab stop after that. */
21404 if (next_tab_x
- x
< font
->space_width
)
21405 next_tab_x
+= tab_width
;
21407 it
->pixel_width
= next_tab_x
- x
;
21409 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21410 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21414 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21415 it
->ascent
+ it
->descent
, it
->ascent
);
21420 it
->pixel_width
= 0;
21426 /* A multi-byte character. Assume that the display width of the
21427 character is the width of the character multiplied by the
21428 width of the font. */
21430 /* If we found a font, this font should give us the right
21431 metrics. If we didn't find a font, use the frame's
21432 default font and calculate the width of the character by
21433 multiplying the width of font by the width of the
21436 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21438 if (font_not_found_p
|| !pcm
)
21440 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21442 if (char_width
== 0)
21443 /* This is a non spacing character. But, as we are
21444 going to display an empty box, the box must occupy
21445 at least one column. */
21447 it
->glyph_not_available_p
= 1;
21448 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21449 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21450 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21454 it
->pixel_width
= pcm
->width
;
21455 it
->phys_ascent
= pcm
->ascent
+ boff
;
21456 it
->phys_descent
= pcm
->descent
- boff
;
21458 && (pcm
->lbearing
< 0
21459 || pcm
->rbearing
> pcm
->width
))
21460 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21463 it
->ascent
= FONT_BASE (font
) + boff
;
21464 it
->descent
= FONT_DESCENT (font
) - boff
;
21465 if (face
->box
!= FACE_NO_BOX
)
21467 int thick
= face
->box_line_width
;
21471 it
->ascent
+= thick
;
21472 it
->descent
+= thick
;
21477 if (it
->start_of_box_run_p
)
21478 it
->pixel_width
+= thick
;
21479 if (it
->end_of_box_run_p
)
21480 it
->pixel_width
+= thick
;
21483 /* If face has an overline, add the height of the overline
21484 (1 pixel) and a 1 pixel margin to the character height. */
21485 if (face
->overline_p
)
21486 it
->ascent
+= overline_margin
;
21488 take_vertical_position_into_account (it
);
21490 if (it
->ascent
< 0)
21492 if (it
->descent
< 0)
21497 if (it
->pixel_width
== 0)
21498 /* We assure that all visible glyphs have at least 1-pixel
21500 it
->pixel_width
= 1;
21502 it
->multibyte_p
= saved_multibyte_p
;
21504 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
21506 /* A static compositoin.
21508 Note: A composition is represented as one glyph in the
21509 glyph matrix. There are no padding glyphs.
21511 Important is that pixel_width, ascent, and descent are the
21512 values of what is drawn by draw_glyphs (i.e. the values of
21513 the overall glyphs composed). */
21514 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21515 int boff
; /* baseline offset */
21516 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
21517 int glyph_len
= cmp
->glyph_len
;
21518 struct font
*font
= face
->font
;
21522 /* If we have not yet calculated pixel size data of glyphs of
21523 the composition for the current face font, calculate them
21524 now. Theoretically, we have to check all fonts for the
21525 glyphs, but that requires much time and memory space. So,
21526 here we check only the font of the first glyph. This leads
21527 to incorrect display, but it's very rare, and C-l (recenter)
21528 can correct the display anyway. */
21529 if (! cmp
->font
|| cmp
->font
!= font
)
21531 /* Ascent and descent of the font of the first character
21532 of this composition (adjusted by baseline offset).
21533 Ascent and descent of overall glyphs should not be less
21534 than them respectively. */
21535 int font_ascent
, font_descent
, font_height
;
21536 /* Bounding box of the overall glyphs. */
21537 int leftmost
, rightmost
, lowest
, highest
;
21538 int lbearing
, rbearing
;
21539 int i
, width
, ascent
, descent
;
21540 int left_padded
= 0, right_padded
= 0;
21543 struct font_metrics
*pcm
;
21544 int font_not_found_p
;
21547 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21548 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21550 if (glyph_len
< cmp
->glyph_len
)
21552 for (i
= 0; i
< glyph_len
; i
++)
21554 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21556 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21561 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21562 : IT_CHARPOS (*it
));
21563 /* When no suitable font found, use the default font. */
21564 font_not_found_p
= font
== NULL
;
21565 if (font_not_found_p
)
21567 face
= face
->ascii_face
;
21570 boff
= font
->baseline_offset
;
21571 if (font
->vertical_centering
)
21572 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21573 font_ascent
= FONT_BASE (font
) + boff
;
21574 font_descent
= FONT_DESCENT (font
) - boff
;
21575 font_height
= FONT_HEIGHT (font
);
21577 cmp
->font
= (void *) font
;
21580 if (! font_not_found_p
)
21582 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21583 &char2b
, it
->multibyte_p
, 0);
21584 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21587 /* Initialize the bounding box. */
21590 width
= pcm
->width
;
21591 ascent
= pcm
->ascent
;
21592 descent
= pcm
->descent
;
21593 lbearing
= pcm
->lbearing
;
21594 rbearing
= pcm
->rbearing
;
21598 width
= FONT_WIDTH (font
);
21599 ascent
= FONT_BASE (font
);
21600 descent
= FONT_DESCENT (font
);
21607 lowest
= - descent
+ boff
;
21608 highest
= ascent
+ boff
;
21610 if (! font_not_found_p
21611 && font
->default_ascent
21612 && CHAR_TABLE_P (Vuse_default_ascent
)
21613 && !NILP (Faref (Vuse_default_ascent
,
21614 make_number (it
->char_to_display
))))
21615 highest
= font
->default_ascent
+ boff
;
21617 /* Draw the first glyph at the normal position. It may be
21618 shifted to right later if some other glyphs are drawn
21620 cmp
->offsets
[i
* 2] = 0;
21621 cmp
->offsets
[i
* 2 + 1] = boff
;
21622 cmp
->lbearing
= lbearing
;
21623 cmp
->rbearing
= rbearing
;
21625 /* Set cmp->offsets for the remaining glyphs. */
21626 for (i
++; i
< glyph_len
; i
++)
21628 int left
, right
, btm
, top
;
21629 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21631 struct face
*this_face
;
21636 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21637 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21638 font
= this_face
->font
;
21644 this_boff
= font
->baseline_offset
;
21645 if (font
->vertical_centering
)
21646 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21647 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21648 &char2b
, it
->multibyte_p
, 0);
21649 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21652 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21655 width
= pcm
->width
;
21656 ascent
= pcm
->ascent
;
21657 descent
= pcm
->descent
;
21658 lbearing
= pcm
->lbearing
;
21659 rbearing
= pcm
->rbearing
;
21660 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21662 /* Relative composition with or without
21663 alternate chars. */
21664 left
= (leftmost
+ rightmost
- width
) / 2;
21665 btm
= - descent
+ boff
;
21666 if (font
->relative_compose
21667 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21668 || NILP (Faref (Vignore_relative_composition
,
21669 make_number (ch
)))))
21672 if (- descent
>= font
->relative_compose
)
21673 /* One extra pixel between two glyphs. */
21675 else if (ascent
<= 0)
21676 /* One extra pixel between two glyphs. */
21677 btm
= lowest
- 1 - ascent
- descent
;
21682 /* A composition rule is specified by an integer
21683 value that encodes global and new reference
21684 points (GREF and NREF). GREF and NREF are
21685 specified by numbers as below:
21687 0---1---2 -- ascent
21691 9--10--11 -- center
21693 ---3---4---5--- baseline
21695 6---7---8 -- descent
21697 int rule
= COMPOSITION_RULE (cmp
, i
);
21698 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21700 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21701 grefx
= gref
% 3, nrefx
= nref
% 3;
21702 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21704 xoff
= font_height
* (xoff
- 128) / 256;
21706 yoff
= font_height
* (yoff
- 128) / 256;
21709 + grefx
* (rightmost
- leftmost
) / 2
21710 - nrefx
* width
/ 2
21713 btm
= ((grefy
== 0 ? highest
21715 : grefy
== 2 ? lowest
21716 : (highest
+ lowest
) / 2)
21717 - (nrefy
== 0 ? ascent
+ descent
21718 : nrefy
== 1 ? descent
- boff
21720 : (ascent
+ descent
) / 2)
21724 cmp
->offsets
[i
* 2] = left
;
21725 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21727 /* Update the bounding box of the overall glyphs. */
21730 right
= left
+ width
;
21731 if (left
< leftmost
)
21733 if (right
> rightmost
)
21736 top
= btm
+ descent
+ ascent
;
21742 if (cmp
->lbearing
> left
+ lbearing
)
21743 cmp
->lbearing
= left
+ lbearing
;
21744 if (cmp
->rbearing
< left
+ rbearing
)
21745 cmp
->rbearing
= left
+ rbearing
;
21749 /* If there are glyphs whose x-offsets are negative,
21750 shift all glyphs to the right and make all x-offsets
21754 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21755 cmp
->offsets
[i
* 2] -= leftmost
;
21756 rightmost
-= leftmost
;
21757 cmp
->lbearing
-= leftmost
;
21758 cmp
->rbearing
-= leftmost
;
21761 if (left_padded
&& cmp
->lbearing
< 0)
21763 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21764 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21765 rightmost
-= cmp
->lbearing
;
21766 cmp
->rbearing
-= cmp
->lbearing
;
21769 if (right_padded
&& rightmost
< cmp
->rbearing
)
21771 rightmost
= cmp
->rbearing
;
21774 cmp
->pixel_width
= rightmost
;
21775 cmp
->ascent
= highest
;
21776 cmp
->descent
= - lowest
;
21777 if (cmp
->ascent
< font_ascent
)
21778 cmp
->ascent
= font_ascent
;
21779 if (cmp
->descent
< font_descent
)
21780 cmp
->descent
= font_descent
;
21784 && (cmp
->lbearing
< 0
21785 || cmp
->rbearing
> cmp
->pixel_width
))
21786 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21788 it
->pixel_width
= cmp
->pixel_width
;
21789 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21790 it
->descent
= it
->phys_descent
= cmp
->descent
;
21791 if (face
->box
!= FACE_NO_BOX
)
21793 int thick
= face
->box_line_width
;
21797 it
->ascent
+= thick
;
21798 it
->descent
+= thick
;
21803 if (it
->start_of_box_run_p
)
21804 it
->pixel_width
+= thick
;
21805 if (it
->end_of_box_run_p
)
21806 it
->pixel_width
+= thick
;
21809 /* If face has an overline, add the height of the overline
21810 (1 pixel) and a 1 pixel margin to the character height. */
21811 if (face
->overline_p
)
21812 it
->ascent
+= overline_margin
;
21814 take_vertical_position_into_account (it
);
21815 if (it
->ascent
< 0)
21817 if (it
->descent
< 0)
21821 append_composite_glyph (it
);
21823 else if (it
->what
== IT_COMPOSITION
)
21825 /* A dynamic (automatic) composition. */
21826 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21827 Lisp_Object gstring
;
21828 struct font_metrics metrics
;
21830 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
21832 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
21835 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
21836 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21837 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
21838 it
->descent
= it
->phys_descent
= metrics
.descent
;
21839 if (face
->box
!= FACE_NO_BOX
)
21841 int thick
= face
->box_line_width
;
21845 it
->ascent
+= thick
;
21846 it
->descent
+= thick
;
21851 if (it
->start_of_box_run_p
)
21852 it
->pixel_width
+= thick
;
21853 if (it
->end_of_box_run_p
)
21854 it
->pixel_width
+= thick
;
21856 /* If face has an overline, add the height of the overline
21857 (1 pixel) and a 1 pixel margin to the character height. */
21858 if (face
->overline_p
)
21859 it
->ascent
+= overline_margin
;
21860 take_vertical_position_into_account (it
);
21861 if (it
->ascent
< 0)
21863 if (it
->descent
< 0)
21867 append_composite_glyph (it
);
21869 else if (it
->what
== IT_IMAGE
)
21870 produce_image_glyph (it
);
21871 else if (it
->what
== IT_STRETCH
)
21872 produce_stretch_glyph (it
);
21874 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21875 because this isn't true for images with `:ascent 100'. */
21876 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21877 if (it
->area
== TEXT_AREA
)
21878 it
->current_x
+= it
->pixel_width
;
21880 if (extra_line_spacing
> 0)
21882 it
->descent
+= extra_line_spacing
;
21883 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21884 it
->max_extra_line_spacing
= extra_line_spacing
;
21887 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21888 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21889 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21890 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21894 Output LEN glyphs starting at START at the nominal cursor position.
21895 Advance the nominal cursor over the text. The global variable
21896 updated_window contains the window being updated, updated_row is
21897 the glyph row being updated, and updated_area is the area of that
21898 row being updated. */
21901 x_write_glyphs (start
, len
)
21902 struct glyph
*start
;
21907 xassert (updated_window
&& updated_row
);
21910 /* Write glyphs. */
21912 hpos
= start
- updated_row
->glyphs
[updated_area
];
21913 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21914 updated_row
, updated_area
,
21916 DRAW_NORMAL_TEXT
, 0);
21918 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21919 if (updated_area
== TEXT_AREA
21920 && updated_window
->phys_cursor_on_p
21921 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21922 && updated_window
->phys_cursor
.hpos
>= hpos
21923 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21924 updated_window
->phys_cursor_on_p
= 0;
21928 /* Advance the output cursor. */
21929 output_cursor
.hpos
+= len
;
21930 output_cursor
.x
= x
;
21935 Insert LEN glyphs from START at the nominal cursor position. */
21938 x_insert_glyphs (start
, len
)
21939 struct glyph
*start
;
21944 int line_height
, shift_by_width
, shifted_region_width
;
21945 struct glyph_row
*row
;
21946 struct glyph
*glyph
;
21947 int frame_x
, frame_y
;
21950 xassert (updated_window
&& updated_row
);
21952 w
= updated_window
;
21953 f
= XFRAME (WINDOW_FRAME (w
));
21955 /* Get the height of the line we are in. */
21957 line_height
= row
->height
;
21959 /* Get the width of the glyphs to insert. */
21960 shift_by_width
= 0;
21961 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21962 shift_by_width
+= glyph
->pixel_width
;
21964 /* Get the width of the region to shift right. */
21965 shifted_region_width
= (window_box_width (w
, updated_area
)
21970 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21971 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21973 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21974 line_height
, shift_by_width
);
21976 /* Write the glyphs. */
21977 hpos
= start
- row
->glyphs
[updated_area
];
21978 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21980 DRAW_NORMAL_TEXT
, 0);
21982 /* Advance the output cursor. */
21983 output_cursor
.hpos
+= len
;
21984 output_cursor
.x
+= shift_by_width
;
21990 Erase the current text line from the nominal cursor position
21991 (inclusive) to pixel column TO_X (exclusive). The idea is that
21992 everything from TO_X onward is already erased.
21994 TO_X is a pixel position relative to updated_area of
21995 updated_window. TO_X == -1 means clear to the end of this area. */
21998 x_clear_end_of_line (to_x
)
22002 struct window
*w
= updated_window
;
22003 int max_x
, min_y
, max_y
;
22004 int from_x
, from_y
, to_y
;
22006 xassert (updated_window
&& updated_row
);
22007 f
= XFRAME (w
->frame
);
22009 if (updated_row
->full_width_p
)
22010 max_x
= WINDOW_TOTAL_WIDTH (w
);
22012 max_x
= window_box_width (w
, updated_area
);
22013 max_y
= window_text_bottom_y (w
);
22015 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22016 of window. For TO_X > 0, truncate to end of drawing area. */
22022 to_x
= min (to_x
, max_x
);
22024 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22026 /* Notice if the cursor will be cleared by this operation. */
22027 if (!updated_row
->full_width_p
)
22028 notice_overwritten_cursor (w
, updated_area
,
22029 output_cursor
.x
, -1,
22031 MATRIX_ROW_BOTTOM_Y (updated_row
));
22033 from_x
= output_cursor
.x
;
22035 /* Translate to frame coordinates. */
22036 if (updated_row
->full_width_p
)
22038 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22039 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22043 int area_left
= window_box_left (w
, updated_area
);
22044 from_x
+= area_left
;
22048 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22049 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22050 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22052 /* Prevent inadvertently clearing to end of the X window. */
22053 if (to_x
> from_x
&& to_y
> from_y
)
22056 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22057 to_x
- from_x
, to_y
- from_y
);
22062 #endif /* HAVE_WINDOW_SYSTEM */
22066 /***********************************************************************
22068 ***********************************************************************/
22070 /* Value is the internal representation of the specified cursor type
22071 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22072 of the bar cursor. */
22074 static enum text_cursor_kinds
22075 get_specified_cursor_type (arg
, width
)
22079 enum text_cursor_kinds type
;
22084 if (EQ (arg
, Qbox
))
22085 return FILLED_BOX_CURSOR
;
22087 if (EQ (arg
, Qhollow
))
22088 return HOLLOW_BOX_CURSOR
;
22090 if (EQ (arg
, Qbar
))
22097 && EQ (XCAR (arg
), Qbar
)
22098 && INTEGERP (XCDR (arg
))
22099 && XINT (XCDR (arg
)) >= 0)
22101 *width
= XINT (XCDR (arg
));
22105 if (EQ (arg
, Qhbar
))
22108 return HBAR_CURSOR
;
22112 && EQ (XCAR (arg
), Qhbar
)
22113 && INTEGERP (XCDR (arg
))
22114 && XINT (XCDR (arg
)) >= 0)
22116 *width
= XINT (XCDR (arg
));
22117 return HBAR_CURSOR
;
22120 /* Treat anything unknown as "hollow box cursor".
22121 It was bad to signal an error; people have trouble fixing
22122 .Xdefaults with Emacs, when it has something bad in it. */
22123 type
= HOLLOW_BOX_CURSOR
;
22128 /* Set the default cursor types for specified frame. */
22130 set_frame_cursor_types (f
, arg
)
22137 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22138 FRAME_CURSOR_WIDTH (f
) = width
;
22140 /* By default, set up the blink-off state depending on the on-state. */
22142 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22145 FRAME_BLINK_OFF_CURSOR (f
)
22146 = get_specified_cursor_type (XCDR (tem
), &width
);
22147 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22150 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22154 /* Return the cursor we want to be displayed in window W. Return
22155 width of bar/hbar cursor through WIDTH arg. Return with
22156 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22157 (i.e. if the `system caret' should track this cursor).
22159 In a mini-buffer window, we want the cursor only to appear if we
22160 are reading input from this window. For the selected window, we
22161 want the cursor type given by the frame parameter or buffer local
22162 setting of cursor-type. If explicitly marked off, draw no cursor.
22163 In all other cases, we want a hollow box cursor. */
22165 static enum text_cursor_kinds
22166 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22168 struct glyph
*glyph
;
22170 int *active_cursor
;
22172 struct frame
*f
= XFRAME (w
->frame
);
22173 struct buffer
*b
= XBUFFER (w
->buffer
);
22174 int cursor_type
= DEFAULT_CURSOR
;
22175 Lisp_Object alt_cursor
;
22176 int non_selected
= 0;
22178 *active_cursor
= 1;
22181 if (cursor_in_echo_area
22182 && FRAME_HAS_MINIBUF_P (f
)
22183 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22185 if (w
== XWINDOW (echo_area_window
))
22187 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22189 *width
= FRAME_CURSOR_WIDTH (f
);
22190 return FRAME_DESIRED_CURSOR (f
);
22193 return get_specified_cursor_type (b
->cursor_type
, width
);
22196 *active_cursor
= 0;
22200 /* Detect a nonselected window or nonselected frame. */
22201 else if (w
!= XWINDOW (f
->selected_window
)
22202 #ifdef HAVE_WINDOW_SYSTEM
22203 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22207 *active_cursor
= 0;
22209 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22215 /* Never display a cursor in a window in which cursor-type is nil. */
22216 if (NILP (b
->cursor_type
))
22219 /* Get the normal cursor type for this window. */
22220 if (EQ (b
->cursor_type
, Qt
))
22222 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22223 *width
= FRAME_CURSOR_WIDTH (f
);
22226 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22228 /* Use cursor-in-non-selected-windows instead
22229 for non-selected window or frame. */
22232 alt_cursor
= b
->cursor_in_non_selected_windows
;
22233 if (!EQ (Qt
, alt_cursor
))
22234 return get_specified_cursor_type (alt_cursor
, width
);
22235 /* t means modify the normal cursor type. */
22236 if (cursor_type
== FILLED_BOX_CURSOR
)
22237 cursor_type
= HOLLOW_BOX_CURSOR
;
22238 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22240 return cursor_type
;
22243 /* Use normal cursor if not blinked off. */
22244 if (!w
->cursor_off_p
)
22246 #ifdef HAVE_WINDOW_SYSTEM
22247 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22249 if (cursor_type
== FILLED_BOX_CURSOR
)
22251 /* Using a block cursor on large images can be very annoying.
22252 So use a hollow cursor for "large" images.
22253 If image is not transparent (no mask), also use hollow cursor. */
22254 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22255 if (img
!= NULL
&& IMAGEP (img
->spec
))
22257 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22258 where N = size of default frame font size.
22259 This should cover most of the "tiny" icons people may use. */
22261 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22262 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22263 cursor_type
= HOLLOW_BOX_CURSOR
;
22266 else if (cursor_type
!= NO_CURSOR
)
22268 /* Display current only supports BOX and HOLLOW cursors for images.
22269 So for now, unconditionally use a HOLLOW cursor when cursor is
22270 not a solid box cursor. */
22271 cursor_type
= HOLLOW_BOX_CURSOR
;
22275 return cursor_type
;
22278 /* Cursor is blinked off, so determine how to "toggle" it. */
22280 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22281 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22282 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22284 /* Then see if frame has specified a specific blink off cursor type. */
22285 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22287 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22288 return FRAME_BLINK_OFF_CURSOR (f
);
22292 /* Some people liked having a permanently visible blinking cursor,
22293 while others had very strong opinions against it. So it was
22294 decided to remove it. KFS 2003-09-03 */
22296 /* Finally perform built-in cursor blinking:
22297 filled box <-> hollow box
22298 wide [h]bar <-> narrow [h]bar
22299 narrow [h]bar <-> no cursor
22300 other type <-> no cursor */
22302 if (cursor_type
== FILLED_BOX_CURSOR
)
22303 return HOLLOW_BOX_CURSOR
;
22305 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22308 return cursor_type
;
22316 #ifdef HAVE_WINDOW_SYSTEM
22318 /* Notice when the text cursor of window W has been completely
22319 overwritten by a drawing operation that outputs glyphs in AREA
22320 starting at X0 and ending at X1 in the line starting at Y0 and
22321 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22322 the rest of the line after X0 has been written. Y coordinates
22323 are window-relative. */
22326 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22328 enum glyph_row_area area
;
22329 int x0
, y0
, x1
, y1
;
22331 int cx0
, cx1
, cy0
, cy1
;
22332 struct glyph_row
*row
;
22334 if (!w
->phys_cursor_on_p
)
22336 if (area
!= TEXT_AREA
)
22339 if (w
->phys_cursor
.vpos
< 0
22340 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22341 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22342 !(row
->enabled_p
&& row
->displays_text_p
)))
22345 if (row
->cursor_in_fringe_p
)
22347 row
->cursor_in_fringe_p
= 0;
22348 draw_fringe_bitmap (w
, row
, 0);
22349 w
->phys_cursor_on_p
= 0;
22353 cx0
= w
->phys_cursor
.x
;
22354 cx1
= cx0
+ w
->phys_cursor_width
;
22355 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22358 /* The cursor image will be completely removed from the
22359 screen if the output area intersects the cursor area in
22360 y-direction. When we draw in [y0 y1[, and some part of
22361 the cursor is at y < y0, that part must have been drawn
22362 before. When scrolling, the cursor is erased before
22363 actually scrolling, so we don't come here. When not
22364 scrolling, the rows above the old cursor row must have
22365 changed, and in this case these rows must have written
22366 over the cursor image.
22368 Likewise if part of the cursor is below y1, with the
22369 exception of the cursor being in the first blank row at
22370 the buffer and window end because update_text_area
22371 doesn't draw that row. (Except when it does, but
22372 that's handled in update_text_area.) */
22374 cy0
= w
->phys_cursor
.y
;
22375 cy1
= cy0
+ w
->phys_cursor_height
;
22376 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22379 w
->phys_cursor_on_p
= 0;
22382 #endif /* HAVE_WINDOW_SYSTEM */
22385 /************************************************************************
22387 ************************************************************************/
22389 #ifdef HAVE_WINDOW_SYSTEM
22392 Fix the display of area AREA of overlapping row ROW in window W
22393 with respect to the overlapping part OVERLAPS. */
22396 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22398 struct glyph_row
*row
;
22399 enum glyph_row_area area
;
22407 for (i
= 0; i
< row
->used
[area
];)
22409 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22411 int start
= i
, start_x
= x
;
22415 x
+= row
->glyphs
[area
][i
].pixel_width
;
22418 while (i
< row
->used
[area
]
22419 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22421 draw_glyphs (w
, start_x
, row
, area
,
22423 DRAW_NORMAL_TEXT
, overlaps
);
22427 x
+= row
->glyphs
[area
][i
].pixel_width
;
22437 Draw the cursor glyph of window W in glyph row ROW. See the
22438 comment of draw_glyphs for the meaning of HL. */
22441 draw_phys_cursor_glyph (w
, row
, hl
)
22443 struct glyph_row
*row
;
22444 enum draw_glyphs_face hl
;
22446 /* If cursor hpos is out of bounds, don't draw garbage. This can
22447 happen in mini-buffer windows when switching between echo area
22448 glyphs and mini-buffer. */
22449 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22451 int on_p
= w
->phys_cursor_on_p
;
22453 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22454 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22456 w
->phys_cursor_on_p
= on_p
;
22458 if (hl
== DRAW_CURSOR
)
22459 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22460 /* When we erase the cursor, and ROW is overlapped by other
22461 rows, make sure that these overlapping parts of other rows
22463 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22465 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22467 if (row
> w
->current_matrix
->rows
22468 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22469 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22470 OVERLAPS_ERASED_CURSOR
);
22472 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22473 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22474 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22475 OVERLAPS_ERASED_CURSOR
);
22482 Erase the image of a cursor of window W from the screen. */
22485 erase_phys_cursor (w
)
22488 struct frame
*f
= XFRAME (w
->frame
);
22489 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22490 int hpos
= w
->phys_cursor
.hpos
;
22491 int vpos
= w
->phys_cursor
.vpos
;
22492 int mouse_face_here_p
= 0;
22493 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22494 struct glyph_row
*cursor_row
;
22495 struct glyph
*cursor_glyph
;
22496 enum draw_glyphs_face hl
;
22498 /* No cursor displayed or row invalidated => nothing to do on the
22500 if (w
->phys_cursor_type
== NO_CURSOR
)
22501 goto mark_cursor_off
;
22503 /* VPOS >= active_glyphs->nrows means that window has been resized.
22504 Don't bother to erase the cursor. */
22505 if (vpos
>= active_glyphs
->nrows
)
22506 goto mark_cursor_off
;
22508 /* If row containing cursor is marked invalid, there is nothing we
22510 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22511 if (!cursor_row
->enabled_p
)
22512 goto mark_cursor_off
;
22514 /* If line spacing is > 0, old cursor may only be partially visible in
22515 window after split-window. So adjust visible height. */
22516 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22517 window_text_bottom_y (w
) - cursor_row
->y
);
22519 /* If row is completely invisible, don't attempt to delete a cursor which
22520 isn't there. This can happen if cursor is at top of a window, and
22521 we switch to a buffer with a header line in that window. */
22522 if (cursor_row
->visible_height
<= 0)
22523 goto mark_cursor_off
;
22525 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22526 if (cursor_row
->cursor_in_fringe_p
)
22528 cursor_row
->cursor_in_fringe_p
= 0;
22529 draw_fringe_bitmap (w
, cursor_row
, 0);
22530 goto mark_cursor_off
;
22533 /* This can happen when the new row is shorter than the old one.
22534 In this case, either draw_glyphs or clear_end_of_line
22535 should have cleared the cursor. Note that we wouldn't be
22536 able to erase the cursor in this case because we don't have a
22537 cursor glyph at hand. */
22538 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22539 goto mark_cursor_off
;
22541 /* If the cursor is in the mouse face area, redisplay that when
22542 we clear the cursor. */
22543 if (! NILP (dpyinfo
->mouse_face_window
)
22544 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22545 && (vpos
> dpyinfo
->mouse_face_beg_row
22546 || (vpos
== dpyinfo
->mouse_face_beg_row
22547 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22548 && (vpos
< dpyinfo
->mouse_face_end_row
22549 || (vpos
== dpyinfo
->mouse_face_end_row
22550 && hpos
< dpyinfo
->mouse_face_end_col
))
22551 /* Don't redraw the cursor's spot in mouse face if it is at the
22552 end of a line (on a newline). The cursor appears there, but
22553 mouse highlighting does not. */
22554 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22555 mouse_face_here_p
= 1;
22557 /* Maybe clear the display under the cursor. */
22558 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22561 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22564 cursor_glyph
= get_phys_cursor_glyph (w
);
22565 if (cursor_glyph
== NULL
)
22566 goto mark_cursor_off
;
22568 width
= cursor_glyph
->pixel_width
;
22569 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22570 x
= w
->phys_cursor
.x
;
22572 width
-= left_x
- x
;
22573 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22574 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22575 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22578 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22581 /* Erase the cursor by redrawing the character underneath it. */
22582 if (mouse_face_here_p
)
22583 hl
= DRAW_MOUSE_FACE
;
22585 hl
= DRAW_NORMAL_TEXT
;
22586 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22589 w
->phys_cursor_on_p
= 0;
22590 w
->phys_cursor_type
= NO_CURSOR
;
22595 Display or clear cursor of window W. If ON is zero, clear the
22596 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22597 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22600 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22602 int on
, hpos
, vpos
, x
, y
;
22604 struct frame
*f
= XFRAME (w
->frame
);
22605 int new_cursor_type
;
22606 int new_cursor_width
;
22608 struct glyph_row
*glyph_row
;
22609 struct glyph
*glyph
;
22611 /* This is pointless on invisible frames, and dangerous on garbaged
22612 windows and frames; in the latter case, the frame or window may
22613 be in the midst of changing its size, and x and y may be off the
22615 if (! FRAME_VISIBLE_P (f
)
22616 || FRAME_GARBAGED_P (f
)
22617 || vpos
>= w
->current_matrix
->nrows
22618 || hpos
>= w
->current_matrix
->matrix_w
)
22621 /* If cursor is off and we want it off, return quickly. */
22622 if (!on
&& !w
->phys_cursor_on_p
)
22625 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22626 /* If cursor row is not enabled, we don't really know where to
22627 display the cursor. */
22628 if (!glyph_row
->enabled_p
)
22630 w
->phys_cursor_on_p
= 0;
22635 if (!glyph_row
->exact_window_width_line_p
22636 || hpos
< glyph_row
->used
[TEXT_AREA
])
22637 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22639 xassert (interrupt_input_blocked
);
22641 /* Set new_cursor_type to the cursor we want to be displayed. */
22642 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22643 &new_cursor_width
, &active_cursor
);
22645 /* If cursor is currently being shown and we don't want it to be or
22646 it is in the wrong place, or the cursor type is not what we want,
22648 if (w
->phys_cursor_on_p
22650 || w
->phys_cursor
.x
!= x
22651 || w
->phys_cursor
.y
!= y
22652 || new_cursor_type
!= w
->phys_cursor_type
22653 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22654 && new_cursor_width
!= w
->phys_cursor_width
)))
22655 erase_phys_cursor (w
);
22657 /* Don't check phys_cursor_on_p here because that flag is only set
22658 to zero in some cases where we know that the cursor has been
22659 completely erased, to avoid the extra work of erasing the cursor
22660 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22661 still not be visible, or it has only been partly erased. */
22664 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22665 w
->phys_cursor_height
= glyph_row
->height
;
22667 /* Set phys_cursor_.* before x_draw_.* is called because some
22668 of them may need the information. */
22669 w
->phys_cursor
.x
= x
;
22670 w
->phys_cursor
.y
= glyph_row
->y
;
22671 w
->phys_cursor
.hpos
= hpos
;
22672 w
->phys_cursor
.vpos
= vpos
;
22675 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22676 new_cursor_type
, new_cursor_width
,
22677 on
, active_cursor
);
22681 /* Switch the display of W's cursor on or off, according to the value
22688 update_window_cursor (w
, on
)
22692 /* Don't update cursor in windows whose frame is in the process
22693 of being deleted. */
22694 if (w
->current_matrix
)
22697 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22698 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22704 /* Call update_window_cursor with parameter ON_P on all leaf windows
22705 in the window tree rooted at W. */
22708 update_cursor_in_window_tree (w
, on_p
)
22714 if (!NILP (w
->hchild
))
22715 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22716 else if (!NILP (w
->vchild
))
22717 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22719 update_window_cursor (w
, on_p
);
22721 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22727 Display the cursor on window W, or clear it, according to ON_P.
22728 Don't change the cursor's position. */
22731 x_update_cursor (f
, on_p
)
22735 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22740 Clear the cursor of window W to background color, and mark the
22741 cursor as not shown. This is used when the text where the cursor
22742 is is about to be rewritten. */
22748 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22749 update_window_cursor (w
, 0);
22754 Display the active region described by mouse_face_* according to DRAW. */
22757 show_mouse_face (dpyinfo
, draw
)
22758 Display_Info
*dpyinfo
;
22759 enum draw_glyphs_face draw
;
22761 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22762 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22764 if (/* If window is in the process of being destroyed, don't bother
22766 w
->current_matrix
!= NULL
22767 /* Don't update mouse highlight if hidden */
22768 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22769 /* Recognize when we are called to operate on rows that don't exist
22770 anymore. This can happen when a window is split. */
22771 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22773 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22774 struct glyph_row
*row
, *first
, *last
;
22776 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22777 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22779 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22781 int start_hpos
, end_hpos
, start_x
;
22783 /* For all but the first row, the highlight starts at column 0. */
22786 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22787 start_x
= dpyinfo
->mouse_face_beg_x
;
22796 end_hpos
= dpyinfo
->mouse_face_end_col
;
22799 end_hpos
= row
->used
[TEXT_AREA
];
22800 if (draw
== DRAW_NORMAL_TEXT
)
22801 row
->fill_line_p
= 1; /* Clear to end of line */
22804 if (end_hpos
> start_hpos
)
22806 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22807 start_hpos
, end_hpos
,
22811 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22815 /* When we've written over the cursor, arrange for it to
22816 be displayed again. */
22817 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22820 display_and_set_cursor (w
, 1,
22821 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22822 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22827 /* Change the mouse cursor. */
22828 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22829 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22830 else if (draw
== DRAW_MOUSE_FACE
)
22831 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22833 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22837 Clear out the mouse-highlighted active region.
22838 Redraw it un-highlighted first. Value is non-zero if mouse
22839 face was actually drawn unhighlighted. */
22842 clear_mouse_face (dpyinfo
)
22843 Display_Info
*dpyinfo
;
22847 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22849 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22853 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22854 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22855 dpyinfo
->mouse_face_window
= Qnil
;
22856 dpyinfo
->mouse_face_overlay
= Qnil
;
22862 Non-zero if physical cursor of window W is within mouse face. */
22865 cursor_in_mouse_face_p (w
)
22868 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22869 int in_mouse_face
= 0;
22871 if (WINDOWP (dpyinfo
->mouse_face_window
)
22872 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22874 int hpos
= w
->phys_cursor
.hpos
;
22875 int vpos
= w
->phys_cursor
.vpos
;
22877 if (vpos
>= dpyinfo
->mouse_face_beg_row
22878 && vpos
<= dpyinfo
->mouse_face_end_row
22879 && (vpos
> dpyinfo
->mouse_face_beg_row
22880 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22881 && (vpos
< dpyinfo
->mouse_face_end_row
22882 || hpos
< dpyinfo
->mouse_face_end_col
22883 || dpyinfo
->mouse_face_past_end
))
22887 return in_mouse_face
;
22893 /* Find the glyph matrix position of buffer position CHARPOS in window
22894 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22895 current glyphs must be up to date. If CHARPOS is above window
22896 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22897 of last line in W. In the row containing CHARPOS, stop before glyphs
22898 having STOP as object. */
22900 #if 1 /* This is a version of fast_find_position that's more correct
22901 in the presence of hscrolling, for example. I didn't install
22902 it right away because the problem fixed is minor, it failed
22903 in 20.x as well, and I think it's too risky to install
22904 so near the release of 21.1. 2001-09-25 gerd. */
22908 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22911 int *hpos
, *vpos
, *x
, *y
;
22914 struct glyph_row
*row
, *first
;
22915 struct glyph
*glyph
, *end
;
22918 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22919 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22924 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22928 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22931 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22935 /* If whole rows or last part of a row came from a display overlay,
22936 row_containing_pos will skip over such rows because their end pos
22937 equals the start pos of the overlay or interval.
22939 Move back if we have a STOP object and previous row's
22940 end glyph came from STOP. */
22943 struct glyph_row
*prev
;
22944 while ((prev
= row
- 1, prev
>= first
)
22945 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22946 && prev
->used
[TEXT_AREA
] > 0)
22948 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22949 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22950 while (--glyph
>= beg
22951 && INTEGERP (glyph
->object
));
22953 || !EQ (stop
, glyph
->object
))
22961 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22963 glyph
= row
->glyphs
[TEXT_AREA
];
22964 end
= glyph
+ row
->used
[TEXT_AREA
];
22966 /* Skip over glyphs not having an object at the start of the row.
22967 These are special glyphs like truncation marks on terminal
22969 if (row
->displays_text_p
)
22971 && INTEGERP (glyph
->object
)
22972 && !EQ (stop
, glyph
->object
)
22973 && glyph
->charpos
< 0)
22975 *x
+= glyph
->pixel_width
;
22980 && !INTEGERP (glyph
->object
)
22981 && !EQ (stop
, glyph
->object
)
22982 && (!BUFFERP (glyph
->object
)
22983 || glyph
->charpos
< charpos
))
22985 *x
+= glyph
->pixel_width
;
22989 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22996 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22999 int *hpos
, *vpos
, *x
, *y
;
23004 int maybe_next_line_p
= 0;
23005 int line_start_position
;
23006 int yb
= window_text_bottom_y (w
);
23007 struct glyph_row
*row
, *best_row
;
23008 int row_vpos
, best_row_vpos
;
23011 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23012 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23014 while (row
->y
< yb
)
23016 if (row
->used
[TEXT_AREA
])
23017 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
23019 line_start_position
= 0;
23021 if (line_start_position
> pos
)
23023 /* If the position sought is the end of the buffer,
23024 don't include the blank lines at the bottom of the window. */
23025 else if (line_start_position
== pos
23026 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
23028 maybe_next_line_p
= 1;
23031 else if (line_start_position
> 0)
23034 best_row_vpos
= row_vpos
;
23037 if (row
->y
+ row
->height
>= yb
)
23044 /* Find the right column within BEST_ROW. */
23046 current_x
= best_row
->x
;
23047 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
23049 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
23050 int charpos
= glyph
->charpos
;
23052 if (BUFFERP (glyph
->object
))
23054 if (charpos
== pos
)
23057 *vpos
= best_row_vpos
;
23062 else if (charpos
> pos
)
23065 else if (EQ (glyph
->object
, stop
))
23070 current_x
+= glyph
->pixel_width
;
23073 /* If we're looking for the end of the buffer,
23074 and we didn't find it in the line we scanned,
23075 use the start of the following line. */
23076 if (maybe_next_line_p
)
23081 current_x
= best_row
->x
;
23084 *vpos
= best_row_vpos
;
23085 *hpos
= lastcol
+ 1;
23094 /* Find the position of the glyph for position POS in OBJECT in
23095 window W's current matrix, and return in *X, *Y the pixel
23096 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23098 RIGHT_P non-zero means return the position of the right edge of the
23099 glyph, RIGHT_P zero means return the left edge position.
23101 If no glyph for POS exists in the matrix, return the position of
23102 the glyph with the next smaller position that is in the matrix, if
23103 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23104 exists in the matrix, return the position of the glyph with the
23105 next larger position in OBJECT.
23107 Value is non-zero if a glyph was found. */
23110 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23113 Lisp_Object object
;
23114 int *hpos
, *vpos
, *x
, *y
;
23117 int yb
= window_text_bottom_y (w
);
23118 struct glyph_row
*r
;
23119 struct glyph
*best_glyph
= NULL
;
23120 struct glyph_row
*best_row
= NULL
;
23123 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23124 r
->enabled_p
&& r
->y
< yb
;
23127 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23128 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23131 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23132 if (EQ (g
->object
, object
))
23134 if (g
->charpos
== pos
)
23141 else if (best_glyph
== NULL
23142 || ((eabs (g
->charpos
- pos
)
23143 < eabs (best_glyph
->charpos
- pos
))
23146 : g
->charpos
> pos
)))
23160 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23164 *x
+= best_glyph
->pixel_width
;
23169 *vpos
= best_row
- w
->current_matrix
->rows
;
23172 return best_glyph
!= NULL
;
23176 /* See if position X, Y is within a hot-spot of an image. */
23179 on_hot_spot_p (hot_spot
, x
, y
)
23180 Lisp_Object hot_spot
;
23183 if (!CONSP (hot_spot
))
23186 if (EQ (XCAR (hot_spot
), Qrect
))
23188 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23189 Lisp_Object rect
= XCDR (hot_spot
);
23193 if (!CONSP (XCAR (rect
)))
23195 if (!CONSP (XCDR (rect
)))
23197 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23199 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23201 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23203 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23207 else if (EQ (XCAR (hot_spot
), Qcircle
))
23209 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23210 Lisp_Object circ
= XCDR (hot_spot
);
23211 Lisp_Object lr
, lx0
, ly0
;
23213 && CONSP (XCAR (circ
))
23214 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23215 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23216 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23218 double r
= XFLOATINT (lr
);
23219 double dx
= XINT (lx0
) - x
;
23220 double dy
= XINT (ly0
) - y
;
23221 return (dx
* dx
+ dy
* dy
<= r
* r
);
23224 else if (EQ (XCAR (hot_spot
), Qpoly
))
23226 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23227 if (VECTORP (XCDR (hot_spot
)))
23229 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23230 Lisp_Object
*poly
= v
->contents
;
23234 Lisp_Object lx
, ly
;
23237 /* Need an even number of coordinates, and at least 3 edges. */
23238 if (n
< 6 || n
& 1)
23241 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23242 If count is odd, we are inside polygon. Pixels on edges
23243 may or may not be included depending on actual geometry of the
23245 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23246 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23248 x0
= XINT (lx
), y0
= XINT (ly
);
23249 for (i
= 0; i
< n
; i
+= 2)
23251 int x1
= x0
, y1
= y0
;
23252 if ((lx
= poly
[i
], !INTEGERP (lx
))
23253 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23255 x0
= XINT (lx
), y0
= XINT (ly
);
23257 /* Does this segment cross the X line? */
23265 if (y
> y0
&& y
> y1
)
23267 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23277 find_hot_spot (map
, x
, y
)
23281 while (CONSP (map
))
23283 if (CONSP (XCAR (map
))
23284 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23292 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23294 doc
: /* Lookup in image map MAP coordinates X and Y.
23295 An image map is an alist where each element has the format (AREA ID PLIST).
23296 An AREA is specified as either a rectangle, a circle, or a polygon:
23297 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23298 pixel coordinates of the upper left and bottom right corners.
23299 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23300 and the radius of the circle; r may be a float or integer.
23301 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23302 vector describes one corner in the polygon.
23303 Returns the alist element for the first matching AREA in MAP. */)
23314 return find_hot_spot (map
, XINT (x
), XINT (y
));
23318 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23320 define_frame_cursor1 (f
, cursor
, pointer
)
23323 Lisp_Object pointer
;
23325 /* Do not change cursor shape while dragging mouse. */
23326 if (!NILP (do_mouse_tracking
))
23329 if (!NILP (pointer
))
23331 if (EQ (pointer
, Qarrow
))
23332 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23333 else if (EQ (pointer
, Qhand
))
23334 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23335 else if (EQ (pointer
, Qtext
))
23336 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23337 else if (EQ (pointer
, intern ("hdrag")))
23338 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23339 #ifdef HAVE_X_WINDOWS
23340 else if (EQ (pointer
, intern ("vdrag")))
23341 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23343 else if (EQ (pointer
, intern ("hourglass")))
23344 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23345 else if (EQ (pointer
, Qmodeline
))
23346 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23348 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23351 if (cursor
!= No_Cursor
)
23352 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23355 /* Take proper action when mouse has moved to the mode or header line
23356 or marginal area AREA of window W, x-position X and y-position Y.
23357 X is relative to the start of the text display area of W, so the
23358 width of bitmap areas and scroll bars must be subtracted to get a
23359 position relative to the start of the mode line. */
23362 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23363 Lisp_Object window
;
23365 enum window_part area
;
23367 struct window
*w
= XWINDOW (window
);
23368 struct frame
*f
= XFRAME (w
->frame
);
23369 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23370 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23371 Lisp_Object pointer
= Qnil
;
23372 int charpos
, dx
, dy
, width
, height
;
23373 Lisp_Object string
, object
= Qnil
;
23374 Lisp_Object pos
, help
;
23376 Lisp_Object mouse_face
;
23377 int original_x_pixel
= x
;
23378 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23379 struct glyph_row
*row
;
23381 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23386 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23387 &object
, &dx
, &dy
, &width
, &height
);
23389 row
= (area
== ON_MODE_LINE
23390 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23391 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23394 if (row
->mode_line_p
&& row
->enabled_p
)
23396 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23397 end
= glyph
+ row
->used
[TEXT_AREA
];
23399 for (x0
= original_x_pixel
;
23400 glyph
< end
&& x0
>= glyph
->pixel_width
;
23402 x0
-= glyph
->pixel_width
;
23410 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23411 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23412 &object
, &dx
, &dy
, &width
, &height
);
23417 if (IMAGEP (object
))
23419 Lisp_Object image_map
, hotspot
;
23420 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23422 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23424 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23426 Lisp_Object area_id
, plist
;
23428 area_id
= XCAR (hotspot
);
23429 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23430 If so, we could look for mouse-enter, mouse-leave
23431 properties in PLIST (and do something...). */
23432 hotspot
= XCDR (hotspot
);
23433 if (CONSP (hotspot
)
23434 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23436 pointer
= Fplist_get (plist
, Qpointer
);
23437 if (NILP (pointer
))
23439 help
= Fplist_get (plist
, Qhelp_echo
);
23442 help_echo_string
= help
;
23443 /* Is this correct? ++kfs */
23444 XSETWINDOW (help_echo_window
, w
);
23445 help_echo_object
= w
->buffer
;
23446 help_echo_pos
= charpos
;
23450 if (NILP (pointer
))
23451 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23454 if (STRINGP (string
))
23456 pos
= make_number (charpos
);
23457 /* If we're on a string with `help-echo' text property, arrange
23458 for the help to be displayed. This is done by setting the
23459 global variable help_echo_string to the help string. */
23462 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23465 help_echo_string
= help
;
23466 XSETWINDOW (help_echo_window
, w
);
23467 help_echo_object
= string
;
23468 help_echo_pos
= charpos
;
23472 if (NILP (pointer
))
23473 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23475 /* Change the mouse pointer according to what is under X/Y. */
23476 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23479 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23480 if (!KEYMAPP (map
))
23481 map
= Fget_text_property (pos
, Qkeymap
, string
);
23482 if (!KEYMAPP (map
))
23483 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23486 /* Change the mouse face according to what is under X/Y. */
23487 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23488 if (!NILP (mouse_face
)
23489 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23494 struct glyph
* tmp_glyph
;
23498 int total_pixel_width
;
23503 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23504 Qmouse_face
, string
, Qnil
);
23506 b
= make_number (0);
23508 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23510 e
= make_number (SCHARS (string
));
23512 /* Calculate the position(glyph position: GPOS) of GLYPH in
23513 displayed string. GPOS is different from CHARPOS.
23515 CHARPOS is the position of glyph in internal string
23516 object. A mode line string format has structures which
23517 is converted to a flatten by emacs lisp interpreter.
23518 The internal string is an element of the structures.
23519 The displayed string is the flatten string. */
23521 if (glyph
> row_start_glyph
)
23523 tmp_glyph
= glyph
- 1;
23524 while (tmp_glyph
>= row_start_glyph
23525 && tmp_glyph
->charpos
>= XINT (b
)
23526 && EQ (tmp_glyph
->object
, glyph
->object
))
23533 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23534 displayed string holding GLYPH.
23536 GSEQ_LENGTH is different from SCHARS (STRING).
23537 SCHARS (STRING) returns the length of the internal string. */
23538 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23539 tmp_glyph
->charpos
< XINT (e
);
23540 tmp_glyph
++, gseq_length
++)
23542 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23546 total_pixel_width
= 0;
23547 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23548 total_pixel_width
+= tmp_glyph
->pixel_width
;
23550 /* Pre calculation of re-rendering position */
23552 hpos
= (area
== ON_MODE_LINE
23553 ? (w
->current_matrix
)->nrows
- 1
23556 /* If the re-rendering position is included in the last
23557 re-rendering area, we should do nothing. */
23558 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23559 && dpyinfo
->mouse_face_beg_col
<= vpos
23560 && vpos
< dpyinfo
->mouse_face_end_col
23561 && dpyinfo
->mouse_face_beg_row
== hpos
)
23564 if (clear_mouse_face (dpyinfo
))
23565 cursor
= No_Cursor
;
23567 dpyinfo
->mouse_face_beg_col
= vpos
;
23568 dpyinfo
->mouse_face_beg_row
= hpos
;
23570 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23571 dpyinfo
->mouse_face_beg_y
= 0;
23573 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23574 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23576 dpyinfo
->mouse_face_end_x
= 0;
23577 dpyinfo
->mouse_face_end_y
= 0;
23579 dpyinfo
->mouse_face_past_end
= 0;
23580 dpyinfo
->mouse_face_window
= window
;
23582 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23585 glyph
->face_id
, 1);
23586 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23588 if (NILP (pointer
))
23591 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23592 clear_mouse_face (dpyinfo
);
23594 define_frame_cursor1 (f
, cursor
, pointer
);
23599 Take proper action when the mouse has moved to position X, Y on
23600 frame F as regards highlighting characters that have mouse-face
23601 properties. Also de-highlighting chars where the mouse was before.
23602 X and Y can be negative or out of range. */
23605 note_mouse_highlight (f
, x
, y
)
23609 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23610 enum window_part part
;
23611 Lisp_Object window
;
23613 Cursor cursor
= No_Cursor
;
23614 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23617 /* When a menu is active, don't highlight because this looks odd. */
23618 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
23619 if (popup_activated ())
23623 if (NILP (Vmouse_highlight
)
23624 || !f
->glyphs_initialized_p
)
23627 dpyinfo
->mouse_face_mouse_x
= x
;
23628 dpyinfo
->mouse_face_mouse_y
= y
;
23629 dpyinfo
->mouse_face_mouse_frame
= f
;
23631 if (dpyinfo
->mouse_face_defer
)
23634 if (gc_in_progress
)
23636 dpyinfo
->mouse_face_deferred_gc
= 1;
23640 /* Which window is that in? */
23641 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23643 /* If we were displaying active text in another window, clear that.
23644 Also clear if we move out of text area in same window. */
23645 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23646 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23647 && !NILP (dpyinfo
->mouse_face_window
)))
23648 clear_mouse_face (dpyinfo
);
23650 /* Not on a window -> return. */
23651 if (!WINDOWP (window
))
23654 /* Reset help_echo_string. It will get recomputed below. */
23655 help_echo_string
= Qnil
;
23657 /* Convert to window-relative pixel coordinates. */
23658 w
= XWINDOW (window
);
23659 frame_to_window_pixel_xy (w
, &x
, &y
);
23661 /* Handle tool-bar window differently since it doesn't display a
23663 if (EQ (window
, f
->tool_bar_window
))
23665 note_tool_bar_highlight (f
, x
, y
);
23669 /* Mouse is on the mode, header line or margin? */
23670 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23671 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23673 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23677 if (part
== ON_VERTICAL_BORDER
)
23679 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23680 help_echo_string
= build_string ("drag-mouse-1: resize");
23682 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23683 || part
== ON_SCROLL_BAR
)
23684 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23686 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23688 /* Are we in a window whose display is up to date?
23689 And verify the buffer's text has not changed. */
23690 b
= XBUFFER (w
->buffer
);
23691 if (part
== ON_TEXT
23692 && EQ (w
->window_end_valid
, w
->buffer
)
23693 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23694 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23696 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23697 struct glyph
*glyph
;
23698 Lisp_Object object
;
23699 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23700 Lisp_Object
*overlay_vec
= NULL
;
23702 struct buffer
*obuf
;
23703 int obegv
, ozv
, same_region
;
23705 /* Find the glyph under X/Y. */
23706 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23708 /* Look for :pointer property on image. */
23709 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23711 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23712 if (img
!= NULL
&& IMAGEP (img
->spec
))
23714 Lisp_Object image_map
, hotspot
;
23715 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23717 && (hotspot
= find_hot_spot (image_map
,
23718 glyph
->slice
.x
+ dx
,
23719 glyph
->slice
.y
+ dy
),
23721 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23723 Lisp_Object area_id
, plist
;
23725 area_id
= XCAR (hotspot
);
23726 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23727 If so, we could look for mouse-enter, mouse-leave
23728 properties in PLIST (and do something...). */
23729 hotspot
= XCDR (hotspot
);
23730 if (CONSP (hotspot
)
23731 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23733 pointer
= Fplist_get (plist
, Qpointer
);
23734 if (NILP (pointer
))
23736 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23737 if (!NILP (help_echo_string
))
23739 help_echo_window
= window
;
23740 help_echo_object
= glyph
->object
;
23741 help_echo_pos
= glyph
->charpos
;
23745 if (NILP (pointer
))
23746 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23750 /* Clear mouse face if X/Y not over text. */
23752 || area
!= TEXT_AREA
23753 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23755 if (clear_mouse_face (dpyinfo
))
23756 cursor
= No_Cursor
;
23757 if (NILP (pointer
))
23759 if (area
!= TEXT_AREA
)
23760 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23762 pointer
= Vvoid_text_area_pointer
;
23767 pos
= glyph
->charpos
;
23768 object
= glyph
->object
;
23769 if (!STRINGP (object
) && !BUFFERP (object
))
23772 /* If we get an out-of-range value, return now; avoid an error. */
23773 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23776 /* Make the window's buffer temporarily current for
23777 overlays_at and compute_char_face. */
23778 obuf
= current_buffer
;
23779 current_buffer
= b
;
23785 /* Is this char mouse-active or does it have help-echo? */
23786 position
= make_number (pos
);
23788 if (BUFFERP (object
))
23790 /* Put all the overlays we want in a vector in overlay_vec. */
23791 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23792 /* Sort overlays into increasing priority order. */
23793 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23798 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23799 && vpos
>= dpyinfo
->mouse_face_beg_row
23800 && vpos
<= dpyinfo
->mouse_face_end_row
23801 && (vpos
> dpyinfo
->mouse_face_beg_row
23802 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23803 && (vpos
< dpyinfo
->mouse_face_end_row
23804 || hpos
< dpyinfo
->mouse_face_end_col
23805 || dpyinfo
->mouse_face_past_end
));
23808 cursor
= No_Cursor
;
23810 /* Check mouse-face highlighting. */
23812 /* If there exists an overlay with mouse-face overlapping
23813 the one we are currently highlighting, we have to
23814 check if we enter the overlapping overlay, and then
23815 highlight only that. */
23816 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23817 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23819 /* Find the highest priority overlay that has a mouse-face
23822 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23824 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23825 if (!NILP (mouse_face
))
23826 overlay
= overlay_vec
[i
];
23829 /* If we're actually highlighting the same overlay as
23830 before, there's no need to do that again. */
23831 if (!NILP (overlay
)
23832 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23833 goto check_help_echo
;
23835 dpyinfo
->mouse_face_overlay
= overlay
;
23837 /* Clear the display of the old active region, if any. */
23838 if (clear_mouse_face (dpyinfo
))
23839 cursor
= No_Cursor
;
23841 /* If no overlay applies, get a text property. */
23842 if (NILP (overlay
))
23843 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23845 /* Handle the overlay case. */
23846 if (!NILP (overlay
))
23848 /* Find the range of text around this char that
23849 should be active. */
23850 Lisp_Object before
, after
;
23853 before
= Foverlay_start (overlay
);
23854 after
= Foverlay_end (overlay
);
23855 /* Record this as the current active region. */
23856 fast_find_position (w
, XFASTINT (before
),
23857 &dpyinfo
->mouse_face_beg_col
,
23858 &dpyinfo
->mouse_face_beg_row
,
23859 &dpyinfo
->mouse_face_beg_x
,
23860 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23862 dpyinfo
->mouse_face_past_end
23863 = !fast_find_position (w
, XFASTINT (after
),
23864 &dpyinfo
->mouse_face_end_col
,
23865 &dpyinfo
->mouse_face_end_row
,
23866 &dpyinfo
->mouse_face_end_x
,
23867 &dpyinfo
->mouse_face_end_y
, Qnil
);
23868 dpyinfo
->mouse_face_window
= window
;
23870 dpyinfo
->mouse_face_face_id
23871 = face_at_buffer_position (w
, pos
, 0, 0,
23873 !dpyinfo
->mouse_face_hidden
);
23875 /* Display it as active. */
23876 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23877 cursor
= No_Cursor
;
23879 /* Handle the text property case. */
23880 else if (!NILP (mouse_face
) && BUFFERP (object
))
23882 /* Find the range of text around this char that
23883 should be active. */
23884 Lisp_Object before
, after
, beginning
, end
;
23887 beginning
= Fmarker_position (w
->start
);
23888 end
= make_number (BUF_Z (XBUFFER (object
))
23889 - XFASTINT (w
->window_end_pos
));
23891 = Fprevious_single_property_change (make_number (pos
+ 1),
23893 object
, beginning
);
23895 = Fnext_single_property_change (position
, Qmouse_face
,
23898 /* Record this as the current active region. */
23899 fast_find_position (w
, XFASTINT (before
),
23900 &dpyinfo
->mouse_face_beg_col
,
23901 &dpyinfo
->mouse_face_beg_row
,
23902 &dpyinfo
->mouse_face_beg_x
,
23903 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23904 dpyinfo
->mouse_face_past_end
23905 = !fast_find_position (w
, XFASTINT (after
),
23906 &dpyinfo
->mouse_face_end_col
,
23907 &dpyinfo
->mouse_face_end_row
,
23908 &dpyinfo
->mouse_face_end_x
,
23909 &dpyinfo
->mouse_face_end_y
, Qnil
);
23910 dpyinfo
->mouse_face_window
= window
;
23912 if (BUFFERP (object
))
23913 dpyinfo
->mouse_face_face_id
23914 = face_at_buffer_position (w
, pos
, 0, 0,
23916 !dpyinfo
->mouse_face_hidden
);
23918 /* Display it as active. */
23919 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23920 cursor
= No_Cursor
;
23922 else if (!NILP (mouse_face
) && STRINGP (object
))
23927 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23930 e
= Fnext_single_property_change (position
, Qmouse_face
,
23933 b
= make_number (0);
23935 e
= make_number (SCHARS (object
) - 1);
23937 fast_find_string_pos (w
, XINT (b
), object
,
23938 &dpyinfo
->mouse_face_beg_col
,
23939 &dpyinfo
->mouse_face_beg_row
,
23940 &dpyinfo
->mouse_face_beg_x
,
23941 &dpyinfo
->mouse_face_beg_y
, 0);
23942 fast_find_string_pos (w
, XINT (e
), object
,
23943 &dpyinfo
->mouse_face_end_col
,
23944 &dpyinfo
->mouse_face_end_row
,
23945 &dpyinfo
->mouse_face_end_x
,
23946 &dpyinfo
->mouse_face_end_y
, 1);
23947 dpyinfo
->mouse_face_past_end
= 0;
23948 dpyinfo
->mouse_face_window
= window
;
23949 dpyinfo
->mouse_face_face_id
23950 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23951 glyph
->face_id
, 1);
23952 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23953 cursor
= No_Cursor
;
23955 else if (STRINGP (object
) && NILP (mouse_face
))
23957 /* A string which doesn't have mouse-face, but
23958 the text ``under'' it might have. */
23959 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23960 int start
= MATRIX_ROW_START_CHARPOS (r
);
23962 pos
= string_buffer_position (w
, object
, start
);
23964 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23968 if (!NILP (mouse_face
) && !NILP (overlay
))
23970 Lisp_Object before
= Foverlay_start (overlay
);
23971 Lisp_Object after
= Foverlay_end (overlay
);
23974 /* Note that we might not be able to find position
23975 BEFORE in the glyph matrix if the overlay is
23976 entirely covered by a `display' property. In
23977 this case, we overshoot. So let's stop in
23978 the glyph matrix before glyphs for OBJECT. */
23979 fast_find_position (w
, XFASTINT (before
),
23980 &dpyinfo
->mouse_face_beg_col
,
23981 &dpyinfo
->mouse_face_beg_row
,
23982 &dpyinfo
->mouse_face_beg_x
,
23983 &dpyinfo
->mouse_face_beg_y
,
23986 dpyinfo
->mouse_face_past_end
23987 = !fast_find_position (w
, XFASTINT (after
),
23988 &dpyinfo
->mouse_face_end_col
,
23989 &dpyinfo
->mouse_face_end_row
,
23990 &dpyinfo
->mouse_face_end_x
,
23991 &dpyinfo
->mouse_face_end_y
,
23993 dpyinfo
->mouse_face_window
= window
;
23994 dpyinfo
->mouse_face_face_id
23995 = face_at_buffer_position (w
, pos
, 0, 0,
23997 !dpyinfo
->mouse_face_hidden
);
23999 /* Display it as active. */
24000 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24001 cursor
= No_Cursor
;
24008 /* Look for a `help-echo' property. */
24009 if (NILP (help_echo_string
)) {
24010 Lisp_Object help
, overlay
;
24012 /* Check overlays first. */
24013 help
= overlay
= Qnil
;
24014 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24016 overlay
= overlay_vec
[i
];
24017 help
= Foverlay_get (overlay
, Qhelp_echo
);
24022 help_echo_string
= help
;
24023 help_echo_window
= window
;
24024 help_echo_object
= overlay
;
24025 help_echo_pos
= pos
;
24029 Lisp_Object object
= glyph
->object
;
24030 int charpos
= glyph
->charpos
;
24032 /* Try text properties. */
24033 if (STRINGP (object
)
24035 && charpos
< SCHARS (object
))
24037 help
= Fget_text_property (make_number (charpos
),
24038 Qhelp_echo
, object
);
24041 /* If the string itself doesn't specify a help-echo,
24042 see if the buffer text ``under'' it does. */
24043 struct glyph_row
*r
24044 = MATRIX_ROW (w
->current_matrix
, vpos
);
24045 int start
= MATRIX_ROW_START_CHARPOS (r
);
24046 int pos
= string_buffer_position (w
, object
, start
);
24049 help
= Fget_char_property (make_number (pos
),
24050 Qhelp_echo
, w
->buffer
);
24054 object
= w
->buffer
;
24059 else if (BUFFERP (object
)
24062 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24067 help_echo_string
= help
;
24068 help_echo_window
= window
;
24069 help_echo_object
= object
;
24070 help_echo_pos
= charpos
;
24075 /* Look for a `pointer' property. */
24076 if (NILP (pointer
))
24078 /* Check overlays first. */
24079 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24080 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24082 if (NILP (pointer
))
24084 Lisp_Object object
= glyph
->object
;
24085 int charpos
= glyph
->charpos
;
24087 /* Try text properties. */
24088 if (STRINGP (object
)
24090 && charpos
< SCHARS (object
))
24092 pointer
= Fget_text_property (make_number (charpos
),
24094 if (NILP (pointer
))
24096 /* If the string itself doesn't specify a pointer,
24097 see if the buffer text ``under'' it does. */
24098 struct glyph_row
*r
24099 = MATRIX_ROW (w
->current_matrix
, vpos
);
24100 int start
= MATRIX_ROW_START_CHARPOS (r
);
24101 int pos
= string_buffer_position (w
, object
, start
);
24103 pointer
= Fget_char_property (make_number (pos
),
24104 Qpointer
, w
->buffer
);
24107 else if (BUFFERP (object
)
24110 pointer
= Fget_text_property (make_number (charpos
),
24117 current_buffer
= obuf
;
24122 define_frame_cursor1 (f
, cursor
, pointer
);
24127 Clear any mouse-face on window W. This function is part of the
24128 redisplay interface, and is called from try_window_id and similar
24129 functions to ensure the mouse-highlight is off. */
24132 x_clear_window_mouse_face (w
)
24135 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24136 Lisp_Object window
;
24139 XSETWINDOW (window
, w
);
24140 if (EQ (window
, dpyinfo
->mouse_face_window
))
24141 clear_mouse_face (dpyinfo
);
24147 Just discard the mouse face information for frame F, if any.
24148 This is used when the size of F is changed. */
24151 cancel_mouse_face (f
)
24154 Lisp_Object window
;
24155 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24157 window
= dpyinfo
->mouse_face_window
;
24158 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24160 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24161 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24162 dpyinfo
->mouse_face_window
= Qnil
;
24167 #endif /* HAVE_WINDOW_SYSTEM */
24170 /***********************************************************************
24172 ***********************************************************************/
24174 #ifdef HAVE_WINDOW_SYSTEM
24176 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24177 which intersects rectangle R. R is in window-relative coordinates. */
24180 expose_area (w
, row
, r
, area
)
24182 struct glyph_row
*row
;
24184 enum glyph_row_area area
;
24186 struct glyph
*first
= row
->glyphs
[area
];
24187 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24188 struct glyph
*last
;
24189 int first_x
, start_x
, x
;
24191 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24192 /* If row extends face to end of line write the whole line. */
24193 draw_glyphs (w
, 0, row
, area
,
24194 0, row
->used
[area
],
24195 DRAW_NORMAL_TEXT
, 0);
24198 /* Set START_X to the window-relative start position for drawing glyphs of
24199 AREA. The first glyph of the text area can be partially visible.
24200 The first glyphs of other areas cannot. */
24201 start_x
= window_box_left_offset (w
, area
);
24203 if (area
== TEXT_AREA
)
24206 /* Find the first glyph that must be redrawn. */
24208 && x
+ first
->pixel_width
< r
->x
)
24210 x
+= first
->pixel_width
;
24214 /* Find the last one. */
24218 && x
< r
->x
+ r
->width
)
24220 x
+= last
->pixel_width
;
24226 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24227 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24228 DRAW_NORMAL_TEXT
, 0);
24233 /* Redraw the parts of the glyph row ROW on window W intersecting
24234 rectangle R. R is in window-relative coordinates. Value is
24235 non-zero if mouse-face was overwritten. */
24238 expose_line (w
, row
, r
)
24240 struct glyph_row
*row
;
24243 xassert (row
->enabled_p
);
24245 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24246 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24247 0, row
->used
[TEXT_AREA
],
24248 DRAW_NORMAL_TEXT
, 0);
24251 if (row
->used
[LEFT_MARGIN_AREA
])
24252 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24253 if (row
->used
[TEXT_AREA
])
24254 expose_area (w
, row
, r
, TEXT_AREA
);
24255 if (row
->used
[RIGHT_MARGIN_AREA
])
24256 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24257 draw_row_fringe_bitmaps (w
, row
);
24260 return row
->mouse_face_p
;
24264 /* Redraw those parts of glyphs rows during expose event handling that
24265 overlap other rows. Redrawing of an exposed line writes over parts
24266 of lines overlapping that exposed line; this function fixes that.
24268 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24269 row in W's current matrix that is exposed and overlaps other rows.
24270 LAST_OVERLAPPING_ROW is the last such row. */
24273 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24275 struct glyph_row
*first_overlapping_row
;
24276 struct glyph_row
*last_overlapping_row
;
24279 struct glyph_row
*row
;
24281 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24282 if (row
->overlapping_p
)
24284 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24287 if (row
->used
[LEFT_MARGIN_AREA
])
24288 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24290 if (row
->used
[TEXT_AREA
])
24291 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24293 if (row
->used
[RIGHT_MARGIN_AREA
])
24294 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24300 /* Return non-zero if W's cursor intersects rectangle R. */
24303 phys_cursor_in_rect_p (w
, r
)
24307 XRectangle cr
, result
;
24308 struct glyph
*cursor_glyph
;
24309 struct glyph_row
*row
;
24311 if (w
->phys_cursor
.vpos
>= 0
24312 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24313 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24315 && row
->cursor_in_fringe_p
)
24317 /* Cursor is in the fringe. */
24318 cr
.x
= window_box_right_offset (w
,
24319 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24320 ? RIGHT_MARGIN_AREA
24323 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24324 cr
.height
= row
->height
;
24325 return x_intersect_rectangles (&cr
, r
, &result
);
24328 cursor_glyph
= get_phys_cursor_glyph (w
);
24331 /* r is relative to W's box, but w->phys_cursor.x is relative
24332 to left edge of W's TEXT area. Adjust it. */
24333 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24334 cr
.y
= w
->phys_cursor
.y
;
24335 cr
.width
= cursor_glyph
->pixel_width
;
24336 cr
.height
= w
->phys_cursor_height
;
24337 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24338 I assume the effect is the same -- and this is portable. */
24339 return x_intersect_rectangles (&cr
, r
, &result
);
24341 /* If we don't understand the format, pretend we're not in the hot-spot. */
24347 Draw a vertical window border to the right of window W if W doesn't
24348 have vertical scroll bars. */
24351 x_draw_vertical_border (w
)
24354 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24356 /* We could do better, if we knew what type of scroll-bar the adjacent
24357 windows (on either side) have... But we don't :-(
24358 However, I think this works ok. ++KFS 2003-04-25 */
24360 /* Redraw borders between horizontally adjacent windows. Don't
24361 do it for frames with vertical scroll bars because either the
24362 right scroll bar of a window, or the left scroll bar of its
24363 neighbor will suffice as a border. */
24364 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24367 if (!WINDOW_RIGHTMOST_P (w
)
24368 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24370 int x0
, x1
, y0
, y1
;
24372 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24375 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24378 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24380 else if (!WINDOW_LEFTMOST_P (w
)
24381 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24383 int x0
, x1
, y0
, y1
;
24385 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24388 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24391 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24396 /* Redraw the part of window W intersection rectangle FR. Pixel
24397 coordinates in FR are frame-relative. Call this function with
24398 input blocked. Value is non-zero if the exposure overwrites
24402 expose_window (w
, fr
)
24406 struct frame
*f
= XFRAME (w
->frame
);
24408 int mouse_face_overwritten_p
= 0;
24410 /* If window is not yet fully initialized, do nothing. This can
24411 happen when toolkit scroll bars are used and a window is split.
24412 Reconfiguring the scroll bar will generate an expose for a newly
24414 if (w
->current_matrix
== NULL
)
24417 /* When we're currently updating the window, display and current
24418 matrix usually don't agree. Arrange for a thorough display
24420 if (w
== updated_window
)
24422 SET_FRAME_GARBAGED (f
);
24426 /* Frame-relative pixel rectangle of W. */
24427 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24428 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24429 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24430 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24432 if (x_intersect_rectangles (fr
, &wr
, &r
))
24434 int yb
= window_text_bottom_y (w
);
24435 struct glyph_row
*row
;
24436 int cursor_cleared_p
;
24437 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24439 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24440 r
.x
, r
.y
, r
.width
, r
.height
));
24442 /* Convert to window coordinates. */
24443 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24444 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24446 /* Turn off the cursor. */
24447 if (!w
->pseudo_window_p
24448 && phys_cursor_in_rect_p (w
, &r
))
24450 x_clear_cursor (w
);
24451 cursor_cleared_p
= 1;
24454 cursor_cleared_p
= 0;
24456 /* Update lines intersecting rectangle R. */
24457 first_overlapping_row
= last_overlapping_row
= NULL
;
24458 for (row
= w
->current_matrix
->rows
;
24463 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24465 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24466 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24467 || (r
.y
>= y0
&& r
.y
< y1
)
24468 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24470 /* A header line may be overlapping, but there is no need
24471 to fix overlapping areas for them. KFS 2005-02-12 */
24472 if (row
->overlapping_p
&& !row
->mode_line_p
)
24474 if (first_overlapping_row
== NULL
)
24475 first_overlapping_row
= row
;
24476 last_overlapping_row
= row
;
24480 if (expose_line (w
, row
, &r
))
24481 mouse_face_overwritten_p
= 1;
24484 else if (row
->overlapping_p
)
24486 /* We must redraw a row overlapping the exposed area. */
24488 ? y0
+ row
->phys_height
> r
.y
24489 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24491 if (first_overlapping_row
== NULL
)
24492 first_overlapping_row
= row
;
24493 last_overlapping_row
= row
;
24501 /* Display the mode line if there is one. */
24502 if (WINDOW_WANTS_MODELINE_P (w
)
24503 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24505 && row
->y
< r
.y
+ r
.height
)
24507 if (expose_line (w
, row
, &r
))
24508 mouse_face_overwritten_p
= 1;
24511 if (!w
->pseudo_window_p
)
24513 /* Fix the display of overlapping rows. */
24514 if (first_overlapping_row
)
24515 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24518 /* Draw border between windows. */
24519 x_draw_vertical_border (w
);
24521 /* Turn the cursor on again. */
24522 if (cursor_cleared_p
)
24523 update_window_cursor (w
, 1);
24527 return mouse_face_overwritten_p
;
24532 /* Redraw (parts) of all windows in the window tree rooted at W that
24533 intersect R. R contains frame pixel coordinates. Value is
24534 non-zero if the exposure overwrites mouse-face. */
24537 expose_window_tree (w
, r
)
24541 struct frame
*f
= XFRAME (w
->frame
);
24542 int mouse_face_overwritten_p
= 0;
24544 while (w
&& !FRAME_GARBAGED_P (f
))
24546 if (!NILP (w
->hchild
))
24547 mouse_face_overwritten_p
24548 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24549 else if (!NILP (w
->vchild
))
24550 mouse_face_overwritten_p
24551 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24553 mouse_face_overwritten_p
|= expose_window (w
, r
);
24555 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24558 return mouse_face_overwritten_p
;
24563 Redisplay an exposed area of frame F. X and Y are the upper-left
24564 corner of the exposed rectangle. W and H are width and height of
24565 the exposed area. All are pixel values. W or H zero means redraw
24566 the entire frame. */
24569 expose_frame (f
, x
, y
, w
, h
)
24574 int mouse_face_overwritten_p
= 0;
24576 TRACE ((stderr
, "expose_frame "));
24578 /* No need to redraw if frame will be redrawn soon. */
24579 if (FRAME_GARBAGED_P (f
))
24581 TRACE ((stderr
, " garbaged\n"));
24585 /* If basic faces haven't been realized yet, there is no point in
24586 trying to redraw anything. This can happen when we get an expose
24587 event while Emacs is starting, e.g. by moving another window. */
24588 if (FRAME_FACE_CACHE (f
) == NULL
24589 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24591 TRACE ((stderr
, " no faces\n"));
24595 if (w
== 0 || h
== 0)
24598 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24599 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24609 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24610 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24612 if (WINDOWP (f
->tool_bar_window
))
24613 mouse_face_overwritten_p
24614 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24616 #ifdef HAVE_X_WINDOWS
24618 #ifndef USE_X_TOOLKIT
24619 if (WINDOWP (f
->menu_bar_window
))
24620 mouse_face_overwritten_p
24621 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24622 #endif /* not USE_X_TOOLKIT */
24626 /* Some window managers support a focus-follows-mouse style with
24627 delayed raising of frames. Imagine a partially obscured frame,
24628 and moving the mouse into partially obscured mouse-face on that
24629 frame. The visible part of the mouse-face will be highlighted,
24630 then the WM raises the obscured frame. With at least one WM, KDE
24631 2.1, Emacs is not getting any event for the raising of the frame
24632 (even tried with SubstructureRedirectMask), only Expose events.
24633 These expose events will draw text normally, i.e. not
24634 highlighted. Which means we must redo the highlight here.
24635 Subsume it under ``we love X''. --gerd 2001-08-15 */
24636 /* Included in Windows version because Windows most likely does not
24637 do the right thing if any third party tool offers
24638 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24639 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24641 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24642 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24644 int x
= dpyinfo
->mouse_face_mouse_x
;
24645 int y
= dpyinfo
->mouse_face_mouse_y
;
24646 clear_mouse_face (dpyinfo
);
24647 note_mouse_highlight (f
, x
, y
);
24654 Determine the intersection of two rectangles R1 and R2. Return
24655 the intersection in *RESULT. Value is non-zero if RESULT is not
24659 x_intersect_rectangles (r1
, r2
, result
)
24660 XRectangle
*r1
, *r2
, *result
;
24662 XRectangle
*left
, *right
;
24663 XRectangle
*upper
, *lower
;
24664 int intersection_p
= 0;
24666 /* Rearrange so that R1 is the left-most rectangle. */
24668 left
= r1
, right
= r2
;
24670 left
= r2
, right
= r1
;
24672 /* X0 of the intersection is right.x0, if this is inside R1,
24673 otherwise there is no intersection. */
24674 if (right
->x
<= left
->x
+ left
->width
)
24676 result
->x
= right
->x
;
24678 /* The right end of the intersection is the minimum of the
24679 the right ends of left and right. */
24680 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24683 /* Same game for Y. */
24685 upper
= r1
, lower
= r2
;
24687 upper
= r2
, lower
= r1
;
24689 /* The upper end of the intersection is lower.y0, if this is inside
24690 of upper. Otherwise, there is no intersection. */
24691 if (lower
->y
<= upper
->y
+ upper
->height
)
24693 result
->y
= lower
->y
;
24695 /* The lower end of the intersection is the minimum of the lower
24696 ends of upper and lower. */
24697 result
->height
= (min (lower
->y
+ lower
->height
,
24698 upper
->y
+ upper
->height
)
24700 intersection_p
= 1;
24704 return intersection_p
;
24707 #endif /* HAVE_WINDOW_SYSTEM */
24710 /***********************************************************************
24712 ***********************************************************************/
24717 Vwith_echo_area_save_vector
= Qnil
;
24718 staticpro (&Vwith_echo_area_save_vector
);
24720 Vmessage_stack
= Qnil
;
24721 staticpro (&Vmessage_stack
);
24723 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24724 staticpro (&Qinhibit_redisplay
);
24726 message_dolog_marker1
= Fmake_marker ();
24727 staticpro (&message_dolog_marker1
);
24728 message_dolog_marker2
= Fmake_marker ();
24729 staticpro (&message_dolog_marker2
);
24730 message_dolog_marker3
= Fmake_marker ();
24731 staticpro (&message_dolog_marker3
);
24734 defsubr (&Sdump_frame_glyph_matrix
);
24735 defsubr (&Sdump_glyph_matrix
);
24736 defsubr (&Sdump_glyph_row
);
24737 defsubr (&Sdump_tool_bar_row
);
24738 defsubr (&Strace_redisplay
);
24739 defsubr (&Strace_to_stderr
);
24741 #ifdef HAVE_WINDOW_SYSTEM
24742 defsubr (&Stool_bar_lines_needed
);
24743 defsubr (&Slookup_image_map
);
24745 defsubr (&Sformat_mode_line
);
24746 defsubr (&Sinvisible_p
);
24748 staticpro (&Qmenu_bar_update_hook
);
24749 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24751 staticpro (&Qoverriding_terminal_local_map
);
24752 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24754 staticpro (&Qoverriding_local_map
);
24755 Qoverriding_local_map
= intern ("overriding-local-map");
24757 staticpro (&Qwindow_scroll_functions
);
24758 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24760 staticpro (&Qwindow_text_change_functions
);
24761 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24763 staticpro (&Qredisplay_end_trigger_functions
);
24764 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24766 staticpro (&Qinhibit_point_motion_hooks
);
24767 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24769 Qeval
= intern ("eval");
24770 staticpro (&Qeval
);
24772 QCdata
= intern (":data");
24773 staticpro (&QCdata
);
24774 Qdisplay
= intern ("display");
24775 staticpro (&Qdisplay
);
24776 Qspace_width
= intern ("space-width");
24777 staticpro (&Qspace_width
);
24778 Qraise
= intern ("raise");
24779 staticpro (&Qraise
);
24780 Qslice
= intern ("slice");
24781 staticpro (&Qslice
);
24782 Qspace
= intern ("space");
24783 staticpro (&Qspace
);
24784 Qmargin
= intern ("margin");
24785 staticpro (&Qmargin
);
24786 Qpointer
= intern ("pointer");
24787 staticpro (&Qpointer
);
24788 Qleft_margin
= intern ("left-margin");
24789 staticpro (&Qleft_margin
);
24790 Qright_margin
= intern ("right-margin");
24791 staticpro (&Qright_margin
);
24792 Qcenter
= intern ("center");
24793 staticpro (&Qcenter
);
24794 Qline_height
= intern ("line-height");
24795 staticpro (&Qline_height
);
24796 QCalign_to
= intern (":align-to");
24797 staticpro (&QCalign_to
);
24798 QCrelative_width
= intern (":relative-width");
24799 staticpro (&QCrelative_width
);
24800 QCrelative_height
= intern (":relative-height");
24801 staticpro (&QCrelative_height
);
24802 QCeval
= intern (":eval");
24803 staticpro (&QCeval
);
24804 QCpropertize
= intern (":propertize");
24805 staticpro (&QCpropertize
);
24806 QCfile
= intern (":file");
24807 staticpro (&QCfile
);
24808 Qfontified
= intern ("fontified");
24809 staticpro (&Qfontified
);
24810 Qfontification_functions
= intern ("fontification-functions");
24811 staticpro (&Qfontification_functions
);
24812 Qtrailing_whitespace
= intern ("trailing-whitespace");
24813 staticpro (&Qtrailing_whitespace
);
24814 Qescape_glyph
= intern ("escape-glyph");
24815 staticpro (&Qescape_glyph
);
24816 Qnobreak_space
= intern ("nobreak-space");
24817 staticpro (&Qnobreak_space
);
24818 Qimage
= intern ("image");
24819 staticpro (&Qimage
);
24820 QCmap
= intern (":map");
24821 staticpro (&QCmap
);
24822 QCpointer
= intern (":pointer");
24823 staticpro (&QCpointer
);
24824 Qrect
= intern ("rect");
24825 staticpro (&Qrect
);
24826 Qcircle
= intern ("circle");
24827 staticpro (&Qcircle
);
24828 Qpoly
= intern ("poly");
24829 staticpro (&Qpoly
);
24830 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24831 staticpro (&Qmessage_truncate_lines
);
24832 Qgrow_only
= intern ("grow-only");
24833 staticpro (&Qgrow_only
);
24834 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24835 staticpro (&Qinhibit_menubar_update
);
24836 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24837 staticpro (&Qinhibit_eval_during_redisplay
);
24838 Qposition
= intern ("position");
24839 staticpro (&Qposition
);
24840 Qbuffer_position
= intern ("buffer-position");
24841 staticpro (&Qbuffer_position
);
24842 Qobject
= intern ("object");
24843 staticpro (&Qobject
);
24844 Qbar
= intern ("bar");
24846 Qhbar
= intern ("hbar");
24847 staticpro (&Qhbar
);
24848 Qbox
= intern ("box");
24850 Qhollow
= intern ("hollow");
24851 staticpro (&Qhollow
);
24852 Qhand
= intern ("hand");
24853 staticpro (&Qhand
);
24854 Qarrow
= intern ("arrow");
24855 staticpro (&Qarrow
);
24856 Qtext
= intern ("text");
24857 staticpro (&Qtext
);
24858 Qrisky_local_variable
= intern ("risky-local-variable");
24859 staticpro (&Qrisky_local_variable
);
24860 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24861 staticpro (&Qinhibit_free_realized_faces
);
24863 list_of_error
= Fcons (Fcons (intern ("error"),
24864 Fcons (intern ("void-variable"), Qnil
)),
24866 staticpro (&list_of_error
);
24868 Qlast_arrow_position
= intern ("last-arrow-position");
24869 staticpro (&Qlast_arrow_position
);
24870 Qlast_arrow_string
= intern ("last-arrow-string");
24871 staticpro (&Qlast_arrow_string
);
24873 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24874 staticpro (&Qoverlay_arrow_string
);
24875 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24876 staticpro (&Qoverlay_arrow_bitmap
);
24878 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24879 staticpro (&echo_buffer
[0]);
24880 staticpro (&echo_buffer
[1]);
24882 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24883 staticpro (&echo_area_buffer
[0]);
24884 staticpro (&echo_area_buffer
[1]);
24886 Vmessages_buffer_name
= build_string ("*Messages*");
24887 staticpro (&Vmessages_buffer_name
);
24889 mode_line_proptrans_alist
= Qnil
;
24890 staticpro (&mode_line_proptrans_alist
);
24891 mode_line_string_list
= Qnil
;
24892 staticpro (&mode_line_string_list
);
24893 mode_line_string_face
= Qnil
;
24894 staticpro (&mode_line_string_face
);
24895 mode_line_string_face_prop
= Qnil
;
24896 staticpro (&mode_line_string_face_prop
);
24897 Vmode_line_unwind_vector
= Qnil
;
24898 staticpro (&Vmode_line_unwind_vector
);
24900 help_echo_string
= Qnil
;
24901 staticpro (&help_echo_string
);
24902 help_echo_object
= Qnil
;
24903 staticpro (&help_echo_object
);
24904 help_echo_window
= Qnil
;
24905 staticpro (&help_echo_window
);
24906 previous_help_echo_string
= Qnil
;
24907 staticpro (&previous_help_echo_string
);
24908 help_echo_pos
= -1;
24910 #ifdef HAVE_WINDOW_SYSTEM
24911 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24912 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24913 For example, if a block cursor is over a tab, it will be drawn as
24914 wide as that tab on the display. */);
24915 x_stretch_cursor_p
= 0;
24918 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24919 doc
: /* *Non-nil means highlight trailing whitespace.
24920 The face used for trailing whitespace is `trailing-whitespace'. */);
24921 Vshow_trailing_whitespace
= Qnil
;
24923 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24924 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24925 A value of t means highlight the character itself (for nobreak space,
24926 use face `nobreak-space').
24927 A value of nil means no highlighting.
24928 Other values mean display the escape glyph followed by an ordinary
24929 space or ordinary hyphen. */);
24930 Vnobreak_char_display
= Qt
;
24932 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24933 doc
: /* *The pointer shape to show in void text areas.
24934 A value of nil means to show the text pointer. Other options are `arrow',
24935 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24936 Vvoid_text_area_pointer
= Qarrow
;
24938 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24939 doc
: /* Non-nil means don't actually do any redisplay.
24940 This is used for internal purposes. */);
24941 Vinhibit_redisplay
= Qnil
;
24943 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24944 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24945 Vglobal_mode_string
= Qnil
;
24947 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24948 doc
: /* Marker for where to display an arrow on top of the buffer text.
24949 This must be the beginning of a line in order to work.
24950 See also `overlay-arrow-string'. */);
24951 Voverlay_arrow_position
= Qnil
;
24953 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24954 doc
: /* String to display as an arrow in non-window frames.
24955 See also `overlay-arrow-position'. */);
24956 Voverlay_arrow_string
= build_string ("=>");
24958 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24959 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24960 The symbols on this list are examined during redisplay to determine
24961 where to display overlay arrows. */);
24962 Voverlay_arrow_variable_list
24963 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24965 DEFVAR_INT ("scroll-step", &scroll_step
,
24966 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24967 If that fails to bring point back on frame, point is centered instead.
24968 If this is zero, point is always centered after it moves off frame.
24969 If you want scrolling to always be a line at a time, you should set
24970 `scroll-conservatively' to a large value rather than set this to 1. */);
24972 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24973 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24974 If point moves off-screen, redisplay will scroll by up to
24975 `scroll-conservatively' lines in order to bring point just barely
24976 onto the screen again. If that cannot be done, then redisplay
24977 recenters point as usual.
24979 A value of zero means always recenter point if it moves off screen. */);
24980 scroll_conservatively
= 0;
24982 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24983 doc
: /* *Number of lines of margin at the top and bottom of a window.
24984 Recenter the window whenever point gets within this many lines
24985 of the top or bottom of the window. */);
24988 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24989 doc
: /* Pixels per inch value for non-window system displays.
24990 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24991 Vdisplay_pixels_per_inch
= make_float (72.0);
24994 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24997 DEFVAR_LISP ("truncate-partial-width-windows",
24998 &Vtruncate_partial_width_windows
,
24999 doc
: /* Non-nil means truncate lines in windows with less than the frame width.
25000 For an integer value, truncate lines in each window with less than the
25001 full frame width, provided the window width is less than that integer;
25002 otherwise, respect the value of `truncate-lines'.
25004 For any other non-nil value, truncate lines in all windows with
25005 less than the full frame width.
25007 A value of nil means to respect the value of `truncate-lines'.
25009 If `word-wrap' is enabled, you might want to reduce this. */);
25010 Vtruncate_partial_width_windows
= make_number (50);
25012 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25013 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25014 Any other value means to use the appropriate face, `mode-line',
25015 `header-line', or `menu' respectively. */);
25016 mode_line_inverse_video
= 1;
25018 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25019 doc
: /* *Maximum buffer size for which line number should be displayed.
25020 If the buffer is bigger than this, the line number does not appear
25021 in the mode line. A value of nil means no limit. */);
25022 Vline_number_display_limit
= Qnil
;
25024 DEFVAR_INT ("line-number-display-limit-width",
25025 &line_number_display_limit_width
,
25026 doc
: /* *Maximum line width (in characters) for line number display.
25027 If the average length of the lines near point is bigger than this, then the
25028 line number may be omitted from the mode line. */);
25029 line_number_display_limit_width
= 200;
25031 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25032 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25033 highlight_nonselected_windows
= 0;
25035 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25036 doc
: /* Non-nil if more than one frame is visible on this display.
25037 Minibuffer-only frames don't count, but iconified frames do.
25038 This variable is not guaranteed to be accurate except while processing
25039 `frame-title-format' and `icon-title-format'. */);
25041 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25042 doc
: /* Template for displaying the title bar of visible frames.
25043 \(Assuming the window manager supports this feature.)
25045 This variable has the same structure as `mode-line-format', except that
25046 the %c and %l constructs are ignored. It is used only on frames for
25047 which no explicit name has been set \(see `modify-frame-parameters'). */);
25049 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25050 doc
: /* Template for displaying the title bar of an iconified frame.
25051 \(Assuming the window manager supports this feature.)
25052 This variable has the same structure as `mode-line-format' (which see),
25053 and is used only on frames for which no explicit name has been set
25054 \(see `modify-frame-parameters'). */);
25056 = Vframe_title_format
25057 = Fcons (intern ("multiple-frames"),
25058 Fcons (build_string ("%b"),
25059 Fcons (Fcons (empty_unibyte_string
,
25060 Fcons (intern ("invocation-name"),
25061 Fcons (build_string ("@"),
25062 Fcons (intern ("system-name"),
25066 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25067 doc
: /* Maximum number of lines to keep in the message log buffer.
25068 If nil, disable message logging. If t, log messages but don't truncate
25069 the buffer when it becomes large. */);
25070 Vmessage_log_max
= make_number (100);
25072 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25073 doc
: /* Functions called before redisplay, if window sizes have changed.
25074 The value should be a list of functions that take one argument.
25075 Just before redisplay, for each frame, if any of its windows have changed
25076 size since the last redisplay, or have been split or deleted,
25077 all the functions in the list are called, with the frame as argument. */);
25078 Vwindow_size_change_functions
= Qnil
;
25080 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25081 doc
: /* List of functions to call before redisplaying a window with scrolling.
25082 Each function is called with two arguments, the window
25083 and its new display-start position. Note that the value of `window-end'
25084 is not valid when these functions are called. */);
25085 Vwindow_scroll_functions
= Qnil
;
25087 DEFVAR_LISP ("window-text-change-functions",
25088 &Vwindow_text_change_functions
,
25089 doc
: /* Functions to call in redisplay when text in the window might change. */);
25090 Vwindow_text_change_functions
= Qnil
;
25092 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25093 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25094 Each function is called with two arguments, the window and the end trigger value.
25095 See `set-window-redisplay-end-trigger'. */);
25096 Vredisplay_end_trigger_functions
= Qnil
;
25098 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25099 doc
: /* *Non-nil means autoselect window with mouse pointer.
25100 If nil, do not autoselect windows.
25101 A positive number means delay autoselection by that many seconds: a
25102 window is autoselected only after the mouse has remained in that
25103 window for the duration of the delay.
25104 A negative number has a similar effect, but causes windows to be
25105 autoselected only after the mouse has stopped moving. \(Because of
25106 the way Emacs compares mouse events, you will occasionally wait twice
25107 that time before the window gets selected.\)
25108 Any other value means to autoselect window instantaneously when the
25109 mouse pointer enters it.
25111 Autoselection selects the minibuffer only if it is active, and never
25112 unselects the minibuffer if it is active.
25114 When customizing this variable make sure that the actual value of
25115 `focus-follows-mouse' matches the behavior of your window manager. */);
25116 Vmouse_autoselect_window
= Qnil
;
25118 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25119 doc
: /* *Non-nil means automatically resize tool-bars.
25120 This dynamically changes the tool-bar's height to the minimum height
25121 that is needed to make all tool-bar items visible.
25122 If value is `grow-only', the tool-bar's height is only increased
25123 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25124 Vauto_resize_tool_bars
= Qt
;
25126 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25127 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25128 auto_raise_tool_bar_buttons_p
= 1;
25130 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25131 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25132 make_cursor_line_fully_visible_p
= 1;
25134 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25135 doc
: /* *Border below tool-bar in pixels.
25136 If an integer, use it as the height of the border.
25137 If it is one of `internal-border-width' or `border-width', use the
25138 value of the corresponding frame parameter.
25139 Otherwise, no border is added below the tool-bar. */);
25140 Vtool_bar_border
= Qinternal_border_width
;
25142 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25143 doc
: /* *Margin around tool-bar buttons in pixels.
25144 If an integer, use that for both horizontal and vertical margins.
25145 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25146 HORZ specifying the horizontal margin, and VERT specifying the
25147 vertical margin. */);
25148 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25150 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25151 doc
: /* *Relief thickness of tool-bar buttons. */);
25152 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25154 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25155 doc
: /* List of functions to call to fontify regions of text.
25156 Each function is called with one argument POS. Functions must
25157 fontify a region starting at POS in the current buffer, and give
25158 fontified regions the property `fontified'. */);
25159 Vfontification_functions
= Qnil
;
25160 Fmake_variable_buffer_local (Qfontification_functions
);
25162 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25163 &unibyte_display_via_language_environment
,
25164 doc
: /* *Non-nil means display unibyte text according to language environment.
25165 Specifically this means that unibyte non-ASCII characters
25166 are displayed by converting them to the equivalent multibyte characters
25167 according to the current language environment. As a result, they are
25168 displayed according to the current fontset. */);
25169 unibyte_display_via_language_environment
= 0;
25171 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25172 doc
: /* *Maximum height for resizing mini-windows.
25173 If a float, it specifies a fraction of the mini-window frame's height.
25174 If an integer, it specifies a number of lines. */);
25175 Vmax_mini_window_height
= make_float (0.25);
25177 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25178 doc
: /* *How to resize mini-windows.
25179 A value of nil means don't automatically resize mini-windows.
25180 A value of t means resize them to fit the text displayed in them.
25181 A value of `grow-only', the default, means let mini-windows grow
25182 only, until their display becomes empty, at which point the windows
25183 go back to their normal size. */);
25184 Vresize_mini_windows
= Qgrow_only
;
25186 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25187 doc
: /* Alist specifying how to blink the cursor off.
25188 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25189 `cursor-type' frame-parameter or variable equals ON-STATE,
25190 comparing using `equal', Emacs uses OFF-STATE to specify
25191 how to blink it off. ON-STATE and OFF-STATE are values for
25192 the `cursor-type' frame parameter.
25194 If a frame's ON-STATE has no entry in this list,
25195 the frame's other specifications determine how to blink the cursor off. */);
25196 Vblink_cursor_alist
= Qnil
;
25198 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25199 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25200 automatic_hscrolling_p
= 1;
25201 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
25202 staticpro (&Qauto_hscroll_mode
);
25204 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25205 doc
: /* *How many columns away from the window edge point is allowed to get
25206 before automatic hscrolling will horizontally scroll the window. */);
25207 hscroll_margin
= 5;
25209 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25210 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25211 When point is less than `hscroll-margin' columns from the window
25212 edge, automatic hscrolling will scroll the window by the amount of columns
25213 determined by this variable. If its value is a positive integer, scroll that
25214 many columns. If it's a positive floating-point number, it specifies the
25215 fraction of the window's width to scroll. If it's nil or zero, point will be
25216 centered horizontally after the scroll. Any other value, including negative
25217 numbers, are treated as if the value were zero.
25219 Automatic hscrolling always moves point outside the scroll margin, so if
25220 point was more than scroll step columns inside the margin, the window will
25221 scroll more than the value given by the scroll step.
25223 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25224 and `scroll-right' overrides this variable's effect. */);
25225 Vhscroll_step
= make_number (0);
25227 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25228 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25229 Bind this around calls to `message' to let it take effect. */);
25230 message_truncate_lines
= 0;
25232 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25233 doc
: /* Normal hook run to update the menu bar definitions.
25234 Redisplay runs this hook before it redisplays the menu bar.
25235 This is used to update submenus such as Buffers,
25236 whose contents depend on various data. */);
25237 Vmenu_bar_update_hook
= Qnil
;
25239 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25240 doc
: /* Frame for which we are updating a menu.
25241 The enable predicate for a menu binding should check this variable. */);
25242 Vmenu_updating_frame
= Qnil
;
25244 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25245 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25246 inhibit_menubar_update
= 0;
25248 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25249 doc
: /* Prefix added to the beginning of all continuation lines at display-time.
25250 May be a string, an image, or a stretch-glyph such as used by the
25251 `display' text-property.
25253 This variable is overridden by any `wrap-prefix' text-property.
25255 To add a prefix to non-continuation lines, use the `line-prefix' variable. */);
25256 Vwrap_prefix
= Qnil
;
25257 staticpro (&Qwrap_prefix
);
25258 Qwrap_prefix
= intern ("wrap-prefix");
25259 Fmake_variable_buffer_local (Qwrap_prefix
);
25261 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25262 doc
: /* Prefix added to the beginning of all non-continuation lines at display-time.
25263 May be a string, an image, or a stretch-glyph such as used by the
25264 `display' text-property.
25266 This variable is overridden by any `line-prefix' text-property.
25268 To add a prefix to continuation lines, use the `wrap-prefix' variable. */);
25269 Vline_prefix
= Qnil
;
25270 staticpro (&Qline_prefix
);
25271 Qline_prefix
= intern ("line-prefix");
25272 Fmake_variable_buffer_local (Qline_prefix
);
25274 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25275 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25276 inhibit_eval_during_redisplay
= 0;
25278 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25279 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25280 inhibit_free_realized_faces
= 0;
25283 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25284 doc
: /* Inhibit try_window_id display optimization. */);
25285 inhibit_try_window_id
= 0;
25287 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25288 doc
: /* Inhibit try_window_reusing display optimization. */);
25289 inhibit_try_window_reusing
= 0;
25291 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25292 doc
: /* Inhibit try_cursor_movement display optimization. */);
25293 inhibit_try_cursor_movement
= 0;
25294 #endif /* GLYPH_DEBUG */
25296 DEFVAR_INT ("overline-margin", &overline_margin
,
25297 doc
: /* *Space between overline and text, in pixels.
25298 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25299 margin to the caracter height. */);
25300 overline_margin
= 2;
25302 DEFVAR_INT ("underline-minimum-offset",
25303 &underline_minimum_offset
,
25304 doc
: /* Minimum distance between baseline and underline.
25305 This can improve legibility of underlined text at small font sizes,
25306 particularly when using variable `x-use-underline-position-properties'
25307 with fonts that specify an UNDERLINE_POSITION relatively close to the
25308 baseline. The default value is 1. */);
25309 underline_minimum_offset
= 1;
25311 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25312 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25313 display_hourglass_p
= 1;
25315 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25316 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25317 Value must be an integer or float. */);
25318 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25320 hourglass_atimer
= NULL
;
25321 hourglass_shown_p
= 0;
25325 /* Initialize this module when Emacs starts. */
25330 Lisp_Object root_window
;
25331 struct window
*mini_w
;
25333 current_header_line_height
= current_mode_line_height
= -1;
25335 CHARPOS (this_line_start_pos
) = 0;
25337 mini_w
= XWINDOW (minibuf_window
);
25338 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25340 if (!noninteractive
)
25342 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25345 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25346 set_window_height (root_window
,
25347 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25349 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25350 set_window_height (minibuf_window
, 1, 0);
25352 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25353 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25355 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25356 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25357 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25359 /* The default ellipsis glyphs `...'. */
25360 for (i
= 0; i
< 3; ++i
)
25361 default_invis_vector
[i
] = make_number ('.');
25365 /* Allocate the buffer for frame titles.
25366 Also used for `format-mode-line'. */
25368 mode_line_noprop_buf
= (char *) xmalloc (size
);
25369 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25370 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25371 mode_line_target
= MODE_LINE_DISPLAY
;
25374 help_echo_showing_p
= 0;
25377 /* Since w32 does not support atimers, it defines its own implementation of
25378 the following three functions in w32fns.c. */
25381 /* Platform-independent portion of hourglass implementation. */
25383 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25385 hourglass_started ()
25387 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25390 /* Cancel a currently active hourglass timer, and start a new one. */
25394 #if defined (HAVE_WINDOW_SYSTEM)
25396 int secs
, usecs
= 0;
25398 cancel_hourglass ();
25400 if (INTEGERP (Vhourglass_delay
)
25401 && XINT (Vhourglass_delay
) > 0)
25402 secs
= XFASTINT (Vhourglass_delay
);
25403 else if (FLOATP (Vhourglass_delay
)
25404 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25407 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25408 secs
= XFASTINT (tem
);
25409 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25412 secs
= DEFAULT_HOURGLASS_DELAY
;
25414 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25415 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25416 show_hourglass
, NULL
);
25421 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25424 cancel_hourglass ()
25426 #if defined (HAVE_WINDOW_SYSTEM)
25427 if (hourglass_atimer
)
25429 cancel_atimer (hourglass_atimer
);
25430 hourglass_atimer
= NULL
;
25433 if (hourglass_shown_p
)
25437 #endif /* ! WINDOWSNT */
25439 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25440 (do not change this comment) */