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. */
174 #include "keyboard.h"
177 #include "termchar.h"
178 #include "dispextern.h"
180 #include "character.h"
183 #include "commands.h"
187 #include "termhooks.h"
188 #include "intervals.h"
191 #include "region-cache.h"
194 #include "blockinput.h"
196 #ifdef HAVE_X_WINDOWS
211 #ifndef FRAME_X_OUTPUT
212 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
215 #define INFINITY 10000000
217 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
218 || defined(HAVE_NS) || defined (USE_GTK)
219 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
220 extern int pending_menu_activation
;
223 extern int interrupt_input
;
224 extern int command_loop_level
;
226 extern Lisp_Object do_mouse_tracking
;
228 extern int minibuffer_auto_raise
;
229 extern Lisp_Object Vminibuffer_list
;
231 extern Lisp_Object Qface
;
232 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
234 extern Lisp_Object Voverriding_local_map
;
235 extern Lisp_Object Voverriding_local_map_menu_flag
;
236 extern Lisp_Object Qmenu_item
;
237 extern Lisp_Object Qwhen
;
238 extern Lisp_Object Qhelp_echo
;
239 extern Lisp_Object Qbefore_string
, Qafter_string
;
241 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
242 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
243 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
244 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
245 Lisp_Object Qinhibit_point_motion_hooks
;
246 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
247 Lisp_Object Qfontified
;
248 Lisp_Object Qgrow_only
;
249 Lisp_Object Qinhibit_eval_during_redisplay
;
250 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
253 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
256 Lisp_Object Qarrow
, Qhand
, Qtext
;
258 Lisp_Object Qrisky_local_variable
;
260 /* Holds the list (error). */
261 Lisp_Object list_of_error
;
263 /* Functions called to fontify regions of text. */
265 Lisp_Object Vfontification_functions
;
266 Lisp_Object Qfontification_functions
;
268 /* Non-nil means automatically select any window when the mouse
269 cursor moves into it. */
270 Lisp_Object Vmouse_autoselect_window
;
272 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
273 Lisp_Object Vline_prefix
, Qline_prefix
;
275 /* Non-zero means draw tool bar buttons raised when the mouse moves
278 int auto_raise_tool_bar_buttons_p
;
280 /* Non-zero means to reposition window if cursor line is only partially visible. */
282 int make_cursor_line_fully_visible_p
;
284 /* Margin below tool bar in pixels. 0 or nil means no margin.
285 If value is `internal-border-width' or `border-width',
286 the corresponding frame parameter is used. */
288 Lisp_Object Vtool_bar_border
;
290 /* Margin around tool bar buttons in pixels. */
292 Lisp_Object Vtool_bar_button_margin
;
294 /* Thickness of shadow to draw around tool bar buttons. */
296 EMACS_INT tool_bar_button_relief
;
298 /* Non-nil means automatically resize tool-bars so that all tool-bar
299 items are visible, and no blank lines remain.
301 If value is `grow-only', only make tool-bar bigger. */
303 Lisp_Object Vauto_resize_tool_bars
;
305 /* Non-zero means draw block and hollow cursor as wide as the glyph
306 under it. For example, if a block cursor is over a tab, it will be
307 drawn as wide as that tab on the display. */
309 int x_stretch_cursor_p
;
311 /* Non-nil means don't actually do any redisplay. */
313 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
315 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
317 int inhibit_eval_during_redisplay
;
319 /* Names of text properties relevant for redisplay. */
321 Lisp_Object Qdisplay
;
322 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
324 /* Symbols used in text property values. */
326 Lisp_Object Vdisplay_pixels_per_inch
;
327 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
328 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
331 Lisp_Object Qmargin
, Qpointer
;
332 Lisp_Object Qline_height
;
333 extern Lisp_Object Qheight
;
334 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
335 extern Lisp_Object Qscroll_bar
;
336 extern Lisp_Object Qcursor
;
338 /* Non-nil means highlight trailing whitespace. */
340 Lisp_Object Vshow_trailing_whitespace
;
342 /* Non-nil means escape non-break space and hyphens. */
344 Lisp_Object Vnobreak_char_display
;
346 #ifdef HAVE_WINDOW_SYSTEM
347 extern Lisp_Object Voverflow_newline_into_fringe
;
349 /* Test if overflow newline into fringe. Called with iterator IT
350 at or past right window margin, and with IT->current_x set. */
352 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) \
353 (!NILP (Voverflow_newline_into_fringe) \
354 && FRAME_WINDOW_P (it->f) \
355 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0 \
356 && it->current_x == it->last_visible_x \
357 && it->line_wrap != WORD_WRAP)
359 #else /* !HAVE_WINDOW_SYSTEM */
360 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
361 #endif /* HAVE_WINDOW_SYSTEM */
363 /* Test if the display element loaded in IT is a space or tab
364 character. This is used to determine word wrapping. */
366 #define IT_DISPLAYING_WHITESPACE(it) \
367 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
369 /* Non-nil means show the text cursor in void text areas
370 i.e. in blank areas after eol and eob. This used to be
371 the default in 21.3. */
373 Lisp_Object Vvoid_text_area_pointer
;
375 /* Name of the face used to highlight trailing whitespace. */
377 Lisp_Object Qtrailing_whitespace
;
379 /* Name and number of the face used to highlight escape glyphs. */
381 Lisp_Object Qescape_glyph
;
383 /* Name and number of the face used to highlight non-breaking spaces. */
385 Lisp_Object Qnobreak_space
;
387 /* The symbol `image' which is the car of the lists used to represent
392 /* The image map types. */
393 Lisp_Object QCmap
, QCpointer
;
394 Lisp_Object Qrect
, Qcircle
, Qpoly
;
396 /* Non-zero means print newline to stdout before next mini-buffer
399 int noninteractive_need_newline
;
401 /* Non-zero means print newline to message log before next message. */
403 static int message_log_need_newline
;
405 /* Three markers that message_dolog uses.
406 It could allocate them itself, but that causes trouble
407 in handling memory-full errors. */
408 static Lisp_Object message_dolog_marker1
;
409 static Lisp_Object message_dolog_marker2
;
410 static Lisp_Object message_dolog_marker3
;
412 /* The buffer position of the first character appearing entirely or
413 partially on the line of the selected window which contains the
414 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
415 redisplay optimization in redisplay_internal. */
417 static struct text_pos this_line_start_pos
;
419 /* Number of characters past the end of the line above, including the
420 terminating newline. */
422 static struct text_pos this_line_end_pos
;
424 /* The vertical positions and the height of this line. */
426 static int this_line_vpos
;
427 static int this_line_y
;
428 static int this_line_pixel_height
;
430 /* X position at which this display line starts. Usually zero;
431 negative if first character is partially visible. */
433 static int this_line_start_x
;
435 /* Buffer that this_line_.* variables are referring to. */
437 static struct buffer
*this_line_buffer
;
439 /* Nonzero means truncate lines in all windows less wide than the
442 Lisp_Object Vtruncate_partial_width_windows
;
444 /* A flag to control how to display unibyte 8-bit character. */
446 int unibyte_display_via_language_environment
;
448 /* Nonzero means we have more than one non-mini-buffer-only frame.
449 Not guaranteed to be accurate except while parsing
450 frame-title-format. */
454 Lisp_Object Vglobal_mode_string
;
457 /* List of variables (symbols) which hold markers for overlay arrows.
458 The symbols on this list are examined during redisplay to determine
459 where to display overlay arrows. */
461 Lisp_Object Voverlay_arrow_variable_list
;
463 /* Marker for where to display an arrow on top of the buffer text. */
465 Lisp_Object Voverlay_arrow_position
;
467 /* String to display for the arrow. Only used on terminal frames. */
469 Lisp_Object Voverlay_arrow_string
;
471 /* Values of those variables at last redisplay are stored as
472 properties on `overlay-arrow-position' symbol. However, if
473 Voverlay_arrow_position is a marker, last-arrow-position is its
474 numerical position. */
476 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
478 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
479 properties on a symbol in overlay-arrow-variable-list. */
481 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
483 /* Like mode-line-format, but for the title bar on a visible frame. */
485 Lisp_Object Vframe_title_format
;
487 /* Like mode-line-format, but for the title bar on an iconified frame. */
489 Lisp_Object Vicon_title_format
;
491 /* List of functions to call when a window's size changes. These
492 functions get one arg, a frame on which one or more windows' sizes
495 static Lisp_Object Vwindow_size_change_functions
;
497 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
499 /* Nonzero if an overlay arrow has been displayed in this window. */
501 static int overlay_arrow_seen
;
503 /* Nonzero means highlight the region even in nonselected windows. */
505 int highlight_nonselected_windows
;
507 /* If cursor motion alone moves point off frame, try scrolling this
508 many lines up or down if that will bring it back. */
510 static EMACS_INT scroll_step
;
512 /* Nonzero means scroll just far enough to bring point back on the
513 screen, when appropriate. */
515 static EMACS_INT scroll_conservatively
;
517 /* Recenter the window whenever point gets within this many lines of
518 the top or bottom of the window. This value is translated into a
519 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
520 that there is really a fixed pixel height scroll margin. */
522 EMACS_INT scroll_margin
;
524 /* Number of windows showing the buffer of the selected window (or
525 another buffer with the same base buffer). keyboard.c refers to
530 /* Vector containing glyphs for an ellipsis `...'. */
532 static Lisp_Object default_invis_vector
[3];
534 /* Zero means display the mode-line/header-line/menu-bar in the default face
535 (this slightly odd definition is for compatibility with previous versions
536 of emacs), non-zero means display them using their respective faces.
538 This variable is deprecated. */
540 int mode_line_inverse_video
;
542 /* Prompt to display in front of the mini-buffer contents. */
544 Lisp_Object minibuf_prompt
;
546 /* Width of current mini-buffer prompt. Only set after display_line
547 of the line that contains the prompt. */
549 int minibuf_prompt_width
;
551 /* This is the window where the echo area message was displayed. It
552 is always a mini-buffer window, but it may not be the same window
553 currently active as a mini-buffer. */
555 Lisp_Object echo_area_window
;
557 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
558 pushes the current message and the value of
559 message_enable_multibyte on the stack, the function restore_message
560 pops the stack and displays MESSAGE again. */
562 Lisp_Object Vmessage_stack
;
564 /* Nonzero means multibyte characters were enabled when the echo area
565 message was specified. */
567 int message_enable_multibyte
;
569 /* Nonzero if we should redraw the mode lines on the next redisplay. */
571 int update_mode_lines
;
573 /* Nonzero if window sizes or contents have changed since last
574 redisplay that finished. */
576 int windows_or_buffers_changed
;
578 /* Nonzero means a frame's cursor type has been changed. */
580 int cursor_type_changed
;
582 /* Nonzero after display_mode_line if %l was used and it displayed a
585 int line_number_displayed
;
587 /* Maximum buffer size for which to display line numbers. */
589 Lisp_Object Vline_number_display_limit
;
591 /* Line width to consider when repositioning for line number display. */
593 static EMACS_INT line_number_display_limit_width
;
595 /* Number of lines to keep in the message log buffer. t means
596 infinite. nil means don't log at all. */
598 Lisp_Object Vmessage_log_max
;
600 /* The name of the *Messages* buffer, a string. */
602 static Lisp_Object Vmessages_buffer_name
;
604 /* Current, index 0, and last displayed echo area message. Either
605 buffers from echo_buffers, or nil to indicate no message. */
607 Lisp_Object echo_area_buffer
[2];
609 /* The buffers referenced from echo_area_buffer. */
611 static Lisp_Object echo_buffer
[2];
613 /* A vector saved used in with_area_buffer to reduce consing. */
615 static Lisp_Object Vwith_echo_area_save_vector
;
617 /* Non-zero means display_echo_area should display the last echo area
618 message again. Set by redisplay_preserve_echo_area. */
620 static int display_last_displayed_message_p
;
622 /* Nonzero if echo area is being used by print; zero if being used by
625 int message_buf_print
;
627 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
629 Lisp_Object Qinhibit_menubar_update
;
630 int inhibit_menubar_update
;
632 /* When evaluating expressions from menu bar items (enable conditions,
633 for instance), this is the frame they are being processed for. */
635 Lisp_Object Vmenu_updating_frame
;
637 /* Maximum height for resizing mini-windows. Either a float
638 specifying a fraction of the available height, or an integer
639 specifying a number of lines. */
641 Lisp_Object Vmax_mini_window_height
;
643 /* Non-zero means messages should be displayed with truncated
644 lines instead of being continued. */
646 int message_truncate_lines
;
647 Lisp_Object Qmessage_truncate_lines
;
649 /* Set to 1 in clear_message to make redisplay_internal aware
650 of an emptied echo area. */
652 static int message_cleared_p
;
654 /* How to blink the default frame cursor off. */
655 Lisp_Object Vblink_cursor_alist
;
657 /* A scratch glyph row with contents used for generating truncation
658 glyphs. Also used in direct_output_for_insert. */
660 #define MAX_SCRATCH_GLYPHS 100
661 struct glyph_row scratch_glyph_row
;
662 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
664 /* Ascent and height of the last line processed by move_it_to. */
666 static int last_max_ascent
, last_height
;
668 /* Non-zero if there's a help-echo in the echo area. */
670 int help_echo_showing_p
;
672 /* If >= 0, computed, exact values of mode-line and header-line height
673 to use in the macros CURRENT_MODE_LINE_HEIGHT and
674 CURRENT_HEADER_LINE_HEIGHT. */
676 int current_mode_line_height
, current_header_line_height
;
678 /* The maximum distance to look ahead for text properties. Values
679 that are too small let us call compute_char_face and similar
680 functions too often which is expensive. Values that are too large
681 let us call compute_char_face and alike too often because we
682 might not be interested in text properties that far away. */
684 #define TEXT_PROP_DISTANCE_LIMIT 100
688 /* Variables to turn off display optimizations from Lisp. */
690 int inhibit_try_window_id
, inhibit_try_window_reusing
;
691 int inhibit_try_cursor_movement
;
693 /* Non-zero means print traces of redisplay if compiled with
696 int trace_redisplay_p
;
698 #endif /* GLYPH_DEBUG */
700 #ifdef DEBUG_TRACE_MOVE
701 /* Non-zero means trace with TRACE_MOVE to stderr. */
704 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
706 #define TRACE_MOVE(x) (void) 0
709 /* Non-zero means automatically scroll windows horizontally to make
712 int automatic_hscrolling_p
;
713 Lisp_Object Qauto_hscroll_mode
;
715 /* How close to the margin can point get before the window is scrolled
717 EMACS_INT hscroll_margin
;
719 /* How much to scroll horizontally when point is inside the above margin. */
720 Lisp_Object Vhscroll_step
;
722 /* The variable `resize-mini-windows'. If nil, don't resize
723 mini-windows. If t, always resize them to fit the text they
724 display. If `grow-only', let mini-windows grow only until they
727 Lisp_Object Vresize_mini_windows
;
729 /* Buffer being redisplayed -- for redisplay_window_error. */
731 struct buffer
*displayed_buffer
;
733 /* Space between overline and text. */
735 EMACS_INT overline_margin
;
737 /* Require underline to be at least this many screen pixels below baseline
738 This to avoid underline "merging" with the base of letters at small
739 font sizes, particularly when x_use_underline_position_properties is on. */
741 EMACS_INT underline_minimum_offset
;
743 /* Value returned from text property handlers (see below). */
748 HANDLED_RECOMPUTE_PROPS
,
749 HANDLED_OVERLAY_STRING_CONSUMED
,
753 /* A description of text properties that redisplay is interested
758 /* The name of the property. */
761 /* A unique index for the property. */
764 /* A handler function called to set up iterator IT from the property
765 at IT's current position. Value is used to steer handle_stop. */
766 enum prop_handled (*handler
) P_ ((struct it
*it
));
769 static enum prop_handled handle_face_prop
P_ ((struct it
*));
770 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
771 static enum prop_handled handle_display_prop
P_ ((struct it
*));
772 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
773 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
774 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
776 /* Properties handled by iterators. */
778 static struct props it_props
[] =
780 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
781 /* Handle `face' before `display' because some sub-properties of
782 `display' need to know the face. */
783 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
784 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
785 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
786 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
790 /* Value is the position described by X. If X is a marker, value is
791 the marker_position of X. Otherwise, value is X. */
793 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
795 /* Enumeration returned by some move_it_.* functions internally. */
799 /* Not used. Undefined value. */
802 /* Move ended at the requested buffer position or ZV. */
803 MOVE_POS_MATCH_OR_ZV
,
805 /* Move ended at the requested X pixel position. */
808 /* Move within a line ended at the end of a line that must be
812 /* Move within a line ended at the end of a line that would
813 be displayed truncated. */
816 /* Move within a line ended at a line end. */
820 /* This counter is used to clear the face cache every once in a while
821 in redisplay_internal. It is incremented for each redisplay.
822 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
825 #define CLEAR_FACE_CACHE_COUNT 500
826 static int clear_face_cache_count
;
828 /* Similarly for the image cache. */
830 #ifdef HAVE_WINDOW_SYSTEM
831 #define CLEAR_IMAGE_CACHE_COUNT 101
832 static int clear_image_cache_count
;
835 /* Non-zero while redisplay_internal is in progress. */
839 /* Non-zero means don't free realized faces. Bound while freeing
840 realized faces is dangerous because glyph matrices might still
843 int inhibit_free_realized_faces
;
844 Lisp_Object Qinhibit_free_realized_faces
;
846 /* If a string, XTread_socket generates an event to display that string.
847 (The display is done in read_char.) */
849 Lisp_Object help_echo_string
;
850 Lisp_Object help_echo_window
;
851 Lisp_Object help_echo_object
;
854 /* Temporary variable for XTread_socket. */
856 Lisp_Object previous_help_echo_string
;
858 /* Null glyph slice */
860 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
862 /* Platform-independent portion of hourglass implementation. */
864 /* Non-zero means we're allowed to display a hourglass pointer. */
865 int display_hourglass_p
;
867 /* Non-zero means an hourglass cursor is currently shown. */
868 int hourglass_shown_p
;
870 /* If non-null, an asynchronous timer that, when it expires, displays
871 an hourglass cursor on all frames. */
872 struct atimer
*hourglass_atimer
;
874 /* Number of seconds to wait before displaying an hourglass cursor. */
875 Lisp_Object Vhourglass_delay
;
877 /* Default number of seconds to wait before displaying an hourglass
879 #define DEFAULT_HOURGLASS_DELAY 1
882 /* Function prototypes. */
884 static void setup_for_ellipsis
P_ ((struct it
*, int));
885 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
886 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
887 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
888 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
889 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
890 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
892 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
894 static void handle_line_prefix
P_ ((struct it
*));
896 static void pint2str
P_ ((char *, int, int));
897 static void pint2hrstr
P_ ((char *, int, int));
898 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
900 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
901 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
902 static void store_mode_line_noprop_char
P_ ((char));
903 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
904 static void x_consider_frame_title
P_ ((Lisp_Object
));
905 static void handle_stop
P_ ((struct it
*));
906 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
907 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
908 static void ensure_echo_area_buffers
P_ ((void));
909 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
910 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
911 static int with_echo_area_buffer
P_ ((struct window
*, int,
912 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
913 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
914 static void clear_garbaged_frames
P_ ((void));
915 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
916 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
917 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
918 static int display_echo_area
P_ ((struct window
*));
919 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
920 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
921 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
922 static int string_char_and_length
P_ ((const unsigned char *, int *));
923 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
925 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
926 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
927 static void insert_left_trunc_glyphs
P_ ((struct it
*));
928 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
930 static void extend_face_to_end_of_line
P_ ((struct it
*));
931 static int append_space_for_newline
P_ ((struct it
*, int));
932 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
933 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
934 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
935 static int trailing_whitespace_p
P_ ((int));
936 static int message_log_check_duplicate
P_ ((int, int, int, int));
937 static void push_it
P_ ((struct it
*));
938 static void pop_it
P_ ((struct it
*));
939 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
940 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
941 static void redisplay_internal
P_ ((int));
942 static int echo_area_display
P_ ((int));
943 static void redisplay_windows
P_ ((Lisp_Object
));
944 static void redisplay_window
P_ ((Lisp_Object
, int));
945 static Lisp_Object
redisplay_window_error ();
946 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
947 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
948 static int update_menu_bar
P_ ((struct frame
*, int, int));
949 static int try_window_reusing_current_matrix
P_ ((struct window
*));
950 static int try_window_id
P_ ((struct window
*));
951 static int display_line
P_ ((struct it
*));
952 static int display_mode_lines
P_ ((struct window
*));
953 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
954 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
955 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
956 static char *decode_mode_spec
P_ ((struct window
*, int, int, int,
958 static void display_menu_bar
P_ ((struct window
*));
959 static int display_count_lines
P_ ((int, int, int, int, int *));
960 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
961 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
962 static void compute_line_metrics
P_ ((struct it
*));
963 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
964 static int get_overlay_strings
P_ ((struct it
*, int));
965 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
966 static void next_overlay_string
P_ ((struct it
*));
967 static void reseat
P_ ((struct it
*, struct text_pos
, int));
968 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
969 static void back_to_previous_visible_line_start
P_ ((struct it
*));
970 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
971 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
972 static int next_element_from_ellipsis
P_ ((struct it
*));
973 static int next_element_from_display_vector
P_ ((struct it
*));
974 static int next_element_from_string
P_ ((struct it
*));
975 static int next_element_from_c_string
P_ ((struct it
*));
976 static int next_element_from_buffer
P_ ((struct it
*));
977 static int next_element_from_composition
P_ ((struct it
*));
978 static int next_element_from_image
P_ ((struct it
*));
979 static int next_element_from_stretch
P_ ((struct it
*));
980 static void load_overlay_strings
P_ ((struct it
*, int));
981 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
982 struct display_pos
*));
983 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
984 Lisp_Object
, int, int, int, int));
985 static enum move_it_result
986 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
987 enum move_operation_enum
);
988 void move_it_vertically_backward
P_ ((struct it
*, int));
989 static void init_to_row_start
P_ ((struct it
*, struct window
*,
990 struct glyph_row
*));
991 static int init_to_row_end
P_ ((struct it
*, struct window
*,
992 struct glyph_row
*));
993 static void back_to_previous_line_start
P_ ((struct it
*));
994 static int forward_to_next_line_start
P_ ((struct it
*, int *));
995 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
997 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
998 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
999 static int number_of_chars
P_ ((unsigned char *, int));
1000 static void compute_stop_pos
P_ ((struct it
*));
1001 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
1003 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
1004 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
1005 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
1006 Lisp_Object
, Lisp_Object
,
1007 struct text_pos
*, int));
1008 static int underlying_face_id
P_ ((struct it
*));
1009 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
1012 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1013 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1015 #ifdef HAVE_WINDOW_SYSTEM
1017 static void update_tool_bar
P_ ((struct frame
*, int));
1018 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
1019 static int redisplay_tool_bar
P_ ((struct frame
*));
1020 static void display_tool_bar_line
P_ ((struct it
*, int));
1021 static void notice_overwritten_cursor
P_ ((struct window
*,
1022 enum glyph_row_area
,
1023 int, int, int, int));
1027 #endif /* HAVE_WINDOW_SYSTEM */
1030 /***********************************************************************
1031 Window display dimensions
1032 ***********************************************************************/
1034 /* Return the bottom boundary y-position for text lines in window W.
1035 This is the first y position at which a line cannot start.
1036 It is relative to the top of the window.
1038 This is the height of W minus the height of a mode line, if any. */
1041 window_text_bottom_y (w
)
1044 int height
= WINDOW_TOTAL_HEIGHT (w
);
1046 if (WINDOW_WANTS_MODELINE_P (w
))
1047 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1051 /* Return the pixel width of display area AREA of window W. AREA < 0
1052 means return the total width of W, not including fringes to
1053 the left and right of the window. */
1056 window_box_width (w
, area
)
1060 int cols
= XFASTINT (w
->total_cols
);
1063 if (!w
->pseudo_window_p
)
1065 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1067 if (area
== TEXT_AREA
)
1069 if (INTEGERP (w
->left_margin_cols
))
1070 cols
-= XFASTINT (w
->left_margin_cols
);
1071 if (INTEGERP (w
->right_margin_cols
))
1072 cols
-= XFASTINT (w
->right_margin_cols
);
1073 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1075 else if (area
== LEFT_MARGIN_AREA
)
1077 cols
= (INTEGERP (w
->left_margin_cols
)
1078 ? XFASTINT (w
->left_margin_cols
) : 0);
1081 else if (area
== RIGHT_MARGIN_AREA
)
1083 cols
= (INTEGERP (w
->right_margin_cols
)
1084 ? XFASTINT (w
->right_margin_cols
) : 0);
1089 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1093 /* Return the pixel height of the display area of window W, not
1094 including mode lines of W, if any. */
1097 window_box_height (w
)
1100 struct frame
*f
= XFRAME (w
->frame
);
1101 int height
= WINDOW_TOTAL_HEIGHT (w
);
1103 xassert (height
>= 0);
1105 /* Note: the code below that determines the mode-line/header-line
1106 height is essentially the same as that contained in the macro
1107 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1108 the appropriate glyph row has its `mode_line_p' flag set,
1109 and if it doesn't, uses estimate_mode_line_height instead. */
1111 if (WINDOW_WANTS_MODELINE_P (w
))
1113 struct glyph_row
*ml_row
1114 = (w
->current_matrix
&& w
->current_matrix
->rows
1115 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1117 if (ml_row
&& ml_row
->mode_line_p
)
1118 height
-= ml_row
->height
;
1120 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1123 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1125 struct glyph_row
*hl_row
1126 = (w
->current_matrix
&& w
->current_matrix
->rows
1127 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1129 if (hl_row
&& hl_row
->mode_line_p
)
1130 height
-= hl_row
->height
;
1132 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1135 /* With a very small font and a mode-line that's taller than
1136 default, we might end up with a negative height. */
1137 return max (0, height
);
1140 /* Return the window-relative coordinate of the left edge of display
1141 area AREA of window W. AREA < 0 means return the left edge of the
1142 whole window, to the right of the left fringe of W. */
1145 window_box_left_offset (w
, area
)
1151 if (w
->pseudo_window_p
)
1154 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1156 if (area
== TEXT_AREA
)
1157 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1158 + window_box_width (w
, LEFT_MARGIN_AREA
));
1159 else if (area
== RIGHT_MARGIN_AREA
)
1160 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1161 + window_box_width (w
, LEFT_MARGIN_AREA
)
1162 + window_box_width (w
, TEXT_AREA
)
1163 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1165 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1166 else if (area
== LEFT_MARGIN_AREA
1167 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1168 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1174 /* Return the window-relative coordinate of the right edge of display
1175 area AREA of window W. AREA < 0 means return the left edge of the
1176 whole window, to the left of the right fringe of W. */
1179 window_box_right_offset (w
, area
)
1183 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1186 /* Return the frame-relative coordinate of the left edge of display
1187 area AREA of window W. AREA < 0 means return the left edge of the
1188 whole window, to the right of the left fringe of W. */
1191 window_box_left (w
, area
)
1195 struct frame
*f
= XFRAME (w
->frame
);
1198 if (w
->pseudo_window_p
)
1199 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1201 x
= (WINDOW_LEFT_EDGE_X (w
)
1202 + window_box_left_offset (w
, area
));
1208 /* Return the frame-relative coordinate of the right edge of display
1209 area AREA of window W. AREA < 0 means return the left edge of the
1210 whole window, to the left of the right fringe of W. */
1213 window_box_right (w
, area
)
1217 return window_box_left (w
, area
) + window_box_width (w
, area
);
1220 /* Get the bounding box of the display area AREA of window W, without
1221 mode lines, in frame-relative coordinates. AREA < 0 means the
1222 whole window, not including the left and right fringes of
1223 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1224 coordinates of the upper-left corner of the box. Return in
1225 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1228 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1231 int *box_x
, *box_y
, *box_width
, *box_height
;
1234 *box_width
= window_box_width (w
, area
);
1236 *box_height
= window_box_height (w
);
1238 *box_x
= window_box_left (w
, area
);
1241 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1242 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1243 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1248 /* Get the bounding box of the display area AREA of window W, without
1249 mode lines. AREA < 0 means the whole window, not including the
1250 left and right fringe of the window. Return in *TOP_LEFT_X
1251 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1252 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1253 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1257 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1258 bottom_right_x
, bottom_right_y
)
1261 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1263 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1265 *bottom_right_x
+= *top_left_x
;
1266 *bottom_right_y
+= *top_left_y
;
1271 /***********************************************************************
1273 ***********************************************************************/
1275 /* Return the bottom y-position of the line the iterator IT is in.
1276 This can modify IT's settings. */
1282 int line_height
= it
->max_ascent
+ it
->max_descent
;
1283 int line_top_y
= it
->current_y
;
1285 if (line_height
== 0)
1288 line_height
= last_height
;
1289 else if (IT_CHARPOS (*it
) < ZV
)
1291 move_it_by_lines (it
, 1, 1);
1292 line_height
= (it
->max_ascent
|| it
->max_descent
1293 ? it
->max_ascent
+ it
->max_descent
1298 struct glyph_row
*row
= it
->glyph_row
;
1300 /* Use the default character height. */
1301 it
->glyph_row
= NULL
;
1302 it
->what
= IT_CHARACTER
;
1305 PRODUCE_GLYPHS (it
);
1306 line_height
= it
->ascent
+ it
->descent
;
1307 it
->glyph_row
= row
;
1311 return line_top_y
+ line_height
;
1315 /* Return 1 if position CHARPOS is visible in window W.
1316 CHARPOS < 0 means return info about WINDOW_END position.
1317 If visible, set *X and *Y to pixel coordinates of top left corner.
1318 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1319 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1322 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1324 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1327 struct text_pos top
;
1329 struct buffer
*old_buffer
= NULL
;
1331 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1334 if (XBUFFER (w
->buffer
) != current_buffer
)
1336 old_buffer
= current_buffer
;
1337 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1340 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1342 /* Compute exact mode line heights. */
1343 if (WINDOW_WANTS_MODELINE_P (w
))
1344 current_mode_line_height
1345 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1346 current_buffer
->mode_line_format
);
1348 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1349 current_header_line_height
1350 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1351 current_buffer
->header_line_format
);
1353 start_display (&it
, w
, top
);
1354 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1355 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1357 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1359 /* We have reached CHARPOS, or passed it. How the call to
1360 move_it_to can overshoot: (i) If CHARPOS is on invisible
1361 text, move_it_to stops at the end of the invisible text,
1362 after CHARPOS. (ii) If CHARPOS is in a display vector,
1363 move_it_to stops on its last glyph. */
1364 int top_x
= it
.current_x
;
1365 int top_y
= it
.current_y
;
1366 enum it_method it_method
= it
.method
;
1367 /* Calling line_bottom_y may change it.method, it.position, etc. */
1368 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1369 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1371 if (top_y
< window_top_y
)
1372 visible_p
= bottom_y
> window_top_y
;
1373 else if (top_y
< it
.last_visible_y
)
1377 if (it_method
== GET_FROM_BUFFER
)
1379 Lisp_Object window
, prop
;
1381 XSETWINDOW (window
, w
);
1382 prop
= Fget_char_property (make_number (charpos
),
1383 Qinvisible
, window
);
1385 /* If charpos coincides with invisible text covered with an
1386 ellipsis, use the first glyph of the ellipsis to compute
1387 the pixel positions. */
1388 if (TEXT_PROP_MEANS_INVISIBLE (prop
) == 2)
1390 struct glyph_row
*row
= it
.glyph_row
;
1391 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1392 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1396 && (!BUFFERP (glyph
->object
)
1397 || glyph
->charpos
< charpos
);
1399 x
+= glyph
->pixel_width
;
1403 else if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1405 /* We stopped on the last glyph of a display vector.
1406 Try and recompute. Hack alert! */
1407 if (charpos
< 2 || top
.charpos
>= charpos
)
1408 top_x
= it
.glyph_row
->x
;
1412 start_display (&it2
, w
, top
);
1413 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1414 get_next_display_element (&it2
);
1415 PRODUCE_GLYPHS (&it2
);
1416 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1417 || it2
.current_x
> it2
.last_visible_x
)
1418 top_x
= it
.glyph_row
->x
;
1421 top_x
= it2
.current_x
;
1422 top_y
= it2
.current_y
;
1428 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1429 *rtop
= max (0, window_top_y
- top_y
);
1430 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1431 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1432 - max (top_y
, window_top_y
)));
1441 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1442 move_it_by_lines (&it
, 1, 0);
1443 if (charpos
< IT_CHARPOS (it
)
1444 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1447 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1449 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1450 *rtop
= max (0, -it2
.current_y
);
1451 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1452 - it
.last_visible_y
));
1453 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1455 - max (it2
.current_y
,
1456 WINDOW_HEADER_LINE_HEIGHT (w
))));
1462 set_buffer_internal_1 (old_buffer
);
1464 current_header_line_height
= current_mode_line_height
= -1;
1466 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1467 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1470 /* Debugging code. */
1472 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1473 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1475 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1482 /* Return the next character from STR which is MAXLEN bytes long.
1483 Return in *LEN the length of the character. This is like
1484 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1485 we find one, we return a `?', but with the length of the invalid
1489 string_char_and_length (str
, len
)
1490 const unsigned char *str
;
1495 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1496 if (!CHAR_VALID_P (c
, 1))
1497 /* We may not change the length here because other places in Emacs
1498 don't use this function, i.e. they silently accept invalid
1507 /* Given a position POS containing a valid character and byte position
1508 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1510 static struct text_pos
1511 string_pos_nchars_ahead (pos
, string
, nchars
)
1512 struct text_pos pos
;
1516 xassert (STRINGP (string
) && nchars
>= 0);
1518 if (STRING_MULTIBYTE (string
))
1520 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1521 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1526 string_char_and_length (p
, &len
);
1527 p
+= len
, rest
-= len
;
1528 xassert (rest
>= 0);
1530 BYTEPOS (pos
) += len
;
1534 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1540 /* Value is the text position, i.e. character and byte position,
1541 for character position CHARPOS in STRING. */
1543 static INLINE
struct text_pos
1544 string_pos (charpos
, string
)
1548 struct text_pos pos
;
1549 xassert (STRINGP (string
));
1550 xassert (charpos
>= 0);
1551 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1556 /* Value is a text position, i.e. character and byte position, for
1557 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1558 means recognize multibyte characters. */
1560 static struct text_pos
1561 c_string_pos (charpos
, s
, multibyte_p
)
1566 struct text_pos pos
;
1568 xassert (s
!= NULL
);
1569 xassert (charpos
>= 0);
1573 int rest
= strlen (s
), len
;
1575 SET_TEXT_POS (pos
, 0, 0);
1578 string_char_and_length (s
, &len
);
1579 s
+= len
, rest
-= len
;
1580 xassert (rest
>= 0);
1582 BYTEPOS (pos
) += len
;
1586 SET_TEXT_POS (pos
, charpos
, charpos
);
1592 /* Value is the number of characters in C string S. MULTIBYTE_P
1593 non-zero means recognize multibyte characters. */
1596 number_of_chars (s
, multibyte_p
)
1604 int rest
= strlen (s
), len
;
1605 unsigned char *p
= (unsigned char *) s
;
1607 for (nchars
= 0; rest
> 0; ++nchars
)
1609 string_char_and_length (p
, &len
);
1610 rest
-= len
, p
+= len
;
1614 nchars
= strlen (s
);
1620 /* Compute byte position NEWPOS->bytepos corresponding to
1621 NEWPOS->charpos. POS is a known position in string STRING.
1622 NEWPOS->charpos must be >= POS.charpos. */
1625 compute_string_pos (newpos
, pos
, string
)
1626 struct text_pos
*newpos
, pos
;
1629 xassert (STRINGP (string
));
1630 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1632 if (STRING_MULTIBYTE (string
))
1633 *newpos
= string_pos_nchars_ahead (pos
, string
,
1634 CHARPOS (*newpos
) - CHARPOS (pos
));
1636 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1640 Return an estimation of the pixel height of mode or header lines on
1641 frame F. FACE_ID specifies what line's height to estimate. */
1644 estimate_mode_line_height (f
, face_id
)
1646 enum face_id face_id
;
1648 #ifdef HAVE_WINDOW_SYSTEM
1649 if (FRAME_WINDOW_P (f
))
1651 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1653 /* This function is called so early when Emacs starts that the face
1654 cache and mode line face are not yet initialized. */
1655 if (FRAME_FACE_CACHE (f
))
1657 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1661 height
= FONT_HEIGHT (face
->font
);
1662 if (face
->box_line_width
> 0)
1663 height
+= 2 * face
->box_line_width
;
1674 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1675 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1676 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1677 not force the value into range. */
1680 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1682 register int pix_x
, pix_y
;
1684 NativeRectangle
*bounds
;
1688 #ifdef HAVE_WINDOW_SYSTEM
1689 if (FRAME_WINDOW_P (f
))
1691 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1692 even for negative values. */
1694 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1696 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1698 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1699 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1702 STORE_NATIVE_RECT (*bounds
,
1703 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1704 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1705 FRAME_COLUMN_WIDTH (f
) - 1,
1706 FRAME_LINE_HEIGHT (f
) - 1);
1712 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1713 pix_x
= FRAME_TOTAL_COLS (f
);
1717 else if (pix_y
> FRAME_LINES (f
))
1718 pix_y
= FRAME_LINES (f
);
1728 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1729 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1730 can't tell the positions because W's display is not up to date,
1734 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1737 int *frame_x
, *frame_y
;
1739 #ifdef HAVE_WINDOW_SYSTEM
1740 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1744 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1745 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1747 if (display_completed
)
1749 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1750 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1751 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1757 hpos
+= glyph
->pixel_width
;
1761 /* If first glyph is partially visible, its first visible position is still 0. */
1773 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1774 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1785 #ifdef HAVE_WINDOW_SYSTEM
1787 /* Find the glyph under window-relative coordinates X/Y in window W.
1788 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1789 strings. Return in *HPOS and *VPOS the row and column number of
1790 the glyph found. Return in *AREA the glyph area containing X.
1791 Value is a pointer to the glyph found or null if X/Y is not on
1792 text, or we can't tell because W's current matrix is not up to
1797 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1800 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1802 struct glyph
*glyph
, *end
;
1803 struct glyph_row
*row
= NULL
;
1806 /* Find row containing Y. Give up if some row is not enabled. */
1807 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1809 row
= MATRIX_ROW (w
->current_matrix
, i
);
1810 if (!row
->enabled_p
)
1812 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1819 /* Give up if Y is not in the window. */
1820 if (i
== w
->current_matrix
->nrows
)
1823 /* Get the glyph area containing X. */
1824 if (w
->pseudo_window_p
)
1831 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1833 *area
= LEFT_MARGIN_AREA
;
1834 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1836 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1839 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1843 *area
= RIGHT_MARGIN_AREA
;
1844 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1848 /* Find glyph containing X. */
1849 glyph
= row
->glyphs
[*area
];
1850 end
= glyph
+ row
->used
[*area
];
1852 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1854 x
-= glyph
->pixel_width
;
1864 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1867 *hpos
= glyph
- row
->glyphs
[*area
];
1873 Convert frame-relative x/y to coordinates relative to window W.
1874 Takes pseudo-windows into account. */
1877 frame_to_window_pixel_xy (w
, x
, y
)
1881 if (w
->pseudo_window_p
)
1883 /* A pseudo-window is always full-width, and starts at the
1884 left edge of the frame, plus a frame border. */
1885 struct frame
*f
= XFRAME (w
->frame
);
1886 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1887 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1891 *x
-= WINDOW_LEFT_EDGE_X (w
);
1892 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1897 Return in RECTS[] at most N clipping rectangles for glyph string S.
1898 Return the number of stored rectangles. */
1901 get_glyph_string_clip_rects (s
, rects
, n
)
1902 struct glyph_string
*s
;
1903 NativeRectangle
*rects
;
1911 if (s
->row
->full_width_p
)
1913 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1914 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1915 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1917 /* Unless displaying a mode or menu bar line, which are always
1918 fully visible, clip to the visible part of the row. */
1919 if (s
->w
->pseudo_window_p
)
1920 r
.height
= s
->row
->visible_height
;
1922 r
.height
= s
->height
;
1926 /* This is a text line that may be partially visible. */
1927 r
.x
= window_box_left (s
->w
, s
->area
);
1928 r
.width
= window_box_width (s
->w
, s
->area
);
1929 r
.height
= s
->row
->visible_height
;
1933 if (r
.x
< s
->clip_head
->x
)
1935 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1936 r
.width
-= s
->clip_head
->x
- r
.x
;
1939 r
.x
= s
->clip_head
->x
;
1942 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1944 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1945 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1950 /* If S draws overlapping rows, it's sufficient to use the top and
1951 bottom of the window for clipping because this glyph string
1952 intentionally draws over other lines. */
1953 if (s
->for_overlaps
)
1955 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1956 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1958 /* Alas, the above simple strategy does not work for the
1959 environments with anti-aliased text: if the same text is
1960 drawn onto the same place multiple times, it gets thicker.
1961 If the overlap we are processing is for the erased cursor, we
1962 take the intersection with the rectagle of the cursor. */
1963 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1965 XRectangle rc
, r_save
= r
;
1967 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1968 rc
.y
= s
->w
->phys_cursor
.y
;
1969 rc
.width
= s
->w
->phys_cursor_width
;
1970 rc
.height
= s
->w
->phys_cursor_height
;
1972 x_intersect_rectangles (&r_save
, &rc
, &r
);
1977 /* Don't use S->y for clipping because it doesn't take partially
1978 visible lines into account. For example, it can be negative for
1979 partially visible lines at the top of a window. */
1980 if (!s
->row
->full_width_p
1981 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1982 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1984 r
.y
= max (0, s
->row
->y
);
1987 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1989 /* If drawing the cursor, don't let glyph draw outside its
1990 advertised boundaries. Cleartype does this under some circumstances. */
1991 if (s
->hl
== DRAW_CURSOR
)
1993 struct glyph
*glyph
= s
->first_glyph
;
1998 r
.width
-= s
->x
- r
.x
;
2001 r
.width
= min (r
.width
, glyph
->pixel_width
);
2003 /* If r.y is below window bottom, ensure that we still see a cursor. */
2004 height
= min (glyph
->ascent
+ glyph
->descent
,
2005 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2006 max_y
= window_text_bottom_y (s
->w
) - height
;
2007 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2008 if (s
->ybase
- glyph
->ascent
> max_y
)
2015 /* Don't draw cursor glyph taller than our actual glyph. */
2016 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2017 if (height
< r
.height
)
2019 max_y
= r
.y
+ r
.height
;
2020 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2021 r
.height
= min (max_y
- r
.y
, height
);
2028 XRectangle r_save
= r
;
2030 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2034 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2035 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2037 #ifdef CONVERT_FROM_XRECT
2038 CONVERT_FROM_XRECT (r
, *rects
);
2046 /* If we are processing overlapping and allowed to return
2047 multiple clipping rectangles, we exclude the row of the glyph
2048 string from the clipping rectangle. This is to avoid drawing
2049 the same text on the environment with anti-aliasing. */
2050 #ifdef CONVERT_FROM_XRECT
2053 XRectangle
*rs
= rects
;
2055 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2057 if (s
->for_overlaps
& OVERLAPS_PRED
)
2060 if (r
.y
+ r
.height
> row_y
)
2063 rs
[i
].height
= row_y
- r
.y
;
2069 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2072 if (r
.y
< row_y
+ s
->row
->visible_height
)
2074 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2076 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2077 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2086 #ifdef CONVERT_FROM_XRECT
2087 for (i
= 0; i
< n
; i
++)
2088 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2095 Return in *NR the clipping rectangle for glyph string S. */
2098 get_glyph_string_clip_rect (s
, nr
)
2099 struct glyph_string
*s
;
2100 NativeRectangle
*nr
;
2102 get_glyph_string_clip_rects (s
, nr
, 1);
2107 Return the position and height of the phys cursor in window W.
2108 Set w->phys_cursor_width to width of phys cursor.
2112 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2114 struct glyph_row
*row
;
2115 struct glyph
*glyph
;
2116 int *xp
, *yp
, *heightp
;
2118 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2119 int x
, y
, wd
, h
, h0
, y0
;
2121 /* Compute the width of the rectangle to draw. If on a stretch
2122 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2123 rectangle as wide as the glyph, but use a canonical character
2125 wd
= glyph
->pixel_width
- 1;
2126 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2130 x
= w
->phys_cursor
.x
;
2137 if (glyph
->type
== STRETCH_GLYPH
2138 && !x_stretch_cursor_p
)
2139 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2140 w
->phys_cursor_width
= wd
;
2142 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2144 /* If y is below window bottom, ensure that we still see a cursor. */
2145 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2147 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2148 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2150 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2153 h
= max (h
- (y0
- y
) + 1, h0
);
2158 y0
= window_text_bottom_y (w
) - h0
;
2166 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2167 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2172 * Remember which glyph the mouse is over.
2176 remember_mouse_glyph (f
, gx
, gy
, rect
)
2179 NativeRectangle
*rect
;
2183 struct glyph_row
*r
, *gr
, *end_row
;
2184 enum window_part part
;
2185 enum glyph_row_area area
;
2186 int x
, y
, width
, height
;
2188 /* Try to determine frame pixel position and size of the glyph under
2189 frame pixel coordinates X/Y on frame F. */
2191 if (!f
->glyphs_initialized_p
2192 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2195 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2196 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2200 w
= XWINDOW (window
);
2201 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2202 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2204 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2205 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2207 if (w
->pseudo_window_p
)
2210 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2216 case ON_LEFT_MARGIN
:
2217 area
= LEFT_MARGIN_AREA
;
2220 case ON_RIGHT_MARGIN
:
2221 area
= RIGHT_MARGIN_AREA
;
2224 case ON_HEADER_LINE
:
2226 gr
= (part
== ON_HEADER_LINE
2227 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2228 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2231 goto text_glyph_row_found
;
2238 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2239 if (r
->y
+ r
->height
> y
)
2245 text_glyph_row_found
:
2248 struct glyph
*g
= gr
->glyphs
[area
];
2249 struct glyph
*end
= g
+ gr
->used
[area
];
2251 height
= gr
->height
;
2252 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2253 if (gx
+ g
->pixel_width
> x
)
2258 if (g
->type
== IMAGE_GLYPH
)
2260 /* Don't remember when mouse is over image, as
2261 image may have hot-spots. */
2262 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2265 width
= g
->pixel_width
;
2269 /* Use nominal char spacing at end of line. */
2271 gx
+= (x
/ width
) * width
;
2274 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2275 gx
+= window_box_left_offset (w
, area
);
2279 /* Use nominal line height at end of window. */
2280 gx
= (x
/ width
) * width
;
2282 gy
+= (y
/ height
) * height
;
2286 case ON_LEFT_FRINGE
:
2287 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2288 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2289 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2290 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2293 case ON_RIGHT_FRINGE
:
2294 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2295 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2296 : window_box_right_offset (w
, TEXT_AREA
));
2297 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2301 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2303 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2304 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2305 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2307 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2311 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2312 if (r
->y
+ r
->height
> y
)
2319 height
= gr
->height
;
2322 /* Use nominal line height at end of window. */
2324 gy
+= (y
/ height
) * height
;
2331 /* If there is no glyph under the mouse, then we divide the screen
2332 into a grid of the smallest glyph in the frame, and use that
2335 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2336 round down even for negative values. */
2342 gx
= (gx
/ width
) * width
;
2343 gy
= (gy
/ height
) * height
;
2348 gx
+= WINDOW_LEFT_EDGE_X (w
);
2349 gy
+= WINDOW_TOP_EDGE_Y (w
);
2352 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2354 /* Visible feedback for debugging. */
2357 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2358 f
->output_data
.x
->normal_gc
,
2359 gx
, gy
, width
, height
);
2365 #endif /* HAVE_WINDOW_SYSTEM */
2368 /***********************************************************************
2369 Lisp form evaluation
2370 ***********************************************************************/
2372 /* Error handler for safe_eval and safe_call. */
2375 safe_eval_handler (arg
)
2378 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2383 /* Evaluate SEXPR and return the result, or nil if something went
2384 wrong. Prevent redisplay during the evaluation. */
2386 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2387 Return the result, or nil if something went wrong. Prevent
2388 redisplay during the evaluation. */
2391 safe_call (nargs
, args
)
2397 if (inhibit_eval_during_redisplay
)
2401 int count
= SPECPDL_INDEX ();
2402 struct gcpro gcpro1
;
2405 gcpro1
.nvars
= nargs
;
2406 specbind (Qinhibit_redisplay
, Qt
);
2407 /* Use Qt to ensure debugger does not run,
2408 so there is no possibility of wanting to redisplay. */
2409 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2412 val
= unbind_to (count
, val
);
2419 /* Call function FN with one argument ARG.
2420 Return the result, or nil if something went wrong. */
2423 safe_call1 (fn
, arg
)
2424 Lisp_Object fn
, arg
;
2426 Lisp_Object args
[2];
2429 return safe_call (2, args
);
2432 static Lisp_Object Qeval
;
2435 safe_eval (Lisp_Object sexpr
)
2437 return safe_call1 (Qeval
, sexpr
);
2440 /* Call function FN with one argument ARG.
2441 Return the result, or nil if something went wrong. */
2444 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2446 Lisp_Object args
[3];
2450 return safe_call (3, args
);
2455 /***********************************************************************
2457 ***********************************************************************/
2461 /* Define CHECK_IT to perform sanity checks on iterators.
2462 This is for debugging. It is too slow to do unconditionally. */
2468 if (it
->method
== GET_FROM_STRING
)
2470 xassert (STRINGP (it
->string
));
2471 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2475 xassert (IT_STRING_CHARPOS (*it
) < 0);
2476 if (it
->method
== GET_FROM_BUFFER
)
2478 /* Check that character and byte positions agree. */
2479 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2484 xassert (it
->current
.dpvec_index
>= 0);
2486 xassert (it
->current
.dpvec_index
< 0);
2489 #define CHECK_IT(IT) check_it ((IT))
2493 #define CHECK_IT(IT) (void) 0
2500 /* Check that the window end of window W is what we expect it
2501 to be---the last row in the current matrix displaying text. */
2504 check_window_end (w
)
2507 if (!MINI_WINDOW_P (w
)
2508 && !NILP (w
->window_end_valid
))
2510 struct glyph_row
*row
;
2511 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2512 XFASTINT (w
->window_end_vpos
)),
2514 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2515 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2519 #define CHECK_WINDOW_END(W) check_window_end ((W))
2521 #else /* not GLYPH_DEBUG */
2523 #define CHECK_WINDOW_END(W) (void) 0
2525 #endif /* not GLYPH_DEBUG */
2529 /***********************************************************************
2530 Iterator initialization
2531 ***********************************************************************/
2533 /* Initialize IT for displaying current_buffer in window W, starting
2534 at character position CHARPOS. CHARPOS < 0 means that no buffer
2535 position is specified which is useful when the iterator is assigned
2536 a position later. BYTEPOS is the byte position corresponding to
2537 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2539 If ROW is not null, calls to produce_glyphs with IT as parameter
2540 will produce glyphs in that row.
2542 BASE_FACE_ID is the id of a base face to use. It must be one of
2543 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2544 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2545 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2547 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2548 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2549 will be initialized to use the corresponding mode line glyph row of
2550 the desired matrix of W. */
2553 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2556 int charpos
, bytepos
;
2557 struct glyph_row
*row
;
2558 enum face_id base_face_id
;
2560 int highlight_region_p
;
2561 enum face_id remapped_base_face_id
= base_face_id
;
2563 /* Some precondition checks. */
2564 xassert (w
!= NULL
&& it
!= NULL
);
2565 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2568 /* If face attributes have been changed since the last redisplay,
2569 free realized faces now because they depend on face definitions
2570 that might have changed. Don't free faces while there might be
2571 desired matrices pending which reference these faces. */
2572 if (face_change_count
&& !inhibit_free_realized_faces
)
2574 face_change_count
= 0;
2575 free_all_realized_faces (Qnil
);
2578 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2579 if (! NILP (Vface_remapping_alist
))
2580 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2582 /* Use one of the mode line rows of W's desired matrix if
2586 if (base_face_id
== MODE_LINE_FACE_ID
2587 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2588 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2589 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2590 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2594 bzero (it
, sizeof *it
);
2595 it
->current
.overlay_string_index
= -1;
2596 it
->current
.dpvec_index
= -1;
2597 it
->base_face_id
= remapped_base_face_id
;
2599 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2601 /* The window in which we iterate over current_buffer: */
2602 XSETWINDOW (it
->window
, w
);
2604 it
->f
= XFRAME (w
->frame
);
2608 /* Extra space between lines (on window systems only). */
2609 if (base_face_id
== DEFAULT_FACE_ID
2610 && FRAME_WINDOW_P (it
->f
))
2612 if (NATNUMP (current_buffer
->extra_line_spacing
))
2613 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2614 else if (FLOATP (current_buffer
->extra_line_spacing
))
2615 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2616 * FRAME_LINE_HEIGHT (it
->f
));
2617 else if (it
->f
->extra_line_spacing
> 0)
2618 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2619 it
->max_extra_line_spacing
= 0;
2622 /* If realized faces have been removed, e.g. because of face
2623 attribute changes of named faces, recompute them. When running
2624 in batch mode, the face cache of the initial frame is null. If
2625 we happen to get called, make a dummy face cache. */
2626 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2627 init_frame_faces (it
->f
);
2628 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2629 recompute_basic_faces (it
->f
);
2631 /* Current value of the `slice', `space-width', and 'height' properties. */
2632 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2633 it
->space_width
= Qnil
;
2634 it
->font_height
= Qnil
;
2635 it
->override_ascent
= -1;
2637 /* Are control characters displayed as `^C'? */
2638 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2640 /* -1 means everything between a CR and the following line end
2641 is invisible. >0 means lines indented more than this value are
2643 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2644 ? XFASTINT (current_buffer
->selective_display
)
2645 : (!NILP (current_buffer
->selective_display
)
2647 it
->selective_display_ellipsis_p
2648 = !NILP (current_buffer
->selective_display_ellipses
);
2650 /* Display table to use. */
2651 it
->dp
= window_display_table (w
);
2653 /* Are multibyte characters enabled in current_buffer? */
2654 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2656 /* Non-zero if we should highlight the region. */
2658 = (!NILP (Vtransient_mark_mode
)
2659 && !NILP (current_buffer
->mark_active
)
2660 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2662 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2663 start and end of a visible region in window IT->w. Set both to
2664 -1 to indicate no region. */
2665 if (highlight_region_p
2666 /* Maybe highlight only in selected window. */
2667 && (/* Either show region everywhere. */
2668 highlight_nonselected_windows
2669 /* Or show region in the selected window. */
2670 || w
== XWINDOW (selected_window
)
2671 /* Or show the region if we are in the mini-buffer and W is
2672 the window the mini-buffer refers to. */
2673 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2674 && WINDOWP (minibuf_selected_window
)
2675 && w
== XWINDOW (minibuf_selected_window
))))
2677 int charpos
= marker_position (current_buffer
->mark
);
2678 it
->region_beg_charpos
= min (PT
, charpos
);
2679 it
->region_end_charpos
= max (PT
, charpos
);
2682 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2684 /* Get the position at which the redisplay_end_trigger hook should
2685 be run, if it is to be run at all. */
2686 if (MARKERP (w
->redisplay_end_trigger
)
2687 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2688 it
->redisplay_end_trigger_charpos
2689 = marker_position (w
->redisplay_end_trigger
);
2690 else if (INTEGERP (w
->redisplay_end_trigger
))
2691 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2693 /* Correct bogus values of tab_width. */
2694 it
->tab_width
= XINT (current_buffer
->tab_width
);
2695 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2698 /* Are lines in the display truncated? */
2699 if (base_face_id
!= DEFAULT_FACE_ID
2700 || XINT (it
->w
->hscroll
)
2701 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2702 && ((!NILP (Vtruncate_partial_width_windows
)
2703 && !INTEGERP (Vtruncate_partial_width_windows
))
2704 || (INTEGERP (Vtruncate_partial_width_windows
)
2705 && (WINDOW_TOTAL_COLS (it
->w
)
2706 < XINT (Vtruncate_partial_width_windows
))))))
2707 it
->line_wrap
= TRUNCATE
;
2708 else if (NILP (current_buffer
->truncate_lines
))
2709 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2710 ? WINDOW_WRAP
: WORD_WRAP
;
2712 it
->line_wrap
= TRUNCATE
;
2714 /* Get dimensions of truncation and continuation glyphs. These are
2715 displayed as fringe bitmaps under X, so we don't need them for such
2717 if (!FRAME_WINDOW_P (it
->f
))
2719 if (it
->line_wrap
== TRUNCATE
)
2721 /* We will need the truncation glyph. */
2722 xassert (it
->glyph_row
== NULL
);
2723 produce_special_glyphs (it
, IT_TRUNCATION
);
2724 it
->truncation_pixel_width
= it
->pixel_width
;
2728 /* We will need the continuation glyph. */
2729 xassert (it
->glyph_row
== NULL
);
2730 produce_special_glyphs (it
, IT_CONTINUATION
);
2731 it
->continuation_pixel_width
= it
->pixel_width
;
2734 /* Reset these values to zero because the produce_special_glyphs
2735 above has changed them. */
2736 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2737 it
->phys_ascent
= it
->phys_descent
= 0;
2740 /* Set this after getting the dimensions of truncation and
2741 continuation glyphs, so that we don't produce glyphs when calling
2742 produce_special_glyphs, above. */
2743 it
->glyph_row
= row
;
2744 it
->area
= TEXT_AREA
;
2746 /* Get the dimensions of the display area. The display area
2747 consists of the visible window area plus a horizontally scrolled
2748 part to the left of the window. All x-values are relative to the
2749 start of this total display area. */
2750 if (base_face_id
!= DEFAULT_FACE_ID
)
2752 /* Mode lines, menu bar in terminal frames. */
2753 it
->first_visible_x
= 0;
2754 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2759 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2760 it
->last_visible_x
= (it
->first_visible_x
2761 + window_box_width (w
, TEXT_AREA
));
2763 /* If we truncate lines, leave room for the truncator glyph(s) at
2764 the right margin. Otherwise, leave room for the continuation
2765 glyph(s). Truncation and continuation glyphs are not inserted
2766 for window-based redisplay. */
2767 if (!FRAME_WINDOW_P (it
->f
))
2769 if (it
->line_wrap
== TRUNCATE
)
2770 it
->last_visible_x
-= it
->truncation_pixel_width
;
2772 it
->last_visible_x
-= it
->continuation_pixel_width
;
2775 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2776 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2779 /* Leave room for a border glyph. */
2780 if (!FRAME_WINDOW_P (it
->f
)
2781 && !WINDOW_RIGHTMOST_P (it
->w
))
2782 it
->last_visible_x
-= 1;
2784 it
->last_visible_y
= window_text_bottom_y (w
);
2786 /* For mode lines and alike, arrange for the first glyph having a
2787 left box line if the face specifies a box. */
2788 if (base_face_id
!= DEFAULT_FACE_ID
)
2792 it
->face_id
= remapped_base_face_id
;
2794 /* If we have a boxed mode line, make the first character appear
2795 with a left box line. */
2796 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2797 if (face
->box
!= FACE_NO_BOX
)
2798 it
->start_of_box_run_p
= 1;
2801 /* If a buffer position was specified, set the iterator there,
2802 getting overlays and face properties from that position. */
2803 if (charpos
>= BUF_BEG (current_buffer
))
2805 it
->end_charpos
= ZV
;
2807 IT_CHARPOS (*it
) = charpos
;
2809 /* Compute byte position if not specified. */
2810 if (bytepos
< charpos
)
2811 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2813 IT_BYTEPOS (*it
) = bytepos
;
2815 it
->start
= it
->current
;
2817 /* Compute faces etc. */
2818 reseat (it
, it
->current
.pos
, 1);
2825 /* Initialize IT for the display of window W with window start POS. */
2828 start_display (it
, w
, pos
)
2831 struct text_pos pos
;
2833 struct glyph_row
*row
;
2834 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2836 row
= w
->desired_matrix
->rows
+ first_vpos
;
2837 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2838 it
->first_vpos
= first_vpos
;
2840 /* Don't reseat to previous visible line start if current start
2841 position is in a string or image. */
2842 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2844 int start_at_line_beg_p
;
2845 int first_y
= it
->current_y
;
2847 /* If window start is not at a line start, skip forward to POS to
2848 get the correct continuation lines width. */
2849 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2850 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2851 if (!start_at_line_beg_p
)
2855 reseat_at_previous_visible_line_start (it
);
2856 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2858 new_x
= it
->current_x
+ it
->pixel_width
;
2860 /* If lines are continued, this line may end in the middle
2861 of a multi-glyph character (e.g. a control character
2862 displayed as \003, or in the middle of an overlay
2863 string). In this case move_it_to above will not have
2864 taken us to the start of the continuation line but to the
2865 end of the continued line. */
2866 if (it
->current_x
> 0
2867 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2868 && (/* And glyph doesn't fit on the line. */
2869 new_x
> it
->last_visible_x
2870 /* Or it fits exactly and we're on a window
2872 || (new_x
== it
->last_visible_x
2873 && FRAME_WINDOW_P (it
->f
))))
2875 if (it
->current
.dpvec_index
>= 0
2876 || it
->current
.overlay_string_index
>= 0)
2878 set_iterator_to_next (it
, 1);
2879 move_it_in_display_line_to (it
, -1, -1, 0);
2882 it
->continuation_lines_width
+= it
->current_x
;
2885 /* We're starting a new display line, not affected by the
2886 height of the continued line, so clear the appropriate
2887 fields in the iterator structure. */
2888 it
->max_ascent
= it
->max_descent
= 0;
2889 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2891 it
->current_y
= first_y
;
2893 it
->current_x
= it
->hpos
= 0;
2899 /* Return 1 if POS is a position in ellipses displayed for invisible
2900 text. W is the window we display, for text property lookup. */
2903 in_ellipses_for_invisible_text_p (pos
, w
)
2904 struct display_pos
*pos
;
2907 Lisp_Object prop
, window
;
2909 int charpos
= CHARPOS (pos
->pos
);
2911 /* If POS specifies a position in a display vector, this might
2912 be for an ellipsis displayed for invisible text. We won't
2913 get the iterator set up for delivering that ellipsis unless
2914 we make sure that it gets aware of the invisible text. */
2915 if (pos
->dpvec_index
>= 0
2916 && pos
->overlay_string_index
< 0
2917 && CHARPOS (pos
->string_pos
) < 0
2919 && (XSETWINDOW (window
, w
),
2920 prop
= Fget_char_property (make_number (charpos
),
2921 Qinvisible
, window
),
2922 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2924 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2926 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2933 /* Initialize IT for stepping through current_buffer in window W,
2934 starting at position POS that includes overlay string and display
2935 vector/ control character translation position information. Value
2936 is zero if there are overlay strings with newlines at POS. */
2939 init_from_display_pos (it
, w
, pos
)
2942 struct display_pos
*pos
;
2944 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2945 int i
, overlay_strings_with_newlines
= 0;
2947 /* If POS specifies a position in a display vector, this might
2948 be for an ellipsis displayed for invisible text. We won't
2949 get the iterator set up for delivering that ellipsis unless
2950 we make sure that it gets aware of the invisible text. */
2951 if (in_ellipses_for_invisible_text_p (pos
, w
))
2957 /* Keep in mind: the call to reseat in init_iterator skips invisible
2958 text, so we might end up at a position different from POS. This
2959 is only a problem when POS is a row start after a newline and an
2960 overlay starts there with an after-string, and the overlay has an
2961 invisible property. Since we don't skip invisible text in
2962 display_line and elsewhere immediately after consuming the
2963 newline before the row start, such a POS will not be in a string,
2964 but the call to init_iterator below will move us to the
2966 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2968 /* This only scans the current chunk -- it should scan all chunks.
2969 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2970 to 16 in 22.1 to make this a lesser problem. */
2971 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2973 const char *s
= SDATA (it
->overlay_strings
[i
]);
2974 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2976 while (s
< e
&& *s
!= '\n')
2981 overlay_strings_with_newlines
= 1;
2986 /* If position is within an overlay string, set up IT to the right
2988 if (pos
->overlay_string_index
>= 0)
2992 /* If the first overlay string happens to have a `display'
2993 property for an image, the iterator will be set up for that
2994 image, and we have to undo that setup first before we can
2995 correct the overlay string index. */
2996 if (it
->method
== GET_FROM_IMAGE
)
2999 /* We already have the first chunk of overlay strings in
3000 IT->overlay_strings. Load more until the one for
3001 pos->overlay_string_index is in IT->overlay_strings. */
3002 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3004 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3005 it
->current
.overlay_string_index
= 0;
3008 load_overlay_strings (it
, 0);
3009 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3013 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3014 relative_index
= (it
->current
.overlay_string_index
3015 % OVERLAY_STRING_CHUNK_SIZE
);
3016 it
->string
= it
->overlay_strings
[relative_index
];
3017 xassert (STRINGP (it
->string
));
3018 it
->current
.string_pos
= pos
->string_pos
;
3019 it
->method
= GET_FROM_STRING
;
3022 if (CHARPOS (pos
->string_pos
) >= 0)
3024 /* Recorded position is not in an overlay string, but in another
3025 string. This can only be a string from a `display' property.
3026 IT should already be filled with that string. */
3027 it
->current
.string_pos
= pos
->string_pos
;
3028 xassert (STRINGP (it
->string
));
3031 /* Restore position in display vector translations, control
3032 character translations or ellipses. */
3033 if (pos
->dpvec_index
>= 0)
3035 if (it
->dpvec
== NULL
)
3036 get_next_display_element (it
);
3037 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3038 it
->current
.dpvec_index
= pos
->dpvec_index
;
3042 return !overlay_strings_with_newlines
;
3046 /* Initialize IT for stepping through current_buffer in window W
3047 starting at ROW->start. */
3050 init_to_row_start (it
, w
, row
)
3053 struct glyph_row
*row
;
3055 init_from_display_pos (it
, w
, &row
->start
);
3056 it
->start
= row
->start
;
3057 it
->continuation_lines_width
= row
->continuation_lines_width
;
3062 /* Initialize IT for stepping through current_buffer in window W
3063 starting in the line following ROW, i.e. starting at ROW->end.
3064 Value is zero if there are overlay strings with newlines at ROW's
3068 init_to_row_end (it
, w
, row
)
3071 struct glyph_row
*row
;
3075 if (init_from_display_pos (it
, w
, &row
->end
))
3077 if (row
->continued_p
)
3078 it
->continuation_lines_width
3079 = row
->continuation_lines_width
+ row
->pixel_width
;
3090 /***********************************************************************
3092 ***********************************************************************/
3094 /* Called when IT reaches IT->stop_charpos. Handle text property and
3095 overlay changes. Set IT->stop_charpos to the next position where
3102 enum prop_handled handled
;
3103 int handle_overlay_change_p
;
3107 it
->current
.dpvec_index
= -1;
3108 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3109 it
->ignore_overlay_strings_at_pos_p
= 0;
3112 /* Use face of preceding text for ellipsis (if invisible) */
3113 if (it
->selective_display_ellipsis_p
)
3114 it
->saved_face_id
= it
->face_id
;
3118 handled
= HANDLED_NORMALLY
;
3120 /* Call text property handlers. */
3121 for (p
= it_props
; p
->handler
; ++p
)
3123 handled
= p
->handler (it
);
3125 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3127 else if (handled
== HANDLED_RETURN
)
3129 /* We still want to show before and after strings from
3130 overlays even if the actual buffer text is replaced. */
3131 if (!handle_overlay_change_p
3133 || !get_overlay_strings_1 (it
, 0, 0))
3136 setup_for_ellipsis (it
, 0);
3137 /* When handling a display spec, we might load an
3138 empty string. In that case, discard it here. We
3139 used to discard it in handle_single_display_spec,
3140 but that causes get_overlay_strings_1, above, to
3141 ignore overlay strings that we must check. */
3142 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3146 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3150 it
->ignore_overlay_strings_at_pos_p
= 1;
3151 it
->string_from_display_prop_p
= 0;
3152 handle_overlay_change_p
= 0;
3154 handled
= HANDLED_RECOMPUTE_PROPS
;
3157 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3158 handle_overlay_change_p
= 0;
3161 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3163 /* Don't check for overlay strings below when set to deliver
3164 characters from a display vector. */
3165 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3166 handle_overlay_change_p
= 0;
3168 /* Handle overlay changes.
3169 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3170 if it finds overlays. */
3171 if (handle_overlay_change_p
)
3172 handled
= handle_overlay_change (it
);
3177 setup_for_ellipsis (it
, 0);
3181 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3183 /* Determine where to stop next. */
3184 if (handled
== HANDLED_NORMALLY
)
3185 compute_stop_pos (it
);
3189 /* Compute IT->stop_charpos from text property and overlay change
3190 information for IT's current position. */
3193 compute_stop_pos (it
)
3196 register INTERVAL iv
, next_iv
;
3197 Lisp_Object object
, limit
, position
;
3198 EMACS_INT charpos
, bytepos
;
3200 /* If nowhere else, stop at the end. */
3201 it
->stop_charpos
= it
->end_charpos
;
3203 if (STRINGP (it
->string
))
3205 /* Strings are usually short, so don't limit the search for
3207 object
= it
->string
;
3209 charpos
= IT_STRING_CHARPOS (*it
);
3210 bytepos
= IT_STRING_BYTEPOS (*it
);
3216 /* If next overlay change is in front of the current stop pos
3217 (which is IT->end_charpos), stop there. Note: value of
3218 next_overlay_change is point-max if no overlay change
3220 charpos
= IT_CHARPOS (*it
);
3221 bytepos
= IT_BYTEPOS (*it
);
3222 pos
= next_overlay_change (charpos
);
3223 if (pos
< it
->stop_charpos
)
3224 it
->stop_charpos
= pos
;
3226 /* If showing the region, we have to stop at the region
3227 start or end because the face might change there. */
3228 if (it
->region_beg_charpos
> 0)
3230 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3231 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3232 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3233 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3236 /* Set up variables for computing the stop position from text
3237 property changes. */
3238 XSETBUFFER (object
, current_buffer
);
3239 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3242 /* Get the interval containing IT's position. Value is a null
3243 interval if there isn't such an interval. */
3244 position
= make_number (charpos
);
3245 iv
= validate_interval_range (object
, &position
, &position
, 0);
3246 if (!NULL_INTERVAL_P (iv
))
3248 Lisp_Object values_here
[LAST_PROP_IDX
];
3251 /* Get properties here. */
3252 for (p
= it_props
; p
->handler
; ++p
)
3253 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3255 /* Look for an interval following iv that has different
3257 for (next_iv
= next_interval (iv
);
3258 (!NULL_INTERVAL_P (next_iv
)
3260 || XFASTINT (limit
) > next_iv
->position
));
3261 next_iv
= next_interval (next_iv
))
3263 for (p
= it_props
; p
->handler
; ++p
)
3265 Lisp_Object new_value
;
3267 new_value
= textget (next_iv
->plist
, *p
->name
);
3268 if (!EQ (values_here
[p
->idx
], new_value
))
3276 if (!NULL_INTERVAL_P (next_iv
))
3278 if (INTEGERP (limit
)
3279 && next_iv
->position
>= XFASTINT (limit
))
3280 /* No text property change up to limit. */
3281 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3283 /* Text properties change in next_iv. */
3284 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3288 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3289 it
->stop_charpos
, it
->string
);
3291 xassert (STRINGP (it
->string
)
3292 || (it
->stop_charpos
>= BEGV
3293 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3297 /* Return the position of the next overlay change after POS in
3298 current_buffer. Value is point-max if no overlay change
3299 follows. This is like `next-overlay-change' but doesn't use
3303 next_overlay_change (pos
)
3308 Lisp_Object
*overlays
;
3311 /* Get all overlays at the given position. */
3312 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3314 /* If any of these overlays ends before endpos,
3315 use its ending point instead. */
3316 for (i
= 0; i
< noverlays
; ++i
)
3321 oend
= OVERLAY_END (overlays
[i
]);
3322 oendpos
= OVERLAY_POSITION (oend
);
3323 endpos
= min (endpos
, oendpos
);
3331 /***********************************************************************
3333 ***********************************************************************/
3335 /* Handle changes in the `fontified' property of the current buffer by
3336 calling hook functions from Qfontification_functions to fontify
3339 static enum prop_handled
3340 handle_fontified_prop (it
)
3343 Lisp_Object prop
, pos
;
3344 enum prop_handled handled
= HANDLED_NORMALLY
;
3346 if (!NILP (Vmemory_full
))
3349 /* Get the value of the `fontified' property at IT's current buffer
3350 position. (The `fontified' property doesn't have a special
3351 meaning in strings.) If the value is nil, call functions from
3352 Qfontification_functions. */
3353 if (!STRINGP (it
->string
)
3355 && !NILP (Vfontification_functions
)
3356 && !NILP (Vrun_hooks
)
3357 && (pos
= make_number (IT_CHARPOS (*it
)),
3358 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3359 /* Ignore the special cased nil value always present at EOB since
3360 no amount of fontifying will be able to change it. */
3361 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3363 int count
= SPECPDL_INDEX ();
3366 val
= Vfontification_functions
;
3367 specbind (Qfontification_functions
, Qnil
);
3369 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3370 safe_call1 (val
, pos
);
3373 Lisp_Object globals
, fn
;
3374 struct gcpro gcpro1
, gcpro2
;
3377 GCPRO2 (val
, globals
);
3379 for (; CONSP (val
); val
= XCDR (val
))
3385 /* A value of t indicates this hook has a local
3386 binding; it means to run the global binding too.
3387 In a global value, t should not occur. If it
3388 does, we must ignore it to avoid an endless
3390 for (globals
= Fdefault_value (Qfontification_functions
);
3392 globals
= XCDR (globals
))
3394 fn
= XCAR (globals
);
3396 safe_call1 (fn
, pos
);
3400 safe_call1 (fn
, pos
);
3406 unbind_to (count
, Qnil
);
3408 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3409 something. This avoids an endless loop if they failed to
3410 fontify the text for which reason ever. */
3411 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3412 handled
= HANDLED_RECOMPUTE_PROPS
;
3420 /***********************************************************************
3422 ***********************************************************************/
3424 /* Set up iterator IT from face properties at its current position.
3425 Called from handle_stop. */
3427 static enum prop_handled
3428 handle_face_prop (it
)
3432 EMACS_INT next_stop
;
3434 if (!STRINGP (it
->string
))
3437 = face_at_buffer_position (it
->w
,
3439 it
->region_beg_charpos
,
3440 it
->region_end_charpos
,
3443 + TEXT_PROP_DISTANCE_LIMIT
),
3444 0, it
->base_face_id
);
3446 /* Is this a start of a run of characters with box face?
3447 Caveat: this can be called for a freshly initialized
3448 iterator; face_id is -1 in this case. We know that the new
3449 face will not change until limit, i.e. if the new face has a
3450 box, all characters up to limit will have one. But, as
3451 usual, we don't know whether limit is really the end. */
3452 if (new_face_id
!= it
->face_id
)
3454 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3456 /* If new face has a box but old face has not, this is
3457 the start of a run of characters with box, i.e. it has
3458 a shadow on the left side. The value of face_id of the
3459 iterator will be -1 if this is the initial call that gets
3460 the face. In this case, we have to look in front of IT's
3461 position and see whether there is a face != new_face_id. */
3462 it
->start_of_box_run_p
3463 = (new_face
->box
!= FACE_NO_BOX
3464 && (it
->face_id
>= 0
3465 || IT_CHARPOS (*it
) == BEG
3466 || new_face_id
!= face_before_it_pos (it
)));
3467 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3472 int base_face_id
, bufpos
;
3474 Lisp_Object from_overlay
3475 = (it
->current
.overlay_string_index
>= 0
3476 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3479 /* See if we got to this string directly or indirectly from
3480 an overlay property. That includes the before-string or
3481 after-string of an overlay, strings in display properties
3482 provided by an overlay, their text properties, etc.
3484 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3485 if (! NILP (from_overlay
))
3486 for (i
= it
->sp
- 1; i
>= 0; i
--)
3488 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3490 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3491 else if (! NILP (it
->stack
[i
].from_overlay
))
3492 from_overlay
= it
->stack
[i
].from_overlay
;
3494 if (!NILP (from_overlay
))
3498 if (! NILP (from_overlay
))
3500 bufpos
= IT_CHARPOS (*it
);
3501 /* For a string from an overlay, the base face depends
3502 only on text properties and ignores overlays. */
3504 = face_for_overlay_string (it
->w
,
3506 it
->region_beg_charpos
,
3507 it
->region_end_charpos
,
3510 + TEXT_PROP_DISTANCE_LIMIT
),
3518 /* For strings from a `display' property, use the face at
3519 IT's current buffer position as the base face to merge
3520 with, so that overlay strings appear in the same face as
3521 surrounding text, unless they specify their own
3523 base_face_id
= underlying_face_id (it
);
3526 new_face_id
= face_at_string_position (it
->w
,
3528 IT_STRING_CHARPOS (*it
),
3530 it
->region_beg_charpos
,
3531 it
->region_end_charpos
,
3535 /* Is this a start of a run of characters with box? Caveat:
3536 this can be called for a freshly allocated iterator; face_id
3537 is -1 is this case. We know that the new face will not
3538 change until the next check pos, i.e. if the new face has a
3539 box, all characters up to that position will have a
3540 box. But, as usual, we don't know whether that position
3541 is really the end. */
3542 if (new_face_id
!= it
->face_id
)
3544 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3545 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3547 /* If new face has a box but old face hasn't, this is the
3548 start of a run of characters with box, i.e. it has a
3549 shadow on the left side. */
3550 it
->start_of_box_run_p
3551 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3552 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3556 it
->face_id
= new_face_id
;
3557 return HANDLED_NORMALLY
;
3561 /* Return the ID of the face ``underlying'' IT's current position,
3562 which is in a string. If the iterator is associated with a
3563 buffer, return the face at IT's current buffer position.
3564 Otherwise, use the iterator's base_face_id. */
3567 underlying_face_id (it
)
3570 int face_id
= it
->base_face_id
, i
;
3572 xassert (STRINGP (it
->string
));
3574 for (i
= it
->sp
- 1; i
>= 0; --i
)
3575 if (NILP (it
->stack
[i
].string
))
3576 face_id
= it
->stack
[i
].face_id
;
3582 /* Compute the face one character before or after the current position
3583 of IT. BEFORE_P non-zero means get the face in front of IT's
3584 position. Value is the id of the face. */
3587 face_before_or_after_it_pos (it
, before_p
)
3592 EMACS_INT next_check_charpos
;
3593 struct text_pos pos
;
3595 xassert (it
->s
== NULL
);
3597 if (STRINGP (it
->string
))
3599 int bufpos
, base_face_id
;
3601 /* No face change past the end of the string (for the case
3602 we are padding with spaces). No face change before the
3604 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3605 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3608 /* Set pos to the position before or after IT's current position. */
3610 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3612 /* For composition, we must check the character after the
3614 pos
= (it
->what
== IT_COMPOSITION
3615 ? string_pos (IT_STRING_CHARPOS (*it
)
3616 + it
->cmp_it
.nchars
, it
->string
)
3617 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3619 if (it
->current
.overlay_string_index
>= 0)
3620 bufpos
= IT_CHARPOS (*it
);
3624 base_face_id
= underlying_face_id (it
);
3626 /* Get the face for ASCII, or unibyte. */
3627 face_id
= face_at_string_position (it
->w
,
3631 it
->region_beg_charpos
,
3632 it
->region_end_charpos
,
3633 &next_check_charpos
,
3636 /* Correct the face for charsets different from ASCII. Do it
3637 for the multibyte case only. The face returned above is
3638 suitable for unibyte text if IT->string is unibyte. */
3639 if (STRING_MULTIBYTE (it
->string
))
3641 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3642 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3644 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3646 c
= string_char_and_length (p
, &len
);
3647 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3652 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3653 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3656 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3657 pos
= it
->current
.pos
;
3660 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3663 if (it
->what
== IT_COMPOSITION
)
3664 /* For composition, we must check the position after the
3666 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3668 INC_TEXT_POS (pos
, it
->multibyte_p
);
3671 /* Determine face for CHARSET_ASCII, or unibyte. */
3672 face_id
= face_at_buffer_position (it
->w
,
3674 it
->region_beg_charpos
,
3675 it
->region_end_charpos
,
3676 &next_check_charpos
,
3679 /* Correct the face for charsets different from ASCII. Do it
3680 for the multibyte case only. The face returned above is
3681 suitable for unibyte text if current_buffer is unibyte. */
3682 if (it
->multibyte_p
)
3684 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3685 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3686 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3695 /***********************************************************************
3697 ***********************************************************************/
3699 /* Set up iterator IT from invisible properties at its current
3700 position. Called from handle_stop. */
3702 static enum prop_handled
3703 handle_invisible_prop (it
)
3706 enum prop_handled handled
= HANDLED_NORMALLY
;
3708 if (STRINGP (it
->string
))
3710 extern Lisp_Object Qinvisible
;
3711 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3713 /* Get the value of the invisible text property at the
3714 current position. Value will be nil if there is no such
3716 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3717 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3720 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3722 handled
= HANDLED_RECOMPUTE_PROPS
;
3724 /* Get the position at which the next change of the
3725 invisible text property can be found in IT->string.
3726 Value will be nil if the property value is the same for
3727 all the rest of IT->string. */
3728 XSETINT (limit
, SCHARS (it
->string
));
3729 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3732 /* Text at current position is invisible. The next
3733 change in the property is at position end_charpos.
3734 Move IT's current position to that position. */
3735 if (INTEGERP (end_charpos
)
3736 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3738 struct text_pos old
;
3739 old
= it
->current
.string_pos
;
3740 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3741 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3745 /* The rest of the string is invisible. If this is an
3746 overlay string, proceed with the next overlay string
3747 or whatever comes and return a character from there. */
3748 if (it
->current
.overlay_string_index
>= 0)
3750 next_overlay_string (it
);
3751 /* Don't check for overlay strings when we just
3752 finished processing them. */
3753 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3757 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3758 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3766 EMACS_INT newpos
, next_stop
, start_charpos
;
3767 Lisp_Object pos
, prop
, overlay
;
3769 /* First of all, is there invisible text at this position? */
3770 start_charpos
= IT_CHARPOS (*it
);
3771 pos
= make_number (IT_CHARPOS (*it
));
3772 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3774 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3776 /* If we are on invisible text, skip over it. */
3777 if (invis_p
&& IT_CHARPOS (*it
) < it
->end_charpos
)
3779 /* Record whether we have to display an ellipsis for the
3781 int display_ellipsis_p
= invis_p
== 2;
3783 handled
= HANDLED_RECOMPUTE_PROPS
;
3785 /* Loop skipping over invisible text. The loop is left at
3786 ZV or with IT on the first char being visible again. */
3789 /* Try to skip some invisible text. Return value is the
3790 position reached which can be equal to IT's position
3791 if there is nothing invisible here. This skips both
3792 over invisible text properties and overlays with
3793 invisible property. */
3794 newpos
= skip_invisible (IT_CHARPOS (*it
),
3795 &next_stop
, ZV
, it
->window
);
3797 /* If we skipped nothing at all we weren't at invisible
3798 text in the first place. If everything to the end of
3799 the buffer was skipped, end the loop. */
3800 if (newpos
== IT_CHARPOS (*it
) || newpos
>= ZV
)
3804 /* We skipped some characters but not necessarily
3805 all there are. Check if we ended up on visible
3806 text. Fget_char_property returns the property of
3807 the char before the given position, i.e. if we
3808 get invis_p = 0, this means that the char at
3809 newpos is visible. */
3810 pos
= make_number (newpos
);
3811 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3812 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3815 /* If we ended up on invisible text, proceed to
3816 skip starting with next_stop. */
3818 IT_CHARPOS (*it
) = next_stop
;
3820 /* If there are adjacent invisible texts, don't lose the
3821 second one's ellipsis. */
3823 display_ellipsis_p
= 1;
3827 /* The position newpos is now either ZV or on visible text. */
3828 IT_CHARPOS (*it
) = newpos
;
3829 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3831 /* If there are before-strings at the start of invisible
3832 text, and the text is invisible because of a text
3833 property, arrange to show before-strings because 20.x did
3834 it that way. (If the text is invisible because of an
3835 overlay property instead of a text property, this is
3836 already handled in the overlay code.) */
3838 && get_overlay_strings (it
, start_charpos
))
3840 handled
= HANDLED_RECOMPUTE_PROPS
;
3841 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3843 else if (display_ellipsis_p
)
3845 /* Make sure that the glyphs of the ellipsis will get
3846 correct `charpos' values. If we would not update
3847 it->position here, the glyphs would belong to the
3848 last visible character _before_ the invisible
3849 text, which confuses `set_cursor_from_row'.
3851 We use the last invisible position instead of the
3852 first because this way the cursor is always drawn on
3853 the first "." of the ellipsis, whenever PT is inside
3854 the invisible text. Otherwise the cursor would be
3855 placed _after_ the ellipsis when the point is after the
3856 first invisible character. */
3857 if (!STRINGP (it
->object
))
3859 it
->position
.charpos
= IT_CHARPOS (*it
) - 1;
3860 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3863 /* Let the ellipsis display before
3864 considering any properties of the following char.
3865 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3866 handled
= HANDLED_RETURN
;
3875 /* Make iterator IT return `...' next.
3876 Replaces LEN characters from buffer. */
3879 setup_for_ellipsis (it
, len
)
3883 /* Use the display table definition for `...'. Invalid glyphs
3884 will be handled by the method returning elements from dpvec. */
3885 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3887 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3888 it
->dpvec
= v
->contents
;
3889 it
->dpend
= v
->contents
+ v
->size
;
3893 /* Default `...'. */
3894 it
->dpvec
= default_invis_vector
;
3895 it
->dpend
= default_invis_vector
+ 3;
3898 it
->dpvec_char_len
= len
;
3899 it
->current
.dpvec_index
= 0;
3900 it
->dpvec_face_id
= -1;
3902 /* Remember the current face id in case glyphs specify faces.
3903 IT's face is restored in set_iterator_to_next.
3904 saved_face_id was set to preceding char's face in handle_stop. */
3905 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3906 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3908 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3914 /***********************************************************************
3916 ***********************************************************************/
3918 /* Set up iterator IT from `display' property at its current position.
3919 Called from handle_stop.
3920 We return HANDLED_RETURN if some part of the display property
3921 overrides the display of the buffer text itself.
3922 Otherwise we return HANDLED_NORMALLY. */
3924 static enum prop_handled
3925 handle_display_prop (it
)
3928 Lisp_Object prop
, object
, overlay
;
3929 struct text_pos
*position
;
3930 /* Nonzero if some property replaces the display of the text itself. */
3931 int display_replaced_p
= 0;
3933 if (STRINGP (it
->string
))
3935 object
= it
->string
;
3936 position
= &it
->current
.string_pos
;
3940 XSETWINDOW (object
, it
->w
);
3941 position
= &it
->current
.pos
;
3944 /* Reset those iterator values set from display property values. */
3945 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3946 it
->space_width
= Qnil
;
3947 it
->font_height
= Qnil
;
3950 /* We don't support recursive `display' properties, i.e. string
3951 values that have a string `display' property, that have a string
3952 `display' property etc. */
3953 if (!it
->string_from_display_prop_p
)
3954 it
->area
= TEXT_AREA
;
3956 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3957 Qdisplay
, object
, &overlay
);
3959 return HANDLED_NORMALLY
;
3960 /* Now OVERLAY is the overlay that gave us this property, or nil
3961 if it was a text property. */
3963 if (!STRINGP (it
->string
))
3964 object
= it
->w
->buffer
;
3967 /* Simple properties. */
3968 && !EQ (XCAR (prop
), Qimage
)
3969 && !EQ (XCAR (prop
), Qspace
)
3970 && !EQ (XCAR (prop
), Qwhen
)
3971 && !EQ (XCAR (prop
), Qslice
)
3972 && !EQ (XCAR (prop
), Qspace_width
)
3973 && !EQ (XCAR (prop
), Qheight
)
3974 && !EQ (XCAR (prop
), Qraise
)
3975 /* Marginal area specifications. */
3976 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3977 && !EQ (XCAR (prop
), Qleft_fringe
)
3978 && !EQ (XCAR (prop
), Qright_fringe
)
3979 && !NILP (XCAR (prop
)))
3981 for (; CONSP (prop
); prop
= XCDR (prop
))
3983 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
3984 position
, display_replaced_p
))
3986 display_replaced_p
= 1;
3987 /* If some text in a string is replaced, `position' no
3988 longer points to the position of `object'. */
3989 if (STRINGP (object
))
3994 else if (VECTORP (prop
))
3997 for (i
= 0; i
< ASIZE (prop
); ++i
)
3998 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
3999 position
, display_replaced_p
))
4001 display_replaced_p
= 1;
4002 /* If some text in a string is replaced, `position' no
4003 longer points to the position of `object'. */
4004 if (STRINGP (object
))
4010 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4012 display_replaced_p
= 1;
4015 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4019 /* Value is the position of the end of the `display' property starting
4020 at START_POS in OBJECT. */
4022 static struct text_pos
4023 display_prop_end (it
, object
, start_pos
)
4026 struct text_pos start_pos
;
4029 struct text_pos end_pos
;
4031 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4032 Qdisplay
, object
, Qnil
);
4033 CHARPOS (end_pos
) = XFASTINT (end
);
4034 if (STRINGP (object
))
4035 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4037 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4043 /* Set up IT from a single `display' specification PROP. OBJECT
4044 is the object in which the `display' property was found. *POSITION
4045 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4046 means that we previously saw a display specification which already
4047 replaced text display with something else, for example an image;
4048 we ignore such properties after the first one has been processed.
4050 OVERLAY is the overlay this `display' property came from,
4051 or nil if it was a text property.
4053 If PROP is a `space' or `image' specification, and in some other
4054 cases too, set *POSITION to the position where the `display'
4057 Value is non-zero if something was found which replaces the display
4058 of buffer or string text. */
4061 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4062 display_replaced_before_p
)
4066 Lisp_Object overlay
;
4067 struct text_pos
*position
;
4068 int display_replaced_before_p
;
4071 Lisp_Object location
, value
;
4072 struct text_pos start_pos
, save_pos
;
4075 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4076 If the result is non-nil, use VALUE instead of SPEC. */
4078 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4087 if (!NILP (form
) && !EQ (form
, Qt
))
4089 int count
= SPECPDL_INDEX ();
4090 struct gcpro gcpro1
;
4092 /* Bind `object' to the object having the `display' property, a
4093 buffer or string. Bind `position' to the position in the
4094 object where the property was found, and `buffer-position'
4095 to the current position in the buffer. */
4096 specbind (Qobject
, object
);
4097 specbind (Qposition
, make_number (CHARPOS (*position
)));
4098 specbind (Qbuffer_position
,
4099 make_number (STRINGP (object
)
4100 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4102 form
= safe_eval (form
);
4104 unbind_to (count
, Qnil
);
4110 /* Handle `(height HEIGHT)' specifications. */
4112 && EQ (XCAR (spec
), Qheight
)
4113 && CONSP (XCDR (spec
)))
4115 if (!FRAME_WINDOW_P (it
->f
))
4118 it
->font_height
= XCAR (XCDR (spec
));
4119 if (!NILP (it
->font_height
))
4121 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4122 int new_height
= -1;
4124 if (CONSP (it
->font_height
)
4125 && (EQ (XCAR (it
->font_height
), Qplus
)
4126 || EQ (XCAR (it
->font_height
), Qminus
))
4127 && CONSP (XCDR (it
->font_height
))
4128 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4130 /* `(+ N)' or `(- N)' where N is an integer. */
4131 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4132 if (EQ (XCAR (it
->font_height
), Qplus
))
4134 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4136 else if (FUNCTIONP (it
->font_height
))
4138 /* Call function with current height as argument.
4139 Value is the new height. */
4141 height
= safe_call1 (it
->font_height
,
4142 face
->lface
[LFACE_HEIGHT_INDEX
]);
4143 if (NUMBERP (height
))
4144 new_height
= XFLOATINT (height
);
4146 else if (NUMBERP (it
->font_height
))
4148 /* Value is a multiple of the canonical char height. */
4151 face
= FACE_FROM_ID (it
->f
,
4152 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4153 new_height
= (XFLOATINT (it
->font_height
)
4154 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4158 /* Evaluate IT->font_height with `height' bound to the
4159 current specified height to get the new height. */
4160 int count
= SPECPDL_INDEX ();
4162 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4163 value
= safe_eval (it
->font_height
);
4164 unbind_to (count
, Qnil
);
4166 if (NUMBERP (value
))
4167 new_height
= XFLOATINT (value
);
4171 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4177 /* Handle `(space-width WIDTH)'. */
4179 && EQ (XCAR (spec
), Qspace_width
)
4180 && CONSP (XCDR (spec
)))
4182 if (!FRAME_WINDOW_P (it
->f
))
4185 value
= XCAR (XCDR (spec
));
4186 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4187 it
->space_width
= value
;
4192 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4194 && EQ (XCAR (spec
), Qslice
))
4198 if (!FRAME_WINDOW_P (it
->f
))
4201 if (tem
= XCDR (spec
), CONSP (tem
))
4203 it
->slice
.x
= XCAR (tem
);
4204 if (tem
= XCDR (tem
), CONSP (tem
))
4206 it
->slice
.y
= XCAR (tem
);
4207 if (tem
= XCDR (tem
), CONSP (tem
))
4209 it
->slice
.width
= XCAR (tem
);
4210 if (tem
= XCDR (tem
), CONSP (tem
))
4211 it
->slice
.height
= XCAR (tem
);
4219 /* Handle `(raise FACTOR)'. */
4221 && EQ (XCAR (spec
), Qraise
)
4222 && CONSP (XCDR (spec
)))
4224 if (!FRAME_WINDOW_P (it
->f
))
4227 #ifdef HAVE_WINDOW_SYSTEM
4228 value
= XCAR (XCDR (spec
));
4229 if (NUMBERP (value
))
4231 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4232 it
->voffset
= - (XFLOATINT (value
)
4233 * (FONT_HEIGHT (face
->font
)));
4235 #endif /* HAVE_WINDOW_SYSTEM */
4240 /* Don't handle the other kinds of display specifications
4241 inside a string that we got from a `display' property. */
4242 if (it
->string_from_display_prop_p
)
4245 /* Characters having this form of property are not displayed, so
4246 we have to find the end of the property. */
4247 start_pos
= *position
;
4248 *position
= display_prop_end (it
, object
, start_pos
);
4251 /* Stop the scan at that end position--we assume that all
4252 text properties change there. */
4253 it
->stop_charpos
= position
->charpos
;
4255 /* Handle `(left-fringe BITMAP [FACE])'
4256 and `(right-fringe BITMAP [FACE])'. */
4258 && (EQ (XCAR (spec
), Qleft_fringe
)
4259 || EQ (XCAR (spec
), Qright_fringe
))
4260 && CONSP (XCDR (spec
)))
4262 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4265 if (!FRAME_WINDOW_P (it
->f
))
4266 /* If we return here, POSITION has been advanced
4267 across the text with this property. */
4270 #ifdef HAVE_WINDOW_SYSTEM
4271 value
= XCAR (XCDR (spec
));
4272 if (!SYMBOLP (value
)
4273 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4274 /* If we return here, POSITION has been advanced
4275 across the text with this property. */
4278 if (CONSP (XCDR (XCDR (spec
))))
4280 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4281 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4287 /* Save current settings of IT so that we can restore them
4288 when we are finished with the glyph property value. */
4290 save_pos
= it
->position
;
4291 it
->position
= *position
;
4293 it
->position
= save_pos
;
4295 it
->area
= TEXT_AREA
;
4296 it
->what
= IT_IMAGE
;
4297 it
->image_id
= -1; /* no image */
4298 it
->position
= start_pos
;
4299 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4300 it
->method
= GET_FROM_IMAGE
;
4301 it
->from_overlay
= Qnil
;
4302 it
->face_id
= face_id
;
4304 /* Say that we haven't consumed the characters with
4305 `display' property yet. The call to pop_it in
4306 set_iterator_to_next will clean this up. */
4307 *position
= start_pos
;
4309 if (EQ (XCAR (spec
), Qleft_fringe
))
4311 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4312 it
->left_user_fringe_face_id
= face_id
;
4316 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4317 it
->right_user_fringe_face_id
= face_id
;
4319 #endif /* HAVE_WINDOW_SYSTEM */
4323 /* Prepare to handle `((margin left-margin) ...)',
4324 `((margin right-margin) ...)' and `((margin nil) ...)'
4325 prefixes for display specifications. */
4326 location
= Qunbound
;
4327 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4331 value
= XCDR (spec
);
4333 value
= XCAR (value
);
4336 if (EQ (XCAR (tem
), Qmargin
)
4337 && (tem
= XCDR (tem
),
4338 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4340 || EQ (tem
, Qleft_margin
)
4341 || EQ (tem
, Qright_margin
))))
4345 if (EQ (location
, Qunbound
))
4351 /* After this point, VALUE is the property after any
4352 margin prefix has been stripped. It must be a string,
4353 an image specification, or `(space ...)'.
4355 LOCATION specifies where to display: `left-margin',
4356 `right-margin' or nil. */
4358 valid_p
= (STRINGP (value
)
4359 #ifdef HAVE_WINDOW_SYSTEM
4360 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4361 #endif /* not HAVE_WINDOW_SYSTEM */
4362 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4364 if (valid_p
&& !display_replaced_before_p
)
4366 /* Save current settings of IT so that we can restore them
4367 when we are finished with the glyph property value. */
4368 save_pos
= it
->position
;
4369 it
->position
= *position
;
4371 it
->position
= save_pos
;
4372 it
->from_overlay
= overlay
;
4374 if (NILP (location
))
4375 it
->area
= TEXT_AREA
;
4376 else if (EQ (location
, Qleft_margin
))
4377 it
->area
= LEFT_MARGIN_AREA
;
4379 it
->area
= RIGHT_MARGIN_AREA
;
4381 if (STRINGP (value
))
4384 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4385 it
->current
.overlay_string_index
= -1;
4386 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4387 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4388 it
->method
= GET_FROM_STRING
;
4389 it
->stop_charpos
= 0;
4390 it
->string_from_display_prop_p
= 1;
4391 /* Say that we haven't consumed the characters with
4392 `display' property yet. The call to pop_it in
4393 set_iterator_to_next will clean this up. */
4394 if (BUFFERP (object
))
4395 *position
= start_pos
;
4397 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4399 it
->method
= GET_FROM_STRETCH
;
4401 *position
= it
->position
= start_pos
;
4403 #ifdef HAVE_WINDOW_SYSTEM
4406 it
->what
= IT_IMAGE
;
4407 it
->image_id
= lookup_image (it
->f
, value
);
4408 it
->position
= start_pos
;
4409 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4410 it
->method
= GET_FROM_IMAGE
;
4412 /* Say that we haven't consumed the characters with
4413 `display' property yet. The call to pop_it in
4414 set_iterator_to_next will clean this up. */
4415 *position
= start_pos
;
4417 #endif /* HAVE_WINDOW_SYSTEM */
4422 /* Invalid property or property not supported. Restore
4423 POSITION to what it was before. */
4424 *position
= start_pos
;
4429 /* Check if SPEC is a display sub-property value whose text should be
4430 treated as intangible. */
4433 single_display_spec_intangible_p (prop
)
4436 /* Skip over `when FORM'. */
4437 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4451 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4452 we don't need to treat text as intangible. */
4453 if (EQ (XCAR (prop
), Qmargin
))
4461 || EQ (XCAR (prop
), Qleft_margin
)
4462 || EQ (XCAR (prop
), Qright_margin
))
4466 return (CONSP (prop
)
4467 && (EQ (XCAR (prop
), Qimage
)
4468 || EQ (XCAR (prop
), Qspace
)));
4472 /* Check if PROP is a display property value whose text should be
4473 treated as intangible. */
4476 display_prop_intangible_p (prop
)
4480 && CONSP (XCAR (prop
))
4481 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4483 /* A list of sub-properties. */
4484 while (CONSP (prop
))
4486 if (single_display_spec_intangible_p (XCAR (prop
)))
4491 else if (VECTORP (prop
))
4493 /* A vector of sub-properties. */
4495 for (i
= 0; i
< ASIZE (prop
); ++i
)
4496 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4500 return single_display_spec_intangible_p (prop
);
4506 /* Return 1 if PROP is a display sub-property value containing STRING. */
4509 single_display_spec_string_p (prop
, string
)
4510 Lisp_Object prop
, string
;
4512 if (EQ (string
, prop
))
4515 /* Skip over `when FORM'. */
4516 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4525 /* Skip over `margin LOCATION'. */
4526 if (EQ (XCAR (prop
), Qmargin
))
4537 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4541 /* Return 1 if STRING appears in the `display' property PROP. */
4544 display_prop_string_p (prop
, string
)
4545 Lisp_Object prop
, string
;
4548 && CONSP (XCAR (prop
))
4549 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4551 /* A list of sub-properties. */
4552 while (CONSP (prop
))
4554 if (single_display_spec_string_p (XCAR (prop
), string
))
4559 else if (VECTORP (prop
))
4561 /* A vector of sub-properties. */
4563 for (i
= 0; i
< ASIZE (prop
); ++i
)
4564 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4568 return single_display_spec_string_p (prop
, string
);
4574 /* Determine which buffer position in W's buffer STRING comes from.
4575 AROUND_CHARPOS is an approximate position where it could come from.
4576 Value is the buffer position or 0 if it couldn't be determined.
4578 W's buffer must be current.
4580 This function is necessary because we don't record buffer positions
4581 in glyphs generated from strings (to keep struct glyph small).
4582 This function may only use code that doesn't eval because it is
4583 called asynchronously from note_mouse_highlight. */
4586 string_buffer_position (w
, string
, around_charpos
)
4591 Lisp_Object limit
, prop
, pos
;
4592 const int MAX_DISTANCE
= 1000;
4595 pos
= make_number (around_charpos
);
4596 limit
= make_number (min (XINT (pos
) + MAX_DISTANCE
, ZV
));
4597 while (!found
&& !EQ (pos
, limit
))
4599 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4600 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4603 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
, limit
);
4608 pos
= make_number (around_charpos
);
4609 limit
= make_number (max (XINT (pos
) - MAX_DISTANCE
, BEGV
));
4610 while (!found
&& !EQ (pos
, limit
))
4612 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4613 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4616 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4621 return found
? XINT (pos
) : 0;
4626 /***********************************************************************
4627 `composition' property
4628 ***********************************************************************/
4630 /* Set up iterator IT from `composition' property at its current
4631 position. Called from handle_stop. */
4633 static enum prop_handled
4634 handle_composition_prop (it
)
4637 Lisp_Object prop
, string
;
4638 EMACS_INT pos
, pos_byte
, start
, end
;
4640 if (STRINGP (it
->string
))
4644 pos
= IT_STRING_CHARPOS (*it
);
4645 pos_byte
= IT_STRING_BYTEPOS (*it
);
4646 string
= it
->string
;
4647 s
= SDATA (string
) + pos_byte
;
4648 it
->c
= STRING_CHAR (s
);
4652 pos
= IT_CHARPOS (*it
);
4653 pos_byte
= IT_BYTEPOS (*it
);
4655 it
->c
= FETCH_CHAR (pos_byte
);
4658 /* If there's a valid composition and point is not inside of the
4659 composition (in the case that the composition is from the current
4660 buffer), draw a glyph composed from the composition components. */
4661 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4662 && COMPOSITION_VALID_P (start
, end
, prop
)
4663 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4667 if (STRINGP (it
->string
))
4668 pos_byte
= string_char_to_byte (it
->string
, start
);
4670 pos_byte
= CHAR_TO_BYTE (start
);
4672 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4675 if (it
->cmp_it
.id
>= 0)
4678 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4679 it
->cmp_it
.nglyphs
= -1;
4683 return HANDLED_NORMALLY
;
4688 /***********************************************************************
4690 ***********************************************************************/
4692 /* The following structure is used to record overlay strings for
4693 later sorting in load_overlay_strings. */
4695 struct overlay_entry
4697 Lisp_Object overlay
;
4704 /* Set up iterator IT from overlay strings at its current position.
4705 Called from handle_stop. */
4707 static enum prop_handled
4708 handle_overlay_change (it
)
4711 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4712 return HANDLED_RECOMPUTE_PROPS
;
4714 return HANDLED_NORMALLY
;
4718 /* Set up the next overlay string for delivery by IT, if there is an
4719 overlay string to deliver. Called by set_iterator_to_next when the
4720 end of the current overlay string is reached. If there are more
4721 overlay strings to display, IT->string and
4722 IT->current.overlay_string_index are set appropriately here.
4723 Otherwise IT->string is set to nil. */
4726 next_overlay_string (it
)
4729 ++it
->current
.overlay_string_index
;
4730 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4732 /* No more overlay strings. Restore IT's settings to what
4733 they were before overlay strings were processed, and
4734 continue to deliver from current_buffer. */
4736 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4739 || (NILP (it
->string
)
4740 && it
->method
== GET_FROM_BUFFER
4741 && it
->stop_charpos
>= BEGV
4742 && it
->stop_charpos
<= it
->end_charpos
));
4743 it
->current
.overlay_string_index
= -1;
4744 it
->n_overlay_strings
= 0;
4746 /* If we're at the end of the buffer, record that we have
4747 processed the overlay strings there already, so that
4748 next_element_from_buffer doesn't try it again. */
4749 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4750 it
->overlay_strings_at_end_processed_p
= 1;
4754 /* There are more overlay strings to process. If
4755 IT->current.overlay_string_index has advanced to a position
4756 where we must load IT->overlay_strings with more strings, do
4758 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4760 if (it
->current
.overlay_string_index
&& i
== 0)
4761 load_overlay_strings (it
, 0);
4763 /* Initialize IT to deliver display elements from the overlay
4765 it
->string
= it
->overlay_strings
[i
];
4766 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4767 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4768 it
->method
= GET_FROM_STRING
;
4769 it
->stop_charpos
= 0;
4770 if (it
->cmp_it
.stop_pos
>= 0)
4771 it
->cmp_it
.stop_pos
= 0;
4778 /* Compare two overlay_entry structures E1 and E2. Used as a
4779 comparison function for qsort in load_overlay_strings. Overlay
4780 strings for the same position are sorted so that
4782 1. All after-strings come in front of before-strings, except
4783 when they come from the same overlay.
4785 2. Within after-strings, strings are sorted so that overlay strings
4786 from overlays with higher priorities come first.
4788 2. Within before-strings, strings are sorted so that overlay
4789 strings from overlays with higher priorities come last.
4791 Value is analogous to strcmp. */
4795 compare_overlay_entries (e1
, e2
)
4798 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4799 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4802 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4804 /* Let after-strings appear in front of before-strings if
4805 they come from different overlays. */
4806 if (EQ (entry1
->overlay
, entry2
->overlay
))
4807 result
= entry1
->after_string_p
? 1 : -1;
4809 result
= entry1
->after_string_p
? -1 : 1;
4811 else if (entry1
->after_string_p
)
4812 /* After-strings sorted in order of decreasing priority. */
4813 result
= entry2
->priority
- entry1
->priority
;
4815 /* Before-strings sorted in order of increasing priority. */
4816 result
= entry1
->priority
- entry2
->priority
;
4822 /* Load the vector IT->overlay_strings with overlay strings from IT's
4823 current buffer position, or from CHARPOS if that is > 0. Set
4824 IT->n_overlays to the total number of overlay strings found.
4826 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4827 a time. On entry into load_overlay_strings,
4828 IT->current.overlay_string_index gives the number of overlay
4829 strings that have already been loaded by previous calls to this
4832 IT->add_overlay_start contains an additional overlay start
4833 position to consider for taking overlay strings from, if non-zero.
4834 This position comes into play when the overlay has an `invisible'
4835 property, and both before and after-strings. When we've skipped to
4836 the end of the overlay, because of its `invisible' property, we
4837 nevertheless want its before-string to appear.
4838 IT->add_overlay_start will contain the overlay start position
4841 Overlay strings are sorted so that after-string strings come in
4842 front of before-string strings. Within before and after-strings,
4843 strings are sorted by overlay priority. See also function
4844 compare_overlay_entries. */
4847 load_overlay_strings (it
, charpos
)
4851 extern Lisp_Object Qwindow
, Qpriority
;
4852 Lisp_Object overlay
, window
, str
, invisible
;
4853 struct Lisp_Overlay
*ov
;
4856 int n
= 0, i
, j
, invis_p
;
4857 struct overlay_entry
*entries
4858 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4861 charpos
= IT_CHARPOS (*it
);
4863 /* Append the overlay string STRING of overlay OVERLAY to vector
4864 `entries' which has size `size' and currently contains `n'
4865 elements. AFTER_P non-zero means STRING is an after-string of
4867 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4870 Lisp_Object priority; \
4874 int new_size = 2 * size; \
4875 struct overlay_entry *old = entries; \
4877 (struct overlay_entry *) alloca (new_size \
4878 * sizeof *entries); \
4879 bcopy (old, entries, size * sizeof *entries); \
4883 entries[n].string = (STRING); \
4884 entries[n].overlay = (OVERLAY); \
4885 priority = Foverlay_get ((OVERLAY), Qpriority); \
4886 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4887 entries[n].after_string_p = (AFTER_P); \
4892 /* Process overlay before the overlay center. */
4893 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4895 XSETMISC (overlay
, ov
);
4896 xassert (OVERLAYP (overlay
));
4897 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4898 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4903 /* Skip this overlay if it doesn't start or end at IT's current
4905 if (end
!= charpos
&& start
!= charpos
)
4908 /* Skip this overlay if it doesn't apply to IT->w. */
4909 window
= Foverlay_get (overlay
, Qwindow
);
4910 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4913 /* If the text ``under'' the overlay is invisible, both before-
4914 and after-strings from this overlay are visible; start and
4915 end position are indistinguishable. */
4916 invisible
= Foverlay_get (overlay
, Qinvisible
);
4917 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4919 /* If overlay has a non-empty before-string, record it. */
4920 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4921 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4923 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4925 /* If overlay has a non-empty after-string, record it. */
4926 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4927 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4929 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4932 /* Process overlays after the overlay center. */
4933 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4935 XSETMISC (overlay
, ov
);
4936 xassert (OVERLAYP (overlay
));
4937 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4938 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4940 if (start
> charpos
)
4943 /* Skip this overlay if it doesn't start or end at IT's current
4945 if (end
!= charpos
&& start
!= charpos
)
4948 /* Skip this overlay if it doesn't apply to IT->w. */
4949 window
= Foverlay_get (overlay
, Qwindow
);
4950 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4953 /* If the text ``under'' the overlay is invisible, it has a zero
4954 dimension, and both before- and after-strings apply. */
4955 invisible
= Foverlay_get (overlay
, Qinvisible
);
4956 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4958 /* If overlay has a non-empty before-string, record it. */
4959 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4960 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4962 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4964 /* If overlay has a non-empty after-string, record it. */
4965 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4966 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4968 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4971 #undef RECORD_OVERLAY_STRING
4975 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
4977 /* Record the total number of strings to process. */
4978 it
->n_overlay_strings
= n
;
4980 /* IT->current.overlay_string_index is the number of overlay strings
4981 that have already been consumed by IT. Copy some of the
4982 remaining overlay strings to IT->overlay_strings. */
4984 j
= it
->current
.overlay_string_index
;
4985 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
4987 it
->overlay_strings
[i
] = entries
[j
].string
;
4988 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
4995 /* Get the first chunk of overlay strings at IT's current buffer
4996 position, or at CHARPOS if that is > 0. Value is non-zero if at
4997 least one overlay string was found. */
5000 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5005 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5006 process. This fills IT->overlay_strings with strings, and sets
5007 IT->n_overlay_strings to the total number of strings to process.
5008 IT->pos.overlay_string_index has to be set temporarily to zero
5009 because load_overlay_strings needs this; it must be set to -1
5010 when no overlay strings are found because a zero value would
5011 indicate a position in the first overlay string. */
5012 it
->current
.overlay_string_index
= 0;
5013 load_overlay_strings (it
, charpos
);
5015 /* If we found overlay strings, set up IT to deliver display
5016 elements from the first one. Otherwise set up IT to deliver
5017 from current_buffer. */
5018 if (it
->n_overlay_strings
)
5020 /* Make sure we know settings in current_buffer, so that we can
5021 restore meaningful values when we're done with the overlay
5024 compute_stop_pos (it
);
5025 xassert (it
->face_id
>= 0);
5027 /* Save IT's settings. They are restored after all overlay
5028 strings have been processed. */
5029 xassert (!compute_stop_p
|| it
->sp
== 0);
5031 /* When called from handle_stop, there might be an empty display
5032 string loaded. In that case, don't bother saving it. */
5033 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5036 /* Set up IT to deliver display elements from the first overlay
5038 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5039 it
->string
= it
->overlay_strings
[0];
5040 it
->from_overlay
= Qnil
;
5041 it
->stop_charpos
= 0;
5042 xassert (STRINGP (it
->string
));
5043 it
->end_charpos
= SCHARS (it
->string
);
5044 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5045 it
->method
= GET_FROM_STRING
;
5049 it
->current
.overlay_string_index
= -1;
5054 get_overlay_strings (it
, charpos
)
5059 it
->method
= GET_FROM_BUFFER
;
5061 (void) get_overlay_strings_1 (it
, charpos
, 1);
5065 /* Value is non-zero if we found at least one overlay string. */
5066 return STRINGP (it
->string
);
5071 /***********************************************************************
5072 Saving and restoring state
5073 ***********************************************************************/
5075 /* Save current settings of IT on IT->stack. Called, for example,
5076 before setting up IT for an overlay string, to be able to restore
5077 IT's settings to what they were after the overlay string has been
5084 struct iterator_stack_entry
*p
;
5086 xassert (it
->sp
< IT_STACK_SIZE
);
5087 p
= it
->stack
+ it
->sp
;
5089 p
->stop_charpos
= it
->stop_charpos
;
5090 p
->cmp_it
= it
->cmp_it
;
5091 xassert (it
->face_id
>= 0);
5092 p
->face_id
= it
->face_id
;
5093 p
->string
= it
->string
;
5094 p
->method
= it
->method
;
5095 p
->from_overlay
= it
->from_overlay
;
5098 case GET_FROM_IMAGE
:
5099 p
->u
.image
.object
= it
->object
;
5100 p
->u
.image
.image_id
= it
->image_id
;
5101 p
->u
.image
.slice
= it
->slice
;
5103 case GET_FROM_STRETCH
:
5104 p
->u
.stretch
.object
= it
->object
;
5107 p
->position
= it
->position
;
5108 p
->current
= it
->current
;
5109 p
->end_charpos
= it
->end_charpos
;
5110 p
->string_nchars
= it
->string_nchars
;
5112 p
->multibyte_p
= it
->multibyte_p
;
5113 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5114 p
->space_width
= it
->space_width
;
5115 p
->font_height
= it
->font_height
;
5116 p
->voffset
= it
->voffset
;
5117 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5118 p
->display_ellipsis_p
= 0;
5119 p
->line_wrap
= it
->line_wrap
;
5124 /* Restore IT's settings from IT->stack. Called, for example, when no
5125 more overlay strings must be processed, and we return to delivering
5126 display elements from a buffer, or when the end of a string from a
5127 `display' property is reached and we return to delivering display
5128 elements from an overlay string, or from a buffer. */
5134 struct iterator_stack_entry
*p
;
5136 xassert (it
->sp
> 0);
5138 p
= it
->stack
+ it
->sp
;
5139 it
->stop_charpos
= p
->stop_charpos
;
5140 it
->cmp_it
= p
->cmp_it
;
5141 it
->face_id
= p
->face_id
;
5142 it
->current
= p
->current
;
5143 it
->position
= p
->position
;
5144 it
->string
= p
->string
;
5145 it
->from_overlay
= p
->from_overlay
;
5146 if (NILP (it
->string
))
5147 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5148 it
->method
= p
->method
;
5151 case GET_FROM_IMAGE
:
5152 it
->image_id
= p
->u
.image
.image_id
;
5153 it
->object
= p
->u
.image
.object
;
5154 it
->slice
= p
->u
.image
.slice
;
5156 case GET_FROM_STRETCH
:
5157 it
->object
= p
->u
.comp
.object
;
5159 case GET_FROM_BUFFER
:
5160 it
->object
= it
->w
->buffer
;
5162 case GET_FROM_STRING
:
5163 it
->object
= it
->string
;
5165 case GET_FROM_DISPLAY_VECTOR
:
5167 it
->method
= GET_FROM_C_STRING
;
5168 else if (STRINGP (it
->string
))
5169 it
->method
= GET_FROM_STRING
;
5172 it
->method
= GET_FROM_BUFFER
;
5173 it
->object
= it
->w
->buffer
;
5176 it
->end_charpos
= p
->end_charpos
;
5177 it
->string_nchars
= p
->string_nchars
;
5179 it
->multibyte_p
= p
->multibyte_p
;
5180 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5181 it
->space_width
= p
->space_width
;
5182 it
->font_height
= p
->font_height
;
5183 it
->voffset
= p
->voffset
;
5184 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5185 it
->line_wrap
= p
->line_wrap
;
5190 /***********************************************************************
5192 ***********************************************************************/
5194 /* Set IT's current position to the previous line start. */
5197 back_to_previous_line_start (it
)
5200 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5201 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5205 /* Move IT to the next line start.
5207 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5208 we skipped over part of the text (as opposed to moving the iterator
5209 continuously over the text). Otherwise, don't change the value
5212 Newlines may come from buffer text, overlay strings, or strings
5213 displayed via the `display' property. That's the reason we can't
5214 simply use find_next_newline_no_quit.
5216 Note that this function may not skip over invisible text that is so
5217 because of text properties and immediately follows a newline. If
5218 it would, function reseat_at_next_visible_line_start, when called
5219 from set_iterator_to_next, would effectively make invisible
5220 characters following a newline part of the wrong glyph row, which
5221 leads to wrong cursor motion. */
5224 forward_to_next_line_start (it
, skipped_p
)
5228 int old_selective
, newline_found_p
, n
;
5229 const int MAX_NEWLINE_DISTANCE
= 500;
5231 /* If already on a newline, just consume it to avoid unintended
5232 skipping over invisible text below. */
5233 if (it
->what
== IT_CHARACTER
5235 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5237 set_iterator_to_next (it
, 0);
5242 /* Don't handle selective display in the following. It's (a)
5243 unnecessary because it's done by the caller, and (b) leads to an
5244 infinite recursion because next_element_from_ellipsis indirectly
5245 calls this function. */
5246 old_selective
= it
->selective
;
5249 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5250 from buffer text. */
5251 for (n
= newline_found_p
= 0;
5252 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5253 n
+= STRINGP (it
->string
) ? 0 : 1)
5255 if (!get_next_display_element (it
))
5257 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5258 set_iterator_to_next (it
, 0);
5261 /* If we didn't find a newline near enough, see if we can use a
5263 if (!newline_found_p
)
5265 int start
= IT_CHARPOS (*it
);
5266 int limit
= find_next_newline_no_quit (start
, 1);
5269 xassert (!STRINGP (it
->string
));
5271 /* If there isn't any `display' property in sight, and no
5272 overlays, we can just use the position of the newline in
5274 if (it
->stop_charpos
>= limit
5275 || ((pos
= Fnext_single_property_change (make_number (start
),
5277 Qnil
, make_number (limit
)),
5279 && next_overlay_change (start
) == ZV
))
5281 IT_CHARPOS (*it
) = limit
;
5282 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5283 *skipped_p
= newline_found_p
= 1;
5287 while (get_next_display_element (it
)
5288 && !newline_found_p
)
5290 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5291 set_iterator_to_next (it
, 0);
5296 it
->selective
= old_selective
;
5297 return newline_found_p
;
5301 /* Set IT's current position to the previous visible line start. Skip
5302 invisible text that is so either due to text properties or due to
5303 selective display. Caution: this does not change IT->current_x and
5307 back_to_previous_visible_line_start (it
)
5310 while (IT_CHARPOS (*it
) > BEGV
)
5312 back_to_previous_line_start (it
);
5314 if (IT_CHARPOS (*it
) <= BEGV
)
5317 /* If selective > 0, then lines indented more than that values
5319 if (it
->selective
> 0
5320 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5321 (double) it
->selective
)) /* iftc */
5324 /* Check the newline before point for invisibility. */
5327 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5328 Qinvisible
, it
->window
);
5329 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5333 if (IT_CHARPOS (*it
) <= BEGV
)
5340 Lisp_Object val
, overlay
;
5342 /* If newline is part of a composition, continue from start of composition */
5343 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5344 && beg
< IT_CHARPOS (*it
))
5347 /* If newline is replaced by a display property, find start of overlay
5348 or interval and continue search from that point. */
5350 pos
= --IT_CHARPOS (it2
);
5353 it2
.string_from_display_prop_p
= 0;
5354 if (handle_display_prop (&it2
) == HANDLED_RETURN
5355 && !NILP (val
= get_char_property_and_overlay
5356 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5357 && (OVERLAYP (overlay
)
5358 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5359 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5362 /* Newline is not replaced by anything -- so we are done. */
5368 IT_CHARPOS (*it
) = beg
;
5369 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5373 it
->continuation_lines_width
= 0;
5375 xassert (IT_CHARPOS (*it
) >= BEGV
);
5376 xassert (IT_CHARPOS (*it
) == BEGV
5377 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5382 /* Reseat iterator IT at the previous visible line start. Skip
5383 invisible text that is so either due to text properties or due to
5384 selective display. At the end, update IT's overlay information,
5385 face information etc. */
5388 reseat_at_previous_visible_line_start (it
)
5391 back_to_previous_visible_line_start (it
);
5392 reseat (it
, it
->current
.pos
, 1);
5397 /* Reseat iterator IT on the next visible line start in the current
5398 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5399 preceding the line start. Skip over invisible text that is so
5400 because of selective display. Compute faces, overlays etc at the
5401 new position. Note that this function does not skip over text that
5402 is invisible because of text properties. */
5405 reseat_at_next_visible_line_start (it
, on_newline_p
)
5409 int newline_found_p
, skipped_p
= 0;
5411 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5413 /* Skip over lines that are invisible because they are indented
5414 more than the value of IT->selective. */
5415 if (it
->selective
> 0)
5416 while (IT_CHARPOS (*it
) < ZV
5417 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5418 (double) it
->selective
)) /* iftc */
5420 xassert (IT_BYTEPOS (*it
) == BEGV
5421 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5422 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5425 /* Position on the newline if that's what's requested. */
5426 if (on_newline_p
&& newline_found_p
)
5428 if (STRINGP (it
->string
))
5430 if (IT_STRING_CHARPOS (*it
) > 0)
5432 --IT_STRING_CHARPOS (*it
);
5433 --IT_STRING_BYTEPOS (*it
);
5436 else if (IT_CHARPOS (*it
) > BEGV
)
5440 reseat (it
, it
->current
.pos
, 0);
5444 reseat (it
, it
->current
.pos
, 0);
5451 /***********************************************************************
5452 Changing an iterator's position
5453 ***********************************************************************/
5455 /* Change IT's current position to POS in current_buffer. If FORCE_P
5456 is non-zero, always check for text properties at the new position.
5457 Otherwise, text properties are only looked up if POS >=
5458 IT->check_charpos of a property. */
5461 reseat (it
, pos
, force_p
)
5463 struct text_pos pos
;
5466 int original_pos
= IT_CHARPOS (*it
);
5468 reseat_1 (it
, pos
, 0);
5470 /* Determine where to check text properties. Avoid doing it
5471 where possible because text property lookup is very expensive. */
5473 || CHARPOS (pos
) > it
->stop_charpos
5474 || CHARPOS (pos
) < original_pos
)
5481 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5482 IT->stop_pos to POS, also. */
5485 reseat_1 (it
, pos
, set_stop_p
)
5487 struct text_pos pos
;
5490 /* Don't call this function when scanning a C string. */
5491 xassert (it
->s
== NULL
);
5493 /* POS must be a reasonable value. */
5494 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5496 it
->current
.pos
= it
->position
= pos
;
5497 it
->end_charpos
= ZV
;
5499 it
->current
.dpvec_index
= -1;
5500 it
->current
.overlay_string_index
= -1;
5501 IT_STRING_CHARPOS (*it
) = -1;
5502 IT_STRING_BYTEPOS (*it
) = -1;
5504 it
->string_from_display_prop_p
= 0;
5505 it
->method
= GET_FROM_BUFFER
;
5506 it
->object
= it
->w
->buffer
;
5507 it
->area
= TEXT_AREA
;
5508 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5510 it
->string_from_display_prop_p
= 0;
5511 it
->face_before_selective_p
= 0;
5514 it
->stop_charpos
= CHARPOS (pos
);
5518 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5519 If S is non-null, it is a C string to iterate over. Otherwise,
5520 STRING gives a Lisp string to iterate over.
5522 If PRECISION > 0, don't return more then PRECISION number of
5523 characters from the string.
5525 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5526 characters have been returned. FIELD_WIDTH < 0 means an infinite
5529 MULTIBYTE = 0 means disable processing of multibyte characters,
5530 MULTIBYTE > 0 means enable it,
5531 MULTIBYTE < 0 means use IT->multibyte_p.
5533 IT must be initialized via a prior call to init_iterator before
5534 calling this function. */
5537 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5542 int precision
, field_width
, multibyte
;
5544 /* No region in strings. */
5545 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5547 /* No text property checks performed by default, but see below. */
5548 it
->stop_charpos
= -1;
5550 /* Set iterator position and end position. */
5551 bzero (&it
->current
, sizeof it
->current
);
5552 it
->current
.overlay_string_index
= -1;
5553 it
->current
.dpvec_index
= -1;
5554 xassert (charpos
>= 0);
5556 /* If STRING is specified, use its multibyteness, otherwise use the
5557 setting of MULTIBYTE, if specified. */
5559 it
->multibyte_p
= multibyte
> 0;
5563 xassert (STRINGP (string
));
5564 it
->string
= string
;
5566 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5567 it
->method
= GET_FROM_STRING
;
5568 it
->current
.string_pos
= string_pos (charpos
, string
);
5575 /* Note that we use IT->current.pos, not it->current.string_pos,
5576 for displaying C strings. */
5577 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5578 if (it
->multibyte_p
)
5580 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5581 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5585 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5586 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5589 it
->method
= GET_FROM_C_STRING
;
5592 /* PRECISION > 0 means don't return more than PRECISION characters
5594 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5595 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5597 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5598 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5599 FIELD_WIDTH < 0 means infinite field width. This is useful for
5600 padding with `-' at the end of a mode line. */
5601 if (field_width
< 0)
5602 field_width
= INFINITY
;
5603 if (field_width
> it
->end_charpos
- charpos
)
5604 it
->end_charpos
= charpos
+ field_width
;
5606 /* Use the standard display table for displaying strings. */
5607 if (DISP_TABLE_P (Vstandard_display_table
))
5608 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5610 it
->stop_charpos
= charpos
;
5611 if (s
== NULL
&& it
->multibyte_p
)
5612 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, it
->end_charpos
,
5619 /***********************************************************************
5621 ***********************************************************************/
5623 /* Map enum it_method value to corresponding next_element_from_* function. */
5625 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5627 next_element_from_buffer
,
5628 next_element_from_display_vector
,
5629 next_element_from_string
,
5630 next_element_from_c_string
,
5631 next_element_from_image
,
5632 next_element_from_stretch
5635 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5638 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5639 (possibly with the following characters). */
5641 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS) \
5642 ((IT)->cmp_it.id >= 0 \
5643 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5644 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5645 (IT)->end_charpos, (IT)->w, \
5646 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5650 /* Load IT's display element fields with information about the next
5651 display element from the current position of IT. Value is zero if
5652 end of buffer (or C string) is reached. */
5654 static struct frame
*last_escape_glyph_frame
= NULL
;
5655 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5656 static int last_escape_glyph_merged_face_id
= 0;
5659 get_next_display_element (it
)
5662 /* Non-zero means that we found a display element. Zero means that
5663 we hit the end of what we iterate over. Performance note: the
5664 function pointer `method' used here turns out to be faster than
5665 using a sequence of if-statements. */
5669 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5671 if (it
->what
== IT_CHARACTER
)
5673 /* Map via display table or translate control characters.
5674 IT->c, IT->len etc. have been set to the next character by
5675 the function call above. If we have a display table, and it
5676 contains an entry for IT->c, translate it. Don't do this if
5677 IT->c itself comes from a display table, otherwise we could
5678 end up in an infinite recursion. (An alternative could be to
5679 count the recursion depth of this function and signal an
5680 error when a certain maximum depth is reached.) Is it worth
5682 if (success_p
&& it
->dpvec
== NULL
)
5685 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5686 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5687 nbsp_or_shy
= char_is_other
;
5688 int decoded
= it
->c
;
5691 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5694 struct Lisp_Vector
*v
= XVECTOR (dv
);
5696 /* Return the first character from the display table
5697 entry, if not empty. If empty, don't display the
5698 current character. */
5701 it
->dpvec_char_len
= it
->len
;
5702 it
->dpvec
= v
->contents
;
5703 it
->dpend
= v
->contents
+ v
->size
;
5704 it
->current
.dpvec_index
= 0;
5705 it
->dpvec_face_id
= -1;
5706 it
->saved_face_id
= it
->face_id
;
5707 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5712 set_iterator_to_next (it
, 0);
5717 if (unibyte_display_via_language_environment
5718 && !ASCII_CHAR_P (it
->c
))
5719 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5721 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5723 if (it
->multibyte_p
)
5724 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5725 : it
->c
== 0xAD ? char_is_soft_hyphen
5727 else if (unibyte_display_via_language_environment
)
5728 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5729 : decoded
== 0xAD ? char_is_soft_hyphen
5733 /* Translate control characters into `\003' or `^C' form.
5734 Control characters coming from a display table entry are
5735 currently not translated because we use IT->dpvec to hold
5736 the translation. This could easily be changed but I
5737 don't believe that it is worth doing.
5739 If it->multibyte_p is nonzero, non-printable non-ASCII
5740 characters are also translated to octal form.
5742 If it->multibyte_p is zero, eight-bit characters that
5743 don't have corresponding multibyte char code are also
5744 translated to octal form. */
5746 ? (it
->area
!= TEXT_AREA
5747 /* In mode line, treat \n, \t like other crl chars. */
5750 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5751 || (it
->c
!= '\n' && it
->c
!= '\t'))
5754 ? ! CHAR_PRINTABLE_P (it
->c
)
5755 : (! unibyte_display_via_language_environment
5757 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5759 /* IT->c is a control character which must be displayed
5760 either as '\003' or as `^C' where the '\\' and '^'
5761 can be defined in the display table. Fill
5762 IT->ctl_chars with glyphs for what we have to
5763 display. Then, set IT->dpvec to these glyphs. */
5766 int face_id
, lface_id
= 0 ;
5769 /* Handle control characters with ^. */
5771 if (it
->c
< 128 && it
->ctl_arrow_p
)
5775 g
= '^'; /* default glyph for Control */
5776 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5778 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5779 && GLYPH_CODE_CHAR_VALID_P (gc
))
5781 g
= GLYPH_CODE_CHAR (gc
);
5782 lface_id
= GLYPH_CODE_FACE (gc
);
5786 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5788 else if (it
->f
== last_escape_glyph_frame
5789 && it
->face_id
== last_escape_glyph_face_id
)
5791 face_id
= last_escape_glyph_merged_face_id
;
5795 /* Merge the escape-glyph face into the current face. */
5796 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5798 last_escape_glyph_frame
= it
->f
;
5799 last_escape_glyph_face_id
= it
->face_id
;
5800 last_escape_glyph_merged_face_id
= face_id
;
5803 XSETINT (it
->ctl_chars
[0], g
);
5804 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5806 goto display_control
;
5809 /* Handle non-break space in the mode where it only gets
5812 if (EQ (Vnobreak_char_display
, Qt
)
5813 && nbsp_or_shy
== char_is_nbsp
)
5815 /* Merge the no-break-space face into the current face. */
5816 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5820 XSETINT (it
->ctl_chars
[0], ' ');
5822 goto display_control
;
5825 /* Handle sequences that start with the "escape glyph". */
5827 /* the default escape glyph is \. */
5828 escape_glyph
= '\\';
5831 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5832 && GLYPH_CODE_CHAR_VALID_P (gc
))
5834 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5835 lface_id
= GLYPH_CODE_FACE (gc
);
5839 /* The display table specified a face.
5840 Merge it into face_id and also into escape_glyph. */
5841 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5844 else if (it
->f
== last_escape_glyph_frame
5845 && it
->face_id
== last_escape_glyph_face_id
)
5847 face_id
= last_escape_glyph_merged_face_id
;
5851 /* Merge the escape-glyph face into the current face. */
5852 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5854 last_escape_glyph_frame
= it
->f
;
5855 last_escape_glyph_face_id
= it
->face_id
;
5856 last_escape_glyph_merged_face_id
= face_id
;
5859 /* Handle soft hyphens in the mode where they only get
5862 if (EQ (Vnobreak_char_display
, Qt
)
5863 && nbsp_or_shy
== char_is_soft_hyphen
)
5866 XSETINT (it
->ctl_chars
[0], '-');
5868 goto display_control
;
5871 /* Handle non-break space and soft hyphen
5872 with the escape glyph. */
5876 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5877 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5878 XSETINT (it
->ctl_chars
[1], it
->c
);
5880 goto display_control
;
5884 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5888 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5889 if (CHAR_BYTE8_P (it
->c
))
5891 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5894 else if (it
->c
< 256)
5901 /* It's an invalid character, which shouldn't
5902 happen actually, but due to bugs it may
5903 happen. Let's print the char as is, there's
5904 not much meaningful we can do with it. */
5906 str
[1] = it
->c
>> 8;
5907 str
[2] = it
->c
>> 16;
5908 str
[3] = it
->c
>> 24;
5912 for (i
= 0; i
< len
; i
++)
5915 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
5916 /* Insert three more glyphs into IT->ctl_chars for
5917 the octal display of the character. */
5918 g
= ((str
[i
] >> 6) & 7) + '0';
5919 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
5920 g
= ((str
[i
] >> 3) & 7) + '0';
5921 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
5922 g
= (str
[i
] & 7) + '0';
5923 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
5929 /* Set up IT->dpvec and return first character from it. */
5930 it
->dpvec_char_len
= it
->len
;
5931 it
->dpvec
= it
->ctl_chars
;
5932 it
->dpend
= it
->dpvec
+ ctl_len
;
5933 it
->current
.dpvec_index
= 0;
5934 it
->dpvec_face_id
= face_id
;
5935 it
->saved_face_id
= it
->face_id
;
5936 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5943 #ifdef HAVE_WINDOW_SYSTEM
5944 /* Adjust face id for a multibyte character. There are no multibyte
5945 character in unibyte text. */
5946 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
5949 && FRAME_WINDOW_P (it
->f
))
5951 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5953 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
5955 /* Automatic composition with glyph-string. */
5956 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
5958 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
5962 int pos
= (it
->s
? -1
5963 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
5964 : IT_CHARPOS (*it
));
5966 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
5971 /* Is this character the last one of a run of characters with
5972 box? If yes, set IT->end_of_box_run_p to 1. */
5976 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
5978 int face_id
= underlying_face_id (it
);
5979 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
5983 if (face
->box
== FACE_NO_BOX
)
5985 /* If the box comes from face properties in a
5986 display string, check faces in that string. */
5987 int string_face_id
= face_after_it_pos (it
);
5988 it
->end_of_box_run_p
5989 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
5992 /* Otherwise, the box comes from the underlying face.
5993 If this is the last string character displayed, check
5994 the next buffer location. */
5995 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
5996 && (it
->current
.overlay_string_index
5997 == it
->n_overlay_strings
- 1))
6001 struct text_pos pos
= it
->current
.pos
;
6002 INC_TEXT_POS (pos
, it
->multibyte_p
);
6004 next_face_id
= face_at_buffer_position
6005 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6006 it
->region_end_charpos
, &ignore
,
6007 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6009 it
->end_of_box_run_p
6010 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6017 int face_id
= face_after_it_pos (it
);
6018 it
->end_of_box_run_p
6019 = (face_id
!= it
->face_id
6020 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6024 /* Value is 0 if end of buffer or string reached. */
6029 /* Move IT to the next display element.
6031 RESEAT_P non-zero means if called on a newline in buffer text,
6032 skip to the next visible line start.
6034 Functions get_next_display_element and set_iterator_to_next are
6035 separate because I find this arrangement easier to handle than a
6036 get_next_display_element function that also increments IT's
6037 position. The way it is we can first look at an iterator's current
6038 display element, decide whether it fits on a line, and if it does,
6039 increment the iterator position. The other way around we probably
6040 would either need a flag indicating whether the iterator has to be
6041 incremented the next time, or we would have to implement a
6042 decrement position function which would not be easy to write. */
6045 set_iterator_to_next (it
, reseat_p
)
6049 /* Reset flags indicating start and end of a sequence of characters
6050 with box. Reset them at the start of this function because
6051 moving the iterator to a new position might set them. */
6052 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6056 case GET_FROM_BUFFER
:
6057 /* The current display element of IT is a character from
6058 current_buffer. Advance in the buffer, and maybe skip over
6059 invisible lines that are so because of selective display. */
6060 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6061 reseat_at_next_visible_line_start (it
, 0);
6062 else if (it
->cmp_it
.id
>= 0)
6064 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6065 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6066 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6067 it
->cmp_it
.from
= it
->cmp_it
.to
;
6071 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6072 IT_BYTEPOS (*it
), it
->stop_charpos
,
6078 xassert (it
->len
!= 0);
6079 IT_BYTEPOS (*it
) += it
->len
;
6080 IT_CHARPOS (*it
) += 1;
6081 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6085 case GET_FROM_C_STRING
:
6086 /* Current display element of IT is from a C string. */
6087 IT_BYTEPOS (*it
) += it
->len
;
6088 IT_CHARPOS (*it
) += 1;
6091 case GET_FROM_DISPLAY_VECTOR
:
6092 /* Current display element of IT is from a display table entry.
6093 Advance in the display table definition. Reset it to null if
6094 end reached, and continue with characters from buffers/
6096 ++it
->current
.dpvec_index
;
6098 /* Restore face of the iterator to what they were before the
6099 display vector entry (these entries may contain faces). */
6100 it
->face_id
= it
->saved_face_id
;
6102 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6104 int recheck_faces
= it
->ellipsis_p
;
6107 it
->method
= GET_FROM_C_STRING
;
6108 else if (STRINGP (it
->string
))
6109 it
->method
= GET_FROM_STRING
;
6112 it
->method
= GET_FROM_BUFFER
;
6113 it
->object
= it
->w
->buffer
;
6117 it
->current
.dpvec_index
= -1;
6119 /* Skip over characters which were displayed via IT->dpvec. */
6120 if (it
->dpvec_char_len
< 0)
6121 reseat_at_next_visible_line_start (it
, 1);
6122 else if (it
->dpvec_char_len
> 0)
6124 if (it
->method
== GET_FROM_STRING
6125 && it
->n_overlay_strings
> 0)
6126 it
->ignore_overlay_strings_at_pos_p
= 1;
6127 it
->len
= it
->dpvec_char_len
;
6128 set_iterator_to_next (it
, reseat_p
);
6131 /* Maybe recheck faces after display vector */
6133 it
->stop_charpos
= IT_CHARPOS (*it
);
6137 case GET_FROM_STRING
:
6138 /* Current display element is a character from a Lisp string. */
6139 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6140 if (it
->cmp_it
.id
>= 0)
6142 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6143 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6144 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6145 it
->cmp_it
.from
= it
->cmp_it
.to
;
6149 composition_compute_stop_pos (&it
->cmp_it
,
6150 IT_STRING_CHARPOS (*it
),
6151 IT_STRING_BYTEPOS (*it
),
6152 it
->stop_charpos
, it
->string
);
6157 IT_STRING_BYTEPOS (*it
) += it
->len
;
6158 IT_STRING_CHARPOS (*it
) += 1;
6161 consider_string_end
:
6163 if (it
->current
.overlay_string_index
>= 0)
6165 /* IT->string is an overlay string. Advance to the
6166 next, if there is one. */
6167 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6170 next_overlay_string (it
);
6172 setup_for_ellipsis (it
, 0);
6177 /* IT->string is not an overlay string. If we reached
6178 its end, and there is something on IT->stack, proceed
6179 with what is on the stack. This can be either another
6180 string, this time an overlay string, or a buffer. */
6181 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6185 if (it
->method
== GET_FROM_STRING
)
6186 goto consider_string_end
;
6191 case GET_FROM_IMAGE
:
6192 case GET_FROM_STRETCH
:
6193 /* The position etc with which we have to proceed are on
6194 the stack. The position may be at the end of a string,
6195 if the `display' property takes up the whole string. */
6196 xassert (it
->sp
> 0);
6198 if (it
->method
== GET_FROM_STRING
)
6199 goto consider_string_end
;
6203 /* There are no other methods defined, so this should be a bug. */
6207 xassert (it
->method
!= GET_FROM_STRING
6208 || (STRINGP (it
->string
)
6209 && IT_STRING_CHARPOS (*it
) >= 0));
6212 /* Load IT's display element fields with information about the next
6213 display element which comes from a display table entry or from the
6214 result of translating a control character to one of the forms `^C'
6217 IT->dpvec holds the glyphs to return as characters.
6218 IT->saved_face_id holds the face id before the display vector--it
6219 is restored into IT->face_id in set_iterator_to_next. */
6222 next_element_from_display_vector (it
)
6228 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6230 it
->face_id
= it
->saved_face_id
;
6232 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6233 That seemed totally bogus - so I changed it... */
6234 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6236 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6238 it
->c
= GLYPH_CODE_CHAR (gc
);
6239 it
->len
= CHAR_BYTES (it
->c
);
6241 /* The entry may contain a face id to use. Such a face id is
6242 the id of a Lisp face, not a realized face. A face id of
6243 zero means no face is specified. */
6244 if (it
->dpvec_face_id
>= 0)
6245 it
->face_id
= it
->dpvec_face_id
;
6248 int lface_id
= GLYPH_CODE_FACE (gc
);
6250 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6255 /* Display table entry is invalid. Return a space. */
6256 it
->c
= ' ', it
->len
= 1;
6258 /* Don't change position and object of the iterator here. They are
6259 still the values of the character that had this display table
6260 entry or was translated, and that's what we want. */
6261 it
->what
= IT_CHARACTER
;
6266 /* Load IT with the next display element from Lisp string IT->string.
6267 IT->current.string_pos is the current position within the string.
6268 If IT->current.overlay_string_index >= 0, the Lisp string is an
6272 next_element_from_string (it
)
6275 struct text_pos position
;
6277 xassert (STRINGP (it
->string
));
6278 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6279 position
= it
->current
.string_pos
;
6281 /* Time to check for invisible text? */
6282 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6283 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6287 /* Since a handler may have changed IT->method, we must
6289 return GET_NEXT_DISPLAY_ELEMENT (it
);
6292 if (it
->current
.overlay_string_index
>= 0)
6294 /* Get the next character from an overlay string. In overlay
6295 strings, There is no field width or padding with spaces to
6297 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6302 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6303 IT_STRING_BYTEPOS (*it
))
6304 && next_element_from_composition (it
))
6308 else if (STRING_MULTIBYTE (it
->string
))
6310 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6311 const unsigned char *s
= (SDATA (it
->string
)
6312 + IT_STRING_BYTEPOS (*it
));
6313 it
->c
= string_char_and_length (s
, &it
->len
);
6317 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6323 /* Get the next character from a Lisp string that is not an
6324 overlay string. Such strings come from the mode line, for
6325 example. We may have to pad with spaces, or truncate the
6326 string. See also next_element_from_c_string. */
6327 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6332 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6334 /* Pad with spaces. */
6335 it
->c
= ' ', it
->len
= 1;
6336 CHARPOS (position
) = BYTEPOS (position
) = -1;
6338 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6339 IT_STRING_BYTEPOS (*it
))
6340 && next_element_from_composition (it
))
6344 else if (STRING_MULTIBYTE (it
->string
))
6346 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6347 const unsigned char *s
= (SDATA (it
->string
)
6348 + IT_STRING_BYTEPOS (*it
));
6349 it
->c
= string_char_and_length (s
, &it
->len
);
6353 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6358 /* Record what we have and where it came from. */
6359 it
->what
= IT_CHARACTER
;
6360 it
->object
= it
->string
;
6361 it
->position
= position
;
6366 /* Load IT with next display element from C string IT->s.
6367 IT->string_nchars is the maximum number of characters to return
6368 from the string. IT->end_charpos may be greater than
6369 IT->string_nchars when this function is called, in which case we
6370 may have to return padding spaces. Value is zero if end of string
6371 reached, including padding spaces. */
6374 next_element_from_c_string (it
)
6380 it
->what
= IT_CHARACTER
;
6381 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6384 /* IT's position can be greater IT->string_nchars in case a field
6385 width or precision has been specified when the iterator was
6387 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6389 /* End of the game. */
6393 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6395 /* Pad with spaces. */
6396 it
->c
= ' ', it
->len
= 1;
6397 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6399 else if (it
->multibyte_p
)
6401 /* Implementation note: The calls to strlen apparently aren't a
6402 performance problem because there is no noticeable performance
6403 difference between Emacs running in unibyte or multibyte mode. */
6404 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6405 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6408 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6414 /* Set up IT to return characters from an ellipsis, if appropriate.
6415 The definition of the ellipsis glyphs may come from a display table
6416 entry. This function fills IT with the first glyph from the
6417 ellipsis if an ellipsis is to be displayed. */
6420 next_element_from_ellipsis (it
)
6423 if (it
->selective_display_ellipsis_p
)
6424 setup_for_ellipsis (it
, it
->len
);
6427 /* The face at the current position may be different from the
6428 face we find after the invisible text. Remember what it
6429 was in IT->saved_face_id, and signal that it's there by
6430 setting face_before_selective_p. */
6431 it
->saved_face_id
= it
->face_id
;
6432 it
->method
= GET_FROM_BUFFER
;
6433 it
->object
= it
->w
->buffer
;
6434 reseat_at_next_visible_line_start (it
, 1);
6435 it
->face_before_selective_p
= 1;
6438 return GET_NEXT_DISPLAY_ELEMENT (it
);
6442 /* Deliver an image display element. The iterator IT is already
6443 filled with image information (done in handle_display_prop). Value
6448 next_element_from_image (it
)
6451 it
->what
= IT_IMAGE
;
6456 /* Fill iterator IT with next display element from a stretch glyph
6457 property. IT->object is the value of the text property. Value is
6461 next_element_from_stretch (it
)
6464 it
->what
= IT_STRETCH
;
6469 /* Load IT with the next display element from current_buffer. Value
6470 is zero if end of buffer reached. IT->stop_charpos is the next
6471 position at which to stop and check for text properties or buffer
6475 next_element_from_buffer (it
)
6480 xassert (IT_CHARPOS (*it
) >= BEGV
);
6482 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6484 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6486 int overlay_strings_follow_p
;
6488 /* End of the game, except when overlay strings follow that
6489 haven't been returned yet. */
6490 if (it
->overlay_strings_at_end_processed_p
)
6491 overlay_strings_follow_p
= 0;
6494 it
->overlay_strings_at_end_processed_p
= 1;
6495 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6498 if (overlay_strings_follow_p
)
6499 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6503 it
->position
= it
->current
.pos
;
6510 return GET_NEXT_DISPLAY_ELEMENT (it
);
6515 /* No face changes, overlays etc. in sight, so just return a
6516 character from current_buffer. */
6519 /* Maybe run the redisplay end trigger hook. Performance note:
6520 This doesn't seem to cost measurable time. */
6521 if (it
->redisplay_end_trigger_charpos
6523 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6524 run_redisplay_end_trigger_hook (it
);
6526 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
))
6527 && next_element_from_composition (it
))
6532 /* Get the next character, maybe multibyte. */
6533 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6534 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6535 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6537 it
->c
= *p
, it
->len
= 1;
6539 /* Record what we have and where it came from. */
6540 it
->what
= IT_CHARACTER
;
6541 it
->object
= it
->w
->buffer
;
6542 it
->position
= it
->current
.pos
;
6544 /* Normally we return the character found above, except when we
6545 really want to return an ellipsis for selective display. */
6550 /* A value of selective > 0 means hide lines indented more
6551 than that number of columns. */
6552 if (it
->selective
> 0
6553 && IT_CHARPOS (*it
) + 1 < ZV
6554 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6555 IT_BYTEPOS (*it
) + 1,
6556 (double) it
->selective
)) /* iftc */
6558 success_p
= next_element_from_ellipsis (it
);
6559 it
->dpvec_char_len
= -1;
6562 else if (it
->c
== '\r' && it
->selective
== -1)
6564 /* A value of selective == -1 means that everything from the
6565 CR to the end of the line is invisible, with maybe an
6566 ellipsis displayed for it. */
6567 success_p
= next_element_from_ellipsis (it
);
6568 it
->dpvec_char_len
= -1;
6573 /* Value is zero if end of buffer reached. */
6574 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6579 /* Run the redisplay end trigger hook for IT. */
6582 run_redisplay_end_trigger_hook (it
)
6585 Lisp_Object args
[3];
6587 /* IT->glyph_row should be non-null, i.e. we should be actually
6588 displaying something, or otherwise we should not run the hook. */
6589 xassert (it
->glyph_row
);
6591 /* Set up hook arguments. */
6592 args
[0] = Qredisplay_end_trigger_functions
;
6593 args
[1] = it
->window
;
6594 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6595 it
->redisplay_end_trigger_charpos
= 0;
6597 /* Since we are *trying* to run these functions, don't try to run
6598 them again, even if they get an error. */
6599 it
->w
->redisplay_end_trigger
= Qnil
;
6600 Frun_hook_with_args (3, args
);
6602 /* Notice if it changed the face of the character we are on. */
6603 handle_face_prop (it
);
6607 /* Deliver a composition display element. Unlike the other
6608 next_element_from_XXX, this function is not registered in the array
6609 get_next_element[]. It is called from next_element_from_buffer and
6610 next_element_from_string when necessary. */
6613 next_element_from_composition (it
)
6616 it
->what
= IT_COMPOSITION
;
6617 it
->len
= it
->cmp_it
.nbytes
;
6618 if (STRINGP (it
->string
))
6622 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6623 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6626 it
->position
= it
->current
.string_pos
;
6627 it
->object
= it
->string
;
6628 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6629 IT_STRING_BYTEPOS (*it
), it
->string
);
6635 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6636 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6639 it
->position
= it
->current
.pos
;
6640 it
->object
= it
->w
->buffer
;
6641 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6642 IT_BYTEPOS (*it
), Qnil
);
6649 /***********************************************************************
6650 Moving an iterator without producing glyphs
6651 ***********************************************************************/
6653 /* Check if iterator is at a position corresponding to a valid buffer
6654 position after some move_it_ call. */
6656 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6657 ((it)->method == GET_FROM_STRING \
6658 ? IT_STRING_CHARPOS (*it) == 0 \
6662 /* Move iterator IT to a specified buffer or X position within one
6663 line on the display without producing glyphs.
6665 OP should be a bit mask including some or all of these bits:
6666 MOVE_TO_X: Stop on reaching x-position TO_X.
6667 MOVE_TO_POS: Stop on reaching buffer or string position TO_CHARPOS.
6668 Regardless of OP's value, stop in reaching the end of the display line.
6670 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6671 This means, in particular, that TO_X includes window's horizontal
6674 The return value has several possible values that
6675 say what condition caused the scan to stop:
6677 MOVE_POS_MATCH_OR_ZV
6678 - when TO_POS or ZV was reached.
6681 -when TO_X was reached before TO_POS or ZV were reached.
6684 - when we reached the end of the display area and the line must
6688 - when we reached the end of the display area and the line is
6692 - when we stopped at a line end, i.e. a newline or a CR and selective
6695 static enum move_it_result
6696 move_it_in_display_line_to (struct it
*it
,
6697 EMACS_INT to_charpos
, int to_x
,
6698 enum move_operation_enum op
)
6700 enum move_it_result result
= MOVE_UNDEFINED
;
6701 struct glyph_row
*saved_glyph_row
;
6702 struct it wrap_it
, atpos_it
, atx_it
;
6705 /* Don't produce glyphs in produce_glyphs. */
6706 saved_glyph_row
= it
->glyph_row
;
6707 it
->glyph_row
= NULL
;
6709 /* Use wrap_it to save a copy of IT wherever a word wrap could
6710 occur. Use atpos_it to save a copy of IT at the desired buffer
6711 position, if found, so that we can scan ahead and check if the
6712 word later overshoots the window edge. Use atx_it similarly, for
6718 #define BUFFER_POS_REACHED_P() \
6719 ((op & MOVE_TO_POS) != 0 \
6720 && BUFFERP (it->object) \
6721 && IT_CHARPOS (*it) >= to_charpos \
6722 && (it->method == GET_FROM_BUFFER \
6723 || (it->method == GET_FROM_DISPLAY_VECTOR \
6724 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
6726 /* If there's a line-/wrap-prefix, handle it. */
6727 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
6728 && it
->current_y
< it
->last_visible_y
)
6729 handle_line_prefix (it
);
6733 int x
, i
, ascent
= 0, descent
= 0;
6735 /* Utility macro to reset an iterator with x, ascent, and descent. */
6736 #define IT_RESET_X_ASCENT_DESCENT(IT) \
6737 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
6738 (IT)->max_descent = descent)
6740 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
6742 if ((op
& MOVE_TO_POS
) != 0
6743 && BUFFERP (it
->object
)
6744 && it
->method
== GET_FROM_BUFFER
6745 && IT_CHARPOS (*it
) > to_charpos
)
6747 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6749 result
= MOVE_POS_MATCH_OR_ZV
;
6752 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6753 /* If wrap_it is valid, the current position might be in a
6754 word that is wrapped. So, save the iterator in
6755 atpos_it and continue to see if wrapping happens. */
6759 /* Stop when ZV reached.
6760 We used to stop here when TO_CHARPOS reached as well, but that is
6761 too soon if this glyph does not fit on this line. So we handle it
6762 explicitly below. */
6763 if (!get_next_display_element (it
))
6765 result
= MOVE_POS_MATCH_OR_ZV
;
6769 if (it
->line_wrap
== TRUNCATE
)
6771 if (BUFFER_POS_REACHED_P ())
6773 result
= MOVE_POS_MATCH_OR_ZV
;
6779 if (it
->line_wrap
== WORD_WRAP
)
6781 if (IT_DISPLAYING_WHITESPACE (it
))
6785 /* We have reached a glyph that follows one or more
6786 whitespace characters. If the position is
6787 already found, we are done. */
6788 if (atpos_it
.sp
>= 0)
6791 result
= MOVE_POS_MATCH_OR_ZV
;
6797 result
= MOVE_X_REACHED
;
6800 /* Otherwise, we can wrap here. */
6807 /* Remember the line height for the current line, in case
6808 the next element doesn't fit on the line. */
6809 ascent
= it
->max_ascent
;
6810 descent
= it
->max_descent
;
6812 /* The call to produce_glyphs will get the metrics of the
6813 display element IT is loaded with. Record the x-position
6814 before this display element, in case it doesn't fit on the
6818 PRODUCE_GLYPHS (it
);
6820 if (it
->area
!= TEXT_AREA
)
6822 set_iterator_to_next (it
, 1);
6826 /* The number of glyphs we get back in IT->nglyphs will normally
6827 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
6828 character on a terminal frame, or (iii) a line end. For the
6829 second case, IT->nglyphs - 1 padding glyphs will be present.
6830 (On X frames, there is only one glyph produced for a
6831 composite character.)
6833 The behavior implemented below means, for continuation lines,
6834 that as many spaces of a TAB as fit on the current line are
6835 displayed there. For terminal frames, as many glyphs of a
6836 multi-glyph character are displayed in the current line, too.
6837 This is what the old redisplay code did, and we keep it that
6838 way. Under X, the whole shape of a complex character must
6839 fit on the line or it will be completely displayed in the
6842 Note that both for tabs and padding glyphs, all glyphs have
6846 /* More than one glyph or glyph doesn't fit on line. All
6847 glyphs have the same width. */
6848 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
6850 int x_before_this_char
= x
;
6851 int hpos_before_this_char
= it
->hpos
;
6853 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
6855 new_x
= x
+ single_glyph_width
;
6857 /* We want to leave anything reaching TO_X to the caller. */
6858 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
6860 if (BUFFER_POS_REACHED_P ())
6862 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6863 goto buffer_pos_reached
;
6864 if (atpos_it
.sp
< 0)
6867 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6872 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6875 result
= MOVE_X_REACHED
;
6881 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
6886 if (/* Lines are continued. */
6887 it
->line_wrap
!= TRUNCATE
6888 && (/* And glyph doesn't fit on the line. */
6889 new_x
> it
->last_visible_x
6890 /* Or it fits exactly and we're on a window
6892 || (new_x
== it
->last_visible_x
6893 && FRAME_WINDOW_P (it
->f
))))
6895 if (/* IT->hpos == 0 means the very first glyph
6896 doesn't fit on the line, e.g. a wide image. */
6898 || (new_x
== it
->last_visible_x
6899 && FRAME_WINDOW_P (it
->f
)))
6902 it
->current_x
= new_x
;
6904 /* The character's last glyph just barely fits
6906 if (i
== it
->nglyphs
- 1)
6908 /* If this is the destination position,
6909 return a position *before* it in this row,
6910 now that we know it fits in this row. */
6911 if (BUFFER_POS_REACHED_P ())
6913 if (it
->line_wrap
!= WORD_WRAP
6916 it
->hpos
= hpos_before_this_char
;
6917 it
->current_x
= x_before_this_char
;
6918 result
= MOVE_POS_MATCH_OR_ZV
;
6921 if (it
->line_wrap
== WORD_WRAP
6925 atpos_it
.current_x
= x_before_this_char
;
6926 atpos_it
.hpos
= hpos_before_this_char
;
6930 set_iterator_to_next (it
, 1);
6931 /* On graphical terminals, newlines may
6932 "overflow" into the fringe if
6933 overflow-newline-into-fringe is non-nil.
6934 On text-only terminals, newlines may
6935 overflow into the last glyph on the
6937 if (!FRAME_WINDOW_P (it
->f
)
6938 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
6940 if (!get_next_display_element (it
))
6942 result
= MOVE_POS_MATCH_OR_ZV
;
6945 if (BUFFER_POS_REACHED_P ())
6947 if (ITERATOR_AT_END_OF_LINE_P (it
))
6948 result
= MOVE_POS_MATCH_OR_ZV
;
6950 result
= MOVE_LINE_CONTINUED
;
6953 if (ITERATOR_AT_END_OF_LINE_P (it
))
6955 result
= MOVE_NEWLINE_OR_CR
;
6962 IT_RESET_X_ASCENT_DESCENT (it
);
6964 if (wrap_it
.sp
>= 0)
6971 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
6973 result
= MOVE_LINE_CONTINUED
;
6977 if (BUFFER_POS_REACHED_P ())
6979 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
6980 goto buffer_pos_reached
;
6981 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
6984 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
6988 if (new_x
> it
->first_visible_x
)
6990 /* Glyph is visible. Increment number of glyphs that
6991 would be displayed. */
6996 if (result
!= MOVE_UNDEFINED
)
6999 else if (BUFFER_POS_REACHED_P ())
7002 IT_RESET_X_ASCENT_DESCENT (it
);
7003 result
= MOVE_POS_MATCH_OR_ZV
;
7006 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7008 /* Stop when TO_X specified and reached. This check is
7009 necessary here because of lines consisting of a line end,
7010 only. The line end will not produce any glyphs and we
7011 would never get MOVE_X_REACHED. */
7012 xassert (it
->nglyphs
== 0);
7013 result
= MOVE_X_REACHED
;
7017 /* Is this a line end? If yes, we're done. */
7018 if (ITERATOR_AT_END_OF_LINE_P (it
))
7020 result
= MOVE_NEWLINE_OR_CR
;
7024 /* The current display element has been consumed. Advance
7026 set_iterator_to_next (it
, 1);
7028 /* Stop if lines are truncated and IT's current x-position is
7029 past the right edge of the window now. */
7030 if (it
->line_wrap
== TRUNCATE
7031 && it
->current_x
>= it
->last_visible_x
)
7033 if (!FRAME_WINDOW_P (it
->f
)
7034 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7036 if (!get_next_display_element (it
)
7037 || BUFFER_POS_REACHED_P ())
7039 result
= MOVE_POS_MATCH_OR_ZV
;
7042 if (ITERATOR_AT_END_OF_LINE_P (it
))
7044 result
= MOVE_NEWLINE_OR_CR
;
7048 result
= MOVE_LINE_TRUNCATED
;
7051 #undef IT_RESET_X_ASCENT_DESCENT
7054 #undef BUFFER_POS_REACHED_P
7056 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7057 restore the saved iterator. */
7058 if (atpos_it
.sp
>= 0)
7060 else if (atx_it
.sp
>= 0)
7065 /* Restore the iterator settings altered at the beginning of this
7067 it
->glyph_row
= saved_glyph_row
;
7071 /* For external use. */
7073 move_it_in_display_line (struct it
*it
,
7074 EMACS_INT to_charpos
, int to_x
,
7075 enum move_operation_enum op
)
7077 if (it
->line_wrap
== WORD_WRAP
7078 && (op
& MOVE_TO_X
))
7080 struct it save_it
= *it
;
7081 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7082 /* When word-wrap is on, TO_X may lie past the end
7083 of a wrapped line. Then it->current is the
7084 character on the next line, so backtrack to the
7085 space before the wrap point. */
7086 if (skip
== MOVE_LINE_CONTINUED
)
7088 int prev_x
= max (it
->current_x
- 1, 0);
7090 move_it_in_display_line_to
7091 (it
, -1, prev_x
, MOVE_TO_X
);
7095 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7099 /* Move IT forward until it satisfies one or more of the criteria in
7100 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7102 OP is a bit-mask that specifies where to stop, and in particular,
7103 which of those four position arguments makes a difference. See the
7104 description of enum move_operation_enum.
7106 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7107 screen line, this function will set IT to the next position >
7111 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7113 int to_charpos
, to_x
, to_y
, to_vpos
;
7116 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7117 int line_height
, line_start_x
= 0, reached
= 0;
7121 if (op
& MOVE_TO_VPOS
)
7123 /* If no TO_CHARPOS and no TO_X specified, stop at the
7124 start of the line TO_VPOS. */
7125 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7127 if (it
->vpos
== to_vpos
)
7133 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7137 /* TO_VPOS >= 0 means stop at TO_X in the line at
7138 TO_VPOS, or at TO_POS, whichever comes first. */
7139 if (it
->vpos
== to_vpos
)
7145 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7147 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7152 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7154 /* We have reached TO_X but not in the line we want. */
7155 skip
= move_it_in_display_line_to (it
, to_charpos
,
7157 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7165 else if (op
& MOVE_TO_Y
)
7167 struct it it_backup
;
7169 if (it
->line_wrap
== WORD_WRAP
)
7172 /* TO_Y specified means stop at TO_X in the line containing
7173 TO_Y---or at TO_CHARPOS if this is reached first. The
7174 problem is that we can't really tell whether the line
7175 contains TO_Y before we have completely scanned it, and
7176 this may skip past TO_X. What we do is to first scan to
7179 If TO_X is not specified, use a TO_X of zero. The reason
7180 is to make the outcome of this function more predictable.
7181 If we didn't use TO_X == 0, we would stop at the end of
7182 the line which is probably not what a caller would expect
7184 skip
= move_it_in_display_line_to
7185 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7186 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7188 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7189 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7191 else if (skip
== MOVE_X_REACHED
)
7193 /* If TO_X was reached, we want to know whether TO_Y is
7194 in the line. We know this is the case if the already
7195 scanned glyphs make the line tall enough. Otherwise,
7196 we must check by scanning the rest of the line. */
7197 line_height
= it
->max_ascent
+ it
->max_descent
;
7198 if (to_y
>= it
->current_y
7199 && to_y
< it
->current_y
+ line_height
)
7205 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7206 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7208 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7209 line_height
= it
->max_ascent
+ it
->max_descent
;
7210 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7212 if (to_y
>= it
->current_y
7213 && to_y
< it
->current_y
+ line_height
)
7215 /* If TO_Y is in this line and TO_X was reached
7216 above, we scanned too far. We have to restore
7217 IT's settings to the ones before skipping. */
7224 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7230 /* Check whether TO_Y is in this line. */
7231 line_height
= it
->max_ascent
+ it
->max_descent
;
7232 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7234 if (to_y
>= it
->current_y
7235 && to_y
< it
->current_y
+ line_height
)
7237 /* When word-wrap is on, TO_X may lie past the end
7238 of a wrapped line. Then it->current is the
7239 character on the next line, so backtrack to the
7240 space before the wrap point. */
7241 if (skip
== MOVE_LINE_CONTINUED
7242 && it
->line_wrap
== WORD_WRAP
)
7244 int prev_x
= max (it
->current_x
- 1, 0);
7246 skip
= move_it_in_display_line_to
7247 (it
, -1, prev_x
, MOVE_TO_X
);
7256 else if (BUFFERP (it
->object
)
7257 && (it
->method
== GET_FROM_BUFFER
7258 || it
->method
== GET_FROM_STRETCH
)
7259 && IT_CHARPOS (*it
) >= to_charpos
)
7260 skip
= MOVE_POS_MATCH_OR_ZV
;
7262 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7266 case MOVE_POS_MATCH_OR_ZV
:
7270 case MOVE_NEWLINE_OR_CR
:
7271 set_iterator_to_next (it
, 1);
7272 it
->continuation_lines_width
= 0;
7275 case MOVE_LINE_TRUNCATED
:
7276 it
->continuation_lines_width
= 0;
7277 reseat_at_next_visible_line_start (it
, 0);
7278 if ((op
& MOVE_TO_POS
) != 0
7279 && IT_CHARPOS (*it
) > to_charpos
)
7286 case MOVE_LINE_CONTINUED
:
7287 /* For continued lines ending in a tab, some of the glyphs
7288 associated with the tab are displayed on the current
7289 line. Since it->current_x does not include these glyphs,
7290 we use it->last_visible_x instead. */
7293 it
->continuation_lines_width
+= it
->last_visible_x
;
7294 /* When moving by vpos, ensure that the iterator really
7295 advances to the next line (bug#847, bug#969). Fixme:
7296 do we need to do this in other circumstances? */
7297 if (it
->current_x
!= it
->last_visible_x
7298 && (op
& MOVE_TO_VPOS
)
7299 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7301 line_start_x
= it
->current_x
+ it
->pixel_width
7302 - it
->last_visible_x
;
7303 set_iterator_to_next (it
, 0);
7307 it
->continuation_lines_width
+= it
->current_x
;
7314 /* Reset/increment for the next run. */
7315 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7316 it
->current_x
= line_start_x
;
7319 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7321 last_height
= it
->max_ascent
+ it
->max_descent
;
7322 last_max_ascent
= it
->max_ascent
;
7323 it
->max_ascent
= it
->max_descent
= 0;
7328 /* On text terminals, we may stop at the end of a line in the middle
7329 of a multi-character glyph. If the glyph itself is continued,
7330 i.e. it is actually displayed on the next line, don't treat this
7331 stopping point as valid; move to the next line instead (unless
7332 that brings us offscreen). */
7333 if (!FRAME_WINDOW_P (it
->f
)
7335 && IT_CHARPOS (*it
) == to_charpos
7336 && it
->what
== IT_CHARACTER
7338 && it
->line_wrap
== WINDOW_WRAP
7339 && it
->current_x
== it
->last_visible_x
- 1
7342 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7344 it
->continuation_lines_width
+= it
->current_x
;
7345 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7346 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7348 last_height
= it
->max_ascent
+ it
->max_descent
;
7349 last_max_ascent
= it
->max_ascent
;
7352 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7356 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7358 If DY > 0, move IT backward at least that many pixels. DY = 0
7359 means move IT backward to the preceding line start or BEGV. This
7360 function may move over more than DY pixels if IT->current_y - DY
7361 ends up in the middle of a line; in this case IT->current_y will be
7362 set to the top of the line moved to. */
7365 move_it_vertically_backward (it
, dy
)
7376 start_pos
= IT_CHARPOS (*it
);
7378 /* Estimate how many newlines we must move back. */
7379 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7381 /* Set the iterator's position that many lines back. */
7382 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7383 back_to_previous_visible_line_start (it
);
7385 /* Reseat the iterator here. When moving backward, we don't want
7386 reseat to skip forward over invisible text, set up the iterator
7387 to deliver from overlay strings at the new position etc. So,
7388 use reseat_1 here. */
7389 reseat_1 (it
, it
->current
.pos
, 1);
7391 /* We are now surely at a line start. */
7392 it
->current_x
= it
->hpos
= 0;
7393 it
->continuation_lines_width
= 0;
7395 /* Move forward and see what y-distance we moved. First move to the
7396 start of the next line so that we get its height. We need this
7397 height to be able to tell whether we reached the specified
7400 it2
.max_ascent
= it2
.max_descent
= 0;
7403 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7404 MOVE_TO_POS
| MOVE_TO_VPOS
);
7406 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7407 xassert (IT_CHARPOS (*it
) >= BEGV
);
7410 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7411 xassert (IT_CHARPOS (*it
) >= BEGV
);
7412 /* H is the actual vertical distance from the position in *IT
7413 and the starting position. */
7414 h
= it2
.current_y
- it
->current_y
;
7415 /* NLINES is the distance in number of lines. */
7416 nlines
= it2
.vpos
- it
->vpos
;
7418 /* Correct IT's y and vpos position
7419 so that they are relative to the starting point. */
7425 /* DY == 0 means move to the start of the screen line. The
7426 value of nlines is > 0 if continuation lines were involved. */
7428 move_it_by_lines (it
, nlines
, 1);
7432 /* The y-position we try to reach, relative to *IT.
7433 Note that H has been subtracted in front of the if-statement. */
7434 int target_y
= it
->current_y
+ h
- dy
;
7435 int y0
= it3
.current_y
;
7436 int y1
= line_bottom_y (&it3
);
7437 int line_height
= y1
- y0
;
7439 /* If we did not reach target_y, try to move further backward if
7440 we can. If we moved too far backward, try to move forward. */
7441 if (target_y
< it
->current_y
7442 /* This is heuristic. In a window that's 3 lines high, with
7443 a line height of 13 pixels each, recentering with point
7444 on the bottom line will try to move -39/2 = 19 pixels
7445 backward. Try to avoid moving into the first line. */
7446 && (it
->current_y
- target_y
7447 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7448 && IT_CHARPOS (*it
) > BEGV
)
7450 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7451 target_y
- it
->current_y
));
7452 dy
= it
->current_y
- target_y
;
7453 goto move_further_back
;
7455 else if (target_y
>= it
->current_y
+ line_height
7456 && IT_CHARPOS (*it
) < ZV
)
7458 /* Should move forward by at least one line, maybe more.
7460 Note: Calling move_it_by_lines can be expensive on
7461 terminal frames, where compute_motion is used (via
7462 vmotion) to do the job, when there are very long lines
7463 and truncate-lines is nil. That's the reason for
7464 treating terminal frames specially here. */
7466 if (!FRAME_WINDOW_P (it
->f
))
7467 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7472 move_it_by_lines (it
, 1, 1);
7474 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7481 /* Move IT by a specified amount of pixel lines DY. DY negative means
7482 move backwards. DY = 0 means move to start of screen line. At the
7483 end, IT will be on the start of a screen line. */
7486 move_it_vertically (it
, dy
)
7491 move_it_vertically_backward (it
, -dy
);
7494 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7495 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7496 MOVE_TO_POS
| MOVE_TO_Y
);
7497 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7499 /* If buffer ends in ZV without a newline, move to the start of
7500 the line to satisfy the post-condition. */
7501 if (IT_CHARPOS (*it
) == ZV
7503 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7504 move_it_by_lines (it
, 0, 0);
7509 /* Move iterator IT past the end of the text line it is in. */
7512 move_it_past_eol (it
)
7515 enum move_it_result rc
;
7517 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7518 if (rc
== MOVE_NEWLINE_OR_CR
)
7519 set_iterator_to_next (it
, 0);
7523 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7524 negative means move up. DVPOS == 0 means move to the start of the
7525 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7526 NEED_Y_P is zero, IT->current_y will be left unchanged.
7528 Further optimization ideas: If we would know that IT->f doesn't use
7529 a face with proportional font, we could be faster for
7530 truncate-lines nil. */
7533 move_it_by_lines (it
, dvpos
, need_y_p
)
7535 int dvpos
, need_y_p
;
7537 struct position pos
;
7539 /* The commented-out optimization uses vmotion on terminals. This
7540 gives bad results, because elements like it->what, on which
7541 callers such as pos_visible_p rely, aren't updated. */
7542 /* if (!FRAME_WINDOW_P (it->f))
7544 struct text_pos textpos;
7546 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7547 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7548 reseat (it, textpos, 1);
7549 it->vpos += pos.vpos;
7550 it->current_y += pos.vpos;
7556 /* DVPOS == 0 means move to the start of the screen line. */
7557 move_it_vertically_backward (it
, 0);
7558 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7559 /* Let next call to line_bottom_y calculate real line height */
7564 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7565 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7566 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7571 int start_charpos
, i
;
7573 /* Start at the beginning of the screen line containing IT's
7574 position. This may actually move vertically backwards,
7575 in case of overlays, so adjust dvpos accordingly. */
7577 move_it_vertically_backward (it
, 0);
7580 /* Go back -DVPOS visible lines and reseat the iterator there. */
7581 start_charpos
= IT_CHARPOS (*it
);
7582 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7583 back_to_previous_visible_line_start (it
);
7584 reseat (it
, it
->current
.pos
, 1);
7586 /* Move further back if we end up in a string or an image. */
7587 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7589 /* First try to move to start of display line. */
7591 move_it_vertically_backward (it
, 0);
7593 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7595 /* If start of line is still in string or image,
7596 move further back. */
7597 back_to_previous_visible_line_start (it
);
7598 reseat (it
, it
->current
.pos
, 1);
7602 it
->current_x
= it
->hpos
= 0;
7604 /* Above call may have moved too far if continuation lines
7605 are involved. Scan forward and see if it did. */
7607 it2
.vpos
= it2
.current_y
= 0;
7608 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7609 it
->vpos
-= it2
.vpos
;
7610 it
->current_y
-= it2
.current_y
;
7611 it
->current_x
= it
->hpos
= 0;
7613 /* If we moved too far back, move IT some lines forward. */
7614 if (it2
.vpos
> -dvpos
)
7616 int delta
= it2
.vpos
+ dvpos
;
7618 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7619 /* Move back again if we got too far ahead. */
7620 if (IT_CHARPOS (*it
) >= start_charpos
)
7626 /* Return 1 if IT points into the middle of a display vector. */
7629 in_display_vector_p (it
)
7632 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7633 && it
->current
.dpvec_index
> 0
7634 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7638 /***********************************************************************
7640 ***********************************************************************/
7643 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7647 add_to_log (format
, arg1
, arg2
)
7649 Lisp_Object arg1
, arg2
;
7651 Lisp_Object args
[3];
7652 Lisp_Object msg
, fmt
;
7655 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7658 /* Do nothing if called asynchronously. Inserting text into
7659 a buffer may call after-change-functions and alike and
7660 that would means running Lisp asynchronously. */
7661 if (handling_signal
)
7665 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7667 args
[0] = fmt
= build_string (format
);
7670 msg
= Fformat (3, args
);
7672 len
= SBYTES (msg
) + 1;
7673 SAFE_ALLOCA (buffer
, char *, len
);
7674 bcopy (SDATA (msg
), buffer
, len
);
7676 message_dolog (buffer
, len
- 1, 1, 0);
7683 /* Output a newline in the *Messages* buffer if "needs" one. */
7686 message_log_maybe_newline ()
7688 if (message_log_need_newline
)
7689 message_dolog ("", 0, 1, 0);
7693 /* Add a string M of length NBYTES to the message log, optionally
7694 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
7695 nonzero, means interpret the contents of M as multibyte. This
7696 function calls low-level routines in order to bypass text property
7697 hooks, etc. which might not be safe to run.
7699 This may GC (insert may run before/after change hooks),
7700 so the buffer M must NOT point to a Lisp string. */
7703 message_dolog (m
, nbytes
, nlflag
, multibyte
)
7705 int nbytes
, nlflag
, multibyte
;
7707 if (!NILP (Vmemory_full
))
7710 if (!NILP (Vmessage_log_max
))
7712 struct buffer
*oldbuf
;
7713 Lisp_Object oldpoint
, oldbegv
, oldzv
;
7714 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
7715 int point_at_end
= 0;
7717 Lisp_Object old_deactivate_mark
, tem
;
7718 struct gcpro gcpro1
;
7720 old_deactivate_mark
= Vdeactivate_mark
;
7721 oldbuf
= current_buffer
;
7722 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
7723 current_buffer
->undo_list
= Qt
;
7725 oldpoint
= message_dolog_marker1
;
7726 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
7727 oldbegv
= message_dolog_marker2
;
7728 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
7729 oldzv
= message_dolog_marker3
;
7730 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
7731 GCPRO1 (old_deactivate_mark
);
7739 BEGV_BYTE
= BEG_BYTE
;
7742 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7744 /* Insert the string--maybe converting multibyte to single byte
7745 or vice versa, so that all the text fits the buffer. */
7747 && NILP (current_buffer
->enable_multibyte_characters
))
7749 int i
, c
, char_bytes
;
7750 unsigned char work
[1];
7752 /* Convert a multibyte string to single-byte
7753 for the *Message* buffer. */
7754 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
7756 c
= string_char_and_length (m
+ i
, &char_bytes
);
7757 work
[0] = (ASCII_CHAR_P (c
)
7759 : multibyte_char_to_unibyte (c
, Qnil
));
7760 insert_1_both (work
, 1, 1, 1, 0, 0);
7763 else if (! multibyte
7764 && ! NILP (current_buffer
->enable_multibyte_characters
))
7766 int i
, c
, char_bytes
;
7767 unsigned char *msg
= (unsigned char *) m
;
7768 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
7769 /* Convert a single-byte string to multibyte
7770 for the *Message* buffer. */
7771 for (i
= 0; i
< nbytes
; i
++)
7774 MAKE_CHAR_MULTIBYTE (c
);
7775 char_bytes
= CHAR_STRING (c
, str
);
7776 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
7780 insert_1 (m
, nbytes
, 1, 0, 0);
7784 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
7785 insert_1 ("\n", 1, 1, 0, 0);
7787 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7789 this_bol_byte
= PT_BYTE
;
7791 /* See if this line duplicates the previous one.
7792 If so, combine duplicates. */
7795 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
7797 prev_bol_byte
= PT_BYTE
;
7799 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
7800 this_bol
, this_bol_byte
);
7803 del_range_both (prev_bol
, prev_bol_byte
,
7804 this_bol
, this_bol_byte
, 0);
7810 /* If you change this format, don't forget to also
7811 change message_log_check_duplicate. */
7812 sprintf (dupstr
, " [%d times]", dup
);
7813 duplen
= strlen (dupstr
);
7814 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
7815 insert_1 (dupstr
, duplen
, 1, 0, 1);
7820 /* If we have more than the desired maximum number of lines
7821 in the *Messages* buffer now, delete the oldest ones.
7822 This is safe because we don't have undo in this buffer. */
7824 if (NATNUMP (Vmessage_log_max
))
7826 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
7827 -XFASTINT (Vmessage_log_max
) - 1, 0);
7828 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
7831 BEGV
= XMARKER (oldbegv
)->charpos
;
7832 BEGV_BYTE
= marker_byte_position (oldbegv
);
7841 ZV
= XMARKER (oldzv
)->charpos
;
7842 ZV_BYTE
= marker_byte_position (oldzv
);
7846 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
7848 /* We can't do Fgoto_char (oldpoint) because it will run some
7850 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
7851 XMARKER (oldpoint
)->bytepos
);
7854 unchain_marker (XMARKER (oldpoint
));
7855 unchain_marker (XMARKER (oldbegv
));
7856 unchain_marker (XMARKER (oldzv
));
7858 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
7859 set_buffer_internal (oldbuf
);
7861 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
7862 message_log_need_newline
= !nlflag
;
7863 Vdeactivate_mark
= old_deactivate_mark
;
7868 /* We are at the end of the buffer after just having inserted a newline.
7869 (Note: We depend on the fact we won't be crossing the gap.)
7870 Check to see if the most recent message looks a lot like the previous one.
7871 Return 0 if different, 1 if the new one should just replace it, or a
7872 value N > 1 if we should also append " [N times]". */
7875 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
7876 int prev_bol
, this_bol
;
7877 int prev_bol_byte
, this_bol_byte
;
7880 int len
= Z_BYTE
- 1 - this_bol_byte
;
7882 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
7883 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
7885 for (i
= 0; i
< len
; i
++)
7887 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
7895 if (*p1
++ == ' ' && *p1
++ == '[')
7898 while (*p1
>= '0' && *p1
<= '9')
7899 n
= n
* 10 + *p1
++ - '0';
7900 if (strncmp (p1
, " times]\n", 8) == 0)
7907 /* Display an echo area message M with a specified length of NBYTES
7908 bytes. The string may include null characters. If M is 0, clear
7909 out any existing message, and let the mini-buffer text show
7912 This may GC, so the buffer M must NOT point to a Lisp string. */
7915 message2 (m
, nbytes
, multibyte
)
7920 /* First flush out any partial line written with print. */
7921 message_log_maybe_newline ();
7923 message_dolog (m
, nbytes
, 1, multibyte
);
7924 message2_nolog (m
, nbytes
, multibyte
);
7928 /* The non-logging counterpart of message2. */
7931 message2_nolog (m
, nbytes
, multibyte
)
7933 int nbytes
, multibyte
;
7935 struct frame
*sf
= SELECTED_FRAME ();
7936 message_enable_multibyte
= multibyte
;
7938 if (FRAME_INITIAL_P (sf
))
7940 if (noninteractive_need_newline
)
7941 putc ('\n', stderr
);
7942 noninteractive_need_newline
= 0;
7944 fwrite (m
, nbytes
, 1, stderr
);
7945 if (cursor_in_echo_area
== 0)
7946 fprintf (stderr
, "\n");
7949 /* A null message buffer means that the frame hasn't really been
7950 initialized yet. Error messages get reported properly by
7951 cmd_error, so this must be just an informative message; toss it. */
7952 else if (INTERACTIVE
7953 && sf
->glyphs_initialized_p
7954 && FRAME_MESSAGE_BUF (sf
))
7956 Lisp_Object mini_window
;
7959 /* Get the frame containing the mini-buffer
7960 that the selected frame is using. */
7961 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
7962 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
7964 FRAME_SAMPLE_VISIBILITY (f
);
7965 if (FRAME_VISIBLE_P (sf
)
7966 && ! FRAME_VISIBLE_P (f
))
7967 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
7971 set_message (m
, Qnil
, nbytes
, multibyte
);
7972 if (minibuffer_auto_raise
)
7973 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
7976 clear_message (1, 1);
7978 do_pending_window_change (0);
7979 echo_area_display (1);
7980 do_pending_window_change (0);
7981 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
7982 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
7987 /* Display an echo area message M with a specified length of NBYTES
7988 bytes. The string may include null characters. If M is not a
7989 string, clear out any existing message, and let the mini-buffer
7992 This function cancels echoing. */
7995 message3 (m
, nbytes
, multibyte
)
8000 struct gcpro gcpro1
;
8003 clear_message (1,1);
8006 /* First flush out any partial line written with print. */
8007 message_log_maybe_newline ();
8013 SAFE_ALLOCA (buffer
, char *, nbytes
);
8014 bcopy (SDATA (m
), buffer
, nbytes
);
8015 message_dolog (buffer
, nbytes
, 1, multibyte
);
8018 message3_nolog (m
, nbytes
, multibyte
);
8024 /* The non-logging version of message3.
8025 This does not cancel echoing, because it is used for echoing.
8026 Perhaps we need to make a separate function for echoing
8027 and make this cancel echoing. */
8030 message3_nolog (m
, nbytes
, multibyte
)
8032 int nbytes
, multibyte
;
8034 struct frame
*sf
= SELECTED_FRAME ();
8035 message_enable_multibyte
= multibyte
;
8037 if (FRAME_INITIAL_P (sf
))
8039 if (noninteractive_need_newline
)
8040 putc ('\n', stderr
);
8041 noninteractive_need_newline
= 0;
8043 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8044 if (cursor_in_echo_area
== 0)
8045 fprintf (stderr
, "\n");
8048 /* A null message buffer means that the frame hasn't really been
8049 initialized yet. Error messages get reported properly by
8050 cmd_error, so this must be just an informative message; toss it. */
8051 else if (INTERACTIVE
8052 && sf
->glyphs_initialized_p
8053 && FRAME_MESSAGE_BUF (sf
))
8055 Lisp_Object mini_window
;
8059 /* Get the frame containing the mini-buffer
8060 that the selected frame is using. */
8061 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8062 frame
= XWINDOW (mini_window
)->frame
;
8065 FRAME_SAMPLE_VISIBILITY (f
);
8066 if (FRAME_VISIBLE_P (sf
)
8067 && !FRAME_VISIBLE_P (f
))
8068 Fmake_frame_visible (frame
);
8070 if (STRINGP (m
) && SCHARS (m
) > 0)
8072 set_message (NULL
, m
, nbytes
, multibyte
);
8073 if (minibuffer_auto_raise
)
8074 Fraise_frame (frame
);
8075 /* Assume we are not echoing.
8076 (If we are, echo_now will override this.) */
8077 echo_message_buffer
= Qnil
;
8080 clear_message (1, 1);
8082 do_pending_window_change (0);
8083 echo_area_display (1);
8084 do_pending_window_change (0);
8085 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8086 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8091 /* Display a null-terminated echo area message M. If M is 0, clear
8092 out any existing message, and let the mini-buffer text show through.
8094 The buffer M must continue to exist until after the echo area gets
8095 cleared or some other message gets displayed there. Do not pass
8096 text that is stored in a Lisp string. Do not pass text in a buffer
8097 that was alloca'd. */
8103 message2 (m
, (m
? strlen (m
) : 0), 0);
8107 /* The non-logging counterpart of message1. */
8113 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8116 /* Display a message M which contains a single %s
8117 which gets replaced with STRING. */
8120 message_with_string (m
, string
, log
)
8125 CHECK_STRING (string
);
8131 if (noninteractive_need_newline
)
8132 putc ('\n', stderr
);
8133 noninteractive_need_newline
= 0;
8134 fprintf (stderr
, m
, SDATA (string
));
8135 if (!cursor_in_echo_area
)
8136 fprintf (stderr
, "\n");
8140 else if (INTERACTIVE
)
8142 /* The frame whose minibuffer we're going to display the message on.
8143 It may be larger than the selected frame, so we need
8144 to use its buffer, not the selected frame's buffer. */
8145 Lisp_Object mini_window
;
8146 struct frame
*f
, *sf
= SELECTED_FRAME ();
8148 /* Get the frame containing the minibuffer
8149 that the selected frame is using. */
8150 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8151 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8153 /* A null message buffer means that the frame hasn't really been
8154 initialized yet. Error messages get reported properly by
8155 cmd_error, so this must be just an informative message; toss it. */
8156 if (FRAME_MESSAGE_BUF (f
))
8158 Lisp_Object args
[2], message
;
8159 struct gcpro gcpro1
, gcpro2
;
8161 args
[0] = build_string (m
);
8162 args
[1] = message
= string
;
8163 GCPRO2 (args
[0], message
);
8166 message
= Fformat (2, args
);
8169 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8171 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8175 /* Print should start at the beginning of the message
8176 buffer next time. */
8177 message_buf_print
= 0;
8183 /* Dump an informative message to the minibuf. If M is 0, clear out
8184 any existing message, and let the mini-buffer text show through. */
8188 message (m
, a1
, a2
, a3
)
8190 EMACS_INT a1
, a2
, a3
;
8196 if (noninteractive_need_newline
)
8197 putc ('\n', stderr
);
8198 noninteractive_need_newline
= 0;
8199 fprintf (stderr
, m
, a1
, a2
, a3
);
8200 if (cursor_in_echo_area
== 0)
8201 fprintf (stderr
, "\n");
8205 else if (INTERACTIVE
)
8207 /* The frame whose mini-buffer we're going to display the message
8208 on. It may be larger than the selected frame, so we need to
8209 use its buffer, not the selected frame's buffer. */
8210 Lisp_Object mini_window
;
8211 struct frame
*f
, *sf
= SELECTED_FRAME ();
8213 /* Get the frame containing the mini-buffer
8214 that the selected frame is using. */
8215 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8216 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8218 /* A null message buffer means that the frame hasn't really been
8219 initialized yet. Error messages get reported properly by
8220 cmd_error, so this must be just an informative message; toss
8222 if (FRAME_MESSAGE_BUF (f
))
8233 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8234 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8236 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8237 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3,
8239 #endif /* NO_ARG_ARRAY */
8241 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8246 /* Print should start at the beginning of the message
8247 buffer next time. */
8248 message_buf_print
= 0;
8254 /* The non-logging version of message. */
8257 message_nolog (m
, a1
, a2
, a3
)
8259 EMACS_INT a1
, a2
, a3
;
8261 Lisp_Object old_log_max
;
8262 old_log_max
= Vmessage_log_max
;
8263 Vmessage_log_max
= Qnil
;
8264 message (m
, a1
, a2
, a3
);
8265 Vmessage_log_max
= old_log_max
;
8269 /* Display the current message in the current mini-buffer. This is
8270 only called from error handlers in process.c, and is not time
8276 if (!NILP (echo_area_buffer
[0]))
8279 string
= Fcurrent_message ();
8280 message3 (string
, SBYTES (string
),
8281 !NILP (current_buffer
->enable_multibyte_characters
));
8286 /* Make sure echo area buffers in `echo_buffers' are live.
8287 If they aren't, make new ones. */
8290 ensure_echo_area_buffers ()
8294 for (i
= 0; i
< 2; ++i
)
8295 if (!BUFFERP (echo_buffer
[i
])
8296 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8299 Lisp_Object old_buffer
;
8302 old_buffer
= echo_buffer
[i
];
8303 sprintf (name
, " *Echo Area %d*", i
);
8304 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8305 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8306 /* to force word wrap in echo area -
8307 it was decided to postpone this*/
8308 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8310 for (j
= 0; j
< 2; ++j
)
8311 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8312 echo_area_buffer
[j
] = echo_buffer
[i
];
8317 /* Call FN with args A1..A4 with either the current or last displayed
8318 echo_area_buffer as current buffer.
8320 WHICH zero means use the current message buffer
8321 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8322 from echo_buffer[] and clear it.
8324 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8325 suitable buffer from echo_buffer[] and clear it.
8327 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8328 that the current message becomes the last displayed one, make
8329 choose a suitable buffer for echo_area_buffer[0], and clear it.
8331 Value is what FN returns. */
8334 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8337 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8343 int this_one
, the_other
, clear_buffer_p
, rc
;
8344 int count
= SPECPDL_INDEX ();
8346 /* If buffers aren't live, make new ones. */
8347 ensure_echo_area_buffers ();
8352 this_one
= 0, the_other
= 1;
8354 this_one
= 1, the_other
= 0;
8357 this_one
= 0, the_other
= 1;
8360 /* We need a fresh one in case the current echo buffer equals
8361 the one containing the last displayed echo area message. */
8362 if (!NILP (echo_area_buffer
[this_one
])
8363 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8364 echo_area_buffer
[this_one
] = Qnil
;
8367 /* Choose a suitable buffer from echo_buffer[] is we don't
8369 if (NILP (echo_area_buffer
[this_one
]))
8371 echo_area_buffer
[this_one
]
8372 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8373 ? echo_buffer
[the_other
]
8374 : echo_buffer
[this_one
]);
8378 buffer
= echo_area_buffer
[this_one
];
8380 /* Don't get confused by reusing the buffer used for echoing
8381 for a different purpose. */
8382 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8385 record_unwind_protect (unwind_with_echo_area_buffer
,
8386 with_echo_area_buffer_unwind_data (w
));
8388 /* Make the echo area buffer current. Note that for display
8389 purposes, it is not necessary that the displayed window's buffer
8390 == current_buffer, except for text property lookup. So, let's
8391 only set that buffer temporarily here without doing a full
8392 Fset_window_buffer. We must also change w->pointm, though,
8393 because otherwise an assertions in unshow_buffer fails, and Emacs
8395 set_buffer_internal_1 (XBUFFER (buffer
));
8399 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8402 current_buffer
->undo_list
= Qt
;
8403 current_buffer
->read_only
= Qnil
;
8404 specbind (Qinhibit_read_only
, Qt
);
8405 specbind (Qinhibit_modification_hooks
, Qt
);
8407 if (clear_buffer_p
&& Z
> BEG
)
8410 xassert (BEGV
>= BEG
);
8411 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8413 rc
= fn (a1
, a2
, a3
, a4
);
8415 xassert (BEGV
>= BEG
);
8416 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8418 unbind_to (count
, Qnil
);
8423 /* Save state that should be preserved around the call to the function
8424 FN called in with_echo_area_buffer. */
8427 with_echo_area_buffer_unwind_data (w
)
8431 Lisp_Object vector
, tmp
;
8433 /* Reduce consing by keeping one vector in
8434 Vwith_echo_area_save_vector. */
8435 vector
= Vwith_echo_area_save_vector
;
8436 Vwith_echo_area_save_vector
= Qnil
;
8439 vector
= Fmake_vector (make_number (7), Qnil
);
8441 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8442 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8443 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8447 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8448 ASET (vector
, i
, w
->buffer
); ++i
;
8449 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8450 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8455 for (; i
< end
; ++i
)
8456 ASET (vector
, i
, Qnil
);
8459 xassert (i
== ASIZE (vector
));
8464 /* Restore global state from VECTOR which was created by
8465 with_echo_area_buffer_unwind_data. */
8468 unwind_with_echo_area_buffer (vector
)
8471 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8472 Vdeactivate_mark
= AREF (vector
, 1);
8473 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8475 if (WINDOWP (AREF (vector
, 3)))
8478 Lisp_Object buffer
, charpos
, bytepos
;
8480 w
= XWINDOW (AREF (vector
, 3));
8481 buffer
= AREF (vector
, 4);
8482 charpos
= AREF (vector
, 5);
8483 bytepos
= AREF (vector
, 6);
8486 set_marker_both (w
->pointm
, buffer
,
8487 XFASTINT (charpos
), XFASTINT (bytepos
));
8490 Vwith_echo_area_save_vector
= vector
;
8495 /* Set up the echo area for use by print functions. MULTIBYTE_P
8496 non-zero means we will print multibyte. */
8499 setup_echo_area_for_printing (multibyte_p
)
8502 /* If we can't find an echo area any more, exit. */
8503 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8506 ensure_echo_area_buffers ();
8508 if (!message_buf_print
)
8510 /* A message has been output since the last time we printed.
8511 Choose a fresh echo area buffer. */
8512 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8513 echo_area_buffer
[0] = echo_buffer
[1];
8515 echo_area_buffer
[0] = echo_buffer
[0];
8517 /* Switch to that buffer and clear it. */
8518 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8519 current_buffer
->truncate_lines
= Qnil
;
8523 int count
= SPECPDL_INDEX ();
8524 specbind (Qinhibit_read_only
, Qt
);
8525 /* Note that undo recording is always disabled. */
8527 unbind_to (count
, Qnil
);
8529 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8531 /* Set up the buffer for the multibyteness we need. */
8533 != !NILP (current_buffer
->enable_multibyte_characters
))
8534 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8536 /* Raise the frame containing the echo area. */
8537 if (minibuffer_auto_raise
)
8539 struct frame
*sf
= SELECTED_FRAME ();
8540 Lisp_Object mini_window
;
8541 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8542 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8545 message_log_maybe_newline ();
8546 message_buf_print
= 1;
8550 if (NILP (echo_area_buffer
[0]))
8552 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8553 echo_area_buffer
[0] = echo_buffer
[1];
8555 echo_area_buffer
[0] = echo_buffer
[0];
8558 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8560 /* Someone switched buffers between print requests. */
8561 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8562 current_buffer
->truncate_lines
= Qnil
;
8568 /* Display an echo area message in window W. Value is non-zero if W's
8569 height is changed. If display_last_displayed_message_p is
8570 non-zero, display the message that was last displayed, otherwise
8571 display the current message. */
8574 display_echo_area (w
)
8577 int i
, no_message_p
, window_height_changed_p
, count
;
8579 /* Temporarily disable garbage collections while displaying the echo
8580 area. This is done because a GC can print a message itself.
8581 That message would modify the echo area buffer's contents while a
8582 redisplay of the buffer is going on, and seriously confuse
8584 count
= inhibit_garbage_collection ();
8586 /* If there is no message, we must call display_echo_area_1
8587 nevertheless because it resizes the window. But we will have to
8588 reset the echo_area_buffer in question to nil at the end because
8589 with_echo_area_buffer will sets it to an empty buffer. */
8590 i
= display_last_displayed_message_p
? 1 : 0;
8591 no_message_p
= NILP (echo_area_buffer
[i
]);
8593 window_height_changed_p
8594 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8595 display_echo_area_1
,
8596 (EMACS_INT
) w
, Qnil
, 0, 0);
8599 echo_area_buffer
[i
] = Qnil
;
8601 unbind_to (count
, Qnil
);
8602 return window_height_changed_p
;
8606 /* Helper for display_echo_area. Display the current buffer which
8607 contains the current echo area message in window W, a mini-window,
8608 a pointer to which is passed in A1. A2..A4 are currently not used.
8609 Change the height of W so that all of the message is displayed.
8610 Value is non-zero if height of W was changed. */
8613 display_echo_area_1 (a1
, a2
, a3
, a4
)
8618 struct window
*w
= (struct window
*) a1
;
8620 struct text_pos start
;
8621 int window_height_changed_p
= 0;
8623 /* Do this before displaying, so that we have a large enough glyph
8624 matrix for the display. If we can't get enough space for the
8625 whole text, display the last N lines. That works by setting w->start. */
8626 window_height_changed_p
= resize_mini_window (w
, 0);
8628 /* Use the starting position chosen by resize_mini_window. */
8629 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8632 clear_glyph_matrix (w
->desired_matrix
);
8633 XSETWINDOW (window
, w
);
8634 try_window (window
, start
, 0);
8636 return window_height_changed_p
;
8640 /* Resize the echo area window to exactly the size needed for the
8641 currently displayed message, if there is one. If a mini-buffer
8642 is active, don't shrink it. */
8645 resize_echo_area_exactly ()
8647 if (BUFFERP (echo_area_buffer
[0])
8648 && WINDOWP (echo_area_window
))
8650 struct window
*w
= XWINDOW (echo_area_window
);
8652 Lisp_Object resize_exactly
;
8654 if (minibuf_level
== 0)
8655 resize_exactly
= Qt
;
8657 resize_exactly
= Qnil
;
8659 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8660 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8663 ++windows_or_buffers_changed
;
8664 ++update_mode_lines
;
8665 redisplay_internal (0);
8671 /* Callback function for with_echo_area_buffer, when used from
8672 resize_echo_area_exactly. A1 contains a pointer to the window to
8673 resize, EXACTLY non-nil means resize the mini-window exactly to the
8674 size of the text displayed. A3 and A4 are not used. Value is what
8675 resize_mini_window returns. */
8678 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
8680 Lisp_Object exactly
;
8683 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8687 /* Resize mini-window W to fit the size of its contents. EXACT_P
8688 means size the window exactly to the size needed. Otherwise, it's
8689 only enlarged until W's buffer is empty.
8691 Set W->start to the right place to begin display. If the whole
8692 contents fit, start at the beginning. Otherwise, start so as
8693 to make the end of the contents appear. This is particularly
8694 important for y-or-n-p, but seems desirable generally.
8696 Value is non-zero if the window height has been changed. */
8699 resize_mini_window (w
, exact_p
)
8703 struct frame
*f
= XFRAME (w
->frame
);
8704 int window_height_changed_p
= 0;
8706 xassert (MINI_WINDOW_P (w
));
8708 /* By default, start display at the beginning. */
8709 set_marker_both (w
->start
, w
->buffer
,
8710 BUF_BEGV (XBUFFER (w
->buffer
)),
8711 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8713 /* Don't resize windows while redisplaying a window; it would
8714 confuse redisplay functions when the size of the window they are
8715 displaying changes from under them. Such a resizing can happen,
8716 for instance, when which-func prints a long message while
8717 we are running fontification-functions. We're running these
8718 functions with safe_call which binds inhibit-redisplay to t. */
8719 if (!NILP (Vinhibit_redisplay
))
8722 /* Nil means don't try to resize. */
8723 if (NILP (Vresize_mini_windows
)
8724 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
8727 if (!FRAME_MINIBUF_ONLY_P (f
))
8730 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
8731 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
8732 int height
, max_height
;
8733 int unit
= FRAME_LINE_HEIGHT (f
);
8734 struct text_pos start
;
8735 struct buffer
*old_current_buffer
= NULL
;
8737 if (current_buffer
!= XBUFFER (w
->buffer
))
8739 old_current_buffer
= current_buffer
;
8740 set_buffer_internal (XBUFFER (w
->buffer
));
8743 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8745 /* Compute the max. number of lines specified by the user. */
8746 if (FLOATP (Vmax_mini_window_height
))
8747 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
8748 else if (INTEGERP (Vmax_mini_window_height
))
8749 max_height
= XINT (Vmax_mini_window_height
);
8751 max_height
= total_height
/ 4;
8753 /* Correct that max. height if it's bogus. */
8754 max_height
= max (1, max_height
);
8755 max_height
= min (total_height
, max_height
);
8757 /* Find out the height of the text in the window. */
8758 if (it
.line_wrap
== TRUNCATE
)
8763 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
8764 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
8765 height
= it
.current_y
+ last_height
;
8767 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
8768 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
8769 height
= (height
+ unit
- 1) / unit
;
8772 /* Compute a suitable window start. */
8773 if (height
> max_height
)
8775 height
= max_height
;
8776 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
8777 move_it_vertically_backward (&it
, (height
- 1) * unit
);
8778 start
= it
.current
.pos
;
8781 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
8782 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
8784 if (EQ (Vresize_mini_windows
, Qgrow_only
))
8786 /* Let it grow only, until we display an empty message, in which
8787 case the window shrinks again. */
8788 if (height
> WINDOW_TOTAL_LINES (w
))
8790 int old_height
= WINDOW_TOTAL_LINES (w
);
8791 freeze_window_starts (f
, 1);
8792 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8793 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8795 else if (height
< WINDOW_TOTAL_LINES (w
)
8796 && (exact_p
|| BEGV
== ZV
))
8798 int old_height
= WINDOW_TOTAL_LINES (w
);
8799 freeze_window_starts (f
, 0);
8800 shrink_mini_window (w
);
8801 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8806 /* Always resize to exact size needed. */
8807 if (height
> WINDOW_TOTAL_LINES (w
))
8809 int old_height
= WINDOW_TOTAL_LINES (w
);
8810 freeze_window_starts (f
, 1);
8811 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8812 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8814 else if (height
< WINDOW_TOTAL_LINES (w
))
8816 int old_height
= WINDOW_TOTAL_LINES (w
);
8817 freeze_window_starts (f
, 0);
8818 shrink_mini_window (w
);
8822 freeze_window_starts (f
, 1);
8823 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
8826 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
8830 if (old_current_buffer
)
8831 set_buffer_internal (old_current_buffer
);
8834 return window_height_changed_p
;
8838 /* Value is the current message, a string, or nil if there is no
8846 if (!BUFFERP (echo_area_buffer
[0]))
8850 with_echo_area_buffer (0, 0, current_message_1
,
8851 (EMACS_INT
) &msg
, Qnil
, 0, 0);
8853 echo_area_buffer
[0] = Qnil
;
8861 current_message_1 (a1
, a2
, a3
, a4
)
8866 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
8869 *msg
= make_buffer_string (BEG
, Z
, 1);
8876 /* Push the current message on Vmessage_stack for later restauration
8877 by restore_message. Value is non-zero if the current message isn't
8878 empty. This is a relatively infrequent operation, so it's not
8879 worth optimizing. */
8885 msg
= current_message ();
8886 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
8887 return STRINGP (msg
);
8891 /* Restore message display from the top of Vmessage_stack. */
8898 xassert (CONSP (Vmessage_stack
));
8899 msg
= XCAR (Vmessage_stack
);
8901 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
8903 message3_nolog (msg
, 0, 0);
8907 /* Handler for record_unwind_protect calling pop_message. */
8910 pop_message_unwind (dummy
)
8917 /* Pop the top-most entry off Vmessage_stack. */
8922 xassert (CONSP (Vmessage_stack
));
8923 Vmessage_stack
= XCDR (Vmessage_stack
);
8927 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
8928 exits. If the stack is not empty, we have a missing pop_message
8932 check_message_stack ()
8934 if (!NILP (Vmessage_stack
))
8939 /* Truncate to NCHARS what will be displayed in the echo area the next
8940 time we display it---but don't redisplay it now. */
8943 truncate_echo_area (nchars
)
8947 echo_area_buffer
[0] = Qnil
;
8948 /* A null message buffer means that the frame hasn't really been
8949 initialized yet. Error messages get reported properly by
8950 cmd_error, so this must be just an informative message; toss it. */
8951 else if (!noninteractive
8953 && !NILP (echo_area_buffer
[0]))
8955 struct frame
*sf
= SELECTED_FRAME ();
8956 if (FRAME_MESSAGE_BUF (sf
))
8957 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
8962 /* Helper function for truncate_echo_area. Truncate the current
8963 message to at most NCHARS characters. */
8966 truncate_message_1 (nchars
, a2
, a3
, a4
)
8971 if (BEG
+ nchars
< Z
)
8972 del_range (BEG
+ nchars
, Z
);
8974 echo_area_buffer
[0] = Qnil
;
8979 /* Set the current message to a substring of S or STRING.
8981 If STRING is a Lisp string, set the message to the first NBYTES
8982 bytes from STRING. NBYTES zero means use the whole string. If
8983 STRING is multibyte, the message will be displayed multibyte.
8985 If S is not null, set the message to the first LEN bytes of S. LEN
8986 zero means use the whole string. MULTIBYTE_P non-zero means S is
8987 multibyte. Display the message multibyte in that case.
8989 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
8990 to t before calling set_message_1 (which calls insert).
8994 set_message (s
, string
, nbytes
, multibyte_p
)
8997 int nbytes
, multibyte_p
;
8999 message_enable_multibyte
9000 = ((s
&& multibyte_p
)
9001 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9003 with_echo_area_buffer (0, -1, set_message_1
,
9004 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9005 message_buf_print
= 0;
9006 help_echo_showing_p
= 0;
9010 /* Helper function for set_message. Arguments have the same meaning
9011 as there, with A1 corresponding to S and A2 corresponding to STRING
9012 This function is called with the echo area buffer being
9016 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9019 EMACS_INT nbytes
, multibyte_p
;
9021 const char *s
= (const char *) a1
;
9022 Lisp_Object string
= a2
;
9024 /* Change multibyteness of the echo buffer appropriately. */
9025 if (message_enable_multibyte
9026 != !NILP (current_buffer
->enable_multibyte_characters
))
9027 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9029 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9031 /* Insert new message at BEG. */
9032 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9034 if (STRINGP (string
))
9039 nbytes
= SBYTES (string
);
9040 nchars
= string_byte_to_char (string
, nbytes
);
9042 /* This function takes care of single/multibyte conversion. We
9043 just have to ensure that the echo area buffer has the right
9044 setting of enable_multibyte_characters. */
9045 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9050 nbytes
= strlen (s
);
9052 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9054 /* Convert from multi-byte to single-byte. */
9056 unsigned char work
[1];
9058 /* Convert a multibyte string to single-byte. */
9059 for (i
= 0; i
< nbytes
; i
+= n
)
9061 c
= string_char_and_length (s
+ i
, &n
);
9062 work
[0] = (ASCII_CHAR_P (c
)
9064 : multibyte_char_to_unibyte (c
, Qnil
));
9065 insert_1_both (work
, 1, 1, 1, 0, 0);
9068 else if (!multibyte_p
9069 && !NILP (current_buffer
->enable_multibyte_characters
))
9071 /* Convert from single-byte to multi-byte. */
9073 const unsigned char *msg
= (const unsigned char *) s
;
9074 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9076 /* Convert a single-byte string to multibyte. */
9077 for (i
= 0; i
< nbytes
; i
++)
9080 MAKE_CHAR_MULTIBYTE (c
);
9081 n
= CHAR_STRING (c
, str
);
9082 insert_1_both (str
, 1, n
, 1, 0, 0);
9086 insert_1 (s
, nbytes
, 1, 0, 0);
9093 /* Clear messages. CURRENT_P non-zero means clear the current
9094 message. LAST_DISPLAYED_P non-zero means clear the message
9098 clear_message (current_p
, last_displayed_p
)
9099 int current_p
, last_displayed_p
;
9103 echo_area_buffer
[0] = Qnil
;
9104 message_cleared_p
= 1;
9107 if (last_displayed_p
)
9108 echo_area_buffer
[1] = Qnil
;
9110 message_buf_print
= 0;
9113 /* Clear garbaged frames.
9115 This function is used where the old redisplay called
9116 redraw_garbaged_frames which in turn called redraw_frame which in
9117 turn called clear_frame. The call to clear_frame was a source of
9118 flickering. I believe a clear_frame is not necessary. It should
9119 suffice in the new redisplay to invalidate all current matrices,
9120 and ensure a complete redisplay of all windows. */
9123 clear_garbaged_frames ()
9127 Lisp_Object tail
, frame
;
9128 int changed_count
= 0;
9130 FOR_EACH_FRAME (tail
, frame
)
9132 struct frame
*f
= XFRAME (frame
);
9134 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9138 Fredraw_frame (frame
);
9139 f
->force_flush_display_p
= 1;
9141 clear_current_matrices (f
);
9150 ++windows_or_buffers_changed
;
9155 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9156 is non-zero update selected_frame. Value is non-zero if the
9157 mini-windows height has been changed. */
9160 echo_area_display (update_frame_p
)
9163 Lisp_Object mini_window
;
9166 int window_height_changed_p
= 0;
9167 struct frame
*sf
= SELECTED_FRAME ();
9169 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9170 w
= XWINDOW (mini_window
);
9171 f
= XFRAME (WINDOW_FRAME (w
));
9173 /* Don't display if frame is invisible or not yet initialized. */
9174 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9177 #ifdef HAVE_WINDOW_SYSTEM
9178 /* When Emacs starts, selected_frame may be the initial terminal
9179 frame. If we let this through, a message would be displayed on
9181 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9183 #endif /* HAVE_WINDOW_SYSTEM */
9185 /* Redraw garbaged frames. */
9187 clear_garbaged_frames ();
9189 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9191 echo_area_window
= mini_window
;
9192 window_height_changed_p
= display_echo_area (w
);
9193 w
->must_be_updated_p
= 1;
9195 /* Update the display, unless called from redisplay_internal.
9196 Also don't update the screen during redisplay itself. The
9197 update will happen at the end of redisplay, and an update
9198 here could cause confusion. */
9199 if (update_frame_p
&& !redisplaying_p
)
9203 /* If the display update has been interrupted by pending
9204 input, update mode lines in the frame. Due to the
9205 pending input, it might have been that redisplay hasn't
9206 been called, so that mode lines above the echo area are
9207 garbaged. This looks odd, so we prevent it here. */
9208 if (!display_completed
)
9209 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9211 if (window_height_changed_p
9212 /* Don't do this if Emacs is shutting down. Redisplay
9213 needs to run hooks. */
9214 && !NILP (Vrun_hooks
))
9216 /* Must update other windows. Likewise as in other
9217 cases, don't let this update be interrupted by
9219 int count
= SPECPDL_INDEX ();
9220 specbind (Qredisplay_dont_pause
, Qt
);
9221 windows_or_buffers_changed
= 1;
9222 redisplay_internal (0);
9223 unbind_to (count
, Qnil
);
9225 else if (FRAME_WINDOW_P (f
) && n
== 0)
9227 /* Window configuration is the same as before.
9228 Can do with a display update of the echo area,
9229 unless we displayed some mode lines. */
9230 update_single_window (w
, 1);
9231 FRAME_RIF (f
)->flush_display (f
);
9234 update_frame (f
, 1, 1);
9236 /* If cursor is in the echo area, make sure that the next
9237 redisplay displays the minibuffer, so that the cursor will
9238 be replaced with what the minibuffer wants. */
9239 if (cursor_in_echo_area
)
9240 ++windows_or_buffers_changed
;
9243 else if (!EQ (mini_window
, selected_window
))
9244 windows_or_buffers_changed
++;
9246 /* Last displayed message is now the current message. */
9247 echo_area_buffer
[1] = echo_area_buffer
[0];
9248 /* Inform read_char that we're not echoing. */
9249 echo_message_buffer
= Qnil
;
9251 /* Prevent redisplay optimization in redisplay_internal by resetting
9252 this_line_start_pos. This is done because the mini-buffer now
9253 displays the message instead of its buffer text. */
9254 if (EQ (mini_window
, selected_window
))
9255 CHARPOS (this_line_start_pos
) = 0;
9257 return window_height_changed_p
;
9262 /***********************************************************************
9263 Mode Lines and Frame Titles
9264 ***********************************************************************/
9266 /* A buffer for constructing non-propertized mode-line strings and
9267 frame titles in it; allocated from the heap in init_xdisp and
9268 resized as needed in store_mode_line_noprop_char. */
9270 static char *mode_line_noprop_buf
;
9272 /* The buffer's end, and a current output position in it. */
9274 static char *mode_line_noprop_buf_end
;
9275 static char *mode_line_noprop_ptr
;
9277 #define MODE_LINE_NOPROP_LEN(start) \
9278 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9281 MODE_LINE_DISPLAY
= 0,
9287 /* Alist that caches the results of :propertize.
9288 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9289 static Lisp_Object mode_line_proptrans_alist
;
9291 /* List of strings making up the mode-line. */
9292 static Lisp_Object mode_line_string_list
;
9294 /* Base face property when building propertized mode line string. */
9295 static Lisp_Object mode_line_string_face
;
9296 static Lisp_Object mode_line_string_face_prop
;
9299 /* Unwind data for mode line strings */
9301 static Lisp_Object Vmode_line_unwind_vector
;
9304 format_mode_line_unwind_data (struct buffer
*obuf
,
9308 Lisp_Object vector
, tmp
;
9310 /* Reduce consing by keeping one vector in
9311 Vwith_echo_area_save_vector. */
9312 vector
= Vmode_line_unwind_vector
;
9313 Vmode_line_unwind_vector
= Qnil
;
9316 vector
= Fmake_vector (make_number (8), Qnil
);
9318 ASET (vector
, 0, make_number (mode_line_target
));
9319 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9320 ASET (vector
, 2, mode_line_string_list
);
9321 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9322 ASET (vector
, 4, mode_line_string_face
);
9323 ASET (vector
, 5, mode_line_string_face_prop
);
9326 XSETBUFFER (tmp
, obuf
);
9329 ASET (vector
, 6, tmp
);
9330 ASET (vector
, 7, owin
);
9336 unwind_format_mode_line (vector
)
9339 mode_line_target
= XINT (AREF (vector
, 0));
9340 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9341 mode_line_string_list
= AREF (vector
, 2);
9342 if (! EQ (AREF (vector
, 3), Qt
))
9343 mode_line_proptrans_alist
= AREF (vector
, 3);
9344 mode_line_string_face
= AREF (vector
, 4);
9345 mode_line_string_face_prop
= AREF (vector
, 5);
9347 if (!NILP (AREF (vector
, 7)))
9348 /* Select window before buffer, since it may change the buffer. */
9349 Fselect_window (AREF (vector
, 7), Qt
);
9351 if (!NILP (AREF (vector
, 6)))
9353 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9354 ASET (vector
, 6, Qnil
);
9357 Vmode_line_unwind_vector
= vector
;
9362 /* Store a single character C for the frame title in mode_line_noprop_buf.
9363 Re-allocate mode_line_noprop_buf if necessary. */
9367 store_mode_line_noprop_char (char c
)
9369 store_mode_line_noprop_char (c
)
9373 /* If output position has reached the end of the allocated buffer,
9374 double the buffer's size. */
9375 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9377 int len
= MODE_LINE_NOPROP_LEN (0);
9378 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9379 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9380 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9381 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9384 *mode_line_noprop_ptr
++ = c
;
9388 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9389 mode_line_noprop_ptr. STR is the string to store. Do not copy
9390 characters that yield more columns than PRECISION; PRECISION <= 0
9391 means copy the whole string. Pad with spaces until FIELD_WIDTH
9392 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9393 pad. Called from display_mode_element when it is used to build a
9397 store_mode_line_noprop (str
, field_width
, precision
)
9398 const unsigned char *str
;
9399 int field_width
, precision
;
9404 /* Copy at most PRECISION chars from STR. */
9405 nbytes
= strlen (str
);
9406 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9408 store_mode_line_noprop_char (*str
++);
9410 /* Fill up with spaces until FIELD_WIDTH reached. */
9411 while (field_width
> 0
9414 store_mode_line_noprop_char (' ');
9421 /***********************************************************************
9423 ***********************************************************************/
9425 #ifdef HAVE_WINDOW_SYSTEM
9427 /* Set the title of FRAME, if it has changed. The title format is
9428 Vicon_title_format if FRAME is iconified, otherwise it is
9429 frame_title_format. */
9432 x_consider_frame_title (frame
)
9435 struct frame
*f
= XFRAME (frame
);
9437 if (FRAME_WINDOW_P (f
)
9438 || FRAME_MINIBUF_ONLY_P (f
)
9439 || f
->explicit_name
)
9441 /* Do we have more than one visible frame on this X display? */
9448 int count
= SPECPDL_INDEX ();
9450 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9452 Lisp_Object other_frame
= XCAR (tail
);
9453 struct frame
*tf
= XFRAME (other_frame
);
9456 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9457 && !FRAME_MINIBUF_ONLY_P (tf
)
9458 && !EQ (other_frame
, tip_frame
)
9459 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9463 /* Set global variable indicating that multiple frames exist. */
9464 multiple_frames
= CONSP (tail
);
9466 /* Switch to the buffer of selected window of the frame. Set up
9467 mode_line_target so that display_mode_element will output into
9468 mode_line_noprop_buf; then display the title. */
9469 record_unwind_protect (unwind_format_mode_line
,
9470 format_mode_line_unwind_data
9471 (current_buffer
, selected_window
, 0));
9473 Fselect_window (f
->selected_window
, Qt
);
9474 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9475 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9477 mode_line_target
= MODE_LINE_TITLE
;
9478 title_start
= MODE_LINE_NOPROP_LEN (0);
9479 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9480 NULL
, DEFAULT_FACE_ID
);
9481 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9482 len
= MODE_LINE_NOPROP_LEN (title_start
);
9483 title
= mode_line_noprop_buf
+ title_start
;
9484 unbind_to (count
, Qnil
);
9486 /* Set the title only if it's changed. This avoids consing in
9487 the common case where it hasn't. (If it turns out that we've
9488 already wasted too much time by walking through the list with
9489 display_mode_element, then we might need to optimize at a
9490 higher level than this.) */
9491 if (! STRINGP (f
->name
)
9492 || SBYTES (f
->name
) != len
9493 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9498 if (!MINI_WINDOW_P(XWINDOW(f
->selected_window
)))
9501 ns_set_name_as_filename (f
);
9503 x_implicitly_set_name (f
, make_string(title
, len
),
9509 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9514 /* do this also for frames with explicit names */
9515 ns_implicitly_set_icon_type(f
);
9516 ns_set_doc_edited(f
, Fbuffer_modified_p
9517 (XWINDOW (f
->selected_window
)->buffer
), Qnil
);
9523 #endif /* not HAVE_WINDOW_SYSTEM */
9528 /***********************************************************************
9530 ***********************************************************************/
9533 /* Prepare for redisplay by updating menu-bar item lists when
9534 appropriate. This can call eval. */
9537 prepare_menu_bars ()
9540 struct gcpro gcpro1
, gcpro2
;
9542 Lisp_Object tooltip_frame
;
9544 #ifdef HAVE_WINDOW_SYSTEM
9545 tooltip_frame
= tip_frame
;
9547 tooltip_frame
= Qnil
;
9550 /* Update all frame titles based on their buffer names, etc. We do
9551 this before the menu bars so that the buffer-menu will show the
9552 up-to-date frame titles. */
9553 #ifdef HAVE_WINDOW_SYSTEM
9554 if (windows_or_buffers_changed
|| update_mode_lines
)
9556 Lisp_Object tail
, frame
;
9558 FOR_EACH_FRAME (tail
, frame
)
9561 if (!EQ (frame
, tooltip_frame
)
9562 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9563 x_consider_frame_title (frame
);
9566 #endif /* HAVE_WINDOW_SYSTEM */
9568 /* Update the menu bar item lists, if appropriate. This has to be
9569 done before any actual redisplay or generation of display lines. */
9570 all_windows
= (update_mode_lines
9571 || buffer_shared
> 1
9572 || windows_or_buffers_changed
);
9575 Lisp_Object tail
, frame
;
9576 int count
= SPECPDL_INDEX ();
9577 /* 1 means that update_menu_bar has run its hooks
9578 so any further calls to update_menu_bar shouldn't do so again. */
9579 int menu_bar_hooks_run
= 0;
9581 record_unwind_save_match_data ();
9583 FOR_EACH_FRAME (tail
, frame
)
9587 /* Ignore tooltip frame. */
9588 if (EQ (frame
, tooltip_frame
))
9591 /* If a window on this frame changed size, report that to
9592 the user and clear the size-change flag. */
9593 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9595 Lisp_Object functions
;
9597 /* Clear flag first in case we get an error below. */
9598 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9599 functions
= Vwindow_size_change_functions
;
9600 GCPRO2 (tail
, functions
);
9602 while (CONSP (functions
))
9604 if (!EQ (XCAR (functions
), Qt
))
9605 call1 (XCAR (functions
), frame
);
9606 functions
= XCDR (functions
);
9612 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9613 #ifdef HAVE_WINDOW_SYSTEM
9614 update_tool_bar (f
, 0);
9619 unbind_to (count
, Qnil
);
9623 struct frame
*sf
= SELECTED_FRAME ();
9624 update_menu_bar (sf
, 1, 0);
9625 #ifdef HAVE_WINDOW_SYSTEM
9626 update_tool_bar (sf
, 1);
9630 /* Motif needs this. See comment in xmenu.c. Turn it off when
9631 pending_menu_activation is not defined. */
9632 #ifdef USE_X_TOOLKIT
9633 pending_menu_activation
= 0;
9638 /* Update the menu bar item list for frame F. This has to be done
9639 before we start to fill in any display lines, because it can call
9642 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9644 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9645 already ran the menu bar hooks for this redisplay, so there
9646 is no need to run them again. The return value is the
9647 updated value of this flag, to pass to the next call. */
9650 update_menu_bar (f
, save_match_data
, hooks_run
)
9652 int save_match_data
;
9656 register struct window
*w
;
9658 /* If called recursively during a menu update, do nothing. This can
9659 happen when, for instance, an activate-menubar-hook causes a
9661 if (inhibit_menubar_update
)
9664 window
= FRAME_SELECTED_WINDOW (f
);
9665 w
= XWINDOW (window
);
9667 if (FRAME_WINDOW_P (f
)
9669 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9670 || defined (HAVE_NS) || defined (USE_GTK)
9671 FRAME_EXTERNAL_MENU_BAR (f
)
9673 FRAME_MENU_BAR_LINES (f
) > 0
9675 : FRAME_MENU_BAR_LINES (f
) > 0)
9677 /* If the user has switched buffers or windows, we need to
9678 recompute to reflect the new bindings. But we'll
9679 recompute when update_mode_lines is set too; that means
9680 that people can use force-mode-line-update to request
9681 that the menu bar be recomputed. The adverse effect on
9682 the rest of the redisplay algorithm is about the same as
9683 windows_or_buffers_changed anyway. */
9684 if (windows_or_buffers_changed
9685 /* This used to test w->update_mode_line, but we believe
9686 there is no need to recompute the menu in that case. */
9687 || update_mode_lines
9688 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9689 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9690 != !NILP (w
->last_had_star
))
9691 || ((!NILP (Vtransient_mark_mode
)
9692 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9693 != !NILP (w
->region_showing
)))
9695 struct buffer
*prev
= current_buffer
;
9696 int count
= SPECPDL_INDEX ();
9698 specbind (Qinhibit_menubar_update
, Qt
);
9700 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9701 if (save_match_data
)
9702 record_unwind_save_match_data ();
9703 if (NILP (Voverriding_local_map_menu_flag
))
9705 specbind (Qoverriding_terminal_local_map
, Qnil
);
9706 specbind (Qoverriding_local_map
, Qnil
);
9711 /* Run the Lucid hook. */
9712 safe_run_hooks (Qactivate_menubar_hook
);
9714 /* If it has changed current-menubar from previous value,
9715 really recompute the menu-bar from the value. */
9716 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9717 call0 (Qrecompute_lucid_menubar
);
9719 safe_run_hooks (Qmenu_bar_update_hook
);
9724 XSETFRAME (Vmenu_updating_frame
, f
);
9725 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9727 /* Redisplay the menu bar in case we changed it. */
9728 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9729 || defined (HAVE_NS) || defined (USE_GTK)
9730 if (FRAME_WINDOW_P (f
))
9732 #if defined (HAVE_NS)
9733 /* All frames on Mac OS share the same menubar. So only
9734 the selected frame should be allowed to set it. */
9735 if (f
== SELECTED_FRAME ())
9737 set_frame_menubar (f
, 0, 0);
9740 /* On a terminal screen, the menu bar is an ordinary screen
9741 line, and this makes it get updated. */
9742 w
->update_mode_line
= Qt
;
9743 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9744 /* In the non-toolkit version, the menu bar is an ordinary screen
9745 line, and this makes it get updated. */
9746 w
->update_mode_line
= Qt
;
9747 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9749 unbind_to (count
, Qnil
);
9750 set_buffer_internal_1 (prev
);
9759 /***********************************************************************
9761 ***********************************************************************/
9763 #ifdef HAVE_WINDOW_SYSTEM
9766 Nominal cursor position -- where to draw output.
9767 HPOS and VPOS are window relative glyph matrix coordinates.
9768 X and Y are window relative pixel coordinates. */
9770 struct cursor_pos output_cursor
;
9774 Set the global variable output_cursor to CURSOR. All cursor
9775 positions are relative to updated_window. */
9778 set_output_cursor (cursor
)
9779 struct cursor_pos
*cursor
;
9781 output_cursor
.hpos
= cursor
->hpos
;
9782 output_cursor
.vpos
= cursor
->vpos
;
9783 output_cursor
.x
= cursor
->x
;
9784 output_cursor
.y
= cursor
->y
;
9789 Set a nominal cursor position.
9791 HPOS and VPOS are column/row positions in a window glyph matrix. X
9792 and Y are window text area relative pixel positions.
9794 If this is done during an update, updated_window will contain the
9795 window that is being updated and the position is the future output
9796 cursor position for that window. If updated_window is null, use
9797 selected_window and display the cursor at the given position. */
9800 x_cursor_to (vpos
, hpos
, y
, x
)
9801 int vpos
, hpos
, y
, x
;
9805 /* If updated_window is not set, work on selected_window. */
9809 w
= XWINDOW (selected_window
);
9811 /* Set the output cursor. */
9812 output_cursor
.hpos
= hpos
;
9813 output_cursor
.vpos
= vpos
;
9814 output_cursor
.x
= x
;
9815 output_cursor
.y
= y
;
9817 /* If not called as part of an update, really display the cursor.
9818 This will also set the cursor position of W. */
9819 if (updated_window
== NULL
)
9822 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
9823 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
9824 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
9829 #endif /* HAVE_WINDOW_SYSTEM */
9832 /***********************************************************************
9834 ***********************************************************************/
9836 #ifdef HAVE_WINDOW_SYSTEM
9838 /* Where the mouse was last time we reported a mouse event. */
9840 FRAME_PTR last_mouse_frame
;
9842 /* Tool-bar item index of the item on which a mouse button was pressed
9845 int last_tool_bar_item
;
9849 update_tool_bar_unwind (frame
)
9852 selected_frame
= frame
;
9856 /* Update the tool-bar item list for frame F. This has to be done
9857 before we start to fill in any display lines. Called from
9858 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
9859 and restore it here. */
9862 update_tool_bar (f
, save_match_data
)
9864 int save_match_data
;
9866 #if defined (USE_GTK) || defined (HAVE_NS)
9867 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
9869 int do_update
= WINDOWP (f
->tool_bar_window
)
9870 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
9878 window
= FRAME_SELECTED_WINDOW (f
);
9879 w
= XWINDOW (window
);
9881 /* If the user has switched buffers or windows, we need to
9882 recompute to reflect the new bindings. But we'll
9883 recompute when update_mode_lines is set too; that means
9884 that people can use force-mode-line-update to request
9885 that the menu bar be recomputed. The adverse effect on
9886 the rest of the redisplay algorithm is about the same as
9887 windows_or_buffers_changed anyway. */
9888 if (windows_or_buffers_changed
9889 || !NILP (w
->update_mode_line
)
9890 || update_mode_lines
9891 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9892 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9893 != !NILP (w
->last_had_star
))
9894 || ((!NILP (Vtransient_mark_mode
)
9895 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9896 != !NILP (w
->region_showing
)))
9898 struct buffer
*prev
= current_buffer
;
9899 int count
= SPECPDL_INDEX ();
9900 Lisp_Object frame
, new_tool_bar
;
9902 struct gcpro gcpro1
;
9904 /* Set current_buffer to the buffer of the selected
9905 window of the frame, so that we get the right local
9907 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9909 /* Save match data, if we must. */
9910 if (save_match_data
)
9911 record_unwind_save_match_data ();
9913 /* Make sure that we don't accidentally use bogus keymaps. */
9914 if (NILP (Voverriding_local_map_menu_flag
))
9916 specbind (Qoverriding_terminal_local_map
, Qnil
);
9917 specbind (Qoverriding_local_map
, Qnil
);
9920 GCPRO1 (new_tool_bar
);
9922 /* We must temporarily set the selected frame to this frame
9923 before calling tool_bar_items, because the calculation of
9924 the tool-bar keymap uses the selected frame (see
9925 `tool-bar-make-keymap' in tool-bar.el). */
9926 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
9927 XSETFRAME (frame
, f
);
9928 selected_frame
= frame
;
9930 /* Build desired tool-bar items from keymaps. */
9931 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
9934 /* Redisplay the tool-bar if we changed it. */
9935 if (new_n_tool_bar
!= f
->n_tool_bar_items
9936 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
9938 /* Redisplay that happens asynchronously due to an expose event
9939 may access f->tool_bar_items. Make sure we update both
9940 variables within BLOCK_INPUT so no such event interrupts. */
9942 f
->tool_bar_items
= new_tool_bar
;
9943 f
->n_tool_bar_items
= new_n_tool_bar
;
9944 w
->update_mode_line
= Qt
;
9950 unbind_to (count
, Qnil
);
9951 set_buffer_internal_1 (prev
);
9957 /* Set F->desired_tool_bar_string to a Lisp string representing frame
9958 F's desired tool-bar contents. F->tool_bar_items must have
9959 been set up previously by calling prepare_menu_bars. */
9962 build_desired_tool_bar_string (f
)
9965 int i
, size
, size_needed
;
9966 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9967 Lisp_Object image
, plist
, props
;
9969 image
= plist
= props
= Qnil
;
9970 GCPRO3 (image
, plist
, props
);
9972 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
9973 Otherwise, make a new string. */
9975 /* The size of the string we might be able to reuse. */
9976 size
= (STRINGP (f
->desired_tool_bar_string
)
9977 ? SCHARS (f
->desired_tool_bar_string
)
9980 /* We need one space in the string for each image. */
9981 size_needed
= f
->n_tool_bar_items
;
9983 /* Reuse f->desired_tool_bar_string, if possible. */
9984 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
9985 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
9989 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
9990 Fremove_text_properties (make_number (0), make_number (size
),
9991 props
, f
->desired_tool_bar_string
);
9994 /* Put a `display' property on the string for the images to display,
9995 put a `menu_item' property on tool-bar items with a value that
9996 is the index of the item in F's tool-bar item vector. */
9997 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
9999 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10001 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10002 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10003 int hmargin
, vmargin
, relief
, idx
, end
;
10004 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10006 /* If image is a vector, choose the image according to the
10008 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10009 if (VECTORP (image
))
10013 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10014 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10017 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10018 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10020 xassert (ASIZE (image
) >= idx
);
10021 image
= AREF (image
, idx
);
10026 /* Ignore invalid image specifications. */
10027 if (!valid_image_p (image
))
10030 /* Display the tool-bar button pressed, or depressed. */
10031 plist
= Fcopy_sequence (XCDR (image
));
10033 /* Compute margin and relief to draw. */
10034 relief
= (tool_bar_button_relief
>= 0
10035 ? tool_bar_button_relief
10036 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10037 hmargin
= vmargin
= relief
;
10039 if (INTEGERP (Vtool_bar_button_margin
)
10040 && XINT (Vtool_bar_button_margin
) > 0)
10042 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10043 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10045 else if (CONSP (Vtool_bar_button_margin
))
10047 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10048 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10049 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10051 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10052 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10053 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10056 if (auto_raise_tool_bar_buttons_p
)
10058 /* Add a `:relief' property to the image spec if the item is
10062 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10069 /* If image is selected, display it pressed, i.e. with a
10070 negative relief. If it's not selected, display it with a
10072 plist
= Fplist_put (plist
, QCrelief
,
10074 ? make_number (-relief
)
10075 : make_number (relief
)));
10080 /* Put a margin around the image. */
10081 if (hmargin
|| vmargin
)
10083 if (hmargin
== vmargin
)
10084 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10086 plist
= Fplist_put (plist
, QCmargin
,
10087 Fcons (make_number (hmargin
),
10088 make_number (vmargin
)));
10091 /* If button is not enabled, and we don't have special images
10092 for the disabled state, make the image appear disabled by
10093 applying an appropriate algorithm to it. */
10094 if (!enabled_p
&& idx
< 0)
10095 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10097 /* Put a `display' text property on the string for the image to
10098 display. Put a `menu-item' property on the string that gives
10099 the start of this item's properties in the tool-bar items
10101 image
= Fcons (Qimage
, plist
);
10102 props
= list4 (Qdisplay
, image
,
10103 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10105 /* Let the last image hide all remaining spaces in the tool bar
10106 string. The string can be longer than needed when we reuse a
10107 previous string. */
10108 if (i
+ 1 == f
->n_tool_bar_items
)
10109 end
= SCHARS (f
->desired_tool_bar_string
);
10112 Fadd_text_properties (make_number (i
), make_number (end
),
10113 props
, f
->desired_tool_bar_string
);
10121 /* Display one line of the tool-bar of frame IT->f.
10123 HEIGHT specifies the desired height of the tool-bar line.
10124 If the actual height of the glyph row is less than HEIGHT, the
10125 row's height is increased to HEIGHT, and the icons are centered
10126 vertically in the new height.
10128 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10129 count a final empty row in case the tool-bar width exactly matches
10134 display_tool_bar_line (it
, height
)
10138 struct glyph_row
*row
= it
->glyph_row
;
10139 int max_x
= it
->last_visible_x
;
10140 struct glyph
*last
;
10142 prepare_desired_row (row
);
10143 row
->y
= it
->current_y
;
10145 /* Note that this isn't made use of if the face hasn't a box,
10146 so there's no need to check the face here. */
10147 it
->start_of_box_run_p
= 1;
10149 while (it
->current_x
< max_x
)
10151 int x
, n_glyphs_before
, i
, nglyphs
;
10152 struct it it_before
;
10154 /* Get the next display element. */
10155 if (!get_next_display_element (it
))
10157 /* Don't count empty row if we are counting needed tool-bar lines. */
10158 if (height
< 0 && !it
->hpos
)
10163 /* Produce glyphs. */
10164 n_glyphs_before
= row
->used
[TEXT_AREA
];
10167 PRODUCE_GLYPHS (it
);
10169 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10171 x
= it_before
.current_x
;
10172 while (i
< nglyphs
)
10174 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10176 if (x
+ glyph
->pixel_width
> max_x
)
10178 /* Glyph doesn't fit on line. Backtrack. */
10179 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10181 /* If this is the only glyph on this line, it will never fit on the
10182 toolbar, so skip it. But ensure there is at least one glyph,
10183 so we don't accidentally disable the tool-bar. */
10184 if (n_glyphs_before
== 0
10185 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10191 x
+= glyph
->pixel_width
;
10195 /* Stop at line ends. */
10196 if (ITERATOR_AT_END_OF_LINE_P (it
))
10199 set_iterator_to_next (it
, 1);
10204 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10206 /* Use default face for the border below the tool bar.
10208 FIXME: When auto-resize-tool-bars is grow-only, there is
10209 no additional border below the possibly empty tool-bar lines.
10210 So to make the extra empty lines look "normal", we have to
10211 use the tool-bar face for the border too. */
10212 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10213 it
->face_id
= DEFAULT_FACE_ID
;
10215 extend_face_to_end_of_line (it
);
10216 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10217 last
->right_box_line_p
= 1;
10218 if (last
== row
->glyphs
[TEXT_AREA
])
10219 last
->left_box_line_p
= 1;
10221 /* Make line the desired height and center it vertically. */
10222 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10224 /* Don't add more than one line height. */
10225 height
%= FRAME_LINE_HEIGHT (it
->f
);
10226 it
->max_ascent
+= height
/ 2;
10227 it
->max_descent
+= (height
+ 1) / 2;
10230 compute_line_metrics (it
);
10232 /* If line is empty, make it occupy the rest of the tool-bar. */
10233 if (!row
->displays_text_p
)
10235 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10236 row
->visible_height
= row
->height
;
10237 row
->ascent
= row
->phys_ascent
= 0;
10238 row
->extra_line_spacing
= 0;
10241 row
->full_width_p
= 1;
10242 row
->continued_p
= 0;
10243 row
->truncated_on_left_p
= 0;
10244 row
->truncated_on_right_p
= 0;
10246 it
->current_x
= it
->hpos
= 0;
10247 it
->current_y
+= row
->height
;
10253 /* Max tool-bar height. */
10255 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10256 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10258 /* Value is the number of screen lines needed to make all tool-bar
10259 items of frame F visible. The number of actual rows needed is
10260 returned in *N_ROWS if non-NULL. */
10263 tool_bar_lines_needed (f
, n_rows
)
10267 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10269 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10270 the desired matrix, so use (unused) mode-line row as temporary row to
10271 avoid destroying the first tool-bar row. */
10272 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10274 /* Initialize an iterator for iteration over
10275 F->desired_tool_bar_string in the tool-bar window of frame F. */
10276 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10277 it
.first_visible_x
= 0;
10278 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10279 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10281 while (!ITERATOR_AT_END_P (&it
))
10283 clear_glyph_row (temp_row
);
10284 it
.glyph_row
= temp_row
;
10285 display_tool_bar_line (&it
, -1);
10287 clear_glyph_row (temp_row
);
10289 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10291 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10293 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10297 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10299 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10308 frame
= selected_frame
;
10310 CHECK_FRAME (frame
);
10311 f
= XFRAME (frame
);
10313 if (WINDOWP (f
->tool_bar_window
)
10314 || (w
= XWINDOW (f
->tool_bar_window
),
10315 WINDOW_TOTAL_LINES (w
) > 0))
10317 update_tool_bar (f
, 1);
10318 if (f
->n_tool_bar_items
)
10320 build_desired_tool_bar_string (f
);
10321 nlines
= tool_bar_lines_needed (f
, NULL
);
10325 return make_number (nlines
);
10329 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10330 height should be changed. */
10333 redisplay_tool_bar (f
)
10338 struct glyph_row
*row
;
10340 #if defined (USE_GTK) || defined (HAVE_NS)
10341 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10342 update_frame_tool_bar (f
);
10346 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10347 do anything. This means you must start with tool-bar-lines
10348 non-zero to get the auto-sizing effect. Or in other words, you
10349 can turn off tool-bars by specifying tool-bar-lines zero. */
10350 if (!WINDOWP (f
->tool_bar_window
)
10351 || (w
= XWINDOW (f
->tool_bar_window
),
10352 WINDOW_TOTAL_LINES (w
) == 0))
10355 /* Set up an iterator for the tool-bar window. */
10356 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10357 it
.first_visible_x
= 0;
10358 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10359 row
= it
.glyph_row
;
10361 /* Build a string that represents the contents of the tool-bar. */
10362 build_desired_tool_bar_string (f
);
10363 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10365 if (f
->n_tool_bar_rows
== 0)
10369 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10370 nlines
!= WINDOW_TOTAL_LINES (w
)))
10372 extern Lisp_Object Qtool_bar_lines
;
10374 int old_height
= WINDOW_TOTAL_LINES (w
);
10376 XSETFRAME (frame
, f
);
10377 Fmodify_frame_parameters (frame
,
10378 Fcons (Fcons (Qtool_bar_lines
,
10379 make_number (nlines
)),
10381 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10383 clear_glyph_matrix (w
->desired_matrix
);
10384 fonts_changed_p
= 1;
10390 /* Display as many lines as needed to display all tool-bar items. */
10392 if (f
->n_tool_bar_rows
> 0)
10394 int border
, rows
, height
, extra
;
10396 if (INTEGERP (Vtool_bar_border
))
10397 border
= XINT (Vtool_bar_border
);
10398 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10399 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10400 else if (EQ (Vtool_bar_border
, Qborder_width
))
10401 border
= f
->border_width
;
10407 rows
= f
->n_tool_bar_rows
;
10408 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10409 extra
= it
.last_visible_y
- border
- height
* rows
;
10411 while (it
.current_y
< it
.last_visible_y
)
10414 if (extra
> 0 && rows
-- > 0)
10416 h
= (extra
+ rows
- 1) / rows
;
10419 display_tool_bar_line (&it
, height
+ h
);
10424 while (it
.current_y
< it
.last_visible_y
)
10425 display_tool_bar_line (&it
, 0);
10428 /* It doesn't make much sense to try scrolling in the tool-bar
10429 window, so don't do it. */
10430 w
->desired_matrix
->no_scrolling_p
= 1;
10431 w
->must_be_updated_p
= 1;
10433 if (!NILP (Vauto_resize_tool_bars
))
10435 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10436 int change_height_p
= 0;
10438 /* If we couldn't display everything, change the tool-bar's
10439 height if there is room for more. */
10440 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10441 && it
.current_y
< max_tool_bar_height
)
10442 change_height_p
= 1;
10444 row
= it
.glyph_row
- 1;
10446 /* If there are blank lines at the end, except for a partially
10447 visible blank line at the end that is smaller than
10448 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10449 if (!row
->displays_text_p
10450 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10451 change_height_p
= 1;
10453 /* If row displays tool-bar items, but is partially visible,
10454 change the tool-bar's height. */
10455 if (row
->displays_text_p
10456 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10457 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10458 change_height_p
= 1;
10460 /* Resize windows as needed by changing the `tool-bar-lines'
10461 frame parameter. */
10462 if (change_height_p
)
10464 extern Lisp_Object Qtool_bar_lines
;
10466 int old_height
= WINDOW_TOTAL_LINES (w
);
10468 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10470 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10471 && !f
->minimize_tool_bar_window_p
)
10472 ? (nlines
> old_height
)
10473 : (nlines
!= old_height
));
10474 f
->minimize_tool_bar_window_p
= 0;
10476 if (change_height_p
)
10478 XSETFRAME (frame
, f
);
10479 Fmodify_frame_parameters (frame
,
10480 Fcons (Fcons (Qtool_bar_lines
,
10481 make_number (nlines
)),
10483 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10485 clear_glyph_matrix (w
->desired_matrix
);
10486 f
->n_tool_bar_rows
= nrows
;
10487 fonts_changed_p
= 1;
10494 f
->minimize_tool_bar_window_p
= 0;
10499 /* Get information about the tool-bar item which is displayed in GLYPH
10500 on frame F. Return in *PROP_IDX the index where tool-bar item
10501 properties start in F->tool_bar_items. Value is zero if
10502 GLYPH doesn't display a tool-bar item. */
10505 tool_bar_item_info (f
, glyph
, prop_idx
)
10507 struct glyph
*glyph
;
10514 /* This function can be called asynchronously, which means we must
10515 exclude any possibility that Fget_text_property signals an
10517 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10518 charpos
= max (0, charpos
);
10520 /* Get the text property `menu-item' at pos. The value of that
10521 property is the start index of this item's properties in
10522 F->tool_bar_items. */
10523 prop
= Fget_text_property (make_number (charpos
),
10524 Qmenu_item
, f
->current_tool_bar_string
);
10525 if (INTEGERP (prop
))
10527 *prop_idx
= XINT (prop
);
10537 /* Get information about the tool-bar item at position X/Y on frame F.
10538 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10539 the current matrix of the tool-bar window of F, or NULL if not
10540 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10541 item in F->tool_bar_items. Value is
10543 -1 if X/Y is not on a tool-bar item
10544 0 if X/Y is on the same item that was highlighted before.
10548 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10551 struct glyph
**glyph
;
10552 int *hpos
, *vpos
, *prop_idx
;
10554 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10555 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10558 /* Find the glyph under X/Y. */
10559 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10560 if (*glyph
== NULL
)
10563 /* Get the start of this tool-bar item's properties in
10564 f->tool_bar_items. */
10565 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10568 /* Is mouse on the highlighted item? */
10569 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10570 && *vpos
>= dpyinfo
->mouse_face_beg_row
10571 && *vpos
<= dpyinfo
->mouse_face_end_row
10572 && (*vpos
> dpyinfo
->mouse_face_beg_row
10573 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10574 && (*vpos
< dpyinfo
->mouse_face_end_row
10575 || *hpos
< dpyinfo
->mouse_face_end_col
10576 || dpyinfo
->mouse_face_past_end
))
10584 Handle mouse button event on the tool-bar of frame F, at
10585 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10586 0 for button release. MODIFIERS is event modifiers for button
10590 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10593 unsigned int modifiers
;
10595 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10596 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10597 int hpos
, vpos
, prop_idx
;
10598 struct glyph
*glyph
;
10599 Lisp_Object enabled_p
;
10601 /* If not on the highlighted tool-bar item, return. */
10602 frame_to_window_pixel_xy (w
, &x
, &y
);
10603 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10606 /* If item is disabled, do nothing. */
10607 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10608 if (NILP (enabled_p
))
10613 /* Show item in pressed state. */
10614 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10615 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10616 last_tool_bar_item
= prop_idx
;
10620 Lisp_Object key
, frame
;
10621 struct input_event event
;
10622 EVENT_INIT (event
);
10624 /* Show item in released state. */
10625 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10626 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10628 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10630 XSETFRAME (frame
, f
);
10631 event
.kind
= TOOL_BAR_EVENT
;
10632 event
.frame_or_window
= frame
;
10634 kbd_buffer_store_event (&event
);
10636 event
.kind
= TOOL_BAR_EVENT
;
10637 event
.frame_or_window
= frame
;
10639 event
.modifiers
= modifiers
;
10640 kbd_buffer_store_event (&event
);
10641 last_tool_bar_item
= -1;
10646 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10647 tool-bar window-relative coordinates X/Y. Called from
10648 note_mouse_highlight. */
10651 note_tool_bar_highlight (f
, x
, y
)
10655 Lisp_Object window
= f
->tool_bar_window
;
10656 struct window
*w
= XWINDOW (window
);
10657 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10659 struct glyph
*glyph
;
10660 struct glyph_row
*row
;
10662 Lisp_Object enabled_p
;
10664 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10665 int mouse_down_p
, rc
;
10667 /* Function note_mouse_highlight is called with negative x(y
10668 values when mouse moves outside of the frame. */
10669 if (x
<= 0 || y
<= 0)
10671 clear_mouse_face (dpyinfo
);
10675 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10678 /* Not on tool-bar item. */
10679 clear_mouse_face (dpyinfo
);
10683 /* On same tool-bar item as before. */
10684 goto set_help_echo
;
10686 clear_mouse_face (dpyinfo
);
10688 /* Mouse is down, but on different tool-bar item? */
10689 mouse_down_p
= (dpyinfo
->grabbed
10690 && f
== last_mouse_frame
10691 && FRAME_LIVE_P (f
));
10693 && last_tool_bar_item
!= prop_idx
)
10696 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10697 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10699 /* If tool-bar item is not enabled, don't highlight it. */
10700 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10701 if (!NILP (enabled_p
))
10703 /* Compute the x-position of the glyph. In front and past the
10704 image is a space. We include this in the highlighted area. */
10705 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10706 for (i
= x
= 0; i
< hpos
; ++i
)
10707 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10709 /* Record this as the current active region. */
10710 dpyinfo
->mouse_face_beg_col
= hpos
;
10711 dpyinfo
->mouse_face_beg_row
= vpos
;
10712 dpyinfo
->mouse_face_beg_x
= x
;
10713 dpyinfo
->mouse_face_beg_y
= row
->y
;
10714 dpyinfo
->mouse_face_past_end
= 0;
10716 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10717 dpyinfo
->mouse_face_end_row
= vpos
;
10718 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10719 dpyinfo
->mouse_face_end_y
= row
->y
;
10720 dpyinfo
->mouse_face_window
= window
;
10721 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10723 /* Display it as active. */
10724 show_mouse_face (dpyinfo
, draw
);
10725 dpyinfo
->mouse_face_image_state
= draw
;
10730 /* Set help_echo_string to a help string to display for this tool-bar item.
10731 XTread_socket does the rest. */
10732 help_echo_object
= help_echo_window
= Qnil
;
10733 help_echo_pos
= -1;
10734 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10735 if (NILP (help_echo_string
))
10736 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10739 #endif /* HAVE_WINDOW_SYSTEM */
10743 /************************************************************************
10744 Horizontal scrolling
10745 ************************************************************************/
10747 static int hscroll_window_tree
P_ ((Lisp_Object
));
10748 static int hscroll_windows
P_ ((Lisp_Object
));
10750 /* For all leaf windows in the window tree rooted at WINDOW, set their
10751 hscroll value so that PT is (i) visible in the window, and (ii) so
10752 that it is not within a certain margin at the window's left and
10753 right border. Value is non-zero if any window's hscroll has been
10757 hscroll_window_tree (window
)
10758 Lisp_Object window
;
10760 int hscrolled_p
= 0;
10761 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10762 int hscroll_step_abs
= 0;
10763 double hscroll_step_rel
= 0;
10765 if (hscroll_relative_p
)
10767 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10768 if (hscroll_step_rel
< 0)
10770 hscroll_relative_p
= 0;
10771 hscroll_step_abs
= 0;
10774 else if (INTEGERP (Vhscroll_step
))
10776 hscroll_step_abs
= XINT (Vhscroll_step
);
10777 if (hscroll_step_abs
< 0)
10778 hscroll_step_abs
= 0;
10781 hscroll_step_abs
= 0;
10783 while (WINDOWP (window
))
10785 struct window
*w
= XWINDOW (window
);
10787 if (WINDOWP (w
->hchild
))
10788 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
10789 else if (WINDOWP (w
->vchild
))
10790 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
10791 else if (w
->cursor
.vpos
>= 0)
10794 int text_area_width
;
10795 struct glyph_row
*current_cursor_row
10796 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
10797 struct glyph_row
*desired_cursor_row
10798 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
10799 struct glyph_row
*cursor_row
10800 = (desired_cursor_row
->enabled_p
10801 ? desired_cursor_row
10802 : current_cursor_row
);
10804 text_area_width
= window_box_width (w
, TEXT_AREA
);
10806 /* Scroll when cursor is inside this scroll margin. */
10807 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
10809 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
10810 && ((XFASTINT (w
->hscroll
)
10811 && w
->cursor
.x
<= h_margin
)
10812 || (cursor_row
->enabled_p
10813 && cursor_row
->truncated_on_right_p
10814 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
10818 struct buffer
*saved_current_buffer
;
10822 /* Find point in a display of infinite width. */
10823 saved_current_buffer
= current_buffer
;
10824 current_buffer
= XBUFFER (w
->buffer
);
10826 if (w
== XWINDOW (selected_window
))
10827 pt
= BUF_PT (current_buffer
);
10830 pt
= marker_position (w
->pointm
);
10831 pt
= max (BEGV
, pt
);
10835 /* Move iterator to pt starting at cursor_row->start in
10836 a line with infinite width. */
10837 init_to_row_start (&it
, w
, cursor_row
);
10838 it
.last_visible_x
= INFINITY
;
10839 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
10840 current_buffer
= saved_current_buffer
;
10842 /* Position cursor in window. */
10843 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
10844 hscroll
= max (0, (it
.current_x
10845 - (ITERATOR_AT_END_OF_LINE_P (&it
)
10846 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
10847 : (text_area_width
/ 2))))
10848 / FRAME_COLUMN_WIDTH (it
.f
);
10849 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
10851 if (hscroll_relative_p
)
10852 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
10855 wanted_x
= text_area_width
10856 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10859 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10863 if (hscroll_relative_p
)
10864 wanted_x
= text_area_width
* hscroll_step_rel
10867 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
10870 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
10872 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
10874 /* Don't call Fset_window_hscroll if value hasn't
10875 changed because it will prevent redisplay
10877 if (XFASTINT (w
->hscroll
) != hscroll
)
10879 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
10880 w
->hscroll
= make_number (hscroll
);
10889 /* Value is non-zero if hscroll of any leaf window has been changed. */
10890 return hscrolled_p
;
10894 /* Set hscroll so that cursor is visible and not inside horizontal
10895 scroll margins for all windows in the tree rooted at WINDOW. See
10896 also hscroll_window_tree above. Value is non-zero if any window's
10897 hscroll has been changed. If it has, desired matrices on the frame
10898 of WINDOW are cleared. */
10901 hscroll_windows (window
)
10902 Lisp_Object window
;
10904 int hscrolled_p
= hscroll_window_tree (window
);
10906 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
10907 return hscrolled_p
;
10912 /************************************************************************
10914 ************************************************************************/
10916 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
10917 to a non-zero value. This is sometimes handy to have in a debugger
10922 /* First and last unchanged row for try_window_id. */
10924 int debug_first_unchanged_at_end_vpos
;
10925 int debug_last_unchanged_at_beg_vpos
;
10927 /* Delta vpos and y. */
10929 int debug_dvpos
, debug_dy
;
10931 /* Delta in characters and bytes for try_window_id. */
10933 int debug_delta
, debug_delta_bytes
;
10935 /* Values of window_end_pos and window_end_vpos at the end of
10938 EMACS_INT debug_end_pos
, debug_end_vpos
;
10940 /* Append a string to W->desired_matrix->method. FMT is a printf
10941 format string. A1...A9 are a supplement for a variable-length
10942 argument list. If trace_redisplay_p is non-zero also printf the
10943 resulting string to stderr. */
10946 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
10949 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
10952 char *method
= w
->desired_matrix
->method
;
10953 int len
= strlen (method
);
10954 int size
= sizeof w
->desired_matrix
->method
;
10955 int remaining
= size
- len
- 1;
10957 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
10958 if (len
&& remaining
)
10961 --remaining
, ++len
;
10964 strncpy (method
+ len
, buffer
, remaining
);
10966 if (trace_redisplay_p
)
10967 fprintf (stderr
, "%p (%s): %s\n",
10969 ((BUFFERP (w
->buffer
)
10970 && STRINGP (XBUFFER (w
->buffer
)->name
))
10971 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
10976 #endif /* GLYPH_DEBUG */
10979 /* Value is non-zero if all changes in window W, which displays
10980 current_buffer, are in the text between START and END. START is a
10981 buffer position, END is given as a distance from Z. Used in
10982 redisplay_internal for display optimization. */
10985 text_outside_line_unchanged_p (w
, start
, end
)
10989 int unchanged_p
= 1;
10991 /* If text or overlays have changed, see where. */
10992 if (XFASTINT (w
->last_modified
) < MODIFF
10993 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
10995 /* Gap in the line? */
10996 if (GPT
< start
|| Z
- GPT
< end
)
10999 /* Changes start in front of the line, or end after it? */
11001 && (BEG_UNCHANGED
< start
- 1
11002 || END_UNCHANGED
< end
))
11005 /* If selective display, can't optimize if changes start at the
11006 beginning of the line. */
11008 && INTEGERP (current_buffer
->selective_display
)
11009 && XINT (current_buffer
->selective_display
) > 0
11010 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11013 /* If there are overlays at the start or end of the line, these
11014 may have overlay strings with newlines in them. A change at
11015 START, for instance, may actually concern the display of such
11016 overlay strings as well, and they are displayed on different
11017 lines. So, quickly rule out this case. (For the future, it
11018 might be desirable to implement something more telling than
11019 just BEG/END_UNCHANGED.) */
11022 if (BEG
+ BEG_UNCHANGED
== start
11023 && overlay_touches_p (start
))
11025 if (END_UNCHANGED
== end
11026 && overlay_touches_p (Z
- end
))
11031 return unchanged_p
;
11035 /* Do a frame update, taking possible shortcuts into account. This is
11036 the main external entry point for redisplay.
11038 If the last redisplay displayed an echo area message and that message
11039 is no longer requested, we clear the echo area or bring back the
11040 mini-buffer if that is in use. */
11045 redisplay_internal (0);
11050 overlay_arrow_string_or_property (var
)
11055 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11058 return Voverlay_arrow_string
;
11061 /* Return 1 if there are any overlay-arrows in current_buffer. */
11063 overlay_arrow_in_current_buffer_p ()
11067 for (vlist
= Voverlay_arrow_variable_list
;
11069 vlist
= XCDR (vlist
))
11071 Lisp_Object var
= XCAR (vlist
);
11074 if (!SYMBOLP (var
))
11076 val
= find_symbol_value (var
);
11078 && current_buffer
== XMARKER (val
)->buffer
)
11085 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11089 overlay_arrows_changed_p ()
11093 for (vlist
= Voverlay_arrow_variable_list
;
11095 vlist
= XCDR (vlist
))
11097 Lisp_Object var
= XCAR (vlist
);
11098 Lisp_Object val
, pstr
;
11100 if (!SYMBOLP (var
))
11102 val
= find_symbol_value (var
);
11103 if (!MARKERP (val
))
11105 if (! EQ (COERCE_MARKER (val
),
11106 Fget (var
, Qlast_arrow_position
))
11107 || ! (pstr
= overlay_arrow_string_or_property (var
),
11108 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11114 /* Mark overlay arrows to be updated on next redisplay. */
11117 update_overlay_arrows (up_to_date
)
11122 for (vlist
= Voverlay_arrow_variable_list
;
11124 vlist
= XCDR (vlist
))
11126 Lisp_Object var
= XCAR (vlist
);
11128 if (!SYMBOLP (var
))
11131 if (up_to_date
> 0)
11133 Lisp_Object val
= find_symbol_value (var
);
11134 Fput (var
, Qlast_arrow_position
,
11135 COERCE_MARKER (val
));
11136 Fput (var
, Qlast_arrow_string
,
11137 overlay_arrow_string_or_property (var
));
11139 else if (up_to_date
< 0
11140 || !NILP (Fget (var
, Qlast_arrow_position
)))
11142 Fput (var
, Qlast_arrow_position
, Qt
);
11143 Fput (var
, Qlast_arrow_string
, Qt
);
11149 /* Return overlay arrow string to display at row.
11150 Return integer (bitmap number) for arrow bitmap in left fringe.
11151 Return nil if no overlay arrow. */
11154 overlay_arrow_at_row (it
, row
)
11156 struct glyph_row
*row
;
11160 for (vlist
= Voverlay_arrow_variable_list
;
11162 vlist
= XCDR (vlist
))
11164 Lisp_Object var
= XCAR (vlist
);
11167 if (!SYMBOLP (var
))
11170 val
= find_symbol_value (var
);
11173 && current_buffer
== XMARKER (val
)->buffer
11174 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11176 if (FRAME_WINDOW_P (it
->f
)
11177 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11179 #ifdef HAVE_WINDOW_SYSTEM
11180 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11183 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11184 return make_number (fringe_bitmap
);
11187 return make_number (-1); /* Use default arrow bitmap */
11189 return overlay_arrow_string_or_property (var
);
11196 /* Return 1 if point moved out of or into a composition. Otherwise
11197 return 0. PREV_BUF and PREV_PT are the last point buffer and
11198 position. BUF and PT are the current point buffer and position. */
11201 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11202 struct buffer
*prev_buf
, *buf
;
11205 EMACS_INT start
, end
;
11207 Lisp_Object buffer
;
11209 XSETBUFFER (buffer
, buf
);
11210 /* Check a composition at the last point if point moved within the
11212 if (prev_buf
== buf
)
11215 /* Point didn't move. */
11218 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11219 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11220 && COMPOSITION_VALID_P (start
, end
, prop
)
11221 && start
< prev_pt
&& end
> prev_pt
)
11222 /* The last point was within the composition. Return 1 iff
11223 point moved out of the composition. */
11224 return (pt
<= start
|| pt
>= end
);
11227 /* Check a composition at the current point. */
11228 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11229 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11230 && COMPOSITION_VALID_P (start
, end
, prop
)
11231 && start
< pt
&& end
> pt
);
11235 /* Reconsider the setting of B->clip_changed which is displayed
11239 reconsider_clip_changes (w
, b
)
11243 if (b
->clip_changed
11244 && !NILP (w
->window_end_valid
)
11245 && w
->current_matrix
->buffer
== b
11246 && w
->current_matrix
->zv
== BUF_ZV (b
)
11247 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11248 b
->clip_changed
= 0;
11250 /* If display wasn't paused, and W is not a tool bar window, see if
11251 point has been moved into or out of a composition. In that case,
11252 we set b->clip_changed to 1 to force updating the screen. If
11253 b->clip_changed has already been set to 1, we can skip this
11255 if (!b
->clip_changed
11256 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11260 if (w
== XWINDOW (selected_window
))
11261 pt
= BUF_PT (current_buffer
);
11263 pt
= marker_position (w
->pointm
);
11265 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11266 || pt
!= XINT (w
->last_point
))
11267 && check_point_in_composition (w
->current_matrix
->buffer
,
11268 XINT (w
->last_point
),
11269 XBUFFER (w
->buffer
), pt
))
11270 b
->clip_changed
= 1;
11275 /* Select FRAME to forward the values of frame-local variables into C
11276 variables so that the redisplay routines can access those values
11280 select_frame_for_redisplay (frame
)
11283 Lisp_Object tail
, symbol
, val
;
11284 Lisp_Object old
= selected_frame
;
11285 struct Lisp_Symbol
*sym
;
11287 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11289 selected_frame
= frame
;
11293 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11294 if (CONSP (XCAR (tail
))
11295 && (symbol
= XCAR (XCAR (tail
)),
11297 && (sym
= indirect_variable (XSYMBOL (symbol
)),
11299 (BUFFER_LOCAL_VALUEP (val
)))
11300 && XBUFFER_LOCAL_VALUE (val
)->check_frame
)
11301 /* Use find_symbol_value rather than Fsymbol_value
11302 to avoid an error if it is void. */
11303 find_symbol_value (symbol
);
11304 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11308 #define STOP_POLLING \
11309 do { if (! polling_stopped_here) stop_polling (); \
11310 polling_stopped_here = 1; } while (0)
11312 #define RESUME_POLLING \
11313 do { if (polling_stopped_here) start_polling (); \
11314 polling_stopped_here = 0; } while (0)
11317 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11318 response to any user action; therefore, we should preserve the echo
11319 area. (Actually, our caller does that job.) Perhaps in the future
11320 avoid recentering windows if it is not necessary; currently that
11321 causes some problems. */
11324 redisplay_internal (preserve_echo_area
)
11325 int preserve_echo_area
;
11327 struct window
*w
= XWINDOW (selected_window
);
11330 int must_finish
= 0;
11331 struct text_pos tlbufpos
, tlendpos
;
11332 int number_of_visible_frames
;
11335 int polling_stopped_here
= 0;
11336 Lisp_Object old_frame
= selected_frame
;
11338 /* Non-zero means redisplay has to consider all windows on all
11339 frames. Zero means, only selected_window is considered. */
11340 int consider_all_windows_p
;
11342 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11344 /* No redisplay if running in batch mode or frame is not yet fully
11345 initialized, or redisplay is explicitly turned off by setting
11346 Vinhibit_redisplay. */
11347 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11348 || !NILP (Vinhibit_redisplay
))
11351 /* Don't examine these until after testing Vinhibit_redisplay.
11352 When Emacs is shutting down, perhaps because its connection to
11353 X has dropped, we should not look at them at all. */
11354 f
= XFRAME (w
->frame
);
11355 sf
= SELECTED_FRAME ();
11357 if (!f
->glyphs_initialized_p
)
11360 /* The flag redisplay_performed_directly_p is set by
11361 direct_output_for_insert when it already did the whole screen
11362 update necessary. */
11363 if (redisplay_performed_directly_p
)
11365 redisplay_performed_directly_p
= 0;
11366 if (!hscroll_windows (selected_window
))
11370 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11371 if (popup_activated ())
11375 /* I don't think this happens but let's be paranoid. */
11376 if (redisplaying_p
)
11379 /* Record a function that resets redisplaying_p to its old value
11380 when we leave this function. */
11381 count
= SPECPDL_INDEX ();
11382 record_unwind_protect (unwind_redisplay
,
11383 Fcons (make_number (redisplaying_p
), selected_frame
));
11385 specbind (Qinhibit_free_realized_faces
, Qnil
);
11388 Lisp_Object tail
, frame
;
11390 FOR_EACH_FRAME (tail
, frame
)
11392 struct frame
*f
= XFRAME (frame
);
11393 f
->already_hscrolled_p
= 0;
11398 if (!EQ (old_frame
, selected_frame
)
11399 && FRAME_LIVE_P (XFRAME (old_frame
)))
11400 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11401 selected_frame and selected_window to be temporarily out-of-sync so
11402 when we come back here via `goto retry', we need to resync because we
11403 may need to run Elisp code (via prepare_menu_bars). */
11404 select_frame_for_redisplay (old_frame
);
11407 reconsider_clip_changes (w
, current_buffer
);
11408 last_escape_glyph_frame
= NULL
;
11409 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11411 /* If new fonts have been loaded that make a glyph matrix adjustment
11412 necessary, do it. */
11413 if (fonts_changed_p
)
11415 adjust_glyphs (NULL
);
11416 ++windows_or_buffers_changed
;
11417 fonts_changed_p
= 0;
11420 /* If face_change_count is non-zero, init_iterator will free all
11421 realized faces, which includes the faces referenced from current
11422 matrices. So, we can't reuse current matrices in this case. */
11423 if (face_change_count
)
11424 ++windows_or_buffers_changed
;
11426 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11427 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11429 /* Since frames on a single ASCII terminal share the same
11430 display area, displaying a different frame means redisplay
11431 the whole thing. */
11432 windows_or_buffers_changed
++;
11433 SET_FRAME_GARBAGED (sf
);
11435 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11437 FRAME_TTY (sf
)->previous_frame
= sf
;
11440 /* Set the visible flags for all frames. Do this before checking
11441 for resized or garbaged frames; they want to know if their frames
11442 are visible. See the comment in frame.h for
11443 FRAME_SAMPLE_VISIBILITY. */
11445 Lisp_Object tail
, frame
;
11447 number_of_visible_frames
= 0;
11449 FOR_EACH_FRAME (tail
, frame
)
11451 struct frame
*f
= XFRAME (frame
);
11453 FRAME_SAMPLE_VISIBILITY (f
);
11454 if (FRAME_VISIBLE_P (f
))
11455 ++number_of_visible_frames
;
11456 clear_desired_matrices (f
);
11460 /* Notice any pending interrupt request to change frame size. */
11461 do_pending_window_change (1);
11463 /* Clear frames marked as garbaged. */
11464 if (frame_garbaged
)
11465 clear_garbaged_frames ();
11467 /* Build menubar and tool-bar items. */
11468 if (NILP (Vmemory_full
))
11469 prepare_menu_bars ();
11471 if (windows_or_buffers_changed
)
11472 update_mode_lines
++;
11474 /* Detect case that we need to write or remove a star in the mode line. */
11475 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11477 w
->update_mode_line
= Qt
;
11478 if (buffer_shared
> 1)
11479 update_mode_lines
++;
11482 /* Avoid invocation of point motion hooks by `current_column' below. */
11483 count1
= SPECPDL_INDEX ();
11484 specbind (Qinhibit_point_motion_hooks
, Qt
);
11486 /* If %c is in the mode line, update it if needed. */
11487 if (!NILP (w
->column_number_displayed
)
11488 /* This alternative quickly identifies a common case
11489 where no change is needed. */
11490 && !(PT
== XFASTINT (w
->last_point
)
11491 && XFASTINT (w
->last_modified
) >= MODIFF
11492 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11493 && (XFASTINT (w
->column_number_displayed
)
11494 != (int) current_column ())) /* iftc */
11495 w
->update_mode_line
= Qt
;
11497 unbind_to (count1
, Qnil
);
11499 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11501 /* The variable buffer_shared is set in redisplay_window and
11502 indicates that we redisplay a buffer in different windows. See
11504 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11505 || cursor_type_changed
);
11507 /* If specs for an arrow have changed, do thorough redisplay
11508 to ensure we remove any arrow that should no longer exist. */
11509 if (overlay_arrows_changed_p ())
11510 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11512 /* Normally the message* functions will have already displayed and
11513 updated the echo area, but the frame may have been trashed, or
11514 the update may have been preempted, so display the echo area
11515 again here. Checking message_cleared_p captures the case that
11516 the echo area should be cleared. */
11517 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11518 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11519 || (message_cleared_p
11520 && minibuf_level
== 0
11521 /* If the mini-window is currently selected, this means the
11522 echo-area doesn't show through. */
11523 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11525 int window_height_changed_p
= echo_area_display (0);
11528 /* If we don't display the current message, don't clear the
11529 message_cleared_p flag, because, if we did, we wouldn't clear
11530 the echo area in the next redisplay which doesn't preserve
11532 if (!display_last_displayed_message_p
)
11533 message_cleared_p
= 0;
11535 if (fonts_changed_p
)
11537 else if (window_height_changed_p
)
11539 consider_all_windows_p
= 1;
11540 ++update_mode_lines
;
11541 ++windows_or_buffers_changed
;
11543 /* If window configuration was changed, frames may have been
11544 marked garbaged. Clear them or we will experience
11545 surprises wrt scrolling. */
11546 if (frame_garbaged
)
11547 clear_garbaged_frames ();
11550 else if (EQ (selected_window
, minibuf_window
)
11551 && (current_buffer
->clip_changed
11552 || XFASTINT (w
->last_modified
) < MODIFF
11553 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11554 && resize_mini_window (w
, 0))
11556 /* Resized active mini-window to fit the size of what it is
11557 showing if its contents might have changed. */
11559 /* FIXME: this causes all frames to be updated, which seems unnecessary
11560 since only the current frame needs to be considered. This function needs
11561 to be rewritten with two variables, consider_all_windows and
11562 consider_all_frames. */
11563 consider_all_windows_p
= 1;
11564 ++windows_or_buffers_changed
;
11565 ++update_mode_lines
;
11567 /* If window configuration was changed, frames may have been
11568 marked garbaged. Clear them or we will experience
11569 surprises wrt scrolling. */
11570 if (frame_garbaged
)
11571 clear_garbaged_frames ();
11575 /* If showing the region, and mark has changed, we must redisplay
11576 the whole window. The assignment to this_line_start_pos prevents
11577 the optimization directly below this if-statement. */
11578 if (((!NILP (Vtransient_mark_mode
)
11579 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11580 != !NILP (w
->region_showing
))
11581 || (!NILP (w
->region_showing
)
11582 && !EQ (w
->region_showing
,
11583 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11584 CHARPOS (this_line_start_pos
) = 0;
11586 /* Optimize the case that only the line containing the cursor in the
11587 selected window has changed. Variables starting with this_ are
11588 set in display_line and record information about the line
11589 containing the cursor. */
11590 tlbufpos
= this_line_start_pos
;
11591 tlendpos
= this_line_end_pos
;
11592 if (!consider_all_windows_p
11593 && CHARPOS (tlbufpos
) > 0
11594 && NILP (w
->update_mode_line
)
11595 && !current_buffer
->clip_changed
11596 && !current_buffer
->prevent_redisplay_optimizations_p
11597 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11598 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11599 /* Make sure recorded data applies to current buffer, etc. */
11600 && this_line_buffer
== current_buffer
11601 && current_buffer
== XBUFFER (w
->buffer
)
11602 && NILP (w
->force_start
)
11603 && NILP (w
->optional_new_start
)
11604 /* Point must be on the line that we have info recorded about. */
11605 && PT
>= CHARPOS (tlbufpos
)
11606 && PT
<= Z
- CHARPOS (tlendpos
)
11607 /* All text outside that line, including its final newline,
11608 must be unchanged. */
11609 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11610 CHARPOS (tlendpos
)))
11612 if (CHARPOS (tlbufpos
) > BEGV
11613 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11614 && (CHARPOS (tlbufpos
) == ZV
11615 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11616 /* Former continuation line has disappeared by becoming empty. */
11618 else if (XFASTINT (w
->last_modified
) < MODIFF
11619 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11620 || MINI_WINDOW_P (w
))
11622 /* We have to handle the case of continuation around a
11623 wide-column character (see the comment in indent.c around
11626 For instance, in the following case:
11628 -------- Insert --------
11629 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11630 J_I_ ==> J_I_ `^^' are cursors.
11634 As we have to redraw the line above, we cannot use this
11638 int line_height_before
= this_line_pixel_height
;
11640 /* Note that start_display will handle the case that the
11641 line starting at tlbufpos is a continuation line. */
11642 start_display (&it
, w
, tlbufpos
);
11644 /* Implementation note: It this still necessary? */
11645 if (it
.current_x
!= this_line_start_x
)
11648 TRACE ((stderr
, "trying display optimization 1\n"));
11649 w
->cursor
.vpos
= -1;
11650 overlay_arrow_seen
= 0;
11651 it
.vpos
= this_line_vpos
;
11652 it
.current_y
= this_line_y
;
11653 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11654 display_line (&it
);
11656 /* If line contains point, is not continued,
11657 and ends at same distance from eob as before, we win. */
11658 if (w
->cursor
.vpos
>= 0
11659 /* Line is not continued, otherwise this_line_start_pos
11660 would have been set to 0 in display_line. */
11661 && CHARPOS (this_line_start_pos
)
11662 /* Line ends as before. */
11663 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11664 /* Line has same height as before. Otherwise other lines
11665 would have to be shifted up or down. */
11666 && this_line_pixel_height
== line_height_before
)
11668 /* If this is not the window's last line, we must adjust
11669 the charstarts of the lines below. */
11670 if (it
.current_y
< it
.last_visible_y
)
11672 struct glyph_row
*row
11673 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11674 int delta
, delta_bytes
;
11676 /* We used to distinguish between two cases here,
11677 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11678 when the line ends in a newline or the end of the
11679 buffer's accessible portion. But both cases did
11680 the same, so they were collapsed. */
11682 - CHARPOS (tlendpos
)
11683 - MATRIX_ROW_START_CHARPOS (row
));
11684 delta_bytes
= (Z_BYTE
11685 - BYTEPOS (tlendpos
)
11686 - MATRIX_ROW_START_BYTEPOS (row
));
11688 increment_matrix_positions (w
->current_matrix
,
11689 this_line_vpos
+ 1,
11690 w
->current_matrix
->nrows
,
11691 delta
, delta_bytes
);
11694 /* If this row displays text now but previously didn't,
11695 or vice versa, w->window_end_vpos may have to be
11697 if ((it
.glyph_row
- 1)->displays_text_p
)
11699 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11700 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11702 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11703 && this_line_vpos
> 0)
11704 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11705 w
->window_end_valid
= Qnil
;
11707 /* Update hint: No need to try to scroll in update_window. */
11708 w
->desired_matrix
->no_scrolling_p
= 1;
11711 *w
->desired_matrix
->method
= 0;
11712 debug_method_add (w
, "optimization 1");
11714 #ifdef HAVE_WINDOW_SYSTEM
11715 update_window_fringes (w
, 0);
11722 else if (/* Cursor position hasn't changed. */
11723 PT
== XFASTINT (w
->last_point
)
11724 /* Make sure the cursor was last displayed
11725 in this window. Otherwise we have to reposition it. */
11726 && 0 <= w
->cursor
.vpos
11727 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11731 do_pending_window_change (1);
11733 /* We used to always goto end_of_redisplay here, but this
11734 isn't enough if we have a blinking cursor. */
11735 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11736 goto end_of_redisplay
;
11740 /* If highlighting the region, or if the cursor is in the echo area,
11741 then we can't just move the cursor. */
11742 else if (! (!NILP (Vtransient_mark_mode
)
11743 && !NILP (current_buffer
->mark_active
))
11744 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11745 || highlight_nonselected_windows
)
11746 && NILP (w
->region_showing
)
11747 && NILP (Vshow_trailing_whitespace
)
11748 && !cursor_in_echo_area
)
11751 struct glyph_row
*row
;
11753 /* Skip from tlbufpos to PT and see where it is. Note that
11754 PT may be in invisible text. If so, we will end at the
11755 next visible position. */
11756 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11757 NULL
, DEFAULT_FACE_ID
);
11758 it
.current_x
= this_line_start_x
;
11759 it
.current_y
= this_line_y
;
11760 it
.vpos
= this_line_vpos
;
11762 /* The call to move_it_to stops in front of PT, but
11763 moves over before-strings. */
11764 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11766 if (it
.vpos
== this_line_vpos
11767 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11770 xassert (this_line_vpos
== it
.vpos
);
11771 xassert (this_line_y
== it
.current_y
);
11772 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11774 *w
->desired_matrix
->method
= 0;
11775 debug_method_add (w
, "optimization 3");
11784 /* Text changed drastically or point moved off of line. */
11785 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11788 CHARPOS (this_line_start_pos
) = 0;
11789 consider_all_windows_p
|= buffer_shared
> 1;
11790 ++clear_face_cache_count
;
11791 #ifdef HAVE_WINDOW_SYSTEM
11792 ++clear_image_cache_count
;
11795 /* Build desired matrices, and update the display. If
11796 consider_all_windows_p is non-zero, do it for all windows on all
11797 frames. Otherwise do it for selected_window, only. */
11799 if (consider_all_windows_p
)
11801 Lisp_Object tail
, frame
;
11803 FOR_EACH_FRAME (tail
, frame
)
11804 XFRAME (frame
)->updated_p
= 0;
11806 /* Recompute # windows showing selected buffer. This will be
11807 incremented each time such a window is displayed. */
11810 FOR_EACH_FRAME (tail
, frame
)
11812 struct frame
*f
= XFRAME (frame
);
11814 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
11816 if (! EQ (frame
, selected_frame
))
11817 /* Select the frame, for the sake of frame-local
11819 select_frame_for_redisplay (frame
);
11821 /* Mark all the scroll bars to be removed; we'll redeem
11822 the ones we want when we redisplay their windows. */
11823 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
11824 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
11826 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11827 redisplay_windows (FRAME_ROOT_WINDOW (f
));
11829 /* The X error handler may have deleted that frame. */
11830 if (!FRAME_LIVE_P (f
))
11833 /* Any scroll bars which redisplay_windows should have
11834 nuked should now go away. */
11835 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
11836 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
11838 /* If fonts changed, display again. */
11839 /* ??? rms: I suspect it is a mistake to jump all the way
11840 back to retry here. It should just retry this frame. */
11841 if (fonts_changed_p
)
11844 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
11846 /* See if we have to hscroll. */
11847 if (!f
->already_hscrolled_p
)
11849 f
->already_hscrolled_p
= 1;
11850 if (hscroll_windows (f
->root_window
))
11854 /* Prevent various kinds of signals during display
11855 update. stdio is not robust about handling
11856 signals, which can cause an apparent I/O
11858 if (interrupt_input
)
11859 unrequest_sigio ();
11862 /* Update the display. */
11863 set_window_update_flags (XWINDOW (f
->root_window
), 1);
11864 pause
|= update_frame (f
, 0, 0);
11870 if (!EQ (old_frame
, selected_frame
)
11871 && FRAME_LIVE_P (XFRAME (old_frame
)))
11872 /* We played a bit fast-and-loose above and allowed selected_frame
11873 and selected_window to be temporarily out-of-sync but let's make
11874 sure this stays contained. */
11875 select_frame_for_redisplay (old_frame
);
11876 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
11880 /* Do the mark_window_display_accurate after all windows have
11881 been redisplayed because this call resets flags in buffers
11882 which are needed for proper redisplay. */
11883 FOR_EACH_FRAME (tail
, frame
)
11885 struct frame
*f
= XFRAME (frame
);
11888 mark_window_display_accurate (f
->root_window
, 1);
11889 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
11890 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
11895 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11897 Lisp_Object mini_window
;
11898 struct frame
*mini_frame
;
11900 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
11901 /* Use list_of_error, not Qerror, so that
11902 we catch only errors and don't run the debugger. */
11903 internal_condition_case_1 (redisplay_window_1
, selected_window
,
11905 redisplay_window_error
);
11907 /* Compare desired and current matrices, perform output. */
11910 /* If fonts changed, display again. */
11911 if (fonts_changed_p
)
11914 /* Prevent various kinds of signals during display update.
11915 stdio is not robust about handling signals,
11916 which can cause an apparent I/O error. */
11917 if (interrupt_input
)
11918 unrequest_sigio ();
11921 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
11923 if (hscroll_windows (selected_window
))
11926 XWINDOW (selected_window
)->must_be_updated_p
= 1;
11927 pause
= update_frame (sf
, 0, 0);
11930 /* We may have called echo_area_display at the top of this
11931 function. If the echo area is on another frame, that may
11932 have put text on a frame other than the selected one, so the
11933 above call to update_frame would not have caught it. Catch
11935 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11936 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
11938 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
11940 XWINDOW (mini_window
)->must_be_updated_p
= 1;
11941 pause
|= update_frame (mini_frame
, 0, 0);
11942 if (!pause
&& hscroll_windows (mini_window
))
11947 /* If display was paused because of pending input, make sure we do a
11948 thorough update the next time. */
11951 /* Prevent the optimization at the beginning of
11952 redisplay_internal that tries a single-line update of the
11953 line containing the cursor in the selected window. */
11954 CHARPOS (this_line_start_pos
) = 0;
11956 /* Let the overlay arrow be updated the next time. */
11957 update_overlay_arrows (0);
11959 /* If we pause after scrolling, some rows in the current
11960 matrices of some windows are not valid. */
11961 if (!WINDOW_FULL_WIDTH_P (w
)
11962 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
11963 update_mode_lines
= 1;
11967 if (!consider_all_windows_p
)
11969 /* This has already been done above if
11970 consider_all_windows_p is set. */
11971 mark_window_display_accurate_1 (w
, 1);
11973 /* Say overlay arrows are up to date. */
11974 update_overlay_arrows (1);
11976 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
11977 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
11980 update_mode_lines
= 0;
11981 windows_or_buffers_changed
= 0;
11982 cursor_type_changed
= 0;
11985 /* Start SIGIO interrupts coming again. Having them off during the
11986 code above makes it less likely one will discard output, but not
11987 impossible, since there might be stuff in the system buffer here.
11988 But it is much hairier to try to do anything about that. */
11989 if (interrupt_input
)
11993 /* If a frame has become visible which was not before, redisplay
11994 again, so that we display it. Expose events for such a frame
11995 (which it gets when becoming visible) don't call the parts of
11996 redisplay constructing glyphs, so simply exposing a frame won't
11997 display anything in this case. So, we have to display these
11998 frames here explicitly. */
12001 Lisp_Object tail
, frame
;
12004 FOR_EACH_FRAME (tail
, frame
)
12006 int this_is_visible
= 0;
12008 if (XFRAME (frame
)->visible
)
12009 this_is_visible
= 1;
12010 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12011 if (XFRAME (frame
)->visible
)
12012 this_is_visible
= 1;
12014 if (this_is_visible
)
12018 if (new_count
!= number_of_visible_frames
)
12019 windows_or_buffers_changed
++;
12022 /* Change frame size now if a change is pending. */
12023 do_pending_window_change (1);
12025 /* If we just did a pending size change, or have additional
12026 visible frames, redisplay again. */
12027 if (windows_or_buffers_changed
&& !pause
)
12030 /* Clear the face cache eventually. */
12031 if (consider_all_windows_p
)
12033 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12035 clear_face_cache (0);
12036 clear_face_cache_count
= 0;
12038 #ifdef HAVE_WINDOW_SYSTEM
12039 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12041 clear_image_caches (Qnil
);
12042 clear_image_cache_count
= 0;
12044 #endif /* HAVE_WINDOW_SYSTEM */
12048 unbind_to (count
, Qnil
);
12053 /* Redisplay, but leave alone any recent echo area message unless
12054 another message has been requested in its place.
12056 This is useful in situations where you need to redisplay but no
12057 user action has occurred, making it inappropriate for the message
12058 area to be cleared. See tracking_off and
12059 wait_reading_process_output for examples of these situations.
12061 FROM_WHERE is an integer saying from where this function was
12062 called. This is useful for debugging. */
12065 redisplay_preserve_echo_area (from_where
)
12068 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12070 if (!NILP (echo_area_buffer
[1]))
12072 /* We have a previously displayed message, but no current
12073 message. Redisplay the previous message. */
12074 display_last_displayed_message_p
= 1;
12075 redisplay_internal (1);
12076 display_last_displayed_message_p
= 0;
12079 redisplay_internal (1);
12081 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12082 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12083 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12087 /* Function registered with record_unwind_protect in
12088 redisplay_internal. Reset redisplaying_p to the value it had
12089 before redisplay_internal was called, and clear
12090 prevent_freeing_realized_faces_p. It also selects the previously
12091 selected frame, unless it has been deleted (by an X connection
12092 failure during redisplay, for example). */
12095 unwind_redisplay (val
)
12098 Lisp_Object old_redisplaying_p
, old_frame
;
12100 old_redisplaying_p
= XCAR (val
);
12101 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12102 old_frame
= XCDR (val
);
12103 if (! EQ (old_frame
, selected_frame
)
12104 && FRAME_LIVE_P (XFRAME (old_frame
)))
12105 select_frame_for_redisplay (old_frame
);
12110 /* Mark the display of window W as accurate or inaccurate. If
12111 ACCURATE_P is non-zero mark display of W as accurate. If
12112 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12113 redisplay_internal is called. */
12116 mark_window_display_accurate_1 (w
, accurate_p
)
12120 if (BUFFERP (w
->buffer
))
12122 struct buffer
*b
= XBUFFER (w
->buffer
);
12125 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12126 w
->last_overlay_modified
12127 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12129 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12133 b
->clip_changed
= 0;
12134 b
->prevent_redisplay_optimizations_p
= 0;
12136 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12137 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12138 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12139 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12141 w
->current_matrix
->buffer
= b
;
12142 w
->current_matrix
->begv
= BUF_BEGV (b
);
12143 w
->current_matrix
->zv
= BUF_ZV (b
);
12145 w
->last_cursor
= w
->cursor
;
12146 w
->last_cursor_off_p
= w
->cursor_off_p
;
12148 if (w
== XWINDOW (selected_window
))
12149 w
->last_point
= make_number (BUF_PT (b
));
12151 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12157 w
->window_end_valid
= w
->buffer
;
12158 w
->update_mode_line
= Qnil
;
12163 /* Mark the display of windows in the window tree rooted at WINDOW as
12164 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12165 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12166 be redisplayed the next time redisplay_internal is called. */
12169 mark_window_display_accurate (window
, accurate_p
)
12170 Lisp_Object window
;
12175 for (; !NILP (window
); window
= w
->next
)
12177 w
= XWINDOW (window
);
12178 mark_window_display_accurate_1 (w
, accurate_p
);
12180 if (!NILP (w
->vchild
))
12181 mark_window_display_accurate (w
->vchild
, accurate_p
);
12182 if (!NILP (w
->hchild
))
12183 mark_window_display_accurate (w
->hchild
, accurate_p
);
12188 update_overlay_arrows (1);
12192 /* Force a thorough redisplay the next time by setting
12193 last_arrow_position and last_arrow_string to t, which is
12194 unequal to any useful value of Voverlay_arrow_... */
12195 update_overlay_arrows (-1);
12200 /* Return value in display table DP (Lisp_Char_Table *) for character
12201 C. Since a display table doesn't have any parent, we don't have to
12202 follow parent. Do not call this function directly but use the
12203 macro DISP_CHAR_VECTOR. */
12206 disp_char_vector (dp
, c
)
12207 struct Lisp_Char_Table
*dp
;
12212 if (ASCII_CHAR_P (c
))
12215 if (SUB_CHAR_TABLE_P (val
))
12216 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12222 XSETCHAR_TABLE (table
, dp
);
12223 val
= char_table_ref (table
, c
);
12232 /***********************************************************************
12234 ***********************************************************************/
12236 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12239 redisplay_windows (window
)
12240 Lisp_Object window
;
12242 while (!NILP (window
))
12244 struct window
*w
= XWINDOW (window
);
12246 if (!NILP (w
->hchild
))
12247 redisplay_windows (w
->hchild
);
12248 else if (!NILP (w
->vchild
))
12249 redisplay_windows (w
->vchild
);
12250 else if (!NILP (w
->buffer
))
12252 displayed_buffer
= XBUFFER (w
->buffer
);
12253 /* Use list_of_error, not Qerror, so that
12254 we catch only errors and don't run the debugger. */
12255 internal_condition_case_1 (redisplay_window_0
, window
,
12257 redisplay_window_error
);
12265 redisplay_window_error ()
12267 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12272 redisplay_window_0 (window
)
12273 Lisp_Object window
;
12275 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12276 redisplay_window (window
, 0);
12281 redisplay_window_1 (window
)
12282 Lisp_Object window
;
12284 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12285 redisplay_window (window
, 1);
12290 /* Increment GLYPH until it reaches END or CONDITION fails while
12291 adding (GLYPH)->pixel_width to X. */
12293 #define SKIP_GLYPHS(glyph, end, x, condition) \
12296 (x) += (glyph)->pixel_width; \
12299 while ((glyph) < (end) && (condition))
12302 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12303 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12304 which positions recorded in ROW differ from current buffer
12307 Return 0 if cursor is not on this row, 1 otherwise. */
12310 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12312 struct glyph_row
*row
;
12313 struct glyph_matrix
*matrix
;
12314 int delta
, delta_bytes
, dy
, dvpos
;
12316 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12317 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12318 struct glyph
*cursor
= NULL
;
12319 /* The first glyph that starts a sequence of glyphs from a string
12320 that is a value of a display property. */
12321 struct glyph
*string_start
;
12322 /* The X coordinate of string_start. */
12323 int string_start_x
;
12324 /* The last known character position in row. */
12325 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12326 /* The last known character position before string_start. */
12327 int string_before_pos
;
12330 /* Last buffer position covered by an overlay. */
12331 int cursor_from_overlay_pos
= 0;
12332 int pt_old
= PT
- delta
;
12334 /* Skip over glyphs not having an object at the start of the row.
12335 These are special glyphs like truncation marks on terminal
12337 if (row
->displays_text_p
)
12339 && INTEGERP (glyph
->object
)
12340 && glyph
->charpos
< 0)
12342 x
+= glyph
->pixel_width
;
12346 string_start
= NULL
;
12348 && !INTEGERP (glyph
->object
)
12349 && (!BUFFERP (glyph
->object
)
12350 || (last_pos
= glyph
->charpos
) < pt_old
12351 || glyph
->avoid_cursor_p
))
12353 if (! STRINGP (glyph
->object
))
12355 string_start
= NULL
;
12356 x
+= glyph
->pixel_width
;
12358 /* If we are beyond the cursor position computed from the
12359 last overlay seen, that overlay is not in effect for
12360 current cursor position. Reset the cursor information
12361 computed from that overlay. */
12362 if (cursor_from_overlay_pos
12363 && last_pos
>= cursor_from_overlay_pos
)
12365 cursor_from_overlay_pos
= 0;
12371 if (string_start
== NULL
)
12373 string_before_pos
= last_pos
;
12374 string_start
= glyph
;
12375 string_start_x
= x
;
12377 /* Skip all glyphs from a string. */
12382 if ((cursor
== NULL
|| glyph
> cursor
)
12383 && (cprop
= Fget_char_property (make_number ((glyph
)->charpos
),
12384 Qcursor
, (glyph
)->object
),
12386 && (pos
= string_buffer_position (w
, glyph
->object
,
12387 string_before_pos
),
12388 (pos
== 0 /* from overlay */
12389 || pos
== pt_old
)))
12391 /* Compute the first buffer position after the overlay.
12392 If the `cursor' property tells us how many positions
12393 are associated with the overlay, use that. Otherwise,
12394 estimate from the buffer positions of the glyphs
12395 before and after the overlay. */
12396 cursor_from_overlay_pos
= (pos
? 0 : last_pos
12397 + (INTEGERP (cprop
) ? XINT (cprop
) : 0));
12401 x
+= glyph
->pixel_width
;
12404 while (glyph
< end
&& EQ (glyph
->object
, string_start
->object
));
12408 if (cursor
!= NULL
)
12413 else if (row
->ends_in_ellipsis_p
&& glyph
== end
)
12415 /* Scan back over the ellipsis glyphs, decrementing positions. */
12416 while (glyph
> row
->glyphs
[TEXT_AREA
]
12417 && (glyph
- 1)->charpos
== last_pos
)
12418 glyph
--, x
-= glyph
->pixel_width
;
12419 /* That loop always goes one position too far, including the
12420 glyph before the ellipsis. So scan forward over that one. */
12421 x
+= glyph
->pixel_width
;
12424 else if (string_start
12425 && (glyph
== end
|| !BUFFERP (glyph
->object
) || last_pos
> pt_old
))
12427 /* We may have skipped over point because the previous glyphs
12428 are from string. As there's no easy way to know the
12429 character position of the current glyph, find the correct
12430 glyph on point by scanning from string_start again. */
12432 Lisp_Object string
;
12433 struct glyph
*stop
= glyph
;
12436 limit
= make_number (pt_old
+ 1);
12437 glyph
= string_start
;
12438 x
= string_start_x
;
12439 string
= glyph
->object
;
12440 pos
= string_buffer_position (w
, string
, string_before_pos
);
12441 /* If POS == 0, STRING is from overlay. We skip such glyphs
12442 because we always put the cursor after overlay strings. */
12443 while (pos
== 0 && glyph
< stop
)
12445 string
= glyph
->object
;
12446 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12448 pos
= string_buffer_position (w
, glyph
->object
, string_before_pos
);
12451 while (glyph
< stop
)
12453 pos
= XINT (Fnext_single_char_property_change
12454 (make_number (pos
), Qdisplay
, Qnil
, limit
));
12457 /* Skip glyphs from the same string. */
12458 string
= glyph
->object
;
12459 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12460 /* Skip glyphs from an overlay. */
12461 while (glyph
< stop
12462 && ! string_buffer_position (w
, glyph
->object
, pos
))
12464 string
= glyph
->object
;
12465 SKIP_GLYPHS (glyph
, stop
, x
, EQ (glyph
->object
, string
));
12469 /* If we reached the end of the line, and END was from a string,
12470 the cursor is not on this line. */
12471 if (glyph
== end
&& row
->continued_p
)
12475 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12477 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12478 w
->cursor
.y
= row
->y
+ dy
;
12480 if (w
== XWINDOW (selected_window
))
12482 if (!row
->continued_p
12483 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12486 this_line_buffer
= XBUFFER (w
->buffer
);
12488 CHARPOS (this_line_start_pos
)
12489 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12490 BYTEPOS (this_line_start_pos
)
12491 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12493 CHARPOS (this_line_end_pos
)
12494 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12495 BYTEPOS (this_line_end_pos
)
12496 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12498 this_line_y
= w
->cursor
.y
;
12499 this_line_pixel_height
= row
->height
;
12500 this_line_vpos
= w
->cursor
.vpos
;
12501 this_line_start_x
= row
->x
;
12504 CHARPOS (this_line_start_pos
) = 0;
12511 /* Run window scroll functions, if any, for WINDOW with new window
12512 start STARTP. Sets the window start of WINDOW to that position.
12514 We assume that the window's buffer is really current. */
12516 static INLINE
struct text_pos
12517 run_window_scroll_functions (window
, startp
)
12518 Lisp_Object window
;
12519 struct text_pos startp
;
12521 struct window
*w
= XWINDOW (window
);
12522 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12524 if (current_buffer
!= XBUFFER (w
->buffer
))
12527 if (!NILP (Vwindow_scroll_functions
))
12529 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
12530 make_number (CHARPOS (startp
)));
12531 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12532 /* In case the hook functions switch buffers. */
12533 if (current_buffer
!= XBUFFER (w
->buffer
))
12534 set_buffer_internal_1 (XBUFFER (w
->buffer
));
12541 /* Make sure the line containing the cursor is fully visible.
12542 A value of 1 means there is nothing to be done.
12543 (Either the line is fully visible, or it cannot be made so,
12544 or we cannot tell.)
12546 If FORCE_P is non-zero, return 0 even if partial visible cursor row
12547 is higher than window.
12549 A value of 0 means the caller should do scrolling
12550 as if point had gone off the screen. */
12553 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
12556 int current_matrix_p
;
12558 struct glyph_matrix
*matrix
;
12559 struct glyph_row
*row
;
12562 if (!make_cursor_line_fully_visible_p
)
12565 /* It's not always possible to find the cursor, e.g, when a window
12566 is full of overlay strings. Don't do anything in that case. */
12567 if (w
->cursor
.vpos
< 0)
12570 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
12571 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
12573 /* If the cursor row is not partially visible, there's nothing to do. */
12574 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
12577 /* If the row the cursor is in is taller than the window's height,
12578 it's not clear what to do, so do nothing. */
12579 window_height
= window_box_height (w
);
12580 if (row
->height
>= window_height
)
12582 if (!force_p
|| MINI_WINDOW_P (w
)
12583 || w
->vscroll
|| w
->cursor
.vpos
== 0)
12590 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
12591 non-zero means only WINDOW is redisplayed in redisplay_internal.
12592 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
12593 in redisplay_window to bring a partially visible line into view in
12594 the case that only the cursor has moved.
12596 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
12597 last screen line's vertical height extends past the end of the screen.
12601 1 if scrolling succeeded
12603 0 if scrolling didn't find point.
12605 -1 if new fonts have been loaded so that we must interrupt
12606 redisplay, adjust glyph matrices, and try again. */
12612 SCROLLING_NEED_LARGER_MATRICES
12616 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
12617 scroll_step
, temp_scroll_step
, last_line_misfit
)
12618 Lisp_Object window
;
12619 int just_this_one_p
;
12620 EMACS_INT scroll_conservatively
, scroll_step
;
12621 int temp_scroll_step
;
12622 int last_line_misfit
;
12624 struct window
*w
= XWINDOW (window
);
12625 struct frame
*f
= XFRAME (w
->frame
);
12626 struct text_pos pos
, startp
;
12628 int this_scroll_margin
, scroll_max
, rc
, height
;
12629 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
12630 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
12631 Lisp_Object aggressive
;
12632 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
12635 debug_method_add (w
, "try_scrolling");
12638 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
12640 /* Compute scroll margin height in pixels. We scroll when point is
12641 within this distance from the top or bottom of the window. */
12642 if (scroll_margin
> 0)
12643 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
12644 * FRAME_LINE_HEIGHT (f
);
12646 this_scroll_margin
= 0;
12648 /* Force scroll_conservatively to have a reasonable value, to avoid
12649 overflow while computing how much to scroll. Note that the user
12650 can supply scroll-conservatively equal to `most-positive-fixnum',
12651 which can be larger than INT_MAX. */
12652 if (scroll_conservatively
> scroll_limit
)
12654 scroll_conservatively
= scroll_limit
;
12655 scroll_max
= INT_MAX
;
12657 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
12658 /* Compute how much we should try to scroll maximally to bring
12659 point into view. */
12660 scroll_max
= (max (scroll_step
,
12661 max (scroll_conservatively
, temp_scroll_step
))
12662 * FRAME_LINE_HEIGHT (f
));
12663 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
12664 || NUMBERP (current_buffer
->scroll_up_aggressively
))
12665 /* We're trying to scroll because of aggressive scrolling but no
12666 scroll_step is set. Choose an arbitrary one. */
12667 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
12673 /* Decide whether to scroll down. */
12674 if (PT
> CHARPOS (startp
))
12676 int scroll_margin_y
;
12678 /* Compute the pixel ypos of the scroll margin, then move it to
12679 either that ypos or PT, whichever comes first. */
12680 start_display (&it
, w
, startp
);
12681 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
12682 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
12683 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
12684 (MOVE_TO_POS
| MOVE_TO_Y
));
12686 if (PT
> CHARPOS (it
.current
.pos
))
12688 int y0
= line_bottom_y (&it
);
12690 /* Compute the distance from the scroll margin to PT
12691 (including the height of the cursor line). Moving the
12692 iterator unconditionally to PT can be slow if PT is far
12693 away, so stop 10 lines past the window bottom (is there a
12694 way to do the right thing quickly?). */
12695 move_it_to (&it
, PT
, -1,
12696 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
12697 -1, MOVE_TO_POS
| MOVE_TO_Y
);
12698 dy
= line_bottom_y (&it
) - y0
;
12700 if (dy
> scroll_max
)
12701 return SCROLLING_FAILED
;
12709 /* Point is in or below the bottom scroll margin, so move the
12710 window start down. If scrolling conservatively, move it just
12711 enough down to make point visible. If scroll_step is set,
12712 move it down by scroll_step. */
12713 if (scroll_conservatively
)
12715 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
12716 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
12717 else if (scroll_step
|| temp_scroll_step
)
12718 amount_to_scroll
= scroll_max
;
12721 aggressive
= current_buffer
->scroll_up_aggressively
;
12722 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12723 if (NUMBERP (aggressive
))
12725 double float_amount
= XFLOATINT (aggressive
) * height
;
12726 amount_to_scroll
= float_amount
;
12727 if (amount_to_scroll
== 0 && float_amount
> 0)
12728 amount_to_scroll
= 1;
12732 if (amount_to_scroll
<= 0)
12733 return SCROLLING_FAILED
;
12735 start_display (&it
, w
, startp
);
12736 move_it_vertically (&it
, amount_to_scroll
);
12738 /* If STARTP is unchanged, move it down another screen line. */
12739 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
12740 move_it_by_lines (&it
, 1, 1);
12741 startp
= it
.current
.pos
;
12745 struct text_pos scroll_margin_pos
= startp
;
12747 /* See if point is inside the scroll margin at the top of the
12749 if (this_scroll_margin
)
12751 start_display (&it
, w
, startp
);
12752 move_it_vertically (&it
, this_scroll_margin
);
12753 scroll_margin_pos
= it
.current
.pos
;
12756 if (PT
< CHARPOS (scroll_margin_pos
))
12758 /* Point is in the scroll margin at the top of the window or
12759 above what is displayed in the window. */
12762 /* Compute the vertical distance from PT to the scroll
12763 margin position. Give up if distance is greater than
12765 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
12766 start_display (&it
, w
, pos
);
12768 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
12769 it
.last_visible_y
, -1,
12770 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
12771 dy
= it
.current_y
- y0
;
12772 if (dy
> scroll_max
)
12773 return SCROLLING_FAILED
;
12775 /* Compute new window start. */
12776 start_display (&it
, w
, startp
);
12778 if (scroll_conservatively
)
12780 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
12781 else if (scroll_step
|| temp_scroll_step
)
12782 amount_to_scroll
= scroll_max
;
12785 aggressive
= current_buffer
->scroll_down_aggressively
;
12786 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
12787 if (NUMBERP (aggressive
))
12789 double float_amount
= XFLOATINT (aggressive
) * height
;
12790 amount_to_scroll
= float_amount
;
12791 if (amount_to_scroll
== 0 && float_amount
> 0)
12792 amount_to_scroll
= 1;
12796 if (amount_to_scroll
<= 0)
12797 return SCROLLING_FAILED
;
12799 move_it_vertically_backward (&it
, amount_to_scroll
);
12800 startp
= it
.current
.pos
;
12804 /* Run window scroll functions. */
12805 startp
= run_window_scroll_functions (window
, startp
);
12807 /* Display the window. Give up if new fonts are loaded, or if point
12809 if (!try_window (window
, startp
, 0))
12810 rc
= SCROLLING_NEED_LARGER_MATRICES
;
12811 else if (w
->cursor
.vpos
< 0)
12813 clear_glyph_matrix (w
->desired_matrix
);
12814 rc
= SCROLLING_FAILED
;
12818 /* Maybe forget recorded base line for line number display. */
12819 if (!just_this_one_p
12820 || current_buffer
->clip_changed
12821 || BEG_UNCHANGED
< CHARPOS (startp
))
12822 w
->base_line_number
= Qnil
;
12824 /* If cursor ends up on a partially visible line,
12825 treat that as being off the bottom of the screen. */
12826 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
12828 clear_glyph_matrix (w
->desired_matrix
);
12829 ++extra_scroll_margin_lines
;
12832 rc
= SCROLLING_SUCCESS
;
12839 /* Compute a suitable window start for window W if display of W starts
12840 on a continuation line. Value is non-zero if a new window start
12843 The new window start will be computed, based on W's width, starting
12844 from the start of the continued line. It is the start of the
12845 screen line with the minimum distance from the old start W->start. */
12848 compute_window_start_on_continuation_line (w
)
12851 struct text_pos pos
, start_pos
;
12852 int window_start_changed_p
= 0;
12854 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
12856 /* If window start is on a continuation line... Window start may be
12857 < BEGV in case there's invisible text at the start of the
12858 buffer (M-x rmail, for example). */
12859 if (CHARPOS (start_pos
) > BEGV
12860 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
12863 struct glyph_row
*row
;
12865 /* Handle the case that the window start is out of range. */
12866 if (CHARPOS (start_pos
) < BEGV
)
12867 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
12868 else if (CHARPOS (start_pos
) > ZV
)
12869 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
12871 /* Find the start of the continued line. This should be fast
12872 because scan_buffer is fast (newline cache). */
12873 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
12874 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
12875 row
, DEFAULT_FACE_ID
);
12876 reseat_at_previous_visible_line_start (&it
);
12878 /* If the line start is "too far" away from the window start,
12879 say it takes too much time to compute a new window start. */
12880 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
12881 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
12883 int min_distance
, distance
;
12885 /* Move forward by display lines to find the new window
12886 start. If window width was enlarged, the new start can
12887 be expected to be > the old start. If window width was
12888 decreased, the new window start will be < the old start.
12889 So, we're looking for the display line start with the
12890 minimum distance from the old window start. */
12891 pos
= it
.current
.pos
;
12892 min_distance
= INFINITY
;
12893 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
12894 distance
< min_distance
)
12896 min_distance
= distance
;
12897 pos
= it
.current
.pos
;
12898 move_it_by_lines (&it
, 1, 0);
12901 /* Set the window start there. */
12902 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
12903 window_start_changed_p
= 1;
12907 return window_start_changed_p
;
12911 /* Try cursor movement in case text has not changed in window WINDOW,
12912 with window start STARTP. Value is
12914 CURSOR_MOVEMENT_SUCCESS if successful
12916 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
12918 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
12919 display. *SCROLL_STEP is set to 1, under certain circumstances, if
12920 we want to scroll as if scroll-step were set to 1. See the code.
12922 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
12923 which case we have to abort this redisplay, and adjust matrices
12928 CURSOR_MOVEMENT_SUCCESS
,
12929 CURSOR_MOVEMENT_CANNOT_BE_USED
,
12930 CURSOR_MOVEMENT_MUST_SCROLL
,
12931 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
12935 try_cursor_movement (window
, startp
, scroll_step
)
12936 Lisp_Object window
;
12937 struct text_pos startp
;
12940 struct window
*w
= XWINDOW (window
);
12941 struct frame
*f
= XFRAME (w
->frame
);
12942 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
12945 if (inhibit_try_cursor_movement
)
12949 /* Handle case where text has not changed, only point, and it has
12950 not moved off the frame. */
12951 if (/* Point may be in this window. */
12952 PT
>= CHARPOS (startp
)
12953 /* Selective display hasn't changed. */
12954 && !current_buffer
->clip_changed
12955 /* Function force-mode-line-update is used to force a thorough
12956 redisplay. It sets either windows_or_buffers_changed or
12957 update_mode_lines. So don't take a shortcut here for these
12959 && !update_mode_lines
12960 && !windows_or_buffers_changed
12961 && !cursor_type_changed
12962 /* Can't use this case if highlighting a region. When a
12963 region exists, cursor movement has to do more than just
12965 && !(!NILP (Vtransient_mark_mode
)
12966 && !NILP (current_buffer
->mark_active
))
12967 && NILP (w
->region_showing
)
12968 && NILP (Vshow_trailing_whitespace
)
12969 /* Right after splitting windows, last_point may be nil. */
12970 && INTEGERP (w
->last_point
)
12971 /* This code is not used for mini-buffer for the sake of the case
12972 of redisplaying to replace an echo area message; since in
12973 that case the mini-buffer contents per se are usually
12974 unchanged. This code is of no real use in the mini-buffer
12975 since the handling of this_line_start_pos, etc., in redisplay
12976 handles the same cases. */
12977 && !EQ (window
, minibuf_window
)
12978 /* When splitting windows or for new windows, it happens that
12979 redisplay is called with a nil window_end_vpos or one being
12980 larger than the window. This should really be fixed in
12981 window.c. I don't have this on my list, now, so we do
12982 approximately the same as the old redisplay code. --gerd. */
12983 && INTEGERP (w
->window_end_vpos
)
12984 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
12985 && (FRAME_WINDOW_P (f
)
12986 || !overlay_arrow_in_current_buffer_p ()))
12988 int this_scroll_margin
, top_scroll_margin
;
12989 struct glyph_row
*row
= NULL
;
12992 debug_method_add (w
, "cursor movement");
12995 /* Scroll if point within this distance from the top or bottom
12996 of the window. This is a pixel value. */
12997 if (scroll_margin
> 0)
12999 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13000 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13003 this_scroll_margin
= 0;
13005 top_scroll_margin
= this_scroll_margin
;
13006 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13007 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13009 /* Start with the row the cursor was displayed during the last
13010 not paused redisplay. Give up if that row is not valid. */
13011 if (w
->last_cursor
.vpos
< 0
13012 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13013 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13016 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13017 if (row
->mode_line_p
)
13019 if (!row
->enabled_p
)
13020 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13023 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13026 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13028 if (PT
> XFASTINT (w
->last_point
))
13030 /* Point has moved forward. */
13031 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13032 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13034 xassert (row
->enabled_p
);
13038 /* The end position of a row equals the start position
13039 of the next row. If PT is there, we would rather
13040 display it in the next line. */
13041 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13042 && MATRIX_ROW_END_CHARPOS (row
) == PT
13043 && !cursor_row_p (w
, row
))
13046 /* If within the scroll margin, scroll. Note that
13047 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13048 the next line would be drawn, and that
13049 this_scroll_margin can be zero. */
13050 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13051 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13052 /* Line is completely visible last line in window
13053 and PT is to be set in the next line. */
13054 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13055 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13056 && !row
->ends_at_zv_p
13057 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13060 else if (PT
< XFASTINT (w
->last_point
))
13062 /* Cursor has to be moved backward. Note that PT >=
13063 CHARPOS (startp) because of the outer if-statement. */
13064 while (!row
->mode_line_p
13065 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13066 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13067 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13068 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13069 row
> w
->current_matrix
->rows
13070 && (row
-1)->ends_in_newline_from_string_p
))))
13071 && (row
->y
> top_scroll_margin
13072 || CHARPOS (startp
) == BEGV
))
13074 xassert (row
->enabled_p
);
13078 /* Consider the following case: Window starts at BEGV,
13079 there is invisible, intangible text at BEGV, so that
13080 display starts at some point START > BEGV. It can
13081 happen that we are called with PT somewhere between
13082 BEGV and START. Try to handle that case. */
13083 if (row
< w
->current_matrix
->rows
13084 || row
->mode_line_p
)
13086 row
= w
->current_matrix
->rows
;
13087 if (row
->mode_line_p
)
13091 /* Due to newlines in overlay strings, we may have to
13092 skip forward over overlay strings. */
13093 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13094 && MATRIX_ROW_END_CHARPOS (row
) == PT
13095 && !cursor_row_p (w
, row
))
13098 /* If within the scroll margin, scroll. */
13099 if (row
->y
< top_scroll_margin
13100 && CHARPOS (startp
) != BEGV
)
13105 /* Cursor did not move. So don't scroll even if cursor line
13106 is partially visible, as it was so before. */
13107 rc
= CURSOR_MOVEMENT_SUCCESS
;
13110 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13111 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13113 /* if PT is not in the glyph row, give up. */
13114 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13116 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13117 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13118 && make_cursor_line_fully_visible_p
)
13120 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13121 && !row
->ends_at_zv_p
13122 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13123 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13124 else if (row
->height
> window_box_height (w
))
13126 /* If we end up in a partially visible line, let's
13127 make it fully visible, except when it's taller
13128 than the window, in which case we can't do much
13131 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13135 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13136 if (!cursor_row_fully_visible_p (w
, 0, 1))
13137 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13139 rc
= CURSOR_MOVEMENT_SUCCESS
;
13143 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13148 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13150 rc
= CURSOR_MOVEMENT_SUCCESS
;
13155 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13156 && MATRIX_ROW_START_CHARPOS (row
) == PT
13157 && cursor_row_p (w
, row
));
13166 set_vertical_scroll_bar (w
)
13169 int start
, end
, whole
;
13171 /* Calculate the start and end positions for the current window.
13172 At some point, it would be nice to choose between scrollbars
13173 which reflect the whole buffer size, with special markers
13174 indicating narrowing, and scrollbars which reflect only the
13177 Note that mini-buffers sometimes aren't displaying any text. */
13178 if (!MINI_WINDOW_P (w
)
13179 || (w
== XWINDOW (minibuf_window
)
13180 && NILP (echo_area_buffer
[0])))
13182 struct buffer
*buf
= XBUFFER (w
->buffer
);
13183 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13184 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13185 /* I don't think this is guaranteed to be right. For the
13186 moment, we'll pretend it is. */
13187 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13191 if (whole
< (end
- start
))
13192 whole
= end
- start
;
13195 start
= end
= whole
= 0;
13197 /* Indicate what this scroll bar ought to be displaying now. */
13198 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13199 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13200 (w
, end
- start
, whole
, start
);
13204 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13205 selected_window is redisplayed.
13207 We can return without actually redisplaying the window if
13208 fonts_changed_p is nonzero. In that case, redisplay_internal will
13212 redisplay_window (window
, just_this_one_p
)
13213 Lisp_Object window
;
13214 int just_this_one_p
;
13216 struct window
*w
= XWINDOW (window
);
13217 struct frame
*f
= XFRAME (w
->frame
);
13218 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13219 struct buffer
*old
= current_buffer
;
13220 struct text_pos lpoint
, opoint
, startp
;
13221 int update_mode_line
;
13224 /* Record it now because it's overwritten. */
13225 int current_matrix_up_to_date_p
= 0;
13226 int used_current_matrix_p
= 0;
13227 /* This is less strict than current_matrix_up_to_date_p.
13228 It indictes that the buffer contents and narrowing are unchanged. */
13229 int buffer_unchanged_p
= 0;
13230 int temp_scroll_step
= 0;
13231 int count
= SPECPDL_INDEX ();
13233 int centering_position
= -1;
13234 int last_line_misfit
= 0;
13235 int beg_unchanged
, end_unchanged
;
13237 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13240 /* W must be a leaf window here. */
13241 xassert (!NILP (w
->buffer
));
13243 *w
->desired_matrix
->method
= 0;
13247 reconsider_clip_changes (w
, buffer
);
13249 /* Has the mode line to be updated? */
13250 update_mode_line
= (!NILP (w
->update_mode_line
)
13251 || update_mode_lines
13252 || buffer
->clip_changed
13253 || buffer
->prevent_redisplay_optimizations_p
);
13255 if (MINI_WINDOW_P (w
))
13257 if (w
== XWINDOW (echo_area_window
)
13258 && !NILP (echo_area_buffer
[0]))
13260 if (update_mode_line
)
13261 /* We may have to update a tty frame's menu bar or a
13262 tool-bar. Example `M-x C-h C-h C-g'. */
13263 goto finish_menu_bars
;
13265 /* We've already displayed the echo area glyphs in this window. */
13266 goto finish_scroll_bars
;
13268 else if ((w
!= XWINDOW (minibuf_window
)
13269 || minibuf_level
== 0)
13270 /* When buffer is nonempty, redisplay window normally. */
13271 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13272 /* Quail displays non-mini buffers in minibuffer window.
13273 In that case, redisplay the window normally. */
13274 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13276 /* W is a mini-buffer window, but it's not active, so clear
13278 int yb
= window_text_bottom_y (w
);
13279 struct glyph_row
*row
;
13282 for (y
= 0, row
= w
->desired_matrix
->rows
;
13284 y
+= row
->height
, ++row
)
13285 blank_row (w
, row
, y
);
13286 goto finish_scroll_bars
;
13289 clear_glyph_matrix (w
->desired_matrix
);
13292 /* Otherwise set up data on this window; select its buffer and point
13294 /* Really select the buffer, for the sake of buffer-local
13296 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13298 current_matrix_up_to_date_p
13299 = (!NILP (w
->window_end_valid
)
13300 && !current_buffer
->clip_changed
13301 && !current_buffer
->prevent_redisplay_optimizations_p
13302 && XFASTINT (w
->last_modified
) >= MODIFF
13303 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13305 /* Run the window-bottom-change-functions
13306 if it is possible that the text on the screen has changed
13307 (either due to modification of the text, or any other reason). */
13308 if (!current_matrix_up_to_date_p
13309 && !NILP (Vwindow_text_change_functions
))
13311 safe_run_hooks (Qwindow_text_change_functions
);
13315 beg_unchanged
= BEG_UNCHANGED
;
13316 end_unchanged
= END_UNCHANGED
;
13318 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13320 specbind (Qinhibit_point_motion_hooks
, Qt
);
13323 = (!NILP (w
->window_end_valid
)
13324 && !current_buffer
->clip_changed
13325 && XFASTINT (w
->last_modified
) >= MODIFF
13326 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13328 /* When windows_or_buffers_changed is non-zero, we can't rely on
13329 the window end being valid, so set it to nil there. */
13330 if (windows_or_buffers_changed
)
13332 /* If window starts on a continuation line, maybe adjust the
13333 window start in case the window's width changed. */
13334 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13335 compute_window_start_on_continuation_line (w
);
13337 w
->window_end_valid
= Qnil
;
13340 /* Some sanity checks. */
13341 CHECK_WINDOW_END (w
);
13342 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13344 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13347 /* If %c is in mode line, update it if needed. */
13348 if (!NILP (w
->column_number_displayed
)
13349 /* This alternative quickly identifies a common case
13350 where no change is needed. */
13351 && !(PT
== XFASTINT (w
->last_point
)
13352 && XFASTINT (w
->last_modified
) >= MODIFF
13353 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13354 && (XFASTINT (w
->column_number_displayed
)
13355 != (int) current_column ())) /* iftc */
13356 update_mode_line
= 1;
13358 /* Count number of windows showing the selected buffer. An indirect
13359 buffer counts as its base buffer. */
13360 if (!just_this_one_p
)
13362 struct buffer
*current_base
, *window_base
;
13363 current_base
= current_buffer
;
13364 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13365 if (current_base
->base_buffer
)
13366 current_base
= current_base
->base_buffer
;
13367 if (window_base
->base_buffer
)
13368 window_base
= window_base
->base_buffer
;
13369 if (current_base
== window_base
)
13373 /* Point refers normally to the selected window. For any other
13374 window, set up appropriate value. */
13375 if (!EQ (window
, selected_window
))
13377 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13378 int new_pt_byte
= marker_byte_position (w
->pointm
);
13382 new_pt_byte
= BEGV_BYTE
;
13383 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13385 else if (new_pt
> (ZV
- 1))
13388 new_pt_byte
= ZV_BYTE
;
13389 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13392 /* We don't use SET_PT so that the point-motion hooks don't run. */
13393 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13396 /* If any of the character widths specified in the display table
13397 have changed, invalidate the width run cache. It's true that
13398 this may be a bit late to catch such changes, but the rest of
13399 redisplay goes (non-fatally) haywire when the display table is
13400 changed, so why should we worry about doing any better? */
13401 if (current_buffer
->width_run_cache
)
13403 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13405 if (! disptab_matches_widthtab (disptab
,
13406 XVECTOR (current_buffer
->width_table
)))
13408 invalidate_region_cache (current_buffer
,
13409 current_buffer
->width_run_cache
,
13411 recompute_width_table (current_buffer
, disptab
);
13415 /* If window-start is screwed up, choose a new one. */
13416 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13419 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13421 /* If someone specified a new starting point but did not insist,
13422 check whether it can be used. */
13423 if (!NILP (w
->optional_new_start
)
13424 && CHARPOS (startp
) >= BEGV
13425 && CHARPOS (startp
) <= ZV
)
13427 w
->optional_new_start
= Qnil
;
13428 start_display (&it
, w
, startp
);
13429 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13430 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13431 if (IT_CHARPOS (it
) == PT
)
13432 w
->force_start
= Qt
;
13433 /* IT may overshoot PT if text at PT is invisible. */
13434 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13435 w
->force_start
= Qt
;
13440 /* Handle case where place to start displaying has been specified,
13441 unless the specified location is outside the accessible range. */
13442 if (!NILP (w
->force_start
)
13443 || w
->frozen_window_start_p
)
13445 /* We set this later on if we have to adjust point. */
13448 w
->force_start
= Qnil
;
13450 w
->window_end_valid
= Qnil
;
13452 /* Forget any recorded base line for line number display. */
13453 if (!buffer_unchanged_p
)
13454 w
->base_line_number
= Qnil
;
13456 /* Redisplay the mode line. Select the buffer properly for that.
13457 Also, run the hook window-scroll-functions
13458 because we have scrolled. */
13459 /* Note, we do this after clearing force_start because
13460 if there's an error, it is better to forget about force_start
13461 than to get into an infinite loop calling the hook functions
13462 and having them get more errors. */
13463 if (!update_mode_line
13464 || ! NILP (Vwindow_scroll_functions
))
13466 update_mode_line
= 1;
13467 w
->update_mode_line
= Qt
;
13468 startp
= run_window_scroll_functions (window
, startp
);
13471 w
->last_modified
= make_number (0);
13472 w
->last_overlay_modified
= make_number (0);
13473 if (CHARPOS (startp
) < BEGV
)
13474 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
13475 else if (CHARPOS (startp
) > ZV
)
13476 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
13478 /* Redisplay, then check if cursor has been set during the
13479 redisplay. Give up if new fonts were loaded. */
13480 /* We used to issue a CHECK_MARGINS argument to try_window here,
13481 but this causes scrolling to fail when point begins inside
13482 the scroll margin (bug#148) -- cyd */
13483 if (!try_window (window
, startp
, 0))
13485 w
->force_start
= Qt
;
13486 clear_glyph_matrix (w
->desired_matrix
);
13487 goto need_larger_matrices
;
13490 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
13492 /* If point does not appear, try to move point so it does
13493 appear. The desired matrix has been built above, so we
13494 can use it here. */
13495 new_vpos
= window_box_height (w
) / 2;
13498 if (!cursor_row_fully_visible_p (w
, 0, 0))
13500 /* Point does appear, but on a line partly visible at end of window.
13501 Move it back to a fully-visible line. */
13502 new_vpos
= window_box_height (w
);
13505 /* If we need to move point for either of the above reasons,
13506 now actually do it. */
13509 struct glyph_row
*row
;
13511 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
13512 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
13515 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
13516 MATRIX_ROW_START_BYTEPOS (row
));
13518 if (w
!= XWINDOW (selected_window
))
13519 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
13520 else if (current_buffer
== old
)
13521 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13523 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
13525 /* If we are highlighting the region, then we just changed
13526 the region, so redisplay to show it. */
13527 if (!NILP (Vtransient_mark_mode
)
13528 && !NILP (current_buffer
->mark_active
))
13530 clear_glyph_matrix (w
->desired_matrix
);
13531 if (!try_window (window
, startp
, 0))
13532 goto need_larger_matrices
;
13537 debug_method_add (w
, "forced window start");
13542 /* Handle case where text has not changed, only point, and it has
13543 not moved off the frame, and we are not retrying after hscroll.
13544 (current_matrix_up_to_date_p is nonzero when retrying.) */
13545 if (current_matrix_up_to_date_p
13546 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
13547 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
13551 case CURSOR_MOVEMENT_SUCCESS
:
13552 used_current_matrix_p
= 1;
13555 case CURSOR_MOVEMENT_MUST_SCROLL
:
13556 goto try_to_scroll
;
13562 /* If current starting point was originally the beginning of a line
13563 but no longer is, find a new starting point. */
13564 else if (!NILP (w
->start_at_line_beg
)
13565 && !(CHARPOS (startp
) <= BEGV
13566 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
13569 debug_method_add (w
, "recenter 1");
13574 /* Try scrolling with try_window_id. Value is > 0 if update has
13575 been done, it is -1 if we know that the same window start will
13576 not work. It is 0 if unsuccessful for some other reason. */
13577 else if ((tem
= try_window_id (w
)) != 0)
13580 debug_method_add (w
, "try_window_id %d", tem
);
13583 if (fonts_changed_p
)
13584 goto need_larger_matrices
;
13588 /* Otherwise try_window_id has returned -1 which means that we
13589 don't want the alternative below this comment to execute. */
13591 else if (CHARPOS (startp
) >= BEGV
13592 && CHARPOS (startp
) <= ZV
13593 && PT
>= CHARPOS (startp
)
13594 && (CHARPOS (startp
) < ZV
13595 /* Avoid starting at end of buffer. */
13596 || CHARPOS (startp
) == BEGV
13597 || (XFASTINT (w
->last_modified
) >= MODIFF
13598 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
13601 /* If first window line is a continuation line, and window start
13602 is inside the modified region, but the first change is before
13603 current window start, we must select a new window start.
13605 However, if this is the result of a down-mouse event (e.g. by
13606 extending the mouse-drag-overlay), we don't want to select a
13607 new window start, since that would change the position under
13608 the mouse, resulting in an unwanted mouse-movement rather
13609 than a simple mouse-click. */
13610 if (NILP (w
->start_at_line_beg
)
13611 && NILP (do_mouse_tracking
)
13612 && CHARPOS (startp
) > BEGV
13613 && CHARPOS (startp
) > BEG
+ beg_unchanged
13614 && CHARPOS (startp
) <= Z
- end_unchanged
13615 /* Even if w->start_at_line_beg is nil, a new window may
13616 start at a line_beg, since that's how set_buffer_window
13617 sets it. So, we need to check the return value of
13618 compute_window_start_on_continuation_line. (See also
13620 && XMARKER (w
->start
)->buffer
== current_buffer
13621 && compute_window_start_on_continuation_line (w
))
13623 w
->force_start
= Qt
;
13624 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13629 debug_method_add (w
, "same window start");
13632 /* Try to redisplay starting at same place as before.
13633 If point has not moved off frame, accept the results. */
13634 if (!current_matrix_up_to_date_p
13635 /* Don't use try_window_reusing_current_matrix in this case
13636 because a window scroll function can have changed the
13638 || !NILP (Vwindow_scroll_functions
)
13639 || MINI_WINDOW_P (w
)
13640 || !(used_current_matrix_p
13641 = try_window_reusing_current_matrix (w
)))
13643 IF_DEBUG (debug_method_add (w
, "1"));
13644 if (try_window (window
, startp
, 1) < 0)
13645 /* -1 means we need to scroll.
13646 0 means we need new matrices, but fonts_changed_p
13647 is set in that case, so we will detect it below. */
13648 goto try_to_scroll
;
13651 if (fonts_changed_p
)
13652 goto need_larger_matrices
;
13654 if (w
->cursor
.vpos
>= 0)
13656 if (!just_this_one_p
13657 || current_buffer
->clip_changed
13658 || BEG_UNCHANGED
< CHARPOS (startp
))
13659 /* Forget any recorded base line for line number display. */
13660 w
->base_line_number
= Qnil
;
13662 if (!cursor_row_fully_visible_p (w
, 1, 0))
13664 clear_glyph_matrix (w
->desired_matrix
);
13665 last_line_misfit
= 1;
13667 /* Drop through and scroll. */
13672 clear_glyph_matrix (w
->desired_matrix
);
13677 w
->last_modified
= make_number (0);
13678 w
->last_overlay_modified
= make_number (0);
13680 /* Redisplay the mode line. Select the buffer properly for that. */
13681 if (!update_mode_line
)
13683 update_mode_line
= 1;
13684 w
->update_mode_line
= Qt
;
13687 /* Try to scroll by specified few lines. */
13688 if ((scroll_conservatively
13690 || temp_scroll_step
13691 || NUMBERP (current_buffer
->scroll_up_aggressively
)
13692 || NUMBERP (current_buffer
->scroll_down_aggressively
))
13693 && !current_buffer
->clip_changed
13694 && CHARPOS (startp
) >= BEGV
13695 && CHARPOS (startp
) <= ZV
)
13697 /* The function returns -1 if new fonts were loaded, 1 if
13698 successful, 0 if not successful. */
13699 int rc
= try_scrolling (window
, just_this_one_p
,
13700 scroll_conservatively
,
13702 temp_scroll_step
, last_line_misfit
);
13705 case SCROLLING_SUCCESS
:
13708 case SCROLLING_NEED_LARGER_MATRICES
:
13709 goto need_larger_matrices
;
13711 case SCROLLING_FAILED
:
13719 /* Finally, just choose place to start which centers point */
13722 if (centering_position
< 0)
13723 centering_position
= window_box_height (w
) / 2;
13726 debug_method_add (w
, "recenter");
13729 /* w->vscroll = 0; */
13731 /* Forget any previously recorded base line for line number display. */
13732 if (!buffer_unchanged_p
)
13733 w
->base_line_number
= Qnil
;
13735 /* Move backward half the height of the window. */
13736 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13737 it
.current_y
= it
.last_visible_y
;
13738 move_it_vertically_backward (&it
, centering_position
);
13739 xassert (IT_CHARPOS (it
) >= BEGV
);
13741 /* The function move_it_vertically_backward may move over more
13742 than the specified y-distance. If it->w is small, e.g. a
13743 mini-buffer window, we may end up in front of the window's
13744 display area. Start displaying at the start of the line
13745 containing PT in this case. */
13746 if (it
.current_y
<= 0)
13748 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
13749 move_it_vertically_backward (&it
, 0);
13753 it
.current_x
= it
.hpos
= 0;
13755 /* Set startp here explicitly in case that helps avoid an infinite loop
13756 in case the window-scroll-functions functions get errors. */
13757 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
13759 /* Run scroll hooks. */
13760 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
13762 /* Redisplay the window. */
13763 if (!current_matrix_up_to_date_p
13764 || windows_or_buffers_changed
13765 || cursor_type_changed
13766 /* Don't use try_window_reusing_current_matrix in this case
13767 because it can have changed the buffer. */
13768 || !NILP (Vwindow_scroll_functions
)
13769 || !just_this_one_p
13770 || MINI_WINDOW_P (w
)
13771 || !(used_current_matrix_p
13772 = try_window_reusing_current_matrix (w
)))
13773 try_window (window
, startp
, 0);
13775 /* If new fonts have been loaded (due to fontsets), give up. We
13776 have to start a new redisplay since we need to re-adjust glyph
13778 if (fonts_changed_p
)
13779 goto need_larger_matrices
;
13781 /* If cursor did not appear assume that the middle of the window is
13782 in the first line of the window. Do it again with the next line.
13783 (Imagine a window of height 100, displaying two lines of height
13784 60. Moving back 50 from it->last_visible_y will end in the first
13786 if (w
->cursor
.vpos
< 0)
13788 if (!NILP (w
->window_end_valid
)
13789 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
13791 clear_glyph_matrix (w
->desired_matrix
);
13792 move_it_by_lines (&it
, 1, 0);
13793 try_window (window
, it
.current
.pos
, 0);
13795 else if (PT
< IT_CHARPOS (it
))
13797 clear_glyph_matrix (w
->desired_matrix
);
13798 move_it_by_lines (&it
, -1, 0);
13799 try_window (window
, it
.current
.pos
, 0);
13803 /* Not much we can do about it. */
13807 /* Consider the following case: Window starts at BEGV, there is
13808 invisible, intangible text at BEGV, so that display starts at
13809 some point START > BEGV. It can happen that we are called with
13810 PT somewhere between BEGV and START. Try to handle that case. */
13811 if (w
->cursor
.vpos
< 0)
13813 struct glyph_row
*row
= w
->current_matrix
->rows
;
13814 if (row
->mode_line_p
)
13816 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13819 if (!cursor_row_fully_visible_p (w
, 0, 0))
13821 /* If vscroll is enabled, disable it and try again. */
13825 clear_glyph_matrix (w
->desired_matrix
);
13829 /* If centering point failed to make the whole line visible,
13830 put point at the top instead. That has to make the whole line
13831 visible, if it can be done. */
13832 if (centering_position
== 0)
13835 clear_glyph_matrix (w
->desired_matrix
);
13836 centering_position
= 0;
13842 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13843 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
13844 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
13847 /* Display the mode line, if we must. */
13848 if ((update_mode_line
13849 /* If window not full width, must redo its mode line
13850 if (a) the window to its side is being redone and
13851 (b) we do a frame-based redisplay. This is a consequence
13852 of how inverted lines are drawn in frame-based redisplay. */
13853 || (!just_this_one_p
13854 && !FRAME_WINDOW_P (f
)
13855 && !WINDOW_FULL_WIDTH_P (w
))
13856 /* Line number to display. */
13857 || INTEGERP (w
->base_line_pos
)
13858 /* Column number is displayed and different from the one displayed. */
13859 || (!NILP (w
->column_number_displayed
)
13860 && (XFASTINT (w
->column_number_displayed
)
13861 != (int) current_column ()))) /* iftc */
13862 /* This means that the window has a mode line. */
13863 && (WINDOW_WANTS_MODELINE_P (w
)
13864 || WINDOW_WANTS_HEADER_LINE_P (w
)))
13866 display_mode_lines (w
);
13868 /* If mode line height has changed, arrange for a thorough
13869 immediate redisplay using the correct mode line height. */
13870 if (WINDOW_WANTS_MODELINE_P (w
)
13871 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
13873 fonts_changed_p
= 1;
13874 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
13875 = DESIRED_MODE_LINE_HEIGHT (w
);
13878 /* If header line height has changed, arrange for a thorough
13879 immediate redisplay using the correct header line height. */
13880 if (WINDOW_WANTS_HEADER_LINE_P (w
)
13881 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
13883 fonts_changed_p
= 1;
13884 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
13885 = DESIRED_HEADER_LINE_HEIGHT (w
);
13888 if (fonts_changed_p
)
13889 goto need_larger_matrices
;
13892 if (!line_number_displayed
13893 && !BUFFERP (w
->base_line_pos
))
13895 w
->base_line_pos
= Qnil
;
13896 w
->base_line_number
= Qnil
;
13901 /* When we reach a frame's selected window, redo the frame's menu bar. */
13902 if (update_mode_line
13903 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
13905 int redisplay_menu_p
= 0;
13906 int redisplay_tool_bar_p
= 0;
13908 if (FRAME_WINDOW_P (f
))
13910 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
13911 || defined (HAVE_NS) || defined (USE_GTK)
13912 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
13914 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13918 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
13920 if (redisplay_menu_p
)
13921 display_menu_bar (w
);
13923 #ifdef HAVE_WINDOW_SYSTEM
13924 if (FRAME_WINDOW_P (f
))
13926 #if defined (USE_GTK) || defined (HAVE_NS)
13927 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
13929 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
13930 && (FRAME_TOOL_BAR_LINES (f
) > 0
13931 || !NILP (Vauto_resize_tool_bars
));
13934 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
13936 extern int ignore_mouse_drag_p
;
13937 ignore_mouse_drag_p
= 1;
13943 #ifdef HAVE_WINDOW_SYSTEM
13944 if (FRAME_WINDOW_P (f
)
13945 && update_window_fringes (w
, (just_this_one_p
13946 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
13947 || w
->pseudo_window_p
)))
13951 if (draw_window_fringes (w
, 1))
13952 x_draw_vertical_border (w
);
13956 #endif /* HAVE_WINDOW_SYSTEM */
13958 /* We go to this label, with fonts_changed_p nonzero,
13959 if it is necessary to try again using larger glyph matrices.
13960 We have to redeem the scroll bar even in this case,
13961 because the loop in redisplay_internal expects that. */
13962 need_larger_matrices
:
13964 finish_scroll_bars
:
13966 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
13968 /* Set the thumb's position and size. */
13969 set_vertical_scroll_bar (w
);
13971 /* Note that we actually used the scroll bar attached to this
13972 window, so it shouldn't be deleted at the end of redisplay. */
13973 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
13974 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
13977 /* Restore current_buffer and value of point in it. */
13978 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
13979 set_buffer_internal_1 (old
);
13980 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
13981 shorter. This can be caused by log truncation in *Messages*. */
13982 if (CHARPOS (lpoint
) <= ZV
)
13983 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
13985 unbind_to (count
, Qnil
);
13989 /* Build the complete desired matrix of WINDOW with a window start
13990 buffer position POS.
13992 Value is 1 if successful. It is zero if fonts were loaded during
13993 redisplay which makes re-adjusting glyph matrices necessary, and -1
13994 if point would appear in the scroll margins.
13995 (We check that only if CHECK_MARGINS is nonzero. */
13998 try_window (window
, pos
, check_margins
)
13999 Lisp_Object window
;
14000 struct text_pos pos
;
14003 struct window
*w
= XWINDOW (window
);
14005 struct glyph_row
*last_text_row
= NULL
;
14006 struct frame
*f
= XFRAME (w
->frame
);
14008 /* Make POS the new window start. */
14009 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14011 /* Mark cursor position as unknown. No overlay arrow seen. */
14012 w
->cursor
.vpos
= -1;
14013 overlay_arrow_seen
= 0;
14015 /* Initialize iterator and info to start at POS. */
14016 start_display (&it
, w
, pos
);
14018 /* Display all lines of W. */
14019 while (it
.current_y
< it
.last_visible_y
)
14021 if (display_line (&it
))
14022 last_text_row
= it
.glyph_row
- 1;
14023 if (fonts_changed_p
)
14027 /* Don't let the cursor end in the scroll margins. */
14029 && !MINI_WINDOW_P (w
))
14031 int this_scroll_margin
;
14033 if (scroll_margin
> 0)
14035 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14036 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14039 this_scroll_margin
= 0;
14041 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14042 && w
->cursor
.y
< this_scroll_margin
14043 && CHARPOS (pos
) > BEGV
14044 && IT_CHARPOS (it
) < ZV
)
14045 /* rms: considering make_cursor_line_fully_visible_p here
14046 seems to give wrong results. We don't want to recenter
14047 when the last line is partly visible, we want to allow
14048 that case to be handled in the usual way. */
14049 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14051 w
->cursor
.vpos
= -1;
14052 clear_glyph_matrix (w
->desired_matrix
);
14057 /* If bottom moved off end of frame, change mode line percentage. */
14058 if (XFASTINT (w
->window_end_pos
) <= 0
14059 && Z
!= IT_CHARPOS (it
))
14060 w
->update_mode_line
= Qt
;
14062 /* Set window_end_pos to the offset of the last character displayed
14063 on the window from the end of current_buffer. Set
14064 window_end_vpos to its row number. */
14067 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14068 w
->window_end_bytepos
14069 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14071 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14073 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14074 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14075 ->displays_text_p
);
14079 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14080 w
->window_end_pos
= make_number (Z
- ZV
);
14081 w
->window_end_vpos
= make_number (0);
14084 /* But that is not valid info until redisplay finishes. */
14085 w
->window_end_valid
= Qnil
;
14091 /************************************************************************
14092 Window redisplay reusing current matrix when buffer has not changed
14093 ************************************************************************/
14095 /* Try redisplay of window W showing an unchanged buffer with a
14096 different window start than the last time it was displayed by
14097 reusing its current matrix. Value is non-zero if successful.
14098 W->start is the new window start. */
14101 try_window_reusing_current_matrix (w
)
14104 struct frame
*f
= XFRAME (w
->frame
);
14105 struct glyph_row
*row
, *bottom_row
;
14108 struct text_pos start
, new_start
;
14109 int nrows_scrolled
, i
;
14110 struct glyph_row
*last_text_row
;
14111 struct glyph_row
*last_reused_text_row
;
14112 struct glyph_row
*start_row
;
14113 int start_vpos
, min_y
, max_y
;
14116 if (inhibit_try_window_reusing
)
14120 if (/* This function doesn't handle terminal frames. */
14121 !FRAME_WINDOW_P (f
)
14122 /* Don't try to reuse the display if windows have been split
14124 || windows_or_buffers_changed
14125 || cursor_type_changed
)
14128 /* Can't do this if region may have changed. */
14129 if ((!NILP (Vtransient_mark_mode
)
14130 && !NILP (current_buffer
->mark_active
))
14131 || !NILP (w
->region_showing
)
14132 || !NILP (Vshow_trailing_whitespace
))
14135 /* If top-line visibility has changed, give up. */
14136 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14137 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14140 /* Give up if old or new display is scrolled vertically. We could
14141 make this function handle this, but right now it doesn't. */
14142 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14143 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14146 /* The variable new_start now holds the new window start. The old
14147 start `start' can be determined from the current matrix. */
14148 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14149 start
= start_row
->start
.pos
;
14150 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14152 /* Clear the desired matrix for the display below. */
14153 clear_glyph_matrix (w
->desired_matrix
);
14155 if (CHARPOS (new_start
) <= CHARPOS (start
))
14159 /* Don't use this method if the display starts with an ellipsis
14160 displayed for invisible text. It's not easy to handle that case
14161 below, and it's certainly not worth the effort since this is
14162 not a frequent case. */
14163 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14166 IF_DEBUG (debug_method_add (w
, "twu1"));
14168 /* Display up to a row that can be reused. The variable
14169 last_text_row is set to the last row displayed that displays
14170 text. Note that it.vpos == 0 if or if not there is a
14171 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14172 start_display (&it
, w
, new_start
);
14173 first_row_y
= it
.current_y
;
14174 w
->cursor
.vpos
= -1;
14175 last_text_row
= last_reused_text_row
= NULL
;
14177 while (it
.current_y
< it
.last_visible_y
14178 && !fonts_changed_p
)
14180 /* If we have reached into the characters in the START row,
14181 that means the line boundaries have changed. So we
14182 can't start copying with the row START. Maybe it will
14183 work to start copying with the following row. */
14184 while (IT_CHARPOS (it
) > CHARPOS (start
))
14186 /* Advance to the next row as the "start". */
14188 start
= start_row
->start
.pos
;
14189 /* If there are no more rows to try, or just one, give up. */
14190 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14191 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14192 || CHARPOS (start
) == ZV
)
14194 clear_glyph_matrix (w
->desired_matrix
);
14198 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14200 /* If we have reached alignment,
14201 we can copy the rest of the rows. */
14202 if (IT_CHARPOS (it
) == CHARPOS (start
))
14205 if (display_line (&it
))
14206 last_text_row
= it
.glyph_row
- 1;
14209 /* A value of current_y < last_visible_y means that we stopped
14210 at the previous window start, which in turn means that we
14211 have at least one reusable row. */
14212 if (it
.current_y
< it
.last_visible_y
)
14214 /* IT.vpos always starts from 0; it counts text lines. */
14215 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14217 /* Find PT if not already found in the lines displayed. */
14218 if (w
->cursor
.vpos
< 0)
14220 int dy
= it
.current_y
- start_row
->y
;
14222 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14223 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14225 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14226 dy
, nrows_scrolled
);
14229 clear_glyph_matrix (w
->desired_matrix
);
14234 /* Scroll the display. Do it before the current matrix is
14235 changed. The problem here is that update has not yet
14236 run, i.e. part of the current matrix is not up to date.
14237 scroll_run_hook will clear the cursor, and use the
14238 current matrix to get the height of the row the cursor is
14240 run
.current_y
= start_row
->y
;
14241 run
.desired_y
= it
.current_y
;
14242 run
.height
= it
.last_visible_y
- it
.current_y
;
14244 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14247 FRAME_RIF (f
)->update_window_begin_hook (w
);
14248 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14249 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14250 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14254 /* Shift current matrix down by nrows_scrolled lines. */
14255 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14256 rotate_matrix (w
->current_matrix
,
14258 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14261 /* Disable lines that must be updated. */
14262 for (i
= 0; i
< nrows_scrolled
; ++i
)
14263 (start_row
+ i
)->enabled_p
= 0;
14265 /* Re-compute Y positions. */
14266 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14267 max_y
= it
.last_visible_y
;
14268 for (row
= start_row
+ nrows_scrolled
;
14272 row
->y
= it
.current_y
;
14273 row
->visible_height
= row
->height
;
14275 if (row
->y
< min_y
)
14276 row
->visible_height
-= min_y
- row
->y
;
14277 if (row
->y
+ row
->height
> max_y
)
14278 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14279 row
->redraw_fringe_bitmaps_p
= 1;
14281 it
.current_y
+= row
->height
;
14283 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14284 last_reused_text_row
= row
;
14285 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14289 /* Disable lines in the current matrix which are now
14290 below the window. */
14291 for (++row
; row
< bottom_row
; ++row
)
14292 row
->enabled_p
= row
->mode_line_p
= 0;
14295 /* Update window_end_pos etc.; last_reused_text_row is the last
14296 reused row from the current matrix containing text, if any.
14297 The value of last_text_row is the last displayed line
14298 containing text. */
14299 if (last_reused_text_row
)
14301 w
->window_end_bytepos
14302 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14304 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14306 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14307 w
->current_matrix
));
14309 else if (last_text_row
)
14311 w
->window_end_bytepos
14312 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14314 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14316 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14320 /* This window must be completely empty. */
14321 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14322 w
->window_end_pos
= make_number (Z
- ZV
);
14323 w
->window_end_vpos
= make_number (0);
14325 w
->window_end_valid
= Qnil
;
14327 /* Update hint: don't try scrolling again in update_window. */
14328 w
->desired_matrix
->no_scrolling_p
= 1;
14331 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14335 else if (CHARPOS (new_start
) > CHARPOS (start
))
14337 struct glyph_row
*pt_row
, *row
;
14338 struct glyph_row
*first_reusable_row
;
14339 struct glyph_row
*first_row_to_display
;
14341 int yb
= window_text_bottom_y (w
);
14343 /* Find the row starting at new_start, if there is one. Don't
14344 reuse a partially visible line at the end. */
14345 first_reusable_row
= start_row
;
14346 while (first_reusable_row
->enabled_p
14347 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14348 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14349 < CHARPOS (new_start
)))
14350 ++first_reusable_row
;
14352 /* Give up if there is no row to reuse. */
14353 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14354 || !first_reusable_row
->enabled_p
14355 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14356 != CHARPOS (new_start
)))
14359 /* We can reuse fully visible rows beginning with
14360 first_reusable_row to the end of the window. Set
14361 first_row_to_display to the first row that cannot be reused.
14362 Set pt_row to the row containing point, if there is any. */
14364 for (first_row_to_display
= first_reusable_row
;
14365 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14366 ++first_row_to_display
)
14368 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14369 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14370 pt_row
= first_row_to_display
;
14373 /* Start displaying at the start of first_row_to_display. */
14374 xassert (first_row_to_display
->y
< yb
);
14375 init_to_row_start (&it
, w
, first_row_to_display
);
14377 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14379 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14381 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14382 + WINDOW_HEADER_LINE_HEIGHT (w
));
14384 /* Display lines beginning with first_row_to_display in the
14385 desired matrix. Set last_text_row to the last row displayed
14386 that displays text. */
14387 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14388 if (pt_row
== NULL
)
14389 w
->cursor
.vpos
= -1;
14390 last_text_row
= NULL
;
14391 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14392 if (display_line (&it
))
14393 last_text_row
= it
.glyph_row
- 1;
14395 /* If point is in a reused row, adjust y and vpos of the cursor
14399 w
->cursor
.vpos
-= nrows_scrolled
;
14400 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14403 /* Give up if point isn't in a row displayed or reused. (This
14404 also handles the case where w->cursor.vpos < nrows_scrolled
14405 after the calls to display_line, which can happen with scroll
14406 margins. See bug#1295.) */
14407 if (w
->cursor
.vpos
< 0)
14409 clear_glyph_matrix (w
->desired_matrix
);
14413 /* Scroll the display. */
14414 run
.current_y
= first_reusable_row
->y
;
14415 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14416 run
.height
= it
.last_visible_y
- run
.current_y
;
14417 dy
= run
.current_y
- run
.desired_y
;
14422 FRAME_RIF (f
)->update_window_begin_hook (w
);
14423 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14424 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14425 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14429 /* Adjust Y positions of reused rows. */
14430 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14431 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14432 max_y
= it
.last_visible_y
;
14433 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
14436 row
->visible_height
= row
->height
;
14437 if (row
->y
< min_y
)
14438 row
->visible_height
-= min_y
- row
->y
;
14439 if (row
->y
+ row
->height
> max_y
)
14440 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14441 row
->redraw_fringe_bitmaps_p
= 1;
14444 /* Scroll the current matrix. */
14445 xassert (nrows_scrolled
> 0);
14446 rotate_matrix (w
->current_matrix
,
14448 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14451 /* Disable rows not reused. */
14452 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
14453 row
->enabled_p
= 0;
14455 /* Point may have moved to a different line, so we cannot assume that
14456 the previous cursor position is valid; locate the correct row. */
14459 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14460 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
14464 w
->cursor
.y
= row
->y
;
14466 if (row
< bottom_row
)
14468 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14469 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14472 && (!BUFFERP (glyph
->object
)
14473 || glyph
->charpos
< PT
);
14477 w
->cursor
.x
+= glyph
->pixel_width
;
14482 /* Adjust window end. A null value of last_text_row means that
14483 the window end is in reused rows which in turn means that
14484 only its vpos can have changed. */
14487 w
->window_end_bytepos
14488 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14490 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14492 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14497 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
14500 w
->window_end_valid
= Qnil
;
14501 w
->desired_matrix
->no_scrolling_p
= 1;
14504 debug_method_add (w
, "try_window_reusing_current_matrix 2");
14514 /************************************************************************
14515 Window redisplay reusing current matrix when buffer has changed
14516 ************************************************************************/
14518 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
14519 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
14521 static struct glyph_row
*
14522 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
14523 struct glyph_row
*));
14526 /* Return the last row in MATRIX displaying text. If row START is
14527 non-null, start searching with that row. IT gives the dimensions
14528 of the display. Value is null if matrix is empty; otherwise it is
14529 a pointer to the row found. */
14531 static struct glyph_row
*
14532 find_last_row_displaying_text (matrix
, it
, start
)
14533 struct glyph_matrix
*matrix
;
14535 struct glyph_row
*start
;
14537 struct glyph_row
*row
, *row_found
;
14539 /* Set row_found to the last row in IT->w's current matrix
14540 displaying text. The loop looks funny but think of partially
14543 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
14544 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14546 xassert (row
->enabled_p
);
14548 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
14557 /* Return the last row in the current matrix of W that is not affected
14558 by changes at the start of current_buffer that occurred since W's
14559 current matrix was built. Value is null if no such row exists.
14561 BEG_UNCHANGED us the number of characters unchanged at the start of
14562 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
14563 first changed character in current_buffer. Characters at positions <
14564 BEG + BEG_UNCHANGED are at the same buffer positions as they were
14565 when the current matrix was built. */
14567 static struct glyph_row
*
14568 find_last_unchanged_at_beg_row (w
)
14571 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
14572 struct glyph_row
*row
;
14573 struct glyph_row
*row_found
= NULL
;
14574 int yb
= window_text_bottom_y (w
);
14576 /* Find the last row displaying unchanged text. */
14577 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14578 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14579 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
14582 if (/* If row ends before first_changed_pos, it is unchanged,
14583 except in some case. */
14584 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
14585 /* When row ends in ZV and we write at ZV it is not
14587 && !row
->ends_at_zv_p
14588 /* When first_changed_pos is the end of a continued line,
14589 row is not unchanged because it may be no longer
14591 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
14592 && (row
->continued_p
14593 || row
->exact_window_width_line_p
)))
14596 /* Stop if last visible row. */
14597 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
14605 /* Find the first glyph row in the current matrix of W that is not
14606 affected by changes at the end of current_buffer since the
14607 time W's current matrix was built.
14609 Return in *DELTA the number of chars by which buffer positions in
14610 unchanged text at the end of current_buffer must be adjusted.
14612 Return in *DELTA_BYTES the corresponding number of bytes.
14614 Value is null if no such row exists, i.e. all rows are affected by
14617 static struct glyph_row
*
14618 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
14620 int *delta
, *delta_bytes
;
14622 struct glyph_row
*row
;
14623 struct glyph_row
*row_found
= NULL
;
14625 *delta
= *delta_bytes
= 0;
14627 /* Display must not have been paused, otherwise the current matrix
14628 is not up to date. */
14629 eassert (!NILP (w
->window_end_valid
));
14631 /* A value of window_end_pos >= END_UNCHANGED means that the window
14632 end is in the range of changed text. If so, there is no
14633 unchanged row at the end of W's current matrix. */
14634 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
14637 /* Set row to the last row in W's current matrix displaying text. */
14638 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14640 /* If matrix is entirely empty, no unchanged row exists. */
14641 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14643 /* The value of row is the last glyph row in the matrix having a
14644 meaningful buffer position in it. The end position of row
14645 corresponds to window_end_pos. This allows us to translate
14646 buffer positions in the current matrix to current buffer
14647 positions for characters not in changed text. */
14648 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14649 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14650 int last_unchanged_pos
, last_unchanged_pos_old
;
14651 struct glyph_row
*first_text_row
14652 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14654 *delta
= Z
- Z_old
;
14655 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14657 /* Set last_unchanged_pos to the buffer position of the last
14658 character in the buffer that has not been changed. Z is the
14659 index + 1 of the last character in current_buffer, i.e. by
14660 subtracting END_UNCHANGED we get the index of the last
14661 unchanged character, and we have to add BEG to get its buffer
14663 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
14664 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
14666 /* Search backward from ROW for a row displaying a line that
14667 starts at a minimum position >= last_unchanged_pos_old. */
14668 for (; row
> first_text_row
; --row
)
14670 /* This used to abort, but it can happen.
14671 It is ok to just stop the search instead here. KFS. */
14672 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14675 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
14680 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
14686 /* Make sure that glyph rows in the current matrix of window W
14687 reference the same glyph memory as corresponding rows in the
14688 frame's frame matrix. This function is called after scrolling W's
14689 current matrix on a terminal frame in try_window_id and
14690 try_window_reusing_current_matrix. */
14693 sync_frame_with_window_matrix_rows (w
)
14696 struct frame
*f
= XFRAME (w
->frame
);
14697 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
14699 /* Preconditions: W must be a leaf window and full-width. Its frame
14700 must have a frame matrix. */
14701 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
14702 xassert (WINDOW_FULL_WIDTH_P (w
));
14703 xassert (!FRAME_WINDOW_P (f
));
14705 /* If W is a full-width window, glyph pointers in W's current matrix
14706 have, by definition, to be the same as glyph pointers in the
14707 corresponding frame matrix. Note that frame matrices have no
14708 marginal areas (see build_frame_matrix). */
14709 window_row
= w
->current_matrix
->rows
;
14710 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
14711 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
14712 while (window_row
< window_row_end
)
14714 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
14715 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
14717 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
14718 frame_row
->glyphs
[TEXT_AREA
] = start
;
14719 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
14720 frame_row
->glyphs
[LAST_AREA
] = end
;
14722 /* Disable frame rows whose corresponding window rows have
14723 been disabled in try_window_id. */
14724 if (!window_row
->enabled_p
)
14725 frame_row
->enabled_p
= 0;
14727 ++window_row
, ++frame_row
;
14732 /* Find the glyph row in window W containing CHARPOS. Consider all
14733 rows between START and END (not inclusive). END null means search
14734 all rows to the end of the display area of W. Value is the row
14735 containing CHARPOS or null. */
14738 row_containing_pos (w
, charpos
, start
, end
, dy
)
14741 struct glyph_row
*start
, *end
;
14744 struct glyph_row
*row
= start
;
14747 /* If we happen to start on a header-line, skip that. */
14748 if (row
->mode_line_p
)
14751 if ((end
&& row
>= end
) || !row
->enabled_p
)
14754 last_y
= window_text_bottom_y (w
) - dy
;
14758 /* Give up if we have gone too far. */
14759 if (end
&& row
>= end
)
14761 /* This formerly returned if they were equal.
14762 I think that both quantities are of a "last plus one" type;
14763 if so, when they are equal, the row is within the screen. -- rms. */
14764 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
14767 /* If it is in this row, return this row. */
14768 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
14769 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
14770 /* The end position of a row equals the start
14771 position of the next row. If CHARPOS is there, we
14772 would rather display it in the next line, except
14773 when this line ends in ZV. */
14774 && !row
->ends_at_zv_p
14775 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14776 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
14783 /* Try to redisplay window W by reusing its existing display. W's
14784 current matrix must be up to date when this function is called,
14785 i.e. window_end_valid must not be nil.
14789 1 if display has been updated
14790 0 if otherwise unsuccessful
14791 -1 if redisplay with same window start is known not to succeed
14793 The following steps are performed:
14795 1. Find the last row in the current matrix of W that is not
14796 affected by changes at the start of current_buffer. If no such row
14799 2. Find the first row in W's current matrix that is not affected by
14800 changes at the end of current_buffer. Maybe there is no such row.
14802 3. Display lines beginning with the row + 1 found in step 1 to the
14803 row found in step 2 or, if step 2 didn't find a row, to the end of
14806 4. If cursor is not known to appear on the window, give up.
14808 5. If display stopped at the row found in step 2, scroll the
14809 display and current matrix as needed.
14811 6. Maybe display some lines at the end of W, if we must. This can
14812 happen under various circumstances, like a partially visible line
14813 becoming fully visible, or because newly displayed lines are displayed
14814 in smaller font sizes.
14816 7. Update W's window end information. */
14822 struct frame
*f
= XFRAME (w
->frame
);
14823 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
14824 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
14825 struct glyph_row
*last_unchanged_at_beg_row
;
14826 struct glyph_row
*first_unchanged_at_end_row
;
14827 struct glyph_row
*row
;
14828 struct glyph_row
*bottom_row
;
14831 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
14832 struct text_pos start_pos
;
14834 int first_unchanged_at_end_vpos
= 0;
14835 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
14836 struct text_pos start
;
14837 int first_changed_charpos
, last_changed_charpos
;
14840 if (inhibit_try_window_id
)
14844 /* This is handy for debugging. */
14846 #define GIVE_UP(X) \
14848 fprintf (stderr, "try_window_id give up %d\n", (X)); \
14852 #define GIVE_UP(X) return 0
14855 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
14857 /* Don't use this for mini-windows because these can show
14858 messages and mini-buffers, and we don't handle that here. */
14859 if (MINI_WINDOW_P (w
))
14862 /* This flag is used to prevent redisplay optimizations. */
14863 if (windows_or_buffers_changed
|| cursor_type_changed
)
14866 /* Verify that narrowing has not changed.
14867 Also verify that we were not told to prevent redisplay optimizations.
14868 It would be nice to further
14869 reduce the number of cases where this prevents try_window_id. */
14870 if (current_buffer
->clip_changed
14871 || current_buffer
->prevent_redisplay_optimizations_p
)
14874 /* Window must either use window-based redisplay or be full width. */
14875 if (!FRAME_WINDOW_P (f
)
14876 && (!FRAME_LINE_INS_DEL_OK (f
)
14877 || !WINDOW_FULL_WIDTH_P (w
)))
14880 /* Give up if point is known NOT to appear in W. */
14881 if (PT
< CHARPOS (start
))
14884 /* Another way to prevent redisplay optimizations. */
14885 if (XFASTINT (w
->last_modified
) == 0)
14888 /* Verify that window is not hscrolled. */
14889 if (XFASTINT (w
->hscroll
) != 0)
14892 /* Verify that display wasn't paused. */
14893 if (NILP (w
->window_end_valid
))
14896 /* Can't use this if highlighting a region because a cursor movement
14897 will do more than just set the cursor. */
14898 if (!NILP (Vtransient_mark_mode
)
14899 && !NILP (current_buffer
->mark_active
))
14902 /* Likewise if highlighting trailing whitespace. */
14903 if (!NILP (Vshow_trailing_whitespace
))
14906 /* Likewise if showing a region. */
14907 if (!NILP (w
->region_showing
))
14910 /* Can't use this if overlay arrow position and/or string have
14912 if (overlay_arrows_changed_p ())
14915 /* When word-wrap is on, adding a space to the first word of a
14916 wrapped line can change the wrap position, altering the line
14917 above it. It might be worthwhile to handle this more
14918 intelligently, but for now just redisplay from scratch. */
14919 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
14922 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
14923 only if buffer has really changed. The reason is that the gap is
14924 initially at Z for freshly visited files. The code below would
14925 set end_unchanged to 0 in that case. */
14926 if (MODIFF
> SAVE_MODIFF
14927 /* This seems to happen sometimes after saving a buffer. */
14928 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
14930 if (GPT
- BEG
< BEG_UNCHANGED
)
14931 BEG_UNCHANGED
= GPT
- BEG
;
14932 if (Z
- GPT
< END_UNCHANGED
)
14933 END_UNCHANGED
= Z
- GPT
;
14936 /* The position of the first and last character that has been changed. */
14937 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
14938 last_changed_charpos
= Z
- END_UNCHANGED
;
14940 /* If window starts after a line end, and the last change is in
14941 front of that newline, then changes don't affect the display.
14942 This case happens with stealth-fontification. Note that although
14943 the display is unchanged, glyph positions in the matrix have to
14944 be adjusted, of course. */
14945 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
14946 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
14947 && ((last_changed_charpos
< CHARPOS (start
)
14948 && CHARPOS (start
) == BEGV
)
14949 || (last_changed_charpos
< CHARPOS (start
) - 1
14950 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
14952 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
14953 struct glyph_row
*r0
;
14955 /* Compute how many chars/bytes have been added to or removed
14956 from the buffer. */
14957 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
14958 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
14960 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
14962 /* Give up if PT is not in the window. Note that it already has
14963 been checked at the start of try_window_id that PT is not in
14964 front of the window start. */
14965 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
14968 /* If window start is unchanged, we can reuse the whole matrix
14969 as is, after adjusting glyph positions. No need to compute
14970 the window end again, since its offset from Z hasn't changed. */
14971 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
14972 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
14973 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
14974 /* PT must not be in a partially visible line. */
14975 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
14976 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
14978 /* Adjust positions in the glyph matrix. */
14979 if (delta
|| delta_bytes
)
14981 struct glyph_row
*r1
14982 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
14983 increment_matrix_positions (w
->current_matrix
,
14984 MATRIX_ROW_VPOS (r0
, current_matrix
),
14985 MATRIX_ROW_VPOS (r1
, current_matrix
),
14986 delta
, delta_bytes
);
14989 /* Set the cursor. */
14990 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
14992 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
14999 /* Handle the case that changes are all below what is displayed in
15000 the window, and that PT is in the window. This shortcut cannot
15001 be taken if ZV is visible in the window, and text has been added
15002 there that is visible in the window. */
15003 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15004 /* ZV is not visible in the window, or there are no
15005 changes at ZV, actually. */
15006 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15007 || first_changed_charpos
== last_changed_charpos
))
15009 struct glyph_row
*r0
;
15011 /* Give up if PT is not in the window. Note that it already has
15012 been checked at the start of try_window_id that PT is not in
15013 front of the window start. */
15014 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15017 /* If window start is unchanged, we can reuse the whole matrix
15018 as is, without changing glyph positions since no text has
15019 been added/removed in front of the window end. */
15020 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15021 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15022 /* PT must not be in a partially visible line. */
15023 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15024 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15026 /* We have to compute the window end anew since text
15027 can have been added/removed after it. */
15029 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15030 w
->window_end_bytepos
15031 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15033 /* Set the cursor. */
15034 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15036 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15043 /* Give up if window start is in the changed area.
15045 The condition used to read
15047 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15049 but why that was tested escapes me at the moment. */
15050 if (CHARPOS (start
) >= first_changed_charpos
15051 && CHARPOS (start
) <= last_changed_charpos
)
15054 /* Check that window start agrees with the start of the first glyph
15055 row in its current matrix. Check this after we know the window
15056 start is not in changed text, otherwise positions would not be
15058 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15059 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15062 /* Give up if the window ends in strings. Overlay strings
15063 at the end are difficult to handle, so don't try. */
15064 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15065 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15068 /* Compute the position at which we have to start displaying new
15069 lines. Some of the lines at the top of the window might be
15070 reusable because they are not displaying changed text. Find the
15071 last row in W's current matrix not affected by changes at the
15072 start of current_buffer. Value is null if changes start in the
15073 first line of window. */
15074 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15075 if (last_unchanged_at_beg_row
)
15077 /* Avoid starting to display in the moddle of a character, a TAB
15078 for instance. This is easier than to set up the iterator
15079 exactly, and it's not a frequent case, so the additional
15080 effort wouldn't really pay off. */
15081 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15082 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15083 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15084 --last_unchanged_at_beg_row
;
15086 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15089 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15091 start_pos
= it
.current
.pos
;
15093 /* Start displaying new lines in the desired matrix at the same
15094 vpos we would use in the current matrix, i.e. below
15095 last_unchanged_at_beg_row. */
15096 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15098 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15099 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15101 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15105 /* There are no reusable lines at the start of the window.
15106 Start displaying in the first text line. */
15107 start_display (&it
, w
, start
);
15108 it
.vpos
= it
.first_vpos
;
15109 start_pos
= it
.current
.pos
;
15112 /* Find the first row that is not affected by changes at the end of
15113 the buffer. Value will be null if there is no unchanged row, in
15114 which case we must redisplay to the end of the window. delta
15115 will be set to the value by which buffer positions beginning with
15116 first_unchanged_at_end_row have to be adjusted due to text
15118 first_unchanged_at_end_row
15119 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15120 IF_DEBUG (debug_delta
= delta
);
15121 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15123 /* Set stop_pos to the buffer position up to which we will have to
15124 display new lines. If first_unchanged_at_end_row != NULL, this
15125 is the buffer position of the start of the line displayed in that
15126 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15127 that we don't stop at a buffer position. */
15129 if (first_unchanged_at_end_row
)
15131 xassert (last_unchanged_at_beg_row
== NULL
15132 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15134 /* If this is a continuation line, move forward to the next one
15135 that isn't. Changes in lines above affect this line.
15136 Caution: this may move first_unchanged_at_end_row to a row
15137 not displaying text. */
15138 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15139 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15140 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15141 < it
.last_visible_y
))
15142 ++first_unchanged_at_end_row
;
15144 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15145 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15146 >= it
.last_visible_y
))
15147 first_unchanged_at_end_row
= NULL
;
15150 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15152 first_unchanged_at_end_vpos
15153 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15154 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15157 else if (last_unchanged_at_beg_row
== NULL
)
15163 /* Either there is no unchanged row at the end, or the one we have
15164 now displays text. This is a necessary condition for the window
15165 end pos calculation at the end of this function. */
15166 xassert (first_unchanged_at_end_row
== NULL
15167 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15169 debug_last_unchanged_at_beg_vpos
15170 = (last_unchanged_at_beg_row
15171 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15173 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15175 #endif /* GLYPH_DEBUG != 0 */
15178 /* Display new lines. Set last_text_row to the last new line
15179 displayed which has text on it, i.e. might end up as being the
15180 line where the window_end_vpos is. */
15181 w
->cursor
.vpos
= -1;
15182 last_text_row
= NULL
;
15183 overlay_arrow_seen
= 0;
15184 while (it
.current_y
< it
.last_visible_y
15185 && !fonts_changed_p
15186 && (first_unchanged_at_end_row
== NULL
15187 || IT_CHARPOS (it
) < stop_pos
))
15189 if (display_line (&it
))
15190 last_text_row
= it
.glyph_row
- 1;
15193 if (fonts_changed_p
)
15197 /* Compute differences in buffer positions, y-positions etc. for
15198 lines reused at the bottom of the window. Compute what we can
15200 if (first_unchanged_at_end_row
15201 /* No lines reused because we displayed everything up to the
15202 bottom of the window. */
15203 && it
.current_y
< it
.last_visible_y
)
15206 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15208 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15209 run
.current_y
= first_unchanged_at_end_row
->y
;
15210 run
.desired_y
= run
.current_y
+ dy
;
15211 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15215 delta
= delta_bytes
= dvpos
= dy
15216 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15217 first_unchanged_at_end_row
= NULL
;
15219 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15222 /* Find the cursor if not already found. We have to decide whether
15223 PT will appear on this window (it sometimes doesn't, but this is
15224 not a very frequent case.) This decision has to be made before
15225 the current matrix is altered. A value of cursor.vpos < 0 means
15226 that PT is either in one of the lines beginning at
15227 first_unchanged_at_end_row or below the window. Don't care for
15228 lines that might be displayed later at the window end; as
15229 mentioned, this is not a frequent case. */
15230 if (w
->cursor
.vpos
< 0)
15232 /* Cursor in unchanged rows at the top? */
15233 if (PT
< CHARPOS (start_pos
)
15234 && last_unchanged_at_beg_row
)
15236 row
= row_containing_pos (w
, PT
,
15237 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15238 last_unchanged_at_beg_row
+ 1, 0);
15240 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15243 /* Start from first_unchanged_at_end_row looking for PT. */
15244 else if (first_unchanged_at_end_row
)
15246 row
= row_containing_pos (w
, PT
- delta
,
15247 first_unchanged_at_end_row
, NULL
, 0);
15249 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15250 delta_bytes
, dy
, dvpos
);
15253 /* Give up if cursor was not found. */
15254 if (w
->cursor
.vpos
< 0)
15256 clear_glyph_matrix (w
->desired_matrix
);
15261 /* Don't let the cursor end in the scroll margins. */
15263 int this_scroll_margin
, cursor_height
;
15265 this_scroll_margin
= max (0, scroll_margin
);
15266 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15267 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15268 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15270 if ((w
->cursor
.y
< this_scroll_margin
15271 && CHARPOS (start
) > BEGV
)
15272 /* Old redisplay didn't take scroll margin into account at the bottom,
15273 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15274 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15275 ? cursor_height
+ this_scroll_margin
15276 : 1)) > it
.last_visible_y
)
15278 w
->cursor
.vpos
= -1;
15279 clear_glyph_matrix (w
->desired_matrix
);
15284 /* Scroll the display. Do it before changing the current matrix so
15285 that xterm.c doesn't get confused about where the cursor glyph is
15287 if (dy
&& run
.height
)
15291 if (FRAME_WINDOW_P (f
))
15293 FRAME_RIF (f
)->update_window_begin_hook (w
);
15294 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15295 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15296 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15300 /* Terminal frame. In this case, dvpos gives the number of
15301 lines to scroll by; dvpos < 0 means scroll up. */
15302 int first_unchanged_at_end_vpos
15303 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15304 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15305 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15306 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15307 + window_internal_height (w
));
15309 /* Perform the operation on the screen. */
15312 /* Scroll last_unchanged_at_beg_row to the end of the
15313 window down dvpos lines. */
15314 set_terminal_window (f
, end
);
15316 /* On dumb terminals delete dvpos lines at the end
15317 before inserting dvpos empty lines. */
15318 if (!FRAME_SCROLL_REGION_OK (f
))
15319 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15321 /* Insert dvpos empty lines in front of
15322 last_unchanged_at_beg_row. */
15323 ins_del_lines (f
, from
, dvpos
);
15325 else if (dvpos
< 0)
15327 /* Scroll up last_unchanged_at_beg_vpos to the end of
15328 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15329 set_terminal_window (f
, end
);
15331 /* Delete dvpos lines in front of
15332 last_unchanged_at_beg_vpos. ins_del_lines will set
15333 the cursor to the given vpos and emit |dvpos| delete
15335 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15337 /* On a dumb terminal insert dvpos empty lines at the
15339 if (!FRAME_SCROLL_REGION_OK (f
))
15340 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15343 set_terminal_window (f
, 0);
15349 /* Shift reused rows of the current matrix to the right position.
15350 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15352 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15353 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15356 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15357 bottom_vpos
, dvpos
);
15358 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15361 else if (dvpos
> 0)
15363 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15364 bottom_vpos
, dvpos
);
15365 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15366 first_unchanged_at_end_vpos
+ dvpos
, 0);
15369 /* For frame-based redisplay, make sure that current frame and window
15370 matrix are in sync with respect to glyph memory. */
15371 if (!FRAME_WINDOW_P (f
))
15372 sync_frame_with_window_matrix_rows (w
);
15374 /* Adjust buffer positions in reused rows. */
15375 if (delta
|| delta_bytes
)
15376 increment_matrix_positions (current_matrix
,
15377 first_unchanged_at_end_vpos
+ dvpos
,
15378 bottom_vpos
, delta
, delta_bytes
);
15380 /* Adjust Y positions. */
15382 shift_glyph_matrix (w
, current_matrix
,
15383 first_unchanged_at_end_vpos
+ dvpos
,
15386 if (first_unchanged_at_end_row
)
15388 first_unchanged_at_end_row
+= dvpos
;
15389 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15390 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15391 first_unchanged_at_end_row
= NULL
;
15394 /* If scrolling up, there may be some lines to display at the end of
15396 last_text_row_at_end
= NULL
;
15399 /* Scrolling up can leave for example a partially visible line
15400 at the end of the window to be redisplayed. */
15401 /* Set last_row to the glyph row in the current matrix where the
15402 window end line is found. It has been moved up or down in
15403 the matrix by dvpos. */
15404 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
15405 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
15407 /* If last_row is the window end line, it should display text. */
15408 xassert (last_row
->displays_text_p
);
15410 /* If window end line was partially visible before, begin
15411 displaying at that line. Otherwise begin displaying with the
15412 line following it. */
15413 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
15415 init_to_row_start (&it
, w
, last_row
);
15416 it
.vpos
= last_vpos
;
15417 it
.current_y
= last_row
->y
;
15421 init_to_row_end (&it
, w
, last_row
);
15422 it
.vpos
= 1 + last_vpos
;
15423 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
15427 /* We may start in a continuation line. If so, we have to
15428 get the right continuation_lines_width and current_x. */
15429 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
15430 it
.hpos
= it
.current_x
= 0;
15432 /* Display the rest of the lines at the window end. */
15433 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15434 while (it
.current_y
< it
.last_visible_y
15435 && !fonts_changed_p
)
15437 /* Is it always sure that the display agrees with lines in
15438 the current matrix? I don't think so, so we mark rows
15439 displayed invalid in the current matrix by setting their
15440 enabled_p flag to zero. */
15441 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
15442 if (display_line (&it
))
15443 last_text_row_at_end
= it
.glyph_row
- 1;
15447 /* Update window_end_pos and window_end_vpos. */
15448 if (first_unchanged_at_end_row
15449 && !last_text_row_at_end
)
15451 /* Window end line if one of the preserved rows from the current
15452 matrix. Set row to the last row displaying text in current
15453 matrix starting at first_unchanged_at_end_row, after
15455 xassert (first_unchanged_at_end_row
->displays_text_p
);
15456 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
15457 first_unchanged_at_end_row
);
15458 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
15460 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15461 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15463 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
15464 xassert (w
->window_end_bytepos
>= 0);
15465 IF_DEBUG (debug_method_add (w
, "A"));
15467 else if (last_text_row_at_end
)
15470 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
15471 w
->window_end_bytepos
15472 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
15474 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
15475 xassert (w
->window_end_bytepos
>= 0);
15476 IF_DEBUG (debug_method_add (w
, "B"));
15478 else if (last_text_row
)
15480 /* We have displayed either to the end of the window or at the
15481 end of the window, i.e. the last row with text is to be found
15482 in the desired matrix. */
15484 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15485 w
->window_end_bytepos
15486 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15488 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
15489 xassert (w
->window_end_bytepos
>= 0);
15491 else if (first_unchanged_at_end_row
== NULL
15492 && last_text_row
== NULL
15493 && last_text_row_at_end
== NULL
)
15495 /* Displayed to end of window, but no line containing text was
15496 displayed. Lines were deleted at the end of the window. */
15497 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
15498 int vpos
= XFASTINT (w
->window_end_vpos
);
15499 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
15500 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
15503 row
== NULL
&& vpos
>= first_vpos
;
15504 --vpos
, --current_row
, --desired_row
)
15506 if (desired_row
->enabled_p
)
15508 if (desired_row
->displays_text_p
)
15511 else if (current_row
->displays_text_p
)
15515 xassert (row
!= NULL
);
15516 w
->window_end_vpos
= make_number (vpos
+ 1);
15517 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15518 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15519 xassert (w
->window_end_bytepos
>= 0);
15520 IF_DEBUG (debug_method_add (w
, "C"));
15525 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
15526 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
15528 /* Record that display has not been completed. */
15529 w
->window_end_valid
= Qnil
;
15530 w
->desired_matrix
->no_scrolling_p
= 1;
15538 /***********************************************************************
15539 More debugging support
15540 ***********************************************************************/
15544 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
15545 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
15546 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
15549 /* Dump the contents of glyph matrix MATRIX on stderr.
15551 GLYPHS 0 means don't show glyph contents.
15552 GLYPHS 1 means show glyphs in short form
15553 GLYPHS > 1 means show glyphs in long form. */
15556 dump_glyph_matrix (matrix
, glyphs
)
15557 struct glyph_matrix
*matrix
;
15561 for (i
= 0; i
< matrix
->nrows
; ++i
)
15562 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
15566 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
15567 the glyph row and area where the glyph comes from. */
15570 dump_glyph (row
, glyph
, area
)
15571 struct glyph_row
*row
;
15572 struct glyph
*glyph
;
15575 if (glyph
->type
== CHAR_GLYPH
)
15578 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15579 glyph
- row
->glyphs
[TEXT_AREA
],
15582 (BUFFERP (glyph
->object
)
15584 : (STRINGP (glyph
->object
)
15587 glyph
->pixel_width
,
15589 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
15593 glyph
->left_box_line_p
,
15594 glyph
->right_box_line_p
);
15596 else if (glyph
->type
== STRETCH_GLYPH
)
15599 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15600 glyph
- row
->glyphs
[TEXT_AREA
],
15603 (BUFFERP (glyph
->object
)
15605 : (STRINGP (glyph
->object
)
15608 glyph
->pixel_width
,
15612 glyph
->left_box_line_p
,
15613 glyph
->right_box_line_p
);
15615 else if (glyph
->type
== IMAGE_GLYPH
)
15618 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
15619 glyph
- row
->glyphs
[TEXT_AREA
],
15622 (BUFFERP (glyph
->object
)
15624 : (STRINGP (glyph
->object
)
15627 glyph
->pixel_width
,
15631 glyph
->left_box_line_p
,
15632 glyph
->right_box_line_p
);
15634 else if (glyph
->type
== COMPOSITE_GLYPH
)
15637 " %5d %4c %6d %c %3d 0x%05x",
15638 glyph
- row
->glyphs
[TEXT_AREA
],
15641 (BUFFERP (glyph
->object
)
15643 : (STRINGP (glyph
->object
)
15646 glyph
->pixel_width
,
15648 if (glyph
->u
.cmp
.automatic
)
15651 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
15652 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
15654 glyph
->left_box_line_p
,
15655 glyph
->right_box_line_p
);
15660 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
15661 GLYPHS 0 means don't show glyph contents.
15662 GLYPHS 1 means show glyphs in short form
15663 GLYPHS > 1 means show glyphs in long form. */
15666 dump_glyph_row (row
, vpos
, glyphs
)
15667 struct glyph_row
*row
;
15672 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
15673 fprintf (stderr
, "======================================================================\n");
15675 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
15676 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
15678 MATRIX_ROW_START_CHARPOS (row
),
15679 MATRIX_ROW_END_CHARPOS (row
),
15680 row
->used
[TEXT_AREA
],
15681 row
->contains_overlapping_glyphs_p
,
15683 row
->truncated_on_left_p
,
15684 row
->truncated_on_right_p
,
15686 MATRIX_ROW_CONTINUATION_LINE_P (row
),
15687 row
->displays_text_p
,
15690 row
->ends_in_middle_of_char_p
,
15691 row
->starts_in_middle_of_char_p
,
15697 row
->visible_height
,
15700 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
15701 row
->end
.overlay_string_index
,
15702 row
->continuation_lines_width
);
15703 fprintf (stderr
, "%9d %5d\n",
15704 CHARPOS (row
->start
.string_pos
),
15705 CHARPOS (row
->end
.string_pos
));
15706 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
15707 row
->end
.dpvec_index
);
15714 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15716 struct glyph
*glyph
= row
->glyphs
[area
];
15717 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
15719 /* Glyph for a line end in text. */
15720 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
15723 if (glyph
< glyph_end
)
15724 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
15726 for (; glyph
< glyph_end
; ++glyph
)
15727 dump_glyph (row
, glyph
, area
);
15730 else if (glyphs
== 1)
15734 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
15736 char *s
= (char *) alloca (row
->used
[area
] + 1);
15739 for (i
= 0; i
< row
->used
[area
]; ++i
)
15741 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
15742 if (glyph
->type
== CHAR_GLYPH
15743 && glyph
->u
.ch
< 0x80
15744 && glyph
->u
.ch
>= ' ')
15745 s
[i
] = glyph
->u
.ch
;
15751 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
15757 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
15758 Sdump_glyph_matrix
, 0, 1, "p",
15759 doc
: /* Dump the current matrix of the selected window to stderr.
15760 Shows contents of glyph row structures. With non-nil
15761 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
15762 glyphs in short form, otherwise show glyphs in long form. */)
15764 Lisp_Object glyphs
;
15766 struct window
*w
= XWINDOW (selected_window
);
15767 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15769 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
15770 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
15771 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
15772 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
15773 fprintf (stderr
, "=============================================\n");
15774 dump_glyph_matrix (w
->current_matrix
,
15775 NILP (glyphs
) ? 0 : XINT (glyphs
));
15780 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
15781 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
15784 struct frame
*f
= XFRAME (selected_frame
);
15785 dump_glyph_matrix (f
->current_matrix
, 1);
15790 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
15791 doc
: /* Dump glyph row ROW to stderr.
15792 GLYPH 0 means don't dump glyphs.
15793 GLYPH 1 means dump glyphs in short form.
15794 GLYPH > 1 or omitted means dump glyphs in long form. */)
15796 Lisp_Object row
, glyphs
;
15798 struct glyph_matrix
*matrix
;
15801 CHECK_NUMBER (row
);
15802 matrix
= XWINDOW (selected_window
)->current_matrix
;
15804 if (vpos
>= 0 && vpos
< matrix
->nrows
)
15805 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
15807 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15812 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
15813 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
15814 GLYPH 0 means don't dump glyphs.
15815 GLYPH 1 means dump glyphs in short form.
15816 GLYPH > 1 or omitted means dump glyphs in long form. */)
15818 Lisp_Object row
, glyphs
;
15820 struct frame
*sf
= SELECTED_FRAME ();
15821 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
15824 CHECK_NUMBER (row
);
15826 if (vpos
>= 0 && vpos
< m
->nrows
)
15827 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
15828 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
15833 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
15834 doc
: /* Toggle tracing of redisplay.
15835 With ARG, turn tracing on if and only if ARG is positive. */)
15840 trace_redisplay_p
= !trace_redisplay_p
;
15843 arg
= Fprefix_numeric_value (arg
);
15844 trace_redisplay_p
= XINT (arg
) > 0;
15851 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
15852 doc
: /* Like `format', but print result to stderr.
15853 usage: (trace-to-stderr STRING &rest OBJECTS) */)
15858 Lisp_Object s
= Fformat (nargs
, args
);
15859 fprintf (stderr
, "%s", SDATA (s
));
15863 #endif /* GLYPH_DEBUG */
15867 /***********************************************************************
15868 Building Desired Matrix Rows
15869 ***********************************************************************/
15871 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
15872 Used for non-window-redisplay windows, and for windows w/o left fringe. */
15874 static struct glyph_row
*
15875 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
15877 Lisp_Object overlay_arrow_string
;
15879 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
15880 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15881 struct buffer
*old
= current_buffer
;
15882 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
15883 int arrow_len
= SCHARS (overlay_arrow_string
);
15884 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
15885 const unsigned char *p
;
15888 int n_glyphs_before
;
15890 set_buffer_temp (buffer
);
15891 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
15892 it
.glyph_row
->used
[TEXT_AREA
] = 0;
15893 SET_TEXT_POS (it
.position
, 0, 0);
15895 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
15897 while (p
< arrow_end
)
15899 Lisp_Object face
, ilisp
;
15901 /* Get the next character. */
15903 it
.c
= string_char_and_length (p
, &it
.len
);
15905 it
.c
= *p
, it
.len
= 1;
15908 /* Get its face. */
15909 ilisp
= make_number (p
- arrow_string
);
15910 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
15911 it
.face_id
= compute_char_face (f
, it
.c
, face
);
15913 /* Compute its width, get its glyphs. */
15914 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
15915 SET_TEXT_POS (it
.position
, -1, -1);
15916 PRODUCE_GLYPHS (&it
);
15918 /* If this character doesn't fit any more in the line, we have
15919 to remove some glyphs. */
15920 if (it
.current_x
> it
.last_visible_x
)
15922 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
15927 set_buffer_temp (old
);
15928 return it
.glyph_row
;
15932 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
15933 glyphs are only inserted for terminal frames since we can't really
15934 win with truncation glyphs when partially visible glyphs are
15935 involved. Which glyphs to insert is determined by
15936 produce_special_glyphs. */
15939 insert_left_trunc_glyphs (it
)
15942 struct it truncate_it
;
15943 struct glyph
*from
, *end
, *to
, *toend
;
15945 xassert (!FRAME_WINDOW_P (it
->f
));
15947 /* Get the truncation glyphs. */
15949 truncate_it
.current_x
= 0;
15950 truncate_it
.face_id
= DEFAULT_FACE_ID
;
15951 truncate_it
.glyph_row
= &scratch_glyph_row
;
15952 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
15953 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
15954 truncate_it
.object
= make_number (0);
15955 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
15957 /* Overwrite glyphs from IT with truncation glyphs. */
15958 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15959 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
15960 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
15961 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
15966 /* There may be padding glyphs left over. Overwrite them too. */
15967 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
15969 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
15975 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
15979 /* Compute the pixel height and width of IT->glyph_row.
15981 Most of the time, ascent and height of a display line will be equal
15982 to the max_ascent and max_height values of the display iterator
15983 structure. This is not the case if
15985 1. We hit ZV without displaying anything. In this case, max_ascent
15986 and max_height will be zero.
15988 2. We have some glyphs that don't contribute to the line height.
15989 (The glyph row flag contributes_to_line_height_p is for future
15990 pixmap extensions).
15992 The first case is easily covered by using default values because in
15993 these cases, the line height does not really matter, except that it
15994 must not be zero. */
15997 compute_line_metrics (it
)
16000 struct glyph_row
*row
= it
->glyph_row
;
16003 if (FRAME_WINDOW_P (it
->f
))
16005 int i
, min_y
, max_y
;
16007 /* The line may consist of one space only, that was added to
16008 place the cursor on it. If so, the row's height hasn't been
16010 if (row
->height
== 0)
16012 if (it
->max_ascent
+ it
->max_descent
== 0)
16013 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16014 row
->ascent
= it
->max_ascent
;
16015 row
->height
= it
->max_ascent
+ it
->max_descent
;
16016 row
->phys_ascent
= it
->max_phys_ascent
;
16017 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16018 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16021 /* Compute the width of this line. */
16022 row
->pixel_width
= row
->x
;
16023 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16024 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16026 xassert (row
->pixel_width
>= 0);
16027 xassert (row
->ascent
>= 0 && row
->height
> 0);
16029 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16030 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16032 /* If first line's physical ascent is larger than its logical
16033 ascent, use the physical ascent, and make the row taller.
16034 This makes accented characters fully visible. */
16035 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16036 && row
->phys_ascent
> row
->ascent
)
16038 row
->height
+= row
->phys_ascent
- row
->ascent
;
16039 row
->ascent
= row
->phys_ascent
;
16042 /* Compute how much of the line is visible. */
16043 row
->visible_height
= row
->height
;
16045 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16046 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16048 if (row
->y
< min_y
)
16049 row
->visible_height
-= min_y
- row
->y
;
16050 if (row
->y
+ row
->height
> max_y
)
16051 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16055 row
->pixel_width
= row
->used
[TEXT_AREA
];
16056 if (row
->continued_p
)
16057 row
->pixel_width
-= it
->continuation_pixel_width
;
16058 else if (row
->truncated_on_right_p
)
16059 row
->pixel_width
-= it
->truncation_pixel_width
;
16060 row
->ascent
= row
->phys_ascent
= 0;
16061 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16062 row
->extra_line_spacing
= 0;
16065 /* Compute a hash code for this row. */
16067 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16068 for (i
= 0; i
< row
->used
[area
]; ++i
)
16069 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16070 + row
->glyphs
[area
][i
].u
.val
16071 + row
->glyphs
[area
][i
].face_id
16072 + row
->glyphs
[area
][i
].padding_p
16073 + (row
->glyphs
[area
][i
].type
<< 2));
16075 it
->max_ascent
= it
->max_descent
= 0;
16076 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16080 /* Append one space to the glyph row of iterator IT if doing a
16081 window-based redisplay. The space has the same face as
16082 IT->face_id. Value is non-zero if a space was added.
16084 This function is called to make sure that there is always one glyph
16085 at the end of a glyph row that the cursor can be set on under
16086 window-systems. (If there weren't such a glyph we would not know
16087 how wide and tall a box cursor should be displayed).
16089 At the same time this space let's a nicely handle clearing to the
16090 end of the line if the row ends in italic text. */
16093 append_space_for_newline (it
, default_face_p
)
16095 int default_face_p
;
16097 if (FRAME_WINDOW_P (it
->f
))
16099 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16101 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16102 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16104 /* Save some values that must not be changed.
16105 Must save IT->c and IT->len because otherwise
16106 ITERATOR_AT_END_P wouldn't work anymore after
16107 append_space_for_newline has been called. */
16108 enum display_element_type saved_what
= it
->what
;
16109 int saved_c
= it
->c
, saved_len
= it
->len
;
16110 int saved_x
= it
->current_x
;
16111 int saved_face_id
= it
->face_id
;
16112 struct text_pos saved_pos
;
16113 Lisp_Object saved_object
;
16116 saved_object
= it
->object
;
16117 saved_pos
= it
->position
;
16119 it
->what
= IT_CHARACTER
;
16120 bzero (&it
->position
, sizeof it
->position
);
16121 it
->object
= make_number (0);
16125 if (default_face_p
)
16126 it
->face_id
= DEFAULT_FACE_ID
;
16127 else if (it
->face_before_selective_p
)
16128 it
->face_id
= it
->saved_face_id
;
16129 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16130 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16132 PRODUCE_GLYPHS (it
);
16134 it
->override_ascent
= -1;
16135 it
->constrain_row_ascent_descent_p
= 0;
16136 it
->current_x
= saved_x
;
16137 it
->object
= saved_object
;
16138 it
->position
= saved_pos
;
16139 it
->what
= saved_what
;
16140 it
->face_id
= saved_face_id
;
16141 it
->len
= saved_len
;
16151 /* Extend the face of the last glyph in the text area of IT->glyph_row
16152 to the end of the display line. Called from display_line.
16153 If the glyph row is empty, add a space glyph to it so that we
16154 know the face to draw. Set the glyph row flag fill_line_p. */
16157 extend_face_to_end_of_line (it
)
16161 struct frame
*f
= it
->f
;
16163 /* If line is already filled, do nothing. */
16164 if (it
->current_x
>= it
->last_visible_x
)
16167 /* Face extension extends the background and box of IT->face_id
16168 to the end of the line. If the background equals the background
16169 of the frame, we don't have to do anything. */
16170 if (it
->face_before_selective_p
)
16171 face
= FACE_FROM_ID (it
->f
, it
->saved_face_id
);
16173 face
= FACE_FROM_ID (f
, it
->face_id
);
16175 if (FRAME_WINDOW_P (f
)
16176 && it
->glyph_row
->displays_text_p
16177 && face
->box
== FACE_NO_BOX
16178 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16182 /* Set the glyph row flag indicating that the face of the last glyph
16183 in the text area has to be drawn to the end of the text area. */
16184 it
->glyph_row
->fill_line_p
= 1;
16186 /* If current character of IT is not ASCII, make sure we have the
16187 ASCII face. This will be automatically undone the next time
16188 get_next_display_element returns a multibyte character. Note
16189 that the character will always be single byte in unibyte
16191 if (!ASCII_CHAR_P (it
->c
))
16193 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16196 if (FRAME_WINDOW_P (f
))
16198 /* If the row is empty, add a space with the current face of IT,
16199 so that we know which face to draw. */
16200 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16202 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16203 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16204 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16209 /* Save some values that must not be changed. */
16210 int saved_x
= it
->current_x
;
16211 struct text_pos saved_pos
;
16212 Lisp_Object saved_object
;
16213 enum display_element_type saved_what
= it
->what
;
16214 int saved_face_id
= it
->face_id
;
16216 saved_object
= it
->object
;
16217 saved_pos
= it
->position
;
16219 it
->what
= IT_CHARACTER
;
16220 bzero (&it
->position
, sizeof it
->position
);
16221 it
->object
= make_number (0);
16224 it
->face_id
= face
->id
;
16226 PRODUCE_GLYPHS (it
);
16228 while (it
->current_x
<= it
->last_visible_x
)
16229 PRODUCE_GLYPHS (it
);
16231 /* Don't count these blanks really. It would let us insert a left
16232 truncation glyph below and make us set the cursor on them, maybe. */
16233 it
->current_x
= saved_x
;
16234 it
->object
= saved_object
;
16235 it
->position
= saved_pos
;
16236 it
->what
= saved_what
;
16237 it
->face_id
= saved_face_id
;
16242 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16243 trailing whitespace. */
16246 trailing_whitespace_p (charpos
)
16249 int bytepos
= CHAR_TO_BYTE (charpos
);
16252 while (bytepos
< ZV_BYTE
16253 && (c
= FETCH_CHAR (bytepos
),
16254 c
== ' ' || c
== '\t'))
16257 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16259 if (bytepos
!= PT_BYTE
)
16266 /* Highlight trailing whitespace, if any, in ROW. */
16269 highlight_trailing_whitespace (f
, row
)
16271 struct glyph_row
*row
;
16273 int used
= row
->used
[TEXT_AREA
];
16277 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16278 struct glyph
*glyph
= start
+ used
- 1;
16280 /* Skip over glyphs inserted to display the cursor at the
16281 end of a line, for extending the face of the last glyph
16282 to the end of the line on terminals, and for truncation
16283 and continuation glyphs. */
16284 while (glyph
>= start
16285 && glyph
->type
== CHAR_GLYPH
16286 && INTEGERP (glyph
->object
))
16289 /* If last glyph is a space or stretch, and it's trailing
16290 whitespace, set the face of all trailing whitespace glyphs in
16291 IT->glyph_row to `trailing-whitespace'. */
16293 && BUFFERP (glyph
->object
)
16294 && (glyph
->type
== STRETCH_GLYPH
16295 || (glyph
->type
== CHAR_GLYPH
16296 && glyph
->u
.ch
== ' '))
16297 && trailing_whitespace_p (glyph
->charpos
))
16299 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
16303 while (glyph
>= start
16304 && BUFFERP (glyph
->object
)
16305 && (glyph
->type
== STRETCH_GLYPH
16306 || (glyph
->type
== CHAR_GLYPH
16307 && glyph
->u
.ch
== ' ')))
16308 (glyph
--)->face_id
= face_id
;
16314 /* Value is non-zero if glyph row ROW in window W should be
16315 used to hold the cursor. */
16318 cursor_row_p (w
, row
)
16320 struct glyph_row
*row
;
16322 int cursor_row_p
= 1;
16324 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
16326 /* Suppose the row ends on a string.
16327 Unless the row is continued, that means it ends on a newline
16328 in the string. If it's anything other than a display string
16329 (e.g. a before-string from an overlay), we don't want the
16330 cursor there. (This heuristic seems to give the optimal
16331 behavior for the various types of multi-line strings.) */
16332 if (CHARPOS (row
->end
.string_pos
) >= 0)
16334 if (row
->continued_p
)
16338 /* Check for `display' property. */
16339 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
16340 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
16341 struct glyph
*glyph
;
16344 for (glyph
= end
; glyph
>= beg
; --glyph
)
16345 if (STRINGP (glyph
->object
))
16348 = Fget_char_property (make_number (PT
),
16352 && display_prop_string_p (prop
, glyph
->object
));
16357 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
16359 /* If the row ends in middle of a real character,
16360 and the line is continued, we want the cursor here.
16361 That's because MATRIX_ROW_END_CHARPOS would equal
16362 PT if PT is before the character. */
16363 if (!row
->ends_in_ellipsis_p
)
16364 cursor_row_p
= row
->continued_p
;
16366 /* If the row ends in an ellipsis, then
16367 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
16368 We want that position to be displayed after the ellipsis. */
16371 /* If the row ends at ZV, display the cursor at the end of that
16372 row instead of at the start of the row below. */
16373 else if (row
->ends_at_zv_p
)
16379 return cursor_row_p
;
16384 /* Push the display property PROP so that it will be rendered at the
16385 current position in IT. Return 1 if PROP was successfully pushed,
16389 push_display_prop (struct it
*it
, Lisp_Object prop
)
16393 if (STRINGP (prop
))
16395 if (SCHARS (prop
) == 0)
16402 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
16403 it
->current
.overlay_string_index
= -1;
16404 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
16405 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
16406 it
->method
= GET_FROM_STRING
;
16407 it
->stop_charpos
= 0;
16409 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
16411 it
->method
= GET_FROM_STRETCH
;
16414 #ifdef HAVE_WINDOW_SYSTEM
16415 else if (IMAGEP (prop
))
16417 it
->what
= IT_IMAGE
;
16418 it
->image_id
= lookup_image (it
->f
, prop
);
16419 it
->method
= GET_FROM_IMAGE
;
16421 #endif /* HAVE_WINDOW_SYSTEM */
16424 pop_it (it
); /* bogus display property, give up */
16431 /* Return the character-property PROP at the current position in IT. */
16434 get_it_property (it
, prop
)
16438 Lisp_Object position
;
16440 if (STRINGP (it
->object
))
16441 position
= make_number (IT_STRING_CHARPOS (*it
));
16442 else if (BUFFERP (it
->object
))
16443 position
= make_number (IT_CHARPOS (*it
));
16447 return Fget_char_property (position
, prop
, it
->object
);
16450 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
16453 handle_line_prefix (struct it
*it
)
16455 Lisp_Object prefix
;
16456 if (it
->continuation_lines_width
> 0)
16458 prefix
= get_it_property (it
, Qwrap_prefix
);
16460 prefix
= Vwrap_prefix
;
16464 prefix
= get_it_property (it
, Qline_prefix
);
16466 prefix
= Vline_prefix
;
16468 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
16470 /* If the prefix is wider than the window, and we try to wrap
16471 it, it would acquire its own wrap prefix, and so on till the
16472 iterator stack overflows. So, don't wrap the prefix. */
16473 it
->line_wrap
= TRUNCATE
;
16474 it
->avoid_cursor_p
= 1;
16480 /* Construct the glyph row IT->glyph_row in the desired matrix of
16481 IT->w from text at the current position of IT. See dispextern.h
16482 for an overview of struct it. Value is non-zero if
16483 IT->glyph_row displays text, as opposed to a line displaying ZV
16490 struct glyph_row
*row
= it
->glyph_row
;
16491 Lisp_Object overlay_arrow_string
;
16493 int may_wrap
= 0, wrap_x
;
16494 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
16495 int wrap_row_phys_ascent
, wrap_row_phys_height
;
16496 int wrap_row_extra_line_spacing
;
16498 /* We always start displaying at hpos zero even if hscrolled. */
16499 xassert (it
->hpos
== 0 && it
->current_x
== 0);
16501 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
16502 >= it
->w
->desired_matrix
->nrows
)
16504 it
->w
->nrows_scale_factor
++;
16505 fonts_changed_p
= 1;
16509 /* Is IT->w showing the region? */
16510 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
16512 /* Clear the result glyph row and enable it. */
16513 prepare_desired_row (row
);
16515 row
->y
= it
->current_y
;
16516 row
->start
= it
->start
;
16517 row
->continuation_lines_width
= it
->continuation_lines_width
;
16518 row
->displays_text_p
= 1;
16519 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
16520 it
->starts_in_middle_of_char_p
= 0;
16522 /* Arrange the overlays nicely for our purposes. Usually, we call
16523 display_line on only one line at a time, in which case this
16524 can't really hurt too much, or we call it on lines which appear
16525 one after another in the buffer, in which case all calls to
16526 recenter_overlay_lists but the first will be pretty cheap. */
16527 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
16529 /* Move over display elements that are not visible because we are
16530 hscrolled. This may stop at an x-position < IT->first_visible_x
16531 if the first glyph is partially visible or if we hit a line end. */
16532 if (it
->current_x
< it
->first_visible_x
)
16534 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
16535 MOVE_TO_POS
| MOVE_TO_X
);
16539 /* We only do this when not calling `move_it_in_display_line_to'
16540 above, because move_it_in_display_line_to calls
16541 handle_line_prefix itself. */
16542 handle_line_prefix (it
);
16545 /* Get the initial row height. This is either the height of the
16546 text hscrolled, if there is any, or zero. */
16547 row
->ascent
= it
->max_ascent
;
16548 row
->height
= it
->max_ascent
+ it
->max_descent
;
16549 row
->phys_ascent
= it
->max_phys_ascent
;
16550 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16551 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16553 /* Loop generating characters. The loop is left with IT on the next
16554 character to display. */
16557 int n_glyphs_before
, hpos_before
, x_before
;
16559 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
16561 /* Retrieve the next thing to display. Value is zero if end of
16563 if (!get_next_display_element (it
))
16565 /* Maybe add a space at the end of this line that is used to
16566 display the cursor there under X. Set the charpos of the
16567 first glyph of blank lines not corresponding to any text
16569 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16570 row
->exact_window_width_line_p
= 1;
16571 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
16572 || row
->used
[TEXT_AREA
] == 0)
16574 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
16575 row
->displays_text_p
= 0;
16577 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
16578 && (!MINI_WINDOW_P (it
->w
)
16579 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
16580 row
->indicate_empty_line_p
= 1;
16583 it
->continuation_lines_width
= 0;
16584 row
->ends_at_zv_p
= 1;
16588 /* Now, get the metrics of what we want to display. This also
16589 generates glyphs in `row' (which is IT->glyph_row). */
16590 n_glyphs_before
= row
->used
[TEXT_AREA
];
16593 /* Remember the line height so far in case the next element doesn't
16594 fit on the line. */
16595 if (it
->line_wrap
!= TRUNCATE
)
16597 ascent
= it
->max_ascent
;
16598 descent
= it
->max_descent
;
16599 phys_ascent
= it
->max_phys_ascent
;
16600 phys_descent
= it
->max_phys_descent
;
16602 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
16604 if (IT_DISPLAYING_WHITESPACE (it
))
16610 wrap_row_used
= row
->used
[TEXT_AREA
];
16611 wrap_row_ascent
= row
->ascent
;
16612 wrap_row_height
= row
->height
;
16613 wrap_row_phys_ascent
= row
->phys_ascent
;
16614 wrap_row_phys_height
= row
->phys_height
;
16615 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
16621 PRODUCE_GLYPHS (it
);
16623 /* If this display element was in marginal areas, continue with
16625 if (it
->area
!= TEXT_AREA
)
16627 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16628 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16629 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16630 row
->phys_height
= max (row
->phys_height
,
16631 it
->max_phys_ascent
+ it
->max_phys_descent
);
16632 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16633 it
->max_extra_line_spacing
);
16634 set_iterator_to_next (it
, 1);
16638 /* Does the display element fit on the line? If we truncate
16639 lines, we should draw past the right edge of the window. If
16640 we don't truncate, we want to stop so that we can display the
16641 continuation glyph before the right margin. If lines are
16642 continued, there are two possible strategies for characters
16643 resulting in more than 1 glyph (e.g. tabs): Display as many
16644 glyphs as possible in this line and leave the rest for the
16645 continuation line, or display the whole element in the next
16646 line. Original redisplay did the former, so we do it also. */
16647 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
16648 hpos_before
= it
->hpos
;
16651 if (/* Not a newline. */
16653 /* Glyphs produced fit entirely in the line. */
16654 && it
->current_x
< it
->last_visible_x
)
16656 it
->hpos
+= nglyphs
;
16657 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16658 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16659 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16660 row
->phys_height
= max (row
->phys_height
,
16661 it
->max_phys_ascent
+ it
->max_phys_descent
);
16662 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16663 it
->max_extra_line_spacing
);
16664 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
16665 row
->x
= x
- it
->first_visible_x
;
16670 struct glyph
*glyph
;
16672 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
16674 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
16675 new_x
= x
+ glyph
->pixel_width
;
16677 if (/* Lines are continued. */
16678 it
->line_wrap
!= TRUNCATE
16679 && (/* Glyph doesn't fit on the line. */
16680 new_x
> it
->last_visible_x
16681 /* Or it fits exactly on a window system frame. */
16682 || (new_x
== it
->last_visible_x
16683 && FRAME_WINDOW_P (it
->f
))))
16685 /* End of a continued line. */
16688 || (new_x
== it
->last_visible_x
16689 && FRAME_WINDOW_P (it
->f
)))
16691 /* Current glyph is the only one on the line or
16692 fits exactly on the line. We must continue
16693 the line because we can't draw the cursor
16694 after the glyph. */
16695 row
->continued_p
= 1;
16696 it
->current_x
= new_x
;
16697 it
->continuation_lines_width
+= new_x
;
16699 if (i
== nglyphs
- 1)
16701 /* If line-wrap is on, check if a previous
16702 wrap point was found. */
16703 if (wrap_row_used
> 0
16704 /* Even if there is a previous wrap
16705 point, continue the line here as
16706 usual, if (i) the previous character
16707 was a space or tab AND (ii) the
16708 current character is not. */
16710 || IT_DISPLAYING_WHITESPACE (it
)))
16713 set_iterator_to_next (it
, 1);
16714 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16716 if (!get_next_display_element (it
))
16718 row
->exact_window_width_line_p
= 1;
16719 it
->continuation_lines_width
= 0;
16720 row
->continued_p
= 0;
16721 row
->ends_at_zv_p
= 1;
16723 else if (ITERATOR_AT_END_OF_LINE_P (it
))
16725 row
->continued_p
= 0;
16726 row
->exact_window_width_line_p
= 1;
16731 else if (CHAR_GLYPH_PADDING_P (*glyph
)
16732 && !FRAME_WINDOW_P (it
->f
))
16734 /* A padding glyph that doesn't fit on this line.
16735 This means the whole character doesn't fit
16737 row
->used
[TEXT_AREA
] = n_glyphs_before
;
16739 /* Fill the rest of the row with continuation
16740 glyphs like in 20.x. */
16741 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
16742 < row
->glyphs
[1 + TEXT_AREA
])
16743 produce_special_glyphs (it
, IT_CONTINUATION
);
16745 row
->continued_p
= 1;
16746 it
->current_x
= x_before
;
16747 it
->continuation_lines_width
+= x_before
;
16749 /* Restore the height to what it was before the
16750 element not fitting on the line. */
16751 it
->max_ascent
= ascent
;
16752 it
->max_descent
= descent
;
16753 it
->max_phys_ascent
= phys_ascent
;
16754 it
->max_phys_descent
= phys_descent
;
16756 else if (wrap_row_used
> 0)
16760 it
->continuation_lines_width
+= wrap_x
;
16761 row
->used
[TEXT_AREA
] = wrap_row_used
;
16762 row
->ascent
= wrap_row_ascent
;
16763 row
->height
= wrap_row_height
;
16764 row
->phys_ascent
= wrap_row_phys_ascent
;
16765 row
->phys_height
= wrap_row_phys_height
;
16766 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
16767 row
->continued_p
= 1;
16768 row
->ends_at_zv_p
= 0;
16769 row
->exact_window_width_line_p
= 0;
16770 it
->continuation_lines_width
+= x
;
16772 /* Make sure that a non-default face is extended
16773 up to the right margin of the window. */
16774 extend_face_to_end_of_line (it
);
16776 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
16778 /* A TAB that extends past the right edge of the
16779 window. This produces a single glyph on
16780 window system frames. We leave the glyph in
16781 this row and let it fill the row, but don't
16782 consume the TAB. */
16783 it
->continuation_lines_width
+= it
->last_visible_x
;
16784 row
->ends_in_middle_of_char_p
= 1;
16785 row
->continued_p
= 1;
16786 glyph
->pixel_width
= it
->last_visible_x
- x
;
16787 it
->starts_in_middle_of_char_p
= 1;
16791 /* Something other than a TAB that draws past
16792 the right edge of the window. Restore
16793 positions to values before the element. */
16794 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
16796 /* Display continuation glyphs. */
16797 if (!FRAME_WINDOW_P (it
->f
))
16798 produce_special_glyphs (it
, IT_CONTINUATION
);
16799 row
->continued_p
= 1;
16801 it
->current_x
= x_before
;
16802 it
->continuation_lines_width
+= x
;
16803 extend_face_to_end_of_line (it
);
16805 if (nglyphs
> 1 && i
> 0)
16807 row
->ends_in_middle_of_char_p
= 1;
16808 it
->starts_in_middle_of_char_p
= 1;
16811 /* Restore the height to what it was before the
16812 element not fitting on the line. */
16813 it
->max_ascent
= ascent
;
16814 it
->max_descent
= descent
;
16815 it
->max_phys_ascent
= phys_ascent
;
16816 it
->max_phys_descent
= phys_descent
;
16821 else if (new_x
> it
->first_visible_x
)
16823 /* Increment number of glyphs actually displayed. */
16826 if (x
< it
->first_visible_x
)
16827 /* Glyph is partially visible, i.e. row starts at
16828 negative X position. */
16829 row
->x
= x
- it
->first_visible_x
;
16833 /* Glyph is completely off the left margin of the
16834 window. This should not happen because of the
16835 move_it_in_display_line at the start of this
16836 function, unless the text display area of the
16837 window is empty. */
16838 xassert (it
->first_visible_x
<= it
->last_visible_x
);
16842 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
16843 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
16844 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
16845 row
->phys_height
= max (row
->phys_height
,
16846 it
->max_phys_ascent
+ it
->max_phys_descent
);
16847 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
16848 it
->max_extra_line_spacing
);
16850 /* End of this display line if row is continued. */
16851 if (row
->continued_p
|| row
->ends_at_zv_p
)
16856 /* Is this a line end? If yes, we're also done, after making
16857 sure that a non-default face is extended up to the right
16858 margin of the window. */
16859 if (ITERATOR_AT_END_OF_LINE_P (it
))
16861 int used_before
= row
->used
[TEXT_AREA
];
16863 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
16865 /* Add a space at the end of the line that is used to
16866 display the cursor there. */
16867 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16868 append_space_for_newline (it
, 0);
16870 /* Extend the face to the end of the line. */
16871 extend_face_to_end_of_line (it
);
16873 /* Make sure we have the position. */
16874 if (used_before
== 0)
16875 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
16877 /* Consume the line end. This skips over invisible lines. */
16878 set_iterator_to_next (it
, 1);
16879 it
->continuation_lines_width
= 0;
16883 /* Proceed with next display element. Note that this skips
16884 over lines invisible because of selective display. */
16885 set_iterator_to_next (it
, 1);
16887 /* If we truncate lines, we are done when the last displayed
16888 glyphs reach past the right margin of the window. */
16889 if (it
->line_wrap
== TRUNCATE
16890 && (FRAME_WINDOW_P (it
->f
)
16891 ? (it
->current_x
>= it
->last_visible_x
)
16892 : (it
->current_x
> it
->last_visible_x
)))
16894 /* Maybe add truncation glyphs. */
16895 if (!FRAME_WINDOW_P (it
->f
))
16899 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
16900 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
16903 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
16905 row
->used
[TEXT_AREA
] = i
;
16906 produce_special_glyphs (it
, IT_TRUNCATION
);
16909 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
16911 /* Don't truncate if we can overflow newline into fringe. */
16912 if (!get_next_display_element (it
))
16914 it
->continuation_lines_width
= 0;
16915 row
->ends_at_zv_p
= 1;
16916 row
->exact_window_width_line_p
= 1;
16919 if (ITERATOR_AT_END_OF_LINE_P (it
))
16921 row
->exact_window_width_line_p
= 1;
16922 goto at_end_of_line
;
16926 row
->truncated_on_right_p
= 1;
16927 it
->continuation_lines_width
= 0;
16928 reseat_at_next_visible_line_start (it
, 0);
16929 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
16930 it
->hpos
= hpos_before
;
16931 it
->current_x
= x_before
;
16936 /* If line is not empty and hscrolled, maybe insert truncation glyphs
16937 at the left window margin. */
16938 if (it
->first_visible_x
16939 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
16941 if (!FRAME_WINDOW_P (it
->f
))
16942 insert_left_trunc_glyphs (it
);
16943 row
->truncated_on_left_p
= 1;
16946 /* If the start of this line is the overlay arrow-position, then
16947 mark this glyph row as the one containing the overlay arrow.
16948 This is clearly a mess with variable size fonts. It would be
16949 better to let it be displayed like cursors under X. */
16950 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
16951 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
16952 !NILP (overlay_arrow_string
)))
16954 /* Overlay arrow in window redisplay is a fringe bitmap. */
16955 if (STRINGP (overlay_arrow_string
))
16957 struct glyph_row
*arrow_row
16958 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
16959 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
16960 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
16961 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
16962 struct glyph
*p2
, *end
;
16964 /* Copy the arrow glyphs. */
16965 while (glyph
< arrow_end
)
16968 /* Throw away padding glyphs. */
16970 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16971 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
16977 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
16982 xassert (INTEGERP (overlay_arrow_string
));
16983 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
16985 overlay_arrow_seen
= 1;
16988 /* Compute pixel dimensions of this line. */
16989 compute_line_metrics (it
);
16991 /* Remember the position at which this line ends. */
16992 row
->end
= it
->current
;
16994 /* Record whether this row ends inside an ellipsis. */
16995 row
->ends_in_ellipsis_p
16996 = (it
->method
== GET_FROM_DISPLAY_VECTOR
16997 && it
->ellipsis_p
);
16999 /* Save fringe bitmaps in this row. */
17000 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17001 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17002 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17003 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17005 it
->left_user_fringe_bitmap
= 0;
17006 it
->left_user_fringe_face_id
= 0;
17007 it
->right_user_fringe_bitmap
= 0;
17008 it
->right_user_fringe_face_id
= 0;
17010 /* Maybe set the cursor. */
17011 if (it
->w
->cursor
.vpos
< 0
17012 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17013 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17014 && cursor_row_p (it
->w
, row
))
17015 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17017 /* Highlight trailing whitespace. */
17018 if (!NILP (Vshow_trailing_whitespace
))
17019 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17021 /* Prepare for the next line. This line starts horizontally at (X
17022 HPOS) = (0 0). Vertical positions are incremented. As a
17023 convenience for the caller, IT->glyph_row is set to the next
17025 it
->current_x
= it
->hpos
= 0;
17026 it
->current_y
+= row
->height
;
17029 it
->start
= it
->current
;
17030 return row
->displays_text_p
;
17035 /***********************************************************************
17037 ***********************************************************************/
17039 /* Redisplay the menu bar in the frame for window W.
17041 The menu bar of X frames that don't have X toolkit support is
17042 displayed in a special window W->frame->menu_bar_window.
17044 The menu bar of terminal frames is treated specially as far as
17045 glyph matrices are concerned. Menu bar lines are not part of
17046 windows, so the update is done directly on the frame matrix rows
17047 for the menu bar. */
17050 display_menu_bar (w
)
17053 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17058 /* Don't do all this for graphical frames. */
17060 if (FRAME_W32_P (f
))
17063 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
17069 if (FRAME_NS_P (f
))
17071 #endif /* HAVE_NS */
17073 #ifdef USE_X_TOOLKIT
17074 xassert (!FRAME_WINDOW_P (f
));
17075 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
17076 it
.first_visible_x
= 0;
17077 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17078 #else /* not USE_X_TOOLKIT */
17079 if (FRAME_WINDOW_P (f
))
17081 /* Menu bar lines are displayed in the desired matrix of the
17082 dummy window menu_bar_window. */
17083 struct window
*menu_w
;
17084 xassert (WINDOWP (f
->menu_bar_window
));
17085 menu_w
= XWINDOW (f
->menu_bar_window
);
17086 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
17088 it
.first_visible_x
= 0;
17089 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
17093 /* This is a TTY frame, i.e. character hpos/vpos are used as
17095 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
17097 it
.first_visible_x
= 0;
17098 it
.last_visible_x
= FRAME_COLS (f
);
17100 #endif /* not USE_X_TOOLKIT */
17102 if (! mode_line_inverse_video
)
17103 /* Force the menu-bar to be displayed in the default face. */
17104 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17106 /* Clear all rows of the menu bar. */
17107 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
17109 struct glyph_row
*row
= it
.glyph_row
+ i
;
17110 clear_glyph_row (row
);
17111 row
->enabled_p
= 1;
17112 row
->full_width_p
= 1;
17115 /* Display all items of the menu bar. */
17116 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
17117 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
17119 Lisp_Object string
;
17121 /* Stop at nil string. */
17122 string
= AREF (items
, i
+ 1);
17126 /* Remember where item was displayed. */
17127 ASET (items
, i
+ 3, make_number (it
.hpos
));
17129 /* Display the item, pad with one space. */
17130 if (it
.current_x
< it
.last_visible_x
)
17131 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
17132 SCHARS (string
) + 1, 0, 0, -1);
17135 /* Fill out the line with spaces. */
17136 if (it
.current_x
< it
.last_visible_x
)
17137 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
17139 /* Compute the total height of the lines. */
17140 compute_line_metrics (&it
);
17145 /***********************************************************************
17147 ***********************************************************************/
17149 /* Redisplay mode lines in the window tree whose root is WINDOW. If
17150 FORCE is non-zero, redisplay mode lines unconditionally.
17151 Otherwise, redisplay only mode lines that are garbaged. Value is
17152 the number of windows whose mode lines were redisplayed. */
17155 redisplay_mode_lines (window
, force
)
17156 Lisp_Object window
;
17161 while (!NILP (window
))
17163 struct window
*w
= XWINDOW (window
);
17165 if (WINDOWP (w
->hchild
))
17166 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
17167 else if (WINDOWP (w
->vchild
))
17168 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
17170 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
17171 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
17173 struct text_pos lpoint
;
17174 struct buffer
*old
= current_buffer
;
17176 /* Set the window's buffer for the mode line display. */
17177 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
17178 set_buffer_internal_1 (XBUFFER (w
->buffer
));
17180 /* Point refers normally to the selected window. For any
17181 other window, set up appropriate value. */
17182 if (!EQ (window
, selected_window
))
17184 struct text_pos pt
;
17186 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
17187 if (CHARPOS (pt
) < BEGV
)
17188 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
17189 else if (CHARPOS (pt
) > (ZV
- 1))
17190 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
17192 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
17195 /* Display mode lines. */
17196 clear_glyph_matrix (w
->desired_matrix
);
17197 if (display_mode_lines (w
))
17200 w
->must_be_updated_p
= 1;
17203 /* Restore old settings. */
17204 set_buffer_internal_1 (old
);
17205 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
17215 /* Display the mode and/or header line of window W. Value is the
17216 sum number of mode lines and header lines displayed. */
17219 display_mode_lines (w
)
17222 Lisp_Object old_selected_window
, old_selected_frame
;
17225 old_selected_frame
= selected_frame
;
17226 selected_frame
= w
->frame
;
17227 old_selected_window
= selected_window
;
17228 XSETWINDOW (selected_window
, w
);
17230 /* These will be set while the mode line specs are processed. */
17231 line_number_displayed
= 0;
17232 w
->column_number_displayed
= Qnil
;
17234 if (WINDOW_WANTS_MODELINE_P (w
))
17236 struct window
*sel_w
= XWINDOW (old_selected_window
);
17238 /* Select mode line face based on the real selected window. */
17239 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
17240 current_buffer
->mode_line_format
);
17244 if (WINDOW_WANTS_HEADER_LINE_P (w
))
17246 display_mode_line (w
, HEADER_LINE_FACE_ID
,
17247 current_buffer
->header_line_format
);
17251 selected_frame
= old_selected_frame
;
17252 selected_window
= old_selected_window
;
17257 /* Display mode or header line of window W. FACE_ID specifies which
17258 line to display; it is either MODE_LINE_FACE_ID or
17259 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
17260 display. Value is the pixel height of the mode/header line
17264 display_mode_line (w
, face_id
, format
)
17266 enum face_id face_id
;
17267 Lisp_Object format
;
17271 int count
= SPECPDL_INDEX ();
17273 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
17274 /* Don't extend on a previously drawn mode-line.
17275 This may happen if called from pos_visible_p. */
17276 it
.glyph_row
->enabled_p
= 0;
17277 prepare_desired_row (it
.glyph_row
);
17279 it
.glyph_row
->mode_line_p
= 1;
17281 if (! mode_line_inverse_video
)
17282 /* Force the mode-line to be displayed in the default face. */
17283 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
17285 record_unwind_protect (unwind_format_mode_line
,
17286 format_mode_line_unwind_data (NULL
, Qnil
, 0));
17288 mode_line_target
= MODE_LINE_DISPLAY
;
17290 /* Temporarily make frame's keyboard the current kboard so that
17291 kboard-local variables in the mode_line_format will get the right
17293 push_kboard (FRAME_KBOARD (it
.f
));
17294 record_unwind_save_match_data ();
17295 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
17298 unbind_to (count
, Qnil
);
17300 /* Fill up with spaces. */
17301 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
17303 compute_line_metrics (&it
);
17304 it
.glyph_row
->full_width_p
= 1;
17305 it
.glyph_row
->continued_p
= 0;
17306 it
.glyph_row
->truncated_on_left_p
= 0;
17307 it
.glyph_row
->truncated_on_right_p
= 0;
17309 /* Make a 3D mode-line have a shadow at its right end. */
17310 face
= FACE_FROM_ID (it
.f
, face_id
);
17311 extend_face_to_end_of_line (&it
);
17312 if (face
->box
!= FACE_NO_BOX
)
17314 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
17315 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
17316 last
->right_box_line_p
= 1;
17319 return it
.glyph_row
->height
;
17322 /* Move element ELT in LIST to the front of LIST.
17323 Return the updated list. */
17326 move_elt_to_front (elt
, list
)
17327 Lisp_Object elt
, list
;
17329 register Lisp_Object tail
, prev
;
17330 register Lisp_Object tem
;
17334 while (CONSP (tail
))
17340 /* Splice out the link TAIL. */
17342 list
= XCDR (tail
);
17344 Fsetcdr (prev
, XCDR (tail
));
17346 /* Now make it the first. */
17347 Fsetcdr (tail
, list
);
17352 tail
= XCDR (tail
);
17356 /* Not found--return unchanged LIST. */
17360 /* Contribute ELT to the mode line for window IT->w. How it
17361 translates into text depends on its data type.
17363 IT describes the display environment in which we display, as usual.
17365 DEPTH is the depth in recursion. It is used to prevent
17366 infinite recursion here.
17368 FIELD_WIDTH is the number of characters the display of ELT should
17369 occupy in the mode line, and PRECISION is the maximum number of
17370 characters to display from ELT's representation. See
17371 display_string for details.
17373 Returns the hpos of the end of the text generated by ELT.
17375 PROPS is a property list to add to any string we encounter.
17377 If RISKY is nonzero, remove (disregard) any properties in any string
17378 we encounter, and ignore :eval and :propertize.
17380 The global variable `mode_line_target' determines whether the
17381 output is passed to `store_mode_line_noprop',
17382 `store_mode_line_string', or `display_string'. */
17385 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
17388 int field_width
, precision
;
17389 Lisp_Object elt
, props
;
17392 int n
= 0, field
, prec
;
17397 elt
= build_string ("*too-deep*");
17401 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
17405 /* A string: output it and check for %-constructs within it. */
17409 if (SCHARS (elt
) > 0
17410 && (!NILP (props
) || risky
))
17412 Lisp_Object oprops
, aelt
;
17413 oprops
= Ftext_properties_at (make_number (0), elt
);
17415 /* If the starting string's properties are not what
17416 we want, translate the string. Also, if the string
17417 is risky, do that anyway. */
17419 if (NILP (Fequal (props
, oprops
)) || risky
)
17421 /* If the starting string has properties,
17422 merge the specified ones onto the existing ones. */
17423 if (! NILP (oprops
) && !risky
)
17427 oprops
= Fcopy_sequence (oprops
);
17429 while (CONSP (tem
))
17431 oprops
= Fplist_put (oprops
, XCAR (tem
),
17432 XCAR (XCDR (tem
)));
17433 tem
= XCDR (XCDR (tem
));
17438 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
17439 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
17441 /* AELT is what we want. Move it to the front
17442 without consing. */
17444 mode_line_proptrans_alist
17445 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
17451 /* If AELT has the wrong props, it is useless.
17452 so get rid of it. */
17454 mode_line_proptrans_alist
17455 = Fdelq (aelt
, mode_line_proptrans_alist
);
17457 elt
= Fcopy_sequence (elt
);
17458 Fset_text_properties (make_number (0), Flength (elt
),
17460 /* Add this item to mode_line_proptrans_alist. */
17461 mode_line_proptrans_alist
17462 = Fcons (Fcons (elt
, props
),
17463 mode_line_proptrans_alist
);
17464 /* Truncate mode_line_proptrans_alist
17465 to at most 50 elements. */
17466 tem
= Fnthcdr (make_number (50),
17467 mode_line_proptrans_alist
);
17469 XSETCDR (tem
, Qnil
);
17478 prec
= precision
- n
;
17479 switch (mode_line_target
)
17481 case MODE_LINE_NOPROP
:
17482 case MODE_LINE_TITLE
:
17483 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
17485 case MODE_LINE_STRING
:
17486 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
17488 case MODE_LINE_DISPLAY
:
17489 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
17490 0, prec
, 0, STRING_MULTIBYTE (elt
));
17497 /* Handle the non-literal case. */
17499 while ((precision
<= 0 || n
< precision
)
17500 && SREF (elt
, offset
) != 0
17501 && (mode_line_target
!= MODE_LINE_DISPLAY
17502 || it
->current_x
< it
->last_visible_x
))
17504 int last_offset
= offset
;
17506 /* Advance to end of string or next format specifier. */
17507 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
17510 if (offset
- 1 != last_offset
)
17512 int nchars
, nbytes
;
17514 /* Output to end of string or up to '%'. Field width
17515 is length of string. Don't output more than
17516 PRECISION allows us. */
17519 prec
= c_string_width (SDATA (elt
) + last_offset
,
17520 offset
- last_offset
, precision
- n
,
17523 switch (mode_line_target
)
17525 case MODE_LINE_NOPROP
:
17526 case MODE_LINE_TITLE
:
17527 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
17529 case MODE_LINE_STRING
:
17531 int bytepos
= last_offset
;
17532 int charpos
= string_byte_to_char (elt
, bytepos
);
17533 int endpos
= (precision
<= 0
17534 ? string_byte_to_char (elt
, offset
)
17535 : charpos
+ nchars
);
17537 n
+= store_mode_line_string (NULL
,
17538 Fsubstring (elt
, make_number (charpos
),
17539 make_number (endpos
)),
17543 case MODE_LINE_DISPLAY
:
17545 int bytepos
= last_offset
;
17546 int charpos
= string_byte_to_char (elt
, bytepos
);
17548 if (precision
<= 0)
17549 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
17550 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
17552 STRING_MULTIBYTE (elt
));
17557 else /* c == '%' */
17559 int percent_position
= offset
;
17561 /* Get the specified minimum width. Zero means
17564 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
17565 field
= field
* 10 + c
- '0';
17567 /* Don't pad beyond the total padding allowed. */
17568 if (field_width
- n
> 0 && field
> field_width
- n
)
17569 field
= field_width
- n
;
17571 /* Note that either PRECISION <= 0 or N < PRECISION. */
17572 prec
= precision
- n
;
17575 n
+= display_mode_element (it
, depth
, field
, prec
,
17576 Vglobal_mode_string
, props
,
17581 int bytepos
, charpos
;
17582 unsigned char *spec
;
17583 Lisp_Object string
;
17585 bytepos
= percent_position
;
17586 charpos
= (STRING_MULTIBYTE (elt
)
17587 ? string_byte_to_char (elt
, bytepos
)
17589 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
17590 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
17592 switch (mode_line_target
)
17594 case MODE_LINE_NOPROP
:
17595 case MODE_LINE_TITLE
:
17596 n
+= store_mode_line_noprop (spec
, field
, prec
);
17598 case MODE_LINE_STRING
:
17600 int len
= strlen (spec
);
17601 Lisp_Object tem
= make_string (spec
, len
);
17602 props
= Ftext_properties_at (make_number (charpos
), elt
);
17603 /* Should only keep face property in props */
17604 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
17607 case MODE_LINE_DISPLAY
:
17609 int nglyphs_before
, nwritten
;
17611 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
17612 nwritten
= display_string (spec
, string
, elt
,
17617 /* Assign to the glyphs written above the
17618 string where the `%x' came from, position
17622 struct glyph
*glyph
17623 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
17627 for (i
= 0; i
< nwritten
; ++i
)
17629 glyph
[i
].object
= elt
;
17630 glyph
[i
].charpos
= charpos
;
17647 /* A symbol: process the value of the symbol recursively
17648 as if it appeared here directly. Avoid error if symbol void.
17649 Special case: if value of symbol is a string, output the string
17652 register Lisp_Object tem
;
17654 /* If the variable is not marked as risky to set
17655 then its contents are risky to use. */
17656 if (NILP (Fget (elt
, Qrisky_local_variable
)))
17659 tem
= Fboundp (elt
);
17662 tem
= Fsymbol_value (elt
);
17663 /* If value is a string, output that string literally:
17664 don't check for % within it. */
17668 if (!EQ (tem
, elt
))
17670 /* Give up right away for nil or t. */
17680 register Lisp_Object car
, tem
;
17682 /* A cons cell: five distinct cases.
17683 If first element is :eval or :propertize, do something special.
17684 If first element is a string or a cons, process all the elements
17685 and effectively concatenate them.
17686 If first element is a negative number, truncate displaying cdr to
17687 at most that many characters. If positive, pad (with spaces)
17688 to at least that many characters.
17689 If first element is a symbol, process the cadr or caddr recursively
17690 according to whether the symbol's value is non-nil or nil. */
17692 if (EQ (car
, QCeval
))
17694 /* An element of the form (:eval FORM) means evaluate FORM
17695 and use the result as mode line elements. */
17700 if (CONSP (XCDR (elt
)))
17703 spec
= safe_eval (XCAR (XCDR (elt
)));
17704 n
+= display_mode_element (it
, depth
, field_width
- n
,
17705 precision
- n
, spec
, props
,
17709 else if (EQ (car
, QCpropertize
))
17711 /* An element of the form (:propertize ELT PROPS...)
17712 means display ELT but applying properties PROPS. */
17717 if (CONSP (XCDR (elt
)))
17718 n
+= display_mode_element (it
, depth
, field_width
- n
,
17719 precision
- n
, XCAR (XCDR (elt
)),
17720 XCDR (XCDR (elt
)), risky
);
17722 else if (SYMBOLP (car
))
17724 tem
= Fboundp (car
);
17728 /* elt is now the cdr, and we know it is a cons cell.
17729 Use its car if CAR has a non-nil value. */
17732 tem
= Fsymbol_value (car
);
17739 /* Symbol's value is nil (or symbol is unbound)
17740 Get the cddr of the original list
17741 and if possible find the caddr and use that. */
17745 else if (!CONSP (elt
))
17750 else if (INTEGERP (car
))
17752 register int lim
= XINT (car
);
17756 /* Negative int means reduce maximum width. */
17757 if (precision
<= 0)
17760 precision
= min (precision
, -lim
);
17764 /* Padding specified. Don't let it be more than
17765 current maximum. */
17767 lim
= min (precision
, lim
);
17769 /* If that's more padding than already wanted, queue it.
17770 But don't reduce padding already specified even if
17771 that is beyond the current truncation point. */
17772 field_width
= max (lim
, field_width
);
17776 else if (STRINGP (car
) || CONSP (car
))
17778 Lisp_Object halftail
= elt
;
17782 && (precision
<= 0 || n
< precision
))
17784 n
+= display_mode_element (it
, depth
,
17785 /* Do padding only after the last
17786 element in the list. */
17787 (! CONSP (XCDR (elt
))
17790 precision
- n
, XCAR (elt
),
17794 if ((len
& 1) == 0)
17795 halftail
= XCDR (halftail
);
17796 /* Check for cycle. */
17797 if (EQ (halftail
, elt
))
17806 elt
= build_string ("*invalid*");
17810 /* Pad to FIELD_WIDTH. */
17811 if (field_width
> 0 && n
< field_width
)
17813 switch (mode_line_target
)
17815 case MODE_LINE_NOPROP
:
17816 case MODE_LINE_TITLE
:
17817 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
17819 case MODE_LINE_STRING
:
17820 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
17822 case MODE_LINE_DISPLAY
:
17823 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
17832 /* Store a mode-line string element in mode_line_string_list.
17834 If STRING is non-null, display that C string. Otherwise, the Lisp
17835 string LISP_STRING is displayed.
17837 FIELD_WIDTH is the minimum number of output glyphs to produce.
17838 If STRING has fewer characters than FIELD_WIDTH, pad to the right
17839 with spaces. FIELD_WIDTH <= 0 means don't pad.
17841 PRECISION is the maximum number of characters to output from
17842 STRING. PRECISION <= 0 means don't truncate the string.
17844 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
17845 properties to the string.
17847 PROPS are the properties to add to the string.
17848 The mode_line_string_face face property is always added to the string.
17852 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
17854 Lisp_Object lisp_string
;
17863 if (string
!= NULL
)
17865 len
= strlen (string
);
17866 if (precision
> 0 && len
> precision
)
17868 lisp_string
= make_string (string
, len
);
17870 props
= mode_line_string_face_prop
;
17871 else if (!NILP (mode_line_string_face
))
17873 Lisp_Object face
= Fplist_get (props
, Qface
);
17874 props
= Fcopy_sequence (props
);
17876 face
= mode_line_string_face
;
17878 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17879 props
= Fplist_put (props
, Qface
, face
);
17881 Fadd_text_properties (make_number (0), make_number (len
),
17882 props
, lisp_string
);
17886 len
= XFASTINT (Flength (lisp_string
));
17887 if (precision
> 0 && len
> precision
)
17890 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
17893 if (!NILP (mode_line_string_face
))
17897 props
= Ftext_properties_at (make_number (0), lisp_string
);
17898 face
= Fplist_get (props
, Qface
);
17900 face
= mode_line_string_face
;
17902 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
17903 props
= Fcons (Qface
, Fcons (face
, Qnil
));
17905 lisp_string
= Fcopy_sequence (lisp_string
);
17908 Fadd_text_properties (make_number (0), make_number (len
),
17909 props
, lisp_string
);
17914 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17918 if (field_width
> len
)
17920 field_width
-= len
;
17921 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
17923 Fadd_text_properties (make_number (0), make_number (field_width
),
17924 props
, lisp_string
);
17925 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
17933 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
17935 doc
: /* Format a string out of a mode line format specification.
17936 First arg FORMAT specifies the mode line format (see `mode-line-format'
17937 for details) to use.
17939 Optional second arg FACE specifies the face property to put
17940 on all characters for which no face is specified.
17941 The value t means whatever face the window's mode line currently uses
17942 \(either `mode-line' or `mode-line-inactive', depending).
17943 A value of nil means the default is no face property.
17944 If FACE is an integer, the value string has no text properties.
17946 Optional third and fourth args WINDOW and BUFFER specify the window
17947 and buffer to use as the context for the formatting (defaults
17948 are the selected window and the window's buffer). */)
17949 (format
, face
, window
, buffer
)
17950 Lisp_Object format
, face
, window
, buffer
;
17955 struct buffer
*old_buffer
= NULL
;
17957 int no_props
= INTEGERP (face
);
17958 int count
= SPECPDL_INDEX ();
17960 int string_start
= 0;
17963 window
= selected_window
;
17964 CHECK_WINDOW (window
);
17965 w
= XWINDOW (window
);
17968 buffer
= w
->buffer
;
17969 CHECK_BUFFER (buffer
);
17971 /* Make formatting the modeline a non-op when noninteractive, otherwise
17972 there will be problems later caused by a partially initialized frame. */
17973 if (NILP (format
) || noninteractive
)
17974 return empty_unibyte_string
;
17982 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
17983 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
17987 face_id
= DEFAULT_FACE_ID
;
17989 if (XBUFFER (buffer
) != current_buffer
)
17990 old_buffer
= current_buffer
;
17992 /* Save things including mode_line_proptrans_alist,
17993 and set that to nil so that we don't alter the outer value. */
17994 record_unwind_protect (unwind_format_mode_line
,
17995 format_mode_line_unwind_data
17996 (old_buffer
, selected_window
, 1));
17997 mode_line_proptrans_alist
= Qnil
;
17999 Fselect_window (window
, Qt
);
18001 set_buffer_internal_1 (XBUFFER (buffer
));
18003 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18007 mode_line_target
= MODE_LINE_NOPROP
;
18008 mode_line_string_face_prop
= Qnil
;
18009 mode_line_string_list
= Qnil
;
18010 string_start
= MODE_LINE_NOPROP_LEN (0);
18014 mode_line_target
= MODE_LINE_STRING
;
18015 mode_line_string_list
= Qnil
;
18016 mode_line_string_face
= face
;
18017 mode_line_string_face_prop
18018 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
18021 push_kboard (FRAME_KBOARD (it
.f
));
18022 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18027 len
= MODE_LINE_NOPROP_LEN (string_start
);
18028 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
18032 mode_line_string_list
= Fnreverse (mode_line_string_list
);
18033 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
18034 empty_unibyte_string
);
18037 unbind_to (count
, Qnil
);
18041 /* Write a null-terminated, right justified decimal representation of
18042 the positive integer D to BUF using a minimal field width WIDTH. */
18045 pint2str (buf
, width
, d
)
18046 register char *buf
;
18047 register int width
;
18050 register char *p
= buf
;
18058 *p
++ = d
% 10 + '0';
18063 for (width
-= (int) (p
- buf
); width
> 0; --width
)
18074 /* Write a null-terminated, right justified decimal and "human
18075 readable" representation of the nonnegative integer D to BUF using
18076 a minimal field width WIDTH. D should be smaller than 999.5e24. */
18078 static const char power_letter
[] =
18092 pint2hrstr (buf
, width
, d
)
18097 /* We aim to represent the nonnegative integer D as
18098 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
18101 /* -1 means: do not use TENTHS. */
18105 /* Length of QUOTIENT.TENTHS as a string. */
18111 if (1000 <= quotient
)
18113 /* Scale to the appropriate EXPONENT. */
18116 remainder
= quotient
% 1000;
18120 while (1000 <= quotient
);
18122 /* Round to nearest and decide whether to use TENTHS or not. */
18125 tenths
= remainder
/ 100;
18126 if (50 <= remainder
% 100)
18133 if (quotient
== 10)
18141 if (500 <= remainder
)
18143 if (quotient
< 999)
18154 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
18155 if (tenths
== -1 && quotient
<= 99)
18162 p
= psuffix
= buf
+ max (width
, length
);
18164 /* Print EXPONENT. */
18166 *psuffix
++ = power_letter
[exponent
];
18169 /* Print TENTHS. */
18172 *--p
= '0' + tenths
;
18176 /* Print QUOTIENT. */
18179 int digit
= quotient
% 10;
18180 *--p
= '0' + digit
;
18182 while ((quotient
/= 10) != 0);
18184 /* Print leading spaces. */
18189 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
18190 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
18191 type of CODING_SYSTEM. Return updated pointer into BUF. */
18193 static unsigned char invalid_eol_type
[] = "(*invalid*)";
18196 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
18197 Lisp_Object coding_system
;
18198 register char *buf
;
18202 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
18203 const unsigned char *eol_str
;
18205 /* The EOL conversion we are using. */
18206 Lisp_Object eoltype
;
18208 val
= CODING_SYSTEM_SPEC (coding_system
);
18211 if (!VECTORP (val
)) /* Not yet decided. */
18216 eoltype
= eol_mnemonic_undecided
;
18217 /* Don't mention EOL conversion if it isn't decided. */
18222 Lisp_Object eolvalue
;
18224 attrs
= AREF (val
, 0);
18225 eolvalue
= AREF (val
, 2);
18228 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
18232 /* The EOL conversion that is normal on this system. */
18234 if (NILP (eolvalue
)) /* Not yet decided. */
18235 eoltype
= eol_mnemonic_undecided
;
18236 else if (VECTORP (eolvalue
)) /* Not yet decided. */
18237 eoltype
= eol_mnemonic_undecided
;
18238 else /* eolvalue is Qunix, Qdos, or Qmac. */
18239 eoltype
= (EQ (eolvalue
, Qunix
)
18240 ? eol_mnemonic_unix
18241 : (EQ (eolvalue
, Qdos
) == 1
18242 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
18248 /* Mention the EOL conversion if it is not the usual one. */
18249 if (STRINGP (eoltype
))
18251 eol_str
= SDATA (eoltype
);
18252 eol_str_len
= SBYTES (eoltype
);
18254 else if (CHARACTERP (eoltype
))
18256 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
18257 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
18262 eol_str
= invalid_eol_type
;
18263 eol_str_len
= sizeof (invalid_eol_type
) - 1;
18265 bcopy (eol_str
, buf
, eol_str_len
);
18266 buf
+= eol_str_len
;
18272 /* Return a string for the output of a mode line %-spec for window W,
18273 generated by character C. PRECISION >= 0 means don't return a
18274 string longer than that value. FIELD_WIDTH > 0 means pad the
18275 string returned with spaces to that value. Return a Lisp string in
18276 *STRING if the resulting string is taken from that Lisp string.
18278 Note we operate on the current buffer for most purposes,
18279 the exception being w->base_line_pos. */
18281 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
18284 decode_mode_spec (w
, c
, field_width
, precision
, string
)
18287 int field_width
, precision
;
18288 Lisp_Object
*string
;
18291 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18292 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
18293 struct buffer
*b
= current_buffer
;
18301 if (!NILP (b
->read_only
))
18303 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18308 /* This differs from %* only for a modified read-only buffer. */
18309 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18311 if (!NILP (b
->read_only
))
18316 /* This differs from %* in ignoring read-only-ness. */
18317 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
18329 if (command_loop_level
> 5)
18331 p
= decode_mode_spec_buf
;
18332 for (i
= 0; i
< command_loop_level
; i
++)
18335 return decode_mode_spec_buf
;
18343 if (command_loop_level
> 5)
18345 p
= decode_mode_spec_buf
;
18346 for (i
= 0; i
< command_loop_level
; i
++)
18349 return decode_mode_spec_buf
;
18356 /* Let lots_of_dashes be a string of infinite length. */
18357 if (mode_line_target
== MODE_LINE_NOPROP
||
18358 mode_line_target
== MODE_LINE_STRING
)
18360 if (field_width
<= 0
18361 || field_width
> sizeof (lots_of_dashes
))
18363 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
18364 decode_mode_spec_buf
[i
] = '-';
18365 decode_mode_spec_buf
[i
] = '\0';
18366 return decode_mode_spec_buf
;
18369 return lots_of_dashes
;
18377 /* %c and %l are ignored in `frame-title-format'.
18378 (In redisplay_internal, the frame title is drawn _before_ the
18379 windows are updated, so the stuff which depends on actual
18380 window contents (such as %l) may fail to render properly, or
18381 even crash emacs.) */
18382 if (mode_line_target
== MODE_LINE_TITLE
)
18386 int col
= (int) current_column (); /* iftc */
18387 w
->column_number_displayed
= make_number (col
);
18388 pint2str (decode_mode_spec_buf
, field_width
, col
);
18389 return decode_mode_spec_buf
;
18393 #ifndef SYSTEM_MALLOC
18395 if (NILP (Vmemory_full
))
18398 return "!MEM FULL! ";
18405 /* %F displays the frame name. */
18406 if (!NILP (f
->title
))
18407 return (char *) SDATA (f
->title
);
18408 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
18409 return (char *) SDATA (f
->name
);
18418 int size
= ZV
- BEGV
;
18419 pint2str (decode_mode_spec_buf
, field_width
, size
);
18420 return decode_mode_spec_buf
;
18425 int size
= ZV
- BEGV
;
18426 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
18427 return decode_mode_spec_buf
;
18432 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
18433 int topline
, nlines
, junk
, height
;
18435 /* %c and %l are ignored in `frame-title-format'. */
18436 if (mode_line_target
== MODE_LINE_TITLE
)
18439 startpos
= XMARKER (w
->start
)->charpos
;
18440 startpos_byte
= marker_byte_position (w
->start
);
18441 height
= WINDOW_TOTAL_LINES (w
);
18443 /* If we decided that this buffer isn't suitable for line numbers,
18444 don't forget that too fast. */
18445 if (EQ (w
->base_line_pos
, w
->buffer
))
18447 /* But do forget it, if the window shows a different buffer now. */
18448 else if (BUFFERP (w
->base_line_pos
))
18449 w
->base_line_pos
= Qnil
;
18451 /* If the buffer is very big, don't waste time. */
18452 if (INTEGERP (Vline_number_display_limit
)
18453 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
18455 w
->base_line_pos
= Qnil
;
18456 w
->base_line_number
= Qnil
;
18460 if (INTEGERP (w
->base_line_number
)
18461 && INTEGERP (w
->base_line_pos
)
18462 && XFASTINT (w
->base_line_pos
) <= startpos
)
18464 line
= XFASTINT (w
->base_line_number
);
18465 linepos
= XFASTINT (w
->base_line_pos
);
18466 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
18471 linepos
= BUF_BEGV (b
);
18472 linepos_byte
= BUF_BEGV_BYTE (b
);
18475 /* Count lines from base line to window start position. */
18476 nlines
= display_count_lines (linepos
, linepos_byte
,
18480 topline
= nlines
+ line
;
18482 /* Determine a new base line, if the old one is too close
18483 or too far away, or if we did not have one.
18484 "Too close" means it's plausible a scroll-down would
18485 go back past it. */
18486 if (startpos
== BUF_BEGV (b
))
18488 w
->base_line_number
= make_number (topline
);
18489 w
->base_line_pos
= make_number (BUF_BEGV (b
));
18491 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
18492 || linepos
== BUF_BEGV (b
))
18494 int limit
= BUF_BEGV (b
);
18495 int limit_byte
= BUF_BEGV_BYTE (b
);
18497 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
18499 if (startpos
- distance
> limit
)
18501 limit
= startpos
- distance
;
18502 limit_byte
= CHAR_TO_BYTE (limit
);
18505 nlines
= display_count_lines (startpos
, startpos_byte
,
18507 - (height
* 2 + 30),
18509 /* If we couldn't find the lines we wanted within
18510 line_number_display_limit_width chars per line,
18511 give up on line numbers for this window. */
18512 if (position
== limit_byte
&& limit
== startpos
- distance
)
18514 w
->base_line_pos
= w
->buffer
;
18515 w
->base_line_number
= Qnil
;
18519 w
->base_line_number
= make_number (topline
- nlines
);
18520 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
18523 /* Now count lines from the start pos to point. */
18524 nlines
= display_count_lines (startpos
, startpos_byte
,
18525 PT_BYTE
, PT
, &junk
);
18527 /* Record that we did display the line number. */
18528 line_number_displayed
= 1;
18530 /* Make the string to show. */
18531 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
18532 return decode_mode_spec_buf
;
18535 char* p
= decode_mode_spec_buf
;
18536 int pad
= field_width
- 2;
18542 return decode_mode_spec_buf
;
18548 obj
= b
->mode_name
;
18552 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
18558 int pos
= marker_position (w
->start
);
18559 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18561 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
18563 if (pos
<= BUF_BEGV (b
))
18568 else if (pos
<= BUF_BEGV (b
))
18572 if (total
> 1000000)
18573 /* Do it differently for a large value, to avoid overflow. */
18574 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18576 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18577 /* We can't normally display a 3-digit number,
18578 so get us a 2-digit number that is close. */
18581 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18582 return decode_mode_spec_buf
;
18586 /* Display percentage of size above the bottom of the screen. */
18589 int toppos
= marker_position (w
->start
);
18590 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
18591 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
18593 if (botpos
>= BUF_ZV (b
))
18595 if (toppos
<= BUF_BEGV (b
))
18602 if (total
> 1000000)
18603 /* Do it differently for a large value, to avoid overflow. */
18604 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
18606 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
18607 /* We can't normally display a 3-digit number,
18608 so get us a 2-digit number that is close. */
18611 if (toppos
<= BUF_BEGV (b
))
18612 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
18614 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
18615 return decode_mode_spec_buf
;
18620 /* status of process */
18621 obj
= Fget_buffer_process (Fcurrent_buffer ());
18623 return "no process";
18624 #ifdef subprocesses
18625 obj
= Fsymbol_name (Fprocess_status (obj
));
18631 int count
= inhibit_garbage_collection ();
18632 Lisp_Object val
= call1 (intern ("file-remote-p"),
18633 current_buffer
->directory
);
18634 unbind_to (count
, Qnil
);
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
;
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. There's a case that STRING is
18812 non-null and LISP_STRING is not nil. It means STRING is a string
18813 data of LISP_STRING. In that case, we display LISP_STRING while
18814 ignoring its text properties.
18816 If FACE_STRING is not nil, FACE_STRING_POS is a position in
18817 FACE_STRING. Display STRING or LISP_STRING with the face at
18818 FACE_STRING_POS in FACE_STRING:
18820 Display the string in the environment given by IT, but use the
18821 standard display table, temporarily.
18823 FIELD_WIDTH is the minimum number of output glyphs to produce.
18824 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18825 with spaces. If STRING has more characters, more than FIELD_WIDTH
18826 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
18828 PRECISION is the maximum number of characters to output from
18829 STRING. PRECISION < 0 means don't truncate the string.
18831 This is roughly equivalent to printf format specifiers:
18833 FIELD_WIDTH PRECISION PRINTF
18834 ----------------------------------------
18840 MULTIBYTE zero means do not display multibyte chars, > 0 means do
18841 display them, and < 0 means obey the current buffer's value of
18842 enable_multibyte_characters.
18844 Value is the number of columns displayed. */
18847 display_string (string
, lisp_string
, face_string
, face_string_pos
,
18848 start
, it
, field_width
, precision
, max_x
, multibyte
)
18849 unsigned char *string
;
18850 Lisp_Object lisp_string
;
18851 Lisp_Object face_string
;
18852 EMACS_INT face_string_pos
;
18855 int field_width
, precision
, max_x
;
18858 int hpos_at_start
= it
->hpos
;
18859 int saved_face_id
= it
->face_id
;
18860 struct glyph_row
*row
= it
->glyph_row
;
18862 /* Initialize the iterator IT for iteration over STRING beginning
18863 with index START. */
18864 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
18865 precision
, field_width
, multibyte
);
18866 if (string
&& STRINGP (lisp_string
))
18867 /* LISP_STRING is the one returned by decode_mode_spec. We should
18868 ignore its text properties. */
18869 it
->stop_charpos
= -1;
18871 /* If displaying STRING, set up the face of the iterator
18872 from LISP_STRING, if that's given. */
18873 if (STRINGP (face_string
))
18879 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
18880 0, it
->region_beg_charpos
,
18881 it
->region_end_charpos
,
18882 &endptr
, it
->base_face_id
, 0);
18883 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18884 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
18887 /* Set max_x to the maximum allowed X position. Don't let it go
18888 beyond the right edge of the window. */
18890 max_x
= it
->last_visible_x
;
18892 max_x
= min (max_x
, it
->last_visible_x
);
18894 /* Skip over display elements that are not visible. because IT->w is
18896 if (it
->current_x
< it
->first_visible_x
)
18897 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
18898 MOVE_TO_POS
| MOVE_TO_X
);
18900 row
->ascent
= it
->max_ascent
;
18901 row
->height
= it
->max_ascent
+ it
->max_descent
;
18902 row
->phys_ascent
= it
->max_phys_ascent
;
18903 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18904 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18906 /* This condition is for the case that we are called with current_x
18907 past last_visible_x. */
18908 while (it
->current_x
< max_x
)
18910 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
18912 /* Get the next display element. */
18913 if (!get_next_display_element (it
))
18916 /* Produce glyphs. */
18917 x_before
= it
->current_x
;
18918 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18919 PRODUCE_GLYPHS (it
);
18921 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
18924 while (i
< nglyphs
)
18926 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18928 if (it
->line_wrap
!= TRUNCATE
18929 && x
+ glyph
->pixel_width
> max_x
)
18931 /* End of continued line or max_x reached. */
18932 if (CHAR_GLYPH_PADDING_P (*glyph
))
18934 /* A wide character is unbreakable. */
18935 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18936 it
->current_x
= x_before
;
18940 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18945 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
18947 /* Glyph is at least partially visible. */
18949 if (x
< it
->first_visible_x
)
18950 it
->glyph_row
->x
= x
- it
->first_visible_x
;
18954 /* Glyph is off the left margin of the display area.
18955 Should not happen. */
18959 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18960 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18961 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18962 row
->phys_height
= max (row
->phys_height
,
18963 it
->max_phys_ascent
+ it
->max_phys_descent
);
18964 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18965 it
->max_extra_line_spacing
);
18966 x
+= glyph
->pixel_width
;
18970 /* Stop if max_x reached. */
18974 /* Stop at line ends. */
18975 if (ITERATOR_AT_END_OF_LINE_P (it
))
18977 it
->continuation_lines_width
= 0;
18981 set_iterator_to_next (it
, 1);
18983 /* Stop if truncating at the right edge. */
18984 if (it
->line_wrap
== TRUNCATE
18985 && it
->current_x
>= it
->last_visible_x
)
18987 /* Add truncation mark, but don't do it if the line is
18988 truncated at a padding space. */
18989 if (IT_CHARPOS (*it
) < it
->string_nchars
)
18991 if (!FRAME_WINDOW_P (it
->f
))
18995 if (it
->current_x
> it
->last_visible_x
)
18997 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18998 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19000 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19002 row
->used
[TEXT_AREA
] = i
;
19003 produce_special_glyphs (it
, IT_TRUNCATION
);
19006 produce_special_glyphs (it
, IT_TRUNCATION
);
19008 it
->glyph_row
->truncated_on_right_p
= 1;
19014 /* Maybe insert a truncation at the left. */
19015 if (it
->first_visible_x
19016 && IT_CHARPOS (*it
) > 0)
19018 if (!FRAME_WINDOW_P (it
->f
))
19019 insert_left_trunc_glyphs (it
);
19020 it
->glyph_row
->truncated_on_left_p
= 1;
19023 it
->face_id
= saved_face_id
;
19025 /* Value is number of columns displayed. */
19026 return it
->hpos
- hpos_at_start
;
19031 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
19032 appears as an element of LIST or as the car of an element of LIST.
19033 If PROPVAL is a list, compare each element against LIST in that
19034 way, and return 1/2 if any element of PROPVAL is found in LIST.
19035 Otherwise return 0. This function cannot quit.
19036 The return value is 2 if the text is invisible but with an ellipsis
19037 and 1 if it's invisible and without an ellipsis. */
19040 invisible_p (propval
, list
)
19041 register Lisp_Object propval
;
19044 register Lisp_Object tail
, proptail
;
19046 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19048 register Lisp_Object tem
;
19050 if (EQ (propval
, tem
))
19052 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
19053 return NILP (XCDR (tem
)) ? 1 : 2;
19056 if (CONSP (propval
))
19058 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
19060 Lisp_Object propelt
;
19061 propelt
= XCAR (proptail
);
19062 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
19064 register Lisp_Object tem
;
19066 if (EQ (propelt
, tem
))
19068 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
19069 return NILP (XCDR (tem
)) ? 1 : 2;
19077 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
19078 doc
: /* Non-nil if the property makes the text invisible.
19079 POS-OR-PROP can be a marker or number, in which case it is taken to be
19080 a position in the current buffer and the value of the `invisible' property
19081 is checked; or it can be some other value, which is then presumed to be the
19082 value of the `invisible' property of the text of interest.
19083 The non-nil value returned can be t for truly invisible text or something
19084 else if the text is replaced by an ellipsis. */)
19086 Lisp_Object pos_or_prop
;
19089 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
19090 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
19092 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
19093 return (invis
== 0 ? Qnil
19095 : make_number (invis
));
19098 /* Calculate a width or height in pixels from a specification using
19099 the following elements:
19102 NUM - a (fractional) multiple of the default font width/height
19103 (NUM) - specifies exactly NUM pixels
19104 UNIT - a fixed number of pixels, see below.
19105 ELEMENT - size of a display element in pixels, see below.
19106 (NUM . SPEC) - equals NUM * SPEC
19107 (+ SPEC SPEC ...) - add pixel values
19108 (- SPEC SPEC ...) - subtract pixel values
19109 (- SPEC) - negate pixel value
19112 INT or FLOAT - a number constant
19113 SYMBOL - use symbol's (buffer local) variable binding.
19116 in - pixels per inch *)
19117 mm - pixels per 1/1000 meter *)
19118 cm - pixels per 1/100 meter *)
19119 width - width of current font in pixels.
19120 height - height of current font in pixels.
19122 *) using the ratio(s) defined in display-pixels-per-inch.
19126 left-fringe - left fringe width in pixels
19127 right-fringe - right fringe width in pixels
19129 left-margin - left margin width in pixels
19130 right-margin - right margin width in pixels
19132 scroll-bar - scroll-bar area width in pixels
19136 Pixels corresponding to 5 inches:
19139 Total width of non-text areas on left side of window (if scroll-bar is on left):
19140 '(space :width (+ left-fringe left-margin scroll-bar))
19142 Align to first text column (in header line):
19143 '(space :align-to 0)
19145 Align to middle of text area minus half the width of variable `my-image'
19146 containing a loaded image:
19147 '(space :align-to (0.5 . (- text my-image)))
19149 Width of left margin minus width of 1 character in the default font:
19150 '(space :width (- left-margin 1))
19152 Width of left margin minus width of 2 characters in the current font:
19153 '(space :width (- left-margin (2 . width)))
19155 Center 1 character over left-margin (in header line):
19156 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
19158 Different ways to express width of left fringe plus left margin minus one pixel:
19159 '(space :width (- (+ left-fringe left-margin) (1)))
19160 '(space :width (+ left-fringe left-margin (- (1))))
19161 '(space :width (+ left-fringe left-margin (-1)))
19165 #define NUMVAL(X) \
19166 ((INTEGERP (X) || FLOATP (X)) \
19171 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
19176 int width_p
, *align_to
;
19180 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
19181 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
19184 return OK_PIXELS (0);
19186 xassert (FRAME_LIVE_P (it
->f
));
19188 if (SYMBOLP (prop
))
19190 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
19192 char *unit
= SDATA (SYMBOL_NAME (prop
));
19194 if (unit
[0] == 'i' && unit
[1] == 'n')
19196 else if (unit
[0] == 'm' && unit
[1] == 'm')
19198 else if (unit
[0] == 'c' && unit
[1] == 'm')
19205 #ifdef HAVE_WINDOW_SYSTEM
19206 if (FRAME_WINDOW_P (it
->f
)
19208 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
19209 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
19211 return OK_PIXELS (ppi
/ pixels
);
19214 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
19215 || (CONSP (Vdisplay_pixels_per_inch
)
19217 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
19218 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
19220 return OK_PIXELS (ppi
/ pixels
);
19226 #ifdef HAVE_WINDOW_SYSTEM
19227 if (EQ (prop
, Qheight
))
19228 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
19229 if (EQ (prop
, Qwidth
))
19230 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
19232 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
19233 return OK_PIXELS (1);
19236 if (EQ (prop
, Qtext
))
19237 return OK_PIXELS (width_p
19238 ? window_box_width (it
->w
, TEXT_AREA
)
19239 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
19241 if (align_to
&& *align_to
< 0)
19244 if (EQ (prop
, Qleft
))
19245 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
19246 if (EQ (prop
, Qright
))
19247 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
19248 if (EQ (prop
, Qcenter
))
19249 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
19250 + window_box_width (it
->w
, TEXT_AREA
) / 2);
19251 if (EQ (prop
, Qleft_fringe
))
19252 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19253 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
19254 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
19255 if (EQ (prop
, Qright_fringe
))
19256 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19257 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19258 : window_box_right_offset (it
->w
, TEXT_AREA
));
19259 if (EQ (prop
, Qleft_margin
))
19260 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
19261 if (EQ (prop
, Qright_margin
))
19262 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
19263 if (EQ (prop
, Qscroll_bar
))
19264 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
19266 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
19267 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
19268 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
19273 if (EQ (prop
, Qleft_fringe
))
19274 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
19275 if (EQ (prop
, Qright_fringe
))
19276 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
19277 if (EQ (prop
, Qleft_margin
))
19278 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
19279 if (EQ (prop
, Qright_margin
))
19280 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
19281 if (EQ (prop
, Qscroll_bar
))
19282 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
19285 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
19288 if (INTEGERP (prop
) || FLOATP (prop
))
19290 int base_unit
= (width_p
19291 ? FRAME_COLUMN_WIDTH (it
->f
)
19292 : FRAME_LINE_HEIGHT (it
->f
));
19293 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
19298 Lisp_Object car
= XCAR (prop
);
19299 Lisp_Object cdr
= XCDR (prop
);
19303 #ifdef HAVE_WINDOW_SYSTEM
19304 if (FRAME_WINDOW_P (it
->f
)
19305 && valid_image_p (prop
))
19307 int id
= lookup_image (it
->f
, prop
);
19308 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
19310 return OK_PIXELS (width_p
? img
->width
: img
->height
);
19313 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
19319 while (CONSP (cdr
))
19321 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
19322 font
, width_p
, align_to
))
19325 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
19330 if (EQ (car
, Qminus
))
19332 return OK_PIXELS (pixels
);
19335 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
19338 if (INTEGERP (car
) || FLOATP (car
))
19341 pixels
= XFLOATINT (car
);
19343 return OK_PIXELS (pixels
);
19344 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
19345 font
, width_p
, align_to
))
19346 return OK_PIXELS (pixels
* fact
);
19357 /***********************************************************************
19359 ***********************************************************************/
19361 #ifdef HAVE_WINDOW_SYSTEM
19366 dump_glyph_string (s
)
19367 struct glyph_string
*s
;
19369 fprintf (stderr
, "glyph string\n");
19370 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
19371 s
->x
, s
->y
, s
->width
, s
->height
);
19372 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
19373 fprintf (stderr
, " hl = %d\n", s
->hl
);
19374 fprintf (stderr
, " left overhang = %d, right = %d\n",
19375 s
->left_overhang
, s
->right_overhang
);
19376 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
19377 fprintf (stderr
, " extends to end of line = %d\n",
19378 s
->extends_to_end_of_line_p
);
19379 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
19380 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
19383 #endif /* GLYPH_DEBUG */
19385 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
19386 of XChar2b structures for S; it can't be allocated in
19387 init_glyph_string because it must be allocated via `alloca'. W
19388 is the window on which S is drawn. ROW and AREA are the glyph row
19389 and area within the row from which S is constructed. START is the
19390 index of the first glyph structure covered by S. HL is a
19391 face-override for drawing S. */
19394 #define OPTIONAL_HDC(hdc) hdc,
19395 #define DECLARE_HDC(hdc) HDC hdc;
19396 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
19397 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
19400 #ifndef OPTIONAL_HDC
19401 #define OPTIONAL_HDC(hdc)
19402 #define DECLARE_HDC(hdc)
19403 #define ALLOCATE_HDC(hdc, f)
19404 #define RELEASE_HDC(hdc, f)
19408 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
19409 struct glyph_string
*s
;
19413 struct glyph_row
*row
;
19414 enum glyph_row_area area
;
19416 enum draw_glyphs_face hl
;
19418 bzero (s
, sizeof *s
);
19420 s
->f
= XFRAME (w
->frame
);
19424 s
->display
= FRAME_X_DISPLAY (s
->f
);
19425 s
->window
= FRAME_X_WINDOW (s
->f
);
19426 s
->char2b
= char2b
;
19430 s
->first_glyph
= row
->glyphs
[area
] + start
;
19431 s
->height
= row
->height
;
19432 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
19433 s
->ybase
= s
->y
+ row
->ascent
;
19437 /* Append the list of glyph strings with head H and tail T to the list
19438 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
19441 append_glyph_string_lists (head
, tail
, h
, t
)
19442 struct glyph_string
**head
, **tail
;
19443 struct glyph_string
*h
, *t
;
19457 /* Prepend the list of glyph strings with head H and tail T to the
19458 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
19462 prepend_glyph_string_lists (head
, tail
, h
, t
)
19463 struct glyph_string
**head
, **tail
;
19464 struct glyph_string
*h
, *t
;
19478 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
19479 Set *HEAD and *TAIL to the resulting list. */
19482 append_glyph_string (head
, tail
, s
)
19483 struct glyph_string
**head
, **tail
;
19484 struct glyph_string
*s
;
19486 s
->next
= s
->prev
= NULL
;
19487 append_glyph_string_lists (head
, tail
, s
, s
);
19491 /* Get face and two-byte form of character C in face FACE_ID on frame
19492 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
19493 means we want to display multibyte text. DISPLAY_P non-zero means
19494 make sure that X resources for the face returned are allocated.
19495 Value is a pointer to a realized face that is ready for display if
19496 DISPLAY_P is non-zero. */
19498 static INLINE
struct face
*
19499 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
19503 int multibyte_p
, display_p
;
19505 struct face
*face
= FACE_FROM_ID (f
, face_id
);
19509 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
19511 if (code
!= FONT_INVALID_CODE
)
19512 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19514 STORE_XCHAR2B (char2b
, 0, 0);
19517 /* Make sure X resources of the face are allocated. */
19518 #ifdef HAVE_X_WINDOWS
19522 xassert (face
!= NULL
);
19523 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19530 /* Get face and two-byte form of character glyph GLYPH on frame F.
19531 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
19532 a pointer to a realized face that is ready for display. */
19534 static INLINE
struct face
*
19535 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
19537 struct glyph
*glyph
;
19543 xassert (glyph
->type
== CHAR_GLYPH
);
19544 face
= FACE_FROM_ID (f
, glyph
->face_id
);
19551 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
19553 if (code
!= FONT_INVALID_CODE
)
19554 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
19556 STORE_XCHAR2B (char2b
, 0, 0);
19559 /* Make sure X resources of the face are allocated. */
19560 xassert (face
!= NULL
);
19561 PREPARE_FACE_FOR_DISPLAY (f
, face
);
19566 /* Fill glyph string S with composition components specified by S->cmp.
19568 BASE_FACE is the base face of the composition.
19569 S->cmp_from is the index of the first component for S.
19571 OVERLAPS non-zero means S should draw the foreground only, and use
19572 its physical height for clipping. See also draw_glyphs.
19574 Value is the index of a component not in S. */
19577 fill_composite_glyph_string (s
, base_face
, overlaps
)
19578 struct glyph_string
*s
;
19579 struct face
*base_face
;
19583 /* For all glyphs of this composition, starting at the offset
19584 S->cmp_from, until we reach the end of the definition or encounter a
19585 glyph that requires the different face, add it to S. */
19590 s
->for_overlaps
= overlaps
;
19593 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
19595 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
19599 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
19602 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
19603 s
->char2b
+ i
, 1, 1);
19609 s
->font
= s
->face
->font
;
19611 else if (s
->face
!= face
)
19619 /* All glyph strings for the same composition has the same width,
19620 i.e. the width set for the first component of the composition. */
19621 s
->width
= s
->first_glyph
->pixel_width
;
19623 /* If the specified font could not be loaded, use the frame's
19624 default font, but record the fact that we couldn't load it in
19625 the glyph string so that we can draw rectangles for the
19626 characters of the glyph string. */
19627 if (s
->font
== NULL
)
19629 s
->font_not_found_p
= 1;
19630 s
->font
= FRAME_FONT (s
->f
);
19633 /* Adjust base line for subscript/superscript text. */
19634 s
->ybase
+= s
->first_glyph
->voffset
;
19636 /* This glyph string must always be drawn with 16-bit functions. */
19643 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
19644 struct glyph_string
*s
;
19646 int start
, end
, overlaps
;
19648 struct glyph
*glyph
, *last
;
19649 Lisp_Object lgstring
;
19652 s
->for_overlaps
= overlaps
;
19653 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19654 last
= s
->row
->glyphs
[s
->area
] + end
;
19655 s
->cmp_id
= glyph
->u
.cmp
.id
;
19656 s
->cmp_from
= glyph
->u
.cmp
.from
;
19657 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
19658 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19659 lgstring
= composition_gstring_from_id (s
->cmp_id
);
19660 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
19662 while (glyph
< last
19663 && glyph
->u
.cmp
.automatic
19664 && glyph
->u
.cmp
.id
== s
->cmp_id
19665 && s
->cmp_to
== glyph
->u
.cmp
.from
)
19666 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
19668 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
19670 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
19671 unsigned code
= LGLYPH_CODE (lglyph
);
19673 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
19675 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
19676 return glyph
- s
->row
->glyphs
[s
->area
];
19680 /* Fill glyph string S from a sequence of character glyphs.
19682 FACE_ID is the face id of the string. START is the index of the
19683 first glyph to consider, END is the index of the last + 1.
19684 OVERLAPS non-zero means S should draw the foreground only, and use
19685 its physical height for clipping. See also draw_glyphs.
19687 Value is the index of the first glyph not in S. */
19690 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
19691 struct glyph_string
*s
;
19693 int start
, end
, overlaps
;
19695 struct glyph
*glyph
, *last
;
19697 int glyph_not_available_p
;
19699 xassert (s
->f
== XFRAME (s
->w
->frame
));
19700 xassert (s
->nchars
== 0);
19701 xassert (start
>= 0 && end
> start
);
19703 s
->for_overlaps
= overlaps
;
19704 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19705 last
= s
->row
->glyphs
[s
->area
] + end
;
19706 voffset
= glyph
->voffset
;
19707 s
->padding_p
= glyph
->padding_p
;
19708 glyph_not_available_p
= glyph
->glyph_not_available_p
;
19710 while (glyph
< last
19711 && glyph
->type
== CHAR_GLYPH
19712 && glyph
->voffset
== voffset
19713 /* Same face id implies same font, nowadays. */
19714 && glyph
->face_id
== face_id
19715 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
19719 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
19720 s
->char2b
+ s
->nchars
,
19722 s
->two_byte_p
= two_byte_p
;
19724 xassert (s
->nchars
<= end
- start
);
19725 s
->width
+= glyph
->pixel_width
;
19726 if (glyph
++->padding_p
!= s
->padding_p
)
19730 s
->font
= s
->face
->font
;
19732 /* If the specified font could not be loaded, use the frame's font,
19733 but record the fact that we couldn't load it in
19734 S->font_not_found_p so that we can draw rectangles for the
19735 characters of the glyph string. */
19736 if (s
->font
== NULL
|| glyph_not_available_p
)
19738 s
->font_not_found_p
= 1;
19739 s
->font
= FRAME_FONT (s
->f
);
19742 /* Adjust base line for subscript/superscript text. */
19743 s
->ybase
+= voffset
;
19745 xassert (s
->face
&& s
->face
->gc
);
19746 return glyph
- s
->row
->glyphs
[s
->area
];
19750 /* Fill glyph string S from image glyph S->first_glyph. */
19753 fill_image_glyph_string (s
)
19754 struct glyph_string
*s
;
19756 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
19757 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
19759 s
->slice
= s
->first_glyph
->slice
;
19760 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
19761 s
->font
= s
->face
->font
;
19762 s
->width
= s
->first_glyph
->pixel_width
;
19764 /* Adjust base line for subscript/superscript text. */
19765 s
->ybase
+= s
->first_glyph
->voffset
;
19769 /* Fill glyph string S from a sequence of stretch glyphs.
19771 ROW is the glyph row in which the glyphs are found, AREA is the
19772 area within the row. START is the index of the first glyph to
19773 consider, END is the index of the last + 1.
19775 Value is the index of the first glyph not in S. */
19778 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
19779 struct glyph_string
*s
;
19780 struct glyph_row
*row
;
19781 enum glyph_row_area area
;
19784 struct glyph
*glyph
, *last
;
19785 int voffset
, face_id
;
19787 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
19789 glyph
= s
->row
->glyphs
[s
->area
] + start
;
19790 last
= s
->row
->glyphs
[s
->area
] + end
;
19791 face_id
= glyph
->face_id
;
19792 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
19793 s
->font
= s
->face
->font
;
19794 s
->width
= glyph
->pixel_width
;
19796 voffset
= glyph
->voffset
;
19800 && glyph
->type
== STRETCH_GLYPH
19801 && glyph
->voffset
== voffset
19802 && glyph
->face_id
== face_id
);
19804 s
->width
+= glyph
->pixel_width
;
19806 /* Adjust base line for subscript/superscript text. */
19807 s
->ybase
+= voffset
;
19809 /* The case that face->gc == 0 is handled when drawing the glyph
19810 string by calling PREPARE_FACE_FOR_DISPLAY. */
19812 return glyph
- s
->row
->glyphs
[s
->area
];
19815 static struct font_metrics
*
19816 get_per_char_metric (f
, font
, char2b
)
19821 static struct font_metrics metrics
;
19822 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
19824 if (! font
|| code
== FONT_INVALID_CODE
)
19826 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
19831 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
19832 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
19833 assumed to be zero. */
19836 x_get_glyph_overhangs (glyph
, f
, left
, right
)
19837 struct glyph
*glyph
;
19841 *left
= *right
= 0;
19843 if (glyph
->type
== CHAR_GLYPH
)
19847 struct font_metrics
*pcm
;
19849 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
19850 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
19852 if (pcm
->rbearing
> pcm
->width
)
19853 *right
= pcm
->rbearing
- pcm
->width
;
19854 if (pcm
->lbearing
< 0)
19855 *left
= -pcm
->lbearing
;
19858 else if (glyph
->type
== COMPOSITE_GLYPH
)
19860 if (! glyph
->u
.cmp
.automatic
)
19862 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
19864 if (cmp
->rbearing
> cmp
->pixel_width
)
19865 *right
= cmp
->rbearing
- cmp
->pixel_width
;
19866 if (cmp
->lbearing
< 0)
19867 *left
= - cmp
->lbearing
;
19871 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
19872 struct font_metrics metrics
;
19874 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
19875 glyph
->u
.cmp
.to
+ 1, &metrics
);
19876 if (metrics
.rbearing
> metrics
.width
)
19877 *right
= metrics
.rbearing
- metrics
.width
;
19878 if (metrics
.lbearing
< 0)
19879 *left
= - metrics
.lbearing
;
19885 /* Return the index of the first glyph preceding glyph string S that
19886 is overwritten by S because of S's left overhang. Value is -1
19887 if no glyphs are overwritten. */
19890 left_overwritten (s
)
19891 struct glyph_string
*s
;
19895 if (s
->left_overhang
)
19898 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19899 int first
= s
->first_glyph
- glyphs
;
19901 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
19902 x
-= glyphs
[i
].pixel_width
;
19913 /* Return the index of the first glyph preceding glyph string S that
19914 is overwriting S because of its right overhang. Value is -1 if no
19915 glyph in front of S overwrites S. */
19918 left_overwriting (s
)
19919 struct glyph_string
*s
;
19922 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19923 int first
= s
->first_glyph
- glyphs
;
19927 for (i
= first
- 1; i
>= 0; --i
)
19930 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19933 x
-= glyphs
[i
].pixel_width
;
19940 /* Return the index of the last glyph following glyph string S that is
19941 overwritten by S because of S's right overhang. Value is -1 if
19942 no such glyph is found. */
19945 right_overwritten (s
)
19946 struct glyph_string
*s
;
19950 if (s
->right_overhang
)
19953 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19954 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19955 int end
= s
->row
->used
[s
->area
];
19957 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
19958 x
+= glyphs
[i
].pixel_width
;
19967 /* Return the index of the last glyph following glyph string S that
19968 overwrites S because of its left overhang. Value is negative
19969 if no such glyph is found. */
19972 right_overwriting (s
)
19973 struct glyph_string
*s
;
19976 int end
= s
->row
->used
[s
->area
];
19977 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
19978 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
19982 for (i
= first
; i
< end
; ++i
)
19985 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
19988 x
+= glyphs
[i
].pixel_width
;
19995 /* Set background width of glyph string S. START is the index of the
19996 first glyph following S. LAST_X is the right-most x-position + 1
19997 in the drawing area. */
20000 set_glyph_string_background_width (s
, start
, last_x
)
20001 struct glyph_string
*s
;
20005 /* If the face of this glyph string has to be drawn to the end of
20006 the drawing area, set S->extends_to_end_of_line_p. */
20008 if (start
== s
->row
->used
[s
->area
]
20009 && s
->area
== TEXT_AREA
20010 && ((s
->row
->fill_line_p
20011 && (s
->hl
== DRAW_NORMAL_TEXT
20012 || s
->hl
== DRAW_IMAGE_RAISED
20013 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20014 || s
->hl
== DRAW_MOUSE_FACE
))
20015 s
->extends_to_end_of_line_p
= 1;
20017 /* If S extends its face to the end of the line, set its
20018 background_width to the distance to the right edge of the drawing
20020 if (s
->extends_to_end_of_line_p
)
20021 s
->background_width
= last_x
- s
->x
+ 1;
20023 s
->background_width
= s
->width
;
20027 /* Compute overhangs and x-positions for glyph string S and its
20028 predecessors, or successors. X is the starting x-position for S.
20029 BACKWARD_P non-zero means process predecessors. */
20032 compute_overhangs_and_x (s
, x
, backward_p
)
20033 struct glyph_string
*s
;
20041 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20042 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20052 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20053 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20063 /* The following macros are only called from draw_glyphs below.
20064 They reference the following parameters of that function directly:
20065 `w', `row', `area', and `overlap_p'
20066 as well as the following local variables:
20067 `s', `f', and `hdc' (in W32) */
20070 /* On W32, silently add local `hdc' variable to argument list of
20071 init_glyph_string. */
20072 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20073 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20075 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20076 init_glyph_string (s, char2b, w, row, area, start, hl)
20079 /* Add a glyph string for a stretch glyph to the list of strings
20080 between HEAD and TAIL. START is the index of the stretch glyph in
20081 row area AREA of glyph row ROW. END is the index of the last glyph
20082 in that glyph row area. X is the current output position assigned
20083 to the new glyph string constructed. HL overrides that face of the
20084 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20085 is the right-most x-position of the drawing area. */
20087 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
20088 and below -- keep them on one line. */
20089 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20092 s = (struct glyph_string *) alloca (sizeof *s); \
20093 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20094 START = fill_stretch_glyph_string (s, row, area, START, END); \
20095 append_glyph_string (&HEAD, &TAIL, s); \
20101 /* Add a glyph string for an image glyph to the list of strings
20102 between HEAD and TAIL. START is the index of the image glyph in
20103 row area AREA of glyph row ROW. END is the index of the last glyph
20104 in that glyph row area. X is the current output position assigned
20105 to the new glyph string constructed. HL overrides that face of the
20106 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
20107 is the right-most x-position of the drawing area. */
20109 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20112 s = (struct glyph_string *) alloca (sizeof *s); \
20113 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
20114 fill_image_glyph_string (s); \
20115 append_glyph_string (&HEAD, &TAIL, s); \
20122 /* Add a glyph string for a sequence of character glyphs to the list
20123 of strings between HEAD and TAIL. START is the index of the first
20124 glyph in row area AREA of glyph row ROW that is part of the new
20125 glyph string. END is the index of the last glyph in that glyph row
20126 area. X is the current output position assigned to the new glyph
20127 string constructed. HL overrides that face of the glyph; e.g. it
20128 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
20129 right-most x-position of the drawing area. */
20131 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20137 face_id = (row)->glyphs[area][START].face_id; \
20139 s = (struct glyph_string *) alloca (sizeof *s); \
20140 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
20141 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20142 append_glyph_string (&HEAD, &TAIL, s); \
20144 START = fill_glyph_string (s, face_id, START, END, overlaps); \
20149 /* Add a glyph string for a composite sequence to the list of strings
20150 between HEAD and TAIL. START is the index of the first glyph in
20151 row area AREA of glyph row ROW that is part of the new glyph
20152 string. END is the index of the last glyph in that glyph row area.
20153 X is the current output position assigned to the new glyph string
20154 constructed. HL overrides that face of the glyph; e.g. it is
20155 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
20156 x-position of the drawing area. */
20158 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20160 int face_id = (row)->glyphs[area][START].face_id; \
20161 struct face *base_face = FACE_FROM_ID (f, face_id); \
20162 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
20163 struct composition *cmp = composition_table[cmp_id]; \
20165 struct glyph_string *first_s; \
20168 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
20170 /* Make glyph_strings for each glyph sequence that is drawable by \
20171 the same face, and append them to HEAD/TAIL. */ \
20172 for (n = 0; n < cmp->glyph_len;) \
20174 s = (struct glyph_string *) alloca (sizeof *s); \
20175 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20176 append_glyph_string (&(HEAD), &(TAIL), s); \
20182 n = fill_composite_glyph_string (s, base_face, overlaps); \
20190 /* Add a glyph string for a glyph-string sequence to the list of strings
20191 between HEAD and TAIL. */
20193 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
20197 Lisp_Object gstring; \
20199 face_id = (row)->glyphs[area][START].face_id; \
20200 gstring = (composition_gstring_from_id \
20201 ((row)->glyphs[area][START].u.cmp.id)); \
20202 s = (struct glyph_string *) alloca (sizeof *s); \
20203 char2b = (XChar2b *) alloca ((sizeof *char2b) \
20204 * LGSTRING_GLYPH_LEN (gstring)); \
20205 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
20206 append_glyph_string (&(HEAD), &(TAIL), s); \
20208 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
20212 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
20213 of AREA of glyph row ROW on window W between indices START and END.
20214 HL overrides the face for drawing glyph strings, e.g. it is
20215 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
20216 x-positions of the drawing area.
20218 This is an ugly monster macro construct because we must use alloca
20219 to allocate glyph strings (because draw_glyphs can be called
20220 asynchronously). */
20222 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
20225 HEAD = TAIL = NULL; \
20226 while (START < END) \
20228 struct glyph *first_glyph = (row)->glyphs[area] + START; \
20229 switch (first_glyph->type) \
20232 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
20236 case COMPOSITE_GLYPH: \
20237 if (first_glyph->u.cmp.automatic) \
20238 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
20241 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
20245 case STRETCH_GLYPH: \
20246 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
20250 case IMAGE_GLYPH: \
20251 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
20261 set_glyph_string_background_width (s, START, LAST_X); \
20268 /* Draw glyphs between START and END in AREA of ROW on window W,
20269 starting at x-position X. X is relative to AREA in W. HL is a
20270 face-override with the following meaning:
20272 DRAW_NORMAL_TEXT draw normally
20273 DRAW_CURSOR draw in cursor face
20274 DRAW_MOUSE_FACE draw in mouse face.
20275 DRAW_INVERSE_VIDEO draw in mode line face
20276 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
20277 DRAW_IMAGE_RAISED draw an image with a raised relief around it
20279 If OVERLAPS is non-zero, draw only the foreground of characters and
20280 clip to the physical height of ROW. Non-zero value also defines
20281 the overlapping part to be drawn:
20283 OVERLAPS_PRED overlap with preceding rows
20284 OVERLAPS_SUCC overlap with succeeding rows
20285 OVERLAPS_BOTH overlap with both preceding/succeeding rows
20286 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
20288 Value is the x-position reached, relative to AREA of W. */
20291 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
20294 struct glyph_row
*row
;
20295 enum glyph_row_area area
;
20296 EMACS_INT start
, end
;
20297 enum draw_glyphs_face hl
;
20300 struct glyph_string
*head
, *tail
;
20301 struct glyph_string
*s
;
20302 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
20303 int i
, j
, x_reached
, last_x
, area_left
= 0;
20304 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20307 ALLOCATE_HDC (hdc
, f
);
20309 /* Let's rather be paranoid than getting a SEGV. */
20310 end
= min (end
, row
->used
[area
]);
20311 start
= max (0, start
);
20312 start
= min (end
, start
);
20314 /* Translate X to frame coordinates. Set last_x to the right
20315 end of the drawing area. */
20316 if (row
->full_width_p
)
20318 /* X is relative to the left edge of W, without scroll bars
20320 area_left
= WINDOW_LEFT_EDGE_X (w
);
20321 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
20325 area_left
= window_box_left (w
, area
);
20326 last_x
= area_left
+ window_box_width (w
, area
);
20330 /* Build a doubly-linked list of glyph_string structures between
20331 head and tail from what we have to draw. Note that the macro
20332 BUILD_GLYPH_STRINGS will modify its start parameter. That's
20333 the reason we use a separate variable `i'. */
20335 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
20337 x_reached
= tail
->x
+ tail
->background_width
;
20341 /* If there are any glyphs with lbearing < 0 or rbearing > width in
20342 the row, redraw some glyphs in front or following the glyph
20343 strings built above. */
20344 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
20346 struct glyph_string
*h
, *t
;
20347 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
20348 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
20351 /* If mouse highlighting is on, we may need to draw adjacent
20352 glyphs using mouse-face highlighting. */
20353 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
20355 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
20357 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
20358 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
20360 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
20362 check_mouse_face
= 1;
20363 mouse_beg_col
= (row
== mouse_beg_row
)
20364 ? dpyinfo
->mouse_face_beg_col
: 0;
20365 mouse_end_col
= (row
== mouse_end_row
)
20366 ? dpyinfo
->mouse_face_end_col
20367 : row
->used
[TEXT_AREA
];
20371 /* Compute overhangs for all glyph strings. */
20372 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
20373 for (s
= head
; s
; s
= s
->next
)
20374 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
20376 /* Prepend glyph strings for glyphs in front of the first glyph
20377 string that are overwritten because of the first glyph
20378 string's left overhang. The background of all strings
20379 prepended must be drawn because the first glyph string
20381 i
= left_overwritten (head
);
20384 enum draw_glyphs_face overlap_hl
;
20386 /* If this row contains mouse highlighting, attempt to draw
20387 the overlapped glyphs with the correct highlight. This
20388 code fails if the overlap encompasses more than one glyph
20389 and mouse-highlight spans only some of these glyphs.
20390 However, making it work perfectly involves a lot more
20391 code, and I don't know if the pathological case occurs in
20392 practice, so we'll stick to this for now. --- cyd */
20393 if (check_mouse_face
20394 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20395 overlap_hl
= DRAW_MOUSE_FACE
;
20397 overlap_hl
= DRAW_NORMAL_TEXT
;
20400 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
20401 overlap_hl
, dummy_x
, last_x
);
20402 compute_overhangs_and_x (t
, head
->x
, 1);
20403 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20407 /* Prepend glyph strings for glyphs in front of the first glyph
20408 string that overwrite that glyph string because of their
20409 right overhang. For these strings, only the foreground must
20410 be drawn, because it draws over the glyph string at `head'.
20411 The background must not be drawn because this would overwrite
20412 right overhangs of preceding glyphs for which no glyph
20414 i
= left_overwriting (head
);
20417 enum draw_glyphs_face overlap_hl
;
20419 if (check_mouse_face
20420 && mouse_beg_col
< start
&& mouse_end_col
> i
)
20421 overlap_hl
= DRAW_MOUSE_FACE
;
20423 overlap_hl
= DRAW_NORMAL_TEXT
;
20426 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
20427 overlap_hl
, dummy_x
, last_x
);
20428 for (s
= h
; s
; s
= s
->next
)
20429 s
->background_filled_p
= 1;
20430 compute_overhangs_and_x (t
, head
->x
, 1);
20431 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
20434 /* Append glyphs strings for glyphs following the last glyph
20435 string tail that are overwritten by tail. The background of
20436 these strings has to be drawn because tail's foreground draws
20438 i
= right_overwritten (tail
);
20441 enum draw_glyphs_face overlap_hl
;
20443 if (check_mouse_face
20444 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20445 overlap_hl
= DRAW_MOUSE_FACE
;
20447 overlap_hl
= DRAW_NORMAL_TEXT
;
20449 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20450 overlap_hl
, x
, last_x
);
20451 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20452 append_glyph_string_lists (&head
, &tail
, h
, t
);
20456 /* Append glyph strings for glyphs following the last glyph
20457 string tail that overwrite tail. The foreground of such
20458 glyphs has to be drawn because it writes into the background
20459 of tail. The background must not be drawn because it could
20460 paint over the foreground of following glyphs. */
20461 i
= right_overwriting (tail
);
20464 enum draw_glyphs_face overlap_hl
;
20465 if (check_mouse_face
20466 && mouse_beg_col
< i
&& mouse_end_col
> end
)
20467 overlap_hl
= DRAW_MOUSE_FACE
;
20469 overlap_hl
= DRAW_NORMAL_TEXT
;
20472 i
++; /* We must include the Ith glyph. */
20473 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
20474 overlap_hl
, x
, last_x
);
20475 for (s
= h
; s
; s
= s
->next
)
20476 s
->background_filled_p
= 1;
20477 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
20478 append_glyph_string_lists (&head
, &tail
, h
, t
);
20480 if (clip_head
|| clip_tail
)
20481 for (s
= head
; s
; s
= s
->next
)
20483 s
->clip_head
= clip_head
;
20484 s
->clip_tail
= clip_tail
;
20488 /* Draw all strings. */
20489 for (s
= head
; s
; s
= s
->next
)
20490 FRAME_RIF (f
)->draw_glyph_string (s
);
20493 /* When focus a sole frame and move horizontally, this sets on_p to 0
20494 causing a failure to erase prev cursor position. */
20495 if (area
== TEXT_AREA
20496 && !row
->full_width_p
20497 /* When drawing overlapping rows, only the glyph strings'
20498 foreground is drawn, which doesn't erase a cursor
20502 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
20503 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
20504 : (tail
? tail
->x
+ tail
->background_width
: x
));
20508 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
20509 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
20513 /* Value is the x-position up to which drawn, relative to AREA of W.
20514 This doesn't include parts drawn because of overhangs. */
20515 if (row
->full_width_p
)
20516 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
20518 x_reached
-= area_left
;
20520 RELEASE_HDC (hdc
, f
);
20525 /* Expand row matrix if too narrow. Don't expand if area
20528 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
20530 if (!fonts_changed_p \
20531 && (it->glyph_row->glyphs[area] \
20532 < it->glyph_row->glyphs[area + 1])) \
20534 it->w->ncols_scale_factor++; \
20535 fonts_changed_p = 1; \
20539 /* Store one glyph for IT->char_to_display in IT->glyph_row.
20540 Called from x_produce_glyphs when IT->glyph_row is non-null. */
20546 struct glyph
*glyph
;
20547 enum glyph_row_area area
= it
->area
;
20549 xassert (it
->glyph_row
);
20550 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
20552 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20553 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20555 glyph
->charpos
= CHARPOS (it
->position
);
20556 glyph
->object
= it
->object
;
20557 if (it
->pixel_width
> 0)
20559 glyph
->pixel_width
= it
->pixel_width
;
20560 glyph
->padding_p
= 0;
20564 /* Assure at least 1-pixel width. Otherwise, cursor can't
20565 be displayed correctly. */
20566 glyph
->pixel_width
= 1;
20567 glyph
->padding_p
= 1;
20569 glyph
->ascent
= it
->ascent
;
20570 glyph
->descent
= it
->descent
;
20571 glyph
->voffset
= it
->voffset
;
20572 glyph
->type
= CHAR_GLYPH
;
20573 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20574 glyph
->multibyte_p
= it
->multibyte_p
;
20575 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20576 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20577 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20578 || it
->phys_descent
> it
->descent
);
20579 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
20580 glyph
->face_id
= it
->face_id
;
20581 glyph
->u
.ch
= it
->char_to_display
;
20582 glyph
->slice
= null_glyph_slice
;
20583 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20584 ++it
->glyph_row
->used
[area
];
20587 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20590 /* Store one glyph for the composition IT->cmp_it.id in
20591 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
20595 append_composite_glyph (it
)
20598 struct glyph
*glyph
;
20599 enum glyph_row_area area
= it
->area
;
20601 xassert (it
->glyph_row
);
20603 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20604 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20606 glyph
->charpos
= CHARPOS (it
->position
);
20607 glyph
->object
= it
->object
;
20608 glyph
->pixel_width
= it
->pixel_width
;
20609 glyph
->ascent
= it
->ascent
;
20610 glyph
->descent
= it
->descent
;
20611 glyph
->voffset
= it
->voffset
;
20612 glyph
->type
= COMPOSITE_GLYPH
;
20613 if (it
->cmp_it
.ch
< 0)
20615 glyph
->u
.cmp
.automatic
= 0;
20616 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20620 glyph
->u
.cmp
.automatic
= 1;
20621 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
20622 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
20623 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
20625 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20626 glyph
->multibyte_p
= it
->multibyte_p
;
20627 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20628 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20629 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
20630 || it
->phys_descent
> it
->descent
);
20631 glyph
->padding_p
= 0;
20632 glyph
->glyph_not_available_p
= 0;
20633 glyph
->face_id
= it
->face_id
;
20634 glyph
->slice
= null_glyph_slice
;
20635 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20636 ++it
->glyph_row
->used
[area
];
20639 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20643 /* Change IT->ascent and IT->height according to the setting of
20647 take_vertical_position_into_account (it
)
20652 if (it
->voffset
< 0)
20653 /* Increase the ascent so that we can display the text higher
20655 it
->ascent
-= it
->voffset
;
20657 /* Increase the descent so that we can display the text lower
20659 it
->descent
+= it
->voffset
;
20664 /* Produce glyphs/get display metrics for the image IT is loaded with.
20665 See the description of struct display_iterator in dispextern.h for
20666 an overview of struct display_iterator. */
20669 produce_image_glyph (it
)
20674 int glyph_ascent
, crop
;
20675 struct glyph_slice slice
;
20677 xassert (it
->what
== IT_IMAGE
);
20679 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20681 /* Make sure X resources of the face is loaded. */
20682 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20684 if (it
->image_id
< 0)
20686 /* Fringe bitmap. */
20687 it
->ascent
= it
->phys_ascent
= 0;
20688 it
->descent
= it
->phys_descent
= 0;
20689 it
->pixel_width
= 0;
20694 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
20696 /* Make sure X resources of the image is loaded. */
20697 prepare_image_for_display (it
->f
, img
);
20699 slice
.x
= slice
.y
= 0;
20700 slice
.width
= img
->width
;
20701 slice
.height
= img
->height
;
20703 if (INTEGERP (it
->slice
.x
))
20704 slice
.x
= XINT (it
->slice
.x
);
20705 else if (FLOATP (it
->slice
.x
))
20706 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
20708 if (INTEGERP (it
->slice
.y
))
20709 slice
.y
= XINT (it
->slice
.y
);
20710 else if (FLOATP (it
->slice
.y
))
20711 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
20713 if (INTEGERP (it
->slice
.width
))
20714 slice
.width
= XINT (it
->slice
.width
);
20715 else if (FLOATP (it
->slice
.width
))
20716 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
20718 if (INTEGERP (it
->slice
.height
))
20719 slice
.height
= XINT (it
->slice
.height
);
20720 else if (FLOATP (it
->slice
.height
))
20721 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
20723 if (slice
.x
>= img
->width
)
20724 slice
.x
= img
->width
;
20725 if (slice
.y
>= img
->height
)
20726 slice
.y
= img
->height
;
20727 if (slice
.x
+ slice
.width
>= img
->width
)
20728 slice
.width
= img
->width
- slice
.x
;
20729 if (slice
.y
+ slice
.height
> img
->height
)
20730 slice
.height
= img
->height
- slice
.y
;
20732 if (slice
.width
== 0 || slice
.height
== 0)
20735 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
20737 it
->descent
= slice
.height
- glyph_ascent
;
20739 it
->descent
+= img
->vmargin
;
20740 if (slice
.y
+ slice
.height
== img
->height
)
20741 it
->descent
+= img
->vmargin
;
20742 it
->phys_descent
= it
->descent
;
20744 it
->pixel_width
= slice
.width
;
20746 it
->pixel_width
+= img
->hmargin
;
20747 if (slice
.x
+ slice
.width
== img
->width
)
20748 it
->pixel_width
+= img
->hmargin
;
20750 /* It's quite possible for images to have an ascent greater than
20751 their height, so don't get confused in that case. */
20752 if (it
->descent
< 0)
20757 if (face
->box
!= FACE_NO_BOX
)
20759 if (face
->box_line_width
> 0)
20762 it
->ascent
+= face
->box_line_width
;
20763 if (slice
.y
+ slice
.height
== img
->height
)
20764 it
->descent
+= face
->box_line_width
;
20767 if (it
->start_of_box_run_p
&& slice
.x
== 0)
20768 it
->pixel_width
+= eabs (face
->box_line_width
);
20769 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
20770 it
->pixel_width
+= eabs (face
->box_line_width
);
20773 take_vertical_position_into_account (it
);
20775 /* Automatically crop wide image glyphs at right edge so we can
20776 draw the cursor on same display row. */
20777 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
20778 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
20780 it
->pixel_width
-= crop
;
20781 slice
.width
-= crop
;
20786 struct glyph
*glyph
;
20787 enum glyph_row_area area
= it
->area
;
20789 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20790 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20792 glyph
->charpos
= CHARPOS (it
->position
);
20793 glyph
->object
= it
->object
;
20794 glyph
->pixel_width
= it
->pixel_width
;
20795 glyph
->ascent
= glyph_ascent
;
20796 glyph
->descent
= it
->descent
;
20797 glyph
->voffset
= it
->voffset
;
20798 glyph
->type
= IMAGE_GLYPH
;
20799 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20800 glyph
->multibyte_p
= it
->multibyte_p
;
20801 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20802 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20803 glyph
->overlaps_vertically_p
= 0;
20804 glyph
->padding_p
= 0;
20805 glyph
->glyph_not_available_p
= 0;
20806 glyph
->face_id
= it
->face_id
;
20807 glyph
->u
.img_id
= img
->id
;
20808 glyph
->slice
= slice
;
20809 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20810 ++it
->glyph_row
->used
[area
];
20813 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20818 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
20819 of the glyph, WIDTH and HEIGHT are the width and height of the
20820 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
20823 append_stretch_glyph (it
, object
, width
, height
, ascent
)
20825 Lisp_Object object
;
20829 struct glyph
*glyph
;
20830 enum glyph_row_area area
= it
->area
;
20832 xassert (ascent
>= 0 && ascent
<= height
);
20834 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
20835 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
20837 glyph
->charpos
= CHARPOS (it
->position
);
20838 glyph
->object
= object
;
20839 glyph
->pixel_width
= width
;
20840 glyph
->ascent
= ascent
;
20841 glyph
->descent
= height
- ascent
;
20842 glyph
->voffset
= it
->voffset
;
20843 glyph
->type
= STRETCH_GLYPH
;
20844 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
20845 glyph
->multibyte_p
= it
->multibyte_p
;
20846 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
20847 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
20848 glyph
->overlaps_vertically_p
= 0;
20849 glyph
->padding_p
= 0;
20850 glyph
->glyph_not_available_p
= 0;
20851 glyph
->face_id
= it
->face_id
;
20852 glyph
->u
.stretch
.ascent
= ascent
;
20853 glyph
->u
.stretch
.height
= height
;
20854 glyph
->slice
= null_glyph_slice
;
20855 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
20856 ++it
->glyph_row
->used
[area
];
20859 IT_EXPAND_MATRIX_WIDTH (it
, area
);
20863 /* Produce a stretch glyph for iterator IT. IT->object is the value
20864 of the glyph property displayed. The value must be a list
20865 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
20868 1. `:width WIDTH' specifies that the space should be WIDTH *
20869 canonical char width wide. WIDTH may be an integer or floating
20872 2. `:relative-width FACTOR' specifies that the width of the stretch
20873 should be computed from the width of the first character having the
20874 `glyph' property, and should be FACTOR times that width.
20876 3. `:align-to HPOS' specifies that the space should be wide enough
20877 to reach HPOS, a value in canonical character units.
20879 Exactly one of the above pairs must be present.
20881 4. `:height HEIGHT' specifies that the height of the stretch produced
20882 should be HEIGHT, measured in canonical character units.
20884 5. `:relative-height FACTOR' specifies that the height of the
20885 stretch should be FACTOR times the height of the characters having
20886 the glyph property.
20888 Either none or exactly one of 4 or 5 must be present.
20890 6. `:ascent ASCENT' specifies that ASCENT percent of the height
20891 of the stretch should be used for the ascent of the stretch.
20892 ASCENT must be in the range 0 <= ASCENT <= 100. */
20895 produce_stretch_glyph (it
)
20898 /* (space :width WIDTH :height HEIGHT ...) */
20899 Lisp_Object prop
, plist
;
20900 int width
= 0, height
= 0, align_to
= -1;
20901 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
20904 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20905 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
20907 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
20909 /* List should start with `space'. */
20910 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
20911 plist
= XCDR (it
->object
);
20913 /* Compute the width of the stretch. */
20914 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
20915 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
20917 /* Absolute width `:width WIDTH' specified and valid. */
20918 zero_width_ok_p
= 1;
20921 else if (prop
= Fplist_get (plist
, QCrelative_width
),
20924 /* Relative width `:relative-width FACTOR' specified and valid.
20925 Compute the width of the characters having the `glyph'
20928 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
20931 if (it
->multibyte_p
)
20933 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
20934 - IT_BYTEPOS (*it
));
20935 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
20938 it2
.c
= *p
, it2
.len
= 1;
20940 it2
.glyph_row
= NULL
;
20941 it2
.what
= IT_CHARACTER
;
20942 x_produce_glyphs (&it2
);
20943 width
= NUMVAL (prop
) * it2
.pixel_width
;
20945 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
20946 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
20948 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
20949 align_to
= (align_to
< 0
20951 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
20952 else if (align_to
< 0)
20953 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
20954 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
20955 zero_width_ok_p
= 1;
20958 /* Nothing specified -> width defaults to canonical char width. */
20959 width
= FRAME_COLUMN_WIDTH (it
->f
);
20961 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
20964 /* Compute height. */
20965 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
20966 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20969 zero_height_ok_p
= 1;
20971 else if (prop
= Fplist_get (plist
, QCrelative_height
),
20973 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
20975 height
= FONT_HEIGHT (font
);
20977 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
20980 /* Compute percentage of height used for ascent. If
20981 `:ascent ASCENT' is present and valid, use that. Otherwise,
20982 derive the ascent from the font in use. */
20983 if (prop
= Fplist_get (plist
, QCascent
),
20984 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
20985 ascent
= height
* NUMVAL (prop
) / 100.0;
20986 else if (!NILP (prop
)
20987 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
20988 ascent
= min (max (0, (int)tem
), height
);
20990 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
20992 if (width
> 0 && it
->line_wrap
!= TRUNCATE
20993 && it
->current_x
+ width
> it
->last_visible_x
)
20994 width
= it
->last_visible_x
- it
->current_x
- 1;
20996 if (width
> 0 && height
> 0 && it
->glyph_row
)
20998 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
20999 if (!STRINGP (object
))
21000 object
= it
->w
->buffer
;
21001 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21004 it
->pixel_width
= width
;
21005 it
->ascent
= it
->phys_ascent
= ascent
;
21006 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21007 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21009 take_vertical_position_into_account (it
);
21012 /* Calculate line-height and line-spacing properties.
21013 An integer value specifies explicit pixel value.
21014 A float value specifies relative value to current face height.
21015 A cons (float . face-name) specifies relative value to
21016 height of specified face font.
21018 Returns height in pixels, or nil. */
21022 calc_line_height_property (it
, val
, font
, boff
, override
)
21026 int boff
, override
;
21028 Lisp_Object face_name
= Qnil
;
21029 int ascent
, descent
, height
;
21031 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
21036 face_name
= XCAR (val
);
21038 if (!NUMBERP (val
))
21039 val
= make_number (1);
21040 if (NILP (face_name
))
21042 height
= it
->ascent
+ it
->descent
;
21047 if (NILP (face_name
))
21049 font
= FRAME_FONT (it
->f
);
21050 boff
= FRAME_BASELINE_OFFSET (it
->f
);
21052 else if (EQ (face_name
, Qt
))
21061 face_id
= lookup_named_face (it
->f
, face_name
, 0);
21063 return make_number (-1);
21065 face
= FACE_FROM_ID (it
->f
, face_id
);
21068 return make_number (-1);
21069 boff
= font
->baseline_offset
;
21070 if (font
->vertical_centering
)
21071 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21074 ascent
= FONT_BASE (font
) + boff
;
21075 descent
= FONT_DESCENT (font
) - boff
;
21079 it
->override_ascent
= ascent
;
21080 it
->override_descent
= descent
;
21081 it
->override_boff
= boff
;
21084 height
= ascent
+ descent
;
21088 height
= (int)(XFLOAT_DATA (val
) * height
);
21089 else if (INTEGERP (val
))
21090 height
*= XINT (val
);
21092 return make_number (height
);
21097 Produce glyphs/get display metrics for the display element IT is
21098 loaded with. See the description of struct it in dispextern.h
21099 for an overview of struct it. */
21102 x_produce_glyphs (it
)
21105 int extra_line_spacing
= it
->extra_line_spacing
;
21107 it
->glyph_not_available_p
= 0;
21109 if (it
->what
== IT_CHARACTER
)
21113 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21114 struct font_metrics
*pcm
;
21115 int font_not_found_p
;
21116 int boff
; /* baseline offset */
21117 /* We may change it->multibyte_p upon unibyte<->multibyte
21118 conversion. So, save the current value now and restore it
21121 Note: It seems that we don't have to record multibyte_p in
21122 struct glyph because the character code itself tells whether
21123 or not the character is multibyte. Thus, in the future, we
21124 must consider eliminating the field `multibyte_p' in the
21126 int saved_multibyte_p
= it
->multibyte_p
;
21128 /* Maybe translate single-byte characters to multibyte, or the
21130 it
->char_to_display
= it
->c
;
21131 if (!ASCII_BYTE_P (it
->c
)
21132 && ! it
->multibyte_p
)
21134 if (SINGLE_BYTE_CHAR_P (it
->c
)
21135 && unibyte_display_via_language_environment
)
21137 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
21139 /* get_next_display_element assures that this decoding
21141 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
21142 it
->multibyte_p
= 1;
21143 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
21145 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21149 /* Get font to use. Encode IT->char_to_display. */
21150 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
21151 &char2b
, it
->multibyte_p
, 0);
21154 font_not_found_p
= font
== NULL
;
21155 if (font_not_found_p
)
21157 /* When no suitable font found, display an empty box based
21158 on the metrics of the font of the default face (or what
21160 struct face
*no_font_face
21161 = FACE_FROM_ID (it
->f
,
21162 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
21163 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
21164 font
= no_font_face
->font
;
21165 boff
= font
->baseline_offset
;
21169 boff
= font
->baseline_offset
;
21170 if (font
->vertical_centering
)
21171 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21174 if (it
->char_to_display
>= ' '
21175 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
21177 /* Either unibyte or ASCII. */
21182 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21184 if (it
->override_ascent
>= 0)
21186 it
->ascent
= it
->override_ascent
;
21187 it
->descent
= it
->override_descent
;
21188 boff
= it
->override_boff
;
21192 it
->ascent
= FONT_BASE (font
) + boff
;
21193 it
->descent
= FONT_DESCENT (font
) - boff
;
21198 it
->phys_ascent
= pcm
->ascent
+ boff
;
21199 it
->phys_descent
= pcm
->descent
- boff
;
21200 it
->pixel_width
= pcm
->width
;
21204 it
->glyph_not_available_p
= 1;
21205 it
->phys_ascent
= it
->ascent
;
21206 it
->phys_descent
= it
->descent
;
21207 it
->pixel_width
= FONT_WIDTH (font
);
21210 if (it
->constrain_row_ascent_descent_p
)
21212 if (it
->descent
> it
->max_descent
)
21214 it
->ascent
+= it
->descent
- it
->max_descent
;
21215 it
->descent
= it
->max_descent
;
21217 if (it
->ascent
> it
->max_ascent
)
21219 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21220 it
->ascent
= it
->max_ascent
;
21222 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21223 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21224 extra_line_spacing
= 0;
21227 /* If this is a space inside a region of text with
21228 `space-width' property, change its width. */
21229 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
21231 it
->pixel_width
*= XFLOATINT (it
->space_width
);
21233 /* If face has a box, add the box thickness to the character
21234 height. If character has a box line to the left and/or
21235 right, add the box line width to the character's width. */
21236 if (face
->box
!= FACE_NO_BOX
)
21238 int thick
= face
->box_line_width
;
21242 it
->ascent
+= thick
;
21243 it
->descent
+= thick
;
21248 if (it
->start_of_box_run_p
)
21249 it
->pixel_width
+= thick
;
21250 if (it
->end_of_box_run_p
)
21251 it
->pixel_width
+= thick
;
21254 /* If face has an overline, add the height of the overline
21255 (1 pixel) and a 1 pixel margin to the character height. */
21256 if (face
->overline_p
)
21257 it
->ascent
+= overline_margin
;
21259 if (it
->constrain_row_ascent_descent_p
)
21261 if (it
->ascent
> it
->max_ascent
)
21262 it
->ascent
= it
->max_ascent
;
21263 if (it
->descent
> it
->max_descent
)
21264 it
->descent
= it
->max_descent
;
21267 take_vertical_position_into_account (it
);
21269 /* If we have to actually produce glyphs, do it. */
21274 /* Translate a space with a `space-width' property
21275 into a stretch glyph. */
21276 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
21277 / FONT_HEIGHT (font
));
21278 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21279 it
->ascent
+ it
->descent
, ascent
);
21284 /* If characters with lbearing or rbearing are displayed
21285 in this line, record that fact in a flag of the
21286 glyph row. This is used to optimize X output code. */
21287 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
21288 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21290 if (! stretched_p
&& it
->pixel_width
== 0)
21291 /* We assure that all visible glyphs have at least 1-pixel
21293 it
->pixel_width
= 1;
21295 else if (it
->char_to_display
== '\n')
21297 /* A newline has no width, but we need the height of the
21298 line. But if previous part of the line sets a height,
21299 don't increase that height */
21301 Lisp_Object height
;
21302 Lisp_Object total_height
= Qnil
;
21304 it
->override_ascent
= -1;
21305 it
->pixel_width
= 0;
21308 height
= get_it_property(it
, Qline_height
);
21309 /* Split (line-height total-height) list */
21311 && CONSP (XCDR (height
))
21312 && NILP (XCDR (XCDR (height
))))
21314 total_height
= XCAR (XCDR (height
));
21315 height
= XCAR (height
);
21317 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
21319 if (it
->override_ascent
>= 0)
21321 it
->ascent
= it
->override_ascent
;
21322 it
->descent
= it
->override_descent
;
21323 boff
= it
->override_boff
;
21327 it
->ascent
= FONT_BASE (font
) + boff
;
21328 it
->descent
= FONT_DESCENT (font
) - boff
;
21331 if (EQ (height
, Qt
))
21333 if (it
->descent
> it
->max_descent
)
21335 it
->ascent
+= it
->descent
- it
->max_descent
;
21336 it
->descent
= it
->max_descent
;
21338 if (it
->ascent
> it
->max_ascent
)
21340 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
21341 it
->ascent
= it
->max_ascent
;
21343 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
21344 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
21345 it
->constrain_row_ascent_descent_p
= 1;
21346 extra_line_spacing
= 0;
21350 Lisp_Object spacing
;
21352 it
->phys_ascent
= it
->ascent
;
21353 it
->phys_descent
= it
->descent
;
21355 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
21356 && face
->box
!= FACE_NO_BOX
21357 && face
->box_line_width
> 0)
21359 it
->ascent
+= face
->box_line_width
;
21360 it
->descent
+= face
->box_line_width
;
21363 && XINT (height
) > it
->ascent
+ it
->descent
)
21364 it
->ascent
= XINT (height
) - it
->descent
;
21366 if (!NILP (total_height
))
21367 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
21370 spacing
= get_it_property(it
, Qline_spacing
);
21371 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
21373 if (INTEGERP (spacing
))
21375 extra_line_spacing
= XINT (spacing
);
21376 if (!NILP (total_height
))
21377 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
21381 else if (it
->char_to_display
== '\t')
21383 if (font
->space_width
> 0)
21385 int tab_width
= it
->tab_width
* font
->space_width
;
21386 int x
= it
->current_x
+ it
->continuation_lines_width
;
21387 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
21389 /* If the distance from the current position to the next tab
21390 stop is less than a space character width, use the
21391 tab stop after that. */
21392 if (next_tab_x
- x
< font
->space_width
)
21393 next_tab_x
+= tab_width
;
21395 it
->pixel_width
= next_tab_x
- x
;
21397 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
21398 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21402 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
21403 it
->ascent
+ it
->descent
, it
->ascent
);
21408 it
->pixel_width
= 0;
21414 /* A multi-byte character. Assume that the display width of the
21415 character is the width of the character multiplied by the
21416 width of the font. */
21418 /* If we found a font, this font should give us the right
21419 metrics. If we didn't find a font, use the frame's
21420 default font and calculate the width of the character by
21421 multiplying the width of font by the width of the
21424 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21426 if (font_not_found_p
|| !pcm
)
21428 int char_width
= CHAR_WIDTH (it
->char_to_display
);
21430 if (char_width
== 0)
21431 /* This is a non spacing character. But, as we are
21432 going to display an empty box, the box must occupy
21433 at least one column. */
21435 it
->glyph_not_available_p
= 1;
21436 it
->pixel_width
= font
->space_width
* char_width
;
21437 it
->phys_ascent
= FONT_BASE (font
) + boff
;
21438 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
21442 it
->pixel_width
= pcm
->width
;
21443 it
->phys_ascent
= pcm
->ascent
+ boff
;
21444 it
->phys_descent
= pcm
->descent
- boff
;
21446 && (pcm
->lbearing
< 0
21447 || pcm
->rbearing
> pcm
->width
))
21448 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21451 it
->ascent
= FONT_BASE (font
) + boff
;
21452 it
->descent
= FONT_DESCENT (font
) - boff
;
21453 if (face
->box
!= FACE_NO_BOX
)
21455 int thick
= face
->box_line_width
;
21459 it
->ascent
+= thick
;
21460 it
->descent
+= thick
;
21465 if (it
->start_of_box_run_p
)
21466 it
->pixel_width
+= thick
;
21467 if (it
->end_of_box_run_p
)
21468 it
->pixel_width
+= thick
;
21471 /* If face has an overline, add the height of the overline
21472 (1 pixel) and a 1 pixel margin to the character height. */
21473 if (face
->overline_p
)
21474 it
->ascent
+= overline_margin
;
21476 take_vertical_position_into_account (it
);
21478 if (it
->ascent
< 0)
21480 if (it
->descent
< 0)
21485 if (it
->pixel_width
== 0)
21486 /* We assure that all visible glyphs have at least 1-pixel
21488 it
->pixel_width
= 1;
21490 it
->multibyte_p
= saved_multibyte_p
;
21492 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
21494 /* A static composition.
21496 Note: A composition is represented as one glyph in the
21497 glyph matrix. There are no padding glyphs.
21499 Important note: pixel_width, ascent, and descent are the
21500 values of what is drawn by draw_glyphs (i.e. the values of
21501 the overall glyphs composed). */
21502 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21503 int boff
; /* baseline offset */
21504 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
21505 int glyph_len
= cmp
->glyph_len
;
21506 struct font
*font
= face
->font
;
21510 /* If we have not yet calculated pixel size data of glyphs of
21511 the composition for the current face font, calculate them
21512 now. Theoretically, we have to check all fonts for the
21513 glyphs, but that requires much time and memory space. So,
21514 here we check only the font of the first glyph. This may
21515 lead to incorrect display, but it's very rare, and C-l
21516 (recenter-top-bottom) can correct the display anyway. */
21517 if (! cmp
->font
|| cmp
->font
!= font
)
21519 /* Ascent and descent of the font of the first character
21520 of this composition (adjusted by baseline offset).
21521 Ascent and descent of overall glyphs should not be less
21522 than these, respectively. */
21523 int font_ascent
, font_descent
, font_height
;
21524 /* Bounding box of the overall glyphs. */
21525 int leftmost
, rightmost
, lowest
, highest
;
21526 int lbearing
, rbearing
;
21527 int i
, width
, ascent
, descent
;
21528 int left_padded
= 0, right_padded
= 0;
21531 struct font_metrics
*pcm
;
21532 int font_not_found_p
;
21535 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
21536 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
21538 if (glyph_len
< cmp
->glyph_len
)
21540 for (i
= 0; i
< glyph_len
; i
++)
21542 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
21544 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21549 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
21550 : IT_CHARPOS (*it
));
21551 /* If no suitable font is found, use the default font. */
21552 font_not_found_p
= font
== NULL
;
21553 if (font_not_found_p
)
21555 face
= face
->ascii_face
;
21558 boff
= font
->baseline_offset
;
21559 if (font
->vertical_centering
)
21560 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21561 font_ascent
= FONT_BASE (font
) + boff
;
21562 font_descent
= FONT_DESCENT (font
) - boff
;
21563 font_height
= FONT_HEIGHT (font
);
21565 cmp
->font
= (void *) font
;
21568 if (! font_not_found_p
)
21570 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
21571 &char2b
, it
->multibyte_p
, 0);
21572 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21575 /* Initialize the bounding box. */
21578 width
= pcm
->width
;
21579 ascent
= pcm
->ascent
;
21580 descent
= pcm
->descent
;
21581 lbearing
= pcm
->lbearing
;
21582 rbearing
= pcm
->rbearing
;
21586 width
= FONT_WIDTH (font
);
21587 ascent
= FONT_BASE (font
);
21588 descent
= FONT_DESCENT (font
);
21595 lowest
= - descent
+ boff
;
21596 highest
= ascent
+ boff
;
21598 if (! font_not_found_p
21599 && font
->default_ascent
21600 && CHAR_TABLE_P (Vuse_default_ascent
)
21601 && !NILP (Faref (Vuse_default_ascent
,
21602 make_number (it
->char_to_display
))))
21603 highest
= font
->default_ascent
+ boff
;
21605 /* Draw the first glyph at the normal position. It may be
21606 shifted to right later if some other glyphs are drawn
21608 cmp
->offsets
[i
* 2] = 0;
21609 cmp
->offsets
[i
* 2 + 1] = boff
;
21610 cmp
->lbearing
= lbearing
;
21611 cmp
->rbearing
= rbearing
;
21613 /* Set cmp->offsets for the remaining glyphs. */
21614 for (i
++; i
< glyph_len
; i
++)
21616 int left
, right
, btm
, top
;
21617 int ch
= COMPOSITION_GLYPH (cmp
, i
);
21619 struct face
*this_face
;
21624 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
21625 this_face
= FACE_FROM_ID (it
->f
, face_id
);
21626 font
= this_face
->font
;
21632 this_boff
= font
->baseline_offset
;
21633 if (font
->vertical_centering
)
21634 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
21635 get_char_face_and_encoding (it
->f
, ch
, face_id
,
21636 &char2b
, it
->multibyte_p
, 0);
21637 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
21640 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
21643 width
= pcm
->width
;
21644 ascent
= pcm
->ascent
;
21645 descent
= pcm
->descent
;
21646 lbearing
= pcm
->lbearing
;
21647 rbearing
= pcm
->rbearing
;
21648 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
21650 /* Relative composition with or without
21651 alternate chars. */
21652 left
= (leftmost
+ rightmost
- width
) / 2;
21653 btm
= - descent
+ boff
;
21654 if (font
->relative_compose
21655 && (! CHAR_TABLE_P (Vignore_relative_composition
)
21656 || NILP (Faref (Vignore_relative_composition
,
21657 make_number (ch
)))))
21660 if (- descent
>= font
->relative_compose
)
21661 /* One extra pixel between two glyphs. */
21663 else if (ascent
<= 0)
21664 /* One extra pixel between two glyphs. */
21665 btm
= lowest
- 1 - ascent
- descent
;
21670 /* A composition rule is specified by an integer
21671 value that encodes global and new reference
21672 points (GREF and NREF). GREF and NREF are
21673 specified by numbers as below:
21675 0---1---2 -- ascent
21679 9--10--11 -- center
21681 ---3---4---5--- baseline
21683 6---7---8 -- descent
21685 int rule
= COMPOSITION_RULE (cmp
, i
);
21686 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
21688 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
21689 grefx
= gref
% 3, nrefx
= nref
% 3;
21690 grefy
= gref
/ 3, nrefy
= nref
/ 3;
21692 xoff
= font_height
* (xoff
- 128) / 256;
21694 yoff
= font_height
* (yoff
- 128) / 256;
21697 + grefx
* (rightmost
- leftmost
) / 2
21698 - nrefx
* width
/ 2
21701 btm
= ((grefy
== 0 ? highest
21703 : grefy
== 2 ? lowest
21704 : (highest
+ lowest
) / 2)
21705 - (nrefy
== 0 ? ascent
+ descent
21706 : nrefy
== 1 ? descent
- boff
21708 : (ascent
+ descent
) / 2)
21712 cmp
->offsets
[i
* 2] = left
;
21713 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
21715 /* Update the bounding box of the overall glyphs. */
21718 right
= left
+ width
;
21719 if (left
< leftmost
)
21721 if (right
> rightmost
)
21724 top
= btm
+ descent
+ ascent
;
21730 if (cmp
->lbearing
> left
+ lbearing
)
21731 cmp
->lbearing
= left
+ lbearing
;
21732 if (cmp
->rbearing
< left
+ rbearing
)
21733 cmp
->rbearing
= left
+ rbearing
;
21737 /* If there are glyphs whose x-offsets are negative,
21738 shift all glyphs to the right and make all x-offsets
21742 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21743 cmp
->offsets
[i
* 2] -= leftmost
;
21744 rightmost
-= leftmost
;
21745 cmp
->lbearing
-= leftmost
;
21746 cmp
->rbearing
-= leftmost
;
21749 if (left_padded
&& cmp
->lbearing
< 0)
21751 for (i
= 0; i
< cmp
->glyph_len
; i
++)
21752 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
21753 rightmost
-= cmp
->lbearing
;
21754 cmp
->rbearing
-= cmp
->lbearing
;
21757 if (right_padded
&& rightmost
< cmp
->rbearing
)
21759 rightmost
= cmp
->rbearing
;
21762 cmp
->pixel_width
= rightmost
;
21763 cmp
->ascent
= highest
;
21764 cmp
->descent
= - lowest
;
21765 if (cmp
->ascent
< font_ascent
)
21766 cmp
->ascent
= font_ascent
;
21767 if (cmp
->descent
< font_descent
)
21768 cmp
->descent
= font_descent
;
21772 && (cmp
->lbearing
< 0
21773 || cmp
->rbearing
> cmp
->pixel_width
))
21774 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21776 it
->pixel_width
= cmp
->pixel_width
;
21777 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
21778 it
->descent
= it
->phys_descent
= cmp
->descent
;
21779 if (face
->box
!= FACE_NO_BOX
)
21781 int thick
= face
->box_line_width
;
21785 it
->ascent
+= thick
;
21786 it
->descent
+= thick
;
21791 if (it
->start_of_box_run_p
)
21792 it
->pixel_width
+= thick
;
21793 if (it
->end_of_box_run_p
)
21794 it
->pixel_width
+= thick
;
21797 /* If face has an overline, add the height of the overline
21798 (1 pixel) and a 1 pixel margin to the character height. */
21799 if (face
->overline_p
)
21800 it
->ascent
+= overline_margin
;
21802 take_vertical_position_into_account (it
);
21803 if (it
->ascent
< 0)
21805 if (it
->descent
< 0)
21809 append_composite_glyph (it
);
21811 else if (it
->what
== IT_COMPOSITION
)
21813 /* A dynamic (automatic) composition. */
21814 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21815 Lisp_Object gstring
;
21816 struct font_metrics metrics
;
21818 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
21820 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
21823 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
21824 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
21825 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
21826 it
->descent
= it
->phys_descent
= metrics
.descent
;
21827 if (face
->box
!= FACE_NO_BOX
)
21829 int thick
= face
->box_line_width
;
21833 it
->ascent
+= thick
;
21834 it
->descent
+= thick
;
21839 if (it
->start_of_box_run_p
)
21840 it
->pixel_width
+= thick
;
21841 if (it
->end_of_box_run_p
)
21842 it
->pixel_width
+= thick
;
21844 /* If face has an overline, add the height of the overline
21845 (1 pixel) and a 1 pixel margin to the character height. */
21846 if (face
->overline_p
)
21847 it
->ascent
+= overline_margin
;
21848 take_vertical_position_into_account (it
);
21849 if (it
->ascent
< 0)
21851 if (it
->descent
< 0)
21855 append_composite_glyph (it
);
21857 else if (it
->what
== IT_IMAGE
)
21858 produce_image_glyph (it
);
21859 else if (it
->what
== IT_STRETCH
)
21860 produce_stretch_glyph (it
);
21862 /* Accumulate dimensions. Note: can't assume that it->descent > 0
21863 because this isn't true for images with `:ascent 100'. */
21864 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
21865 if (it
->area
== TEXT_AREA
)
21866 it
->current_x
+= it
->pixel_width
;
21868 if (extra_line_spacing
> 0)
21870 it
->descent
+= extra_line_spacing
;
21871 if (extra_line_spacing
> it
->max_extra_line_spacing
)
21872 it
->max_extra_line_spacing
= extra_line_spacing
;
21875 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
21876 it
->max_descent
= max (it
->max_descent
, it
->descent
);
21877 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
21878 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
21882 Output LEN glyphs starting at START at the nominal cursor position.
21883 Advance the nominal cursor over the text. The global variable
21884 updated_window contains the window being updated, updated_row is
21885 the glyph row being updated, and updated_area is the area of that
21886 row being updated. */
21889 x_write_glyphs (start
, len
)
21890 struct glyph
*start
;
21895 xassert (updated_window
&& updated_row
);
21898 /* Write glyphs. */
21900 hpos
= start
- updated_row
->glyphs
[updated_area
];
21901 x
= draw_glyphs (updated_window
, output_cursor
.x
,
21902 updated_row
, updated_area
,
21904 DRAW_NORMAL_TEXT
, 0);
21906 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
21907 if (updated_area
== TEXT_AREA
21908 && updated_window
->phys_cursor_on_p
21909 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
21910 && updated_window
->phys_cursor
.hpos
>= hpos
21911 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
21912 updated_window
->phys_cursor_on_p
= 0;
21916 /* Advance the output cursor. */
21917 output_cursor
.hpos
+= len
;
21918 output_cursor
.x
= x
;
21923 Insert LEN glyphs from START at the nominal cursor position. */
21926 x_insert_glyphs (start
, len
)
21927 struct glyph
*start
;
21932 int line_height
, shift_by_width
, shifted_region_width
;
21933 struct glyph_row
*row
;
21934 struct glyph
*glyph
;
21935 int frame_x
, frame_y
;
21938 xassert (updated_window
&& updated_row
);
21940 w
= updated_window
;
21941 f
= XFRAME (WINDOW_FRAME (w
));
21943 /* Get the height of the line we are in. */
21945 line_height
= row
->height
;
21947 /* Get the width of the glyphs to insert. */
21948 shift_by_width
= 0;
21949 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
21950 shift_by_width
+= glyph
->pixel_width
;
21952 /* Get the width of the region to shift right. */
21953 shifted_region_width
= (window_box_width (w
, updated_area
)
21958 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
21959 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
21961 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
21962 line_height
, shift_by_width
);
21964 /* Write the glyphs. */
21965 hpos
= start
- row
->glyphs
[updated_area
];
21966 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
21968 DRAW_NORMAL_TEXT
, 0);
21970 /* Advance the output cursor. */
21971 output_cursor
.hpos
+= len
;
21972 output_cursor
.x
+= shift_by_width
;
21978 Erase the current text line from the nominal cursor position
21979 (inclusive) to pixel column TO_X (exclusive). The idea is that
21980 everything from TO_X onward is already erased.
21982 TO_X is a pixel position relative to updated_area of
21983 updated_window. TO_X == -1 means clear to the end of this area. */
21986 x_clear_end_of_line (to_x
)
21990 struct window
*w
= updated_window
;
21991 int max_x
, min_y
, max_y
;
21992 int from_x
, from_y
, to_y
;
21994 xassert (updated_window
&& updated_row
);
21995 f
= XFRAME (w
->frame
);
21997 if (updated_row
->full_width_p
)
21998 max_x
= WINDOW_TOTAL_WIDTH (w
);
22000 max_x
= window_box_width (w
, updated_area
);
22001 max_y
= window_text_bottom_y (w
);
22003 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22004 of window. For TO_X > 0, truncate to end of drawing area. */
22010 to_x
= min (to_x
, max_x
);
22012 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22014 /* Notice if the cursor will be cleared by this operation. */
22015 if (!updated_row
->full_width_p
)
22016 notice_overwritten_cursor (w
, updated_area
,
22017 output_cursor
.x
, -1,
22019 MATRIX_ROW_BOTTOM_Y (updated_row
));
22021 from_x
= output_cursor
.x
;
22023 /* Translate to frame coordinates. */
22024 if (updated_row
->full_width_p
)
22026 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
22027 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
22031 int area_left
= window_box_left (w
, updated_area
);
22032 from_x
+= area_left
;
22036 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
22037 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
22038 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
22040 /* Prevent inadvertently clearing to end of the X window. */
22041 if (to_x
> from_x
&& to_y
> from_y
)
22044 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
22045 to_x
- from_x
, to_y
- from_y
);
22050 #endif /* HAVE_WINDOW_SYSTEM */
22054 /***********************************************************************
22056 ***********************************************************************/
22058 /* Value is the internal representation of the specified cursor type
22059 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
22060 of the bar cursor. */
22062 static enum text_cursor_kinds
22063 get_specified_cursor_type (arg
, width
)
22067 enum text_cursor_kinds type
;
22072 if (EQ (arg
, Qbox
))
22073 return FILLED_BOX_CURSOR
;
22075 if (EQ (arg
, Qhollow
))
22076 return HOLLOW_BOX_CURSOR
;
22078 if (EQ (arg
, Qbar
))
22085 && EQ (XCAR (arg
), Qbar
)
22086 && INTEGERP (XCDR (arg
))
22087 && XINT (XCDR (arg
)) >= 0)
22089 *width
= XINT (XCDR (arg
));
22093 if (EQ (arg
, Qhbar
))
22096 return HBAR_CURSOR
;
22100 && EQ (XCAR (arg
), Qhbar
)
22101 && INTEGERP (XCDR (arg
))
22102 && XINT (XCDR (arg
)) >= 0)
22104 *width
= XINT (XCDR (arg
));
22105 return HBAR_CURSOR
;
22108 /* Treat anything unknown as "hollow box cursor".
22109 It was bad to signal an error; people have trouble fixing
22110 .Xdefaults with Emacs, when it has something bad in it. */
22111 type
= HOLLOW_BOX_CURSOR
;
22116 /* Set the default cursor types for specified frame. */
22118 set_frame_cursor_types (f
, arg
)
22125 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
22126 FRAME_CURSOR_WIDTH (f
) = width
;
22128 /* By default, set up the blink-off state depending on the on-state. */
22130 tem
= Fassoc (arg
, Vblink_cursor_alist
);
22133 FRAME_BLINK_OFF_CURSOR (f
)
22134 = get_specified_cursor_type (XCDR (tem
), &width
);
22135 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
22138 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
22142 /* Return the cursor we want to be displayed in window W. Return
22143 width of bar/hbar cursor through WIDTH arg. Return with
22144 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
22145 (i.e. if the `system caret' should track this cursor).
22147 In a mini-buffer window, we want the cursor only to appear if we
22148 are reading input from this window. For the selected window, we
22149 want the cursor type given by the frame parameter or buffer local
22150 setting of cursor-type. If explicitly marked off, draw no cursor.
22151 In all other cases, we want a hollow box cursor. */
22153 static enum text_cursor_kinds
22154 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
22156 struct glyph
*glyph
;
22158 int *active_cursor
;
22160 struct frame
*f
= XFRAME (w
->frame
);
22161 struct buffer
*b
= XBUFFER (w
->buffer
);
22162 int cursor_type
= DEFAULT_CURSOR
;
22163 Lisp_Object alt_cursor
;
22164 int non_selected
= 0;
22166 *active_cursor
= 1;
22169 if (cursor_in_echo_area
22170 && FRAME_HAS_MINIBUF_P (f
)
22171 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
22173 if (w
== XWINDOW (echo_area_window
))
22175 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
22177 *width
= FRAME_CURSOR_WIDTH (f
);
22178 return FRAME_DESIRED_CURSOR (f
);
22181 return get_specified_cursor_type (b
->cursor_type
, width
);
22184 *active_cursor
= 0;
22188 /* Detect a nonselected window or nonselected frame. */
22189 else if (w
!= XWINDOW (f
->selected_window
)
22190 #ifdef HAVE_WINDOW_SYSTEM
22191 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
22195 *active_cursor
= 0;
22197 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
22203 /* Never display a cursor in a window in which cursor-type is nil. */
22204 if (NILP (b
->cursor_type
))
22207 /* Get the normal cursor type for this window. */
22208 if (EQ (b
->cursor_type
, Qt
))
22210 cursor_type
= FRAME_DESIRED_CURSOR (f
);
22211 *width
= FRAME_CURSOR_WIDTH (f
);
22214 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
22216 /* Use cursor-in-non-selected-windows instead
22217 for non-selected window or frame. */
22220 alt_cursor
= b
->cursor_in_non_selected_windows
;
22221 if (!EQ (Qt
, alt_cursor
))
22222 return get_specified_cursor_type (alt_cursor
, width
);
22223 /* t means modify the normal cursor type. */
22224 if (cursor_type
== FILLED_BOX_CURSOR
)
22225 cursor_type
= HOLLOW_BOX_CURSOR
;
22226 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
22228 return cursor_type
;
22231 /* Use normal cursor if not blinked off. */
22232 if (!w
->cursor_off_p
)
22234 #ifdef HAVE_WINDOW_SYSTEM
22235 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
22237 if (cursor_type
== FILLED_BOX_CURSOR
)
22239 /* Using a block cursor on large images can be very annoying.
22240 So use a hollow cursor for "large" images.
22241 If image is not transparent (no mask), also use hollow cursor. */
22242 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
22243 if (img
!= NULL
&& IMAGEP (img
->spec
))
22245 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
22246 where N = size of default frame font size.
22247 This should cover most of the "tiny" icons people may use. */
22249 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
22250 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
22251 cursor_type
= HOLLOW_BOX_CURSOR
;
22254 else if (cursor_type
!= NO_CURSOR
)
22256 /* Display current only supports BOX and HOLLOW cursors for images.
22257 So for now, unconditionally use a HOLLOW cursor when cursor is
22258 not a solid box cursor. */
22259 cursor_type
= HOLLOW_BOX_CURSOR
;
22263 return cursor_type
;
22266 /* Cursor is blinked off, so determine how to "toggle" it. */
22268 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
22269 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
22270 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
22272 /* Then see if frame has specified a specific blink off cursor type. */
22273 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
22275 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
22276 return FRAME_BLINK_OFF_CURSOR (f
);
22280 /* Some people liked having a permanently visible blinking cursor,
22281 while others had very strong opinions against it. So it was
22282 decided to remove it. KFS 2003-09-03 */
22284 /* Finally perform built-in cursor blinking:
22285 filled box <-> hollow box
22286 wide [h]bar <-> narrow [h]bar
22287 narrow [h]bar <-> no cursor
22288 other type <-> no cursor */
22290 if (cursor_type
== FILLED_BOX_CURSOR
)
22291 return HOLLOW_BOX_CURSOR
;
22293 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
22296 return cursor_type
;
22304 #ifdef HAVE_WINDOW_SYSTEM
22306 /* Notice when the text cursor of window W has been completely
22307 overwritten by a drawing operation that outputs glyphs in AREA
22308 starting at X0 and ending at X1 in the line starting at Y0 and
22309 ending at Y1. X coordinates are area-relative. X1 < 0 means all
22310 the rest of the line after X0 has been written. Y coordinates
22311 are window-relative. */
22314 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
22316 enum glyph_row_area area
;
22317 int x0
, y0
, x1
, y1
;
22319 int cx0
, cx1
, cy0
, cy1
;
22320 struct glyph_row
*row
;
22322 if (!w
->phys_cursor_on_p
)
22324 if (area
!= TEXT_AREA
)
22327 if (w
->phys_cursor
.vpos
< 0
22328 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
22329 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
22330 !(row
->enabled_p
&& row
->displays_text_p
)))
22333 if (row
->cursor_in_fringe_p
)
22335 row
->cursor_in_fringe_p
= 0;
22336 draw_fringe_bitmap (w
, row
, 0);
22337 w
->phys_cursor_on_p
= 0;
22341 cx0
= w
->phys_cursor
.x
;
22342 cx1
= cx0
+ w
->phys_cursor_width
;
22343 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
22346 /* The cursor image will be completely removed from the
22347 screen if the output area intersects the cursor area in
22348 y-direction. When we draw in [y0 y1[, and some part of
22349 the cursor is at y < y0, that part must have been drawn
22350 before. When scrolling, the cursor is erased before
22351 actually scrolling, so we don't come here. When not
22352 scrolling, the rows above the old cursor row must have
22353 changed, and in this case these rows must have written
22354 over the cursor image.
22356 Likewise if part of the cursor is below y1, with the
22357 exception of the cursor being in the first blank row at
22358 the buffer and window end because update_text_area
22359 doesn't draw that row. (Except when it does, but
22360 that's handled in update_text_area.) */
22362 cy0
= w
->phys_cursor
.y
;
22363 cy1
= cy0
+ w
->phys_cursor_height
;
22364 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
22367 w
->phys_cursor_on_p
= 0;
22370 #endif /* HAVE_WINDOW_SYSTEM */
22373 /************************************************************************
22375 ************************************************************************/
22377 #ifdef HAVE_WINDOW_SYSTEM
22380 Fix the display of area AREA of overlapping row ROW in window W
22381 with respect to the overlapping part OVERLAPS. */
22384 x_fix_overlapping_area (w
, row
, area
, overlaps
)
22386 struct glyph_row
*row
;
22387 enum glyph_row_area area
;
22395 for (i
= 0; i
< row
->used
[area
];)
22397 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
22399 int start
= i
, start_x
= x
;
22403 x
+= row
->glyphs
[area
][i
].pixel_width
;
22406 while (i
< row
->used
[area
]
22407 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
22409 draw_glyphs (w
, start_x
, row
, area
,
22411 DRAW_NORMAL_TEXT
, overlaps
);
22415 x
+= row
->glyphs
[area
][i
].pixel_width
;
22425 Draw the cursor glyph of window W in glyph row ROW. See the
22426 comment of draw_glyphs for the meaning of HL. */
22429 draw_phys_cursor_glyph (w
, row
, hl
)
22431 struct glyph_row
*row
;
22432 enum draw_glyphs_face hl
;
22434 /* If cursor hpos is out of bounds, don't draw garbage. This can
22435 happen in mini-buffer windows when switching between echo area
22436 glyphs and mini-buffer. */
22437 if (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])
22439 int on_p
= w
->phys_cursor_on_p
;
22441 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
22442 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
22444 w
->phys_cursor_on_p
= on_p
;
22446 if (hl
== DRAW_CURSOR
)
22447 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22448 /* When we erase the cursor, and ROW is overlapped by other
22449 rows, make sure that these overlapping parts of other rows
22451 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
22453 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
22455 if (row
> w
->current_matrix
->rows
22456 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
22457 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
22458 OVERLAPS_ERASED_CURSOR
);
22460 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
22461 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
22462 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
22463 OVERLAPS_ERASED_CURSOR
);
22470 Erase the image of a cursor of window W from the screen. */
22473 erase_phys_cursor (w
)
22476 struct frame
*f
= XFRAME (w
->frame
);
22477 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
22478 int hpos
= w
->phys_cursor
.hpos
;
22479 int vpos
= w
->phys_cursor
.vpos
;
22480 int mouse_face_here_p
= 0;
22481 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
22482 struct glyph_row
*cursor_row
;
22483 struct glyph
*cursor_glyph
;
22484 enum draw_glyphs_face hl
;
22486 /* No cursor displayed or row invalidated => nothing to do on the
22488 if (w
->phys_cursor_type
== NO_CURSOR
)
22489 goto mark_cursor_off
;
22491 /* VPOS >= active_glyphs->nrows means that window has been resized.
22492 Don't bother to erase the cursor. */
22493 if (vpos
>= active_glyphs
->nrows
)
22494 goto mark_cursor_off
;
22496 /* If row containing cursor is marked invalid, there is nothing we
22498 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
22499 if (!cursor_row
->enabled_p
)
22500 goto mark_cursor_off
;
22502 /* If line spacing is > 0, old cursor may only be partially visible in
22503 window after split-window. So adjust visible height. */
22504 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
22505 window_text_bottom_y (w
) - cursor_row
->y
);
22507 /* If row is completely invisible, don't attempt to delete a cursor which
22508 isn't there. This can happen if cursor is at top of a window, and
22509 we switch to a buffer with a header line in that window. */
22510 if (cursor_row
->visible_height
<= 0)
22511 goto mark_cursor_off
;
22513 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
22514 if (cursor_row
->cursor_in_fringe_p
)
22516 cursor_row
->cursor_in_fringe_p
= 0;
22517 draw_fringe_bitmap (w
, cursor_row
, 0);
22518 goto mark_cursor_off
;
22521 /* This can happen when the new row is shorter than the old one.
22522 In this case, either draw_glyphs or clear_end_of_line
22523 should have cleared the cursor. Note that we wouldn't be
22524 able to erase the cursor in this case because we don't have a
22525 cursor glyph at hand. */
22526 if (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])
22527 goto mark_cursor_off
;
22529 /* If the cursor is in the mouse face area, redisplay that when
22530 we clear the cursor. */
22531 if (! NILP (dpyinfo
->mouse_face_window
)
22532 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
22533 && (vpos
> dpyinfo
->mouse_face_beg_row
22534 || (vpos
== dpyinfo
->mouse_face_beg_row
22535 && hpos
>= dpyinfo
->mouse_face_beg_col
))
22536 && (vpos
< dpyinfo
->mouse_face_end_row
22537 || (vpos
== dpyinfo
->mouse_face_end_row
22538 && hpos
< dpyinfo
->mouse_face_end_col
))
22539 /* Don't redraw the cursor's spot in mouse face if it is at the
22540 end of a line (on a newline). The cursor appears there, but
22541 mouse highlighting does not. */
22542 && cursor_row
->used
[TEXT_AREA
] > hpos
)
22543 mouse_face_here_p
= 1;
22545 /* Maybe clear the display under the cursor. */
22546 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
22549 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
22552 cursor_glyph
= get_phys_cursor_glyph (w
);
22553 if (cursor_glyph
== NULL
)
22554 goto mark_cursor_off
;
22556 width
= cursor_glyph
->pixel_width
;
22557 left_x
= window_box_left_offset (w
, TEXT_AREA
);
22558 x
= w
->phys_cursor
.x
;
22560 width
-= left_x
- x
;
22561 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
22562 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
22563 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
22566 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
22569 /* Erase the cursor by redrawing the character underneath it. */
22570 if (mouse_face_here_p
)
22571 hl
= DRAW_MOUSE_FACE
;
22573 hl
= DRAW_NORMAL_TEXT
;
22574 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
22577 w
->phys_cursor_on_p
= 0;
22578 w
->phys_cursor_type
= NO_CURSOR
;
22583 Display or clear cursor of window W. If ON is zero, clear the
22584 cursor. If it is non-zero, display the cursor. If ON is nonzero,
22585 where to put the cursor is specified by HPOS, VPOS, X and Y. */
22588 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
22590 int on
, hpos
, vpos
, x
, y
;
22592 struct frame
*f
= XFRAME (w
->frame
);
22593 int new_cursor_type
;
22594 int new_cursor_width
;
22596 struct glyph_row
*glyph_row
;
22597 struct glyph
*glyph
;
22599 /* This is pointless on invisible frames, and dangerous on garbaged
22600 windows and frames; in the latter case, the frame or window may
22601 be in the midst of changing its size, and x and y may be off the
22603 if (! FRAME_VISIBLE_P (f
)
22604 || FRAME_GARBAGED_P (f
)
22605 || vpos
>= w
->current_matrix
->nrows
22606 || hpos
>= w
->current_matrix
->matrix_w
)
22609 /* If cursor is off and we want it off, return quickly. */
22610 if (!on
&& !w
->phys_cursor_on_p
)
22613 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
22614 /* If cursor row is not enabled, we don't really know where to
22615 display the cursor. */
22616 if (!glyph_row
->enabled_p
)
22618 w
->phys_cursor_on_p
= 0;
22623 if (!glyph_row
->exact_window_width_line_p
22624 || hpos
< glyph_row
->used
[TEXT_AREA
])
22625 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
22627 xassert (interrupt_input_blocked
);
22629 /* Set new_cursor_type to the cursor we want to be displayed. */
22630 new_cursor_type
= get_window_cursor_type (w
, glyph
,
22631 &new_cursor_width
, &active_cursor
);
22633 /* If cursor is currently being shown and we don't want it to be or
22634 it is in the wrong place, or the cursor type is not what we want,
22636 if (w
->phys_cursor_on_p
22638 || w
->phys_cursor
.x
!= x
22639 || w
->phys_cursor
.y
!= y
22640 || new_cursor_type
!= w
->phys_cursor_type
22641 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
22642 && new_cursor_width
!= w
->phys_cursor_width
)))
22643 erase_phys_cursor (w
);
22645 /* Don't check phys_cursor_on_p here because that flag is only set
22646 to zero in some cases where we know that the cursor has been
22647 completely erased, to avoid the extra work of erasing the cursor
22648 twice. In other words, phys_cursor_on_p can be 1 and the cursor
22649 still not be visible, or it has only been partly erased. */
22652 w
->phys_cursor_ascent
= glyph_row
->ascent
;
22653 w
->phys_cursor_height
= glyph_row
->height
;
22655 /* Set phys_cursor_.* before x_draw_.* is called because some
22656 of them may need the information. */
22657 w
->phys_cursor
.x
= x
;
22658 w
->phys_cursor
.y
= glyph_row
->y
;
22659 w
->phys_cursor
.hpos
= hpos
;
22660 w
->phys_cursor
.vpos
= vpos
;
22663 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
22664 new_cursor_type
, new_cursor_width
,
22665 on
, active_cursor
);
22669 /* Switch the display of W's cursor on or off, according to the value
22676 update_window_cursor (w
, on
)
22680 /* Don't update cursor in windows whose frame is in the process
22681 of being deleted. */
22682 if (w
->current_matrix
)
22685 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22686 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22692 /* Call update_window_cursor with parameter ON_P on all leaf windows
22693 in the window tree rooted at W. */
22696 update_cursor_in_window_tree (w
, on_p
)
22702 if (!NILP (w
->hchild
))
22703 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
22704 else if (!NILP (w
->vchild
))
22705 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
22707 update_window_cursor (w
, on_p
);
22709 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
22715 Display the cursor on window W, or clear it, according to ON_P.
22716 Don't change the cursor's position. */
22719 x_update_cursor (f
, on_p
)
22723 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
22728 Clear the cursor of window W to background color, and mark the
22729 cursor as not shown. This is used when the text where the cursor
22730 is about to be rewritten. */
22736 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
22737 update_window_cursor (w
, 0);
22742 Display the active region described by mouse_face_* according to DRAW. */
22745 show_mouse_face (dpyinfo
, draw
)
22746 Display_Info
*dpyinfo
;
22747 enum draw_glyphs_face draw
;
22749 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
22750 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22752 if (/* If window is in the process of being destroyed, don't bother
22754 w
->current_matrix
!= NULL
22755 /* Don't update mouse highlight if hidden */
22756 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
22757 /* Recognize when we are called to operate on rows that don't exist
22758 anymore. This can happen when a window is split. */
22759 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
22761 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
22762 struct glyph_row
*row
, *first
, *last
;
22764 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
22765 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
22767 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
22769 int start_hpos
, end_hpos
, start_x
;
22771 /* For all but the first row, the highlight starts at column 0. */
22774 start_hpos
= dpyinfo
->mouse_face_beg_col
;
22775 start_x
= dpyinfo
->mouse_face_beg_x
;
22784 end_hpos
= dpyinfo
->mouse_face_end_col
;
22787 end_hpos
= row
->used
[TEXT_AREA
];
22788 if (draw
== DRAW_NORMAL_TEXT
)
22789 row
->fill_line_p
= 1; /* Clear to end of line */
22792 if (end_hpos
> start_hpos
)
22794 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
22795 start_hpos
, end_hpos
,
22799 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
22803 /* When we've written over the cursor, arrange for it to
22804 be displayed again. */
22805 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
22808 display_and_set_cursor (w
, 1,
22809 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
22810 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
22815 /* Change the mouse cursor. */
22816 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
22817 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
22818 else if (draw
== DRAW_MOUSE_FACE
)
22819 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
22821 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
22825 Clear out the mouse-highlighted active region.
22826 Redraw it un-highlighted first. Value is non-zero if mouse
22827 face was actually drawn unhighlighted. */
22830 clear_mouse_face (dpyinfo
)
22831 Display_Info
*dpyinfo
;
22835 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
22837 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
22841 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
22842 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
22843 dpyinfo
->mouse_face_window
= Qnil
;
22844 dpyinfo
->mouse_face_overlay
= Qnil
;
22850 Non-zero if physical cursor of window W is within mouse face. */
22853 cursor_in_mouse_face_p (w
)
22856 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
22857 int in_mouse_face
= 0;
22859 if (WINDOWP (dpyinfo
->mouse_face_window
)
22860 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
22862 int hpos
= w
->phys_cursor
.hpos
;
22863 int vpos
= w
->phys_cursor
.vpos
;
22865 if (vpos
>= dpyinfo
->mouse_face_beg_row
22866 && vpos
<= dpyinfo
->mouse_face_end_row
22867 && (vpos
> dpyinfo
->mouse_face_beg_row
22868 || hpos
>= dpyinfo
->mouse_face_beg_col
)
22869 && (vpos
< dpyinfo
->mouse_face_end_row
22870 || hpos
< dpyinfo
->mouse_face_end_col
22871 || dpyinfo
->mouse_face_past_end
))
22875 return in_mouse_face
;
22881 /* This function sets the mouse_face_* elements of DPYINFO, assuming
22882 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
22883 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
22884 for the overlay or run of text properties specifying the mouse
22885 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
22886 before-string and after-string that must also be highlighted.
22887 DISPLAY_STRING, if non-nil, is a display string that may cover some
22888 or all of the highlighted text. */
22891 mouse_face_from_buffer_pos (Lisp_Object window
,
22892 Display_Info
*dpyinfo
,
22893 EMACS_INT mouse_charpos
,
22894 EMACS_INT start_charpos
,
22895 EMACS_INT end_charpos
,
22896 Lisp_Object before_string
,
22897 Lisp_Object after_string
,
22898 Lisp_Object display_string
)
22900 struct window
*w
= XWINDOW (window
);
22901 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
22902 struct glyph_row
*row
;
22903 struct glyph
*glyph
, *end
;
22907 xassert (NILP (display_string
) || STRINGP (display_string
));
22908 xassert (NILP (before_string
) || STRINGP (before_string
));
22909 xassert (NILP (after_string
) || STRINGP (after_string
));
22911 /* Find the first highlighted glyph. */
22912 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
22914 dpyinfo
->mouse_face_beg_col
= 0;
22915 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
22916 dpyinfo
->mouse_face_beg_x
= first
->x
;
22917 dpyinfo
->mouse_face_beg_y
= first
->y
;
22921 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
22923 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22925 /* If the before-string or display-string contains newlines,
22926 row_containing_pos skips to its last row. Move back. */
22927 if (!NILP (before_string
) || !NILP (display_string
))
22929 struct glyph_row
*prev
;
22930 while ((prev
= row
- 1, prev
>= first
)
22931 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
22932 && prev
->used
[TEXT_AREA
] > 0)
22934 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
22935 glyph
= beg
+ prev
->used
[TEXT_AREA
];
22936 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
22938 || !(EQ (glyph
->object
, before_string
)
22939 || EQ (glyph
->object
, display_string
)))
22945 glyph
= row
->glyphs
[TEXT_AREA
];
22946 end
= glyph
+ row
->used
[TEXT_AREA
];
22948 dpyinfo
->mouse_face_beg_y
= row
->y
;
22949 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
22951 /* Skip truncation glyphs at the start of the glyph row. */
22952 if (row
->displays_text_p
)
22954 && INTEGERP (glyph
->object
)
22955 && glyph
->charpos
< 0;
22957 x
+= glyph
->pixel_width
;
22959 /* Scan the glyph row, stopping before BEFORE_STRING or
22960 DISPLAY_STRING or START_CHARPOS. */
22962 && !INTEGERP (glyph
->object
)
22963 && !EQ (glyph
->object
, before_string
)
22964 && !EQ (glyph
->object
, display_string
)
22965 && !(BUFFERP (glyph
->object
)
22966 && glyph
->charpos
>= start_charpos
);
22968 x
+= glyph
->pixel_width
;
22970 dpyinfo
->mouse_face_beg_x
= x
;
22971 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
22974 /* Find the last highlighted glyph. */
22975 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
22978 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22979 dpyinfo
->mouse_face_past_end
= 1;
22981 else if (!NILP (after_string
))
22983 /* If the after-string has newlines, advance to its last row. */
22984 struct glyph_row
*next
;
22985 struct glyph_row
*last
22986 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
22988 for (next
= row
+ 1;
22990 && next
->used
[TEXT_AREA
] > 0
22991 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
22996 glyph
= row
->glyphs
[TEXT_AREA
];
22997 end
= glyph
+ row
->used
[TEXT_AREA
];
22999 dpyinfo
->mouse_face_end_y
= row
->y
;
23000 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23002 /* Skip truncation glyphs at the start of the row. */
23003 if (row
->displays_text_p
)
23005 && INTEGERP (glyph
->object
)
23006 && glyph
->charpos
< 0;
23008 x
+= glyph
->pixel_width
;
23010 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23013 && !INTEGERP (glyph
->object
)
23014 && !EQ (glyph
->object
, after_string
)
23015 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23017 x
+= glyph
->pixel_width
;
23019 /* If we found AFTER_STRING, consume it and stop. */
23020 if (EQ (glyph
->object
, after_string
))
23022 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23023 x
+= glyph
->pixel_width
;
23027 /* If there's no after-string, we must check if we overshot,
23028 which might be the case if we stopped after a string glyph.
23029 That glyph may belong to a before-string or display-string
23030 associated with the end position, which must not be
23032 Lisp_Object prev_object
;
23035 while (glyph
> row
->glyphs
[TEXT_AREA
])
23037 prev_object
= (glyph
- 1)->object
;
23038 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23041 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23042 if (pos
&& pos
< end_charpos
)
23045 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23046 && EQ ((glyph
- 1)->object
, prev_object
);
23048 x
-= (glyph
- 1)->pixel_width
;
23052 dpyinfo
->mouse_face_end_x
= x
;
23053 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23054 dpyinfo
->mouse_face_window
= window
;
23055 dpyinfo
->mouse_face_face_id
23056 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
23058 !dpyinfo
->mouse_face_hidden
, -1);
23059 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23063 /* Find the position of the glyph for position POS in OBJECT in
23064 window W's current matrix, and return in *X, *Y the pixel
23065 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
23067 RIGHT_P non-zero means return the position of the right edge of the
23068 glyph, RIGHT_P zero means return the left edge position.
23070 If no glyph for POS exists in the matrix, return the position of
23071 the glyph with the next smaller position that is in the matrix, if
23072 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
23073 exists in the matrix, return the position of the glyph with the
23074 next larger position in OBJECT.
23076 Value is non-zero if a glyph was found. */
23079 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
23082 Lisp_Object object
;
23083 int *hpos
, *vpos
, *x
, *y
;
23086 int yb
= window_text_bottom_y (w
);
23087 struct glyph_row
*r
;
23088 struct glyph
*best_glyph
= NULL
;
23089 struct glyph_row
*best_row
= NULL
;
23092 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23093 r
->enabled_p
&& r
->y
< yb
;
23096 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
23097 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
23100 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
23101 if (EQ (g
->object
, object
))
23103 if (g
->charpos
== pos
)
23110 else if (best_glyph
== NULL
23111 || ((eabs (g
->charpos
- pos
)
23112 < eabs (best_glyph
->charpos
- pos
))
23115 : g
->charpos
> pos
)))
23129 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
23133 *x
+= best_glyph
->pixel_width
;
23138 *vpos
= best_row
- w
->current_matrix
->rows
;
23141 return best_glyph
!= NULL
;
23145 /* See if position X, Y is within a hot-spot of an image. */
23148 on_hot_spot_p (hot_spot
, x
, y
)
23149 Lisp_Object hot_spot
;
23152 if (!CONSP (hot_spot
))
23155 if (EQ (XCAR (hot_spot
), Qrect
))
23157 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
23158 Lisp_Object rect
= XCDR (hot_spot
);
23162 if (!CONSP (XCAR (rect
)))
23164 if (!CONSP (XCDR (rect
)))
23166 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
23168 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
23170 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
23172 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
23176 else if (EQ (XCAR (hot_spot
), Qcircle
))
23178 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
23179 Lisp_Object circ
= XCDR (hot_spot
);
23180 Lisp_Object lr
, lx0
, ly0
;
23182 && CONSP (XCAR (circ
))
23183 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
23184 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
23185 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
23187 double r
= XFLOATINT (lr
);
23188 double dx
= XINT (lx0
) - x
;
23189 double dy
= XINT (ly0
) - y
;
23190 return (dx
* dx
+ dy
* dy
<= r
* r
);
23193 else if (EQ (XCAR (hot_spot
), Qpoly
))
23195 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
23196 if (VECTORP (XCDR (hot_spot
)))
23198 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
23199 Lisp_Object
*poly
= v
->contents
;
23203 Lisp_Object lx
, ly
;
23206 /* Need an even number of coordinates, and at least 3 edges. */
23207 if (n
< 6 || n
& 1)
23210 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
23211 If count is odd, we are inside polygon. Pixels on edges
23212 may or may not be included depending on actual geometry of the
23214 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
23215 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
23217 x0
= XINT (lx
), y0
= XINT (ly
);
23218 for (i
= 0; i
< n
; i
+= 2)
23220 int x1
= x0
, y1
= y0
;
23221 if ((lx
= poly
[i
], !INTEGERP (lx
))
23222 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
23224 x0
= XINT (lx
), y0
= XINT (ly
);
23226 /* Does this segment cross the X line? */
23234 if (y
> y0
&& y
> y1
)
23236 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
23246 find_hot_spot (map
, x
, y
)
23250 while (CONSP (map
))
23252 if (CONSP (XCAR (map
))
23253 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
23261 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
23263 doc
: /* Lookup in image map MAP coordinates X and Y.
23264 An image map is an alist where each element has the format (AREA ID PLIST).
23265 An AREA is specified as either a rectangle, a circle, or a polygon:
23266 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
23267 pixel coordinates of the upper left and bottom right corners.
23268 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
23269 and the radius of the circle; r may be a float or integer.
23270 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
23271 vector describes one corner in the polygon.
23272 Returns the alist element for the first matching AREA in MAP. */)
23283 return find_hot_spot (map
, XINT (x
), XINT (y
));
23287 /* Display frame CURSOR, optionally using shape defined by POINTER. */
23289 define_frame_cursor1 (f
, cursor
, pointer
)
23292 Lisp_Object pointer
;
23294 /* Do not change cursor shape while dragging mouse. */
23295 if (!NILP (do_mouse_tracking
))
23298 if (!NILP (pointer
))
23300 if (EQ (pointer
, Qarrow
))
23301 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23302 else if (EQ (pointer
, Qhand
))
23303 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
23304 else if (EQ (pointer
, Qtext
))
23305 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23306 else if (EQ (pointer
, intern ("hdrag")))
23307 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23308 #ifdef HAVE_X_WINDOWS
23309 else if (EQ (pointer
, intern ("vdrag")))
23310 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
23312 else if (EQ (pointer
, intern ("hourglass")))
23313 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
23314 else if (EQ (pointer
, Qmodeline
))
23315 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
23317 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23320 if (cursor
!= No_Cursor
)
23321 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
23324 /* Take proper action when mouse has moved to the mode or header line
23325 or marginal area AREA of window W, x-position X and y-position Y.
23326 X is relative to the start of the text display area of W, so the
23327 width of bitmap areas and scroll bars must be subtracted to get a
23328 position relative to the start of the mode line. */
23331 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
23332 Lisp_Object window
;
23334 enum window_part area
;
23336 struct window
*w
= XWINDOW (window
);
23337 struct frame
*f
= XFRAME (w
->frame
);
23338 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23339 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23340 Lisp_Object pointer
= Qnil
;
23341 int charpos
, dx
, dy
, width
, height
;
23342 Lisp_Object string
, object
= Qnil
;
23343 Lisp_Object pos
, help
;
23345 Lisp_Object mouse_face
;
23346 int original_x_pixel
= x
;
23347 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
23348 struct glyph_row
*row
;
23350 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
23355 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
23356 &object
, &dx
, &dy
, &width
, &height
);
23358 row
= (area
== ON_MODE_LINE
23359 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
23360 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
23363 if (row
->mode_line_p
&& row
->enabled_p
)
23365 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
23366 end
= glyph
+ row
->used
[TEXT_AREA
];
23368 for (x0
= original_x_pixel
;
23369 glyph
< end
&& x0
>= glyph
->pixel_width
;
23371 x0
-= glyph
->pixel_width
;
23379 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
23380 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
23381 &object
, &dx
, &dy
, &width
, &height
);
23386 if (IMAGEP (object
))
23388 Lisp_Object image_map
, hotspot
;
23389 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
23391 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
23393 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23395 Lisp_Object area_id
, plist
;
23397 area_id
= XCAR (hotspot
);
23398 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23399 If so, we could look for mouse-enter, mouse-leave
23400 properties in PLIST (and do something...). */
23401 hotspot
= XCDR (hotspot
);
23402 if (CONSP (hotspot
)
23403 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23405 pointer
= Fplist_get (plist
, Qpointer
);
23406 if (NILP (pointer
))
23408 help
= Fplist_get (plist
, Qhelp_echo
);
23411 help_echo_string
= help
;
23412 /* Is this correct? ++kfs */
23413 XSETWINDOW (help_echo_window
, w
);
23414 help_echo_object
= w
->buffer
;
23415 help_echo_pos
= charpos
;
23419 if (NILP (pointer
))
23420 pointer
= Fplist_get (XCDR (object
), QCpointer
);
23423 if (STRINGP (string
))
23425 pos
= make_number (charpos
);
23426 /* If we're on a string with `help-echo' text property, arrange
23427 for the help to be displayed. This is done by setting the
23428 global variable help_echo_string to the help string. */
23431 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
23434 help_echo_string
= help
;
23435 XSETWINDOW (help_echo_window
, w
);
23436 help_echo_object
= string
;
23437 help_echo_pos
= charpos
;
23441 if (NILP (pointer
))
23442 pointer
= Fget_text_property (pos
, Qpointer
, string
);
23444 /* Change the mouse pointer according to what is under X/Y. */
23445 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
23448 map
= Fget_text_property (pos
, Qlocal_map
, string
);
23449 if (!KEYMAPP (map
))
23450 map
= Fget_text_property (pos
, Qkeymap
, string
);
23451 if (!KEYMAPP (map
))
23452 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
23455 /* Change the mouse face according to what is under X/Y. */
23456 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
23457 if (!NILP (mouse_face
)
23458 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23463 struct glyph
* tmp_glyph
;
23467 int total_pixel_width
;
23472 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
23473 Qmouse_face
, string
, Qnil
);
23475 b
= make_number (0);
23477 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
23479 e
= make_number (SCHARS (string
));
23481 /* Calculate the position(glyph position: GPOS) of GLYPH in
23482 displayed string. GPOS is different from CHARPOS.
23484 CHARPOS is the position of glyph in internal string
23485 object. A mode line string format has structures which
23486 is converted to a flatten by emacs lisp interpreter.
23487 The internal string is an element of the structures.
23488 The displayed string is the flatten string. */
23490 if (glyph
> row_start_glyph
)
23492 tmp_glyph
= glyph
- 1;
23493 while (tmp_glyph
>= row_start_glyph
23494 && tmp_glyph
->charpos
>= XINT (b
)
23495 && EQ (tmp_glyph
->object
, glyph
->object
))
23502 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
23503 displayed string holding GLYPH.
23505 GSEQ_LENGTH is different from SCHARS (STRING).
23506 SCHARS (STRING) returns the length of the internal string. */
23507 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
23508 tmp_glyph
->charpos
< XINT (e
);
23509 tmp_glyph
++, gseq_length
++)
23511 if (!EQ (tmp_glyph
->object
, glyph
->object
))
23515 total_pixel_width
= 0;
23516 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
23517 total_pixel_width
+= tmp_glyph
->pixel_width
;
23519 /* Pre calculation of re-rendering position */
23521 hpos
= (area
== ON_MODE_LINE
23522 ? (w
->current_matrix
)->nrows
- 1
23525 /* If the re-rendering position is included in the last
23526 re-rendering area, we should do nothing. */
23527 if ( EQ (window
, dpyinfo
->mouse_face_window
)
23528 && dpyinfo
->mouse_face_beg_col
<= vpos
23529 && vpos
< dpyinfo
->mouse_face_end_col
23530 && dpyinfo
->mouse_face_beg_row
== hpos
)
23533 if (clear_mouse_face (dpyinfo
))
23534 cursor
= No_Cursor
;
23536 dpyinfo
->mouse_face_beg_col
= vpos
;
23537 dpyinfo
->mouse_face_beg_row
= hpos
;
23539 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
23540 dpyinfo
->mouse_face_beg_y
= 0;
23542 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
23543 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
23545 dpyinfo
->mouse_face_end_x
= 0;
23546 dpyinfo
->mouse_face_end_y
= 0;
23548 dpyinfo
->mouse_face_past_end
= 0;
23549 dpyinfo
->mouse_face_window
= window
;
23551 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
23554 glyph
->face_id
, 1);
23555 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23557 if (NILP (pointer
))
23560 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
23561 clear_mouse_face (dpyinfo
);
23563 define_frame_cursor1 (f
, cursor
, pointer
);
23568 Take proper action when the mouse has moved to position X, Y on
23569 frame F as regards highlighting characters that have mouse-face
23570 properties. Also de-highlighting chars where the mouse was before.
23571 X and Y can be negative or out of range. */
23574 note_mouse_highlight (f
, x
, y
)
23578 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23579 enum window_part part
;
23580 Lisp_Object window
;
23582 Cursor cursor
= No_Cursor
;
23583 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
23586 /* When a menu is active, don't highlight because this looks odd. */
23587 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
23588 if (popup_activated ())
23592 if (NILP (Vmouse_highlight
)
23593 || !f
->glyphs_initialized_p
)
23596 dpyinfo
->mouse_face_mouse_x
= x
;
23597 dpyinfo
->mouse_face_mouse_y
= y
;
23598 dpyinfo
->mouse_face_mouse_frame
= f
;
23600 if (dpyinfo
->mouse_face_defer
)
23603 if (gc_in_progress
)
23605 dpyinfo
->mouse_face_deferred_gc
= 1;
23609 /* Which window is that in? */
23610 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
23612 /* If we were displaying active text in another window, clear that.
23613 Also clear if we move out of text area in same window. */
23614 if (! EQ (window
, dpyinfo
->mouse_face_window
)
23615 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
23616 && !NILP (dpyinfo
->mouse_face_window
)))
23617 clear_mouse_face (dpyinfo
);
23619 /* Not on a window -> return. */
23620 if (!WINDOWP (window
))
23623 /* Reset help_echo_string. It will get recomputed below. */
23624 help_echo_string
= Qnil
;
23626 /* Convert to window-relative pixel coordinates. */
23627 w
= XWINDOW (window
);
23628 frame_to_window_pixel_xy (w
, &x
, &y
);
23630 /* Handle tool-bar window differently since it doesn't display a
23632 if (EQ (window
, f
->tool_bar_window
))
23634 note_tool_bar_highlight (f
, x
, y
);
23638 /* Mouse is on the mode, header line or margin? */
23639 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
23640 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
23642 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
23646 if (part
== ON_VERTICAL_BORDER
)
23648 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
23649 help_echo_string
= build_string ("drag-mouse-1: resize");
23651 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
23652 || part
== ON_SCROLL_BAR
)
23653 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23655 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
23657 /* Are we in a window whose display is up to date?
23658 And verify the buffer's text has not changed. */
23659 b
= XBUFFER (w
->buffer
);
23660 if (part
== ON_TEXT
23661 && EQ (w
->window_end_valid
, w
->buffer
)
23662 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
23663 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
23665 int hpos
, vpos
, pos
, i
, dx
, dy
, area
;
23666 struct glyph
*glyph
;
23667 Lisp_Object object
;
23668 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
23669 Lisp_Object
*overlay_vec
= NULL
;
23671 struct buffer
*obuf
;
23672 int obegv
, ozv
, same_region
;
23674 /* Find the glyph under X/Y. */
23675 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
23677 /* Look for :pointer property on image. */
23678 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23680 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23681 if (img
!= NULL
&& IMAGEP (img
->spec
))
23683 Lisp_Object image_map
, hotspot
;
23684 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
23686 && (hotspot
= find_hot_spot (image_map
,
23687 glyph
->slice
.x
+ dx
,
23688 glyph
->slice
.y
+ dy
),
23690 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
23692 Lisp_Object area_id
, plist
;
23694 area_id
= XCAR (hotspot
);
23695 /* Could check AREA_ID to see if we enter/leave this hot-spot.
23696 If so, we could look for mouse-enter, mouse-leave
23697 properties in PLIST (and do something...). */
23698 hotspot
= XCDR (hotspot
);
23699 if (CONSP (hotspot
)
23700 && (plist
= XCAR (hotspot
), CONSP (plist
)))
23702 pointer
= Fplist_get (plist
, Qpointer
);
23703 if (NILP (pointer
))
23705 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
23706 if (!NILP (help_echo_string
))
23708 help_echo_window
= window
;
23709 help_echo_object
= glyph
->object
;
23710 help_echo_pos
= glyph
->charpos
;
23714 if (NILP (pointer
))
23715 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
23719 /* Clear mouse face if X/Y not over text. */
23721 || area
!= TEXT_AREA
23722 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
23724 if (clear_mouse_face (dpyinfo
))
23725 cursor
= No_Cursor
;
23726 if (NILP (pointer
))
23728 if (area
!= TEXT_AREA
)
23729 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
23731 pointer
= Vvoid_text_area_pointer
;
23736 pos
= glyph
->charpos
;
23737 object
= glyph
->object
;
23738 if (!STRINGP (object
) && !BUFFERP (object
))
23741 /* If we get an out-of-range value, return now; avoid an error. */
23742 if (BUFFERP (object
) && pos
> BUF_Z (b
))
23745 /* Make the window's buffer temporarily current for
23746 overlays_at and compute_char_face. */
23747 obuf
= current_buffer
;
23748 current_buffer
= b
;
23754 /* Is this char mouse-active or does it have help-echo? */
23755 position
= make_number (pos
);
23757 if (BUFFERP (object
))
23759 /* Put all the overlays we want in a vector in overlay_vec. */
23760 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
23761 /* Sort overlays into increasing priority order. */
23762 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
23767 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
23768 && vpos
>= dpyinfo
->mouse_face_beg_row
23769 && vpos
<= dpyinfo
->mouse_face_end_row
23770 && (vpos
> dpyinfo
->mouse_face_beg_row
23771 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23772 && (vpos
< dpyinfo
->mouse_face_end_row
23773 || hpos
< dpyinfo
->mouse_face_end_col
23774 || dpyinfo
->mouse_face_past_end
));
23777 cursor
= No_Cursor
;
23779 /* Check mouse-face highlighting. */
23781 /* If there exists an overlay with mouse-face overlapping
23782 the one we are currently highlighting, we have to
23783 check if we enter the overlapping overlay, and then
23784 highlight only that. */
23785 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
23786 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
23788 /* Find the highest priority overlay with a mouse-face. */
23790 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
23792 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
23793 if (!NILP (mouse_face
))
23794 overlay
= overlay_vec
[i
];
23797 /* If we're highlighting the same overlay as before, there's
23798 no need to do that again. */
23799 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
23800 goto check_help_echo
;
23801 dpyinfo
->mouse_face_overlay
= overlay
;
23803 /* Clear the display of the old active region, if any. */
23804 if (clear_mouse_face (dpyinfo
))
23805 cursor
= No_Cursor
;
23807 /* If no overlay applies, get a text property. */
23808 if (NILP (overlay
))
23809 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
23811 /* Next, compute the bounds of the mouse highlighting and
23813 if (!NILP (mouse_face
) && STRINGP (object
))
23815 /* The mouse-highlighting comes from a display string
23816 with a mouse-face. */
23820 b
= Fprevious_single_property_change
23821 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
23822 e
= Fnext_single_property_change
23823 (position
, Qmouse_face
, object
, Qnil
);
23825 b
= make_number (0);
23827 e
= make_number (SCHARS (object
) - 1);
23829 fast_find_string_pos (w
, XINT (b
), object
,
23830 &dpyinfo
->mouse_face_beg_col
,
23831 &dpyinfo
->mouse_face_beg_row
,
23832 &dpyinfo
->mouse_face_beg_x
,
23833 &dpyinfo
->mouse_face_beg_y
, 0);
23834 fast_find_string_pos (w
, XINT (e
), object
,
23835 &dpyinfo
->mouse_face_end_col
,
23836 &dpyinfo
->mouse_face_end_row
,
23837 &dpyinfo
->mouse_face_end_x
,
23838 &dpyinfo
->mouse_face_end_y
, 1);
23839 dpyinfo
->mouse_face_past_end
= 0;
23840 dpyinfo
->mouse_face_window
= window
;
23841 dpyinfo
->mouse_face_face_id
23842 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
23843 glyph
->face_id
, 1);
23844 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
23845 cursor
= No_Cursor
;
23849 /* The mouse-highlighting, if any, comes from an overlay
23850 or text property in the buffer. */
23851 Lisp_Object buffer
, display_string
;
23853 if (STRINGP (object
))
23855 /* If we are on a display string with no mouse-face,
23856 check if the text under it has one. */
23857 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
23858 int start
= MATRIX_ROW_START_CHARPOS (r
);
23859 pos
= string_buffer_position (w
, object
, start
);
23862 mouse_face
= get_char_property_and_overlay
23863 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
23864 buffer
= w
->buffer
;
23865 display_string
= object
;
23871 display_string
= Qnil
;
23874 if (!NILP (mouse_face
))
23876 Lisp_Object before
, after
;
23877 Lisp_Object before_string
, after_string
;
23879 if (NILP (overlay
))
23881 /* Handle the text property case. */
23882 before
= Fprevious_single_property_change
23883 (make_number (pos
+ 1), Qmouse_face
, buffer
,
23884 Fmarker_position (w
->start
));
23885 after
= Fnext_single_property_change
23886 (make_number (pos
), Qmouse_face
, buffer
,
23887 make_number (BUF_Z (XBUFFER (buffer
))
23888 - XFASTINT (w
->window_end_pos
)));
23889 before_string
= after_string
= Qnil
;
23893 /* Handle the overlay case. */
23894 before
= Foverlay_start (overlay
);
23895 after
= Foverlay_end (overlay
);
23896 before_string
= Foverlay_get (overlay
, Qbefore_string
);
23897 after_string
= Foverlay_get (overlay
, Qafter_string
);
23899 if (!STRINGP (before_string
)) before_string
= Qnil
;
23900 if (!STRINGP (after_string
)) after_string
= Qnil
;
23903 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
23906 before_string
, after_string
,
23908 cursor
= No_Cursor
;
23915 /* Look for a `help-echo' property. */
23916 if (NILP (help_echo_string
)) {
23917 Lisp_Object help
, overlay
;
23919 /* Check overlays first. */
23920 help
= overlay
= Qnil
;
23921 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
23923 overlay
= overlay_vec
[i
];
23924 help
= Foverlay_get (overlay
, Qhelp_echo
);
23929 help_echo_string
= help
;
23930 help_echo_window
= window
;
23931 help_echo_object
= overlay
;
23932 help_echo_pos
= pos
;
23936 Lisp_Object object
= glyph
->object
;
23937 int charpos
= glyph
->charpos
;
23939 /* Try text properties. */
23940 if (STRINGP (object
)
23942 && charpos
< SCHARS (object
))
23944 help
= Fget_text_property (make_number (charpos
),
23945 Qhelp_echo
, object
);
23948 /* If the string itself doesn't specify a help-echo,
23949 see if the buffer text ``under'' it does. */
23950 struct glyph_row
*r
23951 = MATRIX_ROW (w
->current_matrix
, vpos
);
23952 int start
= MATRIX_ROW_START_CHARPOS (r
);
23953 int pos
= string_buffer_position (w
, object
, start
);
23956 help
= Fget_char_property (make_number (pos
),
23957 Qhelp_echo
, w
->buffer
);
23961 object
= w
->buffer
;
23966 else if (BUFFERP (object
)
23969 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
23974 help_echo_string
= help
;
23975 help_echo_window
= window
;
23976 help_echo_object
= object
;
23977 help_echo_pos
= charpos
;
23982 /* Look for a `pointer' property. */
23983 if (NILP (pointer
))
23985 /* Check overlays first. */
23986 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
23987 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
23989 if (NILP (pointer
))
23991 Lisp_Object object
= glyph
->object
;
23992 int charpos
= glyph
->charpos
;
23994 /* Try text properties. */
23995 if (STRINGP (object
)
23997 && charpos
< SCHARS (object
))
23999 pointer
= Fget_text_property (make_number (charpos
),
24001 if (NILP (pointer
))
24003 /* If the string itself doesn't specify a pointer,
24004 see if the buffer text ``under'' it does. */
24005 struct glyph_row
*r
24006 = MATRIX_ROW (w
->current_matrix
, vpos
);
24007 int start
= MATRIX_ROW_START_CHARPOS (r
);
24008 int pos
= string_buffer_position (w
, object
, start
);
24010 pointer
= Fget_char_property (make_number (pos
),
24011 Qpointer
, w
->buffer
);
24014 else if (BUFFERP (object
)
24017 pointer
= Fget_text_property (make_number (charpos
),
24024 current_buffer
= obuf
;
24029 define_frame_cursor1 (f
, cursor
, pointer
);
24034 Clear any mouse-face on window W. This function is part of the
24035 redisplay interface, and is called from try_window_id and similar
24036 functions to ensure the mouse-highlight is off. */
24039 x_clear_window_mouse_face (w
)
24042 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24043 Lisp_Object window
;
24046 XSETWINDOW (window
, w
);
24047 if (EQ (window
, dpyinfo
->mouse_face_window
))
24048 clear_mouse_face (dpyinfo
);
24054 Just discard the mouse face information for frame F, if any.
24055 This is used when the size of F is changed. */
24058 cancel_mouse_face (f
)
24061 Lisp_Object window
;
24062 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24064 window
= dpyinfo
->mouse_face_window
;
24065 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24067 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24068 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24069 dpyinfo
->mouse_face_window
= Qnil
;
24074 #endif /* HAVE_WINDOW_SYSTEM */
24077 /***********************************************************************
24079 ***********************************************************************/
24081 #ifdef HAVE_WINDOW_SYSTEM
24083 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
24084 which intersects rectangle R. R is in window-relative coordinates. */
24087 expose_area (w
, row
, r
, area
)
24089 struct glyph_row
*row
;
24091 enum glyph_row_area area
;
24093 struct glyph
*first
= row
->glyphs
[area
];
24094 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
24095 struct glyph
*last
;
24096 int first_x
, start_x
, x
;
24098 if (area
== TEXT_AREA
&& row
->fill_line_p
)
24099 /* If row extends face to end of line write the whole line. */
24100 draw_glyphs (w
, 0, row
, area
,
24101 0, row
->used
[area
],
24102 DRAW_NORMAL_TEXT
, 0);
24105 /* Set START_X to the window-relative start position for drawing glyphs of
24106 AREA. The first glyph of the text area can be partially visible.
24107 The first glyphs of other areas cannot. */
24108 start_x
= window_box_left_offset (w
, area
);
24110 if (area
== TEXT_AREA
)
24113 /* Find the first glyph that must be redrawn. */
24115 && x
+ first
->pixel_width
< r
->x
)
24117 x
+= first
->pixel_width
;
24121 /* Find the last one. */
24125 && x
< r
->x
+ r
->width
)
24127 x
+= last
->pixel_width
;
24133 draw_glyphs (w
, first_x
- start_x
, row
, area
,
24134 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
24135 DRAW_NORMAL_TEXT
, 0);
24140 /* Redraw the parts of the glyph row ROW on window W intersecting
24141 rectangle R. R is in window-relative coordinates. Value is
24142 non-zero if mouse-face was overwritten. */
24145 expose_line (w
, row
, r
)
24147 struct glyph_row
*row
;
24150 xassert (row
->enabled_p
);
24152 if (row
->mode_line_p
|| w
->pseudo_window_p
)
24153 draw_glyphs (w
, 0, row
, TEXT_AREA
,
24154 0, row
->used
[TEXT_AREA
],
24155 DRAW_NORMAL_TEXT
, 0);
24158 if (row
->used
[LEFT_MARGIN_AREA
])
24159 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
24160 if (row
->used
[TEXT_AREA
])
24161 expose_area (w
, row
, r
, TEXT_AREA
);
24162 if (row
->used
[RIGHT_MARGIN_AREA
])
24163 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
24164 draw_row_fringe_bitmaps (w
, row
);
24167 return row
->mouse_face_p
;
24171 /* Redraw those parts of glyphs rows during expose event handling that
24172 overlap other rows. Redrawing of an exposed line writes over parts
24173 of lines overlapping that exposed line; this function fixes that.
24175 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
24176 row in W's current matrix that is exposed and overlaps other rows.
24177 LAST_OVERLAPPING_ROW is the last such row. */
24180 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
24182 struct glyph_row
*first_overlapping_row
;
24183 struct glyph_row
*last_overlapping_row
;
24186 struct glyph_row
*row
;
24188 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
24189 if (row
->overlapping_p
)
24191 xassert (row
->enabled_p
&& !row
->mode_line_p
);
24194 if (row
->used
[LEFT_MARGIN_AREA
])
24195 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
24197 if (row
->used
[TEXT_AREA
])
24198 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
24200 if (row
->used
[RIGHT_MARGIN_AREA
])
24201 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
24207 /* Return non-zero if W's cursor intersects rectangle R. */
24210 phys_cursor_in_rect_p (w
, r
)
24214 XRectangle cr
, result
;
24215 struct glyph
*cursor_glyph
;
24216 struct glyph_row
*row
;
24218 if (w
->phys_cursor
.vpos
>= 0
24219 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
24220 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
24222 && row
->cursor_in_fringe_p
)
24224 /* Cursor is in the fringe. */
24225 cr
.x
= window_box_right_offset (w
,
24226 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
24227 ? RIGHT_MARGIN_AREA
24230 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
24231 cr
.height
= row
->height
;
24232 return x_intersect_rectangles (&cr
, r
, &result
);
24235 cursor_glyph
= get_phys_cursor_glyph (w
);
24238 /* r is relative to W's box, but w->phys_cursor.x is relative
24239 to left edge of W's TEXT area. Adjust it. */
24240 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
24241 cr
.y
= w
->phys_cursor
.y
;
24242 cr
.width
= cursor_glyph
->pixel_width
;
24243 cr
.height
= w
->phys_cursor_height
;
24244 /* ++KFS: W32 version used W32-specific IntersectRect here, but
24245 I assume the effect is the same -- and this is portable. */
24246 return x_intersect_rectangles (&cr
, r
, &result
);
24248 /* If we don't understand the format, pretend we're not in the hot-spot. */
24254 Draw a vertical window border to the right of window W if W doesn't
24255 have vertical scroll bars. */
24258 x_draw_vertical_border (w
)
24261 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24263 /* We could do better, if we knew what type of scroll-bar the adjacent
24264 windows (on either side) have... But we don't :-(
24265 However, I think this works ok. ++KFS 2003-04-25 */
24267 /* Redraw borders between horizontally adjacent windows. Don't
24268 do it for frames with vertical scroll bars because either the
24269 right scroll bar of a window, or the left scroll bar of its
24270 neighbor will suffice as a border. */
24271 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
24274 if (!WINDOW_RIGHTMOST_P (w
)
24275 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
24277 int x0
, x1
, y0
, y1
;
24279 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24282 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24285 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
24287 else if (!WINDOW_LEFTMOST_P (w
)
24288 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
24290 int x0
, x1
, y0
, y1
;
24292 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
24295 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
24298 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
24303 /* Redraw the part of window W intersection rectangle FR. Pixel
24304 coordinates in FR are frame-relative. Call this function with
24305 input blocked. Value is non-zero if the exposure overwrites
24309 expose_window (w
, fr
)
24313 struct frame
*f
= XFRAME (w
->frame
);
24315 int mouse_face_overwritten_p
= 0;
24317 /* If window is not yet fully initialized, do nothing. This can
24318 happen when toolkit scroll bars are used and a window is split.
24319 Reconfiguring the scroll bar will generate an expose for a newly
24321 if (w
->current_matrix
== NULL
)
24324 /* When we're currently updating the window, display and current
24325 matrix usually don't agree. Arrange for a thorough display
24327 if (w
== updated_window
)
24329 SET_FRAME_GARBAGED (f
);
24333 /* Frame-relative pixel rectangle of W. */
24334 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
24335 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
24336 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
24337 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
24339 if (x_intersect_rectangles (fr
, &wr
, &r
))
24341 int yb
= window_text_bottom_y (w
);
24342 struct glyph_row
*row
;
24343 int cursor_cleared_p
;
24344 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
24346 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
24347 r
.x
, r
.y
, r
.width
, r
.height
));
24349 /* Convert to window coordinates. */
24350 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
24351 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
24353 /* Turn off the cursor. */
24354 if (!w
->pseudo_window_p
24355 && phys_cursor_in_rect_p (w
, &r
))
24357 x_clear_cursor (w
);
24358 cursor_cleared_p
= 1;
24361 cursor_cleared_p
= 0;
24363 /* Update lines intersecting rectangle R. */
24364 first_overlapping_row
= last_overlapping_row
= NULL
;
24365 for (row
= w
->current_matrix
->rows
;
24370 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
24372 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
24373 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
24374 || (r
.y
>= y0
&& r
.y
< y1
)
24375 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
24377 /* A header line may be overlapping, but there is no need
24378 to fix overlapping areas for them. KFS 2005-02-12 */
24379 if (row
->overlapping_p
&& !row
->mode_line_p
)
24381 if (first_overlapping_row
== NULL
)
24382 first_overlapping_row
= row
;
24383 last_overlapping_row
= row
;
24387 if (expose_line (w
, row
, &r
))
24388 mouse_face_overwritten_p
= 1;
24391 else if (row
->overlapping_p
)
24393 /* We must redraw a row overlapping the exposed area. */
24395 ? y0
+ row
->phys_height
> r
.y
24396 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
24398 if (first_overlapping_row
== NULL
)
24399 first_overlapping_row
= row
;
24400 last_overlapping_row
= row
;
24408 /* Display the mode line if there is one. */
24409 if (WINDOW_WANTS_MODELINE_P (w
)
24410 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
24412 && row
->y
< r
.y
+ r
.height
)
24414 if (expose_line (w
, row
, &r
))
24415 mouse_face_overwritten_p
= 1;
24418 if (!w
->pseudo_window_p
)
24420 /* Fix the display of overlapping rows. */
24421 if (first_overlapping_row
)
24422 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
24425 /* Draw border between windows. */
24426 x_draw_vertical_border (w
);
24428 /* Turn the cursor on again. */
24429 if (cursor_cleared_p
)
24430 update_window_cursor (w
, 1);
24434 return mouse_face_overwritten_p
;
24439 /* Redraw (parts) of all windows in the window tree rooted at W that
24440 intersect R. R contains frame pixel coordinates. Value is
24441 non-zero if the exposure overwrites mouse-face. */
24444 expose_window_tree (w
, r
)
24448 struct frame
*f
= XFRAME (w
->frame
);
24449 int mouse_face_overwritten_p
= 0;
24451 while (w
&& !FRAME_GARBAGED_P (f
))
24453 if (!NILP (w
->hchild
))
24454 mouse_face_overwritten_p
24455 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
24456 else if (!NILP (w
->vchild
))
24457 mouse_face_overwritten_p
24458 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
24460 mouse_face_overwritten_p
|= expose_window (w
, r
);
24462 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
24465 return mouse_face_overwritten_p
;
24470 Redisplay an exposed area of frame F. X and Y are the upper-left
24471 corner of the exposed rectangle. W and H are width and height of
24472 the exposed area. All are pixel values. W or H zero means redraw
24473 the entire frame. */
24476 expose_frame (f
, x
, y
, w
, h
)
24481 int mouse_face_overwritten_p
= 0;
24483 TRACE ((stderr
, "expose_frame "));
24485 /* No need to redraw if frame will be redrawn soon. */
24486 if (FRAME_GARBAGED_P (f
))
24488 TRACE ((stderr
, " garbaged\n"));
24492 /* If basic faces haven't been realized yet, there is no point in
24493 trying to redraw anything. This can happen when we get an expose
24494 event while Emacs is starting, e.g. by moving another window. */
24495 if (FRAME_FACE_CACHE (f
) == NULL
24496 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
24498 TRACE ((stderr
, " no faces\n"));
24502 if (w
== 0 || h
== 0)
24505 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
24506 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
24516 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
24517 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
24519 if (WINDOWP (f
->tool_bar_window
))
24520 mouse_face_overwritten_p
24521 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
24523 #ifdef HAVE_X_WINDOWS
24525 #ifndef USE_X_TOOLKIT
24526 if (WINDOWP (f
->menu_bar_window
))
24527 mouse_face_overwritten_p
24528 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
24529 #endif /* not USE_X_TOOLKIT */
24533 /* Some window managers support a focus-follows-mouse style with
24534 delayed raising of frames. Imagine a partially obscured frame,
24535 and moving the mouse into partially obscured mouse-face on that
24536 frame. The visible part of the mouse-face will be highlighted,
24537 then the WM raises the obscured frame. With at least one WM, KDE
24538 2.1, Emacs is not getting any event for the raising of the frame
24539 (even tried with SubstructureRedirectMask), only Expose events.
24540 These expose events will draw text normally, i.e. not
24541 highlighted. Which means we must redo the highlight here.
24542 Subsume it under ``we love X''. --gerd 2001-08-15 */
24543 /* Included in Windows version because Windows most likely does not
24544 do the right thing if any third party tool offers
24545 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
24546 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
24548 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24549 if (f
== dpyinfo
->mouse_face_mouse_frame
)
24551 int x
= dpyinfo
->mouse_face_mouse_x
;
24552 int y
= dpyinfo
->mouse_face_mouse_y
;
24553 clear_mouse_face (dpyinfo
);
24554 note_mouse_highlight (f
, x
, y
);
24561 Determine the intersection of two rectangles R1 and R2. Return
24562 the intersection in *RESULT. Value is non-zero if RESULT is not
24566 x_intersect_rectangles (r1
, r2
, result
)
24567 XRectangle
*r1
, *r2
, *result
;
24569 XRectangle
*left
, *right
;
24570 XRectangle
*upper
, *lower
;
24571 int intersection_p
= 0;
24573 /* Rearrange so that R1 is the left-most rectangle. */
24575 left
= r1
, right
= r2
;
24577 left
= r2
, right
= r1
;
24579 /* X0 of the intersection is right.x0, if this is inside R1,
24580 otherwise there is no intersection. */
24581 if (right
->x
<= left
->x
+ left
->width
)
24583 result
->x
= right
->x
;
24585 /* The right end of the intersection is the minimum of the
24586 the right ends of left and right. */
24587 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
24590 /* Same game for Y. */
24592 upper
= r1
, lower
= r2
;
24594 upper
= r2
, lower
= r1
;
24596 /* The upper end of the intersection is lower.y0, if this is inside
24597 of upper. Otherwise, there is no intersection. */
24598 if (lower
->y
<= upper
->y
+ upper
->height
)
24600 result
->y
= lower
->y
;
24602 /* The lower end of the intersection is the minimum of the lower
24603 ends of upper and lower. */
24604 result
->height
= (min (lower
->y
+ lower
->height
,
24605 upper
->y
+ upper
->height
)
24607 intersection_p
= 1;
24611 return intersection_p
;
24614 #endif /* HAVE_WINDOW_SYSTEM */
24617 /***********************************************************************
24619 ***********************************************************************/
24624 Vwith_echo_area_save_vector
= Qnil
;
24625 staticpro (&Vwith_echo_area_save_vector
);
24627 Vmessage_stack
= Qnil
;
24628 staticpro (&Vmessage_stack
);
24630 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
24631 staticpro (&Qinhibit_redisplay
);
24633 message_dolog_marker1
= Fmake_marker ();
24634 staticpro (&message_dolog_marker1
);
24635 message_dolog_marker2
= Fmake_marker ();
24636 staticpro (&message_dolog_marker2
);
24637 message_dolog_marker3
= Fmake_marker ();
24638 staticpro (&message_dolog_marker3
);
24641 defsubr (&Sdump_frame_glyph_matrix
);
24642 defsubr (&Sdump_glyph_matrix
);
24643 defsubr (&Sdump_glyph_row
);
24644 defsubr (&Sdump_tool_bar_row
);
24645 defsubr (&Strace_redisplay
);
24646 defsubr (&Strace_to_stderr
);
24648 #ifdef HAVE_WINDOW_SYSTEM
24649 defsubr (&Stool_bar_lines_needed
);
24650 defsubr (&Slookup_image_map
);
24652 defsubr (&Sformat_mode_line
);
24653 defsubr (&Sinvisible_p
);
24655 staticpro (&Qmenu_bar_update_hook
);
24656 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
24658 staticpro (&Qoverriding_terminal_local_map
);
24659 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
24661 staticpro (&Qoverriding_local_map
);
24662 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
24664 staticpro (&Qwindow_scroll_functions
);
24665 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
24667 staticpro (&Qwindow_text_change_functions
);
24668 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
24670 staticpro (&Qredisplay_end_trigger_functions
);
24671 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
24673 staticpro (&Qinhibit_point_motion_hooks
);
24674 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
24676 Qeval
= intern_c_string ("eval");
24677 staticpro (&Qeval
);
24679 QCdata
= intern_c_string (":data");
24680 staticpro (&QCdata
);
24681 Qdisplay
= intern_c_string ("display");
24682 staticpro (&Qdisplay
);
24683 Qspace_width
= intern_c_string ("space-width");
24684 staticpro (&Qspace_width
);
24685 Qraise
= intern_c_string ("raise");
24686 staticpro (&Qraise
);
24687 Qslice
= intern_c_string ("slice");
24688 staticpro (&Qslice
);
24689 Qspace
= intern_c_string ("space");
24690 staticpro (&Qspace
);
24691 Qmargin
= intern_c_string ("margin");
24692 staticpro (&Qmargin
);
24693 Qpointer
= intern_c_string ("pointer");
24694 staticpro (&Qpointer
);
24695 Qleft_margin
= intern_c_string ("left-margin");
24696 staticpro (&Qleft_margin
);
24697 Qright_margin
= intern_c_string ("right-margin");
24698 staticpro (&Qright_margin
);
24699 Qcenter
= intern_c_string ("center");
24700 staticpro (&Qcenter
);
24701 Qline_height
= intern_c_string ("line-height");
24702 staticpro (&Qline_height
);
24703 QCalign_to
= intern_c_string (":align-to");
24704 staticpro (&QCalign_to
);
24705 QCrelative_width
= intern_c_string (":relative-width");
24706 staticpro (&QCrelative_width
);
24707 QCrelative_height
= intern_c_string (":relative-height");
24708 staticpro (&QCrelative_height
);
24709 QCeval
= intern_c_string (":eval");
24710 staticpro (&QCeval
);
24711 QCpropertize
= intern_c_string (":propertize");
24712 staticpro (&QCpropertize
);
24713 QCfile
= intern_c_string (":file");
24714 staticpro (&QCfile
);
24715 Qfontified
= intern_c_string ("fontified");
24716 staticpro (&Qfontified
);
24717 Qfontification_functions
= intern_c_string ("fontification-functions");
24718 staticpro (&Qfontification_functions
);
24719 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
24720 staticpro (&Qtrailing_whitespace
);
24721 Qescape_glyph
= intern_c_string ("escape-glyph");
24722 staticpro (&Qescape_glyph
);
24723 Qnobreak_space
= intern_c_string ("nobreak-space");
24724 staticpro (&Qnobreak_space
);
24725 Qimage
= intern_c_string ("image");
24726 staticpro (&Qimage
);
24727 QCmap
= intern_c_string (":map");
24728 staticpro (&QCmap
);
24729 QCpointer
= intern_c_string (":pointer");
24730 staticpro (&QCpointer
);
24731 Qrect
= intern_c_string ("rect");
24732 staticpro (&Qrect
);
24733 Qcircle
= intern_c_string ("circle");
24734 staticpro (&Qcircle
);
24735 Qpoly
= intern_c_string ("poly");
24736 staticpro (&Qpoly
);
24737 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
24738 staticpro (&Qmessage_truncate_lines
);
24739 Qgrow_only
= intern_c_string ("grow-only");
24740 staticpro (&Qgrow_only
);
24741 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
24742 staticpro (&Qinhibit_menubar_update
);
24743 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
24744 staticpro (&Qinhibit_eval_during_redisplay
);
24745 Qposition
= intern_c_string ("position");
24746 staticpro (&Qposition
);
24747 Qbuffer_position
= intern_c_string ("buffer-position");
24748 staticpro (&Qbuffer_position
);
24749 Qobject
= intern_c_string ("object");
24750 staticpro (&Qobject
);
24751 Qbar
= intern_c_string ("bar");
24753 Qhbar
= intern_c_string ("hbar");
24754 staticpro (&Qhbar
);
24755 Qbox
= intern_c_string ("box");
24757 Qhollow
= intern_c_string ("hollow");
24758 staticpro (&Qhollow
);
24759 Qhand
= intern_c_string ("hand");
24760 staticpro (&Qhand
);
24761 Qarrow
= intern_c_string ("arrow");
24762 staticpro (&Qarrow
);
24763 Qtext
= intern_c_string ("text");
24764 staticpro (&Qtext
);
24765 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
24766 staticpro (&Qrisky_local_variable
);
24767 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
24768 staticpro (&Qinhibit_free_realized_faces
);
24770 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
24771 Fcons (intern_c_string ("void-variable"), Qnil
)),
24773 staticpro (&list_of_error
);
24775 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
24776 staticpro (&Qlast_arrow_position
);
24777 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
24778 staticpro (&Qlast_arrow_string
);
24780 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
24781 staticpro (&Qoverlay_arrow_string
);
24782 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
24783 staticpro (&Qoverlay_arrow_bitmap
);
24785 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
24786 staticpro (&echo_buffer
[0]);
24787 staticpro (&echo_buffer
[1]);
24789 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
24790 staticpro (&echo_area_buffer
[0]);
24791 staticpro (&echo_area_buffer
[1]);
24793 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
24794 staticpro (&Vmessages_buffer_name
);
24796 mode_line_proptrans_alist
= Qnil
;
24797 staticpro (&mode_line_proptrans_alist
);
24798 mode_line_string_list
= Qnil
;
24799 staticpro (&mode_line_string_list
);
24800 mode_line_string_face
= Qnil
;
24801 staticpro (&mode_line_string_face
);
24802 mode_line_string_face_prop
= Qnil
;
24803 staticpro (&mode_line_string_face_prop
);
24804 Vmode_line_unwind_vector
= Qnil
;
24805 staticpro (&Vmode_line_unwind_vector
);
24807 help_echo_string
= Qnil
;
24808 staticpro (&help_echo_string
);
24809 help_echo_object
= Qnil
;
24810 staticpro (&help_echo_object
);
24811 help_echo_window
= Qnil
;
24812 staticpro (&help_echo_window
);
24813 previous_help_echo_string
= Qnil
;
24814 staticpro (&previous_help_echo_string
);
24815 help_echo_pos
= -1;
24817 #ifdef HAVE_WINDOW_SYSTEM
24818 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
24819 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
24820 For example, if a block cursor is over a tab, it will be drawn as
24821 wide as that tab on the display. */);
24822 x_stretch_cursor_p
= 0;
24825 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
24826 doc
: /* *Non-nil means highlight trailing whitespace.
24827 The face used for trailing whitespace is `trailing-whitespace'. */);
24828 Vshow_trailing_whitespace
= Qnil
;
24830 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
24831 doc
: /* *Control highlighting of nobreak space and soft hyphen.
24832 A value of t means highlight the character itself (for nobreak space,
24833 use face `nobreak-space').
24834 A value of nil means no highlighting.
24835 Other values mean display the escape glyph followed by an ordinary
24836 space or ordinary hyphen. */);
24837 Vnobreak_char_display
= Qt
;
24839 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
24840 doc
: /* *The pointer shape to show in void text areas.
24841 A value of nil means to show the text pointer. Other options are `arrow',
24842 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
24843 Vvoid_text_area_pointer
= Qarrow
;
24845 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
24846 doc
: /* Non-nil means don't actually do any redisplay.
24847 This is used for internal purposes. */);
24848 Vinhibit_redisplay
= Qnil
;
24850 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
24851 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
24852 Vglobal_mode_string
= Qnil
;
24854 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
24855 doc
: /* Marker for where to display an arrow on top of the buffer text.
24856 This must be the beginning of a line in order to work.
24857 See also `overlay-arrow-string'. */);
24858 Voverlay_arrow_position
= Qnil
;
24860 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
24861 doc
: /* String to display as an arrow in non-window frames.
24862 See also `overlay-arrow-position'. */);
24863 Voverlay_arrow_string
= make_pure_c_string ("=>");
24865 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
24866 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
24867 The symbols on this list are examined during redisplay to determine
24868 where to display overlay arrows. */);
24869 Voverlay_arrow_variable_list
24870 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
24872 DEFVAR_INT ("scroll-step", &scroll_step
,
24873 doc
: /* *The number of lines to try scrolling a window by when point moves out.
24874 If that fails to bring point back on frame, point is centered instead.
24875 If this is zero, point is always centered after it moves off frame.
24876 If you want scrolling to always be a line at a time, you should set
24877 `scroll-conservatively' to a large value rather than set this to 1. */);
24879 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
24880 doc
: /* *Scroll up to this many lines, to bring point back on screen.
24881 If point moves off-screen, redisplay will scroll by up to
24882 `scroll-conservatively' lines in order to bring point just barely
24883 onto the screen again. If that cannot be done, then redisplay
24884 recenters point as usual.
24886 A value of zero means always recenter point if it moves off screen. */);
24887 scroll_conservatively
= 0;
24889 DEFVAR_INT ("scroll-margin", &scroll_margin
,
24890 doc
: /* *Number of lines of margin at the top and bottom of a window.
24891 Recenter the window whenever point gets within this many lines
24892 of the top or bottom of the window. */);
24895 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
24896 doc
: /* Pixels per inch value for non-window system displays.
24897 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
24898 Vdisplay_pixels_per_inch
= make_float (72.0);
24901 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
24904 DEFVAR_LISP ("truncate-partial-width-windows",
24905 &Vtruncate_partial_width_windows
,
24906 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
24907 For an integer value, truncate lines in each window narrower than the
24908 full frame width, provided the window width is less than that integer;
24909 otherwise, respect the value of `truncate-lines'.
24911 For any other non-nil value, truncate lines in all windows that do
24912 not span the full frame width.
24914 A value of nil means to respect the value of `truncate-lines'.
24916 If `word-wrap' is enabled, you might want to reduce this. */);
24917 Vtruncate_partial_width_windows
= make_number (50);
24919 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
24920 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
24921 Any other value means to use the appropriate face, `mode-line',
24922 `header-line', or `menu' respectively. */);
24923 mode_line_inverse_video
= 1;
24925 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
24926 doc
: /* *Maximum buffer size for which line number should be displayed.
24927 If the buffer is bigger than this, the line number does not appear
24928 in the mode line. A value of nil means no limit. */);
24929 Vline_number_display_limit
= Qnil
;
24931 DEFVAR_INT ("line-number-display-limit-width",
24932 &line_number_display_limit_width
,
24933 doc
: /* *Maximum line width (in characters) for line number display.
24934 If the average length of the lines near point is bigger than this, then the
24935 line number may be omitted from the mode line. */);
24936 line_number_display_limit_width
= 200;
24938 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
24939 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
24940 highlight_nonselected_windows
= 0;
24942 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
24943 doc
: /* Non-nil if more than one frame is visible on this display.
24944 Minibuffer-only frames don't count, but iconified frames do.
24945 This variable is not guaranteed to be accurate except while processing
24946 `frame-title-format' and `icon-title-format'. */);
24948 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
24949 doc
: /* Template for displaying the title bar of visible frames.
24950 \(Assuming the window manager supports this feature.)
24952 This variable has the same structure as `mode-line-format', except that
24953 the %c and %l constructs are ignored. It is used only on frames for
24954 which no explicit name has been set \(see `modify-frame-parameters'). */);
24956 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
24957 doc
: /* Template for displaying the title bar of an iconified frame.
24958 \(Assuming the window manager supports this feature.)
24959 This variable has the same structure as `mode-line-format' (which see),
24960 and is used only on frames for which no explicit name has been set
24961 \(see `modify-frame-parameters'). */);
24963 = Vframe_title_format
24964 = pure_cons (intern_c_string ("multiple-frames"),
24965 pure_cons (make_pure_c_string ("%b"),
24966 pure_cons (pure_cons (empty_unibyte_string
,
24967 pure_cons (intern_c_string ("invocation-name"),
24968 pure_cons (make_pure_c_string ("@"),
24969 pure_cons (intern_c_string ("system-name"),
24973 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
24974 doc
: /* Maximum number of lines to keep in the message log buffer.
24975 If nil, disable message logging. If t, log messages but don't truncate
24976 the buffer when it becomes large. */);
24977 Vmessage_log_max
= make_number (100);
24979 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
24980 doc
: /* Functions called before redisplay, if window sizes have changed.
24981 The value should be a list of functions that take one argument.
24982 Just before redisplay, for each frame, if any of its windows have changed
24983 size since the last redisplay, or have been split or deleted,
24984 all the functions in the list are called, with the frame as argument. */);
24985 Vwindow_size_change_functions
= Qnil
;
24987 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
24988 doc
: /* List of functions to call before redisplaying a window with scrolling.
24989 Each function is called with two arguments, the window and its new
24990 display-start position. Note that these functions are also called by
24991 `set-window-buffer'. Also note that the value of `window-end' is not
24992 valid when these functions are called. */);
24993 Vwindow_scroll_functions
= Qnil
;
24995 DEFVAR_LISP ("window-text-change-functions",
24996 &Vwindow_text_change_functions
,
24997 doc
: /* Functions to call in redisplay when text in the window might change. */);
24998 Vwindow_text_change_functions
= Qnil
;
25000 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25001 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25002 Each function is called with two arguments, the window and the end trigger value.
25003 See `set-window-redisplay-end-trigger'. */);
25004 Vredisplay_end_trigger_functions
= Qnil
;
25006 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25007 doc
: /* *Non-nil means autoselect window with mouse pointer.
25008 If nil, do not autoselect windows.
25009 A positive number means delay autoselection by that many seconds: a
25010 window is autoselected only after the mouse has remained in that
25011 window for the duration of the delay.
25012 A negative number has a similar effect, but causes windows to be
25013 autoselected only after the mouse has stopped moving. \(Because of
25014 the way Emacs compares mouse events, you will occasionally wait twice
25015 that time before the window gets selected.\)
25016 Any other value means to autoselect window instantaneously when the
25017 mouse pointer enters it.
25019 Autoselection selects the minibuffer only if it is active, and never
25020 unselects the minibuffer if it is active.
25022 When customizing this variable make sure that the actual value of
25023 `focus-follows-mouse' matches the behavior of your window manager. */);
25024 Vmouse_autoselect_window
= Qnil
;
25026 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25027 doc
: /* *Non-nil means automatically resize tool-bars.
25028 This dynamically changes the tool-bar's height to the minimum height
25029 that is needed to make all tool-bar items visible.
25030 If value is `grow-only', the tool-bar's height is only increased
25031 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25032 Vauto_resize_tool_bars
= Qt
;
25034 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25035 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25036 auto_raise_tool_bar_buttons_p
= 1;
25038 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25039 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25040 make_cursor_line_fully_visible_p
= 1;
25042 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25043 doc
: /* *Border below tool-bar in pixels.
25044 If an integer, use it as the height of the border.
25045 If it is one of `internal-border-width' or `border-width', use the
25046 value of the corresponding frame parameter.
25047 Otherwise, no border is added below the tool-bar. */);
25048 Vtool_bar_border
= Qinternal_border_width
;
25050 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25051 doc
: /* *Margin around tool-bar buttons in pixels.
25052 If an integer, use that for both horizontal and vertical margins.
25053 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25054 HORZ specifying the horizontal margin, and VERT specifying the
25055 vertical margin. */);
25056 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25058 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25059 doc
: /* *Relief thickness of tool-bar buttons. */);
25060 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25062 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
25063 doc
: /* List of functions to call to fontify regions of text.
25064 Each function is called with one argument POS. Functions must
25065 fontify a region starting at POS in the current buffer, and give
25066 fontified regions the property `fontified'. */);
25067 Vfontification_functions
= Qnil
;
25068 Fmake_variable_buffer_local (Qfontification_functions
);
25070 DEFVAR_BOOL ("unibyte-display-via-language-environment",
25071 &unibyte_display_via_language_environment
,
25072 doc
: /* *Non-nil means display unibyte text according to language environment.
25073 Specifically, this means that raw bytes in the range 160-255 decimal
25074 are displayed by converting them to the equivalent multibyte characters
25075 according to the current language environment. As a result, they are
25076 displayed according to the current fontset.
25078 Note that this variable affects only how these bytes are displayed,
25079 but does not change the fact they are interpreted as raw bytes. */);
25080 unibyte_display_via_language_environment
= 0;
25082 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
25083 doc
: /* *Maximum height for resizing mini-windows.
25084 If a float, it specifies a fraction of the mini-window frame's height.
25085 If an integer, it specifies a number of lines. */);
25086 Vmax_mini_window_height
= make_float (0.25);
25088 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
25089 doc
: /* *How to resize mini-windows.
25090 A value of nil means don't automatically resize mini-windows.
25091 A value of t means resize them to fit the text displayed in them.
25092 A value of `grow-only', the default, means let mini-windows grow
25093 only, until their display becomes empty, at which point the windows
25094 go back to their normal size. */);
25095 Vresize_mini_windows
= Qgrow_only
;
25097 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
25098 doc
: /* Alist specifying how to blink the cursor off.
25099 Each element has the form (ON-STATE . OFF-STATE). Whenever the
25100 `cursor-type' frame-parameter or variable equals ON-STATE,
25101 comparing using `equal', Emacs uses OFF-STATE to specify
25102 how to blink it off. ON-STATE and OFF-STATE are values for
25103 the `cursor-type' frame parameter.
25105 If a frame's ON-STATE has no entry in this list,
25106 the frame's other specifications determine how to blink the cursor off. */);
25107 Vblink_cursor_alist
= Qnil
;
25109 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
25110 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
25111 automatic_hscrolling_p
= 1;
25112 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
25113 staticpro (&Qauto_hscroll_mode
);
25115 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
25116 doc
: /* *How many columns away from the window edge point is allowed to get
25117 before automatic hscrolling will horizontally scroll the window. */);
25118 hscroll_margin
= 5;
25120 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
25121 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
25122 When point is less than `hscroll-margin' columns from the window
25123 edge, automatic hscrolling will scroll the window by the amount of columns
25124 determined by this variable. If its value is a positive integer, scroll that
25125 many columns. If it's a positive floating-point number, it specifies the
25126 fraction of the window's width to scroll. If it's nil or zero, point will be
25127 centered horizontally after the scroll. Any other value, including negative
25128 numbers, are treated as if the value were zero.
25130 Automatic hscrolling always moves point outside the scroll margin, so if
25131 point was more than scroll step columns inside the margin, the window will
25132 scroll more than the value given by the scroll step.
25134 Note that the lower bound for automatic hscrolling specified by `scroll-left'
25135 and `scroll-right' overrides this variable's effect. */);
25136 Vhscroll_step
= make_number (0);
25138 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
25139 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
25140 Bind this around calls to `message' to let it take effect. */);
25141 message_truncate_lines
= 0;
25143 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
25144 doc
: /* Normal hook run to update the menu bar definitions.
25145 Redisplay runs this hook before it redisplays the menu bar.
25146 This is used to update submenus such as Buffers,
25147 whose contents depend on various data. */);
25148 Vmenu_bar_update_hook
= Qnil
;
25150 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
25151 doc
: /* Frame for which we are updating a menu.
25152 The enable predicate for a menu binding should check this variable. */);
25153 Vmenu_updating_frame
= Qnil
;
25155 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
25156 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
25157 inhibit_menubar_update
= 0;
25159 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
25160 doc
: /* Prefix prepended to all continuation lines at display time.
25161 The value may be a string, an image, or a stretch-glyph; it is
25162 interpreted in the same way as the value of a `display' text property.
25164 This variable is overridden by any `wrap-prefix' text or overlay
25167 To add a prefix to non-continuation lines, use `line-prefix'. */);
25168 Vwrap_prefix
= Qnil
;
25169 staticpro (&Qwrap_prefix
);
25170 Qwrap_prefix
= intern_c_string ("wrap-prefix");
25171 Fmake_variable_buffer_local (Qwrap_prefix
);
25173 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
25174 doc
: /* Prefix prepended to all non-continuation lines at display time.
25175 The value may be a string, an image, or a stretch-glyph; it is
25176 interpreted in the same way as the value of a `display' text property.
25178 This variable is overridden by any `line-prefix' text or overlay
25181 To add a prefix to continuation lines, use `wrap-prefix'. */);
25182 Vline_prefix
= Qnil
;
25183 staticpro (&Qline_prefix
);
25184 Qline_prefix
= intern_c_string ("line-prefix");
25185 Fmake_variable_buffer_local (Qline_prefix
);
25187 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
25188 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
25189 inhibit_eval_during_redisplay
= 0;
25191 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
25192 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
25193 inhibit_free_realized_faces
= 0;
25196 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
25197 doc
: /* Inhibit try_window_id display optimization. */);
25198 inhibit_try_window_id
= 0;
25200 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
25201 doc
: /* Inhibit try_window_reusing display optimization. */);
25202 inhibit_try_window_reusing
= 0;
25204 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
25205 doc
: /* Inhibit try_cursor_movement display optimization. */);
25206 inhibit_try_cursor_movement
= 0;
25207 #endif /* GLYPH_DEBUG */
25209 DEFVAR_INT ("overline-margin", &overline_margin
,
25210 doc
: /* *Space between overline and text, in pixels.
25211 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
25212 margin to the caracter height. */);
25213 overline_margin
= 2;
25215 DEFVAR_INT ("underline-minimum-offset",
25216 &underline_minimum_offset
,
25217 doc
: /* Minimum distance between baseline and underline.
25218 This can improve legibility of underlined text at small font sizes,
25219 particularly when using variable `x-use-underline-position-properties'
25220 with fonts that specify an UNDERLINE_POSITION relatively close to the
25221 baseline. The default value is 1. */);
25222 underline_minimum_offset
= 1;
25224 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
25225 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
25226 display_hourglass_p
= 1;
25228 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
25229 doc
: /* *Seconds to wait before displaying an hourglass pointer.
25230 Value must be an integer or float. */);
25231 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
25233 hourglass_atimer
= NULL
;
25234 hourglass_shown_p
= 0;
25238 /* Initialize this module when Emacs starts. */
25243 Lisp_Object root_window
;
25244 struct window
*mini_w
;
25246 current_header_line_height
= current_mode_line_height
= -1;
25248 CHARPOS (this_line_start_pos
) = 0;
25250 mini_w
= XWINDOW (minibuf_window
);
25251 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
25253 if (!noninteractive
)
25255 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
25258 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
25259 set_window_height (root_window
,
25260 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
25262 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
25263 set_window_height (minibuf_window
, 1, 0);
25265 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
25266 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
25268 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
25269 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
25270 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
25272 /* The default ellipsis glyphs `...'. */
25273 for (i
= 0; i
< 3; ++i
)
25274 default_invis_vector
[i
] = make_number ('.');
25278 /* Allocate the buffer for frame titles.
25279 Also used for `format-mode-line'. */
25281 mode_line_noprop_buf
= (char *) xmalloc (size
);
25282 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
25283 mode_line_noprop_ptr
= mode_line_noprop_buf
;
25284 mode_line_target
= MODE_LINE_DISPLAY
;
25287 help_echo_showing_p
= 0;
25290 /* Since w32 does not support atimers, it defines its own implementation of
25291 the following three functions in w32fns.c. */
25294 /* Platform-independent portion of hourglass implementation. */
25296 /* Return non-zero if houglass timer has been started or hourglass is shown. */
25298 hourglass_started ()
25300 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
25303 /* Cancel a currently active hourglass timer, and start a new one. */
25307 #if defined (HAVE_WINDOW_SYSTEM)
25309 int secs
, usecs
= 0;
25311 cancel_hourglass ();
25313 if (INTEGERP (Vhourglass_delay
)
25314 && XINT (Vhourglass_delay
) > 0)
25315 secs
= XFASTINT (Vhourglass_delay
);
25316 else if (FLOATP (Vhourglass_delay
)
25317 && XFLOAT_DATA (Vhourglass_delay
) > 0)
25320 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
25321 secs
= XFASTINT (tem
);
25322 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
25325 secs
= DEFAULT_HOURGLASS_DELAY
;
25327 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
25328 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
25329 show_hourglass
, NULL
);
25334 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
25337 cancel_hourglass ()
25339 #if defined (HAVE_WINDOW_SYSTEM)
25340 if (hourglass_atimer
)
25342 cancel_atimer (hourglass_atimer
);
25343 hourglass_atimer
= NULL
;
25346 if (hourglass_shown_p
)
25350 #endif /* ! WINDOWSNT */
25352 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
25353 (do not change this comment) */