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 /* Note that we may overshoot because of invisible text. */
1353 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1355 int top_x
= it
.current_x
;
1356 int top_y
= it
.current_y
;
1357 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1358 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1360 if (top_y
< window_top_y
)
1361 visible_p
= bottom_y
> window_top_y
;
1362 else if (top_y
< it
.last_visible_y
)
1366 if (it
.method
== GET_FROM_BUFFER
)
1368 Lisp_Object window
, prop
;
1370 XSETWINDOW (window
, w
);
1371 prop
= Fget_char_property (make_number (it
.position
.charpos
),
1372 Qinvisible
, window
);
1374 /* If charpos coincides with invisible text covered with an
1375 ellipsis, use the first glyph of the ellipsis to compute
1376 the pixel positions. */
1377 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1379 struct glyph_row
*row
= it
.glyph_row
;
1380 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1381 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1384 for (; glyph
< end
&& glyph
->charpos
< charpos
; glyph
++)
1385 x
+= glyph
->pixel_width
;
1392 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1393 *rtop
= max (0, window_top_y
- top_y
);
1394 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1395 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1396 - max (top_y
, window_top_y
)));
1405 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1406 move_it_by_lines (&it
, 1, 0);
1407 if (charpos
< IT_CHARPOS (it
)
1408 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1411 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1413 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1414 *rtop
= max (0, -it2
.current_y
);
1415 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1416 - it
.last_visible_y
));
1417 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1419 - max (it2
.current_y
,
1420 WINDOW_HEADER_LINE_HEIGHT (w
))));
1426 set_buffer_internal_1 (old_buffer
);
1428 current_header_line_height
= current_mode_line_height
= -1;
1430 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1431 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1434 /* Debugging code. */
1436 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1437 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1439 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1446 /* Return the next character from STR which is MAXLEN bytes long.
1447 Return in *LEN the length of the character. This is like
1448 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1449 we find one, we return a `?', but with the length of the invalid
1453 string_char_and_length (str
, maxlen
, len
)
1454 const unsigned char *str
;
1459 c
= STRING_CHAR_AND_LENGTH (str
, maxlen
, *len
);
1460 if (!CHAR_VALID_P (c
, 1))
1461 /* We may not change the length here because other places in Emacs
1462 don't use this function, i.e. they silently accept invalid
1471 /* Given a position POS containing a valid character and byte position
1472 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1474 static struct text_pos
1475 string_pos_nchars_ahead (pos
, string
, nchars
)
1476 struct text_pos pos
;
1480 xassert (STRINGP (string
) && nchars
>= 0);
1482 if (STRING_MULTIBYTE (string
))
1484 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1485 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1490 string_char_and_length (p
, rest
, &len
);
1491 p
+= len
, rest
-= len
;
1492 xassert (rest
>= 0);
1494 BYTEPOS (pos
) += len
;
1498 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1504 /* Value is the text position, i.e. character and byte position,
1505 for character position CHARPOS in STRING. */
1507 static INLINE
struct text_pos
1508 string_pos (charpos
, string
)
1512 struct text_pos pos
;
1513 xassert (STRINGP (string
));
1514 xassert (charpos
>= 0);
1515 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1520 /* Value is a text position, i.e. character and byte position, for
1521 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1522 means recognize multibyte characters. */
1524 static struct text_pos
1525 c_string_pos (charpos
, s
, multibyte_p
)
1530 struct text_pos pos
;
1532 xassert (s
!= NULL
);
1533 xassert (charpos
>= 0);
1537 int rest
= strlen (s
), len
;
1539 SET_TEXT_POS (pos
, 0, 0);
1542 string_char_and_length (s
, rest
, &len
);
1543 s
+= len
, rest
-= len
;
1544 xassert (rest
>= 0);
1546 BYTEPOS (pos
) += len
;
1550 SET_TEXT_POS (pos
, charpos
, charpos
);
1556 /* Value is the number of characters in C string S. MULTIBYTE_P
1557 non-zero means recognize multibyte characters. */
1560 number_of_chars (s
, multibyte_p
)
1568 int rest
= strlen (s
), len
;
1569 unsigned char *p
= (unsigned char *) s
;
1571 for (nchars
= 0; rest
> 0; ++nchars
)
1573 string_char_and_length (p
, rest
, &len
);
1574 rest
-= len
, p
+= len
;
1578 nchars
= strlen (s
);
1584 /* Compute byte position NEWPOS->bytepos corresponding to
1585 NEWPOS->charpos. POS is a known position in string STRING.
1586 NEWPOS->charpos must be >= POS.charpos. */
1589 compute_string_pos (newpos
, pos
, string
)
1590 struct text_pos
*newpos
, pos
;
1593 xassert (STRINGP (string
));
1594 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1596 if (STRING_MULTIBYTE (string
))
1597 *newpos
= string_pos_nchars_ahead (pos
, string
,
1598 CHARPOS (*newpos
) - CHARPOS (pos
));
1600 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1604 Return an estimation of the pixel height of mode or top lines on
1605 frame F. FACE_ID specifies what line's height to estimate. */
1608 estimate_mode_line_height (f
, face_id
)
1610 enum face_id face_id
;
1612 #ifdef HAVE_WINDOW_SYSTEM
1613 if (FRAME_WINDOW_P (f
))
1615 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1617 /* This function is called so early when Emacs starts that the face
1618 cache and mode line face are not yet initialized. */
1619 if (FRAME_FACE_CACHE (f
))
1621 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1625 height
= FONT_HEIGHT (face
->font
);
1626 if (face
->box_line_width
> 0)
1627 height
+= 2 * face
->box_line_width
;
1638 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1639 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1640 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1641 not force the value into range. */
1644 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1646 register int pix_x
, pix_y
;
1648 NativeRectangle
*bounds
;
1652 #ifdef HAVE_WINDOW_SYSTEM
1653 if (FRAME_WINDOW_P (f
))
1655 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1656 even for negative values. */
1658 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1660 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1662 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1663 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1666 STORE_NATIVE_RECT (*bounds
,
1667 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1668 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1669 FRAME_COLUMN_WIDTH (f
) - 1,
1670 FRAME_LINE_HEIGHT (f
) - 1);
1676 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1677 pix_x
= FRAME_TOTAL_COLS (f
);
1681 else if (pix_y
> FRAME_LINES (f
))
1682 pix_y
= FRAME_LINES (f
);
1692 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1693 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1694 can't tell the positions because W's display is not up to date,
1698 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1701 int *frame_x
, *frame_y
;
1703 #ifdef HAVE_WINDOW_SYSTEM
1704 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1708 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1709 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1711 if (display_completed
)
1713 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1714 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1715 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1721 hpos
+= glyph
->pixel_width
;
1725 /* If first glyph is partially visible, its first visible position is still 0. */
1737 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1738 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1749 #ifdef HAVE_WINDOW_SYSTEM
1751 /* Find the glyph under window-relative coordinates X/Y in window W.
1752 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1753 strings. Return in *HPOS and *VPOS the row and column number of
1754 the glyph found. Return in *AREA the glyph area containing X.
1755 Value is a pointer to the glyph found or null if X/Y is not on
1756 text, or we can't tell because W's current matrix is not up to
1761 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1764 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1766 struct glyph
*glyph
, *end
;
1767 struct glyph_row
*row
= NULL
;
1770 /* Find row containing Y. Give up if some row is not enabled. */
1771 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1773 row
= MATRIX_ROW (w
->current_matrix
, i
);
1774 if (!row
->enabled_p
)
1776 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1783 /* Give up if Y is not in the window. */
1784 if (i
== w
->current_matrix
->nrows
)
1787 /* Get the glyph area containing X. */
1788 if (w
->pseudo_window_p
)
1795 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1797 *area
= LEFT_MARGIN_AREA
;
1798 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1800 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1803 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1807 *area
= RIGHT_MARGIN_AREA
;
1808 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1812 /* Find glyph containing X. */
1813 glyph
= row
->glyphs
[*area
];
1814 end
= glyph
+ row
->used
[*area
];
1816 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1818 x
-= glyph
->pixel_width
;
1828 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1831 *hpos
= glyph
- row
->glyphs
[*area
];
1837 Convert frame-relative x/y to coordinates relative to window W.
1838 Takes pseudo-windows into account. */
1841 frame_to_window_pixel_xy (w
, x
, y
)
1845 if (w
->pseudo_window_p
)
1847 /* A pseudo-window is always full-width, and starts at the
1848 left edge of the frame, plus a frame border. */
1849 struct frame
*f
= XFRAME (w
->frame
);
1850 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1851 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1855 *x
-= WINDOW_LEFT_EDGE_X (w
);
1856 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1861 Return in RECTS[] at most N clipping rectangles for glyph string S.
1862 Return the number of stored rectangles. */
1865 get_glyph_string_clip_rects (s
, rects
, n
)
1866 struct glyph_string
*s
;
1867 NativeRectangle
*rects
;
1875 if (s
->row
->full_width_p
)
1877 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1878 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1879 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1881 /* Unless displaying a mode or menu bar line, which are always
1882 fully visible, clip to the visible part of the row. */
1883 if (s
->w
->pseudo_window_p
)
1884 r
.height
= s
->row
->visible_height
;
1886 r
.height
= s
->height
;
1890 /* This is a text line that may be partially visible. */
1891 r
.x
= window_box_left (s
->w
, s
->area
);
1892 r
.width
= window_box_width (s
->w
, s
->area
);
1893 r
.height
= s
->row
->visible_height
;
1897 if (r
.x
< s
->clip_head
->x
)
1899 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1900 r
.width
-= s
->clip_head
->x
- r
.x
;
1903 r
.x
= s
->clip_head
->x
;
1906 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1908 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1909 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1914 /* If S draws overlapping rows, it's sufficient to use the top and
1915 bottom of the window for clipping because this glyph string
1916 intentionally draws over other lines. */
1917 if (s
->for_overlaps
)
1919 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1920 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1922 /* Alas, the above simple strategy does not work for the
1923 environments with anti-aliased text: if the same text is
1924 drawn onto the same place multiple times, it gets thicker.
1925 If the overlap we are processing is for the erased cursor, we
1926 take the intersection with the rectagle of the cursor. */
1927 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1929 XRectangle rc
, r_save
= r
;
1931 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1932 rc
.y
= s
->w
->phys_cursor
.y
;
1933 rc
.width
= s
->w
->phys_cursor_width
;
1934 rc
.height
= s
->w
->phys_cursor_height
;
1936 x_intersect_rectangles (&r_save
, &rc
, &r
);
1941 /* Don't use S->y for clipping because it doesn't take partially
1942 visible lines into account. For example, it can be negative for
1943 partially visible lines at the top of a window. */
1944 if (!s
->row
->full_width_p
1945 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1946 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1948 r
.y
= max (0, s
->row
->y
);
1950 /* If drawing a tool-bar window, draw it over the internal border
1951 at the top of the window. */
1952 if (WINDOWP (s
->f
->tool_bar_window
)
1953 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
1954 r
.y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
1957 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1959 /* If drawing the cursor, don't let glyph draw outside its
1960 advertised boundaries. Cleartype does this under some circumstances. */
1961 if (s
->hl
== DRAW_CURSOR
)
1963 struct glyph
*glyph
= s
->first_glyph
;
1968 r
.width
-= s
->x
- r
.x
;
1971 r
.width
= min (r
.width
, glyph
->pixel_width
);
1973 /* If r.y is below window bottom, ensure that we still see a cursor. */
1974 height
= min (glyph
->ascent
+ glyph
->descent
,
1975 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1976 max_y
= window_text_bottom_y (s
->w
) - height
;
1977 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1978 if (s
->ybase
- glyph
->ascent
> max_y
)
1985 /* Don't draw cursor glyph taller than our actual glyph. */
1986 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1987 if (height
< r
.height
)
1989 max_y
= r
.y
+ r
.height
;
1990 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1991 r
.height
= min (max_y
- r
.y
, height
);
1998 XRectangle r_save
= r
;
2000 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2004 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2005 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2007 #ifdef CONVERT_FROM_XRECT
2008 CONVERT_FROM_XRECT (r
, *rects
);
2016 /* If we are processing overlapping and allowed to return
2017 multiple clipping rectangles, we exclude the row of the glyph
2018 string from the clipping rectangle. This is to avoid drawing
2019 the same text on the environment with anti-aliasing. */
2020 #ifdef CONVERT_FROM_XRECT
2023 XRectangle
*rs
= rects
;
2025 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2027 if (s
->for_overlaps
& OVERLAPS_PRED
)
2030 if (r
.y
+ r
.height
> row_y
)
2033 rs
[i
].height
= row_y
- r
.y
;
2039 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2042 if (r
.y
< row_y
+ s
->row
->visible_height
)
2044 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2046 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2047 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2056 #ifdef CONVERT_FROM_XRECT
2057 for (i
= 0; i
< n
; i
++)
2058 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2065 Return in *NR the clipping rectangle for glyph string S. */
2068 get_glyph_string_clip_rect (s
, nr
)
2069 struct glyph_string
*s
;
2070 NativeRectangle
*nr
;
2072 get_glyph_string_clip_rects (s
, nr
, 1);
2077 Return the position and height of the phys cursor in window W.
2078 Set w->phys_cursor_width to width of phys cursor.
2082 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2084 struct glyph_row
*row
;
2085 struct glyph
*glyph
;
2086 int *xp
, *yp
, *heightp
;
2088 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2089 int x
, y
, wd
, h
, h0
, y0
;
2091 /* Compute the width of the rectangle to draw. If on a stretch
2092 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2093 rectangle as wide as the glyph, but use a canonical character
2095 wd
= glyph
->pixel_width
- 1;
2096 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2100 x
= w
->phys_cursor
.x
;
2107 if (glyph
->type
== STRETCH_GLYPH
2108 && !x_stretch_cursor_p
)
2109 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2110 w
->phys_cursor_width
= wd
;
2112 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2114 /* If y is below window bottom, ensure that we still see a cursor. */
2115 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2117 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2118 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2120 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2123 h
= max (h
- (y0
- y
) + 1, h0
);
2128 y0
= window_text_bottom_y (w
) - h0
;
2136 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2137 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2142 * Remember which glyph the mouse is over.
2146 remember_mouse_glyph (f
, gx
, gy
, rect
)
2149 NativeRectangle
*rect
;
2153 struct glyph_row
*r
, *gr
, *end_row
;
2154 enum window_part part
;
2155 enum glyph_row_area area
;
2156 int x
, y
, width
, height
;
2158 /* Try to determine frame pixel position and size of the glyph under
2159 frame pixel coordinates X/Y on frame F. */
2161 if (!f
->glyphs_initialized_p
2162 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2165 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2166 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2170 w
= XWINDOW (window
);
2171 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2172 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2174 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2175 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2177 if (w
->pseudo_window_p
)
2180 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2186 case ON_LEFT_MARGIN
:
2187 area
= LEFT_MARGIN_AREA
;
2190 case ON_RIGHT_MARGIN
:
2191 area
= RIGHT_MARGIN_AREA
;
2194 case ON_HEADER_LINE
:
2196 gr
= (part
== ON_HEADER_LINE
2197 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2198 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2201 goto text_glyph_row_found
;
2208 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2209 if (r
->y
+ r
->height
> y
)
2215 text_glyph_row_found
:
2218 struct glyph
*g
= gr
->glyphs
[area
];
2219 struct glyph
*end
= g
+ gr
->used
[area
];
2221 height
= gr
->height
;
2222 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2223 if (gx
+ g
->pixel_width
> x
)
2228 if (g
->type
== IMAGE_GLYPH
)
2230 /* Don't remember when mouse is over image, as
2231 image may have hot-spots. */
2232 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2235 width
= g
->pixel_width
;
2239 /* Use nominal char spacing at end of line. */
2241 gx
+= (x
/ width
) * width
;
2244 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2245 gx
+= window_box_left_offset (w
, area
);
2249 /* Use nominal line height at end of window. */
2250 gx
= (x
/ width
) * width
;
2252 gy
+= (y
/ height
) * height
;
2256 case ON_LEFT_FRINGE
:
2257 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2258 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2259 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2260 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2263 case ON_RIGHT_FRINGE
:
2264 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2265 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2266 : window_box_right_offset (w
, TEXT_AREA
));
2267 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2271 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2273 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2274 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2275 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2277 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2281 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2282 if (r
->y
+ r
->height
> y
)
2289 height
= gr
->height
;
2292 /* Use nominal line height at end of window. */
2294 gy
+= (y
/ height
) * height
;
2301 /* If there is no glyph under the mouse, then we divide the screen
2302 into a grid of the smallest glyph in the frame, and use that
2305 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2306 round down even for negative values. */
2312 gx
= (gx
/ width
) * width
;
2313 gy
= (gy
/ height
) * height
;
2318 gx
+= WINDOW_LEFT_EDGE_X (w
);
2319 gy
+= WINDOW_TOP_EDGE_Y (w
);
2322 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2324 /* Visible feedback for debugging. */
2327 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2328 f
->output_data
.x
->normal_gc
,
2329 gx
, gy
, width
, height
);
2335 #endif /* HAVE_WINDOW_SYSTEM */
2338 /***********************************************************************
2339 Lisp form evaluation
2340 ***********************************************************************/
2342 /* Error handler for safe_eval and safe_call. */
2345 safe_eval_handler (arg
)
2348 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2353 /* Evaluate SEXPR and return the result, or nil if something went
2354 wrong. Prevent redisplay during the evaluation. */
2356 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2357 Return the result, or nil if something went wrong. Prevent
2358 redisplay during the evaluation. */
2361 safe_call (nargs
, args
)
2367 if (inhibit_eval_during_redisplay
)
2371 int count
= SPECPDL_INDEX ();
2372 struct gcpro gcpro1
;
2375 gcpro1
.nvars
= nargs
;
2376 specbind (Qinhibit_redisplay
, Qt
);
2377 /* Use Qt to ensure debugger does not run,
2378 so there is no possibility of wanting to redisplay. */
2379 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2382 val
= unbind_to (count
, val
);
2389 /* Call function FN with one argument ARG.
2390 Return the result, or nil if something went wrong. */
2393 safe_call1 (fn
, arg
)
2394 Lisp_Object fn
, arg
;
2396 Lisp_Object args
[2];
2399 return safe_call (2, args
);
2402 static Lisp_Object Qeval
;
2405 safe_eval (Lisp_Object sexpr
)
2407 return safe_call1 (Qeval
, sexpr
);
2410 /* Call function FN with one argument ARG.
2411 Return the result, or nil if something went wrong. */
2414 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2416 Lisp_Object args
[3];
2420 return safe_call (3, args
);
2425 /***********************************************************************
2427 ***********************************************************************/
2431 /* Define CHECK_IT to perform sanity checks on iterators.
2432 This is for debugging. It is too slow to do unconditionally. */
2438 if (it
->method
== GET_FROM_STRING
)
2440 xassert (STRINGP (it
->string
));
2441 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2445 xassert (IT_STRING_CHARPOS (*it
) < 0);
2446 if (it
->method
== GET_FROM_BUFFER
)
2448 /* Check that character and byte positions agree. */
2449 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2454 xassert (it
->current
.dpvec_index
>= 0);
2456 xassert (it
->current
.dpvec_index
< 0);
2459 #define CHECK_IT(IT) check_it ((IT))
2463 #define CHECK_IT(IT) (void) 0
2470 /* Check that the window end of window W is what we expect it
2471 to be---the last row in the current matrix displaying text. */
2474 check_window_end (w
)
2477 if (!MINI_WINDOW_P (w
)
2478 && !NILP (w
->window_end_valid
))
2480 struct glyph_row
*row
;
2481 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2482 XFASTINT (w
->window_end_vpos
)),
2484 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2485 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2489 #define CHECK_WINDOW_END(W) check_window_end ((W))
2491 #else /* not GLYPH_DEBUG */
2493 #define CHECK_WINDOW_END(W) (void) 0
2495 #endif /* not GLYPH_DEBUG */
2499 /***********************************************************************
2500 Iterator initialization
2501 ***********************************************************************/
2503 /* Initialize IT for displaying current_buffer in window W, starting
2504 at character position CHARPOS. CHARPOS < 0 means that no buffer
2505 position is specified which is useful when the iterator is assigned
2506 a position later. BYTEPOS is the byte position corresponding to
2507 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2509 If ROW is not null, calls to produce_glyphs with IT as parameter
2510 will produce glyphs in that row.
2512 BASE_FACE_ID is the id of a base face to use. It must be one of
2513 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2514 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2515 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2517 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2518 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2519 will be initialized to use the corresponding mode line glyph row of
2520 the desired matrix of W. */
2523 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2526 int charpos
, bytepos
;
2527 struct glyph_row
*row
;
2528 enum face_id base_face_id
;
2530 int highlight_region_p
;
2531 enum face_id remapped_base_face_id
= base_face_id
;
2533 /* Some precondition checks. */
2534 xassert (w
!= NULL
&& it
!= NULL
);
2535 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2538 /* If face attributes have been changed since the last redisplay,
2539 free realized faces now because they depend on face definitions
2540 that might have changed. Don't free faces while there might be
2541 desired matrices pending which reference these faces. */
2542 if (face_change_count
&& !inhibit_free_realized_faces
)
2544 face_change_count
= 0;
2545 free_all_realized_faces (Qnil
);
2548 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2549 if (! NILP (Vface_remapping_alist
))
2550 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2552 /* Use one of the mode line rows of W's desired matrix if
2556 if (base_face_id
== MODE_LINE_FACE_ID
2557 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2558 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2559 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2560 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2564 bzero (it
, sizeof *it
);
2565 it
->current
.overlay_string_index
= -1;
2566 it
->current
.dpvec_index
= -1;
2567 it
->base_face_id
= remapped_base_face_id
;
2569 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2571 /* The window in which we iterate over current_buffer: */
2572 XSETWINDOW (it
->window
, w
);
2574 it
->f
= XFRAME (w
->frame
);
2578 /* Extra space between lines (on window systems only). */
2579 if (base_face_id
== DEFAULT_FACE_ID
2580 && FRAME_WINDOW_P (it
->f
))
2582 if (NATNUMP (current_buffer
->extra_line_spacing
))
2583 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2584 else if (FLOATP (current_buffer
->extra_line_spacing
))
2585 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2586 * FRAME_LINE_HEIGHT (it
->f
));
2587 else if (it
->f
->extra_line_spacing
> 0)
2588 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2589 it
->max_extra_line_spacing
= 0;
2592 /* If realized faces have been removed, e.g. because of face
2593 attribute changes of named faces, recompute them. When running
2594 in batch mode, the face cache of the initial frame is null. If
2595 we happen to get called, make a dummy face cache. */
2596 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2597 init_frame_faces (it
->f
);
2598 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2599 recompute_basic_faces (it
->f
);
2601 /* Current value of the `slice', `space-width', and 'height' properties. */
2602 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2603 it
->space_width
= Qnil
;
2604 it
->font_height
= Qnil
;
2605 it
->override_ascent
= -1;
2607 /* Are control characters displayed as `^C'? */
2608 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2610 /* -1 means everything between a CR and the following line end
2611 is invisible. >0 means lines indented more than this value are
2613 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2614 ? XFASTINT (current_buffer
->selective_display
)
2615 : (!NILP (current_buffer
->selective_display
)
2617 it
->selective_display_ellipsis_p
2618 = !NILP (current_buffer
->selective_display_ellipses
);
2620 /* Display table to use. */
2621 it
->dp
= window_display_table (w
);
2623 /* Are multibyte characters enabled in current_buffer? */
2624 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2626 /* Non-zero if we should highlight the region. */
2628 = (!NILP (Vtransient_mark_mode
)
2629 && !NILP (current_buffer
->mark_active
)
2630 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2632 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2633 start and end of a visible region in window IT->w. Set both to
2634 -1 to indicate no region. */
2635 if (highlight_region_p
2636 /* Maybe highlight only in selected window. */
2637 && (/* Either show region everywhere. */
2638 highlight_nonselected_windows
2639 /* Or show region in the selected window. */
2640 || w
== XWINDOW (selected_window
)
2641 /* Or show the region if we are in the mini-buffer and W is
2642 the window the mini-buffer refers to. */
2643 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2644 && WINDOWP (minibuf_selected_window
)
2645 && w
== XWINDOW (minibuf_selected_window
))))
2647 int charpos
= marker_position (current_buffer
->mark
);
2648 it
->region_beg_charpos
= min (PT
, charpos
);
2649 it
->region_end_charpos
= max (PT
, charpos
);
2652 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2654 /* Get the position at which the redisplay_end_trigger hook should
2655 be run, if it is to be run at all. */
2656 if (MARKERP (w
->redisplay_end_trigger
)
2657 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2658 it
->redisplay_end_trigger_charpos
2659 = marker_position (w
->redisplay_end_trigger
);
2660 else if (INTEGERP (w
->redisplay_end_trigger
))
2661 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2663 /* Correct bogus values of tab_width. */
2664 it
->tab_width
= XINT (current_buffer
->tab_width
);
2665 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2668 /* Are lines in the display truncated? */
2669 if (base_face_id
!= DEFAULT_FACE_ID
2670 || XINT (it
->w
->hscroll
)
2671 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2672 && ((!NILP (Vtruncate_partial_width_windows
)
2673 && !INTEGERP (Vtruncate_partial_width_windows
))
2674 || (INTEGERP (Vtruncate_partial_width_windows
)
2675 && (WINDOW_TOTAL_COLS (it
->w
)
2676 < XINT (Vtruncate_partial_width_windows
))))))
2677 it
->line_wrap
= TRUNCATE
;
2678 else if (NILP (current_buffer
->truncate_lines
))
2679 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2680 ? WINDOW_WRAP
: WORD_WRAP
;
2682 it
->line_wrap
= TRUNCATE
;
2684 /* Get dimensions of truncation and continuation glyphs. These are
2685 displayed as fringe bitmaps under X, so we don't need them for such
2687 if (!FRAME_WINDOW_P (it
->f
))
2689 if (it
->line_wrap
== TRUNCATE
)
2691 /* We will need the truncation glyph. */
2692 xassert (it
->glyph_row
== NULL
);
2693 produce_special_glyphs (it
, IT_TRUNCATION
);
2694 it
->truncation_pixel_width
= it
->pixel_width
;
2698 /* We will need the continuation glyph. */
2699 xassert (it
->glyph_row
== NULL
);
2700 produce_special_glyphs (it
, IT_CONTINUATION
);
2701 it
->continuation_pixel_width
= it
->pixel_width
;
2704 /* Reset these values to zero because the produce_special_glyphs
2705 above has changed them. */
2706 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2707 it
->phys_ascent
= it
->phys_descent
= 0;
2710 /* Set this after getting the dimensions of truncation and
2711 continuation glyphs, so that we don't produce glyphs when calling
2712 produce_special_glyphs, above. */
2713 it
->glyph_row
= row
;
2714 it
->area
= TEXT_AREA
;
2716 /* Get the dimensions of the display area. The display area
2717 consists of the visible window area plus a horizontally scrolled
2718 part to the left of the window. All x-values are relative to the
2719 start of this total display area. */
2720 if (base_face_id
!= DEFAULT_FACE_ID
)
2722 /* Mode lines, menu bar in terminal frames. */
2723 it
->first_visible_x
= 0;
2724 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2729 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2730 it
->last_visible_x
= (it
->first_visible_x
2731 + window_box_width (w
, TEXT_AREA
));
2733 /* If we truncate lines, leave room for the truncator glyph(s) at
2734 the right margin. Otherwise, leave room for the continuation
2735 glyph(s). Truncation and continuation glyphs are not inserted
2736 for window-based redisplay. */
2737 if (!FRAME_WINDOW_P (it
->f
))
2739 if (it
->line_wrap
== TRUNCATE
)
2740 it
->last_visible_x
-= it
->truncation_pixel_width
;
2742 it
->last_visible_x
-= it
->continuation_pixel_width
;
2745 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2746 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2749 /* Leave room for a border glyph. */
2750 if (!FRAME_WINDOW_P (it
->f
)
2751 && !WINDOW_RIGHTMOST_P (it
->w
))
2752 it
->last_visible_x
-= 1;
2754 it
->last_visible_y
= window_text_bottom_y (w
);
2756 /* For mode lines and alike, arrange for the first glyph having a
2757 left box line if the face specifies a box. */
2758 if (base_face_id
!= DEFAULT_FACE_ID
)
2762 it
->face_id
= remapped_base_face_id
;
2764 /* If we have a boxed mode line, make the first character appear
2765 with a left box line. */
2766 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2767 if (face
->box
!= FACE_NO_BOX
)
2768 it
->start_of_box_run_p
= 1;
2771 /* If a buffer position was specified, set the iterator there,
2772 getting overlays and face properties from that position. */
2773 if (charpos
>= BUF_BEG (current_buffer
))
2775 it
->end_charpos
= ZV
;
2777 IT_CHARPOS (*it
) = charpos
;
2779 /* Compute byte position if not specified. */
2780 if (bytepos
< charpos
)
2781 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2783 IT_BYTEPOS (*it
) = bytepos
;
2785 it
->start
= it
->current
;
2787 /* Compute faces etc. */
2788 reseat (it
, it
->current
.pos
, 1);
2795 /* Initialize IT for the display of window W with window start POS. */
2798 start_display (it
, w
, pos
)
2801 struct text_pos pos
;
2803 struct glyph_row
*row
;
2804 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2806 row
= w
->desired_matrix
->rows
+ first_vpos
;
2807 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2808 it
->first_vpos
= first_vpos
;
2810 /* Don't reseat to previous visible line start if current start
2811 position is in a string or image. */
2812 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2814 int start_at_line_beg_p
;
2815 int first_y
= it
->current_y
;
2817 /* If window start is not at a line start, skip forward to POS to
2818 get the correct continuation lines width. */
2819 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2820 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2821 if (!start_at_line_beg_p
)
2825 reseat_at_previous_visible_line_start (it
);
2826 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2828 new_x
= it
->current_x
+ it
->pixel_width
;
2830 /* If lines are continued, this line may end in the middle
2831 of a multi-glyph character (e.g. a control character
2832 displayed as \003, or in the middle of an overlay
2833 string). In this case move_it_to above will not have
2834 taken us to the start of the continuation line but to the
2835 end of the continued line. */
2836 if (it
->current_x
> 0
2837 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2838 && (/* And glyph doesn't fit on the line. */
2839 new_x
> it
->last_visible_x
2840 /* Or it fits exactly and we're on a window
2842 || (new_x
== it
->last_visible_x
2843 && FRAME_WINDOW_P (it
->f
))))
2845 if (it
->current
.dpvec_index
>= 0
2846 || it
->current
.overlay_string_index
>= 0)
2848 set_iterator_to_next (it
, 1);
2849 move_it_in_display_line_to (it
, -1, -1, 0);
2852 it
->continuation_lines_width
+= it
->current_x
;
2855 /* We're starting a new display line, not affected by the
2856 height of the continued line, so clear the appropriate
2857 fields in the iterator structure. */
2858 it
->max_ascent
= it
->max_descent
= 0;
2859 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2861 it
->current_y
= first_y
;
2863 it
->current_x
= it
->hpos
= 0;
2867 #if 0 /* Don't assert the following because start_display is sometimes
2868 called intentionally with a window start that is not at a
2869 line start. Please leave this code in as a comment. */
2871 /* Window start should be on a line start, now. */
2872 xassert (it
->continuation_lines_width
2873 || IT_CHARPOS (it
) == BEGV
2874 || FETCH_BYTE (IT_BYTEPOS (it
) - 1) == '\n');
2879 /* Return 1 if POS is a position in ellipses displayed for invisible
2880 text. W is the window we display, for text property lookup. */
2883 in_ellipses_for_invisible_text_p (pos
, w
)
2884 struct display_pos
*pos
;
2887 Lisp_Object prop
, window
;
2889 int charpos
= CHARPOS (pos
->pos
);
2891 /* If POS specifies a position in a display vector, this might
2892 be for an ellipsis displayed for invisible text. We won't
2893 get the iterator set up for delivering that ellipsis unless
2894 we make sure that it gets aware of the invisible text. */
2895 if (pos
->dpvec_index
>= 0
2896 && pos
->overlay_string_index
< 0
2897 && CHARPOS (pos
->string_pos
) < 0
2899 && (XSETWINDOW (window
, w
),
2900 prop
= Fget_char_property (make_number (charpos
),
2901 Qinvisible
, window
),
2902 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2904 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2906 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2913 /* Initialize IT for stepping through current_buffer in window W,
2914 starting at position POS that includes overlay string and display
2915 vector/ control character translation position information. Value
2916 is zero if there are overlay strings with newlines at POS. */
2919 init_from_display_pos (it
, w
, pos
)
2922 struct display_pos
*pos
;
2924 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2925 int i
, overlay_strings_with_newlines
= 0;
2927 /* If POS specifies a position in a display vector, this might
2928 be for an ellipsis displayed for invisible text. We won't
2929 get the iterator set up for delivering that ellipsis unless
2930 we make sure that it gets aware of the invisible text. */
2931 if (in_ellipses_for_invisible_text_p (pos
, w
))
2937 /* Keep in mind: the call to reseat in init_iterator skips invisible
2938 text, so we might end up at a position different from POS. This
2939 is only a problem when POS is a row start after a newline and an
2940 overlay starts there with an after-string, and the overlay has an
2941 invisible property. Since we don't skip invisible text in
2942 display_line and elsewhere immediately after consuming the
2943 newline before the row start, such a POS will not be in a string,
2944 but the call to init_iterator below will move us to the
2946 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2948 /* This only scans the current chunk -- it should scan all chunks.
2949 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2950 to 16 in 22.1 to make this a lesser problem. */
2951 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2953 const char *s
= SDATA (it
->overlay_strings
[i
]);
2954 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2956 while (s
< e
&& *s
!= '\n')
2961 overlay_strings_with_newlines
= 1;
2966 /* If position is within an overlay string, set up IT to the right
2968 if (pos
->overlay_string_index
>= 0)
2972 /* If the first overlay string happens to have a `display'
2973 property for an image, the iterator will be set up for that
2974 image, and we have to undo that setup first before we can
2975 correct the overlay string index. */
2976 if (it
->method
== GET_FROM_IMAGE
)
2979 /* We already have the first chunk of overlay strings in
2980 IT->overlay_strings. Load more until the one for
2981 pos->overlay_string_index is in IT->overlay_strings. */
2982 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2984 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2985 it
->current
.overlay_string_index
= 0;
2988 load_overlay_strings (it
, 0);
2989 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2993 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2994 relative_index
= (it
->current
.overlay_string_index
2995 % OVERLAY_STRING_CHUNK_SIZE
);
2996 it
->string
= it
->overlay_strings
[relative_index
];
2997 xassert (STRINGP (it
->string
));
2998 it
->current
.string_pos
= pos
->string_pos
;
2999 it
->method
= GET_FROM_STRING
;
3002 if (CHARPOS (pos
->string_pos
) >= 0)
3004 /* Recorded position is not in an overlay string, but in another
3005 string. This can only be a string from a `display' property.
3006 IT should already be filled with that string. */
3007 it
->current
.string_pos
= pos
->string_pos
;
3008 xassert (STRINGP (it
->string
));
3011 /* Restore position in display vector translations, control
3012 character translations or ellipses. */
3013 if (pos
->dpvec_index
>= 0)
3015 if (it
->dpvec
== NULL
)
3016 get_next_display_element (it
);
3017 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3018 it
->current
.dpvec_index
= pos
->dpvec_index
;
3022 return !overlay_strings_with_newlines
;
3026 /* Initialize IT for stepping through current_buffer in window W
3027 starting at ROW->start. */
3030 init_to_row_start (it
, w
, row
)
3033 struct glyph_row
*row
;
3035 init_from_display_pos (it
, w
, &row
->start
);
3036 it
->start
= row
->start
;
3037 it
->continuation_lines_width
= row
->continuation_lines_width
;
3042 /* Initialize IT for stepping through current_buffer in window W
3043 starting in the line following ROW, i.e. starting at ROW->end.
3044 Value is zero if there are overlay strings with newlines at ROW's
3048 init_to_row_end (it
, w
, row
)
3051 struct glyph_row
*row
;
3055 if (init_from_display_pos (it
, w
, &row
->end
))
3057 if (row
->continued_p
)
3058 it
->continuation_lines_width
3059 = row
->continuation_lines_width
+ row
->pixel_width
;
3070 /***********************************************************************
3072 ***********************************************************************/
3074 /* Called when IT reaches IT->stop_charpos. Handle text property and
3075 overlay changes. Set IT->stop_charpos to the next position where
3082 enum prop_handled handled
;
3083 int handle_overlay_change_p
;
3087 it
->current
.dpvec_index
= -1;
3088 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3089 it
->ignore_overlay_strings_at_pos_p
= 0;
3092 /* Use face of preceding text for ellipsis (if invisible) */
3093 if (it
->selective_display_ellipsis_p
)
3094 it
->saved_face_id
= it
->face_id
;
3098 handled
= HANDLED_NORMALLY
;
3100 /* Call text property handlers. */
3101 for (p
= it_props
; p
->handler
; ++p
)
3103 handled
= p
->handler (it
);
3105 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3107 else if (handled
== HANDLED_RETURN
)
3109 /* We still want to show before and after strings from
3110 overlays even if the actual buffer text is replaced. */
3111 if (!handle_overlay_change_p
3113 || !get_overlay_strings_1 (it
, 0, 0))
3116 setup_for_ellipsis (it
, 0);
3117 /* When handling a display spec, we might load an
3118 empty string. In that case, discard it here. We
3119 used to discard it in handle_single_display_spec,
3120 but that causes get_overlay_strings_1, above, to
3121 ignore overlay strings that we must check. */
3122 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3126 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3130 it
->ignore_overlay_strings_at_pos_p
= 1;
3131 it
->string_from_display_prop_p
= 0;
3132 handle_overlay_change_p
= 0;
3134 handled
= HANDLED_RECOMPUTE_PROPS
;
3137 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3138 handle_overlay_change_p
= 0;
3141 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3143 /* Don't check for overlay strings below when set to deliver
3144 characters from a display vector. */
3145 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3146 handle_overlay_change_p
= 0;
3148 /* Handle overlay changes.
3149 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3150 if it finds overlays. */
3151 if (handle_overlay_change_p
)
3152 handled
= handle_overlay_change (it
);
3157 setup_for_ellipsis (it
, 0);
3161 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3163 /* Determine where to stop next. */
3164 if (handled
== HANDLED_NORMALLY
)
3165 compute_stop_pos (it
);
3169 /* Compute IT->stop_charpos from text property and overlay change
3170 information for IT's current position. */
3173 compute_stop_pos (it
)
3176 register INTERVAL iv
, next_iv
;
3177 Lisp_Object object
, limit
, position
;
3178 EMACS_INT charpos
, bytepos
;
3180 /* If nowhere else, stop at the end. */
3181 it
->stop_charpos
= it
->end_charpos
;
3183 if (STRINGP (it
->string
))
3185 /* Strings are usually short, so don't limit the search for
3187 object
= it
->string
;
3189 charpos
= IT_STRING_CHARPOS (*it
);
3190 bytepos
= IT_STRING_BYTEPOS (*it
);
3196 /* If next overlay change is in front of the current stop pos
3197 (which is IT->end_charpos), stop there. Note: value of
3198 next_overlay_change is point-max if no overlay change
3200 charpos
= IT_CHARPOS (*it
);
3201 bytepos
= IT_BYTEPOS (*it
);
3202 pos
= next_overlay_change (charpos
);
3203 if (pos
< it
->stop_charpos
)
3204 it
->stop_charpos
= pos
;
3206 /* If showing the region, we have to stop at the region
3207 start or end because the face might change there. */
3208 if (it
->region_beg_charpos
> 0)
3210 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3211 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3212 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3213 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3216 /* Set up variables for computing the stop position from text
3217 property changes. */
3218 XSETBUFFER (object
, current_buffer
);
3219 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3222 /* Get the interval containing IT's position. Value is a null
3223 interval if there isn't such an interval. */
3224 position
= make_number (charpos
);
3225 iv
= validate_interval_range (object
, &position
, &position
, 0);
3226 if (!NULL_INTERVAL_P (iv
))
3228 Lisp_Object values_here
[LAST_PROP_IDX
];
3231 /* Get properties here. */
3232 for (p
= it_props
; p
->handler
; ++p
)
3233 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3235 /* Look for an interval following iv that has different
3237 for (next_iv
= next_interval (iv
);
3238 (!NULL_INTERVAL_P (next_iv
)
3240 || XFASTINT (limit
) > next_iv
->position
));
3241 next_iv
= next_interval (next_iv
))
3243 for (p
= it_props
; p
->handler
; ++p
)
3245 Lisp_Object new_value
;
3247 new_value
= textget (next_iv
->plist
, *p
->name
);
3248 if (!EQ (values_here
[p
->idx
], new_value
))
3256 if (!NULL_INTERVAL_P (next_iv
))
3258 if (INTEGERP (limit
)
3259 && next_iv
->position
>= XFASTINT (limit
))
3260 /* No text property change up to limit. */
3261 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3263 /* Text properties change in next_iv. */
3264 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3268 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3269 it
->stop_charpos
, it
->string
);
3271 xassert (STRINGP (it
->string
)
3272 || (it
->stop_charpos
>= BEGV
3273 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3277 /* Return the position of the next overlay change after POS in
3278 current_buffer. Value is point-max if no overlay change
3279 follows. This is like `next-overlay-change' but doesn't use
3283 next_overlay_change (pos
)
3288 Lisp_Object
*overlays
;
3291 /* Get all overlays at the given position. */
3292 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3294 /* If any of these overlays ends before endpos,
3295 use its ending point instead. */
3296 for (i
= 0; i
< noverlays
; ++i
)
3301 oend
= OVERLAY_END (overlays
[i
]);
3302 oendpos
= OVERLAY_POSITION (oend
);
3303 endpos
= min (endpos
, oendpos
);
3311 /***********************************************************************
3313 ***********************************************************************/
3315 /* Handle changes in the `fontified' property of the current buffer by
3316 calling hook functions from Qfontification_functions to fontify
3319 static enum prop_handled
3320 handle_fontified_prop (it
)
3323 Lisp_Object prop
, pos
;
3324 enum prop_handled handled
= HANDLED_NORMALLY
;
3326 if (!NILP (Vmemory_full
))
3329 /* Get the value of the `fontified' property at IT's current buffer
3330 position. (The `fontified' property doesn't have a special
3331 meaning in strings.) If the value is nil, call functions from
3332 Qfontification_functions. */
3333 if (!STRINGP (it
->string
)
3335 && !NILP (Vfontification_functions
)
3336 && !NILP (Vrun_hooks
)
3337 && (pos
= make_number (IT_CHARPOS (*it
)),
3338 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3339 /* Ignore the special cased nil value always present at EOB since
3340 no amount of fontifying will be able to change it. */
3341 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3343 int count
= SPECPDL_INDEX ();
3346 val
= Vfontification_functions
;
3347 specbind (Qfontification_functions
, Qnil
);
3349 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3350 safe_call1 (val
, pos
);
3353 Lisp_Object globals
, fn
;
3354 struct gcpro gcpro1
, gcpro2
;
3357 GCPRO2 (val
, globals
);
3359 for (; CONSP (val
); val
= XCDR (val
))
3365 /* A value of t indicates this hook has a local
3366 binding; it means to run the global binding too.
3367 In a global value, t should not occur. If it
3368 does, we must ignore it to avoid an endless
3370 for (globals
= Fdefault_value (Qfontification_functions
);
3372 globals
= XCDR (globals
))
3374 fn
= XCAR (globals
);
3376 safe_call1 (fn
, pos
);
3380 safe_call1 (fn
, pos
);
3386 unbind_to (count
, Qnil
);
3388 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3389 something. This avoids an endless loop if they failed to
3390 fontify the text for which reason ever. */
3391 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3392 handled
= HANDLED_RECOMPUTE_PROPS
;
3400 /***********************************************************************
3402 ***********************************************************************/
3404 /* Set up iterator IT from face properties at its current position.
3405 Called from handle_stop. */
3407 static enum prop_handled
3408 handle_face_prop (it
)
3412 EMACS_INT next_stop
;
3414 if (!STRINGP (it
->string
))
3417 = face_at_buffer_position (it
->w
,
3419 it
->region_beg_charpos
,
3420 it
->region_end_charpos
,
3423 + TEXT_PROP_DISTANCE_LIMIT
),
3426 /* Is this a start of a run of characters with box face?
3427 Caveat: this can be called for a freshly initialized
3428 iterator; face_id is -1 in this case. We know that the new
3429 face will not change until limit, i.e. if the new face has a
3430 box, all characters up to limit will have one. But, as
3431 usual, we don't know whether limit is really the end. */
3432 if (new_face_id
!= it
->face_id
)
3434 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3436 /* If new face has a box but old face has not, this is
3437 the start of a run of characters with box, i.e. it has
3438 a shadow on the left side. The value of face_id of the
3439 iterator will be -1 if this is the initial call that gets
3440 the face. In this case, we have to look in front of IT's
3441 position and see whether there is a face != new_face_id. */
3442 it
->start_of_box_run_p
3443 = (new_face
->box
!= FACE_NO_BOX
3444 && (it
->face_id
>= 0
3445 || IT_CHARPOS (*it
) == BEG
3446 || new_face_id
!= face_before_it_pos (it
)));
3447 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3452 int base_face_id
, bufpos
;
3454 Lisp_Object from_overlay
3455 = (it
->current
.overlay_string_index
>= 0
3456 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3459 /* See if we got to this string directly or indirectly from
3460 an overlay property. That includes the before-string or
3461 after-string of an overlay, strings in display properties
3462 provided by an overlay, their text properties, etc.
3464 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3465 if (! NILP (from_overlay
))
3466 for (i
= it
->sp
- 1; i
>= 0; i
--)
3468 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3470 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3471 else if (! NILP (it
->stack
[i
].from_overlay
))
3472 from_overlay
= it
->stack
[i
].from_overlay
;
3474 if (!NILP (from_overlay
))
3478 if (! NILP (from_overlay
))
3480 bufpos
= IT_CHARPOS (*it
);
3481 /* For a string from an overlay, the base face depends
3482 only on text properties and ignores overlays. */
3484 = face_for_overlay_string (it
->w
,
3486 it
->region_beg_charpos
,
3487 it
->region_end_charpos
,
3490 + TEXT_PROP_DISTANCE_LIMIT
),
3498 /* For strings from a `display' property, use the face at
3499 IT's current buffer position as the base face to merge
3500 with, so that overlay strings appear in the same face as
3501 surrounding text, unless they specify their own
3503 base_face_id
= underlying_face_id (it
);
3506 new_face_id
= face_at_string_position (it
->w
,
3508 IT_STRING_CHARPOS (*it
),
3510 it
->region_beg_charpos
,
3511 it
->region_end_charpos
,
3515 #if 0 /* This shouldn't be neccessary. Let's check it. */
3516 /* If IT is used to display a mode line we would really like to
3517 use the mode line face instead of the frame's default face. */
3518 if (it
->glyph_row
== MATRIX_MODE_LINE_ROW (it
->w
->desired_matrix
)
3519 && new_face_id
== DEFAULT_FACE_ID
)
3520 new_face_id
= CURRENT_MODE_LINE_FACE_ID (it
->w
);
3523 /* Is this a start of a run of characters with box? Caveat:
3524 this can be called for a freshly allocated iterator; face_id
3525 is -1 is this case. We know that the new face will not
3526 change until the next check pos, i.e. if the new face has a
3527 box, all characters up to that position will have a
3528 box. But, as usual, we don't know whether that position
3529 is really the end. */
3530 if (new_face_id
!= it
->face_id
)
3532 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3533 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3535 /* If new face has a box but old face hasn't, this is the
3536 start of a run of characters with box, i.e. it has a
3537 shadow on the left side. */
3538 it
->start_of_box_run_p
3539 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3540 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3544 it
->face_id
= new_face_id
;
3545 return HANDLED_NORMALLY
;
3549 /* Return the ID of the face ``underlying'' IT's current position,
3550 which is in a string. If the iterator is associated with a
3551 buffer, return the face at IT's current buffer position.
3552 Otherwise, use the iterator's base_face_id. */
3555 underlying_face_id (it
)
3558 int face_id
= it
->base_face_id
, i
;
3560 xassert (STRINGP (it
->string
));
3562 for (i
= it
->sp
- 1; i
>= 0; --i
)
3563 if (NILP (it
->stack
[i
].string
))
3564 face_id
= it
->stack
[i
].face_id
;
3570 /* Compute the face one character before or after the current position
3571 of IT. BEFORE_P non-zero means get the face in front of IT's
3572 position. Value is the id of the face. */
3575 face_before_or_after_it_pos (it
, before_p
)
3580 EMACS_INT next_check_charpos
;
3581 struct text_pos pos
;
3583 xassert (it
->s
== NULL
);
3585 if (STRINGP (it
->string
))
3587 int bufpos
, base_face_id
;
3589 /* No face change past the end of the string (for the case
3590 we are padding with spaces). No face change before the
3592 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3593 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3596 /* Set pos to the position before or after IT's current position. */
3598 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3600 /* For composition, we must check the character after the
3602 pos
= (it
->what
== IT_COMPOSITION
3603 ? string_pos (IT_STRING_CHARPOS (*it
)
3604 + it
->cmp_it
.nchars
, it
->string
)
3605 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3607 if (it
->current
.overlay_string_index
>= 0)
3608 bufpos
= IT_CHARPOS (*it
);
3612 base_face_id
= underlying_face_id (it
);
3614 /* Get the face for ASCII, or unibyte. */
3615 face_id
= face_at_string_position (it
->w
,
3619 it
->region_beg_charpos
,
3620 it
->region_end_charpos
,
3621 &next_check_charpos
,
3624 /* Correct the face for charsets different from ASCII. Do it
3625 for the multibyte case only. The face returned above is
3626 suitable for unibyte text if IT->string is unibyte. */
3627 if (STRING_MULTIBYTE (it
->string
))
3629 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3630 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3632 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3634 c
= string_char_and_length (p
, rest
, &len
);
3635 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3640 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3641 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3644 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3645 pos
= it
->current
.pos
;
3648 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3651 if (it
->what
== IT_COMPOSITION
)
3652 /* For composition, we must check the position after the
3654 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3656 INC_TEXT_POS (pos
, it
->multibyte_p
);
3659 /* Determine face for CHARSET_ASCII, or unibyte. */
3660 face_id
= face_at_buffer_position (it
->w
,
3662 it
->region_beg_charpos
,
3663 it
->region_end_charpos
,
3664 &next_check_charpos
,
3667 /* Correct the face for charsets different from ASCII. Do it
3668 for the multibyte case only. The face returned above is
3669 suitable for unibyte text if current_buffer is unibyte. */
3670 if (it
->multibyte_p
)
3672 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3673 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3674 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3683 /***********************************************************************
3685 ***********************************************************************/
3687 /* Set up iterator IT from invisible properties at its current
3688 position. Called from handle_stop. */
3690 static enum prop_handled
3691 handle_invisible_prop (it
)
3694 enum prop_handled handled
= HANDLED_NORMALLY
;
3696 if (STRINGP (it
->string
))
3698 extern Lisp_Object Qinvisible
;
3699 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3701 /* Get the value of the invisible text property at the
3702 current position. Value will be nil if there is no such
3704 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3705 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3708 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3710 handled
= HANDLED_RECOMPUTE_PROPS
;
3712 /* Get the position at which the next change of the
3713 invisible text property can be found in IT->string.
3714 Value will be nil if the property value is the same for
3715 all the rest of IT->string. */
3716 XSETINT (limit
, SCHARS (it
->string
));
3717 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3720 /* Text at current position is invisible. The next
3721 change in the property is at position end_charpos.
3722 Move IT's current position to that position. */
3723 if (INTEGERP (end_charpos
)
3724 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3726 struct text_pos old
;
3727 old
= it
->current
.string_pos
;
3728 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3729 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3733 /* The rest of the string is invisible. If this is an
3734 overlay string, proceed with the next overlay string
3735 or whatever comes and return a character from there. */
3736 if (it
->current
.overlay_string_index
>= 0)
3738 next_overlay_string (it
);
3739 /* Don't check for overlay strings when we just
3740 finished processing them. */
3741 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3745 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3746 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3754 EMACS_INT newpos
, next_stop
, start_charpos
;
3755 Lisp_Object pos
, prop
, overlay
;
3757 /* First of all, is there invisible text at this position? */
3758 start_charpos
= IT_CHARPOS (*it
);
3759 pos
= make_number (IT_CHARPOS (*it
));
3760 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3762 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3764 /* If we are on invisible text, skip over it. */
3765 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3767 /* Record whether we have to display an ellipsis for the
3769 int display_ellipsis_p
= invis_p
== 2;
3771 handled
= HANDLED_RECOMPUTE_PROPS
;
3773 /* Loop skipping over invisible text. The loop is left at
3774 ZV or with IT on the first char being visible again. */
3777 /* Try to skip some invisible text. Return value is the
3778 position reached which can be equal to IT's position
3779 if there is nothing invisible here. This skips both
3780 over invisible text properties and overlays with
3781 invisible property. */
3782 newpos
= skip_invisible (IT_CHARPOS (*it
),
3783 &next_stop
, ZV
, it
->window
);
3785 /* If we skipped nothing at all we weren't at invisible
3786 text in the first place. If everything to the end of
3787 the buffer was skipped, end the loop. */
3788 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3792 /* We skipped some characters but not necessarily
3793 all there are. Check if we ended up on visible
3794 text. Fget_char_property returns the property of
3795 the char before the given position, i.e. if we
3796 get invis_p = 0, this means that the char at
3797 newpos is visible. */
3798 pos
= make_number (newpos
);
3799 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3800 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3803 /* If we ended up on invisible text, proceed to
3804 skip starting with next_stop. */
3806 IT_CHARPOS (*it
) = next_stop
;
3808 /* If there are adjacent invisible texts, don't lose the
3809 second one's ellipsis. */
3811 display_ellipsis_p
= 1;
3815 /* The position newpos is now either ZV or on visible text. */
3816 IT_CHARPOS (*it
) = newpos
;
3817 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3819 /* If there are before-strings at the start of invisible
3820 text, and the text is invisible because of a text
3821 property, arrange to show before-strings because 20.x did
3822 it that way. (If the text is invisible because of an
3823 overlay property instead of a text property, this is
3824 already handled in the overlay code.) */
3826 && get_overlay_strings (it
, start_charpos
))
3828 handled
= HANDLED_RECOMPUTE_PROPS
;
3829 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3831 else if (display_ellipsis_p
)
3833 /* Make sure that the glyphs of the ellipsis will get
3834 correct `charpos' values. If we would not update
3835 it->position here, the glyphs would belong to the
3836 last visible character _before_ the invisible
3837 text, which confuses `set_cursor_from_row'.
3839 We use the last invisible position instead of the
3840 first because this way the cursor is always drawn on
3841 the first "." of the ellipsis, whenever PT is inside
3842 the invisible text. Otherwise the cursor would be
3843 placed _after_ the ellipsis when the point is after the
3844 first invisible character. */
3845 if (!STRINGP (it
->object
))
3847 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3848 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3851 /* Let the ellipsis display before
3852 considering any properties of the following char.
3853 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3854 handled
= HANDLED_RETURN
;
3863 /* Make iterator IT return `...' next.
3864 Replaces LEN characters from buffer. */
3867 setup_for_ellipsis (it
, len
)
3871 /* Use the display table definition for `...'. Invalid glyphs
3872 will be handled by the method returning elements from dpvec. */
3873 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3875 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3876 it
->dpvec
= v
->contents
;
3877 it
->dpend
= v
->contents
+ v
->size
;
3881 /* Default `...'. */
3882 it
->dpvec
= default_invis_vector
;
3883 it
->dpend
= default_invis_vector
+ 3;
3886 it
->dpvec_char_len
= len
;
3887 it
->current
.dpvec_index
= 0;
3888 it
->dpvec_face_id
= -1;
3890 /* Remember the current face id in case glyphs specify faces.
3891 IT's face is restored in set_iterator_to_next.
3892 saved_face_id was set to preceding char's face in handle_stop. */
3893 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3894 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3896 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3902 /***********************************************************************
3904 ***********************************************************************/
3906 /* Set up iterator IT from `display' property at its current position.
3907 Called from handle_stop.
3908 We return HANDLED_RETURN if some part of the display property
3909 overrides the display of the buffer text itself.
3910 Otherwise we return HANDLED_NORMALLY. */
3912 static enum prop_handled
3913 handle_display_prop (it
)
3916 Lisp_Object prop
, object
, overlay
;
3917 struct text_pos
*position
;
3918 /* Nonzero if some property replaces the display of the text itself. */
3919 int display_replaced_p
= 0;
3921 if (STRINGP (it
->string
))
3923 object
= it
->string
;
3924 position
= &it
->current
.string_pos
;
3928 XSETWINDOW (object
, it
->w
);
3929 position
= &it
->current
.pos
;
3932 /* Reset those iterator values set from display property values. */
3933 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3934 it
->space_width
= Qnil
;
3935 it
->font_height
= Qnil
;
3938 /* We don't support recursive `display' properties, i.e. string
3939 values that have a string `display' property, that have a string
3940 `display' property etc. */
3941 if (!it
->string_from_display_prop_p
)
3942 it
->area
= TEXT_AREA
;
3944 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3945 Qdisplay
, object
, &overlay
);
3947 return HANDLED_NORMALLY
;
3948 /* Now OVERLAY is the overlay that gave us this property, or nil
3949 if it was a text property. */
3951 if (!STRINGP (it
->string
))
3952 object
= it
->w
->buffer
;
3955 /* Simple properties. */
3956 && !EQ (XCAR (prop
), Qimage
)
3957 && !EQ (XCAR (prop
), Qspace
)
3958 && !EQ (XCAR (prop
), Qwhen
)
3959 && !EQ (XCAR (prop
), Qslice
)
3960 && !EQ (XCAR (prop
), Qspace_width
)
3961 && !EQ (XCAR (prop
), Qheight
)
3962 && !EQ (XCAR (prop
), Qraise
)
3963 /* Marginal area specifications. */
3964 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3965 && !EQ (XCAR (prop
), Qleft_fringe
)
3966 && !EQ (XCAR (prop
), Qright_fringe
)
3967 && !NILP (XCAR (prop
)))
3969 for (; CONSP (prop
); prop
= XCDR (prop
))
3971 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3972 position
, display_replaced_p
))
3974 display_replaced_p
= 1;
3975 /* If some text in a string is replaced, `position' no
3976 longer points to the position of `object'. */
3977 if (STRINGP (object
))
3982 else if (VECTORP (prop
))
3985 for (i
= 0; i
< ASIZE (prop
); ++i
)
3986 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3987 position
, display_replaced_p
))
3989 display_replaced_p
= 1;
3990 /* If some text in a string is replaced, `position' no
3991 longer points to the position of `object'. */
3992 if (STRINGP (object
))
3998 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4000 display_replaced_p
= 1;
4003 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4007 /* Value is the position of the end of the `display' property starting
4008 at START_POS in OBJECT. */
4010 static struct text_pos
4011 display_prop_end (it
, object
, start_pos
)
4014 struct text_pos start_pos
;
4017 struct text_pos end_pos
;
4019 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4020 Qdisplay
, object
, Qnil
);
4021 CHARPOS (end_pos
) = XFASTINT (end
);
4022 if (STRINGP (object
))
4023 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4025 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4031 /* Set up IT from a single `display' specification PROP. OBJECT
4032 is the object in which the `display' property was found. *POSITION
4033 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4034 means that we previously saw a display specification which already
4035 replaced text display with something else, for example an image;
4036 we ignore such properties after the first one has been processed.
4038 OVERLAY is the overlay this `display' property came from,
4039 or nil if it was a text property.
4041 If PROP is a `space' or `image' specification, and in some other
4042 cases too, set *POSITION to the position where the `display'
4045 Value is non-zero if something was found which replaces the display
4046 of buffer or string text. */
4049 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4050 display_replaced_before_p
)
4054 Lisp_Object overlay
;
4055 struct text_pos
*position
;
4056 int display_replaced_before_p
;
4059 Lisp_Object location
, value
;
4060 struct text_pos start_pos
, save_pos
;
4063 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4064 If the result is non-nil, use VALUE instead of SPEC. */
4066 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4075 if (!NILP (form
) && !EQ (form
, Qt
))
4077 int count
= SPECPDL_INDEX ();
4078 struct gcpro gcpro1
;
4080 /* Bind `object' to the object having the `display' property, a
4081 buffer or string. Bind `position' to the position in the
4082 object where the property was found, and `buffer-position'
4083 to the current position in the buffer. */
4084 specbind (Qobject
, object
);
4085 specbind (Qposition
, make_number (CHARPOS (*position
)));
4086 specbind (Qbuffer_position
,
4087 make_number (STRINGP (object
)
4088 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4090 form
= safe_eval (form
);
4092 unbind_to (count
, Qnil
);
4098 /* Handle `(height HEIGHT)' specifications. */
4100 && EQ (XCAR (spec
), Qheight
)
4101 && CONSP (XCDR (spec
)))
4103 if (!FRAME_WINDOW_P (it
->f
))
4106 it
->font_height
= XCAR (XCDR (spec
));
4107 if (!NILP (it
->font_height
))
4109 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4110 int new_height
= -1;
4112 if (CONSP (it
->font_height
)
4113 && (EQ (XCAR (it
->font_height
), Qplus
)
4114 || EQ (XCAR (it
->font_height
), Qminus
))
4115 && CONSP (XCDR (it
->font_height
))
4116 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4118 /* `(+ N)' or `(- N)' where N is an integer. */
4119 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4120 if (EQ (XCAR (it
->font_height
), Qplus
))
4122 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4124 else if (FUNCTIONP (it
->font_height
))
4126 /* Call function with current height as argument.
4127 Value is the new height. */
4129 height
= safe_call1 (it
->font_height
,
4130 face
->lface
[LFACE_HEIGHT_INDEX
]);
4131 if (NUMBERP (height
))
4132 new_height
= XFLOATINT (height
);
4134 else if (NUMBERP (it
->font_height
))
4136 /* Value is a multiple of the canonical char height. */
4139 face
= FACE_FROM_ID (it
->f
,
4140 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4141 new_height
= (XFLOATINT (it
->font_height
)
4142 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4146 /* Evaluate IT->font_height with `height' bound to the
4147 current specified height to get the new height. */
4148 int count
= SPECPDL_INDEX ();
4150 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4151 value
= safe_eval (it
->font_height
);
4152 unbind_to (count
, Qnil
);
4154 if (NUMBERP (value
))
4155 new_height
= XFLOATINT (value
);
4159 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4165 /* Handle `(space-width WIDTH)'. */
4167 && EQ (XCAR (spec
), Qspace_width
)
4168 && CONSP (XCDR (spec
)))
4170 if (!FRAME_WINDOW_P (it
->f
))
4173 value
= XCAR (XCDR (spec
));
4174 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4175 it
->space_width
= value
;
4180 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4182 && EQ (XCAR (spec
), Qslice
))
4186 if (!FRAME_WINDOW_P (it
->f
))
4189 if (tem
= XCDR (spec
), CONSP (tem
))
4191 it
->slice
.x
= XCAR (tem
);
4192 if (tem
= XCDR (tem
), CONSP (tem
))
4194 it
->slice
.y
= XCAR (tem
);
4195 if (tem
= XCDR (tem
), CONSP (tem
))
4197 it
->slice
.width
= XCAR (tem
);
4198 if (tem
= XCDR (tem
), CONSP (tem
))
4199 it
->slice
.height
= XCAR (tem
);
4207 /* Handle `(raise FACTOR)'. */
4209 && EQ (XCAR (spec
), Qraise
)
4210 && CONSP (XCDR (spec
)))
4212 if (!FRAME_WINDOW_P (it
->f
))
4215 #ifdef HAVE_WINDOW_SYSTEM
4216 value
= XCAR (XCDR (spec
));
4217 if (NUMBERP (value
))
4219 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4220 it
->voffset
= - (XFLOATINT (value
)
4221 * (FONT_HEIGHT (face
->font
)));
4223 #endif /* HAVE_WINDOW_SYSTEM */
4228 /* Don't handle the other kinds of display specifications
4229 inside a string that we got from a `display' property. */
4230 if (it
->string_from_display_prop_p
)
4233 /* Characters having this form of property are not displayed, so
4234 we have to find the end of the property. */
4235 start_pos
= *position
;
4236 *position
= display_prop_end (it
, object
, start_pos
);
4239 /* Stop the scan at that end position--we assume that all
4240 text properties change there. */
4241 it
->stop_charpos
= position
->charpos
;
4243 /* Handle `(left-fringe BITMAP [FACE])'
4244 and `(right-fringe BITMAP [FACE])'. */
4246 && (EQ (XCAR (spec
), Qleft_fringe
)
4247 || EQ (XCAR (spec
), Qright_fringe
))
4248 && CONSP (XCDR (spec
)))
4250 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4253 if (!FRAME_WINDOW_P (it
->f
))
4254 /* If we return here, POSITION has been advanced
4255 across the text with this property. */
4258 #ifdef HAVE_WINDOW_SYSTEM
4259 value
= XCAR (XCDR (spec
));
4260 if (!SYMBOLP (value
)
4261 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4262 /* If we return here, POSITION has been advanced
4263 across the text with this property. */
4266 if (CONSP (XCDR (XCDR (spec
))))
4268 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4269 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4275 /* Save current settings of IT so that we can restore them
4276 when we are finished with the glyph property value. */
4278 save_pos
= it
->position
;
4279 it
->position
= *position
;
4281 it
->position
= save_pos
;
4283 it
->area
= TEXT_AREA
;
4284 it
->what
= IT_IMAGE
;
4285 it
->image_id
= -1; /* no image */
4286 it
->position
= start_pos
;
4287 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4288 it
->method
= GET_FROM_IMAGE
;
4289 it
->from_overlay
= Qnil
;
4290 it
->face_id
= face_id
;
4292 /* Say that we haven't consumed the characters with
4293 `display' property yet. The call to pop_it in
4294 set_iterator_to_next will clean this up. */
4295 *position
= start_pos
;
4297 if (EQ (XCAR (spec
), Qleft_fringe
))
4299 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4300 it
->left_user_fringe_face_id
= face_id
;
4304 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4305 it
->right_user_fringe_face_id
= face_id
;
4307 #endif /* HAVE_WINDOW_SYSTEM */
4311 /* Prepare to handle `((margin left-margin) ...)',
4312 `((margin right-margin) ...)' and `((margin nil) ...)'
4313 prefixes for display specifications. */
4314 location
= Qunbound
;
4315 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4319 value
= XCDR (spec
);
4321 value
= XCAR (value
);
4324 if (EQ (XCAR (tem
), Qmargin
)
4325 && (tem
= XCDR (tem
),
4326 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4328 || EQ (tem
, Qleft_margin
)
4329 || EQ (tem
, Qright_margin
))))
4333 if (EQ (location
, Qunbound
))
4339 /* After this point, VALUE is the property after any
4340 margin prefix has been stripped. It must be a string,
4341 an image specification, or `(space ...)'.
4343 LOCATION specifies where to display: `left-margin',
4344 `right-margin' or nil. */
4346 valid_p
= (STRINGP (value
)
4347 #ifdef HAVE_WINDOW_SYSTEM
4348 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4349 #endif /* not HAVE_WINDOW_SYSTEM */
4350 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4352 if (valid_p
&& !display_replaced_before_p
)
4354 /* Save current settings of IT so that we can restore them
4355 when we are finished with the glyph property value. */
4356 save_pos
= it
->position
;
4357 it
->position
= *position
;
4359 it
->position
= save_pos
;
4360 it
->from_overlay
= overlay
;
4362 if (NILP (location
))
4363 it
->area
= TEXT_AREA
;
4364 else if (EQ (location
, Qleft_margin
))
4365 it
->area
= LEFT_MARGIN_AREA
;
4367 it
->area
= RIGHT_MARGIN_AREA
;
4369 if (STRINGP (value
))
4372 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4373 it
->current
.overlay_string_index
= -1;
4374 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4375 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4376 it
->method
= GET_FROM_STRING
;
4377 it
->stop_charpos
= 0;
4378 it
->string_from_display_prop_p
= 1;
4379 /* Say that we haven't consumed the characters with
4380 `display' property yet. The call to pop_it in
4381 set_iterator_to_next will clean this up. */
4382 if (BUFFERP (object
))
4383 *position
= start_pos
;
4385 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4387 it
->method
= GET_FROM_STRETCH
;
4389 *position
= it
->position
= start_pos
;
4391 #ifdef HAVE_WINDOW_SYSTEM
4394 it
->what
= IT_IMAGE
;
4395 it
->image_id
= lookup_image (it
->f
, value
);
4396 it
->position
= start_pos
;
4397 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4398 it
->method
= GET_FROM_IMAGE
;
4400 /* Say that we haven't consumed the characters with
4401 `display' property yet. The call to pop_it in
4402 set_iterator_to_next will clean this up. */
4403 *position
= start_pos
;
4405 #endif /* HAVE_WINDOW_SYSTEM */
4410 /* Invalid property or property not supported. Restore
4411 POSITION to what it was before. */
4412 *position
= start_pos
;
4417 /* Check if SPEC is a display sub-property value whose text should be
4418 treated as intangible. */
4421 single_display_spec_intangible_p (prop
)
4424 /* Skip over `when FORM'. */
4425 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4439 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4440 we don't need to treat text as intangible. */
4441 if (EQ (XCAR (prop
), Qmargin
))
4449 || EQ (XCAR (prop
), Qleft_margin
)
4450 || EQ (XCAR (prop
), Qright_margin
))
4454 return (CONSP (prop
)
4455 && (EQ (XCAR (prop
), Qimage
)
4456 || EQ (XCAR (prop
), Qspace
)));
4460 /* Check if PROP is a display property value whose text should be
4461 treated as intangible. */
4464 display_prop_intangible_p (prop
)
4468 && CONSP (XCAR (prop
))
4469 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4471 /* A list of sub-properties. */
4472 while (CONSP (prop
))
4474 if (single_display_spec_intangible_p (XCAR (prop
)))
4479 else if (VECTORP (prop
))
4481 /* A vector of sub-properties. */
4483 for (i
= 0; i
< ASIZE (prop
); ++i
)
4484 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4488 return single_display_spec_intangible_p (prop
);
4494 /* Return 1 if PROP is a display sub-property value containing STRING. */
4497 single_display_spec_string_p (prop
, string
)
4498 Lisp_Object prop
, string
;
4500 if (EQ (string
, prop
))
4503 /* Skip over `when FORM'. */
4504 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4513 /* Skip over `margin LOCATION'. */
4514 if (EQ (XCAR (prop
), Qmargin
))
4525 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4529 /* Return 1 if STRING appears in the `display' property PROP. */
4532 display_prop_string_p (prop
, string
)
4533 Lisp_Object prop
, string
;
4536 && CONSP (XCAR (prop
))
4537 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4539 /* A list of sub-properties. */
4540 while (CONSP (prop
))
4542 if (single_display_spec_string_p (XCAR (prop
), string
))
4547 else if (VECTORP (prop
))
4549 /* A vector of sub-properties. */
4551 for (i
= 0; i
< ASIZE (prop
); ++i
)
4552 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4556 return single_display_spec_string_p (prop
, string
);
4562 /* Determine from which buffer position in W's buffer STRING comes
4563 from. AROUND_CHARPOS is an approximate position where it could
4564 be from. Value is the buffer position or 0 if it couldn't be
4567 W's buffer must be current.
4569 This function is necessary because we don't record buffer positions
4570 in glyphs generated from strings (to keep struct glyph small).
4571 This function may only use code that doesn't eval because it is
4572 called asynchronously from note_mouse_highlight. */
4575 string_buffer_position (w
, string
, around_charpos
)
4580 Lisp_Object limit
, prop
, pos
;
4581 const int MAX_DISTANCE
= 1000;
4584 pos
= make_number (around_charpos
);
4585 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4586 while (!found
&& !EQ (pos
, limit
))
4588 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4589 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4592 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4597 pos
= make_number (around_charpos
);
4598 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4599 while (!found
&& !EQ (pos
, limit
))
4601 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4602 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4605 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4610 return found
? XINT (pos
) : 0;
4615 /***********************************************************************
4616 `composition' property
4617 ***********************************************************************/
4619 /* Set up iterator IT from `composition' property at its current
4620 position. Called from handle_stop. */
4622 static enum prop_handled
4623 handle_composition_prop (it
)
4626 Lisp_Object prop
, string
;
4627 EMACS_INT pos
, pos_byte
, start
, end
;
4629 if (STRINGP (it
->string
))
4633 pos
= IT_STRING_CHARPOS (*it
);
4634 pos_byte
= IT_STRING_BYTEPOS (*it
);
4635 string
= it
->string
;
4636 s
= SDATA (string
) + pos_byte
;
4637 it
->c
= STRING_CHAR (s
, 0);
4641 pos
= IT_CHARPOS (*it
);
4642 pos_byte
= IT_BYTEPOS (*it
);
4644 it
->c
= FETCH_CHAR (pos_byte
);
4647 /* If there's a valid composition and point is not inside of the
4648 composition (in the case that the composition is from the current
4649 buffer), draw a glyph composed from the composition components. */
4650 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4651 && COMPOSITION_VALID_P (start
, end
, prop
)
4652 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4656 if (STRINGP (it
->string
))
4657 pos_byte
= string_char_to_byte (it
->string
, start
);
4659 pos_byte
= CHAR_TO_BYTE (start
);
4661 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4664 if (it
->cmp_it
.id
>= 0)
4667 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4668 it
->cmp_it
.nglyphs
= -1;
4672 return HANDLED_NORMALLY
;
4677 /***********************************************************************
4679 ***********************************************************************/
4681 /* The following structure is used to record overlay strings for
4682 later sorting in load_overlay_strings. */
4684 struct overlay_entry
4686 Lisp_Object overlay
;
4693 /* Set up iterator IT from overlay strings at its current position.
4694 Called from handle_stop. */
4696 static enum prop_handled
4697 handle_overlay_change (it
)
4700 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4701 return HANDLED_RECOMPUTE_PROPS
;
4703 return HANDLED_NORMALLY
;
4707 /* Set up the next overlay string for delivery by IT, if there is an
4708 overlay string to deliver. Called by set_iterator_to_next when the
4709 end of the current overlay string is reached. If there are more
4710 overlay strings to display, IT->string and
4711 IT->current.overlay_string_index are set appropriately here.
4712 Otherwise IT->string is set to nil. */
4715 next_overlay_string (it
)
4718 ++it
->current
.overlay_string_index
;
4719 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4721 /* No more overlay strings. Restore IT's settings to what
4722 they were before overlay strings were processed, and
4723 continue to deliver from current_buffer. */
4725 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4728 || (NILP (it
->string
)
4729 && it
->method
== GET_FROM_BUFFER
4730 && it
->stop_charpos
>= BEGV
4731 && it
->stop_charpos
<= it
->end_charpos
));
4732 it
->current
.overlay_string_index
= -1;
4733 it
->n_overlay_strings
= 0;
4735 /* If we're at the end of the buffer, record that we have
4736 processed the overlay strings there already, so that
4737 next_element_from_buffer doesn't try it again. */
4738 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4739 it
->overlay_strings_at_end_processed_p
= 1;
4743 /* There are more overlay strings to process. If
4744 IT->current.overlay_string_index has advanced to a position
4745 where we must load IT->overlay_strings with more strings, do
4747 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4749 if (it
->current
.overlay_string_index
&& i
== 0)
4750 load_overlay_strings (it
, 0);
4752 /* Initialize IT to deliver display elements from the overlay
4754 it
->string
= it
->overlay_strings
[i
];
4755 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4756 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4757 it
->method
= GET_FROM_STRING
;
4758 it
->stop_charpos
= 0;
4759 if (it
->cmp_it
.stop_pos
>= 0)
4760 it
->cmp_it
.stop_pos
= 0;
4767 /* Compare two overlay_entry structures E1 and E2. Used as a
4768 comparison function for qsort in load_overlay_strings. Overlay
4769 strings for the same position are sorted so that
4771 1. All after-strings come in front of before-strings, except
4772 when they come from the same overlay.
4774 2. Within after-strings, strings are sorted so that overlay strings
4775 from overlays with higher priorities come first.
4777 2. Within before-strings, strings are sorted so that overlay
4778 strings from overlays with higher priorities come last.
4780 Value is analogous to strcmp. */
4784 compare_overlay_entries (e1
, e2
)
4787 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4788 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4791 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4793 /* Let after-strings appear in front of before-strings if
4794 they come from different overlays. */
4795 if (EQ (entry1
->overlay
, entry2
->overlay
))
4796 result
= entry1
->after_string_p
? 1 : -1;
4798 result
= entry1
->after_string_p
? -1 : 1;
4800 else if (entry1
->after_string_p
)
4801 /* After-strings sorted in order of decreasing priority. */
4802 result
= entry2
->priority
- entry1
->priority
;
4804 /* Before-strings sorted in order of increasing priority. */
4805 result
= entry1
->priority
- entry2
->priority
;
4811 /* Load the vector IT->overlay_strings with overlay strings from IT's
4812 current buffer position, or from CHARPOS if that is > 0. Set
4813 IT->n_overlays to the total number of overlay strings found.
4815 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4816 a time. On entry into load_overlay_strings,
4817 IT->current.overlay_string_index gives the number of overlay
4818 strings that have already been loaded by previous calls to this
4821 IT->add_overlay_start contains an additional overlay start
4822 position to consider for taking overlay strings from, if non-zero.
4823 This position comes into play when the overlay has an `invisible'
4824 property, and both before and after-strings. When we've skipped to
4825 the end of the overlay, because of its `invisible' property, we
4826 nevertheless want its before-string to appear.
4827 IT->add_overlay_start will contain the overlay start position
4830 Overlay strings are sorted so that after-string strings come in
4831 front of before-string strings. Within before and after-strings,
4832 strings are sorted by overlay priority. See also function
4833 compare_overlay_entries. */
4836 load_overlay_strings (it
, charpos
)
4840 extern Lisp_Object Qafter_string
, Qbefore_string
, Qwindow
, Qpriority
;
4841 Lisp_Object overlay
, window
, str
, invisible
;
4842 struct Lisp_Overlay
*ov
;
4845 int n
= 0, i
, j
, invis_p
;
4846 struct overlay_entry
*entries
4847 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4850 charpos
= IT_CHARPOS (*it
);
4852 /* Append the overlay string STRING of overlay OVERLAY to vector
4853 `entries' which has size `size' and currently contains `n'
4854 elements. AFTER_P non-zero means STRING is an after-string of
4856 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4859 Lisp_Object priority; \
4863 int new_size = 2 * size; \
4864 struct overlay_entry *old = entries; \
4866 (struct overlay_entry *) alloca (new_size \
4867 * sizeof *entries); \
4868 bcopy (old, entries, size * sizeof *entries); \
4872 entries[n].string = (STRING); \
4873 entries[n].overlay = (OVERLAY); \
4874 priority = Foverlay_get ((OVERLAY), Qpriority); \
4875 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4876 entries[n].after_string_p = (AFTER_P); \
4881 /* Process overlay before the overlay center. */
4882 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4884 XSETMISC (overlay
, ov
);
4885 xassert (OVERLAYP (overlay
));
4886 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4887 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4892 /* Skip this overlay if it doesn't start or end at IT's current
4894 if (end
!= charpos
&& start
!= charpos
)
4897 /* Skip this overlay if it doesn't apply to IT->w. */
4898 window
= Foverlay_get (overlay
, Qwindow
);
4899 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4902 /* If the text ``under'' the overlay is invisible, both before-
4903 and after-strings from this overlay are visible; start and
4904 end position are indistinguishable. */
4905 invisible
= Foverlay_get (overlay
, Qinvisible
);
4906 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4908 /* If overlay has a non-empty before-string, record it. */
4909 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4910 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4912 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4914 /* If overlay has a non-empty after-string, record it. */
4915 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4916 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4918 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4921 /* Process overlays after the overlay center. */
4922 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4924 XSETMISC (overlay
, ov
);
4925 xassert (OVERLAYP (overlay
));
4926 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4927 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4929 if (start
> charpos
)
4932 /* Skip this overlay if it doesn't start or end at IT's current
4934 if (end
!= charpos
&& start
!= charpos
)
4937 /* Skip this overlay if it doesn't apply to IT->w. */
4938 window
= Foverlay_get (overlay
, Qwindow
);
4939 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4942 /* If the text ``under'' the overlay is invisible, it has a zero
4943 dimension, and both before- and after-strings apply. */
4944 invisible
= Foverlay_get (overlay
, Qinvisible
);
4945 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4947 /* If overlay has a non-empty before-string, record it. */
4948 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4949 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4951 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4953 /* If overlay has a non-empty after-string, record it. */
4954 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4955 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4957 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4960 #undef RECORD_OVERLAY_STRING
4964 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4966 /* Record the total number of strings to process. */
4967 it
->n_overlay_strings
= n
;
4969 /* IT->current.overlay_string_index is the number of overlay strings
4970 that have already been consumed by IT. Copy some of the
4971 remaining overlay strings to IT->overlay_strings. */
4973 j
= it
->current
.overlay_string_index
;
4974 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4976 it
->overlay_strings
[i
] = entries
[j
].string
;
4977 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4984 /* Get the first chunk of overlay strings at IT's current buffer
4985 position, or at CHARPOS if that is > 0. Value is non-zero if at
4986 least one overlay string was found. */
4989 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
4994 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
4995 process. This fills IT->overlay_strings with strings, and sets
4996 IT->n_overlay_strings to the total number of strings to process.
4997 IT->pos.overlay_string_index has to be set temporarily to zero
4998 because load_overlay_strings needs this; it must be set to -1
4999 when no overlay strings are found because a zero value would
5000 indicate a position in the first overlay string. */
5001 it
->current
.overlay_string_index
= 0;
5002 load_overlay_strings (it
, charpos
);
5004 /* If we found overlay strings, set up IT to deliver display
5005 elements from the first one. Otherwise set up IT to deliver
5006 from current_buffer. */
5007 if (it
->n_overlay_strings
)
5009 /* Make sure we know settings in current_buffer, so that we can
5010 restore meaningful values when we're done with the overlay
5013 compute_stop_pos (it
);
5014 xassert (it
->face_id
>= 0);
5016 /* Save IT's settings. They are restored after all overlay
5017 strings have been processed. */
5018 xassert (!compute_stop_p
|| it
->sp
== 0);
5020 /* When called from handle_stop, there might be an empty display
5021 string loaded. In that case, don't bother saving it. */
5022 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5025 /* Set up IT to deliver display elements from the first overlay
5027 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5028 it
->string
= it
->overlay_strings
[0];
5029 it
->from_overlay
= Qnil
;
5030 it
->stop_charpos
= 0;
5031 xassert (STRINGP (it
->string
));
5032 it
->end_charpos
= SCHARS (it
->string
);
5033 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5034 it
->method
= GET_FROM_STRING
;
5038 it
->current
.overlay_string_index
= -1;
5043 get_overlay_strings (it
, charpos
)
5048 it
->method
= GET_FROM_BUFFER
;
5050 (void) get_overlay_strings_1 (it
, charpos
, 1);
5054 /* Value is non-zero if we found at least one overlay string. */
5055 return STRINGP (it
->string
);
5060 /***********************************************************************
5061 Saving and restoring state
5062 ***********************************************************************/
5064 /* Save current settings of IT on IT->stack. Called, for example,
5065 before setting up IT for an overlay string, to be able to restore
5066 IT's settings to what they were after the overlay string has been
5073 struct iterator_stack_entry
*p
;
5075 xassert (it
->sp
< IT_STACK_SIZE
);
5076 p
= it
->stack
+ it
->sp
;
5078 p
->stop_charpos
= it
->stop_charpos
;
5079 p
->cmp_it
= it
->cmp_it
;
5080 xassert (it
->face_id
>= 0);
5081 p
->face_id
= it
->face_id
;
5082 p
->string
= it
->string
;
5083 p
->method
= it
->method
;
5084 p
->from_overlay
= it
->from_overlay
;
5087 case GET_FROM_IMAGE
:
5088 p
->u
.image
.object
= it
->object
;
5089 p
->u
.image
.image_id
= it
->image_id
;
5090 p
->u
.image
.slice
= it
->slice
;
5092 case GET_FROM_STRETCH
:
5093 p
->u
.stretch
.object
= it
->object
;
5096 p
->position
= it
->position
;
5097 p
->current
= it
->current
;
5098 p
->end_charpos
= it
->end_charpos
;
5099 p
->string_nchars
= it
->string_nchars
;
5101 p
->multibyte_p
= it
->multibyte_p
;
5102 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5103 p
->space_width
= it
->space_width
;
5104 p
->font_height
= it
->font_height
;
5105 p
->voffset
= it
->voffset
;
5106 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5107 p
->display_ellipsis_p
= 0;
5112 /* Restore IT's settings from IT->stack. Called, for example, when no
5113 more overlay strings must be processed, and we return to delivering
5114 display elements from a buffer, or when the end of a string from a
5115 `display' property is reached and we return to delivering display
5116 elements from an overlay string, or from a buffer. */
5122 struct iterator_stack_entry
*p
;
5124 xassert (it
->sp
> 0);
5126 p
= it
->stack
+ it
->sp
;
5127 it
->stop_charpos
= p
->stop_charpos
;
5128 it
->cmp_it
= p
->cmp_it
;
5129 it
->face_id
= p
->face_id
;
5130 it
->current
= p
->current
;
5131 it
->position
= p
->position
;
5132 it
->string
= p
->string
;
5133 it
->from_overlay
= p
->from_overlay
;
5134 if (NILP (it
->string
))
5135 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5136 it
->method
= p
->method
;
5139 case GET_FROM_IMAGE
:
5140 it
->image_id
= p
->u
.image
.image_id
;
5141 it
->object
= p
->u
.image
.object
;
5142 it
->slice
= p
->u
.image
.slice
;
5144 case GET_FROM_STRETCH
:
5145 it
->object
= p
->u
.comp
.object
;
5147 case GET_FROM_BUFFER
:
5148 it
->object
= it
->w
->buffer
;
5150 case GET_FROM_STRING
:
5151 it
->object
= it
->string
;
5154 it
->end_charpos
= p
->end_charpos
;
5155 it
->string_nchars
= p
->string_nchars
;
5157 it
->multibyte_p
= p
->multibyte_p
;
5158 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5159 it
->space_width
= p
->space_width
;
5160 it
->font_height
= p
->font_height
;
5161 it
->voffset
= p
->voffset
;
5162 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5167 /***********************************************************************
5169 ***********************************************************************/
5171 /* Set IT's current position to the previous line start. */
5174 back_to_previous_line_start (it
)
5177 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5178 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5182 /* Move IT to the next line start.
5184 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5185 we skipped over part of the text (as opposed to moving the iterator
5186 continuously over the text). Otherwise, don't change the value
5189 Newlines may come from buffer text, overlay strings, or strings
5190 displayed via the `display' property. That's the reason we can't
5191 simply use find_next_newline_no_quit.
5193 Note that this function may not skip over invisible text that is so
5194 because of text properties and immediately follows a newline. If
5195 it would, function reseat_at_next_visible_line_start, when called
5196 from set_iterator_to_next, would effectively make invisible
5197 characters following a newline part of the wrong glyph row, which
5198 leads to wrong cursor motion. */
5201 forward_to_next_line_start (it
, skipped_p
)
5205 int old_selective
, newline_found_p
, n
;
5206 const int MAX_NEWLINE_DISTANCE
= 500;
5208 /* If already on a newline, just consume it to avoid unintended
5209 skipping over invisible text below. */
5210 if (it
->what
== IT_CHARACTER
5212 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5214 set_iterator_to_next (it
, 0);
5219 /* Don't handle selective display in the following. It's (a)
5220 unnecessary because it's done by the caller, and (b) leads to an
5221 infinite recursion because next_element_from_ellipsis indirectly
5222 calls this function. */
5223 old_selective
= it
->selective
;
5226 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5227 from buffer text. */
5228 for (n
= newline_found_p
= 0;
5229 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5230 n
+= STRINGP (it
->string
) ? 0 : 1)
5232 if (!get_next_display_element (it
))
5234 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5235 set_iterator_to_next (it
, 0);
5238 /* If we didn't find a newline near enough, see if we can use a
5240 if (!newline_found_p
)
5242 int start
= IT_CHARPOS (*it
);
5243 int limit
= find_next_newline_no_quit (start
, 1);
5246 xassert (!STRINGP (it
->string
));
5248 /* If there isn't any `display' property in sight, and no
5249 overlays, we can just use the position of the newline in
5251 if (it
->stop_charpos
>= limit
5252 || ((pos
= Fnext_single_property_change (make_number (start
),
5254 Qnil
, make_number (limit
)),
5256 && next_overlay_change (start
) == ZV
))
5258 IT_CHARPOS (*it
) = limit
;
5259 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5260 *skipped_p
= newline_found_p
= 1;
5264 while (get_next_display_element (it
)
5265 && !newline_found_p
)
5267 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5268 set_iterator_to_next (it
, 0);
5273 it
->selective
= old_selective
;
5274 return newline_found_p
;
5278 /* Set IT's current position to the previous visible line start. Skip
5279 invisible text that is so either due to text properties or due to
5280 selective display. Caution: this does not change IT->current_x and
5284 back_to_previous_visible_line_start (it
)
5287 while (IT_CHARPOS (*it
) > BEGV
)
5289 back_to_previous_line_start (it
);
5291 if (IT_CHARPOS (*it
) <= BEGV
)
5294 /* If selective > 0, then lines indented more than that values
5296 if (it
->selective
> 0
5297 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5298 (double) it
->selective
)) /* iftc */
5301 /* Check the newline before point for invisibility. */
5304 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5305 Qinvisible
, it
->window
);
5306 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5310 if (IT_CHARPOS (*it
) <= BEGV
)
5317 Lisp_Object val
, overlay
;
5319 /* If newline is part of a composition, continue from start of composition */
5320 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5321 && beg
< IT_CHARPOS (*it
))
5324 /* If newline is replaced by a display property, find start of overlay
5325 or interval and continue search from that point. */
5327 pos
= --IT_CHARPOS (it2
);
5330 it2
.string_from_display_prop_p
= 0;
5331 if (handle_display_prop (&it2
) == HANDLED_RETURN
5332 && !NILP (val
= get_char_property_and_overlay
5333 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5334 && (OVERLAYP (overlay
)
5335 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5336 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5339 /* Newline is not replaced by anything -- so we are done. */
5345 IT_CHARPOS (*it
) = beg
;
5346 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5350 it
->continuation_lines_width
= 0;
5352 xassert (IT_CHARPOS (*it
) >= BEGV
);
5353 xassert (IT_CHARPOS (*it
) == BEGV
5354 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5359 /* Reseat iterator IT at the previous visible line start. Skip
5360 invisible text that is so either due to text properties or due to
5361 selective display. At the end, update IT's overlay information,
5362 face information etc. */
5365 reseat_at_previous_visible_line_start (it
)
5368 back_to_previous_visible_line_start (it
);
5369 reseat (it
, it
->current
.pos
, 1);
5374 /* Reseat iterator IT on the next visible line start in the current
5375 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5376 preceding the line start. Skip over invisible text that is so
5377 because of selective display. Compute faces, overlays etc at the
5378 new position. Note that this function does not skip over text that
5379 is invisible because of text properties. */
5382 reseat_at_next_visible_line_start (it
, on_newline_p
)
5386 int newline_found_p
, skipped_p
= 0;
5388 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5390 /* Skip over lines that are invisible because they are indented
5391 more than the value of IT->selective. */
5392 if (it
->selective
> 0)
5393 while (IT_CHARPOS (*it
) < ZV
5394 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5395 (double) it
->selective
)) /* iftc */
5397 xassert (IT_BYTEPOS (*it
) == BEGV
5398 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5399 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5402 /* Position on the newline if that's what's requested. */
5403 if (on_newline_p
&& newline_found_p
)
5405 if (STRINGP (it
->string
))
5407 if (IT_STRING_CHARPOS (*it
) > 0)
5409 --IT_STRING_CHARPOS (*it
);
5410 --IT_STRING_BYTEPOS (*it
);
5413 else if (IT_CHARPOS (*it
) > BEGV
)
5417 reseat (it
, it
->current
.pos
, 0);
5421 reseat (it
, it
->current
.pos
, 0);
5428 /***********************************************************************
5429 Changing an iterator's position
5430 ***********************************************************************/
5432 /* Change IT's current position to POS in current_buffer. If FORCE_P
5433 is non-zero, always check for text properties at the new position.
5434 Otherwise, text properties are only looked up if POS >=
5435 IT->check_charpos of a property. */
5438 reseat (it
, pos
, force_p
)
5440 struct text_pos pos
;
5443 int original_pos
= IT_CHARPOS (*it
);
5445 reseat_1 (it
, pos
, 0);
5447 /* Determine where to check text properties. Avoid doing it
5448 where possible because text property lookup is very expensive. */
5450 || CHARPOS (pos
) > it
->stop_charpos
5451 || CHARPOS (pos
) < original_pos
)
5458 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5459 IT->stop_pos to POS, also. */
5462 reseat_1 (it
, pos
, set_stop_p
)
5464 struct text_pos pos
;
5467 /* Don't call this function when scanning a C string. */
5468 xassert (it
->s
== NULL
);
5470 /* POS must be a reasonable value. */
5471 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5473 it
->current
.pos
= it
->position
= pos
;
5474 it
->end_charpos
= ZV
;
5476 it
->current
.dpvec_index
= -1;
5477 it
->current
.overlay_string_index
= -1;
5478 IT_STRING_CHARPOS (*it
) = -1;
5479 IT_STRING_BYTEPOS (*it
) = -1;
5481 it
->string_from_display_prop_p
= 0;
5482 it
->method
= GET_FROM_BUFFER
;
5483 it
->object
= it
->w
->buffer
;
5484 it
->area
= TEXT_AREA
;
5485 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5487 it
->string_from_display_prop_p
= 0;
5488 it
->face_before_selective_p
= 0;
5491 it
->stop_charpos
= CHARPOS (pos
);
5495 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5496 If S is non-null, it is a C string to iterate over. Otherwise,
5497 STRING gives a Lisp string to iterate over.
5499 If PRECISION > 0, don't return more then PRECISION number of
5500 characters from the string.
5502 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5503 characters have been returned. FIELD_WIDTH < 0 means an infinite
5506 MULTIBYTE = 0 means disable processing of multibyte characters,
5507 MULTIBYTE > 0 means enable it,
5508 MULTIBYTE < 0 means use IT->multibyte_p.
5510 IT must be initialized via a prior call to init_iterator before
5511 calling this function. */
5514 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5519 int precision
, field_width
, multibyte
;
5521 /* No region in strings. */
5522 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5524 /* No text property checks performed by default, but see below. */
5525 it
->stop_charpos
= -1;
5527 /* Set iterator position and end position. */
5528 bzero (&it
->current
, sizeof it
->current
);
5529 it
->current
.overlay_string_index
= -1;
5530 it
->current
.dpvec_index
= -1;
5531 xassert (charpos
>= 0);
5533 /* If STRING is specified, use its multibyteness, otherwise use the
5534 setting of MULTIBYTE, if specified. */
5536 it
->multibyte_p
= multibyte
> 0;
5540 xassert (STRINGP (string
));
5541 it
->string
= string
;
5543 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5544 it
->method
= GET_FROM_STRING
;
5545 it
->current
.string_pos
= string_pos (charpos
, string
);
5552 /* Note that we use IT->current.pos, not it->current.string_pos,
5553 for displaying C strings. */
5554 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5555 if (it
->multibyte_p
)
5557 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5558 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5562 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5563 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5566 it
->method
= GET_FROM_C_STRING
;
5569 /* PRECISION > 0 means don't return more than PRECISION characters
5571 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5572 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5574 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5575 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5576 FIELD_WIDTH < 0 means infinite field width. This is useful for
5577 padding with `-' at the end of a mode line. */
5578 if (field_width
< 0)
5579 field_width
= INFINITY
;
5580 if (field_width
> it
->end_charpos
- charpos
)
5581 it
->end_charpos
= charpos
+ field_width
;
5583 /* Use the standard display table for displaying strings. */
5584 if (DISP_TABLE_P (Vstandard_display_table
))
5585 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5587 it
->stop_charpos
= charpos
;
5593 /***********************************************************************
5595 ***********************************************************************/
5597 /* Map enum it_method value to corresponding next_element_from_* function. */
5599 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5601 next_element_from_buffer
,
5602 next_element_from_display_vector
,
5603 next_element_from_string
,
5604 next_element_from_c_string
,
5605 next_element_from_image
,
5606 next_element_from_stretch
5609 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5612 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5613 (possibly with the following characters). */
5615 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS) \
5616 ((IT)->cmp_it.id >= 0 \
5617 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5618 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5619 (IT)->end_charpos, (IT)->w, \
5620 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5624 /* Load IT's display element fields with information about the next
5625 display element from the current position of IT. Value is zero if
5626 end of buffer (or C string) is reached. */
5628 static struct frame
*last_escape_glyph_frame
= NULL
;
5629 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5630 static int last_escape_glyph_merged_face_id
= 0;
5633 get_next_display_element (it
)
5636 /* Non-zero means that we found a display element. Zero means that
5637 we hit the end of what we iterate over. Performance note: the
5638 function pointer `method' used here turns out to be faster than
5639 using a sequence of if-statements. */
5643 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5645 if (it
->what
== IT_CHARACTER
)
5647 /* Map via display table or translate control characters.
5648 IT->c, IT->len etc. have been set to the next character by
5649 the function call above. If we have a display table, and it
5650 contains an entry for IT->c, translate it. Don't do this if
5651 IT->c itself comes from a display table, otherwise we could
5652 end up in an infinite recursion. (An alternative could be to
5653 count the recursion depth of this function and signal an
5654 error when a certain maximum depth is reached.) Is it worth
5656 if (success_p
&& it
->dpvec
== NULL
)
5661 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5664 struct Lisp_Vector
*v
= XVECTOR (dv
);
5666 /* Return the first character from the display table
5667 entry, if not empty. If empty, don't display the
5668 current character. */
5671 it
->dpvec_char_len
= it
->len
;
5672 it
->dpvec
= v
->contents
;
5673 it
->dpend
= v
->contents
+ v
->size
;
5674 it
->current
.dpvec_index
= 0;
5675 it
->dpvec_face_id
= -1;
5676 it
->saved_face_id
= it
->face_id
;
5677 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5682 set_iterator_to_next (it
, 0);
5687 /* Translate control characters into `\003' or `^C' form.
5688 Control characters coming from a display table entry are
5689 currently not translated because we use IT->dpvec to hold
5690 the translation. This could easily be changed but I
5691 don't believe that it is worth doing.
5693 If it->multibyte_p is nonzero, non-printable non-ASCII
5694 characters are also translated to octal form.
5696 If it->multibyte_p is zero, eight-bit characters that
5697 don't have corresponding multibyte char code are also
5698 translated to octal form. */
5699 else if ((it
->c
< ' '
5700 ? (it
->area
!= TEXT_AREA
5701 /* In mode line, treat \n, \t like other crl chars. */
5703 && it
->glyph_row
&& it
->glyph_row
->mode_line_p
)
5704 || (it
->c
!= '\n' && it
->c
!= '\t'))
5706 ? (!CHAR_PRINTABLE_P (it
->c
)
5707 || (!NILP (Vnobreak_char_display
)
5708 && (it
->c
== 0xA0 /* NO-BREAK SPACE */
5709 || it
->c
== 0xAD /* SOFT HYPHEN */)))
5711 && (! unibyte_display_via_language_environment
5712 || (UNIBYTE_CHAR_HAS_MULTIBYTE_P (it
->c
)))))))
5714 /* IT->c is a control character which must be displayed
5715 either as '\003' or as `^C' where the '\\' and '^'
5716 can be defined in the display table. Fill
5717 IT->ctl_chars with glyphs for what we have to
5718 display. Then, set IT->dpvec to these glyphs. */
5721 int face_id
, lface_id
= 0 ;
5724 /* Handle control characters with ^. */
5726 if (it
->c
< 128 && it
->ctl_arrow_p
)
5730 g
= '^'; /* default glyph for Control */
5731 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5733 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5734 && GLYPH_CODE_CHAR_VALID_P (gc
))
5736 g
= GLYPH_CODE_CHAR (gc
);
5737 lface_id
= GLYPH_CODE_FACE (gc
);
5741 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5743 else if (it
->f
== last_escape_glyph_frame
5744 && it
->face_id
== last_escape_glyph_face_id
)
5746 face_id
= last_escape_glyph_merged_face_id
;
5750 /* Merge the escape-glyph face into the current face. */
5751 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5753 last_escape_glyph_frame
= it
->f
;
5754 last_escape_glyph_face_id
= it
->face_id
;
5755 last_escape_glyph_merged_face_id
= face_id
;
5758 XSETINT (it
->ctl_chars
[0], g
);
5759 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5761 goto display_control
;
5764 /* Handle non-break space in the mode where it only gets
5767 if (EQ (Vnobreak_char_display
, Qt
)
5770 /* Merge the no-break-space face into the current face. */
5771 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5775 XSETINT (it
->ctl_chars
[0], ' ');
5777 goto display_control
;
5780 /* Handle sequences that start with the "escape glyph". */
5782 /* the default escape glyph is \. */
5783 escape_glyph
= '\\';
5786 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5787 && GLYPH_CODE_CHAR_VALID_P (gc
))
5789 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5790 lface_id
= GLYPH_CODE_FACE (gc
);
5794 /* The display table specified a face.
5795 Merge it into face_id and also into escape_glyph. */
5796 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5799 else if (it
->f
== last_escape_glyph_frame
5800 && it
->face_id
== last_escape_glyph_face_id
)
5802 face_id
= last_escape_glyph_merged_face_id
;
5806 /* Merge the escape-glyph face into the current face. */
5807 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5809 last_escape_glyph_frame
= it
->f
;
5810 last_escape_glyph_face_id
= it
->face_id
;
5811 last_escape_glyph_merged_face_id
= face_id
;
5814 /* Handle soft hyphens in the mode where they only get
5817 if (EQ (Vnobreak_char_display
, Qt
)
5821 XSETINT (it
->ctl_chars
[0], '-');
5823 goto display_control
;
5826 /* Handle non-break space and soft hyphen
5827 with the escape glyph. */
5829 if (it
->c
== 0xA0 || it
->c
== 0xAD)
5831 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5832 it
->c
= (it
->c
== 0xA0 ? ' ' : '-');
5833 XSETINT (it
->ctl_chars
[1], it
->c
);
5835 goto display_control
;
5839 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5843 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5844 if (CHAR_BYTE8_P (it
->c
))
5846 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5849 else if (it
->c
< 256)
5856 /* It's an invalid character, which shouldn't
5857 happen actually, but due to bugs it may
5858 happen. Let's print the char as is, there's
5859 not much meaningful we can do with it. */
5861 str
[1] = it
->c
>> 8;
5862 str
[2] = it
->c
>> 16;
5863 str
[3] = it
->c
>> 24;
5867 for (i
= 0; i
< len
; i
++)
5870 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5871 /* Insert three more glyphs into IT->ctl_chars for
5872 the octal display of the character. */
5873 g
= ((str
[i
] >> 6) & 7) + '0';
5874 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5875 g
= ((str
[i
] >> 3) & 7) + '0';
5876 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5877 g
= (str
[i
] & 7) + '0';
5878 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5884 /* Set up IT->dpvec and return first character from it. */
5885 it
->dpvec_char_len
= it
->len
;
5886 it
->dpvec
= it
->ctl_chars
;
5887 it
->dpend
= it
->dpvec
+ ctl_len
;
5888 it
->current
.dpvec_index
= 0;
5889 it
->dpvec_face_id
= face_id
;
5890 it
->saved_face_id
= it
->face_id
;
5891 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5898 #ifdef HAVE_WINDOW_SYSTEM
5899 /* Adjust face id for a multibyte character. There are no multibyte
5900 character in unibyte text. */
5901 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5904 && FRAME_WINDOW_P (it
->f
))
5906 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5908 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5910 /* Automatic composition with glyph-string. */
5911 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5913 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5917 int pos
= (it
->s
? -1
5918 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5919 : IT_CHARPOS (*it
));
5921 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
5926 /* Is this character the last one of a run of characters with
5927 box? If yes, set IT->end_of_box_run_p to 1. */
5931 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5933 int face_id
= underlying_face_id (it
);
5934 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5938 if (face
->box
== FACE_NO_BOX
)
5940 /* If the box comes from face properties in a
5941 display string, check faces in that string. */
5942 int string_face_id
= face_after_it_pos (it
);
5943 it
->end_of_box_run_p
5944 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5947 /* Otherwise, the box comes from the underlying face.
5948 If this is the last string character displayed, check
5949 the next buffer location. */
5950 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5951 && (it
->current
.overlay_string_index
5952 == it
->n_overlay_strings
- 1))
5956 struct text_pos pos
= it
->current
.pos
;
5957 INC_TEXT_POS (pos
, it
->multibyte_p
);
5959 next_face_id
= face_at_buffer_position
5960 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
5961 it
->region_end_charpos
, &ignore
,
5962 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0);
5963 it
->end_of_box_run_p
5964 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
5971 int face_id
= face_after_it_pos (it
);
5972 it
->end_of_box_run_p
5973 = (face_id
!= it
->face_id
5974 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
5978 /* Value is 0 if end of buffer or string reached. */
5983 /* Move IT to the next display element.
5985 RESEAT_P non-zero means if called on a newline in buffer text,
5986 skip to the next visible line start.
5988 Functions get_next_display_element and set_iterator_to_next are
5989 separate because I find this arrangement easier to handle than a
5990 get_next_display_element function that also increments IT's
5991 position. The way it is we can first look at an iterator's current
5992 display element, decide whether it fits on a line, and if it does,
5993 increment the iterator position. The other way around we probably
5994 would either need a flag indicating whether the iterator has to be
5995 incremented the next time, or we would have to implement a
5996 decrement position function which would not be easy to write. */
5999 set_iterator_to_next (it
, reseat_p
)
6003 /* Reset flags indicating start and end of a sequence of characters
6004 with box. Reset them at the start of this function because
6005 moving the iterator to a new position might set them. */
6006 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6010 case GET_FROM_BUFFER
:
6011 /* The current display element of IT is a character from
6012 current_buffer. Advance in the buffer, and maybe skip over
6013 invisible lines that are so because of selective display. */
6014 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6015 reseat_at_next_visible_line_start (it
, 0);
6016 else if (it
->cmp_it
.id
>= 0)
6018 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6019 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6020 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6021 it
->cmp_it
.from
= it
->cmp_it
.to
;
6025 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6026 IT_BYTEPOS (*it
), it
->stop_charpos
,
6032 xassert (it
->len
!= 0);
6033 IT_BYTEPOS (*it
) += it
->len
;
6034 IT_CHARPOS (*it
) += 1;
6035 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6039 case GET_FROM_C_STRING
:
6040 /* Current display element of IT is from a C string. */
6041 IT_BYTEPOS (*it
) += it
->len
;
6042 IT_CHARPOS (*it
) += 1;
6045 case GET_FROM_DISPLAY_VECTOR
:
6046 /* Current display element of IT is from a display table entry.
6047 Advance in the display table definition. Reset it to null if
6048 end reached, and continue with characters from buffers/
6050 ++it
->current
.dpvec_index
;
6052 /* Restore face of the iterator to what they were before the
6053 display vector entry (these entries may contain faces). */
6054 it
->face_id
= it
->saved_face_id
;
6056 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6058 int recheck_faces
= it
->ellipsis_p
;
6061 it
->method
= GET_FROM_C_STRING
;
6062 else if (STRINGP (it
->string
))
6063 it
->method
= GET_FROM_STRING
;
6066 it
->method
= GET_FROM_BUFFER
;
6067 it
->object
= it
->w
->buffer
;
6071 it
->current
.dpvec_index
= -1;
6073 /* Skip over characters which were displayed via IT->dpvec. */
6074 if (it
->dpvec_char_len
< 0)
6075 reseat_at_next_visible_line_start (it
, 1);
6076 else if (it
->dpvec_char_len
> 0)
6078 if (it
->method
== GET_FROM_STRING
6079 && it
->n_overlay_strings
> 0)
6080 it
->ignore_overlay_strings_at_pos_p
= 1;
6081 it
->len
= it
->dpvec_char_len
;
6082 set_iterator_to_next (it
, reseat_p
);
6085 /* Maybe recheck faces after display vector */
6087 it
->stop_charpos
= IT_CHARPOS (*it
);
6091 case GET_FROM_STRING
:
6092 /* Current display element is a character from a Lisp string. */
6093 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6094 if (it
->cmp_it
.id
>= 0)
6096 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6097 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6098 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6099 it
->cmp_it
.from
= it
->cmp_it
.to
;
6103 composition_compute_stop_pos (&it
->cmp_it
,
6104 IT_STRING_CHARPOS (*it
),
6105 IT_STRING_BYTEPOS (*it
),
6106 it
->stop_charpos
, it
->string
);
6111 IT_STRING_BYTEPOS (*it
) += it
->len
;
6112 IT_STRING_CHARPOS (*it
) += 1;
6115 consider_string_end
:
6117 if (it
->current
.overlay_string_index
>= 0)
6119 /* IT->string is an overlay string. Advance to the
6120 next, if there is one. */
6121 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6124 next_overlay_string (it
);
6126 setup_for_ellipsis (it
, 0);
6131 /* IT->string is not an overlay string. If we reached
6132 its end, and there is something on IT->stack, proceed
6133 with what is on the stack. This can be either another
6134 string, this time an overlay string, or a buffer. */
6135 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6139 if (it
->method
== GET_FROM_STRING
)
6140 goto consider_string_end
;
6145 case GET_FROM_IMAGE
:
6146 case GET_FROM_STRETCH
:
6147 /* The position etc with which we have to proceed are on
6148 the stack. The position may be at the end of a string,
6149 if the `display' property takes up the whole string. */
6150 xassert (it
->sp
> 0);
6152 if (it
->method
== GET_FROM_STRING
)
6153 goto consider_string_end
;
6157 /* There are no other methods defined, so this should be a bug. */
6161 xassert (it
->method
!= GET_FROM_STRING
6162 || (STRINGP (it
->string
)
6163 && IT_STRING_CHARPOS (*it
) >= 0));
6166 /* Load IT's display element fields with information about the next
6167 display element which comes from a display table entry or from the
6168 result of translating a control character to one of the forms `^C'
6171 IT->dpvec holds the glyphs to return as characters.
6172 IT->saved_face_id holds the face id before the display vector--
6173 it is restored into IT->face_idin set_iterator_to_next. */
6176 next_element_from_display_vector (it
)
6182 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6184 it
->face_id
= it
->saved_face_id
;
6186 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6187 That seemed totally bogus - so I changed it... */
6188 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6190 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6192 it
->c
= GLYPH_CODE_CHAR (gc
);
6193 it
->len
= CHAR_BYTES (it
->c
);
6195 /* The entry may contain a face id to use. Such a face id is
6196 the id of a Lisp face, not a realized face. A face id of
6197 zero means no face is specified. */
6198 if (it
->dpvec_face_id
>= 0)
6199 it
->face_id
= it
->dpvec_face_id
;
6202 int lface_id
= GLYPH_CODE_FACE (gc
);
6204 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6209 /* Display table entry is invalid. Return a space. */
6210 it
->c
= ' ', it
->len
= 1;
6212 /* Don't change position and object of the iterator here. They are
6213 still the values of the character that had this display table
6214 entry or was translated, and that's what we want. */
6215 it
->what
= IT_CHARACTER
;
6220 /* Load IT with the next display element from Lisp string IT->string.
6221 IT->current.string_pos is the current position within the string.
6222 If IT->current.overlay_string_index >= 0, the Lisp string is an
6226 next_element_from_string (it
)
6229 struct text_pos position
;
6231 xassert (STRINGP (it
->string
));
6232 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6233 position
= it
->current
.string_pos
;
6235 /* Time to check for invisible text? */
6236 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6237 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6241 /* Since a handler may have changed IT->method, we must
6243 return GET_NEXT_DISPLAY_ELEMENT (it
);
6246 if (it
->current
.overlay_string_index
>= 0)
6248 /* Get the next character from an overlay string. In overlay
6249 strings, There is no field width or padding with spaces to
6251 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6256 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6257 IT_STRING_BYTEPOS (*it
))
6258 && next_element_from_composition (it
))
6262 else if (STRING_MULTIBYTE (it
->string
))
6264 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6265 const unsigned char *s
= (SDATA (it
->string
)
6266 + IT_STRING_BYTEPOS (*it
));
6267 it
->c
= string_char_and_length (s
, remaining
, &it
->len
);
6271 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6277 /* Get the next character from a Lisp string that is not an
6278 overlay string. Such strings come from the mode line, for
6279 example. We may have to pad with spaces, or truncate the
6280 string. See also next_element_from_c_string. */
6281 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6286 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6288 /* Pad with spaces. */
6289 it
->c
= ' ', it
->len
= 1;
6290 CHARPOS (position
) = BYTEPOS (position
) = -1;
6292 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6293 IT_STRING_BYTEPOS (*it
))
6294 && next_element_from_composition (it
))
6298 else if (STRING_MULTIBYTE (it
->string
))
6300 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6301 const unsigned char *s
= (SDATA (it
->string
)
6302 + IT_STRING_BYTEPOS (*it
));
6303 it
->c
= string_char_and_length (s
, maxlen
, &it
->len
);
6307 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6312 /* Record what we have and where it came from. */
6313 it
->what
= IT_CHARACTER
;
6314 it
->object
= it
->string
;
6315 it
->position
= position
;
6320 /* Load IT with next display element from C string IT->s.
6321 IT->string_nchars is the maximum number of characters to return
6322 from the string. IT->end_charpos may be greater than
6323 IT->string_nchars when this function is called, in which case we
6324 may have to return padding spaces. Value is zero if end of string
6325 reached, including padding spaces. */
6328 next_element_from_c_string (it
)
6334 it
->what
= IT_CHARACTER
;
6335 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6338 /* IT's position can be greater IT->string_nchars in case a field
6339 width or precision has been specified when the iterator was
6341 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6343 /* End of the game. */
6347 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6349 /* Pad with spaces. */
6350 it
->c
= ' ', it
->len
= 1;
6351 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6353 else if (it
->multibyte_p
)
6355 /* Implementation note: The calls to strlen apparently aren't a
6356 performance problem because there is no noticeable performance
6357 difference between Emacs running in unibyte or multibyte mode. */
6358 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6359 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
),
6363 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6369 /* Set up IT to return characters from an ellipsis, if appropriate.
6370 The definition of the ellipsis glyphs may come from a display table
6371 entry. This function Fills IT with the first glyph from the
6372 ellipsis if an ellipsis is to be displayed. */
6375 next_element_from_ellipsis (it
)
6378 if (it
->selective_display_ellipsis_p
)
6379 setup_for_ellipsis (it
, it
->len
);
6382 /* The face at the current position may be different from the
6383 face we find after the invisible text. Remember what it
6384 was in IT->saved_face_id, and signal that it's there by
6385 setting face_before_selective_p. */
6386 it
->saved_face_id
= it
->face_id
;
6387 it
->method
= GET_FROM_BUFFER
;
6388 it
->object
= it
->w
->buffer
;
6389 reseat_at_next_visible_line_start (it
, 1);
6390 it
->face_before_selective_p
= 1;
6393 return GET_NEXT_DISPLAY_ELEMENT (it
);
6397 /* Deliver an image display element. The iterator IT is already
6398 filled with image information (done in handle_display_prop). Value
6403 next_element_from_image (it
)
6406 it
->what
= IT_IMAGE
;
6411 /* Fill iterator IT with next display element from a stretch glyph
6412 property. IT->object is the value of the text property. Value is
6416 next_element_from_stretch (it
)
6419 it
->what
= IT_STRETCH
;
6424 /* Load IT with the next display element from current_buffer. Value
6425 is zero if end of buffer reached. IT->stop_charpos is the next
6426 position at which to stop and check for text properties or buffer
6430 next_element_from_buffer (it
)
6435 xassert (IT_CHARPOS (*it
) >= BEGV
);
6437 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6439 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6441 int overlay_strings_follow_p
;
6443 /* End of the game, except when overlay strings follow that
6444 haven't been returned yet. */
6445 if (it
->overlay_strings_at_end_processed_p
)
6446 overlay_strings_follow_p
= 0;
6449 it
->overlay_strings_at_end_processed_p
= 1;
6450 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6453 if (overlay_strings_follow_p
)
6454 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6458 it
->position
= it
->current
.pos
;
6465 return GET_NEXT_DISPLAY_ELEMENT (it
);
6470 /* No face changes, overlays etc. in sight, so just return a
6471 character from current_buffer. */
6474 /* Maybe run the redisplay end trigger hook. Performance note:
6475 This doesn't seem to cost measurable time. */
6476 if (it
->redisplay_end_trigger_charpos
6478 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6479 run_redisplay_end_trigger_hook (it
);
6481 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
))
6482 && next_element_from_composition (it
))
6487 /* Get the next character, maybe multibyte. */
6488 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6489 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6490 it
->c
= STRING_CHAR_AND_LENGTH (p
, 0, it
->len
);
6492 it
->c
= *p
, it
->len
= 1;
6494 /* Record what we have and where it came from. */
6495 it
->what
= IT_CHARACTER
;
6496 it
->object
= it
->w
->buffer
;
6497 it
->position
= it
->current
.pos
;
6499 /* Normally we return the character found above, except when we
6500 really want to return an ellipsis for selective display. */
6505 /* A value of selective > 0 means hide lines indented more
6506 than that number of columns. */
6507 if (it
->selective
> 0
6508 && IT_CHARPOS (*it
) + 1 < ZV
6509 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6510 IT_BYTEPOS (*it
) + 1,
6511 (double) it
->selective
)) /* iftc */
6513 success_p
= next_element_from_ellipsis (it
);
6514 it
->dpvec_char_len
= -1;
6517 else if (it
->c
== '\r' && it
->selective
== -1)
6519 /* A value of selective == -1 means that everything from the
6520 CR to the end of the line is invisible, with maybe an
6521 ellipsis displayed for it. */
6522 success_p
= next_element_from_ellipsis (it
);
6523 it
->dpvec_char_len
= -1;
6528 /* Value is zero if end of buffer reached. */
6529 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6534 /* Run the redisplay end trigger hook for IT. */
6537 run_redisplay_end_trigger_hook (it
)
6540 Lisp_Object args
[3];
6542 /* IT->glyph_row should be non-null, i.e. we should be actually
6543 displaying something, or otherwise we should not run the hook. */
6544 xassert (it
->glyph_row
);
6546 /* Set up hook arguments. */
6547 args
[0] = Qredisplay_end_trigger_functions
;
6548 args
[1] = it
->window
;
6549 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6550 it
->redisplay_end_trigger_charpos
= 0;
6552 /* Since we are *trying* to run these functions, don't try to run
6553 them again, even if they get an error. */
6554 it
->w
->redisplay_end_trigger
= Qnil
;
6555 Frun_hook_with_args (3, args
);
6557 /* Notice if it changed the face of the character we are on. */
6558 handle_face_prop (it
);
6562 /* Deliver a composition display element. Unlike the other
6563 next_element_from_XXX, this function is not registered in the array
6564 get_next_element[]. It is called from next_element_from_buffer and
6565 next_element_from_string when necessary. */
6568 next_element_from_composition (it
)
6571 it
->what
= IT_COMPOSITION
;
6572 it
->len
= it
->cmp_it
.nbytes
;
6573 if (STRINGP (it
->string
))
6577 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6578 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6581 it
->position
= it
->current
.string_pos
;
6582 it
->object
= it
->string
;
6583 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6584 IT_STRING_BYTEPOS (*it
), it
->string
);
6590 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6591 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6594 it
->position
= it
->current
.pos
;
6595 it
->object
= it
->w
->buffer
;
6596 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6597 IT_BYTEPOS (*it
), Qnil
);
6604 /***********************************************************************
6605 Moving an iterator without producing glyphs
6606 ***********************************************************************/
6608 /* Check if iterator is at a position corresponding to a valid buffer
6609 position after some move_it_ call. */
6611 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6612 ((it)->method == GET_FROM_STRING \
6613 ? IT_STRING_CHARPOS (*it) == 0 \
6617 /* Move iterator IT to a specified buffer or X position within one
6618 line on the display without producing glyphs.
6620 OP should be a bit mask including some or all of these bits:
6621 MOVE_TO_X: Stop on reaching x-position TO_X.
6622 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6623 Regardless of OP's value, stop in reaching the end of the display line.
6625 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6626 This means, in particular, that TO_X includes window's horizontal
6629 The return value has several possible values that
6630 say what condition caused the scan to stop:
6632 MOVE_POS_MATCH_OR_ZV
6633 - when TO_POS or ZV was reached.
6636 -when TO_X was reached before TO_POS or ZV were reached.
6639 - when we reached the end of the display area and the line must
6643 - when we reached the end of the display area and the line is
6647 - when we stopped at a line end, i.e. a newline or a CR and selective
6650 static enum move_it_result
6651 move_it_in_display_line_to (struct it
*it
,
6652 EMACS_INT to_charpos
, int to_x
,
6653 enum move_operation_enum op
)
6655 enum move_it_result result
= MOVE_UNDEFINED
;
6656 struct glyph_row
*saved_glyph_row
;
6657 struct it wrap_it
, atpos_it
, atx_it
;
6660 /* Don't produce glyphs in produce_glyphs. */
6661 saved_glyph_row
= it
->glyph_row
;
6662 it
->glyph_row
= NULL
;
6664 /* Use wrap_it to save a copy of IT wherever a word wrap could
6665 occur. Use atpos_it to save a copy of IT at the desired buffer
6666 position, if found, so that we can scan ahead and check if the
6667 word later overshoots the window edge. Use atx_it similarly, for
6673 #define BUFFER_POS_REACHED_P() \
6674 ((op & MOVE_TO_POS) != 0 \
6675 && BUFFERP (it->object) \
6676 && IT_CHARPOS (*it) >= to_charpos \
6677 && (it->method == GET_FROM_BUFFER \
6678 || (it->method == GET_FROM_DISPLAY_VECTOR \
6679 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6681 /* If there's a line-/wrap-prefix, handle it. */
6682 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6683 && it
->current_y
< it
->last_visible_y
)
6684 handle_line_prefix (it
);
6688 int x
, i
, ascent
= 0, descent
= 0;
6690 /* Utility macro to reset an iterator with x, ascent, and descent. */
6691 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6692 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6693 (IT)->max_descent = descent)
6695 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6697 if ((op
& MOVE_TO_POS
) != 0
6698 && BUFFERP (it
->object
)
6699 && it
->method
== GET_FROM_BUFFER
6700 && IT_CHARPOS (*it
) > to_charpos
)
6702 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6704 result
= MOVE_POS_MATCH_OR_ZV
;
6707 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6708 /* If wrap_it is valid, the current position might be in a
6709 word that is wrapped. So, save the iterator in
6710 atpos_it and continue to see if wrapping happens. */
6714 /* Stop when ZV reached.
6715 We used to stop here when TO_CHARPOS reached as well, but that is
6716 too soon if this glyph does not fit on this line. So we handle it
6717 explicitly below. */
6718 if (!get_next_display_element (it
))
6720 result
= MOVE_POS_MATCH_OR_ZV
;
6724 if (it
->line_wrap
== TRUNCATE
)
6726 if (BUFFER_POS_REACHED_P ())
6728 result
= MOVE_POS_MATCH_OR_ZV
;
6734 if (it
->line_wrap
== WORD_WRAP
)
6736 if (IT_DISPLAYING_WHITESPACE (it
))
6740 /* We have reached a glyph that follows one or more
6741 whitespace characters. If the position is
6742 already found, we are done. */
6743 if (atpos_it
.sp
>= 0)
6746 result
= MOVE_POS_MATCH_OR_ZV
;
6752 result
= MOVE_X_REACHED
;
6755 /* Otherwise, we can wrap here. */
6762 /* Remember the line height for the current line, in case
6763 the next element doesn't fit on the line. */
6764 ascent
= it
->max_ascent
;
6765 descent
= it
->max_descent
;
6767 /* The call to produce_glyphs will get the metrics of the
6768 display element IT is loaded with. Record the x-position
6769 before this display element, in case it doesn't fit on the
6773 PRODUCE_GLYPHS (it
);
6775 if (it
->area
!= TEXT_AREA
)
6777 set_iterator_to_next (it
, 1);
6781 /* The number of glyphs we get back in IT->nglyphs will normally
6782 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6783 character on a terminal frame, or (iii) a line end. For the
6784 second case, IT->nglyphs - 1 padding glyphs will be present
6785 (on X frames, there is only one glyph produced for a
6786 composite character.
6788 The behavior implemented below means, for continuation lines,
6789 that as many spaces of a TAB as fit on the current line are
6790 displayed there. For terminal frames, as many glyphs of a
6791 multi-glyph character are displayed in the current line, too.
6792 This is what the old redisplay code did, and we keep it that
6793 way. Under X, the whole shape of a complex character must
6794 fit on the line or it will be completely displayed in the
6797 Note that both for tabs and padding glyphs, all glyphs have
6801 /* More than one glyph or glyph doesn't fit on line. All
6802 glyphs have the same width. */
6803 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6805 int x_before_this_char
= x
;
6806 int hpos_before_this_char
= it
->hpos
;
6808 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6810 new_x
= x
+ single_glyph_width
;
6812 /* We want to leave anything reaching TO_X to the caller. */
6813 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6815 if (BUFFER_POS_REACHED_P ())
6817 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6818 goto buffer_pos_reached
;
6819 if (atpos_it
.sp
< 0)
6822 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6827 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6830 result
= MOVE_X_REACHED
;
6836 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
6841 if (/* Lines are continued. */
6842 it
->line_wrap
!= TRUNCATE
6843 && (/* And glyph doesn't fit on the line. */
6844 new_x
> it
->last_visible_x
6845 /* Or it fits exactly and we're on a window
6847 || (new_x
== it
->last_visible_x
6848 && FRAME_WINDOW_P (it
->f
))))
6850 if (/* IT->hpos == 0 means the very first glyph
6851 doesn't fit on the line, e.g. a wide image. */
6853 || (new_x
== it
->last_visible_x
6854 && FRAME_WINDOW_P (it
->f
)))
6857 it
->current_x
= new_x
;
6859 /* The character's last glyph just barely fits
6861 if (i
== it
->nglyphs
- 1)
6863 /* If this is the destination position,
6864 return a position *before* it in this row,
6865 now that we know it fits in this row. */
6866 if (BUFFER_POS_REACHED_P ())
6868 if (it
->line_wrap
!= WORD_WRAP
6871 it
->hpos
= hpos_before_this_char
;
6872 it
->current_x
= x_before_this_char
;
6873 result
= MOVE_POS_MATCH_OR_ZV
;
6876 if (it
->line_wrap
== WORD_WRAP
6880 atpos_it
.current_x
= x_before_this_char
;
6881 atpos_it
.hpos
= hpos_before_this_char
;
6885 set_iterator_to_next (it
, 1);
6886 #ifdef HAVE_WINDOW_SYSTEM
6887 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6889 if (!get_next_display_element (it
))
6891 result
= MOVE_POS_MATCH_OR_ZV
;
6894 if (BUFFER_POS_REACHED_P ())
6896 if (ITERATOR_AT_END_OF_LINE_P (it
))
6897 result
= MOVE_POS_MATCH_OR_ZV
;
6899 result
= MOVE_LINE_CONTINUED
;
6902 if (ITERATOR_AT_END_OF_LINE_P (it
))
6904 result
= MOVE_NEWLINE_OR_CR
;
6908 #endif /* HAVE_WINDOW_SYSTEM */
6912 IT_RESET_X_ASCENT_DESCENT (it
);
6914 if (wrap_it
.sp
>= 0)
6921 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6923 result
= MOVE_LINE_CONTINUED
;
6927 if (BUFFER_POS_REACHED_P ())
6929 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6930 goto buffer_pos_reached
;
6931 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6934 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6938 if (new_x
> it
->first_visible_x
)
6940 /* Glyph is visible. Increment number of glyphs that
6941 would be displayed. */
6946 if (result
!= MOVE_UNDEFINED
)
6949 else if (BUFFER_POS_REACHED_P ())
6952 IT_RESET_X_ASCENT_DESCENT (it
);
6953 result
= MOVE_POS_MATCH_OR_ZV
;
6956 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
6958 /* Stop when TO_X specified and reached. This check is
6959 necessary here because of lines consisting of a line end,
6960 only. The line end will not produce any glyphs and we
6961 would never get MOVE_X_REACHED. */
6962 xassert (it
->nglyphs
== 0);
6963 result
= MOVE_X_REACHED
;
6967 /* Is this a line end? If yes, we're done. */
6968 if (ITERATOR_AT_END_OF_LINE_P (it
))
6970 result
= MOVE_NEWLINE_OR_CR
;
6974 /* The current display element has been consumed. Advance
6976 set_iterator_to_next (it
, 1);
6978 /* Stop if lines are truncated and IT's current x-position is
6979 past the right edge of the window now. */
6980 if (it
->line_wrap
== TRUNCATE
6981 && it
->current_x
>= it
->last_visible_x
)
6983 #ifdef HAVE_WINDOW_SYSTEM
6984 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6986 if (!get_next_display_element (it
)
6987 || BUFFER_POS_REACHED_P ())
6989 result
= MOVE_POS_MATCH_OR_ZV
;
6992 if (ITERATOR_AT_END_OF_LINE_P (it
))
6994 result
= MOVE_NEWLINE_OR_CR
;
6998 #endif /* HAVE_WINDOW_SYSTEM */
6999 result
= MOVE_LINE_TRUNCATED
;
7002 #undef IT_RESET_X_ASCENT_DESCENT
7005 #undef BUFFER_POS_REACHED_P
7007 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7008 restore the saved iterator. */
7009 if (atpos_it
.sp
>= 0)
7011 else if (atx_it
.sp
>= 0)
7016 /* Restore the iterator settings altered at the beginning of this
7018 it
->glyph_row
= saved_glyph_row
;
7022 /* For external use. */
7024 move_it_in_display_line (struct it
*it
,
7025 EMACS_INT to_charpos
, int to_x
,
7026 enum move_operation_enum op
)
7028 if (it
->line_wrap
== WORD_WRAP
7029 && (op
& MOVE_TO_X
))
7031 struct it save_it
= *it
;
7032 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7033 /* When word-wrap is on, TO_X may lie past the end
7034 of a wrapped line. Then it->current is the
7035 character on the next line, so backtrack to the
7036 space before the wrap point. */
7037 if (skip
== MOVE_LINE_CONTINUED
)
7039 int prev_x
= max (it
->current_x
- 1, 0);
7041 move_it_in_display_line_to
7042 (it
, -1, prev_x
, MOVE_TO_X
);
7046 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7050 /* Move IT forward until it satisfies one or more of the criteria in
7051 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7053 OP is a bit-mask that specifies where to stop, and in particular,
7054 which of those four position arguments makes a difference. See the
7055 description of enum move_operation_enum.
7057 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7058 screen line, this function will set IT to the next position >
7062 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7064 int to_charpos
, to_x
, to_y
, to_vpos
;
7067 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7073 if (op
& MOVE_TO_VPOS
)
7075 /* If no TO_CHARPOS and no TO_X specified, stop at the
7076 start of the line TO_VPOS. */
7077 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7079 if (it
->vpos
== to_vpos
)
7085 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7089 /* TO_VPOS >= 0 means stop at TO_X in the line at
7090 TO_VPOS, or at TO_POS, whichever comes first. */
7091 if (it
->vpos
== to_vpos
)
7097 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7099 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7104 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7106 /* We have reached TO_X but not in the line we want. */
7107 skip
= move_it_in_display_line_to (it
, to_charpos
,
7109 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7117 else if (op
& MOVE_TO_Y
)
7119 struct it it_backup
;
7121 if (it
->line_wrap
== WORD_WRAP
)
7124 /* TO_Y specified means stop at TO_X in the line containing
7125 TO_Y---or at TO_CHARPOS if this is reached first. The
7126 problem is that we can't really tell whether the line
7127 contains TO_Y before we have completely scanned it, and
7128 this may skip past TO_X. What we do is to first scan to
7131 If TO_X is not specified, use a TO_X of zero. The reason
7132 is to make the outcome of this function more predictable.
7133 If we didn't use TO_X == 0, we would stop at the end of
7134 the line which is probably not what a caller would expect
7136 skip
= move_it_in_display_line_to
7137 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7138 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7140 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7141 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7143 else if (skip
== MOVE_X_REACHED
)
7145 /* If TO_X was reached, we want to know whether TO_Y is
7146 in the line. We know this is the case if the already
7147 scanned glyphs make the line tall enough. Otherwise,
7148 we must check by scanning the rest of the line. */
7149 line_height
= it
->max_ascent
+ it
->max_descent
;
7150 if (to_y
>= it
->current_y
7151 && to_y
< it
->current_y
+ line_height
)
7157 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7158 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7160 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7161 line_height
= it
->max_ascent
+ it
->max_descent
;
7162 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7164 if (to_y
>= it
->current_y
7165 && to_y
< it
->current_y
+ line_height
)
7167 /* If TO_Y is in this line and TO_X was reached
7168 above, we scanned too far. We have to restore
7169 IT's settings to the ones before skipping. */
7176 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7182 /* Check whether TO_Y is in this line. */
7183 line_height
= it
->max_ascent
+ it
->max_descent
;
7184 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7186 if (to_y
>= it
->current_y
7187 && to_y
< it
->current_y
+ line_height
)
7189 /* When word-wrap is on, TO_X may lie past the end
7190 of a wrapped line. Then it->current is the
7191 character on the next line, so backtrack to the
7192 space before the wrap point. */
7193 if (skip
== MOVE_LINE_CONTINUED
7194 && it
->line_wrap
== WORD_WRAP
)
7196 int prev_x
= max (it
->current_x
- 1, 0);
7198 skip
= move_it_in_display_line_to
7199 (it
, -1, prev_x
, MOVE_TO_X
);
7208 else if (BUFFERP (it
->object
)
7209 && (it
->method
== GET_FROM_BUFFER
7210 || it
->method
== GET_FROM_STRETCH
)
7211 && IT_CHARPOS (*it
) >= to_charpos
)
7212 skip
= MOVE_POS_MATCH_OR_ZV
;
7214 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7218 case MOVE_POS_MATCH_OR_ZV
:
7222 case MOVE_NEWLINE_OR_CR
:
7223 set_iterator_to_next (it
, 1);
7224 it
->continuation_lines_width
= 0;
7227 case MOVE_LINE_TRUNCATED
:
7228 it
->continuation_lines_width
= 0;
7229 reseat_at_next_visible_line_start (it
, 0);
7230 if ((op
& MOVE_TO_POS
) != 0
7231 && IT_CHARPOS (*it
) > to_charpos
)
7238 case MOVE_LINE_CONTINUED
:
7239 /* For continued lines ending in a tab, some of the glyphs
7240 associated with the tab are displayed on the current
7241 line. Since it->current_x does not include these glyphs,
7242 we use it->last_visible_x instead. */
7245 it
->continuation_lines_width
+= it
->last_visible_x
;
7246 /* When moving by vpos, ensure that the iterator really
7247 advances to the next line (bug#847, bug#969). Fixme:
7248 do we need to do this in other circumstances? */
7249 if (it
->current_x
!= it
->last_visible_x
7250 && (op
& MOVE_TO_VPOS
)
7251 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7252 set_iterator_to_next (it
, 0);
7255 it
->continuation_lines_width
+= it
->current_x
;
7262 /* Reset/increment for the next run. */
7263 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7264 it
->current_x
= it
->hpos
= 0;
7265 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7267 last_height
= it
->max_ascent
+ it
->max_descent
;
7268 last_max_ascent
= it
->max_ascent
;
7269 it
->max_ascent
= it
->max_descent
= 0;
7274 /* On text terminals, we may stop at the end of a line in the middle
7275 of a multi-character glyph. If the glyph itself is continued,
7276 i.e. it is actually displayed on the next line, don't treat this
7277 stopping point as valid; move to the next line instead (unless
7278 that brings us offscreen). */
7279 if (!FRAME_WINDOW_P (it
->f
)
7281 && IT_CHARPOS (*it
) == to_charpos
7282 && it
->what
== IT_CHARACTER
7284 && it
->line_wrap
== WINDOW_WRAP
7285 && it
->current_x
== it
->last_visible_x
- 1
7288 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7290 it
->continuation_lines_width
+= it
->current_x
;
7291 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7292 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7294 last_height
= it
->max_ascent
+ it
->max_descent
;
7295 last_max_ascent
= it
->max_ascent
;
7298 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7302 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7304 If DY > 0, move IT backward at least that many pixels. DY = 0
7305 means move IT backward to the preceding line start or BEGV. This
7306 function may move over more than DY pixels if IT->current_y - DY
7307 ends up in the middle of a line; in this case IT->current_y will be
7308 set to the top of the line moved to. */
7311 move_it_vertically_backward (it
, dy
)
7322 start_pos
= IT_CHARPOS (*it
);
7324 /* Estimate how many newlines we must move back. */
7325 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7327 /* Set the iterator's position that many lines back. */
7328 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7329 back_to_previous_visible_line_start (it
);
7331 /* Reseat the iterator here. When moving backward, we don't want
7332 reseat to skip forward over invisible text, set up the iterator
7333 to deliver from overlay strings at the new position etc. So,
7334 use reseat_1 here. */
7335 reseat_1 (it
, it
->current
.pos
, 1);
7337 /* We are now surely at a line start. */
7338 it
->current_x
= it
->hpos
= 0;
7339 it
->continuation_lines_width
= 0;
7341 /* Move forward and see what y-distance we moved. First move to the
7342 start of the next line so that we get its height. We need this
7343 height to be able to tell whether we reached the specified
7346 it2
.max_ascent
= it2
.max_descent
= 0;
7349 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7350 MOVE_TO_POS
| MOVE_TO_VPOS
);
7352 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7353 xassert (IT_CHARPOS (*it
) >= BEGV
);
7356 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7357 xassert (IT_CHARPOS (*it
) >= BEGV
);
7358 /* H is the actual vertical distance from the position in *IT
7359 and the starting position. */
7360 h
= it2
.current_y
- it
->current_y
;
7361 /* NLINES is the distance in number of lines. */
7362 nlines
= it2
.vpos
- it
->vpos
;
7364 /* Correct IT's y and vpos position
7365 so that they are relative to the starting point. */
7371 /* DY == 0 means move to the start of the screen line. The
7372 value of nlines is > 0 if continuation lines were involved. */
7374 move_it_by_lines (it
, nlines
, 1);
7376 /* I think this assert is bogus if buffer contains
7377 invisible text or images. KFS. */
7378 xassert (IT_CHARPOS (*it
) <= start_pos
);
7383 /* The y-position we try to reach, relative to *IT.
7384 Note that H has been subtracted in front of the if-statement. */
7385 int target_y
= it
->current_y
+ h
- dy
;
7386 int y0
= it3
.current_y
;
7387 int y1
= line_bottom_y (&it3
);
7388 int line_height
= y1
- y0
;
7390 /* If we did not reach target_y, try to move further backward if
7391 we can. If we moved too far backward, try to move forward. */
7392 if (target_y
< it
->current_y
7393 /* This is heuristic. In a window that's 3 lines high, with
7394 a line height of 13 pixels each, recentering with point
7395 on the bottom line will try to move -39/2 = 19 pixels
7396 backward. Try to avoid moving into the first line. */
7397 && (it
->current_y
- target_y
7398 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7399 && IT_CHARPOS (*it
) > BEGV
)
7401 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7402 target_y
- it
->current_y
));
7403 dy
= it
->current_y
- target_y
;
7404 goto move_further_back
;
7406 else if (target_y
>= it
->current_y
+ line_height
7407 && IT_CHARPOS (*it
) < ZV
)
7409 /* Should move forward by at least one line, maybe more.
7411 Note: Calling move_it_by_lines can be expensive on
7412 terminal frames, where compute_motion is used (via
7413 vmotion) to do the job, when there are very long lines
7414 and truncate-lines is nil. That's the reason for
7415 treating terminal frames specially here. */
7417 if (!FRAME_WINDOW_P (it
->f
))
7418 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7423 move_it_by_lines (it
, 1, 1);
7425 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7429 /* I think this assert is bogus if buffer contains
7430 invisible text or images. KFS. */
7431 xassert (IT_CHARPOS (*it
) >= BEGV
);
7438 /* Move IT by a specified amount of pixel lines DY. DY negative means
7439 move backwards. DY = 0 means move to start of screen line. At the
7440 end, IT will be on the start of a screen line. */
7443 move_it_vertically (it
, dy
)
7448 move_it_vertically_backward (it
, -dy
);
7451 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7452 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7453 MOVE_TO_POS
| MOVE_TO_Y
);
7454 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7456 /* If buffer ends in ZV without a newline, move to the start of
7457 the line to satisfy the post-condition. */
7458 if (IT_CHARPOS (*it
) == ZV
7460 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7461 move_it_by_lines (it
, 0, 0);
7466 /* Move iterator IT past the end of the text line it is in. */
7469 move_it_past_eol (it
)
7472 enum move_it_result rc
;
7474 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7475 if (rc
== MOVE_NEWLINE_OR_CR
)
7476 set_iterator_to_next (it
, 0);
7480 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7481 negative means move up. DVPOS == 0 means move to the start of the
7482 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7483 NEED_Y_P is zero, IT->current_y will be left unchanged.
7485 Further optimization ideas: If we would know that IT->f doesn't use
7486 a face with proportional font, we could be faster for
7487 truncate-lines nil. */
7490 move_it_by_lines (it
, dvpos
, need_y_p
)
7492 int dvpos
, need_y_p
;
7494 struct position pos
;
7496 /* The commented-out optimization uses vmotion on terminals. This
7497 gives bad results, because elements like it->what, on which
7498 callers such as pos_visible_p rely, aren't updated. */
7499 /* if (!FRAME_WINDOW_P (it->f))
7501 struct text_pos textpos;
7503 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7504 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7505 reseat (it, textpos, 1);
7506 it->vpos += pos.vpos;
7507 it->current_y += pos.vpos;
7513 /* DVPOS == 0 means move to the start of the screen line. */
7514 move_it_vertically_backward (it
, 0);
7515 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7516 /* Let next call to line_bottom_y calculate real line height */
7521 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7522 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7523 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7528 int start_charpos
, i
;
7530 /* Start at the beginning of the screen line containing IT's
7531 position. This may actually move vertically backwards,
7532 in case of overlays, so adjust dvpos accordingly. */
7534 move_it_vertically_backward (it
, 0);
7537 /* Go back -DVPOS visible lines and reseat the iterator there. */
7538 start_charpos
= IT_CHARPOS (*it
);
7539 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7540 back_to_previous_visible_line_start (it
);
7541 reseat (it
, it
->current
.pos
, 1);
7543 /* Move further back if we end up in a string or an image. */
7544 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7546 /* First try to move to start of display line. */
7548 move_it_vertically_backward (it
, 0);
7550 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7552 /* If start of line is still in string or image,
7553 move further back. */
7554 back_to_previous_visible_line_start (it
);
7555 reseat (it
, it
->current
.pos
, 1);
7559 it
->current_x
= it
->hpos
= 0;
7561 /* Above call may have moved too far if continuation lines
7562 are involved. Scan forward and see if it did. */
7564 it2
.vpos
= it2
.current_y
= 0;
7565 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7566 it
->vpos
-= it2
.vpos
;
7567 it
->current_y
-= it2
.current_y
;
7568 it
->current_x
= it
->hpos
= 0;
7570 /* If we moved too far back, move IT some lines forward. */
7571 if (it2
.vpos
> -dvpos
)
7573 int delta
= it2
.vpos
+ dvpos
;
7575 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7576 /* Move back again if we got too far ahead. */
7577 if (IT_CHARPOS (*it
) >= start_charpos
)
7583 /* Return 1 if IT points into the middle of a display vector. */
7586 in_display_vector_p (it
)
7589 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7590 && it
->current
.dpvec_index
> 0
7591 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7595 /***********************************************************************
7597 ***********************************************************************/
7600 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7604 add_to_log (format
, arg1
, arg2
)
7606 Lisp_Object arg1
, arg2
;
7608 Lisp_Object args
[3];
7609 Lisp_Object msg
, fmt
;
7612 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7615 /* Do nothing if called asynchronously. Inserting text into
7616 a buffer may call after-change-functions and alike and
7617 that would means running Lisp asynchronously. */
7618 if (handling_signal
)
7622 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7624 args
[0] = fmt
= build_string (format
);
7627 msg
= Fformat (3, args
);
7629 len
= SBYTES (msg
) + 1;
7630 SAFE_ALLOCA (buffer
, char *, len
);
7631 bcopy (SDATA (msg
), buffer
, len
);
7633 message_dolog (buffer
, len
- 1, 1, 0);
7640 /* Output a newline in the *Messages* buffer if "needs" one. */
7643 message_log_maybe_newline ()
7645 if (message_log_need_newline
)
7646 message_dolog ("", 0, 1, 0);
7650 /* Add a string M of length NBYTES to the message log, optionally
7651 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7652 nonzero, means interpret the contents of M as multibyte. This
7653 function calls low-level routines in order to bypass text property
7654 hooks, etc. which might not be safe to run.
7656 This may GC (insert may run before/after change hooks),
7657 so the buffer M must NOT point to a Lisp string. */
7660 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7662 int nbytes
, nlflag
, multibyte
;
7664 if (!NILP (Vmemory_full
))
7667 if (!NILP (Vmessage_log_max
))
7669 struct buffer
*oldbuf
;
7670 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7671 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7672 int point_at_end
= 0;
7674 Lisp_Object old_deactivate_mark
, tem
;
7675 struct gcpro gcpro1
;
7677 old_deactivate_mark
= Vdeactivate_mark
;
7678 oldbuf
= current_buffer
;
7679 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7680 current_buffer
->undo_list
= Qt
;
7682 oldpoint
= message_dolog_marker1
;
7683 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7684 oldbegv
= message_dolog_marker2
;
7685 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7686 oldzv
= message_dolog_marker3
;
7687 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7688 GCPRO1 (old_deactivate_mark
);
7696 BEGV_BYTE
= BEG_BYTE
;
7699 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7701 /* Insert the string--maybe converting multibyte to single byte
7702 or vice versa, so that all the text fits the buffer. */
7704 && NILP (current_buffer
->enable_multibyte_characters
))
7706 int i
, c
, char_bytes
;
7707 unsigned char work
[1];
7709 /* Convert a multibyte string to single-byte
7710 for the *Message* buffer. */
7711 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7713 c
= string_char_and_length (m
+ i
, nbytes
- i
, &char_bytes
);
7714 work
[0] = (ASCII_CHAR_P (c
)
7716 : multibyte_char_to_unibyte (c
, Qnil
));
7717 insert_1_both (work
, 1, 1, 1, 0, 0);
7720 else if (! multibyte
7721 && ! NILP (current_buffer
->enable_multibyte_characters
))
7723 int i
, c
, char_bytes
;
7724 unsigned char *msg
= (unsigned char *) m
;
7725 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7726 /* Convert a single-byte string to multibyte
7727 for the *Message* buffer. */
7728 for (i
= 0; i
< nbytes
; i
++)
7731 c
= unibyte_char_to_multibyte (c
);
7732 char_bytes
= CHAR_STRING (c
, str
);
7733 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7737 insert_1 (m
, nbytes
, 1, 0, 0);
7741 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7742 insert_1 ("\n", 1, 1, 0, 0);
7744 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7746 this_bol_byte
= PT_BYTE
;
7748 /* See if this line duplicates the previous one.
7749 If so, combine duplicates. */
7752 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7754 prev_bol_byte
= PT_BYTE
;
7756 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7757 this_bol
, this_bol_byte
);
7760 del_range_both (prev_bol
, prev_bol_byte
,
7761 this_bol
, this_bol_byte
, 0);
7767 /* If you change this format, don't forget to also
7768 change message_log_check_duplicate. */
7769 sprintf (dupstr
, " [%d times]", dup
);
7770 duplen
= strlen (dupstr
);
7771 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7772 insert_1 (dupstr
, duplen
, 1, 0, 1);
7777 /* If we have more than the desired maximum number of lines
7778 in the *Messages* buffer now, delete the oldest ones.
7779 This is safe because we don't have undo in this buffer. */
7781 if (NATNUMP (Vmessage_log_max
))
7783 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7784 -XFASTINT (Vmessage_log_max
) - 1, 0);
7785 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7788 BEGV
= XMARKER (oldbegv
)->charpos
;
7789 BEGV_BYTE
= marker_byte_position (oldbegv
);
7798 ZV
= XMARKER (oldzv
)->charpos
;
7799 ZV_BYTE
= marker_byte_position (oldzv
);
7803 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7805 /* We can't do Fgoto_char (oldpoint) because it will run some
7807 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7808 XMARKER (oldpoint
)->bytepos
);
7811 unchain_marker (XMARKER (oldpoint
));
7812 unchain_marker (XMARKER (oldbegv
));
7813 unchain_marker (XMARKER (oldzv
));
7815 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7816 set_buffer_internal (oldbuf
);
7818 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7819 message_log_need_newline
= !nlflag
;
7820 Vdeactivate_mark
= old_deactivate_mark
;
7825 /* We are at the end of the buffer after just having inserted a newline.
7826 (Note: We depend on the fact we won't be crossing the gap.)
7827 Check to see if the most recent message looks a lot like the previous one.
7828 Return 0 if different, 1 if the new one should just replace it, or a
7829 value N > 1 if we should also append " [N times]". */
7832 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7833 int prev_bol
, this_bol
;
7834 int prev_bol_byte
, this_bol_byte
;
7837 int len
= Z_BYTE
- 1 - this_bol_byte
;
7839 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7840 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7842 for (i
= 0; i
< len
; i
++)
7844 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7852 if (*p1
++ == ' ' && *p1
++ == '[')
7855 while (*p1
>= '0' && *p1
<= '9')
7856 n
= n
* 10 + *p1
++ - '0';
7857 if (strncmp (p1
, " times]\n", 8) == 0)
7864 /* Display an echo area message M with a specified length of NBYTES
7865 bytes. The string may include null characters. If M is 0, clear
7866 out any existing message, and let the mini-buffer text show
7869 This may GC, so the buffer M must NOT point to a Lisp string. */
7872 message2 (m
, nbytes
, multibyte
)
7877 /* First flush out any partial line written with print. */
7878 message_log_maybe_newline ();
7880 message_dolog (m
, nbytes
, 1, multibyte
);
7881 message2_nolog (m
, nbytes
, multibyte
);
7885 /* The non-logging counterpart of message2. */
7888 message2_nolog (m
, nbytes
, multibyte
)
7890 int nbytes
, multibyte
;
7892 struct frame
*sf
= SELECTED_FRAME ();
7893 message_enable_multibyte
= multibyte
;
7895 if (FRAME_INITIAL_P (sf
))
7897 if (noninteractive_need_newline
)
7898 putc ('\n', stderr
);
7899 noninteractive_need_newline
= 0;
7901 fwrite (m
, nbytes
, 1, stderr
);
7902 if (cursor_in_echo_area
== 0)
7903 fprintf (stderr
, "\n");
7906 /* A null message buffer means that the frame hasn't really been
7907 initialized yet. Error messages get reported properly by
7908 cmd_error, so this must be just an informative message; toss it. */
7909 else if (INTERACTIVE
7910 && sf
->glyphs_initialized_p
7911 && FRAME_MESSAGE_BUF (sf
))
7913 Lisp_Object mini_window
;
7916 /* Get the frame containing the mini-buffer
7917 that the selected frame is using. */
7918 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7919 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7921 FRAME_SAMPLE_VISIBILITY (f
);
7922 if (FRAME_VISIBLE_P (sf
)
7923 && ! FRAME_VISIBLE_P (f
))
7924 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7928 set_message (m
, Qnil
, nbytes
, multibyte
);
7929 if (minibuffer_auto_raise
)
7930 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7933 clear_message (1, 1);
7935 do_pending_window_change (0);
7936 echo_area_display (1);
7937 do_pending_window_change (0);
7938 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7939 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7944 /* Display an echo area message M with a specified length of NBYTES
7945 bytes. The string may include null characters. If M is not a
7946 string, clear out any existing message, and let the mini-buffer
7949 This function cancels echoing. */
7952 message3 (m
, nbytes
, multibyte
)
7957 struct gcpro gcpro1
;
7960 clear_message (1,1);
7963 /* First flush out any partial line written with print. */
7964 message_log_maybe_newline ();
7970 SAFE_ALLOCA (buffer
, char *, nbytes
);
7971 bcopy (SDATA (m
), buffer
, nbytes
);
7972 message_dolog (buffer
, nbytes
, 1, multibyte
);
7975 message3_nolog (m
, nbytes
, multibyte
);
7981 /* The non-logging version of message3.
7982 This does not cancel echoing, because it is used for echoing.
7983 Perhaps we need to make a separate function for echoing
7984 and make this cancel echoing. */
7987 message3_nolog (m
, nbytes
, multibyte
)
7989 int nbytes
, multibyte
;
7991 struct frame
*sf
= SELECTED_FRAME ();
7992 message_enable_multibyte
= multibyte
;
7994 if (FRAME_INITIAL_P (sf
))
7996 if (noninteractive_need_newline
)
7997 putc ('\n', stderr
);
7998 noninteractive_need_newline
= 0;
8000 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8001 if (cursor_in_echo_area
== 0)
8002 fprintf (stderr
, "\n");
8005 /* A null message buffer means that the frame hasn't really been
8006 initialized yet. Error messages get reported properly by
8007 cmd_error, so this must be just an informative message; toss it. */
8008 else if (INTERACTIVE
8009 && sf
->glyphs_initialized_p
8010 && FRAME_MESSAGE_BUF (sf
))
8012 Lisp_Object mini_window
;
8016 /* Get the frame containing the mini-buffer
8017 that the selected frame is using. */
8018 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8019 frame
= XWINDOW (mini_window
)->frame
;
8022 FRAME_SAMPLE_VISIBILITY (f
);
8023 if (FRAME_VISIBLE_P (sf
)
8024 && !FRAME_VISIBLE_P (f
))
8025 Fmake_frame_visible (frame
);
8027 if (STRINGP (m
) && SCHARS (m
) > 0)
8029 set_message (NULL
, m
, nbytes
, multibyte
);
8030 if (minibuffer_auto_raise
)
8031 Fraise_frame (frame
);
8032 /* Assume we are not echoing.
8033 (If we are, echo_now will override this.) */
8034 echo_message_buffer
= Qnil
;
8037 clear_message (1, 1);
8039 do_pending_window_change (0);
8040 echo_area_display (1);
8041 do_pending_window_change (0);
8042 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8043 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8048 /* Display a null-terminated echo area message M. If M is 0, clear
8049 out any existing message, and let the mini-buffer text show through.
8051 The buffer M must continue to exist until after the echo area gets
8052 cleared or some other message gets displayed there. Do not pass
8053 text that is stored in a Lisp string. Do not pass text in a buffer
8054 that was alloca'd. */
8060 message2 (m
, (m
? strlen (m
) : 0), 0);
8064 /* The non-logging counterpart of message1. */
8070 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8073 /* Display a message M which contains a single %s
8074 which gets replaced with STRING. */
8077 message_with_string (m
, string
, log
)
8082 CHECK_STRING (string
);
8088 if (noninteractive_need_newline
)
8089 putc ('\n', stderr
);
8090 noninteractive_need_newline
= 0;
8091 fprintf (stderr
, m
, SDATA (string
));
8092 if (!cursor_in_echo_area
)
8093 fprintf (stderr
, "\n");
8097 else if (INTERACTIVE
)
8099 /* The frame whose minibuffer we're going to display the message on.
8100 It may be larger than the selected frame, so we need
8101 to use its buffer, not the selected frame's buffer. */
8102 Lisp_Object mini_window
;
8103 struct frame
*f
, *sf
= SELECTED_FRAME ();
8105 /* Get the frame containing the minibuffer
8106 that the selected frame is using. */
8107 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8108 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8110 /* A null message buffer means that the frame hasn't really been
8111 initialized yet. Error messages get reported properly by
8112 cmd_error, so this must be just an informative message; toss it. */
8113 if (FRAME_MESSAGE_BUF (f
))
8115 Lisp_Object args
[2], message
;
8116 struct gcpro gcpro1
, gcpro2
;
8118 args
[0] = build_string (m
);
8119 args
[1] = message
= string
;
8120 GCPRO2 (args
[0], message
);
8123 message
= Fformat (2, args
);
8126 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8128 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8132 /* Print should start at the beginning of the message
8133 buffer next time. */
8134 message_buf_print
= 0;
8140 /* Dump an informative message to the minibuf. If M is 0, clear out
8141 any existing message, and let the mini-buffer text show through. */
8145 message (m
, a1
, a2
, a3
)
8147 EMACS_INT a1
, a2
, a3
;
8153 if (noninteractive_need_newline
)
8154 putc ('\n', stderr
);
8155 noninteractive_need_newline
= 0;
8156 fprintf (stderr
, m
, a1
, a2
, a3
);
8157 if (cursor_in_echo_area
== 0)
8158 fprintf (stderr
, "\n");
8162 else if (INTERACTIVE
)
8164 /* The frame whose mini-buffer we're going to display the message
8165 on. It may be larger than the selected frame, so we need to
8166 use its buffer, not the selected frame's buffer. */
8167 Lisp_Object mini_window
;
8168 struct frame
*f
, *sf
= SELECTED_FRAME ();
8170 /* Get the frame containing the mini-buffer
8171 that the selected frame is using. */
8172 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8173 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8175 /* A null message buffer means that the frame hasn't really been
8176 initialized yet. Error messages get reported properly by
8177 cmd_error, so this must be just an informative message; toss
8179 if (FRAME_MESSAGE_BUF (f
))
8190 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8191 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8193 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8194 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8196 #endif /* NO_ARG_ARRAY */
8198 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8203 /* Print should start at the beginning of the message
8204 buffer next time. */
8205 message_buf_print
= 0;
8211 /* The non-logging version of message. */
8214 message_nolog (m
, a1
, a2
, a3
)
8216 EMACS_INT a1
, a2
, a3
;
8218 Lisp_Object old_log_max
;
8219 old_log_max
= Vmessage_log_max
;
8220 Vmessage_log_max
= Qnil
;
8221 message (m
, a1
, a2
, a3
);
8222 Vmessage_log_max
= old_log_max
;
8226 /* Display the current message in the current mini-buffer. This is
8227 only called from error handlers in process.c, and is not time
8233 if (!NILP (echo_area_buffer
[0]))
8236 string
= Fcurrent_message ();
8237 message3 (string
, SBYTES (string
),
8238 !NILP (current_buffer
->enable_multibyte_characters
));
8243 /* Make sure echo area buffers in `echo_buffers' are live.
8244 If they aren't, make new ones. */
8247 ensure_echo_area_buffers ()
8251 for (i
= 0; i
< 2; ++i
)
8252 if (!BUFFERP (echo_buffer
[i
])
8253 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8256 Lisp_Object old_buffer
;
8259 old_buffer
= echo_buffer
[i
];
8260 sprintf (name
, " *Echo Area %d*", i
);
8261 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8262 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8263 /* to force word wrap in echo area -
8264 it was decided to postpone this*/
8265 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8267 for (j
= 0; j
< 2; ++j
)
8268 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8269 echo_area_buffer
[j
] = echo_buffer
[i
];
8274 /* Call FN with args A1..A4 with either the current or last displayed
8275 echo_area_buffer as current buffer.
8277 WHICH zero means use the current message buffer
8278 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8279 from echo_buffer[] and clear it.
8281 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8282 suitable buffer from echo_buffer[] and clear it.
8284 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8285 that the current message becomes the last displayed one, make
8286 choose a suitable buffer for echo_area_buffer[0], and clear it.
8288 Value is what FN returns. */
8291 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8294 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8300 int this_one
, the_other
, clear_buffer_p
, rc
;
8301 int count
= SPECPDL_INDEX ();
8303 /* If buffers aren't live, make new ones. */
8304 ensure_echo_area_buffers ();
8309 this_one
= 0, the_other
= 1;
8311 this_one
= 1, the_other
= 0;
8314 this_one
= 0, the_other
= 1;
8317 /* We need a fresh one in case the current echo buffer equals
8318 the one containing the last displayed echo area message. */
8319 if (!NILP (echo_area_buffer
[this_one
])
8320 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8321 echo_area_buffer
[this_one
] = Qnil
;
8324 /* Choose a suitable buffer from echo_buffer[] is we don't
8326 if (NILP (echo_area_buffer
[this_one
]))
8328 echo_area_buffer
[this_one
]
8329 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8330 ? echo_buffer
[the_other
]
8331 : echo_buffer
[this_one
]);
8335 buffer
= echo_area_buffer
[this_one
];
8337 /* Don't get confused by reusing the buffer used for echoing
8338 for a different purpose. */
8339 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8342 record_unwind_protect (unwind_with_echo_area_buffer
,
8343 with_echo_area_buffer_unwind_data (w
));
8345 /* Make the echo area buffer current. Note that for display
8346 purposes, it is not necessary that the displayed window's buffer
8347 == current_buffer, except for text property lookup. So, let's
8348 only set that buffer temporarily here without doing a full
8349 Fset_window_buffer. We must also change w->pointm, though,
8350 because otherwise an assertions in unshow_buffer fails, and Emacs
8352 set_buffer_internal_1 (XBUFFER (buffer
));
8356 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8359 current_buffer
->undo_list
= Qt
;
8360 current_buffer
->read_only
= Qnil
;
8361 specbind (Qinhibit_read_only
, Qt
);
8362 specbind (Qinhibit_modification_hooks
, Qt
);
8364 if (clear_buffer_p
&& Z
> BEG
)
8367 xassert (BEGV
>= BEG
);
8368 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8370 rc
= fn (a1
, a2
, a3
, a4
);
8372 xassert (BEGV
>= BEG
);
8373 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8375 unbind_to (count
, Qnil
);
8380 /* Save state that should be preserved around the call to the function
8381 FN called in with_echo_area_buffer. */
8384 with_echo_area_buffer_unwind_data (w
)
8388 Lisp_Object vector
, tmp
;
8390 /* Reduce consing by keeping one vector in
8391 Vwith_echo_area_save_vector. */
8392 vector
= Vwith_echo_area_save_vector
;
8393 Vwith_echo_area_save_vector
= Qnil
;
8396 vector
= Fmake_vector (make_number (7), Qnil
);
8398 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8399 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8400 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8404 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8405 ASET (vector
, i
, w
->buffer
); ++i
;
8406 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8407 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8412 for (; i
< end
; ++i
)
8413 ASET (vector
, i
, Qnil
);
8416 xassert (i
== ASIZE (vector
));
8421 /* Restore global state from VECTOR which was created by
8422 with_echo_area_buffer_unwind_data. */
8425 unwind_with_echo_area_buffer (vector
)
8428 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8429 Vdeactivate_mark
= AREF (vector
, 1);
8430 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8432 if (WINDOWP (AREF (vector
, 3)))
8435 Lisp_Object buffer
, charpos
, bytepos
;
8437 w
= XWINDOW (AREF (vector
, 3));
8438 buffer
= AREF (vector
, 4);
8439 charpos
= AREF (vector
, 5);
8440 bytepos
= AREF (vector
, 6);
8443 set_marker_both (w
->pointm
, buffer
,
8444 XFASTINT (charpos
), XFASTINT (bytepos
));
8447 Vwith_echo_area_save_vector
= vector
;
8452 /* Set up the echo area for use by print functions. MULTIBYTE_P
8453 non-zero means we will print multibyte. */
8456 setup_echo_area_for_printing (multibyte_p
)
8459 /* If we can't find an echo area any more, exit. */
8460 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8463 ensure_echo_area_buffers ();
8465 if (!message_buf_print
)
8467 /* A message has been output since the last time we printed.
8468 Choose a fresh echo area buffer. */
8469 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8470 echo_area_buffer
[0] = echo_buffer
[1];
8472 echo_area_buffer
[0] = echo_buffer
[0];
8474 /* Switch to that buffer and clear it. */
8475 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8476 current_buffer
->truncate_lines
= Qnil
;
8480 int count
= SPECPDL_INDEX ();
8481 specbind (Qinhibit_read_only
, Qt
);
8482 /* Note that undo recording is always disabled. */
8484 unbind_to (count
, Qnil
);
8486 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8488 /* Set up the buffer for the multibyteness we need. */
8490 != !NILP (current_buffer
->enable_multibyte_characters
))
8491 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8493 /* Raise the frame containing the echo area. */
8494 if (minibuffer_auto_raise
)
8496 struct frame
*sf
= SELECTED_FRAME ();
8497 Lisp_Object mini_window
;
8498 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8499 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8502 message_log_maybe_newline ();
8503 message_buf_print
= 1;
8507 if (NILP (echo_area_buffer
[0]))
8509 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8510 echo_area_buffer
[0] = echo_buffer
[1];
8512 echo_area_buffer
[0] = echo_buffer
[0];
8515 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8517 /* Someone switched buffers between print requests. */
8518 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8519 current_buffer
->truncate_lines
= Qnil
;
8525 /* Display an echo area message in window W. Value is non-zero if W's
8526 height is changed. If display_last_displayed_message_p is
8527 non-zero, display the message that was last displayed, otherwise
8528 display the current message. */
8531 display_echo_area (w
)
8534 int i
, no_message_p
, window_height_changed_p
, count
;
8536 /* Temporarily disable garbage collections while displaying the echo
8537 area. This is done because a GC can print a message itself.
8538 That message would modify the echo area buffer's contents while a
8539 redisplay of the buffer is going on, and seriously confuse
8541 count
= inhibit_garbage_collection ();
8543 /* If there is no message, we must call display_echo_area_1
8544 nevertheless because it resizes the window. But we will have to
8545 reset the echo_area_buffer in question to nil at the end because
8546 with_echo_area_buffer will sets it to an empty buffer. */
8547 i
= display_last_displayed_message_p
? 1 : 0;
8548 no_message_p
= NILP (echo_area_buffer
[i
]);
8550 window_height_changed_p
8551 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8552 display_echo_area_1
,
8553 (EMACS_INT
) w
, Qnil
, 0, 0);
8556 echo_area_buffer
[i
] = Qnil
;
8558 unbind_to (count
, Qnil
);
8559 return window_height_changed_p
;
8563 /* Helper for display_echo_area. Display the current buffer which
8564 contains the current echo area message in window W, a mini-window,
8565 a pointer to which is passed in A1. A2..A4 are currently not used.
8566 Change the height of W so that all of the message is displayed.
8567 Value is non-zero if height of W was changed. */
8570 display_echo_area_1 (a1
, a2
, a3
, a4
)
8575 struct window
*w
= (struct window
*) a1
;
8577 struct text_pos start
;
8578 int window_height_changed_p
= 0;
8580 /* Do this before displaying, so that we have a large enough glyph
8581 matrix for the display. If we can't get enough space for the
8582 whole text, display the last N lines. That works by setting w->start. */
8583 window_height_changed_p
= resize_mini_window (w
, 0);
8585 /* Use the starting position chosen by resize_mini_window. */
8586 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8589 clear_glyph_matrix (w
->desired_matrix
);
8590 XSETWINDOW (window
, w
);
8591 try_window (window
, start
, 0);
8593 return window_height_changed_p
;
8597 /* Resize the echo area window to exactly the size needed for the
8598 currently displayed message, if there is one. If a mini-buffer
8599 is active, don't shrink it. */
8602 resize_echo_area_exactly ()
8604 if (BUFFERP (echo_area_buffer
[0])
8605 && WINDOWP (echo_area_window
))
8607 struct window
*w
= XWINDOW (echo_area_window
);
8609 Lisp_Object resize_exactly
;
8611 if (minibuf_level
== 0)
8612 resize_exactly
= Qt
;
8614 resize_exactly
= Qnil
;
8616 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8617 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8620 ++windows_or_buffers_changed
;
8621 ++update_mode_lines
;
8622 redisplay_internal (0);
8628 /* Callback function for with_echo_area_buffer, when used from
8629 resize_echo_area_exactly. A1 contains a pointer to the window to
8630 resize, EXACTLY non-nil means resize the mini-window exactly to the
8631 size of the text displayed. A3 and A4 are not used. Value is what
8632 resize_mini_window returns. */
8635 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8637 Lisp_Object exactly
;
8640 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8644 /* Resize mini-window W to fit the size of its contents. EXACT_P
8645 means size the window exactly to the size needed. Otherwise, it's
8646 only enlarged until W's buffer is empty.
8648 Set W->start to the right place to begin display. If the whole
8649 contents fit, start at the beginning. Otherwise, start so as
8650 to make the end of the contents appear. This is particularly
8651 important for y-or-n-p, but seems desirable generally.
8653 Value is non-zero if the window height has been changed. */
8656 resize_mini_window (w
, exact_p
)
8660 struct frame
*f
= XFRAME (w
->frame
);
8661 int window_height_changed_p
= 0;
8663 xassert (MINI_WINDOW_P (w
));
8665 /* By default, start display at the beginning. */
8666 set_marker_both (w
->start
, w
->buffer
,
8667 BUF_BEGV (XBUFFER (w
->buffer
)),
8668 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8670 /* Don't resize windows while redisplaying a window; it would
8671 confuse redisplay functions when the size of the window they are
8672 displaying changes from under them. Such a resizing can happen,
8673 for instance, when which-func prints a long message while
8674 we are running fontification-functions. We're running these
8675 functions with safe_call which binds inhibit-redisplay to t. */
8676 if (!NILP (Vinhibit_redisplay
))
8679 /* Nil means don't try to resize. */
8680 if (NILP (Vresize_mini_windows
)
8681 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8684 if (!FRAME_MINIBUF_ONLY_P (f
))
8687 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8688 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8689 int height
, max_height
;
8690 int unit
= FRAME_LINE_HEIGHT (f
);
8691 struct text_pos start
;
8692 struct buffer
*old_current_buffer
= NULL
;
8694 if (current_buffer
!= XBUFFER (w
->buffer
))
8696 old_current_buffer
= current_buffer
;
8697 set_buffer_internal (XBUFFER (w
->buffer
));
8700 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8702 /* Compute the max. number of lines specified by the user. */
8703 if (FLOATP (Vmax_mini_window_height
))
8704 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8705 else if (INTEGERP (Vmax_mini_window_height
))
8706 max_height
= XINT (Vmax_mini_window_height
);
8708 max_height
= total_height
/ 4;
8710 /* Correct that max. height if it's bogus. */
8711 max_height
= max (1, max_height
);
8712 max_height
= min (total_height
, max_height
);
8714 /* Find out the height of the text in the window. */
8715 if (it
.line_wrap
== TRUNCATE
)
8720 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8721 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8722 height
= it
.current_y
+ last_height
;
8724 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8725 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8726 height
= (height
+ unit
- 1) / unit
;
8729 /* Compute a suitable window start. */
8730 if (height
> max_height
)
8732 height
= max_height
;
8733 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8734 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8735 start
= it
.current
.pos
;
8738 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8739 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8741 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8743 /* Let it grow only, until we display an empty message, in which
8744 case the window shrinks again. */
8745 if (height
> WINDOW_TOTAL_LINES (w
))
8747 int old_height
= WINDOW_TOTAL_LINES (w
);
8748 freeze_window_starts (f
, 1);
8749 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8750 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8752 else if (height
< WINDOW_TOTAL_LINES (w
)
8753 && (exact_p
|| BEGV
== ZV
))
8755 int old_height
= WINDOW_TOTAL_LINES (w
);
8756 freeze_window_starts (f
, 0);
8757 shrink_mini_window (w
);
8758 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8763 /* Always resize to exact size needed. */
8764 if (height
> WINDOW_TOTAL_LINES (w
))
8766 int old_height
= WINDOW_TOTAL_LINES (w
);
8767 freeze_window_starts (f
, 1);
8768 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8769 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8771 else if (height
< WINDOW_TOTAL_LINES (w
))
8773 int old_height
= WINDOW_TOTAL_LINES (w
);
8774 freeze_window_starts (f
, 0);
8775 shrink_mini_window (w
);
8779 freeze_window_starts (f
, 1);
8780 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8783 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8787 if (old_current_buffer
)
8788 set_buffer_internal (old_current_buffer
);
8791 return window_height_changed_p
;
8795 /* Value is the current message, a string, or nil if there is no
8803 if (!BUFFERP (echo_area_buffer
[0]))
8807 with_echo_area_buffer (0, 0, current_message_1
,
8808 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8810 echo_area_buffer
[0] = Qnil
;
8818 current_message_1 (a1
, a2
, a3
, a4
)
8823 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8826 *msg
= make_buffer_string (BEG
, Z
, 1);
8833 /* Push the current message on Vmessage_stack for later restauration
8834 by restore_message. Value is non-zero if the current message isn't
8835 empty. This is a relatively infrequent operation, so it's not
8836 worth optimizing. */
8842 msg
= current_message ();
8843 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8844 return STRINGP (msg
);
8848 /* Restore message display from the top of Vmessage_stack. */
8855 xassert (CONSP (Vmessage_stack
));
8856 msg
= XCAR (Vmessage_stack
);
8858 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8860 message3_nolog (msg
, 0, 0);
8864 /* Handler for record_unwind_protect calling pop_message. */
8867 pop_message_unwind (dummy
)
8874 /* Pop the top-most entry off Vmessage_stack. */
8879 xassert (CONSP (Vmessage_stack
));
8880 Vmessage_stack
= XCDR (Vmessage_stack
);
8884 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8885 exits. If the stack is not empty, we have a missing pop_message
8889 check_message_stack ()
8891 if (!NILP (Vmessage_stack
))
8896 /* Truncate to NCHARS what will be displayed in the echo area the next
8897 time we display it---but don't redisplay it now. */
8900 truncate_echo_area (nchars
)
8904 echo_area_buffer
[0] = Qnil
;
8905 /* A null message buffer means that the frame hasn't really been
8906 initialized yet. Error messages get reported properly by
8907 cmd_error, so this must be just an informative message; toss it. */
8908 else if (!noninteractive
8910 && !NILP (echo_area_buffer
[0]))
8912 struct frame
*sf
= SELECTED_FRAME ();
8913 if (FRAME_MESSAGE_BUF (sf
))
8914 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8919 /* Helper function for truncate_echo_area. Truncate the current
8920 message to at most NCHARS characters. */
8923 truncate_message_1 (nchars
, a2
, a3
, a4
)
8928 if (BEG
+ nchars
< Z
)
8929 del_range (BEG
+ nchars
, Z
);
8931 echo_area_buffer
[0] = Qnil
;
8936 /* Set the current message to a substring of S or STRING.
8938 If STRING is a Lisp string, set the message to the first NBYTES
8939 bytes from STRING. NBYTES zero means use the whole string. If
8940 STRING is multibyte, the message will be displayed multibyte.
8942 If S is not null, set the message to the first LEN bytes of S. LEN
8943 zero means use the whole string. MULTIBYTE_P non-zero means S is
8944 multibyte. Display the message multibyte in that case.
8946 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8947 to t before calling set_message_1 (which calls insert).
8951 set_message (s
, string
, nbytes
, multibyte_p
)
8954 int nbytes
, multibyte_p
;
8956 message_enable_multibyte
8957 = ((s
&& multibyte_p
)
8958 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
8960 with_echo_area_buffer (0, -1, set_message_1
,
8961 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
8962 message_buf_print
= 0;
8963 help_echo_showing_p
= 0;
8967 /* Helper function for set_message. Arguments have the same meaning
8968 as there, with A1 corresponding to S and A2 corresponding to STRING
8969 This function is called with the echo area buffer being
8973 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
8976 EMACS_INT nbytes
, multibyte_p
;
8978 const char *s
= (const char *) a1
;
8979 Lisp_Object string
= a2
;
8981 /* Change multibyteness of the echo buffer appropriately. */
8982 if (message_enable_multibyte
8983 != !NILP (current_buffer
->enable_multibyte_characters
))
8984 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
8986 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
8988 /* Insert new message at BEG. */
8989 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8991 if (STRINGP (string
))
8996 nbytes
= SBYTES (string
);
8997 nchars
= string_byte_to_char (string
, nbytes
);
8999 /* This function takes care of single/multibyte conversion. We
9000 just have to ensure that the echo area buffer has the right
9001 setting of enable_multibyte_characters. */
9002 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9007 nbytes
= strlen (s
);
9009 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9011 /* Convert from multi-byte to single-byte. */
9013 unsigned char work
[1];
9015 /* Convert a multibyte string to single-byte. */
9016 for (i
= 0; i
< nbytes
; i
+= n
)
9018 c
= string_char_and_length (s
+ i
, nbytes
- i
, &n
);
9019 work
[0] = (ASCII_CHAR_P (c
)
9021 : multibyte_char_to_unibyte (c
, Qnil
));
9022 insert_1_both (work
, 1, 1, 1, 0, 0);
9025 else if (!multibyte_p
9026 && !NILP (current_buffer
->enable_multibyte_characters
))
9028 /* Convert from single-byte to multi-byte. */
9030 const unsigned char *msg
= (const unsigned char *) s
;
9031 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9033 /* Convert a single-byte string to multibyte. */
9034 for (i
= 0; i
< nbytes
; i
++)
9037 c
= unibyte_char_to_multibyte (c
);
9038 n
= CHAR_STRING (c
, str
);
9039 insert_1_both (str
, 1, n
, 1, 0, 0);
9043 insert_1 (s
, nbytes
, 1, 0, 0);
9050 /* Clear messages. CURRENT_P non-zero means clear the current
9051 message. LAST_DISPLAYED_P non-zero means clear the message
9055 clear_message (current_p
, last_displayed_p
)
9056 int current_p
, last_displayed_p
;
9060 echo_area_buffer
[0] = Qnil
;
9061 message_cleared_p
= 1;
9064 if (last_displayed_p
)
9065 echo_area_buffer
[1] = Qnil
;
9067 message_buf_print
= 0;
9070 /* Clear garbaged frames.
9072 This function is used where the old redisplay called
9073 redraw_garbaged_frames which in turn called redraw_frame which in
9074 turn called clear_frame. The call to clear_frame was a source of
9075 flickering. I believe a clear_frame is not necessary. It should
9076 suffice in the new redisplay to invalidate all current matrices,
9077 and ensure a complete redisplay of all windows. */
9080 clear_garbaged_frames ()
9084 Lisp_Object tail
, frame
;
9085 int changed_count
= 0;
9087 FOR_EACH_FRAME (tail
, frame
)
9089 struct frame
*f
= XFRAME (frame
);
9091 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9095 Fredraw_frame (frame
);
9096 f
->force_flush_display_p
= 1;
9098 clear_current_matrices (f
);
9107 ++windows_or_buffers_changed
;
9112 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9113 is non-zero update selected_frame. Value is non-zero if the
9114 mini-windows height has been changed. */
9117 echo_area_display (update_frame_p
)
9120 Lisp_Object mini_window
;
9123 int window_height_changed_p
= 0;
9124 struct frame
*sf
= SELECTED_FRAME ();
9126 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9127 w
= XWINDOW (mini_window
);
9128 f
= XFRAME (WINDOW_FRAME (w
));
9130 /* Don't display if frame is invisible or not yet initialized. */
9131 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9134 #ifdef HAVE_WINDOW_SYSTEM
9135 /* When Emacs starts, selected_frame may be the initial terminal
9136 frame. If we let this through, a message would be displayed on
9138 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9140 #endif /* HAVE_WINDOW_SYSTEM */
9142 /* Redraw garbaged frames. */
9144 clear_garbaged_frames ();
9146 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9148 echo_area_window
= mini_window
;
9149 window_height_changed_p
= display_echo_area (w
);
9150 w
->must_be_updated_p
= 1;
9152 /* Update the display, unless called from redisplay_internal.
9153 Also don't update the screen during redisplay itself. The
9154 update will happen at the end of redisplay, and an update
9155 here could cause confusion. */
9156 if (update_frame_p
&& !redisplaying_p
)
9160 /* If the display update has been interrupted by pending
9161 input, update mode lines in the frame. Due to the
9162 pending input, it might have been that redisplay hasn't
9163 been called, so that mode lines above the echo area are
9164 garbaged. This looks odd, so we prevent it here. */
9165 if (!display_completed
)
9166 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9168 if (window_height_changed_p
9169 /* Don't do this if Emacs is shutting down. Redisplay
9170 needs to run hooks. */
9171 && !NILP (Vrun_hooks
))
9173 /* Must update other windows. Likewise as in other
9174 cases, don't let this update be interrupted by
9176 int count
= SPECPDL_INDEX ();
9177 specbind (Qredisplay_dont_pause
, Qt
);
9178 windows_or_buffers_changed
= 1;
9179 redisplay_internal (0);
9180 unbind_to (count
, Qnil
);
9182 else if (FRAME_WINDOW_P (f
) && n
== 0)
9184 /* Window configuration is the same as before.
9185 Can do with a display update of the echo area,
9186 unless we displayed some mode lines. */
9187 update_single_window (w
, 1);
9188 FRAME_RIF (f
)->flush_display (f
);
9191 update_frame (f
, 1, 1);
9193 /* If cursor is in the echo area, make sure that the next
9194 redisplay displays the minibuffer, so that the cursor will
9195 be replaced with what the minibuffer wants. */
9196 if (cursor_in_echo_area
)
9197 ++windows_or_buffers_changed
;
9200 else if (!EQ (mini_window
, selected_window
))
9201 windows_or_buffers_changed
++;
9203 /* Last displayed message is now the current message. */
9204 echo_area_buffer
[1] = echo_area_buffer
[0];
9205 /* Inform read_char that we're not echoing. */
9206 echo_message_buffer
= Qnil
;
9208 /* Prevent redisplay optimization in redisplay_internal by resetting
9209 this_line_start_pos. This is done because the mini-buffer now
9210 displays the message instead of its buffer text. */
9211 if (EQ (mini_window
, selected_window
))
9212 CHARPOS (this_line_start_pos
) = 0;
9214 return window_height_changed_p
;
9219 /***********************************************************************
9220 Mode Lines and Frame Titles
9221 ***********************************************************************/
9223 /* A buffer for constructing non-propertized mode-line strings and
9224 frame titles in it; allocated from the heap in init_xdisp and
9225 resized as needed in store_mode_line_noprop_char. */
9227 static char *mode_line_noprop_buf
;
9229 /* The buffer's end, and a current output position in it. */
9231 static char *mode_line_noprop_buf_end
;
9232 static char *mode_line_noprop_ptr
;
9234 #define MODE_LINE_NOPROP_LEN(start) \
9235 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9238 MODE_LINE_DISPLAY
= 0,
9244 /* Alist that caches the results of :propertize.
9245 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9246 static Lisp_Object mode_line_proptrans_alist
;
9248 /* List of strings making up the mode-line. */
9249 static Lisp_Object mode_line_string_list
;
9251 /* Base face property when building propertized mode line string. */
9252 static Lisp_Object mode_line_string_face
;
9253 static Lisp_Object mode_line_string_face_prop
;
9256 /* Unwind data for mode line strings */
9258 static Lisp_Object Vmode_line_unwind_vector
;
9261 format_mode_line_unwind_data (struct buffer
*obuf
,
9265 Lisp_Object vector
, tmp
;
9267 /* Reduce consing by keeping one vector in
9268 Vwith_echo_area_save_vector. */
9269 vector
= Vmode_line_unwind_vector
;
9270 Vmode_line_unwind_vector
= Qnil
;
9273 vector
= Fmake_vector (make_number (8), Qnil
);
9275 ASET (vector
, 0, make_number (mode_line_target
));
9276 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9277 ASET (vector
, 2, mode_line_string_list
);
9278 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9279 ASET (vector
, 4, mode_line_string_face
);
9280 ASET (vector
, 5, mode_line_string_face_prop
);
9283 XSETBUFFER (tmp
, obuf
);
9286 ASET (vector
, 6, tmp
);
9287 ASET (vector
, 7, owin
);
9293 unwind_format_mode_line (vector
)
9296 mode_line_target
= XINT (AREF (vector
, 0));
9297 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9298 mode_line_string_list
= AREF (vector
, 2);
9299 if (! EQ (AREF (vector
, 3), Qt
))
9300 mode_line_proptrans_alist
= AREF (vector
, 3);
9301 mode_line_string_face
= AREF (vector
, 4);
9302 mode_line_string_face_prop
= AREF (vector
, 5);
9304 if (!NILP (AREF (vector
, 7)))
9305 /* Select window before buffer, since it may change the buffer. */
9306 Fselect_window (AREF (vector
, 7), Qt
);
9308 if (!NILP (AREF (vector
, 6)))
9310 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9311 ASET (vector
, 6, Qnil
);
9314 Vmode_line_unwind_vector
= vector
;
9319 /* Store a single character C for the frame title in mode_line_noprop_buf.
9320 Re-allocate mode_line_noprop_buf if necessary. */
9324 store_mode_line_noprop_char (char c
)
9326 store_mode_line_noprop_char (c
)
9330 /* If output position has reached the end of the allocated buffer,
9331 double the buffer's size. */
9332 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9334 int len
= MODE_LINE_NOPROP_LEN (0);
9335 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9336 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9337 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9338 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9341 *mode_line_noprop_ptr
++ = c
;
9345 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9346 mode_line_noprop_ptr. STR is the string to store. Do not copy
9347 characters that yield more columns than PRECISION; PRECISION <= 0
9348 means copy the whole string. Pad with spaces until FIELD_WIDTH
9349 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9350 pad. Called from display_mode_element when it is used to build a
9354 store_mode_line_noprop (str
, field_width
, precision
)
9355 const unsigned char *str
;
9356 int field_width
, precision
;
9361 /* Copy at most PRECISION chars from STR. */
9362 nbytes
= strlen (str
);
9363 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9365 store_mode_line_noprop_char (*str
++);
9367 /* Fill up with spaces until FIELD_WIDTH reached. */
9368 while (field_width
> 0
9371 store_mode_line_noprop_char (' ');
9378 /***********************************************************************
9380 ***********************************************************************/
9382 #ifdef HAVE_WINDOW_SYSTEM
9384 /* Set the title of FRAME, if it has changed. The title format is
9385 Vicon_title_format if FRAME is iconified, otherwise it is
9386 frame_title_format. */
9389 x_consider_frame_title (frame
)
9392 struct frame
*f
= XFRAME (frame
);
9394 if (FRAME_WINDOW_P (f
)
9395 || FRAME_MINIBUF_ONLY_P (f
)
9396 || f
->explicit_name
)
9398 /* Do we have more than one visible frame on this X display? */
9405 int count
= SPECPDL_INDEX ();
9407 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9409 Lisp_Object other_frame
= XCAR (tail
);
9410 struct frame
*tf
= XFRAME (other_frame
);
9413 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9414 && !FRAME_MINIBUF_ONLY_P (tf
)
9415 && !EQ (other_frame
, tip_frame
)
9416 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9420 /* Set global variable indicating that multiple frames exist. */
9421 multiple_frames
= CONSP (tail
);
9423 /* Switch to the buffer of selected window of the frame. Set up
9424 mode_line_target so that display_mode_element will output into
9425 mode_line_noprop_buf; then display the title. */
9426 record_unwind_protect (unwind_format_mode_line
,
9427 format_mode_line_unwind_data
9428 (current_buffer
, selected_window
, 0));
9430 Fselect_window (f
->selected_window
, Qt
);
9431 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9432 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9434 mode_line_target
= MODE_LINE_TITLE
;
9435 title_start
= MODE_LINE_NOPROP_LEN (0);
9436 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9437 NULL
, DEFAULT_FACE_ID
);
9438 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9439 len
= MODE_LINE_NOPROP_LEN (title_start
);
9440 title
= mode_line_noprop_buf
+ title_start
;
9441 unbind_to (count
, Qnil
);
9443 /* Set the title only if it's changed. This avoids consing in
9444 the common case where it hasn't. (If it turns out that we've
9445 already wasted too much time by walking through the list with
9446 display_mode_element, then we might need to optimize at a
9447 higher level than this.) */
9448 if (! STRINGP (f
->name
)
9449 || SBYTES (f
->name
) != len
9450 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9455 if (!MINI_WINDOW_P(XWINDOW(f
->selected_window
)))
9458 ns_set_name_as_filename (f
);
9460 x_implicitly_set_name (f
, make_string(title
, len
),
9466 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9471 /* do this also for frames with explicit names */
9472 ns_implicitly_set_icon_type(f
);
9473 ns_set_doc_edited(f
, Fbuffer_modified_p
9474 (XWINDOW (f
->selected_window
)->buffer
), Qnil
);
9480 #endif /* not HAVE_WINDOW_SYSTEM */
9485 /***********************************************************************
9487 ***********************************************************************/
9490 /* Prepare for redisplay by updating menu-bar item lists when
9491 appropriate. This can call eval. */
9494 prepare_menu_bars ()
9497 struct gcpro gcpro1
, gcpro2
;
9499 Lisp_Object tooltip_frame
;
9501 #ifdef HAVE_WINDOW_SYSTEM
9502 tooltip_frame
= tip_frame
;
9504 tooltip_frame
= Qnil
;
9507 /* Update all frame titles based on their buffer names, etc. We do
9508 this before the menu bars so that the buffer-menu will show the
9509 up-to-date frame titles. */
9510 #ifdef HAVE_WINDOW_SYSTEM
9511 if (windows_or_buffers_changed
|| update_mode_lines
)
9513 Lisp_Object tail
, frame
;
9515 FOR_EACH_FRAME (tail
, frame
)
9518 if (!EQ (frame
, tooltip_frame
)
9519 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9520 x_consider_frame_title (frame
);
9523 #endif /* HAVE_WINDOW_SYSTEM */
9525 /* Update the menu bar item lists, if appropriate. This has to be
9526 done before any actual redisplay or generation of display lines. */
9527 all_windows
= (update_mode_lines
9528 || buffer_shared
> 1
9529 || windows_or_buffers_changed
);
9532 Lisp_Object tail
, frame
;
9533 int count
= SPECPDL_INDEX ();
9534 /* 1 means that update_menu_bar has run its hooks
9535 so any further calls to update_menu_bar shouldn't do so again. */
9536 int menu_bar_hooks_run
= 0;
9538 record_unwind_save_match_data ();
9540 FOR_EACH_FRAME (tail
, frame
)
9544 /* Ignore tooltip frame. */
9545 if (EQ (frame
, tooltip_frame
))
9548 /* If a window on this frame changed size, report that to
9549 the user and clear the size-change flag. */
9550 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9552 Lisp_Object functions
;
9554 /* Clear flag first in case we get an error below. */
9555 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9556 functions
= Vwindow_size_change_functions
;
9557 GCPRO2 (tail
, functions
);
9559 while (CONSP (functions
))
9561 if (!EQ (XCAR (functions
), Qt
))
9562 call1 (XCAR (functions
), frame
);
9563 functions
= XCDR (functions
);
9569 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9570 #ifdef HAVE_WINDOW_SYSTEM
9571 update_tool_bar (f
, 0);
9576 unbind_to (count
, Qnil
);
9580 struct frame
*sf
= SELECTED_FRAME ();
9581 update_menu_bar (sf
, 1, 0);
9582 #ifdef HAVE_WINDOW_SYSTEM
9583 update_tool_bar (sf
, 1);
9587 /* Motif needs this. See comment in xmenu.c. Turn it off when
9588 pending_menu_activation is not defined. */
9589 #ifdef USE_X_TOOLKIT
9590 pending_menu_activation
= 0;
9595 /* Update the menu bar item list for frame F. This has to be done
9596 before we start to fill in any display lines, because it can call
9599 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9601 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9602 already ran the menu bar hooks for this redisplay, so there
9603 is no need to run them again. The return value is the
9604 updated value of this flag, to pass to the next call. */
9607 update_menu_bar (f
, save_match_data
, hooks_run
)
9609 int save_match_data
;
9613 register struct window
*w
;
9615 /* If called recursively during a menu update, do nothing. This can
9616 happen when, for instance, an activate-menubar-hook causes a
9618 if (inhibit_menubar_update
)
9621 window
= FRAME_SELECTED_WINDOW (f
);
9622 w
= XWINDOW (window
);
9624 if (FRAME_WINDOW_P (f
)
9626 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9627 || defined (HAVE_NS) || defined (USE_GTK)
9628 FRAME_EXTERNAL_MENU_BAR (f
)
9630 FRAME_MENU_BAR_LINES (f
) > 0
9632 : FRAME_MENU_BAR_LINES (f
) > 0)
9634 /* If the user has switched buffers or windows, we need to
9635 recompute to reflect the new bindings. But we'll
9636 recompute when update_mode_lines is set too; that means
9637 that people can use force-mode-line-update to request
9638 that the menu bar be recomputed. The adverse effect on
9639 the rest of the redisplay algorithm is about the same as
9640 windows_or_buffers_changed anyway. */
9641 if (windows_or_buffers_changed
9642 /* This used to test w->update_mode_line, but we believe
9643 there is no need to recompute the menu in that case. */
9644 || update_mode_lines
9645 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9646 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9647 != !NILP (w
->last_had_star
))
9648 || ((!NILP (Vtransient_mark_mode
)
9649 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9650 != !NILP (w
->region_showing
)))
9652 struct buffer
*prev
= current_buffer
;
9653 int count
= SPECPDL_INDEX ();
9655 specbind (Qinhibit_menubar_update
, Qt
);
9657 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9658 if (save_match_data
)
9659 record_unwind_save_match_data ();
9660 if (NILP (Voverriding_local_map_menu_flag
))
9662 specbind (Qoverriding_terminal_local_map
, Qnil
);
9663 specbind (Qoverriding_local_map
, Qnil
);
9668 /* Run the Lucid hook. */
9669 safe_run_hooks (Qactivate_menubar_hook
);
9671 /* If it has changed current-menubar from previous value,
9672 really recompute the menu-bar from the value. */
9673 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9674 call0 (Qrecompute_lucid_menubar
);
9676 safe_run_hooks (Qmenu_bar_update_hook
);
9681 XSETFRAME (Vmenu_updating_frame
, f
);
9682 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9684 /* Redisplay the menu bar in case we changed it. */
9685 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9686 || defined (HAVE_NS) || defined (USE_GTK)
9687 if (FRAME_WINDOW_P (f
))
9689 #if defined (HAVE_NS)
9690 /* All frames on Mac OS share the same menubar. So only
9691 the selected frame should be allowed to set it. */
9692 if (f
== SELECTED_FRAME ())
9694 set_frame_menubar (f
, 0, 0);
9697 /* On a terminal screen, the menu bar is an ordinary screen
9698 line, and this makes it get updated. */
9699 w
->update_mode_line
= Qt
;
9700 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9701 /* In the non-toolkit version, the menu bar is an ordinary screen
9702 line, and this makes it get updated. */
9703 w
->update_mode_line
= Qt
;
9704 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9706 unbind_to (count
, Qnil
);
9707 set_buffer_internal_1 (prev
);
9716 /***********************************************************************
9718 ***********************************************************************/
9720 #ifdef HAVE_WINDOW_SYSTEM
9723 Nominal cursor position -- where to draw output.
9724 HPOS and VPOS are window relative glyph matrix coordinates.
9725 X and Y are window relative pixel coordinates. */
9727 struct cursor_pos output_cursor
;
9731 Set the global variable output_cursor to CURSOR. All cursor
9732 positions are relative to updated_window. */
9735 set_output_cursor (cursor
)
9736 struct cursor_pos
*cursor
;
9738 output_cursor
.hpos
= cursor
->hpos
;
9739 output_cursor
.vpos
= cursor
->vpos
;
9740 output_cursor
.x
= cursor
->x
;
9741 output_cursor
.y
= cursor
->y
;
9746 Set a nominal cursor position.
9748 HPOS and VPOS are column/row positions in a window glyph matrix. X
9749 and Y are window text area relative pixel positions.
9751 If this is done during an update, updated_window will contain the
9752 window that is being updated and the position is the future output
9753 cursor position for that window. If updated_window is null, use
9754 selected_window and display the cursor at the given position. */
9757 x_cursor_to (vpos
, hpos
, y
, x
)
9758 int vpos
, hpos
, y
, x
;
9762 /* If updated_window is not set, work on selected_window. */
9766 w
= XWINDOW (selected_window
);
9768 /* Set the output cursor. */
9769 output_cursor
.hpos
= hpos
;
9770 output_cursor
.vpos
= vpos
;
9771 output_cursor
.x
= x
;
9772 output_cursor
.y
= y
;
9774 /* If not called as part of an update, really display the cursor.
9775 This will also set the cursor position of W. */
9776 if (updated_window
== NULL
)
9779 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9780 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9781 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9786 #endif /* HAVE_WINDOW_SYSTEM */
9789 /***********************************************************************
9791 ***********************************************************************/
9793 #ifdef HAVE_WINDOW_SYSTEM
9795 /* Where the mouse was last time we reported a mouse event. */
9797 FRAME_PTR last_mouse_frame
;
9799 /* Tool-bar item index of the item on which a mouse button was pressed
9802 int last_tool_bar_item
;
9806 update_tool_bar_unwind (frame
)
9809 selected_frame
= frame
;
9813 /* Update the tool-bar item list for frame F. This has to be done
9814 before we start to fill in any display lines. Called from
9815 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9816 and restore it here. */
9819 update_tool_bar (f
, save_match_data
)
9821 int save_match_data
;
9823 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
9824 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9826 int do_update
= WINDOWP (f
->tool_bar_window
)
9827 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9835 window
= FRAME_SELECTED_WINDOW (f
);
9836 w
= XWINDOW (window
);
9838 /* If the user has switched buffers or windows, we need to
9839 recompute to reflect the new bindings. But we'll
9840 recompute when update_mode_lines is set too; that means
9841 that people can use force-mode-line-update to request
9842 that the menu bar be recomputed. The adverse effect on
9843 the rest of the redisplay algorithm is about the same as
9844 windows_or_buffers_changed anyway. */
9845 if (windows_or_buffers_changed
9846 || !NILP (w
->update_mode_line
)
9847 || update_mode_lines
9848 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9849 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9850 != !NILP (w
->last_had_star
))
9851 || ((!NILP (Vtransient_mark_mode
)
9852 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9853 != !NILP (w
->region_showing
)))
9855 struct buffer
*prev
= current_buffer
;
9856 int count
= SPECPDL_INDEX ();
9857 Lisp_Object frame
, new_tool_bar
;
9859 struct gcpro gcpro1
;
9861 /* Set current_buffer to the buffer of the selected
9862 window of the frame, so that we get the right local
9864 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9866 /* Save match data, if we must. */
9867 if (save_match_data
)
9868 record_unwind_save_match_data ();
9870 /* Make sure that we don't accidentally use bogus keymaps. */
9871 if (NILP (Voverriding_local_map_menu_flag
))
9873 specbind (Qoverriding_terminal_local_map
, Qnil
);
9874 specbind (Qoverriding_local_map
, Qnil
);
9877 GCPRO1 (new_tool_bar
);
9879 /* We must temporarily set the selected frame to this frame
9880 before calling tool_bar_items, because the calculation of
9881 the tool-bar keymap uses the selected frame (see
9882 `tool-bar-make-keymap' in tool-bar.el). */
9883 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
9884 XSETFRAME (frame
, f
);
9885 selected_frame
= frame
;
9887 /* Build desired tool-bar items from keymaps. */
9888 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9891 /* Redisplay the tool-bar if we changed it. */
9892 if (new_n_tool_bar
!= f
->n_tool_bar_items
9893 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9895 /* Redisplay that happens asynchronously due to an expose event
9896 may access f->tool_bar_items. Make sure we update both
9897 variables within BLOCK_INPUT so no such event interrupts. */
9899 f
->tool_bar_items
= new_tool_bar
;
9900 f
->n_tool_bar_items
= new_n_tool_bar
;
9901 w
->update_mode_line
= Qt
;
9907 unbind_to (count
, Qnil
);
9908 set_buffer_internal_1 (prev
);
9914 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9915 F's desired tool-bar contents. F->tool_bar_items must have
9916 been set up previously by calling prepare_menu_bars. */
9919 build_desired_tool_bar_string (f
)
9922 int i
, size
, size_needed
;
9923 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9924 Lisp_Object image
, plist
, props
;
9926 image
= plist
= props
= Qnil
;
9927 GCPRO3 (image
, plist
, props
);
9929 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9930 Otherwise, make a new string. */
9932 /* The size of the string we might be able to reuse. */
9933 size
= (STRINGP (f
->desired_tool_bar_string
)
9934 ? SCHARS (f
->desired_tool_bar_string
)
9937 /* We need one space in the string for each image. */
9938 size_needed
= f
->n_tool_bar_items
;
9940 /* Reuse f->desired_tool_bar_string, if possible. */
9941 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9942 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9946 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9947 Fremove_text_properties (make_number (0), make_number (size
),
9948 props
, f
->desired_tool_bar_string
);
9951 /* Put a `display' property on the string for the images to display,
9952 put a `menu_item' property on tool-bar items with a value that
9953 is the index of the item in F's tool-bar item vector. */
9954 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9956 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
9958 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
9959 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
9960 int hmargin
, vmargin
, relief
, idx
, end
;
9961 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
9963 /* If image is a vector, choose the image according to the
9965 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
9966 if (VECTORP (image
))
9970 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
9971 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
9974 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
9975 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
9977 xassert (ASIZE (image
) >= idx
);
9978 image
= AREF (image
, idx
);
9983 /* Ignore invalid image specifications. */
9984 if (!valid_image_p (image
))
9987 /* Display the tool-bar button pressed, or depressed. */
9988 plist
= Fcopy_sequence (XCDR (image
));
9990 /* Compute margin and relief to draw. */
9991 relief
= (tool_bar_button_relief
>= 0
9992 ? tool_bar_button_relief
9993 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
9994 hmargin
= vmargin
= relief
;
9996 if (INTEGERP (Vtool_bar_button_margin
)
9997 && XINT (Vtool_bar_button_margin
) > 0)
9999 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10000 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10002 else if (CONSP (Vtool_bar_button_margin
))
10004 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10005 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10006 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10008 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10009 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10010 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10013 if (auto_raise_tool_bar_buttons_p
)
10015 /* Add a `:relief' property to the image spec if the item is
10019 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10026 /* If image is selected, display it pressed, i.e. with a
10027 negative relief. If it's not selected, display it with a
10029 plist
= Fplist_put (plist
, QCrelief
,
10031 ? make_number (-relief
)
10032 : make_number (relief
)));
10037 /* Put a margin around the image. */
10038 if (hmargin
|| vmargin
)
10040 if (hmargin
== vmargin
)
10041 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10043 plist
= Fplist_put (plist
, QCmargin
,
10044 Fcons (make_number (hmargin
),
10045 make_number (vmargin
)));
10048 /* If button is not enabled, and we don't have special images
10049 for the disabled state, make the image appear disabled by
10050 applying an appropriate algorithm to it. */
10051 if (!enabled_p
&& idx
< 0)
10052 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10054 /* Put a `display' text property on the string for the image to
10055 display. Put a `menu-item' property on the string that gives
10056 the start of this item's properties in the tool-bar items
10058 image
= Fcons (Qimage
, plist
);
10059 props
= list4 (Qdisplay
, image
,
10060 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10062 /* Let the last image hide all remaining spaces in the tool bar
10063 string. The string can be longer than needed when we reuse a
10064 previous string. */
10065 if (i
+ 1 == f
->n_tool_bar_items
)
10066 end
= SCHARS (f
->desired_tool_bar_string
);
10069 Fadd_text_properties (make_number (i
), make_number (end
),
10070 props
, f
->desired_tool_bar_string
);
10078 /* Display one line of the tool-bar of frame IT->f.
10080 HEIGHT specifies the desired height of the tool-bar line.
10081 If the actual height of the glyph row is less than HEIGHT, the
10082 row's height is increased to HEIGHT, and the icons are centered
10083 vertically in the new height.
10085 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10086 count a final empty row in case the tool-bar width exactly matches
10091 display_tool_bar_line (it
, height
)
10095 struct glyph_row
*row
= it
->glyph_row
;
10096 int max_x
= it
->last_visible_x
;
10097 struct glyph
*last
;
10099 prepare_desired_row (row
);
10100 row
->y
= it
->current_y
;
10102 /* Note that this isn't made use of if the face hasn't a box,
10103 so there's no need to check the face here. */
10104 it
->start_of_box_run_p
= 1;
10106 while (it
->current_x
< max_x
)
10108 int x
, n_glyphs_before
, i
, nglyphs
;
10109 struct it it_before
;
10111 /* Get the next display element. */
10112 if (!get_next_display_element (it
))
10114 /* Don't count empty row if we are counting needed tool-bar lines. */
10115 if (height
< 0 && !it
->hpos
)
10120 /* Produce glyphs. */
10121 n_glyphs_before
= row
->used
[TEXT_AREA
];
10124 PRODUCE_GLYPHS (it
);
10126 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10128 x
= it_before
.current_x
;
10129 while (i
< nglyphs
)
10131 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10133 if (x
+ glyph
->pixel_width
> max_x
)
10135 /* Glyph doesn't fit on line. Backtrack. */
10136 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10138 /* If this is the only glyph on this line, it will never fit on the
10139 toolbar, so skip it. But ensure there is at least one glyph,
10140 so we don't accidentally disable the tool-bar. */
10141 if (n_glyphs_before
== 0
10142 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10148 x
+= glyph
->pixel_width
;
10152 /* Stop at line ends. */
10153 if (ITERATOR_AT_END_OF_LINE_P (it
))
10156 set_iterator_to_next (it
, 1);
10161 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10163 /* Use default face for the border below the tool bar.
10165 FIXME: When auto-resize-tool-bars is grow-only, there is
10166 no additional border below the possibly empty tool-bar lines.
10167 So to make the extra empty lines look "normal", we have to
10168 use the tool-bar face for the border too. */
10169 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10170 it
->face_id
= DEFAULT_FACE_ID
;
10172 extend_face_to_end_of_line (it
);
10173 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10174 last
->right_box_line_p
= 1;
10175 if (last
== row
->glyphs
[TEXT_AREA
])
10176 last
->left_box_line_p
= 1;
10178 /* Make line the desired height and center it vertically. */
10179 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10181 /* Don't add more than one line height. */
10182 height
%= FRAME_LINE_HEIGHT (it
->f
);
10183 it
->max_ascent
+= height
/ 2;
10184 it
->max_descent
+= (height
+ 1) / 2;
10187 compute_line_metrics (it
);
10189 /* If line is empty, make it occupy the rest of the tool-bar. */
10190 if (!row
->displays_text_p
)
10192 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10193 row
->visible_height
= row
->height
;
10194 row
->ascent
= row
->phys_ascent
= 0;
10195 row
->extra_line_spacing
= 0;
10198 row
->full_width_p
= 1;
10199 row
->continued_p
= 0;
10200 row
->truncated_on_left_p
= 0;
10201 row
->truncated_on_right_p
= 0;
10203 it
->current_x
= it
->hpos
= 0;
10204 it
->current_y
+= row
->height
;
10210 /* Max tool-bar height. */
10212 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10213 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10215 /* Value is the number of screen lines needed to make all tool-bar
10216 items of frame F visible. The number of actual rows needed is
10217 returned in *N_ROWS if non-NULL. */
10220 tool_bar_lines_needed (f
, n_rows
)
10224 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10226 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10227 the desired matrix, so use (unused) mode-line row as temporary row to
10228 avoid destroying the first tool-bar row. */
10229 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10231 /* Initialize an iterator for iteration over
10232 F->desired_tool_bar_string in the tool-bar window of frame F. */
10233 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10234 it
.first_visible_x
= 0;
10235 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10236 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10238 while (!ITERATOR_AT_END_P (&it
))
10240 clear_glyph_row (temp_row
);
10241 it
.glyph_row
= temp_row
;
10242 display_tool_bar_line (&it
, -1);
10244 clear_glyph_row (temp_row
);
10246 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10248 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10250 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10254 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10256 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10265 frame
= selected_frame
;
10267 CHECK_FRAME (frame
);
10268 f
= XFRAME (frame
);
10270 if (WINDOWP (f
->tool_bar_window
)
10271 || (w
= XWINDOW (f
->tool_bar_window
),
10272 WINDOW_TOTAL_LINES (w
) > 0))
10274 update_tool_bar (f
, 1);
10275 if (f
->n_tool_bar_items
)
10277 build_desired_tool_bar_string (f
);
10278 nlines
= tool_bar_lines_needed (f
, NULL
);
10282 return make_number (nlines
);
10286 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10287 height should be changed. */
10290 redisplay_tool_bar (f
)
10295 struct glyph_row
*row
;
10297 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
10298 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10299 update_frame_tool_bar (f
);
10303 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10304 do anything. This means you must start with tool-bar-lines
10305 non-zero to get the auto-sizing effect. Or in other words, you
10306 can turn off tool-bars by specifying tool-bar-lines zero. */
10307 if (!WINDOWP (f
->tool_bar_window
)
10308 || (w
= XWINDOW (f
->tool_bar_window
),
10309 WINDOW_TOTAL_LINES (w
) == 0))
10312 /* Set up an iterator for the tool-bar window. */
10313 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10314 it
.first_visible_x
= 0;
10315 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10316 row
= it
.glyph_row
;
10318 /* Build a string that represents the contents of the tool-bar. */
10319 build_desired_tool_bar_string (f
);
10320 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10322 if (f
->n_tool_bar_rows
== 0)
10326 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10327 nlines
!= WINDOW_TOTAL_LINES (w
)))
10329 extern Lisp_Object Qtool_bar_lines
;
10331 int old_height
= WINDOW_TOTAL_LINES (w
);
10333 XSETFRAME (frame
, f
);
10334 Fmodify_frame_parameters (frame
,
10335 Fcons (Fcons (Qtool_bar_lines
,
10336 make_number (nlines
)),
10338 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10340 clear_glyph_matrix (w
->desired_matrix
);
10341 fonts_changed_p
= 1;
10347 /* Display as many lines as needed to display all tool-bar items. */
10349 if (f
->n_tool_bar_rows
> 0)
10351 int border
, rows
, height
, extra
;
10353 if (INTEGERP (Vtool_bar_border
))
10354 border
= XINT (Vtool_bar_border
);
10355 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10356 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10357 else if (EQ (Vtool_bar_border
, Qborder_width
))
10358 border
= f
->border_width
;
10364 rows
= f
->n_tool_bar_rows
;
10365 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10366 extra
= it
.last_visible_y
- border
- height
* rows
;
10368 while (it
.current_y
< it
.last_visible_y
)
10371 if (extra
> 0 && rows
-- > 0)
10373 h
= (extra
+ rows
- 1) / rows
;
10376 display_tool_bar_line (&it
, height
+ h
);
10381 while (it
.current_y
< it
.last_visible_y
)
10382 display_tool_bar_line (&it
, 0);
10385 /* It doesn't make much sense to try scrolling in the tool-bar
10386 window, so don't do it. */
10387 w
->desired_matrix
->no_scrolling_p
= 1;
10388 w
->must_be_updated_p
= 1;
10390 if (!NILP (Vauto_resize_tool_bars
))
10392 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10393 int change_height_p
= 0;
10395 /* If we couldn't display everything, change the tool-bar's
10396 height if there is room for more. */
10397 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10398 && it
.current_y
< max_tool_bar_height
)
10399 change_height_p
= 1;
10401 row
= it
.glyph_row
- 1;
10403 /* If there are blank lines at the end, except for a partially
10404 visible blank line at the end that is smaller than
10405 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10406 if (!row
->displays_text_p
10407 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10408 change_height_p
= 1;
10410 /* If row displays tool-bar items, but is partially visible,
10411 change the tool-bar's height. */
10412 if (row
->displays_text_p
10413 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10414 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10415 change_height_p
= 1;
10417 /* Resize windows as needed by changing the `tool-bar-lines'
10418 frame parameter. */
10419 if (change_height_p
)
10421 extern Lisp_Object Qtool_bar_lines
;
10423 int old_height
= WINDOW_TOTAL_LINES (w
);
10425 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10427 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10428 && !f
->minimize_tool_bar_window_p
)
10429 ? (nlines
> old_height
)
10430 : (nlines
!= old_height
));
10431 f
->minimize_tool_bar_window_p
= 0;
10433 if (change_height_p
)
10435 XSETFRAME (frame
, f
);
10436 Fmodify_frame_parameters (frame
,
10437 Fcons (Fcons (Qtool_bar_lines
,
10438 make_number (nlines
)),
10440 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10442 clear_glyph_matrix (w
->desired_matrix
);
10443 f
->n_tool_bar_rows
= nrows
;
10444 fonts_changed_p
= 1;
10451 f
->minimize_tool_bar_window_p
= 0;
10456 /* Get information about the tool-bar item which is displayed in GLYPH
10457 on frame F. Return in *PROP_IDX the index where tool-bar item
10458 properties start in F->tool_bar_items. Value is zero if
10459 GLYPH doesn't display a tool-bar item. */
10462 tool_bar_item_info (f
, glyph
, prop_idx
)
10464 struct glyph
*glyph
;
10471 /* This function can be called asynchronously, which means we must
10472 exclude any possibility that Fget_text_property signals an
10474 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10475 charpos
= max (0, charpos
);
10477 /* Get the text property `menu-item' at pos. The value of that
10478 property is the start index of this item's properties in
10479 F->tool_bar_items. */
10480 prop
= Fget_text_property (make_number (charpos
),
10481 Qmenu_item
, f
->current_tool_bar_string
);
10482 if (INTEGERP (prop
))
10484 *prop_idx
= XINT (prop
);
10494 /* Get information about the tool-bar item at position X/Y on frame F.
10495 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10496 the current matrix of the tool-bar window of F, or NULL if not
10497 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10498 item in F->tool_bar_items. Value is
10500 -1 if X/Y is not on a tool-bar item
10501 0 if X/Y is on the same item that was highlighted before.
10505 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10508 struct glyph
**glyph
;
10509 int *hpos
, *vpos
, *prop_idx
;
10511 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10512 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10515 /* Find the glyph under X/Y. */
10516 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10517 if (*glyph
== NULL
)
10520 /* Get the start of this tool-bar item's properties in
10521 f->tool_bar_items. */
10522 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10525 /* Is mouse on the highlighted item? */
10526 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10527 && *vpos
>= dpyinfo
->mouse_face_beg_row
10528 && *vpos
<= dpyinfo
->mouse_face_end_row
10529 && (*vpos
> dpyinfo
->mouse_face_beg_row
10530 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10531 && (*vpos
< dpyinfo
->mouse_face_end_row
10532 || *hpos
< dpyinfo
->mouse_face_end_col
10533 || dpyinfo
->mouse_face_past_end
))
10541 Handle mouse button event on the tool-bar of frame F, at
10542 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10543 0 for button release. MODIFIERS is event modifiers for button
10547 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10550 unsigned int modifiers
;
10552 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10553 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10554 int hpos
, vpos
, prop_idx
;
10555 struct glyph
*glyph
;
10556 Lisp_Object enabled_p
;
10558 /* If not on the highlighted tool-bar item, return. */
10559 frame_to_window_pixel_xy (w
, &x
, &y
);
10560 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10563 /* If item is disabled, do nothing. */
10564 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10565 if (NILP (enabled_p
))
10570 /* Show item in pressed state. */
10571 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10572 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10573 last_tool_bar_item
= prop_idx
;
10577 Lisp_Object key
, frame
;
10578 struct input_event event
;
10579 EVENT_INIT (event
);
10581 /* Show item in released state. */
10582 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10583 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10585 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10587 XSETFRAME (frame
, f
);
10588 event
.kind
= TOOL_BAR_EVENT
;
10589 event
.frame_or_window
= frame
;
10591 kbd_buffer_store_event (&event
);
10593 event
.kind
= TOOL_BAR_EVENT
;
10594 event
.frame_or_window
= frame
;
10596 event
.modifiers
= modifiers
;
10597 kbd_buffer_store_event (&event
);
10598 last_tool_bar_item
= -1;
10603 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10604 tool-bar window-relative coordinates X/Y. Called from
10605 note_mouse_highlight. */
10608 note_tool_bar_highlight (f
, x
, y
)
10612 Lisp_Object window
= f
->tool_bar_window
;
10613 struct window
*w
= XWINDOW (window
);
10614 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10616 struct glyph
*glyph
;
10617 struct glyph_row
*row
;
10619 Lisp_Object enabled_p
;
10621 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10622 int mouse_down_p
, rc
;
10624 /* Function note_mouse_highlight is called with negative x(y
10625 values when mouse moves outside of the frame. */
10626 if (x
<= 0 || y
<= 0)
10628 clear_mouse_face (dpyinfo
);
10632 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10635 /* Not on tool-bar item. */
10636 clear_mouse_face (dpyinfo
);
10640 /* On same tool-bar item as before. */
10641 goto set_help_echo
;
10643 clear_mouse_face (dpyinfo
);
10645 /* Mouse is down, but on different tool-bar item? */
10646 mouse_down_p
= (dpyinfo
->grabbed
10647 && f
== last_mouse_frame
10648 && FRAME_LIVE_P (f
));
10650 && last_tool_bar_item
!= prop_idx
)
10653 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10654 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10656 /* If tool-bar item is not enabled, don't highlight it. */
10657 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10658 if (!NILP (enabled_p
))
10660 /* Compute the x-position of the glyph. In front and past the
10661 image is a space. We include this in the highlighted area. */
10662 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10663 for (i
= x
= 0; i
< hpos
; ++i
)
10664 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10666 /* Record this as the current active region. */
10667 dpyinfo
->mouse_face_beg_col
= hpos
;
10668 dpyinfo
->mouse_face_beg_row
= vpos
;
10669 dpyinfo
->mouse_face_beg_x
= x
;
10670 dpyinfo
->mouse_face_beg_y
= row
->y
;
10671 dpyinfo
->mouse_face_past_end
= 0;
10673 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10674 dpyinfo
->mouse_face_end_row
= vpos
;
10675 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10676 dpyinfo
->mouse_face_end_y
= row
->y
;
10677 dpyinfo
->mouse_face_window
= window
;
10678 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10680 /* Display it as active. */
10681 show_mouse_face (dpyinfo
, draw
);
10682 dpyinfo
->mouse_face_image_state
= draw
;
10687 /* Set help_echo_string to a help string to display for this tool-bar item.
10688 XTread_socket does the rest. */
10689 help_echo_object
= help_echo_window
= Qnil
;
10690 help_echo_pos
= -1;
10691 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10692 if (NILP (help_echo_string
))
10693 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10696 #endif /* HAVE_WINDOW_SYSTEM */
10700 /************************************************************************
10701 Horizontal scrolling
10702 ************************************************************************/
10704 static int hscroll_window_tree
P_ ((Lisp_Object
));
10705 static int hscroll_windows
P_ ((Lisp_Object
));
10707 /* For all leaf windows in the window tree rooted at WINDOW, set their
10708 hscroll value so that PT is (i) visible in the window, and (ii) so
10709 that it is not within a certain margin at the window's left and
10710 right border. Value is non-zero if any window's hscroll has been
10714 hscroll_window_tree (window
)
10715 Lisp_Object window
;
10717 int hscrolled_p
= 0;
10718 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10719 int hscroll_step_abs
= 0;
10720 double hscroll_step_rel
= 0;
10722 if (hscroll_relative_p
)
10724 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10725 if (hscroll_step_rel
< 0)
10727 hscroll_relative_p
= 0;
10728 hscroll_step_abs
= 0;
10731 else if (INTEGERP (Vhscroll_step
))
10733 hscroll_step_abs
= XINT (Vhscroll_step
);
10734 if (hscroll_step_abs
< 0)
10735 hscroll_step_abs
= 0;
10738 hscroll_step_abs
= 0;
10740 while (WINDOWP (window
))
10742 struct window
*w
= XWINDOW (window
);
10744 if (WINDOWP (w
->hchild
))
10745 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10746 else if (WINDOWP (w
->vchild
))
10747 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10748 else if (w
->cursor
.vpos
>= 0)
10751 int text_area_width
;
10752 struct glyph_row
*current_cursor_row
10753 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10754 struct glyph_row
*desired_cursor_row
10755 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10756 struct glyph_row
*cursor_row
10757 = (desired_cursor_row
->enabled_p
10758 ? desired_cursor_row
10759 : current_cursor_row
);
10761 text_area_width
= window_box_width (w
, TEXT_AREA
);
10763 /* Scroll when cursor is inside this scroll margin. */
10764 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10766 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10767 && ((XFASTINT (w
->hscroll
)
10768 && w
->cursor
.x
<= h_margin
)
10769 || (cursor_row
->enabled_p
10770 && cursor_row
->truncated_on_right_p
10771 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10775 struct buffer
*saved_current_buffer
;
10779 /* Find point in a display of infinite width. */
10780 saved_current_buffer
= current_buffer
;
10781 current_buffer
= XBUFFER (w
->buffer
);
10783 if (w
== XWINDOW (selected_window
))
10784 pt
= BUF_PT (current_buffer
);
10787 pt
= marker_position (w
->pointm
);
10788 pt
= max (BEGV
, pt
);
10792 /* Move iterator to pt starting at cursor_row->start in
10793 a line with infinite width. */
10794 init_to_row_start (&it
, w
, cursor_row
);
10795 it
.last_visible_x
= INFINITY
;
10796 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10797 current_buffer
= saved_current_buffer
;
10799 /* Position cursor in window. */
10800 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10801 hscroll
= max (0, (it
.current_x
10802 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10803 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10804 : (text_area_width
/ 2))))
10805 / FRAME_COLUMN_WIDTH (it
.f
);
10806 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10808 if (hscroll_relative_p
)
10809 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10812 wanted_x
= text_area_width
10813 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10816 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10820 if (hscroll_relative_p
)
10821 wanted_x
= text_area_width
* hscroll_step_rel
10824 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10827 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10829 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10831 /* Don't call Fset_window_hscroll if value hasn't
10832 changed because it will prevent redisplay
10834 if (XFASTINT (w
->hscroll
) != hscroll
)
10836 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10837 w
->hscroll
= make_number (hscroll
);
10846 /* Value is non-zero if hscroll of any leaf window has been changed. */
10847 return hscrolled_p
;
10851 /* Set hscroll so that cursor is visible and not inside horizontal
10852 scroll margins for all windows in the tree rooted at WINDOW. See
10853 also hscroll_window_tree above. Value is non-zero if any window's
10854 hscroll has been changed. If it has, desired matrices on the frame
10855 of WINDOW are cleared. */
10858 hscroll_windows (window
)
10859 Lisp_Object window
;
10861 int hscrolled_p
= hscroll_window_tree (window
);
10863 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10864 return hscrolled_p
;
10869 /************************************************************************
10871 ************************************************************************/
10873 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10874 to a non-zero value. This is sometimes handy to have in a debugger
10879 /* First and last unchanged row for try_window_id. */
10881 int debug_first_unchanged_at_end_vpos
;
10882 int debug_last_unchanged_at_beg_vpos
;
10884 /* Delta vpos and y. */
10886 int debug_dvpos
, debug_dy
;
10888 /* Delta in characters and bytes for try_window_id. */
10890 int debug_delta
, debug_delta_bytes
;
10892 /* Values of window_end_pos and window_end_vpos at the end of
10895 EMACS_INT debug_end_pos
, debug_end_vpos
;
10897 /* Append a string to W->desired_matrix->method. FMT is a printf
10898 format string. A1...A9 are a supplement for a variable-length
10899 argument list. If trace_redisplay_p is non-zero also printf the
10900 resulting string to stderr. */
10903 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10906 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10909 char *method
= w
->desired_matrix
->method
;
10910 int len
= strlen (method
);
10911 int size
= sizeof w
->desired_matrix
->method
;
10912 int remaining
= size
- len
- 1;
10914 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10915 if (len
&& remaining
)
10918 --remaining
, ++len
;
10921 strncpy (method
+ len
, buffer
, remaining
);
10923 if (trace_redisplay_p
)
10924 fprintf (stderr
, "%p (%s): %s\n",
10926 ((BUFFERP (w
->buffer
)
10927 && STRINGP (XBUFFER (w
->buffer
)->name
))
10928 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10933 #endif /* GLYPH_DEBUG */
10936 /* Value is non-zero if all changes in window W, which displays
10937 current_buffer, are in the text between START and END. START is a
10938 buffer position, END is given as a distance from Z. Used in
10939 redisplay_internal for display optimization. */
10942 text_outside_line_unchanged_p (w
, start
, end
)
10946 int unchanged_p
= 1;
10948 /* If text or overlays have changed, see where. */
10949 if (XFASTINT (w
->last_modified
) < MODIFF
10950 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10952 /* Gap in the line? */
10953 if (GPT
< start
|| Z
- GPT
< end
)
10956 /* Changes start in front of the line, or end after it? */
10958 && (BEG_UNCHANGED
< start
- 1
10959 || END_UNCHANGED
< end
))
10962 /* If selective display, can't optimize if changes start at the
10963 beginning of the line. */
10965 && INTEGERP (current_buffer
->selective_display
)
10966 && XINT (current_buffer
->selective_display
) > 0
10967 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
10970 /* If there are overlays at the start or end of the line, these
10971 may have overlay strings with newlines in them. A change at
10972 START, for instance, may actually concern the display of such
10973 overlay strings as well, and they are displayed on different
10974 lines. So, quickly rule out this case. (For the future, it
10975 might be desirable to implement something more telling than
10976 just BEG/END_UNCHANGED.) */
10979 if (BEG
+ BEG_UNCHANGED
== start
10980 && overlay_touches_p (start
))
10982 if (END_UNCHANGED
== end
10983 && overlay_touches_p (Z
- end
))
10988 return unchanged_p
;
10992 /* Do a frame update, taking possible shortcuts into account. This is
10993 the main external entry point for redisplay.
10995 If the last redisplay displayed an echo area message and that message
10996 is no longer requested, we clear the echo area or bring back the
10997 mini-buffer if that is in use. */
11002 redisplay_internal (0);
11007 overlay_arrow_string_or_property (var
)
11012 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11015 return Voverlay_arrow_string
;
11018 /* Return 1 if there are any overlay-arrows in current_buffer. */
11020 overlay_arrow_in_current_buffer_p ()
11024 for (vlist
= Voverlay_arrow_variable_list
;
11026 vlist
= XCDR (vlist
))
11028 Lisp_Object var
= XCAR (vlist
);
11031 if (!SYMBOLP (var
))
11033 val
= find_symbol_value (var
);
11035 && current_buffer
== XMARKER (val
)->buffer
)
11042 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11046 overlay_arrows_changed_p ()
11050 for (vlist
= Voverlay_arrow_variable_list
;
11052 vlist
= XCDR (vlist
))
11054 Lisp_Object var
= XCAR (vlist
);
11055 Lisp_Object val
, pstr
;
11057 if (!SYMBOLP (var
))
11059 val
= find_symbol_value (var
);
11060 if (!MARKERP (val
))
11062 if (! EQ (COERCE_MARKER (val
),
11063 Fget (var
, Qlast_arrow_position
))
11064 || ! (pstr
= overlay_arrow_string_or_property (var
),
11065 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11071 /* Mark overlay arrows to be updated on next redisplay. */
11074 update_overlay_arrows (up_to_date
)
11079 for (vlist
= Voverlay_arrow_variable_list
;
11081 vlist
= XCDR (vlist
))
11083 Lisp_Object var
= XCAR (vlist
);
11085 if (!SYMBOLP (var
))
11088 if (up_to_date
> 0)
11090 Lisp_Object val
= find_symbol_value (var
);
11091 Fput (var
, Qlast_arrow_position
,
11092 COERCE_MARKER (val
));
11093 Fput (var
, Qlast_arrow_string
,
11094 overlay_arrow_string_or_property (var
));
11096 else if (up_to_date
< 0
11097 || !NILP (Fget (var
, Qlast_arrow_position
)))
11099 Fput (var
, Qlast_arrow_position
, Qt
);
11100 Fput (var
, Qlast_arrow_string
, Qt
);
11106 /* Return overlay arrow string to display at row.
11107 Return integer (bitmap number) for arrow bitmap in left fringe.
11108 Return nil if no overlay arrow. */
11111 overlay_arrow_at_row (it
, row
)
11113 struct glyph_row
*row
;
11117 for (vlist
= Voverlay_arrow_variable_list
;
11119 vlist
= XCDR (vlist
))
11121 Lisp_Object var
= XCAR (vlist
);
11124 if (!SYMBOLP (var
))
11127 val
= find_symbol_value (var
);
11130 && current_buffer
== XMARKER (val
)->buffer
11131 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11133 if (FRAME_WINDOW_P (it
->f
)
11134 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11136 #ifdef HAVE_WINDOW_SYSTEM
11137 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11140 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11141 return make_number (fringe_bitmap
);
11144 return make_number (-1); /* Use default arrow bitmap */
11146 return overlay_arrow_string_or_property (var
);
11153 /* Return 1 if point moved out of or into a composition. Otherwise
11154 return 0. PREV_BUF and PREV_PT are the last point buffer and
11155 position. BUF and PT are the current point buffer and position. */
11158 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11159 struct buffer
*prev_buf
, *buf
;
11162 EMACS_INT start
, end
;
11164 Lisp_Object buffer
;
11166 XSETBUFFER (buffer
, buf
);
11167 /* Check a composition at the last point if point moved within the
11169 if (prev_buf
== buf
)
11172 /* Point didn't move. */
11175 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11176 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11177 && COMPOSITION_VALID_P (start
, end
, prop
)
11178 && start
< prev_pt
&& end
> prev_pt
)
11179 /* The last point was within the composition. Return 1 iff
11180 point moved out of the composition. */
11181 return (pt
<= start
|| pt
>= end
);
11184 /* Check a composition at the current point. */
11185 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11186 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11187 && COMPOSITION_VALID_P (start
, end
, prop
)
11188 && start
< pt
&& end
> pt
);
11192 /* Reconsider the setting of B->clip_changed which is displayed
11196 reconsider_clip_changes (w
, b
)
11200 if (b
->clip_changed
11201 && !NILP (w
->window_end_valid
)
11202 && w
->current_matrix
->buffer
== b
11203 && w
->current_matrix
->zv
== BUF_ZV (b
)
11204 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11205 b
->clip_changed
= 0;
11207 /* If display wasn't paused, and W is not a tool bar window, see if
11208 point has been moved into or out of a composition. In that case,
11209 we set b->clip_changed to 1 to force updating the screen. If
11210 b->clip_changed has already been set to 1, we can skip this
11212 if (!b
->clip_changed
11213 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11217 if (w
== XWINDOW (selected_window
))
11218 pt
= BUF_PT (current_buffer
);
11220 pt
= marker_position (w
->pointm
);
11222 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11223 || pt
!= XINT (w
->last_point
))
11224 && check_point_in_composition (w
->current_matrix
->buffer
,
11225 XINT (w
->last_point
),
11226 XBUFFER (w
->buffer
), pt
))
11227 b
->clip_changed
= 1;
11232 /* Select FRAME to forward the values of frame-local variables into C
11233 variables so that the redisplay routines can access those values
11237 select_frame_for_redisplay (frame
)
11240 Lisp_Object tail
, symbol
, val
;
11241 Lisp_Object old
= selected_frame
;
11242 struct Lisp_Symbol
*sym
;
11244 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11246 selected_frame
= frame
;
11250 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11251 if (CONSP (XCAR (tail
))
11252 && (symbol
= XCAR (XCAR (tail
)),
11254 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11256 (BUFFER_LOCAL_VALUEP (val
)))
11257 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11258 /* Use find_symbol_value rather than Fsymbol_value
11259 to avoid an error if it is void. */
11260 find_symbol_value (symbol
);
11261 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11265 #define STOP_POLLING \
11266 do { if (! polling_stopped_here) stop_polling (); \
11267 polling_stopped_here = 1; } while (0)
11269 #define RESUME_POLLING \
11270 do { if (polling_stopped_here) start_polling (); \
11271 polling_stopped_here = 0; } while (0)
11274 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11275 response to any user action; therefore, we should preserve the echo
11276 area. (Actually, our caller does that job.) Perhaps in the future
11277 avoid recentering windows if it is not necessary; currently that
11278 causes some problems. */
11281 redisplay_internal (preserve_echo_area
)
11282 int preserve_echo_area
;
11284 struct window
*w
= XWINDOW (selected_window
);
11287 int must_finish
= 0;
11288 struct text_pos tlbufpos
, tlendpos
;
11289 int number_of_visible_frames
;
11292 int polling_stopped_here
= 0;
11293 Lisp_Object old_frame
= selected_frame
;
11295 /* Non-zero means redisplay has to consider all windows on all
11296 frames. Zero means, only selected_window is considered. */
11297 int consider_all_windows_p
;
11299 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11301 /* No redisplay if running in batch mode or frame is not yet fully
11302 initialized, or redisplay is explicitly turned off by setting
11303 Vinhibit_redisplay. */
11304 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11305 || !NILP (Vinhibit_redisplay
))
11308 /* Don't examine these until after testing Vinhibit_redisplay.
11309 When Emacs is shutting down, perhaps because its connection to
11310 X has dropped, we should not look at them at all. */
11311 f
= XFRAME (w
->frame
);
11312 sf
= SELECTED_FRAME ();
11314 if (!f
->glyphs_initialized_p
)
11317 /* The flag redisplay_performed_directly_p is set by
11318 direct_output_for_insert when it already did the whole screen
11319 update necessary. */
11320 if (redisplay_performed_directly_p
)
11322 redisplay_performed_directly_p
= 0;
11323 if (!hscroll_windows (selected_window
))
11327 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11328 if (popup_activated ())
11332 /* I don't think this happens but let's be paranoid. */
11333 if (redisplaying_p
)
11336 /* Record a function that resets redisplaying_p to its old value
11337 when we leave this function. */
11338 count
= SPECPDL_INDEX ();
11339 record_unwind_protect (unwind_redisplay
,
11340 Fcons (make_number (redisplaying_p
), selected_frame
));
11342 specbind (Qinhibit_free_realized_faces
, Qnil
);
11345 Lisp_Object tail
, frame
;
11347 FOR_EACH_FRAME (tail
, frame
)
11349 struct frame
*f
= XFRAME (frame
);
11350 f
->already_hscrolled_p
= 0;
11355 if (!EQ (old_frame
, selected_frame
)
11356 && FRAME_LIVE_P (XFRAME (old_frame
)))
11357 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11358 selected_frame and selected_window to be temporarily out-of-sync so
11359 when we come back here via `goto retry', we need to resync because we
11360 may need to run Elisp code (via prepare_menu_bars). */
11361 select_frame_for_redisplay (old_frame
);
11364 reconsider_clip_changes (w
, current_buffer
);
11365 last_escape_glyph_frame
= NULL
;
11366 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11368 /* If new fonts have been loaded that make a glyph matrix adjustment
11369 necessary, do it. */
11370 if (fonts_changed_p
)
11372 adjust_glyphs (NULL
);
11373 ++windows_or_buffers_changed
;
11374 fonts_changed_p
= 0;
11377 /* If face_change_count is non-zero, init_iterator will free all
11378 realized faces, which includes the faces referenced from current
11379 matrices. So, we can't reuse current matrices in this case. */
11380 if (face_change_count
)
11381 ++windows_or_buffers_changed
;
11383 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11384 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11386 /* Since frames on a single ASCII terminal share the same
11387 display area, displaying a different frame means redisplay
11388 the whole thing. */
11389 windows_or_buffers_changed
++;
11390 SET_FRAME_GARBAGED (sf
);
11392 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11394 FRAME_TTY (sf
)->previous_frame
= sf
;
11397 /* Set the visible flags for all frames. Do this before checking
11398 for resized or garbaged frames; they want to know if their frames
11399 are visible. See the comment in frame.h for
11400 FRAME_SAMPLE_VISIBILITY. */
11402 Lisp_Object tail
, frame
;
11404 number_of_visible_frames
= 0;
11406 FOR_EACH_FRAME (tail
, frame
)
11408 struct frame
*f
= XFRAME (frame
);
11410 FRAME_SAMPLE_VISIBILITY (f
);
11411 if (FRAME_VISIBLE_P (f
))
11412 ++number_of_visible_frames
;
11413 clear_desired_matrices (f
);
11418 /* Notice any pending interrupt request to change frame size. */
11419 do_pending_window_change (1);
11421 /* Clear frames marked as garbaged. */
11422 if (frame_garbaged
)
11423 clear_garbaged_frames ();
11425 /* Build menubar and tool-bar items. */
11426 if (NILP (Vmemory_full
))
11427 prepare_menu_bars ();
11429 if (windows_or_buffers_changed
)
11430 update_mode_lines
++;
11432 /* Detect case that we need to write or remove a star in the mode line. */
11433 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11435 w
->update_mode_line
= Qt
;
11436 if (buffer_shared
> 1)
11437 update_mode_lines
++;
11440 /* Avoid invocation of point motion hooks by `current_column' below. */
11441 count1
= SPECPDL_INDEX ();
11442 specbind (Qinhibit_point_motion_hooks
, Qt
);
11444 /* If %c is in the mode line, update it if needed. */
11445 if (!NILP (w
->column_number_displayed
)
11446 /* This alternative quickly identifies a common case
11447 where no change is needed. */
11448 && !(PT
== XFASTINT (w
->last_point
)
11449 && XFASTINT (w
->last_modified
) >= MODIFF
11450 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11451 && (XFASTINT (w
->column_number_displayed
)
11452 != (int) current_column ())) /* iftc */
11453 w
->update_mode_line
= Qt
;
11455 unbind_to (count1
, Qnil
);
11457 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11459 /* The variable buffer_shared is set in redisplay_window and
11460 indicates that we redisplay a buffer in different windows. See
11462 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11463 || cursor_type_changed
);
11465 /* If specs for an arrow have changed, do thorough redisplay
11466 to ensure we remove any arrow that should no longer exist. */
11467 if (overlay_arrows_changed_p ())
11468 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11470 /* Normally the message* functions will have already displayed and
11471 updated the echo area, but the frame may have been trashed, or
11472 the update may have been preempted, so display the echo area
11473 again here. Checking message_cleared_p captures the case that
11474 the echo area should be cleared. */
11475 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11476 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11477 || (message_cleared_p
11478 && minibuf_level
== 0
11479 /* If the mini-window is currently selected, this means the
11480 echo-area doesn't show through. */
11481 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11483 int window_height_changed_p
= echo_area_display (0);
11486 /* If we don't display the current message, don't clear the
11487 message_cleared_p flag, because, if we did, we wouldn't clear
11488 the echo area in the next redisplay which doesn't preserve
11490 if (!display_last_displayed_message_p
)
11491 message_cleared_p
= 0;
11493 if (fonts_changed_p
)
11495 else if (window_height_changed_p
)
11497 consider_all_windows_p
= 1;
11498 ++update_mode_lines
;
11499 ++windows_or_buffers_changed
;
11501 /* If window configuration was changed, frames may have been
11502 marked garbaged. Clear them or we will experience
11503 surprises wrt scrolling. */
11504 if (frame_garbaged
)
11505 clear_garbaged_frames ();
11508 else if (EQ (selected_window
, minibuf_window
)
11509 && (current_buffer
->clip_changed
11510 || XFASTINT (w
->last_modified
) < MODIFF
11511 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11512 && resize_mini_window (w
, 0))
11514 /* Resized active mini-window to fit the size of what it is
11515 showing if its contents might have changed. */
11517 /* FIXME: this causes all frames to be updated, which seems unnecessary
11518 since only the current frame needs to be considered. This function needs
11519 to be rewritten with two variables, consider_all_windows and
11520 consider_all_frames. */
11521 consider_all_windows_p
= 1;
11522 ++windows_or_buffers_changed
;
11523 ++update_mode_lines
;
11525 /* If window configuration was changed, frames may have been
11526 marked garbaged. Clear them or we will experience
11527 surprises wrt scrolling. */
11528 if (frame_garbaged
)
11529 clear_garbaged_frames ();
11533 /* If showing the region, and mark has changed, we must redisplay
11534 the whole window. The assignment to this_line_start_pos prevents
11535 the optimization directly below this if-statement. */
11536 if (((!NILP (Vtransient_mark_mode
)
11537 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11538 != !NILP (w
->region_showing
))
11539 || (!NILP (w
->region_showing
)
11540 && !EQ (w
->region_showing
,
11541 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11542 CHARPOS (this_line_start_pos
) = 0;
11544 /* Optimize the case that only the line containing the cursor in the
11545 selected window has changed. Variables starting with this_ are
11546 set in display_line and record information about the line
11547 containing the cursor. */
11548 tlbufpos
= this_line_start_pos
;
11549 tlendpos
= this_line_end_pos
;
11550 if (!consider_all_windows_p
11551 && CHARPOS (tlbufpos
) > 0
11552 && NILP (w
->update_mode_line
)
11553 && !current_buffer
->clip_changed
11554 && !current_buffer
->prevent_redisplay_optimizations_p
11555 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11556 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11557 /* Make sure recorded data applies to current buffer, etc. */
11558 && this_line_buffer
== current_buffer
11559 && current_buffer
== XBUFFER (w
->buffer
)
11560 && NILP (w
->force_start
)
11561 && NILP (w
->optional_new_start
)
11562 /* Point must be on the line that we have info recorded about. */
11563 && PT
>= CHARPOS (tlbufpos
)
11564 && PT
<= Z
- CHARPOS (tlendpos
)
11565 /* All text outside that line, including its final newline,
11566 must be unchanged */
11567 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11568 CHARPOS (tlendpos
)))
11570 if (CHARPOS (tlbufpos
) > BEGV
11571 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11572 && (CHARPOS (tlbufpos
) == ZV
11573 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11574 /* Former continuation line has disappeared by becoming empty */
11576 else if (XFASTINT (w
->last_modified
) < MODIFF
11577 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11578 || MINI_WINDOW_P (w
))
11580 /* We have to handle the case of continuation around a
11581 wide-column character (See the comment in indent.c around
11584 For instance, in the following case:
11586 -------- Insert --------
11587 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11588 J_I_ ==> J_I_ `^^' are cursors.
11592 As we have to redraw the line above, we should goto cancel. */
11595 int line_height_before
= this_line_pixel_height
;
11597 /* Note that start_display will handle the case that the
11598 line starting at tlbufpos is a continuation lines. */
11599 start_display (&it
, w
, tlbufpos
);
11601 /* Implementation note: It this still necessary? */
11602 if (it
.current_x
!= this_line_start_x
)
11605 TRACE ((stderr
, "trying display optimization 1\n"));
11606 w
->cursor
.vpos
= -1;
11607 overlay_arrow_seen
= 0;
11608 it
.vpos
= this_line_vpos
;
11609 it
.current_y
= this_line_y
;
11610 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11611 display_line (&it
);
11613 /* If line contains point, is not continued,
11614 and ends at same distance from eob as before, we win */
11615 if (w
->cursor
.vpos
>= 0
11616 /* Line is not continued, otherwise this_line_start_pos
11617 would have been set to 0 in display_line. */
11618 && CHARPOS (this_line_start_pos
)
11619 /* Line ends as before. */
11620 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11621 /* Line has same height as before. Otherwise other lines
11622 would have to be shifted up or down. */
11623 && this_line_pixel_height
== line_height_before
)
11625 /* If this is not the window's last line, we must adjust
11626 the charstarts of the lines below. */
11627 if (it
.current_y
< it
.last_visible_y
)
11629 struct glyph_row
*row
11630 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11631 int delta
, delta_bytes
;
11633 if (Z
- CHARPOS (tlendpos
) == ZV
)
11635 /* This line ends at end of (accessible part of)
11636 buffer. There is no newline to count. */
11638 - CHARPOS (tlendpos
)
11639 - MATRIX_ROW_START_CHARPOS (row
));
11640 delta_bytes
= (Z_BYTE
11641 - BYTEPOS (tlendpos
)
11642 - MATRIX_ROW_START_BYTEPOS (row
));
11646 /* This line ends in a newline. Must take
11647 account of the newline and the rest of the
11648 text that follows. */
11650 - CHARPOS (tlendpos
)
11651 - MATRIX_ROW_START_CHARPOS (row
));
11652 delta_bytes
= (Z_BYTE
11653 - BYTEPOS (tlendpos
)
11654 - MATRIX_ROW_START_BYTEPOS (row
));
11657 increment_matrix_positions (w
->current_matrix
,
11658 this_line_vpos
+ 1,
11659 w
->current_matrix
->nrows
,
11660 delta
, delta_bytes
);
11663 /* If this row displays text now but previously didn't,
11664 or vice versa, w->window_end_vpos may have to be
11666 if ((it
.glyph_row
- 1)->displays_text_p
)
11668 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11669 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11671 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11672 && this_line_vpos
> 0)
11673 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11674 w
->window_end_valid
= Qnil
;
11676 /* Update hint: No need to try to scroll in update_window. */
11677 w
->desired_matrix
->no_scrolling_p
= 1;
11680 *w
->desired_matrix
->method
= 0;
11681 debug_method_add (w
, "optimization 1");
11683 #ifdef HAVE_WINDOW_SYSTEM
11684 update_window_fringes (w
, 0);
11691 else if (/* Cursor position hasn't changed. */
11692 PT
== XFASTINT (w
->last_point
)
11693 /* Make sure the cursor was last displayed
11694 in this window. Otherwise we have to reposition it. */
11695 && 0 <= w
->cursor
.vpos
11696 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11700 do_pending_window_change (1);
11702 /* We used to always goto end_of_redisplay here, but this
11703 isn't enough if we have a blinking cursor. */
11704 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11705 goto end_of_redisplay
;
11709 /* If highlighting the region, or if the cursor is in the echo area,
11710 then we can't just move the cursor. */
11711 else if (! (!NILP (Vtransient_mark_mode
)
11712 && !NILP (current_buffer
->mark_active
))
11713 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11714 || highlight_nonselected_windows
)
11715 && NILP (w
->region_showing
)
11716 && NILP (Vshow_trailing_whitespace
)
11717 && !cursor_in_echo_area
)
11720 struct glyph_row
*row
;
11722 /* Skip from tlbufpos to PT and see where it is. Note that
11723 PT may be in invisible text. If so, we will end at the
11724 next visible position. */
11725 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11726 NULL
, DEFAULT_FACE_ID
);
11727 it
.current_x
= this_line_start_x
;
11728 it
.current_y
= this_line_y
;
11729 it
.vpos
= this_line_vpos
;
11731 /* The call to move_it_to stops in front of PT, but
11732 moves over before-strings. */
11733 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11735 if (it
.vpos
== this_line_vpos
11736 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11739 xassert (this_line_vpos
== it
.vpos
);
11740 xassert (this_line_y
== it
.current_y
);
11741 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11743 *w
->desired_matrix
->method
= 0;
11744 debug_method_add (w
, "optimization 3");
11753 /* Text changed drastically or point moved off of line. */
11754 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11757 CHARPOS (this_line_start_pos
) = 0;
11758 consider_all_windows_p
|= buffer_shared
> 1;
11759 ++clear_face_cache_count
;
11760 #ifdef HAVE_WINDOW_SYSTEM
11761 ++clear_image_cache_count
;
11764 /* Build desired matrices, and update the display. If
11765 consider_all_windows_p is non-zero, do it for all windows on all
11766 frames. Otherwise do it for selected_window, only. */
11768 if (consider_all_windows_p
)
11770 Lisp_Object tail
, frame
;
11772 FOR_EACH_FRAME (tail
, frame
)
11773 XFRAME (frame
)->updated_p
= 0;
11775 /* Recompute # windows showing selected buffer. This will be
11776 incremented each time such a window is displayed. */
11779 FOR_EACH_FRAME (tail
, frame
)
11781 struct frame
*f
= XFRAME (frame
);
11783 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11785 if (! EQ (frame
, selected_frame
))
11786 /* Select the frame, for the sake of frame-local
11788 select_frame_for_redisplay (frame
);
11790 /* Mark all the scroll bars to be removed; we'll redeem
11791 the ones we want when we redisplay their windows. */
11792 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11793 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11795 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11796 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11798 /* Any scroll bars which redisplay_windows should have
11799 nuked should now go away. */
11800 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11801 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11803 /* If fonts changed, display again. */
11804 /* ??? rms: I suspect it is a mistake to jump all the way
11805 back to retry here. It should just retry this frame. */
11806 if (fonts_changed_p
)
11809 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11811 /* See if we have to hscroll. */
11812 if (!f
->already_hscrolled_p
)
11814 f
->already_hscrolled_p
= 1;
11815 if (hscroll_windows (f
->root_window
))
11819 /* Prevent various kinds of signals during display
11820 update. stdio is not robust about handling
11821 signals, which can cause an apparent I/O
11823 if (interrupt_input
)
11824 unrequest_sigio ();
11827 /* Update the display. */
11828 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11829 pause
|= update_frame (f
, 0, 0);
11835 if (!EQ (old_frame
, selected_frame
)
11836 && FRAME_LIVE_P (XFRAME (old_frame
)))
11837 /* We played a bit fast-and-loose above and allowed selected_frame
11838 and selected_window to be temporarily out-of-sync but let's make
11839 sure this stays contained. */
11840 select_frame_for_redisplay (old_frame
);
11841 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11845 /* Do the mark_window_display_accurate after all windows have
11846 been redisplayed because this call resets flags in buffers
11847 which are needed for proper redisplay. */
11848 FOR_EACH_FRAME (tail
, frame
)
11850 struct frame
*f
= XFRAME (frame
);
11853 mark_window_display_accurate (f
->root_window
, 1);
11854 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11855 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11860 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11862 Lisp_Object mini_window
;
11863 struct frame
*mini_frame
;
11865 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11866 /* Use list_of_error, not Qerror, so that
11867 we catch only errors and don't run the debugger. */
11868 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11870 redisplay_window_error
);
11872 /* Compare desired and current matrices, perform output. */
11875 /* If fonts changed, display again. */
11876 if (fonts_changed_p
)
11879 /* Prevent various kinds of signals during display update.
11880 stdio is not robust about handling signals,
11881 which can cause an apparent I/O error. */
11882 if (interrupt_input
)
11883 unrequest_sigio ();
11886 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11888 if (hscroll_windows (selected_window
))
11891 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11892 pause
= update_frame (sf
, 0, 0);
11895 /* We may have called echo_area_display at the top of this
11896 function. If the echo area is on another frame, that may
11897 have put text on a frame other than the selected one, so the
11898 above call to update_frame would not have caught it. Catch
11900 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11901 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11903 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11905 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11906 pause
|= update_frame (mini_frame
, 0, 0);
11907 if (!pause
&& hscroll_windows (mini_window
))
11912 /* If display was paused because of pending input, make sure we do a
11913 thorough update the next time. */
11916 /* Prevent the optimization at the beginning of
11917 redisplay_internal that tries a single-line update of the
11918 line containing the cursor in the selected window. */
11919 CHARPOS (this_line_start_pos
) = 0;
11921 /* Let the overlay arrow be updated the next time. */
11922 update_overlay_arrows (0);
11924 /* If we pause after scrolling, some rows in the current
11925 matrices of some windows are not valid. */
11926 if (!WINDOW_FULL_WIDTH_P (w
)
11927 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11928 update_mode_lines
= 1;
11932 if (!consider_all_windows_p
)
11934 /* This has already been done above if
11935 consider_all_windows_p is set. */
11936 mark_window_display_accurate_1 (w
, 1);
11938 /* Say overlay arrows are up to date. */
11939 update_overlay_arrows (1);
11941 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11942 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11945 update_mode_lines
= 0;
11946 windows_or_buffers_changed
= 0;
11947 cursor_type_changed
= 0;
11950 /* Start SIGIO interrupts coming again. Having them off during the
11951 code above makes it less likely one will discard output, but not
11952 impossible, since there might be stuff in the system buffer here.
11953 But it is much hairier to try to do anything about that. */
11954 if (interrupt_input
)
11958 /* If a frame has become visible which was not before, redisplay
11959 again, so that we display it. Expose events for such a frame
11960 (which it gets when becoming visible) don't call the parts of
11961 redisplay constructing glyphs, so simply exposing a frame won't
11962 display anything in this case. So, we have to display these
11963 frames here explicitly. */
11966 Lisp_Object tail
, frame
;
11969 FOR_EACH_FRAME (tail
, frame
)
11971 int this_is_visible
= 0;
11973 if (XFRAME (frame
)->visible
)
11974 this_is_visible
= 1;
11975 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
11976 if (XFRAME (frame
)->visible
)
11977 this_is_visible
= 1;
11979 if (this_is_visible
)
11983 if (new_count
!= number_of_visible_frames
)
11984 windows_or_buffers_changed
++;
11987 /* Change frame size now if a change is pending. */
11988 do_pending_window_change (1);
11990 /* If we just did a pending size change, or have additional
11991 visible frames, redisplay again. */
11992 if (windows_or_buffers_changed
&& !pause
)
11995 /* Clear the face cache eventually. */
11996 if (consider_all_windows_p
)
11998 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12000 clear_face_cache (0);
12001 clear_face_cache_count
= 0;
12003 #ifdef HAVE_WINDOW_SYSTEM
12004 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12006 clear_image_caches (Qnil
);
12007 clear_image_cache_count
= 0;
12009 #endif /* HAVE_WINDOW_SYSTEM */
12013 unbind_to (count
, Qnil
);
12018 /* Redisplay, but leave alone any recent echo area message unless
12019 another message has been requested in its place.
12021 This is useful in situations where you need to redisplay but no
12022 user action has occurred, making it inappropriate for the message
12023 area to be cleared. See tracking_off and
12024 wait_reading_process_output for examples of these situations.
12026 FROM_WHERE is an integer saying from where this function was
12027 called. This is useful for debugging. */
12030 redisplay_preserve_echo_area (from_where
)
12033 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12035 if (!NILP (echo_area_buffer
[1]))
12037 /* We have a previously displayed message, but no current
12038 message. Redisplay the previous message. */
12039 display_last_displayed_message_p
= 1;
12040 redisplay_internal (1);
12041 display_last_displayed_message_p
= 0;
12044 redisplay_internal (1);
12046 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12047 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12048 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12052 /* Function registered with record_unwind_protect in
12053 redisplay_internal. Reset redisplaying_p to the value it had
12054 before redisplay_internal was called, and clear
12055 prevent_freeing_realized_faces_p. It also selects the previously
12056 selected frame, unless it has been deleted (by an X connection
12057 failure during redisplay, for example). */
12060 unwind_redisplay (val
)
12063 Lisp_Object old_redisplaying_p
, old_frame
;
12065 old_redisplaying_p
= XCAR (val
);
12066 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12067 old_frame
= XCDR (val
);
12068 if (! EQ (old_frame
, selected_frame
)
12069 && FRAME_LIVE_P (XFRAME (old_frame
)))
12070 select_frame_for_redisplay (old_frame
);
12075 /* Mark the display of window W as accurate or inaccurate. If
12076 ACCURATE_P is non-zero mark display of W as accurate. If
12077 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12078 redisplay_internal is called. */
12081 mark_window_display_accurate_1 (w
, accurate_p
)
12085 if (BUFFERP (w
->buffer
))
12087 struct buffer
*b
= XBUFFER (w
->buffer
);
12090 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12091 w
->last_overlay_modified
12092 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12094 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12098 b
->clip_changed
= 0;
12099 b
->prevent_redisplay_optimizations_p
= 0;
12101 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12102 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12103 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12104 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12106 w
->current_matrix
->buffer
= b
;
12107 w
->current_matrix
->begv
= BUF_BEGV (b
);
12108 w
->current_matrix
->zv
= BUF_ZV (b
);
12110 w
->last_cursor
= w
->cursor
;
12111 w
->last_cursor_off_p
= w
->cursor_off_p
;
12113 if (w
== XWINDOW (selected_window
))
12114 w
->last_point
= make_number (BUF_PT (b
));
12116 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12122 w
->window_end_valid
= w
->buffer
;
12123 w
->update_mode_line
= Qnil
;
12128 /* Mark the display of windows in the window tree rooted at WINDOW as
12129 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12130 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12131 be redisplayed the next time redisplay_internal is called. */
12134 mark_window_display_accurate (window
, accurate_p
)
12135 Lisp_Object window
;
12140 for (; !NILP (window
); window
= w
->next
)
12142 w
= XWINDOW (window
);
12143 mark_window_display_accurate_1 (w
, accurate_p
);
12145 if (!NILP (w
->vchild
))
12146 mark_window_display_accurate (w
->vchild
, accurate_p
);
12147 if (!NILP (w
->hchild
))
12148 mark_window_display_accurate (w
->hchild
, accurate_p
);
12153 update_overlay_arrows (1);
12157 /* Force a thorough redisplay the next time by setting
12158 last_arrow_position and last_arrow_string to t, which is
12159 unequal to any useful value of Voverlay_arrow_... */
12160 update_overlay_arrows (-1);
12165 /* Return value in display table DP (Lisp_Char_Table *) for character
12166 C. Since a display table doesn't have any parent, we don't have to
12167 follow parent. Do not call this function directly but use the
12168 macro DISP_CHAR_VECTOR. */
12171 disp_char_vector (dp
, c
)
12172 struct Lisp_Char_Table
*dp
;
12177 if (ASCII_CHAR_P (c
))
12180 if (SUB_CHAR_TABLE_P (val
))
12181 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12187 XSETCHAR_TABLE (table
, dp
);
12188 val
= char_table_ref (table
, c
);
12197 /***********************************************************************
12199 ***********************************************************************/
12201 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12204 redisplay_windows (window
)
12205 Lisp_Object window
;
12207 while (!NILP (window
))
12209 struct window
*w
= XWINDOW (window
);
12211 if (!NILP (w
->hchild
))
12212 redisplay_windows (w
->hchild
);
12213 else if (!NILP (w
->vchild
))
12214 redisplay_windows (w
->vchild
);
12217 displayed_buffer
= XBUFFER (w
->buffer
);
12218 /* Use list_of_error, not Qerror, so that
12219 we catch only errors and don't run the debugger. */
12220 internal_condition_case_1 (redisplay_window_0
, window
,
12222 redisplay_window_error
);
12230 redisplay_window_error ()
12232 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12237 redisplay_window_0 (window
)
12238 Lisp_Object window
;
12240 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12241 redisplay_window (window
, 0);
12246 redisplay_window_1 (window
)
12247 Lisp_Object window
;
12249 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12250 redisplay_window (window
, 1);
12255 /* Increment GLYPH until it reaches END or CONDITION fails while
12256 adding (GLYPH)->pixel_width to X. */
12258 #define SKIP_GLYPHS(glyph, end, x, condition) \
12261 (x) += (glyph)->pixel_width; \
12264 while ((glyph) < (end) && (condition))
12267 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12268 DELTA is the number of bytes by which positions recorded in ROW
12269 differ from current buffer positions.
12271 Return 0 if cursor is not on this row. 1 otherwise. */
12274 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12276 struct glyph_row
*row
;
12277 struct glyph_matrix
*matrix
;
12278 int delta
, delta_bytes
, dy
, dvpos
;
12280 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12281 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12282 struct glyph
*cursor
= NULL
;
12283 /* The first glyph that starts a sequence of glyphs from string. */
12284 struct glyph
*string_start
;
12285 /* The X coordinate of string_start. */
12286 int string_start_x
;
12287 /* The last known character position. */
12288 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12289 /* The last known character position before string_start. */
12290 int string_before_pos
;
12293 int cursor_from_overlay_pos
= 0;
12294 int pt_old
= PT
- delta
;
12296 /* Skip over glyphs not having an object at the start of the row.
12297 These are special glyphs like truncation marks on terminal
12299 if (row
->displays_text_p
)
12301 && INTEGERP (glyph
->object
)
12302 && glyph
->charpos
< 0)
12304 x
+= glyph
->pixel_width
;
12308 string_start
= NULL
;
12310 && !INTEGERP (glyph
->object
)
12311 && (!BUFFERP (glyph
->object
)
12312 || (last_pos
= glyph
->charpos
) < pt_old
12313 || glyph
->avoid_cursor_p
))
12315 if (! STRINGP (glyph
->object
))
12317 string_start
= NULL
;
12318 x
+= glyph
->pixel_width
;
12320 if (cursor_from_overlay_pos
12321 && last_pos
>= cursor_from_overlay_pos
)
12323 cursor_from_overlay_pos
= 0;
12329 if (string_start
== NULL
)
12331 string_before_pos
= last_pos
;
12332 string_start
= glyph
;
12333 string_start_x
= x
;
12335 /* Skip all glyphs from string. */
12340 if ((cursor
== NULL
|| glyph
> cursor
)
12341 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12342 Qcursor
, (glyph
)->object
),
12344 && (pos
= string_buffer_position (w
, glyph
->object
,
12345 string_before_pos
),
12346 (pos
== 0 /* From overlay */
12347 || pos
== pt_old
)))
12349 /* Estimate overlay buffer position from the buffer
12350 positions of the glyphs before and after the overlay.
12351 Add 1 to last_pos so that if point corresponds to the
12352 glyph right after the overlay, we still use a 'cursor'
12353 property found in that overlay. */
12354 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12355 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12359 x
+= glyph
->pixel_width
;
12362 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12366 if (cursor
!= NULL
)
12371 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12373 /* Scan back over the ellipsis glyphs, decrementing positions. */
12374 while (glyph
> row
->glyphs
[TEXT_AREA
]
12375 && (glyph
- 1)->charpos
== last_pos
)
12376 glyph
--, x
-= glyph
->pixel_width
;
12377 /* That loop always goes one position too far,
12378 including the glyph before the ellipsis.
12379 So scan forward over that one. */
12380 x
+= glyph
->pixel_width
;
12383 else if (string_start
12384 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12386 /* We may have skipped over point because the previous glyphs
12387 are from string. As there's no easy way to know the
12388 character position of the current glyph, find the correct
12389 glyph on point by scanning from string_start again. */
12391 Lisp_Object string
;
12392 struct glyph
*stop
= glyph
;
12395 limit
= make_number (pt_old
+ 1);
12396 glyph
= string_start
;
12397 x
= string_start_x
;
12398 string
= glyph
->object
;
12399 pos
= string_buffer_position (w
, string
, string_before_pos
);
12400 /* If STRING is from overlay, LAST_POS == 0. We skip such glyphs
12401 because we always put cursor after overlay strings. */
12402 while (pos
== 0 && glyph
< stop
)
12404 string
= glyph
->object
;
12405 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12407 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12410 while (glyph
< stop
)
12412 pos
= XINT (Fnext_single_char_property_change
12413 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12416 /* Skip glyphs from the same string. */
12417 string
= glyph
->object
;
12418 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12419 /* Skip glyphs from an overlay. */
12420 while (glyph
< stop
12421 && ! string_buffer_position (w
, glyph
->object
, pos
))
12423 string
= glyph
->object
;
12424 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12428 /* If we reached the end of the line, and end was from a string,
12429 cursor is not on this line. */
12430 if (glyph
== end
&& row
->continued_p
)
12434 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12436 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12437 w
->cursor
.y
= row
->y
+ dy
;
12439 if (w
== XWINDOW (selected_window
))
12441 if (!row
->continued_p
12442 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12445 this_line_buffer
= XBUFFER (w
->buffer
);
12447 CHARPOS (this_line_start_pos
)
12448 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12449 BYTEPOS (this_line_start_pos
)
12450 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12452 CHARPOS (this_line_end_pos
)
12453 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12454 BYTEPOS (this_line_end_pos
)
12455 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12457 this_line_y
= w
->cursor
.y
;
12458 this_line_pixel_height
= row
->height
;
12459 this_line_vpos
= w
->cursor
.vpos
;
12460 this_line_start_x
= row
->x
;
12463 CHARPOS (this_line_start_pos
) = 0;
12470 /* Run window scroll functions, if any, for WINDOW with new window
12471 start STARTP. Sets the window start of WINDOW to that position.
12473 We assume that the window's buffer is really current. */
12475 static INLINE
struct text_pos
12476 run_window_scroll_functions (window
, startp
)
12477 Lisp_Object window
;
12478 struct text_pos startp
;
12480 struct window
*w
= XWINDOW (window
);
12481 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12483 if (current_buffer
!= XBUFFER (w
->buffer
))
12486 if (!NILP (Vwindow_scroll_functions
))
12488 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12489 make_number (CHARPOS (startp
)));
12490 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12491 /* In case the hook functions switch buffers. */
12492 if (current_buffer
!= XBUFFER (w
->buffer
))
12493 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12500 /* Make sure the line containing the cursor is fully visible.
12501 A value of 1 means there is nothing to be done.
12502 (Either the line is fully visible, or it cannot be made so,
12503 or we cannot tell.)
12505 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12506 is higher than window.
12508 A value of 0 means the caller should do scrolling
12509 as if point had gone off the screen. */
12512 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12515 int current_matrix_p
;
12517 struct glyph_matrix
*matrix
;
12518 struct glyph_row
*row
;
12521 if (!make_cursor_line_fully_visible_p
)
12524 /* It's not always possible to find the cursor, e.g, when a window
12525 is full of overlay strings. Don't do anything in that case. */
12526 if (w
->cursor
.vpos
< 0)
12529 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12530 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12532 /* If the cursor row is not partially visible, there's nothing to do. */
12533 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12536 /* If the row the cursor is in is taller than the window's height,
12537 it's not clear what to do, so do nothing. */
12538 window_height
= window_box_height (w
);
12539 if (row
->height
>= window_height
)
12541 if (!force_p
|| MINI_WINDOW_P (w
)
12542 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12548 /* This code used to try to scroll the window just enough to make
12549 the line visible. It returned 0 to say that the caller should
12550 allocate larger glyph matrices. */
12552 if (MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (w
, row
))
12554 int dy
= row
->height
- row
->visible_height
;
12557 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12559 else /* MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P (w, row)) */
12561 int dy
= - (row
->height
- row
->visible_height
);
12564 shift_glyph_matrix (w
, matrix
, 0, matrix
->nrows
, dy
);
12567 /* When we change the cursor y-position of the selected window,
12568 change this_line_y as well so that the display optimization for
12569 the cursor line of the selected window in redisplay_internal uses
12570 the correct y-position. */
12571 if (w
== XWINDOW (selected_window
))
12572 this_line_y
= w
->cursor
.y
;
12574 /* If vscrolling requires a larger glyph matrix, arrange for a fresh
12575 redisplay with larger matrices. */
12576 if (matrix
->nrows
< required_matrix_height (w
))
12578 fonts_changed_p
= 1;
12587 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12588 non-zero means only WINDOW is redisplayed in redisplay_internal.
12589 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12590 in redisplay_window to bring a partially visible line into view in
12591 the case that only the cursor has moved.
12593 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12594 last screen line's vertical height extends past the end of the screen.
12598 1 if scrolling succeeded
12600 0 if scrolling didn't find point.
12602 -1 if new fonts have been loaded so that we must interrupt
12603 redisplay, adjust glyph matrices, and try again. */
12609 SCROLLING_NEED_LARGER_MATRICES
12613 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12614 scroll_step
, temp_scroll_step
, last_line_misfit
)
12615 Lisp_Object window
;
12616 int just_this_one_p
;
12617 EMACS_INT scroll_conservatively
, scroll_step
;
12618 int temp_scroll_step
;
12619 int last_line_misfit
;
12621 struct window
*w
= XWINDOW (window
);
12622 struct frame
*f
= XFRAME (w
->frame
);
12623 struct text_pos pos
, startp
;
12625 int this_scroll_margin
, scroll_max
, rc
, height
;
12626 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12627 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12628 Lisp_Object aggressive
;
12629 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12632 debug_method_add (w
, "try_scrolling");
12635 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12637 /* Compute scroll margin height in pixels. We scroll when point is
12638 within this distance from the top or bottom of the window. */
12639 if (scroll_margin
> 0)
12640 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
12641 * FRAME_LINE_HEIGHT (f
);
12643 this_scroll_margin
= 0;
12645 /* Force scroll_conservatively to have a reasonable value, to avoid
12646 overflow while computing how much to scroll. Note that the user
12647 can supply scroll-conservatively equal to `most-positive-fixnum',
12648 which can be larger than INT_MAX. */
12649 if (scroll_conservatively
> scroll_limit
)
12651 scroll_conservatively
= scroll_limit
;
12652 scroll_max
= INT_MAX
;
12654 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12655 /* Compute how much we should try to scroll maximally to bring
12656 point into view. */
12657 scroll_max
= (max (scroll_step
,
12658 max (scroll_conservatively
, temp_scroll_step
))
12659 * FRAME_LINE_HEIGHT (f
));
12660 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12661 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12662 /* We're trying to scroll because of aggressive scrolling but no
12663 scroll_step is set. Choose an arbitrary one. */
12664 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
12670 /* Decide whether to scroll down. */
12671 if (PT
> CHARPOS (startp
))
12673 int scroll_margin_y
;
12675 /* Compute the pixel ypos of the scroll margin, then move it to
12676 either that ypos or PT, whichever comes first. */
12677 start_display (&it
, w
, startp
);
12678 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
12679 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
12680 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
12681 (MOVE_TO_POS
| MOVE_TO_Y
));
12683 if (PT
> CHARPOS (it
.current
.pos
))
12685 int y0
= line_bottom_y (&it
);
12687 /* Compute the distance from the scroll margin to PT
12688 (including the height of the cursor line). Moving the
12689 iterator unconditionally to PT can be slow if PT is far
12690 away, so stop 10 lines past the window bottom (is there a
12691 way to do the right thing quickly?). */
12692 move_it_to (&it
, PT
, -1,
12693 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
12694 -1, MOVE_TO_POS
| MOVE_TO_Y
);
12695 dy
= line_bottom_y (&it
) - y0
;
12697 if (dy
> scroll_max
)
12698 return SCROLLING_FAILED
;
12706 /* Point is in or below the bottom scroll margin, so move the
12707 window start down. If scrolling conservatively, move it just
12708 enough down to make point visible. If scroll_step is set,
12709 move it down by scroll_step. */
12710 if (scroll_conservatively
)
12712 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12713 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12714 else if (scroll_step
|| temp_scroll_step
)
12715 amount_to_scroll
= scroll_max
;
12718 aggressive
= current_buffer
->scroll_up_aggressively
;
12719 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12720 if (NUMBERP (aggressive
))
12722 double float_amount
= XFLOATINT (aggressive
) * height
;
12723 amount_to_scroll
= float_amount
;
12724 if (amount_to_scroll
== 0 && float_amount
> 0)
12725 amount_to_scroll
= 1;
12729 if (amount_to_scroll
<= 0)
12730 return SCROLLING_FAILED
;
12732 start_display (&it
, w
, startp
);
12733 move_it_vertically (&it
, amount_to_scroll
);
12735 /* If STARTP is unchanged, move it down another screen line. */
12736 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12737 move_it_by_lines (&it
, 1, 1);
12738 startp
= it
.current
.pos
;
12742 struct text_pos scroll_margin_pos
= startp
;
12744 /* See if point is inside the scroll margin at the top of the
12746 if (this_scroll_margin
)
12748 start_display (&it
, w
, startp
);
12749 move_it_vertically (&it
, this_scroll_margin
);
12750 scroll_margin_pos
= it
.current
.pos
;
12753 if (PT
< CHARPOS (scroll_margin_pos
))
12755 /* Point is in the scroll margin at the top of the window or
12756 above what is displayed in the window. */
12759 /* Compute the vertical distance from PT to the scroll
12760 margin position. Give up if distance is greater than
12762 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12763 start_display (&it
, w
, pos
);
12765 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12766 it
.last_visible_y
, -1,
12767 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12768 dy
= it
.current_y
- y0
;
12769 if (dy
> scroll_max
)
12770 return SCROLLING_FAILED
;
12772 /* Compute new window start. */
12773 start_display (&it
, w
, startp
);
12775 if (scroll_conservatively
)
12777 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12778 else if (scroll_step
|| temp_scroll_step
)
12779 amount_to_scroll
= scroll_max
;
12782 aggressive
= current_buffer
->scroll_down_aggressively
;
12783 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12784 if (NUMBERP (aggressive
))
12786 double float_amount
= XFLOATINT (aggressive
) * height
;
12787 amount_to_scroll
= float_amount
;
12788 if (amount_to_scroll
== 0 && float_amount
> 0)
12789 amount_to_scroll
= 1;
12793 if (amount_to_scroll
<= 0)
12794 return SCROLLING_FAILED
;
12796 move_it_vertically_backward (&it
, amount_to_scroll
);
12797 startp
= it
.current
.pos
;
12801 /* Run window scroll functions. */
12802 startp
= run_window_scroll_functions (window
, startp
);
12804 /* Display the window. Give up if new fonts are loaded, or if point
12806 if (!try_window (window
, startp
, 0))
12807 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12808 else if (w
->cursor
.vpos
< 0)
12810 clear_glyph_matrix (w
->desired_matrix
);
12811 rc
= SCROLLING_FAILED
;
12815 /* Maybe forget recorded base line for line number display. */
12816 if (!just_this_one_p
12817 || current_buffer
->clip_changed
12818 || BEG_UNCHANGED
< CHARPOS (startp
))
12819 w
->base_line_number
= Qnil
;
12821 /* If cursor ends up on a partially visible line,
12822 treat that as being off the bottom of the screen. */
12823 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12825 clear_glyph_matrix (w
->desired_matrix
);
12826 ++extra_scroll_margin_lines
;
12829 rc
= SCROLLING_SUCCESS
;
12836 /* Compute a suitable window start for window W if display of W starts
12837 on a continuation line. Value is non-zero if a new window start
12840 The new window start will be computed, based on W's width, starting
12841 from the start of the continued line. It is the start of the
12842 screen line with the minimum distance from the old start W->start. */
12845 compute_window_start_on_continuation_line (w
)
12848 struct text_pos pos
, start_pos
;
12849 int window_start_changed_p
= 0;
12851 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12853 /* If window start is on a continuation line... Window start may be
12854 < BEGV in case there's invisible text at the start of the
12855 buffer (M-x rmail, for example). */
12856 if (CHARPOS (start_pos
) > BEGV
12857 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12860 struct glyph_row
*row
;
12862 /* Handle the case that the window start is out of range. */
12863 if (CHARPOS (start_pos
) < BEGV
)
12864 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12865 else if (CHARPOS (start_pos
) > ZV
)
12866 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12868 /* Find the start of the continued line. This should be fast
12869 because scan_buffer is fast (newline cache). */
12870 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12871 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12872 row
, DEFAULT_FACE_ID
);
12873 reseat_at_previous_visible_line_start (&it
);
12875 /* If the line start is "too far" away from the window start,
12876 say it takes too much time to compute a new window start. */
12877 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12878 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12880 int min_distance
, distance
;
12882 /* Move forward by display lines to find the new window
12883 start. If window width was enlarged, the new start can
12884 be expected to be > the old start. If window width was
12885 decreased, the new window start will be < the old start.
12886 So, we're looking for the display line start with the
12887 minimum distance from the old window start. */
12888 pos
= it
.current
.pos
;
12889 min_distance
= INFINITY
;
12890 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12891 distance
< min_distance
)
12893 min_distance
= distance
;
12894 pos
= it
.current
.pos
;
12895 move_it_by_lines (&it
, 1, 0);
12898 /* Set the window start there. */
12899 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12900 window_start_changed_p
= 1;
12904 return window_start_changed_p
;
12908 /* Try cursor movement in case text has not changed in window WINDOW,
12909 with window start STARTP. Value is
12911 CURSOR_MOVEMENT_SUCCESS if successful
12913 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12915 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12916 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12917 we want to scroll as if scroll-step were set to 1. See the code.
12919 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12920 which case we have to abort this redisplay, and adjust matrices
12925 CURSOR_MOVEMENT_SUCCESS
,
12926 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12927 CURSOR_MOVEMENT_MUST_SCROLL
,
12928 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12932 try_cursor_movement (window
, startp
, scroll_step
)
12933 Lisp_Object window
;
12934 struct text_pos startp
;
12937 struct window
*w
= XWINDOW (window
);
12938 struct frame
*f
= XFRAME (w
->frame
);
12939 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12942 if (inhibit_try_cursor_movement
)
12946 /* Handle case where text has not changed, only point, and it has
12947 not moved off the frame. */
12948 if (/* Point may be in this window. */
12949 PT
>= CHARPOS (startp
)
12950 /* Selective display hasn't changed. */
12951 && !current_buffer
->clip_changed
12952 /* Function force-mode-line-update is used to force a thorough
12953 redisplay. It sets either windows_or_buffers_changed or
12954 update_mode_lines. So don't take a shortcut here for these
12956 && !update_mode_lines
12957 && !windows_or_buffers_changed
12958 && !cursor_type_changed
12959 /* Can't use this case if highlighting a region. When a
12960 region exists, cursor movement has to do more than just
12962 && !(!NILP (Vtransient_mark_mode
)
12963 && !NILP (current_buffer
->mark_active
))
12964 && NILP (w
->region_showing
)
12965 && NILP (Vshow_trailing_whitespace
)
12966 /* Right after splitting windows, last_point may be nil. */
12967 && INTEGERP (w
->last_point
)
12968 /* This code is not used for mini-buffer for the sake of the case
12969 of redisplaying to replace an echo area message; since in
12970 that case the mini-buffer contents per se are usually
12971 unchanged. This code is of no real use in the mini-buffer
12972 since the handling of this_line_start_pos, etc., in redisplay
12973 handles the same cases. */
12974 && !EQ (window
, minibuf_window
)
12975 /* When splitting windows or for new windows, it happens that
12976 redisplay is called with a nil window_end_vpos or one being
12977 larger than the window. This should really be fixed in
12978 window.c. I don't have this on my list, now, so we do
12979 approximately the same as the old redisplay code. --gerd. */
12980 && INTEGERP (w
->window_end_vpos
)
12981 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12982 && (FRAME_WINDOW_P (f
)
12983 || !overlay_arrow_in_current_buffer_p ()))
12985 int this_scroll_margin
, top_scroll_margin
;
12986 struct glyph_row
*row
= NULL
;
12989 debug_method_add (w
, "cursor movement");
12992 /* Scroll if point within this distance from the top or bottom
12993 of the window. This is a pixel value. */
12994 if (scroll_margin
> 0)
12996 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
12997 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13000 this_scroll_margin
= 0;
13002 top_scroll_margin
= this_scroll_margin
;
13003 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13004 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13006 /* Start with the row the cursor was displayed during the last
13007 not paused redisplay. Give up if that row is not valid. */
13008 if (w
->last_cursor
.vpos
< 0
13009 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13010 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13013 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13014 if (row
->mode_line_p
)
13016 if (!row
->enabled_p
)
13017 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13020 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13023 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13025 if (PT
> XFASTINT (w
->last_point
))
13027 /* Point has moved forward. */
13028 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13029 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13031 xassert (row
->enabled_p
);
13035 /* The end position of a row equals the start position
13036 of the next row. If PT is there, we would rather
13037 display it in the next line. */
13038 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13039 && MATRIX_ROW_END_CHARPOS (row
) == PT
13040 && !cursor_row_p (w
, row
))
13043 /* If within the scroll margin, scroll. Note that
13044 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13045 the next line would be drawn, and that
13046 this_scroll_margin can be zero. */
13047 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13048 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13049 /* Line is completely visible last line in window
13050 and PT is to be set in the next line. */
13051 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13052 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13053 && !row
->ends_at_zv_p
13054 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13057 else if (PT
< XFASTINT (w
->last_point
))
13059 /* Cursor has to be moved backward. Note that PT >=
13060 CHARPOS (startp) because of the outer if-statement. */
13061 while (!row
->mode_line_p
13062 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13063 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13064 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13065 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13066 row
> w
->current_matrix
->rows
13067 && (row
-1)->ends_in_newline_from_string_p
))))
13068 && (row
->y
> top_scroll_margin
13069 || CHARPOS (startp
) == BEGV
))
13071 xassert (row
->enabled_p
);
13075 /* Consider the following case: Window starts at BEGV,
13076 there is invisible, intangible text at BEGV, so that
13077 display starts at some point START > BEGV. It can
13078 happen that we are called with PT somewhere between
13079 BEGV and START. Try to handle that case. */
13080 if (row
< w
->current_matrix
->rows
13081 || row
->mode_line_p
)
13083 row
= w
->current_matrix
->rows
;
13084 if (row
->mode_line_p
)
13088 /* Due to newlines in overlay strings, we may have to
13089 skip forward over overlay strings. */
13090 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13091 && MATRIX_ROW_END_CHARPOS (row
) == PT
13092 && !cursor_row_p (w
, row
))
13095 /* If within the scroll margin, scroll. */
13096 if (row
->y
< top_scroll_margin
13097 && CHARPOS (startp
) != BEGV
)
13102 /* Cursor did not move. So don't scroll even if cursor line
13103 is partially visible, as it was so before. */
13104 rc
= CURSOR_MOVEMENT_SUCCESS
;
13107 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13108 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13110 /* if PT is not in the glyph row, give up. */
13111 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13113 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13114 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13115 && make_cursor_line_fully_visible_p
)
13117 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13118 && !row
->ends_at_zv_p
13119 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13120 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13121 else if (row
->height
> window_box_height (w
))
13123 /* If we end up in a partially visible line, let's
13124 make it fully visible, except when it's taller
13125 than the window, in which case we can't do much
13128 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13132 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13133 if (!cursor_row_fully_visible_p (w
, 0, 1))
13134 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13136 rc
= CURSOR_MOVEMENT_SUCCESS
;
13140 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13145 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13147 rc
= CURSOR_MOVEMENT_SUCCESS
;
13152 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13153 && MATRIX_ROW_START_CHARPOS (row
) == PT
13154 && cursor_row_p (w
, row
));
13163 set_vertical_scroll_bar (w
)
13166 int start
, end
, whole
;
13168 /* Calculate the start and end positions for the current window.
13169 At some point, it would be nice to choose between scrollbars
13170 which reflect the whole buffer size, with special markers
13171 indicating narrowing, and scrollbars which reflect only the
13174 Note that mini-buffers sometimes aren't displaying any text. */
13175 if (!MINI_WINDOW_P (w
)
13176 || (w
== XWINDOW (minibuf_window
)
13177 && NILP (echo_area_buffer
[0])))
13179 struct buffer
*buf
= XBUFFER (w
->buffer
);
13180 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13181 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13182 /* I don't think this is guaranteed to be right. For the
13183 moment, we'll pretend it is. */
13184 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13188 if (whole
< (end
- start
))
13189 whole
= end
- start
;
13192 start
= end
= whole
= 0;
13194 /* Indicate what this scroll bar ought to be displaying now. */
13195 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13196 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13197 (w
, end
- start
, whole
, start
);
13201 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13202 selected_window is redisplayed.
13204 We can return without actually redisplaying the window if
13205 fonts_changed_p is nonzero. In that case, redisplay_internal will
13209 redisplay_window (window
, just_this_one_p
)
13210 Lisp_Object window
;
13211 int just_this_one_p
;
13213 struct window
*w
= XWINDOW (window
);
13214 struct frame
*f
= XFRAME (w
->frame
);
13215 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13216 struct buffer
*old
= current_buffer
;
13217 struct text_pos lpoint
, opoint
, startp
;
13218 int update_mode_line
;
13221 /* Record it now because it's overwritten. */
13222 int current_matrix_up_to_date_p
= 0;
13223 int used_current_matrix_p
= 0;
13224 /* This is less strict than current_matrix_up_to_date_p.
13225 It indictes that the buffer contents and narrowing are unchanged. */
13226 int buffer_unchanged_p
= 0;
13227 int temp_scroll_step
= 0;
13228 int count
= SPECPDL_INDEX ();
13230 int centering_position
= -1;
13231 int last_line_misfit
= 0;
13232 int beg_unchanged
, end_unchanged
;
13234 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13237 /* W must be a leaf window here. */
13238 xassert (!NILP (w
->buffer
));
13240 *w
->desired_matrix
->method
= 0;
13244 reconsider_clip_changes (w
, buffer
);
13246 /* Has the mode line to be updated? */
13247 update_mode_line
= (!NILP (w
->update_mode_line
)
13248 || update_mode_lines
13249 || buffer
->clip_changed
13250 || buffer
->prevent_redisplay_optimizations_p
);
13252 if (MINI_WINDOW_P (w
))
13254 if (w
== XWINDOW (echo_area_window
)
13255 && !NILP (echo_area_buffer
[0]))
13257 if (update_mode_line
)
13258 /* We may have to update a tty frame's menu bar or a
13259 tool-bar. Example `M-x C-h C-h C-g'. */
13260 goto finish_menu_bars
;
13262 /* We've already displayed the echo area glyphs in this window. */
13263 goto finish_scroll_bars
;
13265 else if ((w
!= XWINDOW (minibuf_window
)
13266 || minibuf_level
== 0)
13267 /* When buffer is nonempty, redisplay window normally. */
13268 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13269 /* Quail displays non-mini buffers in minibuffer window.
13270 In that case, redisplay the window normally. */
13271 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13273 /* W is a mini-buffer window, but it's not active, so clear
13275 int yb
= window_text_bottom_y (w
);
13276 struct glyph_row
*row
;
13279 for (y
= 0, row
= w
->desired_matrix
->rows
;
13281 y
+= row
->height
, ++row
)
13282 blank_row (w
, row
, y
);
13283 goto finish_scroll_bars
;
13286 clear_glyph_matrix (w
->desired_matrix
);
13289 /* Otherwise set up data on this window; select its buffer and point
13291 /* Really select the buffer, for the sake of buffer-local
13293 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13295 current_matrix_up_to_date_p
13296 = (!NILP (w
->window_end_valid
)
13297 && !current_buffer
->clip_changed
13298 && !current_buffer
->prevent_redisplay_optimizations_p
13299 && XFASTINT (w
->last_modified
) >= MODIFF
13300 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13302 /* Run the window-bottom-change-functions
13303 if it is possible that the text on the screen has changed
13304 (either due to modification of the text, or any other reason). */
13305 if (!current_matrix_up_to_date_p
13306 && !NILP (Vwindow_text_change_functions
))
13308 safe_run_hooks (Qwindow_text_change_functions
);
13312 beg_unchanged
= BEG_UNCHANGED
;
13313 end_unchanged
= END_UNCHANGED
;
13315 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13317 specbind (Qinhibit_point_motion_hooks
, Qt
);
13320 = (!NILP (w
->window_end_valid
)
13321 && !current_buffer
->clip_changed
13322 && XFASTINT (w
->last_modified
) >= MODIFF
13323 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13325 /* When windows_or_buffers_changed is non-zero, we can't rely on
13326 the window end being valid, so set it to nil there. */
13327 if (windows_or_buffers_changed
)
13329 /* If window starts on a continuation line, maybe adjust the
13330 window start in case the window's width changed. */
13331 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13332 compute_window_start_on_continuation_line (w
);
13334 w
->window_end_valid
= Qnil
;
13337 /* Some sanity checks. */
13338 CHECK_WINDOW_END (w
);
13339 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13341 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13344 /* If %c is in mode line, update it if needed. */
13345 if (!NILP (w
->column_number_displayed
)
13346 /* This alternative quickly identifies a common case
13347 where no change is needed. */
13348 && !(PT
== XFASTINT (w
->last_point
)
13349 && XFASTINT (w
->last_modified
) >= MODIFF
13350 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13351 && (XFASTINT (w
->column_number_displayed
)
13352 != (int) current_column ())) /* iftc */
13353 update_mode_line
= 1;
13355 /* Count number of windows showing the selected buffer. An indirect
13356 buffer counts as its base buffer. */
13357 if (!just_this_one_p
)
13359 struct buffer
*current_base
, *window_base
;
13360 current_base
= current_buffer
;
13361 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13362 if (current_base
->base_buffer
)
13363 current_base
= current_base
->base_buffer
;
13364 if (window_base
->base_buffer
)
13365 window_base
= window_base
->base_buffer
;
13366 if (current_base
== window_base
)
13370 /* Point refers normally to the selected window. For any other
13371 window, set up appropriate value. */
13372 if (!EQ (window
, selected_window
))
13374 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13375 int new_pt_byte
= marker_byte_position (w
->pointm
);
13379 new_pt_byte
= BEGV_BYTE
;
13380 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13382 else if (new_pt
> (ZV
- 1))
13385 new_pt_byte
= ZV_BYTE
;
13386 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13389 /* We don't use SET_PT so that the point-motion hooks don't run. */
13390 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13393 /* If any of the character widths specified in the display table
13394 have changed, invalidate the width run cache. It's true that
13395 this may be a bit late to catch such changes, but the rest of
13396 redisplay goes (non-fatally) haywire when the display table is
13397 changed, so why should we worry about doing any better? */
13398 if (current_buffer
->width_run_cache
)
13400 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13402 if (! disptab_matches_widthtab (disptab
,
13403 XVECTOR (current_buffer
->width_table
)))
13405 invalidate_region_cache (current_buffer
,
13406 current_buffer
->width_run_cache
,
13408 recompute_width_table (current_buffer
, disptab
);
13412 /* If window-start is screwed up, choose a new one. */
13413 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13416 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13418 /* If someone specified a new starting point but did not insist,
13419 check whether it can be used. */
13420 if (!NILP (w
->optional_new_start
)
13421 && CHARPOS (startp
) >= BEGV
13422 && CHARPOS (startp
) <= ZV
)
13424 w
->optional_new_start
= Qnil
;
13425 start_display (&it
, w
, startp
);
13426 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13427 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13428 if (IT_CHARPOS (it
) == PT
)
13429 w
->force_start
= Qt
;
13430 /* IT may overshoot PT if text at PT is invisible. */
13431 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13432 w
->force_start
= Qt
;
13437 /* Handle case where place to start displaying has been specified,
13438 unless the specified location is outside the accessible range. */
13439 if (!NILP (w
->force_start
)
13440 || w
->frozen_window_start_p
)
13442 /* We set this later on if we have to adjust point. */
13445 w
->force_start
= Qnil
;
13447 w
->window_end_valid
= Qnil
;
13449 /* Forget any recorded base line for line number display. */
13450 if (!buffer_unchanged_p
)
13451 w
->base_line_number
= Qnil
;
13453 /* Redisplay the mode line. Select the buffer properly for that.
13454 Also, run the hook window-scroll-functions
13455 because we have scrolled. */
13456 /* Note, we do this after clearing force_start because
13457 if there's an error, it is better to forget about force_start
13458 than to get into an infinite loop calling the hook functions
13459 and having them get more errors. */
13460 if (!update_mode_line
13461 || ! NILP (Vwindow_scroll_functions
))
13463 update_mode_line
= 1;
13464 w
->update_mode_line
= Qt
;
13465 startp
= run_window_scroll_functions (window
, startp
);
13468 w
->last_modified
= make_number (0);
13469 w
->last_overlay_modified
= make_number (0);
13470 if (CHARPOS (startp
) < BEGV
)
13471 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13472 else if (CHARPOS (startp
) > ZV
)
13473 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13475 /* Redisplay, then check if cursor has been set during the
13476 redisplay. Give up if new fonts were loaded. */
13477 /* We used to issue a CHECK_MARGINS argument to try_window here,
13478 but this causes scrolling to fail when point begins inside
13479 the scroll margin (bug#148) -- cyd */
13480 if (!try_window (window
, startp
, 0))
13482 w
->force_start
= Qt
;
13483 clear_glyph_matrix (w
->desired_matrix
);
13484 goto need_larger_matrices
;
13487 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13489 /* If point does not appear, try to move point so it does
13490 appear. The desired matrix has been built above, so we
13491 can use it here. */
13492 new_vpos
= window_box_height (w
) / 2;
13495 if (!cursor_row_fully_visible_p (w
, 0, 0))
13497 /* Point does appear, but on a line partly visible at end of window.
13498 Move it back to a fully-visible line. */
13499 new_vpos
= window_box_height (w
);
13502 /* If we need to move point for either of the above reasons,
13503 now actually do it. */
13506 struct glyph_row
*row
;
13508 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13509 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13512 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13513 MATRIX_ROW_START_BYTEPOS (row
));
13515 if (w
!= XWINDOW (selected_window
))
13516 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13517 else if (current_buffer
== old
)
13518 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13520 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13522 /* If we are highlighting the region, then we just changed
13523 the region, so redisplay to show it. */
13524 if (!NILP (Vtransient_mark_mode
)
13525 && !NILP (current_buffer
->mark_active
))
13527 clear_glyph_matrix (w
->desired_matrix
);
13528 if (!try_window (window
, startp
, 0))
13529 goto need_larger_matrices
;
13534 debug_method_add (w
, "forced window start");
13539 /* Handle case where text has not changed, only point, and it has
13540 not moved off the frame, and we are not retrying after hscroll.
13541 (current_matrix_up_to_date_p is nonzero when retrying.) */
13542 if (current_matrix_up_to_date_p
13543 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13544 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13548 case CURSOR_MOVEMENT_SUCCESS
:
13549 used_current_matrix_p
= 1;
13552 #if 0 /* try_cursor_movement never returns this value. */
13553 case CURSOR_MOVEMENT_NEED_LARGER_MATRICES
:
13554 goto need_larger_matrices
;
13557 case CURSOR_MOVEMENT_MUST_SCROLL
:
13558 goto try_to_scroll
;
13564 /* If current starting point was originally the beginning of a line
13565 but no longer is, find a new starting point. */
13566 else if (!NILP (w
->start_at_line_beg
)
13567 && !(CHARPOS (startp
) <= BEGV
13568 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13571 debug_method_add (w
, "recenter 1");
13576 /* Try scrolling with try_window_id. Value is > 0 if update has
13577 been done, it is -1 if we know that the same window start will
13578 not work. It is 0 if unsuccessful for some other reason. */
13579 else if ((tem
= try_window_id (w
)) != 0)
13582 debug_method_add (w
, "try_window_id %d", tem
);
13585 if (fonts_changed_p
)
13586 goto need_larger_matrices
;
13590 /* Otherwise try_window_id has returned -1 which means that we
13591 don't want the alternative below this comment to execute. */
13593 else if (CHARPOS (startp
) >= BEGV
13594 && CHARPOS (startp
) <= ZV
13595 && PT
>= CHARPOS (startp
)
13596 && (CHARPOS (startp
) < ZV
13597 /* Avoid starting at end of buffer. */
13598 || CHARPOS (startp
) == BEGV
13599 || (XFASTINT (w
->last_modified
) >= MODIFF
13600 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13603 /* If first window line is a continuation line, and window start
13604 is inside the modified region, but the first change is before
13605 current window start, we must select a new window start.
13607 However, if this is the result of a down-mouse event (e.g. by
13608 extending the mouse-drag-overlay), we don't want to select a
13609 new window start, since that would change the position under
13610 the mouse, resulting in an unwanted mouse-movement rather
13611 than a simple mouse-click. */
13612 if (NILP (w
->start_at_line_beg
)
13613 && NILP (do_mouse_tracking
)
13614 && CHARPOS (startp
) > BEGV
13615 && CHARPOS (startp
) > BEG
+ beg_unchanged
13616 && CHARPOS (startp
) <= Z
- end_unchanged
13617 /* Even if w->start_at_line_beg is nil, a new window may
13618 start at a line_beg, since that's how set_buffer_window
13619 sets it. So, we need to check the return value of
13620 compute_window_start_on_continuation_line. (See also
13622 && XMARKER (w
->start
)->buffer
== current_buffer
13623 && compute_window_start_on_continuation_line (w
))
13625 w
->force_start
= Qt
;
13626 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13631 debug_method_add (w
, "same window start");
13634 /* Try to redisplay starting at same place as before.
13635 If point has not moved off frame, accept the results. */
13636 if (!current_matrix_up_to_date_p
13637 /* Don't use try_window_reusing_current_matrix in this case
13638 because a window scroll function can have changed the
13640 || !NILP (Vwindow_scroll_functions
)
13641 || MINI_WINDOW_P (w
)
13642 || !(used_current_matrix_p
13643 = try_window_reusing_current_matrix (w
)))
13645 IF_DEBUG (debug_method_add (w
, "1"));
13646 if (try_window (window
, startp
, 1) < 0)
13647 /* -1 means we need to scroll.
13648 0 means we need new matrices, but fonts_changed_p
13649 is set in that case, so we will detect it below. */
13650 goto try_to_scroll
;
13653 if (fonts_changed_p
)
13654 goto need_larger_matrices
;
13656 if (w
->cursor
.vpos
>= 0)
13658 if (!just_this_one_p
13659 || current_buffer
->clip_changed
13660 || BEG_UNCHANGED
< CHARPOS (startp
))
13661 /* Forget any recorded base line for line number display. */
13662 w
->base_line_number
= Qnil
;
13664 if (!cursor_row_fully_visible_p (w
, 1, 0))
13666 clear_glyph_matrix (w
->desired_matrix
);
13667 last_line_misfit
= 1;
13669 /* Drop through and scroll. */
13674 clear_glyph_matrix (w
->desired_matrix
);
13679 w
->last_modified
= make_number (0);
13680 w
->last_overlay_modified
= make_number (0);
13682 /* Redisplay the mode line. Select the buffer properly for that. */
13683 if (!update_mode_line
)
13685 update_mode_line
= 1;
13686 w
->update_mode_line
= Qt
;
13689 /* Try to scroll by specified few lines. */
13690 if ((scroll_conservatively
13692 || temp_scroll_step
13693 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13694 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13695 && !current_buffer
->clip_changed
13696 && CHARPOS (startp
) >= BEGV
13697 && CHARPOS (startp
) <= ZV
)
13699 /* The function returns -1 if new fonts were loaded, 1 if
13700 successful, 0 if not successful. */
13701 int rc
= try_scrolling (window
, just_this_one_p
,
13702 scroll_conservatively
,
13704 temp_scroll_step
, last_line_misfit
);
13707 case SCROLLING_SUCCESS
:
13710 case SCROLLING_NEED_LARGER_MATRICES
:
13711 goto need_larger_matrices
;
13713 case SCROLLING_FAILED
:
13721 /* Finally, just choose place to start which centers point */
13724 if (centering_position
< 0)
13725 centering_position
= window_box_height (w
) / 2;
13728 debug_method_add (w
, "recenter");
13731 /* w->vscroll = 0; */
13733 /* Forget any previously recorded base line for line number display. */
13734 if (!buffer_unchanged_p
)
13735 w
->base_line_number
= Qnil
;
13737 /* Move backward half the height of the window. */
13738 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13739 it
.current_y
= it
.last_visible_y
;
13740 move_it_vertically_backward (&it
, centering_position
);
13741 xassert (IT_CHARPOS (it
) >= BEGV
);
13743 /* The function move_it_vertically_backward may move over more
13744 than the specified y-distance. If it->w is small, e.g. a
13745 mini-buffer window, we may end up in front of the window's
13746 display area. Start displaying at the start of the line
13747 containing PT in this case. */
13748 if (it
.current_y
<= 0)
13750 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13751 move_it_vertically_backward (&it
, 0);
13755 it
.current_x
= it
.hpos
= 0;
13757 /* Set startp here explicitly in case that helps avoid an infinite loop
13758 in case the window-scroll-functions functions get errors. */
13759 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13761 /* Run scroll hooks. */
13762 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13764 /* Redisplay the window. */
13765 if (!current_matrix_up_to_date_p
13766 || windows_or_buffers_changed
13767 || cursor_type_changed
13768 /* Don't use try_window_reusing_current_matrix in this case
13769 because it can have changed the buffer. */
13770 || !NILP (Vwindow_scroll_functions
)
13771 || !just_this_one_p
13772 || MINI_WINDOW_P (w
)
13773 || !(used_current_matrix_p
13774 = try_window_reusing_current_matrix (w
)))
13775 try_window (window
, startp
, 0);
13777 /* If new fonts have been loaded (due to fontsets), give up. We
13778 have to start a new redisplay since we need to re-adjust glyph
13780 if (fonts_changed_p
)
13781 goto need_larger_matrices
;
13783 /* If cursor did not appear assume that the middle of the window is
13784 in the first line of the window. Do it again with the next line.
13785 (Imagine a window of height 100, displaying two lines of height
13786 60. Moving back 50 from it->last_visible_y will end in the first
13788 if (w
->cursor
.vpos
< 0)
13790 if (!NILP (w
->window_end_valid
)
13791 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13793 clear_glyph_matrix (w
->desired_matrix
);
13794 move_it_by_lines (&it
, 1, 0);
13795 try_window (window
, it
.current
.pos
, 0);
13797 else if (PT
< IT_CHARPOS (it
))
13799 clear_glyph_matrix (w
->desired_matrix
);
13800 move_it_by_lines (&it
, -1, 0);
13801 try_window (window
, it
.current
.pos
, 0);
13805 /* Not much we can do about it. */
13809 /* Consider the following case: Window starts at BEGV, there is
13810 invisible, intangible text at BEGV, so that display starts at
13811 some point START > BEGV. It can happen that we are called with
13812 PT somewhere between BEGV and START. Try to handle that case. */
13813 if (w
->cursor
.vpos
< 0)
13815 struct glyph_row
*row
= w
->current_matrix
->rows
;
13816 if (row
->mode_line_p
)
13818 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13821 if (!cursor_row_fully_visible_p (w
, 0, 0))
13823 /* If vscroll is enabled, disable it and try again. */
13827 clear_glyph_matrix (w
->desired_matrix
);
13831 /* If centering point failed to make the whole line visible,
13832 put point at the top instead. That has to make the whole line
13833 visible, if it can be done. */
13834 if (centering_position
== 0)
13837 clear_glyph_matrix (w
->desired_matrix
);
13838 centering_position
= 0;
13844 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13845 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13846 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13849 /* Display the mode line, if we must. */
13850 if ((update_mode_line
13851 /* If window not full width, must redo its mode line
13852 if (a) the window to its side is being redone and
13853 (b) we do a frame-based redisplay. This is a consequence
13854 of how inverted lines are drawn in frame-based redisplay. */
13855 || (!just_this_one_p
13856 && !FRAME_WINDOW_P (f
)
13857 && !WINDOW_FULL_WIDTH_P (w
))
13858 /* Line number to display. */
13859 || INTEGERP (w
->base_line_pos
)
13860 /* Column number is displayed and different from the one displayed. */
13861 || (!NILP (w
->column_number_displayed
)
13862 && (XFASTINT (w
->column_number_displayed
)
13863 != (int) current_column ()))) /* iftc */
13864 /* This means that the window has a mode line. */
13865 && (WINDOW_WANTS_MODELINE_P (w
)
13866 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13868 display_mode_lines (w
);
13870 /* If mode line height has changed, arrange for a thorough
13871 immediate redisplay using the correct mode line height. */
13872 if (WINDOW_WANTS_MODELINE_P (w
)
13873 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13875 fonts_changed_p
= 1;
13876 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13877 = DESIRED_MODE_LINE_HEIGHT (w
);
13880 /* If top line height has changed, arrange for a thorough
13881 immediate redisplay using the correct mode line height. */
13882 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13883 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13885 fonts_changed_p
= 1;
13886 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13887 = DESIRED_HEADER_LINE_HEIGHT (w
);
13890 if (fonts_changed_p
)
13891 goto need_larger_matrices
;
13894 if (!line_number_displayed
13895 && !BUFFERP (w
->base_line_pos
))
13897 w
->base_line_pos
= Qnil
;
13898 w
->base_line_number
= Qnil
;
13903 /* When we reach a frame's selected window, redo the frame's menu bar. */
13904 if (update_mode_line
13905 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13907 int redisplay_menu_p
= 0;
13908 int redisplay_tool_bar_p
= 0;
13910 if (FRAME_WINDOW_P (f
))
13912 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13913 || defined (HAVE_NS) || defined (USE_GTK)
13914 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13916 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13920 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13922 if (redisplay_menu_p
)
13923 display_menu_bar (w
);
13925 #ifdef HAVE_WINDOW_SYSTEM
13926 if (FRAME_WINDOW_P (f
))
13928 #if defined (USE_GTK) || defined (HAVE_NS) || USE_MAC_TOOLBAR
13929 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13931 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13932 && (FRAME_TOOL_BAR_LINES (f
) > 0
13933 || !NILP (Vauto_resize_tool_bars
));
13936 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13938 extern int ignore_mouse_drag_p
;
13939 ignore_mouse_drag_p
= 1;
13945 #ifdef HAVE_WINDOW_SYSTEM
13946 if (FRAME_WINDOW_P (f
)
13947 && update_window_fringes (w
, (just_this_one_p
13948 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13949 || w
->pseudo_window_p
)))
13953 if (draw_window_fringes (w
, 1))
13954 x_draw_vertical_border (w
);
13958 #endif /* HAVE_WINDOW_SYSTEM */
13960 /* We go to this label, with fonts_changed_p nonzero,
13961 if it is necessary to try again using larger glyph matrices.
13962 We have to redeem the scroll bar even in this case,
13963 because the loop in redisplay_internal expects that. */
13964 need_larger_matrices
:
13966 finish_scroll_bars
:
13968 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13970 /* Set the thumb's position and size. */
13971 set_vertical_scroll_bar (w
);
13973 /* Note that we actually used the scroll bar attached to this
13974 window, so it shouldn't be deleted at the end of redisplay. */
13975 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13976 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13979 /* Restore current_buffer and value of point in it. */
13980 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13981 set_buffer_internal_1 (old
);
13982 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13983 shorter. This can be caused by log truncation in *Messages*. */
13984 if (CHARPOS (lpoint
) <= ZV
)
13985 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13987 unbind_to (count
, Qnil
);
13991 /* Build the complete desired matrix of WINDOW with a window start
13992 buffer position POS.
13994 Value is 1 if successful. It is zero if fonts were loaded during
13995 redisplay which makes re-adjusting glyph matrices necessary, and -1
13996 if point would appear in the scroll margins.
13997 (We check that only if CHECK_MARGINS is nonzero. */
14000 try_window (window
, pos
, check_margins
)
14001 Lisp_Object window
;
14002 struct text_pos pos
;
14005 struct window
*w
= XWINDOW (window
);
14007 struct glyph_row
*last_text_row
= NULL
;
14008 struct frame
*f
= XFRAME (w
->frame
);
14010 /* Make POS the new window start. */
14011 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14013 /* Mark cursor position as unknown. No overlay arrow seen. */
14014 w
->cursor
.vpos
= -1;
14015 overlay_arrow_seen
= 0;
14017 /* Initialize iterator and info to start at POS. */
14018 start_display (&it
, w
, pos
);
14020 /* Display all lines of W. */
14021 while (it
.current_y
< it
.last_visible_y
)
14023 if (display_line (&it
))
14024 last_text_row
= it
.glyph_row
- 1;
14025 if (fonts_changed_p
)
14029 /* Don't let the cursor end in the scroll margins. */
14031 && !MINI_WINDOW_P (w
))
14033 int this_scroll_margin
;
14035 if (scroll_margin
> 0)
14037 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14038 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14041 this_scroll_margin
= 0;
14043 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14044 && w
->cursor
.y
< this_scroll_margin
14045 && CHARPOS (pos
) > BEGV
14046 && IT_CHARPOS (it
) < ZV
)
14047 /* rms: considering make_cursor_line_fully_visible_p here
14048 seems to give wrong results. We don't want to recenter
14049 when the last line is partly visible, we want to allow
14050 that case to be handled in the usual way. */
14051 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14053 w
->cursor
.vpos
= -1;
14054 clear_glyph_matrix (w
->desired_matrix
);
14059 /* If bottom moved off end of frame, change mode line percentage. */
14060 if (XFASTINT (w
->window_end_pos
) <= 0
14061 && Z
!= IT_CHARPOS (it
))
14062 w
->update_mode_line
= Qt
;
14064 /* Set window_end_pos to the offset of the last character displayed
14065 on the window from the end of current_buffer. Set
14066 window_end_vpos to its row number. */
14069 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14070 w
->window_end_bytepos
14071 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14073 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14075 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14076 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14077 ->displays_text_p
);
14081 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14082 w
->window_end_pos
= make_number (Z
- ZV
);
14083 w
->window_end_vpos
= make_number (0);
14086 /* But that is not valid info until redisplay finishes. */
14087 w
->window_end_valid
= Qnil
;
14093 /************************************************************************
14094 Window redisplay reusing current matrix when buffer has not changed
14095 ************************************************************************/
14097 /* Try redisplay of window W showing an unchanged buffer with a
14098 different window start than the last time it was displayed by
14099 reusing its current matrix. Value is non-zero if successful.
14100 W->start is the new window start. */
14103 try_window_reusing_current_matrix (w
)
14106 struct frame
*f
= XFRAME (w
->frame
);
14107 struct glyph_row
*row
, *bottom_row
;
14110 struct text_pos start
, new_start
;
14111 int nrows_scrolled
, i
;
14112 struct glyph_row
*last_text_row
;
14113 struct glyph_row
*last_reused_text_row
;
14114 struct glyph_row
*start_row
;
14115 int start_vpos
, min_y
, max_y
;
14118 if (inhibit_try_window_reusing
)
14122 if (/* This function doesn't handle terminal frames. */
14123 !FRAME_WINDOW_P (f
)
14124 /* Don't try to reuse the display if windows have been split
14126 || windows_or_buffers_changed
14127 || cursor_type_changed
)
14130 /* Can't do this if region may have changed. */
14131 if ((!NILP (Vtransient_mark_mode
)
14132 && !NILP (current_buffer
->mark_active
))
14133 || !NILP (w
->region_showing
)
14134 || !NILP (Vshow_trailing_whitespace
))
14137 /* If top-line visibility has changed, give up. */
14138 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14139 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14142 /* Give up if old or new display is scrolled vertically. We could
14143 make this function handle this, but right now it doesn't. */
14144 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14145 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14148 /* The variable new_start now holds the new window start. The old
14149 start `start' can be determined from the current matrix. */
14150 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14151 start
= start_row
->start
.pos
;
14152 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14154 /* Clear the desired matrix for the display below. */
14155 clear_glyph_matrix (w
->desired_matrix
);
14157 if (CHARPOS (new_start
) <= CHARPOS (start
))
14161 /* Don't use this method if the display starts with an ellipsis
14162 displayed for invisible text. It's not easy to handle that case
14163 below, and it's certainly not worth the effort since this is
14164 not a frequent case. */
14165 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14168 IF_DEBUG (debug_method_add (w
, "twu1"));
14170 /* Display up to a row that can be reused. The variable
14171 last_text_row is set to the last row displayed that displays
14172 text. Note that it.vpos == 0 if or if not there is a
14173 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14174 start_display (&it
, w
, new_start
);
14175 first_row_y
= it
.current_y
;
14176 w
->cursor
.vpos
= -1;
14177 last_text_row
= last_reused_text_row
= NULL
;
14179 while (it
.current_y
< it
.last_visible_y
14180 && !fonts_changed_p
)
14182 /* If we have reached into the characters in the START row,
14183 that means the line boundaries have changed. So we
14184 can't start copying with the row START. Maybe it will
14185 work to start copying with the following row. */
14186 while (IT_CHARPOS (it
) > CHARPOS (start
))
14188 /* Advance to the next row as the "start". */
14190 start
= start_row
->start
.pos
;
14191 /* If there are no more rows to try, or just one, give up. */
14192 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14193 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14194 || CHARPOS (start
) == ZV
)
14196 clear_glyph_matrix (w
->desired_matrix
);
14200 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14202 /* If we have reached alignment,
14203 we can copy the rest of the rows. */
14204 if (IT_CHARPOS (it
) == CHARPOS (start
))
14207 if (display_line (&it
))
14208 last_text_row
= it
.glyph_row
- 1;
14211 /* A value of current_y < last_visible_y means that we stopped
14212 at the previous window start, which in turn means that we
14213 have at least one reusable row. */
14214 if (it
.current_y
< it
.last_visible_y
)
14216 /* IT.vpos always starts from 0; it counts text lines. */
14217 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14219 /* Find PT if not already found in the lines displayed. */
14220 if (w
->cursor
.vpos
< 0)
14222 int dy
= it
.current_y
- start_row
->y
;
14224 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14225 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14227 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14228 dy
, nrows_scrolled
);
14231 clear_glyph_matrix (w
->desired_matrix
);
14236 /* Scroll the display. Do it before the current matrix is
14237 changed. The problem here is that update has not yet
14238 run, i.e. part of the current matrix is not up to date.
14239 scroll_run_hook will clear the cursor, and use the
14240 current matrix to get the height of the row the cursor is
14242 run
.current_y
= start_row
->y
;
14243 run
.desired_y
= it
.current_y
;
14244 run
.height
= it
.last_visible_y
- it
.current_y
;
14246 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14249 FRAME_RIF (f
)->update_window_begin_hook (w
);
14250 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14251 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14252 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14256 /* Shift current matrix down by nrows_scrolled lines. */
14257 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14258 rotate_matrix (w
->current_matrix
,
14260 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14263 /* Disable lines that must be updated. */
14264 for (i
= 0; i
< nrows_scrolled
; ++i
)
14265 (start_row
+ i
)->enabled_p
= 0;
14267 /* Re-compute Y positions. */
14268 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14269 max_y
= it
.last_visible_y
;
14270 for (row
= start_row
+ nrows_scrolled
;
14274 row
->y
= it
.current_y
;
14275 row
->visible_height
= row
->height
;
14277 if (row
->y
< min_y
)
14278 row
->visible_height
-= min_y
- row
->y
;
14279 if (row
->y
+ row
->height
> max_y
)
14280 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14281 row
->redraw_fringe_bitmaps_p
= 1;
14283 it
.current_y
+= row
->height
;
14285 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14286 last_reused_text_row
= row
;
14287 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14291 /* Disable lines in the current matrix which are now
14292 below the window. */
14293 for (++row
; row
< bottom_row
; ++row
)
14294 row
->enabled_p
= row
->mode_line_p
= 0;
14297 /* Update window_end_pos etc.; last_reused_text_row is the last
14298 reused row from the current matrix containing text, if any.
14299 The value of last_text_row is the last displayed line
14300 containing text. */
14301 if (last_reused_text_row
)
14303 w
->window_end_bytepos
14304 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14306 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14308 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14309 w
->current_matrix
));
14311 else if (last_text_row
)
14313 w
->window_end_bytepos
14314 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14316 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14318 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14322 /* This window must be completely empty. */
14323 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14324 w
->window_end_pos
= make_number (Z
- ZV
);
14325 w
->window_end_vpos
= make_number (0);
14327 w
->window_end_valid
= Qnil
;
14329 /* Update hint: don't try scrolling again in update_window. */
14330 w
->desired_matrix
->no_scrolling_p
= 1;
14333 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14337 else if (CHARPOS (new_start
) > CHARPOS (start
))
14339 struct glyph_row
*pt_row
, *row
;
14340 struct glyph_row
*first_reusable_row
;
14341 struct glyph_row
*first_row_to_display
;
14343 int yb
= window_text_bottom_y (w
);
14345 /* Find the row starting at new_start, if there is one. Don't
14346 reuse a partially visible line at the end. */
14347 first_reusable_row
= start_row
;
14348 while (first_reusable_row
->enabled_p
14349 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14350 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14351 < CHARPOS (new_start
)))
14352 ++first_reusable_row
;
14354 /* Give up if there is no row to reuse. */
14355 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14356 || !first_reusable_row
->enabled_p
14357 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14358 != CHARPOS (new_start
)))
14361 /* We can reuse fully visible rows beginning with
14362 first_reusable_row to the end of the window. Set
14363 first_row_to_display to the first row that cannot be reused.
14364 Set pt_row to the row containing point, if there is any. */
14366 for (first_row_to_display
= first_reusable_row
;
14367 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14368 ++first_row_to_display
)
14370 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14371 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14372 pt_row
= first_row_to_display
;
14375 /* Start displaying at the start of first_row_to_display. */
14376 xassert (first_row_to_display
->y
< yb
);
14377 init_to_row_start (&it
, w
, first_row_to_display
);
14379 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14381 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14383 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14384 + WINDOW_HEADER_LINE_HEIGHT (w
));
14386 /* Display lines beginning with first_row_to_display in the
14387 desired matrix. Set last_text_row to the last row displayed
14388 that displays text. */
14389 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14390 if (pt_row
== NULL
)
14391 w
->cursor
.vpos
= -1;
14392 last_text_row
= NULL
;
14393 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14394 if (display_line (&it
))
14395 last_text_row
= it
.glyph_row
- 1;
14397 /* If point is in a reused row, adjust y and vpos of the cursor
14401 w
->cursor
.vpos
-= nrows_scrolled
;
14402 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14405 /* Give up if point isn't in a row displayed or reused. (This
14406 also handles the case where w->cursor.vpos < nrows_scrolled
14407 after the calls to display_line, which can happen with scroll
14408 margins. See bug#1295.) */
14409 if (w
->cursor
.vpos
< 0)
14411 clear_glyph_matrix (w
->desired_matrix
);
14415 /* Scroll the display. */
14416 run
.current_y
= first_reusable_row
->y
;
14417 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14418 run
.height
= it
.last_visible_y
- run
.current_y
;
14419 dy
= run
.current_y
- run
.desired_y
;
14424 FRAME_RIF (f
)->update_window_begin_hook (w
);
14425 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14426 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14427 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14431 /* Adjust Y positions of reused rows. */
14432 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14433 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14434 max_y
= it
.last_visible_y
;
14435 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14438 row
->visible_height
= row
->height
;
14439 if (row
->y
< min_y
)
14440 row
->visible_height
-= min_y
- row
->y
;
14441 if (row
->y
+ row
->height
> max_y
)
14442 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14443 row
->redraw_fringe_bitmaps_p
= 1;
14446 /* Scroll the current matrix. */
14447 xassert (nrows_scrolled
> 0);
14448 rotate_matrix (w
->current_matrix
,
14450 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14453 /* Disable rows not reused. */
14454 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14455 row
->enabled_p
= 0;
14457 /* Point may have moved to a different line, so we cannot assume that
14458 the previous cursor position is valid; locate the correct row. */
14461 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14462 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14466 w
->cursor
.y
= row
->y
;
14468 if (row
< bottom_row
)
14470 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14471 while (glyph
->charpos
< PT
)
14474 w
->cursor
.x
+= glyph
->pixel_width
;
14480 /* Adjust window end. A null value of last_text_row means that
14481 the window end is in reused rows which in turn means that
14482 only its vpos can have changed. */
14485 w
->window_end_bytepos
14486 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14488 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14490 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14495 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14498 w
->window_end_valid
= Qnil
;
14499 w
->desired_matrix
->no_scrolling_p
= 1;
14502 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14512 /************************************************************************
14513 Window redisplay reusing current matrix when buffer has changed
14514 ************************************************************************/
14516 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14517 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14519 static struct glyph_row
*
14520 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14521 struct glyph_row
*));
14524 /* Return the last row in MATRIX displaying text. If row START is
14525 non-null, start searching with that row. IT gives the dimensions
14526 of the display. Value is null if matrix is empty; otherwise it is
14527 a pointer to the row found. */
14529 static struct glyph_row
*
14530 find_last_row_displaying_text (matrix
, it
, start
)
14531 struct glyph_matrix
*matrix
;
14533 struct glyph_row
*start
;
14535 struct glyph_row
*row
, *row_found
;
14537 /* Set row_found to the last row in IT->w's current matrix
14538 displaying text. The loop looks funny but think of partially
14541 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14542 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14544 xassert (row
->enabled_p
);
14546 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14555 /* Return the last row in the current matrix of W that is not affected
14556 by changes at the start of current_buffer that occurred since W's
14557 current matrix was built. Value is null if no such row exists.
14559 BEG_UNCHANGED us the number of characters unchanged at the start of
14560 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14561 first changed character in current_buffer. Characters at positions <
14562 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14563 when the current matrix was built. */
14565 static struct glyph_row
*
14566 find_last_unchanged_at_beg_row (w
)
14569 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14570 struct glyph_row
*row
;
14571 struct glyph_row
*row_found
= NULL
;
14572 int yb
= window_text_bottom_y (w
);
14574 /* Find the last row displaying unchanged text. */
14575 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14576 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14577 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14580 if (/* If row ends before first_changed_pos, it is unchanged,
14581 except in some case. */
14582 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14583 /* When row ends in ZV and we write at ZV it is not
14585 && !row
->ends_at_zv_p
14586 /* When first_changed_pos is the end of a continued line,
14587 row is not unchanged because it may be no longer
14589 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14590 && (row
->continued_p
14591 || row
->exact_window_width_line_p
)))
14594 /* Stop if last visible row. */
14595 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14603 /* Find the first glyph row in the current matrix of W that is not
14604 affected by changes at the end of current_buffer since the
14605 time W's current matrix was built.
14607 Return in *DELTA the number of chars by which buffer positions in
14608 unchanged text at the end of current_buffer must be adjusted.
14610 Return in *DELTA_BYTES the corresponding number of bytes.
14612 Value is null if no such row exists, i.e. all rows are affected by
14615 static struct glyph_row
*
14616 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14618 int *delta
, *delta_bytes
;
14620 struct glyph_row
*row
;
14621 struct glyph_row
*row_found
= NULL
;
14623 *delta
= *delta_bytes
= 0;
14625 /* Display must not have been paused, otherwise the current matrix
14626 is not up to date. */
14627 eassert (!NILP (w
->window_end_valid
));
14629 /* A value of window_end_pos >= END_UNCHANGED means that the window
14630 end is in the range of changed text. If so, there is no
14631 unchanged row at the end of W's current matrix. */
14632 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14635 /* Set row to the last row in W's current matrix displaying text. */
14636 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14638 /* If matrix is entirely empty, no unchanged row exists. */
14639 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14641 /* The value of row is the last glyph row in the matrix having a
14642 meaningful buffer position in it. The end position of row
14643 corresponds to window_end_pos. This allows us to translate
14644 buffer positions in the current matrix to current buffer
14645 positions for characters not in changed text. */
14646 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14647 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14648 int last_unchanged_pos
, last_unchanged_pos_old
;
14649 struct glyph_row
*first_text_row
14650 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14652 *delta
= Z
- Z_old
;
14653 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14655 /* Set last_unchanged_pos to the buffer position of the last
14656 character in the buffer that has not been changed. Z is the
14657 index + 1 of the last character in current_buffer, i.e. by
14658 subtracting END_UNCHANGED we get the index of the last
14659 unchanged character, and we have to add BEG to get its buffer
14661 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14662 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14664 /* Search backward from ROW for a row displaying a line that
14665 starts at a minimum position >= last_unchanged_pos_old. */
14666 for (; row
> first_text_row
; --row
)
14668 /* This used to abort, but it can happen.
14669 It is ok to just stop the search instead here. KFS. */
14670 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14673 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14678 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14684 /* Make sure that glyph rows in the current matrix of window W
14685 reference the same glyph memory as corresponding rows in the
14686 frame's frame matrix. This function is called after scrolling W's
14687 current matrix on a terminal frame in try_window_id and
14688 try_window_reusing_current_matrix. */
14691 sync_frame_with_window_matrix_rows (w
)
14694 struct frame
*f
= XFRAME (w
->frame
);
14695 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14697 /* Preconditions: W must be a leaf window and full-width. Its frame
14698 must have a frame matrix. */
14699 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14700 xassert (WINDOW_FULL_WIDTH_P (w
));
14701 xassert (!FRAME_WINDOW_P (f
));
14703 /* If W is a full-width window, glyph pointers in W's current matrix
14704 have, by definition, to be the same as glyph pointers in the
14705 corresponding frame matrix. Note that frame matrices have no
14706 marginal areas (see build_frame_matrix). */
14707 window_row
= w
->current_matrix
->rows
;
14708 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14709 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14710 while (window_row
< window_row_end
)
14712 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14713 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14715 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14716 frame_row
->glyphs
[TEXT_AREA
] = start
;
14717 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14718 frame_row
->glyphs
[LAST_AREA
] = end
;
14720 /* Disable frame rows whose corresponding window rows have
14721 been disabled in try_window_id. */
14722 if (!window_row
->enabled_p
)
14723 frame_row
->enabled_p
= 0;
14725 ++window_row
, ++frame_row
;
14730 /* Find the glyph row in window W containing CHARPOS. Consider all
14731 rows between START and END (not inclusive). END null means search
14732 all rows to the end of the display area of W. Value is the row
14733 containing CHARPOS or null. */
14736 row_containing_pos (w
, charpos
, start
, end
, dy
)
14739 struct glyph_row
*start
, *end
;
14742 struct glyph_row
*row
= start
;
14745 /* If we happen to start on a header-line, skip that. */
14746 if (row
->mode_line_p
)
14749 if ((end
&& row
>= end
) || !row
->enabled_p
)
14752 last_y
= window_text_bottom_y (w
) - dy
;
14756 /* Give up if we have gone too far. */
14757 if (end
&& row
>= end
)
14759 /* This formerly returned if they were equal.
14760 I think that both quantities are of a "last plus one" type;
14761 if so, when they are equal, the row is within the screen. -- rms. */
14762 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14765 /* If it is in this row, return this row. */
14766 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14767 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14768 /* The end position of a row equals the start
14769 position of the next row. If CHARPOS is there, we
14770 would rather display it in the next line, except
14771 when this line ends in ZV. */
14772 && !row
->ends_at_zv_p
14773 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14774 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14781 /* Try to redisplay window W by reusing its existing display. W's
14782 current matrix must be up to date when this function is called,
14783 i.e. window_end_valid must not be nil.
14787 1 if display has been updated
14788 0 if otherwise unsuccessful
14789 -1 if redisplay with same window start is known not to succeed
14791 The following steps are performed:
14793 1. Find the last row in the current matrix of W that is not
14794 affected by changes at the start of current_buffer. If no such row
14797 2. Find the first row in W's current matrix that is not affected by
14798 changes at the end of current_buffer. Maybe there is no such row.
14800 3. Display lines beginning with the row + 1 found in step 1 to the
14801 row found in step 2 or, if step 2 didn't find a row, to the end of
14804 4. If cursor is not known to appear on the window, give up.
14806 5. If display stopped at the row found in step 2, scroll the
14807 display and current matrix as needed.
14809 6. Maybe display some lines at the end of W, if we must. This can
14810 happen under various circumstances, like a partially visible line
14811 becoming fully visible, or because newly displayed lines are displayed
14812 in smaller font sizes.
14814 7. Update W's window end information. */
14820 struct frame
*f
= XFRAME (w
->frame
);
14821 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14822 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14823 struct glyph_row
*last_unchanged_at_beg_row
;
14824 struct glyph_row
*first_unchanged_at_end_row
;
14825 struct glyph_row
*row
;
14826 struct glyph_row
*bottom_row
;
14829 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14830 struct text_pos start_pos
;
14832 int first_unchanged_at_end_vpos
= 0;
14833 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14834 struct text_pos start
;
14835 int first_changed_charpos
, last_changed_charpos
;
14838 if (inhibit_try_window_id
)
14842 /* This is handy for debugging. */
14844 #define GIVE_UP(X) \
14846 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14850 #define GIVE_UP(X) return 0
14853 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14855 /* Don't use this for mini-windows because these can show
14856 messages and mini-buffers, and we don't handle that here. */
14857 if (MINI_WINDOW_P (w
))
14860 /* This flag is used to prevent redisplay optimizations. */
14861 if (windows_or_buffers_changed
|| cursor_type_changed
)
14864 /* Verify that narrowing has not changed.
14865 Also verify that we were not told to prevent redisplay optimizations.
14866 It would be nice to further
14867 reduce the number of cases where this prevents try_window_id. */
14868 if (current_buffer
->clip_changed
14869 || current_buffer
->prevent_redisplay_optimizations_p
)
14872 /* Window must either use window-based redisplay or be full width. */
14873 if (!FRAME_WINDOW_P (f
)
14874 && (!FRAME_LINE_INS_DEL_OK (f
)
14875 || !WINDOW_FULL_WIDTH_P (w
)))
14878 /* Give up if point is not known NOT to appear in W. */
14879 if (PT
< CHARPOS (start
))
14882 /* Another way to prevent redisplay optimizations. */
14883 if (XFASTINT (w
->last_modified
) == 0)
14886 /* Verify that window is not hscrolled. */
14887 if (XFASTINT (w
->hscroll
) != 0)
14890 /* Verify that display wasn't paused. */
14891 if (NILP (w
->window_end_valid
))
14894 /* Can't use this if highlighting a region because a cursor movement
14895 will do more than just set the cursor. */
14896 if (!NILP (Vtransient_mark_mode
)
14897 && !NILP (current_buffer
->mark_active
))
14900 /* Likewise if highlighting trailing whitespace. */
14901 if (!NILP (Vshow_trailing_whitespace
))
14904 /* Likewise if showing a region. */
14905 if (!NILP (w
->region_showing
))
14908 /* Can use this if overlay arrow position and or string have changed. */
14909 if (overlay_arrows_changed_p ())
14912 /* When word-wrap is on, adding a space to the first word of a
14913 wrapped line can change the wrap position, altering the line
14914 above it. It might be worthwhile to handle this more
14915 intelligently, but for now just redisplay from scratch. */
14916 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14919 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14920 only if buffer has really changed. The reason is that the gap is
14921 initially at Z for freshly visited files. The code below would
14922 set end_unchanged to 0 in that case. */
14923 if (MODIFF
> SAVE_MODIFF
14924 /* This seems to happen sometimes after saving a buffer. */
14925 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14927 if (GPT
- BEG
< BEG_UNCHANGED
)
14928 BEG_UNCHANGED
= GPT
- BEG
;
14929 if (Z
- GPT
< END_UNCHANGED
)
14930 END_UNCHANGED
= Z
- GPT
;
14933 /* The position of the first and last character that has been changed. */
14934 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14935 last_changed_charpos
= Z
- END_UNCHANGED
;
14937 /* If window starts after a line end, and the last change is in
14938 front of that newline, then changes don't affect the display.
14939 This case happens with stealth-fontification. Note that although
14940 the display is unchanged, glyph positions in the matrix have to
14941 be adjusted, of course. */
14942 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14943 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14944 && ((last_changed_charpos
< CHARPOS (start
)
14945 && CHARPOS (start
) == BEGV
)
14946 || (last_changed_charpos
< CHARPOS (start
) - 1
14947 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14949 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14950 struct glyph_row
*r0
;
14952 /* Compute how many chars/bytes have been added to or removed
14953 from the buffer. */
14954 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14955 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14957 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14959 /* Give up if PT is not in the window. Note that it already has
14960 been checked at the start of try_window_id that PT is not in
14961 front of the window start. */
14962 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14965 /* If window start is unchanged, we can reuse the whole matrix
14966 as is, after adjusting glyph positions. No need to compute
14967 the window end again, since its offset from Z hasn't changed. */
14968 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14969 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14970 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14971 /* PT must not be in a partially visible line. */
14972 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14973 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14975 /* Adjust positions in the glyph matrix. */
14976 if (delta
|| delta_bytes
)
14978 struct glyph_row
*r1
14979 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14980 increment_matrix_positions (w
->current_matrix
,
14981 MATRIX_ROW_VPOS (r0
, current_matrix
),
14982 MATRIX_ROW_VPOS (r1
, current_matrix
),
14983 delta
, delta_bytes
);
14986 /* Set the cursor. */
14987 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14989 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14996 /* Handle the case that changes are all below what is displayed in
14997 the window, and that PT is in the window. This shortcut cannot
14998 be taken if ZV is visible in the window, and text has been added
14999 there that is visible in the window. */
15000 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15001 /* ZV is not visible in the window, or there are no
15002 changes at ZV, actually. */
15003 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15004 || first_changed_charpos
== last_changed_charpos
))
15006 struct glyph_row
*r0
;
15008 /* Give up if PT is not in the window. Note that it already has
15009 been checked at the start of try_window_id that PT is not in
15010 front of the window start. */
15011 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15014 /* If window start is unchanged, we can reuse the whole matrix
15015 as is, without changing glyph positions since no text has
15016 been added/removed in front of the window end. */
15017 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15018 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15019 /* PT must not be in a partially visible line. */
15020 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15021 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15023 /* We have to compute the window end anew since text
15024 can have been added/removed after it. */
15026 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15027 w
->window_end_bytepos
15028 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15030 /* Set the cursor. */
15031 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15033 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15040 /* Give up if window start is in the changed area.
15042 The condition used to read
15044 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15046 but why that was tested escapes me at the moment. */
15047 if (CHARPOS (start
) >= first_changed_charpos
15048 && CHARPOS (start
) <= last_changed_charpos
)
15051 /* Check that window start agrees with the start of the first glyph
15052 row in its current matrix. Check this after we know the window
15053 start is not in changed text, otherwise positions would not be
15055 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15056 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15059 /* Give up if the window ends in strings. Overlay strings
15060 at the end are difficult to handle, so don't try. */
15061 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15062 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15065 /* Compute the position at which we have to start displaying new
15066 lines. Some of the lines at the top of the window might be
15067 reusable because they are not displaying changed text. Find the
15068 last row in W's current matrix not affected by changes at the
15069 start of current_buffer. Value is null if changes start in the
15070 first line of window. */
15071 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15072 if (last_unchanged_at_beg_row
)
15074 /* Avoid starting to display in the moddle of a character, a TAB
15075 for instance. This is easier than to set up the iterator
15076 exactly, and it's not a frequent case, so the additional
15077 effort wouldn't really pay off. */
15078 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15079 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15080 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15081 --last_unchanged_at_beg_row
;
15083 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15086 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15088 start_pos
= it
.current
.pos
;
15090 /* Start displaying new lines in the desired matrix at the same
15091 vpos we would use in the current matrix, i.e. below
15092 last_unchanged_at_beg_row. */
15093 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15095 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15096 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15098 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15102 /* There are no reusable lines at the start of the window.
15103 Start displaying in the first text line. */
15104 start_display (&it
, w
, start
);
15105 it
.vpos
= it
.first_vpos
;
15106 start_pos
= it
.current
.pos
;
15109 /* Find the first row that is not affected by changes at the end of
15110 the buffer. Value will be null if there is no unchanged row, in
15111 which case we must redisplay to the end of the window. delta
15112 will be set to the value by which buffer positions beginning with
15113 first_unchanged_at_end_row have to be adjusted due to text
15115 first_unchanged_at_end_row
15116 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15117 IF_DEBUG (debug_delta
= delta
);
15118 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15120 /* Set stop_pos to the buffer position up to which we will have to
15121 display new lines. If first_unchanged_at_end_row != NULL, this
15122 is the buffer position of the start of the line displayed in that
15123 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15124 that we don't stop at a buffer position. */
15126 if (first_unchanged_at_end_row
)
15128 xassert (last_unchanged_at_beg_row
== NULL
15129 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15131 /* If this is a continuation line, move forward to the next one
15132 that isn't. Changes in lines above affect this line.
15133 Caution: this may move first_unchanged_at_end_row to a row
15134 not displaying text. */
15135 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15136 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15137 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15138 < it
.last_visible_y
))
15139 ++first_unchanged_at_end_row
;
15141 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15142 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15143 >= it
.last_visible_y
))
15144 first_unchanged_at_end_row
= NULL
;
15147 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15149 first_unchanged_at_end_vpos
15150 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15151 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15154 else if (last_unchanged_at_beg_row
== NULL
)
15160 /* Either there is no unchanged row at the end, or the one we have
15161 now displays text. This is a necessary condition for the window
15162 end pos calculation at the end of this function. */
15163 xassert (first_unchanged_at_end_row
== NULL
15164 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15166 debug_last_unchanged_at_beg_vpos
15167 = (last_unchanged_at_beg_row
15168 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15170 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15172 #endif /* GLYPH_DEBUG != 0 */
15175 /* Display new lines. Set last_text_row to the last new line
15176 displayed which has text on it, i.e. might end up as being the
15177 line where the window_end_vpos is. */
15178 w
->cursor
.vpos
= -1;
15179 last_text_row
= NULL
;
15180 overlay_arrow_seen
= 0;
15181 while (it
.current_y
< it
.last_visible_y
15182 && !fonts_changed_p
15183 && (first_unchanged_at_end_row
== NULL
15184 || IT_CHARPOS (it
) < stop_pos
))
15186 if (display_line (&it
))
15187 last_text_row
= it
.glyph_row
- 1;
15190 if (fonts_changed_p
)
15194 /* Compute differences in buffer positions, y-positions etc. for
15195 lines reused at the bottom of the window. Compute what we can
15197 if (first_unchanged_at_end_row
15198 /* No lines reused because we displayed everything up to the
15199 bottom of the window. */
15200 && it
.current_y
< it
.last_visible_y
)
15203 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15205 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15206 run
.current_y
= first_unchanged_at_end_row
->y
;
15207 run
.desired_y
= run
.current_y
+ dy
;
15208 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15212 delta
= delta_bytes
= dvpos
= dy
15213 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15214 first_unchanged_at_end_row
= NULL
;
15216 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15219 /* Find the cursor if not already found. We have to decide whether
15220 PT will appear on this window (it sometimes doesn't, but this is
15221 not a very frequent case.) This decision has to be made before
15222 the current matrix is altered. A value of cursor.vpos < 0 means
15223 that PT is either in one of the lines beginning at
15224 first_unchanged_at_end_row or below the window. Don't care for
15225 lines that might be displayed later at the window end; as
15226 mentioned, this is not a frequent case. */
15227 if (w
->cursor
.vpos
< 0)
15229 /* Cursor in unchanged rows at the top? */
15230 if (PT
< CHARPOS (start_pos
)
15231 && last_unchanged_at_beg_row
)
15233 row
= row_containing_pos (w
, PT
,
15234 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15235 last_unchanged_at_beg_row
+ 1, 0);
15237 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15240 /* Start from first_unchanged_at_end_row looking for PT. */
15241 else if (first_unchanged_at_end_row
)
15243 row
= row_containing_pos (w
, PT
- delta
,
15244 first_unchanged_at_end_row
, NULL
, 0);
15246 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15247 delta_bytes
, dy
, dvpos
);
15250 /* Give up if cursor was not found. */
15251 if (w
->cursor
.vpos
< 0)
15253 clear_glyph_matrix (w
->desired_matrix
);
15258 /* Don't let the cursor end in the scroll margins. */
15260 int this_scroll_margin
, cursor_height
;
15262 this_scroll_margin
= max (0, scroll_margin
);
15263 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15264 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15265 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15267 if ((w
->cursor
.y
< this_scroll_margin
15268 && CHARPOS (start
) > BEGV
)
15269 /* Old redisplay didn't take scroll margin into account at the bottom,
15270 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15271 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15272 ? cursor_height
+ this_scroll_margin
15273 : 1)) > it
.last_visible_y
)
15275 w
->cursor
.vpos
= -1;
15276 clear_glyph_matrix (w
->desired_matrix
);
15281 /* Scroll the display. Do it before changing the current matrix so
15282 that xterm.c doesn't get confused about where the cursor glyph is
15284 if (dy
&& run
.height
)
15288 if (FRAME_WINDOW_P (f
))
15290 FRAME_RIF (f
)->update_window_begin_hook (w
);
15291 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15292 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15293 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15297 /* Terminal frame. In this case, dvpos gives the number of
15298 lines to scroll by; dvpos < 0 means scroll up. */
15299 int first_unchanged_at_end_vpos
15300 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15301 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15302 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15303 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15304 + window_internal_height (w
));
15306 /* Perform the operation on the screen. */
15309 /* Scroll last_unchanged_at_beg_row to the end of the
15310 window down dvpos lines. */
15311 set_terminal_window (f
, end
);
15313 /* On dumb terminals delete dvpos lines at the end
15314 before inserting dvpos empty lines. */
15315 if (!FRAME_SCROLL_REGION_OK (f
))
15316 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15318 /* Insert dvpos empty lines in front of
15319 last_unchanged_at_beg_row. */
15320 ins_del_lines (f
, from
, dvpos
);
15322 else if (dvpos
< 0)
15324 /* Scroll up last_unchanged_at_beg_vpos to the end of
15325 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15326 set_terminal_window (f
, end
);
15328 /* Delete dvpos lines in front of
15329 last_unchanged_at_beg_vpos. ins_del_lines will set
15330 the cursor to the given vpos and emit |dvpos| delete
15332 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15334 /* On a dumb terminal insert dvpos empty lines at the
15336 if (!FRAME_SCROLL_REGION_OK (f
))
15337 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15340 set_terminal_window (f
, 0);
15346 /* Shift reused rows of the current matrix to the right position.
15347 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15349 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15350 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15353 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15354 bottom_vpos
, dvpos
);
15355 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15358 else if (dvpos
> 0)
15360 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15361 bottom_vpos
, dvpos
);
15362 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15363 first_unchanged_at_end_vpos
+ dvpos
, 0);
15366 /* For frame-based redisplay, make sure that current frame and window
15367 matrix are in sync with respect to glyph memory. */
15368 if (!FRAME_WINDOW_P (f
))
15369 sync_frame_with_window_matrix_rows (w
);
15371 /* Adjust buffer positions in reused rows. */
15372 if (delta
|| delta_bytes
)
15373 increment_matrix_positions (current_matrix
,
15374 first_unchanged_at_end_vpos
+ dvpos
,
15375 bottom_vpos
, delta
, delta_bytes
);
15377 /* Adjust Y positions. */
15379 shift_glyph_matrix (w
, current_matrix
,
15380 first_unchanged_at_end_vpos
+ dvpos
,
15383 if (first_unchanged_at_end_row
)
15385 first_unchanged_at_end_row
+= dvpos
;
15386 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15387 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15388 first_unchanged_at_end_row
= NULL
;
15391 /* If scrolling up, there may be some lines to display at the end of
15393 last_text_row_at_end
= NULL
;
15396 /* Scrolling up can leave for example a partially visible line
15397 at the end of the window to be redisplayed. */
15398 /* Set last_row to the glyph row in the current matrix where the
15399 window end line is found. It has been moved up or down in
15400 the matrix by dvpos. */
15401 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15402 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15404 /* If last_row is the window end line, it should display text. */
15405 xassert (last_row
->displays_text_p
);
15407 /* If window end line was partially visible before, begin
15408 displaying at that line. Otherwise begin displaying with the
15409 line following it. */
15410 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15412 init_to_row_start (&it
, w
, last_row
);
15413 it
.vpos
= last_vpos
;
15414 it
.current_y
= last_row
->y
;
15418 init_to_row_end (&it
, w
, last_row
);
15419 it
.vpos
= 1 + last_vpos
;
15420 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15424 /* We may start in a continuation line. If so, we have to
15425 get the right continuation_lines_width and current_x. */
15426 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15427 it
.hpos
= it
.current_x
= 0;
15429 /* Display the rest of the lines at the window end. */
15430 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15431 while (it
.current_y
< it
.last_visible_y
15432 && !fonts_changed_p
)
15434 /* Is it always sure that the display agrees with lines in
15435 the current matrix? I don't think so, so we mark rows
15436 displayed invalid in the current matrix by setting their
15437 enabled_p flag to zero. */
15438 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15439 if (display_line (&it
))
15440 last_text_row_at_end
= it
.glyph_row
- 1;
15444 /* Update window_end_pos and window_end_vpos. */
15445 if (first_unchanged_at_end_row
15446 && !last_text_row_at_end
)
15448 /* Window end line if one of the preserved rows from the current
15449 matrix. Set row to the last row displaying text in current
15450 matrix starting at first_unchanged_at_end_row, after
15452 xassert (first_unchanged_at_end_row
->displays_text_p
);
15453 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15454 first_unchanged_at_end_row
);
15455 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15457 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15458 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15460 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15461 xassert (w
->window_end_bytepos
>= 0);
15462 IF_DEBUG (debug_method_add (w
, "A"));
15464 else if (last_text_row_at_end
)
15467 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15468 w
->window_end_bytepos
15469 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15471 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15472 xassert (w
->window_end_bytepos
>= 0);
15473 IF_DEBUG (debug_method_add (w
, "B"));
15475 else if (last_text_row
)
15477 /* We have displayed either to the end of the window or at the
15478 end of the window, i.e. the last row with text is to be found
15479 in the desired matrix. */
15481 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15482 w
->window_end_bytepos
15483 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15485 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15486 xassert (w
->window_end_bytepos
>= 0);
15488 else if (first_unchanged_at_end_row
== NULL
15489 && last_text_row
== NULL
15490 && last_text_row_at_end
== NULL
)
15492 /* Displayed to end of window, but no line containing text was
15493 displayed. Lines were deleted at the end of the window. */
15494 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15495 int vpos
= XFASTINT (w
->window_end_vpos
);
15496 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15497 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15500 row
== NULL
&& vpos
>= first_vpos
;
15501 --vpos
, --current_row
, --desired_row
)
15503 if (desired_row
->enabled_p
)
15505 if (desired_row
->displays_text_p
)
15508 else if (current_row
->displays_text_p
)
15512 xassert (row
!= NULL
);
15513 w
->window_end_vpos
= make_number (vpos
+ 1);
15514 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15515 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15516 xassert (w
->window_end_bytepos
>= 0);
15517 IF_DEBUG (debug_method_add (w
, "C"));
15522 #if 0 /* This leads to problems, for instance when the cursor is
15523 at ZV, and the cursor line displays no text. */
15524 /* Disable rows below what's displayed in the window. This makes
15525 debugging easier. */
15526 enable_glyph_matrix_rows (current_matrix
,
15527 XFASTINT (w
->window_end_vpos
) + 1,
15531 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15532 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15534 /* Record that display has not been completed. */
15535 w
->window_end_valid
= Qnil
;
15536 w
->desired_matrix
->no_scrolling_p
= 1;
15544 /***********************************************************************
15545 More debugging support
15546 ***********************************************************************/
15550 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15551 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15552 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15555 /* Dump the contents of glyph matrix MATRIX on stderr.
15557 GLYPHS 0 means don't show glyph contents.
15558 GLYPHS 1 means show glyphs in short form
15559 GLYPHS > 1 means show glyphs in long form. */
15562 dump_glyph_matrix (matrix
, glyphs
)
15563 struct glyph_matrix
*matrix
;
15567 for (i
= 0; i
< matrix
->nrows
; ++i
)
15568 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15572 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15573 the glyph row and area where the glyph comes from. */
15576 dump_glyph (row
, glyph
, area
)
15577 struct glyph_row
*row
;
15578 struct glyph
*glyph
;
15581 if (glyph
->type
== CHAR_GLYPH
)
15584 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15585 glyph
- row
->glyphs
[TEXT_AREA
],
15588 (BUFFERP (glyph
->object
)
15590 : (STRINGP (glyph
->object
)
15593 glyph
->pixel_width
,
15595 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15599 glyph
->left_box_line_p
,
15600 glyph
->right_box_line_p
);
15602 else if (glyph
->type
== STRETCH_GLYPH
)
15605 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15606 glyph
- row
->glyphs
[TEXT_AREA
],
15609 (BUFFERP (glyph
->object
)
15611 : (STRINGP (glyph
->object
)
15614 glyph
->pixel_width
,
15618 glyph
->left_box_line_p
,
15619 glyph
->right_box_line_p
);
15621 else if (glyph
->type
== IMAGE_GLYPH
)
15624 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15625 glyph
- row
->glyphs
[TEXT_AREA
],
15628 (BUFFERP (glyph
->object
)
15630 : (STRINGP (glyph
->object
)
15633 glyph
->pixel_width
,
15637 glyph
->left_box_line_p
,
15638 glyph
->right_box_line_p
);
15640 else if (glyph
->type
== COMPOSITE_GLYPH
)
15643 " %5d %4c %6d %c %3d 0x%05x",
15644 glyph
- row
->glyphs
[TEXT_AREA
],
15647 (BUFFERP (glyph
->object
)
15649 : (STRINGP (glyph
->object
)
15652 glyph
->pixel_width
,
15654 if (glyph
->u
.cmp
.automatic
)
15657 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
15658 fprintf (stderr
, " . %4d %1.1d%1.1d\n"
15660 glyph
->left_box_line_p
,
15661 glyph
->right_box_line_p
);
15666 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15667 GLYPHS 0 means don't show glyph contents.
15668 GLYPHS 1 means show glyphs in short form
15669 GLYPHS > 1 means show glyphs in long form. */
15672 dump_glyph_row (row
, vpos
, glyphs
)
15673 struct glyph_row
*row
;
15678 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15679 fprintf (stderr
, "======================================================================\n");
15681 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15682 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15684 MATRIX_ROW_START_CHARPOS (row
),
15685 MATRIX_ROW_END_CHARPOS (row
),
15686 row
->used
[TEXT_AREA
],
15687 row
->contains_overlapping_glyphs_p
,
15689 row
->truncated_on_left_p
,
15690 row
->truncated_on_right_p
,
15692 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15693 row
->displays_text_p
,
15696 row
->ends_in_middle_of_char_p
,
15697 row
->starts_in_middle_of_char_p
,
15703 row
->visible_height
,
15706 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15707 row
->end
.overlay_string_index
,
15708 row
->continuation_lines_width
);
15709 fprintf (stderr
, "%9d %5d\n",
15710 CHARPOS (row
->start
.string_pos
),
15711 CHARPOS (row
->end
.string_pos
));
15712 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15713 row
->end
.dpvec_index
);
15720 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15722 struct glyph
*glyph
= row
->glyphs
[area
];
15723 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15725 /* Glyph for a line end in text. */
15726 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15729 if (glyph
< glyph_end
)
15730 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15732 for (; glyph
< glyph_end
; ++glyph
)
15733 dump_glyph (row
, glyph
, area
);
15736 else if (glyphs
== 1)
15740 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15742 char *s
= (char *) alloca (row
->used
[area
] + 1);
15745 for (i
= 0; i
< row
->used
[area
]; ++i
)
15747 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15748 if (glyph
->type
== CHAR_GLYPH
15749 && glyph
->u
.ch
< 0x80
15750 && glyph
->u
.ch
>= ' ')
15751 s
[i
] = glyph
->u
.ch
;
15757 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15763 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15764 Sdump_glyph_matrix
, 0, 1, "p",
15765 doc
: /* Dump the current matrix of the selected window to stderr.
15766 Shows contents of glyph row structures. With non-nil
15767 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15768 glyphs in short form, otherwise show glyphs in long form. */)
15770 Lisp_Object glyphs
;
15772 struct window
*w
= XWINDOW (selected_window
);
15773 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15775 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15776 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15777 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15778 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15779 fprintf (stderr
, "=============================================\n");
15780 dump_glyph_matrix (w
->current_matrix
,
15781 NILP (glyphs
) ? 0 : XINT (glyphs
));
15786 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15787 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15790 struct frame
*f
= XFRAME (selected_frame
);
15791 dump_glyph_matrix (f
->current_matrix
, 1);
15796 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15797 doc
: /* Dump glyph row ROW to stderr.
15798 GLYPH 0 means don't dump glyphs.
15799 GLYPH 1 means dump glyphs in short form.
15800 GLYPH > 1 or omitted means dump glyphs in long form. */)
15802 Lisp_Object row
, glyphs
;
15804 struct glyph_matrix
*matrix
;
15807 CHECK_NUMBER (row
);
15808 matrix
= XWINDOW (selected_window
)->current_matrix
;
15810 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15811 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15813 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15818 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15819 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15820 GLYPH 0 means don't dump glyphs.
15821 GLYPH 1 means dump glyphs in short form.
15822 GLYPH > 1 or omitted means dump glyphs in long form. */)
15824 Lisp_Object row
, glyphs
;
15826 struct frame
*sf
= SELECTED_FRAME ();
15827 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15830 CHECK_NUMBER (row
);
15832 if (vpos
>= 0 && vpos
< m
->nrows
)
15833 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15834 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15839 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15840 doc
: /* Toggle tracing of redisplay.
15841 With ARG, turn tracing on if and only if ARG is positive. */)
15846 trace_redisplay_p
= !trace_redisplay_p
;
15849 arg
= Fprefix_numeric_value (arg
);
15850 trace_redisplay_p
= XINT (arg
) > 0;
15857 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15858 doc
: /* Like `format', but print result to stderr.
15859 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15864 Lisp_Object s
= Fformat (nargs
, args
);
15865 fprintf (stderr
, "%s", SDATA (s
));
15869 #endif /* GLYPH_DEBUG */
15873 /***********************************************************************
15874 Building Desired Matrix Rows
15875 ***********************************************************************/
15877 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15878 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15880 static struct glyph_row
*
15881 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15883 Lisp_Object overlay_arrow_string
;
15885 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15886 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15887 struct buffer
*old
= current_buffer
;
15888 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15889 int arrow_len
= SCHARS (overlay_arrow_string
);
15890 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15891 const unsigned char *p
;
15894 int n_glyphs_before
;
15896 set_buffer_temp (buffer
);
15897 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15898 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15899 SET_TEXT_POS (it
.position
, 0, 0);
15901 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15903 while (p
< arrow_end
)
15905 Lisp_Object face
, ilisp
;
15907 /* Get the next character. */
15909 it
.c
= string_char_and_length (p
, arrow_len
, &it
.len
);
15911 it
.c
= *p
, it
.len
= 1;
15914 /* Get its face. */
15915 ilisp
= make_number (p
- arrow_string
);
15916 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15917 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15919 /* Compute its width, get its glyphs. */
15920 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15921 SET_TEXT_POS (it
.position
, -1, -1);
15922 PRODUCE_GLYPHS (&it
);
15924 /* If this character doesn't fit any more in the line, we have
15925 to remove some glyphs. */
15926 if (it
.current_x
> it
.last_visible_x
)
15928 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15933 set_buffer_temp (old
);
15934 return it
.glyph_row
;
15938 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15939 glyphs are only inserted for terminal frames since we can't really
15940 win with truncation glyphs when partially visible glyphs are
15941 involved. Which glyphs to insert is determined by
15942 produce_special_glyphs. */
15945 insert_left_trunc_glyphs (it
)
15948 struct it truncate_it
;
15949 struct glyph
*from
, *end
, *to
, *toend
;
15951 xassert (!FRAME_WINDOW_P (it
->f
));
15953 /* Get the truncation glyphs. */
15955 truncate_it
.current_x
= 0;
15956 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15957 truncate_it
.glyph_row
= &scratch_glyph_row
;
15958 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15959 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15960 truncate_it
.object
= make_number (0);
15961 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15963 /* Overwrite glyphs from IT with truncation glyphs. */
15964 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15965 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15966 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15967 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15972 /* There may be padding glyphs left over. Overwrite them too. */
15973 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15975 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15981 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15985 /* Compute the pixel height and width of IT->glyph_row.
15987 Most of the time, ascent and height of a display line will be equal
15988 to the max_ascent and max_height values of the display iterator
15989 structure. This is not the case if
15991 1. We hit ZV without displaying anything. In this case, max_ascent
15992 and max_height will be zero.
15994 2. We have some glyphs that don't contribute to the line height.
15995 (The glyph row flag contributes_to_line_height_p is for future
15996 pixmap extensions).
15998 The first case is easily covered by using default values because in
15999 these cases, the line height does not really matter, except that it
16000 must not be zero. */
16003 compute_line_metrics (it
)
16006 struct glyph_row
*row
= it
->glyph_row
;
16009 if (FRAME_WINDOW_P (it
->f
))
16011 int i
, min_y
, max_y
;
16013 /* The line may consist of one space only, that was added to
16014 place the cursor on it. If so, the row's height hasn't been
16016 if (row
->height
== 0)
16018 if (it
->max_ascent
+ it
->max_descent
== 0)
16019 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16020 row
->ascent
= it
->max_ascent
;
16021 row
->height
= it
->max_ascent
+ it
->max_descent
;
16022 row
->phys_ascent
= it
->max_phys_ascent
;
16023 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16024 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16027 /* Compute the width of this line. */
16028 row
->pixel_width
= row
->x
;
16029 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16030 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16032 xassert (row
->pixel_width
>= 0);
16033 xassert (row
->ascent
>= 0 && row
->height
> 0);
16035 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16036 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16038 /* If first line's physical ascent is larger than its logical
16039 ascent, use the physical ascent, and make the row taller.
16040 This makes accented characters fully visible. */
16041 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16042 && row
->phys_ascent
> row
->ascent
)
16044 row
->height
+= row
->phys_ascent
- row
->ascent
;
16045 row
->ascent
= row
->phys_ascent
;
16048 /* Compute how much of the line is visible. */
16049 row
->visible_height
= row
->height
;
16051 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16052 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16054 if (row
->y
< min_y
)
16055 row
->visible_height
-= min_y
- row
->y
;
16056 if (row
->y
+ row
->height
> max_y
)
16057 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16061 row
->pixel_width
= row
->used
[TEXT_AREA
];
16062 if (row
->continued_p
)
16063 row
->pixel_width
-= it
->continuation_pixel_width
;
16064 else if (row
->truncated_on_right_p
)
16065 row
->pixel_width
-= it
->truncation_pixel_width
;
16066 row
->ascent
= row
->phys_ascent
= 0;
16067 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16068 row
->extra_line_spacing
= 0;
16071 /* Compute a hash code for this row. */
16073 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16074 for (i
= 0; i
< row
->used
[area
]; ++i
)
16075 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16076 + row
->glyphs
[area
][i
].u
.val
16077 + row
->glyphs
[area
][i
].face_id
16078 + row
->glyphs
[area
][i
].padding_p
16079 + (row
->glyphs
[area
][i
].type
<< 2));
16081 it
->max_ascent
= it
->max_descent
= 0;
16082 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16086 /* Append one space to the glyph row of iterator IT if doing a
16087 window-based redisplay. The space has the same face as
16088 IT->face_id. Value is non-zero if a space was added.
16090 This function is called to make sure that there is always one glyph
16091 at the end of a glyph row that the cursor can be set on under
16092 window-systems. (If there weren't such a glyph we would not know
16093 how wide and tall a box cursor should be displayed).
16095 At the same time this space let's a nicely handle clearing to the
16096 end of the line if the row ends in italic text. */
16099 append_space_for_newline (it
, default_face_p
)
16101 int default_face_p
;
16103 if (FRAME_WINDOW_P (it
->f
))
16105 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16107 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16108 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16110 /* Save some values that must not be changed.
16111 Must save IT->c and IT->len because otherwise
16112 ITERATOR_AT_END_P wouldn't work anymore after
16113 append_space_for_newline has been called. */
16114 enum display_element_type saved_what
= it
->what
;
16115 int saved_c
= it
->c
, saved_len
= it
->len
;
16116 int saved_x
= it
->current_x
;
16117 int saved_face_id
= it
->face_id
;
16118 struct text_pos saved_pos
;
16119 Lisp_Object saved_object
;
16122 saved_object
= it
->object
;
16123 saved_pos
= it
->position
;
16125 it
->what
= IT_CHARACTER
;
16126 bzero (&it
->position
, sizeof it
->position
);
16127 it
->object
= make_number (0);
16131 if (default_face_p
)
16132 it
->face_id
= DEFAULT_FACE_ID
;
16133 else if (it
->face_before_selective_p
)
16134 it
->face_id
= it
->saved_face_id
;
16135 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16136 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16138 PRODUCE_GLYPHS (it
);
16140 it
->override_ascent
= -1;
16141 it
->constrain_row_ascent_descent_p
= 0;
16142 it
->current_x
= saved_x
;
16143 it
->object
= saved_object
;
16144 it
->position
= saved_pos
;
16145 it
->what
= saved_what
;
16146 it
->face_id
= saved_face_id
;
16147 it
->len
= saved_len
;
16157 /* Extend the face of the last glyph in the text area of IT->glyph_row
16158 to the end of the display line. Called from display_line.
16159 If the glyph row is empty, add a space glyph to it so that we
16160 know the face to draw. Set the glyph row flag fill_line_p. */
16163 extend_face_to_end_of_line (it
)
16167 struct frame
*f
= it
->f
;
16169 /* If line is already filled, do nothing. */
16170 if (it
->current_x
>= it
->last_visible_x
)
16173 /* Face extension extends the background and box of IT->face_id
16174 to the end of the line. If the background equals the background
16175 of the frame, we don't have to do anything. */
16176 if (it
->face_before_selective_p
)
16177 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16179 face
= FACE_FROM_ID (f
, it
->face_id
);
16181 if (FRAME_WINDOW_P (f
)
16182 && it
->glyph_row
->displays_text_p
16183 && face
->box
== FACE_NO_BOX
16184 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16188 /* Set the glyph row flag indicating that the face of the last glyph
16189 in the text area has to be drawn to the end of the text area. */
16190 it
->glyph_row
->fill_line_p
= 1;
16192 /* If current character of IT is not ASCII, make sure we have the
16193 ASCII face. This will be automatically undone the next time
16194 get_next_display_element returns a multibyte character. Note
16195 that the character will always be single byte in unibyte text. */
16196 if (!ASCII_CHAR_P (it
->c
))
16198 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16201 if (FRAME_WINDOW_P (f
))
16203 /* If the row is empty, add a space with the current face of IT,
16204 so that we know which face to draw. */
16205 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16207 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16208 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16209 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16214 /* Save some values that must not be changed. */
16215 int saved_x
= it
->current_x
;
16216 struct text_pos saved_pos
;
16217 Lisp_Object saved_object
;
16218 enum display_element_type saved_what
= it
->what
;
16219 int saved_face_id
= it
->face_id
;
16221 saved_object
= it
->object
;
16222 saved_pos
= it
->position
;
16224 it
->what
= IT_CHARACTER
;
16225 bzero (&it
->position
, sizeof it
->position
);
16226 it
->object
= make_number (0);
16229 it
->face_id
= face
->id
;
16231 PRODUCE_GLYPHS (it
);
16233 while (it
->current_x
<= it
->last_visible_x
)
16234 PRODUCE_GLYPHS (it
);
16236 /* Don't count these blanks really. It would let us insert a left
16237 truncation glyph below and make us set the cursor on them, maybe. */
16238 it
->current_x
= saved_x
;
16239 it
->object
= saved_object
;
16240 it
->position
= saved_pos
;
16241 it
->what
= saved_what
;
16242 it
->face_id
= saved_face_id
;
16247 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16248 trailing whitespace. */
16251 trailing_whitespace_p (charpos
)
16254 int bytepos
= CHAR_TO_BYTE (charpos
);
16257 while (bytepos
< ZV_BYTE
16258 && (c
= FETCH_CHAR (bytepos
),
16259 c
== ' ' || c
== '\t'))
16262 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16264 if (bytepos
!= PT_BYTE
)
16271 /* Highlight trailing whitespace, if any, in ROW. */
16274 highlight_trailing_whitespace (f
, row
)
16276 struct glyph_row
*row
;
16278 int used
= row
->used
[TEXT_AREA
];
16282 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16283 struct glyph
*glyph
= start
+ used
- 1;
16285 /* Skip over glyphs inserted to display the cursor at the
16286 end of a line, for extending the face of the last glyph
16287 to the end of the line on terminals, and for truncation
16288 and continuation glyphs. */
16289 while (glyph
>= start
16290 && glyph
->type
== CHAR_GLYPH
16291 && INTEGERP (glyph
->object
))
16294 /* If last glyph is a space or stretch, and it's trailing
16295 whitespace, set the face of all trailing whitespace glyphs in
16296 IT->glyph_row to `trailing-whitespace'. */
16298 && BUFFERP (glyph
->object
)
16299 && (glyph
->type
== STRETCH_GLYPH
16300 || (glyph
->type
== CHAR_GLYPH
16301 && glyph
->u
.ch
== ' '))
16302 && trailing_whitespace_p (glyph
->charpos
))
16304 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16308 while (glyph
>= start
16309 && BUFFERP (glyph
->object
)
16310 && (glyph
->type
== STRETCH_GLYPH
16311 || (glyph
->type
== CHAR_GLYPH
16312 && glyph
->u
.ch
== ' ')))
16313 (glyph
--)->face_id
= face_id
;
16319 /* Value is non-zero if glyph row ROW in window W should be
16320 used to hold the cursor. */
16323 cursor_row_p (w
, row
)
16325 struct glyph_row
*row
;
16327 int cursor_row_p
= 1;
16329 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16331 /* Suppose the row ends on a string.
16332 Unless the row is continued, that means it ends on a newline
16333 in the string. If it's anything other than a display string
16334 (e.g. a before-string from an overlay), we don't want the
16335 cursor there. (This heuristic seems to give the optimal
16336 behavior for the various types of multi-line strings.) */
16337 if (CHARPOS (row
->end
.string_pos
) >= 0)
16339 if (row
->continued_p
)
16343 /* Check for `display' property. */
16344 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16345 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16346 struct glyph
*glyph
;
16349 for (glyph
= end
; glyph
>= beg
; --glyph
)
16350 if (STRINGP (glyph
->object
))
16353 = Fget_char_property (make_number (PT
),
16357 && display_prop_string_p (prop
, glyph
->object
));
16362 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16364 /* If the row ends in middle of a real character,
16365 and the line is continued, we want the cursor here.
16366 That's because MATRIX_ROW_END_CHARPOS would equal
16367 PT if PT is before the character. */
16368 if (!row
->ends_in_ellipsis_p
)
16369 cursor_row_p
= row
->continued_p
;
16371 /* If the row ends in an ellipsis, then
16372 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16373 We want that position to be displayed after the ellipsis. */
16376 /* If the row ends at ZV, display the cursor at the end of that
16377 row instead of at the start of the row below. */
16378 else if (row
->ends_at_zv_p
)
16384 return cursor_row_p
;
16389 /* Push the display property PROP so that it will be rendered at the
16390 current position in IT. */
16393 push_display_prop (struct it
*it
, Lisp_Object prop
)
16397 /* Never display a cursor on the prefix. */
16398 it
->avoid_cursor_p
= 1;
16400 if (STRINGP (prop
))
16402 if (SCHARS (prop
) == 0)
16409 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16410 it
->current
.overlay_string_index
= -1;
16411 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16412 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16413 it
->method
= GET_FROM_STRING
;
16414 it
->stop_charpos
= 0;
16416 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16418 it
->method
= GET_FROM_STRETCH
;
16421 #ifdef HAVE_WINDOW_SYSTEM
16422 else if (IMAGEP (prop
))
16424 it
->what
= IT_IMAGE
;
16425 it
->image_id
= lookup_image (it
->f
, prop
);
16426 it
->method
= GET_FROM_IMAGE
;
16428 #endif /* HAVE_WINDOW_SYSTEM */
16431 pop_it (it
); /* bogus display property, give up */
16436 /* Return the character-property PROP at the current position in IT. */
16439 get_it_property (it
, prop
)
16443 Lisp_Object position
;
16445 if (STRINGP (it
->object
))
16446 position
= make_number (IT_STRING_CHARPOS (*it
));
16447 else if (BUFFERP (it
->object
))
16448 position
= make_number (IT_CHARPOS (*it
));
16452 return Fget_char_property (position
, prop
, it
->object
);
16455 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16458 handle_line_prefix (struct it
*it
)
16460 Lisp_Object prefix
;
16461 if (it
->continuation_lines_width
> 0)
16463 prefix
= get_it_property (it
, Qwrap_prefix
);
16465 prefix
= Vwrap_prefix
;
16469 prefix
= get_it_property (it
, Qline_prefix
);
16471 prefix
= Vline_prefix
;
16473 if (! NILP (prefix
))
16474 push_display_prop (it
, prefix
);
16479 /* Construct the glyph row IT->glyph_row in the desired matrix of
16480 IT->w from text at the current position of IT. See dispextern.h
16481 for an overview of struct it. Value is non-zero if
16482 IT->glyph_row displays text, as opposed to a line displaying ZV
16489 struct glyph_row
*row
= it
->glyph_row
;
16490 Lisp_Object overlay_arrow_string
;
16492 int may_wrap
= 0, wrap_x
;
16493 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16494 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16495 int wrap_row_extra_line_spacing
;
16497 /* We always start displaying at hpos zero even if hscrolled. */
16498 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16500 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16501 >= it
->w
->desired_matrix
->nrows
)
16503 it
->w
->nrows_scale_factor
++;
16504 fonts_changed_p
= 1;
16508 /* Is IT->w showing the region? */
16509 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16511 /* Clear the result glyph row and enable it. */
16512 prepare_desired_row (row
);
16514 row
->y
= it
->current_y
;
16515 row
->start
= it
->start
;
16516 row
->continuation_lines_width
= it
->continuation_lines_width
;
16517 row
->displays_text_p
= 1;
16518 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16519 it
->starts_in_middle_of_char_p
= 0;
16521 /* Arrange the overlays nicely for our purposes. Usually, we call
16522 display_line on only one line at a time, in which case this
16523 can't really hurt too much, or we call it on lines which appear
16524 one after another in the buffer, in which case all calls to
16525 recenter_overlay_lists but the first will be pretty cheap. */
16526 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16528 /* Move over display elements that are not visible because we are
16529 hscrolled. This may stop at an x-position < IT->first_visible_x
16530 if the first glyph is partially visible or if we hit a line end. */
16531 if (it
->current_x
< it
->first_visible_x
)
16533 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16534 MOVE_TO_POS
| MOVE_TO_X
);
16538 /* We only do this when not calling `move_it_in_display_line_to'
16539 above, because move_it_in_display_line_to calls
16540 handle_line_prefix itself. */
16541 handle_line_prefix (it
);
16544 /* Get the initial row height. This is either the height of the
16545 text hscrolled, if there is any, or zero. */
16546 row
->ascent
= it
->max_ascent
;
16547 row
->height
= it
->max_ascent
+ it
->max_descent
;
16548 row
->phys_ascent
= it
->max_phys_ascent
;
16549 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16550 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16552 /* Loop generating characters. The loop is left with IT on the next
16553 character to display. */
16556 int n_glyphs_before
, hpos_before
, x_before
;
16558 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16560 /* Retrieve the next thing to display. Value is zero if end of
16562 if (!get_next_display_element (it
))
16564 /* Maybe add a space at the end of this line that is used to
16565 display the cursor there under X. Set the charpos of the
16566 first glyph of blank lines not corresponding to any text
16568 #ifdef HAVE_WINDOW_SYSTEM
16569 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16570 row
->exact_window_width_line_p
= 1;
16572 #endif /* HAVE_WINDOW_SYSTEM */
16573 if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16574 || row
->used
[TEXT_AREA
] == 0)
16576 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16577 row
->displays_text_p
= 0;
16579 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16580 && (!MINI_WINDOW_P (it
->w
)
16581 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16582 row
->indicate_empty_line_p
= 1;
16585 it
->continuation_lines_width
= 0;
16586 row
->ends_at_zv_p
= 1;
16590 /* Now, get the metrics of what we want to display. This also
16591 generates glyphs in `row' (which is IT->glyph_row). */
16592 n_glyphs_before
= row
->used
[TEXT_AREA
];
16595 /* Remember the line height so far in case the next element doesn't
16596 fit on the line. */
16597 if (it
->line_wrap
!= TRUNCATE
)
16599 ascent
= it
->max_ascent
;
16600 descent
= it
->max_descent
;
16601 phys_ascent
= it
->max_phys_ascent
;
16602 phys_descent
= it
->max_phys_descent
;
16604 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16606 if (IT_DISPLAYING_WHITESPACE (it
))
16612 wrap_row_used
= row
->used
[TEXT_AREA
];
16613 wrap_row_ascent
= row
->ascent
;
16614 wrap_row_height
= row
->height
;
16615 wrap_row_phys_ascent
= row
->phys_ascent
;
16616 wrap_row_phys_height
= row
->phys_height
;
16617 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16623 PRODUCE_GLYPHS (it
);
16625 /* If this display element was in marginal areas, continue with
16627 if (it
->area
!= TEXT_AREA
)
16629 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16630 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16631 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16632 row
->phys_height
= max (row
->phys_height
,
16633 it
->max_phys_ascent
+ it
->max_phys_descent
);
16634 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16635 it
->max_extra_line_spacing
);
16636 set_iterator_to_next (it
, 1);
16640 /* Does the display element fit on the line? If we truncate
16641 lines, we should draw past the right edge of the window. If
16642 we don't truncate, we want to stop so that we can display the
16643 continuation glyph before the right margin. If lines are
16644 continued, there are two possible strategies for characters
16645 resulting in more than 1 glyph (e.g. tabs): Display as many
16646 glyphs as possible in this line and leave the rest for the
16647 continuation line, or display the whole element in the next
16648 line. Original redisplay did the former, so we do it also. */
16649 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16650 hpos_before
= it
->hpos
;
16653 if (/* Not a newline. */
16655 /* Glyphs produced fit entirely in the line. */
16656 && it
->current_x
< it
->last_visible_x
)
16658 it
->hpos
+= nglyphs
;
16659 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16660 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16661 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16662 row
->phys_height
= max (row
->phys_height
,
16663 it
->max_phys_ascent
+ it
->max_phys_descent
);
16664 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16665 it
->max_extra_line_spacing
);
16666 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16667 row
->x
= x
- it
->first_visible_x
;
16672 struct glyph
*glyph
;
16674 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16676 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16677 new_x
= x
+ glyph
->pixel_width
;
16679 if (/* Lines are continued. */
16680 it
->line_wrap
!= TRUNCATE
16681 && (/* Glyph doesn't fit on the line. */
16682 new_x
> it
->last_visible_x
16683 /* Or it fits exactly on a window system frame. */
16684 || (new_x
== it
->last_visible_x
16685 && FRAME_WINDOW_P (it
->f
))))
16687 /* End of a continued line. */
16690 || (new_x
== it
->last_visible_x
16691 && FRAME_WINDOW_P (it
->f
)))
16693 /* Current glyph is the only one on the line or
16694 fits exactly on the line. We must continue
16695 the line because we can't draw the cursor
16696 after the glyph. */
16697 row
->continued_p
= 1;
16698 it
->current_x
= new_x
;
16699 it
->continuation_lines_width
+= new_x
;
16701 if (i
== nglyphs
- 1)
16703 /* If line-wrap is on, check if a previous
16704 wrap point was found. */
16705 if (wrap_row_used
> 0
16706 /* Even if there is a previous wrap
16707 point, continue the line here as
16708 usual, if (i) the previous character
16709 was a space or tab AND (ii) the
16710 current character is not. */
16712 || IT_DISPLAYING_WHITESPACE (it
)))
16715 set_iterator_to_next (it
, 1);
16716 #ifdef HAVE_WINDOW_SYSTEM
16717 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16719 if (!get_next_display_element (it
))
16721 row
->exact_window_width_line_p
= 1;
16722 it
->continuation_lines_width
= 0;
16723 row
->continued_p
= 0;
16724 row
->ends_at_zv_p
= 1;
16726 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16728 row
->continued_p
= 0;
16729 row
->exact_window_width_line_p
= 1;
16732 #endif /* HAVE_WINDOW_SYSTEM */
16735 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16736 && !FRAME_WINDOW_P (it
->f
))
16738 /* A padding glyph that doesn't fit on this line.
16739 This means the whole character doesn't fit
16741 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16743 /* Fill the rest of the row with continuation
16744 glyphs like in 20.x. */
16745 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16746 < row
->glyphs
[1 + TEXT_AREA
])
16747 produce_special_glyphs (it
, IT_CONTINUATION
);
16749 row
->continued_p
= 1;
16750 it
->current_x
= x_before
;
16751 it
->continuation_lines_width
+= x_before
;
16753 /* Restore the height to what it was before the
16754 element not fitting on the line. */
16755 it
->max_ascent
= ascent
;
16756 it
->max_descent
= descent
;
16757 it
->max_phys_ascent
= phys_ascent
;
16758 it
->max_phys_descent
= phys_descent
;
16760 else if (wrap_row_used
> 0)
16764 it
->continuation_lines_width
+= wrap_x
;
16765 row
->used
[TEXT_AREA
] = wrap_row_used
;
16766 row
->ascent
= wrap_row_ascent
;
16767 row
->height
= wrap_row_height
;
16768 row
->phys_ascent
= wrap_row_phys_ascent
;
16769 row
->phys_height
= wrap_row_phys_height
;
16770 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16771 row
->continued_p
= 1;
16772 row
->ends_at_zv_p
= 0;
16773 row
->exact_window_width_line_p
= 0;
16774 it
->continuation_lines_width
+= x
;
16776 /* Make sure that a non-default face is extended
16777 up to the right margin of the window. */
16778 extend_face_to_end_of_line (it
);
16780 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16782 /* A TAB that extends past the right edge of the
16783 window. This produces a single glyph on
16784 window system frames. We leave the glyph in
16785 this row and let it fill the row, but don't
16786 consume the TAB. */
16787 it
->continuation_lines_width
+= it
->last_visible_x
;
16788 row
->ends_in_middle_of_char_p
= 1;
16789 row
->continued_p
= 1;
16790 glyph
->pixel_width
= it
->last_visible_x
- x
;
16791 it
->starts_in_middle_of_char_p
= 1;
16795 /* Something other than a TAB that draws past
16796 the right edge of the window. Restore
16797 positions to values before the element. */
16798 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16800 /* Display continuation glyphs. */
16801 if (!FRAME_WINDOW_P (it
->f
))
16802 produce_special_glyphs (it
, IT_CONTINUATION
);
16803 row
->continued_p
= 1;
16805 it
->current_x
= x_before
;
16806 it
->continuation_lines_width
+= x
;
16807 extend_face_to_end_of_line (it
);
16809 if (nglyphs
> 1 && i
> 0)
16811 row
->ends_in_middle_of_char_p
= 1;
16812 it
->starts_in_middle_of_char_p
= 1;
16815 /* Restore the height to what it was before the
16816 element not fitting on the line. */
16817 it
->max_ascent
= ascent
;
16818 it
->max_descent
= descent
;
16819 it
->max_phys_ascent
= phys_ascent
;
16820 it
->max_phys_descent
= phys_descent
;
16825 else if (new_x
> it
->first_visible_x
)
16827 /* Increment number of glyphs actually displayed. */
16830 if (x
< it
->first_visible_x
)
16831 /* Glyph is partially visible, i.e. row starts at
16832 negative X position. */
16833 row
->x
= x
- it
->first_visible_x
;
16837 /* Glyph is completely off the left margin of the
16838 window. This should not happen because of the
16839 move_it_in_display_line at the start of this
16840 function, unless the text display area of the
16841 window is empty. */
16842 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16846 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16847 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16848 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16849 row
->phys_height
= max (row
->phys_height
,
16850 it
->max_phys_ascent
+ it
->max_phys_descent
);
16851 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16852 it
->max_extra_line_spacing
);
16854 /* End of this display line if row is continued. */
16855 if (row
->continued_p
|| row
->ends_at_zv_p
)
16860 /* Is this a line end? If yes, we're also done, after making
16861 sure that a non-default face is extended up to the right
16862 margin of the window. */
16863 if (ITERATOR_AT_END_OF_LINE_P (it
))
16865 int used_before
= row
->used
[TEXT_AREA
];
16867 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16869 #ifdef HAVE_WINDOW_SYSTEM
16870 /* Add a space at the end of the line that is used to
16871 display the cursor there. */
16872 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16873 append_space_for_newline (it
, 0);
16874 #endif /* HAVE_WINDOW_SYSTEM */
16876 /* Extend the face to the end of the line. */
16877 extend_face_to_end_of_line (it
);
16879 /* Make sure we have the position. */
16880 if (used_before
== 0)
16881 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16883 /* Consume the line end. This skips over invisible lines. */
16884 set_iterator_to_next (it
, 1);
16885 it
->continuation_lines_width
= 0;
16889 /* Proceed with next display element. Note that this skips
16890 over lines invisible because of selective display. */
16891 set_iterator_to_next (it
, 1);
16893 /* If we truncate lines, we are done when the last displayed
16894 glyphs reach past the right margin of the window. */
16895 if (it
->line_wrap
== TRUNCATE
16896 && (FRAME_WINDOW_P (it
->f
)
16897 ? (it
->current_x
>= it
->last_visible_x
)
16898 : (it
->current_x
> it
->last_visible_x
)))
16900 /* Maybe add truncation glyphs. */
16901 if (!FRAME_WINDOW_P (it
->f
))
16905 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16906 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16909 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16911 row
->used
[TEXT_AREA
] = i
;
16912 produce_special_glyphs (it
, IT_TRUNCATION
);
16915 #ifdef HAVE_WINDOW_SYSTEM
16918 /* Don't truncate if we can overflow newline into fringe. */
16919 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16921 if (!get_next_display_element (it
))
16923 it
->continuation_lines_width
= 0;
16924 row
->ends_at_zv_p
= 1;
16925 row
->exact_window_width_line_p
= 1;
16928 if (ITERATOR_AT_END_OF_LINE_P (it
))
16930 row
->exact_window_width_line_p
= 1;
16931 goto at_end_of_line
;
16935 #endif /* HAVE_WINDOW_SYSTEM */
16937 row
->truncated_on_right_p
= 1;
16938 it
->continuation_lines_width
= 0;
16939 reseat_at_next_visible_line_start (it
, 0);
16940 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16941 it
->hpos
= hpos_before
;
16942 it
->current_x
= x_before
;
16947 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16948 at the left window margin. */
16949 if (it
->first_visible_x
16950 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16952 if (!FRAME_WINDOW_P (it
->f
))
16953 insert_left_trunc_glyphs (it
);
16954 row
->truncated_on_left_p
= 1;
16957 /* If the start of this line is the overlay arrow-position, then
16958 mark this glyph row as the one containing the overlay arrow.
16959 This is clearly a mess with variable size fonts. It would be
16960 better to let it be displayed like cursors under X. */
16961 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16962 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16963 !NILP (overlay_arrow_string
)))
16965 /* Overlay arrow in window redisplay is a fringe bitmap. */
16966 if (STRINGP (overlay_arrow_string
))
16968 struct glyph_row
*arrow_row
16969 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16970 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16971 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16972 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16973 struct glyph
*p2
, *end
;
16975 /* Copy the arrow glyphs. */
16976 while (glyph
< arrow_end
)
16979 /* Throw away padding glyphs. */
16981 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16982 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16988 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16993 xassert (INTEGERP (overlay_arrow_string
));
16994 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16996 overlay_arrow_seen
= 1;
16999 /* Compute pixel dimensions of this line. */
17000 compute_line_metrics (it
);
17002 /* Remember the position at which this line ends. */
17003 row
->end
= it
->current
;
17005 /* Record whether this row ends inside an ellipsis. */
17006 row
->ends_in_ellipsis_p
17007 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17008 && it
->ellipsis_p
);
17010 /* Save fringe bitmaps in this row. */
17011 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17012 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17013 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17014 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17016 it
->left_user_fringe_bitmap
= 0;
17017 it
->left_user_fringe_face_id
= 0;
17018 it
->right_user_fringe_bitmap
= 0;
17019 it
->right_user_fringe_face_id
= 0;
17021 /* Maybe set the cursor. */
17022 if (it
->w
->cursor
.vpos
< 0
17023 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17024 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17025 && cursor_row_p (it
->w
, row
))
17026 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17028 /* Highlight trailing whitespace. */
17029 if (!NILP (Vshow_trailing_whitespace
))
17030 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17032 /* Prepare for the next line. This line starts horizontally at (X
17033 HPOS) = (0 0). Vertical positions are incremented. As a
17034 convenience for the caller, IT->glyph_row is set to the next
17036 it
->current_x
= it
->hpos
= 0;
17037 it
->current_y
+= row
->height
;
17040 it
->start
= it
->current
;
17041 return row
->displays_text_p
;
17046 /***********************************************************************
17048 ***********************************************************************/
17050 /* Redisplay the menu bar in the frame for window W.
17052 The menu bar of X frames that don't have X toolkit support is
17053 displayed in a special window W->frame->menu_bar_window.
17055 The menu bar of terminal frames is treated specially as far as
17056 glyph matrices are concerned. Menu bar lines are not part of
17057 windows, so the update is done directly on the frame matrix rows
17058 for the menu bar. */
17061 display_menu_bar (w
)
17064 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17069 /* Don't do all this for graphical frames. */
17071 if (FRAME_W32_P (f
))
17074 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17080 if (FRAME_NS_P (f
))
17082 #endif /* HAVE_NS */
17084 #ifdef USE_X_TOOLKIT
17085 xassert (!FRAME_WINDOW_P (f
));
17086 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17087 it
.first_visible_x
= 0;
17088 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17089 #else /* not USE_X_TOOLKIT */
17090 if (FRAME_WINDOW_P (f
))
17092 /* Menu bar lines are displayed in the desired matrix of the
17093 dummy window menu_bar_window. */
17094 struct window
*menu_w
;
17095 xassert (WINDOWP (f
->menu_bar_window
));
17096 menu_w
= XWINDOW (f
->menu_bar_window
);
17097 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17099 it
.first_visible_x
= 0;
17100 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17104 /* This is a TTY frame, i.e. character hpos/vpos are used as
17106 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17108 it
.first_visible_x
= 0;
17109 it
.last_visible_x
= FRAME_COLS (f
);
17111 #endif /* not USE_X_TOOLKIT */
17113 if (! mode_line_inverse_video
)
17114 /* Force the menu-bar to be displayed in the default face. */
17115 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17117 /* Clear all rows of the menu bar. */
17118 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17120 struct glyph_row
*row
= it
.glyph_row
+ i
;
17121 clear_glyph_row (row
);
17122 row
->enabled_p
= 1;
17123 row
->full_width_p
= 1;
17126 /* Display all items of the menu bar. */
17127 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17128 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17130 Lisp_Object string
;
17132 /* Stop at nil string. */
17133 string
= AREF (items
, i
+ 1);
17137 /* Remember where item was displayed. */
17138 ASET (items
, i
+ 3, make_number (it
.hpos
));
17140 /* Display the item, pad with one space. */
17141 if (it
.current_x
< it
.last_visible_x
)
17142 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17143 SCHARS (string
) + 1, 0, 0, -1);
17146 /* Fill out the line with spaces. */
17147 if (it
.current_x
< it
.last_visible_x
)
17148 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17150 /* Compute the total height of the lines. */
17151 compute_line_metrics (&it
);
17156 /***********************************************************************
17158 ***********************************************************************/
17160 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17161 FORCE is non-zero, redisplay mode lines unconditionally.
17162 Otherwise, redisplay only mode lines that are garbaged. Value is
17163 the number of windows whose mode lines were redisplayed. */
17166 redisplay_mode_lines (window
, force
)
17167 Lisp_Object window
;
17172 while (!NILP (window
))
17174 struct window
*w
= XWINDOW (window
);
17176 if (WINDOWP (w
->hchild
))
17177 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17178 else if (WINDOWP (w
->vchild
))
17179 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17181 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17182 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17184 struct text_pos lpoint
;
17185 struct buffer
*old
= current_buffer
;
17187 /* Set the window's buffer for the mode line display. */
17188 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17189 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17191 /* Point refers normally to the selected window. For any
17192 other window, set up appropriate value. */
17193 if (!EQ (window
, selected_window
))
17195 struct text_pos pt
;
17197 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17198 if (CHARPOS (pt
) < BEGV
)
17199 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17200 else if (CHARPOS (pt
) > (ZV
- 1))
17201 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17203 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17206 /* Display mode lines. */
17207 clear_glyph_matrix (w
->desired_matrix
);
17208 if (display_mode_lines (w
))
17211 w
->must_be_updated_p
= 1;
17214 /* Restore old settings. */
17215 set_buffer_internal_1 (old
);
17216 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17226 /* Display the mode and/or top line of window W. Value is the number
17227 of mode lines displayed. */
17230 display_mode_lines (w
)
17233 Lisp_Object old_selected_window
, old_selected_frame
;
17236 old_selected_frame
= selected_frame
;
17237 selected_frame
= w
->frame
;
17238 old_selected_window
= selected_window
;
17239 XSETWINDOW (selected_window
, w
);
17241 /* These will be set while the mode line specs are processed. */
17242 line_number_displayed
= 0;
17243 w
->column_number_displayed
= Qnil
;
17245 if (WINDOW_WANTS_MODELINE_P (w
))
17247 struct window
*sel_w
= XWINDOW (old_selected_window
);
17249 /* Select mode line face based on the real selected window. */
17250 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17251 current_buffer
->mode_line_format
);
17255 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17257 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17258 current_buffer
->header_line_format
);
17262 selected_frame
= old_selected_frame
;
17263 selected_window
= old_selected_window
;
17268 /* Display mode or top line of window W. FACE_ID specifies which line
17269 to display; it is either MODE_LINE_FACE_ID or HEADER_LINE_FACE_ID.
17270 FORMAT is the mode line format to display. Value is the pixel
17271 height of the mode line displayed. */
17274 display_mode_line (w
, face_id
, format
)
17276 enum face_id face_id
;
17277 Lisp_Object format
;
17281 int count
= SPECPDL_INDEX ();
17283 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17284 /* Don't extend on a previously drawn mode-line.
17285 This may happen if called from pos_visible_p. */
17286 it
.glyph_row
->enabled_p
= 0;
17287 prepare_desired_row (it
.glyph_row
);
17289 it
.glyph_row
->mode_line_p
= 1;
17291 if (! mode_line_inverse_video
)
17292 /* Force the mode-line to be displayed in the default face. */
17293 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17295 record_unwind_protect (unwind_format_mode_line
,
17296 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17298 mode_line_target
= MODE_LINE_DISPLAY
;
17300 /* Temporarily make frame's keyboard the current kboard so that
17301 kboard-local variables in the mode_line_format will get the right
17303 push_kboard (FRAME_KBOARD (it
.f
));
17304 record_unwind_save_match_data ();
17305 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17308 unbind_to (count
, Qnil
);
17310 /* Fill up with spaces. */
17311 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17313 compute_line_metrics (&it
);
17314 it
.glyph_row
->full_width_p
= 1;
17315 it
.glyph_row
->continued_p
= 0;
17316 it
.glyph_row
->truncated_on_left_p
= 0;
17317 it
.glyph_row
->truncated_on_right_p
= 0;
17319 /* Make a 3D mode-line have a shadow at its right end. */
17320 face
= FACE_FROM_ID (it
.f
, face_id
);
17321 extend_face_to_end_of_line (&it
);
17322 if (face
->box
!= FACE_NO_BOX
)
17324 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17325 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17326 last
->right_box_line_p
= 1;
17329 return it
.glyph_row
->height
;
17332 /* Move element ELT in LIST to the front of LIST.
17333 Return the updated list. */
17336 move_elt_to_front (elt
, list
)
17337 Lisp_Object elt
, list
;
17339 register Lisp_Object tail
, prev
;
17340 register Lisp_Object tem
;
17344 while (CONSP (tail
))
17350 /* Splice out the link TAIL. */
17352 list
= XCDR (tail
);
17354 Fsetcdr (prev
, XCDR (tail
));
17356 /* Now make it the first. */
17357 Fsetcdr (tail
, list
);
17362 tail
= XCDR (tail
);
17366 /* Not found--return unchanged LIST. */
17370 /* Contribute ELT to the mode line for window IT->w. How it
17371 translates into text depends on its data type.
17373 IT describes the display environment in which we display, as usual.
17375 DEPTH is the depth in recursion. It is used to prevent
17376 infinite recursion here.
17378 FIELD_WIDTH is the number of characters the display of ELT should
17379 occupy in the mode line, and PRECISION is the maximum number of
17380 characters to display from ELT's representation. See
17381 display_string for details.
17383 Returns the hpos of the end of the text generated by ELT.
17385 PROPS is a property list to add to any string we encounter.
17387 If RISKY is nonzero, remove (disregard) any properties in any string
17388 we encounter, and ignore :eval and :propertize.
17390 The global variable `mode_line_target' determines whether the
17391 output is passed to `store_mode_line_noprop',
17392 `store_mode_line_string', or `display_string'. */
17395 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17398 int field_width
, precision
;
17399 Lisp_Object elt
, props
;
17402 int n
= 0, field
, prec
;
17407 elt
= build_string ("*too-deep*");
17411 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17415 /* A string: output it and check for %-constructs within it. */
17419 if (SCHARS (elt
) > 0
17420 && (!NILP (props
) || risky
))
17422 Lisp_Object oprops
, aelt
;
17423 oprops
= Ftext_properties_at (make_number (0), elt
);
17425 /* If the starting string's properties are not what
17426 we want, translate the string. Also, if the string
17427 is risky, do that anyway. */
17429 if (NILP (Fequal (props
, oprops
)) || risky
)
17431 /* If the starting string has properties,
17432 merge the specified ones onto the existing ones. */
17433 if (! NILP (oprops
) && !risky
)
17437 oprops
= Fcopy_sequence (oprops
);
17439 while (CONSP (tem
))
17441 oprops
= Fplist_put (oprops
, XCAR (tem
),
17442 XCAR (XCDR (tem
)));
17443 tem
= XCDR (XCDR (tem
));
17448 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17449 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17451 /* AELT is what we want. Move it to the front
17452 without consing. */
17454 mode_line_proptrans_alist
17455 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17461 /* If AELT has the wrong props, it is useless.
17462 so get rid of it. */
17464 mode_line_proptrans_alist
17465 = Fdelq (aelt
, mode_line_proptrans_alist
);
17467 elt
= Fcopy_sequence (elt
);
17468 Fset_text_properties (make_number (0), Flength (elt
),
17470 /* Add this item to mode_line_proptrans_alist. */
17471 mode_line_proptrans_alist
17472 = Fcons (Fcons (elt
, props
),
17473 mode_line_proptrans_alist
);
17474 /* Truncate mode_line_proptrans_alist
17475 to at most 50 elements. */
17476 tem
= Fnthcdr (make_number (50),
17477 mode_line_proptrans_alist
);
17479 XSETCDR (tem
, Qnil
);
17488 prec
= precision
- n
;
17489 switch (mode_line_target
)
17491 case MODE_LINE_NOPROP
:
17492 case MODE_LINE_TITLE
:
17493 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17495 case MODE_LINE_STRING
:
17496 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17498 case MODE_LINE_DISPLAY
:
17499 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17500 0, prec
, 0, STRING_MULTIBYTE (elt
));
17507 /* Handle the non-literal case. */
17509 while ((precision
<= 0 || n
< precision
)
17510 && SREF (elt
, offset
) != 0
17511 && (mode_line_target
!= MODE_LINE_DISPLAY
17512 || it
->current_x
< it
->last_visible_x
))
17514 int last_offset
= offset
;
17516 /* Advance to end of string or next format specifier. */
17517 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17520 if (offset
- 1 != last_offset
)
17522 int nchars
, nbytes
;
17524 /* Output to end of string or up to '%'. Field width
17525 is length of string. Don't output more than
17526 PRECISION allows us. */
17529 prec
= c_string_width (SDATA (elt
) + last_offset
,
17530 offset
- last_offset
, precision
- n
,
17533 switch (mode_line_target
)
17535 case MODE_LINE_NOPROP
:
17536 case MODE_LINE_TITLE
:
17537 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17539 case MODE_LINE_STRING
:
17541 int bytepos
= last_offset
;
17542 int charpos
= string_byte_to_char (elt
, bytepos
);
17543 int endpos
= (precision
<= 0
17544 ? string_byte_to_char (elt
, offset
)
17545 : charpos
+ nchars
);
17547 n
+= store_mode_line_string (NULL
,
17548 Fsubstring (elt
, make_number (charpos
),
17549 make_number (endpos
)),
17553 case MODE_LINE_DISPLAY
:
17555 int bytepos
= last_offset
;
17556 int charpos
= string_byte_to_char (elt
, bytepos
);
17558 if (precision
<= 0)
17559 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17560 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17562 STRING_MULTIBYTE (elt
));
17567 else /* c == '%' */
17569 int percent_position
= offset
;
17571 /* Get the specified minimum width. Zero means
17574 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17575 field
= field
* 10 + c
- '0';
17577 /* Don't pad beyond the total padding allowed. */
17578 if (field_width
- n
> 0 && field
> field_width
- n
)
17579 field
= field_width
- n
;
17581 /* Note that either PRECISION <= 0 or N < PRECISION. */
17582 prec
= precision
- n
;
17585 n
+= display_mode_element (it
, depth
, field
, prec
,
17586 Vglobal_mode_string
, props
,
17591 int bytepos
, charpos
;
17592 unsigned char *spec
;
17594 bytepos
= percent_position
;
17595 charpos
= (STRING_MULTIBYTE (elt
)
17596 ? string_byte_to_char (elt
, bytepos
)
17599 = decode_mode_spec (it
->w
, c
, field
, prec
, &multibyte
);
17601 switch (mode_line_target
)
17603 case MODE_LINE_NOPROP
:
17604 case MODE_LINE_TITLE
:
17605 n
+= store_mode_line_noprop (spec
, field
, prec
);
17607 case MODE_LINE_STRING
:
17609 int len
= strlen (spec
);
17610 Lisp_Object tem
= make_string (spec
, len
);
17611 props
= Ftext_properties_at (make_number (charpos
), elt
);
17612 /* Should only keep face property in props */
17613 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17616 case MODE_LINE_DISPLAY
:
17618 int nglyphs_before
, nwritten
;
17620 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17621 nwritten
= display_string (spec
, Qnil
, elt
,
17626 /* Assign to the glyphs written above the
17627 string where the `%x' came from, position
17631 struct glyph
*glyph
17632 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17636 for (i
= 0; i
< nwritten
; ++i
)
17638 glyph
[i
].object
= elt
;
17639 glyph
[i
].charpos
= charpos
;
17656 /* A symbol: process the value of the symbol recursively
17657 as if it appeared here directly. Avoid error if symbol void.
17658 Special case: if value of symbol is a string, output the string
17661 register Lisp_Object tem
;
17663 /* If the variable is not marked as risky to set
17664 then its contents are risky to use. */
17665 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17668 tem
= Fboundp (elt
);
17671 tem
= Fsymbol_value (elt
);
17672 /* If value is a string, output that string literally:
17673 don't check for % within it. */
17677 if (!EQ (tem
, elt
))
17679 /* Give up right away for nil or t. */
17689 register Lisp_Object car
, tem
;
17691 /* A cons cell: five distinct cases.
17692 If first element is :eval or :propertize, do something special.
17693 If first element is a string or a cons, process all the elements
17694 and effectively concatenate them.
17695 If first element is a negative number, truncate displaying cdr to
17696 at most that many characters. If positive, pad (with spaces)
17697 to at least that many characters.
17698 If first element is a symbol, process the cadr or caddr recursively
17699 according to whether the symbol's value is non-nil or nil. */
17701 if (EQ (car
, QCeval
))
17703 /* An element of the form (:eval FORM) means evaluate FORM
17704 and use the result as mode line elements. */
17709 if (CONSP (XCDR (elt
)))
17712 spec
= safe_eval (XCAR (XCDR (elt
)));
17713 n
+= display_mode_element (it
, depth
, field_width
- n
,
17714 precision
- n
, spec
, props
,
17718 else if (EQ (car
, QCpropertize
))
17720 /* An element of the form (:propertize ELT PROPS...)
17721 means display ELT but applying properties PROPS. */
17726 if (CONSP (XCDR (elt
)))
17727 n
+= display_mode_element (it
, depth
, field_width
- n
,
17728 precision
- n
, XCAR (XCDR (elt
)),
17729 XCDR (XCDR (elt
)), risky
);
17731 else if (SYMBOLP (car
))
17733 tem
= Fboundp (car
);
17737 /* elt is now the cdr, and we know it is a cons cell.
17738 Use its car if CAR has a non-nil value. */
17741 tem
= Fsymbol_value (car
);
17748 /* Symbol's value is nil (or symbol is unbound)
17749 Get the cddr of the original list
17750 and if possible find the caddr and use that. */
17754 else if (!CONSP (elt
))
17759 else if (INTEGERP (car
))
17761 register int lim
= XINT (car
);
17765 /* Negative int means reduce maximum width. */
17766 if (precision
<= 0)
17769 precision
= min (precision
, -lim
);
17773 /* Padding specified. Don't let it be more than
17774 current maximum. */
17776 lim
= min (precision
, lim
);
17778 /* If that's more padding than already wanted, queue it.
17779 But don't reduce padding already specified even if
17780 that is beyond the current truncation point. */
17781 field_width
= max (lim
, field_width
);
17785 else if (STRINGP (car
) || CONSP (car
))
17787 register int limit
= 50;
17788 /* Limit is to protect against circular lists. */
17791 && (precision
<= 0 || n
< precision
))
17793 n
+= display_mode_element (it
, depth
,
17794 /* Do padding only after the last
17795 element in the list. */
17796 (! CONSP (XCDR (elt
))
17799 precision
- n
, XCAR (elt
),
17809 elt
= build_string ("*invalid*");
17813 /* Pad to FIELD_WIDTH. */
17814 if (field_width
> 0 && n
< field_width
)
17816 switch (mode_line_target
)
17818 case MODE_LINE_NOPROP
:
17819 case MODE_LINE_TITLE
:
17820 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17822 case MODE_LINE_STRING
:
17823 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17825 case MODE_LINE_DISPLAY
:
17826 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17835 /* Store a mode-line string element in mode_line_string_list.
17837 If STRING is non-null, display that C string. Otherwise, the Lisp
17838 string LISP_STRING is displayed.
17840 FIELD_WIDTH is the minimum number of output glyphs to produce.
17841 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17842 with spaces. FIELD_WIDTH <= 0 means don't pad.
17844 PRECISION is the maximum number of characters to output from
17845 STRING. PRECISION <= 0 means don't truncate the string.
17847 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17848 properties to the string.
17850 PROPS are the properties to add to the string.
17851 The mode_line_string_face face property is always added to the string.
17855 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17857 Lisp_Object lisp_string
;
17866 if (string
!= NULL
)
17868 len
= strlen (string
);
17869 if (precision
> 0 && len
> precision
)
17871 lisp_string
= make_string (string
, len
);
17873 props
= mode_line_string_face_prop
;
17874 else if (!NILP (mode_line_string_face
))
17876 Lisp_Object face
= Fplist_get (props
, Qface
);
17877 props
= Fcopy_sequence (props
);
17879 face
= mode_line_string_face
;
17881 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17882 props
= Fplist_put (props
, Qface
, face
);
17884 Fadd_text_properties (make_number (0), make_number (len
),
17885 props
, lisp_string
);
17889 len
= XFASTINT (Flength (lisp_string
));
17890 if (precision
> 0 && len
> precision
)
17893 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17896 if (!NILP (mode_line_string_face
))
17900 props
= Ftext_properties_at (make_number (0), lisp_string
);
17901 face
= Fplist_get (props
, Qface
);
17903 face
= mode_line_string_face
;
17905 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17906 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17908 lisp_string
= Fcopy_sequence (lisp_string
);
17911 Fadd_text_properties (make_number (0), make_number (len
),
17912 props
, lisp_string
);
17917 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17921 if (field_width
> len
)
17923 field_width
-= len
;
17924 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17926 Fadd_text_properties (make_number (0), make_number (field_width
),
17927 props
, lisp_string
);
17928 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17936 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17938 doc
: /* Format a string out of a mode line format specification.
17939 First arg FORMAT specifies the mode line format (see `mode-line-format'
17940 for details) to use.
17942 Optional second arg FACE specifies the face property to put
17943 on all characters for which no face is specified.
17944 The value t means whatever face the window's mode line currently uses
17945 \(either `mode-line' or `mode-line-inactive', depending).
17946 A value of nil means the default is no face property.
17947 If FACE is an integer, the value string has no text properties.
17949 Optional third and fourth args WINDOW and BUFFER specify the window
17950 and buffer to use as the context for the formatting (defaults
17951 are the selected window and the window's buffer). */)
17952 (format
, face
, window
, buffer
)
17953 Lisp_Object format
, face
, window
, buffer
;
17958 struct buffer
*old_buffer
= NULL
;
17960 int no_props
= INTEGERP (face
);
17961 int count
= SPECPDL_INDEX ();
17963 int string_start
= 0;
17966 window
= selected_window
;
17967 CHECK_WINDOW (window
);
17968 w
= XWINDOW (window
);
17971 buffer
= w
->buffer
;
17972 CHECK_BUFFER (buffer
);
17974 /* Make formatting the modeline a non-op when noninteractive, otherwise
17975 there will be problems later caused by a partially initialized frame. */
17976 if (NILP (format
) || noninteractive
)
17977 return empty_unibyte_string
;
17985 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17986 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17990 face_id
= DEFAULT_FACE_ID
;
17992 if (XBUFFER (buffer
) != current_buffer
)
17993 old_buffer
= current_buffer
;
17995 /* Save things including mode_line_proptrans_alist,
17996 and set that to nil so that we don't alter the outer value. */
17997 record_unwind_protect (unwind_format_mode_line
,
17998 format_mode_line_unwind_data
17999 (old_buffer
, selected_window
, 1));
18000 mode_line_proptrans_alist
= Qnil
;
18002 Fselect_window (window
, Qt
);
18004 set_buffer_internal_1 (XBUFFER (buffer
));
18006 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18010 mode_line_target
= MODE_LINE_NOPROP
;
18011 mode_line_string_face_prop
= Qnil
;
18012 mode_line_string_list
= Qnil
;
18013 string_start
= MODE_LINE_NOPROP_LEN (0);
18017 mode_line_target
= MODE_LINE_STRING
;
18018 mode_line_string_list
= Qnil
;
18019 mode_line_string_face
= face
;
18020 mode_line_string_face_prop
18021 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18024 push_kboard (FRAME_KBOARD (it
.f
));
18025 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18030 len
= MODE_LINE_NOPROP_LEN (string_start
);
18031 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18035 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18036 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18037 empty_unibyte_string
);
18040 unbind_to (count
, Qnil
);
18044 /* Write a null-terminated, right justified decimal representation of
18045 the positive integer D to BUF using a minimal field width WIDTH. */
18048 pint2str (buf
, width
, d
)
18049 register char *buf
;
18050 register int width
;
18053 register char *p
= buf
;
18061 *p
++ = d
% 10 + '0';
18066 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18077 /* Write a null-terminated, right justified decimal and "human
18078 readable" representation of the nonnegative integer D to BUF using
18079 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18081 static const char power_letter
[] =
18095 pint2hrstr (buf
, width
, d
)
18100 /* We aim to represent the nonnegative integer D as
18101 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18104 /* -1 means: do not use TENTHS. */
18108 /* Length of QUOTIENT.TENTHS as a string. */
18114 if (1000 <= quotient
)
18116 /* Scale to the appropriate EXPONENT. */
18119 remainder
= quotient
% 1000;
18123 while (1000 <= quotient
);
18125 /* Round to nearest and decide whether to use TENTHS or not. */
18128 tenths
= remainder
/ 100;
18129 if (50 <= remainder
% 100)
18136 if (quotient
== 10)
18144 if (500 <= remainder
)
18146 if (quotient
< 999)
18157 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18158 if (tenths
== -1 && quotient
<= 99)
18165 p
= psuffix
= buf
+ max (width
, length
);
18167 /* Print EXPONENT. */
18169 *psuffix
++ = power_letter
[exponent
];
18172 /* Print TENTHS. */
18175 *--p
= '0' + tenths
;
18179 /* Print QUOTIENT. */
18182 int digit
= quotient
% 10;
18183 *--p
= '0' + digit
;
18185 while ((quotient
/= 10) != 0);
18187 /* Print leading spaces. */
18192 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18193 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18194 type of CODING_SYSTEM. Return updated pointer into BUF. */
18196 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18199 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18200 Lisp_Object coding_system
;
18201 register char *buf
;
18205 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18206 const unsigned char *eol_str
;
18208 /* The EOL conversion we are using. */
18209 Lisp_Object eoltype
;
18211 val
= CODING_SYSTEM_SPEC (coding_system
);
18214 if (!VECTORP (val
)) /* Not yet decided. */
18219 eoltype
= eol_mnemonic_undecided
;
18220 /* Don't mention EOL conversion if it isn't decided. */
18225 Lisp_Object eolvalue
;
18227 attrs
= AREF (val
, 0);
18228 eolvalue
= AREF (val
, 2);
18231 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18235 /* The EOL conversion that is normal on this system. */
18237 if (NILP (eolvalue
)) /* Not yet decided. */
18238 eoltype
= eol_mnemonic_undecided
;
18239 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18240 eoltype
= eol_mnemonic_undecided
;
18241 else /* eolvalue is Qunix, Qdos, or Qmac. */
18242 eoltype
= (EQ (eolvalue
, Qunix
)
18243 ? eol_mnemonic_unix
18244 : (EQ (eolvalue
, Qdos
) == 1
18245 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18251 /* Mention the EOL conversion if it is not the usual one. */
18252 if (STRINGP (eoltype
))
18254 eol_str
= SDATA (eoltype
);
18255 eol_str_len
= SBYTES (eoltype
);
18257 else if (CHARACTERP (eoltype
))
18259 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18260 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18265 eol_str
= invalid_eol_type
;
18266 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18268 bcopy (eol_str
, buf
, eol_str_len
);
18269 buf
+= eol_str_len
;
18275 /* Return a string for the output of a mode line %-spec for window W,
18276 generated by character C. PRECISION >= 0 means don't return a
18277 string longer than that value. FIELD_WIDTH > 0 means pad the
18278 string returned with spaces to that value. Return 1 in *MULTIBYTE
18279 if the result is multibyte text.
18281 Note we operate on the current buffer for most purposes,
18282 the exception being w->base_line_pos. */
18284 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18287 decode_mode_spec (w
, c
, field_width
, precision
, multibyte
)
18290 int field_width
, precision
;
18294 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18295 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18296 struct buffer
*b
= current_buffer
;
18304 if (!NILP (b
->read_only
))
18306 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18311 /* This differs from %* only for a modified read-only buffer. */
18312 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18314 if (!NILP (b
->read_only
))
18319 /* This differs from %* in ignoring read-only-ness. */
18320 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18332 if (command_loop_level
> 5)
18334 p
= decode_mode_spec_buf
;
18335 for (i
= 0; i
< command_loop_level
; i
++)
18338 return decode_mode_spec_buf
;
18346 if (command_loop_level
> 5)
18348 p
= decode_mode_spec_buf
;
18349 for (i
= 0; i
< command_loop_level
; i
++)
18352 return decode_mode_spec_buf
;
18359 /* Let lots_of_dashes be a string of infinite length. */
18360 if (mode_line_target
== MODE_LINE_NOPROP
||
18361 mode_line_target
== MODE_LINE_STRING
)
18363 if (field_width
<= 0
18364 || field_width
> sizeof (lots_of_dashes
))
18366 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18367 decode_mode_spec_buf
[i
] = '-';
18368 decode_mode_spec_buf
[i
] = '\0';
18369 return decode_mode_spec_buf
;
18372 return lots_of_dashes
;
18380 /* %c and %l are ignored in `frame-title-format'.
18381 (In redisplay_internal, the frame title is drawn _before_ the
18382 windows are updated, so the stuff which depends on actual
18383 window contents (such as %l) may fail to render properly, or
18384 even crash emacs.) */
18385 if (mode_line_target
== MODE_LINE_TITLE
)
18389 int col
= (int) current_column (); /* iftc */
18390 w
->column_number_displayed
= make_number (col
);
18391 pint2str (decode_mode_spec_buf
, field_width
, col
);
18392 return decode_mode_spec_buf
;
18396 #ifndef SYSTEM_MALLOC
18398 if (NILP (Vmemory_full
))
18401 return "!MEM FULL! ";
18408 /* %F displays the frame name. */
18409 if (!NILP (f
->title
))
18410 return (char *) SDATA (f
->title
);
18411 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18412 return (char *) SDATA (f
->name
);
18421 int size
= ZV
- BEGV
;
18422 pint2str (decode_mode_spec_buf
, field_width
, size
);
18423 return decode_mode_spec_buf
;
18428 int size
= ZV
- BEGV
;
18429 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18430 return decode_mode_spec_buf
;
18435 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18436 int topline
, nlines
, junk
, height
;
18438 /* %c and %l are ignored in `frame-title-format'. */
18439 if (mode_line_target
== MODE_LINE_TITLE
)
18442 startpos
= XMARKER (w
->start
)->charpos
;
18443 startpos_byte
= marker_byte_position (w
->start
);
18444 height
= WINDOW_TOTAL_LINES (w
);
18446 /* If we decided that this buffer isn't suitable for line numbers,
18447 don't forget that too fast. */
18448 if (EQ (w
->base_line_pos
, w
->buffer
))
18450 /* But do forget it, if the window shows a different buffer now. */
18451 else if (BUFFERP (w
->base_line_pos
))
18452 w
->base_line_pos
= Qnil
;
18454 /* If the buffer is very big, don't waste time. */
18455 if (INTEGERP (Vline_number_display_limit
)
18456 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18458 w
->base_line_pos
= Qnil
;
18459 w
->base_line_number
= Qnil
;
18463 if (INTEGERP (w
->base_line_number
)
18464 && INTEGERP (w
->base_line_pos
)
18465 && XFASTINT (w
->base_line_pos
) <= startpos
)
18467 line
= XFASTINT (w
->base_line_number
);
18468 linepos
= XFASTINT (w
->base_line_pos
);
18469 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18474 linepos
= BUF_BEGV (b
);
18475 linepos_byte
= BUF_BEGV_BYTE (b
);
18478 /* Count lines from base line to window start position. */
18479 nlines
= display_count_lines (linepos
, linepos_byte
,
18483 topline
= nlines
+ line
;
18485 /* Determine a new base line, if the old one is too close
18486 or too far away, or if we did not have one.
18487 "Too close" means it's plausible a scroll-down would
18488 go back past it. */
18489 if (startpos
== BUF_BEGV (b
))
18491 w
->base_line_number
= make_number (topline
);
18492 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18494 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18495 || linepos
== BUF_BEGV (b
))
18497 int limit
= BUF_BEGV (b
);
18498 int limit_byte
= BUF_BEGV_BYTE (b
);
18500 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18502 if (startpos
- distance
> limit
)
18504 limit
= startpos
- distance
;
18505 limit_byte
= CHAR_TO_BYTE (limit
);
18508 nlines
= display_count_lines (startpos
, startpos_byte
,
18510 - (height
* 2 + 30),
18512 /* If we couldn't find the lines we wanted within
18513 line_number_display_limit_width chars per line,
18514 give up on line numbers for this window. */
18515 if (position
== limit_byte
&& limit
== startpos
- distance
)
18517 w
->base_line_pos
= w
->buffer
;
18518 w
->base_line_number
= Qnil
;
18522 w
->base_line_number
= make_number (topline
- nlines
);
18523 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18526 /* Now count lines from the start pos to point. */
18527 nlines
= display_count_lines (startpos
, startpos_byte
,
18528 PT_BYTE
, PT
, &junk
);
18530 /* Record that we did display the line number. */
18531 line_number_displayed
= 1;
18533 /* Make the string to show. */
18534 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18535 return decode_mode_spec_buf
;
18538 char* p
= decode_mode_spec_buf
;
18539 int pad
= field_width
- 2;
18545 return decode_mode_spec_buf
;
18551 obj
= b
->mode_name
;
18555 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18561 int pos
= marker_position (w
->start
);
18562 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18564 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18566 if (pos
<= BUF_BEGV (b
))
18571 else if (pos
<= BUF_BEGV (b
))
18575 if (total
> 1000000)
18576 /* Do it differently for a large value, to avoid overflow. */
18577 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18579 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18580 /* We can't normally display a 3-digit number,
18581 so get us a 2-digit number that is close. */
18584 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18585 return decode_mode_spec_buf
;
18589 /* Display percentage of size above the bottom of the screen. */
18592 int toppos
= marker_position (w
->start
);
18593 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18594 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18596 if (botpos
>= BUF_ZV (b
))
18598 if (toppos
<= BUF_BEGV (b
))
18605 if (total
> 1000000)
18606 /* Do it differently for a large value, to avoid overflow. */
18607 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18609 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18610 /* We can't normally display a 3-digit number,
18611 so get us a 2-digit number that is close. */
18614 if (toppos
<= BUF_BEGV (b
))
18615 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18617 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18618 return decode_mode_spec_buf
;
18623 /* status of process */
18624 obj
= Fget_buffer_process (Fcurrent_buffer ());
18626 return "no process";
18627 #ifdef subprocesses
18628 obj
= Fsymbol_name (Fprocess_status (obj
));
18635 val
= call1 (intern ("file-remote-p"), current_buffer
->directory
);
18642 case 't': /* indicate TEXT or BINARY */
18643 #ifdef MODE_LINE_BINARY_TEXT
18644 return MODE_LINE_BINARY_TEXT (b
);
18650 /* coding-system (not including end-of-line format) */
18652 /* coding-system (including end-of-line type) */
18654 int eol_flag
= (c
== 'Z');
18655 char *p
= decode_mode_spec_buf
;
18657 if (! FRAME_WINDOW_P (f
))
18659 /* No need to mention EOL here--the terminal never needs
18660 to do EOL conversion. */
18661 p
= decode_mode_spec_coding (CODING_ID_NAME
18662 (FRAME_KEYBOARD_CODING (f
)->id
),
18664 p
= decode_mode_spec_coding (CODING_ID_NAME
18665 (FRAME_TERMINAL_CODING (f
)->id
),
18668 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
18671 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
18672 #ifdef subprocesses
18673 obj
= Fget_buffer_process (Fcurrent_buffer ());
18674 if (PROCESSP (obj
))
18676 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
18678 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
18681 #endif /* subprocesses */
18684 return decode_mode_spec_buf
;
18690 *multibyte
= STRING_MULTIBYTE (obj
);
18691 return (char *) SDATA (obj
);
18698 /* Count up to COUNT lines starting from START / START_BYTE.
18699 But don't go beyond LIMIT_BYTE.
18700 Return the number of lines thus found (always nonnegative).
18702 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
18705 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
18706 int start
, start_byte
, limit_byte
, count
;
18709 register unsigned char *cursor
;
18710 unsigned char *base
;
18712 register int ceiling
;
18713 register unsigned char *ceiling_addr
;
18714 int orig_count
= count
;
18716 /* If we are not in selective display mode,
18717 check only for newlines. */
18718 int selective_display
= (!NILP (current_buffer
->selective_display
)
18719 && !INTEGERP (current_buffer
->selective_display
));
18723 while (start_byte
< limit_byte
)
18725 ceiling
= BUFFER_CEILING_OF (start_byte
);
18726 ceiling
= min (limit_byte
- 1, ceiling
);
18727 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
18728 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
18731 if (selective_display
)
18732 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
18735 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
18738 if (cursor
!= ceiling_addr
)
18742 start_byte
+= cursor
- base
+ 1;
18743 *byte_pos_ptr
= start_byte
;
18747 if (++cursor
== ceiling_addr
)
18753 start_byte
+= cursor
- base
;
18758 while (start_byte
> limit_byte
)
18760 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
18761 ceiling
= max (limit_byte
, ceiling
);
18762 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
18763 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
18766 if (selective_display
)
18767 while (--cursor
!= ceiling_addr
18768 && *cursor
!= '\n' && *cursor
!= 015)
18771 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
18774 if (cursor
!= ceiling_addr
)
18778 start_byte
+= cursor
- base
+ 1;
18779 *byte_pos_ptr
= start_byte
;
18780 /* When scanning backwards, we should
18781 not count the newline posterior to which we stop. */
18782 return - orig_count
- 1;
18788 /* Here we add 1 to compensate for the last decrement
18789 of CURSOR, which took it past the valid range. */
18790 start_byte
+= cursor
- base
+ 1;
18794 *byte_pos_ptr
= limit_byte
;
18797 return - orig_count
+ count
;
18798 return orig_count
- count
;
18804 /***********************************************************************
18806 ***********************************************************************/
18808 /* Display a NUL-terminated string, starting with index START.
18810 If STRING is non-null, display that C string. Otherwise, the Lisp
18811 string LISP_STRING is displayed.
18813 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18814 FACE_STRING. Display STRING or LISP_STRING with the face at
18815 FACE_STRING_POS in FACE_STRING:
18817 Display the string in the environment given by IT, but use the
18818 standard display table, temporarily.
18820 FIELD_WIDTH is the minimum number of output glyphs to produce.
18821 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18822 with spaces. If STRING has more characters, more than FIELD_WIDTH
18823 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18825 PRECISION is the maximum number of characters to output from
18826 STRING. PRECISION < 0 means don't truncate the string.
18828 This is roughly equivalent to printf format specifiers:
18830 FIELD_WIDTH PRECISION PRINTF
18831 ----------------------------------------
18837 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18838 display them, and < 0 means obey the current buffer's value of
18839 enable_multibyte_characters.
18841 Value is the number of columns displayed. */
18844 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18845 start
, it
, field_width
, precision
, max_x
, multibyte
)
18846 unsigned char *string
;
18847 Lisp_Object lisp_string
;
18848 Lisp_Object face_string
;
18849 EMACS_INT face_string_pos
;
18852 int field_width
, precision
, max_x
;
18855 int hpos_at_start
= it
->hpos
;
18856 int saved_face_id
= it
->face_id
;
18857 struct glyph_row
*row
= it
->glyph_row
;
18859 /* Initialize the iterator IT for iteration over STRING beginning
18860 with index START. */
18861 reseat_to_string (it
, string
, lisp_string
, start
,
18862 precision
, field_width
, multibyte
);
18864 /* If displaying STRING, set up the face of the iterator
18865 from LISP_STRING, if that's given. */
18866 if (STRINGP (face_string
))
18872 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18873 0, it
->region_beg_charpos
,
18874 it
->region_end_charpos
,
18875 &endptr
, it
->base_face_id
, 0);
18876 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18877 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18880 /* Set max_x to the maximum allowed X position. Don't let it go
18881 beyond the right edge of the window. */
18883 max_x
= it
->last_visible_x
;
18885 max_x
= min (max_x
, it
->last_visible_x
);
18887 /* Skip over display elements that are not visible. because IT->w is
18889 if (it
->current_x
< it
->first_visible_x
)
18890 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18891 MOVE_TO_POS
| MOVE_TO_X
);
18893 row
->ascent
= it
->max_ascent
;
18894 row
->height
= it
->max_ascent
+ it
->max_descent
;
18895 row
->phys_ascent
= it
->max_phys_ascent
;
18896 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18897 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18899 /* This condition is for the case that we are called with current_x
18900 past last_visible_x. */
18901 while (it
->current_x
< max_x
)
18903 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18905 /* Get the next display element. */
18906 if (!get_next_display_element (it
))
18909 /* Produce glyphs. */
18910 x_before
= it
->current_x
;
18911 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18912 PRODUCE_GLYPHS (it
);
18914 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18917 while (i
< nglyphs
)
18919 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18921 if (it
->line_wrap
!= TRUNCATE
18922 && x
+ glyph
->pixel_width
> max_x
)
18924 /* End of continued line or max_x reached. */
18925 if (CHAR_GLYPH_PADDING_P (*glyph
))
18927 /* A wide character is unbreakable. */
18928 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18929 it
->current_x
= x_before
;
18933 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18938 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18940 /* Glyph is at least partially visible. */
18942 if (x
< it
->first_visible_x
)
18943 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18947 /* Glyph is off the left margin of the display area.
18948 Should not happen. */
18952 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18953 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18954 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18955 row
->phys_height
= max (row
->phys_height
,
18956 it
->max_phys_ascent
+ it
->max_phys_descent
);
18957 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18958 it
->max_extra_line_spacing
);
18959 x
+= glyph
->pixel_width
;
18963 /* Stop if max_x reached. */
18967 /* Stop at line ends. */
18968 if (ITERATOR_AT_END_OF_LINE_P (it
))
18970 it
->continuation_lines_width
= 0;
18974 set_iterator_to_next (it
, 1);
18976 /* Stop if truncating at the right edge. */
18977 if (it
->line_wrap
== TRUNCATE
18978 && it
->current_x
>= it
->last_visible_x
)
18980 /* Add truncation mark, but don't do it if the line is
18981 truncated at a padding space. */
18982 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18984 if (!FRAME_WINDOW_P (it
->f
))
18988 if (it
->current_x
> it
->last_visible_x
)
18990 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18991 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18993 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18995 row
->used
[TEXT_AREA
] = i
;
18996 produce_special_glyphs (it
, IT_TRUNCATION
);
18999 produce_special_glyphs (it
, IT_TRUNCATION
);
19001 it
->glyph_row
->truncated_on_right_p
= 1;
19007 /* Maybe insert a truncation at the left. */
19008 if (it
->first_visible_x
19009 && IT_CHARPOS (*it
) > 0)
19011 if (!FRAME_WINDOW_P (it
->f
))
19012 insert_left_trunc_glyphs (it
);
19013 it
->glyph_row
->truncated_on_left_p
= 1;
19016 it
->face_id
= saved_face_id
;
19018 /* Value is number of columns displayed. */
19019 return it
->hpos
- hpos_at_start
;
19024 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19025 appears as an element of LIST or as the car of an element of LIST.
19026 If PROPVAL is a list, compare each element against LIST in that
19027 way, and return 1/2 if any element of PROPVAL is found in LIST.
19028 Otherwise return 0. This function cannot quit.
19029 The return value is 2 if the text is invisible but with an ellipsis
19030 and 1 if it's invisible and without an ellipsis. */
19033 invisible_p (propval
, list
)
19034 register Lisp_Object propval
;
19037 register Lisp_Object tail
, proptail
;
19039 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19041 register Lisp_Object tem
;
19043 if (EQ (propval
, tem
))
19045 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19046 return NILP (XCDR (tem
)) ? 1 : 2;
19049 if (CONSP (propval
))
19051 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19053 Lisp_Object propelt
;
19054 propelt
= XCAR (proptail
);
19055 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19057 register Lisp_Object tem
;
19059 if (EQ (propelt
, tem
))
19061 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19062 return NILP (XCDR (tem
)) ? 1 : 2;
19070 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19071 doc
: /* Non-nil if the property makes the text invisible.
19072 POS-OR-PROP can be a marker or number, in which case it is taken to be
19073 a position in the current buffer and the value of the `invisible' property
19074 is checked; or it can be some other value, which is then presumed to be the
19075 value of the `invisible' property of the text of interest.
19076 The non-nil value returned can be t for truly invisible text or something
19077 else if the text is replaced by an ellipsis. */)
19079 Lisp_Object pos_or_prop
;
19082 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19083 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19085 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19086 return (invis
== 0 ? Qnil
19088 : make_number (invis
));
19091 /* Calculate a width or height in pixels from a specification using
19092 the following elements:
19095 NUM - a (fractional) multiple of the default font width/height
19096 (NUM) - specifies exactly NUM pixels
19097 UNIT - a fixed number of pixels, see below.
19098 ELEMENT - size of a display element in pixels, see below.
19099 (NUM . SPEC) - equals NUM * SPEC
19100 (+ SPEC SPEC ...) - add pixel values
19101 (- SPEC SPEC ...) - subtract pixel values
19102 (- SPEC) - negate pixel value
19105 INT or FLOAT - a number constant
19106 SYMBOL - use symbol's (buffer local) variable binding.
19109 in - pixels per inch *)
19110 mm - pixels per 1/1000 meter *)
19111 cm - pixels per 1/100 meter *)
19112 width - width of current font in pixels.
19113 height - height of current font in pixels.
19115 *) using the ratio(s) defined in display-pixels-per-inch.
19119 left-fringe - left fringe width in pixels
19120 right-fringe - right fringe width in pixels
19122 left-margin - left margin width in pixels
19123 right-margin - right margin width in pixels
19125 scroll-bar - scroll-bar area width in pixels
19129 Pixels corresponding to 5 inches:
19132 Total width of non-text areas on left side of window (if scroll-bar is on left):
19133 '(space :width (+ left-fringe left-margin scroll-bar))
19135 Align to first text column (in header line):
19136 '(space :align-to 0)
19138 Align to middle of text area minus half the width of variable `my-image'
19139 containing a loaded image:
19140 '(space :align-to (0.5 . (- text my-image)))
19142 Width of left margin minus width of 1 character in the default font:
19143 '(space :width (- left-margin 1))
19145 Width of left margin minus width of 2 characters in the current font:
19146 '(space :width (- left-margin (2 . width)))
19148 Center 1 character over left-margin (in header line):
19149 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19151 Different ways to express width of left fringe plus left margin minus one pixel:
19152 '(space :width (- (+ left-fringe left-margin) (1)))
19153 '(space :width (+ left-fringe left-margin (- (1))))
19154 '(space :width (+ left-fringe left-margin (-1)))
19158 #define NUMVAL(X) \
19159 ((INTEGERP (X) || FLOATP (X)) \
19164 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19169 int width_p
, *align_to
;
19173 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19174 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19177 return OK_PIXELS (0);
19179 xassert (FRAME_LIVE_P (it
->f
));
19181 if (SYMBOLP (prop
))
19183 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19185 char *unit
= SDATA (SYMBOL_NAME (prop
));
19187 if (unit
[0] == 'i' && unit
[1] == 'n')
19189 else if (unit
[0] == 'm' && unit
[1] == 'm')
19191 else if (unit
[0] == 'c' && unit
[1] == 'm')
19198 #ifdef HAVE_WINDOW_SYSTEM
19199 if (FRAME_WINDOW_P (it
->f
)
19201 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19202 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19204 return OK_PIXELS (ppi
/ pixels
);
19207 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19208 || (CONSP (Vdisplay_pixels_per_inch
)
19210 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19211 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19213 return OK_PIXELS (ppi
/ pixels
);
19219 #ifdef HAVE_WINDOW_SYSTEM
19220 if (EQ (prop
, Qheight
))
19221 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19222 if (EQ (prop
, Qwidth
))
19223 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19225 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19226 return OK_PIXELS (1);
19229 if (EQ (prop
, Qtext
))
19230 return OK_PIXELS (width_p
19231 ? window_box_width (it
->w
, TEXT_AREA
)
19232 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19234 if (align_to
&& *align_to
< 0)
19237 if (EQ (prop
, Qleft
))
19238 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19239 if (EQ (prop
, Qright
))
19240 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19241 if (EQ (prop
, Qcenter
))
19242 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19243 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19244 if (EQ (prop
, Qleft_fringe
))
19245 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19246 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19247 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19248 if (EQ (prop
, Qright_fringe
))
19249 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19250 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19251 : window_box_right_offset (it
->w
, TEXT_AREA
));
19252 if (EQ (prop
, Qleft_margin
))
19253 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19254 if (EQ (prop
, Qright_margin
))
19255 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19256 if (EQ (prop
, Qscroll_bar
))
19257 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19259 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19260 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19261 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19266 if (EQ (prop
, Qleft_fringe
))
19267 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19268 if (EQ (prop
, Qright_fringe
))
19269 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19270 if (EQ (prop
, Qleft_margin
))
19271 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19272 if (EQ (prop
, Qright_margin
))
19273 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19274 if (EQ (prop
, Qscroll_bar
))
19275 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19278 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19281 if (INTEGERP (prop
) || FLOATP (prop
))
19283 int base_unit
= (width_p
19284 ? FRAME_COLUMN_WIDTH (it
->f
)
19285 : FRAME_LINE_HEIGHT (it
->f
));
19286 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19291 Lisp_Object car
= XCAR (prop
);
19292 Lisp_Object cdr
= XCDR (prop
);
19296 #ifdef HAVE_WINDOW_SYSTEM
19297 if (FRAME_WINDOW_P (it
->f
)
19298 && valid_image_p (prop
))
19300 int id
= lookup_image (it
->f
, prop
);
19301 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19303 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19306 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19312 while (CONSP (cdr
))
19314 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19315 font
, width_p
, align_to
))
19318 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19323 if (EQ (car
, Qminus
))
19325 return OK_PIXELS (pixels
);
19328 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19331 if (INTEGERP (car
) || FLOATP (car
))
19334 pixels
= XFLOATINT (car
);
19336 return OK_PIXELS (pixels
);
19337 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19338 font
, width_p
, align_to
))
19339 return OK_PIXELS (pixels
* fact
);
19350 /***********************************************************************
19352 ***********************************************************************/
19354 #ifdef HAVE_WINDOW_SYSTEM
19359 dump_glyph_string (s
)
19360 struct glyph_string
*s
;
19362 fprintf (stderr
, "glyph string\n");
19363 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19364 s
->x
, s
->y
, s
->width
, s
->height
);
19365 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19366 fprintf (stderr
, " hl = %d\n", s
->hl
);
19367 fprintf (stderr
, " left overhang = %d, right = %d\n",
19368 s
->left_overhang
, s
->right_overhang
);
19369 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19370 fprintf (stderr
, " extends to end of line = %d\n",
19371 s
->extends_to_end_of_line_p
);
19372 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19373 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19376 #endif /* GLYPH_DEBUG */
19378 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19379 of XChar2b structures for S; it can't be allocated in
19380 init_glyph_string because it must be allocated via `alloca'. W
19381 is the window on which S is drawn. ROW and AREA are the glyph row
19382 and area within the row from which S is constructed. START is the
19383 index of the first glyph structure covered by S. HL is a
19384 face-override for drawing S. */
19387 #define OPTIONAL_HDC(hdc) hdc,
19388 #define DECLARE_HDC(hdc) HDC hdc;
19389 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19390 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19393 #ifndef OPTIONAL_HDC
19394 #define OPTIONAL_HDC(hdc)
19395 #define DECLARE_HDC(hdc)
19396 #define ALLOCATE_HDC(hdc, f)
19397 #define RELEASE_HDC(hdc, f)
19401 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19402 struct glyph_string
*s
;
19406 struct glyph_row
*row
;
19407 enum glyph_row_area area
;
19409 enum draw_glyphs_face hl
;
19411 bzero (s
, sizeof *s
);
19413 s
->f
= XFRAME (w
->frame
);
19417 s
->display
= FRAME_X_DISPLAY (s
->f
);
19418 s
->window
= FRAME_X_WINDOW (s
->f
);
19419 s
->char2b
= char2b
;
19423 s
->first_glyph
= row
->glyphs
[area
] + start
;
19424 s
->height
= row
->height
;
19425 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19427 /* Display the internal border below the tool-bar window. */
19428 if (WINDOWP (s
->f
->tool_bar_window
)
19429 && s
->w
== XWINDOW (s
->f
->tool_bar_window
))
19430 s
->y
-= FRAME_INTERNAL_BORDER_WIDTH (s
->f
);
19432 s
->ybase
= s
->y
+ row
->ascent
;
19436 /* Append the list of glyph strings with head H and tail T to the list
19437 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19440 append_glyph_string_lists (head
, tail
, h
, t
)
19441 struct glyph_string
**head
, **tail
;
19442 struct glyph_string
*h
, *t
;
19456 /* Prepend the list of glyph strings with head H and tail T to the
19457 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19461 prepend_glyph_string_lists (head
, tail
, h
, t
)
19462 struct glyph_string
**head
, **tail
;
19463 struct glyph_string
*h
, *t
;
19477 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19478 Set *HEAD and *TAIL to the resulting list. */
19481 append_glyph_string (head
, tail
, s
)
19482 struct glyph_string
**head
, **tail
;
19483 struct glyph_string
*s
;
19485 s
->next
= s
->prev
= NULL
;
19486 append_glyph_string_lists (head
, tail
, s
, s
);
19490 /* Get face and two-byte form of character C in face FACE_ID on frame
19491 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19492 means we want to display multibyte text. DISPLAY_P non-zero means
19493 make sure that X resources for the face returned are allocated.
19494 Value is a pointer to a realized face that is ready for display if
19495 DISPLAY_P is non-zero. */
19497 static INLINE
struct face
*
19498 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19502 int multibyte_p
, display_p
;
19504 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19508 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19510 if (code
!= FONT_INVALID_CODE
)
19511 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19513 STORE_XCHAR2B (char2b
, 0, 0);
19516 /* Make sure X resources of the face are allocated. */
19517 #ifdef HAVE_X_WINDOWS
19521 xassert (face
!= NULL
);
19522 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19529 /* Get face and two-byte form of character glyph GLYPH on frame F.
19530 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19531 a pointer to a realized face that is ready for display. */
19533 static INLINE
struct face
*
19534 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19536 struct glyph
*glyph
;
19542 xassert (glyph
->type
== CHAR_GLYPH
);
19543 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19550 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19552 if (code
!= FONT_INVALID_CODE
)
19553 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19555 STORE_XCHAR2B (char2b
, 0, 0);
19558 /* Make sure X resources of the face are allocated. */
19559 xassert (face
!= NULL
);
19560 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19565 /* Fill glyph string S with composition components specified by S->cmp.
19567 BASE_FACE is the base face of the composition.
19568 S->cmp_from is the index of the first component for S.
19570 OVERLAPS non-zero means S should draw the foreground only, and use
19571 its physical height for clipping. See also draw_glyphs.
19573 Value is the index of a component not in S. */
19576 fill_composite_glyph_string (s
, base_face
, overlaps
)
19577 struct glyph_string
*s
;
19578 struct face
*base_face
;
19582 /* For all glyphs of this composition, starting at the offset
19583 S->cmp_from, until we reach the end of the definition or encounter a
19584 glyph that requires the different face, add it to S. */
19589 s
->for_overlaps
= overlaps
;
19592 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
19594 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19598 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19601 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19602 s
->char2b
+ i
, 1, 1);
19608 s
->font
= s
->face
->font
;
19610 else if (s
->face
!= face
)
19618 /* All glyph strings for the same composition has the same width,
19619 i.e. the width set for the first component of the composition. */
19620 s
->width
= s
->first_glyph
->pixel_width
;
19622 /* If the specified font could not be loaded, use the frame's
19623 default font, but record the fact that we couldn't load it in
19624 the glyph string so that we can draw rectangles for the
19625 characters of the glyph string. */
19626 if (s
->font
== NULL
)
19628 s
->font_not_found_p
= 1;
19629 s
->font
= FRAME_FONT (s
->f
);
19632 /* Adjust base line for subscript/superscript text. */
19633 s
->ybase
+= s
->first_glyph
->voffset
;
19635 /* This glyph string must always be drawn with 16-bit functions. */
19642 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
19643 struct glyph_string
*s
;
19645 int start
, end
, overlaps
;
19647 struct glyph
*glyph
, *last
;
19648 Lisp_Object lgstring
;
19651 s
->for_overlaps
= overlaps
;
19652 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19653 last
= s
->row
->glyphs
[s
->area
] + end
;
19654 s
->cmp_id
= glyph
->u
.cmp
.id
;
19655 s
->cmp_from
= glyph
->u
.cmp
.from
;
19656 s
->cmp_to
= glyph
->u
.cmp
.to
;
19657 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19658 lgstring
= composition_gstring_from_id (s
->cmp_id
);
19659 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
19661 while (glyph
< last
19662 && glyph
->u
.cmp
.automatic
19663 && glyph
->u
.cmp
.id
== s
->cmp_id
)
19664 s
->cmp_to
= (glyph
++)->u
.cmp
.to
;
19666 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
19668 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
19669 unsigned code
= LGLYPH_CODE (lglyph
);
19671 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
19673 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
19674 return glyph
- s
->row
->glyphs
[s
->area
];
19678 /* Fill glyph string S from a sequence of character glyphs.
19680 FACE_ID is the face id of the string. START is the index of the
19681 first glyph to consider, END is the index of the last + 1.
19682 OVERLAPS non-zero means S should draw the foreground only, and use
19683 its physical height for clipping. See also draw_glyphs.
19685 Value is the index of the first glyph not in S. */
19688 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19689 struct glyph_string
*s
;
19691 int start
, end
, overlaps
;
19693 struct glyph
*glyph
, *last
;
19695 int glyph_not_available_p
;
19697 xassert (s
->f
== XFRAME (s
->w
->frame
));
19698 xassert (s
->nchars
== 0);
19699 xassert (start
>= 0 && end
> start
);
19701 s
->for_overlaps
= overlaps
;
19702 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19703 last
= s
->row
->glyphs
[s
->area
] + end
;
19704 voffset
= glyph
->voffset
;
19705 s
->padding_p
= glyph
->padding_p
;
19706 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19708 while (glyph
< last
19709 && glyph
->type
== CHAR_GLYPH
19710 && glyph
->voffset
== voffset
19711 /* Same face id implies same font, nowadays. */
19712 && glyph
->face_id
== face_id
19713 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19717 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19718 s
->char2b
+ s
->nchars
,
19720 s
->two_byte_p
= two_byte_p
;
19722 xassert (s
->nchars
<= end
- start
);
19723 s
->width
+= glyph
->pixel_width
;
19724 if (glyph
++->padding_p
!= s
->padding_p
)
19728 s
->font
= s
->face
->font
;
19730 /* If the specified font could not be loaded, use the frame's font,
19731 but record the fact that we couldn't load it in
19732 S->font_not_found_p so that we can draw rectangles for the
19733 characters of the glyph string. */
19734 if (s
->font
== NULL
|| glyph_not_available_p
)
19736 s
->font_not_found_p
= 1;
19737 s
->font
= FRAME_FONT (s
->f
);
19740 /* Adjust base line for subscript/superscript text. */
19741 s
->ybase
+= voffset
;
19743 xassert (s
->face
&& s
->face
->gc
);
19744 return glyph
- s
->row
->glyphs
[s
->area
];
19748 /* Fill glyph string S from image glyph S->first_glyph. */
19751 fill_image_glyph_string (s
)
19752 struct glyph_string
*s
;
19754 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19755 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19757 s
->slice
= s
->first_glyph
->slice
;
19758 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19759 s
->font
= s
->face
->font
;
19760 s
->width
= s
->first_glyph
->pixel_width
;
19762 /* Adjust base line for subscript/superscript text. */
19763 s
->ybase
+= s
->first_glyph
->voffset
;
19767 /* Fill glyph string S from a sequence of stretch glyphs.
19769 ROW is the glyph row in which the glyphs are found, AREA is the
19770 area within the row. START is the index of the first glyph to
19771 consider, END is the index of the last + 1.
19773 Value is the index of the first glyph not in S. */
19776 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19777 struct glyph_string
*s
;
19778 struct glyph_row
*row
;
19779 enum glyph_row_area area
;
19782 struct glyph
*glyph
, *last
;
19783 int voffset
, face_id
;
19785 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19787 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19788 last
= s
->row
->glyphs
[s
->area
] + end
;
19789 face_id
= glyph
->face_id
;
19790 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19791 s
->font
= s
->face
->font
;
19792 s
->width
= glyph
->pixel_width
;
19794 voffset
= glyph
->voffset
;
19798 && glyph
->type
== STRETCH_GLYPH
19799 && glyph
->voffset
== voffset
19800 && glyph
->face_id
== face_id
);
19802 s
->width
+= glyph
->pixel_width
;
19804 /* Adjust base line for subscript/superscript text. */
19805 s
->ybase
+= voffset
;
19807 /* The case that face->gc == 0 is handled when drawing the glyph
19808 string by calling PREPARE_FACE_FOR_DISPLAY. */
19810 return glyph
- s
->row
->glyphs
[s
->area
];
19813 static struct font_metrics
*
19814 get_per_char_metric (f
, font
, char2b
)
19819 static struct font_metrics metrics
;
19820 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19822 if (! font
|| code
== FONT_INVALID_CODE
)
19824 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19829 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19830 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19831 assumed to be zero. */
19834 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19835 struct glyph
*glyph
;
19839 *left
= *right
= 0;
19841 if (glyph
->type
== CHAR_GLYPH
)
19845 struct font_metrics
*pcm
;
19847 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19848 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19850 if (pcm
->rbearing
> pcm
->width
)
19851 *right
= pcm
->rbearing
- pcm
->width
;
19852 if (pcm
->lbearing
< 0)
19853 *left
= -pcm
->lbearing
;
19856 else if (glyph
->type
== COMPOSITE_GLYPH
)
19858 if (! glyph
->u
.cmp
.automatic
)
19860 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
19862 if (cmp
->rbearing
- cmp
->pixel_width
)
19863 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19864 if (cmp
->lbearing
< 0);
19865 *left
= - cmp
->lbearing
;
19869 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
19870 struct font_metrics metrics
;
19872 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
19873 glyph
->u
.cmp
.to
, &metrics
);
19874 if (metrics
.rbearing
> metrics
.width
)
19875 *right
= metrics
.rbearing
;
19876 if (metrics
.lbearing
< 0)
19877 *left
= - metrics
.lbearing
;
19883 /* Return the index of the first glyph preceding glyph string S that
19884 is overwritten by S because of S's left overhang. Value is -1
19885 if no glyphs are overwritten. */
19888 left_overwritten (s
)
19889 struct glyph_string
*s
;
19893 if (s
->left_overhang
)
19896 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19897 int first
= s
->first_glyph
- glyphs
;
19899 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19900 x
-= glyphs
[i
].pixel_width
;
19911 /* Return the index of the first glyph preceding glyph string S that
19912 is overwriting S because of its right overhang. Value is -1 if no
19913 glyph in front of S overwrites S. */
19916 left_overwriting (s
)
19917 struct glyph_string
*s
;
19920 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19921 int first
= s
->first_glyph
- glyphs
;
19925 for (i
= first
- 1; i
>= 0; --i
)
19928 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19931 x
-= glyphs
[i
].pixel_width
;
19938 /* Return the index of the last glyph following glyph string S that is
19939 overwritten by S because of S's right overhang. Value is -1 if
19940 no such glyph is found. */
19943 right_overwritten (s
)
19944 struct glyph_string
*s
;
19948 if (s
->right_overhang
)
19951 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19952 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19953 int end
= s
->row
->used
[s
->area
];
19955 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19956 x
+= glyphs
[i
].pixel_width
;
19965 /* Return the index of the last glyph following glyph string S that
19966 overwrites S because of its left overhang. Value is negative
19967 if no such glyph is found. */
19970 right_overwriting (s
)
19971 struct glyph_string
*s
;
19974 int end
= s
->row
->used
[s
->area
];
19975 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19976 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19980 for (i
= first
; i
< end
; ++i
)
19983 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19986 x
+= glyphs
[i
].pixel_width
;
19993 /* Set background width of glyph string S. START is the index of the
19994 first glyph following S. LAST_X is the right-most x-position + 1
19995 in the drawing area. */
19998 set_glyph_string_background_width (s
, start
, last_x
)
19999 struct glyph_string
*s
;
20003 /* If the face of this glyph string has to be drawn to the end of
20004 the drawing area, set S->extends_to_end_of_line_p. */
20006 if (start
== s
->row
->used
[s
->area
]
20007 && s
->area
== TEXT_AREA
20008 && ((s
->row
->fill_line_p
20009 && (s
->hl
== DRAW_NORMAL_TEXT
20010 || s
->hl
== DRAW_IMAGE_RAISED
20011 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20012 || s
->hl
== DRAW_MOUSE_FACE
))
20013 s
->extends_to_end_of_line_p
= 1;
20015 /* If S extends its face to the end of the line, set its
20016 background_width to the distance to the right edge of the drawing
20018 if (s
->extends_to_end_of_line_p
)
20019 s
->background_width
= last_x
- s
->x
+ 1;
20021 s
->background_width
= s
->width
;
20025 /* Compute overhangs and x-positions for glyph string S and its
20026 predecessors, or successors. X is the starting x-position for S.
20027 BACKWARD_P non-zero means process predecessors. */
20030 compute_overhangs_and_x (s
, x
, backward_p
)
20031 struct glyph_string
*s
;
20039 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20040 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20050 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20051 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20061 /* The following macros are only called from draw_glyphs below.
20062 They reference the following parameters of that function directly:
20063 `w', `row', `area', and `overlap_p'
20064 as well as the following local variables:
20065 `s', `f', and `hdc' (in W32) */
20068 /* On W32, silently add local `hdc' variable to argument list of
20069 init_glyph_string. */
20070 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20071 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20073 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20074 init_glyph_string (s, char2b, w, row, area, start, hl)
20077 /* Add a glyph string for a stretch glyph to the list of strings
20078 between HEAD and TAIL. START is the index of the stretch glyph in
20079 row area AREA of glyph row ROW. END is the index of the last glyph
20080 in that glyph row area. X is the current output position assigned
20081 to the new glyph string constructed. HL overrides that face of the
20082 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20083 is the right-most x-position of the drawing area. */
20085 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20086 and below -- keep them on one line. */
20087 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20090 s = (struct glyph_string *) alloca (sizeof *s); \
20091 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20092 START = fill_stretch_glyph_string (s, row, area, START, END); \
20093 append_glyph_string (&HEAD, &TAIL, s); \
20099 /* Add a glyph string for an image glyph to the list of strings
20100 between HEAD and TAIL. START is the index of the image glyph in
20101 row area AREA of glyph row ROW. END is the index of the last glyph
20102 in that glyph row area. X is the current output position assigned
20103 to the new glyph string constructed. HL overrides that face of the
20104 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20105 is the right-most x-position of the drawing area. */
20107 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20110 s = (struct glyph_string *) alloca (sizeof *s); \
20111 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20112 fill_image_glyph_string (s); \
20113 append_glyph_string (&HEAD, &TAIL, s); \
20120 /* Add a glyph string for a sequence of character glyphs to the list
20121 of strings between HEAD and TAIL. START is the index of the first
20122 glyph in row area AREA of glyph row ROW that is part of the new
20123 glyph string. END is the index of the last glyph in that glyph row
20124 area. X is the current output position assigned to the new glyph
20125 string constructed. HL overrides that face of the glyph; e.g. it
20126 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20127 right-most x-position of the drawing area. */
20129 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20135 face_id = (row)->glyphs[area][START].face_id; \
20137 s = (struct glyph_string *) alloca (sizeof *s); \
20138 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20139 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20140 append_glyph_string (&HEAD, &TAIL, s); \
20142 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20147 /* Add a glyph string for a composite sequence to the list of strings
20148 between HEAD and TAIL. START is the index of the first glyph in
20149 row area AREA of glyph row ROW that is part of the new glyph
20150 string. END is the index of the last glyph in that glyph row area.
20151 X is the current output position assigned to the new glyph string
20152 constructed. HL overrides that face of the glyph; e.g. it is
20153 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20154 x-position of the drawing area. */
20156 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20158 int face_id = (row)->glyphs[area][START].face_id; \
20159 struct face *base_face = FACE_FROM_ID (f, face_id); \
20160 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20161 struct composition *cmp = composition_table[cmp_id]; \
20163 struct glyph_string *first_s; \
20166 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20168 /* Make glyph_strings for each glyph sequence that is drawable by \
20169 the same face, and append them to HEAD/TAIL. */ \
20170 for (n = 0; n < cmp->glyph_len;) \
20172 s = (struct glyph_string *) alloca (sizeof *s); \
20173 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20174 append_glyph_string (&(HEAD), &(TAIL), s); \
20180 n = fill_composite_glyph_string (s, base_face, overlaps); \
20188 /* Add a glyph string for a glyph-string sequence to the list of strings
20189 between HEAD and TAIL. */
20191 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20195 Lisp_Object gstring; \
20197 face_id = (row)->glyphs[area][START].face_id; \
20198 gstring = (composition_gstring_from_id \
20199 ((row)->glyphs[area][START].u.cmp.id)); \
20200 s = (struct glyph_string *) alloca (sizeof *s); \
20201 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20202 * LGSTRING_GLYPH_LEN (gstring)); \
20203 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20204 append_glyph_string (&(HEAD), &(TAIL), s); \
20206 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20210 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20211 of AREA of glyph row ROW on window W between indices START and END.
20212 HL overrides the face for drawing glyph strings, e.g. it is
20213 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20214 x-positions of the drawing area.
20216 This is an ugly monster macro construct because we must use alloca
20217 to allocate glyph strings (because draw_glyphs can be called
20218 asynchronously). */
20220 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20223 HEAD = TAIL = NULL; \
20224 while (START < END) \
20226 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20227 switch (first_glyph->type) \
20230 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20234 case COMPOSITE_GLYPH: \
20235 if (first_glyph->u.cmp.automatic) \
20236 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
20239 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20243 case STRETCH_GLYPH: \
20244 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20248 case IMAGE_GLYPH: \
20249 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20259 set_glyph_string_background_width (s, START, LAST_X); \
20266 /* Draw glyphs between START and END in AREA of ROW on window W,
20267 starting at x-position X. X is relative to AREA in W. HL is a
20268 face-override with the following meaning:
20270 DRAW_NORMAL_TEXT draw normally
20271 DRAW_CURSOR draw in cursor face
20272 DRAW_MOUSE_FACE draw in mouse face.
20273 DRAW_INVERSE_VIDEO draw in mode line face
20274 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20275 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20277 If OVERLAPS is non-zero, draw only the foreground of characters and
20278 clip to the physical height of ROW. Non-zero value also defines
20279 the overlapping part to be drawn:
20281 OVERLAPS_PRED overlap with preceding rows
20282 OVERLAPS_SUCC overlap with succeeding rows
20283 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20284 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20286 Value is the x-position reached, relative to AREA of W. */
20289 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20292 struct glyph_row
*row
;
20293 enum glyph_row_area area
;
20294 EMACS_INT start
, end
;
20295 enum draw_glyphs_face hl
;
20298 struct glyph_string
*head
, *tail
;
20299 struct glyph_string
*s
;
20300 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20301 int i
, j
, x_reached
, last_x
, area_left
= 0;
20302 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20305 ALLOCATE_HDC (hdc
, f
);
20307 /* Let's rather be paranoid than getting a SEGV. */
20308 end
= min (end
, row
->used
[area
]);
20309 start
= max (0, start
);
20310 start
= min (end
, start
);
20312 /* Translate X to frame coordinates. Set last_x to the right
20313 end of the drawing area. */
20314 if (row
->full_width_p
)
20316 /* X is relative to the left edge of W, without scroll bars
20318 area_left
= WINDOW_LEFT_EDGE_X (w
);
20319 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20323 area_left
= window_box_left (w
, area
);
20324 last_x
= area_left
+ window_box_width (w
, area
);
20328 /* Build a doubly-linked list of glyph_string structures between
20329 head and tail from what we have to draw. Note that the macro
20330 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20331 the reason we use a separate variable `i'. */
20333 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20335 x_reached
= tail
->x
+ tail
->background_width
;
20339 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20340 the row, redraw some glyphs in front or following the glyph
20341 strings built above. */
20342 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20344 struct glyph_string
*h
, *t
;
20345 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20346 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20349 /* If mouse highlighting is on, we may need to draw adjacent
20350 glyphs using mouse-face highlighting. */
20351 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20353 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20355 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20356 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20358 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20360 check_mouse_face
= 1;
20361 mouse_beg_col
= (row
== mouse_beg_row
)
20362 ? dpyinfo
->mouse_face_beg_col
: 0;
20363 mouse_end_col
= (row
== mouse_end_row
)
20364 ? dpyinfo
->mouse_face_end_col
20365 : row
->used
[TEXT_AREA
];
20369 /* Compute overhangs for all glyph strings. */
20370 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20371 for (s
= head
; s
; s
= s
->next
)
20372 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20374 /* Prepend glyph strings for glyphs in front of the first glyph
20375 string that are overwritten because of the first glyph
20376 string's left overhang. The background of all strings
20377 prepended must be drawn because the first glyph string
20379 i
= left_overwritten (head
);
20382 enum draw_glyphs_face overlap_hl
;
20384 /* If this row contains mouse highlighting, attempt to draw
20385 the overlapped glyphs with the correct highlight. This
20386 code fails if the overlap encompasses more than one glyph
20387 and mouse-highlight spans only some of these glyphs.
20388 However, making it work perfectly involves a lot more
20389 code, and I don't know if the pathological case occurs in
20390 practice, so we'll stick to this for now. --- cyd */
20391 if (check_mouse_face
20392 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20393 overlap_hl
= DRAW_MOUSE_FACE
;
20395 overlap_hl
= DRAW_NORMAL_TEXT
;
20398 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20399 overlap_hl
, dummy_x
, last_x
);
20400 compute_overhangs_and_x (t
, head
->x
, 1);
20401 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20405 /* Prepend glyph strings for glyphs in front of the first glyph
20406 string that overwrite that glyph string because of their
20407 right overhang. For these strings, only the foreground must
20408 be drawn, because it draws over the glyph string at `head'.
20409 The background must not be drawn because this would overwrite
20410 right overhangs of preceding glyphs for which no glyph
20412 i
= left_overwriting (head
);
20415 enum draw_glyphs_face overlap_hl
;
20417 if (check_mouse_face
20418 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20419 overlap_hl
= DRAW_MOUSE_FACE
;
20421 overlap_hl
= DRAW_NORMAL_TEXT
;
20424 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20425 overlap_hl
, dummy_x
, last_x
);
20426 for (s
= h
; s
; s
= s
->next
)
20427 s
->background_filled_p
= 1;
20428 compute_overhangs_and_x (t
, head
->x
, 1);
20429 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20432 /* Append glyphs strings for glyphs following the last glyph
20433 string tail that are overwritten by tail. The background of
20434 these strings has to be drawn because tail's foreground draws
20436 i
= right_overwritten (tail
);
20439 enum draw_glyphs_face overlap_hl
;
20441 if (check_mouse_face
20442 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20443 overlap_hl
= DRAW_MOUSE_FACE
;
20445 overlap_hl
= DRAW_NORMAL_TEXT
;
20447 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20448 overlap_hl
, x
, last_x
);
20449 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20450 append_glyph_string_lists (&head
, &tail
, h
, t
);
20454 /* Append glyph strings for glyphs following the last glyph
20455 string tail that overwrite tail. The foreground of such
20456 glyphs has to be drawn because it writes into the background
20457 of tail. The background must not be drawn because it could
20458 paint over the foreground of following glyphs. */
20459 i
= right_overwriting (tail
);
20462 enum draw_glyphs_face overlap_hl
;
20463 if (check_mouse_face
20464 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20465 overlap_hl
= DRAW_MOUSE_FACE
;
20467 overlap_hl
= DRAW_NORMAL_TEXT
;
20470 i
++; /* We must include the Ith glyph. */
20471 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20472 overlap_hl
, x
, last_x
);
20473 for (s
= h
; s
; s
= s
->next
)
20474 s
->background_filled_p
= 1;
20475 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20476 append_glyph_string_lists (&head
, &tail
, h
, t
);
20478 if (clip_head
|| clip_tail
)
20479 for (s
= head
; s
; s
= s
->next
)
20481 s
->clip_head
= clip_head
;
20482 s
->clip_tail
= clip_tail
;
20486 /* Draw all strings. */
20487 for (s
= head
; s
; s
= s
->next
)
20488 FRAME_RIF (f
)->draw_glyph_string (s
);
20491 /* When focus a sole frame and move horizontally, this sets on_p to 0
20492 causing a failure to erase prev cursor position. */
20493 if (area
== TEXT_AREA
20494 && !row
->full_width_p
20495 /* When drawing overlapping rows, only the glyph strings'
20496 foreground is drawn, which doesn't erase a cursor
20500 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20501 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20502 : (tail
? tail
->x
+ tail
->background_width
: x
));
20506 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20507 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20511 /* Value is the x-position up to which drawn, relative to AREA of W.
20512 This doesn't include parts drawn because of overhangs. */
20513 if (row
->full_width_p
)
20514 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20516 x_reached
-= area_left
;
20518 RELEASE_HDC (hdc
, f
);
20523 /* Expand row matrix if too narrow. Don't expand if area
20526 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20528 if (!fonts_changed_p \
20529 && (it->glyph_row->glyphs[area] \
20530 < it->glyph_row->glyphs[area + 1])) \
20532 it->w->ncols_scale_factor++; \
20533 fonts_changed_p = 1; \
20537 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20538 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20544 struct glyph
*glyph
;
20545 enum glyph_row_area area
= it
->area
;
20547 xassert (it
->glyph_row
);
20548 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20550 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20551 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20553 glyph
->charpos
= CHARPOS (it
->position
);
20554 glyph
->object
= it
->object
;
20555 if (it
->pixel_width
> 0)
20557 glyph
->pixel_width
= it
->pixel_width
;
20558 glyph
->padding_p
= 0;
20562 /* Assure at least 1-pixel width. Otherwise, cursor can't
20563 be displayed correctly. */
20564 glyph
->pixel_width
= 1;
20565 glyph
->padding_p
= 1;
20567 glyph
->ascent
= it
->ascent
;
20568 glyph
->descent
= it
->descent
;
20569 glyph
->voffset
= it
->voffset
;
20570 glyph
->type
= CHAR_GLYPH
;
20571 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20572 glyph
->multibyte_p
= it
->multibyte_p
;
20573 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20574 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20575 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20576 || it
->phys_descent
> it
->descent
);
20577 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20578 glyph
->face_id
= it
->face_id
;
20579 glyph
->u
.ch
= it
->char_to_display
;
20580 glyph
->slice
= null_glyph_slice
;
20581 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20582 ++it
->glyph_row
->used
[area
];
20585 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20588 /* Store one glyph for the composition IT->cmp_it.id in
20589 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
20593 append_composite_glyph (it
)
20596 struct glyph
*glyph
;
20597 enum glyph_row_area area
= it
->area
;
20599 xassert (it
->glyph_row
);
20601 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20602 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20604 glyph
->charpos
= CHARPOS (it
->position
);
20605 glyph
->object
= it
->object
;
20606 glyph
->pixel_width
= it
->pixel_width
;
20607 glyph
->ascent
= it
->ascent
;
20608 glyph
->descent
= it
->descent
;
20609 glyph
->voffset
= it
->voffset
;
20610 glyph
->type
= COMPOSITE_GLYPH
;
20611 if (it
->cmp_it
.ch
< 0)
20613 glyph
->u
.cmp
.automatic
= 0;
20614 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20618 glyph
->u
.cmp
.automatic
= 1;
20619 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20620 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
20621 glyph
->u
.cmp
.to
= it
->cmp_it
.to
;
20623 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20624 glyph
->multibyte_p
= it
->multibyte_p
;
20625 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20626 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20627 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20628 || it
->phys_descent
> it
->descent
);
20629 glyph
->padding_p
= 0;
20630 glyph
->glyph_not_available_p
= 0;
20631 glyph
->face_id
= it
->face_id
;
20632 glyph
->slice
= null_glyph_slice
;
20633 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20634 ++it
->glyph_row
->used
[area
];
20637 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20641 /* Change IT->ascent and IT->height according to the setting of
20645 take_vertical_position_into_account (it
)
20650 if (it
->voffset
< 0)
20651 /* Increase the ascent so that we can display the text higher
20653 it
->ascent
-= it
->voffset
;
20655 /* Increase the descent so that we can display the text lower
20657 it
->descent
+= it
->voffset
;
20662 /* Produce glyphs/get display metrics for the image IT is loaded with.
20663 See the description of struct display_iterator in dispextern.h for
20664 an overview of struct display_iterator. */
20667 produce_image_glyph (it
)
20672 int glyph_ascent
, crop
;
20673 struct glyph_slice slice
;
20675 xassert (it
->what
== IT_IMAGE
);
20677 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20679 /* Make sure X resources of the face is loaded. */
20680 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20682 if (it
->image_id
< 0)
20684 /* Fringe bitmap. */
20685 it
->ascent
= it
->phys_ascent
= 0;
20686 it
->descent
= it
->phys_descent
= 0;
20687 it
->pixel_width
= 0;
20692 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20694 /* Make sure X resources of the image is loaded. */
20695 prepare_image_for_display (it
->f
, img
);
20697 slice
.x
= slice
.y
= 0;
20698 slice
.width
= img
->width
;
20699 slice
.height
= img
->height
;
20701 if (INTEGERP (it
->slice
.x
))
20702 slice
.x
= XINT (it
->slice
.x
);
20703 else if (FLOATP (it
->slice
.x
))
20704 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20706 if (INTEGERP (it
->slice
.y
))
20707 slice
.y
= XINT (it
->slice
.y
);
20708 else if (FLOATP (it
->slice
.y
))
20709 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20711 if (INTEGERP (it
->slice
.width
))
20712 slice
.width
= XINT (it
->slice
.width
);
20713 else if (FLOATP (it
->slice
.width
))
20714 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20716 if (INTEGERP (it
->slice
.height
))
20717 slice
.height
= XINT (it
->slice
.height
);
20718 else if (FLOATP (it
->slice
.height
))
20719 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20721 if (slice
.x
>= img
->width
)
20722 slice
.x
= img
->width
;
20723 if (slice
.y
>= img
->height
)
20724 slice
.y
= img
->height
;
20725 if (slice
.x
+ slice
.width
>= img
->width
)
20726 slice
.width
= img
->width
- slice
.x
;
20727 if (slice
.y
+ slice
.height
> img
->height
)
20728 slice
.height
= img
->height
- slice
.y
;
20730 if (slice
.width
== 0 || slice
.height
== 0)
20733 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20735 it
->descent
= slice
.height
- glyph_ascent
;
20737 it
->descent
+= img
->vmargin
;
20738 if (slice
.y
+ slice
.height
== img
->height
)
20739 it
->descent
+= img
->vmargin
;
20740 it
->phys_descent
= it
->descent
;
20742 it
->pixel_width
= slice
.width
;
20744 it
->pixel_width
+= img
->hmargin
;
20745 if (slice
.x
+ slice
.width
== img
->width
)
20746 it
->pixel_width
+= img
->hmargin
;
20748 /* It's quite possible for images to have an ascent greater than
20749 their height, so don't get confused in that case. */
20750 if (it
->descent
< 0)
20753 #if 0 /* this breaks image tiling */
20754 /* If this glyph is alone on the last line, adjust it.ascent to minimum row ascent. */
20755 int face_ascent
= face
->font
? FONT_BASE (face
->font
) : FRAME_BASELINE_OFFSET (it
->f
);
20756 if (face_ascent
> it
->ascent
)
20757 it
->ascent
= it
->phys_ascent
= face_ascent
;
20762 if (face
->box
!= FACE_NO_BOX
)
20764 if (face
->box_line_width
> 0)
20767 it
->ascent
+= face
->box_line_width
;
20768 if (slice
.y
+ slice
.height
== img
->height
)
20769 it
->descent
+= face
->box_line_width
;
20772 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20773 it
->pixel_width
+= eabs (face
->box_line_width
);
20774 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20775 it
->pixel_width
+= eabs (face
->box_line_width
);
20778 take_vertical_position_into_account (it
);
20780 /* Automatically crop wide image glyphs at right edge so we can
20781 draw the cursor on same display row. */
20782 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20783 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20785 it
->pixel_width
-= crop
;
20786 slice
.width
-= crop
;
20791 struct glyph
*glyph
;
20792 enum glyph_row_area area
= it
->area
;
20794 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20795 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20797 glyph
->charpos
= CHARPOS (it
->position
);
20798 glyph
->object
= it
->object
;
20799 glyph
->pixel_width
= it
->pixel_width
;
20800 glyph
->ascent
= glyph_ascent
;
20801 glyph
->descent
= it
->descent
;
20802 glyph
->voffset
= it
->voffset
;
20803 glyph
->type
= IMAGE_GLYPH
;
20804 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20805 glyph
->multibyte_p
= it
->multibyte_p
;
20806 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20807 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20808 glyph
->overlaps_vertically_p
= 0;
20809 glyph
->padding_p
= 0;
20810 glyph
->glyph_not_available_p
= 0;
20811 glyph
->face_id
= it
->face_id
;
20812 glyph
->u
.img_id
= img
->id
;
20813 glyph
->slice
= slice
;
20814 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20815 ++it
->glyph_row
->used
[area
];
20818 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20823 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20824 of the glyph, WIDTH and HEIGHT are the width and height of the
20825 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20828 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20830 Lisp_Object object
;
20834 struct glyph
*glyph
;
20835 enum glyph_row_area area
= it
->area
;
20837 xassert (ascent
>= 0 && ascent
<= height
);
20839 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20840 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20842 glyph
->charpos
= CHARPOS (it
->position
);
20843 glyph
->object
= object
;
20844 glyph
->pixel_width
= width
;
20845 glyph
->ascent
= ascent
;
20846 glyph
->descent
= height
- ascent
;
20847 glyph
->voffset
= it
->voffset
;
20848 glyph
->type
= STRETCH_GLYPH
;
20849 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20850 glyph
->multibyte_p
= it
->multibyte_p
;
20851 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20852 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20853 glyph
->overlaps_vertically_p
= 0;
20854 glyph
->padding_p
= 0;
20855 glyph
->glyph_not_available_p
= 0;
20856 glyph
->face_id
= it
->face_id
;
20857 glyph
->u
.stretch
.ascent
= ascent
;
20858 glyph
->u
.stretch
.height
= height
;
20859 glyph
->slice
= null_glyph_slice
;
20860 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20861 ++it
->glyph_row
->used
[area
];
20864 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20868 /* Produce a stretch glyph for iterator IT. IT->object is the value
20869 of the glyph property displayed. The value must be a list
20870 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20873 1. `:width WIDTH' specifies that the space should be WIDTH *
20874 canonical char width wide. WIDTH may be an integer or floating
20877 2. `:relative-width FACTOR' specifies that the width of the stretch
20878 should be computed from the width of the first character having the
20879 `glyph' property, and should be FACTOR times that width.
20881 3. `:align-to HPOS' specifies that the space should be wide enough
20882 to reach HPOS, a value in canonical character units.
20884 Exactly one of the above pairs must be present.
20886 4. `:height HEIGHT' specifies that the height of the stretch produced
20887 should be HEIGHT, measured in canonical character units.
20889 5. `:relative-height FACTOR' specifies that the height of the
20890 stretch should be FACTOR times the height of the characters having
20891 the glyph property.
20893 Either none or exactly one of 4 or 5 must be present.
20895 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20896 of the stretch should be used for the ascent of the stretch.
20897 ASCENT must be in the range 0 <= ASCENT <= 100. */
20900 produce_stretch_glyph (it
)
20903 /* (space :width WIDTH :height HEIGHT ...) */
20904 Lisp_Object prop
, plist
;
20905 int width
= 0, height
= 0, align_to
= -1;
20906 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20909 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20910 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20912 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20914 /* List should start with `space'. */
20915 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20916 plist
= XCDR (it
->object
);
20918 /* Compute the width of the stretch. */
20919 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20920 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20922 /* Absolute width `:width WIDTH' specified and valid. */
20923 zero_width_ok_p
= 1;
20926 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20929 /* Relative width `:relative-width FACTOR' specified and valid.
20930 Compute the width of the characters having the `glyph'
20933 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20936 if (it
->multibyte_p
)
20938 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20939 - IT_BYTEPOS (*it
));
20940 it2
.c
= STRING_CHAR_AND_LENGTH (p
, maxlen
, it2
.len
);
20943 it2
.c
= *p
, it2
.len
= 1;
20945 it2
.glyph_row
= NULL
;
20946 it2
.what
= IT_CHARACTER
;
20947 x_produce_glyphs (&it2
);
20948 width
= NUMVAL (prop
) * it2
.pixel_width
;
20950 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20951 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20953 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20954 align_to
= (align_to
< 0
20956 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20957 else if (align_to
< 0)
20958 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20959 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20960 zero_width_ok_p
= 1;
20963 /* Nothing specified -> width defaults to canonical char width. */
20964 width
= FRAME_COLUMN_WIDTH (it
->f
);
20966 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20969 /* Compute height. */
20970 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20971 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20974 zero_height_ok_p
= 1;
20976 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20978 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20980 height
= FONT_HEIGHT (font
);
20982 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20985 /* Compute percentage of height used for ascent. If
20986 `:ascent ASCENT' is present and valid, use that. Otherwise,
20987 derive the ascent from the font in use. */
20988 if (prop
= Fplist_get (plist
, QCascent
),
20989 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20990 ascent
= height
* NUMVAL (prop
) / 100.0;
20991 else if (!NILP (prop
)
20992 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20993 ascent
= min (max (0, (int)tem
), height
);
20995 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20997 if (width
> 0 && it
->line_wrap
!= TRUNCATE
20998 && it
->current_x
+ width
> it
->last_visible_x
)
20999 width
= it
->last_visible_x
- it
->current_x
- 1;
21001 if (width
> 0 && height
> 0 && it
->glyph_row
)
21003 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21004 if (!STRINGP (object
))
21005 object
= it
->w
->buffer
;
21006 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21009 it
->pixel_width
= width
;
21010 it
->ascent
= it
->phys_ascent
= ascent
;
21011 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21012 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21014 take_vertical_position_into_account (it
);
21017 /* Calculate line-height and line-spacing properties.
21018 An integer value specifies explicit pixel value.
21019 A float value specifies relative value to current face height.
21020 A cons (float . face-name) specifies relative value to
21021 height of specified face font.
21023 Returns height in pixels, or nil. */
21027 calc_line_height_property (it
, val
, font
, boff
, override
)
21031 int boff
, override
;
21033 Lisp_Object face_name
= Qnil
;
21034 int ascent
, descent
, height
;
21036 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21041 face_name
= XCAR (val
);
21043 if (!NUMBERP (val
))
21044 val
= make_number (1);
21045 if (NILP (face_name
))
21047 height
= it
->ascent
+ it
->descent
;
21052 if (NILP (face_name
))
21054 font
= FRAME_FONT (it
->f
);
21055 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21057 else if (EQ (face_name
, Qt
))
21066 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21068 return make_number (-1);
21070 face
= FACE_FROM_ID (it
->f
, face_id
);
21073 return make_number (-1);
21074 boff
= font
->baseline_offset
;
21075 if (font
->vertical_centering
)
21076 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21079 ascent
= FONT_BASE (font
) + boff
;
21080 descent
= FONT_DESCENT (font
) - boff
;
21084 it
->override_ascent
= ascent
;
21085 it
->override_descent
= descent
;
21086 it
->override_boff
= boff
;
21089 height
= ascent
+ descent
;
21093 height
= (int)(XFLOAT_DATA (val
) * height
);
21094 else if (INTEGERP (val
))
21095 height
*= XINT (val
);
21097 return make_number (height
);
21102 Produce glyphs/get display metrics for the display element IT is
21103 loaded with. See the description of struct it in dispextern.h
21104 for an overview of struct it. */
21107 x_produce_glyphs (it
)
21110 int extra_line_spacing
= it
->extra_line_spacing
;
21112 it
->glyph_not_available_p
= 0;
21114 if (it
->what
== IT_CHARACTER
)
21118 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21119 struct font_metrics
*pcm
;
21120 int font_not_found_p
;
21121 int boff
; /* baseline offset */
21122 /* We may change it->multibyte_p upon unibyte<->multibyte
21123 conversion. So, save the current value now and restore it
21126 Note: It seems that we don't have to record multibyte_p in
21127 struct glyph because the character code itself tells if or
21128 not the character is multibyte. Thus, in the future, we must
21129 consider eliminating the field `multibyte_p' in the struct
21131 int saved_multibyte_p
= it
->multibyte_p
;
21133 /* Maybe translate single-byte characters to multibyte, or the
21135 it
->char_to_display
= it
->c
;
21136 if (!ASCII_BYTE_P (it
->c
)
21137 && ! it
->multibyte_p
)
21139 if (SINGLE_BYTE_CHAR_P (it
->c
)
21140 && unibyte_display_via_language_environment
)
21141 it
->char_to_display
= unibyte_char_to_multibyte (it
->c
);
21142 if (! SINGLE_BYTE_CHAR_P (it
->char_to_display
))
21144 it
->multibyte_p
= 1;
21145 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21147 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21151 /* Get font to use. Encode IT->char_to_display. */
21152 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21153 &char2b
, it
->multibyte_p
, 0);
21156 /* When no suitable font found, use the default font. */
21157 font_not_found_p
= font
== NULL
;
21158 if (font_not_found_p
)
21160 font
= FRAME_FONT (it
->f
);
21161 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21165 boff
= font
->baseline_offset
;
21166 if (font
->vertical_centering
)
21167 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21170 if (it
->char_to_display
>= ' '
21171 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21173 /* Either unibyte or ASCII. */
21178 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21180 if (it
->override_ascent
>= 0)
21182 it
->ascent
= it
->override_ascent
;
21183 it
->descent
= it
->override_descent
;
21184 boff
= it
->override_boff
;
21188 it
->ascent
= FONT_BASE (font
) + boff
;
21189 it
->descent
= FONT_DESCENT (font
) - boff
;
21194 it
->phys_ascent
= pcm
->ascent
+ boff
;
21195 it
->phys_descent
= pcm
->descent
- boff
;
21196 it
->pixel_width
= pcm
->width
;
21200 it
->glyph_not_available_p
= 1;
21201 it
->phys_ascent
= it
->ascent
;
21202 it
->phys_descent
= it
->descent
;
21203 it
->pixel_width
= FONT_WIDTH (font
);
21206 if (it
->constrain_row_ascent_descent_p
)
21208 if (it
->descent
> it
->max_descent
)
21210 it
->ascent
+= it
->descent
- it
->max_descent
;
21211 it
->descent
= it
->max_descent
;
21213 if (it
->ascent
> it
->max_ascent
)
21215 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21216 it
->ascent
= it
->max_ascent
;
21218 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21219 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21220 extra_line_spacing
= 0;
21223 /* If this is a space inside a region of text with
21224 `space-width' property, change its width. */
21225 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21227 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21229 /* If face has a box, add the box thickness to the character
21230 height. If character has a box line to the left and/or
21231 right, add the box line width to the character's width. */
21232 if (face
->box
!= FACE_NO_BOX
)
21234 int thick
= face
->box_line_width
;
21238 it
->ascent
+= thick
;
21239 it
->descent
+= thick
;
21244 if (it
->start_of_box_run_p
)
21245 it
->pixel_width
+= thick
;
21246 if (it
->end_of_box_run_p
)
21247 it
->pixel_width
+= thick
;
21250 /* If face has an overline, add the height of the overline
21251 (1 pixel) and a 1 pixel margin to the character height. */
21252 if (face
->overline_p
)
21253 it
->ascent
+= overline_margin
;
21255 if (it
->constrain_row_ascent_descent_p
)
21257 if (it
->ascent
> it
->max_ascent
)
21258 it
->ascent
= it
->max_ascent
;
21259 if (it
->descent
> it
->max_descent
)
21260 it
->descent
= it
->max_descent
;
21263 take_vertical_position_into_account (it
);
21265 /* If we have to actually produce glyphs, do it. */
21270 /* Translate a space with a `space-width' property
21271 into a stretch glyph. */
21272 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21273 / FONT_HEIGHT (font
));
21274 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21275 it
->ascent
+ it
->descent
, ascent
);
21280 /* If characters with lbearing or rbearing are displayed
21281 in this line, record that fact in a flag of the
21282 glyph row. This is used to optimize X output code. */
21283 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21284 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21286 if (! stretched_p
&& it
->pixel_width
== 0)
21287 /* We assure that all visible glyphs have at least 1-pixel
21289 it
->pixel_width
= 1;
21291 else if (it
->char_to_display
== '\n')
21293 /* A newline has no width but we need the height of the line.
21294 But if previous part of the line set a height, don't
21295 increase that height */
21297 Lisp_Object height
;
21298 Lisp_Object total_height
= Qnil
;
21300 it
->override_ascent
= -1;
21301 it
->pixel_width
= 0;
21304 height
= get_it_property(it
, Qline_height
);
21305 /* Split (line-height total-height) list */
21307 && CONSP (XCDR (height
))
21308 && NILP (XCDR (XCDR (height
))))
21310 total_height
= XCAR (XCDR (height
));
21311 height
= XCAR (height
);
21313 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21315 if (it
->override_ascent
>= 0)
21317 it
->ascent
= it
->override_ascent
;
21318 it
->descent
= it
->override_descent
;
21319 boff
= it
->override_boff
;
21323 it
->ascent
= FONT_BASE (font
) + boff
;
21324 it
->descent
= FONT_DESCENT (font
) - boff
;
21327 if (EQ (height
, Qt
))
21329 if (it
->descent
> it
->max_descent
)
21331 it
->ascent
+= it
->descent
- it
->max_descent
;
21332 it
->descent
= it
->max_descent
;
21334 if (it
->ascent
> it
->max_ascent
)
21336 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21337 it
->ascent
= it
->max_ascent
;
21339 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21340 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21341 it
->constrain_row_ascent_descent_p
= 1;
21342 extra_line_spacing
= 0;
21346 Lisp_Object spacing
;
21348 it
->phys_ascent
= it
->ascent
;
21349 it
->phys_descent
= it
->descent
;
21351 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21352 && face
->box
!= FACE_NO_BOX
21353 && face
->box_line_width
> 0)
21355 it
->ascent
+= face
->box_line_width
;
21356 it
->descent
+= face
->box_line_width
;
21359 && XINT (height
) > it
->ascent
+ it
->descent
)
21360 it
->ascent
= XINT (height
) - it
->descent
;
21362 if (!NILP (total_height
))
21363 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21366 spacing
= get_it_property(it
, Qline_spacing
);
21367 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21369 if (INTEGERP (spacing
))
21371 extra_line_spacing
= XINT (spacing
);
21372 if (!NILP (total_height
))
21373 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21377 else if (it
->char_to_display
== '\t')
21379 if (font
->space_width
> 0)
21381 int tab_width
= it
->tab_width
* font
->space_width
;
21382 int x
= it
->current_x
+ it
->continuation_lines_width
;
21383 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21385 /* If the distance from the current position to the next tab
21386 stop is less than a space character width, use the
21387 tab stop after that. */
21388 if (next_tab_x
- x
< font
->space_width
)
21389 next_tab_x
+= tab_width
;
21391 it
->pixel_width
= next_tab_x
- x
;
21393 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21394 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21398 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21399 it
->ascent
+ it
->descent
, it
->ascent
);
21404 it
->pixel_width
= 0;
21410 /* A multi-byte character. Assume that the display width of the
21411 character is the width of the character multiplied by the
21412 width of the font. */
21414 /* If we found a font, this font should give us the right
21415 metrics. If we didn't find a font, use the frame's
21416 default font and calculate the width of the character by
21417 multiplying the width of font by the width of the
21420 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21422 if (font_not_found_p
|| !pcm
)
21424 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21426 if (char_width
== 0)
21427 /* This is a non spacing character. But, as we are
21428 going to display an empty box, the box must occupy
21429 at least one column. */
21431 it
->glyph_not_available_p
= 1;
21432 it
->pixel_width
= FRAME_COLUMN_WIDTH (it
->f
) * char_width
;
21433 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21434 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21438 it
->pixel_width
= pcm
->width
;
21439 it
->phys_ascent
= pcm
->ascent
+ boff
;
21440 it
->phys_descent
= pcm
->descent
- boff
;
21442 && (pcm
->lbearing
< 0
21443 || pcm
->rbearing
> pcm
->width
))
21444 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21447 it
->ascent
= FONT_BASE (font
) + boff
;
21448 it
->descent
= FONT_DESCENT (font
) - boff
;
21449 if (face
->box
!= FACE_NO_BOX
)
21451 int thick
= face
->box_line_width
;
21455 it
->ascent
+= thick
;
21456 it
->descent
+= thick
;
21461 if (it
->start_of_box_run_p
)
21462 it
->pixel_width
+= thick
;
21463 if (it
->end_of_box_run_p
)
21464 it
->pixel_width
+= thick
;
21467 /* If face has an overline, add the height of the overline
21468 (1 pixel) and a 1 pixel margin to the character height. */
21469 if (face
->overline_p
)
21470 it
->ascent
+= overline_margin
;
21472 take_vertical_position_into_account (it
);
21474 if (it
->ascent
< 0)
21476 if (it
->descent
< 0)
21481 if (it
->pixel_width
== 0)
21482 /* We assure that all visible glyphs have at least 1-pixel
21484 it
->pixel_width
= 1;
21486 it
->multibyte_p
= saved_multibyte_p
;
21488 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
21490 /* A static compositoin.
21492 Note: A composition is represented as one glyph in the
21493 glyph matrix. There are no padding glyphs.
21495 Important is that pixel_width, ascent, and descent are the
21496 values of what is drawn by draw_glyphs (i.e. the values of
21497 the overall glyphs composed). */
21498 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21499 int boff
; /* baseline offset */
21500 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
21501 int glyph_len
= cmp
->glyph_len
;
21502 struct font
*font
= face
->font
;
21506 /* If we have not yet calculated pixel size data of glyphs of
21507 the composition for the current face font, calculate them
21508 now. Theoretically, we have to check all fonts for the
21509 glyphs, but that requires much time and memory space. So,
21510 here we check only the font of the first glyph. This leads
21511 to incorrect display, but it's very rare, and C-l (recenter)
21512 can correct the display anyway. */
21513 if (! cmp
->font
|| cmp
->font
!= font
)
21515 /* Ascent and descent of the font of the first character
21516 of this composition (adjusted by baseline offset).
21517 Ascent and descent of overall glyphs should not be less
21518 than them respectively. */
21519 int font_ascent
, font_descent
, font_height
;
21520 /* Bounding box of the overall glyphs. */
21521 int leftmost
, rightmost
, lowest
, highest
;
21522 int lbearing
, rbearing
;
21523 int i
, width
, ascent
, descent
;
21524 int left_padded
= 0, right_padded
= 0;
21527 struct font_metrics
*pcm
;
21528 int font_not_found_p
;
21531 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21532 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21534 if (glyph_len
< cmp
->glyph_len
)
21536 for (i
= 0; i
< glyph_len
; i
++)
21538 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21540 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21545 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21546 : IT_CHARPOS (*it
));
21547 /* When no suitable font found, use the default font. */
21548 font_not_found_p
= font
== NULL
;
21549 if (font_not_found_p
)
21551 face
= face
->ascii_face
;
21554 boff
= font
->baseline_offset
;
21555 if (font
->vertical_centering
)
21556 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21557 font_ascent
= FONT_BASE (font
) + boff
;
21558 font_descent
= FONT_DESCENT (font
) - boff
;
21559 font_height
= FONT_HEIGHT (font
);
21561 cmp
->font
= (void *) font
;
21564 if (! font_not_found_p
)
21566 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21567 &char2b
, it
->multibyte_p
, 0);
21568 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21571 /* Initialize the bounding box. */
21574 width
= pcm
->width
;
21575 ascent
= pcm
->ascent
;
21576 descent
= pcm
->descent
;
21577 lbearing
= pcm
->lbearing
;
21578 rbearing
= pcm
->rbearing
;
21582 width
= FONT_WIDTH (font
);
21583 ascent
= FONT_BASE (font
);
21584 descent
= FONT_DESCENT (font
);
21591 lowest
= - descent
+ boff
;
21592 highest
= ascent
+ boff
;
21594 if (! font_not_found_p
21595 && font
->default_ascent
21596 && CHAR_TABLE_P (Vuse_default_ascent
)
21597 && !NILP (Faref (Vuse_default_ascent
,
21598 make_number (it
->char_to_display
))))
21599 highest
= font
->default_ascent
+ boff
;
21601 /* Draw the first glyph at the normal position. It may be
21602 shifted to right later if some other glyphs are drawn
21604 cmp
->offsets
[i
* 2] = 0;
21605 cmp
->offsets
[i
* 2 + 1] = boff
;
21606 cmp
->lbearing
= lbearing
;
21607 cmp
->rbearing
= rbearing
;
21609 /* Set cmp->offsets for the remaining glyphs. */
21610 for (i
++; i
< glyph_len
; i
++)
21612 int left
, right
, btm
, top
;
21613 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21615 struct face
*this_face
;
21620 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21621 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21622 font
= this_face
->font
;
21628 this_boff
= font
->baseline_offset
;
21629 if (font
->vertical_centering
)
21630 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21631 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21632 &char2b
, it
->multibyte_p
, 0);
21633 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21636 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21639 width
= pcm
->width
;
21640 ascent
= pcm
->ascent
;
21641 descent
= pcm
->descent
;
21642 lbearing
= pcm
->lbearing
;
21643 rbearing
= pcm
->rbearing
;
21644 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21646 /* Relative composition with or without
21647 alternate chars. */
21648 left
= (leftmost
+ rightmost
- width
) / 2;
21649 btm
= - descent
+ boff
;
21650 if (font
->relative_compose
21651 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21652 || NILP (Faref (Vignore_relative_composition
,
21653 make_number (ch
)))))
21656 if (- descent
>= font
->relative_compose
)
21657 /* One extra pixel between two glyphs. */
21659 else if (ascent
<= 0)
21660 /* One extra pixel between two glyphs. */
21661 btm
= lowest
- 1 - ascent
- descent
;
21666 /* A composition rule is specified by an integer
21667 value that encodes global and new reference
21668 points (GREF and NREF). GREF and NREF are
21669 specified by numbers as below:
21671 0---1---2 -- ascent
21675 9--10--11 -- center
21677 ---3---4---5--- baseline
21679 6---7---8 -- descent
21681 int rule
= COMPOSITION_RULE (cmp
, i
);
21682 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21684 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21685 grefx
= gref
% 3, nrefx
= nref
% 3;
21686 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21688 xoff
= font_height
* (xoff
- 128) / 256;
21690 yoff
= font_height
* (yoff
- 128) / 256;
21693 + grefx
* (rightmost
- leftmost
) / 2
21694 - nrefx
* width
/ 2
21697 btm
= ((grefy
== 0 ? highest
21699 : grefy
== 2 ? lowest
21700 : (highest
+ lowest
) / 2)
21701 - (nrefy
== 0 ? ascent
+ descent
21702 : nrefy
== 1 ? descent
- boff
21704 : (ascent
+ descent
) / 2)
21708 cmp
->offsets
[i
* 2] = left
;
21709 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21711 /* Update the bounding box of the overall glyphs. */
21714 right
= left
+ width
;
21715 if (left
< leftmost
)
21717 if (right
> rightmost
)
21720 top
= btm
+ descent
+ ascent
;
21726 if (cmp
->lbearing
> left
+ lbearing
)
21727 cmp
->lbearing
= left
+ lbearing
;
21728 if (cmp
->rbearing
< left
+ rbearing
)
21729 cmp
->rbearing
= left
+ rbearing
;
21733 /* If there are glyphs whose x-offsets are negative,
21734 shift all glyphs to the right and make all x-offsets
21738 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21739 cmp
->offsets
[i
* 2] -= leftmost
;
21740 rightmost
-= leftmost
;
21741 cmp
->lbearing
-= leftmost
;
21742 cmp
->rbearing
-= leftmost
;
21745 if (left_padded
&& cmp
->lbearing
< 0)
21747 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21748 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21749 rightmost
-= cmp
->lbearing
;
21750 cmp
->rbearing
-= cmp
->lbearing
;
21753 if (right_padded
&& rightmost
< cmp
->rbearing
)
21755 rightmost
= cmp
->rbearing
;
21758 cmp
->pixel_width
= rightmost
;
21759 cmp
->ascent
= highest
;
21760 cmp
->descent
= - lowest
;
21761 if (cmp
->ascent
< font_ascent
)
21762 cmp
->ascent
= font_ascent
;
21763 if (cmp
->descent
< font_descent
)
21764 cmp
->descent
= font_descent
;
21768 && (cmp
->lbearing
< 0
21769 || cmp
->rbearing
> cmp
->pixel_width
))
21770 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21772 it
->pixel_width
= cmp
->pixel_width
;
21773 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21774 it
->descent
= it
->phys_descent
= cmp
->descent
;
21775 if (face
->box
!= FACE_NO_BOX
)
21777 int thick
= face
->box_line_width
;
21781 it
->ascent
+= thick
;
21782 it
->descent
+= thick
;
21787 if (it
->start_of_box_run_p
)
21788 it
->pixel_width
+= thick
;
21789 if (it
->end_of_box_run_p
)
21790 it
->pixel_width
+= thick
;
21793 /* If face has an overline, add the height of the overline
21794 (1 pixel) and a 1 pixel margin to the character height. */
21795 if (face
->overline_p
)
21796 it
->ascent
+= overline_margin
;
21798 take_vertical_position_into_account (it
);
21799 if (it
->ascent
< 0)
21801 if (it
->descent
< 0)
21805 append_composite_glyph (it
);
21807 else if (it
->what
== IT_COMPOSITION
)
21809 /* A dynamic (automatic) composition. */
21810 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21811 Lisp_Object gstring
;
21812 struct font_metrics metrics
;
21814 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
21816 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
21819 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
21820 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21821 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
21822 it
->descent
= it
->phys_descent
= metrics
.descent
;
21823 if (face
->box
!= FACE_NO_BOX
)
21825 int thick
= face
->box_line_width
;
21829 it
->ascent
+= thick
;
21830 it
->descent
+= thick
;
21835 if (it
->start_of_box_run_p
)
21836 it
->pixel_width
+= thick
;
21837 if (it
->end_of_box_run_p
)
21838 it
->pixel_width
+= thick
;
21840 /* If face has an overline, add the height of the overline
21841 (1 pixel) and a 1 pixel margin to the character height. */
21842 if (face
->overline_p
)
21843 it
->ascent
+= overline_margin
;
21844 take_vertical_position_into_account (it
);
21845 if (it
->ascent
< 0)
21847 if (it
->descent
< 0)
21851 append_composite_glyph (it
);
21853 else if (it
->what
== IT_IMAGE
)
21854 produce_image_glyph (it
);
21855 else if (it
->what
== IT_STRETCH
)
21856 produce_stretch_glyph (it
);
21858 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21859 because this isn't true for images with `:ascent 100'. */
21860 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21861 if (it
->area
== TEXT_AREA
)
21862 it
->current_x
+= it
->pixel_width
;
21864 if (extra_line_spacing
> 0)
21866 it
->descent
+= extra_line_spacing
;
21867 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21868 it
->max_extra_line_spacing
= extra_line_spacing
;
21871 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21872 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21873 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21874 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21878 Output LEN glyphs starting at START at the nominal cursor position.
21879 Advance the nominal cursor over the text. The global variable
21880 updated_window contains the window being updated, updated_row is
21881 the glyph row being updated, and updated_area is the area of that
21882 row being updated. */
21885 x_write_glyphs (start
, len
)
21886 struct glyph
*start
;
21891 xassert (updated_window
&& updated_row
);
21894 /* Write glyphs. */
21896 hpos
= start
- updated_row
->glyphs
[updated_area
];
21897 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21898 updated_row
, updated_area
,
21900 DRAW_NORMAL_TEXT
, 0);
21902 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21903 if (updated_area
== TEXT_AREA
21904 && updated_window
->phys_cursor_on_p
21905 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21906 && updated_window
->phys_cursor
.hpos
>= hpos
21907 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21908 updated_window
->phys_cursor_on_p
= 0;
21912 /* Advance the output cursor. */
21913 output_cursor
.hpos
+= len
;
21914 output_cursor
.x
= x
;
21919 Insert LEN glyphs from START at the nominal cursor position. */
21922 x_insert_glyphs (start
, len
)
21923 struct glyph
*start
;
21928 int line_height
, shift_by_width
, shifted_region_width
;
21929 struct glyph_row
*row
;
21930 struct glyph
*glyph
;
21931 int frame_x
, frame_y
;
21934 xassert (updated_window
&& updated_row
);
21936 w
= updated_window
;
21937 f
= XFRAME (WINDOW_FRAME (w
));
21939 /* Get the height of the line we are in. */
21941 line_height
= row
->height
;
21943 /* Get the width of the glyphs to insert. */
21944 shift_by_width
= 0;
21945 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21946 shift_by_width
+= glyph
->pixel_width
;
21948 /* Get the width of the region to shift right. */
21949 shifted_region_width
= (window_box_width (w
, updated_area
)
21954 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21955 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21957 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21958 line_height
, shift_by_width
);
21960 /* Write the glyphs. */
21961 hpos
= start
- row
->glyphs
[updated_area
];
21962 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21964 DRAW_NORMAL_TEXT
, 0);
21966 /* Advance the output cursor. */
21967 output_cursor
.hpos
+= len
;
21968 output_cursor
.x
+= shift_by_width
;
21974 Erase the current text line from the nominal cursor position
21975 (inclusive) to pixel column TO_X (exclusive). The idea is that
21976 everything from TO_X onward is already erased.
21978 TO_X is a pixel position relative to updated_area of
21979 updated_window. TO_X == -1 means clear to the end of this area. */
21982 x_clear_end_of_line (to_x
)
21986 struct window
*w
= updated_window
;
21987 int max_x
, min_y
, max_y
;
21988 int from_x
, from_y
, to_y
;
21990 xassert (updated_window
&& updated_row
);
21991 f
= XFRAME (w
->frame
);
21993 if (updated_row
->full_width_p
)
21994 max_x
= WINDOW_TOTAL_WIDTH (w
);
21996 max_x
= window_box_width (w
, updated_area
);
21997 max_y
= window_text_bottom_y (w
);
21999 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22000 of window. For TO_X > 0, truncate to end of drawing area. */
22006 to_x
= min (to_x
, max_x
);
22008 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22010 /* Notice if the cursor will be cleared by this operation. */
22011 if (!updated_row
->full_width_p
)
22012 notice_overwritten_cursor (w
, updated_area
,
22013 output_cursor
.x
, -1,
22015 MATRIX_ROW_BOTTOM_Y (updated_row
));
22017 from_x
= output_cursor
.x
;
22019 /* Translate to frame coordinates. */
22020 if (updated_row
->full_width_p
)
22022 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22023 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22027 int area_left
= window_box_left (w
, updated_area
);
22028 from_x
+= area_left
;
22032 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22033 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22034 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22036 /* Prevent inadvertently clearing to end of the X window. */
22037 if (to_x
> from_x
&& to_y
> from_y
)
22040 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22041 to_x
- from_x
, to_y
- from_y
);
22046 #endif /* HAVE_WINDOW_SYSTEM */
22050 /***********************************************************************
22052 ***********************************************************************/
22054 /* Value is the internal representation of the specified cursor type
22055 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22056 of the bar cursor. */
22058 static enum text_cursor_kinds
22059 get_specified_cursor_type (arg
, width
)
22063 enum text_cursor_kinds type
;
22068 if (EQ (arg
, Qbox
))
22069 return FILLED_BOX_CURSOR
;
22071 if (EQ (arg
, Qhollow
))
22072 return HOLLOW_BOX_CURSOR
;
22074 if (EQ (arg
, Qbar
))
22081 && EQ (XCAR (arg
), Qbar
)
22082 && INTEGERP (XCDR (arg
))
22083 && XINT (XCDR (arg
)) >= 0)
22085 *width
= XINT (XCDR (arg
));
22089 if (EQ (arg
, Qhbar
))
22092 return HBAR_CURSOR
;
22096 && EQ (XCAR (arg
), Qhbar
)
22097 && INTEGERP (XCDR (arg
))
22098 && XINT (XCDR (arg
)) >= 0)
22100 *width
= XINT (XCDR (arg
));
22101 return HBAR_CURSOR
;
22104 /* Treat anything unknown as "hollow box cursor".
22105 It was bad to signal an error; people have trouble fixing
22106 .Xdefaults with Emacs, when it has something bad in it. */
22107 type
= HOLLOW_BOX_CURSOR
;
22112 /* Set the default cursor types for specified frame. */
22114 set_frame_cursor_types (f
, arg
)
22121 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22122 FRAME_CURSOR_WIDTH (f
) = width
;
22124 /* By default, set up the blink-off state depending on the on-state. */
22126 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22129 FRAME_BLINK_OFF_CURSOR (f
)
22130 = get_specified_cursor_type (XCDR (tem
), &width
);
22131 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22134 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22138 /* Return the cursor we want to be displayed in window W. Return
22139 width of bar/hbar cursor through WIDTH arg. Return with
22140 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22141 (i.e. if the `system caret' should track this cursor).
22143 In a mini-buffer window, we want the cursor only to appear if we
22144 are reading input from this window. For the selected window, we
22145 want the cursor type given by the frame parameter or buffer local
22146 setting of cursor-type. If explicitly marked off, draw no cursor.
22147 In all other cases, we want a hollow box cursor. */
22149 static enum text_cursor_kinds
22150 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22152 struct glyph
*glyph
;
22154 int *active_cursor
;
22156 struct frame
*f
= XFRAME (w
->frame
);
22157 struct buffer
*b
= XBUFFER (w
->buffer
);
22158 int cursor_type
= DEFAULT_CURSOR
;
22159 Lisp_Object alt_cursor
;
22160 int non_selected
= 0;
22162 *active_cursor
= 1;
22165 if (cursor_in_echo_area
22166 && FRAME_HAS_MINIBUF_P (f
)
22167 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22169 if (w
== XWINDOW (echo_area_window
))
22171 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22173 *width
= FRAME_CURSOR_WIDTH (f
);
22174 return FRAME_DESIRED_CURSOR (f
);
22177 return get_specified_cursor_type (b
->cursor_type
, width
);
22180 *active_cursor
= 0;
22184 /* Detect a nonselected window or nonselected frame. */
22185 else if (w
!= XWINDOW (f
->selected_window
)
22186 #ifdef HAVE_WINDOW_SYSTEM
22187 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22191 *active_cursor
= 0;
22193 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22199 /* Never display a cursor in a window in which cursor-type is nil. */
22200 if (NILP (b
->cursor_type
))
22203 /* Get the normal cursor type for this window. */
22204 if (EQ (b
->cursor_type
, Qt
))
22206 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22207 *width
= FRAME_CURSOR_WIDTH (f
);
22210 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22212 /* Use cursor-in-non-selected-windows instead
22213 for non-selected window or frame. */
22216 alt_cursor
= b
->cursor_in_non_selected_windows
;
22217 if (!EQ (Qt
, alt_cursor
))
22218 return get_specified_cursor_type (alt_cursor
, width
);
22219 /* t means modify the normal cursor type. */
22220 if (cursor_type
== FILLED_BOX_CURSOR
)
22221 cursor_type
= HOLLOW_BOX_CURSOR
;
22222 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22224 return cursor_type
;
22227 /* Use normal cursor if not blinked off. */
22228 if (!w
->cursor_off_p
)
22230 #ifdef HAVE_WINDOW_SYSTEM
22231 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22233 if (cursor_type
== FILLED_BOX_CURSOR
)
22235 /* Using a block cursor on large images can be very annoying.
22236 So use a hollow cursor for "large" images.
22237 If image is not transparent (no mask), also use hollow cursor. */
22238 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22239 if (img
!= NULL
&& IMAGEP (img
->spec
))
22241 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22242 where N = size of default frame font size.
22243 This should cover most of the "tiny" icons people may use. */
22245 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22246 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22247 cursor_type
= HOLLOW_BOX_CURSOR
;
22250 else if (cursor_type
!= NO_CURSOR
)
22252 /* Display current only supports BOX and HOLLOW cursors for images.
22253 So for now, unconditionally use a HOLLOW cursor when cursor is
22254 not a solid box cursor. */
22255 cursor_type
= HOLLOW_BOX_CURSOR
;
22259 return cursor_type
;
22262 /* Cursor is blinked off, so determine how to "toggle" it. */
22264 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22265 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22266 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22268 /* Then see if frame has specified a specific blink off cursor type. */
22269 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22271 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22272 return FRAME_BLINK_OFF_CURSOR (f
);
22276 /* Some people liked having a permanently visible blinking cursor,
22277 while others had very strong opinions against it. So it was
22278 decided to remove it. KFS 2003-09-03 */
22280 /* Finally perform built-in cursor blinking:
22281 filled box <-> hollow box
22282 wide [h]bar <-> narrow [h]bar
22283 narrow [h]bar <-> no cursor
22284 other type <-> no cursor */
22286 if (cursor_type
== FILLED_BOX_CURSOR
)
22287 return HOLLOW_BOX_CURSOR
;
22289 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22292 return cursor_type
;
22300 #ifdef HAVE_WINDOW_SYSTEM
22302 /* Notice when the text cursor of window W has been completely
22303 overwritten by a drawing operation that outputs glyphs in AREA
22304 starting at X0 and ending at X1 in the line starting at Y0 and
22305 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22306 the rest of the line after X0 has been written. Y coordinates
22307 are window-relative. */
22310 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22312 enum glyph_row_area area
;
22313 int x0
, y0
, x1
, y1
;
22315 int cx0
, cx1
, cy0
, cy1
;
22316 struct glyph_row
*row
;
22318 if (!w
->phys_cursor_on_p
)
22320 if (area
!= TEXT_AREA
)
22323 if (w
->phys_cursor
.vpos
< 0
22324 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22325 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22326 !(row
->enabled_p
&& row
->displays_text_p
)))
22329 if (row
->cursor_in_fringe_p
)
22331 row
->cursor_in_fringe_p
= 0;
22332 draw_fringe_bitmap (w
, row
, 0);
22333 w
->phys_cursor_on_p
= 0;
22337 cx0
= w
->phys_cursor
.x
;
22338 cx1
= cx0
+ w
->phys_cursor_width
;
22339 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22342 /* The cursor image will be completely removed from the
22343 screen if the output area intersects the cursor area in
22344 y-direction. When we draw in [y0 y1[, and some part of
22345 the cursor is at y < y0, that part must have been drawn
22346 before. When scrolling, the cursor is erased before
22347 actually scrolling, so we don't come here. When not
22348 scrolling, the rows above the old cursor row must have
22349 changed, and in this case these rows must have written
22350 over the cursor image.
22352 Likewise if part of the cursor is below y1, with the
22353 exception of the cursor being in the first blank row at
22354 the buffer and window end because update_text_area
22355 doesn't draw that row. (Except when it does, but
22356 that's handled in update_text_area.) */
22358 cy0
= w
->phys_cursor
.y
;
22359 cy1
= cy0
+ w
->phys_cursor_height
;
22360 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22363 w
->phys_cursor_on_p
= 0;
22366 #endif /* HAVE_WINDOW_SYSTEM */
22369 /************************************************************************
22371 ************************************************************************/
22373 #ifdef HAVE_WINDOW_SYSTEM
22376 Fix the display of area AREA of overlapping row ROW in window W
22377 with respect to the overlapping part OVERLAPS. */
22380 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22382 struct glyph_row
*row
;
22383 enum glyph_row_area area
;
22391 for (i
= 0; i
< row
->used
[area
];)
22393 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22395 int start
= i
, start_x
= x
;
22399 x
+= row
->glyphs
[area
][i
].pixel_width
;
22402 while (i
< row
->used
[area
]
22403 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22405 draw_glyphs (w
, start_x
, row
, area
,
22407 DRAW_NORMAL_TEXT
, overlaps
);
22411 x
+= row
->glyphs
[area
][i
].pixel_width
;
22421 Draw the cursor glyph of window W in glyph row ROW. See the
22422 comment of draw_glyphs for the meaning of HL. */
22425 draw_phys_cursor_glyph (w
, row
, hl
)
22427 struct glyph_row
*row
;
22428 enum draw_glyphs_face hl
;
22430 /* If cursor hpos is out of bounds, don't draw garbage. This can
22431 happen in mini-buffer windows when switching between echo area
22432 glyphs and mini-buffer. */
22433 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22435 int on_p
= w
->phys_cursor_on_p
;
22437 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22438 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22440 w
->phys_cursor_on_p
= on_p
;
22442 if (hl
== DRAW_CURSOR
)
22443 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22444 /* When we erase the cursor, and ROW is overlapped by other
22445 rows, make sure that these overlapping parts of other rows
22447 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22449 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22451 if (row
> w
->current_matrix
->rows
22452 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22453 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22454 OVERLAPS_ERASED_CURSOR
);
22456 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22457 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22458 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22459 OVERLAPS_ERASED_CURSOR
);
22466 Erase the image of a cursor of window W from the screen. */
22469 erase_phys_cursor (w
)
22472 struct frame
*f
= XFRAME (w
->frame
);
22473 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22474 int hpos
= w
->phys_cursor
.hpos
;
22475 int vpos
= w
->phys_cursor
.vpos
;
22476 int mouse_face_here_p
= 0;
22477 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22478 struct glyph_row
*cursor_row
;
22479 struct glyph
*cursor_glyph
;
22480 enum draw_glyphs_face hl
;
22482 /* No cursor displayed or row invalidated => nothing to do on the
22484 if (w
->phys_cursor_type
== NO_CURSOR
)
22485 goto mark_cursor_off
;
22487 /* VPOS >= active_glyphs->nrows means that window has been resized.
22488 Don't bother to erase the cursor. */
22489 if (vpos
>= active_glyphs
->nrows
)
22490 goto mark_cursor_off
;
22492 /* If row containing cursor is marked invalid, there is nothing we
22494 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22495 if (!cursor_row
->enabled_p
)
22496 goto mark_cursor_off
;
22498 /* If line spacing is > 0, old cursor may only be partially visible in
22499 window after split-window. So adjust visible height. */
22500 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22501 window_text_bottom_y (w
) - cursor_row
->y
);
22503 /* If row is completely invisible, don't attempt to delete a cursor which
22504 isn't there. This can happen if cursor is at top of a window, and
22505 we switch to a buffer with a header line in that window. */
22506 if (cursor_row
->visible_height
<= 0)
22507 goto mark_cursor_off
;
22509 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22510 if (cursor_row
->cursor_in_fringe_p
)
22512 cursor_row
->cursor_in_fringe_p
= 0;
22513 draw_fringe_bitmap (w
, cursor_row
, 0);
22514 goto mark_cursor_off
;
22517 /* This can happen when the new row is shorter than the old one.
22518 In this case, either draw_glyphs or clear_end_of_line
22519 should have cleared the cursor. Note that we wouldn't be
22520 able to erase the cursor in this case because we don't have a
22521 cursor glyph at hand. */
22522 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22523 goto mark_cursor_off
;
22525 /* If the cursor is in the mouse face area, redisplay that when
22526 we clear the cursor. */
22527 if (! NILP (dpyinfo
->mouse_face_window
)
22528 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22529 && (vpos
> dpyinfo
->mouse_face_beg_row
22530 || (vpos
== dpyinfo
->mouse_face_beg_row
22531 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22532 && (vpos
< dpyinfo
->mouse_face_end_row
22533 || (vpos
== dpyinfo
->mouse_face_end_row
22534 && hpos
< dpyinfo
->mouse_face_end_col
))
22535 /* Don't redraw the cursor's spot in mouse face if it is at the
22536 end of a line (on a newline). The cursor appears there, but
22537 mouse highlighting does not. */
22538 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22539 mouse_face_here_p
= 1;
22541 /* Maybe clear the display under the cursor. */
22542 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22545 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22548 cursor_glyph
= get_phys_cursor_glyph (w
);
22549 if (cursor_glyph
== NULL
)
22550 goto mark_cursor_off
;
22552 width
= cursor_glyph
->pixel_width
;
22553 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22554 x
= w
->phys_cursor
.x
;
22556 width
-= left_x
- x
;
22557 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22558 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22559 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22562 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22565 /* Erase the cursor by redrawing the character underneath it. */
22566 if (mouse_face_here_p
)
22567 hl
= DRAW_MOUSE_FACE
;
22569 hl
= DRAW_NORMAL_TEXT
;
22570 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22573 w
->phys_cursor_on_p
= 0;
22574 w
->phys_cursor_type
= NO_CURSOR
;
22579 Display or clear cursor of window W. If ON is zero, clear the
22580 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22581 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22584 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22586 int on
, hpos
, vpos
, x
, y
;
22588 struct frame
*f
= XFRAME (w
->frame
);
22589 int new_cursor_type
;
22590 int new_cursor_width
;
22592 struct glyph_row
*glyph_row
;
22593 struct glyph
*glyph
;
22595 /* This is pointless on invisible frames, and dangerous on garbaged
22596 windows and frames; in the latter case, the frame or window may
22597 be in the midst of changing its size, and x and y may be off the
22599 if (! FRAME_VISIBLE_P (f
)
22600 || FRAME_GARBAGED_P (f
)
22601 || vpos
>= w
->current_matrix
->nrows
22602 || hpos
>= w
->current_matrix
->matrix_w
)
22605 /* If cursor is off and we want it off, return quickly. */
22606 if (!on
&& !w
->phys_cursor_on_p
)
22609 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22610 /* If cursor row is not enabled, we don't really know where to
22611 display the cursor. */
22612 if (!glyph_row
->enabled_p
)
22614 w
->phys_cursor_on_p
= 0;
22619 if (!glyph_row
->exact_window_width_line_p
22620 || hpos
< glyph_row
->used
[TEXT_AREA
])
22621 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22623 xassert (interrupt_input_blocked
);
22625 /* Set new_cursor_type to the cursor we want to be displayed. */
22626 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22627 &new_cursor_width
, &active_cursor
);
22629 /* If cursor is currently being shown and we don't want it to be or
22630 it is in the wrong place, or the cursor type is not what we want,
22632 if (w
->phys_cursor_on_p
22634 || w
->phys_cursor
.x
!= x
22635 || w
->phys_cursor
.y
!= y
22636 || new_cursor_type
!= w
->phys_cursor_type
22637 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22638 && new_cursor_width
!= w
->phys_cursor_width
)))
22639 erase_phys_cursor (w
);
22641 /* Don't check phys_cursor_on_p here because that flag is only set
22642 to zero in some cases where we know that the cursor has been
22643 completely erased, to avoid the extra work of erasing the cursor
22644 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22645 still not be visible, or it has only been partly erased. */
22648 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22649 w
->phys_cursor_height
= glyph_row
->height
;
22651 /* Set phys_cursor_.* before x_draw_.* is called because some
22652 of them may need the information. */
22653 w
->phys_cursor
.x
= x
;
22654 w
->phys_cursor
.y
= glyph_row
->y
;
22655 w
->phys_cursor
.hpos
= hpos
;
22656 w
->phys_cursor
.vpos
= vpos
;
22659 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22660 new_cursor_type
, new_cursor_width
,
22661 on
, active_cursor
);
22665 /* Switch the display of W's cursor on or off, according to the value
22672 update_window_cursor (w
, on
)
22676 /* Don't update cursor in windows whose frame is in the process
22677 of being deleted. */
22678 if (w
->current_matrix
)
22681 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22682 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22688 /* Call update_window_cursor with parameter ON_P on all leaf windows
22689 in the window tree rooted at W. */
22692 update_cursor_in_window_tree (w
, on_p
)
22698 if (!NILP (w
->hchild
))
22699 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22700 else if (!NILP (w
->vchild
))
22701 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22703 update_window_cursor (w
, on_p
);
22705 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22711 Display the cursor on window W, or clear it, according to ON_P.
22712 Don't change the cursor's position. */
22715 x_update_cursor (f
, on_p
)
22719 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22724 Clear the cursor of window W to background color, and mark the
22725 cursor as not shown. This is used when the text where the cursor
22726 is is about to be rewritten. */
22732 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22733 update_window_cursor (w
, 0);
22738 Display the active region described by mouse_face_* according to DRAW. */
22741 show_mouse_face (dpyinfo
, draw
)
22742 Display_Info
*dpyinfo
;
22743 enum draw_glyphs_face draw
;
22745 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22746 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22748 if (/* If window is in the process of being destroyed, don't bother
22750 w
->current_matrix
!= NULL
22751 /* Don't update mouse highlight if hidden */
22752 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22753 /* Recognize when we are called to operate on rows that don't exist
22754 anymore. This can happen when a window is split. */
22755 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22757 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22758 struct glyph_row
*row
, *first
, *last
;
22760 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22761 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22763 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22765 int start_hpos
, end_hpos
, start_x
;
22767 /* For all but the first row, the highlight starts at column 0. */
22770 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22771 start_x
= dpyinfo
->mouse_face_beg_x
;
22780 end_hpos
= dpyinfo
->mouse_face_end_col
;
22783 end_hpos
= row
->used
[TEXT_AREA
];
22784 if (draw
== DRAW_NORMAL_TEXT
)
22785 row
->fill_line_p
= 1; /* Clear to end of line */
22788 if (end_hpos
> start_hpos
)
22790 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22791 start_hpos
, end_hpos
,
22795 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22799 /* When we've written over the cursor, arrange for it to
22800 be displayed again. */
22801 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22804 display_and_set_cursor (w
, 1,
22805 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22806 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22811 /* Change the mouse cursor. */
22812 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22813 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22814 else if (draw
== DRAW_MOUSE_FACE
)
22815 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22817 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22821 Clear out the mouse-highlighted active region.
22822 Redraw it un-highlighted first. Value is non-zero if mouse
22823 face was actually drawn unhighlighted. */
22826 clear_mouse_face (dpyinfo
)
22827 Display_Info
*dpyinfo
;
22831 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22833 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22837 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22838 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22839 dpyinfo
->mouse_face_window
= Qnil
;
22840 dpyinfo
->mouse_face_overlay
= Qnil
;
22846 Non-zero if physical cursor of window W is within mouse face. */
22849 cursor_in_mouse_face_p (w
)
22852 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22853 int in_mouse_face
= 0;
22855 if (WINDOWP (dpyinfo
->mouse_face_window
)
22856 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22858 int hpos
= w
->phys_cursor
.hpos
;
22859 int vpos
= w
->phys_cursor
.vpos
;
22861 if (vpos
>= dpyinfo
->mouse_face_beg_row
22862 && vpos
<= dpyinfo
->mouse_face_end_row
22863 && (vpos
> dpyinfo
->mouse_face_beg_row
22864 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22865 && (vpos
< dpyinfo
->mouse_face_end_row
22866 || hpos
< dpyinfo
->mouse_face_end_col
22867 || dpyinfo
->mouse_face_past_end
))
22871 return in_mouse_face
;
22877 /* Find the glyph matrix position of buffer position CHARPOS in window
22878 *W. HPOS, *VPOS, *X, and *Y are set to the positions found. W's
22879 current glyphs must be up to date. If CHARPOS is above window
22880 start return (0, 0, 0, 0). If CHARPOS is after end of W, return end
22881 of last line in W. In the row containing CHARPOS, stop before glyphs
22882 having STOP as object. */
22884 #if 1 /* This is a version of fast_find_position that's more correct
22885 in the presence of hscrolling, for example. I didn't install
22886 it right away because the problem fixed is minor, it failed
22887 in 20.x as well, and I think it's too risky to install
22888 so near the release of 21.1. 2001-09-25 gerd. */
22892 fast_find_position (w
, charpos
, hpos
, vpos
, x
, y
, stop
)
22895 int *hpos
, *vpos
, *x
, *y
;
22898 struct glyph_row
*row
, *first
;
22899 struct glyph
*glyph
, *end
;
22902 first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22903 if (charpos
< MATRIX_ROW_START_CHARPOS (first
))
22908 *vpos
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22912 row
= row_containing_pos (w
, charpos
, first
, NULL
, 0);
22915 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22919 /* If whole rows or last part of a row came from a display overlay,
22920 row_containing_pos will skip over such rows because their end pos
22921 equals the start pos of the overlay or interval.
22923 Move back if we have a STOP object and previous row's
22924 end glyph came from STOP. */
22927 struct glyph_row
*prev
;
22928 while ((prev
= row
- 1, prev
>= first
)
22929 && MATRIX_ROW_END_CHARPOS (prev
) == charpos
22930 && prev
->used
[TEXT_AREA
] > 0)
22932 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22933 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22934 while (--glyph
>= beg
22935 && INTEGERP (glyph
->object
));
22937 || !EQ (stop
, glyph
->object
))
22945 *vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22947 glyph
= row
->glyphs
[TEXT_AREA
];
22948 end
= glyph
+ row
->used
[TEXT_AREA
];
22950 /* Skip over glyphs not having an object at the start of the row.
22951 These are special glyphs like truncation marks on terminal
22953 if (row
->displays_text_p
)
22955 && INTEGERP (glyph
->object
)
22956 && !EQ (stop
, glyph
->object
)
22957 && glyph
->charpos
< 0)
22959 *x
+= glyph
->pixel_width
;
22964 && !INTEGERP (glyph
->object
)
22965 && !EQ (stop
, glyph
->object
)
22966 && (!BUFFERP (glyph
->object
)
22967 || glyph
->charpos
< charpos
))
22969 *x
+= glyph
->pixel_width
;
22973 *hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
22980 fast_find_position (w
, pos
, hpos
, vpos
, x
, y
, stop
)
22983 int *hpos
, *vpos
, *x
, *y
;
22988 int maybe_next_line_p
= 0;
22989 int line_start_position
;
22990 int yb
= window_text_bottom_y (w
);
22991 struct glyph_row
*row
, *best_row
;
22992 int row_vpos
, best_row_vpos
;
22995 row
= best_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22996 row_vpos
= best_row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22998 while (row
->y
< yb
)
23000 if (row
->used
[TEXT_AREA
])
23001 line_start_position
= row
->glyphs
[TEXT_AREA
]->charpos
;
23003 line_start_position
= 0;
23005 if (line_start_position
> pos
)
23007 /* If the position sought is the end of the buffer,
23008 don't include the blank lines at the bottom of the window. */
23009 else if (line_start_position
== pos
23010 && pos
== BUF_ZV (XBUFFER (w
->buffer
)))
23012 maybe_next_line_p
= 1;
23015 else if (line_start_position
> 0)
23018 best_row_vpos
= row_vpos
;
23021 if (row
->y
+ row
->height
>= yb
)
23028 /* Find the right column within BEST_ROW. */
23030 current_x
= best_row
->x
;
23031 for (i
= 0; i
< best_row
->used
[TEXT_AREA
]; i
++)
23033 struct glyph
*glyph
= best_row
->glyphs
[TEXT_AREA
] + i
;
23034 int charpos
= glyph
->charpos
;
23036 if (BUFFERP (glyph
->object
))
23038 if (charpos
== pos
)
23041 *vpos
= best_row_vpos
;
23046 else if (charpos
> pos
)
23049 else if (EQ (glyph
->object
, stop
))
23054 current_x
+= glyph
->pixel_width
;
23057 /* If we're looking for the end of the buffer,
23058 and we didn't find it in the line we scanned,
23059 use the start of the following line. */
23060 if (maybe_next_line_p
)
23065 current_x
= best_row
->x
;
23068 *vpos
= best_row_vpos
;
23069 *hpos
= lastcol
+ 1;
23078 /* Find the position of the glyph for position POS in OBJECT in
23079 window W's current matrix, and return in *X, *Y the pixel
23080 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23082 RIGHT_P non-zero means return the position of the right edge of the
23083 glyph, RIGHT_P zero means return the left edge position.
23085 If no glyph for POS exists in the matrix, return the position of
23086 the glyph with the next smaller position that is in the matrix, if
23087 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23088 exists in the matrix, return the position of the glyph with the
23089 next larger position in OBJECT.
23091 Value is non-zero if a glyph was found. */
23094 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23097 Lisp_Object object
;
23098 int *hpos
, *vpos
, *x
, *y
;
23101 int yb
= window_text_bottom_y (w
);
23102 struct glyph_row
*r
;
23103 struct glyph
*best_glyph
= NULL
;
23104 struct glyph_row
*best_row
= NULL
;
23107 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23108 r
->enabled_p
&& r
->y
< yb
;
23111 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23112 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23115 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23116 if (EQ (g
->object
, object
))
23118 if (g
->charpos
== pos
)
23125 else if (best_glyph
== NULL
23126 || ((eabs (g
->charpos
- pos
)
23127 < eabs (best_glyph
->charpos
- pos
))
23130 : g
->charpos
> pos
)))
23144 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23148 *x
+= best_glyph
->pixel_width
;
23153 *vpos
= best_row
- w
->current_matrix
->rows
;
23156 return best_glyph
!= NULL
;
23160 /* See if position X, Y is within a hot-spot of an image. */
23163 on_hot_spot_p (hot_spot
, x
, y
)
23164 Lisp_Object hot_spot
;
23167 if (!CONSP (hot_spot
))
23170 if (EQ (XCAR (hot_spot
), Qrect
))
23172 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23173 Lisp_Object rect
= XCDR (hot_spot
);
23177 if (!CONSP (XCAR (rect
)))
23179 if (!CONSP (XCDR (rect
)))
23181 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23183 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23185 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23187 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23191 else if (EQ (XCAR (hot_spot
), Qcircle
))
23193 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23194 Lisp_Object circ
= XCDR (hot_spot
);
23195 Lisp_Object lr
, lx0
, ly0
;
23197 && CONSP (XCAR (circ
))
23198 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23199 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23200 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23202 double r
= XFLOATINT (lr
);
23203 double dx
= XINT (lx0
) - x
;
23204 double dy
= XINT (ly0
) - y
;
23205 return (dx
* dx
+ dy
* dy
<= r
* r
);
23208 else if (EQ (XCAR (hot_spot
), Qpoly
))
23210 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23211 if (VECTORP (XCDR (hot_spot
)))
23213 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23214 Lisp_Object
*poly
= v
->contents
;
23218 Lisp_Object lx
, ly
;
23221 /* Need an even number of coordinates, and at least 3 edges. */
23222 if (n
< 6 || n
& 1)
23225 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23226 If count is odd, we are inside polygon. Pixels on edges
23227 may or may not be included depending on actual geometry of the
23229 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23230 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23232 x0
= XINT (lx
), y0
= XINT (ly
);
23233 for (i
= 0; i
< n
; i
+= 2)
23235 int x1
= x0
, y1
= y0
;
23236 if ((lx
= poly
[i
], !INTEGERP (lx
))
23237 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23239 x0
= XINT (lx
), y0
= XINT (ly
);
23241 /* Does this segment cross the X line? */
23249 if (y
> y0
&& y
> y1
)
23251 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23261 find_hot_spot (map
, x
, y
)
23265 while (CONSP (map
))
23267 if (CONSP (XCAR (map
))
23268 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23276 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23278 doc
: /* Lookup in image map MAP coordinates X and Y.
23279 An image map is an alist where each element has the format (AREA ID PLIST).
23280 An AREA is specified as either a rectangle, a circle, or a polygon:
23281 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23282 pixel coordinates of the upper left and bottom right corners.
23283 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23284 and the radius of the circle; r may be a float or integer.
23285 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23286 vector describes one corner in the polygon.
23287 Returns the alist element for the first matching AREA in MAP. */)
23298 return find_hot_spot (map
, XINT (x
), XINT (y
));
23302 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23304 define_frame_cursor1 (f
, cursor
, pointer
)
23307 Lisp_Object pointer
;
23309 /* Do not change cursor shape while dragging mouse. */
23310 if (!NILP (do_mouse_tracking
))
23313 if (!NILP (pointer
))
23315 if (EQ (pointer
, Qarrow
))
23316 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23317 else if (EQ (pointer
, Qhand
))
23318 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23319 else if (EQ (pointer
, Qtext
))
23320 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23321 else if (EQ (pointer
, intern ("hdrag")))
23322 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23323 #ifdef HAVE_X_WINDOWS
23324 else if (EQ (pointer
, intern ("vdrag")))
23325 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23327 else if (EQ (pointer
, intern ("hourglass")))
23328 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23329 else if (EQ (pointer
, Qmodeline
))
23330 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23332 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23335 if (cursor
!= No_Cursor
)
23336 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23339 /* Take proper action when mouse has moved to the mode or header line
23340 or marginal area AREA of window W, x-position X and y-position Y.
23341 X is relative to the start of the text display area of W, so the
23342 width of bitmap areas and scroll bars must be subtracted to get a
23343 position relative to the start of the mode line. */
23346 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23347 Lisp_Object window
;
23349 enum window_part area
;
23351 struct window
*w
= XWINDOW (window
);
23352 struct frame
*f
= XFRAME (w
->frame
);
23353 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23354 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23355 Lisp_Object pointer
= Qnil
;
23356 int charpos
, dx
, dy
, width
, height
;
23357 Lisp_Object string
, object
= Qnil
;
23358 Lisp_Object pos
, help
;
23360 Lisp_Object mouse_face
;
23361 int original_x_pixel
= x
;
23362 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23363 struct glyph_row
*row
;
23365 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23370 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23371 &object
, &dx
, &dy
, &width
, &height
);
23373 row
= (area
== ON_MODE_LINE
23374 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23375 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23378 if (row
->mode_line_p
&& row
->enabled_p
)
23380 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23381 end
= glyph
+ row
->used
[TEXT_AREA
];
23383 for (x0
= original_x_pixel
;
23384 glyph
< end
&& x0
>= glyph
->pixel_width
;
23386 x0
-= glyph
->pixel_width
;
23394 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23395 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23396 &object
, &dx
, &dy
, &width
, &height
);
23401 if (IMAGEP (object
))
23403 Lisp_Object image_map
, hotspot
;
23404 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23406 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23408 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23410 Lisp_Object area_id
, plist
;
23412 area_id
= XCAR (hotspot
);
23413 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23414 If so, we could look for mouse-enter, mouse-leave
23415 properties in PLIST (and do something...). */
23416 hotspot
= XCDR (hotspot
);
23417 if (CONSP (hotspot
)
23418 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23420 pointer
= Fplist_get (plist
, Qpointer
);
23421 if (NILP (pointer
))
23423 help
= Fplist_get (plist
, Qhelp_echo
);
23426 help_echo_string
= help
;
23427 /* Is this correct? ++kfs */
23428 XSETWINDOW (help_echo_window
, w
);
23429 help_echo_object
= w
->buffer
;
23430 help_echo_pos
= charpos
;
23434 if (NILP (pointer
))
23435 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23438 if (STRINGP (string
))
23440 pos
= make_number (charpos
);
23441 /* If we're on a string with `help-echo' text property, arrange
23442 for the help to be displayed. This is done by setting the
23443 global variable help_echo_string to the help string. */
23446 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23449 help_echo_string
= help
;
23450 XSETWINDOW (help_echo_window
, w
);
23451 help_echo_object
= string
;
23452 help_echo_pos
= charpos
;
23456 if (NILP (pointer
))
23457 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23459 /* Change the mouse pointer according to what is under X/Y. */
23460 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23463 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23464 if (!KEYMAPP (map
))
23465 map
= Fget_text_property (pos
, Qkeymap
, string
);
23466 if (!KEYMAPP (map
))
23467 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23470 /* Change the mouse face according to what is under X/Y. */
23471 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23472 if (!NILP (mouse_face
)
23473 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23478 struct glyph
* tmp_glyph
;
23482 int total_pixel_width
;
23487 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23488 Qmouse_face
, string
, Qnil
);
23490 b
= make_number (0);
23492 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23494 e
= make_number (SCHARS (string
));
23496 /* Calculate the position(glyph position: GPOS) of GLYPH in
23497 displayed string. GPOS is different from CHARPOS.
23499 CHARPOS is the position of glyph in internal string
23500 object. A mode line string format has structures which
23501 is converted to a flatten by emacs lisp interpreter.
23502 The internal string is an element of the structures.
23503 The displayed string is the flatten string. */
23505 if (glyph
> row_start_glyph
)
23507 tmp_glyph
= glyph
- 1;
23508 while (tmp_glyph
>= row_start_glyph
23509 && tmp_glyph
->charpos
>= XINT (b
)
23510 && EQ (tmp_glyph
->object
, glyph
->object
))
23517 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23518 displayed string holding GLYPH.
23520 GSEQ_LENGTH is different from SCHARS (STRING).
23521 SCHARS (STRING) returns the length of the internal string. */
23522 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23523 tmp_glyph
->charpos
< XINT (e
);
23524 tmp_glyph
++, gseq_length
++)
23526 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23530 total_pixel_width
= 0;
23531 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23532 total_pixel_width
+= tmp_glyph
->pixel_width
;
23534 /* Pre calculation of re-rendering position */
23536 hpos
= (area
== ON_MODE_LINE
23537 ? (w
->current_matrix
)->nrows
- 1
23540 /* If the re-rendering position is included in the last
23541 re-rendering area, we should do nothing. */
23542 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23543 && dpyinfo
->mouse_face_beg_col
<= vpos
23544 && vpos
< dpyinfo
->mouse_face_end_col
23545 && dpyinfo
->mouse_face_beg_row
== hpos
)
23548 if (clear_mouse_face (dpyinfo
))
23549 cursor
= No_Cursor
;
23551 dpyinfo
->mouse_face_beg_col
= vpos
;
23552 dpyinfo
->mouse_face_beg_row
= hpos
;
23554 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23555 dpyinfo
->mouse_face_beg_y
= 0;
23557 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23558 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23560 dpyinfo
->mouse_face_end_x
= 0;
23561 dpyinfo
->mouse_face_end_y
= 0;
23563 dpyinfo
->mouse_face_past_end
= 0;
23564 dpyinfo
->mouse_face_window
= window
;
23566 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23569 glyph
->face_id
, 1);
23570 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23572 if (NILP (pointer
))
23575 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23576 clear_mouse_face (dpyinfo
);
23578 define_frame_cursor1 (f
, cursor
, pointer
);
23583 Take proper action when the mouse has moved to position X, Y on
23584 frame F as regards highlighting characters that have mouse-face
23585 properties. Also de-highlighting chars where the mouse was before.
23586 X and Y can be negative or out of range. */
23589 note_mouse_highlight (f
, x
, y
)
23593 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23594 enum window_part part
;
23595 Lisp_Object window
;
23597 Cursor cursor
= No_Cursor
;
23598 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23601 /* When a menu is active, don't highlight because this looks odd. */
23602 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
23603 if (popup_activated ())
23607 if (NILP (Vmouse_highlight
)
23608 || !f
->glyphs_initialized_p
)
23611 dpyinfo
->mouse_face_mouse_x
= x
;
23612 dpyinfo
->mouse_face_mouse_y
= y
;
23613 dpyinfo
->mouse_face_mouse_frame
= f
;
23615 if (dpyinfo
->mouse_face_defer
)
23618 if (gc_in_progress
)
23620 dpyinfo
->mouse_face_deferred_gc
= 1;
23624 /* Which window is that in? */
23625 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23627 /* If we were displaying active text in another window, clear that.
23628 Also clear if we move out of text area in same window. */
23629 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23630 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23631 && !NILP (dpyinfo
->mouse_face_window
)))
23632 clear_mouse_face (dpyinfo
);
23634 /* Not on a window -> return. */
23635 if (!WINDOWP (window
))
23638 /* Reset help_echo_string. It will get recomputed below. */
23639 help_echo_string
= Qnil
;
23641 /* Convert to window-relative pixel coordinates. */
23642 w
= XWINDOW (window
);
23643 frame_to_window_pixel_xy (w
, &x
, &y
);
23645 /* Handle tool-bar window differently since it doesn't display a
23647 if (EQ (window
, f
->tool_bar_window
))
23649 note_tool_bar_highlight (f
, x
, y
);
23653 /* Mouse is on the mode, header line or margin? */
23654 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23655 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23657 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23661 if (part
== ON_VERTICAL_BORDER
)
23663 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23664 help_echo_string
= build_string ("drag-mouse-1: resize");
23666 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23667 || part
== ON_SCROLL_BAR
)
23668 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23670 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23672 /* Are we in a window whose display is up to date?
23673 And verify the buffer's text has not changed. */
23674 b
= XBUFFER (w
->buffer
);
23675 if (part
== ON_TEXT
23676 && EQ (w
->window_end_valid
, w
->buffer
)
23677 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23678 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23680 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23681 struct glyph
*glyph
;
23682 Lisp_Object object
;
23683 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23684 Lisp_Object
*overlay_vec
= NULL
;
23686 struct buffer
*obuf
;
23687 int obegv
, ozv
, same_region
;
23689 /* Find the glyph under X/Y. */
23690 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23692 /* Look for :pointer property on image. */
23693 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23695 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23696 if (img
!= NULL
&& IMAGEP (img
->spec
))
23698 Lisp_Object image_map
, hotspot
;
23699 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23701 && (hotspot
= find_hot_spot (image_map
,
23702 glyph
->slice
.x
+ dx
,
23703 glyph
->slice
.y
+ dy
),
23705 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23707 Lisp_Object area_id
, plist
;
23709 area_id
= XCAR (hotspot
);
23710 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23711 If so, we could look for mouse-enter, mouse-leave
23712 properties in PLIST (and do something...). */
23713 hotspot
= XCDR (hotspot
);
23714 if (CONSP (hotspot
)
23715 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23717 pointer
= Fplist_get (plist
, Qpointer
);
23718 if (NILP (pointer
))
23720 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23721 if (!NILP (help_echo_string
))
23723 help_echo_window
= window
;
23724 help_echo_object
= glyph
->object
;
23725 help_echo_pos
= glyph
->charpos
;
23729 if (NILP (pointer
))
23730 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23734 /* Clear mouse face if X/Y not over text. */
23736 || area
!= TEXT_AREA
23737 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23739 if (clear_mouse_face (dpyinfo
))
23740 cursor
= No_Cursor
;
23741 if (NILP (pointer
))
23743 if (area
!= TEXT_AREA
)
23744 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23746 pointer
= Vvoid_text_area_pointer
;
23751 pos
= glyph
->charpos
;
23752 object
= glyph
->object
;
23753 if (!STRINGP (object
) && !BUFFERP (object
))
23756 /* If we get an out-of-range value, return now; avoid an error. */
23757 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23760 /* Make the window's buffer temporarily current for
23761 overlays_at and compute_char_face. */
23762 obuf
= current_buffer
;
23763 current_buffer
= b
;
23769 /* Is this char mouse-active or does it have help-echo? */
23770 position
= make_number (pos
);
23772 if (BUFFERP (object
))
23774 /* Put all the overlays we want in a vector in overlay_vec. */
23775 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23776 /* Sort overlays into increasing priority order. */
23777 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23782 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23783 && vpos
>= dpyinfo
->mouse_face_beg_row
23784 && vpos
<= dpyinfo
->mouse_face_end_row
23785 && (vpos
> dpyinfo
->mouse_face_beg_row
23786 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23787 && (vpos
< dpyinfo
->mouse_face_end_row
23788 || hpos
< dpyinfo
->mouse_face_end_col
23789 || dpyinfo
->mouse_face_past_end
));
23792 cursor
= No_Cursor
;
23794 /* Check mouse-face highlighting. */
23796 /* If there exists an overlay with mouse-face overlapping
23797 the one we are currently highlighting, we have to
23798 check if we enter the overlapping overlay, and then
23799 highlight only that. */
23800 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23801 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23803 /* Find the highest priority overlay that has a mouse-face
23806 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23808 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23809 if (!NILP (mouse_face
))
23810 overlay
= overlay_vec
[i
];
23813 /* If we're actually highlighting the same overlay as
23814 before, there's no need to do that again. */
23815 if (!NILP (overlay
)
23816 && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23817 goto check_help_echo
;
23819 dpyinfo
->mouse_face_overlay
= overlay
;
23821 /* Clear the display of the old active region, if any. */
23822 if (clear_mouse_face (dpyinfo
))
23823 cursor
= No_Cursor
;
23825 /* If no overlay applies, get a text property. */
23826 if (NILP (overlay
))
23827 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23829 /* Handle the overlay case. */
23830 if (!NILP (overlay
))
23832 /* Find the range of text around this char that
23833 should be active. */
23834 Lisp_Object before
, after
;
23837 before
= Foverlay_start (overlay
);
23838 after
= Foverlay_end (overlay
);
23839 /* Record this as the current active region. */
23840 fast_find_position (w
, XFASTINT (before
),
23841 &dpyinfo
->mouse_face_beg_col
,
23842 &dpyinfo
->mouse_face_beg_row
,
23843 &dpyinfo
->mouse_face_beg_x
,
23844 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23846 dpyinfo
->mouse_face_past_end
23847 = !fast_find_position (w
, XFASTINT (after
),
23848 &dpyinfo
->mouse_face_end_col
,
23849 &dpyinfo
->mouse_face_end_row
,
23850 &dpyinfo
->mouse_face_end_x
,
23851 &dpyinfo
->mouse_face_end_y
, Qnil
);
23852 dpyinfo
->mouse_face_window
= window
;
23854 dpyinfo
->mouse_face_face_id
23855 = face_at_buffer_position (w
, pos
, 0, 0,
23857 !dpyinfo
->mouse_face_hidden
);
23859 /* Display it as active. */
23860 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23861 cursor
= No_Cursor
;
23863 /* Handle the text property case. */
23864 else if (!NILP (mouse_face
) && BUFFERP (object
))
23866 /* Find the range of text around this char that
23867 should be active. */
23868 Lisp_Object before
, after
, beginning
, end
;
23871 beginning
= Fmarker_position (w
->start
);
23872 end
= make_number (BUF_Z (XBUFFER (object
))
23873 - XFASTINT (w
->window_end_pos
));
23875 = Fprevious_single_property_change (make_number (pos
+ 1),
23877 object
, beginning
);
23879 = Fnext_single_property_change (position
, Qmouse_face
,
23882 /* Record this as the current active region. */
23883 fast_find_position (w
, XFASTINT (before
),
23884 &dpyinfo
->mouse_face_beg_col
,
23885 &dpyinfo
->mouse_face_beg_row
,
23886 &dpyinfo
->mouse_face_beg_x
,
23887 &dpyinfo
->mouse_face_beg_y
, Qnil
);
23888 dpyinfo
->mouse_face_past_end
23889 = !fast_find_position (w
, XFASTINT (after
),
23890 &dpyinfo
->mouse_face_end_col
,
23891 &dpyinfo
->mouse_face_end_row
,
23892 &dpyinfo
->mouse_face_end_x
,
23893 &dpyinfo
->mouse_face_end_y
, Qnil
);
23894 dpyinfo
->mouse_face_window
= window
;
23896 if (BUFFERP (object
))
23897 dpyinfo
->mouse_face_face_id
23898 = face_at_buffer_position (w
, pos
, 0, 0,
23900 !dpyinfo
->mouse_face_hidden
);
23902 /* Display it as active. */
23903 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23904 cursor
= No_Cursor
;
23906 else if (!NILP (mouse_face
) && STRINGP (object
))
23911 b
= Fprevious_single_property_change (make_number (pos
+ 1),
23914 e
= Fnext_single_property_change (position
, Qmouse_face
,
23917 b
= make_number (0);
23919 e
= make_number (SCHARS (object
) - 1);
23921 fast_find_string_pos (w
, XINT (b
), object
,
23922 &dpyinfo
->mouse_face_beg_col
,
23923 &dpyinfo
->mouse_face_beg_row
,
23924 &dpyinfo
->mouse_face_beg_x
,
23925 &dpyinfo
->mouse_face_beg_y
, 0);
23926 fast_find_string_pos (w
, XINT (e
), object
,
23927 &dpyinfo
->mouse_face_end_col
,
23928 &dpyinfo
->mouse_face_end_row
,
23929 &dpyinfo
->mouse_face_end_x
,
23930 &dpyinfo
->mouse_face_end_y
, 1);
23931 dpyinfo
->mouse_face_past_end
= 0;
23932 dpyinfo
->mouse_face_window
= window
;
23933 dpyinfo
->mouse_face_face_id
23934 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23935 glyph
->face_id
, 1);
23936 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23937 cursor
= No_Cursor
;
23939 else if (STRINGP (object
) && NILP (mouse_face
))
23941 /* A string which doesn't have mouse-face, but
23942 the text ``under'' it might have. */
23943 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23944 int start
= MATRIX_ROW_START_CHARPOS (r
);
23946 pos
= string_buffer_position (w
, object
, start
);
23948 mouse_face
= get_char_property_and_overlay (make_number (pos
),
23952 if (!NILP (mouse_face
) && !NILP (overlay
))
23954 Lisp_Object before
= Foverlay_start (overlay
);
23955 Lisp_Object after
= Foverlay_end (overlay
);
23958 /* Note that we might not be able to find position
23959 BEFORE in the glyph matrix if the overlay is
23960 entirely covered by a `display' property. In
23961 this case, we overshoot. So let's stop in
23962 the glyph matrix before glyphs for OBJECT. */
23963 fast_find_position (w
, XFASTINT (before
),
23964 &dpyinfo
->mouse_face_beg_col
,
23965 &dpyinfo
->mouse_face_beg_row
,
23966 &dpyinfo
->mouse_face_beg_x
,
23967 &dpyinfo
->mouse_face_beg_y
,
23970 dpyinfo
->mouse_face_past_end
23971 = !fast_find_position (w
, XFASTINT (after
),
23972 &dpyinfo
->mouse_face_end_col
,
23973 &dpyinfo
->mouse_face_end_row
,
23974 &dpyinfo
->mouse_face_end_x
,
23975 &dpyinfo
->mouse_face_end_y
,
23977 dpyinfo
->mouse_face_window
= window
;
23978 dpyinfo
->mouse_face_face_id
23979 = face_at_buffer_position (w
, pos
, 0, 0,
23981 !dpyinfo
->mouse_face_hidden
);
23983 /* Display it as active. */
23984 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23985 cursor
= No_Cursor
;
23992 /* Look for a `help-echo' property. */
23993 if (NILP (help_echo_string
)) {
23994 Lisp_Object help
, overlay
;
23996 /* Check overlays first. */
23997 help
= overlay
= Qnil
;
23998 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24000 overlay
= overlay_vec
[i
];
24001 help
= Foverlay_get (overlay
, Qhelp_echo
);
24006 help_echo_string
= help
;
24007 help_echo_window
= window
;
24008 help_echo_object
= overlay
;
24009 help_echo_pos
= pos
;
24013 Lisp_Object object
= glyph
->object
;
24014 int charpos
= glyph
->charpos
;
24016 /* Try text properties. */
24017 if (STRINGP (object
)
24019 && charpos
< SCHARS (object
))
24021 help
= Fget_text_property (make_number (charpos
),
24022 Qhelp_echo
, object
);
24025 /* If the string itself doesn't specify a help-echo,
24026 see if the buffer text ``under'' it does. */
24027 struct glyph_row
*r
24028 = MATRIX_ROW (w
->current_matrix
, vpos
);
24029 int start
= MATRIX_ROW_START_CHARPOS (r
);
24030 int pos
= string_buffer_position (w
, object
, start
);
24033 help
= Fget_char_property (make_number (pos
),
24034 Qhelp_echo
, w
->buffer
);
24038 object
= w
->buffer
;
24043 else if (BUFFERP (object
)
24046 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24051 help_echo_string
= help
;
24052 help_echo_window
= window
;
24053 help_echo_object
= object
;
24054 help_echo_pos
= charpos
;
24059 /* Look for a `pointer' property. */
24060 if (NILP (pointer
))
24062 /* Check overlays first. */
24063 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24064 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24066 if (NILP (pointer
))
24068 Lisp_Object object
= glyph
->object
;
24069 int charpos
= glyph
->charpos
;
24071 /* Try text properties. */
24072 if (STRINGP (object
)
24074 && charpos
< SCHARS (object
))
24076 pointer
= Fget_text_property (make_number (charpos
),
24078 if (NILP (pointer
))
24080 /* If the string itself doesn't specify a pointer,
24081 see if the buffer text ``under'' it does. */
24082 struct glyph_row
*r
24083 = MATRIX_ROW (w
->current_matrix
, vpos
);
24084 int start
= MATRIX_ROW_START_CHARPOS (r
);
24085 int pos
= string_buffer_position (w
, object
, start
);
24087 pointer
= Fget_char_property (make_number (pos
),
24088 Qpointer
, w
->buffer
);
24091 else if (BUFFERP (object
)
24094 pointer
= Fget_text_property (make_number (charpos
),
24101 current_buffer
= obuf
;
24106 define_frame_cursor1 (f
, cursor
, pointer
);
24111 Clear any mouse-face on window W. This function is part of the
24112 redisplay interface, and is called from try_window_id and similar
24113 functions to ensure the mouse-highlight is off. */
24116 x_clear_window_mouse_face (w
)
24119 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24120 Lisp_Object window
;
24123 XSETWINDOW (window
, w
);
24124 if (EQ (window
, dpyinfo
->mouse_face_window
))
24125 clear_mouse_face (dpyinfo
);
24131 Just discard the mouse face information for frame F, if any.
24132 This is used when the size of F is changed. */
24135 cancel_mouse_face (f
)
24138 Lisp_Object window
;
24139 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24141 window
= dpyinfo
->mouse_face_window
;
24142 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24144 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24145 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24146 dpyinfo
->mouse_face_window
= Qnil
;
24151 #endif /* HAVE_WINDOW_SYSTEM */
24154 /***********************************************************************
24156 ***********************************************************************/
24158 #ifdef HAVE_WINDOW_SYSTEM
24160 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24161 which intersects rectangle R. R is in window-relative coordinates. */
24164 expose_area (w
, row
, r
, area
)
24166 struct glyph_row
*row
;
24168 enum glyph_row_area area
;
24170 struct glyph
*first
= row
->glyphs
[area
];
24171 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24172 struct glyph
*last
;
24173 int first_x
, start_x
, x
;
24175 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24176 /* If row extends face to end of line write the whole line. */
24177 draw_glyphs (w
, 0, row
, area
,
24178 0, row
->used
[area
],
24179 DRAW_NORMAL_TEXT
, 0);
24182 /* Set START_X to the window-relative start position for drawing glyphs of
24183 AREA. The first glyph of the text area can be partially visible.
24184 The first glyphs of other areas cannot. */
24185 start_x
= window_box_left_offset (w
, area
);
24187 if (area
== TEXT_AREA
)
24190 /* Find the first glyph that must be redrawn. */
24192 && x
+ first
->pixel_width
< r
->x
)
24194 x
+= first
->pixel_width
;
24198 /* Find the last one. */
24202 && x
< r
->x
+ r
->width
)
24204 x
+= last
->pixel_width
;
24210 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24211 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24212 DRAW_NORMAL_TEXT
, 0);
24217 /* Redraw the parts of the glyph row ROW on window W intersecting
24218 rectangle R. R is in window-relative coordinates. Value is
24219 non-zero if mouse-face was overwritten. */
24222 expose_line (w
, row
, r
)
24224 struct glyph_row
*row
;
24227 xassert (row
->enabled_p
);
24229 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24230 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24231 0, row
->used
[TEXT_AREA
],
24232 DRAW_NORMAL_TEXT
, 0);
24235 if (row
->used
[LEFT_MARGIN_AREA
])
24236 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24237 if (row
->used
[TEXT_AREA
])
24238 expose_area (w
, row
, r
, TEXT_AREA
);
24239 if (row
->used
[RIGHT_MARGIN_AREA
])
24240 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24241 draw_row_fringe_bitmaps (w
, row
);
24244 return row
->mouse_face_p
;
24248 /* Redraw those parts of glyphs rows during expose event handling that
24249 overlap other rows. Redrawing of an exposed line writes over parts
24250 of lines overlapping that exposed line; this function fixes that.
24252 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24253 row in W's current matrix that is exposed and overlaps other rows.
24254 LAST_OVERLAPPING_ROW is the last such row. */
24257 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24259 struct glyph_row
*first_overlapping_row
;
24260 struct glyph_row
*last_overlapping_row
;
24263 struct glyph_row
*row
;
24265 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24266 if (row
->overlapping_p
)
24268 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24271 if (row
->used
[LEFT_MARGIN_AREA
])
24272 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24274 if (row
->used
[TEXT_AREA
])
24275 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24277 if (row
->used
[RIGHT_MARGIN_AREA
])
24278 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24284 /* Return non-zero if W's cursor intersects rectangle R. */
24287 phys_cursor_in_rect_p (w
, r
)
24291 XRectangle cr
, result
;
24292 struct glyph
*cursor_glyph
;
24293 struct glyph_row
*row
;
24295 if (w
->phys_cursor
.vpos
>= 0
24296 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24297 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24299 && row
->cursor_in_fringe_p
)
24301 /* Cursor is in the fringe. */
24302 cr
.x
= window_box_right_offset (w
,
24303 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24304 ? RIGHT_MARGIN_AREA
24307 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24308 cr
.height
= row
->height
;
24309 return x_intersect_rectangles (&cr
, r
, &result
);
24312 cursor_glyph
= get_phys_cursor_glyph (w
);
24315 /* r is relative to W's box, but w->phys_cursor.x is relative
24316 to left edge of W's TEXT area. Adjust it. */
24317 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24318 cr
.y
= w
->phys_cursor
.y
;
24319 cr
.width
= cursor_glyph
->pixel_width
;
24320 cr
.height
= w
->phys_cursor_height
;
24321 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24322 I assume the effect is the same -- and this is portable. */
24323 return x_intersect_rectangles (&cr
, r
, &result
);
24325 /* If we don't understand the format, pretend we're not in the hot-spot. */
24331 Draw a vertical window border to the right of window W if W doesn't
24332 have vertical scroll bars. */
24335 x_draw_vertical_border (w
)
24338 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24340 /* We could do better, if we knew what type of scroll-bar the adjacent
24341 windows (on either side) have... But we don't :-(
24342 However, I think this works ok. ++KFS 2003-04-25 */
24344 /* Redraw borders between horizontally adjacent windows. Don't
24345 do it for frames with vertical scroll bars because either the
24346 right scroll bar of a window, or the left scroll bar of its
24347 neighbor will suffice as a border. */
24348 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24351 if (!WINDOW_RIGHTMOST_P (w
)
24352 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24354 int x0
, x1
, y0
, y1
;
24356 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24359 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24362 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24364 else if (!WINDOW_LEFTMOST_P (w
)
24365 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24367 int x0
, x1
, y0
, y1
;
24369 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24372 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24375 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24380 /* Redraw the part of window W intersection rectangle FR. Pixel
24381 coordinates in FR are frame-relative. Call this function with
24382 input blocked. Value is non-zero if the exposure overwrites
24386 expose_window (w
, fr
)
24390 struct frame
*f
= XFRAME (w
->frame
);
24392 int mouse_face_overwritten_p
= 0;
24394 /* If window is not yet fully initialized, do nothing. This can
24395 happen when toolkit scroll bars are used and a window is split.
24396 Reconfiguring the scroll bar will generate an expose for a newly
24398 if (w
->current_matrix
== NULL
)
24401 /* When we're currently updating the window, display and current
24402 matrix usually don't agree. Arrange for a thorough display
24404 if (w
== updated_window
)
24406 SET_FRAME_GARBAGED (f
);
24410 /* Frame-relative pixel rectangle of W. */
24411 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24412 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24413 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24414 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24416 if (x_intersect_rectangles (fr
, &wr
, &r
))
24418 int yb
= window_text_bottom_y (w
);
24419 struct glyph_row
*row
;
24420 int cursor_cleared_p
;
24421 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24423 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24424 r
.x
, r
.y
, r
.width
, r
.height
));
24426 /* Convert to window coordinates. */
24427 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24428 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24430 /* Turn off the cursor. */
24431 if (!w
->pseudo_window_p
24432 && phys_cursor_in_rect_p (w
, &r
))
24434 x_clear_cursor (w
);
24435 cursor_cleared_p
= 1;
24438 cursor_cleared_p
= 0;
24440 /* Update lines intersecting rectangle R. */
24441 first_overlapping_row
= last_overlapping_row
= NULL
;
24442 for (row
= w
->current_matrix
->rows
;
24447 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24449 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24450 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24451 || (r
.y
>= y0
&& r
.y
< y1
)
24452 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24454 /* A header line may be overlapping, but there is no need
24455 to fix overlapping areas for them. KFS 2005-02-12 */
24456 if (row
->overlapping_p
&& !row
->mode_line_p
)
24458 if (first_overlapping_row
== NULL
)
24459 first_overlapping_row
= row
;
24460 last_overlapping_row
= row
;
24464 if (expose_line (w
, row
, &r
))
24465 mouse_face_overwritten_p
= 1;
24468 else if (row
->overlapping_p
)
24470 /* We must redraw a row overlapping the exposed area. */
24472 ? y0
+ row
->phys_height
> r
.y
24473 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24475 if (first_overlapping_row
== NULL
)
24476 first_overlapping_row
= row
;
24477 last_overlapping_row
= row
;
24485 /* Display the mode line if there is one. */
24486 if (WINDOW_WANTS_MODELINE_P (w
)
24487 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24489 && row
->y
< r
.y
+ r
.height
)
24491 if (expose_line (w
, row
, &r
))
24492 mouse_face_overwritten_p
= 1;
24495 if (!w
->pseudo_window_p
)
24497 /* Fix the display of overlapping rows. */
24498 if (first_overlapping_row
)
24499 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24502 /* Draw border between windows. */
24503 x_draw_vertical_border (w
);
24505 /* Turn the cursor on again. */
24506 if (cursor_cleared_p
)
24507 update_window_cursor (w
, 1);
24511 return mouse_face_overwritten_p
;
24516 /* Redraw (parts) of all windows in the window tree rooted at W that
24517 intersect R. R contains frame pixel coordinates. Value is
24518 non-zero if the exposure overwrites mouse-face. */
24521 expose_window_tree (w
, r
)
24525 struct frame
*f
= XFRAME (w
->frame
);
24526 int mouse_face_overwritten_p
= 0;
24528 while (w
&& !FRAME_GARBAGED_P (f
))
24530 if (!NILP (w
->hchild
))
24531 mouse_face_overwritten_p
24532 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24533 else if (!NILP (w
->vchild
))
24534 mouse_face_overwritten_p
24535 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24537 mouse_face_overwritten_p
|= expose_window (w
, r
);
24539 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24542 return mouse_face_overwritten_p
;
24547 Redisplay an exposed area of frame F. X and Y are the upper-left
24548 corner of the exposed rectangle. W and H are width and height of
24549 the exposed area. All are pixel values. W or H zero means redraw
24550 the entire frame. */
24553 expose_frame (f
, x
, y
, w
, h
)
24558 int mouse_face_overwritten_p
= 0;
24560 TRACE ((stderr
, "expose_frame "));
24562 /* No need to redraw if frame will be redrawn soon. */
24563 if (FRAME_GARBAGED_P (f
))
24565 TRACE ((stderr
, " garbaged\n"));
24569 /* If basic faces haven't been realized yet, there is no point in
24570 trying to redraw anything. This can happen when we get an expose
24571 event while Emacs is starting, e.g. by moving another window. */
24572 if (FRAME_FACE_CACHE (f
) == NULL
24573 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24575 TRACE ((stderr
, " no faces\n"));
24579 if (w
== 0 || h
== 0)
24582 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24583 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24593 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24594 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24596 if (WINDOWP (f
->tool_bar_window
))
24597 mouse_face_overwritten_p
24598 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24600 #ifdef HAVE_X_WINDOWS
24602 #ifndef USE_X_TOOLKIT
24603 if (WINDOWP (f
->menu_bar_window
))
24604 mouse_face_overwritten_p
24605 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24606 #endif /* not USE_X_TOOLKIT */
24610 /* Some window managers support a focus-follows-mouse style with
24611 delayed raising of frames. Imagine a partially obscured frame,
24612 and moving the mouse into partially obscured mouse-face on that
24613 frame. The visible part of the mouse-face will be highlighted,
24614 then the WM raises the obscured frame. With at least one WM, KDE
24615 2.1, Emacs is not getting any event for the raising of the frame
24616 (even tried with SubstructureRedirectMask), only Expose events.
24617 These expose events will draw text normally, i.e. not
24618 highlighted. Which means we must redo the highlight here.
24619 Subsume it under ``we love X''. --gerd 2001-08-15 */
24620 /* Included in Windows version because Windows most likely does not
24621 do the right thing if any third party tool offers
24622 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24623 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24625 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24626 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24628 int x
= dpyinfo
->mouse_face_mouse_x
;
24629 int y
= dpyinfo
->mouse_face_mouse_y
;
24630 clear_mouse_face (dpyinfo
);
24631 note_mouse_highlight (f
, x
, y
);
24638 Determine the intersection of two rectangles R1 and R2. Return
24639 the intersection in *RESULT. Value is non-zero if RESULT is not
24643 x_intersect_rectangles (r1
, r2
, result
)
24644 XRectangle
*r1
, *r2
, *result
;
24646 XRectangle
*left
, *right
;
24647 XRectangle
*upper
, *lower
;
24648 int intersection_p
= 0;
24650 /* Rearrange so that R1 is the left-most rectangle. */
24652 left
= r1
, right
= r2
;
24654 left
= r2
, right
= r1
;
24656 /* X0 of the intersection is right.x0, if this is inside R1,
24657 otherwise there is no intersection. */
24658 if (right
->x
<= left
->x
+ left
->width
)
24660 result
->x
= right
->x
;
24662 /* The right end of the intersection is the minimum of the
24663 the right ends of left and right. */
24664 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24667 /* Same game for Y. */
24669 upper
= r1
, lower
= r2
;
24671 upper
= r2
, lower
= r1
;
24673 /* The upper end of the intersection is lower.y0, if this is inside
24674 of upper. Otherwise, there is no intersection. */
24675 if (lower
->y
<= upper
->y
+ upper
->height
)
24677 result
->y
= lower
->y
;
24679 /* The lower end of the intersection is the minimum of the lower
24680 ends of upper and lower. */
24681 result
->height
= (min (lower
->y
+ lower
->height
,
24682 upper
->y
+ upper
->height
)
24684 intersection_p
= 1;
24688 return intersection_p
;
24691 #endif /* HAVE_WINDOW_SYSTEM */
24694 /***********************************************************************
24696 ***********************************************************************/
24701 Vwith_echo_area_save_vector
= Qnil
;
24702 staticpro (&Vwith_echo_area_save_vector
);
24704 Vmessage_stack
= Qnil
;
24705 staticpro (&Vmessage_stack
);
24707 Qinhibit_redisplay
= intern ("inhibit-redisplay");
24708 staticpro (&Qinhibit_redisplay
);
24710 message_dolog_marker1
= Fmake_marker ();
24711 staticpro (&message_dolog_marker1
);
24712 message_dolog_marker2
= Fmake_marker ();
24713 staticpro (&message_dolog_marker2
);
24714 message_dolog_marker3
= Fmake_marker ();
24715 staticpro (&message_dolog_marker3
);
24718 defsubr (&Sdump_frame_glyph_matrix
);
24719 defsubr (&Sdump_glyph_matrix
);
24720 defsubr (&Sdump_glyph_row
);
24721 defsubr (&Sdump_tool_bar_row
);
24722 defsubr (&Strace_redisplay
);
24723 defsubr (&Strace_to_stderr
);
24725 #ifdef HAVE_WINDOW_SYSTEM
24726 defsubr (&Stool_bar_lines_needed
);
24727 defsubr (&Slookup_image_map
);
24729 defsubr (&Sformat_mode_line
);
24730 defsubr (&Sinvisible_p
);
24732 staticpro (&Qmenu_bar_update_hook
);
24733 Qmenu_bar_update_hook
= intern ("menu-bar-update-hook");
24735 staticpro (&Qoverriding_terminal_local_map
);
24736 Qoverriding_terminal_local_map
= intern ("overriding-terminal-local-map");
24738 staticpro (&Qoverriding_local_map
);
24739 Qoverriding_local_map
= intern ("overriding-local-map");
24741 staticpro (&Qwindow_scroll_functions
);
24742 Qwindow_scroll_functions
= intern ("window-scroll-functions");
24744 staticpro (&Qwindow_text_change_functions
);
24745 Qwindow_text_change_functions
= intern ("window-text-change-functions");
24747 staticpro (&Qredisplay_end_trigger_functions
);
24748 Qredisplay_end_trigger_functions
= intern ("redisplay-end-trigger-functions");
24750 staticpro (&Qinhibit_point_motion_hooks
);
24751 Qinhibit_point_motion_hooks
= intern ("inhibit-point-motion-hooks");
24753 Qeval
= intern ("eval");
24754 staticpro (&Qeval
);
24756 QCdata
= intern (":data");
24757 staticpro (&QCdata
);
24758 Qdisplay
= intern ("display");
24759 staticpro (&Qdisplay
);
24760 Qspace_width
= intern ("space-width");
24761 staticpro (&Qspace_width
);
24762 Qraise
= intern ("raise");
24763 staticpro (&Qraise
);
24764 Qslice
= intern ("slice");
24765 staticpro (&Qslice
);
24766 Qspace
= intern ("space");
24767 staticpro (&Qspace
);
24768 Qmargin
= intern ("margin");
24769 staticpro (&Qmargin
);
24770 Qpointer
= intern ("pointer");
24771 staticpro (&Qpointer
);
24772 Qleft_margin
= intern ("left-margin");
24773 staticpro (&Qleft_margin
);
24774 Qright_margin
= intern ("right-margin");
24775 staticpro (&Qright_margin
);
24776 Qcenter
= intern ("center");
24777 staticpro (&Qcenter
);
24778 Qline_height
= intern ("line-height");
24779 staticpro (&Qline_height
);
24780 QCalign_to
= intern (":align-to");
24781 staticpro (&QCalign_to
);
24782 QCrelative_width
= intern (":relative-width");
24783 staticpro (&QCrelative_width
);
24784 QCrelative_height
= intern (":relative-height");
24785 staticpro (&QCrelative_height
);
24786 QCeval
= intern (":eval");
24787 staticpro (&QCeval
);
24788 QCpropertize
= intern (":propertize");
24789 staticpro (&QCpropertize
);
24790 QCfile
= intern (":file");
24791 staticpro (&QCfile
);
24792 Qfontified
= intern ("fontified");
24793 staticpro (&Qfontified
);
24794 Qfontification_functions
= intern ("fontification-functions");
24795 staticpro (&Qfontification_functions
);
24796 Qtrailing_whitespace
= intern ("trailing-whitespace");
24797 staticpro (&Qtrailing_whitespace
);
24798 Qescape_glyph
= intern ("escape-glyph");
24799 staticpro (&Qescape_glyph
);
24800 Qnobreak_space
= intern ("nobreak-space");
24801 staticpro (&Qnobreak_space
);
24802 Qimage
= intern ("image");
24803 staticpro (&Qimage
);
24804 QCmap
= intern (":map");
24805 staticpro (&QCmap
);
24806 QCpointer
= intern (":pointer");
24807 staticpro (&QCpointer
);
24808 Qrect
= intern ("rect");
24809 staticpro (&Qrect
);
24810 Qcircle
= intern ("circle");
24811 staticpro (&Qcircle
);
24812 Qpoly
= intern ("poly");
24813 staticpro (&Qpoly
);
24814 Qmessage_truncate_lines
= intern ("message-truncate-lines");
24815 staticpro (&Qmessage_truncate_lines
);
24816 Qgrow_only
= intern ("grow-only");
24817 staticpro (&Qgrow_only
);
24818 Qinhibit_menubar_update
= intern ("inhibit-menubar-update");
24819 staticpro (&Qinhibit_menubar_update
);
24820 Qinhibit_eval_during_redisplay
= intern ("inhibit-eval-during-redisplay");
24821 staticpro (&Qinhibit_eval_during_redisplay
);
24822 Qposition
= intern ("position");
24823 staticpro (&Qposition
);
24824 Qbuffer_position
= intern ("buffer-position");
24825 staticpro (&Qbuffer_position
);
24826 Qobject
= intern ("object");
24827 staticpro (&Qobject
);
24828 Qbar
= intern ("bar");
24830 Qhbar
= intern ("hbar");
24831 staticpro (&Qhbar
);
24832 Qbox
= intern ("box");
24834 Qhollow
= intern ("hollow");
24835 staticpro (&Qhollow
);
24836 Qhand
= intern ("hand");
24837 staticpro (&Qhand
);
24838 Qarrow
= intern ("arrow");
24839 staticpro (&Qarrow
);
24840 Qtext
= intern ("text");
24841 staticpro (&Qtext
);
24842 Qrisky_local_variable
= intern ("risky-local-variable");
24843 staticpro (&Qrisky_local_variable
);
24844 Qinhibit_free_realized_faces
= intern ("inhibit-free-realized-faces");
24845 staticpro (&Qinhibit_free_realized_faces
);
24847 list_of_error
= Fcons (Fcons (intern ("error"),
24848 Fcons (intern ("void-variable"), Qnil
)),
24850 staticpro (&list_of_error
);
24852 Qlast_arrow_position
= intern ("last-arrow-position");
24853 staticpro (&Qlast_arrow_position
);
24854 Qlast_arrow_string
= intern ("last-arrow-string");
24855 staticpro (&Qlast_arrow_string
);
24857 Qoverlay_arrow_string
= intern ("overlay-arrow-string");
24858 staticpro (&Qoverlay_arrow_string
);
24859 Qoverlay_arrow_bitmap
= intern ("overlay-arrow-bitmap");
24860 staticpro (&Qoverlay_arrow_bitmap
);
24862 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24863 staticpro (&echo_buffer
[0]);
24864 staticpro (&echo_buffer
[1]);
24866 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24867 staticpro (&echo_area_buffer
[0]);
24868 staticpro (&echo_area_buffer
[1]);
24870 Vmessages_buffer_name
= build_string ("*Messages*");
24871 staticpro (&Vmessages_buffer_name
);
24873 mode_line_proptrans_alist
= Qnil
;
24874 staticpro (&mode_line_proptrans_alist
);
24875 mode_line_string_list
= Qnil
;
24876 staticpro (&mode_line_string_list
);
24877 mode_line_string_face
= Qnil
;
24878 staticpro (&mode_line_string_face
);
24879 mode_line_string_face_prop
= Qnil
;
24880 staticpro (&mode_line_string_face_prop
);
24881 Vmode_line_unwind_vector
= Qnil
;
24882 staticpro (&Vmode_line_unwind_vector
);
24884 help_echo_string
= Qnil
;
24885 staticpro (&help_echo_string
);
24886 help_echo_object
= Qnil
;
24887 staticpro (&help_echo_object
);
24888 help_echo_window
= Qnil
;
24889 staticpro (&help_echo_window
);
24890 previous_help_echo_string
= Qnil
;
24891 staticpro (&previous_help_echo_string
);
24892 help_echo_pos
= -1;
24894 #ifdef HAVE_WINDOW_SYSTEM
24895 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24896 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24897 For example, if a block cursor is over a tab, it will be drawn as
24898 wide as that tab on the display. */);
24899 x_stretch_cursor_p
= 0;
24902 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24903 doc
: /* *Non-nil means highlight trailing whitespace.
24904 The face used for trailing whitespace is `trailing-whitespace'. */);
24905 Vshow_trailing_whitespace
= Qnil
;
24907 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24908 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24909 A value of t means highlight the character itself (for nobreak space,
24910 use face `nobreak-space').
24911 A value of nil means no highlighting.
24912 Other values mean display the escape glyph followed by an ordinary
24913 space or ordinary hyphen. */);
24914 Vnobreak_char_display
= Qt
;
24916 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24917 doc
: /* *The pointer shape to show in void text areas.
24918 A value of nil means to show the text pointer. Other options are `arrow',
24919 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24920 Vvoid_text_area_pointer
= Qarrow
;
24922 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24923 doc
: /* Non-nil means don't actually do any redisplay.
24924 This is used for internal purposes. */);
24925 Vinhibit_redisplay
= Qnil
;
24927 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24928 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24929 Vglobal_mode_string
= Qnil
;
24931 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24932 doc
: /* Marker for where to display an arrow on top of the buffer text.
24933 This must be the beginning of a line in order to work.
24934 See also `overlay-arrow-string'. */);
24935 Voverlay_arrow_position
= Qnil
;
24937 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24938 doc
: /* String to display as an arrow in non-window frames.
24939 See also `overlay-arrow-position'. */);
24940 Voverlay_arrow_string
= build_string ("=>");
24942 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24943 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24944 The symbols on this list are examined during redisplay to determine
24945 where to display overlay arrows. */);
24946 Voverlay_arrow_variable_list
24947 = Fcons (intern ("overlay-arrow-position"), Qnil
);
24949 DEFVAR_INT ("scroll-step", &scroll_step
,
24950 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24951 If that fails to bring point back on frame, point is centered instead.
24952 If this is zero, point is always centered after it moves off frame.
24953 If you want scrolling to always be a line at a time, you should set
24954 `scroll-conservatively' to a large value rather than set this to 1. */);
24956 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24957 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24958 If point moves off-screen, redisplay will scroll by up to
24959 `scroll-conservatively' lines in order to bring point just barely
24960 onto the screen again. If that cannot be done, then redisplay
24961 recenters point as usual.
24963 A value of zero means always recenter point if it moves off screen. */);
24964 scroll_conservatively
= 0;
24966 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24967 doc
: /* *Number of lines of margin at the top and bottom of a window.
24968 Recenter the window whenever point gets within this many lines
24969 of the top or bottom of the window. */);
24972 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24973 doc
: /* Pixels per inch value for non-window system displays.
24974 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24975 Vdisplay_pixels_per_inch
= make_float (72.0);
24978 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24981 DEFVAR_LISP ("truncate-partial-width-windows",
24982 &Vtruncate_partial_width_windows
,
24983 doc
: /* Non-nil means truncate lines in windows with less than the frame width.
24984 For an integer value, truncate lines in each window with less than the
24985 full frame width, provided the window width is less than that integer;
24986 otherwise, respect the value of `truncate-lines'.
24988 For any other non-nil value, truncate lines in all windows with
24989 less than the full frame width.
24991 A value of nil means to respect the value of `truncate-lines'.
24993 If `word-wrap' is enabled, you might want to reduce this. */);
24994 Vtruncate_partial_width_windows
= make_number (50);
24996 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24997 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24998 Any other value means to use the appropriate face, `mode-line',
24999 `header-line', or `menu' respectively. */);
25000 mode_line_inverse_video
= 1;
25002 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25003 doc
: /* *Maximum buffer size for which line number should be displayed.
25004 If the buffer is bigger than this, the line number does not appear
25005 in the mode line. A value of nil means no limit. */);
25006 Vline_number_display_limit
= Qnil
;
25008 DEFVAR_INT ("line-number-display-limit-width",
25009 &line_number_display_limit_width
,
25010 doc
: /* *Maximum line width (in characters) for line number display.
25011 If the average length of the lines near point is bigger than this, then the
25012 line number may be omitted from the mode line. */);
25013 line_number_display_limit_width
= 200;
25015 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25016 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25017 highlight_nonselected_windows
= 0;
25019 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25020 doc
: /* Non-nil if more than one frame is visible on this display.
25021 Minibuffer-only frames don't count, but iconified frames do.
25022 This variable is not guaranteed to be accurate except while processing
25023 `frame-title-format' and `icon-title-format'. */);
25025 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25026 doc
: /* Template for displaying the title bar of visible frames.
25027 \(Assuming the window manager supports this feature.)
25029 This variable has the same structure as `mode-line-format', except that
25030 the %c and %l constructs are ignored. It is used only on frames for
25031 which no explicit name has been set \(see `modify-frame-parameters'). */);
25033 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25034 doc
: /* Template for displaying the title bar of an iconified frame.
25035 \(Assuming the window manager supports this feature.)
25036 This variable has the same structure as `mode-line-format' (which see),
25037 and is used only on frames for which no explicit name has been set
25038 \(see `modify-frame-parameters'). */);
25040 = Vframe_title_format
25041 = Fcons (intern ("multiple-frames"),
25042 Fcons (build_string ("%b"),
25043 Fcons (Fcons (empty_unibyte_string
,
25044 Fcons (intern ("invocation-name"),
25045 Fcons (build_string ("@"),
25046 Fcons (intern ("system-name"),
25050 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25051 doc
: /* Maximum number of lines to keep in the message log buffer.
25052 If nil, disable message logging. If t, log messages but don't truncate
25053 the buffer when it becomes large. */);
25054 Vmessage_log_max
= make_number (100);
25056 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25057 doc
: /* Functions called before redisplay, if window sizes have changed.
25058 The value should be a list of functions that take one argument.
25059 Just before redisplay, for each frame, if any of its windows have changed
25060 size since the last redisplay, or have been split or deleted,
25061 all the functions in the list are called, with the frame as argument. */);
25062 Vwindow_size_change_functions
= Qnil
;
25064 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25065 doc
: /* List of functions to call before redisplaying a window with scrolling.
25066 Each function is called with two arguments, the window and its new
25067 display-start position. Note that these functions are also called by
25068 `set-window-buffer'. Also note that the value of `window-end' is not
25069 valid when these functions are called. */);
25070 Vwindow_scroll_functions
= Qnil
;
25072 DEFVAR_LISP ("window-text-change-functions",
25073 &Vwindow_text_change_functions
,
25074 doc
: /* Functions to call in redisplay when text in the window might change. */);
25075 Vwindow_text_change_functions
= Qnil
;
25077 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25078 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25079 Each function is called with two arguments, the window and the end trigger value.
25080 See `set-window-redisplay-end-trigger'. */);
25081 Vredisplay_end_trigger_functions
= Qnil
;
25083 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25084 doc
: /* *Non-nil means autoselect window with mouse pointer.
25085 If nil, do not autoselect windows.
25086 A positive number means delay autoselection by that many seconds: a
25087 window is autoselected only after the mouse has remained in that
25088 window for the duration of the delay.
25089 A negative number has a similar effect, but causes windows to be
25090 autoselected only after the mouse has stopped moving. \(Because of
25091 the way Emacs compares mouse events, you will occasionally wait twice
25092 that time before the window gets selected.\)
25093 Any other value means to autoselect window instantaneously when the
25094 mouse pointer enters it.
25096 Autoselection selects the minibuffer only if it is active, and never
25097 unselects the minibuffer if it is active.
25099 When customizing this variable make sure that the actual value of
25100 `focus-follows-mouse' matches the behavior of your window manager. */);
25101 Vmouse_autoselect_window
= Qnil
;
25103 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25104 doc
: /* *Non-nil means automatically resize tool-bars.
25105 This dynamically changes the tool-bar's height to the minimum height
25106 that is needed to make all tool-bar items visible.
25107 If value is `grow-only', the tool-bar's height is only increased
25108 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25109 Vauto_resize_tool_bars
= Qt
;
25111 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25112 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25113 auto_raise_tool_bar_buttons_p
= 1;
25115 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25116 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25117 make_cursor_line_fully_visible_p
= 1;
25119 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25120 doc
: /* *Border below tool-bar in pixels.
25121 If an integer, use it as the height of the border.
25122 If it is one of `internal-border-width' or `border-width', use the
25123 value of the corresponding frame parameter.
25124 Otherwise, no border is added below the tool-bar. */);
25125 Vtool_bar_border
= Qinternal_border_width
;
25127 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25128 doc
: /* *Margin around tool-bar buttons in pixels.
25129 If an integer, use that for both horizontal and vertical margins.
25130 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25131 HORZ specifying the horizontal margin, and VERT specifying the
25132 vertical margin. */);
25133 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25135 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25136 doc
: /* *Relief thickness of tool-bar buttons. */);
25137 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25139 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25140 doc
: /* List of functions to call to fontify regions of text.
25141 Each function is called with one argument POS. Functions must
25142 fontify a region starting at POS in the current buffer, and give
25143 fontified regions the property `fontified'. */);
25144 Vfontification_functions
= Qnil
;
25145 Fmake_variable_buffer_local (Qfontification_functions
);
25147 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25148 &unibyte_display_via_language_environment
,
25149 doc
: /* *Non-nil means display unibyte text according to language environment.
25150 Specifically this means that unibyte non-ASCII characters
25151 are displayed by converting them to the equivalent multibyte characters
25152 according to the current language environment. As a result, they are
25153 displayed according to the current fontset. */);
25154 unibyte_display_via_language_environment
= 0;
25156 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25157 doc
: /* *Maximum height for resizing mini-windows.
25158 If a float, it specifies a fraction of the mini-window frame's height.
25159 If an integer, it specifies a number of lines. */);
25160 Vmax_mini_window_height
= make_float (0.25);
25162 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25163 doc
: /* *How to resize mini-windows.
25164 A value of nil means don't automatically resize mini-windows.
25165 A value of t means resize them to fit the text displayed in them.
25166 A value of `grow-only', the default, means let mini-windows grow
25167 only, until their display becomes empty, at which point the windows
25168 go back to their normal size. */);
25169 Vresize_mini_windows
= Qgrow_only
;
25171 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25172 doc
: /* Alist specifying how to blink the cursor off.
25173 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25174 `cursor-type' frame-parameter or variable equals ON-STATE,
25175 comparing using `equal', Emacs uses OFF-STATE to specify
25176 how to blink it off. ON-STATE and OFF-STATE are values for
25177 the `cursor-type' frame parameter.
25179 If a frame's ON-STATE has no entry in this list,
25180 the frame's other specifications determine how to blink the cursor off. */);
25181 Vblink_cursor_alist
= Qnil
;
25183 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25184 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25185 automatic_hscrolling_p
= 1;
25186 Qauto_hscroll_mode
= intern ("auto-hscroll-mode");
25187 staticpro (&Qauto_hscroll_mode
);
25189 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25190 doc
: /* *How many columns away from the window edge point is allowed to get
25191 before automatic hscrolling will horizontally scroll the window. */);
25192 hscroll_margin
= 5;
25194 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25195 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25196 When point is less than `hscroll-margin' columns from the window
25197 edge, automatic hscrolling will scroll the window by the amount of columns
25198 determined by this variable. If its value is a positive integer, scroll that
25199 many columns. If it's a positive floating-point number, it specifies the
25200 fraction of the window's width to scroll. If it's nil or zero, point will be
25201 centered horizontally after the scroll. Any other value, including negative
25202 numbers, are treated as if the value were zero.
25204 Automatic hscrolling always moves point outside the scroll margin, so if
25205 point was more than scroll step columns inside the margin, the window will
25206 scroll more than the value given by the scroll step.
25208 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25209 and `scroll-right' overrides this variable's effect. */);
25210 Vhscroll_step
= make_number (0);
25212 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25213 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25214 Bind this around calls to `message' to let it take effect. */);
25215 message_truncate_lines
= 0;
25217 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25218 doc
: /* Normal hook run to update the menu bar definitions.
25219 Redisplay runs this hook before it redisplays the menu bar.
25220 This is used to update submenus such as Buffers,
25221 whose contents depend on various data. */);
25222 Vmenu_bar_update_hook
= Qnil
;
25224 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25225 doc
: /* Frame for which we are updating a menu.
25226 The enable predicate for a menu binding should check this variable. */);
25227 Vmenu_updating_frame
= Qnil
;
25229 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25230 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25231 inhibit_menubar_update
= 0;
25233 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25234 doc
: /* Prefix added to the beginning of all continuation lines at display-time.
25235 May be a string, an image, or a stretch-glyph such as used by the
25236 `display' text-property.
25238 This variable is overridden by any `wrap-prefix' text-property.
25240 To add a prefix to non-continuation lines, use the `line-prefix' variable. */);
25241 Vwrap_prefix
= Qnil
;
25242 staticpro (&Qwrap_prefix
);
25243 Qwrap_prefix
= intern ("wrap-prefix");
25244 Fmake_variable_buffer_local (Qwrap_prefix
);
25246 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25247 doc
: /* Prefix added to the beginning of all non-continuation lines at display-time.
25248 May be a string, an image, or a stretch-glyph such as used by the
25249 `display' text-property.
25251 This variable is overridden by any `line-prefix' text-property.
25253 To add a prefix to continuation lines, use the `wrap-prefix' variable. */);
25254 Vline_prefix
= Qnil
;
25255 staticpro (&Qline_prefix
);
25256 Qline_prefix
= intern ("line-prefix");
25257 Fmake_variable_buffer_local (Qline_prefix
);
25259 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25260 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25261 inhibit_eval_during_redisplay
= 0;
25263 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25264 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25265 inhibit_free_realized_faces
= 0;
25268 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25269 doc
: /* Inhibit try_window_id display optimization. */);
25270 inhibit_try_window_id
= 0;
25272 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25273 doc
: /* Inhibit try_window_reusing display optimization. */);
25274 inhibit_try_window_reusing
= 0;
25276 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25277 doc
: /* Inhibit try_cursor_movement display optimization. */);
25278 inhibit_try_cursor_movement
= 0;
25279 #endif /* GLYPH_DEBUG */
25281 DEFVAR_INT ("overline-margin", &overline_margin
,
25282 doc
: /* *Space between overline and text, in pixels.
25283 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25284 margin to the caracter height. */);
25285 overline_margin
= 2;
25287 DEFVAR_INT ("underline-minimum-offset",
25288 &underline_minimum_offset
,
25289 doc
: /* Minimum distance between baseline and underline.
25290 This can improve legibility of underlined text at small font sizes,
25291 particularly when using variable `x-use-underline-position-properties'
25292 with fonts that specify an UNDERLINE_POSITION relatively close to the
25293 baseline. The default value is 1. */);
25294 underline_minimum_offset
= 1;
25296 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25297 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25298 display_hourglass_p
= 1;
25300 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25301 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25302 Value must be an integer or float. */);
25303 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25305 hourglass_atimer
= NULL
;
25306 hourglass_shown_p
= 0;
25310 /* Initialize this module when Emacs starts. */
25315 Lisp_Object root_window
;
25316 struct window
*mini_w
;
25318 current_header_line_height
= current_mode_line_height
= -1;
25320 CHARPOS (this_line_start_pos
) = 0;
25322 mini_w
= XWINDOW (minibuf_window
);
25323 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25325 if (!noninteractive
)
25327 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25330 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25331 set_window_height (root_window
,
25332 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25334 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25335 set_window_height (minibuf_window
, 1, 0);
25337 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25338 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25340 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25341 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25342 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25344 /* The default ellipsis glyphs `...'. */
25345 for (i
= 0; i
< 3; ++i
)
25346 default_invis_vector
[i
] = make_number ('.');
25350 /* Allocate the buffer for frame titles.
25351 Also used for `format-mode-line'. */
25353 mode_line_noprop_buf
= (char *) xmalloc (size
);
25354 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25355 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25356 mode_line_target
= MODE_LINE_DISPLAY
;
25359 help_echo_showing_p
= 0;
25362 /* Since w32 does not support atimers, it defines its own implementation of
25363 the following three functions in w32fns.c. */
25366 /* Platform-independent portion of hourglass implementation. */
25368 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25370 hourglass_started ()
25372 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25375 /* Cancel a currently active hourglass timer, and start a new one. */
25379 #if defined (HAVE_WINDOW_SYSTEM)
25381 int secs
, usecs
= 0;
25383 cancel_hourglass ();
25385 if (INTEGERP (Vhourglass_delay
)
25386 && XINT (Vhourglass_delay
) > 0)
25387 secs
= XFASTINT (Vhourglass_delay
);
25388 else if (FLOATP (Vhourglass_delay
)
25389 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25392 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25393 secs
= XFASTINT (tem
);
25394 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25397 secs
= DEFAULT_HOURGLASS_DELAY
;
25399 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25400 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25401 show_hourglass
, NULL
);
25406 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25409 cancel_hourglass ()
25411 #if defined (HAVE_WINDOW_SYSTEM)
25412 if (hourglass_atimer
)
25414 cancel_atimer (hourglass_atimer
);
25415 hourglass_atimer
= NULL
;
25418 if (hourglass_shown_p
)
25422 #endif /* ! WINDOWSNT */
25424 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25425 (do not change this comment) */