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, 2009 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code. (Or,
35 let's say almost---see the description of direct update
38 The following diagram shows how redisplay code is invoked. As you
39 can see, Lisp calls redisplay and vice versa. Under window systems
40 like X, some portions of the redisplay code are also called
41 asynchronously during mouse movement or expose events. It is very
42 important that these code parts do NOT use the C library (malloc,
43 free) because many C libraries under Unix are not reentrant. They
44 may also NOT call functions of the Lisp interpreter which could
45 change the interpreter's state. If you don't follow these rules,
46 you will encounter bugs which are very hard to explain.
48 (Direct functions, see below)
49 direct_output_for_insert,
50 direct_forward_char (dispnew.c)
51 +---------------------------------+
54 +--------------+ redisplay +----------------+
55 | Lisp machine |---------------->| Redisplay code |<--+
56 +--------------+ (xdisp.c) +----------------+ |
58 +----------------------------------+ |
59 Don't use this path when called |
62 expose_window (asynchronous) |
64 X expose events -----+
66 What does redisplay do? Obviously, it has to figure out somehow what
67 has been changed since the last time the display has been updated,
68 and to make these changes visible. Preferably it would do that in
69 a moderately intelligent way, i.e. fast.
71 Changes in buffer text can be deduced from window and buffer
72 structures, and from some global variables like `beg_unchanged' and
73 `end_unchanged'. The contents of the display are additionally
74 recorded in a `glyph matrix', a two-dimensional matrix of glyph
75 structures. Each row in such a matrix corresponds to a line on the
76 display, and each glyph in a row corresponds to a column displaying
77 a character, an image, or what else. This matrix is called the
78 `current glyph matrix' or `current matrix' in redisplay
81 For buffer parts that have been changed since the last update, a
82 second glyph matrix is constructed, the so called `desired glyph
83 matrix' or short `desired matrix'. Current and desired matrix are
84 then compared to find a cheap way to update the display, e.g. by
85 reusing part of the display by scrolling lines.
90 You will find a lot of redisplay optimizations when you start
91 looking at the innards of redisplay. The overall goal of all these
92 optimizations is to make redisplay fast because it is done
95 Two optimizations are not found in xdisp.c. These are the direct
96 operations mentioned above. As the name suggests they follow a
97 different principle than the rest of redisplay. Instead of
98 building a desired matrix and then comparing it with the current
99 display, they perform their actions directly on the display and on
102 One direct operation updates the display after one character has
103 been entered. The other one moves the cursor by one position
104 forward or backward. You find these functions under the names
105 `direct_output_for_insert' and `direct_output_forward_char' in
111 Desired matrices are always built per Emacs window. The function
112 `display_line' is the central function to look at if you are
113 interested. It constructs one row in a desired matrix given an
114 iterator structure containing both a buffer position and a
115 description of the environment in which the text is to be
116 displayed. But this is too early, read on.
118 Characters and pixmaps displayed for a range of buffer text depend
119 on various settings of buffers and windows, on overlays and text
120 properties, on display tables, on selective display. The good news
121 is that all this hairy stuff is hidden behind a small set of
122 interface functions taking an iterator structure (struct it)
125 Iteration over things to be displayed is then simple. It is
126 started by initializing an iterator with a call to init_iterator.
127 Calls to get_next_display_element fill the iterator structure with
128 relevant information about the next thing to display. Calls to
129 set_iterator_to_next move the iterator to the next thing.
131 Besides this, an iterator also contains information about the
132 display environment in which glyphs for display elements are to be
133 produced. It has fields for the width and height of the display,
134 the information whether long lines are truncated or continued, a
135 current X and Y position, and lots of other stuff you can better
138 Glyphs in a desired matrix are normally constructed in a loop
139 calling get_next_display_element and then produce_glyphs. The call
140 to produce_glyphs will fill the iterator structure with pixel
141 information about the element being displayed and at the same time
142 produce glyphs for it. If the display element fits on the line
143 being displayed, set_iterator_to_next is called next, otherwise the
144 glyphs produced are discarded.
149 That just couldn't be all, could it? What about terminal types not
150 supporting operations on sub-windows of the screen? To update the
151 display on such a terminal, window-based glyph matrices are not
152 well suited. To be able to reuse part of the display (scrolling
153 lines up and down), we must instead have a view of the whole
154 screen. This is what `frame matrices' are for. They are a trick.
156 Frames on terminals like above have a glyph pool. Windows on such
157 a frame sub-allocate their glyph memory from their frame's glyph
158 pool. The frame itself is given its own glyph matrices. By
159 coincidence---or maybe something else---rows in window glyph
160 matrices are slices of corresponding rows in frame matrices. Thus
161 writing to window matrices implicitly updates a frame matrix which
162 provides us with the view of the whole screen that we originally
163 wanted to have without having to move many bytes around. To be
164 honest, there is a little bit more done, but not much more. If you
165 plan to extend that code, take a look at dispnew.c. The function
166 build_frame_matrix is a good starting point. */
173 #include "keyboard.h"
176 #include "termchar.h"
177 #include "dispextern.h"
179 #include "character.h"
182 #include "commands.h"
186 #include "termhooks.h"
187 #include "intervals.h"
190 #include "region-cache.h"
193 #include "blockinput.h"
195 #ifdef HAVE_X_WINDOWS
210 #ifndef FRAME_X_OUTPUT
211 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
214 #define INFINITY 10000000
216 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
217 || defined(HAVE_NS) || defined (USE_GTK)
218 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
219 extern int pending_menu_activation
;
222 extern int interrupt_input
;
223 extern int command_loop_level
;
225 extern Lisp_Object do_mouse_tracking
;
227 extern int minibuffer_auto_raise
;
228 extern Lisp_Object Vminibuffer_list
;
230 extern Lisp_Object Qface
;
231 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
233 extern Lisp_Object Voverriding_local_map
;
234 extern Lisp_Object Voverriding_local_map_menu_flag
;
235 extern Lisp_Object Qmenu_item
;
236 extern Lisp_Object Qwhen
;
237 extern Lisp_Object Qhelp_echo
;
239 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
240 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
241 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
242 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
243 Lisp_Object Qinhibit_point_motion_hooks
;
244 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
245 Lisp_Object Qfontified
;
246 Lisp_Object Qgrow_only
;
247 Lisp_Object Qinhibit_eval_during_redisplay
;
248 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
251 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
254 Lisp_Object Qarrow
, Qhand
, Qtext
;
256 Lisp_Object Qrisky_local_variable
;
258 /* Holds the list (error). */
259 Lisp_Object list_of_error
;
261 /* Functions called to fontify regions of text. */
263 Lisp_Object Vfontification_functions
;
264 Lisp_Object Qfontification_functions
;
266 /* Non-nil means automatically select any window when the mouse
267 cursor moves into it. */
268 Lisp_Object Vmouse_autoselect_window
;
270 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
271 Lisp_Object Vline_prefix
, Qline_prefix
;
273 /* Non-zero means draw tool bar buttons raised when the mouse moves
276 int auto_raise_tool_bar_buttons_p
;
278 /* Non-zero means to reposition window if cursor line is only partially visible. */
280 int make_cursor_line_fully_visible_p
;
282 /* Margin below tool bar in pixels. 0 or nil means no margin.
283 If value is `internal-border-width' or `border-width',
284 the corresponding frame parameter is used. */
286 Lisp_Object Vtool_bar_border
;
288 /* Margin around tool bar buttons in pixels. */
290 Lisp_Object Vtool_bar_button_margin
;
292 /* Thickness of shadow to draw around tool bar buttons. */
294 EMACS_INT tool_bar_button_relief
;
296 /* Non-nil means automatically resize tool-bars so that all tool-bar
297 items are visible, and no blank lines remain.
299 If value is `grow-only', only make tool-bar bigger. */
301 Lisp_Object Vauto_resize_tool_bars
;
303 /* Non-zero means draw block and hollow cursor as wide as the glyph
304 under it. For example, if a block cursor is over a tab, it will be
305 drawn as wide as that tab on the display. */
307 int x_stretch_cursor_p
;
309 /* Non-nil means don't actually do any redisplay. */
311 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
313 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
315 int inhibit_eval_during_redisplay
;
317 /* Names of text properties relevant for redisplay. */
319 Lisp_Object Qdisplay
;
320 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
322 /* Symbols used in text property values. */
324 Lisp_Object Vdisplay_pixels_per_inch
;
325 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
326 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
329 Lisp_Object Qmargin
, Qpointer
;
330 Lisp_Object Qline_height
;
331 extern Lisp_Object Qheight
;
332 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
333 extern Lisp_Object Qscroll_bar
;
334 extern Lisp_Object Qcursor
;
336 /* Non-nil means highlight trailing whitespace. */
338 Lisp_Object Vshow_trailing_whitespace
;
340 /* Non-nil means escape non-break space and hyphens. */
342 Lisp_Object Vnobreak_char_display
;
344 #ifdef HAVE_WINDOW_SYSTEM
345 extern Lisp_Object Voverflow_newline_into_fringe
;
347 /* Test if overflow newline into fringe. Called with iterator IT
348 at or past right window margin, and with IT->current_x set. */
350 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
351 (!NILP (Voverflow_newline_into_fringe) \
352 && FRAME_WINDOW_P (it->f) \
353 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
354 && it->current_x == it->last_visible_x \
355 && it->line_wrap != WORD_WRAP)
357 #endif /* HAVE_WINDOW_SYSTEM */
359 /* Test if the display element loaded in IT is a space or tab
360 character. This is used to determine word wrapping. */
362 #define IT_DISPLAYING_WHITESPACE(it) \
363 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
365 /* Non-nil means show the text cursor in void text areas
366 i.e. in blank areas after eol and eob. This used to be
367 the default in 21.3. */
369 Lisp_Object Vvoid_text_area_pointer
;
371 /* Name of the face used to highlight trailing whitespace. */
373 Lisp_Object Qtrailing_whitespace
;
375 /* Name and number of the face used to highlight escape glyphs. */
377 Lisp_Object Qescape_glyph
;
379 /* Name and number of the face used to highlight non-breaking spaces. */
381 Lisp_Object Qnobreak_space
;
383 /* The symbol `image' which is the car of the lists used to represent
388 /* The image map types. */
389 Lisp_Object QCmap
, QCpointer
;
390 Lisp_Object Qrect
, Qcircle
, Qpoly
;
392 /* Non-zero means print newline to stdout before next mini-buffer
395 int noninteractive_need_newline
;
397 /* Non-zero means print newline to message log before next message. */
399 static int message_log_need_newline
;
401 /* Three markers that message_dolog uses.
402 It could allocate them itself, but that causes trouble
403 in handling memory-full errors. */
404 static Lisp_Object message_dolog_marker1
;
405 static Lisp_Object message_dolog_marker2
;
406 static Lisp_Object message_dolog_marker3
;
408 /* The buffer position of the first character appearing entirely or
409 partially on the line of the selected window which contains the
410 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
411 redisplay optimization in redisplay_internal. */
413 static struct text_pos this_line_start_pos
;
415 /* Number of characters past the end of the line above, including the
416 terminating newline. */
418 static struct text_pos this_line_end_pos
;
420 /* The vertical positions and the height of this line. */
422 static int this_line_vpos
;
423 static int this_line_y
;
424 static int this_line_pixel_height
;
426 /* X position at which this display line starts. Usually zero;
427 negative if first character is partially visible. */
429 static int this_line_start_x
;
431 /* Buffer that this_line_.* variables are referring to. */
433 static struct buffer
*this_line_buffer
;
435 /* Nonzero means truncate lines in all windows less wide than the
438 Lisp_Object Vtruncate_partial_width_windows
;
440 /* A flag to control how to display unibyte 8-bit character. */
442 int unibyte_display_via_language_environment
;
444 /* Nonzero means we have more than one non-mini-buffer-only frame.
445 Not guaranteed to be accurate except while parsing
446 frame-title-format. */
450 Lisp_Object Vglobal_mode_string
;
453 /* List of variables (symbols) which hold markers for overlay arrows.
454 The symbols on this list are examined during redisplay to determine
455 where to display overlay arrows. */
457 Lisp_Object Voverlay_arrow_variable_list
;
459 /* Marker for where to display an arrow on top of the buffer text. */
461 Lisp_Object Voverlay_arrow_position
;
463 /* String to display for the arrow. Only used on terminal frames. */
465 Lisp_Object Voverlay_arrow_string
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 /* Like mode-line-format, but for the title bar on a visible frame. */
481 Lisp_Object Vframe_title_format
;
483 /* Like mode-line-format, but for the title bar on an iconified frame. */
485 Lisp_Object Vicon_title_format
;
487 /* List of functions to call when a window's size changes. These
488 functions get one arg, a frame on which one or more windows' sizes
491 static Lisp_Object Vwindow_size_change_functions
;
493 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
495 /* Nonzero if an overlay arrow has been displayed in this window. */
497 static int overlay_arrow_seen
;
499 /* Nonzero means highlight the region even in nonselected windows. */
501 int highlight_nonselected_windows
;
503 /* If cursor motion alone moves point off frame, try scrolling this
504 many lines up or down if that will bring it back. */
506 static EMACS_INT scroll_step
;
508 /* Nonzero means scroll just far enough to bring point back on the
509 screen, when appropriate. */
511 static EMACS_INT scroll_conservatively
;
513 /* Recenter the window whenever point gets within this many lines of
514 the top or bottom of the window. This value is translated into a
515 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
516 that there is really a fixed pixel height scroll margin. */
518 EMACS_INT scroll_margin
;
520 /* Number of windows showing the buffer of the selected window (or
521 another buffer with the same base buffer). keyboard.c refers to
526 /* Vector containing glyphs for an ellipsis `...'. */
528 static Lisp_Object default_invis_vector
[3];
530 /* Zero means display the mode-line/header-line/menu-bar in the default face
531 (this slightly odd definition is for compatibility with previous versions
532 of emacs), non-zero means display them using their respective faces.
534 This variable is deprecated. */
536 int mode_line_inverse_video
;
538 /* Prompt to display in front of the mini-buffer contents. */
540 Lisp_Object minibuf_prompt
;
542 /* Width of current mini-buffer prompt. Only set after display_line
543 of the line that contains the prompt. */
545 int minibuf_prompt_width
;
547 /* This is the window where the echo area message was displayed. It
548 is always a mini-buffer window, but it may not be the same window
549 currently active as a mini-buffer. */
551 Lisp_Object echo_area_window
;
553 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
554 pushes the current message and the value of
555 message_enable_multibyte on the stack, the function restore_message
556 pops the stack and displays MESSAGE again. */
558 Lisp_Object Vmessage_stack
;
560 /* Nonzero means multibyte characters were enabled when the echo area
561 message was specified. */
563 int message_enable_multibyte
;
565 /* Nonzero if we should redraw the mode lines on the next redisplay. */
567 int update_mode_lines
;
569 /* Nonzero if window sizes or contents have changed since last
570 redisplay that finished. */
572 int windows_or_buffers_changed
;
574 /* Nonzero means a frame's cursor type has been changed. */
576 int cursor_type_changed
;
578 /* Nonzero after display_mode_line if %l was used and it displayed a
581 int line_number_displayed
;
583 /* Maximum buffer size for which to display line numbers. */
585 Lisp_Object Vline_number_display_limit
;
587 /* Line width to consider when repositioning for line number display. */
589 static EMACS_INT line_number_display_limit_width
;
591 /* Number of lines to keep in the message log buffer. t means
592 infinite. nil means don't log at all. */
594 Lisp_Object Vmessage_log_max
;
596 /* The name of the *Messages* buffer, a string. */
598 static Lisp_Object Vmessages_buffer_name
;
600 /* Current, index 0, and last displayed echo area message. Either
601 buffers from echo_buffers, or nil to indicate no message. */
603 Lisp_Object echo_area_buffer
[2];
605 /* The buffers referenced from echo_area_buffer. */
607 static Lisp_Object echo_buffer
[2];
609 /* A vector saved used in with_area_buffer to reduce consing. */
611 static Lisp_Object Vwith_echo_area_save_vector
;
613 /* Non-zero means display_echo_area should display the last echo area
614 message again. Set by redisplay_preserve_echo_area. */
616 static int display_last_displayed_message_p
;
618 /* Nonzero if echo area is being used by print; zero if being used by
621 int message_buf_print
;
623 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
625 Lisp_Object Qinhibit_menubar_update
;
626 int inhibit_menubar_update
;
628 /* When evaluating expressions from menu bar items (enable conditions,
629 for instance), this is the frame they are being processed for. */
631 Lisp_Object Vmenu_updating_frame
;
633 /* Maximum height for resizing mini-windows. Either a float
634 specifying a fraction of the available height, or an integer
635 specifying a number of lines. */
637 Lisp_Object Vmax_mini_window_height
;
639 /* Non-zero means messages should be displayed with truncated
640 lines instead of being continued. */
642 int message_truncate_lines
;
643 Lisp_Object Qmessage_truncate_lines
;
645 /* Set to 1 in clear_message to make redisplay_internal aware
646 of an emptied echo area. */
648 static int message_cleared_p
;
650 /* How to blink the default frame cursor off. */
651 Lisp_Object Vblink_cursor_alist
;
653 /* A scratch glyph row with contents used for generating truncation
654 glyphs. Also used in direct_output_for_insert. */
656 #define MAX_SCRATCH_GLYPHS 100
657 struct glyph_row scratch_glyph_row
;
658 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
660 /* Ascent and height of the last line processed by move_it_to. */
662 static int last_max_ascent
, last_height
;
664 /* Non-zero if there's a help-echo in the echo area. */
666 int help_echo_showing_p
;
668 /* If >= 0, computed, exact values of mode-line and header-line height
669 to use in the macros CURRENT_MODE_LINE_HEIGHT and
670 CURRENT_HEADER_LINE_HEIGHT. */
672 int current_mode_line_height
, current_header_line_height
;
674 /* The maximum distance to look ahead for text properties. Values
675 that are too small let us call compute_char_face and similar
676 functions too often which is expensive. Values that are too large
677 let us call compute_char_face and alike too often because we
678 might not be interested in text properties that far away. */
680 #define TEXT_PROP_DISTANCE_LIMIT 100
684 /* Variables to turn off display optimizations from Lisp. */
686 int inhibit_try_window_id
, inhibit_try_window_reusing
;
687 int inhibit_try_cursor_movement
;
689 /* Non-zero means print traces of redisplay if compiled with
692 int trace_redisplay_p
;
694 #endif /* GLYPH_DEBUG */
696 #ifdef DEBUG_TRACE_MOVE
697 /* Non-zero means trace with TRACE_MOVE to stderr. */
700 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
702 #define TRACE_MOVE(x) (void) 0
705 /* Non-zero means automatically scroll windows horizontally to make
708 int automatic_hscrolling_p
;
709 Lisp_Object Qauto_hscroll_mode
;
711 /* How close to the margin can point get before the window is scrolled
713 EMACS_INT hscroll_margin
;
715 /* How much to scroll horizontally when point is inside the above margin. */
716 Lisp_Object Vhscroll_step
;
718 /* The variable `resize-mini-windows'. If nil, don't resize
719 mini-windows. If t, always resize them to fit the text they
720 display. If `grow-only', let mini-windows grow only until they
723 Lisp_Object Vresize_mini_windows
;
725 /* Buffer being redisplayed -- for redisplay_window_error. */
727 struct buffer
*displayed_buffer
;
729 /* Space between overline and text. */
731 EMACS_INT overline_margin
;
733 /* Require underline to be at least this many screen pixels below baseline
734 This to avoid underline "merging" with the base of letters at small
735 font sizes, particularly when x_use_underline_position_properties is on. */
737 EMACS_INT underline_minimum_offset
;
739 /* Value returned from text property handlers (see below). */
744 HANDLED_RECOMPUTE_PROPS
,
745 HANDLED_OVERLAY_STRING_CONSUMED
,
749 /* A description of text properties that redisplay is interested
754 /* The name of the property. */
757 /* A unique index for the property. */
760 /* A handler function called to set up iterator IT from the property
761 at IT's current position. Value is used to steer handle_stop. */
762 enum prop_handled (*handler
) P_ ((struct it
*it
));
765 static enum prop_handled handle_face_prop
P_ ((struct it
*));
766 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
767 static enum prop_handled handle_display_prop
P_ ((struct it
*));
768 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
769 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
770 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
772 /* Properties handled by iterators. */
774 static struct props it_props
[] =
776 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
777 /* Handle `face' before `display' because some sub-properties of
778 `display' need to know the face. */
779 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
780 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
781 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
782 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
786 /* Value is the position described by X. If X is a marker, value is
787 the marker_position of X. Otherwise, value is X. */
789 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
791 /* Enumeration returned by some move_it_.* functions internally. */
795 /* Not used. Undefined value. */
798 /* Move ended at the requested buffer position or ZV. */
799 MOVE_POS_MATCH_OR_ZV
,
801 /* Move ended at the requested X pixel position. */
804 /* Move within a line ended at the end of a line that must be
808 /* Move within a line ended at the end of a line that would
809 be displayed truncated. */
812 /* Move within a line ended at a line end. */
816 /* This counter is used to clear the face cache every once in a while
817 in redisplay_internal. It is incremented for each redisplay.
818 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
821 #define CLEAR_FACE_CACHE_COUNT 500
822 static int clear_face_cache_count
;
824 /* Similarly for the image cache. */
826 #ifdef HAVE_WINDOW_SYSTEM
827 #define CLEAR_IMAGE_CACHE_COUNT 101
828 static int clear_image_cache_count
;
831 /* Non-zero while redisplay_internal is in progress. */
835 /* Non-zero means don't free realized faces. Bound while freeing
836 realized faces is dangerous because glyph matrices might still
839 int inhibit_free_realized_faces
;
840 Lisp_Object Qinhibit_free_realized_faces
;
842 /* If a string, XTread_socket generates an event to display that string.
843 (The display is done in read_char.) */
845 Lisp_Object help_echo_string
;
846 Lisp_Object help_echo_window
;
847 Lisp_Object help_echo_object
;
850 /* Temporary variable for XTread_socket. */
852 Lisp_Object previous_help_echo_string
;
854 /* Null glyph slice */
856 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
858 /* Platform-independent portion of hourglass implementation. */
860 /* Non-zero means we're allowed to display a hourglass pointer. */
861 int display_hourglass_p
;
863 /* Non-zero means an hourglass cursor is currently shown. */
864 int hourglass_shown_p
;
866 /* If non-null, an asynchronous timer that, when it expires, displays
867 an hourglass cursor on all frames. */
868 struct atimer
*hourglass_atimer
;
870 /* Number of seconds to wait before displaying an hourglass cursor. */
871 Lisp_Object Vhourglass_delay
;
873 /* Default number of seconds to wait before displaying an hourglass
875 #define DEFAULT_HOURGLASS_DELAY 1
878 /* Function prototypes. */
880 static void setup_for_ellipsis
P_ ((struct it
*, int));
881 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
882 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
883 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
884 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
885 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
886 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
888 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
890 static void handle_line_prefix
P_ ((struct it
*));
892 static void pint2str
P_ ((char *, int, int));
893 static void pint2hrstr
P_ ((char *, int, int));
894 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
896 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
897 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
898 static void store_mode_line_noprop_char
P_ ((char));
899 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
900 static void x_consider_frame_title
P_ ((Lisp_Object
));
901 static void handle_stop
P_ ((struct it
*));
902 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
903 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
904 static void ensure_echo_area_buffers
P_ ((void));
905 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
906 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
907 static int with_echo_area_buffer
P_ ((struct window
*, int,
908 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
909 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
910 static void clear_garbaged_frames
P_ ((void));
911 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
912 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
913 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
914 static int display_echo_area
P_ ((struct window
*));
915 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
916 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
917 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
918 static int string_char_and_length
P_ ((const unsigned char *, int, int *));
919 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
921 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
922 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
923 static void insert_left_trunc_glyphs
P_ ((struct it
*));
924 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
926 static void extend_face_to_end_of_line
P_ ((struct it
*));
927 static int append_space_for_newline
P_ ((struct it
*, int));
928 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
929 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
930 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
931 static int trailing_whitespace_p
P_ ((int));
932 static int message_log_check_duplicate
P_ ((int, int, int, int));
933 static void push_it
P_ ((struct it
*));
934 static void pop_it
P_ ((struct it
*));
935 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
936 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
937 static void redisplay_internal
P_ ((int));
938 static int echo_area_display
P_ ((int));
939 static void redisplay_windows
P_ ((Lisp_Object
));
940 static void redisplay_window
P_ ((Lisp_Object
, int));
941 static Lisp_Object
redisplay_window_error ();
942 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
943 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
944 static int update_menu_bar
P_ ((struct frame
*, int, int));
945 static int try_window_reusing_current_matrix
P_ ((struct window
*));
946 static int try_window_id
P_ ((struct window
*));
947 static int display_line
P_ ((struct it
*));
948 static int display_mode_lines
P_ ((struct window
*));
949 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
950 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
951 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
952 static char *decode_mode_spec
P_ ((struct window
*, int, int, int, int *));
953 static void display_menu_bar
P_ ((struct window
*));
954 static int display_count_lines
P_ ((int, int, int, int, int *));
955 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
956 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
957 static void compute_line_metrics
P_ ((struct it
*));
958 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
959 static int get_overlay_strings
P_ ((struct it
*, int));
960 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
961 static void next_overlay_string
P_ ((struct it
*));
962 static void reseat
P_ ((struct it
*, struct text_pos
, int));
963 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
964 static void back_to_previous_visible_line_start
P_ ((struct it
*));
965 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
966 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
967 static int next_element_from_ellipsis
P_ ((struct it
*));
968 static int next_element_from_display_vector
P_ ((struct it
*));
969 static int next_element_from_string
P_ ((struct it
*));
970 static int next_element_from_c_string
P_ ((struct it
*));
971 static int next_element_from_buffer
P_ ((struct it
*));
972 static int next_element_from_composition
P_ ((struct it
*));
973 static int next_element_from_image
P_ ((struct it
*));
974 static int next_element_from_stretch
P_ ((struct it
*));
975 static void load_overlay_strings
P_ ((struct it
*, int));
976 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
977 struct display_pos
*));
978 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
979 Lisp_Object
, int, int, int, int));
980 static enum move_it_result
981 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
982 enum move_operation_enum
);
983 void move_it_vertically_backward
P_ ((struct it
*, int));
984 static void init_to_row_start
P_ ((struct it
*, struct window
*,
985 struct glyph_row
*));
986 static int init_to_row_end
P_ ((struct it
*, struct window
*,
987 struct glyph_row
*));
988 static void back_to_previous_line_start
P_ ((struct it
*));
989 static int forward_to_next_line_start
P_ ((struct it
*, int *));
990 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
992 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
993 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
994 static int number_of_chars
P_ ((unsigned char *, int));
995 static void compute_stop_pos
P_ ((struct it
*));
996 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
998 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
999 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
1000 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
1001 Lisp_Object
, Lisp_Object
,
1002 struct text_pos
*, int));
1003 static int underlying_face_id
P_ ((struct it
*));
1004 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
1007 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1008 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1010 #ifdef HAVE_WINDOW_SYSTEM
1012 static void update_tool_bar
P_ ((struct frame
*, int));
1013 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
1014 static int redisplay_tool_bar
P_ ((struct frame
*));
1015 static void display_tool_bar_line
P_ ((struct it
*, int));
1016 static void notice_overwritten_cursor
P_ ((struct window
*,
1017 enum glyph_row_area
,
1018 int, int, int, int));
1022 #endif /* HAVE_WINDOW_SYSTEM */
1025 /***********************************************************************
1026 Window display dimensions
1027 ***********************************************************************/
1029 /* Return the bottom boundary y-position for text lines in window W.
1030 This is the first y position at which a line cannot start.
1031 It is relative to the top of the window.
1033 This is the height of W minus the height of a mode line, if any. */
1036 window_text_bottom_y (w
)
1039 int height
= WINDOW_TOTAL_HEIGHT (w
);
1041 if (WINDOW_WANTS_MODELINE_P (w
))
1042 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1046 /* Return the pixel width of display area AREA of window W. AREA < 0
1047 means return the total width of W, not including fringes to
1048 the left and right of the window. */
1051 window_box_width (w
, area
)
1055 int cols
= XFASTINT (w
->total_cols
);
1058 if (!w
->pseudo_window_p
)
1060 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1062 if (area
== TEXT_AREA
)
1064 if (INTEGERP (w
->left_margin_cols
))
1065 cols
-= XFASTINT (w
->left_margin_cols
);
1066 if (INTEGERP (w
->right_margin_cols
))
1067 cols
-= XFASTINT (w
->right_margin_cols
);
1068 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1070 else if (area
== LEFT_MARGIN_AREA
)
1072 cols
= (INTEGERP (w
->left_margin_cols
)
1073 ? XFASTINT (w
->left_margin_cols
) : 0);
1076 else if (area
== RIGHT_MARGIN_AREA
)
1078 cols
= (INTEGERP (w
->right_margin_cols
)
1079 ? XFASTINT (w
->right_margin_cols
) : 0);
1084 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1088 /* Return the pixel height of the display area of window W, not
1089 including mode lines of W, if any. */
1092 window_box_height (w
)
1095 struct frame
*f
= XFRAME (w
->frame
);
1096 int height
= WINDOW_TOTAL_HEIGHT (w
);
1098 xassert (height
>= 0);
1100 /* Note: the code below that determines the mode-line/header-line
1101 height is essentially the same as that contained in the macro
1102 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1103 the appropriate glyph row has its `mode_line_p' flag set,
1104 and if it doesn't, uses estimate_mode_line_height instead. */
1106 if (WINDOW_WANTS_MODELINE_P (w
))
1108 struct glyph_row
*ml_row
1109 = (w
->current_matrix
&& w
->current_matrix
->rows
1110 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1112 if (ml_row
&& ml_row
->mode_line_p
)
1113 height
-= ml_row
->height
;
1115 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1118 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1120 struct glyph_row
*hl_row
1121 = (w
->current_matrix
&& w
->current_matrix
->rows
1122 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1124 if (hl_row
&& hl_row
->mode_line_p
)
1125 height
-= hl_row
->height
;
1127 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1130 /* With a very small font and a mode-line that's taller than
1131 default, we might end up with a negative height. */
1132 return max (0, height
);
1135 /* Return the window-relative coordinate of the left edge of display
1136 area AREA of window W. AREA < 0 means return the left edge of the
1137 whole window, to the right of the left fringe of W. */
1140 window_box_left_offset (w
, area
)
1146 if (w
->pseudo_window_p
)
1149 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1151 if (area
== TEXT_AREA
)
1152 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1153 + window_box_width (w
, LEFT_MARGIN_AREA
));
1154 else if (area
== RIGHT_MARGIN_AREA
)
1155 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1156 + window_box_width (w
, LEFT_MARGIN_AREA
)
1157 + window_box_width (w
, TEXT_AREA
)
1158 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1160 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1161 else if (area
== LEFT_MARGIN_AREA
1162 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1163 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1169 /* Return the window-relative coordinate of the right edge of display
1170 area AREA of window W. AREA < 0 means return the left edge of the
1171 whole window, to the left of the right fringe of W. */
1174 window_box_right_offset (w
, area
)
1178 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1181 /* Return the frame-relative coordinate of the left edge of display
1182 area AREA of window W. AREA < 0 means return the left edge of the
1183 whole window, to the right of the left fringe of W. */
1186 window_box_left (w
, area
)
1190 struct frame
*f
= XFRAME (w
->frame
);
1193 if (w
->pseudo_window_p
)
1194 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1196 x
= (WINDOW_LEFT_EDGE_X (w
)
1197 + window_box_left_offset (w
, area
));
1203 /* Return the frame-relative coordinate of the right edge of display
1204 area AREA of window W. AREA < 0 means return the left edge of the
1205 whole window, to the left of the right fringe of W. */
1208 window_box_right (w
, area
)
1212 return window_box_left (w
, area
) + window_box_width (w
, area
);
1215 /* Get the bounding box of the display area AREA of window W, without
1216 mode lines, in frame-relative coordinates. AREA < 0 means the
1217 whole window, not including the left and right fringes of
1218 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1219 coordinates of the upper-left corner of the box. Return in
1220 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1223 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1226 int *box_x
, *box_y
, *box_width
, *box_height
;
1229 *box_width
= window_box_width (w
, area
);
1231 *box_height
= window_box_height (w
);
1233 *box_x
= window_box_left (w
, area
);
1236 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1237 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1238 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1243 /* Get the bounding box of the display area AREA of window W, without
1244 mode lines. AREA < 0 means the whole window, not including the
1245 left and right fringe of the window. Return in *TOP_LEFT_X
1246 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1247 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1248 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1252 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1253 bottom_right_x
, bottom_right_y
)
1256 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1258 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1260 *bottom_right_x
+= *top_left_x
;
1261 *bottom_right_y
+= *top_left_y
;
1266 /***********************************************************************
1268 ***********************************************************************/
1270 /* Return the bottom y-position of the line the iterator IT is in.
1271 This can modify IT's settings. */
1277 int line_height
= it
->max_ascent
+ it
->max_descent
;
1278 int line_top_y
= it
->current_y
;
1280 if (line_height
== 0)
1283 line_height
= last_height
;
1284 else if (IT_CHARPOS (*it
) < ZV
)
1286 move_it_by_lines (it
, 1, 1);
1287 line_height
= (it
->max_ascent
|| it
->max_descent
1288 ? it
->max_ascent
+ it
->max_descent
1293 struct glyph_row
*row
= it
->glyph_row
;
1295 /* Use the default character height. */
1296 it
->glyph_row
= NULL
;
1297 it
->what
= IT_CHARACTER
;
1300 PRODUCE_GLYPHS (it
);
1301 line_height
= it
->ascent
+ it
->descent
;
1302 it
->glyph_row
= row
;
1306 return line_top_y
+ line_height
;
1310 /* Return 1 if position CHARPOS is visible in window W.
1311 CHARPOS < 0 means return info about WINDOW_END position.
1312 If visible, set *X and *Y to pixel coordinates of top left corner.
1313 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1314 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1317 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1319 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1322 struct text_pos top
;
1324 struct buffer
*old_buffer
= NULL
;
1326 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1329 if (XBUFFER (w
->buffer
) != current_buffer
)
1331 old_buffer
= current_buffer
;
1332 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1335 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1337 /* Compute exact mode line heights. */
1338 if (WINDOW_WANTS_MODELINE_P (w
))
1339 current_mode_line_height
1340 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1341 current_buffer
->mode_line_format
);
1343 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1344 current_header_line_height
1345 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1346 current_buffer
->header_line_format
);
1348 start_display (&it
, w
, top
);
1349 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1350 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1352 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1354 /* We have reached CHARPOS, or passed it. How the call to
1355 move_it_to can overshoot: (i) If CHARPOS is on invisible
1356 text, move_it_to stops at the end of the invisible text,
1357 after CHARPOS. (ii) If CHARPOS is in a display vector,
1358 move_it_to stops on its last glyph. */
1359 int top_x
= it
.current_x
;
1360 int top_y
= it
.current_y
;
1361 enum it_method it_method
= it
.method
;
1362 /* Calling line_bottom_y may change it.method. */
1363 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1364 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1366 if (top_y
< window_top_y
)
1367 visible_p
= bottom_y
> window_top_y
;
1368 else if (top_y
< it
.last_visible_y
)
1372 if (it_method
== GET_FROM_BUFFER
)
1374 Lisp_Object window
, prop
;
1376 XSETWINDOW (window
, w
);
1377 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1378 Qinvisible
, window
);
1380 /* If charpos coincides with invisible text covered with an
1381 ellipsis, use the first glyph of the ellipsis to compute
1382 the pixel positions. */
1383 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1385 struct glyph_row
*row
= it
.glyph_row
;
1386 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1387 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1391 && (!BUFFERP (glyph
->object
)
1392 || glyph
->charpos
< charpos
);
1394 x
+= glyph
->pixel_width
;
1398 else if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1400 /* We stopped on the last glyph of a display vector.
1401 Try and recompute. Hack alert! */
1402 if (charpos
< 2 || top
.charpos
>= charpos
)
1403 top_x
= it
.glyph_row
->x
;
1407 start_display (&it2
, w
, top
);
1408 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1409 get_next_display_element (&it2
);
1410 PRODUCE_GLYPHS (&it2
);
1411 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1412 || it2
.current_x
> it2
.last_visible_x
)
1413 top_x
= it
.glyph_row
->x
;
1416 top_x
= it2
.current_x
;
1417 top_y
= it2
.current_y
;
1423 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1424 *rtop
= max (0, window_top_y
- top_y
);
1425 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1426 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1427 - max (top_y
, window_top_y
)));
1436 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1437 move_it_by_lines (&it
, 1, 0);
1438 if (charpos
< IT_CHARPOS (it
)
1439 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1442 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1444 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1445 *rtop
= max (0, -it2
.current_y
);
1446 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1447 - it
.last_visible_y
));
1448 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1450 - max (it2
.current_y
,
1451 WINDOW_HEADER_LINE_HEIGHT (w
))));
1457 set_buffer_internal_1 (old_buffer
);
1459 current_header_line_height
= current_mode_line_height
= -1;
1461 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1462 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1465 /* Debugging code. */
1467 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1468 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1470 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1477 /* Return the next character from STR which is MAXLEN bytes long.
1478 Return in *LEN the length of the character. This is like
1479 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1480 we find one, we return a `?', but with the length of the invalid
1484 string_char_and_length (str
, maxlen
, len
)
1485 const unsigned char *str
;
1490 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1491 if (!CHAR_VALID_P (c
, 1))
1492 /* We may not change the length here because other places in Emacs
1493 don't use this function, i.e. they silently accept invalid
1502 /* Given a position POS containing a valid character and byte position
1503 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1505 static struct text_pos
1506 string_pos_nchars_ahead (pos
, string
, nchars
)
1507 struct text_pos pos
;
1511 xassert (STRINGP (string
) && nchars
>= 0);
1513 if (STRING_MULTIBYTE (string
))
1515 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1516 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1521 string_char_and_length (p
, rest
, &len
);
1522 p
+= len
, rest
-= len
;
1523 xassert (rest
>= 0);
1525 BYTEPOS (pos
) += len
;
1529 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1535 /* Value is the text position, i.e. character and byte position,
1536 for character position CHARPOS in STRING. */
1538 static INLINE
struct text_pos
1539 string_pos (charpos
, string
)
1543 struct text_pos pos
;
1544 xassert (STRINGP (string
));
1545 xassert (charpos
>= 0);
1546 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1551 /* Value is a text position, i.e. character and byte position, for
1552 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1553 means recognize multibyte characters. */
1555 static struct text_pos
1556 c_string_pos (charpos
, s
, multibyte_p
)
1561 struct text_pos pos
;
1563 xassert (s
!= NULL
);
1564 xassert (charpos
>= 0);
1568 int rest
= strlen (s
), len
;
1570 SET_TEXT_POS (pos
, 0, 0);
1573 string_char_and_length (s
, rest
, &len
);
1574 s
+= len
, rest
-= len
;
1575 xassert (rest
>= 0);
1577 BYTEPOS (pos
) += len
;
1581 SET_TEXT_POS (pos
, charpos
, charpos
);
1587 /* Value is the number of characters in C string S. MULTIBYTE_P
1588 non-zero means recognize multibyte characters. */
1591 number_of_chars (s
, multibyte_p
)
1599 int rest
= strlen (s
), len
;
1600 unsigned char *p
= (unsigned char *) s
;
1602 for (nchars
= 0; rest
> 0; ++nchars
)
1604 string_char_and_length (p
, rest
, &len
);
1605 rest
-= len
, p
+= len
;
1609 nchars
= strlen (s
);
1615 /* Compute byte position NEWPOS->bytepos corresponding to
1616 NEWPOS->charpos. POS is a known position in string STRING.
1617 NEWPOS->charpos must be >= POS.charpos. */
1620 compute_string_pos (newpos
, pos
, string
)
1621 struct text_pos
*newpos
, pos
;
1624 xassert (STRINGP (string
));
1625 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1627 if (STRING_MULTIBYTE (string
))
1628 *newpos
= string_pos_nchars_ahead (pos
, string
,
1629 CHARPOS (*newpos
) - CHARPOS (pos
));
1631 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1635 Return an estimation of the pixel height of mode or top lines on
1636 frame F. FACE_ID specifies what line's height to estimate. */
1639 estimate_mode_line_height (f
, face_id
)
1641 enum face_id face_id
;
1643 #ifdef HAVE_WINDOW_SYSTEM
1644 if (FRAME_WINDOW_P (f
))
1646 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1648 /* This function is called so early when Emacs starts that the face
1649 cache and mode line face are not yet initialized. */
1650 if (FRAME_FACE_CACHE (f
))
1652 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1656 height
= FONT_HEIGHT (face
->font
);
1657 if (face
->box_line_width
> 0)
1658 height
+= 2 * face
->box_line_width
;
1669 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1670 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1671 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1672 not force the value into range. */
1675 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1677 register int pix_x
, pix_y
;
1679 NativeRectangle
*bounds
;
1683 #ifdef HAVE_WINDOW_SYSTEM
1684 if (FRAME_WINDOW_P (f
))
1686 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1687 even for negative values. */
1689 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1691 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1693 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1694 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1697 STORE_NATIVE_RECT (*bounds
,
1698 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1699 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1700 FRAME_COLUMN_WIDTH (f
) - 1,
1701 FRAME_LINE_HEIGHT (f
) - 1);
1707 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1708 pix_x
= FRAME_TOTAL_COLS (f
);
1712 else if (pix_y
> FRAME_LINES (f
))
1713 pix_y
= FRAME_LINES (f
);
1723 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1724 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1725 can't tell the positions because W's display is not up to date,
1729 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1732 int *frame_x
, *frame_y
;
1734 #ifdef HAVE_WINDOW_SYSTEM
1735 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1739 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1740 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1742 if (display_completed
)
1744 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1745 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1746 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1752 hpos
+= glyph
->pixel_width
;
1756 /* If first glyph is partially visible, its first visible position is still 0. */
1768 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1769 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1780 #ifdef HAVE_WINDOW_SYSTEM
1782 /* Find the glyph under window-relative coordinates X/Y in window W.
1783 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1784 strings. Return in *HPOS and *VPOS the row and column number of
1785 the glyph found. Return in *AREA the glyph area containing X.
1786 Value is a pointer to the glyph found or null if X/Y is not on
1787 text, or we can't tell because W's current matrix is not up to
1792 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1795 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1797 struct glyph
*glyph
, *end
;
1798 struct glyph_row
*row
= NULL
;
1801 /* Find row containing Y. Give up if some row is not enabled. */
1802 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1804 row
= MATRIX_ROW (w
->current_matrix
, i
);
1805 if (!row
->enabled_p
)
1807 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1814 /* Give up if Y is not in the window. */
1815 if (i
== w
->current_matrix
->nrows
)
1818 /* Get the glyph area containing X. */
1819 if (w
->pseudo_window_p
)
1826 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1828 *area
= LEFT_MARGIN_AREA
;
1829 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1831 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1834 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1838 *area
= RIGHT_MARGIN_AREA
;
1839 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1843 /* Find glyph containing X. */
1844 glyph
= row
->glyphs
[*area
];
1845 end
= glyph
+ row
->used
[*area
];
1847 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1849 x
-= glyph
->pixel_width
;
1859 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1862 *hpos
= glyph
- row
->glyphs
[*area
];
1868 Convert frame-relative x/y to coordinates relative to window W.
1869 Takes pseudo-windows into account. */
1872 frame_to_window_pixel_xy (w
, x
, y
)
1876 if (w
->pseudo_window_p
)
1878 /* A pseudo-window is always full-width, and starts at the
1879 left edge of the frame, plus a frame border. */
1880 struct frame
*f
= XFRAME (w
->frame
);
1881 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1882 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1886 *x
-= WINDOW_LEFT_EDGE_X (w
);
1887 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1892 Return in RECTS[] at most N clipping rectangles for glyph string S.
1893 Return the number of stored rectangles. */
1896 get_glyph_string_clip_rects (s
, rects
, n
)
1897 struct glyph_string
*s
;
1898 NativeRectangle
*rects
;
1906 if (s
->row
->full_width_p
)
1908 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1909 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1910 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1912 /* Unless displaying a mode or menu bar line, which are always
1913 fully visible, clip to the visible part of the row. */
1914 if (s
->w
->pseudo_window_p
)
1915 r
.height
= s
->row
->visible_height
;
1917 r
.height
= s
->height
;
1921 /* This is a text line that may be partially visible. */
1922 r
.x
= window_box_left (s
->w
, s
->area
);
1923 r
.width
= window_box_width (s
->w
, s
->area
);
1924 r
.height
= s
->row
->visible_height
;
1928 if (r
.x
< s
->clip_head
->x
)
1930 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1931 r
.width
-= s
->clip_head
->x
- r
.x
;
1934 r
.x
= s
->clip_head
->x
;
1937 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1939 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1940 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1945 /* If S draws overlapping rows, it's sufficient to use the top and
1946 bottom of the window for clipping because this glyph string
1947 intentionally draws over other lines. */
1948 if (s
->for_overlaps
)
1950 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1951 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1953 /* Alas, the above simple strategy does not work for the
1954 environments with anti-aliased text: if the same text is
1955 drawn onto the same place multiple times, it gets thicker.
1956 If the overlap we are processing is for the erased cursor, we
1957 take the intersection with the rectagle of the cursor. */
1958 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1960 XRectangle rc
, r_save
= r
;
1962 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1963 rc
.y
= s
->w
->phys_cursor
.y
;
1964 rc
.width
= s
->w
->phys_cursor_width
;
1965 rc
.height
= s
->w
->phys_cursor_height
;
1967 x_intersect_rectangles (&r_save
, &rc
, &r
);
1972 /* Don't use S->y for clipping because it doesn't take partially
1973 visible lines into account. For example, it can be negative for
1974 partially visible lines at the top of a window. */
1975 if (!s
->row
->full_width_p
1976 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1977 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1979 r
.y
= max (0, s
->row
->y
);
1981 /* If drawing a tool-bar window, draw it over the internal border
1982 at the top of the window. */
1983 if (WINDOWP (s
->f
->tool_bar_window
)
1984 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1985 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1988 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1990 /* If drawing the cursor, don't let glyph draw outside its
1991 advertised boundaries. Cleartype does this under some circumstances. */
1992 if (s
->hl
== DRAW_CURSOR
)
1994 struct glyph
*glyph
= s
->first_glyph
;
1999 r
.width
-= s
->x
- r
.x
;
2002 r
.width
= min (r
.width
, glyph
->pixel_width
);
2004 /* If r.y is below window bottom, ensure that we still see a cursor. */
2005 height
= min (glyph
->ascent
+ glyph
->descent
,
2006 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2007 max_y
= window_text_bottom_y (s
->w
) - height
;
2008 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2009 if (s
->ybase
- glyph
->ascent
> max_y
)
2016 /* Don't draw cursor glyph taller than our actual glyph. */
2017 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2018 if (height
< r
.height
)
2020 max_y
= r
.y
+ r
.height
;
2021 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2022 r
.height
= min (max_y
- r
.y
, height
);
2029 XRectangle r_save
= r
;
2031 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2035 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2036 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2038 #ifdef CONVERT_FROM_XRECT
2039 CONVERT_FROM_XRECT (r
, *rects
);
2047 /* If we are processing overlapping and allowed to return
2048 multiple clipping rectangles, we exclude the row of the glyph
2049 string from the clipping rectangle. This is to avoid drawing
2050 the same text on the environment with anti-aliasing. */
2051 #ifdef CONVERT_FROM_XRECT
2054 XRectangle
*rs
= rects
;
2056 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2058 if (s
->for_overlaps
& OVERLAPS_PRED
)
2061 if (r
.y
+ r
.height
> row_y
)
2064 rs
[i
].height
= row_y
- r
.y
;
2070 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2073 if (r
.y
< row_y
+ s
->row
->visible_height
)
2075 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2077 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2078 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2087 #ifdef CONVERT_FROM_XRECT
2088 for (i
= 0; i
< n
; i
++)
2089 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2096 Return in *NR the clipping rectangle for glyph string S. */
2099 get_glyph_string_clip_rect (s
, nr
)
2100 struct glyph_string
*s
;
2101 NativeRectangle
*nr
;
2103 get_glyph_string_clip_rects (s
, nr
, 1);
2108 Return the position and height of the phys cursor in window W.
2109 Set w->phys_cursor_width to width of phys cursor.
2113 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2115 struct glyph_row
*row
;
2116 struct glyph
*glyph
;
2117 int *xp
, *yp
, *heightp
;
2119 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2120 int x
, y
, wd
, h
, h0
, y0
;
2122 /* Compute the width of the rectangle to draw. If on a stretch
2123 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2124 rectangle as wide as the glyph, but use a canonical character
2126 wd
= glyph
->pixel_width
- 1;
2127 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2131 x
= w
->phys_cursor
.x
;
2138 if (glyph
->type
== STRETCH_GLYPH
2139 && !x_stretch_cursor_p
)
2140 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2141 w
->phys_cursor_width
= wd
;
2143 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2145 /* If y is below window bottom, ensure that we still see a cursor. */
2146 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2148 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2149 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2151 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2154 h
= max (h
- (y0
- y
) + 1, h0
);
2159 y0
= window_text_bottom_y (w
) - h0
;
2167 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2168 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2173 * Remember which glyph the mouse is over.
2177 remember_mouse_glyph (f
, gx
, gy
, rect
)
2180 NativeRectangle
*rect
;
2184 struct glyph_row
*r
, *gr
, *end_row
;
2185 enum window_part part
;
2186 enum glyph_row_area area
;
2187 int x
, y
, width
, height
;
2189 /* Try to determine frame pixel position and size of the glyph under
2190 frame pixel coordinates X/Y on frame F. */
2192 if (!f
->glyphs_initialized_p
2193 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2196 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2197 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2201 w
= XWINDOW (window
);
2202 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2203 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2205 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2206 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2208 if (w
->pseudo_window_p
)
2211 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2217 case ON_LEFT_MARGIN
:
2218 area
= LEFT_MARGIN_AREA
;
2221 case ON_RIGHT_MARGIN
:
2222 area
= RIGHT_MARGIN_AREA
;
2225 case ON_HEADER_LINE
:
2227 gr
= (part
== ON_HEADER_LINE
2228 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2229 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2232 goto text_glyph_row_found
;
2239 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2240 if (r
->y
+ r
->height
> y
)
2246 text_glyph_row_found
:
2249 struct glyph
*g
= gr
->glyphs
[area
];
2250 struct glyph
*end
= g
+ gr
->used
[area
];
2252 height
= gr
->height
;
2253 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2254 if (gx
+ g
->pixel_width
> x
)
2259 if (g
->type
== IMAGE_GLYPH
)
2261 /* Don't remember when mouse is over image, as
2262 image may have hot-spots. */
2263 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2266 width
= g
->pixel_width
;
2270 /* Use nominal char spacing at end of line. */
2272 gx
+= (x
/ width
) * width
;
2275 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2276 gx
+= window_box_left_offset (w
, area
);
2280 /* Use nominal line height at end of window. */
2281 gx
= (x
/ width
) * width
;
2283 gy
+= (y
/ height
) * height
;
2287 case ON_LEFT_FRINGE
:
2288 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2289 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2290 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2291 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2294 case ON_RIGHT_FRINGE
:
2295 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2296 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2297 : window_box_right_offset (w
, TEXT_AREA
));
2298 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2302 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2304 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2305 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2306 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2308 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2312 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2313 if (r
->y
+ r
->height
> y
)
2320 height
= gr
->height
;
2323 /* Use nominal line height at end of window. */
2325 gy
+= (y
/ height
) * height
;
2332 /* If there is no glyph under the mouse, then we divide the screen
2333 into a grid of the smallest glyph in the frame, and use that
2336 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2337 round down even for negative values. */
2343 gx
= (gx
/ width
) * width
;
2344 gy
= (gy
/ height
) * height
;
2349 gx
+= WINDOW_LEFT_EDGE_X (w
);
2350 gy
+= WINDOW_TOP_EDGE_Y (w
);
2353 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2355 /* Visible feedback for debugging. */
2358 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2359 f
->output_data
.x
->normal_gc
,
2360 gx
, gy
, width
, height
);
2366 #endif /* HAVE_WINDOW_SYSTEM */
2369 /***********************************************************************
2370 Lisp form evaluation
2371 ***********************************************************************/
2373 /* Error handler for safe_eval and safe_call. */
2376 safe_eval_handler (arg
)
2379 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2384 /* Evaluate SEXPR and return the result, or nil if something went
2385 wrong. Prevent redisplay during the evaluation. */
2387 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2388 Return the result, or nil if something went wrong. Prevent
2389 redisplay during the evaluation. */
2392 safe_call (nargs
, args
)
2398 if (inhibit_eval_during_redisplay
)
2402 int count
= SPECPDL_INDEX ();
2403 struct gcpro gcpro1
;
2406 gcpro1
.nvars
= nargs
;
2407 specbind (Qinhibit_redisplay
, Qt
);
2408 /* Use Qt to ensure debugger does not run,
2409 so there is no possibility of wanting to redisplay. */
2410 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2413 val
= unbind_to (count
, val
);
2420 /* Call function FN with one argument ARG.
2421 Return the result, or nil if something went wrong. */
2424 safe_call1 (fn
, arg
)
2425 Lisp_Object fn
, arg
;
2427 Lisp_Object args
[2];
2430 return safe_call (2, args
);
2433 static Lisp_Object Qeval
;
2436 safe_eval (Lisp_Object sexpr
)
2438 return safe_call1 (Qeval
, sexpr
);
2441 /* Call function FN with one argument ARG.
2442 Return the result, or nil if something went wrong. */
2445 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2447 Lisp_Object args
[3];
2451 return safe_call (3, args
);
2456 /***********************************************************************
2458 ***********************************************************************/
2462 /* Define CHECK_IT to perform sanity checks on iterators.
2463 This is for debugging. It is too slow to do unconditionally. */
2469 if (it
->method
== GET_FROM_STRING
)
2471 xassert (STRINGP (it
->string
));
2472 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2476 xassert (IT_STRING_CHARPOS (*it
) < 0);
2477 if (it
->method
== GET_FROM_BUFFER
)
2479 /* Check that character and byte positions agree. */
2480 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2485 xassert (it
->current
.dpvec_index
>= 0);
2487 xassert (it
->current
.dpvec_index
< 0);
2490 #define CHECK_IT(IT) check_it ((IT))
2494 #define CHECK_IT(IT) (void) 0
2501 /* Check that the window end of window W is what we expect it
2502 to be---the last row in the current matrix displaying text. */
2505 check_window_end (w
)
2508 if (!MINI_WINDOW_P (w
)
2509 && !NILP (w
->window_end_valid
))
2511 struct glyph_row
*row
;
2512 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2513 XFASTINT (w
->window_end_vpos
)),
2515 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2516 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2520 #define CHECK_WINDOW_END(W) check_window_end ((W))
2522 #else /* not GLYPH_DEBUG */
2524 #define CHECK_WINDOW_END(W) (void) 0
2526 #endif /* not GLYPH_DEBUG */
2530 /***********************************************************************
2531 Iterator initialization
2532 ***********************************************************************/
2534 /* Initialize IT for displaying current_buffer in window W, starting
2535 at character position CHARPOS. CHARPOS < 0 means that no buffer
2536 position is specified which is useful when the iterator is assigned
2537 a position later. BYTEPOS is the byte position corresponding to
2538 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2540 If ROW is not null, calls to produce_glyphs with IT as parameter
2541 will produce glyphs in that row.
2543 BASE_FACE_ID is the id of a base face to use. It must be one of
2544 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2545 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2546 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2548 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2549 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2550 will be initialized to use the corresponding mode line glyph row of
2551 the desired matrix of W. */
2554 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2557 int charpos
, bytepos
;
2558 struct glyph_row
*row
;
2559 enum face_id base_face_id
;
2561 int highlight_region_p
;
2562 enum face_id remapped_base_face_id
= base_face_id
;
2564 /* Some precondition checks. */
2565 xassert (w
!= NULL
&& it
!= NULL
);
2566 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2569 /* If face attributes have been changed since the last redisplay,
2570 free realized faces now because they depend on face definitions
2571 that might have changed. Don't free faces while there might be
2572 desired matrices pending which reference these faces. */
2573 if (face_change_count
&& !inhibit_free_realized_faces
)
2575 face_change_count
= 0;
2576 free_all_realized_faces (Qnil
);
2579 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2580 if (! NILP (Vface_remapping_alist
))
2581 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2583 /* Use one of the mode line rows of W's desired matrix if
2587 if (base_face_id
== MODE_LINE_FACE_ID
2588 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2589 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2590 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2591 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2595 bzero (it
, sizeof *it
);
2596 it
->current
.overlay_string_index
= -1;
2597 it
->current
.dpvec_index
= -1;
2598 it
->base_face_id
= remapped_base_face_id
;
2600 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2602 /* The window in which we iterate over current_buffer: */
2603 XSETWINDOW (it
->window
, w
);
2605 it
->f
= XFRAME (w
->frame
);
2609 /* Extra space between lines (on window systems only). */
2610 if (base_face_id
== DEFAULT_FACE_ID
2611 && FRAME_WINDOW_P (it
->f
))
2613 if (NATNUMP (current_buffer
->extra_line_spacing
))
2614 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2615 else if (FLOATP (current_buffer
->extra_line_spacing
))
2616 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2617 * FRAME_LINE_HEIGHT (it
->f
));
2618 else if (it
->f
->extra_line_spacing
> 0)
2619 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2620 it
->max_extra_line_spacing
= 0;
2623 /* If realized faces have been removed, e.g. because of face
2624 attribute changes of named faces, recompute them. When running
2625 in batch mode, the face cache of the initial frame is null. If
2626 we happen to get called, make a dummy face cache. */
2627 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2628 init_frame_faces (it
->f
);
2629 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2630 recompute_basic_faces (it
->f
);
2632 /* Current value of the `slice', `space-width', and 'height' properties. */
2633 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2634 it
->space_width
= Qnil
;
2635 it
->font_height
= Qnil
;
2636 it
->override_ascent
= -1;
2638 /* Are control characters displayed as `^C'? */
2639 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2641 /* -1 means everything between a CR and the following line end
2642 is invisible. >0 means lines indented more than this value are
2644 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2645 ? XFASTINT (current_buffer
->selective_display
)
2646 : (!NILP (current_buffer
->selective_display
)
2648 it
->selective_display_ellipsis_p
2649 = !NILP (current_buffer
->selective_display_ellipses
);
2651 /* Display table to use. */
2652 it
->dp
= window_display_table (w
);
2654 /* Are multibyte characters enabled in current_buffer? */
2655 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2657 /* Non-zero if we should highlight the region. */
2659 = (!NILP (Vtransient_mark_mode
)
2660 && !NILP (current_buffer
->mark_active
)
2661 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2663 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2664 start and end of a visible region in window IT->w. Set both to
2665 -1 to indicate no region. */
2666 if (highlight_region_p
2667 /* Maybe highlight only in selected window. */
2668 && (/* Either show region everywhere. */
2669 highlight_nonselected_windows
2670 /* Or show region in the selected window. */
2671 || w
== XWINDOW (selected_window
)
2672 /* Or show the region if we are in the mini-buffer and W is
2673 the window the mini-buffer refers to. */
2674 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2675 && WINDOWP (minibuf_selected_window
)
2676 && w
== XWINDOW (minibuf_selected_window
))))
2678 int charpos
= marker_position (current_buffer
->mark
);
2679 it
->region_beg_charpos
= min (PT
, charpos
);
2680 it
->region_end_charpos
= max (PT
, charpos
);
2683 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2685 /* Get the position at which the redisplay_end_trigger hook should
2686 be run, if it is to be run at all. */
2687 if (MARKERP (w
->redisplay_end_trigger
)
2688 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2689 it
->redisplay_end_trigger_charpos
2690 = marker_position (w
->redisplay_end_trigger
);
2691 else if (INTEGERP (w
->redisplay_end_trigger
))
2692 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2694 /* Correct bogus values of tab_width. */
2695 it
->tab_width
= XINT (current_buffer
->tab_width
);
2696 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2699 /* Are lines in the display truncated? */
2700 if (base_face_id
!= DEFAULT_FACE_ID
2701 || XINT (it
->w
->hscroll
)
2702 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2703 && ((!NILP (Vtruncate_partial_width_windows
)
2704 && !INTEGERP (Vtruncate_partial_width_windows
))
2705 || (INTEGERP (Vtruncate_partial_width_windows
)
2706 && (WINDOW_TOTAL_COLS (it
->w
)
2707 < XINT (Vtruncate_partial_width_windows
))))))
2708 it
->line_wrap
= TRUNCATE
;
2709 else if (NILP (current_buffer
->truncate_lines
))
2710 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2711 ? WINDOW_WRAP
: WORD_WRAP
;
2713 it
->line_wrap
= TRUNCATE
;
2715 /* Get dimensions of truncation and continuation glyphs. These are
2716 displayed as fringe bitmaps under X, so we don't need them for such
2718 if (!FRAME_WINDOW_P (it
->f
))
2720 if (it
->line_wrap
== TRUNCATE
)
2722 /* We will need the truncation glyph. */
2723 xassert (it
->glyph_row
== NULL
);
2724 produce_special_glyphs (it
, IT_TRUNCATION
);
2725 it
->truncation_pixel_width
= it
->pixel_width
;
2729 /* We will need the continuation glyph. */
2730 xassert (it
->glyph_row
== NULL
);
2731 produce_special_glyphs (it
, IT_CONTINUATION
);
2732 it
->continuation_pixel_width
= it
->pixel_width
;
2735 /* Reset these values to zero because the produce_special_glyphs
2736 above has changed them. */
2737 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2738 it
->phys_ascent
= it
->phys_descent
= 0;
2741 /* Set this after getting the dimensions of truncation and
2742 continuation glyphs, so that we don't produce glyphs when calling
2743 produce_special_glyphs, above. */
2744 it
->glyph_row
= row
;
2745 it
->area
= TEXT_AREA
;
2747 /* Get the dimensions of the display area. The display area
2748 consists of the visible window area plus a horizontally scrolled
2749 part to the left of the window. All x-values are relative to the
2750 start of this total display area. */
2751 if (base_face_id
!= DEFAULT_FACE_ID
)
2753 /* Mode lines, menu bar in terminal frames. */
2754 it
->first_visible_x
= 0;
2755 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2760 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2761 it
->last_visible_x
= (it
->first_visible_x
2762 + window_box_width (w
, TEXT_AREA
));
2764 /* If we truncate lines, leave room for the truncator glyph(s) at
2765 the right margin. Otherwise, leave room for the continuation
2766 glyph(s). Truncation and continuation glyphs are not inserted
2767 for window-based redisplay. */
2768 if (!FRAME_WINDOW_P (it
->f
))
2770 if (it
->line_wrap
== TRUNCATE
)
2771 it
->last_visible_x
-= it
->truncation_pixel_width
;
2773 it
->last_visible_x
-= it
->continuation_pixel_width
;
2776 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2777 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2780 /* Leave room for a border glyph. */
2781 if (!FRAME_WINDOW_P (it
->f
)
2782 && !WINDOW_RIGHTMOST_P (it
->w
))
2783 it
->last_visible_x
-= 1;
2785 it
->last_visible_y
= window_text_bottom_y (w
);
2787 /* For mode lines and alike, arrange for the first glyph having a
2788 left box line if the face specifies a box. */
2789 if (base_face_id
!= DEFAULT_FACE_ID
)
2793 it
->face_id
= remapped_base_face_id
;
2795 /* If we have a boxed mode line, make the first character appear
2796 with a left box line. */
2797 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2798 if (face
->box
!= FACE_NO_BOX
)
2799 it
->start_of_box_run_p
= 1;
2802 /* If a buffer position was specified, set the iterator there,
2803 getting overlays and face properties from that position. */
2804 if (charpos
>= BUF_BEG (current_buffer
))
2806 it
->end_charpos
= ZV
;
2808 IT_CHARPOS (*it
) = charpos
;
2810 /* Compute byte position if not specified. */
2811 if (bytepos
< charpos
)
2812 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2814 IT_BYTEPOS (*it
) = bytepos
;
2816 it
->start
= it
->current
;
2818 /* Compute faces etc. */
2819 reseat (it
, it
->current
.pos
, 1);
2826 /* Initialize IT for the display of window W with window start POS. */
2829 start_display (it
, w
, pos
)
2832 struct text_pos pos
;
2834 struct glyph_row
*row
;
2835 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2837 row
= w
->desired_matrix
->rows
+ first_vpos
;
2838 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2839 it
->first_vpos
= first_vpos
;
2841 /* Don't reseat to previous visible line start if current start
2842 position is in a string or image. */
2843 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2845 int start_at_line_beg_p
;
2846 int first_y
= it
->current_y
;
2848 /* If window start is not at a line start, skip forward to POS to
2849 get the correct continuation lines width. */
2850 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2851 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2852 if (!start_at_line_beg_p
)
2856 reseat_at_previous_visible_line_start (it
);
2857 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2859 new_x
= it
->current_x
+ it
->pixel_width
;
2861 /* If lines are continued, this line may end in the middle
2862 of a multi-glyph character (e.g. a control character
2863 displayed as \003, or in the middle of an overlay
2864 string). In this case move_it_to above will not have
2865 taken us to the start of the continuation line but to the
2866 end of the continued line. */
2867 if (it
->current_x
> 0
2868 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2869 && (/* And glyph doesn't fit on the line. */
2870 new_x
> it
->last_visible_x
2871 /* Or it fits exactly and we're on a window
2873 || (new_x
== it
->last_visible_x
2874 && FRAME_WINDOW_P (it
->f
))))
2876 if (it
->current
.dpvec_index
>= 0
2877 || it
->current
.overlay_string_index
>= 0)
2879 set_iterator_to_next (it
, 1);
2880 move_it_in_display_line_to (it
, -1, -1, 0);
2883 it
->continuation_lines_width
+= it
->current_x
;
2886 /* We're starting a new display line, not affected by the
2887 height of the continued line, so clear the appropriate
2888 fields in the iterator structure. */
2889 it
->max_ascent
= it
->max_descent
= 0;
2890 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2892 it
->current_y
= first_y
;
2894 it
->current_x
= it
->hpos
= 0;
2898 #if 0 /* Don't assert the following because start_display is sometimes
2899 called intentionally with a window start that is not at a
2900 line start. Please leave this code in as a comment. */
2902 /* Window start should be on a line start, now. */
2903 xassert (it
->continuation_lines_width
2904 || IT_CHARPOS (it
) == BEGV
2905 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2910 /* Return 1 if POS is a position in ellipses displayed for invisible
2911 text. W is the window we display, for text property lookup. */
2914 in_ellipses_for_invisible_text_p (pos
, w
)
2915 struct display_pos
*pos
;
2918 Lisp_Object prop
, window
;
2920 int charpos
= CHARPOS (pos
->pos
);
2922 /* If POS specifies a position in a display vector, this might
2923 be for an ellipsis displayed for invisible text. We won't
2924 get the iterator set up for delivering that ellipsis unless
2925 we make sure that it gets aware of the invisible text. */
2926 if (pos
->dpvec_index
>= 0
2927 && pos
->overlay_string_index
< 0
2928 && CHARPOS (pos
->string_pos
) < 0
2930 && (XSETWINDOW (window
, w
),
2931 prop
= Fget_char_property (make_number (charpos
),
2932 Qinvisible
, window
),
2933 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2935 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2937 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2944 /* Initialize IT for stepping through current_buffer in window W,
2945 starting at position POS that includes overlay string and display
2946 vector/ control character translation position information. Value
2947 is zero if there are overlay strings with newlines at POS. */
2950 init_from_display_pos (it
, w
, pos
)
2953 struct display_pos
*pos
;
2955 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2956 int i
, overlay_strings_with_newlines
= 0;
2958 /* If POS specifies a position in a display vector, this might
2959 be for an ellipsis displayed for invisible text. We won't
2960 get the iterator set up for delivering that ellipsis unless
2961 we make sure that it gets aware of the invisible text. */
2962 if (in_ellipses_for_invisible_text_p (pos
, w
))
2968 /* Keep in mind: the call to reseat in init_iterator skips invisible
2969 text, so we might end up at a position different from POS. This
2970 is only a problem when POS is a row start after a newline and an
2971 overlay starts there with an after-string, and the overlay has an
2972 invisible property. Since we don't skip invisible text in
2973 display_line and elsewhere immediately after consuming the
2974 newline before the row start, such a POS will not be in a string,
2975 but the call to init_iterator below will move us to the
2977 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2979 /* This only scans the current chunk -- it should scan all chunks.
2980 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2981 to 16 in 22.1 to make this a lesser problem. */
2982 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2984 const char *s
= SDATA (it
->overlay_strings
[i
]);
2985 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2987 while (s
< e
&& *s
!= '\n')
2992 overlay_strings_with_newlines
= 1;
2997 /* If position is within an overlay string, set up IT to the right
2999 if (pos
->overlay_string_index
>= 0)
3003 /* If the first overlay string happens to have a `display'
3004 property for an image, the iterator will be set up for that
3005 image, and we have to undo that setup first before we can
3006 correct the overlay string index. */
3007 if (it
->method
== GET_FROM_IMAGE
)
3010 /* We already have the first chunk of overlay strings in
3011 IT->overlay_strings. Load more until the one for
3012 pos->overlay_string_index is in IT->overlay_strings. */
3013 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3015 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3016 it
->current
.overlay_string_index
= 0;
3019 load_overlay_strings (it
, 0);
3020 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3024 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3025 relative_index
= (it
->current
.overlay_string_index
3026 % OVERLAY_STRING_CHUNK_SIZE
);
3027 it
->string
= it
->overlay_strings
[relative_index
];
3028 xassert (STRINGP (it
->string
));
3029 it
->current
.string_pos
= pos
->string_pos
;
3030 it
->method
= GET_FROM_STRING
;
3033 if (CHARPOS (pos
->string_pos
) >= 0)
3035 /* Recorded position is not in an overlay string, but in another
3036 string. This can only be a string from a `display' property.
3037 IT should already be filled with that string. */
3038 it
->current
.string_pos
= pos
->string_pos
;
3039 xassert (STRINGP (it
->string
));
3042 /* Restore position in display vector translations, control
3043 character translations or ellipses. */
3044 if (pos
->dpvec_index
>= 0)
3046 if (it
->dpvec
== NULL
)
3047 get_next_display_element (it
);
3048 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3049 it
->current
.dpvec_index
= pos
->dpvec_index
;
3053 return !overlay_strings_with_newlines
;
3057 /* Initialize IT for stepping through current_buffer in window W
3058 starting at ROW->start. */
3061 init_to_row_start (it
, w
, row
)
3064 struct glyph_row
*row
;
3066 init_from_display_pos (it
, w
, &row
->start
);
3067 it
->start
= row
->start
;
3068 it
->continuation_lines_width
= row
->continuation_lines_width
;
3073 /* Initialize IT for stepping through current_buffer in window W
3074 starting in the line following ROW, i.e. starting at ROW->end.
3075 Value is zero if there are overlay strings with newlines at ROW's
3079 init_to_row_end (it
, w
, row
)
3082 struct glyph_row
*row
;
3086 if (init_from_display_pos (it
, w
, &row
->end
))
3088 if (row
->continued_p
)
3089 it
->continuation_lines_width
3090 = row
->continuation_lines_width
+ row
->pixel_width
;
3101 /***********************************************************************
3103 ***********************************************************************/
3105 /* Called when IT reaches IT->stop_charpos. Handle text property and
3106 overlay changes. Set IT->stop_charpos to the next position where
3113 enum prop_handled handled
;
3114 int handle_overlay_change_p
;
3118 it
->current
.dpvec_index
= -1;
3119 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3120 it
->ignore_overlay_strings_at_pos_p
= 0;
3123 /* Use face of preceding text for ellipsis (if invisible) */
3124 if (it
->selective_display_ellipsis_p
)
3125 it
->saved_face_id
= it
->face_id
;
3129 handled
= HANDLED_NORMALLY
;
3131 /* Call text property handlers. */
3132 for (p
= it_props
; p
->handler
; ++p
)
3134 handled
= p
->handler (it
);
3136 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3138 else if (handled
== HANDLED_RETURN
)
3140 /* We still want to show before and after strings from
3141 overlays even if the actual buffer text is replaced. */
3142 if (!handle_overlay_change_p
3144 || !get_overlay_strings_1 (it
, 0, 0))
3147 setup_for_ellipsis (it
, 0);
3148 /* When handling a display spec, we might load an
3149 empty string. In that case, discard it here. We
3150 used to discard it in handle_single_display_spec,
3151 but that causes get_overlay_strings_1, above, to
3152 ignore overlay strings that we must check. */
3153 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3157 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3161 it
->ignore_overlay_strings_at_pos_p
= 1;
3162 it
->string_from_display_prop_p
= 0;
3163 handle_overlay_change_p
= 0;
3165 handled
= HANDLED_RECOMPUTE_PROPS
;
3168 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3169 handle_overlay_change_p
= 0;
3172 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3174 /* Don't check for overlay strings below when set to deliver
3175 characters from a display vector. */
3176 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3177 handle_overlay_change_p
= 0;
3179 /* Handle overlay changes.
3180 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3181 if it finds overlays. */
3182 if (handle_overlay_change_p
)
3183 handled
= handle_overlay_change (it
);
3188 setup_for_ellipsis (it
, 0);
3192 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3194 /* Determine where to stop next. */
3195 if (handled
== HANDLED_NORMALLY
)
3196 compute_stop_pos (it
);
3200 /* Compute IT->stop_charpos from text property and overlay change
3201 information for IT's current position. */
3204 compute_stop_pos (it
)
3207 register INTERVAL iv
, next_iv
;
3208 Lisp_Object object
, limit
, position
;
3209 EMACS_INT charpos
, bytepos
;
3211 /* If nowhere else, stop at the end. */
3212 it
->stop_charpos
= it
->end_charpos
;
3214 if (STRINGP (it
->string
))
3216 /* Strings are usually short, so don't limit the search for
3218 object
= it
->string
;
3220 charpos
= IT_STRING_CHARPOS (*it
);
3221 bytepos
= IT_STRING_BYTEPOS (*it
);
3227 /* If next overlay change is in front of the current stop pos
3228 (which is IT->end_charpos), stop there. Note: value of
3229 next_overlay_change is point-max if no overlay change
3231 charpos
= IT_CHARPOS (*it
);
3232 bytepos
= IT_BYTEPOS (*it
);
3233 pos
= next_overlay_change (charpos
);
3234 if (pos
< it
->stop_charpos
)
3235 it
->stop_charpos
= pos
;
3237 /* If showing the region, we have to stop at the region
3238 start or end because the face might change there. */
3239 if (it
->region_beg_charpos
> 0)
3241 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3242 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3243 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3244 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3247 /* Set up variables for computing the stop position from text
3248 property changes. */
3249 XSETBUFFER (object
, current_buffer
);
3250 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3253 /* Get the interval containing IT's position. Value is a null
3254 interval if there isn't such an interval. */
3255 position
= make_number (charpos
);
3256 iv
= validate_interval_range (object
, &position
, &position
, 0);
3257 if (!NULL_INTERVAL_P (iv
))
3259 Lisp_Object values_here
[LAST_PROP_IDX
];
3262 /* Get properties here. */
3263 for (p
= it_props
; p
->handler
; ++p
)
3264 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3266 /* Look for an interval following iv that has different
3268 for (next_iv
= next_interval (iv
);
3269 (!NULL_INTERVAL_P (next_iv
)
3271 || XFASTINT (limit
) > next_iv
->position
));
3272 next_iv
= next_interval (next_iv
))
3274 for (p
= it_props
; p
->handler
; ++p
)
3276 Lisp_Object new_value
;
3278 new_value
= textget (next_iv
->plist
, *p
->name
);
3279 if (!EQ (values_here
[p
->idx
], new_value
))
3287 if (!NULL_INTERVAL_P (next_iv
))
3289 if (INTEGERP (limit
)
3290 && next_iv
->position
>= XFASTINT (limit
))
3291 /* No text property change up to limit. */
3292 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3294 /* Text properties change in next_iv. */
3295 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3299 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3300 it
->stop_charpos
, it
->string
);
3302 xassert (STRINGP (it
->string
)
3303 || (it
->stop_charpos
>= BEGV
3304 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3308 /* Return the position of the next overlay change after POS in
3309 current_buffer. Value is point-max if no overlay change
3310 follows. This is like `next-overlay-change' but doesn't use
3314 next_overlay_change (pos
)
3319 Lisp_Object
*overlays
;
3322 /* Get all overlays at the given position. */
3323 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3325 /* If any of these overlays ends before endpos,
3326 use its ending point instead. */
3327 for (i
= 0; i
< noverlays
; ++i
)
3332 oend
= OVERLAY_END (overlays
[i
]);
3333 oendpos
= OVERLAY_POSITION (oend
);
3334 endpos
= min (endpos
, oendpos
);
3342 /***********************************************************************
3344 ***********************************************************************/
3346 /* Handle changes in the `fontified' property of the current buffer by
3347 calling hook functions from Qfontification_functions to fontify
3350 static enum prop_handled
3351 handle_fontified_prop (it
)
3354 Lisp_Object prop
, pos
;
3355 enum prop_handled handled
= HANDLED_NORMALLY
;
3357 if (!NILP (Vmemory_full
))
3360 /* Get the value of the `fontified' property at IT's current buffer
3361 position. (The `fontified' property doesn't have a special
3362 meaning in strings.) If the value is nil, call functions from
3363 Qfontification_functions. */
3364 if (!STRINGP (it
->string
)
3366 && !NILP (Vfontification_functions
)
3367 && !NILP (Vrun_hooks
)
3368 && (pos
= make_number (IT_CHARPOS (*it
)),
3369 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3370 /* Ignore the special cased nil value always present at EOB since
3371 no amount of fontifying will be able to change it. */
3372 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3374 int count
= SPECPDL_INDEX ();
3377 val
= Vfontification_functions
;
3378 specbind (Qfontification_functions
, Qnil
);
3380 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3381 safe_call1 (val
, pos
);
3384 Lisp_Object globals
, fn
;
3385 struct gcpro gcpro1
, gcpro2
;
3388 GCPRO2 (val
, globals
);
3390 for (; CONSP (val
); val
= XCDR (val
))
3396 /* A value of t indicates this hook has a local
3397 binding; it means to run the global binding too.
3398 In a global value, t should not occur. If it
3399 does, we must ignore it to avoid an endless
3401 for (globals
= Fdefault_value (Qfontification_functions
);
3403 globals
= XCDR (globals
))
3405 fn
= XCAR (globals
);
3407 safe_call1 (fn
, pos
);
3411 safe_call1 (fn
, pos
);
3417 unbind_to (count
, Qnil
);
3419 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3420 something. This avoids an endless loop if they failed to
3421 fontify the text for which reason ever. */
3422 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3423 handled
= HANDLED_RECOMPUTE_PROPS
;
3431 /***********************************************************************
3433 ***********************************************************************/
3435 /* Set up iterator IT from face properties at its current position.
3436 Called from handle_stop. */
3438 static enum prop_handled
3439 handle_face_prop (it
)
3443 EMACS_INT next_stop
;
3445 if (!STRINGP (it
->string
))
3448 = face_at_buffer_position (it
->w
,
3450 it
->region_beg_charpos
,
3451 it
->region_end_charpos
,
3454 + TEXT_PROP_DISTANCE_LIMIT
),
3455 0, it
->base_face_id
);
3457 /* Is this a start of a run of characters with box face?
3458 Caveat: this can be called for a freshly initialized
3459 iterator; face_id is -1 in this case. We know that the new
3460 face will not change until limit, i.e. if the new face has a
3461 box, all characters up to limit will have one. But, as
3462 usual, we don't know whether limit is really the end. */
3463 if (new_face_id
!= it
->face_id
)
3465 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3467 /* If new face has a box but old face has not, this is
3468 the start of a run of characters with box, i.e. it has
3469 a shadow on the left side. The value of face_id of the
3470 iterator will be -1 if this is the initial call that gets
3471 the face. In this case, we have to look in front of IT's
3472 position and see whether there is a face != new_face_id. */
3473 it
->start_of_box_run_p
3474 = (new_face
->box
!= FACE_NO_BOX
3475 && (it
->face_id
>= 0
3476 || IT_CHARPOS (*it
) == BEG
3477 || new_face_id
!= face_before_it_pos (it
)));
3478 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3483 int base_face_id
, bufpos
;
3485 Lisp_Object from_overlay
3486 = (it
->current
.overlay_string_index
>= 0
3487 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3490 /* See if we got to this string directly or indirectly from
3491 an overlay property. That includes the before-string or
3492 after-string of an overlay, strings in display properties
3493 provided by an overlay, their text properties, etc.
3495 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3496 if (! NILP (from_overlay
))
3497 for (i
= it
->sp
- 1; i
>= 0; i
--)
3499 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3501 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3502 else if (! NILP (it
->stack
[i
].from_overlay
))
3503 from_overlay
= it
->stack
[i
].from_overlay
;
3505 if (!NILP (from_overlay
))
3509 if (! NILP (from_overlay
))
3511 bufpos
= IT_CHARPOS (*it
);
3512 /* For a string from an overlay, the base face depends
3513 only on text properties and ignores overlays. */
3515 = face_for_overlay_string (it
->w
,
3517 it
->region_beg_charpos
,
3518 it
->region_end_charpos
,
3521 + TEXT_PROP_DISTANCE_LIMIT
),
3529 /* For strings from a `display' property, use the face at
3530 IT's current buffer position as the base face to merge
3531 with, so that overlay strings appear in the same face as
3532 surrounding text, unless they specify their own
3534 base_face_id
= underlying_face_id (it
);
3537 new_face_id
= face_at_string_position (it
->w
,
3539 IT_STRING_CHARPOS (*it
),
3541 it
->region_beg_charpos
,
3542 it
->region_end_charpos
,
3546 #if 0 /* This shouldn't be neccessary. Let's check it. */
3547 /* If IT is used to display a mode line we would really like to
3548 use the mode line face instead of the frame's default face. */
3549 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3550 && new_face_id
== DEFAULT_FACE_ID
)
3551 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3554 /* Is this a start of a run of characters with box? Caveat:
3555 this can be called for a freshly allocated iterator; face_id
3556 is -1 is this case. We know that the new face will not
3557 change until the next check pos, i.e. if the new face has a
3558 box, all characters up to that position will have a
3559 box. But, as usual, we don't know whether that position
3560 is really the end. */
3561 if (new_face_id
!= it
->face_id
)
3563 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3564 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3566 /* If new face has a box but old face hasn't, this is the
3567 start of a run of characters with box, i.e. it has a
3568 shadow on the left side. */
3569 it
->start_of_box_run_p
3570 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3571 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3575 it
->face_id
= new_face_id
;
3576 return HANDLED_NORMALLY
;
3580 /* Return the ID of the face ``underlying'' IT's current position,
3581 which is in a string. If the iterator is associated with a
3582 buffer, return the face at IT's current buffer position.
3583 Otherwise, use the iterator's base_face_id. */
3586 underlying_face_id (it
)
3589 int face_id
= it
->base_face_id
, i
;
3591 xassert (STRINGP (it
->string
));
3593 for (i
= it
->sp
- 1; i
>= 0; --i
)
3594 if (NILP (it
->stack
[i
].string
))
3595 face_id
= it
->stack
[i
].face_id
;
3601 /* Compute the face one character before or after the current position
3602 of IT. BEFORE_P non-zero means get the face in front of IT's
3603 position. Value is the id of the face. */
3606 face_before_or_after_it_pos (it
, before_p
)
3611 EMACS_INT next_check_charpos
;
3612 struct text_pos pos
;
3614 xassert (it
->s
== NULL
);
3616 if (STRINGP (it
->string
))
3618 int bufpos
, base_face_id
;
3620 /* No face change past the end of the string (for the case
3621 we are padding with spaces). No face change before the
3623 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3624 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3627 /* Set pos to the position before or after IT's current position. */
3629 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3631 /* For composition, we must check the character after the
3633 pos
= (it
->what
== IT_COMPOSITION
3634 ? string_pos (IT_STRING_CHARPOS (*it
)
3635 + it
->cmp_it
.nchars
, it
->string
)
3636 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3638 if (it
->current
.overlay_string_index
>= 0)
3639 bufpos
= IT_CHARPOS (*it
);
3643 base_face_id
= underlying_face_id (it
);
3645 /* Get the face for ASCII, or unibyte. */
3646 face_id
= face_at_string_position (it
->w
,
3650 it
->region_beg_charpos
,
3651 it
->region_end_charpos
,
3652 &next_check_charpos
,
3655 /* Correct the face for charsets different from ASCII. Do it
3656 for the multibyte case only. The face returned above is
3657 suitable for unibyte text if IT->string is unibyte. */
3658 if (STRING_MULTIBYTE (it
->string
))
3660 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3661 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3663 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3665 c
= string_char_and_length (p
, rest
, &len
);
3666 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3671 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3672 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3675 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3676 pos
= it
->current
.pos
;
3679 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3682 if (it
->what
== IT_COMPOSITION
)
3683 /* For composition, we must check the position after the
3685 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3687 INC_TEXT_POS (pos
, it
->multibyte_p
);
3690 /* Determine face for CHARSET_ASCII, or unibyte. */
3691 face_id
= face_at_buffer_position (it
->w
,
3693 it
->region_beg_charpos
,
3694 it
->region_end_charpos
,
3695 &next_check_charpos
,
3698 /* Correct the face for charsets different from ASCII. Do it
3699 for the multibyte case only. The face returned above is
3700 suitable for unibyte text if current_buffer is unibyte. */
3701 if (it
->multibyte_p
)
3703 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3704 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3705 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3714 /***********************************************************************
3716 ***********************************************************************/
3718 /* Set up iterator IT from invisible properties at its current
3719 position. Called from handle_stop. */
3721 static enum prop_handled
3722 handle_invisible_prop (it
)
3725 enum prop_handled handled
= HANDLED_NORMALLY
;
3727 if (STRINGP (it
->string
))
3729 extern Lisp_Object Qinvisible
;
3730 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3732 /* Get the value of the invisible text property at the
3733 current position. Value will be nil if there is no such
3735 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3736 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3739 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3741 handled
= HANDLED_RECOMPUTE_PROPS
;
3743 /* Get the position at which the next change of the
3744 invisible text property can be found in IT->string.
3745 Value will be nil if the property value is the same for
3746 all the rest of IT->string. */
3747 XSETINT (limit
, SCHARS (it
->string
));
3748 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3751 /* Text at current position is invisible. The next
3752 change in the property is at position end_charpos.
3753 Move IT's current position to that position. */
3754 if (INTEGERP (end_charpos
)
3755 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3757 struct text_pos old
;
3758 old
= it
->current
.string_pos
;
3759 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3760 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3764 /* The rest of the string is invisible. If this is an
3765 overlay string, proceed with the next overlay string
3766 or whatever comes and return a character from there. */
3767 if (it
->current
.overlay_string_index
>= 0)
3769 next_overlay_string (it
);
3770 /* Don't check for overlay strings when we just
3771 finished processing them. */
3772 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3776 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3777 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3785 EMACS_INT newpos
, next_stop
, start_charpos
;
3786 Lisp_Object pos
, prop
, overlay
;
3788 /* First of all, is there invisible text at this position? */
3789 start_charpos
= IT_CHARPOS (*it
);
3790 pos
= make_number (IT_CHARPOS (*it
));
3791 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3793 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3795 /* If we are on invisible text, skip over it. */
3796 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3798 /* Record whether we have to display an ellipsis for the
3800 int display_ellipsis_p
= invis_p
== 2;
3802 handled
= HANDLED_RECOMPUTE_PROPS
;
3804 /* Loop skipping over invisible text. The loop is left at
3805 ZV or with IT on the first char being visible again. */
3808 /* Try to skip some invisible text. Return value is the
3809 position reached which can be equal to IT's position
3810 if there is nothing invisible here. This skips both
3811 over invisible text properties and overlays with
3812 invisible property. */
3813 newpos
= skip_invisible (IT_CHARPOS (*it
),
3814 &next_stop
, ZV
, it
->window
);
3816 /* If we skipped nothing at all we weren't at invisible
3817 text in the first place. If everything to the end of
3818 the buffer was skipped, end the loop. */
3819 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3823 /* We skipped some characters but not necessarily
3824 all there are. Check if we ended up on visible
3825 text. Fget_char_property returns the property of
3826 the char before the given position, i.e. if we
3827 get invis_p = 0, this means that the char at
3828 newpos is visible. */
3829 pos
= make_number (newpos
);
3830 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3831 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3834 /* If we ended up on invisible text, proceed to
3835 skip starting with next_stop. */
3837 IT_CHARPOS (*it
) = next_stop
;
3839 /* If there are adjacent invisible texts, don't lose the
3840 second one's ellipsis. */
3842 display_ellipsis_p
= 1;
3846 /* The position newpos is now either ZV or on visible text. */
3847 IT_CHARPOS (*it
) = newpos
;
3848 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3850 /* If there are before-strings at the start of invisible
3851 text, and the text is invisible because of a text
3852 property, arrange to show before-strings because 20.x did
3853 it that way. (If the text is invisible because of an
3854 overlay property instead of a text property, this is
3855 already handled in the overlay code.) */
3857 && get_overlay_strings (it
, start_charpos
))
3859 handled
= HANDLED_RECOMPUTE_PROPS
;
3860 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3862 else if (display_ellipsis_p
)
3864 /* Make sure that the glyphs of the ellipsis will get
3865 correct `charpos' values. If we would not update
3866 it->position here, the glyphs would belong to the
3867 last visible character _before_ the invisible
3868 text, which confuses `set_cursor_from_row'.
3870 We use the last invisible position instead of the
3871 first because this way the cursor is always drawn on
3872 the first "." of the ellipsis, whenever PT is inside
3873 the invisible text. Otherwise the cursor would be
3874 placed _after_ the ellipsis when the point is after the
3875 first invisible character. */
3876 if (!STRINGP (it
->object
))
3878 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3879 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3882 /* Let the ellipsis display before
3883 considering any properties of the following char.
3884 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3885 handled
= HANDLED_RETURN
;
3894 /* Make iterator IT return `...' next.
3895 Replaces LEN characters from buffer. */
3898 setup_for_ellipsis (it
, len
)
3902 /* Use the display table definition for `...'. Invalid glyphs
3903 will be handled by the method returning elements from dpvec. */
3904 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3906 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3907 it
->dpvec
= v
->contents
;
3908 it
->dpend
= v
->contents
+ v
->size
;
3912 /* Default `...'. */
3913 it
->dpvec
= default_invis_vector
;
3914 it
->dpend
= default_invis_vector
+ 3;
3917 it
->dpvec_char_len
= len
;
3918 it
->current
.dpvec_index
= 0;
3919 it
->dpvec_face_id
= -1;
3921 /* Remember the current face id in case glyphs specify faces.
3922 IT's face is restored in set_iterator_to_next.
3923 saved_face_id was set to preceding char's face in handle_stop. */
3924 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3925 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3927 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3933 /***********************************************************************
3935 ***********************************************************************/
3937 /* Set up iterator IT from `display' property at its current position.
3938 Called from handle_stop.
3939 We return HANDLED_RETURN if some part of the display property
3940 overrides the display of the buffer text itself.
3941 Otherwise we return HANDLED_NORMALLY. */
3943 static enum prop_handled
3944 handle_display_prop (it
)
3947 Lisp_Object prop
, object
, overlay
;
3948 struct text_pos
*position
;
3949 /* Nonzero if some property replaces the display of the text itself. */
3950 int display_replaced_p
= 0;
3952 if (STRINGP (it
->string
))
3954 object
= it
->string
;
3955 position
= &it
->current
.string_pos
;
3959 XSETWINDOW (object
, it
->w
);
3960 position
= &it
->current
.pos
;
3963 /* Reset those iterator values set from display property values. */
3964 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3965 it
->space_width
= Qnil
;
3966 it
->font_height
= Qnil
;
3969 /* We don't support recursive `display' properties, i.e. string
3970 values that have a string `display' property, that have a string
3971 `display' property etc. */
3972 if (!it
->string_from_display_prop_p
)
3973 it
->area
= TEXT_AREA
;
3975 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3976 Qdisplay
, object
, &overlay
);
3978 return HANDLED_NORMALLY
;
3979 /* Now OVERLAY is the overlay that gave us this property, or nil
3980 if it was a text property. */
3982 if (!STRINGP (it
->string
))
3983 object
= it
->w
->buffer
;
3986 /* Simple properties. */
3987 && !EQ (XCAR (prop
), Qimage
)
3988 && !EQ (XCAR (prop
), Qspace
)
3989 && !EQ (XCAR (prop
), Qwhen
)
3990 && !EQ (XCAR (prop
), Qslice
)
3991 && !EQ (XCAR (prop
), Qspace_width
)
3992 && !EQ (XCAR (prop
), Qheight
)
3993 && !EQ (XCAR (prop
), Qraise
)
3994 /* Marginal area specifications. */
3995 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3996 && !EQ (XCAR (prop
), Qleft_fringe
)
3997 && !EQ (XCAR (prop
), Qright_fringe
)
3998 && !NILP (XCAR (prop
)))
4000 for (; CONSP (prop
); prop
= XCDR (prop
))
4002 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
4003 position
, display_replaced_p
))
4005 display_replaced_p
= 1;
4006 /* If some text in a string is replaced, `position' no
4007 longer points to the position of `object'. */
4008 if (STRINGP (object
))
4013 else if (VECTORP (prop
))
4016 for (i
= 0; i
< ASIZE (prop
); ++i
)
4017 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4018 position
, display_replaced_p
))
4020 display_replaced_p
= 1;
4021 /* If some text in a string is replaced, `position' no
4022 longer points to the position of `object'. */
4023 if (STRINGP (object
))
4029 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4031 display_replaced_p
= 1;
4034 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4038 /* Value is the position of the end of the `display' property starting
4039 at START_POS in OBJECT. */
4041 static struct text_pos
4042 display_prop_end (it
, object
, start_pos
)
4045 struct text_pos start_pos
;
4048 struct text_pos end_pos
;
4050 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4051 Qdisplay
, object
, Qnil
);
4052 CHARPOS (end_pos
) = XFASTINT (end
);
4053 if (STRINGP (object
))
4054 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4056 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4062 /* Set up IT from a single `display' specification PROP. OBJECT
4063 is the object in which the `display' property was found. *POSITION
4064 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4065 means that we previously saw a display specification which already
4066 replaced text display with something else, for example an image;
4067 we ignore such properties after the first one has been processed.
4069 OVERLAY is the overlay this `display' property came from,
4070 or nil if it was a text property.
4072 If PROP is a `space' or `image' specification, and in some other
4073 cases too, set *POSITION to the position where the `display'
4076 Value is non-zero if something was found which replaces the display
4077 of buffer or string text. */
4080 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4081 display_replaced_before_p
)
4085 Lisp_Object overlay
;
4086 struct text_pos
*position
;
4087 int display_replaced_before_p
;
4090 Lisp_Object location
, value
;
4091 struct text_pos start_pos
, save_pos
;
4094 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4095 If the result is non-nil, use VALUE instead of SPEC. */
4097 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4106 if (!NILP (form
) && !EQ (form
, Qt
))
4108 int count
= SPECPDL_INDEX ();
4109 struct gcpro gcpro1
;
4111 /* Bind `object' to the object having the `display' property, a
4112 buffer or string. Bind `position' to the position in the
4113 object where the property was found, and `buffer-position'
4114 to the current position in the buffer. */
4115 specbind (Qobject
, object
);
4116 specbind (Qposition
, make_number (CHARPOS (*position
)));
4117 specbind (Qbuffer_position
,
4118 make_number (STRINGP (object
)
4119 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4121 form
= safe_eval (form
);
4123 unbind_to (count
, Qnil
);
4129 /* Handle `(height HEIGHT)' specifications. */
4131 && EQ (XCAR (spec
), Qheight
)
4132 && CONSP (XCDR (spec
)))
4134 if (!FRAME_WINDOW_P (it
->f
))
4137 it
->font_height
= XCAR (XCDR (spec
));
4138 if (!NILP (it
->font_height
))
4140 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4141 int new_height
= -1;
4143 if (CONSP (it
->font_height
)
4144 && (EQ (XCAR (it
->font_height
), Qplus
)
4145 || EQ (XCAR (it
->font_height
), Qminus
))
4146 && CONSP (XCDR (it
->font_height
))
4147 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4149 /* `(+ N)' or `(- N)' where N is an integer. */
4150 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4151 if (EQ (XCAR (it
->font_height
), Qplus
))
4153 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4155 else if (FUNCTIONP (it
->font_height
))
4157 /* Call function with current height as argument.
4158 Value is the new height. */
4160 height
= safe_call1 (it
->font_height
,
4161 face
->lface
[LFACE_HEIGHT_INDEX
]);
4162 if (NUMBERP (height
))
4163 new_height
= XFLOATINT (height
);
4165 else if (NUMBERP (it
->font_height
))
4167 /* Value is a multiple of the canonical char height. */
4170 face
= FACE_FROM_ID (it
->f
,
4171 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4172 new_height
= (XFLOATINT (it
->font_height
)
4173 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4177 /* Evaluate IT->font_height with `height' bound to the
4178 current specified height to get the new height. */
4179 int count
= SPECPDL_INDEX ();
4181 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4182 value
= safe_eval (it
->font_height
);
4183 unbind_to (count
, Qnil
);
4185 if (NUMBERP (value
))
4186 new_height
= XFLOATINT (value
);
4190 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4196 /* Handle `(space-width WIDTH)'. */
4198 && EQ (XCAR (spec
), Qspace_width
)
4199 && CONSP (XCDR (spec
)))
4201 if (!FRAME_WINDOW_P (it
->f
))
4204 value
= XCAR (XCDR (spec
));
4205 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4206 it
->space_width
= value
;
4211 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4213 && EQ (XCAR (spec
), Qslice
))
4217 if (!FRAME_WINDOW_P (it
->f
))
4220 if (tem
= XCDR (spec
), CONSP (tem
))
4222 it
->slice
.x
= XCAR (tem
);
4223 if (tem
= XCDR (tem
), CONSP (tem
))
4225 it
->slice
.y
= XCAR (tem
);
4226 if (tem
= XCDR (tem
), CONSP (tem
))
4228 it
->slice
.width
= XCAR (tem
);
4229 if (tem
= XCDR (tem
), CONSP (tem
))
4230 it
->slice
.height
= XCAR (tem
);
4238 /* Handle `(raise FACTOR)'. */
4240 && EQ (XCAR (spec
), Qraise
)
4241 && CONSP (XCDR (spec
)))
4243 if (!FRAME_WINDOW_P (it
->f
))
4246 #ifdef HAVE_WINDOW_SYSTEM
4247 value
= XCAR (XCDR (spec
));
4248 if (NUMBERP (value
))
4250 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4251 it
->voffset
= - (XFLOATINT (value
)
4252 * (FONT_HEIGHT (face
->font
)));
4254 #endif /* HAVE_WINDOW_SYSTEM */
4259 /* Don't handle the other kinds of display specifications
4260 inside a string that we got from a `display' property. */
4261 if (it
->string_from_display_prop_p
)
4264 /* Characters having this form of property are not displayed, so
4265 we have to find the end of the property. */
4266 start_pos
= *position
;
4267 *position
= display_prop_end (it
, object
, start_pos
);
4270 /* Stop the scan at that end position--we assume that all
4271 text properties change there. */
4272 it
->stop_charpos
= position
->charpos
;
4274 /* Handle `(left-fringe BITMAP [FACE])'
4275 and `(right-fringe BITMAP [FACE])'. */
4277 && (EQ (XCAR (spec
), Qleft_fringe
)
4278 || EQ (XCAR (spec
), Qright_fringe
))
4279 && CONSP (XCDR (spec
)))
4281 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4284 if (!FRAME_WINDOW_P (it
->f
))
4285 /* If we return here, POSITION has been advanced
4286 across the text with this property. */
4289 #ifdef HAVE_WINDOW_SYSTEM
4290 value
= XCAR (XCDR (spec
));
4291 if (!SYMBOLP (value
)
4292 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4293 /* If we return here, POSITION has been advanced
4294 across the text with this property. */
4297 if (CONSP (XCDR (XCDR (spec
))))
4299 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4300 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4306 /* Save current settings of IT so that we can restore them
4307 when we are finished with the glyph property value. */
4309 save_pos
= it
->position
;
4310 it
->position
= *position
;
4312 it
->position
= save_pos
;
4314 it
->area
= TEXT_AREA
;
4315 it
->what
= IT_IMAGE
;
4316 it
->image_id
= -1; /* no image */
4317 it
->position
= start_pos
;
4318 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4319 it
->method
= GET_FROM_IMAGE
;
4320 it
->from_overlay
= Qnil
;
4321 it
->face_id
= face_id
;
4323 /* Say that we haven't consumed the characters with
4324 `display' property yet. The call to pop_it in
4325 set_iterator_to_next will clean this up. */
4326 *position
= start_pos
;
4328 if (EQ (XCAR (spec
), Qleft_fringe
))
4330 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4331 it
->left_user_fringe_face_id
= face_id
;
4335 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4336 it
->right_user_fringe_face_id
= face_id
;
4338 #endif /* HAVE_WINDOW_SYSTEM */
4342 /* Prepare to handle `((margin left-margin) ...)',
4343 `((margin right-margin) ...)' and `((margin nil) ...)'
4344 prefixes for display specifications. */
4345 location
= Qunbound
;
4346 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4350 value
= XCDR (spec
);
4352 value
= XCAR (value
);
4355 if (EQ (XCAR (tem
), Qmargin
)
4356 && (tem
= XCDR (tem
),
4357 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4359 || EQ (tem
, Qleft_margin
)
4360 || EQ (tem
, Qright_margin
))))
4364 if (EQ (location
, Qunbound
))
4370 /* After this point, VALUE is the property after any
4371 margin prefix has been stripped. It must be a string,
4372 an image specification, or `(space ...)'.
4374 LOCATION specifies where to display: `left-margin',
4375 `right-margin' or nil. */
4377 valid_p
= (STRINGP (value
)
4378 #ifdef HAVE_WINDOW_SYSTEM
4379 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4380 #endif /* not HAVE_WINDOW_SYSTEM */
4381 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4383 if (valid_p
&& !display_replaced_before_p
)
4385 /* Save current settings of IT so that we can restore them
4386 when we are finished with the glyph property value. */
4387 save_pos
= it
->position
;
4388 it
->position
= *position
;
4390 it
->position
= save_pos
;
4391 it
->from_overlay
= overlay
;
4393 if (NILP (location
))
4394 it
->area
= TEXT_AREA
;
4395 else if (EQ (location
, Qleft_margin
))
4396 it
->area
= LEFT_MARGIN_AREA
;
4398 it
->area
= RIGHT_MARGIN_AREA
;
4400 if (STRINGP (value
))
4403 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4404 it
->current
.overlay_string_index
= -1;
4405 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4406 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4407 it
->method
= GET_FROM_STRING
;
4408 it
->stop_charpos
= 0;
4409 it
->string_from_display_prop_p
= 1;
4410 /* Say that we haven't consumed the characters with
4411 `display' property yet. The call to pop_it in
4412 set_iterator_to_next will clean this up. */
4413 if (BUFFERP (object
))
4414 *position
= start_pos
;
4416 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4418 it
->method
= GET_FROM_STRETCH
;
4420 *position
= it
->position
= start_pos
;
4422 #ifdef HAVE_WINDOW_SYSTEM
4425 it
->what
= IT_IMAGE
;
4426 it
->image_id
= lookup_image (it
->f
, value
);
4427 it
->position
= start_pos
;
4428 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4429 it
->method
= GET_FROM_IMAGE
;
4431 /* Say that we haven't consumed the characters with
4432 `display' property yet. The call to pop_it in
4433 set_iterator_to_next will clean this up. */
4434 *position
= start_pos
;
4436 #endif /* HAVE_WINDOW_SYSTEM */
4441 /* Invalid property or property not supported. Restore
4442 POSITION to what it was before. */
4443 *position
= start_pos
;
4448 /* Check if SPEC is a display sub-property value whose text should be
4449 treated as intangible. */
4452 single_display_spec_intangible_p (prop
)
4455 /* Skip over `when FORM'. */
4456 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4470 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4471 we don't need to treat text as intangible. */
4472 if (EQ (XCAR (prop
), Qmargin
))
4480 || EQ (XCAR (prop
), Qleft_margin
)
4481 || EQ (XCAR (prop
), Qright_margin
))
4485 return (CONSP (prop
)
4486 && (EQ (XCAR (prop
), Qimage
)
4487 || EQ (XCAR (prop
), Qspace
)));
4491 /* Check if PROP is a display property value whose text should be
4492 treated as intangible. */
4495 display_prop_intangible_p (prop
)
4499 && CONSP (XCAR (prop
))
4500 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4502 /* A list of sub-properties. */
4503 while (CONSP (prop
))
4505 if (single_display_spec_intangible_p (XCAR (prop
)))
4510 else if (VECTORP (prop
))
4512 /* A vector of sub-properties. */
4514 for (i
= 0; i
< ASIZE (prop
); ++i
)
4515 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4519 return single_display_spec_intangible_p (prop
);
4525 /* Return 1 if PROP is a display sub-property value containing STRING. */
4528 single_display_spec_string_p (prop
, string
)
4529 Lisp_Object prop
, string
;
4531 if (EQ (string
, prop
))
4534 /* Skip over `when FORM'. */
4535 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4544 /* Skip over `margin LOCATION'. */
4545 if (EQ (XCAR (prop
), Qmargin
))
4556 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4560 /* Return 1 if STRING appears in the `display' property PROP. */
4563 display_prop_string_p (prop
, string
)
4564 Lisp_Object prop
, string
;
4567 && CONSP (XCAR (prop
))
4568 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4570 /* A list of sub-properties. */
4571 while (CONSP (prop
))
4573 if (single_display_spec_string_p (XCAR (prop
), string
))
4578 else if (VECTORP (prop
))
4580 /* A vector of sub-properties. */
4582 for (i
= 0; i
< ASIZE (prop
); ++i
)
4583 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4587 return single_display_spec_string_p (prop
, string
);
4593 /* Determine from which buffer position in W's buffer STRING comes
4594 from. AROUND_CHARPOS is an approximate position where it could
4595 be from. Value is the buffer position or 0 if it couldn't be
4598 W's buffer must be current.
4600 This function is necessary because we don't record buffer positions
4601 in glyphs generated from strings (to keep struct glyph small).
4602 This function may only use code that doesn't eval because it is
4603 called asynchronously from note_mouse_highlight. */
4606 string_buffer_position (w
, string
, around_charpos
)
4611 Lisp_Object limit
, prop
, pos
;
4612 const int MAX_DISTANCE
= 1000;
4615 pos
= make_number (around_charpos
);
4616 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4617 while (!found
&& !EQ (pos
, limit
))
4619 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4620 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4623 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4628 pos
= make_number (around_charpos
);
4629 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4630 while (!found
&& !EQ (pos
, limit
))
4632 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4633 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4636 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4641 return found
? XINT (pos
) : 0;
4646 /***********************************************************************
4647 `composition' property
4648 ***********************************************************************/
4650 /* Set up iterator IT from `composition' property at its current
4651 position. Called from handle_stop. */
4653 static enum prop_handled
4654 handle_composition_prop (it
)
4657 Lisp_Object prop
, string
;
4658 EMACS_INT pos
, pos_byte
, start
, end
;
4660 if (STRINGP (it
->string
))
4664 pos
= IT_STRING_CHARPOS (*it
);
4665 pos_byte
= IT_STRING_BYTEPOS (*it
);
4666 string
= it
->string
;
4667 s
= SDATA (string
) + pos_byte
;
4668 it
->c
= STRING_CHAR (s
, 0);
4672 pos
= IT_CHARPOS (*it
);
4673 pos_byte
= IT_BYTEPOS (*it
);
4675 it
->c
= FETCH_CHAR (pos_byte
);
4678 /* If there's a valid composition and point is not inside of the
4679 composition (in the case that the composition is from the current
4680 buffer), draw a glyph composed from the composition components. */
4681 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4682 && COMPOSITION_VALID_P (start
, end
, prop
)
4683 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4687 if (STRINGP (it
->string
))
4688 pos_byte
= string_char_to_byte (it
->string
, start
);
4690 pos_byte
= CHAR_TO_BYTE (start
);
4692 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4695 if (it
->cmp_it
.id
>= 0)
4698 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4699 it
->cmp_it
.nglyphs
= -1;
4703 return HANDLED_NORMALLY
;
4708 /***********************************************************************
4710 ***********************************************************************/
4712 /* The following structure is used to record overlay strings for
4713 later sorting in load_overlay_strings. */
4715 struct overlay_entry
4717 Lisp_Object overlay
;
4724 /* Set up iterator IT from overlay strings at its current position.
4725 Called from handle_stop. */
4727 static enum prop_handled
4728 handle_overlay_change (it
)
4731 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4732 return HANDLED_RECOMPUTE_PROPS
;
4734 return HANDLED_NORMALLY
;
4738 /* Set up the next overlay string for delivery by IT, if there is an
4739 overlay string to deliver. Called by set_iterator_to_next when the
4740 end of the current overlay string is reached. If there are more
4741 overlay strings to display, IT->string and
4742 IT->current.overlay_string_index are set appropriately here.
4743 Otherwise IT->string is set to nil. */
4746 next_overlay_string (it
)
4749 ++it
->current
.overlay_string_index
;
4750 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4752 /* No more overlay strings. Restore IT's settings to what
4753 they were before overlay strings were processed, and
4754 continue to deliver from current_buffer. */
4756 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4759 || (NILP (it
->string
)
4760 && it
->method
== GET_FROM_BUFFER
4761 && it
->stop_charpos
>= BEGV
4762 && it
->stop_charpos
<= it
->end_charpos
));
4763 it
->current
.overlay_string_index
= -1;
4764 it
->n_overlay_strings
= 0;
4766 /* If we're at the end of the buffer, record that we have
4767 processed the overlay strings there already, so that
4768 next_element_from_buffer doesn't try it again. */
4769 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4770 it
->overlay_strings_at_end_processed_p
= 1;
4774 /* There are more overlay strings to process. If
4775 IT->current.overlay_string_index has advanced to a position
4776 where we must load IT->overlay_strings with more strings, do
4778 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4780 if (it
->current
.overlay_string_index
&& i
== 0)
4781 load_overlay_strings (it
, 0);
4783 /* Initialize IT to deliver display elements from the overlay
4785 it
->string
= it
->overlay_strings
[i
];
4786 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4787 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4788 it
->method
= GET_FROM_STRING
;
4789 it
->stop_charpos
= 0;
4790 if (it
->cmp_it
.stop_pos
>= 0)
4791 it
->cmp_it
.stop_pos
= 0;
4798 /* Compare two overlay_entry structures E1 and E2. Used as a
4799 comparison function for qsort in load_overlay_strings. Overlay
4800 strings for the same position are sorted so that
4802 1. All after-strings come in front of before-strings, except
4803 when they come from the same overlay.
4805 2. Within after-strings, strings are sorted so that overlay strings
4806 from overlays with higher priorities come first.
4808 2. Within before-strings, strings are sorted so that overlay
4809 strings from overlays with higher priorities come last.
4811 Value is analogous to strcmp. */
4815 compare_overlay_entries (e1
, e2
)
4818 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4819 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4822 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4824 /* Let after-strings appear in front of before-strings if
4825 they come from different overlays. */
4826 if (EQ (entry1
->overlay
, entry2
->overlay
))
4827 result
= entry1
->after_string_p
? 1 : -1;
4829 result
= entry1
->after_string_p
? -1 : 1;
4831 else if (entry1
->after_string_p
)
4832 /* After-strings sorted in order of decreasing priority. */
4833 result
= entry2
->priority
- entry1
->priority
;
4835 /* Before-strings sorted in order of increasing priority. */
4836 result
= entry1
->priority
- entry2
->priority
;
4842 /* Load the vector IT->overlay_strings with overlay strings from IT's
4843 current buffer position, or from CHARPOS if that is > 0. Set
4844 IT->n_overlays to the total number of overlay strings found.
4846 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4847 a time. On entry into load_overlay_strings,
4848 IT->current.overlay_string_index gives the number of overlay
4849 strings that have already been loaded by previous calls to this
4852 IT->add_overlay_start contains an additional overlay start
4853 position to consider for taking overlay strings from, if non-zero.
4854 This position comes into play when the overlay has an `invisible'
4855 property, and both before and after-strings. When we've skipped to
4856 the end of the overlay, because of its `invisible' property, we
4857 nevertheless want its before-string to appear.
4858 IT->add_overlay_start will contain the overlay start position
4861 Overlay strings are sorted so that after-string strings come in
4862 front of before-string strings. Within before and after-strings,
4863 strings are sorted by overlay priority. See also function
4864 compare_overlay_entries. */
4867 load_overlay_strings (it
, charpos
)
4871 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4872 Lisp_Object overlay
, window
, str
, invisible
;
4873 struct Lisp_Overlay
*ov
;
4876 int n
= 0, i
, j
, invis_p
;
4877 struct overlay_entry
*entries
4878 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4881 charpos
= IT_CHARPOS (*it
);
4883 /* Append the overlay string STRING of overlay OVERLAY to vector
4884 `entries' which has size `size' and currently contains `n'
4885 elements. AFTER_P non-zero means STRING is an after-string of
4887 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4890 Lisp_Object priority; \
4894 int new_size = 2 * size; \
4895 struct overlay_entry *old = entries; \
4897 (struct overlay_entry *) alloca (new_size \
4898 * sizeof *entries); \
4899 bcopy (old, entries, size * sizeof *entries); \
4903 entries[n].string = (STRING); \
4904 entries[n].overlay = (OVERLAY); \
4905 priority = Foverlay_get ((OVERLAY), Qpriority); \
4906 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4907 entries[n].after_string_p = (AFTER_P); \
4912 /* Process overlay before the overlay center. */
4913 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4915 XSETMISC (overlay
, ov
);
4916 xassert (OVERLAYP (overlay
));
4917 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4918 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4923 /* Skip this overlay if it doesn't start or end at IT's current
4925 if (end
!= charpos
&& start
!= charpos
)
4928 /* Skip this overlay if it doesn't apply to IT->w. */
4929 window
= Foverlay_get (overlay
, Qwindow
);
4930 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4933 /* If the text ``under'' the overlay is invisible, both before-
4934 and after-strings from this overlay are visible; start and
4935 end position are indistinguishable. */
4936 invisible
= Foverlay_get (overlay
, Qinvisible
);
4937 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4939 /* If overlay has a non-empty before-string, record it. */
4940 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4941 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4943 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4945 /* If overlay has a non-empty after-string, record it. */
4946 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4947 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4949 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4952 /* Process overlays after the overlay center. */
4953 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4955 XSETMISC (overlay
, ov
);
4956 xassert (OVERLAYP (overlay
));
4957 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4958 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4960 if (start
> charpos
)
4963 /* Skip this overlay if it doesn't start or end at IT's current
4965 if (end
!= charpos
&& start
!= charpos
)
4968 /* Skip this overlay if it doesn't apply to IT->w. */
4969 window
= Foverlay_get (overlay
, Qwindow
);
4970 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4973 /* If the text ``under'' the overlay is invisible, it has a zero
4974 dimension, and both before- and after-strings apply. */
4975 invisible
= Foverlay_get (overlay
, Qinvisible
);
4976 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4978 /* If overlay has a non-empty before-string, record it. */
4979 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4980 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4982 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4984 /* If overlay has a non-empty after-string, record it. */
4985 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4986 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4988 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4991 #undef RECORD_OVERLAY_STRING
4995 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4997 /* Record the total number of strings to process. */
4998 it
->n_overlay_strings
= n
;
5000 /* IT->current.overlay_string_index is the number of overlay strings
5001 that have already been consumed by IT. Copy some of the
5002 remaining overlay strings to IT->overlay_strings. */
5004 j
= it
->current
.overlay_string_index
;
5005 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5007 it
->overlay_strings
[i
] = entries
[j
].string
;
5008 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5015 /* Get the first chunk of overlay strings at IT's current buffer
5016 position, or at CHARPOS if that is > 0. Value is non-zero if at
5017 least one overlay string was found. */
5020 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5025 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5026 process. This fills IT->overlay_strings with strings, and sets
5027 IT->n_overlay_strings to the total number of strings to process.
5028 IT->pos.overlay_string_index has to be set temporarily to zero
5029 because load_overlay_strings needs this; it must be set to -1
5030 when no overlay strings are found because a zero value would
5031 indicate a position in the first overlay string. */
5032 it
->current
.overlay_string_index
= 0;
5033 load_overlay_strings (it
, charpos
);
5035 /* If we found overlay strings, set up IT to deliver display
5036 elements from the first one. Otherwise set up IT to deliver
5037 from current_buffer. */
5038 if (it
->n_overlay_strings
)
5040 /* Make sure we know settings in current_buffer, so that we can
5041 restore meaningful values when we're done with the overlay
5044 compute_stop_pos (it
);
5045 xassert (it
->face_id
>= 0);
5047 /* Save IT's settings. They are restored after all overlay
5048 strings have been processed. */
5049 xassert (!compute_stop_p
|| it
->sp
== 0);
5051 /* When called from handle_stop, there might be an empty display
5052 string loaded. In that case, don't bother saving it. */
5053 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5056 /* Set up IT to deliver display elements from the first overlay
5058 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5059 it
->string
= it
->overlay_strings
[0];
5060 it
->from_overlay
= Qnil
;
5061 it
->stop_charpos
= 0;
5062 xassert (STRINGP (it
->string
));
5063 it
->end_charpos
= SCHARS (it
->string
);
5064 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5065 it
->method
= GET_FROM_STRING
;
5069 it
->current
.overlay_string_index
= -1;
5074 get_overlay_strings (it
, charpos
)
5079 it
->method
= GET_FROM_BUFFER
;
5081 (void) get_overlay_strings_1 (it
, charpos
, 1);
5085 /* Value is non-zero if we found at least one overlay string. */
5086 return STRINGP (it
->string
);
5091 /***********************************************************************
5092 Saving and restoring state
5093 ***********************************************************************/
5095 /* Save current settings of IT on IT->stack. Called, for example,
5096 before setting up IT for an overlay string, to be able to restore
5097 IT's settings to what they were after the overlay string has been
5104 struct iterator_stack_entry
*p
;
5106 xassert (it
->sp
< IT_STACK_SIZE
);
5107 p
= it
->stack
+ it
->sp
;
5109 p
->stop_charpos
= it
->stop_charpos
;
5110 p
->cmp_it
= it
->cmp_it
;
5111 xassert (it
->face_id
>= 0);
5112 p
->face_id
= it
->face_id
;
5113 p
->string
= it
->string
;
5114 p
->method
= it
->method
;
5115 p
->from_overlay
= it
->from_overlay
;
5118 case GET_FROM_IMAGE
:
5119 p
->u
.image
.object
= it
->object
;
5120 p
->u
.image
.image_id
= it
->image_id
;
5121 p
->u
.image
.slice
= it
->slice
;
5123 case GET_FROM_STRETCH
:
5124 p
->u
.stretch
.object
= it
->object
;
5127 p
->position
= it
->position
;
5128 p
->current
= it
->current
;
5129 p
->end_charpos
= it
->end_charpos
;
5130 p
->string_nchars
= it
->string_nchars
;
5132 p
->multibyte_p
= it
->multibyte_p
;
5133 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5134 p
->space_width
= it
->space_width
;
5135 p
->font_height
= it
->font_height
;
5136 p
->voffset
= it
->voffset
;
5137 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5138 p
->display_ellipsis_p
= 0;
5139 p
->line_wrap
= it
->line_wrap
;
5144 /* Restore IT's settings from IT->stack. Called, for example, when no
5145 more overlay strings must be processed, and we return to delivering
5146 display elements from a buffer, or when the end of a string from a
5147 `display' property is reached and we return to delivering display
5148 elements from an overlay string, or from a buffer. */
5154 struct iterator_stack_entry
*p
;
5156 xassert (it
->sp
> 0);
5158 p
= it
->stack
+ it
->sp
;
5159 it
->stop_charpos
= p
->stop_charpos
;
5160 it
->cmp_it
= p
->cmp_it
;
5161 it
->face_id
= p
->face_id
;
5162 it
->current
= p
->current
;
5163 it
->position
= p
->position
;
5164 it
->string
= p
->string
;
5165 it
->from_overlay
= p
->from_overlay
;
5166 if (NILP (it
->string
))
5167 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5168 it
->method
= p
->method
;
5171 case GET_FROM_IMAGE
:
5172 it
->image_id
= p
->u
.image
.image_id
;
5173 it
->object
= p
->u
.image
.object
;
5174 it
->slice
= p
->u
.image
.slice
;
5176 case GET_FROM_STRETCH
:
5177 it
->object
= p
->u
.comp
.object
;
5179 case GET_FROM_BUFFER
:
5180 it
->object
= it
->w
->buffer
;
5182 case GET_FROM_STRING
:
5183 it
->object
= it
->string
;
5186 it
->end_charpos
= p
->end_charpos
;
5187 it
->string_nchars
= p
->string_nchars
;
5189 it
->multibyte_p
= p
->multibyte_p
;
5190 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5191 it
->space_width
= p
->space_width
;
5192 it
->font_height
= p
->font_height
;
5193 it
->voffset
= p
->voffset
;
5194 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5195 it
->line_wrap
= p
->line_wrap
;
5200 /***********************************************************************
5202 ***********************************************************************/
5204 /* Set IT's current position to the previous line start. */
5207 back_to_previous_line_start (it
)
5210 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5211 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5215 /* Move IT to the next line start.
5217 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5218 we skipped over part of the text (as opposed to moving the iterator
5219 continuously over the text). Otherwise, don't change the value
5222 Newlines may come from buffer text, overlay strings, or strings
5223 displayed via the `display' property. That's the reason we can't
5224 simply use find_next_newline_no_quit.
5226 Note that this function may not skip over invisible text that is so
5227 because of text properties and immediately follows a newline. If
5228 it would, function reseat_at_next_visible_line_start, when called
5229 from set_iterator_to_next, would effectively make invisible
5230 characters following a newline part of the wrong glyph row, which
5231 leads to wrong cursor motion. */
5234 forward_to_next_line_start (it
, skipped_p
)
5238 int old_selective
, newline_found_p
, n
;
5239 const int MAX_NEWLINE_DISTANCE
= 500;
5241 /* If already on a newline, just consume it to avoid unintended
5242 skipping over invisible text below. */
5243 if (it
->what
== IT_CHARACTER
5245 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5247 set_iterator_to_next (it
, 0);
5252 /* Don't handle selective display in the following. It's (a)
5253 unnecessary because it's done by the caller, and (b) leads to an
5254 infinite recursion because next_element_from_ellipsis indirectly
5255 calls this function. */
5256 old_selective
= it
->selective
;
5259 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5260 from buffer text. */
5261 for (n
= newline_found_p
= 0;
5262 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5263 n
+= STRINGP (it
->string
) ? 0 : 1)
5265 if (!get_next_display_element (it
))
5267 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5268 set_iterator_to_next (it
, 0);
5271 /* If we didn't find a newline near enough, see if we can use a
5273 if (!newline_found_p
)
5275 int start
= IT_CHARPOS (*it
);
5276 int limit
= find_next_newline_no_quit (start
, 1);
5279 xassert (!STRINGP (it
->string
));
5281 /* If there isn't any `display' property in sight, and no
5282 overlays, we can just use the position of the newline in
5284 if (it
->stop_charpos
>= limit
5285 || ((pos
= Fnext_single_property_change (make_number (start
),
5287 Qnil
, make_number (limit
)),
5289 && next_overlay_change (start
) == ZV
))
5291 IT_CHARPOS (*it
) = limit
;
5292 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5293 *skipped_p
= newline_found_p
= 1;
5297 while (get_next_display_element (it
)
5298 && !newline_found_p
)
5300 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5301 set_iterator_to_next (it
, 0);
5306 it
->selective
= old_selective
;
5307 return newline_found_p
;
5311 /* Set IT's current position to the previous visible line start. Skip
5312 invisible text that is so either due to text properties or due to
5313 selective display. Caution: this does not change IT->current_x and
5317 back_to_previous_visible_line_start (it
)
5320 while (IT_CHARPOS (*it
) > BEGV
)
5322 back_to_previous_line_start (it
);
5324 if (IT_CHARPOS (*it
) <= BEGV
)
5327 /* If selective > 0, then lines indented more than that values
5329 if (it
->selective
> 0
5330 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5331 (double) it
->selective
)) /* iftc */
5334 /* Check the newline before point for invisibility. */
5337 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5338 Qinvisible
, it
->window
);
5339 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5343 if (IT_CHARPOS (*it
) <= BEGV
)
5350 Lisp_Object val
, overlay
;
5352 /* If newline is part of a composition, continue from start of composition */
5353 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5354 && beg
< IT_CHARPOS (*it
))
5357 /* If newline is replaced by a display property, find start of overlay
5358 or interval and continue search from that point. */
5360 pos
= --IT_CHARPOS (it2
);
5363 it2
.string_from_display_prop_p
= 0;
5364 if (handle_display_prop (&it2
) == HANDLED_RETURN
5365 && !NILP (val
= get_char_property_and_overlay
5366 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5367 && (OVERLAYP (overlay
)
5368 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5369 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5372 /* Newline is not replaced by anything -- so we are done. */
5378 IT_CHARPOS (*it
) = beg
;
5379 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5383 it
->continuation_lines_width
= 0;
5385 xassert (IT_CHARPOS (*it
) >= BEGV
);
5386 xassert (IT_CHARPOS (*it
) == BEGV
5387 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5392 /* Reseat iterator IT at the previous visible line start. Skip
5393 invisible text that is so either due to text properties or due to
5394 selective display. At the end, update IT's overlay information,
5395 face information etc. */
5398 reseat_at_previous_visible_line_start (it
)
5401 back_to_previous_visible_line_start (it
);
5402 reseat (it
, it
->current
.pos
, 1);
5407 /* Reseat iterator IT on the next visible line start in the current
5408 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5409 preceding the line start. Skip over invisible text that is so
5410 because of selective display. Compute faces, overlays etc at the
5411 new position. Note that this function does not skip over text that
5412 is invisible because of text properties. */
5415 reseat_at_next_visible_line_start (it
, on_newline_p
)
5419 int newline_found_p
, skipped_p
= 0;
5421 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5423 /* Skip over lines that are invisible because they are indented
5424 more than the value of IT->selective. */
5425 if (it
->selective
> 0)
5426 while (IT_CHARPOS (*it
) < ZV
5427 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5428 (double) it
->selective
)) /* iftc */
5430 xassert (IT_BYTEPOS (*it
) == BEGV
5431 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5432 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5435 /* Position on the newline if that's what's requested. */
5436 if (on_newline_p
&& newline_found_p
)
5438 if (STRINGP (it
->string
))
5440 if (IT_STRING_CHARPOS (*it
) > 0)
5442 --IT_STRING_CHARPOS (*it
);
5443 --IT_STRING_BYTEPOS (*it
);
5446 else if (IT_CHARPOS (*it
) > BEGV
)
5450 reseat (it
, it
->current
.pos
, 0);
5454 reseat (it
, it
->current
.pos
, 0);
5461 /***********************************************************************
5462 Changing an iterator's position
5463 ***********************************************************************/
5465 /* Change IT's current position to POS in current_buffer. If FORCE_P
5466 is non-zero, always check for text properties at the new position.
5467 Otherwise, text properties are only looked up if POS >=
5468 IT->check_charpos of a property. */
5471 reseat (it
, pos
, force_p
)
5473 struct text_pos pos
;
5476 int original_pos
= IT_CHARPOS (*it
);
5478 reseat_1 (it
, pos
, 0);
5480 /* Determine where to check text properties. Avoid doing it
5481 where possible because text property lookup is very expensive. */
5483 || CHARPOS (pos
) > it
->stop_charpos
5484 || CHARPOS (pos
) < original_pos
)
5491 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5492 IT->stop_pos to POS, also. */
5495 reseat_1 (it
, pos
, set_stop_p
)
5497 struct text_pos pos
;
5500 /* Don't call this function when scanning a C string. */
5501 xassert (it
->s
== NULL
);
5503 /* POS must be a reasonable value. */
5504 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5506 it
->current
.pos
= it
->position
= pos
;
5507 it
->end_charpos
= ZV
;
5509 it
->current
.dpvec_index
= -1;
5510 it
->current
.overlay_string_index
= -1;
5511 IT_STRING_CHARPOS (*it
) = -1;
5512 IT_STRING_BYTEPOS (*it
) = -1;
5514 it
->string_from_display_prop_p
= 0;
5515 it
->method
= GET_FROM_BUFFER
;
5516 it
->object
= it
->w
->buffer
;
5517 it
->area
= TEXT_AREA
;
5518 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5520 it
->string_from_display_prop_p
= 0;
5521 it
->face_before_selective_p
= 0;
5524 it
->stop_charpos
= CHARPOS (pos
);
5528 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5529 If S is non-null, it is a C string to iterate over. Otherwise,
5530 STRING gives a Lisp string to iterate over.
5532 If PRECISION > 0, don't return more then PRECISION number of
5533 characters from the string.
5535 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5536 characters have been returned. FIELD_WIDTH < 0 means an infinite
5539 MULTIBYTE = 0 means disable processing of multibyte characters,
5540 MULTIBYTE > 0 means enable it,
5541 MULTIBYTE < 0 means use IT->multibyte_p.
5543 IT must be initialized via a prior call to init_iterator before
5544 calling this function. */
5547 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5552 int precision
, field_width
, multibyte
;
5554 /* No region in strings. */
5555 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5557 /* No text property checks performed by default, but see below. */
5558 it
->stop_charpos
= -1;
5560 /* Set iterator position and end position. */
5561 bzero (&it
->current
, sizeof it
->current
);
5562 it
->current
.overlay_string_index
= -1;
5563 it
->current
.dpvec_index
= -1;
5564 xassert (charpos
>= 0);
5566 /* If STRING is specified, use its multibyteness, otherwise use the
5567 setting of MULTIBYTE, if specified. */
5569 it
->multibyte_p
= multibyte
> 0;
5573 xassert (STRINGP (string
));
5574 it
->string
= string
;
5576 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5577 it
->method
= GET_FROM_STRING
;
5578 it
->current
.string_pos
= string_pos (charpos
, string
);
5585 /* Note that we use IT->current.pos, not it->current.string_pos,
5586 for displaying C strings. */
5587 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5588 if (it
->multibyte_p
)
5590 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5591 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5595 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5596 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5599 it
->method
= GET_FROM_C_STRING
;
5602 /* PRECISION > 0 means don't return more than PRECISION characters
5604 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5605 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5607 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5608 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5609 FIELD_WIDTH < 0 means infinite field width. This is useful for
5610 padding with `-' at the end of a mode line. */
5611 if (field_width
< 0)
5612 field_width
= INFINITY
;
5613 if (field_width
> it
->end_charpos
- charpos
)
5614 it
->end_charpos
= charpos
+ field_width
;
5616 /* Use the standard display table for displaying strings. */
5617 if (DISP_TABLE_P (Vstandard_display_table
))
5618 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5620 it
->stop_charpos
= charpos
;
5626 /***********************************************************************
5628 ***********************************************************************/
5630 /* Map enum it_method value to corresponding next_element_from_* function. */
5632 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5634 next_element_from_buffer
,
5635 next_element_from_display_vector
,
5636 next_element_from_string
,
5637 next_element_from_c_string
,
5638 next_element_from_image
,
5639 next_element_from_stretch
5642 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5645 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5646 (possibly with the following characters). */
5648 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS) \
5649 ((IT)->cmp_it.id >= 0 \
5650 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5651 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5652 (IT)->end_charpos, (IT)->w, \
5653 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5657 /* Load IT's display element fields with information about the next
5658 display element from the current position of IT. Value is zero if
5659 end of buffer (or C string) is reached. */
5661 static struct frame
*last_escape_glyph_frame
= NULL
;
5662 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5663 static int last_escape_glyph_merged_face_id
= 0;
5666 get_next_display_element (it
)
5669 /* Non-zero means that we found a display element. Zero means that
5670 we hit the end of what we iterate over. Performance note: the
5671 function pointer `method' used here turns out to be faster than
5672 using a sequence of if-statements. */
5676 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5678 if (it
->what
== IT_CHARACTER
)
5680 /* Map via display table or translate control characters.
5681 IT->c, IT->len etc. have been set to the next character by
5682 the function call above. If we have a display table, and it
5683 contains an entry for IT->c, translate it. Don't do this if
5684 IT->c itself comes from a display table, otherwise we could
5685 end up in an infinite recursion. (An alternative could be to
5686 count the recursion depth of this function and signal an
5687 error when a certain maximum depth is reached.) Is it worth
5689 if (success_p
&& it
->dpvec
== NULL
)
5694 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5697 struct Lisp_Vector
*v
= XVECTOR (dv
);
5699 /* Return the first character from the display table
5700 entry, if not empty. If empty, don't display the
5701 current character. */
5704 it
->dpvec_char_len
= it
->len
;
5705 it
->dpvec
= v
->contents
;
5706 it
->dpend
= v
->contents
+ v
->size
;
5707 it
->current
.dpvec_index
= 0;
5708 it
->dpvec_face_id
= -1;
5709 it
->saved_face_id
= it
->face_id
;
5710 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5715 set_iterator_to_next (it
, 0);
5720 /* Translate control characters into `\003' or `^C' form.
5721 Control characters coming from a display table entry are
5722 currently not translated because we use IT->dpvec to hold
5723 the translation. This could easily be changed but I
5724 don't believe that it is worth doing.
5726 If it->multibyte_p is nonzero, non-printable non-ASCII
5727 characters are also translated to octal form.
5729 If it->multibyte_p is zero, eight-bit characters that
5730 don't have corresponding multibyte char code are also
5731 translated to octal form. */
5732 else if ((it
->c
< ' '
5733 ? (it
->area
!= TEXT_AREA
5734 /* In mode line, treat \n, \t like other crl chars. */
5736 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5737 || (it
->c
!= '\n' && it
->c
!= '\t'))
5739 ? (!CHAR_PRINTABLE_P (it
->c
)
5740 || (!NILP (Vnobreak_char_display
)
5741 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5742 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5744 && (! unibyte_display_via_language_environment
5745 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5747 /* IT->c is a control character which must be displayed
5748 either as '\003' or as `^C' where the '\\' and '^'
5749 can be defined in the display table. Fill
5750 IT->ctl_chars with glyphs for what we have to
5751 display. Then, set IT->dpvec to these glyphs. */
5754 int face_id
, lface_id
= 0 ;
5757 /* Handle control characters with ^. */
5759 if (it
->c
< 128 && it
->ctl_arrow_p
)
5763 g
= '^'; /* default glyph for Control */
5764 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5766 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5767 && GLYPH_CODE_CHAR_VALID_P (gc
))
5769 g
= GLYPH_CODE_CHAR (gc
);
5770 lface_id
= GLYPH_CODE_FACE (gc
);
5774 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5776 else if (it
->f
== last_escape_glyph_frame
5777 && it
->face_id
== last_escape_glyph_face_id
)
5779 face_id
= last_escape_glyph_merged_face_id
;
5783 /* Merge the escape-glyph face into the current face. */
5784 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5786 last_escape_glyph_frame
= it
->f
;
5787 last_escape_glyph_face_id
= it
->face_id
;
5788 last_escape_glyph_merged_face_id
= face_id
;
5791 XSETINT (it
->ctl_chars
[0], g
);
5792 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5794 goto display_control
;
5797 /* Handle non-break space in the mode where it only gets
5800 if (EQ (Vnobreak_char_display
, Qt
)
5803 /* Merge the no-break-space face into the current face. */
5804 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5808 XSETINT (it
->ctl_chars
[0], ' ');
5810 goto display_control
;
5813 /* Handle sequences that start with the "escape glyph". */
5815 /* the default escape glyph is \. */
5816 escape_glyph
= '\\';
5819 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5820 && GLYPH_CODE_CHAR_VALID_P (gc
))
5822 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5823 lface_id
= GLYPH_CODE_FACE (gc
);
5827 /* The display table specified a face.
5828 Merge it into face_id and also into escape_glyph. */
5829 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5832 else if (it
->f
== last_escape_glyph_frame
5833 && it
->face_id
== last_escape_glyph_face_id
)
5835 face_id
= last_escape_glyph_merged_face_id
;
5839 /* Merge the escape-glyph face into the current face. */
5840 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5842 last_escape_glyph_frame
= it
->f
;
5843 last_escape_glyph_face_id
= it
->face_id
;
5844 last_escape_glyph_merged_face_id
= face_id
;
5847 /* Handle soft hyphens in the mode where they only get
5850 if (EQ (Vnobreak_char_display
, Qt
)
5854 XSETINT (it
->ctl_chars
[0], '-');
5856 goto display_control
;
5859 /* Handle non-break space and soft hyphen
5860 with the escape glyph. */
5862 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5864 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5865 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5866 XSETINT (it
->ctl_chars
[1], it
->c
);
5868 goto display_control
;
5872 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5876 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5877 if (CHAR_BYTE8_P (it
->c
))
5879 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5882 else if (it
->c
< 256)
5889 /* It's an invalid character, which shouldn't
5890 happen actually, but due to bugs it may
5891 happen. Let's print the char as is, there's
5892 not much meaningful we can do with it. */
5894 str
[1] = it
->c
>> 8;
5895 str
[2] = it
->c
>> 16;
5896 str
[3] = it
->c
>> 24;
5900 for (i
= 0; i
< len
; i
++)
5903 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5904 /* Insert three more glyphs into IT->ctl_chars for
5905 the octal display of the character. */
5906 g
= ((str
[i
] >> 6) & 7) + '0';
5907 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5908 g
= ((str
[i
] >> 3) & 7) + '0';
5909 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5910 g
= (str
[i
] & 7) + '0';
5911 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5917 /* Set up IT->dpvec and return first character from it. */
5918 it
->dpvec_char_len
= it
->len
;
5919 it
->dpvec
= it
->ctl_chars
;
5920 it
->dpend
= it
->dpvec
+ ctl_len
;
5921 it
->current
.dpvec_index
= 0;
5922 it
->dpvec_face_id
= face_id
;
5923 it
->saved_face_id
= it
->face_id
;
5924 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5931 #ifdef HAVE_WINDOW_SYSTEM
5932 /* Adjust face id for a multibyte character. There are no multibyte
5933 character in unibyte text. */
5934 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5937 && FRAME_WINDOW_P (it
->f
))
5939 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5941 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5943 /* Automatic composition with glyph-string. */
5944 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5946 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5950 int pos
= (it
->s
? -1
5951 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5952 : IT_CHARPOS (*it
));
5954 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
5959 /* Is this character the last one of a run of characters with
5960 box? If yes, set IT->end_of_box_run_p to 1. */
5964 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5966 int face_id
= underlying_face_id (it
);
5967 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5971 if (face
->box
== FACE_NO_BOX
)
5973 /* If the box comes from face properties in a
5974 display string, check faces in that string. */
5975 int string_face_id
= face_after_it_pos (it
);
5976 it
->end_of_box_run_p
5977 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5980 /* Otherwise, the box comes from the underlying face.
5981 If this is the last string character displayed, check
5982 the next buffer location. */
5983 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5984 && (it
->current
.overlay_string_index
5985 == it
->n_overlay_strings
- 1))
5989 struct text_pos pos
= it
->current
.pos
;
5990 INC_TEXT_POS (pos
, it
->multibyte_p
);
5992 next_face_id
= face_at_buffer_position
5993 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5994 it
->region_end_charpos
, &ignore
,
5995 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
5997 it
->end_of_box_run_p
5998 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6005 int face_id
= face_after_it_pos (it
);
6006 it
->end_of_box_run_p
6007 = (face_id
!= it
->face_id
6008 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6012 /* Value is 0 if end of buffer or string reached. */
6017 /* Move IT to the next display element.
6019 RESEAT_P non-zero means if called on a newline in buffer text,
6020 skip to the next visible line start.
6022 Functions get_next_display_element and set_iterator_to_next are
6023 separate because I find this arrangement easier to handle than a
6024 get_next_display_element function that also increments IT's
6025 position. The way it is we can first look at an iterator's current
6026 display element, decide whether it fits on a line, and if it does,
6027 increment the iterator position. The other way around we probably
6028 would either need a flag indicating whether the iterator has to be
6029 incremented the next time, or we would have to implement a
6030 decrement position function which would not be easy to write. */
6033 set_iterator_to_next (it
, reseat_p
)
6037 /* Reset flags indicating start and end of a sequence of characters
6038 with box. Reset them at the start of this function because
6039 moving the iterator to a new position might set them. */
6040 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6044 case GET_FROM_BUFFER
:
6045 /* The current display element of IT is a character from
6046 current_buffer. Advance in the buffer, and maybe skip over
6047 invisible lines that are so because of selective display. */
6048 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6049 reseat_at_next_visible_line_start (it
, 0);
6050 else if (it
->cmp_it
.id
>= 0)
6052 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6053 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6054 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6055 it
->cmp_it
.from
= it
->cmp_it
.to
;
6059 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6060 IT_BYTEPOS (*it
), it
->stop_charpos
,
6066 xassert (it
->len
!= 0);
6067 IT_BYTEPOS (*it
) += it
->len
;
6068 IT_CHARPOS (*it
) += 1;
6069 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6073 case GET_FROM_C_STRING
:
6074 /* Current display element of IT is from a C string. */
6075 IT_BYTEPOS (*it
) += it
->len
;
6076 IT_CHARPOS (*it
) += 1;
6079 case GET_FROM_DISPLAY_VECTOR
:
6080 /* Current display element of IT is from a display table entry.
6081 Advance in the display table definition. Reset it to null if
6082 end reached, and continue with characters from buffers/
6084 ++it
->current
.dpvec_index
;
6086 /* Restore face of the iterator to what they were before the
6087 display vector entry (these entries may contain faces). */
6088 it
->face_id
= it
->saved_face_id
;
6090 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6092 int recheck_faces
= it
->ellipsis_p
;
6095 it
->method
= GET_FROM_C_STRING
;
6096 else if (STRINGP (it
->string
))
6097 it
->method
= GET_FROM_STRING
;
6100 it
->method
= GET_FROM_BUFFER
;
6101 it
->object
= it
->w
->buffer
;
6105 it
->current
.dpvec_index
= -1;
6107 /* Skip over characters which were displayed via IT->dpvec. */
6108 if (it
->dpvec_char_len
< 0)
6109 reseat_at_next_visible_line_start (it
, 1);
6110 else if (it
->dpvec_char_len
> 0)
6112 if (it
->method
== GET_FROM_STRING
6113 && it
->n_overlay_strings
> 0)
6114 it
->ignore_overlay_strings_at_pos_p
= 1;
6115 it
->len
= it
->dpvec_char_len
;
6116 set_iterator_to_next (it
, reseat_p
);
6119 /* Maybe recheck faces after display vector */
6121 it
->stop_charpos
= IT_CHARPOS (*it
);
6125 case GET_FROM_STRING
:
6126 /* Current display element is a character from a Lisp string. */
6127 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6128 if (it
->cmp_it
.id
>= 0)
6130 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6131 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6132 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6133 it
->cmp_it
.from
= it
->cmp_it
.to
;
6137 composition_compute_stop_pos (&it
->cmp_it
,
6138 IT_STRING_CHARPOS (*it
),
6139 IT_STRING_BYTEPOS (*it
),
6140 it
->stop_charpos
, it
->string
);
6145 IT_STRING_BYTEPOS (*it
) += it
->len
;
6146 IT_STRING_CHARPOS (*it
) += 1;
6149 consider_string_end
:
6151 if (it
->current
.overlay_string_index
>= 0)
6153 /* IT->string is an overlay string. Advance to the
6154 next, if there is one. */
6155 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6158 next_overlay_string (it
);
6160 setup_for_ellipsis (it
, 0);
6165 /* IT->string is not an overlay string. If we reached
6166 its end, and there is something on IT->stack, proceed
6167 with what is on the stack. This can be either another
6168 string, this time an overlay string, or a buffer. */
6169 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6173 if (it
->method
== GET_FROM_STRING
)
6174 goto consider_string_end
;
6179 case GET_FROM_IMAGE
:
6180 case GET_FROM_STRETCH
:
6181 /* The position etc with which we have to proceed are on
6182 the stack. The position may be at the end of a string,
6183 if the `display' property takes up the whole string. */
6184 xassert (it
->sp
> 0);
6186 if (it
->method
== GET_FROM_STRING
)
6187 goto consider_string_end
;
6191 /* There are no other methods defined, so this should be a bug. */
6195 xassert (it
->method
!= GET_FROM_STRING
6196 || (STRINGP (it
->string
)
6197 && IT_STRING_CHARPOS (*it
) >= 0));
6200 /* Load IT's display element fields with information about the next
6201 display element which comes from a display table entry or from the
6202 result of translating a control character to one of the forms `^C'
6205 IT->dpvec holds the glyphs to return as characters.
6206 IT->saved_face_id holds the face id before the display vector--
6207 it is restored into IT->face_idin set_iterator_to_next. */
6210 next_element_from_display_vector (it
)
6216 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6218 it
->face_id
= it
->saved_face_id
;
6220 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6221 That seemed totally bogus - so I changed it... */
6222 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6224 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6226 it
->c
= GLYPH_CODE_CHAR (gc
);
6227 it
->len
= CHAR_BYTES (it
->c
);
6229 /* The entry may contain a face id to use. Such a face id is
6230 the id of a Lisp face, not a realized face. A face id of
6231 zero means no face is specified. */
6232 if (it
->dpvec_face_id
>= 0)
6233 it
->face_id
= it
->dpvec_face_id
;
6236 int lface_id
= GLYPH_CODE_FACE (gc
);
6238 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6243 /* Display table entry is invalid. Return a space. */
6244 it
->c
= ' ', it
->len
= 1;
6246 /* Don't change position and object of the iterator here. They are
6247 still the values of the character that had this display table
6248 entry or was translated, and that's what we want. */
6249 it
->what
= IT_CHARACTER
;
6254 /* Load IT with the next display element from Lisp string IT->string.
6255 IT->current.string_pos is the current position within the string.
6256 If IT->current.overlay_string_index >= 0, the Lisp string is an
6260 next_element_from_string (it
)
6263 struct text_pos position
;
6265 xassert (STRINGP (it
->string
));
6266 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6267 position
= it
->current
.string_pos
;
6269 /* Time to check for invisible text? */
6270 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6271 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6275 /* Since a handler may have changed IT->method, we must
6277 return GET_NEXT_DISPLAY_ELEMENT (it
);
6280 if (it
->current
.overlay_string_index
>= 0)
6282 /* Get the next character from an overlay string. In overlay
6283 strings, There is no field width or padding with spaces to
6285 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6290 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6291 IT_STRING_BYTEPOS (*it
))
6292 && next_element_from_composition (it
))
6296 else if (STRING_MULTIBYTE (it
->string
))
6298 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6299 const unsigned char *s
= (SDATA (it
->string
)
6300 + IT_STRING_BYTEPOS (*it
));
6301 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6305 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6311 /* Get the next character from a Lisp string that is not an
6312 overlay string. Such strings come from the mode line, for
6313 example. We may have to pad with spaces, or truncate the
6314 string. See also next_element_from_c_string. */
6315 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6320 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6322 /* Pad with spaces. */
6323 it
->c
= ' ', it
->len
= 1;
6324 CHARPOS (position
) = BYTEPOS (position
) = -1;
6326 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6327 IT_STRING_BYTEPOS (*it
))
6328 && next_element_from_composition (it
))
6332 else if (STRING_MULTIBYTE (it
->string
))
6334 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6335 const unsigned char *s
= (SDATA (it
->string
)
6336 + IT_STRING_BYTEPOS (*it
));
6337 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6341 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6346 /* Record what we have and where it came from. */
6347 it
->what
= IT_CHARACTER
;
6348 it
->object
= it
->string
;
6349 it
->position
= position
;
6354 /* Load IT with next display element from C string IT->s.
6355 IT->string_nchars is the maximum number of characters to return
6356 from the string. IT->end_charpos may be greater than
6357 IT->string_nchars when this function is called, in which case we
6358 may have to return padding spaces. Value is zero if end of string
6359 reached, including padding spaces. */
6362 next_element_from_c_string (it
)
6368 it
->what
= IT_CHARACTER
;
6369 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6372 /* IT's position can be greater IT->string_nchars in case a field
6373 width or precision has been specified when the iterator was
6375 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6377 /* End of the game. */
6381 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6383 /* Pad with spaces. */
6384 it
->c
= ' ', it
->len
= 1;
6385 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6387 else if (it
->multibyte_p
)
6389 /* Implementation note: The calls to strlen apparently aren't a
6390 performance problem because there is no noticeable performance
6391 difference between Emacs running in unibyte or multibyte mode. */
6392 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6393 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6397 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6403 /* Set up IT to return characters from an ellipsis, if appropriate.
6404 The definition of the ellipsis glyphs may come from a display table
6405 entry. This function Fills IT with the first glyph from the
6406 ellipsis if an ellipsis is to be displayed. */
6409 next_element_from_ellipsis (it
)
6412 if (it
->selective_display_ellipsis_p
)
6413 setup_for_ellipsis (it
, it
->len
);
6416 /* The face at the current position may be different from the
6417 face we find after the invisible text. Remember what it
6418 was in IT->saved_face_id, and signal that it's there by
6419 setting face_before_selective_p. */
6420 it
->saved_face_id
= it
->face_id
;
6421 it
->method
= GET_FROM_BUFFER
;
6422 it
->object
= it
->w
->buffer
;
6423 reseat_at_next_visible_line_start (it
, 1);
6424 it
->face_before_selective_p
= 1;
6427 return GET_NEXT_DISPLAY_ELEMENT (it
);
6431 /* Deliver an image display element. The iterator IT is already
6432 filled with image information (done in handle_display_prop). Value
6437 next_element_from_image (it
)
6440 it
->what
= IT_IMAGE
;
6445 /* Fill iterator IT with next display element from a stretch glyph
6446 property. IT->object is the value of the text property. Value is
6450 next_element_from_stretch (it
)
6453 it
->what
= IT_STRETCH
;
6458 /* Load IT with the next display element from current_buffer. Value
6459 is zero if end of buffer reached. IT->stop_charpos is the next
6460 position at which to stop and check for text properties or buffer
6464 next_element_from_buffer (it
)
6469 xassert (IT_CHARPOS (*it
) >= BEGV
);
6471 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6473 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6475 int overlay_strings_follow_p
;
6477 /* End of the game, except when overlay strings follow that
6478 haven't been returned yet. */
6479 if (it
->overlay_strings_at_end_processed_p
)
6480 overlay_strings_follow_p
= 0;
6483 it
->overlay_strings_at_end_processed_p
= 1;
6484 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6487 if (overlay_strings_follow_p
)
6488 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6492 it
->position
= it
->current
.pos
;
6499 return GET_NEXT_DISPLAY_ELEMENT (it
);
6504 /* No face changes, overlays etc. in sight, so just return a
6505 character from current_buffer. */
6508 /* Maybe run the redisplay end trigger hook. Performance note:
6509 This doesn't seem to cost measurable time. */
6510 if (it
->redisplay_end_trigger_charpos
6512 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6513 run_redisplay_end_trigger_hook (it
);
6515 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
))
6516 && next_element_from_composition (it
))
6521 /* Get the next character, maybe multibyte. */
6522 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6523 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6524 it
->c
= STRING_CHAR_AND_LENGTH (p
, 0, it
->len
);
6526 it
->c
= *p
, it
->len
= 1;
6528 /* Record what we have and where it came from. */
6529 it
->what
= IT_CHARACTER
;
6530 it
->object
= it
->w
->buffer
;
6531 it
->position
= it
->current
.pos
;
6533 /* Normally we return the character found above, except when we
6534 really want to return an ellipsis for selective display. */
6539 /* A value of selective > 0 means hide lines indented more
6540 than that number of columns. */
6541 if (it
->selective
> 0
6542 && IT_CHARPOS (*it
) + 1 < ZV
6543 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6544 IT_BYTEPOS (*it
) + 1,
6545 (double) it
->selective
)) /* iftc */
6547 success_p
= next_element_from_ellipsis (it
);
6548 it
->dpvec_char_len
= -1;
6551 else if (it
->c
== '\r' && it
->selective
== -1)
6553 /* A value of selective == -1 means that everything from the
6554 CR to the end of the line is invisible, with maybe an
6555 ellipsis displayed for it. */
6556 success_p
= next_element_from_ellipsis (it
);
6557 it
->dpvec_char_len
= -1;
6562 /* Value is zero if end of buffer reached. */
6563 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6568 /* Run the redisplay end trigger hook for IT. */
6571 run_redisplay_end_trigger_hook (it
)
6574 Lisp_Object args
[3];
6576 /* IT->glyph_row should be non-null, i.e. we should be actually
6577 displaying something, or otherwise we should not run the hook. */
6578 xassert (it
->glyph_row
);
6580 /* Set up hook arguments. */
6581 args
[0] = Qredisplay_end_trigger_functions
;
6582 args
[1] = it
->window
;
6583 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6584 it
->redisplay_end_trigger_charpos
= 0;
6586 /* Since we are *trying* to run these functions, don't try to run
6587 them again, even if they get an error. */
6588 it
->w
->redisplay_end_trigger
= Qnil
;
6589 Frun_hook_with_args (3, args
);
6591 /* Notice if it changed the face of the character we are on. */
6592 handle_face_prop (it
);
6596 /* Deliver a composition display element. Unlike the other
6597 next_element_from_XXX, this function is not registered in the array
6598 get_next_element[]. It is called from next_element_from_buffer and
6599 next_element_from_string when necessary. */
6602 next_element_from_composition (it
)
6605 it
->what
= IT_COMPOSITION
;
6606 it
->len
= it
->cmp_it
.nbytes
;
6607 if (STRINGP (it
->string
))
6611 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6612 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6615 it
->position
= it
->current
.string_pos
;
6616 it
->object
= it
->string
;
6617 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6618 IT_STRING_BYTEPOS (*it
), it
->string
);
6624 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6625 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6628 it
->position
= it
->current
.pos
;
6629 it
->object
= it
->w
->buffer
;
6630 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6631 IT_BYTEPOS (*it
), Qnil
);
6638 /***********************************************************************
6639 Moving an iterator without producing glyphs
6640 ***********************************************************************/
6642 /* Check if iterator is at a position corresponding to a valid buffer
6643 position after some move_it_ call. */
6645 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6646 ((it)->method == GET_FROM_STRING \
6647 ? IT_STRING_CHARPOS (*it) == 0 \
6651 /* Move iterator IT to a specified buffer or X position within one
6652 line on the display without producing glyphs.
6654 OP should be a bit mask including some or all of these bits:
6655 MOVE_TO_X: Stop on reaching x-position TO_X.
6656 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6657 Regardless of OP's value, stop in reaching the end of the display line.
6659 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6660 This means, in particular, that TO_X includes window's horizontal
6663 The return value has several possible values that
6664 say what condition caused the scan to stop:
6666 MOVE_POS_MATCH_OR_ZV
6667 - when TO_POS or ZV was reached.
6670 -when TO_X was reached before TO_POS or ZV were reached.
6673 - when we reached the end of the display area and the line must
6677 - when we reached the end of the display area and the line is
6681 - when we stopped at a line end, i.e. a newline or a CR and selective
6684 static enum move_it_result
6685 move_it_in_display_line_to (struct it
*it
,
6686 EMACS_INT to_charpos
, int to_x
,
6687 enum move_operation_enum op
)
6689 enum move_it_result result
= MOVE_UNDEFINED
;
6690 struct glyph_row
*saved_glyph_row
;
6691 struct it wrap_it
, atpos_it
, atx_it
;
6694 /* Don't produce glyphs in produce_glyphs. */
6695 saved_glyph_row
= it
->glyph_row
;
6696 it
->glyph_row
= NULL
;
6698 /* Use wrap_it to save a copy of IT wherever a word wrap could
6699 occur. Use atpos_it to save a copy of IT at the desired buffer
6700 position, if found, so that we can scan ahead and check if the
6701 word later overshoots the window edge. Use atx_it similarly, for
6707 #define BUFFER_POS_REACHED_P() \
6708 ((op & MOVE_TO_POS) != 0 \
6709 && BUFFERP (it->object) \
6710 && IT_CHARPOS (*it) >= to_charpos \
6711 && (it->method == GET_FROM_BUFFER \
6712 || (it->method == GET_FROM_DISPLAY_VECTOR \
6713 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6715 /* If there's a line-/wrap-prefix, handle it. */
6716 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6717 && it
->current_y
< it
->last_visible_y
)
6718 handle_line_prefix (it
);
6722 int x
, i
, ascent
= 0, descent
= 0;
6724 /* Utility macro to reset an iterator with x, ascent, and descent. */
6725 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6726 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6727 (IT)->max_descent = descent)
6729 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6731 if ((op
& MOVE_TO_POS
) != 0
6732 && BUFFERP (it
->object
)
6733 && it
->method
== GET_FROM_BUFFER
6734 && IT_CHARPOS (*it
) > to_charpos
)
6736 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6738 result
= MOVE_POS_MATCH_OR_ZV
;
6741 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6742 /* If wrap_it is valid, the current position might be in a
6743 word that is wrapped. So, save the iterator in
6744 atpos_it and continue to see if wrapping happens. */
6748 /* Stop when ZV reached.
6749 We used to stop here when TO_CHARPOS reached as well, but that is
6750 too soon if this glyph does not fit on this line. So we handle it
6751 explicitly below. */
6752 if (!get_next_display_element (it
))
6754 result
= MOVE_POS_MATCH_OR_ZV
;
6758 if (it
->line_wrap
== TRUNCATE
)
6760 if (BUFFER_POS_REACHED_P ())
6762 result
= MOVE_POS_MATCH_OR_ZV
;
6768 if (it
->line_wrap
== WORD_WRAP
)
6770 if (IT_DISPLAYING_WHITESPACE (it
))
6774 /* We have reached a glyph that follows one or more
6775 whitespace characters. If the position is
6776 already found, we are done. */
6777 if (atpos_it
.sp
>= 0)
6780 result
= MOVE_POS_MATCH_OR_ZV
;
6786 result
= MOVE_X_REACHED
;
6789 /* Otherwise, we can wrap here. */
6796 /* Remember the line height for the current line, in case
6797 the next element doesn't fit on the line. */
6798 ascent
= it
->max_ascent
;
6799 descent
= it
->max_descent
;
6801 /* The call to produce_glyphs will get the metrics of the
6802 display element IT is loaded with. Record the x-position
6803 before this display element, in case it doesn't fit on the
6807 PRODUCE_GLYPHS (it
);
6809 if (it
->area
!= TEXT_AREA
)
6811 set_iterator_to_next (it
, 1);
6815 /* The number of glyphs we get back in IT->nglyphs will normally
6816 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6817 character on a terminal frame, or (iii) a line end. For the
6818 second case, IT->nglyphs - 1 padding glyphs will be present
6819 (on X frames, there is only one glyph produced for a
6820 composite character.
6822 The behavior implemented below means, for continuation lines,
6823 that as many spaces of a TAB as fit on the current line are
6824 displayed there. For terminal frames, as many glyphs of a
6825 multi-glyph character are displayed in the current line, too.
6826 This is what the old redisplay code did, and we keep it that
6827 way. Under X, the whole shape of a complex character must
6828 fit on the line or it will be completely displayed in the
6831 Note that both for tabs and padding glyphs, all glyphs have
6835 /* More than one glyph or glyph doesn't fit on line. All
6836 glyphs have the same width. */
6837 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6839 int x_before_this_char
= x
;
6840 int hpos_before_this_char
= it
->hpos
;
6842 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6844 new_x
= x
+ single_glyph_width
;
6846 /* We want to leave anything reaching TO_X to the caller. */
6847 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6849 if (BUFFER_POS_REACHED_P ())
6851 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6852 goto buffer_pos_reached
;
6853 if (atpos_it
.sp
< 0)
6856 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6861 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6864 result
= MOVE_X_REACHED
;
6870 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
6875 if (/* Lines are continued. */
6876 it
->line_wrap
!= TRUNCATE
6877 && (/* And glyph doesn't fit on the line. */
6878 new_x
> it
->last_visible_x
6879 /* Or it fits exactly and we're on a window
6881 || (new_x
== it
->last_visible_x
6882 && FRAME_WINDOW_P (it
->f
))))
6884 if (/* IT->hpos == 0 means the very first glyph
6885 doesn't fit on the line, e.g. a wide image. */
6887 || (new_x
== it
->last_visible_x
6888 && FRAME_WINDOW_P (it
->f
)))
6891 it
->current_x
= new_x
;
6893 /* The character's last glyph just barely fits
6895 if (i
== it
->nglyphs
- 1)
6897 /* If this is the destination position,
6898 return a position *before* it in this row,
6899 now that we know it fits in this row. */
6900 if (BUFFER_POS_REACHED_P ())
6902 if (it
->line_wrap
!= WORD_WRAP
6905 it
->hpos
= hpos_before_this_char
;
6906 it
->current_x
= x_before_this_char
;
6907 result
= MOVE_POS_MATCH_OR_ZV
;
6910 if (it
->line_wrap
== WORD_WRAP
6914 atpos_it
.current_x
= x_before_this_char
;
6915 atpos_it
.hpos
= hpos_before_this_char
;
6919 set_iterator_to_next (it
, 1);
6920 #ifdef HAVE_WINDOW_SYSTEM
6921 /* One graphical terminals, newlines may
6922 "overflow" into the fringe if
6923 overflow-newline-into-fringe is non-nil.
6924 On text-only terminals, newlines may
6925 overflow into the last glyph on the
6927 if (!FRAME_WINDOW_P (it
->f
)
6928 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6930 if (!get_next_display_element (it
))
6932 result
= MOVE_POS_MATCH_OR_ZV
;
6935 if (BUFFER_POS_REACHED_P ())
6937 if (ITERATOR_AT_END_OF_LINE_P (it
))
6938 result
= MOVE_POS_MATCH_OR_ZV
;
6940 result
= MOVE_LINE_CONTINUED
;
6943 if (ITERATOR_AT_END_OF_LINE_P (it
))
6945 result
= MOVE_NEWLINE_OR_CR
;
6949 #endif /* HAVE_WINDOW_SYSTEM */
6953 IT_RESET_X_ASCENT_DESCENT (it
);
6955 if (wrap_it
.sp
>= 0)
6962 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6964 result
= MOVE_LINE_CONTINUED
;
6968 if (BUFFER_POS_REACHED_P ())
6970 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6971 goto buffer_pos_reached
;
6972 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6975 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6979 if (new_x
> it
->first_visible_x
)
6981 /* Glyph is visible. Increment number of glyphs that
6982 would be displayed. */
6987 if (result
!= MOVE_UNDEFINED
)
6990 else if (BUFFER_POS_REACHED_P ())
6993 IT_RESET_X_ASCENT_DESCENT (it
);
6994 result
= MOVE_POS_MATCH_OR_ZV
;
6997 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6999 /* Stop when TO_X specified and reached. This check is
7000 necessary here because of lines consisting of a line end,
7001 only. The line end will not produce any glyphs and we
7002 would never get MOVE_X_REACHED. */
7003 xassert (it
->nglyphs
== 0);
7004 result
= MOVE_X_REACHED
;
7008 /* Is this a line end? If yes, we're done. */
7009 if (ITERATOR_AT_END_OF_LINE_P (it
))
7011 result
= MOVE_NEWLINE_OR_CR
;
7015 /* The current display element has been consumed. Advance
7017 set_iterator_to_next (it
, 1);
7019 /* Stop if lines are truncated and IT's current x-position is
7020 past the right edge of the window now. */
7021 if (it
->line_wrap
== TRUNCATE
7022 && it
->current_x
>= it
->last_visible_x
)
7024 #ifdef HAVE_WINDOW_SYSTEM
7025 if (!FRAME_WINDOW_P (it
->f
)
7026 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7028 if (!get_next_display_element (it
)
7029 || BUFFER_POS_REACHED_P ())
7031 result
= MOVE_POS_MATCH_OR_ZV
;
7034 if (ITERATOR_AT_END_OF_LINE_P (it
))
7036 result
= MOVE_NEWLINE_OR_CR
;
7040 #endif /* HAVE_WINDOW_SYSTEM */
7041 result
= MOVE_LINE_TRUNCATED
;
7044 #undef IT_RESET_X_ASCENT_DESCENT
7047 #undef BUFFER_POS_REACHED_P
7049 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7050 restore the saved iterator. */
7051 if (atpos_it
.sp
>= 0)
7053 else if (atx_it
.sp
>= 0)
7058 /* Restore the iterator settings altered at the beginning of this
7060 it
->glyph_row
= saved_glyph_row
;
7064 /* For external use. */
7066 move_it_in_display_line (struct it
*it
,
7067 EMACS_INT to_charpos
, int to_x
,
7068 enum move_operation_enum op
)
7070 if (it
->line_wrap
== WORD_WRAP
7071 && (op
& MOVE_TO_X
))
7073 struct it save_it
= *it
;
7074 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7075 /* When word-wrap is on, TO_X may lie past the end
7076 of a wrapped line. Then it->current is the
7077 character on the next line, so backtrack to the
7078 space before the wrap point. */
7079 if (skip
== MOVE_LINE_CONTINUED
)
7081 int prev_x
= max (it
->current_x
- 1, 0);
7083 move_it_in_display_line_to
7084 (it
, -1, prev_x
, MOVE_TO_X
);
7088 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7092 /* Move IT forward until it satisfies one or more of the criteria in
7093 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7095 OP is a bit-mask that specifies where to stop, and in particular,
7096 which of those four position arguments makes a difference. See the
7097 description of enum move_operation_enum.
7099 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7100 screen line, this function will set IT to the next position >
7104 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7106 int to_charpos
, to_x
, to_y
, to_vpos
;
7109 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7115 if (op
& MOVE_TO_VPOS
)
7117 /* If no TO_CHARPOS and no TO_X specified, stop at the
7118 start of the line TO_VPOS. */
7119 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7121 if (it
->vpos
== to_vpos
)
7127 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7131 /* TO_VPOS >= 0 means stop at TO_X in the line at
7132 TO_VPOS, or at TO_POS, whichever comes first. */
7133 if (it
->vpos
== to_vpos
)
7139 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7141 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7146 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7148 /* We have reached TO_X but not in the line we want. */
7149 skip
= move_it_in_display_line_to (it
, to_charpos
,
7151 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7159 else if (op
& MOVE_TO_Y
)
7161 struct it it_backup
;
7163 if (it
->line_wrap
== WORD_WRAP
)
7166 /* TO_Y specified means stop at TO_X in the line containing
7167 TO_Y---or at TO_CHARPOS if this is reached first. The
7168 problem is that we can't really tell whether the line
7169 contains TO_Y before we have completely scanned it, and
7170 this may skip past TO_X. What we do is to first scan to
7173 If TO_X is not specified, use a TO_X of zero. The reason
7174 is to make the outcome of this function more predictable.
7175 If we didn't use TO_X == 0, we would stop at the end of
7176 the line which is probably not what a caller would expect
7178 skip
= move_it_in_display_line_to
7179 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7180 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7182 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7183 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7185 else if (skip
== MOVE_X_REACHED
)
7187 /* If TO_X was reached, we want to know whether TO_Y is
7188 in the line. We know this is the case if the already
7189 scanned glyphs make the line tall enough. Otherwise,
7190 we must check by scanning the rest of the line. */
7191 line_height
= it
->max_ascent
+ it
->max_descent
;
7192 if (to_y
>= it
->current_y
7193 && to_y
< it
->current_y
+ line_height
)
7199 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7200 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7202 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7203 line_height
= it
->max_ascent
+ it
->max_descent
;
7204 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7206 if (to_y
>= it
->current_y
7207 && to_y
< it
->current_y
+ line_height
)
7209 /* If TO_Y is in this line and TO_X was reached
7210 above, we scanned too far. We have to restore
7211 IT's settings to the ones before skipping. */
7218 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7224 /* Check whether TO_Y is in this line. */
7225 line_height
= it
->max_ascent
+ it
->max_descent
;
7226 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7228 if (to_y
>= it
->current_y
7229 && to_y
< it
->current_y
+ line_height
)
7231 /* When word-wrap is on, TO_X may lie past the end
7232 of a wrapped line. Then it->current is the
7233 character on the next line, so backtrack to the
7234 space before the wrap point. */
7235 if (skip
== MOVE_LINE_CONTINUED
7236 && it
->line_wrap
== WORD_WRAP
)
7238 int prev_x
= max (it
->current_x
- 1, 0);
7240 skip
= move_it_in_display_line_to
7241 (it
, -1, prev_x
, MOVE_TO_X
);
7250 else if (BUFFERP (it
->object
)
7251 && (it
->method
== GET_FROM_BUFFER
7252 || it
->method
== GET_FROM_STRETCH
)
7253 && IT_CHARPOS (*it
) >= to_charpos
)
7254 skip
= MOVE_POS_MATCH_OR_ZV
;
7256 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7260 case MOVE_POS_MATCH_OR_ZV
:
7264 case MOVE_NEWLINE_OR_CR
:
7265 set_iterator_to_next (it
, 1);
7266 it
->continuation_lines_width
= 0;
7269 case MOVE_LINE_TRUNCATED
:
7270 it
->continuation_lines_width
= 0;
7271 reseat_at_next_visible_line_start (it
, 0);
7272 if ((op
& MOVE_TO_POS
) != 0
7273 && IT_CHARPOS (*it
) > to_charpos
)
7280 case MOVE_LINE_CONTINUED
:
7281 /* For continued lines ending in a tab, some of the glyphs
7282 associated with the tab are displayed on the current
7283 line. Since it->current_x does not include these glyphs,
7284 we use it->last_visible_x instead. */
7287 it
->continuation_lines_width
+= it
->last_visible_x
;
7288 /* When moving by vpos, ensure that the iterator really
7289 advances to the next line (bug#847, bug#969). Fixme:
7290 do we need to do this in other circumstances? */
7291 if (it
->current_x
!= it
->last_visible_x
7292 && (op
& MOVE_TO_VPOS
)
7293 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7294 set_iterator_to_next (it
, 0);
7297 it
->continuation_lines_width
+= it
->current_x
;
7304 /* Reset/increment for the next run. */
7305 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7306 it
->current_x
= it
->hpos
= 0;
7307 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7309 last_height
= it
->max_ascent
+ it
->max_descent
;
7310 last_max_ascent
= it
->max_ascent
;
7311 it
->max_ascent
= it
->max_descent
= 0;
7316 /* On text terminals, we may stop at the end of a line in the middle
7317 of a multi-character glyph. If the glyph itself is continued,
7318 i.e. it is actually displayed on the next line, don't treat this
7319 stopping point as valid; move to the next line instead (unless
7320 that brings us offscreen). */
7321 if (!FRAME_WINDOW_P (it
->f
)
7323 && IT_CHARPOS (*it
) == to_charpos
7324 && it
->what
== IT_CHARACTER
7326 && it
->line_wrap
== WINDOW_WRAP
7327 && it
->current_x
== it
->last_visible_x
- 1
7330 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7332 it
->continuation_lines_width
+= it
->current_x
;
7333 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7334 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7336 last_height
= it
->max_ascent
+ it
->max_descent
;
7337 last_max_ascent
= it
->max_ascent
;
7340 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7344 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7346 If DY > 0, move IT backward at least that many pixels. DY = 0
7347 means move IT backward to the preceding line start or BEGV. This
7348 function may move over more than DY pixels if IT->current_y - DY
7349 ends up in the middle of a line; in this case IT->current_y will be
7350 set to the top of the line moved to. */
7353 move_it_vertically_backward (it
, dy
)
7364 start_pos
= IT_CHARPOS (*it
);
7366 /* Estimate how many newlines we must move back. */
7367 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7369 /* Set the iterator's position that many lines back. */
7370 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7371 back_to_previous_visible_line_start (it
);
7373 /* Reseat the iterator here. When moving backward, we don't want
7374 reseat to skip forward over invisible text, set up the iterator
7375 to deliver from overlay strings at the new position etc. So,
7376 use reseat_1 here. */
7377 reseat_1 (it
, it
->current
.pos
, 1);
7379 /* We are now surely at a line start. */
7380 it
->current_x
= it
->hpos
= 0;
7381 it
->continuation_lines_width
= 0;
7383 /* Move forward and see what y-distance we moved. First move to the
7384 start of the next line so that we get its height. We need this
7385 height to be able to tell whether we reached the specified
7388 it2
.max_ascent
= it2
.max_descent
= 0;
7391 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7392 MOVE_TO_POS
| MOVE_TO_VPOS
);
7394 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7395 xassert (IT_CHARPOS (*it
) >= BEGV
);
7398 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7399 xassert (IT_CHARPOS (*it
) >= BEGV
);
7400 /* H is the actual vertical distance from the position in *IT
7401 and the starting position. */
7402 h
= it2
.current_y
- it
->current_y
;
7403 /* NLINES is the distance in number of lines. */
7404 nlines
= it2
.vpos
- it
->vpos
;
7406 /* Correct IT's y and vpos position
7407 so that they are relative to the starting point. */
7413 /* DY == 0 means move to the start of the screen line. The
7414 value of nlines is > 0 if continuation lines were involved. */
7416 move_it_by_lines (it
, nlines
, 1);
7418 /* I think this assert is bogus if buffer contains
7419 invisible text or images. KFS. */
7420 xassert (IT_CHARPOS (*it
) <= start_pos
);
7425 /* The y-position we try to reach, relative to *IT.
7426 Note that H has been subtracted in front of the if-statement. */
7427 int target_y
= it
->current_y
+ h
- dy
;
7428 int y0
= it3
.current_y
;
7429 int y1
= line_bottom_y (&it3
);
7430 int line_height
= y1
- y0
;
7432 /* If we did not reach target_y, try to move further backward if
7433 we can. If we moved too far backward, try to move forward. */
7434 if (target_y
< it
->current_y
7435 /* This is heuristic. In a window that's 3 lines high, with
7436 a line height of 13 pixels each, recentering with point
7437 on the bottom line will try to move -39/2 = 19 pixels
7438 backward. Try to avoid moving into the first line. */
7439 && (it
->current_y
- target_y
7440 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7441 && IT_CHARPOS (*it
) > BEGV
)
7443 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7444 target_y
- it
->current_y
));
7445 dy
= it
->current_y
- target_y
;
7446 goto move_further_back
;
7448 else if (target_y
>= it
->current_y
+ line_height
7449 && IT_CHARPOS (*it
) < ZV
)
7451 /* Should move forward by at least one line, maybe more.
7453 Note: Calling move_it_by_lines can be expensive on
7454 terminal frames, where compute_motion is used (via
7455 vmotion) to do the job, when there are very long lines
7456 and truncate-lines is nil. That's the reason for
7457 treating terminal frames specially here. */
7459 if (!FRAME_WINDOW_P (it
->f
))
7460 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7465 move_it_by_lines (it
, 1, 1);
7467 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7471 /* I think this assert is bogus if buffer contains
7472 invisible text or images. KFS. */
7473 xassert (IT_CHARPOS (*it
) >= BEGV
);
7480 /* Move IT by a specified amount of pixel lines DY. DY negative means
7481 move backwards. DY = 0 means move to start of screen line. At the
7482 end, IT will be on the start of a screen line. */
7485 move_it_vertically (it
, dy
)
7490 move_it_vertically_backward (it
, -dy
);
7493 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7494 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7495 MOVE_TO_POS
| MOVE_TO_Y
);
7496 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7498 /* If buffer ends in ZV without a newline, move to the start of
7499 the line to satisfy the post-condition. */
7500 if (IT_CHARPOS (*it
) == ZV
7502 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7503 move_it_by_lines (it
, 0, 0);
7508 /* Move iterator IT past the end of the text line it is in. */
7511 move_it_past_eol (it
)
7514 enum move_it_result rc
;
7516 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7517 if (rc
== MOVE_NEWLINE_OR_CR
)
7518 set_iterator_to_next (it
, 0);
7522 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7523 negative means move up. DVPOS == 0 means move to the start of the
7524 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7525 NEED_Y_P is zero, IT->current_y will be left unchanged.
7527 Further optimization ideas: If we would know that IT->f doesn't use
7528 a face with proportional font, we could be faster for
7529 truncate-lines nil. */
7532 move_it_by_lines (it
, dvpos
, need_y_p
)
7534 int dvpos
, need_y_p
;
7536 struct position pos
;
7538 /* The commented-out optimization uses vmotion on terminals. This
7539 gives bad results, because elements like it->what, on which
7540 callers such as pos_visible_p rely, aren't updated. */
7541 /* if (!FRAME_WINDOW_P (it->f))
7543 struct text_pos textpos;
7545 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7546 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7547 reseat (it, textpos, 1);
7548 it->vpos += pos.vpos;
7549 it->current_y += pos.vpos;
7555 /* DVPOS == 0 means move to the start of the screen line. */
7556 move_it_vertically_backward (it
, 0);
7557 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7558 /* Let next call to line_bottom_y calculate real line height */
7563 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7564 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7565 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7570 int start_charpos
, i
;
7572 /* Start at the beginning of the screen line containing IT's
7573 position. This may actually move vertically backwards,
7574 in case of overlays, so adjust dvpos accordingly. */
7576 move_it_vertically_backward (it
, 0);
7579 /* Go back -DVPOS visible lines and reseat the iterator there. */
7580 start_charpos
= IT_CHARPOS (*it
);
7581 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7582 back_to_previous_visible_line_start (it
);
7583 reseat (it
, it
->current
.pos
, 1);
7585 /* Move further back if we end up in a string or an image. */
7586 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7588 /* First try to move to start of display line. */
7590 move_it_vertically_backward (it
, 0);
7592 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7594 /* If start of line is still in string or image,
7595 move further back. */
7596 back_to_previous_visible_line_start (it
);
7597 reseat (it
, it
->current
.pos
, 1);
7601 it
->current_x
= it
->hpos
= 0;
7603 /* Above call may have moved too far if continuation lines
7604 are involved. Scan forward and see if it did. */
7606 it2
.vpos
= it2
.current_y
= 0;
7607 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7608 it
->vpos
-= it2
.vpos
;
7609 it
->current_y
-= it2
.current_y
;
7610 it
->current_x
= it
->hpos
= 0;
7612 /* If we moved too far back, move IT some lines forward. */
7613 if (it2
.vpos
> -dvpos
)
7615 int delta
= it2
.vpos
+ dvpos
;
7617 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7618 /* Move back again if we got too far ahead. */
7619 if (IT_CHARPOS (*it
) >= start_charpos
)
7625 /* Return 1 if IT points into the middle of a display vector. */
7628 in_display_vector_p (it
)
7631 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7632 && it
->current
.dpvec_index
> 0
7633 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7637 /***********************************************************************
7639 ***********************************************************************/
7642 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7646 add_to_log (format
, arg1
, arg2
)
7648 Lisp_Object arg1
, arg2
;
7650 Lisp_Object args
[3];
7651 Lisp_Object msg
, fmt
;
7654 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7657 /* Do nothing if called asynchronously. Inserting text into
7658 a buffer may call after-change-functions and alike and
7659 that would means running Lisp asynchronously. */
7660 if (handling_signal
)
7664 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7666 args
[0] = fmt
= build_string (format
);
7669 msg
= Fformat (3, args
);
7671 len
= SBYTES (msg
) + 1;
7672 SAFE_ALLOCA (buffer
, char *, len
);
7673 bcopy (SDATA (msg
), buffer
, len
);
7675 message_dolog (buffer
, len
- 1, 1, 0);
7682 /* Output a newline in the *Messages* buffer if "needs" one. */
7685 message_log_maybe_newline ()
7687 if (message_log_need_newline
)
7688 message_dolog ("", 0, 1, 0);
7692 /* Add a string M of length NBYTES to the message log, optionally
7693 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7694 nonzero, means interpret the contents of M as multibyte. This
7695 function calls low-level routines in order to bypass text property
7696 hooks, etc. which might not be safe to run.
7698 This may GC (insert may run before/after change hooks),
7699 so the buffer M must NOT point to a Lisp string. */
7702 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7704 int nbytes
, nlflag
, multibyte
;
7706 if (!NILP (Vmemory_full
))
7709 if (!NILP (Vmessage_log_max
))
7711 struct buffer
*oldbuf
;
7712 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7713 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7714 int point_at_end
= 0;
7716 Lisp_Object old_deactivate_mark
, tem
;
7717 struct gcpro gcpro1
;
7719 old_deactivate_mark
= Vdeactivate_mark
;
7720 oldbuf
= current_buffer
;
7721 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7722 current_buffer
->undo_list
= Qt
;
7724 oldpoint
= message_dolog_marker1
;
7725 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7726 oldbegv
= message_dolog_marker2
;
7727 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7728 oldzv
= message_dolog_marker3
;
7729 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7730 GCPRO1 (old_deactivate_mark
);
7738 BEGV_BYTE
= BEG_BYTE
;
7741 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7743 /* Insert the string--maybe converting multibyte to single byte
7744 or vice versa, so that all the text fits the buffer. */
7746 && NILP (current_buffer
->enable_multibyte_characters
))
7748 int i
, c
, char_bytes
;
7749 unsigned char work
[1];
7751 /* Convert a multibyte string to single-byte
7752 for the *Message* buffer. */
7753 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7755 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7756 work
[0] = (ASCII_CHAR_P (c
)
7758 : multibyte_char_to_unibyte (c
, Qnil
));
7759 insert_1_both (work
, 1, 1, 1, 0, 0);
7762 else if (! multibyte
7763 && ! NILP (current_buffer
->enable_multibyte_characters
))
7765 int i
, c
, char_bytes
;
7766 unsigned char *msg
= (unsigned char *) m
;
7767 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7768 /* Convert a single-byte string to multibyte
7769 for the *Message* buffer. */
7770 for (i
= 0; i
< nbytes
; i
++)
7773 c
= unibyte_char_to_multibyte (c
);
7774 char_bytes
= CHAR_STRING (c
, str
);
7775 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7779 insert_1 (m
, nbytes
, 1, 0, 0);
7783 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7784 insert_1 ("\n", 1, 1, 0, 0);
7786 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7788 this_bol_byte
= PT_BYTE
;
7790 /* See if this line duplicates the previous one.
7791 If so, combine duplicates. */
7794 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7796 prev_bol_byte
= PT_BYTE
;
7798 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7799 this_bol
, this_bol_byte
);
7802 del_range_both (prev_bol
, prev_bol_byte
,
7803 this_bol
, this_bol_byte
, 0);
7809 /* If you change this format, don't forget to also
7810 change message_log_check_duplicate. */
7811 sprintf (dupstr
, " [%d times]", dup
);
7812 duplen
= strlen (dupstr
);
7813 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7814 insert_1 (dupstr
, duplen
, 1, 0, 1);
7819 /* If we have more than the desired maximum number of lines
7820 in the *Messages* buffer now, delete the oldest ones.
7821 This is safe because we don't have undo in this buffer. */
7823 if (NATNUMP (Vmessage_log_max
))
7825 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7826 -XFASTINT (Vmessage_log_max
) - 1, 0);
7827 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7830 BEGV
= XMARKER (oldbegv
)->charpos
;
7831 BEGV_BYTE
= marker_byte_position (oldbegv
);
7840 ZV
= XMARKER (oldzv
)->charpos
;
7841 ZV_BYTE
= marker_byte_position (oldzv
);
7845 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7847 /* We can't do Fgoto_char (oldpoint) because it will run some
7849 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7850 XMARKER (oldpoint
)->bytepos
);
7853 unchain_marker (XMARKER (oldpoint
));
7854 unchain_marker (XMARKER (oldbegv
));
7855 unchain_marker (XMARKER (oldzv
));
7857 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7858 set_buffer_internal (oldbuf
);
7860 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7861 message_log_need_newline
= !nlflag
;
7862 Vdeactivate_mark
= old_deactivate_mark
;
7867 /* We are at the end of the buffer after just having inserted a newline.
7868 (Note: We depend on the fact we won't be crossing the gap.)
7869 Check to see if the most recent message looks a lot like the previous one.
7870 Return 0 if different, 1 if the new one should just replace it, or a
7871 value N > 1 if we should also append " [N times]". */
7874 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7875 int prev_bol
, this_bol
;
7876 int prev_bol_byte
, this_bol_byte
;
7879 int len
= Z_BYTE
- 1 - this_bol_byte
;
7881 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7882 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7884 for (i
= 0; i
< len
; i
++)
7886 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7894 if (*p1
++ == ' ' && *p1
++ == '[')
7897 while (*p1
>= '0' && *p1
<= '9')
7898 n
= n
* 10 + *p1
++ - '0';
7899 if (strncmp (p1
, " times]\n", 8) == 0)
7906 /* Display an echo area message M with a specified length of NBYTES
7907 bytes. The string may include null characters. If M is 0, clear
7908 out any existing message, and let the mini-buffer text show
7911 This may GC, so the buffer M must NOT point to a Lisp string. */
7914 message2 (m
, nbytes
, multibyte
)
7919 /* First flush out any partial line written with print. */
7920 message_log_maybe_newline ();
7922 message_dolog (m
, nbytes
, 1, multibyte
);
7923 message2_nolog (m
, nbytes
, multibyte
);
7927 /* The non-logging counterpart of message2. */
7930 message2_nolog (m
, nbytes
, multibyte
)
7932 int nbytes
, multibyte
;
7934 struct frame
*sf
= SELECTED_FRAME ();
7935 message_enable_multibyte
= multibyte
;
7937 if (FRAME_INITIAL_P (sf
))
7939 if (noninteractive_need_newline
)
7940 putc ('\n', stderr
);
7941 noninteractive_need_newline
= 0;
7943 fwrite (m
, nbytes
, 1, stderr
);
7944 if (cursor_in_echo_area
== 0)
7945 fprintf (stderr
, "\n");
7948 /* A null message buffer means that the frame hasn't really been
7949 initialized yet. Error messages get reported properly by
7950 cmd_error, so this must be just an informative message; toss it. */
7951 else if (INTERACTIVE
7952 && sf
->glyphs_initialized_p
7953 && FRAME_MESSAGE_BUF (sf
))
7955 Lisp_Object mini_window
;
7958 /* Get the frame containing the mini-buffer
7959 that the selected frame is using. */
7960 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7961 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7963 FRAME_SAMPLE_VISIBILITY (f
);
7964 if (FRAME_VISIBLE_P (sf
)
7965 && ! FRAME_VISIBLE_P (f
))
7966 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7970 set_message (m
, Qnil
, nbytes
, multibyte
);
7971 if (minibuffer_auto_raise
)
7972 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7975 clear_message (1, 1);
7977 do_pending_window_change (0);
7978 echo_area_display (1);
7979 do_pending_window_change (0);
7980 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7981 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7986 /* Display an echo area message M with a specified length of NBYTES
7987 bytes. The string may include null characters. If M is not a
7988 string, clear out any existing message, and let the mini-buffer
7991 This function cancels echoing. */
7994 message3 (m
, nbytes
, multibyte
)
7999 struct gcpro gcpro1
;
8002 clear_message (1,1);
8005 /* First flush out any partial line written with print. */
8006 message_log_maybe_newline ();
8012 SAFE_ALLOCA (buffer
, char *, nbytes
);
8013 bcopy (SDATA (m
), buffer
, nbytes
);
8014 message_dolog (buffer
, nbytes
, 1, multibyte
);
8017 message3_nolog (m
, nbytes
, multibyte
);
8023 /* The non-logging version of message3.
8024 This does not cancel echoing, because it is used for echoing.
8025 Perhaps we need to make a separate function for echoing
8026 and make this cancel echoing. */
8029 message3_nolog (m
, nbytes
, multibyte
)
8031 int nbytes
, multibyte
;
8033 struct frame
*sf
= SELECTED_FRAME ();
8034 message_enable_multibyte
= multibyte
;
8036 if (FRAME_INITIAL_P (sf
))
8038 if (noninteractive_need_newline
)
8039 putc ('\n', stderr
);
8040 noninteractive_need_newline
= 0;
8042 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8043 if (cursor_in_echo_area
== 0)
8044 fprintf (stderr
, "\n");
8047 /* A null message buffer means that the frame hasn't really been
8048 initialized yet. Error messages get reported properly by
8049 cmd_error, so this must be just an informative message; toss it. */
8050 else if (INTERACTIVE
8051 && sf
->glyphs_initialized_p
8052 && FRAME_MESSAGE_BUF (sf
))
8054 Lisp_Object mini_window
;
8058 /* Get the frame containing the mini-buffer
8059 that the selected frame is using. */
8060 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8061 frame
= XWINDOW (mini_window
)->frame
;
8064 FRAME_SAMPLE_VISIBILITY (f
);
8065 if (FRAME_VISIBLE_P (sf
)
8066 && !FRAME_VISIBLE_P (f
))
8067 Fmake_frame_visible (frame
);
8069 if (STRINGP (m
) && SCHARS (m
) > 0)
8071 set_message (NULL
, m
, nbytes
, multibyte
);
8072 if (minibuffer_auto_raise
)
8073 Fraise_frame (frame
);
8074 /* Assume we are not echoing.
8075 (If we are, echo_now will override this.) */
8076 echo_message_buffer
= Qnil
;
8079 clear_message (1, 1);
8081 do_pending_window_change (0);
8082 echo_area_display (1);
8083 do_pending_window_change (0);
8084 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8085 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8090 /* Display a null-terminated echo area message M. If M is 0, clear
8091 out any existing message, and let the mini-buffer text show through.
8093 The buffer M must continue to exist until after the echo area gets
8094 cleared or some other message gets displayed there. Do not pass
8095 text that is stored in a Lisp string. Do not pass text in a buffer
8096 that was alloca'd. */
8102 message2 (m
, (m
? strlen (m
) : 0), 0);
8106 /* The non-logging counterpart of message1. */
8112 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8115 /* Display a message M which contains a single %s
8116 which gets replaced with STRING. */
8119 message_with_string (m
, string
, log
)
8124 CHECK_STRING (string
);
8130 if (noninteractive_need_newline
)
8131 putc ('\n', stderr
);
8132 noninteractive_need_newline
= 0;
8133 fprintf (stderr
, m
, SDATA (string
));
8134 if (!cursor_in_echo_area
)
8135 fprintf (stderr
, "\n");
8139 else if (INTERACTIVE
)
8141 /* The frame whose minibuffer we're going to display the message on.
8142 It may be larger than the selected frame, so we need
8143 to use its buffer, not the selected frame's buffer. */
8144 Lisp_Object mini_window
;
8145 struct frame
*f
, *sf
= SELECTED_FRAME ();
8147 /* Get the frame containing the minibuffer
8148 that the selected frame is using. */
8149 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8150 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8152 /* A null message buffer means that the frame hasn't really been
8153 initialized yet. Error messages get reported properly by
8154 cmd_error, so this must be just an informative message; toss it. */
8155 if (FRAME_MESSAGE_BUF (f
))
8157 Lisp_Object args
[2], message
;
8158 struct gcpro gcpro1
, gcpro2
;
8160 args
[0] = build_string (m
);
8161 args
[1] = message
= string
;
8162 GCPRO2 (args
[0], message
);
8165 message
= Fformat (2, args
);
8168 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8170 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8174 /* Print should start at the beginning of the message
8175 buffer next time. */
8176 message_buf_print
= 0;
8182 /* Dump an informative message to the minibuf. If M is 0, clear out
8183 any existing message, and let the mini-buffer text show through. */
8187 message (m
, a1
, a2
, a3
)
8189 EMACS_INT a1
, a2
, a3
;
8195 if (noninteractive_need_newline
)
8196 putc ('\n', stderr
);
8197 noninteractive_need_newline
= 0;
8198 fprintf (stderr
, m
, a1
, a2
, a3
);
8199 if (cursor_in_echo_area
== 0)
8200 fprintf (stderr
, "\n");
8204 else if (INTERACTIVE
)
8206 /* The frame whose mini-buffer we're going to display the message
8207 on. It may be larger than the selected frame, so we need to
8208 use its buffer, not the selected frame's buffer. */
8209 Lisp_Object mini_window
;
8210 struct frame
*f
, *sf
= SELECTED_FRAME ();
8212 /* Get the frame containing the mini-buffer
8213 that the selected frame is using. */
8214 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8215 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8217 /* A null message buffer means that the frame hasn't really been
8218 initialized yet. Error messages get reported properly by
8219 cmd_error, so this must be just an informative message; toss
8221 if (FRAME_MESSAGE_BUF (f
))
8232 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8233 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8235 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8236 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8238 #endif /* NO_ARG_ARRAY */
8240 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8245 /* Print should start at the beginning of the message
8246 buffer next time. */
8247 message_buf_print
= 0;
8253 /* The non-logging version of message. */
8256 message_nolog (m
, a1
, a2
, a3
)
8258 EMACS_INT a1
, a2
, a3
;
8260 Lisp_Object old_log_max
;
8261 old_log_max
= Vmessage_log_max
;
8262 Vmessage_log_max
= Qnil
;
8263 message (m
, a1
, a2
, a3
);
8264 Vmessage_log_max
= old_log_max
;
8268 /* Display the current message in the current mini-buffer. This is
8269 only called from error handlers in process.c, and is not time
8275 if (!NILP (echo_area_buffer
[0]))
8278 string
= Fcurrent_message ();
8279 message3 (string
, SBYTES (string
),
8280 !NILP (current_buffer
->enable_multibyte_characters
));
8285 /* Make sure echo area buffers in `echo_buffers' are live.
8286 If they aren't, make new ones. */
8289 ensure_echo_area_buffers ()
8293 for (i
= 0; i
< 2; ++i
)
8294 if (!BUFFERP (echo_buffer
[i
])
8295 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8298 Lisp_Object old_buffer
;
8301 old_buffer
= echo_buffer
[i
];
8302 sprintf (name
, " *Echo Area %d*", i
);
8303 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8304 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8305 /* to force word wrap in echo area -
8306 it was decided to postpone this*/
8307 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8309 for (j
= 0; j
< 2; ++j
)
8310 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8311 echo_area_buffer
[j
] = echo_buffer
[i
];
8316 /* Call FN with args A1..A4 with either the current or last displayed
8317 echo_area_buffer as current buffer.
8319 WHICH zero means use the current message buffer
8320 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8321 from echo_buffer[] and clear it.
8323 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8324 suitable buffer from echo_buffer[] and clear it.
8326 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8327 that the current message becomes the last displayed one, make
8328 choose a suitable buffer for echo_area_buffer[0], and clear it.
8330 Value is what FN returns. */
8333 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8336 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8342 int this_one
, the_other
, clear_buffer_p
, rc
;
8343 int count
= SPECPDL_INDEX ();
8345 /* If buffers aren't live, make new ones. */
8346 ensure_echo_area_buffers ();
8351 this_one
= 0, the_other
= 1;
8353 this_one
= 1, the_other
= 0;
8356 this_one
= 0, the_other
= 1;
8359 /* We need a fresh one in case the current echo buffer equals
8360 the one containing the last displayed echo area message. */
8361 if (!NILP (echo_area_buffer
[this_one
])
8362 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8363 echo_area_buffer
[this_one
] = Qnil
;
8366 /* Choose a suitable buffer from echo_buffer[] is we don't
8368 if (NILP (echo_area_buffer
[this_one
]))
8370 echo_area_buffer
[this_one
]
8371 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8372 ? echo_buffer
[the_other
]
8373 : echo_buffer
[this_one
]);
8377 buffer
= echo_area_buffer
[this_one
];
8379 /* Don't get confused by reusing the buffer used for echoing
8380 for a different purpose. */
8381 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8384 record_unwind_protect (unwind_with_echo_area_buffer
,
8385 with_echo_area_buffer_unwind_data (w
));
8387 /* Make the echo area buffer current. Note that for display
8388 purposes, it is not necessary that the displayed window's buffer
8389 == current_buffer, except for text property lookup. So, let's
8390 only set that buffer temporarily here without doing a full
8391 Fset_window_buffer. We must also change w->pointm, though,
8392 because otherwise an assertions in unshow_buffer fails, and Emacs
8394 set_buffer_internal_1 (XBUFFER (buffer
));
8398 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8401 current_buffer
->undo_list
= Qt
;
8402 current_buffer
->read_only
= Qnil
;
8403 specbind (Qinhibit_read_only
, Qt
);
8404 specbind (Qinhibit_modification_hooks
, Qt
);
8406 if (clear_buffer_p
&& Z
> BEG
)
8409 xassert (BEGV
>= BEG
);
8410 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8412 rc
= fn (a1
, a2
, a3
, a4
);
8414 xassert (BEGV
>= BEG
);
8415 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8417 unbind_to (count
, Qnil
);
8422 /* Save state that should be preserved around the call to the function
8423 FN called in with_echo_area_buffer. */
8426 with_echo_area_buffer_unwind_data (w
)
8430 Lisp_Object vector
, tmp
;
8432 /* Reduce consing by keeping one vector in
8433 Vwith_echo_area_save_vector. */
8434 vector
= Vwith_echo_area_save_vector
;
8435 Vwith_echo_area_save_vector
= Qnil
;
8438 vector
= Fmake_vector (make_number (7), Qnil
);
8440 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8441 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8442 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8446 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8447 ASET (vector
, i
, w
->buffer
); ++i
;
8448 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8449 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8454 for (; i
< end
; ++i
)
8455 ASET (vector
, i
, Qnil
);
8458 xassert (i
== ASIZE (vector
));
8463 /* Restore global state from VECTOR which was created by
8464 with_echo_area_buffer_unwind_data. */
8467 unwind_with_echo_area_buffer (vector
)
8470 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8471 Vdeactivate_mark
= AREF (vector
, 1);
8472 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8474 if (WINDOWP (AREF (vector
, 3)))
8477 Lisp_Object buffer
, charpos
, bytepos
;
8479 w
= XWINDOW (AREF (vector
, 3));
8480 buffer
= AREF (vector
, 4);
8481 charpos
= AREF (vector
, 5);
8482 bytepos
= AREF (vector
, 6);
8485 set_marker_both (w
->pointm
, buffer
,
8486 XFASTINT (charpos
), XFASTINT (bytepos
));
8489 Vwith_echo_area_save_vector
= vector
;
8494 /* Set up the echo area for use by print functions. MULTIBYTE_P
8495 non-zero means we will print multibyte. */
8498 setup_echo_area_for_printing (multibyte_p
)
8501 /* If we can't find an echo area any more, exit. */
8502 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8505 ensure_echo_area_buffers ();
8507 if (!message_buf_print
)
8509 /* A message has been output since the last time we printed.
8510 Choose a fresh echo area buffer. */
8511 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8512 echo_area_buffer
[0] = echo_buffer
[1];
8514 echo_area_buffer
[0] = echo_buffer
[0];
8516 /* Switch to that buffer and clear it. */
8517 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8518 current_buffer
->truncate_lines
= Qnil
;
8522 int count
= SPECPDL_INDEX ();
8523 specbind (Qinhibit_read_only
, Qt
);
8524 /* Note that undo recording is always disabled. */
8526 unbind_to (count
, Qnil
);
8528 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8530 /* Set up the buffer for the multibyteness we need. */
8532 != !NILP (current_buffer
->enable_multibyte_characters
))
8533 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8535 /* Raise the frame containing the echo area. */
8536 if (minibuffer_auto_raise
)
8538 struct frame
*sf
= SELECTED_FRAME ();
8539 Lisp_Object mini_window
;
8540 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8541 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8544 message_log_maybe_newline ();
8545 message_buf_print
= 1;
8549 if (NILP (echo_area_buffer
[0]))
8551 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8552 echo_area_buffer
[0] = echo_buffer
[1];
8554 echo_area_buffer
[0] = echo_buffer
[0];
8557 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8559 /* Someone switched buffers between print requests. */
8560 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8561 current_buffer
->truncate_lines
= Qnil
;
8567 /* Display an echo area message in window W. Value is non-zero if W's
8568 height is changed. If display_last_displayed_message_p is
8569 non-zero, display the message that was last displayed, otherwise
8570 display the current message. */
8573 display_echo_area (w
)
8576 int i
, no_message_p
, window_height_changed_p
, count
;
8578 /* Temporarily disable garbage collections while displaying the echo
8579 area. This is done because a GC can print a message itself.
8580 That message would modify the echo area buffer's contents while a
8581 redisplay of the buffer is going on, and seriously confuse
8583 count
= inhibit_garbage_collection ();
8585 /* If there is no message, we must call display_echo_area_1
8586 nevertheless because it resizes the window. But we will have to
8587 reset the echo_area_buffer in question to nil at the end because
8588 with_echo_area_buffer will sets it to an empty buffer. */
8589 i
= display_last_displayed_message_p
? 1 : 0;
8590 no_message_p
= NILP (echo_area_buffer
[i
]);
8592 window_height_changed_p
8593 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8594 display_echo_area_1
,
8595 (EMACS_INT
) w
, Qnil
, 0, 0);
8598 echo_area_buffer
[i
] = Qnil
;
8600 unbind_to (count
, Qnil
);
8601 return window_height_changed_p
;
8605 /* Helper for display_echo_area. Display the current buffer which
8606 contains the current echo area message in window W, a mini-window,
8607 a pointer to which is passed in A1. A2..A4 are currently not used.
8608 Change the height of W so that all of the message is displayed.
8609 Value is non-zero if height of W was changed. */
8612 display_echo_area_1 (a1
, a2
, a3
, a4
)
8617 struct window
*w
= (struct window
*) a1
;
8619 struct text_pos start
;
8620 int window_height_changed_p
= 0;
8622 /* Do this before displaying, so that we have a large enough glyph
8623 matrix for the display. If we can't get enough space for the
8624 whole text, display the last N lines. That works by setting w->start. */
8625 window_height_changed_p
= resize_mini_window (w
, 0);
8627 /* Use the starting position chosen by resize_mini_window. */
8628 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8631 clear_glyph_matrix (w
->desired_matrix
);
8632 XSETWINDOW (window
, w
);
8633 try_window (window
, start
, 0);
8635 return window_height_changed_p
;
8639 /* Resize the echo area window to exactly the size needed for the
8640 currently displayed message, if there is one. If a mini-buffer
8641 is active, don't shrink it. */
8644 resize_echo_area_exactly ()
8646 if (BUFFERP (echo_area_buffer
[0])
8647 && WINDOWP (echo_area_window
))
8649 struct window
*w
= XWINDOW (echo_area_window
);
8651 Lisp_Object resize_exactly
;
8653 if (minibuf_level
== 0)
8654 resize_exactly
= Qt
;
8656 resize_exactly
= Qnil
;
8658 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8659 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8662 ++windows_or_buffers_changed
;
8663 ++update_mode_lines
;
8664 redisplay_internal (0);
8670 /* Callback function for with_echo_area_buffer, when used from
8671 resize_echo_area_exactly. A1 contains a pointer to the window to
8672 resize, EXACTLY non-nil means resize the mini-window exactly to the
8673 size of the text displayed. A3 and A4 are not used. Value is what
8674 resize_mini_window returns. */
8677 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8679 Lisp_Object exactly
;
8682 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8686 /* Resize mini-window W to fit the size of its contents. EXACT_P
8687 means size the window exactly to the size needed. Otherwise, it's
8688 only enlarged until W's buffer is empty.
8690 Set W->start to the right place to begin display. If the whole
8691 contents fit, start at the beginning. Otherwise, start so as
8692 to make the end of the contents appear. This is particularly
8693 important for y-or-n-p, but seems desirable generally.
8695 Value is non-zero if the window height has been changed. */
8698 resize_mini_window (w
, exact_p
)
8702 struct frame
*f
= XFRAME (w
->frame
);
8703 int window_height_changed_p
= 0;
8705 xassert (MINI_WINDOW_P (w
));
8707 /* By default, start display at the beginning. */
8708 set_marker_both (w
->start
, w
->buffer
,
8709 BUF_BEGV (XBUFFER (w
->buffer
)),
8710 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8712 /* Don't resize windows while redisplaying a window; it would
8713 confuse redisplay functions when the size of the window they are
8714 displaying changes from under them. Such a resizing can happen,
8715 for instance, when which-func prints a long message while
8716 we are running fontification-functions. We're running these
8717 functions with safe_call which binds inhibit-redisplay to t. */
8718 if (!NILP (Vinhibit_redisplay
))
8721 /* Nil means don't try to resize. */
8722 if (NILP (Vresize_mini_windows
)
8723 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8726 if (!FRAME_MINIBUF_ONLY_P (f
))
8729 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8730 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8731 int height
, max_height
;
8732 int unit
= FRAME_LINE_HEIGHT (f
);
8733 struct text_pos start
;
8734 struct buffer
*old_current_buffer
= NULL
;
8736 if (current_buffer
!= XBUFFER (w
->buffer
))
8738 old_current_buffer
= current_buffer
;
8739 set_buffer_internal (XBUFFER (w
->buffer
));
8742 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8744 /* Compute the max. number of lines specified by the user. */
8745 if (FLOATP (Vmax_mini_window_height
))
8746 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8747 else if (INTEGERP (Vmax_mini_window_height
))
8748 max_height
= XINT (Vmax_mini_window_height
);
8750 max_height
= total_height
/ 4;
8752 /* Correct that max. height if it's bogus. */
8753 max_height
= max (1, max_height
);
8754 max_height
= min (total_height
, max_height
);
8756 /* Find out the height of the text in the window. */
8757 if (it
.line_wrap
== TRUNCATE
)
8762 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8763 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8764 height
= it
.current_y
+ last_height
;
8766 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8767 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8768 height
= (height
+ unit
- 1) / unit
;
8771 /* Compute a suitable window start. */
8772 if (height
> max_height
)
8774 height
= max_height
;
8775 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8776 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8777 start
= it
.current
.pos
;
8780 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8781 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8783 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8785 /* Let it grow only, until we display an empty message, in which
8786 case the window shrinks again. */
8787 if (height
> WINDOW_TOTAL_LINES (w
))
8789 int old_height
= WINDOW_TOTAL_LINES (w
);
8790 freeze_window_starts (f
, 1);
8791 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8792 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8794 else if (height
< WINDOW_TOTAL_LINES (w
)
8795 && (exact_p
|| BEGV
== ZV
))
8797 int old_height
= WINDOW_TOTAL_LINES (w
);
8798 freeze_window_starts (f
, 0);
8799 shrink_mini_window (w
);
8800 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8805 /* Always resize to exact size needed. */
8806 if (height
> WINDOW_TOTAL_LINES (w
))
8808 int old_height
= WINDOW_TOTAL_LINES (w
);
8809 freeze_window_starts (f
, 1);
8810 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8811 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8813 else if (height
< WINDOW_TOTAL_LINES (w
))
8815 int old_height
= WINDOW_TOTAL_LINES (w
);
8816 freeze_window_starts (f
, 0);
8817 shrink_mini_window (w
);
8821 freeze_window_starts (f
, 1);
8822 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8825 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8829 if (old_current_buffer
)
8830 set_buffer_internal (old_current_buffer
);
8833 return window_height_changed_p
;
8837 /* Value is the current message, a string, or nil if there is no
8845 if (!BUFFERP (echo_area_buffer
[0]))
8849 with_echo_area_buffer (0, 0, current_message_1
,
8850 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8852 echo_area_buffer
[0] = Qnil
;
8860 current_message_1 (a1
, a2
, a3
, a4
)
8865 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8868 *msg
= make_buffer_string (BEG
, Z
, 1);
8875 /* Push the current message on Vmessage_stack for later restauration
8876 by restore_message. Value is non-zero if the current message isn't
8877 empty. This is a relatively infrequent operation, so it's not
8878 worth optimizing. */
8884 msg
= current_message ();
8885 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8886 return STRINGP (msg
);
8890 /* Restore message display from the top of Vmessage_stack. */
8897 xassert (CONSP (Vmessage_stack
));
8898 msg
= XCAR (Vmessage_stack
);
8900 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8902 message3_nolog (msg
, 0, 0);
8906 /* Handler for record_unwind_protect calling pop_message. */
8909 pop_message_unwind (dummy
)
8916 /* Pop the top-most entry off Vmessage_stack. */
8921 xassert (CONSP (Vmessage_stack
));
8922 Vmessage_stack
= XCDR (Vmessage_stack
);
8926 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8927 exits. If the stack is not empty, we have a missing pop_message
8931 check_message_stack ()
8933 if (!NILP (Vmessage_stack
))
8938 /* Truncate to NCHARS what will be displayed in the echo area the next
8939 time we display it---but don't redisplay it now. */
8942 truncate_echo_area (nchars
)
8946 echo_area_buffer
[0] = Qnil
;
8947 /* A null message buffer means that the frame hasn't really been
8948 initialized yet. Error messages get reported properly by
8949 cmd_error, so this must be just an informative message; toss it. */
8950 else if (!noninteractive
8952 && !NILP (echo_area_buffer
[0]))
8954 struct frame
*sf
= SELECTED_FRAME ();
8955 if (FRAME_MESSAGE_BUF (sf
))
8956 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8961 /* Helper function for truncate_echo_area. Truncate the current
8962 message to at most NCHARS characters. */
8965 truncate_message_1 (nchars
, a2
, a3
, a4
)
8970 if (BEG
+ nchars
< Z
)
8971 del_range (BEG
+ nchars
, Z
);
8973 echo_area_buffer
[0] = Qnil
;
8978 /* Set the current message to a substring of S or STRING.
8980 If STRING is a Lisp string, set the message to the first NBYTES
8981 bytes from STRING. NBYTES zero means use the whole string. If
8982 STRING is multibyte, the message will be displayed multibyte.
8984 If S is not null, set the message to the first LEN bytes of S. LEN
8985 zero means use the whole string. MULTIBYTE_P non-zero means S is
8986 multibyte. Display the message multibyte in that case.
8988 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8989 to t before calling set_message_1 (which calls insert).
8993 set_message (s
, string
, nbytes
, multibyte_p
)
8996 int nbytes
, multibyte_p
;
8998 message_enable_multibyte
8999 = ((s
&& multibyte_p
)
9000 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9002 with_echo_area_buffer (0, -1, set_message_1
,
9003 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9004 message_buf_print
= 0;
9005 help_echo_showing_p
= 0;
9009 /* Helper function for set_message. Arguments have the same meaning
9010 as there, with A1 corresponding to S and A2 corresponding to STRING
9011 This function is called with the echo area buffer being
9015 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9018 EMACS_INT nbytes
, multibyte_p
;
9020 const char *s
= (const char *) a1
;
9021 Lisp_Object string
= a2
;
9023 /* Change multibyteness of the echo buffer appropriately. */
9024 if (message_enable_multibyte
9025 != !NILP (current_buffer
->enable_multibyte_characters
))
9026 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9028 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9030 /* Insert new message at BEG. */
9031 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9033 if (STRINGP (string
))
9038 nbytes
= SBYTES (string
);
9039 nchars
= string_byte_to_char (string
, nbytes
);
9041 /* This function takes care of single/multibyte conversion. We
9042 just have to ensure that the echo area buffer has the right
9043 setting of enable_multibyte_characters. */
9044 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9049 nbytes
= strlen (s
);
9051 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9053 /* Convert from multi-byte to single-byte. */
9055 unsigned char work
[1];
9057 /* Convert a multibyte string to single-byte. */
9058 for (i
= 0; i
< nbytes
; i
+= n
)
9060 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
9061 work
[0] = (ASCII_CHAR_P (c
)
9063 : multibyte_char_to_unibyte (c
, Qnil
));
9064 insert_1_both (work
, 1, 1, 1, 0, 0);
9067 else if (!multibyte_p
9068 && !NILP (current_buffer
->enable_multibyte_characters
))
9070 /* Convert from single-byte to multi-byte. */
9072 const unsigned char *msg
= (const unsigned char *) s
;
9073 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9075 /* Convert a single-byte string to multibyte. */
9076 for (i
= 0; i
< nbytes
; i
++)
9079 c
= unibyte_char_to_multibyte (c
);
9080 n
= CHAR_STRING (c
, str
);
9081 insert_1_both (str
, 1, n
, 1, 0, 0);
9085 insert_1 (s
, nbytes
, 1, 0, 0);
9092 /* Clear messages. CURRENT_P non-zero means clear the current
9093 message. LAST_DISPLAYED_P non-zero means clear the message
9097 clear_message (current_p
, last_displayed_p
)
9098 int current_p
, last_displayed_p
;
9102 echo_area_buffer
[0] = Qnil
;
9103 message_cleared_p
= 1;
9106 if (last_displayed_p
)
9107 echo_area_buffer
[1] = Qnil
;
9109 message_buf_print
= 0;
9112 /* Clear garbaged frames.
9114 This function is used where the old redisplay called
9115 redraw_garbaged_frames which in turn called redraw_frame which in
9116 turn called clear_frame. The call to clear_frame was a source of
9117 flickering. I believe a clear_frame is not necessary. It should
9118 suffice in the new redisplay to invalidate all current matrices,
9119 and ensure a complete redisplay of all windows. */
9122 clear_garbaged_frames ()
9126 Lisp_Object tail
, frame
;
9127 int changed_count
= 0;
9129 FOR_EACH_FRAME (tail
, frame
)
9131 struct frame
*f
= XFRAME (frame
);
9133 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9137 Fredraw_frame (frame
);
9138 f
->force_flush_display_p
= 1;
9140 clear_current_matrices (f
);
9149 ++windows_or_buffers_changed
;
9154 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9155 is non-zero update selected_frame. Value is non-zero if the
9156 mini-windows height has been changed. */
9159 echo_area_display (update_frame_p
)
9162 Lisp_Object mini_window
;
9165 int window_height_changed_p
= 0;
9166 struct frame
*sf
= SELECTED_FRAME ();
9168 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9169 w
= XWINDOW (mini_window
);
9170 f
= XFRAME (WINDOW_FRAME (w
));
9172 /* Don't display if frame is invisible or not yet initialized. */
9173 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9176 #ifdef HAVE_WINDOW_SYSTEM
9177 /* When Emacs starts, selected_frame may be the initial terminal
9178 frame. If we let this through, a message would be displayed on
9180 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9182 #endif /* HAVE_WINDOW_SYSTEM */
9184 /* Redraw garbaged frames. */
9186 clear_garbaged_frames ();
9188 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9190 echo_area_window
= mini_window
;
9191 window_height_changed_p
= display_echo_area (w
);
9192 w
->must_be_updated_p
= 1;
9194 /* Update the display, unless called from redisplay_internal.
9195 Also don't update the screen during redisplay itself. The
9196 update will happen at the end of redisplay, and an update
9197 here could cause confusion. */
9198 if (update_frame_p
&& !redisplaying_p
)
9202 /* If the display update has been interrupted by pending
9203 input, update mode lines in the frame. Due to the
9204 pending input, it might have been that redisplay hasn't
9205 been called, so that mode lines above the echo area are
9206 garbaged. This looks odd, so we prevent it here. */
9207 if (!display_completed
)
9208 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9210 if (window_height_changed_p
9211 /* Don't do this if Emacs is shutting down. Redisplay
9212 needs to run hooks. */
9213 && !NILP (Vrun_hooks
))
9215 /* Must update other windows. Likewise as in other
9216 cases, don't let this update be interrupted by
9218 int count
= SPECPDL_INDEX ();
9219 specbind (Qredisplay_dont_pause
, Qt
);
9220 windows_or_buffers_changed
= 1;
9221 redisplay_internal (0);
9222 unbind_to (count
, Qnil
);
9224 else if (FRAME_WINDOW_P (f
) && n
== 0)
9226 /* Window configuration is the same as before.
9227 Can do with a display update of the echo area,
9228 unless we displayed some mode lines. */
9229 update_single_window (w
, 1);
9230 FRAME_RIF (f
)->flush_display (f
);
9233 update_frame (f
, 1, 1);
9235 /* If cursor is in the echo area, make sure that the next
9236 redisplay displays the minibuffer, so that the cursor will
9237 be replaced with what the minibuffer wants. */
9238 if (cursor_in_echo_area
)
9239 ++windows_or_buffers_changed
;
9242 else if (!EQ (mini_window
, selected_window
))
9243 windows_or_buffers_changed
++;
9245 /* Last displayed message is now the current message. */
9246 echo_area_buffer
[1] = echo_area_buffer
[0];
9247 /* Inform read_char that we're not echoing. */
9248 echo_message_buffer
= Qnil
;
9250 /* Prevent redisplay optimization in redisplay_internal by resetting
9251 this_line_start_pos. This is done because the mini-buffer now
9252 displays the message instead of its buffer text. */
9253 if (EQ (mini_window
, selected_window
))
9254 CHARPOS (this_line_start_pos
) = 0;
9256 return window_height_changed_p
;
9261 /***********************************************************************
9262 Mode Lines and Frame Titles
9263 ***********************************************************************/
9265 /* A buffer for constructing non-propertized mode-line strings and
9266 frame titles in it; allocated from the heap in init_xdisp and
9267 resized as needed in store_mode_line_noprop_char. */
9269 static char *mode_line_noprop_buf
;
9271 /* The buffer's end, and a current output position in it. */
9273 static char *mode_line_noprop_buf_end
;
9274 static char *mode_line_noprop_ptr
;
9276 #define MODE_LINE_NOPROP_LEN(start) \
9277 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9280 MODE_LINE_DISPLAY
= 0,
9286 /* Alist that caches the results of :propertize.
9287 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9288 static Lisp_Object mode_line_proptrans_alist
;
9290 /* List of strings making up the mode-line. */
9291 static Lisp_Object mode_line_string_list
;
9293 /* Base face property when building propertized mode line string. */
9294 static Lisp_Object mode_line_string_face
;
9295 static Lisp_Object mode_line_string_face_prop
;
9298 /* Unwind data for mode line strings */
9300 static Lisp_Object Vmode_line_unwind_vector
;
9303 format_mode_line_unwind_data (struct buffer
*obuf
,
9307 Lisp_Object vector
, tmp
;
9309 /* Reduce consing by keeping one vector in
9310 Vwith_echo_area_save_vector. */
9311 vector
= Vmode_line_unwind_vector
;
9312 Vmode_line_unwind_vector
= Qnil
;
9315 vector
= Fmake_vector (make_number (8), Qnil
);
9317 ASET (vector
, 0, make_number (mode_line_target
));
9318 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9319 ASET (vector
, 2, mode_line_string_list
);
9320 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9321 ASET (vector
, 4, mode_line_string_face
);
9322 ASET (vector
, 5, mode_line_string_face_prop
);
9325 XSETBUFFER (tmp
, obuf
);
9328 ASET (vector
, 6, tmp
);
9329 ASET (vector
, 7, owin
);
9335 unwind_format_mode_line (vector
)
9338 mode_line_target
= XINT (AREF (vector
, 0));
9339 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9340 mode_line_string_list
= AREF (vector
, 2);
9341 if (! EQ (AREF (vector
, 3), Qt
))
9342 mode_line_proptrans_alist
= AREF (vector
, 3);
9343 mode_line_string_face
= AREF (vector
, 4);
9344 mode_line_string_face_prop
= AREF (vector
, 5);
9346 if (!NILP (AREF (vector
, 7)))
9347 /* Select window before buffer, since it may change the buffer. */
9348 Fselect_window (AREF (vector
, 7), Qt
);
9350 if (!NILP (AREF (vector
, 6)))
9352 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9353 ASET (vector
, 6, Qnil
);
9356 Vmode_line_unwind_vector
= vector
;
9361 /* Store a single character C for the frame title in mode_line_noprop_buf.
9362 Re-allocate mode_line_noprop_buf if necessary. */
9366 store_mode_line_noprop_char (char c
)
9368 store_mode_line_noprop_char (c
)
9372 /* If output position has reached the end of the allocated buffer,
9373 double the buffer's size. */
9374 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9376 int len
= MODE_LINE_NOPROP_LEN (0);
9377 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9378 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9379 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9380 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9383 *mode_line_noprop_ptr
++ = c
;
9387 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9388 mode_line_noprop_ptr. STR is the string to store. Do not copy
9389 characters that yield more columns than PRECISION; PRECISION <= 0
9390 means copy the whole string. Pad with spaces until FIELD_WIDTH
9391 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9392 pad. Called from display_mode_element when it is used to build a
9396 store_mode_line_noprop (str
, field_width
, precision
)
9397 const unsigned char *str
;
9398 int field_width
, precision
;
9403 /* Copy at most PRECISION chars from STR. */
9404 nbytes
= strlen (str
);
9405 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9407 store_mode_line_noprop_char (*str
++);
9409 /* Fill up with spaces until FIELD_WIDTH reached. */
9410 while (field_width
> 0
9413 store_mode_line_noprop_char (' ');
9420 /***********************************************************************
9422 ***********************************************************************/
9424 #ifdef HAVE_WINDOW_SYSTEM
9426 /* Set the title of FRAME, if it has changed. The title format is
9427 Vicon_title_format if FRAME is iconified, otherwise it is
9428 frame_title_format. */
9431 x_consider_frame_title (frame
)
9434 struct frame
*f
= XFRAME (frame
);
9436 if (FRAME_WINDOW_P (f
)
9437 || FRAME_MINIBUF_ONLY_P (f
)
9438 || f
->explicit_name
)
9440 /* Do we have more than one visible frame on this X display? */
9447 int count
= SPECPDL_INDEX ();
9449 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9451 Lisp_Object other_frame
= XCAR (tail
);
9452 struct frame
*tf
= XFRAME (other_frame
);
9455 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9456 && !FRAME_MINIBUF_ONLY_P (tf
)
9457 && !EQ (other_frame
, tip_frame
)
9458 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9462 /* Set global variable indicating that multiple frames exist. */
9463 multiple_frames
= CONSP (tail
);
9465 /* Switch to the buffer of selected window of the frame. Set up
9466 mode_line_target so that display_mode_element will output into
9467 mode_line_noprop_buf; then display the title. */
9468 record_unwind_protect (unwind_format_mode_line
,
9469 format_mode_line_unwind_data
9470 (current_buffer
, selected_window
, 0));
9472 Fselect_window (f
->selected_window
, Qt
);
9473 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9474 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9476 mode_line_target
= MODE_LINE_TITLE
;
9477 title_start
= MODE_LINE_NOPROP_LEN (0);
9478 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9479 NULL
, DEFAULT_FACE_ID
);
9480 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9481 len
= MODE_LINE_NOPROP_LEN (title_start
);
9482 title
= mode_line_noprop_buf
+ title_start
;
9483 unbind_to (count
, Qnil
);
9485 /* Set the title only if it's changed. This avoids consing in
9486 the common case where it hasn't. (If it turns out that we've
9487 already wasted too much time by walking through the list with
9488 display_mode_element, then we might need to optimize at a
9489 higher level than this.) */
9490 if (! STRINGP (f
->name
)
9491 || SBYTES (f
->name
) != len
9492 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9497 if (!MINI_WINDOW_P(XWINDOW(f
->selected_window
)))
9500 ns_set_name_as_filename (f
);
9502 x_implicitly_set_name (f
, make_string(title
, len
),
9508 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9513 /* do this also for frames with explicit names */
9514 ns_implicitly_set_icon_type(f
);
9515 ns_set_doc_edited(f
, Fbuffer_modified_p
9516 (XWINDOW (f
->selected_window
)->buffer
), Qnil
);
9522 #endif /* not HAVE_WINDOW_SYSTEM */
9527 /***********************************************************************
9529 ***********************************************************************/
9532 /* Prepare for redisplay by updating menu-bar item lists when
9533 appropriate. This can call eval. */
9536 prepare_menu_bars ()
9539 struct gcpro gcpro1
, gcpro2
;
9541 Lisp_Object tooltip_frame
;
9543 #ifdef HAVE_WINDOW_SYSTEM
9544 tooltip_frame
= tip_frame
;
9546 tooltip_frame
= Qnil
;
9549 /* Update all frame titles based on their buffer names, etc. We do
9550 this before the menu bars so that the buffer-menu will show the
9551 up-to-date frame titles. */
9552 #ifdef HAVE_WINDOW_SYSTEM
9553 if (windows_or_buffers_changed
|| update_mode_lines
)
9555 Lisp_Object tail
, frame
;
9557 FOR_EACH_FRAME (tail
, frame
)
9560 if (!EQ (frame
, tooltip_frame
)
9561 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9562 x_consider_frame_title (frame
);
9565 #endif /* HAVE_WINDOW_SYSTEM */
9567 /* Update the menu bar item lists, if appropriate. This has to be
9568 done before any actual redisplay or generation of display lines. */
9569 all_windows
= (update_mode_lines
9570 || buffer_shared
> 1
9571 || windows_or_buffers_changed
);
9574 Lisp_Object tail
, frame
;
9575 int count
= SPECPDL_INDEX ();
9576 /* 1 means that update_menu_bar has run its hooks
9577 so any further calls to update_menu_bar shouldn't do so again. */
9578 int menu_bar_hooks_run
= 0;
9580 record_unwind_save_match_data ();
9582 FOR_EACH_FRAME (tail
, frame
)
9586 /* Ignore tooltip frame. */
9587 if (EQ (frame
, tooltip_frame
))
9590 /* If a window on this frame changed size, report that to
9591 the user and clear the size-change flag. */
9592 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9594 Lisp_Object functions
;
9596 /* Clear flag first in case we get an error below. */
9597 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9598 functions
= Vwindow_size_change_functions
;
9599 GCPRO2 (tail
, functions
);
9601 while (CONSP (functions
))
9603 if (!EQ (XCAR (functions
), Qt
))
9604 call1 (XCAR (functions
), frame
);
9605 functions
= XCDR (functions
);
9611 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9612 #ifdef HAVE_WINDOW_SYSTEM
9613 update_tool_bar (f
, 0);
9618 unbind_to (count
, Qnil
);
9622 struct frame
*sf
= SELECTED_FRAME ();
9623 update_menu_bar (sf
, 1, 0);
9624 #ifdef HAVE_WINDOW_SYSTEM
9625 update_tool_bar (sf
, 1);
9629 /* Motif needs this. See comment in xmenu.c. Turn it off when
9630 pending_menu_activation is not defined. */
9631 #ifdef USE_X_TOOLKIT
9632 pending_menu_activation
= 0;
9637 /* Update the menu bar item list for frame F. This has to be done
9638 before we start to fill in any display lines, because it can call
9641 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9643 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9644 already ran the menu bar hooks for this redisplay, so there
9645 is no need to run them again. The return value is the
9646 updated value of this flag, to pass to the next call. */
9649 update_menu_bar (f
, save_match_data
, hooks_run
)
9651 int save_match_data
;
9655 register struct window
*w
;
9657 /* If called recursively during a menu update, do nothing. This can
9658 happen when, for instance, an activate-menubar-hook causes a
9660 if (inhibit_menubar_update
)
9663 window
= FRAME_SELECTED_WINDOW (f
);
9664 w
= XWINDOW (window
);
9666 if (FRAME_WINDOW_P (f
)
9668 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9669 || defined (HAVE_NS) || defined (USE_GTK)
9670 FRAME_EXTERNAL_MENU_BAR (f
)
9672 FRAME_MENU_BAR_LINES (f
) > 0
9674 : FRAME_MENU_BAR_LINES (f
) > 0)
9676 /* If the user has switched buffers or windows, we need to
9677 recompute to reflect the new bindings. But we'll
9678 recompute when update_mode_lines is set too; that means
9679 that people can use force-mode-line-update to request
9680 that the menu bar be recomputed. The adverse effect on
9681 the rest of the redisplay algorithm is about the same as
9682 windows_or_buffers_changed anyway. */
9683 if (windows_or_buffers_changed
9684 /* This used to test w->update_mode_line, but we believe
9685 there is no need to recompute the menu in that case. */
9686 || update_mode_lines
9687 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9688 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9689 != !NILP (w
->last_had_star
))
9690 || ((!NILP (Vtransient_mark_mode
)
9691 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9692 != !NILP (w
->region_showing
)))
9694 struct buffer
*prev
= current_buffer
;
9695 int count
= SPECPDL_INDEX ();
9697 specbind (Qinhibit_menubar_update
, Qt
);
9699 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9700 if (save_match_data
)
9701 record_unwind_save_match_data ();
9702 if (NILP (Voverriding_local_map_menu_flag
))
9704 specbind (Qoverriding_terminal_local_map
, Qnil
);
9705 specbind (Qoverriding_local_map
, Qnil
);
9710 /* Run the Lucid hook. */
9711 safe_run_hooks (Qactivate_menubar_hook
);
9713 /* If it has changed current-menubar from previous value,
9714 really recompute the menu-bar from the value. */
9715 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9716 call0 (Qrecompute_lucid_menubar
);
9718 safe_run_hooks (Qmenu_bar_update_hook
);
9723 XSETFRAME (Vmenu_updating_frame
, f
);
9724 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9726 /* Redisplay the menu bar in case we changed it. */
9727 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9728 || defined (HAVE_NS) || defined (USE_GTK)
9729 if (FRAME_WINDOW_P (f
))
9731 #if defined (HAVE_NS)
9732 /* All frames on Mac OS share the same menubar. So only
9733 the selected frame should be allowed to set it. */
9734 if (f
== SELECTED_FRAME ())
9736 set_frame_menubar (f
, 0, 0);
9739 /* On a terminal screen, the menu bar is an ordinary screen
9740 line, and this makes it get updated. */
9741 w
->update_mode_line
= Qt
;
9742 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9743 /* In the non-toolkit version, the menu bar is an ordinary screen
9744 line, and this makes it get updated. */
9745 w
->update_mode_line
= Qt
;
9746 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9748 unbind_to (count
, Qnil
);
9749 set_buffer_internal_1 (prev
);
9758 /***********************************************************************
9760 ***********************************************************************/
9762 #ifdef HAVE_WINDOW_SYSTEM
9765 Nominal cursor position -- where to draw output.
9766 HPOS and VPOS are window relative glyph matrix coordinates.
9767 X and Y are window relative pixel coordinates. */
9769 struct cursor_pos output_cursor
;
9773 Set the global variable output_cursor to CURSOR. All cursor
9774 positions are relative to updated_window. */
9777 set_output_cursor (cursor
)
9778 struct cursor_pos
*cursor
;
9780 output_cursor
.hpos
= cursor
->hpos
;
9781 output_cursor
.vpos
= cursor
->vpos
;
9782 output_cursor
.x
= cursor
->x
;
9783 output_cursor
.y
= cursor
->y
;
9788 Set a nominal cursor position.
9790 HPOS and VPOS are column/row positions in a window glyph matrix. X
9791 and Y are window text area relative pixel positions.
9793 If this is done during an update, updated_window will contain the
9794 window that is being updated and the position is the future output
9795 cursor position for that window. If updated_window is null, use
9796 selected_window and display the cursor at the given position. */
9799 x_cursor_to (vpos
, hpos
, y
, x
)
9800 int vpos
, hpos
, y
, x
;
9804 /* If updated_window is not set, work on selected_window. */
9808 w
= XWINDOW (selected_window
);
9810 /* Set the output cursor. */
9811 output_cursor
.hpos
= hpos
;
9812 output_cursor
.vpos
= vpos
;
9813 output_cursor
.x
= x
;
9814 output_cursor
.y
= y
;
9816 /* If not called as part of an update, really display the cursor.
9817 This will also set the cursor position of W. */
9818 if (updated_window
== NULL
)
9821 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9822 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9823 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9828 #endif /* HAVE_WINDOW_SYSTEM */
9831 /***********************************************************************
9833 ***********************************************************************/
9835 #ifdef HAVE_WINDOW_SYSTEM
9837 /* Where the mouse was last time we reported a mouse event. */
9839 FRAME_PTR last_mouse_frame
;
9841 /* Tool-bar item index of the item on which a mouse button was pressed
9844 int last_tool_bar_item
;
9848 update_tool_bar_unwind (frame
)
9851 selected_frame
= frame
;
9855 /* Update the tool-bar item list for frame F. This has to be done
9856 before we start to fill in any display lines. Called from
9857 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9858 and restore it here. */
9861 update_tool_bar (f
, save_match_data
)
9863 int save_match_data
;
9865 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
9866 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9868 int do_update
= WINDOWP (f
->tool_bar_window
)
9869 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9877 window
= FRAME_SELECTED_WINDOW (f
);
9878 w
= XWINDOW (window
);
9880 /* If the user has switched buffers or windows, we need to
9881 recompute to reflect the new bindings. But we'll
9882 recompute when update_mode_lines is set too; that means
9883 that people can use force-mode-line-update to request
9884 that the menu bar be recomputed. The adverse effect on
9885 the rest of the redisplay algorithm is about the same as
9886 windows_or_buffers_changed anyway. */
9887 if (windows_or_buffers_changed
9888 || !NILP (w
->update_mode_line
)
9889 || update_mode_lines
9890 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9891 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9892 != !NILP (w
->last_had_star
))
9893 || ((!NILP (Vtransient_mark_mode
)
9894 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9895 != !NILP (w
->region_showing
)))
9897 struct buffer
*prev
= current_buffer
;
9898 int count
= SPECPDL_INDEX ();
9899 Lisp_Object frame
, new_tool_bar
;
9901 struct gcpro gcpro1
;
9903 /* Set current_buffer to the buffer of the selected
9904 window of the frame, so that we get the right local
9906 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9908 /* Save match data, if we must. */
9909 if (save_match_data
)
9910 record_unwind_save_match_data ();
9912 /* Make sure that we don't accidentally use bogus keymaps. */
9913 if (NILP (Voverriding_local_map_menu_flag
))
9915 specbind (Qoverriding_terminal_local_map
, Qnil
);
9916 specbind (Qoverriding_local_map
, Qnil
);
9919 GCPRO1 (new_tool_bar
);
9921 /* We must temporarily set the selected frame to this frame
9922 before calling tool_bar_items, because the calculation of
9923 the tool-bar keymap uses the selected frame (see
9924 `tool-bar-make-keymap' in tool-bar.el). */
9925 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
9926 XSETFRAME (frame
, f
);
9927 selected_frame
= frame
;
9929 /* Build desired tool-bar items from keymaps. */
9930 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9933 /* Redisplay the tool-bar if we changed it. */
9934 if (new_n_tool_bar
!= f
->n_tool_bar_items
9935 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9937 /* Redisplay that happens asynchronously due to an expose event
9938 may access f->tool_bar_items. Make sure we update both
9939 variables within BLOCK_INPUT so no such event interrupts. */
9941 f
->tool_bar_items
= new_tool_bar
;
9942 f
->n_tool_bar_items
= new_n_tool_bar
;
9943 w
->update_mode_line
= Qt
;
9949 unbind_to (count
, Qnil
);
9950 set_buffer_internal_1 (prev
);
9956 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9957 F's desired tool-bar contents. F->tool_bar_items must have
9958 been set up previously by calling prepare_menu_bars. */
9961 build_desired_tool_bar_string (f
)
9964 int i
, size
, size_needed
;
9965 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9966 Lisp_Object image
, plist
, props
;
9968 image
= plist
= props
= Qnil
;
9969 GCPRO3 (image
, plist
, props
);
9971 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9972 Otherwise, make a new string. */
9974 /* The size of the string we might be able to reuse. */
9975 size
= (STRINGP (f
->desired_tool_bar_string
)
9976 ? SCHARS (f
->desired_tool_bar_string
)
9979 /* We need one space in the string for each image. */
9980 size_needed
= f
->n_tool_bar_items
;
9982 /* Reuse f->desired_tool_bar_string, if possible. */
9983 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9984 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9988 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9989 Fremove_text_properties (make_number (0), make_number (size
),
9990 props
, f
->desired_tool_bar_string
);
9993 /* Put a `display' property on the string for the images to display,
9994 put a `menu_item' property on tool-bar items with a value that
9995 is the index of the item in F's tool-bar item vector. */
9996 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9998 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10000 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10001 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10002 int hmargin
, vmargin
, relief
, idx
, end
;
10003 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10005 /* If image is a vector, choose the image according to the
10007 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10008 if (VECTORP (image
))
10012 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10013 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10016 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10017 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10019 xassert (ASIZE (image
) >= idx
);
10020 image
= AREF (image
, idx
);
10025 /* Ignore invalid image specifications. */
10026 if (!valid_image_p (image
))
10029 /* Display the tool-bar button pressed, or depressed. */
10030 plist
= Fcopy_sequence (XCDR (image
));
10032 /* Compute margin and relief to draw. */
10033 relief
= (tool_bar_button_relief
>= 0
10034 ? tool_bar_button_relief
10035 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10036 hmargin
= vmargin
= relief
;
10038 if (INTEGERP (Vtool_bar_button_margin
)
10039 && XINT (Vtool_bar_button_margin
) > 0)
10041 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10042 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10044 else if (CONSP (Vtool_bar_button_margin
))
10046 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10047 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10048 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10050 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10051 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10052 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10055 if (auto_raise_tool_bar_buttons_p
)
10057 /* Add a `:relief' property to the image spec if the item is
10061 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10068 /* If image is selected, display it pressed, i.e. with a
10069 negative relief. If it's not selected, display it with a
10071 plist
= Fplist_put (plist
, QCrelief
,
10073 ? make_number (-relief
)
10074 : make_number (relief
)));
10079 /* Put a margin around the image. */
10080 if (hmargin
|| vmargin
)
10082 if (hmargin
== vmargin
)
10083 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10085 plist
= Fplist_put (plist
, QCmargin
,
10086 Fcons (make_number (hmargin
),
10087 make_number (vmargin
)));
10090 /* If button is not enabled, and we don't have special images
10091 for the disabled state, make the image appear disabled by
10092 applying an appropriate algorithm to it. */
10093 if (!enabled_p
&& idx
< 0)
10094 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10096 /* Put a `display' text property on the string for the image to
10097 display. Put a `menu-item' property on the string that gives
10098 the start of this item's properties in the tool-bar items
10100 image
= Fcons (Qimage
, plist
);
10101 props
= list4 (Qdisplay
, image
,
10102 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10104 /* Let the last image hide all remaining spaces in the tool bar
10105 string. The string can be longer than needed when we reuse a
10106 previous string. */
10107 if (i
+ 1 == f
->n_tool_bar_items
)
10108 end
= SCHARS (f
->desired_tool_bar_string
);
10111 Fadd_text_properties (make_number (i
), make_number (end
),
10112 props
, f
->desired_tool_bar_string
);
10120 /* Display one line of the tool-bar of frame IT->f.
10122 HEIGHT specifies the desired height of the tool-bar line.
10123 If the actual height of the glyph row is less than HEIGHT, the
10124 row's height is increased to HEIGHT, and the icons are centered
10125 vertically in the new height.
10127 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10128 count a final empty row in case the tool-bar width exactly matches
10133 display_tool_bar_line (it
, height
)
10137 struct glyph_row
*row
= it
->glyph_row
;
10138 int max_x
= it
->last_visible_x
;
10139 struct glyph
*last
;
10141 prepare_desired_row (row
);
10142 row
->y
= it
->current_y
;
10144 /* Note that this isn't made use of if the face hasn't a box,
10145 so there's no need to check the face here. */
10146 it
->start_of_box_run_p
= 1;
10148 while (it
->current_x
< max_x
)
10150 int x
, n_glyphs_before
, i
, nglyphs
;
10151 struct it it_before
;
10153 /* Get the next display element. */
10154 if (!get_next_display_element (it
))
10156 /* Don't count empty row if we are counting needed tool-bar lines. */
10157 if (height
< 0 && !it
->hpos
)
10162 /* Produce glyphs. */
10163 n_glyphs_before
= row
->used
[TEXT_AREA
];
10166 PRODUCE_GLYPHS (it
);
10168 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10170 x
= it_before
.current_x
;
10171 while (i
< nglyphs
)
10173 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10175 if (x
+ glyph
->pixel_width
> max_x
)
10177 /* Glyph doesn't fit on line. Backtrack. */
10178 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10180 /* If this is the only glyph on this line, it will never fit on the
10181 toolbar, so skip it. But ensure there is at least one glyph,
10182 so we don't accidentally disable the tool-bar. */
10183 if (n_glyphs_before
== 0
10184 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10190 x
+= glyph
->pixel_width
;
10194 /* Stop at line ends. */
10195 if (ITERATOR_AT_END_OF_LINE_P (it
))
10198 set_iterator_to_next (it
, 1);
10203 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10205 /* Use default face for the border below the tool bar.
10207 FIXME: When auto-resize-tool-bars is grow-only, there is
10208 no additional border below the possibly empty tool-bar lines.
10209 So to make the extra empty lines look "normal", we have to
10210 use the tool-bar face for the border too. */
10211 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10212 it
->face_id
= DEFAULT_FACE_ID
;
10214 extend_face_to_end_of_line (it
);
10215 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10216 last
->right_box_line_p
= 1;
10217 if (last
== row
->glyphs
[TEXT_AREA
])
10218 last
->left_box_line_p
= 1;
10220 /* Make line the desired height and center it vertically. */
10221 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10223 /* Don't add more than one line height. */
10224 height
%= FRAME_LINE_HEIGHT (it
->f
);
10225 it
->max_ascent
+= height
/ 2;
10226 it
->max_descent
+= (height
+ 1) / 2;
10229 compute_line_metrics (it
);
10231 /* If line is empty, make it occupy the rest of the tool-bar. */
10232 if (!row
->displays_text_p
)
10234 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10235 row
->visible_height
= row
->height
;
10236 row
->ascent
= row
->phys_ascent
= 0;
10237 row
->extra_line_spacing
= 0;
10240 row
->full_width_p
= 1;
10241 row
->continued_p
= 0;
10242 row
->truncated_on_left_p
= 0;
10243 row
->truncated_on_right_p
= 0;
10245 it
->current_x
= it
->hpos
= 0;
10246 it
->current_y
+= row
->height
;
10252 /* Max tool-bar height. */
10254 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10255 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10257 /* Value is the number of screen lines needed to make all tool-bar
10258 items of frame F visible. The number of actual rows needed is
10259 returned in *N_ROWS if non-NULL. */
10262 tool_bar_lines_needed (f
, n_rows
)
10266 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10268 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10269 the desired matrix, so use (unused) mode-line row as temporary row to
10270 avoid destroying the first tool-bar row. */
10271 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10273 /* Initialize an iterator for iteration over
10274 F->desired_tool_bar_string in the tool-bar window of frame F. */
10275 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10276 it
.first_visible_x
= 0;
10277 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10278 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10280 while (!ITERATOR_AT_END_P (&it
))
10282 clear_glyph_row (temp_row
);
10283 it
.glyph_row
= temp_row
;
10284 display_tool_bar_line (&it
, -1);
10286 clear_glyph_row (temp_row
);
10288 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10290 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10292 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10296 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10298 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10307 frame
= selected_frame
;
10309 CHECK_FRAME (frame
);
10310 f
= XFRAME (frame
);
10312 if (WINDOWP (f
->tool_bar_window
)
10313 || (w
= XWINDOW (f
->tool_bar_window
),
10314 WINDOW_TOTAL_LINES (w
) > 0))
10316 update_tool_bar (f
, 1);
10317 if (f
->n_tool_bar_items
)
10319 build_desired_tool_bar_string (f
);
10320 nlines
= tool_bar_lines_needed (f
, NULL
);
10324 return make_number (nlines
);
10328 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10329 height should be changed. */
10332 redisplay_tool_bar (f
)
10337 struct glyph_row
*row
;
10339 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
10340 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10341 update_frame_tool_bar (f
);
10345 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10346 do anything. This means you must start with tool-bar-lines
10347 non-zero to get the auto-sizing effect. Or in other words, you
10348 can turn off tool-bars by specifying tool-bar-lines zero. */
10349 if (!WINDOWP (f
->tool_bar_window
)
10350 || (w
= XWINDOW (f
->tool_bar_window
),
10351 WINDOW_TOTAL_LINES (w
) == 0))
10354 /* Set up an iterator for the tool-bar window. */
10355 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10356 it
.first_visible_x
= 0;
10357 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10358 row
= it
.glyph_row
;
10360 /* Build a string that represents the contents of the tool-bar. */
10361 build_desired_tool_bar_string (f
);
10362 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10364 if (f
->n_tool_bar_rows
== 0)
10368 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10369 nlines
!= WINDOW_TOTAL_LINES (w
)))
10371 extern Lisp_Object Qtool_bar_lines
;
10373 int old_height
= WINDOW_TOTAL_LINES (w
);
10375 XSETFRAME (frame
, f
);
10376 Fmodify_frame_parameters (frame
,
10377 Fcons (Fcons (Qtool_bar_lines
,
10378 make_number (nlines
)),
10380 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10382 clear_glyph_matrix (w
->desired_matrix
);
10383 fonts_changed_p
= 1;
10389 /* Display as many lines as needed to display all tool-bar items. */
10391 if (f
->n_tool_bar_rows
> 0)
10393 int border
, rows
, height
, extra
;
10395 if (INTEGERP (Vtool_bar_border
))
10396 border
= XINT (Vtool_bar_border
);
10397 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10398 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10399 else if (EQ (Vtool_bar_border
, Qborder_width
))
10400 border
= f
->border_width
;
10406 rows
= f
->n_tool_bar_rows
;
10407 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10408 extra
= it
.last_visible_y
- border
- height
* rows
;
10410 while (it
.current_y
< it
.last_visible_y
)
10413 if (extra
> 0 && rows
-- > 0)
10415 h
= (extra
+ rows
- 1) / rows
;
10418 display_tool_bar_line (&it
, height
+ h
);
10423 while (it
.current_y
< it
.last_visible_y
)
10424 display_tool_bar_line (&it
, 0);
10427 /* It doesn't make much sense to try scrolling in the tool-bar
10428 window, so don't do it. */
10429 w
->desired_matrix
->no_scrolling_p
= 1;
10430 w
->must_be_updated_p
= 1;
10432 if (!NILP (Vauto_resize_tool_bars
))
10434 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10435 int change_height_p
= 0;
10437 /* If we couldn't display everything, change the tool-bar's
10438 height if there is room for more. */
10439 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10440 && it
.current_y
< max_tool_bar_height
)
10441 change_height_p
= 1;
10443 row
= it
.glyph_row
- 1;
10445 /* If there are blank lines at the end, except for a partially
10446 visible blank line at the end that is smaller than
10447 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10448 if (!row
->displays_text_p
10449 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10450 change_height_p
= 1;
10452 /* If row displays tool-bar items, but is partially visible,
10453 change the tool-bar's height. */
10454 if (row
->displays_text_p
10455 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10456 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10457 change_height_p
= 1;
10459 /* Resize windows as needed by changing the `tool-bar-lines'
10460 frame parameter. */
10461 if (change_height_p
)
10463 extern Lisp_Object Qtool_bar_lines
;
10465 int old_height
= WINDOW_TOTAL_LINES (w
);
10467 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10469 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10470 && !f
->minimize_tool_bar_window_p
)
10471 ? (nlines
> old_height
)
10472 : (nlines
!= old_height
));
10473 f
->minimize_tool_bar_window_p
= 0;
10475 if (change_height_p
)
10477 XSETFRAME (frame
, f
);
10478 Fmodify_frame_parameters (frame
,
10479 Fcons (Fcons (Qtool_bar_lines
,
10480 make_number (nlines
)),
10482 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10484 clear_glyph_matrix (w
->desired_matrix
);
10485 f
->n_tool_bar_rows
= nrows
;
10486 fonts_changed_p
= 1;
10493 f
->minimize_tool_bar_window_p
= 0;
10498 /* Get information about the tool-bar item which is displayed in GLYPH
10499 on frame F. Return in *PROP_IDX the index where tool-bar item
10500 properties start in F->tool_bar_items. Value is zero if
10501 GLYPH doesn't display a tool-bar item. */
10504 tool_bar_item_info (f
, glyph
, prop_idx
)
10506 struct glyph
*glyph
;
10513 /* This function can be called asynchronously, which means we must
10514 exclude any possibility that Fget_text_property signals an
10516 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10517 charpos
= max (0, charpos
);
10519 /* Get the text property `menu-item' at pos. The value of that
10520 property is the start index of this item's properties in
10521 F->tool_bar_items. */
10522 prop
= Fget_text_property (make_number (charpos
),
10523 Qmenu_item
, f
->current_tool_bar_string
);
10524 if (INTEGERP (prop
))
10526 *prop_idx
= XINT (prop
);
10536 /* Get information about the tool-bar item at position X/Y on frame F.
10537 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10538 the current matrix of the tool-bar window of F, or NULL if not
10539 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10540 item in F->tool_bar_items. Value is
10542 -1 if X/Y is not on a tool-bar item
10543 0 if X/Y is on the same item that was highlighted before.
10547 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10550 struct glyph
**glyph
;
10551 int *hpos
, *vpos
, *prop_idx
;
10553 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10554 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10557 /* Find the glyph under X/Y. */
10558 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10559 if (*glyph
== NULL
)
10562 /* Get the start of this tool-bar item's properties in
10563 f->tool_bar_items. */
10564 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10567 /* Is mouse on the highlighted item? */
10568 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10569 && *vpos
>= dpyinfo
->mouse_face_beg_row
10570 && *vpos
<= dpyinfo
->mouse_face_end_row
10571 && (*vpos
> dpyinfo
->mouse_face_beg_row
10572 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10573 && (*vpos
< dpyinfo
->mouse_face_end_row
10574 || *hpos
< dpyinfo
->mouse_face_end_col
10575 || dpyinfo
->mouse_face_past_end
))
10583 Handle mouse button event on the tool-bar of frame F, at
10584 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10585 0 for button release. MODIFIERS is event modifiers for button
10589 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10592 unsigned int modifiers
;
10594 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10595 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10596 int hpos
, vpos
, prop_idx
;
10597 struct glyph
*glyph
;
10598 Lisp_Object enabled_p
;
10600 /* If not on the highlighted tool-bar item, return. */
10601 frame_to_window_pixel_xy (w
, &x
, &y
);
10602 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10605 /* If item is disabled, do nothing. */
10606 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10607 if (NILP (enabled_p
))
10612 /* Show item in pressed state. */
10613 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10614 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10615 last_tool_bar_item
= prop_idx
;
10619 Lisp_Object key
, frame
;
10620 struct input_event event
;
10621 EVENT_INIT (event
);
10623 /* Show item in released state. */
10624 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10625 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10627 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10629 XSETFRAME (frame
, f
);
10630 event
.kind
= TOOL_BAR_EVENT
;
10631 event
.frame_or_window
= frame
;
10633 kbd_buffer_store_event (&event
);
10635 event
.kind
= TOOL_BAR_EVENT
;
10636 event
.frame_or_window
= frame
;
10638 event
.modifiers
= modifiers
;
10639 kbd_buffer_store_event (&event
);
10640 last_tool_bar_item
= -1;
10645 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10646 tool-bar window-relative coordinates X/Y. Called from
10647 note_mouse_highlight. */
10650 note_tool_bar_highlight (f
, x
, y
)
10654 Lisp_Object window
= f
->tool_bar_window
;
10655 struct window
*w
= XWINDOW (window
);
10656 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10658 struct glyph
*glyph
;
10659 struct glyph_row
*row
;
10661 Lisp_Object enabled_p
;
10663 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10664 int mouse_down_p
, rc
;
10666 /* Function note_mouse_highlight is called with negative x(y
10667 values when mouse moves outside of the frame. */
10668 if (x
<= 0 || y
<= 0)
10670 clear_mouse_face (dpyinfo
);
10674 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10677 /* Not on tool-bar item. */
10678 clear_mouse_face (dpyinfo
);
10682 /* On same tool-bar item as before. */
10683 goto set_help_echo
;
10685 clear_mouse_face (dpyinfo
);
10687 /* Mouse is down, but on different tool-bar item? */
10688 mouse_down_p
= (dpyinfo
->grabbed
10689 && f
== last_mouse_frame
10690 && FRAME_LIVE_P (f
));
10692 && last_tool_bar_item
!= prop_idx
)
10695 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10696 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10698 /* If tool-bar item is not enabled, don't highlight it. */
10699 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10700 if (!NILP (enabled_p
))
10702 /* Compute the x-position of the glyph. In front and past the
10703 image is a space. We include this in the highlighted area. */
10704 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10705 for (i
= x
= 0; i
< hpos
; ++i
)
10706 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10708 /* Record this as the current active region. */
10709 dpyinfo
->mouse_face_beg_col
= hpos
;
10710 dpyinfo
->mouse_face_beg_row
= vpos
;
10711 dpyinfo
->mouse_face_beg_x
= x
;
10712 dpyinfo
->mouse_face_beg_y
= row
->y
;
10713 dpyinfo
->mouse_face_past_end
= 0;
10715 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10716 dpyinfo
->mouse_face_end_row
= vpos
;
10717 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10718 dpyinfo
->mouse_face_end_y
= row
->y
;
10719 dpyinfo
->mouse_face_window
= window
;
10720 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10722 /* Display it as active. */
10723 show_mouse_face (dpyinfo
, draw
);
10724 dpyinfo
->mouse_face_image_state
= draw
;
10729 /* Set help_echo_string to a help string to display for this tool-bar item.
10730 XTread_socket does the rest. */
10731 help_echo_object
= help_echo_window
= Qnil
;
10732 help_echo_pos
= -1;
10733 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10734 if (NILP (help_echo_string
))
10735 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10738 #endif /* HAVE_WINDOW_SYSTEM */
10742 /************************************************************************
10743 Horizontal scrolling
10744 ************************************************************************/
10746 static int hscroll_window_tree
P_ ((Lisp_Object
));
10747 static int hscroll_windows
P_ ((Lisp_Object
));
10749 /* For all leaf windows in the window tree rooted at WINDOW, set their
10750 hscroll value so that PT is (i) visible in the window, and (ii) so
10751 that it is not within a certain margin at the window's left and
10752 right border. Value is non-zero if any window's hscroll has been
10756 hscroll_window_tree (window
)
10757 Lisp_Object window
;
10759 int hscrolled_p
= 0;
10760 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10761 int hscroll_step_abs
= 0;
10762 double hscroll_step_rel
= 0;
10764 if (hscroll_relative_p
)
10766 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10767 if (hscroll_step_rel
< 0)
10769 hscroll_relative_p
= 0;
10770 hscroll_step_abs
= 0;
10773 else if (INTEGERP (Vhscroll_step
))
10775 hscroll_step_abs
= XINT (Vhscroll_step
);
10776 if (hscroll_step_abs
< 0)
10777 hscroll_step_abs
= 0;
10780 hscroll_step_abs
= 0;
10782 while (WINDOWP (window
))
10784 struct window
*w
= XWINDOW (window
);
10786 if (WINDOWP (w
->hchild
))
10787 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10788 else if (WINDOWP (w
->vchild
))
10789 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10790 else if (w
->cursor
.vpos
>= 0)
10793 int text_area_width
;
10794 struct glyph_row
*current_cursor_row
10795 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10796 struct glyph_row
*desired_cursor_row
10797 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10798 struct glyph_row
*cursor_row
10799 = (desired_cursor_row
->enabled_p
10800 ? desired_cursor_row
10801 : current_cursor_row
);
10803 text_area_width
= window_box_width (w
, TEXT_AREA
);
10805 /* Scroll when cursor is inside this scroll margin. */
10806 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10808 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10809 && ((XFASTINT (w
->hscroll
)
10810 && w
->cursor
.x
<= h_margin
)
10811 || (cursor_row
->enabled_p
10812 && cursor_row
->truncated_on_right_p
10813 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10817 struct buffer
*saved_current_buffer
;
10821 /* Find point in a display of infinite width. */
10822 saved_current_buffer
= current_buffer
;
10823 current_buffer
= XBUFFER (w
->buffer
);
10825 if (w
== XWINDOW (selected_window
))
10826 pt
= BUF_PT (current_buffer
);
10829 pt
= marker_position (w
->pointm
);
10830 pt
= max (BEGV
, pt
);
10834 /* Move iterator to pt starting at cursor_row->start in
10835 a line with infinite width. */
10836 init_to_row_start (&it
, w
, cursor_row
);
10837 it
.last_visible_x
= INFINITY
;
10838 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10839 current_buffer
= saved_current_buffer
;
10841 /* Position cursor in window. */
10842 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10843 hscroll
= max (0, (it
.current_x
10844 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10845 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10846 : (text_area_width
/ 2))))
10847 / FRAME_COLUMN_WIDTH (it
.f
);
10848 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10850 if (hscroll_relative_p
)
10851 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10854 wanted_x
= text_area_width
10855 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10858 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10862 if (hscroll_relative_p
)
10863 wanted_x
= text_area_width
* hscroll_step_rel
10866 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10869 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10871 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10873 /* Don't call Fset_window_hscroll if value hasn't
10874 changed because it will prevent redisplay
10876 if (XFASTINT (w
->hscroll
) != hscroll
)
10878 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10879 w
->hscroll
= make_number (hscroll
);
10888 /* Value is non-zero if hscroll of any leaf window has been changed. */
10889 return hscrolled_p
;
10893 /* Set hscroll so that cursor is visible and not inside horizontal
10894 scroll margins for all windows in the tree rooted at WINDOW. See
10895 also hscroll_window_tree above. Value is non-zero if any window's
10896 hscroll has been changed. If it has, desired matrices on the frame
10897 of WINDOW are cleared. */
10900 hscroll_windows (window
)
10901 Lisp_Object window
;
10903 int hscrolled_p
= hscroll_window_tree (window
);
10905 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10906 return hscrolled_p
;
10911 /************************************************************************
10913 ************************************************************************/
10915 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10916 to a non-zero value. This is sometimes handy to have in a debugger
10921 /* First and last unchanged row for try_window_id. */
10923 int debug_first_unchanged_at_end_vpos
;
10924 int debug_last_unchanged_at_beg_vpos
;
10926 /* Delta vpos and y. */
10928 int debug_dvpos
, debug_dy
;
10930 /* Delta in characters and bytes for try_window_id. */
10932 int debug_delta
, debug_delta_bytes
;
10934 /* Values of window_end_pos and window_end_vpos at the end of
10937 EMACS_INT debug_end_pos
, debug_end_vpos
;
10939 /* Append a string to W->desired_matrix->method. FMT is a printf
10940 format string. A1...A9 are a supplement for a variable-length
10941 argument list. If trace_redisplay_p is non-zero also printf the
10942 resulting string to stderr. */
10945 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10948 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10951 char *method
= w
->desired_matrix
->method
;
10952 int len
= strlen (method
);
10953 int size
= sizeof w
->desired_matrix
->method
;
10954 int remaining
= size
- len
- 1;
10956 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10957 if (len
&& remaining
)
10960 --remaining
, ++len
;
10963 strncpy (method
+ len
, buffer
, remaining
);
10965 if (trace_redisplay_p
)
10966 fprintf (stderr
, "%p (%s): %s\n",
10968 ((BUFFERP (w
->buffer
)
10969 && STRINGP (XBUFFER (w
->buffer
)->name
))
10970 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10975 #endif /* GLYPH_DEBUG */
10978 /* Value is non-zero if all changes in window W, which displays
10979 current_buffer, are in the text between START and END. START is a
10980 buffer position, END is given as a distance from Z. Used in
10981 redisplay_internal for display optimization. */
10984 text_outside_line_unchanged_p (w
, start
, end
)
10988 int unchanged_p
= 1;
10990 /* If text or overlays have changed, see where. */
10991 if (XFASTINT (w
->last_modified
) < MODIFF
10992 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10994 /* Gap in the line? */
10995 if (GPT
< start
|| Z
- GPT
< end
)
10998 /* Changes start in front of the line, or end after it? */
11000 && (BEG_UNCHANGED
< start
- 1
11001 || END_UNCHANGED
< end
))
11004 /* If selective display, can't optimize if changes start at the
11005 beginning of the line. */
11007 && INTEGERP (current_buffer
->selective_display
)
11008 && XINT (current_buffer
->selective_display
) > 0
11009 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11012 /* If there are overlays at the start or end of the line, these
11013 may have overlay strings with newlines in them. A change at
11014 START, for instance, may actually concern the display of such
11015 overlay strings as well, and they are displayed on different
11016 lines. So, quickly rule out this case. (For the future, it
11017 might be desirable to implement something more telling than
11018 just BEG/END_UNCHANGED.) */
11021 if (BEG
+ BEG_UNCHANGED
== start
11022 && overlay_touches_p (start
))
11024 if (END_UNCHANGED
== end
11025 && overlay_touches_p (Z
- end
))
11030 return unchanged_p
;
11034 /* Do a frame update, taking possible shortcuts into account. This is
11035 the main external entry point for redisplay.
11037 If the last redisplay displayed an echo area message and that message
11038 is no longer requested, we clear the echo area or bring back the
11039 mini-buffer if that is in use. */
11044 redisplay_internal (0);
11049 overlay_arrow_string_or_property (var
)
11054 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11057 return Voverlay_arrow_string
;
11060 /* Return 1 if there are any overlay-arrows in current_buffer. */
11062 overlay_arrow_in_current_buffer_p ()
11066 for (vlist
= Voverlay_arrow_variable_list
;
11068 vlist
= XCDR (vlist
))
11070 Lisp_Object var
= XCAR (vlist
);
11073 if (!SYMBOLP (var
))
11075 val
= find_symbol_value (var
);
11077 && current_buffer
== XMARKER (val
)->buffer
)
11084 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11088 overlay_arrows_changed_p ()
11092 for (vlist
= Voverlay_arrow_variable_list
;
11094 vlist
= XCDR (vlist
))
11096 Lisp_Object var
= XCAR (vlist
);
11097 Lisp_Object val
, pstr
;
11099 if (!SYMBOLP (var
))
11101 val
= find_symbol_value (var
);
11102 if (!MARKERP (val
))
11104 if (! EQ (COERCE_MARKER (val
),
11105 Fget (var
, Qlast_arrow_position
))
11106 || ! (pstr
= overlay_arrow_string_or_property (var
),
11107 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11113 /* Mark overlay arrows to be updated on next redisplay. */
11116 update_overlay_arrows (up_to_date
)
11121 for (vlist
= Voverlay_arrow_variable_list
;
11123 vlist
= XCDR (vlist
))
11125 Lisp_Object var
= XCAR (vlist
);
11127 if (!SYMBOLP (var
))
11130 if (up_to_date
> 0)
11132 Lisp_Object val
= find_symbol_value (var
);
11133 Fput (var
, Qlast_arrow_position
,
11134 COERCE_MARKER (val
));
11135 Fput (var
, Qlast_arrow_string
,
11136 overlay_arrow_string_or_property (var
));
11138 else if (up_to_date
< 0
11139 || !NILP (Fget (var
, Qlast_arrow_position
)))
11141 Fput (var
, Qlast_arrow_position
, Qt
);
11142 Fput (var
, Qlast_arrow_string
, Qt
);
11148 /* Return overlay arrow string to display at row.
11149 Return integer (bitmap number) for arrow bitmap in left fringe.
11150 Return nil if no overlay arrow. */
11153 overlay_arrow_at_row (it
, row
)
11155 struct glyph_row
*row
;
11159 for (vlist
= Voverlay_arrow_variable_list
;
11161 vlist
= XCDR (vlist
))
11163 Lisp_Object var
= XCAR (vlist
);
11166 if (!SYMBOLP (var
))
11169 val
= find_symbol_value (var
);
11172 && current_buffer
== XMARKER (val
)->buffer
11173 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11175 if (FRAME_WINDOW_P (it
->f
)
11176 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11178 #ifdef HAVE_WINDOW_SYSTEM
11179 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11182 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11183 return make_number (fringe_bitmap
);
11186 return make_number (-1); /* Use default arrow bitmap */
11188 return overlay_arrow_string_or_property (var
);
11195 /* Return 1 if point moved out of or into a composition. Otherwise
11196 return 0. PREV_BUF and PREV_PT are the last point buffer and
11197 position. BUF and PT are the current point buffer and position. */
11200 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11201 struct buffer
*prev_buf
, *buf
;
11204 EMACS_INT start
, end
;
11206 Lisp_Object buffer
;
11208 XSETBUFFER (buffer
, buf
);
11209 /* Check a composition at the last point if point moved within the
11211 if (prev_buf
== buf
)
11214 /* Point didn't move. */
11217 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11218 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11219 && COMPOSITION_VALID_P (start
, end
, prop
)
11220 && start
< prev_pt
&& end
> prev_pt
)
11221 /* The last point was within the composition. Return 1 iff
11222 point moved out of the composition. */
11223 return (pt
<= start
|| pt
>= end
);
11226 /* Check a composition at the current point. */
11227 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11228 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11229 && COMPOSITION_VALID_P (start
, end
, prop
)
11230 && start
< pt
&& end
> pt
);
11234 /* Reconsider the setting of B->clip_changed which is displayed
11238 reconsider_clip_changes (w
, b
)
11242 if (b
->clip_changed
11243 && !NILP (w
->window_end_valid
)
11244 && w
->current_matrix
->buffer
== b
11245 && w
->current_matrix
->zv
== BUF_ZV (b
)
11246 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11247 b
->clip_changed
= 0;
11249 /* If display wasn't paused, and W is not a tool bar window, see if
11250 point has been moved into or out of a composition. In that case,
11251 we set b->clip_changed to 1 to force updating the screen. If
11252 b->clip_changed has already been set to 1, we can skip this
11254 if (!b
->clip_changed
11255 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11259 if (w
== XWINDOW (selected_window
))
11260 pt
= BUF_PT (current_buffer
);
11262 pt
= marker_position (w
->pointm
);
11264 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11265 || pt
!= XINT (w
->last_point
))
11266 && check_point_in_composition (w
->current_matrix
->buffer
,
11267 XINT (w
->last_point
),
11268 XBUFFER (w
->buffer
), pt
))
11269 b
->clip_changed
= 1;
11274 /* Select FRAME to forward the values of frame-local variables into C
11275 variables so that the redisplay routines can access those values
11279 select_frame_for_redisplay (frame
)
11282 Lisp_Object tail
, symbol
, val
;
11283 Lisp_Object old
= selected_frame
;
11284 struct Lisp_Symbol
*sym
;
11286 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11288 selected_frame
= frame
;
11292 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11293 if (CONSP (XCAR (tail
))
11294 && (symbol
= XCAR (XCAR (tail
)),
11296 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11298 (BUFFER_LOCAL_VALUEP (val
)))
11299 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11300 /* Use find_symbol_value rather than Fsymbol_value
11301 to avoid an error if it is void. */
11302 find_symbol_value (symbol
);
11303 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11307 #define STOP_POLLING \
11308 do { if (! polling_stopped_here) stop_polling (); \
11309 polling_stopped_here = 1; } while (0)
11311 #define RESUME_POLLING \
11312 do { if (polling_stopped_here) start_polling (); \
11313 polling_stopped_here = 0; } while (0)
11316 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11317 response to any user action; therefore, we should preserve the echo
11318 area. (Actually, our caller does that job.) Perhaps in the future
11319 avoid recentering windows if it is not necessary; currently that
11320 causes some problems. */
11323 redisplay_internal (preserve_echo_area
)
11324 int preserve_echo_area
;
11326 struct window
*w
= XWINDOW (selected_window
);
11329 int must_finish
= 0;
11330 struct text_pos tlbufpos
, tlendpos
;
11331 int number_of_visible_frames
;
11334 int polling_stopped_here
= 0;
11335 Lisp_Object old_frame
= selected_frame
;
11337 /* Non-zero means redisplay has to consider all windows on all
11338 frames. Zero means, only selected_window is considered. */
11339 int consider_all_windows_p
;
11341 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11343 /* No redisplay if running in batch mode or frame is not yet fully
11344 initialized, or redisplay is explicitly turned off by setting
11345 Vinhibit_redisplay. */
11346 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11347 || !NILP (Vinhibit_redisplay
))
11350 /* Don't examine these until after testing Vinhibit_redisplay.
11351 When Emacs is shutting down, perhaps because its connection to
11352 X has dropped, we should not look at them at all. */
11353 f
= XFRAME (w
->frame
);
11354 sf
= SELECTED_FRAME ();
11356 if (!f
->glyphs_initialized_p
)
11359 /* The flag redisplay_performed_directly_p is set by
11360 direct_output_for_insert when it already did the whole screen
11361 update necessary. */
11362 if (redisplay_performed_directly_p
)
11364 redisplay_performed_directly_p
= 0;
11365 if (!hscroll_windows (selected_window
))
11369 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11370 if (popup_activated ())
11374 /* I don't think this happens but let's be paranoid. */
11375 if (redisplaying_p
)
11378 /* Record a function that resets redisplaying_p to its old value
11379 when we leave this function. */
11380 count
= SPECPDL_INDEX ();
11381 record_unwind_protect (unwind_redisplay
,
11382 Fcons (make_number (redisplaying_p
), selected_frame
));
11384 specbind (Qinhibit_free_realized_faces
, Qnil
);
11387 Lisp_Object tail
, frame
;
11389 FOR_EACH_FRAME (tail
, frame
)
11391 struct frame
*f
= XFRAME (frame
);
11392 f
->already_hscrolled_p
= 0;
11397 if (!EQ (old_frame
, selected_frame
)
11398 && FRAME_LIVE_P (XFRAME (old_frame
)))
11399 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11400 selected_frame and selected_window to be temporarily out-of-sync so
11401 when we come back here via `goto retry', we need to resync because we
11402 may need to run Elisp code (via prepare_menu_bars). */
11403 select_frame_for_redisplay (old_frame
);
11406 reconsider_clip_changes (w
, current_buffer
);
11407 last_escape_glyph_frame
= NULL
;
11408 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11410 /* If new fonts have been loaded that make a glyph matrix adjustment
11411 necessary, do it. */
11412 if (fonts_changed_p
)
11414 adjust_glyphs (NULL
);
11415 ++windows_or_buffers_changed
;
11416 fonts_changed_p
= 0;
11419 /* If face_change_count is non-zero, init_iterator will free all
11420 realized faces, which includes the faces referenced from current
11421 matrices. So, we can't reuse current matrices in this case. */
11422 if (face_change_count
)
11423 ++windows_or_buffers_changed
;
11425 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11426 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11428 /* Since frames on a single ASCII terminal share the same
11429 display area, displaying a different frame means redisplay
11430 the whole thing. */
11431 windows_or_buffers_changed
++;
11432 SET_FRAME_GARBAGED (sf
);
11434 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11436 FRAME_TTY (sf
)->previous_frame
= sf
;
11439 /* Set the visible flags for all frames. Do this before checking
11440 for resized or garbaged frames; they want to know if their frames
11441 are visible. See the comment in frame.h for
11442 FRAME_SAMPLE_VISIBILITY. */
11444 Lisp_Object tail
, frame
;
11446 number_of_visible_frames
= 0;
11448 FOR_EACH_FRAME (tail
, frame
)
11450 struct frame
*f
= XFRAME (frame
);
11452 FRAME_SAMPLE_VISIBILITY (f
);
11453 if (FRAME_VISIBLE_P (f
))
11454 ++number_of_visible_frames
;
11455 clear_desired_matrices (f
);
11460 /* Notice any pending interrupt request to change frame size. */
11461 do_pending_window_change (1);
11463 /* Clear frames marked as garbaged. */
11464 if (frame_garbaged
)
11465 clear_garbaged_frames ();
11467 /* Build menubar and tool-bar items. */
11468 if (NILP (Vmemory_full
))
11469 prepare_menu_bars ();
11471 if (windows_or_buffers_changed
)
11472 update_mode_lines
++;
11474 /* Detect case that we need to write or remove a star in the mode line. */
11475 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11477 w
->update_mode_line
= Qt
;
11478 if (buffer_shared
> 1)
11479 update_mode_lines
++;
11482 /* Avoid invocation of point motion hooks by `current_column' below. */
11483 count1
= SPECPDL_INDEX ();
11484 specbind (Qinhibit_point_motion_hooks
, Qt
);
11486 /* If %c is in the mode line, update it if needed. */
11487 if (!NILP (w
->column_number_displayed
)
11488 /* This alternative quickly identifies a common case
11489 where no change is needed. */
11490 && !(PT
== XFASTINT (w
->last_point
)
11491 && XFASTINT (w
->last_modified
) >= MODIFF
11492 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11493 && (XFASTINT (w
->column_number_displayed
)
11494 != (int) current_column ())) /* iftc */
11495 w
->update_mode_line
= Qt
;
11497 unbind_to (count1
, Qnil
);
11499 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11501 /* The variable buffer_shared is set in redisplay_window and
11502 indicates that we redisplay a buffer in different windows. See
11504 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11505 || cursor_type_changed
);
11507 /* If specs for an arrow have changed, do thorough redisplay
11508 to ensure we remove any arrow that should no longer exist. */
11509 if (overlay_arrows_changed_p ())
11510 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11512 /* Normally the message* functions will have already displayed and
11513 updated the echo area, but the frame may have been trashed, or
11514 the update may have been preempted, so display the echo area
11515 again here. Checking message_cleared_p captures the case that
11516 the echo area should be cleared. */
11517 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11518 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11519 || (message_cleared_p
11520 && minibuf_level
== 0
11521 /* If the mini-window is currently selected, this means the
11522 echo-area doesn't show through. */
11523 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11525 int window_height_changed_p
= echo_area_display (0);
11528 /* If we don't display the current message, don't clear the
11529 message_cleared_p flag, because, if we did, we wouldn't clear
11530 the echo area in the next redisplay which doesn't preserve
11532 if (!display_last_displayed_message_p
)
11533 message_cleared_p
= 0;
11535 if (fonts_changed_p
)
11537 else if (window_height_changed_p
)
11539 consider_all_windows_p
= 1;
11540 ++update_mode_lines
;
11541 ++windows_or_buffers_changed
;
11543 /* If window configuration was changed, frames may have been
11544 marked garbaged. Clear them or we will experience
11545 surprises wrt scrolling. */
11546 if (frame_garbaged
)
11547 clear_garbaged_frames ();
11550 else if (EQ (selected_window
, minibuf_window
)
11551 && (current_buffer
->clip_changed
11552 || XFASTINT (w
->last_modified
) < MODIFF
11553 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11554 && resize_mini_window (w
, 0))
11556 /* Resized active mini-window to fit the size of what it is
11557 showing if its contents might have changed. */
11559 /* FIXME: this causes all frames to be updated, which seems unnecessary
11560 since only the current frame needs to be considered. This function needs
11561 to be rewritten with two variables, consider_all_windows and
11562 consider_all_frames. */
11563 consider_all_windows_p
= 1;
11564 ++windows_or_buffers_changed
;
11565 ++update_mode_lines
;
11567 /* If window configuration was changed, frames may have been
11568 marked garbaged. Clear them or we will experience
11569 surprises wrt scrolling. */
11570 if (frame_garbaged
)
11571 clear_garbaged_frames ();
11575 /* If showing the region, and mark has changed, we must redisplay
11576 the whole window. The assignment to this_line_start_pos prevents
11577 the optimization directly below this if-statement. */
11578 if (((!NILP (Vtransient_mark_mode
)
11579 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11580 != !NILP (w
->region_showing
))
11581 || (!NILP (w
->region_showing
)
11582 && !EQ (w
->region_showing
,
11583 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11584 CHARPOS (this_line_start_pos
) = 0;
11586 /* Optimize the case that only the line containing the cursor in the
11587 selected window has changed. Variables starting with this_ are
11588 set in display_line and record information about the line
11589 containing the cursor. */
11590 tlbufpos
= this_line_start_pos
;
11591 tlendpos
= this_line_end_pos
;
11592 if (!consider_all_windows_p
11593 && CHARPOS (tlbufpos
) > 0
11594 && NILP (w
->update_mode_line
)
11595 && !current_buffer
->clip_changed
11596 && !current_buffer
->prevent_redisplay_optimizations_p
11597 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11598 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11599 /* Make sure recorded data applies to current buffer, etc. */
11600 && this_line_buffer
== current_buffer
11601 && current_buffer
== XBUFFER (w
->buffer
)
11602 && NILP (w
->force_start
)
11603 && NILP (w
->optional_new_start
)
11604 /* Point must be on the line that we have info recorded about. */
11605 && PT
>= CHARPOS (tlbufpos
)
11606 && PT
<= Z
- CHARPOS (tlendpos
)
11607 /* All text outside that line, including its final newline,
11608 must be unchanged */
11609 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11610 CHARPOS (tlendpos
)))
11612 if (CHARPOS (tlbufpos
) > BEGV
11613 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11614 && (CHARPOS (tlbufpos
) == ZV
11615 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11616 /* Former continuation line has disappeared by becoming empty */
11618 else if (XFASTINT (w
->last_modified
) < MODIFF
11619 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11620 || MINI_WINDOW_P (w
))
11622 /* We have to handle the case of continuation around a
11623 wide-column character (See the comment in indent.c around
11626 For instance, in the following case:
11628 -------- Insert --------
11629 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11630 J_I_ ==> J_I_ `^^' are cursors.
11634 As we have to redraw the line above, we should goto cancel. */
11637 int line_height_before
= this_line_pixel_height
;
11639 /* Note that start_display will handle the case that the
11640 line starting at tlbufpos is a continuation lines. */
11641 start_display (&it
, w
, tlbufpos
);
11643 /* Implementation note: It this still necessary? */
11644 if (it
.current_x
!= this_line_start_x
)
11647 TRACE ((stderr
, "trying display optimization 1\n"));
11648 w
->cursor
.vpos
= -1;
11649 overlay_arrow_seen
= 0;
11650 it
.vpos
= this_line_vpos
;
11651 it
.current_y
= this_line_y
;
11652 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11653 display_line (&it
);
11655 /* If line contains point, is not continued,
11656 and ends at same distance from eob as before, we win */
11657 if (w
->cursor
.vpos
>= 0
11658 /* Line is not continued, otherwise this_line_start_pos
11659 would have been set to 0 in display_line. */
11660 && CHARPOS (this_line_start_pos
)
11661 /* Line ends as before. */
11662 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11663 /* Line has same height as before. Otherwise other lines
11664 would have to be shifted up or down. */
11665 && this_line_pixel_height
== line_height_before
)
11667 /* If this is not the window's last line, we must adjust
11668 the charstarts of the lines below. */
11669 if (it
.current_y
< it
.last_visible_y
)
11671 struct glyph_row
*row
11672 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11673 int delta
, delta_bytes
;
11675 if (Z
- CHARPOS (tlendpos
) == ZV
)
11677 /* This line ends at end of (accessible part of)
11678 buffer. There is no newline to count. */
11680 - CHARPOS (tlendpos
)
11681 - MATRIX_ROW_START_CHARPOS (row
));
11682 delta_bytes
= (Z_BYTE
11683 - BYTEPOS (tlendpos
)
11684 - MATRIX_ROW_START_BYTEPOS (row
));
11688 /* This line ends in a newline. Must take
11689 account of the newline and the rest of the
11690 text that follows. */
11692 - CHARPOS (tlendpos
)
11693 - MATRIX_ROW_START_CHARPOS (row
));
11694 delta_bytes
= (Z_BYTE
11695 - BYTEPOS (tlendpos
)
11696 - MATRIX_ROW_START_BYTEPOS (row
));
11699 increment_matrix_positions (w
->current_matrix
,
11700 this_line_vpos
+ 1,
11701 w
->current_matrix
->nrows
,
11702 delta
, delta_bytes
);
11705 /* If this row displays text now but previously didn't,
11706 or vice versa, w->window_end_vpos may have to be
11708 if ((it
.glyph_row
- 1)->displays_text_p
)
11710 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11711 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11713 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11714 && this_line_vpos
> 0)
11715 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11716 w
->window_end_valid
= Qnil
;
11718 /* Update hint: No need to try to scroll in update_window. */
11719 w
->desired_matrix
->no_scrolling_p
= 1;
11722 *w
->desired_matrix
->method
= 0;
11723 debug_method_add (w
, "optimization 1");
11725 #ifdef HAVE_WINDOW_SYSTEM
11726 update_window_fringes (w
, 0);
11733 else if (/* Cursor position hasn't changed. */
11734 PT
== XFASTINT (w
->last_point
)
11735 /* Make sure the cursor was last displayed
11736 in this window. Otherwise we have to reposition it. */
11737 && 0 <= w
->cursor
.vpos
11738 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11742 do_pending_window_change (1);
11744 /* We used to always goto end_of_redisplay here, but this
11745 isn't enough if we have a blinking cursor. */
11746 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11747 goto end_of_redisplay
;
11751 /* If highlighting the region, or if the cursor is in the echo area,
11752 then we can't just move the cursor. */
11753 else if (! (!NILP (Vtransient_mark_mode
)
11754 && !NILP (current_buffer
->mark_active
))
11755 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11756 || highlight_nonselected_windows
)
11757 && NILP (w
->region_showing
)
11758 && NILP (Vshow_trailing_whitespace
)
11759 && !cursor_in_echo_area
)
11762 struct glyph_row
*row
;
11764 /* Skip from tlbufpos to PT and see where it is. Note that
11765 PT may be in invisible text. If so, we will end at the
11766 next visible position. */
11767 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11768 NULL
, DEFAULT_FACE_ID
);
11769 it
.current_x
= this_line_start_x
;
11770 it
.current_y
= this_line_y
;
11771 it
.vpos
= this_line_vpos
;
11773 /* The call to move_it_to stops in front of PT, but
11774 moves over before-strings. */
11775 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11777 if (it
.vpos
== this_line_vpos
11778 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11781 xassert (this_line_vpos
== it
.vpos
);
11782 xassert (this_line_y
== it
.current_y
);
11783 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11785 *w
->desired_matrix
->method
= 0;
11786 debug_method_add (w
, "optimization 3");
11795 /* Text changed drastically or point moved off of line. */
11796 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11799 CHARPOS (this_line_start_pos
) = 0;
11800 consider_all_windows_p
|= buffer_shared
> 1;
11801 ++clear_face_cache_count
;
11802 #ifdef HAVE_WINDOW_SYSTEM
11803 ++clear_image_cache_count
;
11806 /* Build desired matrices, and update the display. If
11807 consider_all_windows_p is non-zero, do it for all windows on all
11808 frames. Otherwise do it for selected_window, only. */
11810 if (consider_all_windows_p
)
11812 Lisp_Object tail
, frame
;
11814 FOR_EACH_FRAME (tail
, frame
)
11815 XFRAME (frame
)->updated_p
= 0;
11817 /* Recompute # windows showing selected buffer. This will be
11818 incremented each time such a window is displayed. */
11821 FOR_EACH_FRAME (tail
, frame
)
11823 struct frame
*f
= XFRAME (frame
);
11825 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11827 if (! EQ (frame
, selected_frame
))
11828 /* Select the frame, for the sake of frame-local
11830 select_frame_for_redisplay (frame
);
11832 /* Mark all the scroll bars to be removed; we'll redeem
11833 the ones we want when we redisplay their windows. */
11834 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11835 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11837 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11838 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11840 /* Any scroll bars which redisplay_windows should have
11841 nuked should now go away. */
11842 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11843 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11845 /* If fonts changed, display again. */
11846 /* ??? rms: I suspect it is a mistake to jump all the way
11847 back to retry here. It should just retry this frame. */
11848 if (fonts_changed_p
)
11851 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11853 /* See if we have to hscroll. */
11854 if (!f
->already_hscrolled_p
)
11856 f
->already_hscrolled_p
= 1;
11857 if (hscroll_windows (f
->root_window
))
11861 /* Prevent various kinds of signals during display
11862 update. stdio is not robust about handling
11863 signals, which can cause an apparent I/O
11865 if (interrupt_input
)
11866 unrequest_sigio ();
11869 /* Update the display. */
11870 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11871 pause
|= update_frame (f
, 0, 0);
11877 if (!EQ (old_frame
, selected_frame
)
11878 && FRAME_LIVE_P (XFRAME (old_frame
)))
11879 /* We played a bit fast-and-loose above and allowed selected_frame
11880 and selected_window to be temporarily out-of-sync but let's make
11881 sure this stays contained. */
11882 select_frame_for_redisplay (old_frame
);
11883 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11887 /* Do the mark_window_display_accurate after all windows have
11888 been redisplayed because this call resets flags in buffers
11889 which are needed for proper redisplay. */
11890 FOR_EACH_FRAME (tail
, frame
)
11892 struct frame
*f
= XFRAME (frame
);
11895 mark_window_display_accurate (f
->root_window
, 1);
11896 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11897 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11902 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11904 Lisp_Object mini_window
;
11905 struct frame
*mini_frame
;
11907 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11908 /* Use list_of_error, not Qerror, so that
11909 we catch only errors and don't run the debugger. */
11910 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11912 redisplay_window_error
);
11914 /* Compare desired and current matrices, perform output. */
11917 /* If fonts changed, display again. */
11918 if (fonts_changed_p
)
11921 /* Prevent various kinds of signals during display update.
11922 stdio is not robust about handling signals,
11923 which can cause an apparent I/O error. */
11924 if (interrupt_input
)
11925 unrequest_sigio ();
11928 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11930 if (hscroll_windows (selected_window
))
11933 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11934 pause
= update_frame (sf
, 0, 0);
11937 /* We may have called echo_area_display at the top of this
11938 function. If the echo area is on another frame, that may
11939 have put text on a frame other than the selected one, so the
11940 above call to update_frame would not have caught it. Catch
11942 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11943 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11945 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11947 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11948 pause
|= update_frame (mini_frame
, 0, 0);
11949 if (!pause
&& hscroll_windows (mini_window
))
11954 /* If display was paused because of pending input, make sure we do a
11955 thorough update the next time. */
11958 /* Prevent the optimization at the beginning of
11959 redisplay_internal that tries a single-line update of the
11960 line containing the cursor in the selected window. */
11961 CHARPOS (this_line_start_pos
) = 0;
11963 /* Let the overlay arrow be updated the next time. */
11964 update_overlay_arrows (0);
11966 /* If we pause after scrolling, some rows in the current
11967 matrices of some windows are not valid. */
11968 if (!WINDOW_FULL_WIDTH_P (w
)
11969 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11970 update_mode_lines
= 1;
11974 if (!consider_all_windows_p
)
11976 /* This has already been done above if
11977 consider_all_windows_p is set. */
11978 mark_window_display_accurate_1 (w
, 1);
11980 /* Say overlay arrows are up to date. */
11981 update_overlay_arrows (1);
11983 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11984 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11987 update_mode_lines
= 0;
11988 windows_or_buffers_changed
= 0;
11989 cursor_type_changed
= 0;
11992 /* Start SIGIO interrupts coming again. Having them off during the
11993 code above makes it less likely one will discard output, but not
11994 impossible, since there might be stuff in the system buffer here.
11995 But it is much hairier to try to do anything about that. */
11996 if (interrupt_input
)
12000 /* If a frame has become visible which was not before, redisplay
12001 again, so that we display it. Expose events for such a frame
12002 (which it gets when becoming visible) don't call the parts of
12003 redisplay constructing glyphs, so simply exposing a frame won't
12004 display anything in this case. So, we have to display these
12005 frames here explicitly. */
12008 Lisp_Object tail
, frame
;
12011 FOR_EACH_FRAME (tail
, frame
)
12013 int this_is_visible
= 0;
12015 if (XFRAME (frame
)->visible
)
12016 this_is_visible
= 1;
12017 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12018 if (XFRAME (frame
)->visible
)
12019 this_is_visible
= 1;
12021 if (this_is_visible
)
12025 if (new_count
!= number_of_visible_frames
)
12026 windows_or_buffers_changed
++;
12029 /* Change frame size now if a change is pending. */
12030 do_pending_window_change (1);
12032 /* If we just did a pending size change, or have additional
12033 visible frames, redisplay again. */
12034 if (windows_or_buffers_changed
&& !pause
)
12037 /* Clear the face cache eventually. */
12038 if (consider_all_windows_p
)
12040 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12042 clear_face_cache (0);
12043 clear_face_cache_count
= 0;
12045 #ifdef HAVE_WINDOW_SYSTEM
12046 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12048 clear_image_caches (Qnil
);
12049 clear_image_cache_count
= 0;
12051 #endif /* HAVE_WINDOW_SYSTEM */
12055 unbind_to (count
, Qnil
);
12060 /* Redisplay, but leave alone any recent echo area message unless
12061 another message has been requested in its place.
12063 This is useful in situations where you need to redisplay but no
12064 user action has occurred, making it inappropriate for the message
12065 area to be cleared. See tracking_off and
12066 wait_reading_process_output for examples of these situations.
12068 FROM_WHERE is an integer saying from where this function was
12069 called. This is useful for debugging. */
12072 redisplay_preserve_echo_area (from_where
)
12075 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12077 if (!NILP (echo_area_buffer
[1]))
12079 /* We have a previously displayed message, but no current
12080 message. Redisplay the previous message. */
12081 display_last_displayed_message_p
= 1;
12082 redisplay_internal (1);
12083 display_last_displayed_message_p
= 0;
12086 redisplay_internal (1);
12088 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12089 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12090 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12094 /* Function registered with record_unwind_protect in
12095 redisplay_internal. Reset redisplaying_p to the value it had
12096 before redisplay_internal was called, and clear
12097 prevent_freeing_realized_faces_p. It also selects the previously
12098 selected frame, unless it has been deleted (by an X connection
12099 failure during redisplay, for example). */
12102 unwind_redisplay (val
)
12105 Lisp_Object old_redisplaying_p
, old_frame
;
12107 old_redisplaying_p
= XCAR (val
);
12108 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12109 old_frame
= XCDR (val
);
12110 if (! EQ (old_frame
, selected_frame
)
12111 && FRAME_LIVE_P (XFRAME (old_frame
)))
12112 select_frame_for_redisplay (old_frame
);
12117 /* Mark the display of window W as accurate or inaccurate. If
12118 ACCURATE_P is non-zero mark display of W as accurate. If
12119 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12120 redisplay_internal is called. */
12123 mark_window_display_accurate_1 (w
, accurate_p
)
12127 if (BUFFERP (w
->buffer
))
12129 struct buffer
*b
= XBUFFER (w
->buffer
);
12132 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12133 w
->last_overlay_modified
12134 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12136 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12140 b
->clip_changed
= 0;
12141 b
->prevent_redisplay_optimizations_p
= 0;
12143 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12144 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12145 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12146 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12148 w
->current_matrix
->buffer
= b
;
12149 w
->current_matrix
->begv
= BUF_BEGV (b
);
12150 w
->current_matrix
->zv
= BUF_ZV (b
);
12152 w
->last_cursor
= w
->cursor
;
12153 w
->last_cursor_off_p
= w
->cursor_off_p
;
12155 if (w
== XWINDOW (selected_window
))
12156 w
->last_point
= make_number (BUF_PT (b
));
12158 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12164 w
->window_end_valid
= w
->buffer
;
12165 w
->update_mode_line
= Qnil
;
12170 /* Mark the display of windows in the window tree rooted at WINDOW as
12171 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12172 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12173 be redisplayed the next time redisplay_internal is called. */
12176 mark_window_display_accurate (window
, accurate_p
)
12177 Lisp_Object window
;
12182 for (; !NILP (window
); window
= w
->next
)
12184 w
= XWINDOW (window
);
12185 mark_window_display_accurate_1 (w
, accurate_p
);
12187 if (!NILP (w
->vchild
))
12188 mark_window_display_accurate (w
->vchild
, accurate_p
);
12189 if (!NILP (w
->hchild
))
12190 mark_window_display_accurate (w
->hchild
, accurate_p
);
12195 update_overlay_arrows (1);
12199 /* Force a thorough redisplay the next time by setting
12200 last_arrow_position and last_arrow_string to t, which is
12201 unequal to any useful value of Voverlay_arrow_... */
12202 update_overlay_arrows (-1);
12207 /* Return value in display table DP (Lisp_Char_Table *) for character
12208 C. Since a display table doesn't have any parent, we don't have to
12209 follow parent. Do not call this function directly but use the
12210 macro DISP_CHAR_VECTOR. */
12213 disp_char_vector (dp
, c
)
12214 struct Lisp_Char_Table
*dp
;
12219 if (ASCII_CHAR_P (c
))
12222 if (SUB_CHAR_TABLE_P (val
))
12223 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12229 XSETCHAR_TABLE (table
, dp
);
12230 val
= char_table_ref (table
, c
);
12239 /***********************************************************************
12241 ***********************************************************************/
12243 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12246 redisplay_windows (window
)
12247 Lisp_Object window
;
12249 while (!NILP (window
))
12251 struct window
*w
= XWINDOW (window
);
12253 if (!NILP (w
->hchild
))
12254 redisplay_windows (w
->hchild
);
12255 else if (!NILP (w
->vchild
))
12256 redisplay_windows (w
->vchild
);
12259 displayed_buffer
= XBUFFER (w
->buffer
);
12260 /* Use list_of_error, not Qerror, so that
12261 we catch only errors and don't run the debugger. */
12262 internal_condition_case_1 (redisplay_window_0
, window
,
12264 redisplay_window_error
);
12272 redisplay_window_error ()
12274 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12279 redisplay_window_0 (window
)
12280 Lisp_Object window
;
12282 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12283 redisplay_window (window
, 0);
12288 redisplay_window_1 (window
)
12289 Lisp_Object window
;
12291 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12292 redisplay_window (window
, 1);
12297 /* Increment GLYPH until it reaches END or CONDITION fails while
12298 adding (GLYPH)->pixel_width to X. */
12300 #define SKIP_GLYPHS(glyph, end, x, condition) \
12303 (x) += (glyph)->pixel_width; \
12306 while ((glyph) < (end) && (condition))
12309 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12310 DELTA is the number of bytes by which positions recorded in ROW
12311 differ from current buffer positions.
12313 Return 0 if cursor is not on this row. 1 otherwise. */
12316 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12318 struct glyph_row
*row
;
12319 struct glyph_matrix
*matrix
;
12320 int delta
, delta_bytes
, dy
, dvpos
;
12322 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12323 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12324 struct glyph
*cursor
= NULL
;
12325 /* The first glyph that starts a sequence of glyphs from string. */
12326 struct glyph
*string_start
;
12327 /* The X coordinate of string_start. */
12328 int string_start_x
;
12329 /* The last known character position. */
12330 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12331 /* The last known character position before string_start. */
12332 int string_before_pos
;
12335 int cursor_from_overlay_pos
= 0;
12336 int pt_old
= PT
- delta
;
12338 /* Skip over glyphs not having an object at the start of the row.
12339 These are special glyphs like truncation marks on terminal
12341 if (row
->displays_text_p
)
12343 && INTEGERP (glyph
->object
)
12344 && glyph
->charpos
< 0)
12346 x
+= glyph
->pixel_width
;
12350 string_start
= NULL
;
12352 && !INTEGERP (glyph
->object
)
12353 && (!BUFFERP (glyph
->object
)
12354 || (last_pos
= glyph
->charpos
) < pt_old
12355 || glyph
->avoid_cursor_p
))
12357 if (! STRINGP (glyph
->object
))
12359 string_start
= NULL
;
12360 x
+= glyph
->pixel_width
;
12362 if (cursor_from_overlay_pos
12363 && last_pos
>= cursor_from_overlay_pos
)
12365 cursor_from_overlay_pos
= 0;
12371 if (string_start
== NULL
)
12373 string_before_pos
= last_pos
;
12374 string_start
= glyph
;
12375 string_start_x
= x
;
12377 /* Skip all glyphs from string. */
12382 if ((cursor
== NULL
|| glyph
> cursor
)
12383 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12384 Qcursor
, (glyph
)->object
),
12386 && (pos
= string_buffer_position (w
, glyph
->object
,
12387 string_before_pos
),
12388 (pos
== 0 /* From overlay */
12389 || pos
== pt_old
)))
12391 /* Estimate overlay buffer position from the buffer
12392 positions of the glyphs before and after the overlay.
12393 Add 1 to last_pos so that if point corresponds to the
12394 glyph right after the overlay, we still use a 'cursor'
12395 property found in that overlay. */
12396 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12397 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12401 x
+= glyph
->pixel_width
;
12404 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12408 if (cursor
!= NULL
)
12413 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12415 /* Scan back over the ellipsis glyphs, decrementing positions. */
12416 while (glyph
> row
->glyphs
[TEXT_AREA
]
12417 && (glyph
- 1)->charpos
== last_pos
)
12418 glyph
--, x
-= glyph
->pixel_width
;
12419 /* That loop always goes one position too far,
12420 including the glyph before the ellipsis.
12421 So scan forward over that one. */
12422 x
+= glyph
->pixel_width
;
12425 else if (string_start
12426 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12428 /* We may have skipped over point because the previous glyphs
12429 are from string. As there's no easy way to know the
12430 character position of the current glyph, find the correct
12431 glyph on point by scanning from string_start again. */
12433 Lisp_Object string
;
12434 struct glyph
*stop
= glyph
;
12437 limit
= make_number (pt_old
+ 1);
12438 glyph
= string_start
;
12439 x
= string_start_x
;
12440 string
= glyph
->object
;
12441 pos
= string_buffer_position (w
, string
, string_before_pos
);
12442 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12443 because we always put cursor after overlay strings. */
12444 while (pos
== 0 && glyph
< stop
)
12446 string
= glyph
->object
;
12447 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12449 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12452 while (glyph
< stop
)
12454 pos
= XINT (Fnext_single_char_property_change
12455 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12458 /* Skip glyphs from the same string. */
12459 string
= glyph
->object
;
12460 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12461 /* Skip glyphs from an overlay. */
12462 while (glyph
< stop
12463 && ! string_buffer_position (w
, glyph
->object
, pos
))
12465 string
= glyph
->object
;
12466 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12470 /* If we reached the end of the line, and end was from a string,
12471 cursor is not on this line. */
12472 if (glyph
== end
&& row
->continued_p
)
12476 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12478 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12479 w
->cursor
.y
= row
->y
+ dy
;
12481 if (w
== XWINDOW (selected_window
))
12483 if (!row
->continued_p
12484 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12487 this_line_buffer
= XBUFFER (w
->buffer
);
12489 CHARPOS (this_line_start_pos
)
12490 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12491 BYTEPOS (this_line_start_pos
)
12492 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12494 CHARPOS (this_line_end_pos
)
12495 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12496 BYTEPOS (this_line_end_pos
)
12497 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12499 this_line_y
= w
->cursor
.y
;
12500 this_line_pixel_height
= row
->height
;
12501 this_line_vpos
= w
->cursor
.vpos
;
12502 this_line_start_x
= row
->x
;
12505 CHARPOS (this_line_start_pos
) = 0;
12512 /* Run window scroll functions, if any, for WINDOW with new window
12513 start STARTP. Sets the window start of WINDOW to that position.
12515 We assume that the window's buffer is really current. */
12517 static INLINE
struct text_pos
12518 run_window_scroll_functions (window
, startp
)
12519 Lisp_Object window
;
12520 struct text_pos startp
;
12522 struct window
*w
= XWINDOW (window
);
12523 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12525 if (current_buffer
!= XBUFFER (w
->buffer
))
12528 if (!NILP (Vwindow_scroll_functions
))
12530 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12531 make_number (CHARPOS (startp
)));
12532 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12533 /* In case the hook functions switch buffers. */
12534 if (current_buffer
!= XBUFFER (w
->buffer
))
12535 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12542 /* Make sure the line containing the cursor is fully visible.
12543 A value of 1 means there is nothing to be done.
12544 (Either the line is fully visible, or it cannot be made so,
12545 or we cannot tell.)
12547 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12548 is higher than window.
12550 A value of 0 means the caller should do scrolling
12551 as if point had gone off the screen. */
12554 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12557 int current_matrix_p
;
12559 struct glyph_matrix
*matrix
;
12560 struct glyph_row
*row
;
12563 if (!make_cursor_line_fully_visible_p
)
12566 /* It's not always possible to find the cursor, e.g, when a window
12567 is full of overlay strings. Don't do anything in that case. */
12568 if (w
->cursor
.vpos
< 0)
12571 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12572 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12574 /* If the cursor row is not partially visible, there's nothing to do. */
12575 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12578 /* If the row the cursor is in is taller than the window's height,
12579 it's not clear what to do, so do nothing. */
12580 window_height
= window_box_height (w
);
12581 if (row
->height
>= window_height
)
12583 if (!force_p
|| MINI_WINDOW_P (w
)
12584 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12590 /* This code used to try to scroll the window just enough to make
12591 the line visible. It returned 0 to say that the caller should
12592 allocate larger glyph matrices. */
12594 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12596 int dy
= row
->height
- row
->visible_height
;
12599 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12601 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12603 int dy
= - (row
->height
- row
->visible_height
);
12606 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12609 /* When we change the cursor y-position of the selected window,
12610 change this_line_y as well so that the display optimization for
12611 the cursor line of the selected window in redisplay_internal uses
12612 the correct y-position. */
12613 if (w
== XWINDOW (selected_window
))
12614 this_line_y
= w
->cursor
.y
;
12616 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12617 redisplay with larger matrices. */
12618 if (matrix
->nrows
< required_matrix_height (w
))
12620 fonts_changed_p
= 1;
12629 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12630 non-zero means only WINDOW is redisplayed in redisplay_internal.
12631 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12632 in redisplay_window to bring a partially visible line into view in
12633 the case that only the cursor has moved.
12635 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12636 last screen line's vertical height extends past the end of the screen.
12640 1 if scrolling succeeded
12642 0 if scrolling didn't find point.
12644 -1 if new fonts have been loaded so that we must interrupt
12645 redisplay, adjust glyph matrices, and try again. */
12651 SCROLLING_NEED_LARGER_MATRICES
12655 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12656 scroll_step
, temp_scroll_step
, last_line_misfit
)
12657 Lisp_Object window
;
12658 int just_this_one_p
;
12659 EMACS_INT scroll_conservatively
, scroll_step
;
12660 int temp_scroll_step
;
12661 int last_line_misfit
;
12663 struct window
*w
= XWINDOW (window
);
12664 struct frame
*f
= XFRAME (w
->frame
);
12665 struct text_pos pos
, startp
;
12667 int this_scroll_margin
, scroll_max
, rc
, height
;
12668 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12669 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12670 Lisp_Object aggressive
;
12671 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12674 debug_method_add (w
, "try_scrolling");
12677 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12679 /* Compute scroll margin height in pixels. We scroll when point is
12680 within this distance from the top or bottom of the window. */
12681 if (scroll_margin
> 0)
12682 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
12683 * FRAME_LINE_HEIGHT (f
);
12685 this_scroll_margin
= 0;
12687 /* Force scroll_conservatively to have a reasonable value, to avoid
12688 overflow while computing how much to scroll. Note that the user
12689 can supply scroll-conservatively equal to `most-positive-fixnum',
12690 which can be larger than INT_MAX. */
12691 if (scroll_conservatively
> scroll_limit
)
12693 scroll_conservatively
= scroll_limit
;
12694 scroll_max
= INT_MAX
;
12696 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12697 /* Compute how much we should try to scroll maximally to bring
12698 point into view. */
12699 scroll_max
= (max (scroll_step
,
12700 max (scroll_conservatively
, temp_scroll_step
))
12701 * FRAME_LINE_HEIGHT (f
));
12702 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12703 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12704 /* We're trying to scroll because of aggressive scrolling but no
12705 scroll_step is set. Choose an arbitrary one. */
12706 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
12712 /* Decide whether to scroll down. */
12713 if (PT
> CHARPOS (startp
))
12715 int scroll_margin_y
;
12717 /* Compute the pixel ypos of the scroll margin, then move it to
12718 either that ypos or PT, whichever comes first. */
12719 start_display (&it
, w
, startp
);
12720 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
12721 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
12722 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
12723 (MOVE_TO_POS
| MOVE_TO_Y
));
12725 if (PT
> CHARPOS (it
.current
.pos
))
12727 int y0
= line_bottom_y (&it
);
12729 /* Compute the distance from the scroll margin to PT
12730 (including the height of the cursor line). Moving the
12731 iterator unconditionally to PT can be slow if PT is far
12732 away, so stop 10 lines past the window bottom (is there a
12733 way to do the right thing quickly?). */
12734 move_it_to (&it
, PT
, -1,
12735 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
12736 -1, MOVE_TO_POS
| MOVE_TO_Y
);
12737 dy
= line_bottom_y (&it
) - y0
;
12739 if (dy
> scroll_max
)
12740 return SCROLLING_FAILED
;
12748 /* Point is in or below the bottom scroll margin, so move the
12749 window start down. If scrolling conservatively, move it just
12750 enough down to make point visible. If scroll_step is set,
12751 move it down by scroll_step. */
12752 if (scroll_conservatively
)
12754 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12755 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12756 else if (scroll_step
|| temp_scroll_step
)
12757 amount_to_scroll
= scroll_max
;
12760 aggressive
= current_buffer
->scroll_up_aggressively
;
12761 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12762 if (NUMBERP (aggressive
))
12764 double float_amount
= XFLOATINT (aggressive
) * height
;
12765 amount_to_scroll
= float_amount
;
12766 if (amount_to_scroll
== 0 && float_amount
> 0)
12767 amount_to_scroll
= 1;
12771 if (amount_to_scroll
<= 0)
12772 return SCROLLING_FAILED
;
12774 start_display (&it
, w
, startp
);
12775 move_it_vertically (&it
, amount_to_scroll
);
12777 /* If STARTP is unchanged, move it down another screen line. */
12778 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12779 move_it_by_lines (&it
, 1, 1);
12780 startp
= it
.current
.pos
;
12784 struct text_pos scroll_margin_pos
= startp
;
12786 /* See if point is inside the scroll margin at the top of the
12788 if (this_scroll_margin
)
12790 start_display (&it
, w
, startp
);
12791 move_it_vertically (&it
, this_scroll_margin
);
12792 scroll_margin_pos
= it
.current
.pos
;
12795 if (PT
< CHARPOS (scroll_margin_pos
))
12797 /* Point is in the scroll margin at the top of the window or
12798 above what is displayed in the window. */
12801 /* Compute the vertical distance from PT to the scroll
12802 margin position. Give up if distance is greater than
12804 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12805 start_display (&it
, w
, pos
);
12807 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12808 it
.last_visible_y
, -1,
12809 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12810 dy
= it
.current_y
- y0
;
12811 if (dy
> scroll_max
)
12812 return SCROLLING_FAILED
;
12814 /* Compute new window start. */
12815 start_display (&it
, w
, startp
);
12817 if (scroll_conservatively
)
12819 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12820 else if (scroll_step
|| temp_scroll_step
)
12821 amount_to_scroll
= scroll_max
;
12824 aggressive
= current_buffer
->scroll_down_aggressively
;
12825 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12826 if (NUMBERP (aggressive
))
12828 double float_amount
= XFLOATINT (aggressive
) * height
;
12829 amount_to_scroll
= float_amount
;
12830 if (amount_to_scroll
== 0 && float_amount
> 0)
12831 amount_to_scroll
= 1;
12835 if (amount_to_scroll
<= 0)
12836 return SCROLLING_FAILED
;
12838 move_it_vertically_backward (&it
, amount_to_scroll
);
12839 startp
= it
.current
.pos
;
12843 /* Run window scroll functions. */
12844 startp
= run_window_scroll_functions (window
, startp
);
12846 /* Display the window. Give up if new fonts are loaded, or if point
12848 if (!try_window (window
, startp
, 0))
12849 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12850 else if (w
->cursor
.vpos
< 0)
12852 clear_glyph_matrix (w
->desired_matrix
);
12853 rc
= SCROLLING_FAILED
;
12857 /* Maybe forget recorded base line for line number display. */
12858 if (!just_this_one_p
12859 || current_buffer
->clip_changed
12860 || BEG_UNCHANGED
< CHARPOS (startp
))
12861 w
->base_line_number
= Qnil
;
12863 /* If cursor ends up on a partially visible line,
12864 treat that as being off the bottom of the screen. */
12865 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12867 clear_glyph_matrix (w
->desired_matrix
);
12868 ++extra_scroll_margin_lines
;
12871 rc
= SCROLLING_SUCCESS
;
12878 /* Compute a suitable window start for window W if display of W starts
12879 on a continuation line. Value is non-zero if a new window start
12882 The new window start will be computed, based on W's width, starting
12883 from the start of the continued line. It is the start of the
12884 screen line with the minimum distance from the old start W->start. */
12887 compute_window_start_on_continuation_line (w
)
12890 struct text_pos pos
, start_pos
;
12891 int window_start_changed_p
= 0;
12893 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12895 /* If window start is on a continuation line... Window start may be
12896 < BEGV in case there's invisible text at the start of the
12897 buffer (M-x rmail, for example). */
12898 if (CHARPOS (start_pos
) > BEGV
12899 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12902 struct glyph_row
*row
;
12904 /* Handle the case that the window start is out of range. */
12905 if (CHARPOS (start_pos
) < BEGV
)
12906 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12907 else if (CHARPOS (start_pos
) > ZV
)
12908 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12910 /* Find the start of the continued line. This should be fast
12911 because scan_buffer is fast (newline cache). */
12912 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12913 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12914 row
, DEFAULT_FACE_ID
);
12915 reseat_at_previous_visible_line_start (&it
);
12917 /* If the line start is "too far" away from the window start,
12918 say it takes too much time to compute a new window start. */
12919 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12920 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12922 int min_distance
, distance
;
12924 /* Move forward by display lines to find the new window
12925 start. If window width was enlarged, the new start can
12926 be expected to be > the old start. If window width was
12927 decreased, the new window start will be < the old start.
12928 So, we're looking for the display line start with the
12929 minimum distance from the old window start. */
12930 pos
= it
.current
.pos
;
12931 min_distance
= INFINITY
;
12932 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12933 distance
< min_distance
)
12935 min_distance
= distance
;
12936 pos
= it
.current
.pos
;
12937 move_it_by_lines (&it
, 1, 0);
12940 /* Set the window start there. */
12941 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12942 window_start_changed_p
= 1;
12946 return window_start_changed_p
;
12950 /* Try cursor movement in case text has not changed in window WINDOW,
12951 with window start STARTP. Value is
12953 CURSOR_MOVEMENT_SUCCESS if successful
12955 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12957 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12958 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12959 we want to scroll as if scroll-step were set to 1. See the code.
12961 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12962 which case we have to abort this redisplay, and adjust matrices
12967 CURSOR_MOVEMENT_SUCCESS
,
12968 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12969 CURSOR_MOVEMENT_MUST_SCROLL
,
12970 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12974 try_cursor_movement (window
, startp
, scroll_step
)
12975 Lisp_Object window
;
12976 struct text_pos startp
;
12979 struct window
*w
= XWINDOW (window
);
12980 struct frame
*f
= XFRAME (w
->frame
);
12981 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12984 if (inhibit_try_cursor_movement
)
12988 /* Handle case where text has not changed, only point, and it has
12989 not moved off the frame. */
12990 if (/* Point may be in this window. */
12991 PT
>= CHARPOS (startp
)
12992 /* Selective display hasn't changed. */
12993 && !current_buffer
->clip_changed
12994 /* Function force-mode-line-update is used to force a thorough
12995 redisplay. It sets either windows_or_buffers_changed or
12996 update_mode_lines. So don't take a shortcut here for these
12998 && !update_mode_lines
12999 && !windows_or_buffers_changed
13000 && !cursor_type_changed
13001 /* Can't use this case if highlighting a region. When a
13002 region exists, cursor movement has to do more than just
13004 && !(!NILP (Vtransient_mark_mode
)
13005 && !NILP (current_buffer
->mark_active
))
13006 && NILP (w
->region_showing
)
13007 && NILP (Vshow_trailing_whitespace
)
13008 /* Right after splitting windows, last_point may be nil. */
13009 && INTEGERP (w
->last_point
)
13010 /* This code is not used for mini-buffer for the sake of the case
13011 of redisplaying to replace an echo area message; since in
13012 that case the mini-buffer contents per se are usually
13013 unchanged. This code is of no real use in the mini-buffer
13014 since the handling of this_line_start_pos, etc., in redisplay
13015 handles the same cases. */
13016 && !EQ (window
, minibuf_window
)
13017 /* When splitting windows or for new windows, it happens that
13018 redisplay is called with a nil window_end_vpos or one being
13019 larger than the window. This should really be fixed in
13020 window.c. I don't have this on my list, now, so we do
13021 approximately the same as the old redisplay code. --gerd. */
13022 && INTEGERP (w
->window_end_vpos
)
13023 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13024 && (FRAME_WINDOW_P (f
)
13025 || !overlay_arrow_in_current_buffer_p ()))
13027 int this_scroll_margin
, top_scroll_margin
;
13028 struct glyph_row
*row
= NULL
;
13031 debug_method_add (w
, "cursor movement");
13034 /* Scroll if point within this distance from the top or bottom
13035 of the window. This is a pixel value. */
13036 if (scroll_margin
> 0)
13038 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13039 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13042 this_scroll_margin
= 0;
13044 top_scroll_margin
= this_scroll_margin
;
13045 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13046 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13048 /* Start with the row the cursor was displayed during the last
13049 not paused redisplay. Give up if that row is not valid. */
13050 if (w
->last_cursor
.vpos
< 0
13051 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13052 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13055 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13056 if (row
->mode_line_p
)
13058 if (!row
->enabled_p
)
13059 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13062 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13065 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13067 if (PT
> XFASTINT (w
->last_point
))
13069 /* Point has moved forward. */
13070 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13071 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13073 xassert (row
->enabled_p
);
13077 /* The end position of a row equals the start position
13078 of the next row. If PT is there, we would rather
13079 display it in the next line. */
13080 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13081 && MATRIX_ROW_END_CHARPOS (row
) == PT
13082 && !cursor_row_p (w
, row
))
13085 /* If within the scroll margin, scroll. Note that
13086 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13087 the next line would be drawn, and that
13088 this_scroll_margin can be zero. */
13089 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13090 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13091 /* Line is completely visible last line in window
13092 and PT is to be set in the next line. */
13093 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13094 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13095 && !row
->ends_at_zv_p
13096 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13099 else if (PT
< XFASTINT (w
->last_point
))
13101 /* Cursor has to be moved backward. Note that PT >=
13102 CHARPOS (startp) because of the outer if-statement. */
13103 while (!row
->mode_line_p
13104 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13105 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13106 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13107 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13108 row
> w
->current_matrix
->rows
13109 && (row
-1)->ends_in_newline_from_string_p
))))
13110 && (row
->y
> top_scroll_margin
13111 || CHARPOS (startp
) == BEGV
))
13113 xassert (row
->enabled_p
);
13117 /* Consider the following case: Window starts at BEGV,
13118 there is invisible, intangible text at BEGV, so that
13119 display starts at some point START > BEGV. It can
13120 happen that we are called with PT somewhere between
13121 BEGV and START. Try to handle that case. */
13122 if (row
< w
->current_matrix
->rows
13123 || row
->mode_line_p
)
13125 row
= w
->current_matrix
->rows
;
13126 if (row
->mode_line_p
)
13130 /* Due to newlines in overlay strings, we may have to
13131 skip forward over overlay strings. */
13132 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13133 && MATRIX_ROW_END_CHARPOS (row
) == PT
13134 && !cursor_row_p (w
, row
))
13137 /* If within the scroll margin, scroll. */
13138 if (row
->y
< top_scroll_margin
13139 && CHARPOS (startp
) != BEGV
)
13144 /* Cursor did not move. So don't scroll even if cursor line
13145 is partially visible, as it was so before. */
13146 rc
= CURSOR_MOVEMENT_SUCCESS
;
13149 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13150 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13152 /* if PT is not in the glyph row, give up. */
13153 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13155 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13156 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13157 && make_cursor_line_fully_visible_p
)
13159 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13160 && !row
->ends_at_zv_p
13161 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13162 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13163 else if (row
->height
> window_box_height (w
))
13165 /* If we end up in a partially visible line, let's
13166 make it fully visible, except when it's taller
13167 than the window, in which case we can't do much
13170 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13174 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13175 if (!cursor_row_fully_visible_p (w
, 0, 1))
13176 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13178 rc
= CURSOR_MOVEMENT_SUCCESS
;
13182 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13187 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13189 rc
= CURSOR_MOVEMENT_SUCCESS
;
13194 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13195 && MATRIX_ROW_START_CHARPOS (row
) == PT
13196 && cursor_row_p (w
, row
));
13205 set_vertical_scroll_bar (w
)
13208 int start
, end
, whole
;
13210 /* Calculate the start and end positions for the current window.
13211 At some point, it would be nice to choose between scrollbars
13212 which reflect the whole buffer size, with special markers
13213 indicating narrowing, and scrollbars which reflect only the
13216 Note that mini-buffers sometimes aren't displaying any text. */
13217 if (!MINI_WINDOW_P (w
)
13218 || (w
== XWINDOW (minibuf_window
)
13219 && NILP (echo_area_buffer
[0])))
13221 struct buffer
*buf
= XBUFFER (w
->buffer
);
13222 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13223 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13224 /* I don't think this is guaranteed to be right. For the
13225 moment, we'll pretend it is. */
13226 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13230 if (whole
< (end
- start
))
13231 whole
= end
- start
;
13234 start
= end
= whole
= 0;
13236 /* Indicate what this scroll bar ought to be displaying now. */
13237 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13238 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13239 (w
, end
- start
, whole
, start
);
13243 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13244 selected_window is redisplayed.
13246 We can return without actually redisplaying the window if
13247 fonts_changed_p is nonzero. In that case, redisplay_internal will
13251 redisplay_window (window
, just_this_one_p
)
13252 Lisp_Object window
;
13253 int just_this_one_p
;
13255 struct window
*w
= XWINDOW (window
);
13256 struct frame
*f
= XFRAME (w
->frame
);
13257 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13258 struct buffer
*old
= current_buffer
;
13259 struct text_pos lpoint
, opoint
, startp
;
13260 int update_mode_line
;
13263 /* Record it now because it's overwritten. */
13264 int current_matrix_up_to_date_p
= 0;
13265 int used_current_matrix_p
= 0;
13266 /* This is less strict than current_matrix_up_to_date_p.
13267 It indictes that the buffer contents and narrowing are unchanged. */
13268 int buffer_unchanged_p
= 0;
13269 int temp_scroll_step
= 0;
13270 int count
= SPECPDL_INDEX ();
13272 int centering_position
= -1;
13273 int last_line_misfit
= 0;
13274 int beg_unchanged
, end_unchanged
;
13276 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13279 /* W must be a leaf window here. */
13280 xassert (!NILP (w
->buffer
));
13282 *w
->desired_matrix
->method
= 0;
13286 reconsider_clip_changes (w
, buffer
);
13288 /* Has the mode line to be updated? */
13289 update_mode_line
= (!NILP (w
->update_mode_line
)
13290 || update_mode_lines
13291 || buffer
->clip_changed
13292 || buffer
->prevent_redisplay_optimizations_p
);
13294 if (MINI_WINDOW_P (w
))
13296 if (w
== XWINDOW (echo_area_window
)
13297 && !NILP (echo_area_buffer
[0]))
13299 if (update_mode_line
)
13300 /* We may have to update a tty frame's menu bar or a
13301 tool-bar. Example `M-x C-h C-h C-g'. */
13302 goto finish_menu_bars
;
13304 /* We've already displayed the echo area glyphs in this window. */
13305 goto finish_scroll_bars
;
13307 else if ((w
!= XWINDOW (minibuf_window
)
13308 || minibuf_level
== 0)
13309 /* When buffer is nonempty, redisplay window normally. */
13310 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13311 /* Quail displays non-mini buffers in minibuffer window.
13312 In that case, redisplay the window normally. */
13313 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13315 /* W is a mini-buffer window, but it's not active, so clear
13317 int yb
= window_text_bottom_y (w
);
13318 struct glyph_row
*row
;
13321 for (y
= 0, row
= w
->desired_matrix
->rows
;
13323 y
+= row
->height
, ++row
)
13324 blank_row (w
, row
, y
);
13325 goto finish_scroll_bars
;
13328 clear_glyph_matrix (w
->desired_matrix
);
13331 /* Otherwise set up data on this window; select its buffer and point
13333 /* Really select the buffer, for the sake of buffer-local
13335 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13337 current_matrix_up_to_date_p
13338 = (!NILP (w
->window_end_valid
)
13339 && !current_buffer
->clip_changed
13340 && !current_buffer
->prevent_redisplay_optimizations_p
13341 && XFASTINT (w
->last_modified
) >= MODIFF
13342 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13344 /* Run the window-bottom-change-functions
13345 if it is possible that the text on the screen has changed
13346 (either due to modification of the text, or any other reason). */
13347 if (!current_matrix_up_to_date_p
13348 && !NILP (Vwindow_text_change_functions
))
13350 safe_run_hooks (Qwindow_text_change_functions
);
13354 beg_unchanged
= BEG_UNCHANGED
;
13355 end_unchanged
= END_UNCHANGED
;
13357 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13359 specbind (Qinhibit_point_motion_hooks
, Qt
);
13362 = (!NILP (w
->window_end_valid
)
13363 && !current_buffer
->clip_changed
13364 && XFASTINT (w
->last_modified
) >= MODIFF
13365 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13367 /* When windows_or_buffers_changed is non-zero, we can't rely on
13368 the window end being valid, so set it to nil there. */
13369 if (windows_or_buffers_changed
)
13371 /* If window starts on a continuation line, maybe adjust the
13372 window start in case the window's width changed. */
13373 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13374 compute_window_start_on_continuation_line (w
);
13376 w
->window_end_valid
= Qnil
;
13379 /* Some sanity checks. */
13380 CHECK_WINDOW_END (w
);
13381 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13383 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13386 /* If %c is in mode line, update it if needed. */
13387 if (!NILP (w
->column_number_displayed
)
13388 /* This alternative quickly identifies a common case
13389 where no change is needed. */
13390 && !(PT
== XFASTINT (w
->last_point
)
13391 && XFASTINT (w
->last_modified
) >= MODIFF
13392 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13393 && (XFASTINT (w
->column_number_displayed
)
13394 != (int) current_column ())) /* iftc */
13395 update_mode_line
= 1;
13397 /* Count number of windows showing the selected buffer. An indirect
13398 buffer counts as its base buffer. */
13399 if (!just_this_one_p
)
13401 struct buffer
*current_base
, *window_base
;
13402 current_base
= current_buffer
;
13403 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13404 if (current_base
->base_buffer
)
13405 current_base
= current_base
->base_buffer
;
13406 if (window_base
->base_buffer
)
13407 window_base
= window_base
->base_buffer
;
13408 if (current_base
== window_base
)
13412 /* Point refers normally to the selected window. For any other
13413 window, set up appropriate value. */
13414 if (!EQ (window
, selected_window
))
13416 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13417 int new_pt_byte
= marker_byte_position (w
->pointm
);
13421 new_pt_byte
= BEGV_BYTE
;
13422 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13424 else if (new_pt
> (ZV
- 1))
13427 new_pt_byte
= ZV_BYTE
;
13428 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13431 /* We don't use SET_PT so that the point-motion hooks don't run. */
13432 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13435 /* If any of the character widths specified in the display table
13436 have changed, invalidate the width run cache. It's true that
13437 this may be a bit late to catch such changes, but the rest of
13438 redisplay goes (non-fatally) haywire when the display table is
13439 changed, so why should we worry about doing any better? */
13440 if (current_buffer
->width_run_cache
)
13442 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13444 if (! disptab_matches_widthtab (disptab
,
13445 XVECTOR (current_buffer
->width_table
)))
13447 invalidate_region_cache (current_buffer
,
13448 current_buffer
->width_run_cache
,
13450 recompute_width_table (current_buffer
, disptab
);
13454 /* If window-start is screwed up, choose a new one. */
13455 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13458 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13460 /* If someone specified a new starting point but did not insist,
13461 check whether it can be used. */
13462 if (!NILP (w
->optional_new_start
)
13463 && CHARPOS (startp
) >= BEGV
13464 && CHARPOS (startp
) <= ZV
)
13466 w
->optional_new_start
= Qnil
;
13467 start_display (&it
, w
, startp
);
13468 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13469 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13470 if (IT_CHARPOS (it
) == PT
)
13471 w
->force_start
= Qt
;
13472 /* IT may overshoot PT if text at PT is invisible. */
13473 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13474 w
->force_start
= Qt
;
13479 /* Handle case where place to start displaying has been specified,
13480 unless the specified location is outside the accessible range. */
13481 if (!NILP (w
->force_start
)
13482 || w
->frozen_window_start_p
)
13484 /* We set this later on if we have to adjust point. */
13487 w
->force_start
= Qnil
;
13489 w
->window_end_valid
= Qnil
;
13491 /* Forget any recorded base line for line number display. */
13492 if (!buffer_unchanged_p
)
13493 w
->base_line_number
= Qnil
;
13495 /* Redisplay the mode line. Select the buffer properly for that.
13496 Also, run the hook window-scroll-functions
13497 because we have scrolled. */
13498 /* Note, we do this after clearing force_start because
13499 if there's an error, it is better to forget about force_start
13500 than to get into an infinite loop calling the hook functions
13501 and having them get more errors. */
13502 if (!update_mode_line
13503 || ! NILP (Vwindow_scroll_functions
))
13505 update_mode_line
= 1;
13506 w
->update_mode_line
= Qt
;
13507 startp
= run_window_scroll_functions (window
, startp
);
13510 w
->last_modified
= make_number (0);
13511 w
->last_overlay_modified
= make_number (0);
13512 if (CHARPOS (startp
) < BEGV
)
13513 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13514 else if (CHARPOS (startp
) > ZV
)
13515 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13517 /* Redisplay, then check if cursor has been set during the
13518 redisplay. Give up if new fonts were loaded. */
13519 /* We used to issue a CHECK_MARGINS argument to try_window here,
13520 but this causes scrolling to fail when point begins inside
13521 the scroll margin (bug#148) -- cyd */
13522 if (!try_window (window
, startp
, 0))
13524 w
->force_start
= Qt
;
13525 clear_glyph_matrix (w
->desired_matrix
);
13526 goto need_larger_matrices
;
13529 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13531 /* If point does not appear, try to move point so it does
13532 appear. The desired matrix has been built above, so we
13533 can use it here. */
13534 new_vpos
= window_box_height (w
) / 2;
13537 if (!cursor_row_fully_visible_p (w
, 0, 0))
13539 /* Point does appear, but on a line partly visible at end of window.
13540 Move it back to a fully-visible line. */
13541 new_vpos
= window_box_height (w
);
13544 /* If we need to move point for either of the above reasons,
13545 now actually do it. */
13548 struct glyph_row
*row
;
13550 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13551 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13554 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13555 MATRIX_ROW_START_BYTEPOS (row
));
13557 if (w
!= XWINDOW (selected_window
))
13558 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13559 else if (current_buffer
== old
)
13560 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13562 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13564 /* If we are highlighting the region, then we just changed
13565 the region, so redisplay to show it. */
13566 if (!NILP (Vtransient_mark_mode
)
13567 && !NILP (current_buffer
->mark_active
))
13569 clear_glyph_matrix (w
->desired_matrix
);
13570 if (!try_window (window
, startp
, 0))
13571 goto need_larger_matrices
;
13576 debug_method_add (w
, "forced window start");
13581 /* Handle case where text has not changed, only point, and it has
13582 not moved off the frame, and we are not retrying after hscroll.
13583 (current_matrix_up_to_date_p is nonzero when retrying.) */
13584 if (current_matrix_up_to_date_p
13585 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13586 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13590 case CURSOR_MOVEMENT_SUCCESS
:
13591 used_current_matrix_p
= 1;
13594 #if 0 /* try_cursor_movement never returns this value. */
13595 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13596 goto need_larger_matrices
;
13599 case CURSOR_MOVEMENT_MUST_SCROLL
:
13600 goto try_to_scroll
;
13606 /* If current starting point was originally the beginning of a line
13607 but no longer is, find a new starting point. */
13608 else if (!NILP (w
->start_at_line_beg
)
13609 && !(CHARPOS (startp
) <= BEGV
13610 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13613 debug_method_add (w
, "recenter 1");
13618 /* Try scrolling with try_window_id. Value is > 0 if update has
13619 been done, it is -1 if we know that the same window start will
13620 not work. It is 0 if unsuccessful for some other reason. */
13621 else if ((tem
= try_window_id (w
)) != 0)
13624 debug_method_add (w
, "try_window_id %d", tem
);
13627 if (fonts_changed_p
)
13628 goto need_larger_matrices
;
13632 /* Otherwise try_window_id has returned -1 which means that we
13633 don't want the alternative below this comment to execute. */
13635 else if (CHARPOS (startp
) >= BEGV
13636 && CHARPOS (startp
) <= ZV
13637 && PT
>= CHARPOS (startp
)
13638 && (CHARPOS (startp
) < ZV
13639 /* Avoid starting at end of buffer. */
13640 || CHARPOS (startp
) == BEGV
13641 || (XFASTINT (w
->last_modified
) >= MODIFF
13642 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13645 /* If first window line is a continuation line, and window start
13646 is inside the modified region, but the first change is before
13647 current window start, we must select a new window start.
13649 However, if this is the result of a down-mouse event (e.g. by
13650 extending the mouse-drag-overlay), we don't want to select a
13651 new window start, since that would change the position under
13652 the mouse, resulting in an unwanted mouse-movement rather
13653 than a simple mouse-click. */
13654 if (NILP (w
->start_at_line_beg
)
13655 && NILP (do_mouse_tracking
)
13656 && CHARPOS (startp
) > BEGV
13657 && CHARPOS (startp
) > BEG
+ beg_unchanged
13658 && CHARPOS (startp
) <= Z
- end_unchanged
13659 /* Even if w->start_at_line_beg is nil, a new window may
13660 start at a line_beg, since that's how set_buffer_window
13661 sets it. So, we need to check the return value of
13662 compute_window_start_on_continuation_line. (See also
13664 && XMARKER (w
->start
)->buffer
== current_buffer
13665 && compute_window_start_on_continuation_line (w
))
13667 w
->force_start
= Qt
;
13668 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13673 debug_method_add (w
, "same window start");
13676 /* Try to redisplay starting at same place as before.
13677 If point has not moved off frame, accept the results. */
13678 if (!current_matrix_up_to_date_p
13679 /* Don't use try_window_reusing_current_matrix in this case
13680 because a window scroll function can have changed the
13682 || !NILP (Vwindow_scroll_functions
)
13683 || MINI_WINDOW_P (w
)
13684 || !(used_current_matrix_p
13685 = try_window_reusing_current_matrix (w
)))
13687 IF_DEBUG (debug_method_add (w
, "1"));
13688 if (try_window (window
, startp
, 1) < 0)
13689 /* -1 means we need to scroll.
13690 0 means we need new matrices, but fonts_changed_p
13691 is set in that case, so we will detect it below. */
13692 goto try_to_scroll
;
13695 if (fonts_changed_p
)
13696 goto need_larger_matrices
;
13698 if (w
->cursor
.vpos
>= 0)
13700 if (!just_this_one_p
13701 || current_buffer
->clip_changed
13702 || BEG_UNCHANGED
< CHARPOS (startp
))
13703 /* Forget any recorded base line for line number display. */
13704 w
->base_line_number
= Qnil
;
13706 if (!cursor_row_fully_visible_p (w
, 1, 0))
13708 clear_glyph_matrix (w
->desired_matrix
);
13709 last_line_misfit
= 1;
13711 /* Drop through and scroll. */
13716 clear_glyph_matrix (w
->desired_matrix
);
13721 w
->last_modified
= make_number (0);
13722 w
->last_overlay_modified
= make_number (0);
13724 /* Redisplay the mode line. Select the buffer properly for that. */
13725 if (!update_mode_line
)
13727 update_mode_line
= 1;
13728 w
->update_mode_line
= Qt
;
13731 /* Try to scroll by specified few lines. */
13732 if ((scroll_conservatively
13734 || temp_scroll_step
13735 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13736 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13737 && !current_buffer
->clip_changed
13738 && CHARPOS (startp
) >= BEGV
13739 && CHARPOS (startp
) <= ZV
)
13741 /* The function returns -1 if new fonts were loaded, 1 if
13742 successful, 0 if not successful. */
13743 int rc
= try_scrolling (window
, just_this_one_p
,
13744 scroll_conservatively
,
13746 temp_scroll_step
, last_line_misfit
);
13749 case SCROLLING_SUCCESS
:
13752 case SCROLLING_NEED_LARGER_MATRICES
:
13753 goto need_larger_matrices
;
13755 case SCROLLING_FAILED
:
13763 /* Finally, just choose place to start which centers point */
13766 if (centering_position
< 0)
13767 centering_position
= window_box_height (w
) / 2;
13770 debug_method_add (w
, "recenter");
13773 /* w->vscroll = 0; */
13775 /* Forget any previously recorded base line for line number display. */
13776 if (!buffer_unchanged_p
)
13777 w
->base_line_number
= Qnil
;
13779 /* Move backward half the height of the window. */
13780 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13781 it
.current_y
= it
.last_visible_y
;
13782 move_it_vertically_backward (&it
, centering_position
);
13783 xassert (IT_CHARPOS (it
) >= BEGV
);
13785 /* The function move_it_vertically_backward may move over more
13786 than the specified y-distance. If it->w is small, e.g. a
13787 mini-buffer window, we may end up in front of the window's
13788 display area. Start displaying at the start of the line
13789 containing PT in this case. */
13790 if (it
.current_y
<= 0)
13792 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13793 move_it_vertically_backward (&it
, 0);
13797 it
.current_x
= it
.hpos
= 0;
13799 /* Set startp here explicitly in case that helps avoid an infinite loop
13800 in case the window-scroll-functions functions get errors. */
13801 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13803 /* Run scroll hooks. */
13804 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13806 /* Redisplay the window. */
13807 if (!current_matrix_up_to_date_p
13808 || windows_or_buffers_changed
13809 || cursor_type_changed
13810 /* Don't use try_window_reusing_current_matrix in this case
13811 because it can have changed the buffer. */
13812 || !NILP (Vwindow_scroll_functions
)
13813 || !just_this_one_p
13814 || MINI_WINDOW_P (w
)
13815 || !(used_current_matrix_p
13816 = try_window_reusing_current_matrix (w
)))
13817 try_window (window
, startp
, 0);
13819 /* If new fonts have been loaded (due to fontsets), give up. We
13820 have to start a new redisplay since we need to re-adjust glyph
13822 if (fonts_changed_p
)
13823 goto need_larger_matrices
;
13825 /* If cursor did not appear assume that the middle of the window is
13826 in the first line of the window. Do it again with the next line.
13827 (Imagine a window of height 100, displaying two lines of height
13828 60. Moving back 50 from it->last_visible_y will end in the first
13830 if (w
->cursor
.vpos
< 0)
13832 if (!NILP (w
->window_end_valid
)
13833 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13835 clear_glyph_matrix (w
->desired_matrix
);
13836 move_it_by_lines (&it
, 1, 0);
13837 try_window (window
, it
.current
.pos
, 0);
13839 else if (PT
< IT_CHARPOS (it
))
13841 clear_glyph_matrix (w
->desired_matrix
);
13842 move_it_by_lines (&it
, -1, 0);
13843 try_window (window
, it
.current
.pos
, 0);
13847 /* Not much we can do about it. */
13851 /* Consider the following case: Window starts at BEGV, there is
13852 invisible, intangible text at BEGV, so that display starts at
13853 some point START > BEGV. It can happen that we are called with
13854 PT somewhere between BEGV and START. Try to handle that case. */
13855 if (w
->cursor
.vpos
< 0)
13857 struct glyph_row
*row
= w
->current_matrix
->rows
;
13858 if (row
->mode_line_p
)
13860 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13863 if (!cursor_row_fully_visible_p (w
, 0, 0))
13865 /* If vscroll is enabled, disable it and try again. */
13869 clear_glyph_matrix (w
->desired_matrix
);
13873 /* If centering point failed to make the whole line visible,
13874 put point at the top instead. That has to make the whole line
13875 visible, if it can be done. */
13876 if (centering_position
== 0)
13879 clear_glyph_matrix (w
->desired_matrix
);
13880 centering_position
= 0;
13886 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13887 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13888 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13891 /* Display the mode line, if we must. */
13892 if ((update_mode_line
13893 /* If window not full width, must redo its mode line
13894 if (a) the window to its side is being redone and
13895 (b) we do a frame-based redisplay. This is a consequence
13896 of how inverted lines are drawn in frame-based redisplay. */
13897 || (!just_this_one_p
13898 && !FRAME_WINDOW_P (f
)
13899 && !WINDOW_FULL_WIDTH_P (w
))
13900 /* Line number to display. */
13901 || INTEGERP (w
->base_line_pos
)
13902 /* Column number is displayed and different from the one displayed. */
13903 || (!NILP (w
->column_number_displayed
)
13904 && (XFASTINT (w
->column_number_displayed
)
13905 != (int) current_column ()))) /* iftc */
13906 /* This means that the window has a mode line. */
13907 && (WINDOW_WANTS_MODELINE_P (w
)
13908 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13910 display_mode_lines (w
);
13912 /* If mode line height has changed, arrange for a thorough
13913 immediate redisplay using the correct mode line height. */
13914 if (WINDOW_WANTS_MODELINE_P (w
)
13915 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13917 fonts_changed_p
= 1;
13918 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13919 = DESIRED_MODE_LINE_HEIGHT (w
);
13922 /* If top line height has changed, arrange for a thorough
13923 immediate redisplay using the correct mode line height. */
13924 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13925 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13927 fonts_changed_p
= 1;
13928 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13929 = DESIRED_HEADER_LINE_HEIGHT (w
);
13932 if (fonts_changed_p
)
13933 goto need_larger_matrices
;
13936 if (!line_number_displayed
13937 && !BUFFERP (w
->base_line_pos
))
13939 w
->base_line_pos
= Qnil
;
13940 w
->base_line_number
= Qnil
;
13945 /* When we reach a frame's selected window, redo the frame's menu bar. */
13946 if (update_mode_line
13947 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13949 int redisplay_menu_p
= 0;
13950 int redisplay_tool_bar_p
= 0;
13952 if (FRAME_WINDOW_P (f
))
13954 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13955 || defined (HAVE_NS) || defined (USE_GTK)
13956 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13958 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13962 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13964 if (redisplay_menu_p
)
13965 display_menu_bar (w
);
13967 #ifdef HAVE_WINDOW_SYSTEM
13968 if (FRAME_WINDOW_P (f
))
13970 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
13971 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13973 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13974 && (FRAME_TOOL_BAR_LINES (f
) > 0
13975 || !NILP (Vauto_resize_tool_bars
));
13978 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13980 extern int ignore_mouse_drag_p
;
13981 ignore_mouse_drag_p
= 1;
13987 #ifdef HAVE_WINDOW_SYSTEM
13988 if (FRAME_WINDOW_P (f
)
13989 && update_window_fringes (w
, (just_this_one_p
13990 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13991 || w
->pseudo_window_p
)))
13995 if (draw_window_fringes (w
, 1))
13996 x_draw_vertical_border (w
);
14000 #endif /* HAVE_WINDOW_SYSTEM */
14002 /* We go to this label, with fonts_changed_p nonzero,
14003 if it is necessary to try again using larger glyph matrices.
14004 We have to redeem the scroll bar even in this case,
14005 because the loop in redisplay_internal expects that. */
14006 need_larger_matrices
:
14008 finish_scroll_bars
:
14010 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14012 /* Set the thumb's position and size. */
14013 set_vertical_scroll_bar (w
);
14015 /* Note that we actually used the scroll bar attached to this
14016 window, so it shouldn't be deleted at the end of redisplay. */
14017 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14018 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14021 /* Restore current_buffer and value of point in it. */
14022 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14023 set_buffer_internal_1 (old
);
14024 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14025 shorter. This can be caused by log truncation in *Messages*. */
14026 if (CHARPOS (lpoint
) <= ZV
)
14027 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14029 unbind_to (count
, Qnil
);
14033 /* Build the complete desired matrix of WINDOW with a window start
14034 buffer position POS.
14036 Value is 1 if successful. It is zero if fonts were loaded during
14037 redisplay which makes re-adjusting glyph matrices necessary, and -1
14038 if point would appear in the scroll margins.
14039 (We check that only if CHECK_MARGINS is nonzero. */
14042 try_window (window
, pos
, check_margins
)
14043 Lisp_Object window
;
14044 struct text_pos pos
;
14047 struct window
*w
= XWINDOW (window
);
14049 struct glyph_row
*last_text_row
= NULL
;
14050 struct frame
*f
= XFRAME (w
->frame
);
14052 /* Make POS the new window start. */
14053 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14055 /* Mark cursor position as unknown. No overlay arrow seen. */
14056 w
->cursor
.vpos
= -1;
14057 overlay_arrow_seen
= 0;
14059 /* Initialize iterator and info to start at POS. */
14060 start_display (&it
, w
, pos
);
14062 /* Display all lines of W. */
14063 while (it
.current_y
< it
.last_visible_y
)
14065 if (display_line (&it
))
14066 last_text_row
= it
.glyph_row
- 1;
14067 if (fonts_changed_p
)
14071 /* Don't let the cursor end in the scroll margins. */
14073 && !MINI_WINDOW_P (w
))
14075 int this_scroll_margin
;
14077 if (scroll_margin
> 0)
14079 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14080 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14083 this_scroll_margin
= 0;
14085 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14086 && w
->cursor
.y
< this_scroll_margin
14087 && CHARPOS (pos
) > BEGV
14088 && IT_CHARPOS (it
) < ZV
)
14089 /* rms: considering make_cursor_line_fully_visible_p here
14090 seems to give wrong results. We don't want to recenter
14091 when the last line is partly visible, we want to allow
14092 that case to be handled in the usual way. */
14093 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14095 w
->cursor
.vpos
= -1;
14096 clear_glyph_matrix (w
->desired_matrix
);
14101 /* If bottom moved off end of frame, change mode line percentage. */
14102 if (XFASTINT (w
->window_end_pos
) <= 0
14103 && Z
!= IT_CHARPOS (it
))
14104 w
->update_mode_line
= Qt
;
14106 /* Set window_end_pos to the offset of the last character displayed
14107 on the window from the end of current_buffer. Set
14108 window_end_vpos to its row number. */
14111 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14112 w
->window_end_bytepos
14113 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14115 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14117 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14118 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14119 ->displays_text_p
);
14123 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14124 w
->window_end_pos
= make_number (Z
- ZV
);
14125 w
->window_end_vpos
= make_number (0);
14128 /* But that is not valid info until redisplay finishes. */
14129 w
->window_end_valid
= Qnil
;
14135 /************************************************************************
14136 Window redisplay reusing current matrix when buffer has not changed
14137 ************************************************************************/
14139 /* Try redisplay of window W showing an unchanged buffer with a
14140 different window start than the last time it was displayed by
14141 reusing its current matrix. Value is non-zero if successful.
14142 W->start is the new window start. */
14145 try_window_reusing_current_matrix (w
)
14148 struct frame
*f
= XFRAME (w
->frame
);
14149 struct glyph_row
*row
, *bottom_row
;
14152 struct text_pos start
, new_start
;
14153 int nrows_scrolled
, i
;
14154 struct glyph_row
*last_text_row
;
14155 struct glyph_row
*last_reused_text_row
;
14156 struct glyph_row
*start_row
;
14157 int start_vpos
, min_y
, max_y
;
14160 if (inhibit_try_window_reusing
)
14164 if (/* This function doesn't handle terminal frames. */
14165 !FRAME_WINDOW_P (f
)
14166 /* Don't try to reuse the display if windows have been split
14168 || windows_or_buffers_changed
14169 || cursor_type_changed
)
14172 /* Can't do this if region may have changed. */
14173 if ((!NILP (Vtransient_mark_mode
)
14174 && !NILP (current_buffer
->mark_active
))
14175 || !NILP (w
->region_showing
)
14176 || !NILP (Vshow_trailing_whitespace
))
14179 /* If top-line visibility has changed, give up. */
14180 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14181 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14184 /* Give up if old or new display is scrolled vertically. We could
14185 make this function handle this, but right now it doesn't. */
14186 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14187 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14190 /* The variable new_start now holds the new window start. The old
14191 start `start' can be determined from the current matrix. */
14192 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14193 start
= start_row
->start
.pos
;
14194 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14196 /* Clear the desired matrix for the display below. */
14197 clear_glyph_matrix (w
->desired_matrix
);
14199 if (CHARPOS (new_start
) <= CHARPOS (start
))
14203 /* Don't use this method if the display starts with an ellipsis
14204 displayed for invisible text. It's not easy to handle that case
14205 below, and it's certainly not worth the effort since this is
14206 not a frequent case. */
14207 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14210 IF_DEBUG (debug_method_add (w
, "twu1"));
14212 /* Display up to a row that can be reused. The variable
14213 last_text_row is set to the last row displayed that displays
14214 text. Note that it.vpos == 0 if or if not there is a
14215 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14216 start_display (&it
, w
, new_start
);
14217 first_row_y
= it
.current_y
;
14218 w
->cursor
.vpos
= -1;
14219 last_text_row
= last_reused_text_row
= NULL
;
14221 while (it
.current_y
< it
.last_visible_y
14222 && !fonts_changed_p
)
14224 /* If we have reached into the characters in the START row,
14225 that means the line boundaries have changed. So we
14226 can't start copying with the row START. Maybe it will
14227 work to start copying with the following row. */
14228 while (IT_CHARPOS (it
) > CHARPOS (start
))
14230 /* Advance to the next row as the "start". */
14232 start
= start_row
->start
.pos
;
14233 /* If there are no more rows to try, or just one, give up. */
14234 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14235 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14236 || CHARPOS (start
) == ZV
)
14238 clear_glyph_matrix (w
->desired_matrix
);
14242 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14244 /* If we have reached alignment,
14245 we can copy the rest of the rows. */
14246 if (IT_CHARPOS (it
) == CHARPOS (start
))
14249 if (display_line (&it
))
14250 last_text_row
= it
.glyph_row
- 1;
14253 /* A value of current_y < last_visible_y means that we stopped
14254 at the previous window start, which in turn means that we
14255 have at least one reusable row. */
14256 if (it
.current_y
< it
.last_visible_y
)
14258 /* IT.vpos always starts from 0; it counts text lines. */
14259 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14261 /* Find PT if not already found in the lines displayed. */
14262 if (w
->cursor
.vpos
< 0)
14264 int dy
= it
.current_y
- start_row
->y
;
14266 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14267 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14269 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14270 dy
, nrows_scrolled
);
14273 clear_glyph_matrix (w
->desired_matrix
);
14278 /* Scroll the display. Do it before the current matrix is
14279 changed. The problem here is that update has not yet
14280 run, i.e. part of the current matrix is not up to date.
14281 scroll_run_hook will clear the cursor, and use the
14282 current matrix to get the height of the row the cursor is
14284 run
.current_y
= start_row
->y
;
14285 run
.desired_y
= it
.current_y
;
14286 run
.height
= it
.last_visible_y
- it
.current_y
;
14288 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14291 FRAME_RIF (f
)->update_window_begin_hook (w
);
14292 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14293 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14294 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14298 /* Shift current matrix down by nrows_scrolled lines. */
14299 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14300 rotate_matrix (w
->current_matrix
,
14302 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14305 /* Disable lines that must be updated. */
14306 for (i
= 0; i
< nrows_scrolled
; ++i
)
14307 (start_row
+ i
)->enabled_p
= 0;
14309 /* Re-compute Y positions. */
14310 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14311 max_y
= it
.last_visible_y
;
14312 for (row
= start_row
+ nrows_scrolled
;
14316 row
->y
= it
.current_y
;
14317 row
->visible_height
= row
->height
;
14319 if (row
->y
< min_y
)
14320 row
->visible_height
-= min_y
- row
->y
;
14321 if (row
->y
+ row
->height
> max_y
)
14322 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14323 row
->redraw_fringe_bitmaps_p
= 1;
14325 it
.current_y
+= row
->height
;
14327 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14328 last_reused_text_row
= row
;
14329 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14333 /* Disable lines in the current matrix which are now
14334 below the window. */
14335 for (++row
; row
< bottom_row
; ++row
)
14336 row
->enabled_p
= row
->mode_line_p
= 0;
14339 /* Update window_end_pos etc.; last_reused_text_row is the last
14340 reused row from the current matrix containing text, if any.
14341 The value of last_text_row is the last displayed line
14342 containing text. */
14343 if (last_reused_text_row
)
14345 w
->window_end_bytepos
14346 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14348 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14350 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14351 w
->current_matrix
));
14353 else if (last_text_row
)
14355 w
->window_end_bytepos
14356 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14358 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14360 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14364 /* This window must be completely empty. */
14365 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14366 w
->window_end_pos
= make_number (Z
- ZV
);
14367 w
->window_end_vpos
= make_number (0);
14369 w
->window_end_valid
= Qnil
;
14371 /* Update hint: don't try scrolling again in update_window. */
14372 w
->desired_matrix
->no_scrolling_p
= 1;
14375 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14379 else if (CHARPOS (new_start
) > CHARPOS (start
))
14381 struct glyph_row
*pt_row
, *row
;
14382 struct glyph_row
*first_reusable_row
;
14383 struct glyph_row
*first_row_to_display
;
14385 int yb
= window_text_bottom_y (w
);
14387 /* Find the row starting at new_start, if there is one. Don't
14388 reuse a partially visible line at the end. */
14389 first_reusable_row
= start_row
;
14390 while (first_reusable_row
->enabled_p
14391 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14392 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14393 < CHARPOS (new_start
)))
14394 ++first_reusable_row
;
14396 /* Give up if there is no row to reuse. */
14397 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14398 || !first_reusable_row
->enabled_p
14399 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14400 != CHARPOS (new_start
)))
14403 /* We can reuse fully visible rows beginning with
14404 first_reusable_row to the end of the window. Set
14405 first_row_to_display to the first row that cannot be reused.
14406 Set pt_row to the row containing point, if there is any. */
14408 for (first_row_to_display
= first_reusable_row
;
14409 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14410 ++first_row_to_display
)
14412 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14413 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14414 pt_row
= first_row_to_display
;
14417 /* Start displaying at the start of first_row_to_display. */
14418 xassert (first_row_to_display
->y
< yb
);
14419 init_to_row_start (&it
, w
, first_row_to_display
);
14421 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14423 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14425 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14426 + WINDOW_HEADER_LINE_HEIGHT (w
));
14428 /* Display lines beginning with first_row_to_display in the
14429 desired matrix. Set last_text_row to the last row displayed
14430 that displays text. */
14431 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14432 if (pt_row
== NULL
)
14433 w
->cursor
.vpos
= -1;
14434 last_text_row
= NULL
;
14435 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14436 if (display_line (&it
))
14437 last_text_row
= it
.glyph_row
- 1;
14439 /* If point is in a reused row, adjust y and vpos of the cursor
14443 w
->cursor
.vpos
-= nrows_scrolled
;
14444 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14447 /* Give up if point isn't in a row displayed or reused. (This
14448 also handles the case where w->cursor.vpos < nrows_scrolled
14449 after the calls to display_line, which can happen with scroll
14450 margins. See bug#1295.) */
14451 if (w
->cursor
.vpos
< 0)
14453 clear_glyph_matrix (w
->desired_matrix
);
14457 /* Scroll the display. */
14458 run
.current_y
= first_reusable_row
->y
;
14459 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14460 run
.height
= it
.last_visible_y
- run
.current_y
;
14461 dy
= run
.current_y
- run
.desired_y
;
14466 FRAME_RIF (f
)->update_window_begin_hook (w
);
14467 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14468 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14469 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14473 /* Adjust Y positions of reused rows. */
14474 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14475 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14476 max_y
= it
.last_visible_y
;
14477 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14480 row
->visible_height
= row
->height
;
14481 if (row
->y
< min_y
)
14482 row
->visible_height
-= min_y
- row
->y
;
14483 if (row
->y
+ row
->height
> max_y
)
14484 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14485 row
->redraw_fringe_bitmaps_p
= 1;
14488 /* Scroll the current matrix. */
14489 xassert (nrows_scrolled
> 0);
14490 rotate_matrix (w
->current_matrix
,
14492 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14495 /* Disable rows not reused. */
14496 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14497 row
->enabled_p
= 0;
14499 /* Point may have moved to a different line, so we cannot assume that
14500 the previous cursor position is valid; locate the correct row. */
14503 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14504 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14508 w
->cursor
.y
= row
->y
;
14510 if (row
< bottom_row
)
14512 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14513 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14516 && (!BUFFERP (glyph
->object
)
14517 || glyph
->charpos
< PT
);
14521 w
->cursor
.x
+= glyph
->pixel_width
;
14526 /* Adjust window end. A null value of last_text_row means that
14527 the window end is in reused rows which in turn means that
14528 only its vpos can have changed. */
14531 w
->window_end_bytepos
14532 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14534 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14536 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14541 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14544 w
->window_end_valid
= Qnil
;
14545 w
->desired_matrix
->no_scrolling_p
= 1;
14548 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14558 /************************************************************************
14559 Window redisplay reusing current matrix when buffer has changed
14560 ************************************************************************/
14562 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14563 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14565 static struct glyph_row
*
14566 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14567 struct glyph_row
*));
14570 /* Return the last row in MATRIX displaying text. If row START is
14571 non-null, start searching with that row. IT gives the dimensions
14572 of the display. Value is null if matrix is empty; otherwise it is
14573 a pointer to the row found. */
14575 static struct glyph_row
*
14576 find_last_row_displaying_text (matrix
, it
, start
)
14577 struct glyph_matrix
*matrix
;
14579 struct glyph_row
*start
;
14581 struct glyph_row
*row
, *row_found
;
14583 /* Set row_found to the last row in IT->w's current matrix
14584 displaying text. The loop looks funny but think of partially
14587 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14588 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14590 xassert (row
->enabled_p
);
14592 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14601 /* Return the last row in the current matrix of W that is not affected
14602 by changes at the start of current_buffer that occurred since W's
14603 current matrix was built. Value is null if no such row exists.
14605 BEG_UNCHANGED us the number of characters unchanged at the start of
14606 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14607 first changed character in current_buffer. Characters at positions <
14608 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14609 when the current matrix was built. */
14611 static struct glyph_row
*
14612 find_last_unchanged_at_beg_row (w
)
14615 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14616 struct glyph_row
*row
;
14617 struct glyph_row
*row_found
= NULL
;
14618 int yb
= window_text_bottom_y (w
);
14620 /* Find the last row displaying unchanged text. */
14621 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14622 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14623 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14626 if (/* If row ends before first_changed_pos, it is unchanged,
14627 except in some case. */
14628 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14629 /* When row ends in ZV and we write at ZV it is not
14631 && !row
->ends_at_zv_p
14632 /* When first_changed_pos is the end of a continued line,
14633 row is not unchanged because it may be no longer
14635 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14636 && (row
->continued_p
14637 || row
->exact_window_width_line_p
)))
14640 /* Stop if last visible row. */
14641 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14649 /* Find the first glyph row in the current matrix of W that is not
14650 affected by changes at the end of current_buffer since the
14651 time W's current matrix was built.
14653 Return in *DELTA the number of chars by which buffer positions in
14654 unchanged text at the end of current_buffer must be adjusted.
14656 Return in *DELTA_BYTES the corresponding number of bytes.
14658 Value is null if no such row exists, i.e. all rows are affected by
14661 static struct glyph_row
*
14662 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14664 int *delta
, *delta_bytes
;
14666 struct glyph_row
*row
;
14667 struct glyph_row
*row_found
= NULL
;
14669 *delta
= *delta_bytes
= 0;
14671 /* Display must not have been paused, otherwise the current matrix
14672 is not up to date. */
14673 eassert (!NILP (w
->window_end_valid
));
14675 /* A value of window_end_pos >= END_UNCHANGED means that the window
14676 end is in the range of changed text. If so, there is no
14677 unchanged row at the end of W's current matrix. */
14678 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14681 /* Set row to the last row in W's current matrix displaying text. */
14682 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14684 /* If matrix is entirely empty, no unchanged row exists. */
14685 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14687 /* The value of row is the last glyph row in the matrix having a
14688 meaningful buffer position in it. The end position of row
14689 corresponds to window_end_pos. This allows us to translate
14690 buffer positions in the current matrix to current buffer
14691 positions for characters not in changed text. */
14692 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14693 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14694 int last_unchanged_pos
, last_unchanged_pos_old
;
14695 struct glyph_row
*first_text_row
14696 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14698 *delta
= Z
- Z_old
;
14699 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14701 /* Set last_unchanged_pos to the buffer position of the last
14702 character in the buffer that has not been changed. Z is the
14703 index + 1 of the last character in current_buffer, i.e. by
14704 subtracting END_UNCHANGED we get the index of the last
14705 unchanged character, and we have to add BEG to get its buffer
14707 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14708 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14710 /* Search backward from ROW for a row displaying a line that
14711 starts at a minimum position >= last_unchanged_pos_old. */
14712 for (; row
> first_text_row
; --row
)
14714 /* This used to abort, but it can happen.
14715 It is ok to just stop the search instead here. KFS. */
14716 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14719 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14724 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14730 /* Make sure that glyph rows in the current matrix of window W
14731 reference the same glyph memory as corresponding rows in the
14732 frame's frame matrix. This function is called after scrolling W's
14733 current matrix on a terminal frame in try_window_id and
14734 try_window_reusing_current_matrix. */
14737 sync_frame_with_window_matrix_rows (w
)
14740 struct frame
*f
= XFRAME (w
->frame
);
14741 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14743 /* Preconditions: W must be a leaf window and full-width. Its frame
14744 must have a frame matrix. */
14745 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14746 xassert (WINDOW_FULL_WIDTH_P (w
));
14747 xassert (!FRAME_WINDOW_P (f
));
14749 /* If W is a full-width window, glyph pointers in W's current matrix
14750 have, by definition, to be the same as glyph pointers in the
14751 corresponding frame matrix. Note that frame matrices have no
14752 marginal areas (see build_frame_matrix). */
14753 window_row
= w
->current_matrix
->rows
;
14754 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14755 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14756 while (window_row
< window_row_end
)
14758 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14759 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14761 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14762 frame_row
->glyphs
[TEXT_AREA
] = start
;
14763 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14764 frame_row
->glyphs
[LAST_AREA
] = end
;
14766 /* Disable frame rows whose corresponding window rows have
14767 been disabled in try_window_id. */
14768 if (!window_row
->enabled_p
)
14769 frame_row
->enabled_p
= 0;
14771 ++window_row
, ++frame_row
;
14776 /* Find the glyph row in window W containing CHARPOS. Consider all
14777 rows between START and END (not inclusive). END null means search
14778 all rows to the end of the display area of W. Value is the row
14779 containing CHARPOS or null. */
14782 row_containing_pos (w
, charpos
, start
, end
, dy
)
14785 struct glyph_row
*start
, *end
;
14788 struct glyph_row
*row
= start
;
14791 /* If we happen to start on a header-line, skip that. */
14792 if (row
->mode_line_p
)
14795 if ((end
&& row
>= end
) || !row
->enabled_p
)
14798 last_y
= window_text_bottom_y (w
) - dy
;
14802 /* Give up if we have gone too far. */
14803 if (end
&& row
>= end
)
14805 /* This formerly returned if they were equal.
14806 I think that both quantities are of a "last plus one" type;
14807 if so, when they are equal, the row is within the screen. -- rms. */
14808 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14811 /* If it is in this row, return this row. */
14812 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14813 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14814 /* The end position of a row equals the start
14815 position of the next row. If CHARPOS is there, we
14816 would rather display it in the next line, except
14817 when this line ends in ZV. */
14818 && !row
->ends_at_zv_p
14819 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14820 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14827 /* Try to redisplay window W by reusing its existing display. W's
14828 current matrix must be up to date when this function is called,
14829 i.e. window_end_valid must not be nil.
14833 1 if display has been updated
14834 0 if otherwise unsuccessful
14835 -1 if redisplay with same window start is known not to succeed
14837 The following steps are performed:
14839 1. Find the last row in the current matrix of W that is not
14840 affected by changes at the start of current_buffer. If no such row
14843 2. Find the first row in W's current matrix that is not affected by
14844 changes at the end of current_buffer. Maybe there is no such row.
14846 3. Display lines beginning with the row + 1 found in step 1 to the
14847 row found in step 2 or, if step 2 didn't find a row, to the end of
14850 4. If cursor is not known to appear on the window, give up.
14852 5. If display stopped at the row found in step 2, scroll the
14853 display and current matrix as needed.
14855 6. Maybe display some lines at the end of W, if we must. This can
14856 happen under various circumstances, like a partially visible line
14857 becoming fully visible, or because newly displayed lines are displayed
14858 in smaller font sizes.
14860 7. Update W's window end information. */
14866 struct frame
*f
= XFRAME (w
->frame
);
14867 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14868 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14869 struct glyph_row
*last_unchanged_at_beg_row
;
14870 struct glyph_row
*first_unchanged_at_end_row
;
14871 struct glyph_row
*row
;
14872 struct glyph_row
*bottom_row
;
14875 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14876 struct text_pos start_pos
;
14878 int first_unchanged_at_end_vpos
= 0;
14879 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14880 struct text_pos start
;
14881 int first_changed_charpos
, last_changed_charpos
;
14884 if (inhibit_try_window_id
)
14888 /* This is handy for debugging. */
14890 #define GIVE_UP(X) \
14892 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14896 #define GIVE_UP(X) return 0
14899 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14901 /* Don't use this for mini-windows because these can show
14902 messages and mini-buffers, and we don't handle that here. */
14903 if (MINI_WINDOW_P (w
))
14906 /* This flag is used to prevent redisplay optimizations. */
14907 if (windows_or_buffers_changed
|| cursor_type_changed
)
14910 /* Verify that narrowing has not changed.
14911 Also verify that we were not told to prevent redisplay optimizations.
14912 It would be nice to further
14913 reduce the number of cases where this prevents try_window_id. */
14914 if (current_buffer
->clip_changed
14915 || current_buffer
->prevent_redisplay_optimizations_p
)
14918 /* Window must either use window-based redisplay or be full width. */
14919 if (!FRAME_WINDOW_P (f
)
14920 && (!FRAME_LINE_INS_DEL_OK (f
)
14921 || !WINDOW_FULL_WIDTH_P (w
)))
14924 /* Give up if point is not known NOT to appear in W. */
14925 if (PT
< CHARPOS (start
))
14928 /* Another way to prevent redisplay optimizations. */
14929 if (XFASTINT (w
->last_modified
) == 0)
14932 /* Verify that window is not hscrolled. */
14933 if (XFASTINT (w
->hscroll
) != 0)
14936 /* Verify that display wasn't paused. */
14937 if (NILP (w
->window_end_valid
))
14940 /* Can't use this if highlighting a region because a cursor movement
14941 will do more than just set the cursor. */
14942 if (!NILP (Vtransient_mark_mode
)
14943 && !NILP (current_buffer
->mark_active
))
14946 /* Likewise if highlighting trailing whitespace. */
14947 if (!NILP (Vshow_trailing_whitespace
))
14950 /* Likewise if showing a region. */
14951 if (!NILP (w
->region_showing
))
14954 /* Can use this if overlay arrow position and or string have changed. */
14955 if (overlay_arrows_changed_p ())
14958 /* When word-wrap is on, adding a space to the first word of a
14959 wrapped line can change the wrap position, altering the line
14960 above it. It might be worthwhile to handle this more
14961 intelligently, but for now just redisplay from scratch. */
14962 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14965 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14966 only if buffer has really changed. The reason is that the gap is
14967 initially at Z for freshly visited files. The code below would
14968 set end_unchanged to 0 in that case. */
14969 if (MODIFF
> SAVE_MODIFF
14970 /* This seems to happen sometimes after saving a buffer. */
14971 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14973 if (GPT
- BEG
< BEG_UNCHANGED
)
14974 BEG_UNCHANGED
= GPT
- BEG
;
14975 if (Z
- GPT
< END_UNCHANGED
)
14976 END_UNCHANGED
= Z
- GPT
;
14979 /* The position of the first and last character that has been changed. */
14980 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14981 last_changed_charpos
= Z
- END_UNCHANGED
;
14983 /* If window starts after a line end, and the last change is in
14984 front of that newline, then changes don't affect the display.
14985 This case happens with stealth-fontification. Note that although
14986 the display is unchanged, glyph positions in the matrix have to
14987 be adjusted, of course. */
14988 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14989 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14990 && ((last_changed_charpos
< CHARPOS (start
)
14991 && CHARPOS (start
) == BEGV
)
14992 || (last_changed_charpos
< CHARPOS (start
) - 1
14993 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14995 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14996 struct glyph_row
*r0
;
14998 /* Compute how many chars/bytes have been added to or removed
14999 from the buffer. */
15000 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15001 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15003 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15005 /* Give up if PT is not in the window. Note that it already has
15006 been checked at the start of try_window_id that PT is not in
15007 front of the window start. */
15008 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15011 /* If window start is unchanged, we can reuse the whole matrix
15012 as is, after adjusting glyph positions. No need to compute
15013 the window end again, since its offset from Z hasn't changed. */
15014 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15015 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15016 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15017 /* PT must not be in a partially visible line. */
15018 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15019 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15021 /* Adjust positions in the glyph matrix. */
15022 if (delta
|| delta_bytes
)
15024 struct glyph_row
*r1
15025 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15026 increment_matrix_positions (w
->current_matrix
,
15027 MATRIX_ROW_VPOS (r0
, current_matrix
),
15028 MATRIX_ROW_VPOS (r1
, current_matrix
),
15029 delta
, delta_bytes
);
15032 /* Set the cursor. */
15033 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15035 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15042 /* Handle the case that changes are all below what is displayed in
15043 the window, and that PT is in the window. This shortcut cannot
15044 be taken if ZV is visible in the window, and text has been added
15045 there that is visible in the window. */
15046 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15047 /* ZV is not visible in the window, or there are no
15048 changes at ZV, actually. */
15049 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15050 || first_changed_charpos
== last_changed_charpos
))
15052 struct glyph_row
*r0
;
15054 /* Give up if PT is not in the window. Note that it already has
15055 been checked at the start of try_window_id that PT is not in
15056 front of the window start. */
15057 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15060 /* If window start is unchanged, we can reuse the whole matrix
15061 as is, without changing glyph positions since no text has
15062 been added/removed in front of the window end. */
15063 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15064 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15065 /* PT must not be in a partially visible line. */
15066 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15067 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15069 /* We have to compute the window end anew since text
15070 can have been added/removed after it. */
15072 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15073 w
->window_end_bytepos
15074 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15076 /* Set the cursor. */
15077 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15079 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15086 /* Give up if window start is in the changed area.
15088 The condition used to read
15090 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15092 but why that was tested escapes me at the moment. */
15093 if (CHARPOS (start
) >= first_changed_charpos
15094 && CHARPOS (start
) <= last_changed_charpos
)
15097 /* Check that window start agrees with the start of the first glyph
15098 row in its current matrix. Check this after we know the window
15099 start is not in changed text, otherwise positions would not be
15101 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15102 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15105 /* Give up if the window ends in strings. Overlay strings
15106 at the end are difficult to handle, so don't try. */
15107 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15108 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15111 /* Compute the position at which we have to start displaying new
15112 lines. Some of the lines at the top of the window might be
15113 reusable because they are not displaying changed text. Find the
15114 last row in W's current matrix not affected by changes at the
15115 start of current_buffer. Value is null if changes start in the
15116 first line of window. */
15117 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15118 if (last_unchanged_at_beg_row
)
15120 /* Avoid starting to display in the moddle of a character, a TAB
15121 for instance. This is easier than to set up the iterator
15122 exactly, and it's not a frequent case, so the additional
15123 effort wouldn't really pay off. */
15124 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15125 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15126 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15127 --last_unchanged_at_beg_row
;
15129 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15132 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15134 start_pos
= it
.current
.pos
;
15136 /* Start displaying new lines in the desired matrix at the same
15137 vpos we would use in the current matrix, i.e. below
15138 last_unchanged_at_beg_row. */
15139 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15141 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15142 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15144 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15148 /* There are no reusable lines at the start of the window.
15149 Start displaying in the first text line. */
15150 start_display (&it
, w
, start
);
15151 it
.vpos
= it
.first_vpos
;
15152 start_pos
= it
.current
.pos
;
15155 /* Find the first row that is not affected by changes at the end of
15156 the buffer. Value will be null if there is no unchanged row, in
15157 which case we must redisplay to the end of the window. delta
15158 will be set to the value by which buffer positions beginning with
15159 first_unchanged_at_end_row have to be adjusted due to text
15161 first_unchanged_at_end_row
15162 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15163 IF_DEBUG (debug_delta
= delta
);
15164 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15166 /* Set stop_pos to the buffer position up to which we will have to
15167 display new lines. If first_unchanged_at_end_row != NULL, this
15168 is the buffer position of the start of the line displayed in that
15169 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15170 that we don't stop at a buffer position. */
15172 if (first_unchanged_at_end_row
)
15174 xassert (last_unchanged_at_beg_row
== NULL
15175 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15177 /* If this is a continuation line, move forward to the next one
15178 that isn't. Changes in lines above affect this line.
15179 Caution: this may move first_unchanged_at_end_row to a row
15180 not displaying text. */
15181 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15182 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15183 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15184 < it
.last_visible_y
))
15185 ++first_unchanged_at_end_row
;
15187 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15188 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15189 >= it
.last_visible_y
))
15190 first_unchanged_at_end_row
= NULL
;
15193 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15195 first_unchanged_at_end_vpos
15196 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15197 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15200 else if (last_unchanged_at_beg_row
== NULL
)
15206 /* Either there is no unchanged row at the end, or the one we have
15207 now displays text. This is a necessary condition for the window
15208 end pos calculation at the end of this function. */
15209 xassert (first_unchanged_at_end_row
== NULL
15210 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15212 debug_last_unchanged_at_beg_vpos
15213 = (last_unchanged_at_beg_row
15214 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15216 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15218 #endif /* GLYPH_DEBUG != 0 */
15221 /* Display new lines. Set last_text_row to the last new line
15222 displayed which has text on it, i.e. might end up as being the
15223 line where the window_end_vpos is. */
15224 w
->cursor
.vpos
= -1;
15225 last_text_row
= NULL
;
15226 overlay_arrow_seen
= 0;
15227 while (it
.current_y
< it
.last_visible_y
15228 && !fonts_changed_p
15229 && (first_unchanged_at_end_row
== NULL
15230 || IT_CHARPOS (it
) < stop_pos
))
15232 if (display_line (&it
))
15233 last_text_row
= it
.glyph_row
- 1;
15236 if (fonts_changed_p
)
15240 /* Compute differences in buffer positions, y-positions etc. for
15241 lines reused at the bottom of the window. Compute what we can
15243 if (first_unchanged_at_end_row
15244 /* No lines reused because we displayed everything up to the
15245 bottom of the window. */
15246 && it
.current_y
< it
.last_visible_y
)
15249 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15251 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15252 run
.current_y
= first_unchanged_at_end_row
->y
;
15253 run
.desired_y
= run
.current_y
+ dy
;
15254 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15258 delta
= delta_bytes
= dvpos
= dy
15259 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15260 first_unchanged_at_end_row
= NULL
;
15262 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15265 /* Find the cursor if not already found. We have to decide whether
15266 PT will appear on this window (it sometimes doesn't, but this is
15267 not a very frequent case.) This decision has to be made before
15268 the current matrix is altered. A value of cursor.vpos < 0 means
15269 that PT is either in one of the lines beginning at
15270 first_unchanged_at_end_row or below the window. Don't care for
15271 lines that might be displayed later at the window end; as
15272 mentioned, this is not a frequent case. */
15273 if (w
->cursor
.vpos
< 0)
15275 /* Cursor in unchanged rows at the top? */
15276 if (PT
< CHARPOS (start_pos
)
15277 && last_unchanged_at_beg_row
)
15279 row
= row_containing_pos (w
, PT
,
15280 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15281 last_unchanged_at_beg_row
+ 1, 0);
15283 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15286 /* Start from first_unchanged_at_end_row looking for PT. */
15287 else if (first_unchanged_at_end_row
)
15289 row
= row_containing_pos (w
, PT
- delta
,
15290 first_unchanged_at_end_row
, NULL
, 0);
15292 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15293 delta_bytes
, dy
, dvpos
);
15296 /* Give up if cursor was not found. */
15297 if (w
->cursor
.vpos
< 0)
15299 clear_glyph_matrix (w
->desired_matrix
);
15304 /* Don't let the cursor end in the scroll margins. */
15306 int this_scroll_margin
, cursor_height
;
15308 this_scroll_margin
= max (0, scroll_margin
);
15309 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15310 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15311 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15313 if ((w
->cursor
.y
< this_scroll_margin
15314 && CHARPOS (start
) > BEGV
)
15315 /* Old redisplay didn't take scroll margin into account at the bottom,
15316 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15317 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15318 ? cursor_height
+ this_scroll_margin
15319 : 1)) > it
.last_visible_y
)
15321 w
->cursor
.vpos
= -1;
15322 clear_glyph_matrix (w
->desired_matrix
);
15327 /* Scroll the display. Do it before changing the current matrix so
15328 that xterm.c doesn't get confused about where the cursor glyph is
15330 if (dy
&& run
.height
)
15334 if (FRAME_WINDOW_P (f
))
15336 FRAME_RIF (f
)->update_window_begin_hook (w
);
15337 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15338 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15339 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15343 /* Terminal frame. In this case, dvpos gives the number of
15344 lines to scroll by; dvpos < 0 means scroll up. */
15345 int first_unchanged_at_end_vpos
15346 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15347 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15348 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15349 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15350 + window_internal_height (w
));
15352 /* Perform the operation on the screen. */
15355 /* Scroll last_unchanged_at_beg_row to the end of the
15356 window down dvpos lines. */
15357 set_terminal_window (f
, end
);
15359 /* On dumb terminals delete dvpos lines at the end
15360 before inserting dvpos empty lines. */
15361 if (!FRAME_SCROLL_REGION_OK (f
))
15362 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15364 /* Insert dvpos empty lines in front of
15365 last_unchanged_at_beg_row. */
15366 ins_del_lines (f
, from
, dvpos
);
15368 else if (dvpos
< 0)
15370 /* Scroll up last_unchanged_at_beg_vpos to the end of
15371 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15372 set_terminal_window (f
, end
);
15374 /* Delete dvpos lines in front of
15375 last_unchanged_at_beg_vpos. ins_del_lines will set
15376 the cursor to the given vpos and emit |dvpos| delete
15378 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15380 /* On a dumb terminal insert dvpos empty lines at the
15382 if (!FRAME_SCROLL_REGION_OK (f
))
15383 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15386 set_terminal_window (f
, 0);
15392 /* Shift reused rows of the current matrix to the right position.
15393 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15395 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15396 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15399 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15400 bottom_vpos
, dvpos
);
15401 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15404 else if (dvpos
> 0)
15406 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15407 bottom_vpos
, dvpos
);
15408 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15409 first_unchanged_at_end_vpos
+ dvpos
, 0);
15412 /* For frame-based redisplay, make sure that current frame and window
15413 matrix are in sync with respect to glyph memory. */
15414 if (!FRAME_WINDOW_P (f
))
15415 sync_frame_with_window_matrix_rows (w
);
15417 /* Adjust buffer positions in reused rows. */
15418 if (delta
|| delta_bytes
)
15419 increment_matrix_positions (current_matrix
,
15420 first_unchanged_at_end_vpos
+ dvpos
,
15421 bottom_vpos
, delta
, delta_bytes
);
15423 /* Adjust Y positions. */
15425 shift_glyph_matrix (w
, current_matrix
,
15426 first_unchanged_at_end_vpos
+ dvpos
,
15429 if (first_unchanged_at_end_row
)
15431 first_unchanged_at_end_row
+= dvpos
;
15432 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15433 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15434 first_unchanged_at_end_row
= NULL
;
15437 /* If scrolling up, there may be some lines to display at the end of
15439 last_text_row_at_end
= NULL
;
15442 /* Scrolling up can leave for example a partially visible line
15443 at the end of the window to be redisplayed. */
15444 /* Set last_row to the glyph row in the current matrix where the
15445 window end line is found. It has been moved up or down in
15446 the matrix by dvpos. */
15447 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15448 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15450 /* If last_row is the window end line, it should display text. */
15451 xassert (last_row
->displays_text_p
);
15453 /* If window end line was partially visible before, begin
15454 displaying at that line. Otherwise begin displaying with the
15455 line following it. */
15456 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15458 init_to_row_start (&it
, w
, last_row
);
15459 it
.vpos
= last_vpos
;
15460 it
.current_y
= last_row
->y
;
15464 init_to_row_end (&it
, w
, last_row
);
15465 it
.vpos
= 1 + last_vpos
;
15466 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15470 /* We may start in a continuation line. If so, we have to
15471 get the right continuation_lines_width and current_x. */
15472 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15473 it
.hpos
= it
.current_x
= 0;
15475 /* Display the rest of the lines at the window end. */
15476 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15477 while (it
.current_y
< it
.last_visible_y
15478 && !fonts_changed_p
)
15480 /* Is it always sure that the display agrees with lines in
15481 the current matrix? I don't think so, so we mark rows
15482 displayed invalid in the current matrix by setting their
15483 enabled_p flag to zero. */
15484 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15485 if (display_line (&it
))
15486 last_text_row_at_end
= it
.glyph_row
- 1;
15490 /* Update window_end_pos and window_end_vpos. */
15491 if (first_unchanged_at_end_row
15492 && !last_text_row_at_end
)
15494 /* Window end line if one of the preserved rows from the current
15495 matrix. Set row to the last row displaying text in current
15496 matrix starting at first_unchanged_at_end_row, after
15498 xassert (first_unchanged_at_end_row
->displays_text_p
);
15499 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15500 first_unchanged_at_end_row
);
15501 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15503 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15504 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15506 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15507 xassert (w
->window_end_bytepos
>= 0);
15508 IF_DEBUG (debug_method_add (w
, "A"));
15510 else if (last_text_row_at_end
)
15513 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15514 w
->window_end_bytepos
15515 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15517 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15518 xassert (w
->window_end_bytepos
>= 0);
15519 IF_DEBUG (debug_method_add (w
, "B"));
15521 else if (last_text_row
)
15523 /* We have displayed either to the end of the window or at the
15524 end of the window, i.e. the last row with text is to be found
15525 in the desired matrix. */
15527 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15528 w
->window_end_bytepos
15529 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15531 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15532 xassert (w
->window_end_bytepos
>= 0);
15534 else if (first_unchanged_at_end_row
== NULL
15535 && last_text_row
== NULL
15536 && last_text_row_at_end
== NULL
)
15538 /* Displayed to end of window, but no line containing text was
15539 displayed. Lines were deleted at the end of the window. */
15540 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15541 int vpos
= XFASTINT (w
->window_end_vpos
);
15542 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15543 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15546 row
== NULL
&& vpos
>= first_vpos
;
15547 --vpos
, --current_row
, --desired_row
)
15549 if (desired_row
->enabled_p
)
15551 if (desired_row
->displays_text_p
)
15554 else if (current_row
->displays_text_p
)
15558 xassert (row
!= NULL
);
15559 w
->window_end_vpos
= make_number (vpos
+ 1);
15560 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15561 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15562 xassert (w
->window_end_bytepos
>= 0);
15563 IF_DEBUG (debug_method_add (w
, "C"));
15568 #if 0 /* This leads to problems, for instance when the cursor is
15569 at ZV, and the cursor line displays no text. */
15570 /* Disable rows below what's displayed in the window. This makes
15571 debugging easier. */
15572 enable_glyph_matrix_rows (current_matrix
,
15573 XFASTINT (w
->window_end_vpos
) + 1,
15577 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15578 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15580 /* Record that display has not been completed. */
15581 w
->window_end_valid
= Qnil
;
15582 w
->desired_matrix
->no_scrolling_p
= 1;
15590 /***********************************************************************
15591 More debugging support
15592 ***********************************************************************/
15596 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15597 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15598 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15601 /* Dump the contents of glyph matrix MATRIX on stderr.
15603 GLYPHS 0 means don't show glyph contents.
15604 GLYPHS 1 means show glyphs in short form
15605 GLYPHS > 1 means show glyphs in long form. */
15608 dump_glyph_matrix (matrix
, glyphs
)
15609 struct glyph_matrix
*matrix
;
15613 for (i
= 0; i
< matrix
->nrows
; ++i
)
15614 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15618 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15619 the glyph row and area where the glyph comes from. */
15622 dump_glyph (row
, glyph
, area
)
15623 struct glyph_row
*row
;
15624 struct glyph
*glyph
;
15627 if (glyph
->type
== CHAR_GLYPH
)
15630 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15631 glyph
- row
->glyphs
[TEXT_AREA
],
15634 (BUFFERP (glyph
->object
)
15636 : (STRINGP (glyph
->object
)
15639 glyph
->pixel_width
,
15641 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15645 glyph
->left_box_line_p
,
15646 glyph
->right_box_line_p
);
15648 else if (glyph
->type
== STRETCH_GLYPH
)
15651 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15652 glyph
- row
->glyphs
[TEXT_AREA
],
15655 (BUFFERP (glyph
->object
)
15657 : (STRINGP (glyph
->object
)
15660 glyph
->pixel_width
,
15664 glyph
->left_box_line_p
,
15665 glyph
->right_box_line_p
);
15667 else if (glyph
->type
== IMAGE_GLYPH
)
15670 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15671 glyph
- row
->glyphs
[TEXT_AREA
],
15674 (BUFFERP (glyph
->object
)
15676 : (STRINGP (glyph
->object
)
15679 glyph
->pixel_width
,
15683 glyph
->left_box_line_p
,
15684 glyph
->right_box_line_p
);
15686 else if (glyph
->type
== COMPOSITE_GLYPH
)
15689 " %5d %4c %6d %c %3d 0x%05x",
15690 glyph
- row
->glyphs
[TEXT_AREA
],
15693 (BUFFERP (glyph
->object
)
15695 : (STRINGP (glyph
->object
)
15698 glyph
->pixel_width
,
15700 if (glyph
->u
.cmp
.automatic
)
15703 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
15704 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
15706 glyph
->left_box_line_p
,
15707 glyph
->right_box_line_p
);
15712 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15713 GLYPHS 0 means don't show glyph contents.
15714 GLYPHS 1 means show glyphs in short form
15715 GLYPHS > 1 means show glyphs in long form. */
15718 dump_glyph_row (row
, vpos
, glyphs
)
15719 struct glyph_row
*row
;
15724 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15725 fprintf (stderr
, "======================================================================\n");
15727 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15728 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15730 MATRIX_ROW_START_CHARPOS (row
),
15731 MATRIX_ROW_END_CHARPOS (row
),
15732 row
->used
[TEXT_AREA
],
15733 row
->contains_overlapping_glyphs_p
,
15735 row
->truncated_on_left_p
,
15736 row
->truncated_on_right_p
,
15738 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15739 row
->displays_text_p
,
15742 row
->ends_in_middle_of_char_p
,
15743 row
->starts_in_middle_of_char_p
,
15749 row
->visible_height
,
15752 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15753 row
->end
.overlay_string_index
,
15754 row
->continuation_lines_width
);
15755 fprintf (stderr
, "%9d %5d\n",
15756 CHARPOS (row
->start
.string_pos
),
15757 CHARPOS (row
->end
.string_pos
));
15758 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15759 row
->end
.dpvec_index
);
15766 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15768 struct glyph
*glyph
= row
->glyphs
[area
];
15769 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15771 /* Glyph for a line end in text. */
15772 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15775 if (glyph
< glyph_end
)
15776 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15778 for (; glyph
< glyph_end
; ++glyph
)
15779 dump_glyph (row
, glyph
, area
);
15782 else if (glyphs
== 1)
15786 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15788 char *s
= (char *) alloca (row
->used
[area
] + 1);
15791 for (i
= 0; i
< row
->used
[area
]; ++i
)
15793 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15794 if (glyph
->type
== CHAR_GLYPH
15795 && glyph
->u
.ch
< 0x80
15796 && glyph
->u
.ch
>= ' ')
15797 s
[i
] = glyph
->u
.ch
;
15803 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15809 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15810 Sdump_glyph_matrix
, 0, 1, "p",
15811 doc
: /* Dump the current matrix of the selected window to stderr.
15812 Shows contents of glyph row structures. With non-nil
15813 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15814 glyphs in short form, otherwise show glyphs in long form. */)
15816 Lisp_Object glyphs
;
15818 struct window
*w
= XWINDOW (selected_window
);
15819 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15821 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15822 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15823 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15824 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15825 fprintf (stderr
, "=============================================\n");
15826 dump_glyph_matrix (w
->current_matrix
,
15827 NILP (glyphs
) ? 0 : XINT (glyphs
));
15832 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15833 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15836 struct frame
*f
= XFRAME (selected_frame
);
15837 dump_glyph_matrix (f
->current_matrix
, 1);
15842 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15843 doc
: /* Dump glyph row ROW to stderr.
15844 GLYPH 0 means don't dump glyphs.
15845 GLYPH 1 means dump glyphs in short form.
15846 GLYPH > 1 or omitted means dump glyphs in long form. */)
15848 Lisp_Object row
, glyphs
;
15850 struct glyph_matrix
*matrix
;
15853 CHECK_NUMBER (row
);
15854 matrix
= XWINDOW (selected_window
)->current_matrix
;
15856 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15857 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15859 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15864 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15865 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15866 GLYPH 0 means don't dump glyphs.
15867 GLYPH 1 means dump glyphs in short form.
15868 GLYPH > 1 or omitted means dump glyphs in long form. */)
15870 Lisp_Object row
, glyphs
;
15872 struct frame
*sf
= SELECTED_FRAME ();
15873 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15876 CHECK_NUMBER (row
);
15878 if (vpos
>= 0 && vpos
< m
->nrows
)
15879 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15880 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15885 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15886 doc
: /* Toggle tracing of redisplay.
15887 With ARG, turn tracing on if and only if ARG is positive. */)
15892 trace_redisplay_p
= !trace_redisplay_p
;
15895 arg
= Fprefix_numeric_value (arg
);
15896 trace_redisplay_p
= XINT (arg
) > 0;
15903 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15904 doc
: /* Like `format', but print result to stderr.
15905 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15910 Lisp_Object s
= Fformat (nargs
, args
);
15911 fprintf (stderr
, "%s", SDATA (s
));
15915 #endif /* GLYPH_DEBUG */
15919 /***********************************************************************
15920 Building Desired Matrix Rows
15921 ***********************************************************************/
15923 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15924 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15926 static struct glyph_row
*
15927 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15929 Lisp_Object overlay_arrow_string
;
15931 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15932 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15933 struct buffer
*old
= current_buffer
;
15934 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15935 int arrow_len
= SCHARS (overlay_arrow_string
);
15936 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15937 const unsigned char *p
;
15940 int n_glyphs_before
;
15942 set_buffer_temp (buffer
);
15943 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15944 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15945 SET_TEXT_POS (it
.position
, 0, 0);
15947 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15949 while (p
< arrow_end
)
15951 Lisp_Object face
, ilisp
;
15953 /* Get the next character. */
15955 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15957 it
.c
= *p
, it
.len
= 1;
15960 /* Get its face. */
15961 ilisp
= make_number (p
- arrow_string
);
15962 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15963 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15965 /* Compute its width, get its glyphs. */
15966 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15967 SET_TEXT_POS (it
.position
, -1, -1);
15968 PRODUCE_GLYPHS (&it
);
15970 /* If this character doesn't fit any more in the line, we have
15971 to remove some glyphs. */
15972 if (it
.current_x
> it
.last_visible_x
)
15974 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15979 set_buffer_temp (old
);
15980 return it
.glyph_row
;
15984 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15985 glyphs are only inserted for terminal frames since we can't really
15986 win with truncation glyphs when partially visible glyphs are
15987 involved. Which glyphs to insert is determined by
15988 produce_special_glyphs. */
15991 insert_left_trunc_glyphs (it
)
15994 struct it truncate_it
;
15995 struct glyph
*from
, *end
, *to
, *toend
;
15997 xassert (!FRAME_WINDOW_P (it
->f
));
15999 /* Get the truncation glyphs. */
16001 truncate_it
.current_x
= 0;
16002 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16003 truncate_it
.glyph_row
= &scratch_glyph_row
;
16004 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16005 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16006 truncate_it
.object
= make_number (0);
16007 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16009 /* Overwrite glyphs from IT with truncation glyphs. */
16010 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16011 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16012 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16013 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16018 /* There may be padding glyphs left over. Overwrite them too. */
16019 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16021 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16027 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16031 /* Compute the pixel height and width of IT->glyph_row.
16033 Most of the time, ascent and height of a display line will be equal
16034 to the max_ascent and max_height values of the display iterator
16035 structure. This is not the case if
16037 1. We hit ZV without displaying anything. In this case, max_ascent
16038 and max_height will be zero.
16040 2. We have some glyphs that don't contribute to the line height.
16041 (The glyph row flag contributes_to_line_height_p is for future
16042 pixmap extensions).
16044 The first case is easily covered by using default values because in
16045 these cases, the line height does not really matter, except that it
16046 must not be zero. */
16049 compute_line_metrics (it
)
16052 struct glyph_row
*row
= it
->glyph_row
;
16055 if (FRAME_WINDOW_P (it
->f
))
16057 int i
, min_y
, max_y
;
16059 /* The line may consist of one space only, that was added to
16060 place the cursor on it. If so, the row's height hasn't been
16062 if (row
->height
== 0)
16064 if (it
->max_ascent
+ it
->max_descent
== 0)
16065 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16066 row
->ascent
= it
->max_ascent
;
16067 row
->height
= it
->max_ascent
+ it
->max_descent
;
16068 row
->phys_ascent
= it
->max_phys_ascent
;
16069 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16070 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16073 /* Compute the width of this line. */
16074 row
->pixel_width
= row
->x
;
16075 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16076 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16078 xassert (row
->pixel_width
>= 0);
16079 xassert (row
->ascent
>= 0 && row
->height
> 0);
16081 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16082 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16084 /* If first line's physical ascent is larger than its logical
16085 ascent, use the physical ascent, and make the row taller.
16086 This makes accented characters fully visible. */
16087 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16088 && row
->phys_ascent
> row
->ascent
)
16090 row
->height
+= row
->phys_ascent
- row
->ascent
;
16091 row
->ascent
= row
->phys_ascent
;
16094 /* Compute how much of the line is visible. */
16095 row
->visible_height
= row
->height
;
16097 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16098 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16100 if (row
->y
< min_y
)
16101 row
->visible_height
-= min_y
- row
->y
;
16102 if (row
->y
+ row
->height
> max_y
)
16103 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16107 row
->pixel_width
= row
->used
[TEXT_AREA
];
16108 if (row
->continued_p
)
16109 row
->pixel_width
-= it
->continuation_pixel_width
;
16110 else if (row
->truncated_on_right_p
)
16111 row
->pixel_width
-= it
->truncation_pixel_width
;
16112 row
->ascent
= row
->phys_ascent
= 0;
16113 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16114 row
->extra_line_spacing
= 0;
16117 /* Compute a hash code for this row. */
16119 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16120 for (i
= 0; i
< row
->used
[area
]; ++i
)
16121 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16122 + row
->glyphs
[area
][i
].u
.val
16123 + row
->glyphs
[area
][i
].face_id
16124 + row
->glyphs
[area
][i
].padding_p
16125 + (row
->glyphs
[area
][i
].type
<< 2));
16127 it
->max_ascent
= it
->max_descent
= 0;
16128 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16132 /* Append one space to the glyph row of iterator IT if doing a
16133 window-based redisplay. The space has the same face as
16134 IT->face_id. Value is non-zero if a space was added.
16136 This function is called to make sure that there is always one glyph
16137 at the end of a glyph row that the cursor can be set on under
16138 window-systems. (If there weren't such a glyph we would not know
16139 how wide and tall a box cursor should be displayed).
16141 At the same time this space let's a nicely handle clearing to the
16142 end of the line if the row ends in italic text. */
16145 append_space_for_newline (it
, default_face_p
)
16147 int default_face_p
;
16149 if (FRAME_WINDOW_P (it
->f
))
16151 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16153 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16154 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16156 /* Save some values that must not be changed.
16157 Must save IT->c and IT->len because otherwise
16158 ITERATOR_AT_END_P wouldn't work anymore after
16159 append_space_for_newline has been called. */
16160 enum display_element_type saved_what
= it
->what
;
16161 int saved_c
= it
->c
, saved_len
= it
->len
;
16162 int saved_x
= it
->current_x
;
16163 int saved_face_id
= it
->face_id
;
16164 struct text_pos saved_pos
;
16165 Lisp_Object saved_object
;
16168 saved_object
= it
->object
;
16169 saved_pos
= it
->position
;
16171 it
->what
= IT_CHARACTER
;
16172 bzero (&it
->position
, sizeof it
->position
);
16173 it
->object
= make_number (0);
16177 if (default_face_p
)
16178 it
->face_id
= DEFAULT_FACE_ID
;
16179 else if (it
->face_before_selective_p
)
16180 it
->face_id
= it
->saved_face_id
;
16181 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16182 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16184 PRODUCE_GLYPHS (it
);
16186 it
->override_ascent
= -1;
16187 it
->constrain_row_ascent_descent_p
= 0;
16188 it
->current_x
= saved_x
;
16189 it
->object
= saved_object
;
16190 it
->position
= saved_pos
;
16191 it
->what
= saved_what
;
16192 it
->face_id
= saved_face_id
;
16193 it
->len
= saved_len
;
16203 /* Extend the face of the last glyph in the text area of IT->glyph_row
16204 to the end of the display line. Called from display_line.
16205 If the glyph row is empty, add a space glyph to it so that we
16206 know the face to draw. Set the glyph row flag fill_line_p. */
16209 extend_face_to_end_of_line (it
)
16213 struct frame
*f
= it
->f
;
16215 /* If line is already filled, do nothing. */
16216 if (it
->current_x
>= it
->last_visible_x
)
16219 /* Face extension extends the background and box of IT->face_id
16220 to the end of the line. If the background equals the background
16221 of the frame, we don't have to do anything. */
16222 if (it
->face_before_selective_p
)
16223 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16225 face
= FACE_FROM_ID (f
, it
->face_id
);
16227 if (FRAME_WINDOW_P (f
)
16228 && it
->glyph_row
->displays_text_p
16229 && face
->box
== FACE_NO_BOX
16230 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16234 /* Set the glyph row flag indicating that the face of the last glyph
16235 in the text area has to be drawn to the end of the text area. */
16236 it
->glyph_row
->fill_line_p
= 1;
16238 /* If current character of IT is not ASCII, make sure we have the
16239 ASCII face. This will be automatically undone the next time
16240 get_next_display_element returns a multibyte character. Note
16241 that the character will always be single byte in unibyte text. */
16242 if (!ASCII_CHAR_P (it
->c
))
16244 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16247 if (FRAME_WINDOW_P (f
))
16249 /* If the row is empty, add a space with the current face of IT,
16250 so that we know which face to draw. */
16251 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16253 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16254 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16255 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16260 /* Save some values that must not be changed. */
16261 int saved_x
= it
->current_x
;
16262 struct text_pos saved_pos
;
16263 Lisp_Object saved_object
;
16264 enum display_element_type saved_what
= it
->what
;
16265 int saved_face_id
= it
->face_id
;
16267 saved_object
= it
->object
;
16268 saved_pos
= it
->position
;
16270 it
->what
= IT_CHARACTER
;
16271 bzero (&it
->position
, sizeof it
->position
);
16272 it
->object
= make_number (0);
16275 it
->face_id
= face
->id
;
16277 PRODUCE_GLYPHS (it
);
16279 while (it
->current_x
<= it
->last_visible_x
)
16280 PRODUCE_GLYPHS (it
);
16282 /* Don't count these blanks really. It would let us insert a left
16283 truncation glyph below and make us set the cursor on them, maybe. */
16284 it
->current_x
= saved_x
;
16285 it
->object
= saved_object
;
16286 it
->position
= saved_pos
;
16287 it
->what
= saved_what
;
16288 it
->face_id
= saved_face_id
;
16293 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16294 trailing whitespace. */
16297 trailing_whitespace_p (charpos
)
16300 int bytepos
= CHAR_TO_BYTE (charpos
);
16303 while (bytepos
< ZV_BYTE
16304 && (c
= FETCH_CHAR (bytepos
),
16305 c
== ' ' || c
== '\t'))
16308 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16310 if (bytepos
!= PT_BYTE
)
16317 /* Highlight trailing whitespace, if any, in ROW. */
16320 highlight_trailing_whitespace (f
, row
)
16322 struct glyph_row
*row
;
16324 int used
= row
->used
[TEXT_AREA
];
16328 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16329 struct glyph
*glyph
= start
+ used
- 1;
16331 /* Skip over glyphs inserted to display the cursor at the
16332 end of a line, for extending the face of the last glyph
16333 to the end of the line on terminals, and for truncation
16334 and continuation glyphs. */
16335 while (glyph
>= start
16336 && glyph
->type
== CHAR_GLYPH
16337 && INTEGERP (glyph
->object
))
16340 /* If last glyph is a space or stretch, and it's trailing
16341 whitespace, set the face of all trailing whitespace glyphs in
16342 IT->glyph_row to `trailing-whitespace'. */
16344 && BUFFERP (glyph
->object
)
16345 && (glyph
->type
== STRETCH_GLYPH
16346 || (glyph
->type
== CHAR_GLYPH
16347 && glyph
->u
.ch
== ' '))
16348 && trailing_whitespace_p (glyph
->charpos
))
16350 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16354 while (glyph
>= start
16355 && BUFFERP (glyph
->object
)
16356 && (glyph
->type
== STRETCH_GLYPH
16357 || (glyph
->type
== CHAR_GLYPH
16358 && glyph
->u
.ch
== ' ')))
16359 (glyph
--)->face_id
= face_id
;
16365 /* Value is non-zero if glyph row ROW in window W should be
16366 used to hold the cursor. */
16369 cursor_row_p (w
, row
)
16371 struct glyph_row
*row
;
16373 int cursor_row_p
= 1;
16375 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16377 /* Suppose the row ends on a string.
16378 Unless the row is continued, that means it ends on a newline
16379 in the string. If it's anything other than a display string
16380 (e.g. a before-string from an overlay), we don't want the
16381 cursor there. (This heuristic seems to give the optimal
16382 behavior for the various types of multi-line strings.) */
16383 if (CHARPOS (row
->end
.string_pos
) >= 0)
16385 if (row
->continued_p
)
16389 /* Check for `display' property. */
16390 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16391 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16392 struct glyph
*glyph
;
16395 for (glyph
= end
; glyph
>= beg
; --glyph
)
16396 if (STRINGP (glyph
->object
))
16399 = Fget_char_property (make_number (PT
),
16403 && display_prop_string_p (prop
, glyph
->object
));
16408 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16410 /* If the row ends in middle of a real character,
16411 and the line is continued, we want the cursor here.
16412 That's because MATRIX_ROW_END_CHARPOS would equal
16413 PT if PT is before the character. */
16414 if (!row
->ends_in_ellipsis_p
)
16415 cursor_row_p
= row
->continued_p
;
16417 /* If the row ends in an ellipsis, then
16418 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16419 We want that position to be displayed after the ellipsis. */
16422 /* If the row ends at ZV, display the cursor at the end of that
16423 row instead of at the start of the row below. */
16424 else if (row
->ends_at_zv_p
)
16430 return cursor_row_p
;
16435 /* Push the display property PROP so that it will be rendered at the
16436 current position in IT. */
16439 push_display_prop (struct it
*it
, Lisp_Object prop
)
16443 /* Never display a cursor on the prefix. */
16444 it
->avoid_cursor_p
= 1;
16446 if (STRINGP (prop
))
16448 if (SCHARS (prop
) == 0)
16455 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16456 it
->current
.overlay_string_index
= -1;
16457 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16458 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16459 it
->method
= GET_FROM_STRING
;
16460 it
->stop_charpos
= 0;
16462 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16464 it
->method
= GET_FROM_STRETCH
;
16467 #ifdef HAVE_WINDOW_SYSTEM
16468 else if (IMAGEP (prop
))
16470 it
->what
= IT_IMAGE
;
16471 it
->image_id
= lookup_image (it
->f
, prop
);
16472 it
->method
= GET_FROM_IMAGE
;
16474 #endif /* HAVE_WINDOW_SYSTEM */
16477 pop_it (it
); /* bogus display property, give up */
16482 /* Return the character-property PROP at the current position in IT. */
16485 get_it_property (it
, prop
)
16489 Lisp_Object position
;
16491 if (STRINGP (it
->object
))
16492 position
= make_number (IT_STRING_CHARPOS (*it
));
16493 else if (BUFFERP (it
->object
))
16494 position
= make_number (IT_CHARPOS (*it
));
16498 return Fget_char_property (position
, prop
, it
->object
);
16501 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16504 handle_line_prefix (struct it
*it
)
16506 Lisp_Object prefix
;
16507 if (it
->continuation_lines_width
> 0)
16509 prefix
= get_it_property (it
, Qwrap_prefix
);
16511 prefix
= Vwrap_prefix
;
16515 prefix
= get_it_property (it
, Qline_prefix
);
16517 prefix
= Vline_prefix
;
16519 if (! NILP (prefix
))
16521 push_display_prop (it
, prefix
);
16522 /* If the prefix is wider than the window, and we try to wrap
16523 it, it would acquire its own wrap prefix, and so on till the
16524 iterator stack overflows. So, don't wrap the prefix. */
16525 it
->line_wrap
= TRUNCATE
;
16531 /* Construct the glyph row IT->glyph_row in the desired matrix of
16532 IT->w from text at the current position of IT. See dispextern.h
16533 for an overview of struct it. Value is non-zero if
16534 IT->glyph_row displays text, as opposed to a line displaying ZV
16541 struct glyph_row
*row
= it
->glyph_row
;
16542 Lisp_Object overlay_arrow_string
;
16544 int may_wrap
= 0, wrap_x
;
16545 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16546 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16547 int wrap_row_extra_line_spacing
;
16549 /* We always start displaying at hpos zero even if hscrolled. */
16550 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16552 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16553 >= it
->w
->desired_matrix
->nrows
)
16555 it
->w
->nrows_scale_factor
++;
16556 fonts_changed_p
= 1;
16560 /* Is IT->w showing the region? */
16561 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16563 /* Clear the result glyph row and enable it. */
16564 prepare_desired_row (row
);
16566 row
->y
= it
->current_y
;
16567 row
->start
= it
->start
;
16568 row
->continuation_lines_width
= it
->continuation_lines_width
;
16569 row
->displays_text_p
= 1;
16570 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16571 it
->starts_in_middle_of_char_p
= 0;
16573 /* Arrange the overlays nicely for our purposes. Usually, we call
16574 display_line on only one line at a time, in which case this
16575 can't really hurt too much, or we call it on lines which appear
16576 one after another in the buffer, in which case all calls to
16577 recenter_overlay_lists but the first will be pretty cheap. */
16578 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16580 /* Move over display elements that are not visible because we are
16581 hscrolled. This may stop at an x-position < IT->first_visible_x
16582 if the first glyph is partially visible or if we hit a line end. */
16583 if (it
->current_x
< it
->first_visible_x
)
16585 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16586 MOVE_TO_POS
| MOVE_TO_X
);
16590 /* We only do this when not calling `move_it_in_display_line_to'
16591 above, because move_it_in_display_line_to calls
16592 handle_line_prefix itself. */
16593 handle_line_prefix (it
);
16596 /* Get the initial row height. This is either the height of the
16597 text hscrolled, if there is any, or zero. */
16598 row
->ascent
= it
->max_ascent
;
16599 row
->height
= it
->max_ascent
+ it
->max_descent
;
16600 row
->phys_ascent
= it
->max_phys_ascent
;
16601 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16602 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16604 /* Loop generating characters. The loop is left with IT on the next
16605 character to display. */
16608 int n_glyphs_before
, hpos_before
, x_before
;
16610 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16612 /* Retrieve the next thing to display. Value is zero if end of
16614 if (!get_next_display_element (it
))
16616 /* Maybe add a space at the end of this line that is used to
16617 display the cursor there under X. Set the charpos of the
16618 first glyph of blank lines not corresponding to any text
16620 #ifdef HAVE_WINDOW_SYSTEM
16621 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16622 row
->exact_window_width_line_p
= 1;
16624 #endif /* HAVE_WINDOW_SYSTEM */
16625 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16626 || row
->used
[TEXT_AREA
] == 0)
16628 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16629 row
->displays_text_p
= 0;
16631 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16632 && (!MINI_WINDOW_P (it
->w
)
16633 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16634 row
->indicate_empty_line_p
= 1;
16637 it
->continuation_lines_width
= 0;
16638 row
->ends_at_zv_p
= 1;
16642 /* Now, get the metrics of what we want to display. This also
16643 generates glyphs in `row' (which is IT->glyph_row). */
16644 n_glyphs_before
= row
->used
[TEXT_AREA
];
16647 /* Remember the line height so far in case the next element doesn't
16648 fit on the line. */
16649 if (it
->line_wrap
!= TRUNCATE
)
16651 ascent
= it
->max_ascent
;
16652 descent
= it
->max_descent
;
16653 phys_ascent
= it
->max_phys_ascent
;
16654 phys_descent
= it
->max_phys_descent
;
16656 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16658 if (IT_DISPLAYING_WHITESPACE (it
))
16664 wrap_row_used
= row
->used
[TEXT_AREA
];
16665 wrap_row_ascent
= row
->ascent
;
16666 wrap_row_height
= row
->height
;
16667 wrap_row_phys_ascent
= row
->phys_ascent
;
16668 wrap_row_phys_height
= row
->phys_height
;
16669 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16675 PRODUCE_GLYPHS (it
);
16677 /* If this display element was in marginal areas, continue with
16679 if (it
->area
!= TEXT_AREA
)
16681 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16682 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16683 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16684 row
->phys_height
= max (row
->phys_height
,
16685 it
->max_phys_ascent
+ it
->max_phys_descent
);
16686 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16687 it
->max_extra_line_spacing
);
16688 set_iterator_to_next (it
, 1);
16692 /* Does the display element fit on the line? If we truncate
16693 lines, we should draw past the right edge of the window. If
16694 we don't truncate, we want to stop so that we can display the
16695 continuation glyph before the right margin. If lines are
16696 continued, there are two possible strategies for characters
16697 resulting in more than 1 glyph (e.g. tabs): Display as many
16698 glyphs as possible in this line and leave the rest for the
16699 continuation line, or display the whole element in the next
16700 line. Original redisplay did the former, so we do it also. */
16701 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16702 hpos_before
= it
->hpos
;
16705 if (/* Not a newline. */
16707 /* Glyphs produced fit entirely in the line. */
16708 && it
->current_x
< it
->last_visible_x
)
16710 it
->hpos
+= nglyphs
;
16711 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16712 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16713 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16714 row
->phys_height
= max (row
->phys_height
,
16715 it
->max_phys_ascent
+ it
->max_phys_descent
);
16716 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16717 it
->max_extra_line_spacing
);
16718 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16719 row
->x
= x
- it
->first_visible_x
;
16724 struct glyph
*glyph
;
16726 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16728 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16729 new_x
= x
+ glyph
->pixel_width
;
16731 if (/* Lines are continued. */
16732 it
->line_wrap
!= TRUNCATE
16733 && (/* Glyph doesn't fit on the line. */
16734 new_x
> it
->last_visible_x
16735 /* Or it fits exactly on a window system frame. */
16736 || (new_x
== it
->last_visible_x
16737 && FRAME_WINDOW_P (it
->f
))))
16739 /* End of a continued line. */
16742 || (new_x
== it
->last_visible_x
16743 && FRAME_WINDOW_P (it
->f
)))
16745 /* Current glyph is the only one on the line or
16746 fits exactly on the line. We must continue
16747 the line because we can't draw the cursor
16748 after the glyph. */
16749 row
->continued_p
= 1;
16750 it
->current_x
= new_x
;
16751 it
->continuation_lines_width
+= new_x
;
16753 if (i
== nglyphs
- 1)
16755 /* If line-wrap is on, check if a previous
16756 wrap point was found. */
16757 if (wrap_row_used
> 0
16758 /* Even if there is a previous wrap
16759 point, continue the line here as
16760 usual, if (i) the previous character
16761 was a space or tab AND (ii) the
16762 current character is not. */
16764 || IT_DISPLAYING_WHITESPACE (it
)))
16767 set_iterator_to_next (it
, 1);
16768 #ifdef HAVE_WINDOW_SYSTEM
16769 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16771 if (!get_next_display_element (it
))
16773 row
->exact_window_width_line_p
= 1;
16774 it
->continuation_lines_width
= 0;
16775 row
->continued_p
= 0;
16776 row
->ends_at_zv_p
= 1;
16778 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16780 row
->continued_p
= 0;
16781 row
->exact_window_width_line_p
= 1;
16784 #endif /* HAVE_WINDOW_SYSTEM */
16787 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16788 && !FRAME_WINDOW_P (it
->f
))
16790 /* A padding glyph that doesn't fit on this line.
16791 This means the whole character doesn't fit
16793 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16795 /* Fill the rest of the row with continuation
16796 glyphs like in 20.x. */
16797 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16798 < row
->glyphs
[1 + TEXT_AREA
])
16799 produce_special_glyphs (it
, IT_CONTINUATION
);
16801 row
->continued_p
= 1;
16802 it
->current_x
= x_before
;
16803 it
->continuation_lines_width
+= x_before
;
16805 /* Restore the height to what it was before the
16806 element not fitting on the line. */
16807 it
->max_ascent
= ascent
;
16808 it
->max_descent
= descent
;
16809 it
->max_phys_ascent
= phys_ascent
;
16810 it
->max_phys_descent
= phys_descent
;
16812 else if (wrap_row_used
> 0)
16816 it
->continuation_lines_width
+= wrap_x
;
16817 row
->used
[TEXT_AREA
] = wrap_row_used
;
16818 row
->ascent
= wrap_row_ascent
;
16819 row
->height
= wrap_row_height
;
16820 row
->phys_ascent
= wrap_row_phys_ascent
;
16821 row
->phys_height
= wrap_row_phys_height
;
16822 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16823 row
->continued_p
= 1;
16824 row
->ends_at_zv_p
= 0;
16825 row
->exact_window_width_line_p
= 0;
16826 it
->continuation_lines_width
+= x
;
16828 /* Make sure that a non-default face is extended
16829 up to the right margin of the window. */
16830 extend_face_to_end_of_line (it
);
16832 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16834 /* A TAB that extends past the right edge of the
16835 window. This produces a single glyph on
16836 window system frames. We leave the glyph in
16837 this row and let it fill the row, but don't
16838 consume the TAB. */
16839 it
->continuation_lines_width
+= it
->last_visible_x
;
16840 row
->ends_in_middle_of_char_p
= 1;
16841 row
->continued_p
= 1;
16842 glyph
->pixel_width
= it
->last_visible_x
- x
;
16843 it
->starts_in_middle_of_char_p
= 1;
16847 /* Something other than a TAB that draws past
16848 the right edge of the window. Restore
16849 positions to values before the element. */
16850 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16852 /* Display continuation glyphs. */
16853 if (!FRAME_WINDOW_P (it
->f
))
16854 produce_special_glyphs (it
, IT_CONTINUATION
);
16855 row
->continued_p
= 1;
16857 it
->current_x
= x_before
;
16858 it
->continuation_lines_width
+= x
;
16859 extend_face_to_end_of_line (it
);
16861 if (nglyphs
> 1 && i
> 0)
16863 row
->ends_in_middle_of_char_p
= 1;
16864 it
->starts_in_middle_of_char_p
= 1;
16867 /* Restore the height to what it was before the
16868 element not fitting on the line. */
16869 it
->max_ascent
= ascent
;
16870 it
->max_descent
= descent
;
16871 it
->max_phys_ascent
= phys_ascent
;
16872 it
->max_phys_descent
= phys_descent
;
16877 else if (new_x
> it
->first_visible_x
)
16879 /* Increment number of glyphs actually displayed. */
16882 if (x
< it
->first_visible_x
)
16883 /* Glyph is partially visible, i.e. row starts at
16884 negative X position. */
16885 row
->x
= x
- it
->first_visible_x
;
16889 /* Glyph is completely off the left margin of the
16890 window. This should not happen because of the
16891 move_it_in_display_line at the start of this
16892 function, unless the text display area of the
16893 window is empty. */
16894 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16898 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16899 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16900 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16901 row
->phys_height
= max (row
->phys_height
,
16902 it
->max_phys_ascent
+ it
->max_phys_descent
);
16903 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16904 it
->max_extra_line_spacing
);
16906 /* End of this display line if row is continued. */
16907 if (row
->continued_p
|| row
->ends_at_zv_p
)
16912 /* Is this a line end? If yes, we're also done, after making
16913 sure that a non-default face is extended up to the right
16914 margin of the window. */
16915 if (ITERATOR_AT_END_OF_LINE_P (it
))
16917 int used_before
= row
->used
[TEXT_AREA
];
16919 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16921 #ifdef HAVE_WINDOW_SYSTEM
16922 /* Add a space at the end of the line that is used to
16923 display the cursor there. */
16924 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16925 append_space_for_newline (it
, 0);
16926 #endif /* HAVE_WINDOW_SYSTEM */
16928 /* Extend the face to the end of the line. */
16929 extend_face_to_end_of_line (it
);
16931 /* Make sure we have the position. */
16932 if (used_before
== 0)
16933 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16935 /* Consume the line end. This skips over invisible lines. */
16936 set_iterator_to_next (it
, 1);
16937 it
->continuation_lines_width
= 0;
16941 /* Proceed with next display element. Note that this skips
16942 over lines invisible because of selective display. */
16943 set_iterator_to_next (it
, 1);
16945 /* If we truncate lines, we are done when the last displayed
16946 glyphs reach past the right margin of the window. */
16947 if (it
->line_wrap
== TRUNCATE
16948 && (FRAME_WINDOW_P (it
->f
)
16949 ? (it
->current_x
>= it
->last_visible_x
)
16950 : (it
->current_x
> it
->last_visible_x
)))
16952 /* Maybe add truncation glyphs. */
16953 if (!FRAME_WINDOW_P (it
->f
))
16957 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16958 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16961 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16963 row
->used
[TEXT_AREA
] = i
;
16964 produce_special_glyphs (it
, IT_TRUNCATION
);
16967 #ifdef HAVE_WINDOW_SYSTEM
16970 /* Don't truncate if we can overflow newline into fringe. */
16971 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16973 if (!get_next_display_element (it
))
16975 it
->continuation_lines_width
= 0;
16976 row
->ends_at_zv_p
= 1;
16977 row
->exact_window_width_line_p
= 1;
16980 if (ITERATOR_AT_END_OF_LINE_P (it
))
16982 row
->exact_window_width_line_p
= 1;
16983 goto at_end_of_line
;
16987 #endif /* HAVE_WINDOW_SYSTEM */
16989 row
->truncated_on_right_p
= 1;
16990 it
->continuation_lines_width
= 0;
16991 reseat_at_next_visible_line_start (it
, 0);
16992 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16993 it
->hpos
= hpos_before
;
16994 it
->current_x
= x_before
;
16999 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17000 at the left window margin. */
17001 if (it
->first_visible_x
17002 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
17004 if (!FRAME_WINDOW_P (it
->f
))
17005 insert_left_trunc_glyphs (it
);
17006 row
->truncated_on_left_p
= 1;
17009 /* If the start of this line is the overlay arrow-position, then
17010 mark this glyph row as the one containing the overlay arrow.
17011 This is clearly a mess with variable size fonts. It would be
17012 better to let it be displayed like cursors under X. */
17013 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17014 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17015 !NILP (overlay_arrow_string
)))
17017 /* Overlay arrow in window redisplay is a fringe bitmap. */
17018 if (STRINGP (overlay_arrow_string
))
17020 struct glyph_row
*arrow_row
17021 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17022 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17023 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17024 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17025 struct glyph
*p2
, *end
;
17027 /* Copy the arrow glyphs. */
17028 while (glyph
< arrow_end
)
17031 /* Throw away padding glyphs. */
17033 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17034 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17040 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17045 xassert (INTEGERP (overlay_arrow_string
));
17046 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17048 overlay_arrow_seen
= 1;
17051 /* Compute pixel dimensions of this line. */
17052 compute_line_metrics (it
);
17054 /* Remember the position at which this line ends. */
17055 row
->end
= it
->current
;
17057 /* Record whether this row ends inside an ellipsis. */
17058 row
->ends_in_ellipsis_p
17059 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17060 && it
->ellipsis_p
);
17062 /* Save fringe bitmaps in this row. */
17063 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17064 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17065 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17066 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17068 it
->left_user_fringe_bitmap
= 0;
17069 it
->left_user_fringe_face_id
= 0;
17070 it
->right_user_fringe_bitmap
= 0;
17071 it
->right_user_fringe_face_id
= 0;
17073 /* Maybe set the cursor. */
17074 if (it
->w
->cursor
.vpos
< 0
17075 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17076 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17077 && cursor_row_p (it
->w
, row
))
17078 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17080 /* Highlight trailing whitespace. */
17081 if (!NILP (Vshow_trailing_whitespace
))
17082 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17084 /* Prepare for the next line. This line starts horizontally at (X
17085 HPOS) = (0 0). Vertical positions are incremented. As a
17086 convenience for the caller, IT->glyph_row is set to the next
17088 it
->current_x
= it
->hpos
= 0;
17089 it
->current_y
+= row
->height
;
17092 it
->start
= it
->current
;
17093 return row
->displays_text_p
;
17098 /***********************************************************************
17100 ***********************************************************************/
17102 /* Redisplay the menu bar in the frame for window W.
17104 The menu bar of X frames that don't have X toolkit support is
17105 displayed in a special window W->frame->menu_bar_window.
17107 The menu bar of terminal frames is treated specially as far as
17108 glyph matrices are concerned. Menu bar lines are not part of
17109 windows, so the update is done directly on the frame matrix rows
17110 for the menu bar. */
17113 display_menu_bar (w
)
17116 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17121 /* Don't do all this for graphical frames. */
17123 if (FRAME_W32_P (f
))
17126 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17132 if (FRAME_NS_P (f
))
17134 #endif /* HAVE_NS */
17136 #ifdef USE_X_TOOLKIT
17137 xassert (!FRAME_WINDOW_P (f
));
17138 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17139 it
.first_visible_x
= 0;
17140 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17141 #else /* not USE_X_TOOLKIT */
17142 if (FRAME_WINDOW_P (f
))
17144 /* Menu bar lines are displayed in the desired matrix of the
17145 dummy window menu_bar_window. */
17146 struct window
*menu_w
;
17147 xassert (WINDOWP (f
->menu_bar_window
));
17148 menu_w
= XWINDOW (f
->menu_bar_window
);
17149 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17151 it
.first_visible_x
= 0;
17152 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17156 /* This is a TTY frame, i.e. character hpos/vpos are used as
17158 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17160 it
.first_visible_x
= 0;
17161 it
.last_visible_x
= FRAME_COLS (f
);
17163 #endif /* not USE_X_TOOLKIT */
17165 if (! mode_line_inverse_video
)
17166 /* Force the menu-bar to be displayed in the default face. */
17167 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17169 /* Clear all rows of the menu bar. */
17170 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17172 struct glyph_row
*row
= it
.glyph_row
+ i
;
17173 clear_glyph_row (row
);
17174 row
->enabled_p
= 1;
17175 row
->full_width_p
= 1;
17178 /* Display all items of the menu bar. */
17179 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17180 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17182 Lisp_Object string
;
17184 /* Stop at nil string. */
17185 string
= AREF (items
, i
+ 1);
17189 /* Remember where item was displayed. */
17190 ASET (items
, i
+ 3, make_number (it
.hpos
));
17192 /* Display the item, pad with one space. */
17193 if (it
.current_x
< it
.last_visible_x
)
17194 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17195 SCHARS (string
) + 1, 0, 0, -1);
17198 /* Fill out the line with spaces. */
17199 if (it
.current_x
< it
.last_visible_x
)
17200 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17202 /* Compute the total height of the lines. */
17203 compute_line_metrics (&it
);
17208 /***********************************************************************
17210 ***********************************************************************/
17212 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17213 FORCE is non-zero, redisplay mode lines unconditionally.
17214 Otherwise, redisplay only mode lines that are garbaged. Value is
17215 the number of windows whose mode lines were redisplayed. */
17218 redisplay_mode_lines (window
, force
)
17219 Lisp_Object window
;
17224 while (!NILP (window
))
17226 struct window
*w
= XWINDOW (window
);
17228 if (WINDOWP (w
->hchild
))
17229 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17230 else if (WINDOWP (w
->vchild
))
17231 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17233 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17234 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17236 struct text_pos lpoint
;
17237 struct buffer
*old
= current_buffer
;
17239 /* Set the window's buffer for the mode line display. */
17240 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17241 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17243 /* Point refers normally to the selected window. For any
17244 other window, set up appropriate value. */
17245 if (!EQ (window
, selected_window
))
17247 struct text_pos pt
;
17249 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17250 if (CHARPOS (pt
) < BEGV
)
17251 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17252 else if (CHARPOS (pt
) > (ZV
- 1))
17253 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17255 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17258 /* Display mode lines. */
17259 clear_glyph_matrix (w
->desired_matrix
);
17260 if (display_mode_lines (w
))
17263 w
->must_be_updated_p
= 1;
17266 /* Restore old settings. */
17267 set_buffer_internal_1 (old
);
17268 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17278 /* Display the mode and/or top line of window W. Value is the number
17279 of mode lines displayed. */
17282 display_mode_lines (w
)
17285 Lisp_Object old_selected_window
, old_selected_frame
;
17288 old_selected_frame
= selected_frame
;
17289 selected_frame
= w
->frame
;
17290 old_selected_window
= selected_window
;
17291 XSETWINDOW (selected_window
, w
);
17293 /* These will be set while the mode line specs are processed. */
17294 line_number_displayed
= 0;
17295 w
->column_number_displayed
= Qnil
;
17297 if (WINDOW_WANTS_MODELINE_P (w
))
17299 struct window
*sel_w
= XWINDOW (old_selected_window
);
17301 /* Select mode line face based on the real selected window. */
17302 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17303 current_buffer
->mode_line_format
);
17307 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17309 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17310 current_buffer
->header_line_format
);
17314 selected_frame
= old_selected_frame
;
17315 selected_window
= old_selected_window
;
17320 /* Display mode or top line of window W. FACE_ID specifies which line
17321 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
17322 FORMAT is the mode line format to display. Value is the pixel
17323 height of the mode line displayed. */
17326 display_mode_line (w
, face_id
, format
)
17328 enum face_id face_id
;
17329 Lisp_Object format
;
17333 int count
= SPECPDL_INDEX ();
17335 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17336 /* Don't extend on a previously drawn mode-line.
17337 This may happen if called from pos_visible_p. */
17338 it
.glyph_row
->enabled_p
= 0;
17339 prepare_desired_row (it
.glyph_row
);
17341 it
.glyph_row
->mode_line_p
= 1;
17343 if (! mode_line_inverse_video
)
17344 /* Force the mode-line to be displayed in the default face. */
17345 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17347 record_unwind_protect (unwind_format_mode_line
,
17348 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17350 mode_line_target
= MODE_LINE_DISPLAY
;
17352 /* Temporarily make frame's keyboard the current kboard so that
17353 kboard-local variables in the mode_line_format will get the right
17355 push_kboard (FRAME_KBOARD (it
.f
));
17356 record_unwind_save_match_data ();
17357 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17360 unbind_to (count
, Qnil
);
17362 /* Fill up with spaces. */
17363 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17365 compute_line_metrics (&it
);
17366 it
.glyph_row
->full_width_p
= 1;
17367 it
.glyph_row
->continued_p
= 0;
17368 it
.glyph_row
->truncated_on_left_p
= 0;
17369 it
.glyph_row
->truncated_on_right_p
= 0;
17371 /* Make a 3D mode-line have a shadow at its right end. */
17372 face
= FACE_FROM_ID (it
.f
, face_id
);
17373 extend_face_to_end_of_line (&it
);
17374 if (face
->box
!= FACE_NO_BOX
)
17376 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17377 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17378 last
->right_box_line_p
= 1;
17381 return it
.glyph_row
->height
;
17384 /* Move element ELT in LIST to the front of LIST.
17385 Return the updated list. */
17388 move_elt_to_front (elt
, list
)
17389 Lisp_Object elt
, list
;
17391 register Lisp_Object tail
, prev
;
17392 register Lisp_Object tem
;
17396 while (CONSP (tail
))
17402 /* Splice out the link TAIL. */
17404 list
= XCDR (tail
);
17406 Fsetcdr (prev
, XCDR (tail
));
17408 /* Now make it the first. */
17409 Fsetcdr (tail
, list
);
17414 tail
= XCDR (tail
);
17418 /* Not found--return unchanged LIST. */
17422 /* Contribute ELT to the mode line for window IT->w. How it
17423 translates into text depends on its data type.
17425 IT describes the display environment in which we display, as usual.
17427 DEPTH is the depth in recursion. It is used to prevent
17428 infinite recursion here.
17430 FIELD_WIDTH is the number of characters the display of ELT should
17431 occupy in the mode line, and PRECISION is the maximum number of
17432 characters to display from ELT's representation. See
17433 display_string for details.
17435 Returns the hpos of the end of the text generated by ELT.
17437 PROPS is a property list to add to any string we encounter.
17439 If RISKY is nonzero, remove (disregard) any properties in any string
17440 we encounter, and ignore :eval and :propertize.
17442 The global variable `mode_line_target' determines whether the
17443 output is passed to `store_mode_line_noprop',
17444 `store_mode_line_string', or `display_string'. */
17447 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17450 int field_width
, precision
;
17451 Lisp_Object elt
, props
;
17454 int n
= 0, field
, prec
;
17459 elt
= build_string ("*too-deep*");
17463 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17467 /* A string: output it and check for %-constructs within it. */
17471 if (SCHARS (elt
) > 0
17472 && (!NILP (props
) || risky
))
17474 Lisp_Object oprops
, aelt
;
17475 oprops
= Ftext_properties_at (make_number (0), elt
);
17477 /* If the starting string's properties are not what
17478 we want, translate the string. Also, if the string
17479 is risky, do that anyway. */
17481 if (NILP (Fequal (props
, oprops
)) || risky
)
17483 /* If the starting string has properties,
17484 merge the specified ones onto the existing ones. */
17485 if (! NILP (oprops
) && !risky
)
17489 oprops
= Fcopy_sequence (oprops
);
17491 while (CONSP (tem
))
17493 oprops
= Fplist_put (oprops
, XCAR (tem
),
17494 XCAR (XCDR (tem
)));
17495 tem
= XCDR (XCDR (tem
));
17500 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17501 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17503 /* AELT is what we want. Move it to the front
17504 without consing. */
17506 mode_line_proptrans_alist
17507 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17513 /* If AELT has the wrong props, it is useless.
17514 so get rid of it. */
17516 mode_line_proptrans_alist
17517 = Fdelq (aelt
, mode_line_proptrans_alist
);
17519 elt
= Fcopy_sequence (elt
);
17520 Fset_text_properties (make_number (0), Flength (elt
),
17522 /* Add this item to mode_line_proptrans_alist. */
17523 mode_line_proptrans_alist
17524 = Fcons (Fcons (elt
, props
),
17525 mode_line_proptrans_alist
);
17526 /* Truncate mode_line_proptrans_alist
17527 to at most 50 elements. */
17528 tem
= Fnthcdr (make_number (50),
17529 mode_line_proptrans_alist
);
17531 XSETCDR (tem
, Qnil
);
17540 prec
= precision
- n
;
17541 switch (mode_line_target
)
17543 case MODE_LINE_NOPROP
:
17544 case MODE_LINE_TITLE
:
17545 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17547 case MODE_LINE_STRING
:
17548 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17550 case MODE_LINE_DISPLAY
:
17551 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17552 0, prec
, 0, STRING_MULTIBYTE (elt
));
17559 /* Handle the non-literal case. */
17561 while ((precision
<= 0 || n
< precision
)
17562 && SREF (elt
, offset
) != 0
17563 && (mode_line_target
!= MODE_LINE_DISPLAY
17564 || it
->current_x
< it
->last_visible_x
))
17566 int last_offset
= offset
;
17568 /* Advance to end of string or next format specifier. */
17569 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17572 if (offset
- 1 != last_offset
)
17574 int nchars
, nbytes
;
17576 /* Output to end of string or up to '%'. Field width
17577 is length of string. Don't output more than
17578 PRECISION allows us. */
17581 prec
= c_string_width (SDATA (elt
) + last_offset
,
17582 offset
- last_offset
, precision
- n
,
17585 switch (mode_line_target
)
17587 case MODE_LINE_NOPROP
:
17588 case MODE_LINE_TITLE
:
17589 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17591 case MODE_LINE_STRING
:
17593 int bytepos
= last_offset
;
17594 int charpos
= string_byte_to_char (elt
, bytepos
);
17595 int endpos
= (precision
<= 0
17596 ? string_byte_to_char (elt
, offset
)
17597 : charpos
+ nchars
);
17599 n
+= store_mode_line_string (NULL
,
17600 Fsubstring (elt
, make_number (charpos
),
17601 make_number (endpos
)),
17605 case MODE_LINE_DISPLAY
:
17607 int bytepos
= last_offset
;
17608 int charpos
= string_byte_to_char (elt
, bytepos
);
17610 if (precision
<= 0)
17611 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17612 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17614 STRING_MULTIBYTE (elt
));
17619 else /* c == '%' */
17621 int percent_position
= offset
;
17623 /* Get the specified minimum width. Zero means
17626 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17627 field
= field
* 10 + c
- '0';
17629 /* Don't pad beyond the total padding allowed. */
17630 if (field_width
- n
> 0 && field
> field_width
- n
)
17631 field
= field_width
- n
;
17633 /* Note that either PRECISION <= 0 or N < PRECISION. */
17634 prec
= precision
- n
;
17637 n
+= display_mode_element (it
, depth
, field
, prec
,
17638 Vglobal_mode_string
, props
,
17643 int bytepos
, charpos
;
17644 unsigned char *spec
;
17646 bytepos
= percent_position
;
17647 charpos
= (STRING_MULTIBYTE (elt
)
17648 ? string_byte_to_char (elt
, bytepos
)
17651 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17653 switch (mode_line_target
)
17655 case MODE_LINE_NOPROP
:
17656 case MODE_LINE_TITLE
:
17657 n
+= store_mode_line_noprop (spec
, field
, prec
);
17659 case MODE_LINE_STRING
:
17661 int len
= strlen (spec
);
17662 Lisp_Object tem
= make_string (spec
, len
);
17663 props
= Ftext_properties_at (make_number (charpos
), elt
);
17664 /* Should only keep face property in props */
17665 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17668 case MODE_LINE_DISPLAY
:
17670 int nglyphs_before
, nwritten
;
17672 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17673 nwritten
= display_string (spec
, Qnil
, elt
,
17678 /* Assign to the glyphs written above the
17679 string where the `%x' came from, position
17683 struct glyph
*glyph
17684 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17688 for (i
= 0; i
< nwritten
; ++i
)
17690 glyph
[i
].object
= elt
;
17691 glyph
[i
].charpos
= charpos
;
17708 /* A symbol: process the value of the symbol recursively
17709 as if it appeared here directly. Avoid error if symbol void.
17710 Special case: if value of symbol is a string, output the string
17713 register Lisp_Object tem
;
17715 /* If the variable is not marked as risky to set
17716 then its contents are risky to use. */
17717 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17720 tem
= Fboundp (elt
);
17723 tem
= Fsymbol_value (elt
);
17724 /* If value is a string, output that string literally:
17725 don't check for % within it. */
17729 if (!EQ (tem
, elt
))
17731 /* Give up right away for nil or t. */
17741 register Lisp_Object car
, tem
;
17743 /* A cons cell: five distinct cases.
17744 If first element is :eval or :propertize, do something special.
17745 If first element is a string or a cons, process all the elements
17746 and effectively concatenate them.
17747 If first element is a negative number, truncate displaying cdr to
17748 at most that many characters. If positive, pad (with spaces)
17749 to at least that many characters.
17750 If first element is a symbol, process the cadr or caddr recursively
17751 according to whether the symbol's value is non-nil or nil. */
17753 if (EQ (car
, QCeval
))
17755 /* An element of the form (:eval FORM) means evaluate FORM
17756 and use the result as mode line elements. */
17761 if (CONSP (XCDR (elt
)))
17764 spec
= safe_eval (XCAR (XCDR (elt
)));
17765 n
+= display_mode_element (it
, depth
, field_width
- n
,
17766 precision
- n
, spec
, props
,
17770 else if (EQ (car
, QCpropertize
))
17772 /* An element of the form (:propertize ELT PROPS...)
17773 means display ELT but applying properties PROPS. */
17778 if (CONSP (XCDR (elt
)))
17779 n
+= display_mode_element (it
, depth
, field_width
- n
,
17780 precision
- n
, XCAR (XCDR (elt
)),
17781 XCDR (XCDR (elt
)), risky
);
17783 else if (SYMBOLP (car
))
17785 tem
= Fboundp (car
);
17789 /* elt is now the cdr, and we know it is a cons cell.
17790 Use its car if CAR has a non-nil value. */
17793 tem
= Fsymbol_value (car
);
17800 /* Symbol's value is nil (or symbol is unbound)
17801 Get the cddr of the original list
17802 and if possible find the caddr and use that. */
17806 else if (!CONSP (elt
))
17811 else if (INTEGERP (car
))
17813 register int lim
= XINT (car
);
17817 /* Negative int means reduce maximum width. */
17818 if (precision
<= 0)
17821 precision
= min (precision
, -lim
);
17825 /* Padding specified. Don't let it be more than
17826 current maximum. */
17828 lim
= min (precision
, lim
);
17830 /* If that's more padding than already wanted, queue it.
17831 But don't reduce padding already specified even if
17832 that is beyond the current truncation point. */
17833 field_width
= max (lim
, field_width
);
17837 else if (STRINGP (car
) || CONSP (car
))
17839 register int limit
= 50;
17840 /* Limit is to protect against circular lists. */
17843 && (precision
<= 0 || n
< precision
))
17845 n
+= display_mode_element (it
, depth
,
17846 /* Do padding only after the last
17847 element in the list. */
17848 (! CONSP (XCDR (elt
))
17851 precision
- n
, XCAR (elt
),
17861 elt
= build_string ("*invalid*");
17865 /* Pad to FIELD_WIDTH. */
17866 if (field_width
> 0 && n
< field_width
)
17868 switch (mode_line_target
)
17870 case MODE_LINE_NOPROP
:
17871 case MODE_LINE_TITLE
:
17872 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17874 case MODE_LINE_STRING
:
17875 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17877 case MODE_LINE_DISPLAY
:
17878 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17887 /* Store a mode-line string element in mode_line_string_list.
17889 If STRING is non-null, display that C string. Otherwise, the Lisp
17890 string LISP_STRING is displayed.
17892 FIELD_WIDTH is the minimum number of output glyphs to produce.
17893 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17894 with spaces. FIELD_WIDTH <= 0 means don't pad.
17896 PRECISION is the maximum number of characters to output from
17897 STRING. PRECISION <= 0 means don't truncate the string.
17899 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17900 properties to the string.
17902 PROPS are the properties to add to the string.
17903 The mode_line_string_face face property is always added to the string.
17907 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17909 Lisp_Object lisp_string
;
17918 if (string
!= NULL
)
17920 len
= strlen (string
);
17921 if (precision
> 0 && len
> precision
)
17923 lisp_string
= make_string (string
, len
);
17925 props
= mode_line_string_face_prop
;
17926 else if (!NILP (mode_line_string_face
))
17928 Lisp_Object face
= Fplist_get (props
, Qface
);
17929 props
= Fcopy_sequence (props
);
17931 face
= mode_line_string_face
;
17933 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17934 props
= Fplist_put (props
, Qface
, face
);
17936 Fadd_text_properties (make_number (0), make_number (len
),
17937 props
, lisp_string
);
17941 len
= XFASTINT (Flength (lisp_string
));
17942 if (precision
> 0 && len
> precision
)
17945 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17948 if (!NILP (mode_line_string_face
))
17952 props
= Ftext_properties_at (make_number (0), lisp_string
);
17953 face
= Fplist_get (props
, Qface
);
17955 face
= mode_line_string_face
;
17957 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17958 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17960 lisp_string
= Fcopy_sequence (lisp_string
);
17963 Fadd_text_properties (make_number (0), make_number (len
),
17964 props
, lisp_string
);
17969 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17973 if (field_width
> len
)
17975 field_width
-= len
;
17976 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17978 Fadd_text_properties (make_number (0), make_number (field_width
),
17979 props
, lisp_string
);
17980 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17988 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17990 doc
: /* Format a string out of a mode line format specification.
17991 First arg FORMAT specifies the mode line format (see `mode-line-format'
17992 for details) to use.
17994 Optional second arg FACE specifies the face property to put
17995 on all characters for which no face is specified.
17996 The value t means whatever face the window's mode line currently uses
17997 \(either `mode-line' or `mode-line-inactive', depending).
17998 A value of nil means the default is no face property.
17999 If FACE is an integer, the value string has no text properties.
18001 Optional third and fourth args WINDOW and BUFFER specify the window
18002 and buffer to use as the context for the formatting (defaults
18003 are the selected window and the window's buffer). */)
18004 (format
, face
, window
, buffer
)
18005 Lisp_Object format
, face
, window
, buffer
;
18010 struct buffer
*old_buffer
= NULL
;
18012 int no_props
= INTEGERP (face
);
18013 int count
= SPECPDL_INDEX ();
18015 int string_start
= 0;
18018 window
= selected_window
;
18019 CHECK_WINDOW (window
);
18020 w
= XWINDOW (window
);
18023 buffer
= w
->buffer
;
18024 CHECK_BUFFER (buffer
);
18026 /* Make formatting the modeline a non-op when noninteractive, otherwise
18027 there will be problems later caused by a partially initialized frame. */
18028 if (NILP (format
) || noninteractive
)
18029 return empty_unibyte_string
;
18037 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18038 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18042 face_id
= DEFAULT_FACE_ID
;
18044 if (XBUFFER (buffer
) != current_buffer
)
18045 old_buffer
= current_buffer
;
18047 /* Save things including mode_line_proptrans_alist,
18048 and set that to nil so that we don't alter the outer value. */
18049 record_unwind_protect (unwind_format_mode_line
,
18050 format_mode_line_unwind_data
18051 (old_buffer
, selected_window
, 1));
18052 mode_line_proptrans_alist
= Qnil
;
18054 Fselect_window (window
, Qt
);
18056 set_buffer_internal_1 (XBUFFER (buffer
));
18058 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18062 mode_line_target
= MODE_LINE_NOPROP
;
18063 mode_line_string_face_prop
= Qnil
;
18064 mode_line_string_list
= Qnil
;
18065 string_start
= MODE_LINE_NOPROP_LEN (0);
18069 mode_line_target
= MODE_LINE_STRING
;
18070 mode_line_string_list
= Qnil
;
18071 mode_line_string_face
= face
;
18072 mode_line_string_face_prop
18073 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18076 push_kboard (FRAME_KBOARD (it
.f
));
18077 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18082 len
= MODE_LINE_NOPROP_LEN (string_start
);
18083 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18087 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18088 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18089 empty_unibyte_string
);
18092 unbind_to (count
, Qnil
);
18096 /* Write a null-terminated, right justified decimal representation of
18097 the positive integer D to BUF using a minimal field width WIDTH. */
18100 pint2str (buf
, width
, d
)
18101 register char *buf
;
18102 register int width
;
18105 register char *p
= buf
;
18113 *p
++ = d
% 10 + '0';
18118 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18129 /* Write a null-terminated, right justified decimal and "human
18130 readable" representation of the nonnegative integer D to BUF using
18131 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18133 static const char power_letter
[] =
18147 pint2hrstr (buf
, width
, d
)
18152 /* We aim to represent the nonnegative integer D as
18153 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18156 /* -1 means: do not use TENTHS. */
18160 /* Length of QUOTIENT.TENTHS as a string. */
18166 if (1000 <= quotient
)
18168 /* Scale to the appropriate EXPONENT. */
18171 remainder
= quotient
% 1000;
18175 while (1000 <= quotient
);
18177 /* Round to nearest and decide whether to use TENTHS or not. */
18180 tenths
= remainder
/ 100;
18181 if (50 <= remainder
% 100)
18188 if (quotient
== 10)
18196 if (500 <= remainder
)
18198 if (quotient
< 999)
18209 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18210 if (tenths
== -1 && quotient
<= 99)
18217 p
= psuffix
= buf
+ max (width
, length
);
18219 /* Print EXPONENT. */
18221 *psuffix
++ = power_letter
[exponent
];
18224 /* Print TENTHS. */
18227 *--p
= '0' + tenths
;
18231 /* Print QUOTIENT. */
18234 int digit
= quotient
% 10;
18235 *--p
= '0' + digit
;
18237 while ((quotient
/= 10) != 0);
18239 /* Print leading spaces. */
18244 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18245 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18246 type of CODING_SYSTEM. Return updated pointer into BUF. */
18248 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18251 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18252 Lisp_Object coding_system
;
18253 register char *buf
;
18257 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18258 const unsigned char *eol_str
;
18260 /* The EOL conversion we are using. */
18261 Lisp_Object eoltype
;
18263 val
= CODING_SYSTEM_SPEC (coding_system
);
18266 if (!VECTORP (val
)) /* Not yet decided. */
18271 eoltype
= eol_mnemonic_undecided
;
18272 /* Don't mention EOL conversion if it isn't decided. */
18277 Lisp_Object eolvalue
;
18279 attrs
= AREF (val
, 0);
18280 eolvalue
= AREF (val
, 2);
18283 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18287 /* The EOL conversion that is normal on this system. */
18289 if (NILP (eolvalue
)) /* Not yet decided. */
18290 eoltype
= eol_mnemonic_undecided
;
18291 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18292 eoltype
= eol_mnemonic_undecided
;
18293 else /* eolvalue is Qunix, Qdos, or Qmac. */
18294 eoltype
= (EQ (eolvalue
, Qunix
)
18295 ? eol_mnemonic_unix
18296 : (EQ (eolvalue
, Qdos
) == 1
18297 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18303 /* Mention the EOL conversion if it is not the usual one. */
18304 if (STRINGP (eoltype
))
18306 eol_str
= SDATA (eoltype
);
18307 eol_str_len
= SBYTES (eoltype
);
18309 else if (CHARACTERP (eoltype
))
18311 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18312 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18317 eol_str
= invalid_eol_type
;
18318 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18320 bcopy (eol_str
, buf
, eol_str_len
);
18321 buf
+= eol_str_len
;
18327 /* Return a string for the output of a mode line %-spec for window W,
18328 generated by character C. PRECISION >= 0 means don't return a
18329 string longer than that value. FIELD_WIDTH > 0 means pad the
18330 string returned with spaces to that value. Return 1 in *MULTIBYTE
18331 if the result is multibyte text.
18333 Note we operate on the current buffer for most purposes,
18334 the exception being w->base_line_pos. */
18336 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18339 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
18342 int field_width
, precision
;
18346 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18347 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18348 struct buffer
*b
= current_buffer
;
18356 if (!NILP (b
->read_only
))
18358 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18363 /* This differs from %* only for a modified read-only buffer. */
18364 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18366 if (!NILP (b
->read_only
))
18371 /* This differs from %* in ignoring read-only-ness. */
18372 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18384 if (command_loop_level
> 5)
18386 p
= decode_mode_spec_buf
;
18387 for (i
= 0; i
< command_loop_level
; i
++)
18390 return decode_mode_spec_buf
;
18398 if (command_loop_level
> 5)
18400 p
= decode_mode_spec_buf
;
18401 for (i
= 0; i
< command_loop_level
; i
++)
18404 return decode_mode_spec_buf
;
18411 /* Let lots_of_dashes be a string of infinite length. */
18412 if (mode_line_target
== MODE_LINE_NOPROP
||
18413 mode_line_target
== MODE_LINE_STRING
)
18415 if (field_width
<= 0
18416 || field_width
> sizeof (lots_of_dashes
))
18418 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18419 decode_mode_spec_buf
[i
] = '-';
18420 decode_mode_spec_buf
[i
] = '\0';
18421 return decode_mode_spec_buf
;
18424 return lots_of_dashes
;
18432 /* %c and %l are ignored in `frame-title-format'.
18433 (In redisplay_internal, the frame title is drawn _before_ the
18434 windows are updated, so the stuff which depends on actual
18435 window contents (such as %l) may fail to render properly, or
18436 even crash emacs.) */
18437 if (mode_line_target
== MODE_LINE_TITLE
)
18441 int col
= (int) current_column (); /* iftc */
18442 w
->column_number_displayed
= make_number (col
);
18443 pint2str (decode_mode_spec_buf
, field_width
, col
);
18444 return decode_mode_spec_buf
;
18448 #ifndef SYSTEM_MALLOC
18450 if (NILP (Vmemory_full
))
18453 return "!MEM FULL! ";
18460 /* %F displays the frame name. */
18461 if (!NILP (f
->title
))
18462 return (char *) SDATA (f
->title
);
18463 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18464 return (char *) SDATA (f
->name
);
18473 int size
= ZV
- BEGV
;
18474 pint2str (decode_mode_spec_buf
, field_width
, size
);
18475 return decode_mode_spec_buf
;
18480 int size
= ZV
- BEGV
;
18481 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18482 return decode_mode_spec_buf
;
18487 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18488 int topline
, nlines
, junk
, height
;
18490 /* %c and %l are ignored in `frame-title-format'. */
18491 if (mode_line_target
== MODE_LINE_TITLE
)
18494 startpos
= XMARKER (w
->start
)->charpos
;
18495 startpos_byte
= marker_byte_position (w
->start
);
18496 height
= WINDOW_TOTAL_LINES (w
);
18498 /* If we decided that this buffer isn't suitable for line numbers,
18499 don't forget that too fast. */
18500 if (EQ (w
->base_line_pos
, w
->buffer
))
18502 /* But do forget it, if the window shows a different buffer now. */
18503 else if (BUFFERP (w
->base_line_pos
))
18504 w
->base_line_pos
= Qnil
;
18506 /* If the buffer is very big, don't waste time. */
18507 if (INTEGERP (Vline_number_display_limit
)
18508 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18510 w
->base_line_pos
= Qnil
;
18511 w
->base_line_number
= Qnil
;
18515 if (INTEGERP (w
->base_line_number
)
18516 && INTEGERP (w
->base_line_pos
)
18517 && XFASTINT (w
->base_line_pos
) <= startpos
)
18519 line
= XFASTINT (w
->base_line_number
);
18520 linepos
= XFASTINT (w
->base_line_pos
);
18521 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18526 linepos
= BUF_BEGV (b
);
18527 linepos_byte
= BUF_BEGV_BYTE (b
);
18530 /* Count lines from base line to window start position. */
18531 nlines
= display_count_lines (linepos
, linepos_byte
,
18535 topline
= nlines
+ line
;
18537 /* Determine a new base line, if the old one is too close
18538 or too far away, or if we did not have one.
18539 "Too close" means it's plausible a scroll-down would
18540 go back past it. */
18541 if (startpos
== BUF_BEGV (b
))
18543 w
->base_line_number
= make_number (topline
);
18544 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18546 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18547 || linepos
== BUF_BEGV (b
))
18549 int limit
= BUF_BEGV (b
);
18550 int limit_byte
= BUF_BEGV_BYTE (b
);
18552 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18554 if (startpos
- distance
> limit
)
18556 limit
= startpos
- distance
;
18557 limit_byte
= CHAR_TO_BYTE (limit
);
18560 nlines
= display_count_lines (startpos
, startpos_byte
,
18562 - (height
* 2 + 30),
18564 /* If we couldn't find the lines we wanted within
18565 line_number_display_limit_width chars per line,
18566 give up on line numbers for this window. */
18567 if (position
== limit_byte
&& limit
== startpos
- distance
)
18569 w
->base_line_pos
= w
->buffer
;
18570 w
->base_line_number
= Qnil
;
18574 w
->base_line_number
= make_number (topline
- nlines
);
18575 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18578 /* Now count lines from the start pos to point. */
18579 nlines
= display_count_lines (startpos
, startpos_byte
,
18580 PT_BYTE
, PT
, &junk
);
18582 /* Record that we did display the line number. */
18583 line_number_displayed
= 1;
18585 /* Make the string to show. */
18586 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18587 return decode_mode_spec_buf
;
18590 char* p
= decode_mode_spec_buf
;
18591 int pad
= field_width
- 2;
18597 return decode_mode_spec_buf
;
18603 obj
= b
->mode_name
;
18607 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18613 int pos
= marker_position (w
->start
);
18614 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18616 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18618 if (pos
<= BUF_BEGV (b
))
18623 else if (pos
<= BUF_BEGV (b
))
18627 if (total
> 1000000)
18628 /* Do it differently for a large value, to avoid overflow. */
18629 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18631 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18632 /* We can't normally display a 3-digit number,
18633 so get us a 2-digit number that is close. */
18636 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18637 return decode_mode_spec_buf
;
18641 /* Display percentage of size above the bottom of the screen. */
18644 int toppos
= marker_position (w
->start
);
18645 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18646 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18648 if (botpos
>= BUF_ZV (b
))
18650 if (toppos
<= BUF_BEGV (b
))
18657 if (total
> 1000000)
18658 /* Do it differently for a large value, to avoid overflow. */
18659 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18661 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18662 /* We can't normally display a 3-digit number,
18663 so get us a 2-digit number that is close. */
18666 if (toppos
<= BUF_BEGV (b
))
18667 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18669 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18670 return decode_mode_spec_buf
;
18675 /* status of process */
18676 obj
= Fget_buffer_process (Fcurrent_buffer ());
18678 return "no process";
18679 #ifdef subprocesses
18680 obj
= Fsymbol_name (Fprocess_status (obj
));
18687 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18694 case 't': /* indicate TEXT or BINARY */
18695 #ifdef MODE_LINE_BINARY_TEXT
18696 return MODE_LINE_BINARY_TEXT (b
);
18702 /* coding-system (not including end-of-line format) */
18704 /* coding-system (including end-of-line type) */
18706 int eol_flag
= (c
== 'Z');
18707 char *p
= decode_mode_spec_buf
;
18709 if (! FRAME_WINDOW_P (f
))
18711 /* No need to mention EOL here--the terminal never needs
18712 to do EOL conversion. */
18713 p
= decode_mode_spec_coding (CODING_ID_NAME
18714 (FRAME_KEYBOARD_CODING (f
)->id
),
18716 p
= decode_mode_spec_coding (CODING_ID_NAME
18717 (FRAME_TERMINAL_CODING (f
)->id
),
18720 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18723 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18724 #ifdef subprocesses
18725 obj
= Fget_buffer_process (Fcurrent_buffer ());
18726 if (PROCESSP (obj
))
18728 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18730 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18733 #endif /* subprocesses */
18736 return decode_mode_spec_buf
;
18742 *multibyte
= STRING_MULTIBYTE (obj
);
18743 return (char *) SDATA (obj
);
18750 /* Count up to COUNT lines starting from START / START_BYTE.
18751 But don't go beyond LIMIT_BYTE.
18752 Return the number of lines thus found (always nonnegative).
18754 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18757 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18758 int start
, start_byte
, limit_byte
, count
;
18761 register unsigned char *cursor
;
18762 unsigned char *base
;
18764 register int ceiling
;
18765 register unsigned char *ceiling_addr
;
18766 int orig_count
= count
;
18768 /* If we are not in selective display mode,
18769 check only for newlines. */
18770 int selective_display
= (!NILP (current_buffer
->selective_display
)
18771 && !INTEGERP (current_buffer
->selective_display
));
18775 while (start_byte
< limit_byte
)
18777 ceiling
= BUFFER_CEILING_OF (start_byte
);
18778 ceiling
= min (limit_byte
- 1, ceiling
);
18779 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18780 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18783 if (selective_display
)
18784 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18787 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18790 if (cursor
!= ceiling_addr
)
18794 start_byte
+= cursor
- base
+ 1;
18795 *byte_pos_ptr
= start_byte
;
18799 if (++cursor
== ceiling_addr
)
18805 start_byte
+= cursor
- base
;
18810 while (start_byte
> limit_byte
)
18812 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18813 ceiling
= max (limit_byte
, ceiling
);
18814 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18815 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18818 if (selective_display
)
18819 while (--cursor
!= ceiling_addr
18820 && *cursor
!= '\n' && *cursor
!= 015)
18823 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18826 if (cursor
!= ceiling_addr
)
18830 start_byte
+= cursor
- base
+ 1;
18831 *byte_pos_ptr
= start_byte
;
18832 /* When scanning backwards, we should
18833 not count the newline posterior to which we stop. */
18834 return - orig_count
- 1;
18840 /* Here we add 1 to compensate for the last decrement
18841 of CURSOR, which took it past the valid range. */
18842 start_byte
+= cursor
- base
+ 1;
18846 *byte_pos_ptr
= limit_byte
;
18849 return - orig_count
+ count
;
18850 return orig_count
- count
;
18856 /***********************************************************************
18858 ***********************************************************************/
18860 /* Display a NUL-terminated string, starting with index START.
18862 If STRING is non-null, display that C string. Otherwise, the Lisp
18863 string LISP_STRING is displayed.
18865 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18866 FACE_STRING. Display STRING or LISP_STRING with the face at
18867 FACE_STRING_POS in FACE_STRING:
18869 Display the string in the environment given by IT, but use the
18870 standard display table, temporarily.
18872 FIELD_WIDTH is the minimum number of output glyphs to produce.
18873 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18874 with spaces. If STRING has more characters, more than FIELD_WIDTH
18875 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18877 PRECISION is the maximum number of characters to output from
18878 STRING. PRECISION < 0 means don't truncate the string.
18880 This is roughly equivalent to printf format specifiers:
18882 FIELD_WIDTH PRECISION PRINTF
18883 ----------------------------------------
18889 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18890 display them, and < 0 means obey the current buffer's value of
18891 enable_multibyte_characters.
18893 Value is the number of columns displayed. */
18896 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18897 start
, it
, field_width
, precision
, max_x
, multibyte
)
18898 unsigned char *string
;
18899 Lisp_Object lisp_string
;
18900 Lisp_Object face_string
;
18901 EMACS_INT face_string_pos
;
18904 int field_width
, precision
, max_x
;
18907 int hpos_at_start
= it
->hpos
;
18908 int saved_face_id
= it
->face_id
;
18909 struct glyph_row
*row
= it
->glyph_row
;
18911 /* Initialize the iterator IT for iteration over STRING beginning
18912 with index START. */
18913 reseat_to_string (it
, string
, lisp_string
, start
,
18914 precision
, field_width
, multibyte
);
18916 /* If displaying STRING, set up the face of the iterator
18917 from LISP_STRING, if that's given. */
18918 if (STRINGP (face_string
))
18924 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18925 0, it
->region_beg_charpos
,
18926 it
->region_end_charpos
,
18927 &endptr
, it
->base_face_id
, 0);
18928 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18929 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18932 /* Set max_x to the maximum allowed X position. Don't let it go
18933 beyond the right edge of the window. */
18935 max_x
= it
->last_visible_x
;
18937 max_x
= min (max_x
, it
->last_visible_x
);
18939 /* Skip over display elements that are not visible. because IT->w is
18941 if (it
->current_x
< it
->first_visible_x
)
18942 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18943 MOVE_TO_POS
| MOVE_TO_X
);
18945 row
->ascent
= it
->max_ascent
;
18946 row
->height
= it
->max_ascent
+ it
->max_descent
;
18947 row
->phys_ascent
= it
->max_phys_ascent
;
18948 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18949 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18951 /* This condition is for the case that we are called with current_x
18952 past last_visible_x. */
18953 while (it
->current_x
< max_x
)
18955 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18957 /* Get the next display element. */
18958 if (!get_next_display_element (it
))
18961 /* Produce glyphs. */
18962 x_before
= it
->current_x
;
18963 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18964 PRODUCE_GLYPHS (it
);
18966 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18969 while (i
< nglyphs
)
18971 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18973 if (it
->line_wrap
!= TRUNCATE
18974 && x
+ glyph
->pixel_width
> max_x
)
18976 /* End of continued line or max_x reached. */
18977 if (CHAR_GLYPH_PADDING_P (*glyph
))
18979 /* A wide character is unbreakable. */
18980 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18981 it
->current_x
= x_before
;
18985 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18990 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18992 /* Glyph is at least partially visible. */
18994 if (x
< it
->first_visible_x
)
18995 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18999 /* Glyph is off the left margin of the display area.
19000 Should not happen. */
19004 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19005 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19006 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19007 row
->phys_height
= max (row
->phys_height
,
19008 it
->max_phys_ascent
+ it
->max_phys_descent
);
19009 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19010 it
->max_extra_line_spacing
);
19011 x
+= glyph
->pixel_width
;
19015 /* Stop if max_x reached. */
19019 /* Stop at line ends. */
19020 if (ITERATOR_AT_END_OF_LINE_P (it
))
19022 it
->continuation_lines_width
= 0;
19026 set_iterator_to_next (it
, 1);
19028 /* Stop if truncating at the right edge. */
19029 if (it
->line_wrap
== TRUNCATE
19030 && it
->current_x
>= it
->last_visible_x
)
19032 /* Add truncation mark, but don't do it if the line is
19033 truncated at a padding space. */
19034 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19036 if (!FRAME_WINDOW_P (it
->f
))
19040 if (it
->current_x
> it
->last_visible_x
)
19042 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19043 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19045 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19047 row
->used
[TEXT_AREA
] = i
;
19048 produce_special_glyphs (it
, IT_TRUNCATION
);
19051 produce_special_glyphs (it
, IT_TRUNCATION
);
19053 it
->glyph_row
->truncated_on_right_p
= 1;
19059 /* Maybe insert a truncation at the left. */
19060 if (it
->first_visible_x
19061 && IT_CHARPOS (*it
) > 0)
19063 if (!FRAME_WINDOW_P (it
->f
))
19064 insert_left_trunc_glyphs (it
);
19065 it
->glyph_row
->truncated_on_left_p
= 1;
19068 it
->face_id
= saved_face_id
;
19070 /* Value is number of columns displayed. */
19071 return it
->hpos
- hpos_at_start
;
19076 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19077 appears as an element of LIST or as the car of an element of LIST.
19078 If PROPVAL is a list, compare each element against LIST in that
19079 way, and return 1/2 if any element of PROPVAL is found in LIST.
19080 Otherwise return 0. This function cannot quit.
19081 The return value is 2 if the text is invisible but with an ellipsis
19082 and 1 if it's invisible and without an ellipsis. */
19085 invisible_p (propval
, list
)
19086 register Lisp_Object propval
;
19089 register Lisp_Object tail
, proptail
;
19091 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19093 register Lisp_Object tem
;
19095 if (EQ (propval
, tem
))
19097 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19098 return NILP (XCDR (tem
)) ? 1 : 2;
19101 if (CONSP (propval
))
19103 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19105 Lisp_Object propelt
;
19106 propelt
= XCAR (proptail
);
19107 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19109 register Lisp_Object tem
;
19111 if (EQ (propelt
, tem
))
19113 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19114 return NILP (XCDR (tem
)) ? 1 : 2;
19122 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19123 doc
: /* Non-nil if the property makes the text invisible.
19124 POS-OR-PROP can be a marker or number, in which case it is taken to be
19125 a position in the current buffer and the value of the `invisible' property
19126 is checked; or it can be some other value, which is then presumed to be the
19127 value of the `invisible' property of the text of interest.
19128 The non-nil value returned can be t for truly invisible text or something
19129 else if the text is replaced by an ellipsis. */)
19131 Lisp_Object pos_or_prop
;
19134 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19135 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19137 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19138 return (invis
== 0 ? Qnil
19140 : make_number (invis
));
19143 /* Calculate a width or height in pixels from a specification using
19144 the following elements:
19147 NUM - a (fractional) multiple of the default font width/height
19148 (NUM) - specifies exactly NUM pixels
19149 UNIT - a fixed number of pixels, see below.
19150 ELEMENT - size of a display element in pixels, see below.
19151 (NUM . SPEC) - equals NUM * SPEC
19152 (+ SPEC SPEC ...) - add pixel values
19153 (- SPEC SPEC ...) - subtract pixel values
19154 (- SPEC) - negate pixel value
19157 INT or FLOAT - a number constant
19158 SYMBOL - use symbol's (buffer local) variable binding.
19161 in - pixels per inch *)
19162 mm - pixels per 1/1000 meter *)
19163 cm - pixels per 1/100 meter *)
19164 width - width of current font in pixels.
19165 height - height of current font in pixels.
19167 *) using the ratio(s) defined in display-pixels-per-inch.
19171 left-fringe - left fringe width in pixels
19172 right-fringe - right fringe width in pixels
19174 left-margin - left margin width in pixels
19175 right-margin - right margin width in pixels
19177 scroll-bar - scroll-bar area width in pixels
19181 Pixels corresponding to 5 inches:
19184 Total width of non-text areas on left side of window (if scroll-bar is on left):
19185 '(space :width (+ left-fringe left-margin scroll-bar))
19187 Align to first text column (in header line):
19188 '(space :align-to 0)
19190 Align to middle of text area minus half the width of variable `my-image'
19191 containing a loaded image:
19192 '(space :align-to (0.5 . (- text my-image)))
19194 Width of left margin minus width of 1 character in the default font:
19195 '(space :width (- left-margin 1))
19197 Width of left margin minus width of 2 characters in the current font:
19198 '(space :width (- left-margin (2 . width)))
19200 Center 1 character over left-margin (in header line):
19201 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19203 Different ways to express width of left fringe plus left margin minus one pixel:
19204 '(space :width (- (+ left-fringe left-margin) (1)))
19205 '(space :width (+ left-fringe left-margin (- (1))))
19206 '(space :width (+ left-fringe left-margin (-1)))
19210 #define NUMVAL(X) \
19211 ((INTEGERP (X) || FLOATP (X)) \
19216 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19221 int width_p
, *align_to
;
19225 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19226 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19229 return OK_PIXELS (0);
19231 xassert (FRAME_LIVE_P (it
->f
));
19233 if (SYMBOLP (prop
))
19235 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19237 char *unit
= SDATA (SYMBOL_NAME (prop
));
19239 if (unit
[0] == 'i' && unit
[1] == 'n')
19241 else if (unit
[0] == 'm' && unit
[1] == 'm')
19243 else if (unit
[0] == 'c' && unit
[1] == 'm')
19250 #ifdef HAVE_WINDOW_SYSTEM
19251 if (FRAME_WINDOW_P (it
->f
)
19253 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19254 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19256 return OK_PIXELS (ppi
/ pixels
);
19259 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19260 || (CONSP (Vdisplay_pixels_per_inch
)
19262 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19263 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19265 return OK_PIXELS (ppi
/ pixels
);
19271 #ifdef HAVE_WINDOW_SYSTEM
19272 if (EQ (prop
, Qheight
))
19273 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19274 if (EQ (prop
, Qwidth
))
19275 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19277 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19278 return OK_PIXELS (1);
19281 if (EQ (prop
, Qtext
))
19282 return OK_PIXELS (width_p
19283 ? window_box_width (it
->w
, TEXT_AREA
)
19284 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19286 if (align_to
&& *align_to
< 0)
19289 if (EQ (prop
, Qleft
))
19290 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19291 if (EQ (prop
, Qright
))
19292 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19293 if (EQ (prop
, Qcenter
))
19294 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19295 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19296 if (EQ (prop
, Qleft_fringe
))
19297 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19298 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19299 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19300 if (EQ (prop
, Qright_fringe
))
19301 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19302 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19303 : window_box_right_offset (it
->w
, TEXT_AREA
));
19304 if (EQ (prop
, Qleft_margin
))
19305 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19306 if (EQ (prop
, Qright_margin
))
19307 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19308 if (EQ (prop
, Qscroll_bar
))
19309 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19311 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19312 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19313 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19318 if (EQ (prop
, Qleft_fringe
))
19319 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19320 if (EQ (prop
, Qright_fringe
))
19321 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19322 if (EQ (prop
, Qleft_margin
))
19323 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19324 if (EQ (prop
, Qright_margin
))
19325 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19326 if (EQ (prop
, Qscroll_bar
))
19327 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19330 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19333 if (INTEGERP (prop
) || FLOATP (prop
))
19335 int base_unit
= (width_p
19336 ? FRAME_COLUMN_WIDTH (it
->f
)
19337 : FRAME_LINE_HEIGHT (it
->f
));
19338 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19343 Lisp_Object car
= XCAR (prop
);
19344 Lisp_Object cdr
= XCDR (prop
);
19348 #ifdef HAVE_WINDOW_SYSTEM
19349 if (FRAME_WINDOW_P (it
->f
)
19350 && valid_image_p (prop
))
19352 int id
= lookup_image (it
->f
, prop
);
19353 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19355 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19358 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19364 while (CONSP (cdr
))
19366 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19367 font
, width_p
, align_to
))
19370 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19375 if (EQ (car
, Qminus
))
19377 return OK_PIXELS (pixels
);
19380 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19383 if (INTEGERP (car
) || FLOATP (car
))
19386 pixels
= XFLOATINT (car
);
19388 return OK_PIXELS (pixels
);
19389 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19390 font
, width_p
, align_to
))
19391 return OK_PIXELS (pixels
* fact
);
19402 /***********************************************************************
19404 ***********************************************************************/
19406 #ifdef HAVE_WINDOW_SYSTEM
19411 dump_glyph_string (s
)
19412 struct glyph_string
*s
;
19414 fprintf (stderr
, "glyph string\n");
19415 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19416 s
->x
, s
->y
, s
->width
, s
->height
);
19417 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19418 fprintf (stderr
, " hl = %d\n", s
->hl
);
19419 fprintf (stderr
, " left overhang = %d, right = %d\n",
19420 s
->left_overhang
, s
->right_overhang
);
19421 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19422 fprintf (stderr
, " extends to end of line = %d\n",
19423 s
->extends_to_end_of_line_p
);
19424 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19425 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19428 #endif /* GLYPH_DEBUG */
19430 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19431 of XChar2b structures for S; it can't be allocated in
19432 init_glyph_string because it must be allocated via `alloca'. W
19433 is the window on which S is drawn. ROW and AREA are the glyph row
19434 and area within the row from which S is constructed. START is the
19435 index of the first glyph structure covered by S. HL is a
19436 face-override for drawing S. */
19439 #define OPTIONAL_HDC(hdc) hdc,
19440 #define DECLARE_HDC(hdc) HDC hdc;
19441 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19442 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19445 #ifndef OPTIONAL_HDC
19446 #define OPTIONAL_HDC(hdc)
19447 #define DECLARE_HDC(hdc)
19448 #define ALLOCATE_HDC(hdc, f)
19449 #define RELEASE_HDC(hdc, f)
19453 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19454 struct glyph_string
*s
;
19458 struct glyph_row
*row
;
19459 enum glyph_row_area area
;
19461 enum draw_glyphs_face hl
;
19463 bzero (s
, sizeof *s
);
19465 s
->f
= XFRAME (w
->frame
);
19469 s
->display
= FRAME_X_DISPLAY (s
->f
);
19470 s
->window
= FRAME_X_WINDOW (s
->f
);
19471 s
->char2b
= char2b
;
19475 s
->first_glyph
= row
->glyphs
[area
] + start
;
19476 s
->height
= row
->height
;
19477 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19479 /* Display the internal border below the tool-bar window. */
19480 if (WINDOWP (s
->f
->tool_bar_window
)
19481 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19482 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19484 s
->ybase
= s
->y
+ row
->ascent
;
19488 /* Append the list of glyph strings with head H and tail T to the list
19489 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19492 append_glyph_string_lists (head
, tail
, h
, t
)
19493 struct glyph_string
**head
, **tail
;
19494 struct glyph_string
*h
, *t
;
19508 /* Prepend the list of glyph strings with head H and tail T to the
19509 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19513 prepend_glyph_string_lists (head
, tail
, h
, t
)
19514 struct glyph_string
**head
, **tail
;
19515 struct glyph_string
*h
, *t
;
19529 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19530 Set *HEAD and *TAIL to the resulting list. */
19533 append_glyph_string (head
, tail
, s
)
19534 struct glyph_string
**head
, **tail
;
19535 struct glyph_string
*s
;
19537 s
->next
= s
->prev
= NULL
;
19538 append_glyph_string_lists (head
, tail
, s
, s
);
19542 /* Get face and two-byte form of character C in face FACE_ID on frame
19543 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19544 means we want to display multibyte text. DISPLAY_P non-zero means
19545 make sure that X resources for the face returned are allocated.
19546 Value is a pointer to a realized face that is ready for display if
19547 DISPLAY_P is non-zero. */
19549 static INLINE
struct face
*
19550 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19554 int multibyte_p
, display_p
;
19556 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19560 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19562 if (code
!= FONT_INVALID_CODE
)
19563 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19565 STORE_XCHAR2B (char2b
, 0, 0);
19568 /* Make sure X resources of the face are allocated. */
19569 #ifdef HAVE_X_WINDOWS
19573 xassert (face
!= NULL
);
19574 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19581 /* Get face and two-byte form of character glyph GLYPH on frame F.
19582 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19583 a pointer to a realized face that is ready for display. */
19585 static INLINE
struct face
*
19586 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19588 struct glyph
*glyph
;
19594 xassert (glyph
->type
== CHAR_GLYPH
);
19595 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19602 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19604 if (code
!= FONT_INVALID_CODE
)
19605 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19607 STORE_XCHAR2B (char2b
, 0, 0);
19610 /* Make sure X resources of the face are allocated. */
19611 xassert (face
!= NULL
);
19612 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19617 /* Fill glyph string S with composition components specified by S->cmp.
19619 BASE_FACE is the base face of the composition.
19620 S->cmp_from is the index of the first component for S.
19622 OVERLAPS non-zero means S should draw the foreground only, and use
19623 its physical height for clipping. See also draw_glyphs.
19625 Value is the index of a component not in S. */
19628 fill_composite_glyph_string (s
, base_face
, overlaps
)
19629 struct glyph_string
*s
;
19630 struct face
*base_face
;
19634 /* For all glyphs of this composition, starting at the offset
19635 S->cmp_from, until we reach the end of the definition or encounter a
19636 glyph that requires the different face, add it to S. */
19641 s
->for_overlaps
= overlaps
;
19644 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
19646 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19650 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19653 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19654 s
->char2b
+ i
, 1, 1);
19660 s
->font
= s
->face
->font
;
19662 else if (s
->face
!= face
)
19670 /* All glyph strings for the same composition has the same width,
19671 i.e. the width set for the first component of the composition. */
19672 s
->width
= s
->first_glyph
->pixel_width
;
19674 /* If the specified font could not be loaded, use the frame's
19675 default font, but record the fact that we couldn't load it in
19676 the glyph string so that we can draw rectangles for the
19677 characters of the glyph string. */
19678 if (s
->font
== NULL
)
19680 s
->font_not_found_p
= 1;
19681 s
->font
= FRAME_FONT (s
->f
);
19684 /* Adjust base line for subscript/superscript text. */
19685 s
->ybase
+= s
->first_glyph
->voffset
;
19687 /* This glyph string must always be drawn with 16-bit functions. */
19694 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
19695 struct glyph_string
*s
;
19697 int start
, end
, overlaps
;
19699 struct glyph
*glyph
, *last
;
19700 Lisp_Object lgstring
;
19703 s
->for_overlaps
= overlaps
;
19704 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19705 last
= s
->row
->glyphs
[s
->area
] + end
;
19706 s
->cmp_id
= glyph
->u
.cmp
.id
;
19707 s
->cmp_from
= glyph
->u
.cmp
.from
;
19708 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
19709 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19710 lgstring
= composition_gstring_from_id (s
->cmp_id
);
19711 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
19713 while (glyph
< last
19714 && glyph
->u
.cmp
.automatic
19715 && glyph
->u
.cmp
.id
== s
->cmp_id
19716 && s
->cmp_to
== glyph
->u
.cmp
.from
)
19717 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
19719 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
19721 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
19722 unsigned code
= LGLYPH_CODE (lglyph
);
19724 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
19726 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
19727 return glyph
- s
->row
->glyphs
[s
->area
];
19731 /* Fill glyph string S from a sequence of character glyphs.
19733 FACE_ID is the face id of the string. START is the index of the
19734 first glyph to consider, END is the index of the last + 1.
19735 OVERLAPS non-zero means S should draw the foreground only, and use
19736 its physical height for clipping. See also draw_glyphs.
19738 Value is the index of the first glyph not in S. */
19741 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19742 struct glyph_string
*s
;
19744 int start
, end
, overlaps
;
19746 struct glyph
*glyph
, *last
;
19748 int glyph_not_available_p
;
19750 xassert (s
->f
== XFRAME (s
->w
->frame
));
19751 xassert (s
->nchars
== 0);
19752 xassert (start
>= 0 && end
> start
);
19754 s
->for_overlaps
= overlaps
;
19755 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19756 last
= s
->row
->glyphs
[s
->area
] + end
;
19757 voffset
= glyph
->voffset
;
19758 s
->padding_p
= glyph
->padding_p
;
19759 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19761 while (glyph
< last
19762 && glyph
->type
== CHAR_GLYPH
19763 && glyph
->voffset
== voffset
19764 /* Same face id implies same font, nowadays. */
19765 && glyph
->face_id
== face_id
19766 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19770 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19771 s
->char2b
+ s
->nchars
,
19773 s
->two_byte_p
= two_byte_p
;
19775 xassert (s
->nchars
<= end
- start
);
19776 s
->width
+= glyph
->pixel_width
;
19777 if (glyph
++->padding_p
!= s
->padding_p
)
19781 s
->font
= s
->face
->font
;
19783 /* If the specified font could not be loaded, use the frame's font,
19784 but record the fact that we couldn't load it in
19785 S->font_not_found_p so that we can draw rectangles for the
19786 characters of the glyph string. */
19787 if (s
->font
== NULL
|| glyph_not_available_p
)
19789 s
->font_not_found_p
= 1;
19790 s
->font
= FRAME_FONT (s
->f
);
19793 /* Adjust base line for subscript/superscript text. */
19794 s
->ybase
+= voffset
;
19796 xassert (s
->face
&& s
->face
->gc
);
19797 return glyph
- s
->row
->glyphs
[s
->area
];
19801 /* Fill glyph string S from image glyph S->first_glyph. */
19804 fill_image_glyph_string (s
)
19805 struct glyph_string
*s
;
19807 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19808 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19810 s
->slice
= s
->first_glyph
->slice
;
19811 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19812 s
->font
= s
->face
->font
;
19813 s
->width
= s
->first_glyph
->pixel_width
;
19815 /* Adjust base line for subscript/superscript text. */
19816 s
->ybase
+= s
->first_glyph
->voffset
;
19820 /* Fill glyph string S from a sequence of stretch glyphs.
19822 ROW is the glyph row in which the glyphs are found, AREA is the
19823 area within the row. START is the index of the first glyph to
19824 consider, END is the index of the last + 1.
19826 Value is the index of the first glyph not in S. */
19829 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19830 struct glyph_string
*s
;
19831 struct glyph_row
*row
;
19832 enum glyph_row_area area
;
19835 struct glyph
*glyph
, *last
;
19836 int voffset
, face_id
;
19838 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19840 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19841 last
= s
->row
->glyphs
[s
->area
] + end
;
19842 face_id
= glyph
->face_id
;
19843 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19844 s
->font
= s
->face
->font
;
19845 s
->width
= glyph
->pixel_width
;
19847 voffset
= glyph
->voffset
;
19851 && glyph
->type
== STRETCH_GLYPH
19852 && glyph
->voffset
== voffset
19853 && glyph
->face_id
== face_id
);
19855 s
->width
+= glyph
->pixel_width
;
19857 /* Adjust base line for subscript/superscript text. */
19858 s
->ybase
+= voffset
;
19860 /* The case that face->gc == 0 is handled when drawing the glyph
19861 string by calling PREPARE_FACE_FOR_DISPLAY. */
19863 return glyph
- s
->row
->glyphs
[s
->area
];
19866 static struct font_metrics
*
19867 get_per_char_metric (f
, font
, char2b
)
19872 static struct font_metrics metrics
;
19873 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19875 if (! font
|| code
== FONT_INVALID_CODE
)
19877 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19882 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19883 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19884 assumed to be zero. */
19887 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19888 struct glyph
*glyph
;
19892 *left
= *right
= 0;
19894 if (glyph
->type
== CHAR_GLYPH
)
19898 struct font_metrics
*pcm
;
19900 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19901 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19903 if (pcm
->rbearing
> pcm
->width
)
19904 *right
= pcm
->rbearing
- pcm
->width
;
19905 if (pcm
->lbearing
< 0)
19906 *left
= -pcm
->lbearing
;
19909 else if (glyph
->type
== COMPOSITE_GLYPH
)
19911 if (! glyph
->u
.cmp
.automatic
)
19913 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
19915 if (cmp
->rbearing
- cmp
->pixel_width
)
19916 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19917 if (cmp
->lbearing
< 0);
19918 *left
= - cmp
->lbearing
;
19922 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
19923 struct font_metrics metrics
;
19925 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
19926 glyph
->u
.cmp
.to
+ 1, &metrics
);
19927 if (metrics
.rbearing
> metrics
.width
)
19928 *right
= metrics
.rbearing
;
19929 if (metrics
.lbearing
< 0)
19930 *left
= - metrics
.lbearing
;
19936 /* Return the index of the first glyph preceding glyph string S that
19937 is overwritten by S because of S's left overhang. Value is -1
19938 if no glyphs are overwritten. */
19941 left_overwritten (s
)
19942 struct glyph_string
*s
;
19946 if (s
->left_overhang
)
19949 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19950 int first
= s
->first_glyph
- glyphs
;
19952 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19953 x
-= glyphs
[i
].pixel_width
;
19964 /* Return the index of the first glyph preceding glyph string S that
19965 is overwriting S because of its right overhang. Value is -1 if no
19966 glyph in front of S overwrites S. */
19969 left_overwriting (s
)
19970 struct glyph_string
*s
;
19973 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19974 int first
= s
->first_glyph
- glyphs
;
19978 for (i
= first
- 1; i
>= 0; --i
)
19981 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19984 x
-= glyphs
[i
].pixel_width
;
19991 /* Return the index of the last glyph following glyph string S that is
19992 overwritten by S because of S's right overhang. Value is -1 if
19993 no such glyph is found. */
19996 right_overwritten (s
)
19997 struct glyph_string
*s
;
20001 if (s
->right_overhang
)
20004 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20005 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20006 int end
= s
->row
->used
[s
->area
];
20008 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20009 x
+= glyphs
[i
].pixel_width
;
20018 /* Return the index of the last glyph following glyph string S that
20019 overwrites S because of its left overhang. Value is negative
20020 if no such glyph is found. */
20023 right_overwriting (s
)
20024 struct glyph_string
*s
;
20027 int end
= s
->row
->used
[s
->area
];
20028 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20029 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20033 for (i
= first
; i
< end
; ++i
)
20036 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20039 x
+= glyphs
[i
].pixel_width
;
20046 /* Set background width of glyph string S. START is the index of the
20047 first glyph following S. LAST_X is the right-most x-position + 1
20048 in the drawing area. */
20051 set_glyph_string_background_width (s
, start
, last_x
)
20052 struct glyph_string
*s
;
20056 /* If the face of this glyph string has to be drawn to the end of
20057 the drawing area, set S->extends_to_end_of_line_p. */
20059 if (start
== s
->row
->used
[s
->area
]
20060 && s
->area
== TEXT_AREA
20061 && ((s
->row
->fill_line_p
20062 && (s
->hl
== DRAW_NORMAL_TEXT
20063 || s
->hl
== DRAW_IMAGE_RAISED
20064 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20065 || s
->hl
== DRAW_MOUSE_FACE
))
20066 s
->extends_to_end_of_line_p
= 1;
20068 /* If S extends its face to the end of the line, set its
20069 background_width to the distance to the right edge of the drawing
20071 if (s
->extends_to_end_of_line_p
)
20072 s
->background_width
= last_x
- s
->x
+ 1;
20074 s
->background_width
= s
->width
;
20078 /* Compute overhangs and x-positions for glyph string S and its
20079 predecessors, or successors. X is the starting x-position for S.
20080 BACKWARD_P non-zero means process predecessors. */
20083 compute_overhangs_and_x (s
, x
, backward_p
)
20084 struct glyph_string
*s
;
20092 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20093 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20103 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20104 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20114 /* The following macros are only called from draw_glyphs below.
20115 They reference the following parameters of that function directly:
20116 `w', `row', `area', and `overlap_p'
20117 as well as the following local variables:
20118 `s', `f', and `hdc' (in W32) */
20121 /* On W32, silently add local `hdc' variable to argument list of
20122 init_glyph_string. */
20123 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20124 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20126 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20127 init_glyph_string (s, char2b, w, row, area, start, hl)
20130 /* Add a glyph string for a stretch glyph to the list of strings
20131 between HEAD and TAIL. START is the index of the stretch glyph in
20132 row area AREA of glyph row ROW. END is the index of the last glyph
20133 in that glyph row area. X is the current output position assigned
20134 to the new glyph string constructed. HL overrides that face of the
20135 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20136 is the right-most x-position of the drawing area. */
20138 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20139 and below -- keep them on one line. */
20140 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20143 s = (struct glyph_string *) alloca (sizeof *s); \
20144 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20145 START = fill_stretch_glyph_string (s, row, area, START, END); \
20146 append_glyph_string (&HEAD, &TAIL, s); \
20152 /* Add a glyph string for an image glyph to the list of strings
20153 between HEAD and TAIL. START is the index of the image glyph in
20154 row area AREA of glyph row ROW. END is the index of the last glyph
20155 in that glyph row area. X is the current output position assigned
20156 to the new glyph string constructed. HL overrides that face of the
20157 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20158 is the right-most x-position of the drawing area. */
20160 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20163 s = (struct glyph_string *) alloca (sizeof *s); \
20164 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20165 fill_image_glyph_string (s); \
20166 append_glyph_string (&HEAD, &TAIL, s); \
20173 /* Add a glyph string for a sequence of character glyphs to the list
20174 of strings between HEAD and TAIL. START is the index of the first
20175 glyph in row area AREA of glyph row ROW that is part of the new
20176 glyph string. END is the index of the last glyph in that glyph row
20177 area. X is the current output position assigned to the new glyph
20178 string constructed. HL overrides that face of the glyph; e.g. it
20179 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20180 right-most x-position of the drawing area. */
20182 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20188 face_id = (row)->glyphs[area][START].face_id; \
20190 s = (struct glyph_string *) alloca (sizeof *s); \
20191 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20192 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20193 append_glyph_string (&HEAD, &TAIL, s); \
20195 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20200 /* Add a glyph string for a composite sequence to the list of strings
20201 between HEAD and TAIL. START is the index of the first glyph in
20202 row area AREA of glyph row ROW that is part of the new glyph
20203 string. END is the index of the last glyph in that glyph row area.
20204 X is the current output position assigned to the new glyph string
20205 constructed. HL overrides that face of the glyph; e.g. it is
20206 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20207 x-position of the drawing area. */
20209 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20211 int face_id = (row)->glyphs[area][START].face_id; \
20212 struct face *base_face = FACE_FROM_ID (f, face_id); \
20213 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20214 struct composition *cmp = composition_table[cmp_id]; \
20216 struct glyph_string *first_s; \
20219 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20221 /* Make glyph_strings for each glyph sequence that is drawable by \
20222 the same face, and append them to HEAD/TAIL. */ \
20223 for (n = 0; n < cmp->glyph_len;) \
20225 s = (struct glyph_string *) alloca (sizeof *s); \
20226 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20227 append_glyph_string (&(HEAD), &(TAIL), s); \
20233 n = fill_composite_glyph_string (s, base_face, overlaps); \
20241 /* Add a glyph string for a glyph-string sequence to the list of strings
20242 between HEAD and TAIL. */
20244 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20248 Lisp_Object gstring; \
20250 face_id = (row)->glyphs[area][START].face_id; \
20251 gstring = (composition_gstring_from_id \
20252 ((row)->glyphs[area][START].u.cmp.id)); \
20253 s = (struct glyph_string *) alloca (sizeof *s); \
20254 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20255 * LGSTRING_GLYPH_LEN (gstring)); \
20256 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20257 append_glyph_string (&(HEAD), &(TAIL), s); \
20259 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20263 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20264 of AREA of glyph row ROW on window W between indices START and END.
20265 HL overrides the face for drawing glyph strings, e.g. it is
20266 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20267 x-positions of the drawing area.
20269 This is an ugly monster macro construct because we must use alloca
20270 to allocate glyph strings (because draw_glyphs can be called
20271 asynchronously). */
20273 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20276 HEAD = TAIL = NULL; \
20277 while (START < END) \
20279 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20280 switch (first_glyph->type) \
20283 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20287 case COMPOSITE_GLYPH: \
20288 if (first_glyph->u.cmp.automatic) \
20289 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
20292 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20296 case STRETCH_GLYPH: \
20297 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20301 case IMAGE_GLYPH: \
20302 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20312 set_glyph_string_background_width (s, START, LAST_X); \
20319 /* Draw glyphs between START and END in AREA of ROW on window W,
20320 starting at x-position X. X is relative to AREA in W. HL is a
20321 face-override with the following meaning:
20323 DRAW_NORMAL_TEXT draw normally
20324 DRAW_CURSOR draw in cursor face
20325 DRAW_MOUSE_FACE draw in mouse face.
20326 DRAW_INVERSE_VIDEO draw in mode line face
20327 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20328 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20330 If OVERLAPS is non-zero, draw only the foreground of characters and
20331 clip to the physical height of ROW. Non-zero value also defines
20332 the overlapping part to be drawn:
20334 OVERLAPS_PRED overlap with preceding rows
20335 OVERLAPS_SUCC overlap with succeeding rows
20336 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20337 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20339 Value is the x-position reached, relative to AREA of W. */
20342 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20345 struct glyph_row
*row
;
20346 enum glyph_row_area area
;
20347 EMACS_INT start
, end
;
20348 enum draw_glyphs_face hl
;
20351 struct glyph_string
*head
, *tail
;
20352 struct glyph_string
*s
;
20353 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20354 int i
, j
, x_reached
, last_x
, area_left
= 0;
20355 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20358 ALLOCATE_HDC (hdc
, f
);
20360 /* Let's rather be paranoid than getting a SEGV. */
20361 end
= min (end
, row
->used
[area
]);
20362 start
= max (0, start
);
20363 start
= min (end
, start
);
20365 /* Translate X to frame coordinates. Set last_x to the right
20366 end of the drawing area. */
20367 if (row
->full_width_p
)
20369 /* X is relative to the left edge of W, without scroll bars
20371 area_left
= WINDOW_LEFT_EDGE_X (w
);
20372 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20376 area_left
= window_box_left (w
, area
);
20377 last_x
= area_left
+ window_box_width (w
, area
);
20381 /* Build a doubly-linked list of glyph_string structures between
20382 head and tail from what we have to draw. Note that the macro
20383 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20384 the reason we use a separate variable `i'. */
20386 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20388 x_reached
= tail
->x
+ tail
->background_width
;
20392 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20393 the row, redraw some glyphs in front or following the glyph
20394 strings built above. */
20395 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20397 struct glyph_string
*h
, *t
;
20398 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20399 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20402 /* If mouse highlighting is on, we may need to draw adjacent
20403 glyphs using mouse-face highlighting. */
20404 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20406 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20408 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20409 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20411 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20413 check_mouse_face
= 1;
20414 mouse_beg_col
= (row
== mouse_beg_row
)
20415 ? dpyinfo
->mouse_face_beg_col
: 0;
20416 mouse_end_col
= (row
== mouse_end_row
)
20417 ? dpyinfo
->mouse_face_end_col
20418 : row
->used
[TEXT_AREA
];
20422 /* Compute overhangs for all glyph strings. */
20423 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20424 for (s
= head
; s
; s
= s
->next
)
20425 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20427 /* Prepend glyph strings for glyphs in front of the first glyph
20428 string that are overwritten because of the first glyph
20429 string's left overhang. The background of all strings
20430 prepended must be drawn because the first glyph string
20432 i
= left_overwritten (head
);
20435 enum draw_glyphs_face overlap_hl
;
20437 /* If this row contains mouse highlighting, attempt to draw
20438 the overlapped glyphs with the correct highlight. This
20439 code fails if the overlap encompasses more than one glyph
20440 and mouse-highlight spans only some of these glyphs.
20441 However, making it work perfectly involves a lot more
20442 code, and I don't know if the pathological case occurs in
20443 practice, so we'll stick to this for now. --- cyd */
20444 if (check_mouse_face
20445 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20446 overlap_hl
= DRAW_MOUSE_FACE
;
20448 overlap_hl
= DRAW_NORMAL_TEXT
;
20451 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20452 overlap_hl
, dummy_x
, last_x
);
20453 compute_overhangs_and_x (t
, head
->x
, 1);
20454 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20458 /* Prepend glyph strings for glyphs in front of the first glyph
20459 string that overwrite that glyph string because of their
20460 right overhang. For these strings, only the foreground must
20461 be drawn, because it draws over the glyph string at `head'.
20462 The background must not be drawn because this would overwrite
20463 right overhangs of preceding glyphs for which no glyph
20465 i
= left_overwriting (head
);
20468 enum draw_glyphs_face overlap_hl
;
20470 if (check_mouse_face
20471 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20472 overlap_hl
= DRAW_MOUSE_FACE
;
20474 overlap_hl
= DRAW_NORMAL_TEXT
;
20477 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20478 overlap_hl
, dummy_x
, last_x
);
20479 for (s
= h
; s
; s
= s
->next
)
20480 s
->background_filled_p
= 1;
20481 compute_overhangs_and_x (t
, head
->x
, 1);
20482 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20485 /* Append glyphs strings for glyphs following the last glyph
20486 string tail that are overwritten by tail. The background of
20487 these strings has to be drawn because tail's foreground draws
20489 i
= right_overwritten (tail
);
20492 enum draw_glyphs_face overlap_hl
;
20494 if (check_mouse_face
20495 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20496 overlap_hl
= DRAW_MOUSE_FACE
;
20498 overlap_hl
= DRAW_NORMAL_TEXT
;
20500 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20501 overlap_hl
, x
, last_x
);
20502 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20503 append_glyph_string_lists (&head
, &tail
, h
, t
);
20507 /* Append glyph strings for glyphs following the last glyph
20508 string tail that overwrite tail. The foreground of such
20509 glyphs has to be drawn because it writes into the background
20510 of tail. The background must not be drawn because it could
20511 paint over the foreground of following glyphs. */
20512 i
= right_overwriting (tail
);
20515 enum draw_glyphs_face overlap_hl
;
20516 if (check_mouse_face
20517 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20518 overlap_hl
= DRAW_MOUSE_FACE
;
20520 overlap_hl
= DRAW_NORMAL_TEXT
;
20523 i
++; /* We must include the Ith glyph. */
20524 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20525 overlap_hl
, x
, last_x
);
20526 for (s
= h
; s
; s
= s
->next
)
20527 s
->background_filled_p
= 1;
20528 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20529 append_glyph_string_lists (&head
, &tail
, h
, t
);
20531 if (clip_head
|| clip_tail
)
20532 for (s
= head
; s
; s
= s
->next
)
20534 s
->clip_head
= clip_head
;
20535 s
->clip_tail
= clip_tail
;
20539 /* Draw all strings. */
20540 for (s
= head
; s
; s
= s
->next
)
20541 FRAME_RIF (f
)->draw_glyph_string (s
);
20544 /* When focus a sole frame and move horizontally, this sets on_p to 0
20545 causing a failure to erase prev cursor position. */
20546 if (area
== TEXT_AREA
20547 && !row
->full_width_p
20548 /* When drawing overlapping rows, only the glyph strings'
20549 foreground is drawn, which doesn't erase a cursor
20553 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20554 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20555 : (tail
? tail
->x
+ tail
->background_width
: x
));
20559 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20560 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20564 /* Value is the x-position up to which drawn, relative to AREA of W.
20565 This doesn't include parts drawn because of overhangs. */
20566 if (row
->full_width_p
)
20567 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20569 x_reached
-= area_left
;
20571 RELEASE_HDC (hdc
, f
);
20576 /* Expand row matrix if too narrow. Don't expand if area
20579 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20581 if (!fonts_changed_p \
20582 && (it->glyph_row->glyphs[area] \
20583 < it->glyph_row->glyphs[area + 1])) \
20585 it->w->ncols_scale_factor++; \
20586 fonts_changed_p = 1; \
20590 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20591 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20597 struct glyph
*glyph
;
20598 enum glyph_row_area area
= it
->area
;
20600 xassert (it
->glyph_row
);
20601 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20603 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20604 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20606 glyph
->charpos
= CHARPOS (it
->position
);
20607 glyph
->object
= it
->object
;
20608 if (it
->pixel_width
> 0)
20610 glyph
->pixel_width
= it
->pixel_width
;
20611 glyph
->padding_p
= 0;
20615 /* Assure at least 1-pixel width. Otherwise, cursor can't
20616 be displayed correctly. */
20617 glyph
->pixel_width
= 1;
20618 glyph
->padding_p
= 1;
20620 glyph
->ascent
= it
->ascent
;
20621 glyph
->descent
= it
->descent
;
20622 glyph
->voffset
= it
->voffset
;
20623 glyph
->type
= CHAR_GLYPH
;
20624 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20625 glyph
->multibyte_p
= it
->multibyte_p
;
20626 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20627 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20628 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20629 || it
->phys_descent
> it
->descent
);
20630 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20631 glyph
->face_id
= it
->face_id
;
20632 glyph
->u
.ch
= it
->char_to_display
;
20633 glyph
->slice
= null_glyph_slice
;
20634 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20635 ++it
->glyph_row
->used
[area
];
20638 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20641 /* Store one glyph for the composition IT->cmp_it.id in
20642 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
20646 append_composite_glyph (it
)
20649 struct glyph
*glyph
;
20650 enum glyph_row_area area
= it
->area
;
20652 xassert (it
->glyph_row
);
20654 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20655 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20657 glyph
->charpos
= CHARPOS (it
->position
);
20658 glyph
->object
= it
->object
;
20659 glyph
->pixel_width
= it
->pixel_width
;
20660 glyph
->ascent
= it
->ascent
;
20661 glyph
->descent
= it
->descent
;
20662 glyph
->voffset
= it
->voffset
;
20663 glyph
->type
= COMPOSITE_GLYPH
;
20664 if (it
->cmp_it
.ch
< 0)
20666 glyph
->u
.cmp
.automatic
= 0;
20667 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20671 glyph
->u
.cmp
.automatic
= 1;
20672 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20673 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
20674 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
20676 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20677 glyph
->multibyte_p
= it
->multibyte_p
;
20678 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20679 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20680 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20681 || it
->phys_descent
> it
->descent
);
20682 glyph
->padding_p
= 0;
20683 glyph
->glyph_not_available_p
= 0;
20684 glyph
->face_id
= it
->face_id
;
20685 glyph
->slice
= null_glyph_slice
;
20686 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20687 ++it
->glyph_row
->used
[area
];
20690 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20694 /* Change IT->ascent and IT->height according to the setting of
20698 take_vertical_position_into_account (it
)
20703 if (it
->voffset
< 0)
20704 /* Increase the ascent so that we can display the text higher
20706 it
->ascent
-= it
->voffset
;
20708 /* Increase the descent so that we can display the text lower
20710 it
->descent
+= it
->voffset
;
20715 /* Produce glyphs/get display metrics for the image IT is loaded with.
20716 See the description of struct display_iterator in dispextern.h for
20717 an overview of struct display_iterator. */
20720 produce_image_glyph (it
)
20725 int glyph_ascent
, crop
;
20726 struct glyph_slice slice
;
20728 xassert (it
->what
== IT_IMAGE
);
20730 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20732 /* Make sure X resources of the face is loaded. */
20733 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20735 if (it
->image_id
< 0)
20737 /* Fringe bitmap. */
20738 it
->ascent
= it
->phys_ascent
= 0;
20739 it
->descent
= it
->phys_descent
= 0;
20740 it
->pixel_width
= 0;
20745 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20747 /* Make sure X resources of the image is loaded. */
20748 prepare_image_for_display (it
->f
, img
);
20750 slice
.x
= slice
.y
= 0;
20751 slice
.width
= img
->width
;
20752 slice
.height
= img
->height
;
20754 if (INTEGERP (it
->slice
.x
))
20755 slice
.x
= XINT (it
->slice
.x
);
20756 else if (FLOATP (it
->slice
.x
))
20757 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20759 if (INTEGERP (it
->slice
.y
))
20760 slice
.y
= XINT (it
->slice
.y
);
20761 else if (FLOATP (it
->slice
.y
))
20762 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20764 if (INTEGERP (it
->slice
.width
))
20765 slice
.width
= XINT (it
->slice
.width
);
20766 else if (FLOATP (it
->slice
.width
))
20767 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20769 if (INTEGERP (it
->slice
.height
))
20770 slice
.height
= XINT (it
->slice
.height
);
20771 else if (FLOATP (it
->slice
.height
))
20772 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20774 if (slice
.x
>= img
->width
)
20775 slice
.x
= img
->width
;
20776 if (slice
.y
>= img
->height
)
20777 slice
.y
= img
->height
;
20778 if (slice
.x
+ slice
.width
>= img
->width
)
20779 slice
.width
= img
->width
- slice
.x
;
20780 if (slice
.y
+ slice
.height
> img
->height
)
20781 slice
.height
= img
->height
- slice
.y
;
20783 if (slice
.width
== 0 || slice
.height
== 0)
20786 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20788 it
->descent
= slice
.height
- glyph_ascent
;
20790 it
->descent
+= img
->vmargin
;
20791 if (slice
.y
+ slice
.height
== img
->height
)
20792 it
->descent
+= img
->vmargin
;
20793 it
->phys_descent
= it
->descent
;
20795 it
->pixel_width
= slice
.width
;
20797 it
->pixel_width
+= img
->hmargin
;
20798 if (slice
.x
+ slice
.width
== img
->width
)
20799 it
->pixel_width
+= img
->hmargin
;
20801 /* It's quite possible for images to have an ascent greater than
20802 their height, so don't get confused in that case. */
20803 if (it
->descent
< 0)
20806 #if 0 /* this breaks image tiling */
20807 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20808 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20809 if (face_ascent
> it
->ascent
)
20810 it
->ascent
= it
->phys_ascent
= face_ascent
;
20815 if (face
->box
!= FACE_NO_BOX
)
20817 if (face
->box_line_width
> 0)
20820 it
->ascent
+= face
->box_line_width
;
20821 if (slice
.y
+ slice
.height
== img
->height
)
20822 it
->descent
+= face
->box_line_width
;
20825 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20826 it
->pixel_width
+= eabs (face
->box_line_width
);
20827 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20828 it
->pixel_width
+= eabs (face
->box_line_width
);
20831 take_vertical_position_into_account (it
);
20833 /* Automatically crop wide image glyphs at right edge so we can
20834 draw the cursor on same display row. */
20835 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20836 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20838 it
->pixel_width
-= crop
;
20839 slice
.width
-= crop
;
20844 struct glyph
*glyph
;
20845 enum glyph_row_area area
= it
->area
;
20847 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20848 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20850 glyph
->charpos
= CHARPOS (it
->position
);
20851 glyph
->object
= it
->object
;
20852 glyph
->pixel_width
= it
->pixel_width
;
20853 glyph
->ascent
= glyph_ascent
;
20854 glyph
->descent
= it
->descent
;
20855 glyph
->voffset
= it
->voffset
;
20856 glyph
->type
= IMAGE_GLYPH
;
20857 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20858 glyph
->multibyte_p
= it
->multibyte_p
;
20859 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20860 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20861 glyph
->overlaps_vertically_p
= 0;
20862 glyph
->padding_p
= 0;
20863 glyph
->glyph_not_available_p
= 0;
20864 glyph
->face_id
= it
->face_id
;
20865 glyph
->u
.img_id
= img
->id
;
20866 glyph
->slice
= slice
;
20867 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20868 ++it
->glyph_row
->used
[area
];
20871 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20876 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20877 of the glyph, WIDTH and HEIGHT are the width and height of the
20878 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20881 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20883 Lisp_Object object
;
20887 struct glyph
*glyph
;
20888 enum glyph_row_area area
= it
->area
;
20890 xassert (ascent
>= 0 && ascent
<= height
);
20892 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20893 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20895 glyph
->charpos
= CHARPOS (it
->position
);
20896 glyph
->object
= object
;
20897 glyph
->pixel_width
= width
;
20898 glyph
->ascent
= ascent
;
20899 glyph
->descent
= height
- ascent
;
20900 glyph
->voffset
= it
->voffset
;
20901 glyph
->type
= STRETCH_GLYPH
;
20902 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20903 glyph
->multibyte_p
= it
->multibyte_p
;
20904 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20905 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20906 glyph
->overlaps_vertically_p
= 0;
20907 glyph
->padding_p
= 0;
20908 glyph
->glyph_not_available_p
= 0;
20909 glyph
->face_id
= it
->face_id
;
20910 glyph
->u
.stretch
.ascent
= ascent
;
20911 glyph
->u
.stretch
.height
= height
;
20912 glyph
->slice
= null_glyph_slice
;
20913 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20914 ++it
->glyph_row
->used
[area
];
20917 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20921 /* Produce a stretch glyph for iterator IT. IT->object is the value
20922 of the glyph property displayed. The value must be a list
20923 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20926 1. `:width WIDTH' specifies that the space should be WIDTH *
20927 canonical char width wide. WIDTH may be an integer or floating
20930 2. `:relative-width FACTOR' specifies that the width of the stretch
20931 should be computed from the width of the first character having the
20932 `glyph' property, and should be FACTOR times that width.
20934 3. `:align-to HPOS' specifies that the space should be wide enough
20935 to reach HPOS, a value in canonical character units.
20937 Exactly one of the above pairs must be present.
20939 4. `:height HEIGHT' specifies that the height of the stretch produced
20940 should be HEIGHT, measured in canonical character units.
20942 5. `:relative-height FACTOR' specifies that the height of the
20943 stretch should be FACTOR times the height of the characters having
20944 the glyph property.
20946 Either none or exactly one of 4 or 5 must be present.
20948 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20949 of the stretch should be used for the ascent of the stretch.
20950 ASCENT must be in the range 0 <= ASCENT <= 100. */
20953 produce_stretch_glyph (it
)
20956 /* (space :width WIDTH :height HEIGHT ...) */
20957 Lisp_Object prop
, plist
;
20958 int width
= 0, height
= 0, align_to
= -1;
20959 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20962 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20963 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20965 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20967 /* List should start with `space'. */
20968 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20969 plist
= XCDR (it
->object
);
20971 /* Compute the width of the stretch. */
20972 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20973 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20975 /* Absolute width `:width WIDTH' specified and valid. */
20976 zero_width_ok_p
= 1;
20979 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20982 /* Relative width `:relative-width FACTOR' specified and valid.
20983 Compute the width of the characters having the `glyph'
20986 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20989 if (it
->multibyte_p
)
20991 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20992 - IT_BYTEPOS (*it
));
20993 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20996 it2
.c
= *p
, it2
.len
= 1;
20998 it2
.glyph_row
= NULL
;
20999 it2
.what
= IT_CHARACTER
;
21000 x_produce_glyphs (&it2
);
21001 width
= NUMVAL (prop
) * it2
.pixel_width
;
21003 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21004 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21006 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21007 align_to
= (align_to
< 0
21009 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21010 else if (align_to
< 0)
21011 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21012 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21013 zero_width_ok_p
= 1;
21016 /* Nothing specified -> width defaults to canonical char width. */
21017 width
= FRAME_COLUMN_WIDTH (it
->f
);
21019 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21022 /* Compute height. */
21023 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21024 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21027 zero_height_ok_p
= 1;
21029 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21031 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21033 height
= FONT_HEIGHT (font
);
21035 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21038 /* Compute percentage of height used for ascent. If
21039 `:ascent ASCENT' is present and valid, use that. Otherwise,
21040 derive the ascent from the font in use. */
21041 if (prop
= Fplist_get (plist
, QCascent
),
21042 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21043 ascent
= height
* NUMVAL (prop
) / 100.0;
21044 else if (!NILP (prop
)
21045 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21046 ascent
= min (max (0, (int)tem
), height
);
21048 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21050 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21051 && it
->current_x
+ width
> it
->last_visible_x
)
21052 width
= it
->last_visible_x
- it
->current_x
- 1;
21054 if (width
> 0 && height
> 0 && it
->glyph_row
)
21056 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21057 if (!STRINGP (object
))
21058 object
= it
->w
->buffer
;
21059 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21062 it
->pixel_width
= width
;
21063 it
->ascent
= it
->phys_ascent
= ascent
;
21064 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21065 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21067 take_vertical_position_into_account (it
);
21070 /* Calculate line-height and line-spacing properties.
21071 An integer value specifies explicit pixel value.
21072 A float value specifies relative value to current face height.
21073 A cons (float . face-name) specifies relative value to
21074 height of specified face font.
21076 Returns height in pixels, or nil. */
21080 calc_line_height_property (it
, val
, font
, boff
, override
)
21084 int boff
, override
;
21086 Lisp_Object face_name
= Qnil
;
21087 int ascent
, descent
, height
;
21089 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21094 face_name
= XCAR (val
);
21096 if (!NUMBERP (val
))
21097 val
= make_number (1);
21098 if (NILP (face_name
))
21100 height
= it
->ascent
+ it
->descent
;
21105 if (NILP (face_name
))
21107 font
= FRAME_FONT (it
->f
);
21108 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21110 else if (EQ (face_name
, Qt
))
21119 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21121 return make_number (-1);
21123 face
= FACE_FROM_ID (it
->f
, face_id
);
21126 return make_number (-1);
21127 boff
= font
->baseline_offset
;
21128 if (font
->vertical_centering
)
21129 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21132 ascent
= FONT_BASE (font
) + boff
;
21133 descent
= FONT_DESCENT (font
) - boff
;
21137 it
->override_ascent
= ascent
;
21138 it
->override_descent
= descent
;
21139 it
->override_boff
= boff
;
21142 height
= ascent
+ descent
;
21146 height
= (int)(XFLOAT_DATA (val
) * height
);
21147 else if (INTEGERP (val
))
21148 height
*= XINT (val
);
21150 return make_number (height
);
21155 Produce glyphs/get display metrics for the display element IT is
21156 loaded with. See the description of struct it in dispextern.h
21157 for an overview of struct it. */
21160 x_produce_glyphs (it
)
21163 int extra_line_spacing
= it
->extra_line_spacing
;
21165 it
->glyph_not_available_p
= 0;
21167 if (it
->what
== IT_CHARACTER
)
21171 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21172 struct font_metrics
*pcm
;
21173 int font_not_found_p
;
21174 int boff
; /* baseline offset */
21175 /* We may change it->multibyte_p upon unibyte<->multibyte
21176 conversion. So, save the current value now and restore it
21179 Note: It seems that we don't have to record multibyte_p in
21180 struct glyph because the character code itself tells if or
21181 not the character is multibyte. Thus, in the future, we must
21182 consider eliminating the field `multibyte_p' in the struct
21184 int saved_multibyte_p
= it
->multibyte_p
;
21186 /* Maybe translate single-byte characters to multibyte, or the
21188 it
->char_to_display
= it
->c
;
21189 if (!ASCII_BYTE_P (it
->c
)
21190 && ! it
->multibyte_p
)
21192 if (SINGLE_BYTE_CHAR_P (it
->c
)
21193 && unibyte_display_via_language_environment
)
21194 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
21195 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
21197 it
->multibyte_p
= 1;
21198 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21200 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21204 /* Get font to use. Encode IT->char_to_display. */
21205 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21206 &char2b
, it
->multibyte_p
, 0);
21209 /* When no suitable font found, use the default font. */
21210 font_not_found_p
= font
== NULL
;
21211 if (font_not_found_p
)
21213 font
= FRAME_FONT (it
->f
);
21214 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21218 boff
= font
->baseline_offset
;
21219 if (font
->vertical_centering
)
21220 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21223 if (it
->char_to_display
>= ' '
21224 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21226 /* Either unibyte or ASCII. */
21231 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21233 if (it
->override_ascent
>= 0)
21235 it
->ascent
= it
->override_ascent
;
21236 it
->descent
= it
->override_descent
;
21237 boff
= it
->override_boff
;
21241 it
->ascent
= FONT_BASE (font
) + boff
;
21242 it
->descent
= FONT_DESCENT (font
) - boff
;
21247 it
->phys_ascent
= pcm
->ascent
+ boff
;
21248 it
->phys_descent
= pcm
->descent
- boff
;
21249 it
->pixel_width
= pcm
->width
;
21253 it
->glyph_not_available_p
= 1;
21254 it
->phys_ascent
= it
->ascent
;
21255 it
->phys_descent
= it
->descent
;
21256 it
->pixel_width
= FONT_WIDTH (font
);
21259 if (it
->constrain_row_ascent_descent_p
)
21261 if (it
->descent
> it
->max_descent
)
21263 it
->ascent
+= it
->descent
- it
->max_descent
;
21264 it
->descent
= it
->max_descent
;
21266 if (it
->ascent
> it
->max_ascent
)
21268 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21269 it
->ascent
= it
->max_ascent
;
21271 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21272 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21273 extra_line_spacing
= 0;
21276 /* If this is a space inside a region of text with
21277 `space-width' property, change its width. */
21278 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21280 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21282 /* If face has a box, add the box thickness to the character
21283 height. If character has a box line to the left and/or
21284 right, add the box line width to the character's width. */
21285 if (face
->box
!= FACE_NO_BOX
)
21287 int thick
= face
->box_line_width
;
21291 it
->ascent
+= thick
;
21292 it
->descent
+= thick
;
21297 if (it
->start_of_box_run_p
)
21298 it
->pixel_width
+= thick
;
21299 if (it
->end_of_box_run_p
)
21300 it
->pixel_width
+= thick
;
21303 /* If face has an overline, add the height of the overline
21304 (1 pixel) and a 1 pixel margin to the character height. */
21305 if (face
->overline_p
)
21306 it
->ascent
+= overline_margin
;
21308 if (it
->constrain_row_ascent_descent_p
)
21310 if (it
->ascent
> it
->max_ascent
)
21311 it
->ascent
= it
->max_ascent
;
21312 if (it
->descent
> it
->max_descent
)
21313 it
->descent
= it
->max_descent
;
21316 take_vertical_position_into_account (it
);
21318 /* If we have to actually produce glyphs, do it. */
21323 /* Translate a space with a `space-width' property
21324 into a stretch glyph. */
21325 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21326 / FONT_HEIGHT (font
));
21327 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21328 it
->ascent
+ it
->descent
, ascent
);
21333 /* If characters with lbearing or rbearing are displayed
21334 in this line, record that fact in a flag of the
21335 glyph row. This is used to optimize X output code. */
21336 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21337 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21339 if (! stretched_p
&& it
->pixel_width
== 0)
21340 /* We assure that all visible glyphs have at least 1-pixel
21342 it
->pixel_width
= 1;
21344 else if (it
->char_to_display
== '\n')
21346 /* A newline has no width but we need the height of the line.
21347 But if previous part of the line set a height, don't
21348 increase that height */
21350 Lisp_Object height
;
21351 Lisp_Object total_height
= Qnil
;
21353 it
->override_ascent
= -1;
21354 it
->pixel_width
= 0;
21357 height
= get_it_property(it
, Qline_height
);
21358 /* Split (line-height total-height) list */
21360 && CONSP (XCDR (height
))
21361 && NILP (XCDR (XCDR (height
))))
21363 total_height
= XCAR (XCDR (height
));
21364 height
= XCAR (height
);
21366 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21368 if (it
->override_ascent
>= 0)
21370 it
->ascent
= it
->override_ascent
;
21371 it
->descent
= it
->override_descent
;
21372 boff
= it
->override_boff
;
21376 it
->ascent
= FONT_BASE (font
) + boff
;
21377 it
->descent
= FONT_DESCENT (font
) - boff
;
21380 if (EQ (height
, Qt
))
21382 if (it
->descent
> it
->max_descent
)
21384 it
->ascent
+= it
->descent
- it
->max_descent
;
21385 it
->descent
= it
->max_descent
;
21387 if (it
->ascent
> it
->max_ascent
)
21389 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21390 it
->ascent
= it
->max_ascent
;
21392 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21393 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21394 it
->constrain_row_ascent_descent_p
= 1;
21395 extra_line_spacing
= 0;
21399 Lisp_Object spacing
;
21401 it
->phys_ascent
= it
->ascent
;
21402 it
->phys_descent
= it
->descent
;
21404 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21405 && face
->box
!= FACE_NO_BOX
21406 && face
->box_line_width
> 0)
21408 it
->ascent
+= face
->box_line_width
;
21409 it
->descent
+= face
->box_line_width
;
21412 && XINT (height
) > it
->ascent
+ it
->descent
)
21413 it
->ascent
= XINT (height
) - it
->descent
;
21415 if (!NILP (total_height
))
21416 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21419 spacing
= get_it_property(it
, Qline_spacing
);
21420 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21422 if (INTEGERP (spacing
))
21424 extra_line_spacing
= XINT (spacing
);
21425 if (!NILP (total_height
))
21426 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21430 else if (it
->char_to_display
== '\t')
21432 if (font
->space_width
> 0)
21434 int tab_width
= it
->tab_width
* font
->space_width
;
21435 int x
= it
->current_x
+ it
->continuation_lines_width
;
21436 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21438 /* If the distance from the current position to the next tab
21439 stop is less than a space character width, use the
21440 tab stop after that. */
21441 if (next_tab_x
- x
< font
->space_width
)
21442 next_tab_x
+= tab_width
;
21444 it
->pixel_width
= next_tab_x
- x
;
21446 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21447 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21451 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21452 it
->ascent
+ it
->descent
, it
->ascent
);
21457 it
->pixel_width
= 0;
21463 /* A multi-byte character. Assume that the display width of the
21464 character is the width of the character multiplied by the
21465 width of the font. */
21467 /* If we found a font, this font should give us the right
21468 metrics. If we didn't find a font, use the frame's
21469 default font and calculate the width of the character by
21470 multiplying the width of font by the width of the
21473 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21475 if (font_not_found_p
|| !pcm
)
21477 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21479 if (char_width
== 0)
21480 /* This is a non spacing character. But, as we are
21481 going to display an empty box, the box must occupy
21482 at least one column. */
21484 it
->glyph_not_available_p
= 1;
21485 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21486 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21487 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21491 it
->pixel_width
= pcm
->width
;
21492 it
->phys_ascent
= pcm
->ascent
+ boff
;
21493 it
->phys_descent
= pcm
->descent
- boff
;
21495 && (pcm
->lbearing
< 0
21496 || pcm
->rbearing
> pcm
->width
))
21497 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21500 it
->ascent
= FONT_BASE (font
) + boff
;
21501 it
->descent
= FONT_DESCENT (font
) - boff
;
21502 if (face
->box
!= FACE_NO_BOX
)
21504 int thick
= face
->box_line_width
;
21508 it
->ascent
+= thick
;
21509 it
->descent
+= thick
;
21514 if (it
->start_of_box_run_p
)
21515 it
->pixel_width
+= thick
;
21516 if (it
->end_of_box_run_p
)
21517 it
->pixel_width
+= thick
;
21520 /* If face has an overline, add the height of the overline
21521 (1 pixel) and a 1 pixel margin to the character height. */
21522 if (face
->overline_p
)
21523 it
->ascent
+= overline_margin
;
21525 take_vertical_position_into_account (it
);
21527 if (it
->ascent
< 0)
21529 if (it
->descent
< 0)
21534 if (it
->pixel_width
== 0)
21535 /* We assure that all visible glyphs have at least 1-pixel
21537 it
->pixel_width
= 1;
21539 it
->multibyte_p
= saved_multibyte_p
;
21541 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
21543 /* A static compositoin.
21545 Note: A composition is represented as one glyph in the
21546 glyph matrix. There are no padding glyphs.
21548 Important is that pixel_width, ascent, and descent are the
21549 values of what is drawn by draw_glyphs (i.e. the values of
21550 the overall glyphs composed). */
21551 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21552 int boff
; /* baseline offset */
21553 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
21554 int glyph_len
= cmp
->glyph_len
;
21555 struct font
*font
= face
->font
;
21559 /* If we have not yet calculated pixel size data of glyphs of
21560 the composition for the current face font, calculate them
21561 now. Theoretically, we have to check all fonts for the
21562 glyphs, but that requires much time and memory space. So,
21563 here we check only the font of the first glyph. This leads
21564 to incorrect display, but it's very rare, and C-l (recenter)
21565 can correct the display anyway. */
21566 if (! cmp
->font
|| cmp
->font
!= font
)
21568 /* Ascent and descent of the font of the first character
21569 of this composition (adjusted by baseline offset).
21570 Ascent and descent of overall glyphs should not be less
21571 than them respectively. */
21572 int font_ascent
, font_descent
, font_height
;
21573 /* Bounding box of the overall glyphs. */
21574 int leftmost
, rightmost
, lowest
, highest
;
21575 int lbearing
, rbearing
;
21576 int i
, width
, ascent
, descent
;
21577 int left_padded
= 0, right_padded
= 0;
21580 struct font_metrics
*pcm
;
21581 int font_not_found_p
;
21584 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21585 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21587 if (glyph_len
< cmp
->glyph_len
)
21589 for (i
= 0; i
< glyph_len
; i
++)
21591 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21593 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21598 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21599 : IT_CHARPOS (*it
));
21600 /* When no suitable font found, use the default font. */
21601 font_not_found_p
= font
== NULL
;
21602 if (font_not_found_p
)
21604 face
= face
->ascii_face
;
21607 boff
= font
->baseline_offset
;
21608 if (font
->vertical_centering
)
21609 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21610 font_ascent
= FONT_BASE (font
) + boff
;
21611 font_descent
= FONT_DESCENT (font
) - boff
;
21612 font_height
= FONT_HEIGHT (font
);
21614 cmp
->font
= (void *) font
;
21617 if (! font_not_found_p
)
21619 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21620 &char2b
, it
->multibyte_p
, 0);
21621 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21624 /* Initialize the bounding box. */
21627 width
= pcm
->width
;
21628 ascent
= pcm
->ascent
;
21629 descent
= pcm
->descent
;
21630 lbearing
= pcm
->lbearing
;
21631 rbearing
= pcm
->rbearing
;
21635 width
= FONT_WIDTH (font
);
21636 ascent
= FONT_BASE (font
);
21637 descent
= FONT_DESCENT (font
);
21644 lowest
= - descent
+ boff
;
21645 highest
= ascent
+ boff
;
21647 if (! font_not_found_p
21648 && font
->default_ascent
21649 && CHAR_TABLE_P (Vuse_default_ascent
)
21650 && !NILP (Faref (Vuse_default_ascent
,
21651 make_number (it
->char_to_display
))))
21652 highest
= font
->default_ascent
+ boff
;
21654 /* Draw the first glyph at the normal position. It may be
21655 shifted to right later if some other glyphs are drawn
21657 cmp
->offsets
[i
* 2] = 0;
21658 cmp
->offsets
[i
* 2 + 1] = boff
;
21659 cmp
->lbearing
= lbearing
;
21660 cmp
->rbearing
= rbearing
;
21662 /* Set cmp->offsets for the remaining glyphs. */
21663 for (i
++; i
< glyph_len
; i
++)
21665 int left
, right
, btm
, top
;
21666 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21668 struct face
*this_face
;
21673 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21674 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21675 font
= this_face
->font
;
21681 this_boff
= font
->baseline_offset
;
21682 if (font
->vertical_centering
)
21683 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21684 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21685 &char2b
, it
->multibyte_p
, 0);
21686 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21689 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21692 width
= pcm
->width
;
21693 ascent
= pcm
->ascent
;
21694 descent
= pcm
->descent
;
21695 lbearing
= pcm
->lbearing
;
21696 rbearing
= pcm
->rbearing
;
21697 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21699 /* Relative composition with or without
21700 alternate chars. */
21701 left
= (leftmost
+ rightmost
- width
) / 2;
21702 btm
= - descent
+ boff
;
21703 if (font
->relative_compose
21704 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21705 || NILP (Faref (Vignore_relative_composition
,
21706 make_number (ch
)))))
21709 if (- descent
>= font
->relative_compose
)
21710 /* One extra pixel between two glyphs. */
21712 else if (ascent
<= 0)
21713 /* One extra pixel between two glyphs. */
21714 btm
= lowest
- 1 - ascent
- descent
;
21719 /* A composition rule is specified by an integer
21720 value that encodes global and new reference
21721 points (GREF and NREF). GREF and NREF are
21722 specified by numbers as below:
21724 0---1---2 -- ascent
21728 9--10--11 -- center
21730 ---3---4---5--- baseline
21732 6---7---8 -- descent
21734 int rule
= COMPOSITION_RULE (cmp
, i
);
21735 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21737 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21738 grefx
= gref
% 3, nrefx
= nref
% 3;
21739 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21741 xoff
= font_height
* (xoff
- 128) / 256;
21743 yoff
= font_height
* (yoff
- 128) / 256;
21746 + grefx
* (rightmost
- leftmost
) / 2
21747 - nrefx
* width
/ 2
21750 btm
= ((grefy
== 0 ? highest
21752 : grefy
== 2 ? lowest
21753 : (highest
+ lowest
) / 2)
21754 - (nrefy
== 0 ? ascent
+ descent
21755 : nrefy
== 1 ? descent
- boff
21757 : (ascent
+ descent
) / 2)
21761 cmp
->offsets
[i
* 2] = left
;
21762 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21764 /* Update the bounding box of the overall glyphs. */
21767 right
= left
+ width
;
21768 if (left
< leftmost
)
21770 if (right
> rightmost
)
21773 top
= btm
+ descent
+ ascent
;
21779 if (cmp
->lbearing
> left
+ lbearing
)
21780 cmp
->lbearing
= left
+ lbearing
;
21781 if (cmp
->rbearing
< left
+ rbearing
)
21782 cmp
->rbearing
= left
+ rbearing
;
21786 /* If there are glyphs whose x-offsets are negative,
21787 shift all glyphs to the right and make all x-offsets
21791 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21792 cmp
->offsets
[i
* 2] -= leftmost
;
21793 rightmost
-= leftmost
;
21794 cmp
->lbearing
-= leftmost
;
21795 cmp
->rbearing
-= leftmost
;
21798 if (left_padded
&& cmp
->lbearing
< 0)
21800 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21801 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21802 rightmost
-= cmp
->lbearing
;
21803 cmp
->rbearing
-= cmp
->lbearing
;
21806 if (right_padded
&& rightmost
< cmp
->rbearing
)
21808 rightmost
= cmp
->rbearing
;
21811 cmp
->pixel_width
= rightmost
;
21812 cmp
->ascent
= highest
;
21813 cmp
->descent
= - lowest
;
21814 if (cmp
->ascent
< font_ascent
)
21815 cmp
->ascent
= font_ascent
;
21816 if (cmp
->descent
< font_descent
)
21817 cmp
->descent
= font_descent
;
21821 && (cmp
->lbearing
< 0
21822 || cmp
->rbearing
> cmp
->pixel_width
))
21823 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21825 it
->pixel_width
= cmp
->pixel_width
;
21826 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21827 it
->descent
= it
->phys_descent
= cmp
->descent
;
21828 if (face
->box
!= FACE_NO_BOX
)
21830 int thick
= face
->box_line_width
;
21834 it
->ascent
+= thick
;
21835 it
->descent
+= thick
;
21840 if (it
->start_of_box_run_p
)
21841 it
->pixel_width
+= thick
;
21842 if (it
->end_of_box_run_p
)
21843 it
->pixel_width
+= thick
;
21846 /* If face has an overline, add the height of the overline
21847 (1 pixel) and a 1 pixel margin to the character height. */
21848 if (face
->overline_p
)
21849 it
->ascent
+= overline_margin
;
21851 take_vertical_position_into_account (it
);
21852 if (it
->ascent
< 0)
21854 if (it
->descent
< 0)
21858 append_composite_glyph (it
);
21860 else if (it
->what
== IT_COMPOSITION
)
21862 /* A dynamic (automatic) composition. */
21863 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21864 Lisp_Object gstring
;
21865 struct font_metrics metrics
;
21867 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
21869 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
21872 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
21873 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21874 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
21875 it
->descent
= it
->phys_descent
= metrics
.descent
;
21876 if (face
->box
!= FACE_NO_BOX
)
21878 int thick
= face
->box_line_width
;
21882 it
->ascent
+= thick
;
21883 it
->descent
+= thick
;
21888 if (it
->start_of_box_run_p
)
21889 it
->pixel_width
+= thick
;
21890 if (it
->end_of_box_run_p
)
21891 it
->pixel_width
+= thick
;
21893 /* If face has an overline, add the height of the overline
21894 (1 pixel) and a 1 pixel margin to the character height. */
21895 if (face
->overline_p
)
21896 it
->ascent
+= overline_margin
;
21897 take_vertical_position_into_account (it
);
21898 if (it
->ascent
< 0)
21900 if (it
->descent
< 0)
21904 append_composite_glyph (it
);
21906 else if (it
->what
== IT_IMAGE
)
21907 produce_image_glyph (it
);
21908 else if (it
->what
== IT_STRETCH
)
21909 produce_stretch_glyph (it
);
21911 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21912 because this isn't true for images with `:ascent 100'. */
21913 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21914 if (it
->area
== TEXT_AREA
)
21915 it
->current_x
+= it
->pixel_width
;
21917 if (extra_line_spacing
> 0)
21919 it
->descent
+= extra_line_spacing
;
21920 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21921 it
->max_extra_line_spacing
= extra_line_spacing
;
21924 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21925 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21926 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21927 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21931 Output LEN glyphs starting at START at the nominal cursor position.
21932 Advance the nominal cursor over the text. The global variable
21933 updated_window contains the window being updated, updated_row is
21934 the glyph row being updated, and updated_area is the area of that
21935 row being updated. */
21938 x_write_glyphs (start
, len
)
21939 struct glyph
*start
;
21944 xassert (updated_window
&& updated_row
);
21947 /* Write glyphs. */
21949 hpos
= start
- updated_row
->glyphs
[updated_area
];
21950 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21951 updated_row
, updated_area
,
21953 DRAW_NORMAL_TEXT
, 0);
21955 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21956 if (updated_area
== TEXT_AREA
21957 && updated_window
->phys_cursor_on_p
21958 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21959 && updated_window
->phys_cursor
.hpos
>= hpos
21960 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21961 updated_window
->phys_cursor_on_p
= 0;
21965 /* Advance the output cursor. */
21966 output_cursor
.hpos
+= len
;
21967 output_cursor
.x
= x
;
21972 Insert LEN glyphs from START at the nominal cursor position. */
21975 x_insert_glyphs (start
, len
)
21976 struct glyph
*start
;
21981 int line_height
, shift_by_width
, shifted_region_width
;
21982 struct glyph_row
*row
;
21983 struct glyph
*glyph
;
21984 int frame_x
, frame_y
;
21987 xassert (updated_window
&& updated_row
);
21989 w
= updated_window
;
21990 f
= XFRAME (WINDOW_FRAME (w
));
21992 /* Get the height of the line we are in. */
21994 line_height
= row
->height
;
21996 /* Get the width of the glyphs to insert. */
21997 shift_by_width
= 0;
21998 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21999 shift_by_width
+= glyph
->pixel_width
;
22001 /* Get the width of the region to shift right. */
22002 shifted_region_width
= (window_box_width (w
, updated_area
)
22007 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22008 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22010 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22011 line_height
, shift_by_width
);
22013 /* Write the glyphs. */
22014 hpos
= start
- row
->glyphs
[updated_area
];
22015 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22017 DRAW_NORMAL_TEXT
, 0);
22019 /* Advance the output cursor. */
22020 output_cursor
.hpos
+= len
;
22021 output_cursor
.x
+= shift_by_width
;
22027 Erase the current text line from the nominal cursor position
22028 (inclusive) to pixel column TO_X (exclusive). The idea is that
22029 everything from TO_X onward is already erased.
22031 TO_X is a pixel position relative to updated_area of
22032 updated_window. TO_X == -1 means clear to the end of this area. */
22035 x_clear_end_of_line (to_x
)
22039 struct window
*w
= updated_window
;
22040 int max_x
, min_y
, max_y
;
22041 int from_x
, from_y
, to_y
;
22043 xassert (updated_window
&& updated_row
);
22044 f
= XFRAME (w
->frame
);
22046 if (updated_row
->full_width_p
)
22047 max_x
= WINDOW_TOTAL_WIDTH (w
);
22049 max_x
= window_box_width (w
, updated_area
);
22050 max_y
= window_text_bottom_y (w
);
22052 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22053 of window. For TO_X > 0, truncate to end of drawing area. */
22059 to_x
= min (to_x
, max_x
);
22061 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22063 /* Notice if the cursor will be cleared by this operation. */
22064 if (!updated_row
->full_width_p
)
22065 notice_overwritten_cursor (w
, updated_area
,
22066 output_cursor
.x
, -1,
22068 MATRIX_ROW_BOTTOM_Y (updated_row
));
22070 from_x
= output_cursor
.x
;
22072 /* Translate to frame coordinates. */
22073 if (updated_row
->full_width_p
)
22075 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22076 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22080 int area_left
= window_box_left (w
, updated_area
);
22081 from_x
+= area_left
;
22085 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22086 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22087 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22089 /* Prevent inadvertently clearing to end of the X window. */
22090 if (to_x
> from_x
&& to_y
> from_y
)
22093 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22094 to_x
- from_x
, to_y
- from_y
);
22099 #endif /* HAVE_WINDOW_SYSTEM */
22103 /***********************************************************************
22105 ***********************************************************************/
22107 /* Value is the internal representation of the specified cursor type
22108 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22109 of the bar cursor. */
22111 static enum text_cursor_kinds
22112 get_specified_cursor_type (arg
, width
)
22116 enum text_cursor_kinds type
;
22121 if (EQ (arg
, Qbox
))
22122 return FILLED_BOX_CURSOR
;
22124 if (EQ (arg
, Qhollow
))
22125 return HOLLOW_BOX_CURSOR
;
22127 if (EQ (arg
, Qbar
))
22134 && EQ (XCAR (arg
), Qbar
)
22135 && INTEGERP (XCDR (arg
))
22136 && XINT (XCDR (arg
)) >= 0)
22138 *width
= XINT (XCDR (arg
));
22142 if (EQ (arg
, Qhbar
))
22145 return HBAR_CURSOR
;
22149 && EQ (XCAR (arg
), Qhbar
)
22150 && INTEGERP (XCDR (arg
))
22151 && XINT (XCDR (arg
)) >= 0)
22153 *width
= XINT (XCDR (arg
));
22154 return HBAR_CURSOR
;
22157 /* Treat anything unknown as "hollow box cursor".
22158 It was bad to signal an error; people have trouble fixing
22159 .Xdefaults with Emacs, when it has something bad in it. */
22160 type
= HOLLOW_BOX_CURSOR
;
22165 /* Set the default cursor types for specified frame. */
22167 set_frame_cursor_types (f
, arg
)
22174 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22175 FRAME_CURSOR_WIDTH (f
) = width
;
22177 /* By default, set up the blink-off state depending on the on-state. */
22179 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22182 FRAME_BLINK_OFF_CURSOR (f
)
22183 = get_specified_cursor_type (XCDR (tem
), &width
);
22184 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22187 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22191 /* Return the cursor we want to be displayed in window W. Return
22192 width of bar/hbar cursor through WIDTH arg. Return with
22193 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22194 (i.e. if the `system caret' should track this cursor).
22196 In a mini-buffer window, we want the cursor only to appear if we
22197 are reading input from this window. For the selected window, we
22198 want the cursor type given by the frame parameter or buffer local
22199 setting of cursor-type. If explicitly marked off, draw no cursor.
22200 In all other cases, we want a hollow box cursor. */
22202 static enum text_cursor_kinds
22203 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22205 struct glyph
*glyph
;
22207 int *active_cursor
;
22209 struct frame
*f
= XFRAME (w
->frame
);
22210 struct buffer
*b
= XBUFFER (w
->buffer
);
22211 int cursor_type
= DEFAULT_CURSOR
;
22212 Lisp_Object alt_cursor
;
22213 int non_selected
= 0;
22215 *active_cursor
= 1;
22218 if (cursor_in_echo_area
22219 && FRAME_HAS_MINIBUF_P (f
)
22220 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22222 if (w
== XWINDOW (echo_area_window
))
22224 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22226 *width
= FRAME_CURSOR_WIDTH (f
);
22227 return FRAME_DESIRED_CURSOR (f
);
22230 return get_specified_cursor_type (b
->cursor_type
, width
);
22233 *active_cursor
= 0;
22237 /* Detect a nonselected window or nonselected frame. */
22238 else if (w
!= XWINDOW (f
->selected_window
)
22239 #ifdef HAVE_WINDOW_SYSTEM
22240 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22244 *active_cursor
= 0;
22246 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22252 /* Never display a cursor in a window in which cursor-type is nil. */
22253 if (NILP (b
->cursor_type
))
22256 /* Get the normal cursor type for this window. */
22257 if (EQ (b
->cursor_type
, Qt
))
22259 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22260 *width
= FRAME_CURSOR_WIDTH (f
);
22263 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22265 /* Use cursor-in-non-selected-windows instead
22266 for non-selected window or frame. */
22269 alt_cursor
= b
->cursor_in_non_selected_windows
;
22270 if (!EQ (Qt
, alt_cursor
))
22271 return get_specified_cursor_type (alt_cursor
, width
);
22272 /* t means modify the normal cursor type. */
22273 if (cursor_type
== FILLED_BOX_CURSOR
)
22274 cursor_type
= HOLLOW_BOX_CURSOR
;
22275 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22277 return cursor_type
;
22280 /* Use normal cursor if not blinked off. */
22281 if (!w
->cursor_off_p
)
22283 #ifdef HAVE_WINDOW_SYSTEM
22284 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22286 if (cursor_type
== FILLED_BOX_CURSOR
)
22288 /* Using a block cursor on large images can be very annoying.
22289 So use a hollow cursor for "large" images.
22290 If image is not transparent (no mask), also use hollow cursor. */
22291 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22292 if (img
!= NULL
&& IMAGEP (img
->spec
))
22294 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22295 where N = size of default frame font size.
22296 This should cover most of the "tiny" icons people may use. */
22298 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22299 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22300 cursor_type
= HOLLOW_BOX_CURSOR
;
22303 else if (cursor_type
!= NO_CURSOR
)
22305 /* Display current only supports BOX and HOLLOW cursors for images.
22306 So for now, unconditionally use a HOLLOW cursor when cursor is
22307 not a solid box cursor. */
22308 cursor_type
= HOLLOW_BOX_CURSOR
;
22312 return cursor_type
;
22315 /* Cursor is blinked off, so determine how to "toggle" it. */
22317 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22318 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22319 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22321 /* Then see if frame has specified a specific blink off cursor type. */
22322 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22324 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22325 return FRAME_BLINK_OFF_CURSOR (f
);
22329 /* Some people liked having a permanently visible blinking cursor,
22330 while others had very strong opinions against it. So it was
22331 decided to remove it. KFS 2003-09-03 */
22333 /* Finally perform built-in cursor blinking:
22334 filled box <-> hollow box
22335 wide [h]bar <-> narrow [h]bar
22336 narrow [h]bar <-> no cursor
22337 other type <-> no cursor */
22339 if (cursor_type
== FILLED_BOX_CURSOR
)
22340 return HOLLOW_BOX_CURSOR
;
22342 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22345 return cursor_type
;
22353 #ifdef HAVE_WINDOW_SYSTEM
22355 /* Notice when the text cursor of window W has been completely
22356 overwritten by a drawing operation that outputs glyphs in AREA
22357 starting at X0 and ending at X1 in the line starting at Y0 and
22358 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22359 the rest of the line after X0 has been written. Y coordinates
22360 are window-relative. */
22363 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22365 enum glyph_row_area area
;
22366 int x0
, y0
, x1
, y1
;
22368 int cx0
, cx1
, cy0
, cy1
;
22369 struct glyph_row
*row
;
22371 if (!w
->phys_cursor_on_p
)
22373 if (area
!= TEXT_AREA
)
22376 if (w
->phys_cursor
.vpos
< 0
22377 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22378 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22379 !(row
->enabled_p
&& row
->displays_text_p
)))
22382 if (row
->cursor_in_fringe_p
)
22384 row
->cursor_in_fringe_p
= 0;
22385 draw_fringe_bitmap (w
, row
, 0);
22386 w
->phys_cursor_on_p
= 0;
22390 cx0
= w
->phys_cursor
.x
;
22391 cx1
= cx0
+ w
->phys_cursor_width
;
22392 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22395 /* The cursor image will be completely removed from the
22396 screen if the output area intersects the cursor area in
22397 y-direction. When we draw in [y0 y1[, and some part of
22398 the cursor is at y < y0, that part must have been drawn
22399 before. When scrolling, the cursor is erased before
22400 actually scrolling, so we don't come here. When not
22401 scrolling, the rows above the old cursor row must have
22402 changed, and in this case these rows must have written
22403 over the cursor image.
22405 Likewise if part of the cursor is below y1, with the
22406 exception of the cursor being in the first blank row at
22407 the buffer and window end because update_text_area
22408 doesn't draw that row. (Except when it does, but
22409 that's handled in update_text_area.) */
22411 cy0
= w
->phys_cursor
.y
;
22412 cy1
= cy0
+ w
->phys_cursor_height
;
22413 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22416 w
->phys_cursor_on_p
= 0;
22419 #endif /* HAVE_WINDOW_SYSTEM */
22422 /************************************************************************
22424 ************************************************************************/
22426 #ifdef HAVE_WINDOW_SYSTEM
22429 Fix the display of area AREA of overlapping row ROW in window W
22430 with respect to the overlapping part OVERLAPS. */
22433 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22435 struct glyph_row
*row
;
22436 enum glyph_row_area area
;
22444 for (i
= 0; i
< row
->used
[area
];)
22446 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22448 int start
= i
, start_x
= x
;
22452 x
+= row
->glyphs
[area
][i
].pixel_width
;
22455 while (i
< row
->used
[area
]
22456 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22458 draw_glyphs (w
, start_x
, row
, area
,
22460 DRAW_NORMAL_TEXT
, overlaps
);
22464 x
+= row
->glyphs
[area
][i
].pixel_width
;
22474 Draw the cursor glyph of window W in glyph row ROW. See the
22475 comment of draw_glyphs for the meaning of HL. */
22478 draw_phys_cursor_glyph (w
, row
, hl
)
22480 struct glyph_row
*row
;
22481 enum draw_glyphs_face hl
;
22483 /* If cursor hpos is out of bounds, don't draw garbage. This can
22484 happen in mini-buffer windows when switching between echo area
22485 glyphs and mini-buffer. */
22486 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22488 int on_p
= w
->phys_cursor_on_p
;
22490 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22491 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22493 w
->phys_cursor_on_p
= on_p
;
22495 if (hl
== DRAW_CURSOR
)
22496 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22497 /* When we erase the cursor, and ROW is overlapped by other
22498 rows, make sure that these overlapping parts of other rows
22500 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22502 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22504 if (row
> w
->current_matrix
->rows
22505 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22506 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22507 OVERLAPS_ERASED_CURSOR
);
22509 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22510 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22511 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22512 OVERLAPS_ERASED_CURSOR
);
22519 Erase the image of a cursor of window W from the screen. */
22522 erase_phys_cursor (w
)
22525 struct frame
*f
= XFRAME (w
->frame
);
22526 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22527 int hpos
= w
->phys_cursor
.hpos
;
22528 int vpos
= w
->phys_cursor
.vpos
;
22529 int mouse_face_here_p
= 0;
22530 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22531 struct glyph_row
*cursor_row
;
22532 struct glyph
*cursor_glyph
;
22533 enum draw_glyphs_face hl
;
22535 /* No cursor displayed or row invalidated => nothing to do on the
22537 if (w
->phys_cursor_type
== NO_CURSOR
)
22538 goto mark_cursor_off
;
22540 /* VPOS >= active_glyphs->nrows means that window has been resized.
22541 Don't bother to erase the cursor. */
22542 if (vpos
>= active_glyphs
->nrows
)
22543 goto mark_cursor_off
;
22545 /* If row containing cursor is marked invalid, there is nothing we
22547 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22548 if (!cursor_row
->enabled_p
)
22549 goto mark_cursor_off
;
22551 /* If line spacing is > 0, old cursor may only be partially visible in
22552 window after split-window. So adjust visible height. */
22553 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22554 window_text_bottom_y (w
) - cursor_row
->y
);
22556 /* If row is completely invisible, don't attempt to delete a cursor which
22557 isn't there. This can happen if cursor is at top of a window, and
22558 we switch to a buffer with a header line in that window. */
22559 if (cursor_row
->visible_height
<= 0)
22560 goto mark_cursor_off
;
22562 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22563 if (cursor_row
->cursor_in_fringe_p
)
22565 cursor_row
->cursor_in_fringe_p
= 0;
22566 draw_fringe_bitmap (w
, cursor_row
, 0);
22567 goto mark_cursor_off
;
22570 /* This can happen when the new row is shorter than the old one.
22571 In this case, either draw_glyphs or clear_end_of_line
22572 should have cleared the cursor. Note that we wouldn't be
22573 able to erase the cursor in this case because we don't have a
22574 cursor glyph at hand. */
22575 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22576 goto mark_cursor_off
;
22578 /* If the cursor is in the mouse face area, redisplay that when
22579 we clear the cursor. */
22580 if (! NILP (dpyinfo
->mouse_face_window
)
22581 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22582 && (vpos
> dpyinfo
->mouse_face_beg_row
22583 || (vpos
== dpyinfo
->mouse_face_beg_row
22584 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22585 && (vpos
< dpyinfo
->mouse_face_end_row
22586 || (vpos
== dpyinfo
->mouse_face_end_row
22587 && hpos
< dpyinfo
->mouse_face_end_col
))
22588 /* Don't redraw the cursor's spot in mouse face if it is at the
22589 end of a line (on a newline). The cursor appears there, but
22590 mouse highlighting does not. */
22591 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22592 mouse_face_here_p
= 1;
22594 /* Maybe clear the display under the cursor. */
22595 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22598 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22601 cursor_glyph
= get_phys_cursor_glyph (w
);
22602 if (cursor_glyph
== NULL
)
22603 goto mark_cursor_off
;
22605 width
= cursor_glyph
->pixel_width
;
22606 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22607 x
= w
->phys_cursor
.x
;
22609 width
-= left_x
- x
;
22610 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22611 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22612 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22615 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22618 /* Erase the cursor by redrawing the character underneath it. */
22619 if (mouse_face_here_p
)
22620 hl
= DRAW_MOUSE_FACE
;
22622 hl
= DRAW_NORMAL_TEXT
;
22623 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22626 w
->phys_cursor_on_p
= 0;
22627 w
->phys_cursor_type
= NO_CURSOR
;
22632 Display or clear cursor of window W. If ON is zero, clear the
22633 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22634 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22637 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22639 int on
, hpos
, vpos
, x
, y
;
22641 struct frame
*f
= XFRAME (w
->frame
);
22642 int new_cursor_type
;
22643 int new_cursor_width
;
22645 struct glyph_row
*glyph_row
;
22646 struct glyph
*glyph
;
22648 /* This is pointless on invisible frames, and dangerous on garbaged
22649 windows and frames; in the latter case, the frame or window may
22650 be in the midst of changing its size, and x and y may be off the
22652 if (! FRAME_VISIBLE_P (f
)
22653 || FRAME_GARBAGED_P (f
)
22654 || vpos
>= w
->current_matrix
->nrows
22655 || hpos
>= w
->current_matrix
->matrix_w
)
22658 /* If cursor is off and we want it off, return quickly. */
22659 if (!on
&& !w
->phys_cursor_on_p
)
22662 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22663 /* If cursor row is not enabled, we don't really know where to
22664 display the cursor. */
22665 if (!glyph_row
->enabled_p
)
22667 w
->phys_cursor_on_p
= 0;
22672 if (!glyph_row
->exact_window_width_line_p
22673 || hpos
< glyph_row
->used
[TEXT_AREA
])
22674 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22676 xassert (interrupt_input_blocked
);
22678 /* Set new_cursor_type to the cursor we want to be displayed. */
22679 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22680 &new_cursor_width
, &active_cursor
);
22682 /* If cursor is currently being shown and we don't want it to be or
22683 it is in the wrong place, or the cursor type is not what we want,
22685 if (w
->phys_cursor_on_p
22687 || w
->phys_cursor
.x
!= x
22688 || w
->phys_cursor
.y
!= y
22689 || new_cursor_type
!= w
->phys_cursor_type
22690 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22691 && new_cursor_width
!= w
->phys_cursor_width
)))
22692 erase_phys_cursor (w
);
22694 /* Don't check phys_cursor_on_p here because that flag is only set
22695 to zero in some cases where we know that the cursor has been
22696 completely erased, to avoid the extra work of erasing the cursor
22697 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22698 still not be visible, or it has only been partly erased. */
22701 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22702 w
->phys_cursor_height
= glyph_row
->height
;
22704 /* Set phys_cursor_.* before x_draw_.* is called because some
22705 of them may need the information. */
22706 w
->phys_cursor
.x
= x
;
22707 w
->phys_cursor
.y
= glyph_row
->y
;
22708 w
->phys_cursor
.hpos
= hpos
;
22709 w
->phys_cursor
.vpos
= vpos
;
22712 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22713 new_cursor_type
, new_cursor_width
,
22714 on
, active_cursor
);
22718 /* Switch the display of W's cursor on or off, according to the value
22725 update_window_cursor (w
, on
)
22729 /* Don't update cursor in windows whose frame is in the process
22730 of being deleted. */
22731 if (w
->current_matrix
)
22734 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22735 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22741 /* Call update_window_cursor with parameter ON_P on all leaf windows
22742 in the window tree rooted at W. */
22745 update_cursor_in_window_tree (w
, on_p
)
22751 if (!NILP (w
->hchild
))
22752 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22753 else if (!NILP (w
->vchild
))
22754 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22756 update_window_cursor (w
, on_p
);
22758 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22764 Display the cursor on window W, or clear it, according to ON_P.
22765 Don't change the cursor's position. */
22768 x_update_cursor (f
, on_p
)
22772 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22777 Clear the cursor of window W to background color, and mark the
22778 cursor as not shown. This is used when the text where the cursor
22779 is is about to be rewritten. */
22785 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22786 update_window_cursor (w
, 0);
22791 Display the active region described by mouse_face_* according to DRAW. */
22794 show_mouse_face (dpyinfo
, draw
)
22795 Display_Info
*dpyinfo
;
22796 enum draw_glyphs_face draw
;
22798 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22799 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22801 if (/* If window is in the process of being destroyed, don't bother
22803 w
->current_matrix
!= NULL
22804 /* Don't update mouse highlight if hidden */
22805 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22806 /* Recognize when we are called to operate on rows that don't exist
22807 anymore. This can happen when a window is split. */
22808 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22810 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22811 struct glyph_row
*row
, *first
, *last
;
22813 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22814 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22816 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22818 int start_hpos
, end_hpos
, start_x
;
22820 /* For all but the first row, the highlight starts at column 0. */
22823 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22824 start_x
= dpyinfo
->mouse_face_beg_x
;
22833 end_hpos
= dpyinfo
->mouse_face_end_col
;
22836 end_hpos
= row
->used
[TEXT_AREA
];
22837 if (draw
== DRAW_NORMAL_TEXT
)
22838 row
->fill_line_p
= 1; /* Clear to end of line */
22841 if (end_hpos
> start_hpos
)
22843 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22844 start_hpos
, end_hpos
,
22848 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22852 /* When we've written over the cursor, arrange for it to
22853 be displayed again. */
22854 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22857 display_and_set_cursor (w
, 1,
22858 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22859 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22864 /* Change the mouse cursor. */
22865 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22866 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22867 else if (draw
== DRAW_MOUSE_FACE
)
22868 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22870 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22874 Clear out the mouse-highlighted active region.
22875 Redraw it un-highlighted first. Value is non-zero if mouse
22876 face was actually drawn unhighlighted. */
22879 clear_mouse_face (dpyinfo
)
22880 Display_Info
*dpyinfo
;
22884 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22886 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22890 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22891 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22892 dpyinfo
->mouse_face_window
= Qnil
;
22893 dpyinfo
->mouse_face_overlay
= Qnil
;
22899 Non-zero if physical cursor of window W is within mouse face. */
22902 cursor_in_mouse_face_p (w
)
22905 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22906 int in_mouse_face
= 0;
22908 if (WINDOWP (dpyinfo
->mouse_face_window
)
22909 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22911 int hpos
= w
->phys_cursor
.hpos
;
22912 int vpos
= w
->phys_cursor
.vpos
;
22914 if (vpos
>= dpyinfo
->mouse_face_beg_row
22915 && vpos
<= dpyinfo
->mouse_face_end_row
22916 && (vpos
> dpyinfo
->mouse_face_beg_row
22917 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22918 && (vpos
< dpyinfo
->mouse_face_end_row
22919 || hpos
< dpyinfo
->mouse_face_end_col
22920 || dpyinfo
->mouse_face_past_end
))
22924 return in_mouse_face
;
22930 /* Find the glyph matrix position of buffer position CHARPOS in window
22931 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22932 current glyphs must be up to date. If CHARPOS is above window
22933 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22934 of last line in W. In the row containing CHARPOS, stop before glyphs
22935 having STOP as object. */
22937 #if 1 /* This is a version of fast_find_position that's more correct
22938 in the presence of hscrolling, for example. I didn't install
22939 it right away because the problem fixed is minor, it failed
22940 in 20.x as well, and I think it's too risky to install
22941 so near the release of 21.1. 2001-09-25 gerd. */
22945 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22948 int *hpos
, *vpos
, *x
, *y
;
22951 struct glyph_row
*row
, *first
;
22952 struct glyph
*glyph
, *end
;
22955 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22956 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22961 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22965 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22968 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22972 /* If whole rows or last part of a row came from a display overlay,
22973 row_containing_pos will skip over such rows because their end pos
22974 equals the start pos of the overlay or interval.
22976 Move back if we have a STOP object and previous row's
22977 end glyph came from STOP. */
22980 struct glyph_row
*prev
;
22981 while ((prev
= row
- 1, prev
>= first
)
22982 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22983 && prev
->used
[TEXT_AREA
] > 0)
22985 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22986 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22987 while (--glyph
>= beg
22988 && INTEGERP (glyph
->object
));
22990 || !EQ (stop
, glyph
->object
))
22998 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23000 glyph
= row
->glyphs
[TEXT_AREA
];
23001 end
= glyph
+ row
->used
[TEXT_AREA
];
23003 /* Skip over glyphs not having an object at the start of the row.
23004 These are special glyphs like truncation marks on terminal
23006 if (row
->displays_text_p
)
23008 && INTEGERP (glyph
->object
)
23009 && !EQ (stop
, glyph
->object
)
23010 && glyph
->charpos
< 0)
23012 *x
+= glyph
->pixel_width
;
23017 && !INTEGERP (glyph
->object
)
23018 && !EQ (stop
, glyph
->object
)
23019 && (!BUFFERP (glyph
->object
)
23020 || glyph
->charpos
< charpos
))
23022 *x
+= glyph
->pixel_width
;
23026 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
23033 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
23036 int *hpos
, *vpos
, *x
, *y
;
23041 int maybe_next_line_p
= 0;
23042 int line_start_position
;
23043 int yb
= window_text_bottom_y (w
);
23044 struct glyph_row
*row
, *best_row
;
23045 int row_vpos
, best_row_vpos
;
23048 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23049 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23051 while (row
->y
< yb
)
23053 if (row
->used
[TEXT_AREA
])
23054 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
23056 line_start_position
= 0;
23058 if (line_start_position
> pos
)
23060 /* If the position sought is the end of the buffer,
23061 don't include the blank lines at the bottom of the window. */
23062 else if (line_start_position
== pos
23063 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
23065 maybe_next_line_p
= 1;
23068 else if (line_start_position
> 0)
23071 best_row_vpos
= row_vpos
;
23074 if (row
->y
+ row
->height
>= yb
)
23081 /* Find the right column within BEST_ROW. */
23083 current_x
= best_row
->x
;
23084 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
23086 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
23087 int charpos
= glyph
->charpos
;
23089 if (BUFFERP (glyph
->object
))
23091 if (charpos
== pos
)
23094 *vpos
= best_row_vpos
;
23099 else if (charpos
> pos
)
23102 else if (EQ (glyph
->object
, stop
))
23107 current_x
+= glyph
->pixel_width
;
23110 /* If we're looking for the end of the buffer,
23111 and we didn't find it in the line we scanned,
23112 use the start of the following line. */
23113 if (maybe_next_line_p
)
23118 current_x
= best_row
->x
;
23121 *vpos
= best_row_vpos
;
23122 *hpos
= lastcol
+ 1;
23131 /* Find the position of the glyph for position POS in OBJECT in
23132 window W's current matrix, and return in *X, *Y the pixel
23133 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23135 RIGHT_P non-zero means return the position of the right edge of the
23136 glyph, RIGHT_P zero means return the left edge position.
23138 If no glyph for POS exists in the matrix, return the position of
23139 the glyph with the next smaller position that is in the matrix, if
23140 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23141 exists in the matrix, return the position of the glyph with the
23142 next larger position in OBJECT.
23144 Value is non-zero if a glyph was found. */
23147 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23150 Lisp_Object object
;
23151 int *hpos
, *vpos
, *x
, *y
;
23154 int yb
= window_text_bottom_y (w
);
23155 struct glyph_row
*r
;
23156 struct glyph
*best_glyph
= NULL
;
23157 struct glyph_row
*best_row
= NULL
;
23160 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23161 r
->enabled_p
&& r
->y
< yb
;
23164 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23165 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23168 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23169 if (EQ (g
->object
, object
))
23171 if (g
->charpos
== pos
)
23178 else if (best_glyph
== NULL
23179 || ((eabs (g
->charpos
- pos
)
23180 < eabs (best_glyph
->charpos
- pos
))
23183 : g
->charpos
> pos
)))
23197 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23201 *x
+= best_glyph
->pixel_width
;
23206 *vpos
= best_row
- w
->current_matrix
->rows
;
23209 return best_glyph
!= NULL
;
23213 /* See if position X, Y is within a hot-spot of an image. */
23216 on_hot_spot_p (hot_spot
, x
, y
)
23217 Lisp_Object hot_spot
;
23220 if (!CONSP (hot_spot
))
23223 if (EQ (XCAR (hot_spot
), Qrect
))
23225 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23226 Lisp_Object rect
= XCDR (hot_spot
);
23230 if (!CONSP (XCAR (rect
)))
23232 if (!CONSP (XCDR (rect
)))
23234 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23236 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23238 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23240 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23244 else if (EQ (XCAR (hot_spot
), Qcircle
))
23246 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23247 Lisp_Object circ
= XCDR (hot_spot
);
23248 Lisp_Object lr
, lx0
, ly0
;
23250 && CONSP (XCAR (circ
))
23251 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23252 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23253 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23255 double r
= XFLOATINT (lr
);
23256 double dx
= XINT (lx0
) - x
;
23257 double dy
= XINT (ly0
) - y
;
23258 return (dx
* dx
+ dy
* dy
<= r
* r
);
23261 else if (EQ (XCAR (hot_spot
), Qpoly
))
23263 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23264 if (VECTORP (XCDR (hot_spot
)))
23266 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23267 Lisp_Object
*poly
= v
->contents
;
23271 Lisp_Object lx
, ly
;
23274 /* Need an even number of coordinates, and at least 3 edges. */
23275 if (n
< 6 || n
& 1)
23278 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23279 If count is odd, we are inside polygon. Pixels on edges
23280 may or may not be included depending on actual geometry of the
23282 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23283 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23285 x0
= XINT (lx
), y0
= XINT (ly
);
23286 for (i
= 0; i
< n
; i
+= 2)
23288 int x1
= x0
, y1
= y0
;
23289 if ((lx
= poly
[i
], !INTEGERP (lx
))
23290 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23292 x0
= XINT (lx
), y0
= XINT (ly
);
23294 /* Does this segment cross the X line? */
23302 if (y
> y0
&& y
> y1
)
23304 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23314 find_hot_spot (map
, x
, y
)
23318 while (CONSP (map
))
23320 if (CONSP (XCAR (map
))
23321 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23329 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23331 doc
: /* Lookup in image map MAP coordinates X and Y.
23332 An image map is an alist where each element has the format (AREA ID PLIST).
23333 An AREA is specified as either a rectangle, a circle, or a polygon:
23334 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23335 pixel coordinates of the upper left and bottom right corners.
23336 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23337 and the radius of the circle; r may be a float or integer.
23338 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23339 vector describes one corner in the polygon.
23340 Returns the alist element for the first matching AREA in MAP. */)
23351 return find_hot_spot (map
, XINT (x
), XINT (y
));
23355 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23357 define_frame_cursor1 (f
, cursor
, pointer
)
23360 Lisp_Object pointer
;
23362 /* Do not change cursor shape while dragging mouse. */
23363 if (!NILP (do_mouse_tracking
))
23366 if (!NILP (pointer
))
23368 if (EQ (pointer
, Qarrow
))
23369 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23370 else if (EQ (pointer
, Qhand
))
23371 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23372 else if (EQ (pointer
, Qtext
))
23373 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23374 else if (EQ (pointer
, intern ("hdrag")))
23375 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23376 #ifdef HAVE_X_WINDOWS
23377 else if (EQ (pointer
, intern ("vdrag")))
23378 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23380 else if (EQ (pointer
, intern ("hourglass")))
23381 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23382 else if (EQ (pointer
, Qmodeline
))
23383 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23385 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23388 if (cursor
!= No_Cursor
)
23389 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23392 /* Take proper action when mouse has moved to the mode or header line
23393 or marginal area AREA of window W, x-position X and y-position Y.
23394 X is relative to the start of the text display area of W, so the
23395 width of bitmap areas and scroll bars must be subtracted to get a
23396 position relative to the start of the mode line. */
23399 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23400 Lisp_Object window
;
23402 enum window_part area
;
23404 struct window
*w
= XWINDOW (window
);
23405 struct frame
*f
= XFRAME (w
->frame
);
23406 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23407 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23408 Lisp_Object pointer
= Qnil
;
23409 int charpos
, dx
, dy
, width
, height
;
23410 Lisp_Object string
, object
= Qnil
;
23411 Lisp_Object pos
, help
;
23413 Lisp_Object mouse_face
;
23414 int original_x_pixel
= x
;
23415 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23416 struct glyph_row
*row
;
23418 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23423 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23424 &object
, &dx
, &dy
, &width
, &height
);
23426 row
= (area
== ON_MODE_LINE
23427 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23428 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23431 if (row
->mode_line_p
&& row
->enabled_p
)
23433 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23434 end
= glyph
+ row
->used
[TEXT_AREA
];
23436 for (x0
= original_x_pixel
;
23437 glyph
< end
&& x0
>= glyph
->pixel_width
;
23439 x0
-= glyph
->pixel_width
;
23447 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23448 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23449 &object
, &dx
, &dy
, &width
, &height
);
23454 if (IMAGEP (object
))
23456 Lisp_Object image_map
, hotspot
;
23457 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23459 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23461 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23463 Lisp_Object area_id
, plist
;
23465 area_id
= XCAR (hotspot
);
23466 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23467 If so, we could look for mouse-enter, mouse-leave
23468 properties in PLIST (and do something...). */
23469 hotspot
= XCDR (hotspot
);
23470 if (CONSP (hotspot
)
23471 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23473 pointer
= Fplist_get (plist
, Qpointer
);
23474 if (NILP (pointer
))
23476 help
= Fplist_get (plist
, Qhelp_echo
);
23479 help_echo_string
= help
;
23480 /* Is this correct? ++kfs */
23481 XSETWINDOW (help_echo_window
, w
);
23482 help_echo_object
= w
->buffer
;
23483 help_echo_pos
= charpos
;
23487 if (NILP (pointer
))
23488 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23491 if (STRINGP (string
))
23493 pos
= make_number (charpos
);
23494 /* If we're on a string with `help-echo' text property, arrange
23495 for the help to be displayed. This is done by setting the
23496 global variable help_echo_string to the help string. */
23499 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23502 help_echo_string
= help
;
23503 XSETWINDOW (help_echo_window
, w
);
23504 help_echo_object
= string
;
23505 help_echo_pos
= charpos
;
23509 if (NILP (pointer
))
23510 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23512 /* Change the mouse pointer according to what is under X/Y. */
23513 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23516 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23517 if (!KEYMAPP (map
))
23518 map
= Fget_text_property (pos
, Qkeymap
, string
);
23519 if (!KEYMAPP (map
))
23520 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23523 /* Change the mouse face according to what is under X/Y. */
23524 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23525 if (!NILP (mouse_face
)
23526 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23531 struct glyph
* tmp_glyph
;
23535 int total_pixel_width
;
23540 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23541 Qmouse_face
, string
, Qnil
);
23543 b
= make_number (0);
23545 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23547 e
= make_number (SCHARS (string
));
23549 /* Calculate the position(glyph position: GPOS) of GLYPH in
23550 displayed string. GPOS is different from CHARPOS.
23552 CHARPOS is the position of glyph in internal string
23553 object. A mode line string format has structures which
23554 is converted to a flatten by emacs lisp interpreter.
23555 The internal string is an element of the structures.
23556 The displayed string is the flatten string. */
23558 if (glyph
> row_start_glyph
)
23560 tmp_glyph
= glyph
- 1;
23561 while (tmp_glyph
>= row_start_glyph
23562 && tmp_glyph
->charpos
>= XINT (b
)
23563 && EQ (tmp_glyph
->object
, glyph
->object
))
23570 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23571 displayed string holding GLYPH.
23573 GSEQ_LENGTH is different from SCHARS (STRING).
23574 SCHARS (STRING) returns the length of the internal string. */
23575 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23576 tmp_glyph
->charpos
< XINT (e
);
23577 tmp_glyph
++, gseq_length
++)
23579 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23583 total_pixel_width
= 0;
23584 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23585 total_pixel_width
+= tmp_glyph
->pixel_width
;
23587 /* Pre calculation of re-rendering position */
23589 hpos
= (area
== ON_MODE_LINE
23590 ? (w
->current_matrix
)->nrows
- 1
23593 /* If the re-rendering position is included in the last
23594 re-rendering area, we should do nothing. */
23595 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23596 && dpyinfo
->mouse_face_beg_col
<= vpos
23597 && vpos
< dpyinfo
->mouse_face_end_col
23598 && dpyinfo
->mouse_face_beg_row
== hpos
)
23601 if (clear_mouse_face (dpyinfo
))
23602 cursor
= No_Cursor
;
23604 dpyinfo
->mouse_face_beg_col
= vpos
;
23605 dpyinfo
->mouse_face_beg_row
= hpos
;
23607 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23608 dpyinfo
->mouse_face_beg_y
= 0;
23610 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23611 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23613 dpyinfo
->mouse_face_end_x
= 0;
23614 dpyinfo
->mouse_face_end_y
= 0;
23616 dpyinfo
->mouse_face_past_end
= 0;
23617 dpyinfo
->mouse_face_window
= window
;
23619 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23622 glyph
->face_id
, 1);
23623 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23625 if (NILP (pointer
))
23628 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23629 clear_mouse_face (dpyinfo
);
23631 define_frame_cursor1 (f
, cursor
, pointer
);
23636 Take proper action when the mouse has moved to position X, Y on
23637 frame F as regards highlighting characters that have mouse-face
23638 properties. Also de-highlighting chars where the mouse was before.
23639 X and Y can be negative or out of range. */
23642 note_mouse_highlight (f
, x
, y
)
23646 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23647 enum window_part part
;
23648 Lisp_Object window
;
23650 Cursor cursor
= No_Cursor
;
23651 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23654 /* When a menu is active, don't highlight because this looks odd. */
23655 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
23656 if (popup_activated ())
23660 if (NILP (Vmouse_highlight
)
23661 || !f
->glyphs_initialized_p
)
23664 dpyinfo
->mouse_face_mouse_x
= x
;
23665 dpyinfo
->mouse_face_mouse_y
= y
;
23666 dpyinfo
->mouse_face_mouse_frame
= f
;
23668 if (dpyinfo
->mouse_face_defer
)
23671 if (gc_in_progress
)
23673 dpyinfo
->mouse_face_deferred_gc
= 1;
23677 /* Which window is that in? */
23678 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23680 /* If we were displaying active text in another window, clear that.
23681 Also clear if we move out of text area in same window. */
23682 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23683 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23684 && !NILP (dpyinfo
->mouse_face_window
)))
23685 clear_mouse_face (dpyinfo
);
23687 /* Not on a window -> return. */
23688 if (!WINDOWP (window
))
23691 /* Reset help_echo_string. It will get recomputed below. */
23692 help_echo_string
= Qnil
;
23694 /* Convert to window-relative pixel coordinates. */
23695 w
= XWINDOW (window
);
23696 frame_to_window_pixel_xy (w
, &x
, &y
);
23698 /* Handle tool-bar window differently since it doesn't display a
23700 if (EQ (window
, f
->tool_bar_window
))
23702 note_tool_bar_highlight (f
, x
, y
);
23706 /* Mouse is on the mode, header line or margin? */
23707 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23708 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23710 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23714 if (part
== ON_VERTICAL_BORDER
)
23716 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23717 help_echo_string
= build_string ("drag-mouse-1: resize");
23719 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23720 || part
== ON_SCROLL_BAR
)
23721 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23723 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23725 /* Are we in a window whose display is up to date?
23726 And verify the buffer's text has not changed. */
23727 b
= XBUFFER (w
->buffer
);
23728 if (part
== ON_TEXT
23729 && EQ (w
->window_end_valid
, w
->buffer
)
23730 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23731 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23733 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23734 struct glyph
*glyph
;
23735 Lisp_Object object
;
23736 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23737 Lisp_Object
*overlay_vec
= NULL
;
23739 struct buffer
*obuf
;
23740 int obegv
, ozv
, same_region
;
23742 /* Find the glyph under X/Y. */
23743 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23745 /* Look for :pointer property on image. */
23746 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23748 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23749 if (img
!= NULL
&& IMAGEP (img
->spec
))
23751 Lisp_Object image_map
, hotspot
;
23752 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23754 && (hotspot
= find_hot_spot (image_map
,
23755 glyph
->slice
.x
+ dx
,
23756 glyph
->slice
.y
+ dy
),
23758 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23760 Lisp_Object area_id
, plist
;
23762 area_id
= XCAR (hotspot
);
23763 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23764 If so, we could look for mouse-enter, mouse-leave
23765 properties in PLIST (and do something...). */
23766 hotspot
= XCDR (hotspot
);
23767 if (CONSP (hotspot
)
23768 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23770 pointer
= Fplist_get (plist
, Qpointer
);
23771 if (NILP (pointer
))
23773 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23774 if (!NILP (help_echo_string
))
23776 help_echo_window
= window
;
23777 help_echo_object
= glyph
->object
;
23778 help_echo_pos
= glyph
->charpos
;
23782 if (NILP (pointer
))
23783 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23787 /* Clear mouse face if X/Y not over text. */
23789 || area
!= TEXT_AREA
23790 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23792 if (clear_mouse_face (dpyinfo
))
23793 cursor
= No_Cursor
;
23794 if (NILP (pointer
))
23796 if (area
!= TEXT_AREA
)
23797 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23799 pointer
= Vvoid_text_area_pointer
;
23804 pos
= glyph
->charpos
;
23805 object
= glyph
->object
;
23806 if (!STRINGP (object
) && !BUFFERP (object
))
23809 /* If we get an out-of-range value, return now; avoid an error. */
23810 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23813 /* Make the window's buffer temporarily current for
23814 overlays_at and compute_char_face. */
23815 obuf
= current_buffer
;
23816 current_buffer
= b
;
23822 /* Is this char mouse-active or does it have help-echo? */
23823 position
= make_number (pos
);
23825 if (BUFFERP (object
))
23827 /* Put all the overlays we want in a vector in overlay_vec. */
23828 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23829 /* Sort overlays into increasing priority order. */
23830 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23835 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23836 && vpos
>= dpyinfo
->mouse_face_beg_row
23837 && vpos
<= dpyinfo
->mouse_face_end_row
23838 && (vpos
> dpyinfo
->mouse_face_beg_row
23839 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23840 && (vpos
< dpyinfo
->mouse_face_end_row
23841 || hpos
< dpyinfo
->mouse_face_end_col
23842 || dpyinfo
->mouse_face_past_end
));
23845 cursor
= No_Cursor
;
23847 /* Check mouse-face highlighting. */
23849 /* If there exists an overlay with mouse-face overlapping
23850 the one we are currently highlighting, we have to
23851 check if we enter the overlapping overlay, and then
23852 highlight only that. */
23853 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23854 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23856 /* Find the highest priority overlay that has a mouse-face
23859 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23861 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23862 if (!NILP (mouse_face
))
23863 overlay
= overlay_vec
[i
];
23866 /* If we're actually highlighting the same overlay as
23867 before, there's no need to do that again. */
23868 if (!NILP (overlay
)
23869 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23870 goto check_help_echo
;
23872 dpyinfo
->mouse_face_overlay
= overlay
;
23874 /* Clear the display of the old active region, if any. */
23875 if (clear_mouse_face (dpyinfo
))
23876 cursor
= No_Cursor
;
23878 /* If no overlay applies, get a text property. */
23879 if (NILP (overlay
))
23880 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23882 /* Handle the overlay case. */
23883 if (!NILP (overlay
))
23885 /* Find the range of text around this char that
23886 should be active. */
23887 Lisp_Object before
, after
;
23890 before
= Foverlay_start (overlay
);
23891 after
= Foverlay_end (overlay
);
23892 /* Record this as the current active region. */
23893 fast_find_position (w
, XFASTINT (before
),
23894 &dpyinfo
->mouse_face_beg_col
,
23895 &dpyinfo
->mouse_face_beg_row
,
23896 &dpyinfo
->mouse_face_beg_x
,
23897 &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 dpyinfo
->mouse_face_face_id
23908 = face_at_buffer_position (w
, pos
, 0, 0,
23910 !dpyinfo
->mouse_face_hidden
,
23913 /* Display it as active. */
23914 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23915 cursor
= No_Cursor
;
23917 /* Handle the text property case. */
23918 else if (!NILP (mouse_face
) && BUFFERP (object
))
23920 /* Find the range of text around this char that
23921 should be active. */
23922 Lisp_Object before
, after
, beginning
, end
;
23925 beginning
= Fmarker_position (w
->start
);
23926 end
= make_number (BUF_Z (XBUFFER (object
))
23927 - XFASTINT (w
->window_end_pos
));
23929 = Fprevious_single_property_change (make_number (pos
+ 1),
23931 object
, beginning
);
23933 = Fnext_single_property_change (position
, Qmouse_face
,
23936 /* Record this as the current active region. */
23937 fast_find_position (w
, XFASTINT (before
),
23938 &dpyinfo
->mouse_face_beg_col
,
23939 &dpyinfo
->mouse_face_beg_row
,
23940 &dpyinfo
->mouse_face_beg_x
,
23941 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23942 dpyinfo
->mouse_face_past_end
23943 = !fast_find_position (w
, XFASTINT (after
),
23944 &dpyinfo
->mouse_face_end_col
,
23945 &dpyinfo
->mouse_face_end_row
,
23946 &dpyinfo
->mouse_face_end_x
,
23947 &dpyinfo
->mouse_face_end_y
, Qnil
);
23948 dpyinfo
->mouse_face_window
= window
;
23950 if (BUFFERP (object
))
23951 dpyinfo
->mouse_face_face_id
23952 = face_at_buffer_position (w
, pos
, 0, 0,
23954 !dpyinfo
->mouse_face_hidden
,
23957 /* Display it as active. */
23958 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23959 cursor
= No_Cursor
;
23961 else if (!NILP (mouse_face
) && STRINGP (object
))
23966 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23969 e
= Fnext_single_property_change (position
, Qmouse_face
,
23972 b
= make_number (0);
23974 e
= make_number (SCHARS (object
) - 1);
23976 fast_find_string_pos (w
, XINT (b
), object
,
23977 &dpyinfo
->mouse_face_beg_col
,
23978 &dpyinfo
->mouse_face_beg_row
,
23979 &dpyinfo
->mouse_face_beg_x
,
23980 &dpyinfo
->mouse_face_beg_y
, 0);
23981 fast_find_string_pos (w
, XINT (e
), object
,
23982 &dpyinfo
->mouse_face_end_col
,
23983 &dpyinfo
->mouse_face_end_row
,
23984 &dpyinfo
->mouse_face_end_x
,
23985 &dpyinfo
->mouse_face_end_y
, 1);
23986 dpyinfo
->mouse_face_past_end
= 0;
23987 dpyinfo
->mouse_face_window
= window
;
23988 dpyinfo
->mouse_face_face_id
23989 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23990 glyph
->face_id
, 1);
23991 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23992 cursor
= No_Cursor
;
23994 else if (STRINGP (object
) && NILP (mouse_face
))
23996 /* A string which doesn't have mouse-face, but
23997 the text ``under'' it might have. */
23998 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23999 int start
= MATRIX_ROW_START_CHARPOS (r
);
24001 pos
= string_buffer_position (w
, object
, start
);
24003 mouse_face
= get_char_property_and_overlay (make_number (pos
),
24007 if (!NILP (mouse_face
) && !NILP (overlay
))
24009 Lisp_Object before
= Foverlay_start (overlay
);
24010 Lisp_Object after
= Foverlay_end (overlay
);
24013 /* Note that we might not be able to find position
24014 BEFORE in the glyph matrix if the overlay is
24015 entirely covered by a `display' property. In
24016 this case, we overshoot. So let's stop in
24017 the glyph matrix before glyphs for OBJECT. */
24018 fast_find_position (w
, XFASTINT (before
),
24019 &dpyinfo
->mouse_face_beg_col
,
24020 &dpyinfo
->mouse_face_beg_row
,
24021 &dpyinfo
->mouse_face_beg_x
,
24022 &dpyinfo
->mouse_face_beg_y
,
24025 dpyinfo
->mouse_face_past_end
24026 = !fast_find_position (w
, XFASTINT (after
),
24027 &dpyinfo
->mouse_face_end_col
,
24028 &dpyinfo
->mouse_face_end_row
,
24029 &dpyinfo
->mouse_face_end_x
,
24030 &dpyinfo
->mouse_face_end_y
,
24032 dpyinfo
->mouse_face_window
= window
;
24033 dpyinfo
->mouse_face_face_id
24034 = face_at_buffer_position (w
, pos
, 0, 0,
24036 !dpyinfo
->mouse_face_hidden
,
24039 /* Display it as active. */
24040 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24041 cursor
= No_Cursor
;
24048 /* Look for a `help-echo' property. */
24049 if (NILP (help_echo_string
)) {
24050 Lisp_Object help
, overlay
;
24052 /* Check overlays first. */
24053 help
= overlay
= Qnil
;
24054 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24056 overlay
= overlay_vec
[i
];
24057 help
= Foverlay_get (overlay
, Qhelp_echo
);
24062 help_echo_string
= help
;
24063 help_echo_window
= window
;
24064 help_echo_object
= overlay
;
24065 help_echo_pos
= pos
;
24069 Lisp_Object object
= glyph
->object
;
24070 int charpos
= glyph
->charpos
;
24072 /* Try text properties. */
24073 if (STRINGP (object
)
24075 && charpos
< SCHARS (object
))
24077 help
= Fget_text_property (make_number (charpos
),
24078 Qhelp_echo
, object
);
24081 /* If the string itself doesn't specify a help-echo,
24082 see if the buffer text ``under'' it does. */
24083 struct glyph_row
*r
24084 = MATRIX_ROW (w
->current_matrix
, vpos
);
24085 int start
= MATRIX_ROW_START_CHARPOS (r
);
24086 int pos
= string_buffer_position (w
, object
, start
);
24089 help
= Fget_char_property (make_number (pos
),
24090 Qhelp_echo
, w
->buffer
);
24094 object
= w
->buffer
;
24099 else if (BUFFERP (object
)
24102 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24107 help_echo_string
= help
;
24108 help_echo_window
= window
;
24109 help_echo_object
= object
;
24110 help_echo_pos
= charpos
;
24115 /* Look for a `pointer' property. */
24116 if (NILP (pointer
))
24118 /* Check overlays first. */
24119 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24120 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24122 if (NILP (pointer
))
24124 Lisp_Object object
= glyph
->object
;
24125 int charpos
= glyph
->charpos
;
24127 /* Try text properties. */
24128 if (STRINGP (object
)
24130 && charpos
< SCHARS (object
))
24132 pointer
= Fget_text_property (make_number (charpos
),
24134 if (NILP (pointer
))
24136 /* If the string itself doesn't specify a pointer,
24137 see if the buffer text ``under'' it does. */
24138 struct glyph_row
*r
24139 = MATRIX_ROW (w
->current_matrix
, vpos
);
24140 int start
= MATRIX_ROW_START_CHARPOS (r
);
24141 int pos
= string_buffer_position (w
, object
, start
);
24143 pointer
= Fget_char_property (make_number (pos
),
24144 Qpointer
, w
->buffer
);
24147 else if (BUFFERP (object
)
24150 pointer
= Fget_text_property (make_number (charpos
),
24157 current_buffer
= obuf
;
24162 define_frame_cursor1 (f
, cursor
, pointer
);
24167 Clear any mouse-face on window W. This function is part of the
24168 redisplay interface, and is called from try_window_id and similar
24169 functions to ensure the mouse-highlight is off. */
24172 x_clear_window_mouse_face (w
)
24175 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24176 Lisp_Object window
;
24179 XSETWINDOW (window
, w
);
24180 if (EQ (window
, dpyinfo
->mouse_face_window
))
24181 clear_mouse_face (dpyinfo
);
24187 Just discard the mouse face information for frame F, if any.
24188 This is used when the size of F is changed. */
24191 cancel_mouse_face (f
)
24194 Lisp_Object window
;
24195 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24197 window
= dpyinfo
->mouse_face_window
;
24198 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24200 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24201 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24202 dpyinfo
->mouse_face_window
= Qnil
;
24207 #endif /* HAVE_WINDOW_SYSTEM */
24210 /***********************************************************************
24212 ***********************************************************************/
24214 #ifdef HAVE_WINDOW_SYSTEM
24216 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24217 which intersects rectangle R. R is in window-relative coordinates. */
24220 expose_area (w
, row
, r
, area
)
24222 struct glyph_row
*row
;
24224 enum glyph_row_area area
;
24226 struct glyph
*first
= row
->glyphs
[area
];
24227 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24228 struct glyph
*last
;
24229 int first_x
, start_x
, x
;
24231 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24232 /* If row extends face to end of line write the whole line. */
24233 draw_glyphs (w
, 0, row
, area
,
24234 0, row
->used
[area
],
24235 DRAW_NORMAL_TEXT
, 0);
24238 /* Set START_X to the window-relative start position for drawing glyphs of
24239 AREA. The first glyph of the text area can be partially visible.
24240 The first glyphs of other areas cannot. */
24241 start_x
= window_box_left_offset (w
, area
);
24243 if (area
== TEXT_AREA
)
24246 /* Find the first glyph that must be redrawn. */
24248 && x
+ first
->pixel_width
< r
->x
)
24250 x
+= first
->pixel_width
;
24254 /* Find the last one. */
24258 && x
< r
->x
+ r
->width
)
24260 x
+= last
->pixel_width
;
24266 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24267 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24268 DRAW_NORMAL_TEXT
, 0);
24273 /* Redraw the parts of the glyph row ROW on window W intersecting
24274 rectangle R. R is in window-relative coordinates. Value is
24275 non-zero if mouse-face was overwritten. */
24278 expose_line (w
, row
, r
)
24280 struct glyph_row
*row
;
24283 xassert (row
->enabled_p
);
24285 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24286 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24287 0, row
->used
[TEXT_AREA
],
24288 DRAW_NORMAL_TEXT
, 0);
24291 if (row
->used
[LEFT_MARGIN_AREA
])
24292 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24293 if (row
->used
[TEXT_AREA
])
24294 expose_area (w
, row
, r
, TEXT_AREA
);
24295 if (row
->used
[RIGHT_MARGIN_AREA
])
24296 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24297 draw_row_fringe_bitmaps (w
, row
);
24300 return row
->mouse_face_p
;
24304 /* Redraw those parts of glyphs rows during expose event handling that
24305 overlap other rows. Redrawing of an exposed line writes over parts
24306 of lines overlapping that exposed line; this function fixes that.
24308 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24309 row in W's current matrix that is exposed and overlaps other rows.
24310 LAST_OVERLAPPING_ROW is the last such row. */
24313 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24315 struct glyph_row
*first_overlapping_row
;
24316 struct glyph_row
*last_overlapping_row
;
24319 struct glyph_row
*row
;
24321 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24322 if (row
->overlapping_p
)
24324 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24327 if (row
->used
[LEFT_MARGIN_AREA
])
24328 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24330 if (row
->used
[TEXT_AREA
])
24331 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24333 if (row
->used
[RIGHT_MARGIN_AREA
])
24334 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24340 /* Return non-zero if W's cursor intersects rectangle R. */
24343 phys_cursor_in_rect_p (w
, r
)
24347 XRectangle cr
, result
;
24348 struct glyph
*cursor_glyph
;
24349 struct glyph_row
*row
;
24351 if (w
->phys_cursor
.vpos
>= 0
24352 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24353 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24355 && row
->cursor_in_fringe_p
)
24357 /* Cursor is in the fringe. */
24358 cr
.x
= window_box_right_offset (w
,
24359 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24360 ? RIGHT_MARGIN_AREA
24363 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24364 cr
.height
= row
->height
;
24365 return x_intersect_rectangles (&cr
, r
, &result
);
24368 cursor_glyph
= get_phys_cursor_glyph (w
);
24371 /* r is relative to W's box, but w->phys_cursor.x is relative
24372 to left edge of W's TEXT area. Adjust it. */
24373 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24374 cr
.y
= w
->phys_cursor
.y
;
24375 cr
.width
= cursor_glyph
->pixel_width
;
24376 cr
.height
= w
->phys_cursor_height
;
24377 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24378 I assume the effect is the same -- and this is portable. */
24379 return x_intersect_rectangles (&cr
, r
, &result
);
24381 /* If we don't understand the format, pretend we're not in the hot-spot. */
24387 Draw a vertical window border to the right of window W if W doesn't
24388 have vertical scroll bars. */
24391 x_draw_vertical_border (w
)
24394 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24396 /* We could do better, if we knew what type of scroll-bar the adjacent
24397 windows (on either side) have... But we don't :-(
24398 However, I think this works ok. ++KFS 2003-04-25 */
24400 /* Redraw borders between horizontally adjacent windows. Don't
24401 do it for frames with vertical scroll bars because either the
24402 right scroll bar of a window, or the left scroll bar of its
24403 neighbor will suffice as a border. */
24404 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24407 if (!WINDOW_RIGHTMOST_P (w
)
24408 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24410 int x0
, x1
, y0
, y1
;
24412 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24415 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24418 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24420 else if (!WINDOW_LEFTMOST_P (w
)
24421 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24423 int x0
, x1
, y0
, y1
;
24425 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24428 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24431 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24436 /* Redraw the part of window W intersection rectangle FR. Pixel
24437 coordinates in FR are frame-relative. Call this function with
24438 input blocked. Value is non-zero if the exposure overwrites
24442 expose_window (w
, fr
)
24446 struct frame
*f
= XFRAME (w
->frame
);
24448 int mouse_face_overwritten_p
= 0;
24450 /* If window is not yet fully initialized, do nothing. This can
24451 happen when toolkit scroll bars are used and a window is split.
24452 Reconfiguring the scroll bar will generate an expose for a newly
24454 if (w
->current_matrix
== NULL
)
24457 /* When we're currently updating the window, display and current
24458 matrix usually don't agree. Arrange for a thorough display
24460 if (w
== updated_window
)
24462 SET_FRAME_GARBAGED (f
);
24466 /* Frame-relative pixel rectangle of W. */
24467 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24468 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24469 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24470 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24472 if (x_intersect_rectangles (fr
, &wr
, &r
))
24474 int yb
= window_text_bottom_y (w
);
24475 struct glyph_row
*row
;
24476 int cursor_cleared_p
;
24477 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24479 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24480 r
.x
, r
.y
, r
.width
, r
.height
));
24482 /* Convert to window coordinates. */
24483 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24484 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24486 /* Turn off the cursor. */
24487 if (!w
->pseudo_window_p
24488 && phys_cursor_in_rect_p (w
, &r
))
24490 x_clear_cursor (w
);
24491 cursor_cleared_p
= 1;
24494 cursor_cleared_p
= 0;
24496 /* Update lines intersecting rectangle R. */
24497 first_overlapping_row
= last_overlapping_row
= NULL
;
24498 for (row
= w
->current_matrix
->rows
;
24503 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24505 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24506 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24507 || (r
.y
>= y0
&& r
.y
< y1
)
24508 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24510 /* A header line may be overlapping, but there is no need
24511 to fix overlapping areas for them. KFS 2005-02-12 */
24512 if (row
->overlapping_p
&& !row
->mode_line_p
)
24514 if (first_overlapping_row
== NULL
)
24515 first_overlapping_row
= row
;
24516 last_overlapping_row
= row
;
24520 if (expose_line (w
, row
, &r
))
24521 mouse_face_overwritten_p
= 1;
24524 else if (row
->overlapping_p
)
24526 /* We must redraw a row overlapping the exposed area. */
24528 ? y0
+ row
->phys_height
> r
.y
24529 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24531 if (first_overlapping_row
== NULL
)
24532 first_overlapping_row
= row
;
24533 last_overlapping_row
= row
;
24541 /* Display the mode line if there is one. */
24542 if (WINDOW_WANTS_MODELINE_P (w
)
24543 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24545 && row
->y
< r
.y
+ r
.height
)
24547 if (expose_line (w
, row
, &r
))
24548 mouse_face_overwritten_p
= 1;
24551 if (!w
->pseudo_window_p
)
24553 /* Fix the display of overlapping rows. */
24554 if (first_overlapping_row
)
24555 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24558 /* Draw border between windows. */
24559 x_draw_vertical_border (w
);
24561 /* Turn the cursor on again. */
24562 if (cursor_cleared_p
)
24563 update_window_cursor (w
, 1);
24567 return mouse_face_overwritten_p
;
24572 /* Redraw (parts) of all windows in the window tree rooted at W that
24573 intersect R. R contains frame pixel coordinates. Value is
24574 non-zero if the exposure overwrites mouse-face. */
24577 expose_window_tree (w
, r
)
24581 struct frame
*f
= XFRAME (w
->frame
);
24582 int mouse_face_overwritten_p
= 0;
24584 while (w
&& !FRAME_GARBAGED_P (f
))
24586 if (!NILP (w
->hchild
))
24587 mouse_face_overwritten_p
24588 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24589 else if (!NILP (w
->vchild
))
24590 mouse_face_overwritten_p
24591 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24593 mouse_face_overwritten_p
|= expose_window (w
, r
);
24595 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24598 return mouse_face_overwritten_p
;
24603 Redisplay an exposed area of frame F. X and Y are the upper-left
24604 corner of the exposed rectangle. W and H are width and height of
24605 the exposed area. All are pixel values. W or H zero means redraw
24606 the entire frame. */
24609 expose_frame (f
, x
, y
, w
, h
)
24614 int mouse_face_overwritten_p
= 0;
24616 TRACE ((stderr
, "expose_frame "));
24618 /* No need to redraw if frame will be redrawn soon. */
24619 if (FRAME_GARBAGED_P (f
))
24621 TRACE ((stderr
, " garbaged\n"));
24625 /* If basic faces haven't been realized yet, there is no point in
24626 trying to redraw anything. This can happen when we get an expose
24627 event while Emacs is starting, e.g. by moving another window. */
24628 if (FRAME_FACE_CACHE (f
) == NULL
24629 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24631 TRACE ((stderr
, " no faces\n"));
24635 if (w
== 0 || h
== 0)
24638 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24639 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24649 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24650 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24652 if (WINDOWP (f
->tool_bar_window
))
24653 mouse_face_overwritten_p
24654 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24656 #ifdef HAVE_X_WINDOWS
24658 #ifndef USE_X_TOOLKIT
24659 if (WINDOWP (f
->menu_bar_window
))
24660 mouse_face_overwritten_p
24661 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24662 #endif /* not USE_X_TOOLKIT */
24666 /* Some window managers support a focus-follows-mouse style with
24667 delayed raising of frames. Imagine a partially obscured frame,
24668 and moving the mouse into partially obscured mouse-face on that
24669 frame. The visible part of the mouse-face will be highlighted,
24670 then the WM raises the obscured frame. With at least one WM, KDE
24671 2.1, Emacs is not getting any event for the raising of the frame
24672 (even tried with SubstructureRedirectMask), only Expose events.
24673 These expose events will draw text normally, i.e. not
24674 highlighted. Which means we must redo the highlight here.
24675 Subsume it under ``we love X''. --gerd 2001-08-15 */
24676 /* Included in Windows version because Windows most likely does not
24677 do the right thing if any third party tool offers
24678 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24679 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24681 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24682 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24684 int x
= dpyinfo
->mouse_face_mouse_x
;
24685 int y
= dpyinfo
->mouse_face_mouse_y
;
24686 clear_mouse_face (dpyinfo
);
24687 note_mouse_highlight (f
, x
, y
);
24694 Determine the intersection of two rectangles R1 and R2. Return
24695 the intersection in *RESULT. Value is non-zero if RESULT is not
24699 x_intersect_rectangles (r1
, r2
, result
)
24700 XRectangle
*r1
, *r2
, *result
;
24702 XRectangle
*left
, *right
;
24703 XRectangle
*upper
, *lower
;
24704 int intersection_p
= 0;
24706 /* Rearrange so that R1 is the left-most rectangle. */
24708 left
= r1
, right
= r2
;
24710 left
= r2
, right
= r1
;
24712 /* X0 of the intersection is right.x0, if this is inside R1,
24713 otherwise there is no intersection. */
24714 if (right
->x
<= left
->x
+ left
->width
)
24716 result
->x
= right
->x
;
24718 /* The right end of the intersection is the minimum of the
24719 the right ends of left and right. */
24720 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24723 /* Same game for Y. */
24725 upper
= r1
, lower
= r2
;
24727 upper
= r2
, lower
= r1
;
24729 /* The upper end of the intersection is lower.y0, if this is inside
24730 of upper. Otherwise, there is no intersection. */
24731 if (lower
->y
<= upper
->y
+ upper
->height
)
24733 result
->y
= lower
->y
;
24735 /* The lower end of the intersection is the minimum of the lower
24736 ends of upper and lower. */
24737 result
->height
= (min (lower
->y
+ lower
->height
,
24738 upper
->y
+ upper
->height
)
24740 intersection_p
= 1;
24744 return intersection_p
;
24747 #endif /* HAVE_WINDOW_SYSTEM */
24750 /***********************************************************************
24752 ***********************************************************************/
24757 Vwith_echo_area_save_vector
= Qnil
;
24758 staticpro (&Vwith_echo_area_save_vector
);
24760 Vmessage_stack
= Qnil
;
24761 staticpro (&Vmessage_stack
);
24763 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24764 staticpro (&Qinhibit_redisplay
);
24766 message_dolog_marker1
= Fmake_marker ();
24767 staticpro (&message_dolog_marker1
);
24768 message_dolog_marker2
= Fmake_marker ();
24769 staticpro (&message_dolog_marker2
);
24770 message_dolog_marker3
= Fmake_marker ();
24771 staticpro (&message_dolog_marker3
);
24774 defsubr (&Sdump_frame_glyph_matrix
);
24775 defsubr (&Sdump_glyph_matrix
);
24776 defsubr (&Sdump_glyph_row
);
24777 defsubr (&Sdump_tool_bar_row
);
24778 defsubr (&Strace_redisplay
);
24779 defsubr (&Strace_to_stderr
);
24781 #ifdef HAVE_WINDOW_SYSTEM
24782 defsubr (&Stool_bar_lines_needed
);
24783 defsubr (&Slookup_image_map
);
24785 defsubr (&Sformat_mode_line
);
24786 defsubr (&Sinvisible_p
);
24788 staticpro (&Qmenu_bar_update_hook
);
24789 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24791 staticpro (&Qoverriding_terminal_local_map
);
24792 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24794 staticpro (&Qoverriding_local_map
);
24795 Qoverriding_local_map
= intern ("overriding-local-map");
24797 staticpro (&Qwindow_scroll_functions
);
24798 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24800 staticpro (&Qwindow_text_change_functions
);
24801 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24803 staticpro (&Qredisplay_end_trigger_functions
);
24804 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24806 staticpro (&Qinhibit_point_motion_hooks
);
24807 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24809 Qeval
= intern ("eval");
24810 staticpro (&Qeval
);
24812 QCdata
= intern (":data");
24813 staticpro (&QCdata
);
24814 Qdisplay
= intern ("display");
24815 staticpro (&Qdisplay
);
24816 Qspace_width
= intern ("space-width");
24817 staticpro (&Qspace_width
);
24818 Qraise
= intern ("raise");
24819 staticpro (&Qraise
);
24820 Qslice
= intern ("slice");
24821 staticpro (&Qslice
);
24822 Qspace
= intern ("space");
24823 staticpro (&Qspace
);
24824 Qmargin
= intern ("margin");
24825 staticpro (&Qmargin
);
24826 Qpointer
= intern ("pointer");
24827 staticpro (&Qpointer
);
24828 Qleft_margin
= intern ("left-margin");
24829 staticpro (&Qleft_margin
);
24830 Qright_margin
= intern ("right-margin");
24831 staticpro (&Qright_margin
);
24832 Qcenter
= intern ("center");
24833 staticpro (&Qcenter
);
24834 Qline_height
= intern ("line-height");
24835 staticpro (&Qline_height
);
24836 QCalign_to
= intern (":align-to");
24837 staticpro (&QCalign_to
);
24838 QCrelative_width
= intern (":relative-width");
24839 staticpro (&QCrelative_width
);
24840 QCrelative_height
= intern (":relative-height");
24841 staticpro (&QCrelative_height
);
24842 QCeval
= intern (":eval");
24843 staticpro (&QCeval
);
24844 QCpropertize
= intern (":propertize");
24845 staticpro (&QCpropertize
);
24846 QCfile
= intern (":file");
24847 staticpro (&QCfile
);
24848 Qfontified
= intern ("fontified");
24849 staticpro (&Qfontified
);
24850 Qfontification_functions
= intern ("fontification-functions");
24851 staticpro (&Qfontification_functions
);
24852 Qtrailing_whitespace
= intern ("trailing-whitespace");
24853 staticpro (&Qtrailing_whitespace
);
24854 Qescape_glyph
= intern ("escape-glyph");
24855 staticpro (&Qescape_glyph
);
24856 Qnobreak_space
= intern ("nobreak-space");
24857 staticpro (&Qnobreak_space
);
24858 Qimage
= intern ("image");
24859 staticpro (&Qimage
);
24860 QCmap
= intern (":map");
24861 staticpro (&QCmap
);
24862 QCpointer
= intern (":pointer");
24863 staticpro (&QCpointer
);
24864 Qrect
= intern ("rect");
24865 staticpro (&Qrect
);
24866 Qcircle
= intern ("circle");
24867 staticpro (&Qcircle
);
24868 Qpoly
= intern ("poly");
24869 staticpro (&Qpoly
);
24870 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24871 staticpro (&Qmessage_truncate_lines
);
24872 Qgrow_only
= intern ("grow-only");
24873 staticpro (&Qgrow_only
);
24874 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24875 staticpro (&Qinhibit_menubar_update
);
24876 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24877 staticpro (&Qinhibit_eval_during_redisplay
);
24878 Qposition
= intern ("position");
24879 staticpro (&Qposition
);
24880 Qbuffer_position
= intern ("buffer-position");
24881 staticpro (&Qbuffer_position
);
24882 Qobject
= intern ("object");
24883 staticpro (&Qobject
);
24884 Qbar
= intern ("bar");
24886 Qhbar
= intern ("hbar");
24887 staticpro (&Qhbar
);
24888 Qbox
= intern ("box");
24890 Qhollow
= intern ("hollow");
24891 staticpro (&Qhollow
);
24892 Qhand
= intern ("hand");
24893 staticpro (&Qhand
);
24894 Qarrow
= intern ("arrow");
24895 staticpro (&Qarrow
);
24896 Qtext
= intern ("text");
24897 staticpro (&Qtext
);
24898 Qrisky_local_variable
= intern ("risky-local-variable");
24899 staticpro (&Qrisky_local_variable
);
24900 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24901 staticpro (&Qinhibit_free_realized_faces
);
24903 list_of_error
= Fcons (Fcons (intern ("error"),
24904 Fcons (intern ("void-variable"), Qnil
)),
24906 staticpro (&list_of_error
);
24908 Qlast_arrow_position
= intern ("last-arrow-position");
24909 staticpro (&Qlast_arrow_position
);
24910 Qlast_arrow_string
= intern ("last-arrow-string");
24911 staticpro (&Qlast_arrow_string
);
24913 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24914 staticpro (&Qoverlay_arrow_string
);
24915 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24916 staticpro (&Qoverlay_arrow_bitmap
);
24918 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24919 staticpro (&echo_buffer
[0]);
24920 staticpro (&echo_buffer
[1]);
24922 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24923 staticpro (&echo_area_buffer
[0]);
24924 staticpro (&echo_area_buffer
[1]);
24926 Vmessages_buffer_name
= build_string ("*Messages*");
24927 staticpro (&Vmessages_buffer_name
);
24929 mode_line_proptrans_alist
= Qnil
;
24930 staticpro (&mode_line_proptrans_alist
);
24931 mode_line_string_list
= Qnil
;
24932 staticpro (&mode_line_string_list
);
24933 mode_line_string_face
= Qnil
;
24934 staticpro (&mode_line_string_face
);
24935 mode_line_string_face_prop
= Qnil
;
24936 staticpro (&mode_line_string_face_prop
);
24937 Vmode_line_unwind_vector
= Qnil
;
24938 staticpro (&Vmode_line_unwind_vector
);
24940 help_echo_string
= Qnil
;
24941 staticpro (&help_echo_string
);
24942 help_echo_object
= Qnil
;
24943 staticpro (&help_echo_object
);
24944 help_echo_window
= Qnil
;
24945 staticpro (&help_echo_window
);
24946 previous_help_echo_string
= Qnil
;
24947 staticpro (&previous_help_echo_string
);
24948 help_echo_pos
= -1;
24950 #ifdef HAVE_WINDOW_SYSTEM
24951 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24952 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24953 For example, if a block cursor is over a tab, it will be drawn as
24954 wide as that tab on the display. */);
24955 x_stretch_cursor_p
= 0;
24958 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24959 doc
: /* *Non-nil means highlight trailing whitespace.
24960 The face used for trailing whitespace is `trailing-whitespace'. */);
24961 Vshow_trailing_whitespace
= Qnil
;
24963 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24964 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24965 A value of t means highlight the character itself (for nobreak space,
24966 use face `nobreak-space').
24967 A value of nil means no highlighting.
24968 Other values mean display the escape glyph followed by an ordinary
24969 space or ordinary hyphen. */);
24970 Vnobreak_char_display
= Qt
;
24972 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24973 doc
: /* *The pointer shape to show in void text areas.
24974 A value of nil means to show the text pointer. Other options are `arrow',
24975 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24976 Vvoid_text_area_pointer
= Qarrow
;
24978 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24979 doc
: /* Non-nil means don't actually do any redisplay.
24980 This is used for internal purposes. */);
24981 Vinhibit_redisplay
= Qnil
;
24983 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24984 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24985 Vglobal_mode_string
= Qnil
;
24987 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24988 doc
: /* Marker for where to display an arrow on top of the buffer text.
24989 This must be the beginning of a line in order to work.
24990 See also `overlay-arrow-string'. */);
24991 Voverlay_arrow_position
= Qnil
;
24993 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24994 doc
: /* String to display as an arrow in non-window frames.
24995 See also `overlay-arrow-position'. */);
24996 Voverlay_arrow_string
= build_string ("=>");
24998 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24999 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25000 The symbols on this list are examined during redisplay to determine
25001 where to display overlay arrows. */);
25002 Voverlay_arrow_variable_list
25003 = Fcons (intern ("overlay-arrow-position"), Qnil
);
25005 DEFVAR_INT ("scroll-step", &scroll_step
,
25006 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25007 If that fails to bring point back on frame, point is centered instead.
25008 If this is zero, point is always centered after it moves off frame.
25009 If you want scrolling to always be a line at a time, you should set
25010 `scroll-conservatively' to a large value rather than set this to 1. */);
25012 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25013 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25014 If point moves off-screen, redisplay will scroll by up to
25015 `scroll-conservatively' lines in order to bring point just barely
25016 onto the screen again. If that cannot be done, then redisplay
25017 recenters point as usual.
25019 A value of zero means always recenter point if it moves off screen. */);
25020 scroll_conservatively
= 0;
25022 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25023 doc
: /* *Number of lines of margin at the top and bottom of a window.
25024 Recenter the window whenever point gets within this many lines
25025 of the top or bottom of the window. */);
25028 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25029 doc
: /* Pixels per inch value for non-window system displays.
25030 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25031 Vdisplay_pixels_per_inch
= make_float (72.0);
25034 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25037 DEFVAR_LISP ("truncate-partial-width-windows",
25038 &Vtruncate_partial_width_windows
,
25039 doc
: /* Non-nil means truncate lines in windows with less than the frame width.
25040 For an integer value, truncate lines in each window with less than the
25041 full frame width, provided the window width is less than that integer;
25042 otherwise, respect the value of `truncate-lines'.
25044 For any other non-nil value, truncate lines in all windows with
25045 less than the full frame width.
25047 A value of nil means to respect the value of `truncate-lines'.
25049 If `word-wrap' is enabled, you might want to reduce this. */);
25050 Vtruncate_partial_width_windows
= make_number (50);
25052 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25053 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25054 Any other value means to use the appropriate face, `mode-line',
25055 `header-line', or `menu' respectively. */);
25056 mode_line_inverse_video
= 1;
25058 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25059 doc
: /* *Maximum buffer size for which line number should be displayed.
25060 If the buffer is bigger than this, the line number does not appear
25061 in the mode line. A value of nil means no limit. */);
25062 Vline_number_display_limit
= Qnil
;
25064 DEFVAR_INT ("line-number-display-limit-width",
25065 &line_number_display_limit_width
,
25066 doc
: /* *Maximum line width (in characters) for line number display.
25067 If the average length of the lines near point is bigger than this, then the
25068 line number may be omitted from the mode line. */);
25069 line_number_display_limit_width
= 200;
25071 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25072 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25073 highlight_nonselected_windows
= 0;
25075 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25076 doc
: /* Non-nil if more than one frame is visible on this display.
25077 Minibuffer-only frames don't count, but iconified frames do.
25078 This variable is not guaranteed to be accurate except while processing
25079 `frame-title-format' and `icon-title-format'. */);
25081 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25082 doc
: /* Template for displaying the title bar of visible frames.
25083 \(Assuming the window manager supports this feature.)
25085 This variable has the same structure as `mode-line-format', except that
25086 the %c and %l constructs are ignored. It is used only on frames for
25087 which no explicit name has been set \(see `modify-frame-parameters'). */);
25089 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25090 doc
: /* Template for displaying the title bar of an iconified frame.
25091 \(Assuming the window manager supports this feature.)
25092 This variable has the same structure as `mode-line-format' (which see),
25093 and is used only on frames for which no explicit name has been set
25094 \(see `modify-frame-parameters'). */);
25096 = Vframe_title_format
25097 = Fcons (intern ("multiple-frames"),
25098 Fcons (build_string ("%b"),
25099 Fcons (Fcons (empty_unibyte_string
,
25100 Fcons (intern ("invocation-name"),
25101 Fcons (build_string ("@"),
25102 Fcons (intern ("system-name"),
25106 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25107 doc
: /* Maximum number of lines to keep in the message log buffer.
25108 If nil, disable message logging. If t, log messages but don't truncate
25109 the buffer when it becomes large. */);
25110 Vmessage_log_max
= make_number (100);
25112 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25113 doc
: /* Functions called before redisplay, if window sizes have changed.
25114 The value should be a list of functions that take one argument.
25115 Just before redisplay, for each frame, if any of its windows have changed
25116 size since the last redisplay, or have been split or deleted,
25117 all the functions in the list are called, with the frame as argument. */);
25118 Vwindow_size_change_functions
= Qnil
;
25120 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25121 doc
: /* List of functions to call before redisplaying a window with scrolling.
25122 Each function is called with two arguments, the window and its new
25123 display-start position. Note that these functions are also called by
25124 `set-window-buffer'. Also note that the value of `window-end' is not
25125 valid when these functions are called. */);
25126 Vwindow_scroll_functions
= Qnil
;
25128 DEFVAR_LISP ("window-text-change-functions",
25129 &Vwindow_text_change_functions
,
25130 doc
: /* Functions to call in redisplay when text in the window might change. */);
25131 Vwindow_text_change_functions
= Qnil
;
25133 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25134 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25135 Each function is called with two arguments, the window and the end trigger value.
25136 See `set-window-redisplay-end-trigger'. */);
25137 Vredisplay_end_trigger_functions
= Qnil
;
25139 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25140 doc
: /* *Non-nil means autoselect window with mouse pointer.
25141 If nil, do not autoselect windows.
25142 A positive number means delay autoselection by that many seconds: a
25143 window is autoselected only after the mouse has remained in that
25144 window for the duration of the delay.
25145 A negative number has a similar effect, but causes windows to be
25146 autoselected only after the mouse has stopped moving. \(Because of
25147 the way Emacs compares mouse events, you will occasionally wait twice
25148 that time before the window gets selected.\)
25149 Any other value means to autoselect window instantaneously when the
25150 mouse pointer enters it.
25152 Autoselection selects the minibuffer only if it is active, and never
25153 unselects the minibuffer if it is active.
25155 When customizing this variable make sure that the actual value of
25156 `focus-follows-mouse' matches the behavior of your window manager. */);
25157 Vmouse_autoselect_window
= Qnil
;
25159 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25160 doc
: /* *Non-nil means automatically resize tool-bars.
25161 This dynamically changes the tool-bar's height to the minimum height
25162 that is needed to make all tool-bar items visible.
25163 If value is `grow-only', the tool-bar's height is only increased
25164 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25165 Vauto_resize_tool_bars
= Qt
;
25167 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25168 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25169 auto_raise_tool_bar_buttons_p
= 1;
25171 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25172 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25173 make_cursor_line_fully_visible_p
= 1;
25175 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25176 doc
: /* *Border below tool-bar in pixels.
25177 If an integer, use it as the height of the border.
25178 If it is one of `internal-border-width' or `border-width', use the
25179 value of the corresponding frame parameter.
25180 Otherwise, no border is added below the tool-bar. */);
25181 Vtool_bar_border
= Qinternal_border_width
;
25183 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25184 doc
: /* *Margin around tool-bar buttons in pixels.
25185 If an integer, use that for both horizontal and vertical margins.
25186 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25187 HORZ specifying the horizontal margin, and VERT specifying the
25188 vertical margin. */);
25189 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25191 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25192 doc
: /* *Relief thickness of tool-bar buttons. */);
25193 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25195 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25196 doc
: /* List of functions to call to fontify regions of text.
25197 Each function is called with one argument POS. Functions must
25198 fontify a region starting at POS in the current buffer, and give
25199 fontified regions the property `fontified'. */);
25200 Vfontification_functions
= Qnil
;
25201 Fmake_variable_buffer_local (Qfontification_functions
);
25203 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25204 &unibyte_display_via_language_environment
,
25205 doc
: /* *Non-nil means display unibyte text according to language environment.
25206 Specifically this means that unibyte non-ASCII characters
25207 are displayed by converting them to the equivalent multibyte characters
25208 according to the current language environment. As a result, they are
25209 displayed according to the current fontset. */);
25210 unibyte_display_via_language_environment
= 0;
25212 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25213 doc
: /* *Maximum height for resizing mini-windows.
25214 If a float, it specifies a fraction of the mini-window frame's height.
25215 If an integer, it specifies a number of lines. */);
25216 Vmax_mini_window_height
= make_float (0.25);
25218 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25219 doc
: /* *How to resize mini-windows.
25220 A value of nil means don't automatically resize mini-windows.
25221 A value of t means resize them to fit the text displayed in them.
25222 A value of `grow-only', the default, means let mini-windows grow
25223 only, until their display becomes empty, at which point the windows
25224 go back to their normal size. */);
25225 Vresize_mini_windows
= Qgrow_only
;
25227 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25228 doc
: /* Alist specifying how to blink the cursor off.
25229 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25230 `cursor-type' frame-parameter or variable equals ON-STATE,
25231 comparing using `equal', Emacs uses OFF-STATE to specify
25232 how to blink it off. ON-STATE and OFF-STATE are values for
25233 the `cursor-type' frame parameter.
25235 If a frame's ON-STATE has no entry in this list,
25236 the frame's other specifications determine how to blink the cursor off. */);
25237 Vblink_cursor_alist
= Qnil
;
25239 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25240 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25241 automatic_hscrolling_p
= 1;
25242 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
25243 staticpro (&Qauto_hscroll_mode
);
25245 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25246 doc
: /* *How many columns away from the window edge point is allowed to get
25247 before automatic hscrolling will horizontally scroll the window. */);
25248 hscroll_margin
= 5;
25250 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25251 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25252 When point is less than `hscroll-margin' columns from the window
25253 edge, automatic hscrolling will scroll the window by the amount of columns
25254 determined by this variable. If its value is a positive integer, scroll that
25255 many columns. If it's a positive floating-point number, it specifies the
25256 fraction of the window's width to scroll. If it's nil or zero, point will be
25257 centered horizontally after the scroll. Any other value, including negative
25258 numbers, are treated as if the value were zero.
25260 Automatic hscrolling always moves point outside the scroll margin, so if
25261 point was more than scroll step columns inside the margin, the window will
25262 scroll more than the value given by the scroll step.
25264 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25265 and `scroll-right' overrides this variable's effect. */);
25266 Vhscroll_step
= make_number (0);
25268 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25269 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25270 Bind this around calls to `message' to let it take effect. */);
25271 message_truncate_lines
= 0;
25273 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25274 doc
: /* Normal hook run to update the menu bar definitions.
25275 Redisplay runs this hook before it redisplays the menu bar.
25276 This is used to update submenus such as Buffers,
25277 whose contents depend on various data. */);
25278 Vmenu_bar_update_hook
= Qnil
;
25280 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25281 doc
: /* Frame for which we are updating a menu.
25282 The enable predicate for a menu binding should check this variable. */);
25283 Vmenu_updating_frame
= Qnil
;
25285 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25286 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25287 inhibit_menubar_update
= 0;
25289 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25290 doc
: /* Prefix prepended to all continuation lines at display time.
25291 The value may be a string, an image, or a stretch-glyph; it is
25292 interpreted in the same way as the value of a `display' text property.
25294 This variable is overridden by any `wrap-prefix' text or overlay
25297 To add a prefix to non-continuation lines, use `line-prefix'. */);
25298 Vwrap_prefix
= Qnil
;
25299 staticpro (&Qwrap_prefix
);
25300 Qwrap_prefix
= intern ("wrap-prefix");
25301 Fmake_variable_buffer_local (Qwrap_prefix
);
25303 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25304 doc
: /* Prefix prepended to all non-continuation lines at display time.
25305 The value may be a string, an image, or a stretch-glyph; it is
25306 interpreted in the same way as the value of a `display' text property.
25308 This variable is overridden by any `line-prefix' text or overlay
25311 To add a prefix to continuation lines, use `wrap-prefix'. */);
25312 Vline_prefix
= Qnil
;
25313 staticpro (&Qline_prefix
);
25314 Qline_prefix
= intern ("line-prefix");
25315 Fmake_variable_buffer_local (Qline_prefix
);
25317 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25318 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25319 inhibit_eval_during_redisplay
= 0;
25321 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25322 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25323 inhibit_free_realized_faces
= 0;
25326 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25327 doc
: /* Inhibit try_window_id display optimization. */);
25328 inhibit_try_window_id
= 0;
25330 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25331 doc
: /* Inhibit try_window_reusing display optimization. */);
25332 inhibit_try_window_reusing
= 0;
25334 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25335 doc
: /* Inhibit try_cursor_movement display optimization. */);
25336 inhibit_try_cursor_movement
= 0;
25337 #endif /* GLYPH_DEBUG */
25339 DEFVAR_INT ("overline-margin", &overline_margin
,
25340 doc
: /* *Space between overline and text, in pixels.
25341 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25342 margin to the caracter height. */);
25343 overline_margin
= 2;
25345 DEFVAR_INT ("underline-minimum-offset",
25346 &underline_minimum_offset
,
25347 doc
: /* Minimum distance between baseline and underline.
25348 This can improve legibility of underlined text at small font sizes,
25349 particularly when using variable `x-use-underline-position-properties'
25350 with fonts that specify an UNDERLINE_POSITION relatively close to the
25351 baseline. The default value is 1. */);
25352 underline_minimum_offset
= 1;
25354 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25355 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25356 display_hourglass_p
= 1;
25358 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25359 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25360 Value must be an integer or float. */);
25361 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25363 hourglass_atimer
= NULL
;
25364 hourglass_shown_p
= 0;
25368 /* Initialize this module when Emacs starts. */
25373 Lisp_Object root_window
;
25374 struct window
*mini_w
;
25376 current_header_line_height
= current_mode_line_height
= -1;
25378 CHARPOS (this_line_start_pos
) = 0;
25380 mini_w
= XWINDOW (minibuf_window
);
25381 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25383 if (!noninteractive
)
25385 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25388 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25389 set_window_height (root_window
,
25390 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25392 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25393 set_window_height (minibuf_window
, 1, 0);
25395 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25396 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25398 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25399 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25400 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25402 /* The default ellipsis glyphs `...'. */
25403 for (i
= 0; i
< 3; ++i
)
25404 default_invis_vector
[i
] = make_number ('.');
25408 /* Allocate the buffer for frame titles.
25409 Also used for `format-mode-line'. */
25411 mode_line_noprop_buf
= (char *) xmalloc (size
);
25412 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25413 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25414 mode_line_target
= MODE_LINE_DISPLAY
;
25417 help_echo_showing_p
= 0;
25420 /* Since w32 does not support atimers, it defines its own implementation of
25421 the following three functions in w32fns.c. */
25424 /* Platform-independent portion of hourglass implementation. */
25426 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25428 hourglass_started ()
25430 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25433 /* Cancel a currently active hourglass timer, and start a new one. */
25437 #if defined (HAVE_WINDOW_SYSTEM)
25439 int secs
, usecs
= 0;
25441 cancel_hourglass ();
25443 if (INTEGERP (Vhourglass_delay
)
25444 && XINT (Vhourglass_delay
) > 0)
25445 secs
= XFASTINT (Vhourglass_delay
);
25446 else if (FLOATP (Vhourglass_delay
)
25447 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25450 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25451 secs
= XFASTINT (tem
);
25452 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25455 secs
= DEFAULT_HOURGLASS_DELAY
;
25457 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25458 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25459 show_hourglass
, NULL
);
25464 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25467 cancel_hourglass ()
25469 #if defined (HAVE_WINDOW_SYSTEM)
25470 if (hourglass_atimer
)
25472 cancel_atimer (hourglass_atimer
);
25473 hourglass_atimer
= NULL
;
25476 if (hourglass_shown_p
)
25480 #endif /* ! WINDOWSNT */
25482 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25483 (do not change this comment) */