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). Fixme: do we
7262 need to do this in other circumstances? */
7263 if ((op
& MOVE_TO_VPOS
)
7264 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7265 set_iterator_to_next (it
, 0);
7268 it
->continuation_lines_width
+= it
->current_x
;
7275 /* Reset/increment for the next run. */
7276 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7277 it
->current_x
= it
->hpos
= 0;
7278 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7280 last_height
= it
->max_ascent
+ it
->max_descent
;
7281 last_max_ascent
= it
->max_ascent
;
7282 it
->max_ascent
= it
->max_descent
= 0;
7287 /* On text terminals, we may stop at the end of a line in the middle
7288 of a multi-character glyph. If the glyph itself is continued,
7289 i.e. it is actually displayed on the next line, don't treat this
7290 stopping point as valid; move to the next line instead (unless
7291 that brings us offscreen). */
7292 if (!FRAME_WINDOW_P (it
->f
)
7294 && IT_CHARPOS (*it
) == to_charpos
7295 && it
->what
== IT_CHARACTER
7297 && it
->line_wrap
== WINDOW_WRAP
7298 && it
->current_x
== it
->last_visible_x
- 1
7301 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7303 it
->continuation_lines_width
+= it
->current_x
;
7304 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7305 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7307 last_height
= it
->max_ascent
+ it
->max_descent
;
7308 last_max_ascent
= it
->max_ascent
;
7311 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7315 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7317 If DY > 0, move IT backward at least that many pixels. DY = 0
7318 means move IT backward to the preceding line start or BEGV. This
7319 function may move over more than DY pixels if IT->current_y - DY
7320 ends up in the middle of a line; in this case IT->current_y will be
7321 set to the top of the line moved to. */
7324 move_it_vertically_backward (it
, dy
)
7335 start_pos
= IT_CHARPOS (*it
);
7337 /* Estimate how many newlines we must move back. */
7338 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7340 /* Set the iterator's position that many lines back. */
7341 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7342 back_to_previous_visible_line_start (it
);
7344 /* Reseat the iterator here. When moving backward, we don't want
7345 reseat to skip forward over invisible text, set up the iterator
7346 to deliver from overlay strings at the new position etc. So,
7347 use reseat_1 here. */
7348 reseat_1 (it
, it
->current
.pos
, 1);
7350 /* We are now surely at a line start. */
7351 it
->current_x
= it
->hpos
= 0;
7352 it
->continuation_lines_width
= 0;
7354 /* Move forward and see what y-distance we moved. First move to the
7355 start of the next line so that we get its height. We need this
7356 height to be able to tell whether we reached the specified
7359 it2
.max_ascent
= it2
.max_descent
= 0;
7362 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7363 MOVE_TO_POS
| MOVE_TO_VPOS
);
7365 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7366 xassert (IT_CHARPOS (*it
) >= BEGV
);
7369 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7370 xassert (IT_CHARPOS (*it
) >= BEGV
);
7371 /* H is the actual vertical distance from the position in *IT
7372 and the starting position. */
7373 h
= it2
.current_y
- it
->current_y
;
7374 /* NLINES is the distance in number of lines. */
7375 nlines
= it2
.vpos
- it
->vpos
;
7377 /* Correct IT's y and vpos position
7378 so that they are relative to the starting point. */
7384 /* DY == 0 means move to the start of the screen line. The
7385 value of nlines is > 0 if continuation lines were involved. */
7387 move_it_by_lines (it
, nlines
, 1);
7389 /* I think this assert is bogus if buffer contains
7390 invisible text or images. KFS. */
7391 xassert (IT_CHARPOS (*it
) <= start_pos
);
7396 /* The y-position we try to reach, relative to *IT.
7397 Note that H has been subtracted in front of the if-statement. */
7398 int target_y
= it
->current_y
+ h
- dy
;
7399 int y0
= it3
.current_y
;
7400 int y1
= line_bottom_y (&it3
);
7401 int line_height
= y1
- y0
;
7403 /* If we did not reach target_y, try to move further backward if
7404 we can. If we moved too far backward, try to move forward. */
7405 if (target_y
< it
->current_y
7406 /* This is heuristic. In a window that's 3 lines high, with
7407 a line height of 13 pixels each, recentering with point
7408 on the bottom line will try to move -39/2 = 19 pixels
7409 backward. Try to avoid moving into the first line. */
7410 && (it
->current_y
- target_y
7411 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7412 && IT_CHARPOS (*it
) > BEGV
)
7414 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7415 target_y
- it
->current_y
));
7416 dy
= it
->current_y
- target_y
;
7417 goto move_further_back
;
7419 else if (target_y
>= it
->current_y
+ line_height
7420 && IT_CHARPOS (*it
) < ZV
)
7422 /* Should move forward by at least one line, maybe more.
7424 Note: Calling move_it_by_lines can be expensive on
7425 terminal frames, where compute_motion is used (via
7426 vmotion) to do the job, when there are very long lines
7427 and truncate-lines is nil. That's the reason for
7428 treating terminal frames specially here. */
7430 if (!FRAME_WINDOW_P (it
->f
))
7431 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7436 move_it_by_lines (it
, 1, 1);
7438 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7442 /* I think this assert is bogus if buffer contains
7443 invisible text or images. KFS. */
7444 xassert (IT_CHARPOS (*it
) >= BEGV
);
7451 /* Move IT by a specified amount of pixel lines DY. DY negative means
7452 move backwards. DY = 0 means move to start of screen line. At the
7453 end, IT will be on the start of a screen line. */
7456 move_it_vertically (it
, dy
)
7461 move_it_vertically_backward (it
, -dy
);
7464 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7465 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7466 MOVE_TO_POS
| MOVE_TO_Y
);
7467 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7469 /* If buffer ends in ZV without a newline, move to the start of
7470 the line to satisfy the post-condition. */
7471 if (IT_CHARPOS (*it
) == ZV
7473 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7474 move_it_by_lines (it
, 0, 0);
7479 /* Move iterator IT past the end of the text line it is in. */
7482 move_it_past_eol (it
)
7485 enum move_it_result rc
;
7487 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7488 if (rc
== MOVE_NEWLINE_OR_CR
)
7489 set_iterator_to_next (it
, 0);
7493 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7494 negative means move up. DVPOS == 0 means move to the start of the
7495 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7496 NEED_Y_P is zero, IT->current_y will be left unchanged.
7498 Further optimization ideas: If we would know that IT->f doesn't use
7499 a face with proportional font, we could be faster for
7500 truncate-lines nil. */
7503 move_it_by_lines (it
, dvpos
, need_y_p
)
7505 int dvpos
, need_y_p
;
7507 struct position pos
;
7509 /* The commented-out optimization uses vmotion on terminals. This
7510 gives bad results, because elements like it->what, on which
7511 callers such as pos_visible_p rely, aren't updated. */
7512 /* if (!FRAME_WINDOW_P (it->f))
7514 struct text_pos textpos;
7516 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7517 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7518 reseat (it, textpos, 1);
7519 it->vpos += pos.vpos;
7520 it->current_y += pos.vpos;
7526 /* DVPOS == 0 means move to the start of the screen line. */
7527 move_it_vertically_backward (it
, 0);
7528 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7529 /* Let next call to line_bottom_y calculate real line height */
7534 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7535 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7536 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7541 int start_charpos
, i
;
7543 /* Start at the beginning of the screen line containing IT's
7544 position. This may actually move vertically backwards,
7545 in case of overlays, so adjust dvpos accordingly. */
7547 move_it_vertically_backward (it
, 0);
7550 /* Go back -DVPOS visible lines and reseat the iterator there. */
7551 start_charpos
= IT_CHARPOS (*it
);
7552 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7553 back_to_previous_visible_line_start (it
);
7554 reseat (it
, it
->current
.pos
, 1);
7556 /* Move further back if we end up in a string or an image. */
7557 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7559 /* First try to move to start of display line. */
7561 move_it_vertically_backward (it
, 0);
7563 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7565 /* If start of line is still in string or image,
7566 move further back. */
7567 back_to_previous_visible_line_start (it
);
7568 reseat (it
, it
->current
.pos
, 1);
7572 it
->current_x
= it
->hpos
= 0;
7574 /* Above call may have moved too far if continuation lines
7575 are involved. Scan forward and see if it did. */
7577 it2
.vpos
= it2
.current_y
= 0;
7578 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7579 it
->vpos
-= it2
.vpos
;
7580 it
->current_y
-= it2
.current_y
;
7581 it
->current_x
= it
->hpos
= 0;
7583 /* If we moved too far back, move IT some lines forward. */
7584 if (it2
.vpos
> -dvpos
)
7586 int delta
= it2
.vpos
+ dvpos
;
7588 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7589 /* Move back again if we got too far ahead. */
7590 if (IT_CHARPOS (*it
) >= start_charpos
)
7596 /* Return 1 if IT points into the middle of a display vector. */
7599 in_display_vector_p (it
)
7602 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7603 && it
->current
.dpvec_index
> 0
7604 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7608 /***********************************************************************
7610 ***********************************************************************/
7613 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7617 add_to_log (format
, arg1
, arg2
)
7619 Lisp_Object arg1
, arg2
;
7621 Lisp_Object args
[3];
7622 Lisp_Object msg
, fmt
;
7625 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7628 /* Do nothing if called asynchronously. Inserting text into
7629 a buffer may call after-change-functions and alike and
7630 that would means running Lisp asynchronously. */
7631 if (handling_signal
)
7635 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7637 args
[0] = fmt
= build_string (format
);
7640 msg
= Fformat (3, args
);
7642 len
= SBYTES (msg
) + 1;
7643 SAFE_ALLOCA (buffer
, char *, len
);
7644 bcopy (SDATA (msg
), buffer
, len
);
7646 message_dolog (buffer
, len
- 1, 1, 0);
7653 /* Output a newline in the *Messages* buffer if "needs" one. */
7656 message_log_maybe_newline ()
7658 if (message_log_need_newline
)
7659 message_dolog ("", 0, 1, 0);
7663 /* Add a string M of length NBYTES to the message log, optionally
7664 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7665 nonzero, means interpret the contents of M as multibyte. This
7666 function calls low-level routines in order to bypass text property
7667 hooks, etc. which might not be safe to run.
7669 This may GC (insert may run before/after change hooks),
7670 so the buffer M must NOT point to a Lisp string. */
7673 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7675 int nbytes
, nlflag
, multibyte
;
7677 if (!NILP (Vmemory_full
))
7680 if (!NILP (Vmessage_log_max
))
7682 struct buffer
*oldbuf
;
7683 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7684 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7685 int point_at_end
= 0;
7687 Lisp_Object old_deactivate_mark
, tem
;
7688 struct gcpro gcpro1
;
7690 old_deactivate_mark
= Vdeactivate_mark
;
7691 oldbuf
= current_buffer
;
7692 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7693 current_buffer
->undo_list
= Qt
;
7695 oldpoint
= message_dolog_marker1
;
7696 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7697 oldbegv
= message_dolog_marker2
;
7698 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7699 oldzv
= message_dolog_marker3
;
7700 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7701 GCPRO1 (old_deactivate_mark
);
7709 BEGV_BYTE
= BEG_BYTE
;
7712 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7714 /* Insert the string--maybe converting multibyte to single byte
7715 or vice versa, so that all the text fits the buffer. */
7717 && NILP (current_buffer
->enable_multibyte_characters
))
7719 int i
, c
, char_bytes
;
7720 unsigned char work
[1];
7722 /* Convert a multibyte string to single-byte
7723 for the *Message* buffer. */
7724 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7726 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7727 work
[0] = (ASCII_CHAR_P (c
)
7729 : multibyte_char_to_unibyte (c
, Qnil
));
7730 insert_1_both (work
, 1, 1, 1, 0, 0);
7733 else if (! multibyte
7734 && ! NILP (current_buffer
->enable_multibyte_characters
))
7736 int i
, c
, char_bytes
;
7737 unsigned char *msg
= (unsigned char *) m
;
7738 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7739 /* Convert a single-byte string to multibyte
7740 for the *Message* buffer. */
7741 for (i
= 0; i
< nbytes
; i
++)
7744 c
= unibyte_char_to_multibyte (c
);
7745 char_bytes
= CHAR_STRING (c
, str
);
7746 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7750 insert_1 (m
, nbytes
, 1, 0, 0);
7754 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7755 insert_1 ("\n", 1, 1, 0, 0);
7757 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7759 this_bol_byte
= PT_BYTE
;
7761 /* See if this line duplicates the previous one.
7762 If so, combine duplicates. */
7765 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7767 prev_bol_byte
= PT_BYTE
;
7769 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7770 this_bol
, this_bol_byte
);
7773 del_range_both (prev_bol
, prev_bol_byte
,
7774 this_bol
, this_bol_byte
, 0);
7780 /* If you change this format, don't forget to also
7781 change message_log_check_duplicate. */
7782 sprintf (dupstr
, " [%d times]", dup
);
7783 duplen
= strlen (dupstr
);
7784 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7785 insert_1 (dupstr
, duplen
, 1, 0, 1);
7790 /* If we have more than the desired maximum number of lines
7791 in the *Messages* buffer now, delete the oldest ones.
7792 This is safe because we don't have undo in this buffer. */
7794 if (NATNUMP (Vmessage_log_max
))
7796 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7797 -XFASTINT (Vmessage_log_max
) - 1, 0);
7798 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7801 BEGV
= XMARKER (oldbegv
)->charpos
;
7802 BEGV_BYTE
= marker_byte_position (oldbegv
);
7811 ZV
= XMARKER (oldzv
)->charpos
;
7812 ZV_BYTE
= marker_byte_position (oldzv
);
7816 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7818 /* We can't do Fgoto_char (oldpoint) because it will run some
7820 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7821 XMARKER (oldpoint
)->bytepos
);
7824 unchain_marker (XMARKER (oldpoint
));
7825 unchain_marker (XMARKER (oldbegv
));
7826 unchain_marker (XMARKER (oldzv
));
7828 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7829 set_buffer_internal (oldbuf
);
7831 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7832 message_log_need_newline
= !nlflag
;
7833 Vdeactivate_mark
= old_deactivate_mark
;
7838 /* We are at the end of the buffer after just having inserted a newline.
7839 (Note: We depend on the fact we won't be crossing the gap.)
7840 Check to see if the most recent message looks a lot like the previous one.
7841 Return 0 if different, 1 if the new one should just replace it, or a
7842 value N > 1 if we should also append " [N times]". */
7845 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7846 int prev_bol
, this_bol
;
7847 int prev_bol_byte
, this_bol_byte
;
7850 int len
= Z_BYTE
- 1 - this_bol_byte
;
7852 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7853 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7855 for (i
= 0; i
< len
; i
++)
7857 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7865 if (*p1
++ == ' ' && *p1
++ == '[')
7868 while (*p1
>= '0' && *p1
<= '9')
7869 n
= n
* 10 + *p1
++ - '0';
7870 if (strncmp (p1
, " times]\n", 8) == 0)
7877 /* Display an echo area message M with a specified length of NBYTES
7878 bytes. The string may include null characters. If M is 0, clear
7879 out any existing message, and let the mini-buffer text show
7882 This may GC, so the buffer M must NOT point to a Lisp string. */
7885 message2 (m
, nbytes
, multibyte
)
7890 /* First flush out any partial line written with print. */
7891 message_log_maybe_newline ();
7893 message_dolog (m
, nbytes
, 1, multibyte
);
7894 message2_nolog (m
, nbytes
, multibyte
);
7898 /* The non-logging counterpart of message2. */
7901 message2_nolog (m
, nbytes
, multibyte
)
7903 int nbytes
, multibyte
;
7905 struct frame
*sf
= SELECTED_FRAME ();
7906 message_enable_multibyte
= multibyte
;
7910 if (noninteractive_need_newline
)
7911 putc ('\n', stderr
);
7912 noninteractive_need_newline
= 0;
7914 fwrite (m
, nbytes
, 1, stderr
);
7915 if (cursor_in_echo_area
== 0)
7916 fprintf (stderr
, "\n");
7919 /* A null message buffer means that the frame hasn't really been
7920 initialized yet. Error messages get reported properly by
7921 cmd_error, so this must be just an informative message; toss it. */
7922 else if (INTERACTIVE
7923 && sf
->glyphs_initialized_p
7924 && FRAME_MESSAGE_BUF (sf
))
7926 Lisp_Object mini_window
;
7929 /* Get the frame containing the mini-buffer
7930 that the selected frame is using. */
7931 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7932 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7934 FRAME_SAMPLE_VISIBILITY (f
);
7935 if (FRAME_VISIBLE_P (sf
)
7936 && ! FRAME_VISIBLE_P (f
))
7937 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7941 set_message (m
, Qnil
, nbytes
, multibyte
);
7942 if (minibuffer_auto_raise
)
7943 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7946 clear_message (1, 1);
7948 do_pending_window_change (0);
7949 echo_area_display (1);
7950 do_pending_window_change (0);
7951 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7952 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7957 /* Display an echo area message M with a specified length of NBYTES
7958 bytes. The string may include null characters. If M is not a
7959 string, clear out any existing message, and let the mini-buffer
7962 This function cancels echoing. */
7965 message3 (m
, nbytes
, multibyte
)
7970 struct gcpro gcpro1
;
7973 clear_message (1,1);
7976 /* First flush out any partial line written with print. */
7977 message_log_maybe_newline ();
7983 SAFE_ALLOCA (buffer
, char *, nbytes
);
7984 bcopy (SDATA (m
), buffer
, nbytes
);
7985 message_dolog (buffer
, nbytes
, 1, multibyte
);
7988 message3_nolog (m
, nbytes
, multibyte
);
7994 /* The non-logging version of message3.
7995 This does not cancel echoing, because it is used for echoing.
7996 Perhaps we need to make a separate function for echoing
7997 and make this cancel echoing. */
8000 message3_nolog (m
, nbytes
, multibyte
)
8002 int nbytes
, multibyte
;
8004 struct frame
*sf
= SELECTED_FRAME ();
8005 message_enable_multibyte
= multibyte
;
8009 if (noninteractive_need_newline
)
8010 putc ('\n', stderr
);
8011 noninteractive_need_newline
= 0;
8013 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8014 if (cursor_in_echo_area
== 0)
8015 fprintf (stderr
, "\n");
8018 /* A null message buffer means that the frame hasn't really been
8019 initialized yet. Error messages get reported properly by
8020 cmd_error, so this must be just an informative message; toss it. */
8021 else if (INTERACTIVE
8022 && sf
->glyphs_initialized_p
8023 && FRAME_MESSAGE_BUF (sf
))
8025 Lisp_Object mini_window
;
8029 /* Get the frame containing the mini-buffer
8030 that the selected frame is using. */
8031 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8032 frame
= XWINDOW (mini_window
)->frame
;
8035 FRAME_SAMPLE_VISIBILITY (f
);
8036 if (FRAME_VISIBLE_P (sf
)
8037 && !FRAME_VISIBLE_P (f
))
8038 Fmake_frame_visible (frame
);
8040 if (STRINGP (m
) && SCHARS (m
) > 0)
8042 set_message (NULL
, m
, nbytes
, multibyte
);
8043 if (minibuffer_auto_raise
)
8044 Fraise_frame (frame
);
8045 /* Assume we are not echoing.
8046 (If we are, echo_now will override this.) */
8047 echo_message_buffer
= Qnil
;
8050 clear_message (1, 1);
8052 do_pending_window_change (0);
8053 echo_area_display (1);
8054 do_pending_window_change (0);
8055 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8056 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8061 /* Display a null-terminated echo area message M. If M is 0, clear
8062 out any existing message, and let the mini-buffer text show through.
8064 The buffer M must continue to exist until after the echo area gets
8065 cleared or some other message gets displayed there. Do not pass
8066 text that is stored in a Lisp string. Do not pass text in a buffer
8067 that was alloca'd. */
8073 message2 (m
, (m
? strlen (m
) : 0), 0);
8077 /* The non-logging counterpart of message1. */
8083 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8086 /* Display a message M which contains a single %s
8087 which gets replaced with STRING. */
8090 message_with_string (m
, string
, log
)
8095 CHECK_STRING (string
);
8101 if (noninteractive_need_newline
)
8102 putc ('\n', stderr
);
8103 noninteractive_need_newline
= 0;
8104 fprintf (stderr
, m
, SDATA (string
));
8105 if (cursor_in_echo_area
== 0)
8106 fprintf (stderr
, "\n");
8110 else if (INTERACTIVE
)
8112 /* The frame whose minibuffer we're going to display the message on.
8113 It may be larger than the selected frame, so we need
8114 to use its buffer, not the selected frame's buffer. */
8115 Lisp_Object mini_window
;
8116 struct frame
*f
, *sf
= SELECTED_FRAME ();
8118 /* Get the frame containing the minibuffer
8119 that the selected frame is using. */
8120 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8121 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8123 /* A null message buffer means that the frame hasn't really been
8124 initialized yet. Error messages get reported properly by
8125 cmd_error, so this must be just an informative message; toss it. */
8126 if (FRAME_MESSAGE_BUF (f
))
8128 Lisp_Object args
[2], message
;
8129 struct gcpro gcpro1
, gcpro2
;
8131 args
[0] = build_string (m
);
8132 args
[1] = message
= string
;
8133 GCPRO2 (args
[0], message
);
8136 message
= Fformat (2, args
);
8139 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8141 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8145 /* Print should start at the beginning of the message
8146 buffer next time. */
8147 message_buf_print
= 0;
8153 /* Dump an informative message to the minibuf. If M is 0, clear out
8154 any existing message, and let the mini-buffer text show through. */
8158 message (m
, a1
, a2
, a3
)
8160 EMACS_INT a1
, a2
, a3
;
8166 if (noninteractive_need_newline
)
8167 putc ('\n', stderr
);
8168 noninteractive_need_newline
= 0;
8169 fprintf (stderr
, m
, a1
, a2
, a3
);
8170 if (cursor_in_echo_area
== 0)
8171 fprintf (stderr
, "\n");
8175 else if (INTERACTIVE
)
8177 /* The frame whose mini-buffer we're going to display the message
8178 on. It may be larger than the selected frame, so we need to
8179 use its buffer, not the selected frame's buffer. */
8180 Lisp_Object mini_window
;
8181 struct frame
*f
, *sf
= SELECTED_FRAME ();
8183 /* Get the frame containing the mini-buffer
8184 that the selected frame is using. */
8185 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8186 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8188 /* A null message buffer means that the frame hasn't really been
8189 initialized yet. Error messages get reported properly by
8190 cmd_error, so this must be just an informative message; toss
8192 if (FRAME_MESSAGE_BUF (f
))
8203 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8204 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8206 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8207 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8209 #endif /* NO_ARG_ARRAY */
8211 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8216 /* Print should start at the beginning of the message
8217 buffer next time. */
8218 message_buf_print
= 0;
8224 /* The non-logging version of message. */
8227 message_nolog (m
, a1
, a2
, a3
)
8229 EMACS_INT a1
, a2
, a3
;
8231 Lisp_Object old_log_max
;
8232 old_log_max
= Vmessage_log_max
;
8233 Vmessage_log_max
= Qnil
;
8234 message (m
, a1
, a2
, a3
);
8235 Vmessage_log_max
= old_log_max
;
8239 /* Display the current message in the current mini-buffer. This is
8240 only called from error handlers in process.c, and is not time
8246 if (!NILP (echo_area_buffer
[0]))
8249 string
= Fcurrent_message ();
8250 message3 (string
, SBYTES (string
),
8251 !NILP (current_buffer
->enable_multibyte_characters
));
8256 /* Make sure echo area buffers in `echo_buffers' are live.
8257 If they aren't, make new ones. */
8260 ensure_echo_area_buffers ()
8264 for (i
= 0; i
< 2; ++i
)
8265 if (!BUFFERP (echo_buffer
[i
])
8266 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8269 Lisp_Object old_buffer
;
8272 old_buffer
= echo_buffer
[i
];
8273 sprintf (name
, " *Echo Area %d*", i
);
8274 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8275 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8276 /* to force word wrap in echo area -
8277 it was decided to postpone this*/
8278 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8280 for (j
= 0; j
< 2; ++j
)
8281 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8282 echo_area_buffer
[j
] = echo_buffer
[i
];
8287 /* Call FN with args A1..A4 with either the current or last displayed
8288 echo_area_buffer as current buffer.
8290 WHICH zero means use the current message buffer
8291 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8292 from echo_buffer[] and clear it.
8294 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8295 suitable buffer from echo_buffer[] and clear it.
8297 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8298 that the current message becomes the last displayed one, make
8299 choose a suitable buffer for echo_area_buffer[0], and clear it.
8301 Value is what FN returns. */
8304 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8307 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8313 int this_one
, the_other
, clear_buffer_p
, rc
;
8314 int count
= SPECPDL_INDEX ();
8316 /* If buffers aren't live, make new ones. */
8317 ensure_echo_area_buffers ();
8322 this_one
= 0, the_other
= 1;
8324 this_one
= 1, the_other
= 0;
8327 this_one
= 0, the_other
= 1;
8330 /* We need a fresh one in case the current echo buffer equals
8331 the one containing the last displayed echo area message. */
8332 if (!NILP (echo_area_buffer
[this_one
])
8333 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8334 echo_area_buffer
[this_one
] = Qnil
;
8337 /* Choose a suitable buffer from echo_buffer[] is we don't
8339 if (NILP (echo_area_buffer
[this_one
]))
8341 echo_area_buffer
[this_one
]
8342 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8343 ? echo_buffer
[the_other
]
8344 : echo_buffer
[this_one
]);
8348 buffer
= echo_area_buffer
[this_one
];
8350 /* Don't get confused by reusing the buffer used for echoing
8351 for a different purpose. */
8352 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8355 record_unwind_protect (unwind_with_echo_area_buffer
,
8356 with_echo_area_buffer_unwind_data (w
));
8358 /* Make the echo area buffer current. Note that for display
8359 purposes, it is not necessary that the displayed window's buffer
8360 == current_buffer, except for text property lookup. So, let's
8361 only set that buffer temporarily here without doing a full
8362 Fset_window_buffer. We must also change w->pointm, though,
8363 because otherwise an assertions in unshow_buffer fails, and Emacs
8365 set_buffer_internal_1 (XBUFFER (buffer
));
8369 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8372 current_buffer
->undo_list
= Qt
;
8373 current_buffer
->read_only
= Qnil
;
8374 specbind (Qinhibit_read_only
, Qt
);
8375 specbind (Qinhibit_modification_hooks
, Qt
);
8377 if (clear_buffer_p
&& Z
> BEG
)
8380 xassert (BEGV
>= BEG
);
8381 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8383 rc
= fn (a1
, a2
, a3
, a4
);
8385 xassert (BEGV
>= BEG
);
8386 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8388 unbind_to (count
, Qnil
);
8393 /* Save state that should be preserved around the call to the function
8394 FN called in with_echo_area_buffer. */
8397 with_echo_area_buffer_unwind_data (w
)
8401 Lisp_Object vector
, tmp
;
8403 /* Reduce consing by keeping one vector in
8404 Vwith_echo_area_save_vector. */
8405 vector
= Vwith_echo_area_save_vector
;
8406 Vwith_echo_area_save_vector
= Qnil
;
8409 vector
= Fmake_vector (make_number (7), Qnil
);
8411 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8412 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8413 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8417 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8418 ASET (vector
, i
, w
->buffer
); ++i
;
8419 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8420 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8425 for (; i
< end
; ++i
)
8426 ASET (vector
, i
, Qnil
);
8429 xassert (i
== ASIZE (vector
));
8434 /* Restore global state from VECTOR which was created by
8435 with_echo_area_buffer_unwind_data. */
8438 unwind_with_echo_area_buffer (vector
)
8441 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8442 Vdeactivate_mark
= AREF (vector
, 1);
8443 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8445 if (WINDOWP (AREF (vector
, 3)))
8448 Lisp_Object buffer
, charpos
, bytepos
;
8450 w
= XWINDOW (AREF (vector
, 3));
8451 buffer
= AREF (vector
, 4);
8452 charpos
= AREF (vector
, 5);
8453 bytepos
= AREF (vector
, 6);
8456 set_marker_both (w
->pointm
, buffer
,
8457 XFASTINT (charpos
), XFASTINT (bytepos
));
8460 Vwith_echo_area_save_vector
= vector
;
8465 /* Set up the echo area for use by print functions. MULTIBYTE_P
8466 non-zero means we will print multibyte. */
8469 setup_echo_area_for_printing (multibyte_p
)
8472 /* If we can't find an echo area any more, exit. */
8473 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8476 ensure_echo_area_buffers ();
8478 if (!message_buf_print
)
8480 /* A message has been output since the last time we printed.
8481 Choose a fresh echo area buffer. */
8482 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8483 echo_area_buffer
[0] = echo_buffer
[1];
8485 echo_area_buffer
[0] = echo_buffer
[0];
8487 /* Switch to that buffer and clear it. */
8488 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8489 current_buffer
->truncate_lines
= Qnil
;
8493 int count
= SPECPDL_INDEX ();
8494 specbind (Qinhibit_read_only
, Qt
);
8495 /* Note that undo recording is always disabled. */
8497 unbind_to (count
, Qnil
);
8499 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8501 /* Set up the buffer for the multibyteness we need. */
8503 != !NILP (current_buffer
->enable_multibyte_characters
))
8504 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8506 /* Raise the frame containing the echo area. */
8507 if (minibuffer_auto_raise
)
8509 struct frame
*sf
= SELECTED_FRAME ();
8510 Lisp_Object mini_window
;
8511 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8512 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8515 message_log_maybe_newline ();
8516 message_buf_print
= 1;
8520 if (NILP (echo_area_buffer
[0]))
8522 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8523 echo_area_buffer
[0] = echo_buffer
[1];
8525 echo_area_buffer
[0] = echo_buffer
[0];
8528 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8530 /* Someone switched buffers between print requests. */
8531 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8532 current_buffer
->truncate_lines
= Qnil
;
8538 /* Display an echo area message in window W. Value is non-zero if W's
8539 height is changed. If display_last_displayed_message_p is
8540 non-zero, display the message that was last displayed, otherwise
8541 display the current message. */
8544 display_echo_area (w
)
8547 int i
, no_message_p
, window_height_changed_p
, count
;
8549 /* Temporarily disable garbage collections while displaying the echo
8550 area. This is done because a GC can print a message itself.
8551 That message would modify the echo area buffer's contents while a
8552 redisplay of the buffer is going on, and seriously confuse
8554 count
= inhibit_garbage_collection ();
8556 /* If there is no message, we must call display_echo_area_1
8557 nevertheless because it resizes the window. But we will have to
8558 reset the echo_area_buffer in question to nil at the end because
8559 with_echo_area_buffer will sets it to an empty buffer. */
8560 i
= display_last_displayed_message_p
? 1 : 0;
8561 no_message_p
= NILP (echo_area_buffer
[i
]);
8563 window_height_changed_p
8564 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8565 display_echo_area_1
,
8566 (EMACS_INT
) w
, Qnil
, 0, 0);
8569 echo_area_buffer
[i
] = Qnil
;
8571 unbind_to (count
, Qnil
);
8572 return window_height_changed_p
;
8576 /* Helper for display_echo_area. Display the current buffer which
8577 contains the current echo area message in window W, a mini-window,
8578 a pointer to which is passed in A1. A2..A4 are currently not used.
8579 Change the height of W so that all of the message is displayed.
8580 Value is non-zero if height of W was changed. */
8583 display_echo_area_1 (a1
, a2
, a3
, a4
)
8588 struct window
*w
= (struct window
*) a1
;
8590 struct text_pos start
;
8591 int window_height_changed_p
= 0;
8593 /* Do this before displaying, so that we have a large enough glyph
8594 matrix for the display. If we can't get enough space for the
8595 whole text, display the last N lines. That works by setting w->start. */
8596 window_height_changed_p
= resize_mini_window (w
, 0);
8598 /* Use the starting position chosen by resize_mini_window. */
8599 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8602 clear_glyph_matrix (w
->desired_matrix
);
8603 XSETWINDOW (window
, w
);
8604 try_window (window
, start
, 0);
8606 return window_height_changed_p
;
8610 /* Resize the echo area window to exactly the size needed for the
8611 currently displayed message, if there is one. If a mini-buffer
8612 is active, don't shrink it. */
8615 resize_echo_area_exactly ()
8617 if (BUFFERP (echo_area_buffer
[0])
8618 && WINDOWP (echo_area_window
))
8620 struct window
*w
= XWINDOW (echo_area_window
);
8622 Lisp_Object resize_exactly
;
8624 if (minibuf_level
== 0)
8625 resize_exactly
= Qt
;
8627 resize_exactly
= Qnil
;
8629 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8630 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8633 ++windows_or_buffers_changed
;
8634 ++update_mode_lines
;
8635 redisplay_internal (0);
8641 /* Callback function for with_echo_area_buffer, when used from
8642 resize_echo_area_exactly. A1 contains a pointer to the window to
8643 resize, EXACTLY non-nil means resize the mini-window exactly to the
8644 size of the text displayed. A3 and A4 are not used. Value is what
8645 resize_mini_window returns. */
8648 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8650 Lisp_Object exactly
;
8653 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8657 /* Resize mini-window W to fit the size of its contents. EXACT_P
8658 means size the window exactly to the size needed. Otherwise, it's
8659 only enlarged until W's buffer is empty.
8661 Set W->start to the right place to begin display. If the whole
8662 contents fit, start at the beginning. Otherwise, start so as
8663 to make the end of the contents appear. This is particularly
8664 important for y-or-n-p, but seems desirable generally.
8666 Value is non-zero if the window height has been changed. */
8669 resize_mini_window (w
, exact_p
)
8673 struct frame
*f
= XFRAME (w
->frame
);
8674 int window_height_changed_p
= 0;
8676 xassert (MINI_WINDOW_P (w
));
8678 /* By default, start display at the beginning. */
8679 set_marker_both (w
->start
, w
->buffer
,
8680 BUF_BEGV (XBUFFER (w
->buffer
)),
8681 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8683 /* Don't resize windows while redisplaying a window; it would
8684 confuse redisplay functions when the size of the window they are
8685 displaying changes from under them. Such a resizing can happen,
8686 for instance, when which-func prints a long message while
8687 we are running fontification-functions. We're running these
8688 functions with safe_call which binds inhibit-redisplay to t. */
8689 if (!NILP (Vinhibit_redisplay
))
8692 /* Nil means don't try to resize. */
8693 if (NILP (Vresize_mini_windows
)
8694 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8697 if (!FRAME_MINIBUF_ONLY_P (f
))
8700 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8701 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8702 int height
, max_height
;
8703 int unit
= FRAME_LINE_HEIGHT (f
);
8704 struct text_pos start
;
8705 struct buffer
*old_current_buffer
= NULL
;
8707 if (current_buffer
!= XBUFFER (w
->buffer
))
8709 old_current_buffer
= current_buffer
;
8710 set_buffer_internal (XBUFFER (w
->buffer
));
8713 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8715 /* Compute the max. number of lines specified by the user. */
8716 if (FLOATP (Vmax_mini_window_height
))
8717 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8718 else if (INTEGERP (Vmax_mini_window_height
))
8719 max_height
= XINT (Vmax_mini_window_height
);
8721 max_height
= total_height
/ 4;
8723 /* Correct that max. height if it's bogus. */
8724 max_height
= max (1, max_height
);
8725 max_height
= min (total_height
, max_height
);
8727 /* Find out the height of the text in the window. */
8728 if (it
.line_wrap
== TRUNCATE
)
8733 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8734 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8735 height
= it
.current_y
+ last_height
;
8737 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8738 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8739 height
= (height
+ unit
- 1) / unit
;
8742 /* Compute a suitable window start. */
8743 if (height
> max_height
)
8745 height
= max_height
;
8746 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8747 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8748 start
= it
.current
.pos
;
8751 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8752 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8754 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8756 /* Let it grow only, until we display an empty message, in which
8757 case the window shrinks again. */
8758 if (height
> WINDOW_TOTAL_LINES (w
))
8760 int old_height
= WINDOW_TOTAL_LINES (w
);
8761 freeze_window_starts (f
, 1);
8762 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8763 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8765 else if (height
< WINDOW_TOTAL_LINES (w
)
8766 && (exact_p
|| BEGV
== ZV
))
8768 int old_height
= WINDOW_TOTAL_LINES (w
);
8769 freeze_window_starts (f
, 0);
8770 shrink_mini_window (w
);
8771 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8776 /* Always resize to exact size needed. */
8777 if (height
> WINDOW_TOTAL_LINES (w
))
8779 int old_height
= WINDOW_TOTAL_LINES (w
);
8780 freeze_window_starts (f
, 1);
8781 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8782 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8784 else if (height
< WINDOW_TOTAL_LINES (w
))
8786 int old_height
= WINDOW_TOTAL_LINES (w
);
8787 freeze_window_starts (f
, 0);
8788 shrink_mini_window (w
);
8792 freeze_window_starts (f
, 1);
8793 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8796 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8800 if (old_current_buffer
)
8801 set_buffer_internal (old_current_buffer
);
8804 return window_height_changed_p
;
8808 /* Value is the current message, a string, or nil if there is no
8816 if (!BUFFERP (echo_area_buffer
[0]))
8820 with_echo_area_buffer (0, 0, current_message_1
,
8821 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8823 echo_area_buffer
[0] = Qnil
;
8831 current_message_1 (a1
, a2
, a3
, a4
)
8836 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8839 *msg
= make_buffer_string (BEG
, Z
, 1);
8846 /* Push the current message on Vmessage_stack for later restauration
8847 by restore_message. Value is non-zero if the current message isn't
8848 empty. This is a relatively infrequent operation, so it's not
8849 worth optimizing. */
8855 msg
= current_message ();
8856 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8857 return STRINGP (msg
);
8861 /* Restore message display from the top of Vmessage_stack. */
8868 xassert (CONSP (Vmessage_stack
));
8869 msg
= XCAR (Vmessage_stack
);
8871 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8873 message3_nolog (msg
, 0, 0);
8877 /* Handler for record_unwind_protect calling pop_message. */
8880 pop_message_unwind (dummy
)
8887 /* Pop the top-most entry off Vmessage_stack. */
8892 xassert (CONSP (Vmessage_stack
));
8893 Vmessage_stack
= XCDR (Vmessage_stack
);
8897 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8898 exits. If the stack is not empty, we have a missing pop_message
8902 check_message_stack ()
8904 if (!NILP (Vmessage_stack
))
8909 /* Truncate to NCHARS what will be displayed in the echo area the next
8910 time we display it---but don't redisplay it now. */
8913 truncate_echo_area (nchars
)
8917 echo_area_buffer
[0] = Qnil
;
8918 /* A null message buffer means that the frame hasn't really been
8919 initialized yet. Error messages get reported properly by
8920 cmd_error, so this must be just an informative message; toss it. */
8921 else if (!noninteractive
8923 && !NILP (echo_area_buffer
[0]))
8925 struct frame
*sf
= SELECTED_FRAME ();
8926 if (FRAME_MESSAGE_BUF (sf
))
8927 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8932 /* Helper function for truncate_echo_area. Truncate the current
8933 message to at most NCHARS characters. */
8936 truncate_message_1 (nchars
, a2
, a3
, a4
)
8941 if (BEG
+ nchars
< Z
)
8942 del_range (BEG
+ nchars
, Z
);
8944 echo_area_buffer
[0] = Qnil
;
8949 /* Set the current message to a substring of S or STRING.
8951 If STRING is a Lisp string, set the message to the first NBYTES
8952 bytes from STRING. NBYTES zero means use the whole string. If
8953 STRING is multibyte, the message will be displayed multibyte.
8955 If S is not null, set the message to the first LEN bytes of S. LEN
8956 zero means use the whole string. MULTIBYTE_P non-zero means S is
8957 multibyte. Display the message multibyte in that case.
8959 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8960 to t before calling set_message_1 (which calls insert).
8964 set_message (s
, string
, nbytes
, multibyte_p
)
8967 int nbytes
, multibyte_p
;
8969 message_enable_multibyte
8970 = ((s
&& multibyte_p
)
8971 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8973 with_echo_area_buffer (0, -1, set_message_1
,
8974 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8975 message_buf_print
= 0;
8976 help_echo_showing_p
= 0;
8980 /* Helper function for set_message. Arguments have the same meaning
8981 as there, with A1 corresponding to S and A2 corresponding to STRING
8982 This function is called with the echo area buffer being
8986 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8989 EMACS_INT nbytes
, multibyte_p
;
8991 const char *s
= (const char *) a1
;
8992 Lisp_Object string
= a2
;
8994 /* Change multibyteness of the echo buffer appropriately. */
8995 if (message_enable_multibyte
8996 != !NILP (current_buffer
->enable_multibyte_characters
))
8997 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8999 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9001 /* Insert new message at BEG. */
9002 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9004 if (STRINGP (string
))
9009 nbytes
= SBYTES (string
);
9010 nchars
= string_byte_to_char (string
, nbytes
);
9012 /* This function takes care of single/multibyte conversion. We
9013 just have to ensure that the echo area buffer has the right
9014 setting of enable_multibyte_characters. */
9015 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9020 nbytes
= strlen (s
);
9022 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9024 /* Convert from multi-byte to single-byte. */
9026 unsigned char work
[1];
9028 /* Convert a multibyte string to single-byte. */
9029 for (i
= 0; i
< nbytes
; i
+= n
)
9031 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
9032 work
[0] = (ASCII_CHAR_P (c
)
9034 : multibyte_char_to_unibyte (c
, Qnil
));
9035 insert_1_both (work
, 1, 1, 1, 0, 0);
9038 else if (!multibyte_p
9039 && !NILP (current_buffer
->enable_multibyte_characters
))
9041 /* Convert from single-byte to multi-byte. */
9043 const unsigned char *msg
= (const unsigned char *) s
;
9044 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9046 /* Convert a single-byte string to multibyte. */
9047 for (i
= 0; i
< nbytes
; i
++)
9050 c
= unibyte_char_to_multibyte (c
);
9051 n
= CHAR_STRING (c
, str
);
9052 insert_1_both (str
, 1, n
, 1, 0, 0);
9056 insert_1 (s
, nbytes
, 1, 0, 0);
9063 /* Clear messages. CURRENT_P non-zero means clear the current
9064 message. LAST_DISPLAYED_P non-zero means clear the message
9068 clear_message (current_p
, last_displayed_p
)
9069 int current_p
, last_displayed_p
;
9073 echo_area_buffer
[0] = Qnil
;
9074 message_cleared_p
= 1;
9077 if (last_displayed_p
)
9078 echo_area_buffer
[1] = Qnil
;
9080 message_buf_print
= 0;
9083 /* Clear garbaged frames.
9085 This function is used where the old redisplay called
9086 redraw_garbaged_frames which in turn called redraw_frame which in
9087 turn called clear_frame. The call to clear_frame was a source of
9088 flickering. I believe a clear_frame is not necessary. It should
9089 suffice in the new redisplay to invalidate all current matrices,
9090 and ensure a complete redisplay of all windows. */
9093 clear_garbaged_frames ()
9097 Lisp_Object tail
, frame
;
9098 int changed_count
= 0;
9100 FOR_EACH_FRAME (tail
, frame
)
9102 struct frame
*f
= XFRAME (frame
);
9104 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9108 Fredraw_frame (frame
);
9109 f
->force_flush_display_p
= 1;
9111 clear_current_matrices (f
);
9120 ++windows_or_buffers_changed
;
9125 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9126 is non-zero update selected_frame. Value is non-zero if the
9127 mini-windows height has been changed. */
9130 echo_area_display (update_frame_p
)
9133 Lisp_Object mini_window
;
9136 int window_height_changed_p
= 0;
9137 struct frame
*sf
= SELECTED_FRAME ();
9139 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9140 w
= XWINDOW (mini_window
);
9141 f
= XFRAME (WINDOW_FRAME (w
));
9143 /* Don't display if frame is invisible or not yet initialized. */
9144 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9147 #ifdef HAVE_WINDOW_SYSTEM
9148 /* When Emacs starts, selected_frame may be the initial terminal
9149 frame. If we let this through, a message would be displayed on
9151 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9153 #endif /* HAVE_WINDOW_SYSTEM */
9155 /* Redraw garbaged frames. */
9157 clear_garbaged_frames ();
9159 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9161 echo_area_window
= mini_window
;
9162 window_height_changed_p
= display_echo_area (w
);
9163 w
->must_be_updated_p
= 1;
9165 /* Update the display, unless called from redisplay_internal.
9166 Also don't update the screen during redisplay itself. The
9167 update will happen at the end of redisplay, and an update
9168 here could cause confusion. */
9169 if (update_frame_p
&& !redisplaying_p
)
9173 /* If the display update has been interrupted by pending
9174 input, update mode lines in the frame. Due to the
9175 pending input, it might have been that redisplay hasn't
9176 been called, so that mode lines above the echo area are
9177 garbaged. This looks odd, so we prevent it here. */
9178 if (!display_completed
)
9179 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9181 if (window_height_changed_p
9182 /* Don't do this if Emacs is shutting down. Redisplay
9183 needs to run hooks. */
9184 && !NILP (Vrun_hooks
))
9186 /* Must update other windows. Likewise as in other
9187 cases, don't let this update be interrupted by
9189 int count
= SPECPDL_INDEX ();
9190 specbind (Qredisplay_dont_pause
, Qt
);
9191 windows_or_buffers_changed
= 1;
9192 redisplay_internal (0);
9193 unbind_to (count
, Qnil
);
9195 else if (FRAME_WINDOW_P (f
) && n
== 0)
9197 /* Window configuration is the same as before.
9198 Can do with a display update of the echo area,
9199 unless we displayed some mode lines. */
9200 update_single_window (w
, 1);
9201 FRAME_RIF (f
)->flush_display (f
);
9204 update_frame (f
, 1, 1);
9206 /* If cursor is in the echo area, make sure that the next
9207 redisplay displays the minibuffer, so that the cursor will
9208 be replaced with what the minibuffer wants. */
9209 if (cursor_in_echo_area
)
9210 ++windows_or_buffers_changed
;
9213 else if (!EQ (mini_window
, selected_window
))
9214 windows_or_buffers_changed
++;
9216 /* Last displayed message is now the current message. */
9217 echo_area_buffer
[1] = echo_area_buffer
[0];
9218 /* Inform read_char that we're not echoing. */
9219 echo_message_buffer
= Qnil
;
9221 /* Prevent redisplay optimization in redisplay_internal by resetting
9222 this_line_start_pos. This is done because the mini-buffer now
9223 displays the message instead of its buffer text. */
9224 if (EQ (mini_window
, selected_window
))
9225 CHARPOS (this_line_start_pos
) = 0;
9227 return window_height_changed_p
;
9232 /***********************************************************************
9233 Mode Lines and Frame Titles
9234 ***********************************************************************/
9236 /* A buffer for constructing non-propertized mode-line strings and
9237 frame titles in it; allocated from the heap in init_xdisp and
9238 resized as needed in store_mode_line_noprop_char. */
9240 static char *mode_line_noprop_buf
;
9242 /* The buffer's end, and a current output position in it. */
9244 static char *mode_line_noprop_buf_end
;
9245 static char *mode_line_noprop_ptr
;
9247 #define MODE_LINE_NOPROP_LEN(start) \
9248 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9251 MODE_LINE_DISPLAY
= 0,
9257 /* Alist that caches the results of :propertize.
9258 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9259 static Lisp_Object mode_line_proptrans_alist
;
9261 /* List of strings making up the mode-line. */
9262 static Lisp_Object mode_line_string_list
;
9264 /* Base face property when building propertized mode line string. */
9265 static Lisp_Object mode_line_string_face
;
9266 static Lisp_Object mode_line_string_face_prop
;
9269 /* Unwind data for mode line strings */
9271 static Lisp_Object Vmode_line_unwind_vector
;
9274 format_mode_line_unwind_data (struct buffer
*obuf
,
9278 Lisp_Object vector
, tmp
;
9280 /* Reduce consing by keeping one vector in
9281 Vwith_echo_area_save_vector. */
9282 vector
= Vmode_line_unwind_vector
;
9283 Vmode_line_unwind_vector
= Qnil
;
9286 vector
= Fmake_vector (make_number (8), Qnil
);
9288 ASET (vector
, 0, make_number (mode_line_target
));
9289 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9290 ASET (vector
, 2, mode_line_string_list
);
9291 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9292 ASET (vector
, 4, mode_line_string_face
);
9293 ASET (vector
, 5, mode_line_string_face_prop
);
9296 XSETBUFFER (tmp
, obuf
);
9299 ASET (vector
, 6, tmp
);
9300 ASET (vector
, 7, owin
);
9306 unwind_format_mode_line (vector
)
9309 mode_line_target
= XINT (AREF (vector
, 0));
9310 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9311 mode_line_string_list
= AREF (vector
, 2);
9312 if (! EQ (AREF (vector
, 3), Qt
))
9313 mode_line_proptrans_alist
= AREF (vector
, 3);
9314 mode_line_string_face
= AREF (vector
, 4);
9315 mode_line_string_face_prop
= AREF (vector
, 5);
9317 if (!NILP (AREF (vector
, 7)))
9318 /* Select window before buffer, since it may change the buffer. */
9319 Fselect_window (AREF (vector
, 7), Qt
);
9321 if (!NILP (AREF (vector
, 6)))
9323 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9324 ASET (vector
, 6, Qnil
);
9327 Vmode_line_unwind_vector
= vector
;
9332 /* Store a single character C for the frame title in mode_line_noprop_buf.
9333 Re-allocate mode_line_noprop_buf if necessary. */
9337 store_mode_line_noprop_char (char c
)
9339 store_mode_line_noprop_char (c
)
9343 /* If output position has reached the end of the allocated buffer,
9344 double the buffer's size. */
9345 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9347 int len
= MODE_LINE_NOPROP_LEN (0);
9348 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9349 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9350 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9351 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9354 *mode_line_noprop_ptr
++ = c
;
9358 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9359 mode_line_noprop_ptr. STR is the string to store. Do not copy
9360 characters that yield more columns than PRECISION; PRECISION <= 0
9361 means copy the whole string. Pad with spaces until FIELD_WIDTH
9362 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9363 pad. Called from display_mode_element when it is used to build a
9367 store_mode_line_noprop (str
, field_width
, precision
)
9368 const unsigned char *str
;
9369 int field_width
, precision
;
9374 /* Copy at most PRECISION chars from STR. */
9375 nbytes
= strlen (str
);
9376 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9378 store_mode_line_noprop_char (*str
++);
9380 /* Fill up with spaces until FIELD_WIDTH reached. */
9381 while (field_width
> 0
9384 store_mode_line_noprop_char (' ');
9391 /***********************************************************************
9393 ***********************************************************************/
9395 #ifdef HAVE_WINDOW_SYSTEM
9397 /* Set the title of FRAME, if it has changed. The title format is
9398 Vicon_title_format if FRAME is iconified, otherwise it is
9399 frame_title_format. */
9402 x_consider_frame_title (frame
)
9405 struct frame
*f
= XFRAME (frame
);
9407 if (FRAME_WINDOW_P (f
)
9408 || FRAME_MINIBUF_ONLY_P (f
)
9409 || f
->explicit_name
)
9411 /* Do we have more than one visible frame on this X display? */
9418 int count
= SPECPDL_INDEX ();
9420 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9422 Lisp_Object other_frame
= XCAR (tail
);
9423 struct frame
*tf
= XFRAME (other_frame
);
9426 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9427 && !FRAME_MINIBUF_ONLY_P (tf
)
9428 && !EQ (other_frame
, tip_frame
)
9429 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9433 /* Set global variable indicating that multiple frames exist. */
9434 multiple_frames
= CONSP (tail
);
9436 /* Switch to the buffer of selected window of the frame. Set up
9437 mode_line_target so that display_mode_element will output into
9438 mode_line_noprop_buf; then display the title. */
9439 record_unwind_protect (unwind_format_mode_line
,
9440 format_mode_line_unwind_data
9441 (current_buffer
, selected_window
, 0));
9443 Fselect_window (f
->selected_window
, Qt
);
9444 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9445 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9447 mode_line_target
= MODE_LINE_TITLE
;
9448 title_start
= MODE_LINE_NOPROP_LEN (0);
9449 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9450 NULL
, DEFAULT_FACE_ID
);
9451 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9452 len
= MODE_LINE_NOPROP_LEN (title_start
);
9453 title
= mode_line_noprop_buf
+ title_start
;
9454 unbind_to (count
, Qnil
);
9456 /* Set the title only if it's changed. This avoids consing in
9457 the common case where it hasn't. (If it turns out that we've
9458 already wasted too much time by walking through the list with
9459 display_mode_element, then we might need to optimize at a
9460 higher level than this.) */
9461 if (! STRINGP (f
->name
)
9462 || SBYTES (f
->name
) != len
9463 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9468 if (!MINI_WINDOW_P(XWINDOW(f
->selected_window
)))
9471 ns_set_name_as_filename (f
);
9473 x_implicitly_set_name (f
, make_string(title
, len
),
9479 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9484 /* do this also for frames with explicit names */
9485 ns_implicitly_set_icon_type(f
);
9486 ns_set_doc_edited(f
, Fbuffer_modified_p
9487 (XWINDOW (f
->selected_window
)->buffer
), Qnil
);
9493 #endif /* not HAVE_WINDOW_SYSTEM */
9498 /***********************************************************************
9500 ***********************************************************************/
9503 /* Prepare for redisplay by updating menu-bar item lists when
9504 appropriate. This can call eval. */
9507 prepare_menu_bars ()
9510 struct gcpro gcpro1
, gcpro2
;
9512 Lisp_Object tooltip_frame
;
9514 #ifdef HAVE_WINDOW_SYSTEM
9515 tooltip_frame
= tip_frame
;
9517 tooltip_frame
= Qnil
;
9520 /* Update all frame titles based on their buffer names, etc. We do
9521 this before the menu bars so that the buffer-menu will show the
9522 up-to-date frame titles. */
9523 #ifdef HAVE_WINDOW_SYSTEM
9524 if (windows_or_buffers_changed
|| update_mode_lines
)
9526 Lisp_Object tail
, frame
;
9528 FOR_EACH_FRAME (tail
, frame
)
9531 if (!EQ (frame
, tooltip_frame
)
9532 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9533 x_consider_frame_title (frame
);
9536 #endif /* HAVE_WINDOW_SYSTEM */
9538 /* Update the menu bar item lists, if appropriate. This has to be
9539 done before any actual redisplay or generation of display lines. */
9540 all_windows
= (update_mode_lines
9541 || buffer_shared
> 1
9542 || windows_or_buffers_changed
);
9545 Lisp_Object tail
, frame
;
9546 int count
= SPECPDL_INDEX ();
9547 /* 1 means that update_menu_bar has run its hooks
9548 so any further calls to update_menu_bar shouldn't do so again. */
9549 int menu_bar_hooks_run
= 0;
9551 record_unwind_save_match_data ();
9553 FOR_EACH_FRAME (tail
, frame
)
9557 /* Ignore tooltip frame. */
9558 if (EQ (frame
, tooltip_frame
))
9561 /* If a window on this frame changed size, report that to
9562 the user and clear the size-change flag. */
9563 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9565 Lisp_Object functions
;
9567 /* Clear flag first in case we get an error below. */
9568 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9569 functions
= Vwindow_size_change_functions
;
9570 GCPRO2 (tail
, functions
);
9572 while (CONSP (functions
))
9574 if (!EQ (XCAR (functions
), Qt
))
9575 call1 (XCAR (functions
), frame
);
9576 functions
= XCDR (functions
);
9582 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9583 #ifdef HAVE_WINDOW_SYSTEM
9584 update_tool_bar (f
, 0);
9589 unbind_to (count
, Qnil
);
9593 struct frame
*sf
= SELECTED_FRAME ();
9594 update_menu_bar (sf
, 1, 0);
9595 #ifdef HAVE_WINDOW_SYSTEM
9596 update_tool_bar (sf
, 1);
9600 /* Motif needs this. See comment in xmenu.c. Turn it off when
9601 pending_menu_activation is not defined. */
9602 #ifdef USE_X_TOOLKIT
9603 pending_menu_activation
= 0;
9608 /* Update the menu bar item list for frame F. This has to be done
9609 before we start to fill in any display lines, because it can call
9612 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9614 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9615 already ran the menu bar hooks for this redisplay, so there
9616 is no need to run them again. The return value is the
9617 updated value of this flag, to pass to the next call. */
9620 update_menu_bar (f
, save_match_data
, hooks_run
)
9622 int save_match_data
;
9626 register struct window
*w
;
9628 /* If called recursively during a menu update, do nothing. This can
9629 happen when, for instance, an activate-menubar-hook causes a
9631 if (inhibit_menubar_update
)
9634 window
= FRAME_SELECTED_WINDOW (f
);
9635 w
= XWINDOW (window
);
9637 if (FRAME_WINDOW_P (f
)
9639 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9640 || defined (HAVE_NS) || defined (USE_GTK)
9641 FRAME_EXTERNAL_MENU_BAR (f
)
9643 FRAME_MENU_BAR_LINES (f
) > 0
9645 : FRAME_MENU_BAR_LINES (f
) > 0)
9647 /* If the user has switched buffers or windows, we need to
9648 recompute to reflect the new bindings. But we'll
9649 recompute when update_mode_lines is set too; that means
9650 that people can use force-mode-line-update to request
9651 that the menu bar be recomputed. The adverse effect on
9652 the rest of the redisplay algorithm is about the same as
9653 windows_or_buffers_changed anyway. */
9654 if (windows_or_buffers_changed
9655 /* This used to test w->update_mode_line, but we believe
9656 there is no need to recompute the menu in that case. */
9657 || update_mode_lines
9658 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9659 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9660 != !NILP (w
->last_had_star
))
9661 || ((!NILP (Vtransient_mark_mode
)
9662 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9663 != !NILP (w
->region_showing
)))
9665 struct buffer
*prev
= current_buffer
;
9666 int count
= SPECPDL_INDEX ();
9668 specbind (Qinhibit_menubar_update
, Qt
);
9670 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9671 if (save_match_data
)
9672 record_unwind_save_match_data ();
9673 if (NILP (Voverriding_local_map_menu_flag
))
9675 specbind (Qoverriding_terminal_local_map
, Qnil
);
9676 specbind (Qoverriding_local_map
, Qnil
);
9681 /* Run the Lucid hook. */
9682 safe_run_hooks (Qactivate_menubar_hook
);
9684 /* If it has changed current-menubar from previous value,
9685 really recompute the menu-bar from the value. */
9686 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9687 call0 (Qrecompute_lucid_menubar
);
9689 safe_run_hooks (Qmenu_bar_update_hook
);
9694 XSETFRAME (Vmenu_updating_frame
, f
);
9695 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9697 /* Redisplay the menu bar in case we changed it. */
9698 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9699 || defined (HAVE_NS) || defined (USE_GTK)
9700 if (FRAME_WINDOW_P (f
))
9702 #if defined (HAVE_NS)
9703 /* All frames on Mac OS share the same menubar. So only
9704 the selected frame should be allowed to set it. */
9705 if (f
== SELECTED_FRAME ())
9707 set_frame_menubar (f
, 0, 0);
9710 /* On a terminal screen, the menu bar is an ordinary screen
9711 line, and this makes it get updated. */
9712 w
->update_mode_line
= Qt
;
9713 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9714 /* In the non-toolkit version, the menu bar is an ordinary screen
9715 line, and this makes it get updated. */
9716 w
->update_mode_line
= Qt
;
9717 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9719 unbind_to (count
, Qnil
);
9720 set_buffer_internal_1 (prev
);
9729 /***********************************************************************
9731 ***********************************************************************/
9733 #ifdef HAVE_WINDOW_SYSTEM
9736 Nominal cursor position -- where to draw output.
9737 HPOS and VPOS are window relative glyph matrix coordinates.
9738 X and Y are window relative pixel coordinates. */
9740 struct cursor_pos output_cursor
;
9744 Set the global variable output_cursor to CURSOR. All cursor
9745 positions are relative to updated_window. */
9748 set_output_cursor (cursor
)
9749 struct cursor_pos
*cursor
;
9751 output_cursor
.hpos
= cursor
->hpos
;
9752 output_cursor
.vpos
= cursor
->vpos
;
9753 output_cursor
.x
= cursor
->x
;
9754 output_cursor
.y
= cursor
->y
;
9759 Set a nominal cursor position.
9761 HPOS and VPOS are column/row positions in a window glyph matrix. X
9762 and Y are window text area relative pixel positions.
9764 If this is done during an update, updated_window will contain the
9765 window that is being updated and the position is the future output
9766 cursor position for that window. If updated_window is null, use
9767 selected_window and display the cursor at the given position. */
9770 x_cursor_to (vpos
, hpos
, y
, x
)
9771 int vpos
, hpos
, y
, x
;
9775 /* If updated_window is not set, work on selected_window. */
9779 w
= XWINDOW (selected_window
);
9781 /* Set the output cursor. */
9782 output_cursor
.hpos
= hpos
;
9783 output_cursor
.vpos
= vpos
;
9784 output_cursor
.x
= x
;
9785 output_cursor
.y
= y
;
9787 /* If not called as part of an update, really display the cursor.
9788 This will also set the cursor position of W. */
9789 if (updated_window
== NULL
)
9792 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9793 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9794 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9799 #endif /* HAVE_WINDOW_SYSTEM */
9802 /***********************************************************************
9804 ***********************************************************************/
9806 #ifdef HAVE_WINDOW_SYSTEM
9808 /* Where the mouse was last time we reported a mouse event. */
9810 FRAME_PTR last_mouse_frame
;
9812 /* Tool-bar item index of the item on which a mouse button was pressed
9815 int last_tool_bar_item
;
9819 update_tool_bar_unwind (frame
)
9822 selected_frame
= frame
;
9826 /* Update the tool-bar item list for frame F. This has to be done
9827 before we start to fill in any display lines. Called from
9828 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9829 and restore it here. */
9832 update_tool_bar (f
, save_match_data
)
9834 int save_match_data
;
9836 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
9837 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9839 int do_update
= WINDOWP (f
->tool_bar_window
)
9840 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9848 window
= FRAME_SELECTED_WINDOW (f
);
9849 w
= XWINDOW (window
);
9851 /* If the user has switched buffers or windows, we need to
9852 recompute to reflect the new bindings. But we'll
9853 recompute when update_mode_lines is set too; that means
9854 that people can use force-mode-line-update to request
9855 that the menu bar be recomputed. The adverse effect on
9856 the rest of the redisplay algorithm is about the same as
9857 windows_or_buffers_changed anyway. */
9858 if (windows_or_buffers_changed
9859 || !NILP (w
->update_mode_line
)
9860 || update_mode_lines
9861 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9862 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9863 != !NILP (w
->last_had_star
))
9864 || ((!NILP (Vtransient_mark_mode
)
9865 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9866 != !NILP (w
->region_showing
)))
9868 struct buffer
*prev
= current_buffer
;
9869 int count
= SPECPDL_INDEX ();
9870 Lisp_Object frame
, new_tool_bar
;
9872 struct gcpro gcpro1
;
9874 /* Set current_buffer to the buffer of the selected
9875 window of the frame, so that we get the right local
9877 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9879 /* Save match data, if we must. */
9880 if (save_match_data
)
9881 record_unwind_save_match_data ();
9883 /* Make sure that we don't accidentally use bogus keymaps. */
9884 if (NILP (Voverriding_local_map_menu_flag
))
9886 specbind (Qoverriding_terminal_local_map
, Qnil
);
9887 specbind (Qoverriding_local_map
, Qnil
);
9890 GCPRO1 (new_tool_bar
);
9892 /* We must temporarily set the selected frame to this frame
9893 before calling tool_bar_items, because the calculation of
9894 the tool-bar keymap uses the selected frame (see
9895 `tool-bar-make-keymap' in tool-bar.el). */
9896 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
9897 XSETFRAME (frame
, f
);
9898 selected_frame
= frame
;
9900 /* Build desired tool-bar items from keymaps. */
9901 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9904 /* Redisplay the tool-bar if we changed it. */
9905 if (new_n_tool_bar
!= f
->n_tool_bar_items
9906 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9908 /* Redisplay that happens asynchronously due to an expose event
9909 may access f->tool_bar_items. Make sure we update both
9910 variables within BLOCK_INPUT so no such event interrupts. */
9912 f
->tool_bar_items
= new_tool_bar
;
9913 f
->n_tool_bar_items
= new_n_tool_bar
;
9914 w
->update_mode_line
= Qt
;
9920 unbind_to (count
, Qnil
);
9921 set_buffer_internal_1 (prev
);
9927 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9928 F's desired tool-bar contents. F->tool_bar_items must have
9929 been set up previously by calling prepare_menu_bars. */
9932 build_desired_tool_bar_string (f
)
9935 int i
, size
, size_needed
;
9936 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9937 Lisp_Object image
, plist
, props
;
9939 image
= plist
= props
= Qnil
;
9940 GCPRO3 (image
, plist
, props
);
9942 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9943 Otherwise, make a new string. */
9945 /* The size of the string we might be able to reuse. */
9946 size
= (STRINGP (f
->desired_tool_bar_string
)
9947 ? SCHARS (f
->desired_tool_bar_string
)
9950 /* We need one space in the string for each image. */
9951 size_needed
= f
->n_tool_bar_items
;
9953 /* Reuse f->desired_tool_bar_string, if possible. */
9954 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9955 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9959 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9960 Fremove_text_properties (make_number (0), make_number (size
),
9961 props
, f
->desired_tool_bar_string
);
9964 /* Put a `display' property on the string for the images to display,
9965 put a `menu_item' property on tool-bar items with a value that
9966 is the index of the item in F's tool-bar item vector. */
9967 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9969 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9971 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9972 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9973 int hmargin
, vmargin
, relief
, idx
, end
;
9974 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9976 /* If image is a vector, choose the image according to the
9978 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9979 if (VECTORP (image
))
9983 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9984 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9987 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9988 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9990 xassert (ASIZE (image
) >= idx
);
9991 image
= AREF (image
, idx
);
9996 /* Ignore invalid image specifications. */
9997 if (!valid_image_p (image
))
10000 /* Display the tool-bar button pressed, or depressed. */
10001 plist
= Fcopy_sequence (XCDR (image
));
10003 /* Compute margin and relief to draw. */
10004 relief
= (tool_bar_button_relief
>= 0
10005 ? tool_bar_button_relief
10006 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10007 hmargin
= vmargin
= relief
;
10009 if (INTEGERP (Vtool_bar_button_margin
)
10010 && XINT (Vtool_bar_button_margin
) > 0)
10012 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10013 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10015 else if (CONSP (Vtool_bar_button_margin
))
10017 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10018 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10019 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10021 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10022 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10023 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10026 if (auto_raise_tool_bar_buttons_p
)
10028 /* Add a `:relief' property to the image spec if the item is
10032 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10039 /* If image is selected, display it pressed, i.e. with a
10040 negative relief. If it's not selected, display it with a
10042 plist
= Fplist_put (plist
, QCrelief
,
10044 ? make_number (-relief
)
10045 : make_number (relief
)));
10050 /* Put a margin around the image. */
10051 if (hmargin
|| vmargin
)
10053 if (hmargin
== vmargin
)
10054 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10056 plist
= Fplist_put (plist
, QCmargin
,
10057 Fcons (make_number (hmargin
),
10058 make_number (vmargin
)));
10061 /* If button is not enabled, and we don't have special images
10062 for the disabled state, make the image appear disabled by
10063 applying an appropriate algorithm to it. */
10064 if (!enabled_p
&& idx
< 0)
10065 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10067 /* Put a `display' text property on the string for the image to
10068 display. Put a `menu-item' property on the string that gives
10069 the start of this item's properties in the tool-bar items
10071 image
= Fcons (Qimage
, plist
);
10072 props
= list4 (Qdisplay
, image
,
10073 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10075 /* Let the last image hide all remaining spaces in the tool bar
10076 string. The string can be longer than needed when we reuse a
10077 previous string. */
10078 if (i
+ 1 == f
->n_tool_bar_items
)
10079 end
= SCHARS (f
->desired_tool_bar_string
);
10082 Fadd_text_properties (make_number (i
), make_number (end
),
10083 props
, f
->desired_tool_bar_string
);
10091 /* Display one line of the tool-bar of frame IT->f.
10093 HEIGHT specifies the desired height of the tool-bar line.
10094 If the actual height of the glyph row is less than HEIGHT, the
10095 row's height is increased to HEIGHT, and the icons are centered
10096 vertically in the new height.
10098 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10099 count a final empty row in case the tool-bar width exactly matches
10104 display_tool_bar_line (it
, height
)
10108 struct glyph_row
*row
= it
->glyph_row
;
10109 int max_x
= it
->last_visible_x
;
10110 struct glyph
*last
;
10112 prepare_desired_row (row
);
10113 row
->y
= it
->current_y
;
10115 /* Note that this isn't made use of if the face hasn't a box,
10116 so there's no need to check the face here. */
10117 it
->start_of_box_run_p
= 1;
10119 while (it
->current_x
< max_x
)
10121 int x
, n_glyphs_before
, i
, nglyphs
;
10122 struct it it_before
;
10124 /* Get the next display element. */
10125 if (!get_next_display_element (it
))
10127 /* Don't count empty row if we are counting needed tool-bar lines. */
10128 if (height
< 0 && !it
->hpos
)
10133 /* Produce glyphs. */
10134 n_glyphs_before
= row
->used
[TEXT_AREA
];
10137 PRODUCE_GLYPHS (it
);
10139 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10141 x
= it_before
.current_x
;
10142 while (i
< nglyphs
)
10144 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10146 if (x
+ glyph
->pixel_width
> max_x
)
10148 /* Glyph doesn't fit on line. Backtrack. */
10149 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10151 /* If this is the only glyph on this line, it will never fit on the
10152 toolbar, so skip it. But ensure there is at least one glyph,
10153 so we don't accidentally disable the tool-bar. */
10154 if (n_glyphs_before
== 0
10155 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10161 x
+= glyph
->pixel_width
;
10165 /* Stop at line ends. */
10166 if (ITERATOR_AT_END_OF_LINE_P (it
))
10169 set_iterator_to_next (it
, 1);
10174 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10176 /* Use default face for the border below the tool bar.
10178 FIXME: When auto-resize-tool-bars is grow-only, there is
10179 no additional border below the possibly empty tool-bar lines.
10180 So to make the extra empty lines look "normal", we have to
10181 use the tool-bar face for the border too. */
10182 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10183 it
->face_id
= DEFAULT_FACE_ID
;
10185 extend_face_to_end_of_line (it
);
10186 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10187 last
->right_box_line_p
= 1;
10188 if (last
== row
->glyphs
[TEXT_AREA
])
10189 last
->left_box_line_p
= 1;
10191 /* Make line the desired height and center it vertically. */
10192 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10194 /* Don't add more than one line height. */
10195 height
%= FRAME_LINE_HEIGHT (it
->f
);
10196 it
->max_ascent
+= height
/ 2;
10197 it
->max_descent
+= (height
+ 1) / 2;
10200 compute_line_metrics (it
);
10202 /* If line is empty, make it occupy the rest of the tool-bar. */
10203 if (!row
->displays_text_p
)
10205 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10206 row
->visible_height
= row
->height
;
10207 row
->ascent
= row
->phys_ascent
= 0;
10208 row
->extra_line_spacing
= 0;
10211 row
->full_width_p
= 1;
10212 row
->continued_p
= 0;
10213 row
->truncated_on_left_p
= 0;
10214 row
->truncated_on_right_p
= 0;
10216 it
->current_x
= it
->hpos
= 0;
10217 it
->current_y
+= row
->height
;
10223 /* Max tool-bar height. */
10225 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10226 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10228 /* Value is the number of screen lines needed to make all tool-bar
10229 items of frame F visible. The number of actual rows needed is
10230 returned in *N_ROWS if non-NULL. */
10233 tool_bar_lines_needed (f
, n_rows
)
10237 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10239 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10240 the desired matrix, so use (unused) mode-line row as temporary row to
10241 avoid destroying the first tool-bar row. */
10242 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10244 /* Initialize an iterator for iteration over
10245 F->desired_tool_bar_string in the tool-bar window of frame F. */
10246 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10247 it
.first_visible_x
= 0;
10248 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10249 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10251 while (!ITERATOR_AT_END_P (&it
))
10253 clear_glyph_row (temp_row
);
10254 it
.glyph_row
= temp_row
;
10255 display_tool_bar_line (&it
, -1);
10257 clear_glyph_row (temp_row
);
10259 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10261 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10263 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10267 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10269 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10278 frame
= selected_frame
;
10280 CHECK_FRAME (frame
);
10281 f
= XFRAME (frame
);
10283 if (WINDOWP (f
->tool_bar_window
)
10284 || (w
= XWINDOW (f
->tool_bar_window
),
10285 WINDOW_TOTAL_LINES (w
) > 0))
10287 update_tool_bar (f
, 1);
10288 if (f
->n_tool_bar_items
)
10290 build_desired_tool_bar_string (f
);
10291 nlines
= tool_bar_lines_needed (f
, NULL
);
10295 return make_number (nlines
);
10299 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10300 height should be changed. */
10303 redisplay_tool_bar (f
)
10308 struct glyph_row
*row
;
10310 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
10311 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10312 update_frame_tool_bar (f
);
10316 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10317 do anything. This means you must start with tool-bar-lines
10318 non-zero to get the auto-sizing effect. Or in other words, you
10319 can turn off tool-bars by specifying tool-bar-lines zero. */
10320 if (!WINDOWP (f
->tool_bar_window
)
10321 || (w
= XWINDOW (f
->tool_bar_window
),
10322 WINDOW_TOTAL_LINES (w
) == 0))
10325 /* Set up an iterator for the tool-bar window. */
10326 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10327 it
.first_visible_x
= 0;
10328 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10329 row
= it
.glyph_row
;
10331 /* Build a string that represents the contents of the tool-bar. */
10332 build_desired_tool_bar_string (f
);
10333 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10335 if (f
->n_tool_bar_rows
== 0)
10339 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10340 nlines
!= WINDOW_TOTAL_LINES (w
)))
10342 extern Lisp_Object Qtool_bar_lines
;
10344 int old_height
= WINDOW_TOTAL_LINES (w
);
10346 XSETFRAME (frame
, f
);
10347 Fmodify_frame_parameters (frame
,
10348 Fcons (Fcons (Qtool_bar_lines
,
10349 make_number (nlines
)),
10351 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10353 clear_glyph_matrix (w
->desired_matrix
);
10354 fonts_changed_p
= 1;
10360 /* Display as many lines as needed to display all tool-bar items. */
10362 if (f
->n_tool_bar_rows
> 0)
10364 int border
, rows
, height
, extra
;
10366 if (INTEGERP (Vtool_bar_border
))
10367 border
= XINT (Vtool_bar_border
);
10368 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10369 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10370 else if (EQ (Vtool_bar_border
, Qborder_width
))
10371 border
= f
->border_width
;
10377 rows
= f
->n_tool_bar_rows
;
10378 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10379 extra
= it
.last_visible_y
- border
- height
* rows
;
10381 while (it
.current_y
< it
.last_visible_y
)
10384 if (extra
> 0 && rows
-- > 0)
10386 h
= (extra
+ rows
- 1) / rows
;
10389 display_tool_bar_line (&it
, height
+ h
);
10394 while (it
.current_y
< it
.last_visible_y
)
10395 display_tool_bar_line (&it
, 0);
10398 /* It doesn't make much sense to try scrolling in the tool-bar
10399 window, so don't do it. */
10400 w
->desired_matrix
->no_scrolling_p
= 1;
10401 w
->must_be_updated_p
= 1;
10403 if (!NILP (Vauto_resize_tool_bars
))
10405 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10406 int change_height_p
= 0;
10408 /* If we couldn't display everything, change the tool-bar's
10409 height if there is room for more. */
10410 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10411 && it
.current_y
< max_tool_bar_height
)
10412 change_height_p
= 1;
10414 row
= it
.glyph_row
- 1;
10416 /* If there are blank lines at the end, except for a partially
10417 visible blank line at the end that is smaller than
10418 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10419 if (!row
->displays_text_p
10420 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10421 change_height_p
= 1;
10423 /* If row displays tool-bar items, but is partially visible,
10424 change the tool-bar's height. */
10425 if (row
->displays_text_p
10426 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10427 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10428 change_height_p
= 1;
10430 /* Resize windows as needed by changing the `tool-bar-lines'
10431 frame parameter. */
10432 if (change_height_p
)
10434 extern Lisp_Object Qtool_bar_lines
;
10436 int old_height
= WINDOW_TOTAL_LINES (w
);
10438 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10440 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10441 && !f
->minimize_tool_bar_window_p
)
10442 ? (nlines
> old_height
)
10443 : (nlines
!= old_height
));
10444 f
->minimize_tool_bar_window_p
= 0;
10446 if (change_height_p
)
10448 XSETFRAME (frame
, f
);
10449 Fmodify_frame_parameters (frame
,
10450 Fcons (Fcons (Qtool_bar_lines
,
10451 make_number (nlines
)),
10453 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10455 clear_glyph_matrix (w
->desired_matrix
);
10456 f
->n_tool_bar_rows
= nrows
;
10457 fonts_changed_p
= 1;
10464 f
->minimize_tool_bar_window_p
= 0;
10469 /* Get information about the tool-bar item which is displayed in GLYPH
10470 on frame F. Return in *PROP_IDX the index where tool-bar item
10471 properties start in F->tool_bar_items. Value is zero if
10472 GLYPH doesn't display a tool-bar item. */
10475 tool_bar_item_info (f
, glyph
, prop_idx
)
10477 struct glyph
*glyph
;
10484 /* This function can be called asynchronously, which means we must
10485 exclude any possibility that Fget_text_property signals an
10487 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10488 charpos
= max (0, charpos
);
10490 /* Get the text property `menu-item' at pos. The value of that
10491 property is the start index of this item's properties in
10492 F->tool_bar_items. */
10493 prop
= Fget_text_property (make_number (charpos
),
10494 Qmenu_item
, f
->current_tool_bar_string
);
10495 if (INTEGERP (prop
))
10497 *prop_idx
= XINT (prop
);
10507 /* Get information about the tool-bar item at position X/Y on frame F.
10508 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10509 the current matrix of the tool-bar window of F, or NULL if not
10510 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10511 item in F->tool_bar_items. Value is
10513 -1 if X/Y is not on a tool-bar item
10514 0 if X/Y is on the same item that was highlighted before.
10518 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10521 struct glyph
**glyph
;
10522 int *hpos
, *vpos
, *prop_idx
;
10524 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10525 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10528 /* Find the glyph under X/Y. */
10529 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10530 if (*glyph
== NULL
)
10533 /* Get the start of this tool-bar item's properties in
10534 f->tool_bar_items. */
10535 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10538 /* Is mouse on the highlighted item? */
10539 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10540 && *vpos
>= dpyinfo
->mouse_face_beg_row
10541 && *vpos
<= dpyinfo
->mouse_face_end_row
10542 && (*vpos
> dpyinfo
->mouse_face_beg_row
10543 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10544 && (*vpos
< dpyinfo
->mouse_face_end_row
10545 || *hpos
< dpyinfo
->mouse_face_end_col
10546 || dpyinfo
->mouse_face_past_end
))
10554 Handle mouse button event on the tool-bar of frame F, at
10555 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10556 0 for button release. MODIFIERS is event modifiers for button
10560 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10563 unsigned int modifiers
;
10565 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10566 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10567 int hpos
, vpos
, prop_idx
;
10568 struct glyph
*glyph
;
10569 Lisp_Object enabled_p
;
10571 /* If not on the highlighted tool-bar item, return. */
10572 frame_to_window_pixel_xy (w
, &x
, &y
);
10573 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10576 /* If item is disabled, do nothing. */
10577 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10578 if (NILP (enabled_p
))
10583 /* Show item in pressed state. */
10584 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10585 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10586 last_tool_bar_item
= prop_idx
;
10590 Lisp_Object key
, frame
;
10591 struct input_event event
;
10592 EVENT_INIT (event
);
10594 /* Show item in released state. */
10595 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10596 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10598 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10600 XSETFRAME (frame
, f
);
10601 event
.kind
= TOOL_BAR_EVENT
;
10602 event
.frame_or_window
= frame
;
10604 kbd_buffer_store_event (&event
);
10606 event
.kind
= TOOL_BAR_EVENT
;
10607 event
.frame_or_window
= frame
;
10609 event
.modifiers
= modifiers
;
10610 kbd_buffer_store_event (&event
);
10611 last_tool_bar_item
= -1;
10616 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10617 tool-bar window-relative coordinates X/Y. Called from
10618 note_mouse_highlight. */
10621 note_tool_bar_highlight (f
, x
, y
)
10625 Lisp_Object window
= f
->tool_bar_window
;
10626 struct window
*w
= XWINDOW (window
);
10627 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10629 struct glyph
*glyph
;
10630 struct glyph_row
*row
;
10632 Lisp_Object enabled_p
;
10634 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10635 int mouse_down_p
, rc
;
10637 /* Function note_mouse_highlight is called with negative x(y
10638 values when mouse moves outside of the frame. */
10639 if (x
<= 0 || y
<= 0)
10641 clear_mouse_face (dpyinfo
);
10645 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10648 /* Not on tool-bar item. */
10649 clear_mouse_face (dpyinfo
);
10653 /* On same tool-bar item as before. */
10654 goto set_help_echo
;
10656 clear_mouse_face (dpyinfo
);
10658 /* Mouse is down, but on different tool-bar item? */
10659 mouse_down_p
= (dpyinfo
->grabbed
10660 && f
== last_mouse_frame
10661 && FRAME_LIVE_P (f
));
10663 && last_tool_bar_item
!= prop_idx
)
10666 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10667 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10669 /* If tool-bar item is not enabled, don't highlight it. */
10670 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10671 if (!NILP (enabled_p
))
10673 /* Compute the x-position of the glyph. In front and past the
10674 image is a space. We include this in the highlighted area. */
10675 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10676 for (i
= x
= 0; i
< hpos
; ++i
)
10677 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10679 /* Record this as the current active region. */
10680 dpyinfo
->mouse_face_beg_col
= hpos
;
10681 dpyinfo
->mouse_face_beg_row
= vpos
;
10682 dpyinfo
->mouse_face_beg_x
= x
;
10683 dpyinfo
->mouse_face_beg_y
= row
->y
;
10684 dpyinfo
->mouse_face_past_end
= 0;
10686 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10687 dpyinfo
->mouse_face_end_row
= vpos
;
10688 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10689 dpyinfo
->mouse_face_end_y
= row
->y
;
10690 dpyinfo
->mouse_face_window
= window
;
10691 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10693 /* Display it as active. */
10694 show_mouse_face (dpyinfo
, draw
);
10695 dpyinfo
->mouse_face_image_state
= draw
;
10700 /* Set help_echo_string to a help string to display for this tool-bar item.
10701 XTread_socket does the rest. */
10702 help_echo_object
= help_echo_window
= Qnil
;
10703 help_echo_pos
= -1;
10704 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10705 if (NILP (help_echo_string
))
10706 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10709 #endif /* HAVE_WINDOW_SYSTEM */
10713 /************************************************************************
10714 Horizontal scrolling
10715 ************************************************************************/
10717 static int hscroll_window_tree
P_ ((Lisp_Object
));
10718 static int hscroll_windows
P_ ((Lisp_Object
));
10720 /* For all leaf windows in the window tree rooted at WINDOW, set their
10721 hscroll value so that PT is (i) visible in the window, and (ii) so
10722 that it is not within a certain margin at the window's left and
10723 right border. Value is non-zero if any window's hscroll has been
10727 hscroll_window_tree (window
)
10728 Lisp_Object window
;
10730 int hscrolled_p
= 0;
10731 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10732 int hscroll_step_abs
= 0;
10733 double hscroll_step_rel
= 0;
10735 if (hscroll_relative_p
)
10737 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10738 if (hscroll_step_rel
< 0)
10740 hscroll_relative_p
= 0;
10741 hscroll_step_abs
= 0;
10744 else if (INTEGERP (Vhscroll_step
))
10746 hscroll_step_abs
= XINT (Vhscroll_step
);
10747 if (hscroll_step_abs
< 0)
10748 hscroll_step_abs
= 0;
10751 hscroll_step_abs
= 0;
10753 while (WINDOWP (window
))
10755 struct window
*w
= XWINDOW (window
);
10757 if (WINDOWP (w
->hchild
))
10758 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10759 else if (WINDOWP (w
->vchild
))
10760 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10761 else if (w
->cursor
.vpos
>= 0)
10764 int text_area_width
;
10765 struct glyph_row
*current_cursor_row
10766 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10767 struct glyph_row
*desired_cursor_row
10768 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10769 struct glyph_row
*cursor_row
10770 = (desired_cursor_row
->enabled_p
10771 ? desired_cursor_row
10772 : current_cursor_row
);
10774 text_area_width
= window_box_width (w
, TEXT_AREA
);
10776 /* Scroll when cursor is inside this scroll margin. */
10777 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10779 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10780 && ((XFASTINT (w
->hscroll
)
10781 && w
->cursor
.x
<= h_margin
)
10782 || (cursor_row
->enabled_p
10783 && cursor_row
->truncated_on_right_p
10784 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10788 struct buffer
*saved_current_buffer
;
10792 /* Find point in a display of infinite width. */
10793 saved_current_buffer
= current_buffer
;
10794 current_buffer
= XBUFFER (w
->buffer
);
10796 if (w
== XWINDOW (selected_window
))
10797 pt
= BUF_PT (current_buffer
);
10800 pt
= marker_position (w
->pointm
);
10801 pt
= max (BEGV
, pt
);
10805 /* Move iterator to pt starting at cursor_row->start in
10806 a line with infinite width. */
10807 init_to_row_start (&it
, w
, cursor_row
);
10808 it
.last_visible_x
= INFINITY
;
10809 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10810 current_buffer
= saved_current_buffer
;
10812 /* Position cursor in window. */
10813 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10814 hscroll
= max (0, (it
.current_x
10815 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10816 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10817 : (text_area_width
/ 2))))
10818 / FRAME_COLUMN_WIDTH (it
.f
);
10819 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10821 if (hscroll_relative_p
)
10822 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10825 wanted_x
= text_area_width
10826 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10829 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10833 if (hscroll_relative_p
)
10834 wanted_x
= text_area_width
* hscroll_step_rel
10837 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10840 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10842 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10844 /* Don't call Fset_window_hscroll if value hasn't
10845 changed because it will prevent redisplay
10847 if (XFASTINT (w
->hscroll
) != hscroll
)
10849 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10850 w
->hscroll
= make_number (hscroll
);
10859 /* Value is non-zero if hscroll of any leaf window has been changed. */
10860 return hscrolled_p
;
10864 /* Set hscroll so that cursor is visible and not inside horizontal
10865 scroll margins for all windows in the tree rooted at WINDOW. See
10866 also hscroll_window_tree above. Value is non-zero if any window's
10867 hscroll has been changed. If it has, desired matrices on the frame
10868 of WINDOW are cleared. */
10871 hscroll_windows (window
)
10872 Lisp_Object window
;
10874 int hscrolled_p
= hscroll_window_tree (window
);
10876 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10877 return hscrolled_p
;
10882 /************************************************************************
10884 ************************************************************************/
10886 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10887 to a non-zero value. This is sometimes handy to have in a debugger
10892 /* First and last unchanged row for try_window_id. */
10894 int debug_first_unchanged_at_end_vpos
;
10895 int debug_last_unchanged_at_beg_vpos
;
10897 /* Delta vpos and y. */
10899 int debug_dvpos
, debug_dy
;
10901 /* Delta in characters and bytes for try_window_id. */
10903 int debug_delta
, debug_delta_bytes
;
10905 /* Values of window_end_pos and window_end_vpos at the end of
10908 EMACS_INT debug_end_pos
, debug_end_vpos
;
10910 /* Append a string to W->desired_matrix->method. FMT is a printf
10911 format string. A1...A9 are a supplement for a variable-length
10912 argument list. If trace_redisplay_p is non-zero also printf the
10913 resulting string to stderr. */
10916 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10919 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10922 char *method
= w
->desired_matrix
->method
;
10923 int len
= strlen (method
);
10924 int size
= sizeof w
->desired_matrix
->method
;
10925 int remaining
= size
- len
- 1;
10927 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10928 if (len
&& remaining
)
10931 --remaining
, ++len
;
10934 strncpy (method
+ len
, buffer
, remaining
);
10936 if (trace_redisplay_p
)
10937 fprintf (stderr
, "%p (%s): %s\n",
10939 ((BUFFERP (w
->buffer
)
10940 && STRINGP (XBUFFER (w
->buffer
)->name
))
10941 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10946 #endif /* GLYPH_DEBUG */
10949 /* Value is non-zero if all changes in window W, which displays
10950 current_buffer, are in the text between START and END. START is a
10951 buffer position, END is given as a distance from Z. Used in
10952 redisplay_internal for display optimization. */
10955 text_outside_line_unchanged_p (w
, start
, end
)
10959 int unchanged_p
= 1;
10961 /* If text or overlays have changed, see where. */
10962 if (XFASTINT (w
->last_modified
) < MODIFF
10963 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10965 /* Gap in the line? */
10966 if (GPT
< start
|| Z
- GPT
< end
)
10969 /* Changes start in front of the line, or end after it? */
10971 && (BEG_UNCHANGED
< start
- 1
10972 || END_UNCHANGED
< end
))
10975 /* If selective display, can't optimize if changes start at the
10976 beginning of the line. */
10978 && INTEGERP (current_buffer
->selective_display
)
10979 && XINT (current_buffer
->selective_display
) > 0
10980 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10983 /* If there are overlays at the start or end of the line, these
10984 may have overlay strings with newlines in them. A change at
10985 START, for instance, may actually concern the display of such
10986 overlay strings as well, and they are displayed on different
10987 lines. So, quickly rule out this case. (For the future, it
10988 might be desirable to implement something more telling than
10989 just BEG/END_UNCHANGED.) */
10992 if (BEG
+ BEG_UNCHANGED
== start
10993 && overlay_touches_p (start
))
10995 if (END_UNCHANGED
== end
10996 && overlay_touches_p (Z
- end
))
11001 return unchanged_p
;
11005 /* Do a frame update, taking possible shortcuts into account. This is
11006 the main external entry point for redisplay.
11008 If the last redisplay displayed an echo area message and that message
11009 is no longer requested, we clear the echo area or bring back the
11010 mini-buffer if that is in use. */
11015 redisplay_internal (0);
11020 overlay_arrow_string_or_property (var
)
11025 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11028 return Voverlay_arrow_string
;
11031 /* Return 1 if there are any overlay-arrows in current_buffer. */
11033 overlay_arrow_in_current_buffer_p ()
11037 for (vlist
= Voverlay_arrow_variable_list
;
11039 vlist
= XCDR (vlist
))
11041 Lisp_Object var
= XCAR (vlist
);
11044 if (!SYMBOLP (var
))
11046 val
= find_symbol_value (var
);
11048 && current_buffer
== XMARKER (val
)->buffer
)
11055 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11059 overlay_arrows_changed_p ()
11063 for (vlist
= Voverlay_arrow_variable_list
;
11065 vlist
= XCDR (vlist
))
11067 Lisp_Object var
= XCAR (vlist
);
11068 Lisp_Object val
, pstr
;
11070 if (!SYMBOLP (var
))
11072 val
= find_symbol_value (var
);
11073 if (!MARKERP (val
))
11075 if (! EQ (COERCE_MARKER (val
),
11076 Fget (var
, Qlast_arrow_position
))
11077 || ! (pstr
= overlay_arrow_string_or_property (var
),
11078 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11084 /* Mark overlay arrows to be updated on next redisplay. */
11087 update_overlay_arrows (up_to_date
)
11092 for (vlist
= Voverlay_arrow_variable_list
;
11094 vlist
= XCDR (vlist
))
11096 Lisp_Object var
= XCAR (vlist
);
11098 if (!SYMBOLP (var
))
11101 if (up_to_date
> 0)
11103 Lisp_Object val
= find_symbol_value (var
);
11104 Fput (var
, Qlast_arrow_position
,
11105 COERCE_MARKER (val
));
11106 Fput (var
, Qlast_arrow_string
,
11107 overlay_arrow_string_or_property (var
));
11109 else if (up_to_date
< 0
11110 || !NILP (Fget (var
, Qlast_arrow_position
)))
11112 Fput (var
, Qlast_arrow_position
, Qt
);
11113 Fput (var
, Qlast_arrow_string
, Qt
);
11119 /* Return overlay arrow string to display at row.
11120 Return integer (bitmap number) for arrow bitmap in left fringe.
11121 Return nil if no overlay arrow. */
11124 overlay_arrow_at_row (it
, row
)
11126 struct glyph_row
*row
;
11130 for (vlist
= Voverlay_arrow_variable_list
;
11132 vlist
= XCDR (vlist
))
11134 Lisp_Object var
= XCAR (vlist
);
11137 if (!SYMBOLP (var
))
11140 val
= find_symbol_value (var
);
11143 && current_buffer
== XMARKER (val
)->buffer
11144 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11146 if (FRAME_WINDOW_P (it
->f
)
11147 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11149 #ifdef HAVE_WINDOW_SYSTEM
11150 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11153 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11154 return make_number (fringe_bitmap
);
11157 return make_number (-1); /* Use default arrow bitmap */
11159 return overlay_arrow_string_or_property (var
);
11166 /* Return 1 if point moved out of or into a composition. Otherwise
11167 return 0. PREV_BUF and PREV_PT are the last point buffer and
11168 position. BUF and PT are the current point buffer and position. */
11171 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11172 struct buffer
*prev_buf
, *buf
;
11175 EMACS_INT start
, end
;
11177 Lisp_Object buffer
;
11179 XSETBUFFER (buffer
, buf
);
11180 /* Check a composition at the last point if point moved within the
11182 if (prev_buf
== buf
)
11185 /* Point didn't move. */
11188 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11189 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11190 && COMPOSITION_VALID_P (start
, end
, prop
)
11191 && start
< prev_pt
&& end
> prev_pt
)
11192 /* The last point was within the composition. Return 1 iff
11193 point moved out of the composition. */
11194 return (pt
<= start
|| pt
>= end
);
11197 /* Check a composition at the current point. */
11198 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11199 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11200 && COMPOSITION_VALID_P (start
, end
, prop
)
11201 && start
< pt
&& end
> pt
);
11205 /* Reconsider the setting of B->clip_changed which is displayed
11209 reconsider_clip_changes (w
, b
)
11213 if (b
->clip_changed
11214 && !NILP (w
->window_end_valid
)
11215 && w
->current_matrix
->buffer
== b
11216 && w
->current_matrix
->zv
== BUF_ZV (b
)
11217 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11218 b
->clip_changed
= 0;
11220 /* If display wasn't paused, and W is not a tool bar window, see if
11221 point has been moved into or out of a composition. In that case,
11222 we set b->clip_changed to 1 to force updating the screen. If
11223 b->clip_changed has already been set to 1, we can skip this
11225 if (!b
->clip_changed
11226 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11230 if (w
== XWINDOW (selected_window
))
11231 pt
= BUF_PT (current_buffer
);
11233 pt
= marker_position (w
->pointm
);
11235 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11236 || pt
!= XINT (w
->last_point
))
11237 && check_point_in_composition (w
->current_matrix
->buffer
,
11238 XINT (w
->last_point
),
11239 XBUFFER (w
->buffer
), pt
))
11240 b
->clip_changed
= 1;
11245 /* Select FRAME to forward the values of frame-local variables into C
11246 variables so that the redisplay routines can access those values
11250 select_frame_for_redisplay (frame
)
11253 Lisp_Object tail
, symbol
, val
;
11254 Lisp_Object old
= selected_frame
;
11255 struct Lisp_Symbol
*sym
;
11257 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11259 selected_frame
= frame
;
11263 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11264 if (CONSP (XCAR (tail
))
11265 && (symbol
= XCAR (XCAR (tail
)),
11267 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11269 (BUFFER_LOCAL_VALUEP (val
)))
11270 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11271 /* Use find_symbol_value rather than Fsymbol_value
11272 to avoid an error if it is void. */
11273 find_symbol_value (symbol
);
11274 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11278 #define STOP_POLLING \
11279 do { if (! polling_stopped_here) stop_polling (); \
11280 polling_stopped_here = 1; } while (0)
11282 #define RESUME_POLLING \
11283 do { if (polling_stopped_here) start_polling (); \
11284 polling_stopped_here = 0; } while (0)
11287 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11288 response to any user action; therefore, we should preserve the echo
11289 area. (Actually, our caller does that job.) Perhaps in the future
11290 avoid recentering windows if it is not necessary; currently that
11291 causes some problems. */
11294 redisplay_internal (preserve_echo_area
)
11295 int preserve_echo_area
;
11297 struct window
*w
= XWINDOW (selected_window
);
11300 int must_finish
= 0;
11301 struct text_pos tlbufpos
, tlendpos
;
11302 int number_of_visible_frames
;
11305 int polling_stopped_here
= 0;
11306 Lisp_Object old_frame
= selected_frame
;
11308 /* Non-zero means redisplay has to consider all windows on all
11309 frames. Zero means, only selected_window is considered. */
11310 int consider_all_windows_p
;
11312 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11314 /* No redisplay if running in batch mode or frame is not yet fully
11315 initialized, or redisplay is explicitly turned off by setting
11316 Vinhibit_redisplay. */
11318 || !NILP (Vinhibit_redisplay
))
11321 /* Don't examine these until after testing Vinhibit_redisplay.
11322 When Emacs is shutting down, perhaps because its connection to
11323 X has dropped, we should not look at them at all. */
11324 f
= XFRAME (w
->frame
);
11325 sf
= SELECTED_FRAME ();
11327 if (!f
->glyphs_initialized_p
)
11330 /* The flag redisplay_performed_directly_p is set by
11331 direct_output_for_insert when it already did the whole screen
11332 update necessary. */
11333 if (redisplay_performed_directly_p
)
11335 redisplay_performed_directly_p
= 0;
11336 if (!hscroll_windows (selected_window
))
11340 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11341 if (popup_activated ())
11345 /* I don't think this happens but let's be paranoid. */
11346 if (redisplaying_p
)
11349 /* Record a function that resets redisplaying_p to its old value
11350 when we leave this function. */
11351 count
= SPECPDL_INDEX ();
11352 record_unwind_protect (unwind_redisplay
,
11353 Fcons (make_number (redisplaying_p
), selected_frame
));
11355 specbind (Qinhibit_free_realized_faces
, Qnil
);
11358 Lisp_Object tail
, frame
;
11360 FOR_EACH_FRAME (tail
, frame
)
11362 struct frame
*f
= XFRAME (frame
);
11363 f
->already_hscrolled_p
= 0;
11368 if (!EQ (old_frame
, selected_frame
)
11369 && FRAME_LIVE_P (XFRAME (old_frame
)))
11370 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11371 selected_frame and selected_window to be temporarily out-of-sync so
11372 when we come back here via `goto retry', we need to resync because we
11373 may need to run Elisp code (via prepare_menu_bars). */
11374 select_frame_for_redisplay (old_frame
);
11377 reconsider_clip_changes (w
, current_buffer
);
11378 last_escape_glyph_frame
= NULL
;
11379 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11381 /* If new fonts have been loaded that make a glyph matrix adjustment
11382 necessary, do it. */
11383 if (fonts_changed_p
)
11385 adjust_glyphs (NULL
);
11386 ++windows_or_buffers_changed
;
11387 fonts_changed_p
= 0;
11390 /* If face_change_count is non-zero, init_iterator will free all
11391 realized faces, which includes the faces referenced from current
11392 matrices. So, we can't reuse current matrices in this case. */
11393 if (face_change_count
)
11394 ++windows_or_buffers_changed
;
11396 if (FRAME_TERMCAP_P (sf
)
11397 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11399 /* Since frames on a single ASCII terminal share the same
11400 display area, displaying a different frame means redisplay
11401 the whole thing. */
11402 windows_or_buffers_changed
++;
11403 SET_FRAME_GARBAGED (sf
);
11405 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11407 FRAME_TTY (sf
)->previous_frame
= sf
;
11410 /* Set the visible flags for all frames. Do this before checking
11411 for resized or garbaged frames; they want to know if their frames
11412 are visible. See the comment in frame.h for
11413 FRAME_SAMPLE_VISIBILITY. */
11415 Lisp_Object tail
, frame
;
11417 number_of_visible_frames
= 0;
11419 FOR_EACH_FRAME (tail
, frame
)
11421 struct frame
*f
= XFRAME (frame
);
11423 FRAME_SAMPLE_VISIBILITY (f
);
11424 if (FRAME_VISIBLE_P (f
))
11425 ++number_of_visible_frames
;
11426 clear_desired_matrices (f
);
11431 /* Notice any pending interrupt request to change frame size. */
11432 do_pending_window_change (1);
11434 /* Clear frames marked as garbaged. */
11435 if (frame_garbaged
)
11436 clear_garbaged_frames ();
11438 /* Build menubar and tool-bar items. */
11439 if (NILP (Vmemory_full
))
11440 prepare_menu_bars ();
11442 if (windows_or_buffers_changed
)
11443 update_mode_lines
++;
11445 /* Detect case that we need to write or remove a star in the mode line. */
11446 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11448 w
->update_mode_line
= Qt
;
11449 if (buffer_shared
> 1)
11450 update_mode_lines
++;
11453 /* Avoid invocation of point motion hooks by `current_column' below. */
11454 count1
= SPECPDL_INDEX ();
11455 specbind (Qinhibit_point_motion_hooks
, Qt
);
11457 /* If %c is in the mode line, update it if needed. */
11458 if (!NILP (w
->column_number_displayed
)
11459 /* This alternative quickly identifies a common case
11460 where no change is needed. */
11461 && !(PT
== XFASTINT (w
->last_point
)
11462 && XFASTINT (w
->last_modified
) >= MODIFF
11463 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11464 && (XFASTINT (w
->column_number_displayed
)
11465 != (int) current_column ())) /* iftc */
11466 w
->update_mode_line
= Qt
;
11468 unbind_to (count1
, Qnil
);
11470 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11472 /* The variable buffer_shared is set in redisplay_window and
11473 indicates that we redisplay a buffer in different windows. See
11475 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11476 || cursor_type_changed
);
11478 /* If specs for an arrow have changed, do thorough redisplay
11479 to ensure we remove any arrow that should no longer exist. */
11480 if (overlay_arrows_changed_p ())
11481 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11483 /* Normally the message* functions will have already displayed and
11484 updated the echo area, but the frame may have been trashed, or
11485 the update may have been preempted, so display the echo area
11486 again here. Checking message_cleared_p captures the case that
11487 the echo area should be cleared. */
11488 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11489 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11490 || (message_cleared_p
11491 && minibuf_level
== 0
11492 /* If the mini-window is currently selected, this means the
11493 echo-area doesn't show through. */
11494 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11496 int window_height_changed_p
= echo_area_display (0);
11499 /* If we don't display the current message, don't clear the
11500 message_cleared_p flag, because, if we did, we wouldn't clear
11501 the echo area in the next redisplay which doesn't preserve
11503 if (!display_last_displayed_message_p
)
11504 message_cleared_p
= 0;
11506 if (fonts_changed_p
)
11508 else if (window_height_changed_p
)
11510 consider_all_windows_p
= 1;
11511 ++update_mode_lines
;
11512 ++windows_or_buffers_changed
;
11514 /* If window configuration was changed, frames may have been
11515 marked garbaged. Clear them or we will experience
11516 surprises wrt scrolling. */
11517 if (frame_garbaged
)
11518 clear_garbaged_frames ();
11521 else if (EQ (selected_window
, minibuf_window
)
11522 && (current_buffer
->clip_changed
11523 || XFASTINT (w
->last_modified
) < MODIFF
11524 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11525 && resize_mini_window (w
, 0))
11527 /* Resized active mini-window to fit the size of what it is
11528 showing if its contents might have changed. */
11530 /* FIXME: this causes all frames to be updated, which seems unnecessary
11531 since only the current frame needs to be considered. This function needs
11532 to be rewritten with two variables, consider_all_windows and
11533 consider_all_frames. */
11534 consider_all_windows_p
= 1;
11535 ++windows_or_buffers_changed
;
11536 ++update_mode_lines
;
11538 /* If window configuration was changed, frames may have been
11539 marked garbaged. Clear them or we will experience
11540 surprises wrt scrolling. */
11541 if (frame_garbaged
)
11542 clear_garbaged_frames ();
11546 /* If showing the region, and mark has changed, we must redisplay
11547 the whole window. The assignment to this_line_start_pos prevents
11548 the optimization directly below this if-statement. */
11549 if (((!NILP (Vtransient_mark_mode
)
11550 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11551 != !NILP (w
->region_showing
))
11552 || (!NILP (w
->region_showing
)
11553 && !EQ (w
->region_showing
,
11554 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11555 CHARPOS (this_line_start_pos
) = 0;
11557 /* Optimize the case that only the line containing the cursor in the
11558 selected window has changed. Variables starting with this_ are
11559 set in display_line and record information about the line
11560 containing the cursor. */
11561 tlbufpos
= this_line_start_pos
;
11562 tlendpos
= this_line_end_pos
;
11563 if (!consider_all_windows_p
11564 && CHARPOS (tlbufpos
) > 0
11565 && NILP (w
->update_mode_line
)
11566 && !current_buffer
->clip_changed
11567 && !current_buffer
->prevent_redisplay_optimizations_p
11568 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11569 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11570 /* Make sure recorded data applies to current buffer, etc. */
11571 && this_line_buffer
== current_buffer
11572 && current_buffer
== XBUFFER (w
->buffer
)
11573 && NILP (w
->force_start
)
11574 && NILP (w
->optional_new_start
)
11575 /* Point must be on the line that we have info recorded about. */
11576 && PT
>= CHARPOS (tlbufpos
)
11577 && PT
<= Z
- CHARPOS (tlendpos
)
11578 /* All text outside that line, including its final newline,
11579 must be unchanged */
11580 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11581 CHARPOS (tlendpos
)))
11583 if (CHARPOS (tlbufpos
) > BEGV
11584 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11585 && (CHARPOS (tlbufpos
) == ZV
11586 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11587 /* Former continuation line has disappeared by becoming empty */
11589 else if (XFASTINT (w
->last_modified
) < MODIFF
11590 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11591 || MINI_WINDOW_P (w
))
11593 /* We have to handle the case of continuation around a
11594 wide-column character (See the comment in indent.c around
11597 For instance, in the following case:
11599 -------- Insert --------
11600 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11601 J_I_ ==> J_I_ `^^' are cursors.
11605 As we have to redraw the line above, we should goto cancel. */
11608 int line_height_before
= this_line_pixel_height
;
11610 /* Note that start_display will handle the case that the
11611 line starting at tlbufpos is a continuation lines. */
11612 start_display (&it
, w
, tlbufpos
);
11614 /* Implementation note: It this still necessary? */
11615 if (it
.current_x
!= this_line_start_x
)
11618 TRACE ((stderr
, "trying display optimization 1\n"));
11619 w
->cursor
.vpos
= -1;
11620 overlay_arrow_seen
= 0;
11621 it
.vpos
= this_line_vpos
;
11622 it
.current_y
= this_line_y
;
11623 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11624 display_line (&it
);
11626 /* If line contains point, is not continued,
11627 and ends at same distance from eob as before, we win */
11628 if (w
->cursor
.vpos
>= 0
11629 /* Line is not continued, otherwise this_line_start_pos
11630 would have been set to 0 in display_line. */
11631 && CHARPOS (this_line_start_pos
)
11632 /* Line ends as before. */
11633 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11634 /* Line has same height as before. Otherwise other lines
11635 would have to be shifted up or down. */
11636 && this_line_pixel_height
== line_height_before
)
11638 /* If this is not the window's last line, we must adjust
11639 the charstarts of the lines below. */
11640 if (it
.current_y
< it
.last_visible_y
)
11642 struct glyph_row
*row
11643 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11644 int delta
, delta_bytes
;
11646 if (Z
- CHARPOS (tlendpos
) == ZV
)
11648 /* This line ends at end of (accessible part of)
11649 buffer. There is no newline to count. */
11651 - CHARPOS (tlendpos
)
11652 - MATRIX_ROW_START_CHARPOS (row
));
11653 delta_bytes
= (Z_BYTE
11654 - BYTEPOS (tlendpos
)
11655 - MATRIX_ROW_START_BYTEPOS (row
));
11659 /* This line ends in a newline. Must take
11660 account of the newline and the rest of the
11661 text that follows. */
11663 - CHARPOS (tlendpos
)
11664 - MATRIX_ROW_START_CHARPOS (row
));
11665 delta_bytes
= (Z_BYTE
11666 - BYTEPOS (tlendpos
)
11667 - MATRIX_ROW_START_BYTEPOS (row
));
11670 increment_matrix_positions (w
->current_matrix
,
11671 this_line_vpos
+ 1,
11672 w
->current_matrix
->nrows
,
11673 delta
, delta_bytes
);
11676 /* If this row displays text now but previously didn't,
11677 or vice versa, w->window_end_vpos may have to be
11679 if ((it
.glyph_row
- 1)->displays_text_p
)
11681 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11682 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11684 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11685 && this_line_vpos
> 0)
11686 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11687 w
->window_end_valid
= Qnil
;
11689 /* Update hint: No need to try to scroll in update_window. */
11690 w
->desired_matrix
->no_scrolling_p
= 1;
11693 *w
->desired_matrix
->method
= 0;
11694 debug_method_add (w
, "optimization 1");
11696 #ifdef HAVE_WINDOW_SYSTEM
11697 update_window_fringes (w
, 0);
11704 else if (/* Cursor position hasn't changed. */
11705 PT
== XFASTINT (w
->last_point
)
11706 /* Make sure the cursor was last displayed
11707 in this window. Otherwise we have to reposition it. */
11708 && 0 <= w
->cursor
.vpos
11709 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11713 do_pending_window_change (1);
11715 /* We used to always goto end_of_redisplay here, but this
11716 isn't enough if we have a blinking cursor. */
11717 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11718 goto end_of_redisplay
;
11722 /* If highlighting the region, or if the cursor is in the echo area,
11723 then we can't just move the cursor. */
11724 else if (! (!NILP (Vtransient_mark_mode
)
11725 && !NILP (current_buffer
->mark_active
))
11726 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11727 || highlight_nonselected_windows
)
11728 && NILP (w
->region_showing
)
11729 && NILP (Vshow_trailing_whitespace
)
11730 && !cursor_in_echo_area
)
11733 struct glyph_row
*row
;
11735 /* Skip from tlbufpos to PT and see where it is. Note that
11736 PT may be in invisible text. If so, we will end at the
11737 next visible position. */
11738 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11739 NULL
, DEFAULT_FACE_ID
);
11740 it
.current_x
= this_line_start_x
;
11741 it
.current_y
= this_line_y
;
11742 it
.vpos
= this_line_vpos
;
11744 /* The call to move_it_to stops in front of PT, but
11745 moves over before-strings. */
11746 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11748 if (it
.vpos
== this_line_vpos
11749 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11752 xassert (this_line_vpos
== it
.vpos
);
11753 xassert (this_line_y
== it
.current_y
);
11754 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11756 *w
->desired_matrix
->method
= 0;
11757 debug_method_add (w
, "optimization 3");
11766 /* Text changed drastically or point moved off of line. */
11767 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11770 CHARPOS (this_line_start_pos
) = 0;
11771 consider_all_windows_p
|= buffer_shared
> 1;
11772 ++clear_face_cache_count
;
11773 #ifdef HAVE_WINDOW_SYSTEM
11774 ++clear_image_cache_count
;
11777 /* Build desired matrices, and update the display. If
11778 consider_all_windows_p is non-zero, do it for all windows on all
11779 frames. Otherwise do it for selected_window, only. */
11781 if (consider_all_windows_p
)
11783 Lisp_Object tail
, frame
;
11785 FOR_EACH_FRAME (tail
, frame
)
11786 XFRAME (frame
)->updated_p
= 0;
11788 /* Recompute # windows showing selected buffer. This will be
11789 incremented each time such a window is displayed. */
11792 FOR_EACH_FRAME (tail
, frame
)
11794 struct frame
*f
= XFRAME (frame
);
11796 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11798 if (! EQ (frame
, selected_frame
))
11799 /* Select the frame, for the sake of frame-local
11801 select_frame_for_redisplay (frame
);
11803 /* Mark all the scroll bars to be removed; we'll redeem
11804 the ones we want when we redisplay their windows. */
11805 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11806 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11808 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11809 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11811 /* Any scroll bars which redisplay_windows should have
11812 nuked should now go away. */
11813 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11814 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11816 /* If fonts changed, display again. */
11817 /* ??? rms: I suspect it is a mistake to jump all the way
11818 back to retry here. It should just retry this frame. */
11819 if (fonts_changed_p
)
11822 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11824 /* See if we have to hscroll. */
11825 if (!f
->already_hscrolled_p
)
11827 f
->already_hscrolled_p
= 1;
11828 if (hscroll_windows (f
->root_window
))
11832 /* Prevent various kinds of signals during display
11833 update. stdio is not robust about handling
11834 signals, which can cause an apparent I/O
11836 if (interrupt_input
)
11837 unrequest_sigio ();
11840 /* Update the display. */
11841 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11842 pause
|= update_frame (f
, 0, 0);
11848 if (!EQ (old_frame
, selected_frame
)
11849 && FRAME_LIVE_P (XFRAME (old_frame
)))
11850 /* We played a bit fast-and-loose above and allowed selected_frame
11851 and selected_window to be temporarily out-of-sync but let's make
11852 sure this stays contained. */
11853 select_frame_for_redisplay (old_frame
);
11854 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11858 /* Do the mark_window_display_accurate after all windows have
11859 been redisplayed because this call resets flags in buffers
11860 which are needed for proper redisplay. */
11861 FOR_EACH_FRAME (tail
, frame
)
11863 struct frame
*f
= XFRAME (frame
);
11866 mark_window_display_accurate (f
->root_window
, 1);
11867 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11868 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11873 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11875 Lisp_Object mini_window
;
11876 struct frame
*mini_frame
;
11878 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11879 /* Use list_of_error, not Qerror, so that
11880 we catch only errors and don't run the debugger. */
11881 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11883 redisplay_window_error
);
11885 /* Compare desired and current matrices, perform output. */
11888 /* If fonts changed, display again. */
11889 if (fonts_changed_p
)
11892 /* Prevent various kinds of signals during display update.
11893 stdio is not robust about handling signals,
11894 which can cause an apparent I/O error. */
11895 if (interrupt_input
)
11896 unrequest_sigio ();
11899 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11901 if (hscroll_windows (selected_window
))
11904 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11905 pause
= update_frame (sf
, 0, 0);
11908 /* We may have called echo_area_display at the top of this
11909 function. If the echo area is on another frame, that may
11910 have put text on a frame other than the selected one, so the
11911 above call to update_frame would not have caught it. Catch
11913 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11914 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11916 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11918 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11919 pause
|= update_frame (mini_frame
, 0, 0);
11920 if (!pause
&& hscroll_windows (mini_window
))
11925 /* If display was paused because of pending input, make sure we do a
11926 thorough update the next time. */
11929 /* Prevent the optimization at the beginning of
11930 redisplay_internal that tries a single-line update of the
11931 line containing the cursor in the selected window. */
11932 CHARPOS (this_line_start_pos
) = 0;
11934 /* Let the overlay arrow be updated the next time. */
11935 update_overlay_arrows (0);
11937 /* If we pause after scrolling, some rows in the current
11938 matrices of some windows are not valid. */
11939 if (!WINDOW_FULL_WIDTH_P (w
)
11940 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11941 update_mode_lines
= 1;
11945 if (!consider_all_windows_p
)
11947 /* This has already been done above if
11948 consider_all_windows_p is set. */
11949 mark_window_display_accurate_1 (w
, 1);
11951 /* Say overlay arrows are up to date. */
11952 update_overlay_arrows (1);
11954 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11955 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11958 update_mode_lines
= 0;
11959 windows_or_buffers_changed
= 0;
11960 cursor_type_changed
= 0;
11963 /* Start SIGIO interrupts coming again. Having them off during the
11964 code above makes it less likely one will discard output, but not
11965 impossible, since there might be stuff in the system buffer here.
11966 But it is much hairier to try to do anything about that. */
11967 if (interrupt_input
)
11971 /* If a frame has become visible which was not before, redisplay
11972 again, so that we display it. Expose events for such a frame
11973 (which it gets when becoming visible) don't call the parts of
11974 redisplay constructing glyphs, so simply exposing a frame won't
11975 display anything in this case. So, we have to display these
11976 frames here explicitly. */
11979 Lisp_Object tail
, frame
;
11982 FOR_EACH_FRAME (tail
, frame
)
11984 int this_is_visible
= 0;
11986 if (XFRAME (frame
)->visible
)
11987 this_is_visible
= 1;
11988 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11989 if (XFRAME (frame
)->visible
)
11990 this_is_visible
= 1;
11992 if (this_is_visible
)
11996 if (new_count
!= number_of_visible_frames
)
11997 windows_or_buffers_changed
++;
12000 /* Change frame size now if a change is pending. */
12001 do_pending_window_change (1);
12003 /* If we just did a pending size change, or have additional
12004 visible frames, redisplay again. */
12005 if (windows_or_buffers_changed
&& !pause
)
12008 /* Clear the face cache eventually. */
12009 if (consider_all_windows_p
)
12011 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12013 clear_face_cache (0);
12014 clear_face_cache_count
= 0;
12016 #ifdef HAVE_WINDOW_SYSTEM
12017 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12019 clear_image_caches (Qnil
);
12020 clear_image_cache_count
= 0;
12022 #endif /* HAVE_WINDOW_SYSTEM */
12026 unbind_to (count
, Qnil
);
12031 /* Redisplay, but leave alone any recent echo area message unless
12032 another message has been requested in its place.
12034 This is useful in situations where you need to redisplay but no
12035 user action has occurred, making it inappropriate for the message
12036 area to be cleared. See tracking_off and
12037 wait_reading_process_output for examples of these situations.
12039 FROM_WHERE is an integer saying from where this function was
12040 called. This is useful for debugging. */
12043 redisplay_preserve_echo_area (from_where
)
12046 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12048 if (!NILP (echo_area_buffer
[1]))
12050 /* We have a previously displayed message, but no current
12051 message. Redisplay the previous message. */
12052 display_last_displayed_message_p
= 1;
12053 redisplay_internal (1);
12054 display_last_displayed_message_p
= 0;
12057 redisplay_internal (1);
12059 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12060 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12061 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12065 /* Function registered with record_unwind_protect in
12066 redisplay_internal. Reset redisplaying_p to the value it had
12067 before redisplay_internal was called, and clear
12068 prevent_freeing_realized_faces_p. It also selects the previously
12069 selected frame, unless it has been deleted (by an X connection
12070 failure during redisplay, for example). */
12073 unwind_redisplay (val
)
12076 Lisp_Object old_redisplaying_p
, old_frame
;
12078 old_redisplaying_p
= XCAR (val
);
12079 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12080 old_frame
= XCDR (val
);
12081 if (! EQ (old_frame
, selected_frame
)
12082 && FRAME_LIVE_P (XFRAME (old_frame
)))
12083 select_frame_for_redisplay (old_frame
);
12088 /* Mark the display of window W as accurate or inaccurate. If
12089 ACCURATE_P is non-zero mark display of W as accurate. If
12090 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12091 redisplay_internal is called. */
12094 mark_window_display_accurate_1 (w
, accurate_p
)
12098 if (BUFFERP (w
->buffer
))
12100 struct buffer
*b
= XBUFFER (w
->buffer
);
12103 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12104 w
->last_overlay_modified
12105 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12107 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12111 b
->clip_changed
= 0;
12112 b
->prevent_redisplay_optimizations_p
= 0;
12114 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12115 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12116 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12117 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12119 w
->current_matrix
->buffer
= b
;
12120 w
->current_matrix
->begv
= BUF_BEGV (b
);
12121 w
->current_matrix
->zv
= BUF_ZV (b
);
12123 w
->last_cursor
= w
->cursor
;
12124 w
->last_cursor_off_p
= w
->cursor_off_p
;
12126 if (w
== XWINDOW (selected_window
))
12127 w
->last_point
= make_number (BUF_PT (b
));
12129 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12135 w
->window_end_valid
= w
->buffer
;
12136 w
->update_mode_line
= Qnil
;
12141 /* Mark the display of windows in the window tree rooted at WINDOW as
12142 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12143 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12144 be redisplayed the next time redisplay_internal is called. */
12147 mark_window_display_accurate (window
, accurate_p
)
12148 Lisp_Object window
;
12153 for (; !NILP (window
); window
= w
->next
)
12155 w
= XWINDOW (window
);
12156 mark_window_display_accurate_1 (w
, accurate_p
);
12158 if (!NILP (w
->vchild
))
12159 mark_window_display_accurate (w
->vchild
, accurate_p
);
12160 if (!NILP (w
->hchild
))
12161 mark_window_display_accurate (w
->hchild
, accurate_p
);
12166 update_overlay_arrows (1);
12170 /* Force a thorough redisplay the next time by setting
12171 last_arrow_position and last_arrow_string to t, which is
12172 unequal to any useful value of Voverlay_arrow_... */
12173 update_overlay_arrows (-1);
12178 /* Return value in display table DP (Lisp_Char_Table *) for character
12179 C. Since a display table doesn't have any parent, we don't have to
12180 follow parent. Do not call this function directly but use the
12181 macro DISP_CHAR_VECTOR. */
12184 disp_char_vector (dp
, c
)
12185 struct Lisp_Char_Table
*dp
;
12190 if (ASCII_CHAR_P (c
))
12193 if (SUB_CHAR_TABLE_P (val
))
12194 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12200 XSETCHAR_TABLE (table
, dp
);
12201 val
= char_table_ref (table
, c
);
12210 /***********************************************************************
12212 ***********************************************************************/
12214 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12217 redisplay_windows (window
)
12218 Lisp_Object window
;
12220 while (!NILP (window
))
12222 struct window
*w
= XWINDOW (window
);
12224 if (!NILP (w
->hchild
))
12225 redisplay_windows (w
->hchild
);
12226 else if (!NILP (w
->vchild
))
12227 redisplay_windows (w
->vchild
);
12230 displayed_buffer
= XBUFFER (w
->buffer
);
12231 /* Use list_of_error, not Qerror, so that
12232 we catch only errors and don't run the debugger. */
12233 internal_condition_case_1 (redisplay_window_0
, window
,
12235 redisplay_window_error
);
12243 redisplay_window_error ()
12245 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12250 redisplay_window_0 (window
)
12251 Lisp_Object window
;
12253 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12254 redisplay_window (window
, 0);
12259 redisplay_window_1 (window
)
12260 Lisp_Object window
;
12262 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12263 redisplay_window (window
, 1);
12268 /* Increment GLYPH until it reaches END or CONDITION fails while
12269 adding (GLYPH)->pixel_width to X. */
12271 #define SKIP_GLYPHS(glyph, end, x, condition) \
12274 (x) += (glyph)->pixel_width; \
12277 while ((glyph) < (end) && (condition))
12280 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12281 DELTA is the number of bytes by which positions recorded in ROW
12282 differ from current buffer positions.
12284 Return 0 if cursor is not on this row. 1 otherwise. */
12287 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12289 struct glyph_row
*row
;
12290 struct glyph_matrix
*matrix
;
12291 int delta
, delta_bytes
, dy
, dvpos
;
12293 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12294 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12295 struct glyph
*cursor
= NULL
;
12296 /* The first glyph that starts a sequence of glyphs from string. */
12297 struct glyph
*string_start
;
12298 /* The X coordinate of string_start. */
12299 int string_start_x
;
12300 /* The last known character position. */
12301 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12302 /* The last known character position before string_start. */
12303 int string_before_pos
;
12306 int cursor_from_overlay_pos
= 0;
12307 int pt_old
= PT
- delta
;
12309 /* Skip over glyphs not having an object at the start of the row.
12310 These are special glyphs like truncation marks on terminal
12312 if (row
->displays_text_p
)
12314 && INTEGERP (glyph
->object
)
12315 && glyph
->charpos
< 0)
12317 x
+= glyph
->pixel_width
;
12321 string_start
= NULL
;
12323 && !INTEGERP (glyph
->object
)
12324 && (!BUFFERP (glyph
->object
)
12325 || (last_pos
= glyph
->charpos
) < pt_old
12326 || glyph
->avoid_cursor_p
))
12328 if (! STRINGP (glyph
->object
))
12330 string_start
= NULL
;
12331 x
+= glyph
->pixel_width
;
12333 if (cursor_from_overlay_pos
12334 && last_pos
>= cursor_from_overlay_pos
)
12336 cursor_from_overlay_pos
= 0;
12342 if (string_start
== NULL
)
12344 string_before_pos
= last_pos
;
12345 string_start
= glyph
;
12346 string_start_x
= x
;
12348 /* Skip all glyphs from string. */
12353 if ((cursor
== NULL
|| glyph
> cursor
)
12354 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12355 Qcursor
, (glyph
)->object
),
12357 && (pos
= string_buffer_position (w
, glyph
->object
,
12358 string_before_pos
),
12359 (pos
== 0 /* From overlay */
12360 || pos
== pt_old
)))
12362 /* Estimate overlay buffer position from the buffer
12363 positions of the glyphs before and after the overlay.
12364 Add 1 to last_pos so that if point corresponds to the
12365 glyph right after the overlay, we still use a 'cursor'
12366 property found in that overlay. */
12367 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12368 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12372 x
+= glyph
->pixel_width
;
12375 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12379 if (cursor
!= NULL
)
12384 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12386 /* Scan back over the ellipsis glyphs, decrementing positions. */
12387 while (glyph
> row
->glyphs
[TEXT_AREA
]
12388 && (glyph
- 1)->charpos
== last_pos
)
12389 glyph
--, x
-= glyph
->pixel_width
;
12390 /* That loop always goes one position too far,
12391 including the glyph before the ellipsis.
12392 So scan forward over that one. */
12393 x
+= glyph
->pixel_width
;
12396 else if (string_start
12397 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12399 /* We may have skipped over point because the previous glyphs
12400 are from string. As there's no easy way to know the
12401 character position of the current glyph, find the correct
12402 glyph on point by scanning from string_start again. */
12404 Lisp_Object string
;
12405 struct glyph
*stop
= glyph
;
12408 limit
= make_number (pt_old
+ 1);
12409 glyph
= string_start
;
12410 x
= string_start_x
;
12411 string
= glyph
->object
;
12412 pos
= string_buffer_position (w
, string
, string_before_pos
);
12413 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12414 because we always put cursor after overlay strings. */
12415 while (pos
== 0 && glyph
< stop
)
12417 string
= glyph
->object
;
12418 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12420 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12423 while (glyph
< stop
)
12425 pos
= XINT (Fnext_single_char_property_change
12426 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12429 /* Skip glyphs from the same string. */
12430 string
= glyph
->object
;
12431 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12432 /* Skip glyphs from an overlay. */
12433 while (glyph
< stop
12434 && ! string_buffer_position (w
, glyph
->object
, pos
))
12436 string
= glyph
->object
;
12437 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12441 /* If we reached the end of the line, and end was from a string,
12442 cursor is not on this line. */
12443 if (glyph
== end
&& row
->continued_p
)
12447 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12449 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12450 w
->cursor
.y
= row
->y
+ dy
;
12452 if (w
== XWINDOW (selected_window
))
12454 if (!row
->continued_p
12455 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12458 this_line_buffer
= XBUFFER (w
->buffer
);
12460 CHARPOS (this_line_start_pos
)
12461 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12462 BYTEPOS (this_line_start_pos
)
12463 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12465 CHARPOS (this_line_end_pos
)
12466 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12467 BYTEPOS (this_line_end_pos
)
12468 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12470 this_line_y
= w
->cursor
.y
;
12471 this_line_pixel_height
= row
->height
;
12472 this_line_vpos
= w
->cursor
.vpos
;
12473 this_line_start_x
= row
->x
;
12476 CHARPOS (this_line_start_pos
) = 0;
12483 /* Run window scroll functions, if any, for WINDOW with new window
12484 start STARTP. Sets the window start of WINDOW to that position.
12486 We assume that the window's buffer is really current. */
12488 static INLINE
struct text_pos
12489 run_window_scroll_functions (window
, startp
)
12490 Lisp_Object window
;
12491 struct text_pos startp
;
12493 struct window
*w
= XWINDOW (window
);
12494 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12496 if (current_buffer
!= XBUFFER (w
->buffer
))
12499 if (!NILP (Vwindow_scroll_functions
))
12501 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12502 make_number (CHARPOS (startp
)));
12503 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12504 /* In case the hook functions switch buffers. */
12505 if (current_buffer
!= XBUFFER (w
->buffer
))
12506 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12513 /* Make sure the line containing the cursor is fully visible.
12514 A value of 1 means there is nothing to be done.
12515 (Either the line is fully visible, or it cannot be made so,
12516 or we cannot tell.)
12518 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12519 is higher than window.
12521 A value of 0 means the caller should do scrolling
12522 as if point had gone off the screen. */
12525 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12528 int current_matrix_p
;
12530 struct glyph_matrix
*matrix
;
12531 struct glyph_row
*row
;
12534 if (!make_cursor_line_fully_visible_p
)
12537 /* It's not always possible to find the cursor, e.g, when a window
12538 is full of overlay strings. Don't do anything in that case. */
12539 if (w
->cursor
.vpos
< 0)
12542 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12543 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12545 /* If the cursor row is not partially visible, there's nothing to do. */
12546 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12549 /* If the row the cursor is in is taller than the window's height,
12550 it's not clear what to do, so do nothing. */
12551 window_height
= window_box_height (w
);
12552 if (row
->height
>= window_height
)
12554 if (!force_p
|| MINI_WINDOW_P (w
)
12555 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12561 /* This code used to try to scroll the window just enough to make
12562 the line visible. It returned 0 to say that the caller should
12563 allocate larger glyph matrices. */
12565 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12567 int dy
= row
->height
- row
->visible_height
;
12570 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12572 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12574 int dy
= - (row
->height
- row
->visible_height
);
12577 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12580 /* When we change the cursor y-position of the selected window,
12581 change this_line_y as well so that the display optimization for
12582 the cursor line of the selected window in redisplay_internal uses
12583 the correct y-position. */
12584 if (w
== XWINDOW (selected_window
))
12585 this_line_y
= w
->cursor
.y
;
12587 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12588 redisplay with larger matrices. */
12589 if (matrix
->nrows
< required_matrix_height (w
))
12591 fonts_changed_p
= 1;
12600 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12601 non-zero means only WINDOW is redisplayed in redisplay_internal.
12602 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12603 in redisplay_window to bring a partially visible line into view in
12604 the case that only the cursor has moved.
12606 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12607 last screen line's vertical height extends past the end of the screen.
12611 1 if scrolling succeeded
12613 0 if scrolling didn't find point.
12615 -1 if new fonts have been loaded so that we must interrupt
12616 redisplay, adjust glyph matrices, and try again. */
12622 SCROLLING_NEED_LARGER_MATRICES
12626 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12627 scroll_step
, temp_scroll_step
, last_line_misfit
)
12628 Lisp_Object window
;
12629 int just_this_one_p
;
12630 EMACS_INT scroll_conservatively
, scroll_step
;
12631 int temp_scroll_step
;
12632 int last_line_misfit
;
12634 struct window
*w
= XWINDOW (window
);
12635 struct frame
*f
= XFRAME (w
->frame
);
12636 struct text_pos pos
, startp
;
12638 int this_scroll_margin
, scroll_max
, rc
, height
;
12639 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12640 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12641 Lisp_Object aggressive
;
12642 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12645 debug_method_add (w
, "try_scrolling");
12648 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12650 /* Compute scroll margin height in pixels. We scroll when point is
12651 within this distance from the top or bottom of the window. */
12652 if (scroll_margin
> 0)
12654 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12655 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
12658 this_scroll_margin
= 0;
12660 /* Force scroll_conservatively to have a reasonable value, to avoid
12661 overflow while computing how much to scroll. Note that it's
12662 fairly common for users to supply scroll-conservatively equal to
12663 `most-positive-fixnum', which can be larger than INT_MAX. */
12664 if (scroll_conservatively
> scroll_limit
)
12666 scroll_conservatively
= scroll_limit
;
12667 scroll_max
= INT_MAX
;
12669 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12670 /* Compute how much we should try to scroll maximally to bring
12671 point into view. */
12672 scroll_max
= (max (scroll_step
,
12673 max (scroll_conservatively
, temp_scroll_step
))
12674 * FRAME_LINE_HEIGHT (f
));
12675 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12676 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12677 /* We're trying to scroll because of aggressive scrolling but no
12678 scroll_step is set. Choose an arbitrary one. */
12679 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
12685 /* Decide whether we have to scroll down. */
12686 if (PT
> CHARPOS (startp
))
12688 int scroll_margin_y
;
12690 /* Compute the pixel ypos of the scroll margin, then move it to
12691 either that ypos or PT, whichever comes first. */
12692 start_display (&it
, w
, startp
);
12693 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
12694 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
12695 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
12696 (MOVE_TO_POS
| MOVE_TO_Y
));
12698 if (PT
> CHARPOS (it
.current
.pos
))
12700 /* Point is in the scroll margin at the bottom of the
12701 window, or below. Compute the distance from the scroll
12702 margin to PT, and give up if the distance is greater than
12704 move_it_to (&it
, PT
, -1, it
.last_visible_y
- 1, -1,
12705 MOVE_TO_POS
| MOVE_TO_Y
);
12707 /* To make point visible, we must move the window start down
12708 so that the cursor line is visible, which means we have
12709 to add in the height of the cursor line. */
12710 dy
= line_bottom_y (&it
) - scroll_margin_y
;
12712 if (dy
> scroll_max
)
12713 return SCROLLING_FAILED
;
12721 /* Move the window start down. If scrolling conservatively,
12722 move it just enough down to make point visible. If
12723 scroll_step is set, move it down by scroll_step. */
12724 start_display (&it
, w
, startp
);
12726 if (scroll_conservatively
)
12727 /* Set AMOUNT_TO_SCROLL to at least one line,
12728 and at most scroll_conservatively lines. */
12730 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12731 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12732 else if (scroll_step
|| temp_scroll_step
)
12733 amount_to_scroll
= scroll_max
;
12736 aggressive
= current_buffer
->scroll_up_aggressively
;
12737 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12738 if (NUMBERP (aggressive
))
12740 double float_amount
= XFLOATINT (aggressive
) * height
;
12741 amount_to_scroll
= float_amount
;
12742 if (amount_to_scroll
== 0 && float_amount
> 0)
12743 amount_to_scroll
= 1;
12747 if (amount_to_scroll
<= 0)
12748 return SCROLLING_FAILED
;
12750 /* If moving by amount_to_scroll leaves STARTP unchanged,
12751 move it down one screen line. */
12753 move_it_vertically (&it
, amount_to_scroll
);
12754 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12755 move_it_by_lines (&it
, 1, 1);
12756 startp
= it
.current
.pos
;
12760 struct text_pos scroll_margin_pos
= startp
;
12762 /* See if point is inside the scroll margin at the top of the
12764 if (this_scroll_margin
)
12766 start_display (&it
, w
, startp
);
12767 move_it_vertically (&it
, this_scroll_margin
);
12768 scroll_margin_pos
= it
.current
.pos
;
12771 if (PT
< CHARPOS (scroll_margin_pos
))
12773 /* Point is in the scroll margin at the top of the window or
12774 above what is displayed in the window. */
12777 /* Compute the vertical distance from PT to the scroll
12778 margin position. Give up if distance is greater than
12780 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12781 start_display (&it
, w
, pos
);
12783 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12784 it
.last_visible_y
, -1,
12785 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12786 dy
= it
.current_y
- y0
;
12787 if (dy
> scroll_max
)
12788 return SCROLLING_FAILED
;
12790 /* Compute new window start. */
12791 start_display (&it
, w
, startp
);
12793 if (scroll_conservatively
)
12795 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12796 else if (scroll_step
|| temp_scroll_step
)
12797 amount_to_scroll
= scroll_max
;
12800 aggressive
= current_buffer
->scroll_down_aggressively
;
12801 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12802 if (NUMBERP (aggressive
))
12804 double float_amount
= XFLOATINT (aggressive
) * height
;
12805 amount_to_scroll
= float_amount
;
12806 if (amount_to_scroll
== 0 && float_amount
> 0)
12807 amount_to_scroll
= 1;
12811 if (amount_to_scroll
<= 0)
12812 return SCROLLING_FAILED
;
12814 move_it_vertically_backward (&it
, amount_to_scroll
);
12815 startp
= it
.current
.pos
;
12819 /* Run window scroll functions. */
12820 startp
= run_window_scroll_functions (window
, startp
);
12822 /* Display the window. Give up if new fonts are loaded, or if point
12824 if (!try_window (window
, startp
, 0))
12825 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12826 else if (w
->cursor
.vpos
< 0)
12828 clear_glyph_matrix (w
->desired_matrix
);
12829 rc
= SCROLLING_FAILED
;
12833 /* Maybe forget recorded base line for line number display. */
12834 if (!just_this_one_p
12835 || current_buffer
->clip_changed
12836 || BEG_UNCHANGED
< CHARPOS (startp
))
12837 w
->base_line_number
= Qnil
;
12839 /* If cursor ends up on a partially visible line,
12840 treat that as being off the bottom of the screen. */
12841 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12843 clear_glyph_matrix (w
->desired_matrix
);
12844 ++extra_scroll_margin_lines
;
12847 rc
= SCROLLING_SUCCESS
;
12854 /* Compute a suitable window start for window W if display of W starts
12855 on a continuation line. Value is non-zero if a new window start
12858 The new window start will be computed, based on W's width, starting
12859 from the start of the continued line. It is the start of the
12860 screen line with the minimum distance from the old start W->start. */
12863 compute_window_start_on_continuation_line (w
)
12866 struct text_pos pos
, start_pos
;
12867 int window_start_changed_p
= 0;
12869 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12871 /* If window start is on a continuation line... Window start may be
12872 < BEGV in case there's invisible text at the start of the
12873 buffer (M-x rmail, for example). */
12874 if (CHARPOS (start_pos
) > BEGV
12875 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12878 struct glyph_row
*row
;
12880 /* Handle the case that the window start is out of range. */
12881 if (CHARPOS (start_pos
) < BEGV
)
12882 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12883 else if (CHARPOS (start_pos
) > ZV
)
12884 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12886 /* Find the start of the continued line. This should be fast
12887 because scan_buffer is fast (newline cache). */
12888 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12889 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12890 row
, DEFAULT_FACE_ID
);
12891 reseat_at_previous_visible_line_start (&it
);
12893 /* If the line start is "too far" away from the window start,
12894 say it takes too much time to compute a new window start. */
12895 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12896 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12898 int min_distance
, distance
;
12900 /* Move forward by display lines to find the new window
12901 start. If window width was enlarged, the new start can
12902 be expected to be > the old start. If window width was
12903 decreased, the new window start will be < the old start.
12904 So, we're looking for the display line start with the
12905 minimum distance from the old window start. */
12906 pos
= it
.current
.pos
;
12907 min_distance
= INFINITY
;
12908 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12909 distance
< min_distance
)
12911 min_distance
= distance
;
12912 pos
= it
.current
.pos
;
12913 move_it_by_lines (&it
, 1, 0);
12916 /* Set the window start there. */
12917 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12918 window_start_changed_p
= 1;
12922 return window_start_changed_p
;
12926 /* Try cursor movement in case text has not changed in window WINDOW,
12927 with window start STARTP. Value is
12929 CURSOR_MOVEMENT_SUCCESS if successful
12931 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12933 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12934 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12935 we want to scroll as if scroll-step were set to 1. See the code.
12937 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12938 which case we have to abort this redisplay, and adjust matrices
12943 CURSOR_MOVEMENT_SUCCESS
,
12944 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12945 CURSOR_MOVEMENT_MUST_SCROLL
,
12946 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12950 try_cursor_movement (window
, startp
, scroll_step
)
12951 Lisp_Object window
;
12952 struct text_pos startp
;
12955 struct window
*w
= XWINDOW (window
);
12956 struct frame
*f
= XFRAME (w
->frame
);
12957 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12960 if (inhibit_try_cursor_movement
)
12964 /* Handle case where text has not changed, only point, and it has
12965 not moved off the frame. */
12966 if (/* Point may be in this window. */
12967 PT
>= CHARPOS (startp
)
12968 /* Selective display hasn't changed. */
12969 && !current_buffer
->clip_changed
12970 /* Function force-mode-line-update is used to force a thorough
12971 redisplay. It sets either windows_or_buffers_changed or
12972 update_mode_lines. So don't take a shortcut here for these
12974 && !update_mode_lines
12975 && !windows_or_buffers_changed
12976 && !cursor_type_changed
12977 /* Can't use this case if highlighting a region. When a
12978 region exists, cursor movement has to do more than just
12980 && !(!NILP (Vtransient_mark_mode
)
12981 && !NILP (current_buffer
->mark_active
))
12982 && NILP (w
->region_showing
)
12983 && NILP (Vshow_trailing_whitespace
)
12984 /* Right after splitting windows, last_point may be nil. */
12985 && INTEGERP (w
->last_point
)
12986 /* This code is not used for mini-buffer for the sake of the case
12987 of redisplaying to replace an echo area message; since in
12988 that case the mini-buffer contents per se are usually
12989 unchanged. This code is of no real use in the mini-buffer
12990 since the handling of this_line_start_pos, etc., in redisplay
12991 handles the same cases. */
12992 && !EQ (window
, minibuf_window
)
12993 /* When splitting windows or for new windows, it happens that
12994 redisplay is called with a nil window_end_vpos or one being
12995 larger than the window. This should really be fixed in
12996 window.c. I don't have this on my list, now, so we do
12997 approximately the same as the old redisplay code. --gerd. */
12998 && INTEGERP (w
->window_end_vpos
)
12999 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13000 && (FRAME_WINDOW_P (f
)
13001 || !overlay_arrow_in_current_buffer_p ()))
13003 int this_scroll_margin
, top_scroll_margin
;
13004 struct glyph_row
*row
= NULL
;
13007 debug_method_add (w
, "cursor movement");
13010 /* Scroll if point within this distance from the top or bottom
13011 of the window. This is a pixel value. */
13012 if (scroll_margin
> 0)
13014 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13015 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13018 this_scroll_margin
= 0;
13020 top_scroll_margin
= this_scroll_margin
;
13021 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13022 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13024 /* Start with the row the cursor was displayed during the last
13025 not paused redisplay. Give up if that row is not valid. */
13026 if (w
->last_cursor
.vpos
< 0
13027 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13028 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13031 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13032 if (row
->mode_line_p
)
13034 if (!row
->enabled_p
)
13035 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13038 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13041 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13043 if (PT
> XFASTINT (w
->last_point
))
13045 /* Point has moved forward. */
13046 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13047 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13049 xassert (row
->enabled_p
);
13053 /* The end position of a row equals the start position
13054 of the next row. If PT is there, we would rather
13055 display it in the next line. */
13056 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13057 && MATRIX_ROW_END_CHARPOS (row
) == PT
13058 && !cursor_row_p (w
, row
))
13061 /* If within the scroll margin, scroll. Note that
13062 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13063 the next line would be drawn, and that
13064 this_scroll_margin can be zero. */
13065 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13066 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13067 /* Line is completely visible last line in window
13068 and PT is to be set in the next line. */
13069 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13070 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13071 && !row
->ends_at_zv_p
13072 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13075 else if (PT
< XFASTINT (w
->last_point
))
13077 /* Cursor has to be moved backward. Note that PT >=
13078 CHARPOS (startp) because of the outer if-statement. */
13079 while (!row
->mode_line_p
13080 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13081 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13082 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13083 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13084 row
> w
->current_matrix
->rows
13085 && (row
-1)->ends_in_newline_from_string_p
))))
13086 && (row
->y
> top_scroll_margin
13087 || CHARPOS (startp
) == BEGV
))
13089 xassert (row
->enabled_p
);
13093 /* Consider the following case: Window starts at BEGV,
13094 there is invisible, intangible text at BEGV, so that
13095 display starts at some point START > BEGV. It can
13096 happen that we are called with PT somewhere between
13097 BEGV and START. Try to handle that case. */
13098 if (row
< w
->current_matrix
->rows
13099 || row
->mode_line_p
)
13101 row
= w
->current_matrix
->rows
;
13102 if (row
->mode_line_p
)
13106 /* Due to newlines in overlay strings, we may have to
13107 skip forward over overlay strings. */
13108 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13109 && MATRIX_ROW_END_CHARPOS (row
) == PT
13110 && !cursor_row_p (w
, row
))
13113 /* If within the scroll margin, scroll. */
13114 if (row
->y
< top_scroll_margin
13115 && CHARPOS (startp
) != BEGV
)
13120 /* Cursor did not move. So don't scroll even if cursor line
13121 is partially visible, as it was so before. */
13122 rc
= CURSOR_MOVEMENT_SUCCESS
;
13125 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13126 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13128 /* if PT is not in the glyph row, give up. */
13129 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13131 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13132 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13133 && make_cursor_line_fully_visible_p
)
13135 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13136 && !row
->ends_at_zv_p
13137 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13138 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13139 else if (row
->height
> window_box_height (w
))
13141 /* If we end up in a partially visible line, let's
13142 make it fully visible, except when it's taller
13143 than the window, in which case we can't do much
13146 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13150 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13151 if (!cursor_row_fully_visible_p (w
, 0, 1))
13152 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13154 rc
= CURSOR_MOVEMENT_SUCCESS
;
13158 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13163 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13165 rc
= CURSOR_MOVEMENT_SUCCESS
;
13170 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13171 && MATRIX_ROW_START_CHARPOS (row
) == PT
13172 && cursor_row_p (w
, row
));
13181 set_vertical_scroll_bar (w
)
13184 int start
, end
, whole
;
13186 /* Calculate the start and end positions for the current window.
13187 At some point, it would be nice to choose between scrollbars
13188 which reflect the whole buffer size, with special markers
13189 indicating narrowing, and scrollbars which reflect only the
13192 Note that mini-buffers sometimes aren't displaying any text. */
13193 if (!MINI_WINDOW_P (w
)
13194 || (w
== XWINDOW (minibuf_window
)
13195 && NILP (echo_area_buffer
[0])))
13197 struct buffer
*buf
= XBUFFER (w
->buffer
);
13198 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13199 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13200 /* I don't think this is guaranteed to be right. For the
13201 moment, we'll pretend it is. */
13202 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13206 if (whole
< (end
- start
))
13207 whole
= end
- start
;
13210 start
= end
= whole
= 0;
13212 /* Indicate what this scroll bar ought to be displaying now. */
13213 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13214 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13215 (w
, end
- start
, whole
, start
);
13219 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13220 selected_window is redisplayed.
13222 We can return without actually redisplaying the window if
13223 fonts_changed_p is nonzero. In that case, redisplay_internal will
13227 redisplay_window (window
, just_this_one_p
)
13228 Lisp_Object window
;
13229 int just_this_one_p
;
13231 struct window
*w
= XWINDOW (window
);
13232 struct frame
*f
= XFRAME (w
->frame
);
13233 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13234 struct buffer
*old
= current_buffer
;
13235 struct text_pos lpoint
, opoint
, startp
;
13236 int update_mode_line
;
13239 /* Record it now because it's overwritten. */
13240 int current_matrix_up_to_date_p
= 0;
13241 int used_current_matrix_p
= 0;
13242 /* This is less strict than current_matrix_up_to_date_p.
13243 It indictes that the buffer contents and narrowing are unchanged. */
13244 int buffer_unchanged_p
= 0;
13245 int temp_scroll_step
= 0;
13246 int count
= SPECPDL_INDEX ();
13248 int centering_position
= -1;
13249 int last_line_misfit
= 0;
13250 int beg_unchanged
, end_unchanged
;
13252 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13255 /* W must be a leaf window here. */
13256 xassert (!NILP (w
->buffer
));
13258 *w
->desired_matrix
->method
= 0;
13262 reconsider_clip_changes (w
, buffer
);
13264 /* Has the mode line to be updated? */
13265 update_mode_line
= (!NILP (w
->update_mode_line
)
13266 || update_mode_lines
13267 || buffer
->clip_changed
13268 || buffer
->prevent_redisplay_optimizations_p
);
13270 if (MINI_WINDOW_P (w
))
13272 if (w
== XWINDOW (echo_area_window
)
13273 && !NILP (echo_area_buffer
[0]))
13275 if (update_mode_line
)
13276 /* We may have to update a tty frame's menu bar or a
13277 tool-bar. Example `M-x C-h C-h C-g'. */
13278 goto finish_menu_bars
;
13280 /* We've already displayed the echo area glyphs in this window. */
13281 goto finish_scroll_bars
;
13283 else if ((w
!= XWINDOW (minibuf_window
)
13284 || minibuf_level
== 0)
13285 /* When buffer is nonempty, redisplay window normally. */
13286 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13287 /* Quail displays non-mini buffers in minibuffer window.
13288 In that case, redisplay the window normally. */
13289 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13291 /* W is a mini-buffer window, but it's not active, so clear
13293 int yb
= window_text_bottom_y (w
);
13294 struct glyph_row
*row
;
13297 for (y
= 0, row
= w
->desired_matrix
->rows
;
13299 y
+= row
->height
, ++row
)
13300 blank_row (w
, row
, y
);
13301 goto finish_scroll_bars
;
13304 clear_glyph_matrix (w
->desired_matrix
);
13307 /* Otherwise set up data on this window; select its buffer and point
13309 /* Really select the buffer, for the sake of buffer-local
13311 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13313 current_matrix_up_to_date_p
13314 = (!NILP (w
->window_end_valid
)
13315 && !current_buffer
->clip_changed
13316 && !current_buffer
->prevent_redisplay_optimizations_p
13317 && XFASTINT (w
->last_modified
) >= MODIFF
13318 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13320 /* Run the window-bottom-change-functions
13321 if it is possible that the text on the screen has changed
13322 (either due to modification of the text, or any other reason). */
13323 if (!current_matrix_up_to_date_p
13324 && !NILP (Vwindow_text_change_functions
))
13326 safe_run_hooks (Qwindow_text_change_functions
);
13330 beg_unchanged
= BEG_UNCHANGED
;
13331 end_unchanged
= END_UNCHANGED
;
13333 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13335 specbind (Qinhibit_point_motion_hooks
, Qt
);
13338 = (!NILP (w
->window_end_valid
)
13339 && !current_buffer
->clip_changed
13340 && XFASTINT (w
->last_modified
) >= MODIFF
13341 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13343 /* When windows_or_buffers_changed is non-zero, we can't rely on
13344 the window end being valid, so set it to nil there. */
13345 if (windows_or_buffers_changed
)
13347 /* If window starts on a continuation line, maybe adjust the
13348 window start in case the window's width changed. */
13349 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13350 compute_window_start_on_continuation_line (w
);
13352 w
->window_end_valid
= Qnil
;
13355 /* Some sanity checks. */
13356 CHECK_WINDOW_END (w
);
13357 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13359 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13362 /* If %c is in mode line, update it if needed. */
13363 if (!NILP (w
->column_number_displayed
)
13364 /* This alternative quickly identifies a common case
13365 where no change is needed. */
13366 && !(PT
== XFASTINT (w
->last_point
)
13367 && XFASTINT (w
->last_modified
) >= MODIFF
13368 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13369 && (XFASTINT (w
->column_number_displayed
)
13370 != (int) current_column ())) /* iftc */
13371 update_mode_line
= 1;
13373 /* Count number of windows showing the selected buffer. An indirect
13374 buffer counts as its base buffer. */
13375 if (!just_this_one_p
)
13377 struct buffer
*current_base
, *window_base
;
13378 current_base
= current_buffer
;
13379 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13380 if (current_base
->base_buffer
)
13381 current_base
= current_base
->base_buffer
;
13382 if (window_base
->base_buffer
)
13383 window_base
= window_base
->base_buffer
;
13384 if (current_base
== window_base
)
13388 /* Point refers normally to the selected window. For any other
13389 window, set up appropriate value. */
13390 if (!EQ (window
, selected_window
))
13392 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13393 int new_pt_byte
= marker_byte_position (w
->pointm
);
13397 new_pt_byte
= BEGV_BYTE
;
13398 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13400 else if (new_pt
> (ZV
- 1))
13403 new_pt_byte
= ZV_BYTE
;
13404 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13407 /* We don't use SET_PT so that the point-motion hooks don't run. */
13408 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13411 /* If any of the character widths specified in the display table
13412 have changed, invalidate the width run cache. It's true that
13413 this may be a bit late to catch such changes, but the rest of
13414 redisplay goes (non-fatally) haywire when the display table is
13415 changed, so why should we worry about doing any better? */
13416 if (current_buffer
->width_run_cache
)
13418 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13420 if (! disptab_matches_widthtab (disptab
,
13421 XVECTOR (current_buffer
->width_table
)))
13423 invalidate_region_cache (current_buffer
,
13424 current_buffer
->width_run_cache
,
13426 recompute_width_table (current_buffer
, disptab
);
13430 /* If window-start is screwed up, choose a new one. */
13431 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13434 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13436 /* If someone specified a new starting point but did not insist,
13437 check whether it can be used. */
13438 if (!NILP (w
->optional_new_start
)
13439 && CHARPOS (startp
) >= BEGV
13440 && CHARPOS (startp
) <= ZV
)
13442 w
->optional_new_start
= Qnil
;
13443 start_display (&it
, w
, startp
);
13444 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13445 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13446 if (IT_CHARPOS (it
) == PT
)
13447 w
->force_start
= Qt
;
13448 /* IT may overshoot PT if text at PT is invisible. */
13449 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13450 w
->force_start
= Qt
;
13455 /* Handle case where place to start displaying has been specified,
13456 unless the specified location is outside the accessible range. */
13457 if (!NILP (w
->force_start
)
13458 || w
->frozen_window_start_p
)
13460 /* We set this later on if we have to adjust point. */
13463 w
->force_start
= Qnil
;
13465 w
->window_end_valid
= Qnil
;
13467 /* Forget any recorded base line for line number display. */
13468 if (!buffer_unchanged_p
)
13469 w
->base_line_number
= Qnil
;
13471 /* Redisplay the mode line. Select the buffer properly for that.
13472 Also, run the hook window-scroll-functions
13473 because we have scrolled. */
13474 /* Note, we do this after clearing force_start because
13475 if there's an error, it is better to forget about force_start
13476 than to get into an infinite loop calling the hook functions
13477 and having them get more errors. */
13478 if (!update_mode_line
13479 || ! NILP (Vwindow_scroll_functions
))
13481 update_mode_line
= 1;
13482 w
->update_mode_line
= Qt
;
13483 startp
= run_window_scroll_functions (window
, startp
);
13486 w
->last_modified
= make_number (0);
13487 w
->last_overlay_modified
= make_number (0);
13488 if (CHARPOS (startp
) < BEGV
)
13489 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13490 else if (CHARPOS (startp
) > ZV
)
13491 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13493 /* Redisplay, then check if cursor has been set during the
13494 redisplay. Give up if new fonts were loaded. */
13495 /* We used to issue a CHECK_MARGINS argument to try_window here,
13496 but this causes scrolling to fail when point begins inside
13497 the scroll margin (bug#148) -- cyd */
13498 if (!try_window (window
, startp
, 0))
13500 w
->force_start
= Qt
;
13501 clear_glyph_matrix (w
->desired_matrix
);
13502 goto need_larger_matrices
;
13505 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13507 /* If point does not appear, try to move point so it does
13508 appear. The desired matrix has been built above, so we
13509 can use it here. */
13510 new_vpos
= window_box_height (w
) / 2;
13513 if (!cursor_row_fully_visible_p (w
, 0, 0))
13515 /* Point does appear, but on a line partly visible at end of window.
13516 Move it back to a fully-visible line. */
13517 new_vpos
= window_box_height (w
);
13520 /* If we need to move point for either of the above reasons,
13521 now actually do it. */
13524 struct glyph_row
*row
;
13526 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13527 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13530 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13531 MATRIX_ROW_START_BYTEPOS (row
));
13533 if (w
!= XWINDOW (selected_window
))
13534 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13535 else if (current_buffer
== old
)
13536 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13538 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13540 /* If we are highlighting the region, then we just changed
13541 the region, so redisplay to show it. */
13542 if (!NILP (Vtransient_mark_mode
)
13543 && !NILP (current_buffer
->mark_active
))
13545 clear_glyph_matrix (w
->desired_matrix
);
13546 if (!try_window (window
, startp
, 0))
13547 goto need_larger_matrices
;
13552 debug_method_add (w
, "forced window start");
13557 /* Handle case where text has not changed, only point, and it has
13558 not moved off the frame, and we are not retrying after hscroll.
13559 (current_matrix_up_to_date_p is nonzero when retrying.) */
13560 if (current_matrix_up_to_date_p
13561 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13562 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13566 case CURSOR_MOVEMENT_SUCCESS
:
13567 used_current_matrix_p
= 1;
13570 #if 0 /* try_cursor_movement never returns this value. */
13571 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13572 goto need_larger_matrices
;
13575 case CURSOR_MOVEMENT_MUST_SCROLL
:
13576 goto try_to_scroll
;
13582 /* If current starting point was originally the beginning of a line
13583 but no longer is, find a new starting point. */
13584 else if (!NILP (w
->start_at_line_beg
)
13585 && !(CHARPOS (startp
) <= BEGV
13586 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13589 debug_method_add (w
, "recenter 1");
13594 /* Try scrolling with try_window_id. Value is > 0 if update has
13595 been done, it is -1 if we know that the same window start will
13596 not work. It is 0 if unsuccessful for some other reason. */
13597 else if ((tem
= try_window_id (w
)) != 0)
13600 debug_method_add (w
, "try_window_id %d", tem
);
13603 if (fonts_changed_p
)
13604 goto need_larger_matrices
;
13608 /* Otherwise try_window_id has returned -1 which means that we
13609 don't want the alternative below this comment to execute. */
13611 else if (CHARPOS (startp
) >= BEGV
13612 && CHARPOS (startp
) <= ZV
13613 && PT
>= CHARPOS (startp
)
13614 && (CHARPOS (startp
) < ZV
13615 /* Avoid starting at end of buffer. */
13616 || CHARPOS (startp
) == BEGV
13617 || (XFASTINT (w
->last_modified
) >= MODIFF
13618 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13621 /* If first window line is a continuation line, and window start
13622 is inside the modified region, but the first change is before
13623 current window start, we must select a new window start.
13625 However, if this is the result of a down-mouse event (e.g. by
13626 extending the mouse-drag-overlay), we don't want to select a
13627 new window start, since that would change the position under
13628 the mouse, resulting in an unwanted mouse-movement rather
13629 than a simple mouse-click. */
13630 if (NILP (w
->start_at_line_beg
)
13631 && NILP (do_mouse_tracking
)
13632 && CHARPOS (startp
) > BEGV
13633 && CHARPOS (startp
) > BEG
+ beg_unchanged
13634 && CHARPOS (startp
) <= Z
- end_unchanged
13635 /* Even if w->start_at_line_beg is nil, a new window may
13636 start at a line_beg, since that's how set_buffer_window
13637 sets it. So, we need to check the return value of
13638 compute_window_start_on_continuation_line. (See also
13640 && XMARKER (w
->start
)->buffer
== current_buffer
13641 && compute_window_start_on_continuation_line (w
))
13643 w
->force_start
= Qt
;
13644 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13649 debug_method_add (w
, "same window start");
13652 /* Try to redisplay starting at same place as before.
13653 If point has not moved off frame, accept the results. */
13654 if (!current_matrix_up_to_date_p
13655 /* Don't use try_window_reusing_current_matrix in this case
13656 because a window scroll function can have changed the
13658 || !NILP (Vwindow_scroll_functions
)
13659 || MINI_WINDOW_P (w
)
13660 || !(used_current_matrix_p
13661 = try_window_reusing_current_matrix (w
)))
13663 IF_DEBUG (debug_method_add (w
, "1"));
13664 if (try_window (window
, startp
, 1) < 0)
13665 /* -1 means we need to scroll.
13666 0 means we need new matrices, but fonts_changed_p
13667 is set in that case, so we will detect it below. */
13668 goto try_to_scroll
;
13671 if (fonts_changed_p
)
13672 goto need_larger_matrices
;
13674 if (w
->cursor
.vpos
>= 0)
13676 if (!just_this_one_p
13677 || current_buffer
->clip_changed
13678 || BEG_UNCHANGED
< CHARPOS (startp
))
13679 /* Forget any recorded base line for line number display. */
13680 w
->base_line_number
= Qnil
;
13682 if (!cursor_row_fully_visible_p (w
, 1, 0))
13684 clear_glyph_matrix (w
->desired_matrix
);
13685 last_line_misfit
= 1;
13687 /* Drop through and scroll. */
13692 clear_glyph_matrix (w
->desired_matrix
);
13697 w
->last_modified
= make_number (0);
13698 w
->last_overlay_modified
= make_number (0);
13700 /* Redisplay the mode line. Select the buffer properly for that. */
13701 if (!update_mode_line
)
13703 update_mode_line
= 1;
13704 w
->update_mode_line
= Qt
;
13707 /* Try to scroll by specified few lines. */
13708 if ((scroll_conservatively
13710 || temp_scroll_step
13711 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13712 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13713 && !current_buffer
->clip_changed
13714 && CHARPOS (startp
) >= BEGV
13715 && CHARPOS (startp
) <= ZV
)
13717 /* The function returns -1 if new fonts were loaded, 1 if
13718 successful, 0 if not successful. */
13719 int rc
= try_scrolling (window
, just_this_one_p
,
13720 scroll_conservatively
,
13722 temp_scroll_step
, last_line_misfit
);
13725 case SCROLLING_SUCCESS
:
13728 case SCROLLING_NEED_LARGER_MATRICES
:
13729 goto need_larger_matrices
;
13731 case SCROLLING_FAILED
:
13739 /* Finally, just choose place to start which centers point */
13742 if (centering_position
< 0)
13743 centering_position
= window_box_height (w
) / 2;
13746 debug_method_add (w
, "recenter");
13749 /* w->vscroll = 0; */
13751 /* Forget any previously recorded base line for line number display. */
13752 if (!buffer_unchanged_p
)
13753 w
->base_line_number
= Qnil
;
13755 /* Move backward half the height of the window. */
13756 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13757 it
.current_y
= it
.last_visible_y
;
13758 move_it_vertically_backward (&it
, centering_position
);
13759 xassert (IT_CHARPOS (it
) >= BEGV
);
13761 /* The function move_it_vertically_backward may move over more
13762 than the specified y-distance. If it->w is small, e.g. a
13763 mini-buffer window, we may end up in front of the window's
13764 display area. Start displaying at the start of the line
13765 containing PT in this case. */
13766 if (it
.current_y
<= 0)
13768 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13769 move_it_vertically_backward (&it
, 0);
13773 it
.current_x
= it
.hpos
= 0;
13775 /* Set startp here explicitly in case that helps avoid an infinite loop
13776 in case the window-scroll-functions functions get errors. */
13777 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13779 /* Run scroll hooks. */
13780 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13782 /* Redisplay the window. */
13783 if (!current_matrix_up_to_date_p
13784 || windows_or_buffers_changed
13785 || cursor_type_changed
13786 /* Don't use try_window_reusing_current_matrix in this case
13787 because it can have changed the buffer. */
13788 || !NILP (Vwindow_scroll_functions
)
13789 || !just_this_one_p
13790 || MINI_WINDOW_P (w
)
13791 || !(used_current_matrix_p
13792 = try_window_reusing_current_matrix (w
)))
13793 try_window (window
, startp
, 0);
13795 /* If new fonts have been loaded (due to fontsets), give up. We
13796 have to start a new redisplay since we need to re-adjust glyph
13798 if (fonts_changed_p
)
13799 goto need_larger_matrices
;
13801 /* If cursor did not appear assume that the middle of the window is
13802 in the first line of the window. Do it again with the next line.
13803 (Imagine a window of height 100, displaying two lines of height
13804 60. Moving back 50 from it->last_visible_y will end in the first
13806 if (w
->cursor
.vpos
< 0)
13808 if (!NILP (w
->window_end_valid
)
13809 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13811 clear_glyph_matrix (w
->desired_matrix
);
13812 move_it_by_lines (&it
, 1, 0);
13813 try_window (window
, it
.current
.pos
, 0);
13815 else if (PT
< IT_CHARPOS (it
))
13817 clear_glyph_matrix (w
->desired_matrix
);
13818 move_it_by_lines (&it
, -1, 0);
13819 try_window (window
, it
.current
.pos
, 0);
13823 /* Not much we can do about it. */
13827 /* Consider the following case: Window starts at BEGV, there is
13828 invisible, intangible text at BEGV, so that display starts at
13829 some point START > BEGV. It can happen that we are called with
13830 PT somewhere between BEGV and START. Try to handle that case. */
13831 if (w
->cursor
.vpos
< 0)
13833 struct glyph_row
*row
= w
->current_matrix
->rows
;
13834 if (row
->mode_line_p
)
13836 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13839 if (!cursor_row_fully_visible_p (w
, 0, 0))
13841 /* If vscroll is enabled, disable it and try again. */
13845 clear_glyph_matrix (w
->desired_matrix
);
13849 /* If centering point failed to make the whole line visible,
13850 put point at the top instead. That has to make the whole line
13851 visible, if it can be done. */
13852 if (centering_position
== 0)
13855 clear_glyph_matrix (w
->desired_matrix
);
13856 centering_position
= 0;
13862 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13863 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13864 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13867 /* Display the mode line, if we must. */
13868 if ((update_mode_line
13869 /* If window not full width, must redo its mode line
13870 if (a) the window to its side is being redone and
13871 (b) we do a frame-based redisplay. This is a consequence
13872 of how inverted lines are drawn in frame-based redisplay. */
13873 || (!just_this_one_p
13874 && !FRAME_WINDOW_P (f
)
13875 && !WINDOW_FULL_WIDTH_P (w
))
13876 /* Line number to display. */
13877 || INTEGERP (w
->base_line_pos
)
13878 /* Column number is displayed and different from the one displayed. */
13879 || (!NILP (w
->column_number_displayed
)
13880 && (XFASTINT (w
->column_number_displayed
)
13881 != (int) current_column ()))) /* iftc */
13882 /* This means that the window has a mode line. */
13883 && (WINDOW_WANTS_MODELINE_P (w
)
13884 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13886 display_mode_lines (w
);
13888 /* If mode line height has changed, arrange for a thorough
13889 immediate redisplay using the correct mode line height. */
13890 if (WINDOW_WANTS_MODELINE_P (w
)
13891 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13893 fonts_changed_p
= 1;
13894 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13895 = DESIRED_MODE_LINE_HEIGHT (w
);
13898 /* If top line height has changed, arrange for a thorough
13899 immediate redisplay using the correct mode line height. */
13900 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13901 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13903 fonts_changed_p
= 1;
13904 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13905 = DESIRED_HEADER_LINE_HEIGHT (w
);
13908 if (fonts_changed_p
)
13909 goto need_larger_matrices
;
13912 if (!line_number_displayed
13913 && !BUFFERP (w
->base_line_pos
))
13915 w
->base_line_pos
= Qnil
;
13916 w
->base_line_number
= Qnil
;
13921 /* When we reach a frame's selected window, redo the frame's menu bar. */
13922 if (update_mode_line
13923 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13925 int redisplay_menu_p
= 0;
13926 int redisplay_tool_bar_p
= 0;
13928 if (FRAME_WINDOW_P (f
))
13930 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13931 || defined (HAVE_NS) || defined (USE_GTK)
13932 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13934 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13938 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13940 if (redisplay_menu_p
)
13941 display_menu_bar (w
);
13943 #ifdef HAVE_WINDOW_SYSTEM
13944 if (FRAME_WINDOW_P (f
))
13946 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
13947 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13949 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13950 && (FRAME_TOOL_BAR_LINES (f
) > 0
13951 || !NILP (Vauto_resize_tool_bars
));
13954 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13956 extern int ignore_mouse_drag_p
;
13957 ignore_mouse_drag_p
= 1;
13963 #ifdef HAVE_WINDOW_SYSTEM
13964 if (FRAME_WINDOW_P (f
)
13965 && update_window_fringes (w
, (just_this_one_p
13966 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13967 || w
->pseudo_window_p
)))
13971 if (draw_window_fringes (w
, 1))
13972 x_draw_vertical_border (w
);
13976 #endif /* HAVE_WINDOW_SYSTEM */
13978 /* We go to this label, with fonts_changed_p nonzero,
13979 if it is necessary to try again using larger glyph matrices.
13980 We have to redeem the scroll bar even in this case,
13981 because the loop in redisplay_internal expects that. */
13982 need_larger_matrices
:
13984 finish_scroll_bars
:
13986 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13988 /* Set the thumb's position and size. */
13989 set_vertical_scroll_bar (w
);
13991 /* Note that we actually used the scroll bar attached to this
13992 window, so it shouldn't be deleted at the end of redisplay. */
13993 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13994 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13997 /* Restore current_buffer and value of point in it. */
13998 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13999 set_buffer_internal_1 (old
);
14000 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14001 shorter. This can be caused by log truncation in *Messages*. */
14002 if (CHARPOS (lpoint
) <= ZV
)
14003 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14005 unbind_to (count
, Qnil
);
14009 /* Build the complete desired matrix of WINDOW with a window start
14010 buffer position POS.
14012 Value is 1 if successful. It is zero if fonts were loaded during
14013 redisplay which makes re-adjusting glyph matrices necessary, and -1
14014 if point would appear in the scroll margins.
14015 (We check that only if CHECK_MARGINS is nonzero. */
14018 try_window (window
, pos
, check_margins
)
14019 Lisp_Object window
;
14020 struct text_pos pos
;
14023 struct window
*w
= XWINDOW (window
);
14025 struct glyph_row
*last_text_row
= NULL
;
14026 struct frame
*f
= XFRAME (w
->frame
);
14028 /* Make POS the new window start. */
14029 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14031 /* Mark cursor position as unknown. No overlay arrow seen. */
14032 w
->cursor
.vpos
= -1;
14033 overlay_arrow_seen
= 0;
14035 /* Initialize iterator and info to start at POS. */
14036 start_display (&it
, w
, pos
);
14038 /* Display all lines of W. */
14039 while (it
.current_y
< it
.last_visible_y
)
14041 if (display_line (&it
))
14042 last_text_row
= it
.glyph_row
- 1;
14043 if (fonts_changed_p
)
14047 /* Don't let the cursor end in the scroll margins. */
14049 && !MINI_WINDOW_P (w
))
14051 int this_scroll_margin
;
14053 if (scroll_margin
> 0)
14055 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14056 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14059 this_scroll_margin
= 0;
14061 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14062 && w
->cursor
.y
< this_scroll_margin
14063 && CHARPOS (pos
) > BEGV
14064 && IT_CHARPOS (it
) < ZV
)
14065 /* rms: considering make_cursor_line_fully_visible_p here
14066 seems to give wrong results. We don't want to recenter
14067 when the last line is partly visible, we want to allow
14068 that case to be handled in the usual way. */
14069 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14071 w
->cursor
.vpos
= -1;
14072 clear_glyph_matrix (w
->desired_matrix
);
14077 /* If bottom moved off end of frame, change mode line percentage. */
14078 if (XFASTINT (w
->window_end_pos
) <= 0
14079 && Z
!= IT_CHARPOS (it
))
14080 w
->update_mode_line
= Qt
;
14082 /* Set window_end_pos to the offset of the last character displayed
14083 on the window from the end of current_buffer. Set
14084 window_end_vpos to its row number. */
14087 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14088 w
->window_end_bytepos
14089 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14091 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14093 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14094 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14095 ->displays_text_p
);
14099 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14100 w
->window_end_pos
= make_number (Z
- ZV
);
14101 w
->window_end_vpos
= make_number (0);
14104 /* But that is not valid info until redisplay finishes. */
14105 w
->window_end_valid
= Qnil
;
14111 /************************************************************************
14112 Window redisplay reusing current matrix when buffer has not changed
14113 ************************************************************************/
14115 /* Try redisplay of window W showing an unchanged buffer with a
14116 different window start than the last time it was displayed by
14117 reusing its current matrix. Value is non-zero if successful.
14118 W->start is the new window start. */
14121 try_window_reusing_current_matrix (w
)
14124 struct frame
*f
= XFRAME (w
->frame
);
14125 struct glyph_row
*row
, *bottom_row
;
14128 struct text_pos start
, new_start
;
14129 int nrows_scrolled
, i
;
14130 struct glyph_row
*last_text_row
;
14131 struct glyph_row
*last_reused_text_row
;
14132 struct glyph_row
*start_row
;
14133 int start_vpos
, min_y
, max_y
;
14136 if (inhibit_try_window_reusing
)
14140 if (/* This function doesn't handle terminal frames. */
14141 !FRAME_WINDOW_P (f
)
14142 /* Don't try to reuse the display if windows have been split
14144 || windows_or_buffers_changed
14145 || cursor_type_changed
)
14148 /* Can't do this if region may have changed. */
14149 if ((!NILP (Vtransient_mark_mode
)
14150 && !NILP (current_buffer
->mark_active
))
14151 || !NILP (w
->region_showing
)
14152 || !NILP (Vshow_trailing_whitespace
))
14155 /* If top-line visibility has changed, give up. */
14156 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14157 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14160 /* Give up if old or new display is scrolled vertically. We could
14161 make this function handle this, but right now it doesn't. */
14162 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14163 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14166 /* The variable new_start now holds the new window start. The old
14167 start `start' can be determined from the current matrix. */
14168 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14169 start
= start_row
->start
.pos
;
14170 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14172 /* Clear the desired matrix for the display below. */
14173 clear_glyph_matrix (w
->desired_matrix
);
14175 if (CHARPOS (new_start
) <= CHARPOS (start
))
14179 /* Don't use this method if the display starts with an ellipsis
14180 displayed for invisible text. It's not easy to handle that case
14181 below, and it's certainly not worth the effort since this is
14182 not a frequent case. */
14183 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14186 IF_DEBUG (debug_method_add (w
, "twu1"));
14188 /* Display up to a row that can be reused. The variable
14189 last_text_row is set to the last row displayed that displays
14190 text. Note that it.vpos == 0 if or if not there is a
14191 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14192 start_display (&it
, w
, new_start
);
14193 first_row_y
= it
.current_y
;
14194 w
->cursor
.vpos
= -1;
14195 last_text_row
= last_reused_text_row
= NULL
;
14197 while (it
.current_y
< it
.last_visible_y
14198 && !fonts_changed_p
)
14200 /* If we have reached into the characters in the START row,
14201 that means the line boundaries have changed. So we
14202 can't start copying with the row START. Maybe it will
14203 work to start copying with the following row. */
14204 while (IT_CHARPOS (it
) > CHARPOS (start
))
14206 /* Advance to the next row as the "start". */
14208 start
= start_row
->start
.pos
;
14209 /* If there are no more rows to try, or just one, give up. */
14210 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14211 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14212 || CHARPOS (start
) == ZV
)
14214 clear_glyph_matrix (w
->desired_matrix
);
14218 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14220 /* If we have reached alignment,
14221 we can copy the rest of the rows. */
14222 if (IT_CHARPOS (it
) == CHARPOS (start
))
14225 if (display_line (&it
))
14226 last_text_row
= it
.glyph_row
- 1;
14229 /* A value of current_y < last_visible_y means that we stopped
14230 at the previous window start, which in turn means that we
14231 have at least one reusable row. */
14232 if (it
.current_y
< it
.last_visible_y
)
14234 /* IT.vpos always starts from 0; it counts text lines. */
14235 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14237 /* Find PT if not already found in the lines displayed. */
14238 if (w
->cursor
.vpos
< 0)
14240 int dy
= it
.current_y
- start_row
->y
;
14242 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14243 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14245 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14246 dy
, nrows_scrolled
);
14249 clear_glyph_matrix (w
->desired_matrix
);
14254 /* Scroll the display. Do it before the current matrix is
14255 changed. The problem here is that update has not yet
14256 run, i.e. part of the current matrix is not up to date.
14257 scroll_run_hook will clear the cursor, and use the
14258 current matrix to get the height of the row the cursor is
14260 run
.current_y
= start_row
->y
;
14261 run
.desired_y
= it
.current_y
;
14262 run
.height
= it
.last_visible_y
- it
.current_y
;
14264 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14267 FRAME_RIF (f
)->update_window_begin_hook (w
);
14268 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14269 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14270 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14274 /* Shift current matrix down by nrows_scrolled lines. */
14275 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14276 rotate_matrix (w
->current_matrix
,
14278 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14281 /* Disable lines that must be updated. */
14282 for (i
= 0; i
< nrows_scrolled
; ++i
)
14283 (start_row
+ i
)->enabled_p
= 0;
14285 /* Re-compute Y positions. */
14286 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14287 max_y
= it
.last_visible_y
;
14288 for (row
= start_row
+ nrows_scrolled
;
14292 row
->y
= it
.current_y
;
14293 row
->visible_height
= row
->height
;
14295 if (row
->y
< min_y
)
14296 row
->visible_height
-= min_y
- row
->y
;
14297 if (row
->y
+ row
->height
> max_y
)
14298 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14299 row
->redraw_fringe_bitmaps_p
= 1;
14301 it
.current_y
+= row
->height
;
14303 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14304 last_reused_text_row
= row
;
14305 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14309 /* Disable lines in the current matrix which are now
14310 below the window. */
14311 for (++row
; row
< bottom_row
; ++row
)
14312 row
->enabled_p
= row
->mode_line_p
= 0;
14315 /* Update window_end_pos etc.; last_reused_text_row is the last
14316 reused row from the current matrix containing text, if any.
14317 The value of last_text_row is the last displayed line
14318 containing text. */
14319 if (last_reused_text_row
)
14321 w
->window_end_bytepos
14322 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14324 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14326 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14327 w
->current_matrix
));
14329 else if (last_text_row
)
14331 w
->window_end_bytepos
14332 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14334 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14336 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14340 /* This window must be completely empty. */
14341 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14342 w
->window_end_pos
= make_number (Z
- ZV
);
14343 w
->window_end_vpos
= make_number (0);
14345 w
->window_end_valid
= Qnil
;
14347 /* Update hint: don't try scrolling again in update_window. */
14348 w
->desired_matrix
->no_scrolling_p
= 1;
14351 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14355 else if (CHARPOS (new_start
) > CHARPOS (start
))
14357 struct glyph_row
*pt_row
, *row
;
14358 struct glyph_row
*first_reusable_row
;
14359 struct glyph_row
*first_row_to_display
;
14361 int yb
= window_text_bottom_y (w
);
14363 /* Find the row starting at new_start, if there is one. Don't
14364 reuse a partially visible line at the end. */
14365 first_reusable_row
= start_row
;
14366 while (first_reusable_row
->enabled_p
14367 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14368 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14369 < CHARPOS (new_start
)))
14370 ++first_reusable_row
;
14372 /* Give up if there is no row to reuse. */
14373 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14374 || !first_reusable_row
->enabled_p
14375 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14376 != CHARPOS (new_start
)))
14379 /* We can reuse fully visible rows beginning with
14380 first_reusable_row to the end of the window. Set
14381 first_row_to_display to the first row that cannot be reused.
14382 Set pt_row to the row containing point, if there is any. */
14384 for (first_row_to_display
= first_reusable_row
;
14385 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14386 ++first_row_to_display
)
14388 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14389 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14390 pt_row
= first_row_to_display
;
14393 /* Start displaying at the start of first_row_to_display. */
14394 xassert (first_row_to_display
->y
< yb
);
14395 init_to_row_start (&it
, w
, first_row_to_display
);
14397 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14399 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14401 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14402 + WINDOW_HEADER_LINE_HEIGHT (w
));
14404 /* Display lines beginning with first_row_to_display in the
14405 desired matrix. Set last_text_row to the last row displayed
14406 that displays text. */
14407 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14408 if (pt_row
== NULL
)
14409 w
->cursor
.vpos
= -1;
14410 last_text_row
= NULL
;
14411 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14412 if (display_line (&it
))
14413 last_text_row
= it
.glyph_row
- 1;
14415 /* Give up If point isn't in a row displayed or reused. */
14416 if (w
->cursor
.vpos
< 0)
14418 clear_glyph_matrix (w
->desired_matrix
);
14422 /* If point is in a reused row, adjust y and vpos of the cursor
14426 w
->cursor
.vpos
-= nrows_scrolled
;
14427 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14430 /* Scroll the display. */
14431 run
.current_y
= first_reusable_row
->y
;
14432 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14433 run
.height
= it
.last_visible_y
- run
.current_y
;
14434 dy
= run
.current_y
- run
.desired_y
;
14439 FRAME_RIF (f
)->update_window_begin_hook (w
);
14440 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14441 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14442 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14446 /* Adjust Y positions of reused rows. */
14447 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14448 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14449 max_y
= it
.last_visible_y
;
14450 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14453 row
->visible_height
= row
->height
;
14454 if (row
->y
< min_y
)
14455 row
->visible_height
-= min_y
- row
->y
;
14456 if (row
->y
+ row
->height
> max_y
)
14457 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14458 row
->redraw_fringe_bitmaps_p
= 1;
14461 /* Scroll the current matrix. */
14462 xassert (nrows_scrolled
> 0);
14463 rotate_matrix (w
->current_matrix
,
14465 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14468 /* Disable rows not reused. */
14469 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14470 row
->enabled_p
= 0;
14472 /* Point may have moved to a different line, so we cannot assume that
14473 the previous cursor position is valid; locate the correct row. */
14476 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14477 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14481 w
->cursor
.y
= row
->y
;
14483 if (row
< bottom_row
)
14485 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14486 while (glyph
->charpos
< PT
)
14489 w
->cursor
.x
+= glyph
->pixel_width
;
14495 /* Adjust window end. A null value of last_text_row means that
14496 the window end is in reused rows which in turn means that
14497 only its vpos can have changed. */
14500 w
->window_end_bytepos
14501 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14503 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14505 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14510 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14513 w
->window_end_valid
= Qnil
;
14514 w
->desired_matrix
->no_scrolling_p
= 1;
14517 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14527 /************************************************************************
14528 Window redisplay reusing current matrix when buffer has changed
14529 ************************************************************************/
14531 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14532 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14534 static struct glyph_row
*
14535 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14536 struct glyph_row
*));
14539 /* Return the last row in MATRIX displaying text. If row START is
14540 non-null, start searching with that row. IT gives the dimensions
14541 of the display. Value is null if matrix is empty; otherwise it is
14542 a pointer to the row found. */
14544 static struct glyph_row
*
14545 find_last_row_displaying_text (matrix
, it
, start
)
14546 struct glyph_matrix
*matrix
;
14548 struct glyph_row
*start
;
14550 struct glyph_row
*row
, *row_found
;
14552 /* Set row_found to the last row in IT->w's current matrix
14553 displaying text. The loop looks funny but think of partially
14556 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14557 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14559 xassert (row
->enabled_p
);
14561 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14570 /* Return the last row in the current matrix of W that is not affected
14571 by changes at the start of current_buffer that occurred since W's
14572 current matrix was built. Value is null if no such row exists.
14574 BEG_UNCHANGED us the number of characters unchanged at the start of
14575 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14576 first changed character in current_buffer. Characters at positions <
14577 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14578 when the current matrix was built. */
14580 static struct glyph_row
*
14581 find_last_unchanged_at_beg_row (w
)
14584 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14585 struct glyph_row
*row
;
14586 struct glyph_row
*row_found
= NULL
;
14587 int yb
= window_text_bottom_y (w
);
14589 /* Find the last row displaying unchanged text. */
14590 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14591 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14592 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14595 if (/* If row ends before first_changed_pos, it is unchanged,
14596 except in some case. */
14597 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14598 /* When row ends in ZV and we write at ZV it is not
14600 && !row
->ends_at_zv_p
14601 /* When first_changed_pos is the end of a continued line,
14602 row is not unchanged because it may be no longer
14604 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14605 && (row
->continued_p
14606 || row
->exact_window_width_line_p
)))
14609 /* Stop if last visible row. */
14610 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14618 /* Find the first glyph row in the current matrix of W that is not
14619 affected by changes at the end of current_buffer since the
14620 time W's current matrix was built.
14622 Return in *DELTA the number of chars by which buffer positions in
14623 unchanged text at the end of current_buffer must be adjusted.
14625 Return in *DELTA_BYTES the corresponding number of bytes.
14627 Value is null if no such row exists, i.e. all rows are affected by
14630 static struct glyph_row
*
14631 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14633 int *delta
, *delta_bytes
;
14635 struct glyph_row
*row
;
14636 struct glyph_row
*row_found
= NULL
;
14638 *delta
= *delta_bytes
= 0;
14640 /* Display must not have been paused, otherwise the current matrix
14641 is not up to date. */
14642 eassert (!NILP (w
->window_end_valid
));
14644 /* A value of window_end_pos >= END_UNCHANGED means that the window
14645 end is in the range of changed text. If so, there is no
14646 unchanged row at the end of W's current matrix. */
14647 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14650 /* Set row to the last row in W's current matrix displaying text. */
14651 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14653 /* If matrix is entirely empty, no unchanged row exists. */
14654 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14656 /* The value of row is the last glyph row in the matrix having a
14657 meaningful buffer position in it. The end position of row
14658 corresponds to window_end_pos. This allows us to translate
14659 buffer positions in the current matrix to current buffer
14660 positions for characters not in changed text. */
14661 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14662 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14663 int last_unchanged_pos
, last_unchanged_pos_old
;
14664 struct glyph_row
*first_text_row
14665 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14667 *delta
= Z
- Z_old
;
14668 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14670 /* Set last_unchanged_pos to the buffer position of the last
14671 character in the buffer that has not been changed. Z is the
14672 index + 1 of the last character in current_buffer, i.e. by
14673 subtracting END_UNCHANGED we get the index of the last
14674 unchanged character, and we have to add BEG to get its buffer
14676 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14677 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14679 /* Search backward from ROW for a row displaying a line that
14680 starts at a minimum position >= last_unchanged_pos_old. */
14681 for (; row
> first_text_row
; --row
)
14683 /* This used to abort, but it can happen.
14684 It is ok to just stop the search instead here. KFS. */
14685 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14688 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14693 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14699 /* Make sure that glyph rows in the current matrix of window W
14700 reference the same glyph memory as corresponding rows in the
14701 frame's frame matrix. This function is called after scrolling W's
14702 current matrix on a terminal frame in try_window_id and
14703 try_window_reusing_current_matrix. */
14706 sync_frame_with_window_matrix_rows (w
)
14709 struct frame
*f
= XFRAME (w
->frame
);
14710 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14712 /* Preconditions: W must be a leaf window and full-width. Its frame
14713 must have a frame matrix. */
14714 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14715 xassert (WINDOW_FULL_WIDTH_P (w
));
14716 xassert (!FRAME_WINDOW_P (f
));
14718 /* If W is a full-width window, glyph pointers in W's current matrix
14719 have, by definition, to be the same as glyph pointers in the
14720 corresponding frame matrix. Note that frame matrices have no
14721 marginal areas (see build_frame_matrix). */
14722 window_row
= w
->current_matrix
->rows
;
14723 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14724 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14725 while (window_row
< window_row_end
)
14727 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14728 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14730 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14731 frame_row
->glyphs
[TEXT_AREA
] = start
;
14732 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14733 frame_row
->glyphs
[LAST_AREA
] = end
;
14735 /* Disable frame rows whose corresponding window rows have
14736 been disabled in try_window_id. */
14737 if (!window_row
->enabled_p
)
14738 frame_row
->enabled_p
= 0;
14740 ++window_row
, ++frame_row
;
14745 /* Find the glyph row in window W containing CHARPOS. Consider all
14746 rows between START and END (not inclusive). END null means search
14747 all rows to the end of the display area of W. Value is the row
14748 containing CHARPOS or null. */
14751 row_containing_pos (w
, charpos
, start
, end
, dy
)
14754 struct glyph_row
*start
, *end
;
14757 struct glyph_row
*row
= start
;
14760 /* If we happen to start on a header-line, skip that. */
14761 if (row
->mode_line_p
)
14764 if ((end
&& row
>= end
) || !row
->enabled_p
)
14767 last_y
= window_text_bottom_y (w
) - dy
;
14771 /* Give up if we have gone too far. */
14772 if (end
&& row
>= end
)
14774 /* This formerly returned if they were equal.
14775 I think that both quantities are of a "last plus one" type;
14776 if so, when they are equal, the row is within the screen. -- rms. */
14777 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14780 /* If it is in this row, return this row. */
14781 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14782 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14783 /* The end position of a row equals the start
14784 position of the next row. If CHARPOS is there, we
14785 would rather display it in the next line, except
14786 when this line ends in ZV. */
14787 && !row
->ends_at_zv_p
14788 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14789 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14796 /* Try to redisplay window W by reusing its existing display. W's
14797 current matrix must be up to date when this function is called,
14798 i.e. window_end_valid must not be nil.
14802 1 if display has been updated
14803 0 if otherwise unsuccessful
14804 -1 if redisplay with same window start is known not to succeed
14806 The following steps are performed:
14808 1. Find the last row in the current matrix of W that is not
14809 affected by changes at the start of current_buffer. If no such row
14812 2. Find the first row in W's current matrix that is not affected by
14813 changes at the end of current_buffer. Maybe there is no such row.
14815 3. Display lines beginning with the row + 1 found in step 1 to the
14816 row found in step 2 or, if step 2 didn't find a row, to the end of
14819 4. If cursor is not known to appear on the window, give up.
14821 5. If display stopped at the row found in step 2, scroll the
14822 display and current matrix as needed.
14824 6. Maybe display some lines at the end of W, if we must. This can
14825 happen under various circumstances, like a partially visible line
14826 becoming fully visible, or because newly displayed lines are displayed
14827 in smaller font sizes.
14829 7. Update W's window end information. */
14835 struct frame
*f
= XFRAME (w
->frame
);
14836 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14837 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14838 struct glyph_row
*last_unchanged_at_beg_row
;
14839 struct glyph_row
*first_unchanged_at_end_row
;
14840 struct glyph_row
*row
;
14841 struct glyph_row
*bottom_row
;
14844 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14845 struct text_pos start_pos
;
14847 int first_unchanged_at_end_vpos
= 0;
14848 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14849 struct text_pos start
;
14850 int first_changed_charpos
, last_changed_charpos
;
14853 if (inhibit_try_window_id
)
14857 /* This is handy for debugging. */
14859 #define GIVE_UP(X) \
14861 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14865 #define GIVE_UP(X) return 0
14868 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14870 /* Don't use this for mini-windows because these can show
14871 messages and mini-buffers, and we don't handle that here. */
14872 if (MINI_WINDOW_P (w
))
14875 /* This flag is used to prevent redisplay optimizations. */
14876 if (windows_or_buffers_changed
|| cursor_type_changed
)
14879 /* Verify that narrowing has not changed.
14880 Also verify that we were not told to prevent redisplay optimizations.
14881 It would be nice to further
14882 reduce the number of cases where this prevents try_window_id. */
14883 if (current_buffer
->clip_changed
14884 || current_buffer
->prevent_redisplay_optimizations_p
)
14887 /* Window must either use window-based redisplay or be full width. */
14888 if (!FRAME_WINDOW_P (f
)
14889 && (!FRAME_LINE_INS_DEL_OK (f
)
14890 || !WINDOW_FULL_WIDTH_P (w
)))
14893 /* Give up if point is not known NOT to appear in W. */
14894 if (PT
< CHARPOS (start
))
14897 /* Another way to prevent redisplay optimizations. */
14898 if (XFASTINT (w
->last_modified
) == 0)
14901 /* Verify that window is not hscrolled. */
14902 if (XFASTINT (w
->hscroll
) != 0)
14905 /* Verify that display wasn't paused. */
14906 if (NILP (w
->window_end_valid
))
14909 /* Can't use this if highlighting a region because a cursor movement
14910 will do more than just set the cursor. */
14911 if (!NILP (Vtransient_mark_mode
)
14912 && !NILP (current_buffer
->mark_active
))
14915 /* Likewise if highlighting trailing whitespace. */
14916 if (!NILP (Vshow_trailing_whitespace
))
14919 /* Likewise if showing a region. */
14920 if (!NILP (w
->region_showing
))
14923 /* Can use this if overlay arrow position and or string have changed. */
14924 if (overlay_arrows_changed_p ())
14927 /* When word-wrap is on, adding a space to the first word of a
14928 wrapped line can change the wrap position, altering the line
14929 above it. It might be worthwhile to handle this more
14930 intelligently, but for now just redisplay from scratch. */
14931 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14934 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14935 only if buffer has really changed. The reason is that the gap is
14936 initially at Z for freshly visited files. The code below would
14937 set end_unchanged to 0 in that case. */
14938 if (MODIFF
> SAVE_MODIFF
14939 /* This seems to happen sometimes after saving a buffer. */
14940 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14942 if (GPT
- BEG
< BEG_UNCHANGED
)
14943 BEG_UNCHANGED
= GPT
- BEG
;
14944 if (Z
- GPT
< END_UNCHANGED
)
14945 END_UNCHANGED
= Z
- GPT
;
14948 /* The position of the first and last character that has been changed. */
14949 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14950 last_changed_charpos
= Z
- END_UNCHANGED
;
14952 /* If window starts after a line end, and the last change is in
14953 front of that newline, then changes don't affect the display.
14954 This case happens with stealth-fontification. Note that although
14955 the display is unchanged, glyph positions in the matrix have to
14956 be adjusted, of course. */
14957 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14958 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14959 && ((last_changed_charpos
< CHARPOS (start
)
14960 && CHARPOS (start
) == BEGV
)
14961 || (last_changed_charpos
< CHARPOS (start
) - 1
14962 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14964 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14965 struct glyph_row
*r0
;
14967 /* Compute how many chars/bytes have been added to or removed
14968 from the buffer. */
14969 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14970 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14972 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14974 /* Give up if PT is not in the window. Note that it already has
14975 been checked at the start of try_window_id that PT is not in
14976 front of the window start. */
14977 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14980 /* If window start is unchanged, we can reuse the whole matrix
14981 as is, after adjusting glyph positions. No need to compute
14982 the window end again, since its offset from Z hasn't changed. */
14983 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14984 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14985 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14986 /* PT must not be in a partially visible line. */
14987 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14988 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14990 /* Adjust positions in the glyph matrix. */
14991 if (delta
|| delta_bytes
)
14993 struct glyph_row
*r1
14994 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14995 increment_matrix_positions (w
->current_matrix
,
14996 MATRIX_ROW_VPOS (r0
, current_matrix
),
14997 MATRIX_ROW_VPOS (r1
, current_matrix
),
14998 delta
, delta_bytes
);
15001 /* Set the cursor. */
15002 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15004 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15011 /* Handle the case that changes are all below what is displayed in
15012 the window, and that PT is in the window. This shortcut cannot
15013 be taken if ZV is visible in the window, and text has been added
15014 there that is visible in the window. */
15015 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15016 /* ZV is not visible in the window, or there are no
15017 changes at ZV, actually. */
15018 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15019 || first_changed_charpos
== last_changed_charpos
))
15021 struct glyph_row
*r0
;
15023 /* Give up if PT is not in the window. Note that it already has
15024 been checked at the start of try_window_id that PT is not in
15025 front of the window start. */
15026 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15029 /* If window start is unchanged, we can reuse the whole matrix
15030 as is, without changing glyph positions since no text has
15031 been added/removed in front of the window end. */
15032 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15033 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15034 /* PT must not be in a partially visible line. */
15035 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15036 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15038 /* We have to compute the window end anew since text
15039 can have been added/removed after it. */
15041 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15042 w
->window_end_bytepos
15043 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15045 /* Set the cursor. */
15046 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15048 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15055 /* Give up if window start is in the changed area.
15057 The condition used to read
15059 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15061 but why that was tested escapes me at the moment. */
15062 if (CHARPOS (start
) >= first_changed_charpos
15063 && CHARPOS (start
) <= last_changed_charpos
)
15066 /* Check that window start agrees with the start of the first glyph
15067 row in its current matrix. Check this after we know the window
15068 start is not in changed text, otherwise positions would not be
15070 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15071 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15074 /* Give up if the window ends in strings. Overlay strings
15075 at the end are difficult to handle, so don't try. */
15076 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15077 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15080 /* Compute the position at which we have to start displaying new
15081 lines. Some of the lines at the top of the window might be
15082 reusable because they are not displaying changed text. Find the
15083 last row in W's current matrix not affected by changes at the
15084 start of current_buffer. Value is null if changes start in the
15085 first line of window. */
15086 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15087 if (last_unchanged_at_beg_row
)
15089 /* Avoid starting to display in the moddle of a character, a TAB
15090 for instance. This is easier than to set up the iterator
15091 exactly, and it's not a frequent case, so the additional
15092 effort wouldn't really pay off. */
15093 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15094 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15095 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15096 --last_unchanged_at_beg_row
;
15098 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15101 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15103 start_pos
= it
.current
.pos
;
15105 /* Start displaying new lines in the desired matrix at the same
15106 vpos we would use in the current matrix, i.e. below
15107 last_unchanged_at_beg_row. */
15108 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15110 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15111 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15113 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15117 /* There are no reusable lines at the start of the window.
15118 Start displaying in the first text line. */
15119 start_display (&it
, w
, start
);
15120 it
.vpos
= it
.first_vpos
;
15121 start_pos
= it
.current
.pos
;
15124 /* Find the first row that is not affected by changes at the end of
15125 the buffer. Value will be null if there is no unchanged row, in
15126 which case we must redisplay to the end of the window. delta
15127 will be set to the value by which buffer positions beginning with
15128 first_unchanged_at_end_row have to be adjusted due to text
15130 first_unchanged_at_end_row
15131 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15132 IF_DEBUG (debug_delta
= delta
);
15133 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15135 /* Set stop_pos to the buffer position up to which we will have to
15136 display new lines. If first_unchanged_at_end_row != NULL, this
15137 is the buffer position of the start of the line displayed in that
15138 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15139 that we don't stop at a buffer position. */
15141 if (first_unchanged_at_end_row
)
15143 xassert (last_unchanged_at_beg_row
== NULL
15144 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15146 /* If this is a continuation line, move forward to the next one
15147 that isn't. Changes in lines above affect this line.
15148 Caution: this may move first_unchanged_at_end_row to a row
15149 not displaying text. */
15150 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15151 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15152 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15153 < it
.last_visible_y
))
15154 ++first_unchanged_at_end_row
;
15156 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15157 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15158 >= it
.last_visible_y
))
15159 first_unchanged_at_end_row
= NULL
;
15162 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15164 first_unchanged_at_end_vpos
15165 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15166 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15169 else if (last_unchanged_at_beg_row
== NULL
)
15175 /* Either there is no unchanged row at the end, or the one we have
15176 now displays text. This is a necessary condition for the window
15177 end pos calculation at the end of this function. */
15178 xassert (first_unchanged_at_end_row
== NULL
15179 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15181 debug_last_unchanged_at_beg_vpos
15182 = (last_unchanged_at_beg_row
15183 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15185 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15187 #endif /* GLYPH_DEBUG != 0 */
15190 /* Display new lines. Set last_text_row to the last new line
15191 displayed which has text on it, i.e. might end up as being the
15192 line where the window_end_vpos is. */
15193 w
->cursor
.vpos
= -1;
15194 last_text_row
= NULL
;
15195 overlay_arrow_seen
= 0;
15196 while (it
.current_y
< it
.last_visible_y
15197 && !fonts_changed_p
15198 && (first_unchanged_at_end_row
== NULL
15199 || IT_CHARPOS (it
) < stop_pos
))
15201 if (display_line (&it
))
15202 last_text_row
= it
.glyph_row
- 1;
15205 if (fonts_changed_p
)
15209 /* Compute differences in buffer positions, y-positions etc. for
15210 lines reused at the bottom of the window. Compute what we can
15212 if (first_unchanged_at_end_row
15213 /* No lines reused because we displayed everything up to the
15214 bottom of the window. */
15215 && it
.current_y
< it
.last_visible_y
)
15218 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15220 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15221 run
.current_y
= first_unchanged_at_end_row
->y
;
15222 run
.desired_y
= run
.current_y
+ dy
;
15223 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15227 delta
= delta_bytes
= dvpos
= dy
15228 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15229 first_unchanged_at_end_row
= NULL
;
15231 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15234 /* Find the cursor if not already found. We have to decide whether
15235 PT will appear on this window (it sometimes doesn't, but this is
15236 not a very frequent case.) This decision has to be made before
15237 the current matrix is altered. A value of cursor.vpos < 0 means
15238 that PT is either in one of the lines beginning at
15239 first_unchanged_at_end_row or below the window. Don't care for
15240 lines that might be displayed later at the window end; as
15241 mentioned, this is not a frequent case. */
15242 if (w
->cursor
.vpos
< 0)
15244 /* Cursor in unchanged rows at the top? */
15245 if (PT
< CHARPOS (start_pos
)
15246 && last_unchanged_at_beg_row
)
15248 row
= row_containing_pos (w
, PT
,
15249 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15250 last_unchanged_at_beg_row
+ 1, 0);
15252 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15255 /* Start from first_unchanged_at_end_row looking for PT. */
15256 else if (first_unchanged_at_end_row
)
15258 row
= row_containing_pos (w
, PT
- delta
,
15259 first_unchanged_at_end_row
, NULL
, 0);
15261 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15262 delta_bytes
, dy
, dvpos
);
15265 /* Give up if cursor was not found. */
15266 if (w
->cursor
.vpos
< 0)
15268 clear_glyph_matrix (w
->desired_matrix
);
15273 /* Don't let the cursor end in the scroll margins. */
15275 int this_scroll_margin
, cursor_height
;
15277 this_scroll_margin
= max (0, scroll_margin
);
15278 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15279 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15280 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15282 if ((w
->cursor
.y
< this_scroll_margin
15283 && CHARPOS (start
) > BEGV
)
15284 /* Old redisplay didn't take scroll margin into account at the bottom,
15285 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15286 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15287 ? cursor_height
+ this_scroll_margin
15288 : 1)) > it
.last_visible_y
)
15290 w
->cursor
.vpos
= -1;
15291 clear_glyph_matrix (w
->desired_matrix
);
15296 /* Scroll the display. Do it before changing the current matrix so
15297 that xterm.c doesn't get confused about where the cursor glyph is
15299 if (dy
&& run
.height
)
15303 if (FRAME_WINDOW_P (f
))
15305 FRAME_RIF (f
)->update_window_begin_hook (w
);
15306 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15307 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15308 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15312 /* Terminal frame. In this case, dvpos gives the number of
15313 lines to scroll by; dvpos < 0 means scroll up. */
15314 int first_unchanged_at_end_vpos
15315 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15316 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15317 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15318 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15319 + window_internal_height (w
));
15321 /* Perform the operation on the screen. */
15324 /* Scroll last_unchanged_at_beg_row to the end of the
15325 window down dvpos lines. */
15326 set_terminal_window (f
, end
);
15328 /* On dumb terminals delete dvpos lines at the end
15329 before inserting dvpos empty lines. */
15330 if (!FRAME_SCROLL_REGION_OK (f
))
15331 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15333 /* Insert dvpos empty lines in front of
15334 last_unchanged_at_beg_row. */
15335 ins_del_lines (f
, from
, dvpos
);
15337 else if (dvpos
< 0)
15339 /* Scroll up last_unchanged_at_beg_vpos to the end of
15340 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15341 set_terminal_window (f
, end
);
15343 /* Delete dvpos lines in front of
15344 last_unchanged_at_beg_vpos. ins_del_lines will set
15345 the cursor to the given vpos and emit |dvpos| delete
15347 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15349 /* On a dumb terminal insert dvpos empty lines at the
15351 if (!FRAME_SCROLL_REGION_OK (f
))
15352 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15355 set_terminal_window (f
, 0);
15361 /* Shift reused rows of the current matrix to the right position.
15362 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15364 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15365 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15368 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15369 bottom_vpos
, dvpos
);
15370 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15373 else if (dvpos
> 0)
15375 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15376 bottom_vpos
, dvpos
);
15377 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15378 first_unchanged_at_end_vpos
+ dvpos
, 0);
15381 /* For frame-based redisplay, make sure that current frame and window
15382 matrix are in sync with respect to glyph memory. */
15383 if (!FRAME_WINDOW_P (f
))
15384 sync_frame_with_window_matrix_rows (w
);
15386 /* Adjust buffer positions in reused rows. */
15387 if (delta
|| delta_bytes
)
15388 increment_matrix_positions (current_matrix
,
15389 first_unchanged_at_end_vpos
+ dvpos
,
15390 bottom_vpos
, delta
, delta_bytes
);
15392 /* Adjust Y positions. */
15394 shift_glyph_matrix (w
, current_matrix
,
15395 first_unchanged_at_end_vpos
+ dvpos
,
15398 if (first_unchanged_at_end_row
)
15400 first_unchanged_at_end_row
+= dvpos
;
15401 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15402 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15403 first_unchanged_at_end_row
= NULL
;
15406 /* If scrolling up, there may be some lines to display at the end of
15408 last_text_row_at_end
= NULL
;
15411 /* Scrolling up can leave for example a partially visible line
15412 at the end of the window to be redisplayed. */
15413 /* Set last_row to the glyph row in the current matrix where the
15414 window end line is found. It has been moved up or down in
15415 the matrix by dvpos. */
15416 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15417 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15419 /* If last_row is the window end line, it should display text. */
15420 xassert (last_row
->displays_text_p
);
15422 /* If window end line was partially visible before, begin
15423 displaying at that line. Otherwise begin displaying with the
15424 line following it. */
15425 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15427 init_to_row_start (&it
, w
, last_row
);
15428 it
.vpos
= last_vpos
;
15429 it
.current_y
= last_row
->y
;
15433 init_to_row_end (&it
, w
, last_row
);
15434 it
.vpos
= 1 + last_vpos
;
15435 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15439 /* We may start in a continuation line. If so, we have to
15440 get the right continuation_lines_width and current_x. */
15441 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15442 it
.hpos
= it
.current_x
= 0;
15444 /* Display the rest of the lines at the window end. */
15445 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15446 while (it
.current_y
< it
.last_visible_y
15447 && !fonts_changed_p
)
15449 /* Is it always sure that the display agrees with lines in
15450 the current matrix? I don't think so, so we mark rows
15451 displayed invalid in the current matrix by setting their
15452 enabled_p flag to zero. */
15453 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15454 if (display_line (&it
))
15455 last_text_row_at_end
= it
.glyph_row
- 1;
15459 /* Update window_end_pos and window_end_vpos. */
15460 if (first_unchanged_at_end_row
15461 && !last_text_row_at_end
)
15463 /* Window end line if one of the preserved rows from the current
15464 matrix. Set row to the last row displaying text in current
15465 matrix starting at first_unchanged_at_end_row, after
15467 xassert (first_unchanged_at_end_row
->displays_text_p
);
15468 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15469 first_unchanged_at_end_row
);
15470 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15472 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15473 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15475 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15476 xassert (w
->window_end_bytepos
>= 0);
15477 IF_DEBUG (debug_method_add (w
, "A"));
15479 else if (last_text_row_at_end
)
15482 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15483 w
->window_end_bytepos
15484 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15486 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15487 xassert (w
->window_end_bytepos
>= 0);
15488 IF_DEBUG (debug_method_add (w
, "B"));
15490 else if (last_text_row
)
15492 /* We have displayed either to the end of the window or at the
15493 end of the window, i.e. the last row with text is to be found
15494 in the desired matrix. */
15496 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15497 w
->window_end_bytepos
15498 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15500 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15501 xassert (w
->window_end_bytepos
>= 0);
15503 else if (first_unchanged_at_end_row
== NULL
15504 && last_text_row
== NULL
15505 && last_text_row_at_end
== NULL
)
15507 /* Displayed to end of window, but no line containing text was
15508 displayed. Lines were deleted at the end of the window. */
15509 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15510 int vpos
= XFASTINT (w
->window_end_vpos
);
15511 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15512 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15515 row
== NULL
&& vpos
>= first_vpos
;
15516 --vpos
, --current_row
, --desired_row
)
15518 if (desired_row
->enabled_p
)
15520 if (desired_row
->displays_text_p
)
15523 else if (current_row
->displays_text_p
)
15527 xassert (row
!= NULL
);
15528 w
->window_end_vpos
= make_number (vpos
+ 1);
15529 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15530 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15531 xassert (w
->window_end_bytepos
>= 0);
15532 IF_DEBUG (debug_method_add (w
, "C"));
15537 #if 0 /* This leads to problems, for instance when the cursor is
15538 at ZV, and the cursor line displays no text. */
15539 /* Disable rows below what's displayed in the window. This makes
15540 debugging easier. */
15541 enable_glyph_matrix_rows (current_matrix
,
15542 XFASTINT (w
->window_end_vpos
) + 1,
15546 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15547 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15549 /* Record that display has not been completed. */
15550 w
->window_end_valid
= Qnil
;
15551 w
->desired_matrix
->no_scrolling_p
= 1;
15559 /***********************************************************************
15560 More debugging support
15561 ***********************************************************************/
15565 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15566 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15567 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15570 /* Dump the contents of glyph matrix MATRIX on stderr.
15572 GLYPHS 0 means don't show glyph contents.
15573 GLYPHS 1 means show glyphs in short form
15574 GLYPHS > 1 means show glyphs in long form. */
15577 dump_glyph_matrix (matrix
, glyphs
)
15578 struct glyph_matrix
*matrix
;
15582 for (i
= 0; i
< matrix
->nrows
; ++i
)
15583 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15587 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15588 the glyph row and area where the glyph comes from. */
15591 dump_glyph (row
, glyph
, area
)
15592 struct glyph_row
*row
;
15593 struct glyph
*glyph
;
15596 if (glyph
->type
== CHAR_GLYPH
)
15599 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15600 glyph
- row
->glyphs
[TEXT_AREA
],
15603 (BUFFERP (glyph
->object
)
15605 : (STRINGP (glyph
->object
)
15608 glyph
->pixel_width
,
15610 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15614 glyph
->left_box_line_p
,
15615 glyph
->right_box_line_p
);
15617 else if (glyph
->type
== STRETCH_GLYPH
)
15620 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15621 glyph
- row
->glyphs
[TEXT_AREA
],
15624 (BUFFERP (glyph
->object
)
15626 : (STRINGP (glyph
->object
)
15629 glyph
->pixel_width
,
15633 glyph
->left_box_line_p
,
15634 glyph
->right_box_line_p
);
15636 else if (glyph
->type
== IMAGE_GLYPH
)
15639 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15640 glyph
- row
->glyphs
[TEXT_AREA
],
15643 (BUFFERP (glyph
->object
)
15645 : (STRINGP (glyph
->object
)
15648 glyph
->pixel_width
,
15652 glyph
->left_box_line_p
,
15653 glyph
->right_box_line_p
);
15655 else if (glyph
->type
== COMPOSITE_GLYPH
)
15658 " %5d %4c %6d %c %3d 0x%05x",
15659 glyph
- row
->glyphs
[TEXT_AREA
],
15662 (BUFFERP (glyph
->object
)
15664 : (STRINGP (glyph
->object
)
15667 glyph
->pixel_width
,
15669 if (glyph
->u
.cmp
.automatic
)
15672 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
15673 fprintf (stderr
, " . %4d %1.1d%1.1d\n"
15675 glyph
->left_box_line_p
,
15676 glyph
->right_box_line_p
);
15681 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15682 GLYPHS 0 means don't show glyph contents.
15683 GLYPHS 1 means show glyphs in short form
15684 GLYPHS > 1 means show glyphs in long form. */
15687 dump_glyph_row (row
, vpos
, glyphs
)
15688 struct glyph_row
*row
;
15693 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15694 fprintf (stderr
, "======================================================================\n");
15696 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15697 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15699 MATRIX_ROW_START_CHARPOS (row
),
15700 MATRIX_ROW_END_CHARPOS (row
),
15701 row
->used
[TEXT_AREA
],
15702 row
->contains_overlapping_glyphs_p
,
15704 row
->truncated_on_left_p
,
15705 row
->truncated_on_right_p
,
15707 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15708 row
->displays_text_p
,
15711 row
->ends_in_middle_of_char_p
,
15712 row
->starts_in_middle_of_char_p
,
15718 row
->visible_height
,
15721 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15722 row
->end
.overlay_string_index
,
15723 row
->continuation_lines_width
);
15724 fprintf (stderr
, "%9d %5d\n",
15725 CHARPOS (row
->start
.string_pos
),
15726 CHARPOS (row
->end
.string_pos
));
15727 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15728 row
->end
.dpvec_index
);
15735 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15737 struct glyph
*glyph
= row
->glyphs
[area
];
15738 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15740 /* Glyph for a line end in text. */
15741 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15744 if (glyph
< glyph_end
)
15745 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15747 for (; glyph
< glyph_end
; ++glyph
)
15748 dump_glyph (row
, glyph
, area
);
15751 else if (glyphs
== 1)
15755 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15757 char *s
= (char *) alloca (row
->used
[area
] + 1);
15760 for (i
= 0; i
< row
->used
[area
]; ++i
)
15762 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15763 if (glyph
->type
== CHAR_GLYPH
15764 && glyph
->u
.ch
< 0x80
15765 && glyph
->u
.ch
>= ' ')
15766 s
[i
] = glyph
->u
.ch
;
15772 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15778 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15779 Sdump_glyph_matrix
, 0, 1, "p",
15780 doc
: /* Dump the current matrix of the selected window to stderr.
15781 Shows contents of glyph row structures. With non-nil
15782 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15783 glyphs in short form, otherwise show glyphs in long form. */)
15785 Lisp_Object glyphs
;
15787 struct window
*w
= XWINDOW (selected_window
);
15788 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15790 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15791 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15792 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15793 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15794 fprintf (stderr
, "=============================================\n");
15795 dump_glyph_matrix (w
->current_matrix
,
15796 NILP (glyphs
) ? 0 : XINT (glyphs
));
15801 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15802 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15805 struct frame
*f
= XFRAME (selected_frame
);
15806 dump_glyph_matrix (f
->current_matrix
, 1);
15811 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15812 doc
: /* Dump glyph row ROW to stderr.
15813 GLYPH 0 means don't dump glyphs.
15814 GLYPH 1 means dump glyphs in short form.
15815 GLYPH > 1 or omitted means dump glyphs in long form. */)
15817 Lisp_Object row
, glyphs
;
15819 struct glyph_matrix
*matrix
;
15822 CHECK_NUMBER (row
);
15823 matrix
= XWINDOW (selected_window
)->current_matrix
;
15825 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15826 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15828 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15833 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15834 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15835 GLYPH 0 means don't dump glyphs.
15836 GLYPH 1 means dump glyphs in short form.
15837 GLYPH > 1 or omitted means dump glyphs in long form. */)
15839 Lisp_Object row
, glyphs
;
15841 struct frame
*sf
= SELECTED_FRAME ();
15842 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15845 CHECK_NUMBER (row
);
15847 if (vpos
>= 0 && vpos
< m
->nrows
)
15848 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15849 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15854 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15855 doc
: /* Toggle tracing of redisplay.
15856 With ARG, turn tracing on if and only if ARG is positive. */)
15861 trace_redisplay_p
= !trace_redisplay_p
;
15864 arg
= Fprefix_numeric_value (arg
);
15865 trace_redisplay_p
= XINT (arg
) > 0;
15872 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15873 doc
: /* Like `format', but print result to stderr.
15874 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15879 Lisp_Object s
= Fformat (nargs
, args
);
15880 fprintf (stderr
, "%s", SDATA (s
));
15884 #endif /* GLYPH_DEBUG */
15888 /***********************************************************************
15889 Building Desired Matrix Rows
15890 ***********************************************************************/
15892 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15893 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15895 static struct glyph_row
*
15896 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15898 Lisp_Object overlay_arrow_string
;
15900 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15901 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15902 struct buffer
*old
= current_buffer
;
15903 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15904 int arrow_len
= SCHARS (overlay_arrow_string
);
15905 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15906 const unsigned char *p
;
15909 int n_glyphs_before
;
15911 set_buffer_temp (buffer
);
15912 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15913 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15914 SET_TEXT_POS (it
.position
, 0, 0);
15916 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15918 while (p
< arrow_end
)
15920 Lisp_Object face
, ilisp
;
15922 /* Get the next character. */
15924 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15926 it
.c
= *p
, it
.len
= 1;
15929 /* Get its face. */
15930 ilisp
= make_number (p
- arrow_string
);
15931 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15932 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15934 /* Compute its width, get its glyphs. */
15935 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15936 SET_TEXT_POS (it
.position
, -1, -1);
15937 PRODUCE_GLYPHS (&it
);
15939 /* If this character doesn't fit any more in the line, we have
15940 to remove some glyphs. */
15941 if (it
.current_x
> it
.last_visible_x
)
15943 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15948 set_buffer_temp (old
);
15949 return it
.glyph_row
;
15953 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15954 glyphs are only inserted for terminal frames since we can't really
15955 win with truncation glyphs when partially visible glyphs are
15956 involved. Which glyphs to insert is determined by
15957 produce_special_glyphs. */
15960 insert_left_trunc_glyphs (it
)
15963 struct it truncate_it
;
15964 struct glyph
*from
, *end
, *to
, *toend
;
15966 xassert (!FRAME_WINDOW_P (it
->f
));
15968 /* Get the truncation glyphs. */
15970 truncate_it
.current_x
= 0;
15971 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15972 truncate_it
.glyph_row
= &scratch_glyph_row
;
15973 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15974 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15975 truncate_it
.object
= make_number (0);
15976 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15978 /* Overwrite glyphs from IT with truncation glyphs. */
15979 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15980 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15981 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15982 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15987 /* There may be padding glyphs left over. Overwrite them too. */
15988 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15990 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15996 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16000 /* Compute the pixel height and width of IT->glyph_row.
16002 Most of the time, ascent and height of a display line will be equal
16003 to the max_ascent and max_height values of the display iterator
16004 structure. This is not the case if
16006 1. We hit ZV without displaying anything. In this case, max_ascent
16007 and max_height will be zero.
16009 2. We have some glyphs that don't contribute to the line height.
16010 (The glyph row flag contributes_to_line_height_p is for future
16011 pixmap extensions).
16013 The first case is easily covered by using default values because in
16014 these cases, the line height does not really matter, except that it
16015 must not be zero. */
16018 compute_line_metrics (it
)
16021 struct glyph_row
*row
= it
->glyph_row
;
16024 if (FRAME_WINDOW_P (it
->f
))
16026 int i
, min_y
, max_y
;
16028 /* The line may consist of one space only, that was added to
16029 place the cursor on it. If so, the row's height hasn't been
16031 if (row
->height
== 0)
16033 if (it
->max_ascent
+ it
->max_descent
== 0)
16034 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16035 row
->ascent
= it
->max_ascent
;
16036 row
->height
= it
->max_ascent
+ it
->max_descent
;
16037 row
->phys_ascent
= it
->max_phys_ascent
;
16038 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16039 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16042 /* Compute the width of this line. */
16043 row
->pixel_width
= row
->x
;
16044 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16045 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16047 xassert (row
->pixel_width
>= 0);
16048 xassert (row
->ascent
>= 0 && row
->height
> 0);
16050 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16051 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16053 /* If first line's physical ascent is larger than its logical
16054 ascent, use the physical ascent, and make the row taller.
16055 This makes accented characters fully visible. */
16056 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16057 && row
->phys_ascent
> row
->ascent
)
16059 row
->height
+= row
->phys_ascent
- row
->ascent
;
16060 row
->ascent
= row
->phys_ascent
;
16063 /* Compute how much of the line is visible. */
16064 row
->visible_height
= row
->height
;
16066 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16067 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16069 if (row
->y
< min_y
)
16070 row
->visible_height
-= min_y
- row
->y
;
16071 if (row
->y
+ row
->height
> max_y
)
16072 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16076 row
->pixel_width
= row
->used
[TEXT_AREA
];
16077 if (row
->continued_p
)
16078 row
->pixel_width
-= it
->continuation_pixel_width
;
16079 else if (row
->truncated_on_right_p
)
16080 row
->pixel_width
-= it
->truncation_pixel_width
;
16081 row
->ascent
= row
->phys_ascent
= 0;
16082 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16083 row
->extra_line_spacing
= 0;
16086 /* Compute a hash code for this row. */
16088 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16089 for (i
= 0; i
< row
->used
[area
]; ++i
)
16090 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16091 + row
->glyphs
[area
][i
].u
.val
16092 + row
->glyphs
[area
][i
].face_id
16093 + row
->glyphs
[area
][i
].padding_p
16094 + (row
->glyphs
[area
][i
].type
<< 2));
16096 it
->max_ascent
= it
->max_descent
= 0;
16097 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16101 /* Append one space to the glyph row of iterator IT if doing a
16102 window-based redisplay. The space has the same face as
16103 IT->face_id. Value is non-zero if a space was added.
16105 This function is called to make sure that there is always one glyph
16106 at the end of a glyph row that the cursor can be set on under
16107 window-systems. (If there weren't such a glyph we would not know
16108 how wide and tall a box cursor should be displayed).
16110 At the same time this space let's a nicely handle clearing to the
16111 end of the line if the row ends in italic text. */
16114 append_space_for_newline (it
, default_face_p
)
16116 int default_face_p
;
16118 if (FRAME_WINDOW_P (it
->f
))
16120 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16122 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16123 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16125 /* Save some values that must not be changed.
16126 Must save IT->c and IT->len because otherwise
16127 ITERATOR_AT_END_P wouldn't work anymore after
16128 append_space_for_newline has been called. */
16129 enum display_element_type saved_what
= it
->what
;
16130 int saved_c
= it
->c
, saved_len
= it
->len
;
16131 int saved_x
= it
->current_x
;
16132 int saved_face_id
= it
->face_id
;
16133 struct text_pos saved_pos
;
16134 Lisp_Object saved_object
;
16137 saved_object
= it
->object
;
16138 saved_pos
= it
->position
;
16140 it
->what
= IT_CHARACTER
;
16141 bzero (&it
->position
, sizeof it
->position
);
16142 it
->object
= make_number (0);
16146 if (default_face_p
)
16147 it
->face_id
= DEFAULT_FACE_ID
;
16148 else if (it
->face_before_selective_p
)
16149 it
->face_id
= it
->saved_face_id
;
16150 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16151 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16153 PRODUCE_GLYPHS (it
);
16155 it
->override_ascent
= -1;
16156 it
->constrain_row_ascent_descent_p
= 0;
16157 it
->current_x
= saved_x
;
16158 it
->object
= saved_object
;
16159 it
->position
= saved_pos
;
16160 it
->what
= saved_what
;
16161 it
->face_id
= saved_face_id
;
16162 it
->len
= saved_len
;
16172 /* Extend the face of the last glyph in the text area of IT->glyph_row
16173 to the end of the display line. Called from display_line.
16174 If the glyph row is empty, add a space glyph to it so that we
16175 know the face to draw. Set the glyph row flag fill_line_p. */
16178 extend_face_to_end_of_line (it
)
16182 struct frame
*f
= it
->f
;
16184 /* If line is already filled, do nothing. */
16185 if (it
->current_x
>= it
->last_visible_x
)
16188 /* Face extension extends the background and box of IT->face_id
16189 to the end of the line. If the background equals the background
16190 of the frame, we don't have to do anything. */
16191 if (it
->face_before_selective_p
)
16192 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16194 face
= FACE_FROM_ID (f
, it
->face_id
);
16196 if (FRAME_WINDOW_P (f
)
16197 && it
->glyph_row
->displays_text_p
16198 && face
->box
== FACE_NO_BOX
16199 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16203 /* Set the glyph row flag indicating that the face of the last glyph
16204 in the text area has to be drawn to the end of the text area. */
16205 it
->glyph_row
->fill_line_p
= 1;
16207 /* If current character of IT is not ASCII, make sure we have the
16208 ASCII face. This will be automatically undone the next time
16209 get_next_display_element returns a multibyte character. Note
16210 that the character will always be single byte in unibyte text. */
16211 if (!ASCII_CHAR_P (it
->c
))
16213 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16216 if (FRAME_WINDOW_P (f
))
16218 /* If the row is empty, add a space with the current face of IT,
16219 so that we know which face to draw. */
16220 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16222 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16223 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16224 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16229 /* Save some values that must not be changed. */
16230 int saved_x
= it
->current_x
;
16231 struct text_pos saved_pos
;
16232 Lisp_Object saved_object
;
16233 enum display_element_type saved_what
= it
->what
;
16234 int saved_face_id
= it
->face_id
;
16236 saved_object
= it
->object
;
16237 saved_pos
= it
->position
;
16239 it
->what
= IT_CHARACTER
;
16240 bzero (&it
->position
, sizeof it
->position
);
16241 it
->object
= make_number (0);
16244 it
->face_id
= face
->id
;
16246 PRODUCE_GLYPHS (it
);
16248 while (it
->current_x
<= it
->last_visible_x
)
16249 PRODUCE_GLYPHS (it
);
16251 /* Don't count these blanks really. It would let us insert a left
16252 truncation glyph below and make us set the cursor on them, maybe. */
16253 it
->current_x
= saved_x
;
16254 it
->object
= saved_object
;
16255 it
->position
= saved_pos
;
16256 it
->what
= saved_what
;
16257 it
->face_id
= saved_face_id
;
16262 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16263 trailing whitespace. */
16266 trailing_whitespace_p (charpos
)
16269 int bytepos
= CHAR_TO_BYTE (charpos
);
16272 while (bytepos
< ZV_BYTE
16273 && (c
= FETCH_CHAR (bytepos
),
16274 c
== ' ' || c
== '\t'))
16277 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16279 if (bytepos
!= PT_BYTE
)
16286 /* Highlight trailing whitespace, if any, in ROW. */
16289 highlight_trailing_whitespace (f
, row
)
16291 struct glyph_row
*row
;
16293 int used
= row
->used
[TEXT_AREA
];
16297 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16298 struct glyph
*glyph
= start
+ used
- 1;
16300 /* Skip over glyphs inserted to display the cursor at the
16301 end of a line, for extending the face of the last glyph
16302 to the end of the line on terminals, and for truncation
16303 and continuation glyphs. */
16304 while (glyph
>= start
16305 && glyph
->type
== CHAR_GLYPH
16306 && INTEGERP (glyph
->object
))
16309 /* If last glyph is a space or stretch, and it's trailing
16310 whitespace, set the face of all trailing whitespace glyphs in
16311 IT->glyph_row to `trailing-whitespace'. */
16313 && BUFFERP (glyph
->object
)
16314 && (glyph
->type
== STRETCH_GLYPH
16315 || (glyph
->type
== CHAR_GLYPH
16316 && glyph
->u
.ch
== ' '))
16317 && trailing_whitespace_p (glyph
->charpos
))
16319 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16323 while (glyph
>= start
16324 && BUFFERP (glyph
->object
)
16325 && (glyph
->type
== STRETCH_GLYPH
16326 || (glyph
->type
== CHAR_GLYPH
16327 && glyph
->u
.ch
== ' ')))
16328 (glyph
--)->face_id
= face_id
;
16334 /* Value is non-zero if glyph row ROW in window W should be
16335 used to hold the cursor. */
16338 cursor_row_p (w
, row
)
16340 struct glyph_row
*row
;
16342 int cursor_row_p
= 1;
16344 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16346 /* Suppose the row ends on a string.
16347 Unless the row is continued, that means it ends on a newline
16348 in the string. If it's anything other than a display string
16349 (e.g. a before-string from an overlay), we don't want the
16350 cursor there. (This heuristic seems to give the optimal
16351 behavior for the various types of multi-line strings.) */
16352 if (CHARPOS (row
->end
.string_pos
) >= 0)
16354 if (row
->continued_p
)
16358 /* Check for `display' property. */
16359 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16360 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16361 struct glyph
*glyph
;
16364 for (glyph
= end
; glyph
>= beg
; --glyph
)
16365 if (STRINGP (glyph
->object
))
16368 = Fget_char_property (make_number (PT
),
16372 && display_prop_string_p (prop
, glyph
->object
));
16377 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16379 /* If the row ends in middle of a real character,
16380 and the line is continued, we want the cursor here.
16381 That's because MATRIX_ROW_END_CHARPOS would equal
16382 PT if PT is before the character. */
16383 if (!row
->ends_in_ellipsis_p
)
16384 cursor_row_p
= row
->continued_p
;
16386 /* If the row ends in an ellipsis, then
16387 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16388 We want that position to be displayed after the ellipsis. */
16391 /* If the row ends at ZV, display the cursor at the end of that
16392 row instead of at the start of the row below. */
16393 else if (row
->ends_at_zv_p
)
16399 return cursor_row_p
;
16404 /* Push the display property PROP so that it will be rendered at the
16405 current position in IT. */
16408 push_display_prop (struct it
*it
, Lisp_Object prop
)
16412 /* Never display a cursor on the prefix. */
16413 it
->avoid_cursor_p
= 1;
16415 if (STRINGP (prop
))
16417 if (SCHARS (prop
) == 0)
16424 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16425 it
->current
.overlay_string_index
= -1;
16426 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16427 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16428 it
->method
= GET_FROM_STRING
;
16429 it
->stop_charpos
= 0;
16431 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16433 it
->method
= GET_FROM_STRETCH
;
16436 #ifdef HAVE_WINDOW_SYSTEM
16437 else if (IMAGEP (prop
))
16439 it
->what
= IT_IMAGE
;
16440 it
->image_id
= lookup_image (it
->f
, prop
);
16441 it
->method
= GET_FROM_IMAGE
;
16443 #endif /* HAVE_WINDOW_SYSTEM */
16446 pop_it (it
); /* bogus display property, give up */
16451 /* Return the character-property PROP at the current position in IT. */
16454 get_it_property (it
, prop
)
16458 Lisp_Object position
;
16460 if (STRINGP (it
->object
))
16461 position
= make_number (IT_STRING_CHARPOS (*it
));
16462 else if (BUFFERP (it
->object
))
16463 position
= make_number (IT_CHARPOS (*it
));
16467 return Fget_char_property (position
, prop
, it
->object
);
16470 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16473 handle_line_prefix (struct it
*it
)
16475 Lisp_Object prefix
;
16476 if (it
->continuation_lines_width
> 0)
16478 prefix
= get_it_property (it
, Qwrap_prefix
);
16480 prefix
= Vwrap_prefix
;
16484 prefix
= get_it_property (it
, Qline_prefix
);
16486 prefix
= Vline_prefix
;
16488 if (! NILP (prefix
))
16489 push_display_prop (it
, prefix
);
16494 /* Construct the glyph row IT->glyph_row in the desired matrix of
16495 IT->w from text at the current position of IT. See dispextern.h
16496 for an overview of struct it. Value is non-zero if
16497 IT->glyph_row displays text, as opposed to a line displaying ZV
16504 struct glyph_row
*row
= it
->glyph_row
;
16505 Lisp_Object overlay_arrow_string
;
16507 int may_wrap
= 0, wrap_x
;
16508 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16509 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16510 int wrap_row_extra_line_spacing
;
16512 /* We always start displaying at hpos zero even if hscrolled. */
16513 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16515 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16516 >= it
->w
->desired_matrix
->nrows
)
16518 it
->w
->nrows_scale_factor
++;
16519 fonts_changed_p
= 1;
16523 /* Is IT->w showing the region? */
16524 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16526 /* Clear the result glyph row and enable it. */
16527 prepare_desired_row (row
);
16529 row
->y
= it
->current_y
;
16530 row
->start
= it
->start
;
16531 row
->continuation_lines_width
= it
->continuation_lines_width
;
16532 row
->displays_text_p
= 1;
16533 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16534 it
->starts_in_middle_of_char_p
= 0;
16536 /* Arrange the overlays nicely for our purposes. Usually, we call
16537 display_line on only one line at a time, in which case this
16538 can't really hurt too much, or we call it on lines which appear
16539 one after another in the buffer, in which case all calls to
16540 recenter_overlay_lists but the first will be pretty cheap. */
16541 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16543 /* Move over display elements that are not visible because we are
16544 hscrolled. This may stop at an x-position < IT->first_visible_x
16545 if the first glyph is partially visible or if we hit a line end. */
16546 if (it
->current_x
< it
->first_visible_x
)
16548 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16549 MOVE_TO_POS
| MOVE_TO_X
);
16553 /* We only do this when not calling `move_it_in_display_line_to'
16554 above, because move_it_in_display_line_to calls
16555 handle_line_prefix itself. */
16556 handle_line_prefix (it
);
16559 /* Get the initial row height. This is either the height of the
16560 text hscrolled, if there is any, or zero. */
16561 row
->ascent
= it
->max_ascent
;
16562 row
->height
= it
->max_ascent
+ it
->max_descent
;
16563 row
->phys_ascent
= it
->max_phys_ascent
;
16564 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16565 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16567 /* Loop generating characters. The loop is left with IT on the next
16568 character to display. */
16571 int n_glyphs_before
, hpos_before
, x_before
;
16573 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16575 /* Retrieve the next thing to display. Value is zero if end of
16577 if (!get_next_display_element (it
))
16579 /* Maybe add a space at the end of this line that is used to
16580 display the cursor there under X. Set the charpos of the
16581 first glyph of blank lines not corresponding to any text
16583 #ifdef HAVE_WINDOW_SYSTEM
16584 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16585 row
->exact_window_width_line_p
= 1;
16587 #endif /* HAVE_WINDOW_SYSTEM */
16588 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16589 || row
->used
[TEXT_AREA
] == 0)
16591 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16592 row
->displays_text_p
= 0;
16594 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16595 && (!MINI_WINDOW_P (it
->w
)
16596 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16597 row
->indicate_empty_line_p
= 1;
16600 it
->continuation_lines_width
= 0;
16601 row
->ends_at_zv_p
= 1;
16605 /* Now, get the metrics of what we want to display. This also
16606 generates glyphs in `row' (which is IT->glyph_row). */
16607 n_glyphs_before
= row
->used
[TEXT_AREA
];
16610 /* Remember the line height so far in case the next element doesn't
16611 fit on the line. */
16612 if (it
->line_wrap
!= TRUNCATE
)
16614 ascent
= it
->max_ascent
;
16615 descent
= it
->max_descent
;
16616 phys_ascent
= it
->max_phys_ascent
;
16617 phys_descent
= it
->max_phys_descent
;
16619 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16621 if (IT_DISPLAYING_WHITESPACE (it
))
16627 wrap_row_used
= row
->used
[TEXT_AREA
];
16628 wrap_row_ascent
= row
->ascent
;
16629 wrap_row_height
= row
->height
;
16630 wrap_row_phys_ascent
= row
->phys_ascent
;
16631 wrap_row_phys_height
= row
->phys_height
;
16632 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16638 PRODUCE_GLYPHS (it
);
16640 /* If this display element was in marginal areas, continue with
16642 if (it
->area
!= TEXT_AREA
)
16644 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16645 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16646 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16647 row
->phys_height
= max (row
->phys_height
,
16648 it
->max_phys_ascent
+ it
->max_phys_descent
);
16649 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16650 it
->max_extra_line_spacing
);
16651 set_iterator_to_next (it
, 1);
16655 /* Does the display element fit on the line? If we truncate
16656 lines, we should draw past the right edge of the window. If
16657 we don't truncate, we want to stop so that we can display the
16658 continuation glyph before the right margin. If lines are
16659 continued, there are two possible strategies for characters
16660 resulting in more than 1 glyph (e.g. tabs): Display as many
16661 glyphs as possible in this line and leave the rest for the
16662 continuation line, or display the whole element in the next
16663 line. Original redisplay did the former, so we do it also. */
16664 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16665 hpos_before
= it
->hpos
;
16668 if (/* Not a newline. */
16670 /* Glyphs produced fit entirely in the line. */
16671 && it
->current_x
< it
->last_visible_x
)
16673 it
->hpos
+= nglyphs
;
16674 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16675 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16676 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16677 row
->phys_height
= max (row
->phys_height
,
16678 it
->max_phys_ascent
+ it
->max_phys_descent
);
16679 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16680 it
->max_extra_line_spacing
);
16681 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16682 row
->x
= x
- it
->first_visible_x
;
16687 struct glyph
*glyph
;
16689 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16691 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16692 new_x
= x
+ glyph
->pixel_width
;
16694 if (/* Lines are continued. */
16695 it
->line_wrap
!= TRUNCATE
16696 && (/* Glyph doesn't fit on the line. */
16697 new_x
> it
->last_visible_x
16698 /* Or it fits exactly on a window system frame. */
16699 || (new_x
== it
->last_visible_x
16700 && FRAME_WINDOW_P (it
->f
))))
16702 /* End of a continued line. */
16705 || (new_x
== it
->last_visible_x
16706 && FRAME_WINDOW_P (it
->f
)))
16708 /* Current glyph is the only one on the line or
16709 fits exactly on the line. We must continue
16710 the line because we can't draw the cursor
16711 after the glyph. */
16712 row
->continued_p
= 1;
16713 it
->current_x
= new_x
;
16714 it
->continuation_lines_width
+= new_x
;
16716 if (i
== nglyphs
- 1)
16718 /* If line-wrap is on, check if a previous
16719 wrap point was found. */
16720 if (wrap_row_used
> 0
16721 /* Even if there is a previous wrap
16722 point, continue the line here as
16723 usual, if (i) the previous character
16724 was a space or tab AND (ii) the
16725 current character is not. */
16727 || IT_DISPLAYING_WHITESPACE (it
)))
16730 set_iterator_to_next (it
, 1);
16731 #ifdef HAVE_WINDOW_SYSTEM
16732 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16734 if (!get_next_display_element (it
))
16736 row
->exact_window_width_line_p
= 1;
16737 it
->continuation_lines_width
= 0;
16738 row
->continued_p
= 0;
16739 row
->ends_at_zv_p
= 1;
16741 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16743 row
->continued_p
= 0;
16744 row
->exact_window_width_line_p
= 1;
16747 #endif /* HAVE_WINDOW_SYSTEM */
16750 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16751 && !FRAME_WINDOW_P (it
->f
))
16753 /* A padding glyph that doesn't fit on this line.
16754 This means the whole character doesn't fit
16756 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16758 /* Fill the rest of the row with continuation
16759 glyphs like in 20.x. */
16760 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16761 < row
->glyphs
[1 + TEXT_AREA
])
16762 produce_special_glyphs (it
, IT_CONTINUATION
);
16764 row
->continued_p
= 1;
16765 it
->current_x
= x_before
;
16766 it
->continuation_lines_width
+= x_before
;
16768 /* Restore the height to what it was before the
16769 element not fitting on the line. */
16770 it
->max_ascent
= ascent
;
16771 it
->max_descent
= descent
;
16772 it
->max_phys_ascent
= phys_ascent
;
16773 it
->max_phys_descent
= phys_descent
;
16775 else if (wrap_row_used
> 0)
16779 it
->continuation_lines_width
+= wrap_x
;
16780 row
->used
[TEXT_AREA
] = wrap_row_used
;
16781 row
->ascent
= wrap_row_ascent
;
16782 row
->height
= wrap_row_height
;
16783 row
->phys_ascent
= wrap_row_phys_ascent
;
16784 row
->phys_height
= wrap_row_phys_height
;
16785 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16786 row
->continued_p
= 1;
16787 row
->ends_at_zv_p
= 0;
16788 row
->exact_window_width_line_p
= 0;
16789 it
->continuation_lines_width
+= x
;
16791 /* Make sure that a non-default face is extended
16792 up to the right margin of the window. */
16793 extend_face_to_end_of_line (it
);
16795 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16797 /* A TAB that extends past the right edge of the
16798 window. This produces a single glyph on
16799 window system frames. We leave the glyph in
16800 this row and let it fill the row, but don't
16801 consume the TAB. */
16802 it
->continuation_lines_width
+= it
->last_visible_x
;
16803 row
->ends_in_middle_of_char_p
= 1;
16804 row
->continued_p
= 1;
16805 glyph
->pixel_width
= it
->last_visible_x
- x
;
16806 it
->starts_in_middle_of_char_p
= 1;
16810 /* Something other than a TAB that draws past
16811 the right edge of the window. Restore
16812 positions to values before the element. */
16813 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16815 /* Display continuation glyphs. */
16816 if (!FRAME_WINDOW_P (it
->f
))
16817 produce_special_glyphs (it
, IT_CONTINUATION
);
16818 row
->continued_p
= 1;
16820 it
->current_x
= x_before
;
16821 it
->continuation_lines_width
+= x
;
16822 extend_face_to_end_of_line (it
);
16824 if (nglyphs
> 1 && i
> 0)
16826 row
->ends_in_middle_of_char_p
= 1;
16827 it
->starts_in_middle_of_char_p
= 1;
16830 /* Restore the height to what it was before the
16831 element not fitting on the line. */
16832 it
->max_ascent
= ascent
;
16833 it
->max_descent
= descent
;
16834 it
->max_phys_ascent
= phys_ascent
;
16835 it
->max_phys_descent
= phys_descent
;
16840 else if (new_x
> it
->first_visible_x
)
16842 /* Increment number of glyphs actually displayed. */
16845 if (x
< it
->first_visible_x
)
16846 /* Glyph is partially visible, i.e. row starts at
16847 negative X position. */
16848 row
->x
= x
- it
->first_visible_x
;
16852 /* Glyph is completely off the left margin of the
16853 window. This should not happen because of the
16854 move_it_in_display_line at the start of this
16855 function, unless the text display area of the
16856 window is empty. */
16857 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16861 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16862 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16863 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16864 row
->phys_height
= max (row
->phys_height
,
16865 it
->max_phys_ascent
+ it
->max_phys_descent
);
16866 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16867 it
->max_extra_line_spacing
);
16869 /* End of this display line if row is continued. */
16870 if (row
->continued_p
|| row
->ends_at_zv_p
)
16875 /* Is this a line end? If yes, we're also done, after making
16876 sure that a non-default face is extended up to the right
16877 margin of the window. */
16878 if (ITERATOR_AT_END_OF_LINE_P (it
))
16880 int used_before
= row
->used
[TEXT_AREA
];
16882 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16884 #ifdef HAVE_WINDOW_SYSTEM
16885 /* Add a space at the end of the line that is used to
16886 display the cursor there. */
16887 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16888 append_space_for_newline (it
, 0);
16889 #endif /* HAVE_WINDOW_SYSTEM */
16891 /* Extend the face to the end of the line. */
16892 extend_face_to_end_of_line (it
);
16894 /* Make sure we have the position. */
16895 if (used_before
== 0)
16896 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16898 /* Consume the line end. This skips over invisible lines. */
16899 set_iterator_to_next (it
, 1);
16900 it
->continuation_lines_width
= 0;
16904 /* Proceed with next display element. Note that this skips
16905 over lines invisible because of selective display. */
16906 set_iterator_to_next (it
, 1);
16908 /* If we truncate lines, we are done when the last displayed
16909 glyphs reach past the right margin of the window. */
16910 if (it
->line_wrap
== TRUNCATE
16911 && (FRAME_WINDOW_P (it
->f
)
16912 ? (it
->current_x
>= it
->last_visible_x
)
16913 : (it
->current_x
> it
->last_visible_x
)))
16915 /* Maybe add truncation glyphs. */
16916 if (!FRAME_WINDOW_P (it
->f
))
16920 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16921 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16924 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16926 row
->used
[TEXT_AREA
] = i
;
16927 produce_special_glyphs (it
, IT_TRUNCATION
);
16930 #ifdef HAVE_WINDOW_SYSTEM
16933 /* Don't truncate if we can overflow newline into fringe. */
16934 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16936 if (!get_next_display_element (it
))
16938 it
->continuation_lines_width
= 0;
16939 row
->ends_at_zv_p
= 1;
16940 row
->exact_window_width_line_p
= 1;
16943 if (ITERATOR_AT_END_OF_LINE_P (it
))
16945 row
->exact_window_width_line_p
= 1;
16946 goto at_end_of_line
;
16950 #endif /* HAVE_WINDOW_SYSTEM */
16952 row
->truncated_on_right_p
= 1;
16953 it
->continuation_lines_width
= 0;
16954 reseat_at_next_visible_line_start (it
, 0);
16955 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16956 it
->hpos
= hpos_before
;
16957 it
->current_x
= x_before
;
16962 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16963 at the left window margin. */
16964 if (it
->first_visible_x
16965 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16967 if (!FRAME_WINDOW_P (it
->f
))
16968 insert_left_trunc_glyphs (it
);
16969 row
->truncated_on_left_p
= 1;
16972 /* If the start of this line is the overlay arrow-position, then
16973 mark this glyph row as the one containing the overlay arrow.
16974 This is clearly a mess with variable size fonts. It would be
16975 better to let it be displayed like cursors under X. */
16976 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16977 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16978 !NILP (overlay_arrow_string
)))
16980 /* Overlay arrow in window redisplay is a fringe bitmap. */
16981 if (STRINGP (overlay_arrow_string
))
16983 struct glyph_row
*arrow_row
16984 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16985 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16986 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16987 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16988 struct glyph
*p2
, *end
;
16990 /* Copy the arrow glyphs. */
16991 while (glyph
< arrow_end
)
16994 /* Throw away padding glyphs. */
16996 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16997 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17003 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17008 xassert (INTEGERP (overlay_arrow_string
));
17009 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17011 overlay_arrow_seen
= 1;
17014 /* Compute pixel dimensions of this line. */
17015 compute_line_metrics (it
);
17017 /* Remember the position at which this line ends. */
17018 row
->end
= it
->current
;
17020 /* Record whether this row ends inside an ellipsis. */
17021 row
->ends_in_ellipsis_p
17022 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17023 && it
->ellipsis_p
);
17025 /* Save fringe bitmaps in this row. */
17026 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17027 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17028 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17029 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17031 it
->left_user_fringe_bitmap
= 0;
17032 it
->left_user_fringe_face_id
= 0;
17033 it
->right_user_fringe_bitmap
= 0;
17034 it
->right_user_fringe_face_id
= 0;
17036 /* Maybe set the cursor. */
17037 if (it
->w
->cursor
.vpos
< 0
17038 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17039 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17040 && cursor_row_p (it
->w
, row
))
17041 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17043 /* Highlight trailing whitespace. */
17044 if (!NILP (Vshow_trailing_whitespace
))
17045 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17047 /* Prepare for the next line. This line starts horizontally at (X
17048 HPOS) = (0 0). Vertical positions are incremented. As a
17049 convenience for the caller, IT->glyph_row is set to the next
17051 it
->current_x
= it
->hpos
= 0;
17052 it
->current_y
+= row
->height
;
17055 it
->start
= it
->current
;
17056 return row
->displays_text_p
;
17061 /***********************************************************************
17063 ***********************************************************************/
17065 /* Redisplay the menu bar in the frame for window W.
17067 The menu bar of X frames that don't have X toolkit support is
17068 displayed in a special window W->frame->menu_bar_window.
17070 The menu bar of terminal frames is treated specially as far as
17071 glyph matrices are concerned. Menu bar lines are not part of
17072 windows, so the update is done directly on the frame matrix rows
17073 for the menu bar. */
17076 display_menu_bar (w
)
17079 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17084 /* Don't do all this for graphical frames. */
17086 if (FRAME_W32_P (f
))
17089 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17095 if (FRAME_NS_P (f
))
17097 #endif /* HAVE_NS */
17099 #ifdef USE_X_TOOLKIT
17100 xassert (!FRAME_WINDOW_P (f
));
17101 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17102 it
.first_visible_x
= 0;
17103 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17104 #else /* not USE_X_TOOLKIT */
17105 if (FRAME_WINDOW_P (f
))
17107 /* Menu bar lines are displayed in the desired matrix of the
17108 dummy window menu_bar_window. */
17109 struct window
*menu_w
;
17110 xassert (WINDOWP (f
->menu_bar_window
));
17111 menu_w
= XWINDOW (f
->menu_bar_window
);
17112 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17114 it
.first_visible_x
= 0;
17115 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17119 /* This is a TTY frame, i.e. character hpos/vpos are used as
17121 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17123 it
.first_visible_x
= 0;
17124 it
.last_visible_x
= FRAME_COLS (f
);
17126 #endif /* not USE_X_TOOLKIT */
17128 if (! mode_line_inverse_video
)
17129 /* Force the menu-bar to be displayed in the default face. */
17130 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17132 /* Clear all rows of the menu bar. */
17133 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17135 struct glyph_row
*row
= it
.glyph_row
+ i
;
17136 clear_glyph_row (row
);
17137 row
->enabled_p
= 1;
17138 row
->full_width_p
= 1;
17141 /* Display all items of the menu bar. */
17142 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17143 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17145 Lisp_Object string
;
17147 /* Stop at nil string. */
17148 string
= AREF (items
, i
+ 1);
17152 /* Remember where item was displayed. */
17153 ASET (items
, i
+ 3, make_number (it
.hpos
));
17155 /* Display the item, pad with one space. */
17156 if (it
.current_x
< it
.last_visible_x
)
17157 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17158 SCHARS (string
) + 1, 0, 0, -1);
17161 /* Fill out the line with spaces. */
17162 if (it
.current_x
< it
.last_visible_x
)
17163 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17165 /* Compute the total height of the lines. */
17166 compute_line_metrics (&it
);
17171 /***********************************************************************
17173 ***********************************************************************/
17175 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17176 FORCE is non-zero, redisplay mode lines unconditionally.
17177 Otherwise, redisplay only mode lines that are garbaged. Value is
17178 the number of windows whose mode lines were redisplayed. */
17181 redisplay_mode_lines (window
, force
)
17182 Lisp_Object window
;
17187 while (!NILP (window
))
17189 struct window
*w
= XWINDOW (window
);
17191 if (WINDOWP (w
->hchild
))
17192 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17193 else if (WINDOWP (w
->vchild
))
17194 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17196 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17197 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17199 struct text_pos lpoint
;
17200 struct buffer
*old
= current_buffer
;
17202 /* Set the window's buffer for the mode line display. */
17203 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17204 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17206 /* Point refers normally to the selected window. For any
17207 other window, set up appropriate value. */
17208 if (!EQ (window
, selected_window
))
17210 struct text_pos pt
;
17212 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17213 if (CHARPOS (pt
) < BEGV
)
17214 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17215 else if (CHARPOS (pt
) > (ZV
- 1))
17216 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17218 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17221 /* Display mode lines. */
17222 clear_glyph_matrix (w
->desired_matrix
);
17223 if (display_mode_lines (w
))
17226 w
->must_be_updated_p
= 1;
17229 /* Restore old settings. */
17230 set_buffer_internal_1 (old
);
17231 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17241 /* Display the mode and/or top line of window W. Value is the number
17242 of mode lines displayed. */
17245 display_mode_lines (w
)
17248 Lisp_Object old_selected_window
, old_selected_frame
;
17251 old_selected_frame
= selected_frame
;
17252 selected_frame
= w
->frame
;
17253 old_selected_window
= selected_window
;
17254 XSETWINDOW (selected_window
, w
);
17256 /* These will be set while the mode line specs are processed. */
17257 line_number_displayed
= 0;
17258 w
->column_number_displayed
= Qnil
;
17260 if (WINDOW_WANTS_MODELINE_P (w
))
17262 struct window
*sel_w
= XWINDOW (old_selected_window
);
17264 /* Select mode line face based on the real selected window. */
17265 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17266 current_buffer
->mode_line_format
);
17270 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17272 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17273 current_buffer
->header_line_format
);
17277 selected_frame
= old_selected_frame
;
17278 selected_window
= old_selected_window
;
17283 /* Display mode or top line of window W. FACE_ID specifies which line
17284 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
17285 FORMAT is the mode line format to display. Value is the pixel
17286 height of the mode line displayed. */
17289 display_mode_line (w
, face_id
, format
)
17291 enum face_id face_id
;
17292 Lisp_Object format
;
17296 int count
= SPECPDL_INDEX ();
17298 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17299 /* Don't extend on a previously drawn mode-line.
17300 This may happen if called from pos_visible_p. */
17301 it
.glyph_row
->enabled_p
= 0;
17302 prepare_desired_row (it
.glyph_row
);
17304 it
.glyph_row
->mode_line_p
= 1;
17306 if (! mode_line_inverse_video
)
17307 /* Force the mode-line to be displayed in the default face. */
17308 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17310 record_unwind_protect (unwind_format_mode_line
,
17311 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17313 mode_line_target
= MODE_LINE_DISPLAY
;
17315 /* Temporarily make frame's keyboard the current kboard so that
17316 kboard-local variables in the mode_line_format will get the right
17318 push_kboard (FRAME_KBOARD (it
.f
));
17319 record_unwind_save_match_data ();
17320 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17323 unbind_to (count
, Qnil
);
17325 /* Fill up with spaces. */
17326 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17328 compute_line_metrics (&it
);
17329 it
.glyph_row
->full_width_p
= 1;
17330 it
.glyph_row
->continued_p
= 0;
17331 it
.glyph_row
->truncated_on_left_p
= 0;
17332 it
.glyph_row
->truncated_on_right_p
= 0;
17334 /* Make a 3D mode-line have a shadow at its right end. */
17335 face
= FACE_FROM_ID (it
.f
, face_id
);
17336 extend_face_to_end_of_line (&it
);
17337 if (face
->box
!= FACE_NO_BOX
)
17339 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17340 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17341 last
->right_box_line_p
= 1;
17344 return it
.glyph_row
->height
;
17347 /* Move element ELT in LIST to the front of LIST.
17348 Return the updated list. */
17351 move_elt_to_front (elt
, list
)
17352 Lisp_Object elt
, list
;
17354 register Lisp_Object tail
, prev
;
17355 register Lisp_Object tem
;
17359 while (CONSP (tail
))
17365 /* Splice out the link TAIL. */
17367 list
= XCDR (tail
);
17369 Fsetcdr (prev
, XCDR (tail
));
17371 /* Now make it the first. */
17372 Fsetcdr (tail
, list
);
17377 tail
= XCDR (tail
);
17381 /* Not found--return unchanged LIST. */
17385 /* Contribute ELT to the mode line for window IT->w. How it
17386 translates into text depends on its data type.
17388 IT describes the display environment in which we display, as usual.
17390 DEPTH is the depth in recursion. It is used to prevent
17391 infinite recursion here.
17393 FIELD_WIDTH is the number of characters the display of ELT should
17394 occupy in the mode line, and PRECISION is the maximum number of
17395 characters to display from ELT's representation. See
17396 display_string for details.
17398 Returns the hpos of the end of the text generated by ELT.
17400 PROPS is a property list to add to any string we encounter.
17402 If RISKY is nonzero, remove (disregard) any properties in any string
17403 we encounter, and ignore :eval and :propertize.
17405 The global variable `mode_line_target' determines whether the
17406 output is passed to `store_mode_line_noprop',
17407 `store_mode_line_string', or `display_string'. */
17410 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17413 int field_width
, precision
;
17414 Lisp_Object elt
, props
;
17417 int n
= 0, field
, prec
;
17422 elt
= build_string ("*too-deep*");
17426 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17430 /* A string: output it and check for %-constructs within it. */
17434 if (SCHARS (elt
) > 0
17435 && (!NILP (props
) || risky
))
17437 Lisp_Object oprops
, aelt
;
17438 oprops
= Ftext_properties_at (make_number (0), elt
);
17440 /* If the starting string's properties are not what
17441 we want, translate the string. Also, if the string
17442 is risky, do that anyway. */
17444 if (NILP (Fequal (props
, oprops
)) || risky
)
17446 /* If the starting string has properties,
17447 merge the specified ones onto the existing ones. */
17448 if (! NILP (oprops
) && !risky
)
17452 oprops
= Fcopy_sequence (oprops
);
17454 while (CONSP (tem
))
17456 oprops
= Fplist_put (oprops
, XCAR (tem
),
17457 XCAR (XCDR (tem
)));
17458 tem
= XCDR (XCDR (tem
));
17463 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17464 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17466 /* AELT is what we want. Move it to the front
17467 without consing. */
17469 mode_line_proptrans_alist
17470 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17476 /* If AELT has the wrong props, it is useless.
17477 so get rid of it. */
17479 mode_line_proptrans_alist
17480 = Fdelq (aelt
, mode_line_proptrans_alist
);
17482 elt
= Fcopy_sequence (elt
);
17483 Fset_text_properties (make_number (0), Flength (elt
),
17485 /* Add this item to mode_line_proptrans_alist. */
17486 mode_line_proptrans_alist
17487 = Fcons (Fcons (elt
, props
),
17488 mode_line_proptrans_alist
);
17489 /* Truncate mode_line_proptrans_alist
17490 to at most 50 elements. */
17491 tem
= Fnthcdr (make_number (50),
17492 mode_line_proptrans_alist
);
17494 XSETCDR (tem
, Qnil
);
17503 prec
= precision
- n
;
17504 switch (mode_line_target
)
17506 case MODE_LINE_NOPROP
:
17507 case MODE_LINE_TITLE
:
17508 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17510 case MODE_LINE_STRING
:
17511 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17513 case MODE_LINE_DISPLAY
:
17514 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17515 0, prec
, 0, STRING_MULTIBYTE (elt
));
17522 /* Handle the non-literal case. */
17524 while ((precision
<= 0 || n
< precision
)
17525 && SREF (elt
, offset
) != 0
17526 && (mode_line_target
!= MODE_LINE_DISPLAY
17527 || it
->current_x
< it
->last_visible_x
))
17529 int last_offset
= offset
;
17531 /* Advance to end of string or next format specifier. */
17532 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17535 if (offset
- 1 != last_offset
)
17537 int nchars
, nbytes
;
17539 /* Output to end of string or up to '%'. Field width
17540 is length of string. Don't output more than
17541 PRECISION allows us. */
17544 prec
= c_string_width (SDATA (elt
) + last_offset
,
17545 offset
- last_offset
, precision
- n
,
17548 switch (mode_line_target
)
17550 case MODE_LINE_NOPROP
:
17551 case MODE_LINE_TITLE
:
17552 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17554 case MODE_LINE_STRING
:
17556 int bytepos
= last_offset
;
17557 int charpos
= string_byte_to_char (elt
, bytepos
);
17558 int endpos
= (precision
<= 0
17559 ? string_byte_to_char (elt
, offset
)
17560 : charpos
+ nchars
);
17562 n
+= store_mode_line_string (NULL
,
17563 Fsubstring (elt
, make_number (charpos
),
17564 make_number (endpos
)),
17568 case MODE_LINE_DISPLAY
:
17570 int bytepos
= last_offset
;
17571 int charpos
= string_byte_to_char (elt
, bytepos
);
17573 if (precision
<= 0)
17574 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17575 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17577 STRING_MULTIBYTE (elt
));
17582 else /* c == '%' */
17584 int percent_position
= offset
;
17586 /* Get the specified minimum width. Zero means
17589 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17590 field
= field
* 10 + c
- '0';
17592 /* Don't pad beyond the total padding allowed. */
17593 if (field_width
- n
> 0 && field
> field_width
- n
)
17594 field
= field_width
- n
;
17596 /* Note that either PRECISION <= 0 or N < PRECISION. */
17597 prec
= precision
- n
;
17600 n
+= display_mode_element (it
, depth
, field
, prec
,
17601 Vglobal_mode_string
, props
,
17606 int bytepos
, charpos
;
17607 unsigned char *spec
;
17609 bytepos
= percent_position
;
17610 charpos
= (STRING_MULTIBYTE (elt
)
17611 ? string_byte_to_char (elt
, bytepos
)
17614 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17616 switch (mode_line_target
)
17618 case MODE_LINE_NOPROP
:
17619 case MODE_LINE_TITLE
:
17620 n
+= store_mode_line_noprop (spec
, field
, prec
);
17622 case MODE_LINE_STRING
:
17624 int len
= strlen (spec
);
17625 Lisp_Object tem
= make_string (spec
, len
);
17626 props
= Ftext_properties_at (make_number (charpos
), elt
);
17627 /* Should only keep face property in props */
17628 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17631 case MODE_LINE_DISPLAY
:
17633 int nglyphs_before
, nwritten
;
17635 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17636 nwritten
= display_string (spec
, Qnil
, elt
,
17641 /* Assign to the glyphs written above the
17642 string where the `%x' came from, position
17646 struct glyph
*glyph
17647 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17651 for (i
= 0; i
< nwritten
; ++i
)
17653 glyph
[i
].object
= elt
;
17654 glyph
[i
].charpos
= charpos
;
17671 /* A symbol: process the value of the symbol recursively
17672 as if it appeared here directly. Avoid error if symbol void.
17673 Special case: if value of symbol is a string, output the string
17676 register Lisp_Object tem
;
17678 /* If the variable is not marked as risky to set
17679 then its contents are risky to use. */
17680 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17683 tem
= Fboundp (elt
);
17686 tem
= Fsymbol_value (elt
);
17687 /* If value is a string, output that string literally:
17688 don't check for % within it. */
17692 if (!EQ (tem
, elt
))
17694 /* Give up right away for nil or t. */
17704 register Lisp_Object car
, tem
;
17706 /* A cons cell: five distinct cases.
17707 If first element is :eval or :propertize, do something special.
17708 If first element is a string or a cons, process all the elements
17709 and effectively concatenate them.
17710 If first element is a negative number, truncate displaying cdr to
17711 at most that many characters. If positive, pad (with spaces)
17712 to at least that many characters.
17713 If first element is a symbol, process the cadr or caddr recursively
17714 according to whether the symbol's value is non-nil or nil. */
17716 if (EQ (car
, QCeval
))
17718 /* An element of the form (:eval FORM) means evaluate FORM
17719 and use the result as mode line elements. */
17724 if (CONSP (XCDR (elt
)))
17727 spec
= safe_eval (XCAR (XCDR (elt
)));
17728 n
+= display_mode_element (it
, depth
, field_width
- n
,
17729 precision
- n
, spec
, props
,
17733 else if (EQ (car
, QCpropertize
))
17735 /* An element of the form (:propertize ELT PROPS...)
17736 means display ELT but applying properties PROPS. */
17741 if (CONSP (XCDR (elt
)))
17742 n
+= display_mode_element (it
, depth
, field_width
- n
,
17743 precision
- n
, XCAR (XCDR (elt
)),
17744 XCDR (XCDR (elt
)), risky
);
17746 else if (SYMBOLP (car
))
17748 tem
= Fboundp (car
);
17752 /* elt is now the cdr, and we know it is a cons cell.
17753 Use its car if CAR has a non-nil value. */
17756 tem
= Fsymbol_value (car
);
17763 /* Symbol's value is nil (or symbol is unbound)
17764 Get the cddr of the original list
17765 and if possible find the caddr and use that. */
17769 else if (!CONSP (elt
))
17774 else if (INTEGERP (car
))
17776 register int lim
= XINT (car
);
17780 /* Negative int means reduce maximum width. */
17781 if (precision
<= 0)
17784 precision
= min (precision
, -lim
);
17788 /* Padding specified. Don't let it be more than
17789 current maximum. */
17791 lim
= min (precision
, lim
);
17793 /* If that's more padding than already wanted, queue it.
17794 But don't reduce padding already specified even if
17795 that is beyond the current truncation point. */
17796 field_width
= max (lim
, field_width
);
17800 else if (STRINGP (car
) || CONSP (car
))
17802 register int limit
= 50;
17803 /* Limit is to protect against circular lists. */
17806 && (precision
<= 0 || n
< precision
))
17808 n
+= display_mode_element (it
, depth
,
17809 /* Do padding only after the last
17810 element in the list. */
17811 (! CONSP (XCDR (elt
))
17814 precision
- n
, XCAR (elt
),
17824 elt
= build_string ("*invalid*");
17828 /* Pad to FIELD_WIDTH. */
17829 if (field_width
> 0 && n
< field_width
)
17831 switch (mode_line_target
)
17833 case MODE_LINE_NOPROP
:
17834 case MODE_LINE_TITLE
:
17835 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17837 case MODE_LINE_STRING
:
17838 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17840 case MODE_LINE_DISPLAY
:
17841 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17850 /* Store a mode-line string element in mode_line_string_list.
17852 If STRING is non-null, display that C string. Otherwise, the Lisp
17853 string LISP_STRING is displayed.
17855 FIELD_WIDTH is the minimum number of output glyphs to produce.
17856 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17857 with spaces. FIELD_WIDTH <= 0 means don't pad.
17859 PRECISION is the maximum number of characters to output from
17860 STRING. PRECISION <= 0 means don't truncate the string.
17862 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17863 properties to the string.
17865 PROPS are the properties to add to the string.
17866 The mode_line_string_face face property is always added to the string.
17870 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17872 Lisp_Object lisp_string
;
17881 if (string
!= NULL
)
17883 len
= strlen (string
);
17884 if (precision
> 0 && len
> precision
)
17886 lisp_string
= make_string (string
, len
);
17888 props
= mode_line_string_face_prop
;
17889 else if (!NILP (mode_line_string_face
))
17891 Lisp_Object face
= Fplist_get (props
, Qface
);
17892 props
= Fcopy_sequence (props
);
17894 face
= mode_line_string_face
;
17896 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17897 props
= Fplist_put (props
, Qface
, face
);
17899 Fadd_text_properties (make_number (0), make_number (len
),
17900 props
, lisp_string
);
17904 len
= XFASTINT (Flength (lisp_string
));
17905 if (precision
> 0 && len
> precision
)
17908 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17911 if (!NILP (mode_line_string_face
))
17915 props
= Ftext_properties_at (make_number (0), lisp_string
);
17916 face
= Fplist_get (props
, Qface
);
17918 face
= mode_line_string_face
;
17920 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17921 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17923 lisp_string
= Fcopy_sequence (lisp_string
);
17926 Fadd_text_properties (make_number (0), make_number (len
),
17927 props
, lisp_string
);
17932 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17936 if (field_width
> len
)
17938 field_width
-= len
;
17939 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17941 Fadd_text_properties (make_number (0), make_number (field_width
),
17942 props
, lisp_string
);
17943 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17951 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17953 doc
: /* Format a string out of a mode line format specification.
17954 First arg FORMAT specifies the mode line format (see `mode-line-format'
17955 for details) to use.
17957 Optional second arg FACE specifies the face property to put
17958 on all characters for which no face is specified.
17959 The value t means whatever face the window's mode line currently uses
17960 \(either `mode-line' or `mode-line-inactive', depending).
17961 A value of nil means the default is no face property.
17962 If FACE is an integer, the value string has no text properties.
17964 Optional third and fourth args WINDOW and BUFFER specify the window
17965 and buffer to use as the context for the formatting (defaults
17966 are the selected window and the window's buffer). */)
17967 (format
, face
, window
, buffer
)
17968 Lisp_Object format
, face
, window
, buffer
;
17973 struct buffer
*old_buffer
= NULL
;
17975 int no_props
= INTEGERP (face
);
17976 int count
= SPECPDL_INDEX ();
17978 int string_start
= 0;
17981 window
= selected_window
;
17982 CHECK_WINDOW (window
);
17983 w
= XWINDOW (window
);
17986 buffer
= w
->buffer
;
17987 CHECK_BUFFER (buffer
);
17989 /* Make formatting the modeline a non-op when noninteractive, otherwise
17990 there will be problems later caused by a partially initialized frame. */
17991 if (NILP (format
) || noninteractive
)
17992 return empty_unibyte_string
;
18000 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18001 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18005 face_id
= DEFAULT_FACE_ID
;
18007 if (XBUFFER (buffer
) != current_buffer
)
18008 old_buffer
= current_buffer
;
18010 /* Save things including mode_line_proptrans_alist,
18011 and set that to nil so that we don't alter the outer value. */
18012 record_unwind_protect (unwind_format_mode_line
,
18013 format_mode_line_unwind_data
18014 (old_buffer
, selected_window
, 1));
18015 mode_line_proptrans_alist
= Qnil
;
18017 Fselect_window (window
, Qt
);
18019 set_buffer_internal_1 (XBUFFER (buffer
));
18021 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18025 mode_line_target
= MODE_LINE_NOPROP
;
18026 mode_line_string_face_prop
= Qnil
;
18027 mode_line_string_list
= Qnil
;
18028 string_start
= MODE_LINE_NOPROP_LEN (0);
18032 mode_line_target
= MODE_LINE_STRING
;
18033 mode_line_string_list
= Qnil
;
18034 mode_line_string_face
= face
;
18035 mode_line_string_face_prop
18036 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18039 push_kboard (FRAME_KBOARD (it
.f
));
18040 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18045 len
= MODE_LINE_NOPROP_LEN (string_start
);
18046 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18050 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18051 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18052 empty_unibyte_string
);
18055 unbind_to (count
, Qnil
);
18059 /* Write a null-terminated, right justified decimal representation of
18060 the positive integer D to BUF using a minimal field width WIDTH. */
18063 pint2str (buf
, width
, d
)
18064 register char *buf
;
18065 register int width
;
18068 register char *p
= buf
;
18076 *p
++ = d
% 10 + '0';
18081 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18092 /* Write a null-terminated, right justified decimal and "human
18093 readable" representation of the nonnegative integer D to BUF using
18094 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18096 static const char power_letter
[] =
18110 pint2hrstr (buf
, width
, d
)
18115 /* We aim to represent the nonnegative integer D as
18116 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18119 /* -1 means: do not use TENTHS. */
18123 /* Length of QUOTIENT.TENTHS as a string. */
18129 if (1000 <= quotient
)
18131 /* Scale to the appropriate EXPONENT. */
18134 remainder
= quotient
% 1000;
18138 while (1000 <= quotient
);
18140 /* Round to nearest and decide whether to use TENTHS or not. */
18143 tenths
= remainder
/ 100;
18144 if (50 <= remainder
% 100)
18151 if (quotient
== 10)
18159 if (500 <= remainder
)
18161 if (quotient
< 999)
18172 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18173 if (tenths
== -1 && quotient
<= 99)
18180 p
= psuffix
= buf
+ max (width
, length
);
18182 /* Print EXPONENT. */
18184 *psuffix
++ = power_letter
[exponent
];
18187 /* Print TENTHS. */
18190 *--p
= '0' + tenths
;
18194 /* Print QUOTIENT. */
18197 int digit
= quotient
% 10;
18198 *--p
= '0' + digit
;
18200 while ((quotient
/= 10) != 0);
18202 /* Print leading spaces. */
18207 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18208 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18209 type of CODING_SYSTEM. Return updated pointer into BUF. */
18211 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18214 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18215 Lisp_Object coding_system
;
18216 register char *buf
;
18220 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18221 const unsigned char *eol_str
;
18223 /* The EOL conversion we are using. */
18224 Lisp_Object eoltype
;
18226 val
= CODING_SYSTEM_SPEC (coding_system
);
18229 if (!VECTORP (val
)) /* Not yet decided. */
18234 eoltype
= eol_mnemonic_undecided
;
18235 /* Don't mention EOL conversion if it isn't decided. */
18240 Lisp_Object eolvalue
;
18242 attrs
= AREF (val
, 0);
18243 eolvalue
= AREF (val
, 2);
18246 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18250 /* The EOL conversion that is normal on this system. */
18252 if (NILP (eolvalue
)) /* Not yet decided. */
18253 eoltype
= eol_mnemonic_undecided
;
18254 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18255 eoltype
= eol_mnemonic_undecided
;
18256 else /* eolvalue is Qunix, Qdos, or Qmac. */
18257 eoltype
= (EQ (eolvalue
, Qunix
)
18258 ? eol_mnemonic_unix
18259 : (EQ (eolvalue
, Qdos
) == 1
18260 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18266 /* Mention the EOL conversion if it is not the usual one. */
18267 if (STRINGP (eoltype
))
18269 eol_str
= SDATA (eoltype
);
18270 eol_str_len
= SBYTES (eoltype
);
18272 else if (CHARACTERP (eoltype
))
18274 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18275 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18280 eol_str
= invalid_eol_type
;
18281 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18283 bcopy (eol_str
, buf
, eol_str_len
);
18284 buf
+= eol_str_len
;
18290 /* Return a string for the output of a mode line %-spec for window W,
18291 generated by character C. PRECISION >= 0 means don't return a
18292 string longer than that value. FIELD_WIDTH > 0 means pad the
18293 string returned with spaces to that value. Return 1 in *MULTIBYTE
18294 if the result is multibyte text.
18296 Note we operate on the current buffer for most purposes,
18297 the exception being w->base_line_pos. */
18299 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18302 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
18305 int field_width
, precision
;
18309 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18310 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18311 struct buffer
*b
= current_buffer
;
18319 if (!NILP (b
->read_only
))
18321 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18326 /* This differs from %* only for a modified read-only buffer. */
18327 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18329 if (!NILP (b
->read_only
))
18334 /* This differs from %* in ignoring read-only-ness. */
18335 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18347 if (command_loop_level
> 5)
18349 p
= decode_mode_spec_buf
;
18350 for (i
= 0; i
< command_loop_level
; i
++)
18353 return decode_mode_spec_buf
;
18361 if (command_loop_level
> 5)
18363 p
= decode_mode_spec_buf
;
18364 for (i
= 0; i
< command_loop_level
; i
++)
18367 return decode_mode_spec_buf
;
18374 /* Let lots_of_dashes be a string of infinite length. */
18375 if (mode_line_target
== MODE_LINE_NOPROP
||
18376 mode_line_target
== MODE_LINE_STRING
)
18378 if (field_width
<= 0
18379 || field_width
> sizeof (lots_of_dashes
))
18381 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18382 decode_mode_spec_buf
[i
] = '-';
18383 decode_mode_spec_buf
[i
] = '\0';
18384 return decode_mode_spec_buf
;
18387 return lots_of_dashes
;
18395 /* %c and %l are ignored in `frame-title-format'.
18396 (In redisplay_internal, the frame title is drawn _before_ the
18397 windows are updated, so the stuff which depends on actual
18398 window contents (such as %l) may fail to render properly, or
18399 even crash emacs.) */
18400 if (mode_line_target
== MODE_LINE_TITLE
)
18404 int col
= (int) current_column (); /* iftc */
18405 w
->column_number_displayed
= make_number (col
);
18406 pint2str (decode_mode_spec_buf
, field_width
, col
);
18407 return decode_mode_spec_buf
;
18411 #ifndef SYSTEM_MALLOC
18413 if (NILP (Vmemory_full
))
18416 return "!MEM FULL! ";
18423 /* %F displays the frame name. */
18424 if (!NILP (f
->title
))
18425 return (char *) SDATA (f
->title
);
18426 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18427 return (char *) SDATA (f
->name
);
18436 int size
= ZV
- BEGV
;
18437 pint2str (decode_mode_spec_buf
, field_width
, size
);
18438 return decode_mode_spec_buf
;
18443 int size
= ZV
- BEGV
;
18444 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18445 return decode_mode_spec_buf
;
18450 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18451 int topline
, nlines
, junk
, height
;
18453 /* %c and %l are ignored in `frame-title-format'. */
18454 if (mode_line_target
== MODE_LINE_TITLE
)
18457 startpos
= XMARKER (w
->start
)->charpos
;
18458 startpos_byte
= marker_byte_position (w
->start
);
18459 height
= WINDOW_TOTAL_LINES (w
);
18461 /* If we decided that this buffer isn't suitable for line numbers,
18462 don't forget that too fast. */
18463 if (EQ (w
->base_line_pos
, w
->buffer
))
18465 /* But do forget it, if the window shows a different buffer now. */
18466 else if (BUFFERP (w
->base_line_pos
))
18467 w
->base_line_pos
= Qnil
;
18469 /* If the buffer is very big, don't waste time. */
18470 if (INTEGERP (Vline_number_display_limit
)
18471 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18473 w
->base_line_pos
= Qnil
;
18474 w
->base_line_number
= Qnil
;
18478 if (INTEGERP (w
->base_line_number
)
18479 && INTEGERP (w
->base_line_pos
)
18480 && XFASTINT (w
->base_line_pos
) <= startpos
)
18482 line
= XFASTINT (w
->base_line_number
);
18483 linepos
= XFASTINT (w
->base_line_pos
);
18484 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18489 linepos
= BUF_BEGV (b
);
18490 linepos_byte
= BUF_BEGV_BYTE (b
);
18493 /* Count lines from base line to window start position. */
18494 nlines
= display_count_lines (linepos
, linepos_byte
,
18498 topline
= nlines
+ line
;
18500 /* Determine a new base line, if the old one is too close
18501 or too far away, or if we did not have one.
18502 "Too close" means it's plausible a scroll-down would
18503 go back past it. */
18504 if (startpos
== BUF_BEGV (b
))
18506 w
->base_line_number
= make_number (topline
);
18507 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18509 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18510 || linepos
== BUF_BEGV (b
))
18512 int limit
= BUF_BEGV (b
);
18513 int limit_byte
= BUF_BEGV_BYTE (b
);
18515 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18517 if (startpos
- distance
> limit
)
18519 limit
= startpos
- distance
;
18520 limit_byte
= CHAR_TO_BYTE (limit
);
18523 nlines
= display_count_lines (startpos
, startpos_byte
,
18525 - (height
* 2 + 30),
18527 /* If we couldn't find the lines we wanted within
18528 line_number_display_limit_width chars per line,
18529 give up on line numbers for this window. */
18530 if (position
== limit_byte
&& limit
== startpos
- distance
)
18532 w
->base_line_pos
= w
->buffer
;
18533 w
->base_line_number
= Qnil
;
18537 w
->base_line_number
= make_number (topline
- nlines
);
18538 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18541 /* Now count lines from the start pos to point. */
18542 nlines
= display_count_lines (startpos
, startpos_byte
,
18543 PT_BYTE
, PT
, &junk
);
18545 /* Record that we did display the line number. */
18546 line_number_displayed
= 1;
18548 /* Make the string to show. */
18549 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18550 return decode_mode_spec_buf
;
18553 char* p
= decode_mode_spec_buf
;
18554 int pad
= field_width
- 2;
18560 return decode_mode_spec_buf
;
18566 obj
= b
->mode_name
;
18570 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18576 int pos
= marker_position (w
->start
);
18577 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18579 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18581 if (pos
<= BUF_BEGV (b
))
18586 else if (pos
<= BUF_BEGV (b
))
18590 if (total
> 1000000)
18591 /* Do it differently for a large value, to avoid overflow. */
18592 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18594 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18595 /* We can't normally display a 3-digit number,
18596 so get us a 2-digit number that is close. */
18599 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18600 return decode_mode_spec_buf
;
18604 /* Display percentage of size above the bottom of the screen. */
18607 int toppos
= marker_position (w
->start
);
18608 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18609 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18611 if (botpos
>= BUF_ZV (b
))
18613 if (toppos
<= BUF_BEGV (b
))
18620 if (total
> 1000000)
18621 /* Do it differently for a large value, to avoid overflow. */
18622 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18624 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18625 /* We can't normally display a 3-digit number,
18626 so get us a 2-digit number that is close. */
18629 if (toppos
<= BUF_BEGV (b
))
18630 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18632 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18633 return decode_mode_spec_buf
;
18638 /* status of process */
18639 obj
= Fget_buffer_process (Fcurrent_buffer ());
18641 return "no process";
18642 #ifdef subprocesses
18643 obj
= Fsymbol_name (Fprocess_status (obj
));
18650 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18657 case 't': /* indicate TEXT or BINARY */
18658 #ifdef MODE_LINE_BINARY_TEXT
18659 return MODE_LINE_BINARY_TEXT (b
);
18665 /* coding-system (not including end-of-line format) */
18667 /* coding-system (including end-of-line type) */
18669 int eol_flag
= (c
== 'Z');
18670 char *p
= decode_mode_spec_buf
;
18672 if (! FRAME_WINDOW_P (f
))
18674 /* No need to mention EOL here--the terminal never needs
18675 to do EOL conversion. */
18676 p
= decode_mode_spec_coding (CODING_ID_NAME
18677 (FRAME_KEYBOARD_CODING (f
)->id
),
18679 p
= decode_mode_spec_coding (CODING_ID_NAME
18680 (FRAME_TERMINAL_CODING (f
)->id
),
18683 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18686 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18687 #ifdef subprocesses
18688 obj
= Fget_buffer_process (Fcurrent_buffer ());
18689 if (PROCESSP (obj
))
18691 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18693 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18696 #endif /* subprocesses */
18699 return decode_mode_spec_buf
;
18705 *multibyte
= STRING_MULTIBYTE (obj
);
18706 return (char *) SDATA (obj
);
18713 /* Count up to COUNT lines starting from START / START_BYTE.
18714 But don't go beyond LIMIT_BYTE.
18715 Return the number of lines thus found (always nonnegative).
18717 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18720 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18721 int start
, start_byte
, limit_byte
, count
;
18724 register unsigned char *cursor
;
18725 unsigned char *base
;
18727 register int ceiling
;
18728 register unsigned char *ceiling_addr
;
18729 int orig_count
= count
;
18731 /* If we are not in selective display mode,
18732 check only for newlines. */
18733 int selective_display
= (!NILP (current_buffer
->selective_display
)
18734 && !INTEGERP (current_buffer
->selective_display
));
18738 while (start_byte
< limit_byte
)
18740 ceiling
= BUFFER_CEILING_OF (start_byte
);
18741 ceiling
= min (limit_byte
- 1, ceiling
);
18742 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18743 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18746 if (selective_display
)
18747 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18750 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18753 if (cursor
!= ceiling_addr
)
18757 start_byte
+= cursor
- base
+ 1;
18758 *byte_pos_ptr
= start_byte
;
18762 if (++cursor
== ceiling_addr
)
18768 start_byte
+= cursor
- base
;
18773 while (start_byte
> limit_byte
)
18775 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18776 ceiling
= max (limit_byte
, ceiling
);
18777 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18778 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18781 if (selective_display
)
18782 while (--cursor
!= ceiling_addr
18783 && *cursor
!= '\n' && *cursor
!= 015)
18786 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18789 if (cursor
!= ceiling_addr
)
18793 start_byte
+= cursor
- base
+ 1;
18794 *byte_pos_ptr
= start_byte
;
18795 /* When scanning backwards, we should
18796 not count the newline posterior to which we stop. */
18797 return - orig_count
- 1;
18803 /* Here we add 1 to compensate for the last decrement
18804 of CURSOR, which took it past the valid range. */
18805 start_byte
+= cursor
- base
+ 1;
18809 *byte_pos_ptr
= limit_byte
;
18812 return - orig_count
+ count
;
18813 return orig_count
- count
;
18819 /***********************************************************************
18821 ***********************************************************************/
18823 /* Display a NUL-terminated string, starting with index START.
18825 If STRING is non-null, display that C string. Otherwise, the Lisp
18826 string LISP_STRING is displayed.
18828 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18829 FACE_STRING. Display STRING or LISP_STRING with the face at
18830 FACE_STRING_POS in FACE_STRING:
18832 Display the string in the environment given by IT, but use the
18833 standard display table, temporarily.
18835 FIELD_WIDTH is the minimum number of output glyphs to produce.
18836 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18837 with spaces. If STRING has more characters, more than FIELD_WIDTH
18838 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18840 PRECISION is the maximum number of characters to output from
18841 STRING. PRECISION < 0 means don't truncate the string.
18843 This is roughly equivalent to printf format specifiers:
18845 FIELD_WIDTH PRECISION PRINTF
18846 ----------------------------------------
18852 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18853 display them, and < 0 means obey the current buffer's value of
18854 enable_multibyte_characters.
18856 Value is the number of columns displayed. */
18859 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18860 start
, it
, field_width
, precision
, max_x
, multibyte
)
18861 unsigned char *string
;
18862 Lisp_Object lisp_string
;
18863 Lisp_Object face_string
;
18864 EMACS_INT face_string_pos
;
18867 int field_width
, precision
, max_x
;
18870 int hpos_at_start
= it
->hpos
;
18871 int saved_face_id
= it
->face_id
;
18872 struct glyph_row
*row
= it
->glyph_row
;
18874 /* Initialize the iterator IT for iteration over STRING beginning
18875 with index START. */
18876 reseat_to_string (it
, string
, lisp_string
, start
,
18877 precision
, field_width
, multibyte
);
18879 /* If displaying STRING, set up the face of the iterator
18880 from LISP_STRING, if that's given. */
18881 if (STRINGP (face_string
))
18887 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18888 0, it
->region_beg_charpos
,
18889 it
->region_end_charpos
,
18890 &endptr
, it
->base_face_id
, 0);
18891 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18892 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18895 /* Set max_x to the maximum allowed X position. Don't let it go
18896 beyond the right edge of the window. */
18898 max_x
= it
->last_visible_x
;
18900 max_x
= min (max_x
, it
->last_visible_x
);
18902 /* Skip over display elements that are not visible. because IT->w is
18904 if (it
->current_x
< it
->first_visible_x
)
18905 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18906 MOVE_TO_POS
| MOVE_TO_X
);
18908 row
->ascent
= it
->max_ascent
;
18909 row
->height
= it
->max_ascent
+ it
->max_descent
;
18910 row
->phys_ascent
= it
->max_phys_ascent
;
18911 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18912 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18914 /* This condition is for the case that we are called with current_x
18915 past last_visible_x. */
18916 while (it
->current_x
< max_x
)
18918 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18920 /* Get the next display element. */
18921 if (!get_next_display_element (it
))
18924 /* Produce glyphs. */
18925 x_before
= it
->current_x
;
18926 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18927 PRODUCE_GLYPHS (it
);
18929 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18932 while (i
< nglyphs
)
18934 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18936 if (it
->line_wrap
!= TRUNCATE
18937 && x
+ glyph
->pixel_width
> max_x
)
18939 /* End of continued line or max_x reached. */
18940 if (CHAR_GLYPH_PADDING_P (*glyph
))
18942 /* A wide character is unbreakable. */
18943 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18944 it
->current_x
= x_before
;
18948 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18953 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18955 /* Glyph is at least partially visible. */
18957 if (x
< it
->first_visible_x
)
18958 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18962 /* Glyph is off the left margin of the display area.
18963 Should not happen. */
18967 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18968 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18969 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18970 row
->phys_height
= max (row
->phys_height
,
18971 it
->max_phys_ascent
+ it
->max_phys_descent
);
18972 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18973 it
->max_extra_line_spacing
);
18974 x
+= glyph
->pixel_width
;
18978 /* Stop if max_x reached. */
18982 /* Stop at line ends. */
18983 if (ITERATOR_AT_END_OF_LINE_P (it
))
18985 it
->continuation_lines_width
= 0;
18989 set_iterator_to_next (it
, 1);
18991 /* Stop if truncating at the right edge. */
18992 if (it
->line_wrap
== TRUNCATE
18993 && it
->current_x
>= it
->last_visible_x
)
18995 /* Add truncation mark, but don't do it if the line is
18996 truncated at a padding space. */
18997 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18999 if (!FRAME_WINDOW_P (it
->f
))
19003 if (it
->current_x
> it
->last_visible_x
)
19005 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19006 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19008 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19010 row
->used
[TEXT_AREA
] = i
;
19011 produce_special_glyphs (it
, IT_TRUNCATION
);
19014 produce_special_glyphs (it
, IT_TRUNCATION
);
19016 it
->glyph_row
->truncated_on_right_p
= 1;
19022 /* Maybe insert a truncation at the left. */
19023 if (it
->first_visible_x
19024 && IT_CHARPOS (*it
) > 0)
19026 if (!FRAME_WINDOW_P (it
->f
))
19027 insert_left_trunc_glyphs (it
);
19028 it
->glyph_row
->truncated_on_left_p
= 1;
19031 it
->face_id
= saved_face_id
;
19033 /* Value is number of columns displayed. */
19034 return it
->hpos
- hpos_at_start
;
19039 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19040 appears as an element of LIST or as the car of an element of LIST.
19041 If PROPVAL is a list, compare each element against LIST in that
19042 way, and return 1/2 if any element of PROPVAL is found in LIST.
19043 Otherwise return 0. This function cannot quit.
19044 The return value is 2 if the text is invisible but with an ellipsis
19045 and 1 if it's invisible and without an ellipsis. */
19048 invisible_p (propval
, list
)
19049 register Lisp_Object propval
;
19052 register Lisp_Object tail
, proptail
;
19054 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19056 register Lisp_Object tem
;
19058 if (EQ (propval
, tem
))
19060 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19061 return NILP (XCDR (tem
)) ? 1 : 2;
19064 if (CONSP (propval
))
19066 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19068 Lisp_Object propelt
;
19069 propelt
= XCAR (proptail
);
19070 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19072 register Lisp_Object tem
;
19074 if (EQ (propelt
, tem
))
19076 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19077 return NILP (XCDR (tem
)) ? 1 : 2;
19085 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19086 doc
: /* Non-nil if the property makes the text invisible.
19087 POS-OR-PROP can be a marker or number, in which case it is taken to be
19088 a position in the current buffer and the value of the `invisible' property
19089 is checked; or it can be some other value, which is then presumed to be the
19090 value of the `invisible' property of the text of interest.
19091 The non-nil value returned can be t for truly invisible text or something
19092 else if the text is replaced by an ellipsis. */)
19094 Lisp_Object pos_or_prop
;
19097 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19098 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19100 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19101 return (invis
== 0 ? Qnil
19103 : make_number (invis
));
19106 /* Calculate a width or height in pixels from a specification using
19107 the following elements:
19110 NUM - a (fractional) multiple of the default font width/height
19111 (NUM) - specifies exactly NUM pixels
19112 UNIT - a fixed number of pixels, see below.
19113 ELEMENT - size of a display element in pixels, see below.
19114 (NUM . SPEC) - equals NUM * SPEC
19115 (+ SPEC SPEC ...) - add pixel values
19116 (- SPEC SPEC ...) - subtract pixel values
19117 (- SPEC) - negate pixel value
19120 INT or FLOAT - a number constant
19121 SYMBOL - use symbol's (buffer local) variable binding.
19124 in - pixels per inch *)
19125 mm - pixels per 1/1000 meter *)
19126 cm - pixels per 1/100 meter *)
19127 width - width of current font in pixels.
19128 height - height of current font in pixels.
19130 *) using the ratio(s) defined in display-pixels-per-inch.
19134 left-fringe - left fringe width in pixels
19135 right-fringe - right fringe width in pixels
19137 left-margin - left margin width in pixels
19138 right-margin - right margin width in pixels
19140 scroll-bar - scroll-bar area width in pixels
19144 Pixels corresponding to 5 inches:
19147 Total width of non-text areas on left side of window (if scroll-bar is on left):
19148 '(space :width (+ left-fringe left-margin scroll-bar))
19150 Align to first text column (in header line):
19151 '(space :align-to 0)
19153 Align to middle of text area minus half the width of variable `my-image'
19154 containing a loaded image:
19155 '(space :align-to (0.5 . (- text my-image)))
19157 Width of left margin minus width of 1 character in the default font:
19158 '(space :width (- left-margin 1))
19160 Width of left margin minus width of 2 characters in the current font:
19161 '(space :width (- left-margin (2 . width)))
19163 Center 1 character over left-margin (in header line):
19164 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19166 Different ways to express width of left fringe plus left margin minus one pixel:
19167 '(space :width (- (+ left-fringe left-margin) (1)))
19168 '(space :width (+ left-fringe left-margin (- (1))))
19169 '(space :width (+ left-fringe left-margin (-1)))
19173 #define NUMVAL(X) \
19174 ((INTEGERP (X) || FLOATP (X)) \
19179 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19184 int width_p
, *align_to
;
19188 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19189 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19192 return OK_PIXELS (0);
19194 xassert (FRAME_LIVE_P (it
->f
));
19196 if (SYMBOLP (prop
))
19198 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19200 char *unit
= SDATA (SYMBOL_NAME (prop
));
19202 if (unit
[0] == 'i' && unit
[1] == 'n')
19204 else if (unit
[0] == 'm' && unit
[1] == 'm')
19206 else if (unit
[0] == 'c' && unit
[1] == 'm')
19213 #ifdef HAVE_WINDOW_SYSTEM
19214 if (FRAME_WINDOW_P (it
->f
)
19216 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19217 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19219 return OK_PIXELS (ppi
/ pixels
);
19222 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19223 || (CONSP (Vdisplay_pixels_per_inch
)
19225 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19226 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19228 return OK_PIXELS (ppi
/ pixels
);
19234 #ifdef HAVE_WINDOW_SYSTEM
19235 if (EQ (prop
, Qheight
))
19236 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19237 if (EQ (prop
, Qwidth
))
19238 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19240 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19241 return OK_PIXELS (1);
19244 if (EQ (prop
, Qtext
))
19245 return OK_PIXELS (width_p
19246 ? window_box_width (it
->w
, TEXT_AREA
)
19247 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19249 if (align_to
&& *align_to
< 0)
19252 if (EQ (prop
, Qleft
))
19253 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19254 if (EQ (prop
, Qright
))
19255 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19256 if (EQ (prop
, Qcenter
))
19257 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19258 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19259 if (EQ (prop
, Qleft_fringe
))
19260 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19261 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19262 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19263 if (EQ (prop
, Qright_fringe
))
19264 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19265 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19266 : window_box_right_offset (it
->w
, TEXT_AREA
));
19267 if (EQ (prop
, Qleft_margin
))
19268 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19269 if (EQ (prop
, Qright_margin
))
19270 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19271 if (EQ (prop
, Qscroll_bar
))
19272 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19274 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19275 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19276 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19281 if (EQ (prop
, Qleft_fringe
))
19282 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19283 if (EQ (prop
, Qright_fringe
))
19284 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19285 if (EQ (prop
, Qleft_margin
))
19286 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19287 if (EQ (prop
, Qright_margin
))
19288 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19289 if (EQ (prop
, Qscroll_bar
))
19290 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19293 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19296 if (INTEGERP (prop
) || FLOATP (prop
))
19298 int base_unit
= (width_p
19299 ? FRAME_COLUMN_WIDTH (it
->f
)
19300 : FRAME_LINE_HEIGHT (it
->f
));
19301 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19306 Lisp_Object car
= XCAR (prop
);
19307 Lisp_Object cdr
= XCDR (prop
);
19311 #ifdef HAVE_WINDOW_SYSTEM
19312 if (FRAME_WINDOW_P (it
->f
)
19313 && valid_image_p (prop
))
19315 int id
= lookup_image (it
->f
, prop
);
19316 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19318 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19321 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19327 while (CONSP (cdr
))
19329 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19330 font
, width_p
, align_to
))
19333 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19338 if (EQ (car
, Qminus
))
19340 return OK_PIXELS (pixels
);
19343 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19346 if (INTEGERP (car
) || FLOATP (car
))
19349 pixels
= XFLOATINT (car
);
19351 return OK_PIXELS (pixels
);
19352 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19353 font
, width_p
, align_to
))
19354 return OK_PIXELS (pixels
* fact
);
19365 /***********************************************************************
19367 ***********************************************************************/
19369 #ifdef HAVE_WINDOW_SYSTEM
19374 dump_glyph_string (s
)
19375 struct glyph_string
*s
;
19377 fprintf (stderr
, "glyph string\n");
19378 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19379 s
->x
, s
->y
, s
->width
, s
->height
);
19380 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19381 fprintf (stderr
, " hl = %d\n", s
->hl
);
19382 fprintf (stderr
, " left overhang = %d, right = %d\n",
19383 s
->left_overhang
, s
->right_overhang
);
19384 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19385 fprintf (stderr
, " extends to end of line = %d\n",
19386 s
->extends_to_end_of_line_p
);
19387 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19388 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19391 #endif /* GLYPH_DEBUG */
19393 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19394 of XChar2b structures for S; it can't be allocated in
19395 init_glyph_string because it must be allocated via `alloca'. W
19396 is the window on which S is drawn. ROW and AREA are the glyph row
19397 and area within the row from which S is constructed. START is the
19398 index of the first glyph structure covered by S. HL is a
19399 face-override for drawing S. */
19402 #define OPTIONAL_HDC(hdc) hdc,
19403 #define DECLARE_HDC(hdc) HDC hdc;
19404 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19405 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19408 #ifndef OPTIONAL_HDC
19409 #define OPTIONAL_HDC(hdc)
19410 #define DECLARE_HDC(hdc)
19411 #define ALLOCATE_HDC(hdc, f)
19412 #define RELEASE_HDC(hdc, f)
19416 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19417 struct glyph_string
*s
;
19421 struct glyph_row
*row
;
19422 enum glyph_row_area area
;
19424 enum draw_glyphs_face hl
;
19426 bzero (s
, sizeof *s
);
19428 s
->f
= XFRAME (w
->frame
);
19432 s
->display
= FRAME_X_DISPLAY (s
->f
);
19433 s
->window
= FRAME_X_WINDOW (s
->f
);
19434 s
->char2b
= char2b
;
19438 s
->first_glyph
= row
->glyphs
[area
] + start
;
19439 s
->height
= row
->height
;
19440 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19442 /* Display the internal border below the tool-bar window. */
19443 if (WINDOWP (s
->f
->tool_bar_window
)
19444 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19445 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19447 s
->ybase
= s
->y
+ row
->ascent
;
19451 /* Append the list of glyph strings with head H and tail T to the list
19452 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19455 append_glyph_string_lists (head
, tail
, h
, t
)
19456 struct glyph_string
**head
, **tail
;
19457 struct glyph_string
*h
, *t
;
19471 /* Prepend the list of glyph strings with head H and tail T to the
19472 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19476 prepend_glyph_string_lists (head
, tail
, h
, t
)
19477 struct glyph_string
**head
, **tail
;
19478 struct glyph_string
*h
, *t
;
19492 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19493 Set *HEAD and *TAIL to the resulting list. */
19496 append_glyph_string (head
, tail
, s
)
19497 struct glyph_string
**head
, **tail
;
19498 struct glyph_string
*s
;
19500 s
->next
= s
->prev
= NULL
;
19501 append_glyph_string_lists (head
, tail
, s
, s
);
19505 /* Get face and two-byte form of character C in face FACE_ID on frame
19506 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19507 means we want to display multibyte text. DISPLAY_P non-zero means
19508 make sure that X resources for the face returned are allocated.
19509 Value is a pointer to a realized face that is ready for display if
19510 DISPLAY_P is non-zero. */
19512 static INLINE
struct face
*
19513 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19517 int multibyte_p
, display_p
;
19519 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19523 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19525 if (code
!= FONT_INVALID_CODE
)
19526 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19528 STORE_XCHAR2B (char2b
, 0, 0);
19531 /* Make sure X resources of the face are allocated. */
19532 #ifdef HAVE_X_WINDOWS
19536 xassert (face
!= NULL
);
19537 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19544 /* Get face and two-byte form of character glyph GLYPH on frame F.
19545 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19546 a pointer to a realized face that is ready for display. */
19548 static INLINE
struct face
*
19549 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19551 struct glyph
*glyph
;
19557 xassert (glyph
->type
== CHAR_GLYPH
);
19558 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19565 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19567 if (code
!= FONT_INVALID_CODE
)
19568 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19570 STORE_XCHAR2B (char2b
, 0, 0);
19573 /* Make sure X resources of the face are allocated. */
19574 xassert (face
!= NULL
);
19575 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19580 /* Fill glyph string S with composition components specified by S->cmp.
19582 BASE_FACE is the base face of the composition.
19583 S->cmp_from is the index of the first component for S.
19585 OVERLAPS non-zero means S should draw the foreground only, and use
19586 its physical height for clipping. See also draw_glyphs.
19588 Value is the index of a component not in S. */
19591 fill_composite_glyph_string (s
, base_face
, overlaps
)
19592 struct glyph_string
*s
;
19593 struct face
*base_face
;
19597 /* For all glyphs of this composition, starting at the offset
19598 S->cmp_from, until we reach the end of the definition or encounter a
19599 glyph that requires the different face, add it to S. */
19604 s
->for_overlaps
= overlaps
;
19607 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
19609 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19613 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19616 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19617 s
->char2b
+ i
, 1, 1);
19623 s
->font
= s
->face
->font
;
19625 else if (s
->face
!= face
)
19633 /* All glyph strings for the same composition has the same width,
19634 i.e. the width set for the first component of the composition. */
19635 s
->width
= s
->first_glyph
->pixel_width
;
19637 /* If the specified font could not be loaded, use the frame's
19638 default font, but record the fact that we couldn't load it in
19639 the glyph string so that we can draw rectangles for the
19640 characters of the glyph string. */
19641 if (s
->font
== NULL
)
19643 s
->font_not_found_p
= 1;
19644 s
->font
= FRAME_FONT (s
->f
);
19647 /* Adjust base line for subscript/superscript text. */
19648 s
->ybase
+= s
->first_glyph
->voffset
;
19650 /* This glyph string must always be drawn with 16-bit functions. */
19657 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
19658 struct glyph_string
*s
;
19660 int start
, end
, overlaps
;
19662 struct glyph
*glyph
, *last
;
19663 Lisp_Object lgstring
;
19666 s
->for_overlaps
= overlaps
;
19667 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19668 last
= s
->row
->glyphs
[s
->area
] + end
;
19669 s
->cmp_id
= glyph
->u
.cmp
.id
;
19670 s
->cmp_from
= glyph
->u
.cmp
.from
;
19671 s
->cmp_to
= glyph
->u
.cmp
.to
;
19672 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19673 lgstring
= composition_gstring_from_id (s
->cmp_id
);
19674 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
19676 while (glyph
< last
19677 && glyph
->u
.cmp
.automatic
19678 && glyph
->u
.cmp
.id
== s
->cmp_id
)
19679 s
->cmp_to
= (glyph
++)->u
.cmp
.to
;
19681 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
19683 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
19684 unsigned code
= LGLYPH_CODE (lglyph
);
19686 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
19688 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
19689 return glyph
- s
->row
->glyphs
[s
->area
];
19693 /* Fill glyph string S from a sequence of character glyphs.
19695 FACE_ID is the face id of the string. START is the index of the
19696 first glyph to consider, END is the index of the last + 1.
19697 OVERLAPS non-zero means S should draw the foreground only, and use
19698 its physical height for clipping. See also draw_glyphs.
19700 Value is the index of the first glyph not in S. */
19703 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19704 struct glyph_string
*s
;
19706 int start
, end
, overlaps
;
19708 struct glyph
*glyph
, *last
;
19710 int glyph_not_available_p
;
19712 xassert (s
->f
== XFRAME (s
->w
->frame
));
19713 xassert (s
->nchars
== 0);
19714 xassert (start
>= 0 && end
> start
);
19716 s
->for_overlaps
= overlaps
,
19717 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19718 last
= s
->row
->glyphs
[s
->area
] + end
;
19719 voffset
= glyph
->voffset
;
19720 s
->padding_p
= glyph
->padding_p
;
19721 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19723 while (glyph
< last
19724 && glyph
->type
== CHAR_GLYPH
19725 && glyph
->voffset
== voffset
19726 /* Same face id implies same font, nowadays. */
19727 && glyph
->face_id
== face_id
19728 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19732 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19733 s
->char2b
+ s
->nchars
,
19735 s
->two_byte_p
= two_byte_p
;
19737 xassert (s
->nchars
<= end
- start
);
19738 s
->width
+= glyph
->pixel_width
;
19739 if (glyph
++->padding_p
!= s
->padding_p
)
19743 s
->font
= s
->face
->font
;
19745 /* If the specified font could not be loaded, use the frame's font,
19746 but record the fact that we couldn't load it in
19747 S->font_not_found_p so that we can draw rectangles for the
19748 characters of the glyph string. */
19749 if (s
->font
== NULL
|| glyph_not_available_p
)
19751 s
->font_not_found_p
= 1;
19752 s
->font
= FRAME_FONT (s
->f
);
19755 /* Adjust base line for subscript/superscript text. */
19756 s
->ybase
+= voffset
;
19758 xassert (s
->face
&& s
->face
->gc
);
19759 return glyph
- s
->row
->glyphs
[s
->area
];
19763 /* Fill glyph string S from image glyph S->first_glyph. */
19766 fill_image_glyph_string (s
)
19767 struct glyph_string
*s
;
19769 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19770 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19772 s
->slice
= s
->first_glyph
->slice
;
19773 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19774 s
->font
= s
->face
->font
;
19775 s
->width
= s
->first_glyph
->pixel_width
;
19777 /* Adjust base line for subscript/superscript text. */
19778 s
->ybase
+= s
->first_glyph
->voffset
;
19782 /* Fill glyph string S from a sequence of stretch glyphs.
19784 ROW is the glyph row in which the glyphs are found, AREA is the
19785 area within the row. START is the index of the first glyph to
19786 consider, END is the index of the last + 1.
19788 Value is the index of the first glyph not in S. */
19791 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19792 struct glyph_string
*s
;
19793 struct glyph_row
*row
;
19794 enum glyph_row_area area
;
19797 struct glyph
*glyph
, *last
;
19798 int voffset
, face_id
;
19800 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19802 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19803 last
= s
->row
->glyphs
[s
->area
] + end
;
19804 face_id
= glyph
->face_id
;
19805 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19806 s
->font
= s
->face
->font
;
19807 s
->width
= glyph
->pixel_width
;
19809 voffset
= glyph
->voffset
;
19813 && glyph
->type
== STRETCH_GLYPH
19814 && glyph
->voffset
== voffset
19815 && glyph
->face_id
== face_id
);
19817 s
->width
+= glyph
->pixel_width
;
19819 /* Adjust base line for subscript/superscript text. */
19820 s
->ybase
+= voffset
;
19822 /* The case that face->gc == 0 is handled when drawing the glyph
19823 string by calling PREPARE_FACE_FOR_DISPLAY. */
19825 return glyph
- s
->row
->glyphs
[s
->area
];
19828 static struct font_metrics
*
19829 get_per_char_metric (f
, font
, char2b
)
19834 static struct font_metrics metrics
;
19835 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19837 if (! font
|| code
== FONT_INVALID_CODE
)
19839 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19844 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19845 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19846 assumed to be zero. */
19849 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19850 struct glyph
*glyph
;
19854 *left
= *right
= 0;
19856 if (glyph
->type
== CHAR_GLYPH
)
19860 struct font_metrics
*pcm
;
19862 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19863 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19865 if (pcm
->rbearing
> pcm
->width
)
19866 *right
= pcm
->rbearing
- pcm
->width
;
19867 if (pcm
->lbearing
< 0)
19868 *left
= -pcm
->lbearing
;
19871 else if (glyph
->type
== COMPOSITE_GLYPH
)
19873 if (! glyph
->u
.cmp
.automatic
)
19875 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
19877 if (cmp
->rbearing
- cmp
->pixel_width
)
19878 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19879 if (cmp
->lbearing
< 0);
19880 *left
= - cmp
->lbearing
;
19884 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
19885 struct font_metrics metrics
;
19887 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
19888 glyph
->u
.cmp
.to
, &metrics
);
19889 if (metrics
.rbearing
> metrics
.width
)
19890 *right
= metrics
.rbearing
;
19891 if (metrics
.lbearing
< 0)
19892 *left
= - metrics
.lbearing
;
19898 /* Return the index of the first glyph preceding glyph string S that
19899 is overwritten by S because of S's left overhang. Value is -1
19900 if no glyphs are overwritten. */
19903 left_overwritten (s
)
19904 struct glyph_string
*s
;
19908 if (s
->left_overhang
)
19911 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19912 int first
= s
->first_glyph
- glyphs
;
19914 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19915 x
-= glyphs
[i
].pixel_width
;
19926 /* Return the index of the first glyph preceding glyph string S that
19927 is overwriting S because of its right overhang. Value is -1 if no
19928 glyph in front of S overwrites S. */
19931 left_overwriting (s
)
19932 struct glyph_string
*s
;
19935 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19936 int first
= s
->first_glyph
- glyphs
;
19940 for (i
= first
- 1; i
>= 0; --i
)
19943 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19946 x
-= glyphs
[i
].pixel_width
;
19953 /* Return the index of the last glyph following glyph string S that is
19954 overwritten by S because of S's right overhang. Value is -1 if
19955 no such glyph is found. */
19958 right_overwritten (s
)
19959 struct glyph_string
*s
;
19963 if (s
->right_overhang
)
19966 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19967 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19968 int end
= s
->row
->used
[s
->area
];
19970 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19971 x
+= glyphs
[i
].pixel_width
;
19980 /* Return the index of the last glyph following glyph string S that
19981 overwrites S because of its left overhang. Value is negative
19982 if no such glyph is found. */
19985 right_overwriting (s
)
19986 struct glyph_string
*s
;
19989 int end
= s
->row
->used
[s
->area
];
19990 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19991 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19995 for (i
= first
; i
< end
; ++i
)
19998 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20001 x
+= glyphs
[i
].pixel_width
;
20008 /* Set background width of glyph string S. START is the index of the
20009 first glyph following S. LAST_X is the right-most x-position + 1
20010 in the drawing area. */
20013 set_glyph_string_background_width (s
, start
, last_x
)
20014 struct glyph_string
*s
;
20018 /* If the face of this glyph string has to be drawn to the end of
20019 the drawing area, set S->extends_to_end_of_line_p. */
20021 if (start
== s
->row
->used
[s
->area
]
20022 && s
->area
== TEXT_AREA
20023 && ((s
->row
->fill_line_p
20024 && (s
->hl
== DRAW_NORMAL_TEXT
20025 || s
->hl
== DRAW_IMAGE_RAISED
20026 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20027 || s
->hl
== DRAW_MOUSE_FACE
))
20028 s
->extends_to_end_of_line_p
= 1;
20030 /* If S extends its face to the end of the line, set its
20031 background_width to the distance to the right edge of the drawing
20033 if (s
->extends_to_end_of_line_p
)
20034 s
->background_width
= last_x
- s
->x
+ 1;
20036 s
->background_width
= s
->width
;
20040 /* Compute overhangs and x-positions for glyph string S and its
20041 predecessors, or successors. X is the starting x-position for S.
20042 BACKWARD_P non-zero means process predecessors. */
20045 compute_overhangs_and_x (s
, x
, backward_p
)
20046 struct glyph_string
*s
;
20054 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20055 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20065 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20066 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20076 /* The following macros are only called from draw_glyphs below.
20077 They reference the following parameters of that function directly:
20078 `w', `row', `area', and `overlap_p'
20079 as well as the following local variables:
20080 `s', `f', and `hdc' (in W32) */
20083 /* On W32, silently add local `hdc' variable to argument list of
20084 init_glyph_string. */
20085 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20086 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20088 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20089 init_glyph_string (s, char2b, w, row, area, start, hl)
20092 /* Add a glyph string for a stretch glyph to the list of strings
20093 between HEAD and TAIL. START is the index of the stretch glyph in
20094 row area AREA of glyph row ROW. END is the index of the last glyph
20095 in that glyph row area. X is the current output position assigned
20096 to the new glyph string constructed. HL overrides that face of the
20097 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20098 is the right-most x-position of the drawing area. */
20100 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20101 and below -- keep them on one line. */
20102 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20105 s = (struct glyph_string *) alloca (sizeof *s); \
20106 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20107 START = fill_stretch_glyph_string (s, row, area, START, END); \
20108 append_glyph_string (&HEAD, &TAIL, s); \
20114 /* Add a glyph string for an image glyph to the list of strings
20115 between HEAD and TAIL. START is the index of the image glyph in
20116 row area AREA of glyph row ROW. END is the index of the last glyph
20117 in that glyph row area. X is the current output position assigned
20118 to the new glyph string constructed. HL overrides that face of the
20119 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20120 is the right-most x-position of the drawing area. */
20122 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20125 s = (struct glyph_string *) alloca (sizeof *s); \
20126 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20127 fill_image_glyph_string (s); \
20128 append_glyph_string (&HEAD, &TAIL, s); \
20135 /* Add a glyph string for a sequence of character glyphs to the list
20136 of strings between HEAD and TAIL. START is the index of the first
20137 glyph in row area AREA of glyph row ROW that is part of the new
20138 glyph string. END is the index of the last glyph in that glyph row
20139 area. X is the current output position assigned to the new glyph
20140 string constructed. HL overrides that face of the glyph; e.g. it
20141 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20142 right-most x-position of the drawing area. */
20144 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20150 face_id = (row)->glyphs[area][START].face_id; \
20152 s = (struct glyph_string *) alloca (sizeof *s); \
20153 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20154 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20155 append_glyph_string (&HEAD, &TAIL, s); \
20157 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20162 /* Add a glyph string for a composite sequence to the list of strings
20163 between HEAD and TAIL. START is the index of the first glyph in
20164 row area AREA of glyph row ROW that is part of the new glyph
20165 string. END is the index of the last glyph in that glyph row area.
20166 X is the current output position assigned to the new glyph string
20167 constructed. HL overrides that face of the glyph; e.g. it is
20168 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20169 x-position of the drawing area. */
20171 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20173 int face_id = (row)->glyphs[area][START].face_id; \
20174 struct face *base_face = FACE_FROM_ID (f, face_id); \
20175 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20176 struct composition *cmp = composition_table[cmp_id]; \
20178 struct glyph_string *first_s; \
20181 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20183 /* Make glyph_strings for each glyph sequence that is drawable by \
20184 the same face, and append them to HEAD/TAIL. */ \
20185 for (n = 0; n < cmp->glyph_len;) \
20187 s = (struct glyph_string *) alloca (sizeof *s); \
20188 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20189 append_glyph_string (&(HEAD), &(TAIL), s); \
20195 n = fill_composite_glyph_string (s, base_face, overlaps); \
20203 /* Add a glyph string for a glyph-string sequence to the list of strings
20204 between HEAD and TAIL. */
20206 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20210 Lisp_Object gstring; \
20212 face_id = (row)->glyphs[area][START].face_id; \
20213 gstring = (composition_gstring_from_id \
20214 ((row)->glyphs[area][START].u.cmp.id)); \
20215 s = (struct glyph_string *) alloca (sizeof *s); \
20216 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20217 * LGSTRING_GLYPH_LEN (gstring)); \
20218 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20219 append_glyph_string (&(HEAD), &(TAIL), s); \
20221 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20225 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20226 of AREA of glyph row ROW on window W between indices START and END.
20227 HL overrides the face for drawing glyph strings, e.g. it is
20228 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20229 x-positions of the drawing area.
20231 This is an ugly monster macro construct because we must use alloca
20232 to allocate glyph strings (because draw_glyphs can be called
20233 asynchronously). */
20235 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20238 HEAD = TAIL = NULL; \
20239 while (START < END) \
20241 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20242 switch (first_glyph->type) \
20245 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20249 case COMPOSITE_GLYPH: \
20250 if (first_glyph->u.cmp.automatic) \
20251 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
20254 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20258 case STRETCH_GLYPH: \
20259 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20263 case IMAGE_GLYPH: \
20264 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20274 set_glyph_string_background_width (s, START, LAST_X); \
20281 /* Draw glyphs between START and END in AREA of ROW on window W,
20282 starting at x-position X. X is relative to AREA in W. HL is a
20283 face-override with the following meaning:
20285 DRAW_NORMAL_TEXT draw normally
20286 DRAW_CURSOR draw in cursor face
20287 DRAW_MOUSE_FACE draw in mouse face.
20288 DRAW_INVERSE_VIDEO draw in mode line face
20289 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20290 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20292 If OVERLAPS is non-zero, draw only the foreground of characters and
20293 clip to the physical height of ROW. Non-zero value also defines
20294 the overlapping part to be drawn:
20296 OVERLAPS_PRED overlap with preceding rows
20297 OVERLAPS_SUCC overlap with succeeding rows
20298 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20299 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20301 Value is the x-position reached, relative to AREA of W. */
20304 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20307 struct glyph_row
*row
;
20308 enum glyph_row_area area
;
20309 EMACS_INT start
, end
;
20310 enum draw_glyphs_face hl
;
20313 struct glyph_string
*head
, *tail
;
20314 struct glyph_string
*s
;
20315 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20316 int i
, j
, x_reached
, last_x
, area_left
= 0;
20317 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20320 ALLOCATE_HDC (hdc
, f
);
20322 /* Let's rather be paranoid than getting a SEGV. */
20323 end
= min (end
, row
->used
[area
]);
20324 start
= max (0, start
);
20325 start
= min (end
, start
);
20327 /* Translate X to frame coordinates. Set last_x to the right
20328 end of the drawing area. */
20329 if (row
->full_width_p
)
20331 /* X is relative to the left edge of W, without scroll bars
20333 area_left
= WINDOW_LEFT_EDGE_X (w
);
20334 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20338 area_left
= window_box_left (w
, area
);
20339 last_x
= area_left
+ window_box_width (w
, area
);
20343 /* Build a doubly-linked list of glyph_string structures between
20344 head and tail from what we have to draw. Note that the macro
20345 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20346 the reason we use a separate variable `i'. */
20348 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20350 x_reached
= tail
->x
+ tail
->background_width
;
20354 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20355 the row, redraw some glyphs in front or following the glyph
20356 strings built above. */
20357 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20359 struct glyph_string
*h
, *t
;
20360 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20361 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20364 /* If mouse highlighting is on, we may need to draw adjacent
20365 glyphs using mouse-face highlighting. */
20366 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20368 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20370 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20371 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20373 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20375 check_mouse_face
= 1;
20376 mouse_beg_col
= (row
== mouse_beg_row
)
20377 ? dpyinfo
->mouse_face_beg_col
: 0;
20378 mouse_end_col
= (row
== mouse_end_row
)
20379 ? dpyinfo
->mouse_face_end_col
20380 : row
->used
[TEXT_AREA
];
20384 /* Compute overhangs for all glyph strings. */
20385 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20386 for (s
= head
; s
; s
= s
->next
)
20387 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20389 /* Prepend glyph strings for glyphs in front of the first glyph
20390 string that are overwritten because of the first glyph
20391 string's left overhang. The background of all strings
20392 prepended must be drawn because the first glyph string
20394 i
= left_overwritten (head
);
20397 enum draw_glyphs_face overlap_hl
;
20399 /* If this row contains mouse highlighting, attempt to draw
20400 the overlapped glyphs with the correct highlight. This
20401 code fails if the overlap encompasses more than one glyph
20402 and mouse-highlight spans only some of these glyphs.
20403 However, making it work perfectly involves a lot more
20404 code, and I don't know if the pathological case occurs in
20405 practice, so we'll stick to this for now. --- cyd */
20406 if (check_mouse_face
20407 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20408 overlap_hl
= DRAW_MOUSE_FACE
;
20410 overlap_hl
= DRAW_NORMAL_TEXT
;
20413 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20414 overlap_hl
, dummy_x
, last_x
);
20415 compute_overhangs_and_x (t
, head
->x
, 1);
20416 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20420 /* Prepend glyph strings for glyphs in front of the first glyph
20421 string that overwrite that glyph string because of their
20422 right overhang. For these strings, only the foreground must
20423 be drawn, because it draws over the glyph string at `head'.
20424 The background must not be drawn because this would overwrite
20425 right overhangs of preceding glyphs for which no glyph
20427 i
= left_overwriting (head
);
20430 enum draw_glyphs_face overlap_hl
;
20432 if (check_mouse_face
20433 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20434 overlap_hl
= DRAW_MOUSE_FACE
;
20436 overlap_hl
= DRAW_NORMAL_TEXT
;
20439 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20440 overlap_hl
, dummy_x
, last_x
);
20441 for (s
= h
; s
; s
= s
->next
)
20442 s
->background_filled_p
= 1;
20443 compute_overhangs_and_x (t
, head
->x
, 1);
20444 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20447 /* Append glyphs strings for glyphs following the last glyph
20448 string tail that are overwritten by tail. The background of
20449 these strings has to be drawn because tail's foreground draws
20451 i
= right_overwritten (tail
);
20454 enum draw_glyphs_face overlap_hl
;
20456 if (check_mouse_face
20457 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20458 overlap_hl
= DRAW_MOUSE_FACE
;
20460 overlap_hl
= DRAW_NORMAL_TEXT
;
20462 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20463 overlap_hl
, x
, last_x
);
20464 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20465 append_glyph_string_lists (&head
, &tail
, h
, t
);
20469 /* Append glyph strings for glyphs following the last glyph
20470 string tail that overwrite tail. The foreground of such
20471 glyphs has to be drawn because it writes into the background
20472 of tail. The background must not be drawn because it could
20473 paint over the foreground of following glyphs. */
20474 i
= right_overwriting (tail
);
20477 enum draw_glyphs_face overlap_hl
;
20478 if (check_mouse_face
20479 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20480 overlap_hl
= DRAW_MOUSE_FACE
;
20482 overlap_hl
= DRAW_NORMAL_TEXT
;
20485 i
++; /* We must include the Ith glyph. */
20486 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20487 overlap_hl
, x
, last_x
);
20488 for (s
= h
; s
; s
= s
->next
)
20489 s
->background_filled_p
= 1;
20490 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20491 append_glyph_string_lists (&head
, &tail
, h
, t
);
20493 if (clip_head
|| clip_tail
)
20494 for (s
= head
; s
; s
= s
->next
)
20496 s
->clip_head
= clip_head
;
20497 s
->clip_tail
= clip_tail
;
20501 /* Draw all strings. */
20502 for (s
= head
; s
; s
= s
->next
)
20503 FRAME_RIF (f
)->draw_glyph_string (s
);
20505 if (area
== TEXT_AREA
20506 && !row
->full_width_p
20507 /* When drawing overlapping rows, only the glyph strings'
20508 foreground is drawn, which doesn't erase a cursor
20512 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20513 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20514 : (tail
? tail
->x
+ tail
->background_width
: x
));
20518 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20519 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20522 /* Value is the x-position up to which drawn, relative to AREA of W.
20523 This doesn't include parts drawn because of overhangs. */
20524 if (row
->full_width_p
)
20525 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20527 x_reached
-= area_left
;
20529 RELEASE_HDC (hdc
, f
);
20534 /* Expand row matrix if too narrow. Don't expand if area
20537 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20539 if (!fonts_changed_p \
20540 && (it->glyph_row->glyphs[area] \
20541 < it->glyph_row->glyphs[area + 1])) \
20543 it->w->ncols_scale_factor++; \
20544 fonts_changed_p = 1; \
20548 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20549 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20555 struct glyph
*glyph
;
20556 enum glyph_row_area area
= it
->area
;
20558 xassert (it
->glyph_row
);
20559 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20561 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20562 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20564 glyph
->charpos
= CHARPOS (it
->position
);
20565 glyph
->object
= it
->object
;
20566 if (it
->pixel_width
> 0)
20568 glyph
->pixel_width
= it
->pixel_width
;
20569 glyph
->padding_p
= 0;
20573 /* Assure at least 1-pixel width. Otherwise, cursor can't
20574 be displayed correctly. */
20575 glyph
->pixel_width
= 1;
20576 glyph
->padding_p
= 1;
20578 glyph
->ascent
= it
->ascent
;
20579 glyph
->descent
= it
->descent
;
20580 glyph
->voffset
= it
->voffset
;
20581 glyph
->type
= CHAR_GLYPH
;
20582 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20583 glyph
->multibyte_p
= it
->multibyte_p
;
20584 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20585 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20586 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20587 || it
->phys_descent
> it
->descent
);
20588 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20589 glyph
->face_id
= it
->face_id
;
20590 glyph
->u
.ch
= it
->char_to_display
;
20591 glyph
->slice
= null_glyph_slice
;
20592 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20593 ++it
->glyph_row
->used
[area
];
20596 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20599 /* Store one glyph for the composition IT->cmp_it.id in
20600 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
20604 append_composite_glyph (it
)
20607 struct glyph
*glyph
;
20608 enum glyph_row_area area
= it
->area
;
20610 xassert (it
->glyph_row
);
20612 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20613 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20615 glyph
->charpos
= CHARPOS (it
->position
);
20616 glyph
->object
= it
->object
;
20617 glyph
->pixel_width
= it
->pixel_width
;
20618 glyph
->ascent
= it
->ascent
;
20619 glyph
->descent
= it
->descent
;
20620 glyph
->voffset
= it
->voffset
;
20621 glyph
->type
= COMPOSITE_GLYPH
;
20622 if (it
->cmp_it
.ch
< 0)
20624 glyph
->u
.cmp
.automatic
= 0;
20625 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20629 glyph
->u
.cmp
.automatic
= 1;
20630 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20631 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
20632 glyph
->u
.cmp
.to
= it
->cmp_it
.to
;
20634 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20635 glyph
->multibyte_p
= it
->multibyte_p
;
20636 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20637 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20638 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20639 || it
->phys_descent
> it
->descent
);
20640 glyph
->padding_p
= 0;
20641 glyph
->glyph_not_available_p
= 0;
20642 glyph
->face_id
= it
->face_id
;
20643 glyph
->slice
= null_glyph_slice
;
20644 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20645 ++it
->glyph_row
->used
[area
];
20648 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20652 /* Change IT->ascent and IT->height according to the setting of
20656 take_vertical_position_into_account (it
)
20661 if (it
->voffset
< 0)
20662 /* Increase the ascent so that we can display the text higher
20664 it
->ascent
-= it
->voffset
;
20666 /* Increase the descent so that we can display the text lower
20668 it
->descent
+= it
->voffset
;
20673 /* Produce glyphs/get display metrics for the image IT is loaded with.
20674 See the description of struct display_iterator in dispextern.h for
20675 an overview of struct display_iterator. */
20678 produce_image_glyph (it
)
20683 int glyph_ascent
, crop
;
20684 struct glyph_slice slice
;
20686 xassert (it
->what
== IT_IMAGE
);
20688 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20690 /* Make sure X resources of the face is loaded. */
20691 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20693 if (it
->image_id
< 0)
20695 /* Fringe bitmap. */
20696 it
->ascent
= it
->phys_ascent
= 0;
20697 it
->descent
= it
->phys_descent
= 0;
20698 it
->pixel_width
= 0;
20703 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20705 /* Make sure X resources of the image is loaded. */
20706 prepare_image_for_display (it
->f
, img
);
20708 slice
.x
= slice
.y
= 0;
20709 slice
.width
= img
->width
;
20710 slice
.height
= img
->height
;
20712 if (INTEGERP (it
->slice
.x
))
20713 slice
.x
= XINT (it
->slice
.x
);
20714 else if (FLOATP (it
->slice
.x
))
20715 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20717 if (INTEGERP (it
->slice
.y
))
20718 slice
.y
= XINT (it
->slice
.y
);
20719 else if (FLOATP (it
->slice
.y
))
20720 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20722 if (INTEGERP (it
->slice
.width
))
20723 slice
.width
= XINT (it
->slice
.width
);
20724 else if (FLOATP (it
->slice
.width
))
20725 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20727 if (INTEGERP (it
->slice
.height
))
20728 slice
.height
= XINT (it
->slice
.height
);
20729 else if (FLOATP (it
->slice
.height
))
20730 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20732 if (slice
.x
>= img
->width
)
20733 slice
.x
= img
->width
;
20734 if (slice
.y
>= img
->height
)
20735 slice
.y
= img
->height
;
20736 if (slice
.x
+ slice
.width
>= img
->width
)
20737 slice
.width
= img
->width
- slice
.x
;
20738 if (slice
.y
+ slice
.height
> img
->height
)
20739 slice
.height
= img
->height
- slice
.y
;
20741 if (slice
.width
== 0 || slice
.height
== 0)
20744 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20746 it
->descent
= slice
.height
- glyph_ascent
;
20748 it
->descent
+= img
->vmargin
;
20749 if (slice
.y
+ slice
.height
== img
->height
)
20750 it
->descent
+= img
->vmargin
;
20751 it
->phys_descent
= it
->descent
;
20753 it
->pixel_width
= slice
.width
;
20755 it
->pixel_width
+= img
->hmargin
;
20756 if (slice
.x
+ slice
.width
== img
->width
)
20757 it
->pixel_width
+= img
->hmargin
;
20759 /* It's quite possible for images to have an ascent greater than
20760 their height, so don't get confused in that case. */
20761 if (it
->descent
< 0)
20764 #if 0 /* this breaks image tiling */
20765 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20766 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20767 if (face_ascent
> it
->ascent
)
20768 it
->ascent
= it
->phys_ascent
= face_ascent
;
20773 if (face
->box
!= FACE_NO_BOX
)
20775 if (face
->box_line_width
> 0)
20778 it
->ascent
+= face
->box_line_width
;
20779 if (slice
.y
+ slice
.height
== img
->height
)
20780 it
->descent
+= face
->box_line_width
;
20783 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20784 it
->pixel_width
+= eabs (face
->box_line_width
);
20785 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20786 it
->pixel_width
+= eabs (face
->box_line_width
);
20789 take_vertical_position_into_account (it
);
20791 /* Automatically crop wide image glyphs at right edge so we can
20792 draw the cursor on same display row. */
20793 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20794 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20796 it
->pixel_width
-= crop
;
20797 slice
.width
-= crop
;
20802 struct glyph
*glyph
;
20803 enum glyph_row_area area
= it
->area
;
20805 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20806 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20808 glyph
->charpos
= CHARPOS (it
->position
);
20809 glyph
->object
= it
->object
;
20810 glyph
->pixel_width
= it
->pixel_width
;
20811 glyph
->ascent
= glyph_ascent
;
20812 glyph
->descent
= it
->descent
;
20813 glyph
->voffset
= it
->voffset
;
20814 glyph
->type
= IMAGE_GLYPH
;
20815 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20816 glyph
->multibyte_p
= it
->multibyte_p
;
20817 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20818 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20819 glyph
->overlaps_vertically_p
= 0;
20820 glyph
->padding_p
= 0;
20821 glyph
->glyph_not_available_p
= 0;
20822 glyph
->face_id
= it
->face_id
;
20823 glyph
->u
.img_id
= img
->id
;
20824 glyph
->slice
= slice
;
20825 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20826 ++it
->glyph_row
->used
[area
];
20829 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20834 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20835 of the glyph, WIDTH and HEIGHT are the width and height of the
20836 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20839 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20841 Lisp_Object object
;
20845 struct glyph
*glyph
;
20846 enum glyph_row_area area
= it
->area
;
20848 xassert (ascent
>= 0 && ascent
<= height
);
20850 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20851 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20853 glyph
->charpos
= CHARPOS (it
->position
);
20854 glyph
->object
= object
;
20855 glyph
->pixel_width
= width
;
20856 glyph
->ascent
= ascent
;
20857 glyph
->descent
= height
- ascent
;
20858 glyph
->voffset
= it
->voffset
;
20859 glyph
->type
= STRETCH_GLYPH
;
20860 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20861 glyph
->multibyte_p
= it
->multibyte_p
;
20862 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20863 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20864 glyph
->overlaps_vertically_p
= 0;
20865 glyph
->padding_p
= 0;
20866 glyph
->glyph_not_available_p
= 0;
20867 glyph
->face_id
= it
->face_id
;
20868 glyph
->u
.stretch
.ascent
= ascent
;
20869 glyph
->u
.stretch
.height
= height
;
20870 glyph
->slice
= null_glyph_slice
;
20871 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20872 ++it
->glyph_row
->used
[area
];
20875 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20879 /* Produce a stretch glyph for iterator IT. IT->object is the value
20880 of the glyph property displayed. The value must be a list
20881 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20884 1. `:width WIDTH' specifies that the space should be WIDTH *
20885 canonical char width wide. WIDTH may be an integer or floating
20888 2. `:relative-width FACTOR' specifies that the width of the stretch
20889 should be computed from the width of the first character having the
20890 `glyph' property, and should be FACTOR times that width.
20892 3. `:align-to HPOS' specifies that the space should be wide enough
20893 to reach HPOS, a value in canonical character units.
20895 Exactly one of the above pairs must be present.
20897 4. `:height HEIGHT' specifies that the height of the stretch produced
20898 should be HEIGHT, measured in canonical character units.
20900 5. `:relative-height FACTOR' specifies that the height of the
20901 stretch should be FACTOR times the height of the characters having
20902 the glyph property.
20904 Either none or exactly one of 4 or 5 must be present.
20906 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20907 of the stretch should be used for the ascent of the stretch.
20908 ASCENT must be in the range 0 <= ASCENT <= 100. */
20911 produce_stretch_glyph (it
)
20914 /* (space :width WIDTH :height HEIGHT ...) */
20915 Lisp_Object prop
, plist
;
20916 int width
= 0, height
= 0, align_to
= -1;
20917 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20920 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20921 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20923 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20925 /* List should start with `space'. */
20926 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20927 plist
= XCDR (it
->object
);
20929 /* Compute the width of the stretch. */
20930 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20931 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20933 /* Absolute width `:width WIDTH' specified and valid. */
20934 zero_width_ok_p
= 1;
20937 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20940 /* Relative width `:relative-width FACTOR' specified and valid.
20941 Compute the width of the characters having the `glyph'
20944 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20947 if (it
->multibyte_p
)
20949 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20950 - IT_BYTEPOS (*it
));
20951 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20954 it2
.c
= *p
, it2
.len
= 1;
20956 it2
.glyph_row
= NULL
;
20957 it2
.what
= IT_CHARACTER
;
20958 x_produce_glyphs (&it2
);
20959 width
= NUMVAL (prop
) * it2
.pixel_width
;
20961 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20962 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20964 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20965 align_to
= (align_to
< 0
20967 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20968 else if (align_to
< 0)
20969 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20970 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20971 zero_width_ok_p
= 1;
20974 /* Nothing specified -> width defaults to canonical char width. */
20975 width
= FRAME_COLUMN_WIDTH (it
->f
);
20977 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20980 /* Compute height. */
20981 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20982 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20985 zero_height_ok_p
= 1;
20987 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20989 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20991 height
= FONT_HEIGHT (font
);
20993 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20996 /* Compute percentage of height used for ascent. If
20997 `:ascent ASCENT' is present and valid, use that. Otherwise,
20998 derive the ascent from the font in use. */
20999 if (prop
= Fplist_get (plist
, QCascent
),
21000 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21001 ascent
= height
* NUMVAL (prop
) / 100.0;
21002 else if (!NILP (prop
)
21003 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21004 ascent
= min (max (0, (int)tem
), height
);
21006 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21008 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21009 && it
->current_x
+ width
> it
->last_visible_x
)
21010 width
= it
->last_visible_x
- it
->current_x
- 1;
21012 if (width
> 0 && height
> 0 && it
->glyph_row
)
21014 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21015 if (!STRINGP (object
))
21016 object
= it
->w
->buffer
;
21017 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21020 it
->pixel_width
= width
;
21021 it
->ascent
= it
->phys_ascent
= ascent
;
21022 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21023 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21025 take_vertical_position_into_account (it
);
21028 /* Calculate line-height and line-spacing properties.
21029 An integer value specifies explicit pixel value.
21030 A float value specifies relative value to current face height.
21031 A cons (float . face-name) specifies relative value to
21032 height of specified face font.
21034 Returns height in pixels, or nil. */
21038 calc_line_height_property (it
, val
, font
, boff
, override
)
21042 int boff
, override
;
21044 Lisp_Object face_name
= Qnil
;
21045 int ascent
, descent
, height
;
21047 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21052 face_name
= XCAR (val
);
21054 if (!NUMBERP (val
))
21055 val
= make_number (1);
21056 if (NILP (face_name
))
21058 height
= it
->ascent
+ it
->descent
;
21063 if (NILP (face_name
))
21065 font
= FRAME_FONT (it
->f
);
21066 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21068 else if (EQ (face_name
, Qt
))
21077 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21079 return make_number (-1);
21081 face
= FACE_FROM_ID (it
->f
, face_id
);
21084 return make_number (-1);
21085 boff
= font
->baseline_offset
;
21086 if (font
->vertical_centering
)
21087 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21090 ascent
= FONT_BASE (font
) + boff
;
21091 descent
= FONT_DESCENT (font
) - boff
;
21095 it
->override_ascent
= ascent
;
21096 it
->override_descent
= descent
;
21097 it
->override_boff
= boff
;
21100 height
= ascent
+ descent
;
21104 height
= (int)(XFLOAT_DATA (val
) * height
);
21105 else if (INTEGERP (val
))
21106 height
*= XINT (val
);
21108 return make_number (height
);
21113 Produce glyphs/get display metrics for the display element IT is
21114 loaded with. See the description of struct it in dispextern.h
21115 for an overview of struct it. */
21118 x_produce_glyphs (it
)
21121 int extra_line_spacing
= it
->extra_line_spacing
;
21123 it
->glyph_not_available_p
= 0;
21125 if (it
->what
== IT_CHARACTER
)
21129 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21130 struct font_metrics
*pcm
;
21131 int font_not_found_p
;
21132 int boff
; /* baseline offset */
21133 /* We may change it->multibyte_p upon unibyte<->multibyte
21134 conversion. So, save the current value now and restore it
21137 Note: It seems that we don't have to record multibyte_p in
21138 struct glyph because the character code itself tells if or
21139 not the character is multibyte. Thus, in the future, we must
21140 consider eliminating the field `multibyte_p' in the struct
21142 int saved_multibyte_p
= it
->multibyte_p
;
21144 /* Maybe translate single-byte characters to multibyte, or the
21146 it
->char_to_display
= it
->c
;
21147 if (!ASCII_BYTE_P (it
->c
)
21148 && ! it
->multibyte_p
)
21150 if (SINGLE_BYTE_CHAR_P (it
->c
)
21151 && unibyte_display_via_language_environment
)
21152 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
21153 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
21155 it
->multibyte_p
= 1;
21156 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21158 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21162 /* Get font to use. Encode IT->char_to_display. */
21163 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21164 &char2b
, it
->multibyte_p
, 0);
21167 /* When no suitable font found, use the default font. */
21168 font_not_found_p
= font
== NULL
;
21169 if (font_not_found_p
)
21171 font
= FRAME_FONT (it
->f
);
21172 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21176 boff
= font
->baseline_offset
;
21177 if (font
->vertical_centering
)
21178 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21181 if (it
->char_to_display
>= ' '
21182 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21184 /* Either unibyte or ASCII. */
21189 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21191 if (it
->override_ascent
>= 0)
21193 it
->ascent
= it
->override_ascent
;
21194 it
->descent
= it
->override_descent
;
21195 boff
= it
->override_boff
;
21199 it
->ascent
= FONT_BASE (font
) + boff
;
21200 it
->descent
= FONT_DESCENT (font
) - boff
;
21205 it
->phys_ascent
= pcm
->ascent
+ boff
;
21206 it
->phys_descent
= pcm
->descent
- boff
;
21207 it
->pixel_width
= pcm
->width
;
21211 it
->glyph_not_available_p
= 1;
21212 it
->phys_ascent
= it
->ascent
;
21213 it
->phys_descent
= it
->descent
;
21214 it
->pixel_width
= FONT_WIDTH (font
);
21217 if (it
->constrain_row_ascent_descent_p
)
21219 if (it
->descent
> it
->max_descent
)
21221 it
->ascent
+= it
->descent
- it
->max_descent
;
21222 it
->descent
= it
->max_descent
;
21224 if (it
->ascent
> it
->max_ascent
)
21226 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21227 it
->ascent
= it
->max_ascent
;
21229 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21230 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21231 extra_line_spacing
= 0;
21234 /* If this is a space inside a region of text with
21235 `space-width' property, change its width. */
21236 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21238 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21240 /* If face has a box, add the box thickness to the character
21241 height. If character has a box line to the left and/or
21242 right, add the box line width to the character's width. */
21243 if (face
->box
!= FACE_NO_BOX
)
21245 int thick
= face
->box_line_width
;
21249 it
->ascent
+= thick
;
21250 it
->descent
+= thick
;
21255 if (it
->start_of_box_run_p
)
21256 it
->pixel_width
+= thick
;
21257 if (it
->end_of_box_run_p
)
21258 it
->pixel_width
+= thick
;
21261 /* If face has an overline, add the height of the overline
21262 (1 pixel) and a 1 pixel margin to the character height. */
21263 if (face
->overline_p
)
21264 it
->ascent
+= overline_margin
;
21266 if (it
->constrain_row_ascent_descent_p
)
21268 if (it
->ascent
> it
->max_ascent
)
21269 it
->ascent
= it
->max_ascent
;
21270 if (it
->descent
> it
->max_descent
)
21271 it
->descent
= it
->max_descent
;
21274 take_vertical_position_into_account (it
);
21276 /* If we have to actually produce glyphs, do it. */
21281 /* Translate a space with a `space-width' property
21282 into a stretch glyph. */
21283 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21284 / FONT_HEIGHT (font
));
21285 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21286 it
->ascent
+ it
->descent
, ascent
);
21291 /* If characters with lbearing or rbearing are displayed
21292 in this line, record that fact in a flag of the
21293 glyph row. This is used to optimize X output code. */
21294 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21295 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21297 if (! stretched_p
&& it
->pixel_width
== 0)
21298 /* We assure that all visible glyphs have at least 1-pixel
21300 it
->pixel_width
= 1;
21302 else if (it
->char_to_display
== '\n')
21304 /* A newline has no width but we need the height of the line.
21305 But if previous part of the line set a height, don't
21306 increase that height */
21308 Lisp_Object height
;
21309 Lisp_Object total_height
= Qnil
;
21311 it
->override_ascent
= -1;
21312 it
->pixel_width
= 0;
21315 height
= get_it_property(it
, Qline_height
);
21316 /* Split (line-height total-height) list */
21318 && CONSP (XCDR (height
))
21319 && NILP (XCDR (XCDR (height
))))
21321 total_height
= XCAR (XCDR (height
));
21322 height
= XCAR (height
);
21324 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21326 if (it
->override_ascent
>= 0)
21328 it
->ascent
= it
->override_ascent
;
21329 it
->descent
= it
->override_descent
;
21330 boff
= it
->override_boff
;
21334 it
->ascent
= FONT_BASE (font
) + boff
;
21335 it
->descent
= FONT_DESCENT (font
) - boff
;
21338 if (EQ (height
, Qt
))
21340 if (it
->descent
> it
->max_descent
)
21342 it
->ascent
+= it
->descent
- it
->max_descent
;
21343 it
->descent
= it
->max_descent
;
21345 if (it
->ascent
> it
->max_ascent
)
21347 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21348 it
->ascent
= it
->max_ascent
;
21350 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21351 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21352 it
->constrain_row_ascent_descent_p
= 1;
21353 extra_line_spacing
= 0;
21357 Lisp_Object spacing
;
21359 it
->phys_ascent
= it
->ascent
;
21360 it
->phys_descent
= it
->descent
;
21362 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21363 && face
->box
!= FACE_NO_BOX
21364 && face
->box_line_width
> 0)
21366 it
->ascent
+= face
->box_line_width
;
21367 it
->descent
+= face
->box_line_width
;
21370 && XINT (height
) > it
->ascent
+ it
->descent
)
21371 it
->ascent
= XINT (height
) - it
->descent
;
21373 if (!NILP (total_height
))
21374 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21377 spacing
= get_it_property(it
, Qline_spacing
);
21378 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21380 if (INTEGERP (spacing
))
21382 extra_line_spacing
= XINT (spacing
);
21383 if (!NILP (total_height
))
21384 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21388 else if (it
->char_to_display
== '\t')
21390 if (font
->space_width
> 0)
21392 int tab_width
= it
->tab_width
* font
->space_width
;
21393 int x
= it
->current_x
+ it
->continuation_lines_width
;
21394 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21396 /* If the distance from the current position to the next tab
21397 stop is less than a space character width, use the
21398 tab stop after that. */
21399 if (next_tab_x
- x
< font
->space_width
)
21400 next_tab_x
+= tab_width
;
21402 it
->pixel_width
= next_tab_x
- x
;
21404 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21405 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21409 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21410 it
->ascent
+ it
->descent
, it
->ascent
);
21415 it
->pixel_width
= 0;
21421 /* A multi-byte character. Assume that the display width of the
21422 character is the width of the character multiplied by the
21423 width of the font. */
21425 /* If we found a font, this font should give us the right
21426 metrics. If we didn't find a font, use the frame's
21427 default font and calculate the width of the character by
21428 multiplying the width of font by the width of the
21431 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21433 if (font_not_found_p
|| !pcm
)
21435 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21437 if (char_width
== 0)
21438 /* This is a non spacing character. But, as we are
21439 going to display an empty box, the box must occupy
21440 at least one column. */
21442 it
->glyph_not_available_p
= 1;
21443 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21444 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21445 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21449 it
->pixel_width
= pcm
->width
;
21450 it
->phys_ascent
= pcm
->ascent
+ boff
;
21451 it
->phys_descent
= pcm
->descent
- boff
;
21453 && (pcm
->lbearing
< 0
21454 || pcm
->rbearing
> pcm
->width
))
21455 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21458 it
->ascent
= FONT_BASE (font
) + boff
;
21459 it
->descent
= FONT_DESCENT (font
) - boff
;
21460 if (face
->box
!= FACE_NO_BOX
)
21462 int thick
= face
->box_line_width
;
21466 it
->ascent
+= thick
;
21467 it
->descent
+= thick
;
21472 if (it
->start_of_box_run_p
)
21473 it
->pixel_width
+= thick
;
21474 if (it
->end_of_box_run_p
)
21475 it
->pixel_width
+= thick
;
21478 /* If face has an overline, add the height of the overline
21479 (1 pixel) and a 1 pixel margin to the character height. */
21480 if (face
->overline_p
)
21481 it
->ascent
+= overline_margin
;
21483 take_vertical_position_into_account (it
);
21485 if (it
->ascent
< 0)
21487 if (it
->descent
< 0)
21492 if (it
->pixel_width
== 0)
21493 /* We assure that all visible glyphs have at least 1-pixel
21495 it
->pixel_width
= 1;
21497 it
->multibyte_p
= saved_multibyte_p
;
21499 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
21501 /* A static compositoin.
21503 Note: A composition is represented as one glyph in the
21504 glyph matrix. There are no padding glyphs.
21506 Important is that pixel_width, ascent, and descent are the
21507 values of what is drawn by draw_glyphs (i.e. the values of
21508 the overall glyphs composed). */
21509 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21510 int boff
; /* baseline offset */
21511 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
21512 int glyph_len
= cmp
->glyph_len
;
21513 struct font
*font
= face
->font
;
21517 /* If we have not yet calculated pixel size data of glyphs of
21518 the composition for the current face font, calculate them
21519 now. Theoretically, we have to check all fonts for the
21520 glyphs, but that requires much time and memory space. So,
21521 here we check only the font of the first glyph. This leads
21522 to incorrect display, but it's very rare, and C-l (recenter)
21523 can correct the display anyway. */
21524 if (! cmp
->font
|| cmp
->font
!= font
)
21526 /* Ascent and descent of the font of the first character
21527 of this composition (adjusted by baseline offset).
21528 Ascent and descent of overall glyphs should not be less
21529 than them respectively. */
21530 int font_ascent
, font_descent
, font_height
;
21531 /* Bounding box of the overall glyphs. */
21532 int leftmost
, rightmost
, lowest
, highest
;
21533 int lbearing
, rbearing
;
21534 int i
, width
, ascent
, descent
;
21535 int left_padded
= 0, right_padded
= 0;
21538 struct font_metrics
*pcm
;
21539 int font_not_found_p
;
21542 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21543 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21545 if (glyph_len
< cmp
->glyph_len
)
21547 for (i
= 0; i
< glyph_len
; i
++)
21549 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21551 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21556 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21557 : IT_CHARPOS (*it
));
21558 /* When no suitable font found, use the default font. */
21559 font_not_found_p
= font
== NULL
;
21560 if (font_not_found_p
)
21562 face
= face
->ascii_face
;
21565 boff
= font
->baseline_offset
;
21566 if (font
->vertical_centering
)
21567 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21568 font_ascent
= FONT_BASE (font
) + boff
;
21569 font_descent
= FONT_DESCENT (font
) - boff
;
21570 font_height
= FONT_HEIGHT (font
);
21572 cmp
->font
= (void *) font
;
21575 if (! font_not_found_p
)
21577 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21578 &char2b
, it
->multibyte_p
, 0);
21579 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21582 /* Initialize the bounding box. */
21585 width
= pcm
->width
;
21586 ascent
= pcm
->ascent
;
21587 descent
= pcm
->descent
;
21588 lbearing
= pcm
->lbearing
;
21589 rbearing
= pcm
->rbearing
;
21593 width
= FONT_WIDTH (font
);
21594 ascent
= FONT_BASE (font
);
21595 descent
= FONT_DESCENT (font
);
21602 lowest
= - descent
+ boff
;
21603 highest
= ascent
+ boff
;
21605 if (! font_not_found_p
21606 && font
->default_ascent
21607 && CHAR_TABLE_P (Vuse_default_ascent
)
21608 && !NILP (Faref (Vuse_default_ascent
,
21609 make_number (it
->char_to_display
))))
21610 highest
= font
->default_ascent
+ boff
;
21612 /* Draw the first glyph at the normal position. It may be
21613 shifted to right later if some other glyphs are drawn
21615 cmp
->offsets
[i
* 2] = 0;
21616 cmp
->offsets
[i
* 2 + 1] = boff
;
21617 cmp
->lbearing
= lbearing
;
21618 cmp
->rbearing
= rbearing
;
21620 /* Set cmp->offsets for the remaining glyphs. */
21621 for (i
++; i
< glyph_len
; i
++)
21623 int left
, right
, btm
, top
;
21624 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21626 struct face
*this_face
;
21631 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21632 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21633 font
= this_face
->font
;
21639 this_boff
= font
->baseline_offset
;
21640 if (font
->vertical_centering
)
21641 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21642 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21643 &char2b
, it
->multibyte_p
, 0);
21644 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21647 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21650 width
= pcm
->width
;
21651 ascent
= pcm
->ascent
;
21652 descent
= pcm
->descent
;
21653 lbearing
= pcm
->lbearing
;
21654 rbearing
= pcm
->rbearing
;
21655 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21657 /* Relative composition with or without
21658 alternate chars. */
21659 left
= (leftmost
+ rightmost
- width
) / 2;
21660 btm
= - descent
+ boff
;
21661 if (font
->relative_compose
21662 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21663 || NILP (Faref (Vignore_relative_composition
,
21664 make_number (ch
)))))
21667 if (- descent
>= font
->relative_compose
)
21668 /* One extra pixel between two glyphs. */
21670 else if (ascent
<= 0)
21671 /* One extra pixel between two glyphs. */
21672 btm
= lowest
- 1 - ascent
- descent
;
21677 /* A composition rule is specified by an integer
21678 value that encodes global and new reference
21679 points (GREF and NREF). GREF and NREF are
21680 specified by numbers as below:
21682 0---1---2 -- ascent
21686 9--10--11 -- center
21688 ---3---4---5--- baseline
21690 6---7---8 -- descent
21692 int rule
= COMPOSITION_RULE (cmp
, i
);
21693 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21695 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21696 grefx
= gref
% 3, nrefx
= nref
% 3;
21697 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21699 xoff
= font_height
* (xoff
- 128) / 256;
21701 yoff
= font_height
* (yoff
- 128) / 256;
21704 + grefx
* (rightmost
- leftmost
) / 2
21705 - nrefx
* width
/ 2
21708 btm
= ((grefy
== 0 ? highest
21710 : grefy
== 2 ? lowest
21711 : (highest
+ lowest
) / 2)
21712 - (nrefy
== 0 ? ascent
+ descent
21713 : nrefy
== 1 ? descent
- boff
21715 : (ascent
+ descent
) / 2)
21719 cmp
->offsets
[i
* 2] = left
;
21720 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21722 /* Update the bounding box of the overall glyphs. */
21725 right
= left
+ width
;
21726 if (left
< leftmost
)
21728 if (right
> rightmost
)
21731 top
= btm
+ descent
+ ascent
;
21737 if (cmp
->lbearing
> left
+ lbearing
)
21738 cmp
->lbearing
= left
+ lbearing
;
21739 if (cmp
->rbearing
< left
+ rbearing
)
21740 cmp
->rbearing
= left
+ rbearing
;
21744 /* If there are glyphs whose x-offsets are negative,
21745 shift all glyphs to the right and make all x-offsets
21749 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21750 cmp
->offsets
[i
* 2] -= leftmost
;
21751 rightmost
-= leftmost
;
21752 cmp
->lbearing
-= leftmost
;
21753 cmp
->rbearing
-= leftmost
;
21756 if (left_padded
&& cmp
->lbearing
< 0)
21758 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21759 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21760 rightmost
-= cmp
->lbearing
;
21761 cmp
->rbearing
-= cmp
->lbearing
;
21764 if (right_padded
&& rightmost
< cmp
->rbearing
)
21766 rightmost
= cmp
->rbearing
;
21769 cmp
->pixel_width
= rightmost
;
21770 cmp
->ascent
= highest
;
21771 cmp
->descent
= - lowest
;
21772 if (cmp
->ascent
< font_ascent
)
21773 cmp
->ascent
= font_ascent
;
21774 if (cmp
->descent
< font_descent
)
21775 cmp
->descent
= font_descent
;
21779 && (cmp
->lbearing
< 0
21780 || cmp
->rbearing
> cmp
->pixel_width
))
21781 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21783 it
->pixel_width
= cmp
->pixel_width
;
21784 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21785 it
->descent
= it
->phys_descent
= cmp
->descent
;
21786 if (face
->box
!= FACE_NO_BOX
)
21788 int thick
= face
->box_line_width
;
21792 it
->ascent
+= thick
;
21793 it
->descent
+= thick
;
21798 if (it
->start_of_box_run_p
)
21799 it
->pixel_width
+= thick
;
21800 if (it
->end_of_box_run_p
)
21801 it
->pixel_width
+= thick
;
21804 /* If face has an overline, add the height of the overline
21805 (1 pixel) and a 1 pixel margin to the character height. */
21806 if (face
->overline_p
)
21807 it
->ascent
+= overline_margin
;
21809 take_vertical_position_into_account (it
);
21810 if (it
->ascent
< 0)
21812 if (it
->descent
< 0)
21816 append_composite_glyph (it
);
21818 else if (it
->what
== IT_COMPOSITION
)
21820 /* A dynamic (automatic) composition. */
21821 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21822 Lisp_Object gstring
;
21823 struct font_metrics metrics
;
21825 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
21827 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
21830 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
21831 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21832 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
21833 it
->descent
= it
->phys_descent
= metrics
.descent
;
21834 if (face
->box
!= FACE_NO_BOX
)
21836 int thick
= face
->box_line_width
;
21840 it
->ascent
+= thick
;
21841 it
->descent
+= thick
;
21846 if (it
->start_of_box_run_p
)
21847 it
->pixel_width
+= thick
;
21848 if (it
->end_of_box_run_p
)
21849 it
->pixel_width
+= thick
;
21851 /* If face has an overline, add the height of the overline
21852 (1 pixel) and a 1 pixel margin to the character height. */
21853 if (face
->overline_p
)
21854 it
->ascent
+= overline_margin
;
21855 take_vertical_position_into_account (it
);
21856 if (it
->ascent
< 0)
21858 if (it
->descent
< 0)
21862 append_composite_glyph (it
);
21864 else if (it
->what
== IT_IMAGE
)
21865 produce_image_glyph (it
);
21866 else if (it
->what
== IT_STRETCH
)
21867 produce_stretch_glyph (it
);
21869 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21870 because this isn't true for images with `:ascent 100'. */
21871 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21872 if (it
->area
== TEXT_AREA
)
21873 it
->current_x
+= it
->pixel_width
;
21875 if (extra_line_spacing
> 0)
21877 it
->descent
+= extra_line_spacing
;
21878 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21879 it
->max_extra_line_spacing
= extra_line_spacing
;
21882 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21883 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21884 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21885 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21889 Output LEN glyphs starting at START at the nominal cursor position.
21890 Advance the nominal cursor over the text. The global variable
21891 updated_window contains the window being updated, updated_row is
21892 the glyph row being updated, and updated_area is the area of that
21893 row being updated. */
21896 x_write_glyphs (start
, len
)
21897 struct glyph
*start
;
21902 xassert (updated_window
&& updated_row
);
21905 /* Write glyphs. */
21907 hpos
= start
- updated_row
->glyphs
[updated_area
];
21908 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21909 updated_row
, updated_area
,
21911 DRAW_NORMAL_TEXT
, 0);
21913 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21914 if (updated_area
== TEXT_AREA
21915 && updated_window
->phys_cursor_on_p
21916 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21917 && updated_window
->phys_cursor
.hpos
>= hpos
21918 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21919 updated_window
->phys_cursor_on_p
= 0;
21923 /* Advance the output cursor. */
21924 output_cursor
.hpos
+= len
;
21925 output_cursor
.x
= x
;
21930 Insert LEN glyphs from START at the nominal cursor position. */
21933 x_insert_glyphs (start
, len
)
21934 struct glyph
*start
;
21939 int line_height
, shift_by_width
, shifted_region_width
;
21940 struct glyph_row
*row
;
21941 struct glyph
*glyph
;
21942 int frame_x
, frame_y
;
21945 xassert (updated_window
&& updated_row
);
21947 w
= updated_window
;
21948 f
= XFRAME (WINDOW_FRAME (w
));
21950 /* Get the height of the line we are in. */
21952 line_height
= row
->height
;
21954 /* Get the width of the glyphs to insert. */
21955 shift_by_width
= 0;
21956 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21957 shift_by_width
+= glyph
->pixel_width
;
21959 /* Get the width of the region to shift right. */
21960 shifted_region_width
= (window_box_width (w
, updated_area
)
21965 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21966 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21968 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21969 line_height
, shift_by_width
);
21971 /* Write the glyphs. */
21972 hpos
= start
- row
->glyphs
[updated_area
];
21973 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21975 DRAW_NORMAL_TEXT
, 0);
21977 /* Advance the output cursor. */
21978 output_cursor
.hpos
+= len
;
21979 output_cursor
.x
+= shift_by_width
;
21985 Erase the current text line from the nominal cursor position
21986 (inclusive) to pixel column TO_X (exclusive). The idea is that
21987 everything from TO_X onward is already erased.
21989 TO_X is a pixel position relative to updated_area of
21990 updated_window. TO_X == -1 means clear to the end of this area. */
21993 x_clear_end_of_line (to_x
)
21997 struct window
*w
= updated_window
;
21998 int max_x
, min_y
, max_y
;
21999 int from_x
, from_y
, to_y
;
22001 xassert (updated_window
&& updated_row
);
22002 f
= XFRAME (w
->frame
);
22004 if (updated_row
->full_width_p
)
22005 max_x
= WINDOW_TOTAL_WIDTH (w
);
22007 max_x
= window_box_width (w
, updated_area
);
22008 max_y
= window_text_bottom_y (w
);
22010 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22011 of window. For TO_X > 0, truncate to end of drawing area. */
22017 to_x
= min (to_x
, max_x
);
22019 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22021 /* Notice if the cursor will be cleared by this operation. */
22022 if (!updated_row
->full_width_p
)
22023 notice_overwritten_cursor (w
, updated_area
,
22024 output_cursor
.x
, -1,
22026 MATRIX_ROW_BOTTOM_Y (updated_row
));
22028 from_x
= output_cursor
.x
;
22030 /* Translate to frame coordinates. */
22031 if (updated_row
->full_width_p
)
22033 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22034 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22038 int area_left
= window_box_left (w
, updated_area
);
22039 from_x
+= area_left
;
22043 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22044 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22045 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22047 /* Prevent inadvertently clearing to end of the X window. */
22048 if (to_x
> from_x
&& to_y
> from_y
)
22051 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22052 to_x
- from_x
, to_y
- from_y
);
22057 #endif /* HAVE_WINDOW_SYSTEM */
22061 /***********************************************************************
22063 ***********************************************************************/
22065 /* Value is the internal representation of the specified cursor type
22066 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22067 of the bar cursor. */
22069 static enum text_cursor_kinds
22070 get_specified_cursor_type (arg
, width
)
22074 enum text_cursor_kinds type
;
22079 if (EQ (arg
, Qbox
))
22080 return FILLED_BOX_CURSOR
;
22082 if (EQ (arg
, Qhollow
))
22083 return HOLLOW_BOX_CURSOR
;
22085 if (EQ (arg
, Qbar
))
22092 && EQ (XCAR (arg
), Qbar
)
22093 && INTEGERP (XCDR (arg
))
22094 && XINT (XCDR (arg
)) >= 0)
22096 *width
= XINT (XCDR (arg
));
22100 if (EQ (arg
, Qhbar
))
22103 return HBAR_CURSOR
;
22107 && EQ (XCAR (arg
), Qhbar
)
22108 && INTEGERP (XCDR (arg
))
22109 && XINT (XCDR (arg
)) >= 0)
22111 *width
= XINT (XCDR (arg
));
22112 return HBAR_CURSOR
;
22115 /* Treat anything unknown as "hollow box cursor".
22116 It was bad to signal an error; people have trouble fixing
22117 .Xdefaults with Emacs, when it has something bad in it. */
22118 type
= HOLLOW_BOX_CURSOR
;
22123 /* Set the default cursor types for specified frame. */
22125 set_frame_cursor_types (f
, arg
)
22132 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22133 FRAME_CURSOR_WIDTH (f
) = width
;
22135 /* By default, set up the blink-off state depending on the on-state. */
22137 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22140 FRAME_BLINK_OFF_CURSOR (f
)
22141 = get_specified_cursor_type (XCDR (tem
), &width
);
22142 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22145 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22149 /* Return the cursor we want to be displayed in window W. Return
22150 width of bar/hbar cursor through WIDTH arg. Return with
22151 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22152 (i.e. if the `system caret' should track this cursor).
22154 In a mini-buffer window, we want the cursor only to appear if we
22155 are reading input from this window. For the selected window, we
22156 want the cursor type given by the frame parameter or buffer local
22157 setting of cursor-type. If explicitly marked off, draw no cursor.
22158 In all other cases, we want a hollow box cursor. */
22160 static enum text_cursor_kinds
22161 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22163 struct glyph
*glyph
;
22165 int *active_cursor
;
22167 struct frame
*f
= XFRAME (w
->frame
);
22168 struct buffer
*b
= XBUFFER (w
->buffer
);
22169 int cursor_type
= DEFAULT_CURSOR
;
22170 Lisp_Object alt_cursor
;
22171 int non_selected
= 0;
22173 *active_cursor
= 1;
22176 if (cursor_in_echo_area
22177 && FRAME_HAS_MINIBUF_P (f
)
22178 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22180 if (w
== XWINDOW (echo_area_window
))
22182 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22184 *width
= FRAME_CURSOR_WIDTH (f
);
22185 return FRAME_DESIRED_CURSOR (f
);
22188 return get_specified_cursor_type (b
->cursor_type
, width
);
22191 *active_cursor
= 0;
22195 /* Detect a nonselected window or nonselected frame. */
22196 else if (w
!= XWINDOW (f
->selected_window
)
22197 #ifdef HAVE_WINDOW_SYSTEM
22198 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22202 *active_cursor
= 0;
22204 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22210 /* Never display a cursor in a window in which cursor-type is nil. */
22211 if (NILP (b
->cursor_type
))
22214 /* Get the normal cursor type for this window. */
22215 if (EQ (b
->cursor_type
, Qt
))
22217 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22218 *width
= FRAME_CURSOR_WIDTH (f
);
22221 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22223 /* Use cursor-in-non-selected-windows instead
22224 for non-selected window or frame. */
22227 alt_cursor
= b
->cursor_in_non_selected_windows
;
22228 if (!EQ (Qt
, alt_cursor
))
22229 return get_specified_cursor_type (alt_cursor
, width
);
22230 /* t means modify the normal cursor type. */
22231 if (cursor_type
== FILLED_BOX_CURSOR
)
22232 cursor_type
= HOLLOW_BOX_CURSOR
;
22233 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22235 return cursor_type
;
22238 /* Use normal cursor if not blinked off. */
22239 if (!w
->cursor_off_p
)
22241 #ifdef HAVE_WINDOW_SYSTEM
22242 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22244 if (cursor_type
== FILLED_BOX_CURSOR
)
22246 /* Using a block cursor on large images can be very annoying.
22247 So use a hollow cursor for "large" images.
22248 If image is not transparent (no mask), also use hollow cursor. */
22249 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22250 if (img
!= NULL
&& IMAGEP (img
->spec
))
22252 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22253 where N = size of default frame font size.
22254 This should cover most of the "tiny" icons people may use. */
22256 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22257 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22258 cursor_type
= HOLLOW_BOX_CURSOR
;
22261 else if (cursor_type
!= NO_CURSOR
)
22263 /* Display current only supports BOX and HOLLOW cursors for images.
22264 So for now, unconditionally use a HOLLOW cursor when cursor is
22265 not a solid box cursor. */
22266 cursor_type
= HOLLOW_BOX_CURSOR
;
22270 return cursor_type
;
22273 /* Cursor is blinked off, so determine how to "toggle" it. */
22275 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22276 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22277 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22279 /* Then see if frame has specified a specific blink off cursor type. */
22280 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22282 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22283 return FRAME_BLINK_OFF_CURSOR (f
);
22287 /* Some people liked having a permanently visible blinking cursor,
22288 while others had very strong opinions against it. So it was
22289 decided to remove it. KFS 2003-09-03 */
22291 /* Finally perform built-in cursor blinking:
22292 filled box <-> hollow box
22293 wide [h]bar <-> narrow [h]bar
22294 narrow [h]bar <-> no cursor
22295 other type <-> no cursor */
22297 if (cursor_type
== FILLED_BOX_CURSOR
)
22298 return HOLLOW_BOX_CURSOR
;
22300 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22303 return cursor_type
;
22311 #ifdef HAVE_WINDOW_SYSTEM
22313 /* Notice when the text cursor of window W has been completely
22314 overwritten by a drawing operation that outputs glyphs in AREA
22315 starting at X0 and ending at X1 in the line starting at Y0 and
22316 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22317 the rest of the line after X0 has been written. Y coordinates
22318 are window-relative. */
22321 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22323 enum glyph_row_area area
;
22324 int x0
, y0
, x1
, y1
;
22326 int cx0
, cx1
, cy0
, cy1
;
22327 struct glyph_row
*row
;
22329 if (!w
->phys_cursor_on_p
)
22331 if (area
!= TEXT_AREA
)
22334 if (w
->phys_cursor
.vpos
< 0
22335 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22336 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22337 !(row
->enabled_p
&& row
->displays_text_p
)))
22340 if (row
->cursor_in_fringe_p
)
22342 row
->cursor_in_fringe_p
= 0;
22343 draw_fringe_bitmap (w
, row
, 0);
22344 w
->phys_cursor_on_p
= 0;
22348 cx0
= w
->phys_cursor
.x
;
22349 cx1
= cx0
+ w
->phys_cursor_width
;
22350 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22353 /* The cursor image will be completely removed from the
22354 screen if the output area intersects the cursor area in
22355 y-direction. When we draw in [y0 y1[, and some part of
22356 the cursor is at y < y0, that part must have been drawn
22357 before. When scrolling, the cursor is erased before
22358 actually scrolling, so we don't come here. When not
22359 scrolling, the rows above the old cursor row must have
22360 changed, and in this case these rows must have written
22361 over the cursor image.
22363 Likewise if part of the cursor is below y1, with the
22364 exception of the cursor being in the first blank row at
22365 the buffer and window end because update_text_area
22366 doesn't draw that row. (Except when it does, but
22367 that's handled in update_text_area.) */
22369 cy0
= w
->phys_cursor
.y
;
22370 cy1
= cy0
+ w
->phys_cursor_height
;
22371 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22374 w
->phys_cursor_on_p
= 0;
22377 #endif /* HAVE_WINDOW_SYSTEM */
22380 /************************************************************************
22382 ************************************************************************/
22384 #ifdef HAVE_WINDOW_SYSTEM
22387 Fix the display of area AREA of overlapping row ROW in window W
22388 with respect to the overlapping part OVERLAPS. */
22391 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22393 struct glyph_row
*row
;
22394 enum glyph_row_area area
;
22402 for (i
= 0; i
< row
->used
[area
];)
22404 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22406 int start
= i
, start_x
= x
;
22410 x
+= row
->glyphs
[area
][i
].pixel_width
;
22413 while (i
< row
->used
[area
]
22414 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22416 draw_glyphs (w
, start_x
, row
, area
,
22418 DRAW_NORMAL_TEXT
, overlaps
);
22422 x
+= row
->glyphs
[area
][i
].pixel_width
;
22432 Draw the cursor glyph of window W in glyph row ROW. See the
22433 comment of draw_glyphs for the meaning of HL. */
22436 draw_phys_cursor_glyph (w
, row
, hl
)
22438 struct glyph_row
*row
;
22439 enum draw_glyphs_face hl
;
22441 /* If cursor hpos is out of bounds, don't draw garbage. This can
22442 happen in mini-buffer windows when switching between echo area
22443 glyphs and mini-buffer. */
22444 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22446 int on_p
= w
->phys_cursor_on_p
;
22448 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22449 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22451 w
->phys_cursor_on_p
= on_p
;
22453 if (hl
== DRAW_CURSOR
)
22454 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22455 /* When we erase the cursor, and ROW is overlapped by other
22456 rows, make sure that these overlapping parts of other rows
22458 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22460 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22462 if (row
> w
->current_matrix
->rows
22463 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22464 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22465 OVERLAPS_ERASED_CURSOR
);
22467 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22468 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22469 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22470 OVERLAPS_ERASED_CURSOR
);
22477 Erase the image of a cursor of window W from the screen. */
22480 erase_phys_cursor (w
)
22483 struct frame
*f
= XFRAME (w
->frame
);
22484 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22485 int hpos
= w
->phys_cursor
.hpos
;
22486 int vpos
= w
->phys_cursor
.vpos
;
22487 int mouse_face_here_p
= 0;
22488 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22489 struct glyph_row
*cursor_row
;
22490 struct glyph
*cursor_glyph
;
22491 enum draw_glyphs_face hl
;
22493 /* No cursor displayed or row invalidated => nothing to do on the
22495 if (w
->phys_cursor_type
== NO_CURSOR
)
22496 goto mark_cursor_off
;
22498 /* VPOS >= active_glyphs->nrows means that window has been resized.
22499 Don't bother to erase the cursor. */
22500 if (vpos
>= active_glyphs
->nrows
)
22501 goto mark_cursor_off
;
22503 /* If row containing cursor is marked invalid, there is nothing we
22505 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22506 if (!cursor_row
->enabled_p
)
22507 goto mark_cursor_off
;
22509 /* If line spacing is > 0, old cursor may only be partially visible in
22510 window after split-window. So adjust visible height. */
22511 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22512 window_text_bottom_y (w
) - cursor_row
->y
);
22514 /* If row is completely invisible, don't attempt to delete a cursor which
22515 isn't there. This can happen if cursor is at top of a window, and
22516 we switch to a buffer with a header line in that window. */
22517 if (cursor_row
->visible_height
<= 0)
22518 goto mark_cursor_off
;
22520 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22521 if (cursor_row
->cursor_in_fringe_p
)
22523 cursor_row
->cursor_in_fringe_p
= 0;
22524 draw_fringe_bitmap (w
, cursor_row
, 0);
22525 goto mark_cursor_off
;
22528 /* This can happen when the new row is shorter than the old one.
22529 In this case, either draw_glyphs or clear_end_of_line
22530 should have cleared the cursor. Note that we wouldn't be
22531 able to erase the cursor in this case because we don't have a
22532 cursor glyph at hand. */
22533 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22534 goto mark_cursor_off
;
22536 /* If the cursor is in the mouse face area, redisplay that when
22537 we clear the cursor. */
22538 if (! NILP (dpyinfo
->mouse_face_window
)
22539 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22540 && (vpos
> dpyinfo
->mouse_face_beg_row
22541 || (vpos
== dpyinfo
->mouse_face_beg_row
22542 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22543 && (vpos
< dpyinfo
->mouse_face_end_row
22544 || (vpos
== dpyinfo
->mouse_face_end_row
22545 && hpos
< dpyinfo
->mouse_face_end_col
))
22546 /* Don't redraw the cursor's spot in mouse face if it is at the
22547 end of a line (on a newline). The cursor appears there, but
22548 mouse highlighting does not. */
22549 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22550 mouse_face_here_p
= 1;
22552 /* Maybe clear the display under the cursor. */
22553 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22556 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22559 cursor_glyph
= get_phys_cursor_glyph (w
);
22560 if (cursor_glyph
== NULL
)
22561 goto mark_cursor_off
;
22563 width
= cursor_glyph
->pixel_width
;
22564 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22565 x
= w
->phys_cursor
.x
;
22567 width
-= left_x
- x
;
22568 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22569 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22570 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22573 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22576 /* Erase the cursor by redrawing the character underneath it. */
22577 if (mouse_face_here_p
)
22578 hl
= DRAW_MOUSE_FACE
;
22580 hl
= DRAW_NORMAL_TEXT
;
22581 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22584 w
->phys_cursor_on_p
= 0;
22585 w
->phys_cursor_type
= NO_CURSOR
;
22590 Display or clear cursor of window W. If ON is zero, clear the
22591 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22592 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22595 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22597 int on
, hpos
, vpos
, x
, y
;
22599 struct frame
*f
= XFRAME (w
->frame
);
22600 int new_cursor_type
;
22601 int new_cursor_width
;
22603 struct glyph_row
*glyph_row
;
22604 struct glyph
*glyph
;
22606 /* This is pointless on invisible frames, and dangerous on garbaged
22607 windows and frames; in the latter case, the frame or window may
22608 be in the midst of changing its size, and x and y may be off the
22610 if (! FRAME_VISIBLE_P (f
)
22611 || FRAME_GARBAGED_P (f
)
22612 || vpos
>= w
->current_matrix
->nrows
22613 || hpos
>= w
->current_matrix
->matrix_w
)
22616 /* If cursor is off and we want it off, return quickly. */
22617 if (!on
&& !w
->phys_cursor_on_p
)
22620 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22621 /* If cursor row is not enabled, we don't really know where to
22622 display the cursor. */
22623 if (!glyph_row
->enabled_p
)
22625 w
->phys_cursor_on_p
= 0;
22630 if (!glyph_row
->exact_window_width_line_p
22631 || hpos
< glyph_row
->used
[TEXT_AREA
])
22632 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22634 xassert (interrupt_input_blocked
);
22636 /* Set new_cursor_type to the cursor we want to be displayed. */
22637 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22638 &new_cursor_width
, &active_cursor
);
22640 /* If cursor is currently being shown and we don't want it to be or
22641 it is in the wrong place, or the cursor type is not what we want,
22643 if (w
->phys_cursor_on_p
22645 || w
->phys_cursor
.x
!= x
22646 || w
->phys_cursor
.y
!= y
22647 || new_cursor_type
!= w
->phys_cursor_type
22648 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22649 && new_cursor_width
!= w
->phys_cursor_width
)))
22650 erase_phys_cursor (w
);
22652 /* Don't check phys_cursor_on_p here because that flag is only set
22653 to zero in some cases where we know that the cursor has been
22654 completely erased, to avoid the extra work of erasing the cursor
22655 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22656 still not be visible, or it has only been partly erased. */
22659 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22660 w
->phys_cursor_height
= glyph_row
->height
;
22662 /* Set phys_cursor_.* before x_draw_.* is called because some
22663 of them may need the information. */
22664 w
->phys_cursor
.x
= x
;
22665 w
->phys_cursor
.y
= glyph_row
->y
;
22666 w
->phys_cursor
.hpos
= hpos
;
22667 w
->phys_cursor
.vpos
= vpos
;
22670 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22671 new_cursor_type
, new_cursor_width
,
22672 on
, active_cursor
);
22676 /* Switch the display of W's cursor on or off, according to the value
22683 update_window_cursor (w
, on
)
22687 /* Don't update cursor in windows whose frame is in the process
22688 of being deleted. */
22689 if (w
->current_matrix
)
22692 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22693 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22699 /* Call update_window_cursor with parameter ON_P on all leaf windows
22700 in the window tree rooted at W. */
22703 update_cursor_in_window_tree (w
, on_p
)
22709 if (!NILP (w
->hchild
))
22710 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22711 else if (!NILP (w
->vchild
))
22712 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22714 update_window_cursor (w
, on_p
);
22716 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22722 Display the cursor on window W, or clear it, according to ON_P.
22723 Don't change the cursor's position. */
22726 x_update_cursor (f
, on_p
)
22730 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22735 Clear the cursor of window W to background color, and mark the
22736 cursor as not shown. This is used when the text where the cursor
22737 is is about to be rewritten. */
22743 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22744 update_window_cursor (w
, 0);
22749 Display the active region described by mouse_face_* according to DRAW. */
22752 show_mouse_face (dpyinfo
, draw
)
22753 Display_Info
*dpyinfo
;
22754 enum draw_glyphs_face draw
;
22756 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22757 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22759 if (/* If window is in the process of being destroyed, don't bother
22761 w
->current_matrix
!= NULL
22762 /* Don't update mouse highlight if hidden */
22763 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22764 /* Recognize when we are called to operate on rows that don't exist
22765 anymore. This can happen when a window is split. */
22766 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22768 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22769 struct glyph_row
*row
, *first
, *last
;
22771 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22772 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22774 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22776 int start_hpos
, end_hpos
, start_x
;
22778 /* For all but the first row, the highlight starts at column 0. */
22781 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22782 start_x
= dpyinfo
->mouse_face_beg_x
;
22791 end_hpos
= dpyinfo
->mouse_face_end_col
;
22794 end_hpos
= row
->used
[TEXT_AREA
];
22795 if (draw
== DRAW_NORMAL_TEXT
)
22796 row
->fill_line_p
= 1; /* Clear to end of line */
22799 if (end_hpos
> start_hpos
)
22801 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22802 start_hpos
, end_hpos
,
22806 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22810 /* When we've written over the cursor, arrange for it to
22811 be displayed again. */
22812 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22815 display_and_set_cursor (w
, 1,
22816 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22817 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22822 /* Change the mouse cursor. */
22823 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22824 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22825 else if (draw
== DRAW_MOUSE_FACE
)
22826 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22828 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22832 Clear out the mouse-highlighted active region.
22833 Redraw it un-highlighted first. Value is non-zero if mouse
22834 face was actually drawn unhighlighted. */
22837 clear_mouse_face (dpyinfo
)
22838 Display_Info
*dpyinfo
;
22842 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22844 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22848 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22849 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22850 dpyinfo
->mouse_face_window
= Qnil
;
22851 dpyinfo
->mouse_face_overlay
= Qnil
;
22857 Non-zero if physical cursor of window W is within mouse face. */
22860 cursor_in_mouse_face_p (w
)
22863 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22864 int in_mouse_face
= 0;
22866 if (WINDOWP (dpyinfo
->mouse_face_window
)
22867 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22869 int hpos
= w
->phys_cursor
.hpos
;
22870 int vpos
= w
->phys_cursor
.vpos
;
22872 if (vpos
>= dpyinfo
->mouse_face_beg_row
22873 && vpos
<= dpyinfo
->mouse_face_end_row
22874 && (vpos
> dpyinfo
->mouse_face_beg_row
22875 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22876 && (vpos
< dpyinfo
->mouse_face_end_row
22877 || hpos
< dpyinfo
->mouse_face_end_col
22878 || dpyinfo
->mouse_face_past_end
))
22882 return in_mouse_face
;
22888 /* Find the glyph matrix position of buffer position CHARPOS in window
22889 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22890 current glyphs must be up to date. If CHARPOS is above window
22891 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22892 of last line in W. In the row containing CHARPOS, stop before glyphs
22893 having STOP as object. */
22895 #if 1 /* This is a version of fast_find_position that's more correct
22896 in the presence of hscrolling, for example. I didn't install
22897 it right away because the problem fixed is minor, it failed
22898 in 20.x as well, and I think it's too risky to install
22899 so near the release of 21.1. 2001-09-25 gerd. */
22903 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22906 int *hpos
, *vpos
, *x
, *y
;
22909 struct glyph_row
*row
, *first
;
22910 struct glyph
*glyph
, *end
;
22913 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22914 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22919 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22923 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22926 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22930 /* If whole rows or last part of a row came from a display overlay,
22931 row_containing_pos will skip over such rows because their end pos
22932 equals the start pos of the overlay or interval.
22934 Move back if we have a STOP object and previous row's
22935 end glyph came from STOP. */
22938 struct glyph_row
*prev
;
22939 while ((prev
= row
- 1, prev
>= first
)
22940 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22941 && prev
->used
[TEXT_AREA
] > 0)
22943 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22944 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22945 while (--glyph
>= beg
22946 && INTEGERP (glyph
->object
));
22948 || !EQ (stop
, glyph
->object
))
22956 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22958 glyph
= row
->glyphs
[TEXT_AREA
];
22959 end
= glyph
+ row
->used
[TEXT_AREA
];
22961 /* Skip over glyphs not having an object at the start of the row.
22962 These are special glyphs like truncation marks on terminal
22964 if (row
->displays_text_p
)
22966 && INTEGERP (glyph
->object
)
22967 && !EQ (stop
, glyph
->object
)
22968 && glyph
->charpos
< 0)
22970 *x
+= glyph
->pixel_width
;
22975 && !INTEGERP (glyph
->object
)
22976 && !EQ (stop
, glyph
->object
)
22977 && (!BUFFERP (glyph
->object
)
22978 || glyph
->charpos
< charpos
))
22980 *x
+= glyph
->pixel_width
;
22984 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22991 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22994 int *hpos
, *vpos
, *x
, *y
;
22999 int maybe_next_line_p
= 0;
23000 int line_start_position
;
23001 int yb
= window_text_bottom_y (w
);
23002 struct glyph_row
*row
, *best_row
;
23003 int row_vpos
, best_row_vpos
;
23006 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23007 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23009 while (row
->y
< yb
)
23011 if (row
->used
[TEXT_AREA
])
23012 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
23014 line_start_position
= 0;
23016 if (line_start_position
> pos
)
23018 /* If the position sought is the end of the buffer,
23019 don't include the blank lines at the bottom of the window. */
23020 else if (line_start_position
== pos
23021 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
23023 maybe_next_line_p
= 1;
23026 else if (line_start_position
> 0)
23029 best_row_vpos
= row_vpos
;
23032 if (row
->y
+ row
->height
>= yb
)
23039 /* Find the right column within BEST_ROW. */
23041 current_x
= best_row
->x
;
23042 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
23044 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
23045 int charpos
= glyph
->charpos
;
23047 if (BUFFERP (glyph
->object
))
23049 if (charpos
== pos
)
23052 *vpos
= best_row_vpos
;
23057 else if (charpos
> pos
)
23060 else if (EQ (glyph
->object
, stop
))
23065 current_x
+= glyph
->pixel_width
;
23068 /* If we're looking for the end of the buffer,
23069 and we didn't find it in the line we scanned,
23070 use the start of the following line. */
23071 if (maybe_next_line_p
)
23076 current_x
= best_row
->x
;
23079 *vpos
= best_row_vpos
;
23080 *hpos
= lastcol
+ 1;
23089 /* Find the position of the glyph for position POS in OBJECT in
23090 window W's current matrix, and return in *X, *Y the pixel
23091 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23093 RIGHT_P non-zero means return the position of the right edge of the
23094 glyph, RIGHT_P zero means return the left edge position.
23096 If no glyph for POS exists in the matrix, return the position of
23097 the glyph with the next smaller position that is in the matrix, if
23098 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23099 exists in the matrix, return the position of the glyph with the
23100 next larger position in OBJECT.
23102 Value is non-zero if a glyph was found. */
23105 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23108 Lisp_Object object
;
23109 int *hpos
, *vpos
, *x
, *y
;
23112 int yb
= window_text_bottom_y (w
);
23113 struct glyph_row
*r
;
23114 struct glyph
*best_glyph
= NULL
;
23115 struct glyph_row
*best_row
= NULL
;
23118 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23119 r
->enabled_p
&& r
->y
< yb
;
23122 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23123 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23126 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23127 if (EQ (g
->object
, object
))
23129 if (g
->charpos
== pos
)
23136 else if (best_glyph
== NULL
23137 || ((eabs (g
->charpos
- pos
)
23138 < eabs (best_glyph
->charpos
- pos
))
23141 : g
->charpos
> pos
)))
23155 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23159 *x
+= best_glyph
->pixel_width
;
23164 *vpos
= best_row
- w
->current_matrix
->rows
;
23167 return best_glyph
!= NULL
;
23171 /* See if position X, Y is within a hot-spot of an image. */
23174 on_hot_spot_p (hot_spot
, x
, y
)
23175 Lisp_Object hot_spot
;
23178 if (!CONSP (hot_spot
))
23181 if (EQ (XCAR (hot_spot
), Qrect
))
23183 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23184 Lisp_Object rect
= XCDR (hot_spot
);
23188 if (!CONSP (XCAR (rect
)))
23190 if (!CONSP (XCDR (rect
)))
23192 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23194 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23196 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23198 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23202 else if (EQ (XCAR (hot_spot
), Qcircle
))
23204 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23205 Lisp_Object circ
= XCDR (hot_spot
);
23206 Lisp_Object lr
, lx0
, ly0
;
23208 && CONSP (XCAR (circ
))
23209 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23210 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23211 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23213 double r
= XFLOATINT (lr
);
23214 double dx
= XINT (lx0
) - x
;
23215 double dy
= XINT (ly0
) - y
;
23216 return (dx
* dx
+ dy
* dy
<= r
* r
);
23219 else if (EQ (XCAR (hot_spot
), Qpoly
))
23221 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23222 if (VECTORP (XCDR (hot_spot
)))
23224 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23225 Lisp_Object
*poly
= v
->contents
;
23229 Lisp_Object lx
, ly
;
23232 /* Need an even number of coordinates, and at least 3 edges. */
23233 if (n
< 6 || n
& 1)
23236 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23237 If count is odd, we are inside polygon. Pixels on edges
23238 may or may not be included depending on actual geometry of the
23240 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23241 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23243 x0
= XINT (lx
), y0
= XINT (ly
);
23244 for (i
= 0; i
< n
; i
+= 2)
23246 int x1
= x0
, y1
= y0
;
23247 if ((lx
= poly
[i
], !INTEGERP (lx
))
23248 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23250 x0
= XINT (lx
), y0
= XINT (ly
);
23252 /* Does this segment cross the X line? */
23260 if (y
> y0
&& y
> y1
)
23262 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23272 find_hot_spot (map
, x
, y
)
23276 while (CONSP (map
))
23278 if (CONSP (XCAR (map
))
23279 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23287 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23289 doc
: /* Lookup in image map MAP coordinates X and Y.
23290 An image map is an alist where each element has the format (AREA ID PLIST).
23291 An AREA is specified as either a rectangle, a circle, or a polygon:
23292 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23293 pixel coordinates of the upper left and bottom right corners.
23294 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23295 and the radius of the circle; r may be a float or integer.
23296 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23297 vector describes one corner in the polygon.
23298 Returns the alist element for the first matching AREA in MAP. */)
23309 return find_hot_spot (map
, XINT (x
), XINT (y
));
23313 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23315 define_frame_cursor1 (f
, cursor
, pointer
)
23318 Lisp_Object pointer
;
23320 /* Do not change cursor shape while dragging mouse. */
23321 if (!NILP (do_mouse_tracking
))
23324 if (!NILP (pointer
))
23326 if (EQ (pointer
, Qarrow
))
23327 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23328 else if (EQ (pointer
, Qhand
))
23329 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23330 else if (EQ (pointer
, Qtext
))
23331 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23332 else if (EQ (pointer
, intern ("hdrag")))
23333 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23334 #ifdef HAVE_X_WINDOWS
23335 else if (EQ (pointer
, intern ("vdrag")))
23336 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23338 else if (EQ (pointer
, intern ("hourglass")))
23339 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23340 else if (EQ (pointer
, Qmodeline
))
23341 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23343 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23346 if (cursor
!= No_Cursor
)
23347 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23350 /* Take proper action when mouse has moved to the mode or header line
23351 or marginal area AREA of window W, x-position X and y-position Y.
23352 X is relative to the start of the text display area of W, so the
23353 width of bitmap areas and scroll bars must be subtracted to get a
23354 position relative to the start of the mode line. */
23357 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23358 Lisp_Object window
;
23360 enum window_part area
;
23362 struct window
*w
= XWINDOW (window
);
23363 struct frame
*f
= XFRAME (w
->frame
);
23364 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23365 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23366 Lisp_Object pointer
= Qnil
;
23367 int charpos
, dx
, dy
, width
, height
;
23368 Lisp_Object string
, object
= Qnil
;
23369 Lisp_Object pos
, help
;
23371 Lisp_Object mouse_face
;
23372 int original_x_pixel
= x
;
23373 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23374 struct glyph_row
*row
;
23376 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23381 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23382 &object
, &dx
, &dy
, &width
, &height
);
23384 row
= (area
== ON_MODE_LINE
23385 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23386 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23389 if (row
->mode_line_p
&& row
->enabled_p
)
23391 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23392 end
= glyph
+ row
->used
[TEXT_AREA
];
23394 for (x0
= original_x_pixel
;
23395 glyph
< end
&& x0
>= glyph
->pixel_width
;
23397 x0
-= glyph
->pixel_width
;
23405 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23406 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23407 &object
, &dx
, &dy
, &width
, &height
);
23412 if (IMAGEP (object
))
23414 Lisp_Object image_map
, hotspot
;
23415 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23417 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23419 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23421 Lisp_Object area_id
, plist
;
23423 area_id
= XCAR (hotspot
);
23424 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23425 If so, we could look for mouse-enter, mouse-leave
23426 properties in PLIST (and do something...). */
23427 hotspot
= XCDR (hotspot
);
23428 if (CONSP (hotspot
)
23429 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23431 pointer
= Fplist_get (plist
, Qpointer
);
23432 if (NILP (pointer
))
23434 help
= Fplist_get (plist
, Qhelp_echo
);
23437 help_echo_string
= help
;
23438 /* Is this correct? ++kfs */
23439 XSETWINDOW (help_echo_window
, w
);
23440 help_echo_object
= w
->buffer
;
23441 help_echo_pos
= charpos
;
23445 if (NILP (pointer
))
23446 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23449 if (STRINGP (string
))
23451 pos
= make_number (charpos
);
23452 /* If we're on a string with `help-echo' text property, arrange
23453 for the help to be displayed. This is done by setting the
23454 global variable help_echo_string to the help string. */
23457 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23460 help_echo_string
= help
;
23461 XSETWINDOW (help_echo_window
, w
);
23462 help_echo_object
= string
;
23463 help_echo_pos
= charpos
;
23467 if (NILP (pointer
))
23468 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23470 /* Change the mouse pointer according to what is under X/Y. */
23471 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23474 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23475 if (!KEYMAPP (map
))
23476 map
= Fget_text_property (pos
, Qkeymap
, string
);
23477 if (!KEYMAPP (map
))
23478 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23481 /* Change the mouse face according to what is under X/Y. */
23482 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23483 if (!NILP (mouse_face
)
23484 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23489 struct glyph
* tmp_glyph
;
23493 int total_pixel_width
;
23498 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23499 Qmouse_face
, string
, Qnil
);
23501 b
= make_number (0);
23503 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23505 e
= make_number (SCHARS (string
));
23507 /* Calculate the position(glyph position: GPOS) of GLYPH in
23508 displayed string. GPOS is different from CHARPOS.
23510 CHARPOS is the position of glyph in internal string
23511 object. A mode line string format has structures which
23512 is converted to a flatten by emacs lisp interpreter.
23513 The internal string is an element of the structures.
23514 The displayed string is the flatten string. */
23516 if (glyph
> row_start_glyph
)
23518 tmp_glyph
= glyph
- 1;
23519 while (tmp_glyph
>= row_start_glyph
23520 && tmp_glyph
->charpos
>= XINT (b
)
23521 && EQ (tmp_glyph
->object
, glyph
->object
))
23528 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23529 displayed string holding GLYPH.
23531 GSEQ_LENGTH is different from SCHARS (STRING).
23532 SCHARS (STRING) returns the length of the internal string. */
23533 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23534 tmp_glyph
->charpos
< XINT (e
);
23535 tmp_glyph
++, gseq_length
++)
23537 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23541 total_pixel_width
= 0;
23542 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23543 total_pixel_width
+= tmp_glyph
->pixel_width
;
23545 /* Pre calculation of re-rendering position */
23547 hpos
= (area
== ON_MODE_LINE
23548 ? (w
->current_matrix
)->nrows
- 1
23551 /* If the re-rendering position is included in the last
23552 re-rendering area, we should do nothing. */
23553 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23554 && dpyinfo
->mouse_face_beg_col
<= vpos
23555 && vpos
< dpyinfo
->mouse_face_end_col
23556 && dpyinfo
->mouse_face_beg_row
== hpos
)
23559 if (clear_mouse_face (dpyinfo
))
23560 cursor
= No_Cursor
;
23562 dpyinfo
->mouse_face_beg_col
= vpos
;
23563 dpyinfo
->mouse_face_beg_row
= hpos
;
23565 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23566 dpyinfo
->mouse_face_beg_y
= 0;
23568 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23569 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23571 dpyinfo
->mouse_face_end_x
= 0;
23572 dpyinfo
->mouse_face_end_y
= 0;
23574 dpyinfo
->mouse_face_past_end
= 0;
23575 dpyinfo
->mouse_face_window
= window
;
23577 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23580 glyph
->face_id
, 1);
23581 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23583 if (NILP (pointer
))
23586 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23587 clear_mouse_face (dpyinfo
);
23589 define_frame_cursor1 (f
, cursor
, pointer
);
23594 Take proper action when the mouse has moved to position X, Y on
23595 frame F as regards highlighting characters that have mouse-face
23596 properties. Also de-highlighting chars where the mouse was before.
23597 X and Y can be negative or out of range. */
23600 note_mouse_highlight (f
, x
, y
)
23604 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23605 enum window_part part
;
23606 Lisp_Object window
;
23608 Cursor cursor
= No_Cursor
;
23609 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23612 /* When a menu is active, don't highlight because this looks odd. */
23613 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
23614 if (popup_activated ())
23618 if (NILP (Vmouse_highlight
)
23619 || !f
->glyphs_initialized_p
)
23622 dpyinfo
->mouse_face_mouse_x
= x
;
23623 dpyinfo
->mouse_face_mouse_y
= y
;
23624 dpyinfo
->mouse_face_mouse_frame
= f
;
23626 if (dpyinfo
->mouse_face_defer
)
23629 if (gc_in_progress
)
23631 dpyinfo
->mouse_face_deferred_gc
= 1;
23635 /* Which window is that in? */
23636 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23638 /* If we were displaying active text in another window, clear that.
23639 Also clear if we move out of text area in same window. */
23640 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23641 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23642 && !NILP (dpyinfo
->mouse_face_window
)))
23643 clear_mouse_face (dpyinfo
);
23645 /* Not on a window -> return. */
23646 if (!WINDOWP (window
))
23649 /* Reset help_echo_string. It will get recomputed below. */
23650 help_echo_string
= Qnil
;
23652 /* Convert to window-relative pixel coordinates. */
23653 w
= XWINDOW (window
);
23654 frame_to_window_pixel_xy (w
, &x
, &y
);
23656 /* Handle tool-bar window differently since it doesn't display a
23658 if (EQ (window
, f
->tool_bar_window
))
23660 note_tool_bar_highlight (f
, x
, y
);
23664 /* Mouse is on the mode, header line or margin? */
23665 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23666 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23668 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23672 if (part
== ON_VERTICAL_BORDER
)
23674 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23675 help_echo_string
= build_string ("drag-mouse-1: resize");
23677 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23678 || part
== ON_SCROLL_BAR
)
23679 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23681 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23683 /* Are we in a window whose display is up to date?
23684 And verify the buffer's text has not changed. */
23685 b
= XBUFFER (w
->buffer
);
23686 if (part
== ON_TEXT
23687 && EQ (w
->window_end_valid
, w
->buffer
)
23688 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23689 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23691 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23692 struct glyph
*glyph
;
23693 Lisp_Object object
;
23694 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23695 Lisp_Object
*overlay_vec
= NULL
;
23697 struct buffer
*obuf
;
23698 int obegv
, ozv
, same_region
;
23700 /* Find the glyph under X/Y. */
23701 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23703 /* Look for :pointer property on image. */
23704 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23706 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23707 if (img
!= NULL
&& IMAGEP (img
->spec
))
23709 Lisp_Object image_map
, hotspot
;
23710 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23712 && (hotspot
= find_hot_spot (image_map
,
23713 glyph
->slice
.x
+ dx
,
23714 glyph
->slice
.y
+ dy
),
23716 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23718 Lisp_Object area_id
, plist
;
23720 area_id
= XCAR (hotspot
);
23721 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23722 If so, we could look for mouse-enter, mouse-leave
23723 properties in PLIST (and do something...). */
23724 hotspot
= XCDR (hotspot
);
23725 if (CONSP (hotspot
)
23726 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23728 pointer
= Fplist_get (plist
, Qpointer
);
23729 if (NILP (pointer
))
23731 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23732 if (!NILP (help_echo_string
))
23734 help_echo_window
= window
;
23735 help_echo_object
= glyph
->object
;
23736 help_echo_pos
= glyph
->charpos
;
23740 if (NILP (pointer
))
23741 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23745 /* Clear mouse face if X/Y not over text. */
23747 || area
!= TEXT_AREA
23748 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23750 if (clear_mouse_face (dpyinfo
))
23751 cursor
= No_Cursor
;
23752 if (NILP (pointer
))
23754 if (area
!= TEXT_AREA
)
23755 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23757 pointer
= Vvoid_text_area_pointer
;
23762 pos
= glyph
->charpos
;
23763 object
= glyph
->object
;
23764 if (!STRINGP (object
) && !BUFFERP (object
))
23767 /* If we get an out-of-range value, return now; avoid an error. */
23768 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23771 /* Make the window's buffer temporarily current for
23772 overlays_at and compute_char_face. */
23773 obuf
= current_buffer
;
23774 current_buffer
= b
;
23780 /* Is this char mouse-active or does it have help-echo? */
23781 position
= make_number (pos
);
23783 if (BUFFERP (object
))
23785 /* Put all the overlays we want in a vector in overlay_vec. */
23786 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23787 /* Sort overlays into increasing priority order. */
23788 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23793 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23794 && vpos
>= dpyinfo
->mouse_face_beg_row
23795 && vpos
<= dpyinfo
->mouse_face_end_row
23796 && (vpos
> dpyinfo
->mouse_face_beg_row
23797 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23798 && (vpos
< dpyinfo
->mouse_face_end_row
23799 || hpos
< dpyinfo
->mouse_face_end_col
23800 || dpyinfo
->mouse_face_past_end
));
23803 cursor
= No_Cursor
;
23805 /* Check mouse-face highlighting. */
23807 /* If there exists an overlay with mouse-face overlapping
23808 the one we are currently highlighting, we have to
23809 check if we enter the overlapping overlay, and then
23810 highlight only that. */
23811 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23812 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23814 /* Find the highest priority overlay that has a mouse-face
23817 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23819 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23820 if (!NILP (mouse_face
))
23821 overlay
= overlay_vec
[i
];
23824 /* If we're actually highlighting the same overlay as
23825 before, there's no need to do that again. */
23826 if (!NILP (overlay
)
23827 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23828 goto check_help_echo
;
23830 dpyinfo
->mouse_face_overlay
= overlay
;
23832 /* Clear the display of the old active region, if any. */
23833 if (clear_mouse_face (dpyinfo
))
23834 cursor
= No_Cursor
;
23836 /* If no overlay applies, get a text property. */
23837 if (NILP (overlay
))
23838 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23840 /* Handle the overlay case. */
23841 if (!NILP (overlay
))
23843 /* Find the range of text around this char that
23844 should be active. */
23845 Lisp_Object before
, after
;
23848 before
= Foverlay_start (overlay
);
23849 after
= Foverlay_end (overlay
);
23850 /* Record this as the current active region. */
23851 fast_find_position (w
, XFASTINT (before
),
23852 &dpyinfo
->mouse_face_beg_col
,
23853 &dpyinfo
->mouse_face_beg_row
,
23854 &dpyinfo
->mouse_face_beg_x
,
23855 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23857 dpyinfo
->mouse_face_past_end
23858 = !fast_find_position (w
, XFASTINT (after
),
23859 &dpyinfo
->mouse_face_end_col
,
23860 &dpyinfo
->mouse_face_end_row
,
23861 &dpyinfo
->mouse_face_end_x
,
23862 &dpyinfo
->mouse_face_end_y
, Qnil
);
23863 dpyinfo
->mouse_face_window
= window
;
23865 dpyinfo
->mouse_face_face_id
23866 = face_at_buffer_position (w
, pos
, 0, 0,
23868 !dpyinfo
->mouse_face_hidden
);
23870 /* Display it as active. */
23871 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23872 cursor
= No_Cursor
;
23874 /* Handle the text property case. */
23875 else if (!NILP (mouse_face
) && BUFFERP (object
))
23877 /* Find the range of text around this char that
23878 should be active. */
23879 Lisp_Object before
, after
, beginning
, end
;
23882 beginning
= Fmarker_position (w
->start
);
23883 end
= make_number (BUF_Z (XBUFFER (object
))
23884 - XFASTINT (w
->window_end_pos
));
23886 = Fprevious_single_property_change (make_number (pos
+ 1),
23888 object
, beginning
);
23890 = Fnext_single_property_change (position
, Qmouse_face
,
23893 /* Record this as the current active region. */
23894 fast_find_position (w
, XFASTINT (before
),
23895 &dpyinfo
->mouse_face_beg_col
,
23896 &dpyinfo
->mouse_face_beg_row
,
23897 &dpyinfo
->mouse_face_beg_x
,
23898 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23899 dpyinfo
->mouse_face_past_end
23900 = !fast_find_position (w
, XFASTINT (after
),
23901 &dpyinfo
->mouse_face_end_col
,
23902 &dpyinfo
->mouse_face_end_row
,
23903 &dpyinfo
->mouse_face_end_x
,
23904 &dpyinfo
->mouse_face_end_y
, Qnil
);
23905 dpyinfo
->mouse_face_window
= window
;
23907 if (BUFFERP (object
))
23908 dpyinfo
->mouse_face_face_id
23909 = face_at_buffer_position (w
, pos
, 0, 0,
23911 !dpyinfo
->mouse_face_hidden
);
23913 /* Display it as active. */
23914 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23915 cursor
= No_Cursor
;
23917 else if (!NILP (mouse_face
) && STRINGP (object
))
23922 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23925 e
= Fnext_single_property_change (position
, Qmouse_face
,
23928 b
= make_number (0);
23930 e
= make_number (SCHARS (object
) - 1);
23932 fast_find_string_pos (w
, XINT (b
), object
,
23933 &dpyinfo
->mouse_face_beg_col
,
23934 &dpyinfo
->mouse_face_beg_row
,
23935 &dpyinfo
->mouse_face_beg_x
,
23936 &dpyinfo
->mouse_face_beg_y
, 0);
23937 fast_find_string_pos (w
, XINT (e
), object
,
23938 &dpyinfo
->mouse_face_end_col
,
23939 &dpyinfo
->mouse_face_end_row
,
23940 &dpyinfo
->mouse_face_end_x
,
23941 &dpyinfo
->mouse_face_end_y
, 1);
23942 dpyinfo
->mouse_face_past_end
= 0;
23943 dpyinfo
->mouse_face_window
= window
;
23944 dpyinfo
->mouse_face_face_id
23945 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23946 glyph
->face_id
, 1);
23947 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23948 cursor
= No_Cursor
;
23950 else if (STRINGP (object
) && NILP (mouse_face
))
23952 /* A string which doesn't have mouse-face, but
23953 the text ``under'' it might have. */
23954 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23955 int start
= MATRIX_ROW_START_CHARPOS (r
);
23957 pos
= string_buffer_position (w
, object
, start
);
23959 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23963 if (!NILP (mouse_face
) && !NILP (overlay
))
23965 Lisp_Object before
= Foverlay_start (overlay
);
23966 Lisp_Object after
= Foverlay_end (overlay
);
23969 /* Note that we might not be able to find position
23970 BEFORE in the glyph matrix if the overlay is
23971 entirely covered by a `display' property. In
23972 this case, we overshoot. So let's stop in
23973 the glyph matrix before glyphs for OBJECT. */
23974 fast_find_position (w
, XFASTINT (before
),
23975 &dpyinfo
->mouse_face_beg_col
,
23976 &dpyinfo
->mouse_face_beg_row
,
23977 &dpyinfo
->mouse_face_beg_x
,
23978 &dpyinfo
->mouse_face_beg_y
,
23981 dpyinfo
->mouse_face_past_end
23982 = !fast_find_position (w
, XFASTINT (after
),
23983 &dpyinfo
->mouse_face_end_col
,
23984 &dpyinfo
->mouse_face_end_row
,
23985 &dpyinfo
->mouse_face_end_x
,
23986 &dpyinfo
->mouse_face_end_y
,
23988 dpyinfo
->mouse_face_window
= window
;
23989 dpyinfo
->mouse_face_face_id
23990 = face_at_buffer_position (w
, pos
, 0, 0,
23992 !dpyinfo
->mouse_face_hidden
);
23994 /* Display it as active. */
23995 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23996 cursor
= No_Cursor
;
24003 /* Look for a `help-echo' property. */
24004 if (NILP (help_echo_string
)) {
24005 Lisp_Object help
, overlay
;
24007 /* Check overlays first. */
24008 help
= overlay
= Qnil
;
24009 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24011 overlay
= overlay_vec
[i
];
24012 help
= Foverlay_get (overlay
, Qhelp_echo
);
24017 help_echo_string
= help
;
24018 help_echo_window
= window
;
24019 help_echo_object
= overlay
;
24020 help_echo_pos
= pos
;
24024 Lisp_Object object
= glyph
->object
;
24025 int charpos
= glyph
->charpos
;
24027 /* Try text properties. */
24028 if (STRINGP (object
)
24030 && charpos
< SCHARS (object
))
24032 help
= Fget_text_property (make_number (charpos
),
24033 Qhelp_echo
, object
);
24036 /* If the string itself doesn't specify a help-echo,
24037 see if the buffer text ``under'' it does. */
24038 struct glyph_row
*r
24039 = MATRIX_ROW (w
->current_matrix
, vpos
);
24040 int start
= MATRIX_ROW_START_CHARPOS (r
);
24041 int pos
= string_buffer_position (w
, object
, start
);
24044 help
= Fget_char_property (make_number (pos
),
24045 Qhelp_echo
, w
->buffer
);
24049 object
= w
->buffer
;
24054 else if (BUFFERP (object
)
24057 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24062 help_echo_string
= help
;
24063 help_echo_window
= window
;
24064 help_echo_object
= object
;
24065 help_echo_pos
= charpos
;
24070 /* Look for a `pointer' property. */
24071 if (NILP (pointer
))
24073 /* Check overlays first. */
24074 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24075 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24077 if (NILP (pointer
))
24079 Lisp_Object object
= glyph
->object
;
24080 int charpos
= glyph
->charpos
;
24082 /* Try text properties. */
24083 if (STRINGP (object
)
24085 && charpos
< SCHARS (object
))
24087 pointer
= Fget_text_property (make_number (charpos
),
24089 if (NILP (pointer
))
24091 /* If the string itself doesn't specify a pointer,
24092 see if the buffer text ``under'' it does. */
24093 struct glyph_row
*r
24094 = MATRIX_ROW (w
->current_matrix
, vpos
);
24095 int start
= MATRIX_ROW_START_CHARPOS (r
);
24096 int pos
= string_buffer_position (w
, object
, start
);
24098 pointer
= Fget_char_property (make_number (pos
),
24099 Qpointer
, w
->buffer
);
24102 else if (BUFFERP (object
)
24105 pointer
= Fget_text_property (make_number (charpos
),
24112 current_buffer
= obuf
;
24117 define_frame_cursor1 (f
, cursor
, pointer
);
24122 Clear any mouse-face on window W. This function is part of the
24123 redisplay interface, and is called from try_window_id and similar
24124 functions to ensure the mouse-highlight is off. */
24127 x_clear_window_mouse_face (w
)
24130 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24131 Lisp_Object window
;
24134 XSETWINDOW (window
, w
);
24135 if (EQ (window
, dpyinfo
->mouse_face_window
))
24136 clear_mouse_face (dpyinfo
);
24142 Just discard the mouse face information for frame F, if any.
24143 This is used when the size of F is changed. */
24146 cancel_mouse_face (f
)
24149 Lisp_Object window
;
24150 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24152 window
= dpyinfo
->mouse_face_window
;
24153 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24155 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24156 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24157 dpyinfo
->mouse_face_window
= Qnil
;
24162 #endif /* HAVE_WINDOW_SYSTEM */
24165 /***********************************************************************
24167 ***********************************************************************/
24169 #ifdef HAVE_WINDOW_SYSTEM
24171 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24172 which intersects rectangle R. R is in window-relative coordinates. */
24175 expose_area (w
, row
, r
, area
)
24177 struct glyph_row
*row
;
24179 enum glyph_row_area area
;
24181 struct glyph
*first
= row
->glyphs
[area
];
24182 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24183 struct glyph
*last
;
24184 int first_x
, start_x
, x
;
24186 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24187 /* If row extends face to end of line write the whole line. */
24188 draw_glyphs (w
, 0, row
, area
,
24189 0, row
->used
[area
],
24190 DRAW_NORMAL_TEXT
, 0);
24193 /* Set START_X to the window-relative start position for drawing glyphs of
24194 AREA. The first glyph of the text area can be partially visible.
24195 The first glyphs of other areas cannot. */
24196 start_x
= window_box_left_offset (w
, area
);
24198 if (area
== TEXT_AREA
)
24201 /* Find the first glyph that must be redrawn. */
24203 && x
+ first
->pixel_width
< r
->x
)
24205 x
+= first
->pixel_width
;
24209 /* Find the last one. */
24213 && x
< r
->x
+ r
->width
)
24215 x
+= last
->pixel_width
;
24221 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24222 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24223 DRAW_NORMAL_TEXT
, 0);
24228 /* Redraw the parts of the glyph row ROW on window W intersecting
24229 rectangle R. R is in window-relative coordinates. Value is
24230 non-zero if mouse-face was overwritten. */
24233 expose_line (w
, row
, r
)
24235 struct glyph_row
*row
;
24238 xassert (row
->enabled_p
);
24240 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24241 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24242 0, row
->used
[TEXT_AREA
],
24243 DRAW_NORMAL_TEXT
, 0);
24246 if (row
->used
[LEFT_MARGIN_AREA
])
24247 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24248 if (row
->used
[TEXT_AREA
])
24249 expose_area (w
, row
, r
, TEXT_AREA
);
24250 if (row
->used
[RIGHT_MARGIN_AREA
])
24251 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24252 draw_row_fringe_bitmaps (w
, row
);
24255 return row
->mouse_face_p
;
24259 /* Redraw those parts of glyphs rows during expose event handling that
24260 overlap other rows. Redrawing of an exposed line writes over parts
24261 of lines overlapping that exposed line; this function fixes that.
24263 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24264 row in W's current matrix that is exposed and overlaps other rows.
24265 LAST_OVERLAPPING_ROW is the last such row. */
24268 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24270 struct glyph_row
*first_overlapping_row
;
24271 struct glyph_row
*last_overlapping_row
;
24274 struct glyph_row
*row
;
24276 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24277 if (row
->overlapping_p
)
24279 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24282 if (row
->used
[LEFT_MARGIN_AREA
])
24283 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24285 if (row
->used
[TEXT_AREA
])
24286 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24288 if (row
->used
[RIGHT_MARGIN_AREA
])
24289 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24295 /* Return non-zero if W's cursor intersects rectangle R. */
24298 phys_cursor_in_rect_p (w
, r
)
24302 XRectangle cr
, result
;
24303 struct glyph
*cursor_glyph
;
24304 struct glyph_row
*row
;
24306 if (w
->phys_cursor
.vpos
>= 0
24307 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24308 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24310 && row
->cursor_in_fringe_p
)
24312 /* Cursor is in the fringe. */
24313 cr
.x
= window_box_right_offset (w
,
24314 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24315 ? RIGHT_MARGIN_AREA
24318 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24319 cr
.height
= row
->height
;
24320 return x_intersect_rectangles (&cr
, r
, &result
);
24323 cursor_glyph
= get_phys_cursor_glyph (w
);
24326 /* r is relative to W's box, but w->phys_cursor.x is relative
24327 to left edge of W's TEXT area. Adjust it. */
24328 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24329 cr
.y
= w
->phys_cursor
.y
;
24330 cr
.width
= cursor_glyph
->pixel_width
;
24331 cr
.height
= w
->phys_cursor_height
;
24332 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24333 I assume the effect is the same -- and this is portable. */
24334 return x_intersect_rectangles (&cr
, r
, &result
);
24336 /* If we don't understand the format, pretend we're not in the hot-spot. */
24342 Draw a vertical window border to the right of window W if W doesn't
24343 have vertical scroll bars. */
24346 x_draw_vertical_border (w
)
24349 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24351 /* We could do better, if we knew what type of scroll-bar the adjacent
24352 windows (on either side) have... But we don't :-(
24353 However, I think this works ok. ++KFS 2003-04-25 */
24355 /* Redraw borders between horizontally adjacent windows. Don't
24356 do it for frames with vertical scroll bars because either the
24357 right scroll bar of a window, or the left scroll bar of its
24358 neighbor will suffice as a border. */
24359 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24362 if (!WINDOW_RIGHTMOST_P (w
)
24363 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24365 int x0
, x1
, y0
, y1
;
24367 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24370 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24373 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24375 else if (!WINDOW_LEFTMOST_P (w
)
24376 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24378 int x0
, x1
, y0
, y1
;
24380 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24383 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24386 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24391 /* Redraw the part of window W intersection rectangle FR. Pixel
24392 coordinates in FR are frame-relative. Call this function with
24393 input blocked. Value is non-zero if the exposure overwrites
24397 expose_window (w
, fr
)
24401 struct frame
*f
= XFRAME (w
->frame
);
24403 int mouse_face_overwritten_p
= 0;
24405 /* If window is not yet fully initialized, do nothing. This can
24406 happen when toolkit scroll bars are used and a window is split.
24407 Reconfiguring the scroll bar will generate an expose for a newly
24409 if (w
->current_matrix
== NULL
)
24412 /* When we're currently updating the window, display and current
24413 matrix usually don't agree. Arrange for a thorough display
24415 if (w
== updated_window
)
24417 SET_FRAME_GARBAGED (f
);
24421 /* Frame-relative pixel rectangle of W. */
24422 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24423 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24424 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24425 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24427 if (x_intersect_rectangles (fr
, &wr
, &r
))
24429 int yb
= window_text_bottom_y (w
);
24430 struct glyph_row
*row
;
24431 int cursor_cleared_p
;
24432 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24434 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24435 r
.x
, r
.y
, r
.width
, r
.height
));
24437 /* Convert to window coordinates. */
24438 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24439 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24441 /* Turn off the cursor. */
24442 if (!w
->pseudo_window_p
24443 && phys_cursor_in_rect_p (w
, &r
))
24445 x_clear_cursor (w
);
24446 cursor_cleared_p
= 1;
24449 cursor_cleared_p
= 0;
24451 /* Update lines intersecting rectangle R. */
24452 first_overlapping_row
= last_overlapping_row
= NULL
;
24453 for (row
= w
->current_matrix
->rows
;
24458 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24460 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24461 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24462 || (r
.y
>= y0
&& r
.y
< y1
)
24463 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24465 /* A header line may be overlapping, but there is no need
24466 to fix overlapping areas for them. KFS 2005-02-12 */
24467 if (row
->overlapping_p
&& !row
->mode_line_p
)
24469 if (first_overlapping_row
== NULL
)
24470 first_overlapping_row
= row
;
24471 last_overlapping_row
= row
;
24475 if (expose_line (w
, row
, &r
))
24476 mouse_face_overwritten_p
= 1;
24479 else if (row
->overlapping_p
)
24481 /* We must redraw a row overlapping the exposed area. */
24483 ? y0
+ row
->phys_height
> r
.y
24484 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24486 if (first_overlapping_row
== NULL
)
24487 first_overlapping_row
= row
;
24488 last_overlapping_row
= row
;
24496 /* Display the mode line if there is one. */
24497 if (WINDOW_WANTS_MODELINE_P (w
)
24498 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24500 && row
->y
< r
.y
+ r
.height
)
24502 if (expose_line (w
, row
, &r
))
24503 mouse_face_overwritten_p
= 1;
24506 if (!w
->pseudo_window_p
)
24508 /* Fix the display of overlapping rows. */
24509 if (first_overlapping_row
)
24510 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24513 /* Draw border between windows. */
24514 x_draw_vertical_border (w
);
24516 /* Turn the cursor on again. */
24517 if (cursor_cleared_p
)
24518 update_window_cursor (w
, 1);
24522 return mouse_face_overwritten_p
;
24527 /* Redraw (parts) of all windows in the window tree rooted at W that
24528 intersect R. R contains frame pixel coordinates. Value is
24529 non-zero if the exposure overwrites mouse-face. */
24532 expose_window_tree (w
, r
)
24536 struct frame
*f
= XFRAME (w
->frame
);
24537 int mouse_face_overwritten_p
= 0;
24539 while (w
&& !FRAME_GARBAGED_P (f
))
24541 if (!NILP (w
->hchild
))
24542 mouse_face_overwritten_p
24543 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24544 else if (!NILP (w
->vchild
))
24545 mouse_face_overwritten_p
24546 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24548 mouse_face_overwritten_p
|= expose_window (w
, r
);
24550 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24553 return mouse_face_overwritten_p
;
24558 Redisplay an exposed area of frame F. X and Y are the upper-left
24559 corner of the exposed rectangle. W and H are width and height of
24560 the exposed area. All are pixel values. W or H zero means redraw
24561 the entire frame. */
24564 expose_frame (f
, x
, y
, w
, h
)
24569 int mouse_face_overwritten_p
= 0;
24571 TRACE ((stderr
, "expose_frame "));
24573 /* No need to redraw if frame will be redrawn soon. */
24574 if (FRAME_GARBAGED_P (f
))
24576 TRACE ((stderr
, " garbaged\n"));
24580 /* If basic faces haven't been realized yet, there is no point in
24581 trying to redraw anything. This can happen when we get an expose
24582 event while Emacs is starting, e.g. by moving another window. */
24583 if (FRAME_FACE_CACHE (f
) == NULL
24584 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24586 TRACE ((stderr
, " no faces\n"));
24590 if (w
== 0 || h
== 0)
24593 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24594 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24604 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24605 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24607 if (WINDOWP (f
->tool_bar_window
))
24608 mouse_face_overwritten_p
24609 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24611 #ifdef HAVE_X_WINDOWS
24613 #ifndef USE_X_TOOLKIT
24614 if (WINDOWP (f
->menu_bar_window
))
24615 mouse_face_overwritten_p
24616 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24617 #endif /* not USE_X_TOOLKIT */
24621 /* Some window managers support a focus-follows-mouse style with
24622 delayed raising of frames. Imagine a partially obscured frame,
24623 and moving the mouse into partially obscured mouse-face on that
24624 frame. The visible part of the mouse-face will be highlighted,
24625 then the WM raises the obscured frame. With at least one WM, KDE
24626 2.1, Emacs is not getting any event for the raising of the frame
24627 (even tried with SubstructureRedirectMask), only Expose events.
24628 These expose events will draw text normally, i.e. not
24629 highlighted. Which means we must redo the highlight here.
24630 Subsume it under ``we love X''. --gerd 2001-08-15 */
24631 /* Included in Windows version because Windows most likely does not
24632 do the right thing if any third party tool offers
24633 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24634 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24636 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24637 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24639 int x
= dpyinfo
->mouse_face_mouse_x
;
24640 int y
= dpyinfo
->mouse_face_mouse_y
;
24641 clear_mouse_face (dpyinfo
);
24642 note_mouse_highlight (f
, x
, y
);
24649 Determine the intersection of two rectangles R1 and R2. Return
24650 the intersection in *RESULT. Value is non-zero if RESULT is not
24654 x_intersect_rectangles (r1
, r2
, result
)
24655 XRectangle
*r1
, *r2
, *result
;
24657 XRectangle
*left
, *right
;
24658 XRectangle
*upper
, *lower
;
24659 int intersection_p
= 0;
24661 /* Rearrange so that R1 is the left-most rectangle. */
24663 left
= r1
, right
= r2
;
24665 left
= r2
, right
= r1
;
24667 /* X0 of the intersection is right.x0, if this is inside R1,
24668 otherwise there is no intersection. */
24669 if (right
->x
<= left
->x
+ left
->width
)
24671 result
->x
= right
->x
;
24673 /* The right end of the intersection is the minimum of the
24674 the right ends of left and right. */
24675 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24678 /* Same game for Y. */
24680 upper
= r1
, lower
= r2
;
24682 upper
= r2
, lower
= r1
;
24684 /* The upper end of the intersection is lower.y0, if this is inside
24685 of upper. Otherwise, there is no intersection. */
24686 if (lower
->y
<= upper
->y
+ upper
->height
)
24688 result
->y
= lower
->y
;
24690 /* The lower end of the intersection is the minimum of the lower
24691 ends of upper and lower. */
24692 result
->height
= (min (lower
->y
+ lower
->height
,
24693 upper
->y
+ upper
->height
)
24695 intersection_p
= 1;
24699 return intersection_p
;
24702 #endif /* HAVE_WINDOW_SYSTEM */
24705 /***********************************************************************
24707 ***********************************************************************/
24712 Vwith_echo_area_save_vector
= Qnil
;
24713 staticpro (&Vwith_echo_area_save_vector
);
24715 Vmessage_stack
= Qnil
;
24716 staticpro (&Vmessage_stack
);
24718 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24719 staticpro (&Qinhibit_redisplay
);
24721 message_dolog_marker1
= Fmake_marker ();
24722 staticpro (&message_dolog_marker1
);
24723 message_dolog_marker2
= Fmake_marker ();
24724 staticpro (&message_dolog_marker2
);
24725 message_dolog_marker3
= Fmake_marker ();
24726 staticpro (&message_dolog_marker3
);
24729 defsubr (&Sdump_frame_glyph_matrix
);
24730 defsubr (&Sdump_glyph_matrix
);
24731 defsubr (&Sdump_glyph_row
);
24732 defsubr (&Sdump_tool_bar_row
);
24733 defsubr (&Strace_redisplay
);
24734 defsubr (&Strace_to_stderr
);
24736 #ifdef HAVE_WINDOW_SYSTEM
24737 defsubr (&Stool_bar_lines_needed
);
24738 defsubr (&Slookup_image_map
);
24740 defsubr (&Sformat_mode_line
);
24741 defsubr (&Sinvisible_p
);
24743 staticpro (&Qmenu_bar_update_hook
);
24744 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24746 staticpro (&Qoverriding_terminal_local_map
);
24747 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24749 staticpro (&Qoverriding_local_map
);
24750 Qoverriding_local_map
= intern ("overriding-local-map");
24752 staticpro (&Qwindow_scroll_functions
);
24753 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24755 staticpro (&Qwindow_text_change_functions
);
24756 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24758 staticpro (&Qredisplay_end_trigger_functions
);
24759 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24761 staticpro (&Qinhibit_point_motion_hooks
);
24762 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24764 Qeval
= intern ("eval");
24765 staticpro (&Qeval
);
24767 QCdata
= intern (":data");
24768 staticpro (&QCdata
);
24769 Qdisplay
= intern ("display");
24770 staticpro (&Qdisplay
);
24771 Qspace_width
= intern ("space-width");
24772 staticpro (&Qspace_width
);
24773 Qraise
= intern ("raise");
24774 staticpro (&Qraise
);
24775 Qslice
= intern ("slice");
24776 staticpro (&Qslice
);
24777 Qspace
= intern ("space");
24778 staticpro (&Qspace
);
24779 Qmargin
= intern ("margin");
24780 staticpro (&Qmargin
);
24781 Qpointer
= intern ("pointer");
24782 staticpro (&Qpointer
);
24783 Qleft_margin
= intern ("left-margin");
24784 staticpro (&Qleft_margin
);
24785 Qright_margin
= intern ("right-margin");
24786 staticpro (&Qright_margin
);
24787 Qcenter
= intern ("center");
24788 staticpro (&Qcenter
);
24789 Qline_height
= intern ("line-height");
24790 staticpro (&Qline_height
);
24791 QCalign_to
= intern (":align-to");
24792 staticpro (&QCalign_to
);
24793 QCrelative_width
= intern (":relative-width");
24794 staticpro (&QCrelative_width
);
24795 QCrelative_height
= intern (":relative-height");
24796 staticpro (&QCrelative_height
);
24797 QCeval
= intern (":eval");
24798 staticpro (&QCeval
);
24799 QCpropertize
= intern (":propertize");
24800 staticpro (&QCpropertize
);
24801 QCfile
= intern (":file");
24802 staticpro (&QCfile
);
24803 Qfontified
= intern ("fontified");
24804 staticpro (&Qfontified
);
24805 Qfontification_functions
= intern ("fontification-functions");
24806 staticpro (&Qfontification_functions
);
24807 Qtrailing_whitespace
= intern ("trailing-whitespace");
24808 staticpro (&Qtrailing_whitespace
);
24809 Qescape_glyph
= intern ("escape-glyph");
24810 staticpro (&Qescape_glyph
);
24811 Qnobreak_space
= intern ("nobreak-space");
24812 staticpro (&Qnobreak_space
);
24813 Qimage
= intern ("image");
24814 staticpro (&Qimage
);
24815 QCmap
= intern (":map");
24816 staticpro (&QCmap
);
24817 QCpointer
= intern (":pointer");
24818 staticpro (&QCpointer
);
24819 Qrect
= intern ("rect");
24820 staticpro (&Qrect
);
24821 Qcircle
= intern ("circle");
24822 staticpro (&Qcircle
);
24823 Qpoly
= intern ("poly");
24824 staticpro (&Qpoly
);
24825 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24826 staticpro (&Qmessage_truncate_lines
);
24827 Qgrow_only
= intern ("grow-only");
24828 staticpro (&Qgrow_only
);
24829 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24830 staticpro (&Qinhibit_menubar_update
);
24831 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24832 staticpro (&Qinhibit_eval_during_redisplay
);
24833 Qposition
= intern ("position");
24834 staticpro (&Qposition
);
24835 Qbuffer_position
= intern ("buffer-position");
24836 staticpro (&Qbuffer_position
);
24837 Qobject
= intern ("object");
24838 staticpro (&Qobject
);
24839 Qbar
= intern ("bar");
24841 Qhbar
= intern ("hbar");
24842 staticpro (&Qhbar
);
24843 Qbox
= intern ("box");
24845 Qhollow
= intern ("hollow");
24846 staticpro (&Qhollow
);
24847 Qhand
= intern ("hand");
24848 staticpro (&Qhand
);
24849 Qarrow
= intern ("arrow");
24850 staticpro (&Qarrow
);
24851 Qtext
= intern ("text");
24852 staticpro (&Qtext
);
24853 Qrisky_local_variable
= intern ("risky-local-variable");
24854 staticpro (&Qrisky_local_variable
);
24855 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24856 staticpro (&Qinhibit_free_realized_faces
);
24858 list_of_error
= Fcons (Fcons (intern ("error"),
24859 Fcons (intern ("void-variable"), Qnil
)),
24861 staticpro (&list_of_error
);
24863 Qlast_arrow_position
= intern ("last-arrow-position");
24864 staticpro (&Qlast_arrow_position
);
24865 Qlast_arrow_string
= intern ("last-arrow-string");
24866 staticpro (&Qlast_arrow_string
);
24868 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24869 staticpro (&Qoverlay_arrow_string
);
24870 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24871 staticpro (&Qoverlay_arrow_bitmap
);
24873 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24874 staticpro (&echo_buffer
[0]);
24875 staticpro (&echo_buffer
[1]);
24877 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24878 staticpro (&echo_area_buffer
[0]);
24879 staticpro (&echo_area_buffer
[1]);
24881 Vmessages_buffer_name
= build_string ("*Messages*");
24882 staticpro (&Vmessages_buffer_name
);
24884 mode_line_proptrans_alist
= Qnil
;
24885 staticpro (&mode_line_proptrans_alist
);
24886 mode_line_string_list
= Qnil
;
24887 staticpro (&mode_line_string_list
);
24888 mode_line_string_face
= Qnil
;
24889 staticpro (&mode_line_string_face
);
24890 mode_line_string_face_prop
= Qnil
;
24891 staticpro (&mode_line_string_face_prop
);
24892 Vmode_line_unwind_vector
= Qnil
;
24893 staticpro (&Vmode_line_unwind_vector
);
24895 help_echo_string
= Qnil
;
24896 staticpro (&help_echo_string
);
24897 help_echo_object
= Qnil
;
24898 staticpro (&help_echo_object
);
24899 help_echo_window
= Qnil
;
24900 staticpro (&help_echo_window
);
24901 previous_help_echo_string
= Qnil
;
24902 staticpro (&previous_help_echo_string
);
24903 help_echo_pos
= -1;
24905 #ifdef HAVE_WINDOW_SYSTEM
24906 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24907 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24908 For example, if a block cursor is over a tab, it will be drawn as
24909 wide as that tab on the display. */);
24910 x_stretch_cursor_p
= 0;
24913 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24914 doc
: /* *Non-nil means highlight trailing whitespace.
24915 The face used for trailing whitespace is `trailing-whitespace'. */);
24916 Vshow_trailing_whitespace
= Qnil
;
24918 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24919 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24920 A value of t means highlight the character itself (for nobreak space,
24921 use face `nobreak-space').
24922 A value of nil means no highlighting.
24923 Other values mean display the escape glyph followed by an ordinary
24924 space or ordinary hyphen. */);
24925 Vnobreak_char_display
= Qt
;
24927 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24928 doc
: /* *The pointer shape to show in void text areas.
24929 A value of nil means to show the text pointer. Other options are `arrow',
24930 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24931 Vvoid_text_area_pointer
= Qarrow
;
24933 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24934 doc
: /* Non-nil means don't actually do any redisplay.
24935 This is used for internal purposes. */);
24936 Vinhibit_redisplay
= Qnil
;
24938 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24939 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24940 Vglobal_mode_string
= Qnil
;
24942 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24943 doc
: /* Marker for where to display an arrow on top of the buffer text.
24944 This must be the beginning of a line in order to work.
24945 See also `overlay-arrow-string'. */);
24946 Voverlay_arrow_position
= Qnil
;
24948 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24949 doc
: /* String to display as an arrow in non-window frames.
24950 See also `overlay-arrow-position'. */);
24951 Voverlay_arrow_string
= build_string ("=>");
24953 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24954 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24955 The symbols on this list are examined during redisplay to determine
24956 where to display overlay arrows. */);
24957 Voverlay_arrow_variable_list
24958 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24960 DEFVAR_INT ("scroll-step", &scroll_step
,
24961 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24962 If that fails to bring point back on frame, point is centered instead.
24963 If this is zero, point is always centered after it moves off frame.
24964 If you want scrolling to always be a line at a time, you should set
24965 `scroll-conservatively' to a large value rather than set this to 1. */);
24967 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24968 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24969 If point moves off-screen, redisplay will scroll by up to
24970 `scroll-conservatively' lines in order to bring point just barely
24971 onto the screen again. If that cannot be done, then redisplay
24972 recenters point as usual.
24974 A value of zero means always recenter point if it moves off screen. */);
24975 scroll_conservatively
= 0;
24977 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24978 doc
: /* *Number of lines of margin at the top and bottom of a window.
24979 Recenter the window whenever point gets within this many lines
24980 of the top or bottom of the window. */);
24983 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24984 doc
: /* Pixels per inch value for non-window system displays.
24985 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24986 Vdisplay_pixels_per_inch
= make_float (72.0);
24989 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24992 DEFVAR_LISP ("truncate-partial-width-windows",
24993 &Vtruncate_partial_width_windows
,
24994 doc
: /* Non-nil means truncate lines in windows with less than the frame width.
24995 For an integer value, truncate lines in each window with less than the
24996 full frame width, provided the window width is less than that integer;
24997 otherwise, respect the value of `truncate-lines'.
24999 For any other non-nil value, truncate lines in all windows with
25000 less than the full frame width.
25002 A value of nil means to respect the value of `truncate-lines'.
25004 If `word-wrap' is enabled, you might want to reduce this. */);
25005 Vtruncate_partial_width_windows
= make_number (50);
25007 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25008 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25009 Any other value means to use the appropriate face, `mode-line',
25010 `header-line', or `menu' respectively. */);
25011 mode_line_inverse_video
= 1;
25013 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25014 doc
: /* *Maximum buffer size for which line number should be displayed.
25015 If the buffer is bigger than this, the line number does not appear
25016 in the mode line. A value of nil means no limit. */);
25017 Vline_number_display_limit
= Qnil
;
25019 DEFVAR_INT ("line-number-display-limit-width",
25020 &line_number_display_limit_width
,
25021 doc
: /* *Maximum line width (in characters) for line number display.
25022 If the average length of the lines near point is bigger than this, then the
25023 line number may be omitted from the mode line. */);
25024 line_number_display_limit_width
= 200;
25026 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25027 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25028 highlight_nonselected_windows
= 0;
25030 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25031 doc
: /* Non-nil if more than one frame is visible on this display.
25032 Minibuffer-only frames don't count, but iconified frames do.
25033 This variable is not guaranteed to be accurate except while processing
25034 `frame-title-format' and `icon-title-format'. */);
25036 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25037 doc
: /* Template for displaying the title bar of visible frames.
25038 \(Assuming the window manager supports this feature.)
25040 This variable has the same structure as `mode-line-format', except that
25041 the %c and %l constructs are ignored. It is used only on frames for
25042 which no explicit name has been set \(see `modify-frame-parameters'). */);
25044 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25045 doc
: /* Template for displaying the title bar of an iconified frame.
25046 \(Assuming the window manager supports this feature.)
25047 This variable has the same structure as `mode-line-format' (which see),
25048 and is used only on frames for which no explicit name has been set
25049 \(see `modify-frame-parameters'). */);
25051 = Vframe_title_format
25052 = Fcons (intern ("multiple-frames"),
25053 Fcons (build_string ("%b"),
25054 Fcons (Fcons (empty_unibyte_string
,
25055 Fcons (intern ("invocation-name"),
25056 Fcons (build_string ("@"),
25057 Fcons (intern ("system-name"),
25061 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25062 doc
: /* Maximum number of lines to keep in the message log buffer.
25063 If nil, disable message logging. If t, log messages but don't truncate
25064 the buffer when it becomes large. */);
25065 Vmessage_log_max
= make_number (100);
25067 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25068 doc
: /* Functions called before redisplay, if window sizes have changed.
25069 The value should be a list of functions that take one argument.
25070 Just before redisplay, for each frame, if any of its windows have changed
25071 size since the last redisplay, or have been split or deleted,
25072 all the functions in the list are called, with the frame as argument. */);
25073 Vwindow_size_change_functions
= Qnil
;
25075 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25076 doc
: /* List of functions to call before redisplaying a window with scrolling.
25077 Each function is called with two arguments, the window
25078 and its new display-start position. Note that the value of `window-end'
25079 is not valid when these functions are called. */);
25080 Vwindow_scroll_functions
= Qnil
;
25082 DEFVAR_LISP ("window-text-change-functions",
25083 &Vwindow_text_change_functions
,
25084 doc
: /* Functions to call in redisplay when text in the window might change. */);
25085 Vwindow_text_change_functions
= Qnil
;
25087 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25088 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25089 Each function is called with two arguments, the window and the end trigger value.
25090 See `set-window-redisplay-end-trigger'. */);
25091 Vredisplay_end_trigger_functions
= Qnil
;
25093 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25094 doc
: /* *Non-nil means autoselect window with mouse pointer.
25095 If nil, do not autoselect windows.
25096 A positive number means delay autoselection by that many seconds: a
25097 window is autoselected only after the mouse has remained in that
25098 window for the duration of the delay.
25099 A negative number has a similar effect, but causes windows to be
25100 autoselected only after the mouse has stopped moving. \(Because of
25101 the way Emacs compares mouse events, you will occasionally wait twice
25102 that time before the window gets selected.\)
25103 Any other value means to autoselect window instantaneously when the
25104 mouse pointer enters it.
25106 Autoselection selects the minibuffer only if it is active, and never
25107 unselects the minibuffer if it is active.
25109 When customizing this variable make sure that the actual value of
25110 `focus-follows-mouse' matches the behavior of your window manager. */);
25111 Vmouse_autoselect_window
= Qnil
;
25113 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25114 doc
: /* *Non-nil means automatically resize tool-bars.
25115 This dynamically changes the tool-bar's height to the minimum height
25116 that is needed to make all tool-bar items visible.
25117 If value is `grow-only', the tool-bar's height is only increased
25118 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25119 Vauto_resize_tool_bars
= Qt
;
25121 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25122 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25123 auto_raise_tool_bar_buttons_p
= 1;
25125 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25126 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25127 make_cursor_line_fully_visible_p
= 1;
25129 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25130 doc
: /* *Border below tool-bar in pixels.
25131 If an integer, use it as the height of the border.
25132 If it is one of `internal-border-width' or `border-width', use the
25133 value of the corresponding frame parameter.
25134 Otherwise, no border is added below the tool-bar. */);
25135 Vtool_bar_border
= Qinternal_border_width
;
25137 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25138 doc
: /* *Margin around tool-bar buttons in pixels.
25139 If an integer, use that for both horizontal and vertical margins.
25140 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25141 HORZ specifying the horizontal margin, and VERT specifying the
25142 vertical margin. */);
25143 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25145 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25146 doc
: /* *Relief thickness of tool-bar buttons. */);
25147 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25149 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25150 doc
: /* List of functions to call to fontify regions of text.
25151 Each function is called with one argument POS. Functions must
25152 fontify a region starting at POS in the current buffer, and give
25153 fontified regions the property `fontified'. */);
25154 Vfontification_functions
= Qnil
;
25155 Fmake_variable_buffer_local (Qfontification_functions
);
25157 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25158 &unibyte_display_via_language_environment
,
25159 doc
: /* *Non-nil means display unibyte text according to language environment.
25160 Specifically this means that unibyte non-ASCII characters
25161 are displayed by converting them to the equivalent multibyte characters
25162 according to the current language environment. As a result, they are
25163 displayed according to the current fontset. */);
25164 unibyte_display_via_language_environment
= 0;
25166 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25167 doc
: /* *Maximum height for resizing mini-windows.
25168 If a float, it specifies a fraction of the mini-window frame's height.
25169 If an integer, it specifies a number of lines. */);
25170 Vmax_mini_window_height
= make_float (0.25);
25172 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25173 doc
: /* *How to resize mini-windows.
25174 A value of nil means don't automatically resize mini-windows.
25175 A value of t means resize them to fit the text displayed in them.
25176 A value of `grow-only', the default, means let mini-windows grow
25177 only, until their display becomes empty, at which point the windows
25178 go back to their normal size. */);
25179 Vresize_mini_windows
= Qgrow_only
;
25181 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25182 doc
: /* Alist specifying how to blink the cursor off.
25183 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25184 `cursor-type' frame-parameter or variable equals ON-STATE,
25185 comparing using `equal', Emacs uses OFF-STATE to specify
25186 how to blink it off. ON-STATE and OFF-STATE are values for
25187 the `cursor-type' frame parameter.
25189 If a frame's ON-STATE has no entry in this list,
25190 the frame's other specifications determine how to blink the cursor off. */);
25191 Vblink_cursor_alist
= Qnil
;
25193 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25194 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25195 automatic_hscrolling_p
= 1;
25196 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
25197 staticpro (&Qauto_hscroll_mode
);
25199 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25200 doc
: /* *How many columns away from the window edge point is allowed to get
25201 before automatic hscrolling will horizontally scroll the window. */);
25202 hscroll_margin
= 5;
25204 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25205 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25206 When point is less than `hscroll-margin' columns from the window
25207 edge, automatic hscrolling will scroll the window by the amount of columns
25208 determined by this variable. If its value is a positive integer, scroll that
25209 many columns. If it's a positive floating-point number, it specifies the
25210 fraction of the window's width to scroll. If it's nil or zero, point will be
25211 centered horizontally after the scroll. Any other value, including negative
25212 numbers, are treated as if the value were zero.
25214 Automatic hscrolling always moves point outside the scroll margin, so if
25215 point was more than scroll step columns inside the margin, the window will
25216 scroll more than the value given by the scroll step.
25218 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25219 and `scroll-right' overrides this variable's effect. */);
25220 Vhscroll_step
= make_number (0);
25222 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25223 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25224 Bind this around calls to `message' to let it take effect. */);
25225 message_truncate_lines
= 0;
25227 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25228 doc
: /* Normal hook run to update the menu bar definitions.
25229 Redisplay runs this hook before it redisplays the menu bar.
25230 This is used to update submenus such as Buffers,
25231 whose contents depend on various data. */);
25232 Vmenu_bar_update_hook
= Qnil
;
25234 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25235 doc
: /* Frame for which we are updating a menu.
25236 The enable predicate for a menu binding should check this variable. */);
25237 Vmenu_updating_frame
= Qnil
;
25239 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25240 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25241 inhibit_menubar_update
= 0;
25243 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25244 doc
: /* Prefix added to the beginning of all continuation lines at display-time.
25245 May be a string, an image, or a stretch-glyph such as used by the
25246 `display' text-property.
25248 This variable is overridden by any `wrap-prefix' text-property.
25250 To add a prefix to non-continuation lines, use the `line-prefix' variable. */);
25251 Vwrap_prefix
= Qnil
;
25252 staticpro (&Qwrap_prefix
);
25253 Qwrap_prefix
= intern ("wrap-prefix");
25254 Fmake_variable_buffer_local (Qwrap_prefix
);
25256 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25257 doc
: /* Prefix added to the beginning of all non-continuation lines at display-time.
25258 May be a string, an image, or a stretch-glyph such as used by the
25259 `display' text-property.
25261 This variable is overridden by any `line-prefix' text-property.
25263 To add a prefix to continuation lines, use the `wrap-prefix' variable. */);
25264 Vline_prefix
= Qnil
;
25265 staticpro (&Qline_prefix
);
25266 Qline_prefix
= intern ("line-prefix");
25267 Fmake_variable_buffer_local (Qline_prefix
);
25269 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25270 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25271 inhibit_eval_during_redisplay
= 0;
25273 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25274 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25275 inhibit_free_realized_faces
= 0;
25278 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25279 doc
: /* Inhibit try_window_id display optimization. */);
25280 inhibit_try_window_id
= 0;
25282 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25283 doc
: /* Inhibit try_window_reusing display optimization. */);
25284 inhibit_try_window_reusing
= 0;
25286 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25287 doc
: /* Inhibit try_cursor_movement display optimization. */);
25288 inhibit_try_cursor_movement
= 0;
25289 #endif /* GLYPH_DEBUG */
25291 DEFVAR_INT ("overline-margin", &overline_margin
,
25292 doc
: /* *Space between overline and text, in pixels.
25293 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25294 margin to the caracter height. */);
25295 overline_margin
= 2;
25297 DEFVAR_INT ("underline-minimum-offset",
25298 &underline_minimum_offset
,
25299 doc
: /* Minimum distance between baseline and underline.
25300 This can improve legibility of underlined text at small font sizes,
25301 particularly when using variable `x-use-underline-position-properties'
25302 with fonts that specify an UNDERLINE_POSITION relatively close to the
25303 baseline. The default value is 1. */);
25304 underline_minimum_offset
= 1;
25306 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25307 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25308 display_hourglass_p
= 1;
25310 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25311 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25312 Value must be an integer or float. */);
25313 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25315 hourglass_atimer
= NULL
;
25316 hourglass_shown_p
= 0;
25320 /* Initialize this module when Emacs starts. */
25325 Lisp_Object root_window
;
25326 struct window
*mini_w
;
25328 current_header_line_height
= current_mode_line_height
= -1;
25330 CHARPOS (this_line_start_pos
) = 0;
25332 mini_w
= XWINDOW (minibuf_window
);
25333 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25335 if (!noninteractive
)
25337 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25340 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25341 set_window_height (root_window
,
25342 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25344 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25345 set_window_height (minibuf_window
, 1, 0);
25347 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25348 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25350 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25351 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25352 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25354 /* The default ellipsis glyphs `...'. */
25355 for (i
= 0; i
< 3; ++i
)
25356 default_invis_vector
[i
] = make_number ('.');
25360 /* Allocate the buffer for frame titles.
25361 Also used for `format-mode-line'. */
25363 mode_line_noprop_buf
= (char *) xmalloc (size
);
25364 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25365 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25366 mode_line_target
= MODE_LINE_DISPLAY
;
25369 help_echo_showing_p
= 0;
25372 /* Since w32 does not support atimers, it defines its own implementation of
25373 the following three functions in w32fns.c. */
25376 /* Platform-independent portion of hourglass implementation. */
25378 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25380 hourglass_started ()
25382 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25385 /* Cancel a currently active hourglass timer, and start a new one. */
25389 #if defined (HAVE_WINDOW_SYSTEM)
25391 int secs
, usecs
= 0;
25393 cancel_hourglass ();
25395 if (INTEGERP (Vhourglass_delay
)
25396 && XINT (Vhourglass_delay
) > 0)
25397 secs
= XFASTINT (Vhourglass_delay
);
25398 else if (FLOATP (Vhourglass_delay
)
25399 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25402 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25403 secs
= XFASTINT (tem
);
25404 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25407 secs
= DEFAULT_HOURGLASS_DELAY
;
25409 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25410 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25411 show_hourglass
, NULL
);
25416 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25419 cancel_hourglass ()
25421 #if defined (HAVE_WINDOW_SYSTEM)
25422 if (hourglass_atimer
)
25424 cancel_atimer (hourglass_atimer
);
25425 hourglass_atimer
= NULL
;
25428 if (hourglass_shown_p
)
25432 #endif /* ! WINDOWSNT */
25434 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25435 (do not change this comment) */