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, 2010
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
26 Emacs separates the task of updating the display from code
27 modifying global state, e.g. buffer text. This way functions
28 operating on buffers don't also have to be concerned with updating
31 Updating the display is triggered by the Lisp interpreter when it
32 decides it's time to do it. This is done either automatically for
33 you as part of the interpreter's command loop or as the result of
34 calling Lisp functions like `sit-for'. The C function `redisplay'
35 in xdisp.c is the only entry into the inner redisplay code.
37 The following diagram shows how redisplay code is invoked. As you
38 can see, Lisp calls redisplay and vice versa. Under window systems
39 like X, some portions of the redisplay code are also called
40 asynchronously during mouse movement or expose events. It is very
41 important that these code parts do NOT use the C library (malloc,
42 free) because many C libraries under Unix are not reentrant. They
43 may also NOT call functions of the Lisp interpreter which could
44 change the interpreter's state. If you don't follow these rules,
45 you will encounter bugs which are very hard to explain.
47 +--------------+ redisplay +----------------+
48 | Lisp machine |---------------->| Redisplay code |<--+
49 +--------------+ (xdisp.c) +----------------+ |
51 +----------------------------------+ |
52 Don't use this path when called |
55 expose_window (asynchronous) |
57 X expose events -----+
59 What does redisplay do? Obviously, it has to figure out somehow what
60 has been changed since the last time the display has been updated,
61 and to make these changes visible. Preferably it would do that in
62 a moderately intelligent way, i.e. fast.
64 Changes in buffer text can be deduced from window and buffer
65 structures, and from some global variables like `beg_unchanged' and
66 `end_unchanged'. The contents of the display are additionally
67 recorded in a `glyph matrix', a two-dimensional matrix of glyph
68 structures. Each row in such a matrix corresponds to a line on the
69 display, and each glyph in a row corresponds to a column displaying
70 a character, an image, or what else. This matrix is called the
71 `current glyph matrix' or `current matrix' in redisplay
74 For buffer parts that have been changed since the last update, a
75 second glyph matrix is constructed, the so called `desired glyph
76 matrix' or short `desired matrix'. Current and desired matrix are
77 then compared to find a cheap way to update the display, e.g. by
78 reusing part of the display by scrolling lines.
80 You will find a lot of redisplay optimizations when you start
81 looking at the innards of redisplay. The overall goal of all these
82 optimizations is to make redisplay fast because it is done
83 frequently. Some of these optimizations are implemented by the
88 This function tries to update the display if the text in the
89 window did not change and did not scroll, only point moved, and
90 it did not move off the displayed portion of the text.
92 . try_window_reusing_current_matrix
94 This function reuses the current matrix of a window when text
95 has not changed, but the window start changed (e.g., due to
100 This function attempts to redisplay a window by reusing parts of
101 its existing display. It finds and reuses the part that was not
102 changed, and redraws the rest.
106 This function performs the full redisplay of a single window
107 assuming that its fonts were not changed and that the cursor
108 will not end up in the scroll margins. (Loading fonts requires
109 re-adjustment of dimensions of glyph matrices, which makes this
110 method impossible to use.)
112 These optimizations are tried in sequence (some can be skipped if
113 it is known that they are not applicable). If none of the
114 optimizations were successful, redisplay calls redisplay_windows,
115 which performs a full redisplay of all windows.
119 Desired matrices are always built per Emacs window. The function
120 `display_line' is the central function to look at if you are
121 interested. It constructs one row in a desired matrix given an
122 iterator structure containing both a buffer position and a
123 description of the environment in which the text is to be
124 displayed. But this is too early, read on.
126 Characters and pixmaps displayed for a range of buffer text depend
127 on various settings of buffers and windows, on overlays and text
128 properties, on display tables, on selective display. The good news
129 is that all this hairy stuff is hidden behind a small set of
130 interface functions taking an iterator structure (struct it)
133 Iteration over things to be displayed is then simple. It is
134 started by initializing an iterator with a call to init_iterator.
135 Calls to get_next_display_element fill the iterator structure with
136 relevant information about the next thing to display. Calls to
137 set_iterator_to_next move the iterator to the next thing.
139 Besides this, an iterator also contains information about the
140 display environment in which glyphs for display elements are to be
141 produced. It has fields for the width and height of the display,
142 the information whether long lines are truncated or continued, a
143 current X and Y position, and lots of other stuff you can better
146 Glyphs in a desired matrix are normally constructed in a loop
147 calling get_next_display_element and then PRODUCE_GLYPHS. The call
148 to PRODUCE_GLYPHS will fill the iterator structure with pixel
149 information about the element being displayed and at the same time
150 produce glyphs for it. If the display element fits on the line
151 being displayed, set_iterator_to_next is called next, otherwise the
152 glyphs produced are discarded. The function display_line is the
153 workhorse of filling glyph rows in the desired matrix with glyphs.
154 In addition to producing glyphs, it also handles line truncation
155 and continuation, word wrap, and cursor positioning (for the
156 latter, see also set_cursor_from_row).
160 That just couldn't be all, could it? What about terminal types not
161 supporting operations on sub-windows of the screen? To update the
162 display on such a terminal, window-based glyph matrices are not
163 well suited. To be able to reuse part of the display (scrolling
164 lines up and down), we must instead have a view of the whole
165 screen. This is what `frame matrices' are for. They are a trick.
167 Frames on terminals like above have a glyph pool. Windows on such
168 a frame sub-allocate their glyph memory from their frame's glyph
169 pool. The frame itself is given its own glyph matrices. By
170 coincidence---or maybe something else---rows in window glyph
171 matrices are slices of corresponding rows in frame matrices. Thus
172 writing to window matrices implicitly updates a frame matrix which
173 provides us with the view of the whole screen that we originally
174 wanted to have without having to move many bytes around. To be
175 honest, there is a little bit more done, but not much more. If you
176 plan to extend that code, take a look at dispnew.c. The function
177 build_frame_matrix is a good starting point.
179 Bidirectional display.
181 Bidirectional display adds quite some hair to this already complex
182 design. The good news are that a large portion of that hairy stuff
183 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
184 reordering engine which is called by set_iterator_to_next and
185 returns the next character to display in the visual order. See
186 commentary on bidi.c for more details. As far as redisplay is
187 concerned, the effect of calling bidi_get_next_char_visually, the
188 main interface of the reordering engine, is that the iterator gets
189 magically placed on the buffer or string position that is to be
190 displayed next. In other words, a linear iteration through the
191 buffer/string is replaced with a non-linear one. All the rest of
192 the redisplay is oblivious to the bidi reordering.
194 Well, almost oblivious---there are still complications, most of
195 them due to the fact that buffer and string positions no longer
196 change monotonously with glyph indices in a glyph row. Moreover,
197 for continued lines, the buffer positions may not even be
198 monotonously changing with vertical positions. Also, accounting
199 for face changes, overlays, etc. becomes more complex because
200 non-linear iteration could potentially skip many positions with
201 changes, and then cross them again on the way back...
203 One other prominent effect of bidirectional display is that some
204 paragraphs of text need to be displayed starting at the right
205 margin of the window---the so-called right-to-left, or R2L
206 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
207 which have their reversed_p flag set. The bidi reordering engine
208 produces characters in such rows starting from the character which
209 should be the rightmost on display. PRODUCE_GLYPHS then reverses
210 the order, when it fills up the glyph row whose reversed_p flag is
211 set, by prepending each new glyph to what is already there, instead
212 of appending it. When the glyph row is complete, the function
213 extend_face_to_end_of_line fills the empty space to the left of the
214 leftmost character with special glyphs, which will display as,
215 well, empty. On text terminals, these special glyphs are simply
216 blank characters. On graphics terminals, there's a single stretch
217 glyph with suitably computed width. Both the blanks and the
218 stretch glyph are given the face of the background of the line.
219 This way, the terminal-specific back-end can still draw the glyphs
220 left to right, even for R2L lines. */
228 #include "keyboard.h"
231 #include "termchar.h"
232 #include "dispextern.h"
234 #include "character.h"
237 #include "commands.h"
241 #include "termhooks.h"
242 #include "intervals.h"
245 #include "region-cache.h"
248 #include "blockinput.h"
250 #ifdef HAVE_X_WINDOWS
265 #ifndef FRAME_X_OUTPUT
266 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
269 #define INFINITY 10000000
271 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
272 || defined(HAVE_NS) || defined (USE_GTK)
273 extern void set_frame_menubar
P_ ((struct frame
*f
, int, int));
274 extern int pending_menu_activation
;
277 extern int interrupt_input
;
278 extern int command_loop_level
;
280 extern Lisp_Object do_mouse_tracking
;
282 extern int minibuffer_auto_raise
;
283 extern Lisp_Object Vminibuffer_list
;
285 extern Lisp_Object Qface
;
286 extern Lisp_Object Qmode_line
, Qmode_line_inactive
, Qheader_line
;
288 extern Lisp_Object Voverriding_local_map
;
289 extern Lisp_Object Voverriding_local_map_menu_flag
;
290 extern Lisp_Object Qmenu_item
;
291 extern Lisp_Object Qwhen
;
292 extern Lisp_Object Qhelp_echo
;
293 extern Lisp_Object Qbefore_string
, Qafter_string
;
295 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
296 Lisp_Object Qwindow_scroll_functions
, Vwindow_scroll_functions
;
297 Lisp_Object Qwindow_text_change_functions
, Vwindow_text_change_functions
;
298 Lisp_Object Qredisplay_end_trigger_functions
, Vredisplay_end_trigger_functions
;
299 Lisp_Object Qinhibit_point_motion_hooks
;
300 Lisp_Object QCeval
, QCfile
, QCdata
, QCpropertize
;
301 Lisp_Object Qfontified
;
302 Lisp_Object Qgrow_only
;
303 Lisp_Object Qinhibit_eval_during_redisplay
;
304 Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
305 Lisp_Object Qright_to_left
, Qleft_to_right
;
308 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
311 Lisp_Object Qarrow
, Qhand
, Qtext
;
313 Lisp_Object Qrisky_local_variable
;
315 /* Holds the list (error). */
316 Lisp_Object list_of_error
;
318 /* Functions called to fontify regions of text. */
320 Lisp_Object Vfontification_functions
;
321 Lisp_Object Qfontification_functions
;
323 /* Non-nil means automatically select any window when the mouse
324 cursor moves into it. */
325 Lisp_Object Vmouse_autoselect_window
;
327 Lisp_Object Vwrap_prefix
, Qwrap_prefix
;
328 Lisp_Object Vline_prefix
, Qline_prefix
;
330 /* Non-zero means draw tool bar buttons raised when the mouse moves
333 int auto_raise_tool_bar_buttons_p
;
335 /* Non-zero means to reposition window if cursor line is only partially visible. */
337 int make_cursor_line_fully_visible_p
;
339 /* Margin below tool bar in pixels. 0 or nil means no margin.
340 If value is `internal-border-width' or `border-width',
341 the corresponding frame parameter is used. */
343 Lisp_Object Vtool_bar_border
;
345 /* Margin around tool bar buttons in pixels. */
347 Lisp_Object Vtool_bar_button_margin
;
349 /* Thickness of shadow to draw around tool bar buttons. */
351 EMACS_INT tool_bar_button_relief
;
353 /* Non-nil means automatically resize tool-bars so that all tool-bar
354 items are visible, and no blank lines remain.
356 If value is `grow-only', only make tool-bar bigger. */
358 Lisp_Object Vauto_resize_tool_bars
;
360 /* Type of tool bar. Can be symbols image, text, both or both-hroiz. */
362 Lisp_Object Vtool_bar_style
;
364 /* Maximum number of characters a label can have to be shown. */
366 EMACS_INT tool_bar_max_label_size
;
368 /* Non-zero means draw block and hollow cursor as wide as the glyph
369 under it. For example, if a block cursor is over a tab, it will be
370 drawn as wide as that tab on the display. */
372 int x_stretch_cursor_p
;
374 /* Non-nil means don't actually do any redisplay. */
376 Lisp_Object Vinhibit_redisplay
, Qinhibit_redisplay
;
378 /* Non-zero means Lisp evaluation during redisplay is inhibited. */
380 int inhibit_eval_during_redisplay
;
382 /* Names of text properties relevant for redisplay. */
384 Lisp_Object Qdisplay
;
385 extern Lisp_Object Qface
, Qinvisible
, Qwidth
;
387 /* Symbols used in text property values. */
389 Lisp_Object Vdisplay_pixels_per_inch
;
390 Lisp_Object Qspace
, QCalign_to
, QCrelative_width
, QCrelative_height
;
391 Lisp_Object Qleft_margin
, Qright_margin
, Qspace_width
, Qraise
;
394 Lisp_Object Qmargin
, Qpointer
;
395 Lisp_Object Qline_height
;
396 extern Lisp_Object Qheight
;
397 extern Lisp_Object QCwidth
, QCheight
, QCascent
;
398 extern Lisp_Object Qscroll_bar
;
399 extern Lisp_Object Qcursor
;
401 /* Non-nil means highlight trailing whitespace. */
403 Lisp_Object Vshow_trailing_whitespace
;
405 /* Non-nil means escape non-break space and hyphens. */
407 Lisp_Object Vnobreak_char_display
;
409 #ifdef HAVE_WINDOW_SYSTEM
410 extern Lisp_Object Voverflow_newline_into_fringe
;
412 /* Test if overflow newline into fringe. Called with iterator IT
413 at or past right window margin, and with IT->current_x set. */
415 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
416 (!NILP (Voverflow_newline_into_fringe) \
417 && FRAME_WINDOW_P ((IT)->f) \
418 && ((IT)->bidi_it.paragraph_dir == R2L \
419 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
420 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
421 && (IT)->current_x == (IT)->last_visible_x \
422 && (IT)->line_wrap != WORD_WRAP)
424 #else /* !HAVE_WINDOW_SYSTEM */
425 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
426 #endif /* HAVE_WINDOW_SYSTEM */
428 /* Test if the display element loaded in IT is a space or tab
429 character. This is used to determine word wrapping. */
431 #define IT_DISPLAYING_WHITESPACE(it) \
432 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
434 /* Non-nil means show the text cursor in void text areas
435 i.e. in blank areas after eol and eob. This used to be
436 the default in 21.3. */
438 Lisp_Object Vvoid_text_area_pointer
;
440 /* Name of the face used to highlight trailing whitespace. */
442 Lisp_Object Qtrailing_whitespace
;
444 /* Name and number of the face used to highlight escape glyphs. */
446 Lisp_Object Qescape_glyph
;
448 /* Name and number of the face used to highlight non-breaking spaces. */
450 Lisp_Object Qnobreak_space
;
452 /* The symbol `image' which is the car of the lists used to represent
453 images in Lisp. Also a tool bar style. */
457 /* The image map types. */
458 Lisp_Object QCmap
, QCpointer
;
459 Lisp_Object Qrect
, Qcircle
, Qpoly
;
461 /* Tool bar styles */
462 Lisp_Object Qtext
, Qboth
, Qboth_horiz
;
464 /* Non-zero means print newline to stdout before next mini-buffer
467 int noninteractive_need_newline
;
469 /* Non-zero means print newline to message log before next message. */
471 static int message_log_need_newline
;
473 /* Three markers that message_dolog uses.
474 It could allocate them itself, but that causes trouble
475 in handling memory-full errors. */
476 static Lisp_Object message_dolog_marker1
;
477 static Lisp_Object message_dolog_marker2
;
478 static Lisp_Object message_dolog_marker3
;
480 /* The buffer position of the first character appearing entirely or
481 partially on the line of the selected window which contains the
482 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
483 redisplay optimization in redisplay_internal. */
485 static struct text_pos this_line_start_pos
;
487 /* Number of characters past the end of the line above, including the
488 terminating newline. */
490 static struct text_pos this_line_end_pos
;
492 /* The vertical positions and the height of this line. */
494 static int this_line_vpos
;
495 static int this_line_y
;
496 static int this_line_pixel_height
;
498 /* X position at which this display line starts. Usually zero;
499 negative if first character is partially visible. */
501 static int this_line_start_x
;
503 /* Buffer that this_line_.* variables are referring to. */
505 static struct buffer
*this_line_buffer
;
507 /* Nonzero means truncate lines in all windows less wide than the
510 Lisp_Object Vtruncate_partial_width_windows
;
512 /* A flag to control how to display unibyte 8-bit character. */
514 int unibyte_display_via_language_environment
;
516 /* Nonzero means we have more than one non-mini-buffer-only frame.
517 Not guaranteed to be accurate except while parsing
518 frame-title-format. */
522 Lisp_Object Vglobal_mode_string
;
525 /* List of variables (symbols) which hold markers for overlay arrows.
526 The symbols on this list are examined during redisplay to determine
527 where to display overlay arrows. */
529 Lisp_Object Voverlay_arrow_variable_list
;
531 /* Marker for where to display an arrow on top of the buffer text. */
533 Lisp_Object Voverlay_arrow_position
;
535 /* String to display for the arrow. Only used on terminal frames. */
537 Lisp_Object Voverlay_arrow_string
;
539 /* Values of those variables at last redisplay are stored as
540 properties on `overlay-arrow-position' symbol. However, if
541 Voverlay_arrow_position is a marker, last-arrow-position is its
542 numerical position. */
544 Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
546 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
547 properties on a symbol in overlay-arrow-variable-list. */
549 Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
551 /* Like mode-line-format, but for the title bar on a visible frame. */
553 Lisp_Object Vframe_title_format
;
555 /* Like mode-line-format, but for the title bar on an iconified frame. */
557 Lisp_Object Vicon_title_format
;
559 /* List of functions to call when a window's size changes. These
560 functions get one arg, a frame on which one or more windows' sizes
563 static Lisp_Object Vwindow_size_change_functions
;
565 Lisp_Object Qmenu_bar_update_hook
, Vmenu_bar_update_hook
;
567 /* Nonzero if an overlay arrow has been displayed in this window. */
569 static int overlay_arrow_seen
;
571 /* Nonzero means highlight the region even in nonselected windows. */
573 int highlight_nonselected_windows
;
575 /* If cursor motion alone moves point off frame, try scrolling this
576 many lines up or down if that will bring it back. */
578 static EMACS_INT scroll_step
;
580 /* Nonzero means scroll just far enough to bring point back on the
581 screen, when appropriate. */
583 static EMACS_INT scroll_conservatively
;
585 /* Recenter the window whenever point gets within this many lines of
586 the top or bottom of the window. This value is translated into a
587 pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
588 that there is really a fixed pixel height scroll margin. */
590 EMACS_INT scroll_margin
;
592 /* Number of windows showing the buffer of the selected window (or
593 another buffer with the same base buffer). keyboard.c refers to
598 /* Vector containing glyphs for an ellipsis `...'. */
600 static Lisp_Object default_invis_vector
[3];
602 /* Zero means display the mode-line/header-line/menu-bar in the default face
603 (this slightly odd definition is for compatibility with previous versions
604 of emacs), non-zero means display them using their respective faces.
606 This variable is deprecated. */
608 int mode_line_inverse_video
;
610 /* Prompt to display in front of the mini-buffer contents. */
612 Lisp_Object minibuf_prompt
;
614 /* Width of current mini-buffer prompt. Only set after display_line
615 of the line that contains the prompt. */
617 int minibuf_prompt_width
;
619 /* This is the window where the echo area message was displayed. It
620 is always a mini-buffer window, but it may not be the same window
621 currently active as a mini-buffer. */
623 Lisp_Object echo_area_window
;
625 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
626 pushes the current message and the value of
627 message_enable_multibyte on the stack, the function restore_message
628 pops the stack and displays MESSAGE again. */
630 Lisp_Object Vmessage_stack
;
632 /* Nonzero means multibyte characters were enabled when the echo area
633 message was specified. */
635 int message_enable_multibyte
;
637 /* Nonzero if we should redraw the mode lines on the next redisplay. */
639 int update_mode_lines
;
641 /* Nonzero if window sizes or contents have changed since last
642 redisplay that finished. */
644 int windows_or_buffers_changed
;
646 /* Nonzero means a frame's cursor type has been changed. */
648 int cursor_type_changed
;
650 /* Nonzero after display_mode_line if %l was used and it displayed a
653 int line_number_displayed
;
655 /* Maximum buffer size for which to display line numbers. */
657 Lisp_Object Vline_number_display_limit
;
659 /* Line width to consider when repositioning for line number display. */
661 static EMACS_INT line_number_display_limit_width
;
663 /* Number of lines to keep in the message log buffer. t means
664 infinite. nil means don't log at all. */
666 Lisp_Object Vmessage_log_max
;
668 /* The name of the *Messages* buffer, a string. */
670 static Lisp_Object Vmessages_buffer_name
;
672 /* Current, index 0, and last displayed echo area message. Either
673 buffers from echo_buffers, or nil to indicate no message. */
675 Lisp_Object echo_area_buffer
[2];
677 /* The buffers referenced from echo_area_buffer. */
679 static Lisp_Object echo_buffer
[2];
681 /* A vector saved used in with_area_buffer to reduce consing. */
683 static Lisp_Object Vwith_echo_area_save_vector
;
685 /* Non-zero means display_echo_area should display the last echo area
686 message again. Set by redisplay_preserve_echo_area. */
688 static int display_last_displayed_message_p
;
690 /* Nonzero if echo area is being used by print; zero if being used by
693 int message_buf_print
;
695 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
697 Lisp_Object Qinhibit_menubar_update
;
698 int inhibit_menubar_update
;
700 /* When evaluating expressions from menu bar items (enable conditions,
701 for instance), this is the frame they are being processed for. */
703 Lisp_Object Vmenu_updating_frame
;
705 /* Maximum height for resizing mini-windows. Either a float
706 specifying a fraction of the available height, or an integer
707 specifying a number of lines. */
709 Lisp_Object Vmax_mini_window_height
;
711 /* Non-zero means messages should be displayed with truncated
712 lines instead of being continued. */
714 int message_truncate_lines
;
715 Lisp_Object Qmessage_truncate_lines
;
717 /* Set to 1 in clear_message to make redisplay_internal aware
718 of an emptied echo area. */
720 static int message_cleared_p
;
722 /* How to blink the default frame cursor off. */
723 Lisp_Object Vblink_cursor_alist
;
725 /* A scratch glyph row with contents used for generating truncation
726 glyphs. Also used in direct_output_for_insert. */
728 #define MAX_SCRATCH_GLYPHS 100
729 struct glyph_row scratch_glyph_row
;
730 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
732 /* Ascent and height of the last line processed by move_it_to. */
734 static int last_max_ascent
, last_height
;
736 /* Non-zero if there's a help-echo in the echo area. */
738 int help_echo_showing_p
;
740 /* If >= 0, computed, exact values of mode-line and header-line height
741 to use in the macros CURRENT_MODE_LINE_HEIGHT and
742 CURRENT_HEADER_LINE_HEIGHT. */
744 int current_mode_line_height
, current_header_line_height
;
746 /* The maximum distance to look ahead for text properties. Values
747 that are too small let us call compute_char_face and similar
748 functions too often which is expensive. Values that are too large
749 let us call compute_char_face and alike too often because we
750 might not be interested in text properties that far away. */
752 #define TEXT_PROP_DISTANCE_LIMIT 100
756 /* Variables to turn off display optimizations from Lisp. */
758 int inhibit_try_window_id
, inhibit_try_window_reusing
;
759 int inhibit_try_cursor_movement
;
761 /* Non-zero means print traces of redisplay if compiled with
764 int trace_redisplay_p
;
766 #endif /* GLYPH_DEBUG */
768 #ifdef DEBUG_TRACE_MOVE
769 /* Non-zero means trace with TRACE_MOVE to stderr. */
772 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
774 #define TRACE_MOVE(x) (void) 0
777 /* Non-zero means automatically scroll windows horizontally to make
780 int automatic_hscrolling_p
;
781 Lisp_Object Qauto_hscroll_mode
;
783 /* How close to the margin can point get before the window is scrolled
785 EMACS_INT hscroll_margin
;
787 /* How much to scroll horizontally when point is inside the above margin. */
788 Lisp_Object Vhscroll_step
;
790 /* The variable `resize-mini-windows'. If nil, don't resize
791 mini-windows. If t, always resize them to fit the text they
792 display. If `grow-only', let mini-windows grow only until they
795 Lisp_Object Vresize_mini_windows
;
797 /* Buffer being redisplayed -- for redisplay_window_error. */
799 struct buffer
*displayed_buffer
;
801 /* Space between overline and text. */
803 EMACS_INT overline_margin
;
805 /* Require underline to be at least this many screen pixels below baseline
806 This to avoid underline "merging" with the base of letters at small
807 font sizes, particularly when x_use_underline_position_properties is on. */
809 EMACS_INT underline_minimum_offset
;
811 /* Value returned from text property handlers (see below). */
816 HANDLED_RECOMPUTE_PROPS
,
817 HANDLED_OVERLAY_STRING_CONSUMED
,
821 /* A description of text properties that redisplay is interested
826 /* The name of the property. */
829 /* A unique index for the property. */
832 /* A handler function called to set up iterator IT from the property
833 at IT's current position. Value is used to steer handle_stop. */
834 enum prop_handled (*handler
) P_ ((struct it
*it
));
837 static enum prop_handled handle_face_prop
P_ ((struct it
*));
838 static enum prop_handled handle_invisible_prop
P_ ((struct it
*));
839 static enum prop_handled handle_display_prop
P_ ((struct it
*));
840 static enum prop_handled handle_composition_prop
P_ ((struct it
*));
841 static enum prop_handled handle_overlay_change
P_ ((struct it
*));
842 static enum prop_handled handle_fontified_prop
P_ ((struct it
*));
844 /* Properties handled by iterators. */
846 static struct props it_props
[] =
848 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
849 /* Handle `face' before `display' because some sub-properties of
850 `display' need to know the face. */
851 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
852 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
853 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
854 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
858 /* Value is the position described by X. If X is a marker, value is
859 the marker_position of X. Otherwise, value is X. */
861 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
863 /* Enumeration returned by some move_it_.* functions internally. */
867 /* Not used. Undefined value. */
870 /* Move ended at the requested buffer position or ZV. */
871 MOVE_POS_MATCH_OR_ZV
,
873 /* Move ended at the requested X pixel position. */
876 /* Move within a line ended at the end of a line that must be
880 /* Move within a line ended at the end of a line that would
881 be displayed truncated. */
884 /* Move within a line ended at a line end. */
888 /* This counter is used to clear the face cache every once in a while
889 in redisplay_internal. It is incremented for each redisplay.
890 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
893 #define CLEAR_FACE_CACHE_COUNT 500
894 static int clear_face_cache_count
;
896 /* Similarly for the image cache. */
898 #ifdef HAVE_WINDOW_SYSTEM
899 #define CLEAR_IMAGE_CACHE_COUNT 101
900 static int clear_image_cache_count
;
903 /* Non-zero while redisplay_internal is in progress. */
907 /* Non-zero means don't free realized faces. Bound while freeing
908 realized faces is dangerous because glyph matrices might still
911 int inhibit_free_realized_faces
;
912 Lisp_Object Qinhibit_free_realized_faces
;
914 /* If a string, XTread_socket generates an event to display that string.
915 (The display is done in read_char.) */
917 Lisp_Object help_echo_string
;
918 Lisp_Object help_echo_window
;
919 Lisp_Object help_echo_object
;
922 /* Temporary variable for XTread_socket. */
924 Lisp_Object previous_help_echo_string
;
926 /* Null glyph slice */
928 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
930 /* Platform-independent portion of hourglass implementation. */
932 /* Non-zero means we're allowed to display a hourglass pointer. */
933 int display_hourglass_p
;
935 /* Non-zero means an hourglass cursor is currently shown. */
936 int hourglass_shown_p
;
938 /* If non-null, an asynchronous timer that, when it expires, displays
939 an hourglass cursor on all frames. */
940 struct atimer
*hourglass_atimer
;
942 /* Number of seconds to wait before displaying an hourglass cursor. */
943 Lisp_Object Vhourglass_delay
;
945 /* Default number of seconds to wait before displaying an hourglass
947 #define DEFAULT_HOURGLASS_DELAY 1
950 /* Function prototypes. */
952 static void setup_for_ellipsis
P_ ((struct it
*, int));
953 static void mark_window_display_accurate_1
P_ ((struct window
*, int));
954 static int single_display_spec_string_p
P_ ((Lisp_Object
, Lisp_Object
));
955 static int display_prop_string_p
P_ ((Lisp_Object
, Lisp_Object
));
956 static int cursor_row_p
P_ ((struct window
*, struct glyph_row
*));
957 static int redisplay_mode_lines
P_ ((Lisp_Object
, int));
958 static char *decode_mode_spec_coding
P_ ((Lisp_Object
, char *, int));
960 static Lisp_Object get_it_property
P_ ((struct it
*it
, Lisp_Object prop
));
962 static void handle_line_prefix
P_ ((struct it
*));
964 static void pint2str
P_ ((char *, int, int));
965 static void pint2hrstr
P_ ((char *, int, int));
966 static struct text_pos run_window_scroll_functions
P_ ((Lisp_Object
,
968 static void reconsider_clip_changes
P_ ((struct window
*, struct buffer
*));
969 static int text_outside_line_unchanged_p
P_ ((struct window
*, int, int));
970 static void store_mode_line_noprop_char
P_ ((char));
971 static int store_mode_line_noprop
P_ ((const unsigned char *, int, int));
972 static void x_consider_frame_title
P_ ((Lisp_Object
));
973 static void handle_stop
P_ ((struct it
*));
974 static void handle_stop_backwards
P_ ((struct it
*, EMACS_INT
));
975 static int tool_bar_lines_needed
P_ ((struct frame
*, int *));
976 static int single_display_spec_intangible_p
P_ ((Lisp_Object
));
977 static void ensure_echo_area_buffers
P_ ((void));
978 static Lisp_Object unwind_with_echo_area_buffer
P_ ((Lisp_Object
));
979 static Lisp_Object with_echo_area_buffer_unwind_data
P_ ((struct window
*));
980 static int with_echo_area_buffer
P_ ((struct window
*, int,
981 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
982 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
983 static void clear_garbaged_frames
P_ ((void));
984 static int current_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
985 static int truncate_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
986 static int set_message_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
987 static int display_echo_area
P_ ((struct window
*));
988 static int display_echo_area_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
989 static int resize_mini_window_1
P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
990 static Lisp_Object unwind_redisplay
P_ ((Lisp_Object
));
991 static int string_char_and_length
P_ ((const unsigned char *, int *));
992 static struct text_pos display_prop_end
P_ ((struct it
*, Lisp_Object
,
994 static int compute_window_start_on_continuation_line
P_ ((struct window
*));
995 static Lisp_Object safe_eval_handler
P_ ((Lisp_Object
));
996 static void insert_left_trunc_glyphs
P_ ((struct it
*));
997 static struct glyph_row
*get_overlay_arrow_glyph_row
P_ ((struct window
*,
999 static void extend_face_to_end_of_line
P_ ((struct it
*));
1000 static int append_space_for_newline
P_ ((struct it
*, int));
1001 static int cursor_row_fully_visible_p
P_ ((struct window
*, int, int));
1002 static int try_scrolling
P_ ((Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int));
1003 static int try_cursor_movement
P_ ((Lisp_Object
, struct text_pos
, int *));
1004 static int trailing_whitespace_p
P_ ((int));
1005 static int message_log_check_duplicate
P_ ((int, int, int, int));
1006 static void push_it
P_ ((struct it
*));
1007 static void pop_it
P_ ((struct it
*));
1008 static void sync_frame_with_window_matrix_rows
P_ ((struct window
*));
1009 static void select_frame_for_redisplay
P_ ((Lisp_Object
));
1010 static void redisplay_internal
P_ ((int));
1011 static int echo_area_display
P_ ((int));
1012 static void redisplay_windows
P_ ((Lisp_Object
));
1013 static void redisplay_window
P_ ((Lisp_Object
, int));
1014 static Lisp_Object
redisplay_window_error ();
1015 static Lisp_Object redisplay_window_0
P_ ((Lisp_Object
));
1016 static Lisp_Object redisplay_window_1
P_ ((Lisp_Object
));
1017 static int update_menu_bar
P_ ((struct frame
*, int, int));
1018 static int try_window_reusing_current_matrix
P_ ((struct window
*));
1019 static int try_window_id
P_ ((struct window
*));
1020 static int display_line
P_ ((struct it
*));
1021 static int display_mode_lines
P_ ((struct window
*));
1022 static int display_mode_line
P_ ((struct window
*, enum face_id
, Lisp_Object
));
1023 static int display_mode_element
P_ ((struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int));
1024 static int store_mode_line_string
P_ ((char *, Lisp_Object
, int, int, int, Lisp_Object
));
1025 static char *decode_mode_spec
P_ ((struct window
*, int, int, int,
1027 static void display_menu_bar
P_ ((struct window
*));
1028 static int display_count_lines
P_ ((int, int, int, int, int *));
1029 static int display_string
P_ ((unsigned char *, Lisp_Object
, Lisp_Object
,
1030 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int));
1031 static void compute_line_metrics
P_ ((struct it
*));
1032 static void run_redisplay_end_trigger_hook
P_ ((struct it
*));
1033 static int get_overlay_strings
P_ ((struct it
*, int));
1034 static int get_overlay_strings_1
P_ ((struct it
*, int, int));
1035 static void next_overlay_string
P_ ((struct it
*));
1036 static void reseat
P_ ((struct it
*, struct text_pos
, int));
1037 static void reseat_1
P_ ((struct it
*, struct text_pos
, int));
1038 static void back_to_previous_visible_line_start
P_ ((struct it
*));
1039 void reseat_at_previous_visible_line_start
P_ ((struct it
*));
1040 static void reseat_at_next_visible_line_start
P_ ((struct it
*, int));
1041 static int next_element_from_ellipsis
P_ ((struct it
*));
1042 static int next_element_from_display_vector
P_ ((struct it
*));
1043 static int next_element_from_string
P_ ((struct it
*));
1044 static int next_element_from_c_string
P_ ((struct it
*));
1045 static int next_element_from_buffer
P_ ((struct it
*));
1046 static int next_element_from_composition
P_ ((struct it
*));
1047 static int next_element_from_image
P_ ((struct it
*));
1048 static int next_element_from_stretch
P_ ((struct it
*));
1049 static void load_overlay_strings
P_ ((struct it
*, int));
1050 static int init_from_display_pos
P_ ((struct it
*, struct window
*,
1051 struct display_pos
*));
1052 static void reseat_to_string
P_ ((struct it
*, unsigned char *,
1053 Lisp_Object
, int, int, int, int));
1054 static enum move_it_result
1055 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
1056 enum move_operation_enum
);
1057 void move_it_vertically_backward
P_ ((struct it
*, int));
1058 static void init_to_row_start
P_ ((struct it
*, struct window
*,
1059 struct glyph_row
*));
1060 static int init_to_row_end
P_ ((struct it
*, struct window
*,
1061 struct glyph_row
*));
1062 static void back_to_previous_line_start
P_ ((struct it
*));
1063 static int forward_to_next_line_start
P_ ((struct it
*, int *));
1064 static struct text_pos string_pos_nchars_ahead
P_ ((struct text_pos
,
1066 static struct text_pos string_pos
P_ ((int, Lisp_Object
));
1067 static struct text_pos c_string_pos
P_ ((int, unsigned char *, int));
1068 static int number_of_chars
P_ ((unsigned char *, int));
1069 static void compute_stop_pos
P_ ((struct it
*));
1070 static void compute_string_pos
P_ ((struct text_pos
*, struct text_pos
,
1072 static int face_before_or_after_it_pos
P_ ((struct it
*, int));
1073 static EMACS_INT next_overlay_change
P_ ((EMACS_INT
));
1074 static int handle_single_display_spec
P_ ((struct it
*, Lisp_Object
,
1075 Lisp_Object
, Lisp_Object
,
1076 struct text_pos
*, int));
1077 static int underlying_face_id
P_ ((struct it
*));
1078 static int in_ellipses_for_invisible_text_p
P_ ((struct display_pos
*,
1081 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
1082 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
1084 #ifdef HAVE_WINDOW_SYSTEM
1086 static void update_tool_bar
P_ ((struct frame
*, int));
1087 static void build_desired_tool_bar_string
P_ ((struct frame
*f
));
1088 static int redisplay_tool_bar
P_ ((struct frame
*));
1089 static void display_tool_bar_line
P_ ((struct it
*, int));
1090 static void notice_overwritten_cursor
P_ ((struct window
*,
1091 enum glyph_row_area
,
1092 int, int, int, int));
1093 static void append_stretch_glyph
P_ ((struct it
*, Lisp_Object
,
1098 #endif /* HAVE_WINDOW_SYSTEM */
1101 /***********************************************************************
1102 Window display dimensions
1103 ***********************************************************************/
1105 /* Return the bottom boundary y-position for text lines in window W.
1106 This is the first y position at which a line cannot start.
1107 It is relative to the top of the window.
1109 This is the height of W minus the height of a mode line, if any. */
1112 window_text_bottom_y (w
)
1115 int height
= WINDOW_TOTAL_HEIGHT (w
);
1117 if (WINDOW_WANTS_MODELINE_P (w
))
1118 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1122 /* Return the pixel width of display area AREA of window W. AREA < 0
1123 means return the total width of W, not including fringes to
1124 the left and right of the window. */
1127 window_box_width (w
, area
)
1131 int cols
= XFASTINT (w
->total_cols
);
1134 if (!w
->pseudo_window_p
)
1136 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1138 if (area
== TEXT_AREA
)
1140 if (INTEGERP (w
->left_margin_cols
))
1141 cols
-= XFASTINT (w
->left_margin_cols
);
1142 if (INTEGERP (w
->right_margin_cols
))
1143 cols
-= XFASTINT (w
->right_margin_cols
);
1144 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1146 else if (area
== LEFT_MARGIN_AREA
)
1148 cols
= (INTEGERP (w
->left_margin_cols
)
1149 ? XFASTINT (w
->left_margin_cols
) : 0);
1152 else if (area
== RIGHT_MARGIN_AREA
)
1154 cols
= (INTEGERP (w
->right_margin_cols
)
1155 ? XFASTINT (w
->right_margin_cols
) : 0);
1160 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1164 /* Return the pixel height of the display area of window W, not
1165 including mode lines of W, if any. */
1168 window_box_height (w
)
1171 struct frame
*f
= XFRAME (w
->frame
);
1172 int height
= WINDOW_TOTAL_HEIGHT (w
);
1174 xassert (height
>= 0);
1176 /* Note: the code below that determines the mode-line/header-line
1177 height is essentially the same as that contained in the macro
1178 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1179 the appropriate glyph row has its `mode_line_p' flag set,
1180 and if it doesn't, uses estimate_mode_line_height instead. */
1182 if (WINDOW_WANTS_MODELINE_P (w
))
1184 struct glyph_row
*ml_row
1185 = (w
->current_matrix
&& w
->current_matrix
->rows
1186 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1188 if (ml_row
&& ml_row
->mode_line_p
)
1189 height
-= ml_row
->height
;
1191 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1194 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1196 struct glyph_row
*hl_row
1197 = (w
->current_matrix
&& w
->current_matrix
->rows
1198 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1200 if (hl_row
&& hl_row
->mode_line_p
)
1201 height
-= hl_row
->height
;
1203 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1206 /* With a very small font and a mode-line that's taller than
1207 default, we might end up with a negative height. */
1208 return max (0, height
);
1211 /* Return the window-relative coordinate of the left edge of display
1212 area AREA of window W. AREA < 0 means return the left edge of the
1213 whole window, to the right of the left fringe of W. */
1216 window_box_left_offset (w
, area
)
1222 if (w
->pseudo_window_p
)
1225 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1227 if (area
== TEXT_AREA
)
1228 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1229 + window_box_width (w
, LEFT_MARGIN_AREA
));
1230 else if (area
== RIGHT_MARGIN_AREA
)
1231 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1232 + window_box_width (w
, LEFT_MARGIN_AREA
)
1233 + window_box_width (w
, TEXT_AREA
)
1234 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1236 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1237 else if (area
== LEFT_MARGIN_AREA
1238 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1239 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1245 /* Return the window-relative coordinate of the right edge of display
1246 area AREA of window W. AREA < 0 means return the left edge of the
1247 whole window, to the left of the right fringe of W. */
1250 window_box_right_offset (w
, area
)
1254 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1257 /* Return the frame-relative coordinate of the left edge of display
1258 area AREA of window W. AREA < 0 means return the left edge of the
1259 whole window, to the right of the left fringe of W. */
1262 window_box_left (w
, area
)
1266 struct frame
*f
= XFRAME (w
->frame
);
1269 if (w
->pseudo_window_p
)
1270 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1272 x
= (WINDOW_LEFT_EDGE_X (w
)
1273 + window_box_left_offset (w
, area
));
1279 /* Return the frame-relative coordinate of the right edge of display
1280 area AREA of window W. AREA < 0 means return the left edge of the
1281 whole window, to the left of the right fringe of W. */
1284 window_box_right (w
, area
)
1288 return window_box_left (w
, area
) + window_box_width (w
, area
);
1291 /* Get the bounding box of the display area AREA of window W, without
1292 mode lines, in frame-relative coordinates. AREA < 0 means the
1293 whole window, not including the left and right fringes of
1294 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1295 coordinates of the upper-left corner of the box. Return in
1296 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1299 window_box (w
, area
, box_x
, box_y
, box_width
, box_height
)
1302 int *box_x
, *box_y
, *box_width
, *box_height
;
1305 *box_width
= window_box_width (w
, area
);
1307 *box_height
= window_box_height (w
);
1309 *box_x
= window_box_left (w
, area
);
1312 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1313 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1314 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1319 /* Get the bounding box of the display area AREA of window W, without
1320 mode lines. AREA < 0 means the whole window, not including the
1321 left and right fringe of the window. Return in *TOP_LEFT_X
1322 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1323 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1324 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1328 window_box_edges (w
, area
, top_left_x
, top_left_y
,
1329 bottom_right_x
, bottom_right_y
)
1332 int *top_left_x
, *top_left_y
, *bottom_right_x
, *bottom_right_y
;
1334 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1336 *bottom_right_x
+= *top_left_x
;
1337 *bottom_right_y
+= *top_left_y
;
1342 /***********************************************************************
1344 ***********************************************************************/
1346 /* Return the bottom y-position of the line the iterator IT is in.
1347 This can modify IT's settings. */
1353 int line_height
= it
->max_ascent
+ it
->max_descent
;
1354 int line_top_y
= it
->current_y
;
1356 if (line_height
== 0)
1359 line_height
= last_height
;
1360 else if (IT_CHARPOS (*it
) < ZV
)
1362 move_it_by_lines (it
, 1, 1);
1363 line_height
= (it
->max_ascent
|| it
->max_descent
1364 ? it
->max_ascent
+ it
->max_descent
1369 struct glyph_row
*row
= it
->glyph_row
;
1371 /* Use the default character height. */
1372 it
->glyph_row
= NULL
;
1373 it
->what
= IT_CHARACTER
;
1376 PRODUCE_GLYPHS (it
);
1377 line_height
= it
->ascent
+ it
->descent
;
1378 it
->glyph_row
= row
;
1382 return line_top_y
+ line_height
;
1386 /* Return 1 if position CHARPOS is visible in window W.
1387 CHARPOS < 0 means return info about WINDOW_END position.
1388 If visible, set *X and *Y to pixel coordinates of top left corner.
1389 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1390 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1393 pos_visible_p (w
, charpos
, x
, y
, rtop
, rbot
, rowh
, vpos
)
1395 int charpos
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
;
1398 struct text_pos top
;
1400 struct buffer
*old_buffer
= NULL
;
1402 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1405 if (XBUFFER (w
->buffer
) != current_buffer
)
1407 old_buffer
= current_buffer
;
1408 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1411 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1413 /* Compute exact mode line heights. */
1414 if (WINDOW_WANTS_MODELINE_P (w
))
1415 current_mode_line_height
1416 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1417 current_buffer
->mode_line_format
);
1419 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1420 current_header_line_height
1421 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1422 current_buffer
->header_line_format
);
1424 start_display (&it
, w
, top
);
1425 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1426 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1428 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1430 /* We have reached CHARPOS, or passed it. How the call to
1431 move_it_to can overshoot: (i) If CHARPOS is on invisible
1432 text, move_it_to stops at the end of the invisible text,
1433 after CHARPOS. (ii) If CHARPOS is in a display vector,
1434 move_it_to stops on its last glyph. */
1435 int top_x
= it
.current_x
;
1436 int top_y
= it
.current_y
;
1437 enum it_method it_method
= it
.method
;
1438 /* Calling line_bottom_y may change it.method, it.position, etc. */
1439 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1440 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1442 if (top_y
< window_top_y
)
1443 visible_p
= bottom_y
> window_top_y
;
1444 else if (top_y
< it
.last_visible_y
)
1448 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1450 /* We stopped on the last glyph of a display vector.
1451 Try and recompute. Hack alert! */
1452 if (charpos
< 2 || top
.charpos
>= charpos
)
1453 top_x
= it
.glyph_row
->x
;
1457 start_display (&it2
, w
, top
);
1458 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1459 get_next_display_element (&it2
);
1460 PRODUCE_GLYPHS (&it2
);
1461 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1462 || it2
.current_x
> it2
.last_visible_x
)
1463 top_x
= it
.glyph_row
->x
;
1466 top_x
= it2
.current_x
;
1467 top_y
= it2
.current_y
;
1473 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1474 *rtop
= max (0, window_top_y
- top_y
);
1475 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1476 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1477 - max (top_y
, window_top_y
)));
1486 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1487 move_it_by_lines (&it
, 1, 0);
1488 if (charpos
< IT_CHARPOS (it
)
1489 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1492 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1494 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1495 *rtop
= max (0, -it2
.current_y
);
1496 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1497 - it
.last_visible_y
));
1498 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1500 - max (it2
.current_y
,
1501 WINDOW_HEADER_LINE_HEIGHT (w
))));
1507 set_buffer_internal_1 (old_buffer
);
1509 current_header_line_height
= current_mode_line_height
= -1;
1511 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1512 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1515 /* Debugging code. */
1517 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1518 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1520 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1527 /* Return the next character from STR which is MAXLEN bytes long.
1528 Return in *LEN the length of the character. This is like
1529 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1530 we find one, we return a `?', but with the length of the invalid
1534 string_char_and_length (str
, len
)
1535 const unsigned char *str
;
1540 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1541 if (!CHAR_VALID_P (c
, 1))
1542 /* We may not change the length here because other places in Emacs
1543 don't use this function, i.e. they silently accept invalid
1552 /* Given a position POS containing a valid character and byte position
1553 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1555 static struct text_pos
1556 string_pos_nchars_ahead (pos
, string
, nchars
)
1557 struct text_pos pos
;
1561 xassert (STRINGP (string
) && nchars
>= 0);
1563 if (STRING_MULTIBYTE (string
))
1565 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1566 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1571 string_char_and_length (p
, &len
);
1572 p
+= len
, rest
-= len
;
1573 xassert (rest
>= 0);
1575 BYTEPOS (pos
) += len
;
1579 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1585 /* Value is the text position, i.e. character and byte position,
1586 for character position CHARPOS in STRING. */
1588 static INLINE
struct text_pos
1589 string_pos (charpos
, string
)
1593 struct text_pos pos
;
1594 xassert (STRINGP (string
));
1595 xassert (charpos
>= 0);
1596 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1601 /* Value is a text position, i.e. character and byte position, for
1602 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1603 means recognize multibyte characters. */
1605 static struct text_pos
1606 c_string_pos (charpos
, s
, multibyte_p
)
1611 struct text_pos pos
;
1613 xassert (s
!= NULL
);
1614 xassert (charpos
>= 0);
1618 int rest
= strlen (s
), len
;
1620 SET_TEXT_POS (pos
, 0, 0);
1623 string_char_and_length (s
, &len
);
1624 s
+= len
, rest
-= len
;
1625 xassert (rest
>= 0);
1627 BYTEPOS (pos
) += len
;
1631 SET_TEXT_POS (pos
, charpos
, charpos
);
1637 /* Value is the number of characters in C string S. MULTIBYTE_P
1638 non-zero means recognize multibyte characters. */
1641 number_of_chars (s
, multibyte_p
)
1649 int rest
= strlen (s
), len
;
1650 unsigned char *p
= (unsigned char *) s
;
1652 for (nchars
= 0; rest
> 0; ++nchars
)
1654 string_char_and_length (p
, &len
);
1655 rest
-= len
, p
+= len
;
1659 nchars
= strlen (s
);
1665 /* Compute byte position NEWPOS->bytepos corresponding to
1666 NEWPOS->charpos. POS is a known position in string STRING.
1667 NEWPOS->charpos must be >= POS.charpos. */
1670 compute_string_pos (newpos
, pos
, string
)
1671 struct text_pos
*newpos
, pos
;
1674 xassert (STRINGP (string
));
1675 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1677 if (STRING_MULTIBYTE (string
))
1678 *newpos
= string_pos_nchars_ahead (pos
, string
,
1679 CHARPOS (*newpos
) - CHARPOS (pos
));
1681 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1685 Return an estimation of the pixel height of mode or header lines on
1686 frame F. FACE_ID specifies what line's height to estimate. */
1689 estimate_mode_line_height (f
, face_id
)
1691 enum face_id face_id
;
1693 #ifdef HAVE_WINDOW_SYSTEM
1694 if (FRAME_WINDOW_P (f
))
1696 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1698 /* This function is called so early when Emacs starts that the face
1699 cache and mode line face are not yet initialized. */
1700 if (FRAME_FACE_CACHE (f
))
1702 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1706 height
= FONT_HEIGHT (face
->font
);
1707 if (face
->box_line_width
> 0)
1708 height
+= 2 * face
->box_line_width
;
1719 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1720 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1721 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1722 not force the value into range. */
1725 pixel_to_glyph_coords (f
, pix_x
, pix_y
, x
, y
, bounds
, noclip
)
1727 register int pix_x
, pix_y
;
1729 NativeRectangle
*bounds
;
1733 #ifdef HAVE_WINDOW_SYSTEM
1734 if (FRAME_WINDOW_P (f
))
1736 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1737 even for negative values. */
1739 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1741 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1743 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1744 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1747 STORE_NATIVE_RECT (*bounds
,
1748 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1749 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1750 FRAME_COLUMN_WIDTH (f
) - 1,
1751 FRAME_LINE_HEIGHT (f
) - 1);
1757 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1758 pix_x
= FRAME_TOTAL_COLS (f
);
1762 else if (pix_y
> FRAME_LINES (f
))
1763 pix_y
= FRAME_LINES (f
);
1773 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1774 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1775 can't tell the positions because W's display is not up to date,
1779 glyph_to_pixel_coords (w
, hpos
, vpos
, frame_x
, frame_y
)
1782 int *frame_x
, *frame_y
;
1784 #ifdef HAVE_WINDOW_SYSTEM
1785 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1789 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1790 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1792 if (display_completed
)
1794 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1795 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1796 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1802 hpos
+= glyph
->pixel_width
;
1806 /* If first glyph is partially visible, its first visible position is still 0. */
1818 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1819 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1830 #ifdef HAVE_WINDOW_SYSTEM
1832 /* Find the glyph under window-relative coordinates X/Y in window W.
1833 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1834 strings. Return in *HPOS and *VPOS the row and column number of
1835 the glyph found. Return in *AREA the glyph area containing X.
1836 Value is a pointer to the glyph found or null if X/Y is not on
1837 text, or we can't tell because W's current matrix is not up to
1842 x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, dx
, dy
, area
)
1845 int *hpos
, *vpos
, *dx
, *dy
, *area
;
1847 struct glyph
*glyph
, *end
;
1848 struct glyph_row
*row
= NULL
;
1851 /* Find row containing Y. Give up if some row is not enabled. */
1852 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1854 row
= MATRIX_ROW (w
->current_matrix
, i
);
1855 if (!row
->enabled_p
)
1857 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1864 /* Give up if Y is not in the window. */
1865 if (i
== w
->current_matrix
->nrows
)
1868 /* Get the glyph area containing X. */
1869 if (w
->pseudo_window_p
)
1876 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1878 *area
= LEFT_MARGIN_AREA
;
1879 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1881 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1884 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1888 *area
= RIGHT_MARGIN_AREA
;
1889 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1893 /* Find glyph containing X. */
1894 glyph
= row
->glyphs
[*area
];
1895 end
= glyph
+ row
->used
[*area
];
1897 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1899 x
-= glyph
->pixel_width
;
1909 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1912 *hpos
= glyph
- row
->glyphs
[*area
];
1918 Convert frame-relative x/y to coordinates relative to window W.
1919 Takes pseudo-windows into account. */
1922 frame_to_window_pixel_xy (w
, x
, y
)
1926 if (w
->pseudo_window_p
)
1928 /* A pseudo-window is always full-width, and starts at the
1929 left edge of the frame, plus a frame border. */
1930 struct frame
*f
= XFRAME (w
->frame
);
1931 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1932 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1936 *x
-= WINDOW_LEFT_EDGE_X (w
);
1937 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1942 Return in RECTS[] at most N clipping rectangles for glyph string S.
1943 Return the number of stored rectangles. */
1946 get_glyph_string_clip_rects (s
, rects
, n
)
1947 struct glyph_string
*s
;
1948 NativeRectangle
*rects
;
1956 if (s
->row
->full_width_p
)
1958 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1959 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1960 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1962 /* Unless displaying a mode or menu bar line, which are always
1963 fully visible, clip to the visible part of the row. */
1964 if (s
->w
->pseudo_window_p
)
1965 r
.height
= s
->row
->visible_height
;
1967 r
.height
= s
->height
;
1971 /* This is a text line that may be partially visible. */
1972 r
.x
= window_box_left (s
->w
, s
->area
);
1973 r
.width
= window_box_width (s
->w
, s
->area
);
1974 r
.height
= s
->row
->visible_height
;
1978 if (r
.x
< s
->clip_head
->x
)
1980 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1981 r
.width
-= s
->clip_head
->x
- r
.x
;
1984 r
.x
= s
->clip_head
->x
;
1987 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1989 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1990 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1995 /* If S draws overlapping rows, it's sufficient to use the top and
1996 bottom of the window for clipping because this glyph string
1997 intentionally draws over other lines. */
1998 if (s
->for_overlaps
)
2000 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2001 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2003 /* Alas, the above simple strategy does not work for the
2004 environments with anti-aliased text: if the same text is
2005 drawn onto the same place multiple times, it gets thicker.
2006 If the overlap we are processing is for the erased cursor, we
2007 take the intersection with the rectagle of the cursor. */
2008 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2010 XRectangle rc
, r_save
= r
;
2012 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2013 rc
.y
= s
->w
->phys_cursor
.y
;
2014 rc
.width
= s
->w
->phys_cursor_width
;
2015 rc
.height
= s
->w
->phys_cursor_height
;
2017 x_intersect_rectangles (&r_save
, &rc
, &r
);
2022 /* Don't use S->y for clipping because it doesn't take partially
2023 visible lines into account. For example, it can be negative for
2024 partially visible lines at the top of a window. */
2025 if (!s
->row
->full_width_p
2026 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2027 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2029 r
.y
= max (0, s
->row
->y
);
2032 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2034 /* If drawing the cursor, don't let glyph draw outside its
2035 advertised boundaries. Cleartype does this under some circumstances. */
2036 if (s
->hl
== DRAW_CURSOR
)
2038 struct glyph
*glyph
= s
->first_glyph
;
2043 r
.width
-= s
->x
- r
.x
;
2046 r
.width
= min (r
.width
, glyph
->pixel_width
);
2048 /* If r.y is below window bottom, ensure that we still see a cursor. */
2049 height
= min (glyph
->ascent
+ glyph
->descent
,
2050 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2051 max_y
= window_text_bottom_y (s
->w
) - height
;
2052 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2053 if (s
->ybase
- glyph
->ascent
> max_y
)
2060 /* Don't draw cursor glyph taller than our actual glyph. */
2061 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2062 if (height
< r
.height
)
2064 max_y
= r
.y
+ r
.height
;
2065 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2066 r
.height
= min (max_y
- r
.y
, height
);
2073 XRectangle r_save
= r
;
2075 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2079 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2080 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2082 #ifdef CONVERT_FROM_XRECT
2083 CONVERT_FROM_XRECT (r
, *rects
);
2091 /* If we are processing overlapping and allowed to return
2092 multiple clipping rectangles, we exclude the row of the glyph
2093 string from the clipping rectangle. This is to avoid drawing
2094 the same text on the environment with anti-aliasing. */
2095 #ifdef CONVERT_FROM_XRECT
2098 XRectangle
*rs
= rects
;
2100 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2102 if (s
->for_overlaps
& OVERLAPS_PRED
)
2105 if (r
.y
+ r
.height
> row_y
)
2108 rs
[i
].height
= row_y
- r
.y
;
2114 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2117 if (r
.y
< row_y
+ s
->row
->visible_height
)
2119 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2121 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2122 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2131 #ifdef CONVERT_FROM_XRECT
2132 for (i
= 0; i
< n
; i
++)
2133 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2140 Return in *NR the clipping rectangle for glyph string S. */
2143 get_glyph_string_clip_rect (s
, nr
)
2144 struct glyph_string
*s
;
2145 NativeRectangle
*nr
;
2147 get_glyph_string_clip_rects (s
, nr
, 1);
2152 Return the position and height of the phys cursor in window W.
2153 Set w->phys_cursor_width to width of phys cursor.
2157 get_phys_cursor_geometry (w
, row
, glyph
, xp
, yp
, heightp
)
2159 struct glyph_row
*row
;
2160 struct glyph
*glyph
;
2161 int *xp
, *yp
, *heightp
;
2163 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2164 int x
, y
, wd
, h
, h0
, y0
;
2166 /* Compute the width of the rectangle to draw. If on a stretch
2167 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2168 rectangle as wide as the glyph, but use a canonical character
2170 wd
= glyph
->pixel_width
- 1;
2171 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2175 x
= w
->phys_cursor
.x
;
2182 if (glyph
->type
== STRETCH_GLYPH
2183 && !x_stretch_cursor_p
)
2184 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2185 w
->phys_cursor_width
= wd
;
2187 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2189 /* If y is below window bottom, ensure that we still see a cursor. */
2190 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2192 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2193 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2195 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2198 h
= max (h
- (y0
- y
) + 1, h0
);
2203 y0
= window_text_bottom_y (w
) - h0
;
2211 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2212 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2217 * Remember which glyph the mouse is over.
2221 remember_mouse_glyph (f
, gx
, gy
, rect
)
2224 NativeRectangle
*rect
;
2228 struct glyph_row
*r
, *gr
, *end_row
;
2229 enum window_part part
;
2230 enum glyph_row_area area
;
2231 int x
, y
, width
, height
;
2233 /* Try to determine frame pixel position and size of the glyph under
2234 frame pixel coordinates X/Y on frame F. */
2236 if (!f
->glyphs_initialized_p
2237 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2240 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2241 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2245 w
= XWINDOW (window
);
2246 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2247 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2249 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2250 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2252 if (w
->pseudo_window_p
)
2255 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2261 case ON_LEFT_MARGIN
:
2262 area
= LEFT_MARGIN_AREA
;
2265 case ON_RIGHT_MARGIN
:
2266 area
= RIGHT_MARGIN_AREA
;
2269 case ON_HEADER_LINE
:
2271 gr
= (part
== ON_HEADER_LINE
2272 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2273 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2276 goto text_glyph_row_found
;
2283 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2284 if (r
->y
+ r
->height
> y
)
2290 text_glyph_row_found
:
2293 struct glyph
*g
= gr
->glyphs
[area
];
2294 struct glyph
*end
= g
+ gr
->used
[area
];
2296 height
= gr
->height
;
2297 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2298 if (gx
+ g
->pixel_width
> x
)
2303 if (g
->type
== IMAGE_GLYPH
)
2305 /* Don't remember when mouse is over image, as
2306 image may have hot-spots. */
2307 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2310 width
= g
->pixel_width
;
2314 /* Use nominal char spacing at end of line. */
2316 gx
+= (x
/ width
) * width
;
2319 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2320 gx
+= window_box_left_offset (w
, area
);
2324 /* Use nominal line height at end of window. */
2325 gx
= (x
/ width
) * width
;
2327 gy
+= (y
/ height
) * height
;
2331 case ON_LEFT_FRINGE
:
2332 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2333 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2334 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2335 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2338 case ON_RIGHT_FRINGE
:
2339 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2340 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2341 : window_box_right_offset (w
, TEXT_AREA
));
2342 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2346 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2348 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2349 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2350 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2352 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2356 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2357 if (r
->y
+ r
->height
> y
)
2364 height
= gr
->height
;
2367 /* Use nominal line height at end of window. */
2369 gy
+= (y
/ height
) * height
;
2376 /* If there is no glyph under the mouse, then we divide the screen
2377 into a grid of the smallest glyph in the frame, and use that
2380 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2381 round down even for negative values. */
2387 gx
= (gx
/ width
) * width
;
2388 gy
= (gy
/ height
) * height
;
2393 gx
+= WINDOW_LEFT_EDGE_X (w
);
2394 gy
+= WINDOW_TOP_EDGE_Y (w
);
2397 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2399 /* Visible feedback for debugging. */
2402 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2403 f
->output_data
.x
->normal_gc
,
2404 gx
, gy
, width
, height
);
2410 #endif /* HAVE_WINDOW_SYSTEM */
2413 /***********************************************************************
2414 Lisp form evaluation
2415 ***********************************************************************/
2417 /* Error handler for safe_eval and safe_call. */
2420 safe_eval_handler (arg
)
2423 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2428 /* Evaluate SEXPR and return the result, or nil if something went
2429 wrong. Prevent redisplay during the evaluation. */
2431 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2432 Return the result, or nil if something went wrong. Prevent
2433 redisplay during the evaluation. */
2436 safe_call (nargs
, args
)
2442 if (inhibit_eval_during_redisplay
)
2446 int count
= SPECPDL_INDEX ();
2447 struct gcpro gcpro1
;
2450 gcpro1
.nvars
= nargs
;
2451 specbind (Qinhibit_redisplay
, Qt
);
2452 /* Use Qt to ensure debugger does not run,
2453 so there is no possibility of wanting to redisplay. */
2454 val
= internal_condition_case_2 (Ffuncall
, nargs
, args
, Qt
,
2457 val
= unbind_to (count
, val
);
2464 /* Call function FN with one argument ARG.
2465 Return the result, or nil if something went wrong. */
2468 safe_call1 (fn
, arg
)
2469 Lisp_Object fn
, arg
;
2471 Lisp_Object args
[2];
2474 return safe_call (2, args
);
2477 static Lisp_Object Qeval
;
2480 safe_eval (Lisp_Object sexpr
)
2482 return safe_call1 (Qeval
, sexpr
);
2485 /* Call function FN with one argument ARG.
2486 Return the result, or nil if something went wrong. */
2489 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2491 Lisp_Object args
[3];
2495 return safe_call (3, args
);
2500 /***********************************************************************
2502 ***********************************************************************/
2506 /* Define CHECK_IT to perform sanity checks on iterators.
2507 This is for debugging. It is too slow to do unconditionally. */
2513 if (it
->method
== GET_FROM_STRING
)
2515 xassert (STRINGP (it
->string
));
2516 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2520 xassert (IT_STRING_CHARPOS (*it
) < 0);
2521 if (it
->method
== GET_FROM_BUFFER
)
2523 /* Check that character and byte positions agree. */
2524 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2529 xassert (it
->current
.dpvec_index
>= 0);
2531 xassert (it
->current
.dpvec_index
< 0);
2534 #define CHECK_IT(IT) check_it ((IT))
2538 #define CHECK_IT(IT) (void) 0
2545 /* Check that the window end of window W is what we expect it
2546 to be---the last row in the current matrix displaying text. */
2549 check_window_end (w
)
2552 if (!MINI_WINDOW_P (w
)
2553 && !NILP (w
->window_end_valid
))
2555 struct glyph_row
*row
;
2556 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2557 XFASTINT (w
->window_end_vpos
)),
2559 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2560 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2564 #define CHECK_WINDOW_END(W) check_window_end ((W))
2566 #else /* not GLYPH_DEBUG */
2568 #define CHECK_WINDOW_END(W) (void) 0
2570 #endif /* not GLYPH_DEBUG */
2574 /***********************************************************************
2575 Iterator initialization
2576 ***********************************************************************/
2578 /* Initialize IT for displaying current_buffer in window W, starting
2579 at character position CHARPOS. CHARPOS < 0 means that no buffer
2580 position is specified which is useful when the iterator is assigned
2581 a position later. BYTEPOS is the byte position corresponding to
2582 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2584 If ROW is not null, calls to produce_glyphs with IT as parameter
2585 will produce glyphs in that row.
2587 BASE_FACE_ID is the id of a base face to use. It must be one of
2588 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2589 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2590 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2592 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2593 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2594 will be initialized to use the corresponding mode line glyph row of
2595 the desired matrix of W. */
2598 init_iterator (it
, w
, charpos
, bytepos
, row
, base_face_id
)
2601 int charpos
, bytepos
;
2602 struct glyph_row
*row
;
2603 enum face_id base_face_id
;
2605 int highlight_region_p
;
2606 enum face_id remapped_base_face_id
= base_face_id
;
2608 /* Some precondition checks. */
2609 xassert (w
!= NULL
&& it
!= NULL
);
2610 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2613 /* If face attributes have been changed since the last redisplay,
2614 free realized faces now because they depend on face definitions
2615 that might have changed. Don't free faces while there might be
2616 desired matrices pending which reference these faces. */
2617 if (face_change_count
&& !inhibit_free_realized_faces
)
2619 face_change_count
= 0;
2620 free_all_realized_faces (Qnil
);
2623 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2624 if (! NILP (Vface_remapping_alist
))
2625 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2627 /* Use one of the mode line rows of W's desired matrix if
2631 if (base_face_id
== MODE_LINE_FACE_ID
2632 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2633 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2634 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2635 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2639 bzero (it
, sizeof *it
);
2640 it
->current
.overlay_string_index
= -1;
2641 it
->current
.dpvec_index
= -1;
2642 it
->base_face_id
= remapped_base_face_id
;
2644 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2646 /* The window in which we iterate over current_buffer: */
2647 XSETWINDOW (it
->window
, w
);
2649 it
->f
= XFRAME (w
->frame
);
2653 /* Extra space between lines (on window systems only). */
2654 if (base_face_id
== DEFAULT_FACE_ID
2655 && FRAME_WINDOW_P (it
->f
))
2657 if (NATNUMP (current_buffer
->extra_line_spacing
))
2658 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2659 else if (FLOATP (current_buffer
->extra_line_spacing
))
2660 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2661 * FRAME_LINE_HEIGHT (it
->f
));
2662 else if (it
->f
->extra_line_spacing
> 0)
2663 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2664 it
->max_extra_line_spacing
= 0;
2667 /* If realized faces have been removed, e.g. because of face
2668 attribute changes of named faces, recompute them. When running
2669 in batch mode, the face cache of the initial frame is null. If
2670 we happen to get called, make a dummy face cache. */
2671 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2672 init_frame_faces (it
->f
);
2673 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2674 recompute_basic_faces (it
->f
);
2676 /* Current value of the `slice', `space-width', and 'height' properties. */
2677 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2678 it
->space_width
= Qnil
;
2679 it
->font_height
= Qnil
;
2680 it
->override_ascent
= -1;
2682 /* Are control characters displayed as `^C'? */
2683 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2685 /* -1 means everything between a CR and the following line end
2686 is invisible. >0 means lines indented more than this value are
2688 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2689 ? XFASTINT (current_buffer
->selective_display
)
2690 : (!NILP (current_buffer
->selective_display
)
2692 it
->selective_display_ellipsis_p
2693 = !NILP (current_buffer
->selective_display_ellipses
);
2695 /* Display table to use. */
2696 it
->dp
= window_display_table (w
);
2698 /* Are multibyte characters enabled in current_buffer? */
2699 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2701 /* Do we need to reorder bidirectional text? */
2702 it
->bidi_p
= !NILP (current_buffer
->bidi_display_reordering
);
2704 /* Non-zero if we should highlight the region. */
2706 = (!NILP (Vtransient_mark_mode
)
2707 && !NILP (current_buffer
->mark_active
)
2708 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2710 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2711 start and end of a visible region in window IT->w. Set both to
2712 -1 to indicate no region. */
2713 if (highlight_region_p
2714 /* Maybe highlight only in selected window. */
2715 && (/* Either show region everywhere. */
2716 highlight_nonselected_windows
2717 /* Or show region in the selected window. */
2718 || w
== XWINDOW (selected_window
)
2719 /* Or show the region if we are in the mini-buffer and W is
2720 the window the mini-buffer refers to. */
2721 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2722 && WINDOWP (minibuf_selected_window
)
2723 && w
== XWINDOW (minibuf_selected_window
))))
2725 int charpos
= marker_position (current_buffer
->mark
);
2726 it
->region_beg_charpos
= min (PT
, charpos
);
2727 it
->region_end_charpos
= max (PT
, charpos
);
2730 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2732 /* Get the position at which the redisplay_end_trigger hook should
2733 be run, if it is to be run at all. */
2734 if (MARKERP (w
->redisplay_end_trigger
)
2735 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2736 it
->redisplay_end_trigger_charpos
2737 = marker_position (w
->redisplay_end_trigger
);
2738 else if (INTEGERP (w
->redisplay_end_trigger
))
2739 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2741 /* Correct bogus values of tab_width. */
2742 it
->tab_width
= XINT (current_buffer
->tab_width
);
2743 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2746 /* Are lines in the display truncated? */
2747 if (base_face_id
!= DEFAULT_FACE_ID
2748 || XINT (it
->w
->hscroll
)
2749 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2750 && ((!NILP (Vtruncate_partial_width_windows
)
2751 && !INTEGERP (Vtruncate_partial_width_windows
))
2752 || (INTEGERP (Vtruncate_partial_width_windows
)
2753 && (WINDOW_TOTAL_COLS (it
->w
)
2754 < XINT (Vtruncate_partial_width_windows
))))))
2755 it
->line_wrap
= TRUNCATE
;
2756 else if (NILP (current_buffer
->truncate_lines
))
2757 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2758 ? WINDOW_WRAP
: WORD_WRAP
;
2760 it
->line_wrap
= TRUNCATE
;
2762 /* Get dimensions of truncation and continuation glyphs. These are
2763 displayed as fringe bitmaps under X, so we don't need them for such
2765 if (!FRAME_WINDOW_P (it
->f
))
2767 if (it
->line_wrap
== TRUNCATE
)
2769 /* We will need the truncation glyph. */
2770 xassert (it
->glyph_row
== NULL
);
2771 produce_special_glyphs (it
, IT_TRUNCATION
);
2772 it
->truncation_pixel_width
= it
->pixel_width
;
2776 /* We will need the continuation glyph. */
2777 xassert (it
->glyph_row
== NULL
);
2778 produce_special_glyphs (it
, IT_CONTINUATION
);
2779 it
->continuation_pixel_width
= it
->pixel_width
;
2782 /* Reset these values to zero because the produce_special_glyphs
2783 above has changed them. */
2784 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2785 it
->phys_ascent
= it
->phys_descent
= 0;
2788 /* Set this after getting the dimensions of truncation and
2789 continuation glyphs, so that we don't produce glyphs when calling
2790 produce_special_glyphs, above. */
2791 it
->glyph_row
= row
;
2792 it
->area
= TEXT_AREA
;
2794 /* Forget any previous info about this row being reversed. */
2796 it
->glyph_row
->reversed_p
= 0;
2798 /* Get the dimensions of the display area. The display area
2799 consists of the visible window area plus a horizontally scrolled
2800 part to the left of the window. All x-values are relative to the
2801 start of this total display area. */
2802 if (base_face_id
!= DEFAULT_FACE_ID
)
2804 /* Mode lines, menu bar in terminal frames. */
2805 it
->first_visible_x
= 0;
2806 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2811 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2812 it
->last_visible_x
= (it
->first_visible_x
2813 + window_box_width (w
, TEXT_AREA
));
2815 /* If we truncate lines, leave room for the truncator glyph(s) at
2816 the right margin. Otherwise, leave room for the continuation
2817 glyph(s). Truncation and continuation glyphs are not inserted
2818 for window-based redisplay. */
2819 if (!FRAME_WINDOW_P (it
->f
))
2821 if (it
->line_wrap
== TRUNCATE
)
2822 it
->last_visible_x
-= it
->truncation_pixel_width
;
2824 it
->last_visible_x
-= it
->continuation_pixel_width
;
2827 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2828 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2831 /* Leave room for a border glyph. */
2832 if (!FRAME_WINDOW_P (it
->f
)
2833 && !WINDOW_RIGHTMOST_P (it
->w
))
2834 it
->last_visible_x
-= 1;
2836 it
->last_visible_y
= window_text_bottom_y (w
);
2838 /* For mode lines and alike, arrange for the first glyph having a
2839 left box line if the face specifies a box. */
2840 if (base_face_id
!= DEFAULT_FACE_ID
)
2844 it
->face_id
= remapped_base_face_id
;
2846 /* If we have a boxed mode line, make the first character appear
2847 with a left box line. */
2848 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2849 if (face
->box
!= FACE_NO_BOX
)
2850 it
->start_of_box_run_p
= 1;
2853 /* If we are to reorder bidirectional text, init the bidi
2857 /* Note the paragraph direction that this buffer wants to
2859 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2860 it
->paragraph_embedding
= L2R
;
2861 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2862 it
->paragraph_embedding
= R2L
;
2864 it
->paragraph_embedding
= NEUTRAL_DIR
;
2865 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2868 /* If a buffer position was specified, set the iterator there,
2869 getting overlays and face properties from that position. */
2870 if (charpos
>= BUF_BEG (current_buffer
))
2872 it
->end_charpos
= ZV
;
2874 IT_CHARPOS (*it
) = charpos
;
2876 /* Compute byte position if not specified. */
2877 if (bytepos
< charpos
)
2878 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2880 IT_BYTEPOS (*it
) = bytepos
;
2882 it
->start
= it
->current
;
2884 /* Compute faces etc. */
2885 reseat (it
, it
->current
.pos
, 1);
2892 /* Initialize IT for the display of window W with window start POS. */
2895 start_display (it
, w
, pos
)
2898 struct text_pos pos
;
2900 struct glyph_row
*row
;
2901 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2903 row
= w
->desired_matrix
->rows
+ first_vpos
;
2904 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2905 it
->first_vpos
= first_vpos
;
2907 /* Don't reseat to previous visible line start if current start
2908 position is in a string or image. */
2909 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2911 int start_at_line_beg_p
;
2912 int first_y
= it
->current_y
;
2914 /* If window start is not at a line start, skip forward to POS to
2915 get the correct continuation lines width. */
2916 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2917 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2918 if (!start_at_line_beg_p
)
2922 reseat_at_previous_visible_line_start (it
);
2923 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2925 new_x
= it
->current_x
+ it
->pixel_width
;
2927 /* If lines are continued, this line may end in the middle
2928 of a multi-glyph character (e.g. a control character
2929 displayed as \003, or in the middle of an overlay
2930 string). In this case move_it_to above will not have
2931 taken us to the start of the continuation line but to the
2932 end of the continued line. */
2933 if (it
->current_x
> 0
2934 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2935 && (/* And glyph doesn't fit on the line. */
2936 new_x
> it
->last_visible_x
2937 /* Or it fits exactly and we're on a window
2939 || (new_x
== it
->last_visible_x
2940 && FRAME_WINDOW_P (it
->f
))))
2942 if (it
->current
.dpvec_index
>= 0
2943 || it
->current
.overlay_string_index
>= 0)
2945 set_iterator_to_next (it
, 1);
2946 move_it_in_display_line_to (it
, -1, -1, 0);
2949 it
->continuation_lines_width
+= it
->current_x
;
2952 /* We're starting a new display line, not affected by the
2953 height of the continued line, so clear the appropriate
2954 fields in the iterator structure. */
2955 it
->max_ascent
= it
->max_descent
= 0;
2956 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2958 it
->current_y
= first_y
;
2960 it
->current_x
= it
->hpos
= 0;
2966 /* Return 1 if POS is a position in ellipses displayed for invisible
2967 text. W is the window we display, for text property lookup. */
2970 in_ellipses_for_invisible_text_p (pos
, w
)
2971 struct display_pos
*pos
;
2974 Lisp_Object prop
, window
;
2976 int charpos
= CHARPOS (pos
->pos
);
2978 /* If POS specifies a position in a display vector, this might
2979 be for an ellipsis displayed for invisible text. We won't
2980 get the iterator set up for delivering that ellipsis unless
2981 we make sure that it gets aware of the invisible text. */
2982 if (pos
->dpvec_index
>= 0
2983 && pos
->overlay_string_index
< 0
2984 && CHARPOS (pos
->string_pos
) < 0
2986 && (XSETWINDOW (window
, w
),
2987 prop
= Fget_char_property (make_number (charpos
),
2988 Qinvisible
, window
),
2989 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2991 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2993 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3000 /* Initialize IT for stepping through current_buffer in window W,
3001 starting at position POS that includes overlay string and display
3002 vector/ control character translation position information. Value
3003 is zero if there are overlay strings with newlines at POS. */
3006 init_from_display_pos (it
, w
, pos
)
3009 struct display_pos
*pos
;
3011 int charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3012 int i
, overlay_strings_with_newlines
= 0;
3014 /* If POS specifies a position in a display vector, this might
3015 be for an ellipsis displayed for invisible text. We won't
3016 get the iterator set up for delivering that ellipsis unless
3017 we make sure that it gets aware of the invisible text. */
3018 if (in_ellipses_for_invisible_text_p (pos
, w
))
3024 /* Keep in mind: the call to reseat in init_iterator skips invisible
3025 text, so we might end up at a position different from POS. This
3026 is only a problem when POS is a row start after a newline and an
3027 overlay starts there with an after-string, and the overlay has an
3028 invisible property. Since we don't skip invisible text in
3029 display_line and elsewhere immediately after consuming the
3030 newline before the row start, such a POS will not be in a string,
3031 but the call to init_iterator below will move us to the
3033 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3035 /* This only scans the current chunk -- it should scan all chunks.
3036 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3037 to 16 in 22.1 to make this a lesser problem. */
3038 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3040 const char *s
= SDATA (it
->overlay_strings
[i
]);
3041 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3043 while (s
< e
&& *s
!= '\n')
3048 overlay_strings_with_newlines
= 1;
3053 /* If position is within an overlay string, set up IT to the right
3055 if (pos
->overlay_string_index
>= 0)
3059 /* If the first overlay string happens to have a `display'
3060 property for an image, the iterator will be set up for that
3061 image, and we have to undo that setup first before we can
3062 correct the overlay string index. */
3063 if (it
->method
== GET_FROM_IMAGE
)
3066 /* We already have the first chunk of overlay strings in
3067 IT->overlay_strings. Load more until the one for
3068 pos->overlay_string_index is in IT->overlay_strings. */
3069 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3071 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3072 it
->current
.overlay_string_index
= 0;
3075 load_overlay_strings (it
, 0);
3076 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3080 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3081 relative_index
= (it
->current
.overlay_string_index
3082 % OVERLAY_STRING_CHUNK_SIZE
);
3083 it
->string
= it
->overlay_strings
[relative_index
];
3084 xassert (STRINGP (it
->string
));
3085 it
->current
.string_pos
= pos
->string_pos
;
3086 it
->method
= GET_FROM_STRING
;
3089 if (CHARPOS (pos
->string_pos
) >= 0)
3091 /* Recorded position is not in an overlay string, but in another
3092 string. This can only be a string from a `display' property.
3093 IT should already be filled with that string. */
3094 it
->current
.string_pos
= pos
->string_pos
;
3095 xassert (STRINGP (it
->string
));
3098 /* Restore position in display vector translations, control
3099 character translations or ellipses. */
3100 if (pos
->dpvec_index
>= 0)
3102 if (it
->dpvec
== NULL
)
3103 get_next_display_element (it
);
3104 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3105 it
->current
.dpvec_index
= pos
->dpvec_index
;
3109 return !overlay_strings_with_newlines
;
3113 /* Initialize IT for stepping through current_buffer in window W
3114 starting at ROW->start. */
3117 init_to_row_start (it
, w
, row
)
3120 struct glyph_row
*row
;
3122 init_from_display_pos (it
, w
, &row
->start
);
3123 it
->start
= row
->start
;
3124 it
->continuation_lines_width
= row
->continuation_lines_width
;
3129 /* Initialize IT for stepping through current_buffer in window W
3130 starting in the line following ROW, i.e. starting at ROW->end.
3131 Value is zero if there are overlay strings with newlines at ROW's
3135 init_to_row_end (it
, w
, row
)
3138 struct glyph_row
*row
;
3142 if (init_from_display_pos (it
, w
, &row
->end
))
3144 if (row
->continued_p
)
3145 it
->continuation_lines_width
3146 = row
->continuation_lines_width
+ row
->pixel_width
;
3157 /***********************************************************************
3159 ***********************************************************************/
3161 /* Called when IT reaches IT->stop_charpos. Handle text property and
3162 overlay changes. Set IT->stop_charpos to the next position where
3169 enum prop_handled handled
;
3170 int handle_overlay_change_p
;
3174 it
->current
.dpvec_index
= -1;
3175 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3176 it
->ignore_overlay_strings_at_pos_p
= 0;
3179 /* Use face of preceding text for ellipsis (if invisible) */
3180 if (it
->selective_display_ellipsis_p
)
3181 it
->saved_face_id
= it
->face_id
;
3185 handled
= HANDLED_NORMALLY
;
3187 /* Call text property handlers. */
3188 for (p
= it_props
; p
->handler
; ++p
)
3190 handled
= p
->handler (it
);
3192 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3194 else if (handled
== HANDLED_RETURN
)
3196 /* We still want to show before and after strings from
3197 overlays even if the actual buffer text is replaced. */
3198 if (!handle_overlay_change_p
3200 || !get_overlay_strings_1 (it
, 0, 0))
3203 setup_for_ellipsis (it
, 0);
3204 /* When handling a display spec, we might load an
3205 empty string. In that case, discard it here. We
3206 used to discard it in handle_single_display_spec,
3207 but that causes get_overlay_strings_1, above, to
3208 ignore overlay strings that we must check. */
3209 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3213 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3217 it
->ignore_overlay_strings_at_pos_p
= 1;
3218 it
->string_from_display_prop_p
= 0;
3219 handle_overlay_change_p
= 0;
3221 handled
= HANDLED_RECOMPUTE_PROPS
;
3224 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3225 handle_overlay_change_p
= 0;
3228 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3230 /* Don't check for overlay strings below when set to deliver
3231 characters from a display vector. */
3232 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3233 handle_overlay_change_p
= 0;
3235 /* Handle overlay changes.
3236 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3237 if it finds overlays. */
3238 if (handle_overlay_change_p
)
3239 handled
= handle_overlay_change (it
);
3244 setup_for_ellipsis (it
, 0);
3248 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3250 /* Determine where to stop next. */
3251 if (handled
== HANDLED_NORMALLY
)
3252 compute_stop_pos (it
);
3256 /* Compute IT->stop_charpos from text property and overlay change
3257 information for IT's current position. */
3260 compute_stop_pos (it
)
3263 register INTERVAL iv
, next_iv
;
3264 Lisp_Object object
, limit
, position
;
3265 EMACS_INT charpos
, bytepos
;
3267 /* If nowhere else, stop at the end. */
3268 it
->stop_charpos
= it
->end_charpos
;
3270 if (STRINGP (it
->string
))
3272 /* Strings are usually short, so don't limit the search for
3274 object
= it
->string
;
3276 charpos
= IT_STRING_CHARPOS (*it
);
3277 bytepos
= IT_STRING_BYTEPOS (*it
);
3283 /* If next overlay change is in front of the current stop pos
3284 (which is IT->end_charpos), stop there. Note: value of
3285 next_overlay_change is point-max if no overlay change
3287 charpos
= IT_CHARPOS (*it
);
3288 bytepos
= IT_BYTEPOS (*it
);
3289 pos
= next_overlay_change (charpos
);
3290 if (pos
< it
->stop_charpos
)
3291 it
->stop_charpos
= pos
;
3293 /* If showing the region, we have to stop at the region
3294 start or end because the face might change there. */
3295 if (it
->region_beg_charpos
> 0)
3297 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3298 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3299 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3300 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3303 /* Set up variables for computing the stop position from text
3304 property changes. */
3305 XSETBUFFER (object
, current_buffer
);
3306 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3309 /* Get the interval containing IT's position. Value is a null
3310 interval if there isn't such an interval. */
3311 position
= make_number (charpos
);
3312 iv
= validate_interval_range (object
, &position
, &position
, 0);
3313 if (!NULL_INTERVAL_P (iv
))
3315 Lisp_Object values_here
[LAST_PROP_IDX
];
3318 /* Get properties here. */
3319 for (p
= it_props
; p
->handler
; ++p
)
3320 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3322 /* Look for an interval following iv that has different
3324 for (next_iv
= next_interval (iv
);
3325 (!NULL_INTERVAL_P (next_iv
)
3327 || XFASTINT (limit
) > next_iv
->position
));
3328 next_iv
= next_interval (next_iv
))
3330 for (p
= it_props
; p
->handler
; ++p
)
3332 Lisp_Object new_value
;
3334 new_value
= textget (next_iv
->plist
, *p
->name
);
3335 if (!EQ (values_here
[p
->idx
], new_value
))
3343 if (!NULL_INTERVAL_P (next_iv
))
3345 if (INTEGERP (limit
)
3346 && next_iv
->position
>= XFASTINT (limit
))
3347 /* No text property change up to limit. */
3348 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3350 /* Text properties change in next_iv. */
3351 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3355 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3356 it
->stop_charpos
, it
->string
);
3358 xassert (STRINGP (it
->string
)
3359 || (it
->stop_charpos
>= BEGV
3360 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3364 /* Return the position of the next overlay change after POS in
3365 current_buffer. Value is point-max if no overlay change
3366 follows. This is like `next-overlay-change' but doesn't use
3370 next_overlay_change (pos
)
3375 Lisp_Object
*overlays
;
3378 /* Get all overlays at the given position. */
3379 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3381 /* If any of these overlays ends before endpos,
3382 use its ending point instead. */
3383 for (i
= 0; i
< noverlays
; ++i
)
3388 oend
= OVERLAY_END (overlays
[i
]);
3389 oendpos
= OVERLAY_POSITION (oend
);
3390 endpos
= min (endpos
, oendpos
);
3398 /***********************************************************************
3400 ***********************************************************************/
3402 /* Handle changes in the `fontified' property of the current buffer by
3403 calling hook functions from Qfontification_functions to fontify
3406 static enum prop_handled
3407 handle_fontified_prop (it
)
3410 Lisp_Object prop
, pos
;
3411 enum prop_handled handled
= HANDLED_NORMALLY
;
3413 if (!NILP (Vmemory_full
))
3416 /* Get the value of the `fontified' property at IT's current buffer
3417 position. (The `fontified' property doesn't have a special
3418 meaning in strings.) If the value is nil, call functions from
3419 Qfontification_functions. */
3420 if (!STRINGP (it
->string
)
3422 && !NILP (Vfontification_functions
)
3423 && !NILP (Vrun_hooks
)
3424 && (pos
= make_number (IT_CHARPOS (*it
)),
3425 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3426 /* Ignore the special cased nil value always present at EOB since
3427 no amount of fontifying will be able to change it. */
3428 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3430 int count
= SPECPDL_INDEX ();
3433 val
= Vfontification_functions
;
3434 specbind (Qfontification_functions
, Qnil
);
3436 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3437 safe_call1 (val
, pos
);
3440 Lisp_Object globals
, fn
;
3441 struct gcpro gcpro1
, gcpro2
;
3444 GCPRO2 (val
, globals
);
3446 for (; CONSP (val
); val
= XCDR (val
))
3452 /* A value of t indicates this hook has a local
3453 binding; it means to run the global binding too.
3454 In a global value, t should not occur. If it
3455 does, we must ignore it to avoid an endless
3457 for (globals
= Fdefault_value (Qfontification_functions
);
3459 globals
= XCDR (globals
))
3461 fn
= XCAR (globals
);
3463 safe_call1 (fn
, pos
);
3467 safe_call1 (fn
, pos
);
3473 unbind_to (count
, Qnil
);
3475 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3476 something. This avoids an endless loop if they failed to
3477 fontify the text for which reason ever. */
3478 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3479 handled
= HANDLED_RECOMPUTE_PROPS
;
3487 /***********************************************************************
3489 ***********************************************************************/
3491 /* Set up iterator IT from face properties at its current position.
3492 Called from handle_stop. */
3494 static enum prop_handled
3495 handle_face_prop (it
)
3499 EMACS_INT next_stop
;
3501 if (!STRINGP (it
->string
))
3504 = face_at_buffer_position (it
->w
,
3506 it
->region_beg_charpos
,
3507 it
->region_end_charpos
,
3510 + TEXT_PROP_DISTANCE_LIMIT
),
3511 0, it
->base_face_id
);
3513 /* Is this a start of a run of characters with box face?
3514 Caveat: this can be called for a freshly initialized
3515 iterator; face_id is -1 in this case. We know that the new
3516 face will not change until limit, i.e. if the new face has a
3517 box, all characters up to limit will have one. But, as
3518 usual, we don't know whether limit is really the end. */
3519 if (new_face_id
!= it
->face_id
)
3521 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3523 /* If new face has a box but old face has not, this is
3524 the start of a run of characters with box, i.e. it has
3525 a shadow on the left side. The value of face_id of the
3526 iterator will be -1 if this is the initial call that gets
3527 the face. In this case, we have to look in front of IT's
3528 position and see whether there is a face != new_face_id. */
3529 it
->start_of_box_run_p
3530 = (new_face
->box
!= FACE_NO_BOX
3531 && (it
->face_id
>= 0
3532 || IT_CHARPOS (*it
) == BEG
3533 || new_face_id
!= face_before_it_pos (it
)));
3534 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3539 int base_face_id
, bufpos
;
3541 Lisp_Object from_overlay
3542 = (it
->current
.overlay_string_index
>= 0
3543 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3546 /* See if we got to this string directly or indirectly from
3547 an overlay property. That includes the before-string or
3548 after-string of an overlay, strings in display properties
3549 provided by an overlay, their text properties, etc.
3551 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3552 if (! NILP (from_overlay
))
3553 for (i
= it
->sp
- 1; i
>= 0; i
--)
3555 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3557 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3558 else if (! NILP (it
->stack
[i
].from_overlay
))
3559 from_overlay
= it
->stack
[i
].from_overlay
;
3561 if (!NILP (from_overlay
))
3565 if (! NILP (from_overlay
))
3567 bufpos
= IT_CHARPOS (*it
);
3568 /* For a string from an overlay, the base face depends
3569 only on text properties and ignores overlays. */
3571 = face_for_overlay_string (it
->w
,
3573 it
->region_beg_charpos
,
3574 it
->region_end_charpos
,
3577 + TEXT_PROP_DISTANCE_LIMIT
),
3585 /* For strings from a `display' property, use the face at
3586 IT's current buffer position as the base face to merge
3587 with, so that overlay strings appear in the same face as
3588 surrounding text, unless they specify their own
3590 base_face_id
= underlying_face_id (it
);
3593 new_face_id
= face_at_string_position (it
->w
,
3595 IT_STRING_CHARPOS (*it
),
3597 it
->region_beg_charpos
,
3598 it
->region_end_charpos
,
3602 /* Is this a start of a run of characters with box? Caveat:
3603 this can be called for a freshly allocated iterator; face_id
3604 is -1 is this case. We know that the new face will not
3605 change until the next check pos, i.e. if the new face has a
3606 box, all characters up to that position will have a
3607 box. But, as usual, we don't know whether that position
3608 is really the end. */
3609 if (new_face_id
!= it
->face_id
)
3611 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3612 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3614 /* If new face has a box but old face hasn't, this is the
3615 start of a run of characters with box, i.e. it has a
3616 shadow on the left side. */
3617 it
->start_of_box_run_p
3618 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3619 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3623 it
->face_id
= new_face_id
;
3624 return HANDLED_NORMALLY
;
3628 /* Return the ID of the face ``underlying'' IT's current position,
3629 which is in a string. If the iterator is associated with a
3630 buffer, return the face at IT's current buffer position.
3631 Otherwise, use the iterator's base_face_id. */
3634 underlying_face_id (it
)
3637 int face_id
= it
->base_face_id
, i
;
3639 xassert (STRINGP (it
->string
));
3641 for (i
= it
->sp
- 1; i
>= 0; --i
)
3642 if (NILP (it
->stack
[i
].string
))
3643 face_id
= it
->stack
[i
].face_id
;
3649 /* Compute the face one character before or after the current position
3650 of IT. BEFORE_P non-zero means get the face in front of IT's
3651 position. Value is the id of the face. */
3654 face_before_or_after_it_pos (it
, before_p
)
3659 EMACS_INT next_check_charpos
;
3660 struct text_pos pos
;
3662 xassert (it
->s
== NULL
);
3664 if (STRINGP (it
->string
))
3666 int bufpos
, base_face_id
;
3668 /* No face change past the end of the string (for the case
3669 we are padding with spaces). No face change before the
3671 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3672 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3675 /* Set pos to the position before or after IT's current position. */
3677 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3679 /* For composition, we must check the character after the
3681 pos
= (it
->what
== IT_COMPOSITION
3682 ? string_pos (IT_STRING_CHARPOS (*it
)
3683 + it
->cmp_it
.nchars
, it
->string
)
3684 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3686 if (it
->current
.overlay_string_index
>= 0)
3687 bufpos
= IT_CHARPOS (*it
);
3691 base_face_id
= underlying_face_id (it
);
3693 /* Get the face for ASCII, or unibyte. */
3694 face_id
= face_at_string_position (it
->w
,
3698 it
->region_beg_charpos
,
3699 it
->region_end_charpos
,
3700 &next_check_charpos
,
3703 /* Correct the face for charsets different from ASCII. Do it
3704 for the multibyte case only. The face returned above is
3705 suitable for unibyte text if IT->string is unibyte. */
3706 if (STRING_MULTIBYTE (it
->string
))
3708 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3709 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3711 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3713 c
= string_char_and_length (p
, &len
);
3714 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3719 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3720 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3723 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3724 pos
= it
->current
.pos
;
3727 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3730 if (it
->what
== IT_COMPOSITION
)
3731 /* For composition, we must check the position after the
3733 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3735 INC_TEXT_POS (pos
, it
->multibyte_p
);
3738 /* Determine face for CHARSET_ASCII, or unibyte. */
3739 face_id
= face_at_buffer_position (it
->w
,
3741 it
->region_beg_charpos
,
3742 it
->region_end_charpos
,
3743 &next_check_charpos
,
3746 /* Correct the face for charsets different from ASCII. Do it
3747 for the multibyte case only. The face returned above is
3748 suitable for unibyte text if current_buffer is unibyte. */
3749 if (it
->multibyte_p
)
3751 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3752 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3753 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3762 /***********************************************************************
3764 ***********************************************************************/
3766 /* Set up iterator IT from invisible properties at its current
3767 position. Called from handle_stop. */
3769 static enum prop_handled
3770 handle_invisible_prop (it
)
3773 enum prop_handled handled
= HANDLED_NORMALLY
;
3775 if (STRINGP (it
->string
))
3777 extern Lisp_Object Qinvisible
;
3778 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3780 /* Get the value of the invisible text property at the
3781 current position. Value will be nil if there is no such
3783 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3784 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3787 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3789 handled
= HANDLED_RECOMPUTE_PROPS
;
3791 /* Get the position at which the next change of the
3792 invisible text property can be found in IT->string.
3793 Value will be nil if the property value is the same for
3794 all the rest of IT->string. */
3795 XSETINT (limit
, SCHARS (it
->string
));
3796 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3799 /* Text at current position is invisible. The next
3800 change in the property is at position end_charpos.
3801 Move IT's current position to that position. */
3802 if (INTEGERP (end_charpos
)
3803 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3805 struct text_pos old
;
3806 old
= it
->current
.string_pos
;
3807 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3808 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3812 /* The rest of the string is invisible. If this is an
3813 overlay string, proceed with the next overlay string
3814 or whatever comes and return a character from there. */
3815 if (it
->current
.overlay_string_index
>= 0)
3817 next_overlay_string (it
);
3818 /* Don't check for overlay strings when we just
3819 finished processing them. */
3820 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3824 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3825 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3833 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3834 Lisp_Object pos
, prop
, overlay
;
3836 /* First of all, is there invisible text at this position? */
3837 tem
= start_charpos
= IT_CHARPOS (*it
);
3838 pos
= make_number (tem
);
3839 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3841 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3843 /* If we are on invisible text, skip over it. */
3844 if (invis_p
&& start_charpos
< it
->end_charpos
)
3846 /* Record whether we have to display an ellipsis for the
3848 int display_ellipsis_p
= invis_p
== 2;
3850 handled
= HANDLED_RECOMPUTE_PROPS
;
3852 /* Loop skipping over invisible text. The loop is left at
3853 ZV or with IT on the first char being visible again. */
3856 /* Try to skip some invisible text. Return value is the
3857 position reached which can be equal to where we start
3858 if there is nothing invisible there. This skips both
3859 over invisible text properties and overlays with
3860 invisible property. */
3861 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3863 /* If we skipped nothing at all we weren't at invisible
3864 text in the first place. If everything to the end of
3865 the buffer was skipped, end the loop. */
3866 if (newpos
== tem
|| newpos
>= ZV
)
3870 /* We skipped some characters but not necessarily
3871 all there are. Check if we ended up on visible
3872 text. Fget_char_property returns the property of
3873 the char before the given position, i.e. if we
3874 get invis_p = 0, this means that the char at
3875 newpos is visible. */
3876 pos
= make_number (newpos
);
3877 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3878 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3881 /* If we ended up on invisible text, proceed to
3882 skip starting with next_stop. */
3886 /* If there are adjacent invisible texts, don't lose the
3887 second one's ellipsis. */
3889 display_ellipsis_p
= 1;
3893 /* The position newpos is now either ZV or on visible text. */
3894 if (it
->bidi_p
&& newpos
< ZV
)
3896 /* With bidi iteration, the region of invisible text
3897 could start and/or end in the middle of a non-base
3898 embedding level. Therefore, we need to skip
3899 invisible text using the bidi iterator, starting at
3900 IT's current position, until we find ourselves
3901 outside the invisible text. Skipping invisible text
3902 _after_ bidi iteration avoids affecting the visual
3903 order of the displayed text when invisible properties
3904 are added or removed. */
3905 if (it
->bidi_it
.first_elt
)
3907 /* If we were `reseat'ed to a new paragraph,
3908 determine the paragraph base direction. We need
3909 to do it now because next_element_from_buffer may
3910 not have a chance to do it, if we are going to
3911 skip any text at the beginning, which resets the
3913 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
3917 bidi_get_next_char_visually (&it
->bidi_it
);
3919 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3920 && it
->bidi_it
.charpos
< newpos
);
3921 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3922 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3923 /* If we overstepped NEWPOS, record its position in the
3924 iterator, so that we skip invisible text if later the
3925 bidi iteration lands us in the invisible region
3927 if (IT_CHARPOS (*it
) >= newpos
)
3928 it
->prev_stop
= newpos
;
3932 IT_CHARPOS (*it
) = newpos
;
3933 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3936 /* If there are before-strings at the start of invisible
3937 text, and the text is invisible because of a text
3938 property, arrange to show before-strings because 20.x did
3939 it that way. (If the text is invisible because of an
3940 overlay property instead of a text property, this is
3941 already handled in the overlay code.) */
3943 && get_overlay_strings (it
, it
->stop_charpos
))
3945 handled
= HANDLED_RECOMPUTE_PROPS
;
3946 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3948 else if (display_ellipsis_p
)
3950 /* Make sure that the glyphs of the ellipsis will get
3951 correct `charpos' values. If we would not update
3952 it->position here, the glyphs would belong to the
3953 last visible character _before_ the invisible
3954 text, which confuses `set_cursor_from_row'.
3956 We use the last invisible position instead of the
3957 first because this way the cursor is always drawn on
3958 the first "." of the ellipsis, whenever PT is inside
3959 the invisible text. Otherwise the cursor would be
3960 placed _after_ the ellipsis when the point is after the
3961 first invisible character. */
3962 if (!STRINGP (it
->object
))
3964 it
->position
.charpos
= newpos
- 1;
3965 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3968 /* Let the ellipsis display before
3969 considering any properties of the following char.
3970 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3971 handled
= HANDLED_RETURN
;
3980 /* Make iterator IT return `...' next.
3981 Replaces LEN characters from buffer. */
3984 setup_for_ellipsis (it
, len
)
3988 /* Use the display table definition for `...'. Invalid glyphs
3989 will be handled by the method returning elements from dpvec. */
3990 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3992 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3993 it
->dpvec
= v
->contents
;
3994 it
->dpend
= v
->contents
+ v
->size
;
3998 /* Default `...'. */
3999 it
->dpvec
= default_invis_vector
;
4000 it
->dpend
= default_invis_vector
+ 3;
4003 it
->dpvec_char_len
= len
;
4004 it
->current
.dpvec_index
= 0;
4005 it
->dpvec_face_id
= -1;
4007 /* Remember the current face id in case glyphs specify faces.
4008 IT's face is restored in set_iterator_to_next.
4009 saved_face_id was set to preceding char's face in handle_stop. */
4010 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4011 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4013 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4019 /***********************************************************************
4021 ***********************************************************************/
4023 /* Set up iterator IT from `display' property at its current position.
4024 Called from handle_stop.
4025 We return HANDLED_RETURN if some part of the display property
4026 overrides the display of the buffer text itself.
4027 Otherwise we return HANDLED_NORMALLY. */
4029 static enum prop_handled
4030 handle_display_prop (it
)
4033 Lisp_Object prop
, object
, overlay
;
4034 struct text_pos
*position
;
4035 /* Nonzero if some property replaces the display of the text itself. */
4036 int display_replaced_p
= 0;
4038 if (STRINGP (it
->string
))
4040 object
= it
->string
;
4041 position
= &it
->current
.string_pos
;
4045 XSETWINDOW (object
, it
->w
);
4046 position
= &it
->current
.pos
;
4049 /* Reset those iterator values set from display property values. */
4050 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4051 it
->space_width
= Qnil
;
4052 it
->font_height
= Qnil
;
4055 /* We don't support recursive `display' properties, i.e. string
4056 values that have a string `display' property, that have a string
4057 `display' property etc. */
4058 if (!it
->string_from_display_prop_p
)
4059 it
->area
= TEXT_AREA
;
4061 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
4062 Qdisplay
, object
, &overlay
);
4064 return HANDLED_NORMALLY
;
4065 /* Now OVERLAY is the overlay that gave us this property, or nil
4066 if it was a text property. */
4068 if (!STRINGP (it
->string
))
4069 object
= it
->w
->buffer
;
4072 /* Simple properties. */
4073 && !EQ (XCAR (prop
), Qimage
)
4074 && !EQ (XCAR (prop
), Qspace
)
4075 && !EQ (XCAR (prop
), Qwhen
)
4076 && !EQ (XCAR (prop
), Qslice
)
4077 && !EQ (XCAR (prop
), Qspace_width
)
4078 && !EQ (XCAR (prop
), Qheight
)
4079 && !EQ (XCAR (prop
), Qraise
)
4080 /* Marginal area specifications. */
4081 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
4082 && !EQ (XCAR (prop
), Qleft_fringe
)
4083 && !EQ (XCAR (prop
), Qright_fringe
)
4084 && !NILP (XCAR (prop
)))
4086 for (; CONSP (prop
); prop
= XCDR (prop
))
4088 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
4089 position
, display_replaced_p
))
4091 display_replaced_p
= 1;
4092 /* If some text in a string is replaced, `position' no
4093 longer points to the position of `object'. */
4094 if (STRINGP (object
))
4099 else if (VECTORP (prop
))
4102 for (i
= 0; i
< ASIZE (prop
); ++i
)
4103 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4104 position
, display_replaced_p
))
4106 display_replaced_p
= 1;
4107 /* If some text in a string is replaced, `position' no
4108 longer points to the position of `object'. */
4109 if (STRINGP (object
))
4115 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4117 display_replaced_p
= 1;
4120 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4124 /* Value is the position of the end of the `display' property starting
4125 at START_POS in OBJECT. */
4127 static struct text_pos
4128 display_prop_end (it
, object
, start_pos
)
4131 struct text_pos start_pos
;
4134 struct text_pos end_pos
;
4136 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4137 Qdisplay
, object
, Qnil
);
4138 CHARPOS (end_pos
) = XFASTINT (end
);
4139 if (STRINGP (object
))
4140 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4142 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4148 /* Set up IT from a single `display' specification PROP. OBJECT
4149 is the object in which the `display' property was found. *POSITION
4150 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4151 means that we previously saw a display specification which already
4152 replaced text display with something else, for example an image;
4153 we ignore such properties after the first one has been processed.
4155 OVERLAY is the overlay this `display' property came from,
4156 or nil if it was a text property.
4158 If PROP is a `space' or `image' specification, and in some other
4159 cases too, set *POSITION to the position where the `display'
4162 Value is non-zero if something was found which replaces the display
4163 of buffer or string text. */
4166 handle_single_display_spec (it
, spec
, object
, overlay
, position
,
4167 display_replaced_before_p
)
4171 Lisp_Object overlay
;
4172 struct text_pos
*position
;
4173 int display_replaced_before_p
;
4176 Lisp_Object location
, value
;
4177 struct text_pos start_pos
, save_pos
;
4180 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4181 If the result is non-nil, use VALUE instead of SPEC. */
4183 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4192 if (!NILP (form
) && !EQ (form
, Qt
))
4194 int count
= SPECPDL_INDEX ();
4195 struct gcpro gcpro1
;
4197 /* Bind `object' to the object having the `display' property, a
4198 buffer or string. Bind `position' to the position in the
4199 object where the property was found, and `buffer-position'
4200 to the current position in the buffer. */
4201 specbind (Qobject
, object
);
4202 specbind (Qposition
, make_number (CHARPOS (*position
)));
4203 specbind (Qbuffer_position
,
4204 make_number (STRINGP (object
)
4205 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4207 form
= safe_eval (form
);
4209 unbind_to (count
, Qnil
);
4215 /* Handle `(height HEIGHT)' specifications. */
4217 && EQ (XCAR (spec
), Qheight
)
4218 && CONSP (XCDR (spec
)))
4220 if (!FRAME_WINDOW_P (it
->f
))
4223 it
->font_height
= XCAR (XCDR (spec
));
4224 if (!NILP (it
->font_height
))
4226 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4227 int new_height
= -1;
4229 if (CONSP (it
->font_height
)
4230 && (EQ (XCAR (it
->font_height
), Qplus
)
4231 || EQ (XCAR (it
->font_height
), Qminus
))
4232 && CONSP (XCDR (it
->font_height
))
4233 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4235 /* `(+ N)' or `(- N)' where N is an integer. */
4236 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4237 if (EQ (XCAR (it
->font_height
), Qplus
))
4239 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4241 else if (FUNCTIONP (it
->font_height
))
4243 /* Call function with current height as argument.
4244 Value is the new height. */
4246 height
= safe_call1 (it
->font_height
,
4247 face
->lface
[LFACE_HEIGHT_INDEX
]);
4248 if (NUMBERP (height
))
4249 new_height
= XFLOATINT (height
);
4251 else if (NUMBERP (it
->font_height
))
4253 /* Value is a multiple of the canonical char height. */
4256 face
= FACE_FROM_ID (it
->f
,
4257 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4258 new_height
= (XFLOATINT (it
->font_height
)
4259 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4263 /* Evaluate IT->font_height with `height' bound to the
4264 current specified height to get the new height. */
4265 int count
= SPECPDL_INDEX ();
4267 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4268 value
= safe_eval (it
->font_height
);
4269 unbind_to (count
, Qnil
);
4271 if (NUMBERP (value
))
4272 new_height
= XFLOATINT (value
);
4276 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4282 /* Handle `(space-width WIDTH)'. */
4284 && EQ (XCAR (spec
), Qspace_width
)
4285 && CONSP (XCDR (spec
)))
4287 if (!FRAME_WINDOW_P (it
->f
))
4290 value
= XCAR (XCDR (spec
));
4291 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4292 it
->space_width
= value
;
4297 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4299 && EQ (XCAR (spec
), Qslice
))
4303 if (!FRAME_WINDOW_P (it
->f
))
4306 if (tem
= XCDR (spec
), CONSP (tem
))
4308 it
->slice
.x
= XCAR (tem
);
4309 if (tem
= XCDR (tem
), CONSP (tem
))
4311 it
->slice
.y
= XCAR (tem
);
4312 if (tem
= XCDR (tem
), CONSP (tem
))
4314 it
->slice
.width
= XCAR (tem
);
4315 if (tem
= XCDR (tem
), CONSP (tem
))
4316 it
->slice
.height
= XCAR (tem
);
4324 /* Handle `(raise FACTOR)'. */
4326 && EQ (XCAR (spec
), Qraise
)
4327 && CONSP (XCDR (spec
)))
4329 if (!FRAME_WINDOW_P (it
->f
))
4332 #ifdef HAVE_WINDOW_SYSTEM
4333 value
= XCAR (XCDR (spec
));
4334 if (NUMBERP (value
))
4336 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4337 it
->voffset
= - (XFLOATINT (value
)
4338 * (FONT_HEIGHT (face
->font
)));
4340 #endif /* HAVE_WINDOW_SYSTEM */
4345 /* Don't handle the other kinds of display specifications
4346 inside a string that we got from a `display' property. */
4347 if (it
->string_from_display_prop_p
)
4350 /* Characters having this form of property are not displayed, so
4351 we have to find the end of the property. */
4352 start_pos
= *position
;
4353 *position
= display_prop_end (it
, object
, start_pos
);
4356 /* Stop the scan at that end position--we assume that all
4357 text properties change there. */
4358 it
->stop_charpos
= position
->charpos
;
4360 /* Handle `(left-fringe BITMAP [FACE])'
4361 and `(right-fringe BITMAP [FACE])'. */
4363 && (EQ (XCAR (spec
), Qleft_fringe
)
4364 || EQ (XCAR (spec
), Qright_fringe
))
4365 && CONSP (XCDR (spec
)))
4367 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4370 if (!FRAME_WINDOW_P (it
->f
))
4371 /* If we return here, POSITION has been advanced
4372 across the text with this property. */
4375 #ifdef HAVE_WINDOW_SYSTEM
4376 value
= XCAR (XCDR (spec
));
4377 if (!SYMBOLP (value
)
4378 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4379 /* If we return here, POSITION has been advanced
4380 across the text with this property. */
4383 if (CONSP (XCDR (XCDR (spec
))))
4385 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4386 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4392 /* Save current settings of IT so that we can restore them
4393 when we are finished with the glyph property value. */
4395 save_pos
= it
->position
;
4396 it
->position
= *position
;
4398 it
->position
= save_pos
;
4400 it
->area
= TEXT_AREA
;
4401 it
->what
= IT_IMAGE
;
4402 it
->image_id
= -1; /* no image */
4403 it
->position
= start_pos
;
4404 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4405 it
->method
= GET_FROM_IMAGE
;
4406 it
->from_overlay
= Qnil
;
4407 it
->face_id
= face_id
;
4409 /* Say that we haven't consumed the characters with
4410 `display' property yet. The call to pop_it in
4411 set_iterator_to_next will clean this up. */
4412 *position
= start_pos
;
4414 if (EQ (XCAR (spec
), Qleft_fringe
))
4416 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4417 it
->left_user_fringe_face_id
= face_id
;
4421 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4422 it
->right_user_fringe_face_id
= face_id
;
4424 #endif /* HAVE_WINDOW_SYSTEM */
4428 /* Prepare to handle `((margin left-margin) ...)',
4429 `((margin right-margin) ...)' and `((margin nil) ...)'
4430 prefixes for display specifications. */
4431 location
= Qunbound
;
4432 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4436 value
= XCDR (spec
);
4438 value
= XCAR (value
);
4441 if (EQ (XCAR (tem
), Qmargin
)
4442 && (tem
= XCDR (tem
),
4443 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4445 || EQ (tem
, Qleft_margin
)
4446 || EQ (tem
, Qright_margin
))))
4450 if (EQ (location
, Qunbound
))
4456 /* After this point, VALUE is the property after any
4457 margin prefix has been stripped. It must be a string,
4458 an image specification, or `(space ...)'.
4460 LOCATION specifies where to display: `left-margin',
4461 `right-margin' or nil. */
4463 valid_p
= (STRINGP (value
)
4464 #ifdef HAVE_WINDOW_SYSTEM
4465 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4466 #endif /* not HAVE_WINDOW_SYSTEM */
4467 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4469 if (valid_p
&& !display_replaced_before_p
)
4471 /* Save current settings of IT so that we can restore them
4472 when we are finished with the glyph property value. */
4473 save_pos
= it
->position
;
4474 it
->position
= *position
;
4476 it
->position
= save_pos
;
4477 it
->from_overlay
= overlay
;
4479 if (NILP (location
))
4480 it
->area
= TEXT_AREA
;
4481 else if (EQ (location
, Qleft_margin
))
4482 it
->area
= LEFT_MARGIN_AREA
;
4484 it
->area
= RIGHT_MARGIN_AREA
;
4486 if (STRINGP (value
))
4489 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4490 it
->current
.overlay_string_index
= -1;
4491 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4492 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4493 it
->method
= GET_FROM_STRING
;
4494 it
->stop_charpos
= 0;
4495 it
->string_from_display_prop_p
= 1;
4496 /* Say that we haven't consumed the characters with
4497 `display' property yet. The call to pop_it in
4498 set_iterator_to_next will clean this up. */
4499 if (BUFFERP (object
))
4500 *position
= start_pos
;
4502 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4504 it
->method
= GET_FROM_STRETCH
;
4506 *position
= it
->position
= start_pos
;
4508 #ifdef HAVE_WINDOW_SYSTEM
4511 it
->what
= IT_IMAGE
;
4512 it
->image_id
= lookup_image (it
->f
, value
);
4513 it
->position
= start_pos
;
4514 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4515 it
->method
= GET_FROM_IMAGE
;
4517 /* Say that we haven't consumed the characters with
4518 `display' property yet. The call to pop_it in
4519 set_iterator_to_next will clean this up. */
4520 *position
= start_pos
;
4522 #endif /* HAVE_WINDOW_SYSTEM */
4527 /* Invalid property or property not supported. Restore
4528 POSITION to what it was before. */
4529 *position
= start_pos
;
4534 /* Check if SPEC is a display sub-property value whose text should be
4535 treated as intangible. */
4538 single_display_spec_intangible_p (prop
)
4541 /* Skip over `when FORM'. */
4542 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4556 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4557 we don't need to treat text as intangible. */
4558 if (EQ (XCAR (prop
), Qmargin
))
4566 || EQ (XCAR (prop
), Qleft_margin
)
4567 || EQ (XCAR (prop
), Qright_margin
))
4571 return (CONSP (prop
)
4572 && (EQ (XCAR (prop
), Qimage
)
4573 || EQ (XCAR (prop
), Qspace
)));
4577 /* Check if PROP is a display property value whose text should be
4578 treated as intangible. */
4581 display_prop_intangible_p (prop
)
4585 && CONSP (XCAR (prop
))
4586 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4588 /* A list of sub-properties. */
4589 while (CONSP (prop
))
4591 if (single_display_spec_intangible_p (XCAR (prop
)))
4596 else if (VECTORP (prop
))
4598 /* A vector of sub-properties. */
4600 for (i
= 0; i
< ASIZE (prop
); ++i
)
4601 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4605 return single_display_spec_intangible_p (prop
);
4611 /* Return 1 if PROP is a display sub-property value containing STRING. */
4614 single_display_spec_string_p (prop
, string
)
4615 Lisp_Object prop
, string
;
4617 if (EQ (string
, prop
))
4620 /* Skip over `when FORM'. */
4621 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4630 /* Skip over `margin LOCATION'. */
4631 if (EQ (XCAR (prop
), Qmargin
))
4642 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4646 /* Return 1 if STRING appears in the `display' property PROP. */
4649 display_prop_string_p (prop
, string
)
4650 Lisp_Object prop
, string
;
4653 && CONSP (XCAR (prop
))
4654 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4656 /* A list of sub-properties. */
4657 while (CONSP (prop
))
4659 if (single_display_spec_string_p (XCAR (prop
), string
))
4664 else if (VECTORP (prop
))
4666 /* A vector of sub-properties. */
4668 for (i
= 0; i
< ASIZE (prop
); ++i
)
4669 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4673 return single_display_spec_string_p (prop
, string
);
4678 /* Look for STRING in overlays and text properties in W's buffer,
4679 between character positions FROM and TO (excluding TO).
4680 BACK_P non-zero means look back (in this case, TO is supposed to be
4682 Value is the first character position where STRING was found, or
4683 zero if it wasn't found before hitting TO.
4685 W's buffer must be current.
4687 This function may only use code that doesn't eval because it is
4688 called asynchronously from note_mouse_highlight. */
4691 string_buffer_position_lim (w
, string
, from
, to
, back_p
)
4697 Lisp_Object limit
, prop
, pos
;
4700 pos
= make_number (from
);
4702 if (!back_p
) /* looking forward */
4704 limit
= make_number (min (to
, ZV
));
4705 while (!found
&& !EQ (pos
, limit
))
4707 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4708 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4711 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4715 else /* looking back */
4717 limit
= make_number (max (to
, BEGV
));
4718 while (!found
&& !EQ (pos
, limit
))
4720 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4721 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4724 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4729 return found
? XINT (pos
) : 0;
4732 /* Determine which buffer position in W's buffer STRING comes from.
4733 AROUND_CHARPOS is an approximate position where it could come from.
4734 Value is the buffer position or 0 if it couldn't be determined.
4736 W's buffer must be current.
4738 This function is necessary because we don't record buffer positions
4739 in glyphs generated from strings (to keep struct glyph small).
4740 This function may only use code that doesn't eval because it is
4741 called asynchronously from note_mouse_highlight. */
4744 string_buffer_position (w
, string
, around_charpos
)
4747 EMACS_INT around_charpos
;
4749 Lisp_Object limit
, prop
, pos
;
4750 const int MAX_DISTANCE
= 1000;
4751 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4752 around_charpos
+ MAX_DISTANCE
,
4756 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4757 around_charpos
- MAX_DISTANCE
, 1);
4763 /***********************************************************************
4764 `composition' property
4765 ***********************************************************************/
4767 /* Set up iterator IT from `composition' property at its current
4768 position. Called from handle_stop. */
4770 static enum prop_handled
4771 handle_composition_prop (it
)
4774 Lisp_Object prop
, string
;
4775 EMACS_INT pos
, pos_byte
, start
, end
;
4777 if (STRINGP (it
->string
))
4781 pos
= IT_STRING_CHARPOS (*it
);
4782 pos_byte
= IT_STRING_BYTEPOS (*it
);
4783 string
= it
->string
;
4784 s
= SDATA (string
) + pos_byte
;
4785 it
->c
= STRING_CHAR (s
);
4789 pos
= IT_CHARPOS (*it
);
4790 pos_byte
= IT_BYTEPOS (*it
);
4792 it
->c
= FETCH_CHAR (pos_byte
);
4795 /* If there's a valid composition and point is not inside of the
4796 composition (in the case that the composition is from the current
4797 buffer), draw a glyph composed from the composition components. */
4798 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4799 && COMPOSITION_VALID_P (start
, end
, prop
)
4800 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4804 if (STRINGP (it
->string
))
4805 pos_byte
= string_char_to_byte (it
->string
, start
);
4807 pos_byte
= CHAR_TO_BYTE (start
);
4809 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4812 if (it
->cmp_it
.id
>= 0)
4815 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4816 it
->cmp_it
.nglyphs
= -1;
4820 return HANDLED_NORMALLY
;
4825 /***********************************************************************
4827 ***********************************************************************/
4829 /* The following structure is used to record overlay strings for
4830 later sorting in load_overlay_strings. */
4832 struct overlay_entry
4834 Lisp_Object overlay
;
4841 /* Set up iterator IT from overlay strings at its current position.
4842 Called from handle_stop. */
4844 static enum prop_handled
4845 handle_overlay_change (it
)
4848 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4849 return HANDLED_RECOMPUTE_PROPS
;
4851 return HANDLED_NORMALLY
;
4855 /* Set up the next overlay string for delivery by IT, if there is an
4856 overlay string to deliver. Called by set_iterator_to_next when the
4857 end of the current overlay string is reached. If there are more
4858 overlay strings to display, IT->string and
4859 IT->current.overlay_string_index are set appropriately here.
4860 Otherwise IT->string is set to nil. */
4863 next_overlay_string (it
)
4866 ++it
->current
.overlay_string_index
;
4867 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4869 /* No more overlay strings. Restore IT's settings to what
4870 they were before overlay strings were processed, and
4871 continue to deliver from current_buffer. */
4873 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4876 || (NILP (it
->string
)
4877 && it
->method
== GET_FROM_BUFFER
4878 && it
->stop_charpos
>= BEGV
4879 && it
->stop_charpos
<= it
->end_charpos
));
4880 it
->current
.overlay_string_index
= -1;
4881 it
->n_overlay_strings
= 0;
4883 /* If we're at the end of the buffer, record that we have
4884 processed the overlay strings there already, so that
4885 next_element_from_buffer doesn't try it again. */
4886 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4887 it
->overlay_strings_at_end_processed_p
= 1;
4891 /* There are more overlay strings to process. If
4892 IT->current.overlay_string_index has advanced to a position
4893 where we must load IT->overlay_strings with more strings, do
4895 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4897 if (it
->current
.overlay_string_index
&& i
== 0)
4898 load_overlay_strings (it
, 0);
4900 /* Initialize IT to deliver display elements from the overlay
4902 it
->string
= it
->overlay_strings
[i
];
4903 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4904 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4905 it
->method
= GET_FROM_STRING
;
4906 it
->stop_charpos
= 0;
4907 if (it
->cmp_it
.stop_pos
>= 0)
4908 it
->cmp_it
.stop_pos
= 0;
4915 /* Compare two overlay_entry structures E1 and E2. Used as a
4916 comparison function for qsort in load_overlay_strings. Overlay
4917 strings for the same position are sorted so that
4919 1. All after-strings come in front of before-strings, except
4920 when they come from the same overlay.
4922 2. Within after-strings, strings are sorted so that overlay strings
4923 from overlays with higher priorities come first.
4925 2. Within before-strings, strings are sorted so that overlay
4926 strings from overlays with higher priorities come last.
4928 Value is analogous to strcmp. */
4932 compare_overlay_entries (e1
, e2
)
4935 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4936 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4939 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4941 /* Let after-strings appear in front of before-strings if
4942 they come from different overlays. */
4943 if (EQ (entry1
->overlay
, entry2
->overlay
))
4944 result
= entry1
->after_string_p
? 1 : -1;
4946 result
= entry1
->after_string_p
? -1 : 1;
4948 else if (entry1
->after_string_p
)
4949 /* After-strings sorted in order of decreasing priority. */
4950 result
= entry2
->priority
- entry1
->priority
;
4952 /* Before-strings sorted in order of increasing priority. */
4953 result
= entry1
->priority
- entry2
->priority
;
4959 /* Load the vector IT->overlay_strings with overlay strings from IT's
4960 current buffer position, or from CHARPOS if that is > 0. Set
4961 IT->n_overlays to the total number of overlay strings found.
4963 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4964 a time. On entry into load_overlay_strings,
4965 IT->current.overlay_string_index gives the number of overlay
4966 strings that have already been loaded by previous calls to this
4969 IT->add_overlay_start contains an additional overlay start
4970 position to consider for taking overlay strings from, if non-zero.
4971 This position comes into play when the overlay has an `invisible'
4972 property, and both before and after-strings. When we've skipped to
4973 the end of the overlay, because of its `invisible' property, we
4974 nevertheless want its before-string to appear.
4975 IT->add_overlay_start will contain the overlay start position
4978 Overlay strings are sorted so that after-string strings come in
4979 front of before-string strings. Within before and after-strings,
4980 strings are sorted by overlay priority. See also function
4981 compare_overlay_entries. */
4984 load_overlay_strings (it
, charpos
)
4988 extern Lisp_Object Qwindow
, Qpriority
;
4989 Lisp_Object overlay
, window
, str
, invisible
;
4990 struct Lisp_Overlay
*ov
;
4993 int n
= 0, i
, j
, invis_p
;
4994 struct overlay_entry
*entries
4995 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4998 charpos
= IT_CHARPOS (*it
);
5000 /* Append the overlay string STRING of overlay OVERLAY to vector
5001 `entries' which has size `size' and currently contains `n'
5002 elements. AFTER_P non-zero means STRING is an after-string of
5004 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5007 Lisp_Object priority; \
5011 int new_size = 2 * size; \
5012 struct overlay_entry *old = entries; \
5014 (struct overlay_entry *) alloca (new_size \
5015 * sizeof *entries); \
5016 bcopy (old, entries, size * sizeof *entries); \
5020 entries[n].string = (STRING); \
5021 entries[n].overlay = (OVERLAY); \
5022 priority = Foverlay_get ((OVERLAY), Qpriority); \
5023 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5024 entries[n].after_string_p = (AFTER_P); \
5029 /* Process overlay before the overlay center. */
5030 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5032 XSETMISC (overlay
, ov
);
5033 xassert (OVERLAYP (overlay
));
5034 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5035 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5040 /* Skip this overlay if it doesn't start or end at IT's current
5042 if (end
!= charpos
&& start
!= charpos
)
5045 /* Skip this overlay if it doesn't apply to IT->w. */
5046 window
= Foverlay_get (overlay
, Qwindow
);
5047 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5050 /* If the text ``under'' the overlay is invisible, both before-
5051 and after-strings from this overlay are visible; start and
5052 end position are indistinguishable. */
5053 invisible
= Foverlay_get (overlay
, Qinvisible
);
5054 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5056 /* If overlay has a non-empty before-string, record it. */
5057 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5058 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5060 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5062 /* If overlay has a non-empty after-string, record it. */
5063 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5064 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5066 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5069 /* Process overlays after the overlay center. */
5070 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5072 XSETMISC (overlay
, ov
);
5073 xassert (OVERLAYP (overlay
));
5074 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5075 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5077 if (start
> charpos
)
5080 /* Skip this overlay if it doesn't start or end at IT's current
5082 if (end
!= charpos
&& start
!= charpos
)
5085 /* Skip this overlay if it doesn't apply to IT->w. */
5086 window
= Foverlay_get (overlay
, Qwindow
);
5087 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5090 /* If the text ``under'' the overlay is invisible, it has a zero
5091 dimension, and both before- and after-strings apply. */
5092 invisible
= Foverlay_get (overlay
, Qinvisible
);
5093 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5095 /* If overlay has a non-empty before-string, record it. */
5096 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5097 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5099 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5101 /* If overlay has a non-empty after-string, record it. */
5102 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5103 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5105 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5108 #undef RECORD_OVERLAY_STRING
5112 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5114 /* Record the total number of strings to process. */
5115 it
->n_overlay_strings
= n
;
5117 /* IT->current.overlay_string_index is the number of overlay strings
5118 that have already been consumed by IT. Copy some of the
5119 remaining overlay strings to IT->overlay_strings. */
5121 j
= it
->current
.overlay_string_index
;
5122 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5124 it
->overlay_strings
[i
] = entries
[j
].string
;
5125 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5132 /* Get the first chunk of overlay strings at IT's current buffer
5133 position, or at CHARPOS if that is > 0. Value is non-zero if at
5134 least one overlay string was found. */
5137 get_overlay_strings_1 (it
, charpos
, compute_stop_p
)
5142 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5143 process. This fills IT->overlay_strings with strings, and sets
5144 IT->n_overlay_strings to the total number of strings to process.
5145 IT->pos.overlay_string_index has to be set temporarily to zero
5146 because load_overlay_strings needs this; it must be set to -1
5147 when no overlay strings are found because a zero value would
5148 indicate a position in the first overlay string. */
5149 it
->current
.overlay_string_index
= 0;
5150 load_overlay_strings (it
, charpos
);
5152 /* If we found overlay strings, set up IT to deliver display
5153 elements from the first one. Otherwise set up IT to deliver
5154 from current_buffer. */
5155 if (it
->n_overlay_strings
)
5157 /* Make sure we know settings in current_buffer, so that we can
5158 restore meaningful values when we're done with the overlay
5161 compute_stop_pos (it
);
5162 xassert (it
->face_id
>= 0);
5164 /* Save IT's settings. They are restored after all overlay
5165 strings have been processed. */
5166 xassert (!compute_stop_p
|| it
->sp
== 0);
5168 /* When called from handle_stop, there might be an empty display
5169 string loaded. In that case, don't bother saving it. */
5170 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5173 /* Set up IT to deliver display elements from the first overlay
5175 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5176 it
->string
= it
->overlay_strings
[0];
5177 it
->from_overlay
= Qnil
;
5178 it
->stop_charpos
= 0;
5179 xassert (STRINGP (it
->string
));
5180 it
->end_charpos
= SCHARS (it
->string
);
5181 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5182 it
->method
= GET_FROM_STRING
;
5186 it
->current
.overlay_string_index
= -1;
5191 get_overlay_strings (it
, charpos
)
5196 it
->method
= GET_FROM_BUFFER
;
5198 (void) get_overlay_strings_1 (it
, charpos
, 1);
5202 /* Value is non-zero if we found at least one overlay string. */
5203 return STRINGP (it
->string
);
5208 /***********************************************************************
5209 Saving and restoring state
5210 ***********************************************************************/
5212 /* Save current settings of IT on IT->stack. Called, for example,
5213 before setting up IT for an overlay string, to be able to restore
5214 IT's settings to what they were after the overlay string has been
5221 struct iterator_stack_entry
*p
;
5223 xassert (it
->sp
< IT_STACK_SIZE
);
5224 p
= it
->stack
+ it
->sp
;
5226 p
->stop_charpos
= it
->stop_charpos
;
5227 p
->prev_stop
= it
->prev_stop
;
5228 p
->base_level_stop
= it
->base_level_stop
;
5229 p
->cmp_it
= it
->cmp_it
;
5230 xassert (it
->face_id
>= 0);
5231 p
->face_id
= it
->face_id
;
5232 p
->string
= it
->string
;
5233 p
->method
= it
->method
;
5234 p
->from_overlay
= it
->from_overlay
;
5237 case GET_FROM_IMAGE
:
5238 p
->u
.image
.object
= it
->object
;
5239 p
->u
.image
.image_id
= it
->image_id
;
5240 p
->u
.image
.slice
= it
->slice
;
5242 case GET_FROM_STRETCH
:
5243 p
->u
.stretch
.object
= it
->object
;
5246 p
->position
= it
->position
;
5247 p
->current
= it
->current
;
5248 p
->end_charpos
= it
->end_charpos
;
5249 p
->string_nchars
= it
->string_nchars
;
5251 p
->multibyte_p
= it
->multibyte_p
;
5252 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5253 p
->space_width
= it
->space_width
;
5254 p
->font_height
= it
->font_height
;
5255 p
->voffset
= it
->voffset
;
5256 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5257 p
->display_ellipsis_p
= 0;
5258 p
->line_wrap
= it
->line_wrap
;
5263 /* Restore IT's settings from IT->stack. Called, for example, when no
5264 more overlay strings must be processed, and we return to delivering
5265 display elements from a buffer, or when the end of a string from a
5266 `display' property is reached and we return to delivering display
5267 elements from an overlay string, or from a buffer. */
5273 struct iterator_stack_entry
*p
;
5275 xassert (it
->sp
> 0);
5277 p
= it
->stack
+ it
->sp
;
5278 it
->stop_charpos
= p
->stop_charpos
;
5279 it
->prev_stop
= p
->prev_stop
;
5280 it
->base_level_stop
= p
->base_level_stop
;
5281 it
->cmp_it
= p
->cmp_it
;
5282 it
->face_id
= p
->face_id
;
5283 it
->current
= p
->current
;
5284 it
->position
= p
->position
;
5285 it
->string
= p
->string
;
5286 it
->from_overlay
= p
->from_overlay
;
5287 if (NILP (it
->string
))
5288 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5289 it
->method
= p
->method
;
5292 case GET_FROM_IMAGE
:
5293 it
->image_id
= p
->u
.image
.image_id
;
5294 it
->object
= p
->u
.image
.object
;
5295 it
->slice
= p
->u
.image
.slice
;
5297 case GET_FROM_STRETCH
:
5298 it
->object
= p
->u
.comp
.object
;
5300 case GET_FROM_BUFFER
:
5301 it
->object
= it
->w
->buffer
;
5304 /* Bidi-iterate until we get out of the portion of text, if
5305 any, covered by a `display' text property or an overlay
5306 with `display' property. (We cannot just jump there,
5307 because the internal coherency of the bidi iterator state
5308 can not be preserved across such jumps.) We also must
5309 determine the paragraph base direction if the overlay we
5310 just processed is at the beginning of a new
5312 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5313 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
5314 /* prev_stop can be zero, so check against BEGV as well. */
5315 while (it
->bidi_it
.charpos
>= BEGV
5316 && it
->prev_stop
<= it
->bidi_it
.charpos
5317 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5318 bidi_get_next_char_visually (&it
->bidi_it
);
5319 /* Record the stop_pos we just crossed, for when we cross it
5321 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5322 it
->prev_stop
= CHARPOS (it
->position
);
5323 /* If we ended up not where pop_it put us, resync IT's
5324 positional members with the bidi iterator. */
5325 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5327 SET_TEXT_POS (it
->position
,
5328 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5329 it
->current
.pos
= it
->position
;
5333 case GET_FROM_STRING
:
5334 it
->object
= it
->string
;
5336 case GET_FROM_DISPLAY_VECTOR
:
5338 it
->method
= GET_FROM_C_STRING
;
5339 else if (STRINGP (it
->string
))
5340 it
->method
= GET_FROM_STRING
;
5343 it
->method
= GET_FROM_BUFFER
;
5344 it
->object
= it
->w
->buffer
;
5347 it
->end_charpos
= p
->end_charpos
;
5348 it
->string_nchars
= p
->string_nchars
;
5350 it
->multibyte_p
= p
->multibyte_p
;
5351 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5352 it
->space_width
= p
->space_width
;
5353 it
->font_height
= p
->font_height
;
5354 it
->voffset
= p
->voffset
;
5355 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5356 it
->line_wrap
= p
->line_wrap
;
5361 /***********************************************************************
5363 ***********************************************************************/
5365 /* Set IT's current position to the previous line start. */
5368 back_to_previous_line_start (it
)
5371 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5372 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5376 /* Move IT to the next line start.
5378 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5379 we skipped over part of the text (as opposed to moving the iterator
5380 continuously over the text). Otherwise, don't change the value
5383 Newlines may come from buffer text, overlay strings, or strings
5384 displayed via the `display' property. That's the reason we can't
5385 simply use find_next_newline_no_quit.
5387 Note that this function may not skip over invisible text that is so
5388 because of text properties and immediately follows a newline. If
5389 it would, function reseat_at_next_visible_line_start, when called
5390 from set_iterator_to_next, would effectively make invisible
5391 characters following a newline part of the wrong glyph row, which
5392 leads to wrong cursor motion. */
5395 forward_to_next_line_start (it
, skipped_p
)
5399 int old_selective
, newline_found_p
, n
;
5400 const int MAX_NEWLINE_DISTANCE
= 500;
5402 /* If already on a newline, just consume it to avoid unintended
5403 skipping over invisible text below. */
5404 if (it
->what
== IT_CHARACTER
5406 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5408 set_iterator_to_next (it
, 0);
5413 /* Don't handle selective display in the following. It's (a)
5414 unnecessary because it's done by the caller, and (b) leads to an
5415 infinite recursion because next_element_from_ellipsis indirectly
5416 calls this function. */
5417 old_selective
= it
->selective
;
5420 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5421 from buffer text. */
5422 for (n
= newline_found_p
= 0;
5423 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5424 n
+= STRINGP (it
->string
) ? 0 : 1)
5426 if (!get_next_display_element (it
))
5428 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5429 set_iterator_to_next (it
, 0);
5432 /* If we didn't find a newline near enough, see if we can use a
5434 if (!newline_found_p
)
5436 int start
= IT_CHARPOS (*it
);
5437 int limit
= find_next_newline_no_quit (start
, 1);
5440 xassert (!STRINGP (it
->string
));
5442 /* If there isn't any `display' property in sight, and no
5443 overlays, we can just use the position of the newline in
5445 if (it
->stop_charpos
>= limit
5446 || ((pos
= Fnext_single_property_change (make_number (start
),
5448 Qnil
, make_number (limit
)),
5450 && next_overlay_change (start
) == ZV
))
5452 IT_CHARPOS (*it
) = limit
;
5453 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5454 *skipped_p
= newline_found_p
= 1;
5458 while (get_next_display_element (it
)
5459 && !newline_found_p
)
5461 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5462 set_iterator_to_next (it
, 0);
5467 it
->selective
= old_selective
;
5468 return newline_found_p
;
5472 /* Set IT's current position to the previous visible line start. Skip
5473 invisible text that is so either due to text properties or due to
5474 selective display. Caution: this does not change IT->current_x and
5478 back_to_previous_visible_line_start (it
)
5481 while (IT_CHARPOS (*it
) > BEGV
)
5483 back_to_previous_line_start (it
);
5485 if (IT_CHARPOS (*it
) <= BEGV
)
5488 /* If selective > 0, then lines indented more than its value are
5490 if (it
->selective
> 0
5491 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5492 (double) it
->selective
)) /* iftc */
5495 /* Check the newline before point for invisibility. */
5498 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5499 Qinvisible
, it
->window
);
5500 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5504 if (IT_CHARPOS (*it
) <= BEGV
)
5511 Lisp_Object val
, overlay
;
5513 /* If newline is part of a composition, continue from start of composition */
5514 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5515 && beg
< IT_CHARPOS (*it
))
5518 /* If newline is replaced by a display property, find start of overlay
5519 or interval and continue search from that point. */
5521 pos
= --IT_CHARPOS (it2
);
5524 it2
.string_from_display_prop_p
= 0;
5525 if (handle_display_prop (&it2
) == HANDLED_RETURN
5526 && !NILP (val
= get_char_property_and_overlay
5527 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5528 && (OVERLAYP (overlay
)
5529 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5530 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5533 /* Newline is not replaced by anything -- so we are done. */
5539 IT_CHARPOS (*it
) = beg
;
5540 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5544 it
->continuation_lines_width
= 0;
5546 xassert (IT_CHARPOS (*it
) >= BEGV
);
5547 xassert (IT_CHARPOS (*it
) == BEGV
5548 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5553 /* Reseat iterator IT at the previous visible line start. Skip
5554 invisible text that is so either due to text properties or due to
5555 selective display. At the end, update IT's overlay information,
5556 face information etc. */
5559 reseat_at_previous_visible_line_start (it
)
5562 back_to_previous_visible_line_start (it
);
5563 reseat (it
, it
->current
.pos
, 1);
5568 /* Reseat iterator IT on the next visible line start in the current
5569 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5570 preceding the line start. Skip over invisible text that is so
5571 because of selective display. Compute faces, overlays etc at the
5572 new position. Note that this function does not skip over text that
5573 is invisible because of text properties. */
5576 reseat_at_next_visible_line_start (it
, on_newline_p
)
5580 int newline_found_p
, skipped_p
= 0;
5582 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5584 /* Skip over lines that are invisible because they are indented
5585 more than the value of IT->selective. */
5586 if (it
->selective
> 0)
5587 while (IT_CHARPOS (*it
) < ZV
5588 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5589 (double) it
->selective
)) /* iftc */
5591 xassert (IT_BYTEPOS (*it
) == BEGV
5592 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5593 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5596 /* Position on the newline if that's what's requested. */
5597 if (on_newline_p
&& newline_found_p
)
5599 if (STRINGP (it
->string
))
5601 if (IT_STRING_CHARPOS (*it
) > 0)
5603 --IT_STRING_CHARPOS (*it
);
5604 --IT_STRING_BYTEPOS (*it
);
5607 else if (IT_CHARPOS (*it
) > BEGV
)
5611 reseat (it
, it
->current
.pos
, 0);
5615 reseat (it
, it
->current
.pos
, 0);
5622 /***********************************************************************
5623 Changing an iterator's position
5624 ***********************************************************************/
5626 /* Change IT's current position to POS in current_buffer. If FORCE_P
5627 is non-zero, always check for text properties at the new position.
5628 Otherwise, text properties are only looked up if POS >=
5629 IT->check_charpos of a property. */
5632 reseat (it
, pos
, force_p
)
5634 struct text_pos pos
;
5637 int original_pos
= IT_CHARPOS (*it
);
5639 reseat_1 (it
, pos
, 0);
5641 /* Determine where to check text properties. Avoid doing it
5642 where possible because text property lookup is very expensive. */
5644 || CHARPOS (pos
) > it
->stop_charpos
5645 || CHARPOS (pos
) < original_pos
)
5649 /* For bidi iteration, we need to prime prev_stop and
5650 base_level_stop with our best estimations. */
5651 if (CHARPOS (pos
) < it
->prev_stop
)
5653 handle_stop_backwards (it
, BEGV
);
5654 if (CHARPOS (pos
) < it
->base_level_stop
)
5655 it
->base_level_stop
= 0;
5657 else if (CHARPOS (pos
) > it
->stop_charpos
5658 && it
->stop_charpos
>= BEGV
)
5659 handle_stop_backwards (it
, it
->stop_charpos
);
5666 it
->prev_stop
= it
->base_level_stop
= 0;
5675 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5676 IT->stop_pos to POS, also. */
5679 reseat_1 (it
, pos
, set_stop_p
)
5681 struct text_pos pos
;
5684 /* Don't call this function when scanning a C string. */
5685 xassert (it
->s
== NULL
);
5687 /* POS must be a reasonable value. */
5688 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5690 it
->current
.pos
= it
->position
= pos
;
5691 it
->end_charpos
= ZV
;
5693 it
->current
.dpvec_index
= -1;
5694 it
->current
.overlay_string_index
= -1;
5695 IT_STRING_CHARPOS (*it
) = -1;
5696 IT_STRING_BYTEPOS (*it
) = -1;
5698 it
->string_from_display_prop_p
= 0;
5699 it
->method
= GET_FROM_BUFFER
;
5700 it
->object
= it
->w
->buffer
;
5701 it
->area
= TEXT_AREA
;
5702 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5704 it
->string_from_display_prop_p
= 0;
5705 it
->face_before_selective_p
= 0;
5707 it
->bidi_it
.first_elt
= 1;
5711 it
->stop_charpos
= CHARPOS (pos
);
5712 it
->base_level_stop
= CHARPOS (pos
);
5717 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5718 If S is non-null, it is a C string to iterate over. Otherwise,
5719 STRING gives a Lisp string to iterate over.
5721 If PRECISION > 0, don't return more then PRECISION number of
5722 characters from the string.
5724 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5725 characters have been returned. FIELD_WIDTH < 0 means an infinite
5728 MULTIBYTE = 0 means disable processing of multibyte characters,
5729 MULTIBYTE > 0 means enable it,
5730 MULTIBYTE < 0 means use IT->multibyte_p.
5732 IT must be initialized via a prior call to init_iterator before
5733 calling this function. */
5736 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5741 int precision
, field_width
, multibyte
;
5743 /* No region in strings. */
5744 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5746 /* No text property checks performed by default, but see below. */
5747 it
->stop_charpos
= -1;
5749 /* Set iterator position and end position. */
5750 bzero (&it
->current
, sizeof it
->current
);
5751 it
->current
.overlay_string_index
= -1;
5752 it
->current
.dpvec_index
= -1;
5753 xassert (charpos
>= 0);
5755 /* If STRING is specified, use its multibyteness, otherwise use the
5756 setting of MULTIBYTE, if specified. */
5758 it
->multibyte_p
= multibyte
> 0;
5762 xassert (STRINGP (string
));
5763 it
->string
= string
;
5765 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5766 it
->method
= GET_FROM_STRING
;
5767 it
->current
.string_pos
= string_pos (charpos
, string
);
5774 /* Note that we use IT->current.pos, not it->current.string_pos,
5775 for displaying C strings. */
5776 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5777 if (it
->multibyte_p
)
5779 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5780 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5784 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5785 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5788 it
->method
= GET_FROM_C_STRING
;
5791 /* PRECISION > 0 means don't return more than PRECISION characters
5793 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5794 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5796 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5797 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5798 FIELD_WIDTH < 0 means infinite field width. This is useful for
5799 padding with `-' at the end of a mode line. */
5800 if (field_width
< 0)
5801 field_width
= INFINITY
;
5802 if (field_width
> it
->end_charpos
- charpos
)
5803 it
->end_charpos
= charpos
+ field_width
;
5805 /* Use the standard display table for displaying strings. */
5806 if (DISP_TABLE_P (Vstandard_display_table
))
5807 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5809 it
->stop_charpos
= charpos
;
5810 if (s
== NULL
&& it
->multibyte_p
)
5812 EMACS_INT endpos
= SCHARS (it
->string
);
5813 if (endpos
> it
->end_charpos
)
5814 endpos
= it
->end_charpos
;
5815 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5823 /***********************************************************************
5825 ***********************************************************************/
5827 /* Map enum it_method value to corresponding next_element_from_* function. */
5829 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5831 next_element_from_buffer
,
5832 next_element_from_display_vector
,
5833 next_element_from_string
,
5834 next_element_from_c_string
,
5835 next_element_from_image
,
5836 next_element_from_stretch
5839 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5842 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5843 (possibly with the following characters). */
5845 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5846 ((IT)->cmp_it.id >= 0 \
5847 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5848 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5849 END_CHARPOS, (IT)->w, \
5850 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5854 /* Load IT's display element fields with information about the next
5855 display element from the current position of IT. Value is zero if
5856 end of buffer (or C string) is reached. */
5858 static struct frame
*last_escape_glyph_frame
= NULL
;
5859 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5860 static int last_escape_glyph_merged_face_id
= 0;
5863 get_next_display_element (it
)
5866 /* Non-zero means that we found a display element. Zero means that
5867 we hit the end of what we iterate over. Performance note: the
5868 function pointer `method' used here turns out to be faster than
5869 using a sequence of if-statements. */
5873 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5875 if (it
->what
== IT_CHARACTER
)
5877 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5878 and only if (a) the resolved directionality of that character
5880 /* FIXME: Do we need an exception for characters from display
5882 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5883 it
->c
= bidi_mirror_char (it
->c
);
5884 /* Map via display table or translate control characters.
5885 IT->c, IT->len etc. have been set to the next character by
5886 the function call above. If we have a display table, and it
5887 contains an entry for IT->c, translate it. Don't do this if
5888 IT->c itself comes from a display table, otherwise we could
5889 end up in an infinite recursion. (An alternative could be to
5890 count the recursion depth of this function and signal an
5891 error when a certain maximum depth is reached.) Is it worth
5893 if (success_p
&& it
->dpvec
== NULL
)
5896 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5897 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5898 nbsp_or_shy
= char_is_other
;
5899 int decoded
= it
->c
;
5902 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5905 struct Lisp_Vector
*v
= XVECTOR (dv
);
5907 /* Return the first character from the display table
5908 entry, if not empty. If empty, don't display the
5909 current character. */
5912 it
->dpvec_char_len
= it
->len
;
5913 it
->dpvec
= v
->contents
;
5914 it
->dpend
= v
->contents
+ v
->size
;
5915 it
->current
.dpvec_index
= 0;
5916 it
->dpvec_face_id
= -1;
5917 it
->saved_face_id
= it
->face_id
;
5918 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5923 set_iterator_to_next (it
, 0);
5928 if (unibyte_display_via_language_environment
5929 && !ASCII_CHAR_P (it
->c
))
5930 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5932 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5934 if (it
->multibyte_p
)
5935 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5936 : it
->c
== 0xAD ? char_is_soft_hyphen
5938 else if (unibyte_display_via_language_environment
)
5939 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5940 : decoded
== 0xAD ? char_is_soft_hyphen
5944 /* Translate control characters into `\003' or `^C' form.
5945 Control characters coming from a display table entry are
5946 currently not translated because we use IT->dpvec to hold
5947 the translation. This could easily be changed but I
5948 don't believe that it is worth doing.
5950 If it->multibyte_p is nonzero, non-printable non-ASCII
5951 characters are also translated to octal form.
5953 If it->multibyte_p is zero, eight-bit characters that
5954 don't have corresponding multibyte char code are also
5955 translated to octal form. */
5957 ? (it
->area
!= TEXT_AREA
5958 /* In mode line, treat \n, \t like other crl chars. */
5961 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5962 || (it
->c
!= '\n' && it
->c
!= '\t'))
5965 ? ! CHAR_PRINTABLE_P (it
->c
)
5966 : (! unibyte_display_via_language_environment
5968 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5970 /* IT->c is a control character which must be displayed
5971 either as '\003' or as `^C' where the '\\' and '^'
5972 can be defined in the display table. Fill
5973 IT->ctl_chars with glyphs for what we have to
5974 display. Then, set IT->dpvec to these glyphs. */
5977 int face_id
, lface_id
= 0 ;
5980 /* Handle control characters with ^. */
5982 if (it
->c
< 128 && it
->ctl_arrow_p
)
5986 g
= '^'; /* default glyph for Control */
5987 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5989 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5990 && GLYPH_CODE_CHAR_VALID_P (gc
))
5992 g
= GLYPH_CODE_CHAR (gc
);
5993 lface_id
= GLYPH_CODE_FACE (gc
);
5997 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5999 else if (it
->f
== last_escape_glyph_frame
6000 && it
->face_id
== last_escape_glyph_face_id
)
6002 face_id
= last_escape_glyph_merged_face_id
;
6006 /* Merge the escape-glyph face into the current face. */
6007 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6009 last_escape_glyph_frame
= it
->f
;
6010 last_escape_glyph_face_id
= it
->face_id
;
6011 last_escape_glyph_merged_face_id
= face_id
;
6014 XSETINT (it
->ctl_chars
[0], g
);
6015 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
6017 goto display_control
;
6020 /* Handle non-break space in the mode where it only gets
6023 if (EQ (Vnobreak_char_display
, Qt
)
6024 && nbsp_or_shy
== char_is_nbsp
)
6026 /* Merge the no-break-space face into the current face. */
6027 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6031 XSETINT (it
->ctl_chars
[0], ' ');
6033 goto display_control
;
6036 /* Handle sequences that start with the "escape glyph". */
6038 /* the default escape glyph is \. */
6039 escape_glyph
= '\\';
6042 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6043 && GLYPH_CODE_CHAR_VALID_P (gc
))
6045 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6046 lface_id
= GLYPH_CODE_FACE (gc
);
6050 /* The display table specified a face.
6051 Merge it into face_id and also into escape_glyph. */
6052 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6055 else if (it
->f
== last_escape_glyph_frame
6056 && it
->face_id
== last_escape_glyph_face_id
)
6058 face_id
= last_escape_glyph_merged_face_id
;
6062 /* Merge the escape-glyph face into the current face. */
6063 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6065 last_escape_glyph_frame
= it
->f
;
6066 last_escape_glyph_face_id
= it
->face_id
;
6067 last_escape_glyph_merged_face_id
= face_id
;
6070 /* Handle soft hyphens in the mode where they only get
6073 if (EQ (Vnobreak_char_display
, Qt
)
6074 && nbsp_or_shy
== char_is_soft_hyphen
)
6077 XSETINT (it
->ctl_chars
[0], '-');
6079 goto display_control
;
6082 /* Handle non-break space and soft hyphen
6083 with the escape glyph. */
6087 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6088 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6089 XSETINT (it
->ctl_chars
[1], it
->c
);
6091 goto display_control
;
6095 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6099 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
6100 if (CHAR_BYTE8_P (it
->c
))
6102 str
[0] = CHAR_TO_BYTE8 (it
->c
);
6105 else if (it
->c
< 256)
6112 /* It's an invalid character, which shouldn't
6113 happen actually, but due to bugs it may
6114 happen. Let's print the char as is, there's
6115 not much meaningful we can do with it. */
6117 str
[1] = it
->c
>> 8;
6118 str
[2] = it
->c
>> 16;
6119 str
[3] = it
->c
>> 24;
6123 for (i
= 0; i
< len
; i
++)
6126 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
6127 /* Insert three more glyphs into IT->ctl_chars for
6128 the octal display of the character. */
6129 g
= ((str
[i
] >> 6) & 7) + '0';
6130 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
6131 g
= ((str
[i
] >> 3) & 7) + '0';
6132 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
6133 g
= (str
[i
] & 7) + '0';
6134 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
6140 /* Set up IT->dpvec and return first character from it. */
6141 it
->dpvec_char_len
= it
->len
;
6142 it
->dpvec
= it
->ctl_chars
;
6143 it
->dpend
= it
->dpvec
+ ctl_len
;
6144 it
->current
.dpvec_index
= 0;
6145 it
->dpvec_face_id
= face_id
;
6146 it
->saved_face_id
= it
->face_id
;
6147 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6154 #ifdef HAVE_WINDOW_SYSTEM
6155 /* Adjust face id for a multibyte character. There are no multibyte
6156 character in unibyte text. */
6157 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6160 && FRAME_WINDOW_P (it
->f
))
6162 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6164 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6166 /* Automatic composition with glyph-string. */
6167 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6169 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6173 int pos
= (it
->s
? -1
6174 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6175 : IT_CHARPOS (*it
));
6177 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6182 /* Is this character the last one of a run of characters with
6183 box? If yes, set IT->end_of_box_run_p to 1. */
6187 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6189 int face_id
= underlying_face_id (it
);
6190 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6194 if (face
->box
== FACE_NO_BOX
)
6196 /* If the box comes from face properties in a
6197 display string, check faces in that string. */
6198 int string_face_id
= face_after_it_pos (it
);
6199 it
->end_of_box_run_p
6200 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6203 /* Otherwise, the box comes from the underlying face.
6204 If this is the last string character displayed, check
6205 the next buffer location. */
6206 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6207 && (it
->current
.overlay_string_index
6208 == it
->n_overlay_strings
- 1))
6212 struct text_pos pos
= it
->current
.pos
;
6213 INC_TEXT_POS (pos
, it
->multibyte_p
);
6215 next_face_id
= face_at_buffer_position
6216 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6217 it
->region_end_charpos
, &ignore
,
6218 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6220 it
->end_of_box_run_p
6221 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6228 int face_id
= face_after_it_pos (it
);
6229 it
->end_of_box_run_p
6230 = (face_id
!= it
->face_id
6231 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6235 /* Value is 0 if end of buffer or string reached. */
6240 /* Move IT to the next display element.
6242 RESEAT_P non-zero means if called on a newline in buffer text,
6243 skip to the next visible line start.
6245 Functions get_next_display_element and set_iterator_to_next are
6246 separate because I find this arrangement easier to handle than a
6247 get_next_display_element function that also increments IT's
6248 position. The way it is we can first look at an iterator's current
6249 display element, decide whether it fits on a line, and if it does,
6250 increment the iterator position. The other way around we probably
6251 would either need a flag indicating whether the iterator has to be
6252 incremented the next time, or we would have to implement a
6253 decrement position function which would not be easy to write. */
6256 set_iterator_to_next (it
, reseat_p
)
6260 /* Reset flags indicating start and end of a sequence of characters
6261 with box. Reset them at the start of this function because
6262 moving the iterator to a new position might set them. */
6263 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6267 case GET_FROM_BUFFER
:
6268 /* The current display element of IT is a character from
6269 current_buffer. Advance in the buffer, and maybe skip over
6270 invisible lines that are so because of selective display. */
6271 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6272 reseat_at_next_visible_line_start (it
, 0);
6273 else if (it
->cmp_it
.id
>= 0)
6275 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6276 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6279 if (it
->bidi_it
.new_paragraph
)
6280 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6281 /* Resync the bidi iterator with IT's new position.
6282 FIXME: this doesn't support bidirectional text. */
6283 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6284 bidi_get_next_char_visually (&it
->bidi_it
);
6286 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6287 it
->cmp_it
.from
= it
->cmp_it
.to
;
6291 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6292 IT_BYTEPOS (*it
), it
->stop_charpos
,
6298 xassert (it
->len
!= 0);
6302 IT_BYTEPOS (*it
) += it
->len
;
6303 IT_CHARPOS (*it
) += 1;
6307 /* If this is a new paragraph, determine its base
6308 direction (a.k.a. its base embedding level). */
6309 if (it
->bidi_it
.new_paragraph
)
6310 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6311 bidi_get_next_char_visually (&it
->bidi_it
);
6312 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6313 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6315 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6319 case GET_FROM_C_STRING
:
6320 /* Current display element of IT is from a C string. */
6321 IT_BYTEPOS (*it
) += it
->len
;
6322 IT_CHARPOS (*it
) += 1;
6325 case GET_FROM_DISPLAY_VECTOR
:
6326 /* Current display element of IT is from a display table entry.
6327 Advance in the display table definition. Reset it to null if
6328 end reached, and continue with characters from buffers/
6330 ++it
->current
.dpvec_index
;
6332 /* Restore face of the iterator to what they were before the
6333 display vector entry (these entries may contain faces). */
6334 it
->face_id
= it
->saved_face_id
;
6336 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6338 int recheck_faces
= it
->ellipsis_p
;
6341 it
->method
= GET_FROM_C_STRING
;
6342 else if (STRINGP (it
->string
))
6343 it
->method
= GET_FROM_STRING
;
6346 it
->method
= GET_FROM_BUFFER
;
6347 it
->object
= it
->w
->buffer
;
6351 it
->current
.dpvec_index
= -1;
6353 /* Skip over characters which were displayed via IT->dpvec. */
6354 if (it
->dpvec_char_len
< 0)
6355 reseat_at_next_visible_line_start (it
, 1);
6356 else if (it
->dpvec_char_len
> 0)
6358 if (it
->method
== GET_FROM_STRING
6359 && it
->n_overlay_strings
> 0)
6360 it
->ignore_overlay_strings_at_pos_p
= 1;
6361 it
->len
= it
->dpvec_char_len
;
6362 set_iterator_to_next (it
, reseat_p
);
6365 /* Maybe recheck faces after display vector */
6367 it
->stop_charpos
= IT_CHARPOS (*it
);
6371 case GET_FROM_STRING
:
6372 /* Current display element is a character from a Lisp string. */
6373 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6374 if (it
->cmp_it
.id
>= 0)
6376 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6377 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6378 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6379 it
->cmp_it
.from
= it
->cmp_it
.to
;
6383 composition_compute_stop_pos (&it
->cmp_it
,
6384 IT_STRING_CHARPOS (*it
),
6385 IT_STRING_BYTEPOS (*it
),
6386 it
->stop_charpos
, it
->string
);
6391 IT_STRING_BYTEPOS (*it
) += it
->len
;
6392 IT_STRING_CHARPOS (*it
) += 1;
6395 consider_string_end
:
6397 if (it
->current
.overlay_string_index
>= 0)
6399 /* IT->string is an overlay string. Advance to the
6400 next, if there is one. */
6401 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6404 next_overlay_string (it
);
6406 setup_for_ellipsis (it
, 0);
6411 /* IT->string is not an overlay string. If we reached
6412 its end, and there is something on IT->stack, proceed
6413 with what is on the stack. This can be either another
6414 string, this time an overlay string, or a buffer. */
6415 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6419 if (it
->method
== GET_FROM_STRING
)
6420 goto consider_string_end
;
6425 case GET_FROM_IMAGE
:
6426 case GET_FROM_STRETCH
:
6427 /* The position etc with which we have to proceed are on
6428 the stack. The position may be at the end of a string,
6429 if the `display' property takes up the whole string. */
6430 xassert (it
->sp
> 0);
6432 if (it
->method
== GET_FROM_STRING
)
6433 goto consider_string_end
;
6437 /* There are no other methods defined, so this should be a bug. */
6441 xassert (it
->method
!= GET_FROM_STRING
6442 || (STRINGP (it
->string
)
6443 && IT_STRING_CHARPOS (*it
) >= 0));
6446 /* Load IT's display element fields with information about the next
6447 display element which comes from a display table entry or from the
6448 result of translating a control character to one of the forms `^C'
6451 IT->dpvec holds the glyphs to return as characters.
6452 IT->saved_face_id holds the face id before the display vector--it
6453 is restored into IT->face_id in set_iterator_to_next. */
6456 next_element_from_display_vector (it
)
6462 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6464 it
->face_id
= it
->saved_face_id
;
6466 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6467 That seemed totally bogus - so I changed it... */
6468 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6470 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6472 it
->c
= GLYPH_CODE_CHAR (gc
);
6473 it
->len
= CHAR_BYTES (it
->c
);
6475 /* The entry may contain a face id to use. Such a face id is
6476 the id of a Lisp face, not a realized face. A face id of
6477 zero means no face is specified. */
6478 if (it
->dpvec_face_id
>= 0)
6479 it
->face_id
= it
->dpvec_face_id
;
6482 int lface_id
= GLYPH_CODE_FACE (gc
);
6484 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6489 /* Display table entry is invalid. Return a space. */
6490 it
->c
= ' ', it
->len
= 1;
6492 /* Don't change position and object of the iterator here. They are
6493 still the values of the character that had this display table
6494 entry or was translated, and that's what we want. */
6495 it
->what
= IT_CHARACTER
;
6500 /* Load IT with the next display element from Lisp string IT->string.
6501 IT->current.string_pos is the current position within the string.
6502 If IT->current.overlay_string_index >= 0, the Lisp string is an
6506 next_element_from_string (it
)
6509 struct text_pos position
;
6511 xassert (STRINGP (it
->string
));
6512 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6513 position
= it
->current
.string_pos
;
6515 /* Time to check for invisible text? */
6516 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6517 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6521 /* Since a handler may have changed IT->method, we must
6523 return GET_NEXT_DISPLAY_ELEMENT (it
);
6526 if (it
->current
.overlay_string_index
>= 0)
6528 /* Get the next character from an overlay string. In overlay
6529 strings, There is no field width or padding with spaces to
6531 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6536 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6537 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6538 && next_element_from_composition (it
))
6542 else if (STRING_MULTIBYTE (it
->string
))
6544 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6545 const unsigned char *s
= (SDATA (it
->string
)
6546 + IT_STRING_BYTEPOS (*it
));
6547 it
->c
= string_char_and_length (s
, &it
->len
);
6551 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6557 /* Get the next character from a Lisp string that is not an
6558 overlay string. Such strings come from the mode line, for
6559 example. We may have to pad with spaces, or truncate the
6560 string. See also next_element_from_c_string. */
6561 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6566 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6568 /* Pad with spaces. */
6569 it
->c
= ' ', it
->len
= 1;
6570 CHARPOS (position
) = BYTEPOS (position
) = -1;
6572 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6573 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6574 && next_element_from_composition (it
))
6578 else if (STRING_MULTIBYTE (it
->string
))
6580 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6581 const unsigned char *s
= (SDATA (it
->string
)
6582 + IT_STRING_BYTEPOS (*it
));
6583 it
->c
= string_char_and_length (s
, &it
->len
);
6587 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6592 /* Record what we have and where it came from. */
6593 it
->what
= IT_CHARACTER
;
6594 it
->object
= it
->string
;
6595 it
->position
= position
;
6600 /* Load IT with next display element from C string IT->s.
6601 IT->string_nchars is the maximum number of characters to return
6602 from the string. IT->end_charpos may be greater than
6603 IT->string_nchars when this function is called, in which case we
6604 may have to return padding spaces. Value is zero if end of string
6605 reached, including padding spaces. */
6608 next_element_from_c_string (it
)
6614 it
->what
= IT_CHARACTER
;
6615 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6618 /* IT's position can be greater IT->string_nchars in case a field
6619 width or precision has been specified when the iterator was
6621 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6623 /* End of the game. */
6627 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6629 /* Pad with spaces. */
6630 it
->c
= ' ', it
->len
= 1;
6631 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6633 else if (it
->multibyte_p
)
6635 /* Implementation note: The calls to strlen apparently aren't a
6636 performance problem because there is no noticeable performance
6637 difference between Emacs running in unibyte or multibyte mode. */
6638 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6639 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6642 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6648 /* Set up IT to return characters from an ellipsis, if appropriate.
6649 The definition of the ellipsis glyphs may come from a display table
6650 entry. This function fills IT with the first glyph from the
6651 ellipsis if an ellipsis is to be displayed. */
6654 next_element_from_ellipsis (it
)
6657 if (it
->selective_display_ellipsis_p
)
6658 setup_for_ellipsis (it
, it
->len
);
6661 /* The face at the current position may be different from the
6662 face we find after the invisible text. Remember what it
6663 was in IT->saved_face_id, and signal that it's there by
6664 setting face_before_selective_p. */
6665 it
->saved_face_id
= it
->face_id
;
6666 it
->method
= GET_FROM_BUFFER
;
6667 it
->object
= it
->w
->buffer
;
6668 reseat_at_next_visible_line_start (it
, 1);
6669 it
->face_before_selective_p
= 1;
6672 return GET_NEXT_DISPLAY_ELEMENT (it
);
6676 /* Deliver an image display element. The iterator IT is already
6677 filled with image information (done in handle_display_prop). Value
6682 next_element_from_image (it
)
6685 it
->what
= IT_IMAGE
;
6690 /* Fill iterator IT with next display element from a stretch glyph
6691 property. IT->object is the value of the text property. Value is
6695 next_element_from_stretch (it
)
6698 it
->what
= IT_STRETCH
;
6702 /* Scan forward from CHARPOS in the current buffer, until we find a
6703 stop position > current IT's position. Then handle the stop
6704 position before that. This is called when we bump into a stop
6705 position while reordering bidirectional text. CHARPOS should be
6706 the last previously processed stop_pos (or BEGV, if none were
6707 processed yet) whose position is less that IT's current
6711 handle_stop_backwards (it
, charpos
)
6715 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6716 struct display_pos save_current
= it
->current
;
6717 struct text_pos save_position
= it
->position
;
6718 struct text_pos pos1
;
6719 EMACS_INT next_stop
;
6721 /* Scan in strict logical order. */
6725 it
->prev_stop
= charpos
;
6726 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6727 reseat_1 (it
, pos1
, 0);
6728 compute_stop_pos (it
);
6729 /* We must advance forward, right? */
6730 if (it
->stop_charpos
<= it
->prev_stop
)
6732 charpos
= it
->stop_charpos
;
6734 while (charpos
<= where_we_are
);
6736 next_stop
= it
->stop_charpos
;
6737 it
->stop_charpos
= it
->prev_stop
;
6739 it
->current
= save_current
;
6740 it
->position
= save_position
;
6742 it
->stop_charpos
= next_stop
;
6745 /* Load IT with the next display element from current_buffer. Value
6746 is zero if end of buffer reached. IT->stop_charpos is the next
6747 position at which to stop and check for text properties or buffer
6751 next_element_from_buffer (it
)
6756 xassert (IT_CHARPOS (*it
) >= BEGV
);
6758 /* With bidi reordering, the character to display might not be the
6759 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6760 we were reseat()ed to a new buffer position, which is potentially
6761 a different paragraph. */
6762 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6764 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6765 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6766 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6768 /* Nothing to do, but reset the FIRST_ELT flag, like
6769 bidi_paragraph_init does, because we are not going to
6771 it
->bidi_it
.first_elt
= 0;
6773 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6774 /* FIXME: Should support all Unicode line separators. */
6775 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6776 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6778 /* If we are at the beginning of a line, we can produce the
6779 next element right away. */
6780 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6781 bidi_get_next_char_visually (&it
->bidi_it
);
6785 int orig_bytepos
= IT_BYTEPOS (*it
);
6787 /* We need to prime the bidi iterator starting at the line's
6788 beginning, before we will be able to produce the next
6790 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6791 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6792 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6793 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6794 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6797 /* Now return to buffer position where we were asked to
6798 get the next display element, and produce that. */
6799 bidi_get_next_char_visually (&it
->bidi_it
);
6801 while (it
->bidi_it
.bytepos
!= orig_bytepos
6802 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6805 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6806 /* Adjust IT's position information to where we ended up. */
6807 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6808 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6809 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6812 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6814 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6816 int overlay_strings_follow_p
;
6818 /* End of the game, except when overlay strings follow that
6819 haven't been returned yet. */
6820 if (it
->overlay_strings_at_end_processed_p
)
6821 overlay_strings_follow_p
= 0;
6824 it
->overlay_strings_at_end_processed_p
= 1;
6825 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6828 if (overlay_strings_follow_p
)
6829 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6833 it
->position
= it
->current
.pos
;
6837 else if (!(!it
->bidi_p
6838 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6839 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6841 /* With bidi non-linear iteration, we could find ourselves
6842 far beyond the last computed stop_charpos, with several
6843 other stop positions in between that we missed. Scan
6844 them all now, in buffer's logical order, until we find
6845 and handle the last stop_charpos that precedes our
6846 current position. */
6847 handle_stop_backwards (it
, it
->stop_charpos
);
6848 return GET_NEXT_DISPLAY_ELEMENT (it
);
6854 /* Take note of the stop position we just moved across,
6855 for when we will move back across it. */
6856 it
->prev_stop
= it
->stop_charpos
;
6857 /* If we are at base paragraph embedding level, take
6858 note of the last stop position seen at this
6860 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6861 it
->base_level_stop
= it
->stop_charpos
;
6864 return GET_NEXT_DISPLAY_ELEMENT (it
);
6868 /* We can sometimes back up for reasons that have nothing
6869 to do with bidi reordering. E.g., compositions. The
6870 code below is only needed when we are above the base
6871 embedding level, so test for that explicitly. */
6872 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6873 && IT_CHARPOS (*it
) < it
->prev_stop
)
6875 if (it
->base_level_stop
<= 0)
6876 it
->base_level_stop
= BEGV
;
6877 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6879 handle_stop_backwards (it
, it
->base_level_stop
);
6880 return GET_NEXT_DISPLAY_ELEMENT (it
);
6884 /* No face changes, overlays etc. in sight, so just return a
6885 character from current_buffer. */
6888 /* Maybe run the redisplay end trigger hook. Performance note:
6889 This doesn't seem to cost measurable time. */
6890 if (it
->redisplay_end_trigger_charpos
6892 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6893 run_redisplay_end_trigger_hook (it
);
6895 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6897 && next_element_from_composition (it
))
6902 /* Get the next character, maybe multibyte. */
6903 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6904 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6905 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6907 it
->c
= *p
, it
->len
= 1;
6909 /* Record what we have and where it came from. */
6910 it
->what
= IT_CHARACTER
;
6911 it
->object
= it
->w
->buffer
;
6912 it
->position
= it
->current
.pos
;
6914 /* Normally we return the character found above, except when we
6915 really want to return an ellipsis for selective display. */
6920 /* A value of selective > 0 means hide lines indented more
6921 than that number of columns. */
6922 if (it
->selective
> 0
6923 && IT_CHARPOS (*it
) + 1 < ZV
6924 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6925 IT_BYTEPOS (*it
) + 1,
6926 (double) it
->selective
)) /* iftc */
6928 success_p
= next_element_from_ellipsis (it
);
6929 it
->dpvec_char_len
= -1;
6932 else if (it
->c
== '\r' && it
->selective
== -1)
6934 /* A value of selective == -1 means that everything from the
6935 CR to the end of the line is invisible, with maybe an
6936 ellipsis displayed for it. */
6937 success_p
= next_element_from_ellipsis (it
);
6938 it
->dpvec_char_len
= -1;
6943 /* Value is zero if end of buffer reached. */
6944 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6949 /* Run the redisplay end trigger hook for IT. */
6952 run_redisplay_end_trigger_hook (it
)
6955 Lisp_Object args
[3];
6957 /* IT->glyph_row should be non-null, i.e. we should be actually
6958 displaying something, or otherwise we should not run the hook. */
6959 xassert (it
->glyph_row
);
6961 /* Set up hook arguments. */
6962 args
[0] = Qredisplay_end_trigger_functions
;
6963 args
[1] = it
->window
;
6964 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6965 it
->redisplay_end_trigger_charpos
= 0;
6967 /* Since we are *trying* to run these functions, don't try to run
6968 them again, even if they get an error. */
6969 it
->w
->redisplay_end_trigger
= Qnil
;
6970 Frun_hook_with_args (3, args
);
6972 /* Notice if it changed the face of the character we are on. */
6973 handle_face_prop (it
);
6977 /* Deliver a composition display element. Unlike the other
6978 next_element_from_XXX, this function is not registered in the array
6979 get_next_element[]. It is called from next_element_from_buffer and
6980 next_element_from_string when necessary. */
6983 next_element_from_composition (it
)
6986 it
->what
= IT_COMPOSITION
;
6987 it
->len
= it
->cmp_it
.nbytes
;
6988 if (STRINGP (it
->string
))
6992 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6993 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6996 it
->position
= it
->current
.string_pos
;
6997 it
->object
= it
->string
;
6998 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6999 IT_STRING_BYTEPOS (*it
), it
->string
);
7005 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7006 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7009 if (it
->bidi_it
.new_paragraph
)
7010 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
7011 /* Resync the bidi iterator with IT's new position.
7012 FIXME: this doesn't support bidirectional text. */
7013 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7014 bidi_get_next_char_visually (&it
->bidi_it
);
7018 it
->position
= it
->current
.pos
;
7019 it
->object
= it
->w
->buffer
;
7020 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7021 IT_BYTEPOS (*it
), Qnil
);
7028 /***********************************************************************
7029 Moving an iterator without producing glyphs
7030 ***********************************************************************/
7032 /* Check if iterator is at a position corresponding to a valid buffer
7033 position after some move_it_ call. */
7035 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7036 ((it)->method == GET_FROM_STRING \
7037 ? IT_STRING_CHARPOS (*it) == 0 \
7041 /* Move iterator IT to a specified buffer or X position within one
7042 line on the display without producing glyphs.
7044 OP should be a bit mask including some or all of these bits:
7045 MOVE_TO_X: Stop upon reaching x-position TO_X.
7046 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7047 Regardless of OP's value, stop upon reaching the end of the display line.
7049 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7050 This means, in particular, that TO_X includes window's horizontal
7053 The return value has several possible values that
7054 say what condition caused the scan to stop:
7056 MOVE_POS_MATCH_OR_ZV
7057 - when TO_POS or ZV was reached.
7060 -when TO_X was reached before TO_POS or ZV were reached.
7063 - when we reached the end of the display area and the line must
7067 - when we reached the end of the display area and the line is
7071 - when we stopped at a line end, i.e. a newline or a CR and selective
7074 static enum move_it_result
7075 move_it_in_display_line_to (struct it
*it
,
7076 EMACS_INT to_charpos
, int to_x
,
7077 enum move_operation_enum op
)
7079 enum move_it_result result
= MOVE_UNDEFINED
;
7080 struct glyph_row
*saved_glyph_row
;
7081 struct it wrap_it
, atpos_it
, atx_it
;
7083 enum it_method prev_method
= it
->method
;
7084 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7086 /* Don't produce glyphs in produce_glyphs. */
7087 saved_glyph_row
= it
->glyph_row
;
7088 it
->glyph_row
= NULL
;
7090 /* Use wrap_it to save a copy of IT wherever a word wrap could
7091 occur. Use atpos_it to save a copy of IT at the desired buffer
7092 position, if found, so that we can scan ahead and check if the
7093 word later overshoots the window edge. Use atx_it similarly, for
7099 #define BUFFER_POS_REACHED_P() \
7100 ((op & MOVE_TO_POS) != 0 \
7101 && BUFFERP (it->object) \
7102 && (IT_CHARPOS (*it) == to_charpos \
7103 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7104 && (it->method == GET_FROM_BUFFER \
7105 || (it->method == GET_FROM_DISPLAY_VECTOR \
7106 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7108 /* If there's a line-/wrap-prefix, handle it. */
7109 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7110 && it
->current_y
< it
->last_visible_y
)
7111 handle_line_prefix (it
);
7115 int x
, i
, ascent
= 0, descent
= 0;
7117 /* Utility macro to reset an iterator with x, ascent, and descent. */
7118 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7119 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7120 (IT)->max_descent = descent)
7122 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7124 if ((op
& MOVE_TO_POS
) != 0
7125 && BUFFERP (it
->object
)
7126 && it
->method
== GET_FROM_BUFFER
7127 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7129 && (prev_method
== GET_FROM_IMAGE
7130 || prev_method
== GET_FROM_STRETCH
)
7131 /* Passed TO_CHARPOS from left to right. */
7132 && ((prev_pos
< to_charpos
7133 && IT_CHARPOS (*it
) > to_charpos
)
7134 /* Passed TO_CHARPOS from right to left. */
7135 || (prev_pos
> to_charpos
7136 && IT_CHARPOS (*it
) < to_charpos
)))))
7138 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7140 result
= MOVE_POS_MATCH_OR_ZV
;
7143 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7144 /* If wrap_it is valid, the current position might be in a
7145 word that is wrapped. So, save the iterator in
7146 atpos_it and continue to see if wrapping happens. */
7150 prev_method
= it
->method
;
7151 if (it
->method
== GET_FROM_BUFFER
)
7152 prev_pos
= IT_CHARPOS (*it
);
7153 /* Stop when ZV reached.
7154 We used to stop here when TO_CHARPOS reached as well, but that is
7155 too soon if this glyph does not fit on this line. So we handle it
7156 explicitly below. */
7157 if (!get_next_display_element (it
))
7159 result
= MOVE_POS_MATCH_OR_ZV
;
7163 if (it
->line_wrap
== TRUNCATE
)
7165 if (BUFFER_POS_REACHED_P ())
7167 result
= MOVE_POS_MATCH_OR_ZV
;
7173 if (it
->line_wrap
== WORD_WRAP
)
7175 if (IT_DISPLAYING_WHITESPACE (it
))
7179 /* We have reached a glyph that follows one or more
7180 whitespace characters. If the position is
7181 already found, we are done. */
7182 if (atpos_it
.sp
>= 0)
7185 result
= MOVE_POS_MATCH_OR_ZV
;
7191 result
= MOVE_X_REACHED
;
7194 /* Otherwise, we can wrap here. */
7201 /* Remember the line height for the current line, in case
7202 the next element doesn't fit on the line. */
7203 ascent
= it
->max_ascent
;
7204 descent
= it
->max_descent
;
7206 /* The call to produce_glyphs will get the metrics of the
7207 display element IT is loaded with. Record the x-position
7208 before this display element, in case it doesn't fit on the
7212 PRODUCE_GLYPHS (it
);
7214 if (it
->area
!= TEXT_AREA
)
7216 set_iterator_to_next (it
, 1);
7220 /* The number of glyphs we get back in IT->nglyphs will normally
7221 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7222 character on a terminal frame, or (iii) a line end. For the
7223 second case, IT->nglyphs - 1 padding glyphs will be present.
7224 (On X frames, there is only one glyph produced for a
7225 composite character.)
7227 The behavior implemented below means, for continuation lines,
7228 that as many spaces of a TAB as fit on the current line are
7229 displayed there. For terminal frames, as many glyphs of a
7230 multi-glyph character are displayed in the current line, too.
7231 This is what the old redisplay code did, and we keep it that
7232 way. Under X, the whole shape of a complex character must
7233 fit on the line or it will be completely displayed in the
7236 Note that both for tabs and padding glyphs, all glyphs have
7240 /* More than one glyph or glyph doesn't fit on line. All
7241 glyphs have the same width. */
7242 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7244 int x_before_this_char
= x
;
7245 int hpos_before_this_char
= it
->hpos
;
7247 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7249 new_x
= x
+ single_glyph_width
;
7251 /* We want to leave anything reaching TO_X to the caller. */
7252 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7254 if (BUFFER_POS_REACHED_P ())
7256 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7257 goto buffer_pos_reached
;
7258 if (atpos_it
.sp
< 0)
7261 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7266 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7269 result
= MOVE_X_REACHED
;
7275 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7280 if (/* Lines are continued. */
7281 it
->line_wrap
!= TRUNCATE
7282 && (/* And glyph doesn't fit on the line. */
7283 new_x
> it
->last_visible_x
7284 /* Or it fits exactly and we're on a window
7286 || (new_x
== it
->last_visible_x
7287 && FRAME_WINDOW_P (it
->f
))))
7289 if (/* IT->hpos == 0 means the very first glyph
7290 doesn't fit on the line, e.g. a wide image. */
7292 || (new_x
== it
->last_visible_x
7293 && FRAME_WINDOW_P (it
->f
)))
7296 it
->current_x
= new_x
;
7298 /* The character's last glyph just barely fits
7300 if (i
== it
->nglyphs
- 1)
7302 /* If this is the destination position,
7303 return a position *before* it in this row,
7304 now that we know it fits in this row. */
7305 if (BUFFER_POS_REACHED_P ())
7307 if (it
->line_wrap
!= WORD_WRAP
7310 it
->hpos
= hpos_before_this_char
;
7311 it
->current_x
= x_before_this_char
;
7312 result
= MOVE_POS_MATCH_OR_ZV
;
7315 if (it
->line_wrap
== WORD_WRAP
7319 atpos_it
.current_x
= x_before_this_char
;
7320 atpos_it
.hpos
= hpos_before_this_char
;
7324 set_iterator_to_next (it
, 1);
7325 /* On graphical terminals, newlines may
7326 "overflow" into the fringe if
7327 overflow-newline-into-fringe is non-nil.
7328 On text-only terminals, newlines may
7329 overflow into the last glyph on the
7331 if (!FRAME_WINDOW_P (it
->f
)
7332 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7334 if (!get_next_display_element (it
))
7336 result
= MOVE_POS_MATCH_OR_ZV
;
7339 if (BUFFER_POS_REACHED_P ())
7341 if (ITERATOR_AT_END_OF_LINE_P (it
))
7342 result
= MOVE_POS_MATCH_OR_ZV
;
7344 result
= MOVE_LINE_CONTINUED
;
7347 if (ITERATOR_AT_END_OF_LINE_P (it
))
7349 result
= MOVE_NEWLINE_OR_CR
;
7356 IT_RESET_X_ASCENT_DESCENT (it
);
7358 if (wrap_it
.sp
>= 0)
7365 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7367 result
= MOVE_LINE_CONTINUED
;
7371 if (BUFFER_POS_REACHED_P ())
7373 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7374 goto buffer_pos_reached
;
7375 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7378 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7382 if (new_x
> it
->first_visible_x
)
7384 /* Glyph is visible. Increment number of glyphs that
7385 would be displayed. */
7390 if (result
!= MOVE_UNDEFINED
)
7393 else if (BUFFER_POS_REACHED_P ())
7396 IT_RESET_X_ASCENT_DESCENT (it
);
7397 result
= MOVE_POS_MATCH_OR_ZV
;
7400 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7402 /* Stop when TO_X specified and reached. This check is
7403 necessary here because of lines consisting of a line end,
7404 only. The line end will not produce any glyphs and we
7405 would never get MOVE_X_REACHED. */
7406 xassert (it
->nglyphs
== 0);
7407 result
= MOVE_X_REACHED
;
7411 /* Is this a line end? If yes, we're done. */
7412 if (ITERATOR_AT_END_OF_LINE_P (it
))
7414 result
= MOVE_NEWLINE_OR_CR
;
7418 if (it
->method
== GET_FROM_BUFFER
)
7419 prev_pos
= IT_CHARPOS (*it
);
7420 /* The current display element has been consumed. Advance
7422 set_iterator_to_next (it
, 1);
7424 /* Stop if lines are truncated and IT's current x-position is
7425 past the right edge of the window now. */
7426 if (it
->line_wrap
== TRUNCATE
7427 && it
->current_x
>= it
->last_visible_x
)
7429 if (!FRAME_WINDOW_P (it
->f
)
7430 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7432 if (!get_next_display_element (it
)
7433 || BUFFER_POS_REACHED_P ())
7435 result
= MOVE_POS_MATCH_OR_ZV
;
7438 if (ITERATOR_AT_END_OF_LINE_P (it
))
7440 result
= MOVE_NEWLINE_OR_CR
;
7444 result
= MOVE_LINE_TRUNCATED
;
7447 #undef IT_RESET_X_ASCENT_DESCENT
7450 #undef BUFFER_POS_REACHED_P
7452 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7453 restore the saved iterator. */
7454 if (atpos_it
.sp
>= 0)
7456 else if (atx_it
.sp
>= 0)
7461 /* Restore the iterator settings altered at the beginning of this
7463 it
->glyph_row
= saved_glyph_row
;
7467 /* For external use. */
7469 move_it_in_display_line (struct it
*it
,
7470 EMACS_INT to_charpos
, int to_x
,
7471 enum move_operation_enum op
)
7473 if (it
->line_wrap
== WORD_WRAP
7474 && (op
& MOVE_TO_X
))
7476 struct it save_it
= *it
;
7477 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7478 /* When word-wrap is on, TO_X may lie past the end
7479 of a wrapped line. Then it->current is the
7480 character on the next line, so backtrack to the
7481 space before the wrap point. */
7482 if (skip
== MOVE_LINE_CONTINUED
)
7484 int prev_x
= max (it
->current_x
- 1, 0);
7486 move_it_in_display_line_to
7487 (it
, -1, prev_x
, MOVE_TO_X
);
7491 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7495 /* Move IT forward until it satisfies one or more of the criteria in
7496 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7498 OP is a bit-mask that specifies where to stop, and in particular,
7499 which of those four position arguments makes a difference. See the
7500 description of enum move_operation_enum.
7502 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7503 screen line, this function will set IT to the next position >
7507 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7509 int to_charpos
, to_x
, to_y
, to_vpos
;
7512 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7513 int line_height
, line_start_x
= 0, reached
= 0;
7517 if (op
& MOVE_TO_VPOS
)
7519 /* If no TO_CHARPOS and no TO_X specified, stop at the
7520 start of the line TO_VPOS. */
7521 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7523 if (it
->vpos
== to_vpos
)
7529 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7533 /* TO_VPOS >= 0 means stop at TO_X in the line at
7534 TO_VPOS, or at TO_POS, whichever comes first. */
7535 if (it
->vpos
== to_vpos
)
7541 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7543 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7548 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7550 /* We have reached TO_X but not in the line we want. */
7551 skip
= move_it_in_display_line_to (it
, to_charpos
,
7553 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7561 else if (op
& MOVE_TO_Y
)
7563 struct it it_backup
;
7565 if (it
->line_wrap
== WORD_WRAP
)
7568 /* TO_Y specified means stop at TO_X in the line containing
7569 TO_Y---or at TO_CHARPOS if this is reached first. The
7570 problem is that we can't really tell whether the line
7571 contains TO_Y before we have completely scanned it, and
7572 this may skip past TO_X. What we do is to first scan to
7575 If TO_X is not specified, use a TO_X of zero. The reason
7576 is to make the outcome of this function more predictable.
7577 If we didn't use TO_X == 0, we would stop at the end of
7578 the line which is probably not what a caller would expect
7580 skip
= move_it_in_display_line_to
7581 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7582 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7584 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7585 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7587 else if (skip
== MOVE_X_REACHED
)
7589 /* If TO_X was reached, we want to know whether TO_Y is
7590 in the line. We know this is the case if the already
7591 scanned glyphs make the line tall enough. Otherwise,
7592 we must check by scanning the rest of the line. */
7593 line_height
= it
->max_ascent
+ it
->max_descent
;
7594 if (to_y
>= it
->current_y
7595 && to_y
< it
->current_y
+ line_height
)
7601 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7602 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7604 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7605 line_height
= it
->max_ascent
+ it
->max_descent
;
7606 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7608 if (to_y
>= it
->current_y
7609 && to_y
< it
->current_y
+ line_height
)
7611 /* If TO_Y is in this line and TO_X was reached
7612 above, we scanned too far. We have to restore
7613 IT's settings to the ones before skipping. */
7620 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7626 /* Check whether TO_Y is in this line. */
7627 line_height
= it
->max_ascent
+ it
->max_descent
;
7628 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7630 if (to_y
>= it
->current_y
7631 && to_y
< it
->current_y
+ line_height
)
7633 /* When word-wrap is on, TO_X may lie past the end
7634 of a wrapped line. Then it->current is the
7635 character on the next line, so backtrack to the
7636 space before the wrap point. */
7637 if (skip
== MOVE_LINE_CONTINUED
7638 && it
->line_wrap
== WORD_WRAP
)
7640 int prev_x
= max (it
->current_x
- 1, 0);
7642 skip
= move_it_in_display_line_to
7643 (it
, -1, prev_x
, MOVE_TO_X
);
7652 else if (BUFFERP (it
->object
)
7653 && (it
->method
== GET_FROM_BUFFER
7654 || it
->method
== GET_FROM_STRETCH
)
7655 && IT_CHARPOS (*it
) >= to_charpos
)
7656 skip
= MOVE_POS_MATCH_OR_ZV
;
7658 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7662 case MOVE_POS_MATCH_OR_ZV
:
7666 case MOVE_NEWLINE_OR_CR
:
7667 set_iterator_to_next (it
, 1);
7668 it
->continuation_lines_width
= 0;
7671 case MOVE_LINE_TRUNCATED
:
7672 it
->continuation_lines_width
= 0;
7673 reseat_at_next_visible_line_start (it
, 0);
7674 if ((op
& MOVE_TO_POS
) != 0
7675 && IT_CHARPOS (*it
) > to_charpos
)
7682 case MOVE_LINE_CONTINUED
:
7683 /* For continued lines ending in a tab, some of the glyphs
7684 associated with the tab are displayed on the current
7685 line. Since it->current_x does not include these glyphs,
7686 we use it->last_visible_x instead. */
7689 it
->continuation_lines_width
+= it
->last_visible_x
;
7690 /* When moving by vpos, ensure that the iterator really
7691 advances to the next line (bug#847, bug#969). Fixme:
7692 do we need to do this in other circumstances? */
7693 if (it
->current_x
!= it
->last_visible_x
7694 && (op
& MOVE_TO_VPOS
)
7695 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7697 line_start_x
= it
->current_x
+ it
->pixel_width
7698 - it
->last_visible_x
;
7699 set_iterator_to_next (it
, 0);
7703 it
->continuation_lines_width
+= it
->current_x
;
7710 /* Reset/increment for the next run. */
7711 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7712 it
->current_x
= line_start_x
;
7715 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7717 last_height
= it
->max_ascent
+ it
->max_descent
;
7718 last_max_ascent
= it
->max_ascent
;
7719 it
->max_ascent
= it
->max_descent
= 0;
7724 /* On text terminals, we may stop at the end of a line in the middle
7725 of a multi-character glyph. If the glyph itself is continued,
7726 i.e. it is actually displayed on the next line, don't treat this
7727 stopping point as valid; move to the next line instead (unless
7728 that brings us offscreen). */
7729 if (!FRAME_WINDOW_P (it
->f
)
7731 && IT_CHARPOS (*it
) == to_charpos
7732 && it
->what
== IT_CHARACTER
7734 && it
->line_wrap
== WINDOW_WRAP
7735 && it
->current_x
== it
->last_visible_x
- 1
7738 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7740 it
->continuation_lines_width
+= it
->current_x
;
7741 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7742 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7744 last_height
= it
->max_ascent
+ it
->max_descent
;
7745 last_max_ascent
= it
->max_ascent
;
7748 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7752 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7754 If DY > 0, move IT backward at least that many pixels. DY = 0
7755 means move IT backward to the preceding line start or BEGV. This
7756 function may move over more than DY pixels if IT->current_y - DY
7757 ends up in the middle of a line; in this case IT->current_y will be
7758 set to the top of the line moved to. */
7761 move_it_vertically_backward (it
, dy
)
7772 start_pos
= IT_CHARPOS (*it
);
7774 /* Estimate how many newlines we must move back. */
7775 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7777 /* Set the iterator's position that many lines back. */
7778 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7779 back_to_previous_visible_line_start (it
);
7781 /* Reseat the iterator here. When moving backward, we don't want
7782 reseat to skip forward over invisible text, set up the iterator
7783 to deliver from overlay strings at the new position etc. So,
7784 use reseat_1 here. */
7785 reseat_1 (it
, it
->current
.pos
, 1);
7787 /* We are now surely at a line start. */
7788 it
->current_x
= it
->hpos
= 0;
7789 it
->continuation_lines_width
= 0;
7791 /* Move forward and see what y-distance we moved. First move to the
7792 start of the next line so that we get its height. We need this
7793 height to be able to tell whether we reached the specified
7796 it2
.max_ascent
= it2
.max_descent
= 0;
7799 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7800 MOVE_TO_POS
| MOVE_TO_VPOS
);
7802 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7803 xassert (IT_CHARPOS (*it
) >= BEGV
);
7806 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7807 xassert (IT_CHARPOS (*it
) >= BEGV
);
7808 /* H is the actual vertical distance from the position in *IT
7809 and the starting position. */
7810 h
= it2
.current_y
- it
->current_y
;
7811 /* NLINES is the distance in number of lines. */
7812 nlines
= it2
.vpos
- it
->vpos
;
7814 /* Correct IT's y and vpos position
7815 so that they are relative to the starting point. */
7821 /* DY == 0 means move to the start of the screen line. The
7822 value of nlines is > 0 if continuation lines were involved. */
7824 move_it_by_lines (it
, nlines
, 1);
7828 /* The y-position we try to reach, relative to *IT.
7829 Note that H has been subtracted in front of the if-statement. */
7830 int target_y
= it
->current_y
+ h
- dy
;
7831 int y0
= it3
.current_y
;
7832 int y1
= line_bottom_y (&it3
);
7833 int line_height
= y1
- y0
;
7835 /* If we did not reach target_y, try to move further backward if
7836 we can. If we moved too far backward, try to move forward. */
7837 if (target_y
< it
->current_y
7838 /* This is heuristic. In a window that's 3 lines high, with
7839 a line height of 13 pixels each, recentering with point
7840 on the bottom line will try to move -39/2 = 19 pixels
7841 backward. Try to avoid moving into the first line. */
7842 && (it
->current_y
- target_y
7843 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7844 && IT_CHARPOS (*it
) > BEGV
)
7846 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7847 target_y
- it
->current_y
));
7848 dy
= it
->current_y
- target_y
;
7849 goto move_further_back
;
7851 else if (target_y
>= it
->current_y
+ line_height
7852 && IT_CHARPOS (*it
) < ZV
)
7854 /* Should move forward by at least one line, maybe more.
7856 Note: Calling move_it_by_lines can be expensive on
7857 terminal frames, where compute_motion is used (via
7858 vmotion) to do the job, when there are very long lines
7859 and truncate-lines is nil. That's the reason for
7860 treating terminal frames specially here. */
7862 if (!FRAME_WINDOW_P (it
->f
))
7863 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7868 move_it_by_lines (it
, 1, 1);
7870 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7877 /* Move IT by a specified amount of pixel lines DY. DY negative means
7878 move backwards. DY = 0 means move to start of screen line. At the
7879 end, IT will be on the start of a screen line. */
7882 move_it_vertically (it
, dy
)
7887 move_it_vertically_backward (it
, -dy
);
7890 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7891 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7892 MOVE_TO_POS
| MOVE_TO_Y
);
7893 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7895 /* If buffer ends in ZV without a newline, move to the start of
7896 the line to satisfy the post-condition. */
7897 if (IT_CHARPOS (*it
) == ZV
7899 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7900 move_it_by_lines (it
, 0, 0);
7905 /* Move iterator IT past the end of the text line it is in. */
7908 move_it_past_eol (it
)
7911 enum move_it_result rc
;
7913 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7914 if (rc
== MOVE_NEWLINE_OR_CR
)
7915 set_iterator_to_next (it
, 0);
7919 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7920 negative means move up. DVPOS == 0 means move to the start of the
7921 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7922 NEED_Y_P is zero, IT->current_y will be left unchanged.
7924 Further optimization ideas: If we would know that IT->f doesn't use
7925 a face with proportional font, we could be faster for
7926 truncate-lines nil. */
7929 move_it_by_lines (it
, dvpos
, need_y_p
)
7931 int dvpos
, need_y_p
;
7933 struct position pos
;
7935 /* The commented-out optimization uses vmotion on terminals. This
7936 gives bad results, because elements like it->what, on which
7937 callers such as pos_visible_p rely, aren't updated. */
7938 /* if (!FRAME_WINDOW_P (it->f))
7940 struct text_pos textpos;
7942 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7943 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7944 reseat (it, textpos, 1);
7945 it->vpos += pos.vpos;
7946 it->current_y += pos.vpos;
7952 /* DVPOS == 0 means move to the start of the screen line. */
7953 move_it_vertically_backward (it
, 0);
7954 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7955 /* Let next call to line_bottom_y calculate real line height */
7960 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7961 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7962 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7967 int start_charpos
, i
;
7969 /* Start at the beginning of the screen line containing IT's
7970 position. This may actually move vertically backwards,
7971 in case of overlays, so adjust dvpos accordingly. */
7973 move_it_vertically_backward (it
, 0);
7976 /* Go back -DVPOS visible lines and reseat the iterator there. */
7977 start_charpos
= IT_CHARPOS (*it
);
7978 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7979 back_to_previous_visible_line_start (it
);
7980 reseat (it
, it
->current
.pos
, 1);
7982 /* Move further back if we end up in a string or an image. */
7983 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7985 /* First try to move to start of display line. */
7987 move_it_vertically_backward (it
, 0);
7989 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7991 /* If start of line is still in string or image,
7992 move further back. */
7993 back_to_previous_visible_line_start (it
);
7994 reseat (it
, it
->current
.pos
, 1);
7998 it
->current_x
= it
->hpos
= 0;
8000 /* Above call may have moved too far if continuation lines
8001 are involved. Scan forward and see if it did. */
8003 it2
.vpos
= it2
.current_y
= 0;
8004 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8005 it
->vpos
-= it2
.vpos
;
8006 it
->current_y
-= it2
.current_y
;
8007 it
->current_x
= it
->hpos
= 0;
8009 /* If we moved too far back, move IT some lines forward. */
8010 if (it2
.vpos
> -dvpos
)
8012 int delta
= it2
.vpos
+ dvpos
;
8014 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8015 /* Move back again if we got too far ahead. */
8016 if (IT_CHARPOS (*it
) >= start_charpos
)
8022 /* Return 1 if IT points into the middle of a display vector. */
8025 in_display_vector_p (it
)
8028 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8029 && it
->current
.dpvec_index
> 0
8030 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8034 /***********************************************************************
8036 ***********************************************************************/
8039 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8043 add_to_log (format
, arg1
, arg2
)
8045 Lisp_Object arg1
, arg2
;
8047 Lisp_Object args
[3];
8048 Lisp_Object msg
, fmt
;
8051 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8054 /* Do nothing if called asynchronously. Inserting text into
8055 a buffer may call after-change-functions and alike and
8056 that would means running Lisp asynchronously. */
8057 if (handling_signal
)
8061 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8063 args
[0] = fmt
= build_string (format
);
8066 msg
= Fformat (3, args
);
8068 len
= SBYTES (msg
) + 1;
8069 SAFE_ALLOCA (buffer
, char *, len
);
8070 bcopy (SDATA (msg
), buffer
, len
);
8072 message_dolog (buffer
, len
- 1, 1, 0);
8079 /* Output a newline in the *Messages* buffer if "needs" one. */
8082 message_log_maybe_newline ()
8084 if (message_log_need_newline
)
8085 message_dolog ("", 0, 1, 0);
8089 /* Add a string M of length NBYTES to the message log, optionally
8090 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8091 nonzero, means interpret the contents of M as multibyte. This
8092 function calls low-level routines in order to bypass text property
8093 hooks, etc. which might not be safe to run.
8095 This may GC (insert may run before/after change hooks),
8096 so the buffer M must NOT point to a Lisp string. */
8099 message_dolog (m
, nbytes
, nlflag
, multibyte
)
8101 int nbytes
, nlflag
, multibyte
;
8103 if (!NILP (Vmemory_full
))
8106 if (!NILP (Vmessage_log_max
))
8108 struct buffer
*oldbuf
;
8109 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8110 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8111 int point_at_end
= 0;
8113 Lisp_Object old_deactivate_mark
, tem
;
8114 struct gcpro gcpro1
;
8116 old_deactivate_mark
= Vdeactivate_mark
;
8117 oldbuf
= current_buffer
;
8118 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8119 current_buffer
->undo_list
= Qt
;
8121 oldpoint
= message_dolog_marker1
;
8122 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8123 oldbegv
= message_dolog_marker2
;
8124 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8125 oldzv
= message_dolog_marker3
;
8126 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8127 GCPRO1 (old_deactivate_mark
);
8135 BEGV_BYTE
= BEG_BYTE
;
8138 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8140 /* Insert the string--maybe converting multibyte to single byte
8141 or vice versa, so that all the text fits the buffer. */
8143 && NILP (current_buffer
->enable_multibyte_characters
))
8145 int i
, c
, char_bytes
;
8146 unsigned char work
[1];
8148 /* Convert a multibyte string to single-byte
8149 for the *Message* buffer. */
8150 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8152 c
= string_char_and_length (m
+ i
, &char_bytes
);
8153 work
[0] = (ASCII_CHAR_P (c
)
8155 : multibyte_char_to_unibyte (c
, Qnil
));
8156 insert_1_both (work
, 1, 1, 1, 0, 0);
8159 else if (! multibyte
8160 && ! NILP (current_buffer
->enable_multibyte_characters
))
8162 int i
, c
, char_bytes
;
8163 unsigned char *msg
= (unsigned char *) m
;
8164 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8165 /* Convert a single-byte string to multibyte
8166 for the *Message* buffer. */
8167 for (i
= 0; i
< nbytes
; i
++)
8170 MAKE_CHAR_MULTIBYTE (c
);
8171 char_bytes
= CHAR_STRING (c
, str
);
8172 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8176 insert_1 (m
, nbytes
, 1, 0, 0);
8180 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8181 insert_1 ("\n", 1, 1, 0, 0);
8183 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8185 this_bol_byte
= PT_BYTE
;
8187 /* See if this line duplicates the previous one.
8188 If so, combine duplicates. */
8191 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8193 prev_bol_byte
= PT_BYTE
;
8195 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8196 this_bol
, this_bol_byte
);
8199 del_range_both (prev_bol
, prev_bol_byte
,
8200 this_bol
, this_bol_byte
, 0);
8206 /* If you change this format, don't forget to also
8207 change message_log_check_duplicate. */
8208 sprintf (dupstr
, " [%d times]", dup
);
8209 duplen
= strlen (dupstr
);
8210 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8211 insert_1 (dupstr
, duplen
, 1, 0, 1);
8216 /* If we have more than the desired maximum number of lines
8217 in the *Messages* buffer now, delete the oldest ones.
8218 This is safe because we don't have undo in this buffer. */
8220 if (NATNUMP (Vmessage_log_max
))
8222 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8223 -XFASTINT (Vmessage_log_max
) - 1, 0);
8224 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8227 BEGV
= XMARKER (oldbegv
)->charpos
;
8228 BEGV_BYTE
= marker_byte_position (oldbegv
);
8237 ZV
= XMARKER (oldzv
)->charpos
;
8238 ZV_BYTE
= marker_byte_position (oldzv
);
8242 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8244 /* We can't do Fgoto_char (oldpoint) because it will run some
8246 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8247 XMARKER (oldpoint
)->bytepos
);
8250 unchain_marker (XMARKER (oldpoint
));
8251 unchain_marker (XMARKER (oldbegv
));
8252 unchain_marker (XMARKER (oldzv
));
8254 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8255 set_buffer_internal (oldbuf
);
8257 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8258 message_log_need_newline
= !nlflag
;
8259 Vdeactivate_mark
= old_deactivate_mark
;
8264 /* We are at the end of the buffer after just having inserted a newline.
8265 (Note: We depend on the fact we won't be crossing the gap.)
8266 Check to see if the most recent message looks a lot like the previous one.
8267 Return 0 if different, 1 if the new one should just replace it, or a
8268 value N > 1 if we should also append " [N times]". */
8271 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
8272 int prev_bol
, this_bol
;
8273 int prev_bol_byte
, this_bol_byte
;
8276 int len
= Z_BYTE
- 1 - this_bol_byte
;
8278 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8279 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8281 for (i
= 0; i
< len
; i
++)
8283 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8291 if (*p1
++ == ' ' && *p1
++ == '[')
8294 while (*p1
>= '0' && *p1
<= '9')
8295 n
= n
* 10 + *p1
++ - '0';
8296 if (strncmp (p1
, " times]\n", 8) == 0)
8303 /* Display an echo area message M with a specified length of NBYTES
8304 bytes. The string may include null characters. If M is 0, clear
8305 out any existing message, and let the mini-buffer text show
8308 This may GC, so the buffer M must NOT point to a Lisp string. */
8311 message2 (m
, nbytes
, multibyte
)
8316 /* First flush out any partial line written with print. */
8317 message_log_maybe_newline ();
8319 message_dolog (m
, nbytes
, 1, multibyte
);
8320 message2_nolog (m
, nbytes
, multibyte
);
8324 /* The non-logging counterpart of message2. */
8327 message2_nolog (m
, nbytes
, multibyte
)
8329 int nbytes
, multibyte
;
8331 struct frame
*sf
= SELECTED_FRAME ();
8332 message_enable_multibyte
= multibyte
;
8334 if (FRAME_INITIAL_P (sf
))
8336 if (noninteractive_need_newline
)
8337 putc ('\n', stderr
);
8338 noninteractive_need_newline
= 0;
8340 fwrite (m
, nbytes
, 1, stderr
);
8341 if (cursor_in_echo_area
== 0)
8342 fprintf (stderr
, "\n");
8345 /* A null message buffer means that the frame hasn't really been
8346 initialized yet. Error messages get reported properly by
8347 cmd_error, so this must be just an informative message; toss it. */
8348 else if (INTERACTIVE
8349 && sf
->glyphs_initialized_p
8350 && FRAME_MESSAGE_BUF (sf
))
8352 Lisp_Object mini_window
;
8355 /* Get the frame containing the mini-buffer
8356 that the selected frame is using. */
8357 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8358 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8360 FRAME_SAMPLE_VISIBILITY (f
);
8361 if (FRAME_VISIBLE_P (sf
)
8362 && ! FRAME_VISIBLE_P (f
))
8363 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8367 set_message (m
, Qnil
, nbytes
, multibyte
);
8368 if (minibuffer_auto_raise
)
8369 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8372 clear_message (1, 1);
8374 do_pending_window_change (0);
8375 echo_area_display (1);
8376 do_pending_window_change (0);
8377 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8378 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8383 /* Display an echo area message M with a specified length of NBYTES
8384 bytes. The string may include null characters. If M is not a
8385 string, clear out any existing message, and let the mini-buffer
8388 This function cancels echoing. */
8391 message3 (m
, nbytes
, multibyte
)
8396 struct gcpro gcpro1
;
8399 clear_message (1,1);
8402 /* First flush out any partial line written with print. */
8403 message_log_maybe_newline ();
8409 SAFE_ALLOCA (buffer
, char *, nbytes
);
8410 bcopy (SDATA (m
), buffer
, nbytes
);
8411 message_dolog (buffer
, nbytes
, 1, multibyte
);
8414 message3_nolog (m
, nbytes
, multibyte
);
8420 /* The non-logging version of message3.
8421 This does not cancel echoing, because it is used for echoing.
8422 Perhaps we need to make a separate function for echoing
8423 and make this cancel echoing. */
8426 message3_nolog (m
, nbytes
, multibyte
)
8428 int nbytes
, multibyte
;
8430 struct frame
*sf
= SELECTED_FRAME ();
8431 message_enable_multibyte
= multibyte
;
8433 if (FRAME_INITIAL_P (sf
))
8435 if (noninteractive_need_newline
)
8436 putc ('\n', stderr
);
8437 noninteractive_need_newline
= 0;
8439 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8440 if (cursor_in_echo_area
== 0)
8441 fprintf (stderr
, "\n");
8444 /* A null message buffer means that the frame hasn't really been
8445 initialized yet. Error messages get reported properly by
8446 cmd_error, so this must be just an informative message; toss it. */
8447 else if (INTERACTIVE
8448 && sf
->glyphs_initialized_p
8449 && FRAME_MESSAGE_BUF (sf
))
8451 Lisp_Object mini_window
;
8455 /* Get the frame containing the mini-buffer
8456 that the selected frame is using. */
8457 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8458 frame
= XWINDOW (mini_window
)->frame
;
8461 FRAME_SAMPLE_VISIBILITY (f
);
8462 if (FRAME_VISIBLE_P (sf
)
8463 && !FRAME_VISIBLE_P (f
))
8464 Fmake_frame_visible (frame
);
8466 if (STRINGP (m
) && SCHARS (m
) > 0)
8468 set_message (NULL
, m
, nbytes
, multibyte
);
8469 if (minibuffer_auto_raise
)
8470 Fraise_frame (frame
);
8471 /* Assume we are not echoing.
8472 (If we are, echo_now will override this.) */
8473 echo_message_buffer
= Qnil
;
8476 clear_message (1, 1);
8478 do_pending_window_change (0);
8479 echo_area_display (1);
8480 do_pending_window_change (0);
8481 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8482 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8487 /* Display a null-terminated echo area message M. If M is 0, clear
8488 out any existing message, and let the mini-buffer text show through.
8490 The buffer M must continue to exist until after the echo area gets
8491 cleared or some other message gets displayed there. Do not pass
8492 text that is stored in a Lisp string. Do not pass text in a buffer
8493 that was alloca'd. */
8499 message2 (m
, (m
? strlen (m
) : 0), 0);
8503 /* The non-logging counterpart of message1. */
8509 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8512 /* Display a message M which contains a single %s
8513 which gets replaced with STRING. */
8516 message_with_string (m
, string
, log
)
8521 CHECK_STRING (string
);
8527 if (noninteractive_need_newline
)
8528 putc ('\n', stderr
);
8529 noninteractive_need_newline
= 0;
8530 fprintf (stderr
, m
, SDATA (string
));
8531 if (!cursor_in_echo_area
)
8532 fprintf (stderr
, "\n");
8536 else if (INTERACTIVE
)
8538 /* The frame whose minibuffer we're going to display the message on.
8539 It may be larger than the selected frame, so we need
8540 to use its buffer, not the selected frame's buffer. */
8541 Lisp_Object mini_window
;
8542 struct frame
*f
, *sf
= SELECTED_FRAME ();
8544 /* Get the frame containing the minibuffer
8545 that the selected frame is using. */
8546 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8547 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8549 /* A null message buffer means that the frame hasn't really been
8550 initialized yet. Error messages get reported properly by
8551 cmd_error, so this must be just an informative message; toss it. */
8552 if (FRAME_MESSAGE_BUF (f
))
8554 Lisp_Object args
[2], message
;
8555 struct gcpro gcpro1
, gcpro2
;
8557 args
[0] = build_string (m
);
8558 args
[1] = message
= string
;
8559 GCPRO2 (args
[0], message
);
8562 message
= Fformat (2, args
);
8565 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8567 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8571 /* Print should start at the beginning of the message
8572 buffer next time. */
8573 message_buf_print
= 0;
8579 /* Dump an informative message to the minibuf. If M is 0, clear out
8580 any existing message, and let the mini-buffer text show through. */
8584 message (m
, a1
, a2
, a3
)
8586 EMACS_INT a1
, a2
, a3
;
8592 if (noninteractive_need_newline
)
8593 putc ('\n', stderr
);
8594 noninteractive_need_newline
= 0;
8595 fprintf (stderr
, m
, a1
, a2
, a3
);
8596 if (cursor_in_echo_area
== 0)
8597 fprintf (stderr
, "\n");
8601 else if (INTERACTIVE
)
8603 /* The frame whose mini-buffer we're going to display the message
8604 on. It may be larger than the selected frame, so we need to
8605 use its buffer, not the selected frame's buffer. */
8606 Lisp_Object mini_window
;
8607 struct frame
*f
, *sf
= SELECTED_FRAME ();
8609 /* Get the frame containing the mini-buffer
8610 that the selected frame is using. */
8611 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8612 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8614 /* A null message buffer means that the frame hasn't really been
8615 initialized yet. Error messages get reported properly by
8616 cmd_error, so this must be just an informative message; toss
8618 if (FRAME_MESSAGE_BUF (f
))
8628 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8629 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8631 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8636 /* Print should start at the beginning of the message
8637 buffer next time. */
8638 message_buf_print
= 0;
8644 /* The non-logging version of message. */
8647 message_nolog (m
, a1
, a2
, a3
)
8649 EMACS_INT a1
, a2
, a3
;
8651 Lisp_Object old_log_max
;
8652 old_log_max
= Vmessage_log_max
;
8653 Vmessage_log_max
= Qnil
;
8654 message (m
, a1
, a2
, a3
);
8655 Vmessage_log_max
= old_log_max
;
8659 /* Display the current message in the current mini-buffer. This is
8660 only called from error handlers in process.c, and is not time
8666 if (!NILP (echo_area_buffer
[0]))
8669 string
= Fcurrent_message ();
8670 message3 (string
, SBYTES (string
),
8671 !NILP (current_buffer
->enable_multibyte_characters
));
8676 /* Make sure echo area buffers in `echo_buffers' are live.
8677 If they aren't, make new ones. */
8680 ensure_echo_area_buffers ()
8684 for (i
= 0; i
< 2; ++i
)
8685 if (!BUFFERP (echo_buffer
[i
])
8686 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8689 Lisp_Object old_buffer
;
8692 old_buffer
= echo_buffer
[i
];
8693 sprintf (name
, " *Echo Area %d*", i
);
8694 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8695 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8696 /* to force word wrap in echo area -
8697 it was decided to postpone this*/
8698 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8700 for (j
= 0; j
< 2; ++j
)
8701 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8702 echo_area_buffer
[j
] = echo_buffer
[i
];
8707 /* Call FN with args A1..A4 with either the current or last displayed
8708 echo_area_buffer as current buffer.
8710 WHICH zero means use the current message buffer
8711 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8712 from echo_buffer[] and clear it.
8714 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8715 suitable buffer from echo_buffer[] and clear it.
8717 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8718 that the current message becomes the last displayed one, make
8719 choose a suitable buffer for echo_area_buffer[0], and clear it.
8721 Value is what FN returns. */
8724 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8727 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8733 int this_one
, the_other
, clear_buffer_p
, rc
;
8734 int count
= SPECPDL_INDEX ();
8736 /* If buffers aren't live, make new ones. */
8737 ensure_echo_area_buffers ();
8742 this_one
= 0, the_other
= 1;
8744 this_one
= 1, the_other
= 0;
8747 this_one
= 0, the_other
= 1;
8750 /* We need a fresh one in case the current echo buffer equals
8751 the one containing the last displayed echo area message. */
8752 if (!NILP (echo_area_buffer
[this_one
])
8753 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8754 echo_area_buffer
[this_one
] = Qnil
;
8757 /* Choose a suitable buffer from echo_buffer[] is we don't
8759 if (NILP (echo_area_buffer
[this_one
]))
8761 echo_area_buffer
[this_one
]
8762 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8763 ? echo_buffer
[the_other
]
8764 : echo_buffer
[this_one
]);
8768 buffer
= echo_area_buffer
[this_one
];
8770 /* Don't get confused by reusing the buffer used for echoing
8771 for a different purpose. */
8772 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8775 record_unwind_protect (unwind_with_echo_area_buffer
,
8776 with_echo_area_buffer_unwind_data (w
));
8778 /* Make the echo area buffer current. Note that for display
8779 purposes, it is not necessary that the displayed window's buffer
8780 == current_buffer, except for text property lookup. So, let's
8781 only set that buffer temporarily here without doing a full
8782 Fset_window_buffer. We must also change w->pointm, though,
8783 because otherwise an assertions in unshow_buffer fails, and Emacs
8785 set_buffer_internal_1 (XBUFFER (buffer
));
8789 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8792 current_buffer
->undo_list
= Qt
;
8793 current_buffer
->read_only
= Qnil
;
8794 specbind (Qinhibit_read_only
, Qt
);
8795 specbind (Qinhibit_modification_hooks
, Qt
);
8797 if (clear_buffer_p
&& Z
> BEG
)
8800 xassert (BEGV
>= BEG
);
8801 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8803 rc
= fn (a1
, a2
, a3
, a4
);
8805 xassert (BEGV
>= BEG
);
8806 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8808 unbind_to (count
, Qnil
);
8813 /* Save state that should be preserved around the call to the function
8814 FN called in with_echo_area_buffer. */
8817 with_echo_area_buffer_unwind_data (w
)
8821 Lisp_Object vector
, tmp
;
8823 /* Reduce consing by keeping one vector in
8824 Vwith_echo_area_save_vector. */
8825 vector
= Vwith_echo_area_save_vector
;
8826 Vwith_echo_area_save_vector
= Qnil
;
8829 vector
= Fmake_vector (make_number (7), Qnil
);
8831 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8832 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8833 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8837 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8838 ASET (vector
, i
, w
->buffer
); ++i
;
8839 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8840 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8845 for (; i
< end
; ++i
)
8846 ASET (vector
, i
, Qnil
);
8849 xassert (i
== ASIZE (vector
));
8854 /* Restore global state from VECTOR which was created by
8855 with_echo_area_buffer_unwind_data. */
8858 unwind_with_echo_area_buffer (vector
)
8861 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8862 Vdeactivate_mark
= AREF (vector
, 1);
8863 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8865 if (WINDOWP (AREF (vector
, 3)))
8868 Lisp_Object buffer
, charpos
, bytepos
;
8870 w
= XWINDOW (AREF (vector
, 3));
8871 buffer
= AREF (vector
, 4);
8872 charpos
= AREF (vector
, 5);
8873 bytepos
= AREF (vector
, 6);
8876 set_marker_both (w
->pointm
, buffer
,
8877 XFASTINT (charpos
), XFASTINT (bytepos
));
8880 Vwith_echo_area_save_vector
= vector
;
8885 /* Set up the echo area for use by print functions. MULTIBYTE_P
8886 non-zero means we will print multibyte. */
8889 setup_echo_area_for_printing (multibyte_p
)
8892 /* If we can't find an echo area any more, exit. */
8893 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8896 ensure_echo_area_buffers ();
8898 if (!message_buf_print
)
8900 /* A message has been output since the last time we printed.
8901 Choose a fresh echo area buffer. */
8902 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8903 echo_area_buffer
[0] = echo_buffer
[1];
8905 echo_area_buffer
[0] = echo_buffer
[0];
8907 /* Switch to that buffer and clear it. */
8908 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8909 current_buffer
->truncate_lines
= Qnil
;
8913 int count
= SPECPDL_INDEX ();
8914 specbind (Qinhibit_read_only
, Qt
);
8915 /* Note that undo recording is always disabled. */
8917 unbind_to (count
, Qnil
);
8919 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8921 /* Set up the buffer for the multibyteness we need. */
8923 != !NILP (current_buffer
->enable_multibyte_characters
))
8924 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8926 /* Raise the frame containing the echo area. */
8927 if (minibuffer_auto_raise
)
8929 struct frame
*sf
= SELECTED_FRAME ();
8930 Lisp_Object mini_window
;
8931 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8932 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8935 message_log_maybe_newline ();
8936 message_buf_print
= 1;
8940 if (NILP (echo_area_buffer
[0]))
8942 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8943 echo_area_buffer
[0] = echo_buffer
[1];
8945 echo_area_buffer
[0] = echo_buffer
[0];
8948 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8950 /* Someone switched buffers between print requests. */
8951 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8952 current_buffer
->truncate_lines
= Qnil
;
8958 /* Display an echo area message in window W. Value is non-zero if W's
8959 height is changed. If display_last_displayed_message_p is
8960 non-zero, display the message that was last displayed, otherwise
8961 display the current message. */
8964 display_echo_area (w
)
8967 int i
, no_message_p
, window_height_changed_p
, count
;
8969 /* Temporarily disable garbage collections while displaying the echo
8970 area. This is done because a GC can print a message itself.
8971 That message would modify the echo area buffer's contents while a
8972 redisplay of the buffer is going on, and seriously confuse
8974 count
= inhibit_garbage_collection ();
8976 /* If there is no message, we must call display_echo_area_1
8977 nevertheless because it resizes the window. But we will have to
8978 reset the echo_area_buffer in question to nil at the end because
8979 with_echo_area_buffer will sets it to an empty buffer. */
8980 i
= display_last_displayed_message_p
? 1 : 0;
8981 no_message_p
= NILP (echo_area_buffer
[i
]);
8983 window_height_changed_p
8984 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8985 display_echo_area_1
,
8986 (EMACS_INT
) w
, Qnil
, 0, 0);
8989 echo_area_buffer
[i
] = Qnil
;
8991 unbind_to (count
, Qnil
);
8992 return window_height_changed_p
;
8996 /* Helper for display_echo_area. Display the current buffer which
8997 contains the current echo area message in window W, a mini-window,
8998 a pointer to which is passed in A1. A2..A4 are currently not used.
8999 Change the height of W so that all of the message is displayed.
9000 Value is non-zero if height of W was changed. */
9003 display_echo_area_1 (a1
, a2
, a3
, a4
)
9008 struct window
*w
= (struct window
*) a1
;
9010 struct text_pos start
;
9011 int window_height_changed_p
= 0;
9013 /* Do this before displaying, so that we have a large enough glyph
9014 matrix for the display. If we can't get enough space for the
9015 whole text, display the last N lines. That works by setting w->start. */
9016 window_height_changed_p
= resize_mini_window (w
, 0);
9018 /* Use the starting position chosen by resize_mini_window. */
9019 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9022 clear_glyph_matrix (w
->desired_matrix
);
9023 XSETWINDOW (window
, w
);
9024 try_window (window
, start
, 0);
9026 return window_height_changed_p
;
9030 /* Resize the echo area window to exactly the size needed for the
9031 currently displayed message, if there is one. If a mini-buffer
9032 is active, don't shrink it. */
9035 resize_echo_area_exactly ()
9037 if (BUFFERP (echo_area_buffer
[0])
9038 && WINDOWP (echo_area_window
))
9040 struct window
*w
= XWINDOW (echo_area_window
);
9042 Lisp_Object resize_exactly
;
9044 if (minibuf_level
== 0)
9045 resize_exactly
= Qt
;
9047 resize_exactly
= Qnil
;
9049 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9050 (EMACS_INT
) w
, resize_exactly
, 0, 0);
9053 ++windows_or_buffers_changed
;
9054 ++update_mode_lines
;
9055 redisplay_internal (0);
9061 /* Callback function for with_echo_area_buffer, when used from
9062 resize_echo_area_exactly. A1 contains a pointer to the window to
9063 resize, EXACTLY non-nil means resize the mini-window exactly to the
9064 size of the text displayed. A3 and A4 are not used. Value is what
9065 resize_mini_window returns. */
9068 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
9070 Lisp_Object exactly
;
9073 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
9077 /* Resize mini-window W to fit the size of its contents. EXACT_P
9078 means size the window exactly to the size needed. Otherwise, it's
9079 only enlarged until W's buffer is empty.
9081 Set W->start to the right place to begin display. If the whole
9082 contents fit, start at the beginning. Otherwise, start so as
9083 to make the end of the contents appear. This is particularly
9084 important for y-or-n-p, but seems desirable generally.
9086 Value is non-zero if the window height has been changed. */
9089 resize_mini_window (w
, exact_p
)
9093 struct frame
*f
= XFRAME (w
->frame
);
9094 int window_height_changed_p
= 0;
9096 xassert (MINI_WINDOW_P (w
));
9098 /* By default, start display at the beginning. */
9099 set_marker_both (w
->start
, w
->buffer
,
9100 BUF_BEGV (XBUFFER (w
->buffer
)),
9101 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9103 /* Don't resize windows while redisplaying a window; it would
9104 confuse redisplay functions when the size of the window they are
9105 displaying changes from under them. Such a resizing can happen,
9106 for instance, when which-func prints a long message while
9107 we are running fontification-functions. We're running these
9108 functions with safe_call which binds inhibit-redisplay to t. */
9109 if (!NILP (Vinhibit_redisplay
))
9112 /* Nil means don't try to resize. */
9113 if (NILP (Vresize_mini_windows
)
9114 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9117 if (!FRAME_MINIBUF_ONLY_P (f
))
9120 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9121 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9122 int height
, max_height
;
9123 int unit
= FRAME_LINE_HEIGHT (f
);
9124 struct text_pos start
;
9125 struct buffer
*old_current_buffer
= NULL
;
9127 if (current_buffer
!= XBUFFER (w
->buffer
))
9129 old_current_buffer
= current_buffer
;
9130 set_buffer_internal (XBUFFER (w
->buffer
));
9133 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9135 /* Compute the max. number of lines specified by the user. */
9136 if (FLOATP (Vmax_mini_window_height
))
9137 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9138 else if (INTEGERP (Vmax_mini_window_height
))
9139 max_height
= XINT (Vmax_mini_window_height
);
9141 max_height
= total_height
/ 4;
9143 /* Correct that max. height if it's bogus. */
9144 max_height
= max (1, max_height
);
9145 max_height
= min (total_height
, max_height
);
9147 /* Find out the height of the text in the window. */
9148 if (it
.line_wrap
== TRUNCATE
)
9153 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9154 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9155 height
= it
.current_y
+ last_height
;
9157 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9158 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9159 height
= (height
+ unit
- 1) / unit
;
9162 /* Compute a suitable window start. */
9163 if (height
> max_height
)
9165 height
= max_height
;
9166 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9167 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9168 start
= it
.current
.pos
;
9171 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9172 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9174 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9176 /* Let it grow only, until we display an empty message, in which
9177 case the window shrinks again. */
9178 if (height
> WINDOW_TOTAL_LINES (w
))
9180 int old_height
= WINDOW_TOTAL_LINES (w
);
9181 freeze_window_starts (f
, 1);
9182 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9183 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9185 else if (height
< WINDOW_TOTAL_LINES (w
)
9186 && (exact_p
|| BEGV
== ZV
))
9188 int old_height
= WINDOW_TOTAL_LINES (w
);
9189 freeze_window_starts (f
, 0);
9190 shrink_mini_window (w
);
9191 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9196 /* Always resize to exact size needed. */
9197 if (height
> WINDOW_TOTAL_LINES (w
))
9199 int old_height
= WINDOW_TOTAL_LINES (w
);
9200 freeze_window_starts (f
, 1);
9201 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9202 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9204 else if (height
< WINDOW_TOTAL_LINES (w
))
9206 int old_height
= WINDOW_TOTAL_LINES (w
);
9207 freeze_window_starts (f
, 0);
9208 shrink_mini_window (w
);
9212 freeze_window_starts (f
, 1);
9213 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9216 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9220 if (old_current_buffer
)
9221 set_buffer_internal (old_current_buffer
);
9224 return window_height_changed_p
;
9228 /* Value is the current message, a string, or nil if there is no
9236 if (!BUFFERP (echo_area_buffer
[0]))
9240 with_echo_area_buffer (0, 0, current_message_1
,
9241 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9243 echo_area_buffer
[0] = Qnil
;
9251 current_message_1 (a1
, a2
, a3
, a4
)
9256 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9259 *msg
= make_buffer_string (BEG
, Z
, 1);
9266 /* Push the current message on Vmessage_stack for later restauration
9267 by restore_message. Value is non-zero if the current message isn't
9268 empty. This is a relatively infrequent operation, so it's not
9269 worth optimizing. */
9275 msg
= current_message ();
9276 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9277 return STRINGP (msg
);
9281 /* Restore message display from the top of Vmessage_stack. */
9288 xassert (CONSP (Vmessage_stack
));
9289 msg
= XCAR (Vmessage_stack
);
9291 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9293 message3_nolog (msg
, 0, 0);
9297 /* Handler for record_unwind_protect calling pop_message. */
9300 pop_message_unwind (dummy
)
9307 /* Pop the top-most entry off Vmessage_stack. */
9312 xassert (CONSP (Vmessage_stack
));
9313 Vmessage_stack
= XCDR (Vmessage_stack
);
9317 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9318 exits. If the stack is not empty, we have a missing pop_message
9322 check_message_stack ()
9324 if (!NILP (Vmessage_stack
))
9329 /* Truncate to NCHARS what will be displayed in the echo area the next
9330 time we display it---but don't redisplay it now. */
9333 truncate_echo_area (nchars
)
9337 echo_area_buffer
[0] = Qnil
;
9338 /* A null message buffer means that the frame hasn't really been
9339 initialized yet. Error messages get reported properly by
9340 cmd_error, so this must be just an informative message; toss it. */
9341 else if (!noninteractive
9343 && !NILP (echo_area_buffer
[0]))
9345 struct frame
*sf
= SELECTED_FRAME ();
9346 if (FRAME_MESSAGE_BUF (sf
))
9347 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9352 /* Helper function for truncate_echo_area. Truncate the current
9353 message to at most NCHARS characters. */
9356 truncate_message_1 (nchars
, a2
, a3
, a4
)
9361 if (BEG
+ nchars
< Z
)
9362 del_range (BEG
+ nchars
, Z
);
9364 echo_area_buffer
[0] = Qnil
;
9369 /* Set the current message to a substring of S or STRING.
9371 If STRING is a Lisp string, set the message to the first NBYTES
9372 bytes from STRING. NBYTES zero means use the whole string. If
9373 STRING is multibyte, the message will be displayed multibyte.
9375 If S is not null, set the message to the first LEN bytes of S. LEN
9376 zero means use the whole string. MULTIBYTE_P non-zero means S is
9377 multibyte. Display the message multibyte in that case.
9379 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9380 to t before calling set_message_1 (which calls insert).
9384 set_message (s
, string
, nbytes
, multibyte_p
)
9387 int nbytes
, multibyte_p
;
9389 message_enable_multibyte
9390 = ((s
&& multibyte_p
)
9391 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9393 with_echo_area_buffer (0, -1, set_message_1
,
9394 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9395 message_buf_print
= 0;
9396 help_echo_showing_p
= 0;
9400 /* Helper function for set_message. Arguments have the same meaning
9401 as there, with A1 corresponding to S and A2 corresponding to STRING
9402 This function is called with the echo area buffer being
9406 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9409 EMACS_INT nbytes
, multibyte_p
;
9411 const char *s
= (const char *) a1
;
9412 Lisp_Object string
= a2
;
9414 /* Change multibyteness of the echo buffer appropriately. */
9415 if (message_enable_multibyte
9416 != !NILP (current_buffer
->enable_multibyte_characters
))
9417 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9419 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9421 /* Insert new message at BEG. */
9422 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9424 if (STRINGP (string
))
9429 nbytes
= SBYTES (string
);
9430 nchars
= string_byte_to_char (string
, nbytes
);
9432 /* This function takes care of single/multibyte conversion. We
9433 just have to ensure that the echo area buffer has the right
9434 setting of enable_multibyte_characters. */
9435 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9440 nbytes
= strlen (s
);
9442 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9444 /* Convert from multi-byte to single-byte. */
9446 unsigned char work
[1];
9448 /* Convert a multibyte string to single-byte. */
9449 for (i
= 0; i
< nbytes
; i
+= n
)
9451 c
= string_char_and_length (s
+ i
, &n
);
9452 work
[0] = (ASCII_CHAR_P (c
)
9454 : multibyte_char_to_unibyte (c
, Qnil
));
9455 insert_1_both (work
, 1, 1, 1, 0, 0);
9458 else if (!multibyte_p
9459 && !NILP (current_buffer
->enable_multibyte_characters
))
9461 /* Convert from single-byte to multi-byte. */
9463 const unsigned char *msg
= (const unsigned char *) s
;
9464 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9466 /* Convert a single-byte string to multibyte. */
9467 for (i
= 0; i
< nbytes
; i
++)
9470 MAKE_CHAR_MULTIBYTE (c
);
9471 n
= CHAR_STRING (c
, str
);
9472 insert_1_both (str
, 1, n
, 1, 0, 0);
9476 insert_1 (s
, nbytes
, 1, 0, 0);
9483 /* Clear messages. CURRENT_P non-zero means clear the current
9484 message. LAST_DISPLAYED_P non-zero means clear the message
9488 clear_message (current_p
, last_displayed_p
)
9489 int current_p
, last_displayed_p
;
9493 echo_area_buffer
[0] = Qnil
;
9494 message_cleared_p
= 1;
9497 if (last_displayed_p
)
9498 echo_area_buffer
[1] = Qnil
;
9500 message_buf_print
= 0;
9503 /* Clear garbaged frames.
9505 This function is used where the old redisplay called
9506 redraw_garbaged_frames which in turn called redraw_frame which in
9507 turn called clear_frame. The call to clear_frame was a source of
9508 flickering. I believe a clear_frame is not necessary. It should
9509 suffice in the new redisplay to invalidate all current matrices,
9510 and ensure a complete redisplay of all windows. */
9513 clear_garbaged_frames ()
9517 Lisp_Object tail
, frame
;
9518 int changed_count
= 0;
9520 FOR_EACH_FRAME (tail
, frame
)
9522 struct frame
*f
= XFRAME (frame
);
9524 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9528 Fredraw_frame (frame
);
9529 f
->force_flush_display_p
= 1;
9531 clear_current_matrices (f
);
9540 ++windows_or_buffers_changed
;
9545 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9546 is non-zero update selected_frame. Value is non-zero if the
9547 mini-windows height has been changed. */
9550 echo_area_display (update_frame_p
)
9553 Lisp_Object mini_window
;
9556 int window_height_changed_p
= 0;
9557 struct frame
*sf
= SELECTED_FRAME ();
9559 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9560 w
= XWINDOW (mini_window
);
9561 f
= XFRAME (WINDOW_FRAME (w
));
9563 /* Don't display if frame is invisible or not yet initialized. */
9564 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9567 #ifdef HAVE_WINDOW_SYSTEM
9568 /* When Emacs starts, selected_frame may be the initial terminal
9569 frame. If we let this through, a message would be displayed on
9571 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9573 #endif /* HAVE_WINDOW_SYSTEM */
9575 /* Redraw garbaged frames. */
9577 clear_garbaged_frames ();
9579 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9581 echo_area_window
= mini_window
;
9582 window_height_changed_p
= display_echo_area (w
);
9583 w
->must_be_updated_p
= 1;
9585 /* Update the display, unless called from redisplay_internal.
9586 Also don't update the screen during redisplay itself. The
9587 update will happen at the end of redisplay, and an update
9588 here could cause confusion. */
9589 if (update_frame_p
&& !redisplaying_p
)
9593 /* If the display update has been interrupted by pending
9594 input, update mode lines in the frame. Due to the
9595 pending input, it might have been that redisplay hasn't
9596 been called, so that mode lines above the echo area are
9597 garbaged. This looks odd, so we prevent it here. */
9598 if (!display_completed
)
9599 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9601 if (window_height_changed_p
9602 /* Don't do this if Emacs is shutting down. Redisplay
9603 needs to run hooks. */
9604 && !NILP (Vrun_hooks
))
9606 /* Must update other windows. Likewise as in other
9607 cases, don't let this update be interrupted by
9609 int count
= SPECPDL_INDEX ();
9610 specbind (Qredisplay_dont_pause
, Qt
);
9611 windows_or_buffers_changed
= 1;
9612 redisplay_internal (0);
9613 unbind_to (count
, Qnil
);
9615 else if (FRAME_WINDOW_P (f
) && n
== 0)
9617 /* Window configuration is the same as before.
9618 Can do with a display update of the echo area,
9619 unless we displayed some mode lines. */
9620 update_single_window (w
, 1);
9621 FRAME_RIF (f
)->flush_display (f
);
9624 update_frame (f
, 1, 1);
9626 /* If cursor is in the echo area, make sure that the next
9627 redisplay displays the minibuffer, so that the cursor will
9628 be replaced with what the minibuffer wants. */
9629 if (cursor_in_echo_area
)
9630 ++windows_or_buffers_changed
;
9633 else if (!EQ (mini_window
, selected_window
))
9634 windows_or_buffers_changed
++;
9636 /* Last displayed message is now the current message. */
9637 echo_area_buffer
[1] = echo_area_buffer
[0];
9638 /* Inform read_char that we're not echoing. */
9639 echo_message_buffer
= Qnil
;
9641 /* Prevent redisplay optimization in redisplay_internal by resetting
9642 this_line_start_pos. This is done because the mini-buffer now
9643 displays the message instead of its buffer text. */
9644 if (EQ (mini_window
, selected_window
))
9645 CHARPOS (this_line_start_pos
) = 0;
9647 return window_height_changed_p
;
9652 /***********************************************************************
9653 Mode Lines and Frame Titles
9654 ***********************************************************************/
9656 /* A buffer for constructing non-propertized mode-line strings and
9657 frame titles in it; allocated from the heap in init_xdisp and
9658 resized as needed in store_mode_line_noprop_char. */
9660 static char *mode_line_noprop_buf
;
9662 /* The buffer's end, and a current output position in it. */
9664 static char *mode_line_noprop_buf_end
;
9665 static char *mode_line_noprop_ptr
;
9667 #define MODE_LINE_NOPROP_LEN(start) \
9668 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9671 MODE_LINE_DISPLAY
= 0,
9677 /* Alist that caches the results of :propertize.
9678 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9679 static Lisp_Object mode_line_proptrans_alist
;
9681 /* List of strings making up the mode-line. */
9682 static Lisp_Object mode_line_string_list
;
9684 /* Base face property when building propertized mode line string. */
9685 static Lisp_Object mode_line_string_face
;
9686 static Lisp_Object mode_line_string_face_prop
;
9689 /* Unwind data for mode line strings */
9691 static Lisp_Object Vmode_line_unwind_vector
;
9694 format_mode_line_unwind_data (struct buffer
*obuf
,
9698 Lisp_Object vector
, tmp
;
9700 /* Reduce consing by keeping one vector in
9701 Vwith_echo_area_save_vector. */
9702 vector
= Vmode_line_unwind_vector
;
9703 Vmode_line_unwind_vector
= Qnil
;
9706 vector
= Fmake_vector (make_number (8), Qnil
);
9708 ASET (vector
, 0, make_number (mode_line_target
));
9709 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9710 ASET (vector
, 2, mode_line_string_list
);
9711 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9712 ASET (vector
, 4, mode_line_string_face
);
9713 ASET (vector
, 5, mode_line_string_face_prop
);
9716 XSETBUFFER (tmp
, obuf
);
9719 ASET (vector
, 6, tmp
);
9720 ASET (vector
, 7, owin
);
9726 unwind_format_mode_line (vector
)
9729 mode_line_target
= XINT (AREF (vector
, 0));
9730 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9731 mode_line_string_list
= AREF (vector
, 2);
9732 if (! EQ (AREF (vector
, 3), Qt
))
9733 mode_line_proptrans_alist
= AREF (vector
, 3);
9734 mode_line_string_face
= AREF (vector
, 4);
9735 mode_line_string_face_prop
= AREF (vector
, 5);
9737 if (!NILP (AREF (vector
, 7)))
9738 /* Select window before buffer, since it may change the buffer. */
9739 Fselect_window (AREF (vector
, 7), Qt
);
9741 if (!NILP (AREF (vector
, 6)))
9743 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9744 ASET (vector
, 6, Qnil
);
9747 Vmode_line_unwind_vector
= vector
;
9752 /* Store a single character C for the frame title in mode_line_noprop_buf.
9753 Re-allocate mode_line_noprop_buf if necessary. */
9757 store_mode_line_noprop_char (char c
)
9759 store_mode_line_noprop_char (c
)
9763 /* If output position has reached the end of the allocated buffer,
9764 double the buffer's size. */
9765 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9767 int len
= MODE_LINE_NOPROP_LEN (0);
9768 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9769 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9770 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9771 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9774 *mode_line_noprop_ptr
++ = c
;
9778 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9779 mode_line_noprop_ptr. STR is the string to store. Do not copy
9780 characters that yield more columns than PRECISION; PRECISION <= 0
9781 means copy the whole string. Pad with spaces until FIELD_WIDTH
9782 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9783 pad. Called from display_mode_element when it is used to build a
9787 store_mode_line_noprop (str
, field_width
, precision
)
9788 const unsigned char *str
;
9789 int field_width
, precision
;
9794 /* Copy at most PRECISION chars from STR. */
9795 nbytes
= strlen (str
);
9796 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9798 store_mode_line_noprop_char (*str
++);
9800 /* Fill up with spaces until FIELD_WIDTH reached. */
9801 while (field_width
> 0
9804 store_mode_line_noprop_char (' ');
9811 /***********************************************************************
9813 ***********************************************************************/
9815 #ifdef HAVE_WINDOW_SYSTEM
9817 /* Set the title of FRAME, if it has changed. The title format is
9818 Vicon_title_format if FRAME is iconified, otherwise it is
9819 frame_title_format. */
9822 x_consider_frame_title (frame
)
9825 struct frame
*f
= XFRAME (frame
);
9827 if (FRAME_WINDOW_P (f
)
9828 || FRAME_MINIBUF_ONLY_P (f
)
9829 || f
->explicit_name
)
9831 /* Do we have more than one visible frame on this X display? */
9838 int count
= SPECPDL_INDEX ();
9840 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9842 Lisp_Object other_frame
= XCAR (tail
);
9843 struct frame
*tf
= XFRAME (other_frame
);
9846 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9847 && !FRAME_MINIBUF_ONLY_P (tf
)
9848 && !EQ (other_frame
, tip_frame
)
9849 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9853 /* Set global variable indicating that multiple frames exist. */
9854 multiple_frames
= CONSP (tail
);
9856 /* Switch to the buffer of selected window of the frame. Set up
9857 mode_line_target so that display_mode_element will output into
9858 mode_line_noprop_buf; then display the title. */
9859 record_unwind_protect (unwind_format_mode_line
,
9860 format_mode_line_unwind_data
9861 (current_buffer
, selected_window
, 0));
9863 Fselect_window (f
->selected_window
, Qt
);
9864 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9865 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9867 mode_line_target
= MODE_LINE_TITLE
;
9868 title_start
= MODE_LINE_NOPROP_LEN (0);
9869 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9870 NULL
, DEFAULT_FACE_ID
);
9871 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9872 len
= MODE_LINE_NOPROP_LEN (title_start
);
9873 title
= mode_line_noprop_buf
+ title_start
;
9874 unbind_to (count
, Qnil
);
9876 /* Set the title only if it's changed. This avoids consing in
9877 the common case where it hasn't. (If it turns out that we've
9878 already wasted too much time by walking through the list with
9879 display_mode_element, then we might need to optimize at a
9880 higher level than this.) */
9881 if (! STRINGP (f
->name
)
9882 || SBYTES (f
->name
) != len
9883 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9884 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9888 #endif /* not HAVE_WINDOW_SYSTEM */
9893 /***********************************************************************
9895 ***********************************************************************/
9898 /* Prepare for redisplay by updating menu-bar item lists when
9899 appropriate. This can call eval. */
9902 prepare_menu_bars ()
9905 struct gcpro gcpro1
, gcpro2
;
9907 Lisp_Object tooltip_frame
;
9909 #ifdef HAVE_WINDOW_SYSTEM
9910 tooltip_frame
= tip_frame
;
9912 tooltip_frame
= Qnil
;
9915 /* Update all frame titles based on their buffer names, etc. We do
9916 this before the menu bars so that the buffer-menu will show the
9917 up-to-date frame titles. */
9918 #ifdef HAVE_WINDOW_SYSTEM
9919 if (windows_or_buffers_changed
|| update_mode_lines
)
9921 Lisp_Object tail
, frame
;
9923 FOR_EACH_FRAME (tail
, frame
)
9926 if (!EQ (frame
, tooltip_frame
)
9927 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9928 x_consider_frame_title (frame
);
9931 #endif /* HAVE_WINDOW_SYSTEM */
9933 /* Update the menu bar item lists, if appropriate. This has to be
9934 done before any actual redisplay or generation of display lines. */
9935 all_windows
= (update_mode_lines
9936 || buffer_shared
> 1
9937 || windows_or_buffers_changed
);
9940 Lisp_Object tail
, frame
;
9941 int count
= SPECPDL_INDEX ();
9942 /* 1 means that update_menu_bar has run its hooks
9943 so any further calls to update_menu_bar shouldn't do so again. */
9944 int menu_bar_hooks_run
= 0;
9946 record_unwind_save_match_data ();
9948 FOR_EACH_FRAME (tail
, frame
)
9952 /* Ignore tooltip frame. */
9953 if (EQ (frame
, tooltip_frame
))
9956 /* If a window on this frame changed size, report that to
9957 the user and clear the size-change flag. */
9958 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9960 Lisp_Object functions
;
9962 /* Clear flag first in case we get an error below. */
9963 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9964 functions
= Vwindow_size_change_functions
;
9965 GCPRO2 (tail
, functions
);
9967 while (CONSP (functions
))
9969 if (!EQ (XCAR (functions
), Qt
))
9970 call1 (XCAR (functions
), frame
);
9971 functions
= XCDR (functions
);
9977 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9978 #ifdef HAVE_WINDOW_SYSTEM
9979 update_tool_bar (f
, 0);
9982 if (windows_or_buffers_changed
9984 ns_set_doc_edited (f
, Fbuffer_modified_p
9985 (XWINDOW (f
->selected_window
)->buffer
));
9990 unbind_to (count
, Qnil
);
9994 struct frame
*sf
= SELECTED_FRAME ();
9995 update_menu_bar (sf
, 1, 0);
9996 #ifdef HAVE_WINDOW_SYSTEM
9997 update_tool_bar (sf
, 1);
10001 /* Motif needs this. See comment in xmenu.c. Turn it off when
10002 pending_menu_activation is not defined. */
10003 #ifdef USE_X_TOOLKIT
10004 pending_menu_activation
= 0;
10009 /* Update the menu bar item list for frame F. This has to be done
10010 before we start to fill in any display lines, because it can call
10013 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10015 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10016 already ran the menu bar hooks for this redisplay, so there
10017 is no need to run them again. The return value is the
10018 updated value of this flag, to pass to the next call. */
10021 update_menu_bar (f
, save_match_data
, hooks_run
)
10023 int save_match_data
;
10026 Lisp_Object window
;
10027 register struct window
*w
;
10029 /* If called recursively during a menu update, do nothing. This can
10030 happen when, for instance, an activate-menubar-hook causes a
10032 if (inhibit_menubar_update
)
10035 window
= FRAME_SELECTED_WINDOW (f
);
10036 w
= XWINDOW (window
);
10038 if (FRAME_WINDOW_P (f
)
10040 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10041 || defined (HAVE_NS) || defined (USE_GTK)
10042 FRAME_EXTERNAL_MENU_BAR (f
)
10044 FRAME_MENU_BAR_LINES (f
) > 0
10046 : FRAME_MENU_BAR_LINES (f
) > 0)
10048 /* If the user has switched buffers or windows, we need to
10049 recompute to reflect the new bindings. But we'll
10050 recompute when update_mode_lines is set too; that means
10051 that people can use force-mode-line-update to request
10052 that the menu bar be recomputed. The adverse effect on
10053 the rest of the redisplay algorithm is about the same as
10054 windows_or_buffers_changed anyway. */
10055 if (windows_or_buffers_changed
10056 /* This used to test w->update_mode_line, but we believe
10057 there is no need to recompute the menu in that case. */
10058 || update_mode_lines
10059 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10060 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10061 != !NILP (w
->last_had_star
))
10062 || ((!NILP (Vtransient_mark_mode
)
10063 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10064 != !NILP (w
->region_showing
)))
10066 struct buffer
*prev
= current_buffer
;
10067 int count
= SPECPDL_INDEX ();
10069 specbind (Qinhibit_menubar_update
, Qt
);
10071 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10072 if (save_match_data
)
10073 record_unwind_save_match_data ();
10074 if (NILP (Voverriding_local_map_menu_flag
))
10076 specbind (Qoverriding_terminal_local_map
, Qnil
);
10077 specbind (Qoverriding_local_map
, Qnil
);
10082 /* Run the Lucid hook. */
10083 safe_run_hooks (Qactivate_menubar_hook
);
10085 /* If it has changed current-menubar from previous value,
10086 really recompute the menu-bar from the value. */
10087 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10088 call0 (Qrecompute_lucid_menubar
);
10090 safe_run_hooks (Qmenu_bar_update_hook
);
10095 XSETFRAME (Vmenu_updating_frame
, f
);
10096 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10098 /* Redisplay the menu bar in case we changed it. */
10099 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10100 || defined (HAVE_NS) || defined (USE_GTK)
10101 if (FRAME_WINDOW_P (f
))
10103 #if defined (HAVE_NS)
10104 /* All frames on Mac OS share the same menubar. So only
10105 the selected frame should be allowed to set it. */
10106 if (f
== SELECTED_FRAME ())
10108 set_frame_menubar (f
, 0, 0);
10111 /* On a terminal screen, the menu bar is an ordinary screen
10112 line, and this makes it get updated. */
10113 w
->update_mode_line
= Qt
;
10114 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10115 /* In the non-toolkit version, the menu bar is an ordinary screen
10116 line, and this makes it get updated. */
10117 w
->update_mode_line
= Qt
;
10118 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10120 unbind_to (count
, Qnil
);
10121 set_buffer_internal_1 (prev
);
10130 /***********************************************************************
10132 ***********************************************************************/
10134 #ifdef HAVE_WINDOW_SYSTEM
10137 Nominal cursor position -- where to draw output.
10138 HPOS and VPOS are window relative glyph matrix coordinates.
10139 X and Y are window relative pixel coordinates. */
10141 struct cursor_pos output_cursor
;
10145 Set the global variable output_cursor to CURSOR. All cursor
10146 positions are relative to updated_window. */
10149 set_output_cursor (cursor
)
10150 struct cursor_pos
*cursor
;
10152 output_cursor
.hpos
= cursor
->hpos
;
10153 output_cursor
.vpos
= cursor
->vpos
;
10154 output_cursor
.x
= cursor
->x
;
10155 output_cursor
.y
= cursor
->y
;
10160 Set a nominal cursor position.
10162 HPOS and VPOS are column/row positions in a window glyph matrix. X
10163 and Y are window text area relative pixel positions.
10165 If this is done during an update, updated_window will contain the
10166 window that is being updated and the position is the future output
10167 cursor position for that window. If updated_window is null, use
10168 selected_window and display the cursor at the given position. */
10171 x_cursor_to (vpos
, hpos
, y
, x
)
10172 int vpos
, hpos
, y
, x
;
10176 /* If updated_window is not set, work on selected_window. */
10177 if (updated_window
)
10178 w
= updated_window
;
10180 w
= XWINDOW (selected_window
);
10182 /* Set the output cursor. */
10183 output_cursor
.hpos
= hpos
;
10184 output_cursor
.vpos
= vpos
;
10185 output_cursor
.x
= x
;
10186 output_cursor
.y
= y
;
10188 /* If not called as part of an update, really display the cursor.
10189 This will also set the cursor position of W. */
10190 if (updated_window
== NULL
)
10193 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10194 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10195 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10200 #endif /* HAVE_WINDOW_SYSTEM */
10203 /***********************************************************************
10205 ***********************************************************************/
10207 #ifdef HAVE_WINDOW_SYSTEM
10209 /* Where the mouse was last time we reported a mouse event. */
10211 FRAME_PTR last_mouse_frame
;
10213 /* Tool-bar item index of the item on which a mouse button was pressed
10216 int last_tool_bar_item
;
10220 update_tool_bar_unwind (frame
)
10223 selected_frame
= frame
;
10227 /* Update the tool-bar item list for frame F. This has to be done
10228 before we start to fill in any display lines. Called from
10229 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10230 and restore it here. */
10233 update_tool_bar (f
, save_match_data
)
10235 int save_match_data
;
10237 #if defined (USE_GTK) || defined (HAVE_NS)
10238 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10240 int do_update
= WINDOWP (f
->tool_bar_window
)
10241 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10246 Lisp_Object window
;
10249 window
= FRAME_SELECTED_WINDOW (f
);
10250 w
= XWINDOW (window
);
10252 /* If the user has switched buffers or windows, we need to
10253 recompute to reflect the new bindings. But we'll
10254 recompute when update_mode_lines is set too; that means
10255 that people can use force-mode-line-update to request
10256 that the menu bar be recomputed. The adverse effect on
10257 the rest of the redisplay algorithm is about the same as
10258 windows_or_buffers_changed anyway. */
10259 if (windows_or_buffers_changed
10260 || !NILP (w
->update_mode_line
)
10261 || update_mode_lines
10262 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10263 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10264 != !NILP (w
->last_had_star
))
10265 || ((!NILP (Vtransient_mark_mode
)
10266 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10267 != !NILP (w
->region_showing
)))
10269 struct buffer
*prev
= current_buffer
;
10270 int count
= SPECPDL_INDEX ();
10271 Lisp_Object frame
, new_tool_bar
;
10272 int new_n_tool_bar
;
10273 struct gcpro gcpro1
;
10275 /* Set current_buffer to the buffer of the selected
10276 window of the frame, so that we get the right local
10278 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10280 /* Save match data, if we must. */
10281 if (save_match_data
)
10282 record_unwind_save_match_data ();
10284 /* Make sure that we don't accidentally use bogus keymaps. */
10285 if (NILP (Voverriding_local_map_menu_flag
))
10287 specbind (Qoverriding_terminal_local_map
, Qnil
);
10288 specbind (Qoverriding_local_map
, Qnil
);
10291 GCPRO1 (new_tool_bar
);
10293 /* We must temporarily set the selected frame to this frame
10294 before calling tool_bar_items, because the calculation of
10295 the tool-bar keymap uses the selected frame (see
10296 `tool-bar-make-keymap' in tool-bar.el). */
10297 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10298 XSETFRAME (frame
, f
);
10299 selected_frame
= frame
;
10301 /* Build desired tool-bar items from keymaps. */
10302 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10305 /* Redisplay the tool-bar if we changed it. */
10306 if (new_n_tool_bar
!= f
->n_tool_bar_items
10307 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10309 /* Redisplay that happens asynchronously due to an expose event
10310 may access f->tool_bar_items. Make sure we update both
10311 variables within BLOCK_INPUT so no such event interrupts. */
10313 f
->tool_bar_items
= new_tool_bar
;
10314 f
->n_tool_bar_items
= new_n_tool_bar
;
10315 w
->update_mode_line
= Qt
;
10321 unbind_to (count
, Qnil
);
10322 set_buffer_internal_1 (prev
);
10328 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10329 F's desired tool-bar contents. F->tool_bar_items must have
10330 been set up previously by calling prepare_menu_bars. */
10333 build_desired_tool_bar_string (f
)
10336 int i
, size
, size_needed
;
10337 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10338 Lisp_Object image
, plist
, props
;
10340 image
= plist
= props
= Qnil
;
10341 GCPRO3 (image
, plist
, props
);
10343 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10344 Otherwise, make a new string. */
10346 /* The size of the string we might be able to reuse. */
10347 size
= (STRINGP (f
->desired_tool_bar_string
)
10348 ? SCHARS (f
->desired_tool_bar_string
)
10351 /* We need one space in the string for each image. */
10352 size_needed
= f
->n_tool_bar_items
;
10354 /* Reuse f->desired_tool_bar_string, if possible. */
10355 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10356 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10357 make_number (' '));
10360 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10361 Fremove_text_properties (make_number (0), make_number (size
),
10362 props
, f
->desired_tool_bar_string
);
10365 /* Put a `display' property on the string for the images to display,
10366 put a `menu_item' property on tool-bar items with a value that
10367 is the index of the item in F's tool-bar item vector. */
10368 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10370 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10372 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10373 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10374 int hmargin
, vmargin
, relief
, idx
, end
;
10375 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10377 /* If image is a vector, choose the image according to the
10379 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10380 if (VECTORP (image
))
10384 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10385 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10388 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10389 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10391 xassert (ASIZE (image
) >= idx
);
10392 image
= AREF (image
, idx
);
10397 /* Ignore invalid image specifications. */
10398 if (!valid_image_p (image
))
10401 /* Display the tool-bar button pressed, or depressed. */
10402 plist
= Fcopy_sequence (XCDR (image
));
10404 /* Compute margin and relief to draw. */
10405 relief
= (tool_bar_button_relief
>= 0
10406 ? tool_bar_button_relief
10407 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10408 hmargin
= vmargin
= relief
;
10410 if (INTEGERP (Vtool_bar_button_margin
)
10411 && XINT (Vtool_bar_button_margin
) > 0)
10413 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10414 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10416 else if (CONSP (Vtool_bar_button_margin
))
10418 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10419 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10420 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10422 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10423 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10424 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10427 if (auto_raise_tool_bar_buttons_p
)
10429 /* Add a `:relief' property to the image spec if the item is
10433 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10440 /* If image is selected, display it pressed, i.e. with a
10441 negative relief. If it's not selected, display it with a
10443 plist
= Fplist_put (plist
, QCrelief
,
10445 ? make_number (-relief
)
10446 : make_number (relief
)));
10451 /* Put a margin around the image. */
10452 if (hmargin
|| vmargin
)
10454 if (hmargin
== vmargin
)
10455 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10457 plist
= Fplist_put (plist
, QCmargin
,
10458 Fcons (make_number (hmargin
),
10459 make_number (vmargin
)));
10462 /* If button is not enabled, and we don't have special images
10463 for the disabled state, make the image appear disabled by
10464 applying an appropriate algorithm to it. */
10465 if (!enabled_p
&& idx
< 0)
10466 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10468 /* Put a `display' text property on the string for the image to
10469 display. Put a `menu-item' property on the string that gives
10470 the start of this item's properties in the tool-bar items
10472 image
= Fcons (Qimage
, plist
);
10473 props
= list4 (Qdisplay
, image
,
10474 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10476 /* Let the last image hide all remaining spaces in the tool bar
10477 string. The string can be longer than needed when we reuse a
10478 previous string. */
10479 if (i
+ 1 == f
->n_tool_bar_items
)
10480 end
= SCHARS (f
->desired_tool_bar_string
);
10483 Fadd_text_properties (make_number (i
), make_number (end
),
10484 props
, f
->desired_tool_bar_string
);
10492 /* Display one line of the tool-bar of frame IT->f.
10494 HEIGHT specifies the desired height of the tool-bar line.
10495 If the actual height of the glyph row is less than HEIGHT, the
10496 row's height is increased to HEIGHT, and the icons are centered
10497 vertically in the new height.
10499 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10500 count a final empty row in case the tool-bar width exactly matches
10505 display_tool_bar_line (it
, height
)
10509 struct glyph_row
*row
= it
->glyph_row
;
10510 int max_x
= it
->last_visible_x
;
10511 struct glyph
*last
;
10513 prepare_desired_row (row
);
10514 row
->y
= it
->current_y
;
10516 /* Note that this isn't made use of if the face hasn't a box,
10517 so there's no need to check the face here. */
10518 it
->start_of_box_run_p
= 1;
10520 while (it
->current_x
< max_x
)
10522 int x
, n_glyphs_before
, i
, nglyphs
;
10523 struct it it_before
;
10525 /* Get the next display element. */
10526 if (!get_next_display_element (it
))
10528 /* Don't count empty row if we are counting needed tool-bar lines. */
10529 if (height
< 0 && !it
->hpos
)
10534 /* Produce glyphs. */
10535 n_glyphs_before
= row
->used
[TEXT_AREA
];
10538 PRODUCE_GLYPHS (it
);
10540 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10542 x
= it_before
.current_x
;
10543 while (i
< nglyphs
)
10545 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10547 if (x
+ glyph
->pixel_width
> max_x
)
10549 /* Glyph doesn't fit on line. Backtrack. */
10550 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10552 /* If this is the only glyph on this line, it will never fit on the
10553 toolbar, so skip it. But ensure there is at least one glyph,
10554 so we don't accidentally disable the tool-bar. */
10555 if (n_glyphs_before
== 0
10556 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10562 x
+= glyph
->pixel_width
;
10566 /* Stop at line ends. */
10567 if (ITERATOR_AT_END_OF_LINE_P (it
))
10570 set_iterator_to_next (it
, 1);
10575 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10577 /* Use default face for the border below the tool bar.
10579 FIXME: When auto-resize-tool-bars is grow-only, there is
10580 no additional border below the possibly empty tool-bar lines.
10581 So to make the extra empty lines look "normal", we have to
10582 use the tool-bar face for the border too. */
10583 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10584 it
->face_id
= DEFAULT_FACE_ID
;
10586 extend_face_to_end_of_line (it
);
10587 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10588 last
->right_box_line_p
= 1;
10589 if (last
== row
->glyphs
[TEXT_AREA
])
10590 last
->left_box_line_p
= 1;
10592 /* Make line the desired height and center it vertically. */
10593 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10595 /* Don't add more than one line height. */
10596 height
%= FRAME_LINE_HEIGHT (it
->f
);
10597 it
->max_ascent
+= height
/ 2;
10598 it
->max_descent
+= (height
+ 1) / 2;
10601 compute_line_metrics (it
);
10603 /* If line is empty, make it occupy the rest of the tool-bar. */
10604 if (!row
->displays_text_p
)
10606 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10607 row
->visible_height
= row
->height
;
10608 row
->ascent
= row
->phys_ascent
= 0;
10609 row
->extra_line_spacing
= 0;
10612 row
->full_width_p
= 1;
10613 row
->continued_p
= 0;
10614 row
->truncated_on_left_p
= 0;
10615 row
->truncated_on_right_p
= 0;
10617 it
->current_x
= it
->hpos
= 0;
10618 it
->current_y
+= row
->height
;
10624 /* Max tool-bar height. */
10626 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10627 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10629 /* Value is the number of screen lines needed to make all tool-bar
10630 items of frame F visible. The number of actual rows needed is
10631 returned in *N_ROWS if non-NULL. */
10634 tool_bar_lines_needed (f
, n_rows
)
10638 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10640 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10641 the desired matrix, so use (unused) mode-line row as temporary row to
10642 avoid destroying the first tool-bar row. */
10643 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10645 /* Initialize an iterator for iteration over
10646 F->desired_tool_bar_string in the tool-bar window of frame F. */
10647 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10648 it
.first_visible_x
= 0;
10649 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10650 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10652 while (!ITERATOR_AT_END_P (&it
))
10654 clear_glyph_row (temp_row
);
10655 it
.glyph_row
= temp_row
;
10656 display_tool_bar_line (&it
, -1);
10658 clear_glyph_row (temp_row
);
10660 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10662 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10664 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10668 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10670 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10679 frame
= selected_frame
;
10681 CHECK_FRAME (frame
);
10682 f
= XFRAME (frame
);
10684 if (WINDOWP (f
->tool_bar_window
)
10685 || (w
= XWINDOW (f
->tool_bar_window
),
10686 WINDOW_TOTAL_LINES (w
) > 0))
10688 update_tool_bar (f
, 1);
10689 if (f
->n_tool_bar_items
)
10691 build_desired_tool_bar_string (f
);
10692 nlines
= tool_bar_lines_needed (f
, NULL
);
10696 return make_number (nlines
);
10700 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10701 height should be changed. */
10704 redisplay_tool_bar (f
)
10709 struct glyph_row
*row
;
10711 #if defined (USE_GTK) || defined (HAVE_NS)
10712 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10713 update_frame_tool_bar (f
);
10717 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10718 do anything. This means you must start with tool-bar-lines
10719 non-zero to get the auto-sizing effect. Or in other words, you
10720 can turn off tool-bars by specifying tool-bar-lines zero. */
10721 if (!WINDOWP (f
->tool_bar_window
)
10722 || (w
= XWINDOW (f
->tool_bar_window
),
10723 WINDOW_TOTAL_LINES (w
) == 0))
10726 /* Set up an iterator for the tool-bar window. */
10727 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10728 it
.first_visible_x
= 0;
10729 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10730 row
= it
.glyph_row
;
10732 /* Build a string that represents the contents of the tool-bar. */
10733 build_desired_tool_bar_string (f
);
10734 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10736 if (f
->n_tool_bar_rows
== 0)
10740 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10741 nlines
!= WINDOW_TOTAL_LINES (w
)))
10743 extern Lisp_Object Qtool_bar_lines
;
10745 int old_height
= WINDOW_TOTAL_LINES (w
);
10747 XSETFRAME (frame
, f
);
10748 Fmodify_frame_parameters (frame
,
10749 Fcons (Fcons (Qtool_bar_lines
,
10750 make_number (nlines
)),
10752 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10754 clear_glyph_matrix (w
->desired_matrix
);
10755 fonts_changed_p
= 1;
10761 /* Display as many lines as needed to display all tool-bar items. */
10763 if (f
->n_tool_bar_rows
> 0)
10765 int border
, rows
, height
, extra
;
10767 if (INTEGERP (Vtool_bar_border
))
10768 border
= XINT (Vtool_bar_border
);
10769 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10770 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10771 else if (EQ (Vtool_bar_border
, Qborder_width
))
10772 border
= f
->border_width
;
10778 rows
= f
->n_tool_bar_rows
;
10779 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10780 extra
= it
.last_visible_y
- border
- height
* rows
;
10782 while (it
.current_y
< it
.last_visible_y
)
10785 if (extra
> 0 && rows
-- > 0)
10787 h
= (extra
+ rows
- 1) / rows
;
10790 display_tool_bar_line (&it
, height
+ h
);
10795 while (it
.current_y
< it
.last_visible_y
)
10796 display_tool_bar_line (&it
, 0);
10799 /* It doesn't make much sense to try scrolling in the tool-bar
10800 window, so don't do it. */
10801 w
->desired_matrix
->no_scrolling_p
= 1;
10802 w
->must_be_updated_p
= 1;
10804 if (!NILP (Vauto_resize_tool_bars
))
10806 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10807 int change_height_p
= 0;
10809 /* If we couldn't display everything, change the tool-bar's
10810 height if there is room for more. */
10811 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10812 && it
.current_y
< max_tool_bar_height
)
10813 change_height_p
= 1;
10815 row
= it
.glyph_row
- 1;
10817 /* If there are blank lines at the end, except for a partially
10818 visible blank line at the end that is smaller than
10819 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10820 if (!row
->displays_text_p
10821 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10822 change_height_p
= 1;
10824 /* If row displays tool-bar items, but is partially visible,
10825 change the tool-bar's height. */
10826 if (row
->displays_text_p
10827 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10828 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10829 change_height_p
= 1;
10831 /* Resize windows as needed by changing the `tool-bar-lines'
10832 frame parameter. */
10833 if (change_height_p
)
10835 extern Lisp_Object Qtool_bar_lines
;
10837 int old_height
= WINDOW_TOTAL_LINES (w
);
10839 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10841 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10842 && !f
->minimize_tool_bar_window_p
)
10843 ? (nlines
> old_height
)
10844 : (nlines
!= old_height
));
10845 f
->minimize_tool_bar_window_p
= 0;
10847 if (change_height_p
)
10849 XSETFRAME (frame
, f
);
10850 Fmodify_frame_parameters (frame
,
10851 Fcons (Fcons (Qtool_bar_lines
,
10852 make_number (nlines
)),
10854 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10856 clear_glyph_matrix (w
->desired_matrix
);
10857 f
->n_tool_bar_rows
= nrows
;
10858 fonts_changed_p
= 1;
10865 f
->minimize_tool_bar_window_p
= 0;
10870 /* Get information about the tool-bar item which is displayed in GLYPH
10871 on frame F. Return in *PROP_IDX the index where tool-bar item
10872 properties start in F->tool_bar_items. Value is zero if
10873 GLYPH doesn't display a tool-bar item. */
10876 tool_bar_item_info (f
, glyph
, prop_idx
)
10878 struct glyph
*glyph
;
10885 /* This function can be called asynchronously, which means we must
10886 exclude any possibility that Fget_text_property signals an
10888 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10889 charpos
= max (0, charpos
);
10891 /* Get the text property `menu-item' at pos. The value of that
10892 property is the start index of this item's properties in
10893 F->tool_bar_items. */
10894 prop
= Fget_text_property (make_number (charpos
),
10895 Qmenu_item
, f
->current_tool_bar_string
);
10896 if (INTEGERP (prop
))
10898 *prop_idx
= XINT (prop
);
10908 /* Get information about the tool-bar item at position X/Y on frame F.
10909 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10910 the current matrix of the tool-bar window of F, or NULL if not
10911 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10912 item in F->tool_bar_items. Value is
10914 -1 if X/Y is not on a tool-bar item
10915 0 if X/Y is on the same item that was highlighted before.
10919 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10922 struct glyph
**glyph
;
10923 int *hpos
, *vpos
, *prop_idx
;
10925 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10926 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10929 /* Find the glyph under X/Y. */
10930 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10931 if (*glyph
== NULL
)
10934 /* Get the start of this tool-bar item's properties in
10935 f->tool_bar_items. */
10936 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10939 /* Is mouse on the highlighted item? */
10940 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10941 && *vpos
>= dpyinfo
->mouse_face_beg_row
10942 && *vpos
<= dpyinfo
->mouse_face_end_row
10943 && (*vpos
> dpyinfo
->mouse_face_beg_row
10944 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10945 && (*vpos
< dpyinfo
->mouse_face_end_row
10946 || *hpos
< dpyinfo
->mouse_face_end_col
10947 || dpyinfo
->mouse_face_past_end
))
10955 Handle mouse button event on the tool-bar of frame F, at
10956 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10957 0 for button release. MODIFIERS is event modifiers for button
10961 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10964 unsigned int modifiers
;
10966 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10967 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10968 int hpos
, vpos
, prop_idx
;
10969 struct glyph
*glyph
;
10970 Lisp_Object enabled_p
;
10972 /* If not on the highlighted tool-bar item, return. */
10973 frame_to_window_pixel_xy (w
, &x
, &y
);
10974 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10977 /* If item is disabled, do nothing. */
10978 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10979 if (NILP (enabled_p
))
10984 /* Show item in pressed state. */
10985 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10986 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10987 last_tool_bar_item
= prop_idx
;
10991 Lisp_Object key
, frame
;
10992 struct input_event event
;
10993 EVENT_INIT (event
);
10995 /* Show item in released state. */
10996 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10997 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10999 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11001 XSETFRAME (frame
, f
);
11002 event
.kind
= TOOL_BAR_EVENT
;
11003 event
.frame_or_window
= frame
;
11005 kbd_buffer_store_event (&event
);
11007 event
.kind
= TOOL_BAR_EVENT
;
11008 event
.frame_or_window
= frame
;
11010 event
.modifiers
= modifiers
;
11011 kbd_buffer_store_event (&event
);
11012 last_tool_bar_item
= -1;
11017 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11018 tool-bar window-relative coordinates X/Y. Called from
11019 note_mouse_highlight. */
11022 note_tool_bar_highlight (f
, x
, y
)
11026 Lisp_Object window
= f
->tool_bar_window
;
11027 struct window
*w
= XWINDOW (window
);
11028 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11030 struct glyph
*glyph
;
11031 struct glyph_row
*row
;
11033 Lisp_Object enabled_p
;
11035 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11036 int mouse_down_p
, rc
;
11038 /* Function note_mouse_highlight is called with negative x(y
11039 values when mouse moves outside of the frame. */
11040 if (x
<= 0 || y
<= 0)
11042 clear_mouse_face (dpyinfo
);
11046 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11049 /* Not on tool-bar item. */
11050 clear_mouse_face (dpyinfo
);
11054 /* On same tool-bar item as before. */
11055 goto set_help_echo
;
11057 clear_mouse_face (dpyinfo
);
11059 /* Mouse is down, but on different tool-bar item? */
11060 mouse_down_p
= (dpyinfo
->grabbed
11061 && f
== last_mouse_frame
11062 && FRAME_LIVE_P (f
));
11064 && last_tool_bar_item
!= prop_idx
)
11067 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11068 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11070 /* If tool-bar item is not enabled, don't highlight it. */
11071 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11072 if (!NILP (enabled_p
))
11074 /* Compute the x-position of the glyph. In front and past the
11075 image is a space. We include this in the highlighted area. */
11076 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11077 for (i
= x
= 0; i
< hpos
; ++i
)
11078 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11080 /* Record this as the current active region. */
11081 dpyinfo
->mouse_face_beg_col
= hpos
;
11082 dpyinfo
->mouse_face_beg_row
= vpos
;
11083 dpyinfo
->mouse_face_beg_x
= x
;
11084 dpyinfo
->mouse_face_beg_y
= row
->y
;
11085 dpyinfo
->mouse_face_past_end
= 0;
11087 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
11088 dpyinfo
->mouse_face_end_row
= vpos
;
11089 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11090 dpyinfo
->mouse_face_end_y
= row
->y
;
11091 dpyinfo
->mouse_face_window
= window
;
11092 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11094 /* Display it as active. */
11095 show_mouse_face (dpyinfo
, draw
);
11096 dpyinfo
->mouse_face_image_state
= draw
;
11101 /* Set help_echo_string to a help string to display for this tool-bar item.
11102 XTread_socket does the rest. */
11103 help_echo_object
= help_echo_window
= Qnil
;
11104 help_echo_pos
= -1;
11105 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11106 if (NILP (help_echo_string
))
11107 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11110 #endif /* HAVE_WINDOW_SYSTEM */
11114 /************************************************************************
11115 Horizontal scrolling
11116 ************************************************************************/
11118 static int hscroll_window_tree
P_ ((Lisp_Object
));
11119 static int hscroll_windows
P_ ((Lisp_Object
));
11121 /* For all leaf windows in the window tree rooted at WINDOW, set their
11122 hscroll value so that PT is (i) visible in the window, and (ii) so
11123 that it is not within a certain margin at the window's left and
11124 right border. Value is non-zero if any window's hscroll has been
11128 hscroll_window_tree (window
)
11129 Lisp_Object window
;
11131 int hscrolled_p
= 0;
11132 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11133 int hscroll_step_abs
= 0;
11134 double hscroll_step_rel
= 0;
11136 if (hscroll_relative_p
)
11138 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11139 if (hscroll_step_rel
< 0)
11141 hscroll_relative_p
= 0;
11142 hscroll_step_abs
= 0;
11145 else if (INTEGERP (Vhscroll_step
))
11147 hscroll_step_abs
= XINT (Vhscroll_step
);
11148 if (hscroll_step_abs
< 0)
11149 hscroll_step_abs
= 0;
11152 hscroll_step_abs
= 0;
11154 while (WINDOWP (window
))
11156 struct window
*w
= XWINDOW (window
);
11158 if (WINDOWP (w
->hchild
))
11159 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11160 else if (WINDOWP (w
->vchild
))
11161 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11162 else if (w
->cursor
.vpos
>= 0)
11165 int text_area_width
;
11166 struct glyph_row
*current_cursor_row
11167 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11168 struct glyph_row
*desired_cursor_row
11169 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11170 struct glyph_row
*cursor_row
11171 = (desired_cursor_row
->enabled_p
11172 ? desired_cursor_row
11173 : current_cursor_row
);
11175 text_area_width
= window_box_width (w
, TEXT_AREA
);
11177 /* Scroll when cursor is inside this scroll margin. */
11178 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11180 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11181 && ((XFASTINT (w
->hscroll
)
11182 && w
->cursor
.x
<= h_margin
)
11183 || (cursor_row
->enabled_p
11184 && cursor_row
->truncated_on_right_p
11185 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11189 struct buffer
*saved_current_buffer
;
11193 /* Find point in a display of infinite width. */
11194 saved_current_buffer
= current_buffer
;
11195 current_buffer
= XBUFFER (w
->buffer
);
11197 if (w
== XWINDOW (selected_window
))
11198 pt
= BUF_PT (current_buffer
);
11201 pt
= marker_position (w
->pointm
);
11202 pt
= max (BEGV
, pt
);
11206 /* Move iterator to pt starting at cursor_row->start in
11207 a line with infinite width. */
11208 init_to_row_start (&it
, w
, cursor_row
);
11209 it
.last_visible_x
= INFINITY
;
11210 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11211 current_buffer
= saved_current_buffer
;
11213 /* Position cursor in window. */
11214 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11215 hscroll
= max (0, (it
.current_x
11216 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11217 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11218 : (text_area_width
/ 2))))
11219 / FRAME_COLUMN_WIDTH (it
.f
);
11220 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11222 if (hscroll_relative_p
)
11223 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11226 wanted_x
= text_area_width
11227 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11230 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11234 if (hscroll_relative_p
)
11235 wanted_x
= text_area_width
* hscroll_step_rel
11238 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11241 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11243 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11245 /* Don't call Fset_window_hscroll if value hasn't
11246 changed because it will prevent redisplay
11248 if (XFASTINT (w
->hscroll
) != hscroll
)
11250 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11251 w
->hscroll
= make_number (hscroll
);
11260 /* Value is non-zero if hscroll of any leaf window has been changed. */
11261 return hscrolled_p
;
11265 /* Set hscroll so that cursor is visible and not inside horizontal
11266 scroll margins for all windows in the tree rooted at WINDOW. See
11267 also hscroll_window_tree above. Value is non-zero if any window's
11268 hscroll has been changed. If it has, desired matrices on the frame
11269 of WINDOW are cleared. */
11272 hscroll_windows (window
)
11273 Lisp_Object window
;
11275 int hscrolled_p
= hscroll_window_tree (window
);
11277 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11278 return hscrolled_p
;
11283 /************************************************************************
11285 ************************************************************************/
11287 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11288 to a non-zero value. This is sometimes handy to have in a debugger
11293 /* First and last unchanged row for try_window_id. */
11295 int debug_first_unchanged_at_end_vpos
;
11296 int debug_last_unchanged_at_beg_vpos
;
11298 /* Delta vpos and y. */
11300 int debug_dvpos
, debug_dy
;
11302 /* Delta in characters and bytes for try_window_id. */
11304 int debug_delta
, debug_delta_bytes
;
11306 /* Values of window_end_pos and window_end_vpos at the end of
11309 EMACS_INT debug_end_pos
, debug_end_vpos
;
11311 /* Append a string to W->desired_matrix->method. FMT is a printf
11312 format string. A1...A9 are a supplement for a variable-length
11313 argument list. If trace_redisplay_p is non-zero also printf the
11314 resulting string to stderr. */
11317 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11320 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11323 char *method
= w
->desired_matrix
->method
;
11324 int len
= strlen (method
);
11325 int size
= sizeof w
->desired_matrix
->method
;
11326 int remaining
= size
- len
- 1;
11328 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11329 if (len
&& remaining
)
11332 --remaining
, ++len
;
11335 strncpy (method
+ len
, buffer
, remaining
);
11337 if (trace_redisplay_p
)
11338 fprintf (stderr
, "%p (%s): %s\n",
11340 ((BUFFERP (w
->buffer
)
11341 && STRINGP (XBUFFER (w
->buffer
)->name
))
11342 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11347 #endif /* GLYPH_DEBUG */
11350 /* Value is non-zero if all changes in window W, which displays
11351 current_buffer, are in the text between START and END. START is a
11352 buffer position, END is given as a distance from Z. Used in
11353 redisplay_internal for display optimization. */
11356 text_outside_line_unchanged_p (w
, start
, end
)
11360 int unchanged_p
= 1;
11362 /* If text or overlays have changed, see where. */
11363 if (XFASTINT (w
->last_modified
) < MODIFF
11364 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11366 /* Gap in the line? */
11367 if (GPT
< start
|| Z
- GPT
< end
)
11370 /* Changes start in front of the line, or end after it? */
11372 && (BEG_UNCHANGED
< start
- 1
11373 || END_UNCHANGED
< end
))
11376 /* If selective display, can't optimize if changes start at the
11377 beginning of the line. */
11379 && INTEGERP (current_buffer
->selective_display
)
11380 && XINT (current_buffer
->selective_display
) > 0
11381 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11384 /* If there are overlays at the start or end of the line, these
11385 may have overlay strings with newlines in them. A change at
11386 START, for instance, may actually concern the display of such
11387 overlay strings as well, and they are displayed on different
11388 lines. So, quickly rule out this case. (For the future, it
11389 might be desirable to implement something more telling than
11390 just BEG/END_UNCHANGED.) */
11393 if (BEG
+ BEG_UNCHANGED
== start
11394 && overlay_touches_p (start
))
11396 if (END_UNCHANGED
== end
11397 && overlay_touches_p (Z
- end
))
11401 /* Under bidi reordering, adding or deleting a character in the
11402 beginning of a paragraph, before the first strong directional
11403 character, can change the base direction of the paragraph (unless
11404 the buffer specifies a fixed paragraph direction), which will
11405 require to redisplay the whole paragraph. It might be worthwhile
11406 to find the paragraph limits and widen the range of redisplayed
11407 lines to that, but for now just give up this optimization. */
11408 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11409 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11413 return unchanged_p
;
11417 /* Do a frame update, taking possible shortcuts into account. This is
11418 the main external entry point for redisplay.
11420 If the last redisplay displayed an echo area message and that message
11421 is no longer requested, we clear the echo area or bring back the
11422 mini-buffer if that is in use. */
11427 redisplay_internal (0);
11432 overlay_arrow_string_or_property (var
)
11437 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11440 return Voverlay_arrow_string
;
11443 /* Return 1 if there are any overlay-arrows in current_buffer. */
11445 overlay_arrow_in_current_buffer_p ()
11449 for (vlist
= Voverlay_arrow_variable_list
;
11451 vlist
= XCDR (vlist
))
11453 Lisp_Object var
= XCAR (vlist
);
11456 if (!SYMBOLP (var
))
11458 val
= find_symbol_value (var
);
11460 && current_buffer
== XMARKER (val
)->buffer
)
11467 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11471 overlay_arrows_changed_p ()
11475 for (vlist
= Voverlay_arrow_variable_list
;
11477 vlist
= XCDR (vlist
))
11479 Lisp_Object var
= XCAR (vlist
);
11480 Lisp_Object val
, pstr
;
11482 if (!SYMBOLP (var
))
11484 val
= find_symbol_value (var
);
11485 if (!MARKERP (val
))
11487 if (! EQ (COERCE_MARKER (val
),
11488 Fget (var
, Qlast_arrow_position
))
11489 || ! (pstr
= overlay_arrow_string_or_property (var
),
11490 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11496 /* Mark overlay arrows to be updated on next redisplay. */
11499 update_overlay_arrows (up_to_date
)
11504 for (vlist
= Voverlay_arrow_variable_list
;
11506 vlist
= XCDR (vlist
))
11508 Lisp_Object var
= XCAR (vlist
);
11510 if (!SYMBOLP (var
))
11513 if (up_to_date
> 0)
11515 Lisp_Object val
= find_symbol_value (var
);
11516 Fput (var
, Qlast_arrow_position
,
11517 COERCE_MARKER (val
));
11518 Fput (var
, Qlast_arrow_string
,
11519 overlay_arrow_string_or_property (var
));
11521 else if (up_to_date
< 0
11522 || !NILP (Fget (var
, Qlast_arrow_position
)))
11524 Fput (var
, Qlast_arrow_position
, Qt
);
11525 Fput (var
, Qlast_arrow_string
, Qt
);
11531 /* Return overlay arrow string to display at row.
11532 Return integer (bitmap number) for arrow bitmap in left fringe.
11533 Return nil if no overlay arrow. */
11536 overlay_arrow_at_row (it
, row
)
11538 struct glyph_row
*row
;
11542 for (vlist
= Voverlay_arrow_variable_list
;
11544 vlist
= XCDR (vlist
))
11546 Lisp_Object var
= XCAR (vlist
);
11549 if (!SYMBOLP (var
))
11552 val
= find_symbol_value (var
);
11555 && current_buffer
== XMARKER (val
)->buffer
11556 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11558 if (FRAME_WINDOW_P (it
->f
)
11559 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11561 #ifdef HAVE_WINDOW_SYSTEM
11562 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11565 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11566 return make_number (fringe_bitmap
);
11569 return make_number (-1); /* Use default arrow bitmap */
11571 return overlay_arrow_string_or_property (var
);
11578 /* Return 1 if point moved out of or into a composition. Otherwise
11579 return 0. PREV_BUF and PREV_PT are the last point buffer and
11580 position. BUF and PT are the current point buffer and position. */
11583 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11584 struct buffer
*prev_buf
, *buf
;
11587 EMACS_INT start
, end
;
11589 Lisp_Object buffer
;
11591 XSETBUFFER (buffer
, buf
);
11592 /* Check a composition at the last point if point moved within the
11594 if (prev_buf
== buf
)
11597 /* Point didn't move. */
11600 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11601 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11602 && COMPOSITION_VALID_P (start
, end
, prop
)
11603 && start
< prev_pt
&& end
> prev_pt
)
11604 /* The last point was within the composition. Return 1 iff
11605 point moved out of the composition. */
11606 return (pt
<= start
|| pt
>= end
);
11609 /* Check a composition at the current point. */
11610 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11611 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11612 && COMPOSITION_VALID_P (start
, end
, prop
)
11613 && start
< pt
&& end
> pt
);
11617 /* Reconsider the setting of B->clip_changed which is displayed
11621 reconsider_clip_changes (w
, b
)
11625 if (b
->clip_changed
11626 && !NILP (w
->window_end_valid
)
11627 && w
->current_matrix
->buffer
== b
11628 && w
->current_matrix
->zv
== BUF_ZV (b
)
11629 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11630 b
->clip_changed
= 0;
11632 /* If display wasn't paused, and W is not a tool bar window, see if
11633 point has been moved into or out of a composition. In that case,
11634 we set b->clip_changed to 1 to force updating the screen. If
11635 b->clip_changed has already been set to 1, we can skip this
11637 if (!b
->clip_changed
11638 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11642 if (w
== XWINDOW (selected_window
))
11643 pt
= BUF_PT (current_buffer
);
11645 pt
= marker_position (w
->pointm
);
11647 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11648 || pt
!= XINT (w
->last_point
))
11649 && check_point_in_composition (w
->current_matrix
->buffer
,
11650 XINT (w
->last_point
),
11651 XBUFFER (w
->buffer
), pt
))
11652 b
->clip_changed
= 1;
11657 /* Select FRAME to forward the values of frame-local variables into C
11658 variables so that the redisplay routines can access those values
11662 select_frame_for_redisplay (frame
)
11665 Lisp_Object tail
, tem
;
11666 Lisp_Object old
= selected_frame
;
11667 struct Lisp_Symbol
*sym
;
11669 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11671 selected_frame
= frame
;
11674 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11675 if (CONSP (XCAR (tail
))
11676 && (tem
= XCAR (XCAR (tail
)),
11678 && (sym
= indirect_variable (XSYMBOL (tem
)),
11679 sym
->redirect
== SYMBOL_LOCALIZED
)
11680 && sym
->val
.blv
->frame_local
)
11681 /* Use find_symbol_value rather than Fsymbol_value
11682 to avoid an error if it is void. */
11683 find_symbol_value (tem
);
11684 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11688 #define STOP_POLLING \
11689 do { if (! polling_stopped_here) stop_polling (); \
11690 polling_stopped_here = 1; } while (0)
11692 #define RESUME_POLLING \
11693 do { if (polling_stopped_here) start_polling (); \
11694 polling_stopped_here = 0; } while (0)
11697 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11698 response to any user action; therefore, we should preserve the echo
11699 area. (Actually, our caller does that job.) Perhaps in the future
11700 avoid recentering windows if it is not necessary; currently that
11701 causes some problems. */
11704 redisplay_internal (preserve_echo_area
)
11705 int preserve_echo_area
;
11707 struct window
*w
= XWINDOW (selected_window
);
11710 int must_finish
= 0;
11711 struct text_pos tlbufpos
, tlendpos
;
11712 int number_of_visible_frames
;
11715 int polling_stopped_here
= 0;
11716 Lisp_Object old_frame
= selected_frame
;
11718 /* Non-zero means redisplay has to consider all windows on all
11719 frames. Zero means, only selected_window is considered. */
11720 int consider_all_windows_p
;
11722 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11724 /* No redisplay if running in batch mode or frame is not yet fully
11725 initialized, or redisplay is explicitly turned off by setting
11726 Vinhibit_redisplay. */
11727 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11728 || !NILP (Vinhibit_redisplay
))
11731 /* Don't examine these until after testing Vinhibit_redisplay.
11732 When Emacs is shutting down, perhaps because its connection to
11733 X has dropped, we should not look at them at all. */
11734 f
= XFRAME (w
->frame
);
11735 sf
= SELECTED_FRAME ();
11737 if (!f
->glyphs_initialized_p
)
11740 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11741 if (popup_activated ())
11745 /* I don't think this happens but let's be paranoid. */
11746 if (redisplaying_p
)
11749 /* Record a function that resets redisplaying_p to its old value
11750 when we leave this function. */
11751 count
= SPECPDL_INDEX ();
11752 record_unwind_protect (unwind_redisplay
,
11753 Fcons (make_number (redisplaying_p
), selected_frame
));
11755 specbind (Qinhibit_free_realized_faces
, Qnil
);
11758 Lisp_Object tail
, frame
;
11760 FOR_EACH_FRAME (tail
, frame
)
11762 struct frame
*f
= XFRAME (frame
);
11763 f
->already_hscrolled_p
= 0;
11768 if (!EQ (old_frame
, selected_frame
)
11769 && FRAME_LIVE_P (XFRAME (old_frame
)))
11770 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11771 selected_frame and selected_window to be temporarily out-of-sync so
11772 when we come back here via `goto retry', we need to resync because we
11773 may need to run Elisp code (via prepare_menu_bars). */
11774 select_frame_for_redisplay (old_frame
);
11777 reconsider_clip_changes (w
, current_buffer
);
11778 last_escape_glyph_frame
= NULL
;
11779 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11781 /* If new fonts have been loaded that make a glyph matrix adjustment
11782 necessary, do it. */
11783 if (fonts_changed_p
)
11785 adjust_glyphs (NULL
);
11786 ++windows_or_buffers_changed
;
11787 fonts_changed_p
= 0;
11790 /* If face_change_count is non-zero, init_iterator will free all
11791 realized faces, which includes the faces referenced from current
11792 matrices. So, we can't reuse current matrices in this case. */
11793 if (face_change_count
)
11794 ++windows_or_buffers_changed
;
11796 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11797 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11799 /* Since frames on a single ASCII terminal share the same
11800 display area, displaying a different frame means redisplay
11801 the whole thing. */
11802 windows_or_buffers_changed
++;
11803 SET_FRAME_GARBAGED (sf
);
11805 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11807 FRAME_TTY (sf
)->previous_frame
= sf
;
11810 /* Set the visible flags for all frames. Do this before checking
11811 for resized or garbaged frames; they want to know if their frames
11812 are visible. See the comment in frame.h for
11813 FRAME_SAMPLE_VISIBILITY. */
11815 Lisp_Object tail
, frame
;
11817 number_of_visible_frames
= 0;
11819 FOR_EACH_FRAME (tail
, frame
)
11821 struct frame
*f
= XFRAME (frame
);
11823 FRAME_SAMPLE_VISIBILITY (f
);
11824 if (FRAME_VISIBLE_P (f
))
11825 ++number_of_visible_frames
;
11826 clear_desired_matrices (f
);
11830 /* Notice any pending interrupt request to change frame size. */
11831 do_pending_window_change (1);
11833 /* Clear frames marked as garbaged. */
11834 if (frame_garbaged
)
11835 clear_garbaged_frames ();
11837 /* Build menubar and tool-bar items. */
11838 if (NILP (Vmemory_full
))
11839 prepare_menu_bars ();
11841 if (windows_or_buffers_changed
)
11842 update_mode_lines
++;
11844 /* Detect case that we need to write or remove a star in the mode line. */
11845 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11847 w
->update_mode_line
= Qt
;
11848 if (buffer_shared
> 1)
11849 update_mode_lines
++;
11852 /* Avoid invocation of point motion hooks by `current_column' below. */
11853 count1
= SPECPDL_INDEX ();
11854 specbind (Qinhibit_point_motion_hooks
, Qt
);
11856 /* If %c is in the mode line, update it if needed. */
11857 if (!NILP (w
->column_number_displayed
)
11858 /* This alternative quickly identifies a common case
11859 where no change is needed. */
11860 && !(PT
== XFASTINT (w
->last_point
)
11861 && XFASTINT (w
->last_modified
) >= MODIFF
11862 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11863 && (XFASTINT (w
->column_number_displayed
)
11864 != (int) current_column ())) /* iftc */
11865 w
->update_mode_line
= Qt
;
11867 unbind_to (count1
, Qnil
);
11869 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11871 /* The variable buffer_shared is set in redisplay_window and
11872 indicates that we redisplay a buffer in different windows. See
11874 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11875 || cursor_type_changed
);
11877 /* If specs for an arrow have changed, do thorough redisplay
11878 to ensure we remove any arrow that should no longer exist. */
11879 if (overlay_arrows_changed_p ())
11880 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11882 /* Normally the message* functions will have already displayed and
11883 updated the echo area, but the frame may have been trashed, or
11884 the update may have been preempted, so display the echo area
11885 again here. Checking message_cleared_p captures the case that
11886 the echo area should be cleared. */
11887 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11888 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11889 || (message_cleared_p
11890 && minibuf_level
== 0
11891 /* If the mini-window is currently selected, this means the
11892 echo-area doesn't show through. */
11893 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11895 int window_height_changed_p
= echo_area_display (0);
11898 /* If we don't display the current message, don't clear the
11899 message_cleared_p flag, because, if we did, we wouldn't clear
11900 the echo area in the next redisplay which doesn't preserve
11902 if (!display_last_displayed_message_p
)
11903 message_cleared_p
= 0;
11905 if (fonts_changed_p
)
11907 else if (window_height_changed_p
)
11909 consider_all_windows_p
= 1;
11910 ++update_mode_lines
;
11911 ++windows_or_buffers_changed
;
11913 /* If window configuration was changed, frames may have been
11914 marked garbaged. Clear them or we will experience
11915 surprises wrt scrolling. */
11916 if (frame_garbaged
)
11917 clear_garbaged_frames ();
11920 else if (EQ (selected_window
, minibuf_window
)
11921 && (current_buffer
->clip_changed
11922 || XFASTINT (w
->last_modified
) < MODIFF
11923 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11924 && resize_mini_window (w
, 0))
11926 /* Resized active mini-window to fit the size of what it is
11927 showing if its contents might have changed. */
11929 /* FIXME: this causes all frames to be updated, which seems unnecessary
11930 since only the current frame needs to be considered. This function needs
11931 to be rewritten with two variables, consider_all_windows and
11932 consider_all_frames. */
11933 consider_all_windows_p
= 1;
11934 ++windows_or_buffers_changed
;
11935 ++update_mode_lines
;
11937 /* If window configuration was changed, frames may have been
11938 marked garbaged. Clear them or we will experience
11939 surprises wrt scrolling. */
11940 if (frame_garbaged
)
11941 clear_garbaged_frames ();
11945 /* If showing the region, and mark has changed, we must redisplay
11946 the whole window. The assignment to this_line_start_pos prevents
11947 the optimization directly below this if-statement. */
11948 if (((!NILP (Vtransient_mark_mode
)
11949 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11950 != !NILP (w
->region_showing
))
11951 || (!NILP (w
->region_showing
)
11952 && !EQ (w
->region_showing
,
11953 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11954 CHARPOS (this_line_start_pos
) = 0;
11956 /* Optimize the case that only the line containing the cursor in the
11957 selected window has changed. Variables starting with this_ are
11958 set in display_line and record information about the line
11959 containing the cursor. */
11960 tlbufpos
= this_line_start_pos
;
11961 tlendpos
= this_line_end_pos
;
11962 if (!consider_all_windows_p
11963 && CHARPOS (tlbufpos
) > 0
11964 && NILP (w
->update_mode_line
)
11965 && !current_buffer
->clip_changed
11966 && !current_buffer
->prevent_redisplay_optimizations_p
11967 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11968 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11969 /* Make sure recorded data applies to current buffer, etc. */
11970 && this_line_buffer
== current_buffer
11971 && current_buffer
== XBUFFER (w
->buffer
)
11972 && NILP (w
->force_start
)
11973 && NILP (w
->optional_new_start
)
11974 /* Point must be on the line that we have info recorded about. */
11975 && PT
>= CHARPOS (tlbufpos
)
11976 && PT
<= Z
- CHARPOS (tlendpos
)
11977 /* All text outside that line, including its final newline,
11978 must be unchanged. */
11979 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11980 CHARPOS (tlendpos
)))
11982 if (CHARPOS (tlbufpos
) > BEGV
11983 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11984 && (CHARPOS (tlbufpos
) == ZV
11985 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11986 /* Former continuation line has disappeared by becoming empty. */
11988 else if (XFASTINT (w
->last_modified
) < MODIFF
11989 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11990 || MINI_WINDOW_P (w
))
11992 /* We have to handle the case of continuation around a
11993 wide-column character (see the comment in indent.c around
11996 For instance, in the following case:
11998 -------- Insert --------
11999 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12000 J_I_ ==> J_I_ `^^' are cursors.
12004 As we have to redraw the line above, we cannot use this
12008 int line_height_before
= this_line_pixel_height
;
12010 /* Note that start_display will handle the case that the
12011 line starting at tlbufpos is a continuation line. */
12012 start_display (&it
, w
, tlbufpos
);
12014 /* Implementation note: It this still necessary? */
12015 if (it
.current_x
!= this_line_start_x
)
12018 TRACE ((stderr
, "trying display optimization 1\n"));
12019 w
->cursor
.vpos
= -1;
12020 overlay_arrow_seen
= 0;
12021 it
.vpos
= this_line_vpos
;
12022 it
.current_y
= this_line_y
;
12023 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12024 display_line (&it
);
12026 /* If line contains point, is not continued,
12027 and ends at same distance from eob as before, we win. */
12028 if (w
->cursor
.vpos
>= 0
12029 /* Line is not continued, otherwise this_line_start_pos
12030 would have been set to 0 in display_line. */
12031 && CHARPOS (this_line_start_pos
)
12032 /* Line ends as before. */
12033 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12034 /* Line has same height as before. Otherwise other lines
12035 would have to be shifted up or down. */
12036 && this_line_pixel_height
== line_height_before
)
12038 /* If this is not the window's last line, we must adjust
12039 the charstarts of the lines below. */
12040 if (it
.current_y
< it
.last_visible_y
)
12042 struct glyph_row
*row
12043 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12044 int delta
, delta_bytes
;
12046 /* We used to distinguish between two cases here,
12047 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12048 when the line ends in a newline or the end of the
12049 buffer's accessible portion. But both cases did
12050 the same, so they were collapsed. */
12052 - CHARPOS (tlendpos
)
12053 - MATRIX_ROW_START_CHARPOS (row
));
12054 delta_bytes
= (Z_BYTE
12055 - BYTEPOS (tlendpos
)
12056 - MATRIX_ROW_START_BYTEPOS (row
));
12058 increment_matrix_positions (w
->current_matrix
,
12059 this_line_vpos
+ 1,
12060 w
->current_matrix
->nrows
,
12061 delta
, delta_bytes
);
12064 /* If this row displays text now but previously didn't,
12065 or vice versa, w->window_end_vpos may have to be
12067 if ((it
.glyph_row
- 1)->displays_text_p
)
12069 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12070 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12072 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12073 && this_line_vpos
> 0)
12074 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12075 w
->window_end_valid
= Qnil
;
12077 /* Update hint: No need to try to scroll in update_window. */
12078 w
->desired_matrix
->no_scrolling_p
= 1;
12081 *w
->desired_matrix
->method
= 0;
12082 debug_method_add (w
, "optimization 1");
12084 #ifdef HAVE_WINDOW_SYSTEM
12085 update_window_fringes (w
, 0);
12092 else if (/* Cursor position hasn't changed. */
12093 PT
== XFASTINT (w
->last_point
)
12094 /* Make sure the cursor was last displayed
12095 in this window. Otherwise we have to reposition it. */
12096 && 0 <= w
->cursor
.vpos
12097 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12101 do_pending_window_change (1);
12103 /* We used to always goto end_of_redisplay here, but this
12104 isn't enough if we have a blinking cursor. */
12105 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12106 goto end_of_redisplay
;
12110 /* If highlighting the region, or if the cursor is in the echo area,
12111 then we can't just move the cursor. */
12112 else if (! (!NILP (Vtransient_mark_mode
)
12113 && !NILP (current_buffer
->mark_active
))
12114 && (EQ (selected_window
, current_buffer
->last_selected_window
)
12115 || highlight_nonselected_windows
)
12116 && NILP (w
->region_showing
)
12117 && NILP (Vshow_trailing_whitespace
)
12118 && !cursor_in_echo_area
)
12121 struct glyph_row
*row
;
12123 /* Skip from tlbufpos to PT and see where it is. Note that
12124 PT may be in invisible text. If so, we will end at the
12125 next visible position. */
12126 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12127 NULL
, DEFAULT_FACE_ID
);
12128 it
.current_x
= this_line_start_x
;
12129 it
.current_y
= this_line_y
;
12130 it
.vpos
= this_line_vpos
;
12132 /* The call to move_it_to stops in front of PT, but
12133 moves over before-strings. */
12134 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12136 if (it
.vpos
== this_line_vpos
12137 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12140 xassert (this_line_vpos
== it
.vpos
);
12141 xassert (this_line_y
== it
.current_y
);
12142 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12144 *w
->desired_matrix
->method
= 0;
12145 debug_method_add (w
, "optimization 3");
12154 /* Text changed drastically or point moved off of line. */
12155 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12158 CHARPOS (this_line_start_pos
) = 0;
12159 consider_all_windows_p
|= buffer_shared
> 1;
12160 ++clear_face_cache_count
;
12161 #ifdef HAVE_WINDOW_SYSTEM
12162 ++clear_image_cache_count
;
12165 /* Build desired matrices, and update the display. If
12166 consider_all_windows_p is non-zero, do it for all windows on all
12167 frames. Otherwise do it for selected_window, only. */
12169 if (consider_all_windows_p
)
12171 Lisp_Object tail
, frame
;
12173 FOR_EACH_FRAME (tail
, frame
)
12174 XFRAME (frame
)->updated_p
= 0;
12176 /* Recompute # windows showing selected buffer. This will be
12177 incremented each time such a window is displayed. */
12180 FOR_EACH_FRAME (tail
, frame
)
12182 struct frame
*f
= XFRAME (frame
);
12184 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12186 if (! EQ (frame
, selected_frame
))
12187 /* Select the frame, for the sake of frame-local
12189 select_frame_for_redisplay (frame
);
12191 /* Mark all the scroll bars to be removed; we'll redeem
12192 the ones we want when we redisplay their windows. */
12193 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12194 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12196 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12197 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12199 /* The X error handler may have deleted that frame. */
12200 if (!FRAME_LIVE_P (f
))
12203 /* Any scroll bars which redisplay_windows should have
12204 nuked should now go away. */
12205 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12206 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12208 /* If fonts changed, display again. */
12209 /* ??? rms: I suspect it is a mistake to jump all the way
12210 back to retry here. It should just retry this frame. */
12211 if (fonts_changed_p
)
12214 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12216 /* See if we have to hscroll. */
12217 if (!f
->already_hscrolled_p
)
12219 f
->already_hscrolled_p
= 1;
12220 if (hscroll_windows (f
->root_window
))
12224 /* Prevent various kinds of signals during display
12225 update. stdio is not robust about handling
12226 signals, which can cause an apparent I/O
12228 if (interrupt_input
)
12229 unrequest_sigio ();
12232 /* Update the display. */
12233 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12234 pause
|= update_frame (f
, 0, 0);
12240 if (!EQ (old_frame
, selected_frame
)
12241 && FRAME_LIVE_P (XFRAME (old_frame
)))
12242 /* We played a bit fast-and-loose above and allowed selected_frame
12243 and selected_window to be temporarily out-of-sync but let's make
12244 sure this stays contained. */
12245 select_frame_for_redisplay (old_frame
);
12246 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12250 /* Do the mark_window_display_accurate after all windows have
12251 been redisplayed because this call resets flags in buffers
12252 which are needed for proper redisplay. */
12253 FOR_EACH_FRAME (tail
, frame
)
12255 struct frame
*f
= XFRAME (frame
);
12258 mark_window_display_accurate (f
->root_window
, 1);
12259 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12260 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12265 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12267 Lisp_Object mini_window
;
12268 struct frame
*mini_frame
;
12270 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12271 /* Use list_of_error, not Qerror, so that
12272 we catch only errors and don't run the debugger. */
12273 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12275 redisplay_window_error
);
12277 /* Compare desired and current matrices, perform output. */
12280 /* If fonts changed, display again. */
12281 if (fonts_changed_p
)
12284 /* Prevent various kinds of signals during display update.
12285 stdio is not robust about handling signals,
12286 which can cause an apparent I/O error. */
12287 if (interrupt_input
)
12288 unrequest_sigio ();
12291 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12293 if (hscroll_windows (selected_window
))
12296 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12297 pause
= update_frame (sf
, 0, 0);
12300 /* We may have called echo_area_display at the top of this
12301 function. If the echo area is on another frame, that may
12302 have put text on a frame other than the selected one, so the
12303 above call to update_frame would not have caught it. Catch
12305 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12306 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12308 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12310 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12311 pause
|= update_frame (mini_frame
, 0, 0);
12312 if (!pause
&& hscroll_windows (mini_window
))
12317 /* If display was paused because of pending input, make sure we do a
12318 thorough update the next time. */
12321 /* Prevent the optimization at the beginning of
12322 redisplay_internal that tries a single-line update of the
12323 line containing the cursor in the selected window. */
12324 CHARPOS (this_line_start_pos
) = 0;
12326 /* Let the overlay arrow be updated the next time. */
12327 update_overlay_arrows (0);
12329 /* If we pause after scrolling, some rows in the current
12330 matrices of some windows are not valid. */
12331 if (!WINDOW_FULL_WIDTH_P (w
)
12332 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12333 update_mode_lines
= 1;
12337 if (!consider_all_windows_p
)
12339 /* This has already been done above if
12340 consider_all_windows_p is set. */
12341 mark_window_display_accurate_1 (w
, 1);
12343 /* Say overlay arrows are up to date. */
12344 update_overlay_arrows (1);
12346 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12347 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12350 update_mode_lines
= 0;
12351 windows_or_buffers_changed
= 0;
12352 cursor_type_changed
= 0;
12355 /* Start SIGIO interrupts coming again. Having them off during the
12356 code above makes it less likely one will discard output, but not
12357 impossible, since there might be stuff in the system buffer here.
12358 But it is much hairier to try to do anything about that. */
12359 if (interrupt_input
)
12363 /* If a frame has become visible which was not before, redisplay
12364 again, so that we display it. Expose events for such a frame
12365 (which it gets when becoming visible) don't call the parts of
12366 redisplay constructing glyphs, so simply exposing a frame won't
12367 display anything in this case. So, we have to display these
12368 frames here explicitly. */
12371 Lisp_Object tail
, frame
;
12374 FOR_EACH_FRAME (tail
, frame
)
12376 int this_is_visible
= 0;
12378 if (XFRAME (frame
)->visible
)
12379 this_is_visible
= 1;
12380 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12381 if (XFRAME (frame
)->visible
)
12382 this_is_visible
= 1;
12384 if (this_is_visible
)
12388 if (new_count
!= number_of_visible_frames
)
12389 windows_or_buffers_changed
++;
12392 /* Change frame size now if a change is pending. */
12393 do_pending_window_change (1);
12395 /* If we just did a pending size change, or have additional
12396 visible frames, redisplay again. */
12397 if (windows_or_buffers_changed
&& !pause
)
12400 /* Clear the face cache eventually. */
12401 if (consider_all_windows_p
)
12403 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12405 clear_face_cache (0);
12406 clear_face_cache_count
= 0;
12408 #ifdef HAVE_WINDOW_SYSTEM
12409 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12411 clear_image_caches (Qnil
);
12412 clear_image_cache_count
= 0;
12414 #endif /* HAVE_WINDOW_SYSTEM */
12418 unbind_to (count
, Qnil
);
12423 /* Redisplay, but leave alone any recent echo area message unless
12424 another message has been requested in its place.
12426 This is useful in situations where you need to redisplay but no
12427 user action has occurred, making it inappropriate for the message
12428 area to be cleared. See tracking_off and
12429 wait_reading_process_output for examples of these situations.
12431 FROM_WHERE is an integer saying from where this function was
12432 called. This is useful for debugging. */
12435 redisplay_preserve_echo_area (from_where
)
12438 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12440 if (!NILP (echo_area_buffer
[1]))
12442 /* We have a previously displayed message, but no current
12443 message. Redisplay the previous message. */
12444 display_last_displayed_message_p
= 1;
12445 redisplay_internal (1);
12446 display_last_displayed_message_p
= 0;
12449 redisplay_internal (1);
12451 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12452 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12453 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12457 /* Function registered with record_unwind_protect in
12458 redisplay_internal. Reset redisplaying_p to the value it had
12459 before redisplay_internal was called, and clear
12460 prevent_freeing_realized_faces_p. It also selects the previously
12461 selected frame, unless it has been deleted (by an X connection
12462 failure during redisplay, for example). */
12465 unwind_redisplay (val
)
12468 Lisp_Object old_redisplaying_p
, old_frame
;
12470 old_redisplaying_p
= XCAR (val
);
12471 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12472 old_frame
= XCDR (val
);
12473 if (! EQ (old_frame
, selected_frame
)
12474 && FRAME_LIVE_P (XFRAME (old_frame
)))
12475 select_frame_for_redisplay (old_frame
);
12480 /* Mark the display of window W as accurate or inaccurate. If
12481 ACCURATE_P is non-zero mark display of W as accurate. If
12482 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12483 redisplay_internal is called. */
12486 mark_window_display_accurate_1 (w
, accurate_p
)
12490 if (BUFFERP (w
->buffer
))
12492 struct buffer
*b
= XBUFFER (w
->buffer
);
12495 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12496 w
->last_overlay_modified
12497 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12499 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12503 b
->clip_changed
= 0;
12504 b
->prevent_redisplay_optimizations_p
= 0;
12506 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12507 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12508 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12509 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12511 w
->current_matrix
->buffer
= b
;
12512 w
->current_matrix
->begv
= BUF_BEGV (b
);
12513 w
->current_matrix
->zv
= BUF_ZV (b
);
12515 w
->last_cursor
= w
->cursor
;
12516 w
->last_cursor_off_p
= w
->cursor_off_p
;
12518 if (w
== XWINDOW (selected_window
))
12519 w
->last_point
= make_number (BUF_PT (b
));
12521 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12527 w
->window_end_valid
= w
->buffer
;
12528 w
->update_mode_line
= Qnil
;
12533 /* Mark the display of windows in the window tree rooted at WINDOW as
12534 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12535 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12536 be redisplayed the next time redisplay_internal is called. */
12539 mark_window_display_accurate (window
, accurate_p
)
12540 Lisp_Object window
;
12545 for (; !NILP (window
); window
= w
->next
)
12547 w
= XWINDOW (window
);
12548 mark_window_display_accurate_1 (w
, accurate_p
);
12550 if (!NILP (w
->vchild
))
12551 mark_window_display_accurate (w
->vchild
, accurate_p
);
12552 if (!NILP (w
->hchild
))
12553 mark_window_display_accurate (w
->hchild
, accurate_p
);
12558 update_overlay_arrows (1);
12562 /* Force a thorough redisplay the next time by setting
12563 last_arrow_position and last_arrow_string to t, which is
12564 unequal to any useful value of Voverlay_arrow_... */
12565 update_overlay_arrows (-1);
12570 /* Return value in display table DP (Lisp_Char_Table *) for character
12571 C. Since a display table doesn't have any parent, we don't have to
12572 follow parent. Do not call this function directly but use the
12573 macro DISP_CHAR_VECTOR. */
12576 disp_char_vector (dp
, c
)
12577 struct Lisp_Char_Table
*dp
;
12582 if (ASCII_CHAR_P (c
))
12585 if (SUB_CHAR_TABLE_P (val
))
12586 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12592 XSETCHAR_TABLE (table
, dp
);
12593 val
= char_table_ref (table
, c
);
12602 /***********************************************************************
12604 ***********************************************************************/
12606 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12609 redisplay_windows (window
)
12610 Lisp_Object window
;
12612 while (!NILP (window
))
12614 struct window
*w
= XWINDOW (window
);
12616 if (!NILP (w
->hchild
))
12617 redisplay_windows (w
->hchild
);
12618 else if (!NILP (w
->vchild
))
12619 redisplay_windows (w
->vchild
);
12620 else if (!NILP (w
->buffer
))
12622 displayed_buffer
= XBUFFER (w
->buffer
);
12623 /* Use list_of_error, not Qerror, so that
12624 we catch only errors and don't run the debugger. */
12625 internal_condition_case_1 (redisplay_window_0
, window
,
12627 redisplay_window_error
);
12635 redisplay_window_error ()
12637 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12642 redisplay_window_0 (window
)
12643 Lisp_Object window
;
12645 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12646 redisplay_window (window
, 0);
12651 redisplay_window_1 (window
)
12652 Lisp_Object window
;
12654 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12655 redisplay_window (window
, 1);
12660 /* Increment GLYPH until it reaches END or CONDITION fails while
12661 adding (GLYPH)->pixel_width to X. */
12663 #define SKIP_GLYPHS(glyph, end, x, condition) \
12666 (x) += (glyph)->pixel_width; \
12669 while ((glyph) < (end) && (condition))
12672 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12673 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12674 which positions recorded in ROW differ from current buffer
12677 Return 0 if cursor is not on this row, 1 otherwise. */
12680 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12682 struct glyph_row
*row
;
12683 struct glyph_matrix
*matrix
;
12684 int delta
, delta_bytes
, dy
, dvpos
;
12686 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12687 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12688 struct glyph
*cursor
= NULL
;
12689 /* The last known character position in row. */
12690 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12692 EMACS_INT pt_old
= PT
- delta
;
12693 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12694 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12695 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12696 /* A glyph beyond the edge of TEXT_AREA which we should never
12698 struct glyph
*glyphs_end
= end
;
12699 /* Non-zero means we've found a match for cursor position, but that
12700 glyph has the avoid_cursor_p flag set. */
12701 int match_with_avoid_cursor
= 0;
12702 /* Non-zero means we've seen at least one glyph that came from a
12704 int string_seen
= 0;
12705 /* Largest buffer position seen so far during scan of glyph row. */
12706 EMACS_INT bpos_max
= last_pos
;
12707 /* Last buffer position covered by an overlay string with an integer
12708 `cursor' property. */
12709 EMACS_INT bpos_covered
= 0;
12711 /* Skip over glyphs not having an object at the start and the end of
12712 the row. These are special glyphs like truncation marks on
12713 terminal frames. */
12714 if (row
->displays_text_p
)
12716 if (!row
->reversed_p
)
12719 && INTEGERP (glyph
->object
)
12720 && glyph
->charpos
< 0)
12722 x
+= glyph
->pixel_width
;
12726 && INTEGERP ((end
- 1)->object
)
12727 /* CHARPOS is zero for blanks and stretch glyphs
12728 inserted by extend_face_to_end_of_line. */
12729 && (end
- 1)->charpos
<= 0)
12731 glyph_before
= glyph
- 1;
12738 /* If the glyph row is reversed, we need to process it from back
12739 to front, so swap the edge pointers. */
12740 glyphs_end
= end
= glyph
- 1;
12741 glyph
+= row
->used
[TEXT_AREA
] - 1;
12743 while (glyph
> end
+ 1
12744 && INTEGERP (glyph
->object
)
12745 && glyph
->charpos
< 0)
12748 x
-= glyph
->pixel_width
;
12750 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12752 /* By default, in reversed rows we put the cursor on the
12753 rightmost (first in the reading order) glyph. */
12754 for (g
= end
+ 1; g
< glyph
; g
++)
12755 x
+= g
->pixel_width
;
12757 && INTEGERP ((end
+ 1)->object
)
12758 && (end
+ 1)->charpos
<= 0)
12760 glyph_before
= glyph
+ 1;
12764 else if (row
->reversed_p
)
12766 /* In R2L rows that don't display text, put the cursor on the
12767 rightmost glyph. Case in point: an empty last line that is
12768 part of an R2L paragraph. */
12770 x
= -1; /* will be computed below, at label compute_x */
12773 /* Step 1: Try to find the glyph whose character position
12774 corresponds to point. If that's not possible, find 2 glyphs
12775 whose character positions are the closest to point, one before
12776 point, the other after it. */
12777 if (!row
->reversed_p
)
12778 while (/* not marched to end of glyph row */
12780 /* glyph was not inserted by redisplay for internal purposes */
12781 && !INTEGERP (glyph
->object
))
12783 if (BUFFERP (glyph
->object
))
12785 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12787 if (glyph
->charpos
> bpos_max
)
12788 bpos_max
= glyph
->charpos
;
12789 if (!glyph
->avoid_cursor_p
)
12791 /* If we hit point, we've found the glyph on which to
12792 display the cursor. */
12795 match_with_avoid_cursor
= 0;
12798 /* See if we've found a better approximation to
12799 POS_BEFORE or to POS_AFTER. Note that we want the
12800 first (leftmost) glyph of all those that are the
12801 closest from below, and the last (rightmost) of all
12802 those from above. */
12803 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12805 pos_before
= glyph
->charpos
;
12806 glyph_before
= glyph
;
12808 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12810 pos_after
= glyph
->charpos
;
12811 glyph_after
= glyph
;
12814 else if (dpos
== 0)
12815 match_with_avoid_cursor
= 1;
12817 else if (STRINGP (glyph
->object
))
12819 Lisp_Object chprop
;
12820 int glyph_pos
= glyph
->charpos
;
12822 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12824 if (INTEGERP (chprop
))
12826 bpos_covered
= bpos_max
+ XINT (chprop
);
12827 /* If the `cursor' property covers buffer positions up
12828 to and including point, we should display cursor on
12829 this glyph. Note that overlays and text properties
12830 with string values stop bidi reordering, so every
12831 buffer position to the left of the string is always
12832 smaller than any position to the right of the
12833 string. Therefore, if a `cursor' property on one
12834 of the string's characters has an integer value, we
12835 will break out of the loop below _before_ we get to
12836 the position match above. IOW, integer values of
12837 the `cursor' property override the "exact match for
12838 point" strategy of positioning the cursor. */
12839 /* Implementation note: bpos_max == pt_old when, e.g.,
12840 we are in an empty line, where bpos_max is set to
12841 MATRIX_ROW_START_CHARPOS, see above. */
12842 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12851 x
+= glyph
->pixel_width
;
12854 else if (glyph
> end
) /* row is reversed */
12855 while (!INTEGERP (glyph
->object
))
12857 if (BUFFERP (glyph
->object
))
12859 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12861 if (glyph
->charpos
> bpos_max
)
12862 bpos_max
= glyph
->charpos
;
12863 if (!glyph
->avoid_cursor_p
)
12867 match_with_avoid_cursor
= 0;
12870 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12872 pos_before
= glyph
->charpos
;
12873 glyph_before
= glyph
;
12875 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12877 pos_after
= glyph
->charpos
;
12878 glyph_after
= glyph
;
12881 else if (dpos
== 0)
12882 match_with_avoid_cursor
= 1;
12884 else if (STRINGP (glyph
->object
))
12886 Lisp_Object chprop
;
12887 int glyph_pos
= glyph
->charpos
;
12889 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12891 if (INTEGERP (chprop
))
12893 bpos_covered
= bpos_max
+ XINT (chprop
);
12894 /* If the `cursor' property covers buffer positions up
12895 to and including point, we should display cursor on
12897 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12906 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12908 x
--; /* can't use any pixel_width */
12911 x
-= glyph
->pixel_width
;
12914 /* Step 2: If we didn't find an exact match for point, we need to
12915 look for a proper place to put the cursor among glyphs between
12916 GLYPH_BEFORE and GLYPH_AFTER. */
12917 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12918 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12919 && bpos_covered
< pt_old
)
12921 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12923 EMACS_INT ellipsis_pos
;
12925 /* Scan back over the ellipsis glyphs. */
12926 if (!row
->reversed_p
)
12928 ellipsis_pos
= (glyph
- 1)->charpos
;
12929 while (glyph
> row
->glyphs
[TEXT_AREA
]
12930 && (glyph
- 1)->charpos
== ellipsis_pos
)
12931 glyph
--, x
-= glyph
->pixel_width
;
12932 /* That loop always goes one position too far, including
12933 the glyph before the ellipsis. So scan forward over
12935 x
+= glyph
->pixel_width
;
12938 else /* row is reversed */
12940 ellipsis_pos
= (glyph
+ 1)->charpos
;
12941 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12942 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12943 glyph
++, x
+= glyph
->pixel_width
;
12944 x
-= glyph
->pixel_width
;
12948 else if (match_with_avoid_cursor
12949 /* zero-width characters produce no glyphs */
12950 || ((row
->reversed_p
12951 ? glyph_after
> glyphs_end
12952 : glyph_after
< glyphs_end
)
12953 && eabs (glyph_after
- glyph_before
) == 1))
12955 cursor
= glyph_after
;
12958 else if (string_seen
)
12960 int incr
= row
->reversed_p
? -1 : +1;
12962 /* Need to find the glyph that came out of a string which is
12963 present at point. That glyph is somewhere between
12964 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12965 positioned between POS_BEFORE and POS_AFTER in the
12967 struct glyph
*stop
= glyph_after
;
12968 EMACS_INT pos
= pos_before
;
12971 for (glyph
= glyph_before
+ incr
;
12972 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12975 /* Any glyphs that come from the buffer are here because
12976 of bidi reordering. Skip them, and only pay
12977 attention to glyphs that came from some string. */
12978 if (STRINGP (glyph
->object
))
12983 str
= glyph
->object
;
12984 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12985 if (tem
== 0 /* from overlay */
12988 /* If the string from which this glyph came is
12989 found in the buffer at point, then we've
12990 found the glyph we've been looking for. If
12991 it comes from an overlay (tem == 0), and it
12992 has the `cursor' property on one of its
12993 glyphs, record that glyph as a candidate for
12994 displaying the cursor. (As in the
12995 unidirectional version, we will display the
12996 cursor on the last candidate we find.) */
12997 if (tem
== 0 || tem
== pt_old
)
12999 /* The glyphs from this string could have
13000 been reordered. Find the one with the
13001 smallest string position. Or there could
13002 be a character in the string with the
13003 `cursor' property, which means display
13004 cursor on that character's glyph. */
13005 int strpos
= glyph
->charpos
;
13008 for (glyph
+= incr
;
13009 EQ (glyph
->object
, str
);
13013 int gpos
= glyph
->charpos
;
13015 cprop
= Fget_char_property (make_number (gpos
),
13023 if (glyph
->charpos
< strpos
)
13025 strpos
= glyph
->charpos
;
13034 pos
= tem
+ 1; /* don't find previous instances */
13036 /* This string is not what we want; skip all of the
13037 glyphs that came from it. */
13040 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13041 && EQ (glyph
->object
, str
));
13047 /* If we reached the end of the line, and END was from a string,
13048 the cursor is not on this line. */
13050 && STRINGP ((glyph
- incr
)->object
)
13051 && row
->continued_p
)
13057 if (cursor
!= NULL
)
13063 /* Need to compute x that corresponds to GLYPH. */
13064 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13066 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13068 x
+= g
->pixel_width
;
13072 /* ROW could be part of a continued line, which, under bidi
13073 reordering, might have other rows whose start and end charpos
13074 occlude point. Only set w->cursor if we found a better
13075 approximation to the cursor position than we have from previously
13076 examined candidate rows belonging to the same continued line. */
13077 if (/* we already have a candidate row */
13078 w
->cursor
.vpos
>= 0
13079 /* that candidate is not the row we are processing */
13080 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13081 /* the row we are processing is part of a continued line */
13082 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
13083 /* Make sure cursor.vpos specifies a row whose start and end
13084 charpos occlude point. This is because some callers of this
13085 function leave cursor.vpos at the row where the cursor was
13086 displayed during the last redisplay cycle. */
13087 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13088 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13091 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13093 /* Don't consider glyphs that are outside TEXT_AREA. */
13094 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13096 /* Keep the candidate whose buffer position is the closest to
13098 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13099 w
->cursor
.hpos
>= 0
13100 && w
->cursor
.hpos
< MATRIX_ROW_USED(matrix
, w
->cursor
.vpos
)
13101 && BUFFERP (g1
->object
)
13102 && (g1
->charpos
== pt_old
/* an exact match always wins */
13103 || (BUFFERP (glyph
->object
)
13104 && eabs (g1
->charpos
- pt_old
)
13105 < eabs (glyph
->charpos
- pt_old
))))
13107 /* If this candidate gives an exact match, use that. */
13108 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13109 /* Otherwise, keep the candidate that comes from a row
13110 spanning less buffer positions. This may win when one or
13111 both candidate positions are on glyphs that came from
13112 display strings, for which we cannot compare buffer
13114 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13115 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13116 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13119 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13121 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13122 w
->cursor
.y
= row
->y
+ dy
;
13124 if (w
== XWINDOW (selected_window
))
13126 if (!row
->continued_p
13127 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13130 this_line_buffer
= XBUFFER (w
->buffer
);
13132 CHARPOS (this_line_start_pos
)
13133 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13134 BYTEPOS (this_line_start_pos
)
13135 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13137 CHARPOS (this_line_end_pos
)
13138 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13139 BYTEPOS (this_line_end_pos
)
13140 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13142 this_line_y
= w
->cursor
.y
;
13143 this_line_pixel_height
= row
->height
;
13144 this_line_vpos
= w
->cursor
.vpos
;
13145 this_line_start_x
= row
->x
;
13148 CHARPOS (this_line_start_pos
) = 0;
13155 /* Run window scroll functions, if any, for WINDOW with new window
13156 start STARTP. Sets the window start of WINDOW to that position.
13158 We assume that the window's buffer is really current. */
13160 static INLINE
struct text_pos
13161 run_window_scroll_functions (window
, startp
)
13162 Lisp_Object window
;
13163 struct text_pos startp
;
13165 struct window
*w
= XWINDOW (window
);
13166 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13168 if (current_buffer
!= XBUFFER (w
->buffer
))
13171 if (!NILP (Vwindow_scroll_functions
))
13173 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13174 make_number (CHARPOS (startp
)));
13175 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13176 /* In case the hook functions switch buffers. */
13177 if (current_buffer
!= XBUFFER (w
->buffer
))
13178 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13185 /* Make sure the line containing the cursor is fully visible.
13186 A value of 1 means there is nothing to be done.
13187 (Either the line is fully visible, or it cannot be made so,
13188 or we cannot tell.)
13190 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13191 is higher than window.
13193 A value of 0 means the caller should do scrolling
13194 as if point had gone off the screen. */
13197 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
13200 int current_matrix_p
;
13202 struct glyph_matrix
*matrix
;
13203 struct glyph_row
*row
;
13206 if (!make_cursor_line_fully_visible_p
)
13209 /* It's not always possible to find the cursor, e.g, when a window
13210 is full of overlay strings. Don't do anything in that case. */
13211 if (w
->cursor
.vpos
< 0)
13214 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13215 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13217 /* If the cursor row is not partially visible, there's nothing to do. */
13218 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13221 /* If the row the cursor is in is taller than the window's height,
13222 it's not clear what to do, so do nothing. */
13223 window_height
= window_box_height (w
);
13224 if (row
->height
>= window_height
)
13226 if (!force_p
|| MINI_WINDOW_P (w
)
13227 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13234 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13235 non-zero means only WINDOW is redisplayed in redisplay_internal.
13236 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13237 in redisplay_window to bring a partially visible line into view in
13238 the case that only the cursor has moved.
13240 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13241 last screen line's vertical height extends past the end of the screen.
13245 1 if scrolling succeeded
13247 0 if scrolling didn't find point.
13249 -1 if new fonts have been loaded so that we must interrupt
13250 redisplay, adjust glyph matrices, and try again. */
13256 SCROLLING_NEED_LARGER_MATRICES
13260 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
13261 scroll_step
, temp_scroll_step
, last_line_misfit
)
13262 Lisp_Object window
;
13263 int just_this_one_p
;
13264 EMACS_INT scroll_conservatively
, scroll_step
;
13265 int temp_scroll_step
;
13266 int last_line_misfit
;
13268 struct window
*w
= XWINDOW (window
);
13269 struct frame
*f
= XFRAME (w
->frame
);
13270 struct text_pos pos
, startp
;
13272 int this_scroll_margin
, scroll_max
, rc
, height
;
13273 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13274 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13275 Lisp_Object aggressive
;
13276 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13279 debug_method_add (w
, "try_scrolling");
13282 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13284 /* Compute scroll margin height in pixels. We scroll when point is
13285 within this distance from the top or bottom of the window. */
13286 if (scroll_margin
> 0)
13287 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13288 * FRAME_LINE_HEIGHT (f
);
13290 this_scroll_margin
= 0;
13292 /* Force scroll_conservatively to have a reasonable value, to avoid
13293 overflow while computing how much to scroll. Note that the user
13294 can supply scroll-conservatively equal to `most-positive-fixnum',
13295 which can be larger than INT_MAX. */
13296 if (scroll_conservatively
> scroll_limit
)
13298 scroll_conservatively
= scroll_limit
;
13299 scroll_max
= INT_MAX
;
13301 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13302 /* Compute how much we should try to scroll maximally to bring
13303 point into view. */
13304 scroll_max
= (max (scroll_step
,
13305 max (scroll_conservatively
, temp_scroll_step
))
13306 * FRAME_LINE_HEIGHT (f
));
13307 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13308 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13309 /* We're trying to scroll because of aggressive scrolling but no
13310 scroll_step is set. Choose an arbitrary one. */
13311 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13317 /* Decide whether to scroll down. */
13318 if (PT
> CHARPOS (startp
))
13320 int scroll_margin_y
;
13322 /* Compute the pixel ypos of the scroll margin, then move it to
13323 either that ypos or PT, whichever comes first. */
13324 start_display (&it
, w
, startp
);
13325 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13326 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13327 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13328 (MOVE_TO_POS
| MOVE_TO_Y
));
13330 if (PT
> CHARPOS (it
.current
.pos
))
13332 int y0
= line_bottom_y (&it
);
13334 /* Compute the distance from the scroll margin to PT
13335 (including the height of the cursor line). Moving the
13336 iterator unconditionally to PT can be slow if PT is far
13337 away, so stop 10 lines past the window bottom (is there a
13338 way to do the right thing quickly?). */
13339 move_it_to (&it
, PT
, -1,
13340 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
13341 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13342 dy
= line_bottom_y (&it
) - y0
;
13344 if (dy
> scroll_max
)
13345 return SCROLLING_FAILED
;
13353 /* Point is in or below the bottom scroll margin, so move the
13354 window start down. If scrolling conservatively, move it just
13355 enough down to make point visible. If scroll_step is set,
13356 move it down by scroll_step. */
13357 if (scroll_conservatively
)
13359 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13360 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13361 else if (scroll_step
|| temp_scroll_step
)
13362 amount_to_scroll
= scroll_max
;
13365 aggressive
= current_buffer
->scroll_up_aggressively
;
13366 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13367 if (NUMBERP (aggressive
))
13369 double float_amount
= XFLOATINT (aggressive
) * height
;
13370 amount_to_scroll
= float_amount
;
13371 if (amount_to_scroll
== 0 && float_amount
> 0)
13372 amount_to_scroll
= 1;
13376 if (amount_to_scroll
<= 0)
13377 return SCROLLING_FAILED
;
13379 start_display (&it
, w
, startp
);
13380 move_it_vertically (&it
, amount_to_scroll
);
13382 /* If STARTP is unchanged, move it down another screen line. */
13383 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13384 move_it_by_lines (&it
, 1, 1);
13385 startp
= it
.current
.pos
;
13389 struct text_pos scroll_margin_pos
= startp
;
13391 /* See if point is inside the scroll margin at the top of the
13393 if (this_scroll_margin
)
13395 start_display (&it
, w
, startp
);
13396 move_it_vertically (&it
, this_scroll_margin
);
13397 scroll_margin_pos
= it
.current
.pos
;
13400 if (PT
< CHARPOS (scroll_margin_pos
))
13402 /* Point is in the scroll margin at the top of the window or
13403 above what is displayed in the window. */
13406 /* Compute the vertical distance from PT to the scroll
13407 margin position. Give up if distance is greater than
13409 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13410 start_display (&it
, w
, pos
);
13412 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13413 it
.last_visible_y
, -1,
13414 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13415 dy
= it
.current_y
- y0
;
13416 if (dy
> scroll_max
)
13417 return SCROLLING_FAILED
;
13419 /* Compute new window start. */
13420 start_display (&it
, w
, startp
);
13422 if (scroll_conservatively
)
13424 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13425 else if (scroll_step
|| temp_scroll_step
)
13426 amount_to_scroll
= scroll_max
;
13429 aggressive
= current_buffer
->scroll_down_aggressively
;
13430 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13431 if (NUMBERP (aggressive
))
13433 double float_amount
= XFLOATINT (aggressive
) * height
;
13434 amount_to_scroll
= float_amount
;
13435 if (amount_to_scroll
== 0 && float_amount
> 0)
13436 amount_to_scroll
= 1;
13440 if (amount_to_scroll
<= 0)
13441 return SCROLLING_FAILED
;
13443 move_it_vertically_backward (&it
, amount_to_scroll
);
13444 startp
= it
.current
.pos
;
13448 /* Run window scroll functions. */
13449 startp
= run_window_scroll_functions (window
, startp
);
13451 /* Display the window. Give up if new fonts are loaded, or if point
13453 if (!try_window (window
, startp
, 0))
13454 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13455 else if (w
->cursor
.vpos
< 0)
13457 clear_glyph_matrix (w
->desired_matrix
);
13458 rc
= SCROLLING_FAILED
;
13462 /* Maybe forget recorded base line for line number display. */
13463 if (!just_this_one_p
13464 || current_buffer
->clip_changed
13465 || BEG_UNCHANGED
< CHARPOS (startp
))
13466 w
->base_line_number
= Qnil
;
13468 /* If cursor ends up on a partially visible line,
13469 treat that as being off the bottom of the screen. */
13470 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13472 clear_glyph_matrix (w
->desired_matrix
);
13473 ++extra_scroll_margin_lines
;
13476 rc
= SCROLLING_SUCCESS
;
13483 /* Compute a suitable window start for window W if display of W starts
13484 on a continuation line. Value is non-zero if a new window start
13487 The new window start will be computed, based on W's width, starting
13488 from the start of the continued line. It is the start of the
13489 screen line with the minimum distance from the old start W->start. */
13492 compute_window_start_on_continuation_line (w
)
13495 struct text_pos pos
, start_pos
;
13496 int window_start_changed_p
= 0;
13498 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13500 /* If window start is on a continuation line... Window start may be
13501 < BEGV in case there's invisible text at the start of the
13502 buffer (M-x rmail, for example). */
13503 if (CHARPOS (start_pos
) > BEGV
13504 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13507 struct glyph_row
*row
;
13509 /* Handle the case that the window start is out of range. */
13510 if (CHARPOS (start_pos
) < BEGV
)
13511 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13512 else if (CHARPOS (start_pos
) > ZV
)
13513 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13515 /* Find the start of the continued line. This should be fast
13516 because scan_buffer is fast (newline cache). */
13517 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13518 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13519 row
, DEFAULT_FACE_ID
);
13520 reseat_at_previous_visible_line_start (&it
);
13522 /* If the line start is "too far" away from the window start,
13523 say it takes too much time to compute a new window start. */
13524 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13525 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13527 int min_distance
, distance
;
13529 /* Move forward by display lines to find the new window
13530 start. If window width was enlarged, the new start can
13531 be expected to be > the old start. If window width was
13532 decreased, the new window start will be < the old start.
13533 So, we're looking for the display line start with the
13534 minimum distance from the old window start. */
13535 pos
= it
.current
.pos
;
13536 min_distance
= INFINITY
;
13537 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13538 distance
< min_distance
)
13540 min_distance
= distance
;
13541 pos
= it
.current
.pos
;
13542 move_it_by_lines (&it
, 1, 0);
13545 /* Set the window start there. */
13546 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13547 window_start_changed_p
= 1;
13551 return window_start_changed_p
;
13555 /* Try cursor movement in case text has not changed in window WINDOW,
13556 with window start STARTP. Value is
13558 CURSOR_MOVEMENT_SUCCESS if successful
13560 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13562 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13563 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13564 we want to scroll as if scroll-step were set to 1. See the code.
13566 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13567 which case we have to abort this redisplay, and adjust matrices
13572 CURSOR_MOVEMENT_SUCCESS
,
13573 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13574 CURSOR_MOVEMENT_MUST_SCROLL
,
13575 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13579 try_cursor_movement (window
, startp
, scroll_step
)
13580 Lisp_Object window
;
13581 struct text_pos startp
;
13584 struct window
*w
= XWINDOW (window
);
13585 struct frame
*f
= XFRAME (w
->frame
);
13586 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13589 if (inhibit_try_cursor_movement
)
13593 /* Handle case where text has not changed, only point, and it has
13594 not moved off the frame. */
13595 if (/* Point may be in this window. */
13596 PT
>= CHARPOS (startp
)
13597 /* Selective display hasn't changed. */
13598 && !current_buffer
->clip_changed
13599 /* Function force-mode-line-update is used to force a thorough
13600 redisplay. It sets either windows_or_buffers_changed or
13601 update_mode_lines. So don't take a shortcut here for these
13603 && !update_mode_lines
13604 && !windows_or_buffers_changed
13605 && !cursor_type_changed
13606 /* Can't use this case if highlighting a region. When a
13607 region exists, cursor movement has to do more than just
13609 && !(!NILP (Vtransient_mark_mode
)
13610 && !NILP (current_buffer
->mark_active
))
13611 && NILP (w
->region_showing
)
13612 && NILP (Vshow_trailing_whitespace
)
13613 /* Right after splitting windows, last_point may be nil. */
13614 && INTEGERP (w
->last_point
)
13615 /* This code is not used for mini-buffer for the sake of the case
13616 of redisplaying to replace an echo area message; since in
13617 that case the mini-buffer contents per se are usually
13618 unchanged. This code is of no real use in the mini-buffer
13619 since the handling of this_line_start_pos, etc., in redisplay
13620 handles the same cases. */
13621 && !EQ (window
, minibuf_window
)
13622 /* When splitting windows or for new windows, it happens that
13623 redisplay is called with a nil window_end_vpos or one being
13624 larger than the window. This should really be fixed in
13625 window.c. I don't have this on my list, now, so we do
13626 approximately the same as the old redisplay code. --gerd. */
13627 && INTEGERP (w
->window_end_vpos
)
13628 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13629 && (FRAME_WINDOW_P (f
)
13630 || !overlay_arrow_in_current_buffer_p ()))
13632 int this_scroll_margin
, top_scroll_margin
;
13633 struct glyph_row
*row
= NULL
;
13636 debug_method_add (w
, "cursor movement");
13639 /* Scroll if point within this distance from the top or bottom
13640 of the window. This is a pixel value. */
13641 if (scroll_margin
> 0)
13643 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13644 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13647 this_scroll_margin
= 0;
13649 top_scroll_margin
= this_scroll_margin
;
13650 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13651 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13653 /* Start with the row the cursor was displayed during the last
13654 not paused redisplay. Give up if that row is not valid. */
13655 if (w
->last_cursor
.vpos
< 0
13656 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13657 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13660 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13661 if (row
->mode_line_p
)
13663 if (!row
->enabled_p
)
13664 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13665 /* If rows are bidi-reordered, back up until we find a row
13666 that does not belong to a continuation line. This is
13667 because we must consider all rows of a continued line as
13668 candidates for cursor positioning, since row start and
13669 end positions change non-linearly with vertical position
13671 /* FIXME: Revisit this when glyph ``spilling'' in
13672 continuation lines' rows is implemented for
13673 bidi-reordered rows. */
13674 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13676 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13678 xassert (row
->enabled_p
);
13680 /* If we hit the beginning of the displayed portion
13681 without finding the first row of a continued
13683 if (row
<= w
->current_matrix
->rows
)
13685 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13693 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13696 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13698 if (PT
> XFASTINT (w
->last_point
))
13700 /* Point has moved forward. */
13701 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13702 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13704 xassert (row
->enabled_p
);
13708 /* The end position of a row equals the start position
13709 of the next row. If PT is there, we would rather
13710 display it in the next line. */
13711 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13712 && MATRIX_ROW_END_CHARPOS (row
) == PT
13713 && !cursor_row_p (w
, row
))
13716 /* If within the scroll margin, scroll. Note that
13717 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13718 the next line would be drawn, and that
13719 this_scroll_margin can be zero. */
13720 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13721 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13722 /* Line is completely visible last line in window
13723 and PT is to be set in the next line. */
13724 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13725 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13726 && !row
->ends_at_zv_p
13727 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13730 else if (PT
< XFASTINT (w
->last_point
))
13732 /* Cursor has to be moved backward. Note that PT >=
13733 CHARPOS (startp) because of the outer if-statement. */
13734 while (!row
->mode_line_p
13735 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13736 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13737 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13738 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13739 row
> w
->current_matrix
->rows
13740 && (row
-1)->ends_in_newline_from_string_p
))))
13741 && (row
->y
> top_scroll_margin
13742 || CHARPOS (startp
) == BEGV
))
13744 xassert (row
->enabled_p
);
13748 /* Consider the following case: Window starts at BEGV,
13749 there is invisible, intangible text at BEGV, so that
13750 display starts at some point START > BEGV. It can
13751 happen that we are called with PT somewhere between
13752 BEGV and START. Try to handle that case. */
13753 if (row
< w
->current_matrix
->rows
13754 || row
->mode_line_p
)
13756 row
= w
->current_matrix
->rows
;
13757 if (row
->mode_line_p
)
13761 /* Due to newlines in overlay strings, we may have to
13762 skip forward over overlay strings. */
13763 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13764 && MATRIX_ROW_END_CHARPOS (row
) == PT
13765 && !cursor_row_p (w
, row
))
13768 /* If within the scroll margin, scroll. */
13769 if (row
->y
< top_scroll_margin
13770 && CHARPOS (startp
) != BEGV
)
13775 /* Cursor did not move. So don't scroll even if cursor line
13776 is partially visible, as it was so before. */
13777 rc
= CURSOR_MOVEMENT_SUCCESS
;
13780 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13781 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13783 /* if PT is not in the glyph row, give up. */
13784 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13786 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13787 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13788 && make_cursor_line_fully_visible_p
)
13790 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13791 && !row
->ends_at_zv_p
13792 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13793 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13794 else if (row
->height
> window_box_height (w
))
13796 /* If we end up in a partially visible line, let's
13797 make it fully visible, except when it's taller
13798 than the window, in which case we can't do much
13801 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13805 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13806 if (!cursor_row_fully_visible_p (w
, 0, 1))
13807 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13809 rc
= CURSOR_MOVEMENT_SUCCESS
;
13813 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13814 else if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13816 /* With bidi-reordered rows, there could be more than
13817 one candidate row whose start and end positions
13818 occlude point. We need to let set_cursor_from_row
13819 find the best candidate. */
13820 /* FIXME: Revisit this when glyph ``spilling'' in
13821 continuation lines' rows is implemented for
13822 bidi-reordered rows. */
13827 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13829 /* As soon as we've found the first suitable row
13830 whose ends_at_zv_p flag is set, we are done. */
13832 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13834 rc
= CURSOR_MOVEMENT_SUCCESS
;
13839 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13840 && MATRIX_ROW_START_CHARPOS (row
) <= PT
13841 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13842 && cursor_row_p (w
, row
));
13843 /* If we didn't find any candidate rows, or exited the
13844 loop before all the candidates were examined, signal
13845 to the caller that this method failed. */
13846 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13848 || (MATRIX_ROW_START_CHARPOS (row
) <= PT
13849 && PT
<= MATRIX_ROW_END_CHARPOS (row
))))
13850 rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13852 rc
= CURSOR_MOVEMENT_SUCCESS
;
13858 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13860 rc
= CURSOR_MOVEMENT_SUCCESS
;
13865 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13866 && MATRIX_ROW_START_CHARPOS (row
) == PT
13867 && cursor_row_p (w
, row
));
13876 set_vertical_scroll_bar (w
)
13879 int start
, end
, whole
;
13881 /* Calculate the start and end positions for the current window.
13882 At some point, it would be nice to choose between scrollbars
13883 which reflect the whole buffer size, with special markers
13884 indicating narrowing, and scrollbars which reflect only the
13887 Note that mini-buffers sometimes aren't displaying any text. */
13888 if (!MINI_WINDOW_P (w
)
13889 || (w
== XWINDOW (minibuf_window
)
13890 && NILP (echo_area_buffer
[0])))
13892 struct buffer
*buf
= XBUFFER (w
->buffer
);
13893 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13894 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13895 /* I don't think this is guaranteed to be right. For the
13896 moment, we'll pretend it is. */
13897 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13901 if (whole
< (end
- start
))
13902 whole
= end
- start
;
13905 start
= end
= whole
= 0;
13907 /* Indicate what this scroll bar ought to be displaying now. */
13908 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13909 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13910 (w
, end
- start
, whole
, start
);
13914 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13915 selected_window is redisplayed.
13917 We can return without actually redisplaying the window if
13918 fonts_changed_p is nonzero. In that case, redisplay_internal will
13922 redisplay_window (window
, just_this_one_p
)
13923 Lisp_Object window
;
13924 int just_this_one_p
;
13926 struct window
*w
= XWINDOW (window
);
13927 struct frame
*f
= XFRAME (w
->frame
);
13928 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13929 struct buffer
*old
= current_buffer
;
13930 struct text_pos lpoint
, opoint
, startp
;
13931 int update_mode_line
;
13934 /* Record it now because it's overwritten. */
13935 int current_matrix_up_to_date_p
= 0;
13936 int used_current_matrix_p
= 0;
13937 /* This is less strict than current_matrix_up_to_date_p.
13938 It indictes that the buffer contents and narrowing are unchanged. */
13939 int buffer_unchanged_p
= 0;
13940 int temp_scroll_step
= 0;
13941 int count
= SPECPDL_INDEX ();
13943 int centering_position
= -1;
13944 int last_line_misfit
= 0;
13945 int beg_unchanged
, end_unchanged
;
13947 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13950 /* W must be a leaf window here. */
13951 xassert (!NILP (w
->buffer
));
13953 *w
->desired_matrix
->method
= 0;
13957 reconsider_clip_changes (w
, buffer
);
13959 /* Has the mode line to be updated? */
13960 update_mode_line
= (!NILP (w
->update_mode_line
)
13961 || update_mode_lines
13962 || buffer
->clip_changed
13963 || buffer
->prevent_redisplay_optimizations_p
);
13965 if (MINI_WINDOW_P (w
))
13967 if (w
== XWINDOW (echo_area_window
)
13968 && !NILP (echo_area_buffer
[0]))
13970 if (update_mode_line
)
13971 /* We may have to update a tty frame's menu bar or a
13972 tool-bar. Example `M-x C-h C-h C-g'. */
13973 goto finish_menu_bars
;
13975 /* We've already displayed the echo area glyphs in this window. */
13976 goto finish_scroll_bars
;
13978 else if ((w
!= XWINDOW (minibuf_window
)
13979 || minibuf_level
== 0)
13980 /* When buffer is nonempty, redisplay window normally. */
13981 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13982 /* Quail displays non-mini buffers in minibuffer window.
13983 In that case, redisplay the window normally. */
13984 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13986 /* W is a mini-buffer window, but it's not active, so clear
13988 int yb
= window_text_bottom_y (w
);
13989 struct glyph_row
*row
;
13992 for (y
= 0, row
= w
->desired_matrix
->rows
;
13994 y
+= row
->height
, ++row
)
13995 blank_row (w
, row
, y
);
13996 goto finish_scroll_bars
;
13999 clear_glyph_matrix (w
->desired_matrix
);
14002 /* Otherwise set up data on this window; select its buffer and point
14004 /* Really select the buffer, for the sake of buffer-local
14006 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14008 current_matrix_up_to_date_p
14009 = (!NILP (w
->window_end_valid
)
14010 && !current_buffer
->clip_changed
14011 && !current_buffer
->prevent_redisplay_optimizations_p
14012 && XFASTINT (w
->last_modified
) >= MODIFF
14013 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14015 /* Run the window-bottom-change-functions
14016 if it is possible that the text on the screen has changed
14017 (either due to modification of the text, or any other reason). */
14018 if (!current_matrix_up_to_date_p
14019 && !NILP (Vwindow_text_change_functions
))
14021 safe_run_hooks (Qwindow_text_change_functions
);
14025 beg_unchanged
= BEG_UNCHANGED
;
14026 end_unchanged
= END_UNCHANGED
;
14028 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14030 specbind (Qinhibit_point_motion_hooks
, Qt
);
14033 = (!NILP (w
->window_end_valid
)
14034 && !current_buffer
->clip_changed
14035 && XFASTINT (w
->last_modified
) >= MODIFF
14036 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14038 /* When windows_or_buffers_changed is non-zero, we can't rely on
14039 the window end being valid, so set it to nil there. */
14040 if (windows_or_buffers_changed
)
14042 /* If window starts on a continuation line, maybe adjust the
14043 window start in case the window's width changed. */
14044 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14045 compute_window_start_on_continuation_line (w
);
14047 w
->window_end_valid
= Qnil
;
14050 /* Some sanity checks. */
14051 CHECK_WINDOW_END (w
);
14052 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14054 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14057 /* If %c is in mode line, update it if needed. */
14058 if (!NILP (w
->column_number_displayed
)
14059 /* This alternative quickly identifies a common case
14060 where no change is needed. */
14061 && !(PT
== XFASTINT (w
->last_point
)
14062 && XFASTINT (w
->last_modified
) >= MODIFF
14063 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14064 && (XFASTINT (w
->column_number_displayed
)
14065 != (int) current_column ())) /* iftc */
14066 update_mode_line
= 1;
14068 /* Count number of windows showing the selected buffer. An indirect
14069 buffer counts as its base buffer. */
14070 if (!just_this_one_p
)
14072 struct buffer
*current_base
, *window_base
;
14073 current_base
= current_buffer
;
14074 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14075 if (current_base
->base_buffer
)
14076 current_base
= current_base
->base_buffer
;
14077 if (window_base
->base_buffer
)
14078 window_base
= window_base
->base_buffer
;
14079 if (current_base
== window_base
)
14083 /* Point refers normally to the selected window. For any other
14084 window, set up appropriate value. */
14085 if (!EQ (window
, selected_window
))
14087 int new_pt
= XMARKER (w
->pointm
)->charpos
;
14088 int new_pt_byte
= marker_byte_position (w
->pointm
);
14092 new_pt_byte
= BEGV_BYTE
;
14093 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14095 else if (new_pt
> (ZV
- 1))
14098 new_pt_byte
= ZV_BYTE
;
14099 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14102 /* We don't use SET_PT so that the point-motion hooks don't run. */
14103 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14106 /* If any of the character widths specified in the display table
14107 have changed, invalidate the width run cache. It's true that
14108 this may be a bit late to catch such changes, but the rest of
14109 redisplay goes (non-fatally) haywire when the display table is
14110 changed, so why should we worry about doing any better? */
14111 if (current_buffer
->width_run_cache
)
14113 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14115 if (! disptab_matches_widthtab (disptab
,
14116 XVECTOR (current_buffer
->width_table
)))
14118 invalidate_region_cache (current_buffer
,
14119 current_buffer
->width_run_cache
,
14121 recompute_width_table (current_buffer
, disptab
);
14125 /* If window-start is screwed up, choose a new one. */
14126 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14129 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14131 /* If someone specified a new starting point but did not insist,
14132 check whether it can be used. */
14133 if (!NILP (w
->optional_new_start
)
14134 && CHARPOS (startp
) >= BEGV
14135 && CHARPOS (startp
) <= ZV
)
14137 w
->optional_new_start
= Qnil
;
14138 start_display (&it
, w
, startp
);
14139 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14140 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14141 if (IT_CHARPOS (it
) == PT
)
14142 w
->force_start
= Qt
;
14143 /* IT may overshoot PT if text at PT is invisible. */
14144 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14145 w
->force_start
= Qt
;
14150 /* Handle case where place to start displaying has been specified,
14151 unless the specified location is outside the accessible range. */
14152 if (!NILP (w
->force_start
)
14153 || w
->frozen_window_start_p
)
14155 /* We set this later on if we have to adjust point. */
14158 w
->force_start
= Qnil
;
14160 w
->window_end_valid
= Qnil
;
14162 /* Forget any recorded base line for line number display. */
14163 if (!buffer_unchanged_p
)
14164 w
->base_line_number
= Qnil
;
14166 /* Redisplay the mode line. Select the buffer properly for that.
14167 Also, run the hook window-scroll-functions
14168 because we have scrolled. */
14169 /* Note, we do this after clearing force_start because
14170 if there's an error, it is better to forget about force_start
14171 than to get into an infinite loop calling the hook functions
14172 and having them get more errors. */
14173 if (!update_mode_line
14174 || ! NILP (Vwindow_scroll_functions
))
14176 update_mode_line
= 1;
14177 w
->update_mode_line
= Qt
;
14178 startp
= run_window_scroll_functions (window
, startp
);
14181 w
->last_modified
= make_number (0);
14182 w
->last_overlay_modified
= make_number (0);
14183 if (CHARPOS (startp
) < BEGV
)
14184 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14185 else if (CHARPOS (startp
) > ZV
)
14186 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14188 /* Redisplay, then check if cursor has been set during the
14189 redisplay. Give up if new fonts were loaded. */
14190 /* We used to issue a CHECK_MARGINS argument to try_window here,
14191 but this causes scrolling to fail when point begins inside
14192 the scroll margin (bug#148) -- cyd */
14193 if (!try_window (window
, startp
, 0))
14195 w
->force_start
= Qt
;
14196 clear_glyph_matrix (w
->desired_matrix
);
14197 goto need_larger_matrices
;
14200 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14202 /* If point does not appear, try to move point so it does
14203 appear. The desired matrix has been built above, so we
14204 can use it here. */
14205 new_vpos
= window_box_height (w
) / 2;
14208 if (!cursor_row_fully_visible_p (w
, 0, 0))
14210 /* Point does appear, but on a line partly visible at end of window.
14211 Move it back to a fully-visible line. */
14212 new_vpos
= window_box_height (w
);
14215 /* If we need to move point for either of the above reasons,
14216 now actually do it. */
14219 struct glyph_row
*row
;
14221 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14222 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14225 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14226 MATRIX_ROW_START_BYTEPOS (row
));
14228 if (w
!= XWINDOW (selected_window
))
14229 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14230 else if (current_buffer
== old
)
14231 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14233 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14235 /* If we are highlighting the region, then we just changed
14236 the region, so redisplay to show it. */
14237 if (!NILP (Vtransient_mark_mode
)
14238 && !NILP (current_buffer
->mark_active
))
14240 clear_glyph_matrix (w
->desired_matrix
);
14241 if (!try_window (window
, startp
, 0))
14242 goto need_larger_matrices
;
14247 debug_method_add (w
, "forced window start");
14252 /* Handle case where text has not changed, only point, and it has
14253 not moved off the frame, and we are not retrying after hscroll.
14254 (current_matrix_up_to_date_p is nonzero when retrying.) */
14255 if (current_matrix_up_to_date_p
14256 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14257 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14261 case CURSOR_MOVEMENT_SUCCESS
:
14262 used_current_matrix_p
= 1;
14265 case CURSOR_MOVEMENT_MUST_SCROLL
:
14266 goto try_to_scroll
;
14272 /* If current starting point was originally the beginning of a line
14273 but no longer is, find a new starting point. */
14274 else if (!NILP (w
->start_at_line_beg
)
14275 && !(CHARPOS (startp
) <= BEGV
14276 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14279 debug_method_add (w
, "recenter 1");
14284 /* Try scrolling with try_window_id. Value is > 0 if update has
14285 been done, it is -1 if we know that the same window start will
14286 not work. It is 0 if unsuccessful for some other reason. */
14287 else if ((tem
= try_window_id (w
)) != 0)
14290 debug_method_add (w
, "try_window_id %d", tem
);
14293 if (fonts_changed_p
)
14294 goto need_larger_matrices
;
14298 /* Otherwise try_window_id has returned -1 which means that we
14299 don't want the alternative below this comment to execute. */
14301 else if (CHARPOS (startp
) >= BEGV
14302 && CHARPOS (startp
) <= ZV
14303 && PT
>= CHARPOS (startp
)
14304 && (CHARPOS (startp
) < ZV
14305 /* Avoid starting at end of buffer. */
14306 || CHARPOS (startp
) == BEGV
14307 || (XFASTINT (w
->last_modified
) >= MODIFF
14308 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14311 /* If first window line is a continuation line, and window start
14312 is inside the modified region, but the first change is before
14313 current window start, we must select a new window start.
14315 However, if this is the result of a down-mouse event (e.g. by
14316 extending the mouse-drag-overlay), we don't want to select a
14317 new window start, since that would change the position under
14318 the mouse, resulting in an unwanted mouse-movement rather
14319 than a simple mouse-click. */
14320 if (NILP (w
->start_at_line_beg
)
14321 && NILP (do_mouse_tracking
)
14322 && CHARPOS (startp
) > BEGV
14323 && CHARPOS (startp
) > BEG
+ beg_unchanged
14324 && CHARPOS (startp
) <= Z
- end_unchanged
14325 /* Even if w->start_at_line_beg is nil, a new window may
14326 start at a line_beg, since that's how set_buffer_window
14327 sets it. So, we need to check the return value of
14328 compute_window_start_on_continuation_line. (See also
14330 && XMARKER (w
->start
)->buffer
== current_buffer
14331 && compute_window_start_on_continuation_line (w
))
14333 w
->force_start
= Qt
;
14334 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14339 debug_method_add (w
, "same window start");
14342 /* Try to redisplay starting at same place as before.
14343 If point has not moved off frame, accept the results. */
14344 if (!current_matrix_up_to_date_p
14345 /* Don't use try_window_reusing_current_matrix in this case
14346 because a window scroll function can have changed the
14348 || !NILP (Vwindow_scroll_functions
)
14349 || MINI_WINDOW_P (w
)
14350 || !(used_current_matrix_p
14351 = try_window_reusing_current_matrix (w
)))
14353 IF_DEBUG (debug_method_add (w
, "1"));
14354 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14355 /* -1 means we need to scroll.
14356 0 means we need new matrices, but fonts_changed_p
14357 is set in that case, so we will detect it below. */
14358 goto try_to_scroll
;
14361 if (fonts_changed_p
)
14362 goto need_larger_matrices
;
14364 if (w
->cursor
.vpos
>= 0)
14366 if (!just_this_one_p
14367 || current_buffer
->clip_changed
14368 || BEG_UNCHANGED
< CHARPOS (startp
))
14369 /* Forget any recorded base line for line number display. */
14370 w
->base_line_number
= Qnil
;
14372 if (!cursor_row_fully_visible_p (w
, 1, 0))
14374 clear_glyph_matrix (w
->desired_matrix
);
14375 last_line_misfit
= 1;
14377 /* Drop through and scroll. */
14382 clear_glyph_matrix (w
->desired_matrix
);
14387 w
->last_modified
= make_number (0);
14388 w
->last_overlay_modified
= make_number (0);
14390 /* Redisplay the mode line. Select the buffer properly for that. */
14391 if (!update_mode_line
)
14393 update_mode_line
= 1;
14394 w
->update_mode_line
= Qt
;
14397 /* Try to scroll by specified few lines. */
14398 if ((scroll_conservatively
14400 || temp_scroll_step
14401 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14402 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14403 && !current_buffer
->clip_changed
14404 && CHARPOS (startp
) >= BEGV
14405 && CHARPOS (startp
) <= ZV
)
14407 /* The function returns -1 if new fonts were loaded, 1 if
14408 successful, 0 if not successful. */
14409 int rc
= try_scrolling (window
, just_this_one_p
,
14410 scroll_conservatively
,
14412 temp_scroll_step
, last_line_misfit
);
14415 case SCROLLING_SUCCESS
:
14418 case SCROLLING_NEED_LARGER_MATRICES
:
14419 goto need_larger_matrices
;
14421 case SCROLLING_FAILED
:
14429 /* Finally, just choose place to start which centers point */
14432 if (centering_position
< 0)
14433 centering_position
= window_box_height (w
) / 2;
14436 debug_method_add (w
, "recenter");
14439 /* w->vscroll = 0; */
14441 /* Forget any previously recorded base line for line number display. */
14442 if (!buffer_unchanged_p
)
14443 w
->base_line_number
= Qnil
;
14445 /* Move backward half the height of the window. */
14446 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14447 it
.current_y
= it
.last_visible_y
;
14448 move_it_vertically_backward (&it
, centering_position
);
14449 xassert (IT_CHARPOS (it
) >= BEGV
);
14451 /* The function move_it_vertically_backward may move over more
14452 than the specified y-distance. If it->w is small, e.g. a
14453 mini-buffer window, we may end up in front of the window's
14454 display area. Start displaying at the start of the line
14455 containing PT in this case. */
14456 if (it
.current_y
<= 0)
14458 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14459 move_it_vertically_backward (&it
, 0);
14463 it
.current_x
= it
.hpos
= 0;
14465 /* Set startp here explicitly in case that helps avoid an infinite loop
14466 in case the window-scroll-functions functions get errors. */
14467 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14469 /* Run scroll hooks. */
14470 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14472 /* Redisplay the window. */
14473 if (!current_matrix_up_to_date_p
14474 || windows_or_buffers_changed
14475 || cursor_type_changed
14476 /* Don't use try_window_reusing_current_matrix in this case
14477 because it can have changed the buffer. */
14478 || !NILP (Vwindow_scroll_functions
)
14479 || !just_this_one_p
14480 || MINI_WINDOW_P (w
)
14481 || !(used_current_matrix_p
14482 = try_window_reusing_current_matrix (w
)))
14483 try_window (window
, startp
, 0);
14485 /* If new fonts have been loaded (due to fontsets), give up. We
14486 have to start a new redisplay since we need to re-adjust glyph
14488 if (fonts_changed_p
)
14489 goto need_larger_matrices
;
14491 /* If cursor did not appear assume that the middle of the window is
14492 in the first line of the window. Do it again with the next line.
14493 (Imagine a window of height 100, displaying two lines of height
14494 60. Moving back 50 from it->last_visible_y will end in the first
14496 if (w
->cursor
.vpos
< 0)
14498 if (!NILP (w
->window_end_valid
)
14499 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14501 clear_glyph_matrix (w
->desired_matrix
);
14502 move_it_by_lines (&it
, 1, 0);
14503 try_window (window
, it
.current
.pos
, 0);
14505 else if (PT
< IT_CHARPOS (it
))
14507 clear_glyph_matrix (w
->desired_matrix
);
14508 move_it_by_lines (&it
, -1, 0);
14509 try_window (window
, it
.current
.pos
, 0);
14513 /* Not much we can do about it. */
14517 /* Consider the following case: Window starts at BEGV, there is
14518 invisible, intangible text at BEGV, so that display starts at
14519 some point START > BEGV. It can happen that we are called with
14520 PT somewhere between BEGV and START. Try to handle that case. */
14521 if (w
->cursor
.vpos
< 0)
14523 struct glyph_row
*row
= w
->current_matrix
->rows
;
14524 if (row
->mode_line_p
)
14526 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14529 if (!cursor_row_fully_visible_p (w
, 0, 0))
14531 /* If vscroll is enabled, disable it and try again. */
14535 clear_glyph_matrix (w
->desired_matrix
);
14539 /* If centering point failed to make the whole line visible,
14540 put point at the top instead. That has to make the whole line
14541 visible, if it can be done. */
14542 if (centering_position
== 0)
14545 clear_glyph_matrix (w
->desired_matrix
);
14546 centering_position
= 0;
14552 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14553 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14554 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14557 /* Display the mode line, if we must. */
14558 if ((update_mode_line
14559 /* If window not full width, must redo its mode line
14560 if (a) the window to its side is being redone and
14561 (b) we do a frame-based redisplay. This is a consequence
14562 of how inverted lines are drawn in frame-based redisplay. */
14563 || (!just_this_one_p
14564 && !FRAME_WINDOW_P (f
)
14565 && !WINDOW_FULL_WIDTH_P (w
))
14566 /* Line number to display. */
14567 || INTEGERP (w
->base_line_pos
)
14568 /* Column number is displayed and different from the one displayed. */
14569 || (!NILP (w
->column_number_displayed
)
14570 && (XFASTINT (w
->column_number_displayed
)
14571 != (int) current_column ()))) /* iftc */
14572 /* This means that the window has a mode line. */
14573 && (WINDOW_WANTS_MODELINE_P (w
)
14574 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14576 display_mode_lines (w
);
14578 /* If mode line height has changed, arrange for a thorough
14579 immediate redisplay using the correct mode line height. */
14580 if (WINDOW_WANTS_MODELINE_P (w
)
14581 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14583 fonts_changed_p
= 1;
14584 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14585 = DESIRED_MODE_LINE_HEIGHT (w
);
14588 /* If header line height has changed, arrange for a thorough
14589 immediate redisplay using the correct header line height. */
14590 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14591 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14593 fonts_changed_p
= 1;
14594 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14595 = DESIRED_HEADER_LINE_HEIGHT (w
);
14598 if (fonts_changed_p
)
14599 goto need_larger_matrices
;
14602 if (!line_number_displayed
14603 && !BUFFERP (w
->base_line_pos
))
14605 w
->base_line_pos
= Qnil
;
14606 w
->base_line_number
= Qnil
;
14611 /* When we reach a frame's selected window, redo the frame's menu bar. */
14612 if (update_mode_line
14613 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14615 int redisplay_menu_p
= 0;
14616 int redisplay_tool_bar_p
= 0;
14618 if (FRAME_WINDOW_P (f
))
14620 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14621 || defined (HAVE_NS) || defined (USE_GTK)
14622 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14624 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14628 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14630 if (redisplay_menu_p
)
14631 display_menu_bar (w
);
14633 #ifdef HAVE_WINDOW_SYSTEM
14634 if (FRAME_WINDOW_P (f
))
14636 #if defined (USE_GTK) || defined (HAVE_NS)
14637 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14639 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14640 && (FRAME_TOOL_BAR_LINES (f
) > 0
14641 || !NILP (Vauto_resize_tool_bars
));
14644 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14646 extern int ignore_mouse_drag_p
;
14647 ignore_mouse_drag_p
= 1;
14653 #ifdef HAVE_WINDOW_SYSTEM
14654 if (FRAME_WINDOW_P (f
)
14655 && update_window_fringes (w
, (just_this_one_p
14656 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14657 || w
->pseudo_window_p
)))
14661 if (draw_window_fringes (w
, 1))
14662 x_draw_vertical_border (w
);
14666 #endif /* HAVE_WINDOW_SYSTEM */
14668 /* We go to this label, with fonts_changed_p nonzero,
14669 if it is necessary to try again using larger glyph matrices.
14670 We have to redeem the scroll bar even in this case,
14671 because the loop in redisplay_internal expects that. */
14672 need_larger_matrices
:
14674 finish_scroll_bars
:
14676 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14678 /* Set the thumb's position and size. */
14679 set_vertical_scroll_bar (w
);
14681 /* Note that we actually used the scroll bar attached to this
14682 window, so it shouldn't be deleted at the end of redisplay. */
14683 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14684 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14687 /* Restore current_buffer and value of point in it. */
14688 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14689 set_buffer_internal_1 (old
);
14690 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14691 shorter. This can be caused by log truncation in *Messages*. */
14692 if (CHARPOS (lpoint
) <= ZV
)
14693 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14695 unbind_to (count
, Qnil
);
14699 /* Build the complete desired matrix of WINDOW with a window start
14700 buffer position POS.
14702 Value is 1 if successful. It is zero if fonts were loaded during
14703 redisplay which makes re-adjusting glyph matrices necessary, and -1
14704 if point would appear in the scroll margins.
14705 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14706 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14710 try_window (window
, pos
, flags
)
14711 Lisp_Object window
;
14712 struct text_pos pos
;
14715 struct window
*w
= XWINDOW (window
);
14717 struct glyph_row
*last_text_row
= NULL
;
14718 struct frame
*f
= XFRAME (w
->frame
);
14720 /* Make POS the new window start. */
14721 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14723 /* Mark cursor position as unknown. No overlay arrow seen. */
14724 w
->cursor
.vpos
= -1;
14725 overlay_arrow_seen
= 0;
14727 /* Initialize iterator and info to start at POS. */
14728 start_display (&it
, w
, pos
);
14730 /* Display all lines of W. */
14731 while (it
.current_y
< it
.last_visible_y
)
14733 if (display_line (&it
))
14734 last_text_row
= it
.glyph_row
- 1;
14735 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14739 /* Don't let the cursor end in the scroll margins. */
14740 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14741 && !MINI_WINDOW_P (w
))
14743 int this_scroll_margin
;
14745 if (scroll_margin
> 0)
14747 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14748 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14751 this_scroll_margin
= 0;
14753 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14754 && w
->cursor
.y
< this_scroll_margin
14755 && CHARPOS (pos
) > BEGV
14756 && IT_CHARPOS (it
) < ZV
)
14757 /* rms: considering make_cursor_line_fully_visible_p here
14758 seems to give wrong results. We don't want to recenter
14759 when the last line is partly visible, we want to allow
14760 that case to be handled in the usual way. */
14761 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14763 w
->cursor
.vpos
= -1;
14764 clear_glyph_matrix (w
->desired_matrix
);
14769 /* If bottom moved off end of frame, change mode line percentage. */
14770 if (XFASTINT (w
->window_end_pos
) <= 0
14771 && Z
!= IT_CHARPOS (it
))
14772 w
->update_mode_line
= Qt
;
14774 /* Set window_end_pos to the offset of the last character displayed
14775 on the window from the end of current_buffer. Set
14776 window_end_vpos to its row number. */
14779 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14780 w
->window_end_bytepos
14781 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14783 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14785 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14786 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14787 ->displays_text_p
);
14791 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14792 w
->window_end_pos
= make_number (Z
- ZV
);
14793 w
->window_end_vpos
= make_number (0);
14796 /* But that is not valid info until redisplay finishes. */
14797 w
->window_end_valid
= Qnil
;
14803 /************************************************************************
14804 Window redisplay reusing current matrix when buffer has not changed
14805 ************************************************************************/
14807 /* Try redisplay of window W showing an unchanged buffer with a
14808 different window start than the last time it was displayed by
14809 reusing its current matrix. Value is non-zero if successful.
14810 W->start is the new window start. */
14813 try_window_reusing_current_matrix (w
)
14816 struct frame
*f
= XFRAME (w
->frame
);
14817 struct glyph_row
*row
, *bottom_row
;
14820 struct text_pos start
, new_start
;
14821 int nrows_scrolled
, i
;
14822 struct glyph_row
*last_text_row
;
14823 struct glyph_row
*last_reused_text_row
;
14824 struct glyph_row
*start_row
;
14825 int start_vpos
, min_y
, max_y
;
14828 if (inhibit_try_window_reusing
)
14832 if (/* This function doesn't handle terminal frames. */
14833 !FRAME_WINDOW_P (f
)
14834 /* Don't try to reuse the display if windows have been split
14836 || windows_or_buffers_changed
14837 || cursor_type_changed
)
14840 /* Can't do this if region may have changed. */
14841 if ((!NILP (Vtransient_mark_mode
)
14842 && !NILP (current_buffer
->mark_active
))
14843 || !NILP (w
->region_showing
)
14844 || !NILP (Vshow_trailing_whitespace
))
14847 /* If top-line visibility has changed, give up. */
14848 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14849 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14852 /* Give up if old or new display is scrolled vertically. We could
14853 make this function handle this, but right now it doesn't. */
14854 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14855 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14858 /* The variable new_start now holds the new window start. The old
14859 start `start' can be determined from the current matrix. */
14860 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14861 start
= start_row
->start
.pos
;
14862 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14864 /* Clear the desired matrix for the display below. */
14865 clear_glyph_matrix (w
->desired_matrix
);
14867 if (CHARPOS (new_start
) <= CHARPOS (start
))
14871 /* Don't use this method if the display starts with an ellipsis
14872 displayed for invisible text. It's not easy to handle that case
14873 below, and it's certainly not worth the effort since this is
14874 not a frequent case. */
14875 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14878 IF_DEBUG (debug_method_add (w
, "twu1"));
14880 /* Display up to a row that can be reused. The variable
14881 last_text_row is set to the last row displayed that displays
14882 text. Note that it.vpos == 0 if or if not there is a
14883 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14884 start_display (&it
, w
, new_start
);
14885 first_row_y
= it
.current_y
;
14886 w
->cursor
.vpos
= -1;
14887 last_text_row
= last_reused_text_row
= NULL
;
14889 while (it
.current_y
< it
.last_visible_y
14890 && !fonts_changed_p
)
14892 /* If we have reached into the characters in the START row,
14893 that means the line boundaries have changed. So we
14894 can't start copying with the row START. Maybe it will
14895 work to start copying with the following row. */
14896 while (IT_CHARPOS (it
) > CHARPOS (start
))
14898 /* Advance to the next row as the "start". */
14900 start
= start_row
->start
.pos
;
14901 /* If there are no more rows to try, or just one, give up. */
14902 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14903 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14904 || CHARPOS (start
) == ZV
)
14906 clear_glyph_matrix (w
->desired_matrix
);
14910 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14912 /* If we have reached alignment,
14913 we can copy the rest of the rows. */
14914 if (IT_CHARPOS (it
) == CHARPOS (start
))
14917 if (display_line (&it
))
14918 last_text_row
= it
.glyph_row
- 1;
14921 /* A value of current_y < last_visible_y means that we stopped
14922 at the previous window start, which in turn means that we
14923 have at least one reusable row. */
14924 if (it
.current_y
< it
.last_visible_y
)
14926 /* IT.vpos always starts from 0; it counts text lines. */
14927 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14929 /* Find PT if not already found in the lines displayed. */
14930 if (w
->cursor
.vpos
< 0)
14932 int dy
= it
.current_y
- start_row
->y
;
14934 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14935 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14937 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14938 dy
, nrows_scrolled
);
14941 clear_glyph_matrix (w
->desired_matrix
);
14946 /* Scroll the display. Do it before the current matrix is
14947 changed. The problem here is that update has not yet
14948 run, i.e. part of the current matrix is not up to date.
14949 scroll_run_hook will clear the cursor, and use the
14950 current matrix to get the height of the row the cursor is
14952 run
.current_y
= start_row
->y
;
14953 run
.desired_y
= it
.current_y
;
14954 run
.height
= it
.last_visible_y
- it
.current_y
;
14956 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14959 FRAME_RIF (f
)->update_window_begin_hook (w
);
14960 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14961 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14962 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14966 /* Shift current matrix down by nrows_scrolled lines. */
14967 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14968 rotate_matrix (w
->current_matrix
,
14970 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14973 /* Disable lines that must be updated. */
14974 for (i
= 0; i
< nrows_scrolled
; ++i
)
14975 (start_row
+ i
)->enabled_p
= 0;
14977 /* Re-compute Y positions. */
14978 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14979 max_y
= it
.last_visible_y
;
14980 for (row
= start_row
+ nrows_scrolled
;
14984 row
->y
= it
.current_y
;
14985 row
->visible_height
= row
->height
;
14987 if (row
->y
< min_y
)
14988 row
->visible_height
-= min_y
- row
->y
;
14989 if (row
->y
+ row
->height
> max_y
)
14990 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14991 row
->redraw_fringe_bitmaps_p
= 1;
14993 it
.current_y
+= row
->height
;
14995 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14996 last_reused_text_row
= row
;
14997 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15001 /* Disable lines in the current matrix which are now
15002 below the window. */
15003 for (++row
; row
< bottom_row
; ++row
)
15004 row
->enabled_p
= row
->mode_line_p
= 0;
15007 /* Update window_end_pos etc.; last_reused_text_row is the last
15008 reused row from the current matrix containing text, if any.
15009 The value of last_text_row is the last displayed line
15010 containing text. */
15011 if (last_reused_text_row
)
15013 w
->window_end_bytepos
15014 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15016 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15018 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15019 w
->current_matrix
));
15021 else if (last_text_row
)
15023 w
->window_end_bytepos
15024 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15026 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15028 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15032 /* This window must be completely empty. */
15033 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15034 w
->window_end_pos
= make_number (Z
- ZV
);
15035 w
->window_end_vpos
= make_number (0);
15037 w
->window_end_valid
= Qnil
;
15039 /* Update hint: don't try scrolling again in update_window. */
15040 w
->desired_matrix
->no_scrolling_p
= 1;
15043 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15047 else if (CHARPOS (new_start
) > CHARPOS (start
))
15049 struct glyph_row
*pt_row
, *row
;
15050 struct glyph_row
*first_reusable_row
;
15051 struct glyph_row
*first_row_to_display
;
15053 int yb
= window_text_bottom_y (w
);
15055 /* Find the row starting at new_start, if there is one. Don't
15056 reuse a partially visible line at the end. */
15057 first_reusable_row
= start_row
;
15058 while (first_reusable_row
->enabled_p
15059 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15060 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15061 < CHARPOS (new_start
)))
15062 ++first_reusable_row
;
15064 /* Give up if there is no row to reuse. */
15065 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15066 || !first_reusable_row
->enabled_p
15067 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15068 != CHARPOS (new_start
)))
15071 /* We can reuse fully visible rows beginning with
15072 first_reusable_row to the end of the window. Set
15073 first_row_to_display to the first row that cannot be reused.
15074 Set pt_row to the row containing point, if there is any. */
15076 for (first_row_to_display
= first_reusable_row
;
15077 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15078 ++first_row_to_display
)
15080 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15081 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15082 pt_row
= first_row_to_display
;
15085 /* Start displaying at the start of first_row_to_display. */
15086 xassert (first_row_to_display
->y
< yb
);
15087 init_to_row_start (&it
, w
, first_row_to_display
);
15089 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15091 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15093 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15094 + WINDOW_HEADER_LINE_HEIGHT (w
));
15096 /* Display lines beginning with first_row_to_display in the
15097 desired matrix. Set last_text_row to the last row displayed
15098 that displays text. */
15099 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15100 if (pt_row
== NULL
)
15101 w
->cursor
.vpos
= -1;
15102 last_text_row
= NULL
;
15103 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15104 if (display_line (&it
))
15105 last_text_row
= it
.glyph_row
- 1;
15107 /* If point is in a reused row, adjust y and vpos of the cursor
15111 w
->cursor
.vpos
-= nrows_scrolled
;
15112 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15115 /* Give up if point isn't in a row displayed or reused. (This
15116 also handles the case where w->cursor.vpos < nrows_scrolled
15117 after the calls to display_line, which can happen with scroll
15118 margins. See bug#1295.) */
15119 if (w
->cursor
.vpos
< 0)
15121 clear_glyph_matrix (w
->desired_matrix
);
15125 /* Scroll the display. */
15126 run
.current_y
= first_reusable_row
->y
;
15127 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15128 run
.height
= it
.last_visible_y
- run
.current_y
;
15129 dy
= run
.current_y
- run
.desired_y
;
15134 FRAME_RIF (f
)->update_window_begin_hook (w
);
15135 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15136 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15137 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15141 /* Adjust Y positions of reused rows. */
15142 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15143 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15144 max_y
= it
.last_visible_y
;
15145 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15148 row
->visible_height
= row
->height
;
15149 if (row
->y
< min_y
)
15150 row
->visible_height
-= min_y
- row
->y
;
15151 if (row
->y
+ row
->height
> max_y
)
15152 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15153 row
->redraw_fringe_bitmaps_p
= 1;
15156 /* Scroll the current matrix. */
15157 xassert (nrows_scrolled
> 0);
15158 rotate_matrix (w
->current_matrix
,
15160 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15163 /* Disable rows not reused. */
15164 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15165 row
->enabled_p
= 0;
15167 /* Point may have moved to a different line, so we cannot assume that
15168 the previous cursor position is valid; locate the correct row. */
15171 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15172 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15176 w
->cursor
.y
= row
->y
;
15178 if (row
< bottom_row
)
15180 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15181 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15182 struct glyph
*orig_glyph
= glyph
;
15183 struct cursor_pos orig_cursor
= w
->cursor
;
15186 && (!BUFFERP (glyph
->object
)
15187 || glyph
->charpos
!= PT
);
15191 w
->cursor
.x
+= glyph
->pixel_width
;
15193 /* With bidi reordering, charpos changes non-linearly
15194 with hpos, so the right glyph could be to the
15196 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15197 && (!BUFFERP (glyph
->object
) || glyph
->charpos
!= PT
))
15199 struct glyph
*start_glyph
= row
->glyphs
[TEXT_AREA
];
15201 glyph
= orig_glyph
- 1;
15202 orig_cursor
.hpos
--;
15203 orig_cursor
.x
-= glyph
->pixel_width
;
15204 for (; glyph
>= start_glyph
15205 && (!BUFFERP (glyph
->object
)
15206 || glyph
->charpos
!= PT
);
15210 w
->cursor
.x
-= glyph
->pixel_width
;
15212 if (BUFFERP (glyph
->object
) && glyph
->charpos
== PT
)
15213 w
->cursor
= orig_cursor
;
15218 /* Adjust window end. A null value of last_text_row means that
15219 the window end is in reused rows which in turn means that
15220 only its vpos can have changed. */
15223 w
->window_end_bytepos
15224 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15226 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15228 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15233 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15236 w
->window_end_valid
= Qnil
;
15237 w
->desired_matrix
->no_scrolling_p
= 1;
15240 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15250 /************************************************************************
15251 Window redisplay reusing current matrix when buffer has changed
15252 ************************************************************************/
15254 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
15255 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
15257 static struct glyph_row
*
15258 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
15259 struct glyph_row
*));
15262 /* Return the last row in MATRIX displaying text. If row START is
15263 non-null, start searching with that row. IT gives the dimensions
15264 of the display. Value is null if matrix is empty; otherwise it is
15265 a pointer to the row found. */
15267 static struct glyph_row
*
15268 find_last_row_displaying_text (matrix
, it
, start
)
15269 struct glyph_matrix
*matrix
;
15271 struct glyph_row
*start
;
15273 struct glyph_row
*row
, *row_found
;
15275 /* Set row_found to the last row in IT->w's current matrix
15276 displaying text. The loop looks funny but think of partially
15279 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15280 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15282 xassert (row
->enabled_p
);
15284 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15293 /* Return the last row in the current matrix of W that is not affected
15294 by changes at the start of current_buffer that occurred since W's
15295 current matrix was built. Value is null if no such row exists.
15297 BEG_UNCHANGED us the number of characters unchanged at the start of
15298 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15299 first changed character in current_buffer. Characters at positions <
15300 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15301 when the current matrix was built. */
15303 static struct glyph_row
*
15304 find_last_unchanged_at_beg_row (w
)
15307 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15308 struct glyph_row
*row
;
15309 struct glyph_row
*row_found
= NULL
;
15310 int yb
= window_text_bottom_y (w
);
15312 /* Find the last row displaying unchanged text. */
15313 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15314 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15315 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15318 if (/* If row ends before first_changed_pos, it is unchanged,
15319 except in some case. */
15320 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15321 /* When row ends in ZV and we write at ZV it is not
15323 && !row
->ends_at_zv_p
15324 /* When first_changed_pos is the end of a continued line,
15325 row is not unchanged because it may be no longer
15327 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15328 && (row
->continued_p
15329 || row
->exact_window_width_line_p
)))
15332 /* Stop if last visible row. */
15333 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15341 /* Find the first glyph row in the current matrix of W that is not
15342 affected by changes at the end of current_buffer since the
15343 time W's current matrix was built.
15345 Return in *DELTA the number of chars by which buffer positions in
15346 unchanged text at the end of current_buffer must be adjusted.
15348 Return in *DELTA_BYTES the corresponding number of bytes.
15350 Value is null if no such row exists, i.e. all rows are affected by
15353 static struct glyph_row
*
15354 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
15356 int *delta
, *delta_bytes
;
15358 struct glyph_row
*row
;
15359 struct glyph_row
*row_found
= NULL
;
15361 *delta
= *delta_bytes
= 0;
15363 /* Display must not have been paused, otherwise the current matrix
15364 is not up to date. */
15365 eassert (!NILP (w
->window_end_valid
));
15367 /* A value of window_end_pos >= END_UNCHANGED means that the window
15368 end is in the range of changed text. If so, there is no
15369 unchanged row at the end of W's current matrix. */
15370 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15373 /* Set row to the last row in W's current matrix displaying text. */
15374 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15376 /* If matrix is entirely empty, no unchanged row exists. */
15377 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15379 /* The value of row is the last glyph row in the matrix having a
15380 meaningful buffer position in it. The end position of row
15381 corresponds to window_end_pos. This allows us to translate
15382 buffer positions in the current matrix to current buffer
15383 positions for characters not in changed text. */
15384 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15385 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15386 int last_unchanged_pos
, last_unchanged_pos_old
;
15387 struct glyph_row
*first_text_row
15388 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15390 *delta
= Z
- Z_old
;
15391 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15393 /* Set last_unchanged_pos to the buffer position of the last
15394 character in the buffer that has not been changed. Z is the
15395 index + 1 of the last character in current_buffer, i.e. by
15396 subtracting END_UNCHANGED we get the index of the last
15397 unchanged character, and we have to add BEG to get its buffer
15399 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15400 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15402 /* Search backward from ROW for a row displaying a line that
15403 starts at a minimum position >= last_unchanged_pos_old. */
15404 for (; row
> first_text_row
; --row
)
15406 /* This used to abort, but it can happen.
15407 It is ok to just stop the search instead here. KFS. */
15408 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15411 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15416 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15422 /* Make sure that glyph rows in the current matrix of window W
15423 reference the same glyph memory as corresponding rows in the
15424 frame's frame matrix. This function is called after scrolling W's
15425 current matrix on a terminal frame in try_window_id and
15426 try_window_reusing_current_matrix. */
15429 sync_frame_with_window_matrix_rows (w
)
15432 struct frame
*f
= XFRAME (w
->frame
);
15433 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15435 /* Preconditions: W must be a leaf window and full-width. Its frame
15436 must have a frame matrix. */
15437 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15438 xassert (WINDOW_FULL_WIDTH_P (w
));
15439 xassert (!FRAME_WINDOW_P (f
));
15441 /* If W is a full-width window, glyph pointers in W's current matrix
15442 have, by definition, to be the same as glyph pointers in the
15443 corresponding frame matrix. Note that frame matrices have no
15444 marginal areas (see build_frame_matrix). */
15445 window_row
= w
->current_matrix
->rows
;
15446 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15447 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15448 while (window_row
< window_row_end
)
15450 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15451 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15453 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15454 frame_row
->glyphs
[TEXT_AREA
] = start
;
15455 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15456 frame_row
->glyphs
[LAST_AREA
] = end
;
15458 /* Disable frame rows whose corresponding window rows have
15459 been disabled in try_window_id. */
15460 if (!window_row
->enabled_p
)
15461 frame_row
->enabled_p
= 0;
15463 ++window_row
, ++frame_row
;
15468 /* Find the glyph row in window W containing CHARPOS. Consider all
15469 rows between START and END (not inclusive). END null means search
15470 all rows to the end of the display area of W. Value is the row
15471 containing CHARPOS or null. */
15474 row_containing_pos (w
, charpos
, start
, end
, dy
)
15477 struct glyph_row
*start
, *end
;
15480 struct glyph_row
*row
= start
;
15481 struct glyph_row
*best_row
= NULL
;
15482 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15485 /* If we happen to start on a header-line, skip that. */
15486 if (row
->mode_line_p
)
15489 if ((end
&& row
>= end
) || !row
->enabled_p
)
15492 last_y
= window_text_bottom_y (w
) - dy
;
15496 /* Give up if we have gone too far. */
15497 if (end
&& row
>= end
)
15499 /* This formerly returned if they were equal.
15500 I think that both quantities are of a "last plus one" type;
15501 if so, when they are equal, the row is within the screen. -- rms. */
15502 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15505 /* If it is in this row, return this row. */
15506 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15507 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15508 /* The end position of a row equals the start
15509 position of the next row. If CHARPOS is there, we
15510 would rather display it in the next line, except
15511 when this line ends in ZV. */
15512 && !row
->ends_at_zv_p
15513 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15514 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15518 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15520 /* In bidi-reordered rows, there could be several rows
15521 occluding point. We need to find the one which fits
15522 CHARPOS the best. */
15523 for (g
= row
->glyphs
[TEXT_AREA
];
15524 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15527 if (!STRINGP (g
->object
))
15529 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15531 mindif
= eabs (g
->charpos
- charpos
);
15544 /* Try to redisplay window W by reusing its existing display. W's
15545 current matrix must be up to date when this function is called,
15546 i.e. window_end_valid must not be nil.
15550 1 if display has been updated
15551 0 if otherwise unsuccessful
15552 -1 if redisplay with same window start is known not to succeed
15554 The following steps are performed:
15556 1. Find the last row in the current matrix of W that is not
15557 affected by changes at the start of current_buffer. If no such row
15560 2. Find the first row in W's current matrix that is not affected by
15561 changes at the end of current_buffer. Maybe there is no such row.
15563 3. Display lines beginning with the row + 1 found in step 1 to the
15564 row found in step 2 or, if step 2 didn't find a row, to the end of
15567 4. If cursor is not known to appear on the window, give up.
15569 5. If display stopped at the row found in step 2, scroll the
15570 display and current matrix as needed.
15572 6. Maybe display some lines at the end of W, if we must. This can
15573 happen under various circumstances, like a partially visible line
15574 becoming fully visible, or because newly displayed lines are displayed
15575 in smaller font sizes.
15577 7. Update W's window end information. */
15583 struct frame
*f
= XFRAME (w
->frame
);
15584 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15585 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15586 struct glyph_row
*last_unchanged_at_beg_row
;
15587 struct glyph_row
*first_unchanged_at_end_row
;
15588 struct glyph_row
*row
;
15589 struct glyph_row
*bottom_row
;
15592 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15593 struct text_pos start_pos
;
15595 int first_unchanged_at_end_vpos
= 0;
15596 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15597 struct text_pos start
;
15598 int first_changed_charpos
, last_changed_charpos
;
15601 if (inhibit_try_window_id
)
15605 /* This is handy for debugging. */
15607 #define GIVE_UP(X) \
15609 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15613 #define GIVE_UP(X) return 0
15616 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15618 /* Don't use this for mini-windows because these can show
15619 messages and mini-buffers, and we don't handle that here. */
15620 if (MINI_WINDOW_P (w
))
15623 /* This flag is used to prevent redisplay optimizations. */
15624 if (windows_or_buffers_changed
|| cursor_type_changed
)
15627 /* Verify that narrowing has not changed.
15628 Also verify that we were not told to prevent redisplay optimizations.
15629 It would be nice to further
15630 reduce the number of cases where this prevents try_window_id. */
15631 if (current_buffer
->clip_changed
15632 || current_buffer
->prevent_redisplay_optimizations_p
)
15635 /* Window must either use window-based redisplay or be full width. */
15636 if (!FRAME_WINDOW_P (f
)
15637 && (!FRAME_LINE_INS_DEL_OK (f
)
15638 || !WINDOW_FULL_WIDTH_P (w
)))
15641 /* Give up if point is known NOT to appear in W. */
15642 if (PT
< CHARPOS (start
))
15645 /* Another way to prevent redisplay optimizations. */
15646 if (XFASTINT (w
->last_modified
) == 0)
15649 /* Verify that window is not hscrolled. */
15650 if (XFASTINT (w
->hscroll
) != 0)
15653 /* Verify that display wasn't paused. */
15654 if (NILP (w
->window_end_valid
))
15657 /* Can't use this if highlighting a region because a cursor movement
15658 will do more than just set the cursor. */
15659 if (!NILP (Vtransient_mark_mode
)
15660 && !NILP (current_buffer
->mark_active
))
15663 /* Likewise if highlighting trailing whitespace. */
15664 if (!NILP (Vshow_trailing_whitespace
))
15667 /* Likewise if showing a region. */
15668 if (!NILP (w
->region_showing
))
15671 /* Can't use this if overlay arrow position and/or string have
15673 if (overlay_arrows_changed_p ())
15676 /* When word-wrap is on, adding a space to the first word of a
15677 wrapped line can change the wrap position, altering the line
15678 above it. It might be worthwhile to handle this more
15679 intelligently, but for now just redisplay from scratch. */
15680 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15683 /* Under bidi reordering, adding or deleting a character in the
15684 beginning of a paragraph, before the first strong directional
15685 character, can change the base direction of the paragraph (unless
15686 the buffer specifies a fixed paragraph direction), which will
15687 require to redisplay the whole paragraph. It might be worthwhile
15688 to find the paragraph limits and widen the range of redisplayed
15689 lines to that, but for now just give up this optimization and
15690 redisplay from scratch. */
15691 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15692 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15695 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15696 only if buffer has really changed. The reason is that the gap is
15697 initially at Z for freshly visited files. The code below would
15698 set end_unchanged to 0 in that case. */
15699 if (MODIFF
> SAVE_MODIFF
15700 /* This seems to happen sometimes after saving a buffer. */
15701 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15703 if (GPT
- BEG
< BEG_UNCHANGED
)
15704 BEG_UNCHANGED
= GPT
- BEG
;
15705 if (Z
- GPT
< END_UNCHANGED
)
15706 END_UNCHANGED
= Z
- GPT
;
15709 /* The position of the first and last character that has been changed. */
15710 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15711 last_changed_charpos
= Z
- END_UNCHANGED
;
15713 /* If window starts after a line end, and the last change is in
15714 front of that newline, then changes don't affect the display.
15715 This case happens with stealth-fontification. Note that although
15716 the display is unchanged, glyph positions in the matrix have to
15717 be adjusted, of course. */
15718 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15719 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15720 && ((last_changed_charpos
< CHARPOS (start
)
15721 && CHARPOS (start
) == BEGV
)
15722 || (last_changed_charpos
< CHARPOS (start
) - 1
15723 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15725 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15726 struct glyph_row
*r0
;
15728 /* Compute how many chars/bytes have been added to or removed
15729 from the buffer. */
15730 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15731 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15733 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15735 /* Give up if PT is not in the window. Note that it already has
15736 been checked at the start of try_window_id that PT is not in
15737 front of the window start. */
15738 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15741 /* If window start is unchanged, we can reuse the whole matrix
15742 as is, after adjusting glyph positions. No need to compute
15743 the window end again, since its offset from Z hasn't changed. */
15744 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15745 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15746 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15747 /* PT must not be in a partially visible line. */
15748 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15749 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15751 /* Adjust positions in the glyph matrix. */
15752 if (delta
|| delta_bytes
)
15754 struct glyph_row
*r1
15755 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15756 increment_matrix_positions (w
->current_matrix
,
15757 MATRIX_ROW_VPOS (r0
, current_matrix
),
15758 MATRIX_ROW_VPOS (r1
, current_matrix
),
15759 delta
, delta_bytes
);
15762 /* Set the cursor. */
15763 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15765 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15772 /* Handle the case that changes are all below what is displayed in
15773 the window, and that PT is in the window. This shortcut cannot
15774 be taken if ZV is visible in the window, and text has been added
15775 there that is visible in the window. */
15776 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15777 /* ZV is not visible in the window, or there are no
15778 changes at ZV, actually. */
15779 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15780 || first_changed_charpos
== last_changed_charpos
))
15782 struct glyph_row
*r0
;
15784 /* Give up if PT is not in the window. Note that it already has
15785 been checked at the start of try_window_id that PT is not in
15786 front of the window start. */
15787 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15790 /* If window start is unchanged, we can reuse the whole matrix
15791 as is, without changing glyph positions since no text has
15792 been added/removed in front of the window end. */
15793 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15794 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15795 /* PT must not be in a partially visible line. */
15796 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15797 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15799 /* We have to compute the window end anew since text
15800 can have been added/removed after it. */
15802 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15803 w
->window_end_bytepos
15804 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15806 /* Set the cursor. */
15807 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15809 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15816 /* Give up if window start is in the changed area.
15818 The condition used to read
15820 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15822 but why that was tested escapes me at the moment. */
15823 if (CHARPOS (start
) >= first_changed_charpos
15824 && CHARPOS (start
) <= last_changed_charpos
)
15827 /* Check that window start agrees with the start of the first glyph
15828 row in its current matrix. Check this after we know the window
15829 start is not in changed text, otherwise positions would not be
15831 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15832 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15835 /* Give up if the window ends in strings. Overlay strings
15836 at the end are difficult to handle, so don't try. */
15837 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15838 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15841 /* Compute the position at which we have to start displaying new
15842 lines. Some of the lines at the top of the window might be
15843 reusable because they are not displaying changed text. Find the
15844 last row in W's current matrix not affected by changes at the
15845 start of current_buffer. Value is null if changes start in the
15846 first line of window. */
15847 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15848 if (last_unchanged_at_beg_row
)
15850 /* Avoid starting to display in the moddle of a character, a TAB
15851 for instance. This is easier than to set up the iterator
15852 exactly, and it's not a frequent case, so the additional
15853 effort wouldn't really pay off. */
15854 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15855 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15856 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15857 --last_unchanged_at_beg_row
;
15859 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15862 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15864 start_pos
= it
.current
.pos
;
15866 /* Start displaying new lines in the desired matrix at the same
15867 vpos we would use in the current matrix, i.e. below
15868 last_unchanged_at_beg_row. */
15869 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15871 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15872 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15874 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15878 /* There are no reusable lines at the start of the window.
15879 Start displaying in the first text line. */
15880 start_display (&it
, w
, start
);
15881 it
.vpos
= it
.first_vpos
;
15882 start_pos
= it
.current
.pos
;
15885 /* Find the first row that is not affected by changes at the end of
15886 the buffer. Value will be null if there is no unchanged row, in
15887 which case we must redisplay to the end of the window. delta
15888 will be set to the value by which buffer positions beginning with
15889 first_unchanged_at_end_row have to be adjusted due to text
15891 first_unchanged_at_end_row
15892 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15893 IF_DEBUG (debug_delta
= delta
);
15894 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15896 /* Set stop_pos to the buffer position up to which we will have to
15897 display new lines. If first_unchanged_at_end_row != NULL, this
15898 is the buffer position of the start of the line displayed in that
15899 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15900 that we don't stop at a buffer position. */
15902 if (first_unchanged_at_end_row
)
15904 xassert (last_unchanged_at_beg_row
== NULL
15905 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15907 /* If this is a continuation line, move forward to the next one
15908 that isn't. Changes in lines above affect this line.
15909 Caution: this may move first_unchanged_at_end_row to a row
15910 not displaying text. */
15911 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15912 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15913 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15914 < it
.last_visible_y
))
15915 ++first_unchanged_at_end_row
;
15917 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15918 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15919 >= it
.last_visible_y
))
15920 first_unchanged_at_end_row
= NULL
;
15923 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15925 first_unchanged_at_end_vpos
15926 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15927 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15930 else if (last_unchanged_at_beg_row
== NULL
)
15936 /* Either there is no unchanged row at the end, or the one we have
15937 now displays text. This is a necessary condition for the window
15938 end pos calculation at the end of this function. */
15939 xassert (first_unchanged_at_end_row
== NULL
15940 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15942 debug_last_unchanged_at_beg_vpos
15943 = (last_unchanged_at_beg_row
15944 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15946 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15948 #endif /* GLYPH_DEBUG != 0 */
15951 /* Display new lines. Set last_text_row to the last new line
15952 displayed which has text on it, i.e. might end up as being the
15953 line where the window_end_vpos is. */
15954 w
->cursor
.vpos
= -1;
15955 last_text_row
= NULL
;
15956 overlay_arrow_seen
= 0;
15957 while (it
.current_y
< it
.last_visible_y
15958 && !fonts_changed_p
15959 && (first_unchanged_at_end_row
== NULL
15960 || IT_CHARPOS (it
) < stop_pos
))
15962 if (display_line (&it
))
15963 last_text_row
= it
.glyph_row
- 1;
15966 if (fonts_changed_p
)
15970 /* Compute differences in buffer positions, y-positions etc. for
15971 lines reused at the bottom of the window. Compute what we can
15973 if (first_unchanged_at_end_row
15974 /* No lines reused because we displayed everything up to the
15975 bottom of the window. */
15976 && it
.current_y
< it
.last_visible_y
)
15979 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15981 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15982 run
.current_y
= first_unchanged_at_end_row
->y
;
15983 run
.desired_y
= run
.current_y
+ dy
;
15984 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15988 delta
= delta_bytes
= dvpos
= dy
15989 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15990 first_unchanged_at_end_row
= NULL
;
15992 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15995 /* Find the cursor if not already found. We have to decide whether
15996 PT will appear on this window (it sometimes doesn't, but this is
15997 not a very frequent case.) This decision has to be made before
15998 the current matrix is altered. A value of cursor.vpos < 0 means
15999 that PT is either in one of the lines beginning at
16000 first_unchanged_at_end_row or below the window. Don't care for
16001 lines that might be displayed later at the window end; as
16002 mentioned, this is not a frequent case. */
16003 if (w
->cursor
.vpos
< 0)
16005 /* Cursor in unchanged rows at the top? */
16006 if (PT
< CHARPOS (start_pos
)
16007 && last_unchanged_at_beg_row
)
16009 row
= row_containing_pos (w
, PT
,
16010 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16011 last_unchanged_at_beg_row
+ 1, 0);
16013 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16016 /* Start from first_unchanged_at_end_row looking for PT. */
16017 else if (first_unchanged_at_end_row
)
16019 row
= row_containing_pos (w
, PT
- delta
,
16020 first_unchanged_at_end_row
, NULL
, 0);
16022 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16023 delta_bytes
, dy
, dvpos
);
16026 /* Give up if cursor was not found. */
16027 if (w
->cursor
.vpos
< 0)
16029 clear_glyph_matrix (w
->desired_matrix
);
16034 /* Don't let the cursor end in the scroll margins. */
16036 int this_scroll_margin
, cursor_height
;
16038 this_scroll_margin
= max (0, scroll_margin
);
16039 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16040 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16041 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16043 if ((w
->cursor
.y
< this_scroll_margin
16044 && CHARPOS (start
) > BEGV
)
16045 /* Old redisplay didn't take scroll margin into account at the bottom,
16046 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16047 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16048 ? cursor_height
+ this_scroll_margin
16049 : 1)) > it
.last_visible_y
)
16051 w
->cursor
.vpos
= -1;
16052 clear_glyph_matrix (w
->desired_matrix
);
16057 /* Scroll the display. Do it before changing the current matrix so
16058 that xterm.c doesn't get confused about where the cursor glyph is
16060 if (dy
&& run
.height
)
16064 if (FRAME_WINDOW_P (f
))
16066 FRAME_RIF (f
)->update_window_begin_hook (w
);
16067 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16068 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16069 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16073 /* Terminal frame. In this case, dvpos gives the number of
16074 lines to scroll by; dvpos < 0 means scroll up. */
16075 int first_unchanged_at_end_vpos
16076 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16077 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
16078 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16079 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16080 + window_internal_height (w
));
16082 /* Perform the operation on the screen. */
16085 /* Scroll last_unchanged_at_beg_row to the end of the
16086 window down dvpos lines. */
16087 set_terminal_window (f
, end
);
16089 /* On dumb terminals delete dvpos lines at the end
16090 before inserting dvpos empty lines. */
16091 if (!FRAME_SCROLL_REGION_OK (f
))
16092 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16094 /* Insert dvpos empty lines in front of
16095 last_unchanged_at_beg_row. */
16096 ins_del_lines (f
, from
, dvpos
);
16098 else if (dvpos
< 0)
16100 /* Scroll up last_unchanged_at_beg_vpos to the end of
16101 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16102 set_terminal_window (f
, end
);
16104 /* Delete dvpos lines in front of
16105 last_unchanged_at_beg_vpos. ins_del_lines will set
16106 the cursor to the given vpos and emit |dvpos| delete
16108 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16110 /* On a dumb terminal insert dvpos empty lines at the
16112 if (!FRAME_SCROLL_REGION_OK (f
))
16113 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16116 set_terminal_window (f
, 0);
16122 /* Shift reused rows of the current matrix to the right position.
16123 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16125 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16126 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16129 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16130 bottom_vpos
, dvpos
);
16131 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16134 else if (dvpos
> 0)
16136 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16137 bottom_vpos
, dvpos
);
16138 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16139 first_unchanged_at_end_vpos
+ dvpos
, 0);
16142 /* For frame-based redisplay, make sure that current frame and window
16143 matrix are in sync with respect to glyph memory. */
16144 if (!FRAME_WINDOW_P (f
))
16145 sync_frame_with_window_matrix_rows (w
);
16147 /* Adjust buffer positions in reused rows. */
16148 if (delta
|| delta_bytes
)
16149 increment_matrix_positions (current_matrix
,
16150 first_unchanged_at_end_vpos
+ dvpos
,
16151 bottom_vpos
, delta
, delta_bytes
);
16153 /* Adjust Y positions. */
16155 shift_glyph_matrix (w
, current_matrix
,
16156 first_unchanged_at_end_vpos
+ dvpos
,
16159 if (first_unchanged_at_end_row
)
16161 first_unchanged_at_end_row
+= dvpos
;
16162 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16163 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16164 first_unchanged_at_end_row
= NULL
;
16167 /* If scrolling up, there may be some lines to display at the end of
16169 last_text_row_at_end
= NULL
;
16172 /* Scrolling up can leave for example a partially visible line
16173 at the end of the window to be redisplayed. */
16174 /* Set last_row to the glyph row in the current matrix where the
16175 window end line is found. It has been moved up or down in
16176 the matrix by dvpos. */
16177 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16178 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16180 /* If last_row is the window end line, it should display text. */
16181 xassert (last_row
->displays_text_p
);
16183 /* If window end line was partially visible before, begin
16184 displaying at that line. Otherwise begin displaying with the
16185 line following it. */
16186 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16188 init_to_row_start (&it
, w
, last_row
);
16189 it
.vpos
= last_vpos
;
16190 it
.current_y
= last_row
->y
;
16194 init_to_row_end (&it
, w
, last_row
);
16195 it
.vpos
= 1 + last_vpos
;
16196 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16200 /* We may start in a continuation line. If so, we have to
16201 get the right continuation_lines_width and current_x. */
16202 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16203 it
.hpos
= it
.current_x
= 0;
16205 /* Display the rest of the lines at the window end. */
16206 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16207 while (it
.current_y
< it
.last_visible_y
16208 && !fonts_changed_p
)
16210 /* Is it always sure that the display agrees with lines in
16211 the current matrix? I don't think so, so we mark rows
16212 displayed invalid in the current matrix by setting their
16213 enabled_p flag to zero. */
16214 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16215 if (display_line (&it
))
16216 last_text_row_at_end
= it
.glyph_row
- 1;
16220 /* Update window_end_pos and window_end_vpos. */
16221 if (first_unchanged_at_end_row
16222 && !last_text_row_at_end
)
16224 /* Window end line if one of the preserved rows from the current
16225 matrix. Set row to the last row displaying text in current
16226 matrix starting at first_unchanged_at_end_row, after
16228 xassert (first_unchanged_at_end_row
->displays_text_p
);
16229 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16230 first_unchanged_at_end_row
);
16231 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16233 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16234 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16236 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16237 xassert (w
->window_end_bytepos
>= 0);
16238 IF_DEBUG (debug_method_add (w
, "A"));
16240 else if (last_text_row_at_end
)
16243 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16244 w
->window_end_bytepos
16245 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16247 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16248 xassert (w
->window_end_bytepos
>= 0);
16249 IF_DEBUG (debug_method_add (w
, "B"));
16251 else if (last_text_row
)
16253 /* We have displayed either to the end of the window or at the
16254 end of the window, i.e. the last row with text is to be found
16255 in the desired matrix. */
16257 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16258 w
->window_end_bytepos
16259 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16261 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16262 xassert (w
->window_end_bytepos
>= 0);
16264 else if (first_unchanged_at_end_row
== NULL
16265 && last_text_row
== NULL
16266 && last_text_row_at_end
== NULL
)
16268 /* Displayed to end of window, but no line containing text was
16269 displayed. Lines were deleted at the end of the window. */
16270 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16271 int vpos
= XFASTINT (w
->window_end_vpos
);
16272 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16273 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16276 row
== NULL
&& vpos
>= first_vpos
;
16277 --vpos
, --current_row
, --desired_row
)
16279 if (desired_row
->enabled_p
)
16281 if (desired_row
->displays_text_p
)
16284 else if (current_row
->displays_text_p
)
16288 xassert (row
!= NULL
);
16289 w
->window_end_vpos
= make_number (vpos
+ 1);
16290 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16291 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16292 xassert (w
->window_end_bytepos
>= 0);
16293 IF_DEBUG (debug_method_add (w
, "C"));
16298 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16299 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16301 /* Record that display has not been completed. */
16302 w
->window_end_valid
= Qnil
;
16303 w
->desired_matrix
->no_scrolling_p
= 1;
16311 /***********************************************************************
16312 More debugging support
16313 ***********************************************************************/
16317 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
16318 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
16319 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
16322 /* Dump the contents of glyph matrix MATRIX on stderr.
16324 GLYPHS 0 means don't show glyph contents.
16325 GLYPHS 1 means show glyphs in short form
16326 GLYPHS > 1 means show glyphs in long form. */
16329 dump_glyph_matrix (matrix
, glyphs
)
16330 struct glyph_matrix
*matrix
;
16334 for (i
= 0; i
< matrix
->nrows
; ++i
)
16335 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16339 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16340 the glyph row and area where the glyph comes from. */
16343 dump_glyph (row
, glyph
, area
)
16344 struct glyph_row
*row
;
16345 struct glyph
*glyph
;
16348 if (glyph
->type
== CHAR_GLYPH
)
16351 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16352 glyph
- row
->glyphs
[TEXT_AREA
],
16355 (BUFFERP (glyph
->object
)
16357 : (STRINGP (glyph
->object
)
16360 glyph
->pixel_width
,
16362 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16366 glyph
->left_box_line_p
,
16367 glyph
->right_box_line_p
);
16369 else if (glyph
->type
== STRETCH_GLYPH
)
16372 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16373 glyph
- row
->glyphs
[TEXT_AREA
],
16376 (BUFFERP (glyph
->object
)
16378 : (STRINGP (glyph
->object
)
16381 glyph
->pixel_width
,
16385 glyph
->left_box_line_p
,
16386 glyph
->right_box_line_p
);
16388 else if (glyph
->type
== IMAGE_GLYPH
)
16391 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16392 glyph
- row
->glyphs
[TEXT_AREA
],
16395 (BUFFERP (glyph
->object
)
16397 : (STRINGP (glyph
->object
)
16400 glyph
->pixel_width
,
16404 glyph
->left_box_line_p
,
16405 glyph
->right_box_line_p
);
16407 else if (glyph
->type
== COMPOSITE_GLYPH
)
16410 " %5d %4c %6d %c %3d 0x%05x",
16411 glyph
- row
->glyphs
[TEXT_AREA
],
16414 (BUFFERP (glyph
->object
)
16416 : (STRINGP (glyph
->object
)
16419 glyph
->pixel_width
,
16421 if (glyph
->u
.cmp
.automatic
)
16424 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16425 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16427 glyph
->left_box_line_p
,
16428 glyph
->right_box_line_p
);
16433 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16434 GLYPHS 0 means don't show glyph contents.
16435 GLYPHS 1 means show glyphs in short form
16436 GLYPHS > 1 means show glyphs in long form. */
16439 dump_glyph_row (row
, vpos
, glyphs
)
16440 struct glyph_row
*row
;
16445 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16446 fprintf (stderr
, "======================================================================\n");
16448 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16449 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16451 MATRIX_ROW_START_CHARPOS (row
),
16452 MATRIX_ROW_END_CHARPOS (row
),
16453 row
->used
[TEXT_AREA
],
16454 row
->contains_overlapping_glyphs_p
,
16456 row
->truncated_on_left_p
,
16457 row
->truncated_on_right_p
,
16459 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16460 row
->displays_text_p
,
16463 row
->ends_in_middle_of_char_p
,
16464 row
->starts_in_middle_of_char_p
,
16470 row
->visible_height
,
16473 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16474 row
->end
.overlay_string_index
,
16475 row
->continuation_lines_width
);
16476 fprintf (stderr
, "%9d %5d\n",
16477 CHARPOS (row
->start
.string_pos
),
16478 CHARPOS (row
->end
.string_pos
));
16479 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16480 row
->end
.dpvec_index
);
16487 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16489 struct glyph
*glyph
= row
->glyphs
[area
];
16490 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16492 /* Glyph for a line end in text. */
16493 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16496 if (glyph
< glyph_end
)
16497 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16499 for (; glyph
< glyph_end
; ++glyph
)
16500 dump_glyph (row
, glyph
, area
);
16503 else if (glyphs
== 1)
16507 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16509 char *s
= (char *) alloca (row
->used
[area
] + 1);
16512 for (i
= 0; i
< row
->used
[area
]; ++i
)
16514 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16515 if (glyph
->type
== CHAR_GLYPH
16516 && glyph
->u
.ch
< 0x80
16517 && glyph
->u
.ch
>= ' ')
16518 s
[i
] = glyph
->u
.ch
;
16524 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16530 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16531 Sdump_glyph_matrix
, 0, 1, "p",
16532 doc
: /* Dump the current matrix of the selected window to stderr.
16533 Shows contents of glyph row structures. With non-nil
16534 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16535 glyphs in short form, otherwise show glyphs in long form. */)
16537 Lisp_Object glyphs
;
16539 struct window
*w
= XWINDOW (selected_window
);
16540 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16542 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16543 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16544 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16545 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16546 fprintf (stderr
, "=============================================\n");
16547 dump_glyph_matrix (w
->current_matrix
,
16548 NILP (glyphs
) ? 0 : XINT (glyphs
));
16553 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16554 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16557 struct frame
*f
= XFRAME (selected_frame
);
16558 dump_glyph_matrix (f
->current_matrix
, 1);
16563 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16564 doc
: /* Dump glyph row ROW to stderr.
16565 GLYPH 0 means don't dump glyphs.
16566 GLYPH 1 means dump glyphs in short form.
16567 GLYPH > 1 or omitted means dump glyphs in long form. */)
16569 Lisp_Object row
, glyphs
;
16571 struct glyph_matrix
*matrix
;
16574 CHECK_NUMBER (row
);
16575 matrix
= XWINDOW (selected_window
)->current_matrix
;
16577 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16578 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16580 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16585 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16586 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16587 GLYPH 0 means don't dump glyphs.
16588 GLYPH 1 means dump glyphs in short form.
16589 GLYPH > 1 or omitted means dump glyphs in long form. */)
16591 Lisp_Object row
, glyphs
;
16593 struct frame
*sf
= SELECTED_FRAME ();
16594 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16597 CHECK_NUMBER (row
);
16599 if (vpos
>= 0 && vpos
< m
->nrows
)
16600 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16601 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16606 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16607 doc
: /* Toggle tracing of redisplay.
16608 With ARG, turn tracing on if and only if ARG is positive. */)
16613 trace_redisplay_p
= !trace_redisplay_p
;
16616 arg
= Fprefix_numeric_value (arg
);
16617 trace_redisplay_p
= XINT (arg
) > 0;
16624 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16625 doc
: /* Like `format', but print result to stderr.
16626 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16631 Lisp_Object s
= Fformat (nargs
, args
);
16632 fprintf (stderr
, "%s", SDATA (s
));
16636 #endif /* GLYPH_DEBUG */
16640 /***********************************************************************
16641 Building Desired Matrix Rows
16642 ***********************************************************************/
16644 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16645 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16647 static struct glyph_row
*
16648 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
16650 Lisp_Object overlay_arrow_string
;
16652 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16653 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16654 struct buffer
*old
= current_buffer
;
16655 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16656 int arrow_len
= SCHARS (overlay_arrow_string
);
16657 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16658 const unsigned char *p
;
16661 int n_glyphs_before
;
16663 set_buffer_temp (buffer
);
16664 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16665 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16666 SET_TEXT_POS (it
.position
, 0, 0);
16668 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16670 while (p
< arrow_end
)
16672 Lisp_Object face
, ilisp
;
16674 /* Get the next character. */
16676 it
.c
= string_char_and_length (p
, &it
.len
);
16678 it
.c
= *p
, it
.len
= 1;
16681 /* Get its face. */
16682 ilisp
= make_number (p
- arrow_string
);
16683 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16684 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16686 /* Compute its width, get its glyphs. */
16687 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16688 SET_TEXT_POS (it
.position
, -1, -1);
16689 PRODUCE_GLYPHS (&it
);
16691 /* If this character doesn't fit any more in the line, we have
16692 to remove some glyphs. */
16693 if (it
.current_x
> it
.last_visible_x
)
16695 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16700 set_buffer_temp (old
);
16701 return it
.glyph_row
;
16705 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16706 glyphs are only inserted for terminal frames since we can't really
16707 win with truncation glyphs when partially visible glyphs are
16708 involved. Which glyphs to insert is determined by
16709 produce_special_glyphs. */
16712 insert_left_trunc_glyphs (it
)
16715 struct it truncate_it
;
16716 struct glyph
*from
, *end
, *to
, *toend
;
16718 xassert (!FRAME_WINDOW_P (it
->f
));
16720 /* Get the truncation glyphs. */
16722 truncate_it
.current_x
= 0;
16723 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16724 truncate_it
.glyph_row
= &scratch_glyph_row
;
16725 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16726 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16727 truncate_it
.object
= make_number (0);
16728 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16730 /* Overwrite glyphs from IT with truncation glyphs. */
16731 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16732 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16733 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16734 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16739 /* There may be padding glyphs left over. Overwrite them too. */
16740 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16742 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16748 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16752 /* Compute the pixel height and width of IT->glyph_row.
16754 Most of the time, ascent and height of a display line will be equal
16755 to the max_ascent and max_height values of the display iterator
16756 structure. This is not the case if
16758 1. We hit ZV without displaying anything. In this case, max_ascent
16759 and max_height will be zero.
16761 2. We have some glyphs that don't contribute to the line height.
16762 (The glyph row flag contributes_to_line_height_p is for future
16763 pixmap extensions).
16765 The first case is easily covered by using default values because in
16766 these cases, the line height does not really matter, except that it
16767 must not be zero. */
16770 compute_line_metrics (it
)
16773 struct glyph_row
*row
= it
->glyph_row
;
16776 if (FRAME_WINDOW_P (it
->f
))
16778 int i
, min_y
, max_y
;
16780 /* The line may consist of one space only, that was added to
16781 place the cursor on it. If so, the row's height hasn't been
16783 if (row
->height
== 0)
16785 if (it
->max_ascent
+ it
->max_descent
== 0)
16786 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16787 row
->ascent
= it
->max_ascent
;
16788 row
->height
= it
->max_ascent
+ it
->max_descent
;
16789 row
->phys_ascent
= it
->max_phys_ascent
;
16790 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16791 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16794 /* Compute the width of this line. */
16795 row
->pixel_width
= row
->x
;
16796 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16797 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16799 xassert (row
->pixel_width
>= 0);
16800 xassert (row
->ascent
>= 0 && row
->height
> 0);
16802 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16803 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16805 /* If first line's physical ascent is larger than its logical
16806 ascent, use the physical ascent, and make the row taller.
16807 This makes accented characters fully visible. */
16808 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16809 && row
->phys_ascent
> row
->ascent
)
16811 row
->height
+= row
->phys_ascent
- row
->ascent
;
16812 row
->ascent
= row
->phys_ascent
;
16815 /* Compute how much of the line is visible. */
16816 row
->visible_height
= row
->height
;
16818 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16819 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16821 if (row
->y
< min_y
)
16822 row
->visible_height
-= min_y
- row
->y
;
16823 if (row
->y
+ row
->height
> max_y
)
16824 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16828 row
->pixel_width
= row
->used
[TEXT_AREA
];
16829 if (row
->continued_p
)
16830 row
->pixel_width
-= it
->continuation_pixel_width
;
16831 else if (row
->truncated_on_right_p
)
16832 row
->pixel_width
-= it
->truncation_pixel_width
;
16833 row
->ascent
= row
->phys_ascent
= 0;
16834 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16835 row
->extra_line_spacing
= 0;
16838 /* Compute a hash code for this row. */
16840 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16841 for (i
= 0; i
< row
->used
[area
]; ++i
)
16842 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16843 + row
->glyphs
[area
][i
].u
.val
16844 + row
->glyphs
[area
][i
].face_id
16845 + row
->glyphs
[area
][i
].padding_p
16846 + (row
->glyphs
[area
][i
].type
<< 2));
16848 it
->max_ascent
= it
->max_descent
= 0;
16849 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16853 /* Append one space to the glyph row of iterator IT if doing a
16854 window-based redisplay. The space has the same face as
16855 IT->face_id. Value is non-zero if a space was added.
16857 This function is called to make sure that there is always one glyph
16858 at the end of a glyph row that the cursor can be set on under
16859 window-systems. (If there weren't such a glyph we would not know
16860 how wide and tall a box cursor should be displayed).
16862 At the same time this space let's a nicely handle clearing to the
16863 end of the line if the row ends in italic text. */
16866 append_space_for_newline (it
, default_face_p
)
16868 int default_face_p
;
16870 if (FRAME_WINDOW_P (it
->f
))
16872 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16874 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16875 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16877 /* Save some values that must not be changed.
16878 Must save IT->c and IT->len because otherwise
16879 ITERATOR_AT_END_P wouldn't work anymore after
16880 append_space_for_newline has been called. */
16881 enum display_element_type saved_what
= it
->what
;
16882 int saved_c
= it
->c
, saved_len
= it
->len
;
16883 int saved_x
= it
->current_x
;
16884 int saved_face_id
= it
->face_id
;
16885 struct text_pos saved_pos
;
16886 Lisp_Object saved_object
;
16889 saved_object
= it
->object
;
16890 saved_pos
= it
->position
;
16892 it
->what
= IT_CHARACTER
;
16893 bzero (&it
->position
, sizeof it
->position
);
16894 it
->object
= make_number (0);
16898 if (default_face_p
)
16899 it
->face_id
= DEFAULT_FACE_ID
;
16900 else if (it
->face_before_selective_p
)
16901 it
->face_id
= it
->saved_face_id
;
16902 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16903 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16905 PRODUCE_GLYPHS (it
);
16907 it
->override_ascent
= -1;
16908 it
->constrain_row_ascent_descent_p
= 0;
16909 it
->current_x
= saved_x
;
16910 it
->object
= saved_object
;
16911 it
->position
= saved_pos
;
16912 it
->what
= saved_what
;
16913 it
->face_id
= saved_face_id
;
16914 it
->len
= saved_len
;
16924 /* Extend the face of the last glyph in the text area of IT->glyph_row
16925 to the end of the display line. Called from display_line. If the
16926 glyph row is empty, add a space glyph to it so that we know the
16927 face to draw. Set the glyph row flag fill_line_p. If the glyph
16928 row is R2L, prepend a stretch glyph to cover the empty space to the
16929 left of the leftmost glyph. */
16932 extend_face_to_end_of_line (it
)
16936 struct frame
*f
= it
->f
;
16938 /* If line is already filled, do nothing. Non window-system frames
16939 get a grace of one more ``pixel'' because their characters are
16940 1-``pixel'' wide, so they hit the equality too early. */
16941 if (it
->current_x
>= it
->last_visible_x
+ !FRAME_WINDOW_P (f
))
16944 /* Face extension extends the background and box of IT->face_id
16945 to the end of the line. If the background equals the background
16946 of the frame, we don't have to do anything. */
16947 if (it
->face_before_selective_p
)
16948 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16950 face
= FACE_FROM_ID (f
, it
->face_id
);
16952 if (FRAME_WINDOW_P (f
)
16953 && it
->glyph_row
->displays_text_p
16954 && face
->box
== FACE_NO_BOX
16955 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16957 && !it
->glyph_row
->reversed_p
)
16960 /* Set the glyph row flag indicating that the face of the last glyph
16961 in the text area has to be drawn to the end of the text area. */
16962 it
->glyph_row
->fill_line_p
= 1;
16964 /* If current character of IT is not ASCII, make sure we have the
16965 ASCII face. This will be automatically undone the next time
16966 get_next_display_element returns a multibyte character. Note
16967 that the character will always be single byte in unibyte
16969 if (!ASCII_CHAR_P (it
->c
))
16971 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16974 if (FRAME_WINDOW_P (f
))
16976 /* If the row is empty, add a space with the current face of IT,
16977 so that we know which face to draw. */
16978 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16980 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16981 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16982 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16984 #ifdef HAVE_WINDOW_SYSTEM
16985 if (it
->glyph_row
->reversed_p
)
16987 /* Prepend a stretch glyph to the row, such that the
16988 rightmost glyph will be drawn flushed all the way to the
16989 right margin of the window. The stretch glyph that will
16990 occupy the empty space, if any, to the left of the
16992 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16993 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16994 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16996 int row_width
, stretch_ascent
, stretch_width
;
16997 struct text_pos saved_pos
;
16998 int saved_face_id
, saved_avoid_cursor
;
17000 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17001 row_width
+= g
->pixel_width
;
17002 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17003 if (stretch_width
> 0)
17006 (((it
->ascent
+ it
->descent
)
17007 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17008 saved_pos
= it
->position
;
17009 bzero (&it
->position
, sizeof it
->position
);
17010 saved_avoid_cursor
= it
->avoid_cursor_p
;
17011 it
->avoid_cursor_p
= 1;
17012 saved_face_id
= it
->face_id
;
17013 /* The last row's stretch glyph should get the default
17014 face, to avoid painting the rest of the window with
17015 the region face, if the region ends at ZV. */
17016 if (it
->glyph_row
->ends_at_zv_p
)
17017 it
->face_id
= DEFAULT_FACE_ID
;
17019 it
->face_id
= face
->id
;
17020 append_stretch_glyph (it
, make_number (0), stretch_width
,
17021 it
->ascent
+ it
->descent
, stretch_ascent
);
17022 it
->position
= saved_pos
;
17023 it
->avoid_cursor_p
= saved_avoid_cursor
;
17024 it
->face_id
= saved_face_id
;
17027 #endif /* HAVE_WINDOW_SYSTEM */
17031 /* Save some values that must not be changed. */
17032 int saved_x
= it
->current_x
;
17033 struct text_pos saved_pos
;
17034 Lisp_Object saved_object
;
17035 enum display_element_type saved_what
= it
->what
;
17036 int saved_face_id
= it
->face_id
;
17038 saved_object
= it
->object
;
17039 saved_pos
= it
->position
;
17041 it
->what
= IT_CHARACTER
;
17042 bzero (&it
->position
, sizeof it
->position
);
17043 it
->object
= make_number (0);
17046 /* The last row's blank glyphs should get the default face, to
17047 avoid painting the rest of the window with the region face,
17048 if the region ends at ZV. */
17049 if (it
->glyph_row
->ends_at_zv_p
)
17050 it
->face_id
= DEFAULT_FACE_ID
;
17052 it
->face_id
= face
->id
;
17054 PRODUCE_GLYPHS (it
);
17056 while (it
->current_x
<= it
->last_visible_x
)
17057 PRODUCE_GLYPHS (it
);
17059 /* Don't count these blanks really. It would let us insert a left
17060 truncation glyph below and make us set the cursor on them, maybe. */
17061 it
->current_x
= saved_x
;
17062 it
->object
= saved_object
;
17063 it
->position
= saved_pos
;
17064 it
->what
= saved_what
;
17065 it
->face_id
= saved_face_id
;
17070 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17071 trailing whitespace. */
17074 trailing_whitespace_p (charpos
)
17077 int bytepos
= CHAR_TO_BYTE (charpos
);
17080 while (bytepos
< ZV_BYTE
17081 && (c
= FETCH_CHAR (bytepos
),
17082 c
== ' ' || c
== '\t'))
17085 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17087 if (bytepos
!= PT_BYTE
)
17094 /* Highlight trailing whitespace, if any, in ROW. */
17097 highlight_trailing_whitespace (f
, row
)
17099 struct glyph_row
*row
;
17101 int used
= row
->used
[TEXT_AREA
];
17105 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17106 struct glyph
*glyph
= start
+ used
- 1;
17108 if (row
->reversed_p
)
17110 /* Right-to-left rows need to be processed in the opposite
17111 direction, so swap the edge pointers. */
17113 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17116 /* Skip over glyphs inserted to display the cursor at the
17117 end of a line, for extending the face of the last glyph
17118 to the end of the line on terminals, and for truncation
17119 and continuation glyphs. */
17120 if (!row
->reversed_p
)
17122 while (glyph
>= start
17123 && glyph
->type
== CHAR_GLYPH
17124 && INTEGERP (glyph
->object
))
17129 while (glyph
<= start
17130 && glyph
->type
== CHAR_GLYPH
17131 && INTEGERP (glyph
->object
))
17135 /* If last glyph is a space or stretch, and it's trailing
17136 whitespace, set the face of all trailing whitespace glyphs in
17137 IT->glyph_row to `trailing-whitespace'. */
17138 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17139 && BUFFERP (glyph
->object
)
17140 && (glyph
->type
== STRETCH_GLYPH
17141 || (glyph
->type
== CHAR_GLYPH
17142 && glyph
->u
.ch
== ' '))
17143 && trailing_whitespace_p (glyph
->charpos
))
17145 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17149 if (!row
->reversed_p
)
17151 while (glyph
>= start
17152 && BUFFERP (glyph
->object
)
17153 && (glyph
->type
== STRETCH_GLYPH
17154 || (glyph
->type
== CHAR_GLYPH
17155 && glyph
->u
.ch
== ' ')))
17156 (glyph
--)->face_id
= face_id
;
17160 while (glyph
<= start
17161 && BUFFERP (glyph
->object
)
17162 && (glyph
->type
== STRETCH_GLYPH
17163 || (glyph
->type
== CHAR_GLYPH
17164 && glyph
->u
.ch
== ' ')))
17165 (glyph
++)->face_id
= face_id
;
17172 /* Value is non-zero if glyph row ROW in window W should be
17173 used to hold the cursor. */
17176 cursor_row_p (w
, row
)
17178 struct glyph_row
*row
;
17180 int cursor_row_p
= 1;
17182 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
17184 /* Suppose the row ends on a string.
17185 Unless the row is continued, that means it ends on a newline
17186 in the string. If it's anything other than a display string
17187 (e.g. a before-string from an overlay), we don't want the
17188 cursor there. (This heuristic seems to give the optimal
17189 behavior for the various types of multi-line strings.) */
17190 if (CHARPOS (row
->end
.string_pos
) >= 0)
17192 if (row
->continued_p
)
17196 /* Check for `display' property. */
17197 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17198 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17199 struct glyph
*glyph
;
17202 for (glyph
= end
; glyph
>= beg
; --glyph
)
17203 if (STRINGP (glyph
->object
))
17206 = Fget_char_property (make_number (PT
),
17210 && display_prop_string_p (prop
, glyph
->object
));
17215 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17217 /* If the row ends in middle of a real character,
17218 and the line is continued, we want the cursor here.
17219 That's because MATRIX_ROW_END_CHARPOS would equal
17220 PT if PT is before the character. */
17221 if (!row
->ends_in_ellipsis_p
)
17222 cursor_row_p
= row
->continued_p
;
17224 /* If the row ends in an ellipsis, then
17225 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
17226 We want that position to be displayed after the ellipsis. */
17229 /* If the row ends at ZV, display the cursor at the end of that
17230 row instead of at the start of the row below. */
17231 else if (row
->ends_at_zv_p
)
17237 return cursor_row_p
;
17242 /* Push the display property PROP so that it will be rendered at the
17243 current position in IT. Return 1 if PROP was successfully pushed,
17247 push_display_prop (struct it
*it
, Lisp_Object prop
)
17251 if (STRINGP (prop
))
17253 if (SCHARS (prop
) == 0)
17260 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17261 it
->current
.overlay_string_index
= -1;
17262 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17263 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17264 it
->method
= GET_FROM_STRING
;
17265 it
->stop_charpos
= 0;
17267 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17269 it
->method
= GET_FROM_STRETCH
;
17272 #ifdef HAVE_WINDOW_SYSTEM
17273 else if (IMAGEP (prop
))
17275 it
->what
= IT_IMAGE
;
17276 it
->image_id
= lookup_image (it
->f
, prop
);
17277 it
->method
= GET_FROM_IMAGE
;
17279 #endif /* HAVE_WINDOW_SYSTEM */
17282 pop_it (it
); /* bogus display property, give up */
17289 /* Return the character-property PROP at the current position in IT. */
17292 get_it_property (it
, prop
)
17296 Lisp_Object position
;
17298 if (STRINGP (it
->object
))
17299 position
= make_number (IT_STRING_CHARPOS (*it
));
17300 else if (BUFFERP (it
->object
))
17301 position
= make_number (IT_CHARPOS (*it
));
17305 return Fget_char_property (position
, prop
, it
->object
);
17308 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17311 handle_line_prefix (struct it
*it
)
17313 Lisp_Object prefix
;
17314 if (it
->continuation_lines_width
> 0)
17316 prefix
= get_it_property (it
, Qwrap_prefix
);
17318 prefix
= Vwrap_prefix
;
17322 prefix
= get_it_property (it
, Qline_prefix
);
17324 prefix
= Vline_prefix
;
17326 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17328 /* If the prefix is wider than the window, and we try to wrap
17329 it, it would acquire its own wrap prefix, and so on till the
17330 iterator stack overflows. So, don't wrap the prefix. */
17331 it
->line_wrap
= TRUNCATE
;
17332 it
->avoid_cursor_p
= 1;
17338 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17339 only for R2L lines from display_line, when it decides that too many
17340 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17343 unproduce_glyphs (it
, n
)
17347 struct glyph
*glyph
, *end
;
17349 xassert (it
->glyph_row
);
17350 xassert (it
->glyph_row
->reversed_p
);
17351 xassert (it
->area
== TEXT_AREA
);
17352 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17354 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17355 n
= it
->glyph_row
->used
[TEXT_AREA
];
17356 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17357 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17358 for ( ; glyph
< end
; glyph
++)
17359 glyph
[-n
] = *glyph
;
17363 /* Construct the glyph row IT->glyph_row in the desired matrix of
17364 IT->w from text at the current position of IT. See dispextern.h
17365 for an overview of struct it. Value is non-zero if
17366 IT->glyph_row displays text, as opposed to a line displaying ZV
17373 struct glyph_row
*row
= it
->glyph_row
;
17374 Lisp_Object overlay_arrow_string
;
17376 int may_wrap
= 0, wrap_x
;
17377 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17378 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17379 int wrap_row_extra_line_spacing
;
17380 struct display_pos row_end
;
17383 /* We always start displaying at hpos zero even if hscrolled. */
17384 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17386 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17387 >= it
->w
->desired_matrix
->nrows
)
17389 it
->w
->nrows_scale_factor
++;
17390 fonts_changed_p
= 1;
17394 /* Is IT->w showing the region? */
17395 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17397 /* Clear the result glyph row and enable it. */
17398 prepare_desired_row (row
);
17400 row
->y
= it
->current_y
;
17401 row
->start
= it
->start
;
17402 row
->continuation_lines_width
= it
->continuation_lines_width
;
17403 row
->displays_text_p
= 1;
17404 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17405 it
->starts_in_middle_of_char_p
= 0;
17407 /* Arrange the overlays nicely for our purposes. Usually, we call
17408 display_line on only one line at a time, in which case this
17409 can't really hurt too much, or we call it on lines which appear
17410 one after another in the buffer, in which case all calls to
17411 recenter_overlay_lists but the first will be pretty cheap. */
17412 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17414 /* Move over display elements that are not visible because we are
17415 hscrolled. This may stop at an x-position < IT->first_visible_x
17416 if the first glyph is partially visible or if we hit a line end. */
17417 if (it
->current_x
< it
->first_visible_x
)
17419 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17420 MOVE_TO_POS
| MOVE_TO_X
);
17424 /* We only do this when not calling `move_it_in_display_line_to'
17425 above, because move_it_in_display_line_to calls
17426 handle_line_prefix itself. */
17427 handle_line_prefix (it
);
17430 /* Get the initial row height. This is either the height of the
17431 text hscrolled, if there is any, or zero. */
17432 row
->ascent
= it
->max_ascent
;
17433 row
->height
= it
->max_ascent
+ it
->max_descent
;
17434 row
->phys_ascent
= it
->max_phys_ascent
;
17435 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17436 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17438 /* Loop generating characters. The loop is left with IT on the next
17439 character to display. */
17442 int n_glyphs_before
, hpos_before
, x_before
;
17444 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17446 /* Retrieve the next thing to display. Value is zero if end of
17448 if (!get_next_display_element (it
))
17450 /* Maybe add a space at the end of this line that is used to
17451 display the cursor there under X. Set the charpos of the
17452 first glyph of blank lines not corresponding to any text
17454 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17455 row
->exact_window_width_line_p
= 1;
17456 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17457 || row
->used
[TEXT_AREA
] == 0)
17459 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17460 row
->displays_text_p
= 0;
17462 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17463 && (!MINI_WINDOW_P (it
->w
)
17464 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17465 row
->indicate_empty_line_p
= 1;
17468 it
->continuation_lines_width
= 0;
17469 row
->ends_at_zv_p
= 1;
17470 /* A row that displays right-to-left text must always have
17471 its last face extended all the way to the end of line,
17472 even if this row ends in ZV. */
17473 if (row
->reversed_p
)
17474 extend_face_to_end_of_line (it
);
17478 /* Now, get the metrics of what we want to display. This also
17479 generates glyphs in `row' (which is IT->glyph_row). */
17480 n_glyphs_before
= row
->used
[TEXT_AREA
];
17483 /* Remember the line height so far in case the next element doesn't
17484 fit on the line. */
17485 if (it
->line_wrap
!= TRUNCATE
)
17487 ascent
= it
->max_ascent
;
17488 descent
= it
->max_descent
;
17489 phys_ascent
= it
->max_phys_ascent
;
17490 phys_descent
= it
->max_phys_descent
;
17492 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17494 if (IT_DISPLAYING_WHITESPACE (it
))
17500 wrap_row_used
= row
->used
[TEXT_AREA
];
17501 wrap_row_ascent
= row
->ascent
;
17502 wrap_row_height
= row
->height
;
17503 wrap_row_phys_ascent
= row
->phys_ascent
;
17504 wrap_row_phys_height
= row
->phys_height
;
17505 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17511 PRODUCE_GLYPHS (it
);
17513 /* If this display element was in marginal areas, continue with
17515 if (it
->area
!= TEXT_AREA
)
17517 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17518 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17519 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17520 row
->phys_height
= max (row
->phys_height
,
17521 it
->max_phys_ascent
+ it
->max_phys_descent
);
17522 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17523 it
->max_extra_line_spacing
);
17524 set_iterator_to_next (it
, 1);
17528 /* Does the display element fit on the line? If we truncate
17529 lines, we should draw past the right edge of the window. If
17530 we don't truncate, we want to stop so that we can display the
17531 continuation glyph before the right margin. If lines are
17532 continued, there are two possible strategies for characters
17533 resulting in more than 1 glyph (e.g. tabs): Display as many
17534 glyphs as possible in this line and leave the rest for the
17535 continuation line, or display the whole element in the next
17536 line. Original redisplay did the former, so we do it also. */
17537 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17538 hpos_before
= it
->hpos
;
17541 if (/* Not a newline. */
17543 /* Glyphs produced fit entirely in the line. */
17544 && it
->current_x
< it
->last_visible_x
)
17546 it
->hpos
+= nglyphs
;
17547 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17548 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17549 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17550 row
->phys_height
= max (row
->phys_height
,
17551 it
->max_phys_ascent
+ it
->max_phys_descent
);
17552 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17553 it
->max_extra_line_spacing
);
17554 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17555 row
->x
= x
- it
->first_visible_x
;
17560 struct glyph
*glyph
;
17562 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17564 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17565 new_x
= x
+ glyph
->pixel_width
;
17567 if (/* Lines are continued. */
17568 it
->line_wrap
!= TRUNCATE
17569 && (/* Glyph doesn't fit on the line. */
17570 new_x
> it
->last_visible_x
17571 /* Or it fits exactly on a window system frame. */
17572 || (new_x
== it
->last_visible_x
17573 && FRAME_WINDOW_P (it
->f
))))
17575 /* End of a continued line. */
17578 || (new_x
== it
->last_visible_x
17579 && FRAME_WINDOW_P (it
->f
)))
17581 /* Current glyph is the only one on the line or
17582 fits exactly on the line. We must continue
17583 the line because we can't draw the cursor
17584 after the glyph. */
17585 row
->continued_p
= 1;
17586 it
->current_x
= new_x
;
17587 it
->continuation_lines_width
+= new_x
;
17589 if (i
== nglyphs
- 1)
17591 /* If line-wrap is on, check if a previous
17592 wrap point was found. */
17593 if (wrap_row_used
> 0
17594 /* Even if there is a previous wrap
17595 point, continue the line here as
17596 usual, if (i) the previous character
17597 was a space or tab AND (ii) the
17598 current character is not. */
17600 || IT_DISPLAYING_WHITESPACE (it
)))
17603 set_iterator_to_next (it
, 1);
17604 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17606 if (!get_next_display_element (it
))
17608 row
->exact_window_width_line_p
= 1;
17609 it
->continuation_lines_width
= 0;
17610 row
->continued_p
= 0;
17611 row
->ends_at_zv_p
= 1;
17613 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17615 row
->continued_p
= 0;
17616 row
->exact_window_width_line_p
= 1;
17621 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17622 && !FRAME_WINDOW_P (it
->f
))
17624 /* A padding glyph that doesn't fit on this line.
17625 This means the whole character doesn't fit
17627 if (row
->reversed_p
)
17628 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17629 - n_glyphs_before
);
17630 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17632 /* Fill the rest of the row with continuation
17633 glyphs like in 20.x. */
17634 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17635 < row
->glyphs
[1 + TEXT_AREA
])
17636 produce_special_glyphs (it
, IT_CONTINUATION
);
17638 row
->continued_p
= 1;
17639 it
->current_x
= x_before
;
17640 it
->continuation_lines_width
+= x_before
;
17642 /* Restore the height to what it was before the
17643 element not fitting on the line. */
17644 it
->max_ascent
= ascent
;
17645 it
->max_descent
= descent
;
17646 it
->max_phys_ascent
= phys_ascent
;
17647 it
->max_phys_descent
= phys_descent
;
17649 else if (wrap_row_used
> 0)
17652 if (row
->reversed_p
)
17653 unproduce_glyphs (it
,
17654 row
->used
[TEXT_AREA
] - wrap_row_used
);
17656 it
->continuation_lines_width
+= wrap_x
;
17657 row
->used
[TEXT_AREA
] = wrap_row_used
;
17658 row
->ascent
= wrap_row_ascent
;
17659 row
->height
= wrap_row_height
;
17660 row
->phys_ascent
= wrap_row_phys_ascent
;
17661 row
->phys_height
= wrap_row_phys_height
;
17662 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17663 row
->continued_p
= 1;
17664 row
->ends_at_zv_p
= 0;
17665 row
->exact_window_width_line_p
= 0;
17666 it
->continuation_lines_width
+= x
;
17668 /* Make sure that a non-default face is extended
17669 up to the right margin of the window. */
17670 extend_face_to_end_of_line (it
);
17672 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17674 /* A TAB that extends past the right edge of the
17675 window. This produces a single glyph on
17676 window system frames. We leave the glyph in
17677 this row and let it fill the row, but don't
17678 consume the TAB. */
17679 it
->continuation_lines_width
+= it
->last_visible_x
;
17680 row
->ends_in_middle_of_char_p
= 1;
17681 row
->continued_p
= 1;
17682 glyph
->pixel_width
= it
->last_visible_x
- x
;
17683 it
->starts_in_middle_of_char_p
= 1;
17687 /* Something other than a TAB that draws past
17688 the right edge of the window. Restore
17689 positions to values before the element. */
17690 if (row
->reversed_p
)
17691 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17692 - (n_glyphs_before
+ i
));
17693 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17695 /* Display continuation glyphs. */
17696 if (!FRAME_WINDOW_P (it
->f
))
17697 produce_special_glyphs (it
, IT_CONTINUATION
);
17698 row
->continued_p
= 1;
17700 it
->current_x
= x_before
;
17701 it
->continuation_lines_width
+= x
;
17702 extend_face_to_end_of_line (it
);
17704 if (nglyphs
> 1 && i
> 0)
17706 row
->ends_in_middle_of_char_p
= 1;
17707 it
->starts_in_middle_of_char_p
= 1;
17710 /* Restore the height to what it was before the
17711 element not fitting on the line. */
17712 it
->max_ascent
= ascent
;
17713 it
->max_descent
= descent
;
17714 it
->max_phys_ascent
= phys_ascent
;
17715 it
->max_phys_descent
= phys_descent
;
17720 else if (new_x
> it
->first_visible_x
)
17722 /* Increment number of glyphs actually displayed. */
17725 if (x
< it
->first_visible_x
)
17726 /* Glyph is partially visible, i.e. row starts at
17727 negative X position. */
17728 row
->x
= x
- it
->first_visible_x
;
17732 /* Glyph is completely off the left margin of the
17733 window. This should not happen because of the
17734 move_it_in_display_line at the start of this
17735 function, unless the text display area of the
17736 window is empty. */
17737 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17741 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17742 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17743 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17744 row
->phys_height
= max (row
->phys_height
,
17745 it
->max_phys_ascent
+ it
->max_phys_descent
);
17746 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17747 it
->max_extra_line_spacing
);
17749 /* End of this display line if row is continued. */
17750 if (row
->continued_p
|| row
->ends_at_zv_p
)
17755 /* Is this a line end? If yes, we're also done, after making
17756 sure that a non-default face is extended up to the right
17757 margin of the window. */
17758 if (ITERATOR_AT_END_OF_LINE_P (it
))
17760 int used_before
= row
->used
[TEXT_AREA
];
17762 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17764 /* Add a space at the end of the line that is used to
17765 display the cursor there. */
17766 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17767 append_space_for_newline (it
, 0);
17769 /* Extend the face to the end of the line. */
17770 extend_face_to_end_of_line (it
);
17772 /* Make sure we have the position. */
17773 if (used_before
== 0)
17774 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17776 /* Consume the line end. This skips over invisible lines. */
17777 set_iterator_to_next (it
, 1);
17778 it
->continuation_lines_width
= 0;
17782 /* Proceed with next display element. Note that this skips
17783 over lines invisible because of selective display. */
17784 set_iterator_to_next (it
, 1);
17786 /* If we truncate lines, we are done when the last displayed
17787 glyphs reach past the right margin of the window. */
17788 if (it
->line_wrap
== TRUNCATE
17789 && (FRAME_WINDOW_P (it
->f
)
17790 ? (it
->current_x
>= it
->last_visible_x
)
17791 : (it
->current_x
> it
->last_visible_x
)))
17793 /* Maybe add truncation glyphs. */
17794 if (!FRAME_WINDOW_P (it
->f
))
17798 if (!row
->reversed_p
)
17800 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17801 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17806 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17807 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17809 /* Remove padding glyphs at the front of ROW, to
17810 make room for the truncation glyphs we will be
17812 unproduce_glyphs (it
, i
);
17815 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17817 row
->used
[TEXT_AREA
] = i
;
17818 produce_special_glyphs (it
, IT_TRUNCATION
);
17821 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17823 /* Don't truncate if we can overflow newline into fringe. */
17824 if (!get_next_display_element (it
))
17826 it
->continuation_lines_width
= 0;
17827 row
->ends_at_zv_p
= 1;
17828 row
->exact_window_width_line_p
= 1;
17831 if (ITERATOR_AT_END_OF_LINE_P (it
))
17833 row
->exact_window_width_line_p
= 1;
17834 goto at_end_of_line
;
17838 row
->truncated_on_right_p
= 1;
17839 it
->continuation_lines_width
= 0;
17840 reseat_at_next_visible_line_start (it
, 0);
17841 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17842 it
->hpos
= hpos_before
;
17843 it
->current_x
= x_before
;
17848 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17849 at the left window margin. */
17850 if (it
->first_visible_x
17851 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
17853 if (!FRAME_WINDOW_P (it
->f
))
17854 insert_left_trunc_glyphs (it
);
17855 row
->truncated_on_left_p
= 1;
17858 /* If the start of this line is the overlay arrow-position, then
17859 mark this glyph row as the one containing the overlay arrow.
17860 This is clearly a mess with variable size fonts. It would be
17861 better to let it be displayed like cursors under X. */
17862 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17863 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17864 !NILP (overlay_arrow_string
)))
17866 /* Overlay arrow in window redisplay is a fringe bitmap. */
17867 if (STRINGP (overlay_arrow_string
))
17869 struct glyph_row
*arrow_row
17870 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17871 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17872 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17873 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17874 struct glyph
*p2
, *end
;
17876 /* Copy the arrow glyphs. */
17877 while (glyph
< arrow_end
)
17880 /* Throw away padding glyphs. */
17882 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17883 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17889 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17894 xassert (INTEGERP (overlay_arrow_string
));
17895 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17897 overlay_arrow_seen
= 1;
17900 /* Compute pixel dimensions of this line. */
17901 compute_line_metrics (it
);
17903 /* Remember the position at which this line ends. */
17904 row
->end
= row_end
= it
->current
;
17907 /* ROW->start and ROW->end must be the smallest and largest
17908 buffer positions in ROW. But if ROW was bidi-reordered,
17909 these two positions can be anywhere in the row, so we must
17910 rescan all of the ROW's glyphs to find them. */
17911 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17912 lines' rows is implemented for bidi-reordered rows. */
17913 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17916 struct text_pos tpos
;
17918 for (g
= row
->glyphs
[TEXT_AREA
];
17919 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17922 if (BUFFERP (g
->object
))
17924 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17925 min_pos
= g
->charpos
;
17926 if (g
->charpos
> max_pos
)
17927 max_pos
= g
->charpos
;
17930 /* Empty lines have a valid buffer position at their first
17931 glyph, but that glyph's OBJECT is zero, as if it didn't come
17932 from a buffer. If we didn't find any valid buffer positions
17933 in this row, maybe we have such an empty line. */
17934 if (min_pos
== ZV
+ 1 && row
->used
[TEXT_AREA
])
17936 for (g
= row
->glyphs
[TEXT_AREA
];
17937 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17940 if (INTEGERP (g
->object
))
17942 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17943 min_pos
= g
->charpos
;
17944 if (g
->charpos
> max_pos
)
17945 max_pos
= g
->charpos
;
17951 if (min_pos
!= row
->start
.pos
.charpos
)
17953 row
->start
.pos
.charpos
= min_pos
;
17954 row
->start
.pos
.bytepos
= CHAR_TO_BYTE (min_pos
);
17959 /* For ROW->end, we need the position that is _after_ max_pos,
17960 in the logical order, unless we are at ZV. */
17961 if (row
->ends_at_zv_p
)
17963 row_end
= row
->end
= it
->current
;
17964 if (!row
->used
[TEXT_AREA
])
17966 row
->start
.pos
.charpos
= row_end
.pos
.charpos
;
17967 row
->start
.pos
.bytepos
= row_end
.pos
.bytepos
;
17970 else if (row
->used
[TEXT_AREA
] && max_pos
)
17972 SET_TEXT_POS (tpos
, max_pos
+ 1, CHAR_TO_BYTE (max_pos
+ 1));
17973 row_end
= it
->current
;
17974 row_end
.pos
= tpos
;
17975 /* If the character at max_pos+1 is a newline, skip that as
17976 well. Note that this may skip some invisible text. */
17977 if (FETCH_CHAR (tpos
.bytepos
) == '\n'
17978 || (FETCH_CHAR (tpos
.bytepos
) == '\r' && it
->selective
))
17982 reseat_1 (it
, tpos
, 0);
17983 set_iterator_to_next (it
, 1);
17984 /* Record the position after the newline of a continued
17985 row. We will need that to set ROW->end of the last
17986 row produced for a continued line. */
17987 if (row
->continued_p
)
17989 save_it
.eol_pos
.charpos
= IT_CHARPOS (*it
);
17990 save_it
.eol_pos
.bytepos
= IT_BYTEPOS (*it
);
17994 row_end
= it
->current
;
17995 save_it
.eol_pos
.charpos
= save_it
.eol_pos
.bytepos
= 0;
17999 else if (!row
->continued_p
18000 && MATRIX_ROW_CONTINUATION_LINE_P (row
)
18001 && it
->eol_pos
.charpos
> 0)
18003 /* Last row of a continued line. Use the position
18004 recorded in ROW->eol_pos, to the effect that the
18005 newline belongs to this row, not to the row which
18006 displays the character with the largest buffer
18008 row_end
.pos
= it
->eol_pos
;
18009 it
->eol_pos
.charpos
= it
->eol_pos
.bytepos
= 0;
18011 row
->end
= row_end
;
18015 /* Record whether this row ends inside an ellipsis. */
18016 row
->ends_in_ellipsis_p
18017 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18018 && it
->ellipsis_p
);
18020 /* Save fringe bitmaps in this row. */
18021 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18022 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18023 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18024 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18026 it
->left_user_fringe_bitmap
= 0;
18027 it
->left_user_fringe_face_id
= 0;
18028 it
->right_user_fringe_bitmap
= 0;
18029 it
->right_user_fringe_face_id
= 0;
18031 /* Maybe set the cursor. */
18032 cvpos
= it
->w
->cursor
.vpos
;
18034 /* In bidi-reordered rows, keep checking for proper cursor
18035 position even if one has been found already, because buffer
18036 positions in such rows change non-linearly with ROW->VPOS,
18037 when a line is continued. One exception: when we are at ZV,
18038 display cursor on the first suitable glyph row, since all
18039 the empty rows after that also have their position set to ZV. */
18040 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18041 lines' rows is implemented for bidi-reordered rows. */
18043 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18044 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18045 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18046 && cursor_row_p (it
->w
, row
))
18047 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18049 /* Highlight trailing whitespace. */
18050 if (!NILP (Vshow_trailing_whitespace
))
18051 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18053 /* Prepare for the next line. This line starts horizontally at (X
18054 HPOS) = (0 0). Vertical positions are incremented. As a
18055 convenience for the caller, IT->glyph_row is set to the next
18057 it
->current_x
= it
->hpos
= 0;
18058 it
->current_y
+= row
->height
;
18061 /* The next row should by default use the same value of the
18062 reversed_p flag as this one. set_iterator_to_next decides when
18063 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18064 the flag accordingly. */
18065 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18066 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18067 it
->start
= row_end
;
18068 return row
->displays_text_p
;
18073 /***********************************************************************
18075 ***********************************************************************/
18077 /* Redisplay the menu bar in the frame for window W.
18079 The menu bar of X frames that don't have X toolkit support is
18080 displayed in a special window W->frame->menu_bar_window.
18082 The menu bar of terminal frames is treated specially as far as
18083 glyph matrices are concerned. Menu bar lines are not part of
18084 windows, so the update is done directly on the frame matrix rows
18085 for the menu bar. */
18088 display_menu_bar (w
)
18091 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18096 /* Don't do all this for graphical frames. */
18098 if (FRAME_W32_P (f
))
18101 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18107 if (FRAME_NS_P (f
))
18109 #endif /* HAVE_NS */
18111 #ifdef USE_X_TOOLKIT
18112 xassert (!FRAME_WINDOW_P (f
));
18113 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18114 it
.first_visible_x
= 0;
18115 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18116 #else /* not USE_X_TOOLKIT */
18117 if (FRAME_WINDOW_P (f
))
18119 /* Menu bar lines are displayed in the desired matrix of the
18120 dummy window menu_bar_window. */
18121 struct window
*menu_w
;
18122 xassert (WINDOWP (f
->menu_bar_window
));
18123 menu_w
= XWINDOW (f
->menu_bar_window
);
18124 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18126 it
.first_visible_x
= 0;
18127 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18131 /* This is a TTY frame, i.e. character hpos/vpos are used as
18133 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18135 it
.first_visible_x
= 0;
18136 it
.last_visible_x
= FRAME_COLS (f
);
18138 #endif /* not USE_X_TOOLKIT */
18140 if (! mode_line_inverse_video
)
18141 /* Force the menu-bar to be displayed in the default face. */
18142 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18144 /* Clear all rows of the menu bar. */
18145 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18147 struct glyph_row
*row
= it
.glyph_row
+ i
;
18148 clear_glyph_row (row
);
18149 row
->enabled_p
= 1;
18150 row
->full_width_p
= 1;
18153 /* Display all items of the menu bar. */
18154 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18155 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18157 Lisp_Object string
;
18159 /* Stop at nil string. */
18160 string
= AREF (items
, i
+ 1);
18164 /* Remember where item was displayed. */
18165 ASET (items
, i
+ 3, make_number (it
.hpos
));
18167 /* Display the item, pad with one space. */
18168 if (it
.current_x
< it
.last_visible_x
)
18169 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18170 SCHARS (string
) + 1, 0, 0, -1);
18173 /* Fill out the line with spaces. */
18174 if (it
.current_x
< it
.last_visible_x
)
18175 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18177 /* Compute the total height of the lines. */
18178 compute_line_metrics (&it
);
18183 /***********************************************************************
18185 ***********************************************************************/
18187 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18188 FORCE is non-zero, redisplay mode lines unconditionally.
18189 Otherwise, redisplay only mode lines that are garbaged. Value is
18190 the number of windows whose mode lines were redisplayed. */
18193 redisplay_mode_lines (window
, force
)
18194 Lisp_Object window
;
18199 while (!NILP (window
))
18201 struct window
*w
= XWINDOW (window
);
18203 if (WINDOWP (w
->hchild
))
18204 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18205 else if (WINDOWP (w
->vchild
))
18206 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18208 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18209 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18211 struct text_pos lpoint
;
18212 struct buffer
*old
= current_buffer
;
18214 /* Set the window's buffer for the mode line display. */
18215 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18216 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18218 /* Point refers normally to the selected window. For any
18219 other window, set up appropriate value. */
18220 if (!EQ (window
, selected_window
))
18222 struct text_pos pt
;
18224 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18225 if (CHARPOS (pt
) < BEGV
)
18226 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18227 else if (CHARPOS (pt
) > (ZV
- 1))
18228 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18230 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18233 /* Display mode lines. */
18234 clear_glyph_matrix (w
->desired_matrix
);
18235 if (display_mode_lines (w
))
18238 w
->must_be_updated_p
= 1;
18241 /* Restore old settings. */
18242 set_buffer_internal_1 (old
);
18243 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18253 /* Display the mode and/or header line of window W. Value is the
18254 sum number of mode lines and header lines displayed. */
18257 display_mode_lines (w
)
18260 Lisp_Object old_selected_window
, old_selected_frame
;
18263 old_selected_frame
= selected_frame
;
18264 selected_frame
= w
->frame
;
18265 old_selected_window
= selected_window
;
18266 XSETWINDOW (selected_window
, w
);
18268 /* These will be set while the mode line specs are processed. */
18269 line_number_displayed
= 0;
18270 w
->column_number_displayed
= Qnil
;
18272 if (WINDOW_WANTS_MODELINE_P (w
))
18274 struct window
*sel_w
= XWINDOW (old_selected_window
);
18276 /* Select mode line face based on the real selected window. */
18277 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18278 current_buffer
->mode_line_format
);
18282 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18284 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18285 current_buffer
->header_line_format
);
18289 selected_frame
= old_selected_frame
;
18290 selected_window
= old_selected_window
;
18295 /* Display mode or header line of window W. FACE_ID specifies which
18296 line to display; it is either MODE_LINE_FACE_ID or
18297 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18298 display. Value is the pixel height of the mode/header line
18302 display_mode_line (w
, face_id
, format
)
18304 enum face_id face_id
;
18305 Lisp_Object format
;
18309 int count
= SPECPDL_INDEX ();
18311 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18312 /* Don't extend on a previously drawn mode-line.
18313 This may happen if called from pos_visible_p. */
18314 it
.glyph_row
->enabled_p
= 0;
18315 prepare_desired_row (it
.glyph_row
);
18317 it
.glyph_row
->mode_line_p
= 1;
18319 if (! mode_line_inverse_video
)
18320 /* Force the mode-line to be displayed in the default face. */
18321 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18323 record_unwind_protect (unwind_format_mode_line
,
18324 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18326 mode_line_target
= MODE_LINE_DISPLAY
;
18328 /* Temporarily make frame's keyboard the current kboard so that
18329 kboard-local variables in the mode_line_format will get the right
18331 push_kboard (FRAME_KBOARD (it
.f
));
18332 record_unwind_save_match_data ();
18333 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18336 unbind_to (count
, Qnil
);
18338 /* Fill up with spaces. */
18339 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18341 compute_line_metrics (&it
);
18342 it
.glyph_row
->full_width_p
= 1;
18343 it
.glyph_row
->continued_p
= 0;
18344 it
.glyph_row
->truncated_on_left_p
= 0;
18345 it
.glyph_row
->truncated_on_right_p
= 0;
18347 /* Make a 3D mode-line have a shadow at its right end. */
18348 face
= FACE_FROM_ID (it
.f
, face_id
);
18349 extend_face_to_end_of_line (&it
);
18350 if (face
->box
!= FACE_NO_BOX
)
18352 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18353 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18354 last
->right_box_line_p
= 1;
18357 return it
.glyph_row
->height
;
18360 /* Move element ELT in LIST to the front of LIST.
18361 Return the updated list. */
18364 move_elt_to_front (elt
, list
)
18365 Lisp_Object elt
, list
;
18367 register Lisp_Object tail
, prev
;
18368 register Lisp_Object tem
;
18372 while (CONSP (tail
))
18378 /* Splice out the link TAIL. */
18380 list
= XCDR (tail
);
18382 Fsetcdr (prev
, XCDR (tail
));
18384 /* Now make it the first. */
18385 Fsetcdr (tail
, list
);
18390 tail
= XCDR (tail
);
18394 /* Not found--return unchanged LIST. */
18398 /* Contribute ELT to the mode line for window IT->w. How it
18399 translates into text depends on its data type.
18401 IT describes the display environment in which we display, as usual.
18403 DEPTH is the depth in recursion. It is used to prevent
18404 infinite recursion here.
18406 FIELD_WIDTH is the number of characters the display of ELT should
18407 occupy in the mode line, and PRECISION is the maximum number of
18408 characters to display from ELT's representation. See
18409 display_string for details.
18411 Returns the hpos of the end of the text generated by ELT.
18413 PROPS is a property list to add to any string we encounter.
18415 If RISKY is nonzero, remove (disregard) any properties in any string
18416 we encounter, and ignore :eval and :propertize.
18418 The global variable `mode_line_target' determines whether the
18419 output is passed to `store_mode_line_noprop',
18420 `store_mode_line_string', or `display_string'. */
18423 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
18426 int field_width
, precision
;
18427 Lisp_Object elt
, props
;
18430 int n
= 0, field
, prec
;
18435 elt
= build_string ("*too-deep*");
18439 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18443 /* A string: output it and check for %-constructs within it. */
18447 if (SCHARS (elt
) > 0
18448 && (!NILP (props
) || risky
))
18450 Lisp_Object oprops
, aelt
;
18451 oprops
= Ftext_properties_at (make_number (0), elt
);
18453 /* If the starting string's properties are not what
18454 we want, translate the string. Also, if the string
18455 is risky, do that anyway. */
18457 if (NILP (Fequal (props
, oprops
)) || risky
)
18459 /* If the starting string has properties,
18460 merge the specified ones onto the existing ones. */
18461 if (! NILP (oprops
) && !risky
)
18465 oprops
= Fcopy_sequence (oprops
);
18467 while (CONSP (tem
))
18469 oprops
= Fplist_put (oprops
, XCAR (tem
),
18470 XCAR (XCDR (tem
)));
18471 tem
= XCDR (XCDR (tem
));
18476 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18477 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18479 /* AELT is what we want. Move it to the front
18480 without consing. */
18482 mode_line_proptrans_alist
18483 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18489 /* If AELT has the wrong props, it is useless.
18490 so get rid of it. */
18492 mode_line_proptrans_alist
18493 = Fdelq (aelt
, mode_line_proptrans_alist
);
18495 elt
= Fcopy_sequence (elt
);
18496 Fset_text_properties (make_number (0), Flength (elt
),
18498 /* Add this item to mode_line_proptrans_alist. */
18499 mode_line_proptrans_alist
18500 = Fcons (Fcons (elt
, props
),
18501 mode_line_proptrans_alist
);
18502 /* Truncate mode_line_proptrans_alist
18503 to at most 50 elements. */
18504 tem
= Fnthcdr (make_number (50),
18505 mode_line_proptrans_alist
);
18507 XSETCDR (tem
, Qnil
);
18516 prec
= precision
- n
;
18517 switch (mode_line_target
)
18519 case MODE_LINE_NOPROP
:
18520 case MODE_LINE_TITLE
:
18521 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18523 case MODE_LINE_STRING
:
18524 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18526 case MODE_LINE_DISPLAY
:
18527 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18528 0, prec
, 0, STRING_MULTIBYTE (elt
));
18535 /* Handle the non-literal case. */
18537 while ((precision
<= 0 || n
< precision
)
18538 && SREF (elt
, offset
) != 0
18539 && (mode_line_target
!= MODE_LINE_DISPLAY
18540 || it
->current_x
< it
->last_visible_x
))
18542 int last_offset
= offset
;
18544 /* Advance to end of string or next format specifier. */
18545 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18548 if (offset
- 1 != last_offset
)
18550 int nchars
, nbytes
;
18552 /* Output to end of string or up to '%'. Field width
18553 is length of string. Don't output more than
18554 PRECISION allows us. */
18557 prec
= c_string_width (SDATA (elt
) + last_offset
,
18558 offset
- last_offset
, precision
- n
,
18561 switch (mode_line_target
)
18563 case MODE_LINE_NOPROP
:
18564 case MODE_LINE_TITLE
:
18565 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18567 case MODE_LINE_STRING
:
18569 int bytepos
= last_offset
;
18570 int charpos
= string_byte_to_char (elt
, bytepos
);
18571 int endpos
= (precision
<= 0
18572 ? string_byte_to_char (elt
, offset
)
18573 : charpos
+ nchars
);
18575 n
+= store_mode_line_string (NULL
,
18576 Fsubstring (elt
, make_number (charpos
),
18577 make_number (endpos
)),
18581 case MODE_LINE_DISPLAY
:
18583 int bytepos
= last_offset
;
18584 int charpos
= string_byte_to_char (elt
, bytepos
);
18586 if (precision
<= 0)
18587 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18588 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18590 STRING_MULTIBYTE (elt
));
18595 else /* c == '%' */
18597 int percent_position
= offset
;
18599 /* Get the specified minimum width. Zero means
18602 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18603 field
= field
* 10 + c
- '0';
18605 /* Don't pad beyond the total padding allowed. */
18606 if (field_width
- n
> 0 && field
> field_width
- n
)
18607 field
= field_width
- n
;
18609 /* Note that either PRECISION <= 0 or N < PRECISION. */
18610 prec
= precision
- n
;
18613 n
+= display_mode_element (it
, depth
, field
, prec
,
18614 Vglobal_mode_string
, props
,
18619 int bytepos
, charpos
;
18620 unsigned char *spec
;
18621 Lisp_Object string
;
18623 bytepos
= percent_position
;
18624 charpos
= (STRING_MULTIBYTE (elt
)
18625 ? string_byte_to_char (elt
, bytepos
)
18627 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18628 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18630 switch (mode_line_target
)
18632 case MODE_LINE_NOPROP
:
18633 case MODE_LINE_TITLE
:
18634 n
+= store_mode_line_noprop (spec
, field
, prec
);
18636 case MODE_LINE_STRING
:
18638 int len
= strlen (spec
);
18639 Lisp_Object tem
= make_string (spec
, len
);
18640 props
= Ftext_properties_at (make_number (charpos
), elt
);
18641 /* Should only keep face property in props */
18642 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18645 case MODE_LINE_DISPLAY
:
18647 int nglyphs_before
, nwritten
;
18649 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18650 nwritten
= display_string (spec
, string
, elt
,
18655 /* Assign to the glyphs written above the
18656 string where the `%x' came from, position
18660 struct glyph
*glyph
18661 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18665 for (i
= 0; i
< nwritten
; ++i
)
18667 glyph
[i
].object
= elt
;
18668 glyph
[i
].charpos
= charpos
;
18685 /* A symbol: process the value of the symbol recursively
18686 as if it appeared here directly. Avoid error if symbol void.
18687 Special case: if value of symbol is a string, output the string
18690 register Lisp_Object tem
;
18692 /* If the variable is not marked as risky to set
18693 then its contents are risky to use. */
18694 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18697 tem
= Fboundp (elt
);
18700 tem
= Fsymbol_value (elt
);
18701 /* If value is a string, output that string literally:
18702 don't check for % within it. */
18706 if (!EQ (tem
, elt
))
18708 /* Give up right away for nil or t. */
18718 register Lisp_Object car
, tem
;
18720 /* A cons cell: five distinct cases.
18721 If first element is :eval or :propertize, do something special.
18722 If first element is a string or a cons, process all the elements
18723 and effectively concatenate them.
18724 If first element is a negative number, truncate displaying cdr to
18725 at most that many characters. If positive, pad (with spaces)
18726 to at least that many characters.
18727 If first element is a symbol, process the cadr or caddr recursively
18728 according to whether the symbol's value is non-nil or nil. */
18730 if (EQ (car
, QCeval
))
18732 /* An element of the form (:eval FORM) means evaluate FORM
18733 and use the result as mode line elements. */
18738 if (CONSP (XCDR (elt
)))
18741 spec
= safe_eval (XCAR (XCDR (elt
)));
18742 n
+= display_mode_element (it
, depth
, field_width
- n
,
18743 precision
- n
, spec
, props
,
18747 else if (EQ (car
, QCpropertize
))
18749 /* An element of the form (:propertize ELT PROPS...)
18750 means display ELT but applying properties PROPS. */
18755 if (CONSP (XCDR (elt
)))
18756 n
+= display_mode_element (it
, depth
, field_width
- n
,
18757 precision
- n
, XCAR (XCDR (elt
)),
18758 XCDR (XCDR (elt
)), risky
);
18760 else if (SYMBOLP (car
))
18762 tem
= Fboundp (car
);
18766 /* elt is now the cdr, and we know it is a cons cell.
18767 Use its car if CAR has a non-nil value. */
18770 tem
= Fsymbol_value (car
);
18777 /* Symbol's value is nil (or symbol is unbound)
18778 Get the cddr of the original list
18779 and if possible find the caddr and use that. */
18783 else if (!CONSP (elt
))
18788 else if (INTEGERP (car
))
18790 register int lim
= XINT (car
);
18794 /* Negative int means reduce maximum width. */
18795 if (precision
<= 0)
18798 precision
= min (precision
, -lim
);
18802 /* Padding specified. Don't let it be more than
18803 current maximum. */
18805 lim
= min (precision
, lim
);
18807 /* If that's more padding than already wanted, queue it.
18808 But don't reduce padding already specified even if
18809 that is beyond the current truncation point. */
18810 field_width
= max (lim
, field_width
);
18814 else if (STRINGP (car
) || CONSP (car
))
18816 Lisp_Object halftail
= elt
;
18820 && (precision
<= 0 || n
< precision
))
18822 n
+= display_mode_element (it
, depth
,
18823 /* Do padding only after the last
18824 element in the list. */
18825 (! CONSP (XCDR (elt
))
18828 precision
- n
, XCAR (elt
),
18832 if ((len
& 1) == 0)
18833 halftail
= XCDR (halftail
);
18834 /* Check for cycle. */
18835 if (EQ (halftail
, elt
))
18844 elt
= build_string ("*invalid*");
18848 /* Pad to FIELD_WIDTH. */
18849 if (field_width
> 0 && n
< field_width
)
18851 switch (mode_line_target
)
18853 case MODE_LINE_NOPROP
:
18854 case MODE_LINE_TITLE
:
18855 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18857 case MODE_LINE_STRING
:
18858 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18860 case MODE_LINE_DISPLAY
:
18861 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18870 /* Store a mode-line string element in mode_line_string_list.
18872 If STRING is non-null, display that C string. Otherwise, the Lisp
18873 string LISP_STRING is displayed.
18875 FIELD_WIDTH is the minimum number of output glyphs to produce.
18876 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18877 with spaces. FIELD_WIDTH <= 0 means don't pad.
18879 PRECISION is the maximum number of characters to output from
18880 STRING. PRECISION <= 0 means don't truncate the string.
18882 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18883 properties to the string.
18885 PROPS are the properties to add to the string.
18886 The mode_line_string_face face property is always added to the string.
18890 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
18892 Lisp_Object lisp_string
;
18901 if (string
!= NULL
)
18903 len
= strlen (string
);
18904 if (precision
> 0 && len
> precision
)
18906 lisp_string
= make_string (string
, len
);
18908 props
= mode_line_string_face_prop
;
18909 else if (!NILP (mode_line_string_face
))
18911 Lisp_Object face
= Fplist_get (props
, Qface
);
18912 props
= Fcopy_sequence (props
);
18914 face
= mode_line_string_face
;
18916 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18917 props
= Fplist_put (props
, Qface
, face
);
18919 Fadd_text_properties (make_number (0), make_number (len
),
18920 props
, lisp_string
);
18924 len
= XFASTINT (Flength (lisp_string
));
18925 if (precision
> 0 && len
> precision
)
18928 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18931 if (!NILP (mode_line_string_face
))
18935 props
= Ftext_properties_at (make_number (0), lisp_string
);
18936 face
= Fplist_get (props
, Qface
);
18938 face
= mode_line_string_face
;
18940 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18941 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18943 lisp_string
= Fcopy_sequence (lisp_string
);
18946 Fadd_text_properties (make_number (0), make_number (len
),
18947 props
, lisp_string
);
18952 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18956 if (field_width
> len
)
18958 field_width
-= len
;
18959 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18961 Fadd_text_properties (make_number (0), make_number (field_width
),
18962 props
, lisp_string
);
18963 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18971 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18973 doc
: /* Format a string out of a mode line format specification.
18974 First arg FORMAT specifies the mode line format (see `mode-line-format'
18975 for details) to use.
18977 Optional second arg FACE specifies the face property to put
18978 on all characters for which no face is specified.
18979 The value t means whatever face the window's mode line currently uses
18980 \(either `mode-line' or `mode-line-inactive', depending).
18981 A value of nil means the default is no face property.
18982 If FACE is an integer, the value string has no text properties.
18984 Optional third and fourth args WINDOW and BUFFER specify the window
18985 and buffer to use as the context for the formatting (defaults
18986 are the selected window and the window's buffer). */)
18987 (format
, face
, window
, buffer
)
18988 Lisp_Object format
, face
, window
, buffer
;
18993 struct buffer
*old_buffer
= NULL
;
18995 int no_props
= INTEGERP (face
);
18996 int count
= SPECPDL_INDEX ();
18998 int string_start
= 0;
19001 window
= selected_window
;
19002 CHECK_WINDOW (window
);
19003 w
= XWINDOW (window
);
19006 buffer
= w
->buffer
;
19007 CHECK_BUFFER (buffer
);
19009 /* Make formatting the modeline a non-op when noninteractive, otherwise
19010 there will be problems later caused by a partially initialized frame. */
19011 if (NILP (format
) || noninteractive
)
19012 return empty_unibyte_string
;
19020 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
19021 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
19025 face_id
= DEFAULT_FACE_ID
;
19027 if (XBUFFER (buffer
) != current_buffer
)
19028 old_buffer
= current_buffer
;
19030 /* Save things including mode_line_proptrans_alist,
19031 and set that to nil so that we don't alter the outer value. */
19032 record_unwind_protect (unwind_format_mode_line
,
19033 format_mode_line_unwind_data
19034 (old_buffer
, selected_window
, 1));
19035 mode_line_proptrans_alist
= Qnil
;
19037 Fselect_window (window
, Qt
);
19039 set_buffer_internal_1 (XBUFFER (buffer
));
19041 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19045 mode_line_target
= MODE_LINE_NOPROP
;
19046 mode_line_string_face_prop
= Qnil
;
19047 mode_line_string_list
= Qnil
;
19048 string_start
= MODE_LINE_NOPROP_LEN (0);
19052 mode_line_target
= MODE_LINE_STRING
;
19053 mode_line_string_list
= Qnil
;
19054 mode_line_string_face
= face
;
19055 mode_line_string_face_prop
19056 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19059 push_kboard (FRAME_KBOARD (it
.f
));
19060 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19065 len
= MODE_LINE_NOPROP_LEN (string_start
);
19066 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19070 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19071 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19072 empty_unibyte_string
);
19075 unbind_to (count
, Qnil
);
19079 /* Write a null-terminated, right justified decimal representation of
19080 the positive integer D to BUF using a minimal field width WIDTH. */
19083 pint2str (buf
, width
, d
)
19084 register char *buf
;
19085 register int width
;
19088 register char *p
= buf
;
19096 *p
++ = d
% 10 + '0';
19101 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19112 /* Write a null-terminated, right justified decimal and "human
19113 readable" representation of the nonnegative integer D to BUF using
19114 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19116 static const char power_letter
[] =
19130 pint2hrstr (buf
, width
, d
)
19135 /* We aim to represent the nonnegative integer D as
19136 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19139 /* -1 means: do not use TENTHS. */
19143 /* Length of QUOTIENT.TENTHS as a string. */
19149 if (1000 <= quotient
)
19151 /* Scale to the appropriate EXPONENT. */
19154 remainder
= quotient
% 1000;
19158 while (1000 <= quotient
);
19160 /* Round to nearest and decide whether to use TENTHS or not. */
19163 tenths
= remainder
/ 100;
19164 if (50 <= remainder
% 100)
19171 if (quotient
== 10)
19179 if (500 <= remainder
)
19181 if (quotient
< 999)
19192 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19193 if (tenths
== -1 && quotient
<= 99)
19200 p
= psuffix
= buf
+ max (width
, length
);
19202 /* Print EXPONENT. */
19204 *psuffix
++ = power_letter
[exponent
];
19207 /* Print TENTHS. */
19210 *--p
= '0' + tenths
;
19214 /* Print QUOTIENT. */
19217 int digit
= quotient
% 10;
19218 *--p
= '0' + digit
;
19220 while ((quotient
/= 10) != 0);
19222 /* Print leading spaces. */
19227 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19228 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19229 type of CODING_SYSTEM. Return updated pointer into BUF. */
19231 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19234 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
19235 Lisp_Object coding_system
;
19236 register char *buf
;
19240 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19241 const unsigned char *eol_str
;
19243 /* The EOL conversion we are using. */
19244 Lisp_Object eoltype
;
19246 val
= CODING_SYSTEM_SPEC (coding_system
);
19249 if (!VECTORP (val
)) /* Not yet decided. */
19254 eoltype
= eol_mnemonic_undecided
;
19255 /* Don't mention EOL conversion if it isn't decided. */
19260 Lisp_Object eolvalue
;
19262 attrs
= AREF (val
, 0);
19263 eolvalue
= AREF (val
, 2);
19266 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19270 /* The EOL conversion that is normal on this system. */
19272 if (NILP (eolvalue
)) /* Not yet decided. */
19273 eoltype
= eol_mnemonic_undecided
;
19274 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19275 eoltype
= eol_mnemonic_undecided
;
19276 else /* eolvalue is Qunix, Qdos, or Qmac. */
19277 eoltype
= (EQ (eolvalue
, Qunix
)
19278 ? eol_mnemonic_unix
19279 : (EQ (eolvalue
, Qdos
) == 1
19280 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19286 /* Mention the EOL conversion if it is not the usual one. */
19287 if (STRINGP (eoltype
))
19289 eol_str
= SDATA (eoltype
);
19290 eol_str_len
= SBYTES (eoltype
);
19292 else if (CHARACTERP (eoltype
))
19294 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19295 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19300 eol_str
= invalid_eol_type
;
19301 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19303 bcopy (eol_str
, buf
, eol_str_len
);
19304 buf
+= eol_str_len
;
19310 /* Return a string for the output of a mode line %-spec for window W,
19311 generated by character C. PRECISION >= 0 means don't return a
19312 string longer than that value. FIELD_WIDTH > 0 means pad the
19313 string returned with spaces to that value. Return a Lisp string in
19314 *STRING if the resulting string is taken from that Lisp string.
19316 Note we operate on the current buffer for most purposes,
19317 the exception being w->base_line_pos. */
19319 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19322 decode_mode_spec (w
, c
, field_width
, precision
, string
)
19325 int field_width
, precision
;
19326 Lisp_Object
*string
;
19329 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19330 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19331 struct buffer
*b
= current_buffer
;
19339 if (!NILP (b
->read_only
))
19341 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19346 /* This differs from %* only for a modified read-only buffer. */
19347 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19349 if (!NILP (b
->read_only
))
19354 /* This differs from %* in ignoring read-only-ness. */
19355 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19367 if (command_loop_level
> 5)
19369 p
= decode_mode_spec_buf
;
19370 for (i
= 0; i
< command_loop_level
; i
++)
19373 return decode_mode_spec_buf
;
19381 if (command_loop_level
> 5)
19383 p
= decode_mode_spec_buf
;
19384 for (i
= 0; i
< command_loop_level
; i
++)
19387 return decode_mode_spec_buf
;
19394 /* Let lots_of_dashes be a string of infinite length. */
19395 if (mode_line_target
== MODE_LINE_NOPROP
||
19396 mode_line_target
== MODE_LINE_STRING
)
19398 if (field_width
<= 0
19399 || field_width
> sizeof (lots_of_dashes
))
19401 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19402 decode_mode_spec_buf
[i
] = '-';
19403 decode_mode_spec_buf
[i
] = '\0';
19404 return decode_mode_spec_buf
;
19407 return lots_of_dashes
;
19415 /* %c and %l are ignored in `frame-title-format'.
19416 (In redisplay_internal, the frame title is drawn _before_ the
19417 windows are updated, so the stuff which depends on actual
19418 window contents (such as %l) may fail to render properly, or
19419 even crash emacs.) */
19420 if (mode_line_target
== MODE_LINE_TITLE
)
19424 int col
= (int) current_column (); /* iftc */
19425 w
->column_number_displayed
= make_number (col
);
19426 pint2str (decode_mode_spec_buf
, field_width
, col
);
19427 return decode_mode_spec_buf
;
19431 #ifndef SYSTEM_MALLOC
19433 if (NILP (Vmemory_full
))
19436 return "!MEM FULL! ";
19443 /* %F displays the frame name. */
19444 if (!NILP (f
->title
))
19445 return (char *) SDATA (f
->title
);
19446 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19447 return (char *) SDATA (f
->name
);
19456 int size
= ZV
- BEGV
;
19457 pint2str (decode_mode_spec_buf
, field_width
, size
);
19458 return decode_mode_spec_buf
;
19463 int size
= ZV
- BEGV
;
19464 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19465 return decode_mode_spec_buf
;
19470 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19471 int topline
, nlines
, junk
, height
;
19473 /* %c and %l are ignored in `frame-title-format'. */
19474 if (mode_line_target
== MODE_LINE_TITLE
)
19477 startpos
= XMARKER (w
->start
)->charpos
;
19478 startpos_byte
= marker_byte_position (w
->start
);
19479 height
= WINDOW_TOTAL_LINES (w
);
19481 /* If we decided that this buffer isn't suitable for line numbers,
19482 don't forget that too fast. */
19483 if (EQ (w
->base_line_pos
, w
->buffer
))
19485 /* But do forget it, if the window shows a different buffer now. */
19486 else if (BUFFERP (w
->base_line_pos
))
19487 w
->base_line_pos
= Qnil
;
19489 /* If the buffer is very big, don't waste time. */
19490 if (INTEGERP (Vline_number_display_limit
)
19491 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19493 w
->base_line_pos
= Qnil
;
19494 w
->base_line_number
= Qnil
;
19498 if (INTEGERP (w
->base_line_number
)
19499 && INTEGERP (w
->base_line_pos
)
19500 && XFASTINT (w
->base_line_pos
) <= startpos
)
19502 line
= XFASTINT (w
->base_line_number
);
19503 linepos
= XFASTINT (w
->base_line_pos
);
19504 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19509 linepos
= BUF_BEGV (b
);
19510 linepos_byte
= BUF_BEGV_BYTE (b
);
19513 /* Count lines from base line to window start position. */
19514 nlines
= display_count_lines (linepos
, linepos_byte
,
19518 topline
= nlines
+ line
;
19520 /* Determine a new base line, if the old one is too close
19521 or too far away, or if we did not have one.
19522 "Too close" means it's plausible a scroll-down would
19523 go back past it. */
19524 if (startpos
== BUF_BEGV (b
))
19526 w
->base_line_number
= make_number (topline
);
19527 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19529 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19530 || linepos
== BUF_BEGV (b
))
19532 int limit
= BUF_BEGV (b
);
19533 int limit_byte
= BUF_BEGV_BYTE (b
);
19535 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19537 if (startpos
- distance
> limit
)
19539 limit
= startpos
- distance
;
19540 limit_byte
= CHAR_TO_BYTE (limit
);
19543 nlines
= display_count_lines (startpos
, startpos_byte
,
19545 - (height
* 2 + 30),
19547 /* If we couldn't find the lines we wanted within
19548 line_number_display_limit_width chars per line,
19549 give up on line numbers for this window. */
19550 if (position
== limit_byte
&& limit
== startpos
- distance
)
19552 w
->base_line_pos
= w
->buffer
;
19553 w
->base_line_number
= Qnil
;
19557 w
->base_line_number
= make_number (topline
- nlines
);
19558 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19561 /* Now count lines from the start pos to point. */
19562 nlines
= display_count_lines (startpos
, startpos_byte
,
19563 PT_BYTE
, PT
, &junk
);
19565 /* Record that we did display the line number. */
19566 line_number_displayed
= 1;
19568 /* Make the string to show. */
19569 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19570 return decode_mode_spec_buf
;
19573 char* p
= decode_mode_spec_buf
;
19574 int pad
= field_width
- 2;
19580 return decode_mode_spec_buf
;
19586 obj
= b
->mode_name
;
19590 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19596 int pos
= marker_position (w
->start
);
19597 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19599 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19601 if (pos
<= BUF_BEGV (b
))
19606 else if (pos
<= BUF_BEGV (b
))
19610 if (total
> 1000000)
19611 /* Do it differently for a large value, to avoid overflow. */
19612 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19614 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19615 /* We can't normally display a 3-digit number,
19616 so get us a 2-digit number that is close. */
19619 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19620 return decode_mode_spec_buf
;
19624 /* Display percentage of size above the bottom of the screen. */
19627 int toppos
= marker_position (w
->start
);
19628 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19629 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19631 if (botpos
>= BUF_ZV (b
))
19633 if (toppos
<= BUF_BEGV (b
))
19640 if (total
> 1000000)
19641 /* Do it differently for a large value, to avoid overflow. */
19642 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19644 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19645 /* We can't normally display a 3-digit number,
19646 so get us a 2-digit number that is close. */
19649 if (toppos
<= BUF_BEGV (b
))
19650 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19652 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19653 return decode_mode_spec_buf
;
19658 /* status of process */
19659 obj
= Fget_buffer_process (Fcurrent_buffer ());
19661 return "no process";
19662 #ifdef subprocesses
19663 obj
= Fsymbol_name (Fprocess_status (obj
));
19669 int count
= inhibit_garbage_collection ();
19670 Lisp_Object val
= call1 (intern ("file-remote-p"),
19671 current_buffer
->directory
);
19672 unbind_to (count
, Qnil
);
19680 case 't': /* indicate TEXT or BINARY */
19681 #ifdef MODE_LINE_BINARY_TEXT
19682 return MODE_LINE_BINARY_TEXT (b
);
19688 /* coding-system (not including end-of-line format) */
19690 /* coding-system (including end-of-line type) */
19692 int eol_flag
= (c
== 'Z');
19693 char *p
= decode_mode_spec_buf
;
19695 if (! FRAME_WINDOW_P (f
))
19697 /* No need to mention EOL here--the terminal never needs
19698 to do EOL conversion. */
19699 p
= decode_mode_spec_coding (CODING_ID_NAME
19700 (FRAME_KEYBOARD_CODING (f
)->id
),
19702 p
= decode_mode_spec_coding (CODING_ID_NAME
19703 (FRAME_TERMINAL_CODING (f
)->id
),
19706 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19709 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19710 #ifdef subprocesses
19711 obj
= Fget_buffer_process (Fcurrent_buffer ());
19712 if (PROCESSP (obj
))
19714 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19716 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19719 #endif /* subprocesses */
19722 return decode_mode_spec_buf
;
19729 return (char *) SDATA (obj
);
19736 /* Count up to COUNT lines starting from START / START_BYTE.
19737 But don't go beyond LIMIT_BYTE.
19738 Return the number of lines thus found (always nonnegative).
19740 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19743 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
19744 int start
, start_byte
, limit_byte
, count
;
19747 register unsigned char *cursor
;
19748 unsigned char *base
;
19750 register int ceiling
;
19751 register unsigned char *ceiling_addr
;
19752 int orig_count
= count
;
19754 /* If we are not in selective display mode,
19755 check only for newlines. */
19756 int selective_display
= (!NILP (current_buffer
->selective_display
)
19757 && !INTEGERP (current_buffer
->selective_display
));
19761 while (start_byte
< limit_byte
)
19763 ceiling
= BUFFER_CEILING_OF (start_byte
);
19764 ceiling
= min (limit_byte
- 1, ceiling
);
19765 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19766 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19769 if (selective_display
)
19770 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19773 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19776 if (cursor
!= ceiling_addr
)
19780 start_byte
+= cursor
- base
+ 1;
19781 *byte_pos_ptr
= start_byte
;
19785 if (++cursor
== ceiling_addr
)
19791 start_byte
+= cursor
- base
;
19796 while (start_byte
> limit_byte
)
19798 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19799 ceiling
= max (limit_byte
, ceiling
);
19800 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19801 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19804 if (selective_display
)
19805 while (--cursor
!= ceiling_addr
19806 && *cursor
!= '\n' && *cursor
!= 015)
19809 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19812 if (cursor
!= ceiling_addr
)
19816 start_byte
+= cursor
- base
+ 1;
19817 *byte_pos_ptr
= start_byte
;
19818 /* When scanning backwards, we should
19819 not count the newline posterior to which we stop. */
19820 return - orig_count
- 1;
19826 /* Here we add 1 to compensate for the last decrement
19827 of CURSOR, which took it past the valid range. */
19828 start_byte
+= cursor
- base
+ 1;
19832 *byte_pos_ptr
= limit_byte
;
19835 return - orig_count
+ count
;
19836 return orig_count
- count
;
19842 /***********************************************************************
19844 ***********************************************************************/
19846 /* Display a NUL-terminated string, starting with index START.
19848 If STRING is non-null, display that C string. Otherwise, the Lisp
19849 string LISP_STRING is displayed. There's a case that STRING is
19850 non-null and LISP_STRING is not nil. It means STRING is a string
19851 data of LISP_STRING. In that case, we display LISP_STRING while
19852 ignoring its text properties.
19854 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19855 FACE_STRING. Display STRING or LISP_STRING with the face at
19856 FACE_STRING_POS in FACE_STRING:
19858 Display the string in the environment given by IT, but use the
19859 standard display table, temporarily.
19861 FIELD_WIDTH is the minimum number of output glyphs to produce.
19862 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19863 with spaces. If STRING has more characters, more than FIELD_WIDTH
19864 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19866 PRECISION is the maximum number of characters to output from
19867 STRING. PRECISION < 0 means don't truncate the string.
19869 This is roughly equivalent to printf format specifiers:
19871 FIELD_WIDTH PRECISION PRINTF
19872 ----------------------------------------
19878 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19879 display them, and < 0 means obey the current buffer's value of
19880 enable_multibyte_characters.
19882 Value is the number of columns displayed. */
19885 display_string (string
, lisp_string
, face_string
, face_string_pos
,
19886 start
, it
, field_width
, precision
, max_x
, multibyte
)
19887 unsigned char *string
;
19888 Lisp_Object lisp_string
;
19889 Lisp_Object face_string
;
19890 EMACS_INT face_string_pos
;
19893 int field_width
, precision
, max_x
;
19896 int hpos_at_start
= it
->hpos
;
19897 int saved_face_id
= it
->face_id
;
19898 struct glyph_row
*row
= it
->glyph_row
;
19900 /* Initialize the iterator IT for iteration over STRING beginning
19901 with index START. */
19902 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19903 precision
, field_width
, multibyte
);
19904 if (string
&& STRINGP (lisp_string
))
19905 /* LISP_STRING is the one returned by decode_mode_spec. We should
19906 ignore its text properties. */
19907 it
->stop_charpos
= -1;
19909 /* If displaying STRING, set up the face of the iterator
19910 from LISP_STRING, if that's given. */
19911 if (STRINGP (face_string
))
19917 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19918 0, it
->region_beg_charpos
,
19919 it
->region_end_charpos
,
19920 &endptr
, it
->base_face_id
, 0);
19921 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19922 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19925 /* Set max_x to the maximum allowed X position. Don't let it go
19926 beyond the right edge of the window. */
19928 max_x
= it
->last_visible_x
;
19930 max_x
= min (max_x
, it
->last_visible_x
);
19932 /* Skip over display elements that are not visible. because IT->w is
19934 if (it
->current_x
< it
->first_visible_x
)
19935 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19936 MOVE_TO_POS
| MOVE_TO_X
);
19938 row
->ascent
= it
->max_ascent
;
19939 row
->height
= it
->max_ascent
+ it
->max_descent
;
19940 row
->phys_ascent
= it
->max_phys_ascent
;
19941 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19942 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19944 /* This condition is for the case that we are called with current_x
19945 past last_visible_x. */
19946 while (it
->current_x
< max_x
)
19948 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19950 /* Get the next display element. */
19951 if (!get_next_display_element (it
))
19954 /* Produce glyphs. */
19955 x_before
= it
->current_x
;
19956 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19957 PRODUCE_GLYPHS (it
);
19959 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19962 while (i
< nglyphs
)
19964 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19966 if (it
->line_wrap
!= TRUNCATE
19967 && x
+ glyph
->pixel_width
> max_x
)
19969 /* End of continued line or max_x reached. */
19970 if (CHAR_GLYPH_PADDING_P (*glyph
))
19972 /* A wide character is unbreakable. */
19973 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19974 it
->current_x
= x_before
;
19978 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19983 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19985 /* Glyph is at least partially visible. */
19987 if (x
< it
->first_visible_x
)
19988 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19992 /* Glyph is off the left margin of the display area.
19993 Should not happen. */
19997 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19998 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19999 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20000 row
->phys_height
= max (row
->phys_height
,
20001 it
->max_phys_ascent
+ it
->max_phys_descent
);
20002 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20003 it
->max_extra_line_spacing
);
20004 x
+= glyph
->pixel_width
;
20008 /* Stop if max_x reached. */
20012 /* Stop at line ends. */
20013 if (ITERATOR_AT_END_OF_LINE_P (it
))
20015 it
->continuation_lines_width
= 0;
20019 set_iterator_to_next (it
, 1);
20021 /* Stop if truncating at the right edge. */
20022 if (it
->line_wrap
== TRUNCATE
20023 && it
->current_x
>= it
->last_visible_x
)
20025 /* Add truncation mark, but don't do it if the line is
20026 truncated at a padding space. */
20027 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20029 if (!FRAME_WINDOW_P (it
->f
))
20033 if (it
->current_x
> it
->last_visible_x
)
20035 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20036 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20038 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20040 row
->used
[TEXT_AREA
] = i
;
20041 produce_special_glyphs (it
, IT_TRUNCATION
);
20044 produce_special_glyphs (it
, IT_TRUNCATION
);
20046 it
->glyph_row
->truncated_on_right_p
= 1;
20052 /* Maybe insert a truncation at the left. */
20053 if (it
->first_visible_x
20054 && IT_CHARPOS (*it
) > 0)
20056 if (!FRAME_WINDOW_P (it
->f
))
20057 insert_left_trunc_glyphs (it
);
20058 it
->glyph_row
->truncated_on_left_p
= 1;
20061 it
->face_id
= saved_face_id
;
20063 /* Value is number of columns displayed. */
20064 return it
->hpos
- hpos_at_start
;
20069 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20070 appears as an element of LIST or as the car of an element of LIST.
20071 If PROPVAL is a list, compare each element against LIST in that
20072 way, and return 1/2 if any element of PROPVAL is found in LIST.
20073 Otherwise return 0. This function cannot quit.
20074 The return value is 2 if the text is invisible but with an ellipsis
20075 and 1 if it's invisible and without an ellipsis. */
20078 invisible_p (propval
, list
)
20079 register Lisp_Object propval
;
20082 register Lisp_Object tail
, proptail
;
20084 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20086 register Lisp_Object tem
;
20088 if (EQ (propval
, tem
))
20090 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20091 return NILP (XCDR (tem
)) ? 1 : 2;
20094 if (CONSP (propval
))
20096 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20098 Lisp_Object propelt
;
20099 propelt
= XCAR (proptail
);
20100 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20102 register Lisp_Object tem
;
20104 if (EQ (propelt
, tem
))
20106 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20107 return NILP (XCDR (tem
)) ? 1 : 2;
20115 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20116 doc
: /* Non-nil if the property makes the text invisible.
20117 POS-OR-PROP can be a marker or number, in which case it is taken to be
20118 a position in the current buffer and the value of the `invisible' property
20119 is checked; or it can be some other value, which is then presumed to be the
20120 value of the `invisible' property of the text of interest.
20121 The non-nil value returned can be t for truly invisible text or something
20122 else if the text is replaced by an ellipsis. */)
20124 Lisp_Object pos_or_prop
;
20127 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20128 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20130 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20131 return (invis
== 0 ? Qnil
20133 : make_number (invis
));
20136 /* Calculate a width or height in pixels from a specification using
20137 the following elements:
20140 NUM - a (fractional) multiple of the default font width/height
20141 (NUM) - specifies exactly NUM pixels
20142 UNIT - a fixed number of pixels, see below.
20143 ELEMENT - size of a display element in pixels, see below.
20144 (NUM . SPEC) - equals NUM * SPEC
20145 (+ SPEC SPEC ...) - add pixel values
20146 (- SPEC SPEC ...) - subtract pixel values
20147 (- SPEC) - negate pixel value
20150 INT or FLOAT - a number constant
20151 SYMBOL - use symbol's (buffer local) variable binding.
20154 in - pixels per inch *)
20155 mm - pixels per 1/1000 meter *)
20156 cm - pixels per 1/100 meter *)
20157 width - width of current font in pixels.
20158 height - height of current font in pixels.
20160 *) using the ratio(s) defined in display-pixels-per-inch.
20164 left-fringe - left fringe width in pixels
20165 right-fringe - right fringe width in pixels
20167 left-margin - left margin width in pixels
20168 right-margin - right margin width in pixels
20170 scroll-bar - scroll-bar area width in pixels
20174 Pixels corresponding to 5 inches:
20177 Total width of non-text areas on left side of window (if scroll-bar is on left):
20178 '(space :width (+ left-fringe left-margin scroll-bar))
20180 Align to first text column (in header line):
20181 '(space :align-to 0)
20183 Align to middle of text area minus half the width of variable `my-image'
20184 containing a loaded image:
20185 '(space :align-to (0.5 . (- text my-image)))
20187 Width of left margin minus width of 1 character in the default font:
20188 '(space :width (- left-margin 1))
20190 Width of left margin minus width of 2 characters in the current font:
20191 '(space :width (- left-margin (2 . width)))
20193 Center 1 character over left-margin (in header line):
20194 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20196 Different ways to express width of left fringe plus left margin minus one pixel:
20197 '(space :width (- (+ left-fringe left-margin) (1)))
20198 '(space :width (+ left-fringe left-margin (- (1))))
20199 '(space :width (+ left-fringe left-margin (-1)))
20203 #define NUMVAL(X) \
20204 ((INTEGERP (X) || FLOATP (X)) \
20209 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
20214 int width_p
, *align_to
;
20218 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20219 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20222 return OK_PIXELS (0);
20224 xassert (FRAME_LIVE_P (it
->f
));
20226 if (SYMBOLP (prop
))
20228 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20230 char *unit
= SDATA (SYMBOL_NAME (prop
));
20232 if (unit
[0] == 'i' && unit
[1] == 'n')
20234 else if (unit
[0] == 'm' && unit
[1] == 'm')
20236 else if (unit
[0] == 'c' && unit
[1] == 'm')
20243 #ifdef HAVE_WINDOW_SYSTEM
20244 if (FRAME_WINDOW_P (it
->f
)
20246 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20247 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20249 return OK_PIXELS (ppi
/ pixels
);
20252 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20253 || (CONSP (Vdisplay_pixels_per_inch
)
20255 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20256 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20258 return OK_PIXELS (ppi
/ pixels
);
20264 #ifdef HAVE_WINDOW_SYSTEM
20265 if (EQ (prop
, Qheight
))
20266 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20267 if (EQ (prop
, Qwidth
))
20268 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20270 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20271 return OK_PIXELS (1);
20274 if (EQ (prop
, Qtext
))
20275 return OK_PIXELS (width_p
20276 ? window_box_width (it
->w
, TEXT_AREA
)
20277 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20279 if (align_to
&& *align_to
< 0)
20282 if (EQ (prop
, Qleft
))
20283 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20284 if (EQ (prop
, Qright
))
20285 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20286 if (EQ (prop
, Qcenter
))
20287 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20288 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20289 if (EQ (prop
, Qleft_fringe
))
20290 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20291 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20292 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20293 if (EQ (prop
, Qright_fringe
))
20294 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20295 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20296 : window_box_right_offset (it
->w
, TEXT_AREA
));
20297 if (EQ (prop
, Qleft_margin
))
20298 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20299 if (EQ (prop
, Qright_margin
))
20300 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20301 if (EQ (prop
, Qscroll_bar
))
20302 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20304 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20305 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20306 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20311 if (EQ (prop
, Qleft_fringe
))
20312 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20313 if (EQ (prop
, Qright_fringe
))
20314 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20315 if (EQ (prop
, Qleft_margin
))
20316 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20317 if (EQ (prop
, Qright_margin
))
20318 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20319 if (EQ (prop
, Qscroll_bar
))
20320 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20323 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20326 if (INTEGERP (prop
) || FLOATP (prop
))
20328 int base_unit
= (width_p
20329 ? FRAME_COLUMN_WIDTH (it
->f
)
20330 : FRAME_LINE_HEIGHT (it
->f
));
20331 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20336 Lisp_Object car
= XCAR (prop
);
20337 Lisp_Object cdr
= XCDR (prop
);
20341 #ifdef HAVE_WINDOW_SYSTEM
20342 if (FRAME_WINDOW_P (it
->f
)
20343 && valid_image_p (prop
))
20345 int id
= lookup_image (it
->f
, prop
);
20346 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20348 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20351 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20357 while (CONSP (cdr
))
20359 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20360 font
, width_p
, align_to
))
20363 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20368 if (EQ (car
, Qminus
))
20370 return OK_PIXELS (pixels
);
20373 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20376 if (INTEGERP (car
) || FLOATP (car
))
20379 pixels
= XFLOATINT (car
);
20381 return OK_PIXELS (pixels
);
20382 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20383 font
, width_p
, align_to
))
20384 return OK_PIXELS (pixels
* fact
);
20395 /***********************************************************************
20397 ***********************************************************************/
20399 #ifdef HAVE_WINDOW_SYSTEM
20404 dump_glyph_string (s
)
20405 struct glyph_string
*s
;
20407 fprintf (stderr
, "glyph string\n");
20408 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20409 s
->x
, s
->y
, s
->width
, s
->height
);
20410 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20411 fprintf (stderr
, " hl = %d\n", s
->hl
);
20412 fprintf (stderr
, " left overhang = %d, right = %d\n",
20413 s
->left_overhang
, s
->right_overhang
);
20414 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20415 fprintf (stderr
, " extends to end of line = %d\n",
20416 s
->extends_to_end_of_line_p
);
20417 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20418 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20421 #endif /* GLYPH_DEBUG */
20423 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20424 of XChar2b structures for S; it can't be allocated in
20425 init_glyph_string because it must be allocated via `alloca'. W
20426 is the window on which S is drawn. ROW and AREA are the glyph row
20427 and area within the row from which S is constructed. START is the
20428 index of the first glyph structure covered by S. HL is a
20429 face-override for drawing S. */
20432 #define OPTIONAL_HDC(hdc) hdc,
20433 #define DECLARE_HDC(hdc) HDC hdc;
20434 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20435 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20438 #ifndef OPTIONAL_HDC
20439 #define OPTIONAL_HDC(hdc)
20440 #define DECLARE_HDC(hdc)
20441 #define ALLOCATE_HDC(hdc, f)
20442 #define RELEASE_HDC(hdc, f)
20446 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
20447 struct glyph_string
*s
;
20451 struct glyph_row
*row
;
20452 enum glyph_row_area area
;
20454 enum draw_glyphs_face hl
;
20456 bzero (s
, sizeof *s
);
20458 s
->f
= XFRAME (w
->frame
);
20462 s
->display
= FRAME_X_DISPLAY (s
->f
);
20463 s
->window
= FRAME_X_WINDOW (s
->f
);
20464 s
->char2b
= char2b
;
20468 s
->first_glyph
= row
->glyphs
[area
] + start
;
20469 s
->height
= row
->height
;
20470 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20471 s
->ybase
= s
->y
+ row
->ascent
;
20475 /* Append the list of glyph strings with head H and tail T to the list
20476 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20479 append_glyph_string_lists (head
, tail
, h
, t
)
20480 struct glyph_string
**head
, **tail
;
20481 struct glyph_string
*h
, *t
;
20495 /* Prepend the list of glyph strings with head H and tail T to the
20496 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20500 prepend_glyph_string_lists (head
, tail
, h
, t
)
20501 struct glyph_string
**head
, **tail
;
20502 struct glyph_string
*h
, *t
;
20516 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20517 Set *HEAD and *TAIL to the resulting list. */
20520 append_glyph_string (head
, tail
, s
)
20521 struct glyph_string
**head
, **tail
;
20522 struct glyph_string
*s
;
20524 s
->next
= s
->prev
= NULL
;
20525 append_glyph_string_lists (head
, tail
, s
, s
);
20529 /* Get face and two-byte form of character C in face FACE_ID on frame
20530 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20531 means we want to display multibyte text. DISPLAY_P non-zero means
20532 make sure that X resources for the face returned are allocated.
20533 Value is a pointer to a realized face that is ready for display if
20534 DISPLAY_P is non-zero. */
20536 static INLINE
struct face
*
20537 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
20541 int multibyte_p
, display_p
;
20543 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20547 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20549 if (code
!= FONT_INVALID_CODE
)
20550 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20552 STORE_XCHAR2B (char2b
, 0, 0);
20555 /* Make sure X resources of the face are allocated. */
20556 #ifdef HAVE_X_WINDOWS
20560 xassert (face
!= NULL
);
20561 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20568 /* Get face and two-byte form of character glyph GLYPH on frame F.
20569 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20570 a pointer to a realized face that is ready for display. */
20572 static INLINE
struct face
*
20573 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
20575 struct glyph
*glyph
;
20581 xassert (glyph
->type
== CHAR_GLYPH
);
20582 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20589 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20591 if (code
!= FONT_INVALID_CODE
)
20592 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20594 STORE_XCHAR2B (char2b
, 0, 0);
20597 /* Make sure X resources of the face are allocated. */
20598 xassert (face
!= NULL
);
20599 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20604 /* Fill glyph string S with composition components specified by S->cmp.
20606 BASE_FACE is the base face of the composition.
20607 S->cmp_from is the index of the first component for S.
20609 OVERLAPS non-zero means S should draw the foreground only, and use
20610 its physical height for clipping. See also draw_glyphs.
20612 Value is the index of a component not in S. */
20615 fill_composite_glyph_string (s
, base_face
, overlaps
)
20616 struct glyph_string
*s
;
20617 struct face
*base_face
;
20621 /* For all glyphs of this composition, starting at the offset
20622 S->cmp_from, until we reach the end of the definition or encounter a
20623 glyph that requires the different face, add it to S. */
20628 s
->for_overlaps
= overlaps
;
20631 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20633 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20637 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20640 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20641 s
->char2b
+ i
, 1, 1);
20647 s
->font
= s
->face
->font
;
20649 else if (s
->face
!= face
)
20657 /* All glyph strings for the same composition has the same width,
20658 i.e. the width set for the first component of the composition. */
20659 s
->width
= s
->first_glyph
->pixel_width
;
20661 /* If the specified font could not be loaded, use the frame's
20662 default font, but record the fact that we couldn't load it in
20663 the glyph string so that we can draw rectangles for the
20664 characters of the glyph string. */
20665 if (s
->font
== NULL
)
20667 s
->font_not_found_p
= 1;
20668 s
->font
= FRAME_FONT (s
->f
);
20671 /* Adjust base line for subscript/superscript text. */
20672 s
->ybase
+= s
->first_glyph
->voffset
;
20674 /* This glyph string must always be drawn with 16-bit functions. */
20681 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
20682 struct glyph_string
*s
;
20684 int start
, end
, overlaps
;
20686 struct glyph
*glyph
, *last
;
20687 Lisp_Object lgstring
;
20690 s
->for_overlaps
= overlaps
;
20691 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20692 last
= s
->row
->glyphs
[s
->area
] + end
;
20693 s
->cmp_id
= glyph
->u
.cmp
.id
;
20694 s
->cmp_from
= glyph
->u
.cmp
.from
;
20695 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20696 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20697 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20698 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20700 while (glyph
< last
20701 && glyph
->u
.cmp
.automatic
20702 && glyph
->u
.cmp
.id
== s
->cmp_id
20703 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20704 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20706 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20708 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20709 unsigned code
= LGLYPH_CODE (lglyph
);
20711 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20713 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20714 return glyph
- s
->row
->glyphs
[s
->area
];
20718 /* Fill glyph string S from a sequence of character glyphs.
20720 FACE_ID is the face id of the string. START is the index of the
20721 first glyph to consider, END is the index of the last + 1.
20722 OVERLAPS non-zero means S should draw the foreground only, and use
20723 its physical height for clipping. See also draw_glyphs.
20725 Value is the index of the first glyph not in S. */
20728 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
20729 struct glyph_string
*s
;
20731 int start
, end
, overlaps
;
20733 struct glyph
*glyph
, *last
;
20735 int glyph_not_available_p
;
20737 xassert (s
->f
== XFRAME (s
->w
->frame
));
20738 xassert (s
->nchars
== 0);
20739 xassert (start
>= 0 && end
> start
);
20741 s
->for_overlaps
= overlaps
;
20742 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20743 last
= s
->row
->glyphs
[s
->area
] + end
;
20744 voffset
= glyph
->voffset
;
20745 s
->padding_p
= glyph
->padding_p
;
20746 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20748 while (glyph
< last
20749 && glyph
->type
== CHAR_GLYPH
20750 && glyph
->voffset
== voffset
20751 /* Same face id implies same font, nowadays. */
20752 && glyph
->face_id
== face_id
20753 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20757 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20758 s
->char2b
+ s
->nchars
,
20760 s
->two_byte_p
= two_byte_p
;
20762 xassert (s
->nchars
<= end
- start
);
20763 s
->width
+= glyph
->pixel_width
;
20764 if (glyph
++->padding_p
!= s
->padding_p
)
20768 s
->font
= s
->face
->font
;
20770 /* If the specified font could not be loaded, use the frame's font,
20771 but record the fact that we couldn't load it in
20772 S->font_not_found_p so that we can draw rectangles for the
20773 characters of the glyph string. */
20774 if (s
->font
== NULL
|| glyph_not_available_p
)
20776 s
->font_not_found_p
= 1;
20777 s
->font
= FRAME_FONT (s
->f
);
20780 /* Adjust base line for subscript/superscript text. */
20781 s
->ybase
+= voffset
;
20783 xassert (s
->face
&& s
->face
->gc
);
20784 return glyph
- s
->row
->glyphs
[s
->area
];
20788 /* Fill glyph string S from image glyph S->first_glyph. */
20791 fill_image_glyph_string (s
)
20792 struct glyph_string
*s
;
20794 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20795 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20797 s
->slice
= s
->first_glyph
->slice
;
20798 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20799 s
->font
= s
->face
->font
;
20800 s
->width
= s
->first_glyph
->pixel_width
;
20802 /* Adjust base line for subscript/superscript text. */
20803 s
->ybase
+= s
->first_glyph
->voffset
;
20807 /* Fill glyph string S from a sequence of stretch glyphs.
20809 ROW is the glyph row in which the glyphs are found, AREA is the
20810 area within the row. START is the index of the first glyph to
20811 consider, END is the index of the last + 1.
20813 Value is the index of the first glyph not in S. */
20816 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
20817 struct glyph_string
*s
;
20818 struct glyph_row
*row
;
20819 enum glyph_row_area area
;
20822 struct glyph
*glyph
, *last
;
20823 int voffset
, face_id
;
20825 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20827 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20828 last
= s
->row
->glyphs
[s
->area
] + end
;
20829 face_id
= glyph
->face_id
;
20830 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20831 s
->font
= s
->face
->font
;
20832 s
->width
= glyph
->pixel_width
;
20834 voffset
= glyph
->voffset
;
20838 && glyph
->type
== STRETCH_GLYPH
20839 && glyph
->voffset
== voffset
20840 && glyph
->face_id
== face_id
);
20842 s
->width
+= glyph
->pixel_width
;
20844 /* Adjust base line for subscript/superscript text. */
20845 s
->ybase
+= voffset
;
20847 /* The case that face->gc == 0 is handled when drawing the glyph
20848 string by calling PREPARE_FACE_FOR_DISPLAY. */
20850 return glyph
- s
->row
->glyphs
[s
->area
];
20853 static struct font_metrics
*
20854 get_per_char_metric (f
, font
, char2b
)
20859 static struct font_metrics metrics
;
20860 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20862 if (! font
|| code
== FONT_INVALID_CODE
)
20864 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20869 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20870 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20871 assumed to be zero. */
20874 x_get_glyph_overhangs (glyph
, f
, left
, right
)
20875 struct glyph
*glyph
;
20879 *left
= *right
= 0;
20881 if (glyph
->type
== CHAR_GLYPH
)
20885 struct font_metrics
*pcm
;
20887 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20888 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20890 if (pcm
->rbearing
> pcm
->width
)
20891 *right
= pcm
->rbearing
- pcm
->width
;
20892 if (pcm
->lbearing
< 0)
20893 *left
= -pcm
->lbearing
;
20896 else if (glyph
->type
== COMPOSITE_GLYPH
)
20898 if (! glyph
->u
.cmp
.automatic
)
20900 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20902 if (cmp
->rbearing
> cmp
->pixel_width
)
20903 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20904 if (cmp
->lbearing
< 0)
20905 *left
= - cmp
->lbearing
;
20909 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20910 struct font_metrics metrics
;
20912 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20913 glyph
->u
.cmp
.to
+ 1, &metrics
);
20914 if (metrics
.rbearing
> metrics
.width
)
20915 *right
= metrics
.rbearing
- metrics
.width
;
20916 if (metrics
.lbearing
< 0)
20917 *left
= - metrics
.lbearing
;
20923 /* Return the index of the first glyph preceding glyph string S that
20924 is overwritten by S because of S's left overhang. Value is -1
20925 if no glyphs are overwritten. */
20928 left_overwritten (s
)
20929 struct glyph_string
*s
;
20933 if (s
->left_overhang
)
20936 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20937 int first
= s
->first_glyph
- glyphs
;
20939 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20940 x
-= glyphs
[i
].pixel_width
;
20951 /* Return the index of the first glyph preceding glyph string S that
20952 is overwriting S because of its right overhang. Value is -1 if no
20953 glyph in front of S overwrites S. */
20956 left_overwriting (s
)
20957 struct glyph_string
*s
;
20960 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20961 int first
= s
->first_glyph
- glyphs
;
20965 for (i
= first
- 1; i
>= 0; --i
)
20968 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20971 x
-= glyphs
[i
].pixel_width
;
20978 /* Return the index of the last glyph following glyph string S that is
20979 overwritten by S because of S's right overhang. Value is -1 if
20980 no such glyph is found. */
20983 right_overwritten (s
)
20984 struct glyph_string
*s
;
20988 if (s
->right_overhang
)
20991 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20992 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20993 int end
= s
->row
->used
[s
->area
];
20995 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20996 x
+= glyphs
[i
].pixel_width
;
21005 /* Return the index of the last glyph following glyph string S that
21006 overwrites S because of its left overhang. Value is negative
21007 if no such glyph is found. */
21010 right_overwriting (s
)
21011 struct glyph_string
*s
;
21014 int end
= s
->row
->used
[s
->area
];
21015 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21016 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21020 for (i
= first
; i
< end
; ++i
)
21023 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21026 x
+= glyphs
[i
].pixel_width
;
21033 /* Set background width of glyph string S. START is the index of the
21034 first glyph following S. LAST_X is the right-most x-position + 1
21035 in the drawing area. */
21038 set_glyph_string_background_width (s
, start
, last_x
)
21039 struct glyph_string
*s
;
21043 /* If the face of this glyph string has to be drawn to the end of
21044 the drawing area, set S->extends_to_end_of_line_p. */
21046 if (start
== s
->row
->used
[s
->area
]
21047 && s
->area
== TEXT_AREA
21048 && ((s
->row
->fill_line_p
21049 && (s
->hl
== DRAW_NORMAL_TEXT
21050 || s
->hl
== DRAW_IMAGE_RAISED
21051 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21052 || s
->hl
== DRAW_MOUSE_FACE
))
21053 s
->extends_to_end_of_line_p
= 1;
21055 /* If S extends its face to the end of the line, set its
21056 background_width to the distance to the right edge of the drawing
21058 if (s
->extends_to_end_of_line_p
)
21059 s
->background_width
= last_x
- s
->x
+ 1;
21061 s
->background_width
= s
->width
;
21065 /* Compute overhangs and x-positions for glyph string S and its
21066 predecessors, or successors. X is the starting x-position for S.
21067 BACKWARD_P non-zero means process predecessors. */
21070 compute_overhangs_and_x (s
, x
, backward_p
)
21071 struct glyph_string
*s
;
21079 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21080 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21090 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21091 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21101 /* The following macros are only called from draw_glyphs below.
21102 They reference the following parameters of that function directly:
21103 `w', `row', `area', and `overlap_p'
21104 as well as the following local variables:
21105 `s', `f', and `hdc' (in W32) */
21108 /* On W32, silently add local `hdc' variable to argument list of
21109 init_glyph_string. */
21110 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21111 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21113 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21114 init_glyph_string (s, char2b, w, row, area, start, hl)
21117 /* Add a glyph string for a stretch glyph to the list of strings
21118 between HEAD and TAIL. START is the index of the stretch glyph in
21119 row area AREA of glyph row ROW. END is the index of the last glyph
21120 in that glyph row area. X is the current output position assigned
21121 to the new glyph string constructed. HL overrides that face of the
21122 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21123 is the right-most x-position of the drawing area. */
21125 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21126 and below -- keep them on one line. */
21127 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21130 s = (struct glyph_string *) alloca (sizeof *s); \
21131 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21132 START = fill_stretch_glyph_string (s, row, area, START, END); \
21133 append_glyph_string (&HEAD, &TAIL, s); \
21139 /* Add a glyph string for an image glyph to the list of strings
21140 between HEAD and TAIL. START is the index of the image glyph in
21141 row area AREA of glyph row ROW. END is the index of the last glyph
21142 in that glyph row area. X is the current output position assigned
21143 to the new glyph string constructed. HL overrides that face of the
21144 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21145 is the right-most x-position of the drawing area. */
21147 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21150 s = (struct glyph_string *) alloca (sizeof *s); \
21151 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21152 fill_image_glyph_string (s); \
21153 append_glyph_string (&HEAD, &TAIL, s); \
21160 /* Add a glyph string for a sequence of character glyphs to the list
21161 of strings between HEAD and TAIL. START is the index of the first
21162 glyph in row area AREA of glyph row ROW that is part of the new
21163 glyph string. END is the index of the last glyph in that glyph row
21164 area. X is the current output position assigned to the new glyph
21165 string constructed. HL overrides that face of the glyph; e.g. it
21166 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21167 right-most x-position of the drawing area. */
21169 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21175 face_id = (row)->glyphs[area][START].face_id; \
21177 s = (struct glyph_string *) alloca (sizeof *s); \
21178 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21179 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21180 append_glyph_string (&HEAD, &TAIL, s); \
21182 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21187 /* Add a glyph string for a composite sequence to the list of strings
21188 between HEAD and TAIL. START is the index of the first glyph in
21189 row area AREA of glyph row ROW that is part of the new glyph
21190 string. END is the index of the last glyph in that glyph row area.
21191 X is the current output position assigned to the new glyph string
21192 constructed. HL overrides that face of the glyph; e.g. it is
21193 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21194 x-position of the drawing area. */
21196 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21198 int face_id = (row)->glyphs[area][START].face_id; \
21199 struct face *base_face = FACE_FROM_ID (f, face_id); \
21200 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21201 struct composition *cmp = composition_table[cmp_id]; \
21203 struct glyph_string *first_s; \
21206 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21208 /* Make glyph_strings for each glyph sequence that is drawable by \
21209 the same face, and append them to HEAD/TAIL. */ \
21210 for (n = 0; n < cmp->glyph_len;) \
21212 s = (struct glyph_string *) alloca (sizeof *s); \
21213 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21214 append_glyph_string (&(HEAD), &(TAIL), s); \
21220 n = fill_composite_glyph_string (s, base_face, overlaps); \
21228 /* Add a glyph string for a glyph-string sequence to the list of strings
21229 between HEAD and TAIL. */
21231 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21235 Lisp_Object gstring; \
21237 face_id = (row)->glyphs[area][START].face_id; \
21238 gstring = (composition_gstring_from_id \
21239 ((row)->glyphs[area][START].u.cmp.id)); \
21240 s = (struct glyph_string *) alloca (sizeof *s); \
21241 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21242 * LGSTRING_GLYPH_LEN (gstring)); \
21243 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21244 append_glyph_string (&(HEAD), &(TAIL), s); \
21246 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21250 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21251 of AREA of glyph row ROW on window W between indices START and END.
21252 HL overrides the face for drawing glyph strings, e.g. it is
21253 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21254 x-positions of the drawing area.
21256 This is an ugly monster macro construct because we must use alloca
21257 to allocate glyph strings (because draw_glyphs can be called
21258 asynchronously). */
21260 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21263 HEAD = TAIL = NULL; \
21264 while (START < END) \
21266 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21267 switch (first_glyph->type) \
21270 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21274 case COMPOSITE_GLYPH: \
21275 if (first_glyph->u.cmp.automatic) \
21276 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21279 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21283 case STRETCH_GLYPH: \
21284 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21288 case IMAGE_GLYPH: \
21289 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21299 set_glyph_string_background_width (s, START, LAST_X); \
21306 /* Draw glyphs between START and END in AREA of ROW on window W,
21307 starting at x-position X. X is relative to AREA in W. HL is a
21308 face-override with the following meaning:
21310 DRAW_NORMAL_TEXT draw normally
21311 DRAW_CURSOR draw in cursor face
21312 DRAW_MOUSE_FACE draw in mouse face.
21313 DRAW_INVERSE_VIDEO draw in mode line face
21314 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21315 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21317 If OVERLAPS is non-zero, draw only the foreground of characters and
21318 clip to the physical height of ROW. Non-zero value also defines
21319 the overlapping part to be drawn:
21321 OVERLAPS_PRED overlap with preceding rows
21322 OVERLAPS_SUCC overlap with succeeding rows
21323 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21324 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21326 Value is the x-position reached, relative to AREA of W. */
21329 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
21332 struct glyph_row
*row
;
21333 enum glyph_row_area area
;
21334 EMACS_INT start
, end
;
21335 enum draw_glyphs_face hl
;
21338 struct glyph_string
*head
, *tail
;
21339 struct glyph_string
*s
;
21340 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21341 int i
, j
, x_reached
, last_x
, area_left
= 0;
21342 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21345 ALLOCATE_HDC (hdc
, f
);
21347 /* Let's rather be paranoid than getting a SEGV. */
21348 end
= min (end
, row
->used
[area
]);
21349 start
= max (0, start
);
21350 start
= min (end
, start
);
21352 /* Translate X to frame coordinates. Set last_x to the right
21353 end of the drawing area. */
21354 if (row
->full_width_p
)
21356 /* X is relative to the left edge of W, without scroll bars
21358 area_left
= WINDOW_LEFT_EDGE_X (w
);
21359 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21363 area_left
= window_box_left (w
, area
);
21364 last_x
= area_left
+ window_box_width (w
, area
);
21368 /* Build a doubly-linked list of glyph_string structures between
21369 head and tail from what we have to draw. Note that the macro
21370 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21371 the reason we use a separate variable `i'. */
21373 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21375 x_reached
= tail
->x
+ tail
->background_width
;
21379 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21380 the row, redraw some glyphs in front or following the glyph
21381 strings built above. */
21382 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21384 struct glyph_string
*h
, *t
;
21385 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21386 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21389 /* If mouse highlighting is on, we may need to draw adjacent
21390 glyphs using mouse-face highlighting. */
21391 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21393 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21395 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21396 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21398 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21400 check_mouse_face
= 1;
21401 mouse_beg_col
= (row
== mouse_beg_row
)
21402 ? dpyinfo
->mouse_face_beg_col
: 0;
21403 mouse_end_col
= (row
== mouse_end_row
)
21404 ? dpyinfo
->mouse_face_end_col
21405 : row
->used
[TEXT_AREA
];
21409 /* Compute overhangs for all glyph strings. */
21410 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21411 for (s
= head
; s
; s
= s
->next
)
21412 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21414 /* Prepend glyph strings for glyphs in front of the first glyph
21415 string that are overwritten because of the first glyph
21416 string's left overhang. The background of all strings
21417 prepended must be drawn because the first glyph string
21419 i
= left_overwritten (head
);
21422 enum draw_glyphs_face overlap_hl
;
21424 /* If this row contains mouse highlighting, attempt to draw
21425 the overlapped glyphs with the correct highlight. This
21426 code fails if the overlap encompasses more than one glyph
21427 and mouse-highlight spans only some of these glyphs.
21428 However, making it work perfectly involves a lot more
21429 code, and I don't know if the pathological case occurs in
21430 practice, so we'll stick to this for now. --- cyd */
21431 if (check_mouse_face
21432 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21433 overlap_hl
= DRAW_MOUSE_FACE
;
21435 overlap_hl
= DRAW_NORMAL_TEXT
;
21438 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21439 overlap_hl
, dummy_x
, last_x
);
21441 compute_overhangs_and_x (t
, head
->x
, 1);
21442 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21446 /* Prepend glyph strings for glyphs in front of the first glyph
21447 string that overwrite that glyph string because of their
21448 right overhang. For these strings, only the foreground must
21449 be drawn, because it draws over the glyph string at `head'.
21450 The background must not be drawn because this would overwrite
21451 right overhangs of preceding glyphs for which no glyph
21453 i
= left_overwriting (head
);
21456 enum draw_glyphs_face overlap_hl
;
21458 if (check_mouse_face
21459 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21460 overlap_hl
= DRAW_MOUSE_FACE
;
21462 overlap_hl
= DRAW_NORMAL_TEXT
;
21465 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21466 overlap_hl
, dummy_x
, last_x
);
21467 for (s
= h
; s
; s
= s
->next
)
21468 s
->background_filled_p
= 1;
21469 compute_overhangs_and_x (t
, head
->x
, 1);
21470 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21473 /* Append glyphs strings for glyphs following the last glyph
21474 string tail that are overwritten by tail. The background of
21475 these strings has to be drawn because tail's foreground draws
21477 i
= right_overwritten (tail
);
21480 enum draw_glyphs_face overlap_hl
;
21482 if (check_mouse_face
21483 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21484 overlap_hl
= DRAW_MOUSE_FACE
;
21486 overlap_hl
= DRAW_NORMAL_TEXT
;
21488 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21489 overlap_hl
, x
, last_x
);
21490 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21491 we don't have `end = i;' here. */
21492 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21493 append_glyph_string_lists (&head
, &tail
, h
, t
);
21497 /* Append glyph strings for glyphs following the last glyph
21498 string tail that overwrite tail. The foreground of such
21499 glyphs has to be drawn because it writes into the background
21500 of tail. The background must not be drawn because it could
21501 paint over the foreground of following glyphs. */
21502 i
= right_overwriting (tail
);
21505 enum draw_glyphs_face overlap_hl
;
21506 if (check_mouse_face
21507 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21508 overlap_hl
= DRAW_MOUSE_FACE
;
21510 overlap_hl
= DRAW_NORMAL_TEXT
;
21513 i
++; /* We must include the Ith glyph. */
21514 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21515 overlap_hl
, x
, last_x
);
21516 for (s
= h
; s
; s
= s
->next
)
21517 s
->background_filled_p
= 1;
21518 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21519 append_glyph_string_lists (&head
, &tail
, h
, t
);
21521 if (clip_head
|| clip_tail
)
21522 for (s
= head
; s
; s
= s
->next
)
21524 s
->clip_head
= clip_head
;
21525 s
->clip_tail
= clip_tail
;
21529 /* Draw all strings. */
21530 for (s
= head
; s
; s
= s
->next
)
21531 FRAME_RIF (f
)->draw_glyph_string (s
);
21534 /* When focus a sole frame and move horizontally, this sets on_p to 0
21535 causing a failure to erase prev cursor position. */
21536 if (area
== TEXT_AREA
21537 && !row
->full_width_p
21538 /* When drawing overlapping rows, only the glyph strings'
21539 foreground is drawn, which doesn't erase a cursor
21543 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21544 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21545 : (tail
? tail
->x
+ tail
->background_width
: x
));
21549 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21550 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21554 /* Value is the x-position up to which drawn, relative to AREA of W.
21555 This doesn't include parts drawn because of overhangs. */
21556 if (row
->full_width_p
)
21557 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21559 x_reached
-= area_left
;
21561 RELEASE_HDC (hdc
, f
);
21566 /* Expand row matrix if too narrow. Don't expand if area
21569 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21571 if (!fonts_changed_p \
21572 && (it->glyph_row->glyphs[area] \
21573 < it->glyph_row->glyphs[area + 1])) \
21575 it->w->ncols_scale_factor++; \
21576 fonts_changed_p = 1; \
21580 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21581 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21587 struct glyph
*glyph
;
21588 enum glyph_row_area area
= it
->area
;
21590 xassert (it
->glyph_row
);
21591 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21593 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21594 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21596 /* If the glyph row is reversed, we need to prepend the glyph
21597 rather than append it. */
21598 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21602 /* Make room for the additional glyph. */
21603 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21605 glyph
= it
->glyph_row
->glyphs
[area
];
21607 glyph
->charpos
= CHARPOS (it
->position
);
21608 glyph
->object
= it
->object
;
21609 if (it
->pixel_width
> 0)
21611 glyph
->pixel_width
= it
->pixel_width
;
21612 glyph
->padding_p
= 0;
21616 /* Assure at least 1-pixel width. Otherwise, cursor can't
21617 be displayed correctly. */
21618 glyph
->pixel_width
= 1;
21619 glyph
->padding_p
= 1;
21621 glyph
->ascent
= it
->ascent
;
21622 glyph
->descent
= it
->descent
;
21623 glyph
->voffset
= it
->voffset
;
21624 glyph
->type
= CHAR_GLYPH
;
21625 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21626 glyph
->multibyte_p
= it
->multibyte_p
;
21627 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21628 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21629 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21630 || it
->phys_descent
> it
->descent
);
21631 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21632 glyph
->face_id
= it
->face_id
;
21633 glyph
->u
.ch
= it
->char_to_display
;
21634 glyph
->slice
= null_glyph_slice
;
21635 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21638 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21639 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21641 glyph
->bidi_type
= it
->bidi_it
.type
;
21645 glyph
->resolved_level
= 0;
21646 glyph
->bidi_type
= UNKNOWN_BT
;
21648 ++it
->glyph_row
->used
[area
];
21651 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21654 /* Store one glyph for the composition IT->cmp_it.id in
21655 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21659 append_composite_glyph (it
)
21662 struct glyph
*glyph
;
21663 enum glyph_row_area area
= it
->area
;
21665 xassert (it
->glyph_row
);
21667 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21668 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21670 /* If the glyph row is reversed, we need to prepend the glyph
21671 rather than append it. */
21672 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21676 /* Make room for the new glyph. */
21677 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21679 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21681 glyph
->charpos
= CHARPOS (it
->position
);
21682 glyph
->object
= it
->object
;
21683 glyph
->pixel_width
= it
->pixel_width
;
21684 glyph
->ascent
= it
->ascent
;
21685 glyph
->descent
= it
->descent
;
21686 glyph
->voffset
= it
->voffset
;
21687 glyph
->type
= COMPOSITE_GLYPH
;
21688 if (it
->cmp_it
.ch
< 0)
21690 glyph
->u
.cmp
.automatic
= 0;
21691 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21695 glyph
->u
.cmp
.automatic
= 1;
21696 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21697 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21698 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21700 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21701 glyph
->multibyte_p
= it
->multibyte_p
;
21702 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21703 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21704 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21705 || it
->phys_descent
> it
->descent
);
21706 glyph
->padding_p
= 0;
21707 glyph
->glyph_not_available_p
= 0;
21708 glyph
->face_id
= it
->face_id
;
21709 glyph
->slice
= null_glyph_slice
;
21710 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21713 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21714 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21716 glyph
->bidi_type
= it
->bidi_it
.type
;
21718 ++it
->glyph_row
->used
[area
];
21721 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21725 /* Change IT->ascent and IT->height according to the setting of
21729 take_vertical_position_into_account (it
)
21734 if (it
->voffset
< 0)
21735 /* Increase the ascent so that we can display the text higher
21737 it
->ascent
-= it
->voffset
;
21739 /* Increase the descent so that we can display the text lower
21741 it
->descent
+= it
->voffset
;
21746 /* Produce glyphs/get display metrics for the image IT is loaded with.
21747 See the description of struct display_iterator in dispextern.h for
21748 an overview of struct display_iterator. */
21751 produce_image_glyph (it
)
21756 int glyph_ascent
, crop
;
21757 struct glyph_slice slice
;
21759 xassert (it
->what
== IT_IMAGE
);
21761 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21763 /* Make sure X resources of the face is loaded. */
21764 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21766 if (it
->image_id
< 0)
21768 /* Fringe bitmap. */
21769 it
->ascent
= it
->phys_ascent
= 0;
21770 it
->descent
= it
->phys_descent
= 0;
21771 it
->pixel_width
= 0;
21776 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21778 /* Make sure X resources of the image is loaded. */
21779 prepare_image_for_display (it
->f
, img
);
21781 slice
.x
= slice
.y
= 0;
21782 slice
.width
= img
->width
;
21783 slice
.height
= img
->height
;
21785 if (INTEGERP (it
->slice
.x
))
21786 slice
.x
= XINT (it
->slice
.x
);
21787 else if (FLOATP (it
->slice
.x
))
21788 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21790 if (INTEGERP (it
->slice
.y
))
21791 slice
.y
= XINT (it
->slice
.y
);
21792 else if (FLOATP (it
->slice
.y
))
21793 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21795 if (INTEGERP (it
->slice
.width
))
21796 slice
.width
= XINT (it
->slice
.width
);
21797 else if (FLOATP (it
->slice
.width
))
21798 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21800 if (INTEGERP (it
->slice
.height
))
21801 slice
.height
= XINT (it
->slice
.height
);
21802 else if (FLOATP (it
->slice
.height
))
21803 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21805 if (slice
.x
>= img
->width
)
21806 slice
.x
= img
->width
;
21807 if (slice
.y
>= img
->height
)
21808 slice
.y
= img
->height
;
21809 if (slice
.x
+ slice
.width
>= img
->width
)
21810 slice
.width
= img
->width
- slice
.x
;
21811 if (slice
.y
+ slice
.height
> img
->height
)
21812 slice
.height
= img
->height
- slice
.y
;
21814 if (slice
.width
== 0 || slice
.height
== 0)
21817 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21819 it
->descent
= slice
.height
- glyph_ascent
;
21821 it
->descent
+= img
->vmargin
;
21822 if (slice
.y
+ slice
.height
== img
->height
)
21823 it
->descent
+= img
->vmargin
;
21824 it
->phys_descent
= it
->descent
;
21826 it
->pixel_width
= slice
.width
;
21828 it
->pixel_width
+= img
->hmargin
;
21829 if (slice
.x
+ slice
.width
== img
->width
)
21830 it
->pixel_width
+= img
->hmargin
;
21832 /* It's quite possible for images to have an ascent greater than
21833 their height, so don't get confused in that case. */
21834 if (it
->descent
< 0)
21839 if (face
->box
!= FACE_NO_BOX
)
21841 if (face
->box_line_width
> 0)
21844 it
->ascent
+= face
->box_line_width
;
21845 if (slice
.y
+ slice
.height
== img
->height
)
21846 it
->descent
+= face
->box_line_width
;
21849 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21850 it
->pixel_width
+= eabs (face
->box_line_width
);
21851 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21852 it
->pixel_width
+= eabs (face
->box_line_width
);
21855 take_vertical_position_into_account (it
);
21857 /* Automatically crop wide image glyphs at right edge so we can
21858 draw the cursor on same display row. */
21859 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21860 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21862 it
->pixel_width
-= crop
;
21863 slice
.width
-= crop
;
21868 struct glyph
*glyph
;
21869 enum glyph_row_area area
= it
->area
;
21871 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21872 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21874 glyph
->charpos
= CHARPOS (it
->position
);
21875 glyph
->object
= it
->object
;
21876 glyph
->pixel_width
= it
->pixel_width
;
21877 glyph
->ascent
= glyph_ascent
;
21878 glyph
->descent
= it
->descent
;
21879 glyph
->voffset
= it
->voffset
;
21880 glyph
->type
= IMAGE_GLYPH
;
21881 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21882 glyph
->multibyte_p
= it
->multibyte_p
;
21883 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21884 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21885 glyph
->overlaps_vertically_p
= 0;
21886 glyph
->padding_p
= 0;
21887 glyph
->glyph_not_available_p
= 0;
21888 glyph
->face_id
= it
->face_id
;
21889 glyph
->u
.img_id
= img
->id
;
21890 glyph
->slice
= slice
;
21891 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21894 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21895 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21897 glyph
->bidi_type
= it
->bidi_it
.type
;
21899 ++it
->glyph_row
->used
[area
];
21902 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21907 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21908 of the glyph, WIDTH and HEIGHT are the width and height of the
21909 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21912 append_stretch_glyph (it
, object
, width
, height
, ascent
)
21914 Lisp_Object object
;
21918 struct glyph
*glyph
;
21919 enum glyph_row_area area
= it
->area
;
21921 xassert (ascent
>= 0 && ascent
<= height
);
21923 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21924 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21926 /* If the glyph row is reversed, we need to prepend the glyph
21927 rather than append it. */
21928 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21932 /* Make room for the additional glyph. */
21933 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21935 glyph
= it
->glyph_row
->glyphs
[area
];
21937 glyph
->charpos
= CHARPOS (it
->position
);
21938 glyph
->object
= object
;
21939 glyph
->pixel_width
= width
;
21940 glyph
->ascent
= ascent
;
21941 glyph
->descent
= height
- ascent
;
21942 glyph
->voffset
= it
->voffset
;
21943 glyph
->type
= STRETCH_GLYPH
;
21944 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21945 glyph
->multibyte_p
= it
->multibyte_p
;
21946 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21947 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21948 glyph
->overlaps_vertically_p
= 0;
21949 glyph
->padding_p
= 0;
21950 glyph
->glyph_not_available_p
= 0;
21951 glyph
->face_id
= it
->face_id
;
21952 glyph
->u
.stretch
.ascent
= ascent
;
21953 glyph
->u
.stretch
.height
= height
;
21954 glyph
->slice
= null_glyph_slice
;
21955 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21958 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21959 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21961 glyph
->bidi_type
= it
->bidi_it
.type
;
21965 glyph
->resolved_level
= 0;
21966 glyph
->bidi_type
= UNKNOWN_BT
;
21968 ++it
->glyph_row
->used
[area
];
21971 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21975 /* Produce a stretch glyph for iterator IT. IT->object is the value
21976 of the glyph property displayed. The value must be a list
21977 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21980 1. `:width WIDTH' specifies that the space should be WIDTH *
21981 canonical char width wide. WIDTH may be an integer or floating
21984 2. `:relative-width FACTOR' specifies that the width of the stretch
21985 should be computed from the width of the first character having the
21986 `glyph' property, and should be FACTOR times that width.
21988 3. `:align-to HPOS' specifies that the space should be wide enough
21989 to reach HPOS, a value in canonical character units.
21991 Exactly one of the above pairs must be present.
21993 4. `:height HEIGHT' specifies that the height of the stretch produced
21994 should be HEIGHT, measured in canonical character units.
21996 5. `:relative-height FACTOR' specifies that the height of the
21997 stretch should be FACTOR times the height of the characters having
21998 the glyph property.
22000 Either none or exactly one of 4 or 5 must be present.
22002 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22003 of the stretch should be used for the ascent of the stretch.
22004 ASCENT must be in the range 0 <= ASCENT <= 100. */
22007 produce_stretch_glyph (it
)
22010 /* (space :width WIDTH :height HEIGHT ...) */
22011 Lisp_Object prop
, plist
;
22012 int width
= 0, height
= 0, align_to
= -1;
22013 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22016 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22017 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22019 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22021 /* List should start with `space'. */
22022 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22023 plist
= XCDR (it
->object
);
22025 /* Compute the width of the stretch. */
22026 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22027 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22029 /* Absolute width `:width WIDTH' specified and valid. */
22030 zero_width_ok_p
= 1;
22033 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22036 /* Relative width `:relative-width FACTOR' specified and valid.
22037 Compute the width of the characters having the `glyph'
22040 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22043 if (it
->multibyte_p
)
22045 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
22046 - IT_BYTEPOS (*it
));
22047 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22050 it2
.c
= *p
, it2
.len
= 1;
22052 it2
.glyph_row
= NULL
;
22053 it2
.what
= IT_CHARACTER
;
22054 x_produce_glyphs (&it2
);
22055 width
= NUMVAL (prop
) * it2
.pixel_width
;
22057 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22058 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22060 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22061 align_to
= (align_to
< 0
22063 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22064 else if (align_to
< 0)
22065 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22066 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22067 zero_width_ok_p
= 1;
22070 /* Nothing specified -> width defaults to canonical char width. */
22071 width
= FRAME_COLUMN_WIDTH (it
->f
);
22073 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22076 /* Compute height. */
22077 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22078 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22081 zero_height_ok_p
= 1;
22083 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22085 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22087 height
= FONT_HEIGHT (font
);
22089 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22092 /* Compute percentage of height used for ascent. If
22093 `:ascent ASCENT' is present and valid, use that. Otherwise,
22094 derive the ascent from the font in use. */
22095 if (prop
= Fplist_get (plist
, QCascent
),
22096 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22097 ascent
= height
* NUMVAL (prop
) / 100.0;
22098 else if (!NILP (prop
)
22099 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22100 ascent
= min (max (0, (int)tem
), height
);
22102 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22104 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22105 && it
->current_x
+ width
> it
->last_visible_x
)
22106 width
= it
->last_visible_x
- it
->current_x
- 1;
22108 if (width
> 0 && height
> 0 && it
->glyph_row
)
22110 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22111 if (!STRINGP (object
))
22112 object
= it
->w
->buffer
;
22113 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22116 it
->pixel_width
= width
;
22117 it
->ascent
= it
->phys_ascent
= ascent
;
22118 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22119 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22121 take_vertical_position_into_account (it
);
22124 /* Calculate line-height and line-spacing properties.
22125 An integer value specifies explicit pixel value.
22126 A float value specifies relative value to current face height.
22127 A cons (float . face-name) specifies relative value to
22128 height of specified face font.
22130 Returns height in pixels, or nil. */
22134 calc_line_height_property (it
, val
, font
, boff
, override
)
22138 int boff
, override
;
22140 Lisp_Object face_name
= Qnil
;
22141 int ascent
, descent
, height
;
22143 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22148 face_name
= XCAR (val
);
22150 if (!NUMBERP (val
))
22151 val
= make_number (1);
22152 if (NILP (face_name
))
22154 height
= it
->ascent
+ it
->descent
;
22159 if (NILP (face_name
))
22161 font
= FRAME_FONT (it
->f
);
22162 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22164 else if (EQ (face_name
, Qt
))
22173 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22175 return make_number (-1);
22177 face
= FACE_FROM_ID (it
->f
, face_id
);
22180 return make_number (-1);
22181 boff
= font
->baseline_offset
;
22182 if (font
->vertical_centering
)
22183 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22186 ascent
= FONT_BASE (font
) + boff
;
22187 descent
= FONT_DESCENT (font
) - boff
;
22191 it
->override_ascent
= ascent
;
22192 it
->override_descent
= descent
;
22193 it
->override_boff
= boff
;
22196 height
= ascent
+ descent
;
22200 height
= (int)(XFLOAT_DATA (val
) * height
);
22201 else if (INTEGERP (val
))
22202 height
*= XINT (val
);
22204 return make_number (height
);
22209 Produce glyphs/get display metrics for the display element IT is
22210 loaded with. See the description of struct it in dispextern.h
22211 for an overview of struct it. */
22214 x_produce_glyphs (it
)
22217 int extra_line_spacing
= it
->extra_line_spacing
;
22219 it
->glyph_not_available_p
= 0;
22221 if (it
->what
== IT_CHARACTER
)
22225 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22226 struct font_metrics
*pcm
;
22227 int font_not_found_p
;
22228 int boff
; /* baseline offset */
22229 /* We may change it->multibyte_p upon unibyte<->multibyte
22230 conversion. So, save the current value now and restore it
22233 Note: It seems that we don't have to record multibyte_p in
22234 struct glyph because the character code itself tells whether
22235 or not the character is multibyte. Thus, in the future, we
22236 must consider eliminating the field `multibyte_p' in the
22238 int saved_multibyte_p
= it
->multibyte_p
;
22240 /* Maybe translate single-byte characters to multibyte, or the
22242 it
->char_to_display
= it
->c
;
22243 if (!ASCII_BYTE_P (it
->c
)
22244 && ! it
->multibyte_p
)
22246 if (SINGLE_BYTE_CHAR_P (it
->c
)
22247 && unibyte_display_via_language_environment
)
22249 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
22251 /* get_next_display_element assures that this decoding
22253 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
22254 it
->multibyte_p
= 1;
22255 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
22257 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22261 /* Get font to use. Encode IT->char_to_display. */
22262 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
22263 &char2b
, it
->multibyte_p
, 0);
22266 font_not_found_p
= font
== NULL
;
22267 if (font_not_found_p
)
22269 /* When no suitable font found, display an empty box based
22270 on the metrics of the font of the default face (or what
22272 struct face
*no_font_face
22273 = FACE_FROM_ID (it
->f
,
22274 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22275 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22276 font
= no_font_face
->font
;
22277 boff
= font
->baseline_offset
;
22281 boff
= font
->baseline_offset
;
22282 if (font
->vertical_centering
)
22283 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22286 if (it
->char_to_display
>= ' '
22287 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22289 /* Either unibyte or ASCII. */
22294 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22296 if (it
->override_ascent
>= 0)
22298 it
->ascent
= it
->override_ascent
;
22299 it
->descent
= it
->override_descent
;
22300 boff
= it
->override_boff
;
22304 it
->ascent
= FONT_BASE (font
) + boff
;
22305 it
->descent
= FONT_DESCENT (font
) - boff
;
22310 it
->phys_ascent
= pcm
->ascent
+ boff
;
22311 it
->phys_descent
= pcm
->descent
- boff
;
22312 it
->pixel_width
= pcm
->width
;
22316 it
->glyph_not_available_p
= 1;
22317 it
->phys_ascent
= it
->ascent
;
22318 it
->phys_descent
= it
->descent
;
22319 it
->pixel_width
= FONT_WIDTH (font
);
22322 if (it
->constrain_row_ascent_descent_p
)
22324 if (it
->descent
> it
->max_descent
)
22326 it
->ascent
+= it
->descent
- it
->max_descent
;
22327 it
->descent
= it
->max_descent
;
22329 if (it
->ascent
> it
->max_ascent
)
22331 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22332 it
->ascent
= it
->max_ascent
;
22334 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22335 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22336 extra_line_spacing
= 0;
22339 /* If this is a space inside a region of text with
22340 `space-width' property, change its width. */
22341 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22343 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22345 /* If face has a box, add the box thickness to the character
22346 height. If character has a box line to the left and/or
22347 right, add the box line width to the character's width. */
22348 if (face
->box
!= FACE_NO_BOX
)
22350 int thick
= face
->box_line_width
;
22354 it
->ascent
+= thick
;
22355 it
->descent
+= thick
;
22360 if (it
->start_of_box_run_p
)
22361 it
->pixel_width
+= thick
;
22362 if (it
->end_of_box_run_p
)
22363 it
->pixel_width
+= thick
;
22366 /* If face has an overline, add the height of the overline
22367 (1 pixel) and a 1 pixel margin to the character height. */
22368 if (face
->overline_p
)
22369 it
->ascent
+= overline_margin
;
22371 if (it
->constrain_row_ascent_descent_p
)
22373 if (it
->ascent
> it
->max_ascent
)
22374 it
->ascent
= it
->max_ascent
;
22375 if (it
->descent
> it
->max_descent
)
22376 it
->descent
= it
->max_descent
;
22379 take_vertical_position_into_account (it
);
22381 /* If we have to actually produce glyphs, do it. */
22386 /* Translate a space with a `space-width' property
22387 into a stretch glyph. */
22388 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22389 / FONT_HEIGHT (font
));
22390 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22391 it
->ascent
+ it
->descent
, ascent
);
22396 /* If characters with lbearing or rbearing are displayed
22397 in this line, record that fact in a flag of the
22398 glyph row. This is used to optimize X output code. */
22399 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22400 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22402 if (! stretched_p
&& it
->pixel_width
== 0)
22403 /* We assure that all visible glyphs have at least 1-pixel
22405 it
->pixel_width
= 1;
22407 else if (it
->char_to_display
== '\n')
22409 /* A newline has no width, but we need the height of the
22410 line. But if previous part of the line sets a height,
22411 don't increase that height */
22413 Lisp_Object height
;
22414 Lisp_Object total_height
= Qnil
;
22416 it
->override_ascent
= -1;
22417 it
->pixel_width
= 0;
22420 height
= get_it_property(it
, Qline_height
);
22421 /* Split (line-height total-height) list */
22423 && CONSP (XCDR (height
))
22424 && NILP (XCDR (XCDR (height
))))
22426 total_height
= XCAR (XCDR (height
));
22427 height
= XCAR (height
);
22429 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
22431 if (it
->override_ascent
>= 0)
22433 it
->ascent
= it
->override_ascent
;
22434 it
->descent
= it
->override_descent
;
22435 boff
= it
->override_boff
;
22439 it
->ascent
= FONT_BASE (font
) + boff
;
22440 it
->descent
= FONT_DESCENT (font
) - boff
;
22443 if (EQ (height
, Qt
))
22445 if (it
->descent
> it
->max_descent
)
22447 it
->ascent
+= it
->descent
- it
->max_descent
;
22448 it
->descent
= it
->max_descent
;
22450 if (it
->ascent
> it
->max_ascent
)
22452 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22453 it
->ascent
= it
->max_ascent
;
22455 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22456 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22457 it
->constrain_row_ascent_descent_p
= 1;
22458 extra_line_spacing
= 0;
22462 Lisp_Object spacing
;
22464 it
->phys_ascent
= it
->ascent
;
22465 it
->phys_descent
= it
->descent
;
22467 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22468 && face
->box
!= FACE_NO_BOX
22469 && face
->box_line_width
> 0)
22471 it
->ascent
+= face
->box_line_width
;
22472 it
->descent
+= face
->box_line_width
;
22475 && XINT (height
) > it
->ascent
+ it
->descent
)
22476 it
->ascent
= XINT (height
) - it
->descent
;
22478 if (!NILP (total_height
))
22479 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
22482 spacing
= get_it_property(it
, Qline_spacing
);
22483 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
22485 if (INTEGERP (spacing
))
22487 extra_line_spacing
= XINT (spacing
);
22488 if (!NILP (total_height
))
22489 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22493 else if (it
->char_to_display
== '\t')
22495 if (font
->space_width
> 0)
22497 int tab_width
= it
->tab_width
* font
->space_width
;
22498 int x
= it
->current_x
+ it
->continuation_lines_width
;
22499 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22501 /* If the distance from the current position to the next tab
22502 stop is less than a space character width, use the
22503 tab stop after that. */
22504 if (next_tab_x
- x
< font
->space_width
)
22505 next_tab_x
+= tab_width
;
22507 it
->pixel_width
= next_tab_x
- x
;
22509 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22510 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22514 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22515 it
->ascent
+ it
->descent
, it
->ascent
);
22520 it
->pixel_width
= 0;
22526 /* A multi-byte character. Assume that the display width of the
22527 character is the width of the character multiplied by the
22528 width of the font. */
22530 /* If we found a font, this font should give us the right
22531 metrics. If we didn't find a font, use the frame's
22532 default font and calculate the width of the character by
22533 multiplying the width of font by the width of the
22536 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22538 if (font_not_found_p
|| !pcm
)
22540 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22542 if (char_width
== 0)
22543 /* This is a non spacing character. But, as we are
22544 going to display an empty box, the box must occupy
22545 at least one column. */
22547 it
->glyph_not_available_p
= 1;
22548 it
->pixel_width
= font
->space_width
* char_width
;
22549 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22550 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22554 it
->pixel_width
= pcm
->width
;
22555 it
->phys_ascent
= pcm
->ascent
+ boff
;
22556 it
->phys_descent
= pcm
->descent
- boff
;
22558 && (pcm
->lbearing
< 0
22559 || pcm
->rbearing
> pcm
->width
))
22560 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22563 it
->ascent
= FONT_BASE (font
) + boff
;
22564 it
->descent
= FONT_DESCENT (font
) - boff
;
22565 if (face
->box
!= FACE_NO_BOX
)
22567 int thick
= face
->box_line_width
;
22571 it
->ascent
+= thick
;
22572 it
->descent
+= thick
;
22577 if (it
->start_of_box_run_p
)
22578 it
->pixel_width
+= thick
;
22579 if (it
->end_of_box_run_p
)
22580 it
->pixel_width
+= thick
;
22583 /* If face has an overline, add the height of the overline
22584 (1 pixel) and a 1 pixel margin to the character height. */
22585 if (face
->overline_p
)
22586 it
->ascent
+= overline_margin
;
22588 take_vertical_position_into_account (it
);
22590 if (it
->ascent
< 0)
22592 if (it
->descent
< 0)
22597 if (it
->pixel_width
== 0)
22598 /* We assure that all visible glyphs have at least 1-pixel
22600 it
->pixel_width
= 1;
22602 it
->multibyte_p
= saved_multibyte_p
;
22604 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22606 /* A static composition.
22608 Note: A composition is represented as one glyph in the
22609 glyph matrix. There are no padding glyphs.
22611 Important note: pixel_width, ascent, and descent are the
22612 values of what is drawn by draw_glyphs (i.e. the values of
22613 the overall glyphs composed). */
22614 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22615 int boff
; /* baseline offset */
22616 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22617 int glyph_len
= cmp
->glyph_len
;
22618 struct font
*font
= face
->font
;
22622 /* If we have not yet calculated pixel size data of glyphs of
22623 the composition for the current face font, calculate them
22624 now. Theoretically, we have to check all fonts for the
22625 glyphs, but that requires much time and memory space. So,
22626 here we check only the font of the first glyph. This may
22627 lead to incorrect display, but it's very rare, and C-l
22628 (recenter-top-bottom) can correct the display anyway. */
22629 if (! cmp
->font
|| cmp
->font
!= font
)
22631 /* Ascent and descent of the font of the first character
22632 of this composition (adjusted by baseline offset).
22633 Ascent and descent of overall glyphs should not be less
22634 than these, respectively. */
22635 int font_ascent
, font_descent
, font_height
;
22636 /* Bounding box of the overall glyphs. */
22637 int leftmost
, rightmost
, lowest
, highest
;
22638 int lbearing
, rbearing
;
22639 int i
, width
, ascent
, descent
;
22640 int left_padded
= 0, right_padded
= 0;
22643 struct font_metrics
*pcm
;
22644 int font_not_found_p
;
22647 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22648 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22650 if (glyph_len
< cmp
->glyph_len
)
22652 for (i
= 0; i
< glyph_len
; i
++)
22654 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22656 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22661 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22662 : IT_CHARPOS (*it
));
22663 /* If no suitable font is found, use the default font. */
22664 font_not_found_p
= font
== NULL
;
22665 if (font_not_found_p
)
22667 face
= face
->ascii_face
;
22670 boff
= font
->baseline_offset
;
22671 if (font
->vertical_centering
)
22672 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22673 font_ascent
= FONT_BASE (font
) + boff
;
22674 font_descent
= FONT_DESCENT (font
) - boff
;
22675 font_height
= FONT_HEIGHT (font
);
22677 cmp
->font
= (void *) font
;
22680 if (! font_not_found_p
)
22682 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22683 &char2b
, it
->multibyte_p
, 0);
22684 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22687 /* Initialize the bounding box. */
22690 width
= pcm
->width
;
22691 ascent
= pcm
->ascent
;
22692 descent
= pcm
->descent
;
22693 lbearing
= pcm
->lbearing
;
22694 rbearing
= pcm
->rbearing
;
22698 width
= FONT_WIDTH (font
);
22699 ascent
= FONT_BASE (font
);
22700 descent
= FONT_DESCENT (font
);
22707 lowest
= - descent
+ boff
;
22708 highest
= ascent
+ boff
;
22710 if (! font_not_found_p
22711 && font
->default_ascent
22712 && CHAR_TABLE_P (Vuse_default_ascent
)
22713 && !NILP (Faref (Vuse_default_ascent
,
22714 make_number (it
->char_to_display
))))
22715 highest
= font
->default_ascent
+ boff
;
22717 /* Draw the first glyph at the normal position. It may be
22718 shifted to right later if some other glyphs are drawn
22720 cmp
->offsets
[i
* 2] = 0;
22721 cmp
->offsets
[i
* 2 + 1] = boff
;
22722 cmp
->lbearing
= lbearing
;
22723 cmp
->rbearing
= rbearing
;
22725 /* Set cmp->offsets for the remaining glyphs. */
22726 for (i
++; i
< glyph_len
; i
++)
22728 int left
, right
, btm
, top
;
22729 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22731 struct face
*this_face
;
22736 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22737 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22738 font
= this_face
->font
;
22744 this_boff
= font
->baseline_offset
;
22745 if (font
->vertical_centering
)
22746 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22747 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22748 &char2b
, it
->multibyte_p
, 0);
22749 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22752 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22755 width
= pcm
->width
;
22756 ascent
= pcm
->ascent
;
22757 descent
= pcm
->descent
;
22758 lbearing
= pcm
->lbearing
;
22759 rbearing
= pcm
->rbearing
;
22760 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22762 /* Relative composition with or without
22763 alternate chars. */
22764 left
= (leftmost
+ rightmost
- width
) / 2;
22765 btm
= - descent
+ boff
;
22766 if (font
->relative_compose
22767 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22768 || NILP (Faref (Vignore_relative_composition
,
22769 make_number (ch
)))))
22772 if (- descent
>= font
->relative_compose
)
22773 /* One extra pixel between two glyphs. */
22775 else if (ascent
<= 0)
22776 /* One extra pixel between two glyphs. */
22777 btm
= lowest
- 1 - ascent
- descent
;
22782 /* A composition rule is specified by an integer
22783 value that encodes global and new reference
22784 points (GREF and NREF). GREF and NREF are
22785 specified by numbers as below:
22787 0---1---2 -- ascent
22791 9--10--11 -- center
22793 ---3---4---5--- baseline
22795 6---7---8 -- descent
22797 int rule
= COMPOSITION_RULE (cmp
, i
);
22798 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22800 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22801 grefx
= gref
% 3, nrefx
= nref
% 3;
22802 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22804 xoff
= font_height
* (xoff
- 128) / 256;
22806 yoff
= font_height
* (yoff
- 128) / 256;
22809 + grefx
* (rightmost
- leftmost
) / 2
22810 - nrefx
* width
/ 2
22813 btm
= ((grefy
== 0 ? highest
22815 : grefy
== 2 ? lowest
22816 : (highest
+ lowest
) / 2)
22817 - (nrefy
== 0 ? ascent
+ descent
22818 : nrefy
== 1 ? descent
- boff
22820 : (ascent
+ descent
) / 2)
22824 cmp
->offsets
[i
* 2] = left
;
22825 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22827 /* Update the bounding box of the overall glyphs. */
22830 right
= left
+ width
;
22831 if (left
< leftmost
)
22833 if (right
> rightmost
)
22836 top
= btm
+ descent
+ ascent
;
22842 if (cmp
->lbearing
> left
+ lbearing
)
22843 cmp
->lbearing
= left
+ lbearing
;
22844 if (cmp
->rbearing
< left
+ rbearing
)
22845 cmp
->rbearing
= left
+ rbearing
;
22849 /* If there are glyphs whose x-offsets are negative,
22850 shift all glyphs to the right and make all x-offsets
22854 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22855 cmp
->offsets
[i
* 2] -= leftmost
;
22856 rightmost
-= leftmost
;
22857 cmp
->lbearing
-= leftmost
;
22858 cmp
->rbearing
-= leftmost
;
22861 if (left_padded
&& cmp
->lbearing
< 0)
22863 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22864 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22865 rightmost
-= cmp
->lbearing
;
22866 cmp
->rbearing
-= cmp
->lbearing
;
22869 if (right_padded
&& rightmost
< cmp
->rbearing
)
22871 rightmost
= cmp
->rbearing
;
22874 cmp
->pixel_width
= rightmost
;
22875 cmp
->ascent
= highest
;
22876 cmp
->descent
= - lowest
;
22877 if (cmp
->ascent
< font_ascent
)
22878 cmp
->ascent
= font_ascent
;
22879 if (cmp
->descent
< font_descent
)
22880 cmp
->descent
= font_descent
;
22884 && (cmp
->lbearing
< 0
22885 || cmp
->rbearing
> cmp
->pixel_width
))
22886 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22888 it
->pixel_width
= cmp
->pixel_width
;
22889 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22890 it
->descent
= it
->phys_descent
= cmp
->descent
;
22891 if (face
->box
!= FACE_NO_BOX
)
22893 int thick
= face
->box_line_width
;
22897 it
->ascent
+= thick
;
22898 it
->descent
+= thick
;
22903 if (it
->start_of_box_run_p
)
22904 it
->pixel_width
+= thick
;
22905 if (it
->end_of_box_run_p
)
22906 it
->pixel_width
+= thick
;
22909 /* If face has an overline, add the height of the overline
22910 (1 pixel) and a 1 pixel margin to the character height. */
22911 if (face
->overline_p
)
22912 it
->ascent
+= overline_margin
;
22914 take_vertical_position_into_account (it
);
22915 if (it
->ascent
< 0)
22917 if (it
->descent
< 0)
22921 append_composite_glyph (it
);
22923 else if (it
->what
== IT_COMPOSITION
)
22925 /* A dynamic (automatic) composition. */
22926 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22927 Lisp_Object gstring
;
22928 struct font_metrics metrics
;
22930 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22932 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22935 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22936 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22937 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22938 it
->descent
= it
->phys_descent
= metrics
.descent
;
22939 if (face
->box
!= FACE_NO_BOX
)
22941 int thick
= face
->box_line_width
;
22945 it
->ascent
+= thick
;
22946 it
->descent
+= thick
;
22951 if (it
->start_of_box_run_p
)
22952 it
->pixel_width
+= thick
;
22953 if (it
->end_of_box_run_p
)
22954 it
->pixel_width
+= thick
;
22956 /* If face has an overline, add the height of the overline
22957 (1 pixel) and a 1 pixel margin to the character height. */
22958 if (face
->overline_p
)
22959 it
->ascent
+= overline_margin
;
22960 take_vertical_position_into_account (it
);
22961 if (it
->ascent
< 0)
22963 if (it
->descent
< 0)
22967 append_composite_glyph (it
);
22969 else if (it
->what
== IT_IMAGE
)
22970 produce_image_glyph (it
);
22971 else if (it
->what
== IT_STRETCH
)
22972 produce_stretch_glyph (it
);
22974 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22975 because this isn't true for images with `:ascent 100'. */
22976 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22977 if (it
->area
== TEXT_AREA
)
22978 it
->current_x
+= it
->pixel_width
;
22980 if (extra_line_spacing
> 0)
22982 it
->descent
+= extra_line_spacing
;
22983 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22984 it
->max_extra_line_spacing
= extra_line_spacing
;
22987 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22988 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22989 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22990 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22994 Output LEN glyphs starting at START at the nominal cursor position.
22995 Advance the nominal cursor over the text. The global variable
22996 updated_window contains the window being updated, updated_row is
22997 the glyph row being updated, and updated_area is the area of that
22998 row being updated. */
23001 x_write_glyphs (start
, len
)
23002 struct glyph
*start
;
23007 xassert (updated_window
&& updated_row
);
23010 /* Write glyphs. */
23012 hpos
= start
- updated_row
->glyphs
[updated_area
];
23013 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23014 updated_row
, updated_area
,
23016 DRAW_NORMAL_TEXT
, 0);
23018 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23019 if (updated_area
== TEXT_AREA
23020 && updated_window
->phys_cursor_on_p
23021 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23022 && updated_window
->phys_cursor
.hpos
>= hpos
23023 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23024 updated_window
->phys_cursor_on_p
= 0;
23028 /* Advance the output cursor. */
23029 output_cursor
.hpos
+= len
;
23030 output_cursor
.x
= x
;
23035 Insert LEN glyphs from START at the nominal cursor position. */
23038 x_insert_glyphs (start
, len
)
23039 struct glyph
*start
;
23044 int line_height
, shift_by_width
, shifted_region_width
;
23045 struct glyph_row
*row
;
23046 struct glyph
*glyph
;
23047 int frame_x
, frame_y
;
23050 xassert (updated_window
&& updated_row
);
23052 w
= updated_window
;
23053 f
= XFRAME (WINDOW_FRAME (w
));
23055 /* Get the height of the line we are in. */
23057 line_height
= row
->height
;
23059 /* Get the width of the glyphs to insert. */
23060 shift_by_width
= 0;
23061 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23062 shift_by_width
+= glyph
->pixel_width
;
23064 /* Get the width of the region to shift right. */
23065 shifted_region_width
= (window_box_width (w
, updated_area
)
23070 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23071 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23073 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23074 line_height
, shift_by_width
);
23076 /* Write the glyphs. */
23077 hpos
= start
- row
->glyphs
[updated_area
];
23078 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23080 DRAW_NORMAL_TEXT
, 0);
23082 /* Advance the output cursor. */
23083 output_cursor
.hpos
+= len
;
23084 output_cursor
.x
+= shift_by_width
;
23090 Erase the current text line from the nominal cursor position
23091 (inclusive) to pixel column TO_X (exclusive). The idea is that
23092 everything from TO_X onward is already erased.
23094 TO_X is a pixel position relative to updated_area of
23095 updated_window. TO_X == -1 means clear to the end of this area. */
23098 x_clear_end_of_line (to_x
)
23102 struct window
*w
= updated_window
;
23103 int max_x
, min_y
, max_y
;
23104 int from_x
, from_y
, to_y
;
23106 xassert (updated_window
&& updated_row
);
23107 f
= XFRAME (w
->frame
);
23109 if (updated_row
->full_width_p
)
23110 max_x
= WINDOW_TOTAL_WIDTH (w
);
23112 max_x
= window_box_width (w
, updated_area
);
23113 max_y
= window_text_bottom_y (w
);
23115 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23116 of window. For TO_X > 0, truncate to end of drawing area. */
23122 to_x
= min (to_x
, max_x
);
23124 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23126 /* Notice if the cursor will be cleared by this operation. */
23127 if (!updated_row
->full_width_p
)
23128 notice_overwritten_cursor (w
, updated_area
,
23129 output_cursor
.x
, -1,
23131 MATRIX_ROW_BOTTOM_Y (updated_row
));
23133 from_x
= output_cursor
.x
;
23135 /* Translate to frame coordinates. */
23136 if (updated_row
->full_width_p
)
23138 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23139 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23143 int area_left
= window_box_left (w
, updated_area
);
23144 from_x
+= area_left
;
23148 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23149 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23150 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23152 /* Prevent inadvertently clearing to end of the X window. */
23153 if (to_x
> from_x
&& to_y
> from_y
)
23156 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23157 to_x
- from_x
, to_y
- from_y
);
23162 #endif /* HAVE_WINDOW_SYSTEM */
23166 /***********************************************************************
23168 ***********************************************************************/
23170 /* Value is the internal representation of the specified cursor type
23171 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23172 of the bar cursor. */
23174 static enum text_cursor_kinds
23175 get_specified_cursor_type (arg
, width
)
23179 enum text_cursor_kinds type
;
23184 if (EQ (arg
, Qbox
))
23185 return FILLED_BOX_CURSOR
;
23187 if (EQ (arg
, Qhollow
))
23188 return HOLLOW_BOX_CURSOR
;
23190 if (EQ (arg
, Qbar
))
23197 && EQ (XCAR (arg
), Qbar
)
23198 && INTEGERP (XCDR (arg
))
23199 && XINT (XCDR (arg
)) >= 0)
23201 *width
= XINT (XCDR (arg
));
23205 if (EQ (arg
, Qhbar
))
23208 return HBAR_CURSOR
;
23212 && EQ (XCAR (arg
), Qhbar
)
23213 && INTEGERP (XCDR (arg
))
23214 && XINT (XCDR (arg
)) >= 0)
23216 *width
= XINT (XCDR (arg
));
23217 return HBAR_CURSOR
;
23220 /* Treat anything unknown as "hollow box cursor".
23221 It was bad to signal an error; people have trouble fixing
23222 .Xdefaults with Emacs, when it has something bad in it. */
23223 type
= HOLLOW_BOX_CURSOR
;
23228 /* Set the default cursor types for specified frame. */
23230 set_frame_cursor_types (f
, arg
)
23237 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23238 FRAME_CURSOR_WIDTH (f
) = width
;
23240 /* By default, set up the blink-off state depending on the on-state. */
23242 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23245 FRAME_BLINK_OFF_CURSOR (f
)
23246 = get_specified_cursor_type (XCDR (tem
), &width
);
23247 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23250 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23254 /* Return the cursor we want to be displayed in window W. Return
23255 width of bar/hbar cursor through WIDTH arg. Return with
23256 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23257 (i.e. if the `system caret' should track this cursor).
23259 In a mini-buffer window, we want the cursor only to appear if we
23260 are reading input from this window. For the selected window, we
23261 want the cursor type given by the frame parameter or buffer local
23262 setting of cursor-type. If explicitly marked off, draw no cursor.
23263 In all other cases, we want a hollow box cursor. */
23265 static enum text_cursor_kinds
23266 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
23268 struct glyph
*glyph
;
23270 int *active_cursor
;
23272 struct frame
*f
= XFRAME (w
->frame
);
23273 struct buffer
*b
= XBUFFER (w
->buffer
);
23274 int cursor_type
= DEFAULT_CURSOR
;
23275 Lisp_Object alt_cursor
;
23276 int non_selected
= 0;
23278 *active_cursor
= 1;
23281 if (cursor_in_echo_area
23282 && FRAME_HAS_MINIBUF_P (f
)
23283 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23285 if (w
== XWINDOW (echo_area_window
))
23287 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23289 *width
= FRAME_CURSOR_WIDTH (f
);
23290 return FRAME_DESIRED_CURSOR (f
);
23293 return get_specified_cursor_type (b
->cursor_type
, width
);
23296 *active_cursor
= 0;
23300 /* Detect a nonselected window or nonselected frame. */
23301 else if (w
!= XWINDOW (f
->selected_window
)
23302 #ifdef HAVE_WINDOW_SYSTEM
23303 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23307 *active_cursor
= 0;
23309 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23315 /* Never display a cursor in a window in which cursor-type is nil. */
23316 if (NILP (b
->cursor_type
))
23319 /* Get the normal cursor type for this window. */
23320 if (EQ (b
->cursor_type
, Qt
))
23322 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23323 *width
= FRAME_CURSOR_WIDTH (f
);
23326 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23328 /* Use cursor-in-non-selected-windows instead
23329 for non-selected window or frame. */
23332 alt_cursor
= b
->cursor_in_non_selected_windows
;
23333 if (!EQ (Qt
, alt_cursor
))
23334 return get_specified_cursor_type (alt_cursor
, width
);
23335 /* t means modify the normal cursor type. */
23336 if (cursor_type
== FILLED_BOX_CURSOR
)
23337 cursor_type
= HOLLOW_BOX_CURSOR
;
23338 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23340 return cursor_type
;
23343 /* Use normal cursor if not blinked off. */
23344 if (!w
->cursor_off_p
)
23346 #ifdef HAVE_WINDOW_SYSTEM
23347 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23349 if (cursor_type
== FILLED_BOX_CURSOR
)
23351 /* Using a block cursor on large images can be very annoying.
23352 So use a hollow cursor for "large" images.
23353 If image is not transparent (no mask), also use hollow cursor. */
23354 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23355 if (img
!= NULL
&& IMAGEP (img
->spec
))
23357 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23358 where N = size of default frame font size.
23359 This should cover most of the "tiny" icons people may use. */
23361 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23362 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23363 cursor_type
= HOLLOW_BOX_CURSOR
;
23366 else if (cursor_type
!= NO_CURSOR
)
23368 /* Display current only supports BOX and HOLLOW cursors for images.
23369 So for now, unconditionally use a HOLLOW cursor when cursor is
23370 not a solid box cursor. */
23371 cursor_type
= HOLLOW_BOX_CURSOR
;
23375 return cursor_type
;
23378 /* Cursor is blinked off, so determine how to "toggle" it. */
23380 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23381 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23382 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23384 /* Then see if frame has specified a specific blink off cursor type. */
23385 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23387 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23388 return FRAME_BLINK_OFF_CURSOR (f
);
23392 /* Some people liked having a permanently visible blinking cursor,
23393 while others had very strong opinions against it. So it was
23394 decided to remove it. KFS 2003-09-03 */
23396 /* Finally perform built-in cursor blinking:
23397 filled box <-> hollow box
23398 wide [h]bar <-> narrow [h]bar
23399 narrow [h]bar <-> no cursor
23400 other type <-> no cursor */
23402 if (cursor_type
== FILLED_BOX_CURSOR
)
23403 return HOLLOW_BOX_CURSOR
;
23405 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23408 return cursor_type
;
23416 #ifdef HAVE_WINDOW_SYSTEM
23418 /* Notice when the text cursor of window W has been completely
23419 overwritten by a drawing operation that outputs glyphs in AREA
23420 starting at X0 and ending at X1 in the line starting at Y0 and
23421 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23422 the rest of the line after X0 has been written. Y coordinates
23423 are window-relative. */
23426 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
23428 enum glyph_row_area area
;
23429 int x0
, y0
, x1
, y1
;
23431 int cx0
, cx1
, cy0
, cy1
;
23432 struct glyph_row
*row
;
23434 if (!w
->phys_cursor_on_p
)
23436 if (area
!= TEXT_AREA
)
23439 if (w
->phys_cursor
.vpos
< 0
23440 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23441 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23442 !(row
->enabled_p
&& row
->displays_text_p
)))
23445 if (row
->cursor_in_fringe_p
)
23447 row
->cursor_in_fringe_p
= 0;
23448 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23449 w
->phys_cursor_on_p
= 0;
23453 cx0
= w
->phys_cursor
.x
;
23454 cx1
= cx0
+ w
->phys_cursor_width
;
23455 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23458 /* The cursor image will be completely removed from the
23459 screen if the output area intersects the cursor area in
23460 y-direction. When we draw in [y0 y1[, and some part of
23461 the cursor is at y < y0, that part must have been drawn
23462 before. When scrolling, the cursor is erased before
23463 actually scrolling, so we don't come here. When not
23464 scrolling, the rows above the old cursor row must have
23465 changed, and in this case these rows must have written
23466 over the cursor image.
23468 Likewise if part of the cursor is below y1, with the
23469 exception of the cursor being in the first blank row at
23470 the buffer and window end because update_text_area
23471 doesn't draw that row. (Except when it does, but
23472 that's handled in update_text_area.) */
23474 cy0
= w
->phys_cursor
.y
;
23475 cy1
= cy0
+ w
->phys_cursor_height
;
23476 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23479 w
->phys_cursor_on_p
= 0;
23482 #endif /* HAVE_WINDOW_SYSTEM */
23485 /************************************************************************
23487 ************************************************************************/
23489 #ifdef HAVE_WINDOW_SYSTEM
23492 Fix the display of area AREA of overlapping row ROW in window W
23493 with respect to the overlapping part OVERLAPS. */
23496 x_fix_overlapping_area (w
, row
, area
, overlaps
)
23498 struct glyph_row
*row
;
23499 enum glyph_row_area area
;
23507 for (i
= 0; i
< row
->used
[area
];)
23509 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23511 int start
= i
, start_x
= x
;
23515 x
+= row
->glyphs
[area
][i
].pixel_width
;
23518 while (i
< row
->used
[area
]
23519 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23521 draw_glyphs (w
, start_x
, row
, area
,
23523 DRAW_NORMAL_TEXT
, overlaps
);
23527 x
+= row
->glyphs
[area
][i
].pixel_width
;
23537 Draw the cursor glyph of window W in glyph row ROW. See the
23538 comment of draw_glyphs for the meaning of HL. */
23541 draw_phys_cursor_glyph (w
, row
, hl
)
23543 struct glyph_row
*row
;
23544 enum draw_glyphs_face hl
;
23546 /* If cursor hpos is out of bounds, don't draw garbage. This can
23547 happen in mini-buffer windows when switching between echo area
23548 glyphs and mini-buffer. */
23549 if ((row
->reversed_p
23550 ? (w
->phys_cursor
.hpos
>= 0)
23551 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23553 int on_p
= w
->phys_cursor_on_p
;
23555 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23556 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23558 w
->phys_cursor_on_p
= on_p
;
23560 if (hl
== DRAW_CURSOR
)
23561 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23562 /* When we erase the cursor, and ROW is overlapped by other
23563 rows, make sure that these overlapping parts of other rows
23565 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23567 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23569 if (row
> w
->current_matrix
->rows
23570 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23571 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23572 OVERLAPS_ERASED_CURSOR
);
23574 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23575 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23576 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23577 OVERLAPS_ERASED_CURSOR
);
23584 Erase the image of a cursor of window W from the screen. */
23587 erase_phys_cursor (w
)
23590 struct frame
*f
= XFRAME (w
->frame
);
23591 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23592 int hpos
= w
->phys_cursor
.hpos
;
23593 int vpos
= w
->phys_cursor
.vpos
;
23594 int mouse_face_here_p
= 0;
23595 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23596 struct glyph_row
*cursor_row
;
23597 struct glyph
*cursor_glyph
;
23598 enum draw_glyphs_face hl
;
23600 /* No cursor displayed or row invalidated => nothing to do on the
23602 if (w
->phys_cursor_type
== NO_CURSOR
)
23603 goto mark_cursor_off
;
23605 /* VPOS >= active_glyphs->nrows means that window has been resized.
23606 Don't bother to erase the cursor. */
23607 if (vpos
>= active_glyphs
->nrows
)
23608 goto mark_cursor_off
;
23610 /* If row containing cursor is marked invalid, there is nothing we
23612 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23613 if (!cursor_row
->enabled_p
)
23614 goto mark_cursor_off
;
23616 /* If line spacing is > 0, old cursor may only be partially visible in
23617 window after split-window. So adjust visible height. */
23618 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23619 window_text_bottom_y (w
) - cursor_row
->y
);
23621 /* If row is completely invisible, don't attempt to delete a cursor which
23622 isn't there. This can happen if cursor is at top of a window, and
23623 we switch to a buffer with a header line in that window. */
23624 if (cursor_row
->visible_height
<= 0)
23625 goto mark_cursor_off
;
23627 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23628 if (cursor_row
->cursor_in_fringe_p
)
23630 cursor_row
->cursor_in_fringe_p
= 0;
23631 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23632 goto mark_cursor_off
;
23635 /* This can happen when the new row is shorter than the old one.
23636 In this case, either draw_glyphs or clear_end_of_line
23637 should have cleared the cursor. Note that we wouldn't be
23638 able to erase the cursor in this case because we don't have a
23639 cursor glyph at hand. */
23640 if ((cursor_row
->reversed_p
23641 ? (w
->phys_cursor
.hpos
< 0)
23642 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23643 goto mark_cursor_off
;
23645 /* If the cursor is in the mouse face area, redisplay that when
23646 we clear the cursor. */
23647 if (! NILP (dpyinfo
->mouse_face_window
)
23648 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23649 && (vpos
> dpyinfo
->mouse_face_beg_row
23650 || (vpos
== dpyinfo
->mouse_face_beg_row
23651 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23652 && (vpos
< dpyinfo
->mouse_face_end_row
23653 || (vpos
== dpyinfo
->mouse_face_end_row
23654 && hpos
< dpyinfo
->mouse_face_end_col
))
23655 /* Don't redraw the cursor's spot in mouse face if it is at the
23656 end of a line (on a newline). The cursor appears there, but
23657 mouse highlighting does not. */
23658 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23659 mouse_face_here_p
= 1;
23661 /* Maybe clear the display under the cursor. */
23662 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23665 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23668 cursor_glyph
= get_phys_cursor_glyph (w
);
23669 if (cursor_glyph
== NULL
)
23670 goto mark_cursor_off
;
23672 width
= cursor_glyph
->pixel_width
;
23673 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23674 x
= w
->phys_cursor
.x
;
23676 width
-= left_x
- x
;
23677 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23678 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23679 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23682 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23685 /* Erase the cursor by redrawing the character underneath it. */
23686 if (mouse_face_here_p
)
23687 hl
= DRAW_MOUSE_FACE
;
23689 hl
= DRAW_NORMAL_TEXT
;
23690 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23693 w
->phys_cursor_on_p
= 0;
23694 w
->phys_cursor_type
= NO_CURSOR
;
23699 Display or clear cursor of window W. If ON is zero, clear the
23700 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23701 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23704 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
23706 int on
, hpos
, vpos
, x
, y
;
23708 struct frame
*f
= XFRAME (w
->frame
);
23709 int new_cursor_type
;
23710 int new_cursor_width
;
23712 struct glyph_row
*glyph_row
;
23713 struct glyph
*glyph
;
23715 /* This is pointless on invisible frames, and dangerous on garbaged
23716 windows and frames; in the latter case, the frame or window may
23717 be in the midst of changing its size, and x and y may be off the
23719 if (! FRAME_VISIBLE_P (f
)
23720 || FRAME_GARBAGED_P (f
)
23721 || vpos
>= w
->current_matrix
->nrows
23722 || hpos
>= w
->current_matrix
->matrix_w
)
23725 /* If cursor is off and we want it off, return quickly. */
23726 if (!on
&& !w
->phys_cursor_on_p
)
23729 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23730 /* If cursor row is not enabled, we don't really know where to
23731 display the cursor. */
23732 if (!glyph_row
->enabled_p
)
23734 w
->phys_cursor_on_p
= 0;
23739 if (!glyph_row
->exact_window_width_line_p
23740 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23741 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23743 xassert (interrupt_input_blocked
);
23745 /* Set new_cursor_type to the cursor we want to be displayed. */
23746 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23747 &new_cursor_width
, &active_cursor
);
23749 /* If cursor is currently being shown and we don't want it to be or
23750 it is in the wrong place, or the cursor type is not what we want,
23752 if (w
->phys_cursor_on_p
23754 || w
->phys_cursor
.x
!= x
23755 || w
->phys_cursor
.y
!= y
23756 || new_cursor_type
!= w
->phys_cursor_type
23757 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23758 && new_cursor_width
!= w
->phys_cursor_width
)))
23759 erase_phys_cursor (w
);
23761 /* Don't check phys_cursor_on_p here because that flag is only set
23762 to zero in some cases where we know that the cursor has been
23763 completely erased, to avoid the extra work of erasing the cursor
23764 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23765 still not be visible, or it has only been partly erased. */
23768 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23769 w
->phys_cursor_height
= glyph_row
->height
;
23771 /* Set phys_cursor_.* before x_draw_.* is called because some
23772 of them may need the information. */
23773 w
->phys_cursor
.x
= x
;
23774 w
->phys_cursor
.y
= glyph_row
->y
;
23775 w
->phys_cursor
.hpos
= hpos
;
23776 w
->phys_cursor
.vpos
= vpos
;
23779 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23780 new_cursor_type
, new_cursor_width
,
23781 on
, active_cursor
);
23785 /* Switch the display of W's cursor on or off, according to the value
23789 update_window_cursor (w
, on
)
23793 /* Don't update cursor in windows whose frame is in the process
23794 of being deleted. */
23795 if (w
->current_matrix
)
23798 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23799 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23805 /* Call update_window_cursor with parameter ON_P on all leaf windows
23806 in the window tree rooted at W. */
23809 update_cursor_in_window_tree (w
, on_p
)
23815 if (!NILP (w
->hchild
))
23816 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23817 else if (!NILP (w
->vchild
))
23818 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23820 update_window_cursor (w
, on_p
);
23822 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23828 Display the cursor on window W, or clear it, according to ON_P.
23829 Don't change the cursor's position. */
23832 x_update_cursor (f
, on_p
)
23836 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23841 Clear the cursor of window W to background color, and mark the
23842 cursor as not shown. This is used when the text where the cursor
23843 is about to be rewritten. */
23849 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23850 update_window_cursor (w
, 0);
23855 Display the active region described by mouse_face_* according to DRAW. */
23858 show_mouse_face (dpyinfo
, draw
)
23859 Display_Info
*dpyinfo
;
23860 enum draw_glyphs_face draw
;
23862 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23863 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23865 if (/* If window is in the process of being destroyed, don't bother
23867 w
->current_matrix
!= NULL
23868 /* Don't update mouse highlight if hidden */
23869 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23870 /* Recognize when we are called to operate on rows that don't exist
23871 anymore. This can happen when a window is split. */
23872 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23874 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23875 struct glyph_row
*row
, *first
, *last
;
23877 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23878 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23880 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23882 int start_hpos
, end_hpos
, start_x
;
23884 /* For all but the first row, the highlight starts at column 0. */
23887 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23888 start_x
= dpyinfo
->mouse_face_beg_x
;
23897 end_hpos
= dpyinfo
->mouse_face_end_col
;
23900 end_hpos
= row
->used
[TEXT_AREA
];
23901 if (draw
== DRAW_NORMAL_TEXT
)
23902 row
->fill_line_p
= 1; /* Clear to end of line */
23905 if (end_hpos
> start_hpos
)
23907 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23908 start_hpos
, end_hpos
,
23912 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23916 /* When we've written over the cursor, arrange for it to
23917 be displayed again. */
23918 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23921 display_and_set_cursor (w
, 1,
23922 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23923 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23928 /* Change the mouse cursor. */
23929 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23930 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23931 else if (draw
== DRAW_MOUSE_FACE
)
23932 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23934 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23938 Clear out the mouse-highlighted active region.
23939 Redraw it un-highlighted first. Value is non-zero if mouse
23940 face was actually drawn unhighlighted. */
23943 clear_mouse_face (dpyinfo
)
23944 Display_Info
*dpyinfo
;
23948 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23950 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23954 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23955 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23956 dpyinfo
->mouse_face_window
= Qnil
;
23957 dpyinfo
->mouse_face_overlay
= Qnil
;
23963 Non-zero if physical cursor of window W is within mouse face. */
23966 cursor_in_mouse_face_p (w
)
23969 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23970 int in_mouse_face
= 0;
23972 if (WINDOWP (dpyinfo
->mouse_face_window
)
23973 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23975 int hpos
= w
->phys_cursor
.hpos
;
23976 int vpos
= w
->phys_cursor
.vpos
;
23978 if (vpos
>= dpyinfo
->mouse_face_beg_row
23979 && vpos
<= dpyinfo
->mouse_face_end_row
23980 && (vpos
> dpyinfo
->mouse_face_beg_row
23981 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23982 && (vpos
< dpyinfo
->mouse_face_end_row
23983 || hpos
< dpyinfo
->mouse_face_end_col
23984 || dpyinfo
->mouse_face_past_end
))
23988 return in_mouse_face
;
23994 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23995 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23996 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23997 for the overlay or run of text properties specifying the mouse
23998 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23999 before-string and after-string that must also be highlighted.
24000 DISPLAY_STRING, if non-nil, is a display string that may cover some
24001 or all of the highlighted text. */
24004 mouse_face_from_buffer_pos (Lisp_Object window
,
24005 Display_Info
*dpyinfo
,
24006 EMACS_INT mouse_charpos
,
24007 EMACS_INT start_charpos
,
24008 EMACS_INT end_charpos
,
24009 Lisp_Object before_string
,
24010 Lisp_Object after_string
,
24011 Lisp_Object display_string
)
24013 struct window
*w
= XWINDOW (window
);
24014 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24015 struct glyph_row
*row
;
24016 struct glyph
*glyph
, *end
;
24020 xassert (NILP (display_string
) || STRINGP (display_string
));
24021 xassert (NILP (before_string
) || STRINGP (before_string
));
24022 xassert (NILP (after_string
) || STRINGP (after_string
));
24024 /* Find the first highlighted glyph. */
24025 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
24027 dpyinfo
->mouse_face_beg_col
= 0;
24028 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
24029 dpyinfo
->mouse_face_beg_x
= first
->x
;
24030 dpyinfo
->mouse_face_beg_y
= first
->y
;
24034 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
24036 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24038 /* If the before-string or display-string contains newlines,
24039 row_containing_pos skips to its last row. Move back. */
24040 if (!NILP (before_string
) || !NILP (display_string
))
24042 struct glyph_row
*prev
;
24043 while ((prev
= row
- 1, prev
>= first
)
24044 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24045 && prev
->used
[TEXT_AREA
] > 0)
24047 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24048 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24049 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24051 || !(EQ (glyph
->object
, before_string
)
24052 || EQ (glyph
->object
, display_string
)))
24058 glyph
= row
->glyphs
[TEXT_AREA
];
24059 end
= glyph
+ row
->used
[TEXT_AREA
];
24061 dpyinfo
->mouse_face_beg_y
= row
->y
;
24062 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24064 /* Skip truncation glyphs at the start of the glyph row. */
24065 if (row
->displays_text_p
)
24067 && INTEGERP (glyph
->object
)
24068 && glyph
->charpos
< 0;
24070 x
+= glyph
->pixel_width
;
24072 /* Scan the glyph row, stopping before BEFORE_STRING or
24073 DISPLAY_STRING or START_CHARPOS. */
24075 && !INTEGERP (glyph
->object
)
24076 && !EQ (glyph
->object
, before_string
)
24077 && !EQ (glyph
->object
, display_string
)
24078 && !(BUFFERP (glyph
->object
)
24079 && glyph
->charpos
>= start_charpos
);
24081 x
+= glyph
->pixel_width
;
24083 dpyinfo
->mouse_face_beg_x
= x
;
24084 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24087 /* Find the last highlighted glyph. */
24088 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
24091 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24092 dpyinfo
->mouse_face_past_end
= 1;
24094 else if (!NILP (after_string
))
24096 /* If the after-string has newlines, advance to its last row. */
24097 struct glyph_row
*next
;
24098 struct glyph_row
*last
24099 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24101 for (next
= row
+ 1;
24103 && next
->used
[TEXT_AREA
] > 0
24104 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24109 glyph
= row
->glyphs
[TEXT_AREA
];
24110 end
= glyph
+ row
->used
[TEXT_AREA
];
24112 dpyinfo
->mouse_face_end_y
= row
->y
;
24113 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24115 /* Skip truncation glyphs at the start of the row. */
24116 if (row
->displays_text_p
)
24118 && INTEGERP (glyph
->object
)
24119 && glyph
->charpos
< 0;
24121 x
+= glyph
->pixel_width
;
24123 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
24126 && !INTEGERP (glyph
->object
)
24127 && !EQ (glyph
->object
, after_string
)
24128 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
24130 x
+= glyph
->pixel_width
;
24132 /* If we found AFTER_STRING, consume it and stop. */
24133 if (EQ (glyph
->object
, after_string
))
24135 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
24136 x
+= glyph
->pixel_width
;
24140 /* If there's no after-string, we must check if we overshot,
24141 which might be the case if we stopped after a string glyph.
24142 That glyph may belong to a before-string or display-string
24143 associated with the end position, which must not be
24145 Lisp_Object prev_object
;
24148 while (glyph
> row
->glyphs
[TEXT_AREA
])
24150 prev_object
= (glyph
- 1)->object
;
24151 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
24154 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
24155 if (pos
&& pos
< end_charpos
)
24158 for (; glyph
> row
->glyphs
[TEXT_AREA
]
24159 && EQ ((glyph
- 1)->object
, prev_object
);
24161 x
-= (glyph
- 1)->pixel_width
;
24165 dpyinfo
->mouse_face_end_x
= x
;
24166 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24167 dpyinfo
->mouse_face_window
= window
;
24168 dpyinfo
->mouse_face_face_id
24169 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24171 !dpyinfo
->mouse_face_hidden
, -1);
24172 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24176 /* Find the position of the glyph for position POS in OBJECT in
24177 window W's current matrix, and return in *X, *Y the pixel
24178 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24180 RIGHT_P non-zero means return the position of the right edge of the
24181 glyph, RIGHT_P zero means return the left edge position.
24183 If no glyph for POS exists in the matrix, return the position of
24184 the glyph with the next smaller position that is in the matrix, if
24185 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24186 exists in the matrix, return the position of the glyph with the
24187 next larger position in OBJECT.
24189 Value is non-zero if a glyph was found. */
24192 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
24195 Lisp_Object object
;
24196 int *hpos
, *vpos
, *x
, *y
;
24199 int yb
= window_text_bottom_y (w
);
24200 struct glyph_row
*r
;
24201 struct glyph
*best_glyph
= NULL
;
24202 struct glyph_row
*best_row
= NULL
;
24205 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24206 r
->enabled_p
&& r
->y
< yb
;
24209 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24210 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24213 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24214 if (EQ (g
->object
, object
))
24216 if (g
->charpos
== pos
)
24223 else if (best_glyph
== NULL
24224 || ((eabs (g
->charpos
- pos
)
24225 < eabs (best_glyph
->charpos
- pos
))
24228 : g
->charpos
> pos
)))
24242 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24246 *x
+= best_glyph
->pixel_width
;
24251 *vpos
= best_row
- w
->current_matrix
->rows
;
24254 return best_glyph
!= NULL
;
24258 /* See if position X, Y is within a hot-spot of an image. */
24261 on_hot_spot_p (hot_spot
, x
, y
)
24262 Lisp_Object hot_spot
;
24265 if (!CONSP (hot_spot
))
24268 if (EQ (XCAR (hot_spot
), Qrect
))
24270 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24271 Lisp_Object rect
= XCDR (hot_spot
);
24275 if (!CONSP (XCAR (rect
)))
24277 if (!CONSP (XCDR (rect
)))
24279 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24281 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24283 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24285 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24289 else if (EQ (XCAR (hot_spot
), Qcircle
))
24291 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24292 Lisp_Object circ
= XCDR (hot_spot
);
24293 Lisp_Object lr
, lx0
, ly0
;
24295 && CONSP (XCAR (circ
))
24296 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24297 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24298 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24300 double r
= XFLOATINT (lr
);
24301 double dx
= XINT (lx0
) - x
;
24302 double dy
= XINT (ly0
) - y
;
24303 return (dx
* dx
+ dy
* dy
<= r
* r
);
24306 else if (EQ (XCAR (hot_spot
), Qpoly
))
24308 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24309 if (VECTORP (XCDR (hot_spot
)))
24311 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24312 Lisp_Object
*poly
= v
->contents
;
24316 Lisp_Object lx
, ly
;
24319 /* Need an even number of coordinates, and at least 3 edges. */
24320 if (n
< 6 || n
& 1)
24323 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24324 If count is odd, we are inside polygon. Pixels on edges
24325 may or may not be included depending on actual geometry of the
24327 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24328 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24330 x0
= XINT (lx
), y0
= XINT (ly
);
24331 for (i
= 0; i
< n
; i
+= 2)
24333 int x1
= x0
, y1
= y0
;
24334 if ((lx
= poly
[i
], !INTEGERP (lx
))
24335 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24337 x0
= XINT (lx
), y0
= XINT (ly
);
24339 /* Does this segment cross the X line? */
24347 if (y
> y0
&& y
> y1
)
24349 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24359 find_hot_spot (map
, x
, y
)
24363 while (CONSP (map
))
24365 if (CONSP (XCAR (map
))
24366 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24374 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24376 doc
: /* Lookup in image map MAP coordinates X and Y.
24377 An image map is an alist where each element has the format (AREA ID PLIST).
24378 An AREA is specified as either a rectangle, a circle, or a polygon:
24379 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24380 pixel coordinates of the upper left and bottom right corners.
24381 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24382 and the radius of the circle; r may be a float or integer.
24383 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24384 vector describes one corner in the polygon.
24385 Returns the alist element for the first matching AREA in MAP. */)
24396 return find_hot_spot (map
, XINT (x
), XINT (y
));
24400 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24402 define_frame_cursor1 (f
, cursor
, pointer
)
24405 Lisp_Object pointer
;
24407 /* Do not change cursor shape while dragging mouse. */
24408 if (!NILP (do_mouse_tracking
))
24411 if (!NILP (pointer
))
24413 if (EQ (pointer
, Qarrow
))
24414 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24415 else if (EQ (pointer
, Qhand
))
24416 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24417 else if (EQ (pointer
, Qtext
))
24418 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24419 else if (EQ (pointer
, intern ("hdrag")))
24420 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24421 #ifdef HAVE_X_WINDOWS
24422 else if (EQ (pointer
, intern ("vdrag")))
24423 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24425 else if (EQ (pointer
, intern ("hourglass")))
24426 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24427 else if (EQ (pointer
, Qmodeline
))
24428 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24430 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24433 if (cursor
!= No_Cursor
)
24434 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24437 /* Take proper action when mouse has moved to the mode or header line
24438 or marginal area AREA of window W, x-position X and y-position Y.
24439 X is relative to the start of the text display area of W, so the
24440 width of bitmap areas and scroll bars must be subtracted to get a
24441 position relative to the start of the mode line. */
24444 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
24445 Lisp_Object window
;
24447 enum window_part area
;
24449 struct window
*w
= XWINDOW (window
);
24450 struct frame
*f
= XFRAME (w
->frame
);
24451 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24452 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24453 Lisp_Object pointer
= Qnil
;
24454 int charpos
, dx
, dy
, width
, height
;
24455 Lisp_Object string
, object
= Qnil
;
24456 Lisp_Object pos
, help
;
24458 Lisp_Object mouse_face
;
24459 int original_x_pixel
= x
;
24460 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24461 struct glyph_row
*row
;
24463 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24468 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24469 &object
, &dx
, &dy
, &width
, &height
);
24471 row
= (area
== ON_MODE_LINE
24472 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24473 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24476 if (row
->mode_line_p
&& row
->enabled_p
)
24478 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24479 end
= glyph
+ row
->used
[TEXT_AREA
];
24481 for (x0
= original_x_pixel
;
24482 glyph
< end
&& x0
>= glyph
->pixel_width
;
24484 x0
-= glyph
->pixel_width
;
24492 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24493 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24494 &object
, &dx
, &dy
, &width
, &height
);
24499 if (IMAGEP (object
))
24501 Lisp_Object image_map
, hotspot
;
24502 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24504 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24506 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24508 Lisp_Object area_id
, plist
;
24510 area_id
= XCAR (hotspot
);
24511 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24512 If so, we could look for mouse-enter, mouse-leave
24513 properties in PLIST (and do something...). */
24514 hotspot
= XCDR (hotspot
);
24515 if (CONSP (hotspot
)
24516 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24518 pointer
= Fplist_get (plist
, Qpointer
);
24519 if (NILP (pointer
))
24521 help
= Fplist_get (plist
, Qhelp_echo
);
24524 help_echo_string
= help
;
24525 /* Is this correct? ++kfs */
24526 XSETWINDOW (help_echo_window
, w
);
24527 help_echo_object
= w
->buffer
;
24528 help_echo_pos
= charpos
;
24532 if (NILP (pointer
))
24533 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24536 if (STRINGP (string
))
24538 pos
= make_number (charpos
);
24539 /* If we're on a string with `help-echo' text property, arrange
24540 for the help to be displayed. This is done by setting the
24541 global variable help_echo_string to the help string. */
24544 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24547 help_echo_string
= help
;
24548 XSETWINDOW (help_echo_window
, w
);
24549 help_echo_object
= string
;
24550 help_echo_pos
= charpos
;
24554 if (NILP (pointer
))
24555 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24557 /* Change the mouse pointer according to what is under X/Y. */
24558 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24561 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24562 if (!KEYMAPP (map
))
24563 map
= Fget_text_property (pos
, Qkeymap
, string
);
24564 if (!KEYMAPP (map
))
24565 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24568 /* Change the mouse face according to what is under X/Y. */
24569 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24570 if (!NILP (mouse_face
)
24571 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24576 struct glyph
* tmp_glyph
;
24580 int total_pixel_width
;
24585 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24586 Qmouse_face
, string
, Qnil
);
24588 b
= make_number (0);
24590 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24592 e
= make_number (SCHARS (string
));
24594 /* Calculate the position(glyph position: GPOS) of GLYPH in
24595 displayed string. GPOS is different from CHARPOS.
24597 CHARPOS is the position of glyph in internal string
24598 object. A mode line string format has structures which
24599 is converted to a flatten by emacs lisp interpreter.
24600 The internal string is an element of the structures.
24601 The displayed string is the flatten string. */
24603 if (glyph
> row_start_glyph
)
24605 tmp_glyph
= glyph
- 1;
24606 while (tmp_glyph
>= row_start_glyph
24607 && tmp_glyph
->charpos
>= XINT (b
)
24608 && EQ (tmp_glyph
->object
, glyph
->object
))
24615 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24616 displayed string holding GLYPH.
24618 GSEQ_LENGTH is different from SCHARS (STRING).
24619 SCHARS (STRING) returns the length of the internal string. */
24620 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24621 tmp_glyph
->charpos
< XINT (e
);
24622 tmp_glyph
++, gseq_length
++)
24624 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24628 total_pixel_width
= 0;
24629 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24630 total_pixel_width
+= tmp_glyph
->pixel_width
;
24632 /* Pre calculation of re-rendering position */
24634 hpos
= (area
== ON_MODE_LINE
24635 ? (w
->current_matrix
)->nrows
- 1
24638 /* If the re-rendering position is included in the last
24639 re-rendering area, we should do nothing. */
24640 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24641 && dpyinfo
->mouse_face_beg_col
<= vpos
24642 && vpos
< dpyinfo
->mouse_face_end_col
24643 && dpyinfo
->mouse_face_beg_row
== hpos
)
24646 if (clear_mouse_face (dpyinfo
))
24647 cursor
= No_Cursor
;
24649 dpyinfo
->mouse_face_beg_col
= vpos
;
24650 dpyinfo
->mouse_face_beg_row
= hpos
;
24652 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24653 dpyinfo
->mouse_face_beg_y
= 0;
24655 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24656 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24658 dpyinfo
->mouse_face_end_x
= 0;
24659 dpyinfo
->mouse_face_end_y
= 0;
24661 dpyinfo
->mouse_face_past_end
= 0;
24662 dpyinfo
->mouse_face_window
= window
;
24664 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24667 glyph
->face_id
, 1);
24668 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24670 if (NILP (pointer
))
24673 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24674 clear_mouse_face (dpyinfo
);
24676 define_frame_cursor1 (f
, cursor
, pointer
);
24681 Take proper action when the mouse has moved to position X, Y on
24682 frame F as regards highlighting characters that have mouse-face
24683 properties. Also de-highlighting chars where the mouse was before.
24684 X and Y can be negative or out of range. */
24687 note_mouse_highlight (f
, x
, y
)
24691 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24692 enum window_part part
;
24693 Lisp_Object window
;
24695 Cursor cursor
= No_Cursor
;
24696 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24699 /* When a menu is active, don't highlight because this looks odd. */
24700 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24701 if (popup_activated ())
24705 if (NILP (Vmouse_highlight
)
24706 || !f
->glyphs_initialized_p
24707 || f
->pointer_invisible
)
24710 dpyinfo
->mouse_face_mouse_x
= x
;
24711 dpyinfo
->mouse_face_mouse_y
= y
;
24712 dpyinfo
->mouse_face_mouse_frame
= f
;
24714 if (dpyinfo
->mouse_face_defer
)
24717 if (gc_in_progress
)
24719 dpyinfo
->mouse_face_deferred_gc
= 1;
24723 /* Which window is that in? */
24724 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24726 /* If we were displaying active text in another window, clear that.
24727 Also clear if we move out of text area in same window. */
24728 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24729 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24730 && !NILP (dpyinfo
->mouse_face_window
)))
24731 clear_mouse_face (dpyinfo
);
24733 /* Not on a window -> return. */
24734 if (!WINDOWP (window
))
24737 /* Reset help_echo_string. It will get recomputed below. */
24738 help_echo_string
= Qnil
;
24740 /* Convert to window-relative pixel coordinates. */
24741 w
= XWINDOW (window
);
24742 frame_to_window_pixel_xy (w
, &x
, &y
);
24744 /* Handle tool-bar window differently since it doesn't display a
24746 if (EQ (window
, f
->tool_bar_window
))
24748 note_tool_bar_highlight (f
, x
, y
);
24752 /* Mouse is on the mode, header line or margin? */
24753 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24754 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24756 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24760 if (part
== ON_VERTICAL_BORDER
)
24762 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24763 help_echo_string
= build_string ("drag-mouse-1: resize");
24765 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24766 || part
== ON_SCROLL_BAR
)
24767 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24769 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24771 /* Are we in a window whose display is up to date?
24772 And verify the buffer's text has not changed. */
24773 b
= XBUFFER (w
->buffer
);
24774 if (part
== ON_TEXT
24775 && EQ (w
->window_end_valid
, w
->buffer
)
24776 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24777 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24779 int hpos
, vpos
, i
, dx
, dy
, area
;
24781 struct glyph
*glyph
;
24782 Lisp_Object object
;
24783 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24784 Lisp_Object
*overlay_vec
= NULL
;
24786 struct buffer
*obuf
;
24787 int obegv
, ozv
, same_region
;
24789 /* Find the glyph under X/Y. */
24790 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24792 /* Look for :pointer property on image. */
24793 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24795 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24796 if (img
!= NULL
&& IMAGEP (img
->spec
))
24798 Lisp_Object image_map
, hotspot
;
24799 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24801 && (hotspot
= find_hot_spot (image_map
,
24802 glyph
->slice
.x
+ dx
,
24803 glyph
->slice
.y
+ dy
),
24805 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24807 Lisp_Object area_id
, plist
;
24809 area_id
= XCAR (hotspot
);
24810 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24811 If so, we could look for mouse-enter, mouse-leave
24812 properties in PLIST (and do something...). */
24813 hotspot
= XCDR (hotspot
);
24814 if (CONSP (hotspot
)
24815 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24817 pointer
= Fplist_get (plist
, Qpointer
);
24818 if (NILP (pointer
))
24820 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24821 if (!NILP (help_echo_string
))
24823 help_echo_window
= window
;
24824 help_echo_object
= glyph
->object
;
24825 help_echo_pos
= glyph
->charpos
;
24829 if (NILP (pointer
))
24830 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24834 /* Clear mouse face if X/Y not over text. */
24836 || area
!= TEXT_AREA
24837 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24839 if (clear_mouse_face (dpyinfo
))
24840 cursor
= No_Cursor
;
24841 if (NILP (pointer
))
24843 if (area
!= TEXT_AREA
)
24844 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24846 pointer
= Vvoid_text_area_pointer
;
24851 pos
= glyph
->charpos
;
24852 object
= glyph
->object
;
24853 if (!STRINGP (object
) && !BUFFERP (object
))
24856 /* If we get an out-of-range value, return now; avoid an error. */
24857 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24860 /* Make the window's buffer temporarily current for
24861 overlays_at and compute_char_face. */
24862 obuf
= current_buffer
;
24863 current_buffer
= b
;
24869 /* Is this char mouse-active or does it have help-echo? */
24870 position
= make_number (pos
);
24872 if (BUFFERP (object
))
24874 /* Put all the overlays we want in a vector in overlay_vec. */
24875 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24876 /* Sort overlays into increasing priority order. */
24877 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24882 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24883 && vpos
>= dpyinfo
->mouse_face_beg_row
24884 && vpos
<= dpyinfo
->mouse_face_end_row
24885 && (vpos
> dpyinfo
->mouse_face_beg_row
24886 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24887 && (vpos
< dpyinfo
->mouse_face_end_row
24888 || hpos
< dpyinfo
->mouse_face_end_col
24889 || dpyinfo
->mouse_face_past_end
));
24892 cursor
= No_Cursor
;
24894 /* Check mouse-face highlighting. */
24896 /* If there exists an overlay with mouse-face overlapping
24897 the one we are currently highlighting, we have to
24898 check if we enter the overlapping overlay, and then
24899 highlight only that. */
24900 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24901 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24903 /* Find the highest priority overlay with a mouse-face. */
24905 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24907 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24908 if (!NILP (mouse_face
))
24909 overlay
= overlay_vec
[i
];
24912 /* If we're highlighting the same overlay as before, there's
24913 no need to do that again. */
24914 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24915 goto check_help_echo
;
24916 dpyinfo
->mouse_face_overlay
= overlay
;
24918 /* Clear the display of the old active region, if any. */
24919 if (clear_mouse_face (dpyinfo
))
24920 cursor
= No_Cursor
;
24922 /* If no overlay applies, get a text property. */
24923 if (NILP (overlay
))
24924 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24926 /* Next, compute the bounds of the mouse highlighting and
24928 if (!NILP (mouse_face
) && STRINGP (object
))
24930 /* The mouse-highlighting comes from a display string
24931 with a mouse-face. */
24935 b
= Fprevious_single_property_change
24936 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24937 e
= Fnext_single_property_change
24938 (position
, Qmouse_face
, object
, Qnil
);
24940 b
= make_number (0);
24942 e
= make_number (SCHARS (object
) - 1);
24944 fast_find_string_pos (w
, XINT (b
), object
,
24945 &dpyinfo
->mouse_face_beg_col
,
24946 &dpyinfo
->mouse_face_beg_row
,
24947 &dpyinfo
->mouse_face_beg_x
,
24948 &dpyinfo
->mouse_face_beg_y
, 0);
24949 fast_find_string_pos (w
, XINT (e
), object
,
24950 &dpyinfo
->mouse_face_end_col
,
24951 &dpyinfo
->mouse_face_end_row
,
24952 &dpyinfo
->mouse_face_end_x
,
24953 &dpyinfo
->mouse_face_end_y
, 1);
24954 dpyinfo
->mouse_face_past_end
= 0;
24955 dpyinfo
->mouse_face_window
= window
;
24956 dpyinfo
->mouse_face_face_id
24957 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24958 glyph
->face_id
, 1);
24959 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24960 cursor
= No_Cursor
;
24964 /* The mouse-highlighting, if any, comes from an overlay
24965 or text property in the buffer. */
24966 Lisp_Object buffer
, display_string
;
24968 if (STRINGP (object
))
24970 /* If we are on a display string with no mouse-face,
24971 check if the text under it has one. */
24972 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24973 int start
= MATRIX_ROW_START_CHARPOS (r
);
24974 pos
= string_buffer_position (w
, object
, start
);
24977 mouse_face
= get_char_property_and_overlay
24978 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24979 buffer
= w
->buffer
;
24980 display_string
= object
;
24986 display_string
= Qnil
;
24989 if (!NILP (mouse_face
))
24991 Lisp_Object before
, after
;
24992 Lisp_Object before_string
, after_string
;
24994 if (NILP (overlay
))
24996 /* Handle the text property case. */
24997 before
= Fprevious_single_property_change
24998 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24999 Fmarker_position (w
->start
));
25000 after
= Fnext_single_property_change
25001 (make_number (pos
), Qmouse_face
, buffer
,
25002 make_number (BUF_Z (XBUFFER (buffer
))
25003 - XFASTINT (w
->window_end_pos
)));
25004 before_string
= after_string
= Qnil
;
25008 /* Handle the overlay case. */
25009 before
= Foverlay_start (overlay
);
25010 after
= Foverlay_end (overlay
);
25011 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25012 after_string
= Foverlay_get (overlay
, Qafter_string
);
25014 if (!STRINGP (before_string
)) before_string
= Qnil
;
25015 if (!STRINGP (after_string
)) after_string
= Qnil
;
25018 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
25021 before_string
, after_string
,
25023 cursor
= No_Cursor
;
25030 /* Look for a `help-echo' property. */
25031 if (NILP (help_echo_string
)) {
25032 Lisp_Object help
, overlay
;
25034 /* Check overlays first. */
25035 help
= overlay
= Qnil
;
25036 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25038 overlay
= overlay_vec
[i
];
25039 help
= Foverlay_get (overlay
, Qhelp_echo
);
25044 help_echo_string
= help
;
25045 help_echo_window
= window
;
25046 help_echo_object
= overlay
;
25047 help_echo_pos
= pos
;
25051 Lisp_Object object
= glyph
->object
;
25052 int charpos
= glyph
->charpos
;
25054 /* Try text properties. */
25055 if (STRINGP (object
)
25057 && charpos
< SCHARS (object
))
25059 help
= Fget_text_property (make_number (charpos
),
25060 Qhelp_echo
, object
);
25063 /* If the string itself doesn't specify a help-echo,
25064 see if the buffer text ``under'' it does. */
25065 struct glyph_row
*r
25066 = MATRIX_ROW (w
->current_matrix
, vpos
);
25067 int start
= MATRIX_ROW_START_CHARPOS (r
);
25068 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
25071 help
= Fget_char_property (make_number (pos
),
25072 Qhelp_echo
, w
->buffer
);
25076 object
= w
->buffer
;
25081 else if (BUFFERP (object
)
25084 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25089 help_echo_string
= help
;
25090 help_echo_window
= window
;
25091 help_echo_object
= object
;
25092 help_echo_pos
= charpos
;
25097 /* Look for a `pointer' property. */
25098 if (NILP (pointer
))
25100 /* Check overlays first. */
25101 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25102 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25104 if (NILP (pointer
))
25106 Lisp_Object object
= glyph
->object
;
25107 int charpos
= glyph
->charpos
;
25109 /* Try text properties. */
25110 if (STRINGP (object
)
25112 && charpos
< SCHARS (object
))
25114 pointer
= Fget_text_property (make_number (charpos
),
25116 if (NILP (pointer
))
25118 /* If the string itself doesn't specify a pointer,
25119 see if the buffer text ``under'' it does. */
25120 struct glyph_row
*r
25121 = MATRIX_ROW (w
->current_matrix
, vpos
);
25122 int start
= MATRIX_ROW_START_CHARPOS (r
);
25123 EMACS_INT pos
= string_buffer_position (w
, object
,
25126 pointer
= Fget_char_property (make_number (pos
),
25127 Qpointer
, w
->buffer
);
25130 else if (BUFFERP (object
)
25133 pointer
= Fget_text_property (make_number (charpos
),
25140 current_buffer
= obuf
;
25145 define_frame_cursor1 (f
, cursor
, pointer
);
25150 Clear any mouse-face on window W. This function is part of the
25151 redisplay interface, and is called from try_window_id and similar
25152 functions to ensure the mouse-highlight is off. */
25155 x_clear_window_mouse_face (w
)
25158 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
25159 Lisp_Object window
;
25162 XSETWINDOW (window
, w
);
25163 if (EQ (window
, dpyinfo
->mouse_face_window
))
25164 clear_mouse_face (dpyinfo
);
25170 Just discard the mouse face information for frame F, if any.
25171 This is used when the size of F is changed. */
25174 cancel_mouse_face (f
)
25177 Lisp_Object window
;
25178 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25180 window
= dpyinfo
->mouse_face_window
;
25181 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25183 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
25184 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
25185 dpyinfo
->mouse_face_window
= Qnil
;
25190 #endif /* HAVE_WINDOW_SYSTEM */
25193 /***********************************************************************
25195 ***********************************************************************/
25197 #ifdef HAVE_WINDOW_SYSTEM
25199 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25200 which intersects rectangle R. R is in window-relative coordinates. */
25203 expose_area (w
, row
, r
, area
)
25205 struct glyph_row
*row
;
25207 enum glyph_row_area area
;
25209 struct glyph
*first
= row
->glyphs
[area
];
25210 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25211 struct glyph
*last
;
25212 int first_x
, start_x
, x
;
25214 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25215 /* If row extends face to end of line write the whole line. */
25216 draw_glyphs (w
, 0, row
, area
,
25217 0, row
->used
[area
],
25218 DRAW_NORMAL_TEXT
, 0);
25221 /* Set START_X to the window-relative start position for drawing glyphs of
25222 AREA. The first glyph of the text area can be partially visible.
25223 The first glyphs of other areas cannot. */
25224 start_x
= window_box_left_offset (w
, area
);
25226 if (area
== TEXT_AREA
)
25229 /* Find the first glyph that must be redrawn. */
25231 && x
+ first
->pixel_width
< r
->x
)
25233 x
+= first
->pixel_width
;
25237 /* Find the last one. */
25241 && x
< r
->x
+ r
->width
)
25243 x
+= last
->pixel_width
;
25249 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25250 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25251 DRAW_NORMAL_TEXT
, 0);
25256 /* Redraw the parts of the glyph row ROW on window W intersecting
25257 rectangle R. R is in window-relative coordinates. Value is
25258 non-zero if mouse-face was overwritten. */
25261 expose_line (w
, row
, r
)
25263 struct glyph_row
*row
;
25266 xassert (row
->enabled_p
);
25268 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25269 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25270 0, row
->used
[TEXT_AREA
],
25271 DRAW_NORMAL_TEXT
, 0);
25274 if (row
->used
[LEFT_MARGIN_AREA
])
25275 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25276 if (row
->used
[TEXT_AREA
])
25277 expose_area (w
, row
, r
, TEXT_AREA
);
25278 if (row
->used
[RIGHT_MARGIN_AREA
])
25279 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25280 draw_row_fringe_bitmaps (w
, row
);
25283 return row
->mouse_face_p
;
25287 /* Redraw those parts of glyphs rows during expose event handling that
25288 overlap other rows. Redrawing of an exposed line writes over parts
25289 of lines overlapping that exposed line; this function fixes that.
25291 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25292 row in W's current matrix that is exposed and overlaps other rows.
25293 LAST_OVERLAPPING_ROW is the last such row. */
25296 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
25298 struct glyph_row
*first_overlapping_row
;
25299 struct glyph_row
*last_overlapping_row
;
25302 struct glyph_row
*row
;
25304 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25305 if (row
->overlapping_p
)
25307 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25310 if (row
->used
[LEFT_MARGIN_AREA
])
25311 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25313 if (row
->used
[TEXT_AREA
])
25314 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25316 if (row
->used
[RIGHT_MARGIN_AREA
])
25317 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25323 /* Return non-zero if W's cursor intersects rectangle R. */
25326 phys_cursor_in_rect_p (w
, r
)
25330 XRectangle cr
, result
;
25331 struct glyph
*cursor_glyph
;
25332 struct glyph_row
*row
;
25334 if (w
->phys_cursor
.vpos
>= 0
25335 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25336 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25338 && row
->cursor_in_fringe_p
)
25340 /* Cursor is in the fringe. */
25341 cr
.x
= window_box_right_offset (w
,
25342 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25343 ? RIGHT_MARGIN_AREA
25346 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25347 cr
.height
= row
->height
;
25348 return x_intersect_rectangles (&cr
, r
, &result
);
25351 cursor_glyph
= get_phys_cursor_glyph (w
);
25354 /* r is relative to W's box, but w->phys_cursor.x is relative
25355 to left edge of W's TEXT area. Adjust it. */
25356 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25357 cr
.y
= w
->phys_cursor
.y
;
25358 cr
.width
= cursor_glyph
->pixel_width
;
25359 cr
.height
= w
->phys_cursor_height
;
25360 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25361 I assume the effect is the same -- and this is portable. */
25362 return x_intersect_rectangles (&cr
, r
, &result
);
25364 /* If we don't understand the format, pretend we're not in the hot-spot. */
25370 Draw a vertical window border to the right of window W if W doesn't
25371 have vertical scroll bars. */
25374 x_draw_vertical_border (w
)
25377 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25379 /* We could do better, if we knew what type of scroll-bar the adjacent
25380 windows (on either side) have... But we don't :-(
25381 However, I think this works ok. ++KFS 2003-04-25 */
25383 /* Redraw borders between horizontally adjacent windows. Don't
25384 do it for frames with vertical scroll bars because either the
25385 right scroll bar of a window, or the left scroll bar of its
25386 neighbor will suffice as a border. */
25387 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25390 if (!WINDOW_RIGHTMOST_P (w
)
25391 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25393 int x0
, x1
, y0
, y1
;
25395 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25398 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25401 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25403 else if (!WINDOW_LEFTMOST_P (w
)
25404 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25406 int x0
, x1
, y0
, y1
;
25408 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25411 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25414 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25419 /* Redraw the part of window W intersection rectangle FR. Pixel
25420 coordinates in FR are frame-relative. Call this function with
25421 input blocked. Value is non-zero if the exposure overwrites
25425 expose_window (w
, fr
)
25429 struct frame
*f
= XFRAME (w
->frame
);
25431 int mouse_face_overwritten_p
= 0;
25433 /* If window is not yet fully initialized, do nothing. This can
25434 happen when toolkit scroll bars are used and a window is split.
25435 Reconfiguring the scroll bar will generate an expose for a newly
25437 if (w
->current_matrix
== NULL
)
25440 /* When we're currently updating the window, display and current
25441 matrix usually don't agree. Arrange for a thorough display
25443 if (w
== updated_window
)
25445 SET_FRAME_GARBAGED (f
);
25449 /* Frame-relative pixel rectangle of W. */
25450 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25451 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25452 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25453 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25455 if (x_intersect_rectangles (fr
, &wr
, &r
))
25457 int yb
= window_text_bottom_y (w
);
25458 struct glyph_row
*row
;
25459 int cursor_cleared_p
;
25460 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25462 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25463 r
.x
, r
.y
, r
.width
, r
.height
));
25465 /* Convert to window coordinates. */
25466 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25467 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25469 /* Turn off the cursor. */
25470 if (!w
->pseudo_window_p
25471 && phys_cursor_in_rect_p (w
, &r
))
25473 x_clear_cursor (w
);
25474 cursor_cleared_p
= 1;
25477 cursor_cleared_p
= 0;
25479 /* Update lines intersecting rectangle R. */
25480 first_overlapping_row
= last_overlapping_row
= NULL
;
25481 for (row
= w
->current_matrix
->rows
;
25486 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25488 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25489 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25490 || (r
.y
>= y0
&& r
.y
< y1
)
25491 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25493 /* A header line may be overlapping, but there is no need
25494 to fix overlapping areas for them. KFS 2005-02-12 */
25495 if (row
->overlapping_p
&& !row
->mode_line_p
)
25497 if (first_overlapping_row
== NULL
)
25498 first_overlapping_row
= row
;
25499 last_overlapping_row
= row
;
25503 if (expose_line (w
, row
, &r
))
25504 mouse_face_overwritten_p
= 1;
25507 else if (row
->overlapping_p
)
25509 /* We must redraw a row overlapping the exposed area. */
25511 ? y0
+ row
->phys_height
> r
.y
25512 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25514 if (first_overlapping_row
== NULL
)
25515 first_overlapping_row
= row
;
25516 last_overlapping_row
= row
;
25524 /* Display the mode line if there is one. */
25525 if (WINDOW_WANTS_MODELINE_P (w
)
25526 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25528 && row
->y
< r
.y
+ r
.height
)
25530 if (expose_line (w
, row
, &r
))
25531 mouse_face_overwritten_p
= 1;
25534 if (!w
->pseudo_window_p
)
25536 /* Fix the display of overlapping rows. */
25537 if (first_overlapping_row
)
25538 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25541 /* Draw border between windows. */
25542 x_draw_vertical_border (w
);
25544 /* Turn the cursor on again. */
25545 if (cursor_cleared_p
)
25546 update_window_cursor (w
, 1);
25550 return mouse_face_overwritten_p
;
25555 /* Redraw (parts) of all windows in the window tree rooted at W that
25556 intersect R. R contains frame pixel coordinates. Value is
25557 non-zero if the exposure overwrites mouse-face. */
25560 expose_window_tree (w
, r
)
25564 struct frame
*f
= XFRAME (w
->frame
);
25565 int mouse_face_overwritten_p
= 0;
25567 while (w
&& !FRAME_GARBAGED_P (f
))
25569 if (!NILP (w
->hchild
))
25570 mouse_face_overwritten_p
25571 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25572 else if (!NILP (w
->vchild
))
25573 mouse_face_overwritten_p
25574 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25576 mouse_face_overwritten_p
|= expose_window (w
, r
);
25578 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25581 return mouse_face_overwritten_p
;
25586 Redisplay an exposed area of frame F. X and Y are the upper-left
25587 corner of the exposed rectangle. W and H are width and height of
25588 the exposed area. All are pixel values. W or H zero means redraw
25589 the entire frame. */
25592 expose_frame (f
, x
, y
, w
, h
)
25597 int mouse_face_overwritten_p
= 0;
25599 TRACE ((stderr
, "expose_frame "));
25601 /* No need to redraw if frame will be redrawn soon. */
25602 if (FRAME_GARBAGED_P (f
))
25604 TRACE ((stderr
, " garbaged\n"));
25608 /* If basic faces haven't been realized yet, there is no point in
25609 trying to redraw anything. This can happen when we get an expose
25610 event while Emacs is starting, e.g. by moving another window. */
25611 if (FRAME_FACE_CACHE (f
) == NULL
25612 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25614 TRACE ((stderr
, " no faces\n"));
25618 if (w
== 0 || h
== 0)
25621 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25622 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25632 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25633 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25635 if (WINDOWP (f
->tool_bar_window
))
25636 mouse_face_overwritten_p
25637 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25639 #ifdef HAVE_X_WINDOWS
25641 #ifndef USE_X_TOOLKIT
25642 if (WINDOWP (f
->menu_bar_window
))
25643 mouse_face_overwritten_p
25644 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25645 #endif /* not USE_X_TOOLKIT */
25649 /* Some window managers support a focus-follows-mouse style with
25650 delayed raising of frames. Imagine a partially obscured frame,
25651 and moving the mouse into partially obscured mouse-face on that
25652 frame. The visible part of the mouse-face will be highlighted,
25653 then the WM raises the obscured frame. With at least one WM, KDE
25654 2.1, Emacs is not getting any event for the raising of the frame
25655 (even tried with SubstructureRedirectMask), only Expose events.
25656 These expose events will draw text normally, i.e. not
25657 highlighted. Which means we must redo the highlight here.
25658 Subsume it under ``we love X''. --gerd 2001-08-15 */
25659 /* Included in Windows version because Windows most likely does not
25660 do the right thing if any third party tool offers
25661 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25662 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25664 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25665 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25667 int x
= dpyinfo
->mouse_face_mouse_x
;
25668 int y
= dpyinfo
->mouse_face_mouse_y
;
25669 clear_mouse_face (dpyinfo
);
25670 note_mouse_highlight (f
, x
, y
);
25677 Determine the intersection of two rectangles R1 and R2. Return
25678 the intersection in *RESULT. Value is non-zero if RESULT is not
25682 x_intersect_rectangles (r1
, r2
, result
)
25683 XRectangle
*r1
, *r2
, *result
;
25685 XRectangle
*left
, *right
;
25686 XRectangle
*upper
, *lower
;
25687 int intersection_p
= 0;
25689 /* Rearrange so that R1 is the left-most rectangle. */
25691 left
= r1
, right
= r2
;
25693 left
= r2
, right
= r1
;
25695 /* X0 of the intersection is right.x0, if this is inside R1,
25696 otherwise there is no intersection. */
25697 if (right
->x
<= left
->x
+ left
->width
)
25699 result
->x
= right
->x
;
25701 /* The right end of the intersection is the minimum of the
25702 the right ends of left and right. */
25703 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25706 /* Same game for Y. */
25708 upper
= r1
, lower
= r2
;
25710 upper
= r2
, lower
= r1
;
25712 /* The upper end of the intersection is lower.y0, if this is inside
25713 of upper. Otherwise, there is no intersection. */
25714 if (lower
->y
<= upper
->y
+ upper
->height
)
25716 result
->y
= lower
->y
;
25718 /* The lower end of the intersection is the minimum of the lower
25719 ends of upper and lower. */
25720 result
->height
= (min (lower
->y
+ lower
->height
,
25721 upper
->y
+ upper
->height
)
25723 intersection_p
= 1;
25727 return intersection_p
;
25730 #endif /* HAVE_WINDOW_SYSTEM */
25733 /***********************************************************************
25735 ***********************************************************************/
25740 Vwith_echo_area_save_vector
= Qnil
;
25741 staticpro (&Vwith_echo_area_save_vector
);
25743 Vmessage_stack
= Qnil
;
25744 staticpro (&Vmessage_stack
);
25746 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25747 staticpro (&Qinhibit_redisplay
);
25749 message_dolog_marker1
= Fmake_marker ();
25750 staticpro (&message_dolog_marker1
);
25751 message_dolog_marker2
= Fmake_marker ();
25752 staticpro (&message_dolog_marker2
);
25753 message_dolog_marker3
= Fmake_marker ();
25754 staticpro (&message_dolog_marker3
);
25757 defsubr (&Sdump_frame_glyph_matrix
);
25758 defsubr (&Sdump_glyph_matrix
);
25759 defsubr (&Sdump_glyph_row
);
25760 defsubr (&Sdump_tool_bar_row
);
25761 defsubr (&Strace_redisplay
);
25762 defsubr (&Strace_to_stderr
);
25764 #ifdef HAVE_WINDOW_SYSTEM
25765 defsubr (&Stool_bar_lines_needed
);
25766 defsubr (&Slookup_image_map
);
25768 defsubr (&Sformat_mode_line
);
25769 defsubr (&Sinvisible_p
);
25771 staticpro (&Qmenu_bar_update_hook
);
25772 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25774 staticpro (&Qoverriding_terminal_local_map
);
25775 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25777 staticpro (&Qoverriding_local_map
);
25778 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25780 staticpro (&Qwindow_scroll_functions
);
25781 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25783 staticpro (&Qwindow_text_change_functions
);
25784 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25786 staticpro (&Qredisplay_end_trigger_functions
);
25787 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25789 staticpro (&Qinhibit_point_motion_hooks
);
25790 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25792 Qeval
= intern_c_string ("eval");
25793 staticpro (&Qeval
);
25795 QCdata
= intern_c_string (":data");
25796 staticpro (&QCdata
);
25797 Qdisplay
= intern_c_string ("display");
25798 staticpro (&Qdisplay
);
25799 Qspace_width
= intern_c_string ("space-width");
25800 staticpro (&Qspace_width
);
25801 Qraise
= intern_c_string ("raise");
25802 staticpro (&Qraise
);
25803 Qslice
= intern_c_string ("slice");
25804 staticpro (&Qslice
);
25805 Qspace
= intern_c_string ("space");
25806 staticpro (&Qspace
);
25807 Qmargin
= intern_c_string ("margin");
25808 staticpro (&Qmargin
);
25809 Qpointer
= intern_c_string ("pointer");
25810 staticpro (&Qpointer
);
25811 Qleft_margin
= intern_c_string ("left-margin");
25812 staticpro (&Qleft_margin
);
25813 Qright_margin
= intern_c_string ("right-margin");
25814 staticpro (&Qright_margin
);
25815 Qcenter
= intern_c_string ("center");
25816 staticpro (&Qcenter
);
25817 Qline_height
= intern_c_string ("line-height");
25818 staticpro (&Qline_height
);
25819 QCalign_to
= intern_c_string (":align-to");
25820 staticpro (&QCalign_to
);
25821 QCrelative_width
= intern_c_string (":relative-width");
25822 staticpro (&QCrelative_width
);
25823 QCrelative_height
= intern_c_string (":relative-height");
25824 staticpro (&QCrelative_height
);
25825 QCeval
= intern_c_string (":eval");
25826 staticpro (&QCeval
);
25827 QCpropertize
= intern_c_string (":propertize");
25828 staticpro (&QCpropertize
);
25829 QCfile
= intern_c_string (":file");
25830 staticpro (&QCfile
);
25831 Qfontified
= intern_c_string ("fontified");
25832 staticpro (&Qfontified
);
25833 Qfontification_functions
= intern_c_string ("fontification-functions");
25834 staticpro (&Qfontification_functions
);
25835 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25836 staticpro (&Qtrailing_whitespace
);
25837 Qescape_glyph
= intern_c_string ("escape-glyph");
25838 staticpro (&Qescape_glyph
);
25839 Qnobreak_space
= intern_c_string ("nobreak-space");
25840 staticpro (&Qnobreak_space
);
25841 Qimage
= intern_c_string ("image");
25842 staticpro (&Qimage
);
25843 Qtext
= intern_c_string ("text");
25844 staticpro (&Qtext
);
25845 Qboth
= intern_c_string ("both");
25846 staticpro (&Qboth
);
25847 Qboth_horiz
= intern_c_string ("both-horiz");
25848 staticpro (&Qboth_horiz
);
25849 QCmap
= intern_c_string (":map");
25850 staticpro (&QCmap
);
25851 QCpointer
= intern_c_string (":pointer");
25852 staticpro (&QCpointer
);
25853 Qrect
= intern_c_string ("rect");
25854 staticpro (&Qrect
);
25855 Qcircle
= intern_c_string ("circle");
25856 staticpro (&Qcircle
);
25857 Qpoly
= intern_c_string ("poly");
25858 staticpro (&Qpoly
);
25859 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25860 staticpro (&Qmessage_truncate_lines
);
25861 Qgrow_only
= intern_c_string ("grow-only");
25862 staticpro (&Qgrow_only
);
25863 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25864 staticpro (&Qinhibit_menubar_update
);
25865 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25866 staticpro (&Qinhibit_eval_during_redisplay
);
25867 Qposition
= intern_c_string ("position");
25868 staticpro (&Qposition
);
25869 Qbuffer_position
= intern_c_string ("buffer-position");
25870 staticpro (&Qbuffer_position
);
25871 Qobject
= intern_c_string ("object");
25872 staticpro (&Qobject
);
25873 Qbar
= intern_c_string ("bar");
25875 Qhbar
= intern_c_string ("hbar");
25876 staticpro (&Qhbar
);
25877 Qbox
= intern_c_string ("box");
25879 Qhollow
= intern_c_string ("hollow");
25880 staticpro (&Qhollow
);
25881 Qhand
= intern_c_string ("hand");
25882 staticpro (&Qhand
);
25883 Qarrow
= intern_c_string ("arrow");
25884 staticpro (&Qarrow
);
25885 Qtext
= intern_c_string ("text");
25886 staticpro (&Qtext
);
25887 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25888 staticpro (&Qrisky_local_variable
);
25889 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25890 staticpro (&Qinhibit_free_realized_faces
);
25892 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25893 Fcons (intern_c_string ("void-variable"), Qnil
)),
25895 staticpro (&list_of_error
);
25897 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25898 staticpro (&Qlast_arrow_position
);
25899 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25900 staticpro (&Qlast_arrow_string
);
25902 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25903 staticpro (&Qoverlay_arrow_string
);
25904 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25905 staticpro (&Qoverlay_arrow_bitmap
);
25907 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25908 staticpro (&echo_buffer
[0]);
25909 staticpro (&echo_buffer
[1]);
25911 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25912 staticpro (&echo_area_buffer
[0]);
25913 staticpro (&echo_area_buffer
[1]);
25915 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25916 staticpro (&Vmessages_buffer_name
);
25918 mode_line_proptrans_alist
= Qnil
;
25919 staticpro (&mode_line_proptrans_alist
);
25920 mode_line_string_list
= Qnil
;
25921 staticpro (&mode_line_string_list
);
25922 mode_line_string_face
= Qnil
;
25923 staticpro (&mode_line_string_face
);
25924 mode_line_string_face_prop
= Qnil
;
25925 staticpro (&mode_line_string_face_prop
);
25926 Vmode_line_unwind_vector
= Qnil
;
25927 staticpro (&Vmode_line_unwind_vector
);
25929 help_echo_string
= Qnil
;
25930 staticpro (&help_echo_string
);
25931 help_echo_object
= Qnil
;
25932 staticpro (&help_echo_object
);
25933 help_echo_window
= Qnil
;
25934 staticpro (&help_echo_window
);
25935 previous_help_echo_string
= Qnil
;
25936 staticpro (&previous_help_echo_string
);
25937 help_echo_pos
= -1;
25939 Qright_to_left
= intern_c_string ("right-to-left");
25940 staticpro (&Qright_to_left
);
25941 Qleft_to_right
= intern_c_string ("left-to-right");
25942 staticpro (&Qleft_to_right
);
25944 #ifdef HAVE_WINDOW_SYSTEM
25945 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25946 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25947 For example, if a block cursor is over a tab, it will be drawn as
25948 wide as that tab on the display. */);
25949 x_stretch_cursor_p
= 0;
25952 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25953 doc
: /* *Non-nil means highlight trailing whitespace.
25954 The face used for trailing whitespace is `trailing-whitespace'. */);
25955 Vshow_trailing_whitespace
= Qnil
;
25957 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25958 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25959 A value of t means highlight the character itself (for nobreak space,
25960 use face `nobreak-space').
25961 A value of nil means no highlighting.
25962 Other values mean display the escape glyph followed by an ordinary
25963 space or ordinary hyphen. */);
25964 Vnobreak_char_display
= Qt
;
25966 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25967 doc
: /* *The pointer shape to show in void text areas.
25968 A value of nil means to show the text pointer. Other options are `arrow',
25969 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25970 Vvoid_text_area_pointer
= Qarrow
;
25972 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25973 doc
: /* Non-nil means don't actually do any redisplay.
25974 This is used for internal purposes. */);
25975 Vinhibit_redisplay
= Qnil
;
25977 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25978 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25979 Vglobal_mode_string
= Qnil
;
25981 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25982 doc
: /* Marker for where to display an arrow on top of the buffer text.
25983 This must be the beginning of a line in order to work.
25984 See also `overlay-arrow-string'. */);
25985 Voverlay_arrow_position
= Qnil
;
25987 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25988 doc
: /* String to display as an arrow in non-window frames.
25989 See also `overlay-arrow-position'. */);
25990 Voverlay_arrow_string
= make_pure_c_string ("=>");
25992 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25993 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25994 The symbols on this list are examined during redisplay to determine
25995 where to display overlay arrows. */);
25996 Voverlay_arrow_variable_list
25997 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25999 DEFVAR_INT ("scroll-step", &scroll_step
,
26000 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26001 If that fails to bring point back on frame, point is centered instead.
26002 If this is zero, point is always centered after it moves off frame.
26003 If you want scrolling to always be a line at a time, you should set
26004 `scroll-conservatively' to a large value rather than set this to 1. */);
26006 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
26007 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26008 If point moves off-screen, redisplay will scroll by up to
26009 `scroll-conservatively' lines in order to bring point just barely
26010 onto the screen again. If that cannot be done, then redisplay
26011 recenters point as usual.
26013 A value of zero means always recenter point if it moves off screen. */);
26014 scroll_conservatively
= 0;
26016 DEFVAR_INT ("scroll-margin", &scroll_margin
,
26017 doc
: /* *Number of lines of margin at the top and bottom of a window.
26018 Recenter the window whenever point gets within this many lines
26019 of the top or bottom of the window. */);
26022 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
26023 doc
: /* Pixels per inch value for non-window system displays.
26024 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26025 Vdisplay_pixels_per_inch
= make_float (72.0);
26028 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
26031 DEFVAR_LISP ("truncate-partial-width-windows",
26032 &Vtruncate_partial_width_windows
,
26033 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26034 For an integer value, truncate lines in each window narrower than the
26035 full frame width, provided the window width is less than that integer;
26036 otherwise, respect the value of `truncate-lines'.
26038 For any other non-nil value, truncate lines in all windows that do
26039 not span the full frame width.
26041 A value of nil means to respect the value of `truncate-lines'.
26043 If `word-wrap' is enabled, you might want to reduce this. */);
26044 Vtruncate_partial_width_windows
= make_number (50);
26046 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
26047 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26048 Any other value means to use the appropriate face, `mode-line',
26049 `header-line', or `menu' respectively. */);
26050 mode_line_inverse_video
= 1;
26052 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
26053 doc
: /* *Maximum buffer size for which line number should be displayed.
26054 If the buffer is bigger than this, the line number does not appear
26055 in the mode line. A value of nil means no limit. */);
26056 Vline_number_display_limit
= Qnil
;
26058 DEFVAR_INT ("line-number-display-limit-width",
26059 &line_number_display_limit_width
,
26060 doc
: /* *Maximum line width (in characters) for line number display.
26061 If the average length of the lines near point is bigger than this, then the
26062 line number may be omitted from the mode line. */);
26063 line_number_display_limit_width
= 200;
26065 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
26066 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26067 highlight_nonselected_windows
= 0;
26069 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
26070 doc
: /* Non-nil if more than one frame is visible on this display.
26071 Minibuffer-only frames don't count, but iconified frames do.
26072 This variable is not guaranteed to be accurate except while processing
26073 `frame-title-format' and `icon-title-format'. */);
26075 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
26076 doc
: /* Template for displaying the title bar of visible frames.
26077 \(Assuming the window manager supports this feature.)
26079 This variable has the same structure as `mode-line-format', except that
26080 the %c and %l constructs are ignored. It is used only on frames for
26081 which no explicit name has been set \(see `modify-frame-parameters'). */);
26083 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
26084 doc
: /* Template for displaying the title bar of an iconified frame.
26085 \(Assuming the window manager supports this feature.)
26086 This variable has the same structure as `mode-line-format' (which see),
26087 and is used only on frames for which no explicit name has been set
26088 \(see `modify-frame-parameters'). */);
26090 = Vframe_title_format
26091 = pure_cons (intern_c_string ("multiple-frames"),
26092 pure_cons (make_pure_c_string ("%b"),
26093 pure_cons (pure_cons (empty_unibyte_string
,
26094 pure_cons (intern_c_string ("invocation-name"),
26095 pure_cons (make_pure_c_string ("@"),
26096 pure_cons (intern_c_string ("system-name"),
26100 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
26101 doc
: /* Maximum number of lines to keep in the message log buffer.
26102 If nil, disable message logging. If t, log messages but don't truncate
26103 the buffer when it becomes large. */);
26104 Vmessage_log_max
= make_number (100);
26106 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
26107 doc
: /* Functions called before redisplay, if window sizes have changed.
26108 The value should be a list of functions that take one argument.
26109 Just before redisplay, for each frame, if any of its windows have changed
26110 size since the last redisplay, or have been split or deleted,
26111 all the functions in the list are called, with the frame as argument. */);
26112 Vwindow_size_change_functions
= Qnil
;
26114 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
26115 doc
: /* List of functions to call before redisplaying a window with scrolling.
26116 Each function is called with two arguments, the window and its new
26117 display-start position. Note that these functions are also called by
26118 `set-window-buffer'. Also note that the value of `window-end' is not
26119 valid when these functions are called. */);
26120 Vwindow_scroll_functions
= Qnil
;
26122 DEFVAR_LISP ("window-text-change-functions",
26123 &Vwindow_text_change_functions
,
26124 doc
: /* Functions to call in redisplay when text in the window might change. */);
26125 Vwindow_text_change_functions
= Qnil
;
26127 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
26128 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26129 Each function is called with two arguments, the window and the end trigger value.
26130 See `set-window-redisplay-end-trigger'. */);
26131 Vredisplay_end_trigger_functions
= Qnil
;
26133 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
26134 doc
: /* *Non-nil means autoselect window with mouse pointer.
26135 If nil, do not autoselect windows.
26136 A positive number means delay autoselection by that many seconds: a
26137 window is autoselected only after the mouse has remained in that
26138 window for the duration of the delay.
26139 A negative number has a similar effect, but causes windows to be
26140 autoselected only after the mouse has stopped moving. \(Because of
26141 the way Emacs compares mouse events, you will occasionally wait twice
26142 that time before the window gets selected.\)
26143 Any other value means to autoselect window instantaneously when the
26144 mouse pointer enters it.
26146 Autoselection selects the minibuffer only if it is active, and never
26147 unselects the minibuffer if it is active.
26149 When customizing this variable make sure that the actual value of
26150 `focus-follows-mouse' matches the behavior of your window manager. */);
26151 Vmouse_autoselect_window
= Qnil
;
26153 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
26154 doc
: /* *Non-nil means automatically resize tool-bars.
26155 This dynamically changes the tool-bar's height to the minimum height
26156 that is needed to make all tool-bar items visible.
26157 If value is `grow-only', the tool-bar's height is only increased
26158 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26159 Vauto_resize_tool_bars
= Qt
;
26161 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
26162 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26163 auto_raise_tool_bar_buttons_p
= 1;
26165 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
26166 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26167 make_cursor_line_fully_visible_p
= 1;
26169 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
26170 doc
: /* *Border below tool-bar in pixels.
26171 If an integer, use it as the height of the border.
26172 If it is one of `internal-border-width' or `border-width', use the
26173 value of the corresponding frame parameter.
26174 Otherwise, no border is added below the tool-bar. */);
26175 Vtool_bar_border
= Qinternal_border_width
;
26177 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
26178 doc
: /* *Margin around tool-bar buttons in pixels.
26179 If an integer, use that for both horizontal and vertical margins.
26180 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26181 HORZ specifying the horizontal margin, and VERT specifying the
26182 vertical margin. */);
26183 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26185 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
26186 doc
: /* *Relief thickness of tool-bar buttons. */);
26187 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26189 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
26190 doc
: /* *Tool bar style to use.
26192 image - show images only
26193 text - show text only
26194 both - show both, text under image
26195 both-horiz - show text to the right of the image
26196 any other - use system default or image if no system default. */);
26197 Vtool_bar_style
= Qnil
;
26199 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
26200 doc
: /* *Maximum number of characters a label can have to be shown.
26201 The tool bar style must also show labels for this to have any effect, see
26202 `tool-bar-style'. */);
26203 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26205 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
26206 doc
: /* List of functions to call to fontify regions of text.
26207 Each function is called with one argument POS. Functions must
26208 fontify a region starting at POS in the current buffer, and give
26209 fontified regions the property `fontified'. */);
26210 Vfontification_functions
= Qnil
;
26211 Fmake_variable_buffer_local (Qfontification_functions
);
26213 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26214 &unibyte_display_via_language_environment
,
26215 doc
: /* *Non-nil means display unibyte text according to language environment.
26216 Specifically, this means that raw bytes in the range 160-255 decimal
26217 are displayed by converting them to the equivalent multibyte characters
26218 according to the current language environment. As a result, they are
26219 displayed according to the current fontset.
26221 Note that this variable affects only how these bytes are displayed,
26222 but does not change the fact they are interpreted as raw bytes. */);
26223 unibyte_display_via_language_environment
= 0;
26225 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
26226 doc
: /* *Maximum height for resizing mini-windows.
26227 If a float, it specifies a fraction of the mini-window frame's height.
26228 If an integer, it specifies a number of lines. */);
26229 Vmax_mini_window_height
= make_float (0.25);
26231 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
26232 doc
: /* *How to resize mini-windows.
26233 A value of nil means don't automatically resize mini-windows.
26234 A value of t means resize them to fit the text displayed in them.
26235 A value of `grow-only', the default, means let mini-windows grow
26236 only, until their display becomes empty, at which point the windows
26237 go back to their normal size. */);
26238 Vresize_mini_windows
= Qgrow_only
;
26240 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
26241 doc
: /* Alist specifying how to blink the cursor off.
26242 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26243 `cursor-type' frame-parameter or variable equals ON-STATE,
26244 comparing using `equal', Emacs uses OFF-STATE to specify
26245 how to blink it off. ON-STATE and OFF-STATE are values for
26246 the `cursor-type' frame parameter.
26248 If a frame's ON-STATE has no entry in this list,
26249 the frame's other specifications determine how to blink the cursor off. */);
26250 Vblink_cursor_alist
= Qnil
;
26252 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
26253 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
26254 automatic_hscrolling_p
= 1;
26255 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26256 staticpro (&Qauto_hscroll_mode
);
26258 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
26259 doc
: /* *How many columns away from the window edge point is allowed to get
26260 before automatic hscrolling will horizontally scroll the window. */);
26261 hscroll_margin
= 5;
26263 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
26264 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26265 When point is less than `hscroll-margin' columns from the window
26266 edge, automatic hscrolling will scroll the window by the amount of columns
26267 determined by this variable. If its value is a positive integer, scroll that
26268 many columns. If it's a positive floating-point number, it specifies the
26269 fraction of the window's width to scroll. If it's nil or zero, point will be
26270 centered horizontally after the scroll. Any other value, including negative
26271 numbers, are treated as if the value were zero.
26273 Automatic hscrolling always moves point outside the scroll margin, so if
26274 point was more than scroll step columns inside the margin, the window will
26275 scroll more than the value given by the scroll step.
26277 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26278 and `scroll-right' overrides this variable's effect. */);
26279 Vhscroll_step
= make_number (0);
26281 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
26282 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26283 Bind this around calls to `message' to let it take effect. */);
26284 message_truncate_lines
= 0;
26286 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
26287 doc
: /* Normal hook run to update the menu bar definitions.
26288 Redisplay runs this hook before it redisplays the menu bar.
26289 This is used to update submenus such as Buffers,
26290 whose contents depend on various data. */);
26291 Vmenu_bar_update_hook
= Qnil
;
26293 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26294 doc
: /* Frame for which we are updating a menu.
26295 The enable predicate for a menu binding should check this variable. */);
26296 Vmenu_updating_frame
= Qnil
;
26298 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26299 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26300 inhibit_menubar_update
= 0;
26302 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26303 doc
: /* Prefix prepended to all continuation lines at display time.
26304 The value may be a string, an image, or a stretch-glyph; it is
26305 interpreted in the same way as the value of a `display' text property.
26307 This variable is overridden by any `wrap-prefix' text or overlay
26310 To add a prefix to non-continuation lines, use `line-prefix'. */);
26311 Vwrap_prefix
= Qnil
;
26312 staticpro (&Qwrap_prefix
);
26313 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26314 Fmake_variable_buffer_local (Qwrap_prefix
);
26316 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26317 doc
: /* Prefix prepended to all non-continuation lines at display time.
26318 The value may be a string, an image, or a stretch-glyph; it is
26319 interpreted in the same way as the value of a `display' text property.
26321 This variable is overridden by any `line-prefix' text or overlay
26324 To add a prefix to continuation lines, use `wrap-prefix'. */);
26325 Vline_prefix
= Qnil
;
26326 staticpro (&Qline_prefix
);
26327 Qline_prefix
= intern_c_string ("line-prefix");
26328 Fmake_variable_buffer_local (Qline_prefix
);
26330 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26331 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26332 inhibit_eval_during_redisplay
= 0;
26334 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26335 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26336 inhibit_free_realized_faces
= 0;
26339 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26340 doc
: /* Inhibit try_window_id display optimization. */);
26341 inhibit_try_window_id
= 0;
26343 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26344 doc
: /* Inhibit try_window_reusing display optimization. */);
26345 inhibit_try_window_reusing
= 0;
26347 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26348 doc
: /* Inhibit try_cursor_movement display optimization. */);
26349 inhibit_try_cursor_movement
= 0;
26350 #endif /* GLYPH_DEBUG */
26352 DEFVAR_INT ("overline-margin", &overline_margin
,
26353 doc
: /* *Space between overline and text, in pixels.
26354 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26355 margin to the caracter height. */);
26356 overline_margin
= 2;
26358 DEFVAR_INT ("underline-minimum-offset",
26359 &underline_minimum_offset
,
26360 doc
: /* Minimum distance between baseline and underline.
26361 This can improve legibility of underlined text at small font sizes,
26362 particularly when using variable `x-use-underline-position-properties'
26363 with fonts that specify an UNDERLINE_POSITION relatively close to the
26364 baseline. The default value is 1. */);
26365 underline_minimum_offset
= 1;
26367 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26368 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26369 display_hourglass_p
= 1;
26371 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26372 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26373 Value must be an integer or float. */);
26374 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26376 hourglass_atimer
= NULL
;
26377 hourglass_shown_p
= 0;
26381 /* Initialize this module when Emacs starts. */
26386 Lisp_Object root_window
;
26387 struct window
*mini_w
;
26389 current_header_line_height
= current_mode_line_height
= -1;
26391 CHARPOS (this_line_start_pos
) = 0;
26393 mini_w
= XWINDOW (minibuf_window
);
26394 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26396 if (!noninteractive
)
26398 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26401 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26402 set_window_height (root_window
,
26403 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26405 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26406 set_window_height (minibuf_window
, 1, 0);
26408 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26409 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26411 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26412 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26413 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26415 /* The default ellipsis glyphs `...'. */
26416 for (i
= 0; i
< 3; ++i
)
26417 default_invis_vector
[i
] = make_number ('.');
26421 /* Allocate the buffer for frame titles.
26422 Also used for `format-mode-line'. */
26424 mode_line_noprop_buf
= (char *) xmalloc (size
);
26425 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26426 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26427 mode_line_target
= MODE_LINE_DISPLAY
;
26430 help_echo_showing_p
= 0;
26433 /* Since w32 does not support atimers, it defines its own implementation of
26434 the following three functions in w32fns.c. */
26437 /* Platform-independent portion of hourglass implementation. */
26439 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26441 hourglass_started ()
26443 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26446 /* Cancel a currently active hourglass timer, and start a new one. */
26450 #if defined (HAVE_WINDOW_SYSTEM)
26452 int secs
, usecs
= 0;
26454 cancel_hourglass ();
26456 if (INTEGERP (Vhourglass_delay
)
26457 && XINT (Vhourglass_delay
) > 0)
26458 secs
= XFASTINT (Vhourglass_delay
);
26459 else if (FLOATP (Vhourglass_delay
)
26460 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26463 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26464 secs
= XFASTINT (tem
);
26465 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26468 secs
= DEFAULT_HOURGLASS_DELAY
;
26470 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26471 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26472 show_hourglass
, NULL
);
26477 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26480 cancel_hourglass ()
26482 #if defined (HAVE_WINDOW_SYSTEM)
26483 if (hourglass_atimer
)
26485 cancel_atimer (hourglass_atimer
);
26486 hourglass_atimer
= NULL
;
26489 if (hourglass_shown_p
)
26493 #endif /* ! WINDOWSNT */
26495 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26496 (do not change this comment) */