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 iterate_out_of_display_property (it
)
5266 /* Maybe initialize paragraph direction. If we are at the beginning
5267 of a new paragraph, next_element_from_buffer may not have a
5268 chance to do that. */
5269 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5270 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
5271 /* prev_stop can be zero, so check against BEGV as well. */
5272 while (it
->bidi_it
.charpos
>= BEGV
5273 && it
->prev_stop
<= it
->bidi_it
.charpos
5274 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5275 bidi_get_next_char_visually (&it
->bidi_it
);
5276 /* Record the stop_pos we just crossed, for when we cross it
5278 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5279 it
->prev_stop
= CHARPOS (it
->position
);
5280 /* If we ended up not where pop_it put us, resync IT's
5281 positional members with the bidi iterator. */
5282 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5284 SET_TEXT_POS (it
->position
,
5285 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5286 it
->current
.pos
= it
->position
;
5290 /* Restore IT's settings from IT->stack. Called, for example, when no
5291 more overlay strings must be processed, and we return to delivering
5292 display elements from a buffer, or when the end of a string from a
5293 `display' property is reached and we return to delivering display
5294 elements from an overlay string, or from a buffer. */
5300 struct iterator_stack_entry
*p
;
5302 xassert (it
->sp
> 0);
5304 p
= it
->stack
+ it
->sp
;
5305 it
->stop_charpos
= p
->stop_charpos
;
5306 it
->prev_stop
= p
->prev_stop
;
5307 it
->base_level_stop
= p
->base_level_stop
;
5308 it
->cmp_it
= p
->cmp_it
;
5309 it
->face_id
= p
->face_id
;
5310 it
->current
= p
->current
;
5311 it
->position
= p
->position
;
5312 it
->string
= p
->string
;
5313 it
->from_overlay
= p
->from_overlay
;
5314 if (NILP (it
->string
))
5315 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5316 it
->method
= p
->method
;
5319 case GET_FROM_IMAGE
:
5320 it
->image_id
= p
->u
.image
.image_id
;
5321 it
->object
= p
->u
.image
.object
;
5322 it
->slice
= p
->u
.image
.slice
;
5324 case GET_FROM_STRETCH
:
5325 it
->object
= p
->u
.comp
.object
;
5327 case GET_FROM_BUFFER
:
5328 it
->object
= it
->w
->buffer
;
5331 /* Bidi-iterate until we get out of the portion of text, if
5332 any, covered by a `display' text property or an overlay
5333 with `display' property. (We cannot just jump there,
5334 because the internal coherency of the bidi iterator state
5335 can not be preserved across such jumps.) We also must
5336 determine the paragraph base direction if the overlay we
5337 just processed is at the beginning of a new
5339 iterate_out_of_display_property (it
);
5342 case GET_FROM_STRING
:
5343 it
->object
= it
->string
;
5345 case GET_FROM_DISPLAY_VECTOR
:
5347 it
->method
= GET_FROM_C_STRING
;
5348 else if (STRINGP (it
->string
))
5349 it
->method
= GET_FROM_STRING
;
5352 it
->method
= GET_FROM_BUFFER
;
5353 it
->object
= it
->w
->buffer
;
5356 it
->end_charpos
= p
->end_charpos
;
5357 it
->string_nchars
= p
->string_nchars
;
5359 it
->multibyte_p
= p
->multibyte_p
;
5360 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5361 it
->space_width
= p
->space_width
;
5362 it
->font_height
= p
->font_height
;
5363 it
->voffset
= p
->voffset
;
5364 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5365 it
->line_wrap
= p
->line_wrap
;
5370 /***********************************************************************
5372 ***********************************************************************/
5374 /* Set IT's current position to the previous line start. */
5377 back_to_previous_line_start (it
)
5380 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5381 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5385 /* Move IT to the next line start.
5387 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5388 we skipped over part of the text (as opposed to moving the iterator
5389 continuously over the text). Otherwise, don't change the value
5392 Newlines may come from buffer text, overlay strings, or strings
5393 displayed via the `display' property. That's the reason we can't
5394 simply use find_next_newline_no_quit.
5396 Note that this function may not skip over invisible text that is so
5397 because of text properties and immediately follows a newline. If
5398 it would, function reseat_at_next_visible_line_start, when called
5399 from set_iterator_to_next, would effectively make invisible
5400 characters following a newline part of the wrong glyph row, which
5401 leads to wrong cursor motion. */
5404 forward_to_next_line_start (it
, skipped_p
)
5408 int old_selective
, newline_found_p
, n
;
5409 const int MAX_NEWLINE_DISTANCE
= 500;
5411 /* If already on a newline, just consume it to avoid unintended
5412 skipping over invisible text below. */
5413 if (it
->what
== IT_CHARACTER
5415 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5417 set_iterator_to_next (it
, 0);
5422 /* Don't handle selective display in the following. It's (a)
5423 unnecessary because it's done by the caller, and (b) leads to an
5424 infinite recursion because next_element_from_ellipsis indirectly
5425 calls this function. */
5426 old_selective
= it
->selective
;
5429 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5430 from buffer text. */
5431 for (n
= newline_found_p
= 0;
5432 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5433 n
+= STRINGP (it
->string
) ? 0 : 1)
5435 if (!get_next_display_element (it
))
5437 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5438 set_iterator_to_next (it
, 0);
5441 /* If we didn't find a newline near enough, see if we can use a
5443 if (!newline_found_p
)
5445 int start
= IT_CHARPOS (*it
);
5446 int limit
= find_next_newline_no_quit (start
, 1);
5449 xassert (!STRINGP (it
->string
));
5451 /* If there isn't any `display' property in sight, and no
5452 overlays, we can just use the position of the newline in
5454 if (it
->stop_charpos
>= limit
5455 || ((pos
= Fnext_single_property_change (make_number (start
),
5457 Qnil
, make_number (limit
)),
5459 && next_overlay_change (start
) == ZV
))
5461 IT_CHARPOS (*it
) = limit
;
5462 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5463 *skipped_p
= newline_found_p
= 1;
5467 while (get_next_display_element (it
)
5468 && !newline_found_p
)
5470 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5471 set_iterator_to_next (it
, 0);
5476 it
->selective
= old_selective
;
5477 return newline_found_p
;
5481 /* Set IT's current position to the previous visible line start. Skip
5482 invisible text that is so either due to text properties or due to
5483 selective display. Caution: this does not change IT->current_x and
5487 back_to_previous_visible_line_start (it
)
5490 while (IT_CHARPOS (*it
) > BEGV
)
5492 back_to_previous_line_start (it
);
5494 if (IT_CHARPOS (*it
) <= BEGV
)
5497 /* If selective > 0, then lines indented more than its value are
5499 if (it
->selective
> 0
5500 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5501 (double) it
->selective
)) /* iftc */
5504 /* Check the newline before point for invisibility. */
5507 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5508 Qinvisible
, it
->window
);
5509 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5513 if (IT_CHARPOS (*it
) <= BEGV
)
5520 Lisp_Object val
, overlay
;
5522 /* If newline is part of a composition, continue from start of composition */
5523 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5524 && beg
< IT_CHARPOS (*it
))
5527 /* If newline is replaced by a display property, find start of overlay
5528 or interval and continue search from that point. */
5530 pos
= --IT_CHARPOS (it2
);
5533 it2
.string_from_display_prop_p
= 0;
5534 if (handle_display_prop (&it2
) == HANDLED_RETURN
5535 && !NILP (val
= get_char_property_and_overlay
5536 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5537 && (OVERLAYP (overlay
)
5538 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5539 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5542 /* Newline is not replaced by anything -- so we are done. */
5548 IT_CHARPOS (*it
) = beg
;
5549 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5553 it
->continuation_lines_width
= 0;
5555 xassert (IT_CHARPOS (*it
) >= BEGV
);
5556 xassert (IT_CHARPOS (*it
) == BEGV
5557 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5562 /* Reseat iterator IT at the previous visible line start. Skip
5563 invisible text that is so either due to text properties or due to
5564 selective display. At the end, update IT's overlay information,
5565 face information etc. */
5568 reseat_at_previous_visible_line_start (it
)
5571 back_to_previous_visible_line_start (it
);
5572 reseat (it
, it
->current
.pos
, 1);
5577 /* Reseat iterator IT on the next visible line start in the current
5578 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5579 preceding the line start. Skip over invisible text that is so
5580 because of selective display. Compute faces, overlays etc at the
5581 new position. Note that this function does not skip over text that
5582 is invisible because of text properties. */
5585 reseat_at_next_visible_line_start (it
, on_newline_p
)
5589 int newline_found_p
, skipped_p
= 0;
5591 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5593 /* Skip over lines that are invisible because they are indented
5594 more than the value of IT->selective. */
5595 if (it
->selective
> 0)
5596 while (IT_CHARPOS (*it
) < ZV
5597 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5598 (double) it
->selective
)) /* iftc */
5600 xassert (IT_BYTEPOS (*it
) == BEGV
5601 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5602 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5605 /* Position on the newline if that's what's requested. */
5606 if (on_newline_p
&& newline_found_p
)
5608 if (STRINGP (it
->string
))
5610 if (IT_STRING_CHARPOS (*it
) > 0)
5612 --IT_STRING_CHARPOS (*it
);
5613 --IT_STRING_BYTEPOS (*it
);
5616 else if (IT_CHARPOS (*it
) > BEGV
)
5620 reseat (it
, it
->current
.pos
, 0);
5624 reseat (it
, it
->current
.pos
, 0);
5631 /***********************************************************************
5632 Changing an iterator's position
5633 ***********************************************************************/
5635 /* Change IT's current position to POS in current_buffer. If FORCE_P
5636 is non-zero, always check for text properties at the new position.
5637 Otherwise, text properties are only looked up if POS >=
5638 IT->check_charpos of a property. */
5641 reseat (it
, pos
, force_p
)
5643 struct text_pos pos
;
5646 int original_pos
= IT_CHARPOS (*it
);
5648 reseat_1 (it
, pos
, 0);
5650 /* Determine where to check text properties. Avoid doing it
5651 where possible because text property lookup is very expensive. */
5653 || CHARPOS (pos
) > it
->stop_charpos
5654 || CHARPOS (pos
) < original_pos
)
5658 /* For bidi iteration, we need to prime prev_stop and
5659 base_level_stop with our best estimations. */
5660 if (CHARPOS (pos
) < it
->prev_stop
)
5662 handle_stop_backwards (it
, BEGV
);
5663 if (CHARPOS (pos
) < it
->base_level_stop
)
5664 it
->base_level_stop
= 0;
5666 else if (CHARPOS (pos
) > it
->stop_charpos
5667 && it
->stop_charpos
>= BEGV
)
5668 handle_stop_backwards (it
, it
->stop_charpos
);
5675 it
->prev_stop
= it
->base_level_stop
= 0;
5684 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5685 IT->stop_pos to POS, also. */
5688 reseat_1 (it
, pos
, set_stop_p
)
5690 struct text_pos pos
;
5693 /* Don't call this function when scanning a C string. */
5694 xassert (it
->s
== NULL
);
5696 /* POS must be a reasonable value. */
5697 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5699 it
->current
.pos
= it
->position
= pos
;
5700 it
->end_charpos
= ZV
;
5702 it
->current
.dpvec_index
= -1;
5703 it
->current
.overlay_string_index
= -1;
5704 IT_STRING_CHARPOS (*it
) = -1;
5705 IT_STRING_BYTEPOS (*it
) = -1;
5707 it
->string_from_display_prop_p
= 0;
5708 it
->method
= GET_FROM_BUFFER
;
5709 it
->object
= it
->w
->buffer
;
5710 it
->area
= TEXT_AREA
;
5711 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5713 it
->string_from_display_prop_p
= 0;
5714 it
->face_before_selective_p
= 0;
5716 it
->bidi_it
.first_elt
= 1;
5720 it
->stop_charpos
= CHARPOS (pos
);
5721 it
->base_level_stop
= CHARPOS (pos
);
5726 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5727 If S is non-null, it is a C string to iterate over. Otherwise,
5728 STRING gives a Lisp string to iterate over.
5730 If PRECISION > 0, don't return more then PRECISION number of
5731 characters from the string.
5733 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5734 characters have been returned. FIELD_WIDTH < 0 means an infinite
5737 MULTIBYTE = 0 means disable processing of multibyte characters,
5738 MULTIBYTE > 0 means enable it,
5739 MULTIBYTE < 0 means use IT->multibyte_p.
5741 IT must be initialized via a prior call to init_iterator before
5742 calling this function. */
5745 reseat_to_string (it
, s
, string
, charpos
, precision
, field_width
, multibyte
)
5750 int precision
, field_width
, multibyte
;
5752 /* No region in strings. */
5753 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5755 /* No text property checks performed by default, but see below. */
5756 it
->stop_charpos
= -1;
5758 /* Set iterator position and end position. */
5759 bzero (&it
->current
, sizeof it
->current
);
5760 it
->current
.overlay_string_index
= -1;
5761 it
->current
.dpvec_index
= -1;
5762 xassert (charpos
>= 0);
5764 /* If STRING is specified, use its multibyteness, otherwise use the
5765 setting of MULTIBYTE, if specified. */
5767 it
->multibyte_p
= multibyte
> 0;
5771 xassert (STRINGP (string
));
5772 it
->string
= string
;
5774 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5775 it
->method
= GET_FROM_STRING
;
5776 it
->current
.string_pos
= string_pos (charpos
, string
);
5783 /* Note that we use IT->current.pos, not it->current.string_pos,
5784 for displaying C strings. */
5785 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5786 if (it
->multibyte_p
)
5788 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5789 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5793 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5794 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5797 it
->method
= GET_FROM_C_STRING
;
5800 /* PRECISION > 0 means don't return more than PRECISION characters
5802 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5803 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5805 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5806 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5807 FIELD_WIDTH < 0 means infinite field width. This is useful for
5808 padding with `-' at the end of a mode line. */
5809 if (field_width
< 0)
5810 field_width
= INFINITY
;
5811 if (field_width
> it
->end_charpos
- charpos
)
5812 it
->end_charpos
= charpos
+ field_width
;
5814 /* Use the standard display table for displaying strings. */
5815 if (DISP_TABLE_P (Vstandard_display_table
))
5816 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5818 it
->stop_charpos
= charpos
;
5819 if (s
== NULL
&& it
->multibyte_p
)
5821 EMACS_INT endpos
= SCHARS (it
->string
);
5822 if (endpos
> it
->end_charpos
)
5823 endpos
= it
->end_charpos
;
5824 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5832 /***********************************************************************
5834 ***********************************************************************/
5836 /* Map enum it_method value to corresponding next_element_from_* function. */
5838 static int (* get_next_element
[NUM_IT_METHODS
]) P_ ((struct it
*it
)) =
5840 next_element_from_buffer
,
5841 next_element_from_display_vector
,
5842 next_element_from_string
,
5843 next_element_from_c_string
,
5844 next_element_from_image
,
5845 next_element_from_stretch
5848 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5851 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5852 (possibly with the following characters). */
5854 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5855 ((IT)->cmp_it.id >= 0 \
5856 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5857 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5858 END_CHARPOS, (IT)->w, \
5859 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5863 /* Load IT's display element fields with information about the next
5864 display element from the current position of IT. Value is zero if
5865 end of buffer (or C string) is reached. */
5867 static struct frame
*last_escape_glyph_frame
= NULL
;
5868 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5869 static int last_escape_glyph_merged_face_id
= 0;
5872 get_next_display_element (it
)
5875 /* Non-zero means that we found a display element. Zero means that
5876 we hit the end of what we iterate over. Performance note: the
5877 function pointer `method' used here turns out to be faster than
5878 using a sequence of if-statements. */
5882 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5884 if (it
->what
== IT_CHARACTER
)
5886 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5887 and only if (a) the resolved directionality of that character
5889 /* FIXME: Do we need an exception for characters from display
5891 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5892 it
->c
= bidi_mirror_char (it
->c
);
5893 /* Map via display table or translate control characters.
5894 IT->c, IT->len etc. have been set to the next character by
5895 the function call above. If we have a display table, and it
5896 contains an entry for IT->c, translate it. Don't do this if
5897 IT->c itself comes from a display table, otherwise we could
5898 end up in an infinite recursion. (An alternative could be to
5899 count the recursion depth of this function and signal an
5900 error when a certain maximum depth is reached.) Is it worth
5902 if (success_p
&& it
->dpvec
== NULL
)
5905 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5906 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5907 nbsp_or_shy
= char_is_other
;
5908 int decoded
= it
->c
;
5911 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5914 struct Lisp_Vector
*v
= XVECTOR (dv
);
5916 /* Return the first character from the display table
5917 entry, if not empty. If empty, don't display the
5918 current character. */
5921 it
->dpvec_char_len
= it
->len
;
5922 it
->dpvec
= v
->contents
;
5923 it
->dpend
= v
->contents
+ v
->size
;
5924 it
->current
.dpvec_index
= 0;
5925 it
->dpvec_face_id
= -1;
5926 it
->saved_face_id
= it
->face_id
;
5927 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5932 set_iterator_to_next (it
, 0);
5937 if (unibyte_display_via_language_environment
5938 && !ASCII_CHAR_P (it
->c
))
5939 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5941 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5943 if (it
->multibyte_p
)
5944 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5945 : it
->c
== 0xAD ? char_is_soft_hyphen
5947 else if (unibyte_display_via_language_environment
)
5948 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5949 : decoded
== 0xAD ? char_is_soft_hyphen
5953 /* Translate control characters into `\003' or `^C' form.
5954 Control characters coming from a display table entry are
5955 currently not translated because we use IT->dpvec to hold
5956 the translation. This could easily be changed but I
5957 don't believe that it is worth doing.
5959 If it->multibyte_p is nonzero, non-printable non-ASCII
5960 characters are also translated to octal form.
5962 If it->multibyte_p is zero, eight-bit characters that
5963 don't have corresponding multibyte char code are also
5964 translated to octal form. */
5966 ? (it
->area
!= TEXT_AREA
5967 /* In mode line, treat \n, \t like other crl chars. */
5970 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5971 || (it
->c
!= '\n' && it
->c
!= '\t'))
5974 ? ! CHAR_PRINTABLE_P (it
->c
)
5975 : (! unibyte_display_via_language_environment
5977 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5979 /* IT->c is a control character which must be displayed
5980 either as '\003' or as `^C' where the '\\' and '^'
5981 can be defined in the display table. Fill
5982 IT->ctl_chars with glyphs for what we have to
5983 display. Then, set IT->dpvec to these glyphs. */
5986 int face_id
, lface_id
= 0 ;
5989 /* Handle control characters with ^. */
5991 if (it
->c
< 128 && it
->ctl_arrow_p
)
5995 g
= '^'; /* default glyph for Control */
5996 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5998 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5999 && GLYPH_CODE_CHAR_VALID_P (gc
))
6001 g
= GLYPH_CODE_CHAR (gc
);
6002 lface_id
= GLYPH_CODE_FACE (gc
);
6006 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6008 else if (it
->f
== last_escape_glyph_frame
6009 && it
->face_id
== last_escape_glyph_face_id
)
6011 face_id
= last_escape_glyph_merged_face_id
;
6015 /* Merge the escape-glyph face into the current face. */
6016 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6018 last_escape_glyph_frame
= it
->f
;
6019 last_escape_glyph_face_id
= it
->face_id
;
6020 last_escape_glyph_merged_face_id
= face_id
;
6023 XSETINT (it
->ctl_chars
[0], g
);
6024 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
6026 goto display_control
;
6029 /* Handle non-break space in the mode where it only gets
6032 if (EQ (Vnobreak_char_display
, Qt
)
6033 && nbsp_or_shy
== char_is_nbsp
)
6035 /* Merge the no-break-space face into the current face. */
6036 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6040 XSETINT (it
->ctl_chars
[0], ' ');
6042 goto display_control
;
6045 /* Handle sequences that start with the "escape glyph". */
6047 /* the default escape glyph is \. */
6048 escape_glyph
= '\\';
6051 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6052 && GLYPH_CODE_CHAR_VALID_P (gc
))
6054 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6055 lface_id
= GLYPH_CODE_FACE (gc
);
6059 /* The display table specified a face.
6060 Merge it into face_id and also into escape_glyph. */
6061 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6064 else if (it
->f
== last_escape_glyph_frame
6065 && it
->face_id
== last_escape_glyph_face_id
)
6067 face_id
= last_escape_glyph_merged_face_id
;
6071 /* Merge the escape-glyph face into the current face. */
6072 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6074 last_escape_glyph_frame
= it
->f
;
6075 last_escape_glyph_face_id
= it
->face_id
;
6076 last_escape_glyph_merged_face_id
= face_id
;
6079 /* Handle soft hyphens in the mode where they only get
6082 if (EQ (Vnobreak_char_display
, Qt
)
6083 && nbsp_or_shy
== char_is_soft_hyphen
)
6086 XSETINT (it
->ctl_chars
[0], '-');
6088 goto display_control
;
6091 /* Handle non-break space and soft hyphen
6092 with the escape glyph. */
6096 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6097 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6098 XSETINT (it
->ctl_chars
[1], it
->c
);
6100 goto display_control
;
6104 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
6108 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
6109 if (CHAR_BYTE8_P (it
->c
))
6111 str
[0] = CHAR_TO_BYTE8 (it
->c
);
6114 else if (it
->c
< 256)
6121 /* It's an invalid character, which shouldn't
6122 happen actually, but due to bugs it may
6123 happen. Let's print the char as is, there's
6124 not much meaningful we can do with it. */
6126 str
[1] = it
->c
>> 8;
6127 str
[2] = it
->c
>> 16;
6128 str
[3] = it
->c
>> 24;
6132 for (i
= 0; i
< len
; i
++)
6135 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
6136 /* Insert three more glyphs into IT->ctl_chars for
6137 the octal display of the character. */
6138 g
= ((str
[i
] >> 6) & 7) + '0';
6139 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
6140 g
= ((str
[i
] >> 3) & 7) + '0';
6141 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
6142 g
= (str
[i
] & 7) + '0';
6143 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
6149 /* Set up IT->dpvec and return first character from it. */
6150 it
->dpvec_char_len
= it
->len
;
6151 it
->dpvec
= it
->ctl_chars
;
6152 it
->dpend
= it
->dpvec
+ ctl_len
;
6153 it
->current
.dpvec_index
= 0;
6154 it
->dpvec_face_id
= face_id
;
6155 it
->saved_face_id
= it
->face_id
;
6156 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6163 #ifdef HAVE_WINDOW_SYSTEM
6164 /* Adjust face id for a multibyte character. There are no multibyte
6165 character in unibyte text. */
6166 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6169 && FRAME_WINDOW_P (it
->f
))
6171 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6173 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6175 /* Automatic composition with glyph-string. */
6176 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6178 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6182 int pos
= (it
->s
? -1
6183 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6184 : IT_CHARPOS (*it
));
6186 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6191 /* Is this character the last one of a run of characters with
6192 box? If yes, set IT->end_of_box_run_p to 1. */
6196 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6198 int face_id
= underlying_face_id (it
);
6199 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6203 if (face
->box
== FACE_NO_BOX
)
6205 /* If the box comes from face properties in a
6206 display string, check faces in that string. */
6207 int string_face_id
= face_after_it_pos (it
);
6208 it
->end_of_box_run_p
6209 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6212 /* Otherwise, the box comes from the underlying face.
6213 If this is the last string character displayed, check
6214 the next buffer location. */
6215 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6216 && (it
->current
.overlay_string_index
6217 == it
->n_overlay_strings
- 1))
6221 struct text_pos pos
= it
->current
.pos
;
6222 INC_TEXT_POS (pos
, it
->multibyte_p
);
6224 next_face_id
= face_at_buffer_position
6225 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6226 it
->region_end_charpos
, &ignore
,
6227 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6229 it
->end_of_box_run_p
6230 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6237 int face_id
= face_after_it_pos (it
);
6238 it
->end_of_box_run_p
6239 = (face_id
!= it
->face_id
6240 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6244 /* Value is 0 if end of buffer or string reached. */
6249 /* Move IT to the next display element.
6251 RESEAT_P non-zero means if called on a newline in buffer text,
6252 skip to the next visible line start.
6254 Functions get_next_display_element and set_iterator_to_next are
6255 separate because I find this arrangement easier to handle than a
6256 get_next_display_element function that also increments IT's
6257 position. The way it is we can first look at an iterator's current
6258 display element, decide whether it fits on a line, and if it does,
6259 increment the iterator position. The other way around we probably
6260 would either need a flag indicating whether the iterator has to be
6261 incremented the next time, or we would have to implement a
6262 decrement position function which would not be easy to write. */
6265 set_iterator_to_next (it
, reseat_p
)
6269 /* Reset flags indicating start and end of a sequence of characters
6270 with box. Reset them at the start of this function because
6271 moving the iterator to a new position might set them. */
6272 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6276 case GET_FROM_BUFFER
:
6277 /* The current display element of IT is a character from
6278 current_buffer. Advance in the buffer, and maybe skip over
6279 invisible lines that are so because of selective display. */
6280 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6281 reseat_at_next_visible_line_start (it
, 0);
6282 else if (it
->cmp_it
.id
>= 0)
6284 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6285 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6288 if (it
->bidi_it
.new_paragraph
)
6289 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6290 /* Resync the bidi iterator with IT's new position.
6291 FIXME: this doesn't support bidirectional text. */
6292 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6293 bidi_get_next_char_visually (&it
->bidi_it
);
6295 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6296 it
->cmp_it
.from
= it
->cmp_it
.to
;
6300 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6301 IT_BYTEPOS (*it
), it
->stop_charpos
,
6307 xassert (it
->len
!= 0);
6311 IT_BYTEPOS (*it
) += it
->len
;
6312 IT_CHARPOS (*it
) += 1;
6316 /* If this is a new paragraph, determine its base
6317 direction (a.k.a. its base embedding level). */
6318 if (it
->bidi_it
.new_paragraph
)
6319 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6320 bidi_get_next_char_visually (&it
->bidi_it
);
6321 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6322 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6324 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6328 case GET_FROM_C_STRING
:
6329 /* Current display element of IT is from a C string. */
6330 IT_BYTEPOS (*it
) += it
->len
;
6331 IT_CHARPOS (*it
) += 1;
6334 case GET_FROM_DISPLAY_VECTOR
:
6335 /* Current display element of IT is from a display table entry.
6336 Advance in the display table definition. Reset it to null if
6337 end reached, and continue with characters from buffers/
6339 ++it
->current
.dpvec_index
;
6341 /* Restore face of the iterator to what they were before the
6342 display vector entry (these entries may contain faces). */
6343 it
->face_id
= it
->saved_face_id
;
6345 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6347 int recheck_faces
= it
->ellipsis_p
;
6350 it
->method
= GET_FROM_C_STRING
;
6351 else if (STRINGP (it
->string
))
6352 it
->method
= GET_FROM_STRING
;
6355 it
->method
= GET_FROM_BUFFER
;
6356 it
->object
= it
->w
->buffer
;
6360 it
->current
.dpvec_index
= -1;
6362 /* Skip over characters which were displayed via IT->dpvec. */
6363 if (it
->dpvec_char_len
< 0)
6364 reseat_at_next_visible_line_start (it
, 1);
6365 else if (it
->dpvec_char_len
> 0)
6367 if (it
->method
== GET_FROM_STRING
6368 && it
->n_overlay_strings
> 0)
6369 it
->ignore_overlay_strings_at_pos_p
= 1;
6370 it
->len
= it
->dpvec_char_len
;
6371 set_iterator_to_next (it
, reseat_p
);
6374 /* Maybe recheck faces after display vector */
6376 it
->stop_charpos
= IT_CHARPOS (*it
);
6380 case GET_FROM_STRING
:
6381 /* Current display element is a character from a Lisp string. */
6382 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6383 if (it
->cmp_it
.id
>= 0)
6385 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6386 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6387 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6388 it
->cmp_it
.from
= it
->cmp_it
.to
;
6392 composition_compute_stop_pos (&it
->cmp_it
,
6393 IT_STRING_CHARPOS (*it
),
6394 IT_STRING_BYTEPOS (*it
),
6395 it
->stop_charpos
, it
->string
);
6400 IT_STRING_BYTEPOS (*it
) += it
->len
;
6401 IT_STRING_CHARPOS (*it
) += 1;
6404 consider_string_end
:
6406 if (it
->current
.overlay_string_index
>= 0)
6408 /* IT->string is an overlay string. Advance to the
6409 next, if there is one. */
6410 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6413 next_overlay_string (it
);
6415 setup_for_ellipsis (it
, 0);
6420 /* IT->string is not an overlay string. If we reached
6421 its end, and there is something on IT->stack, proceed
6422 with what is on the stack. This can be either another
6423 string, this time an overlay string, or a buffer. */
6424 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6428 if (it
->method
== GET_FROM_STRING
)
6429 goto consider_string_end
;
6434 case GET_FROM_IMAGE
:
6435 case GET_FROM_STRETCH
:
6436 /* The position etc with which we have to proceed are on
6437 the stack. The position may be at the end of a string,
6438 if the `display' property takes up the whole string. */
6439 xassert (it
->sp
> 0);
6441 if (it
->method
== GET_FROM_STRING
)
6442 goto consider_string_end
;
6446 /* There are no other methods defined, so this should be a bug. */
6450 xassert (it
->method
!= GET_FROM_STRING
6451 || (STRINGP (it
->string
)
6452 && IT_STRING_CHARPOS (*it
) >= 0));
6455 /* Load IT's display element fields with information about the next
6456 display element which comes from a display table entry or from the
6457 result of translating a control character to one of the forms `^C'
6460 IT->dpvec holds the glyphs to return as characters.
6461 IT->saved_face_id holds the face id before the display vector--it
6462 is restored into IT->face_id in set_iterator_to_next. */
6465 next_element_from_display_vector (it
)
6471 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6473 it
->face_id
= it
->saved_face_id
;
6475 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6476 That seemed totally bogus - so I changed it... */
6477 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6479 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6481 it
->c
= GLYPH_CODE_CHAR (gc
);
6482 it
->len
= CHAR_BYTES (it
->c
);
6484 /* The entry may contain a face id to use. Such a face id is
6485 the id of a Lisp face, not a realized face. A face id of
6486 zero means no face is specified. */
6487 if (it
->dpvec_face_id
>= 0)
6488 it
->face_id
= it
->dpvec_face_id
;
6491 int lface_id
= GLYPH_CODE_FACE (gc
);
6493 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6498 /* Display table entry is invalid. Return a space. */
6499 it
->c
= ' ', it
->len
= 1;
6501 /* Don't change position and object of the iterator here. They are
6502 still the values of the character that had this display table
6503 entry or was translated, and that's what we want. */
6504 it
->what
= IT_CHARACTER
;
6509 /* Load IT with the next display element from Lisp string IT->string.
6510 IT->current.string_pos is the current position within the string.
6511 If IT->current.overlay_string_index >= 0, the Lisp string is an
6515 next_element_from_string (it
)
6518 struct text_pos position
;
6520 xassert (STRINGP (it
->string
));
6521 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6522 position
= it
->current
.string_pos
;
6524 /* Time to check for invisible text? */
6525 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6526 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6530 /* Since a handler may have changed IT->method, we must
6532 return GET_NEXT_DISPLAY_ELEMENT (it
);
6535 if (it
->current
.overlay_string_index
>= 0)
6537 /* Get the next character from an overlay string. In overlay
6538 strings, There is no field width or padding with spaces to
6540 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6545 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6546 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6547 && next_element_from_composition (it
))
6551 else if (STRING_MULTIBYTE (it
->string
))
6553 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6554 const unsigned char *s
= (SDATA (it
->string
)
6555 + IT_STRING_BYTEPOS (*it
));
6556 it
->c
= string_char_and_length (s
, &it
->len
);
6560 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6566 /* Get the next character from a Lisp string that is not an
6567 overlay string. Such strings come from the mode line, for
6568 example. We may have to pad with spaces, or truncate the
6569 string. See also next_element_from_c_string. */
6570 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6575 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6577 /* Pad with spaces. */
6578 it
->c
= ' ', it
->len
= 1;
6579 CHARPOS (position
) = BYTEPOS (position
) = -1;
6581 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6582 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6583 && next_element_from_composition (it
))
6587 else if (STRING_MULTIBYTE (it
->string
))
6589 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6590 const unsigned char *s
= (SDATA (it
->string
)
6591 + IT_STRING_BYTEPOS (*it
));
6592 it
->c
= string_char_and_length (s
, &it
->len
);
6596 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6601 /* Record what we have and where it came from. */
6602 it
->what
= IT_CHARACTER
;
6603 it
->object
= it
->string
;
6604 it
->position
= position
;
6609 /* Load IT with next display element from C string IT->s.
6610 IT->string_nchars is the maximum number of characters to return
6611 from the string. IT->end_charpos may be greater than
6612 IT->string_nchars when this function is called, in which case we
6613 may have to return padding spaces. Value is zero if end of string
6614 reached, including padding spaces. */
6617 next_element_from_c_string (it
)
6623 it
->what
= IT_CHARACTER
;
6624 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6627 /* IT's position can be greater IT->string_nchars in case a field
6628 width or precision has been specified when the iterator was
6630 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6632 /* End of the game. */
6636 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6638 /* Pad with spaces. */
6639 it
->c
= ' ', it
->len
= 1;
6640 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6642 else if (it
->multibyte_p
)
6644 /* Implementation note: The calls to strlen apparently aren't a
6645 performance problem because there is no noticeable performance
6646 difference between Emacs running in unibyte or multibyte mode. */
6647 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6648 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6651 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6657 /* Set up IT to return characters from an ellipsis, if appropriate.
6658 The definition of the ellipsis glyphs may come from a display table
6659 entry. This function fills IT with the first glyph from the
6660 ellipsis if an ellipsis is to be displayed. */
6663 next_element_from_ellipsis (it
)
6666 if (it
->selective_display_ellipsis_p
)
6667 setup_for_ellipsis (it
, it
->len
);
6670 /* The face at the current position may be different from the
6671 face we find after the invisible text. Remember what it
6672 was in IT->saved_face_id, and signal that it's there by
6673 setting face_before_selective_p. */
6674 it
->saved_face_id
= it
->face_id
;
6675 it
->method
= GET_FROM_BUFFER
;
6676 it
->object
= it
->w
->buffer
;
6677 reseat_at_next_visible_line_start (it
, 1);
6678 it
->face_before_selective_p
= 1;
6681 return GET_NEXT_DISPLAY_ELEMENT (it
);
6685 /* Deliver an image display element. The iterator IT is already
6686 filled with image information (done in handle_display_prop). Value
6691 next_element_from_image (it
)
6694 it
->what
= IT_IMAGE
;
6699 /* Fill iterator IT with next display element from a stretch glyph
6700 property. IT->object is the value of the text property. Value is
6704 next_element_from_stretch (it
)
6707 it
->what
= IT_STRETCH
;
6711 /* Scan forward from CHARPOS in the current buffer, until we find a
6712 stop position > current IT's position. Then handle the stop
6713 position before that. This is called when we bump into a stop
6714 position while reordering bidirectional text. CHARPOS should be
6715 the last previously processed stop_pos (or BEGV, if none were
6716 processed yet) whose position is less that IT's current
6720 handle_stop_backwards (it
, charpos
)
6724 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6725 struct display_pos save_current
= it
->current
;
6726 struct text_pos save_position
= it
->position
;
6727 struct text_pos pos1
;
6728 EMACS_INT next_stop
;
6730 /* Scan in strict logical order. */
6734 it
->prev_stop
= charpos
;
6735 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6736 reseat_1 (it
, pos1
, 0);
6737 compute_stop_pos (it
);
6738 /* We must advance forward, right? */
6739 if (it
->stop_charpos
<= it
->prev_stop
)
6741 charpos
= it
->stop_charpos
;
6743 while (charpos
<= where_we_are
);
6745 next_stop
= it
->stop_charpos
;
6746 it
->stop_charpos
= it
->prev_stop
;
6748 it
->current
= save_current
;
6749 it
->position
= save_position
;
6751 it
->stop_charpos
= next_stop
;
6754 /* Load IT with the next display element from current_buffer. Value
6755 is zero if end of buffer reached. IT->stop_charpos is the next
6756 position at which to stop and check for text properties or buffer
6760 next_element_from_buffer (it
)
6765 xassert (IT_CHARPOS (*it
) >= BEGV
);
6767 /* With bidi reordering, the character to display might not be the
6768 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6769 we were reseat()ed to a new buffer position, which is potentially
6770 a different paragraph. */
6771 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6773 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6774 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6775 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6777 /* Nothing to do, but reset the FIRST_ELT flag, like
6778 bidi_paragraph_init does, because we are not going to
6780 it
->bidi_it
.first_elt
= 0;
6782 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6783 /* FIXME: Should support all Unicode line separators. */
6784 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6785 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6787 /* If we are at the beginning of a line, we can produce the
6788 next element right away. */
6789 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6790 bidi_get_next_char_visually (&it
->bidi_it
);
6794 int orig_bytepos
= IT_BYTEPOS (*it
);
6796 /* We need to prime the bidi iterator starting at the line's
6797 beginning, before we will be able to produce the next
6799 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6800 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6801 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6802 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6803 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6806 /* Now return to buffer position where we were asked to
6807 get the next display element, and produce that. */
6808 bidi_get_next_char_visually (&it
->bidi_it
);
6810 while (it
->bidi_it
.bytepos
!= orig_bytepos
6811 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6814 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6815 /* Adjust IT's position information to where we ended up. */
6816 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6817 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6818 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6821 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6823 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6825 int overlay_strings_follow_p
;
6827 /* End of the game, except when overlay strings follow that
6828 haven't been returned yet. */
6829 if (it
->overlay_strings_at_end_processed_p
)
6830 overlay_strings_follow_p
= 0;
6833 it
->overlay_strings_at_end_processed_p
= 1;
6834 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6837 if (overlay_strings_follow_p
)
6838 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6842 it
->position
= it
->current
.pos
;
6846 else if (!(!it
->bidi_p
6847 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6848 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6850 /* With bidi non-linear iteration, we could find ourselves
6851 far beyond the last computed stop_charpos, with several
6852 other stop positions in between that we missed. Scan
6853 them all now, in buffer's logical order, until we find
6854 and handle the last stop_charpos that precedes our
6855 current position. */
6856 handle_stop_backwards (it
, it
->stop_charpos
);
6857 return GET_NEXT_DISPLAY_ELEMENT (it
);
6863 /* Take note of the stop position we just moved across,
6864 for when we will move back across it. */
6865 it
->prev_stop
= it
->stop_charpos
;
6866 /* If we are at base paragraph embedding level, take
6867 note of the last stop position seen at this
6869 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6870 it
->base_level_stop
= it
->stop_charpos
;
6873 return GET_NEXT_DISPLAY_ELEMENT (it
);
6877 /* We can sometimes back up for reasons that have nothing
6878 to do with bidi reordering. E.g., compositions. The
6879 code below is only needed when we are above the base
6880 embedding level, so test for that explicitly. */
6881 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6882 && IT_CHARPOS (*it
) < it
->prev_stop
)
6884 if (it
->base_level_stop
<= 0)
6885 it
->base_level_stop
= BEGV
;
6886 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6888 handle_stop_backwards (it
, it
->base_level_stop
);
6889 return GET_NEXT_DISPLAY_ELEMENT (it
);
6893 /* No face changes, overlays etc. in sight, so just return a
6894 character from current_buffer. */
6897 /* Maybe run the redisplay end trigger hook. Performance note:
6898 This doesn't seem to cost measurable time. */
6899 if (it
->redisplay_end_trigger_charpos
6901 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6902 run_redisplay_end_trigger_hook (it
);
6904 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6906 && next_element_from_composition (it
))
6911 /* Get the next character, maybe multibyte. */
6912 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6913 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6914 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6916 it
->c
= *p
, it
->len
= 1;
6918 /* Record what we have and where it came from. */
6919 it
->what
= IT_CHARACTER
;
6920 it
->object
= it
->w
->buffer
;
6921 it
->position
= it
->current
.pos
;
6923 /* Normally we return the character found above, except when we
6924 really want to return an ellipsis for selective display. */
6929 /* A value of selective > 0 means hide lines indented more
6930 than that number of columns. */
6931 if (it
->selective
> 0
6932 && IT_CHARPOS (*it
) + 1 < ZV
6933 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6934 IT_BYTEPOS (*it
) + 1,
6935 (double) it
->selective
)) /* iftc */
6937 success_p
= next_element_from_ellipsis (it
);
6938 it
->dpvec_char_len
= -1;
6941 else if (it
->c
== '\r' && it
->selective
== -1)
6943 /* A value of selective == -1 means that everything from the
6944 CR to the end of the line is invisible, with maybe an
6945 ellipsis displayed for it. */
6946 success_p
= next_element_from_ellipsis (it
);
6947 it
->dpvec_char_len
= -1;
6952 /* Value is zero if end of buffer reached. */
6953 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6958 /* Run the redisplay end trigger hook for IT. */
6961 run_redisplay_end_trigger_hook (it
)
6964 Lisp_Object args
[3];
6966 /* IT->glyph_row should be non-null, i.e. we should be actually
6967 displaying something, or otherwise we should not run the hook. */
6968 xassert (it
->glyph_row
);
6970 /* Set up hook arguments. */
6971 args
[0] = Qredisplay_end_trigger_functions
;
6972 args
[1] = it
->window
;
6973 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6974 it
->redisplay_end_trigger_charpos
= 0;
6976 /* Since we are *trying* to run these functions, don't try to run
6977 them again, even if they get an error. */
6978 it
->w
->redisplay_end_trigger
= Qnil
;
6979 Frun_hook_with_args (3, args
);
6981 /* Notice if it changed the face of the character we are on. */
6982 handle_face_prop (it
);
6986 /* Deliver a composition display element. Unlike the other
6987 next_element_from_XXX, this function is not registered in the array
6988 get_next_element[]. It is called from next_element_from_buffer and
6989 next_element_from_string when necessary. */
6992 next_element_from_composition (it
)
6995 it
->what
= IT_COMPOSITION
;
6996 it
->len
= it
->cmp_it
.nbytes
;
6997 if (STRINGP (it
->string
))
7001 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7002 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7005 it
->position
= it
->current
.string_pos
;
7006 it
->object
= it
->string
;
7007 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7008 IT_STRING_BYTEPOS (*it
), it
->string
);
7014 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7015 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7018 if (it
->bidi_it
.new_paragraph
)
7019 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
7020 /* Resync the bidi iterator with IT's new position.
7021 FIXME: this doesn't support bidirectional text. */
7022 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7023 bidi_get_next_char_visually (&it
->bidi_it
);
7027 it
->position
= it
->current
.pos
;
7028 it
->object
= it
->w
->buffer
;
7029 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7030 IT_BYTEPOS (*it
), Qnil
);
7037 /***********************************************************************
7038 Moving an iterator without producing glyphs
7039 ***********************************************************************/
7041 /* Check if iterator is at a position corresponding to a valid buffer
7042 position after some move_it_ call. */
7044 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7045 ((it)->method == GET_FROM_STRING \
7046 ? IT_STRING_CHARPOS (*it) == 0 \
7050 /* Move iterator IT to a specified buffer or X position within one
7051 line on the display without producing glyphs.
7053 OP should be a bit mask including some or all of these bits:
7054 MOVE_TO_X: Stop upon reaching x-position TO_X.
7055 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7056 Regardless of OP's value, stop upon reaching the end of the display line.
7058 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7059 This means, in particular, that TO_X includes window's horizontal
7062 The return value has several possible values that
7063 say what condition caused the scan to stop:
7065 MOVE_POS_MATCH_OR_ZV
7066 - when TO_POS or ZV was reached.
7069 -when TO_X was reached before TO_POS or ZV were reached.
7072 - when we reached the end of the display area and the line must
7076 - when we reached the end of the display area and the line is
7080 - when we stopped at a line end, i.e. a newline or a CR and selective
7083 static enum move_it_result
7084 move_it_in_display_line_to (struct it
*it
,
7085 EMACS_INT to_charpos
, int to_x
,
7086 enum move_operation_enum op
)
7088 enum move_it_result result
= MOVE_UNDEFINED
;
7089 struct glyph_row
*saved_glyph_row
;
7090 struct it wrap_it
, atpos_it
, atx_it
;
7092 enum it_method prev_method
= it
->method
;
7093 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7095 /* Don't produce glyphs in produce_glyphs. */
7096 saved_glyph_row
= it
->glyph_row
;
7097 it
->glyph_row
= NULL
;
7099 /* Use wrap_it to save a copy of IT wherever a word wrap could
7100 occur. Use atpos_it to save a copy of IT at the desired buffer
7101 position, if found, so that we can scan ahead and check if the
7102 word later overshoots the window edge. Use atx_it similarly, for
7108 #define BUFFER_POS_REACHED_P() \
7109 ((op & MOVE_TO_POS) != 0 \
7110 && BUFFERP (it->object) \
7111 && (IT_CHARPOS (*it) == to_charpos \
7112 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7113 && (it->method == GET_FROM_BUFFER \
7114 || (it->method == GET_FROM_DISPLAY_VECTOR \
7115 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7117 /* If there's a line-/wrap-prefix, handle it. */
7118 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7119 && it
->current_y
< it
->last_visible_y
)
7120 handle_line_prefix (it
);
7124 int x
, i
, ascent
= 0, descent
= 0;
7126 /* Utility macro to reset an iterator with x, ascent, and descent. */
7127 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7128 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7129 (IT)->max_descent = descent)
7131 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7133 if ((op
& MOVE_TO_POS
) != 0
7134 && BUFFERP (it
->object
)
7135 && it
->method
== GET_FROM_BUFFER
7136 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7138 && (prev_method
== GET_FROM_IMAGE
7139 || prev_method
== GET_FROM_STRETCH
)
7140 /* Passed TO_CHARPOS from left to right. */
7141 && ((prev_pos
< to_charpos
7142 && IT_CHARPOS (*it
) > to_charpos
)
7143 /* Passed TO_CHARPOS from right to left. */
7144 || (prev_pos
> to_charpos
7145 && IT_CHARPOS (*it
) < to_charpos
)))))
7147 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7149 result
= MOVE_POS_MATCH_OR_ZV
;
7152 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7153 /* If wrap_it is valid, the current position might be in a
7154 word that is wrapped. So, save the iterator in
7155 atpos_it and continue to see if wrapping happens. */
7159 prev_method
= it
->method
;
7160 if (it
->method
== GET_FROM_BUFFER
)
7161 prev_pos
= IT_CHARPOS (*it
);
7162 /* Stop when ZV reached.
7163 We used to stop here when TO_CHARPOS reached as well, but that is
7164 too soon if this glyph does not fit on this line. So we handle it
7165 explicitly below. */
7166 if (!get_next_display_element (it
))
7168 result
= MOVE_POS_MATCH_OR_ZV
;
7172 if (it
->line_wrap
== TRUNCATE
)
7174 if (BUFFER_POS_REACHED_P ())
7176 result
= MOVE_POS_MATCH_OR_ZV
;
7182 if (it
->line_wrap
== WORD_WRAP
)
7184 if (IT_DISPLAYING_WHITESPACE (it
))
7188 /* We have reached a glyph that follows one or more
7189 whitespace characters. If the position is
7190 already found, we are done. */
7191 if (atpos_it
.sp
>= 0)
7194 result
= MOVE_POS_MATCH_OR_ZV
;
7200 result
= MOVE_X_REACHED
;
7203 /* Otherwise, we can wrap here. */
7210 /* Remember the line height for the current line, in case
7211 the next element doesn't fit on the line. */
7212 ascent
= it
->max_ascent
;
7213 descent
= it
->max_descent
;
7215 /* The call to produce_glyphs will get the metrics of the
7216 display element IT is loaded with. Record the x-position
7217 before this display element, in case it doesn't fit on the
7221 PRODUCE_GLYPHS (it
);
7223 if (it
->area
!= TEXT_AREA
)
7225 set_iterator_to_next (it
, 1);
7229 /* The number of glyphs we get back in IT->nglyphs will normally
7230 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7231 character on a terminal frame, or (iii) a line end. For the
7232 second case, IT->nglyphs - 1 padding glyphs will be present.
7233 (On X frames, there is only one glyph produced for a
7234 composite character.)
7236 The behavior implemented below means, for continuation lines,
7237 that as many spaces of a TAB as fit on the current line are
7238 displayed there. For terminal frames, as many glyphs of a
7239 multi-glyph character are displayed in the current line, too.
7240 This is what the old redisplay code did, and we keep it that
7241 way. Under X, the whole shape of a complex character must
7242 fit on the line or it will be completely displayed in the
7245 Note that both for tabs and padding glyphs, all glyphs have
7249 /* More than one glyph or glyph doesn't fit on line. All
7250 glyphs have the same width. */
7251 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7253 int x_before_this_char
= x
;
7254 int hpos_before_this_char
= it
->hpos
;
7256 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7258 new_x
= x
+ single_glyph_width
;
7260 /* We want to leave anything reaching TO_X to the caller. */
7261 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7263 if (BUFFER_POS_REACHED_P ())
7265 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7266 goto buffer_pos_reached
;
7267 if (atpos_it
.sp
< 0)
7270 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7275 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7278 result
= MOVE_X_REACHED
;
7284 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7289 if (/* Lines are continued. */
7290 it
->line_wrap
!= TRUNCATE
7291 && (/* And glyph doesn't fit on the line. */
7292 new_x
> it
->last_visible_x
7293 /* Or it fits exactly and we're on a window
7295 || (new_x
== it
->last_visible_x
7296 && FRAME_WINDOW_P (it
->f
))))
7298 if (/* IT->hpos == 0 means the very first glyph
7299 doesn't fit on the line, e.g. a wide image. */
7301 || (new_x
== it
->last_visible_x
7302 && FRAME_WINDOW_P (it
->f
)))
7305 it
->current_x
= new_x
;
7307 /* The character's last glyph just barely fits
7309 if (i
== it
->nglyphs
- 1)
7311 /* If this is the destination position,
7312 return a position *before* it in this row,
7313 now that we know it fits in this row. */
7314 if (BUFFER_POS_REACHED_P ())
7316 if (it
->line_wrap
!= WORD_WRAP
7319 it
->hpos
= hpos_before_this_char
;
7320 it
->current_x
= x_before_this_char
;
7321 result
= MOVE_POS_MATCH_OR_ZV
;
7324 if (it
->line_wrap
== WORD_WRAP
7328 atpos_it
.current_x
= x_before_this_char
;
7329 atpos_it
.hpos
= hpos_before_this_char
;
7333 set_iterator_to_next (it
, 1);
7334 /* On graphical terminals, newlines may
7335 "overflow" into the fringe if
7336 overflow-newline-into-fringe is non-nil.
7337 On text-only terminals, newlines may
7338 overflow into the last glyph on the
7340 if (!FRAME_WINDOW_P (it
->f
)
7341 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7343 if (!get_next_display_element (it
))
7345 result
= MOVE_POS_MATCH_OR_ZV
;
7348 if (BUFFER_POS_REACHED_P ())
7350 if (ITERATOR_AT_END_OF_LINE_P (it
))
7351 result
= MOVE_POS_MATCH_OR_ZV
;
7353 result
= MOVE_LINE_CONTINUED
;
7356 if (ITERATOR_AT_END_OF_LINE_P (it
))
7358 result
= MOVE_NEWLINE_OR_CR
;
7365 IT_RESET_X_ASCENT_DESCENT (it
);
7367 if (wrap_it
.sp
>= 0)
7374 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7376 result
= MOVE_LINE_CONTINUED
;
7380 if (BUFFER_POS_REACHED_P ())
7382 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7383 goto buffer_pos_reached
;
7384 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7387 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7391 if (new_x
> it
->first_visible_x
)
7393 /* Glyph is visible. Increment number of glyphs that
7394 would be displayed. */
7399 if (result
!= MOVE_UNDEFINED
)
7402 else if (BUFFER_POS_REACHED_P ())
7405 IT_RESET_X_ASCENT_DESCENT (it
);
7406 result
= MOVE_POS_MATCH_OR_ZV
;
7409 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7411 /* Stop when TO_X specified and reached. This check is
7412 necessary here because of lines consisting of a line end,
7413 only. The line end will not produce any glyphs and we
7414 would never get MOVE_X_REACHED. */
7415 xassert (it
->nglyphs
== 0);
7416 result
= MOVE_X_REACHED
;
7420 /* Is this a line end? If yes, we're done. */
7421 if (ITERATOR_AT_END_OF_LINE_P (it
))
7423 result
= MOVE_NEWLINE_OR_CR
;
7427 if (it
->method
== GET_FROM_BUFFER
)
7428 prev_pos
= IT_CHARPOS (*it
);
7429 /* The current display element has been consumed. Advance
7431 set_iterator_to_next (it
, 1);
7433 /* Stop if lines are truncated and IT's current x-position is
7434 past the right edge of the window now. */
7435 if (it
->line_wrap
== TRUNCATE
7436 && it
->current_x
>= it
->last_visible_x
)
7438 if (!FRAME_WINDOW_P (it
->f
)
7439 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7441 if (!get_next_display_element (it
)
7442 || BUFFER_POS_REACHED_P ())
7444 result
= MOVE_POS_MATCH_OR_ZV
;
7447 if (ITERATOR_AT_END_OF_LINE_P (it
))
7449 result
= MOVE_NEWLINE_OR_CR
;
7453 result
= MOVE_LINE_TRUNCATED
;
7456 #undef IT_RESET_X_ASCENT_DESCENT
7459 #undef BUFFER_POS_REACHED_P
7461 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7462 restore the saved iterator. */
7463 if (atpos_it
.sp
>= 0)
7465 else if (atx_it
.sp
>= 0)
7470 /* Restore the iterator settings altered at the beginning of this
7472 it
->glyph_row
= saved_glyph_row
;
7476 /* For external use. */
7478 move_it_in_display_line (struct it
*it
,
7479 EMACS_INT to_charpos
, int to_x
,
7480 enum move_operation_enum op
)
7482 if (it
->line_wrap
== WORD_WRAP
7483 && (op
& MOVE_TO_X
))
7485 struct it save_it
= *it
;
7486 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7487 /* When word-wrap is on, TO_X may lie past the end
7488 of a wrapped line. Then it->current is the
7489 character on the next line, so backtrack to the
7490 space before the wrap point. */
7491 if (skip
== MOVE_LINE_CONTINUED
)
7493 int prev_x
= max (it
->current_x
- 1, 0);
7495 move_it_in_display_line_to
7496 (it
, -1, prev_x
, MOVE_TO_X
);
7500 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7504 /* Move IT forward until it satisfies one or more of the criteria in
7505 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7507 OP is a bit-mask that specifies where to stop, and in particular,
7508 which of those four position arguments makes a difference. See the
7509 description of enum move_operation_enum.
7511 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7512 screen line, this function will set IT to the next position >
7516 move_it_to (it
, to_charpos
, to_x
, to_y
, to_vpos
, op
)
7518 int to_charpos
, to_x
, to_y
, to_vpos
;
7521 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7522 int line_height
, line_start_x
= 0, reached
= 0;
7526 if (op
& MOVE_TO_VPOS
)
7528 /* If no TO_CHARPOS and no TO_X specified, stop at the
7529 start of the line TO_VPOS. */
7530 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7532 if (it
->vpos
== to_vpos
)
7538 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7542 /* TO_VPOS >= 0 means stop at TO_X in the line at
7543 TO_VPOS, or at TO_POS, whichever comes first. */
7544 if (it
->vpos
== to_vpos
)
7550 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7552 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7557 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7559 /* We have reached TO_X but not in the line we want. */
7560 skip
= move_it_in_display_line_to (it
, to_charpos
,
7562 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7570 else if (op
& MOVE_TO_Y
)
7572 struct it it_backup
;
7574 if (it
->line_wrap
== WORD_WRAP
)
7577 /* TO_Y specified means stop at TO_X in the line containing
7578 TO_Y---or at TO_CHARPOS if this is reached first. The
7579 problem is that we can't really tell whether the line
7580 contains TO_Y before we have completely scanned it, and
7581 this may skip past TO_X. What we do is to first scan to
7584 If TO_X is not specified, use a TO_X of zero. The reason
7585 is to make the outcome of this function more predictable.
7586 If we didn't use TO_X == 0, we would stop at the end of
7587 the line which is probably not what a caller would expect
7589 skip
= move_it_in_display_line_to
7590 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7591 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7593 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7594 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7596 else if (skip
== MOVE_X_REACHED
)
7598 /* If TO_X was reached, we want to know whether TO_Y is
7599 in the line. We know this is the case if the already
7600 scanned glyphs make the line tall enough. Otherwise,
7601 we must check by scanning the rest of the line. */
7602 line_height
= it
->max_ascent
+ it
->max_descent
;
7603 if (to_y
>= it
->current_y
7604 && to_y
< it
->current_y
+ line_height
)
7610 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7611 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7613 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7614 line_height
= it
->max_ascent
+ it
->max_descent
;
7615 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7617 if (to_y
>= it
->current_y
7618 && to_y
< it
->current_y
+ line_height
)
7620 /* If TO_Y is in this line and TO_X was reached
7621 above, we scanned too far. We have to restore
7622 IT's settings to the ones before skipping. */
7629 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7635 /* Check whether TO_Y is in this line. */
7636 line_height
= it
->max_ascent
+ it
->max_descent
;
7637 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7639 if (to_y
>= it
->current_y
7640 && to_y
< it
->current_y
+ line_height
)
7642 /* When word-wrap is on, TO_X may lie past the end
7643 of a wrapped line. Then it->current is the
7644 character on the next line, so backtrack to the
7645 space before the wrap point. */
7646 if (skip
== MOVE_LINE_CONTINUED
7647 && it
->line_wrap
== WORD_WRAP
)
7649 int prev_x
= max (it
->current_x
- 1, 0);
7651 skip
= move_it_in_display_line_to
7652 (it
, -1, prev_x
, MOVE_TO_X
);
7661 else if (BUFFERP (it
->object
)
7662 && (it
->method
== GET_FROM_BUFFER
7663 || it
->method
== GET_FROM_STRETCH
)
7664 && IT_CHARPOS (*it
) >= to_charpos
)
7665 skip
= MOVE_POS_MATCH_OR_ZV
;
7667 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7671 case MOVE_POS_MATCH_OR_ZV
:
7675 case MOVE_NEWLINE_OR_CR
:
7676 set_iterator_to_next (it
, 1);
7677 it
->continuation_lines_width
= 0;
7680 case MOVE_LINE_TRUNCATED
:
7681 it
->continuation_lines_width
= 0;
7682 reseat_at_next_visible_line_start (it
, 0);
7683 if ((op
& MOVE_TO_POS
) != 0
7684 && IT_CHARPOS (*it
) > to_charpos
)
7691 case MOVE_LINE_CONTINUED
:
7692 /* For continued lines ending in a tab, some of the glyphs
7693 associated with the tab are displayed on the current
7694 line. Since it->current_x does not include these glyphs,
7695 we use it->last_visible_x instead. */
7698 it
->continuation_lines_width
+= it
->last_visible_x
;
7699 /* When moving by vpos, ensure that the iterator really
7700 advances to the next line (bug#847, bug#969). Fixme:
7701 do we need to do this in other circumstances? */
7702 if (it
->current_x
!= it
->last_visible_x
7703 && (op
& MOVE_TO_VPOS
)
7704 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7706 line_start_x
= it
->current_x
+ it
->pixel_width
7707 - it
->last_visible_x
;
7708 set_iterator_to_next (it
, 0);
7712 it
->continuation_lines_width
+= it
->current_x
;
7719 /* Reset/increment for the next run. */
7720 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7721 it
->current_x
= line_start_x
;
7724 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7726 last_height
= it
->max_ascent
+ it
->max_descent
;
7727 last_max_ascent
= it
->max_ascent
;
7728 it
->max_ascent
= it
->max_descent
= 0;
7733 /* On text terminals, we may stop at the end of a line in the middle
7734 of a multi-character glyph. If the glyph itself is continued,
7735 i.e. it is actually displayed on the next line, don't treat this
7736 stopping point as valid; move to the next line instead (unless
7737 that brings us offscreen). */
7738 if (!FRAME_WINDOW_P (it
->f
)
7740 && IT_CHARPOS (*it
) == to_charpos
7741 && it
->what
== IT_CHARACTER
7743 && it
->line_wrap
== WINDOW_WRAP
7744 && it
->current_x
== it
->last_visible_x
- 1
7747 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7749 it
->continuation_lines_width
+= it
->current_x
;
7750 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7751 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7753 last_height
= it
->max_ascent
+ it
->max_descent
;
7754 last_max_ascent
= it
->max_ascent
;
7757 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7761 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7763 If DY > 0, move IT backward at least that many pixels. DY = 0
7764 means move IT backward to the preceding line start or BEGV. This
7765 function may move over more than DY pixels if IT->current_y - DY
7766 ends up in the middle of a line; in this case IT->current_y will be
7767 set to the top of the line moved to. */
7770 move_it_vertically_backward (it
, dy
)
7781 start_pos
= IT_CHARPOS (*it
);
7783 /* Estimate how many newlines we must move back. */
7784 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7786 /* Set the iterator's position that many lines back. */
7787 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7788 back_to_previous_visible_line_start (it
);
7790 /* Reseat the iterator here. When moving backward, we don't want
7791 reseat to skip forward over invisible text, set up the iterator
7792 to deliver from overlay strings at the new position etc. So,
7793 use reseat_1 here. */
7794 reseat_1 (it
, it
->current
.pos
, 1);
7796 /* We are now surely at a line start. */
7797 it
->current_x
= it
->hpos
= 0;
7798 it
->continuation_lines_width
= 0;
7800 /* Move forward and see what y-distance we moved. First move to the
7801 start of the next line so that we get its height. We need this
7802 height to be able to tell whether we reached the specified
7805 it2
.max_ascent
= it2
.max_descent
= 0;
7808 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7809 MOVE_TO_POS
| MOVE_TO_VPOS
);
7811 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7812 xassert (IT_CHARPOS (*it
) >= BEGV
);
7815 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7816 xassert (IT_CHARPOS (*it
) >= BEGV
);
7817 /* H is the actual vertical distance from the position in *IT
7818 and the starting position. */
7819 h
= it2
.current_y
- it
->current_y
;
7820 /* NLINES is the distance in number of lines. */
7821 nlines
= it2
.vpos
- it
->vpos
;
7823 /* Correct IT's y and vpos position
7824 so that they are relative to the starting point. */
7830 /* DY == 0 means move to the start of the screen line. The
7831 value of nlines is > 0 if continuation lines were involved. */
7833 move_it_by_lines (it
, nlines
, 1);
7837 /* The y-position we try to reach, relative to *IT.
7838 Note that H has been subtracted in front of the if-statement. */
7839 int target_y
= it
->current_y
+ h
- dy
;
7840 int y0
= it3
.current_y
;
7841 int y1
= line_bottom_y (&it3
);
7842 int line_height
= y1
- y0
;
7844 /* If we did not reach target_y, try to move further backward if
7845 we can. If we moved too far backward, try to move forward. */
7846 if (target_y
< it
->current_y
7847 /* This is heuristic. In a window that's 3 lines high, with
7848 a line height of 13 pixels each, recentering with point
7849 on the bottom line will try to move -39/2 = 19 pixels
7850 backward. Try to avoid moving into the first line. */
7851 && (it
->current_y
- target_y
7852 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7853 && IT_CHARPOS (*it
) > BEGV
)
7855 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7856 target_y
- it
->current_y
));
7857 dy
= it
->current_y
- target_y
;
7858 goto move_further_back
;
7860 else if (target_y
>= it
->current_y
+ line_height
7861 && IT_CHARPOS (*it
) < ZV
)
7863 /* Should move forward by at least one line, maybe more.
7865 Note: Calling move_it_by_lines can be expensive on
7866 terminal frames, where compute_motion is used (via
7867 vmotion) to do the job, when there are very long lines
7868 and truncate-lines is nil. That's the reason for
7869 treating terminal frames specially here. */
7871 if (!FRAME_WINDOW_P (it
->f
))
7872 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7877 move_it_by_lines (it
, 1, 1);
7879 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7886 /* Move IT by a specified amount of pixel lines DY. DY negative means
7887 move backwards. DY = 0 means move to start of screen line. At the
7888 end, IT will be on the start of a screen line. */
7891 move_it_vertically (it
, dy
)
7896 move_it_vertically_backward (it
, -dy
);
7899 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7900 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7901 MOVE_TO_POS
| MOVE_TO_Y
);
7902 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7904 /* If buffer ends in ZV without a newline, move to the start of
7905 the line to satisfy the post-condition. */
7906 if (IT_CHARPOS (*it
) == ZV
7908 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7909 move_it_by_lines (it
, 0, 0);
7914 /* Move iterator IT past the end of the text line it is in. */
7917 move_it_past_eol (it
)
7920 enum move_it_result rc
;
7922 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7923 if (rc
== MOVE_NEWLINE_OR_CR
)
7924 set_iterator_to_next (it
, 0);
7928 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7929 negative means move up. DVPOS == 0 means move to the start of the
7930 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7931 NEED_Y_P is zero, IT->current_y will be left unchanged.
7933 Further optimization ideas: If we would know that IT->f doesn't use
7934 a face with proportional font, we could be faster for
7935 truncate-lines nil. */
7938 move_it_by_lines (it
, dvpos
, need_y_p
)
7940 int dvpos
, need_y_p
;
7942 struct position pos
;
7944 /* The commented-out optimization uses vmotion on terminals. This
7945 gives bad results, because elements like it->what, on which
7946 callers such as pos_visible_p rely, aren't updated. */
7947 /* if (!FRAME_WINDOW_P (it->f))
7949 struct text_pos textpos;
7951 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7952 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7953 reseat (it, textpos, 1);
7954 it->vpos += pos.vpos;
7955 it->current_y += pos.vpos;
7961 /* DVPOS == 0 means move to the start of the screen line. */
7962 move_it_vertically_backward (it
, 0);
7963 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7964 /* Let next call to line_bottom_y calculate real line height */
7969 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7970 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7971 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7976 int start_charpos
, i
;
7978 /* Start at the beginning of the screen line containing IT's
7979 position. This may actually move vertically backwards,
7980 in case of overlays, so adjust dvpos accordingly. */
7982 move_it_vertically_backward (it
, 0);
7985 /* Go back -DVPOS visible lines and reseat the iterator there. */
7986 start_charpos
= IT_CHARPOS (*it
);
7987 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7988 back_to_previous_visible_line_start (it
);
7989 reseat (it
, it
->current
.pos
, 1);
7991 /* Move further back if we end up in a string or an image. */
7992 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7994 /* First try to move to start of display line. */
7996 move_it_vertically_backward (it
, 0);
7998 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8000 /* If start of line is still in string or image,
8001 move further back. */
8002 back_to_previous_visible_line_start (it
);
8003 reseat (it
, it
->current
.pos
, 1);
8007 it
->current_x
= it
->hpos
= 0;
8009 /* Above call may have moved too far if continuation lines
8010 are involved. Scan forward and see if it did. */
8012 it2
.vpos
= it2
.current_y
= 0;
8013 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8014 it
->vpos
-= it2
.vpos
;
8015 it
->current_y
-= it2
.current_y
;
8016 it
->current_x
= it
->hpos
= 0;
8018 /* If we moved too far back, move IT some lines forward. */
8019 if (it2
.vpos
> -dvpos
)
8021 int delta
= it2
.vpos
+ dvpos
;
8023 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8024 /* Move back again if we got too far ahead. */
8025 if (IT_CHARPOS (*it
) >= start_charpos
)
8031 /* Return 1 if IT points into the middle of a display vector. */
8034 in_display_vector_p (it
)
8037 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8038 && it
->current
.dpvec_index
> 0
8039 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8043 /***********************************************************************
8045 ***********************************************************************/
8048 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8052 add_to_log (format
, arg1
, arg2
)
8054 Lisp_Object arg1
, arg2
;
8056 Lisp_Object args
[3];
8057 Lisp_Object msg
, fmt
;
8060 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8063 /* Do nothing if called asynchronously. Inserting text into
8064 a buffer may call after-change-functions and alike and
8065 that would means running Lisp asynchronously. */
8066 if (handling_signal
)
8070 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8072 args
[0] = fmt
= build_string (format
);
8075 msg
= Fformat (3, args
);
8077 len
= SBYTES (msg
) + 1;
8078 SAFE_ALLOCA (buffer
, char *, len
);
8079 bcopy (SDATA (msg
), buffer
, len
);
8081 message_dolog (buffer
, len
- 1, 1, 0);
8088 /* Output a newline in the *Messages* buffer if "needs" one. */
8091 message_log_maybe_newline ()
8093 if (message_log_need_newline
)
8094 message_dolog ("", 0, 1, 0);
8098 /* Add a string M of length NBYTES to the message log, optionally
8099 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8100 nonzero, means interpret the contents of M as multibyte. This
8101 function calls low-level routines in order to bypass text property
8102 hooks, etc. which might not be safe to run.
8104 This may GC (insert may run before/after change hooks),
8105 so the buffer M must NOT point to a Lisp string. */
8108 message_dolog (m
, nbytes
, nlflag
, multibyte
)
8110 int nbytes
, nlflag
, multibyte
;
8112 if (!NILP (Vmemory_full
))
8115 if (!NILP (Vmessage_log_max
))
8117 struct buffer
*oldbuf
;
8118 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8119 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8120 int point_at_end
= 0;
8122 Lisp_Object old_deactivate_mark
, tem
;
8123 struct gcpro gcpro1
;
8125 old_deactivate_mark
= Vdeactivate_mark
;
8126 oldbuf
= current_buffer
;
8127 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8128 current_buffer
->undo_list
= Qt
;
8130 oldpoint
= message_dolog_marker1
;
8131 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8132 oldbegv
= message_dolog_marker2
;
8133 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8134 oldzv
= message_dolog_marker3
;
8135 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8136 GCPRO1 (old_deactivate_mark
);
8144 BEGV_BYTE
= BEG_BYTE
;
8147 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8149 /* Insert the string--maybe converting multibyte to single byte
8150 or vice versa, so that all the text fits the buffer. */
8152 && NILP (current_buffer
->enable_multibyte_characters
))
8154 int i
, c
, char_bytes
;
8155 unsigned char work
[1];
8157 /* Convert a multibyte string to single-byte
8158 for the *Message* buffer. */
8159 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8161 c
= string_char_and_length (m
+ i
, &char_bytes
);
8162 work
[0] = (ASCII_CHAR_P (c
)
8164 : multibyte_char_to_unibyte (c
, Qnil
));
8165 insert_1_both (work
, 1, 1, 1, 0, 0);
8168 else if (! multibyte
8169 && ! NILP (current_buffer
->enable_multibyte_characters
))
8171 int i
, c
, char_bytes
;
8172 unsigned char *msg
= (unsigned char *) m
;
8173 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8174 /* Convert a single-byte string to multibyte
8175 for the *Message* buffer. */
8176 for (i
= 0; i
< nbytes
; i
++)
8179 MAKE_CHAR_MULTIBYTE (c
);
8180 char_bytes
= CHAR_STRING (c
, str
);
8181 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8185 insert_1 (m
, nbytes
, 1, 0, 0);
8189 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8190 insert_1 ("\n", 1, 1, 0, 0);
8192 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8194 this_bol_byte
= PT_BYTE
;
8196 /* See if this line duplicates the previous one.
8197 If so, combine duplicates. */
8200 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8202 prev_bol_byte
= PT_BYTE
;
8204 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8205 this_bol
, this_bol_byte
);
8208 del_range_both (prev_bol
, prev_bol_byte
,
8209 this_bol
, this_bol_byte
, 0);
8215 /* If you change this format, don't forget to also
8216 change message_log_check_duplicate. */
8217 sprintf (dupstr
, " [%d times]", dup
);
8218 duplen
= strlen (dupstr
);
8219 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8220 insert_1 (dupstr
, duplen
, 1, 0, 1);
8225 /* If we have more than the desired maximum number of lines
8226 in the *Messages* buffer now, delete the oldest ones.
8227 This is safe because we don't have undo in this buffer. */
8229 if (NATNUMP (Vmessage_log_max
))
8231 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8232 -XFASTINT (Vmessage_log_max
) - 1, 0);
8233 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8236 BEGV
= XMARKER (oldbegv
)->charpos
;
8237 BEGV_BYTE
= marker_byte_position (oldbegv
);
8246 ZV
= XMARKER (oldzv
)->charpos
;
8247 ZV_BYTE
= marker_byte_position (oldzv
);
8251 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8253 /* We can't do Fgoto_char (oldpoint) because it will run some
8255 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8256 XMARKER (oldpoint
)->bytepos
);
8259 unchain_marker (XMARKER (oldpoint
));
8260 unchain_marker (XMARKER (oldbegv
));
8261 unchain_marker (XMARKER (oldzv
));
8263 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8264 set_buffer_internal (oldbuf
);
8266 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8267 message_log_need_newline
= !nlflag
;
8268 Vdeactivate_mark
= old_deactivate_mark
;
8273 /* We are at the end of the buffer after just having inserted a newline.
8274 (Note: We depend on the fact we won't be crossing the gap.)
8275 Check to see if the most recent message looks a lot like the previous one.
8276 Return 0 if different, 1 if the new one should just replace it, or a
8277 value N > 1 if we should also append " [N times]". */
8280 message_log_check_duplicate (prev_bol
, prev_bol_byte
, this_bol
, this_bol_byte
)
8281 int prev_bol
, this_bol
;
8282 int prev_bol_byte
, this_bol_byte
;
8285 int len
= Z_BYTE
- 1 - this_bol_byte
;
8287 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8288 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8290 for (i
= 0; i
< len
; i
++)
8292 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8300 if (*p1
++ == ' ' && *p1
++ == '[')
8303 while (*p1
>= '0' && *p1
<= '9')
8304 n
= n
* 10 + *p1
++ - '0';
8305 if (strncmp (p1
, " times]\n", 8) == 0)
8312 /* Display an echo area message M with a specified length of NBYTES
8313 bytes. The string may include null characters. If M is 0, clear
8314 out any existing message, and let the mini-buffer text show
8317 This may GC, so the buffer M must NOT point to a Lisp string. */
8320 message2 (m
, nbytes
, multibyte
)
8325 /* First flush out any partial line written with print. */
8326 message_log_maybe_newline ();
8328 message_dolog (m
, nbytes
, 1, multibyte
);
8329 message2_nolog (m
, nbytes
, multibyte
);
8333 /* The non-logging counterpart of message2. */
8336 message2_nolog (m
, nbytes
, multibyte
)
8338 int nbytes
, multibyte
;
8340 struct frame
*sf
= SELECTED_FRAME ();
8341 message_enable_multibyte
= multibyte
;
8343 if (FRAME_INITIAL_P (sf
))
8345 if (noninteractive_need_newline
)
8346 putc ('\n', stderr
);
8347 noninteractive_need_newline
= 0;
8349 fwrite (m
, nbytes
, 1, stderr
);
8350 if (cursor_in_echo_area
== 0)
8351 fprintf (stderr
, "\n");
8354 /* A null message buffer means that the frame hasn't really been
8355 initialized yet. Error messages get reported properly by
8356 cmd_error, so this must be just an informative message; toss it. */
8357 else if (INTERACTIVE
8358 && sf
->glyphs_initialized_p
8359 && FRAME_MESSAGE_BUF (sf
))
8361 Lisp_Object mini_window
;
8364 /* Get the frame containing the mini-buffer
8365 that the selected frame is using. */
8366 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8367 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8369 FRAME_SAMPLE_VISIBILITY (f
);
8370 if (FRAME_VISIBLE_P (sf
)
8371 && ! FRAME_VISIBLE_P (f
))
8372 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8376 set_message (m
, Qnil
, nbytes
, multibyte
);
8377 if (minibuffer_auto_raise
)
8378 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8381 clear_message (1, 1);
8383 do_pending_window_change (0);
8384 echo_area_display (1);
8385 do_pending_window_change (0);
8386 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8387 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8392 /* Display an echo area message M with a specified length of NBYTES
8393 bytes. The string may include null characters. If M is not a
8394 string, clear out any existing message, and let the mini-buffer
8397 This function cancels echoing. */
8400 message3 (m
, nbytes
, multibyte
)
8405 struct gcpro gcpro1
;
8408 clear_message (1,1);
8411 /* First flush out any partial line written with print. */
8412 message_log_maybe_newline ();
8418 SAFE_ALLOCA (buffer
, char *, nbytes
);
8419 bcopy (SDATA (m
), buffer
, nbytes
);
8420 message_dolog (buffer
, nbytes
, 1, multibyte
);
8423 message3_nolog (m
, nbytes
, multibyte
);
8429 /* The non-logging version of message3.
8430 This does not cancel echoing, because it is used for echoing.
8431 Perhaps we need to make a separate function for echoing
8432 and make this cancel echoing. */
8435 message3_nolog (m
, nbytes
, multibyte
)
8437 int nbytes
, multibyte
;
8439 struct frame
*sf
= SELECTED_FRAME ();
8440 message_enable_multibyte
= multibyte
;
8442 if (FRAME_INITIAL_P (sf
))
8444 if (noninteractive_need_newline
)
8445 putc ('\n', stderr
);
8446 noninteractive_need_newline
= 0;
8448 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8449 if (cursor_in_echo_area
== 0)
8450 fprintf (stderr
, "\n");
8453 /* A null message buffer means that the frame hasn't really been
8454 initialized yet. Error messages get reported properly by
8455 cmd_error, so this must be just an informative message; toss it. */
8456 else if (INTERACTIVE
8457 && sf
->glyphs_initialized_p
8458 && FRAME_MESSAGE_BUF (sf
))
8460 Lisp_Object mini_window
;
8464 /* Get the frame containing the mini-buffer
8465 that the selected frame is using. */
8466 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8467 frame
= XWINDOW (mini_window
)->frame
;
8470 FRAME_SAMPLE_VISIBILITY (f
);
8471 if (FRAME_VISIBLE_P (sf
)
8472 && !FRAME_VISIBLE_P (f
))
8473 Fmake_frame_visible (frame
);
8475 if (STRINGP (m
) && SCHARS (m
) > 0)
8477 set_message (NULL
, m
, nbytes
, multibyte
);
8478 if (minibuffer_auto_raise
)
8479 Fraise_frame (frame
);
8480 /* Assume we are not echoing.
8481 (If we are, echo_now will override this.) */
8482 echo_message_buffer
= Qnil
;
8485 clear_message (1, 1);
8487 do_pending_window_change (0);
8488 echo_area_display (1);
8489 do_pending_window_change (0);
8490 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8491 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8496 /* Display a null-terminated echo area message M. If M is 0, clear
8497 out any existing message, and let the mini-buffer text show through.
8499 The buffer M must continue to exist until after the echo area gets
8500 cleared or some other message gets displayed there. Do not pass
8501 text that is stored in a Lisp string. Do not pass text in a buffer
8502 that was alloca'd. */
8508 message2 (m
, (m
? strlen (m
) : 0), 0);
8512 /* The non-logging counterpart of message1. */
8518 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8521 /* Display a message M which contains a single %s
8522 which gets replaced with STRING. */
8525 message_with_string (m
, string
, log
)
8530 CHECK_STRING (string
);
8536 if (noninteractive_need_newline
)
8537 putc ('\n', stderr
);
8538 noninteractive_need_newline
= 0;
8539 fprintf (stderr
, m
, SDATA (string
));
8540 if (!cursor_in_echo_area
)
8541 fprintf (stderr
, "\n");
8545 else if (INTERACTIVE
)
8547 /* The frame whose minibuffer we're going to display the message on.
8548 It may be larger than the selected frame, so we need
8549 to use its buffer, not the selected frame's buffer. */
8550 Lisp_Object mini_window
;
8551 struct frame
*f
, *sf
= SELECTED_FRAME ();
8553 /* Get the frame containing the minibuffer
8554 that the selected frame is using. */
8555 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8556 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8558 /* A null message buffer means that the frame hasn't really been
8559 initialized yet. Error messages get reported properly by
8560 cmd_error, so this must be just an informative message; toss it. */
8561 if (FRAME_MESSAGE_BUF (f
))
8563 Lisp_Object args
[2], message
;
8564 struct gcpro gcpro1
, gcpro2
;
8566 args
[0] = build_string (m
);
8567 args
[1] = message
= string
;
8568 GCPRO2 (args
[0], message
);
8571 message
= Fformat (2, args
);
8574 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8576 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8580 /* Print should start at the beginning of the message
8581 buffer next time. */
8582 message_buf_print
= 0;
8588 /* Dump an informative message to the minibuf. If M is 0, clear out
8589 any existing message, and let the mini-buffer text show through. */
8593 message (m
, a1
, a2
, a3
)
8595 EMACS_INT a1
, a2
, a3
;
8601 if (noninteractive_need_newline
)
8602 putc ('\n', stderr
);
8603 noninteractive_need_newline
= 0;
8604 fprintf (stderr
, m
, a1
, a2
, a3
);
8605 if (cursor_in_echo_area
== 0)
8606 fprintf (stderr
, "\n");
8610 else if (INTERACTIVE
)
8612 /* The frame whose mini-buffer we're going to display the message
8613 on. It may be larger than the selected frame, so we need to
8614 use its buffer, not the selected frame's buffer. */
8615 Lisp_Object mini_window
;
8616 struct frame
*f
, *sf
= SELECTED_FRAME ();
8618 /* Get the frame containing the mini-buffer
8619 that the selected frame is using. */
8620 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8621 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8623 /* A null message buffer means that the frame hasn't really been
8624 initialized yet. Error messages get reported properly by
8625 cmd_error, so this must be just an informative message; toss
8627 if (FRAME_MESSAGE_BUF (f
))
8637 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8638 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, 3, a
);
8640 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8645 /* Print should start at the beginning of the message
8646 buffer next time. */
8647 message_buf_print
= 0;
8653 /* The non-logging version of message. */
8656 message_nolog (m
, a1
, a2
, a3
)
8658 EMACS_INT a1
, a2
, a3
;
8660 Lisp_Object old_log_max
;
8661 old_log_max
= Vmessage_log_max
;
8662 Vmessage_log_max
= Qnil
;
8663 message (m
, a1
, a2
, a3
);
8664 Vmessage_log_max
= old_log_max
;
8668 /* Display the current message in the current mini-buffer. This is
8669 only called from error handlers in process.c, and is not time
8675 if (!NILP (echo_area_buffer
[0]))
8678 string
= Fcurrent_message ();
8679 message3 (string
, SBYTES (string
),
8680 !NILP (current_buffer
->enable_multibyte_characters
));
8685 /* Make sure echo area buffers in `echo_buffers' are live.
8686 If they aren't, make new ones. */
8689 ensure_echo_area_buffers ()
8693 for (i
= 0; i
< 2; ++i
)
8694 if (!BUFFERP (echo_buffer
[i
])
8695 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8698 Lisp_Object old_buffer
;
8701 old_buffer
= echo_buffer
[i
];
8702 sprintf (name
, " *Echo Area %d*", i
);
8703 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8704 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8705 /* to force word wrap in echo area -
8706 it was decided to postpone this*/
8707 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8709 for (j
= 0; j
< 2; ++j
)
8710 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8711 echo_area_buffer
[j
] = echo_buffer
[i
];
8716 /* Call FN with args A1..A4 with either the current or last displayed
8717 echo_area_buffer as current buffer.
8719 WHICH zero means use the current message buffer
8720 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8721 from echo_buffer[] and clear it.
8723 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8724 suitable buffer from echo_buffer[] and clear it.
8726 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8727 that the current message becomes the last displayed one, make
8728 choose a suitable buffer for echo_area_buffer[0], and clear it.
8730 Value is what FN returns. */
8733 with_echo_area_buffer (w
, which
, fn
, a1
, a2
, a3
, a4
)
8736 int (*fn
) P_ ((EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
));
8742 int this_one
, the_other
, clear_buffer_p
, rc
;
8743 int count
= SPECPDL_INDEX ();
8745 /* If buffers aren't live, make new ones. */
8746 ensure_echo_area_buffers ();
8751 this_one
= 0, the_other
= 1;
8753 this_one
= 1, the_other
= 0;
8756 this_one
= 0, the_other
= 1;
8759 /* We need a fresh one in case the current echo buffer equals
8760 the one containing the last displayed echo area message. */
8761 if (!NILP (echo_area_buffer
[this_one
])
8762 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8763 echo_area_buffer
[this_one
] = Qnil
;
8766 /* Choose a suitable buffer from echo_buffer[] is we don't
8768 if (NILP (echo_area_buffer
[this_one
]))
8770 echo_area_buffer
[this_one
]
8771 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8772 ? echo_buffer
[the_other
]
8773 : echo_buffer
[this_one
]);
8777 buffer
= echo_area_buffer
[this_one
];
8779 /* Don't get confused by reusing the buffer used for echoing
8780 for a different purpose. */
8781 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8784 record_unwind_protect (unwind_with_echo_area_buffer
,
8785 with_echo_area_buffer_unwind_data (w
));
8787 /* Make the echo area buffer current. Note that for display
8788 purposes, it is not necessary that the displayed window's buffer
8789 == current_buffer, except for text property lookup. So, let's
8790 only set that buffer temporarily here without doing a full
8791 Fset_window_buffer. We must also change w->pointm, though,
8792 because otherwise an assertions in unshow_buffer fails, and Emacs
8794 set_buffer_internal_1 (XBUFFER (buffer
));
8798 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8801 current_buffer
->undo_list
= Qt
;
8802 current_buffer
->read_only
= Qnil
;
8803 specbind (Qinhibit_read_only
, Qt
);
8804 specbind (Qinhibit_modification_hooks
, Qt
);
8806 if (clear_buffer_p
&& Z
> BEG
)
8809 xassert (BEGV
>= BEG
);
8810 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8812 rc
= fn (a1
, a2
, a3
, a4
);
8814 xassert (BEGV
>= BEG
);
8815 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8817 unbind_to (count
, Qnil
);
8822 /* Save state that should be preserved around the call to the function
8823 FN called in with_echo_area_buffer. */
8826 with_echo_area_buffer_unwind_data (w
)
8830 Lisp_Object vector
, tmp
;
8832 /* Reduce consing by keeping one vector in
8833 Vwith_echo_area_save_vector. */
8834 vector
= Vwith_echo_area_save_vector
;
8835 Vwith_echo_area_save_vector
= Qnil
;
8838 vector
= Fmake_vector (make_number (7), Qnil
);
8840 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8841 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8842 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8846 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8847 ASET (vector
, i
, w
->buffer
); ++i
;
8848 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8849 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8854 for (; i
< end
; ++i
)
8855 ASET (vector
, i
, Qnil
);
8858 xassert (i
== ASIZE (vector
));
8863 /* Restore global state from VECTOR which was created by
8864 with_echo_area_buffer_unwind_data. */
8867 unwind_with_echo_area_buffer (vector
)
8870 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8871 Vdeactivate_mark
= AREF (vector
, 1);
8872 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8874 if (WINDOWP (AREF (vector
, 3)))
8877 Lisp_Object buffer
, charpos
, bytepos
;
8879 w
= XWINDOW (AREF (vector
, 3));
8880 buffer
= AREF (vector
, 4);
8881 charpos
= AREF (vector
, 5);
8882 bytepos
= AREF (vector
, 6);
8885 set_marker_both (w
->pointm
, buffer
,
8886 XFASTINT (charpos
), XFASTINT (bytepos
));
8889 Vwith_echo_area_save_vector
= vector
;
8894 /* Set up the echo area for use by print functions. MULTIBYTE_P
8895 non-zero means we will print multibyte. */
8898 setup_echo_area_for_printing (multibyte_p
)
8901 /* If we can't find an echo area any more, exit. */
8902 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8905 ensure_echo_area_buffers ();
8907 if (!message_buf_print
)
8909 /* A message has been output since the last time we printed.
8910 Choose a fresh echo area buffer. */
8911 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8912 echo_area_buffer
[0] = echo_buffer
[1];
8914 echo_area_buffer
[0] = echo_buffer
[0];
8916 /* Switch to that buffer and clear it. */
8917 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8918 current_buffer
->truncate_lines
= Qnil
;
8922 int count
= SPECPDL_INDEX ();
8923 specbind (Qinhibit_read_only
, Qt
);
8924 /* Note that undo recording is always disabled. */
8926 unbind_to (count
, Qnil
);
8928 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8930 /* Set up the buffer for the multibyteness we need. */
8932 != !NILP (current_buffer
->enable_multibyte_characters
))
8933 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8935 /* Raise the frame containing the echo area. */
8936 if (minibuffer_auto_raise
)
8938 struct frame
*sf
= SELECTED_FRAME ();
8939 Lisp_Object mini_window
;
8940 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8941 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8944 message_log_maybe_newline ();
8945 message_buf_print
= 1;
8949 if (NILP (echo_area_buffer
[0]))
8951 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8952 echo_area_buffer
[0] = echo_buffer
[1];
8954 echo_area_buffer
[0] = echo_buffer
[0];
8957 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8959 /* Someone switched buffers between print requests. */
8960 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8961 current_buffer
->truncate_lines
= Qnil
;
8967 /* Display an echo area message in window W. Value is non-zero if W's
8968 height is changed. If display_last_displayed_message_p is
8969 non-zero, display the message that was last displayed, otherwise
8970 display the current message. */
8973 display_echo_area (w
)
8976 int i
, no_message_p
, window_height_changed_p
, count
;
8978 /* Temporarily disable garbage collections while displaying the echo
8979 area. This is done because a GC can print a message itself.
8980 That message would modify the echo area buffer's contents while a
8981 redisplay of the buffer is going on, and seriously confuse
8983 count
= inhibit_garbage_collection ();
8985 /* If there is no message, we must call display_echo_area_1
8986 nevertheless because it resizes the window. But we will have to
8987 reset the echo_area_buffer in question to nil at the end because
8988 with_echo_area_buffer will sets it to an empty buffer. */
8989 i
= display_last_displayed_message_p
? 1 : 0;
8990 no_message_p
= NILP (echo_area_buffer
[i
]);
8992 window_height_changed_p
8993 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8994 display_echo_area_1
,
8995 (EMACS_INT
) w
, Qnil
, 0, 0);
8998 echo_area_buffer
[i
] = Qnil
;
9000 unbind_to (count
, Qnil
);
9001 return window_height_changed_p
;
9005 /* Helper for display_echo_area. Display the current buffer which
9006 contains the current echo area message in window W, a mini-window,
9007 a pointer to which is passed in A1. A2..A4 are currently not used.
9008 Change the height of W so that all of the message is displayed.
9009 Value is non-zero if height of W was changed. */
9012 display_echo_area_1 (a1
, a2
, a3
, a4
)
9017 struct window
*w
= (struct window
*) a1
;
9019 struct text_pos start
;
9020 int window_height_changed_p
= 0;
9022 /* Do this before displaying, so that we have a large enough glyph
9023 matrix for the display. If we can't get enough space for the
9024 whole text, display the last N lines. That works by setting w->start. */
9025 window_height_changed_p
= resize_mini_window (w
, 0);
9027 /* Use the starting position chosen by resize_mini_window. */
9028 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9031 clear_glyph_matrix (w
->desired_matrix
);
9032 XSETWINDOW (window
, w
);
9033 try_window (window
, start
, 0);
9035 return window_height_changed_p
;
9039 /* Resize the echo area window to exactly the size needed for the
9040 currently displayed message, if there is one. If a mini-buffer
9041 is active, don't shrink it. */
9044 resize_echo_area_exactly ()
9046 if (BUFFERP (echo_area_buffer
[0])
9047 && WINDOWP (echo_area_window
))
9049 struct window
*w
= XWINDOW (echo_area_window
);
9051 Lisp_Object resize_exactly
;
9053 if (minibuf_level
== 0)
9054 resize_exactly
= Qt
;
9056 resize_exactly
= Qnil
;
9058 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9059 (EMACS_INT
) w
, resize_exactly
, 0, 0);
9062 ++windows_or_buffers_changed
;
9063 ++update_mode_lines
;
9064 redisplay_internal (0);
9070 /* Callback function for with_echo_area_buffer, when used from
9071 resize_echo_area_exactly. A1 contains a pointer to the window to
9072 resize, EXACTLY non-nil means resize the mini-window exactly to the
9073 size of the text displayed. A3 and A4 are not used. Value is what
9074 resize_mini_window returns. */
9077 resize_mini_window_1 (a1
, exactly
, a3
, a4
)
9079 Lisp_Object exactly
;
9082 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
9086 /* Resize mini-window W to fit the size of its contents. EXACT_P
9087 means size the window exactly to the size needed. Otherwise, it's
9088 only enlarged until W's buffer is empty.
9090 Set W->start to the right place to begin display. If the whole
9091 contents fit, start at the beginning. Otherwise, start so as
9092 to make the end of the contents appear. This is particularly
9093 important for y-or-n-p, but seems desirable generally.
9095 Value is non-zero if the window height has been changed. */
9098 resize_mini_window (w
, exact_p
)
9102 struct frame
*f
= XFRAME (w
->frame
);
9103 int window_height_changed_p
= 0;
9105 xassert (MINI_WINDOW_P (w
));
9107 /* By default, start display at the beginning. */
9108 set_marker_both (w
->start
, w
->buffer
,
9109 BUF_BEGV (XBUFFER (w
->buffer
)),
9110 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9112 /* Don't resize windows while redisplaying a window; it would
9113 confuse redisplay functions when the size of the window they are
9114 displaying changes from under them. Such a resizing can happen,
9115 for instance, when which-func prints a long message while
9116 we are running fontification-functions. We're running these
9117 functions with safe_call which binds inhibit-redisplay to t. */
9118 if (!NILP (Vinhibit_redisplay
))
9121 /* Nil means don't try to resize. */
9122 if (NILP (Vresize_mini_windows
)
9123 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9126 if (!FRAME_MINIBUF_ONLY_P (f
))
9129 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9130 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9131 int height
, max_height
;
9132 int unit
= FRAME_LINE_HEIGHT (f
);
9133 struct text_pos start
;
9134 struct buffer
*old_current_buffer
= NULL
;
9136 if (current_buffer
!= XBUFFER (w
->buffer
))
9138 old_current_buffer
= current_buffer
;
9139 set_buffer_internal (XBUFFER (w
->buffer
));
9142 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9144 /* Compute the max. number of lines specified by the user. */
9145 if (FLOATP (Vmax_mini_window_height
))
9146 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9147 else if (INTEGERP (Vmax_mini_window_height
))
9148 max_height
= XINT (Vmax_mini_window_height
);
9150 max_height
= total_height
/ 4;
9152 /* Correct that max. height if it's bogus. */
9153 max_height
= max (1, max_height
);
9154 max_height
= min (total_height
, max_height
);
9156 /* Find out the height of the text in the window. */
9157 if (it
.line_wrap
== TRUNCATE
)
9162 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9163 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9164 height
= it
.current_y
+ last_height
;
9166 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9167 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9168 height
= (height
+ unit
- 1) / unit
;
9171 /* Compute a suitable window start. */
9172 if (height
> max_height
)
9174 height
= max_height
;
9175 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9176 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9177 start
= it
.current
.pos
;
9180 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9181 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9183 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9185 /* Let it grow only, until we display an empty message, in which
9186 case the window shrinks again. */
9187 if (height
> WINDOW_TOTAL_LINES (w
))
9189 int old_height
= WINDOW_TOTAL_LINES (w
);
9190 freeze_window_starts (f
, 1);
9191 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9192 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9194 else if (height
< WINDOW_TOTAL_LINES (w
)
9195 && (exact_p
|| BEGV
== ZV
))
9197 int old_height
= WINDOW_TOTAL_LINES (w
);
9198 freeze_window_starts (f
, 0);
9199 shrink_mini_window (w
);
9200 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9205 /* Always resize to exact size needed. */
9206 if (height
> WINDOW_TOTAL_LINES (w
))
9208 int old_height
= WINDOW_TOTAL_LINES (w
);
9209 freeze_window_starts (f
, 1);
9210 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9211 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9213 else if (height
< WINDOW_TOTAL_LINES (w
))
9215 int old_height
= WINDOW_TOTAL_LINES (w
);
9216 freeze_window_starts (f
, 0);
9217 shrink_mini_window (w
);
9221 freeze_window_starts (f
, 1);
9222 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9225 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9229 if (old_current_buffer
)
9230 set_buffer_internal (old_current_buffer
);
9233 return window_height_changed_p
;
9237 /* Value is the current message, a string, or nil if there is no
9245 if (!BUFFERP (echo_area_buffer
[0]))
9249 with_echo_area_buffer (0, 0, current_message_1
,
9250 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9252 echo_area_buffer
[0] = Qnil
;
9260 current_message_1 (a1
, a2
, a3
, a4
)
9265 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9268 *msg
= make_buffer_string (BEG
, Z
, 1);
9275 /* Push the current message on Vmessage_stack for later restauration
9276 by restore_message. Value is non-zero if the current message isn't
9277 empty. This is a relatively infrequent operation, so it's not
9278 worth optimizing. */
9284 msg
= current_message ();
9285 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9286 return STRINGP (msg
);
9290 /* Restore message display from the top of Vmessage_stack. */
9297 xassert (CONSP (Vmessage_stack
));
9298 msg
= XCAR (Vmessage_stack
);
9300 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9302 message3_nolog (msg
, 0, 0);
9306 /* Handler for record_unwind_protect calling pop_message. */
9309 pop_message_unwind (dummy
)
9316 /* Pop the top-most entry off Vmessage_stack. */
9321 xassert (CONSP (Vmessage_stack
));
9322 Vmessage_stack
= XCDR (Vmessage_stack
);
9326 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9327 exits. If the stack is not empty, we have a missing pop_message
9331 check_message_stack ()
9333 if (!NILP (Vmessage_stack
))
9338 /* Truncate to NCHARS what will be displayed in the echo area the next
9339 time we display it---but don't redisplay it now. */
9342 truncate_echo_area (nchars
)
9346 echo_area_buffer
[0] = Qnil
;
9347 /* A null message buffer means that the frame hasn't really been
9348 initialized yet. Error messages get reported properly by
9349 cmd_error, so this must be just an informative message; toss it. */
9350 else if (!noninteractive
9352 && !NILP (echo_area_buffer
[0]))
9354 struct frame
*sf
= SELECTED_FRAME ();
9355 if (FRAME_MESSAGE_BUF (sf
))
9356 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9361 /* Helper function for truncate_echo_area. Truncate the current
9362 message to at most NCHARS characters. */
9365 truncate_message_1 (nchars
, a2
, a3
, a4
)
9370 if (BEG
+ nchars
< Z
)
9371 del_range (BEG
+ nchars
, Z
);
9373 echo_area_buffer
[0] = Qnil
;
9378 /* Set the current message to a substring of S or STRING.
9380 If STRING is a Lisp string, set the message to the first NBYTES
9381 bytes from STRING. NBYTES zero means use the whole string. If
9382 STRING is multibyte, the message will be displayed multibyte.
9384 If S is not null, set the message to the first LEN bytes of S. LEN
9385 zero means use the whole string. MULTIBYTE_P non-zero means S is
9386 multibyte. Display the message multibyte in that case.
9388 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9389 to t before calling set_message_1 (which calls insert).
9393 set_message (s
, string
, nbytes
, multibyte_p
)
9396 int nbytes
, multibyte_p
;
9398 message_enable_multibyte
9399 = ((s
&& multibyte_p
)
9400 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9402 with_echo_area_buffer (0, -1, set_message_1
,
9403 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9404 message_buf_print
= 0;
9405 help_echo_showing_p
= 0;
9409 /* Helper function for set_message. Arguments have the same meaning
9410 as there, with A1 corresponding to S and A2 corresponding to STRING
9411 This function is called with the echo area buffer being
9415 set_message_1 (a1
, a2
, nbytes
, multibyte_p
)
9418 EMACS_INT nbytes
, multibyte_p
;
9420 const char *s
= (const char *) a1
;
9421 Lisp_Object string
= a2
;
9423 /* Change multibyteness of the echo buffer appropriately. */
9424 if (message_enable_multibyte
9425 != !NILP (current_buffer
->enable_multibyte_characters
))
9426 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9428 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9430 /* Insert new message at BEG. */
9431 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9433 if (STRINGP (string
))
9438 nbytes
= SBYTES (string
);
9439 nchars
= string_byte_to_char (string
, nbytes
);
9441 /* This function takes care of single/multibyte conversion. We
9442 just have to ensure that the echo area buffer has the right
9443 setting of enable_multibyte_characters. */
9444 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9449 nbytes
= strlen (s
);
9451 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9453 /* Convert from multi-byte to single-byte. */
9455 unsigned char work
[1];
9457 /* Convert a multibyte string to single-byte. */
9458 for (i
= 0; i
< nbytes
; i
+= n
)
9460 c
= string_char_and_length (s
+ i
, &n
);
9461 work
[0] = (ASCII_CHAR_P (c
)
9463 : multibyte_char_to_unibyte (c
, Qnil
));
9464 insert_1_both (work
, 1, 1, 1, 0, 0);
9467 else if (!multibyte_p
9468 && !NILP (current_buffer
->enable_multibyte_characters
))
9470 /* Convert from single-byte to multi-byte. */
9472 const unsigned char *msg
= (const unsigned char *) s
;
9473 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9475 /* Convert a single-byte string to multibyte. */
9476 for (i
= 0; i
< nbytes
; i
++)
9479 MAKE_CHAR_MULTIBYTE (c
);
9480 n
= CHAR_STRING (c
, str
);
9481 insert_1_both (str
, 1, n
, 1, 0, 0);
9485 insert_1 (s
, nbytes
, 1, 0, 0);
9492 /* Clear messages. CURRENT_P non-zero means clear the current
9493 message. LAST_DISPLAYED_P non-zero means clear the message
9497 clear_message (current_p
, last_displayed_p
)
9498 int current_p
, last_displayed_p
;
9502 echo_area_buffer
[0] = Qnil
;
9503 message_cleared_p
= 1;
9506 if (last_displayed_p
)
9507 echo_area_buffer
[1] = Qnil
;
9509 message_buf_print
= 0;
9512 /* Clear garbaged frames.
9514 This function is used where the old redisplay called
9515 redraw_garbaged_frames which in turn called redraw_frame which in
9516 turn called clear_frame. The call to clear_frame was a source of
9517 flickering. I believe a clear_frame is not necessary. It should
9518 suffice in the new redisplay to invalidate all current matrices,
9519 and ensure a complete redisplay of all windows. */
9522 clear_garbaged_frames ()
9526 Lisp_Object tail
, frame
;
9527 int changed_count
= 0;
9529 FOR_EACH_FRAME (tail
, frame
)
9531 struct frame
*f
= XFRAME (frame
);
9533 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9537 Fredraw_frame (frame
);
9538 f
->force_flush_display_p
= 1;
9540 clear_current_matrices (f
);
9549 ++windows_or_buffers_changed
;
9554 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9555 is non-zero update selected_frame. Value is non-zero if the
9556 mini-windows height has been changed. */
9559 echo_area_display (update_frame_p
)
9562 Lisp_Object mini_window
;
9565 int window_height_changed_p
= 0;
9566 struct frame
*sf
= SELECTED_FRAME ();
9568 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9569 w
= XWINDOW (mini_window
);
9570 f
= XFRAME (WINDOW_FRAME (w
));
9572 /* Don't display if frame is invisible or not yet initialized. */
9573 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9576 #ifdef HAVE_WINDOW_SYSTEM
9577 /* When Emacs starts, selected_frame may be the initial terminal
9578 frame. If we let this through, a message would be displayed on
9580 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9582 #endif /* HAVE_WINDOW_SYSTEM */
9584 /* Redraw garbaged frames. */
9586 clear_garbaged_frames ();
9588 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9590 echo_area_window
= mini_window
;
9591 window_height_changed_p
= display_echo_area (w
);
9592 w
->must_be_updated_p
= 1;
9594 /* Update the display, unless called from redisplay_internal.
9595 Also don't update the screen during redisplay itself. The
9596 update will happen at the end of redisplay, and an update
9597 here could cause confusion. */
9598 if (update_frame_p
&& !redisplaying_p
)
9602 /* If the display update has been interrupted by pending
9603 input, update mode lines in the frame. Due to the
9604 pending input, it might have been that redisplay hasn't
9605 been called, so that mode lines above the echo area are
9606 garbaged. This looks odd, so we prevent it here. */
9607 if (!display_completed
)
9608 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9610 if (window_height_changed_p
9611 /* Don't do this if Emacs is shutting down. Redisplay
9612 needs to run hooks. */
9613 && !NILP (Vrun_hooks
))
9615 /* Must update other windows. Likewise as in other
9616 cases, don't let this update be interrupted by
9618 int count
= SPECPDL_INDEX ();
9619 specbind (Qredisplay_dont_pause
, Qt
);
9620 windows_or_buffers_changed
= 1;
9621 redisplay_internal (0);
9622 unbind_to (count
, Qnil
);
9624 else if (FRAME_WINDOW_P (f
) && n
== 0)
9626 /* Window configuration is the same as before.
9627 Can do with a display update of the echo area,
9628 unless we displayed some mode lines. */
9629 update_single_window (w
, 1);
9630 FRAME_RIF (f
)->flush_display (f
);
9633 update_frame (f
, 1, 1);
9635 /* If cursor is in the echo area, make sure that the next
9636 redisplay displays the minibuffer, so that the cursor will
9637 be replaced with what the minibuffer wants. */
9638 if (cursor_in_echo_area
)
9639 ++windows_or_buffers_changed
;
9642 else if (!EQ (mini_window
, selected_window
))
9643 windows_or_buffers_changed
++;
9645 /* Last displayed message is now the current message. */
9646 echo_area_buffer
[1] = echo_area_buffer
[0];
9647 /* Inform read_char that we're not echoing. */
9648 echo_message_buffer
= Qnil
;
9650 /* Prevent redisplay optimization in redisplay_internal by resetting
9651 this_line_start_pos. This is done because the mini-buffer now
9652 displays the message instead of its buffer text. */
9653 if (EQ (mini_window
, selected_window
))
9654 CHARPOS (this_line_start_pos
) = 0;
9656 return window_height_changed_p
;
9661 /***********************************************************************
9662 Mode Lines and Frame Titles
9663 ***********************************************************************/
9665 /* A buffer for constructing non-propertized mode-line strings and
9666 frame titles in it; allocated from the heap in init_xdisp and
9667 resized as needed in store_mode_line_noprop_char. */
9669 static char *mode_line_noprop_buf
;
9671 /* The buffer's end, and a current output position in it. */
9673 static char *mode_line_noprop_buf_end
;
9674 static char *mode_line_noprop_ptr
;
9676 #define MODE_LINE_NOPROP_LEN(start) \
9677 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9680 MODE_LINE_DISPLAY
= 0,
9686 /* Alist that caches the results of :propertize.
9687 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9688 static Lisp_Object mode_line_proptrans_alist
;
9690 /* List of strings making up the mode-line. */
9691 static Lisp_Object mode_line_string_list
;
9693 /* Base face property when building propertized mode line string. */
9694 static Lisp_Object mode_line_string_face
;
9695 static Lisp_Object mode_line_string_face_prop
;
9698 /* Unwind data for mode line strings */
9700 static Lisp_Object Vmode_line_unwind_vector
;
9703 format_mode_line_unwind_data (struct buffer
*obuf
,
9707 Lisp_Object vector
, tmp
;
9709 /* Reduce consing by keeping one vector in
9710 Vwith_echo_area_save_vector. */
9711 vector
= Vmode_line_unwind_vector
;
9712 Vmode_line_unwind_vector
= Qnil
;
9715 vector
= Fmake_vector (make_number (8), Qnil
);
9717 ASET (vector
, 0, make_number (mode_line_target
));
9718 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9719 ASET (vector
, 2, mode_line_string_list
);
9720 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9721 ASET (vector
, 4, mode_line_string_face
);
9722 ASET (vector
, 5, mode_line_string_face_prop
);
9725 XSETBUFFER (tmp
, obuf
);
9728 ASET (vector
, 6, tmp
);
9729 ASET (vector
, 7, owin
);
9735 unwind_format_mode_line (vector
)
9738 mode_line_target
= XINT (AREF (vector
, 0));
9739 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9740 mode_line_string_list
= AREF (vector
, 2);
9741 if (! EQ (AREF (vector
, 3), Qt
))
9742 mode_line_proptrans_alist
= AREF (vector
, 3);
9743 mode_line_string_face
= AREF (vector
, 4);
9744 mode_line_string_face_prop
= AREF (vector
, 5);
9746 if (!NILP (AREF (vector
, 7)))
9747 /* Select window before buffer, since it may change the buffer. */
9748 Fselect_window (AREF (vector
, 7), Qt
);
9750 if (!NILP (AREF (vector
, 6)))
9752 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9753 ASET (vector
, 6, Qnil
);
9756 Vmode_line_unwind_vector
= vector
;
9761 /* Store a single character C for the frame title in mode_line_noprop_buf.
9762 Re-allocate mode_line_noprop_buf if necessary. */
9766 store_mode_line_noprop_char (char c
)
9768 store_mode_line_noprop_char (c
)
9772 /* If output position has reached the end of the allocated buffer,
9773 double the buffer's size. */
9774 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9776 int len
= MODE_LINE_NOPROP_LEN (0);
9777 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9778 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9779 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9780 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9783 *mode_line_noprop_ptr
++ = c
;
9787 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9788 mode_line_noprop_ptr. STR is the string to store. Do not copy
9789 characters that yield more columns than PRECISION; PRECISION <= 0
9790 means copy the whole string. Pad with spaces until FIELD_WIDTH
9791 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9792 pad. Called from display_mode_element when it is used to build a
9796 store_mode_line_noprop (str
, field_width
, precision
)
9797 const unsigned char *str
;
9798 int field_width
, precision
;
9803 /* Copy at most PRECISION chars from STR. */
9804 nbytes
= strlen (str
);
9805 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9807 store_mode_line_noprop_char (*str
++);
9809 /* Fill up with spaces until FIELD_WIDTH reached. */
9810 while (field_width
> 0
9813 store_mode_line_noprop_char (' ');
9820 /***********************************************************************
9822 ***********************************************************************/
9824 #ifdef HAVE_WINDOW_SYSTEM
9826 /* Set the title of FRAME, if it has changed. The title format is
9827 Vicon_title_format if FRAME is iconified, otherwise it is
9828 frame_title_format. */
9831 x_consider_frame_title (frame
)
9834 struct frame
*f
= XFRAME (frame
);
9836 if (FRAME_WINDOW_P (f
)
9837 || FRAME_MINIBUF_ONLY_P (f
)
9838 || f
->explicit_name
)
9840 /* Do we have more than one visible frame on this X display? */
9847 int count
= SPECPDL_INDEX ();
9849 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9851 Lisp_Object other_frame
= XCAR (tail
);
9852 struct frame
*tf
= XFRAME (other_frame
);
9855 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9856 && !FRAME_MINIBUF_ONLY_P (tf
)
9857 && !EQ (other_frame
, tip_frame
)
9858 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9862 /* Set global variable indicating that multiple frames exist. */
9863 multiple_frames
= CONSP (tail
);
9865 /* Switch to the buffer of selected window of the frame. Set up
9866 mode_line_target so that display_mode_element will output into
9867 mode_line_noprop_buf; then display the title. */
9868 record_unwind_protect (unwind_format_mode_line
,
9869 format_mode_line_unwind_data
9870 (current_buffer
, selected_window
, 0));
9872 Fselect_window (f
->selected_window
, Qt
);
9873 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9874 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9876 mode_line_target
= MODE_LINE_TITLE
;
9877 title_start
= MODE_LINE_NOPROP_LEN (0);
9878 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9879 NULL
, DEFAULT_FACE_ID
);
9880 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9881 len
= MODE_LINE_NOPROP_LEN (title_start
);
9882 title
= mode_line_noprop_buf
+ title_start
;
9883 unbind_to (count
, Qnil
);
9885 /* Set the title only if it's changed. This avoids consing in
9886 the common case where it hasn't. (If it turns out that we've
9887 already wasted too much time by walking through the list with
9888 display_mode_element, then we might need to optimize at a
9889 higher level than this.) */
9890 if (! STRINGP (f
->name
)
9891 || SBYTES (f
->name
) != len
9892 || bcmp (title
, SDATA (f
->name
), len
) != 0)
9893 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9897 #endif /* not HAVE_WINDOW_SYSTEM */
9902 /***********************************************************************
9904 ***********************************************************************/
9907 /* Prepare for redisplay by updating menu-bar item lists when
9908 appropriate. This can call eval. */
9911 prepare_menu_bars ()
9914 struct gcpro gcpro1
, gcpro2
;
9916 Lisp_Object tooltip_frame
;
9918 #ifdef HAVE_WINDOW_SYSTEM
9919 tooltip_frame
= tip_frame
;
9921 tooltip_frame
= Qnil
;
9924 /* Update all frame titles based on their buffer names, etc. We do
9925 this before the menu bars so that the buffer-menu will show the
9926 up-to-date frame titles. */
9927 #ifdef HAVE_WINDOW_SYSTEM
9928 if (windows_or_buffers_changed
|| update_mode_lines
)
9930 Lisp_Object tail
, frame
;
9932 FOR_EACH_FRAME (tail
, frame
)
9935 if (!EQ (frame
, tooltip_frame
)
9936 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9937 x_consider_frame_title (frame
);
9940 #endif /* HAVE_WINDOW_SYSTEM */
9942 /* Update the menu bar item lists, if appropriate. This has to be
9943 done before any actual redisplay or generation of display lines. */
9944 all_windows
= (update_mode_lines
9945 || buffer_shared
> 1
9946 || windows_or_buffers_changed
);
9949 Lisp_Object tail
, frame
;
9950 int count
= SPECPDL_INDEX ();
9951 /* 1 means that update_menu_bar has run its hooks
9952 so any further calls to update_menu_bar shouldn't do so again. */
9953 int menu_bar_hooks_run
= 0;
9955 record_unwind_save_match_data ();
9957 FOR_EACH_FRAME (tail
, frame
)
9961 /* Ignore tooltip frame. */
9962 if (EQ (frame
, tooltip_frame
))
9965 /* If a window on this frame changed size, report that to
9966 the user and clear the size-change flag. */
9967 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9969 Lisp_Object functions
;
9971 /* Clear flag first in case we get an error below. */
9972 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9973 functions
= Vwindow_size_change_functions
;
9974 GCPRO2 (tail
, functions
);
9976 while (CONSP (functions
))
9978 if (!EQ (XCAR (functions
), Qt
))
9979 call1 (XCAR (functions
), frame
);
9980 functions
= XCDR (functions
);
9986 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9987 #ifdef HAVE_WINDOW_SYSTEM
9988 update_tool_bar (f
, 0);
9991 if (windows_or_buffers_changed
9993 ns_set_doc_edited (f
, Fbuffer_modified_p
9994 (XWINDOW (f
->selected_window
)->buffer
));
9999 unbind_to (count
, Qnil
);
10003 struct frame
*sf
= SELECTED_FRAME ();
10004 update_menu_bar (sf
, 1, 0);
10005 #ifdef HAVE_WINDOW_SYSTEM
10006 update_tool_bar (sf
, 1);
10010 /* Motif needs this. See comment in xmenu.c. Turn it off when
10011 pending_menu_activation is not defined. */
10012 #ifdef USE_X_TOOLKIT
10013 pending_menu_activation
= 0;
10018 /* Update the menu bar item list for frame F. This has to be done
10019 before we start to fill in any display lines, because it can call
10022 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10024 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10025 already ran the menu bar hooks for this redisplay, so there
10026 is no need to run them again. The return value is the
10027 updated value of this flag, to pass to the next call. */
10030 update_menu_bar (f
, save_match_data
, hooks_run
)
10032 int save_match_data
;
10035 Lisp_Object window
;
10036 register struct window
*w
;
10038 /* If called recursively during a menu update, do nothing. This can
10039 happen when, for instance, an activate-menubar-hook causes a
10041 if (inhibit_menubar_update
)
10044 window
= FRAME_SELECTED_WINDOW (f
);
10045 w
= XWINDOW (window
);
10047 if (FRAME_WINDOW_P (f
)
10049 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10050 || defined (HAVE_NS) || defined (USE_GTK)
10051 FRAME_EXTERNAL_MENU_BAR (f
)
10053 FRAME_MENU_BAR_LINES (f
) > 0
10055 : FRAME_MENU_BAR_LINES (f
) > 0)
10057 /* If the user has switched buffers or windows, we need to
10058 recompute to reflect the new bindings. But we'll
10059 recompute when update_mode_lines is set too; that means
10060 that people can use force-mode-line-update to request
10061 that the menu bar be recomputed. The adverse effect on
10062 the rest of the redisplay algorithm is about the same as
10063 windows_or_buffers_changed anyway. */
10064 if (windows_or_buffers_changed
10065 /* This used to test w->update_mode_line, but we believe
10066 there is no need to recompute the menu in that case. */
10067 || update_mode_lines
10068 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10069 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10070 != !NILP (w
->last_had_star
))
10071 || ((!NILP (Vtransient_mark_mode
)
10072 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10073 != !NILP (w
->region_showing
)))
10075 struct buffer
*prev
= current_buffer
;
10076 int count
= SPECPDL_INDEX ();
10078 specbind (Qinhibit_menubar_update
, Qt
);
10080 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10081 if (save_match_data
)
10082 record_unwind_save_match_data ();
10083 if (NILP (Voverriding_local_map_menu_flag
))
10085 specbind (Qoverriding_terminal_local_map
, Qnil
);
10086 specbind (Qoverriding_local_map
, Qnil
);
10091 /* Run the Lucid hook. */
10092 safe_run_hooks (Qactivate_menubar_hook
);
10094 /* If it has changed current-menubar from previous value,
10095 really recompute the menu-bar from the value. */
10096 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10097 call0 (Qrecompute_lucid_menubar
);
10099 safe_run_hooks (Qmenu_bar_update_hook
);
10104 XSETFRAME (Vmenu_updating_frame
, f
);
10105 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10107 /* Redisplay the menu bar in case we changed it. */
10108 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10109 || defined (HAVE_NS) || defined (USE_GTK)
10110 if (FRAME_WINDOW_P (f
))
10112 #if defined (HAVE_NS)
10113 /* All frames on Mac OS share the same menubar. So only
10114 the selected frame should be allowed to set it. */
10115 if (f
== SELECTED_FRAME ())
10117 set_frame_menubar (f
, 0, 0);
10120 /* On a terminal screen, the menu bar is an ordinary screen
10121 line, and this makes it get updated. */
10122 w
->update_mode_line
= Qt
;
10123 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10124 /* In the non-toolkit version, the menu bar is an ordinary screen
10125 line, and this makes it get updated. */
10126 w
->update_mode_line
= Qt
;
10127 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10129 unbind_to (count
, Qnil
);
10130 set_buffer_internal_1 (prev
);
10139 /***********************************************************************
10141 ***********************************************************************/
10143 #ifdef HAVE_WINDOW_SYSTEM
10146 Nominal cursor position -- where to draw output.
10147 HPOS and VPOS are window relative glyph matrix coordinates.
10148 X and Y are window relative pixel coordinates. */
10150 struct cursor_pos output_cursor
;
10154 Set the global variable output_cursor to CURSOR. All cursor
10155 positions are relative to updated_window. */
10158 set_output_cursor (cursor
)
10159 struct cursor_pos
*cursor
;
10161 output_cursor
.hpos
= cursor
->hpos
;
10162 output_cursor
.vpos
= cursor
->vpos
;
10163 output_cursor
.x
= cursor
->x
;
10164 output_cursor
.y
= cursor
->y
;
10169 Set a nominal cursor position.
10171 HPOS and VPOS are column/row positions in a window glyph matrix. X
10172 and Y are window text area relative pixel positions.
10174 If this is done during an update, updated_window will contain the
10175 window that is being updated and the position is the future output
10176 cursor position for that window. If updated_window is null, use
10177 selected_window and display the cursor at the given position. */
10180 x_cursor_to (vpos
, hpos
, y
, x
)
10181 int vpos
, hpos
, y
, x
;
10185 /* If updated_window is not set, work on selected_window. */
10186 if (updated_window
)
10187 w
= updated_window
;
10189 w
= XWINDOW (selected_window
);
10191 /* Set the output cursor. */
10192 output_cursor
.hpos
= hpos
;
10193 output_cursor
.vpos
= vpos
;
10194 output_cursor
.x
= x
;
10195 output_cursor
.y
= y
;
10197 /* If not called as part of an update, really display the cursor.
10198 This will also set the cursor position of W. */
10199 if (updated_window
== NULL
)
10202 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10203 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10204 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10209 #endif /* HAVE_WINDOW_SYSTEM */
10212 /***********************************************************************
10214 ***********************************************************************/
10216 #ifdef HAVE_WINDOW_SYSTEM
10218 /* Where the mouse was last time we reported a mouse event. */
10220 FRAME_PTR last_mouse_frame
;
10222 /* Tool-bar item index of the item on which a mouse button was pressed
10225 int last_tool_bar_item
;
10229 update_tool_bar_unwind (frame
)
10232 selected_frame
= frame
;
10236 /* Update the tool-bar item list for frame F. This has to be done
10237 before we start to fill in any display lines. Called from
10238 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10239 and restore it here. */
10242 update_tool_bar (f
, save_match_data
)
10244 int save_match_data
;
10246 #if defined (USE_GTK) || defined (HAVE_NS)
10247 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10249 int do_update
= WINDOWP (f
->tool_bar_window
)
10250 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10255 Lisp_Object window
;
10258 window
= FRAME_SELECTED_WINDOW (f
);
10259 w
= XWINDOW (window
);
10261 /* If the user has switched buffers or windows, we need to
10262 recompute to reflect the new bindings. But we'll
10263 recompute when update_mode_lines is set too; that means
10264 that people can use force-mode-line-update to request
10265 that the menu bar be recomputed. The adverse effect on
10266 the rest of the redisplay algorithm is about the same as
10267 windows_or_buffers_changed anyway. */
10268 if (windows_or_buffers_changed
10269 || !NILP (w
->update_mode_line
)
10270 || update_mode_lines
10271 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10272 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10273 != !NILP (w
->last_had_star
))
10274 || ((!NILP (Vtransient_mark_mode
)
10275 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10276 != !NILP (w
->region_showing
)))
10278 struct buffer
*prev
= current_buffer
;
10279 int count
= SPECPDL_INDEX ();
10280 Lisp_Object frame
, new_tool_bar
;
10281 int new_n_tool_bar
;
10282 struct gcpro gcpro1
;
10284 /* Set current_buffer to the buffer of the selected
10285 window of the frame, so that we get the right local
10287 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10289 /* Save match data, if we must. */
10290 if (save_match_data
)
10291 record_unwind_save_match_data ();
10293 /* Make sure that we don't accidentally use bogus keymaps. */
10294 if (NILP (Voverriding_local_map_menu_flag
))
10296 specbind (Qoverriding_terminal_local_map
, Qnil
);
10297 specbind (Qoverriding_local_map
, Qnil
);
10300 GCPRO1 (new_tool_bar
);
10302 /* We must temporarily set the selected frame to this frame
10303 before calling tool_bar_items, because the calculation of
10304 the tool-bar keymap uses the selected frame (see
10305 `tool-bar-make-keymap' in tool-bar.el). */
10306 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10307 XSETFRAME (frame
, f
);
10308 selected_frame
= frame
;
10310 /* Build desired tool-bar items from keymaps. */
10311 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10314 /* Redisplay the tool-bar if we changed it. */
10315 if (new_n_tool_bar
!= f
->n_tool_bar_items
10316 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10318 /* Redisplay that happens asynchronously due to an expose event
10319 may access f->tool_bar_items. Make sure we update both
10320 variables within BLOCK_INPUT so no such event interrupts. */
10322 f
->tool_bar_items
= new_tool_bar
;
10323 f
->n_tool_bar_items
= new_n_tool_bar
;
10324 w
->update_mode_line
= Qt
;
10330 unbind_to (count
, Qnil
);
10331 set_buffer_internal_1 (prev
);
10337 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10338 F's desired tool-bar contents. F->tool_bar_items must have
10339 been set up previously by calling prepare_menu_bars. */
10342 build_desired_tool_bar_string (f
)
10345 int i
, size
, size_needed
;
10346 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10347 Lisp_Object image
, plist
, props
;
10349 image
= plist
= props
= Qnil
;
10350 GCPRO3 (image
, plist
, props
);
10352 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10353 Otherwise, make a new string. */
10355 /* The size of the string we might be able to reuse. */
10356 size
= (STRINGP (f
->desired_tool_bar_string
)
10357 ? SCHARS (f
->desired_tool_bar_string
)
10360 /* We need one space in the string for each image. */
10361 size_needed
= f
->n_tool_bar_items
;
10363 /* Reuse f->desired_tool_bar_string, if possible. */
10364 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10365 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10366 make_number (' '));
10369 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10370 Fremove_text_properties (make_number (0), make_number (size
),
10371 props
, f
->desired_tool_bar_string
);
10374 /* Put a `display' property on the string for the images to display,
10375 put a `menu_item' property on tool-bar items with a value that
10376 is the index of the item in F's tool-bar item vector. */
10377 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10379 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10381 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10382 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10383 int hmargin
, vmargin
, relief
, idx
, end
;
10384 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10386 /* If image is a vector, choose the image according to the
10388 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10389 if (VECTORP (image
))
10393 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10394 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10397 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10398 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10400 xassert (ASIZE (image
) >= idx
);
10401 image
= AREF (image
, idx
);
10406 /* Ignore invalid image specifications. */
10407 if (!valid_image_p (image
))
10410 /* Display the tool-bar button pressed, or depressed. */
10411 plist
= Fcopy_sequence (XCDR (image
));
10413 /* Compute margin and relief to draw. */
10414 relief
= (tool_bar_button_relief
>= 0
10415 ? tool_bar_button_relief
10416 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10417 hmargin
= vmargin
= relief
;
10419 if (INTEGERP (Vtool_bar_button_margin
)
10420 && XINT (Vtool_bar_button_margin
) > 0)
10422 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10423 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10425 else if (CONSP (Vtool_bar_button_margin
))
10427 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10428 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10429 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10431 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10432 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10433 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10436 if (auto_raise_tool_bar_buttons_p
)
10438 /* Add a `:relief' property to the image spec if the item is
10442 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10449 /* If image is selected, display it pressed, i.e. with a
10450 negative relief. If it's not selected, display it with a
10452 plist
= Fplist_put (plist
, QCrelief
,
10454 ? make_number (-relief
)
10455 : make_number (relief
)));
10460 /* Put a margin around the image. */
10461 if (hmargin
|| vmargin
)
10463 if (hmargin
== vmargin
)
10464 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10466 plist
= Fplist_put (plist
, QCmargin
,
10467 Fcons (make_number (hmargin
),
10468 make_number (vmargin
)));
10471 /* If button is not enabled, and we don't have special images
10472 for the disabled state, make the image appear disabled by
10473 applying an appropriate algorithm to it. */
10474 if (!enabled_p
&& idx
< 0)
10475 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10477 /* Put a `display' text property on the string for the image to
10478 display. Put a `menu-item' property on the string that gives
10479 the start of this item's properties in the tool-bar items
10481 image
= Fcons (Qimage
, plist
);
10482 props
= list4 (Qdisplay
, image
,
10483 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10485 /* Let the last image hide all remaining spaces in the tool bar
10486 string. The string can be longer than needed when we reuse a
10487 previous string. */
10488 if (i
+ 1 == f
->n_tool_bar_items
)
10489 end
= SCHARS (f
->desired_tool_bar_string
);
10492 Fadd_text_properties (make_number (i
), make_number (end
),
10493 props
, f
->desired_tool_bar_string
);
10501 /* Display one line of the tool-bar of frame IT->f.
10503 HEIGHT specifies the desired height of the tool-bar line.
10504 If the actual height of the glyph row is less than HEIGHT, the
10505 row's height is increased to HEIGHT, and the icons are centered
10506 vertically in the new height.
10508 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10509 count a final empty row in case the tool-bar width exactly matches
10514 display_tool_bar_line (it
, height
)
10518 struct glyph_row
*row
= it
->glyph_row
;
10519 int max_x
= it
->last_visible_x
;
10520 struct glyph
*last
;
10522 prepare_desired_row (row
);
10523 row
->y
= it
->current_y
;
10525 /* Note that this isn't made use of if the face hasn't a box,
10526 so there's no need to check the face here. */
10527 it
->start_of_box_run_p
= 1;
10529 while (it
->current_x
< max_x
)
10531 int x
, n_glyphs_before
, i
, nglyphs
;
10532 struct it it_before
;
10534 /* Get the next display element. */
10535 if (!get_next_display_element (it
))
10537 /* Don't count empty row if we are counting needed tool-bar lines. */
10538 if (height
< 0 && !it
->hpos
)
10543 /* Produce glyphs. */
10544 n_glyphs_before
= row
->used
[TEXT_AREA
];
10547 PRODUCE_GLYPHS (it
);
10549 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10551 x
= it_before
.current_x
;
10552 while (i
< nglyphs
)
10554 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10556 if (x
+ glyph
->pixel_width
> max_x
)
10558 /* Glyph doesn't fit on line. Backtrack. */
10559 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10561 /* If this is the only glyph on this line, it will never fit on the
10562 toolbar, so skip it. But ensure there is at least one glyph,
10563 so we don't accidentally disable the tool-bar. */
10564 if (n_glyphs_before
== 0
10565 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10571 x
+= glyph
->pixel_width
;
10575 /* Stop at line ends. */
10576 if (ITERATOR_AT_END_OF_LINE_P (it
))
10579 set_iterator_to_next (it
, 1);
10584 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10586 /* Use default face for the border below the tool bar.
10588 FIXME: When auto-resize-tool-bars is grow-only, there is
10589 no additional border below the possibly empty tool-bar lines.
10590 So to make the extra empty lines look "normal", we have to
10591 use the tool-bar face for the border too. */
10592 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10593 it
->face_id
= DEFAULT_FACE_ID
;
10595 extend_face_to_end_of_line (it
);
10596 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10597 last
->right_box_line_p
= 1;
10598 if (last
== row
->glyphs
[TEXT_AREA
])
10599 last
->left_box_line_p
= 1;
10601 /* Make line the desired height and center it vertically. */
10602 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10604 /* Don't add more than one line height. */
10605 height
%= FRAME_LINE_HEIGHT (it
->f
);
10606 it
->max_ascent
+= height
/ 2;
10607 it
->max_descent
+= (height
+ 1) / 2;
10610 compute_line_metrics (it
);
10612 /* If line is empty, make it occupy the rest of the tool-bar. */
10613 if (!row
->displays_text_p
)
10615 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10616 row
->visible_height
= row
->height
;
10617 row
->ascent
= row
->phys_ascent
= 0;
10618 row
->extra_line_spacing
= 0;
10621 row
->full_width_p
= 1;
10622 row
->continued_p
= 0;
10623 row
->truncated_on_left_p
= 0;
10624 row
->truncated_on_right_p
= 0;
10626 it
->current_x
= it
->hpos
= 0;
10627 it
->current_y
+= row
->height
;
10633 /* Max tool-bar height. */
10635 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10636 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10638 /* Value is the number of screen lines needed to make all tool-bar
10639 items of frame F visible. The number of actual rows needed is
10640 returned in *N_ROWS if non-NULL. */
10643 tool_bar_lines_needed (f
, n_rows
)
10647 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10649 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10650 the desired matrix, so use (unused) mode-line row as temporary row to
10651 avoid destroying the first tool-bar row. */
10652 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10654 /* Initialize an iterator for iteration over
10655 F->desired_tool_bar_string in the tool-bar window of frame F. */
10656 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10657 it
.first_visible_x
= 0;
10658 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10659 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10661 while (!ITERATOR_AT_END_P (&it
))
10663 clear_glyph_row (temp_row
);
10664 it
.glyph_row
= temp_row
;
10665 display_tool_bar_line (&it
, -1);
10667 clear_glyph_row (temp_row
);
10669 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10671 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10673 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10677 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10679 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10688 frame
= selected_frame
;
10690 CHECK_FRAME (frame
);
10691 f
= XFRAME (frame
);
10693 if (WINDOWP (f
->tool_bar_window
)
10694 || (w
= XWINDOW (f
->tool_bar_window
),
10695 WINDOW_TOTAL_LINES (w
) > 0))
10697 update_tool_bar (f
, 1);
10698 if (f
->n_tool_bar_items
)
10700 build_desired_tool_bar_string (f
);
10701 nlines
= tool_bar_lines_needed (f
, NULL
);
10705 return make_number (nlines
);
10709 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10710 height should be changed. */
10713 redisplay_tool_bar (f
)
10718 struct glyph_row
*row
;
10720 #if defined (USE_GTK) || defined (HAVE_NS)
10721 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10722 update_frame_tool_bar (f
);
10726 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10727 do anything. This means you must start with tool-bar-lines
10728 non-zero to get the auto-sizing effect. Or in other words, you
10729 can turn off tool-bars by specifying tool-bar-lines zero. */
10730 if (!WINDOWP (f
->tool_bar_window
)
10731 || (w
= XWINDOW (f
->tool_bar_window
),
10732 WINDOW_TOTAL_LINES (w
) == 0))
10735 /* Set up an iterator for the tool-bar window. */
10736 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10737 it
.first_visible_x
= 0;
10738 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10739 row
= it
.glyph_row
;
10741 /* Build a string that represents the contents of the tool-bar. */
10742 build_desired_tool_bar_string (f
);
10743 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10745 if (f
->n_tool_bar_rows
== 0)
10749 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10750 nlines
!= WINDOW_TOTAL_LINES (w
)))
10752 extern Lisp_Object Qtool_bar_lines
;
10754 int old_height
= WINDOW_TOTAL_LINES (w
);
10756 XSETFRAME (frame
, f
);
10757 Fmodify_frame_parameters (frame
,
10758 Fcons (Fcons (Qtool_bar_lines
,
10759 make_number (nlines
)),
10761 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10763 clear_glyph_matrix (w
->desired_matrix
);
10764 fonts_changed_p
= 1;
10770 /* Display as many lines as needed to display all tool-bar items. */
10772 if (f
->n_tool_bar_rows
> 0)
10774 int border
, rows
, height
, extra
;
10776 if (INTEGERP (Vtool_bar_border
))
10777 border
= XINT (Vtool_bar_border
);
10778 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10779 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10780 else if (EQ (Vtool_bar_border
, Qborder_width
))
10781 border
= f
->border_width
;
10787 rows
= f
->n_tool_bar_rows
;
10788 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10789 extra
= it
.last_visible_y
- border
- height
* rows
;
10791 while (it
.current_y
< it
.last_visible_y
)
10794 if (extra
> 0 && rows
-- > 0)
10796 h
= (extra
+ rows
- 1) / rows
;
10799 display_tool_bar_line (&it
, height
+ h
);
10804 while (it
.current_y
< it
.last_visible_y
)
10805 display_tool_bar_line (&it
, 0);
10808 /* It doesn't make much sense to try scrolling in the tool-bar
10809 window, so don't do it. */
10810 w
->desired_matrix
->no_scrolling_p
= 1;
10811 w
->must_be_updated_p
= 1;
10813 if (!NILP (Vauto_resize_tool_bars
))
10815 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10816 int change_height_p
= 0;
10818 /* If we couldn't display everything, change the tool-bar's
10819 height if there is room for more. */
10820 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10821 && it
.current_y
< max_tool_bar_height
)
10822 change_height_p
= 1;
10824 row
= it
.glyph_row
- 1;
10826 /* If there are blank lines at the end, except for a partially
10827 visible blank line at the end that is smaller than
10828 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10829 if (!row
->displays_text_p
10830 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10831 change_height_p
= 1;
10833 /* If row displays tool-bar items, but is partially visible,
10834 change the tool-bar's height. */
10835 if (row
->displays_text_p
10836 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10837 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10838 change_height_p
= 1;
10840 /* Resize windows as needed by changing the `tool-bar-lines'
10841 frame parameter. */
10842 if (change_height_p
)
10844 extern Lisp_Object Qtool_bar_lines
;
10846 int old_height
= WINDOW_TOTAL_LINES (w
);
10848 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10850 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10851 && !f
->minimize_tool_bar_window_p
)
10852 ? (nlines
> old_height
)
10853 : (nlines
!= old_height
));
10854 f
->minimize_tool_bar_window_p
= 0;
10856 if (change_height_p
)
10858 XSETFRAME (frame
, f
);
10859 Fmodify_frame_parameters (frame
,
10860 Fcons (Fcons (Qtool_bar_lines
,
10861 make_number (nlines
)),
10863 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10865 clear_glyph_matrix (w
->desired_matrix
);
10866 f
->n_tool_bar_rows
= nrows
;
10867 fonts_changed_p
= 1;
10874 f
->minimize_tool_bar_window_p
= 0;
10879 /* Get information about the tool-bar item which is displayed in GLYPH
10880 on frame F. Return in *PROP_IDX the index where tool-bar item
10881 properties start in F->tool_bar_items. Value is zero if
10882 GLYPH doesn't display a tool-bar item. */
10885 tool_bar_item_info (f
, glyph
, prop_idx
)
10887 struct glyph
*glyph
;
10894 /* This function can be called asynchronously, which means we must
10895 exclude any possibility that Fget_text_property signals an
10897 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10898 charpos
= max (0, charpos
);
10900 /* Get the text property `menu-item' at pos. The value of that
10901 property is the start index of this item's properties in
10902 F->tool_bar_items. */
10903 prop
= Fget_text_property (make_number (charpos
),
10904 Qmenu_item
, f
->current_tool_bar_string
);
10905 if (INTEGERP (prop
))
10907 *prop_idx
= XINT (prop
);
10917 /* Get information about the tool-bar item at position X/Y on frame F.
10918 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10919 the current matrix of the tool-bar window of F, or NULL if not
10920 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10921 item in F->tool_bar_items. Value is
10923 -1 if X/Y is not on a tool-bar item
10924 0 if X/Y is on the same item that was highlighted before.
10928 get_tool_bar_item (f
, x
, y
, glyph
, hpos
, vpos
, prop_idx
)
10931 struct glyph
**glyph
;
10932 int *hpos
, *vpos
, *prop_idx
;
10934 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10935 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10938 /* Find the glyph under X/Y. */
10939 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10940 if (*glyph
== NULL
)
10943 /* Get the start of this tool-bar item's properties in
10944 f->tool_bar_items. */
10945 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10948 /* Is mouse on the highlighted item? */
10949 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10950 && *vpos
>= dpyinfo
->mouse_face_beg_row
10951 && *vpos
<= dpyinfo
->mouse_face_end_row
10952 && (*vpos
> dpyinfo
->mouse_face_beg_row
10953 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10954 && (*vpos
< dpyinfo
->mouse_face_end_row
10955 || *hpos
< dpyinfo
->mouse_face_end_col
10956 || dpyinfo
->mouse_face_past_end
))
10964 Handle mouse button event on the tool-bar of frame F, at
10965 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10966 0 for button release. MODIFIERS is event modifiers for button
10970 handle_tool_bar_click (f
, x
, y
, down_p
, modifiers
)
10973 unsigned int modifiers
;
10975 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10976 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10977 int hpos
, vpos
, prop_idx
;
10978 struct glyph
*glyph
;
10979 Lisp_Object enabled_p
;
10981 /* If not on the highlighted tool-bar item, return. */
10982 frame_to_window_pixel_xy (w
, &x
, &y
);
10983 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10986 /* If item is disabled, do nothing. */
10987 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10988 if (NILP (enabled_p
))
10993 /* Show item in pressed state. */
10994 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10995 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10996 last_tool_bar_item
= prop_idx
;
11000 Lisp_Object key
, frame
;
11001 struct input_event event
;
11002 EVENT_INIT (event
);
11004 /* Show item in released state. */
11005 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
11006 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11008 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11010 XSETFRAME (frame
, f
);
11011 event
.kind
= TOOL_BAR_EVENT
;
11012 event
.frame_or_window
= frame
;
11014 kbd_buffer_store_event (&event
);
11016 event
.kind
= TOOL_BAR_EVENT
;
11017 event
.frame_or_window
= frame
;
11019 event
.modifiers
= modifiers
;
11020 kbd_buffer_store_event (&event
);
11021 last_tool_bar_item
= -1;
11026 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11027 tool-bar window-relative coordinates X/Y. Called from
11028 note_mouse_highlight. */
11031 note_tool_bar_highlight (f
, x
, y
)
11035 Lisp_Object window
= f
->tool_bar_window
;
11036 struct window
*w
= XWINDOW (window
);
11037 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11039 struct glyph
*glyph
;
11040 struct glyph_row
*row
;
11042 Lisp_Object enabled_p
;
11044 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11045 int mouse_down_p
, rc
;
11047 /* Function note_mouse_highlight is called with negative x(y
11048 values when mouse moves outside of the frame. */
11049 if (x
<= 0 || y
<= 0)
11051 clear_mouse_face (dpyinfo
);
11055 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11058 /* Not on tool-bar item. */
11059 clear_mouse_face (dpyinfo
);
11063 /* On same tool-bar item as before. */
11064 goto set_help_echo
;
11066 clear_mouse_face (dpyinfo
);
11068 /* Mouse is down, but on different tool-bar item? */
11069 mouse_down_p
= (dpyinfo
->grabbed
11070 && f
== last_mouse_frame
11071 && FRAME_LIVE_P (f
));
11073 && last_tool_bar_item
!= prop_idx
)
11076 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11077 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11079 /* If tool-bar item is not enabled, don't highlight it. */
11080 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11081 if (!NILP (enabled_p
))
11083 /* Compute the x-position of the glyph. In front and past the
11084 image is a space. We include this in the highlighted area. */
11085 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11086 for (i
= x
= 0; i
< hpos
; ++i
)
11087 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11089 /* Record this as the current active region. */
11090 dpyinfo
->mouse_face_beg_col
= hpos
;
11091 dpyinfo
->mouse_face_beg_row
= vpos
;
11092 dpyinfo
->mouse_face_beg_x
= x
;
11093 dpyinfo
->mouse_face_beg_y
= row
->y
;
11094 dpyinfo
->mouse_face_past_end
= 0;
11096 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
11097 dpyinfo
->mouse_face_end_row
= vpos
;
11098 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11099 dpyinfo
->mouse_face_end_y
= row
->y
;
11100 dpyinfo
->mouse_face_window
= window
;
11101 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11103 /* Display it as active. */
11104 show_mouse_face (dpyinfo
, draw
);
11105 dpyinfo
->mouse_face_image_state
= draw
;
11110 /* Set help_echo_string to a help string to display for this tool-bar item.
11111 XTread_socket does the rest. */
11112 help_echo_object
= help_echo_window
= Qnil
;
11113 help_echo_pos
= -1;
11114 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11115 if (NILP (help_echo_string
))
11116 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11119 #endif /* HAVE_WINDOW_SYSTEM */
11123 /************************************************************************
11124 Horizontal scrolling
11125 ************************************************************************/
11127 static int hscroll_window_tree
P_ ((Lisp_Object
));
11128 static int hscroll_windows
P_ ((Lisp_Object
));
11130 /* For all leaf windows in the window tree rooted at WINDOW, set their
11131 hscroll value so that PT is (i) visible in the window, and (ii) so
11132 that it is not within a certain margin at the window's left and
11133 right border. Value is non-zero if any window's hscroll has been
11137 hscroll_window_tree (window
)
11138 Lisp_Object window
;
11140 int hscrolled_p
= 0;
11141 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11142 int hscroll_step_abs
= 0;
11143 double hscroll_step_rel
= 0;
11145 if (hscroll_relative_p
)
11147 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11148 if (hscroll_step_rel
< 0)
11150 hscroll_relative_p
= 0;
11151 hscroll_step_abs
= 0;
11154 else if (INTEGERP (Vhscroll_step
))
11156 hscroll_step_abs
= XINT (Vhscroll_step
);
11157 if (hscroll_step_abs
< 0)
11158 hscroll_step_abs
= 0;
11161 hscroll_step_abs
= 0;
11163 while (WINDOWP (window
))
11165 struct window
*w
= XWINDOW (window
);
11167 if (WINDOWP (w
->hchild
))
11168 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11169 else if (WINDOWP (w
->vchild
))
11170 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11171 else if (w
->cursor
.vpos
>= 0)
11174 int text_area_width
;
11175 struct glyph_row
*current_cursor_row
11176 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11177 struct glyph_row
*desired_cursor_row
11178 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11179 struct glyph_row
*cursor_row
11180 = (desired_cursor_row
->enabled_p
11181 ? desired_cursor_row
11182 : current_cursor_row
);
11184 text_area_width
= window_box_width (w
, TEXT_AREA
);
11186 /* Scroll when cursor is inside this scroll margin. */
11187 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11189 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11190 && ((XFASTINT (w
->hscroll
)
11191 && w
->cursor
.x
<= h_margin
)
11192 || (cursor_row
->enabled_p
11193 && cursor_row
->truncated_on_right_p
11194 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11198 struct buffer
*saved_current_buffer
;
11202 /* Find point in a display of infinite width. */
11203 saved_current_buffer
= current_buffer
;
11204 current_buffer
= XBUFFER (w
->buffer
);
11206 if (w
== XWINDOW (selected_window
))
11207 pt
= BUF_PT (current_buffer
);
11210 pt
= marker_position (w
->pointm
);
11211 pt
= max (BEGV
, pt
);
11215 /* Move iterator to pt starting at cursor_row->start in
11216 a line with infinite width. */
11217 init_to_row_start (&it
, w
, cursor_row
);
11218 it
.last_visible_x
= INFINITY
;
11219 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11220 current_buffer
= saved_current_buffer
;
11222 /* Position cursor in window. */
11223 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11224 hscroll
= max (0, (it
.current_x
11225 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11226 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11227 : (text_area_width
/ 2))))
11228 / FRAME_COLUMN_WIDTH (it
.f
);
11229 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11231 if (hscroll_relative_p
)
11232 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11235 wanted_x
= text_area_width
11236 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11239 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11243 if (hscroll_relative_p
)
11244 wanted_x
= text_area_width
* hscroll_step_rel
11247 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11250 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11252 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11254 /* Don't call Fset_window_hscroll if value hasn't
11255 changed because it will prevent redisplay
11257 if (XFASTINT (w
->hscroll
) != hscroll
)
11259 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11260 w
->hscroll
= make_number (hscroll
);
11269 /* Value is non-zero if hscroll of any leaf window has been changed. */
11270 return hscrolled_p
;
11274 /* Set hscroll so that cursor is visible and not inside horizontal
11275 scroll margins for all windows in the tree rooted at WINDOW. See
11276 also hscroll_window_tree above. Value is non-zero if any window's
11277 hscroll has been changed. If it has, desired matrices on the frame
11278 of WINDOW are cleared. */
11281 hscroll_windows (window
)
11282 Lisp_Object window
;
11284 int hscrolled_p
= hscroll_window_tree (window
);
11286 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11287 return hscrolled_p
;
11292 /************************************************************************
11294 ************************************************************************/
11296 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11297 to a non-zero value. This is sometimes handy to have in a debugger
11302 /* First and last unchanged row for try_window_id. */
11304 int debug_first_unchanged_at_end_vpos
;
11305 int debug_last_unchanged_at_beg_vpos
;
11307 /* Delta vpos and y. */
11309 int debug_dvpos
, debug_dy
;
11311 /* Delta in characters and bytes for try_window_id. */
11313 int debug_delta
, debug_delta_bytes
;
11315 /* Values of window_end_pos and window_end_vpos at the end of
11318 EMACS_INT debug_end_pos
, debug_end_vpos
;
11320 /* Append a string to W->desired_matrix->method. FMT is a printf
11321 format string. A1...A9 are a supplement for a variable-length
11322 argument list. If trace_redisplay_p is non-zero also printf the
11323 resulting string to stderr. */
11326 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11329 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11332 char *method
= w
->desired_matrix
->method
;
11333 int len
= strlen (method
);
11334 int size
= sizeof w
->desired_matrix
->method
;
11335 int remaining
= size
- len
- 1;
11337 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11338 if (len
&& remaining
)
11341 --remaining
, ++len
;
11344 strncpy (method
+ len
, buffer
, remaining
);
11346 if (trace_redisplay_p
)
11347 fprintf (stderr
, "%p (%s): %s\n",
11349 ((BUFFERP (w
->buffer
)
11350 && STRINGP (XBUFFER (w
->buffer
)->name
))
11351 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11356 #endif /* GLYPH_DEBUG */
11359 /* Value is non-zero if all changes in window W, which displays
11360 current_buffer, are in the text between START and END. START is a
11361 buffer position, END is given as a distance from Z. Used in
11362 redisplay_internal for display optimization. */
11365 text_outside_line_unchanged_p (w
, start
, end
)
11369 int unchanged_p
= 1;
11371 /* If text or overlays have changed, see where. */
11372 if (XFASTINT (w
->last_modified
) < MODIFF
11373 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11375 /* Gap in the line? */
11376 if (GPT
< start
|| Z
- GPT
< end
)
11379 /* Changes start in front of the line, or end after it? */
11381 && (BEG_UNCHANGED
< start
- 1
11382 || END_UNCHANGED
< end
))
11385 /* If selective display, can't optimize if changes start at the
11386 beginning of the line. */
11388 && INTEGERP (current_buffer
->selective_display
)
11389 && XINT (current_buffer
->selective_display
) > 0
11390 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11393 /* If there are overlays at the start or end of the line, these
11394 may have overlay strings with newlines in them. A change at
11395 START, for instance, may actually concern the display of such
11396 overlay strings as well, and they are displayed on different
11397 lines. So, quickly rule out this case. (For the future, it
11398 might be desirable to implement something more telling than
11399 just BEG/END_UNCHANGED.) */
11402 if (BEG
+ BEG_UNCHANGED
== start
11403 && overlay_touches_p (start
))
11405 if (END_UNCHANGED
== end
11406 && overlay_touches_p (Z
- end
))
11410 /* Under bidi reordering, adding or deleting a character in the
11411 beginning of a paragraph, before the first strong directional
11412 character, can change the base direction of the paragraph (unless
11413 the buffer specifies a fixed paragraph direction), which will
11414 require to redisplay the whole paragraph. It might be worthwhile
11415 to find the paragraph limits and widen the range of redisplayed
11416 lines to that, but for now just give up this optimization. */
11417 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11418 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11422 return unchanged_p
;
11426 /* Do a frame update, taking possible shortcuts into account. This is
11427 the main external entry point for redisplay.
11429 If the last redisplay displayed an echo area message and that message
11430 is no longer requested, we clear the echo area or bring back the
11431 mini-buffer if that is in use. */
11436 redisplay_internal (0);
11441 overlay_arrow_string_or_property (var
)
11446 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11449 return Voverlay_arrow_string
;
11452 /* Return 1 if there are any overlay-arrows in current_buffer. */
11454 overlay_arrow_in_current_buffer_p ()
11458 for (vlist
= Voverlay_arrow_variable_list
;
11460 vlist
= XCDR (vlist
))
11462 Lisp_Object var
= XCAR (vlist
);
11465 if (!SYMBOLP (var
))
11467 val
= find_symbol_value (var
);
11469 && current_buffer
== XMARKER (val
)->buffer
)
11476 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11480 overlay_arrows_changed_p ()
11484 for (vlist
= Voverlay_arrow_variable_list
;
11486 vlist
= XCDR (vlist
))
11488 Lisp_Object var
= XCAR (vlist
);
11489 Lisp_Object val
, pstr
;
11491 if (!SYMBOLP (var
))
11493 val
= find_symbol_value (var
);
11494 if (!MARKERP (val
))
11496 if (! EQ (COERCE_MARKER (val
),
11497 Fget (var
, Qlast_arrow_position
))
11498 || ! (pstr
= overlay_arrow_string_or_property (var
),
11499 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11505 /* Mark overlay arrows to be updated on next redisplay. */
11508 update_overlay_arrows (up_to_date
)
11513 for (vlist
= Voverlay_arrow_variable_list
;
11515 vlist
= XCDR (vlist
))
11517 Lisp_Object var
= XCAR (vlist
);
11519 if (!SYMBOLP (var
))
11522 if (up_to_date
> 0)
11524 Lisp_Object val
= find_symbol_value (var
);
11525 Fput (var
, Qlast_arrow_position
,
11526 COERCE_MARKER (val
));
11527 Fput (var
, Qlast_arrow_string
,
11528 overlay_arrow_string_or_property (var
));
11530 else if (up_to_date
< 0
11531 || !NILP (Fget (var
, Qlast_arrow_position
)))
11533 Fput (var
, Qlast_arrow_position
, Qt
);
11534 Fput (var
, Qlast_arrow_string
, Qt
);
11540 /* Return overlay arrow string to display at row.
11541 Return integer (bitmap number) for arrow bitmap in left fringe.
11542 Return nil if no overlay arrow. */
11545 overlay_arrow_at_row (it
, row
)
11547 struct glyph_row
*row
;
11551 for (vlist
= Voverlay_arrow_variable_list
;
11553 vlist
= XCDR (vlist
))
11555 Lisp_Object var
= XCAR (vlist
);
11558 if (!SYMBOLP (var
))
11561 val
= find_symbol_value (var
);
11564 && current_buffer
== XMARKER (val
)->buffer
11565 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11567 if (FRAME_WINDOW_P (it
->f
)
11568 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11570 #ifdef HAVE_WINDOW_SYSTEM
11571 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11574 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11575 return make_number (fringe_bitmap
);
11578 return make_number (-1); /* Use default arrow bitmap */
11580 return overlay_arrow_string_or_property (var
);
11587 /* Return 1 if point moved out of or into a composition. Otherwise
11588 return 0. PREV_BUF and PREV_PT are the last point buffer and
11589 position. BUF and PT are the current point buffer and position. */
11592 check_point_in_composition (prev_buf
, prev_pt
, buf
, pt
)
11593 struct buffer
*prev_buf
, *buf
;
11596 EMACS_INT start
, end
;
11598 Lisp_Object buffer
;
11600 XSETBUFFER (buffer
, buf
);
11601 /* Check a composition at the last point if point moved within the
11603 if (prev_buf
== buf
)
11606 /* Point didn't move. */
11609 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11610 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11611 && COMPOSITION_VALID_P (start
, end
, prop
)
11612 && start
< prev_pt
&& end
> prev_pt
)
11613 /* The last point was within the composition. Return 1 iff
11614 point moved out of the composition. */
11615 return (pt
<= start
|| pt
>= end
);
11618 /* Check a composition at the current point. */
11619 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11620 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11621 && COMPOSITION_VALID_P (start
, end
, prop
)
11622 && start
< pt
&& end
> pt
);
11626 /* Reconsider the setting of B->clip_changed which is displayed
11630 reconsider_clip_changes (w
, b
)
11634 if (b
->clip_changed
11635 && !NILP (w
->window_end_valid
)
11636 && w
->current_matrix
->buffer
== b
11637 && w
->current_matrix
->zv
== BUF_ZV (b
)
11638 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11639 b
->clip_changed
= 0;
11641 /* If display wasn't paused, and W is not a tool bar window, see if
11642 point has been moved into or out of a composition. In that case,
11643 we set b->clip_changed to 1 to force updating the screen. If
11644 b->clip_changed has already been set to 1, we can skip this
11646 if (!b
->clip_changed
11647 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11651 if (w
== XWINDOW (selected_window
))
11652 pt
= BUF_PT (current_buffer
);
11654 pt
= marker_position (w
->pointm
);
11656 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11657 || pt
!= XINT (w
->last_point
))
11658 && check_point_in_composition (w
->current_matrix
->buffer
,
11659 XINT (w
->last_point
),
11660 XBUFFER (w
->buffer
), pt
))
11661 b
->clip_changed
= 1;
11666 /* Select FRAME to forward the values of frame-local variables into C
11667 variables so that the redisplay routines can access those values
11671 select_frame_for_redisplay (frame
)
11674 Lisp_Object tail
, tem
;
11675 Lisp_Object old
= selected_frame
;
11676 struct Lisp_Symbol
*sym
;
11678 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11680 selected_frame
= frame
;
11683 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11684 if (CONSP (XCAR (tail
))
11685 && (tem
= XCAR (XCAR (tail
)),
11687 && (sym
= indirect_variable (XSYMBOL (tem
)),
11688 sym
->redirect
== SYMBOL_LOCALIZED
)
11689 && sym
->val
.blv
->frame_local
)
11690 /* Use find_symbol_value rather than Fsymbol_value
11691 to avoid an error if it is void. */
11692 find_symbol_value (tem
);
11693 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11697 #define STOP_POLLING \
11698 do { if (! polling_stopped_here) stop_polling (); \
11699 polling_stopped_here = 1; } while (0)
11701 #define RESUME_POLLING \
11702 do { if (polling_stopped_here) start_polling (); \
11703 polling_stopped_here = 0; } while (0)
11706 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11707 response to any user action; therefore, we should preserve the echo
11708 area. (Actually, our caller does that job.) Perhaps in the future
11709 avoid recentering windows if it is not necessary; currently that
11710 causes some problems. */
11713 redisplay_internal (preserve_echo_area
)
11714 int preserve_echo_area
;
11716 struct window
*w
= XWINDOW (selected_window
);
11719 int must_finish
= 0;
11720 struct text_pos tlbufpos
, tlendpos
;
11721 int number_of_visible_frames
;
11724 int polling_stopped_here
= 0;
11725 Lisp_Object old_frame
= selected_frame
;
11727 /* Non-zero means redisplay has to consider all windows on all
11728 frames. Zero means, only selected_window is considered. */
11729 int consider_all_windows_p
;
11731 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11733 /* No redisplay if running in batch mode or frame is not yet fully
11734 initialized, or redisplay is explicitly turned off by setting
11735 Vinhibit_redisplay. */
11736 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11737 || !NILP (Vinhibit_redisplay
))
11740 /* Don't examine these until after testing Vinhibit_redisplay.
11741 When Emacs is shutting down, perhaps because its connection to
11742 X has dropped, we should not look at them at all. */
11743 f
= XFRAME (w
->frame
);
11744 sf
= SELECTED_FRAME ();
11746 if (!f
->glyphs_initialized_p
)
11749 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11750 if (popup_activated ())
11754 /* I don't think this happens but let's be paranoid. */
11755 if (redisplaying_p
)
11758 /* Record a function that resets redisplaying_p to its old value
11759 when we leave this function. */
11760 count
= SPECPDL_INDEX ();
11761 record_unwind_protect (unwind_redisplay
,
11762 Fcons (make_number (redisplaying_p
), selected_frame
));
11764 specbind (Qinhibit_free_realized_faces
, Qnil
);
11767 Lisp_Object tail
, frame
;
11769 FOR_EACH_FRAME (tail
, frame
)
11771 struct frame
*f
= XFRAME (frame
);
11772 f
->already_hscrolled_p
= 0;
11777 if (!EQ (old_frame
, selected_frame
)
11778 && FRAME_LIVE_P (XFRAME (old_frame
)))
11779 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11780 selected_frame and selected_window to be temporarily out-of-sync so
11781 when we come back here via `goto retry', we need to resync because we
11782 may need to run Elisp code (via prepare_menu_bars). */
11783 select_frame_for_redisplay (old_frame
);
11786 reconsider_clip_changes (w
, current_buffer
);
11787 last_escape_glyph_frame
= NULL
;
11788 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11790 /* If new fonts have been loaded that make a glyph matrix adjustment
11791 necessary, do it. */
11792 if (fonts_changed_p
)
11794 adjust_glyphs (NULL
);
11795 ++windows_or_buffers_changed
;
11796 fonts_changed_p
= 0;
11799 /* If face_change_count is non-zero, init_iterator will free all
11800 realized faces, which includes the faces referenced from current
11801 matrices. So, we can't reuse current matrices in this case. */
11802 if (face_change_count
)
11803 ++windows_or_buffers_changed
;
11805 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11806 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11808 /* Since frames on a single ASCII terminal share the same
11809 display area, displaying a different frame means redisplay
11810 the whole thing. */
11811 windows_or_buffers_changed
++;
11812 SET_FRAME_GARBAGED (sf
);
11814 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11816 FRAME_TTY (sf
)->previous_frame
= sf
;
11819 /* Set the visible flags for all frames. Do this before checking
11820 for resized or garbaged frames; they want to know if their frames
11821 are visible. See the comment in frame.h for
11822 FRAME_SAMPLE_VISIBILITY. */
11824 Lisp_Object tail
, frame
;
11826 number_of_visible_frames
= 0;
11828 FOR_EACH_FRAME (tail
, frame
)
11830 struct frame
*f
= XFRAME (frame
);
11832 FRAME_SAMPLE_VISIBILITY (f
);
11833 if (FRAME_VISIBLE_P (f
))
11834 ++number_of_visible_frames
;
11835 clear_desired_matrices (f
);
11839 /* Notice any pending interrupt request to change frame size. */
11840 do_pending_window_change (1);
11842 /* Clear frames marked as garbaged. */
11843 if (frame_garbaged
)
11844 clear_garbaged_frames ();
11846 /* Build menubar and tool-bar items. */
11847 if (NILP (Vmemory_full
))
11848 prepare_menu_bars ();
11850 if (windows_or_buffers_changed
)
11851 update_mode_lines
++;
11853 /* Detect case that we need to write or remove a star in the mode line. */
11854 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11856 w
->update_mode_line
= Qt
;
11857 if (buffer_shared
> 1)
11858 update_mode_lines
++;
11861 /* Avoid invocation of point motion hooks by `current_column' below. */
11862 count1
= SPECPDL_INDEX ();
11863 specbind (Qinhibit_point_motion_hooks
, Qt
);
11865 /* If %c is in the mode line, update it if needed. */
11866 if (!NILP (w
->column_number_displayed
)
11867 /* This alternative quickly identifies a common case
11868 where no change is needed. */
11869 && !(PT
== XFASTINT (w
->last_point
)
11870 && XFASTINT (w
->last_modified
) >= MODIFF
11871 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11872 && (XFASTINT (w
->column_number_displayed
)
11873 != (int) current_column ())) /* iftc */
11874 w
->update_mode_line
= Qt
;
11876 unbind_to (count1
, Qnil
);
11878 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11880 /* The variable buffer_shared is set in redisplay_window and
11881 indicates that we redisplay a buffer in different windows. See
11883 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11884 || cursor_type_changed
);
11886 /* If specs for an arrow have changed, do thorough redisplay
11887 to ensure we remove any arrow that should no longer exist. */
11888 if (overlay_arrows_changed_p ())
11889 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11891 /* Normally the message* functions will have already displayed and
11892 updated the echo area, but the frame may have been trashed, or
11893 the update may have been preempted, so display the echo area
11894 again here. Checking message_cleared_p captures the case that
11895 the echo area should be cleared. */
11896 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11897 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11898 || (message_cleared_p
11899 && minibuf_level
== 0
11900 /* If the mini-window is currently selected, this means the
11901 echo-area doesn't show through. */
11902 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11904 int window_height_changed_p
= echo_area_display (0);
11907 /* If we don't display the current message, don't clear the
11908 message_cleared_p flag, because, if we did, we wouldn't clear
11909 the echo area in the next redisplay which doesn't preserve
11911 if (!display_last_displayed_message_p
)
11912 message_cleared_p
= 0;
11914 if (fonts_changed_p
)
11916 else if (window_height_changed_p
)
11918 consider_all_windows_p
= 1;
11919 ++update_mode_lines
;
11920 ++windows_or_buffers_changed
;
11922 /* If window configuration was changed, frames may have been
11923 marked garbaged. Clear them or we will experience
11924 surprises wrt scrolling. */
11925 if (frame_garbaged
)
11926 clear_garbaged_frames ();
11929 else if (EQ (selected_window
, minibuf_window
)
11930 && (current_buffer
->clip_changed
11931 || XFASTINT (w
->last_modified
) < MODIFF
11932 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11933 && resize_mini_window (w
, 0))
11935 /* Resized active mini-window to fit the size of what it is
11936 showing if its contents might have changed. */
11938 /* FIXME: this causes all frames to be updated, which seems unnecessary
11939 since only the current frame needs to be considered. This function needs
11940 to be rewritten with two variables, consider_all_windows and
11941 consider_all_frames. */
11942 consider_all_windows_p
= 1;
11943 ++windows_or_buffers_changed
;
11944 ++update_mode_lines
;
11946 /* If window configuration was changed, frames may have been
11947 marked garbaged. Clear them or we will experience
11948 surprises wrt scrolling. */
11949 if (frame_garbaged
)
11950 clear_garbaged_frames ();
11954 /* If showing the region, and mark has changed, we must redisplay
11955 the whole window. The assignment to this_line_start_pos prevents
11956 the optimization directly below this if-statement. */
11957 if (((!NILP (Vtransient_mark_mode
)
11958 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11959 != !NILP (w
->region_showing
))
11960 || (!NILP (w
->region_showing
)
11961 && !EQ (w
->region_showing
,
11962 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11963 CHARPOS (this_line_start_pos
) = 0;
11965 /* Optimize the case that only the line containing the cursor in the
11966 selected window has changed. Variables starting with this_ are
11967 set in display_line and record information about the line
11968 containing the cursor. */
11969 tlbufpos
= this_line_start_pos
;
11970 tlendpos
= this_line_end_pos
;
11971 if (!consider_all_windows_p
11972 && CHARPOS (tlbufpos
) > 0
11973 && NILP (w
->update_mode_line
)
11974 && !current_buffer
->clip_changed
11975 && !current_buffer
->prevent_redisplay_optimizations_p
11976 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11977 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11978 /* Make sure recorded data applies to current buffer, etc. */
11979 && this_line_buffer
== current_buffer
11980 && current_buffer
== XBUFFER (w
->buffer
)
11981 && NILP (w
->force_start
)
11982 && NILP (w
->optional_new_start
)
11983 /* Point must be on the line that we have info recorded about. */
11984 && PT
>= CHARPOS (tlbufpos
)
11985 && PT
<= Z
- CHARPOS (tlendpos
)
11986 /* All text outside that line, including its final newline,
11987 must be unchanged. */
11988 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11989 CHARPOS (tlendpos
)))
11991 if (CHARPOS (tlbufpos
) > BEGV
11992 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11993 && (CHARPOS (tlbufpos
) == ZV
11994 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11995 /* Former continuation line has disappeared by becoming empty. */
11997 else if (XFASTINT (w
->last_modified
) < MODIFF
11998 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11999 || MINI_WINDOW_P (w
))
12001 /* We have to handle the case of continuation around a
12002 wide-column character (see the comment in indent.c around
12005 For instance, in the following case:
12007 -------- Insert --------
12008 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12009 J_I_ ==> J_I_ `^^' are cursors.
12013 As we have to redraw the line above, we cannot use this
12017 int line_height_before
= this_line_pixel_height
;
12019 /* Note that start_display will handle the case that the
12020 line starting at tlbufpos is a continuation line. */
12021 start_display (&it
, w
, tlbufpos
);
12023 /* Implementation note: It this still necessary? */
12024 if (it
.current_x
!= this_line_start_x
)
12027 TRACE ((stderr
, "trying display optimization 1\n"));
12028 w
->cursor
.vpos
= -1;
12029 overlay_arrow_seen
= 0;
12030 it
.vpos
= this_line_vpos
;
12031 it
.current_y
= this_line_y
;
12032 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12033 display_line (&it
);
12035 /* If line contains point, is not continued,
12036 and ends at same distance from eob as before, we win. */
12037 if (w
->cursor
.vpos
>= 0
12038 /* Line is not continued, otherwise this_line_start_pos
12039 would have been set to 0 in display_line. */
12040 && CHARPOS (this_line_start_pos
)
12041 /* Line ends as before. */
12042 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12043 /* Line has same height as before. Otherwise other lines
12044 would have to be shifted up or down. */
12045 && this_line_pixel_height
== line_height_before
)
12047 /* If this is not the window's last line, we must adjust
12048 the charstarts of the lines below. */
12049 if (it
.current_y
< it
.last_visible_y
)
12051 struct glyph_row
*row
12052 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12053 int delta
, delta_bytes
;
12055 /* We used to distinguish between two cases here,
12056 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12057 when the line ends in a newline or the end of the
12058 buffer's accessible portion. But both cases did
12059 the same, so they were collapsed. */
12061 - CHARPOS (tlendpos
)
12062 - MATRIX_ROW_START_CHARPOS (row
));
12063 delta_bytes
= (Z_BYTE
12064 - BYTEPOS (tlendpos
)
12065 - MATRIX_ROW_START_BYTEPOS (row
));
12067 increment_matrix_positions (w
->current_matrix
,
12068 this_line_vpos
+ 1,
12069 w
->current_matrix
->nrows
,
12070 delta
, delta_bytes
);
12073 /* If this row displays text now but previously didn't,
12074 or vice versa, w->window_end_vpos may have to be
12076 if ((it
.glyph_row
- 1)->displays_text_p
)
12078 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12079 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12081 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12082 && this_line_vpos
> 0)
12083 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12084 w
->window_end_valid
= Qnil
;
12086 /* Update hint: No need to try to scroll in update_window. */
12087 w
->desired_matrix
->no_scrolling_p
= 1;
12090 *w
->desired_matrix
->method
= 0;
12091 debug_method_add (w
, "optimization 1");
12093 #ifdef HAVE_WINDOW_SYSTEM
12094 update_window_fringes (w
, 0);
12101 else if (/* Cursor position hasn't changed. */
12102 PT
== XFASTINT (w
->last_point
)
12103 /* Make sure the cursor was last displayed
12104 in this window. Otherwise we have to reposition it. */
12105 && 0 <= w
->cursor
.vpos
12106 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12110 do_pending_window_change (1);
12112 /* We used to always goto end_of_redisplay here, but this
12113 isn't enough if we have a blinking cursor. */
12114 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12115 goto end_of_redisplay
;
12119 /* If highlighting the region, or if the cursor is in the echo area,
12120 then we can't just move the cursor. */
12121 else if (! (!NILP (Vtransient_mark_mode
)
12122 && !NILP (current_buffer
->mark_active
))
12123 && (EQ (selected_window
, current_buffer
->last_selected_window
)
12124 || highlight_nonselected_windows
)
12125 && NILP (w
->region_showing
)
12126 && NILP (Vshow_trailing_whitespace
)
12127 && !cursor_in_echo_area
)
12130 struct glyph_row
*row
;
12132 /* Skip from tlbufpos to PT and see where it is. Note that
12133 PT may be in invisible text. If so, we will end at the
12134 next visible position. */
12135 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12136 NULL
, DEFAULT_FACE_ID
);
12137 it
.current_x
= this_line_start_x
;
12138 it
.current_y
= this_line_y
;
12139 it
.vpos
= this_line_vpos
;
12141 /* The call to move_it_to stops in front of PT, but
12142 moves over before-strings. */
12143 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12145 if (it
.vpos
== this_line_vpos
12146 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12149 xassert (this_line_vpos
== it
.vpos
);
12150 xassert (this_line_y
== it
.current_y
);
12151 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12153 *w
->desired_matrix
->method
= 0;
12154 debug_method_add (w
, "optimization 3");
12163 /* Text changed drastically or point moved off of line. */
12164 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12167 CHARPOS (this_line_start_pos
) = 0;
12168 consider_all_windows_p
|= buffer_shared
> 1;
12169 ++clear_face_cache_count
;
12170 #ifdef HAVE_WINDOW_SYSTEM
12171 ++clear_image_cache_count
;
12174 /* Build desired matrices, and update the display. If
12175 consider_all_windows_p is non-zero, do it for all windows on all
12176 frames. Otherwise do it for selected_window, only. */
12178 if (consider_all_windows_p
)
12180 Lisp_Object tail
, frame
;
12182 FOR_EACH_FRAME (tail
, frame
)
12183 XFRAME (frame
)->updated_p
= 0;
12185 /* Recompute # windows showing selected buffer. This will be
12186 incremented each time such a window is displayed. */
12189 FOR_EACH_FRAME (tail
, frame
)
12191 struct frame
*f
= XFRAME (frame
);
12193 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12195 if (! EQ (frame
, selected_frame
))
12196 /* Select the frame, for the sake of frame-local
12198 select_frame_for_redisplay (frame
);
12200 /* Mark all the scroll bars to be removed; we'll redeem
12201 the ones we want when we redisplay their windows. */
12202 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12203 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12205 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12206 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12208 /* The X error handler may have deleted that frame. */
12209 if (!FRAME_LIVE_P (f
))
12212 /* Any scroll bars which redisplay_windows should have
12213 nuked should now go away. */
12214 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12215 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12217 /* If fonts changed, display again. */
12218 /* ??? rms: I suspect it is a mistake to jump all the way
12219 back to retry here. It should just retry this frame. */
12220 if (fonts_changed_p
)
12223 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12225 /* See if we have to hscroll. */
12226 if (!f
->already_hscrolled_p
)
12228 f
->already_hscrolled_p
= 1;
12229 if (hscroll_windows (f
->root_window
))
12233 /* Prevent various kinds of signals during display
12234 update. stdio is not robust about handling
12235 signals, which can cause an apparent I/O
12237 if (interrupt_input
)
12238 unrequest_sigio ();
12241 /* Update the display. */
12242 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12243 pause
|= update_frame (f
, 0, 0);
12249 if (!EQ (old_frame
, selected_frame
)
12250 && FRAME_LIVE_P (XFRAME (old_frame
)))
12251 /* We played a bit fast-and-loose above and allowed selected_frame
12252 and selected_window to be temporarily out-of-sync but let's make
12253 sure this stays contained. */
12254 select_frame_for_redisplay (old_frame
);
12255 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12259 /* Do the mark_window_display_accurate after all windows have
12260 been redisplayed because this call resets flags in buffers
12261 which are needed for proper redisplay. */
12262 FOR_EACH_FRAME (tail
, frame
)
12264 struct frame
*f
= XFRAME (frame
);
12267 mark_window_display_accurate (f
->root_window
, 1);
12268 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12269 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12274 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12276 Lisp_Object mini_window
;
12277 struct frame
*mini_frame
;
12279 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12280 /* Use list_of_error, not Qerror, so that
12281 we catch only errors and don't run the debugger. */
12282 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12284 redisplay_window_error
);
12286 /* Compare desired and current matrices, perform output. */
12289 /* If fonts changed, display again. */
12290 if (fonts_changed_p
)
12293 /* Prevent various kinds of signals during display update.
12294 stdio is not robust about handling signals,
12295 which can cause an apparent I/O error. */
12296 if (interrupt_input
)
12297 unrequest_sigio ();
12300 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12302 if (hscroll_windows (selected_window
))
12305 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12306 pause
= update_frame (sf
, 0, 0);
12309 /* We may have called echo_area_display at the top of this
12310 function. If the echo area is on another frame, that may
12311 have put text on a frame other than the selected one, so the
12312 above call to update_frame would not have caught it. Catch
12314 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12315 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12317 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12319 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12320 pause
|= update_frame (mini_frame
, 0, 0);
12321 if (!pause
&& hscroll_windows (mini_window
))
12326 /* If display was paused because of pending input, make sure we do a
12327 thorough update the next time. */
12330 /* Prevent the optimization at the beginning of
12331 redisplay_internal that tries a single-line update of the
12332 line containing the cursor in the selected window. */
12333 CHARPOS (this_line_start_pos
) = 0;
12335 /* Let the overlay arrow be updated the next time. */
12336 update_overlay_arrows (0);
12338 /* If we pause after scrolling, some rows in the current
12339 matrices of some windows are not valid. */
12340 if (!WINDOW_FULL_WIDTH_P (w
)
12341 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12342 update_mode_lines
= 1;
12346 if (!consider_all_windows_p
)
12348 /* This has already been done above if
12349 consider_all_windows_p is set. */
12350 mark_window_display_accurate_1 (w
, 1);
12352 /* Say overlay arrows are up to date. */
12353 update_overlay_arrows (1);
12355 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12356 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12359 update_mode_lines
= 0;
12360 windows_or_buffers_changed
= 0;
12361 cursor_type_changed
= 0;
12364 /* Start SIGIO interrupts coming again. Having them off during the
12365 code above makes it less likely one will discard output, but not
12366 impossible, since there might be stuff in the system buffer here.
12367 But it is much hairier to try to do anything about that. */
12368 if (interrupt_input
)
12372 /* If a frame has become visible which was not before, redisplay
12373 again, so that we display it. Expose events for such a frame
12374 (which it gets when becoming visible) don't call the parts of
12375 redisplay constructing glyphs, so simply exposing a frame won't
12376 display anything in this case. So, we have to display these
12377 frames here explicitly. */
12380 Lisp_Object tail
, frame
;
12383 FOR_EACH_FRAME (tail
, frame
)
12385 int this_is_visible
= 0;
12387 if (XFRAME (frame
)->visible
)
12388 this_is_visible
= 1;
12389 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12390 if (XFRAME (frame
)->visible
)
12391 this_is_visible
= 1;
12393 if (this_is_visible
)
12397 if (new_count
!= number_of_visible_frames
)
12398 windows_or_buffers_changed
++;
12401 /* Change frame size now if a change is pending. */
12402 do_pending_window_change (1);
12404 /* If we just did a pending size change, or have additional
12405 visible frames, redisplay again. */
12406 if (windows_or_buffers_changed
&& !pause
)
12409 /* Clear the face cache eventually. */
12410 if (consider_all_windows_p
)
12412 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12414 clear_face_cache (0);
12415 clear_face_cache_count
= 0;
12417 #ifdef HAVE_WINDOW_SYSTEM
12418 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12420 clear_image_caches (Qnil
);
12421 clear_image_cache_count
= 0;
12423 #endif /* HAVE_WINDOW_SYSTEM */
12427 unbind_to (count
, Qnil
);
12432 /* Redisplay, but leave alone any recent echo area message unless
12433 another message has been requested in its place.
12435 This is useful in situations where you need to redisplay but no
12436 user action has occurred, making it inappropriate for the message
12437 area to be cleared. See tracking_off and
12438 wait_reading_process_output for examples of these situations.
12440 FROM_WHERE is an integer saying from where this function was
12441 called. This is useful for debugging. */
12444 redisplay_preserve_echo_area (from_where
)
12447 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12449 if (!NILP (echo_area_buffer
[1]))
12451 /* We have a previously displayed message, but no current
12452 message. Redisplay the previous message. */
12453 display_last_displayed_message_p
= 1;
12454 redisplay_internal (1);
12455 display_last_displayed_message_p
= 0;
12458 redisplay_internal (1);
12460 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12461 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12462 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12466 /* Function registered with record_unwind_protect in
12467 redisplay_internal. Reset redisplaying_p to the value it had
12468 before redisplay_internal was called, and clear
12469 prevent_freeing_realized_faces_p. It also selects the previously
12470 selected frame, unless it has been deleted (by an X connection
12471 failure during redisplay, for example). */
12474 unwind_redisplay (val
)
12477 Lisp_Object old_redisplaying_p
, old_frame
;
12479 old_redisplaying_p
= XCAR (val
);
12480 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12481 old_frame
= XCDR (val
);
12482 if (! EQ (old_frame
, selected_frame
)
12483 && FRAME_LIVE_P (XFRAME (old_frame
)))
12484 select_frame_for_redisplay (old_frame
);
12489 /* Mark the display of window W as accurate or inaccurate. If
12490 ACCURATE_P is non-zero mark display of W as accurate. If
12491 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12492 redisplay_internal is called. */
12495 mark_window_display_accurate_1 (w
, accurate_p
)
12499 if (BUFFERP (w
->buffer
))
12501 struct buffer
*b
= XBUFFER (w
->buffer
);
12504 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12505 w
->last_overlay_modified
12506 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12508 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12512 b
->clip_changed
= 0;
12513 b
->prevent_redisplay_optimizations_p
= 0;
12515 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12516 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12517 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12518 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12520 w
->current_matrix
->buffer
= b
;
12521 w
->current_matrix
->begv
= BUF_BEGV (b
);
12522 w
->current_matrix
->zv
= BUF_ZV (b
);
12524 w
->last_cursor
= w
->cursor
;
12525 w
->last_cursor_off_p
= w
->cursor_off_p
;
12527 if (w
== XWINDOW (selected_window
))
12528 w
->last_point
= make_number (BUF_PT (b
));
12530 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12536 w
->window_end_valid
= w
->buffer
;
12537 w
->update_mode_line
= Qnil
;
12542 /* Mark the display of windows in the window tree rooted at WINDOW as
12543 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12544 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12545 be redisplayed the next time redisplay_internal is called. */
12548 mark_window_display_accurate (window
, accurate_p
)
12549 Lisp_Object window
;
12554 for (; !NILP (window
); window
= w
->next
)
12556 w
= XWINDOW (window
);
12557 mark_window_display_accurate_1 (w
, accurate_p
);
12559 if (!NILP (w
->vchild
))
12560 mark_window_display_accurate (w
->vchild
, accurate_p
);
12561 if (!NILP (w
->hchild
))
12562 mark_window_display_accurate (w
->hchild
, accurate_p
);
12567 update_overlay_arrows (1);
12571 /* Force a thorough redisplay the next time by setting
12572 last_arrow_position and last_arrow_string to t, which is
12573 unequal to any useful value of Voverlay_arrow_... */
12574 update_overlay_arrows (-1);
12579 /* Return value in display table DP (Lisp_Char_Table *) for character
12580 C. Since a display table doesn't have any parent, we don't have to
12581 follow parent. Do not call this function directly but use the
12582 macro DISP_CHAR_VECTOR. */
12585 disp_char_vector (dp
, c
)
12586 struct Lisp_Char_Table
*dp
;
12591 if (ASCII_CHAR_P (c
))
12594 if (SUB_CHAR_TABLE_P (val
))
12595 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12601 XSETCHAR_TABLE (table
, dp
);
12602 val
= char_table_ref (table
, c
);
12611 /***********************************************************************
12613 ***********************************************************************/
12615 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12618 redisplay_windows (window
)
12619 Lisp_Object window
;
12621 while (!NILP (window
))
12623 struct window
*w
= XWINDOW (window
);
12625 if (!NILP (w
->hchild
))
12626 redisplay_windows (w
->hchild
);
12627 else if (!NILP (w
->vchild
))
12628 redisplay_windows (w
->vchild
);
12629 else if (!NILP (w
->buffer
))
12631 displayed_buffer
= XBUFFER (w
->buffer
);
12632 /* Use list_of_error, not Qerror, so that
12633 we catch only errors and don't run the debugger. */
12634 internal_condition_case_1 (redisplay_window_0
, window
,
12636 redisplay_window_error
);
12644 redisplay_window_error ()
12646 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12651 redisplay_window_0 (window
)
12652 Lisp_Object window
;
12654 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12655 redisplay_window (window
, 0);
12660 redisplay_window_1 (window
)
12661 Lisp_Object window
;
12663 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12664 redisplay_window (window
, 1);
12669 /* Increment GLYPH until it reaches END or CONDITION fails while
12670 adding (GLYPH)->pixel_width to X. */
12672 #define SKIP_GLYPHS(glyph, end, x, condition) \
12675 (x) += (glyph)->pixel_width; \
12678 while ((glyph) < (end) && (condition))
12681 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12682 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12683 which positions recorded in ROW differ from current buffer
12686 Return 0 if cursor is not on this row, 1 otherwise. */
12689 set_cursor_from_row (w
, row
, matrix
, delta
, delta_bytes
, dy
, dvpos
)
12691 struct glyph_row
*row
;
12692 struct glyph_matrix
*matrix
;
12693 int delta
, delta_bytes
, dy
, dvpos
;
12695 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12696 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12697 struct glyph
*cursor
= NULL
;
12698 /* The last known character position in row. */
12699 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12701 EMACS_INT pt_old
= PT
- delta
;
12702 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12703 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12704 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12705 /* A glyph beyond the edge of TEXT_AREA which we should never
12707 struct glyph
*glyphs_end
= end
;
12708 /* Non-zero means we've found a match for cursor position, but that
12709 glyph has the avoid_cursor_p flag set. */
12710 int match_with_avoid_cursor
= 0;
12711 /* Non-zero means we've seen at least one glyph that came from a
12713 int string_seen
= 0;
12714 /* Largest buffer position seen so far during scan of glyph row. */
12715 EMACS_INT bpos_max
= last_pos
;
12716 /* Last buffer position covered by an overlay string with an integer
12717 `cursor' property. */
12718 EMACS_INT bpos_covered
= 0;
12720 /* Skip over glyphs not having an object at the start and the end of
12721 the row. These are special glyphs like truncation marks on
12722 terminal frames. */
12723 if (row
->displays_text_p
)
12725 if (!row
->reversed_p
)
12728 && INTEGERP (glyph
->object
)
12729 && glyph
->charpos
< 0)
12731 x
+= glyph
->pixel_width
;
12735 && INTEGERP ((end
- 1)->object
)
12736 /* CHARPOS is zero for blanks and stretch glyphs
12737 inserted by extend_face_to_end_of_line. */
12738 && (end
- 1)->charpos
<= 0)
12740 glyph_before
= glyph
- 1;
12747 /* If the glyph row is reversed, we need to process it from back
12748 to front, so swap the edge pointers. */
12749 glyphs_end
= end
= glyph
- 1;
12750 glyph
+= row
->used
[TEXT_AREA
] - 1;
12752 while (glyph
> end
+ 1
12753 && INTEGERP (glyph
->object
)
12754 && glyph
->charpos
< 0)
12757 x
-= glyph
->pixel_width
;
12759 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12761 /* By default, in reversed rows we put the cursor on the
12762 rightmost (first in the reading order) glyph. */
12763 for (g
= end
+ 1; g
< glyph
; g
++)
12764 x
+= g
->pixel_width
;
12766 && INTEGERP ((end
+ 1)->object
)
12767 && (end
+ 1)->charpos
<= 0)
12769 glyph_before
= glyph
+ 1;
12773 else if (row
->reversed_p
)
12775 /* In R2L rows that don't display text, put the cursor on the
12776 rightmost glyph. Case in point: an empty last line that is
12777 part of an R2L paragraph. */
12779 /* Avoid placing the cursor on the last glyph of the row, where
12780 on terminal frames we hold the vertical border between
12781 adjacent windows. */
12782 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12783 && !WINDOW_RIGHTMOST_P (w
)
12784 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12786 x
= -1; /* will be computed below, at label compute_x */
12789 /* Step 1: Try to find the glyph whose character position
12790 corresponds to point. If that's not possible, find 2 glyphs
12791 whose character positions are the closest to point, one before
12792 point, the other after it. */
12793 if (!row
->reversed_p
)
12794 while (/* not marched to end of glyph row */
12796 /* glyph was not inserted by redisplay for internal purposes */
12797 && !INTEGERP (glyph
->object
))
12799 if (BUFFERP (glyph
->object
))
12801 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12803 if (glyph
->charpos
> bpos_max
)
12804 bpos_max
= glyph
->charpos
;
12805 if (!glyph
->avoid_cursor_p
)
12807 /* If we hit point, we've found the glyph on which to
12808 display the cursor. */
12811 match_with_avoid_cursor
= 0;
12814 /* See if we've found a better approximation to
12815 POS_BEFORE or to POS_AFTER. Note that we want the
12816 first (leftmost) glyph of all those that are the
12817 closest from below, and the last (rightmost) of all
12818 those from above. */
12819 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12821 pos_before
= glyph
->charpos
;
12822 glyph_before
= glyph
;
12824 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12826 pos_after
= glyph
->charpos
;
12827 glyph_after
= glyph
;
12830 else if (dpos
== 0)
12831 match_with_avoid_cursor
= 1;
12833 else if (STRINGP (glyph
->object
))
12835 Lisp_Object chprop
;
12836 int glyph_pos
= glyph
->charpos
;
12838 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12840 if (INTEGERP (chprop
))
12842 bpos_covered
= bpos_max
+ XINT (chprop
);
12843 /* If the `cursor' property covers buffer positions up
12844 to and including point, we should display cursor on
12845 this glyph. Note that overlays and text properties
12846 with string values stop bidi reordering, so every
12847 buffer position to the left of the string is always
12848 smaller than any position to the right of the
12849 string. Therefore, if a `cursor' property on one
12850 of the string's characters has an integer value, we
12851 will break out of the loop below _before_ we get to
12852 the position match above. IOW, integer values of
12853 the `cursor' property override the "exact match for
12854 point" strategy of positioning the cursor. */
12855 /* Implementation note: bpos_max == pt_old when, e.g.,
12856 we are in an empty line, where bpos_max is set to
12857 MATRIX_ROW_START_CHARPOS, see above. */
12858 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12867 x
+= glyph
->pixel_width
;
12870 else if (glyph
> end
) /* row is reversed */
12871 while (!INTEGERP (glyph
->object
))
12873 if (BUFFERP (glyph
->object
))
12875 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12877 if (glyph
->charpos
> bpos_max
)
12878 bpos_max
= glyph
->charpos
;
12879 if (!glyph
->avoid_cursor_p
)
12883 match_with_avoid_cursor
= 0;
12886 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12888 pos_before
= glyph
->charpos
;
12889 glyph_before
= glyph
;
12891 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12893 pos_after
= glyph
->charpos
;
12894 glyph_after
= glyph
;
12897 else if (dpos
== 0)
12898 match_with_avoid_cursor
= 1;
12900 else if (STRINGP (glyph
->object
))
12902 Lisp_Object chprop
;
12903 int glyph_pos
= glyph
->charpos
;
12905 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12907 if (INTEGERP (chprop
))
12909 bpos_covered
= bpos_max
+ XINT (chprop
);
12910 /* If the `cursor' property covers buffer positions up
12911 to and including point, we should display cursor on
12913 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12922 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12924 x
--; /* can't use any pixel_width */
12927 x
-= glyph
->pixel_width
;
12930 /* Step 2: If we didn't find an exact match for point, we need to
12931 look for a proper place to put the cursor among glyphs between
12932 GLYPH_BEFORE and GLYPH_AFTER. */
12933 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12934 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12935 && bpos_covered
< pt_old
)
12937 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12939 EMACS_INT ellipsis_pos
;
12941 /* Scan back over the ellipsis glyphs. */
12942 if (!row
->reversed_p
)
12944 ellipsis_pos
= (glyph
- 1)->charpos
;
12945 while (glyph
> row
->glyphs
[TEXT_AREA
]
12946 && (glyph
- 1)->charpos
== ellipsis_pos
)
12947 glyph
--, x
-= glyph
->pixel_width
;
12948 /* That loop always goes one position too far, including
12949 the glyph before the ellipsis. So scan forward over
12951 x
+= glyph
->pixel_width
;
12954 else /* row is reversed */
12956 ellipsis_pos
= (glyph
+ 1)->charpos
;
12957 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12958 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12959 glyph
++, x
+= glyph
->pixel_width
;
12960 x
-= glyph
->pixel_width
;
12964 else if (match_with_avoid_cursor
12965 /* zero-width characters produce no glyphs */
12966 || ((row
->reversed_p
12967 ? glyph_after
> glyphs_end
12968 : glyph_after
< glyphs_end
)
12969 && eabs (glyph_after
- glyph_before
) == 1))
12971 cursor
= glyph_after
;
12974 else if (string_seen
)
12976 int incr
= row
->reversed_p
? -1 : +1;
12978 /* Need to find the glyph that came out of a string which is
12979 present at point. That glyph is somewhere between
12980 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12981 positioned between POS_BEFORE and POS_AFTER in the
12983 struct glyph
*stop
= glyph_after
;
12984 EMACS_INT pos
= pos_before
;
12987 for (glyph
= glyph_before
+ incr
;
12988 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12991 /* Any glyphs that come from the buffer are here because
12992 of bidi reordering. Skip them, and only pay
12993 attention to glyphs that came from some string. */
12994 if (STRINGP (glyph
->object
))
12999 str
= glyph
->object
;
13000 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
13001 if (tem
== 0 /* from overlay */
13004 /* If the string from which this glyph came is
13005 found in the buffer at point, then we've
13006 found the glyph we've been looking for. If
13007 it comes from an overlay (tem == 0), and it
13008 has the `cursor' property on one of its
13009 glyphs, record that glyph as a candidate for
13010 displaying the cursor. (As in the
13011 unidirectional version, we will display the
13012 cursor on the last candidate we find.) */
13013 if (tem
== 0 || tem
== pt_old
)
13015 /* The glyphs from this string could have
13016 been reordered. Find the one with the
13017 smallest string position. Or there could
13018 be a character in the string with the
13019 `cursor' property, which means display
13020 cursor on that character's glyph. */
13021 int strpos
= glyph
->charpos
;
13024 for (glyph
+= incr
;
13025 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13026 && EQ (glyph
->object
, str
);
13030 int gpos
= glyph
->charpos
;
13032 cprop
= Fget_char_property (make_number (gpos
),
13040 if (glyph
->charpos
< strpos
)
13042 strpos
= glyph
->charpos
;
13051 pos
= tem
+ 1; /* don't find previous instances */
13053 /* This string is not what we want; skip all of the
13054 glyphs that came from it. */
13057 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13058 && EQ (glyph
->object
, str
));
13064 /* If we reached the end of the line, and END was from a string,
13065 the cursor is not on this line. */
13067 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13068 && STRINGP (end
->object
)
13069 && row
->continued_p
)
13075 if (cursor
!= NULL
)
13081 /* Need to compute x that corresponds to GLYPH. */
13082 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13084 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13086 x
+= g
->pixel_width
;
13090 /* ROW could be part of a continued line, which, under bidi
13091 reordering, might have other rows whose start and end charpos
13092 occlude point. Only set w->cursor if we found a better
13093 approximation to the cursor position than we have from previously
13094 examined candidate rows belonging to the same continued line. */
13095 if (/* we already have a candidate row */
13096 w
->cursor
.vpos
>= 0
13097 /* that candidate is not the row we are processing */
13098 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13099 /* the row we are processing is part of a continued line */
13100 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
13101 /* Make sure cursor.vpos specifies a row whose start and end
13102 charpos occlude point. This is because some callers of this
13103 function leave cursor.vpos at the row where the cursor was
13104 displayed during the last redisplay cycle. */
13105 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13106 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13109 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13111 /* Don't consider glyphs that are outside TEXT_AREA. */
13112 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13114 /* Keep the candidate whose buffer position is the closest to
13116 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13117 w
->cursor
.hpos
>= 0
13118 && w
->cursor
.hpos
< MATRIX_ROW_USED(matrix
, w
->cursor
.vpos
)
13119 && BUFFERP (g1
->object
)
13120 && (g1
->charpos
== pt_old
/* an exact match always wins */
13121 || (BUFFERP (glyph
->object
)
13122 && eabs (g1
->charpos
- pt_old
)
13123 < eabs (glyph
->charpos
- pt_old
))))
13125 /* If this candidate gives an exact match, use that. */
13126 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13127 /* Otherwise, keep the candidate that comes from a row
13128 spanning less buffer positions. This may win when one or
13129 both candidate positions are on glyphs that came from
13130 display strings, for which we cannot compare buffer
13132 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13133 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13134 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13137 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13139 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13140 w
->cursor
.y
= row
->y
+ dy
;
13142 if (w
== XWINDOW (selected_window
))
13144 if (!row
->continued_p
13145 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13148 this_line_buffer
= XBUFFER (w
->buffer
);
13150 CHARPOS (this_line_start_pos
)
13151 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13152 BYTEPOS (this_line_start_pos
)
13153 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13155 CHARPOS (this_line_end_pos
)
13156 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13157 BYTEPOS (this_line_end_pos
)
13158 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13160 this_line_y
= w
->cursor
.y
;
13161 this_line_pixel_height
= row
->height
;
13162 this_line_vpos
= w
->cursor
.vpos
;
13163 this_line_start_x
= row
->x
;
13166 CHARPOS (this_line_start_pos
) = 0;
13173 /* Run window scroll functions, if any, for WINDOW with new window
13174 start STARTP. Sets the window start of WINDOW to that position.
13176 We assume that the window's buffer is really current. */
13178 static INLINE
struct text_pos
13179 run_window_scroll_functions (window
, startp
)
13180 Lisp_Object window
;
13181 struct text_pos startp
;
13183 struct window
*w
= XWINDOW (window
);
13184 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13186 if (current_buffer
!= XBUFFER (w
->buffer
))
13189 if (!NILP (Vwindow_scroll_functions
))
13191 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13192 make_number (CHARPOS (startp
)));
13193 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13194 /* In case the hook functions switch buffers. */
13195 if (current_buffer
!= XBUFFER (w
->buffer
))
13196 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13203 /* Make sure the line containing the cursor is fully visible.
13204 A value of 1 means there is nothing to be done.
13205 (Either the line is fully visible, or it cannot be made so,
13206 or we cannot tell.)
13208 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13209 is higher than window.
13211 A value of 0 means the caller should do scrolling
13212 as if point had gone off the screen. */
13215 cursor_row_fully_visible_p (w
, force_p
, current_matrix_p
)
13218 int current_matrix_p
;
13220 struct glyph_matrix
*matrix
;
13221 struct glyph_row
*row
;
13224 if (!make_cursor_line_fully_visible_p
)
13227 /* It's not always possible to find the cursor, e.g, when a window
13228 is full of overlay strings. Don't do anything in that case. */
13229 if (w
->cursor
.vpos
< 0)
13232 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13233 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13235 /* If the cursor row is not partially visible, there's nothing to do. */
13236 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13239 /* If the row the cursor is in is taller than the window's height,
13240 it's not clear what to do, so do nothing. */
13241 window_height
= window_box_height (w
);
13242 if (row
->height
>= window_height
)
13244 if (!force_p
|| MINI_WINDOW_P (w
)
13245 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13252 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13253 non-zero means only WINDOW is redisplayed in redisplay_internal.
13254 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13255 in redisplay_window to bring a partially visible line into view in
13256 the case that only the cursor has moved.
13258 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13259 last screen line's vertical height extends past the end of the screen.
13263 1 if scrolling succeeded
13265 0 if scrolling didn't find point.
13267 -1 if new fonts have been loaded so that we must interrupt
13268 redisplay, adjust glyph matrices, and try again. */
13274 SCROLLING_NEED_LARGER_MATRICES
13278 try_scrolling (window
, just_this_one_p
, scroll_conservatively
,
13279 scroll_step
, temp_scroll_step
, last_line_misfit
)
13280 Lisp_Object window
;
13281 int just_this_one_p
;
13282 EMACS_INT scroll_conservatively
, scroll_step
;
13283 int temp_scroll_step
;
13284 int last_line_misfit
;
13286 struct window
*w
= XWINDOW (window
);
13287 struct frame
*f
= XFRAME (w
->frame
);
13288 struct text_pos pos
, startp
;
13290 int this_scroll_margin
, scroll_max
, rc
, height
;
13291 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13292 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13293 Lisp_Object aggressive
;
13294 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13297 debug_method_add (w
, "try_scrolling");
13300 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13302 /* Compute scroll margin height in pixels. We scroll when point is
13303 within this distance from the top or bottom of the window. */
13304 if (scroll_margin
> 0)
13305 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13306 * FRAME_LINE_HEIGHT (f
);
13308 this_scroll_margin
= 0;
13310 /* Force scroll_conservatively to have a reasonable value, to avoid
13311 overflow while computing how much to scroll. Note that the user
13312 can supply scroll-conservatively equal to `most-positive-fixnum',
13313 which can be larger than INT_MAX. */
13314 if (scroll_conservatively
> scroll_limit
)
13316 scroll_conservatively
= scroll_limit
;
13317 scroll_max
= INT_MAX
;
13319 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13320 /* Compute how much we should try to scroll maximally to bring
13321 point into view. */
13322 scroll_max
= (max (scroll_step
,
13323 max (scroll_conservatively
, temp_scroll_step
))
13324 * FRAME_LINE_HEIGHT (f
));
13325 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13326 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13327 /* We're trying to scroll because of aggressive scrolling but no
13328 scroll_step is set. Choose an arbitrary one. */
13329 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13335 /* Decide whether to scroll down. */
13336 if (PT
> CHARPOS (startp
))
13338 int scroll_margin_y
;
13340 /* Compute the pixel ypos of the scroll margin, then move it to
13341 either that ypos or PT, whichever comes first. */
13342 start_display (&it
, w
, startp
);
13343 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13344 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13345 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13346 (MOVE_TO_POS
| MOVE_TO_Y
));
13348 if (PT
> CHARPOS (it
.current
.pos
))
13350 int y0
= line_bottom_y (&it
);
13352 /* Compute the distance from the scroll margin to PT
13353 (including the height of the cursor line). Moving the
13354 iterator unconditionally to PT can be slow if PT is far
13355 away, so stop 10 lines past the window bottom (is there a
13356 way to do the right thing quickly?). */
13357 move_it_to (&it
, PT
, -1,
13358 it
.last_visible_y
+ 10 * FRAME_LINE_HEIGHT (f
),
13359 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13360 dy
= line_bottom_y (&it
) - y0
;
13362 if (dy
> scroll_max
)
13363 return SCROLLING_FAILED
;
13371 /* Point is in or below the bottom scroll margin, so move the
13372 window start down. If scrolling conservatively, move it just
13373 enough down to make point visible. If scroll_step is set,
13374 move it down by scroll_step. */
13375 if (scroll_conservatively
)
13377 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13378 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13379 else if (scroll_step
|| temp_scroll_step
)
13380 amount_to_scroll
= scroll_max
;
13383 aggressive
= current_buffer
->scroll_up_aggressively
;
13384 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13385 if (NUMBERP (aggressive
))
13387 double float_amount
= XFLOATINT (aggressive
) * height
;
13388 amount_to_scroll
= float_amount
;
13389 if (amount_to_scroll
== 0 && float_amount
> 0)
13390 amount_to_scroll
= 1;
13394 if (amount_to_scroll
<= 0)
13395 return SCROLLING_FAILED
;
13397 start_display (&it
, w
, startp
);
13398 move_it_vertically (&it
, amount_to_scroll
);
13400 /* If STARTP is unchanged, move it down another screen line. */
13401 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13402 move_it_by_lines (&it
, 1, 1);
13403 startp
= it
.current
.pos
;
13407 struct text_pos scroll_margin_pos
= startp
;
13409 /* See if point is inside the scroll margin at the top of the
13411 if (this_scroll_margin
)
13413 start_display (&it
, w
, startp
);
13414 move_it_vertically (&it
, this_scroll_margin
);
13415 scroll_margin_pos
= it
.current
.pos
;
13418 if (PT
< CHARPOS (scroll_margin_pos
))
13420 /* Point is in the scroll margin at the top of the window or
13421 above what is displayed in the window. */
13424 /* Compute the vertical distance from PT to the scroll
13425 margin position. Give up if distance is greater than
13427 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13428 start_display (&it
, w
, pos
);
13430 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13431 it
.last_visible_y
, -1,
13432 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13433 dy
= it
.current_y
- y0
;
13434 if (dy
> scroll_max
)
13435 return SCROLLING_FAILED
;
13437 /* Compute new window start. */
13438 start_display (&it
, w
, startp
);
13440 if (scroll_conservatively
)
13442 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13443 else if (scroll_step
|| temp_scroll_step
)
13444 amount_to_scroll
= scroll_max
;
13447 aggressive
= current_buffer
->scroll_down_aggressively
;
13448 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13449 if (NUMBERP (aggressive
))
13451 double float_amount
= XFLOATINT (aggressive
) * height
;
13452 amount_to_scroll
= float_amount
;
13453 if (amount_to_scroll
== 0 && float_amount
> 0)
13454 amount_to_scroll
= 1;
13458 if (amount_to_scroll
<= 0)
13459 return SCROLLING_FAILED
;
13461 move_it_vertically_backward (&it
, amount_to_scroll
);
13462 startp
= it
.current
.pos
;
13466 /* Run window scroll functions. */
13467 startp
= run_window_scroll_functions (window
, startp
);
13469 /* Display the window. Give up if new fonts are loaded, or if point
13471 if (!try_window (window
, startp
, 0))
13472 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13473 else if (w
->cursor
.vpos
< 0)
13475 clear_glyph_matrix (w
->desired_matrix
);
13476 rc
= SCROLLING_FAILED
;
13480 /* Maybe forget recorded base line for line number display. */
13481 if (!just_this_one_p
13482 || current_buffer
->clip_changed
13483 || BEG_UNCHANGED
< CHARPOS (startp
))
13484 w
->base_line_number
= Qnil
;
13486 /* If cursor ends up on a partially visible line,
13487 treat that as being off the bottom of the screen. */
13488 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13490 clear_glyph_matrix (w
->desired_matrix
);
13491 ++extra_scroll_margin_lines
;
13494 rc
= SCROLLING_SUCCESS
;
13501 /* Compute a suitable window start for window W if display of W starts
13502 on a continuation line. Value is non-zero if a new window start
13505 The new window start will be computed, based on W's width, starting
13506 from the start of the continued line. It is the start of the
13507 screen line with the minimum distance from the old start W->start. */
13510 compute_window_start_on_continuation_line (w
)
13513 struct text_pos pos
, start_pos
;
13514 int window_start_changed_p
= 0;
13516 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13518 /* If window start is on a continuation line... Window start may be
13519 < BEGV in case there's invisible text at the start of the
13520 buffer (M-x rmail, for example). */
13521 if (CHARPOS (start_pos
) > BEGV
13522 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13525 struct glyph_row
*row
;
13527 /* Handle the case that the window start is out of range. */
13528 if (CHARPOS (start_pos
) < BEGV
)
13529 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13530 else if (CHARPOS (start_pos
) > ZV
)
13531 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13533 /* Find the start of the continued line. This should be fast
13534 because scan_buffer is fast (newline cache). */
13535 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13536 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13537 row
, DEFAULT_FACE_ID
);
13538 reseat_at_previous_visible_line_start (&it
);
13540 /* If the line start is "too far" away from the window start,
13541 say it takes too much time to compute a new window start. */
13542 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13543 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13545 int min_distance
, distance
;
13547 /* Move forward by display lines to find the new window
13548 start. If window width was enlarged, the new start can
13549 be expected to be > the old start. If window width was
13550 decreased, the new window start will be < the old start.
13551 So, we're looking for the display line start with the
13552 minimum distance from the old window start. */
13553 pos
= it
.current
.pos
;
13554 min_distance
= INFINITY
;
13555 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13556 distance
< min_distance
)
13558 min_distance
= distance
;
13559 pos
= it
.current
.pos
;
13560 move_it_by_lines (&it
, 1, 0);
13563 /* Set the window start there. */
13564 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13565 window_start_changed_p
= 1;
13569 return window_start_changed_p
;
13573 /* Try cursor movement in case text has not changed in window WINDOW,
13574 with window start STARTP. Value is
13576 CURSOR_MOVEMENT_SUCCESS if successful
13578 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13580 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13581 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13582 we want to scroll as if scroll-step were set to 1. See the code.
13584 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13585 which case we have to abort this redisplay, and adjust matrices
13590 CURSOR_MOVEMENT_SUCCESS
,
13591 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13592 CURSOR_MOVEMENT_MUST_SCROLL
,
13593 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13597 try_cursor_movement (window
, startp
, scroll_step
)
13598 Lisp_Object window
;
13599 struct text_pos startp
;
13602 struct window
*w
= XWINDOW (window
);
13603 struct frame
*f
= XFRAME (w
->frame
);
13604 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13607 if (inhibit_try_cursor_movement
)
13611 /* Handle case where text has not changed, only point, and it has
13612 not moved off the frame. */
13613 if (/* Point may be in this window. */
13614 PT
>= CHARPOS (startp
)
13615 /* Selective display hasn't changed. */
13616 && !current_buffer
->clip_changed
13617 /* Function force-mode-line-update is used to force a thorough
13618 redisplay. It sets either windows_or_buffers_changed or
13619 update_mode_lines. So don't take a shortcut here for these
13621 && !update_mode_lines
13622 && !windows_or_buffers_changed
13623 && !cursor_type_changed
13624 /* Can't use this case if highlighting a region. When a
13625 region exists, cursor movement has to do more than just
13627 && !(!NILP (Vtransient_mark_mode
)
13628 && !NILP (current_buffer
->mark_active
))
13629 && NILP (w
->region_showing
)
13630 && NILP (Vshow_trailing_whitespace
)
13631 /* Right after splitting windows, last_point may be nil. */
13632 && INTEGERP (w
->last_point
)
13633 /* This code is not used for mini-buffer for the sake of the case
13634 of redisplaying to replace an echo area message; since in
13635 that case the mini-buffer contents per se are usually
13636 unchanged. This code is of no real use in the mini-buffer
13637 since the handling of this_line_start_pos, etc., in redisplay
13638 handles the same cases. */
13639 && !EQ (window
, minibuf_window
)
13640 /* When splitting windows or for new windows, it happens that
13641 redisplay is called with a nil window_end_vpos or one being
13642 larger than the window. This should really be fixed in
13643 window.c. I don't have this on my list, now, so we do
13644 approximately the same as the old redisplay code. --gerd. */
13645 && INTEGERP (w
->window_end_vpos
)
13646 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13647 && (FRAME_WINDOW_P (f
)
13648 || !overlay_arrow_in_current_buffer_p ()))
13650 int this_scroll_margin
, top_scroll_margin
;
13651 struct glyph_row
*row
= NULL
;
13654 debug_method_add (w
, "cursor movement");
13657 /* Scroll if point within this distance from the top or bottom
13658 of the window. This is a pixel value. */
13659 if (scroll_margin
> 0)
13661 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13662 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13665 this_scroll_margin
= 0;
13667 top_scroll_margin
= this_scroll_margin
;
13668 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13669 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13671 /* Start with the row the cursor was displayed during the last
13672 not paused redisplay. Give up if that row is not valid. */
13673 if (w
->last_cursor
.vpos
< 0
13674 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13675 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13678 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13679 if (row
->mode_line_p
)
13681 if (!row
->enabled_p
)
13682 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13683 /* If rows are bidi-reordered, back up until we find a row
13684 that does not belong to a continuation line. This is
13685 because we must consider all rows of a continued line as
13686 candidates for cursor positioning, since row start and
13687 end positions change non-linearly with vertical position
13689 /* FIXME: Revisit this when glyph ``spilling'' in
13690 continuation lines' rows is implemented for
13691 bidi-reordered rows. */
13692 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13694 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13696 xassert (row
->enabled_p
);
13698 /* If we hit the beginning of the displayed portion
13699 without finding the first row of a continued
13701 if (row
<= w
->current_matrix
->rows
)
13703 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13711 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13714 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13716 if (PT
> XFASTINT (w
->last_point
))
13718 /* Point has moved forward. */
13719 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13720 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13722 xassert (row
->enabled_p
);
13726 /* If the end position of a row equals the start
13727 position of the next row, and PT is at that position,
13728 we would rather display cursor in the next line. */
13729 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13730 && MATRIX_ROW_END_CHARPOS (row
) == PT
13731 && row
< w
->current_matrix
->rows
13732 + w
->current_matrix
->nrows
- 1
13733 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13734 && !cursor_row_p (w
, row
))
13737 /* If within the scroll margin, scroll. Note that
13738 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13739 the next line would be drawn, and that
13740 this_scroll_margin can be zero. */
13741 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13742 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13743 /* Line is completely visible last line in window
13744 and PT is to be set in the next line. */
13745 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13746 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13747 && !row
->ends_at_zv_p
13748 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13751 else if (PT
< XFASTINT (w
->last_point
))
13753 /* Cursor has to be moved backward. Note that PT >=
13754 CHARPOS (startp) because of the outer if-statement. */
13755 while (!row
->mode_line_p
13756 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13757 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13758 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13759 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13760 row
> w
->current_matrix
->rows
13761 && (row
-1)->ends_in_newline_from_string_p
))))
13762 && (row
->y
> top_scroll_margin
13763 || CHARPOS (startp
) == BEGV
))
13765 xassert (row
->enabled_p
);
13769 /* Consider the following case: Window starts at BEGV,
13770 there is invisible, intangible text at BEGV, so that
13771 display starts at some point START > BEGV. It can
13772 happen that we are called with PT somewhere between
13773 BEGV and START. Try to handle that case. */
13774 if (row
< w
->current_matrix
->rows
13775 || row
->mode_line_p
)
13777 row
= w
->current_matrix
->rows
;
13778 if (row
->mode_line_p
)
13782 /* Due to newlines in overlay strings, we may have to
13783 skip forward over overlay strings. */
13784 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13785 && MATRIX_ROW_END_CHARPOS (row
) == PT
13786 && !cursor_row_p (w
, row
))
13789 /* If within the scroll margin, scroll. */
13790 if (row
->y
< top_scroll_margin
13791 && CHARPOS (startp
) != BEGV
)
13796 /* Cursor did not move. So don't scroll even if cursor line
13797 is partially visible, as it was so before. */
13798 rc
= CURSOR_MOVEMENT_SUCCESS
;
13801 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13802 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13804 /* if PT is not in the glyph row, give up. */
13805 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13807 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13808 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13809 && make_cursor_line_fully_visible_p
)
13811 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13812 && !row
->ends_at_zv_p
13813 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13814 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13815 else if (row
->height
> window_box_height (w
))
13817 /* If we end up in a partially visible line, let's
13818 make it fully visible, except when it's taller
13819 than the window, in which case we can't do much
13822 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13826 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13827 if (!cursor_row_fully_visible_p (w
, 0, 1))
13828 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13830 rc
= CURSOR_MOVEMENT_SUCCESS
;
13834 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13835 else if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13837 /* With bidi-reordered rows, there could be more than
13838 one candidate row whose start and end positions
13839 occlude point. We need to let set_cursor_from_row
13840 find the best candidate. */
13841 /* FIXME: Revisit this when glyph ``spilling'' in
13842 continuation lines' rows is implemented for
13843 bidi-reordered rows. */
13848 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13850 /* As soon as we've found the first suitable row
13851 whose ends_at_zv_p flag is set, we are done. */
13853 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13855 rc
= CURSOR_MOVEMENT_SUCCESS
;
13860 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13861 && MATRIX_ROW_START_CHARPOS (row
) <= PT
13862 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13863 && cursor_row_p (w
, row
));
13864 /* If we didn't find any candidate rows, or exited the
13865 loop before all the candidates were examined, signal
13866 to the caller that this method failed. */
13867 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13869 || (MATRIX_ROW_START_CHARPOS (row
) <= PT
13870 && PT
<= MATRIX_ROW_END_CHARPOS (row
))))
13871 rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13873 rc
= CURSOR_MOVEMENT_SUCCESS
;
13879 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13881 rc
= CURSOR_MOVEMENT_SUCCESS
;
13886 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13887 && MATRIX_ROW_START_CHARPOS (row
) == PT
13888 && cursor_row_p (w
, row
));
13897 set_vertical_scroll_bar (w
)
13900 int start
, end
, whole
;
13902 /* Calculate the start and end positions for the current window.
13903 At some point, it would be nice to choose between scrollbars
13904 which reflect the whole buffer size, with special markers
13905 indicating narrowing, and scrollbars which reflect only the
13908 Note that mini-buffers sometimes aren't displaying any text. */
13909 if (!MINI_WINDOW_P (w
)
13910 || (w
== XWINDOW (minibuf_window
)
13911 && NILP (echo_area_buffer
[0])))
13913 struct buffer
*buf
= XBUFFER (w
->buffer
);
13914 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13915 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13916 /* I don't think this is guaranteed to be right. For the
13917 moment, we'll pretend it is. */
13918 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13922 if (whole
< (end
- start
))
13923 whole
= end
- start
;
13926 start
= end
= whole
= 0;
13928 /* Indicate what this scroll bar ought to be displaying now. */
13929 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13930 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13931 (w
, end
- start
, whole
, start
);
13935 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13936 selected_window is redisplayed.
13938 We can return without actually redisplaying the window if
13939 fonts_changed_p is nonzero. In that case, redisplay_internal will
13943 redisplay_window (window
, just_this_one_p
)
13944 Lisp_Object window
;
13945 int just_this_one_p
;
13947 struct window
*w
= XWINDOW (window
);
13948 struct frame
*f
= XFRAME (w
->frame
);
13949 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13950 struct buffer
*old
= current_buffer
;
13951 struct text_pos lpoint
, opoint
, startp
;
13952 int update_mode_line
;
13955 /* Record it now because it's overwritten. */
13956 int current_matrix_up_to_date_p
= 0;
13957 int used_current_matrix_p
= 0;
13958 /* This is less strict than current_matrix_up_to_date_p.
13959 It indictes that the buffer contents and narrowing are unchanged. */
13960 int buffer_unchanged_p
= 0;
13961 int temp_scroll_step
= 0;
13962 int count
= SPECPDL_INDEX ();
13964 int centering_position
= -1;
13965 int last_line_misfit
= 0;
13966 int beg_unchanged
, end_unchanged
;
13968 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13971 /* W must be a leaf window here. */
13972 xassert (!NILP (w
->buffer
));
13974 *w
->desired_matrix
->method
= 0;
13978 reconsider_clip_changes (w
, buffer
);
13980 /* Has the mode line to be updated? */
13981 update_mode_line
= (!NILP (w
->update_mode_line
)
13982 || update_mode_lines
13983 || buffer
->clip_changed
13984 || buffer
->prevent_redisplay_optimizations_p
);
13986 if (MINI_WINDOW_P (w
))
13988 if (w
== XWINDOW (echo_area_window
)
13989 && !NILP (echo_area_buffer
[0]))
13991 if (update_mode_line
)
13992 /* We may have to update a tty frame's menu bar or a
13993 tool-bar. Example `M-x C-h C-h C-g'. */
13994 goto finish_menu_bars
;
13996 /* We've already displayed the echo area glyphs in this window. */
13997 goto finish_scroll_bars
;
13999 else if ((w
!= XWINDOW (minibuf_window
)
14000 || minibuf_level
== 0)
14001 /* When buffer is nonempty, redisplay window normally. */
14002 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14003 /* Quail displays non-mini buffers in minibuffer window.
14004 In that case, redisplay the window normally. */
14005 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14007 /* W is a mini-buffer window, but it's not active, so clear
14009 int yb
= window_text_bottom_y (w
);
14010 struct glyph_row
*row
;
14013 for (y
= 0, row
= w
->desired_matrix
->rows
;
14015 y
+= row
->height
, ++row
)
14016 blank_row (w
, row
, y
);
14017 goto finish_scroll_bars
;
14020 clear_glyph_matrix (w
->desired_matrix
);
14023 /* Otherwise set up data on this window; select its buffer and point
14025 /* Really select the buffer, for the sake of buffer-local
14027 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14029 current_matrix_up_to_date_p
14030 = (!NILP (w
->window_end_valid
)
14031 && !current_buffer
->clip_changed
14032 && !current_buffer
->prevent_redisplay_optimizations_p
14033 && XFASTINT (w
->last_modified
) >= MODIFF
14034 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14036 /* Run the window-bottom-change-functions
14037 if it is possible that the text on the screen has changed
14038 (either due to modification of the text, or any other reason). */
14039 if (!current_matrix_up_to_date_p
14040 && !NILP (Vwindow_text_change_functions
))
14042 safe_run_hooks (Qwindow_text_change_functions
);
14046 beg_unchanged
= BEG_UNCHANGED
;
14047 end_unchanged
= END_UNCHANGED
;
14049 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14051 specbind (Qinhibit_point_motion_hooks
, Qt
);
14054 = (!NILP (w
->window_end_valid
)
14055 && !current_buffer
->clip_changed
14056 && XFASTINT (w
->last_modified
) >= MODIFF
14057 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14059 /* When windows_or_buffers_changed is non-zero, we can't rely on
14060 the window end being valid, so set it to nil there. */
14061 if (windows_or_buffers_changed
)
14063 /* If window starts on a continuation line, maybe adjust the
14064 window start in case the window's width changed. */
14065 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14066 compute_window_start_on_continuation_line (w
);
14068 w
->window_end_valid
= Qnil
;
14071 /* Some sanity checks. */
14072 CHECK_WINDOW_END (w
);
14073 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14075 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14078 /* If %c is in mode line, update it if needed. */
14079 if (!NILP (w
->column_number_displayed
)
14080 /* This alternative quickly identifies a common case
14081 where no change is needed. */
14082 && !(PT
== XFASTINT (w
->last_point
)
14083 && XFASTINT (w
->last_modified
) >= MODIFF
14084 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14085 && (XFASTINT (w
->column_number_displayed
)
14086 != (int) current_column ())) /* iftc */
14087 update_mode_line
= 1;
14089 /* Count number of windows showing the selected buffer. An indirect
14090 buffer counts as its base buffer. */
14091 if (!just_this_one_p
)
14093 struct buffer
*current_base
, *window_base
;
14094 current_base
= current_buffer
;
14095 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14096 if (current_base
->base_buffer
)
14097 current_base
= current_base
->base_buffer
;
14098 if (window_base
->base_buffer
)
14099 window_base
= window_base
->base_buffer
;
14100 if (current_base
== window_base
)
14104 /* Point refers normally to the selected window. For any other
14105 window, set up appropriate value. */
14106 if (!EQ (window
, selected_window
))
14108 int new_pt
= XMARKER (w
->pointm
)->charpos
;
14109 int new_pt_byte
= marker_byte_position (w
->pointm
);
14113 new_pt_byte
= BEGV_BYTE
;
14114 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14116 else if (new_pt
> (ZV
- 1))
14119 new_pt_byte
= ZV_BYTE
;
14120 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14123 /* We don't use SET_PT so that the point-motion hooks don't run. */
14124 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14127 /* If any of the character widths specified in the display table
14128 have changed, invalidate the width run cache. It's true that
14129 this may be a bit late to catch such changes, but the rest of
14130 redisplay goes (non-fatally) haywire when the display table is
14131 changed, so why should we worry about doing any better? */
14132 if (current_buffer
->width_run_cache
)
14134 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14136 if (! disptab_matches_widthtab (disptab
,
14137 XVECTOR (current_buffer
->width_table
)))
14139 invalidate_region_cache (current_buffer
,
14140 current_buffer
->width_run_cache
,
14142 recompute_width_table (current_buffer
, disptab
);
14146 /* If window-start is screwed up, choose a new one. */
14147 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14150 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14152 /* If someone specified a new starting point but did not insist,
14153 check whether it can be used. */
14154 if (!NILP (w
->optional_new_start
)
14155 && CHARPOS (startp
) >= BEGV
14156 && CHARPOS (startp
) <= ZV
)
14158 w
->optional_new_start
= Qnil
;
14159 start_display (&it
, w
, startp
);
14160 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14161 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14162 if (IT_CHARPOS (it
) == PT
)
14163 w
->force_start
= Qt
;
14164 /* IT may overshoot PT if text at PT is invisible. */
14165 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14166 w
->force_start
= Qt
;
14171 /* Handle case where place to start displaying has been specified,
14172 unless the specified location is outside the accessible range. */
14173 if (!NILP (w
->force_start
)
14174 || w
->frozen_window_start_p
)
14176 /* We set this later on if we have to adjust point. */
14179 w
->force_start
= Qnil
;
14181 w
->window_end_valid
= Qnil
;
14183 /* Forget any recorded base line for line number display. */
14184 if (!buffer_unchanged_p
)
14185 w
->base_line_number
= Qnil
;
14187 /* Redisplay the mode line. Select the buffer properly for that.
14188 Also, run the hook window-scroll-functions
14189 because we have scrolled. */
14190 /* Note, we do this after clearing force_start because
14191 if there's an error, it is better to forget about force_start
14192 than to get into an infinite loop calling the hook functions
14193 and having them get more errors. */
14194 if (!update_mode_line
14195 || ! NILP (Vwindow_scroll_functions
))
14197 update_mode_line
= 1;
14198 w
->update_mode_line
= Qt
;
14199 startp
= run_window_scroll_functions (window
, startp
);
14202 w
->last_modified
= make_number (0);
14203 w
->last_overlay_modified
= make_number (0);
14204 if (CHARPOS (startp
) < BEGV
)
14205 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14206 else if (CHARPOS (startp
) > ZV
)
14207 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14209 /* Redisplay, then check if cursor has been set during the
14210 redisplay. Give up if new fonts were loaded. */
14211 /* We used to issue a CHECK_MARGINS argument to try_window here,
14212 but this causes scrolling to fail when point begins inside
14213 the scroll margin (bug#148) -- cyd */
14214 if (!try_window (window
, startp
, 0))
14216 w
->force_start
= Qt
;
14217 clear_glyph_matrix (w
->desired_matrix
);
14218 goto need_larger_matrices
;
14221 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14223 /* If point does not appear, try to move point so it does
14224 appear. The desired matrix has been built above, so we
14225 can use it here. */
14226 new_vpos
= window_box_height (w
) / 2;
14229 if (!cursor_row_fully_visible_p (w
, 0, 0))
14231 /* Point does appear, but on a line partly visible at end of window.
14232 Move it back to a fully-visible line. */
14233 new_vpos
= window_box_height (w
);
14236 /* If we need to move point for either of the above reasons,
14237 now actually do it. */
14240 struct glyph_row
*row
;
14242 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14243 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14246 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14247 MATRIX_ROW_START_BYTEPOS (row
));
14249 if (w
!= XWINDOW (selected_window
))
14250 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14251 else if (current_buffer
== old
)
14252 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14254 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14256 /* If we are highlighting the region, then we just changed
14257 the region, so redisplay to show it. */
14258 if (!NILP (Vtransient_mark_mode
)
14259 && !NILP (current_buffer
->mark_active
))
14261 clear_glyph_matrix (w
->desired_matrix
);
14262 if (!try_window (window
, startp
, 0))
14263 goto need_larger_matrices
;
14268 debug_method_add (w
, "forced window start");
14273 /* Handle case where text has not changed, only point, and it has
14274 not moved off the frame, and we are not retrying after hscroll.
14275 (current_matrix_up_to_date_p is nonzero when retrying.) */
14276 if (current_matrix_up_to_date_p
14277 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14278 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14282 case CURSOR_MOVEMENT_SUCCESS
:
14283 used_current_matrix_p
= 1;
14286 case CURSOR_MOVEMENT_MUST_SCROLL
:
14287 goto try_to_scroll
;
14293 /* If current starting point was originally the beginning of a line
14294 but no longer is, find a new starting point. */
14295 else if (!NILP (w
->start_at_line_beg
)
14296 && !(CHARPOS (startp
) <= BEGV
14297 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14300 debug_method_add (w
, "recenter 1");
14305 /* Try scrolling with try_window_id. Value is > 0 if update has
14306 been done, it is -1 if we know that the same window start will
14307 not work. It is 0 if unsuccessful for some other reason. */
14308 else if ((tem
= try_window_id (w
)) != 0)
14311 debug_method_add (w
, "try_window_id %d", tem
);
14314 if (fonts_changed_p
)
14315 goto need_larger_matrices
;
14319 /* Otherwise try_window_id has returned -1 which means that we
14320 don't want the alternative below this comment to execute. */
14322 else if (CHARPOS (startp
) >= BEGV
14323 && CHARPOS (startp
) <= ZV
14324 && PT
>= CHARPOS (startp
)
14325 && (CHARPOS (startp
) < ZV
14326 /* Avoid starting at end of buffer. */
14327 || CHARPOS (startp
) == BEGV
14328 || (XFASTINT (w
->last_modified
) >= MODIFF
14329 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14332 /* If first window line is a continuation line, and window start
14333 is inside the modified region, but the first change is before
14334 current window start, we must select a new window start.
14336 However, if this is the result of a down-mouse event (e.g. by
14337 extending the mouse-drag-overlay), we don't want to select a
14338 new window start, since that would change the position under
14339 the mouse, resulting in an unwanted mouse-movement rather
14340 than a simple mouse-click. */
14341 if (NILP (w
->start_at_line_beg
)
14342 && NILP (do_mouse_tracking
)
14343 && CHARPOS (startp
) > BEGV
14344 && CHARPOS (startp
) > BEG
+ beg_unchanged
14345 && CHARPOS (startp
) <= Z
- end_unchanged
14346 /* Even if w->start_at_line_beg is nil, a new window may
14347 start at a line_beg, since that's how set_buffer_window
14348 sets it. So, we need to check the return value of
14349 compute_window_start_on_continuation_line. (See also
14351 && XMARKER (w
->start
)->buffer
== current_buffer
14352 && compute_window_start_on_continuation_line (w
))
14354 w
->force_start
= Qt
;
14355 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14360 debug_method_add (w
, "same window start");
14363 /* Try to redisplay starting at same place as before.
14364 If point has not moved off frame, accept the results. */
14365 if (!current_matrix_up_to_date_p
14366 /* Don't use try_window_reusing_current_matrix in this case
14367 because a window scroll function can have changed the
14369 || !NILP (Vwindow_scroll_functions
)
14370 || MINI_WINDOW_P (w
)
14371 || !(used_current_matrix_p
14372 = try_window_reusing_current_matrix (w
)))
14374 IF_DEBUG (debug_method_add (w
, "1"));
14375 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14376 /* -1 means we need to scroll.
14377 0 means we need new matrices, but fonts_changed_p
14378 is set in that case, so we will detect it below. */
14379 goto try_to_scroll
;
14382 if (fonts_changed_p
)
14383 goto need_larger_matrices
;
14385 if (w
->cursor
.vpos
>= 0)
14387 if (!just_this_one_p
14388 || current_buffer
->clip_changed
14389 || BEG_UNCHANGED
< CHARPOS (startp
))
14390 /* Forget any recorded base line for line number display. */
14391 w
->base_line_number
= Qnil
;
14393 if (!cursor_row_fully_visible_p (w
, 1, 0))
14395 clear_glyph_matrix (w
->desired_matrix
);
14396 last_line_misfit
= 1;
14398 /* Drop through and scroll. */
14403 clear_glyph_matrix (w
->desired_matrix
);
14408 w
->last_modified
= make_number (0);
14409 w
->last_overlay_modified
= make_number (0);
14411 /* Redisplay the mode line. Select the buffer properly for that. */
14412 if (!update_mode_line
)
14414 update_mode_line
= 1;
14415 w
->update_mode_line
= Qt
;
14418 /* Try to scroll by specified few lines. */
14419 if ((scroll_conservatively
14421 || temp_scroll_step
14422 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14423 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14424 && !current_buffer
->clip_changed
14425 && CHARPOS (startp
) >= BEGV
14426 && CHARPOS (startp
) <= ZV
)
14428 /* The function returns -1 if new fonts were loaded, 1 if
14429 successful, 0 if not successful. */
14430 int rc
= try_scrolling (window
, just_this_one_p
,
14431 scroll_conservatively
,
14433 temp_scroll_step
, last_line_misfit
);
14436 case SCROLLING_SUCCESS
:
14439 case SCROLLING_NEED_LARGER_MATRICES
:
14440 goto need_larger_matrices
;
14442 case SCROLLING_FAILED
:
14450 /* Finally, just choose place to start which centers point */
14453 if (centering_position
< 0)
14454 centering_position
= window_box_height (w
) / 2;
14457 debug_method_add (w
, "recenter");
14460 /* w->vscroll = 0; */
14462 /* Forget any previously recorded base line for line number display. */
14463 if (!buffer_unchanged_p
)
14464 w
->base_line_number
= Qnil
;
14466 /* Move backward half the height of the window. */
14467 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14468 it
.current_y
= it
.last_visible_y
;
14469 move_it_vertically_backward (&it
, centering_position
);
14470 xassert (IT_CHARPOS (it
) >= BEGV
);
14472 /* The function move_it_vertically_backward may move over more
14473 than the specified y-distance. If it->w is small, e.g. a
14474 mini-buffer window, we may end up in front of the window's
14475 display area. Start displaying at the start of the line
14476 containing PT in this case. */
14477 if (it
.current_y
<= 0)
14479 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14480 move_it_vertically_backward (&it
, 0);
14484 it
.current_x
= it
.hpos
= 0;
14486 /* Set startp here explicitly in case that helps avoid an infinite loop
14487 in case the window-scroll-functions functions get errors. */
14488 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14490 /* Run scroll hooks. */
14491 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14493 /* Redisplay the window. */
14494 if (!current_matrix_up_to_date_p
14495 || windows_or_buffers_changed
14496 || cursor_type_changed
14497 /* Don't use try_window_reusing_current_matrix in this case
14498 because it can have changed the buffer. */
14499 || !NILP (Vwindow_scroll_functions
)
14500 || !just_this_one_p
14501 || MINI_WINDOW_P (w
)
14502 || !(used_current_matrix_p
14503 = try_window_reusing_current_matrix (w
)))
14504 try_window (window
, startp
, 0);
14506 /* If new fonts have been loaded (due to fontsets), give up. We
14507 have to start a new redisplay since we need to re-adjust glyph
14509 if (fonts_changed_p
)
14510 goto need_larger_matrices
;
14512 /* If cursor did not appear assume that the middle of the window is
14513 in the first line of the window. Do it again with the next line.
14514 (Imagine a window of height 100, displaying two lines of height
14515 60. Moving back 50 from it->last_visible_y will end in the first
14517 if (w
->cursor
.vpos
< 0)
14519 if (!NILP (w
->window_end_valid
)
14520 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14522 clear_glyph_matrix (w
->desired_matrix
);
14523 move_it_by_lines (&it
, 1, 0);
14524 try_window (window
, it
.current
.pos
, 0);
14526 else if (PT
< IT_CHARPOS (it
))
14528 clear_glyph_matrix (w
->desired_matrix
);
14529 move_it_by_lines (&it
, -1, 0);
14530 try_window (window
, it
.current
.pos
, 0);
14534 /* Not much we can do about it. */
14538 /* Consider the following case: Window starts at BEGV, there is
14539 invisible, intangible text at BEGV, so that display starts at
14540 some point START > BEGV. It can happen that we are called with
14541 PT somewhere between BEGV and START. Try to handle that case. */
14542 if (w
->cursor
.vpos
< 0)
14544 struct glyph_row
*row
= w
->current_matrix
->rows
;
14545 if (row
->mode_line_p
)
14547 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14550 if (!cursor_row_fully_visible_p (w
, 0, 0))
14552 /* If vscroll is enabled, disable it and try again. */
14556 clear_glyph_matrix (w
->desired_matrix
);
14560 /* If centering point failed to make the whole line visible,
14561 put point at the top instead. That has to make the whole line
14562 visible, if it can be done. */
14563 if (centering_position
== 0)
14566 clear_glyph_matrix (w
->desired_matrix
);
14567 centering_position
= 0;
14573 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14574 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14575 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14578 /* Display the mode line, if we must. */
14579 if ((update_mode_line
14580 /* If window not full width, must redo its mode line
14581 if (a) the window to its side is being redone and
14582 (b) we do a frame-based redisplay. This is a consequence
14583 of how inverted lines are drawn in frame-based redisplay. */
14584 || (!just_this_one_p
14585 && !FRAME_WINDOW_P (f
)
14586 && !WINDOW_FULL_WIDTH_P (w
))
14587 /* Line number to display. */
14588 || INTEGERP (w
->base_line_pos
)
14589 /* Column number is displayed and different from the one displayed. */
14590 || (!NILP (w
->column_number_displayed
)
14591 && (XFASTINT (w
->column_number_displayed
)
14592 != (int) current_column ()))) /* iftc */
14593 /* This means that the window has a mode line. */
14594 && (WINDOW_WANTS_MODELINE_P (w
)
14595 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14597 display_mode_lines (w
);
14599 /* If mode line height has changed, arrange for a thorough
14600 immediate redisplay using the correct mode line height. */
14601 if (WINDOW_WANTS_MODELINE_P (w
)
14602 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14604 fonts_changed_p
= 1;
14605 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14606 = DESIRED_MODE_LINE_HEIGHT (w
);
14609 /* If header line height has changed, arrange for a thorough
14610 immediate redisplay using the correct header line height. */
14611 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14612 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14614 fonts_changed_p
= 1;
14615 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14616 = DESIRED_HEADER_LINE_HEIGHT (w
);
14619 if (fonts_changed_p
)
14620 goto need_larger_matrices
;
14623 if (!line_number_displayed
14624 && !BUFFERP (w
->base_line_pos
))
14626 w
->base_line_pos
= Qnil
;
14627 w
->base_line_number
= Qnil
;
14632 /* When we reach a frame's selected window, redo the frame's menu bar. */
14633 if (update_mode_line
14634 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14636 int redisplay_menu_p
= 0;
14637 int redisplay_tool_bar_p
= 0;
14639 if (FRAME_WINDOW_P (f
))
14641 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14642 || defined (HAVE_NS) || defined (USE_GTK)
14643 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14645 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14649 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14651 if (redisplay_menu_p
)
14652 display_menu_bar (w
);
14654 #ifdef HAVE_WINDOW_SYSTEM
14655 if (FRAME_WINDOW_P (f
))
14657 #if defined (USE_GTK) || defined (HAVE_NS)
14658 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14660 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14661 && (FRAME_TOOL_BAR_LINES (f
) > 0
14662 || !NILP (Vauto_resize_tool_bars
));
14665 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14667 extern int ignore_mouse_drag_p
;
14668 ignore_mouse_drag_p
= 1;
14674 #ifdef HAVE_WINDOW_SYSTEM
14675 if (FRAME_WINDOW_P (f
)
14676 && update_window_fringes (w
, (just_this_one_p
14677 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14678 || w
->pseudo_window_p
)))
14682 if (draw_window_fringes (w
, 1))
14683 x_draw_vertical_border (w
);
14687 #endif /* HAVE_WINDOW_SYSTEM */
14689 /* We go to this label, with fonts_changed_p nonzero,
14690 if it is necessary to try again using larger glyph matrices.
14691 We have to redeem the scroll bar even in this case,
14692 because the loop in redisplay_internal expects that. */
14693 need_larger_matrices
:
14695 finish_scroll_bars
:
14697 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14699 /* Set the thumb's position and size. */
14700 set_vertical_scroll_bar (w
);
14702 /* Note that we actually used the scroll bar attached to this
14703 window, so it shouldn't be deleted at the end of redisplay. */
14704 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14705 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14708 /* Restore current_buffer and value of point in it. */
14709 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14710 set_buffer_internal_1 (old
);
14711 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14712 shorter. This can be caused by log truncation in *Messages*. */
14713 if (CHARPOS (lpoint
) <= ZV
)
14714 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14716 unbind_to (count
, Qnil
);
14720 /* Build the complete desired matrix of WINDOW with a window start
14721 buffer position POS.
14723 Value is 1 if successful. It is zero if fonts were loaded during
14724 redisplay which makes re-adjusting glyph matrices necessary, and -1
14725 if point would appear in the scroll margins.
14726 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14727 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14731 try_window (window
, pos
, flags
)
14732 Lisp_Object window
;
14733 struct text_pos pos
;
14736 struct window
*w
= XWINDOW (window
);
14738 struct glyph_row
*last_text_row
= NULL
;
14739 struct frame
*f
= XFRAME (w
->frame
);
14741 /* Make POS the new window start. */
14742 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14744 /* Mark cursor position as unknown. No overlay arrow seen. */
14745 w
->cursor
.vpos
= -1;
14746 overlay_arrow_seen
= 0;
14748 /* Initialize iterator and info to start at POS. */
14749 start_display (&it
, w
, pos
);
14751 /* Display all lines of W. */
14752 while (it
.current_y
< it
.last_visible_y
)
14754 if (display_line (&it
))
14755 last_text_row
= it
.glyph_row
- 1;
14756 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14760 /* Don't let the cursor end in the scroll margins. */
14761 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14762 && !MINI_WINDOW_P (w
))
14764 int this_scroll_margin
;
14766 if (scroll_margin
> 0)
14768 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14769 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14772 this_scroll_margin
= 0;
14774 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14775 && w
->cursor
.y
< this_scroll_margin
14776 && CHARPOS (pos
) > BEGV
14777 && IT_CHARPOS (it
) < ZV
)
14778 /* rms: considering make_cursor_line_fully_visible_p here
14779 seems to give wrong results. We don't want to recenter
14780 when the last line is partly visible, we want to allow
14781 that case to be handled in the usual way. */
14782 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14784 w
->cursor
.vpos
= -1;
14785 clear_glyph_matrix (w
->desired_matrix
);
14790 /* If bottom moved off end of frame, change mode line percentage. */
14791 if (XFASTINT (w
->window_end_pos
) <= 0
14792 && Z
!= IT_CHARPOS (it
))
14793 w
->update_mode_line
= Qt
;
14795 /* Set window_end_pos to the offset of the last character displayed
14796 on the window from the end of current_buffer. Set
14797 window_end_vpos to its row number. */
14800 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14801 w
->window_end_bytepos
14802 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14804 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14806 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14807 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14808 ->displays_text_p
);
14812 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14813 w
->window_end_pos
= make_number (Z
- ZV
);
14814 w
->window_end_vpos
= make_number (0);
14817 /* But that is not valid info until redisplay finishes. */
14818 w
->window_end_valid
= Qnil
;
14824 /************************************************************************
14825 Window redisplay reusing current matrix when buffer has not changed
14826 ************************************************************************/
14828 /* Try redisplay of window W showing an unchanged buffer with a
14829 different window start than the last time it was displayed by
14830 reusing its current matrix. Value is non-zero if successful.
14831 W->start is the new window start. */
14834 try_window_reusing_current_matrix (w
)
14837 struct frame
*f
= XFRAME (w
->frame
);
14838 struct glyph_row
*row
, *bottom_row
;
14841 struct text_pos start
, new_start
;
14842 int nrows_scrolled
, i
;
14843 struct glyph_row
*last_text_row
;
14844 struct glyph_row
*last_reused_text_row
;
14845 struct glyph_row
*start_row
;
14846 int start_vpos
, min_y
, max_y
;
14849 if (inhibit_try_window_reusing
)
14853 if (/* This function doesn't handle terminal frames. */
14854 !FRAME_WINDOW_P (f
)
14855 /* Don't try to reuse the display if windows have been split
14857 || windows_or_buffers_changed
14858 || cursor_type_changed
)
14861 /* Can't do this if region may have changed. */
14862 if ((!NILP (Vtransient_mark_mode
)
14863 && !NILP (current_buffer
->mark_active
))
14864 || !NILP (w
->region_showing
)
14865 || !NILP (Vshow_trailing_whitespace
))
14868 /* If top-line visibility has changed, give up. */
14869 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14870 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14873 /* Give up if old or new display is scrolled vertically. We could
14874 make this function handle this, but right now it doesn't. */
14875 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14876 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14879 /* The variable new_start now holds the new window start. The old
14880 start `start' can be determined from the current matrix. */
14881 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14882 start
= start_row
->start
.pos
;
14883 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14885 /* Clear the desired matrix for the display below. */
14886 clear_glyph_matrix (w
->desired_matrix
);
14888 if (CHARPOS (new_start
) <= CHARPOS (start
))
14892 /* Don't use this method if the display starts with an ellipsis
14893 displayed for invisible text. It's not easy to handle that case
14894 below, and it's certainly not worth the effort since this is
14895 not a frequent case. */
14896 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14899 IF_DEBUG (debug_method_add (w
, "twu1"));
14901 /* Display up to a row that can be reused. The variable
14902 last_text_row is set to the last row displayed that displays
14903 text. Note that it.vpos == 0 if or if not there is a
14904 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14905 start_display (&it
, w
, new_start
);
14906 first_row_y
= it
.current_y
;
14907 w
->cursor
.vpos
= -1;
14908 last_text_row
= last_reused_text_row
= NULL
;
14910 while (it
.current_y
< it
.last_visible_y
14911 && !fonts_changed_p
)
14913 /* If we have reached into the characters in the START row,
14914 that means the line boundaries have changed. So we
14915 can't start copying with the row START. Maybe it will
14916 work to start copying with the following row. */
14917 while (IT_CHARPOS (it
) > CHARPOS (start
))
14919 /* Advance to the next row as the "start". */
14921 start
= start_row
->start
.pos
;
14922 /* If there are no more rows to try, or just one, give up. */
14923 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14924 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14925 || CHARPOS (start
) == ZV
)
14927 clear_glyph_matrix (w
->desired_matrix
);
14931 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14933 /* If we have reached alignment,
14934 we can copy the rest of the rows. */
14935 if (IT_CHARPOS (it
) == CHARPOS (start
))
14938 if (display_line (&it
))
14939 last_text_row
= it
.glyph_row
- 1;
14942 /* A value of current_y < last_visible_y means that we stopped
14943 at the previous window start, which in turn means that we
14944 have at least one reusable row. */
14945 if (it
.current_y
< it
.last_visible_y
)
14947 /* IT.vpos always starts from 0; it counts text lines. */
14948 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14950 /* Find PT if not already found in the lines displayed. */
14951 if (w
->cursor
.vpos
< 0)
14953 int dy
= it
.current_y
- start_row
->y
;
14955 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14956 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14958 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14959 dy
, nrows_scrolled
);
14962 clear_glyph_matrix (w
->desired_matrix
);
14967 /* Scroll the display. Do it before the current matrix is
14968 changed. The problem here is that update has not yet
14969 run, i.e. part of the current matrix is not up to date.
14970 scroll_run_hook will clear the cursor, and use the
14971 current matrix to get the height of the row the cursor is
14973 run
.current_y
= start_row
->y
;
14974 run
.desired_y
= it
.current_y
;
14975 run
.height
= it
.last_visible_y
- it
.current_y
;
14977 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14980 FRAME_RIF (f
)->update_window_begin_hook (w
);
14981 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14982 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14983 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14987 /* Shift current matrix down by nrows_scrolled lines. */
14988 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14989 rotate_matrix (w
->current_matrix
,
14991 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14994 /* Disable lines that must be updated. */
14995 for (i
= 0; i
< nrows_scrolled
; ++i
)
14996 (start_row
+ i
)->enabled_p
= 0;
14998 /* Re-compute Y positions. */
14999 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15000 max_y
= it
.last_visible_y
;
15001 for (row
= start_row
+ nrows_scrolled
;
15005 row
->y
= it
.current_y
;
15006 row
->visible_height
= row
->height
;
15008 if (row
->y
< min_y
)
15009 row
->visible_height
-= min_y
- row
->y
;
15010 if (row
->y
+ row
->height
> max_y
)
15011 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15012 row
->redraw_fringe_bitmaps_p
= 1;
15014 it
.current_y
+= row
->height
;
15016 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15017 last_reused_text_row
= row
;
15018 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15022 /* Disable lines in the current matrix which are now
15023 below the window. */
15024 for (++row
; row
< bottom_row
; ++row
)
15025 row
->enabled_p
= row
->mode_line_p
= 0;
15028 /* Update window_end_pos etc.; last_reused_text_row is the last
15029 reused row from the current matrix containing text, if any.
15030 The value of last_text_row is the last displayed line
15031 containing text. */
15032 if (last_reused_text_row
)
15034 w
->window_end_bytepos
15035 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15037 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15039 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15040 w
->current_matrix
));
15042 else if (last_text_row
)
15044 w
->window_end_bytepos
15045 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15047 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15049 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15053 /* This window must be completely empty. */
15054 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15055 w
->window_end_pos
= make_number (Z
- ZV
);
15056 w
->window_end_vpos
= make_number (0);
15058 w
->window_end_valid
= Qnil
;
15060 /* Update hint: don't try scrolling again in update_window. */
15061 w
->desired_matrix
->no_scrolling_p
= 1;
15064 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15068 else if (CHARPOS (new_start
) > CHARPOS (start
))
15070 struct glyph_row
*pt_row
, *row
;
15071 struct glyph_row
*first_reusable_row
;
15072 struct glyph_row
*first_row_to_display
;
15074 int yb
= window_text_bottom_y (w
);
15076 /* Find the row starting at new_start, if there is one. Don't
15077 reuse a partially visible line at the end. */
15078 first_reusable_row
= start_row
;
15079 while (first_reusable_row
->enabled_p
15080 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15081 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15082 < CHARPOS (new_start
)))
15083 ++first_reusable_row
;
15085 /* Give up if there is no row to reuse. */
15086 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15087 || !first_reusable_row
->enabled_p
15088 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15089 != CHARPOS (new_start
)))
15092 /* We can reuse fully visible rows beginning with
15093 first_reusable_row to the end of the window. Set
15094 first_row_to_display to the first row that cannot be reused.
15095 Set pt_row to the row containing point, if there is any. */
15097 for (first_row_to_display
= first_reusable_row
;
15098 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15099 ++first_row_to_display
)
15101 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15102 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15103 pt_row
= first_row_to_display
;
15106 /* Start displaying at the start of first_row_to_display. */
15107 xassert (first_row_to_display
->y
< yb
);
15108 init_to_row_start (&it
, w
, first_row_to_display
);
15110 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15112 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15114 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15115 + WINDOW_HEADER_LINE_HEIGHT (w
));
15117 /* Display lines beginning with first_row_to_display in the
15118 desired matrix. Set last_text_row to the last row displayed
15119 that displays text. */
15120 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15121 if (pt_row
== NULL
)
15122 w
->cursor
.vpos
= -1;
15123 last_text_row
= NULL
;
15124 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15125 if (display_line (&it
))
15126 last_text_row
= it
.glyph_row
- 1;
15128 /* If point is in a reused row, adjust y and vpos of the cursor
15132 w
->cursor
.vpos
-= nrows_scrolled
;
15133 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15136 /* Give up if point isn't in a row displayed or reused. (This
15137 also handles the case where w->cursor.vpos < nrows_scrolled
15138 after the calls to display_line, which can happen with scroll
15139 margins. See bug#1295.) */
15140 if (w
->cursor
.vpos
< 0)
15142 clear_glyph_matrix (w
->desired_matrix
);
15146 /* Scroll the display. */
15147 run
.current_y
= first_reusable_row
->y
;
15148 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15149 run
.height
= it
.last_visible_y
- run
.current_y
;
15150 dy
= run
.current_y
- run
.desired_y
;
15155 FRAME_RIF (f
)->update_window_begin_hook (w
);
15156 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15157 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15158 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15162 /* Adjust Y positions of reused rows. */
15163 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15164 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15165 max_y
= it
.last_visible_y
;
15166 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15169 row
->visible_height
= row
->height
;
15170 if (row
->y
< min_y
)
15171 row
->visible_height
-= min_y
- row
->y
;
15172 if (row
->y
+ row
->height
> max_y
)
15173 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15174 row
->redraw_fringe_bitmaps_p
= 1;
15177 /* Scroll the current matrix. */
15178 xassert (nrows_scrolled
> 0);
15179 rotate_matrix (w
->current_matrix
,
15181 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15184 /* Disable rows not reused. */
15185 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15186 row
->enabled_p
= 0;
15188 /* Point may have moved to a different line, so we cannot assume that
15189 the previous cursor position is valid; locate the correct row. */
15192 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15193 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15197 w
->cursor
.y
= row
->y
;
15199 if (row
< bottom_row
)
15201 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15202 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15203 struct glyph
*orig_glyph
= glyph
;
15204 struct cursor_pos orig_cursor
= w
->cursor
;
15207 && (!BUFFERP (glyph
->object
)
15208 || glyph
->charpos
!= PT
);
15212 w
->cursor
.x
+= glyph
->pixel_width
;
15214 /* With bidi reordering, charpos changes non-linearly
15215 with hpos, so the right glyph could be to the
15217 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15218 && (!BUFFERP (glyph
->object
) || glyph
->charpos
!= PT
))
15220 struct glyph
*start_glyph
= row
->glyphs
[TEXT_AREA
];
15222 glyph
= orig_glyph
- 1;
15223 orig_cursor
.hpos
--;
15224 orig_cursor
.x
-= glyph
->pixel_width
;
15225 for (; glyph
>= start_glyph
15226 && (!BUFFERP (glyph
->object
)
15227 || glyph
->charpos
!= PT
);
15231 w
->cursor
.x
-= glyph
->pixel_width
;
15233 if (BUFFERP (glyph
->object
) && glyph
->charpos
== PT
)
15234 w
->cursor
= orig_cursor
;
15239 /* Adjust window end. A null value of last_text_row means that
15240 the window end is in reused rows which in turn means that
15241 only its vpos can have changed. */
15244 w
->window_end_bytepos
15245 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15247 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15249 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15254 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15257 w
->window_end_valid
= Qnil
;
15258 w
->desired_matrix
->no_scrolling_p
= 1;
15261 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15271 /************************************************************************
15272 Window redisplay reusing current matrix when buffer has changed
15273 ************************************************************************/
15275 static struct glyph_row
*find_last_unchanged_at_beg_row
P_ ((struct window
*));
15276 static struct glyph_row
*find_first_unchanged_at_end_row
P_ ((struct window
*,
15278 static struct glyph_row
*
15279 find_last_row_displaying_text
P_ ((struct glyph_matrix
*, struct it
*,
15280 struct glyph_row
*));
15283 /* Return the last row in MATRIX displaying text. If row START is
15284 non-null, start searching with that row. IT gives the dimensions
15285 of the display. Value is null if matrix is empty; otherwise it is
15286 a pointer to the row found. */
15288 static struct glyph_row
*
15289 find_last_row_displaying_text (matrix
, it
, start
)
15290 struct glyph_matrix
*matrix
;
15292 struct glyph_row
*start
;
15294 struct glyph_row
*row
, *row_found
;
15296 /* Set row_found to the last row in IT->w's current matrix
15297 displaying text. The loop looks funny but think of partially
15300 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15301 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15303 xassert (row
->enabled_p
);
15305 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15314 /* Return the last row in the current matrix of W that is not affected
15315 by changes at the start of current_buffer that occurred since W's
15316 current matrix was built. Value is null if no such row exists.
15318 BEG_UNCHANGED us the number of characters unchanged at the start of
15319 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15320 first changed character in current_buffer. Characters at positions <
15321 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15322 when the current matrix was built. */
15324 static struct glyph_row
*
15325 find_last_unchanged_at_beg_row (w
)
15328 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15329 struct glyph_row
*row
;
15330 struct glyph_row
*row_found
= NULL
;
15331 int yb
= window_text_bottom_y (w
);
15333 /* Find the last row displaying unchanged text. */
15334 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15335 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15336 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15339 if (/* If row ends before first_changed_pos, it is unchanged,
15340 except in some case. */
15341 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15342 /* When row ends in ZV and we write at ZV it is not
15344 && !row
->ends_at_zv_p
15345 /* When first_changed_pos is the end of a continued line,
15346 row is not unchanged because it may be no longer
15348 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15349 && (row
->continued_p
15350 || row
->exact_window_width_line_p
)))
15353 /* Stop if last visible row. */
15354 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15362 /* Find the first glyph row in the current matrix of W that is not
15363 affected by changes at the end of current_buffer since the
15364 time W's current matrix was built.
15366 Return in *DELTA the number of chars by which buffer positions in
15367 unchanged text at the end of current_buffer must be adjusted.
15369 Return in *DELTA_BYTES the corresponding number of bytes.
15371 Value is null if no such row exists, i.e. all rows are affected by
15374 static struct glyph_row
*
15375 find_first_unchanged_at_end_row (w
, delta
, delta_bytes
)
15377 int *delta
, *delta_bytes
;
15379 struct glyph_row
*row
;
15380 struct glyph_row
*row_found
= NULL
;
15382 *delta
= *delta_bytes
= 0;
15384 /* Display must not have been paused, otherwise the current matrix
15385 is not up to date. */
15386 eassert (!NILP (w
->window_end_valid
));
15388 /* A value of window_end_pos >= END_UNCHANGED means that the window
15389 end is in the range of changed text. If so, there is no
15390 unchanged row at the end of W's current matrix. */
15391 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15394 /* Set row to the last row in W's current matrix displaying text. */
15395 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15397 /* If matrix is entirely empty, no unchanged row exists. */
15398 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15400 /* The value of row is the last glyph row in the matrix having a
15401 meaningful buffer position in it. The end position of row
15402 corresponds to window_end_pos. This allows us to translate
15403 buffer positions in the current matrix to current buffer
15404 positions for characters not in changed text. */
15405 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15406 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15407 int last_unchanged_pos
, last_unchanged_pos_old
;
15408 struct glyph_row
*first_text_row
15409 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15411 *delta
= Z
- Z_old
;
15412 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15414 /* Set last_unchanged_pos to the buffer position of the last
15415 character in the buffer that has not been changed. Z is the
15416 index + 1 of the last character in current_buffer, i.e. by
15417 subtracting END_UNCHANGED we get the index of the last
15418 unchanged character, and we have to add BEG to get its buffer
15420 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15421 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15423 /* Search backward from ROW for a row displaying a line that
15424 starts at a minimum position >= last_unchanged_pos_old. */
15425 for (; row
> first_text_row
; --row
)
15427 /* This used to abort, but it can happen.
15428 It is ok to just stop the search instead here. KFS. */
15429 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15432 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15437 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15443 /* Make sure that glyph rows in the current matrix of window W
15444 reference the same glyph memory as corresponding rows in the
15445 frame's frame matrix. This function is called after scrolling W's
15446 current matrix on a terminal frame in try_window_id and
15447 try_window_reusing_current_matrix. */
15450 sync_frame_with_window_matrix_rows (w
)
15453 struct frame
*f
= XFRAME (w
->frame
);
15454 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15456 /* Preconditions: W must be a leaf window and full-width. Its frame
15457 must have a frame matrix. */
15458 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15459 xassert (WINDOW_FULL_WIDTH_P (w
));
15460 xassert (!FRAME_WINDOW_P (f
));
15462 /* If W is a full-width window, glyph pointers in W's current matrix
15463 have, by definition, to be the same as glyph pointers in the
15464 corresponding frame matrix. Note that frame matrices have no
15465 marginal areas (see build_frame_matrix). */
15466 window_row
= w
->current_matrix
->rows
;
15467 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15468 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15469 while (window_row
< window_row_end
)
15471 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15472 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15474 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15475 frame_row
->glyphs
[TEXT_AREA
] = start
;
15476 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15477 frame_row
->glyphs
[LAST_AREA
] = end
;
15479 /* Disable frame rows whose corresponding window rows have
15480 been disabled in try_window_id. */
15481 if (!window_row
->enabled_p
)
15482 frame_row
->enabled_p
= 0;
15484 ++window_row
, ++frame_row
;
15489 /* Find the glyph row in window W containing CHARPOS. Consider all
15490 rows between START and END (not inclusive). END null means search
15491 all rows to the end of the display area of W. Value is the row
15492 containing CHARPOS or null. */
15495 row_containing_pos (w
, charpos
, start
, end
, dy
)
15498 struct glyph_row
*start
, *end
;
15501 struct glyph_row
*row
= start
;
15502 struct glyph_row
*best_row
= NULL
;
15503 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15506 /* If we happen to start on a header-line, skip that. */
15507 if (row
->mode_line_p
)
15510 if ((end
&& row
>= end
) || !row
->enabled_p
)
15513 last_y
= window_text_bottom_y (w
) - dy
;
15517 /* Give up if we have gone too far. */
15518 if (end
&& row
>= end
)
15520 /* This formerly returned if they were equal.
15521 I think that both quantities are of a "last plus one" type;
15522 if so, when they are equal, the row is within the screen. -- rms. */
15523 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15526 /* If it is in this row, return this row. */
15527 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15528 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15529 /* The end position of a row equals the start
15530 position of the next row. If CHARPOS is there, we
15531 would rather display it in the next line, except
15532 when this line ends in ZV. */
15533 && !row
->ends_at_zv_p
15534 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15535 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15539 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15541 /* In bidi-reordered rows, there could be several rows
15542 occluding point. We need to find the one which fits
15543 CHARPOS the best. */
15544 for (g
= row
->glyphs
[TEXT_AREA
];
15545 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15548 if (!STRINGP (g
->object
))
15550 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15552 mindif
= eabs (g
->charpos
- charpos
);
15565 /* Try to redisplay window W by reusing its existing display. W's
15566 current matrix must be up to date when this function is called,
15567 i.e. window_end_valid must not be nil.
15571 1 if display has been updated
15572 0 if otherwise unsuccessful
15573 -1 if redisplay with same window start is known not to succeed
15575 The following steps are performed:
15577 1. Find the last row in the current matrix of W that is not
15578 affected by changes at the start of current_buffer. If no such row
15581 2. Find the first row in W's current matrix that is not affected by
15582 changes at the end of current_buffer. Maybe there is no such row.
15584 3. Display lines beginning with the row + 1 found in step 1 to the
15585 row found in step 2 or, if step 2 didn't find a row, to the end of
15588 4. If cursor is not known to appear on the window, give up.
15590 5. If display stopped at the row found in step 2, scroll the
15591 display and current matrix as needed.
15593 6. Maybe display some lines at the end of W, if we must. This can
15594 happen under various circumstances, like a partially visible line
15595 becoming fully visible, or because newly displayed lines are displayed
15596 in smaller font sizes.
15598 7. Update W's window end information. */
15604 struct frame
*f
= XFRAME (w
->frame
);
15605 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15606 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15607 struct glyph_row
*last_unchanged_at_beg_row
;
15608 struct glyph_row
*first_unchanged_at_end_row
;
15609 struct glyph_row
*row
;
15610 struct glyph_row
*bottom_row
;
15613 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15614 struct text_pos start_pos
;
15616 int first_unchanged_at_end_vpos
= 0;
15617 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15618 struct text_pos start
;
15619 int first_changed_charpos
, last_changed_charpos
;
15622 if (inhibit_try_window_id
)
15626 /* This is handy for debugging. */
15628 #define GIVE_UP(X) \
15630 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15634 #define GIVE_UP(X) return 0
15637 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15639 /* Don't use this for mini-windows because these can show
15640 messages and mini-buffers, and we don't handle that here. */
15641 if (MINI_WINDOW_P (w
))
15644 /* This flag is used to prevent redisplay optimizations. */
15645 if (windows_or_buffers_changed
|| cursor_type_changed
)
15648 /* Verify that narrowing has not changed.
15649 Also verify that we were not told to prevent redisplay optimizations.
15650 It would be nice to further
15651 reduce the number of cases where this prevents try_window_id. */
15652 if (current_buffer
->clip_changed
15653 || current_buffer
->prevent_redisplay_optimizations_p
)
15656 /* Window must either use window-based redisplay or be full width. */
15657 if (!FRAME_WINDOW_P (f
)
15658 && (!FRAME_LINE_INS_DEL_OK (f
)
15659 || !WINDOW_FULL_WIDTH_P (w
)))
15662 /* Give up if point is known NOT to appear in W. */
15663 if (PT
< CHARPOS (start
))
15666 /* Another way to prevent redisplay optimizations. */
15667 if (XFASTINT (w
->last_modified
) == 0)
15670 /* Verify that window is not hscrolled. */
15671 if (XFASTINT (w
->hscroll
) != 0)
15674 /* Verify that display wasn't paused. */
15675 if (NILP (w
->window_end_valid
))
15678 /* Can't use this if highlighting a region because a cursor movement
15679 will do more than just set the cursor. */
15680 if (!NILP (Vtransient_mark_mode
)
15681 && !NILP (current_buffer
->mark_active
))
15684 /* Likewise if highlighting trailing whitespace. */
15685 if (!NILP (Vshow_trailing_whitespace
))
15688 /* Likewise if showing a region. */
15689 if (!NILP (w
->region_showing
))
15692 /* Can't use this if overlay arrow position and/or string have
15694 if (overlay_arrows_changed_p ())
15697 /* When word-wrap is on, adding a space to the first word of a
15698 wrapped line can change the wrap position, altering the line
15699 above it. It might be worthwhile to handle this more
15700 intelligently, but for now just redisplay from scratch. */
15701 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15704 /* Under bidi reordering, adding or deleting a character in the
15705 beginning of a paragraph, before the first strong directional
15706 character, can change the base direction of the paragraph (unless
15707 the buffer specifies a fixed paragraph direction), which will
15708 require to redisplay the whole paragraph. It might be worthwhile
15709 to find the paragraph limits and widen the range of redisplayed
15710 lines to that, but for now just give up this optimization and
15711 redisplay from scratch. */
15712 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15713 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15716 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15717 only if buffer has really changed. The reason is that the gap is
15718 initially at Z for freshly visited files. The code below would
15719 set end_unchanged to 0 in that case. */
15720 if (MODIFF
> SAVE_MODIFF
15721 /* This seems to happen sometimes after saving a buffer. */
15722 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15724 if (GPT
- BEG
< BEG_UNCHANGED
)
15725 BEG_UNCHANGED
= GPT
- BEG
;
15726 if (Z
- GPT
< END_UNCHANGED
)
15727 END_UNCHANGED
= Z
- GPT
;
15730 /* The position of the first and last character that has been changed. */
15731 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15732 last_changed_charpos
= Z
- END_UNCHANGED
;
15734 /* If window starts after a line end, and the last change is in
15735 front of that newline, then changes don't affect the display.
15736 This case happens with stealth-fontification. Note that although
15737 the display is unchanged, glyph positions in the matrix have to
15738 be adjusted, of course. */
15739 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15740 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15741 && ((last_changed_charpos
< CHARPOS (start
)
15742 && CHARPOS (start
) == BEGV
)
15743 || (last_changed_charpos
< CHARPOS (start
) - 1
15744 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15746 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15747 struct glyph_row
*r0
;
15749 /* Compute how many chars/bytes have been added to or removed
15750 from the buffer. */
15751 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15752 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15754 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15756 /* Give up if PT is not in the window. Note that it already has
15757 been checked at the start of try_window_id that PT is not in
15758 front of the window start. */
15759 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15762 /* If window start is unchanged, we can reuse the whole matrix
15763 as is, after adjusting glyph positions. No need to compute
15764 the window end again, since its offset from Z hasn't changed. */
15765 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15766 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15767 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15768 /* PT must not be in a partially visible line. */
15769 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15770 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15772 /* Adjust positions in the glyph matrix. */
15773 if (delta
|| delta_bytes
)
15775 struct glyph_row
*r1
15776 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15777 increment_matrix_positions (w
->current_matrix
,
15778 MATRIX_ROW_VPOS (r0
, current_matrix
),
15779 MATRIX_ROW_VPOS (r1
, current_matrix
),
15780 delta
, delta_bytes
);
15783 /* Set the cursor. */
15784 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15786 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15793 /* Handle the case that changes are all below what is displayed in
15794 the window, and that PT is in the window. This shortcut cannot
15795 be taken if ZV is visible in the window, and text has been added
15796 there that is visible in the window. */
15797 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15798 /* ZV is not visible in the window, or there are no
15799 changes at ZV, actually. */
15800 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15801 || first_changed_charpos
== last_changed_charpos
))
15803 struct glyph_row
*r0
;
15805 /* Give up if PT is not in the window. Note that it already has
15806 been checked at the start of try_window_id that PT is not in
15807 front of the window start. */
15808 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15811 /* If window start is unchanged, we can reuse the whole matrix
15812 as is, without changing glyph positions since no text has
15813 been added/removed in front of the window end. */
15814 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15815 if (TEXT_POS_EQUAL_P (start
, r0
->start
.pos
)
15816 /* PT must not be in a partially visible line. */
15817 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15818 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15820 /* We have to compute the window end anew since text
15821 can have been added/removed after it. */
15823 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15824 w
->window_end_bytepos
15825 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15827 /* Set the cursor. */
15828 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15830 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15837 /* Give up if window start is in the changed area.
15839 The condition used to read
15841 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15843 but why that was tested escapes me at the moment. */
15844 if (CHARPOS (start
) >= first_changed_charpos
15845 && CHARPOS (start
) <= last_changed_charpos
)
15848 /* Check that window start agrees with the start of the first glyph
15849 row in its current matrix. Check this after we know the window
15850 start is not in changed text, otherwise positions would not be
15852 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15853 if (!TEXT_POS_EQUAL_P (start
, row
->start
.pos
))
15856 /* Give up if the window ends in strings. Overlay strings
15857 at the end are difficult to handle, so don't try. */
15858 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15859 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15862 /* Compute the position at which we have to start displaying new
15863 lines. Some of the lines at the top of the window might be
15864 reusable because they are not displaying changed text. Find the
15865 last row in W's current matrix not affected by changes at the
15866 start of current_buffer. Value is null if changes start in the
15867 first line of window. */
15868 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15869 if (last_unchanged_at_beg_row
)
15871 /* Avoid starting to display in the moddle of a character, a TAB
15872 for instance. This is easier than to set up the iterator
15873 exactly, and it's not a frequent case, so the additional
15874 effort wouldn't really pay off. */
15875 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15876 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15877 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15878 --last_unchanged_at_beg_row
;
15880 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15883 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15885 start_pos
= it
.current
.pos
;
15887 /* Start displaying new lines in the desired matrix at the same
15888 vpos we would use in the current matrix, i.e. below
15889 last_unchanged_at_beg_row. */
15890 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15892 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15893 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15895 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15899 /* There are no reusable lines at the start of the window.
15900 Start displaying in the first text line. */
15901 start_display (&it
, w
, start
);
15902 it
.vpos
= it
.first_vpos
;
15903 start_pos
= it
.current
.pos
;
15906 /* Find the first row that is not affected by changes at the end of
15907 the buffer. Value will be null if there is no unchanged row, in
15908 which case we must redisplay to the end of the window. delta
15909 will be set to the value by which buffer positions beginning with
15910 first_unchanged_at_end_row have to be adjusted due to text
15912 first_unchanged_at_end_row
15913 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15914 IF_DEBUG (debug_delta
= delta
);
15915 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15917 /* Set stop_pos to the buffer position up to which we will have to
15918 display new lines. If first_unchanged_at_end_row != NULL, this
15919 is the buffer position of the start of the line displayed in that
15920 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15921 that we don't stop at a buffer position. */
15923 if (first_unchanged_at_end_row
)
15925 xassert (last_unchanged_at_beg_row
== NULL
15926 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15928 /* If this is a continuation line, move forward to the next one
15929 that isn't. Changes in lines above affect this line.
15930 Caution: this may move first_unchanged_at_end_row to a row
15931 not displaying text. */
15932 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15933 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15934 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15935 < it
.last_visible_y
))
15936 ++first_unchanged_at_end_row
;
15938 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15939 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15940 >= it
.last_visible_y
))
15941 first_unchanged_at_end_row
= NULL
;
15944 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15946 first_unchanged_at_end_vpos
15947 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15948 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15951 else if (last_unchanged_at_beg_row
== NULL
)
15957 /* Either there is no unchanged row at the end, or the one we have
15958 now displays text. This is a necessary condition for the window
15959 end pos calculation at the end of this function. */
15960 xassert (first_unchanged_at_end_row
== NULL
15961 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15963 debug_last_unchanged_at_beg_vpos
15964 = (last_unchanged_at_beg_row
15965 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15967 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15969 #endif /* GLYPH_DEBUG != 0 */
15972 /* Display new lines. Set last_text_row to the last new line
15973 displayed which has text on it, i.e. might end up as being the
15974 line where the window_end_vpos is. */
15975 w
->cursor
.vpos
= -1;
15976 last_text_row
= NULL
;
15977 overlay_arrow_seen
= 0;
15978 while (it
.current_y
< it
.last_visible_y
15979 && !fonts_changed_p
15980 && (first_unchanged_at_end_row
== NULL
15981 || IT_CHARPOS (it
) < stop_pos
))
15983 if (display_line (&it
))
15984 last_text_row
= it
.glyph_row
- 1;
15987 if (fonts_changed_p
)
15991 /* Compute differences in buffer positions, y-positions etc. for
15992 lines reused at the bottom of the window. Compute what we can
15994 if (first_unchanged_at_end_row
15995 /* No lines reused because we displayed everything up to the
15996 bottom of the window. */
15997 && it
.current_y
< it
.last_visible_y
)
16000 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16002 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16003 run
.current_y
= first_unchanged_at_end_row
->y
;
16004 run
.desired_y
= run
.current_y
+ dy
;
16005 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16009 delta
= delta_bytes
= dvpos
= dy
16010 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16011 first_unchanged_at_end_row
= NULL
;
16013 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16016 /* Find the cursor if not already found. We have to decide whether
16017 PT will appear on this window (it sometimes doesn't, but this is
16018 not a very frequent case.) This decision has to be made before
16019 the current matrix is altered. A value of cursor.vpos < 0 means
16020 that PT is either in one of the lines beginning at
16021 first_unchanged_at_end_row or below the window. Don't care for
16022 lines that might be displayed later at the window end; as
16023 mentioned, this is not a frequent case. */
16024 if (w
->cursor
.vpos
< 0)
16026 /* Cursor in unchanged rows at the top? */
16027 if (PT
< CHARPOS (start_pos
)
16028 && last_unchanged_at_beg_row
)
16030 row
= row_containing_pos (w
, PT
,
16031 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16032 last_unchanged_at_beg_row
+ 1, 0);
16034 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16037 /* Start from first_unchanged_at_end_row looking for PT. */
16038 else if (first_unchanged_at_end_row
)
16040 row
= row_containing_pos (w
, PT
- delta
,
16041 first_unchanged_at_end_row
, NULL
, 0);
16043 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16044 delta_bytes
, dy
, dvpos
);
16047 /* Give up if cursor was not found. */
16048 if (w
->cursor
.vpos
< 0)
16050 clear_glyph_matrix (w
->desired_matrix
);
16055 /* Don't let the cursor end in the scroll margins. */
16057 int this_scroll_margin
, cursor_height
;
16059 this_scroll_margin
= max (0, scroll_margin
);
16060 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16061 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16062 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16064 if ((w
->cursor
.y
< this_scroll_margin
16065 && CHARPOS (start
) > BEGV
)
16066 /* Old redisplay didn't take scroll margin into account at the bottom,
16067 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16068 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16069 ? cursor_height
+ this_scroll_margin
16070 : 1)) > it
.last_visible_y
)
16072 w
->cursor
.vpos
= -1;
16073 clear_glyph_matrix (w
->desired_matrix
);
16078 /* Scroll the display. Do it before changing the current matrix so
16079 that xterm.c doesn't get confused about where the cursor glyph is
16081 if (dy
&& run
.height
)
16085 if (FRAME_WINDOW_P (f
))
16087 FRAME_RIF (f
)->update_window_begin_hook (w
);
16088 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16089 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16090 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16094 /* Terminal frame. In this case, dvpos gives the number of
16095 lines to scroll by; dvpos < 0 means scroll up. */
16096 int first_unchanged_at_end_vpos
16097 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16098 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
16099 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16100 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16101 + window_internal_height (w
));
16103 /* Perform the operation on the screen. */
16106 /* Scroll last_unchanged_at_beg_row to the end of the
16107 window down dvpos lines. */
16108 set_terminal_window (f
, end
);
16110 /* On dumb terminals delete dvpos lines at the end
16111 before inserting dvpos empty lines. */
16112 if (!FRAME_SCROLL_REGION_OK (f
))
16113 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16115 /* Insert dvpos empty lines in front of
16116 last_unchanged_at_beg_row. */
16117 ins_del_lines (f
, from
, dvpos
);
16119 else if (dvpos
< 0)
16121 /* Scroll up last_unchanged_at_beg_vpos to the end of
16122 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16123 set_terminal_window (f
, end
);
16125 /* Delete dvpos lines in front of
16126 last_unchanged_at_beg_vpos. ins_del_lines will set
16127 the cursor to the given vpos and emit |dvpos| delete
16129 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16131 /* On a dumb terminal insert dvpos empty lines at the
16133 if (!FRAME_SCROLL_REGION_OK (f
))
16134 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16137 set_terminal_window (f
, 0);
16143 /* Shift reused rows of the current matrix to the right position.
16144 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16146 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16147 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16150 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16151 bottom_vpos
, dvpos
);
16152 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16155 else if (dvpos
> 0)
16157 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16158 bottom_vpos
, dvpos
);
16159 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16160 first_unchanged_at_end_vpos
+ dvpos
, 0);
16163 /* For frame-based redisplay, make sure that current frame and window
16164 matrix are in sync with respect to glyph memory. */
16165 if (!FRAME_WINDOW_P (f
))
16166 sync_frame_with_window_matrix_rows (w
);
16168 /* Adjust buffer positions in reused rows. */
16169 if (delta
|| delta_bytes
)
16170 increment_matrix_positions (current_matrix
,
16171 first_unchanged_at_end_vpos
+ dvpos
,
16172 bottom_vpos
, delta
, delta_bytes
);
16174 /* Adjust Y positions. */
16176 shift_glyph_matrix (w
, current_matrix
,
16177 first_unchanged_at_end_vpos
+ dvpos
,
16180 if (first_unchanged_at_end_row
)
16182 first_unchanged_at_end_row
+= dvpos
;
16183 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16184 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16185 first_unchanged_at_end_row
= NULL
;
16188 /* If scrolling up, there may be some lines to display at the end of
16190 last_text_row_at_end
= NULL
;
16193 /* Scrolling up can leave for example a partially visible line
16194 at the end of the window to be redisplayed. */
16195 /* Set last_row to the glyph row in the current matrix where the
16196 window end line is found. It has been moved up or down in
16197 the matrix by dvpos. */
16198 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16199 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16201 /* If last_row is the window end line, it should display text. */
16202 xassert (last_row
->displays_text_p
);
16204 /* If window end line was partially visible before, begin
16205 displaying at that line. Otherwise begin displaying with the
16206 line following it. */
16207 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16209 init_to_row_start (&it
, w
, last_row
);
16210 it
.vpos
= last_vpos
;
16211 it
.current_y
= last_row
->y
;
16215 init_to_row_end (&it
, w
, last_row
);
16216 it
.vpos
= 1 + last_vpos
;
16217 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16221 /* We may start in a continuation line. If so, we have to
16222 get the right continuation_lines_width and current_x. */
16223 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16224 it
.hpos
= it
.current_x
= 0;
16226 /* Display the rest of the lines at the window end. */
16227 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16228 while (it
.current_y
< it
.last_visible_y
16229 && !fonts_changed_p
)
16231 /* Is it always sure that the display agrees with lines in
16232 the current matrix? I don't think so, so we mark rows
16233 displayed invalid in the current matrix by setting their
16234 enabled_p flag to zero. */
16235 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16236 if (display_line (&it
))
16237 last_text_row_at_end
= it
.glyph_row
- 1;
16241 /* Update window_end_pos and window_end_vpos. */
16242 if (first_unchanged_at_end_row
16243 && !last_text_row_at_end
)
16245 /* Window end line if one of the preserved rows from the current
16246 matrix. Set row to the last row displaying text in current
16247 matrix starting at first_unchanged_at_end_row, after
16249 xassert (first_unchanged_at_end_row
->displays_text_p
);
16250 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16251 first_unchanged_at_end_row
);
16252 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16254 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16255 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16257 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16258 xassert (w
->window_end_bytepos
>= 0);
16259 IF_DEBUG (debug_method_add (w
, "A"));
16261 else if (last_text_row_at_end
)
16264 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16265 w
->window_end_bytepos
16266 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16268 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16269 xassert (w
->window_end_bytepos
>= 0);
16270 IF_DEBUG (debug_method_add (w
, "B"));
16272 else if (last_text_row
)
16274 /* We have displayed either to the end of the window or at the
16275 end of the window, i.e. the last row with text is to be found
16276 in the desired matrix. */
16278 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16279 w
->window_end_bytepos
16280 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16282 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16283 xassert (w
->window_end_bytepos
>= 0);
16285 else if (first_unchanged_at_end_row
== NULL
16286 && last_text_row
== NULL
16287 && last_text_row_at_end
== NULL
)
16289 /* Displayed to end of window, but no line containing text was
16290 displayed. Lines were deleted at the end of the window. */
16291 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16292 int vpos
= XFASTINT (w
->window_end_vpos
);
16293 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16294 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16297 row
== NULL
&& vpos
>= first_vpos
;
16298 --vpos
, --current_row
, --desired_row
)
16300 if (desired_row
->enabled_p
)
16302 if (desired_row
->displays_text_p
)
16305 else if (current_row
->displays_text_p
)
16309 xassert (row
!= NULL
);
16310 w
->window_end_vpos
= make_number (vpos
+ 1);
16311 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16312 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16313 xassert (w
->window_end_bytepos
>= 0);
16314 IF_DEBUG (debug_method_add (w
, "C"));
16319 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16320 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16322 /* Record that display has not been completed. */
16323 w
->window_end_valid
= Qnil
;
16324 w
->desired_matrix
->no_scrolling_p
= 1;
16332 /***********************************************************************
16333 More debugging support
16334 ***********************************************************************/
16338 void dump_glyph_row
P_ ((struct glyph_row
*, int, int));
16339 void dump_glyph_matrix
P_ ((struct glyph_matrix
*, int));
16340 void dump_glyph
P_ ((struct glyph_row
*, struct glyph
*, int));
16343 /* Dump the contents of glyph matrix MATRIX on stderr.
16345 GLYPHS 0 means don't show glyph contents.
16346 GLYPHS 1 means show glyphs in short form
16347 GLYPHS > 1 means show glyphs in long form. */
16350 dump_glyph_matrix (matrix
, glyphs
)
16351 struct glyph_matrix
*matrix
;
16355 for (i
= 0; i
< matrix
->nrows
; ++i
)
16356 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16360 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16361 the glyph row and area where the glyph comes from. */
16364 dump_glyph (row
, glyph
, area
)
16365 struct glyph_row
*row
;
16366 struct glyph
*glyph
;
16369 if (glyph
->type
== CHAR_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
,
16383 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16387 glyph
->left_box_line_p
,
16388 glyph
->right_box_line_p
);
16390 else if (glyph
->type
== STRETCH_GLYPH
)
16393 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16394 glyph
- row
->glyphs
[TEXT_AREA
],
16397 (BUFFERP (glyph
->object
)
16399 : (STRINGP (glyph
->object
)
16402 glyph
->pixel_width
,
16406 glyph
->left_box_line_p
,
16407 glyph
->right_box_line_p
);
16409 else if (glyph
->type
== IMAGE_GLYPH
)
16412 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16413 glyph
- row
->glyphs
[TEXT_AREA
],
16416 (BUFFERP (glyph
->object
)
16418 : (STRINGP (glyph
->object
)
16421 glyph
->pixel_width
,
16425 glyph
->left_box_line_p
,
16426 glyph
->right_box_line_p
);
16428 else if (glyph
->type
== COMPOSITE_GLYPH
)
16431 " %5d %4c %6d %c %3d 0x%05x",
16432 glyph
- row
->glyphs
[TEXT_AREA
],
16435 (BUFFERP (glyph
->object
)
16437 : (STRINGP (glyph
->object
)
16440 glyph
->pixel_width
,
16442 if (glyph
->u
.cmp
.automatic
)
16445 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16446 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16448 glyph
->left_box_line_p
,
16449 glyph
->right_box_line_p
);
16454 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16455 GLYPHS 0 means don't show glyph contents.
16456 GLYPHS 1 means show glyphs in short form
16457 GLYPHS > 1 means show glyphs in long form. */
16460 dump_glyph_row (row
, vpos
, glyphs
)
16461 struct glyph_row
*row
;
16466 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16467 fprintf (stderr
, "======================================================================\n");
16469 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16470 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16472 MATRIX_ROW_START_CHARPOS (row
),
16473 MATRIX_ROW_END_CHARPOS (row
),
16474 row
->used
[TEXT_AREA
],
16475 row
->contains_overlapping_glyphs_p
,
16477 row
->truncated_on_left_p
,
16478 row
->truncated_on_right_p
,
16480 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16481 row
->displays_text_p
,
16484 row
->ends_in_middle_of_char_p
,
16485 row
->starts_in_middle_of_char_p
,
16491 row
->visible_height
,
16494 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16495 row
->end
.overlay_string_index
,
16496 row
->continuation_lines_width
);
16497 fprintf (stderr
, "%9d %5d\n",
16498 CHARPOS (row
->start
.string_pos
),
16499 CHARPOS (row
->end
.string_pos
));
16500 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16501 row
->end
.dpvec_index
);
16508 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16510 struct glyph
*glyph
= row
->glyphs
[area
];
16511 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16513 /* Glyph for a line end in text. */
16514 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16517 if (glyph
< glyph_end
)
16518 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16520 for (; glyph
< glyph_end
; ++glyph
)
16521 dump_glyph (row
, glyph
, area
);
16524 else if (glyphs
== 1)
16528 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16530 char *s
= (char *) alloca (row
->used
[area
] + 1);
16533 for (i
= 0; i
< row
->used
[area
]; ++i
)
16535 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16536 if (glyph
->type
== CHAR_GLYPH
16537 && glyph
->u
.ch
< 0x80
16538 && glyph
->u
.ch
>= ' ')
16539 s
[i
] = glyph
->u
.ch
;
16545 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16551 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16552 Sdump_glyph_matrix
, 0, 1, "p",
16553 doc
: /* Dump the current matrix of the selected window to stderr.
16554 Shows contents of glyph row structures. With non-nil
16555 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16556 glyphs in short form, otherwise show glyphs in long form. */)
16558 Lisp_Object glyphs
;
16560 struct window
*w
= XWINDOW (selected_window
);
16561 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16563 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16564 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16565 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16566 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16567 fprintf (stderr
, "=============================================\n");
16568 dump_glyph_matrix (w
->current_matrix
,
16569 NILP (glyphs
) ? 0 : XINT (glyphs
));
16574 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16575 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16578 struct frame
*f
= XFRAME (selected_frame
);
16579 dump_glyph_matrix (f
->current_matrix
, 1);
16584 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16585 doc
: /* Dump glyph row ROW to stderr.
16586 GLYPH 0 means don't dump glyphs.
16587 GLYPH 1 means dump glyphs in short form.
16588 GLYPH > 1 or omitted means dump glyphs in long form. */)
16590 Lisp_Object row
, glyphs
;
16592 struct glyph_matrix
*matrix
;
16595 CHECK_NUMBER (row
);
16596 matrix
= XWINDOW (selected_window
)->current_matrix
;
16598 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16599 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16601 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16606 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16607 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16608 GLYPH 0 means don't dump glyphs.
16609 GLYPH 1 means dump glyphs in short form.
16610 GLYPH > 1 or omitted means dump glyphs in long form. */)
16612 Lisp_Object row
, glyphs
;
16614 struct frame
*sf
= SELECTED_FRAME ();
16615 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16618 CHECK_NUMBER (row
);
16620 if (vpos
>= 0 && vpos
< m
->nrows
)
16621 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16622 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16627 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16628 doc
: /* Toggle tracing of redisplay.
16629 With ARG, turn tracing on if and only if ARG is positive. */)
16634 trace_redisplay_p
= !trace_redisplay_p
;
16637 arg
= Fprefix_numeric_value (arg
);
16638 trace_redisplay_p
= XINT (arg
) > 0;
16645 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16646 doc
: /* Like `format', but print result to stderr.
16647 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16652 Lisp_Object s
= Fformat (nargs
, args
);
16653 fprintf (stderr
, "%s", SDATA (s
));
16657 #endif /* GLYPH_DEBUG */
16661 /***********************************************************************
16662 Building Desired Matrix Rows
16663 ***********************************************************************/
16665 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16666 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16668 static struct glyph_row
*
16669 get_overlay_arrow_glyph_row (w
, overlay_arrow_string
)
16671 Lisp_Object overlay_arrow_string
;
16673 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16674 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16675 struct buffer
*old
= current_buffer
;
16676 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16677 int arrow_len
= SCHARS (overlay_arrow_string
);
16678 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16679 const unsigned char *p
;
16682 int n_glyphs_before
;
16684 set_buffer_temp (buffer
);
16685 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16686 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16687 SET_TEXT_POS (it
.position
, 0, 0);
16689 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16691 while (p
< arrow_end
)
16693 Lisp_Object face
, ilisp
;
16695 /* Get the next character. */
16697 it
.c
= string_char_and_length (p
, &it
.len
);
16699 it
.c
= *p
, it
.len
= 1;
16702 /* Get its face. */
16703 ilisp
= make_number (p
- arrow_string
);
16704 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16705 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16707 /* Compute its width, get its glyphs. */
16708 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16709 SET_TEXT_POS (it
.position
, -1, -1);
16710 PRODUCE_GLYPHS (&it
);
16712 /* If this character doesn't fit any more in the line, we have
16713 to remove some glyphs. */
16714 if (it
.current_x
> it
.last_visible_x
)
16716 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16721 set_buffer_temp (old
);
16722 return it
.glyph_row
;
16726 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16727 glyphs are only inserted for terminal frames since we can't really
16728 win with truncation glyphs when partially visible glyphs are
16729 involved. Which glyphs to insert is determined by
16730 produce_special_glyphs. */
16733 insert_left_trunc_glyphs (it
)
16736 struct it truncate_it
;
16737 struct glyph
*from
, *end
, *to
, *toend
;
16739 xassert (!FRAME_WINDOW_P (it
->f
));
16741 /* Get the truncation glyphs. */
16743 truncate_it
.current_x
= 0;
16744 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16745 truncate_it
.glyph_row
= &scratch_glyph_row
;
16746 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16747 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16748 truncate_it
.object
= make_number (0);
16749 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16751 /* Overwrite glyphs from IT with truncation glyphs. */
16752 if (!it
->glyph_row
->reversed_p
)
16754 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16755 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16756 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16757 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16762 /* There may be padding glyphs left over. Overwrite them too. */
16763 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16765 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16771 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16775 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16776 that back to front. */
16777 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16778 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16779 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16780 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16782 while (from
>= end
&& to
>= toend
)
16784 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16787 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16788 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16789 while (from
>= end
&& to
>= toend
)
16794 /* Need to free some room before prepending additional
16796 int move_by
= from
- end
+ 1;
16797 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16798 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16800 for ( ; g
>= g0
; g
--)
16802 while (from
>= end
)
16804 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16810 /* Compute the pixel height and width of IT->glyph_row.
16812 Most of the time, ascent and height of a display line will be equal
16813 to the max_ascent and max_height values of the display iterator
16814 structure. This is not the case if
16816 1. We hit ZV without displaying anything. In this case, max_ascent
16817 and max_height will be zero.
16819 2. We have some glyphs that don't contribute to the line height.
16820 (The glyph row flag contributes_to_line_height_p is for future
16821 pixmap extensions).
16823 The first case is easily covered by using default values because in
16824 these cases, the line height does not really matter, except that it
16825 must not be zero. */
16828 compute_line_metrics (it
)
16831 struct glyph_row
*row
= it
->glyph_row
;
16834 if (FRAME_WINDOW_P (it
->f
))
16836 int i
, min_y
, max_y
;
16838 /* The line may consist of one space only, that was added to
16839 place the cursor on it. If so, the row's height hasn't been
16841 if (row
->height
== 0)
16843 if (it
->max_ascent
+ it
->max_descent
== 0)
16844 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16845 row
->ascent
= it
->max_ascent
;
16846 row
->height
= it
->max_ascent
+ it
->max_descent
;
16847 row
->phys_ascent
= it
->max_phys_ascent
;
16848 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16849 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16852 /* Compute the width of this line. */
16853 row
->pixel_width
= row
->x
;
16854 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16855 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16857 xassert (row
->pixel_width
>= 0);
16858 xassert (row
->ascent
>= 0 && row
->height
> 0);
16860 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16861 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16863 /* If first line's physical ascent is larger than its logical
16864 ascent, use the physical ascent, and make the row taller.
16865 This makes accented characters fully visible. */
16866 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16867 && row
->phys_ascent
> row
->ascent
)
16869 row
->height
+= row
->phys_ascent
- row
->ascent
;
16870 row
->ascent
= row
->phys_ascent
;
16873 /* Compute how much of the line is visible. */
16874 row
->visible_height
= row
->height
;
16876 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16877 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16879 if (row
->y
< min_y
)
16880 row
->visible_height
-= min_y
- row
->y
;
16881 if (row
->y
+ row
->height
> max_y
)
16882 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16886 row
->pixel_width
= row
->used
[TEXT_AREA
];
16887 if (row
->continued_p
)
16888 row
->pixel_width
-= it
->continuation_pixel_width
;
16889 else if (row
->truncated_on_right_p
)
16890 row
->pixel_width
-= it
->truncation_pixel_width
;
16891 row
->ascent
= row
->phys_ascent
= 0;
16892 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16893 row
->extra_line_spacing
= 0;
16896 /* Compute a hash code for this row. */
16898 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16899 for (i
= 0; i
< row
->used
[area
]; ++i
)
16900 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16901 + row
->glyphs
[area
][i
].u
.val
16902 + row
->glyphs
[area
][i
].face_id
16903 + row
->glyphs
[area
][i
].padding_p
16904 + (row
->glyphs
[area
][i
].type
<< 2));
16906 it
->max_ascent
= it
->max_descent
= 0;
16907 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16911 /* Append one space to the glyph row of iterator IT if doing a
16912 window-based redisplay. The space has the same face as
16913 IT->face_id. Value is non-zero if a space was added.
16915 This function is called to make sure that there is always one glyph
16916 at the end of a glyph row that the cursor can be set on under
16917 window-systems. (If there weren't such a glyph we would not know
16918 how wide and tall a box cursor should be displayed).
16920 At the same time this space let's a nicely handle clearing to the
16921 end of the line if the row ends in italic text. */
16924 append_space_for_newline (it
, default_face_p
)
16926 int default_face_p
;
16928 if (FRAME_WINDOW_P (it
->f
))
16930 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16932 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16933 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16935 /* Save some values that must not be changed.
16936 Must save IT->c and IT->len because otherwise
16937 ITERATOR_AT_END_P wouldn't work anymore after
16938 append_space_for_newline has been called. */
16939 enum display_element_type saved_what
= it
->what
;
16940 int saved_c
= it
->c
, saved_len
= it
->len
;
16941 int saved_x
= it
->current_x
;
16942 int saved_face_id
= it
->face_id
;
16943 struct text_pos saved_pos
;
16944 Lisp_Object saved_object
;
16947 saved_object
= it
->object
;
16948 saved_pos
= it
->position
;
16950 it
->what
= IT_CHARACTER
;
16951 bzero (&it
->position
, sizeof it
->position
);
16952 it
->object
= make_number (0);
16956 if (default_face_p
)
16957 it
->face_id
= DEFAULT_FACE_ID
;
16958 else if (it
->face_before_selective_p
)
16959 it
->face_id
= it
->saved_face_id
;
16960 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16961 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16963 PRODUCE_GLYPHS (it
);
16965 it
->override_ascent
= -1;
16966 it
->constrain_row_ascent_descent_p
= 0;
16967 it
->current_x
= saved_x
;
16968 it
->object
= saved_object
;
16969 it
->position
= saved_pos
;
16970 it
->what
= saved_what
;
16971 it
->face_id
= saved_face_id
;
16972 it
->len
= saved_len
;
16982 /* Extend the face of the last glyph in the text area of IT->glyph_row
16983 to the end of the display line. Called from display_line. If the
16984 glyph row is empty, add a space glyph to it so that we know the
16985 face to draw. Set the glyph row flag fill_line_p. If the glyph
16986 row is R2L, prepend a stretch glyph to cover the empty space to the
16987 left of the leftmost glyph. */
16990 extend_face_to_end_of_line (it
)
16994 struct frame
*f
= it
->f
;
16996 /* If line is already filled, do nothing. Non window-system frames
16997 get a grace of one more ``pixel'' because their characters are
16998 1-``pixel'' wide, so they hit the equality too early. This grace
16999 is needed only for R2L rows that are not continued, to produce
17000 one extra blank where we could display the cursor. */
17001 if (it
->current_x
>= it
->last_visible_x
17002 + (!FRAME_WINDOW_P (f
)
17003 && it
->glyph_row
->reversed_p
17004 && !it
->glyph_row
->continued_p
))
17007 /* Face extension extends the background and box of IT->face_id
17008 to the end of the line. If the background equals the background
17009 of the frame, we don't have to do anything. */
17010 if (it
->face_before_selective_p
)
17011 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17013 face
= FACE_FROM_ID (f
, it
->face_id
);
17015 if (FRAME_WINDOW_P (f
)
17016 && it
->glyph_row
->displays_text_p
17017 && face
->box
== FACE_NO_BOX
17018 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17020 && !it
->glyph_row
->reversed_p
)
17023 /* Set the glyph row flag indicating that the face of the last glyph
17024 in the text area has to be drawn to the end of the text area. */
17025 it
->glyph_row
->fill_line_p
= 1;
17027 /* If current character of IT is not ASCII, make sure we have the
17028 ASCII face. This will be automatically undone the next time
17029 get_next_display_element returns a multibyte character. Note
17030 that the character will always be single byte in unibyte
17032 if (!ASCII_CHAR_P (it
->c
))
17034 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17037 if (FRAME_WINDOW_P (f
))
17039 /* If the row is empty, add a space with the current face of IT,
17040 so that we know which face to draw. */
17041 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17043 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17044 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17045 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17047 #ifdef HAVE_WINDOW_SYSTEM
17048 if (it
->glyph_row
->reversed_p
)
17050 /* Prepend a stretch glyph to the row, such that the
17051 rightmost glyph will be drawn flushed all the way to the
17052 right margin of the window. The stretch glyph that will
17053 occupy the empty space, if any, to the left of the
17055 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17056 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17057 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17059 int row_width
, stretch_ascent
, stretch_width
;
17060 struct text_pos saved_pos
;
17061 int saved_face_id
, saved_avoid_cursor
;
17063 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17064 row_width
+= g
->pixel_width
;
17065 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17066 if (stretch_width
> 0)
17069 (((it
->ascent
+ it
->descent
)
17070 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17071 saved_pos
= it
->position
;
17072 bzero (&it
->position
, sizeof it
->position
);
17073 saved_avoid_cursor
= it
->avoid_cursor_p
;
17074 it
->avoid_cursor_p
= 1;
17075 saved_face_id
= it
->face_id
;
17076 /* The last row's stretch glyph should get the default
17077 face, to avoid painting the rest of the window with
17078 the region face, if the region ends at ZV. */
17079 if (it
->glyph_row
->ends_at_zv_p
)
17080 it
->face_id
= DEFAULT_FACE_ID
;
17082 it
->face_id
= face
->id
;
17083 append_stretch_glyph (it
, make_number (0), stretch_width
,
17084 it
->ascent
+ it
->descent
, stretch_ascent
);
17085 it
->position
= saved_pos
;
17086 it
->avoid_cursor_p
= saved_avoid_cursor
;
17087 it
->face_id
= saved_face_id
;
17090 #endif /* HAVE_WINDOW_SYSTEM */
17094 /* Save some values that must not be changed. */
17095 int saved_x
= it
->current_x
;
17096 struct text_pos saved_pos
;
17097 Lisp_Object saved_object
;
17098 enum display_element_type saved_what
= it
->what
;
17099 int saved_face_id
= it
->face_id
;
17101 saved_object
= it
->object
;
17102 saved_pos
= it
->position
;
17104 it
->what
= IT_CHARACTER
;
17105 bzero (&it
->position
, sizeof it
->position
);
17106 it
->object
= make_number (0);
17109 /* The last row's blank glyphs should get the default face, to
17110 avoid painting the rest of the window with the region face,
17111 if the region ends at ZV. */
17112 if (it
->glyph_row
->ends_at_zv_p
)
17113 it
->face_id
= DEFAULT_FACE_ID
;
17115 it
->face_id
= face
->id
;
17117 PRODUCE_GLYPHS (it
);
17119 while (it
->current_x
<= it
->last_visible_x
)
17120 PRODUCE_GLYPHS (it
);
17122 /* Don't count these blanks really. It would let us insert a left
17123 truncation glyph below and make us set the cursor on them, maybe. */
17124 it
->current_x
= saved_x
;
17125 it
->object
= saved_object
;
17126 it
->position
= saved_pos
;
17127 it
->what
= saved_what
;
17128 it
->face_id
= saved_face_id
;
17133 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17134 trailing whitespace. */
17137 trailing_whitespace_p (charpos
)
17140 int bytepos
= CHAR_TO_BYTE (charpos
);
17143 while (bytepos
< ZV_BYTE
17144 && (c
= FETCH_CHAR (bytepos
),
17145 c
== ' ' || c
== '\t'))
17148 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17150 if (bytepos
!= PT_BYTE
)
17157 /* Highlight trailing whitespace, if any, in ROW. */
17160 highlight_trailing_whitespace (f
, row
)
17162 struct glyph_row
*row
;
17164 int used
= row
->used
[TEXT_AREA
];
17168 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17169 struct glyph
*glyph
= start
+ used
- 1;
17171 if (row
->reversed_p
)
17173 /* Right-to-left rows need to be processed in the opposite
17174 direction, so swap the edge pointers. */
17176 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17179 /* Skip over glyphs inserted to display the cursor at the
17180 end of a line, for extending the face of the last glyph
17181 to the end of the line on terminals, and for truncation
17182 and continuation glyphs. */
17183 if (!row
->reversed_p
)
17185 while (glyph
>= start
17186 && glyph
->type
== CHAR_GLYPH
17187 && INTEGERP (glyph
->object
))
17192 while (glyph
<= start
17193 && glyph
->type
== CHAR_GLYPH
17194 && INTEGERP (glyph
->object
))
17198 /* If last glyph is a space or stretch, and it's trailing
17199 whitespace, set the face of all trailing whitespace glyphs in
17200 IT->glyph_row to `trailing-whitespace'. */
17201 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17202 && BUFFERP (glyph
->object
)
17203 && (glyph
->type
== STRETCH_GLYPH
17204 || (glyph
->type
== CHAR_GLYPH
17205 && glyph
->u
.ch
== ' '))
17206 && trailing_whitespace_p (glyph
->charpos
))
17208 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17212 if (!row
->reversed_p
)
17214 while (glyph
>= start
17215 && BUFFERP (glyph
->object
)
17216 && (glyph
->type
== STRETCH_GLYPH
17217 || (glyph
->type
== CHAR_GLYPH
17218 && glyph
->u
.ch
== ' ')))
17219 (glyph
--)->face_id
= face_id
;
17223 while (glyph
<= start
17224 && BUFFERP (glyph
->object
)
17225 && (glyph
->type
== STRETCH_GLYPH
17226 || (glyph
->type
== CHAR_GLYPH
17227 && glyph
->u
.ch
== ' ')))
17228 (glyph
++)->face_id
= face_id
;
17235 /* Value is non-zero if glyph row ROW in window W should be
17236 used to hold the cursor. */
17239 cursor_row_p (w
, row
)
17241 struct glyph_row
*row
;
17243 int cursor_row_p
= 1;
17245 if (PT
== MATRIX_ROW_END_CHARPOS (row
))
17247 /* Suppose the row ends on a string.
17248 Unless the row is continued, that means it ends on a newline
17249 in the string. If it's anything other than a display string
17250 (e.g. a before-string from an overlay), we don't want the
17251 cursor there. (This heuristic seems to give the optimal
17252 behavior for the various types of multi-line strings.) */
17253 if (CHARPOS (row
->end
.string_pos
) >= 0)
17255 if (row
->continued_p
)
17259 /* Check for `display' property. */
17260 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17261 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17262 struct glyph
*glyph
;
17265 for (glyph
= end
; glyph
>= beg
; --glyph
)
17266 if (STRINGP (glyph
->object
))
17269 = Fget_char_property (make_number (PT
),
17273 && display_prop_string_p (prop
, glyph
->object
));
17278 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17280 /* If the row ends in middle of a real character,
17281 and the line is continued, we want the cursor here.
17282 That's because MATRIX_ROW_END_CHARPOS would equal
17283 PT if PT is before the character. */
17284 if (!row
->ends_in_ellipsis_p
)
17285 cursor_row_p
= row
->continued_p
;
17287 /* If the row ends in an ellipsis, then
17288 MATRIX_ROW_END_CHARPOS will equal point after the invisible text.
17289 We want that position to be displayed after the ellipsis. */
17292 /* If the row ends at ZV, display the cursor at the end of that
17293 row instead of at the start of the row below. */
17294 else if (row
->ends_at_zv_p
)
17300 return cursor_row_p
;
17305 /* Push the display property PROP so that it will be rendered at the
17306 current position in IT. Return 1 if PROP was successfully pushed,
17310 push_display_prop (struct it
*it
, Lisp_Object prop
)
17314 if (STRINGP (prop
))
17316 if (SCHARS (prop
) == 0)
17323 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17324 it
->current
.overlay_string_index
= -1;
17325 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17326 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17327 it
->method
= GET_FROM_STRING
;
17328 it
->stop_charpos
= 0;
17330 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17332 it
->method
= GET_FROM_STRETCH
;
17335 #ifdef HAVE_WINDOW_SYSTEM
17336 else if (IMAGEP (prop
))
17338 it
->what
= IT_IMAGE
;
17339 it
->image_id
= lookup_image (it
->f
, prop
);
17340 it
->method
= GET_FROM_IMAGE
;
17342 #endif /* HAVE_WINDOW_SYSTEM */
17345 pop_it (it
); /* bogus display property, give up */
17352 /* Return the character-property PROP at the current position in IT. */
17355 get_it_property (it
, prop
)
17359 Lisp_Object position
;
17361 if (STRINGP (it
->object
))
17362 position
= make_number (IT_STRING_CHARPOS (*it
));
17363 else if (BUFFERP (it
->object
))
17364 position
= make_number (IT_CHARPOS (*it
));
17368 return Fget_char_property (position
, prop
, it
->object
);
17371 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17374 handle_line_prefix (struct it
*it
)
17376 Lisp_Object prefix
;
17377 if (it
->continuation_lines_width
> 0)
17379 prefix
= get_it_property (it
, Qwrap_prefix
);
17381 prefix
= Vwrap_prefix
;
17385 prefix
= get_it_property (it
, Qline_prefix
);
17387 prefix
= Vline_prefix
;
17389 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17391 /* If the prefix is wider than the window, and we try to wrap
17392 it, it would acquire its own wrap prefix, and so on till the
17393 iterator stack overflows. So, don't wrap the prefix. */
17394 it
->line_wrap
= TRUNCATE
;
17395 it
->avoid_cursor_p
= 1;
17401 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17402 only for R2L lines from display_line, when it decides that too many
17403 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17406 unproduce_glyphs (it
, n
)
17410 struct glyph
*glyph
, *end
;
17412 xassert (it
->glyph_row
);
17413 xassert (it
->glyph_row
->reversed_p
);
17414 xassert (it
->area
== TEXT_AREA
);
17415 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17417 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17418 n
= it
->glyph_row
->used
[TEXT_AREA
];
17419 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17420 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17421 for ( ; glyph
< end
; glyph
++)
17422 glyph
[-n
] = *glyph
;
17425 /* Find the positions in a bidi-reordered ROW to serve as ROW->start
17427 static struct display_pos
17428 find_row_end (it
, row
)
17430 struct glyph_row
*row
;
17432 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17433 lines' rows is implemented for bidi-reordered rows. */
17434 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
17437 struct text_pos tpos
;
17438 struct display_pos row_end
= it
->current
;
17440 for (g
= row
->glyphs
[TEXT_AREA
];
17441 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17444 if (BUFFERP (g
->object
))
17446 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17447 min_pos
= g
->charpos
;
17448 if (g
->charpos
> max_pos
)
17449 max_pos
= g
->charpos
;
17452 /* Empty lines have a valid buffer position at their first
17453 glyph, but that glyph's OBJECT is zero, as if it didn't come
17454 from a buffer. If we didn't find any valid buffer positions
17455 in this row, maybe we have such an empty line. */
17456 if (max_pos
== 0 && row
->used
[TEXT_AREA
])
17458 for (g
= row
->glyphs
[TEXT_AREA
];
17459 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17462 if (INTEGERP (g
->object
))
17464 if (g
->charpos
> 0 && g
->charpos
< min_pos
)
17465 min_pos
= g
->charpos
;
17466 if (g
->charpos
> max_pos
)
17467 max_pos
= g
->charpos
;
17472 /* ROW->start is the value of min_pos, the minimal buffer position
17476 /* Avoid calling the costly CHAR_TO_BYTE if possible. */
17477 if (min_pos
!= row
->start
.pos
.charpos
)
17478 SET_TEXT_POS (row
->start
.pos
, min_pos
, CHAR_TO_BYTE (min_pos
));
17483 /* For ROW->end, we need the position that is _after_ max_pos, in
17484 the logical order, unless we are at ZV. */
17485 if (row
->ends_at_zv_p
)
17487 if (!row
->used
[TEXT_AREA
])
17488 row
->start
.pos
= row_end
.pos
;
17490 else if (row
->used
[TEXT_AREA
] && max_pos
)
17494 SET_TEXT_POS (tpos
, max_pos
, CHAR_TO_BYTE (max_pos
));
17497 reseat (it
, tpos
, 0);
17498 if (!get_next_display_element (it
))
17499 abort (); /* this row cannot be at ZV, see above */
17500 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (it
);
17501 set_iterator_to_next (it
, 1);
17502 row_end
= it
->current
;
17503 /* If the character at max_pos is not a newline and the
17504 characters at max_pos+1 is a newline, skip that newline as
17505 well. Note that this may skip some invisible text. */
17507 && get_next_display_element (it
)
17508 && ITERATOR_AT_END_OF_LINE_P (it
))
17510 set_iterator_to_next (it
, 1);
17511 /* Record the position after the newline of a continued row.
17512 We will need that to set ROW->end of the last row
17513 produced for a continued line. */
17514 if (row
->continued_p
)
17515 save_it
.eol_pos
= it
->current
.pos
;
17518 row_end
= it
->current
;
17519 save_it
.eol_pos
.charpos
= save_it
.eol_pos
.bytepos
= 0;
17522 else if (!row
->continued_p
17523 && MATRIX_ROW_CONTINUATION_LINE_P (row
)
17524 && it
->eol_pos
.charpos
> 0)
17526 /* Last row of a continued line. Use the position recorded
17527 in IT->eol_pos, to the effect that the newline belongs to
17528 this row, not to the row which displays the character
17529 with the largest buffer position before the newline. */
17530 row_end
.pos
= it
->eol_pos
;
17531 it
->eol_pos
.charpos
= it
->eol_pos
.bytepos
= 0;
17534 /* The members of ROW->end that are not taken from buffer
17535 positions are copied from IT->current. */
17536 row_end
.string_pos
= it
->current
.string_pos
;
17537 row_end
.overlay_string_index
= it
->current
.overlay_string_index
;
17538 row_end
.dpvec_index
= it
->current
.dpvec_index
;
17543 /* Construct the glyph row IT->glyph_row in the desired matrix of
17544 IT->w from text at the current position of IT. See dispextern.h
17545 for an overview of struct it. Value is non-zero if
17546 IT->glyph_row displays text, as opposed to a line displaying ZV
17553 struct glyph_row
*row
= it
->glyph_row
;
17554 Lisp_Object overlay_arrow_string
;
17556 int may_wrap
= 0, wrap_x
;
17557 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17558 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17559 int wrap_row_extra_line_spacing
;
17562 /* We always start displaying at hpos zero even if hscrolled. */
17563 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17565 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17566 >= it
->w
->desired_matrix
->nrows
)
17568 it
->w
->nrows_scale_factor
++;
17569 fonts_changed_p
= 1;
17573 /* Is IT->w showing the region? */
17574 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17576 /* Clear the result glyph row and enable it. */
17577 prepare_desired_row (row
);
17579 row
->y
= it
->current_y
;
17580 row
->start
= it
->start
;
17581 row
->continuation_lines_width
= it
->continuation_lines_width
;
17582 row
->displays_text_p
= 1;
17583 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17584 it
->starts_in_middle_of_char_p
= 0;
17586 /* Arrange the overlays nicely for our purposes. Usually, we call
17587 display_line on only one line at a time, in which case this
17588 can't really hurt too much, or we call it on lines which appear
17589 one after another in the buffer, in which case all calls to
17590 recenter_overlay_lists but the first will be pretty cheap. */
17591 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17593 /* Move over display elements that are not visible because we are
17594 hscrolled. This may stop at an x-position < IT->first_visible_x
17595 if the first glyph is partially visible or if we hit a line end. */
17596 if (it
->current_x
< it
->first_visible_x
)
17598 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17599 MOVE_TO_POS
| MOVE_TO_X
);
17603 /* We only do this when not calling `move_it_in_display_line_to'
17604 above, because move_it_in_display_line_to calls
17605 handle_line_prefix itself. */
17606 handle_line_prefix (it
);
17609 /* Get the initial row height. This is either the height of the
17610 text hscrolled, if there is any, or zero. */
17611 row
->ascent
= it
->max_ascent
;
17612 row
->height
= it
->max_ascent
+ it
->max_descent
;
17613 row
->phys_ascent
= it
->max_phys_ascent
;
17614 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17615 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17617 /* Loop generating characters. The loop is left with IT on the next
17618 character to display. */
17621 int n_glyphs_before
, hpos_before
, x_before
;
17623 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17625 /* Retrieve the next thing to display. Value is zero if end of
17627 if (!get_next_display_element (it
))
17629 /* Maybe add a space at the end of this line that is used to
17630 display the cursor there under X. Set the charpos of the
17631 first glyph of blank lines not corresponding to any text
17633 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17634 row
->exact_window_width_line_p
= 1;
17635 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17636 || row
->used
[TEXT_AREA
] == 0)
17638 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17639 row
->displays_text_p
= 0;
17641 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17642 && (!MINI_WINDOW_P (it
->w
)
17643 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17644 row
->indicate_empty_line_p
= 1;
17647 it
->continuation_lines_width
= 0;
17648 row
->ends_at_zv_p
= 1;
17649 /* A row that displays right-to-left text must always have
17650 its last face extended all the way to the end of line,
17651 even if this row ends in ZV. */
17652 if (row
->reversed_p
)
17653 extend_face_to_end_of_line (it
);
17657 /* Now, get the metrics of what we want to display. This also
17658 generates glyphs in `row' (which is IT->glyph_row). */
17659 n_glyphs_before
= row
->used
[TEXT_AREA
];
17662 /* Remember the line height so far in case the next element doesn't
17663 fit on the line. */
17664 if (it
->line_wrap
!= TRUNCATE
)
17666 ascent
= it
->max_ascent
;
17667 descent
= it
->max_descent
;
17668 phys_ascent
= it
->max_phys_ascent
;
17669 phys_descent
= it
->max_phys_descent
;
17671 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17673 if (IT_DISPLAYING_WHITESPACE (it
))
17679 wrap_row_used
= row
->used
[TEXT_AREA
];
17680 wrap_row_ascent
= row
->ascent
;
17681 wrap_row_height
= row
->height
;
17682 wrap_row_phys_ascent
= row
->phys_ascent
;
17683 wrap_row_phys_height
= row
->phys_height
;
17684 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17690 PRODUCE_GLYPHS (it
);
17692 /* If this display element was in marginal areas, continue with
17694 if (it
->area
!= TEXT_AREA
)
17696 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17697 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17698 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17699 row
->phys_height
= max (row
->phys_height
,
17700 it
->max_phys_ascent
+ it
->max_phys_descent
);
17701 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17702 it
->max_extra_line_spacing
);
17703 set_iterator_to_next (it
, 1);
17707 /* Does the display element fit on the line? If we truncate
17708 lines, we should draw past the right edge of the window. If
17709 we don't truncate, we want to stop so that we can display the
17710 continuation glyph before the right margin. If lines are
17711 continued, there are two possible strategies for characters
17712 resulting in more than 1 glyph (e.g. tabs): Display as many
17713 glyphs as possible in this line and leave the rest for the
17714 continuation line, or display the whole element in the next
17715 line. Original redisplay did the former, so we do it also. */
17716 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17717 hpos_before
= it
->hpos
;
17720 if (/* Not a newline. */
17722 /* Glyphs produced fit entirely in the line. */
17723 && it
->current_x
< it
->last_visible_x
)
17725 it
->hpos
+= nglyphs
;
17726 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17727 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17728 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17729 row
->phys_height
= max (row
->phys_height
,
17730 it
->max_phys_ascent
+ it
->max_phys_descent
);
17731 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17732 it
->max_extra_line_spacing
);
17733 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17734 row
->x
= x
- it
->first_visible_x
;
17739 struct glyph
*glyph
;
17741 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17743 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17744 new_x
= x
+ glyph
->pixel_width
;
17746 if (/* Lines are continued. */
17747 it
->line_wrap
!= TRUNCATE
17748 && (/* Glyph doesn't fit on the line. */
17749 new_x
> it
->last_visible_x
17750 /* Or it fits exactly on a window system frame. */
17751 || (new_x
== it
->last_visible_x
17752 && FRAME_WINDOW_P (it
->f
))))
17754 /* End of a continued line. */
17757 || (new_x
== it
->last_visible_x
17758 && FRAME_WINDOW_P (it
->f
)))
17760 /* Current glyph is the only one on the line or
17761 fits exactly on the line. We must continue
17762 the line because we can't draw the cursor
17763 after the glyph. */
17764 row
->continued_p
= 1;
17765 it
->current_x
= new_x
;
17766 it
->continuation_lines_width
+= new_x
;
17768 if (i
== nglyphs
- 1)
17770 /* If line-wrap is on, check if a previous
17771 wrap point was found. */
17772 if (wrap_row_used
> 0
17773 /* Even if there is a previous wrap
17774 point, continue the line here as
17775 usual, if (i) the previous character
17776 was a space or tab AND (ii) the
17777 current character is not. */
17779 || IT_DISPLAYING_WHITESPACE (it
)))
17782 set_iterator_to_next (it
, 1);
17783 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17785 if (!get_next_display_element (it
))
17787 row
->exact_window_width_line_p
= 1;
17788 it
->continuation_lines_width
= 0;
17789 row
->continued_p
= 0;
17790 row
->ends_at_zv_p
= 1;
17792 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17794 row
->continued_p
= 0;
17795 row
->exact_window_width_line_p
= 1;
17800 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17801 && !FRAME_WINDOW_P (it
->f
))
17803 /* A padding glyph that doesn't fit on this line.
17804 This means the whole character doesn't fit
17806 if (row
->reversed_p
)
17807 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17808 - n_glyphs_before
);
17809 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17811 /* Fill the rest of the row with continuation
17812 glyphs like in 20.x. */
17813 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17814 < row
->glyphs
[1 + TEXT_AREA
])
17815 produce_special_glyphs (it
, IT_CONTINUATION
);
17817 row
->continued_p
= 1;
17818 it
->current_x
= x_before
;
17819 it
->continuation_lines_width
+= x_before
;
17821 /* Restore the height to what it was before the
17822 element not fitting on the line. */
17823 it
->max_ascent
= ascent
;
17824 it
->max_descent
= descent
;
17825 it
->max_phys_ascent
= phys_ascent
;
17826 it
->max_phys_descent
= phys_descent
;
17828 else if (wrap_row_used
> 0)
17831 if (row
->reversed_p
)
17832 unproduce_glyphs (it
,
17833 row
->used
[TEXT_AREA
] - wrap_row_used
);
17835 it
->continuation_lines_width
+= wrap_x
;
17836 row
->used
[TEXT_AREA
] = wrap_row_used
;
17837 row
->ascent
= wrap_row_ascent
;
17838 row
->height
= wrap_row_height
;
17839 row
->phys_ascent
= wrap_row_phys_ascent
;
17840 row
->phys_height
= wrap_row_phys_height
;
17841 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17842 row
->continued_p
= 1;
17843 row
->ends_at_zv_p
= 0;
17844 row
->exact_window_width_line_p
= 0;
17845 it
->continuation_lines_width
+= x
;
17847 /* Make sure that a non-default face is extended
17848 up to the right margin of the window. */
17849 extend_face_to_end_of_line (it
);
17851 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17853 /* A TAB that extends past the right edge of the
17854 window. This produces a single glyph on
17855 window system frames. We leave the glyph in
17856 this row and let it fill the row, but don't
17857 consume the TAB. */
17858 it
->continuation_lines_width
+= it
->last_visible_x
;
17859 row
->ends_in_middle_of_char_p
= 1;
17860 row
->continued_p
= 1;
17861 glyph
->pixel_width
= it
->last_visible_x
- x
;
17862 it
->starts_in_middle_of_char_p
= 1;
17866 /* Something other than a TAB that draws past
17867 the right edge of the window. Restore
17868 positions to values before the element. */
17869 if (row
->reversed_p
)
17870 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17871 - (n_glyphs_before
+ i
));
17872 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17874 /* Display continuation glyphs. */
17875 if (!FRAME_WINDOW_P (it
->f
))
17876 produce_special_glyphs (it
, IT_CONTINUATION
);
17877 row
->continued_p
= 1;
17879 it
->current_x
= x_before
;
17880 it
->continuation_lines_width
+= x
;
17881 extend_face_to_end_of_line (it
);
17883 if (nglyphs
> 1 && i
> 0)
17885 row
->ends_in_middle_of_char_p
= 1;
17886 it
->starts_in_middle_of_char_p
= 1;
17889 /* Restore the height to what it was before the
17890 element not fitting on the line. */
17891 it
->max_ascent
= ascent
;
17892 it
->max_descent
= descent
;
17893 it
->max_phys_ascent
= phys_ascent
;
17894 it
->max_phys_descent
= phys_descent
;
17899 else if (new_x
> it
->first_visible_x
)
17901 /* Increment number of glyphs actually displayed. */
17904 if (x
< it
->first_visible_x
)
17905 /* Glyph is partially visible, i.e. row starts at
17906 negative X position. */
17907 row
->x
= x
- it
->first_visible_x
;
17911 /* Glyph is completely off the left margin of the
17912 window. This should not happen because of the
17913 move_it_in_display_line at the start of this
17914 function, unless the text display area of the
17915 window is empty. */
17916 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17920 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17921 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17922 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17923 row
->phys_height
= max (row
->phys_height
,
17924 it
->max_phys_ascent
+ it
->max_phys_descent
);
17925 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17926 it
->max_extra_line_spacing
);
17928 /* End of this display line if row is continued. */
17929 if (row
->continued_p
|| row
->ends_at_zv_p
)
17934 /* Is this a line end? If yes, we're also done, after making
17935 sure that a non-default face is extended up to the right
17936 margin of the window. */
17937 if (ITERATOR_AT_END_OF_LINE_P (it
))
17939 int used_before
= row
->used
[TEXT_AREA
];
17941 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17943 /* Add a space at the end of the line that is used to
17944 display the cursor there. */
17945 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17946 append_space_for_newline (it
, 0);
17948 /* Extend the face to the end of the line. */
17949 extend_face_to_end_of_line (it
);
17951 /* Make sure we have the position. */
17952 if (used_before
== 0)
17953 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17955 /* Consume the line end. This skips over invisible lines. */
17956 set_iterator_to_next (it
, 1);
17957 it
->continuation_lines_width
= 0;
17961 /* Proceed with next display element. Note that this skips
17962 over lines invisible because of selective display. */
17963 set_iterator_to_next (it
, 1);
17965 /* If we truncate lines, we are done when the last displayed
17966 glyphs reach past the right margin of the window. */
17967 if (it
->line_wrap
== TRUNCATE
17968 && (FRAME_WINDOW_P (it
->f
)
17969 ? (it
->current_x
>= it
->last_visible_x
)
17970 : (it
->current_x
> it
->last_visible_x
)))
17972 /* Maybe add truncation glyphs. */
17973 if (!FRAME_WINDOW_P (it
->f
))
17977 if (!row
->reversed_p
)
17979 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17980 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17985 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17986 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17988 /* Remove any padding glyphs at the front of ROW, to
17989 make room for the truncation glyphs we will be
17990 adding below. The loop below always inserts at
17991 least one truncation glyph, so also remove the
17992 last glyph added to ROW. */
17993 unproduce_glyphs (it
, i
+ 1);
17994 /* Adjust i for the loop below. */
17995 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17998 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18000 row
->used
[TEXT_AREA
] = i
;
18001 produce_special_glyphs (it
, IT_TRUNCATION
);
18004 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18006 /* Don't truncate if we can overflow newline into fringe. */
18007 if (!get_next_display_element (it
))
18009 it
->continuation_lines_width
= 0;
18010 row
->ends_at_zv_p
= 1;
18011 row
->exact_window_width_line_p
= 1;
18014 if (ITERATOR_AT_END_OF_LINE_P (it
))
18016 row
->exact_window_width_line_p
= 1;
18017 goto at_end_of_line
;
18021 row
->truncated_on_right_p
= 1;
18022 it
->continuation_lines_width
= 0;
18023 reseat_at_next_visible_line_start (it
, 0);
18024 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18025 it
->hpos
= hpos_before
;
18026 it
->current_x
= x_before
;
18031 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18032 at the left window margin. */
18033 if (it
->first_visible_x
18034 && IT_CHARPOS (*it
) != MATRIX_ROW_START_CHARPOS (row
))
18036 if (!FRAME_WINDOW_P (it
->f
))
18037 insert_left_trunc_glyphs (it
);
18038 row
->truncated_on_left_p
= 1;
18041 /* If the start of this line is the overlay arrow-position, then
18042 mark this glyph row as the one containing the overlay arrow.
18043 This is clearly a mess with variable size fonts. It would be
18044 better to let it be displayed like cursors under X. */
18045 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18046 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18047 !NILP (overlay_arrow_string
)))
18049 /* Overlay arrow in window redisplay is a fringe bitmap. */
18050 if (STRINGP (overlay_arrow_string
))
18052 struct glyph_row
*arrow_row
18053 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18054 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18055 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18056 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18057 struct glyph
*p2
, *end
;
18059 /* Copy the arrow glyphs. */
18060 while (glyph
< arrow_end
)
18063 /* Throw away padding glyphs. */
18065 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18066 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18072 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18077 xassert (INTEGERP (overlay_arrow_string
));
18078 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18080 overlay_arrow_seen
= 1;
18083 /* Compute pixel dimensions of this line. */
18084 compute_line_metrics (it
);
18086 /* Remember the position at which this line ends. */
18087 row
->end
= it
->current
;
18088 /* ROW->start and ROW->end must be the smallest and the largest
18089 buffer positions in ROW. But if ROW was bidi-reordered, these
18090 two positions can be anywhere in the row, so we must rescan all
18091 of the ROW's glyphs to find them. */
18093 row
->end
= find_row_end (it
, row
);
18095 /* Record whether this row ends inside an ellipsis. */
18096 row
->ends_in_ellipsis_p
18097 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18098 && it
->ellipsis_p
);
18100 /* Save fringe bitmaps in this row. */
18101 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18102 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18103 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18104 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18106 it
->left_user_fringe_bitmap
= 0;
18107 it
->left_user_fringe_face_id
= 0;
18108 it
->right_user_fringe_bitmap
= 0;
18109 it
->right_user_fringe_face_id
= 0;
18111 /* Maybe set the cursor. */
18112 cvpos
= it
->w
->cursor
.vpos
;
18114 /* In bidi-reordered rows, keep checking for proper cursor
18115 position even if one has been found already, because buffer
18116 positions in such rows change non-linearly with ROW->VPOS,
18117 when a line is continued. One exception: when we are at ZV,
18118 display cursor on the first suitable glyph row, since all
18119 the empty rows after that also have their position set to ZV. */
18120 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18121 lines' rows is implemented for bidi-reordered rows. */
18123 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18124 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18125 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18126 && cursor_row_p (it
->w
, row
))
18127 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18129 /* Highlight trailing whitespace. */
18130 if (!NILP (Vshow_trailing_whitespace
))
18131 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18133 /* Prepare for the next line. This line starts horizontally at (X
18134 HPOS) = (0 0). Vertical positions are incremented. As a
18135 convenience for the caller, IT->glyph_row is set to the next
18137 it
->current_x
= it
->hpos
= 0;
18138 it
->current_y
+= row
->height
;
18141 /* The next row should by default use the same value of the
18142 reversed_p flag as this one. set_iterator_to_next decides when
18143 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18144 the flag accordingly. */
18145 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18146 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18147 it
->start
= row
->end
;
18148 return row
->displays_text_p
;
18153 /***********************************************************************
18155 ***********************************************************************/
18157 /* Redisplay the menu bar in the frame for window W.
18159 The menu bar of X frames that don't have X toolkit support is
18160 displayed in a special window W->frame->menu_bar_window.
18162 The menu bar of terminal frames is treated specially as far as
18163 glyph matrices are concerned. Menu bar lines are not part of
18164 windows, so the update is done directly on the frame matrix rows
18165 for the menu bar. */
18168 display_menu_bar (w
)
18171 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18176 /* Don't do all this for graphical frames. */
18178 if (FRAME_W32_P (f
))
18181 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18187 if (FRAME_NS_P (f
))
18189 #endif /* HAVE_NS */
18191 #ifdef USE_X_TOOLKIT
18192 xassert (!FRAME_WINDOW_P (f
));
18193 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18194 it
.first_visible_x
= 0;
18195 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18196 #else /* not USE_X_TOOLKIT */
18197 if (FRAME_WINDOW_P (f
))
18199 /* Menu bar lines are displayed in the desired matrix of the
18200 dummy window menu_bar_window. */
18201 struct window
*menu_w
;
18202 xassert (WINDOWP (f
->menu_bar_window
));
18203 menu_w
= XWINDOW (f
->menu_bar_window
);
18204 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18206 it
.first_visible_x
= 0;
18207 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18211 /* This is a TTY frame, i.e. character hpos/vpos are used as
18213 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18215 it
.first_visible_x
= 0;
18216 it
.last_visible_x
= FRAME_COLS (f
);
18218 #endif /* not USE_X_TOOLKIT */
18220 if (! mode_line_inverse_video
)
18221 /* Force the menu-bar to be displayed in the default face. */
18222 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18224 /* Clear all rows of the menu bar. */
18225 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18227 struct glyph_row
*row
= it
.glyph_row
+ i
;
18228 clear_glyph_row (row
);
18229 row
->enabled_p
= 1;
18230 row
->full_width_p
= 1;
18233 /* Display all items of the menu bar. */
18234 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18235 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18237 Lisp_Object string
;
18239 /* Stop at nil string. */
18240 string
= AREF (items
, i
+ 1);
18244 /* Remember where item was displayed. */
18245 ASET (items
, i
+ 3, make_number (it
.hpos
));
18247 /* Display the item, pad with one space. */
18248 if (it
.current_x
< it
.last_visible_x
)
18249 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18250 SCHARS (string
) + 1, 0, 0, -1);
18253 /* Fill out the line with spaces. */
18254 if (it
.current_x
< it
.last_visible_x
)
18255 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18257 /* Compute the total height of the lines. */
18258 compute_line_metrics (&it
);
18263 /***********************************************************************
18265 ***********************************************************************/
18267 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18268 FORCE is non-zero, redisplay mode lines unconditionally.
18269 Otherwise, redisplay only mode lines that are garbaged. Value is
18270 the number of windows whose mode lines were redisplayed. */
18273 redisplay_mode_lines (window
, force
)
18274 Lisp_Object window
;
18279 while (!NILP (window
))
18281 struct window
*w
= XWINDOW (window
);
18283 if (WINDOWP (w
->hchild
))
18284 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18285 else if (WINDOWP (w
->vchild
))
18286 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18288 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18289 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18291 struct text_pos lpoint
;
18292 struct buffer
*old
= current_buffer
;
18294 /* Set the window's buffer for the mode line display. */
18295 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18296 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18298 /* Point refers normally to the selected window. For any
18299 other window, set up appropriate value. */
18300 if (!EQ (window
, selected_window
))
18302 struct text_pos pt
;
18304 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18305 if (CHARPOS (pt
) < BEGV
)
18306 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18307 else if (CHARPOS (pt
) > (ZV
- 1))
18308 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18310 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18313 /* Display mode lines. */
18314 clear_glyph_matrix (w
->desired_matrix
);
18315 if (display_mode_lines (w
))
18318 w
->must_be_updated_p
= 1;
18321 /* Restore old settings. */
18322 set_buffer_internal_1 (old
);
18323 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18333 /* Display the mode and/or header line of window W. Value is the
18334 sum number of mode lines and header lines displayed. */
18337 display_mode_lines (w
)
18340 Lisp_Object old_selected_window
, old_selected_frame
;
18343 old_selected_frame
= selected_frame
;
18344 selected_frame
= w
->frame
;
18345 old_selected_window
= selected_window
;
18346 XSETWINDOW (selected_window
, w
);
18348 /* These will be set while the mode line specs are processed. */
18349 line_number_displayed
= 0;
18350 w
->column_number_displayed
= Qnil
;
18352 if (WINDOW_WANTS_MODELINE_P (w
))
18354 struct window
*sel_w
= XWINDOW (old_selected_window
);
18356 /* Select mode line face based on the real selected window. */
18357 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18358 current_buffer
->mode_line_format
);
18362 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18364 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18365 current_buffer
->header_line_format
);
18369 selected_frame
= old_selected_frame
;
18370 selected_window
= old_selected_window
;
18375 /* Display mode or header line of window W. FACE_ID specifies which
18376 line to display; it is either MODE_LINE_FACE_ID or
18377 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18378 display. Value is the pixel height of the mode/header line
18382 display_mode_line (w
, face_id
, format
)
18384 enum face_id face_id
;
18385 Lisp_Object format
;
18389 int count
= SPECPDL_INDEX ();
18391 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18392 /* Don't extend on a previously drawn mode-line.
18393 This may happen if called from pos_visible_p. */
18394 it
.glyph_row
->enabled_p
= 0;
18395 prepare_desired_row (it
.glyph_row
);
18397 it
.glyph_row
->mode_line_p
= 1;
18399 if (! mode_line_inverse_video
)
18400 /* Force the mode-line to be displayed in the default face. */
18401 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18403 record_unwind_protect (unwind_format_mode_line
,
18404 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18406 mode_line_target
= MODE_LINE_DISPLAY
;
18408 /* Temporarily make frame's keyboard the current kboard so that
18409 kboard-local variables in the mode_line_format will get the right
18411 push_kboard (FRAME_KBOARD (it
.f
));
18412 record_unwind_save_match_data ();
18413 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18416 unbind_to (count
, Qnil
);
18418 /* Fill up with spaces. */
18419 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18421 compute_line_metrics (&it
);
18422 it
.glyph_row
->full_width_p
= 1;
18423 it
.glyph_row
->continued_p
= 0;
18424 it
.glyph_row
->truncated_on_left_p
= 0;
18425 it
.glyph_row
->truncated_on_right_p
= 0;
18427 /* Make a 3D mode-line have a shadow at its right end. */
18428 face
= FACE_FROM_ID (it
.f
, face_id
);
18429 extend_face_to_end_of_line (&it
);
18430 if (face
->box
!= FACE_NO_BOX
)
18432 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18433 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18434 last
->right_box_line_p
= 1;
18437 return it
.glyph_row
->height
;
18440 /* Move element ELT in LIST to the front of LIST.
18441 Return the updated list. */
18444 move_elt_to_front (elt
, list
)
18445 Lisp_Object elt
, list
;
18447 register Lisp_Object tail
, prev
;
18448 register Lisp_Object tem
;
18452 while (CONSP (tail
))
18458 /* Splice out the link TAIL. */
18460 list
= XCDR (tail
);
18462 Fsetcdr (prev
, XCDR (tail
));
18464 /* Now make it the first. */
18465 Fsetcdr (tail
, list
);
18470 tail
= XCDR (tail
);
18474 /* Not found--return unchanged LIST. */
18478 /* Contribute ELT to the mode line for window IT->w. How it
18479 translates into text depends on its data type.
18481 IT describes the display environment in which we display, as usual.
18483 DEPTH is the depth in recursion. It is used to prevent
18484 infinite recursion here.
18486 FIELD_WIDTH is the number of characters the display of ELT should
18487 occupy in the mode line, and PRECISION is the maximum number of
18488 characters to display from ELT's representation. See
18489 display_string for details.
18491 Returns the hpos of the end of the text generated by ELT.
18493 PROPS is a property list to add to any string we encounter.
18495 If RISKY is nonzero, remove (disregard) any properties in any string
18496 we encounter, and ignore :eval and :propertize.
18498 The global variable `mode_line_target' determines whether the
18499 output is passed to `store_mode_line_noprop',
18500 `store_mode_line_string', or `display_string'. */
18503 display_mode_element (it
, depth
, field_width
, precision
, elt
, props
, risky
)
18506 int field_width
, precision
;
18507 Lisp_Object elt
, props
;
18510 int n
= 0, field
, prec
;
18515 elt
= build_string ("*too-deep*");
18519 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18523 /* A string: output it and check for %-constructs within it. */
18527 if (SCHARS (elt
) > 0
18528 && (!NILP (props
) || risky
))
18530 Lisp_Object oprops
, aelt
;
18531 oprops
= Ftext_properties_at (make_number (0), elt
);
18533 /* If the starting string's properties are not what
18534 we want, translate the string. Also, if the string
18535 is risky, do that anyway. */
18537 if (NILP (Fequal (props
, oprops
)) || risky
)
18539 /* If the starting string has properties,
18540 merge the specified ones onto the existing ones. */
18541 if (! NILP (oprops
) && !risky
)
18545 oprops
= Fcopy_sequence (oprops
);
18547 while (CONSP (tem
))
18549 oprops
= Fplist_put (oprops
, XCAR (tem
),
18550 XCAR (XCDR (tem
)));
18551 tem
= XCDR (XCDR (tem
));
18556 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18557 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18559 /* AELT is what we want. Move it to the front
18560 without consing. */
18562 mode_line_proptrans_alist
18563 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18569 /* If AELT has the wrong props, it is useless.
18570 so get rid of it. */
18572 mode_line_proptrans_alist
18573 = Fdelq (aelt
, mode_line_proptrans_alist
);
18575 elt
= Fcopy_sequence (elt
);
18576 Fset_text_properties (make_number (0), Flength (elt
),
18578 /* Add this item to mode_line_proptrans_alist. */
18579 mode_line_proptrans_alist
18580 = Fcons (Fcons (elt
, props
),
18581 mode_line_proptrans_alist
);
18582 /* Truncate mode_line_proptrans_alist
18583 to at most 50 elements. */
18584 tem
= Fnthcdr (make_number (50),
18585 mode_line_proptrans_alist
);
18587 XSETCDR (tem
, Qnil
);
18596 prec
= precision
- n
;
18597 switch (mode_line_target
)
18599 case MODE_LINE_NOPROP
:
18600 case MODE_LINE_TITLE
:
18601 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18603 case MODE_LINE_STRING
:
18604 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18606 case MODE_LINE_DISPLAY
:
18607 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18608 0, prec
, 0, STRING_MULTIBYTE (elt
));
18615 /* Handle the non-literal case. */
18617 while ((precision
<= 0 || n
< precision
)
18618 && SREF (elt
, offset
) != 0
18619 && (mode_line_target
!= MODE_LINE_DISPLAY
18620 || it
->current_x
< it
->last_visible_x
))
18622 int last_offset
= offset
;
18624 /* Advance to end of string or next format specifier. */
18625 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18628 if (offset
- 1 != last_offset
)
18630 int nchars
, nbytes
;
18632 /* Output to end of string or up to '%'. Field width
18633 is length of string. Don't output more than
18634 PRECISION allows us. */
18637 prec
= c_string_width (SDATA (elt
) + last_offset
,
18638 offset
- last_offset
, precision
- n
,
18641 switch (mode_line_target
)
18643 case MODE_LINE_NOPROP
:
18644 case MODE_LINE_TITLE
:
18645 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18647 case MODE_LINE_STRING
:
18649 int bytepos
= last_offset
;
18650 int charpos
= string_byte_to_char (elt
, bytepos
);
18651 int endpos
= (precision
<= 0
18652 ? string_byte_to_char (elt
, offset
)
18653 : charpos
+ nchars
);
18655 n
+= store_mode_line_string (NULL
,
18656 Fsubstring (elt
, make_number (charpos
),
18657 make_number (endpos
)),
18661 case MODE_LINE_DISPLAY
:
18663 int bytepos
= last_offset
;
18664 int charpos
= string_byte_to_char (elt
, bytepos
);
18666 if (precision
<= 0)
18667 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18668 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18670 STRING_MULTIBYTE (elt
));
18675 else /* c == '%' */
18677 int percent_position
= offset
;
18679 /* Get the specified minimum width. Zero means
18682 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18683 field
= field
* 10 + c
- '0';
18685 /* Don't pad beyond the total padding allowed. */
18686 if (field_width
- n
> 0 && field
> field_width
- n
)
18687 field
= field_width
- n
;
18689 /* Note that either PRECISION <= 0 or N < PRECISION. */
18690 prec
= precision
- n
;
18693 n
+= display_mode_element (it
, depth
, field
, prec
,
18694 Vglobal_mode_string
, props
,
18699 int bytepos
, charpos
;
18700 unsigned char *spec
;
18701 Lisp_Object string
;
18703 bytepos
= percent_position
;
18704 charpos
= (STRING_MULTIBYTE (elt
)
18705 ? string_byte_to_char (elt
, bytepos
)
18707 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18708 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18710 switch (mode_line_target
)
18712 case MODE_LINE_NOPROP
:
18713 case MODE_LINE_TITLE
:
18714 n
+= store_mode_line_noprop (spec
, field
, prec
);
18716 case MODE_LINE_STRING
:
18718 int len
= strlen (spec
);
18719 Lisp_Object tem
= make_string (spec
, len
);
18720 props
= Ftext_properties_at (make_number (charpos
), elt
);
18721 /* Should only keep face property in props */
18722 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18725 case MODE_LINE_DISPLAY
:
18727 int nglyphs_before
, nwritten
;
18729 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18730 nwritten
= display_string (spec
, string
, elt
,
18735 /* Assign to the glyphs written above the
18736 string where the `%x' came from, position
18740 struct glyph
*glyph
18741 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18745 for (i
= 0; i
< nwritten
; ++i
)
18747 glyph
[i
].object
= elt
;
18748 glyph
[i
].charpos
= charpos
;
18765 /* A symbol: process the value of the symbol recursively
18766 as if it appeared here directly. Avoid error if symbol void.
18767 Special case: if value of symbol is a string, output the string
18770 register Lisp_Object tem
;
18772 /* If the variable is not marked as risky to set
18773 then its contents are risky to use. */
18774 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18777 tem
= Fboundp (elt
);
18780 tem
= Fsymbol_value (elt
);
18781 /* If value is a string, output that string literally:
18782 don't check for % within it. */
18786 if (!EQ (tem
, elt
))
18788 /* Give up right away for nil or t. */
18798 register Lisp_Object car
, tem
;
18800 /* A cons cell: five distinct cases.
18801 If first element is :eval or :propertize, do something special.
18802 If first element is a string or a cons, process all the elements
18803 and effectively concatenate them.
18804 If first element is a negative number, truncate displaying cdr to
18805 at most that many characters. If positive, pad (with spaces)
18806 to at least that many characters.
18807 If first element is a symbol, process the cadr or caddr recursively
18808 according to whether the symbol's value is non-nil or nil. */
18810 if (EQ (car
, QCeval
))
18812 /* An element of the form (:eval FORM) means evaluate FORM
18813 and use the result as mode line elements. */
18818 if (CONSP (XCDR (elt
)))
18821 spec
= safe_eval (XCAR (XCDR (elt
)));
18822 n
+= display_mode_element (it
, depth
, field_width
- n
,
18823 precision
- n
, spec
, props
,
18827 else if (EQ (car
, QCpropertize
))
18829 /* An element of the form (:propertize ELT PROPS...)
18830 means display ELT but applying properties PROPS. */
18835 if (CONSP (XCDR (elt
)))
18836 n
+= display_mode_element (it
, depth
, field_width
- n
,
18837 precision
- n
, XCAR (XCDR (elt
)),
18838 XCDR (XCDR (elt
)), risky
);
18840 else if (SYMBOLP (car
))
18842 tem
= Fboundp (car
);
18846 /* elt is now the cdr, and we know it is a cons cell.
18847 Use its car if CAR has a non-nil value. */
18850 tem
= Fsymbol_value (car
);
18857 /* Symbol's value is nil (or symbol is unbound)
18858 Get the cddr of the original list
18859 and if possible find the caddr and use that. */
18863 else if (!CONSP (elt
))
18868 else if (INTEGERP (car
))
18870 register int lim
= XINT (car
);
18874 /* Negative int means reduce maximum width. */
18875 if (precision
<= 0)
18878 precision
= min (precision
, -lim
);
18882 /* Padding specified. Don't let it be more than
18883 current maximum. */
18885 lim
= min (precision
, lim
);
18887 /* If that's more padding than already wanted, queue it.
18888 But don't reduce padding already specified even if
18889 that is beyond the current truncation point. */
18890 field_width
= max (lim
, field_width
);
18894 else if (STRINGP (car
) || CONSP (car
))
18896 Lisp_Object halftail
= elt
;
18900 && (precision
<= 0 || n
< precision
))
18902 n
+= display_mode_element (it
, depth
,
18903 /* Do padding only after the last
18904 element in the list. */
18905 (! CONSP (XCDR (elt
))
18908 precision
- n
, XCAR (elt
),
18912 if ((len
& 1) == 0)
18913 halftail
= XCDR (halftail
);
18914 /* Check for cycle. */
18915 if (EQ (halftail
, elt
))
18924 elt
= build_string ("*invalid*");
18928 /* Pad to FIELD_WIDTH. */
18929 if (field_width
> 0 && n
< field_width
)
18931 switch (mode_line_target
)
18933 case MODE_LINE_NOPROP
:
18934 case MODE_LINE_TITLE
:
18935 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18937 case MODE_LINE_STRING
:
18938 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18940 case MODE_LINE_DISPLAY
:
18941 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18950 /* Store a mode-line string element in mode_line_string_list.
18952 If STRING is non-null, display that C string. Otherwise, the Lisp
18953 string LISP_STRING is displayed.
18955 FIELD_WIDTH is the minimum number of output glyphs to produce.
18956 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18957 with spaces. FIELD_WIDTH <= 0 means don't pad.
18959 PRECISION is the maximum number of characters to output from
18960 STRING. PRECISION <= 0 means don't truncate the string.
18962 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18963 properties to the string.
18965 PROPS are the properties to add to the string.
18966 The mode_line_string_face face property is always added to the string.
18970 store_mode_line_string (string
, lisp_string
, copy_string
, field_width
, precision
, props
)
18972 Lisp_Object lisp_string
;
18981 if (string
!= NULL
)
18983 len
= strlen (string
);
18984 if (precision
> 0 && len
> precision
)
18986 lisp_string
= make_string (string
, len
);
18988 props
= mode_line_string_face_prop
;
18989 else if (!NILP (mode_line_string_face
))
18991 Lisp_Object face
= Fplist_get (props
, Qface
);
18992 props
= Fcopy_sequence (props
);
18994 face
= mode_line_string_face
;
18996 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18997 props
= Fplist_put (props
, Qface
, face
);
18999 Fadd_text_properties (make_number (0), make_number (len
),
19000 props
, lisp_string
);
19004 len
= XFASTINT (Flength (lisp_string
));
19005 if (precision
> 0 && len
> precision
)
19008 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19011 if (!NILP (mode_line_string_face
))
19015 props
= Ftext_properties_at (make_number (0), lisp_string
);
19016 face
= Fplist_get (props
, Qface
);
19018 face
= mode_line_string_face
;
19020 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19021 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19023 lisp_string
= Fcopy_sequence (lisp_string
);
19026 Fadd_text_properties (make_number (0), make_number (len
),
19027 props
, lisp_string
);
19032 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19036 if (field_width
> len
)
19038 field_width
-= len
;
19039 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19041 Fadd_text_properties (make_number (0), make_number (field_width
),
19042 props
, lisp_string
);
19043 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19051 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19053 doc
: /* Format a string out of a mode line format specification.
19054 First arg FORMAT specifies the mode line format (see `mode-line-format'
19055 for details) to use.
19057 Optional second arg FACE specifies the face property to put
19058 on all characters for which no face is specified.
19059 The value t means whatever face the window's mode line currently uses
19060 \(either `mode-line' or `mode-line-inactive', depending).
19061 A value of nil means the default is no face property.
19062 If FACE is an integer, the value string has no text properties.
19064 Optional third and fourth args WINDOW and BUFFER specify the window
19065 and buffer to use as the context for the formatting (defaults
19066 are the selected window and the window's buffer). */)
19067 (format
, face
, window
, buffer
)
19068 Lisp_Object format
, face
, window
, buffer
;
19073 struct buffer
*old_buffer
= NULL
;
19075 int no_props
= INTEGERP (face
);
19076 int count
= SPECPDL_INDEX ();
19078 int string_start
= 0;
19081 window
= selected_window
;
19082 CHECK_WINDOW (window
);
19083 w
= XWINDOW (window
);
19086 buffer
= w
->buffer
;
19087 CHECK_BUFFER (buffer
);
19089 /* Make formatting the modeline a non-op when noninteractive, otherwise
19090 there will be problems later caused by a partially initialized frame. */
19091 if (NILP (format
) || noninteractive
)
19092 return empty_unibyte_string
;
19100 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
19101 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
19105 face_id
= DEFAULT_FACE_ID
;
19107 if (XBUFFER (buffer
) != current_buffer
)
19108 old_buffer
= current_buffer
;
19110 /* Save things including mode_line_proptrans_alist,
19111 and set that to nil so that we don't alter the outer value. */
19112 record_unwind_protect (unwind_format_mode_line
,
19113 format_mode_line_unwind_data
19114 (old_buffer
, selected_window
, 1));
19115 mode_line_proptrans_alist
= Qnil
;
19117 Fselect_window (window
, Qt
);
19119 set_buffer_internal_1 (XBUFFER (buffer
));
19121 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19125 mode_line_target
= MODE_LINE_NOPROP
;
19126 mode_line_string_face_prop
= Qnil
;
19127 mode_line_string_list
= Qnil
;
19128 string_start
= MODE_LINE_NOPROP_LEN (0);
19132 mode_line_target
= MODE_LINE_STRING
;
19133 mode_line_string_list
= Qnil
;
19134 mode_line_string_face
= face
;
19135 mode_line_string_face_prop
19136 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19139 push_kboard (FRAME_KBOARD (it
.f
));
19140 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19145 len
= MODE_LINE_NOPROP_LEN (string_start
);
19146 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19150 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19151 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19152 empty_unibyte_string
);
19155 unbind_to (count
, Qnil
);
19159 /* Write a null-terminated, right justified decimal representation of
19160 the positive integer D to BUF using a minimal field width WIDTH. */
19163 pint2str (buf
, width
, d
)
19164 register char *buf
;
19165 register int width
;
19168 register char *p
= buf
;
19176 *p
++ = d
% 10 + '0';
19181 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19192 /* Write a null-terminated, right justified decimal and "human
19193 readable" representation of the nonnegative integer D to BUF using
19194 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19196 static const char power_letter
[] =
19210 pint2hrstr (buf
, width
, d
)
19215 /* We aim to represent the nonnegative integer D as
19216 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19219 /* -1 means: do not use TENTHS. */
19223 /* Length of QUOTIENT.TENTHS as a string. */
19229 if (1000 <= quotient
)
19231 /* Scale to the appropriate EXPONENT. */
19234 remainder
= quotient
% 1000;
19238 while (1000 <= quotient
);
19240 /* Round to nearest and decide whether to use TENTHS or not. */
19243 tenths
= remainder
/ 100;
19244 if (50 <= remainder
% 100)
19251 if (quotient
== 10)
19259 if (500 <= remainder
)
19261 if (quotient
< 999)
19272 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19273 if (tenths
== -1 && quotient
<= 99)
19280 p
= psuffix
= buf
+ max (width
, length
);
19282 /* Print EXPONENT. */
19284 *psuffix
++ = power_letter
[exponent
];
19287 /* Print TENTHS. */
19290 *--p
= '0' + tenths
;
19294 /* Print QUOTIENT. */
19297 int digit
= quotient
% 10;
19298 *--p
= '0' + digit
;
19300 while ((quotient
/= 10) != 0);
19302 /* Print leading spaces. */
19307 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19308 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19309 type of CODING_SYSTEM. Return updated pointer into BUF. */
19311 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19314 decode_mode_spec_coding (coding_system
, buf
, eol_flag
)
19315 Lisp_Object coding_system
;
19316 register char *buf
;
19320 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19321 const unsigned char *eol_str
;
19323 /* The EOL conversion we are using. */
19324 Lisp_Object eoltype
;
19326 val
= CODING_SYSTEM_SPEC (coding_system
);
19329 if (!VECTORP (val
)) /* Not yet decided. */
19334 eoltype
= eol_mnemonic_undecided
;
19335 /* Don't mention EOL conversion if it isn't decided. */
19340 Lisp_Object eolvalue
;
19342 attrs
= AREF (val
, 0);
19343 eolvalue
= AREF (val
, 2);
19346 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19350 /* The EOL conversion that is normal on this system. */
19352 if (NILP (eolvalue
)) /* Not yet decided. */
19353 eoltype
= eol_mnemonic_undecided
;
19354 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19355 eoltype
= eol_mnemonic_undecided
;
19356 else /* eolvalue is Qunix, Qdos, or Qmac. */
19357 eoltype
= (EQ (eolvalue
, Qunix
)
19358 ? eol_mnemonic_unix
19359 : (EQ (eolvalue
, Qdos
) == 1
19360 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19366 /* Mention the EOL conversion if it is not the usual one. */
19367 if (STRINGP (eoltype
))
19369 eol_str
= SDATA (eoltype
);
19370 eol_str_len
= SBYTES (eoltype
);
19372 else if (CHARACTERP (eoltype
))
19374 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19375 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19380 eol_str
= invalid_eol_type
;
19381 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19383 bcopy (eol_str
, buf
, eol_str_len
);
19384 buf
+= eol_str_len
;
19390 /* Return a string for the output of a mode line %-spec for window W,
19391 generated by character C. PRECISION >= 0 means don't return a
19392 string longer than that value. FIELD_WIDTH > 0 means pad the
19393 string returned with spaces to that value. Return a Lisp string in
19394 *STRING if the resulting string is taken from that Lisp string.
19396 Note we operate on the current buffer for most purposes,
19397 the exception being w->base_line_pos. */
19399 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19402 decode_mode_spec (w
, c
, field_width
, precision
, string
)
19405 int field_width
, precision
;
19406 Lisp_Object
*string
;
19409 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19410 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19411 struct buffer
*b
= current_buffer
;
19419 if (!NILP (b
->read_only
))
19421 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19426 /* This differs from %* only for a modified read-only buffer. */
19427 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19429 if (!NILP (b
->read_only
))
19434 /* This differs from %* in ignoring read-only-ness. */
19435 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19447 if (command_loop_level
> 5)
19449 p
= decode_mode_spec_buf
;
19450 for (i
= 0; i
< command_loop_level
; i
++)
19453 return decode_mode_spec_buf
;
19461 if (command_loop_level
> 5)
19463 p
= decode_mode_spec_buf
;
19464 for (i
= 0; i
< command_loop_level
; i
++)
19467 return decode_mode_spec_buf
;
19474 /* Let lots_of_dashes be a string of infinite length. */
19475 if (mode_line_target
== MODE_LINE_NOPROP
||
19476 mode_line_target
== MODE_LINE_STRING
)
19478 if (field_width
<= 0
19479 || field_width
> sizeof (lots_of_dashes
))
19481 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19482 decode_mode_spec_buf
[i
] = '-';
19483 decode_mode_spec_buf
[i
] = '\0';
19484 return decode_mode_spec_buf
;
19487 return lots_of_dashes
;
19495 /* %c and %l are ignored in `frame-title-format'.
19496 (In redisplay_internal, the frame title is drawn _before_ the
19497 windows are updated, so the stuff which depends on actual
19498 window contents (such as %l) may fail to render properly, or
19499 even crash emacs.) */
19500 if (mode_line_target
== MODE_LINE_TITLE
)
19504 int col
= (int) current_column (); /* iftc */
19505 w
->column_number_displayed
= make_number (col
);
19506 pint2str (decode_mode_spec_buf
, field_width
, col
);
19507 return decode_mode_spec_buf
;
19511 #ifndef SYSTEM_MALLOC
19513 if (NILP (Vmemory_full
))
19516 return "!MEM FULL! ";
19523 /* %F displays the frame name. */
19524 if (!NILP (f
->title
))
19525 return (char *) SDATA (f
->title
);
19526 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19527 return (char *) SDATA (f
->name
);
19536 int size
= ZV
- BEGV
;
19537 pint2str (decode_mode_spec_buf
, field_width
, size
);
19538 return decode_mode_spec_buf
;
19543 int size
= ZV
- BEGV
;
19544 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19545 return decode_mode_spec_buf
;
19550 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19551 int topline
, nlines
, junk
, height
;
19553 /* %c and %l are ignored in `frame-title-format'. */
19554 if (mode_line_target
== MODE_LINE_TITLE
)
19557 startpos
= XMARKER (w
->start
)->charpos
;
19558 startpos_byte
= marker_byte_position (w
->start
);
19559 height
= WINDOW_TOTAL_LINES (w
);
19561 /* If we decided that this buffer isn't suitable for line numbers,
19562 don't forget that too fast. */
19563 if (EQ (w
->base_line_pos
, w
->buffer
))
19565 /* But do forget it, if the window shows a different buffer now. */
19566 else if (BUFFERP (w
->base_line_pos
))
19567 w
->base_line_pos
= Qnil
;
19569 /* If the buffer is very big, don't waste time. */
19570 if (INTEGERP (Vline_number_display_limit
)
19571 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19573 w
->base_line_pos
= Qnil
;
19574 w
->base_line_number
= Qnil
;
19578 if (INTEGERP (w
->base_line_number
)
19579 && INTEGERP (w
->base_line_pos
)
19580 && XFASTINT (w
->base_line_pos
) <= startpos
)
19582 line
= XFASTINT (w
->base_line_number
);
19583 linepos
= XFASTINT (w
->base_line_pos
);
19584 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19589 linepos
= BUF_BEGV (b
);
19590 linepos_byte
= BUF_BEGV_BYTE (b
);
19593 /* Count lines from base line to window start position. */
19594 nlines
= display_count_lines (linepos
, linepos_byte
,
19598 topline
= nlines
+ line
;
19600 /* Determine a new base line, if the old one is too close
19601 or too far away, or if we did not have one.
19602 "Too close" means it's plausible a scroll-down would
19603 go back past it. */
19604 if (startpos
== BUF_BEGV (b
))
19606 w
->base_line_number
= make_number (topline
);
19607 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19609 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19610 || linepos
== BUF_BEGV (b
))
19612 int limit
= BUF_BEGV (b
);
19613 int limit_byte
= BUF_BEGV_BYTE (b
);
19615 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19617 if (startpos
- distance
> limit
)
19619 limit
= startpos
- distance
;
19620 limit_byte
= CHAR_TO_BYTE (limit
);
19623 nlines
= display_count_lines (startpos
, startpos_byte
,
19625 - (height
* 2 + 30),
19627 /* If we couldn't find the lines we wanted within
19628 line_number_display_limit_width chars per line,
19629 give up on line numbers for this window. */
19630 if (position
== limit_byte
&& limit
== startpos
- distance
)
19632 w
->base_line_pos
= w
->buffer
;
19633 w
->base_line_number
= Qnil
;
19637 w
->base_line_number
= make_number (topline
- nlines
);
19638 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19641 /* Now count lines from the start pos to point. */
19642 nlines
= display_count_lines (startpos
, startpos_byte
,
19643 PT_BYTE
, PT
, &junk
);
19645 /* Record that we did display the line number. */
19646 line_number_displayed
= 1;
19648 /* Make the string to show. */
19649 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19650 return decode_mode_spec_buf
;
19653 char* p
= decode_mode_spec_buf
;
19654 int pad
= field_width
- 2;
19660 return decode_mode_spec_buf
;
19666 obj
= b
->mode_name
;
19670 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19676 int pos
= marker_position (w
->start
);
19677 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19679 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19681 if (pos
<= BUF_BEGV (b
))
19686 else if (pos
<= BUF_BEGV (b
))
19690 if (total
> 1000000)
19691 /* Do it differently for a large value, to avoid overflow. */
19692 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19694 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19695 /* We can't normally display a 3-digit number,
19696 so get us a 2-digit number that is close. */
19699 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19700 return decode_mode_spec_buf
;
19704 /* Display percentage of size above the bottom of the screen. */
19707 int toppos
= marker_position (w
->start
);
19708 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19709 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19711 if (botpos
>= BUF_ZV (b
))
19713 if (toppos
<= BUF_BEGV (b
))
19720 if (total
> 1000000)
19721 /* Do it differently for a large value, to avoid overflow. */
19722 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19724 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19725 /* We can't normally display a 3-digit number,
19726 so get us a 2-digit number that is close. */
19729 if (toppos
<= BUF_BEGV (b
))
19730 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19732 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19733 return decode_mode_spec_buf
;
19738 /* status of process */
19739 obj
= Fget_buffer_process (Fcurrent_buffer ());
19741 return "no process";
19742 #ifdef subprocesses
19743 obj
= Fsymbol_name (Fprocess_status (obj
));
19749 int count
= inhibit_garbage_collection ();
19750 Lisp_Object val
= call1 (intern ("file-remote-p"),
19751 current_buffer
->directory
);
19752 unbind_to (count
, Qnil
);
19760 case 't': /* indicate TEXT or BINARY */
19761 #ifdef MODE_LINE_BINARY_TEXT
19762 return MODE_LINE_BINARY_TEXT (b
);
19768 /* coding-system (not including end-of-line format) */
19770 /* coding-system (including end-of-line type) */
19772 int eol_flag
= (c
== 'Z');
19773 char *p
= decode_mode_spec_buf
;
19775 if (! FRAME_WINDOW_P (f
))
19777 /* No need to mention EOL here--the terminal never needs
19778 to do EOL conversion. */
19779 p
= decode_mode_spec_coding (CODING_ID_NAME
19780 (FRAME_KEYBOARD_CODING (f
)->id
),
19782 p
= decode_mode_spec_coding (CODING_ID_NAME
19783 (FRAME_TERMINAL_CODING (f
)->id
),
19786 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19789 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19790 #ifdef subprocesses
19791 obj
= Fget_buffer_process (Fcurrent_buffer ());
19792 if (PROCESSP (obj
))
19794 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19796 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19799 #endif /* subprocesses */
19802 return decode_mode_spec_buf
;
19809 return (char *) SDATA (obj
);
19816 /* Count up to COUNT lines starting from START / START_BYTE.
19817 But don't go beyond LIMIT_BYTE.
19818 Return the number of lines thus found (always nonnegative).
19820 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19823 display_count_lines (start
, start_byte
, limit_byte
, count
, byte_pos_ptr
)
19824 int start
, start_byte
, limit_byte
, count
;
19827 register unsigned char *cursor
;
19828 unsigned char *base
;
19830 register int ceiling
;
19831 register unsigned char *ceiling_addr
;
19832 int orig_count
= count
;
19834 /* If we are not in selective display mode,
19835 check only for newlines. */
19836 int selective_display
= (!NILP (current_buffer
->selective_display
)
19837 && !INTEGERP (current_buffer
->selective_display
));
19841 while (start_byte
< limit_byte
)
19843 ceiling
= BUFFER_CEILING_OF (start_byte
);
19844 ceiling
= min (limit_byte
- 1, ceiling
);
19845 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19846 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19849 if (selective_display
)
19850 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19853 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19856 if (cursor
!= ceiling_addr
)
19860 start_byte
+= cursor
- base
+ 1;
19861 *byte_pos_ptr
= start_byte
;
19865 if (++cursor
== ceiling_addr
)
19871 start_byte
+= cursor
- base
;
19876 while (start_byte
> limit_byte
)
19878 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19879 ceiling
= max (limit_byte
, ceiling
);
19880 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19881 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19884 if (selective_display
)
19885 while (--cursor
!= ceiling_addr
19886 && *cursor
!= '\n' && *cursor
!= 015)
19889 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19892 if (cursor
!= ceiling_addr
)
19896 start_byte
+= cursor
- base
+ 1;
19897 *byte_pos_ptr
= start_byte
;
19898 /* When scanning backwards, we should
19899 not count the newline posterior to which we stop. */
19900 return - orig_count
- 1;
19906 /* Here we add 1 to compensate for the last decrement
19907 of CURSOR, which took it past the valid range. */
19908 start_byte
+= cursor
- base
+ 1;
19912 *byte_pos_ptr
= limit_byte
;
19915 return - orig_count
+ count
;
19916 return orig_count
- count
;
19922 /***********************************************************************
19924 ***********************************************************************/
19926 /* Display a NUL-terminated string, starting with index START.
19928 If STRING is non-null, display that C string. Otherwise, the Lisp
19929 string LISP_STRING is displayed. There's a case that STRING is
19930 non-null and LISP_STRING is not nil. It means STRING is a string
19931 data of LISP_STRING. In that case, we display LISP_STRING while
19932 ignoring its text properties.
19934 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19935 FACE_STRING. Display STRING or LISP_STRING with the face at
19936 FACE_STRING_POS in FACE_STRING:
19938 Display the string in the environment given by IT, but use the
19939 standard display table, temporarily.
19941 FIELD_WIDTH is the minimum number of output glyphs to produce.
19942 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19943 with spaces. If STRING has more characters, more than FIELD_WIDTH
19944 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19946 PRECISION is the maximum number of characters to output from
19947 STRING. PRECISION < 0 means don't truncate the string.
19949 This is roughly equivalent to printf format specifiers:
19951 FIELD_WIDTH PRECISION PRINTF
19952 ----------------------------------------
19958 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19959 display them, and < 0 means obey the current buffer's value of
19960 enable_multibyte_characters.
19962 Value is the number of columns displayed. */
19965 display_string (string
, lisp_string
, face_string
, face_string_pos
,
19966 start
, it
, field_width
, precision
, max_x
, multibyte
)
19967 unsigned char *string
;
19968 Lisp_Object lisp_string
;
19969 Lisp_Object face_string
;
19970 EMACS_INT face_string_pos
;
19973 int field_width
, precision
, max_x
;
19976 int hpos_at_start
= it
->hpos
;
19977 int saved_face_id
= it
->face_id
;
19978 struct glyph_row
*row
= it
->glyph_row
;
19980 /* Initialize the iterator IT for iteration over STRING beginning
19981 with index START. */
19982 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19983 precision
, field_width
, multibyte
);
19984 if (string
&& STRINGP (lisp_string
))
19985 /* LISP_STRING is the one returned by decode_mode_spec. We should
19986 ignore its text properties. */
19987 it
->stop_charpos
= -1;
19989 /* If displaying STRING, set up the face of the iterator
19990 from LISP_STRING, if that's given. */
19991 if (STRINGP (face_string
))
19997 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19998 0, it
->region_beg_charpos
,
19999 it
->region_end_charpos
,
20000 &endptr
, it
->base_face_id
, 0);
20001 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20002 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20005 /* Set max_x to the maximum allowed X position. Don't let it go
20006 beyond the right edge of the window. */
20008 max_x
= it
->last_visible_x
;
20010 max_x
= min (max_x
, it
->last_visible_x
);
20012 /* Skip over display elements that are not visible. because IT->w is
20014 if (it
->current_x
< it
->first_visible_x
)
20015 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20016 MOVE_TO_POS
| MOVE_TO_X
);
20018 row
->ascent
= it
->max_ascent
;
20019 row
->height
= it
->max_ascent
+ it
->max_descent
;
20020 row
->phys_ascent
= it
->max_phys_ascent
;
20021 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20022 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20024 /* This condition is for the case that we are called with current_x
20025 past last_visible_x. */
20026 while (it
->current_x
< max_x
)
20028 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20030 /* Get the next display element. */
20031 if (!get_next_display_element (it
))
20034 /* Produce glyphs. */
20035 x_before
= it
->current_x
;
20036 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20037 PRODUCE_GLYPHS (it
);
20039 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
20042 while (i
< nglyphs
)
20044 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20046 if (it
->line_wrap
!= TRUNCATE
20047 && x
+ glyph
->pixel_width
> max_x
)
20049 /* End of continued line or max_x reached. */
20050 if (CHAR_GLYPH_PADDING_P (*glyph
))
20052 /* A wide character is unbreakable. */
20053 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
20054 it
->current_x
= x_before
;
20058 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20063 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20065 /* Glyph is at least partially visible. */
20067 if (x
< it
->first_visible_x
)
20068 it
->glyph_row
->x
= x
- it
->first_visible_x
;
20072 /* Glyph is off the left margin of the display area.
20073 Should not happen. */
20077 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20078 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20079 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20080 row
->phys_height
= max (row
->phys_height
,
20081 it
->max_phys_ascent
+ it
->max_phys_descent
);
20082 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20083 it
->max_extra_line_spacing
);
20084 x
+= glyph
->pixel_width
;
20088 /* Stop if max_x reached. */
20092 /* Stop at line ends. */
20093 if (ITERATOR_AT_END_OF_LINE_P (it
))
20095 it
->continuation_lines_width
= 0;
20099 set_iterator_to_next (it
, 1);
20101 /* Stop if truncating at the right edge. */
20102 if (it
->line_wrap
== TRUNCATE
20103 && it
->current_x
>= it
->last_visible_x
)
20105 /* Add truncation mark, but don't do it if the line is
20106 truncated at a padding space. */
20107 if (IT_CHARPOS (*it
) < it
->string_nchars
)
20109 if (!FRAME_WINDOW_P (it
->f
))
20113 if (it
->current_x
> it
->last_visible_x
)
20115 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20116 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20118 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20120 row
->used
[TEXT_AREA
] = i
;
20121 produce_special_glyphs (it
, IT_TRUNCATION
);
20124 produce_special_glyphs (it
, IT_TRUNCATION
);
20126 it
->glyph_row
->truncated_on_right_p
= 1;
20132 /* Maybe insert a truncation at the left. */
20133 if (it
->first_visible_x
20134 && IT_CHARPOS (*it
) > 0)
20136 if (!FRAME_WINDOW_P (it
->f
))
20137 insert_left_trunc_glyphs (it
);
20138 it
->glyph_row
->truncated_on_left_p
= 1;
20141 it
->face_id
= saved_face_id
;
20143 /* Value is number of columns displayed. */
20144 return it
->hpos
- hpos_at_start
;
20149 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20150 appears as an element of LIST or as the car of an element of LIST.
20151 If PROPVAL is a list, compare each element against LIST in that
20152 way, and return 1/2 if any element of PROPVAL is found in LIST.
20153 Otherwise return 0. This function cannot quit.
20154 The return value is 2 if the text is invisible but with an ellipsis
20155 and 1 if it's invisible and without an ellipsis. */
20158 invisible_p (propval
, list
)
20159 register Lisp_Object propval
;
20162 register Lisp_Object tail
, proptail
;
20164 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20166 register Lisp_Object tem
;
20168 if (EQ (propval
, tem
))
20170 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20171 return NILP (XCDR (tem
)) ? 1 : 2;
20174 if (CONSP (propval
))
20176 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20178 Lisp_Object propelt
;
20179 propelt
= XCAR (proptail
);
20180 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20182 register Lisp_Object tem
;
20184 if (EQ (propelt
, tem
))
20186 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20187 return NILP (XCDR (tem
)) ? 1 : 2;
20195 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20196 doc
: /* Non-nil if the property makes the text invisible.
20197 POS-OR-PROP can be a marker or number, in which case it is taken to be
20198 a position in the current buffer and the value of the `invisible' property
20199 is checked; or it can be some other value, which is then presumed to be the
20200 value of the `invisible' property of the text of interest.
20201 The non-nil value returned can be t for truly invisible text or something
20202 else if the text is replaced by an ellipsis. */)
20204 Lisp_Object pos_or_prop
;
20207 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20208 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20210 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20211 return (invis
== 0 ? Qnil
20213 : make_number (invis
));
20216 /* Calculate a width or height in pixels from a specification using
20217 the following elements:
20220 NUM - a (fractional) multiple of the default font width/height
20221 (NUM) - specifies exactly NUM pixels
20222 UNIT - a fixed number of pixels, see below.
20223 ELEMENT - size of a display element in pixels, see below.
20224 (NUM . SPEC) - equals NUM * SPEC
20225 (+ SPEC SPEC ...) - add pixel values
20226 (- SPEC SPEC ...) - subtract pixel values
20227 (- SPEC) - negate pixel value
20230 INT or FLOAT - a number constant
20231 SYMBOL - use symbol's (buffer local) variable binding.
20234 in - pixels per inch *)
20235 mm - pixels per 1/1000 meter *)
20236 cm - pixels per 1/100 meter *)
20237 width - width of current font in pixels.
20238 height - height of current font in pixels.
20240 *) using the ratio(s) defined in display-pixels-per-inch.
20244 left-fringe - left fringe width in pixels
20245 right-fringe - right fringe width in pixels
20247 left-margin - left margin width in pixels
20248 right-margin - right margin width in pixels
20250 scroll-bar - scroll-bar area width in pixels
20254 Pixels corresponding to 5 inches:
20257 Total width of non-text areas on left side of window (if scroll-bar is on left):
20258 '(space :width (+ left-fringe left-margin scroll-bar))
20260 Align to first text column (in header line):
20261 '(space :align-to 0)
20263 Align to middle of text area minus half the width of variable `my-image'
20264 containing a loaded image:
20265 '(space :align-to (0.5 . (- text my-image)))
20267 Width of left margin minus width of 1 character in the default font:
20268 '(space :width (- left-margin 1))
20270 Width of left margin minus width of 2 characters in the current font:
20271 '(space :width (- left-margin (2 . width)))
20273 Center 1 character over left-margin (in header line):
20274 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20276 Different ways to express width of left fringe plus left margin minus one pixel:
20277 '(space :width (- (+ left-fringe left-margin) (1)))
20278 '(space :width (+ left-fringe left-margin (- (1))))
20279 '(space :width (+ left-fringe left-margin (-1)))
20283 #define NUMVAL(X) \
20284 ((INTEGERP (X) || FLOATP (X)) \
20289 calc_pixel_width_or_height (res
, it
, prop
, font
, width_p
, align_to
)
20294 int width_p
, *align_to
;
20298 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20299 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20302 return OK_PIXELS (0);
20304 xassert (FRAME_LIVE_P (it
->f
));
20306 if (SYMBOLP (prop
))
20308 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20310 char *unit
= SDATA (SYMBOL_NAME (prop
));
20312 if (unit
[0] == 'i' && unit
[1] == 'n')
20314 else if (unit
[0] == 'm' && unit
[1] == 'm')
20316 else if (unit
[0] == 'c' && unit
[1] == 'm')
20323 #ifdef HAVE_WINDOW_SYSTEM
20324 if (FRAME_WINDOW_P (it
->f
)
20326 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20327 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20329 return OK_PIXELS (ppi
/ pixels
);
20332 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20333 || (CONSP (Vdisplay_pixels_per_inch
)
20335 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20336 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20338 return OK_PIXELS (ppi
/ pixels
);
20344 #ifdef HAVE_WINDOW_SYSTEM
20345 if (EQ (prop
, Qheight
))
20346 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20347 if (EQ (prop
, Qwidth
))
20348 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20350 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20351 return OK_PIXELS (1);
20354 if (EQ (prop
, Qtext
))
20355 return OK_PIXELS (width_p
20356 ? window_box_width (it
->w
, TEXT_AREA
)
20357 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20359 if (align_to
&& *align_to
< 0)
20362 if (EQ (prop
, Qleft
))
20363 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20364 if (EQ (prop
, Qright
))
20365 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20366 if (EQ (prop
, Qcenter
))
20367 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20368 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20369 if (EQ (prop
, Qleft_fringe
))
20370 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20371 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20372 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20373 if (EQ (prop
, Qright_fringe
))
20374 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20375 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20376 : window_box_right_offset (it
->w
, TEXT_AREA
));
20377 if (EQ (prop
, Qleft_margin
))
20378 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20379 if (EQ (prop
, Qright_margin
))
20380 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20381 if (EQ (prop
, Qscroll_bar
))
20382 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20384 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20385 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20386 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20391 if (EQ (prop
, Qleft_fringe
))
20392 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20393 if (EQ (prop
, Qright_fringe
))
20394 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20395 if (EQ (prop
, Qleft_margin
))
20396 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20397 if (EQ (prop
, Qright_margin
))
20398 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20399 if (EQ (prop
, Qscroll_bar
))
20400 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20403 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20406 if (INTEGERP (prop
) || FLOATP (prop
))
20408 int base_unit
= (width_p
20409 ? FRAME_COLUMN_WIDTH (it
->f
)
20410 : FRAME_LINE_HEIGHT (it
->f
));
20411 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20416 Lisp_Object car
= XCAR (prop
);
20417 Lisp_Object cdr
= XCDR (prop
);
20421 #ifdef HAVE_WINDOW_SYSTEM
20422 if (FRAME_WINDOW_P (it
->f
)
20423 && valid_image_p (prop
))
20425 int id
= lookup_image (it
->f
, prop
);
20426 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20428 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20431 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20437 while (CONSP (cdr
))
20439 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20440 font
, width_p
, align_to
))
20443 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20448 if (EQ (car
, Qminus
))
20450 return OK_PIXELS (pixels
);
20453 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20456 if (INTEGERP (car
) || FLOATP (car
))
20459 pixels
= XFLOATINT (car
);
20461 return OK_PIXELS (pixels
);
20462 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20463 font
, width_p
, align_to
))
20464 return OK_PIXELS (pixels
* fact
);
20475 /***********************************************************************
20477 ***********************************************************************/
20479 #ifdef HAVE_WINDOW_SYSTEM
20484 dump_glyph_string (s
)
20485 struct glyph_string
*s
;
20487 fprintf (stderr
, "glyph string\n");
20488 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20489 s
->x
, s
->y
, s
->width
, s
->height
);
20490 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20491 fprintf (stderr
, " hl = %d\n", s
->hl
);
20492 fprintf (stderr
, " left overhang = %d, right = %d\n",
20493 s
->left_overhang
, s
->right_overhang
);
20494 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20495 fprintf (stderr
, " extends to end of line = %d\n",
20496 s
->extends_to_end_of_line_p
);
20497 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20498 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20501 #endif /* GLYPH_DEBUG */
20503 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20504 of XChar2b structures for S; it can't be allocated in
20505 init_glyph_string because it must be allocated via `alloca'. W
20506 is the window on which S is drawn. ROW and AREA are the glyph row
20507 and area within the row from which S is constructed. START is the
20508 index of the first glyph structure covered by S. HL is a
20509 face-override for drawing S. */
20512 #define OPTIONAL_HDC(hdc) hdc,
20513 #define DECLARE_HDC(hdc) HDC hdc;
20514 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20515 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20518 #ifndef OPTIONAL_HDC
20519 #define OPTIONAL_HDC(hdc)
20520 #define DECLARE_HDC(hdc)
20521 #define ALLOCATE_HDC(hdc, f)
20522 #define RELEASE_HDC(hdc, f)
20526 init_glyph_string (s
, OPTIONAL_HDC (hdc
) char2b
, w
, row
, area
, start
, hl
)
20527 struct glyph_string
*s
;
20531 struct glyph_row
*row
;
20532 enum glyph_row_area area
;
20534 enum draw_glyphs_face hl
;
20536 bzero (s
, sizeof *s
);
20538 s
->f
= XFRAME (w
->frame
);
20542 s
->display
= FRAME_X_DISPLAY (s
->f
);
20543 s
->window
= FRAME_X_WINDOW (s
->f
);
20544 s
->char2b
= char2b
;
20548 s
->first_glyph
= row
->glyphs
[area
] + start
;
20549 s
->height
= row
->height
;
20550 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20551 s
->ybase
= s
->y
+ row
->ascent
;
20555 /* Append the list of glyph strings with head H and tail T to the list
20556 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20559 append_glyph_string_lists (head
, tail
, h
, t
)
20560 struct glyph_string
**head
, **tail
;
20561 struct glyph_string
*h
, *t
;
20575 /* Prepend the list of glyph strings with head H and tail T to the
20576 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20580 prepend_glyph_string_lists (head
, tail
, h
, t
)
20581 struct glyph_string
**head
, **tail
;
20582 struct glyph_string
*h
, *t
;
20596 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20597 Set *HEAD and *TAIL to the resulting list. */
20600 append_glyph_string (head
, tail
, s
)
20601 struct glyph_string
**head
, **tail
;
20602 struct glyph_string
*s
;
20604 s
->next
= s
->prev
= NULL
;
20605 append_glyph_string_lists (head
, tail
, s
, s
);
20609 /* Get face and two-byte form of character C in face FACE_ID on frame
20610 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20611 means we want to display multibyte text. DISPLAY_P non-zero means
20612 make sure that X resources for the face returned are allocated.
20613 Value is a pointer to a realized face that is ready for display if
20614 DISPLAY_P is non-zero. */
20616 static INLINE
struct face
*
20617 get_char_face_and_encoding (f
, c
, face_id
, char2b
, multibyte_p
, display_p
)
20621 int multibyte_p
, display_p
;
20623 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20627 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20629 if (code
!= FONT_INVALID_CODE
)
20630 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20632 STORE_XCHAR2B (char2b
, 0, 0);
20635 /* Make sure X resources of the face are allocated. */
20636 #ifdef HAVE_X_WINDOWS
20640 xassert (face
!= NULL
);
20641 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20648 /* Get face and two-byte form of character glyph GLYPH on frame F.
20649 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20650 a pointer to a realized face that is ready for display. */
20652 static INLINE
struct face
*
20653 get_glyph_face_and_encoding (f
, glyph
, char2b
, two_byte_p
)
20655 struct glyph
*glyph
;
20661 xassert (glyph
->type
== CHAR_GLYPH
);
20662 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20669 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20671 if (code
!= FONT_INVALID_CODE
)
20672 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20674 STORE_XCHAR2B (char2b
, 0, 0);
20677 /* Make sure X resources of the face are allocated. */
20678 xassert (face
!= NULL
);
20679 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20684 /* Fill glyph string S with composition components specified by S->cmp.
20686 BASE_FACE is the base face of the composition.
20687 S->cmp_from is the index of the first component for S.
20689 OVERLAPS non-zero means S should draw the foreground only, and use
20690 its physical height for clipping. See also draw_glyphs.
20692 Value is the index of a component not in S. */
20695 fill_composite_glyph_string (s
, base_face
, overlaps
)
20696 struct glyph_string
*s
;
20697 struct face
*base_face
;
20701 /* For all glyphs of this composition, starting at the offset
20702 S->cmp_from, until we reach the end of the definition or encounter a
20703 glyph that requires the different face, add it to S. */
20708 s
->for_overlaps
= overlaps
;
20711 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20713 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20717 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20720 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20721 s
->char2b
+ i
, 1, 1);
20727 s
->font
= s
->face
->font
;
20729 else if (s
->face
!= face
)
20737 /* All glyph strings for the same composition has the same width,
20738 i.e. the width set for the first component of the composition. */
20739 s
->width
= s
->first_glyph
->pixel_width
;
20741 /* If the specified font could not be loaded, use the frame's
20742 default font, but record the fact that we couldn't load it in
20743 the glyph string so that we can draw rectangles for the
20744 characters of the glyph string. */
20745 if (s
->font
== NULL
)
20747 s
->font_not_found_p
= 1;
20748 s
->font
= FRAME_FONT (s
->f
);
20751 /* Adjust base line for subscript/superscript text. */
20752 s
->ybase
+= s
->first_glyph
->voffset
;
20754 /* This glyph string must always be drawn with 16-bit functions. */
20761 fill_gstring_glyph_string (s
, face_id
, start
, end
, overlaps
)
20762 struct glyph_string
*s
;
20764 int start
, end
, overlaps
;
20766 struct glyph
*glyph
, *last
;
20767 Lisp_Object lgstring
;
20770 s
->for_overlaps
= overlaps
;
20771 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20772 last
= s
->row
->glyphs
[s
->area
] + end
;
20773 s
->cmp_id
= glyph
->u
.cmp
.id
;
20774 s
->cmp_from
= glyph
->u
.cmp
.from
;
20775 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20776 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20777 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20778 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20780 while (glyph
< last
20781 && glyph
->u
.cmp
.automatic
20782 && glyph
->u
.cmp
.id
== s
->cmp_id
20783 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20784 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20786 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20788 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20789 unsigned code
= LGLYPH_CODE (lglyph
);
20791 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20793 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20794 return glyph
- s
->row
->glyphs
[s
->area
];
20798 /* Fill glyph string S from a sequence of character glyphs.
20800 FACE_ID is the face id of the string. START is the index of the
20801 first glyph to consider, END is the index of the last + 1.
20802 OVERLAPS non-zero means S should draw the foreground only, and use
20803 its physical height for clipping. See also draw_glyphs.
20805 Value is the index of the first glyph not in S. */
20808 fill_glyph_string (s
, face_id
, start
, end
, overlaps
)
20809 struct glyph_string
*s
;
20811 int start
, end
, overlaps
;
20813 struct glyph
*glyph
, *last
;
20815 int glyph_not_available_p
;
20817 xassert (s
->f
== XFRAME (s
->w
->frame
));
20818 xassert (s
->nchars
== 0);
20819 xassert (start
>= 0 && end
> start
);
20821 s
->for_overlaps
= overlaps
;
20822 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20823 last
= s
->row
->glyphs
[s
->area
] + end
;
20824 voffset
= glyph
->voffset
;
20825 s
->padding_p
= glyph
->padding_p
;
20826 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20828 while (glyph
< last
20829 && glyph
->type
== CHAR_GLYPH
20830 && glyph
->voffset
== voffset
20831 /* Same face id implies same font, nowadays. */
20832 && glyph
->face_id
== face_id
20833 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20837 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20838 s
->char2b
+ s
->nchars
,
20840 s
->two_byte_p
= two_byte_p
;
20842 xassert (s
->nchars
<= end
- start
);
20843 s
->width
+= glyph
->pixel_width
;
20844 if (glyph
++->padding_p
!= s
->padding_p
)
20848 s
->font
= s
->face
->font
;
20850 /* If the specified font could not be loaded, use the frame's font,
20851 but record the fact that we couldn't load it in
20852 S->font_not_found_p so that we can draw rectangles for the
20853 characters of the glyph string. */
20854 if (s
->font
== NULL
|| glyph_not_available_p
)
20856 s
->font_not_found_p
= 1;
20857 s
->font
= FRAME_FONT (s
->f
);
20860 /* Adjust base line for subscript/superscript text. */
20861 s
->ybase
+= voffset
;
20863 xassert (s
->face
&& s
->face
->gc
);
20864 return glyph
- s
->row
->glyphs
[s
->area
];
20868 /* Fill glyph string S from image glyph S->first_glyph. */
20871 fill_image_glyph_string (s
)
20872 struct glyph_string
*s
;
20874 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20875 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20877 s
->slice
= s
->first_glyph
->slice
;
20878 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20879 s
->font
= s
->face
->font
;
20880 s
->width
= s
->first_glyph
->pixel_width
;
20882 /* Adjust base line for subscript/superscript text. */
20883 s
->ybase
+= s
->first_glyph
->voffset
;
20887 /* Fill glyph string S from a sequence of stretch glyphs.
20889 ROW is the glyph row in which the glyphs are found, AREA is the
20890 area within the row. START is the index of the first glyph to
20891 consider, END is the index of the last + 1.
20893 Value is the index of the first glyph not in S. */
20896 fill_stretch_glyph_string (s
, row
, area
, start
, end
)
20897 struct glyph_string
*s
;
20898 struct glyph_row
*row
;
20899 enum glyph_row_area area
;
20902 struct glyph
*glyph
, *last
;
20903 int voffset
, face_id
;
20905 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20907 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20908 last
= s
->row
->glyphs
[s
->area
] + end
;
20909 face_id
= glyph
->face_id
;
20910 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20911 s
->font
= s
->face
->font
;
20912 s
->width
= glyph
->pixel_width
;
20914 voffset
= glyph
->voffset
;
20918 && glyph
->type
== STRETCH_GLYPH
20919 && glyph
->voffset
== voffset
20920 && glyph
->face_id
== face_id
);
20922 s
->width
+= glyph
->pixel_width
;
20924 /* Adjust base line for subscript/superscript text. */
20925 s
->ybase
+= voffset
;
20927 /* The case that face->gc == 0 is handled when drawing the glyph
20928 string by calling PREPARE_FACE_FOR_DISPLAY. */
20930 return glyph
- s
->row
->glyphs
[s
->area
];
20933 static struct font_metrics
*
20934 get_per_char_metric (f
, font
, char2b
)
20939 static struct font_metrics metrics
;
20940 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20942 if (! font
|| code
== FONT_INVALID_CODE
)
20944 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20949 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20950 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20951 assumed to be zero. */
20954 x_get_glyph_overhangs (glyph
, f
, left
, right
)
20955 struct glyph
*glyph
;
20959 *left
= *right
= 0;
20961 if (glyph
->type
== CHAR_GLYPH
)
20965 struct font_metrics
*pcm
;
20967 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20968 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20970 if (pcm
->rbearing
> pcm
->width
)
20971 *right
= pcm
->rbearing
- pcm
->width
;
20972 if (pcm
->lbearing
< 0)
20973 *left
= -pcm
->lbearing
;
20976 else if (glyph
->type
== COMPOSITE_GLYPH
)
20978 if (! glyph
->u
.cmp
.automatic
)
20980 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20982 if (cmp
->rbearing
> cmp
->pixel_width
)
20983 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20984 if (cmp
->lbearing
< 0)
20985 *left
= - cmp
->lbearing
;
20989 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20990 struct font_metrics metrics
;
20992 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20993 glyph
->u
.cmp
.to
+ 1, &metrics
);
20994 if (metrics
.rbearing
> metrics
.width
)
20995 *right
= metrics
.rbearing
- metrics
.width
;
20996 if (metrics
.lbearing
< 0)
20997 *left
= - metrics
.lbearing
;
21003 /* Return the index of the first glyph preceding glyph string S that
21004 is overwritten by S because of S's left overhang. Value is -1
21005 if no glyphs are overwritten. */
21008 left_overwritten (s
)
21009 struct glyph_string
*s
;
21013 if (s
->left_overhang
)
21016 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21017 int first
= s
->first_glyph
- glyphs
;
21019 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21020 x
-= glyphs
[i
].pixel_width
;
21031 /* Return the index of the first glyph preceding glyph string S that
21032 is overwriting S because of its right overhang. Value is -1 if no
21033 glyph in front of S overwrites S. */
21036 left_overwriting (s
)
21037 struct glyph_string
*s
;
21040 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21041 int first
= s
->first_glyph
- glyphs
;
21045 for (i
= first
- 1; i
>= 0; --i
)
21048 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21051 x
-= glyphs
[i
].pixel_width
;
21058 /* Return the index of the last glyph following glyph string S that is
21059 overwritten by S because of S's right overhang. Value is -1 if
21060 no such glyph is found. */
21063 right_overwritten (s
)
21064 struct glyph_string
*s
;
21068 if (s
->right_overhang
)
21071 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21072 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21073 int end
= s
->row
->used
[s
->area
];
21075 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
21076 x
+= glyphs
[i
].pixel_width
;
21085 /* Return the index of the last glyph following glyph string S that
21086 overwrites S because of its left overhang. Value is negative
21087 if no such glyph is found. */
21090 right_overwriting (s
)
21091 struct glyph_string
*s
;
21094 int end
= s
->row
->used
[s
->area
];
21095 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21096 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
21100 for (i
= first
; i
< end
; ++i
)
21103 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21106 x
+= glyphs
[i
].pixel_width
;
21113 /* Set background width of glyph string S. START is the index of the
21114 first glyph following S. LAST_X is the right-most x-position + 1
21115 in the drawing area. */
21118 set_glyph_string_background_width (s
, start
, last_x
)
21119 struct glyph_string
*s
;
21123 /* If the face of this glyph string has to be drawn to the end of
21124 the drawing area, set S->extends_to_end_of_line_p. */
21126 if (start
== s
->row
->used
[s
->area
]
21127 && s
->area
== TEXT_AREA
21128 && ((s
->row
->fill_line_p
21129 && (s
->hl
== DRAW_NORMAL_TEXT
21130 || s
->hl
== DRAW_IMAGE_RAISED
21131 || s
->hl
== DRAW_IMAGE_SUNKEN
))
21132 || s
->hl
== DRAW_MOUSE_FACE
))
21133 s
->extends_to_end_of_line_p
= 1;
21135 /* If S extends its face to the end of the line, set its
21136 background_width to the distance to the right edge of the drawing
21138 if (s
->extends_to_end_of_line_p
)
21139 s
->background_width
= last_x
- s
->x
+ 1;
21141 s
->background_width
= s
->width
;
21145 /* Compute overhangs and x-positions for glyph string S and its
21146 predecessors, or successors. X is the starting x-position for S.
21147 BACKWARD_P non-zero means process predecessors. */
21150 compute_overhangs_and_x (s
, x
, backward_p
)
21151 struct glyph_string
*s
;
21159 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21160 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21170 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
21171 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
21181 /* The following macros are only called from draw_glyphs below.
21182 They reference the following parameters of that function directly:
21183 `w', `row', `area', and `overlap_p'
21184 as well as the following local variables:
21185 `s', `f', and `hdc' (in W32) */
21188 /* On W32, silently add local `hdc' variable to argument list of
21189 init_glyph_string. */
21190 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21191 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21193 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21194 init_glyph_string (s, char2b, w, row, area, start, hl)
21197 /* Add a glyph string for a stretch glyph to the list of strings
21198 between HEAD and TAIL. START is the index of the stretch glyph in
21199 row area AREA of glyph row ROW. END is the index of the last glyph
21200 in that glyph row area. X is the current output position assigned
21201 to the new glyph string constructed. HL overrides that face of the
21202 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21203 is the right-most x-position of the drawing area. */
21205 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21206 and below -- keep them on one line. */
21207 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21210 s = (struct glyph_string *) alloca (sizeof *s); \
21211 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21212 START = fill_stretch_glyph_string (s, row, area, START, END); \
21213 append_glyph_string (&HEAD, &TAIL, s); \
21219 /* Add a glyph string for an image glyph to the list of strings
21220 between HEAD and TAIL. START is the index of the image glyph in
21221 row area AREA of glyph row ROW. END is the index of the last glyph
21222 in that glyph row area. X is the current output position assigned
21223 to the new glyph string constructed. HL overrides that face of the
21224 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21225 is the right-most x-position of the drawing area. */
21227 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21230 s = (struct glyph_string *) alloca (sizeof *s); \
21231 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21232 fill_image_glyph_string (s); \
21233 append_glyph_string (&HEAD, &TAIL, s); \
21240 /* Add a glyph string for a sequence of character glyphs to the list
21241 of strings between HEAD and TAIL. START is the index of the first
21242 glyph in row area AREA of glyph row ROW that is part of the new
21243 glyph string. END is the index of the last glyph in that glyph row
21244 area. X is the current output position assigned to the new glyph
21245 string constructed. HL overrides that face of the glyph; e.g. it
21246 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21247 right-most x-position of the drawing area. */
21249 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21255 face_id = (row)->glyphs[area][START].face_id; \
21257 s = (struct glyph_string *) alloca (sizeof *s); \
21258 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21259 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21260 append_glyph_string (&HEAD, &TAIL, s); \
21262 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21267 /* Add a glyph string for a composite sequence to the list of strings
21268 between HEAD and TAIL. START is the index of the first glyph in
21269 row area AREA of glyph row ROW that is part of the new glyph
21270 string. END is the index of the last glyph in that glyph row area.
21271 X is the current output position assigned to the new glyph string
21272 constructed. HL overrides that face of the glyph; e.g. it is
21273 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21274 x-position of the drawing area. */
21276 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21278 int face_id = (row)->glyphs[area][START].face_id; \
21279 struct face *base_face = FACE_FROM_ID (f, face_id); \
21280 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21281 struct composition *cmp = composition_table[cmp_id]; \
21283 struct glyph_string *first_s; \
21286 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21288 /* Make glyph_strings for each glyph sequence that is drawable by \
21289 the same face, and append them to HEAD/TAIL. */ \
21290 for (n = 0; n < cmp->glyph_len;) \
21292 s = (struct glyph_string *) alloca (sizeof *s); \
21293 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21294 append_glyph_string (&(HEAD), &(TAIL), s); \
21300 n = fill_composite_glyph_string (s, base_face, overlaps); \
21308 /* Add a glyph string for a glyph-string sequence to the list of strings
21309 between HEAD and TAIL. */
21311 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21315 Lisp_Object gstring; \
21317 face_id = (row)->glyphs[area][START].face_id; \
21318 gstring = (composition_gstring_from_id \
21319 ((row)->glyphs[area][START].u.cmp.id)); \
21320 s = (struct glyph_string *) alloca (sizeof *s); \
21321 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21322 * LGSTRING_GLYPH_LEN (gstring)); \
21323 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21324 append_glyph_string (&(HEAD), &(TAIL), s); \
21326 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21330 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21331 of AREA of glyph row ROW on window W between indices START and END.
21332 HL overrides the face for drawing glyph strings, e.g. it is
21333 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21334 x-positions of the drawing area.
21336 This is an ugly monster macro construct because we must use alloca
21337 to allocate glyph strings (because draw_glyphs can be called
21338 asynchronously). */
21340 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21343 HEAD = TAIL = NULL; \
21344 while (START < END) \
21346 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21347 switch (first_glyph->type) \
21350 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21354 case COMPOSITE_GLYPH: \
21355 if (first_glyph->u.cmp.automatic) \
21356 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21359 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21363 case STRETCH_GLYPH: \
21364 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21368 case IMAGE_GLYPH: \
21369 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21379 set_glyph_string_background_width (s, START, LAST_X); \
21386 /* Draw glyphs between START and END in AREA of ROW on window W,
21387 starting at x-position X. X is relative to AREA in W. HL is a
21388 face-override with the following meaning:
21390 DRAW_NORMAL_TEXT draw normally
21391 DRAW_CURSOR draw in cursor face
21392 DRAW_MOUSE_FACE draw in mouse face.
21393 DRAW_INVERSE_VIDEO draw in mode line face
21394 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21395 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21397 If OVERLAPS is non-zero, draw only the foreground of characters and
21398 clip to the physical height of ROW. Non-zero value also defines
21399 the overlapping part to be drawn:
21401 OVERLAPS_PRED overlap with preceding rows
21402 OVERLAPS_SUCC overlap with succeeding rows
21403 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21404 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21406 Value is the x-position reached, relative to AREA of W. */
21409 draw_glyphs (w
, x
, row
, area
, start
, end
, hl
, overlaps
)
21412 struct glyph_row
*row
;
21413 enum glyph_row_area area
;
21414 EMACS_INT start
, end
;
21415 enum draw_glyphs_face hl
;
21418 struct glyph_string
*head
, *tail
;
21419 struct glyph_string
*s
;
21420 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21421 int i
, j
, x_reached
, last_x
, area_left
= 0;
21422 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21425 ALLOCATE_HDC (hdc
, f
);
21427 /* Let's rather be paranoid than getting a SEGV. */
21428 end
= min (end
, row
->used
[area
]);
21429 start
= max (0, start
);
21430 start
= min (end
, start
);
21432 /* Translate X to frame coordinates. Set last_x to the right
21433 end of the drawing area. */
21434 if (row
->full_width_p
)
21436 /* X is relative to the left edge of W, without scroll bars
21438 area_left
= WINDOW_LEFT_EDGE_X (w
);
21439 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21443 area_left
= window_box_left (w
, area
);
21444 last_x
= area_left
+ window_box_width (w
, area
);
21448 /* Build a doubly-linked list of glyph_string structures between
21449 head and tail from what we have to draw. Note that the macro
21450 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21451 the reason we use a separate variable `i'. */
21453 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21455 x_reached
= tail
->x
+ tail
->background_width
;
21459 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21460 the row, redraw some glyphs in front or following the glyph
21461 strings built above. */
21462 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21464 struct glyph_string
*h
, *t
;
21465 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21466 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21469 /* If mouse highlighting is on, we may need to draw adjacent
21470 glyphs using mouse-face highlighting. */
21471 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21473 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21475 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21476 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21478 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21480 check_mouse_face
= 1;
21481 mouse_beg_col
= (row
== mouse_beg_row
)
21482 ? dpyinfo
->mouse_face_beg_col
: 0;
21483 mouse_end_col
= (row
== mouse_end_row
)
21484 ? dpyinfo
->mouse_face_end_col
21485 : row
->used
[TEXT_AREA
];
21489 /* Compute overhangs for all glyph strings. */
21490 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21491 for (s
= head
; s
; s
= s
->next
)
21492 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21494 /* Prepend glyph strings for glyphs in front of the first glyph
21495 string that are overwritten because of the first glyph
21496 string's left overhang. The background of all strings
21497 prepended must be drawn because the first glyph string
21499 i
= left_overwritten (head
);
21502 enum draw_glyphs_face overlap_hl
;
21504 /* If this row contains mouse highlighting, attempt to draw
21505 the overlapped glyphs with the correct highlight. This
21506 code fails if the overlap encompasses more than one glyph
21507 and mouse-highlight spans only some of these glyphs.
21508 However, making it work perfectly involves a lot more
21509 code, and I don't know if the pathological case occurs in
21510 practice, so we'll stick to this for now. --- cyd */
21511 if (check_mouse_face
21512 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21513 overlap_hl
= DRAW_MOUSE_FACE
;
21515 overlap_hl
= DRAW_NORMAL_TEXT
;
21518 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21519 overlap_hl
, dummy_x
, last_x
);
21521 compute_overhangs_and_x (t
, head
->x
, 1);
21522 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21526 /* Prepend glyph strings for glyphs in front of the first glyph
21527 string that overwrite that glyph string because of their
21528 right overhang. For these strings, only the foreground must
21529 be drawn, because it draws over the glyph string at `head'.
21530 The background must not be drawn because this would overwrite
21531 right overhangs of preceding glyphs for which no glyph
21533 i
= left_overwriting (head
);
21536 enum draw_glyphs_face overlap_hl
;
21538 if (check_mouse_face
21539 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21540 overlap_hl
= DRAW_MOUSE_FACE
;
21542 overlap_hl
= DRAW_NORMAL_TEXT
;
21545 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21546 overlap_hl
, dummy_x
, last_x
);
21547 for (s
= h
; s
; s
= s
->next
)
21548 s
->background_filled_p
= 1;
21549 compute_overhangs_and_x (t
, head
->x
, 1);
21550 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21553 /* Append glyphs strings for glyphs following the last glyph
21554 string tail that are overwritten by tail. The background of
21555 these strings has to be drawn because tail's foreground draws
21557 i
= right_overwritten (tail
);
21560 enum draw_glyphs_face overlap_hl
;
21562 if (check_mouse_face
21563 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21564 overlap_hl
= DRAW_MOUSE_FACE
;
21566 overlap_hl
= DRAW_NORMAL_TEXT
;
21568 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21569 overlap_hl
, x
, last_x
);
21570 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21571 we don't have `end = i;' here. */
21572 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21573 append_glyph_string_lists (&head
, &tail
, h
, t
);
21577 /* Append glyph strings for glyphs following the last glyph
21578 string tail that overwrite tail. The foreground of such
21579 glyphs has to be drawn because it writes into the background
21580 of tail. The background must not be drawn because it could
21581 paint over the foreground of following glyphs. */
21582 i
= right_overwriting (tail
);
21585 enum draw_glyphs_face overlap_hl
;
21586 if (check_mouse_face
21587 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21588 overlap_hl
= DRAW_MOUSE_FACE
;
21590 overlap_hl
= DRAW_NORMAL_TEXT
;
21593 i
++; /* We must include the Ith glyph. */
21594 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21595 overlap_hl
, x
, last_x
);
21596 for (s
= h
; s
; s
= s
->next
)
21597 s
->background_filled_p
= 1;
21598 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21599 append_glyph_string_lists (&head
, &tail
, h
, t
);
21601 if (clip_head
|| clip_tail
)
21602 for (s
= head
; s
; s
= s
->next
)
21604 s
->clip_head
= clip_head
;
21605 s
->clip_tail
= clip_tail
;
21609 /* Draw all strings. */
21610 for (s
= head
; s
; s
= s
->next
)
21611 FRAME_RIF (f
)->draw_glyph_string (s
);
21614 /* When focus a sole frame and move horizontally, this sets on_p to 0
21615 causing a failure to erase prev cursor position. */
21616 if (area
== TEXT_AREA
21617 && !row
->full_width_p
21618 /* When drawing overlapping rows, only the glyph strings'
21619 foreground is drawn, which doesn't erase a cursor
21623 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21624 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21625 : (tail
? tail
->x
+ tail
->background_width
: x
));
21629 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21630 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21634 /* Value is the x-position up to which drawn, relative to AREA of W.
21635 This doesn't include parts drawn because of overhangs. */
21636 if (row
->full_width_p
)
21637 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21639 x_reached
-= area_left
;
21641 RELEASE_HDC (hdc
, f
);
21646 /* Expand row matrix if too narrow. Don't expand if area
21649 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21651 if (!fonts_changed_p \
21652 && (it->glyph_row->glyphs[area] \
21653 < it->glyph_row->glyphs[area + 1])) \
21655 it->w->ncols_scale_factor++; \
21656 fonts_changed_p = 1; \
21660 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21661 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21667 struct glyph
*glyph
;
21668 enum glyph_row_area area
= it
->area
;
21670 xassert (it
->glyph_row
);
21671 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21673 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21674 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21676 /* If the glyph row is reversed, we need to prepend the glyph
21677 rather than append it. */
21678 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21682 /* Make room for the additional glyph. */
21683 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21685 glyph
= it
->glyph_row
->glyphs
[area
];
21687 glyph
->charpos
= CHARPOS (it
->position
);
21688 glyph
->object
= it
->object
;
21689 if (it
->pixel_width
> 0)
21691 glyph
->pixel_width
= it
->pixel_width
;
21692 glyph
->padding_p
= 0;
21696 /* Assure at least 1-pixel width. Otherwise, cursor can't
21697 be displayed correctly. */
21698 glyph
->pixel_width
= 1;
21699 glyph
->padding_p
= 1;
21701 glyph
->ascent
= it
->ascent
;
21702 glyph
->descent
= it
->descent
;
21703 glyph
->voffset
= it
->voffset
;
21704 glyph
->type
= CHAR_GLYPH
;
21705 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21706 glyph
->multibyte_p
= it
->multibyte_p
;
21707 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21708 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21709 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21710 || it
->phys_descent
> it
->descent
);
21711 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21712 glyph
->face_id
= it
->face_id
;
21713 glyph
->u
.ch
= it
->char_to_display
;
21714 glyph
->slice
= null_glyph_slice
;
21715 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21718 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21719 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21721 glyph
->bidi_type
= it
->bidi_it
.type
;
21725 glyph
->resolved_level
= 0;
21726 glyph
->bidi_type
= UNKNOWN_BT
;
21728 ++it
->glyph_row
->used
[area
];
21731 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21734 /* Store one glyph for the composition IT->cmp_it.id in
21735 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21739 append_composite_glyph (it
)
21742 struct glyph
*glyph
;
21743 enum glyph_row_area area
= it
->area
;
21745 xassert (it
->glyph_row
);
21747 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21748 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21750 /* If the glyph row is reversed, we need to prepend the glyph
21751 rather than append it. */
21752 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21756 /* Make room for the new glyph. */
21757 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21759 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21761 glyph
->charpos
= CHARPOS (it
->position
);
21762 glyph
->object
= it
->object
;
21763 glyph
->pixel_width
= it
->pixel_width
;
21764 glyph
->ascent
= it
->ascent
;
21765 glyph
->descent
= it
->descent
;
21766 glyph
->voffset
= it
->voffset
;
21767 glyph
->type
= COMPOSITE_GLYPH
;
21768 if (it
->cmp_it
.ch
< 0)
21770 glyph
->u
.cmp
.automatic
= 0;
21771 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21775 glyph
->u
.cmp
.automatic
= 1;
21776 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21777 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21778 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21780 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21781 glyph
->multibyte_p
= it
->multibyte_p
;
21782 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21783 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21784 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21785 || it
->phys_descent
> it
->descent
);
21786 glyph
->padding_p
= 0;
21787 glyph
->glyph_not_available_p
= 0;
21788 glyph
->face_id
= it
->face_id
;
21789 glyph
->slice
= null_glyph_slice
;
21790 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21793 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21794 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21796 glyph
->bidi_type
= it
->bidi_it
.type
;
21798 ++it
->glyph_row
->used
[area
];
21801 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21805 /* Change IT->ascent and IT->height according to the setting of
21809 take_vertical_position_into_account (it
)
21814 if (it
->voffset
< 0)
21815 /* Increase the ascent so that we can display the text higher
21817 it
->ascent
-= it
->voffset
;
21819 /* Increase the descent so that we can display the text lower
21821 it
->descent
+= it
->voffset
;
21826 /* Produce glyphs/get display metrics for the image IT is loaded with.
21827 See the description of struct display_iterator in dispextern.h for
21828 an overview of struct display_iterator. */
21831 produce_image_glyph (it
)
21836 int glyph_ascent
, crop
;
21837 struct glyph_slice slice
;
21839 xassert (it
->what
== IT_IMAGE
);
21841 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21843 /* Make sure X resources of the face is loaded. */
21844 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21846 if (it
->image_id
< 0)
21848 /* Fringe bitmap. */
21849 it
->ascent
= it
->phys_ascent
= 0;
21850 it
->descent
= it
->phys_descent
= 0;
21851 it
->pixel_width
= 0;
21856 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21858 /* Make sure X resources of the image is loaded. */
21859 prepare_image_for_display (it
->f
, img
);
21861 slice
.x
= slice
.y
= 0;
21862 slice
.width
= img
->width
;
21863 slice
.height
= img
->height
;
21865 if (INTEGERP (it
->slice
.x
))
21866 slice
.x
= XINT (it
->slice
.x
);
21867 else if (FLOATP (it
->slice
.x
))
21868 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21870 if (INTEGERP (it
->slice
.y
))
21871 slice
.y
= XINT (it
->slice
.y
);
21872 else if (FLOATP (it
->slice
.y
))
21873 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21875 if (INTEGERP (it
->slice
.width
))
21876 slice
.width
= XINT (it
->slice
.width
);
21877 else if (FLOATP (it
->slice
.width
))
21878 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21880 if (INTEGERP (it
->slice
.height
))
21881 slice
.height
= XINT (it
->slice
.height
);
21882 else if (FLOATP (it
->slice
.height
))
21883 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21885 if (slice
.x
>= img
->width
)
21886 slice
.x
= img
->width
;
21887 if (slice
.y
>= img
->height
)
21888 slice
.y
= img
->height
;
21889 if (slice
.x
+ slice
.width
>= img
->width
)
21890 slice
.width
= img
->width
- slice
.x
;
21891 if (slice
.y
+ slice
.height
> img
->height
)
21892 slice
.height
= img
->height
- slice
.y
;
21894 if (slice
.width
== 0 || slice
.height
== 0)
21897 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21899 it
->descent
= slice
.height
- glyph_ascent
;
21901 it
->descent
+= img
->vmargin
;
21902 if (slice
.y
+ slice
.height
== img
->height
)
21903 it
->descent
+= img
->vmargin
;
21904 it
->phys_descent
= it
->descent
;
21906 it
->pixel_width
= slice
.width
;
21908 it
->pixel_width
+= img
->hmargin
;
21909 if (slice
.x
+ slice
.width
== img
->width
)
21910 it
->pixel_width
+= img
->hmargin
;
21912 /* It's quite possible for images to have an ascent greater than
21913 their height, so don't get confused in that case. */
21914 if (it
->descent
< 0)
21919 if (face
->box
!= FACE_NO_BOX
)
21921 if (face
->box_line_width
> 0)
21924 it
->ascent
+= face
->box_line_width
;
21925 if (slice
.y
+ slice
.height
== img
->height
)
21926 it
->descent
+= face
->box_line_width
;
21929 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21930 it
->pixel_width
+= eabs (face
->box_line_width
);
21931 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21932 it
->pixel_width
+= eabs (face
->box_line_width
);
21935 take_vertical_position_into_account (it
);
21937 /* Automatically crop wide image glyphs at right edge so we can
21938 draw the cursor on same display row. */
21939 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21940 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21942 it
->pixel_width
-= crop
;
21943 slice
.width
-= crop
;
21948 struct glyph
*glyph
;
21949 enum glyph_row_area area
= it
->area
;
21951 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21952 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21954 glyph
->charpos
= CHARPOS (it
->position
);
21955 glyph
->object
= it
->object
;
21956 glyph
->pixel_width
= it
->pixel_width
;
21957 glyph
->ascent
= glyph_ascent
;
21958 glyph
->descent
= it
->descent
;
21959 glyph
->voffset
= it
->voffset
;
21960 glyph
->type
= IMAGE_GLYPH
;
21961 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21962 glyph
->multibyte_p
= it
->multibyte_p
;
21963 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21964 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21965 glyph
->overlaps_vertically_p
= 0;
21966 glyph
->padding_p
= 0;
21967 glyph
->glyph_not_available_p
= 0;
21968 glyph
->face_id
= it
->face_id
;
21969 glyph
->u
.img_id
= img
->id
;
21970 glyph
->slice
= slice
;
21971 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21974 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21975 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21977 glyph
->bidi_type
= it
->bidi_it
.type
;
21979 ++it
->glyph_row
->used
[area
];
21982 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21987 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21988 of the glyph, WIDTH and HEIGHT are the width and height of the
21989 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21992 append_stretch_glyph (it
, object
, width
, height
, ascent
)
21994 Lisp_Object object
;
21998 struct glyph
*glyph
;
21999 enum glyph_row_area area
= it
->area
;
22001 xassert (ascent
>= 0 && ascent
<= height
);
22003 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22004 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22006 /* If the glyph row is reversed, we need to prepend the glyph
22007 rather than append it. */
22008 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22012 /* Make room for the additional glyph. */
22013 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22015 glyph
= it
->glyph_row
->glyphs
[area
];
22017 glyph
->charpos
= CHARPOS (it
->position
);
22018 glyph
->object
= object
;
22019 glyph
->pixel_width
= width
;
22020 glyph
->ascent
= ascent
;
22021 glyph
->descent
= height
- ascent
;
22022 glyph
->voffset
= it
->voffset
;
22023 glyph
->type
= STRETCH_GLYPH
;
22024 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22025 glyph
->multibyte_p
= it
->multibyte_p
;
22026 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22027 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22028 glyph
->overlaps_vertically_p
= 0;
22029 glyph
->padding_p
= 0;
22030 glyph
->glyph_not_available_p
= 0;
22031 glyph
->face_id
= it
->face_id
;
22032 glyph
->u
.stretch
.ascent
= ascent
;
22033 glyph
->u
.stretch
.height
= height
;
22034 glyph
->slice
= null_glyph_slice
;
22035 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22038 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22039 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22041 glyph
->bidi_type
= it
->bidi_it
.type
;
22045 glyph
->resolved_level
= 0;
22046 glyph
->bidi_type
= UNKNOWN_BT
;
22048 ++it
->glyph_row
->used
[area
];
22051 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22055 /* Produce a stretch glyph for iterator IT. IT->object is the value
22056 of the glyph property displayed. The value must be a list
22057 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
22060 1. `:width WIDTH' specifies that the space should be WIDTH *
22061 canonical char width wide. WIDTH may be an integer or floating
22064 2. `:relative-width FACTOR' specifies that the width of the stretch
22065 should be computed from the width of the first character having the
22066 `glyph' property, and should be FACTOR times that width.
22068 3. `:align-to HPOS' specifies that the space should be wide enough
22069 to reach HPOS, a value in canonical character units.
22071 Exactly one of the above pairs must be present.
22073 4. `:height HEIGHT' specifies that the height of the stretch produced
22074 should be HEIGHT, measured in canonical character units.
22076 5. `:relative-height FACTOR' specifies that the height of the
22077 stretch should be FACTOR times the height of the characters having
22078 the glyph property.
22080 Either none or exactly one of 4 or 5 must be present.
22082 6. `:ascent ASCENT' specifies that ASCENT percent of the height
22083 of the stretch should be used for the ascent of the stretch.
22084 ASCENT must be in the range 0 <= ASCENT <= 100. */
22087 produce_stretch_glyph (it
)
22090 /* (space :width WIDTH :height HEIGHT ...) */
22091 Lisp_Object prop
, plist
;
22092 int width
= 0, height
= 0, align_to
= -1;
22093 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
22096 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22097 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
22099 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22101 /* List should start with `space'. */
22102 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
22103 plist
= XCDR (it
->object
);
22105 /* Compute the width of the stretch. */
22106 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
22107 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
22109 /* Absolute width `:width WIDTH' specified and valid. */
22110 zero_width_ok_p
= 1;
22113 else if (prop
= Fplist_get (plist
, QCrelative_width
),
22116 /* Relative width `:relative-width FACTOR' specified and valid.
22117 Compute the width of the characters having the `glyph'
22120 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
22123 if (it
->multibyte_p
)
22125 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
22126 - IT_BYTEPOS (*it
));
22127 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
22130 it2
.c
= *p
, it2
.len
= 1;
22132 it2
.glyph_row
= NULL
;
22133 it2
.what
= IT_CHARACTER
;
22134 x_produce_glyphs (&it2
);
22135 width
= NUMVAL (prop
) * it2
.pixel_width
;
22137 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
22138 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
22140 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
22141 align_to
= (align_to
< 0
22143 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
22144 else if (align_to
< 0)
22145 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
22146 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
22147 zero_width_ok_p
= 1;
22150 /* Nothing specified -> width defaults to canonical char width. */
22151 width
= FRAME_COLUMN_WIDTH (it
->f
);
22153 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
22156 /* Compute height. */
22157 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
22158 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22161 zero_height_ok_p
= 1;
22163 else if (prop
= Fplist_get (plist
, QCrelative_height
),
22165 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
22167 height
= FONT_HEIGHT (font
);
22169 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
22172 /* Compute percentage of height used for ascent. If
22173 `:ascent ASCENT' is present and valid, use that. Otherwise,
22174 derive the ascent from the font in use. */
22175 if (prop
= Fplist_get (plist
, QCascent
),
22176 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
22177 ascent
= height
* NUMVAL (prop
) / 100.0;
22178 else if (!NILP (prop
)
22179 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
22180 ascent
= min (max (0, (int)tem
), height
);
22182 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
22184 if (width
> 0 && it
->line_wrap
!= TRUNCATE
22185 && it
->current_x
+ width
> it
->last_visible_x
)
22186 width
= it
->last_visible_x
- it
->current_x
- 1;
22188 if (width
> 0 && height
> 0 && it
->glyph_row
)
22190 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
22191 if (!STRINGP (object
))
22192 object
= it
->w
->buffer
;
22193 append_stretch_glyph (it
, object
, width
, height
, ascent
);
22196 it
->pixel_width
= width
;
22197 it
->ascent
= it
->phys_ascent
= ascent
;
22198 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
22199 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
22201 take_vertical_position_into_account (it
);
22204 /* Calculate line-height and line-spacing properties.
22205 An integer value specifies explicit pixel value.
22206 A float value specifies relative value to current face height.
22207 A cons (float . face-name) specifies relative value to
22208 height of specified face font.
22210 Returns height in pixels, or nil. */
22214 calc_line_height_property (it
, val
, font
, boff
, override
)
22218 int boff
, override
;
22220 Lisp_Object face_name
= Qnil
;
22221 int ascent
, descent
, height
;
22223 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22228 face_name
= XCAR (val
);
22230 if (!NUMBERP (val
))
22231 val
= make_number (1);
22232 if (NILP (face_name
))
22234 height
= it
->ascent
+ it
->descent
;
22239 if (NILP (face_name
))
22241 font
= FRAME_FONT (it
->f
);
22242 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22244 else if (EQ (face_name
, Qt
))
22253 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22255 return make_number (-1);
22257 face
= FACE_FROM_ID (it
->f
, face_id
);
22260 return make_number (-1);
22261 boff
= font
->baseline_offset
;
22262 if (font
->vertical_centering
)
22263 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22266 ascent
= FONT_BASE (font
) + boff
;
22267 descent
= FONT_DESCENT (font
) - boff
;
22271 it
->override_ascent
= ascent
;
22272 it
->override_descent
= descent
;
22273 it
->override_boff
= boff
;
22276 height
= ascent
+ descent
;
22280 height
= (int)(XFLOAT_DATA (val
) * height
);
22281 else if (INTEGERP (val
))
22282 height
*= XINT (val
);
22284 return make_number (height
);
22289 Produce glyphs/get display metrics for the display element IT is
22290 loaded with. See the description of struct it in dispextern.h
22291 for an overview of struct it. */
22294 x_produce_glyphs (it
)
22297 int extra_line_spacing
= it
->extra_line_spacing
;
22299 it
->glyph_not_available_p
= 0;
22301 if (it
->what
== IT_CHARACTER
)
22305 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22306 struct font_metrics
*pcm
;
22307 int font_not_found_p
;
22308 int boff
; /* baseline offset */
22309 /* We may change it->multibyte_p upon unibyte<->multibyte
22310 conversion. So, save the current value now and restore it
22313 Note: It seems that we don't have to record multibyte_p in
22314 struct glyph because the character code itself tells whether
22315 or not the character is multibyte. Thus, in the future, we
22316 must consider eliminating the field `multibyte_p' in the
22318 int saved_multibyte_p
= it
->multibyte_p
;
22320 /* Maybe translate single-byte characters to multibyte, or the
22322 it
->char_to_display
= it
->c
;
22323 if (!ASCII_BYTE_P (it
->c
)
22324 && ! it
->multibyte_p
)
22326 if (SINGLE_BYTE_CHAR_P (it
->c
)
22327 && unibyte_display_via_language_environment
)
22329 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
22331 /* get_next_display_element assures that this decoding
22333 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
22334 it
->multibyte_p
= 1;
22335 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
22337 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22341 /* Get font to use. Encode IT->char_to_display. */
22342 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
22343 &char2b
, it
->multibyte_p
, 0);
22346 font_not_found_p
= font
== NULL
;
22347 if (font_not_found_p
)
22349 /* When no suitable font found, display an empty box based
22350 on the metrics of the font of the default face (or what
22352 struct face
*no_font_face
22353 = FACE_FROM_ID (it
->f
,
22354 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22355 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22356 font
= no_font_face
->font
;
22357 boff
= font
->baseline_offset
;
22361 boff
= font
->baseline_offset
;
22362 if (font
->vertical_centering
)
22363 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22366 if (it
->char_to_display
>= ' '
22367 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22369 /* Either unibyte or ASCII. */
22374 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22376 if (it
->override_ascent
>= 0)
22378 it
->ascent
= it
->override_ascent
;
22379 it
->descent
= it
->override_descent
;
22380 boff
= it
->override_boff
;
22384 it
->ascent
= FONT_BASE (font
) + boff
;
22385 it
->descent
= FONT_DESCENT (font
) - boff
;
22390 it
->phys_ascent
= pcm
->ascent
+ boff
;
22391 it
->phys_descent
= pcm
->descent
- boff
;
22392 it
->pixel_width
= pcm
->width
;
22396 it
->glyph_not_available_p
= 1;
22397 it
->phys_ascent
= it
->ascent
;
22398 it
->phys_descent
= it
->descent
;
22399 it
->pixel_width
= FONT_WIDTH (font
);
22402 if (it
->constrain_row_ascent_descent_p
)
22404 if (it
->descent
> it
->max_descent
)
22406 it
->ascent
+= it
->descent
- it
->max_descent
;
22407 it
->descent
= it
->max_descent
;
22409 if (it
->ascent
> it
->max_ascent
)
22411 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22412 it
->ascent
= it
->max_ascent
;
22414 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22415 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22416 extra_line_spacing
= 0;
22419 /* If this is a space inside a region of text with
22420 `space-width' property, change its width. */
22421 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22423 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22425 /* If face has a box, add the box thickness to the character
22426 height. If character has a box line to the left and/or
22427 right, add the box line width to the character's width. */
22428 if (face
->box
!= FACE_NO_BOX
)
22430 int thick
= face
->box_line_width
;
22434 it
->ascent
+= thick
;
22435 it
->descent
+= thick
;
22440 if (it
->start_of_box_run_p
)
22441 it
->pixel_width
+= thick
;
22442 if (it
->end_of_box_run_p
)
22443 it
->pixel_width
+= thick
;
22446 /* If face has an overline, add the height of the overline
22447 (1 pixel) and a 1 pixel margin to the character height. */
22448 if (face
->overline_p
)
22449 it
->ascent
+= overline_margin
;
22451 if (it
->constrain_row_ascent_descent_p
)
22453 if (it
->ascent
> it
->max_ascent
)
22454 it
->ascent
= it
->max_ascent
;
22455 if (it
->descent
> it
->max_descent
)
22456 it
->descent
= it
->max_descent
;
22459 take_vertical_position_into_account (it
);
22461 /* If we have to actually produce glyphs, do it. */
22466 /* Translate a space with a `space-width' property
22467 into a stretch glyph. */
22468 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22469 / FONT_HEIGHT (font
));
22470 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22471 it
->ascent
+ it
->descent
, ascent
);
22476 /* If characters with lbearing or rbearing are displayed
22477 in this line, record that fact in a flag of the
22478 glyph row. This is used to optimize X output code. */
22479 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22480 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22482 if (! stretched_p
&& it
->pixel_width
== 0)
22483 /* We assure that all visible glyphs have at least 1-pixel
22485 it
->pixel_width
= 1;
22487 else if (it
->char_to_display
== '\n')
22489 /* A newline has no width, but we need the height of the
22490 line. But if previous part of the line sets a height,
22491 don't increase that height */
22493 Lisp_Object height
;
22494 Lisp_Object total_height
= Qnil
;
22496 it
->override_ascent
= -1;
22497 it
->pixel_width
= 0;
22500 height
= get_it_property(it
, Qline_height
);
22501 /* Split (line-height total-height) list */
22503 && CONSP (XCDR (height
))
22504 && NILP (XCDR (XCDR (height
))))
22506 total_height
= XCAR (XCDR (height
));
22507 height
= XCAR (height
);
22509 height
= calc_line_height_property(it
, height
, font
, boff
, 1);
22511 if (it
->override_ascent
>= 0)
22513 it
->ascent
= it
->override_ascent
;
22514 it
->descent
= it
->override_descent
;
22515 boff
= it
->override_boff
;
22519 it
->ascent
= FONT_BASE (font
) + boff
;
22520 it
->descent
= FONT_DESCENT (font
) - boff
;
22523 if (EQ (height
, Qt
))
22525 if (it
->descent
> it
->max_descent
)
22527 it
->ascent
+= it
->descent
- it
->max_descent
;
22528 it
->descent
= it
->max_descent
;
22530 if (it
->ascent
> it
->max_ascent
)
22532 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22533 it
->ascent
= it
->max_ascent
;
22535 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22536 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22537 it
->constrain_row_ascent_descent_p
= 1;
22538 extra_line_spacing
= 0;
22542 Lisp_Object spacing
;
22544 it
->phys_ascent
= it
->ascent
;
22545 it
->phys_descent
= it
->descent
;
22547 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22548 && face
->box
!= FACE_NO_BOX
22549 && face
->box_line_width
> 0)
22551 it
->ascent
+= face
->box_line_width
;
22552 it
->descent
+= face
->box_line_width
;
22555 && XINT (height
) > it
->ascent
+ it
->descent
)
22556 it
->ascent
= XINT (height
) - it
->descent
;
22558 if (!NILP (total_height
))
22559 spacing
= calc_line_height_property(it
, total_height
, font
, boff
, 0);
22562 spacing
= get_it_property(it
, Qline_spacing
);
22563 spacing
= calc_line_height_property(it
, spacing
, font
, boff
, 0);
22565 if (INTEGERP (spacing
))
22567 extra_line_spacing
= XINT (spacing
);
22568 if (!NILP (total_height
))
22569 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22573 else if (it
->char_to_display
== '\t')
22575 if (font
->space_width
> 0)
22577 int tab_width
= it
->tab_width
* font
->space_width
;
22578 int x
= it
->current_x
+ it
->continuation_lines_width
;
22579 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22581 /* If the distance from the current position to the next tab
22582 stop is less than a space character width, use the
22583 tab stop after that. */
22584 if (next_tab_x
- x
< font
->space_width
)
22585 next_tab_x
+= tab_width
;
22587 it
->pixel_width
= next_tab_x
- x
;
22589 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22590 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22594 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22595 it
->ascent
+ it
->descent
, it
->ascent
);
22600 it
->pixel_width
= 0;
22606 /* A multi-byte character. Assume that the display width of the
22607 character is the width of the character multiplied by the
22608 width of the font. */
22610 /* If we found a font, this font should give us the right
22611 metrics. If we didn't find a font, use the frame's
22612 default font and calculate the width of the character by
22613 multiplying the width of font by the width of the
22616 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22618 if (font_not_found_p
|| !pcm
)
22620 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22622 if (char_width
== 0)
22623 /* This is a non spacing character. But, as we are
22624 going to display an empty box, the box must occupy
22625 at least one column. */
22627 it
->glyph_not_available_p
= 1;
22628 it
->pixel_width
= font
->space_width
* char_width
;
22629 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22630 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22634 it
->pixel_width
= pcm
->width
;
22635 it
->phys_ascent
= pcm
->ascent
+ boff
;
22636 it
->phys_descent
= pcm
->descent
- boff
;
22638 && (pcm
->lbearing
< 0
22639 || pcm
->rbearing
> pcm
->width
))
22640 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22643 it
->ascent
= FONT_BASE (font
) + boff
;
22644 it
->descent
= FONT_DESCENT (font
) - boff
;
22645 if (face
->box
!= FACE_NO_BOX
)
22647 int thick
= face
->box_line_width
;
22651 it
->ascent
+= thick
;
22652 it
->descent
+= thick
;
22657 if (it
->start_of_box_run_p
)
22658 it
->pixel_width
+= thick
;
22659 if (it
->end_of_box_run_p
)
22660 it
->pixel_width
+= thick
;
22663 /* If face has an overline, add the height of the overline
22664 (1 pixel) and a 1 pixel margin to the character height. */
22665 if (face
->overline_p
)
22666 it
->ascent
+= overline_margin
;
22668 take_vertical_position_into_account (it
);
22670 if (it
->ascent
< 0)
22672 if (it
->descent
< 0)
22677 if (it
->pixel_width
== 0)
22678 /* We assure that all visible glyphs have at least 1-pixel
22680 it
->pixel_width
= 1;
22682 it
->multibyte_p
= saved_multibyte_p
;
22684 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22686 /* A static composition.
22688 Note: A composition is represented as one glyph in the
22689 glyph matrix. There are no padding glyphs.
22691 Important note: pixel_width, ascent, and descent are the
22692 values of what is drawn by draw_glyphs (i.e. the values of
22693 the overall glyphs composed). */
22694 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22695 int boff
; /* baseline offset */
22696 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22697 int glyph_len
= cmp
->glyph_len
;
22698 struct font
*font
= face
->font
;
22702 /* If we have not yet calculated pixel size data of glyphs of
22703 the composition for the current face font, calculate them
22704 now. Theoretically, we have to check all fonts for the
22705 glyphs, but that requires much time and memory space. So,
22706 here we check only the font of the first glyph. This may
22707 lead to incorrect display, but it's very rare, and C-l
22708 (recenter-top-bottom) can correct the display anyway. */
22709 if (! cmp
->font
|| cmp
->font
!= font
)
22711 /* Ascent and descent of the font of the first character
22712 of this composition (adjusted by baseline offset).
22713 Ascent and descent of overall glyphs should not be less
22714 than these, respectively. */
22715 int font_ascent
, font_descent
, font_height
;
22716 /* Bounding box of the overall glyphs. */
22717 int leftmost
, rightmost
, lowest
, highest
;
22718 int lbearing
, rbearing
;
22719 int i
, width
, ascent
, descent
;
22720 int left_padded
= 0, right_padded
= 0;
22723 struct font_metrics
*pcm
;
22724 int font_not_found_p
;
22727 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22728 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22730 if (glyph_len
< cmp
->glyph_len
)
22732 for (i
= 0; i
< glyph_len
; i
++)
22734 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22736 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22741 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22742 : IT_CHARPOS (*it
));
22743 /* If no suitable font is found, use the default font. */
22744 font_not_found_p
= font
== NULL
;
22745 if (font_not_found_p
)
22747 face
= face
->ascii_face
;
22750 boff
= font
->baseline_offset
;
22751 if (font
->vertical_centering
)
22752 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22753 font_ascent
= FONT_BASE (font
) + boff
;
22754 font_descent
= FONT_DESCENT (font
) - boff
;
22755 font_height
= FONT_HEIGHT (font
);
22757 cmp
->font
= (void *) font
;
22760 if (! font_not_found_p
)
22762 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22763 &char2b
, it
->multibyte_p
, 0);
22764 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22767 /* Initialize the bounding box. */
22770 width
= pcm
->width
;
22771 ascent
= pcm
->ascent
;
22772 descent
= pcm
->descent
;
22773 lbearing
= pcm
->lbearing
;
22774 rbearing
= pcm
->rbearing
;
22778 width
= FONT_WIDTH (font
);
22779 ascent
= FONT_BASE (font
);
22780 descent
= FONT_DESCENT (font
);
22787 lowest
= - descent
+ boff
;
22788 highest
= ascent
+ boff
;
22790 if (! font_not_found_p
22791 && font
->default_ascent
22792 && CHAR_TABLE_P (Vuse_default_ascent
)
22793 && !NILP (Faref (Vuse_default_ascent
,
22794 make_number (it
->char_to_display
))))
22795 highest
= font
->default_ascent
+ boff
;
22797 /* Draw the first glyph at the normal position. It may be
22798 shifted to right later if some other glyphs are drawn
22800 cmp
->offsets
[i
* 2] = 0;
22801 cmp
->offsets
[i
* 2 + 1] = boff
;
22802 cmp
->lbearing
= lbearing
;
22803 cmp
->rbearing
= rbearing
;
22805 /* Set cmp->offsets for the remaining glyphs. */
22806 for (i
++; i
< glyph_len
; i
++)
22808 int left
, right
, btm
, top
;
22809 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22811 struct face
*this_face
;
22816 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22817 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22818 font
= this_face
->font
;
22824 this_boff
= font
->baseline_offset
;
22825 if (font
->vertical_centering
)
22826 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22827 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22828 &char2b
, it
->multibyte_p
, 0);
22829 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22832 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22835 width
= pcm
->width
;
22836 ascent
= pcm
->ascent
;
22837 descent
= pcm
->descent
;
22838 lbearing
= pcm
->lbearing
;
22839 rbearing
= pcm
->rbearing
;
22840 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22842 /* Relative composition with or without
22843 alternate chars. */
22844 left
= (leftmost
+ rightmost
- width
) / 2;
22845 btm
= - descent
+ boff
;
22846 if (font
->relative_compose
22847 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22848 || NILP (Faref (Vignore_relative_composition
,
22849 make_number (ch
)))))
22852 if (- descent
>= font
->relative_compose
)
22853 /* One extra pixel between two glyphs. */
22855 else if (ascent
<= 0)
22856 /* One extra pixel between two glyphs. */
22857 btm
= lowest
- 1 - ascent
- descent
;
22862 /* A composition rule is specified by an integer
22863 value that encodes global and new reference
22864 points (GREF and NREF). GREF and NREF are
22865 specified by numbers as below:
22867 0---1---2 -- ascent
22871 9--10--11 -- center
22873 ---3---4---5--- baseline
22875 6---7---8 -- descent
22877 int rule
= COMPOSITION_RULE (cmp
, i
);
22878 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22880 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22881 grefx
= gref
% 3, nrefx
= nref
% 3;
22882 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22884 xoff
= font_height
* (xoff
- 128) / 256;
22886 yoff
= font_height
* (yoff
- 128) / 256;
22889 + grefx
* (rightmost
- leftmost
) / 2
22890 - nrefx
* width
/ 2
22893 btm
= ((grefy
== 0 ? highest
22895 : grefy
== 2 ? lowest
22896 : (highest
+ lowest
) / 2)
22897 - (nrefy
== 0 ? ascent
+ descent
22898 : nrefy
== 1 ? descent
- boff
22900 : (ascent
+ descent
) / 2)
22904 cmp
->offsets
[i
* 2] = left
;
22905 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22907 /* Update the bounding box of the overall glyphs. */
22910 right
= left
+ width
;
22911 if (left
< leftmost
)
22913 if (right
> rightmost
)
22916 top
= btm
+ descent
+ ascent
;
22922 if (cmp
->lbearing
> left
+ lbearing
)
22923 cmp
->lbearing
= left
+ lbearing
;
22924 if (cmp
->rbearing
< left
+ rbearing
)
22925 cmp
->rbearing
= left
+ rbearing
;
22929 /* If there are glyphs whose x-offsets are negative,
22930 shift all glyphs to the right and make all x-offsets
22934 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22935 cmp
->offsets
[i
* 2] -= leftmost
;
22936 rightmost
-= leftmost
;
22937 cmp
->lbearing
-= leftmost
;
22938 cmp
->rbearing
-= leftmost
;
22941 if (left_padded
&& cmp
->lbearing
< 0)
22943 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22944 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22945 rightmost
-= cmp
->lbearing
;
22946 cmp
->rbearing
-= cmp
->lbearing
;
22949 if (right_padded
&& rightmost
< cmp
->rbearing
)
22951 rightmost
= cmp
->rbearing
;
22954 cmp
->pixel_width
= rightmost
;
22955 cmp
->ascent
= highest
;
22956 cmp
->descent
= - lowest
;
22957 if (cmp
->ascent
< font_ascent
)
22958 cmp
->ascent
= font_ascent
;
22959 if (cmp
->descent
< font_descent
)
22960 cmp
->descent
= font_descent
;
22964 && (cmp
->lbearing
< 0
22965 || cmp
->rbearing
> cmp
->pixel_width
))
22966 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22968 it
->pixel_width
= cmp
->pixel_width
;
22969 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22970 it
->descent
= it
->phys_descent
= cmp
->descent
;
22971 if (face
->box
!= FACE_NO_BOX
)
22973 int thick
= face
->box_line_width
;
22977 it
->ascent
+= thick
;
22978 it
->descent
+= thick
;
22983 if (it
->start_of_box_run_p
)
22984 it
->pixel_width
+= thick
;
22985 if (it
->end_of_box_run_p
)
22986 it
->pixel_width
+= thick
;
22989 /* If face has an overline, add the height of the overline
22990 (1 pixel) and a 1 pixel margin to the character height. */
22991 if (face
->overline_p
)
22992 it
->ascent
+= overline_margin
;
22994 take_vertical_position_into_account (it
);
22995 if (it
->ascent
< 0)
22997 if (it
->descent
< 0)
23001 append_composite_glyph (it
);
23003 else if (it
->what
== IT_COMPOSITION
)
23005 /* A dynamic (automatic) composition. */
23006 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23007 Lisp_Object gstring
;
23008 struct font_metrics metrics
;
23010 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
23012 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
23015 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
23016 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23017 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
23018 it
->descent
= it
->phys_descent
= metrics
.descent
;
23019 if (face
->box
!= FACE_NO_BOX
)
23021 int thick
= face
->box_line_width
;
23025 it
->ascent
+= thick
;
23026 it
->descent
+= thick
;
23031 if (it
->start_of_box_run_p
)
23032 it
->pixel_width
+= thick
;
23033 if (it
->end_of_box_run_p
)
23034 it
->pixel_width
+= thick
;
23036 /* If face has an overline, add the height of the overline
23037 (1 pixel) and a 1 pixel margin to the character height. */
23038 if (face
->overline_p
)
23039 it
->ascent
+= overline_margin
;
23040 take_vertical_position_into_account (it
);
23041 if (it
->ascent
< 0)
23043 if (it
->descent
< 0)
23047 append_composite_glyph (it
);
23049 else if (it
->what
== IT_IMAGE
)
23050 produce_image_glyph (it
);
23051 else if (it
->what
== IT_STRETCH
)
23052 produce_stretch_glyph (it
);
23054 /* Accumulate dimensions. Note: can't assume that it->descent > 0
23055 because this isn't true for images with `:ascent 100'. */
23056 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
23057 if (it
->area
== TEXT_AREA
)
23058 it
->current_x
+= it
->pixel_width
;
23060 if (extra_line_spacing
> 0)
23062 it
->descent
+= extra_line_spacing
;
23063 if (extra_line_spacing
> it
->max_extra_line_spacing
)
23064 it
->max_extra_line_spacing
= extra_line_spacing
;
23067 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
23068 it
->max_descent
= max (it
->max_descent
, it
->descent
);
23069 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
23070 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
23074 Output LEN glyphs starting at START at the nominal cursor position.
23075 Advance the nominal cursor over the text. The global variable
23076 updated_window contains the window being updated, updated_row is
23077 the glyph row being updated, and updated_area is the area of that
23078 row being updated. */
23081 x_write_glyphs (start
, len
)
23082 struct glyph
*start
;
23087 xassert (updated_window
&& updated_row
);
23090 /* Write glyphs. */
23092 hpos
= start
- updated_row
->glyphs
[updated_area
];
23093 x
= draw_glyphs (updated_window
, output_cursor
.x
,
23094 updated_row
, updated_area
,
23096 DRAW_NORMAL_TEXT
, 0);
23098 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
23099 if (updated_area
== TEXT_AREA
23100 && updated_window
->phys_cursor_on_p
23101 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
23102 && updated_window
->phys_cursor
.hpos
>= hpos
23103 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
23104 updated_window
->phys_cursor_on_p
= 0;
23108 /* Advance the output cursor. */
23109 output_cursor
.hpos
+= len
;
23110 output_cursor
.x
= x
;
23115 Insert LEN glyphs from START at the nominal cursor position. */
23118 x_insert_glyphs (start
, len
)
23119 struct glyph
*start
;
23124 int line_height
, shift_by_width
, shifted_region_width
;
23125 struct glyph_row
*row
;
23126 struct glyph
*glyph
;
23127 int frame_x
, frame_y
;
23130 xassert (updated_window
&& updated_row
);
23132 w
= updated_window
;
23133 f
= XFRAME (WINDOW_FRAME (w
));
23135 /* Get the height of the line we are in. */
23137 line_height
= row
->height
;
23139 /* Get the width of the glyphs to insert. */
23140 shift_by_width
= 0;
23141 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
23142 shift_by_width
+= glyph
->pixel_width
;
23144 /* Get the width of the region to shift right. */
23145 shifted_region_width
= (window_box_width (w
, updated_area
)
23150 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
23151 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
23153 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
23154 line_height
, shift_by_width
);
23156 /* Write the glyphs. */
23157 hpos
= start
- row
->glyphs
[updated_area
];
23158 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
23160 DRAW_NORMAL_TEXT
, 0);
23162 /* Advance the output cursor. */
23163 output_cursor
.hpos
+= len
;
23164 output_cursor
.x
+= shift_by_width
;
23170 Erase the current text line from the nominal cursor position
23171 (inclusive) to pixel column TO_X (exclusive). The idea is that
23172 everything from TO_X onward is already erased.
23174 TO_X is a pixel position relative to updated_area of
23175 updated_window. TO_X == -1 means clear to the end of this area. */
23178 x_clear_end_of_line (to_x
)
23182 struct window
*w
= updated_window
;
23183 int max_x
, min_y
, max_y
;
23184 int from_x
, from_y
, to_y
;
23186 xassert (updated_window
&& updated_row
);
23187 f
= XFRAME (w
->frame
);
23189 if (updated_row
->full_width_p
)
23190 max_x
= WINDOW_TOTAL_WIDTH (w
);
23192 max_x
= window_box_width (w
, updated_area
);
23193 max_y
= window_text_bottom_y (w
);
23195 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
23196 of window. For TO_X > 0, truncate to end of drawing area. */
23202 to_x
= min (to_x
, max_x
);
23204 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
23206 /* Notice if the cursor will be cleared by this operation. */
23207 if (!updated_row
->full_width_p
)
23208 notice_overwritten_cursor (w
, updated_area
,
23209 output_cursor
.x
, -1,
23211 MATRIX_ROW_BOTTOM_Y (updated_row
));
23213 from_x
= output_cursor
.x
;
23215 /* Translate to frame coordinates. */
23216 if (updated_row
->full_width_p
)
23218 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23219 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23223 int area_left
= window_box_left (w
, updated_area
);
23224 from_x
+= area_left
;
23228 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23229 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23230 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23232 /* Prevent inadvertently clearing to end of the X window. */
23233 if (to_x
> from_x
&& to_y
> from_y
)
23236 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23237 to_x
- from_x
, to_y
- from_y
);
23242 #endif /* HAVE_WINDOW_SYSTEM */
23246 /***********************************************************************
23248 ***********************************************************************/
23250 /* Value is the internal representation of the specified cursor type
23251 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23252 of the bar cursor. */
23254 static enum text_cursor_kinds
23255 get_specified_cursor_type (arg
, width
)
23259 enum text_cursor_kinds type
;
23264 if (EQ (arg
, Qbox
))
23265 return FILLED_BOX_CURSOR
;
23267 if (EQ (arg
, Qhollow
))
23268 return HOLLOW_BOX_CURSOR
;
23270 if (EQ (arg
, Qbar
))
23277 && EQ (XCAR (arg
), Qbar
)
23278 && INTEGERP (XCDR (arg
))
23279 && XINT (XCDR (arg
)) >= 0)
23281 *width
= XINT (XCDR (arg
));
23285 if (EQ (arg
, Qhbar
))
23288 return HBAR_CURSOR
;
23292 && EQ (XCAR (arg
), Qhbar
)
23293 && INTEGERP (XCDR (arg
))
23294 && XINT (XCDR (arg
)) >= 0)
23296 *width
= XINT (XCDR (arg
));
23297 return HBAR_CURSOR
;
23300 /* Treat anything unknown as "hollow box cursor".
23301 It was bad to signal an error; people have trouble fixing
23302 .Xdefaults with Emacs, when it has something bad in it. */
23303 type
= HOLLOW_BOX_CURSOR
;
23308 /* Set the default cursor types for specified frame. */
23310 set_frame_cursor_types (f
, arg
)
23317 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23318 FRAME_CURSOR_WIDTH (f
) = width
;
23320 /* By default, set up the blink-off state depending on the on-state. */
23322 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23325 FRAME_BLINK_OFF_CURSOR (f
)
23326 = get_specified_cursor_type (XCDR (tem
), &width
);
23327 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23330 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23334 /* Return the cursor we want to be displayed in window W. Return
23335 width of bar/hbar cursor through WIDTH arg. Return with
23336 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23337 (i.e. if the `system caret' should track this cursor).
23339 In a mini-buffer window, we want the cursor only to appear if we
23340 are reading input from this window. For the selected window, we
23341 want the cursor type given by the frame parameter or buffer local
23342 setting of cursor-type. If explicitly marked off, draw no cursor.
23343 In all other cases, we want a hollow box cursor. */
23345 static enum text_cursor_kinds
23346 get_window_cursor_type (w
, glyph
, width
, active_cursor
)
23348 struct glyph
*glyph
;
23350 int *active_cursor
;
23352 struct frame
*f
= XFRAME (w
->frame
);
23353 struct buffer
*b
= XBUFFER (w
->buffer
);
23354 int cursor_type
= DEFAULT_CURSOR
;
23355 Lisp_Object alt_cursor
;
23356 int non_selected
= 0;
23358 *active_cursor
= 1;
23361 if (cursor_in_echo_area
23362 && FRAME_HAS_MINIBUF_P (f
)
23363 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23365 if (w
== XWINDOW (echo_area_window
))
23367 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23369 *width
= FRAME_CURSOR_WIDTH (f
);
23370 return FRAME_DESIRED_CURSOR (f
);
23373 return get_specified_cursor_type (b
->cursor_type
, width
);
23376 *active_cursor
= 0;
23380 /* Detect a nonselected window or nonselected frame. */
23381 else if (w
!= XWINDOW (f
->selected_window
)
23382 #ifdef HAVE_WINDOW_SYSTEM
23383 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23387 *active_cursor
= 0;
23389 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23395 /* Never display a cursor in a window in which cursor-type is nil. */
23396 if (NILP (b
->cursor_type
))
23399 /* Get the normal cursor type for this window. */
23400 if (EQ (b
->cursor_type
, Qt
))
23402 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23403 *width
= FRAME_CURSOR_WIDTH (f
);
23406 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23408 /* Use cursor-in-non-selected-windows instead
23409 for non-selected window or frame. */
23412 alt_cursor
= b
->cursor_in_non_selected_windows
;
23413 if (!EQ (Qt
, alt_cursor
))
23414 return get_specified_cursor_type (alt_cursor
, width
);
23415 /* t means modify the normal cursor type. */
23416 if (cursor_type
== FILLED_BOX_CURSOR
)
23417 cursor_type
= HOLLOW_BOX_CURSOR
;
23418 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23420 return cursor_type
;
23423 /* Use normal cursor if not blinked off. */
23424 if (!w
->cursor_off_p
)
23426 #ifdef HAVE_WINDOW_SYSTEM
23427 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23429 if (cursor_type
== FILLED_BOX_CURSOR
)
23431 /* Using a block cursor on large images can be very annoying.
23432 So use a hollow cursor for "large" images.
23433 If image is not transparent (no mask), also use hollow cursor. */
23434 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23435 if (img
!= NULL
&& IMAGEP (img
->spec
))
23437 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23438 where N = size of default frame font size.
23439 This should cover most of the "tiny" icons people may use. */
23441 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23442 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23443 cursor_type
= HOLLOW_BOX_CURSOR
;
23446 else if (cursor_type
!= NO_CURSOR
)
23448 /* Display current only supports BOX and HOLLOW cursors for images.
23449 So for now, unconditionally use a HOLLOW cursor when cursor is
23450 not a solid box cursor. */
23451 cursor_type
= HOLLOW_BOX_CURSOR
;
23455 return cursor_type
;
23458 /* Cursor is blinked off, so determine how to "toggle" it. */
23460 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23461 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23462 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23464 /* Then see if frame has specified a specific blink off cursor type. */
23465 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23467 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23468 return FRAME_BLINK_OFF_CURSOR (f
);
23472 /* Some people liked having a permanently visible blinking cursor,
23473 while others had very strong opinions against it. So it was
23474 decided to remove it. KFS 2003-09-03 */
23476 /* Finally perform built-in cursor blinking:
23477 filled box <-> hollow box
23478 wide [h]bar <-> narrow [h]bar
23479 narrow [h]bar <-> no cursor
23480 other type <-> no cursor */
23482 if (cursor_type
== FILLED_BOX_CURSOR
)
23483 return HOLLOW_BOX_CURSOR
;
23485 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23488 return cursor_type
;
23496 #ifdef HAVE_WINDOW_SYSTEM
23498 /* Notice when the text cursor of window W has been completely
23499 overwritten by a drawing operation that outputs glyphs in AREA
23500 starting at X0 and ending at X1 in the line starting at Y0 and
23501 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23502 the rest of the line after X0 has been written. Y coordinates
23503 are window-relative. */
23506 notice_overwritten_cursor (w
, area
, x0
, x1
, y0
, y1
)
23508 enum glyph_row_area area
;
23509 int x0
, y0
, x1
, y1
;
23511 int cx0
, cx1
, cy0
, cy1
;
23512 struct glyph_row
*row
;
23514 if (!w
->phys_cursor_on_p
)
23516 if (area
!= TEXT_AREA
)
23519 if (w
->phys_cursor
.vpos
< 0
23520 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23521 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23522 !(row
->enabled_p
&& row
->displays_text_p
)))
23525 if (row
->cursor_in_fringe_p
)
23527 row
->cursor_in_fringe_p
= 0;
23528 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23529 w
->phys_cursor_on_p
= 0;
23533 cx0
= w
->phys_cursor
.x
;
23534 cx1
= cx0
+ w
->phys_cursor_width
;
23535 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23538 /* The cursor image will be completely removed from the
23539 screen if the output area intersects the cursor area in
23540 y-direction. When we draw in [y0 y1[, and some part of
23541 the cursor is at y < y0, that part must have been drawn
23542 before. When scrolling, the cursor is erased before
23543 actually scrolling, so we don't come here. When not
23544 scrolling, the rows above the old cursor row must have
23545 changed, and in this case these rows must have written
23546 over the cursor image.
23548 Likewise if part of the cursor is below y1, with the
23549 exception of the cursor being in the first blank row at
23550 the buffer and window end because update_text_area
23551 doesn't draw that row. (Except when it does, but
23552 that's handled in update_text_area.) */
23554 cy0
= w
->phys_cursor
.y
;
23555 cy1
= cy0
+ w
->phys_cursor_height
;
23556 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23559 w
->phys_cursor_on_p
= 0;
23562 #endif /* HAVE_WINDOW_SYSTEM */
23565 /************************************************************************
23567 ************************************************************************/
23569 #ifdef HAVE_WINDOW_SYSTEM
23572 Fix the display of area AREA of overlapping row ROW in window W
23573 with respect to the overlapping part OVERLAPS. */
23576 x_fix_overlapping_area (w
, row
, area
, overlaps
)
23578 struct glyph_row
*row
;
23579 enum glyph_row_area area
;
23587 for (i
= 0; i
< row
->used
[area
];)
23589 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23591 int start
= i
, start_x
= x
;
23595 x
+= row
->glyphs
[area
][i
].pixel_width
;
23598 while (i
< row
->used
[area
]
23599 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23601 draw_glyphs (w
, start_x
, row
, area
,
23603 DRAW_NORMAL_TEXT
, overlaps
);
23607 x
+= row
->glyphs
[area
][i
].pixel_width
;
23617 Draw the cursor glyph of window W in glyph row ROW. See the
23618 comment of draw_glyphs for the meaning of HL. */
23621 draw_phys_cursor_glyph (w
, row
, hl
)
23623 struct glyph_row
*row
;
23624 enum draw_glyphs_face hl
;
23626 /* If cursor hpos is out of bounds, don't draw garbage. This can
23627 happen in mini-buffer windows when switching between echo area
23628 glyphs and mini-buffer. */
23629 if ((row
->reversed_p
23630 ? (w
->phys_cursor
.hpos
>= 0)
23631 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23633 int on_p
= w
->phys_cursor_on_p
;
23635 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23636 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23638 w
->phys_cursor_on_p
= on_p
;
23640 if (hl
== DRAW_CURSOR
)
23641 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23642 /* When we erase the cursor, and ROW is overlapped by other
23643 rows, make sure that these overlapping parts of other rows
23645 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23647 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23649 if (row
> w
->current_matrix
->rows
23650 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23651 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23652 OVERLAPS_ERASED_CURSOR
);
23654 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23655 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23656 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23657 OVERLAPS_ERASED_CURSOR
);
23664 Erase the image of a cursor of window W from the screen. */
23667 erase_phys_cursor (w
)
23670 struct frame
*f
= XFRAME (w
->frame
);
23671 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23672 int hpos
= w
->phys_cursor
.hpos
;
23673 int vpos
= w
->phys_cursor
.vpos
;
23674 int mouse_face_here_p
= 0;
23675 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23676 struct glyph_row
*cursor_row
;
23677 struct glyph
*cursor_glyph
;
23678 enum draw_glyphs_face hl
;
23680 /* No cursor displayed or row invalidated => nothing to do on the
23682 if (w
->phys_cursor_type
== NO_CURSOR
)
23683 goto mark_cursor_off
;
23685 /* VPOS >= active_glyphs->nrows means that window has been resized.
23686 Don't bother to erase the cursor. */
23687 if (vpos
>= active_glyphs
->nrows
)
23688 goto mark_cursor_off
;
23690 /* If row containing cursor is marked invalid, there is nothing we
23692 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23693 if (!cursor_row
->enabled_p
)
23694 goto mark_cursor_off
;
23696 /* If line spacing is > 0, old cursor may only be partially visible in
23697 window after split-window. So adjust visible height. */
23698 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23699 window_text_bottom_y (w
) - cursor_row
->y
);
23701 /* If row is completely invisible, don't attempt to delete a cursor which
23702 isn't there. This can happen if cursor is at top of a window, and
23703 we switch to a buffer with a header line in that window. */
23704 if (cursor_row
->visible_height
<= 0)
23705 goto mark_cursor_off
;
23707 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23708 if (cursor_row
->cursor_in_fringe_p
)
23710 cursor_row
->cursor_in_fringe_p
= 0;
23711 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23712 goto mark_cursor_off
;
23715 /* This can happen when the new row is shorter than the old one.
23716 In this case, either draw_glyphs or clear_end_of_line
23717 should have cleared the cursor. Note that we wouldn't be
23718 able to erase the cursor in this case because we don't have a
23719 cursor glyph at hand. */
23720 if ((cursor_row
->reversed_p
23721 ? (w
->phys_cursor
.hpos
< 0)
23722 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23723 goto mark_cursor_off
;
23725 /* If the cursor is in the mouse face area, redisplay that when
23726 we clear the cursor. */
23727 if (! NILP (dpyinfo
->mouse_face_window
)
23728 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23729 && (vpos
> dpyinfo
->mouse_face_beg_row
23730 || (vpos
== dpyinfo
->mouse_face_beg_row
23731 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23732 && (vpos
< dpyinfo
->mouse_face_end_row
23733 || (vpos
== dpyinfo
->mouse_face_end_row
23734 && hpos
< dpyinfo
->mouse_face_end_col
))
23735 /* Don't redraw the cursor's spot in mouse face if it is at the
23736 end of a line (on a newline). The cursor appears there, but
23737 mouse highlighting does not. */
23738 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23739 mouse_face_here_p
= 1;
23741 /* Maybe clear the display under the cursor. */
23742 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23745 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23748 cursor_glyph
= get_phys_cursor_glyph (w
);
23749 if (cursor_glyph
== NULL
)
23750 goto mark_cursor_off
;
23752 width
= cursor_glyph
->pixel_width
;
23753 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23754 x
= w
->phys_cursor
.x
;
23756 width
-= left_x
- x
;
23757 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23758 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23759 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23762 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23765 /* Erase the cursor by redrawing the character underneath it. */
23766 if (mouse_face_here_p
)
23767 hl
= DRAW_MOUSE_FACE
;
23769 hl
= DRAW_NORMAL_TEXT
;
23770 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23773 w
->phys_cursor_on_p
= 0;
23774 w
->phys_cursor_type
= NO_CURSOR
;
23779 Display or clear cursor of window W. If ON is zero, clear the
23780 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23781 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23784 display_and_set_cursor (w
, on
, hpos
, vpos
, x
, y
)
23786 int on
, hpos
, vpos
, x
, y
;
23788 struct frame
*f
= XFRAME (w
->frame
);
23789 int new_cursor_type
;
23790 int new_cursor_width
;
23792 struct glyph_row
*glyph_row
;
23793 struct glyph
*glyph
;
23795 /* This is pointless on invisible frames, and dangerous on garbaged
23796 windows and frames; in the latter case, the frame or window may
23797 be in the midst of changing its size, and x and y may be off the
23799 if (! FRAME_VISIBLE_P (f
)
23800 || FRAME_GARBAGED_P (f
)
23801 || vpos
>= w
->current_matrix
->nrows
23802 || hpos
>= w
->current_matrix
->matrix_w
)
23805 /* If cursor is off and we want it off, return quickly. */
23806 if (!on
&& !w
->phys_cursor_on_p
)
23809 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23810 /* If cursor row is not enabled, we don't really know where to
23811 display the cursor. */
23812 if (!glyph_row
->enabled_p
)
23814 w
->phys_cursor_on_p
= 0;
23819 if (!glyph_row
->exact_window_width_line_p
23820 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23821 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23823 xassert (interrupt_input_blocked
);
23825 /* Set new_cursor_type to the cursor we want to be displayed. */
23826 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23827 &new_cursor_width
, &active_cursor
);
23829 /* If cursor is currently being shown and we don't want it to be or
23830 it is in the wrong place, or the cursor type is not what we want,
23832 if (w
->phys_cursor_on_p
23834 || w
->phys_cursor
.x
!= x
23835 || w
->phys_cursor
.y
!= y
23836 || new_cursor_type
!= w
->phys_cursor_type
23837 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23838 && new_cursor_width
!= w
->phys_cursor_width
)))
23839 erase_phys_cursor (w
);
23841 /* Don't check phys_cursor_on_p here because that flag is only set
23842 to zero in some cases where we know that the cursor has been
23843 completely erased, to avoid the extra work of erasing the cursor
23844 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23845 still not be visible, or it has only been partly erased. */
23848 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23849 w
->phys_cursor_height
= glyph_row
->height
;
23851 /* Set phys_cursor_.* before x_draw_.* is called because some
23852 of them may need the information. */
23853 w
->phys_cursor
.x
= x
;
23854 w
->phys_cursor
.y
= glyph_row
->y
;
23855 w
->phys_cursor
.hpos
= hpos
;
23856 w
->phys_cursor
.vpos
= vpos
;
23859 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23860 new_cursor_type
, new_cursor_width
,
23861 on
, active_cursor
);
23865 /* Switch the display of W's cursor on or off, according to the value
23869 update_window_cursor (w
, on
)
23873 /* Don't update cursor in windows whose frame is in the process
23874 of being deleted. */
23875 if (w
->current_matrix
)
23878 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23879 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23885 /* Call update_window_cursor with parameter ON_P on all leaf windows
23886 in the window tree rooted at W. */
23889 update_cursor_in_window_tree (w
, on_p
)
23895 if (!NILP (w
->hchild
))
23896 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23897 else if (!NILP (w
->vchild
))
23898 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23900 update_window_cursor (w
, on_p
);
23902 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23908 Display the cursor on window W, or clear it, according to ON_P.
23909 Don't change the cursor's position. */
23912 x_update_cursor (f
, on_p
)
23916 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23921 Clear the cursor of window W to background color, and mark the
23922 cursor as not shown. This is used when the text where the cursor
23923 is about to be rewritten. */
23929 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23930 update_window_cursor (w
, 0);
23935 Display the active region described by mouse_face_* according to DRAW. */
23938 show_mouse_face (dpyinfo
, draw
)
23939 Display_Info
*dpyinfo
;
23940 enum draw_glyphs_face draw
;
23942 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23943 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23945 if (/* If window is in the process of being destroyed, don't bother
23947 w
->current_matrix
!= NULL
23948 /* Don't update mouse highlight if hidden */
23949 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23950 /* Recognize when we are called to operate on rows that don't exist
23951 anymore. This can happen when a window is split. */
23952 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23954 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23955 struct glyph_row
*row
, *first
, *last
;
23957 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23958 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23960 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23962 int start_hpos
, end_hpos
, start_x
;
23964 /* For all but the first row, the highlight starts at column 0. */
23967 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23968 start_x
= dpyinfo
->mouse_face_beg_x
;
23977 end_hpos
= dpyinfo
->mouse_face_end_col
;
23980 end_hpos
= row
->used
[TEXT_AREA
];
23981 if (draw
== DRAW_NORMAL_TEXT
)
23982 row
->fill_line_p
= 1; /* Clear to end of line */
23985 if (end_hpos
> start_hpos
)
23987 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23988 start_hpos
, end_hpos
,
23992 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23996 /* When we've written over the cursor, arrange for it to
23997 be displayed again. */
23998 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
24001 display_and_set_cursor (w
, 1,
24002 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24003 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24008 /* Change the mouse cursor. */
24009 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
24010 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
24011 else if (draw
== DRAW_MOUSE_FACE
)
24012 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
24014 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
24018 Clear out the mouse-highlighted active region.
24019 Redraw it un-highlighted first. Value is non-zero if mouse
24020 face was actually drawn unhighlighted. */
24023 clear_mouse_face (dpyinfo
)
24024 Display_Info
*dpyinfo
;
24028 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
24030 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
24034 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24035 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
24036 dpyinfo
->mouse_face_window
= Qnil
;
24037 dpyinfo
->mouse_face_overlay
= Qnil
;
24043 Non-zero if physical cursor of window W is within mouse face. */
24046 cursor_in_mouse_face_p (w
)
24049 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24050 int in_mouse_face
= 0;
24052 if (WINDOWP (dpyinfo
->mouse_face_window
)
24053 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
24055 int hpos
= w
->phys_cursor
.hpos
;
24056 int vpos
= w
->phys_cursor
.vpos
;
24058 if (vpos
>= dpyinfo
->mouse_face_beg_row
24059 && vpos
<= dpyinfo
->mouse_face_end_row
24060 && (vpos
> dpyinfo
->mouse_face_beg_row
24061 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24062 && (vpos
< dpyinfo
->mouse_face_end_row
24063 || hpos
< dpyinfo
->mouse_face_end_col
24064 || dpyinfo
->mouse_face_past_end
))
24068 return in_mouse_face
;
24074 /* This function sets the mouse_face_* elements of DPYINFO, assuming
24075 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
24076 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
24077 for the overlay or run of text properties specifying the mouse
24078 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
24079 before-string and after-string that must also be highlighted.
24080 DISPLAY_STRING, if non-nil, is a display string that may cover some
24081 or all of the highlighted text. */
24084 mouse_face_from_buffer_pos (Lisp_Object window
,
24085 Display_Info
*dpyinfo
,
24086 EMACS_INT mouse_charpos
,
24087 EMACS_INT start_charpos
,
24088 EMACS_INT end_charpos
,
24089 Lisp_Object before_string
,
24090 Lisp_Object after_string
,
24091 Lisp_Object display_string
)
24093 struct window
*w
= XWINDOW (window
);
24094 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24095 struct glyph_row
*row
;
24096 struct glyph
*glyph
, *end
;
24100 xassert (NILP (display_string
) || STRINGP (display_string
));
24101 xassert (NILP (before_string
) || STRINGP (before_string
));
24102 xassert (NILP (after_string
) || STRINGP (after_string
));
24104 /* Find the first highlighted glyph. */
24105 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
24107 dpyinfo
->mouse_face_beg_col
= 0;
24108 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
24109 dpyinfo
->mouse_face_beg_x
= first
->x
;
24110 dpyinfo
->mouse_face_beg_y
= first
->y
;
24114 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
24116 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24118 /* If the before-string or display-string contains newlines,
24119 row_containing_pos skips to its last row. Move back. */
24120 if (!NILP (before_string
) || !NILP (display_string
))
24122 struct glyph_row
*prev
;
24123 while ((prev
= row
- 1, prev
>= first
)
24124 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
24125 && prev
->used
[TEXT_AREA
] > 0)
24127 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
24128 glyph
= beg
+ prev
->used
[TEXT_AREA
];
24129 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
24131 || !(EQ (glyph
->object
, before_string
)
24132 || EQ (glyph
->object
, display_string
)))
24138 glyph
= row
->glyphs
[TEXT_AREA
];
24139 end
= glyph
+ row
->used
[TEXT_AREA
];
24141 dpyinfo
->mouse_face_beg_y
= row
->y
;
24142 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24144 /* Skip truncation glyphs at the start of the glyph row. */
24145 if (row
->displays_text_p
)
24147 && INTEGERP (glyph
->object
)
24148 && glyph
->charpos
< 0;
24150 x
+= glyph
->pixel_width
;
24152 /* Scan the glyph row, stopping before BEFORE_STRING or
24153 DISPLAY_STRING or START_CHARPOS. */
24155 && !INTEGERP (glyph
->object
)
24156 && !EQ (glyph
->object
, before_string
)
24157 && !EQ (glyph
->object
, display_string
)
24158 && !(BUFFERP (glyph
->object
)
24159 && glyph
->charpos
>= start_charpos
);
24161 x
+= glyph
->pixel_width
;
24163 dpyinfo
->mouse_face_beg_x
= x
;
24164 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24167 /* Find the last highlighted glyph. */
24168 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
24171 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24172 dpyinfo
->mouse_face_past_end
= 1;
24174 else if (!NILP (after_string
))
24176 /* If the after-string has newlines, advance to its last row. */
24177 struct glyph_row
*next
;
24178 struct glyph_row
*last
24179 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
24181 for (next
= row
+ 1;
24183 && next
->used
[TEXT_AREA
] > 0
24184 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
24189 glyph
= row
->glyphs
[TEXT_AREA
];
24190 end
= glyph
+ row
->used
[TEXT_AREA
];
24192 dpyinfo
->mouse_face_end_y
= row
->y
;
24193 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24195 /* Skip truncation glyphs at the start of the row. */
24196 if (row
->displays_text_p
)
24198 && INTEGERP (glyph
->object
)
24199 && glyph
->charpos
< 0;
24201 x
+= glyph
->pixel_width
;
24203 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
24206 && !INTEGERP (glyph
->object
)
24207 && !EQ (glyph
->object
, after_string
)
24208 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
24210 x
+= glyph
->pixel_width
;
24212 /* If we found AFTER_STRING, consume it and stop. */
24213 if (EQ (glyph
->object
, after_string
))
24215 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
24216 x
+= glyph
->pixel_width
;
24220 /* If there's no after-string, we must check if we overshot,
24221 which might be the case if we stopped after a string glyph.
24222 That glyph may belong to a before-string or display-string
24223 associated with the end position, which must not be
24225 Lisp_Object prev_object
;
24228 while (glyph
> row
->glyphs
[TEXT_AREA
])
24230 prev_object
= (glyph
- 1)->object
;
24231 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
24234 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
24235 if (pos
&& pos
< end_charpos
)
24238 for (; glyph
> row
->glyphs
[TEXT_AREA
]
24239 && EQ ((glyph
- 1)->object
, prev_object
);
24241 x
-= (glyph
- 1)->pixel_width
;
24245 dpyinfo
->mouse_face_end_x
= x
;
24246 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24247 dpyinfo
->mouse_face_window
= window
;
24248 dpyinfo
->mouse_face_face_id
24249 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24251 !dpyinfo
->mouse_face_hidden
, -1);
24252 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24256 /* Find the position of the glyph for position POS in OBJECT in
24257 window W's current matrix, and return in *X, *Y the pixel
24258 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24260 RIGHT_P non-zero means return the position of the right edge of the
24261 glyph, RIGHT_P zero means return the left edge position.
24263 If no glyph for POS exists in the matrix, return the position of
24264 the glyph with the next smaller position that is in the matrix, if
24265 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24266 exists in the matrix, return the position of the glyph with the
24267 next larger position in OBJECT.
24269 Value is non-zero if a glyph was found. */
24272 fast_find_string_pos (w
, pos
, object
, hpos
, vpos
, x
, y
, right_p
)
24275 Lisp_Object object
;
24276 int *hpos
, *vpos
, *x
, *y
;
24279 int yb
= window_text_bottom_y (w
);
24280 struct glyph_row
*r
;
24281 struct glyph
*best_glyph
= NULL
;
24282 struct glyph_row
*best_row
= NULL
;
24285 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24286 r
->enabled_p
&& r
->y
< yb
;
24289 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24290 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24293 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24294 if (EQ (g
->object
, object
))
24296 if (g
->charpos
== pos
)
24303 else if (best_glyph
== NULL
24304 || ((eabs (g
->charpos
- pos
)
24305 < eabs (best_glyph
->charpos
- pos
))
24308 : g
->charpos
> pos
)))
24322 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24326 *x
+= best_glyph
->pixel_width
;
24331 *vpos
= best_row
- w
->current_matrix
->rows
;
24334 return best_glyph
!= NULL
;
24338 /* See if position X, Y is within a hot-spot of an image. */
24341 on_hot_spot_p (hot_spot
, x
, y
)
24342 Lisp_Object hot_spot
;
24345 if (!CONSP (hot_spot
))
24348 if (EQ (XCAR (hot_spot
), Qrect
))
24350 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24351 Lisp_Object rect
= XCDR (hot_spot
);
24355 if (!CONSP (XCAR (rect
)))
24357 if (!CONSP (XCDR (rect
)))
24359 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24361 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24363 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24365 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24369 else if (EQ (XCAR (hot_spot
), Qcircle
))
24371 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24372 Lisp_Object circ
= XCDR (hot_spot
);
24373 Lisp_Object lr
, lx0
, ly0
;
24375 && CONSP (XCAR (circ
))
24376 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24377 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24378 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24380 double r
= XFLOATINT (lr
);
24381 double dx
= XINT (lx0
) - x
;
24382 double dy
= XINT (ly0
) - y
;
24383 return (dx
* dx
+ dy
* dy
<= r
* r
);
24386 else if (EQ (XCAR (hot_spot
), Qpoly
))
24388 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24389 if (VECTORP (XCDR (hot_spot
)))
24391 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24392 Lisp_Object
*poly
= v
->contents
;
24396 Lisp_Object lx
, ly
;
24399 /* Need an even number of coordinates, and at least 3 edges. */
24400 if (n
< 6 || n
& 1)
24403 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24404 If count is odd, we are inside polygon. Pixels on edges
24405 may or may not be included depending on actual geometry of the
24407 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24408 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24410 x0
= XINT (lx
), y0
= XINT (ly
);
24411 for (i
= 0; i
< n
; i
+= 2)
24413 int x1
= x0
, y1
= y0
;
24414 if ((lx
= poly
[i
], !INTEGERP (lx
))
24415 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24417 x0
= XINT (lx
), y0
= XINT (ly
);
24419 /* Does this segment cross the X line? */
24427 if (y
> y0
&& y
> y1
)
24429 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24439 find_hot_spot (map
, x
, y
)
24443 while (CONSP (map
))
24445 if (CONSP (XCAR (map
))
24446 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24454 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24456 doc
: /* Lookup in image map MAP coordinates X and Y.
24457 An image map is an alist where each element has the format (AREA ID PLIST).
24458 An AREA is specified as either a rectangle, a circle, or a polygon:
24459 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24460 pixel coordinates of the upper left and bottom right corners.
24461 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24462 and the radius of the circle; r may be a float or integer.
24463 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24464 vector describes one corner in the polygon.
24465 Returns the alist element for the first matching AREA in MAP. */)
24476 return find_hot_spot (map
, XINT (x
), XINT (y
));
24480 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24482 define_frame_cursor1 (f
, cursor
, pointer
)
24485 Lisp_Object pointer
;
24487 /* Do not change cursor shape while dragging mouse. */
24488 if (!NILP (do_mouse_tracking
))
24491 if (!NILP (pointer
))
24493 if (EQ (pointer
, Qarrow
))
24494 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24495 else if (EQ (pointer
, Qhand
))
24496 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24497 else if (EQ (pointer
, Qtext
))
24498 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24499 else if (EQ (pointer
, intern ("hdrag")))
24500 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24501 #ifdef HAVE_X_WINDOWS
24502 else if (EQ (pointer
, intern ("vdrag")))
24503 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24505 else if (EQ (pointer
, intern ("hourglass")))
24506 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24507 else if (EQ (pointer
, Qmodeline
))
24508 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24510 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24513 if (cursor
!= No_Cursor
)
24514 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24517 /* Take proper action when mouse has moved to the mode or header line
24518 or marginal area AREA of window W, x-position X and y-position Y.
24519 X is relative to the start of the text display area of W, so the
24520 width of bitmap areas and scroll bars must be subtracted to get a
24521 position relative to the start of the mode line. */
24524 note_mode_line_or_margin_highlight (window
, x
, y
, area
)
24525 Lisp_Object window
;
24527 enum window_part area
;
24529 struct window
*w
= XWINDOW (window
);
24530 struct frame
*f
= XFRAME (w
->frame
);
24531 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24532 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24533 Lisp_Object pointer
= Qnil
;
24534 int charpos
, dx
, dy
, width
, height
;
24535 Lisp_Object string
, object
= Qnil
;
24536 Lisp_Object pos
, help
;
24538 Lisp_Object mouse_face
;
24539 int original_x_pixel
= x
;
24540 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24541 struct glyph_row
*row
;
24543 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24548 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24549 &object
, &dx
, &dy
, &width
, &height
);
24551 row
= (area
== ON_MODE_LINE
24552 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24553 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24556 if (row
->mode_line_p
&& row
->enabled_p
)
24558 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24559 end
= glyph
+ row
->used
[TEXT_AREA
];
24561 for (x0
= original_x_pixel
;
24562 glyph
< end
&& x0
>= glyph
->pixel_width
;
24564 x0
-= glyph
->pixel_width
;
24572 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24573 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24574 &object
, &dx
, &dy
, &width
, &height
);
24579 if (IMAGEP (object
))
24581 Lisp_Object image_map
, hotspot
;
24582 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24584 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24586 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24588 Lisp_Object area_id
, plist
;
24590 area_id
= XCAR (hotspot
);
24591 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24592 If so, we could look for mouse-enter, mouse-leave
24593 properties in PLIST (and do something...). */
24594 hotspot
= XCDR (hotspot
);
24595 if (CONSP (hotspot
)
24596 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24598 pointer
= Fplist_get (plist
, Qpointer
);
24599 if (NILP (pointer
))
24601 help
= Fplist_get (plist
, Qhelp_echo
);
24604 help_echo_string
= help
;
24605 /* Is this correct? ++kfs */
24606 XSETWINDOW (help_echo_window
, w
);
24607 help_echo_object
= w
->buffer
;
24608 help_echo_pos
= charpos
;
24612 if (NILP (pointer
))
24613 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24616 if (STRINGP (string
))
24618 pos
= make_number (charpos
);
24619 /* If we're on a string with `help-echo' text property, arrange
24620 for the help to be displayed. This is done by setting the
24621 global variable help_echo_string to the help string. */
24624 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24627 help_echo_string
= help
;
24628 XSETWINDOW (help_echo_window
, w
);
24629 help_echo_object
= string
;
24630 help_echo_pos
= charpos
;
24634 if (NILP (pointer
))
24635 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24637 /* Change the mouse pointer according to what is under X/Y. */
24638 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24641 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24642 if (!KEYMAPP (map
))
24643 map
= Fget_text_property (pos
, Qkeymap
, string
);
24644 if (!KEYMAPP (map
))
24645 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24648 /* Change the mouse face according to what is under X/Y. */
24649 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24650 if (!NILP (mouse_face
)
24651 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24656 struct glyph
* tmp_glyph
;
24660 int total_pixel_width
;
24665 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24666 Qmouse_face
, string
, Qnil
);
24668 b
= make_number (0);
24670 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24672 e
= make_number (SCHARS (string
));
24674 /* Calculate the position(glyph position: GPOS) of GLYPH in
24675 displayed string. GPOS is different from CHARPOS.
24677 CHARPOS is the position of glyph in internal string
24678 object. A mode line string format has structures which
24679 is converted to a flatten by emacs lisp interpreter.
24680 The internal string is an element of the structures.
24681 The displayed string is the flatten string. */
24683 if (glyph
> row_start_glyph
)
24685 tmp_glyph
= glyph
- 1;
24686 while (tmp_glyph
>= row_start_glyph
24687 && tmp_glyph
->charpos
>= XINT (b
)
24688 && EQ (tmp_glyph
->object
, glyph
->object
))
24695 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24696 displayed string holding GLYPH.
24698 GSEQ_LENGTH is different from SCHARS (STRING).
24699 SCHARS (STRING) returns the length of the internal string. */
24700 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24701 tmp_glyph
->charpos
< XINT (e
);
24702 tmp_glyph
++, gseq_length
++)
24704 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24708 total_pixel_width
= 0;
24709 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24710 total_pixel_width
+= tmp_glyph
->pixel_width
;
24712 /* Pre calculation of re-rendering position */
24714 hpos
= (area
== ON_MODE_LINE
24715 ? (w
->current_matrix
)->nrows
- 1
24718 /* If the re-rendering position is included in the last
24719 re-rendering area, we should do nothing. */
24720 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24721 && dpyinfo
->mouse_face_beg_col
<= vpos
24722 && vpos
< dpyinfo
->mouse_face_end_col
24723 && dpyinfo
->mouse_face_beg_row
== hpos
)
24726 if (clear_mouse_face (dpyinfo
))
24727 cursor
= No_Cursor
;
24729 dpyinfo
->mouse_face_beg_col
= vpos
;
24730 dpyinfo
->mouse_face_beg_row
= hpos
;
24732 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24733 dpyinfo
->mouse_face_beg_y
= 0;
24735 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24736 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24738 dpyinfo
->mouse_face_end_x
= 0;
24739 dpyinfo
->mouse_face_end_y
= 0;
24741 dpyinfo
->mouse_face_past_end
= 0;
24742 dpyinfo
->mouse_face_window
= window
;
24744 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24747 glyph
->face_id
, 1);
24748 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24750 if (NILP (pointer
))
24753 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24754 clear_mouse_face (dpyinfo
);
24756 define_frame_cursor1 (f
, cursor
, pointer
);
24761 Take proper action when the mouse has moved to position X, Y on
24762 frame F as regards highlighting characters that have mouse-face
24763 properties. Also de-highlighting chars where the mouse was before.
24764 X and Y can be negative or out of range. */
24767 note_mouse_highlight (f
, x
, y
)
24771 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24772 enum window_part part
;
24773 Lisp_Object window
;
24775 Cursor cursor
= No_Cursor
;
24776 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24779 /* When a menu is active, don't highlight because this looks odd. */
24780 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24781 if (popup_activated ())
24785 if (NILP (Vmouse_highlight
)
24786 || !f
->glyphs_initialized_p
24787 || f
->pointer_invisible
)
24790 dpyinfo
->mouse_face_mouse_x
= x
;
24791 dpyinfo
->mouse_face_mouse_y
= y
;
24792 dpyinfo
->mouse_face_mouse_frame
= f
;
24794 if (dpyinfo
->mouse_face_defer
)
24797 if (gc_in_progress
)
24799 dpyinfo
->mouse_face_deferred_gc
= 1;
24803 /* Which window is that in? */
24804 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24806 /* If we were displaying active text in another window, clear that.
24807 Also clear if we move out of text area in same window. */
24808 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24809 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24810 && !NILP (dpyinfo
->mouse_face_window
)))
24811 clear_mouse_face (dpyinfo
);
24813 /* Not on a window -> return. */
24814 if (!WINDOWP (window
))
24817 /* Reset help_echo_string. It will get recomputed below. */
24818 help_echo_string
= Qnil
;
24820 /* Convert to window-relative pixel coordinates. */
24821 w
= XWINDOW (window
);
24822 frame_to_window_pixel_xy (w
, &x
, &y
);
24824 /* Handle tool-bar window differently since it doesn't display a
24826 if (EQ (window
, f
->tool_bar_window
))
24828 note_tool_bar_highlight (f
, x
, y
);
24832 /* Mouse is on the mode, header line or margin? */
24833 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24834 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24836 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24840 if (part
== ON_VERTICAL_BORDER
)
24842 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24843 help_echo_string
= build_string ("drag-mouse-1: resize");
24845 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24846 || part
== ON_SCROLL_BAR
)
24847 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24849 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24851 /* Are we in a window whose display is up to date?
24852 And verify the buffer's text has not changed. */
24853 b
= XBUFFER (w
->buffer
);
24854 if (part
== ON_TEXT
24855 && EQ (w
->window_end_valid
, w
->buffer
)
24856 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24857 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24859 int hpos
, vpos
, i
, dx
, dy
, area
;
24861 struct glyph
*glyph
;
24862 Lisp_Object object
;
24863 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24864 Lisp_Object
*overlay_vec
= NULL
;
24866 struct buffer
*obuf
;
24867 int obegv
, ozv
, same_region
;
24869 /* Find the glyph under X/Y. */
24870 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24872 /* Look for :pointer property on image. */
24873 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24875 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24876 if (img
!= NULL
&& IMAGEP (img
->spec
))
24878 Lisp_Object image_map
, hotspot
;
24879 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24881 && (hotspot
= find_hot_spot (image_map
,
24882 glyph
->slice
.x
+ dx
,
24883 glyph
->slice
.y
+ dy
),
24885 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24887 Lisp_Object area_id
, plist
;
24889 area_id
= XCAR (hotspot
);
24890 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24891 If so, we could look for mouse-enter, mouse-leave
24892 properties in PLIST (and do something...). */
24893 hotspot
= XCDR (hotspot
);
24894 if (CONSP (hotspot
)
24895 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24897 pointer
= Fplist_get (plist
, Qpointer
);
24898 if (NILP (pointer
))
24900 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24901 if (!NILP (help_echo_string
))
24903 help_echo_window
= window
;
24904 help_echo_object
= glyph
->object
;
24905 help_echo_pos
= glyph
->charpos
;
24909 if (NILP (pointer
))
24910 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24914 /* Clear mouse face if X/Y not over text. */
24916 || area
!= TEXT_AREA
24917 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24919 if (clear_mouse_face (dpyinfo
))
24920 cursor
= No_Cursor
;
24921 if (NILP (pointer
))
24923 if (area
!= TEXT_AREA
)
24924 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24926 pointer
= Vvoid_text_area_pointer
;
24931 pos
= glyph
->charpos
;
24932 object
= glyph
->object
;
24933 if (!STRINGP (object
) && !BUFFERP (object
))
24936 /* If we get an out-of-range value, return now; avoid an error. */
24937 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24940 /* Make the window's buffer temporarily current for
24941 overlays_at and compute_char_face. */
24942 obuf
= current_buffer
;
24943 current_buffer
= b
;
24949 /* Is this char mouse-active or does it have help-echo? */
24950 position
= make_number (pos
);
24952 if (BUFFERP (object
))
24954 /* Put all the overlays we want in a vector in overlay_vec. */
24955 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24956 /* Sort overlays into increasing priority order. */
24957 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24962 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24963 && vpos
>= dpyinfo
->mouse_face_beg_row
24964 && vpos
<= dpyinfo
->mouse_face_end_row
24965 && (vpos
> dpyinfo
->mouse_face_beg_row
24966 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24967 && (vpos
< dpyinfo
->mouse_face_end_row
24968 || hpos
< dpyinfo
->mouse_face_end_col
24969 || dpyinfo
->mouse_face_past_end
));
24972 cursor
= No_Cursor
;
24974 /* Check mouse-face highlighting. */
24976 /* If there exists an overlay with mouse-face overlapping
24977 the one we are currently highlighting, we have to
24978 check if we enter the overlapping overlay, and then
24979 highlight only that. */
24980 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24981 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24983 /* Find the highest priority overlay with a mouse-face. */
24985 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24987 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24988 if (!NILP (mouse_face
))
24989 overlay
= overlay_vec
[i
];
24992 /* If we're highlighting the same overlay as before, there's
24993 no need to do that again. */
24994 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24995 goto check_help_echo
;
24996 dpyinfo
->mouse_face_overlay
= overlay
;
24998 /* Clear the display of the old active region, if any. */
24999 if (clear_mouse_face (dpyinfo
))
25000 cursor
= No_Cursor
;
25002 /* If no overlay applies, get a text property. */
25003 if (NILP (overlay
))
25004 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
25006 /* Next, compute the bounds of the mouse highlighting and
25008 if (!NILP (mouse_face
) && STRINGP (object
))
25010 /* The mouse-highlighting comes from a display string
25011 with a mouse-face. */
25015 b
= Fprevious_single_property_change
25016 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
25017 e
= Fnext_single_property_change
25018 (position
, Qmouse_face
, object
, Qnil
);
25020 b
= make_number (0);
25022 e
= make_number (SCHARS (object
) - 1);
25024 fast_find_string_pos (w
, XINT (b
), object
,
25025 &dpyinfo
->mouse_face_beg_col
,
25026 &dpyinfo
->mouse_face_beg_row
,
25027 &dpyinfo
->mouse_face_beg_x
,
25028 &dpyinfo
->mouse_face_beg_y
, 0);
25029 fast_find_string_pos (w
, XINT (e
), object
,
25030 &dpyinfo
->mouse_face_end_col
,
25031 &dpyinfo
->mouse_face_end_row
,
25032 &dpyinfo
->mouse_face_end_x
,
25033 &dpyinfo
->mouse_face_end_y
, 1);
25034 dpyinfo
->mouse_face_past_end
= 0;
25035 dpyinfo
->mouse_face_window
= window
;
25036 dpyinfo
->mouse_face_face_id
25037 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
25038 glyph
->face_id
, 1);
25039 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
25040 cursor
= No_Cursor
;
25044 /* The mouse-highlighting, if any, comes from an overlay
25045 or text property in the buffer. */
25046 Lisp_Object buffer
, display_string
;
25048 if (STRINGP (object
))
25050 /* If we are on a display string with no mouse-face,
25051 check if the text under it has one. */
25052 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
25053 int start
= MATRIX_ROW_START_CHARPOS (r
);
25054 pos
= string_buffer_position (w
, object
, start
);
25057 mouse_face
= get_char_property_and_overlay
25058 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
25059 buffer
= w
->buffer
;
25060 display_string
= object
;
25066 display_string
= Qnil
;
25069 if (!NILP (mouse_face
))
25071 Lisp_Object before
, after
;
25072 Lisp_Object before_string
, after_string
;
25074 if (NILP (overlay
))
25076 /* Handle the text property case. */
25077 before
= Fprevious_single_property_change
25078 (make_number (pos
+ 1), Qmouse_face
, buffer
,
25079 Fmarker_position (w
->start
));
25080 after
= Fnext_single_property_change
25081 (make_number (pos
), Qmouse_face
, buffer
,
25082 make_number (BUF_Z (XBUFFER (buffer
))
25083 - XFASTINT (w
->window_end_pos
)));
25084 before_string
= after_string
= Qnil
;
25088 /* Handle the overlay case. */
25089 before
= Foverlay_start (overlay
);
25090 after
= Foverlay_end (overlay
);
25091 before_string
= Foverlay_get (overlay
, Qbefore_string
);
25092 after_string
= Foverlay_get (overlay
, Qafter_string
);
25094 if (!STRINGP (before_string
)) before_string
= Qnil
;
25095 if (!STRINGP (after_string
)) after_string
= Qnil
;
25098 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
25101 before_string
, after_string
,
25103 cursor
= No_Cursor
;
25110 /* Look for a `help-echo' property. */
25111 if (NILP (help_echo_string
)) {
25112 Lisp_Object help
, overlay
;
25114 /* Check overlays first. */
25115 help
= overlay
= Qnil
;
25116 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
25118 overlay
= overlay_vec
[i
];
25119 help
= Foverlay_get (overlay
, Qhelp_echo
);
25124 help_echo_string
= help
;
25125 help_echo_window
= window
;
25126 help_echo_object
= overlay
;
25127 help_echo_pos
= pos
;
25131 Lisp_Object object
= glyph
->object
;
25132 int charpos
= glyph
->charpos
;
25134 /* Try text properties. */
25135 if (STRINGP (object
)
25137 && charpos
< SCHARS (object
))
25139 help
= Fget_text_property (make_number (charpos
),
25140 Qhelp_echo
, object
);
25143 /* If the string itself doesn't specify a help-echo,
25144 see if the buffer text ``under'' it does. */
25145 struct glyph_row
*r
25146 = MATRIX_ROW (w
->current_matrix
, vpos
);
25147 int start
= MATRIX_ROW_START_CHARPOS (r
);
25148 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
25151 help
= Fget_char_property (make_number (pos
),
25152 Qhelp_echo
, w
->buffer
);
25156 object
= w
->buffer
;
25161 else if (BUFFERP (object
)
25164 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
25169 help_echo_string
= help
;
25170 help_echo_window
= window
;
25171 help_echo_object
= object
;
25172 help_echo_pos
= charpos
;
25177 /* Look for a `pointer' property. */
25178 if (NILP (pointer
))
25180 /* Check overlays first. */
25181 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
25182 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
25184 if (NILP (pointer
))
25186 Lisp_Object object
= glyph
->object
;
25187 int charpos
= glyph
->charpos
;
25189 /* Try text properties. */
25190 if (STRINGP (object
)
25192 && charpos
< SCHARS (object
))
25194 pointer
= Fget_text_property (make_number (charpos
),
25196 if (NILP (pointer
))
25198 /* If the string itself doesn't specify a pointer,
25199 see if the buffer text ``under'' it does. */
25200 struct glyph_row
*r
25201 = MATRIX_ROW (w
->current_matrix
, vpos
);
25202 int start
= MATRIX_ROW_START_CHARPOS (r
);
25203 EMACS_INT pos
= string_buffer_position (w
, object
,
25206 pointer
= Fget_char_property (make_number (pos
),
25207 Qpointer
, w
->buffer
);
25210 else if (BUFFERP (object
)
25213 pointer
= Fget_text_property (make_number (charpos
),
25220 current_buffer
= obuf
;
25225 define_frame_cursor1 (f
, cursor
, pointer
);
25230 Clear any mouse-face on window W. This function is part of the
25231 redisplay interface, and is called from try_window_id and similar
25232 functions to ensure the mouse-highlight is off. */
25235 x_clear_window_mouse_face (w
)
25238 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
25239 Lisp_Object window
;
25242 XSETWINDOW (window
, w
);
25243 if (EQ (window
, dpyinfo
->mouse_face_window
))
25244 clear_mouse_face (dpyinfo
);
25250 Just discard the mouse face information for frame F, if any.
25251 This is used when the size of F is changed. */
25254 cancel_mouse_face (f
)
25257 Lisp_Object window
;
25258 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25260 window
= dpyinfo
->mouse_face_window
;
25261 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25263 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
25264 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
25265 dpyinfo
->mouse_face_window
= Qnil
;
25270 #endif /* HAVE_WINDOW_SYSTEM */
25273 /***********************************************************************
25275 ***********************************************************************/
25277 #ifdef HAVE_WINDOW_SYSTEM
25279 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25280 which intersects rectangle R. R is in window-relative coordinates. */
25283 expose_area (w
, row
, r
, area
)
25285 struct glyph_row
*row
;
25287 enum glyph_row_area area
;
25289 struct glyph
*first
= row
->glyphs
[area
];
25290 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25291 struct glyph
*last
;
25292 int first_x
, start_x
, x
;
25294 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25295 /* If row extends face to end of line write the whole line. */
25296 draw_glyphs (w
, 0, row
, area
,
25297 0, row
->used
[area
],
25298 DRAW_NORMAL_TEXT
, 0);
25301 /* Set START_X to the window-relative start position for drawing glyphs of
25302 AREA. The first glyph of the text area can be partially visible.
25303 The first glyphs of other areas cannot. */
25304 start_x
= window_box_left_offset (w
, area
);
25306 if (area
== TEXT_AREA
)
25309 /* Find the first glyph that must be redrawn. */
25311 && x
+ first
->pixel_width
< r
->x
)
25313 x
+= first
->pixel_width
;
25317 /* Find the last one. */
25321 && x
< r
->x
+ r
->width
)
25323 x
+= last
->pixel_width
;
25329 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25330 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25331 DRAW_NORMAL_TEXT
, 0);
25336 /* Redraw the parts of the glyph row ROW on window W intersecting
25337 rectangle R. R is in window-relative coordinates. Value is
25338 non-zero if mouse-face was overwritten. */
25341 expose_line (w
, row
, r
)
25343 struct glyph_row
*row
;
25346 xassert (row
->enabled_p
);
25348 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25349 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25350 0, row
->used
[TEXT_AREA
],
25351 DRAW_NORMAL_TEXT
, 0);
25354 if (row
->used
[LEFT_MARGIN_AREA
])
25355 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25356 if (row
->used
[TEXT_AREA
])
25357 expose_area (w
, row
, r
, TEXT_AREA
);
25358 if (row
->used
[RIGHT_MARGIN_AREA
])
25359 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25360 draw_row_fringe_bitmaps (w
, row
);
25363 return row
->mouse_face_p
;
25367 /* Redraw those parts of glyphs rows during expose event handling that
25368 overlap other rows. Redrawing of an exposed line writes over parts
25369 of lines overlapping that exposed line; this function fixes that.
25371 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25372 row in W's current matrix that is exposed and overlaps other rows.
25373 LAST_OVERLAPPING_ROW is the last such row. */
25376 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
, r
)
25378 struct glyph_row
*first_overlapping_row
;
25379 struct glyph_row
*last_overlapping_row
;
25382 struct glyph_row
*row
;
25384 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25385 if (row
->overlapping_p
)
25387 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25390 if (row
->used
[LEFT_MARGIN_AREA
])
25391 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25393 if (row
->used
[TEXT_AREA
])
25394 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25396 if (row
->used
[RIGHT_MARGIN_AREA
])
25397 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25403 /* Return non-zero if W's cursor intersects rectangle R. */
25406 phys_cursor_in_rect_p (w
, r
)
25410 XRectangle cr
, result
;
25411 struct glyph
*cursor_glyph
;
25412 struct glyph_row
*row
;
25414 if (w
->phys_cursor
.vpos
>= 0
25415 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25416 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25418 && row
->cursor_in_fringe_p
)
25420 /* Cursor is in the fringe. */
25421 cr
.x
= window_box_right_offset (w
,
25422 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25423 ? RIGHT_MARGIN_AREA
25426 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25427 cr
.height
= row
->height
;
25428 return x_intersect_rectangles (&cr
, r
, &result
);
25431 cursor_glyph
= get_phys_cursor_glyph (w
);
25434 /* r is relative to W's box, but w->phys_cursor.x is relative
25435 to left edge of W's TEXT area. Adjust it. */
25436 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25437 cr
.y
= w
->phys_cursor
.y
;
25438 cr
.width
= cursor_glyph
->pixel_width
;
25439 cr
.height
= w
->phys_cursor_height
;
25440 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25441 I assume the effect is the same -- and this is portable. */
25442 return x_intersect_rectangles (&cr
, r
, &result
);
25444 /* If we don't understand the format, pretend we're not in the hot-spot. */
25450 Draw a vertical window border to the right of window W if W doesn't
25451 have vertical scroll bars. */
25454 x_draw_vertical_border (w
)
25457 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25459 /* We could do better, if we knew what type of scroll-bar the adjacent
25460 windows (on either side) have... But we don't :-(
25461 However, I think this works ok. ++KFS 2003-04-25 */
25463 /* Redraw borders between horizontally adjacent windows. Don't
25464 do it for frames with vertical scroll bars because either the
25465 right scroll bar of a window, or the left scroll bar of its
25466 neighbor will suffice as a border. */
25467 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25470 if (!WINDOW_RIGHTMOST_P (w
)
25471 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25473 int x0
, x1
, y0
, y1
;
25475 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25478 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25481 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25483 else if (!WINDOW_LEFTMOST_P (w
)
25484 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25486 int x0
, x1
, y0
, y1
;
25488 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25491 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25494 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25499 /* Redraw the part of window W intersection rectangle FR. Pixel
25500 coordinates in FR are frame-relative. Call this function with
25501 input blocked. Value is non-zero if the exposure overwrites
25505 expose_window (w
, fr
)
25509 struct frame
*f
= XFRAME (w
->frame
);
25511 int mouse_face_overwritten_p
= 0;
25513 /* If window is not yet fully initialized, do nothing. This can
25514 happen when toolkit scroll bars are used and a window is split.
25515 Reconfiguring the scroll bar will generate an expose for a newly
25517 if (w
->current_matrix
== NULL
)
25520 /* When we're currently updating the window, display and current
25521 matrix usually don't agree. Arrange for a thorough display
25523 if (w
== updated_window
)
25525 SET_FRAME_GARBAGED (f
);
25529 /* Frame-relative pixel rectangle of W. */
25530 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25531 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25532 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25533 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25535 if (x_intersect_rectangles (fr
, &wr
, &r
))
25537 int yb
= window_text_bottom_y (w
);
25538 struct glyph_row
*row
;
25539 int cursor_cleared_p
;
25540 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25542 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25543 r
.x
, r
.y
, r
.width
, r
.height
));
25545 /* Convert to window coordinates. */
25546 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25547 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25549 /* Turn off the cursor. */
25550 if (!w
->pseudo_window_p
25551 && phys_cursor_in_rect_p (w
, &r
))
25553 x_clear_cursor (w
);
25554 cursor_cleared_p
= 1;
25557 cursor_cleared_p
= 0;
25559 /* Update lines intersecting rectangle R. */
25560 first_overlapping_row
= last_overlapping_row
= NULL
;
25561 for (row
= w
->current_matrix
->rows
;
25566 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25568 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25569 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25570 || (r
.y
>= y0
&& r
.y
< y1
)
25571 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25573 /* A header line may be overlapping, but there is no need
25574 to fix overlapping areas for them. KFS 2005-02-12 */
25575 if (row
->overlapping_p
&& !row
->mode_line_p
)
25577 if (first_overlapping_row
== NULL
)
25578 first_overlapping_row
= row
;
25579 last_overlapping_row
= row
;
25583 if (expose_line (w
, row
, &r
))
25584 mouse_face_overwritten_p
= 1;
25587 else if (row
->overlapping_p
)
25589 /* We must redraw a row overlapping the exposed area. */
25591 ? y0
+ row
->phys_height
> r
.y
25592 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25594 if (first_overlapping_row
== NULL
)
25595 first_overlapping_row
= row
;
25596 last_overlapping_row
= row
;
25604 /* Display the mode line if there is one. */
25605 if (WINDOW_WANTS_MODELINE_P (w
)
25606 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25608 && row
->y
< r
.y
+ r
.height
)
25610 if (expose_line (w
, row
, &r
))
25611 mouse_face_overwritten_p
= 1;
25614 if (!w
->pseudo_window_p
)
25616 /* Fix the display of overlapping rows. */
25617 if (first_overlapping_row
)
25618 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25621 /* Draw border between windows. */
25622 x_draw_vertical_border (w
);
25624 /* Turn the cursor on again. */
25625 if (cursor_cleared_p
)
25626 update_window_cursor (w
, 1);
25630 return mouse_face_overwritten_p
;
25635 /* Redraw (parts) of all windows in the window tree rooted at W that
25636 intersect R. R contains frame pixel coordinates. Value is
25637 non-zero if the exposure overwrites mouse-face. */
25640 expose_window_tree (w
, r
)
25644 struct frame
*f
= XFRAME (w
->frame
);
25645 int mouse_face_overwritten_p
= 0;
25647 while (w
&& !FRAME_GARBAGED_P (f
))
25649 if (!NILP (w
->hchild
))
25650 mouse_face_overwritten_p
25651 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25652 else if (!NILP (w
->vchild
))
25653 mouse_face_overwritten_p
25654 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25656 mouse_face_overwritten_p
|= expose_window (w
, r
);
25658 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25661 return mouse_face_overwritten_p
;
25666 Redisplay an exposed area of frame F. X and Y are the upper-left
25667 corner of the exposed rectangle. W and H are width and height of
25668 the exposed area. All are pixel values. W or H zero means redraw
25669 the entire frame. */
25672 expose_frame (f
, x
, y
, w
, h
)
25677 int mouse_face_overwritten_p
= 0;
25679 TRACE ((stderr
, "expose_frame "));
25681 /* No need to redraw if frame will be redrawn soon. */
25682 if (FRAME_GARBAGED_P (f
))
25684 TRACE ((stderr
, " garbaged\n"));
25688 /* If basic faces haven't been realized yet, there is no point in
25689 trying to redraw anything. This can happen when we get an expose
25690 event while Emacs is starting, e.g. by moving another window. */
25691 if (FRAME_FACE_CACHE (f
) == NULL
25692 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25694 TRACE ((stderr
, " no faces\n"));
25698 if (w
== 0 || h
== 0)
25701 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25702 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25712 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25713 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25715 if (WINDOWP (f
->tool_bar_window
))
25716 mouse_face_overwritten_p
25717 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25719 #ifdef HAVE_X_WINDOWS
25721 #ifndef USE_X_TOOLKIT
25722 if (WINDOWP (f
->menu_bar_window
))
25723 mouse_face_overwritten_p
25724 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25725 #endif /* not USE_X_TOOLKIT */
25729 /* Some window managers support a focus-follows-mouse style with
25730 delayed raising of frames. Imagine a partially obscured frame,
25731 and moving the mouse into partially obscured mouse-face on that
25732 frame. The visible part of the mouse-face will be highlighted,
25733 then the WM raises the obscured frame. With at least one WM, KDE
25734 2.1, Emacs is not getting any event for the raising of the frame
25735 (even tried with SubstructureRedirectMask), only Expose events.
25736 These expose events will draw text normally, i.e. not
25737 highlighted. Which means we must redo the highlight here.
25738 Subsume it under ``we love X''. --gerd 2001-08-15 */
25739 /* Included in Windows version because Windows most likely does not
25740 do the right thing if any third party tool offers
25741 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25742 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25744 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25745 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25747 int x
= dpyinfo
->mouse_face_mouse_x
;
25748 int y
= dpyinfo
->mouse_face_mouse_y
;
25749 clear_mouse_face (dpyinfo
);
25750 note_mouse_highlight (f
, x
, y
);
25757 Determine the intersection of two rectangles R1 and R2. Return
25758 the intersection in *RESULT. Value is non-zero if RESULT is not
25762 x_intersect_rectangles (r1
, r2
, result
)
25763 XRectangle
*r1
, *r2
, *result
;
25765 XRectangle
*left
, *right
;
25766 XRectangle
*upper
, *lower
;
25767 int intersection_p
= 0;
25769 /* Rearrange so that R1 is the left-most rectangle. */
25771 left
= r1
, right
= r2
;
25773 left
= r2
, right
= r1
;
25775 /* X0 of the intersection is right.x0, if this is inside R1,
25776 otherwise there is no intersection. */
25777 if (right
->x
<= left
->x
+ left
->width
)
25779 result
->x
= right
->x
;
25781 /* The right end of the intersection is the minimum of the
25782 the right ends of left and right. */
25783 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25786 /* Same game for Y. */
25788 upper
= r1
, lower
= r2
;
25790 upper
= r2
, lower
= r1
;
25792 /* The upper end of the intersection is lower.y0, if this is inside
25793 of upper. Otherwise, there is no intersection. */
25794 if (lower
->y
<= upper
->y
+ upper
->height
)
25796 result
->y
= lower
->y
;
25798 /* The lower end of the intersection is the minimum of the lower
25799 ends of upper and lower. */
25800 result
->height
= (min (lower
->y
+ lower
->height
,
25801 upper
->y
+ upper
->height
)
25803 intersection_p
= 1;
25807 return intersection_p
;
25810 #endif /* HAVE_WINDOW_SYSTEM */
25813 /***********************************************************************
25815 ***********************************************************************/
25820 Vwith_echo_area_save_vector
= Qnil
;
25821 staticpro (&Vwith_echo_area_save_vector
);
25823 Vmessage_stack
= Qnil
;
25824 staticpro (&Vmessage_stack
);
25826 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25827 staticpro (&Qinhibit_redisplay
);
25829 message_dolog_marker1
= Fmake_marker ();
25830 staticpro (&message_dolog_marker1
);
25831 message_dolog_marker2
= Fmake_marker ();
25832 staticpro (&message_dolog_marker2
);
25833 message_dolog_marker3
= Fmake_marker ();
25834 staticpro (&message_dolog_marker3
);
25837 defsubr (&Sdump_frame_glyph_matrix
);
25838 defsubr (&Sdump_glyph_matrix
);
25839 defsubr (&Sdump_glyph_row
);
25840 defsubr (&Sdump_tool_bar_row
);
25841 defsubr (&Strace_redisplay
);
25842 defsubr (&Strace_to_stderr
);
25844 #ifdef HAVE_WINDOW_SYSTEM
25845 defsubr (&Stool_bar_lines_needed
);
25846 defsubr (&Slookup_image_map
);
25848 defsubr (&Sformat_mode_line
);
25849 defsubr (&Sinvisible_p
);
25851 staticpro (&Qmenu_bar_update_hook
);
25852 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25854 staticpro (&Qoverriding_terminal_local_map
);
25855 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25857 staticpro (&Qoverriding_local_map
);
25858 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25860 staticpro (&Qwindow_scroll_functions
);
25861 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25863 staticpro (&Qwindow_text_change_functions
);
25864 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25866 staticpro (&Qredisplay_end_trigger_functions
);
25867 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25869 staticpro (&Qinhibit_point_motion_hooks
);
25870 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25872 Qeval
= intern_c_string ("eval");
25873 staticpro (&Qeval
);
25875 QCdata
= intern_c_string (":data");
25876 staticpro (&QCdata
);
25877 Qdisplay
= intern_c_string ("display");
25878 staticpro (&Qdisplay
);
25879 Qspace_width
= intern_c_string ("space-width");
25880 staticpro (&Qspace_width
);
25881 Qraise
= intern_c_string ("raise");
25882 staticpro (&Qraise
);
25883 Qslice
= intern_c_string ("slice");
25884 staticpro (&Qslice
);
25885 Qspace
= intern_c_string ("space");
25886 staticpro (&Qspace
);
25887 Qmargin
= intern_c_string ("margin");
25888 staticpro (&Qmargin
);
25889 Qpointer
= intern_c_string ("pointer");
25890 staticpro (&Qpointer
);
25891 Qleft_margin
= intern_c_string ("left-margin");
25892 staticpro (&Qleft_margin
);
25893 Qright_margin
= intern_c_string ("right-margin");
25894 staticpro (&Qright_margin
);
25895 Qcenter
= intern_c_string ("center");
25896 staticpro (&Qcenter
);
25897 Qline_height
= intern_c_string ("line-height");
25898 staticpro (&Qline_height
);
25899 QCalign_to
= intern_c_string (":align-to");
25900 staticpro (&QCalign_to
);
25901 QCrelative_width
= intern_c_string (":relative-width");
25902 staticpro (&QCrelative_width
);
25903 QCrelative_height
= intern_c_string (":relative-height");
25904 staticpro (&QCrelative_height
);
25905 QCeval
= intern_c_string (":eval");
25906 staticpro (&QCeval
);
25907 QCpropertize
= intern_c_string (":propertize");
25908 staticpro (&QCpropertize
);
25909 QCfile
= intern_c_string (":file");
25910 staticpro (&QCfile
);
25911 Qfontified
= intern_c_string ("fontified");
25912 staticpro (&Qfontified
);
25913 Qfontification_functions
= intern_c_string ("fontification-functions");
25914 staticpro (&Qfontification_functions
);
25915 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25916 staticpro (&Qtrailing_whitespace
);
25917 Qescape_glyph
= intern_c_string ("escape-glyph");
25918 staticpro (&Qescape_glyph
);
25919 Qnobreak_space
= intern_c_string ("nobreak-space");
25920 staticpro (&Qnobreak_space
);
25921 Qimage
= intern_c_string ("image");
25922 staticpro (&Qimage
);
25923 Qtext
= intern_c_string ("text");
25924 staticpro (&Qtext
);
25925 Qboth
= intern_c_string ("both");
25926 staticpro (&Qboth
);
25927 Qboth_horiz
= intern_c_string ("both-horiz");
25928 staticpro (&Qboth_horiz
);
25929 QCmap
= intern_c_string (":map");
25930 staticpro (&QCmap
);
25931 QCpointer
= intern_c_string (":pointer");
25932 staticpro (&QCpointer
);
25933 Qrect
= intern_c_string ("rect");
25934 staticpro (&Qrect
);
25935 Qcircle
= intern_c_string ("circle");
25936 staticpro (&Qcircle
);
25937 Qpoly
= intern_c_string ("poly");
25938 staticpro (&Qpoly
);
25939 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25940 staticpro (&Qmessage_truncate_lines
);
25941 Qgrow_only
= intern_c_string ("grow-only");
25942 staticpro (&Qgrow_only
);
25943 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25944 staticpro (&Qinhibit_menubar_update
);
25945 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25946 staticpro (&Qinhibit_eval_during_redisplay
);
25947 Qposition
= intern_c_string ("position");
25948 staticpro (&Qposition
);
25949 Qbuffer_position
= intern_c_string ("buffer-position");
25950 staticpro (&Qbuffer_position
);
25951 Qobject
= intern_c_string ("object");
25952 staticpro (&Qobject
);
25953 Qbar
= intern_c_string ("bar");
25955 Qhbar
= intern_c_string ("hbar");
25956 staticpro (&Qhbar
);
25957 Qbox
= intern_c_string ("box");
25959 Qhollow
= intern_c_string ("hollow");
25960 staticpro (&Qhollow
);
25961 Qhand
= intern_c_string ("hand");
25962 staticpro (&Qhand
);
25963 Qarrow
= intern_c_string ("arrow");
25964 staticpro (&Qarrow
);
25965 Qtext
= intern_c_string ("text");
25966 staticpro (&Qtext
);
25967 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25968 staticpro (&Qrisky_local_variable
);
25969 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25970 staticpro (&Qinhibit_free_realized_faces
);
25972 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25973 Fcons (intern_c_string ("void-variable"), Qnil
)),
25975 staticpro (&list_of_error
);
25977 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25978 staticpro (&Qlast_arrow_position
);
25979 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25980 staticpro (&Qlast_arrow_string
);
25982 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25983 staticpro (&Qoverlay_arrow_string
);
25984 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25985 staticpro (&Qoverlay_arrow_bitmap
);
25987 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25988 staticpro (&echo_buffer
[0]);
25989 staticpro (&echo_buffer
[1]);
25991 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25992 staticpro (&echo_area_buffer
[0]);
25993 staticpro (&echo_area_buffer
[1]);
25995 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25996 staticpro (&Vmessages_buffer_name
);
25998 mode_line_proptrans_alist
= Qnil
;
25999 staticpro (&mode_line_proptrans_alist
);
26000 mode_line_string_list
= Qnil
;
26001 staticpro (&mode_line_string_list
);
26002 mode_line_string_face
= Qnil
;
26003 staticpro (&mode_line_string_face
);
26004 mode_line_string_face_prop
= Qnil
;
26005 staticpro (&mode_line_string_face_prop
);
26006 Vmode_line_unwind_vector
= Qnil
;
26007 staticpro (&Vmode_line_unwind_vector
);
26009 help_echo_string
= Qnil
;
26010 staticpro (&help_echo_string
);
26011 help_echo_object
= Qnil
;
26012 staticpro (&help_echo_object
);
26013 help_echo_window
= Qnil
;
26014 staticpro (&help_echo_window
);
26015 previous_help_echo_string
= Qnil
;
26016 staticpro (&previous_help_echo_string
);
26017 help_echo_pos
= -1;
26019 Qright_to_left
= intern_c_string ("right-to-left");
26020 staticpro (&Qright_to_left
);
26021 Qleft_to_right
= intern_c_string ("left-to-right");
26022 staticpro (&Qleft_to_right
);
26024 #ifdef HAVE_WINDOW_SYSTEM
26025 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
26026 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
26027 For example, if a block cursor is over a tab, it will be drawn as
26028 wide as that tab on the display. */);
26029 x_stretch_cursor_p
= 0;
26032 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
26033 doc
: /* *Non-nil means highlight trailing whitespace.
26034 The face used for trailing whitespace is `trailing-whitespace'. */);
26035 Vshow_trailing_whitespace
= Qnil
;
26037 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
26038 doc
: /* *Control highlighting of nobreak space and soft hyphen.
26039 A value of t means highlight the character itself (for nobreak space,
26040 use face `nobreak-space').
26041 A value of nil means no highlighting.
26042 Other values mean display the escape glyph followed by an ordinary
26043 space or ordinary hyphen. */);
26044 Vnobreak_char_display
= Qt
;
26046 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
26047 doc
: /* *The pointer shape to show in void text areas.
26048 A value of nil means to show the text pointer. Other options are `arrow',
26049 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
26050 Vvoid_text_area_pointer
= Qarrow
;
26052 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
26053 doc
: /* Non-nil means don't actually do any redisplay.
26054 This is used for internal purposes. */);
26055 Vinhibit_redisplay
= Qnil
;
26057 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
26058 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
26059 Vglobal_mode_string
= Qnil
;
26061 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
26062 doc
: /* Marker for where to display an arrow on top of the buffer text.
26063 This must be the beginning of a line in order to work.
26064 See also `overlay-arrow-string'. */);
26065 Voverlay_arrow_position
= Qnil
;
26067 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
26068 doc
: /* String to display as an arrow in non-window frames.
26069 See also `overlay-arrow-position'. */);
26070 Voverlay_arrow_string
= make_pure_c_string ("=>");
26072 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
26073 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
26074 The symbols on this list are examined during redisplay to determine
26075 where to display overlay arrows. */);
26076 Voverlay_arrow_variable_list
26077 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
26079 DEFVAR_INT ("scroll-step", &scroll_step
,
26080 doc
: /* *The number of lines to try scrolling a window by when point moves out.
26081 If that fails to bring point back on frame, point is centered instead.
26082 If this is zero, point is always centered after it moves off frame.
26083 If you want scrolling to always be a line at a time, you should set
26084 `scroll-conservatively' to a large value rather than set this to 1. */);
26086 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
26087 doc
: /* *Scroll up to this many lines, to bring point back on screen.
26088 If point moves off-screen, redisplay will scroll by up to
26089 `scroll-conservatively' lines in order to bring point just barely
26090 onto the screen again. If that cannot be done, then redisplay
26091 recenters point as usual.
26093 A value of zero means always recenter point if it moves off screen. */);
26094 scroll_conservatively
= 0;
26096 DEFVAR_INT ("scroll-margin", &scroll_margin
,
26097 doc
: /* *Number of lines of margin at the top and bottom of a window.
26098 Recenter the window whenever point gets within this many lines
26099 of the top or bottom of the window. */);
26102 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
26103 doc
: /* Pixels per inch value for non-window system displays.
26104 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
26105 Vdisplay_pixels_per_inch
= make_float (72.0);
26108 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
26111 DEFVAR_LISP ("truncate-partial-width-windows",
26112 &Vtruncate_partial_width_windows
,
26113 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
26114 For an integer value, truncate lines in each window narrower than the
26115 full frame width, provided the window width is less than that integer;
26116 otherwise, respect the value of `truncate-lines'.
26118 For any other non-nil value, truncate lines in all windows that do
26119 not span the full frame width.
26121 A value of nil means to respect the value of `truncate-lines'.
26123 If `word-wrap' is enabled, you might want to reduce this. */);
26124 Vtruncate_partial_width_windows
= make_number (50);
26126 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
26127 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
26128 Any other value means to use the appropriate face, `mode-line',
26129 `header-line', or `menu' respectively. */);
26130 mode_line_inverse_video
= 1;
26132 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
26133 doc
: /* *Maximum buffer size for which line number should be displayed.
26134 If the buffer is bigger than this, the line number does not appear
26135 in the mode line. A value of nil means no limit. */);
26136 Vline_number_display_limit
= Qnil
;
26138 DEFVAR_INT ("line-number-display-limit-width",
26139 &line_number_display_limit_width
,
26140 doc
: /* *Maximum line width (in characters) for line number display.
26141 If the average length of the lines near point is bigger than this, then the
26142 line number may be omitted from the mode line. */);
26143 line_number_display_limit_width
= 200;
26145 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
26146 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
26147 highlight_nonselected_windows
= 0;
26149 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
26150 doc
: /* Non-nil if more than one frame is visible on this display.
26151 Minibuffer-only frames don't count, but iconified frames do.
26152 This variable is not guaranteed to be accurate except while processing
26153 `frame-title-format' and `icon-title-format'. */);
26155 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
26156 doc
: /* Template for displaying the title bar of visible frames.
26157 \(Assuming the window manager supports this feature.)
26159 This variable has the same structure as `mode-line-format', except that
26160 the %c and %l constructs are ignored. It is used only on frames for
26161 which no explicit name has been set \(see `modify-frame-parameters'). */);
26163 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
26164 doc
: /* Template for displaying the title bar of an iconified frame.
26165 \(Assuming the window manager supports this feature.)
26166 This variable has the same structure as `mode-line-format' (which see),
26167 and is used only on frames for which no explicit name has been set
26168 \(see `modify-frame-parameters'). */);
26170 = Vframe_title_format
26171 = pure_cons (intern_c_string ("multiple-frames"),
26172 pure_cons (make_pure_c_string ("%b"),
26173 pure_cons (pure_cons (empty_unibyte_string
,
26174 pure_cons (intern_c_string ("invocation-name"),
26175 pure_cons (make_pure_c_string ("@"),
26176 pure_cons (intern_c_string ("system-name"),
26180 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
26181 doc
: /* Maximum number of lines to keep in the message log buffer.
26182 If nil, disable message logging. If t, log messages but don't truncate
26183 the buffer when it becomes large. */);
26184 Vmessage_log_max
= make_number (100);
26186 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
26187 doc
: /* Functions called before redisplay, if window sizes have changed.
26188 The value should be a list of functions that take one argument.
26189 Just before redisplay, for each frame, if any of its windows have changed
26190 size since the last redisplay, or have been split or deleted,
26191 all the functions in the list are called, with the frame as argument. */);
26192 Vwindow_size_change_functions
= Qnil
;
26194 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
26195 doc
: /* List of functions to call before redisplaying a window with scrolling.
26196 Each function is called with two arguments, the window and its new
26197 display-start position. Note that these functions are also called by
26198 `set-window-buffer'. Also note that the value of `window-end' is not
26199 valid when these functions are called. */);
26200 Vwindow_scroll_functions
= Qnil
;
26202 DEFVAR_LISP ("window-text-change-functions",
26203 &Vwindow_text_change_functions
,
26204 doc
: /* Functions to call in redisplay when text in the window might change. */);
26205 Vwindow_text_change_functions
= Qnil
;
26207 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
26208 doc
: /* Functions called when redisplay of a window reaches the end trigger.
26209 Each function is called with two arguments, the window and the end trigger value.
26210 See `set-window-redisplay-end-trigger'. */);
26211 Vredisplay_end_trigger_functions
= Qnil
;
26213 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
26214 doc
: /* *Non-nil means autoselect window with mouse pointer.
26215 If nil, do not autoselect windows.
26216 A positive number means delay autoselection by that many seconds: a
26217 window is autoselected only after the mouse has remained in that
26218 window for the duration of the delay.
26219 A negative number has a similar effect, but causes windows to be
26220 autoselected only after the mouse has stopped moving. \(Because of
26221 the way Emacs compares mouse events, you will occasionally wait twice
26222 that time before the window gets selected.\)
26223 Any other value means to autoselect window instantaneously when the
26224 mouse pointer enters it.
26226 Autoselection selects the minibuffer only if it is active, and never
26227 unselects the minibuffer if it is active.
26229 When customizing this variable make sure that the actual value of
26230 `focus-follows-mouse' matches the behavior of your window manager. */);
26231 Vmouse_autoselect_window
= Qnil
;
26233 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
26234 doc
: /* *Non-nil means automatically resize tool-bars.
26235 This dynamically changes the tool-bar's height to the minimum height
26236 that is needed to make all tool-bar items visible.
26237 If value is `grow-only', the tool-bar's height is only increased
26238 automatically; to decrease the tool-bar height, use \\[recenter]. */);
26239 Vauto_resize_tool_bars
= Qt
;
26241 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
26242 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
26243 auto_raise_tool_bar_buttons_p
= 1;
26245 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
26246 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
26247 make_cursor_line_fully_visible_p
= 1;
26249 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
26250 doc
: /* *Border below tool-bar in pixels.
26251 If an integer, use it as the height of the border.
26252 If it is one of `internal-border-width' or `border-width', use the
26253 value of the corresponding frame parameter.
26254 Otherwise, no border is added below the tool-bar. */);
26255 Vtool_bar_border
= Qinternal_border_width
;
26257 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
26258 doc
: /* *Margin around tool-bar buttons in pixels.
26259 If an integer, use that for both horizontal and vertical margins.
26260 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
26261 HORZ specifying the horizontal margin, and VERT specifying the
26262 vertical margin. */);
26263 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
26265 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
26266 doc
: /* *Relief thickness of tool-bar buttons. */);
26267 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
26269 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
26270 doc
: /* *Tool bar style to use.
26272 image - show images only
26273 text - show text only
26274 both - show both, text under image
26275 both-horiz - show text to the right of the image
26276 any other - use system default or image if no system default. */);
26277 Vtool_bar_style
= Qnil
;
26279 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
26280 doc
: /* *Maximum number of characters a label can have to be shown.
26281 The tool bar style must also show labels for this to have any effect, see
26282 `tool-bar-style'. */);
26283 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26285 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
26286 doc
: /* List of functions to call to fontify regions of text.
26287 Each function is called with one argument POS. Functions must
26288 fontify a region starting at POS in the current buffer, and give
26289 fontified regions the property `fontified'. */);
26290 Vfontification_functions
= Qnil
;
26291 Fmake_variable_buffer_local (Qfontification_functions
);
26293 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26294 &unibyte_display_via_language_environment
,
26295 doc
: /* *Non-nil means display unibyte text according to language environment.
26296 Specifically, this means that raw bytes in the range 160-255 decimal
26297 are displayed by converting them to the equivalent multibyte characters
26298 according to the current language environment. As a result, they are
26299 displayed according to the current fontset.
26301 Note that this variable affects only how these bytes are displayed,
26302 but does not change the fact they are interpreted as raw bytes. */);
26303 unibyte_display_via_language_environment
= 0;
26305 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
26306 doc
: /* *Maximum height for resizing mini-windows.
26307 If a float, it specifies a fraction of the mini-window frame's height.
26308 If an integer, it specifies a number of lines. */);
26309 Vmax_mini_window_height
= make_float (0.25);
26311 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
26312 doc
: /* *How to resize mini-windows.
26313 A value of nil means don't automatically resize mini-windows.
26314 A value of t means resize them to fit the text displayed in them.
26315 A value of `grow-only', the default, means let mini-windows grow
26316 only, until their display becomes empty, at which point the windows
26317 go back to their normal size. */);
26318 Vresize_mini_windows
= Qgrow_only
;
26320 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
26321 doc
: /* Alist specifying how to blink the cursor off.
26322 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26323 `cursor-type' frame-parameter or variable equals ON-STATE,
26324 comparing using `equal', Emacs uses OFF-STATE to specify
26325 how to blink it off. ON-STATE and OFF-STATE are values for
26326 the `cursor-type' frame parameter.
26328 If a frame's ON-STATE has no entry in this list,
26329 the frame's other specifications determine how to blink the cursor off. */);
26330 Vblink_cursor_alist
= Qnil
;
26332 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
26333 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
26334 automatic_hscrolling_p
= 1;
26335 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26336 staticpro (&Qauto_hscroll_mode
);
26338 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
26339 doc
: /* *How many columns away from the window edge point is allowed to get
26340 before automatic hscrolling will horizontally scroll the window. */);
26341 hscroll_margin
= 5;
26343 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
26344 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26345 When point is less than `hscroll-margin' columns from the window
26346 edge, automatic hscrolling will scroll the window by the amount of columns
26347 determined by this variable. If its value is a positive integer, scroll that
26348 many columns. If it's a positive floating-point number, it specifies the
26349 fraction of the window's width to scroll. If it's nil or zero, point will be
26350 centered horizontally after the scroll. Any other value, including negative
26351 numbers, are treated as if the value were zero.
26353 Automatic hscrolling always moves point outside the scroll margin, so if
26354 point was more than scroll step columns inside the margin, the window will
26355 scroll more than the value given by the scroll step.
26357 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26358 and `scroll-right' overrides this variable's effect. */);
26359 Vhscroll_step
= make_number (0);
26361 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
26362 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26363 Bind this around calls to `message' to let it take effect. */);
26364 message_truncate_lines
= 0;
26366 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
26367 doc
: /* Normal hook run to update the menu bar definitions.
26368 Redisplay runs this hook before it redisplays the menu bar.
26369 This is used to update submenus such as Buffers,
26370 whose contents depend on various data. */);
26371 Vmenu_bar_update_hook
= Qnil
;
26373 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26374 doc
: /* Frame for which we are updating a menu.
26375 The enable predicate for a menu binding should check this variable. */);
26376 Vmenu_updating_frame
= Qnil
;
26378 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26379 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26380 inhibit_menubar_update
= 0;
26382 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26383 doc
: /* Prefix prepended to all continuation lines at display time.
26384 The value may be a string, an image, or a stretch-glyph; it is
26385 interpreted in the same way as the value of a `display' text property.
26387 This variable is overridden by any `wrap-prefix' text or overlay
26390 To add a prefix to non-continuation lines, use `line-prefix'. */);
26391 Vwrap_prefix
= Qnil
;
26392 staticpro (&Qwrap_prefix
);
26393 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26394 Fmake_variable_buffer_local (Qwrap_prefix
);
26396 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26397 doc
: /* Prefix prepended to all non-continuation lines at display time.
26398 The value may be a string, an image, or a stretch-glyph; it is
26399 interpreted in the same way as the value of a `display' text property.
26401 This variable is overridden by any `line-prefix' text or overlay
26404 To add a prefix to continuation lines, use `wrap-prefix'. */);
26405 Vline_prefix
= Qnil
;
26406 staticpro (&Qline_prefix
);
26407 Qline_prefix
= intern_c_string ("line-prefix");
26408 Fmake_variable_buffer_local (Qline_prefix
);
26410 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26411 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26412 inhibit_eval_during_redisplay
= 0;
26414 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26415 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26416 inhibit_free_realized_faces
= 0;
26419 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26420 doc
: /* Inhibit try_window_id display optimization. */);
26421 inhibit_try_window_id
= 0;
26423 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26424 doc
: /* Inhibit try_window_reusing display optimization. */);
26425 inhibit_try_window_reusing
= 0;
26427 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26428 doc
: /* Inhibit try_cursor_movement display optimization. */);
26429 inhibit_try_cursor_movement
= 0;
26430 #endif /* GLYPH_DEBUG */
26432 DEFVAR_INT ("overline-margin", &overline_margin
,
26433 doc
: /* *Space between overline and text, in pixels.
26434 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26435 margin to the caracter height. */);
26436 overline_margin
= 2;
26438 DEFVAR_INT ("underline-minimum-offset",
26439 &underline_minimum_offset
,
26440 doc
: /* Minimum distance between baseline and underline.
26441 This can improve legibility of underlined text at small font sizes,
26442 particularly when using variable `x-use-underline-position-properties'
26443 with fonts that specify an UNDERLINE_POSITION relatively close to the
26444 baseline. The default value is 1. */);
26445 underline_minimum_offset
= 1;
26447 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26448 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26449 display_hourglass_p
= 1;
26451 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26452 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26453 Value must be an integer or float. */);
26454 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26456 hourglass_atimer
= NULL
;
26457 hourglass_shown_p
= 0;
26461 /* Initialize this module when Emacs starts. */
26466 Lisp_Object root_window
;
26467 struct window
*mini_w
;
26469 current_header_line_height
= current_mode_line_height
= -1;
26471 CHARPOS (this_line_start_pos
) = 0;
26473 mini_w
= XWINDOW (minibuf_window
);
26474 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26476 if (!noninteractive
)
26478 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26481 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26482 set_window_height (root_window
,
26483 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26485 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26486 set_window_height (minibuf_window
, 1, 0);
26488 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26489 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26491 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26492 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26493 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26495 /* The default ellipsis glyphs `...'. */
26496 for (i
= 0; i
< 3; ++i
)
26497 default_invis_vector
[i
] = make_number ('.');
26501 /* Allocate the buffer for frame titles.
26502 Also used for `format-mode-line'. */
26504 mode_line_noprop_buf
= (char *) xmalloc (size
);
26505 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26506 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26507 mode_line_target
= MODE_LINE_DISPLAY
;
26510 help_echo_showing_p
= 0;
26513 /* Since w32 does not support atimers, it defines its own implementation of
26514 the following three functions in w32fns.c. */
26517 /* Platform-independent portion of hourglass implementation. */
26519 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26521 hourglass_started ()
26523 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26526 /* Cancel a currently active hourglass timer, and start a new one. */
26530 #if defined (HAVE_WINDOW_SYSTEM)
26532 int secs
, usecs
= 0;
26534 cancel_hourglass ();
26536 if (INTEGERP (Vhourglass_delay
)
26537 && XINT (Vhourglass_delay
) > 0)
26538 secs
= XFASTINT (Vhourglass_delay
);
26539 else if (FLOATP (Vhourglass_delay
)
26540 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26543 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26544 secs
= XFASTINT (tem
);
26545 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26548 secs
= DEFAULT_HOURGLASS_DELAY
;
26550 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26551 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26552 show_hourglass
, NULL
);
26557 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26560 cancel_hourglass ()
26562 #if defined (HAVE_WINDOW_SYSTEM)
26563 if (hourglass_atimer
)
26565 cancel_atimer (hourglass_atimer
);
26566 hourglass_atimer
= NULL
;
26569 if (hourglass_shown_p
)
26573 #endif /* ! WINDOWSNT */
26575 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26576 (do not change this comment) */