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_move_to_visually_next, 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 (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
) (struct it
*it
);
837 static enum prop_handled
handle_face_prop (struct it
*);
838 static enum prop_handled
handle_invisible_prop (struct it
*);
839 static enum prop_handled
handle_display_prop (struct it
*);
840 static enum prop_handled
handle_composition_prop (struct it
*);
841 static enum prop_handled
handle_overlay_change (struct it
*);
842 static enum prop_handled
handle_fontified_prop (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 (struct it
*, int);
953 static void mark_window_display_accurate_1 (struct window
*, int);
954 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
955 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
956 static int cursor_row_p (struct window
*, struct glyph_row
*);
957 static int redisplay_mode_lines (Lisp_Object
, int);
958 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
960 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
962 static void handle_line_prefix (struct it
*);
964 static void pint2str (char *, int, int);
965 static void pint2hrstr (char *, int, int);
966 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
968 static void reconsider_clip_changes (struct window
*, struct buffer
*);
969 static int text_outside_line_unchanged_p (struct window
*, int, int);
970 static void store_mode_line_noprop_char (char);
971 static int store_mode_line_noprop (const unsigned char *, int, int);
972 static void x_consider_frame_title (Lisp_Object
);
973 static void handle_stop (struct it
*);
974 static void handle_stop_backwards (struct it
*, EMACS_INT
);
975 static int tool_bar_lines_needed (struct frame
*, int *);
976 static int single_display_spec_intangible_p (Lisp_Object
);
977 static void ensure_echo_area_buffers (void);
978 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
979 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
980 static int with_echo_area_buffer (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 (void);
984 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
985 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
986 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
987 static int display_echo_area (struct window
*);
988 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
989 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
990 static Lisp_Object
unwind_redisplay (Lisp_Object
);
991 static int string_char_and_length (const unsigned char *, int *);
992 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
994 static int compute_window_start_on_continuation_line (struct window
*);
995 static Lisp_Object
safe_eval_handler (Lisp_Object
);
996 static void insert_left_trunc_glyphs (struct it
*);
997 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
999 static void extend_face_to_end_of_line (struct it
*);
1000 static int append_space_for_newline (struct it
*, int);
1001 static int cursor_row_fully_visible_p (struct window
*, int, int);
1002 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
1003 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
1004 static int trailing_whitespace_p (int);
1005 static int message_log_check_duplicate (int, int, int, int);
1006 static void push_it (struct it
*);
1007 static void pop_it (struct it
*);
1008 static void sync_frame_with_window_matrix_rows (struct window
*);
1009 static void select_frame_for_redisplay (Lisp_Object
);
1010 static void redisplay_internal (int);
1011 static int echo_area_display (int);
1012 static void redisplay_windows (Lisp_Object
);
1013 static void redisplay_window (Lisp_Object
, int);
1014 static Lisp_Object
redisplay_window_error (Lisp_Object
);
1015 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
1016 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
1017 static int update_menu_bar (struct frame
*, int, int);
1018 static int try_window_reusing_current_matrix (struct window
*);
1019 static int try_window_id (struct window
*);
1020 static int display_line (struct it
*);
1021 static int display_mode_lines (struct window
*);
1022 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
1023 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
1024 static int store_mode_line_string (char *, Lisp_Object
, int, int, int, Lisp_Object
);
1025 static char *decode_mode_spec (struct window
*, int, int, int,
1027 static void display_menu_bar (struct window
*);
1028 static int display_count_lines (int, int, int, int, int *);
1029 static int display_string (unsigned char *, Lisp_Object
, Lisp_Object
,
1030 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
1031 static void compute_line_metrics (struct it
*);
1032 static void run_redisplay_end_trigger_hook (struct it
*);
1033 static int get_overlay_strings (struct it
*, int);
1034 static int get_overlay_strings_1 (struct it
*, int, int);
1035 static void next_overlay_string (struct it
*);
1036 static void reseat (struct it
*, struct text_pos
, int);
1037 static void reseat_1 (struct it
*, struct text_pos
, int);
1038 static void back_to_previous_visible_line_start (struct it
*);
1039 void reseat_at_previous_visible_line_start (struct it
*);
1040 static void reseat_at_next_visible_line_start (struct it
*, int);
1041 static int next_element_from_ellipsis (struct it
*);
1042 static int next_element_from_display_vector (struct it
*);
1043 static int next_element_from_string (struct it
*);
1044 static int next_element_from_c_string (struct it
*);
1045 static int next_element_from_buffer (struct it
*);
1046 static int next_element_from_composition (struct it
*);
1047 static int next_element_from_image (struct it
*);
1048 static int next_element_from_stretch (struct it
*);
1049 static void load_overlay_strings (struct it
*, int);
1050 static int init_from_display_pos (struct it
*, struct window
*,
1051 struct display_pos
*);
1052 static void reseat_to_string (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 (struct it
*, int);
1058 static void init_to_row_start (struct it
*, struct window
*,
1059 struct glyph_row
*);
1060 static int init_to_row_end (struct it
*, struct window
*,
1061 struct glyph_row
*);
1062 static void back_to_previous_line_start (struct it
*);
1063 static int forward_to_next_line_start (struct it
*, int *);
1064 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
1066 static struct text_pos
string_pos (int, Lisp_Object
);
1067 static struct text_pos
c_string_pos (int, unsigned char *, int);
1068 static int number_of_chars (unsigned char *, int);
1069 static void compute_stop_pos (struct it
*);
1070 static void compute_string_pos (struct text_pos
*, struct text_pos
,
1072 static int face_before_or_after_it_pos (struct it
*, int);
1073 static EMACS_INT
next_overlay_change (EMACS_INT
);
1074 static int handle_single_display_spec (struct it
*, Lisp_Object
,
1075 Lisp_Object
, Lisp_Object
,
1076 struct text_pos
*, int);
1077 static int underlying_face_id (struct it
*);
1078 static int in_ellipses_for_invisible_text_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 (struct frame
*, int);
1087 static void build_desired_tool_bar_string (struct frame
*f
);
1088 static int redisplay_tool_bar (struct frame
*);
1089 static void display_tool_bar_line (struct it
*, int);
1090 static void notice_overwritten_cursor (struct window
*,
1091 enum glyph_row_area
,
1092 int, int, int, int);
1093 static void append_stretch_glyph (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 (struct window
*w
)
1114 int height
= WINDOW_TOTAL_HEIGHT (w
);
1116 if (WINDOW_WANTS_MODELINE_P (w
))
1117 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1121 /* Return the pixel width of display area AREA of window W. AREA < 0
1122 means return the total width of W, not including fringes to
1123 the left and right of the window. */
1126 window_box_width (struct window
*w
, int area
)
1128 int cols
= XFASTINT (w
->total_cols
);
1131 if (!w
->pseudo_window_p
)
1133 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
1135 if (area
== TEXT_AREA
)
1137 if (INTEGERP (w
->left_margin_cols
))
1138 cols
-= XFASTINT (w
->left_margin_cols
);
1139 if (INTEGERP (w
->right_margin_cols
))
1140 cols
-= XFASTINT (w
->right_margin_cols
);
1141 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
1143 else if (area
== LEFT_MARGIN_AREA
)
1145 cols
= (INTEGERP (w
->left_margin_cols
)
1146 ? XFASTINT (w
->left_margin_cols
) : 0);
1149 else if (area
== RIGHT_MARGIN_AREA
)
1151 cols
= (INTEGERP (w
->right_margin_cols
)
1152 ? XFASTINT (w
->right_margin_cols
) : 0);
1157 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1161 /* Return the pixel height of the display area of window W, not
1162 including mode lines of W, if any. */
1165 window_box_height (struct window
*w
)
1167 struct frame
*f
= XFRAME (w
->frame
);
1168 int height
= WINDOW_TOTAL_HEIGHT (w
);
1170 xassert (height
>= 0);
1172 /* Note: the code below that determines the mode-line/header-line
1173 height is essentially the same as that contained in the macro
1174 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1175 the appropriate glyph row has its `mode_line_p' flag set,
1176 and if it doesn't, uses estimate_mode_line_height instead. */
1178 if (WINDOW_WANTS_MODELINE_P (w
))
1180 struct glyph_row
*ml_row
1181 = (w
->current_matrix
&& w
->current_matrix
->rows
1182 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1184 if (ml_row
&& ml_row
->mode_line_p
)
1185 height
-= ml_row
->height
;
1187 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1190 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1192 struct glyph_row
*hl_row
1193 = (w
->current_matrix
&& w
->current_matrix
->rows
1194 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1196 if (hl_row
&& hl_row
->mode_line_p
)
1197 height
-= hl_row
->height
;
1199 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1202 /* With a very small font and a mode-line that's taller than
1203 default, we might end up with a negative height. */
1204 return max (0, height
);
1207 /* Return the window-relative coordinate of the left edge of display
1208 area AREA of window W. AREA < 0 means return the left edge of the
1209 whole window, to the right of the left fringe of W. */
1212 window_box_left_offset (struct window
*w
, int area
)
1216 if (w
->pseudo_window_p
)
1219 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1221 if (area
== TEXT_AREA
)
1222 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1223 + window_box_width (w
, LEFT_MARGIN_AREA
));
1224 else if (area
== RIGHT_MARGIN_AREA
)
1225 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1226 + window_box_width (w
, LEFT_MARGIN_AREA
)
1227 + window_box_width (w
, TEXT_AREA
)
1228 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1230 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1231 else if (area
== LEFT_MARGIN_AREA
1232 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1233 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1239 /* Return the window-relative coordinate of the right edge of display
1240 area AREA of window W. AREA < 0 means return the left edge of the
1241 whole window, to the left of the right fringe of W. */
1244 window_box_right_offset (struct window
*w
, int area
)
1246 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1249 /* Return the frame-relative coordinate of the left edge of display
1250 area AREA of window W. AREA < 0 means return the left edge of the
1251 whole window, to the right of the left fringe of W. */
1254 window_box_left (struct window
*w
, int area
)
1256 struct frame
*f
= XFRAME (w
->frame
);
1259 if (w
->pseudo_window_p
)
1260 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1262 x
= (WINDOW_LEFT_EDGE_X (w
)
1263 + window_box_left_offset (w
, area
));
1269 /* Return the frame-relative coordinate of the right edge of display
1270 area AREA of window W. AREA < 0 means return the left edge of the
1271 whole window, to the left of the right fringe of W. */
1274 window_box_right (struct window
*w
, int area
)
1276 return window_box_left (w
, area
) + window_box_width (w
, area
);
1279 /* Get the bounding box of the display area AREA of window W, without
1280 mode lines, in frame-relative coordinates. AREA < 0 means the
1281 whole window, not including the left and right fringes of
1282 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1283 coordinates of the upper-left corner of the box. Return in
1284 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1287 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1288 int *box_width
, int *box_height
)
1291 *box_width
= window_box_width (w
, area
);
1293 *box_height
= window_box_height (w
);
1295 *box_x
= window_box_left (w
, area
);
1298 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1299 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1300 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1305 /* Get the bounding box of the display area AREA of window W, without
1306 mode lines. AREA < 0 means the whole window, not including the
1307 left and right fringe of the window. Return in *TOP_LEFT_X
1308 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1309 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1310 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1314 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1315 int *bottom_right_x
, int *bottom_right_y
)
1317 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1319 *bottom_right_x
+= *top_left_x
;
1320 *bottom_right_y
+= *top_left_y
;
1325 /***********************************************************************
1327 ***********************************************************************/
1329 /* Return the bottom y-position of the line the iterator IT is in.
1330 This can modify IT's settings. */
1333 line_bottom_y (struct it
*it
)
1335 int line_height
= it
->max_ascent
+ it
->max_descent
;
1336 int line_top_y
= it
->current_y
;
1338 if (line_height
== 0)
1341 line_height
= last_height
;
1342 else if (IT_CHARPOS (*it
) < ZV
)
1344 move_it_by_lines (it
, 1, 1);
1345 line_height
= (it
->max_ascent
|| it
->max_descent
1346 ? it
->max_ascent
+ it
->max_descent
1351 struct glyph_row
*row
= it
->glyph_row
;
1353 /* Use the default character height. */
1354 it
->glyph_row
= NULL
;
1355 it
->what
= IT_CHARACTER
;
1358 PRODUCE_GLYPHS (it
);
1359 line_height
= it
->ascent
+ it
->descent
;
1360 it
->glyph_row
= row
;
1364 return line_top_y
+ line_height
;
1368 /* Return 1 if position CHARPOS is visible in window W.
1369 CHARPOS < 0 means return info about WINDOW_END position.
1370 If visible, set *X and *Y to pixel coordinates of top left corner.
1371 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1372 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1375 pos_visible_p (struct window
*w
, int charpos
, int *x
, int *y
,
1376 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1379 struct text_pos top
;
1381 struct buffer
*old_buffer
= NULL
;
1383 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1386 if (XBUFFER (w
->buffer
) != current_buffer
)
1388 old_buffer
= current_buffer
;
1389 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1392 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1394 /* Compute exact mode line heights. */
1395 if (WINDOW_WANTS_MODELINE_P (w
))
1396 current_mode_line_height
1397 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1398 current_buffer
->mode_line_format
);
1400 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1401 current_header_line_height
1402 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1403 current_buffer
->header_line_format
);
1405 start_display (&it
, w
, top
);
1406 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1407 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1409 if (charpos
>= 0 && IT_CHARPOS (it
) >= charpos
)
1411 /* We have reached CHARPOS, or passed it. How the call to
1412 move_it_to can overshoot: (i) If CHARPOS is on invisible
1413 text, move_it_to stops at the end of the invisible text,
1414 after CHARPOS. (ii) If CHARPOS is in a display vector,
1415 move_it_to stops on its last glyph. */
1416 int top_x
= it
.current_x
;
1417 int top_y
= it
.current_y
;
1418 enum it_method it_method
= it
.method
;
1419 /* Calling line_bottom_y may change it.method, it.position, etc. */
1420 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1421 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1423 if (top_y
< window_top_y
)
1424 visible_p
= bottom_y
> window_top_y
;
1425 else if (top_y
< it
.last_visible_y
)
1429 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1431 /* We stopped on the last glyph of a display vector.
1432 Try and recompute. Hack alert! */
1433 if (charpos
< 2 || top
.charpos
>= charpos
)
1434 top_x
= it
.glyph_row
->x
;
1438 start_display (&it2
, w
, top
);
1439 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1440 get_next_display_element (&it2
);
1441 PRODUCE_GLYPHS (&it2
);
1442 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1443 || it2
.current_x
> it2
.last_visible_x
)
1444 top_x
= it
.glyph_row
->x
;
1447 top_x
= it2
.current_x
;
1448 top_y
= it2
.current_y
;
1454 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1455 *rtop
= max (0, window_top_y
- top_y
);
1456 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1457 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1458 - max (top_y
, window_top_y
)));
1467 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1468 move_it_by_lines (&it
, 1, 0);
1469 if (charpos
< IT_CHARPOS (it
)
1470 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1473 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1475 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1476 *rtop
= max (0, -it2
.current_y
);
1477 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1478 - it
.last_visible_y
));
1479 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1481 - max (it2
.current_y
,
1482 WINDOW_HEADER_LINE_HEIGHT (w
))));
1488 set_buffer_internal_1 (old_buffer
);
1490 current_header_line_height
= current_mode_line_height
= -1;
1492 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1493 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1496 /* Debugging code. */
1498 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1499 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1501 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1508 /* Return the next character from STR which is MAXLEN bytes long.
1509 Return in *LEN the length of the character. This is like
1510 STRING_CHAR_AND_LENGTH but never returns an invalid character. If
1511 we find one, we return a `?', but with the length of the invalid
1515 string_char_and_length (const unsigned char *str
, int *len
)
1519 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1520 if (!CHAR_VALID_P (c
, 1))
1521 /* We may not change the length here because other places in Emacs
1522 don't use this function, i.e. they silently accept invalid
1531 /* Given a position POS containing a valid character and byte position
1532 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1534 static struct text_pos
1535 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, int nchars
)
1537 xassert (STRINGP (string
) && nchars
>= 0);
1539 if (STRING_MULTIBYTE (string
))
1541 int rest
= SBYTES (string
) - BYTEPOS (pos
);
1542 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1547 string_char_and_length (p
, &len
);
1548 p
+= len
, rest
-= len
;
1549 xassert (rest
>= 0);
1551 BYTEPOS (pos
) += len
;
1555 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1561 /* Value is the text position, i.e. character and byte position,
1562 for character position CHARPOS in STRING. */
1564 static INLINE
struct text_pos
1565 string_pos (int charpos
, Lisp_Object string
)
1567 struct text_pos pos
;
1568 xassert (STRINGP (string
));
1569 xassert (charpos
>= 0);
1570 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1575 /* Value is a text position, i.e. character and byte position, for
1576 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1577 means recognize multibyte characters. */
1579 static struct text_pos
1580 c_string_pos (int charpos
, unsigned char *s
, int multibyte_p
)
1582 struct text_pos pos
;
1584 xassert (s
!= NULL
);
1585 xassert (charpos
>= 0);
1589 int rest
= strlen (s
), len
;
1591 SET_TEXT_POS (pos
, 0, 0);
1594 string_char_and_length (s
, &len
);
1595 s
+= len
, rest
-= len
;
1596 xassert (rest
>= 0);
1598 BYTEPOS (pos
) += len
;
1602 SET_TEXT_POS (pos
, charpos
, charpos
);
1608 /* Value is the number of characters in C string S. MULTIBYTE_P
1609 non-zero means recognize multibyte characters. */
1612 number_of_chars (unsigned char *s
, int multibyte_p
)
1618 int rest
= strlen (s
), len
;
1619 unsigned char *p
= (unsigned char *) s
;
1621 for (nchars
= 0; rest
> 0; ++nchars
)
1623 string_char_and_length (p
, &len
);
1624 rest
-= len
, p
+= len
;
1628 nchars
= strlen (s
);
1634 /* Compute byte position NEWPOS->bytepos corresponding to
1635 NEWPOS->charpos. POS is a known position in string STRING.
1636 NEWPOS->charpos must be >= POS.charpos. */
1639 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1641 xassert (STRINGP (string
));
1642 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1644 if (STRING_MULTIBYTE (string
))
1645 *newpos
= string_pos_nchars_ahead (pos
, string
,
1646 CHARPOS (*newpos
) - CHARPOS (pos
));
1648 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1652 Return an estimation of the pixel height of mode or header lines on
1653 frame F. FACE_ID specifies what line's height to estimate. */
1656 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1658 #ifdef HAVE_WINDOW_SYSTEM
1659 if (FRAME_WINDOW_P (f
))
1661 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1663 /* This function is called so early when Emacs starts that the face
1664 cache and mode line face are not yet initialized. */
1665 if (FRAME_FACE_CACHE (f
))
1667 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1671 height
= FONT_HEIGHT (face
->font
);
1672 if (face
->box_line_width
> 0)
1673 height
+= 2 * face
->box_line_width
;
1684 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1685 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1686 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1687 not force the value into range. */
1690 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1691 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1694 #ifdef HAVE_WINDOW_SYSTEM
1695 if (FRAME_WINDOW_P (f
))
1697 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1698 even for negative values. */
1700 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1702 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1704 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1705 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1708 STORE_NATIVE_RECT (*bounds
,
1709 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1710 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1711 FRAME_COLUMN_WIDTH (f
) - 1,
1712 FRAME_LINE_HEIGHT (f
) - 1);
1718 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1719 pix_x
= FRAME_TOTAL_COLS (f
);
1723 else if (pix_y
> FRAME_LINES (f
))
1724 pix_y
= FRAME_LINES (f
);
1734 /* Given HPOS/VPOS in the current matrix of W, return corresponding
1735 frame-relative pixel positions in *FRAME_X and *FRAME_Y. If we
1736 can't tell the positions because W's display is not up to date,
1740 glyph_to_pixel_coords (struct window
*w
, int hpos
, int vpos
,
1741 int *frame_x
, int *frame_y
)
1743 #ifdef HAVE_WINDOW_SYSTEM
1744 if (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))))
1748 xassert (hpos
>= 0 && hpos
< w
->current_matrix
->matrix_w
);
1749 xassert (vpos
>= 0 && vpos
< w
->current_matrix
->matrix_h
);
1751 if (display_completed
)
1753 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
1754 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1755 struct glyph
*end
= glyph
+ min (hpos
, row
->used
[TEXT_AREA
]);
1761 hpos
+= glyph
->pixel_width
;
1765 /* If first glyph is partially visible, its first visible position is still 0. */
1777 *frame_x
= WINDOW_TO_FRAME_PIXEL_X (w
, hpos
);
1778 *frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, vpos
);
1789 #ifdef HAVE_WINDOW_SYSTEM
1791 /* Find the glyph under window-relative coordinates X/Y in window W.
1792 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1793 strings. Return in *HPOS and *VPOS the row and column number of
1794 the glyph found. Return in *AREA the glyph area containing X.
1795 Value is a pointer to the glyph found or null if X/Y is not on
1796 text, or we can't tell because W's current matrix is not up to
1801 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1802 int *dx
, int *dy
, int *area
)
1804 struct glyph
*glyph
, *end
;
1805 struct glyph_row
*row
= NULL
;
1808 /* Find row containing Y. Give up if some row is not enabled. */
1809 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1811 row
= MATRIX_ROW (w
->current_matrix
, i
);
1812 if (!row
->enabled_p
)
1814 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1821 /* Give up if Y is not in the window. */
1822 if (i
== w
->current_matrix
->nrows
)
1825 /* Get the glyph area containing X. */
1826 if (w
->pseudo_window_p
)
1833 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1835 *area
= LEFT_MARGIN_AREA
;
1836 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1838 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1841 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1845 *area
= RIGHT_MARGIN_AREA
;
1846 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1850 /* Find glyph containing X. */
1851 glyph
= row
->glyphs
[*area
];
1852 end
= glyph
+ row
->used
[*area
];
1854 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1856 x
-= glyph
->pixel_width
;
1866 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1869 *hpos
= glyph
- row
->glyphs
[*area
];
1875 Convert frame-relative x/y to coordinates relative to window W.
1876 Takes pseudo-windows into account. */
1879 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1881 if (w
->pseudo_window_p
)
1883 /* A pseudo-window is always full-width, and starts at the
1884 left edge of the frame, plus a frame border. */
1885 struct frame
*f
= XFRAME (w
->frame
);
1886 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1887 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1891 *x
-= WINDOW_LEFT_EDGE_X (w
);
1892 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1897 Return in RECTS[] at most N clipping rectangles for glyph string S.
1898 Return the number of stored rectangles. */
1901 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1908 if (s
->row
->full_width_p
)
1910 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1911 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1912 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1914 /* Unless displaying a mode or menu bar line, which are always
1915 fully visible, clip to the visible part of the row. */
1916 if (s
->w
->pseudo_window_p
)
1917 r
.height
= s
->row
->visible_height
;
1919 r
.height
= s
->height
;
1923 /* This is a text line that may be partially visible. */
1924 r
.x
= window_box_left (s
->w
, s
->area
);
1925 r
.width
= window_box_width (s
->w
, s
->area
);
1926 r
.height
= s
->row
->visible_height
;
1930 if (r
.x
< s
->clip_head
->x
)
1932 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1933 r
.width
-= s
->clip_head
->x
- r
.x
;
1936 r
.x
= s
->clip_head
->x
;
1939 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1941 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1942 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1947 /* If S draws overlapping rows, it's sufficient to use the top and
1948 bottom of the window for clipping because this glyph string
1949 intentionally draws over other lines. */
1950 if (s
->for_overlaps
)
1952 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1953 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1955 /* Alas, the above simple strategy does not work for the
1956 environments with anti-aliased text: if the same text is
1957 drawn onto the same place multiple times, it gets thicker.
1958 If the overlap we are processing is for the erased cursor, we
1959 take the intersection with the rectagle of the cursor. */
1960 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1962 XRectangle rc
, r_save
= r
;
1964 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1965 rc
.y
= s
->w
->phys_cursor
.y
;
1966 rc
.width
= s
->w
->phys_cursor_width
;
1967 rc
.height
= s
->w
->phys_cursor_height
;
1969 x_intersect_rectangles (&r_save
, &rc
, &r
);
1974 /* Don't use S->y for clipping because it doesn't take partially
1975 visible lines into account. For example, it can be negative for
1976 partially visible lines at the top of a window. */
1977 if (!s
->row
->full_width_p
1978 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1979 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1981 r
.y
= max (0, s
->row
->y
);
1984 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1986 /* If drawing the cursor, don't let glyph draw outside its
1987 advertised boundaries. Cleartype does this under some circumstances. */
1988 if (s
->hl
== DRAW_CURSOR
)
1990 struct glyph
*glyph
= s
->first_glyph
;
1995 r
.width
-= s
->x
- r
.x
;
1998 r
.width
= min (r
.width
, glyph
->pixel_width
);
2000 /* If r.y is below window bottom, ensure that we still see a cursor. */
2001 height
= min (glyph
->ascent
+ glyph
->descent
,
2002 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2003 max_y
= window_text_bottom_y (s
->w
) - height
;
2004 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2005 if (s
->ybase
- glyph
->ascent
> max_y
)
2012 /* Don't draw cursor glyph taller than our actual glyph. */
2013 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2014 if (height
< r
.height
)
2016 max_y
= r
.y
+ r
.height
;
2017 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2018 r
.height
= min (max_y
- r
.y
, height
);
2025 XRectangle r_save
= r
;
2027 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2031 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2032 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2034 #ifdef CONVERT_FROM_XRECT
2035 CONVERT_FROM_XRECT (r
, *rects
);
2043 /* If we are processing overlapping and allowed to return
2044 multiple clipping rectangles, we exclude the row of the glyph
2045 string from the clipping rectangle. This is to avoid drawing
2046 the same text on the environment with anti-aliasing. */
2047 #ifdef CONVERT_FROM_XRECT
2050 XRectangle
*rs
= rects
;
2052 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2054 if (s
->for_overlaps
& OVERLAPS_PRED
)
2057 if (r
.y
+ r
.height
> row_y
)
2060 rs
[i
].height
= row_y
- r
.y
;
2066 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2069 if (r
.y
< row_y
+ s
->row
->visible_height
)
2071 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2073 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2074 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2083 #ifdef CONVERT_FROM_XRECT
2084 for (i
= 0; i
< n
; i
++)
2085 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2092 Return in *NR the clipping rectangle for glyph string S. */
2095 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2097 get_glyph_string_clip_rects (s
, nr
, 1);
2102 Return the position and height of the phys cursor in window W.
2103 Set w->phys_cursor_width to width of phys cursor.
2107 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2108 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2110 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2111 int x
, y
, wd
, h
, h0
, y0
;
2113 /* Compute the width of the rectangle to draw. If on a stretch
2114 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2115 rectangle as wide as the glyph, but use a canonical character
2117 wd
= glyph
->pixel_width
- 1;
2118 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
2122 x
= w
->phys_cursor
.x
;
2129 if (glyph
->type
== STRETCH_GLYPH
2130 && !x_stretch_cursor_p
)
2131 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2132 w
->phys_cursor_width
= wd
;
2134 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2136 /* If y is below window bottom, ensure that we still see a cursor. */
2137 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2139 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2140 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2142 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2145 h
= max (h
- (y0
- y
) + 1, h0
);
2150 y0
= window_text_bottom_y (w
) - h0
;
2158 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2159 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2164 * Remember which glyph the mouse is over.
2168 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2172 struct glyph_row
*r
, *gr
, *end_row
;
2173 enum window_part part
;
2174 enum glyph_row_area area
;
2175 int x
, y
, width
, height
;
2177 /* Try to determine frame pixel position and size of the glyph under
2178 frame pixel coordinates X/Y on frame F. */
2180 if (!f
->glyphs_initialized_p
2181 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, &x
, &y
, 0),
2184 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2185 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2189 w
= XWINDOW (window
);
2190 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2191 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2193 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2194 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2196 if (w
->pseudo_window_p
)
2199 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2205 case ON_LEFT_MARGIN
:
2206 area
= LEFT_MARGIN_AREA
;
2209 case ON_RIGHT_MARGIN
:
2210 area
= RIGHT_MARGIN_AREA
;
2213 case ON_HEADER_LINE
:
2215 gr
= (part
== ON_HEADER_LINE
2216 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2217 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2220 goto text_glyph_row_found
;
2227 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2228 if (r
->y
+ r
->height
> y
)
2234 text_glyph_row_found
:
2237 struct glyph
*g
= gr
->glyphs
[area
];
2238 struct glyph
*end
= g
+ gr
->used
[area
];
2240 height
= gr
->height
;
2241 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2242 if (gx
+ g
->pixel_width
> x
)
2247 if (g
->type
== IMAGE_GLYPH
)
2249 /* Don't remember when mouse is over image, as
2250 image may have hot-spots. */
2251 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2254 width
= g
->pixel_width
;
2258 /* Use nominal char spacing at end of line. */
2260 gx
+= (x
/ width
) * width
;
2263 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2264 gx
+= window_box_left_offset (w
, area
);
2268 /* Use nominal line height at end of window. */
2269 gx
= (x
/ width
) * width
;
2271 gy
+= (y
/ height
) * height
;
2275 case ON_LEFT_FRINGE
:
2276 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2277 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2278 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2279 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2282 case ON_RIGHT_FRINGE
:
2283 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2284 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2285 : window_box_right_offset (w
, TEXT_AREA
));
2286 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2290 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2292 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2293 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2294 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2296 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2300 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2301 if (r
->y
+ r
->height
> y
)
2308 height
= gr
->height
;
2311 /* Use nominal line height at end of window. */
2313 gy
+= (y
/ height
) * height
;
2320 /* If there is no glyph under the mouse, then we divide the screen
2321 into a grid of the smallest glyph in the frame, and use that
2324 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2325 round down even for negative values. */
2331 gx
= (gx
/ width
) * width
;
2332 gy
= (gy
/ height
) * height
;
2337 gx
+= WINDOW_LEFT_EDGE_X (w
);
2338 gy
+= WINDOW_TOP_EDGE_Y (w
);
2341 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2343 /* Visible feedback for debugging. */
2346 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2347 f
->output_data
.x
->normal_gc
,
2348 gx
, gy
, width
, height
);
2354 #endif /* HAVE_WINDOW_SYSTEM */
2357 /***********************************************************************
2358 Lisp form evaluation
2359 ***********************************************************************/
2361 /* Error handler for safe_eval and safe_call. */
2364 safe_eval_handler (Lisp_Object arg
)
2366 add_to_log ("Error during redisplay: %s", arg
, Qnil
);
2371 /* Evaluate SEXPR and return the result, or nil if something went
2372 wrong. Prevent redisplay during the evaluation. */
2374 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2375 Return the result, or nil if something went wrong. Prevent
2376 redisplay during the evaluation. */
2379 safe_call (int nargs
, Lisp_Object
*args
)
2383 if (inhibit_eval_during_redisplay
)
2387 int count
= SPECPDL_INDEX ();
2388 struct gcpro gcpro1
;
2391 gcpro1
.nvars
= nargs
;
2392 specbind (Qinhibit_redisplay
, Qt
);
2393 /* Use Qt to ensure debugger does not run,
2394 so there is no possibility of wanting to redisplay. */
2395 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2398 val
= unbind_to (count
, val
);
2405 /* Call function FN with one argument ARG.
2406 Return the result, or nil if something went wrong. */
2409 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2411 Lisp_Object args
[2];
2414 return safe_call (2, args
);
2417 static Lisp_Object Qeval
;
2420 safe_eval (Lisp_Object sexpr
)
2422 return safe_call1 (Qeval
, sexpr
);
2425 /* Call function FN with one argument ARG.
2426 Return the result, or nil if something went wrong. */
2429 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2431 Lisp_Object args
[3];
2435 return safe_call (3, args
);
2440 /***********************************************************************
2442 ***********************************************************************/
2446 /* Define CHECK_IT to perform sanity checks on iterators.
2447 This is for debugging. It is too slow to do unconditionally. */
2453 if (it
->method
== GET_FROM_STRING
)
2455 xassert (STRINGP (it
->string
));
2456 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2460 xassert (IT_STRING_CHARPOS (*it
) < 0);
2461 if (it
->method
== GET_FROM_BUFFER
)
2463 /* Check that character and byte positions agree. */
2464 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2469 xassert (it
->current
.dpvec_index
>= 0);
2471 xassert (it
->current
.dpvec_index
< 0);
2474 #define CHECK_IT(IT) check_it ((IT))
2478 #define CHECK_IT(IT) (void) 0
2485 /* Check that the window end of window W is what we expect it
2486 to be---the last row in the current matrix displaying text. */
2489 check_window_end (w
)
2492 if (!MINI_WINDOW_P (w
)
2493 && !NILP (w
->window_end_valid
))
2495 struct glyph_row
*row
;
2496 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2497 XFASTINT (w
->window_end_vpos
)),
2499 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2500 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2504 #define CHECK_WINDOW_END(W) check_window_end ((W))
2506 #else /* not GLYPH_DEBUG */
2508 #define CHECK_WINDOW_END(W) (void) 0
2510 #endif /* not GLYPH_DEBUG */
2514 /***********************************************************************
2515 Iterator initialization
2516 ***********************************************************************/
2518 /* Initialize IT for displaying current_buffer in window W, starting
2519 at character position CHARPOS. CHARPOS < 0 means that no buffer
2520 position is specified which is useful when the iterator is assigned
2521 a position later. BYTEPOS is the byte position corresponding to
2522 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2524 If ROW is not null, calls to produce_glyphs with IT as parameter
2525 will produce glyphs in that row.
2527 BASE_FACE_ID is the id of a base face to use. It must be one of
2528 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2529 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2530 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2532 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2533 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2534 will be initialized to use the corresponding mode line glyph row of
2535 the desired matrix of W. */
2538 init_iterator (struct it
*it
, struct window
*w
,
2539 EMACS_INT charpos
, EMACS_INT bytepos
,
2540 struct glyph_row
*row
, enum face_id base_face_id
)
2542 int highlight_region_p
;
2543 enum face_id remapped_base_face_id
= base_face_id
;
2545 /* Some precondition checks. */
2546 xassert (w
!= NULL
&& it
!= NULL
);
2547 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2550 /* If face attributes have been changed since the last redisplay,
2551 free realized faces now because they depend on face definitions
2552 that might have changed. Don't free faces while there might be
2553 desired matrices pending which reference these faces. */
2554 if (face_change_count
&& !inhibit_free_realized_faces
)
2556 face_change_count
= 0;
2557 free_all_realized_faces (Qnil
);
2560 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2561 if (! NILP (Vface_remapping_alist
))
2562 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2564 /* Use one of the mode line rows of W's desired matrix if
2568 if (base_face_id
== MODE_LINE_FACE_ID
2569 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2570 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2571 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2572 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2576 memset (it
, 0, sizeof *it
);
2577 it
->current
.overlay_string_index
= -1;
2578 it
->current
.dpvec_index
= -1;
2579 it
->base_face_id
= remapped_base_face_id
;
2581 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2583 /* The window in which we iterate over current_buffer: */
2584 XSETWINDOW (it
->window
, w
);
2586 it
->f
= XFRAME (w
->frame
);
2590 /* Extra space between lines (on window systems only). */
2591 if (base_face_id
== DEFAULT_FACE_ID
2592 && FRAME_WINDOW_P (it
->f
))
2594 if (NATNUMP (current_buffer
->extra_line_spacing
))
2595 it
->extra_line_spacing
= XFASTINT (current_buffer
->extra_line_spacing
);
2596 else if (FLOATP (current_buffer
->extra_line_spacing
))
2597 it
->extra_line_spacing
= (XFLOAT_DATA (current_buffer
->extra_line_spacing
)
2598 * FRAME_LINE_HEIGHT (it
->f
));
2599 else if (it
->f
->extra_line_spacing
> 0)
2600 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2601 it
->max_extra_line_spacing
= 0;
2604 /* If realized faces have been removed, e.g. because of face
2605 attribute changes of named faces, recompute them. When running
2606 in batch mode, the face cache of the initial frame is null. If
2607 we happen to get called, make a dummy face cache. */
2608 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2609 init_frame_faces (it
->f
);
2610 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2611 recompute_basic_faces (it
->f
);
2613 /* Current value of the `slice', `space-width', and 'height' properties. */
2614 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2615 it
->space_width
= Qnil
;
2616 it
->font_height
= Qnil
;
2617 it
->override_ascent
= -1;
2619 /* Are control characters displayed as `^C'? */
2620 it
->ctl_arrow_p
= !NILP (current_buffer
->ctl_arrow
);
2622 /* -1 means everything between a CR and the following line end
2623 is invisible. >0 means lines indented more than this value are
2625 it
->selective
= (INTEGERP (current_buffer
->selective_display
)
2626 ? XFASTINT (current_buffer
->selective_display
)
2627 : (!NILP (current_buffer
->selective_display
)
2629 it
->selective_display_ellipsis_p
2630 = !NILP (current_buffer
->selective_display_ellipses
);
2632 /* Display table to use. */
2633 it
->dp
= window_display_table (w
);
2635 /* Are multibyte characters enabled in current_buffer? */
2636 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
2638 /* Do we need to reorder bidirectional text? Not if this is a
2639 unibyte buffer: by definition, none of the single-byte characters
2640 are strong R2L, so no reordering is needed. And bidi.c doesn't
2641 support unibyte buffers anyway. */
2643 = !NILP (current_buffer
->bidi_display_reordering
) && it
->multibyte_p
;
2645 /* Non-zero if we should highlight the region. */
2647 = (!NILP (Vtransient_mark_mode
)
2648 && !NILP (current_buffer
->mark_active
)
2649 && XMARKER (current_buffer
->mark
)->buffer
!= 0);
2651 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2652 start and end of a visible region in window IT->w. Set both to
2653 -1 to indicate no region. */
2654 if (highlight_region_p
2655 /* Maybe highlight only in selected window. */
2656 && (/* Either show region everywhere. */
2657 highlight_nonselected_windows
2658 /* Or show region in the selected window. */
2659 || w
== XWINDOW (selected_window
)
2660 /* Or show the region if we are in the mini-buffer and W is
2661 the window the mini-buffer refers to. */
2662 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2663 && WINDOWP (minibuf_selected_window
)
2664 && w
== XWINDOW (minibuf_selected_window
))))
2666 int charpos
= marker_position (current_buffer
->mark
);
2667 it
->region_beg_charpos
= min (PT
, charpos
);
2668 it
->region_end_charpos
= max (PT
, charpos
);
2671 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2673 /* Get the position at which the redisplay_end_trigger hook should
2674 be run, if it is to be run at all. */
2675 if (MARKERP (w
->redisplay_end_trigger
)
2676 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2677 it
->redisplay_end_trigger_charpos
2678 = marker_position (w
->redisplay_end_trigger
);
2679 else if (INTEGERP (w
->redisplay_end_trigger
))
2680 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2682 /* Correct bogus values of tab_width. */
2683 it
->tab_width
= XINT (current_buffer
->tab_width
);
2684 if (it
->tab_width
<= 0 || it
->tab_width
> 1000)
2687 /* Are lines in the display truncated? */
2688 if (base_face_id
!= DEFAULT_FACE_ID
2689 || XINT (it
->w
->hscroll
)
2690 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2691 && ((!NILP (Vtruncate_partial_width_windows
)
2692 && !INTEGERP (Vtruncate_partial_width_windows
))
2693 || (INTEGERP (Vtruncate_partial_width_windows
)
2694 && (WINDOW_TOTAL_COLS (it
->w
)
2695 < XINT (Vtruncate_partial_width_windows
))))))
2696 it
->line_wrap
= TRUNCATE
;
2697 else if (NILP (current_buffer
->truncate_lines
))
2698 it
->line_wrap
= NILP (current_buffer
->word_wrap
)
2699 ? WINDOW_WRAP
: WORD_WRAP
;
2701 it
->line_wrap
= TRUNCATE
;
2703 /* Get dimensions of truncation and continuation glyphs. These are
2704 displayed as fringe bitmaps under X, so we don't need them for such
2706 if (!FRAME_WINDOW_P (it
->f
))
2708 if (it
->line_wrap
== TRUNCATE
)
2710 /* We will need the truncation glyph. */
2711 xassert (it
->glyph_row
== NULL
);
2712 produce_special_glyphs (it
, IT_TRUNCATION
);
2713 it
->truncation_pixel_width
= it
->pixel_width
;
2717 /* We will need the continuation glyph. */
2718 xassert (it
->glyph_row
== NULL
);
2719 produce_special_glyphs (it
, IT_CONTINUATION
);
2720 it
->continuation_pixel_width
= it
->pixel_width
;
2723 /* Reset these values to zero because the produce_special_glyphs
2724 above has changed them. */
2725 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2726 it
->phys_ascent
= it
->phys_descent
= 0;
2729 /* Set this after getting the dimensions of truncation and
2730 continuation glyphs, so that we don't produce glyphs when calling
2731 produce_special_glyphs, above. */
2732 it
->glyph_row
= row
;
2733 it
->area
= TEXT_AREA
;
2735 /* Forget any previous info about this row being reversed. */
2737 it
->glyph_row
->reversed_p
= 0;
2739 /* Get the dimensions of the display area. The display area
2740 consists of the visible window area plus a horizontally scrolled
2741 part to the left of the window. All x-values are relative to the
2742 start of this total display area. */
2743 if (base_face_id
!= DEFAULT_FACE_ID
)
2745 /* Mode lines, menu bar in terminal frames. */
2746 it
->first_visible_x
= 0;
2747 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2752 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2753 it
->last_visible_x
= (it
->first_visible_x
2754 + window_box_width (w
, TEXT_AREA
));
2756 /* If we truncate lines, leave room for the truncator glyph(s) at
2757 the right margin. Otherwise, leave room for the continuation
2758 glyph(s). Truncation and continuation glyphs are not inserted
2759 for window-based redisplay. */
2760 if (!FRAME_WINDOW_P (it
->f
))
2762 if (it
->line_wrap
== TRUNCATE
)
2763 it
->last_visible_x
-= it
->truncation_pixel_width
;
2765 it
->last_visible_x
-= it
->continuation_pixel_width
;
2768 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2769 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2772 /* Leave room for a border glyph. */
2773 if (!FRAME_WINDOW_P (it
->f
)
2774 && !WINDOW_RIGHTMOST_P (it
->w
))
2775 it
->last_visible_x
-= 1;
2777 it
->last_visible_y
= window_text_bottom_y (w
);
2779 /* For mode lines and alike, arrange for the first glyph having a
2780 left box line if the face specifies a box. */
2781 if (base_face_id
!= DEFAULT_FACE_ID
)
2785 it
->face_id
= remapped_base_face_id
;
2787 /* If we have a boxed mode line, make the first character appear
2788 with a left box line. */
2789 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2790 if (face
->box
!= FACE_NO_BOX
)
2791 it
->start_of_box_run_p
= 1;
2794 /* If we are to reorder bidirectional text, init the bidi
2798 /* Note the paragraph direction that this buffer wants to
2800 if (EQ (current_buffer
->bidi_paragraph_direction
, Qleft_to_right
))
2801 it
->paragraph_embedding
= L2R
;
2802 else if (EQ (current_buffer
->bidi_paragraph_direction
, Qright_to_left
))
2803 it
->paragraph_embedding
= R2L
;
2805 it
->paragraph_embedding
= NEUTRAL_DIR
;
2806 bidi_init_it (charpos
, bytepos
, &it
->bidi_it
);
2809 /* If a buffer position was specified, set the iterator there,
2810 getting overlays and face properties from that position. */
2811 if (charpos
>= BUF_BEG (current_buffer
))
2813 it
->end_charpos
= ZV
;
2815 IT_CHARPOS (*it
) = charpos
;
2817 /* Compute byte position if not specified. */
2818 if (bytepos
< charpos
)
2819 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2821 IT_BYTEPOS (*it
) = bytepos
;
2823 it
->start
= it
->current
;
2825 /* Compute faces etc. */
2826 reseat (it
, it
->current
.pos
, 1);
2833 /* Initialize IT for the display of window W with window start POS. */
2836 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2838 struct glyph_row
*row
;
2839 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2841 row
= w
->desired_matrix
->rows
+ first_vpos
;
2842 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2843 it
->first_vpos
= first_vpos
;
2845 /* Don't reseat to previous visible line start if current start
2846 position is in a string or image. */
2847 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2849 int start_at_line_beg_p
;
2850 int first_y
= it
->current_y
;
2852 /* If window start is not at a line start, skip forward to POS to
2853 get the correct continuation lines width. */
2854 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2855 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2856 if (!start_at_line_beg_p
)
2860 reseat_at_previous_visible_line_start (it
);
2861 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2863 new_x
= it
->current_x
+ it
->pixel_width
;
2865 /* If lines are continued, this line may end in the middle
2866 of a multi-glyph character (e.g. a control character
2867 displayed as \003, or in the middle of an overlay
2868 string). In this case move_it_to above will not have
2869 taken us to the start of the continuation line but to the
2870 end of the continued line. */
2871 if (it
->current_x
> 0
2872 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2873 && (/* And glyph doesn't fit on the line. */
2874 new_x
> it
->last_visible_x
2875 /* Or it fits exactly and we're on a window
2877 || (new_x
== it
->last_visible_x
2878 && FRAME_WINDOW_P (it
->f
))))
2880 if (it
->current
.dpvec_index
>= 0
2881 || it
->current
.overlay_string_index
>= 0)
2883 set_iterator_to_next (it
, 1);
2884 move_it_in_display_line_to (it
, -1, -1, 0);
2887 it
->continuation_lines_width
+= it
->current_x
;
2890 /* We're starting a new display line, not affected by the
2891 height of the continued line, so clear the appropriate
2892 fields in the iterator structure. */
2893 it
->max_ascent
= it
->max_descent
= 0;
2894 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2896 it
->current_y
= first_y
;
2898 it
->current_x
= it
->hpos
= 0;
2904 /* Return 1 if POS is a position in ellipses displayed for invisible
2905 text. W is the window we display, for text property lookup. */
2908 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2910 Lisp_Object prop
, window
;
2912 int charpos
= CHARPOS (pos
->pos
);
2914 /* If POS specifies a position in a display vector, this might
2915 be for an ellipsis displayed for invisible text. We won't
2916 get the iterator set up for delivering that ellipsis unless
2917 we make sure that it gets aware of the invisible text. */
2918 if (pos
->dpvec_index
>= 0
2919 && pos
->overlay_string_index
< 0
2920 && CHARPOS (pos
->string_pos
) < 0
2922 && (XSETWINDOW (window
, w
),
2923 prop
= Fget_char_property (make_number (charpos
),
2924 Qinvisible
, window
),
2925 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2927 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2929 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2936 /* Initialize IT for stepping through current_buffer in window W,
2937 starting at position POS that includes overlay string and display
2938 vector/ control character translation position information. Value
2939 is zero if there are overlay strings with newlines at POS. */
2942 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2944 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2945 int i
, overlay_strings_with_newlines
= 0;
2947 /* If POS specifies a position in a display vector, this might
2948 be for an ellipsis displayed for invisible text. We won't
2949 get the iterator set up for delivering that ellipsis unless
2950 we make sure that it gets aware of the invisible text. */
2951 if (in_ellipses_for_invisible_text_p (pos
, w
))
2957 /* Keep in mind: the call to reseat in init_iterator skips invisible
2958 text, so we might end up at a position different from POS. This
2959 is only a problem when POS is a row start after a newline and an
2960 overlay starts there with an after-string, and the overlay has an
2961 invisible property. Since we don't skip invisible text in
2962 display_line and elsewhere immediately after consuming the
2963 newline before the row start, such a POS will not be in a string,
2964 but the call to init_iterator below will move us to the
2966 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2968 /* This only scans the current chunk -- it should scan all chunks.
2969 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2970 to 16 in 22.1 to make this a lesser problem. */
2971 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2973 const char *s
= SDATA (it
->overlay_strings
[i
]);
2974 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2976 while (s
< e
&& *s
!= '\n')
2981 overlay_strings_with_newlines
= 1;
2986 /* If position is within an overlay string, set up IT to the right
2988 if (pos
->overlay_string_index
>= 0)
2992 /* If the first overlay string happens to have a `display'
2993 property for an image, the iterator will be set up for that
2994 image, and we have to undo that setup first before we can
2995 correct the overlay string index. */
2996 if (it
->method
== GET_FROM_IMAGE
)
2999 /* We already have the first chunk of overlay strings in
3000 IT->overlay_strings. Load more until the one for
3001 pos->overlay_string_index is in IT->overlay_strings. */
3002 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3004 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3005 it
->current
.overlay_string_index
= 0;
3008 load_overlay_strings (it
, 0);
3009 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3013 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3014 relative_index
= (it
->current
.overlay_string_index
3015 % OVERLAY_STRING_CHUNK_SIZE
);
3016 it
->string
= it
->overlay_strings
[relative_index
];
3017 xassert (STRINGP (it
->string
));
3018 it
->current
.string_pos
= pos
->string_pos
;
3019 it
->method
= GET_FROM_STRING
;
3022 if (CHARPOS (pos
->string_pos
) >= 0)
3024 /* Recorded position is not in an overlay string, but in another
3025 string. This can only be a string from a `display' property.
3026 IT should already be filled with that string. */
3027 it
->current
.string_pos
= pos
->string_pos
;
3028 xassert (STRINGP (it
->string
));
3031 /* Restore position in display vector translations, control
3032 character translations or ellipses. */
3033 if (pos
->dpvec_index
>= 0)
3035 if (it
->dpvec
== NULL
)
3036 get_next_display_element (it
);
3037 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3038 it
->current
.dpvec_index
= pos
->dpvec_index
;
3042 return !overlay_strings_with_newlines
;
3046 /* Initialize IT for stepping through current_buffer in window W
3047 starting at ROW->start. */
3050 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3052 init_from_display_pos (it
, w
, &row
->start
);
3053 it
->start
= row
->start
;
3054 it
->continuation_lines_width
= row
->continuation_lines_width
;
3059 /* Initialize IT for stepping through current_buffer in window W
3060 starting in the line following ROW, i.e. starting at ROW->end.
3061 Value is zero if there are overlay strings with newlines at ROW's
3065 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3069 if (init_from_display_pos (it
, w
, &row
->end
))
3071 if (row
->continued_p
)
3072 it
->continuation_lines_width
3073 = row
->continuation_lines_width
+ row
->pixel_width
;
3084 /***********************************************************************
3086 ***********************************************************************/
3088 /* Called when IT reaches IT->stop_charpos. Handle text property and
3089 overlay changes. Set IT->stop_charpos to the next position where
3093 handle_stop (struct it
*it
)
3095 enum prop_handled handled
;
3096 int handle_overlay_change_p
;
3100 it
->current
.dpvec_index
= -1;
3101 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3102 it
->ignore_overlay_strings_at_pos_p
= 0;
3105 /* Use face of preceding text for ellipsis (if invisible) */
3106 if (it
->selective_display_ellipsis_p
)
3107 it
->saved_face_id
= it
->face_id
;
3111 handled
= HANDLED_NORMALLY
;
3113 /* Call text property handlers. */
3114 for (p
= it_props
; p
->handler
; ++p
)
3116 handled
= p
->handler (it
);
3118 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3120 else if (handled
== HANDLED_RETURN
)
3122 /* We still want to show before and after strings from
3123 overlays even if the actual buffer text is replaced. */
3124 if (!handle_overlay_change_p
3126 || !get_overlay_strings_1 (it
, 0, 0))
3129 setup_for_ellipsis (it
, 0);
3130 /* When handling a display spec, we might load an
3131 empty string. In that case, discard it here. We
3132 used to discard it in handle_single_display_spec,
3133 but that causes get_overlay_strings_1, above, to
3134 ignore overlay strings that we must check. */
3135 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3139 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3143 it
->ignore_overlay_strings_at_pos_p
= 1;
3144 it
->string_from_display_prop_p
= 0;
3145 handle_overlay_change_p
= 0;
3147 handled
= HANDLED_RECOMPUTE_PROPS
;
3150 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3151 handle_overlay_change_p
= 0;
3154 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3156 /* Don't check for overlay strings below when set to deliver
3157 characters from a display vector. */
3158 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3159 handle_overlay_change_p
= 0;
3161 /* Handle overlay changes.
3162 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3163 if it finds overlays. */
3164 if (handle_overlay_change_p
)
3165 handled
= handle_overlay_change (it
);
3170 setup_for_ellipsis (it
, 0);
3174 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3176 /* Determine where to stop next. */
3177 if (handled
== HANDLED_NORMALLY
)
3178 compute_stop_pos (it
);
3182 /* Compute IT->stop_charpos from text property and overlay change
3183 information for IT's current position. */
3186 compute_stop_pos (struct it
*it
)
3188 register INTERVAL iv
, next_iv
;
3189 Lisp_Object object
, limit
, position
;
3190 EMACS_INT charpos
, bytepos
;
3192 /* If nowhere else, stop at the end. */
3193 it
->stop_charpos
= it
->end_charpos
;
3195 if (STRINGP (it
->string
))
3197 /* Strings are usually short, so don't limit the search for
3199 object
= it
->string
;
3201 charpos
= IT_STRING_CHARPOS (*it
);
3202 bytepos
= IT_STRING_BYTEPOS (*it
);
3208 /* If next overlay change is in front of the current stop pos
3209 (which is IT->end_charpos), stop there. Note: value of
3210 next_overlay_change is point-max if no overlay change
3212 charpos
= IT_CHARPOS (*it
);
3213 bytepos
= IT_BYTEPOS (*it
);
3214 pos
= next_overlay_change (charpos
);
3215 if (pos
< it
->stop_charpos
)
3216 it
->stop_charpos
= pos
;
3218 /* If showing the region, we have to stop at the region
3219 start or end because the face might change there. */
3220 if (it
->region_beg_charpos
> 0)
3222 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3223 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3224 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3225 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3228 /* Set up variables for computing the stop position from text
3229 property changes. */
3230 XSETBUFFER (object
, current_buffer
);
3231 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3234 /* Get the interval containing IT's position. Value is a null
3235 interval if there isn't such an interval. */
3236 position
= make_number (charpos
);
3237 iv
= validate_interval_range (object
, &position
, &position
, 0);
3238 if (!NULL_INTERVAL_P (iv
))
3240 Lisp_Object values_here
[LAST_PROP_IDX
];
3243 /* Get properties here. */
3244 for (p
= it_props
; p
->handler
; ++p
)
3245 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3247 /* Look for an interval following iv that has different
3249 for (next_iv
= next_interval (iv
);
3250 (!NULL_INTERVAL_P (next_iv
)
3252 || XFASTINT (limit
) > next_iv
->position
));
3253 next_iv
= next_interval (next_iv
))
3255 for (p
= it_props
; p
->handler
; ++p
)
3257 Lisp_Object new_value
;
3259 new_value
= textget (next_iv
->plist
, *p
->name
);
3260 if (!EQ (values_here
[p
->idx
], new_value
))
3268 if (!NULL_INTERVAL_P (next_iv
))
3270 if (INTEGERP (limit
)
3271 && next_iv
->position
>= XFASTINT (limit
))
3272 /* No text property change up to limit. */
3273 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3275 /* Text properties change in next_iv. */
3276 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3280 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3281 it
->stop_charpos
, it
->string
);
3283 xassert (STRINGP (it
->string
)
3284 || (it
->stop_charpos
>= BEGV
3285 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3289 /* Return the position of the next overlay change after POS in
3290 current_buffer. Value is point-max if no overlay change
3291 follows. This is like `next-overlay-change' but doesn't use
3295 next_overlay_change (EMACS_INT pos
)
3299 Lisp_Object
*overlays
;
3302 /* Get all overlays at the given position. */
3303 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3305 /* If any of these overlays ends before endpos,
3306 use its ending point instead. */
3307 for (i
= 0; i
< noverlays
; ++i
)
3312 oend
= OVERLAY_END (overlays
[i
]);
3313 oendpos
= OVERLAY_POSITION (oend
);
3314 endpos
= min (endpos
, oendpos
);
3322 /***********************************************************************
3324 ***********************************************************************/
3326 /* Handle changes in the `fontified' property of the current buffer by
3327 calling hook functions from Qfontification_functions to fontify
3330 static enum prop_handled
3331 handle_fontified_prop (struct it
*it
)
3333 Lisp_Object prop
, pos
;
3334 enum prop_handled handled
= HANDLED_NORMALLY
;
3336 if (!NILP (Vmemory_full
))
3339 /* Get the value of the `fontified' property at IT's current buffer
3340 position. (The `fontified' property doesn't have a special
3341 meaning in strings.) If the value is nil, call functions from
3342 Qfontification_functions. */
3343 if (!STRINGP (it
->string
)
3345 && !NILP (Vfontification_functions
)
3346 && !NILP (Vrun_hooks
)
3347 && (pos
= make_number (IT_CHARPOS (*it
)),
3348 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3349 /* Ignore the special cased nil value always present at EOB since
3350 no amount of fontifying will be able to change it. */
3351 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3353 int count
= SPECPDL_INDEX ();
3356 val
= Vfontification_functions
;
3357 specbind (Qfontification_functions
, Qnil
);
3359 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3360 safe_call1 (val
, pos
);
3363 Lisp_Object globals
, fn
;
3364 struct gcpro gcpro1
, gcpro2
;
3367 GCPRO2 (val
, globals
);
3369 for (; CONSP (val
); val
= XCDR (val
))
3375 /* A value of t indicates this hook has a local
3376 binding; it means to run the global binding too.
3377 In a global value, t should not occur. If it
3378 does, we must ignore it to avoid an endless
3380 for (globals
= Fdefault_value (Qfontification_functions
);
3382 globals
= XCDR (globals
))
3384 fn
= XCAR (globals
);
3386 safe_call1 (fn
, pos
);
3390 safe_call1 (fn
, pos
);
3396 unbind_to (count
, Qnil
);
3398 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3399 something. This avoids an endless loop if they failed to
3400 fontify the text for which reason ever. */
3401 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3402 handled
= HANDLED_RECOMPUTE_PROPS
;
3410 /***********************************************************************
3412 ***********************************************************************/
3414 /* Set up iterator IT from face properties at its current position.
3415 Called from handle_stop. */
3417 static enum prop_handled
3418 handle_face_prop (struct it
*it
)
3421 EMACS_INT next_stop
;
3423 if (!STRINGP (it
->string
))
3426 = face_at_buffer_position (it
->w
,
3428 it
->region_beg_charpos
,
3429 it
->region_end_charpos
,
3432 + TEXT_PROP_DISTANCE_LIMIT
),
3433 0, it
->base_face_id
);
3435 /* Is this a start of a run of characters with box face?
3436 Caveat: this can be called for a freshly initialized
3437 iterator; face_id is -1 in this case. We know that the new
3438 face will not change until limit, i.e. if the new face has a
3439 box, all characters up to limit will have one. But, as
3440 usual, we don't know whether limit is really the end. */
3441 if (new_face_id
!= it
->face_id
)
3443 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3445 /* If new face has a box but old face has not, this is
3446 the start of a run of characters with box, i.e. it has
3447 a shadow on the left side. The value of face_id of the
3448 iterator will be -1 if this is the initial call that gets
3449 the face. In this case, we have to look in front of IT's
3450 position and see whether there is a face != new_face_id. */
3451 it
->start_of_box_run_p
3452 = (new_face
->box
!= FACE_NO_BOX
3453 && (it
->face_id
>= 0
3454 || IT_CHARPOS (*it
) == BEG
3455 || new_face_id
!= face_before_it_pos (it
)));
3456 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3461 int base_face_id
, bufpos
;
3463 Lisp_Object from_overlay
3464 = (it
->current
.overlay_string_index
>= 0
3465 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3468 /* See if we got to this string directly or indirectly from
3469 an overlay property. That includes the before-string or
3470 after-string of an overlay, strings in display properties
3471 provided by an overlay, their text properties, etc.
3473 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3474 if (! NILP (from_overlay
))
3475 for (i
= it
->sp
- 1; i
>= 0; i
--)
3477 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3479 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3480 else if (! NILP (it
->stack
[i
].from_overlay
))
3481 from_overlay
= it
->stack
[i
].from_overlay
;
3483 if (!NILP (from_overlay
))
3487 if (! NILP (from_overlay
))
3489 bufpos
= IT_CHARPOS (*it
);
3490 /* For a string from an overlay, the base face depends
3491 only on text properties and ignores overlays. */
3493 = face_for_overlay_string (it
->w
,
3495 it
->region_beg_charpos
,
3496 it
->region_end_charpos
,
3499 + TEXT_PROP_DISTANCE_LIMIT
),
3507 /* For strings from a `display' property, use the face at
3508 IT's current buffer position as the base face to merge
3509 with, so that overlay strings appear in the same face as
3510 surrounding text, unless they specify their own
3512 base_face_id
= underlying_face_id (it
);
3515 new_face_id
= face_at_string_position (it
->w
,
3517 IT_STRING_CHARPOS (*it
),
3519 it
->region_beg_charpos
,
3520 it
->region_end_charpos
,
3524 /* Is this a start of a run of characters with box? Caveat:
3525 this can be called for a freshly allocated iterator; face_id
3526 is -1 is this case. We know that the new face will not
3527 change until the next check pos, i.e. if the new face has a
3528 box, all characters up to that position will have a
3529 box. But, as usual, we don't know whether that position
3530 is really the end. */
3531 if (new_face_id
!= it
->face_id
)
3533 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3534 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3536 /* If new face has a box but old face hasn't, this is the
3537 start of a run of characters with box, i.e. it has a
3538 shadow on the left side. */
3539 it
->start_of_box_run_p
3540 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3541 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3545 it
->face_id
= new_face_id
;
3546 return HANDLED_NORMALLY
;
3550 /* Return the ID of the face ``underlying'' IT's current position,
3551 which is in a string. If the iterator is associated with a
3552 buffer, return the face at IT's current buffer position.
3553 Otherwise, use the iterator's base_face_id. */
3556 underlying_face_id (struct it
*it
)
3558 int face_id
= it
->base_face_id
, i
;
3560 xassert (STRINGP (it
->string
));
3562 for (i
= it
->sp
- 1; i
>= 0; --i
)
3563 if (NILP (it
->stack
[i
].string
))
3564 face_id
= it
->stack
[i
].face_id
;
3570 /* Compute the face one character before or after the current position
3571 of IT. BEFORE_P non-zero means get the face in front of IT's
3572 position. Value is the id of the face. */
3575 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3578 EMACS_INT next_check_charpos
;
3579 struct text_pos pos
;
3581 xassert (it
->s
== NULL
);
3583 if (STRINGP (it
->string
))
3585 int bufpos
, base_face_id
;
3587 /* No face change past the end of the string (for the case
3588 we are padding with spaces). No face change before the
3590 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3591 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3594 /* Set pos to the position before or after IT's current position. */
3596 pos
= string_pos (IT_STRING_CHARPOS (*it
) - 1, it
->string
);
3598 /* For composition, we must check the character after the
3600 pos
= (it
->what
== IT_COMPOSITION
3601 ? string_pos (IT_STRING_CHARPOS (*it
)
3602 + it
->cmp_it
.nchars
, it
->string
)
3603 : string_pos (IT_STRING_CHARPOS (*it
) + 1, it
->string
));
3605 if (it
->current
.overlay_string_index
>= 0)
3606 bufpos
= IT_CHARPOS (*it
);
3610 base_face_id
= underlying_face_id (it
);
3612 /* Get the face for ASCII, or unibyte. */
3613 face_id
= face_at_string_position (it
->w
,
3617 it
->region_beg_charpos
,
3618 it
->region_end_charpos
,
3619 &next_check_charpos
,
3622 /* Correct the face for charsets different from ASCII. Do it
3623 for the multibyte case only. The face returned above is
3624 suitable for unibyte text if IT->string is unibyte. */
3625 if (STRING_MULTIBYTE (it
->string
))
3627 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos
);
3628 int rest
= SBYTES (it
->string
) - BYTEPOS (pos
);
3630 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3632 c
= string_char_and_length (p
, &len
);
3633 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), it
->string
);
3638 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3639 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3642 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3643 pos
= it
->current
.pos
;
3646 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3649 if (it
->what
== IT_COMPOSITION
)
3650 /* For composition, we must check the position after the
3652 pos
.charpos
+= it
->cmp_it
.nchars
, pos
.bytepos
+= it
->len
;
3654 INC_TEXT_POS (pos
, it
->multibyte_p
);
3657 /* Determine face for CHARSET_ASCII, or unibyte. */
3658 face_id
= face_at_buffer_position (it
->w
,
3660 it
->region_beg_charpos
,
3661 it
->region_end_charpos
,
3662 &next_check_charpos
,
3665 /* Correct the face for charsets different from ASCII. Do it
3666 for the multibyte case only. The face returned above is
3667 suitable for unibyte text if current_buffer is unibyte. */
3668 if (it
->multibyte_p
)
3670 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3671 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3672 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3681 /***********************************************************************
3683 ***********************************************************************/
3685 /* Set up iterator IT from invisible properties at its current
3686 position. Called from handle_stop. */
3688 static enum prop_handled
3689 handle_invisible_prop (struct it
*it
)
3691 enum prop_handled handled
= HANDLED_NORMALLY
;
3693 if (STRINGP (it
->string
))
3695 extern Lisp_Object Qinvisible
;
3696 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3698 /* Get the value of the invisible text property at the
3699 current position. Value will be nil if there is no such
3701 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3702 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3705 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3707 handled
= HANDLED_RECOMPUTE_PROPS
;
3709 /* Get the position at which the next change of the
3710 invisible text property can be found in IT->string.
3711 Value will be nil if the property value is the same for
3712 all the rest of IT->string. */
3713 XSETINT (limit
, SCHARS (it
->string
));
3714 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3717 /* Text at current position is invisible. The next
3718 change in the property is at position end_charpos.
3719 Move IT's current position to that position. */
3720 if (INTEGERP (end_charpos
)
3721 && XFASTINT (end_charpos
) < XFASTINT (limit
))
3723 struct text_pos old
;
3724 old
= it
->current
.string_pos
;
3725 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3726 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3730 /* The rest of the string is invisible. If this is an
3731 overlay string, proceed with the next overlay string
3732 or whatever comes and return a character from there. */
3733 if (it
->current
.overlay_string_index
>= 0)
3735 next_overlay_string (it
);
3736 /* Don't check for overlay strings when we just
3737 finished processing them. */
3738 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3742 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3743 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3751 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3752 Lisp_Object pos
, prop
, overlay
;
3754 /* First of all, is there invisible text at this position? */
3755 tem
= start_charpos
= IT_CHARPOS (*it
);
3756 pos
= make_number (tem
);
3757 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3759 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3761 /* If we are on invisible text, skip over it. */
3762 if (invis_p
&& start_charpos
< it
->end_charpos
)
3764 /* Record whether we have to display an ellipsis for the
3766 int display_ellipsis_p
= invis_p
== 2;
3768 handled
= HANDLED_RECOMPUTE_PROPS
;
3770 /* Loop skipping over invisible text. The loop is left at
3771 ZV or with IT on the first char being visible again. */
3774 /* Try to skip some invisible text. Return value is the
3775 position reached which can be equal to where we start
3776 if there is nothing invisible there. This skips both
3777 over invisible text properties and overlays with
3778 invisible property. */
3779 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3781 /* If we skipped nothing at all we weren't at invisible
3782 text in the first place. If everything to the end of
3783 the buffer was skipped, end the loop. */
3784 if (newpos
== tem
|| newpos
>= ZV
)
3788 /* We skipped some characters but not necessarily
3789 all there are. Check if we ended up on visible
3790 text. Fget_char_property returns the property of
3791 the char before the given position, i.e. if we
3792 get invis_p = 0, this means that the char at
3793 newpos is visible. */
3794 pos
= make_number (newpos
);
3795 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3796 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3799 /* If we ended up on invisible text, proceed to
3800 skip starting with next_stop. */
3804 /* If there are adjacent invisible texts, don't lose the
3805 second one's ellipsis. */
3807 display_ellipsis_p
= 1;
3811 /* The position newpos is now either ZV or on visible text. */
3812 if (it
->bidi_p
&& newpos
< ZV
)
3814 /* With bidi iteration, the region of invisible text
3815 could start and/or end in the middle of a non-base
3816 embedding level. Therefore, we need to skip
3817 invisible text using the bidi iterator, starting at
3818 IT's current position, until we find ourselves
3819 outside the invisible text. Skipping invisible text
3820 _after_ bidi iteration avoids affecting the visual
3821 order of the displayed text when invisible properties
3822 are added or removed. */
3823 if (it
->bidi_it
.first_elt
)
3825 /* If we were `reseat'ed to a new paragraph,
3826 determine the paragraph base direction. We need
3827 to do it now because next_element_from_buffer may
3828 not have a chance to do it, if we are going to
3829 skip any text at the beginning, which resets the
3831 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
3835 bidi_move_to_visually_next (&it
->bidi_it
);
3837 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3838 && it
->bidi_it
.charpos
< newpos
);
3839 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3840 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3841 /* If we overstepped NEWPOS, record its position in the
3842 iterator, so that we skip invisible text if later the
3843 bidi iteration lands us in the invisible region
3845 if (IT_CHARPOS (*it
) >= newpos
)
3846 it
->prev_stop
= newpos
;
3850 IT_CHARPOS (*it
) = newpos
;
3851 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3854 /* If there are before-strings at the start of invisible
3855 text, and the text is invisible because of a text
3856 property, arrange to show before-strings because 20.x did
3857 it that way. (If the text is invisible because of an
3858 overlay property instead of a text property, this is
3859 already handled in the overlay code.) */
3861 && get_overlay_strings (it
, it
->stop_charpos
))
3863 handled
= HANDLED_RECOMPUTE_PROPS
;
3864 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3866 else if (display_ellipsis_p
)
3868 /* Make sure that the glyphs of the ellipsis will get
3869 correct `charpos' values. If we would not update
3870 it->position here, the glyphs would belong to the
3871 last visible character _before_ the invisible
3872 text, which confuses `set_cursor_from_row'.
3874 We use the last invisible position instead of the
3875 first because this way the cursor is always drawn on
3876 the first "." of the ellipsis, whenever PT is inside
3877 the invisible text. Otherwise the cursor would be
3878 placed _after_ the ellipsis when the point is after the
3879 first invisible character. */
3880 if (!STRINGP (it
->object
))
3882 it
->position
.charpos
= newpos
- 1;
3883 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3886 /* Let the ellipsis display before
3887 considering any properties of the following char.
3888 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3889 handled
= HANDLED_RETURN
;
3898 /* Make iterator IT return `...' next.
3899 Replaces LEN characters from buffer. */
3902 setup_for_ellipsis (struct it
*it
, int len
)
3904 /* Use the display table definition for `...'. Invalid glyphs
3905 will be handled by the method returning elements from dpvec. */
3906 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3908 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3909 it
->dpvec
= v
->contents
;
3910 it
->dpend
= v
->contents
+ v
->size
;
3914 /* Default `...'. */
3915 it
->dpvec
= default_invis_vector
;
3916 it
->dpend
= default_invis_vector
+ 3;
3919 it
->dpvec_char_len
= len
;
3920 it
->current
.dpvec_index
= 0;
3921 it
->dpvec_face_id
= -1;
3923 /* Remember the current face id in case glyphs specify faces.
3924 IT's face is restored in set_iterator_to_next.
3925 saved_face_id was set to preceding char's face in handle_stop. */
3926 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
3927 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
3929 it
->method
= GET_FROM_DISPLAY_VECTOR
;
3935 /***********************************************************************
3937 ***********************************************************************/
3939 /* Set up iterator IT from `display' property at its current position.
3940 Called from handle_stop.
3941 We return HANDLED_RETURN if some part of the display property
3942 overrides the display of the buffer text itself.
3943 Otherwise we return HANDLED_NORMALLY. */
3945 static enum prop_handled
3946 handle_display_prop (struct it
*it
)
3948 Lisp_Object prop
, object
, overlay
;
3949 struct text_pos
*position
;
3950 /* Nonzero if some property replaces the display of the text itself. */
3951 int display_replaced_p
= 0;
3953 if (STRINGP (it
->string
))
3955 object
= it
->string
;
3956 position
= &it
->current
.string_pos
;
3960 XSETWINDOW (object
, it
->w
);
3961 position
= &it
->current
.pos
;
3964 /* Reset those iterator values set from display property values. */
3965 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
3966 it
->space_width
= Qnil
;
3967 it
->font_height
= Qnil
;
3970 /* We don't support recursive `display' properties, i.e. string
3971 values that have a string `display' property, that have a string
3972 `display' property etc. */
3973 if (!it
->string_from_display_prop_p
)
3974 it
->area
= TEXT_AREA
;
3976 prop
= get_char_property_and_overlay (make_number (position
->charpos
),
3977 Qdisplay
, object
, &overlay
);
3979 return HANDLED_NORMALLY
;
3980 /* Now OVERLAY is the overlay that gave us this property, or nil
3981 if it was a text property. */
3983 if (!STRINGP (it
->string
))
3984 object
= it
->w
->buffer
;
3987 /* Simple properties. */
3988 && !EQ (XCAR (prop
), Qimage
)
3989 && !EQ (XCAR (prop
), Qspace
)
3990 && !EQ (XCAR (prop
), Qwhen
)
3991 && !EQ (XCAR (prop
), Qslice
)
3992 && !EQ (XCAR (prop
), Qspace_width
)
3993 && !EQ (XCAR (prop
), Qheight
)
3994 && !EQ (XCAR (prop
), Qraise
)
3995 /* Marginal area specifications. */
3996 && !(CONSP (XCAR (prop
)) && EQ (XCAR (XCAR (prop
)), Qmargin
))
3997 && !EQ (XCAR (prop
), Qleft_fringe
)
3998 && !EQ (XCAR (prop
), Qright_fringe
)
3999 && !NILP (XCAR (prop
)))
4001 for (; CONSP (prop
); prop
= XCDR (prop
))
4003 if (handle_single_display_spec (it
, XCAR (prop
), object
, overlay
,
4004 position
, display_replaced_p
))
4006 display_replaced_p
= 1;
4007 /* If some text in a string is replaced, `position' no
4008 longer points to the position of `object'. */
4009 if (STRINGP (object
))
4014 else if (VECTORP (prop
))
4017 for (i
= 0; i
< ASIZE (prop
); ++i
)
4018 if (handle_single_display_spec (it
, AREF (prop
, i
), object
, overlay
,
4019 position
, display_replaced_p
))
4021 display_replaced_p
= 1;
4022 /* If some text in a string is replaced, `position' no
4023 longer points to the position of `object'. */
4024 if (STRINGP (object
))
4030 if (handle_single_display_spec (it
, prop
, object
, overlay
,
4032 display_replaced_p
= 1;
4035 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4039 /* Value is the position of the end of the `display' property starting
4040 at START_POS in OBJECT. */
4042 static struct text_pos
4043 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4046 struct text_pos end_pos
;
4048 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4049 Qdisplay
, object
, Qnil
);
4050 CHARPOS (end_pos
) = XFASTINT (end
);
4051 if (STRINGP (object
))
4052 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4054 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4060 /* Set up IT from a single `display' specification PROP. OBJECT
4061 is the object in which the `display' property was found. *POSITION
4062 is the position at which it was found. DISPLAY_REPLACED_P non-zero
4063 means that we previously saw a display specification which already
4064 replaced text display with something else, for example an image;
4065 we ignore such properties after the first one has been processed.
4067 OVERLAY is the overlay this `display' property came from,
4068 or nil if it was a text property.
4070 If PROP is a `space' or `image' specification, and in some other
4071 cases too, set *POSITION to the position where the `display'
4074 Value is non-zero if something was found which replaces the display
4075 of buffer or string text. */
4078 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4079 Lisp_Object overlay
, struct text_pos
*position
,
4080 int display_replaced_before_p
)
4083 Lisp_Object location
, value
;
4084 struct text_pos start_pos
, save_pos
;
4087 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4088 If the result is non-nil, use VALUE instead of SPEC. */
4090 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4099 if (!NILP (form
) && !EQ (form
, Qt
))
4101 int count
= SPECPDL_INDEX ();
4102 struct gcpro gcpro1
;
4104 /* Bind `object' to the object having the `display' property, a
4105 buffer or string. Bind `position' to the position in the
4106 object where the property was found, and `buffer-position'
4107 to the current position in the buffer. */
4108 specbind (Qobject
, object
);
4109 specbind (Qposition
, make_number (CHARPOS (*position
)));
4110 specbind (Qbuffer_position
,
4111 make_number (STRINGP (object
)
4112 ? IT_CHARPOS (*it
) : CHARPOS (*position
)));
4114 form
= safe_eval (form
);
4116 unbind_to (count
, Qnil
);
4122 /* Handle `(height HEIGHT)' specifications. */
4124 && EQ (XCAR (spec
), Qheight
)
4125 && CONSP (XCDR (spec
)))
4127 if (!FRAME_WINDOW_P (it
->f
))
4130 it
->font_height
= XCAR (XCDR (spec
));
4131 if (!NILP (it
->font_height
))
4133 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4134 int new_height
= -1;
4136 if (CONSP (it
->font_height
)
4137 && (EQ (XCAR (it
->font_height
), Qplus
)
4138 || EQ (XCAR (it
->font_height
), Qminus
))
4139 && CONSP (XCDR (it
->font_height
))
4140 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4142 /* `(+ N)' or `(- N)' where N is an integer. */
4143 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4144 if (EQ (XCAR (it
->font_height
), Qplus
))
4146 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4148 else if (FUNCTIONP (it
->font_height
))
4150 /* Call function with current height as argument.
4151 Value is the new height. */
4153 height
= safe_call1 (it
->font_height
,
4154 face
->lface
[LFACE_HEIGHT_INDEX
]);
4155 if (NUMBERP (height
))
4156 new_height
= XFLOATINT (height
);
4158 else if (NUMBERP (it
->font_height
))
4160 /* Value is a multiple of the canonical char height. */
4163 face
= FACE_FROM_ID (it
->f
,
4164 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4165 new_height
= (XFLOATINT (it
->font_height
)
4166 * XINT (face
->lface
[LFACE_HEIGHT_INDEX
]));
4170 /* Evaluate IT->font_height with `height' bound to the
4171 current specified height to get the new height. */
4172 int count
= SPECPDL_INDEX ();
4174 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4175 value
= safe_eval (it
->font_height
);
4176 unbind_to (count
, Qnil
);
4178 if (NUMBERP (value
))
4179 new_height
= XFLOATINT (value
);
4183 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4189 /* Handle `(space-width WIDTH)'. */
4191 && EQ (XCAR (spec
), Qspace_width
)
4192 && CONSP (XCDR (spec
)))
4194 if (!FRAME_WINDOW_P (it
->f
))
4197 value
= XCAR (XCDR (spec
));
4198 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4199 it
->space_width
= value
;
4204 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4206 && EQ (XCAR (spec
), Qslice
))
4210 if (!FRAME_WINDOW_P (it
->f
))
4213 if (tem
= XCDR (spec
), CONSP (tem
))
4215 it
->slice
.x
= XCAR (tem
);
4216 if (tem
= XCDR (tem
), CONSP (tem
))
4218 it
->slice
.y
= XCAR (tem
);
4219 if (tem
= XCDR (tem
), CONSP (tem
))
4221 it
->slice
.width
= XCAR (tem
);
4222 if (tem
= XCDR (tem
), CONSP (tem
))
4223 it
->slice
.height
= XCAR (tem
);
4231 /* Handle `(raise FACTOR)'. */
4233 && EQ (XCAR (spec
), Qraise
)
4234 && CONSP (XCDR (spec
)))
4236 if (!FRAME_WINDOW_P (it
->f
))
4239 #ifdef HAVE_WINDOW_SYSTEM
4240 value
= XCAR (XCDR (spec
));
4241 if (NUMBERP (value
))
4243 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4244 it
->voffset
= - (XFLOATINT (value
)
4245 * (FONT_HEIGHT (face
->font
)));
4247 #endif /* HAVE_WINDOW_SYSTEM */
4252 /* Don't handle the other kinds of display specifications
4253 inside a string that we got from a `display' property. */
4254 if (it
->string_from_display_prop_p
)
4257 /* Characters having this form of property are not displayed, so
4258 we have to find the end of the property. */
4259 start_pos
= *position
;
4260 *position
= display_prop_end (it
, object
, start_pos
);
4263 /* Stop the scan at that end position--we assume that all
4264 text properties change there. */
4265 it
->stop_charpos
= position
->charpos
;
4267 /* Handle `(left-fringe BITMAP [FACE])'
4268 and `(right-fringe BITMAP [FACE])'. */
4270 && (EQ (XCAR (spec
), Qleft_fringe
)
4271 || EQ (XCAR (spec
), Qright_fringe
))
4272 && CONSP (XCDR (spec
)))
4274 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
4277 if (!FRAME_WINDOW_P (it
->f
))
4278 /* If we return here, POSITION has been advanced
4279 across the text with this property. */
4282 #ifdef HAVE_WINDOW_SYSTEM
4283 value
= XCAR (XCDR (spec
));
4284 if (!SYMBOLP (value
)
4285 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4286 /* If we return here, POSITION has been advanced
4287 across the text with this property. */
4290 if (CONSP (XCDR (XCDR (spec
))))
4292 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4293 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4299 /* Save current settings of IT so that we can restore them
4300 when we are finished with the glyph property value. */
4302 save_pos
= it
->position
;
4303 it
->position
= *position
;
4305 it
->position
= save_pos
;
4307 it
->area
= TEXT_AREA
;
4308 it
->what
= IT_IMAGE
;
4309 it
->image_id
= -1; /* no image */
4310 it
->position
= start_pos
;
4311 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4312 it
->method
= GET_FROM_IMAGE
;
4313 it
->from_overlay
= Qnil
;
4314 it
->face_id
= face_id
;
4316 /* Say that we haven't consumed the characters with
4317 `display' property yet. The call to pop_it in
4318 set_iterator_to_next will clean this up. */
4319 *position
= start_pos
;
4321 if (EQ (XCAR (spec
), Qleft_fringe
))
4323 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4324 it
->left_user_fringe_face_id
= face_id
;
4328 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4329 it
->right_user_fringe_face_id
= face_id
;
4331 #endif /* HAVE_WINDOW_SYSTEM */
4335 /* Prepare to handle `((margin left-margin) ...)',
4336 `((margin right-margin) ...)' and `((margin nil) ...)'
4337 prefixes for display specifications. */
4338 location
= Qunbound
;
4339 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4343 value
= XCDR (spec
);
4345 value
= XCAR (value
);
4348 if (EQ (XCAR (tem
), Qmargin
)
4349 && (tem
= XCDR (tem
),
4350 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4352 || EQ (tem
, Qleft_margin
)
4353 || EQ (tem
, Qright_margin
))))
4357 if (EQ (location
, Qunbound
))
4363 /* After this point, VALUE is the property after any
4364 margin prefix has been stripped. It must be a string,
4365 an image specification, or `(space ...)'.
4367 LOCATION specifies where to display: `left-margin',
4368 `right-margin' or nil. */
4370 valid_p
= (STRINGP (value
)
4371 #ifdef HAVE_WINDOW_SYSTEM
4372 || (FRAME_WINDOW_P (it
->f
) && valid_image_p (value
))
4373 #endif /* not HAVE_WINDOW_SYSTEM */
4374 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4376 if (valid_p
&& !display_replaced_before_p
)
4378 /* Save current settings of IT so that we can restore them
4379 when we are finished with the glyph property value. */
4380 save_pos
= it
->position
;
4381 it
->position
= *position
;
4383 it
->position
= save_pos
;
4384 it
->from_overlay
= overlay
;
4386 if (NILP (location
))
4387 it
->area
= TEXT_AREA
;
4388 else if (EQ (location
, Qleft_margin
))
4389 it
->area
= LEFT_MARGIN_AREA
;
4391 it
->area
= RIGHT_MARGIN_AREA
;
4393 if (STRINGP (value
))
4396 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4397 it
->current
.overlay_string_index
= -1;
4398 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4399 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4400 it
->method
= GET_FROM_STRING
;
4401 it
->stop_charpos
= 0;
4402 it
->string_from_display_prop_p
= 1;
4403 /* Say that we haven't consumed the characters with
4404 `display' property yet. The call to pop_it in
4405 set_iterator_to_next will clean this up. */
4406 if (BUFFERP (object
))
4407 *position
= start_pos
;
4409 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4411 it
->method
= GET_FROM_STRETCH
;
4413 *position
= it
->position
= start_pos
;
4415 #ifdef HAVE_WINDOW_SYSTEM
4418 it
->what
= IT_IMAGE
;
4419 it
->image_id
= lookup_image (it
->f
, value
);
4420 it
->position
= start_pos
;
4421 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4422 it
->method
= GET_FROM_IMAGE
;
4424 /* Say that we haven't consumed the characters with
4425 `display' property yet. The call to pop_it in
4426 set_iterator_to_next will clean this up. */
4427 *position
= start_pos
;
4429 #endif /* HAVE_WINDOW_SYSTEM */
4434 /* Invalid property or property not supported. Restore
4435 POSITION to what it was before. */
4436 *position
= start_pos
;
4441 /* Check if SPEC is a display sub-property value whose text should be
4442 treated as intangible. */
4445 single_display_spec_intangible_p (Lisp_Object prop
)
4447 /* Skip over `when FORM'. */
4448 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4462 /* Skip over `margin LOCATION'. If LOCATION is in the margins,
4463 we don't need to treat text as intangible. */
4464 if (EQ (XCAR (prop
), Qmargin
))
4472 || EQ (XCAR (prop
), Qleft_margin
)
4473 || EQ (XCAR (prop
), Qright_margin
))
4477 return (CONSP (prop
)
4478 && (EQ (XCAR (prop
), Qimage
)
4479 || EQ (XCAR (prop
), Qspace
)));
4483 /* Check if PROP is a display property value whose text should be
4484 treated as intangible. */
4487 display_prop_intangible_p (Lisp_Object prop
)
4490 && CONSP (XCAR (prop
))
4491 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4493 /* A list of sub-properties. */
4494 while (CONSP (prop
))
4496 if (single_display_spec_intangible_p (XCAR (prop
)))
4501 else if (VECTORP (prop
))
4503 /* A vector of sub-properties. */
4505 for (i
= 0; i
< ASIZE (prop
); ++i
)
4506 if (single_display_spec_intangible_p (AREF (prop
, i
)))
4510 return single_display_spec_intangible_p (prop
);
4516 /* Return 1 if PROP is a display sub-property value containing STRING. */
4519 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4521 if (EQ (string
, prop
))
4524 /* Skip over `when FORM'. */
4525 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4534 /* Skip over `margin LOCATION'. */
4535 if (EQ (XCAR (prop
), Qmargin
))
4546 return CONSP (prop
) && EQ (XCAR (prop
), string
);
4550 /* Return 1 if STRING appears in the `display' property PROP. */
4553 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4556 && CONSP (XCAR (prop
))
4557 && !EQ (Qmargin
, XCAR (XCAR (prop
))))
4559 /* A list of sub-properties. */
4560 while (CONSP (prop
))
4562 if (single_display_spec_string_p (XCAR (prop
), string
))
4567 else if (VECTORP (prop
))
4569 /* A vector of sub-properties. */
4571 for (i
= 0; i
< ASIZE (prop
); ++i
)
4572 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4576 return single_display_spec_string_p (prop
, string
);
4581 /* Look for STRING in overlays and text properties in W's buffer,
4582 between character positions FROM and TO (excluding TO).
4583 BACK_P non-zero means look back (in this case, TO is supposed to be
4585 Value is the first character position where STRING was found, or
4586 zero if it wasn't found before hitting TO.
4588 W's buffer must be current.
4590 This function may only use code that doesn't eval because it is
4591 called asynchronously from note_mouse_highlight. */
4594 string_buffer_position_lim (struct window
*w
, Lisp_Object string
,
4595 EMACS_INT from
, EMACS_INT to
, int back_p
)
4597 Lisp_Object limit
, prop
, pos
;
4600 pos
= make_number (from
);
4602 if (!back_p
) /* looking forward */
4604 limit
= make_number (min (to
, ZV
));
4605 while (!found
&& !EQ (pos
, limit
))
4607 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4608 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4611 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4615 else /* looking back */
4617 limit
= make_number (max (to
, BEGV
));
4618 while (!found
&& !EQ (pos
, limit
))
4620 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4621 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4624 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4629 return found
? XINT (pos
) : 0;
4632 /* Determine which buffer position in W's buffer STRING comes from.
4633 AROUND_CHARPOS is an approximate position where it could come from.
4634 Value is the buffer position or 0 if it couldn't be determined.
4636 W's buffer must be current.
4638 This function is necessary because we don't record buffer positions
4639 in glyphs generated from strings (to keep struct glyph small).
4640 This function may only use code that doesn't eval because it is
4641 called asynchronously from note_mouse_highlight. */
4644 string_buffer_position (struct window
*w
, Lisp_Object string
, EMACS_INT around_charpos
)
4646 Lisp_Object limit
, prop
, pos
;
4647 const int MAX_DISTANCE
= 1000;
4648 EMACS_INT found
= string_buffer_position_lim (w
, string
, around_charpos
,
4649 around_charpos
+ MAX_DISTANCE
,
4653 found
= string_buffer_position_lim (w
, string
, around_charpos
,
4654 around_charpos
- MAX_DISTANCE
, 1);
4660 /***********************************************************************
4661 `composition' property
4662 ***********************************************************************/
4664 /* Set up iterator IT from `composition' property at its current
4665 position. Called from handle_stop. */
4667 static enum prop_handled
4668 handle_composition_prop (struct it
*it
)
4670 Lisp_Object prop
, string
;
4671 EMACS_INT pos
, pos_byte
, start
, end
;
4673 if (STRINGP (it
->string
))
4677 pos
= IT_STRING_CHARPOS (*it
);
4678 pos_byte
= IT_STRING_BYTEPOS (*it
);
4679 string
= it
->string
;
4680 s
= SDATA (string
) + pos_byte
;
4681 it
->c
= STRING_CHAR (s
);
4685 pos
= IT_CHARPOS (*it
);
4686 pos_byte
= IT_BYTEPOS (*it
);
4688 it
->c
= FETCH_CHAR (pos_byte
);
4691 /* If there's a valid composition and point is not inside of the
4692 composition (in the case that the composition is from the current
4693 buffer), draw a glyph composed from the composition components. */
4694 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4695 && COMPOSITION_VALID_P (start
, end
, prop
)
4696 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4700 if (STRINGP (it
->string
))
4701 pos_byte
= string_char_to_byte (it
->string
, start
);
4703 pos_byte
= CHAR_TO_BYTE (start
);
4705 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4708 if (it
->cmp_it
.id
>= 0)
4711 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4712 it
->cmp_it
.nglyphs
= -1;
4716 return HANDLED_NORMALLY
;
4721 /***********************************************************************
4723 ***********************************************************************/
4725 /* The following structure is used to record overlay strings for
4726 later sorting in load_overlay_strings. */
4728 struct overlay_entry
4730 Lisp_Object overlay
;
4737 /* Set up iterator IT from overlay strings at its current position.
4738 Called from handle_stop. */
4740 static enum prop_handled
4741 handle_overlay_change (struct it
*it
)
4743 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4744 return HANDLED_RECOMPUTE_PROPS
;
4746 return HANDLED_NORMALLY
;
4750 /* Set up the next overlay string for delivery by IT, if there is an
4751 overlay string to deliver. Called by set_iterator_to_next when the
4752 end of the current overlay string is reached. If there are more
4753 overlay strings to display, IT->string and
4754 IT->current.overlay_string_index are set appropriately here.
4755 Otherwise IT->string is set to nil. */
4758 next_overlay_string (struct it
*it
)
4760 ++it
->current
.overlay_string_index
;
4761 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4763 /* No more overlay strings. Restore IT's settings to what
4764 they were before overlay strings were processed, and
4765 continue to deliver from current_buffer. */
4767 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4770 || (NILP (it
->string
)
4771 && it
->method
== GET_FROM_BUFFER
4772 && it
->stop_charpos
>= BEGV
4773 && it
->stop_charpos
<= it
->end_charpos
));
4774 it
->current
.overlay_string_index
= -1;
4775 it
->n_overlay_strings
= 0;
4777 /* If we're at the end of the buffer, record that we have
4778 processed the overlay strings there already, so that
4779 next_element_from_buffer doesn't try it again. */
4780 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4781 it
->overlay_strings_at_end_processed_p
= 1;
4785 /* There are more overlay strings to process. If
4786 IT->current.overlay_string_index has advanced to a position
4787 where we must load IT->overlay_strings with more strings, do
4789 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4791 if (it
->current
.overlay_string_index
&& i
== 0)
4792 load_overlay_strings (it
, 0);
4794 /* Initialize IT to deliver display elements from the overlay
4796 it
->string
= it
->overlay_strings
[i
];
4797 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4798 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4799 it
->method
= GET_FROM_STRING
;
4800 it
->stop_charpos
= 0;
4801 if (it
->cmp_it
.stop_pos
>= 0)
4802 it
->cmp_it
.stop_pos
= 0;
4809 /* Compare two overlay_entry structures E1 and E2. Used as a
4810 comparison function for qsort in load_overlay_strings. Overlay
4811 strings for the same position are sorted so that
4813 1. All after-strings come in front of before-strings, except
4814 when they come from the same overlay.
4816 2. Within after-strings, strings are sorted so that overlay strings
4817 from overlays with higher priorities come first.
4819 2. Within before-strings, strings are sorted so that overlay
4820 strings from overlays with higher priorities come last.
4822 Value is analogous to strcmp. */
4826 compare_overlay_entries (const void *e1
, const void *e2
)
4828 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4829 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4832 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4834 /* Let after-strings appear in front of before-strings if
4835 they come from different overlays. */
4836 if (EQ (entry1
->overlay
, entry2
->overlay
))
4837 result
= entry1
->after_string_p
? 1 : -1;
4839 result
= entry1
->after_string_p
? -1 : 1;
4841 else if (entry1
->after_string_p
)
4842 /* After-strings sorted in order of decreasing priority. */
4843 result
= entry2
->priority
- entry1
->priority
;
4845 /* Before-strings sorted in order of increasing priority. */
4846 result
= entry1
->priority
- entry2
->priority
;
4852 /* Load the vector IT->overlay_strings with overlay strings from IT's
4853 current buffer position, or from CHARPOS if that is > 0. Set
4854 IT->n_overlays to the total number of overlay strings found.
4856 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4857 a time. On entry into load_overlay_strings,
4858 IT->current.overlay_string_index gives the number of overlay
4859 strings that have already been loaded by previous calls to this
4862 IT->add_overlay_start contains an additional overlay start
4863 position to consider for taking overlay strings from, if non-zero.
4864 This position comes into play when the overlay has an `invisible'
4865 property, and both before and after-strings. When we've skipped to
4866 the end of the overlay, because of its `invisible' property, we
4867 nevertheless want its before-string to appear.
4868 IT->add_overlay_start will contain the overlay start position
4871 Overlay strings are sorted so that after-string strings come in
4872 front of before-string strings. Within before and after-strings,
4873 strings are sorted by overlay priority. See also function
4874 compare_overlay_entries. */
4877 load_overlay_strings (struct it
*it
, int charpos
)
4879 extern Lisp_Object Qwindow
, Qpriority
;
4880 Lisp_Object overlay
, window
, str
, invisible
;
4881 struct Lisp_Overlay
*ov
;
4884 int n
= 0, i
, j
, invis_p
;
4885 struct overlay_entry
*entries
4886 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
4889 charpos
= IT_CHARPOS (*it
);
4891 /* Append the overlay string STRING of overlay OVERLAY to vector
4892 `entries' which has size `size' and currently contains `n'
4893 elements. AFTER_P non-zero means STRING is an after-string of
4895 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
4898 Lisp_Object priority; \
4902 int new_size = 2 * size; \
4903 struct overlay_entry *old = entries; \
4905 (struct overlay_entry *) alloca (new_size \
4906 * sizeof *entries); \
4907 memcpy (entries, old, size * sizeof *entries); \
4911 entries[n].string = (STRING); \
4912 entries[n].overlay = (OVERLAY); \
4913 priority = Foverlay_get ((OVERLAY), Qpriority); \
4914 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
4915 entries[n].after_string_p = (AFTER_P); \
4920 /* Process overlay before the overlay center. */
4921 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
4923 XSETMISC (overlay
, ov
);
4924 xassert (OVERLAYP (overlay
));
4925 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4926 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4931 /* Skip this overlay if it doesn't start or end at IT's current
4933 if (end
!= charpos
&& start
!= charpos
)
4936 /* Skip this overlay if it doesn't apply to IT->w. */
4937 window
= Foverlay_get (overlay
, Qwindow
);
4938 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4941 /* If the text ``under'' the overlay is invisible, both before-
4942 and after-strings from this overlay are visible; start and
4943 end position are indistinguishable. */
4944 invisible
= Foverlay_get (overlay
, Qinvisible
);
4945 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4947 /* If overlay has a non-empty before-string, record it. */
4948 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4949 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4951 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4953 /* If overlay has a non-empty after-string, record it. */
4954 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4955 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4957 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4960 /* Process overlays after the overlay center. */
4961 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
4963 XSETMISC (overlay
, ov
);
4964 xassert (OVERLAYP (overlay
));
4965 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
4966 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
4968 if (start
> charpos
)
4971 /* Skip this overlay if it doesn't start or end at IT's current
4973 if (end
!= charpos
&& start
!= charpos
)
4976 /* Skip this overlay if it doesn't apply to IT->w. */
4977 window
= Foverlay_get (overlay
, Qwindow
);
4978 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
4981 /* If the text ``under'' the overlay is invisible, it has a zero
4982 dimension, and both before- and after-strings apply. */
4983 invisible
= Foverlay_get (overlay
, Qinvisible
);
4984 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
4986 /* If overlay has a non-empty before-string, record it. */
4987 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
4988 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
4990 RECORD_OVERLAY_STRING (overlay
, str
, 0);
4992 /* If overlay has a non-empty after-string, record it. */
4993 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
4994 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
4996 RECORD_OVERLAY_STRING (overlay
, str
, 1);
4999 #undef RECORD_OVERLAY_STRING
5003 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5005 /* Record the total number of strings to process. */
5006 it
->n_overlay_strings
= n
;
5008 /* IT->current.overlay_string_index is the number of overlay strings
5009 that have already been consumed by IT. Copy some of the
5010 remaining overlay strings to IT->overlay_strings. */
5012 j
= it
->current
.overlay_string_index
;
5013 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5015 it
->overlay_strings
[i
] = entries
[j
].string
;
5016 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5023 /* Get the first chunk of overlay strings at IT's current buffer
5024 position, or at CHARPOS if that is > 0. Value is non-zero if at
5025 least one overlay string was found. */
5028 get_overlay_strings_1 (struct it
*it
, int charpos
, int compute_stop_p
)
5030 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5031 process. This fills IT->overlay_strings with strings, and sets
5032 IT->n_overlay_strings to the total number of strings to process.
5033 IT->pos.overlay_string_index has to be set temporarily to zero
5034 because load_overlay_strings needs this; it must be set to -1
5035 when no overlay strings are found because a zero value would
5036 indicate a position in the first overlay string. */
5037 it
->current
.overlay_string_index
= 0;
5038 load_overlay_strings (it
, charpos
);
5040 /* If we found overlay strings, set up IT to deliver display
5041 elements from the first one. Otherwise set up IT to deliver
5042 from current_buffer. */
5043 if (it
->n_overlay_strings
)
5045 /* Make sure we know settings in current_buffer, so that we can
5046 restore meaningful values when we're done with the overlay
5049 compute_stop_pos (it
);
5050 xassert (it
->face_id
>= 0);
5052 /* Save IT's settings. They are restored after all overlay
5053 strings have been processed. */
5054 xassert (!compute_stop_p
|| it
->sp
== 0);
5056 /* When called from handle_stop, there might be an empty display
5057 string loaded. In that case, don't bother saving it. */
5058 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5061 /* Set up IT to deliver display elements from the first overlay
5063 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5064 it
->string
= it
->overlay_strings
[0];
5065 it
->from_overlay
= Qnil
;
5066 it
->stop_charpos
= 0;
5067 xassert (STRINGP (it
->string
));
5068 it
->end_charpos
= SCHARS (it
->string
);
5069 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5070 it
->method
= GET_FROM_STRING
;
5074 it
->current
.overlay_string_index
= -1;
5079 get_overlay_strings (struct it
*it
, int charpos
)
5082 it
->method
= GET_FROM_BUFFER
;
5084 (void) get_overlay_strings_1 (it
, charpos
, 1);
5088 /* Value is non-zero if we found at least one overlay string. */
5089 return STRINGP (it
->string
);
5094 /***********************************************************************
5095 Saving and restoring state
5096 ***********************************************************************/
5098 /* Save current settings of IT on IT->stack. Called, for example,
5099 before setting up IT for an overlay string, to be able to restore
5100 IT's settings to what they were after the overlay string has been
5104 push_it (struct it
*it
)
5106 struct iterator_stack_entry
*p
;
5108 xassert (it
->sp
< IT_STACK_SIZE
);
5109 p
= it
->stack
+ it
->sp
;
5111 p
->stop_charpos
= it
->stop_charpos
;
5112 p
->prev_stop
= it
->prev_stop
;
5113 p
->base_level_stop
= it
->base_level_stop
;
5114 p
->cmp_it
= it
->cmp_it
;
5115 xassert (it
->face_id
>= 0);
5116 p
->face_id
= it
->face_id
;
5117 p
->string
= it
->string
;
5118 p
->method
= it
->method
;
5119 p
->from_overlay
= it
->from_overlay
;
5122 case GET_FROM_IMAGE
:
5123 p
->u
.image
.object
= it
->object
;
5124 p
->u
.image
.image_id
= it
->image_id
;
5125 p
->u
.image
.slice
= it
->slice
;
5127 case GET_FROM_STRETCH
:
5128 p
->u
.stretch
.object
= it
->object
;
5131 p
->position
= it
->position
;
5132 p
->current
= it
->current
;
5133 p
->end_charpos
= it
->end_charpos
;
5134 p
->string_nchars
= it
->string_nchars
;
5136 p
->multibyte_p
= it
->multibyte_p
;
5137 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5138 p
->space_width
= it
->space_width
;
5139 p
->font_height
= it
->font_height
;
5140 p
->voffset
= it
->voffset
;
5141 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5142 p
->display_ellipsis_p
= 0;
5143 p
->line_wrap
= it
->line_wrap
;
5148 iterate_out_of_display_property (struct it
*it
)
5150 /* Maybe initialize paragraph direction. If we are at the beginning
5151 of a new paragraph, next_element_from_buffer may not have a
5152 chance to do that. */
5153 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
5154 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
5155 /* prev_stop can be zero, so check against BEGV as well. */
5156 while (it
->bidi_it
.charpos
>= BEGV
5157 && it
->prev_stop
<= it
->bidi_it
.charpos
5158 && it
->bidi_it
.charpos
< CHARPOS (it
->position
))
5159 bidi_move_to_visually_next (&it
->bidi_it
);
5160 /* Record the stop_pos we just crossed, for when we cross it
5162 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5163 it
->prev_stop
= CHARPOS (it
->position
);
5164 /* If we ended up not where pop_it put us, resync IT's
5165 positional members with the bidi iterator. */
5166 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5168 SET_TEXT_POS (it
->position
,
5169 it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5170 it
->current
.pos
= it
->position
;
5174 /* Restore IT's settings from IT->stack. Called, for example, when no
5175 more overlay strings must be processed, and we return to delivering
5176 display elements from a buffer, or when the end of a string from a
5177 `display' property is reached and we return to delivering display
5178 elements from an overlay string, or from a buffer. */
5181 pop_it (struct it
*it
)
5183 struct iterator_stack_entry
*p
;
5185 xassert (it
->sp
> 0);
5187 p
= it
->stack
+ it
->sp
;
5188 it
->stop_charpos
= p
->stop_charpos
;
5189 it
->prev_stop
= p
->prev_stop
;
5190 it
->base_level_stop
= p
->base_level_stop
;
5191 it
->cmp_it
= p
->cmp_it
;
5192 it
->face_id
= p
->face_id
;
5193 it
->current
= p
->current
;
5194 it
->position
= p
->position
;
5195 it
->string
= p
->string
;
5196 it
->from_overlay
= p
->from_overlay
;
5197 if (NILP (it
->string
))
5198 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5199 it
->method
= p
->method
;
5202 case GET_FROM_IMAGE
:
5203 it
->image_id
= p
->u
.image
.image_id
;
5204 it
->object
= p
->u
.image
.object
;
5205 it
->slice
= p
->u
.image
.slice
;
5207 case GET_FROM_STRETCH
:
5208 it
->object
= p
->u
.comp
.object
;
5210 case GET_FROM_BUFFER
:
5211 it
->object
= it
->w
->buffer
;
5214 /* Bidi-iterate until we get out of the portion of text, if
5215 any, covered by a `display' text property or an overlay
5216 with `display' property. (We cannot just jump there,
5217 because the internal coherency of the bidi iterator state
5218 can not be preserved across such jumps.) We also must
5219 determine the paragraph base direction if the overlay we
5220 just processed is at the beginning of a new
5222 iterate_out_of_display_property (it
);
5225 case GET_FROM_STRING
:
5226 it
->object
= it
->string
;
5228 case GET_FROM_DISPLAY_VECTOR
:
5230 it
->method
= GET_FROM_C_STRING
;
5231 else if (STRINGP (it
->string
))
5232 it
->method
= GET_FROM_STRING
;
5235 it
->method
= GET_FROM_BUFFER
;
5236 it
->object
= it
->w
->buffer
;
5239 it
->end_charpos
= p
->end_charpos
;
5240 it
->string_nchars
= p
->string_nchars
;
5242 it
->multibyte_p
= p
->multibyte_p
;
5243 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5244 it
->space_width
= p
->space_width
;
5245 it
->font_height
= p
->font_height
;
5246 it
->voffset
= p
->voffset
;
5247 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5248 it
->line_wrap
= p
->line_wrap
;
5253 /***********************************************************************
5255 ***********************************************************************/
5257 /* Set IT's current position to the previous line start. */
5260 back_to_previous_line_start (struct it
*it
)
5262 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5263 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5267 /* Move IT to the next line start.
5269 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5270 we skipped over part of the text (as opposed to moving the iterator
5271 continuously over the text). Otherwise, don't change the value
5274 Newlines may come from buffer text, overlay strings, or strings
5275 displayed via the `display' property. That's the reason we can't
5276 simply use find_next_newline_no_quit.
5278 Note that this function may not skip over invisible text that is so
5279 because of text properties and immediately follows a newline. If
5280 it would, function reseat_at_next_visible_line_start, when called
5281 from set_iterator_to_next, would effectively make invisible
5282 characters following a newline part of the wrong glyph row, which
5283 leads to wrong cursor motion. */
5286 forward_to_next_line_start (struct it
*it
, int *skipped_p
)
5288 int old_selective
, newline_found_p
, n
;
5289 const int MAX_NEWLINE_DISTANCE
= 500;
5291 /* If already on a newline, just consume it to avoid unintended
5292 skipping over invisible text below. */
5293 if (it
->what
== IT_CHARACTER
5295 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5297 set_iterator_to_next (it
, 0);
5302 /* Don't handle selective display in the following. It's (a)
5303 unnecessary because it's done by the caller, and (b) leads to an
5304 infinite recursion because next_element_from_ellipsis indirectly
5305 calls this function. */
5306 old_selective
= it
->selective
;
5309 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5310 from buffer text. */
5311 for (n
= newline_found_p
= 0;
5312 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5313 n
+= STRINGP (it
->string
) ? 0 : 1)
5315 if (!get_next_display_element (it
))
5317 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5318 set_iterator_to_next (it
, 0);
5321 /* If we didn't find a newline near enough, see if we can use a
5323 if (!newline_found_p
)
5325 int start
= IT_CHARPOS (*it
);
5326 int limit
= find_next_newline_no_quit (start
, 1);
5329 xassert (!STRINGP (it
->string
));
5331 /* If there isn't any `display' property in sight, and no
5332 overlays, we can just use the position of the newline in
5334 if (it
->stop_charpos
>= limit
5335 || ((pos
= Fnext_single_property_change (make_number (start
),
5337 Qnil
, make_number (limit
)),
5339 && next_overlay_change (start
) == ZV
))
5341 IT_CHARPOS (*it
) = limit
;
5342 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5343 *skipped_p
= newline_found_p
= 1;
5347 while (get_next_display_element (it
)
5348 && !newline_found_p
)
5350 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5351 set_iterator_to_next (it
, 0);
5356 it
->selective
= old_selective
;
5357 return newline_found_p
;
5361 /* Set IT's current position to the previous visible line start. Skip
5362 invisible text that is so either due to text properties or due to
5363 selective display. Caution: this does not change IT->current_x and
5367 back_to_previous_visible_line_start (struct it
*it
)
5369 while (IT_CHARPOS (*it
) > BEGV
)
5371 back_to_previous_line_start (it
);
5373 if (IT_CHARPOS (*it
) <= BEGV
)
5376 /* If selective > 0, then lines indented more than its value are
5378 if (it
->selective
> 0
5379 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5380 (double) it
->selective
)) /* iftc */
5383 /* Check the newline before point for invisibility. */
5386 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5387 Qinvisible
, it
->window
);
5388 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5392 if (IT_CHARPOS (*it
) <= BEGV
)
5399 Lisp_Object val
, overlay
;
5401 /* If newline is part of a composition, continue from start of composition */
5402 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5403 && beg
< IT_CHARPOS (*it
))
5406 /* If newline is replaced by a display property, find start of overlay
5407 or interval and continue search from that point. */
5409 pos
= --IT_CHARPOS (it2
);
5412 it2
.string_from_display_prop_p
= 0;
5413 if (handle_display_prop (&it2
) == HANDLED_RETURN
5414 && !NILP (val
= get_char_property_and_overlay
5415 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5416 && (OVERLAYP (overlay
)
5417 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5418 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5421 /* Newline is not replaced by anything -- so we are done. */
5427 IT_CHARPOS (*it
) = beg
;
5428 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5432 it
->continuation_lines_width
= 0;
5434 xassert (IT_CHARPOS (*it
) >= BEGV
);
5435 xassert (IT_CHARPOS (*it
) == BEGV
5436 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5441 /* Reseat iterator IT at the previous visible line start. Skip
5442 invisible text that is so either due to text properties or due to
5443 selective display. At the end, update IT's overlay information,
5444 face information etc. */
5447 reseat_at_previous_visible_line_start (struct it
*it
)
5449 back_to_previous_visible_line_start (it
);
5450 reseat (it
, it
->current
.pos
, 1);
5455 /* Reseat iterator IT on the next visible line start in the current
5456 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5457 preceding the line start. Skip over invisible text that is so
5458 because of selective display. Compute faces, overlays etc at the
5459 new position. Note that this function does not skip over text that
5460 is invisible because of text properties. */
5463 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5465 int newline_found_p
, skipped_p
= 0;
5467 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5469 /* Skip over lines that are invisible because they are indented
5470 more than the value of IT->selective. */
5471 if (it
->selective
> 0)
5472 while (IT_CHARPOS (*it
) < ZV
5473 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5474 (double) it
->selective
)) /* iftc */
5476 xassert (IT_BYTEPOS (*it
) == BEGV
5477 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5478 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
);
5481 /* Position on the newline if that's what's requested. */
5482 if (on_newline_p
&& newline_found_p
)
5484 if (STRINGP (it
->string
))
5486 if (IT_STRING_CHARPOS (*it
) > 0)
5488 --IT_STRING_CHARPOS (*it
);
5489 --IT_STRING_BYTEPOS (*it
);
5492 else if (IT_CHARPOS (*it
) > BEGV
)
5496 reseat (it
, it
->current
.pos
, 0);
5500 reseat (it
, it
->current
.pos
, 0);
5507 /***********************************************************************
5508 Changing an iterator's position
5509 ***********************************************************************/
5511 /* Change IT's current position to POS in current_buffer. If FORCE_P
5512 is non-zero, always check for text properties at the new position.
5513 Otherwise, text properties are only looked up if POS >=
5514 IT->check_charpos of a property. */
5517 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5519 int original_pos
= IT_CHARPOS (*it
);
5521 reseat_1 (it
, pos
, 0);
5523 /* Determine where to check text properties. Avoid doing it
5524 where possible because text property lookup is very expensive. */
5526 || CHARPOS (pos
) > it
->stop_charpos
5527 || CHARPOS (pos
) < original_pos
)
5531 /* For bidi iteration, we need to prime prev_stop and
5532 base_level_stop with our best estimations. */
5533 if (CHARPOS (pos
) < it
->prev_stop
)
5535 handle_stop_backwards (it
, BEGV
);
5536 if (CHARPOS (pos
) < it
->base_level_stop
)
5537 it
->base_level_stop
= 0;
5539 else if (CHARPOS (pos
) > it
->stop_charpos
5540 && it
->stop_charpos
>= BEGV
)
5541 handle_stop_backwards (it
, it
->stop_charpos
);
5548 it
->prev_stop
= it
->base_level_stop
= 0;
5557 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5558 IT->stop_pos to POS, also. */
5561 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5563 /* Don't call this function when scanning a C string. */
5564 xassert (it
->s
== NULL
);
5566 /* POS must be a reasonable value. */
5567 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5569 it
->current
.pos
= it
->position
= pos
;
5570 it
->end_charpos
= ZV
;
5572 it
->current
.dpvec_index
= -1;
5573 it
->current
.overlay_string_index
= -1;
5574 IT_STRING_CHARPOS (*it
) = -1;
5575 IT_STRING_BYTEPOS (*it
) = -1;
5577 it
->string_from_display_prop_p
= 0;
5578 it
->method
= GET_FROM_BUFFER
;
5579 it
->object
= it
->w
->buffer
;
5580 it
->area
= TEXT_AREA
;
5581 it
->multibyte_p
= !NILP (current_buffer
->enable_multibyte_characters
);
5583 it
->string_from_display_prop_p
= 0;
5584 it
->face_before_selective_p
= 0;
5586 it
->bidi_it
.first_elt
= 1;
5590 it
->stop_charpos
= CHARPOS (pos
);
5591 it
->base_level_stop
= CHARPOS (pos
);
5596 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5597 If S is non-null, it is a C string to iterate over. Otherwise,
5598 STRING gives a Lisp string to iterate over.
5600 If PRECISION > 0, don't return more then PRECISION number of
5601 characters from the string.
5603 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5604 characters have been returned. FIELD_WIDTH < 0 means an infinite
5607 MULTIBYTE = 0 means disable processing of multibyte characters,
5608 MULTIBYTE > 0 means enable it,
5609 MULTIBYTE < 0 means use IT->multibyte_p.
5611 IT must be initialized via a prior call to init_iterator before
5612 calling this function. */
5615 reseat_to_string (struct it
*it
, unsigned char *s
, Lisp_Object string
,
5616 int charpos
, int precision
, int field_width
, int multibyte
)
5618 /* No region in strings. */
5619 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5621 /* No text property checks performed by default, but see below. */
5622 it
->stop_charpos
= -1;
5624 /* Set iterator position and end position. */
5625 memset (&it
->current
, 0, sizeof it
->current
);
5626 it
->current
.overlay_string_index
= -1;
5627 it
->current
.dpvec_index
= -1;
5628 xassert (charpos
>= 0);
5630 /* If STRING is specified, use its multibyteness, otherwise use the
5631 setting of MULTIBYTE, if specified. */
5633 it
->multibyte_p
= multibyte
> 0;
5637 xassert (STRINGP (string
));
5638 it
->string
= string
;
5640 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5641 it
->method
= GET_FROM_STRING
;
5642 it
->current
.string_pos
= string_pos (charpos
, string
);
5649 /* Note that we use IT->current.pos, not it->current.string_pos,
5650 for displaying C strings. */
5651 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5652 if (it
->multibyte_p
)
5654 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5655 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5659 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5660 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5663 it
->method
= GET_FROM_C_STRING
;
5666 /* PRECISION > 0 means don't return more than PRECISION characters
5668 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5669 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5671 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5672 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5673 FIELD_WIDTH < 0 means infinite field width. This is useful for
5674 padding with `-' at the end of a mode line. */
5675 if (field_width
< 0)
5676 field_width
= INFINITY
;
5677 if (field_width
> it
->end_charpos
- charpos
)
5678 it
->end_charpos
= charpos
+ field_width
;
5680 /* Use the standard display table for displaying strings. */
5681 if (DISP_TABLE_P (Vstandard_display_table
))
5682 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5684 it
->stop_charpos
= charpos
;
5685 if (s
== NULL
&& it
->multibyte_p
)
5687 EMACS_INT endpos
= SCHARS (it
->string
);
5688 if (endpos
> it
->end_charpos
)
5689 endpos
= it
->end_charpos
;
5690 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
5698 /***********************************************************************
5700 ***********************************************************************/
5702 /* Map enum it_method value to corresponding next_element_from_* function. */
5704 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
5706 next_element_from_buffer
,
5707 next_element_from_display_vector
,
5708 next_element_from_string
,
5709 next_element_from_c_string
,
5710 next_element_from_image
,
5711 next_element_from_stretch
5714 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
5717 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
5718 (possibly with the following characters). */
5720 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
5721 ((IT)->cmp_it.id >= 0 \
5722 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
5723 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
5724 END_CHARPOS, (IT)->w, \
5725 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
5729 /* Load IT's display element fields with information about the next
5730 display element from the current position of IT. Value is zero if
5731 end of buffer (or C string) is reached. */
5733 static struct frame
*last_escape_glyph_frame
= NULL
;
5734 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
5735 static int last_escape_glyph_merged_face_id
= 0;
5738 get_next_display_element (struct it
*it
)
5740 /* Non-zero means that we found a display element. Zero means that
5741 we hit the end of what we iterate over. Performance note: the
5742 function pointer `method' used here turns out to be faster than
5743 using a sequence of if-statements. */
5747 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
5749 if (it
->what
== IT_CHARACTER
)
5751 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
5752 and only if (a) the resolved directionality of that character
5754 /* FIXME: Do we need an exception for characters from display
5756 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
5757 it
->c
= bidi_mirror_char (it
->c
);
5758 /* Map via display table or translate control characters.
5759 IT->c, IT->len etc. have been set to the next character by
5760 the function call above. If we have a display table, and it
5761 contains an entry for IT->c, translate it. Don't do this if
5762 IT->c itself comes from a display table, otherwise we could
5763 end up in an infinite recursion. (An alternative could be to
5764 count the recursion depth of this function and signal an
5765 error when a certain maximum depth is reached.) Is it worth
5767 if (success_p
&& it
->dpvec
== NULL
)
5770 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
5771 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
5772 nbsp_or_shy
= char_is_other
;
5773 int decoded
= it
->c
;
5776 && (dv
= DISP_CHAR_VECTOR (it
->dp
, it
->c
),
5779 struct Lisp_Vector
*v
= XVECTOR (dv
);
5781 /* Return the first character from the display table
5782 entry, if not empty. If empty, don't display the
5783 current character. */
5786 it
->dpvec_char_len
= it
->len
;
5787 it
->dpvec
= v
->contents
;
5788 it
->dpend
= v
->contents
+ v
->size
;
5789 it
->current
.dpvec_index
= 0;
5790 it
->dpvec_face_id
= -1;
5791 it
->saved_face_id
= it
->face_id
;
5792 it
->method
= GET_FROM_DISPLAY_VECTOR
;
5797 set_iterator_to_next (it
, 0);
5802 if (unibyte_display_via_language_environment
5803 && !ASCII_CHAR_P (it
->c
))
5804 decoded
= DECODE_CHAR (unibyte
, it
->c
);
5806 if (it
->c
>= 0x80 && ! NILP (Vnobreak_char_display
))
5808 if (it
->multibyte_p
)
5809 nbsp_or_shy
= (it
->c
== 0xA0 ? char_is_nbsp
5810 : it
->c
== 0xAD ? char_is_soft_hyphen
5812 else if (unibyte_display_via_language_environment
)
5813 nbsp_or_shy
= (decoded
== 0xA0 ? char_is_nbsp
5814 : decoded
== 0xAD ? char_is_soft_hyphen
5818 /* Translate control characters into `\003' or `^C' form.
5819 Control characters coming from a display table entry are
5820 currently not translated because we use IT->dpvec to hold
5821 the translation. This could easily be changed but I
5822 don't believe that it is worth doing.
5824 If it->multibyte_p is nonzero, non-printable non-ASCII
5825 characters are also translated to octal form.
5827 If it->multibyte_p is zero, eight-bit characters that
5828 don't have corresponding multibyte char code are also
5829 translated to octal form. */
5831 ? (it
->area
!= TEXT_AREA
5832 /* In mode line, treat \n, \t like other crl chars. */
5835 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
5836 || (it
->c
!= '\n' && it
->c
!= '\t'))
5839 ? ! CHAR_PRINTABLE_P (it
->c
)
5840 : (! unibyte_display_via_language_environment
5842 : (decoded
>= 0x80 && decoded
< 0xA0))))))
5844 /* IT->c is a control character which must be displayed
5845 either as '\003' or as `^C' where the '\\' and '^'
5846 can be defined in the display table. Fill
5847 IT->ctl_chars with glyphs for what we have to
5848 display. Then, set IT->dpvec to these glyphs. */
5851 int face_id
, lface_id
= 0 ;
5854 /* Handle control characters with ^. */
5856 if (it
->c
< 128 && it
->ctl_arrow_p
)
5860 g
= '^'; /* default glyph for Control */
5861 /* Set IT->ctl_chars[0] to the glyph for `^'. */
5863 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5864 && GLYPH_CODE_CHAR_VALID_P (gc
))
5866 g
= GLYPH_CODE_CHAR (gc
);
5867 lface_id
= GLYPH_CODE_FACE (gc
);
5871 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
5873 else if (it
->f
== last_escape_glyph_frame
5874 && it
->face_id
== last_escape_glyph_face_id
)
5876 face_id
= last_escape_glyph_merged_face_id
;
5880 /* Merge the escape-glyph face into the current face. */
5881 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5883 last_escape_glyph_frame
= it
->f
;
5884 last_escape_glyph_face_id
= it
->face_id
;
5885 last_escape_glyph_merged_face_id
= face_id
;
5888 XSETINT (it
->ctl_chars
[0], g
);
5889 XSETINT (it
->ctl_chars
[1], it
->c
^ 0100);
5891 goto display_control
;
5894 /* Handle non-break space in the mode where it only gets
5897 if (EQ (Vnobreak_char_display
, Qt
)
5898 && nbsp_or_shy
== char_is_nbsp
)
5900 /* Merge the no-break-space face into the current face. */
5901 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
5905 XSETINT (it
->ctl_chars
[0], ' ');
5907 goto display_control
;
5910 /* Handle sequences that start with the "escape glyph". */
5912 /* the default escape glyph is \. */
5913 escape_glyph
= '\\';
5916 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
5917 && GLYPH_CODE_CHAR_VALID_P (gc
))
5919 escape_glyph
= GLYPH_CODE_CHAR (gc
);
5920 lface_id
= GLYPH_CODE_FACE (gc
);
5924 /* The display table specified a face.
5925 Merge it into face_id and also into escape_glyph. */
5926 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
5929 else if (it
->f
== last_escape_glyph_frame
5930 && it
->face_id
== last_escape_glyph_face_id
)
5932 face_id
= last_escape_glyph_merged_face_id
;
5936 /* Merge the escape-glyph face into the current face. */
5937 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
5939 last_escape_glyph_frame
= it
->f
;
5940 last_escape_glyph_face_id
= it
->face_id
;
5941 last_escape_glyph_merged_face_id
= face_id
;
5944 /* Handle soft hyphens in the mode where they only get
5947 if (EQ (Vnobreak_char_display
, Qt
)
5948 && nbsp_or_shy
== char_is_soft_hyphen
)
5951 XSETINT (it
->ctl_chars
[0], '-');
5953 goto display_control
;
5956 /* Handle non-break space and soft hyphen
5957 with the escape glyph. */
5961 XSETINT (it
->ctl_chars
[0], escape_glyph
);
5962 it
->c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
5963 XSETINT (it
->ctl_chars
[1], it
->c
);
5965 goto display_control
;
5969 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
5973 /* Set IT->ctl_chars[0] to the glyph for `\\'. */
5974 if (CHAR_BYTE8_P (it
->c
))
5976 str
[0] = CHAR_TO_BYTE8 (it
->c
);
5979 else if (it
->c
< 256)
5986 /* It's an invalid character, which shouldn't
5987 happen actually, but due to bugs it may
5988 happen. Let's print the char as is, there's
5989 not much meaningful we can do with it. */
5991 str
[1] = it
->c
>> 8;
5992 str
[2] = it
->c
>> 16;
5993 str
[3] = it
->c
>> 24;
5997 for (i
= 0; i
< len
; i
++)
6000 XSETINT (it
->ctl_chars
[i
* 4], escape_glyph
);
6001 /* Insert three more glyphs into IT->ctl_chars for
6002 the octal display of the character. */
6003 g
= ((str
[i
] >> 6) & 7) + '0';
6004 XSETINT (it
->ctl_chars
[i
* 4 + 1], g
);
6005 g
= ((str
[i
] >> 3) & 7) + '0';
6006 XSETINT (it
->ctl_chars
[i
* 4 + 2], g
);
6007 g
= (str
[i
] & 7) + '0';
6008 XSETINT (it
->ctl_chars
[i
* 4 + 3], g
);
6014 /* Set up IT->dpvec and return first character from it. */
6015 it
->dpvec_char_len
= it
->len
;
6016 it
->dpvec
= it
->ctl_chars
;
6017 it
->dpend
= it
->dpvec
+ ctl_len
;
6018 it
->current
.dpvec_index
= 0;
6019 it
->dpvec_face_id
= face_id
;
6020 it
->saved_face_id
= it
->face_id
;
6021 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6028 #ifdef HAVE_WINDOW_SYSTEM
6029 /* Adjust face id for a multibyte character. There are no multibyte
6030 character in unibyte text. */
6031 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6034 && FRAME_WINDOW_P (it
->f
))
6036 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6038 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6040 /* Automatic composition with glyph-string. */
6041 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6043 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6047 int pos
= (it
->s
? -1
6048 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6049 : IT_CHARPOS (*it
));
6051 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->c
, pos
, it
->string
);
6056 /* Is this character the last one of a run of characters with
6057 box? If yes, set IT->end_of_box_run_p to 1. */
6061 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6063 int face_id
= underlying_face_id (it
);
6064 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6068 if (face
->box
== FACE_NO_BOX
)
6070 /* If the box comes from face properties in a
6071 display string, check faces in that string. */
6072 int string_face_id
= face_after_it_pos (it
);
6073 it
->end_of_box_run_p
6074 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6077 /* Otherwise, the box comes from the underlying face.
6078 If this is the last string character displayed, check
6079 the next buffer location. */
6080 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6081 && (it
->current
.overlay_string_index
6082 == it
->n_overlay_strings
- 1))
6086 struct text_pos pos
= it
->current
.pos
;
6087 INC_TEXT_POS (pos
, it
->multibyte_p
);
6089 next_face_id
= face_at_buffer_position
6090 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6091 it
->region_end_charpos
, &ignore
,
6092 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6094 it
->end_of_box_run_p
6095 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6102 int face_id
= face_after_it_pos (it
);
6103 it
->end_of_box_run_p
6104 = (face_id
!= it
->face_id
6105 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6109 /* Value is 0 if end of buffer or string reached. */
6114 /* Move IT to the next display element.
6116 RESEAT_P non-zero means if called on a newline in buffer text,
6117 skip to the next visible line start.
6119 Functions get_next_display_element and set_iterator_to_next are
6120 separate because I find this arrangement easier to handle than a
6121 get_next_display_element function that also increments IT's
6122 position. The way it is we can first look at an iterator's current
6123 display element, decide whether it fits on a line, and if it does,
6124 increment the iterator position. The other way around we probably
6125 would either need a flag indicating whether the iterator has to be
6126 incremented the next time, or we would have to implement a
6127 decrement position function which would not be easy to write. */
6130 set_iterator_to_next (struct it
*it
, int reseat_p
)
6132 /* Reset flags indicating start and end of a sequence of characters
6133 with box. Reset them at the start of this function because
6134 moving the iterator to a new position might set them. */
6135 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6139 case GET_FROM_BUFFER
:
6140 /* The current display element of IT is a character from
6141 current_buffer. Advance in the buffer, and maybe skip over
6142 invisible lines that are so because of selective display. */
6143 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6144 reseat_at_next_visible_line_start (it
, 0);
6145 else if (it
->cmp_it
.id
>= 0)
6147 /* We are currently getting glyphs from a composition. */
6152 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6153 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6154 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6156 it
->cmp_it
.from
= it
->cmp_it
.to
;
6161 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6163 it
->stop_charpos
, Qnil
);
6166 else if (! it
->cmp_it
.reversed_p
)
6168 /* Composition created while scanning forward. */
6169 /* Update IT's char/byte positions to point to the first
6170 character of the next grapheme cluster, or to the
6171 character visually after the current composition. */
6172 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6173 bidi_move_to_visually_next (&it
->bidi_it
);
6174 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6175 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6177 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6179 /* Proceed to the next grapheme cluster. */
6180 it
->cmp_it
.from
= it
->cmp_it
.to
;
6184 /* No more grapheme clusters in this composition.
6185 Find the next stop position. */
6186 EMACS_INT stop
= it
->stop_charpos
;
6187 if (it
->bidi_it
.scan_dir
< 0)
6188 /* Now we are scanning backward and don't know
6191 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6192 IT_BYTEPOS (*it
), stop
, Qnil
);
6197 /* Composition created while scanning backward. */
6198 /* Update IT's char/byte positions to point to the last
6199 character of the previous grapheme cluster, or the
6200 character visually after the current composition. */
6201 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6202 bidi_move_to_visually_next (&it
->bidi_it
);
6203 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6204 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6205 if (it
->cmp_it
.from
> 0)
6207 /* Proceed to the previous grapheme cluster. */
6208 it
->cmp_it
.to
= it
->cmp_it
.from
;
6212 /* No more grapheme clusters in this composition.
6213 Find the next stop position. */
6214 EMACS_INT stop
= it
->stop_charpos
;
6215 if (it
->bidi_it
.scan_dir
< 0)
6216 /* Now we are scanning backward and don't know
6219 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6220 IT_BYTEPOS (*it
), stop
, Qnil
);
6226 xassert (it
->len
!= 0);
6230 IT_BYTEPOS (*it
) += it
->len
;
6231 IT_CHARPOS (*it
) += 1;
6235 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6236 /* If this is a new paragraph, determine its base
6237 direction (a.k.a. its base embedding level). */
6238 if (it
->bidi_it
.new_paragraph
)
6239 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6240 bidi_move_to_visually_next (&it
->bidi_it
);
6241 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6242 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6243 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6245 /* As the scan direction was changed, we must
6246 re-compute the stop position for composition. */
6247 EMACS_INT stop
= it
->stop_charpos
;
6248 if (it
->bidi_it
.scan_dir
< 0)
6250 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6251 IT_BYTEPOS (*it
), stop
, Qnil
);
6254 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6258 case GET_FROM_C_STRING
:
6259 /* Current display element of IT is from a C string. */
6260 IT_BYTEPOS (*it
) += it
->len
;
6261 IT_CHARPOS (*it
) += 1;
6264 case GET_FROM_DISPLAY_VECTOR
:
6265 /* Current display element of IT is from a display table entry.
6266 Advance in the display table definition. Reset it to null if
6267 end reached, and continue with characters from buffers/
6269 ++it
->current
.dpvec_index
;
6271 /* Restore face of the iterator to what they were before the
6272 display vector entry (these entries may contain faces). */
6273 it
->face_id
= it
->saved_face_id
;
6275 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6277 int recheck_faces
= it
->ellipsis_p
;
6280 it
->method
= GET_FROM_C_STRING
;
6281 else if (STRINGP (it
->string
))
6282 it
->method
= GET_FROM_STRING
;
6285 it
->method
= GET_FROM_BUFFER
;
6286 it
->object
= it
->w
->buffer
;
6290 it
->current
.dpvec_index
= -1;
6292 /* Skip over characters which were displayed via IT->dpvec. */
6293 if (it
->dpvec_char_len
< 0)
6294 reseat_at_next_visible_line_start (it
, 1);
6295 else if (it
->dpvec_char_len
> 0)
6297 if (it
->method
== GET_FROM_STRING
6298 && it
->n_overlay_strings
> 0)
6299 it
->ignore_overlay_strings_at_pos_p
= 1;
6300 it
->len
= it
->dpvec_char_len
;
6301 set_iterator_to_next (it
, reseat_p
);
6304 /* Maybe recheck faces after display vector */
6306 it
->stop_charpos
= IT_CHARPOS (*it
);
6310 case GET_FROM_STRING
:
6311 /* Current display element is a character from a Lisp string. */
6312 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6313 if (it
->cmp_it
.id
>= 0)
6315 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6316 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6317 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6318 it
->cmp_it
.from
= it
->cmp_it
.to
;
6322 composition_compute_stop_pos (&it
->cmp_it
,
6323 IT_STRING_CHARPOS (*it
),
6324 IT_STRING_BYTEPOS (*it
),
6325 it
->stop_charpos
, it
->string
);
6330 IT_STRING_BYTEPOS (*it
) += it
->len
;
6331 IT_STRING_CHARPOS (*it
) += 1;
6334 consider_string_end
:
6336 if (it
->current
.overlay_string_index
>= 0)
6338 /* IT->string is an overlay string. Advance to the
6339 next, if there is one. */
6340 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6343 next_overlay_string (it
);
6345 setup_for_ellipsis (it
, 0);
6350 /* IT->string is not an overlay string. If we reached
6351 its end, and there is something on IT->stack, proceed
6352 with what is on the stack. This can be either another
6353 string, this time an overlay string, or a buffer. */
6354 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6358 if (it
->method
== GET_FROM_STRING
)
6359 goto consider_string_end
;
6364 case GET_FROM_IMAGE
:
6365 case GET_FROM_STRETCH
:
6366 /* The position etc with which we have to proceed are on
6367 the stack. The position may be at the end of a string,
6368 if the `display' property takes up the whole string. */
6369 xassert (it
->sp
> 0);
6371 if (it
->method
== GET_FROM_STRING
)
6372 goto consider_string_end
;
6376 /* There are no other methods defined, so this should be a bug. */
6380 xassert (it
->method
!= GET_FROM_STRING
6381 || (STRINGP (it
->string
)
6382 && IT_STRING_CHARPOS (*it
) >= 0));
6385 /* Load IT's display element fields with information about the next
6386 display element which comes from a display table entry or from the
6387 result of translating a control character to one of the forms `^C'
6390 IT->dpvec holds the glyphs to return as characters.
6391 IT->saved_face_id holds the face id before the display vector--it
6392 is restored into IT->face_id in set_iterator_to_next. */
6395 next_element_from_display_vector (struct it
*it
)
6400 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6402 it
->face_id
= it
->saved_face_id
;
6404 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6405 That seemed totally bogus - so I changed it... */
6406 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6408 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6410 it
->c
= GLYPH_CODE_CHAR (gc
);
6411 it
->len
= CHAR_BYTES (it
->c
);
6413 /* The entry may contain a face id to use. Such a face id is
6414 the id of a Lisp face, not a realized face. A face id of
6415 zero means no face is specified. */
6416 if (it
->dpvec_face_id
>= 0)
6417 it
->face_id
= it
->dpvec_face_id
;
6420 int lface_id
= GLYPH_CODE_FACE (gc
);
6422 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6427 /* Display table entry is invalid. Return a space. */
6428 it
->c
= ' ', it
->len
= 1;
6430 /* Don't change position and object of the iterator here. They are
6431 still the values of the character that had this display table
6432 entry or was translated, and that's what we want. */
6433 it
->what
= IT_CHARACTER
;
6438 /* Load IT with the next display element from Lisp string IT->string.
6439 IT->current.string_pos is the current position within the string.
6440 If IT->current.overlay_string_index >= 0, the Lisp string is an
6444 next_element_from_string (struct it
*it
)
6446 struct text_pos position
;
6448 xassert (STRINGP (it
->string
));
6449 xassert (IT_STRING_CHARPOS (*it
) >= 0);
6450 position
= it
->current
.string_pos
;
6452 /* Time to check for invisible text? */
6453 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
6454 && IT_STRING_CHARPOS (*it
) == it
->stop_charpos
)
6458 /* Since a handler may have changed IT->method, we must
6460 return GET_NEXT_DISPLAY_ELEMENT (it
);
6463 if (it
->current
.overlay_string_index
>= 0)
6465 /* Get the next character from an overlay string. In overlay
6466 strings, There is no field width or padding with spaces to
6468 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6473 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6474 IT_STRING_BYTEPOS (*it
), SCHARS (it
->string
))
6475 && next_element_from_composition (it
))
6479 else if (STRING_MULTIBYTE (it
->string
))
6481 int remaining
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6482 const unsigned char *s
= (SDATA (it
->string
)
6483 + IT_STRING_BYTEPOS (*it
));
6484 it
->c
= string_char_and_length (s
, &it
->len
);
6488 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6494 /* Get the next character from a Lisp string that is not an
6495 overlay string. Such strings come from the mode line, for
6496 example. We may have to pad with spaces, or truncate the
6497 string. See also next_element_from_c_string. */
6498 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
6503 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
6505 /* Pad with spaces. */
6506 it
->c
= ' ', it
->len
= 1;
6507 CHARPOS (position
) = BYTEPOS (position
) = -1;
6509 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
6510 IT_STRING_BYTEPOS (*it
), it
->string_nchars
)
6511 && next_element_from_composition (it
))
6515 else if (STRING_MULTIBYTE (it
->string
))
6517 int maxlen
= SBYTES (it
->string
) - IT_STRING_BYTEPOS (*it
);
6518 const unsigned char *s
= (SDATA (it
->string
)
6519 + IT_STRING_BYTEPOS (*it
));
6520 it
->c
= string_char_and_length (s
, &it
->len
);
6524 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
6529 /* Record what we have and where it came from. */
6530 it
->what
= IT_CHARACTER
;
6531 it
->object
= it
->string
;
6532 it
->position
= position
;
6537 /* Load IT with next display element from C string IT->s.
6538 IT->string_nchars is the maximum number of characters to return
6539 from the string. IT->end_charpos may be greater than
6540 IT->string_nchars when this function is called, in which case we
6541 may have to return padding spaces. Value is zero if end of string
6542 reached, including padding spaces. */
6545 next_element_from_c_string (struct it
*it
)
6550 it
->what
= IT_CHARACTER
;
6551 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
6554 /* IT's position can be greater IT->string_nchars in case a field
6555 width or precision has been specified when the iterator was
6557 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6559 /* End of the game. */
6563 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
6565 /* Pad with spaces. */
6566 it
->c
= ' ', it
->len
= 1;
6567 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
6569 else if (it
->multibyte_p
)
6571 /* Implementation note: The calls to strlen apparently aren't a
6572 performance problem because there is no noticeable performance
6573 difference between Emacs running in unibyte or multibyte mode. */
6574 int maxlen
= strlen (it
->s
) - IT_BYTEPOS (*it
);
6575 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
6578 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
6584 /* Set up IT to return characters from an ellipsis, if appropriate.
6585 The definition of the ellipsis glyphs may come from a display table
6586 entry. This function fills IT with the first glyph from the
6587 ellipsis if an ellipsis is to be displayed. */
6590 next_element_from_ellipsis (struct it
*it
)
6592 if (it
->selective_display_ellipsis_p
)
6593 setup_for_ellipsis (it
, it
->len
);
6596 /* The face at the current position may be different from the
6597 face we find after the invisible text. Remember what it
6598 was in IT->saved_face_id, and signal that it's there by
6599 setting face_before_selective_p. */
6600 it
->saved_face_id
= it
->face_id
;
6601 it
->method
= GET_FROM_BUFFER
;
6602 it
->object
= it
->w
->buffer
;
6603 reseat_at_next_visible_line_start (it
, 1);
6604 it
->face_before_selective_p
= 1;
6607 return GET_NEXT_DISPLAY_ELEMENT (it
);
6611 /* Deliver an image display element. The iterator IT is already
6612 filled with image information (done in handle_display_prop). Value
6617 next_element_from_image (struct it
*it
)
6619 it
->what
= IT_IMAGE
;
6620 it
->ignore_overlay_strings_at_pos_p
= 0;
6625 /* Fill iterator IT with next display element from a stretch glyph
6626 property. IT->object is the value of the text property. Value is
6630 next_element_from_stretch (struct it
*it
)
6632 it
->what
= IT_STRETCH
;
6636 /* Scan forward from CHARPOS in the current buffer, until we find a
6637 stop position > current IT's position. Then handle the stop
6638 position before that. This is called when we bump into a stop
6639 position while reordering bidirectional text. CHARPOS should be
6640 the last previously processed stop_pos (or BEGV, if none were
6641 processed yet) whose position is less that IT's current
6645 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
6647 EMACS_INT where_we_are
= IT_CHARPOS (*it
);
6648 struct display_pos save_current
= it
->current
;
6649 struct text_pos save_position
= it
->position
;
6650 struct text_pos pos1
;
6651 EMACS_INT next_stop
;
6653 /* Scan in strict logical order. */
6657 it
->prev_stop
= charpos
;
6658 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
6659 reseat_1 (it
, pos1
, 0);
6660 compute_stop_pos (it
);
6661 /* We must advance forward, right? */
6662 if (it
->stop_charpos
<= it
->prev_stop
)
6664 charpos
= it
->stop_charpos
;
6666 while (charpos
<= where_we_are
);
6668 next_stop
= it
->stop_charpos
;
6669 it
->stop_charpos
= it
->prev_stop
;
6671 it
->current
= save_current
;
6672 it
->position
= save_position
;
6674 it
->stop_charpos
= next_stop
;
6677 /* Load IT with the next display element from current_buffer. Value
6678 is zero if end of buffer reached. IT->stop_charpos is the next
6679 position at which to stop and check for text properties or buffer
6683 next_element_from_buffer (struct it
*it
)
6687 xassert (IT_CHARPOS (*it
) >= BEGV
);
6689 /* With bidi reordering, the character to display might not be the
6690 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
6691 we were reseat()ed to a new buffer position, which is potentially
6692 a different paragraph. */
6693 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
6695 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6696 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6697 if (it
->bidi_it
.bytepos
== ZV_BYTE
)
6699 /* Nothing to do, but reset the FIRST_ELT flag, like
6700 bidi_paragraph_init does, because we are not going to
6702 it
->bidi_it
.first_elt
= 0;
6704 else if (it
->bidi_it
.bytepos
== BEGV_BYTE
6705 /* FIXME: Should support all Unicode line separators. */
6706 || FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6707 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')
6709 /* If we are at the beginning of a line, we can produce the
6710 next element right away. */
6711 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6712 bidi_move_to_visually_next (&it
->bidi_it
);
6716 int orig_bytepos
= IT_BYTEPOS (*it
);
6718 /* We need to prime the bidi iterator starting at the line's
6719 beginning, before we will be able to produce the next
6721 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
), -1);
6722 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
6723 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6724 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6725 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6728 /* Now return to buffer position where we were asked to
6729 get the next display element, and produce that. */
6730 bidi_move_to_visually_next (&it
->bidi_it
);
6732 while (it
->bidi_it
.bytepos
!= orig_bytepos
6733 && it
->bidi_it
.bytepos
< ZV_BYTE
);
6736 it
->bidi_it
.first_elt
= 0; /* paranoia: bidi.c does this */
6737 /* Adjust IT's position information to where we ended up. */
6738 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6739 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6740 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
6742 EMACS_INT stop
= it
->stop_charpos
;
6743 if (it
->bidi_it
.scan_dir
< 0)
6745 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6746 IT_BYTEPOS (*it
), stop
, Qnil
);
6750 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
6752 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
6754 int overlay_strings_follow_p
;
6756 /* End of the game, except when overlay strings follow that
6757 haven't been returned yet. */
6758 if (it
->overlay_strings_at_end_processed_p
)
6759 overlay_strings_follow_p
= 0;
6762 it
->overlay_strings_at_end_processed_p
= 1;
6763 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
6766 if (overlay_strings_follow_p
)
6767 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6771 it
->position
= it
->current
.pos
;
6775 else if (!(!it
->bidi_p
6776 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6777 || IT_CHARPOS (*it
) == it
->stop_charpos
))
6779 /* With bidi non-linear iteration, we could find ourselves
6780 far beyond the last computed stop_charpos, with several
6781 other stop positions in between that we missed. Scan
6782 them all now, in buffer's logical order, until we find
6783 and handle the last stop_charpos that precedes our
6784 current position. */
6785 handle_stop_backwards (it
, it
->stop_charpos
);
6786 return GET_NEXT_DISPLAY_ELEMENT (it
);
6792 /* Take note of the stop position we just moved across,
6793 for when we will move back across it. */
6794 it
->prev_stop
= it
->stop_charpos
;
6795 /* If we are at base paragraph embedding level, take
6796 note of the last stop position seen at this
6798 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
6799 it
->base_level_stop
= it
->stop_charpos
;
6802 return GET_NEXT_DISPLAY_ELEMENT (it
);
6806 /* We can sometimes back up for reasons that have nothing
6807 to do with bidi reordering. E.g., compositions. The
6808 code below is only needed when we are above the base
6809 embedding level, so test for that explicitly. */
6810 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
)
6811 && IT_CHARPOS (*it
) < it
->prev_stop
)
6813 if (it
->base_level_stop
<= 0)
6814 it
->base_level_stop
= BEGV
;
6815 if (IT_CHARPOS (*it
) < it
->base_level_stop
)
6817 handle_stop_backwards (it
, it
->base_level_stop
);
6818 return GET_NEXT_DISPLAY_ELEMENT (it
);
6822 /* No face changes, overlays etc. in sight, so just return a
6823 character from current_buffer. */
6827 /* Maybe run the redisplay end trigger hook. Performance note:
6828 This doesn't seem to cost measurable time. */
6829 if (it
->redisplay_end_trigger_charpos
6831 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
6832 run_redisplay_end_trigger_hook (it
);
6834 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
6835 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6837 && next_element_from_composition (it
))
6842 /* Get the next character, maybe multibyte. */
6843 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
6844 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
6845 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
6847 it
->c
= *p
, it
->len
= 1;
6849 /* Record what we have and where it came from. */
6850 it
->what
= IT_CHARACTER
;
6851 it
->object
= it
->w
->buffer
;
6852 it
->position
= it
->current
.pos
;
6854 /* Normally we return the character found above, except when we
6855 really want to return an ellipsis for selective display. */
6860 /* A value of selective > 0 means hide lines indented more
6861 than that number of columns. */
6862 if (it
->selective
> 0
6863 && IT_CHARPOS (*it
) + 1 < ZV
6864 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
6865 IT_BYTEPOS (*it
) + 1,
6866 (double) it
->selective
)) /* iftc */
6868 success_p
= next_element_from_ellipsis (it
);
6869 it
->dpvec_char_len
= -1;
6872 else if (it
->c
== '\r' && it
->selective
== -1)
6874 /* A value of selective == -1 means that everything from the
6875 CR to the end of the line is invisible, with maybe an
6876 ellipsis displayed for it. */
6877 success_p
= next_element_from_ellipsis (it
);
6878 it
->dpvec_char_len
= -1;
6883 /* Value is zero if end of buffer reached. */
6884 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
6889 /* Run the redisplay end trigger hook for IT. */
6892 run_redisplay_end_trigger_hook (struct it
*it
)
6894 Lisp_Object args
[3];
6896 /* IT->glyph_row should be non-null, i.e. we should be actually
6897 displaying something, or otherwise we should not run the hook. */
6898 xassert (it
->glyph_row
);
6900 /* Set up hook arguments. */
6901 args
[0] = Qredisplay_end_trigger_functions
;
6902 args
[1] = it
->window
;
6903 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
6904 it
->redisplay_end_trigger_charpos
= 0;
6906 /* Since we are *trying* to run these functions, don't try to run
6907 them again, even if they get an error. */
6908 it
->w
->redisplay_end_trigger
= Qnil
;
6909 Frun_hook_with_args (3, args
);
6911 /* Notice if it changed the face of the character we are on. */
6912 handle_face_prop (it
);
6916 /* Deliver a composition display element. Unlike the other
6917 next_element_from_XXX, this function is not registered in the array
6918 get_next_element[]. It is called from next_element_from_buffer and
6919 next_element_from_string when necessary. */
6922 next_element_from_composition (struct it
*it
)
6924 it
->what
= IT_COMPOSITION
;
6925 it
->len
= it
->cmp_it
.nbytes
;
6926 if (STRINGP (it
->string
))
6930 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6931 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6934 it
->position
= it
->current
.string_pos
;
6935 it
->object
= it
->string
;
6936 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
6937 IT_STRING_BYTEPOS (*it
), it
->string
);
6943 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6944 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6947 if (it
->bidi_it
.new_paragraph
)
6948 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
);
6949 /* Resync the bidi iterator with IT's new position.
6950 FIXME: this doesn't support bidirectional text. */
6951 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
6952 bidi_move_to_visually_next (&it
->bidi_it
);
6956 it
->position
= it
->current
.pos
;
6957 it
->object
= it
->w
->buffer
;
6958 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
6959 IT_BYTEPOS (*it
), Qnil
);
6966 /***********************************************************************
6967 Moving an iterator without producing glyphs
6968 ***********************************************************************/
6970 /* Check if iterator is at a position corresponding to a valid buffer
6971 position after some move_it_ call. */
6973 #define IT_POS_VALID_AFTER_MOVE_P(it) \
6974 ((it)->method == GET_FROM_STRING \
6975 ? IT_STRING_CHARPOS (*it) == 0 \
6979 /* Move iterator IT to a specified buffer or X position within one
6980 line on the display without producing glyphs.
6982 OP should be a bit mask including some or all of these bits:
6983 MOVE_TO_X: Stop upon reaching x-position TO_X.
6984 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
6985 Regardless of OP's value, stop upon reaching the end of the display line.
6987 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
6988 This means, in particular, that TO_X includes window's horizontal
6991 The return value has several possible values that
6992 say what condition caused the scan to stop:
6994 MOVE_POS_MATCH_OR_ZV
6995 - when TO_POS or ZV was reached.
6998 -when TO_X was reached before TO_POS or ZV were reached.
7001 - when we reached the end of the display area and the line must
7005 - when we reached the end of the display area and the line is
7009 - when we stopped at a line end, i.e. a newline or a CR and selective
7012 static enum move_it_result
7013 move_it_in_display_line_to (struct it
*it
,
7014 EMACS_INT to_charpos
, int to_x
,
7015 enum move_operation_enum op
)
7017 enum move_it_result result
= MOVE_UNDEFINED
;
7018 struct glyph_row
*saved_glyph_row
;
7019 struct it wrap_it
, atpos_it
, atx_it
;
7021 enum it_method prev_method
= it
->method
;
7022 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7024 /* Don't produce glyphs in produce_glyphs. */
7025 saved_glyph_row
= it
->glyph_row
;
7026 it
->glyph_row
= NULL
;
7028 /* Use wrap_it to save a copy of IT wherever a word wrap could
7029 occur. Use atpos_it to save a copy of IT at the desired buffer
7030 position, if found, so that we can scan ahead and check if the
7031 word later overshoots the window edge. Use atx_it similarly, for
7037 #define BUFFER_POS_REACHED_P() \
7038 ((op & MOVE_TO_POS) != 0 \
7039 && BUFFERP (it->object) \
7040 && (IT_CHARPOS (*it) == to_charpos \
7041 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7042 && (it->method == GET_FROM_BUFFER \
7043 || (it->method == GET_FROM_DISPLAY_VECTOR \
7044 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7046 /* If there's a line-/wrap-prefix, handle it. */
7047 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7048 && it
->current_y
< it
->last_visible_y
)
7049 handle_line_prefix (it
);
7053 int x
, i
, ascent
= 0, descent
= 0;
7055 /* Utility macro to reset an iterator with x, ascent, and descent. */
7056 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7057 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7058 (IT)->max_descent = descent)
7060 /* Stop if we move beyond TO_CHARPOS (after an image or stretch
7062 if ((op
& MOVE_TO_POS
) != 0
7063 && BUFFERP (it
->object
)
7064 && it
->method
== GET_FROM_BUFFER
7065 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7067 && (prev_method
== GET_FROM_IMAGE
7068 || prev_method
== GET_FROM_STRETCH
)
7069 /* Passed TO_CHARPOS from left to right. */
7070 && ((prev_pos
< to_charpos
7071 && IT_CHARPOS (*it
) > to_charpos
)
7072 /* Passed TO_CHARPOS from right to left. */
7073 || (prev_pos
> to_charpos
7074 && IT_CHARPOS (*it
) < to_charpos
)))))
7076 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7078 result
= MOVE_POS_MATCH_OR_ZV
;
7081 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7082 /* If wrap_it is valid, the current position might be in a
7083 word that is wrapped. So, save the iterator in
7084 atpos_it and continue to see if wrapping happens. */
7088 prev_method
= it
->method
;
7089 if (it
->method
== GET_FROM_BUFFER
)
7090 prev_pos
= IT_CHARPOS (*it
);
7091 /* Stop when ZV reached.
7092 We used to stop here when TO_CHARPOS reached as well, but that is
7093 too soon if this glyph does not fit on this line. So we handle it
7094 explicitly below. */
7095 if (!get_next_display_element (it
))
7097 result
= MOVE_POS_MATCH_OR_ZV
;
7101 if (it
->line_wrap
== TRUNCATE
)
7103 if (BUFFER_POS_REACHED_P ())
7105 result
= MOVE_POS_MATCH_OR_ZV
;
7111 if (it
->line_wrap
== WORD_WRAP
)
7113 if (IT_DISPLAYING_WHITESPACE (it
))
7117 /* We have reached a glyph that follows one or more
7118 whitespace characters. If the position is
7119 already found, we are done. */
7120 if (atpos_it
.sp
>= 0)
7123 result
= MOVE_POS_MATCH_OR_ZV
;
7129 result
= MOVE_X_REACHED
;
7132 /* Otherwise, we can wrap here. */
7139 /* Remember the line height for the current line, in case
7140 the next element doesn't fit on the line. */
7141 ascent
= it
->max_ascent
;
7142 descent
= it
->max_descent
;
7144 /* The call to produce_glyphs will get the metrics of the
7145 display element IT is loaded with. Record the x-position
7146 before this display element, in case it doesn't fit on the
7150 PRODUCE_GLYPHS (it
);
7152 if (it
->area
!= TEXT_AREA
)
7154 set_iterator_to_next (it
, 1);
7158 /* The number of glyphs we get back in IT->nglyphs will normally
7159 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7160 character on a terminal frame, or (iii) a line end. For the
7161 second case, IT->nglyphs - 1 padding glyphs will be present.
7162 (On X frames, there is only one glyph produced for a
7163 composite character.)
7165 The behavior implemented below means, for continuation lines,
7166 that as many spaces of a TAB as fit on the current line are
7167 displayed there. For terminal frames, as many glyphs of a
7168 multi-glyph character are displayed in the current line, too.
7169 This is what the old redisplay code did, and we keep it that
7170 way. Under X, the whole shape of a complex character must
7171 fit on the line or it will be completely displayed in the
7174 Note that both for tabs and padding glyphs, all glyphs have
7178 /* More than one glyph or glyph doesn't fit on line. All
7179 glyphs have the same width. */
7180 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7182 int x_before_this_char
= x
;
7183 int hpos_before_this_char
= it
->hpos
;
7185 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7187 new_x
= x
+ single_glyph_width
;
7189 /* We want to leave anything reaching TO_X to the caller. */
7190 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7192 if (BUFFER_POS_REACHED_P ())
7194 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7195 goto buffer_pos_reached
;
7196 if (atpos_it
.sp
< 0)
7199 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7204 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7207 result
= MOVE_X_REACHED
;
7213 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7218 if (/* Lines are continued. */
7219 it
->line_wrap
!= TRUNCATE
7220 && (/* And glyph doesn't fit on the line. */
7221 new_x
> it
->last_visible_x
7222 /* Or it fits exactly and we're on a window
7224 || (new_x
== it
->last_visible_x
7225 && FRAME_WINDOW_P (it
->f
))))
7227 if (/* IT->hpos == 0 means the very first glyph
7228 doesn't fit on the line, e.g. a wide image. */
7230 || (new_x
== it
->last_visible_x
7231 && FRAME_WINDOW_P (it
->f
)))
7234 it
->current_x
= new_x
;
7236 /* The character's last glyph just barely fits
7238 if (i
== it
->nglyphs
- 1)
7240 /* If this is the destination position,
7241 return a position *before* it in this row,
7242 now that we know it fits in this row. */
7243 if (BUFFER_POS_REACHED_P ())
7245 if (it
->line_wrap
!= WORD_WRAP
7248 it
->hpos
= hpos_before_this_char
;
7249 it
->current_x
= x_before_this_char
;
7250 result
= MOVE_POS_MATCH_OR_ZV
;
7253 if (it
->line_wrap
== WORD_WRAP
7257 atpos_it
.current_x
= x_before_this_char
;
7258 atpos_it
.hpos
= hpos_before_this_char
;
7262 set_iterator_to_next (it
, 1);
7263 /* On graphical terminals, newlines may
7264 "overflow" into the fringe if
7265 overflow-newline-into-fringe is non-nil.
7266 On text-only terminals, newlines may
7267 overflow into the last glyph on the
7269 if (!FRAME_WINDOW_P (it
->f
)
7270 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7272 if (!get_next_display_element (it
))
7274 result
= MOVE_POS_MATCH_OR_ZV
;
7277 if (BUFFER_POS_REACHED_P ())
7279 if (ITERATOR_AT_END_OF_LINE_P (it
))
7280 result
= MOVE_POS_MATCH_OR_ZV
;
7282 result
= MOVE_LINE_CONTINUED
;
7285 if (ITERATOR_AT_END_OF_LINE_P (it
))
7287 result
= MOVE_NEWLINE_OR_CR
;
7294 IT_RESET_X_ASCENT_DESCENT (it
);
7296 if (wrap_it
.sp
>= 0)
7303 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7305 result
= MOVE_LINE_CONTINUED
;
7309 if (BUFFER_POS_REACHED_P ())
7311 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7312 goto buffer_pos_reached
;
7313 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7316 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7320 if (new_x
> it
->first_visible_x
)
7322 /* Glyph is visible. Increment number of glyphs that
7323 would be displayed. */
7328 if (result
!= MOVE_UNDEFINED
)
7331 else if (BUFFER_POS_REACHED_P ())
7334 IT_RESET_X_ASCENT_DESCENT (it
);
7335 result
= MOVE_POS_MATCH_OR_ZV
;
7338 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
7340 /* Stop when TO_X specified and reached. This check is
7341 necessary here because of lines consisting of a line end,
7342 only. The line end will not produce any glyphs and we
7343 would never get MOVE_X_REACHED. */
7344 xassert (it
->nglyphs
== 0);
7345 result
= MOVE_X_REACHED
;
7349 /* Is this a line end? If yes, we're done. */
7350 if (ITERATOR_AT_END_OF_LINE_P (it
))
7352 result
= MOVE_NEWLINE_OR_CR
;
7356 if (it
->method
== GET_FROM_BUFFER
)
7357 prev_pos
= IT_CHARPOS (*it
);
7358 /* The current display element has been consumed. Advance
7360 set_iterator_to_next (it
, 1);
7362 /* Stop if lines are truncated and IT's current x-position is
7363 past the right edge of the window now. */
7364 if (it
->line_wrap
== TRUNCATE
7365 && it
->current_x
>= it
->last_visible_x
)
7367 if (!FRAME_WINDOW_P (it
->f
)
7368 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7370 if (!get_next_display_element (it
)
7371 || BUFFER_POS_REACHED_P ())
7373 result
= MOVE_POS_MATCH_OR_ZV
;
7376 if (ITERATOR_AT_END_OF_LINE_P (it
))
7378 result
= MOVE_NEWLINE_OR_CR
;
7382 result
= MOVE_LINE_TRUNCATED
;
7385 #undef IT_RESET_X_ASCENT_DESCENT
7388 #undef BUFFER_POS_REACHED_P
7390 /* If we scanned beyond to_pos and didn't find a point to wrap at,
7391 restore the saved iterator. */
7392 if (atpos_it
.sp
>= 0)
7394 else if (atx_it
.sp
>= 0)
7399 /* Restore the iterator settings altered at the beginning of this
7401 it
->glyph_row
= saved_glyph_row
;
7405 /* For external use. */
7407 move_it_in_display_line (struct it
*it
,
7408 EMACS_INT to_charpos
, int to_x
,
7409 enum move_operation_enum op
)
7411 if (it
->line_wrap
== WORD_WRAP
7412 && (op
& MOVE_TO_X
))
7414 struct it save_it
= *it
;
7415 int skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7416 /* When word-wrap is on, TO_X may lie past the end
7417 of a wrapped line. Then it->current is the
7418 character on the next line, so backtrack to the
7419 space before the wrap point. */
7420 if (skip
== MOVE_LINE_CONTINUED
)
7422 int prev_x
= max (it
->current_x
- 1, 0);
7424 move_it_in_display_line_to
7425 (it
, -1, prev_x
, MOVE_TO_X
);
7429 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7433 /* Move IT forward until it satisfies one or more of the criteria in
7434 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
7436 OP is a bit-mask that specifies where to stop, and in particular,
7437 which of those four position arguments makes a difference. See the
7438 description of enum move_operation_enum.
7440 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
7441 screen line, this function will set IT to the next position >
7445 move_it_to (struct it
*it
, int to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
7447 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
7448 int line_height
, line_start_x
= 0, reached
= 0;
7452 if (op
& MOVE_TO_VPOS
)
7454 /* If no TO_CHARPOS and no TO_X specified, stop at the
7455 start of the line TO_VPOS. */
7456 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
7458 if (it
->vpos
== to_vpos
)
7464 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
7468 /* TO_VPOS >= 0 means stop at TO_X in the line at
7469 TO_VPOS, or at TO_POS, whichever comes first. */
7470 if (it
->vpos
== to_vpos
)
7476 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
7478 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
7483 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
7485 /* We have reached TO_X but not in the line we want. */
7486 skip
= move_it_in_display_line_to (it
, to_charpos
,
7488 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7496 else if (op
& MOVE_TO_Y
)
7498 struct it it_backup
;
7500 if (it
->line_wrap
== WORD_WRAP
)
7503 /* TO_Y specified means stop at TO_X in the line containing
7504 TO_Y---or at TO_CHARPOS if this is reached first. The
7505 problem is that we can't really tell whether the line
7506 contains TO_Y before we have completely scanned it, and
7507 this may skip past TO_X. What we do is to first scan to
7510 If TO_X is not specified, use a TO_X of zero. The reason
7511 is to make the outcome of this function more predictable.
7512 If we didn't use TO_X == 0, we would stop at the end of
7513 the line which is probably not what a caller would expect
7515 skip
= move_it_in_display_line_to
7516 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
7517 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
7519 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
7520 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7522 else if (skip
== MOVE_X_REACHED
)
7524 /* If TO_X was reached, we want to know whether TO_Y is
7525 in the line. We know this is the case if the already
7526 scanned glyphs make the line tall enough. Otherwise,
7527 we must check by scanning the rest of the line. */
7528 line_height
= it
->max_ascent
+ it
->max_descent
;
7529 if (to_y
>= it
->current_y
7530 && to_y
< it
->current_y
+ line_height
)
7536 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
7537 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
7539 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
7540 line_height
= it
->max_ascent
+ it
->max_descent
;
7541 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7543 if (to_y
>= it
->current_y
7544 && to_y
< it
->current_y
+ line_height
)
7546 /* If TO_Y is in this line and TO_X was reached
7547 above, we scanned too far. We have to restore
7548 IT's settings to the ones before skipping. */
7555 if (skip
== MOVE_POS_MATCH_OR_ZV
)
7561 /* Check whether TO_Y is in this line. */
7562 line_height
= it
->max_ascent
+ it
->max_descent
;
7563 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
7565 if (to_y
>= it
->current_y
7566 && to_y
< it
->current_y
+ line_height
)
7568 /* When word-wrap is on, TO_X may lie past the end
7569 of a wrapped line. Then it->current is the
7570 character on the next line, so backtrack to the
7571 space before the wrap point. */
7572 if (skip
== MOVE_LINE_CONTINUED
7573 && it
->line_wrap
== WORD_WRAP
)
7575 int prev_x
= max (it
->current_x
- 1, 0);
7577 skip
= move_it_in_display_line_to
7578 (it
, -1, prev_x
, MOVE_TO_X
);
7587 else if (BUFFERP (it
->object
)
7588 && (it
->method
== GET_FROM_BUFFER
7589 || it
->method
== GET_FROM_STRETCH
)
7590 && IT_CHARPOS (*it
) >= to_charpos
)
7591 skip
= MOVE_POS_MATCH_OR_ZV
;
7593 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
7597 case MOVE_POS_MATCH_OR_ZV
:
7601 case MOVE_NEWLINE_OR_CR
:
7602 set_iterator_to_next (it
, 1);
7603 it
->continuation_lines_width
= 0;
7606 case MOVE_LINE_TRUNCATED
:
7607 it
->continuation_lines_width
= 0;
7608 reseat_at_next_visible_line_start (it
, 0);
7609 if ((op
& MOVE_TO_POS
) != 0
7610 && IT_CHARPOS (*it
) > to_charpos
)
7617 case MOVE_LINE_CONTINUED
:
7618 /* For continued lines ending in a tab, some of the glyphs
7619 associated with the tab are displayed on the current
7620 line. Since it->current_x does not include these glyphs,
7621 we use it->last_visible_x instead. */
7624 it
->continuation_lines_width
+= it
->last_visible_x
;
7625 /* When moving by vpos, ensure that the iterator really
7626 advances to the next line (bug#847, bug#969). Fixme:
7627 do we need to do this in other circumstances? */
7628 if (it
->current_x
!= it
->last_visible_x
7629 && (op
& MOVE_TO_VPOS
)
7630 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
7632 line_start_x
= it
->current_x
+ it
->pixel_width
7633 - it
->last_visible_x
;
7634 set_iterator_to_next (it
, 0);
7638 it
->continuation_lines_width
+= it
->current_x
;
7645 /* Reset/increment for the next run. */
7646 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
7647 it
->current_x
= line_start_x
;
7650 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7652 last_height
= it
->max_ascent
+ it
->max_descent
;
7653 last_max_ascent
= it
->max_ascent
;
7654 it
->max_ascent
= it
->max_descent
= 0;
7659 /* On text terminals, we may stop at the end of a line in the middle
7660 of a multi-character glyph. If the glyph itself is continued,
7661 i.e. it is actually displayed on the next line, don't treat this
7662 stopping point as valid; move to the next line instead (unless
7663 that brings us offscreen). */
7664 if (!FRAME_WINDOW_P (it
->f
)
7666 && IT_CHARPOS (*it
) == to_charpos
7667 && it
->what
== IT_CHARACTER
7669 && it
->line_wrap
== WINDOW_WRAP
7670 && it
->current_x
== it
->last_visible_x
- 1
7673 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
7675 it
->continuation_lines_width
+= it
->current_x
;
7676 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
7677 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
7679 last_height
= it
->max_ascent
+ it
->max_descent
;
7680 last_max_ascent
= it
->max_ascent
;
7683 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
7687 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
7689 If DY > 0, move IT backward at least that many pixels. DY = 0
7690 means move IT backward to the preceding line start or BEGV. This
7691 function may move over more than DY pixels if IT->current_y - DY
7692 ends up in the middle of a line; in this case IT->current_y will be
7693 set to the top of the line moved to. */
7696 move_it_vertically_backward (struct it
*it
, int dy
)
7705 start_pos
= IT_CHARPOS (*it
);
7707 /* Estimate how many newlines we must move back. */
7708 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
7710 /* Set the iterator's position that many lines back. */
7711 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
7712 back_to_previous_visible_line_start (it
);
7714 /* Reseat the iterator here. When moving backward, we don't want
7715 reseat to skip forward over invisible text, set up the iterator
7716 to deliver from overlay strings at the new position etc. So,
7717 use reseat_1 here. */
7718 reseat_1 (it
, it
->current
.pos
, 1);
7720 /* We are now surely at a line start. */
7721 it
->current_x
= it
->hpos
= 0;
7722 it
->continuation_lines_width
= 0;
7724 /* Move forward and see what y-distance we moved. First move to the
7725 start of the next line so that we get its height. We need this
7726 height to be able to tell whether we reached the specified
7729 it2
.max_ascent
= it2
.max_descent
= 0;
7732 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
7733 MOVE_TO_POS
| MOVE_TO_VPOS
);
7735 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
7736 xassert (IT_CHARPOS (*it
) >= BEGV
);
7739 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
7740 xassert (IT_CHARPOS (*it
) >= BEGV
);
7741 /* H is the actual vertical distance from the position in *IT
7742 and the starting position. */
7743 h
= it2
.current_y
- it
->current_y
;
7744 /* NLINES is the distance in number of lines. */
7745 nlines
= it2
.vpos
- it
->vpos
;
7747 /* Correct IT's y and vpos position
7748 so that they are relative to the starting point. */
7754 /* DY == 0 means move to the start of the screen line. The
7755 value of nlines is > 0 if continuation lines were involved. */
7757 move_it_by_lines (it
, nlines
, 1);
7761 /* The y-position we try to reach, relative to *IT.
7762 Note that H has been subtracted in front of the if-statement. */
7763 int target_y
= it
->current_y
+ h
- dy
;
7764 int y0
= it3
.current_y
;
7765 int y1
= line_bottom_y (&it3
);
7766 int line_height
= y1
- y0
;
7768 /* If we did not reach target_y, try to move further backward if
7769 we can. If we moved too far backward, try to move forward. */
7770 if (target_y
< it
->current_y
7771 /* This is heuristic. In a window that's 3 lines high, with
7772 a line height of 13 pixels each, recentering with point
7773 on the bottom line will try to move -39/2 = 19 pixels
7774 backward. Try to avoid moving into the first line. */
7775 && (it
->current_y
- target_y
7776 > min (window_box_height (it
->w
), line_height
* 2 / 3))
7777 && IT_CHARPOS (*it
) > BEGV
)
7779 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
7780 target_y
- it
->current_y
));
7781 dy
= it
->current_y
- target_y
;
7782 goto move_further_back
;
7784 else if (target_y
>= it
->current_y
+ line_height
7785 && IT_CHARPOS (*it
) < ZV
)
7787 /* Should move forward by at least one line, maybe more.
7789 Note: Calling move_it_by_lines can be expensive on
7790 terminal frames, where compute_motion is used (via
7791 vmotion) to do the job, when there are very long lines
7792 and truncate-lines is nil. That's the reason for
7793 treating terminal frames specially here. */
7795 if (!FRAME_WINDOW_P (it
->f
))
7796 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
7801 move_it_by_lines (it
, 1, 1);
7803 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
7810 /* Move IT by a specified amount of pixel lines DY. DY negative means
7811 move backwards. DY = 0 means move to start of screen line. At the
7812 end, IT will be on the start of a screen line. */
7815 move_it_vertically (struct it
*it
, int dy
)
7818 move_it_vertically_backward (it
, -dy
);
7821 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
7822 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
7823 MOVE_TO_POS
| MOVE_TO_Y
);
7824 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
7826 /* If buffer ends in ZV without a newline, move to the start of
7827 the line to satisfy the post-condition. */
7828 if (IT_CHARPOS (*it
) == ZV
7830 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
7831 move_it_by_lines (it
, 0, 0);
7836 /* Move iterator IT past the end of the text line it is in. */
7839 move_it_past_eol (struct it
*it
)
7841 enum move_it_result rc
;
7843 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
7844 if (rc
== MOVE_NEWLINE_OR_CR
)
7845 set_iterator_to_next (it
, 0);
7849 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
7850 negative means move up. DVPOS == 0 means move to the start of the
7851 screen line. NEED_Y_P non-zero means calculate IT->current_y. If
7852 NEED_Y_P is zero, IT->current_y will be left unchanged.
7854 Further optimization ideas: If we would know that IT->f doesn't use
7855 a face with proportional font, we could be faster for
7856 truncate-lines nil. */
7859 move_it_by_lines (struct it
*it
, int dvpos
, int need_y_p
)
7861 struct position pos
;
7863 /* The commented-out optimization uses vmotion on terminals. This
7864 gives bad results, because elements like it->what, on which
7865 callers such as pos_visible_p rely, aren't updated. */
7866 /* if (!FRAME_WINDOW_P (it->f))
7868 struct text_pos textpos;
7870 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
7871 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
7872 reseat (it, textpos, 1);
7873 it->vpos += pos.vpos;
7874 it->current_y += pos.vpos;
7880 /* DVPOS == 0 means move to the start of the screen line. */
7881 move_it_vertically_backward (it
, 0);
7882 xassert (it
->current_x
== 0 && it
->hpos
== 0);
7883 /* Let next call to line_bottom_y calculate real line height */
7888 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
7889 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
7890 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
7895 int start_charpos
, i
;
7897 /* Start at the beginning of the screen line containing IT's
7898 position. This may actually move vertically backwards,
7899 in case of overlays, so adjust dvpos accordingly. */
7901 move_it_vertically_backward (it
, 0);
7904 /* Go back -DVPOS visible lines and reseat the iterator there. */
7905 start_charpos
= IT_CHARPOS (*it
);
7906 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
7907 back_to_previous_visible_line_start (it
);
7908 reseat (it
, it
->current
.pos
, 1);
7910 /* Move further back if we end up in a string or an image. */
7911 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
7913 /* First try to move to start of display line. */
7915 move_it_vertically_backward (it
, 0);
7917 if (IT_POS_VALID_AFTER_MOVE_P (it
))
7919 /* If start of line is still in string or image,
7920 move further back. */
7921 back_to_previous_visible_line_start (it
);
7922 reseat (it
, it
->current
.pos
, 1);
7926 it
->current_x
= it
->hpos
= 0;
7928 /* Above call may have moved too far if continuation lines
7929 are involved. Scan forward and see if it did. */
7931 it2
.vpos
= it2
.current_y
= 0;
7932 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
7933 it
->vpos
-= it2
.vpos
;
7934 it
->current_y
-= it2
.current_y
;
7935 it
->current_x
= it
->hpos
= 0;
7937 /* If we moved too far back, move IT some lines forward. */
7938 if (it2
.vpos
> -dvpos
)
7940 int delta
= it2
.vpos
+ dvpos
;
7942 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
7943 /* Move back again if we got too far ahead. */
7944 if (IT_CHARPOS (*it
) >= start_charpos
)
7950 /* Return 1 if IT points into the middle of a display vector. */
7953 in_display_vector_p (struct it
*it
)
7955 return (it
->method
== GET_FROM_DISPLAY_VECTOR
7956 && it
->current
.dpvec_index
> 0
7957 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
7961 /***********************************************************************
7963 ***********************************************************************/
7966 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
7970 add_to_log (char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
7972 Lisp_Object args
[3];
7973 Lisp_Object msg
, fmt
;
7976 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
7979 /* Do nothing if called asynchronously. Inserting text into
7980 a buffer may call after-change-functions and alike and
7981 that would means running Lisp asynchronously. */
7982 if (handling_signal
)
7986 GCPRO4 (fmt
, msg
, arg1
, arg2
);
7988 args
[0] = fmt
= build_string (format
);
7991 msg
= Fformat (3, args
);
7993 len
= SBYTES (msg
) + 1;
7994 SAFE_ALLOCA (buffer
, char *, len
);
7995 memcpy (buffer
, SDATA (msg
), len
);
7997 message_dolog (buffer
, len
- 1, 1, 0);
8004 /* Output a newline in the *Messages* buffer if "needs" one. */
8007 message_log_maybe_newline (void)
8009 if (message_log_need_newline
)
8010 message_dolog ("", 0, 1, 0);
8014 /* Add a string M of length NBYTES to the message log, optionally
8015 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8016 nonzero, means interpret the contents of M as multibyte. This
8017 function calls low-level routines in order to bypass text property
8018 hooks, etc. which might not be safe to run.
8020 This may GC (insert may run before/after change hooks),
8021 so the buffer M must NOT point to a Lisp string. */
8024 message_dolog (const char *m
, int nbytes
, int nlflag
, int multibyte
)
8026 if (!NILP (Vmemory_full
))
8029 if (!NILP (Vmessage_log_max
))
8031 struct buffer
*oldbuf
;
8032 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8033 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8034 int point_at_end
= 0;
8036 Lisp_Object old_deactivate_mark
, tem
;
8037 struct gcpro gcpro1
;
8039 old_deactivate_mark
= Vdeactivate_mark
;
8040 oldbuf
= current_buffer
;
8041 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8042 current_buffer
->undo_list
= Qt
;
8044 oldpoint
= message_dolog_marker1
;
8045 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8046 oldbegv
= message_dolog_marker2
;
8047 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8048 oldzv
= message_dolog_marker3
;
8049 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8050 GCPRO1 (old_deactivate_mark
);
8058 BEGV_BYTE
= BEG_BYTE
;
8061 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8063 /* Insert the string--maybe converting multibyte to single byte
8064 or vice versa, so that all the text fits the buffer. */
8066 && NILP (current_buffer
->enable_multibyte_characters
))
8068 int i
, c
, char_bytes
;
8069 unsigned char work
[1];
8071 /* Convert a multibyte string to single-byte
8072 for the *Message* buffer. */
8073 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8075 c
= string_char_and_length (m
+ i
, &char_bytes
);
8076 work
[0] = (ASCII_CHAR_P (c
)
8078 : multibyte_char_to_unibyte (c
, Qnil
));
8079 insert_1_both (work
, 1, 1, 1, 0, 0);
8082 else if (! multibyte
8083 && ! NILP (current_buffer
->enable_multibyte_characters
))
8085 int i
, c
, char_bytes
;
8086 unsigned char *msg
= (unsigned char *) m
;
8087 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8088 /* Convert a single-byte string to multibyte
8089 for the *Message* buffer. */
8090 for (i
= 0; i
< nbytes
; i
++)
8093 MAKE_CHAR_MULTIBYTE (c
);
8094 char_bytes
= CHAR_STRING (c
, str
);
8095 insert_1_both (str
, 1, char_bytes
, 1, 0, 0);
8099 insert_1 (m
, nbytes
, 1, 0, 0);
8103 int this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
, dup
;
8104 insert_1 ("\n", 1, 1, 0, 0);
8106 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8108 this_bol_byte
= PT_BYTE
;
8110 /* See if this line duplicates the previous one.
8111 If so, combine duplicates. */
8114 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8116 prev_bol_byte
= PT_BYTE
;
8118 dup
= message_log_check_duplicate (prev_bol
, prev_bol_byte
,
8119 this_bol
, this_bol_byte
);
8122 del_range_both (prev_bol
, prev_bol_byte
,
8123 this_bol
, this_bol_byte
, 0);
8129 /* If you change this format, don't forget to also
8130 change message_log_check_duplicate. */
8131 sprintf (dupstr
, " [%d times]", dup
);
8132 duplen
= strlen (dupstr
);
8133 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8134 insert_1 (dupstr
, duplen
, 1, 0, 1);
8139 /* If we have more than the desired maximum number of lines
8140 in the *Messages* buffer now, delete the oldest ones.
8141 This is safe because we don't have undo in this buffer. */
8143 if (NATNUMP (Vmessage_log_max
))
8145 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8146 -XFASTINT (Vmessage_log_max
) - 1, 0);
8147 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8150 BEGV
= XMARKER (oldbegv
)->charpos
;
8151 BEGV_BYTE
= marker_byte_position (oldbegv
);
8160 ZV
= XMARKER (oldzv
)->charpos
;
8161 ZV_BYTE
= marker_byte_position (oldzv
);
8165 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8167 /* We can't do Fgoto_char (oldpoint) because it will run some
8169 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8170 XMARKER (oldpoint
)->bytepos
);
8173 unchain_marker (XMARKER (oldpoint
));
8174 unchain_marker (XMARKER (oldbegv
));
8175 unchain_marker (XMARKER (oldzv
));
8177 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8178 set_buffer_internal (oldbuf
);
8180 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8181 message_log_need_newline
= !nlflag
;
8182 Vdeactivate_mark
= old_deactivate_mark
;
8187 /* We are at the end of the buffer after just having inserted a newline.
8188 (Note: We depend on the fact we won't be crossing the gap.)
8189 Check to see if the most recent message looks a lot like the previous one.
8190 Return 0 if different, 1 if the new one should just replace it, or a
8191 value N > 1 if we should also append " [N times]". */
8194 message_log_check_duplicate (int prev_bol
, int prev_bol_byte
,
8195 int this_bol
, int this_bol_byte
)
8198 int len
= Z_BYTE
- 1 - this_bol_byte
;
8200 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8201 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8203 for (i
= 0; i
< len
; i
++)
8205 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8213 if (*p1
++ == ' ' && *p1
++ == '[')
8216 while (*p1
>= '0' && *p1
<= '9')
8217 n
= n
* 10 + *p1
++ - '0';
8218 if (strncmp (p1
, " times]\n", 8) == 0)
8225 /* Display an echo area message M with a specified length of NBYTES
8226 bytes. The string may include null characters. If M is 0, clear
8227 out any existing message, and let the mini-buffer text show
8230 This may GC, so the buffer M must NOT point to a Lisp string. */
8233 message2 (const char *m
, int nbytes
, int multibyte
)
8235 /* First flush out any partial line written with print. */
8236 message_log_maybe_newline ();
8238 message_dolog (m
, nbytes
, 1, multibyte
);
8239 message2_nolog (m
, nbytes
, multibyte
);
8243 /* The non-logging counterpart of message2. */
8246 message2_nolog (const char *m
, int nbytes
, int multibyte
)
8248 struct frame
*sf
= SELECTED_FRAME ();
8249 message_enable_multibyte
= multibyte
;
8251 if (FRAME_INITIAL_P (sf
))
8253 if (noninteractive_need_newline
)
8254 putc ('\n', stderr
);
8255 noninteractive_need_newline
= 0;
8257 fwrite (m
, nbytes
, 1, stderr
);
8258 if (cursor_in_echo_area
== 0)
8259 fprintf (stderr
, "\n");
8262 /* A null message buffer means that the frame hasn't really been
8263 initialized yet. Error messages get reported properly by
8264 cmd_error, so this must be just an informative message; toss it. */
8265 else if (INTERACTIVE
8266 && sf
->glyphs_initialized_p
8267 && FRAME_MESSAGE_BUF (sf
))
8269 Lisp_Object mini_window
;
8272 /* Get the frame containing the mini-buffer
8273 that the selected frame is using. */
8274 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8275 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8277 FRAME_SAMPLE_VISIBILITY (f
);
8278 if (FRAME_VISIBLE_P (sf
)
8279 && ! FRAME_VISIBLE_P (f
))
8280 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
8284 set_message (m
, Qnil
, nbytes
, multibyte
);
8285 if (minibuffer_auto_raise
)
8286 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8289 clear_message (1, 1);
8291 do_pending_window_change (0);
8292 echo_area_display (1);
8293 do_pending_window_change (0);
8294 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8295 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8300 /* Display an echo area message M with a specified length of NBYTES
8301 bytes. The string may include null characters. If M is not a
8302 string, clear out any existing message, and let the mini-buffer
8305 This function cancels echoing. */
8308 message3 (Lisp_Object m
, int nbytes
, int multibyte
)
8310 struct gcpro gcpro1
;
8313 clear_message (1,1);
8316 /* First flush out any partial line written with print. */
8317 message_log_maybe_newline ();
8323 SAFE_ALLOCA (buffer
, char *, nbytes
);
8324 memcpy (buffer
, SDATA (m
), nbytes
);
8325 message_dolog (buffer
, nbytes
, 1, multibyte
);
8328 message3_nolog (m
, nbytes
, multibyte
);
8334 /* The non-logging version of message3.
8335 This does not cancel echoing, because it is used for echoing.
8336 Perhaps we need to make a separate function for echoing
8337 and make this cancel echoing. */
8340 message3_nolog (Lisp_Object m
, int nbytes
, int multibyte
)
8342 struct frame
*sf
= SELECTED_FRAME ();
8343 message_enable_multibyte
= multibyte
;
8345 if (FRAME_INITIAL_P (sf
))
8347 if (noninteractive_need_newline
)
8348 putc ('\n', stderr
);
8349 noninteractive_need_newline
= 0;
8351 fwrite (SDATA (m
), nbytes
, 1, stderr
);
8352 if (cursor_in_echo_area
== 0)
8353 fprintf (stderr
, "\n");
8356 /* A null message buffer means that the frame hasn't really been
8357 initialized yet. Error messages get reported properly by
8358 cmd_error, so this must be just an informative message; toss it. */
8359 else if (INTERACTIVE
8360 && sf
->glyphs_initialized_p
8361 && FRAME_MESSAGE_BUF (sf
))
8363 Lisp_Object mini_window
;
8367 /* Get the frame containing the mini-buffer
8368 that the selected frame is using. */
8369 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8370 frame
= XWINDOW (mini_window
)->frame
;
8373 FRAME_SAMPLE_VISIBILITY (f
);
8374 if (FRAME_VISIBLE_P (sf
)
8375 && !FRAME_VISIBLE_P (f
))
8376 Fmake_frame_visible (frame
);
8378 if (STRINGP (m
) && SCHARS (m
) > 0)
8380 set_message (NULL
, m
, nbytes
, multibyte
);
8381 if (minibuffer_auto_raise
)
8382 Fraise_frame (frame
);
8383 /* Assume we are not echoing.
8384 (If we are, echo_now will override this.) */
8385 echo_message_buffer
= Qnil
;
8388 clear_message (1, 1);
8390 do_pending_window_change (0);
8391 echo_area_display (1);
8392 do_pending_window_change (0);
8393 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
8394 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
8399 /* Display a null-terminated echo area message M. If M is 0, clear
8400 out any existing message, and let the mini-buffer text show through.
8402 The buffer M must continue to exist until after the echo area gets
8403 cleared or some other message gets displayed there. Do not pass
8404 text that is stored in a Lisp string. Do not pass text in a buffer
8405 that was alloca'd. */
8408 message1 (const char *m
)
8410 message2 (m
, (m
? strlen (m
) : 0), 0);
8414 /* The non-logging counterpart of message1. */
8417 message1_nolog (const char *m
)
8419 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
8422 /* Display a message M which contains a single %s
8423 which gets replaced with STRING. */
8426 message_with_string (const char *m
, Lisp_Object string
, int log
)
8428 CHECK_STRING (string
);
8434 if (noninteractive_need_newline
)
8435 putc ('\n', stderr
);
8436 noninteractive_need_newline
= 0;
8437 fprintf (stderr
, m
, SDATA (string
));
8438 if (!cursor_in_echo_area
)
8439 fprintf (stderr
, "\n");
8443 else if (INTERACTIVE
)
8445 /* The frame whose minibuffer we're going to display the message on.
8446 It may be larger than the selected frame, so we need
8447 to use its buffer, not the selected frame's buffer. */
8448 Lisp_Object mini_window
;
8449 struct frame
*f
, *sf
= SELECTED_FRAME ();
8451 /* Get the frame containing the minibuffer
8452 that the selected frame is using. */
8453 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8454 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8456 /* A null message buffer means that the frame hasn't really been
8457 initialized yet. Error messages get reported properly by
8458 cmd_error, so this must be just an informative message; toss it. */
8459 if (FRAME_MESSAGE_BUF (f
))
8461 Lisp_Object args
[2], message
;
8462 struct gcpro gcpro1
, gcpro2
;
8464 args
[0] = build_string (m
);
8465 args
[1] = message
= string
;
8466 GCPRO2 (args
[0], message
);
8469 message
= Fformat (2, args
);
8472 message3 (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8474 message3_nolog (message
, SBYTES (message
), STRING_MULTIBYTE (message
));
8478 /* Print should start at the beginning of the message
8479 buffer next time. */
8480 message_buf_print
= 0;
8486 /* Dump an informative message to the minibuf. If M is 0, clear out
8487 any existing message, and let the mini-buffer text show through. */
8490 vmessage (const char *m
, va_list ap
)
8496 if (noninteractive_need_newline
)
8497 putc ('\n', stderr
);
8498 noninteractive_need_newline
= 0;
8499 vfprintf (stderr
, m
, ap
);
8500 if (cursor_in_echo_area
== 0)
8501 fprintf (stderr
, "\n");
8505 else if (INTERACTIVE
)
8507 /* The frame whose mini-buffer we're going to display the message
8508 on. It may be larger than the selected frame, so we need to
8509 use its buffer, not the selected frame's buffer. */
8510 Lisp_Object mini_window
;
8511 struct frame
*f
, *sf
= SELECTED_FRAME ();
8513 /* Get the frame containing the mini-buffer
8514 that the selected frame is using. */
8515 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8516 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
8518 /* A null message buffer means that the frame hasn't really been
8519 initialized yet. Error messages get reported properly by
8520 cmd_error, so this must be just an informative message; toss
8522 if (FRAME_MESSAGE_BUF (f
))
8528 len
= doprnt (FRAME_MESSAGE_BUF (f
),
8529 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
8531 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
8536 /* Print should start at the beginning of the message
8537 buffer next time. */
8538 message_buf_print
= 0;
8544 message (const char *m
, ...)
8553 /* The non-logging version of message. */
8556 message_nolog (const char *m
, ...)
8558 Lisp_Object old_log_max
;
8561 old_log_max
= Vmessage_log_max
;
8562 Vmessage_log_max
= Qnil
;
8564 Vmessage_log_max
= old_log_max
;
8569 /* Display the current message in the current mini-buffer. This is
8570 only called from error handlers in process.c, and is not time
8574 update_echo_area (void)
8576 if (!NILP (echo_area_buffer
[0]))
8579 string
= Fcurrent_message ();
8580 message3 (string
, SBYTES (string
),
8581 !NILP (current_buffer
->enable_multibyte_characters
));
8586 /* Make sure echo area buffers in `echo_buffers' are live.
8587 If they aren't, make new ones. */
8590 ensure_echo_area_buffers (void)
8594 for (i
= 0; i
< 2; ++i
)
8595 if (!BUFFERP (echo_buffer
[i
])
8596 || NILP (XBUFFER (echo_buffer
[i
])->name
))
8599 Lisp_Object old_buffer
;
8602 old_buffer
= echo_buffer
[i
];
8603 sprintf (name
, " *Echo Area %d*", i
);
8604 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
8605 XBUFFER (echo_buffer
[i
])->truncate_lines
= Qnil
;
8606 /* to force word wrap in echo area -
8607 it was decided to postpone this*/
8608 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
8610 for (j
= 0; j
< 2; ++j
)
8611 if (EQ (old_buffer
, echo_area_buffer
[j
]))
8612 echo_area_buffer
[j
] = echo_buffer
[i
];
8617 /* Call FN with args A1..A4 with either the current or last displayed
8618 echo_area_buffer as current buffer.
8620 WHICH zero means use the current message buffer
8621 echo_area_buffer[0]. If that is nil, choose a suitable buffer
8622 from echo_buffer[] and clear it.
8624 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
8625 suitable buffer from echo_buffer[] and clear it.
8627 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
8628 that the current message becomes the last displayed one, make
8629 choose a suitable buffer for echo_area_buffer[0], and clear it.
8631 Value is what FN returns. */
8634 with_echo_area_buffer (struct window
*w
, int which
,
8635 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
8636 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8639 int this_one
, the_other
, clear_buffer_p
, rc
;
8640 int count
= SPECPDL_INDEX ();
8642 /* If buffers aren't live, make new ones. */
8643 ensure_echo_area_buffers ();
8648 this_one
= 0, the_other
= 1;
8650 this_one
= 1, the_other
= 0;
8653 this_one
= 0, the_other
= 1;
8656 /* We need a fresh one in case the current echo buffer equals
8657 the one containing the last displayed echo area message. */
8658 if (!NILP (echo_area_buffer
[this_one
])
8659 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
8660 echo_area_buffer
[this_one
] = Qnil
;
8663 /* Choose a suitable buffer from echo_buffer[] is we don't
8665 if (NILP (echo_area_buffer
[this_one
]))
8667 echo_area_buffer
[this_one
]
8668 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
8669 ? echo_buffer
[the_other
]
8670 : echo_buffer
[this_one
]);
8674 buffer
= echo_area_buffer
[this_one
];
8676 /* Don't get confused by reusing the buffer used for echoing
8677 for a different purpose. */
8678 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
8681 record_unwind_protect (unwind_with_echo_area_buffer
,
8682 with_echo_area_buffer_unwind_data (w
));
8684 /* Make the echo area buffer current. Note that for display
8685 purposes, it is not necessary that the displayed window's buffer
8686 == current_buffer, except for text property lookup. So, let's
8687 only set that buffer temporarily here without doing a full
8688 Fset_window_buffer. We must also change w->pointm, though,
8689 because otherwise an assertions in unshow_buffer fails, and Emacs
8691 set_buffer_internal_1 (XBUFFER (buffer
));
8695 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
8698 current_buffer
->undo_list
= Qt
;
8699 current_buffer
->read_only
= Qnil
;
8700 specbind (Qinhibit_read_only
, Qt
);
8701 specbind (Qinhibit_modification_hooks
, Qt
);
8703 if (clear_buffer_p
&& Z
> BEG
)
8706 xassert (BEGV
>= BEG
);
8707 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8709 rc
= fn (a1
, a2
, a3
, a4
);
8711 xassert (BEGV
>= BEG
);
8712 xassert (ZV
<= Z
&& ZV
>= BEGV
);
8714 unbind_to (count
, Qnil
);
8719 /* Save state that should be preserved around the call to the function
8720 FN called in with_echo_area_buffer. */
8723 with_echo_area_buffer_unwind_data (struct window
*w
)
8726 Lisp_Object vector
, tmp
;
8728 /* Reduce consing by keeping one vector in
8729 Vwith_echo_area_save_vector. */
8730 vector
= Vwith_echo_area_save_vector
;
8731 Vwith_echo_area_save_vector
= Qnil
;
8734 vector
= Fmake_vector (make_number (7), Qnil
);
8736 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
8737 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
8738 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
8742 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
8743 ASET (vector
, i
, w
->buffer
); ++i
;
8744 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
8745 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
8750 for (; i
< end
; ++i
)
8751 ASET (vector
, i
, Qnil
);
8754 xassert (i
== ASIZE (vector
));
8759 /* Restore global state from VECTOR which was created by
8760 with_echo_area_buffer_unwind_data. */
8763 unwind_with_echo_area_buffer (Lisp_Object vector
)
8765 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
8766 Vdeactivate_mark
= AREF (vector
, 1);
8767 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
8769 if (WINDOWP (AREF (vector
, 3)))
8772 Lisp_Object buffer
, charpos
, bytepos
;
8774 w
= XWINDOW (AREF (vector
, 3));
8775 buffer
= AREF (vector
, 4);
8776 charpos
= AREF (vector
, 5);
8777 bytepos
= AREF (vector
, 6);
8780 set_marker_both (w
->pointm
, buffer
,
8781 XFASTINT (charpos
), XFASTINT (bytepos
));
8784 Vwith_echo_area_save_vector
= vector
;
8789 /* Set up the echo area for use by print functions. MULTIBYTE_P
8790 non-zero means we will print multibyte. */
8793 setup_echo_area_for_printing (int multibyte_p
)
8795 /* If we can't find an echo area any more, exit. */
8796 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8799 ensure_echo_area_buffers ();
8801 if (!message_buf_print
)
8803 /* A message has been output since the last time we printed.
8804 Choose a fresh echo area buffer. */
8805 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8806 echo_area_buffer
[0] = echo_buffer
[1];
8808 echo_area_buffer
[0] = echo_buffer
[0];
8810 /* Switch to that buffer and clear it. */
8811 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8812 current_buffer
->truncate_lines
= Qnil
;
8816 int count
= SPECPDL_INDEX ();
8817 specbind (Qinhibit_read_only
, Qt
);
8818 /* Note that undo recording is always disabled. */
8820 unbind_to (count
, Qnil
);
8822 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
8824 /* Set up the buffer for the multibyteness we need. */
8826 != !NILP (current_buffer
->enable_multibyte_characters
))
8827 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
8829 /* Raise the frame containing the echo area. */
8830 if (minibuffer_auto_raise
)
8832 struct frame
*sf
= SELECTED_FRAME ();
8833 Lisp_Object mini_window
;
8834 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
8835 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
8838 message_log_maybe_newline ();
8839 message_buf_print
= 1;
8843 if (NILP (echo_area_buffer
[0]))
8845 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
8846 echo_area_buffer
[0] = echo_buffer
[1];
8848 echo_area_buffer
[0] = echo_buffer
[0];
8851 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
8853 /* Someone switched buffers between print requests. */
8854 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
8855 current_buffer
->truncate_lines
= Qnil
;
8861 /* Display an echo area message in window W. Value is non-zero if W's
8862 height is changed. If display_last_displayed_message_p is
8863 non-zero, display the message that was last displayed, otherwise
8864 display the current message. */
8867 display_echo_area (struct window
*w
)
8869 int i
, no_message_p
, window_height_changed_p
, count
;
8871 /* Temporarily disable garbage collections while displaying the echo
8872 area. This is done because a GC can print a message itself.
8873 That message would modify the echo area buffer's contents while a
8874 redisplay of the buffer is going on, and seriously confuse
8876 count
= inhibit_garbage_collection ();
8878 /* If there is no message, we must call display_echo_area_1
8879 nevertheless because it resizes the window. But we will have to
8880 reset the echo_area_buffer in question to nil at the end because
8881 with_echo_area_buffer will sets it to an empty buffer. */
8882 i
= display_last_displayed_message_p
? 1 : 0;
8883 no_message_p
= NILP (echo_area_buffer
[i
]);
8885 window_height_changed_p
8886 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
8887 display_echo_area_1
,
8888 (EMACS_INT
) w
, Qnil
, 0, 0);
8891 echo_area_buffer
[i
] = Qnil
;
8893 unbind_to (count
, Qnil
);
8894 return window_height_changed_p
;
8898 /* Helper for display_echo_area. Display the current buffer which
8899 contains the current echo area message in window W, a mini-window,
8900 a pointer to which is passed in A1. A2..A4 are currently not used.
8901 Change the height of W so that all of the message is displayed.
8902 Value is non-zero if height of W was changed. */
8905 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
8907 struct window
*w
= (struct window
*) a1
;
8909 struct text_pos start
;
8910 int window_height_changed_p
= 0;
8912 /* Do this before displaying, so that we have a large enough glyph
8913 matrix for the display. If we can't get enough space for the
8914 whole text, display the last N lines. That works by setting w->start. */
8915 window_height_changed_p
= resize_mini_window (w
, 0);
8917 /* Use the starting position chosen by resize_mini_window. */
8918 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
8921 clear_glyph_matrix (w
->desired_matrix
);
8922 XSETWINDOW (window
, w
);
8923 try_window (window
, start
, 0);
8925 return window_height_changed_p
;
8929 /* Resize the echo area window to exactly the size needed for the
8930 currently displayed message, if there is one. If a mini-buffer
8931 is active, don't shrink it. */
8934 resize_echo_area_exactly (void)
8936 if (BUFFERP (echo_area_buffer
[0])
8937 && WINDOWP (echo_area_window
))
8939 struct window
*w
= XWINDOW (echo_area_window
);
8941 Lisp_Object resize_exactly
;
8943 if (minibuf_level
== 0)
8944 resize_exactly
= Qt
;
8946 resize_exactly
= Qnil
;
8948 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
8949 (EMACS_INT
) w
, resize_exactly
, 0, 0);
8952 ++windows_or_buffers_changed
;
8953 ++update_mode_lines
;
8954 redisplay_internal (0);
8960 /* Callback function for with_echo_area_buffer, when used from
8961 resize_echo_area_exactly. A1 contains a pointer to the window to
8962 resize, EXACTLY non-nil means resize the mini-window exactly to the
8963 size of the text displayed. A3 and A4 are not used. Value is what
8964 resize_mini_window returns. */
8967 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
8969 return resize_mini_window ((struct window
*) a1
, !NILP (exactly
));
8973 /* Resize mini-window W to fit the size of its contents. EXACT_P
8974 means size the window exactly to the size needed. Otherwise, it's
8975 only enlarged until W's buffer is empty.
8977 Set W->start to the right place to begin display. If the whole
8978 contents fit, start at the beginning. Otherwise, start so as
8979 to make the end of the contents appear. This is particularly
8980 important for y-or-n-p, but seems desirable generally.
8982 Value is non-zero if the window height has been changed. */
8985 resize_mini_window (struct window
*w
, int exact_p
)
8987 struct frame
*f
= XFRAME (w
->frame
);
8988 int window_height_changed_p
= 0;
8990 xassert (MINI_WINDOW_P (w
));
8992 /* By default, start display at the beginning. */
8993 set_marker_both (w
->start
, w
->buffer
,
8994 BUF_BEGV (XBUFFER (w
->buffer
)),
8995 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
8997 /* Don't resize windows while redisplaying a window; it would
8998 confuse redisplay functions when the size of the window they are
8999 displaying changes from under them. Such a resizing can happen,
9000 for instance, when which-func prints a long message while
9001 we are running fontification-functions. We're running these
9002 functions with safe_call which binds inhibit-redisplay to t. */
9003 if (!NILP (Vinhibit_redisplay
))
9006 /* Nil means don't try to resize. */
9007 if (NILP (Vresize_mini_windows
)
9008 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9011 if (!FRAME_MINIBUF_ONLY_P (f
))
9014 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9015 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9016 int height
, max_height
;
9017 int unit
= FRAME_LINE_HEIGHT (f
);
9018 struct text_pos start
;
9019 struct buffer
*old_current_buffer
= NULL
;
9021 if (current_buffer
!= XBUFFER (w
->buffer
))
9023 old_current_buffer
= current_buffer
;
9024 set_buffer_internal (XBUFFER (w
->buffer
));
9027 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9029 /* Compute the max. number of lines specified by the user. */
9030 if (FLOATP (Vmax_mini_window_height
))
9031 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9032 else if (INTEGERP (Vmax_mini_window_height
))
9033 max_height
= XINT (Vmax_mini_window_height
);
9035 max_height
= total_height
/ 4;
9037 /* Correct that max. height if it's bogus. */
9038 max_height
= max (1, max_height
);
9039 max_height
= min (total_height
, max_height
);
9041 /* Find out the height of the text in the window. */
9042 if (it
.line_wrap
== TRUNCATE
)
9047 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9048 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9049 height
= it
.current_y
+ last_height
;
9051 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9052 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9053 height
= (height
+ unit
- 1) / unit
;
9056 /* Compute a suitable window start. */
9057 if (height
> max_height
)
9059 height
= max_height
;
9060 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9061 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9062 start
= it
.current
.pos
;
9065 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9066 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9068 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9070 /* Let it grow only, until we display an empty message, in which
9071 case the window shrinks again. */
9072 if (height
> WINDOW_TOTAL_LINES (w
))
9074 int old_height
= WINDOW_TOTAL_LINES (w
);
9075 freeze_window_starts (f
, 1);
9076 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9077 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9079 else if (height
< WINDOW_TOTAL_LINES (w
)
9080 && (exact_p
|| BEGV
== ZV
))
9082 int old_height
= WINDOW_TOTAL_LINES (w
);
9083 freeze_window_starts (f
, 0);
9084 shrink_mini_window (w
);
9085 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9090 /* Always resize to exact size needed. */
9091 if (height
> WINDOW_TOTAL_LINES (w
))
9093 int old_height
= WINDOW_TOTAL_LINES (w
);
9094 freeze_window_starts (f
, 1);
9095 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9096 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9098 else if (height
< WINDOW_TOTAL_LINES (w
))
9100 int old_height
= WINDOW_TOTAL_LINES (w
);
9101 freeze_window_starts (f
, 0);
9102 shrink_mini_window (w
);
9106 freeze_window_starts (f
, 1);
9107 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9110 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9114 if (old_current_buffer
)
9115 set_buffer_internal (old_current_buffer
);
9118 return window_height_changed_p
;
9122 /* Value is the current message, a string, or nil if there is no
9126 current_message (void)
9130 if (!BUFFERP (echo_area_buffer
[0]))
9134 with_echo_area_buffer (0, 0, current_message_1
,
9135 (EMACS_INT
) &msg
, Qnil
, 0, 0);
9137 echo_area_buffer
[0] = Qnil
;
9145 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9147 Lisp_Object
*msg
= (Lisp_Object
*) a1
;
9150 *msg
= make_buffer_string (BEG
, Z
, 1);
9157 /* Push the current message on Vmessage_stack for later restauration
9158 by restore_message. Value is non-zero if the current message isn't
9159 empty. This is a relatively infrequent operation, so it's not
9160 worth optimizing. */
9166 msg
= current_message ();
9167 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9168 return STRINGP (msg
);
9172 /* Restore message display from the top of Vmessage_stack. */
9175 restore_message (void)
9179 xassert (CONSP (Vmessage_stack
));
9180 msg
= XCAR (Vmessage_stack
);
9182 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9184 message3_nolog (msg
, 0, 0);
9188 /* Handler for record_unwind_protect calling pop_message. */
9191 pop_message_unwind (Lisp_Object dummy
)
9197 /* Pop the top-most entry off Vmessage_stack. */
9202 xassert (CONSP (Vmessage_stack
));
9203 Vmessage_stack
= XCDR (Vmessage_stack
);
9207 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9208 exits. If the stack is not empty, we have a missing pop_message
9212 check_message_stack (void)
9214 if (!NILP (Vmessage_stack
))
9219 /* Truncate to NCHARS what will be displayed in the echo area the next
9220 time we display it---but don't redisplay it now. */
9223 truncate_echo_area (int nchars
)
9226 echo_area_buffer
[0] = Qnil
;
9227 /* A null message buffer means that the frame hasn't really been
9228 initialized yet. Error messages get reported properly by
9229 cmd_error, so this must be just an informative message; toss it. */
9230 else if (!noninteractive
9232 && !NILP (echo_area_buffer
[0]))
9234 struct frame
*sf
= SELECTED_FRAME ();
9235 if (FRAME_MESSAGE_BUF (sf
))
9236 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
9241 /* Helper function for truncate_echo_area. Truncate the current
9242 message to at most NCHARS characters. */
9245 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9247 if (BEG
+ nchars
< Z
)
9248 del_range (BEG
+ nchars
, Z
);
9250 echo_area_buffer
[0] = Qnil
;
9255 /* Set the current message to a substring of S or STRING.
9257 If STRING is a Lisp string, set the message to the first NBYTES
9258 bytes from STRING. NBYTES zero means use the whole string. If
9259 STRING is multibyte, the message will be displayed multibyte.
9261 If S is not null, set the message to the first LEN bytes of S. LEN
9262 zero means use the whole string. MULTIBYTE_P non-zero means S is
9263 multibyte. Display the message multibyte in that case.
9265 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
9266 to t before calling set_message_1 (which calls insert).
9270 set_message (const char *s
, Lisp_Object string
, int nbytes
, int multibyte_p
)
9272 message_enable_multibyte
9273 = ((s
&& multibyte_p
)
9274 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
9276 with_echo_area_buffer (0, -1, set_message_1
,
9277 (EMACS_INT
) s
, string
, nbytes
, multibyte_p
);
9278 message_buf_print
= 0;
9279 help_echo_showing_p
= 0;
9283 /* Helper function for set_message. Arguments have the same meaning
9284 as there, with A1 corresponding to S and A2 corresponding to STRING
9285 This function is called with the echo area buffer being
9289 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
9291 const char *s
= (const char *) a1
;
9292 Lisp_Object string
= a2
;
9294 /* Change multibyteness of the echo buffer appropriately. */
9295 if (message_enable_multibyte
9296 != !NILP (current_buffer
->enable_multibyte_characters
))
9297 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
9299 current_buffer
->truncate_lines
= message_truncate_lines
? Qt
: Qnil
;
9301 /* Insert new message at BEG. */
9302 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9304 if (STRINGP (string
))
9309 nbytes
= SBYTES (string
);
9310 nchars
= string_byte_to_char (string
, nbytes
);
9312 /* This function takes care of single/multibyte conversion. We
9313 just have to ensure that the echo area buffer has the right
9314 setting of enable_multibyte_characters. */
9315 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
9320 nbytes
= strlen (s
);
9322 if (multibyte_p
&& NILP (current_buffer
->enable_multibyte_characters
))
9324 /* Convert from multi-byte to single-byte. */
9326 unsigned char work
[1];
9328 /* Convert a multibyte string to single-byte. */
9329 for (i
= 0; i
< nbytes
; i
+= n
)
9331 c
= string_char_and_length (s
+ i
, &n
);
9332 work
[0] = (ASCII_CHAR_P (c
)
9334 : multibyte_char_to_unibyte (c
, Qnil
));
9335 insert_1_both (work
, 1, 1, 1, 0, 0);
9338 else if (!multibyte_p
9339 && !NILP (current_buffer
->enable_multibyte_characters
))
9341 /* Convert from single-byte to multi-byte. */
9343 const unsigned char *msg
= (const unsigned char *) s
;
9344 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9346 /* Convert a single-byte string to multibyte. */
9347 for (i
= 0; i
< nbytes
; i
++)
9350 MAKE_CHAR_MULTIBYTE (c
);
9351 n
= CHAR_STRING (c
, str
);
9352 insert_1_both (str
, 1, n
, 1, 0, 0);
9356 insert_1 (s
, nbytes
, 1, 0, 0);
9363 /* Clear messages. CURRENT_P non-zero means clear the current
9364 message. LAST_DISPLAYED_P non-zero means clear the message
9368 clear_message (int current_p
, int last_displayed_p
)
9372 echo_area_buffer
[0] = Qnil
;
9373 message_cleared_p
= 1;
9376 if (last_displayed_p
)
9377 echo_area_buffer
[1] = Qnil
;
9379 message_buf_print
= 0;
9382 /* Clear garbaged frames.
9384 This function is used where the old redisplay called
9385 redraw_garbaged_frames which in turn called redraw_frame which in
9386 turn called clear_frame. The call to clear_frame was a source of
9387 flickering. I believe a clear_frame is not necessary. It should
9388 suffice in the new redisplay to invalidate all current matrices,
9389 and ensure a complete redisplay of all windows. */
9392 clear_garbaged_frames (void)
9396 Lisp_Object tail
, frame
;
9397 int changed_count
= 0;
9399 FOR_EACH_FRAME (tail
, frame
)
9401 struct frame
*f
= XFRAME (frame
);
9403 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
9407 Fredraw_frame (frame
);
9408 f
->force_flush_display_p
= 1;
9410 clear_current_matrices (f
);
9419 ++windows_or_buffers_changed
;
9424 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
9425 is non-zero update selected_frame. Value is non-zero if the
9426 mini-windows height has been changed. */
9429 echo_area_display (int update_frame_p
)
9431 Lisp_Object mini_window
;
9434 int window_height_changed_p
= 0;
9435 struct frame
*sf
= SELECTED_FRAME ();
9437 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9438 w
= XWINDOW (mini_window
);
9439 f
= XFRAME (WINDOW_FRAME (w
));
9441 /* Don't display if frame is invisible or not yet initialized. */
9442 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
9445 #ifdef HAVE_WINDOW_SYSTEM
9446 /* When Emacs starts, selected_frame may be the initial terminal
9447 frame. If we let this through, a message would be displayed on
9449 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
9451 #endif /* HAVE_WINDOW_SYSTEM */
9453 /* Redraw garbaged frames. */
9455 clear_garbaged_frames ();
9457 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
9459 echo_area_window
= mini_window
;
9460 window_height_changed_p
= display_echo_area (w
);
9461 w
->must_be_updated_p
= 1;
9463 /* Update the display, unless called from redisplay_internal.
9464 Also don't update the screen during redisplay itself. The
9465 update will happen at the end of redisplay, and an update
9466 here could cause confusion. */
9467 if (update_frame_p
&& !redisplaying_p
)
9471 /* If the display update has been interrupted by pending
9472 input, update mode lines in the frame. Due to the
9473 pending input, it might have been that redisplay hasn't
9474 been called, so that mode lines above the echo area are
9475 garbaged. This looks odd, so we prevent it here. */
9476 if (!display_completed
)
9477 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
9479 if (window_height_changed_p
9480 /* Don't do this if Emacs is shutting down. Redisplay
9481 needs to run hooks. */
9482 && !NILP (Vrun_hooks
))
9484 /* Must update other windows. Likewise as in other
9485 cases, don't let this update be interrupted by
9487 int count
= SPECPDL_INDEX ();
9488 specbind (Qredisplay_dont_pause
, Qt
);
9489 windows_or_buffers_changed
= 1;
9490 redisplay_internal (0);
9491 unbind_to (count
, Qnil
);
9493 else if (FRAME_WINDOW_P (f
) && n
== 0)
9495 /* Window configuration is the same as before.
9496 Can do with a display update of the echo area,
9497 unless we displayed some mode lines. */
9498 update_single_window (w
, 1);
9499 FRAME_RIF (f
)->flush_display (f
);
9502 update_frame (f
, 1, 1);
9504 /* If cursor is in the echo area, make sure that the next
9505 redisplay displays the minibuffer, so that the cursor will
9506 be replaced with what the minibuffer wants. */
9507 if (cursor_in_echo_area
)
9508 ++windows_or_buffers_changed
;
9511 else if (!EQ (mini_window
, selected_window
))
9512 windows_or_buffers_changed
++;
9514 /* Last displayed message is now the current message. */
9515 echo_area_buffer
[1] = echo_area_buffer
[0];
9516 /* Inform read_char that we're not echoing. */
9517 echo_message_buffer
= Qnil
;
9519 /* Prevent redisplay optimization in redisplay_internal by resetting
9520 this_line_start_pos. This is done because the mini-buffer now
9521 displays the message instead of its buffer text. */
9522 if (EQ (mini_window
, selected_window
))
9523 CHARPOS (this_line_start_pos
) = 0;
9525 return window_height_changed_p
;
9530 /***********************************************************************
9531 Mode Lines and Frame Titles
9532 ***********************************************************************/
9534 /* A buffer for constructing non-propertized mode-line strings and
9535 frame titles in it; allocated from the heap in init_xdisp and
9536 resized as needed in store_mode_line_noprop_char. */
9538 static char *mode_line_noprop_buf
;
9540 /* The buffer's end, and a current output position in it. */
9542 static char *mode_line_noprop_buf_end
;
9543 static char *mode_line_noprop_ptr
;
9545 #define MODE_LINE_NOPROP_LEN(start) \
9546 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
9549 MODE_LINE_DISPLAY
= 0,
9555 /* Alist that caches the results of :propertize.
9556 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
9557 static Lisp_Object mode_line_proptrans_alist
;
9559 /* List of strings making up the mode-line. */
9560 static Lisp_Object mode_line_string_list
;
9562 /* Base face property when building propertized mode line string. */
9563 static Lisp_Object mode_line_string_face
;
9564 static Lisp_Object mode_line_string_face_prop
;
9567 /* Unwind data for mode line strings */
9569 static Lisp_Object Vmode_line_unwind_vector
;
9572 format_mode_line_unwind_data (struct buffer
*obuf
,
9576 Lisp_Object vector
, tmp
;
9578 /* Reduce consing by keeping one vector in
9579 Vwith_echo_area_save_vector. */
9580 vector
= Vmode_line_unwind_vector
;
9581 Vmode_line_unwind_vector
= Qnil
;
9584 vector
= Fmake_vector (make_number (8), Qnil
);
9586 ASET (vector
, 0, make_number (mode_line_target
));
9587 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
9588 ASET (vector
, 2, mode_line_string_list
);
9589 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
9590 ASET (vector
, 4, mode_line_string_face
);
9591 ASET (vector
, 5, mode_line_string_face_prop
);
9594 XSETBUFFER (tmp
, obuf
);
9597 ASET (vector
, 6, tmp
);
9598 ASET (vector
, 7, owin
);
9604 unwind_format_mode_line (Lisp_Object vector
)
9606 mode_line_target
= XINT (AREF (vector
, 0));
9607 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
9608 mode_line_string_list
= AREF (vector
, 2);
9609 if (! EQ (AREF (vector
, 3), Qt
))
9610 mode_line_proptrans_alist
= AREF (vector
, 3);
9611 mode_line_string_face
= AREF (vector
, 4);
9612 mode_line_string_face_prop
= AREF (vector
, 5);
9614 if (!NILP (AREF (vector
, 7)))
9615 /* Select window before buffer, since it may change the buffer. */
9616 Fselect_window (AREF (vector
, 7), Qt
);
9618 if (!NILP (AREF (vector
, 6)))
9620 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
9621 ASET (vector
, 6, Qnil
);
9624 Vmode_line_unwind_vector
= vector
;
9629 /* Store a single character C for the frame title in mode_line_noprop_buf.
9630 Re-allocate mode_line_noprop_buf if necessary. */
9633 store_mode_line_noprop_char (char c
)
9635 /* If output position has reached the end of the allocated buffer,
9636 double the buffer's size. */
9637 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
9639 int len
= MODE_LINE_NOPROP_LEN (0);
9640 int new_size
= 2 * len
* sizeof *mode_line_noprop_buf
;
9641 mode_line_noprop_buf
= (char *) xrealloc (mode_line_noprop_buf
, new_size
);
9642 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ new_size
;
9643 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
9646 *mode_line_noprop_ptr
++ = c
;
9650 /* Store part of a frame title in mode_line_noprop_buf, beginning at
9651 mode_line_noprop_ptr. STR is the string to store. Do not copy
9652 characters that yield more columns than PRECISION; PRECISION <= 0
9653 means copy the whole string. Pad with spaces until FIELD_WIDTH
9654 number of characters have been copied; FIELD_WIDTH <= 0 means don't
9655 pad. Called from display_mode_element when it is used to build a
9659 store_mode_line_noprop (const unsigned char *str
, int field_width
, int precision
)
9664 /* Copy at most PRECISION chars from STR. */
9665 nbytes
= strlen (str
);
9666 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
9668 store_mode_line_noprop_char (*str
++);
9670 /* Fill up with spaces until FIELD_WIDTH reached. */
9671 while (field_width
> 0
9674 store_mode_line_noprop_char (' ');
9681 /***********************************************************************
9683 ***********************************************************************/
9685 #ifdef HAVE_WINDOW_SYSTEM
9687 /* Set the title of FRAME, if it has changed. The title format is
9688 Vicon_title_format if FRAME is iconified, otherwise it is
9689 frame_title_format. */
9692 x_consider_frame_title (Lisp_Object frame
)
9694 struct frame
*f
= XFRAME (frame
);
9696 if (FRAME_WINDOW_P (f
)
9697 || FRAME_MINIBUF_ONLY_P (f
)
9698 || f
->explicit_name
)
9700 /* Do we have more than one visible frame on this X display? */
9707 int count
= SPECPDL_INDEX ();
9709 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
9711 Lisp_Object other_frame
= XCAR (tail
);
9712 struct frame
*tf
= XFRAME (other_frame
);
9715 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
9716 && !FRAME_MINIBUF_ONLY_P (tf
)
9717 && !EQ (other_frame
, tip_frame
)
9718 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
9722 /* Set global variable indicating that multiple frames exist. */
9723 multiple_frames
= CONSP (tail
);
9725 /* Switch to the buffer of selected window of the frame. Set up
9726 mode_line_target so that display_mode_element will output into
9727 mode_line_noprop_buf; then display the title. */
9728 record_unwind_protect (unwind_format_mode_line
,
9729 format_mode_line_unwind_data
9730 (current_buffer
, selected_window
, 0));
9732 Fselect_window (f
->selected_window
, Qt
);
9733 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
9734 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
9736 mode_line_target
= MODE_LINE_TITLE
;
9737 title_start
= MODE_LINE_NOPROP_LEN (0);
9738 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
9739 NULL
, DEFAULT_FACE_ID
);
9740 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
9741 len
= MODE_LINE_NOPROP_LEN (title_start
);
9742 title
= mode_line_noprop_buf
+ title_start
;
9743 unbind_to (count
, Qnil
);
9745 /* Set the title only if it's changed. This avoids consing in
9746 the common case where it hasn't. (If it turns out that we've
9747 already wasted too much time by walking through the list with
9748 display_mode_element, then we might need to optimize at a
9749 higher level than this.) */
9750 if (! STRINGP (f
->name
)
9751 || SBYTES (f
->name
) != len
9752 || memcmp (title
, SDATA (f
->name
), len
) != 0)
9753 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
9757 #endif /* not HAVE_WINDOW_SYSTEM */
9762 /***********************************************************************
9764 ***********************************************************************/
9767 /* Prepare for redisplay by updating menu-bar item lists when
9768 appropriate. This can call eval. */
9771 prepare_menu_bars (void)
9774 struct gcpro gcpro1
, gcpro2
;
9776 Lisp_Object tooltip_frame
;
9778 #ifdef HAVE_WINDOW_SYSTEM
9779 tooltip_frame
= tip_frame
;
9781 tooltip_frame
= Qnil
;
9784 /* Update all frame titles based on their buffer names, etc. We do
9785 this before the menu bars so that the buffer-menu will show the
9786 up-to-date frame titles. */
9787 #ifdef HAVE_WINDOW_SYSTEM
9788 if (windows_or_buffers_changed
|| update_mode_lines
)
9790 Lisp_Object tail
, frame
;
9792 FOR_EACH_FRAME (tail
, frame
)
9795 if (!EQ (frame
, tooltip_frame
)
9796 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
9797 x_consider_frame_title (frame
);
9800 #endif /* HAVE_WINDOW_SYSTEM */
9802 /* Update the menu bar item lists, if appropriate. This has to be
9803 done before any actual redisplay or generation of display lines. */
9804 all_windows
= (update_mode_lines
9805 || buffer_shared
> 1
9806 || windows_or_buffers_changed
);
9809 Lisp_Object tail
, frame
;
9810 int count
= SPECPDL_INDEX ();
9811 /* 1 means that update_menu_bar has run its hooks
9812 so any further calls to update_menu_bar shouldn't do so again. */
9813 int menu_bar_hooks_run
= 0;
9815 record_unwind_save_match_data ();
9817 FOR_EACH_FRAME (tail
, frame
)
9821 /* Ignore tooltip frame. */
9822 if (EQ (frame
, tooltip_frame
))
9825 /* If a window on this frame changed size, report that to
9826 the user and clear the size-change flag. */
9827 if (FRAME_WINDOW_SIZES_CHANGED (f
))
9829 Lisp_Object functions
;
9831 /* Clear flag first in case we get an error below. */
9832 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
9833 functions
= Vwindow_size_change_functions
;
9834 GCPRO2 (tail
, functions
);
9836 while (CONSP (functions
))
9838 if (!EQ (XCAR (functions
), Qt
))
9839 call1 (XCAR (functions
), frame
);
9840 functions
= XCDR (functions
);
9846 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
9847 #ifdef HAVE_WINDOW_SYSTEM
9848 update_tool_bar (f
, 0);
9851 if (windows_or_buffers_changed
9853 ns_set_doc_edited (f
, Fbuffer_modified_p
9854 (XWINDOW (f
->selected_window
)->buffer
));
9859 unbind_to (count
, Qnil
);
9863 struct frame
*sf
= SELECTED_FRAME ();
9864 update_menu_bar (sf
, 1, 0);
9865 #ifdef HAVE_WINDOW_SYSTEM
9866 update_tool_bar (sf
, 1);
9870 /* Motif needs this. See comment in xmenu.c. Turn it off when
9871 pending_menu_activation is not defined. */
9872 #ifdef USE_X_TOOLKIT
9873 pending_menu_activation
= 0;
9878 /* Update the menu bar item list for frame F. This has to be done
9879 before we start to fill in any display lines, because it can call
9882 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
9884 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
9885 already ran the menu bar hooks for this redisplay, so there
9886 is no need to run them again. The return value is the
9887 updated value of this flag, to pass to the next call. */
9890 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
9893 register struct window
*w
;
9895 /* If called recursively during a menu update, do nothing. This can
9896 happen when, for instance, an activate-menubar-hook causes a
9898 if (inhibit_menubar_update
)
9901 window
= FRAME_SELECTED_WINDOW (f
);
9902 w
= XWINDOW (window
);
9904 if (FRAME_WINDOW_P (f
)
9906 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9907 || defined (HAVE_NS) || defined (USE_GTK)
9908 FRAME_EXTERNAL_MENU_BAR (f
)
9910 FRAME_MENU_BAR_LINES (f
) > 0
9912 : FRAME_MENU_BAR_LINES (f
) > 0)
9914 /* If the user has switched buffers or windows, we need to
9915 recompute to reflect the new bindings. But we'll
9916 recompute when update_mode_lines is set too; that means
9917 that people can use force-mode-line-update to request
9918 that the menu bar be recomputed. The adverse effect on
9919 the rest of the redisplay algorithm is about the same as
9920 windows_or_buffers_changed anyway. */
9921 if (windows_or_buffers_changed
9922 /* This used to test w->update_mode_line, but we believe
9923 there is no need to recompute the menu in that case. */
9924 || update_mode_lines
9925 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
9926 < BUF_MODIFF (XBUFFER (w
->buffer
)))
9927 != !NILP (w
->last_had_star
))
9928 || ((!NILP (Vtransient_mark_mode
)
9929 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
9930 != !NILP (w
->region_showing
)))
9932 struct buffer
*prev
= current_buffer
;
9933 int count
= SPECPDL_INDEX ();
9935 specbind (Qinhibit_menubar_update
, Qt
);
9937 set_buffer_internal_1 (XBUFFER (w
->buffer
));
9938 if (save_match_data
)
9939 record_unwind_save_match_data ();
9940 if (NILP (Voverriding_local_map_menu_flag
))
9942 specbind (Qoverriding_terminal_local_map
, Qnil
);
9943 specbind (Qoverriding_local_map
, Qnil
);
9948 /* Run the Lucid hook. */
9949 safe_run_hooks (Qactivate_menubar_hook
);
9951 /* If it has changed current-menubar from previous value,
9952 really recompute the menu-bar from the value. */
9953 if (! NILP (Vlucid_menu_bar_dirty_flag
))
9954 call0 (Qrecompute_lucid_menubar
);
9956 safe_run_hooks (Qmenu_bar_update_hook
);
9961 XSETFRAME (Vmenu_updating_frame
, f
);
9962 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
9964 /* Redisplay the menu bar in case we changed it. */
9965 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
9966 || defined (HAVE_NS) || defined (USE_GTK)
9967 if (FRAME_WINDOW_P (f
))
9969 #if defined (HAVE_NS)
9970 /* All frames on Mac OS share the same menubar. So only
9971 the selected frame should be allowed to set it. */
9972 if (f
== SELECTED_FRAME ())
9974 set_frame_menubar (f
, 0, 0);
9977 /* On a terminal screen, the menu bar is an ordinary screen
9978 line, and this makes it get updated. */
9979 w
->update_mode_line
= Qt
;
9980 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9981 /* In the non-toolkit version, the menu bar is an ordinary screen
9982 line, and this makes it get updated. */
9983 w
->update_mode_line
= Qt
;
9984 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
9986 unbind_to (count
, Qnil
);
9987 set_buffer_internal_1 (prev
);
9996 /***********************************************************************
9998 ***********************************************************************/
10000 #ifdef HAVE_WINDOW_SYSTEM
10003 Nominal cursor position -- where to draw output.
10004 HPOS and VPOS are window relative glyph matrix coordinates.
10005 X and Y are window relative pixel coordinates. */
10007 struct cursor_pos output_cursor
;
10011 Set the global variable output_cursor to CURSOR. All cursor
10012 positions are relative to updated_window. */
10015 set_output_cursor (struct cursor_pos
*cursor
)
10017 output_cursor
.hpos
= cursor
->hpos
;
10018 output_cursor
.vpos
= cursor
->vpos
;
10019 output_cursor
.x
= cursor
->x
;
10020 output_cursor
.y
= cursor
->y
;
10025 Set a nominal cursor position.
10027 HPOS and VPOS are column/row positions in a window glyph matrix. X
10028 and Y are window text area relative pixel positions.
10030 If this is done during an update, updated_window will contain the
10031 window that is being updated and the position is the future output
10032 cursor position for that window. If updated_window is null, use
10033 selected_window and display the cursor at the given position. */
10036 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10040 /* If updated_window is not set, work on selected_window. */
10041 if (updated_window
)
10042 w
= updated_window
;
10044 w
= XWINDOW (selected_window
);
10046 /* Set the output cursor. */
10047 output_cursor
.hpos
= hpos
;
10048 output_cursor
.vpos
= vpos
;
10049 output_cursor
.x
= x
;
10050 output_cursor
.y
= y
;
10052 /* If not called as part of an update, really display the cursor.
10053 This will also set the cursor position of W. */
10054 if (updated_window
== NULL
)
10057 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10058 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10059 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10064 #endif /* HAVE_WINDOW_SYSTEM */
10067 /***********************************************************************
10069 ***********************************************************************/
10071 #ifdef HAVE_WINDOW_SYSTEM
10073 /* Where the mouse was last time we reported a mouse event. */
10075 FRAME_PTR last_mouse_frame
;
10077 /* Tool-bar item index of the item on which a mouse button was pressed
10080 int last_tool_bar_item
;
10084 update_tool_bar_unwind (Lisp_Object frame
)
10086 selected_frame
= frame
;
10090 /* Update the tool-bar item list for frame F. This has to be done
10091 before we start to fill in any display lines. Called from
10092 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10093 and restore it here. */
10096 update_tool_bar (struct frame
*f
, int save_match_data
)
10098 #if defined (USE_GTK) || defined (HAVE_NS)
10099 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10101 int do_update
= WINDOWP (f
->tool_bar_window
)
10102 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10107 Lisp_Object window
;
10110 window
= FRAME_SELECTED_WINDOW (f
);
10111 w
= XWINDOW (window
);
10113 /* If the user has switched buffers or windows, we need to
10114 recompute to reflect the new bindings. But we'll
10115 recompute when update_mode_lines is set too; that means
10116 that people can use force-mode-line-update to request
10117 that the menu bar be recomputed. The adverse effect on
10118 the rest of the redisplay algorithm is about the same as
10119 windows_or_buffers_changed anyway. */
10120 if (windows_or_buffers_changed
10121 || !NILP (w
->update_mode_line
)
10122 || update_mode_lines
10123 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10124 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10125 != !NILP (w
->last_had_star
))
10126 || ((!NILP (Vtransient_mark_mode
)
10127 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
10128 != !NILP (w
->region_showing
)))
10130 struct buffer
*prev
= current_buffer
;
10131 int count
= SPECPDL_INDEX ();
10132 Lisp_Object frame
, new_tool_bar
;
10133 int new_n_tool_bar
;
10134 struct gcpro gcpro1
;
10136 /* Set current_buffer to the buffer of the selected
10137 window of the frame, so that we get the right local
10139 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10141 /* Save match data, if we must. */
10142 if (save_match_data
)
10143 record_unwind_save_match_data ();
10145 /* Make sure that we don't accidentally use bogus keymaps. */
10146 if (NILP (Voverriding_local_map_menu_flag
))
10148 specbind (Qoverriding_terminal_local_map
, Qnil
);
10149 specbind (Qoverriding_local_map
, Qnil
);
10152 GCPRO1 (new_tool_bar
);
10154 /* We must temporarily set the selected frame to this frame
10155 before calling tool_bar_items, because the calculation of
10156 the tool-bar keymap uses the selected frame (see
10157 `tool-bar-make-keymap' in tool-bar.el). */
10158 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10159 XSETFRAME (frame
, f
);
10160 selected_frame
= frame
;
10162 /* Build desired tool-bar items from keymaps. */
10163 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10166 /* Redisplay the tool-bar if we changed it. */
10167 if (new_n_tool_bar
!= f
->n_tool_bar_items
10168 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10170 /* Redisplay that happens asynchronously due to an expose event
10171 may access f->tool_bar_items. Make sure we update both
10172 variables within BLOCK_INPUT so no such event interrupts. */
10174 f
->tool_bar_items
= new_tool_bar
;
10175 f
->n_tool_bar_items
= new_n_tool_bar
;
10176 w
->update_mode_line
= Qt
;
10182 unbind_to (count
, Qnil
);
10183 set_buffer_internal_1 (prev
);
10189 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10190 F's desired tool-bar contents. F->tool_bar_items must have
10191 been set up previously by calling prepare_menu_bars. */
10194 build_desired_tool_bar_string (struct frame
*f
)
10196 int i
, size
, size_needed
;
10197 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10198 Lisp_Object image
, plist
, props
;
10200 image
= plist
= props
= Qnil
;
10201 GCPRO3 (image
, plist
, props
);
10203 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10204 Otherwise, make a new string. */
10206 /* The size of the string we might be able to reuse. */
10207 size
= (STRINGP (f
->desired_tool_bar_string
)
10208 ? SCHARS (f
->desired_tool_bar_string
)
10211 /* We need one space in the string for each image. */
10212 size_needed
= f
->n_tool_bar_items
;
10214 /* Reuse f->desired_tool_bar_string, if possible. */
10215 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10216 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10217 make_number (' '));
10220 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10221 Fremove_text_properties (make_number (0), make_number (size
),
10222 props
, f
->desired_tool_bar_string
);
10225 /* Put a `display' property on the string for the images to display,
10226 put a `menu_item' property on tool-bar items with a value that
10227 is the index of the item in F's tool-bar item vector. */
10228 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
10230 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
10232 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
10233 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
10234 int hmargin
, vmargin
, relief
, idx
, end
;
10235 extern Lisp_Object QCrelief
, QCmargin
, QCconversion
;
10237 /* If image is a vector, choose the image according to the
10239 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
10240 if (VECTORP (image
))
10244 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
10245 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
10248 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
10249 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
10251 xassert (ASIZE (image
) >= idx
);
10252 image
= AREF (image
, idx
);
10257 /* Ignore invalid image specifications. */
10258 if (!valid_image_p (image
))
10261 /* Display the tool-bar button pressed, or depressed. */
10262 plist
= Fcopy_sequence (XCDR (image
));
10264 /* Compute margin and relief to draw. */
10265 relief
= (tool_bar_button_relief
>= 0
10266 ? tool_bar_button_relief
10267 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
10268 hmargin
= vmargin
= relief
;
10270 if (INTEGERP (Vtool_bar_button_margin
)
10271 && XINT (Vtool_bar_button_margin
) > 0)
10273 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
10274 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
10276 else if (CONSP (Vtool_bar_button_margin
))
10278 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
10279 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
10280 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
10282 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
10283 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
10284 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
10287 if (auto_raise_tool_bar_buttons_p
)
10289 /* Add a `:relief' property to the image spec if the item is
10293 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
10300 /* If image is selected, display it pressed, i.e. with a
10301 negative relief. If it's not selected, display it with a
10303 plist
= Fplist_put (plist
, QCrelief
,
10305 ? make_number (-relief
)
10306 : make_number (relief
)));
10311 /* Put a margin around the image. */
10312 if (hmargin
|| vmargin
)
10314 if (hmargin
== vmargin
)
10315 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
10317 plist
= Fplist_put (plist
, QCmargin
,
10318 Fcons (make_number (hmargin
),
10319 make_number (vmargin
)));
10322 /* If button is not enabled, and we don't have special images
10323 for the disabled state, make the image appear disabled by
10324 applying an appropriate algorithm to it. */
10325 if (!enabled_p
&& idx
< 0)
10326 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
10328 /* Put a `display' text property on the string for the image to
10329 display. Put a `menu-item' property on the string that gives
10330 the start of this item's properties in the tool-bar items
10332 image
= Fcons (Qimage
, plist
);
10333 props
= list4 (Qdisplay
, image
,
10334 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
10336 /* Let the last image hide all remaining spaces in the tool bar
10337 string. The string can be longer than needed when we reuse a
10338 previous string. */
10339 if (i
+ 1 == f
->n_tool_bar_items
)
10340 end
= SCHARS (f
->desired_tool_bar_string
);
10343 Fadd_text_properties (make_number (i
), make_number (end
),
10344 props
, f
->desired_tool_bar_string
);
10352 /* Display one line of the tool-bar of frame IT->f.
10354 HEIGHT specifies the desired height of the tool-bar line.
10355 If the actual height of the glyph row is less than HEIGHT, the
10356 row's height is increased to HEIGHT, and the icons are centered
10357 vertically in the new height.
10359 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
10360 count a final empty row in case the tool-bar width exactly matches
10365 display_tool_bar_line (struct it
*it
, int height
)
10367 struct glyph_row
*row
= it
->glyph_row
;
10368 int max_x
= it
->last_visible_x
;
10369 struct glyph
*last
;
10371 prepare_desired_row (row
);
10372 row
->y
= it
->current_y
;
10374 /* Note that this isn't made use of if the face hasn't a box,
10375 so there's no need to check the face here. */
10376 it
->start_of_box_run_p
= 1;
10378 while (it
->current_x
< max_x
)
10380 int x
, n_glyphs_before
, i
, nglyphs
;
10381 struct it it_before
;
10383 /* Get the next display element. */
10384 if (!get_next_display_element (it
))
10386 /* Don't count empty row if we are counting needed tool-bar lines. */
10387 if (height
< 0 && !it
->hpos
)
10392 /* Produce glyphs. */
10393 n_glyphs_before
= row
->used
[TEXT_AREA
];
10396 PRODUCE_GLYPHS (it
);
10398 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
10400 x
= it_before
.current_x
;
10401 while (i
< nglyphs
)
10403 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
10405 if (x
+ glyph
->pixel_width
> max_x
)
10407 /* Glyph doesn't fit on line. Backtrack. */
10408 row
->used
[TEXT_AREA
] = n_glyphs_before
;
10410 /* If this is the only glyph on this line, it will never fit on the
10411 toolbar, so skip it. But ensure there is at least one glyph,
10412 so we don't accidentally disable the tool-bar. */
10413 if (n_glyphs_before
== 0
10414 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
10420 x
+= glyph
->pixel_width
;
10424 /* Stop at line ends. */
10425 if (ITERATOR_AT_END_OF_LINE_P (it
))
10428 set_iterator_to_next (it
, 1);
10433 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
10435 /* Use default face for the border below the tool bar.
10437 FIXME: When auto-resize-tool-bars is grow-only, there is
10438 no additional border below the possibly empty tool-bar lines.
10439 So to make the extra empty lines look "normal", we have to
10440 use the tool-bar face for the border too. */
10441 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
10442 it
->face_id
= DEFAULT_FACE_ID
;
10444 extend_face_to_end_of_line (it
);
10445 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
10446 last
->right_box_line_p
= 1;
10447 if (last
== row
->glyphs
[TEXT_AREA
])
10448 last
->left_box_line_p
= 1;
10450 /* Make line the desired height and center it vertically. */
10451 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
10453 /* Don't add more than one line height. */
10454 height
%= FRAME_LINE_HEIGHT (it
->f
);
10455 it
->max_ascent
+= height
/ 2;
10456 it
->max_descent
+= (height
+ 1) / 2;
10459 compute_line_metrics (it
);
10461 /* If line is empty, make it occupy the rest of the tool-bar. */
10462 if (!row
->displays_text_p
)
10464 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
10465 row
->visible_height
= row
->height
;
10466 row
->ascent
= row
->phys_ascent
= 0;
10467 row
->extra_line_spacing
= 0;
10470 row
->full_width_p
= 1;
10471 row
->continued_p
= 0;
10472 row
->truncated_on_left_p
= 0;
10473 row
->truncated_on_right_p
= 0;
10475 it
->current_x
= it
->hpos
= 0;
10476 it
->current_y
+= row
->height
;
10482 /* Max tool-bar height. */
10484 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
10485 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
10487 /* Value is the number of screen lines needed to make all tool-bar
10488 items of frame F visible. The number of actual rows needed is
10489 returned in *N_ROWS if non-NULL. */
10492 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
10494 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10496 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
10497 the desired matrix, so use (unused) mode-line row as temporary row to
10498 avoid destroying the first tool-bar row. */
10499 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
10501 /* Initialize an iterator for iteration over
10502 F->desired_tool_bar_string in the tool-bar window of frame F. */
10503 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
10504 it
.first_visible_x
= 0;
10505 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10506 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10508 while (!ITERATOR_AT_END_P (&it
))
10510 clear_glyph_row (temp_row
);
10511 it
.glyph_row
= temp_row
;
10512 display_tool_bar_line (&it
, -1);
10514 clear_glyph_row (temp_row
);
10516 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
10518 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
10520 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
10524 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
10526 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
10527 (Lisp_Object frame
)
10534 frame
= selected_frame
;
10536 CHECK_FRAME (frame
);
10537 f
= XFRAME (frame
);
10539 if (WINDOWP (f
->tool_bar_window
)
10540 || (w
= XWINDOW (f
->tool_bar_window
),
10541 WINDOW_TOTAL_LINES (w
) > 0))
10543 update_tool_bar (f
, 1);
10544 if (f
->n_tool_bar_items
)
10546 build_desired_tool_bar_string (f
);
10547 nlines
= tool_bar_lines_needed (f
, NULL
);
10551 return make_number (nlines
);
10555 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
10556 height should be changed. */
10559 redisplay_tool_bar (struct frame
*f
)
10563 struct glyph_row
*row
;
10565 #if defined (USE_GTK) || defined (HAVE_NS)
10566 if (FRAME_EXTERNAL_TOOL_BAR (f
))
10567 update_frame_tool_bar (f
);
10571 /* If frame hasn't a tool-bar window or if it is zero-height, don't
10572 do anything. This means you must start with tool-bar-lines
10573 non-zero to get the auto-sizing effect. Or in other words, you
10574 can turn off tool-bars by specifying tool-bar-lines zero. */
10575 if (!WINDOWP (f
->tool_bar_window
)
10576 || (w
= XWINDOW (f
->tool_bar_window
),
10577 WINDOW_TOTAL_LINES (w
) == 0))
10580 /* Set up an iterator for the tool-bar window. */
10581 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
10582 it
.first_visible_x
= 0;
10583 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
10584 row
= it
.glyph_row
;
10586 /* Build a string that represents the contents of the tool-bar. */
10587 build_desired_tool_bar_string (f
);
10588 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
10590 if (f
->n_tool_bar_rows
== 0)
10594 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
10595 nlines
!= WINDOW_TOTAL_LINES (w
)))
10597 extern Lisp_Object Qtool_bar_lines
;
10599 int old_height
= WINDOW_TOTAL_LINES (w
);
10601 XSETFRAME (frame
, f
);
10602 Fmodify_frame_parameters (frame
,
10603 Fcons (Fcons (Qtool_bar_lines
,
10604 make_number (nlines
)),
10606 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10608 clear_glyph_matrix (w
->desired_matrix
);
10609 fonts_changed_p
= 1;
10615 /* Display as many lines as needed to display all tool-bar items. */
10617 if (f
->n_tool_bar_rows
> 0)
10619 int border
, rows
, height
, extra
;
10621 if (INTEGERP (Vtool_bar_border
))
10622 border
= XINT (Vtool_bar_border
);
10623 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
10624 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
10625 else if (EQ (Vtool_bar_border
, Qborder_width
))
10626 border
= f
->border_width
;
10632 rows
= f
->n_tool_bar_rows
;
10633 height
= max (1, (it
.last_visible_y
- border
) / rows
);
10634 extra
= it
.last_visible_y
- border
- height
* rows
;
10636 while (it
.current_y
< it
.last_visible_y
)
10639 if (extra
> 0 && rows
-- > 0)
10641 h
= (extra
+ rows
- 1) / rows
;
10644 display_tool_bar_line (&it
, height
+ h
);
10649 while (it
.current_y
< it
.last_visible_y
)
10650 display_tool_bar_line (&it
, 0);
10653 /* It doesn't make much sense to try scrolling in the tool-bar
10654 window, so don't do it. */
10655 w
->desired_matrix
->no_scrolling_p
= 1;
10656 w
->must_be_updated_p
= 1;
10658 if (!NILP (Vauto_resize_tool_bars
))
10660 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
10661 int change_height_p
= 0;
10663 /* If we couldn't display everything, change the tool-bar's
10664 height if there is room for more. */
10665 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
10666 && it
.current_y
< max_tool_bar_height
)
10667 change_height_p
= 1;
10669 row
= it
.glyph_row
- 1;
10671 /* If there are blank lines at the end, except for a partially
10672 visible blank line at the end that is smaller than
10673 FRAME_LINE_HEIGHT, change the tool-bar's height. */
10674 if (!row
->displays_text_p
10675 && row
->height
>= FRAME_LINE_HEIGHT (f
))
10676 change_height_p
= 1;
10678 /* If row displays tool-bar items, but is partially visible,
10679 change the tool-bar's height. */
10680 if (row
->displays_text_p
10681 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
10682 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
10683 change_height_p
= 1;
10685 /* Resize windows as needed by changing the `tool-bar-lines'
10686 frame parameter. */
10687 if (change_height_p
)
10689 extern Lisp_Object Qtool_bar_lines
;
10691 int old_height
= WINDOW_TOTAL_LINES (w
);
10693 int nlines
= tool_bar_lines_needed (f
, &nrows
);
10695 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
10696 && !f
->minimize_tool_bar_window_p
)
10697 ? (nlines
> old_height
)
10698 : (nlines
!= old_height
));
10699 f
->minimize_tool_bar_window_p
= 0;
10701 if (change_height_p
)
10703 XSETFRAME (frame
, f
);
10704 Fmodify_frame_parameters (frame
,
10705 Fcons (Fcons (Qtool_bar_lines
,
10706 make_number (nlines
)),
10708 if (WINDOW_TOTAL_LINES (w
) != old_height
)
10710 clear_glyph_matrix (w
->desired_matrix
);
10711 f
->n_tool_bar_rows
= nrows
;
10712 fonts_changed_p
= 1;
10719 f
->minimize_tool_bar_window_p
= 0;
10724 /* Get information about the tool-bar item which is displayed in GLYPH
10725 on frame F. Return in *PROP_IDX the index where tool-bar item
10726 properties start in F->tool_bar_items. Value is zero if
10727 GLYPH doesn't display a tool-bar item. */
10730 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
10736 /* This function can be called asynchronously, which means we must
10737 exclude any possibility that Fget_text_property signals an
10739 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
10740 charpos
= max (0, charpos
);
10742 /* Get the text property `menu-item' at pos. The value of that
10743 property is the start index of this item's properties in
10744 F->tool_bar_items. */
10745 prop
= Fget_text_property (make_number (charpos
),
10746 Qmenu_item
, f
->current_tool_bar_string
);
10747 if (INTEGERP (prop
))
10749 *prop_idx
= XINT (prop
);
10759 /* Get information about the tool-bar item at position X/Y on frame F.
10760 Return in *GLYPH a pointer to the glyph of the tool-bar item in
10761 the current matrix of the tool-bar window of F, or NULL if not
10762 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
10763 item in F->tool_bar_items. Value is
10765 -1 if X/Y is not on a tool-bar item
10766 0 if X/Y is on the same item that was highlighted before.
10770 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
10771 int *hpos
, int *vpos
, int *prop_idx
)
10773 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10774 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10777 /* Find the glyph under X/Y. */
10778 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
10779 if (*glyph
== NULL
)
10782 /* Get the start of this tool-bar item's properties in
10783 f->tool_bar_items. */
10784 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
10787 /* Is mouse on the highlighted item? */
10788 if (EQ (f
->tool_bar_window
, dpyinfo
->mouse_face_window
)
10789 && *vpos
>= dpyinfo
->mouse_face_beg_row
10790 && *vpos
<= dpyinfo
->mouse_face_end_row
10791 && (*vpos
> dpyinfo
->mouse_face_beg_row
10792 || *hpos
>= dpyinfo
->mouse_face_beg_col
)
10793 && (*vpos
< dpyinfo
->mouse_face_end_row
10794 || *hpos
< dpyinfo
->mouse_face_end_col
10795 || dpyinfo
->mouse_face_past_end
))
10803 Handle mouse button event on the tool-bar of frame F, at
10804 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
10805 0 for button release. MODIFIERS is event modifiers for button
10809 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
10810 unsigned int modifiers
)
10812 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10813 struct window
*w
= XWINDOW (f
->tool_bar_window
);
10814 int hpos
, vpos
, prop_idx
;
10815 struct glyph
*glyph
;
10816 Lisp_Object enabled_p
;
10818 /* If not on the highlighted tool-bar item, return. */
10819 frame_to_window_pixel_xy (w
, &x
, &y
);
10820 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
10823 /* If item is disabled, do nothing. */
10824 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10825 if (NILP (enabled_p
))
10830 /* Show item in pressed state. */
10831 show_mouse_face (dpyinfo
, DRAW_IMAGE_SUNKEN
);
10832 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
10833 last_tool_bar_item
= prop_idx
;
10837 Lisp_Object key
, frame
;
10838 struct input_event event
;
10839 EVENT_INIT (event
);
10841 /* Show item in released state. */
10842 show_mouse_face (dpyinfo
, DRAW_IMAGE_RAISED
);
10843 dpyinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
10845 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
10847 XSETFRAME (frame
, f
);
10848 event
.kind
= TOOL_BAR_EVENT
;
10849 event
.frame_or_window
= frame
;
10851 kbd_buffer_store_event (&event
);
10853 event
.kind
= TOOL_BAR_EVENT
;
10854 event
.frame_or_window
= frame
;
10856 event
.modifiers
= modifiers
;
10857 kbd_buffer_store_event (&event
);
10858 last_tool_bar_item
= -1;
10863 /* Possibly highlight a tool-bar item on frame F when mouse moves to
10864 tool-bar window-relative coordinates X/Y. Called from
10865 note_mouse_highlight. */
10868 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
10870 Lisp_Object window
= f
->tool_bar_window
;
10871 struct window
*w
= XWINDOW (window
);
10872 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
10874 struct glyph
*glyph
;
10875 struct glyph_row
*row
;
10877 Lisp_Object enabled_p
;
10879 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
10880 int mouse_down_p
, rc
;
10882 /* Function note_mouse_highlight is called with negative x(y
10883 values when mouse moves outside of the frame. */
10884 if (x
<= 0 || y
<= 0)
10886 clear_mouse_face (dpyinfo
);
10890 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
10893 /* Not on tool-bar item. */
10894 clear_mouse_face (dpyinfo
);
10898 /* On same tool-bar item as before. */
10899 goto set_help_echo
;
10901 clear_mouse_face (dpyinfo
);
10903 /* Mouse is down, but on different tool-bar item? */
10904 mouse_down_p
= (dpyinfo
->grabbed
10905 && f
== last_mouse_frame
10906 && FRAME_LIVE_P (f
));
10908 && last_tool_bar_item
!= prop_idx
)
10911 dpyinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
10912 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
10914 /* If tool-bar item is not enabled, don't highlight it. */
10915 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
10916 if (!NILP (enabled_p
))
10918 /* Compute the x-position of the glyph. In front and past the
10919 image is a space. We include this in the highlighted area. */
10920 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
10921 for (i
= x
= 0; i
< hpos
; ++i
)
10922 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
10924 /* Record this as the current active region. */
10925 dpyinfo
->mouse_face_beg_col
= hpos
;
10926 dpyinfo
->mouse_face_beg_row
= vpos
;
10927 dpyinfo
->mouse_face_beg_x
= x
;
10928 dpyinfo
->mouse_face_beg_y
= row
->y
;
10929 dpyinfo
->mouse_face_past_end
= 0;
10931 dpyinfo
->mouse_face_end_col
= hpos
+ 1;
10932 dpyinfo
->mouse_face_end_row
= vpos
;
10933 dpyinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
10934 dpyinfo
->mouse_face_end_y
= row
->y
;
10935 dpyinfo
->mouse_face_window
= window
;
10936 dpyinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
10938 /* Display it as active. */
10939 show_mouse_face (dpyinfo
, draw
);
10940 dpyinfo
->mouse_face_image_state
= draw
;
10945 /* Set help_echo_string to a help string to display for this tool-bar item.
10946 XTread_socket does the rest. */
10947 help_echo_object
= help_echo_window
= Qnil
;
10948 help_echo_pos
= -1;
10949 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
10950 if (NILP (help_echo_string
))
10951 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
10954 #endif /* HAVE_WINDOW_SYSTEM */
10958 /************************************************************************
10959 Horizontal scrolling
10960 ************************************************************************/
10962 static int hscroll_window_tree (Lisp_Object
);
10963 static int hscroll_windows (Lisp_Object
);
10965 /* For all leaf windows in the window tree rooted at WINDOW, set their
10966 hscroll value so that PT is (i) visible in the window, and (ii) so
10967 that it is not within a certain margin at the window's left and
10968 right border. Value is non-zero if any window's hscroll has been
10972 hscroll_window_tree (Lisp_Object window
)
10974 int hscrolled_p
= 0;
10975 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
10976 int hscroll_step_abs
= 0;
10977 double hscroll_step_rel
= 0;
10979 if (hscroll_relative_p
)
10981 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
10982 if (hscroll_step_rel
< 0)
10984 hscroll_relative_p
= 0;
10985 hscroll_step_abs
= 0;
10988 else if (INTEGERP (Vhscroll_step
))
10990 hscroll_step_abs
= XINT (Vhscroll_step
);
10991 if (hscroll_step_abs
< 0)
10992 hscroll_step_abs
= 0;
10995 hscroll_step_abs
= 0;
10997 while (WINDOWP (window
))
10999 struct window
*w
= XWINDOW (window
);
11001 if (WINDOWP (w
->hchild
))
11002 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11003 else if (WINDOWP (w
->vchild
))
11004 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11005 else if (w
->cursor
.vpos
>= 0)
11008 int text_area_width
;
11009 struct glyph_row
*current_cursor_row
11010 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11011 struct glyph_row
*desired_cursor_row
11012 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11013 struct glyph_row
*cursor_row
11014 = (desired_cursor_row
->enabled_p
11015 ? desired_cursor_row
11016 : current_cursor_row
);
11018 text_area_width
= window_box_width (w
, TEXT_AREA
);
11020 /* Scroll when cursor is inside this scroll margin. */
11021 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11023 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11024 && ((XFASTINT (w
->hscroll
)
11025 && w
->cursor
.x
<= h_margin
)
11026 || (cursor_row
->enabled_p
11027 && cursor_row
->truncated_on_right_p
11028 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11032 struct buffer
*saved_current_buffer
;
11036 /* Find point in a display of infinite width. */
11037 saved_current_buffer
= current_buffer
;
11038 current_buffer
= XBUFFER (w
->buffer
);
11040 if (w
== XWINDOW (selected_window
))
11041 pt
= BUF_PT (current_buffer
);
11044 pt
= marker_position (w
->pointm
);
11045 pt
= max (BEGV
, pt
);
11049 /* Move iterator to pt starting at cursor_row->start in
11050 a line with infinite width. */
11051 init_to_row_start (&it
, w
, cursor_row
);
11052 it
.last_visible_x
= INFINITY
;
11053 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11054 current_buffer
= saved_current_buffer
;
11056 /* Position cursor in window. */
11057 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11058 hscroll
= max (0, (it
.current_x
11059 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11060 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11061 : (text_area_width
/ 2))))
11062 / FRAME_COLUMN_WIDTH (it
.f
);
11063 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11065 if (hscroll_relative_p
)
11066 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11069 wanted_x
= text_area_width
11070 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11073 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11077 if (hscroll_relative_p
)
11078 wanted_x
= text_area_width
* hscroll_step_rel
11081 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11084 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11086 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11088 /* Don't call Fset_window_hscroll if value hasn't
11089 changed because it will prevent redisplay
11091 if (XFASTINT (w
->hscroll
) != hscroll
)
11093 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11094 w
->hscroll
= make_number (hscroll
);
11103 /* Value is non-zero if hscroll of any leaf window has been changed. */
11104 return hscrolled_p
;
11108 /* Set hscroll so that cursor is visible and not inside horizontal
11109 scroll margins for all windows in the tree rooted at WINDOW. See
11110 also hscroll_window_tree above. Value is non-zero if any window's
11111 hscroll has been changed. If it has, desired matrices on the frame
11112 of WINDOW are cleared. */
11115 hscroll_windows (Lisp_Object window
)
11117 int hscrolled_p
= hscroll_window_tree (window
);
11119 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11120 return hscrolled_p
;
11125 /************************************************************************
11127 ************************************************************************/
11129 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11130 to a non-zero value. This is sometimes handy to have in a debugger
11135 /* First and last unchanged row for try_window_id. */
11137 int debug_first_unchanged_at_end_vpos
;
11138 int debug_last_unchanged_at_beg_vpos
;
11140 /* Delta vpos and y. */
11142 int debug_dvpos
, debug_dy
;
11144 /* Delta in characters and bytes for try_window_id. */
11146 int debug_delta
, debug_delta_bytes
;
11148 /* Values of window_end_pos and window_end_vpos at the end of
11151 EMACS_INT debug_end_pos
, debug_end_vpos
;
11153 /* Append a string to W->desired_matrix->method. FMT is a printf
11154 format string. A1...A9 are a supplement for a variable-length
11155 argument list. If trace_redisplay_p is non-zero also printf the
11156 resulting string to stderr. */
11159 debug_method_add (w
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
)
11162 int a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
;
11165 char *method
= w
->desired_matrix
->method
;
11166 int len
= strlen (method
);
11167 int size
= sizeof w
->desired_matrix
->method
;
11168 int remaining
= size
- len
- 1;
11170 sprintf (buffer
, fmt
, a1
, a2
, a3
, a4
, a5
, a6
, a7
, a8
, a9
);
11171 if (len
&& remaining
)
11174 --remaining
, ++len
;
11177 strncpy (method
+ len
, buffer
, remaining
);
11179 if (trace_redisplay_p
)
11180 fprintf (stderr
, "%p (%s): %s\n",
11182 ((BUFFERP (w
->buffer
)
11183 && STRINGP (XBUFFER (w
->buffer
)->name
))
11184 ? (char *) SDATA (XBUFFER (w
->buffer
)->name
)
11189 #endif /* GLYPH_DEBUG */
11192 /* Value is non-zero if all changes in window W, which displays
11193 current_buffer, are in the text between START and END. START is a
11194 buffer position, END is given as a distance from Z. Used in
11195 redisplay_internal for display optimization. */
11198 text_outside_line_unchanged_p (struct window
*w
, int start
, int end
)
11200 int unchanged_p
= 1;
11202 /* If text or overlays have changed, see where. */
11203 if (XFASTINT (w
->last_modified
) < MODIFF
11204 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11206 /* Gap in the line? */
11207 if (GPT
< start
|| Z
- GPT
< end
)
11210 /* Changes start in front of the line, or end after it? */
11212 && (BEG_UNCHANGED
< start
- 1
11213 || END_UNCHANGED
< end
))
11216 /* If selective display, can't optimize if changes start at the
11217 beginning of the line. */
11219 && INTEGERP (current_buffer
->selective_display
)
11220 && XINT (current_buffer
->selective_display
) > 0
11221 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
11224 /* If there are overlays at the start or end of the line, these
11225 may have overlay strings with newlines in them. A change at
11226 START, for instance, may actually concern the display of such
11227 overlay strings as well, and they are displayed on different
11228 lines. So, quickly rule out this case. (For the future, it
11229 might be desirable to implement something more telling than
11230 just BEG/END_UNCHANGED.) */
11233 if (BEG
+ BEG_UNCHANGED
== start
11234 && overlay_touches_p (start
))
11236 if (END_UNCHANGED
== end
11237 && overlay_touches_p (Z
- end
))
11241 /* Under bidi reordering, adding or deleting a character in the
11242 beginning of a paragraph, before the first strong directional
11243 character, can change the base direction of the paragraph (unless
11244 the buffer specifies a fixed paragraph direction), which will
11245 require to redisplay the whole paragraph. It might be worthwhile
11246 to find the paragraph limits and widen the range of redisplayed
11247 lines to that, but for now just give up this optimization. */
11248 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
11249 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
11253 return unchanged_p
;
11257 /* Do a frame update, taking possible shortcuts into account. This is
11258 the main external entry point for redisplay.
11260 If the last redisplay displayed an echo area message and that message
11261 is no longer requested, we clear the echo area or bring back the
11262 mini-buffer if that is in use. */
11267 redisplay_internal (0);
11272 overlay_arrow_string_or_property (Lisp_Object var
)
11276 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
11279 return Voverlay_arrow_string
;
11282 /* Return 1 if there are any overlay-arrows in current_buffer. */
11284 overlay_arrow_in_current_buffer_p (void)
11288 for (vlist
= Voverlay_arrow_variable_list
;
11290 vlist
= XCDR (vlist
))
11292 Lisp_Object var
= XCAR (vlist
);
11295 if (!SYMBOLP (var
))
11297 val
= find_symbol_value (var
);
11299 && current_buffer
== XMARKER (val
)->buffer
)
11306 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
11310 overlay_arrows_changed_p (void)
11314 for (vlist
= Voverlay_arrow_variable_list
;
11316 vlist
= XCDR (vlist
))
11318 Lisp_Object var
= XCAR (vlist
);
11319 Lisp_Object val
, pstr
;
11321 if (!SYMBOLP (var
))
11323 val
= find_symbol_value (var
);
11324 if (!MARKERP (val
))
11326 if (! EQ (COERCE_MARKER (val
),
11327 Fget (var
, Qlast_arrow_position
))
11328 || ! (pstr
= overlay_arrow_string_or_property (var
),
11329 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
11335 /* Mark overlay arrows to be updated on next redisplay. */
11338 update_overlay_arrows (int up_to_date
)
11342 for (vlist
= Voverlay_arrow_variable_list
;
11344 vlist
= XCDR (vlist
))
11346 Lisp_Object var
= XCAR (vlist
);
11348 if (!SYMBOLP (var
))
11351 if (up_to_date
> 0)
11353 Lisp_Object val
= find_symbol_value (var
);
11354 Fput (var
, Qlast_arrow_position
,
11355 COERCE_MARKER (val
));
11356 Fput (var
, Qlast_arrow_string
,
11357 overlay_arrow_string_or_property (var
));
11359 else if (up_to_date
< 0
11360 || !NILP (Fget (var
, Qlast_arrow_position
)))
11362 Fput (var
, Qlast_arrow_position
, Qt
);
11363 Fput (var
, Qlast_arrow_string
, Qt
);
11369 /* Return overlay arrow string to display at row.
11370 Return integer (bitmap number) for arrow bitmap in left fringe.
11371 Return nil if no overlay arrow. */
11374 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
11378 for (vlist
= Voverlay_arrow_variable_list
;
11380 vlist
= XCDR (vlist
))
11382 Lisp_Object var
= XCAR (vlist
);
11385 if (!SYMBOLP (var
))
11388 val
= find_symbol_value (var
);
11391 && current_buffer
== XMARKER (val
)->buffer
11392 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
11394 if (FRAME_WINDOW_P (it
->f
)
11395 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
11397 #ifdef HAVE_WINDOW_SYSTEM
11398 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
11401 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
11402 return make_number (fringe_bitmap
);
11405 return make_number (-1); /* Use default arrow bitmap */
11407 return overlay_arrow_string_or_property (var
);
11414 /* Return 1 if point moved out of or into a composition. Otherwise
11415 return 0. PREV_BUF and PREV_PT are the last point buffer and
11416 position. BUF and PT are the current point buffer and position. */
11419 check_point_in_composition (struct buffer
*prev_buf
, int prev_pt
,
11420 struct buffer
*buf
, int pt
)
11422 EMACS_INT start
, end
;
11424 Lisp_Object buffer
;
11426 XSETBUFFER (buffer
, buf
);
11427 /* Check a composition at the last point if point moved within the
11429 if (prev_buf
== buf
)
11432 /* Point didn't move. */
11435 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
11436 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
11437 && COMPOSITION_VALID_P (start
, end
, prop
)
11438 && start
< prev_pt
&& end
> prev_pt
)
11439 /* The last point was within the composition. Return 1 iff
11440 point moved out of the composition. */
11441 return (pt
<= start
|| pt
>= end
);
11444 /* Check a composition at the current point. */
11445 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
11446 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
11447 && COMPOSITION_VALID_P (start
, end
, prop
)
11448 && start
< pt
&& end
> pt
);
11452 /* Reconsider the setting of B->clip_changed which is displayed
11456 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
11458 if (b
->clip_changed
11459 && !NILP (w
->window_end_valid
)
11460 && w
->current_matrix
->buffer
== b
11461 && w
->current_matrix
->zv
== BUF_ZV (b
)
11462 && w
->current_matrix
->begv
== BUF_BEGV (b
))
11463 b
->clip_changed
= 0;
11465 /* If display wasn't paused, and W is not a tool bar window, see if
11466 point has been moved into or out of a composition. In that case,
11467 we set b->clip_changed to 1 to force updating the screen. If
11468 b->clip_changed has already been set to 1, we can skip this
11470 if (!b
->clip_changed
11471 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
11475 if (w
== XWINDOW (selected_window
))
11476 pt
= BUF_PT (current_buffer
);
11478 pt
= marker_position (w
->pointm
);
11480 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
11481 || pt
!= XINT (w
->last_point
))
11482 && check_point_in_composition (w
->current_matrix
->buffer
,
11483 XINT (w
->last_point
),
11484 XBUFFER (w
->buffer
), pt
))
11485 b
->clip_changed
= 1;
11490 /* Select FRAME to forward the values of frame-local variables into C
11491 variables so that the redisplay routines can access those values
11495 select_frame_for_redisplay (Lisp_Object frame
)
11497 Lisp_Object tail
, tem
;
11498 Lisp_Object old
= selected_frame
;
11499 struct Lisp_Symbol
*sym
;
11501 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
11503 selected_frame
= frame
;
11506 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
11507 if (CONSP (XCAR (tail
))
11508 && (tem
= XCAR (XCAR (tail
)),
11510 && (sym
= indirect_variable (XSYMBOL (tem
)),
11511 sym
->redirect
== SYMBOL_LOCALIZED
)
11512 && sym
->val
.blv
->frame_local
)
11513 /* Use find_symbol_value rather than Fsymbol_value
11514 to avoid an error if it is void. */
11515 find_symbol_value (tem
);
11516 } while (!EQ (frame
, old
) && (frame
= old
, 1));
11520 #define STOP_POLLING \
11521 do { if (! polling_stopped_here) stop_polling (); \
11522 polling_stopped_here = 1; } while (0)
11524 #define RESUME_POLLING \
11525 do { if (polling_stopped_here) start_polling (); \
11526 polling_stopped_here = 0; } while (0)
11529 /* If PRESERVE_ECHO_AREA is nonzero, it means this redisplay is not in
11530 response to any user action; therefore, we should preserve the echo
11531 area. (Actually, our caller does that job.) Perhaps in the future
11532 avoid recentering windows if it is not necessary; currently that
11533 causes some problems. */
11536 redisplay_internal (int preserve_echo_area
)
11538 struct window
*w
= XWINDOW (selected_window
);
11541 int must_finish
= 0;
11542 struct text_pos tlbufpos
, tlendpos
;
11543 int number_of_visible_frames
;
11546 int polling_stopped_here
= 0;
11547 Lisp_Object old_frame
= selected_frame
;
11549 /* Non-zero means redisplay has to consider all windows on all
11550 frames. Zero means, only selected_window is considered. */
11551 int consider_all_windows_p
;
11553 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
11555 /* No redisplay if running in batch mode or frame is not yet fully
11556 initialized, or redisplay is explicitly turned off by setting
11557 Vinhibit_redisplay. */
11558 if (FRAME_INITIAL_P (SELECTED_FRAME ())
11559 || !NILP (Vinhibit_redisplay
))
11562 /* Don't examine these until after testing Vinhibit_redisplay.
11563 When Emacs is shutting down, perhaps because its connection to
11564 X has dropped, we should not look at them at all. */
11565 f
= XFRAME (w
->frame
);
11566 sf
= SELECTED_FRAME ();
11568 if (!f
->glyphs_initialized_p
)
11571 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
11572 if (popup_activated ())
11576 /* I don't think this happens but let's be paranoid. */
11577 if (redisplaying_p
)
11580 /* Record a function that resets redisplaying_p to its old value
11581 when we leave this function. */
11582 count
= SPECPDL_INDEX ();
11583 record_unwind_protect (unwind_redisplay
,
11584 Fcons (make_number (redisplaying_p
), selected_frame
));
11586 specbind (Qinhibit_free_realized_faces
, Qnil
);
11589 Lisp_Object tail
, frame
;
11591 FOR_EACH_FRAME (tail
, frame
)
11593 struct frame
*f
= XFRAME (frame
);
11594 f
->already_hscrolled_p
= 0;
11599 if (!EQ (old_frame
, selected_frame
)
11600 && FRAME_LIVE_P (XFRAME (old_frame
)))
11601 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
11602 selected_frame and selected_window to be temporarily out-of-sync so
11603 when we come back here via `goto retry', we need to resync because we
11604 may need to run Elisp code (via prepare_menu_bars). */
11605 select_frame_for_redisplay (old_frame
);
11608 reconsider_clip_changes (w
, current_buffer
);
11609 last_escape_glyph_frame
= NULL
;
11610 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
11612 /* If new fonts have been loaded that make a glyph matrix adjustment
11613 necessary, do it. */
11614 if (fonts_changed_p
)
11616 adjust_glyphs (NULL
);
11617 ++windows_or_buffers_changed
;
11618 fonts_changed_p
= 0;
11621 /* If face_change_count is non-zero, init_iterator will free all
11622 realized faces, which includes the faces referenced from current
11623 matrices. So, we can't reuse current matrices in this case. */
11624 if (face_change_count
)
11625 ++windows_or_buffers_changed
;
11627 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11628 && FRAME_TTY (sf
)->previous_frame
!= sf
)
11630 /* Since frames on a single ASCII terminal share the same
11631 display area, displaying a different frame means redisplay
11632 the whole thing. */
11633 windows_or_buffers_changed
++;
11634 SET_FRAME_GARBAGED (sf
);
11636 set_tty_color_mode (FRAME_TTY (sf
), sf
);
11638 FRAME_TTY (sf
)->previous_frame
= sf
;
11641 /* Set the visible flags for all frames. Do this before checking
11642 for resized or garbaged frames; they want to know if their frames
11643 are visible. See the comment in frame.h for
11644 FRAME_SAMPLE_VISIBILITY. */
11646 Lisp_Object tail
, frame
;
11648 number_of_visible_frames
= 0;
11650 FOR_EACH_FRAME (tail
, frame
)
11652 struct frame
*f
= XFRAME (frame
);
11654 FRAME_SAMPLE_VISIBILITY (f
);
11655 if (FRAME_VISIBLE_P (f
))
11656 ++number_of_visible_frames
;
11657 clear_desired_matrices (f
);
11661 /* Notice any pending interrupt request to change frame size. */
11662 do_pending_window_change (1);
11664 /* Clear frames marked as garbaged. */
11665 if (frame_garbaged
)
11666 clear_garbaged_frames ();
11668 /* Build menubar and tool-bar items. */
11669 if (NILP (Vmemory_full
))
11670 prepare_menu_bars ();
11672 if (windows_or_buffers_changed
)
11673 update_mode_lines
++;
11675 /* Detect case that we need to write or remove a star in the mode line. */
11676 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
11678 w
->update_mode_line
= Qt
;
11679 if (buffer_shared
> 1)
11680 update_mode_lines
++;
11683 /* Avoid invocation of point motion hooks by `current_column' below. */
11684 count1
= SPECPDL_INDEX ();
11685 specbind (Qinhibit_point_motion_hooks
, Qt
);
11687 /* If %c is in the mode line, update it if needed. */
11688 if (!NILP (w
->column_number_displayed
)
11689 /* This alternative quickly identifies a common case
11690 where no change is needed. */
11691 && !(PT
== XFASTINT (w
->last_point
)
11692 && XFASTINT (w
->last_modified
) >= MODIFF
11693 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
11694 && (XFASTINT (w
->column_number_displayed
)
11695 != (int) current_column ())) /* iftc */
11696 w
->update_mode_line
= Qt
;
11698 unbind_to (count1
, Qnil
);
11700 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
11702 /* The variable buffer_shared is set in redisplay_window and
11703 indicates that we redisplay a buffer in different windows. See
11705 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
11706 || cursor_type_changed
);
11708 /* If specs for an arrow have changed, do thorough redisplay
11709 to ensure we remove any arrow that should no longer exist. */
11710 if (overlay_arrows_changed_p ())
11711 consider_all_windows_p
= windows_or_buffers_changed
= 1;
11713 /* Normally the message* functions will have already displayed and
11714 updated the echo area, but the frame may have been trashed, or
11715 the update may have been preempted, so display the echo area
11716 again here. Checking message_cleared_p captures the case that
11717 the echo area should be cleared. */
11718 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
11719 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
11720 || (message_cleared_p
11721 && minibuf_level
== 0
11722 /* If the mini-window is currently selected, this means the
11723 echo-area doesn't show through. */
11724 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
11726 int window_height_changed_p
= echo_area_display (0);
11729 /* If we don't display the current message, don't clear the
11730 message_cleared_p flag, because, if we did, we wouldn't clear
11731 the echo area in the next redisplay which doesn't preserve
11733 if (!display_last_displayed_message_p
)
11734 message_cleared_p
= 0;
11736 if (fonts_changed_p
)
11738 else if (window_height_changed_p
)
11740 consider_all_windows_p
= 1;
11741 ++update_mode_lines
;
11742 ++windows_or_buffers_changed
;
11744 /* If window configuration was changed, frames may have been
11745 marked garbaged. Clear them or we will experience
11746 surprises wrt scrolling. */
11747 if (frame_garbaged
)
11748 clear_garbaged_frames ();
11751 else if (EQ (selected_window
, minibuf_window
)
11752 && (current_buffer
->clip_changed
11753 || XFASTINT (w
->last_modified
) < MODIFF
11754 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11755 && resize_mini_window (w
, 0))
11757 /* Resized active mini-window to fit the size of what it is
11758 showing if its contents might have changed. */
11760 /* FIXME: this causes all frames to be updated, which seems unnecessary
11761 since only the current frame needs to be considered. This function needs
11762 to be rewritten with two variables, consider_all_windows and
11763 consider_all_frames. */
11764 consider_all_windows_p
= 1;
11765 ++windows_or_buffers_changed
;
11766 ++update_mode_lines
;
11768 /* If window configuration was changed, frames may have been
11769 marked garbaged. Clear them or we will experience
11770 surprises wrt scrolling. */
11771 if (frame_garbaged
)
11772 clear_garbaged_frames ();
11776 /* If showing the region, and mark has changed, we must redisplay
11777 the whole window. The assignment to this_line_start_pos prevents
11778 the optimization directly below this if-statement. */
11779 if (((!NILP (Vtransient_mark_mode
)
11780 && !NILP (XBUFFER (w
->buffer
)->mark_active
))
11781 != !NILP (w
->region_showing
))
11782 || (!NILP (w
->region_showing
)
11783 && !EQ (w
->region_showing
,
11784 Fmarker_position (XBUFFER (w
->buffer
)->mark
))))
11785 CHARPOS (this_line_start_pos
) = 0;
11787 /* Optimize the case that only the line containing the cursor in the
11788 selected window has changed. Variables starting with this_ are
11789 set in display_line and record information about the line
11790 containing the cursor. */
11791 tlbufpos
= this_line_start_pos
;
11792 tlendpos
= this_line_end_pos
;
11793 if (!consider_all_windows_p
11794 && CHARPOS (tlbufpos
) > 0
11795 && NILP (w
->update_mode_line
)
11796 && !current_buffer
->clip_changed
11797 && !current_buffer
->prevent_redisplay_optimizations_p
11798 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
11799 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
11800 /* Make sure recorded data applies to current buffer, etc. */
11801 && this_line_buffer
== current_buffer
11802 && current_buffer
== XBUFFER (w
->buffer
)
11803 && NILP (w
->force_start
)
11804 && NILP (w
->optional_new_start
)
11805 /* Point must be on the line that we have info recorded about. */
11806 && PT
>= CHARPOS (tlbufpos
)
11807 && PT
<= Z
- CHARPOS (tlendpos
)
11808 /* All text outside that line, including its final newline,
11809 must be unchanged. */
11810 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
11811 CHARPOS (tlendpos
)))
11813 if (CHARPOS (tlbufpos
) > BEGV
11814 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
11815 && (CHARPOS (tlbufpos
) == ZV
11816 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
11817 /* Former continuation line has disappeared by becoming empty. */
11819 else if (XFASTINT (w
->last_modified
) < MODIFF
11820 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
11821 || MINI_WINDOW_P (w
))
11823 /* We have to handle the case of continuation around a
11824 wide-column character (see the comment in indent.c around
11827 For instance, in the following case:
11829 -------- Insert --------
11830 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
11831 J_I_ ==> J_I_ `^^' are cursors.
11835 As we have to redraw the line above, we cannot use this
11839 int line_height_before
= this_line_pixel_height
;
11841 /* Note that start_display will handle the case that the
11842 line starting at tlbufpos is a continuation line. */
11843 start_display (&it
, w
, tlbufpos
);
11845 /* Implementation note: It this still necessary? */
11846 if (it
.current_x
!= this_line_start_x
)
11849 TRACE ((stderr
, "trying display optimization 1\n"));
11850 w
->cursor
.vpos
= -1;
11851 overlay_arrow_seen
= 0;
11852 it
.vpos
= this_line_vpos
;
11853 it
.current_y
= this_line_y
;
11854 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
11855 display_line (&it
);
11857 /* If line contains point, is not continued,
11858 and ends at same distance from eob as before, we win. */
11859 if (w
->cursor
.vpos
>= 0
11860 /* Line is not continued, otherwise this_line_start_pos
11861 would have been set to 0 in display_line. */
11862 && CHARPOS (this_line_start_pos
)
11863 /* Line ends as before. */
11864 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
11865 /* Line has same height as before. Otherwise other lines
11866 would have to be shifted up or down. */
11867 && this_line_pixel_height
== line_height_before
)
11869 /* If this is not the window's last line, we must adjust
11870 the charstarts of the lines below. */
11871 if (it
.current_y
< it
.last_visible_y
)
11873 struct glyph_row
*row
11874 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
11875 int delta
, delta_bytes
;
11877 /* We used to distinguish between two cases here,
11878 conditioned by Z - CHARPOS (tlendpos) == ZV, for
11879 when the line ends in a newline or the end of the
11880 buffer's accessible portion. But both cases did
11881 the same, so they were collapsed. */
11883 - CHARPOS (tlendpos
)
11884 - MATRIX_ROW_START_CHARPOS (row
));
11885 delta_bytes
= (Z_BYTE
11886 - BYTEPOS (tlendpos
)
11887 - MATRIX_ROW_START_BYTEPOS (row
));
11889 increment_matrix_positions (w
->current_matrix
,
11890 this_line_vpos
+ 1,
11891 w
->current_matrix
->nrows
,
11892 delta
, delta_bytes
);
11895 /* If this row displays text now but previously didn't,
11896 or vice versa, w->window_end_vpos may have to be
11898 if ((it
.glyph_row
- 1)->displays_text_p
)
11900 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
11901 XSETINT (w
->window_end_vpos
, this_line_vpos
);
11903 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
11904 && this_line_vpos
> 0)
11905 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
11906 w
->window_end_valid
= Qnil
;
11908 /* Update hint: No need to try to scroll in update_window. */
11909 w
->desired_matrix
->no_scrolling_p
= 1;
11912 *w
->desired_matrix
->method
= 0;
11913 debug_method_add (w
, "optimization 1");
11915 #ifdef HAVE_WINDOW_SYSTEM
11916 update_window_fringes (w
, 0);
11923 else if (/* Cursor position hasn't changed. */
11924 PT
== XFASTINT (w
->last_point
)
11925 /* Make sure the cursor was last displayed
11926 in this window. Otherwise we have to reposition it. */
11927 && 0 <= w
->cursor
.vpos
11928 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
11932 do_pending_window_change (1);
11934 /* We used to always goto end_of_redisplay here, but this
11935 isn't enough if we have a blinking cursor. */
11936 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
11937 goto end_of_redisplay
;
11941 /* If highlighting the region, or if the cursor is in the echo area,
11942 then we can't just move the cursor. */
11943 else if (! (!NILP (Vtransient_mark_mode
)
11944 && !NILP (current_buffer
->mark_active
))
11945 && (EQ (selected_window
, current_buffer
->last_selected_window
)
11946 || highlight_nonselected_windows
)
11947 && NILP (w
->region_showing
)
11948 && NILP (Vshow_trailing_whitespace
)
11949 && !cursor_in_echo_area
)
11952 struct glyph_row
*row
;
11954 /* Skip from tlbufpos to PT and see where it is. Note that
11955 PT may be in invisible text. If so, we will end at the
11956 next visible position. */
11957 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
11958 NULL
, DEFAULT_FACE_ID
);
11959 it
.current_x
= this_line_start_x
;
11960 it
.current_y
= this_line_y
;
11961 it
.vpos
= this_line_vpos
;
11963 /* The call to move_it_to stops in front of PT, but
11964 moves over before-strings. */
11965 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
11967 if (it
.vpos
== this_line_vpos
11968 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
11971 xassert (this_line_vpos
== it
.vpos
);
11972 xassert (this_line_y
== it
.current_y
);
11973 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
11975 *w
->desired_matrix
->method
= 0;
11976 debug_method_add (w
, "optimization 3");
11985 /* Text changed drastically or point moved off of line. */
11986 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
11989 CHARPOS (this_line_start_pos
) = 0;
11990 consider_all_windows_p
|= buffer_shared
> 1;
11991 ++clear_face_cache_count
;
11992 #ifdef HAVE_WINDOW_SYSTEM
11993 ++clear_image_cache_count
;
11996 /* Build desired matrices, and update the display. If
11997 consider_all_windows_p is non-zero, do it for all windows on all
11998 frames. Otherwise do it for selected_window, only. */
12000 if (consider_all_windows_p
)
12002 Lisp_Object tail
, frame
;
12004 FOR_EACH_FRAME (tail
, frame
)
12005 XFRAME (frame
)->updated_p
= 0;
12007 /* Recompute # windows showing selected buffer. This will be
12008 incremented each time such a window is displayed. */
12011 FOR_EACH_FRAME (tail
, frame
)
12013 struct frame
*f
= XFRAME (frame
);
12015 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12017 if (! EQ (frame
, selected_frame
))
12018 /* Select the frame, for the sake of frame-local
12020 select_frame_for_redisplay (frame
);
12022 /* Mark all the scroll bars to be removed; we'll redeem
12023 the ones we want when we redisplay their windows. */
12024 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12025 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12027 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12028 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12030 /* The X error handler may have deleted that frame. */
12031 if (!FRAME_LIVE_P (f
))
12034 /* Any scroll bars which redisplay_windows should have
12035 nuked should now go away. */
12036 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12037 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12039 /* If fonts changed, display again. */
12040 /* ??? rms: I suspect it is a mistake to jump all the way
12041 back to retry here. It should just retry this frame. */
12042 if (fonts_changed_p
)
12045 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12047 /* See if we have to hscroll. */
12048 if (!f
->already_hscrolled_p
)
12050 f
->already_hscrolled_p
= 1;
12051 if (hscroll_windows (f
->root_window
))
12055 /* Prevent various kinds of signals during display
12056 update. stdio is not robust about handling
12057 signals, which can cause an apparent I/O
12059 if (interrupt_input
)
12060 unrequest_sigio ();
12063 /* Update the display. */
12064 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12065 pause
|= update_frame (f
, 0, 0);
12071 if (!EQ (old_frame
, selected_frame
)
12072 && FRAME_LIVE_P (XFRAME (old_frame
)))
12073 /* We played a bit fast-and-loose above and allowed selected_frame
12074 and selected_window to be temporarily out-of-sync but let's make
12075 sure this stays contained. */
12076 select_frame_for_redisplay (old_frame
);
12077 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12081 /* Do the mark_window_display_accurate after all windows have
12082 been redisplayed because this call resets flags in buffers
12083 which are needed for proper redisplay. */
12084 FOR_EACH_FRAME (tail
, frame
)
12086 struct frame
*f
= XFRAME (frame
);
12089 mark_window_display_accurate (f
->root_window
, 1);
12090 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12091 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12096 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12098 Lisp_Object mini_window
;
12099 struct frame
*mini_frame
;
12101 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12102 /* Use list_of_error, not Qerror, so that
12103 we catch only errors and don't run the debugger. */
12104 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12106 redisplay_window_error
);
12108 /* Compare desired and current matrices, perform output. */
12111 /* If fonts changed, display again. */
12112 if (fonts_changed_p
)
12115 /* Prevent various kinds of signals during display update.
12116 stdio is not robust about handling signals,
12117 which can cause an apparent I/O error. */
12118 if (interrupt_input
)
12119 unrequest_sigio ();
12122 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12124 if (hscroll_windows (selected_window
))
12127 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12128 pause
= update_frame (sf
, 0, 0);
12131 /* We may have called echo_area_display at the top of this
12132 function. If the echo area is on another frame, that may
12133 have put text on a frame other than the selected one, so the
12134 above call to update_frame would not have caught it. Catch
12136 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12137 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12139 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12141 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12142 pause
|= update_frame (mini_frame
, 0, 0);
12143 if (!pause
&& hscroll_windows (mini_window
))
12148 /* If display was paused because of pending input, make sure we do a
12149 thorough update the next time. */
12152 /* Prevent the optimization at the beginning of
12153 redisplay_internal that tries a single-line update of the
12154 line containing the cursor in the selected window. */
12155 CHARPOS (this_line_start_pos
) = 0;
12157 /* Let the overlay arrow be updated the next time. */
12158 update_overlay_arrows (0);
12160 /* If we pause after scrolling, some rows in the current
12161 matrices of some windows are not valid. */
12162 if (!WINDOW_FULL_WIDTH_P (w
)
12163 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12164 update_mode_lines
= 1;
12168 if (!consider_all_windows_p
)
12170 /* This has already been done above if
12171 consider_all_windows_p is set. */
12172 mark_window_display_accurate_1 (w
, 1);
12174 /* Say overlay arrows are up to date. */
12175 update_overlay_arrows (1);
12177 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12178 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12181 update_mode_lines
= 0;
12182 windows_or_buffers_changed
= 0;
12183 cursor_type_changed
= 0;
12186 /* Start SIGIO interrupts coming again. Having them off during the
12187 code above makes it less likely one will discard output, but not
12188 impossible, since there might be stuff in the system buffer here.
12189 But it is much hairier to try to do anything about that. */
12190 if (interrupt_input
)
12194 /* If a frame has become visible which was not before, redisplay
12195 again, so that we display it. Expose events for such a frame
12196 (which it gets when becoming visible) don't call the parts of
12197 redisplay constructing glyphs, so simply exposing a frame won't
12198 display anything in this case. So, we have to display these
12199 frames here explicitly. */
12202 Lisp_Object tail
, frame
;
12205 FOR_EACH_FRAME (tail
, frame
)
12207 int this_is_visible
= 0;
12209 if (XFRAME (frame
)->visible
)
12210 this_is_visible
= 1;
12211 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
12212 if (XFRAME (frame
)->visible
)
12213 this_is_visible
= 1;
12215 if (this_is_visible
)
12219 if (new_count
!= number_of_visible_frames
)
12220 windows_or_buffers_changed
++;
12223 /* Change frame size now if a change is pending. */
12224 do_pending_window_change (1);
12226 /* If we just did a pending size change, or have additional
12227 visible frames, redisplay again. */
12228 if (windows_or_buffers_changed
&& !pause
)
12231 /* Clear the face and image caches.
12233 We used to do this only if consider_all_windows_p. But the cache
12234 needs to be cleared if a timer creates images in the current
12235 buffer (e.g. the test case in Bug#6230). */
12237 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
12239 clear_face_cache (0);
12240 clear_face_cache_count
= 0;
12243 #ifdef HAVE_WINDOW_SYSTEM
12244 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
12246 clear_image_caches (Qnil
);
12247 clear_image_cache_count
= 0;
12249 #endif /* HAVE_WINDOW_SYSTEM */
12252 unbind_to (count
, Qnil
);
12257 /* Redisplay, but leave alone any recent echo area message unless
12258 another message has been requested in its place.
12260 This is useful in situations where you need to redisplay but no
12261 user action has occurred, making it inappropriate for the message
12262 area to be cleared. See tracking_off and
12263 wait_reading_process_output for examples of these situations.
12265 FROM_WHERE is an integer saying from where this function was
12266 called. This is useful for debugging. */
12269 redisplay_preserve_echo_area (int from_where
)
12271 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
12273 if (!NILP (echo_area_buffer
[1]))
12275 /* We have a previously displayed message, but no current
12276 message. Redisplay the previous message. */
12277 display_last_displayed_message_p
= 1;
12278 redisplay_internal (1);
12279 display_last_displayed_message_p
= 0;
12282 redisplay_internal (1);
12284 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
12285 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
12286 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
12290 /* Function registered with record_unwind_protect in
12291 redisplay_internal. Reset redisplaying_p to the value it had
12292 before redisplay_internal was called, and clear
12293 prevent_freeing_realized_faces_p. It also selects the previously
12294 selected frame, unless it has been deleted (by an X connection
12295 failure during redisplay, for example). */
12298 unwind_redisplay (Lisp_Object val
)
12300 Lisp_Object old_redisplaying_p
, old_frame
;
12302 old_redisplaying_p
= XCAR (val
);
12303 redisplaying_p
= XFASTINT (old_redisplaying_p
);
12304 old_frame
= XCDR (val
);
12305 if (! EQ (old_frame
, selected_frame
)
12306 && FRAME_LIVE_P (XFRAME (old_frame
)))
12307 select_frame_for_redisplay (old_frame
);
12312 /* Mark the display of window W as accurate or inaccurate. If
12313 ACCURATE_P is non-zero mark display of W as accurate. If
12314 ACCURATE_P is zero, arrange for W to be redisplayed the next time
12315 redisplay_internal is called. */
12318 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
12320 if (BUFFERP (w
->buffer
))
12322 struct buffer
*b
= XBUFFER (w
->buffer
);
12325 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
12326 w
->last_overlay_modified
12327 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
12329 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
12333 b
->clip_changed
= 0;
12334 b
->prevent_redisplay_optimizations_p
= 0;
12336 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
12337 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
12338 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
12339 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
12341 w
->current_matrix
->buffer
= b
;
12342 w
->current_matrix
->begv
= BUF_BEGV (b
);
12343 w
->current_matrix
->zv
= BUF_ZV (b
);
12345 w
->last_cursor
= w
->cursor
;
12346 w
->last_cursor_off_p
= w
->cursor_off_p
;
12348 if (w
== XWINDOW (selected_window
))
12349 w
->last_point
= make_number (BUF_PT (b
));
12351 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
12357 w
->window_end_valid
= w
->buffer
;
12358 w
->update_mode_line
= Qnil
;
12363 /* Mark the display of windows in the window tree rooted at WINDOW as
12364 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
12365 windows as accurate. If ACCURATE_P is zero, arrange for windows to
12366 be redisplayed the next time redisplay_internal is called. */
12369 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
12373 for (; !NILP (window
); window
= w
->next
)
12375 w
= XWINDOW (window
);
12376 mark_window_display_accurate_1 (w
, accurate_p
);
12378 if (!NILP (w
->vchild
))
12379 mark_window_display_accurate (w
->vchild
, accurate_p
);
12380 if (!NILP (w
->hchild
))
12381 mark_window_display_accurate (w
->hchild
, accurate_p
);
12386 update_overlay_arrows (1);
12390 /* Force a thorough redisplay the next time by setting
12391 last_arrow_position and last_arrow_string to t, which is
12392 unequal to any useful value of Voverlay_arrow_... */
12393 update_overlay_arrows (-1);
12398 /* Return value in display table DP (Lisp_Char_Table *) for character
12399 C. Since a display table doesn't have any parent, we don't have to
12400 follow parent. Do not call this function directly but use the
12401 macro DISP_CHAR_VECTOR. */
12404 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
12408 if (ASCII_CHAR_P (c
))
12411 if (SUB_CHAR_TABLE_P (val
))
12412 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
12418 XSETCHAR_TABLE (table
, dp
);
12419 val
= char_table_ref (table
, c
);
12428 /***********************************************************************
12430 ***********************************************************************/
12432 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
12435 redisplay_windows (Lisp_Object window
)
12437 while (!NILP (window
))
12439 struct window
*w
= XWINDOW (window
);
12441 if (!NILP (w
->hchild
))
12442 redisplay_windows (w
->hchild
);
12443 else if (!NILP (w
->vchild
))
12444 redisplay_windows (w
->vchild
);
12445 else if (!NILP (w
->buffer
))
12447 displayed_buffer
= XBUFFER (w
->buffer
);
12448 /* Use list_of_error, not Qerror, so that
12449 we catch only errors and don't run the debugger. */
12450 internal_condition_case_1 (redisplay_window_0
, window
,
12452 redisplay_window_error
);
12460 redisplay_window_error (Lisp_Object ignore
)
12462 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
12467 redisplay_window_0 (Lisp_Object window
)
12469 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12470 redisplay_window (window
, 0);
12475 redisplay_window_1 (Lisp_Object window
)
12477 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
12478 redisplay_window (window
, 1);
12483 /* Increment GLYPH until it reaches END or CONDITION fails while
12484 adding (GLYPH)->pixel_width to X. */
12486 #define SKIP_GLYPHS(glyph, end, x, condition) \
12489 (x) += (glyph)->pixel_width; \
12492 while ((glyph) < (end) && (condition))
12495 /* Set cursor position of W. PT is assumed to be displayed in ROW.
12496 DELTA and DELTA_BYTES are the numbers of characters and bytes by
12497 which positions recorded in ROW differ from current buffer
12500 Return 0 if cursor is not on this row, 1 otherwise. */
12503 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
12504 struct glyph_matrix
*matrix
, int delta
, int delta_bytes
,
12507 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
12508 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
12509 struct glyph
*cursor
= NULL
;
12510 /* The last known character position in row. */
12511 int last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12513 EMACS_INT pt_old
= PT
- delta
;
12514 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
12515 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
12516 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
12517 /* A glyph beyond the edge of TEXT_AREA which we should never
12519 struct glyph
*glyphs_end
= end
;
12520 /* Non-zero means we've found a match for cursor position, but that
12521 glyph has the avoid_cursor_p flag set. */
12522 int match_with_avoid_cursor
= 0;
12523 /* Non-zero means we've seen at least one glyph that came from a
12525 int string_seen
= 0;
12526 /* Largest buffer position seen so far during scan of glyph row. */
12527 EMACS_INT bpos_max
= last_pos
;
12528 /* Last buffer position covered by an overlay string with an integer
12529 `cursor' property. */
12530 EMACS_INT bpos_covered
= 0;
12532 /* Skip over glyphs not having an object at the start and the end of
12533 the row. These are special glyphs like truncation marks on
12534 terminal frames. */
12535 if (row
->displays_text_p
)
12537 if (!row
->reversed_p
)
12540 && INTEGERP (glyph
->object
)
12541 && glyph
->charpos
< 0)
12543 x
+= glyph
->pixel_width
;
12547 && INTEGERP ((end
- 1)->object
)
12548 /* CHARPOS is zero for blanks and stretch glyphs
12549 inserted by extend_face_to_end_of_line. */
12550 && (end
- 1)->charpos
<= 0)
12552 glyph_before
= glyph
- 1;
12559 /* If the glyph row is reversed, we need to process it from back
12560 to front, so swap the edge pointers. */
12561 glyphs_end
= end
= glyph
- 1;
12562 glyph
+= row
->used
[TEXT_AREA
] - 1;
12564 while (glyph
> end
+ 1
12565 && INTEGERP (glyph
->object
)
12566 && glyph
->charpos
< 0)
12569 x
-= glyph
->pixel_width
;
12571 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
12573 /* By default, in reversed rows we put the cursor on the
12574 rightmost (first in the reading order) glyph. */
12575 for (g
= end
+ 1; g
< glyph
; g
++)
12576 x
+= g
->pixel_width
;
12578 && INTEGERP ((end
+ 1)->object
)
12579 && (end
+ 1)->charpos
<= 0)
12581 glyph_before
= glyph
+ 1;
12585 else if (row
->reversed_p
)
12587 /* In R2L rows that don't display text, put the cursor on the
12588 rightmost glyph. Case in point: an empty last line that is
12589 part of an R2L paragraph. */
12591 /* Avoid placing the cursor on the last glyph of the row, where
12592 on terminal frames we hold the vertical border between
12593 adjacent windows. */
12594 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
12595 && !WINDOW_RIGHTMOST_P (w
)
12596 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
12598 x
= -1; /* will be computed below, at label compute_x */
12601 /* Step 1: Try to find the glyph whose character position
12602 corresponds to point. If that's not possible, find 2 glyphs
12603 whose character positions are the closest to point, one before
12604 point, the other after it. */
12605 if (!row
->reversed_p
)
12606 while (/* not marched to end of glyph row */
12608 /* glyph was not inserted by redisplay for internal purposes */
12609 && !INTEGERP (glyph
->object
))
12611 if (BUFFERP (glyph
->object
))
12613 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12615 if (glyph
->charpos
> bpos_max
)
12616 bpos_max
= glyph
->charpos
;
12617 if (!glyph
->avoid_cursor_p
)
12619 /* If we hit point, we've found the glyph on which to
12620 display the cursor. */
12623 match_with_avoid_cursor
= 0;
12626 /* See if we've found a better approximation to
12627 POS_BEFORE or to POS_AFTER. Note that we want the
12628 first (leftmost) glyph of all those that are the
12629 closest from below, and the last (rightmost) of all
12630 those from above. */
12631 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12633 pos_before
= glyph
->charpos
;
12634 glyph_before
= glyph
;
12636 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12638 pos_after
= glyph
->charpos
;
12639 glyph_after
= glyph
;
12642 else if (dpos
== 0)
12643 match_with_avoid_cursor
= 1;
12645 else if (STRINGP (glyph
->object
))
12647 Lisp_Object chprop
;
12648 int glyph_pos
= glyph
->charpos
;
12650 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12652 if (INTEGERP (chprop
))
12654 bpos_covered
= bpos_max
+ XINT (chprop
);
12655 /* If the `cursor' property covers buffer positions up
12656 to and including point, we should display cursor on
12657 this glyph. Note that overlays and text properties
12658 with string values stop bidi reordering, so every
12659 buffer position to the left of the string is always
12660 smaller than any position to the right of the
12661 string. Therefore, if a `cursor' property on one
12662 of the string's characters has an integer value, we
12663 will break out of the loop below _before_ we get to
12664 the position match above. IOW, integer values of
12665 the `cursor' property override the "exact match for
12666 point" strategy of positioning the cursor. */
12667 /* Implementation note: bpos_max == pt_old when, e.g.,
12668 we are in an empty line, where bpos_max is set to
12669 MATRIX_ROW_START_CHARPOS, see above. */
12670 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12679 x
+= glyph
->pixel_width
;
12682 else if (glyph
> end
) /* row is reversed */
12683 while (!INTEGERP (glyph
->object
))
12685 if (BUFFERP (glyph
->object
))
12687 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
12689 if (glyph
->charpos
> bpos_max
)
12690 bpos_max
= glyph
->charpos
;
12691 if (!glyph
->avoid_cursor_p
)
12695 match_with_avoid_cursor
= 0;
12698 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
12700 pos_before
= glyph
->charpos
;
12701 glyph_before
= glyph
;
12703 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
12705 pos_after
= glyph
->charpos
;
12706 glyph_after
= glyph
;
12709 else if (dpos
== 0)
12710 match_with_avoid_cursor
= 1;
12712 else if (STRINGP (glyph
->object
))
12714 Lisp_Object chprop
;
12715 int glyph_pos
= glyph
->charpos
;
12717 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
12719 if (INTEGERP (chprop
))
12721 bpos_covered
= bpos_max
+ XINT (chprop
);
12722 /* If the `cursor' property covers buffer positions up
12723 to and including point, we should display cursor on
12725 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
12734 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
12736 x
--; /* can't use any pixel_width */
12739 x
-= glyph
->pixel_width
;
12742 /* Step 2: If we didn't find an exact match for point, we need to
12743 look for a proper place to put the cursor among glyphs between
12744 GLYPH_BEFORE and GLYPH_AFTER. */
12745 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
12746 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12747 && bpos_covered
< pt_old
)
12749 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
12751 EMACS_INT ellipsis_pos
;
12753 /* Scan back over the ellipsis glyphs. */
12754 if (!row
->reversed_p
)
12756 ellipsis_pos
= (glyph
- 1)->charpos
;
12757 while (glyph
> row
->glyphs
[TEXT_AREA
]
12758 && (glyph
- 1)->charpos
== ellipsis_pos
)
12759 glyph
--, x
-= glyph
->pixel_width
;
12760 /* That loop always goes one position too far, including
12761 the glyph before the ellipsis. So scan forward over
12763 x
+= glyph
->pixel_width
;
12766 else /* row is reversed */
12768 ellipsis_pos
= (glyph
+ 1)->charpos
;
12769 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
12770 && (glyph
+ 1)->charpos
== ellipsis_pos
)
12771 glyph
++, x
+= glyph
->pixel_width
;
12772 x
-= glyph
->pixel_width
;
12776 else if (match_with_avoid_cursor
12777 /* zero-width characters produce no glyphs */
12778 || ((row
->reversed_p
12779 ? glyph_after
> glyphs_end
12780 : glyph_after
< glyphs_end
)
12781 && eabs (glyph_after
- glyph_before
) == 1))
12783 cursor
= glyph_after
;
12786 else if (string_seen
)
12788 int incr
= row
->reversed_p
? -1 : +1;
12790 /* Need to find the glyph that came out of a string which is
12791 present at point. That glyph is somewhere between
12792 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
12793 positioned between POS_BEFORE and POS_AFTER in the
12795 struct glyph
*stop
= glyph_after
;
12796 EMACS_INT pos
= pos_before
;
12799 for (glyph
= glyph_before
+ incr
;
12800 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
12803 /* Any glyphs that come from the buffer are here because
12804 of bidi reordering. Skip them, and only pay
12805 attention to glyphs that came from some string. */
12806 if (STRINGP (glyph
->object
))
12811 str
= glyph
->object
;
12812 tem
= string_buffer_position_lim (w
, str
, pos
, pos_after
, 0);
12813 if (tem
== 0 /* from overlay */
12816 /* If the string from which this glyph came is
12817 found in the buffer at point, then we've
12818 found the glyph we've been looking for. If
12819 it comes from an overlay (tem == 0), and it
12820 has the `cursor' property on one of its
12821 glyphs, record that glyph as a candidate for
12822 displaying the cursor. (As in the
12823 unidirectional version, we will display the
12824 cursor on the last candidate we find.) */
12825 if (tem
== 0 || tem
== pt_old
)
12827 /* The glyphs from this string could have
12828 been reordered. Find the one with the
12829 smallest string position. Or there could
12830 be a character in the string with the
12831 `cursor' property, which means display
12832 cursor on that character's glyph. */
12833 int strpos
= glyph
->charpos
;
12836 for (glyph
+= incr
;
12837 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12838 && EQ (glyph
->object
, str
);
12842 int gpos
= glyph
->charpos
;
12844 cprop
= Fget_char_property (make_number (gpos
),
12852 if (glyph
->charpos
< strpos
)
12854 strpos
= glyph
->charpos
;
12863 pos
= tem
+ 1; /* don't find previous instances */
12865 /* This string is not what we want; skip all of the
12866 glyphs that came from it. */
12869 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
12870 && EQ (glyph
->object
, str
));
12876 /* If we reached the end of the line, and END was from a string,
12877 the cursor is not on this line. */
12879 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
12880 && STRINGP (end
->object
)
12881 && row
->continued_p
)
12887 if (cursor
!= NULL
)
12893 /* Need to compute x that corresponds to GLYPH. */
12894 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
12896 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
12898 x
+= g
->pixel_width
;
12902 /* ROW could be part of a continued line, which, under bidi
12903 reordering, might have other rows whose start and end charpos
12904 occlude point. Only set w->cursor if we found a better
12905 approximation to the cursor position than we have from previously
12906 examined candidate rows belonging to the same continued line. */
12907 if (/* we already have a candidate row */
12908 w
->cursor
.vpos
>= 0
12909 /* that candidate is not the row we are processing */
12910 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
12911 /* the row we are processing is part of a continued line */
12912 && (row
->continued_p
|| MATRIX_ROW_CONTINUATION_LINE_P (row
))
12913 /* Make sure cursor.vpos specifies a row whose start and end
12914 charpos occlude point. This is because some callers of this
12915 function leave cursor.vpos at the row where the cursor was
12916 displayed during the last redisplay cycle. */
12917 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
12918 && pt_old
< MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
12921 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
12923 /* Don't consider glyphs that are outside TEXT_AREA. */
12924 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
12926 /* Keep the candidate whose buffer position is the closest to
12928 if (/* previous candidate is a glyph in TEXT_AREA of that row */
12929 w
->cursor
.hpos
>= 0
12930 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
12931 && BUFFERP (g1
->object
)
12932 && (g1
->charpos
== pt_old
/* an exact match always wins */
12933 || (BUFFERP (glyph
->object
)
12934 && eabs (g1
->charpos
- pt_old
)
12935 < eabs (glyph
->charpos
- pt_old
))))
12937 /* If this candidate gives an exact match, use that. */
12938 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
12939 /* Otherwise, keep the candidate that comes from a row
12940 spanning less buffer positions. This may win when one or
12941 both candidate positions are on glyphs that came from
12942 display strings, for which we cannot compare buffer
12944 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12945 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
12946 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
12949 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
12951 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
12952 w
->cursor
.y
= row
->y
+ dy
;
12954 if (w
== XWINDOW (selected_window
))
12956 if (!row
->continued_p
12957 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
12960 this_line_buffer
= XBUFFER (w
->buffer
);
12962 CHARPOS (this_line_start_pos
)
12963 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
12964 BYTEPOS (this_line_start_pos
)
12965 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
12967 CHARPOS (this_line_end_pos
)
12968 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
12969 BYTEPOS (this_line_end_pos
)
12970 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
12972 this_line_y
= w
->cursor
.y
;
12973 this_line_pixel_height
= row
->height
;
12974 this_line_vpos
= w
->cursor
.vpos
;
12975 this_line_start_x
= row
->x
;
12978 CHARPOS (this_line_start_pos
) = 0;
12985 /* Run window scroll functions, if any, for WINDOW with new window
12986 start STARTP. Sets the window start of WINDOW to that position.
12988 We assume that the window's buffer is really current. */
12990 static INLINE
struct text_pos
12991 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
12993 struct window
*w
= XWINDOW (window
);
12994 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
12996 if (current_buffer
!= XBUFFER (w
->buffer
))
12999 if (!NILP (Vwindow_scroll_functions
))
13001 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13002 make_number (CHARPOS (startp
)));
13003 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13004 /* In case the hook functions switch buffers. */
13005 if (current_buffer
!= XBUFFER (w
->buffer
))
13006 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13013 /* Make sure the line containing the cursor is fully visible.
13014 A value of 1 means there is nothing to be done.
13015 (Either the line is fully visible, or it cannot be made so,
13016 or we cannot tell.)
13018 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13019 is higher than window.
13021 A value of 0 means the caller should do scrolling
13022 as if point had gone off the screen. */
13025 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13027 struct glyph_matrix
*matrix
;
13028 struct glyph_row
*row
;
13031 if (!make_cursor_line_fully_visible_p
)
13034 /* It's not always possible to find the cursor, e.g, when a window
13035 is full of overlay strings. Don't do anything in that case. */
13036 if (w
->cursor
.vpos
< 0)
13039 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13040 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13042 /* If the cursor row is not partially visible, there's nothing to do. */
13043 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13046 /* If the row the cursor is in is taller than the window's height,
13047 it's not clear what to do, so do nothing. */
13048 window_height
= window_box_height (w
);
13049 if (row
->height
>= window_height
)
13051 if (!force_p
|| MINI_WINDOW_P (w
)
13052 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13059 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13060 non-zero means only WINDOW is redisplayed in redisplay_internal.
13061 TEMP_SCROLL_STEP has the same meaning as scroll_step, and is used
13062 in redisplay_window to bring a partially visible line into view in
13063 the case that only the cursor has moved.
13065 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13066 last screen line's vertical height extends past the end of the screen.
13070 1 if scrolling succeeded
13072 0 if scrolling didn't find point.
13074 -1 if new fonts have been loaded so that we must interrupt
13075 redisplay, adjust glyph matrices, and try again. */
13081 SCROLLING_NEED_LARGER_MATRICES
13085 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13086 EMACS_INT scroll_conservatively
, EMACS_INT scroll_step
,
13087 int temp_scroll_step
, int last_line_misfit
)
13089 struct window
*w
= XWINDOW (window
);
13090 struct frame
*f
= XFRAME (w
->frame
);
13091 struct text_pos pos
, startp
;
13093 int this_scroll_margin
, scroll_max
, rc
, height
;
13094 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13095 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13096 Lisp_Object aggressive
;
13097 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13100 debug_method_add (w
, "try_scrolling");
13103 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13105 /* Compute scroll margin height in pixels. We scroll when point is
13106 within this distance from the top or bottom of the window. */
13107 if (scroll_margin
> 0)
13108 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13109 * FRAME_LINE_HEIGHT (f
);
13111 this_scroll_margin
= 0;
13113 /* Force scroll_conservatively to have a reasonable value, to avoid
13114 overflow while computing how much to scroll. Note that the user
13115 can supply scroll-conservatively equal to `most-positive-fixnum',
13116 which can be larger than INT_MAX. */
13117 if (scroll_conservatively
> scroll_limit
)
13119 scroll_conservatively
= scroll_limit
;
13120 scroll_max
= INT_MAX
;
13122 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13123 /* Compute how much we should try to scroll maximally to bring
13124 point into view. */
13125 scroll_max
= (max (scroll_step
,
13126 max (scroll_conservatively
, temp_scroll_step
))
13127 * FRAME_LINE_HEIGHT (f
));
13128 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13129 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13130 /* We're trying to scroll because of aggressive scrolling but no
13131 scroll_step is set. Choose an arbitrary one. */
13132 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13138 /* Decide whether to scroll down. */
13139 if (PT
> CHARPOS (startp
))
13141 int scroll_margin_y
;
13143 /* Compute the pixel ypos of the scroll margin, then move it to
13144 either that ypos or PT, whichever comes first. */
13145 start_display (&it
, w
, startp
);
13146 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13147 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13148 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13149 (MOVE_TO_POS
| MOVE_TO_Y
));
13151 if (PT
> CHARPOS (it
.current
.pos
))
13153 int y0
= line_bottom_y (&it
);
13154 /* Compute how many pixels below window bottom to stop searching
13155 for PT. This avoids costly search for PT that is far away if
13156 the user limited scrolling by a small number of lines, but
13157 always finds PT if scroll_conservatively is set to a large
13158 number, such as most-positive-fixnum. */
13159 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13161 slack
>= INT_MAX
- it
.last_visible_y
13163 : it
.last_visible_y
+ slack
;
13165 /* Compute the distance from the scroll margin to PT or to
13166 the scroll limit, whichever comes first. This should
13167 include the height of the cursor line, to make that line
13169 move_it_to (&it
, PT
, -1, y_to_move
,
13170 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13171 dy
= line_bottom_y (&it
) - y0
;
13173 if (dy
> scroll_max
)
13174 return SCROLLING_FAILED
;
13182 /* Point is in or below the bottom scroll margin, so move the
13183 window start down. If scrolling conservatively, move it just
13184 enough down to make point visible. If scroll_step is set,
13185 move it down by scroll_step. */
13186 if (scroll_conservatively
)
13188 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13189 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13190 else if (scroll_step
|| temp_scroll_step
)
13191 amount_to_scroll
= scroll_max
;
13194 aggressive
= current_buffer
->scroll_up_aggressively
;
13195 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13196 if (NUMBERP (aggressive
))
13198 double float_amount
= XFLOATINT (aggressive
) * height
;
13199 amount_to_scroll
= float_amount
;
13200 if (amount_to_scroll
== 0 && float_amount
> 0)
13201 amount_to_scroll
= 1;
13205 if (amount_to_scroll
<= 0)
13206 return SCROLLING_FAILED
;
13208 start_display (&it
, w
, startp
);
13209 if (scroll_max
< INT_MAX
)
13210 move_it_vertically (&it
, amount_to_scroll
);
13213 /* Extra precision for users who set scroll-conservatively
13214 to most-positive-fixnum: make sure the amount we scroll
13215 the window start is never less than amount_to_scroll,
13216 which was computed as distance from window bottom to
13217 point. This matters when lines at window top and lines
13218 below window bottom have different height. */
13219 struct it it1
= it
;
13220 /* We use a temporary it1 because line_bottom_y can modify
13221 its argument, if it moves one line down; see there. */
13222 int start_y
= line_bottom_y (&it1
);
13225 move_it_by_lines (&it
, 1, 1);
13227 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13230 /* If STARTP is unchanged, move it down another screen line. */
13231 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13232 move_it_by_lines (&it
, 1, 1);
13233 startp
= it
.current
.pos
;
13237 struct text_pos scroll_margin_pos
= startp
;
13239 /* See if point is inside the scroll margin at the top of the
13241 if (this_scroll_margin
)
13243 start_display (&it
, w
, startp
);
13244 move_it_vertically (&it
, this_scroll_margin
);
13245 scroll_margin_pos
= it
.current
.pos
;
13248 if (PT
< CHARPOS (scroll_margin_pos
))
13250 /* Point is in the scroll margin at the top of the window or
13251 above what is displayed in the window. */
13254 /* Compute the vertical distance from PT to the scroll
13255 margin position. Give up if distance is greater than
13257 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13258 start_display (&it
, w
, pos
);
13260 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13261 it
.last_visible_y
, -1,
13262 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13263 dy
= it
.current_y
- y0
;
13264 if (dy
> scroll_max
)
13265 return SCROLLING_FAILED
;
13267 /* Compute new window start. */
13268 start_display (&it
, w
, startp
);
13270 if (scroll_conservatively
)
13272 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13273 else if (scroll_step
|| temp_scroll_step
)
13274 amount_to_scroll
= scroll_max
;
13277 aggressive
= current_buffer
->scroll_down_aggressively
;
13278 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13279 if (NUMBERP (aggressive
))
13281 double float_amount
= XFLOATINT (aggressive
) * height
;
13282 amount_to_scroll
= float_amount
;
13283 if (amount_to_scroll
== 0 && float_amount
> 0)
13284 amount_to_scroll
= 1;
13288 if (amount_to_scroll
<= 0)
13289 return SCROLLING_FAILED
;
13291 move_it_vertically_backward (&it
, amount_to_scroll
);
13292 startp
= it
.current
.pos
;
13296 /* Run window scroll functions. */
13297 startp
= run_window_scroll_functions (window
, startp
);
13299 /* Display the window. Give up if new fonts are loaded, or if point
13301 if (!try_window (window
, startp
, 0))
13302 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13303 else if (w
->cursor
.vpos
< 0)
13305 clear_glyph_matrix (w
->desired_matrix
);
13306 rc
= SCROLLING_FAILED
;
13310 /* Maybe forget recorded base line for line number display. */
13311 if (!just_this_one_p
13312 || current_buffer
->clip_changed
13313 || BEG_UNCHANGED
< CHARPOS (startp
))
13314 w
->base_line_number
= Qnil
;
13316 /* If cursor ends up on a partially visible line,
13317 treat that as being off the bottom of the screen. */
13318 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13320 clear_glyph_matrix (w
->desired_matrix
);
13321 ++extra_scroll_margin_lines
;
13324 rc
= SCROLLING_SUCCESS
;
13331 /* Compute a suitable window start for window W if display of W starts
13332 on a continuation line. Value is non-zero if a new window start
13335 The new window start will be computed, based on W's width, starting
13336 from the start of the continued line. It is the start of the
13337 screen line with the minimum distance from the old start W->start. */
13340 compute_window_start_on_continuation_line (struct window
*w
)
13342 struct text_pos pos
, start_pos
;
13343 int window_start_changed_p
= 0;
13345 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13347 /* If window start is on a continuation line... Window start may be
13348 < BEGV in case there's invisible text at the start of the
13349 buffer (M-x rmail, for example). */
13350 if (CHARPOS (start_pos
) > BEGV
13351 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13354 struct glyph_row
*row
;
13356 /* Handle the case that the window start is out of range. */
13357 if (CHARPOS (start_pos
) < BEGV
)
13358 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13359 else if (CHARPOS (start_pos
) > ZV
)
13360 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13362 /* Find the start of the continued line. This should be fast
13363 because scan_buffer is fast (newline cache). */
13364 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13365 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13366 row
, DEFAULT_FACE_ID
);
13367 reseat_at_previous_visible_line_start (&it
);
13369 /* If the line start is "too far" away from the window start,
13370 say it takes too much time to compute a new window start. */
13371 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13372 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13374 int min_distance
, distance
;
13376 /* Move forward by display lines to find the new window
13377 start. If window width was enlarged, the new start can
13378 be expected to be > the old start. If window width was
13379 decreased, the new window start will be < the old start.
13380 So, we're looking for the display line start with the
13381 minimum distance from the old window start. */
13382 pos
= it
.current
.pos
;
13383 min_distance
= INFINITY
;
13384 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13385 distance
< min_distance
)
13387 min_distance
= distance
;
13388 pos
= it
.current
.pos
;
13389 move_it_by_lines (&it
, 1, 0);
13392 /* Set the window start there. */
13393 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13394 window_start_changed_p
= 1;
13398 return window_start_changed_p
;
13402 /* Try cursor movement in case text has not changed in window WINDOW,
13403 with window start STARTP. Value is
13405 CURSOR_MOVEMENT_SUCCESS if successful
13407 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13409 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13410 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13411 we want to scroll as if scroll-step were set to 1. See the code.
13413 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13414 which case we have to abort this redisplay, and adjust matrices
13419 CURSOR_MOVEMENT_SUCCESS
,
13420 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13421 CURSOR_MOVEMENT_MUST_SCROLL
,
13422 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13426 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13428 struct window
*w
= XWINDOW (window
);
13429 struct frame
*f
= XFRAME (w
->frame
);
13430 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13433 if (inhibit_try_cursor_movement
)
13437 /* Handle case where text has not changed, only point, and it has
13438 not moved off the frame. */
13439 if (/* Point may be in this window. */
13440 PT
>= CHARPOS (startp
)
13441 /* Selective display hasn't changed. */
13442 && !current_buffer
->clip_changed
13443 /* Function force-mode-line-update is used to force a thorough
13444 redisplay. It sets either windows_or_buffers_changed or
13445 update_mode_lines. So don't take a shortcut here for these
13447 && !update_mode_lines
13448 && !windows_or_buffers_changed
13449 && !cursor_type_changed
13450 /* Can't use this case if highlighting a region. When a
13451 region exists, cursor movement has to do more than just
13453 && !(!NILP (Vtransient_mark_mode
)
13454 && !NILP (current_buffer
->mark_active
))
13455 && NILP (w
->region_showing
)
13456 && NILP (Vshow_trailing_whitespace
)
13457 /* Right after splitting windows, last_point may be nil. */
13458 && INTEGERP (w
->last_point
)
13459 /* This code is not used for mini-buffer for the sake of the case
13460 of redisplaying to replace an echo area message; since in
13461 that case the mini-buffer contents per se are usually
13462 unchanged. This code is of no real use in the mini-buffer
13463 since the handling of this_line_start_pos, etc., in redisplay
13464 handles the same cases. */
13465 && !EQ (window
, minibuf_window
)
13466 /* When splitting windows or for new windows, it happens that
13467 redisplay is called with a nil window_end_vpos or one being
13468 larger than the window. This should really be fixed in
13469 window.c. I don't have this on my list, now, so we do
13470 approximately the same as the old redisplay code. --gerd. */
13471 && INTEGERP (w
->window_end_vpos
)
13472 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13473 && (FRAME_WINDOW_P (f
)
13474 || !overlay_arrow_in_current_buffer_p ()))
13476 int this_scroll_margin
, top_scroll_margin
;
13477 struct glyph_row
*row
= NULL
;
13480 debug_method_add (w
, "cursor movement");
13483 /* Scroll if point within this distance from the top or bottom
13484 of the window. This is a pixel value. */
13485 if (scroll_margin
> 0)
13487 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13488 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13491 this_scroll_margin
= 0;
13493 top_scroll_margin
= this_scroll_margin
;
13494 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13495 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13497 /* Start with the row the cursor was displayed during the last
13498 not paused redisplay. Give up if that row is not valid. */
13499 if (w
->last_cursor
.vpos
< 0
13500 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13501 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13504 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13505 if (row
->mode_line_p
)
13507 if (!row
->enabled_p
)
13508 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13511 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13513 int scroll_p
= 0, must_scroll
= 0;
13514 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13516 if (PT
> XFASTINT (w
->last_point
))
13518 /* Point has moved forward. */
13519 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13520 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13522 xassert (row
->enabled_p
);
13526 /* If the end position of a row equals the start
13527 position of the next row, and PT is at that position,
13528 we would rather display cursor in the next line. */
13529 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13530 && MATRIX_ROW_END_CHARPOS (row
) == PT
13531 && row
< w
->current_matrix
->rows
13532 + w
->current_matrix
->nrows
- 1
13533 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13534 && !cursor_row_p (w
, row
))
13537 /* If within the scroll margin, scroll. Note that
13538 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13539 the next line would be drawn, and that
13540 this_scroll_margin can be zero. */
13541 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13542 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13543 /* Line is completely visible last line in window
13544 and PT is to be set in the next line. */
13545 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13546 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13547 && !row
->ends_at_zv_p
13548 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13551 else if (PT
< XFASTINT (w
->last_point
))
13553 /* Cursor has to be moved backward. Note that PT >=
13554 CHARPOS (startp) because of the outer if-statement. */
13555 while (!row
->mode_line_p
13556 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13557 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13558 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13559 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13560 row
> w
->current_matrix
->rows
13561 && (row
-1)->ends_in_newline_from_string_p
))))
13562 && (row
->y
> top_scroll_margin
13563 || CHARPOS (startp
) == BEGV
))
13565 xassert (row
->enabled_p
);
13569 /* Consider the following case: Window starts at BEGV,
13570 there is invisible, intangible text at BEGV, so that
13571 display starts at some point START > BEGV. It can
13572 happen that we are called with PT somewhere between
13573 BEGV and START. Try to handle that case. */
13574 if (row
< w
->current_matrix
->rows
13575 || row
->mode_line_p
)
13577 row
= w
->current_matrix
->rows
;
13578 if (row
->mode_line_p
)
13582 /* Due to newlines in overlay strings, we may have to
13583 skip forward over overlay strings. */
13584 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13585 && MATRIX_ROW_END_CHARPOS (row
) == PT
13586 && !cursor_row_p (w
, row
))
13589 /* If within the scroll margin, scroll. */
13590 if (row
->y
< top_scroll_margin
13591 && CHARPOS (startp
) != BEGV
)
13596 /* Cursor did not move. So don't scroll even if cursor line
13597 is partially visible, as it was so before. */
13598 rc
= CURSOR_MOVEMENT_SUCCESS
;
13601 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13602 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13604 /* if PT is not in the glyph row, give up. */
13605 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13608 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13609 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13611 /* If rows are bidi-reordered and point moved, back up
13612 until we find a row that does not belong to a
13613 continuation line. This is because we must consider
13614 all rows of a continued line as candidates for the
13615 new cursor positioning, since row start and end
13616 positions change non-linearly with vertical position
13618 /* FIXME: Revisit this when glyph ``spilling'' in
13619 continuation lines' rows is implemented for
13620 bidi-reordered rows. */
13621 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13623 xassert (row
->enabled_p
);
13625 /* If we hit the beginning of the displayed portion
13626 without finding the first row of a continued
13628 if (row
<= w
->current_matrix
->rows
)
13630 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13638 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13639 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13640 && make_cursor_line_fully_visible_p
)
13642 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13643 && !row
->ends_at_zv_p
13644 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13645 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13646 else if (row
->height
> window_box_height (w
))
13648 /* If we end up in a partially visible line, let's
13649 make it fully visible, except when it's taller
13650 than the window, in which case we can't do much
13653 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13657 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13658 if (!cursor_row_fully_visible_p (w
, 0, 1))
13659 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13661 rc
= CURSOR_MOVEMENT_SUCCESS
;
13665 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13666 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13667 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13669 /* With bidi-reordered rows, there could be more than
13670 one candidate row whose start and end positions
13671 occlude point. We need to let set_cursor_from_row
13672 find the best candidate. */
13673 /* FIXME: Revisit this when glyph ``spilling'' in
13674 continuation lines' rows is implemented for
13675 bidi-reordered rows. */
13680 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13681 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13682 && cursor_row_p (w
, row
))
13683 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13685 /* As soon as we've found the first suitable row
13686 whose ends_at_zv_p flag is set, we are done. */
13688 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13690 rc
= CURSOR_MOVEMENT_SUCCESS
;
13695 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13696 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13697 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13698 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13699 /* If we didn't find any candidate rows, or exited the
13700 loop before all the candidates were examined, signal
13701 to the caller that this method failed. */
13702 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13703 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13704 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13706 rc
= CURSOR_MOVEMENT_SUCCESS
;
13712 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13714 rc
= CURSOR_MOVEMENT_SUCCESS
;
13719 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13720 && MATRIX_ROW_START_CHARPOS (row
) == PT
13721 && cursor_row_p (w
, row
));
13730 set_vertical_scroll_bar (struct window
*w
)
13732 int start
, end
, whole
;
13734 /* Calculate the start and end positions for the current window.
13735 At some point, it would be nice to choose between scrollbars
13736 which reflect the whole buffer size, with special markers
13737 indicating narrowing, and scrollbars which reflect only the
13740 Note that mini-buffers sometimes aren't displaying any text. */
13741 if (!MINI_WINDOW_P (w
)
13742 || (w
== XWINDOW (minibuf_window
)
13743 && NILP (echo_area_buffer
[0])))
13745 struct buffer
*buf
= XBUFFER (w
->buffer
);
13746 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13747 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13748 /* I don't think this is guaranteed to be right. For the
13749 moment, we'll pretend it is. */
13750 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13754 if (whole
< (end
- start
))
13755 whole
= end
- start
;
13758 start
= end
= whole
= 0;
13760 /* Indicate what this scroll bar ought to be displaying now. */
13761 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13762 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13763 (w
, end
- start
, whole
, start
);
13767 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13768 selected_window is redisplayed.
13770 We can return without actually redisplaying the window if
13771 fonts_changed_p is nonzero. In that case, redisplay_internal will
13775 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13777 struct window
*w
= XWINDOW (window
);
13778 struct frame
*f
= XFRAME (w
->frame
);
13779 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13780 struct buffer
*old
= current_buffer
;
13781 struct text_pos lpoint
, opoint
, startp
;
13782 int update_mode_line
;
13785 /* Record it now because it's overwritten. */
13786 int current_matrix_up_to_date_p
= 0;
13787 int used_current_matrix_p
= 0;
13788 /* This is less strict than current_matrix_up_to_date_p.
13789 It indictes that the buffer contents and narrowing are unchanged. */
13790 int buffer_unchanged_p
= 0;
13791 int temp_scroll_step
= 0;
13792 int count
= SPECPDL_INDEX ();
13794 int centering_position
= -1;
13795 int last_line_misfit
= 0;
13796 int beg_unchanged
, end_unchanged
;
13798 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13801 /* W must be a leaf window here. */
13802 xassert (!NILP (w
->buffer
));
13804 *w
->desired_matrix
->method
= 0;
13808 reconsider_clip_changes (w
, buffer
);
13810 /* Has the mode line to be updated? */
13811 update_mode_line
= (!NILP (w
->update_mode_line
)
13812 || update_mode_lines
13813 || buffer
->clip_changed
13814 || buffer
->prevent_redisplay_optimizations_p
);
13816 if (MINI_WINDOW_P (w
))
13818 if (w
== XWINDOW (echo_area_window
)
13819 && !NILP (echo_area_buffer
[0]))
13821 if (update_mode_line
)
13822 /* We may have to update a tty frame's menu bar or a
13823 tool-bar. Example `M-x C-h C-h C-g'. */
13824 goto finish_menu_bars
;
13826 /* We've already displayed the echo area glyphs in this window. */
13827 goto finish_scroll_bars
;
13829 else if ((w
!= XWINDOW (minibuf_window
)
13830 || minibuf_level
== 0)
13831 /* When buffer is nonempty, redisplay window normally. */
13832 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13833 /* Quail displays non-mini buffers in minibuffer window.
13834 In that case, redisplay the window normally. */
13835 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13837 /* W is a mini-buffer window, but it's not active, so clear
13839 int yb
= window_text_bottom_y (w
);
13840 struct glyph_row
*row
;
13843 for (y
= 0, row
= w
->desired_matrix
->rows
;
13845 y
+= row
->height
, ++row
)
13846 blank_row (w
, row
, y
);
13847 goto finish_scroll_bars
;
13850 clear_glyph_matrix (w
->desired_matrix
);
13853 /* Otherwise set up data on this window; select its buffer and point
13855 /* Really select the buffer, for the sake of buffer-local
13857 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13859 current_matrix_up_to_date_p
13860 = (!NILP (w
->window_end_valid
)
13861 && !current_buffer
->clip_changed
13862 && !current_buffer
->prevent_redisplay_optimizations_p
13863 && XFASTINT (w
->last_modified
) >= MODIFF
13864 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13866 /* Run the window-bottom-change-functions
13867 if it is possible that the text on the screen has changed
13868 (either due to modification of the text, or any other reason). */
13869 if (!current_matrix_up_to_date_p
13870 && !NILP (Vwindow_text_change_functions
))
13872 safe_run_hooks (Qwindow_text_change_functions
);
13876 beg_unchanged
= BEG_UNCHANGED
;
13877 end_unchanged
= END_UNCHANGED
;
13879 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13881 specbind (Qinhibit_point_motion_hooks
, Qt
);
13884 = (!NILP (w
->window_end_valid
)
13885 && !current_buffer
->clip_changed
13886 && XFASTINT (w
->last_modified
) >= MODIFF
13887 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13889 /* When windows_or_buffers_changed is non-zero, we can't rely on
13890 the window end being valid, so set it to nil there. */
13891 if (windows_or_buffers_changed
)
13893 /* If window starts on a continuation line, maybe adjust the
13894 window start in case the window's width changed. */
13895 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13896 compute_window_start_on_continuation_line (w
);
13898 w
->window_end_valid
= Qnil
;
13901 /* Some sanity checks. */
13902 CHECK_WINDOW_END (w
);
13903 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13905 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13908 /* If %c is in mode line, update it if needed. */
13909 if (!NILP (w
->column_number_displayed
)
13910 /* This alternative quickly identifies a common case
13911 where no change is needed. */
13912 && !(PT
== XFASTINT (w
->last_point
)
13913 && XFASTINT (w
->last_modified
) >= MODIFF
13914 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13915 && (XFASTINT (w
->column_number_displayed
)
13916 != (int) current_column ())) /* iftc */
13917 update_mode_line
= 1;
13919 /* Count number of windows showing the selected buffer. An indirect
13920 buffer counts as its base buffer. */
13921 if (!just_this_one_p
)
13923 struct buffer
*current_base
, *window_base
;
13924 current_base
= current_buffer
;
13925 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13926 if (current_base
->base_buffer
)
13927 current_base
= current_base
->base_buffer
;
13928 if (window_base
->base_buffer
)
13929 window_base
= window_base
->base_buffer
;
13930 if (current_base
== window_base
)
13934 /* Point refers normally to the selected window. For any other
13935 window, set up appropriate value. */
13936 if (!EQ (window
, selected_window
))
13938 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13939 int new_pt_byte
= marker_byte_position (w
->pointm
);
13943 new_pt_byte
= BEGV_BYTE
;
13944 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13946 else if (new_pt
> (ZV
- 1))
13949 new_pt_byte
= ZV_BYTE
;
13950 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13953 /* We don't use SET_PT so that the point-motion hooks don't run. */
13954 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13957 /* If any of the character widths specified in the display table
13958 have changed, invalidate the width run cache. It's true that
13959 this may be a bit late to catch such changes, but the rest of
13960 redisplay goes (non-fatally) haywire when the display table is
13961 changed, so why should we worry about doing any better? */
13962 if (current_buffer
->width_run_cache
)
13964 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13966 if (! disptab_matches_widthtab (disptab
,
13967 XVECTOR (current_buffer
->width_table
)))
13969 invalidate_region_cache (current_buffer
,
13970 current_buffer
->width_run_cache
,
13972 recompute_width_table (current_buffer
, disptab
);
13976 /* If window-start is screwed up, choose a new one. */
13977 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13980 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13982 /* If someone specified a new starting point but did not insist,
13983 check whether it can be used. */
13984 if (!NILP (w
->optional_new_start
)
13985 && CHARPOS (startp
) >= BEGV
13986 && CHARPOS (startp
) <= ZV
)
13988 w
->optional_new_start
= Qnil
;
13989 start_display (&it
, w
, startp
);
13990 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13991 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13992 if (IT_CHARPOS (it
) == PT
)
13993 w
->force_start
= Qt
;
13994 /* IT may overshoot PT if text at PT is invisible. */
13995 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
13996 w
->force_start
= Qt
;
14001 /* Handle case where place to start displaying has been specified,
14002 unless the specified location is outside the accessible range. */
14003 if (!NILP (w
->force_start
)
14004 || w
->frozen_window_start_p
)
14006 /* We set this later on if we have to adjust point. */
14009 w
->force_start
= Qnil
;
14011 w
->window_end_valid
= Qnil
;
14013 /* Forget any recorded base line for line number display. */
14014 if (!buffer_unchanged_p
)
14015 w
->base_line_number
= Qnil
;
14017 /* Redisplay the mode line. Select the buffer properly for that.
14018 Also, run the hook window-scroll-functions
14019 because we have scrolled. */
14020 /* Note, we do this after clearing force_start because
14021 if there's an error, it is better to forget about force_start
14022 than to get into an infinite loop calling the hook functions
14023 and having them get more errors. */
14024 if (!update_mode_line
14025 || ! NILP (Vwindow_scroll_functions
))
14027 update_mode_line
= 1;
14028 w
->update_mode_line
= Qt
;
14029 startp
= run_window_scroll_functions (window
, startp
);
14032 w
->last_modified
= make_number (0);
14033 w
->last_overlay_modified
= make_number (0);
14034 if (CHARPOS (startp
) < BEGV
)
14035 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14036 else if (CHARPOS (startp
) > ZV
)
14037 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14039 /* Redisplay, then check if cursor has been set during the
14040 redisplay. Give up if new fonts were loaded. */
14041 /* We used to issue a CHECK_MARGINS argument to try_window here,
14042 but this causes scrolling to fail when point begins inside
14043 the scroll margin (bug#148) -- cyd */
14044 if (!try_window (window
, startp
, 0))
14046 w
->force_start
= Qt
;
14047 clear_glyph_matrix (w
->desired_matrix
);
14048 goto need_larger_matrices
;
14051 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14053 /* If point does not appear, try to move point so it does
14054 appear. The desired matrix has been built above, so we
14055 can use it here. */
14056 new_vpos
= window_box_height (w
) / 2;
14059 if (!cursor_row_fully_visible_p (w
, 0, 0))
14061 /* Point does appear, but on a line partly visible at end of window.
14062 Move it back to a fully-visible line. */
14063 new_vpos
= window_box_height (w
);
14066 /* If we need to move point for either of the above reasons,
14067 now actually do it. */
14070 struct glyph_row
*row
;
14072 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14073 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14076 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14077 MATRIX_ROW_START_BYTEPOS (row
));
14079 if (w
!= XWINDOW (selected_window
))
14080 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14081 else if (current_buffer
== old
)
14082 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14084 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14086 /* If we are highlighting the region, then we just changed
14087 the region, so redisplay to show it. */
14088 if (!NILP (Vtransient_mark_mode
)
14089 && !NILP (current_buffer
->mark_active
))
14091 clear_glyph_matrix (w
->desired_matrix
);
14092 if (!try_window (window
, startp
, 0))
14093 goto need_larger_matrices
;
14098 debug_method_add (w
, "forced window start");
14103 /* Handle case where text has not changed, only point, and it has
14104 not moved off the frame, and we are not retrying after hscroll.
14105 (current_matrix_up_to_date_p is nonzero when retrying.) */
14106 if (current_matrix_up_to_date_p
14107 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14108 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14112 case CURSOR_MOVEMENT_SUCCESS
:
14113 used_current_matrix_p
= 1;
14116 case CURSOR_MOVEMENT_MUST_SCROLL
:
14117 goto try_to_scroll
;
14123 /* If current starting point was originally the beginning of a line
14124 but no longer is, find a new starting point. */
14125 else if (!NILP (w
->start_at_line_beg
)
14126 && !(CHARPOS (startp
) <= BEGV
14127 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14130 debug_method_add (w
, "recenter 1");
14135 /* Try scrolling with try_window_id. Value is > 0 if update has
14136 been done, it is -1 if we know that the same window start will
14137 not work. It is 0 if unsuccessful for some other reason. */
14138 else if ((tem
= try_window_id (w
)) != 0)
14141 debug_method_add (w
, "try_window_id %d", tem
);
14144 if (fonts_changed_p
)
14145 goto need_larger_matrices
;
14149 /* Otherwise try_window_id has returned -1 which means that we
14150 don't want the alternative below this comment to execute. */
14152 else if (CHARPOS (startp
) >= BEGV
14153 && CHARPOS (startp
) <= ZV
14154 && PT
>= CHARPOS (startp
)
14155 && (CHARPOS (startp
) < ZV
14156 /* Avoid starting at end of buffer. */
14157 || CHARPOS (startp
) == BEGV
14158 || (XFASTINT (w
->last_modified
) >= MODIFF
14159 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14162 /* If first window line is a continuation line, and window start
14163 is inside the modified region, but the first change is before
14164 current window start, we must select a new window start.
14166 However, if this is the result of a down-mouse event (e.g. by
14167 extending the mouse-drag-overlay), we don't want to select a
14168 new window start, since that would change the position under
14169 the mouse, resulting in an unwanted mouse-movement rather
14170 than a simple mouse-click. */
14171 if (NILP (w
->start_at_line_beg
)
14172 && NILP (do_mouse_tracking
)
14173 && CHARPOS (startp
) > BEGV
14174 && CHARPOS (startp
) > BEG
+ beg_unchanged
14175 && CHARPOS (startp
) <= Z
- end_unchanged
14176 /* Even if w->start_at_line_beg is nil, a new window may
14177 start at a line_beg, since that's how set_buffer_window
14178 sets it. So, we need to check the return value of
14179 compute_window_start_on_continuation_line. (See also
14181 && XMARKER (w
->start
)->buffer
== current_buffer
14182 && compute_window_start_on_continuation_line (w
))
14184 w
->force_start
= Qt
;
14185 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14190 debug_method_add (w
, "same window start");
14193 /* Try to redisplay starting at same place as before.
14194 If point has not moved off frame, accept the results. */
14195 if (!current_matrix_up_to_date_p
14196 /* Don't use try_window_reusing_current_matrix in this case
14197 because a window scroll function can have changed the
14199 || !NILP (Vwindow_scroll_functions
)
14200 || MINI_WINDOW_P (w
)
14201 || !(used_current_matrix_p
14202 = try_window_reusing_current_matrix (w
)))
14204 IF_DEBUG (debug_method_add (w
, "1"));
14205 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14206 /* -1 means we need to scroll.
14207 0 means we need new matrices, but fonts_changed_p
14208 is set in that case, so we will detect it below. */
14209 goto try_to_scroll
;
14212 if (fonts_changed_p
)
14213 goto need_larger_matrices
;
14215 if (w
->cursor
.vpos
>= 0)
14217 if (!just_this_one_p
14218 || current_buffer
->clip_changed
14219 || BEG_UNCHANGED
< CHARPOS (startp
))
14220 /* Forget any recorded base line for line number display. */
14221 w
->base_line_number
= Qnil
;
14223 if (!cursor_row_fully_visible_p (w
, 1, 0))
14225 clear_glyph_matrix (w
->desired_matrix
);
14226 last_line_misfit
= 1;
14228 /* Drop through and scroll. */
14233 clear_glyph_matrix (w
->desired_matrix
);
14238 w
->last_modified
= make_number (0);
14239 w
->last_overlay_modified
= make_number (0);
14241 /* Redisplay the mode line. Select the buffer properly for that. */
14242 if (!update_mode_line
)
14244 update_mode_line
= 1;
14245 w
->update_mode_line
= Qt
;
14248 /* Try to scroll by specified few lines. */
14249 if ((scroll_conservatively
14251 || temp_scroll_step
14252 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14253 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14254 && !current_buffer
->clip_changed
14255 && CHARPOS (startp
) >= BEGV
14256 && CHARPOS (startp
) <= ZV
)
14258 /* The function returns -1 if new fonts were loaded, 1 if
14259 successful, 0 if not successful. */
14260 int rc
= try_scrolling (window
, just_this_one_p
,
14261 scroll_conservatively
,
14263 temp_scroll_step
, last_line_misfit
);
14266 case SCROLLING_SUCCESS
:
14269 case SCROLLING_NEED_LARGER_MATRICES
:
14270 goto need_larger_matrices
;
14272 case SCROLLING_FAILED
:
14280 /* Finally, just choose place to start which centers point */
14283 if (centering_position
< 0)
14284 centering_position
= window_box_height (w
) / 2;
14287 debug_method_add (w
, "recenter");
14290 /* w->vscroll = 0; */
14292 /* Forget any previously recorded base line for line number display. */
14293 if (!buffer_unchanged_p
)
14294 w
->base_line_number
= Qnil
;
14296 /* Move backward half the height of the window. */
14297 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14298 it
.current_y
= it
.last_visible_y
;
14299 move_it_vertically_backward (&it
, centering_position
);
14300 xassert (IT_CHARPOS (it
) >= BEGV
);
14302 /* The function move_it_vertically_backward may move over more
14303 than the specified y-distance. If it->w is small, e.g. a
14304 mini-buffer window, we may end up in front of the window's
14305 display area. Start displaying at the start of the line
14306 containing PT in this case. */
14307 if (it
.current_y
<= 0)
14309 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14310 move_it_vertically_backward (&it
, 0);
14314 it
.current_x
= it
.hpos
= 0;
14316 /* Set startp here explicitly in case that helps avoid an infinite loop
14317 in case the window-scroll-functions functions get errors. */
14318 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14320 /* Run scroll hooks. */
14321 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14323 /* Redisplay the window. */
14324 if (!current_matrix_up_to_date_p
14325 || windows_or_buffers_changed
14326 || cursor_type_changed
14327 /* Don't use try_window_reusing_current_matrix in this case
14328 because it can have changed the buffer. */
14329 || !NILP (Vwindow_scroll_functions
)
14330 || !just_this_one_p
14331 || MINI_WINDOW_P (w
)
14332 || !(used_current_matrix_p
14333 = try_window_reusing_current_matrix (w
)))
14334 try_window (window
, startp
, 0);
14336 /* If new fonts have been loaded (due to fontsets), give up. We
14337 have to start a new redisplay since we need to re-adjust glyph
14339 if (fonts_changed_p
)
14340 goto need_larger_matrices
;
14342 /* If cursor did not appear assume that the middle of the window is
14343 in the first line of the window. Do it again with the next line.
14344 (Imagine a window of height 100, displaying two lines of height
14345 60. Moving back 50 from it->last_visible_y will end in the first
14347 if (w
->cursor
.vpos
< 0)
14349 if (!NILP (w
->window_end_valid
)
14350 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14352 clear_glyph_matrix (w
->desired_matrix
);
14353 move_it_by_lines (&it
, 1, 0);
14354 try_window (window
, it
.current
.pos
, 0);
14356 else if (PT
< IT_CHARPOS (it
))
14358 clear_glyph_matrix (w
->desired_matrix
);
14359 move_it_by_lines (&it
, -1, 0);
14360 try_window (window
, it
.current
.pos
, 0);
14364 /* Not much we can do about it. */
14368 /* Consider the following case: Window starts at BEGV, there is
14369 invisible, intangible text at BEGV, so that display starts at
14370 some point START > BEGV. It can happen that we are called with
14371 PT somewhere between BEGV and START. Try to handle that case. */
14372 if (w
->cursor
.vpos
< 0)
14374 struct glyph_row
*row
= w
->current_matrix
->rows
;
14375 if (row
->mode_line_p
)
14377 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14380 if (!cursor_row_fully_visible_p (w
, 0, 0))
14382 /* If vscroll is enabled, disable it and try again. */
14386 clear_glyph_matrix (w
->desired_matrix
);
14390 /* If centering point failed to make the whole line visible,
14391 put point at the top instead. That has to make the whole line
14392 visible, if it can be done. */
14393 if (centering_position
== 0)
14396 clear_glyph_matrix (w
->desired_matrix
);
14397 centering_position
= 0;
14403 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14404 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14405 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14408 /* Display the mode line, if we must. */
14409 if ((update_mode_line
14410 /* If window not full width, must redo its mode line
14411 if (a) the window to its side is being redone and
14412 (b) we do a frame-based redisplay. This is a consequence
14413 of how inverted lines are drawn in frame-based redisplay. */
14414 || (!just_this_one_p
14415 && !FRAME_WINDOW_P (f
)
14416 && !WINDOW_FULL_WIDTH_P (w
))
14417 /* Line number to display. */
14418 || INTEGERP (w
->base_line_pos
)
14419 /* Column number is displayed and different from the one displayed. */
14420 || (!NILP (w
->column_number_displayed
)
14421 && (XFASTINT (w
->column_number_displayed
)
14422 != (int) current_column ()))) /* iftc */
14423 /* This means that the window has a mode line. */
14424 && (WINDOW_WANTS_MODELINE_P (w
)
14425 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14427 display_mode_lines (w
);
14429 /* If mode line height has changed, arrange for a thorough
14430 immediate redisplay using the correct mode line height. */
14431 if (WINDOW_WANTS_MODELINE_P (w
)
14432 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14434 fonts_changed_p
= 1;
14435 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14436 = DESIRED_MODE_LINE_HEIGHT (w
);
14439 /* If header line height has changed, arrange for a thorough
14440 immediate redisplay using the correct header line height. */
14441 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14442 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14444 fonts_changed_p
= 1;
14445 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14446 = DESIRED_HEADER_LINE_HEIGHT (w
);
14449 if (fonts_changed_p
)
14450 goto need_larger_matrices
;
14453 if (!line_number_displayed
14454 && !BUFFERP (w
->base_line_pos
))
14456 w
->base_line_pos
= Qnil
;
14457 w
->base_line_number
= Qnil
;
14462 /* When we reach a frame's selected window, redo the frame's menu bar. */
14463 if (update_mode_line
14464 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14466 int redisplay_menu_p
= 0;
14467 int redisplay_tool_bar_p
= 0;
14469 if (FRAME_WINDOW_P (f
))
14471 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14472 || defined (HAVE_NS) || defined (USE_GTK)
14473 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14475 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14479 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14481 if (redisplay_menu_p
)
14482 display_menu_bar (w
);
14484 #ifdef HAVE_WINDOW_SYSTEM
14485 if (FRAME_WINDOW_P (f
))
14487 #if defined (USE_GTK) || defined (HAVE_NS)
14488 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14490 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14491 && (FRAME_TOOL_BAR_LINES (f
) > 0
14492 || !NILP (Vauto_resize_tool_bars
));
14495 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14497 extern int ignore_mouse_drag_p
;
14498 ignore_mouse_drag_p
= 1;
14504 #ifdef HAVE_WINDOW_SYSTEM
14505 if (FRAME_WINDOW_P (f
)
14506 && update_window_fringes (w
, (just_this_one_p
14507 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14508 || w
->pseudo_window_p
)))
14512 if (draw_window_fringes (w
, 1))
14513 x_draw_vertical_border (w
);
14517 #endif /* HAVE_WINDOW_SYSTEM */
14519 /* We go to this label, with fonts_changed_p nonzero,
14520 if it is necessary to try again using larger glyph matrices.
14521 We have to redeem the scroll bar even in this case,
14522 because the loop in redisplay_internal expects that. */
14523 need_larger_matrices
:
14525 finish_scroll_bars
:
14527 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14529 /* Set the thumb's position and size. */
14530 set_vertical_scroll_bar (w
);
14532 /* Note that we actually used the scroll bar attached to this
14533 window, so it shouldn't be deleted at the end of redisplay. */
14534 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14535 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14538 /* Restore current_buffer and value of point in it. The window
14539 update may have changed the buffer, so first make sure `opoint'
14540 is still valid (Bug#6177). */
14541 if (CHARPOS (opoint
) < BEGV
)
14542 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14543 else if (CHARPOS (opoint
) > ZV
)
14544 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14546 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14548 set_buffer_internal_1 (old
);
14549 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14550 shorter. This can be caused by log truncation in *Messages*. */
14551 if (CHARPOS (lpoint
) <= ZV
)
14552 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14554 unbind_to (count
, Qnil
);
14558 /* Build the complete desired matrix of WINDOW with a window start
14559 buffer position POS.
14561 Value is 1 if successful. It is zero if fonts were loaded during
14562 redisplay which makes re-adjusting glyph matrices necessary, and -1
14563 if point would appear in the scroll margins.
14564 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14565 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14569 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14571 struct window
*w
= XWINDOW (window
);
14573 struct glyph_row
*last_text_row
= NULL
;
14574 struct frame
*f
= XFRAME (w
->frame
);
14576 /* Make POS the new window start. */
14577 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14579 /* Mark cursor position as unknown. No overlay arrow seen. */
14580 w
->cursor
.vpos
= -1;
14581 overlay_arrow_seen
= 0;
14583 /* Initialize iterator and info to start at POS. */
14584 start_display (&it
, w
, pos
);
14586 /* Display all lines of W. */
14587 while (it
.current_y
< it
.last_visible_y
)
14589 if (display_line (&it
))
14590 last_text_row
= it
.glyph_row
- 1;
14591 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14595 /* Don't let the cursor end in the scroll margins. */
14596 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14597 && !MINI_WINDOW_P (w
))
14599 int this_scroll_margin
;
14601 if (scroll_margin
> 0)
14603 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14604 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14607 this_scroll_margin
= 0;
14609 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14610 && w
->cursor
.y
< this_scroll_margin
14611 && CHARPOS (pos
) > BEGV
14612 && IT_CHARPOS (it
) < ZV
)
14613 /* rms: considering make_cursor_line_fully_visible_p here
14614 seems to give wrong results. We don't want to recenter
14615 when the last line is partly visible, we want to allow
14616 that case to be handled in the usual way. */
14617 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14619 w
->cursor
.vpos
= -1;
14620 clear_glyph_matrix (w
->desired_matrix
);
14625 /* If bottom moved off end of frame, change mode line percentage. */
14626 if (XFASTINT (w
->window_end_pos
) <= 0
14627 && Z
!= IT_CHARPOS (it
))
14628 w
->update_mode_line
= Qt
;
14630 /* Set window_end_pos to the offset of the last character displayed
14631 on the window from the end of current_buffer. Set
14632 window_end_vpos to its row number. */
14635 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14636 w
->window_end_bytepos
14637 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14639 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14641 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14642 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14643 ->displays_text_p
);
14647 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14648 w
->window_end_pos
= make_number (Z
- ZV
);
14649 w
->window_end_vpos
= make_number (0);
14652 /* But that is not valid info until redisplay finishes. */
14653 w
->window_end_valid
= Qnil
;
14659 /************************************************************************
14660 Window redisplay reusing current matrix when buffer has not changed
14661 ************************************************************************/
14663 /* Try redisplay of window W showing an unchanged buffer with a
14664 different window start than the last time it was displayed by
14665 reusing its current matrix. Value is non-zero if successful.
14666 W->start is the new window start. */
14669 try_window_reusing_current_matrix (struct window
*w
)
14671 struct frame
*f
= XFRAME (w
->frame
);
14672 struct glyph_row
*row
, *bottom_row
;
14675 struct text_pos start
, new_start
;
14676 int nrows_scrolled
, i
;
14677 struct glyph_row
*last_text_row
;
14678 struct glyph_row
*last_reused_text_row
;
14679 struct glyph_row
*start_row
;
14680 int start_vpos
, min_y
, max_y
;
14683 if (inhibit_try_window_reusing
)
14687 if (/* This function doesn't handle terminal frames. */
14688 !FRAME_WINDOW_P (f
)
14689 /* Don't try to reuse the display if windows have been split
14691 || windows_or_buffers_changed
14692 || cursor_type_changed
)
14695 /* Can't do this if region may have changed. */
14696 if ((!NILP (Vtransient_mark_mode
)
14697 && !NILP (current_buffer
->mark_active
))
14698 || !NILP (w
->region_showing
)
14699 || !NILP (Vshow_trailing_whitespace
))
14702 /* If top-line visibility has changed, give up. */
14703 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14704 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14707 /* Give up if old or new display is scrolled vertically. We could
14708 make this function handle this, but right now it doesn't. */
14709 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14710 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14713 /* The variable new_start now holds the new window start. The old
14714 start `start' can be determined from the current matrix. */
14715 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14716 start
= start_row
->minpos
;
14717 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14719 /* Clear the desired matrix for the display below. */
14720 clear_glyph_matrix (w
->desired_matrix
);
14722 if (CHARPOS (new_start
) <= CHARPOS (start
))
14726 /* Don't use this method if the display starts with an ellipsis
14727 displayed for invisible text. It's not easy to handle that case
14728 below, and it's certainly not worth the effort since this is
14729 not a frequent case. */
14730 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14733 IF_DEBUG (debug_method_add (w
, "twu1"));
14735 /* Display up to a row that can be reused. The variable
14736 last_text_row is set to the last row displayed that displays
14737 text. Note that it.vpos == 0 if or if not there is a
14738 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14739 start_display (&it
, w
, new_start
);
14740 first_row_y
= it
.current_y
;
14741 w
->cursor
.vpos
= -1;
14742 last_text_row
= last_reused_text_row
= NULL
;
14744 while (it
.current_y
< it
.last_visible_y
14745 && !fonts_changed_p
)
14747 /* If we have reached into the characters in the START row,
14748 that means the line boundaries have changed. So we
14749 can't start copying with the row START. Maybe it will
14750 work to start copying with the following row. */
14751 while (IT_CHARPOS (it
) > CHARPOS (start
))
14753 /* Advance to the next row as the "start". */
14755 start
= start_row
->minpos
;
14756 /* If there are no more rows to try, or just one, give up. */
14757 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14758 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14759 || CHARPOS (start
) == ZV
)
14761 clear_glyph_matrix (w
->desired_matrix
);
14765 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14767 /* If we have reached alignment,
14768 we can copy the rest of the rows. */
14769 if (IT_CHARPOS (it
) == CHARPOS (start
))
14772 if (display_line (&it
))
14773 last_text_row
= it
.glyph_row
- 1;
14776 /* A value of current_y < last_visible_y means that we stopped
14777 at the previous window start, which in turn means that we
14778 have at least one reusable row. */
14779 if (it
.current_y
< it
.last_visible_y
)
14781 /* IT.vpos always starts from 0; it counts text lines. */
14782 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14784 /* Find PT if not already found in the lines displayed. */
14785 if (w
->cursor
.vpos
< 0)
14787 int dy
= it
.current_y
- start_row
->y
;
14789 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14790 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14792 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14793 dy
, nrows_scrolled
);
14796 clear_glyph_matrix (w
->desired_matrix
);
14801 /* Scroll the display. Do it before the current matrix is
14802 changed. The problem here is that update has not yet
14803 run, i.e. part of the current matrix is not up to date.
14804 scroll_run_hook will clear the cursor, and use the
14805 current matrix to get the height of the row the cursor is
14807 run
.current_y
= start_row
->y
;
14808 run
.desired_y
= it
.current_y
;
14809 run
.height
= it
.last_visible_y
- it
.current_y
;
14811 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14814 FRAME_RIF (f
)->update_window_begin_hook (w
);
14815 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14816 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14817 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14821 /* Shift current matrix down by nrows_scrolled lines. */
14822 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14823 rotate_matrix (w
->current_matrix
,
14825 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14828 /* Disable lines that must be updated. */
14829 for (i
= 0; i
< nrows_scrolled
; ++i
)
14830 (start_row
+ i
)->enabled_p
= 0;
14832 /* Re-compute Y positions. */
14833 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14834 max_y
= it
.last_visible_y
;
14835 for (row
= start_row
+ nrows_scrolled
;
14839 row
->y
= it
.current_y
;
14840 row
->visible_height
= row
->height
;
14842 if (row
->y
< min_y
)
14843 row
->visible_height
-= min_y
- row
->y
;
14844 if (row
->y
+ row
->height
> max_y
)
14845 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14846 row
->redraw_fringe_bitmaps_p
= 1;
14848 it
.current_y
+= row
->height
;
14850 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14851 last_reused_text_row
= row
;
14852 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14856 /* Disable lines in the current matrix which are now
14857 below the window. */
14858 for (++row
; row
< bottom_row
; ++row
)
14859 row
->enabled_p
= row
->mode_line_p
= 0;
14862 /* Update window_end_pos etc.; last_reused_text_row is the last
14863 reused row from the current matrix containing text, if any.
14864 The value of last_text_row is the last displayed line
14865 containing text. */
14866 if (last_reused_text_row
)
14868 w
->window_end_bytepos
14869 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14871 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14873 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14874 w
->current_matrix
));
14876 else if (last_text_row
)
14878 w
->window_end_bytepos
14879 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14881 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14883 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14887 /* This window must be completely empty. */
14888 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14889 w
->window_end_pos
= make_number (Z
- ZV
);
14890 w
->window_end_vpos
= make_number (0);
14892 w
->window_end_valid
= Qnil
;
14894 /* Update hint: don't try scrolling again in update_window. */
14895 w
->desired_matrix
->no_scrolling_p
= 1;
14898 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14902 else if (CHARPOS (new_start
) > CHARPOS (start
))
14904 struct glyph_row
*pt_row
, *row
;
14905 struct glyph_row
*first_reusable_row
;
14906 struct glyph_row
*first_row_to_display
;
14908 int yb
= window_text_bottom_y (w
);
14910 /* Find the row starting at new_start, if there is one. Don't
14911 reuse a partially visible line at the end. */
14912 first_reusable_row
= start_row
;
14913 while (first_reusable_row
->enabled_p
14914 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14915 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14916 < CHARPOS (new_start
)))
14917 ++first_reusable_row
;
14919 /* Give up if there is no row to reuse. */
14920 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14921 || !first_reusable_row
->enabled_p
14922 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14923 != CHARPOS (new_start
)))
14926 /* We can reuse fully visible rows beginning with
14927 first_reusable_row to the end of the window. Set
14928 first_row_to_display to the first row that cannot be reused.
14929 Set pt_row to the row containing point, if there is any. */
14931 for (first_row_to_display
= first_reusable_row
;
14932 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14933 ++first_row_to_display
)
14935 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14936 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14937 pt_row
= first_row_to_display
;
14940 /* Start displaying at the start of first_row_to_display. */
14941 xassert (first_row_to_display
->y
< yb
);
14942 init_to_row_start (&it
, w
, first_row_to_display
);
14944 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14946 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14948 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14949 + WINDOW_HEADER_LINE_HEIGHT (w
));
14951 /* Display lines beginning with first_row_to_display in the
14952 desired matrix. Set last_text_row to the last row displayed
14953 that displays text. */
14954 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14955 if (pt_row
== NULL
)
14956 w
->cursor
.vpos
= -1;
14957 last_text_row
= NULL
;
14958 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14959 if (display_line (&it
))
14960 last_text_row
= it
.glyph_row
- 1;
14962 /* If point is in a reused row, adjust y and vpos of the cursor
14966 w
->cursor
.vpos
-= nrows_scrolled
;
14967 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14970 /* Give up if point isn't in a row displayed or reused. (This
14971 also handles the case where w->cursor.vpos < nrows_scrolled
14972 after the calls to display_line, which can happen with scroll
14973 margins. See bug#1295.) */
14974 if (w
->cursor
.vpos
< 0)
14976 clear_glyph_matrix (w
->desired_matrix
);
14980 /* Scroll the display. */
14981 run
.current_y
= first_reusable_row
->y
;
14982 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14983 run
.height
= it
.last_visible_y
- run
.current_y
;
14984 dy
= run
.current_y
- run
.desired_y
;
14989 FRAME_RIF (f
)->update_window_begin_hook (w
);
14990 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14991 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14992 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14996 /* Adjust Y positions of reused rows. */
14997 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14998 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14999 max_y
= it
.last_visible_y
;
15000 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15003 row
->visible_height
= row
->height
;
15004 if (row
->y
< min_y
)
15005 row
->visible_height
-= min_y
- row
->y
;
15006 if (row
->y
+ row
->height
> max_y
)
15007 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15008 row
->redraw_fringe_bitmaps_p
= 1;
15011 /* Scroll the current matrix. */
15012 xassert (nrows_scrolled
> 0);
15013 rotate_matrix (w
->current_matrix
,
15015 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15018 /* Disable rows not reused. */
15019 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15020 row
->enabled_p
= 0;
15022 /* Point may have moved to a different line, so we cannot assume that
15023 the previous cursor position is valid; locate the correct row. */
15026 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15027 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15031 w
->cursor
.y
= row
->y
;
15033 if (row
< bottom_row
)
15035 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15036 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15038 /* Can't use this optimization with bidi-reordered glyph
15039 rows, unless cursor is already at point. */
15040 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15042 if (!(w
->cursor
.hpos
>= 0
15043 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15044 && BUFFERP (glyph
->object
)
15045 && glyph
->charpos
== PT
))
15050 && (!BUFFERP (glyph
->object
)
15051 || glyph
->charpos
< PT
);
15055 w
->cursor
.x
+= glyph
->pixel_width
;
15060 /* Adjust window end. A null value of last_text_row means that
15061 the window end is in reused rows which in turn means that
15062 only its vpos can have changed. */
15065 w
->window_end_bytepos
15066 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15068 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15070 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15075 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15078 w
->window_end_valid
= Qnil
;
15079 w
->desired_matrix
->no_scrolling_p
= 1;
15082 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15092 /************************************************************************
15093 Window redisplay reusing current matrix when buffer has changed
15094 ************************************************************************/
15096 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15097 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15099 static struct glyph_row
*
15100 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15101 struct glyph_row
*);
15104 /* Return the last row in MATRIX displaying text. If row START is
15105 non-null, start searching with that row. IT gives the dimensions
15106 of the display. Value is null if matrix is empty; otherwise it is
15107 a pointer to the row found. */
15109 static struct glyph_row
*
15110 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15111 struct glyph_row
*start
)
15113 struct glyph_row
*row
, *row_found
;
15115 /* Set row_found to the last row in IT->w's current matrix
15116 displaying text. The loop looks funny but think of partially
15119 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15120 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15122 xassert (row
->enabled_p
);
15124 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15133 /* Return the last row in the current matrix of W that is not affected
15134 by changes at the start of current_buffer that occurred since W's
15135 current matrix was built. Value is null if no such row exists.
15137 BEG_UNCHANGED us the number of characters unchanged at the start of
15138 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15139 first changed character in current_buffer. Characters at positions <
15140 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15141 when the current matrix was built. */
15143 static struct glyph_row
*
15144 find_last_unchanged_at_beg_row (struct window
*w
)
15146 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15147 struct glyph_row
*row
;
15148 struct glyph_row
*row_found
= NULL
;
15149 int yb
= window_text_bottom_y (w
);
15151 /* Find the last row displaying unchanged text. */
15152 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15153 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15154 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15157 if (/* If row ends before first_changed_pos, it is unchanged,
15158 except in some case. */
15159 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15160 /* When row ends in ZV and we write at ZV it is not
15162 && !row
->ends_at_zv_p
15163 /* When first_changed_pos is the end of a continued line,
15164 row is not unchanged because it may be no longer
15166 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15167 && (row
->continued_p
15168 || row
->exact_window_width_line_p
)))
15171 /* Stop if last visible row. */
15172 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15180 /* Find the first glyph row in the current matrix of W that is not
15181 affected by changes at the end of current_buffer since the
15182 time W's current matrix was built.
15184 Return in *DELTA the number of chars by which buffer positions in
15185 unchanged text at the end of current_buffer must be adjusted.
15187 Return in *DELTA_BYTES the corresponding number of bytes.
15189 Value is null if no such row exists, i.e. all rows are affected by
15192 static struct glyph_row
*
15193 find_first_unchanged_at_end_row (struct window
*w
, int *delta
, int *delta_bytes
)
15195 struct glyph_row
*row
;
15196 struct glyph_row
*row_found
= NULL
;
15198 *delta
= *delta_bytes
= 0;
15200 /* Display must not have been paused, otherwise the current matrix
15201 is not up to date. */
15202 eassert (!NILP (w
->window_end_valid
));
15204 /* A value of window_end_pos >= END_UNCHANGED means that the window
15205 end is in the range of changed text. If so, there is no
15206 unchanged row at the end of W's current matrix. */
15207 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15210 /* Set row to the last row in W's current matrix displaying text. */
15211 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15213 /* If matrix is entirely empty, no unchanged row exists. */
15214 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15216 /* The value of row is the last glyph row in the matrix having a
15217 meaningful buffer position in it. The end position of row
15218 corresponds to window_end_pos. This allows us to translate
15219 buffer positions in the current matrix to current buffer
15220 positions for characters not in changed text. */
15221 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15222 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15223 int last_unchanged_pos
, last_unchanged_pos_old
;
15224 struct glyph_row
*first_text_row
15225 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15227 *delta
= Z
- Z_old
;
15228 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15230 /* Set last_unchanged_pos to the buffer position of the last
15231 character in the buffer that has not been changed. Z is the
15232 index + 1 of the last character in current_buffer, i.e. by
15233 subtracting END_UNCHANGED we get the index of the last
15234 unchanged character, and we have to add BEG to get its buffer
15236 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15237 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15239 /* Search backward from ROW for a row displaying a line that
15240 starts at a minimum position >= last_unchanged_pos_old. */
15241 for (; row
> first_text_row
; --row
)
15243 /* This used to abort, but it can happen.
15244 It is ok to just stop the search instead here. KFS. */
15245 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15248 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15253 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15259 /* Make sure that glyph rows in the current matrix of window W
15260 reference the same glyph memory as corresponding rows in the
15261 frame's frame matrix. This function is called after scrolling W's
15262 current matrix on a terminal frame in try_window_id and
15263 try_window_reusing_current_matrix. */
15266 sync_frame_with_window_matrix_rows (struct window
*w
)
15268 struct frame
*f
= XFRAME (w
->frame
);
15269 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15271 /* Preconditions: W must be a leaf window and full-width. Its frame
15272 must have a frame matrix. */
15273 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15274 xassert (WINDOW_FULL_WIDTH_P (w
));
15275 xassert (!FRAME_WINDOW_P (f
));
15277 /* If W is a full-width window, glyph pointers in W's current matrix
15278 have, by definition, to be the same as glyph pointers in the
15279 corresponding frame matrix. Note that frame matrices have no
15280 marginal areas (see build_frame_matrix). */
15281 window_row
= w
->current_matrix
->rows
;
15282 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15283 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15284 while (window_row
< window_row_end
)
15286 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15287 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15289 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15290 frame_row
->glyphs
[TEXT_AREA
] = start
;
15291 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15292 frame_row
->glyphs
[LAST_AREA
] = end
;
15294 /* Disable frame rows whose corresponding window rows have
15295 been disabled in try_window_id. */
15296 if (!window_row
->enabled_p
)
15297 frame_row
->enabled_p
= 0;
15299 ++window_row
, ++frame_row
;
15304 /* Find the glyph row in window W containing CHARPOS. Consider all
15305 rows between START and END (not inclusive). END null means search
15306 all rows to the end of the display area of W. Value is the row
15307 containing CHARPOS or null. */
15310 row_containing_pos (struct window
*w
, int charpos
, struct glyph_row
*start
,
15311 struct glyph_row
*end
, int dy
)
15313 struct glyph_row
*row
= start
;
15314 struct glyph_row
*best_row
= NULL
;
15315 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15318 /* If we happen to start on a header-line, skip that. */
15319 if (row
->mode_line_p
)
15322 if ((end
&& row
>= end
) || !row
->enabled_p
)
15325 last_y
= window_text_bottom_y (w
) - dy
;
15329 /* Give up if we have gone too far. */
15330 if (end
&& row
>= end
)
15332 /* This formerly returned if they were equal.
15333 I think that both quantities are of a "last plus one" type;
15334 if so, when they are equal, the row is within the screen. -- rms. */
15335 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15338 /* If it is in this row, return this row. */
15339 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15340 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15341 /* The end position of a row equals the start
15342 position of the next row. If CHARPOS is there, we
15343 would rather display it in the next line, except
15344 when this line ends in ZV. */
15345 && !row
->ends_at_zv_p
15346 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15347 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15351 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15353 /* In bidi-reordered rows, there could be several rows
15354 occluding point. We need to find the one which fits
15355 CHARPOS the best. */
15356 for (g
= row
->glyphs
[TEXT_AREA
];
15357 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15360 if (!STRINGP (g
->object
))
15362 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15364 mindif
= eabs (g
->charpos
- charpos
);
15377 /* Try to redisplay window W by reusing its existing display. W's
15378 current matrix must be up to date when this function is called,
15379 i.e. window_end_valid must not be nil.
15383 1 if display has been updated
15384 0 if otherwise unsuccessful
15385 -1 if redisplay with same window start is known not to succeed
15387 The following steps are performed:
15389 1. Find the last row in the current matrix of W that is not
15390 affected by changes at the start of current_buffer. If no such row
15393 2. Find the first row in W's current matrix that is not affected by
15394 changes at the end of current_buffer. Maybe there is no such row.
15396 3. Display lines beginning with the row + 1 found in step 1 to the
15397 row found in step 2 or, if step 2 didn't find a row, to the end of
15400 4. If cursor is not known to appear on the window, give up.
15402 5. If display stopped at the row found in step 2, scroll the
15403 display and current matrix as needed.
15405 6. Maybe display some lines at the end of W, if we must. This can
15406 happen under various circumstances, like a partially visible line
15407 becoming fully visible, or because newly displayed lines are displayed
15408 in smaller font sizes.
15410 7. Update W's window end information. */
15413 try_window_id (struct window
*w
)
15415 struct frame
*f
= XFRAME (w
->frame
);
15416 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15417 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15418 struct glyph_row
*last_unchanged_at_beg_row
;
15419 struct glyph_row
*first_unchanged_at_end_row
;
15420 struct glyph_row
*row
;
15421 struct glyph_row
*bottom_row
;
15424 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15425 struct text_pos start_pos
;
15427 int first_unchanged_at_end_vpos
= 0;
15428 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15429 struct text_pos start
;
15430 int first_changed_charpos
, last_changed_charpos
;
15433 if (inhibit_try_window_id
)
15437 /* This is handy for debugging. */
15439 #define GIVE_UP(X) \
15441 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15445 #define GIVE_UP(X) return 0
15448 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15450 /* Don't use this for mini-windows because these can show
15451 messages and mini-buffers, and we don't handle that here. */
15452 if (MINI_WINDOW_P (w
))
15455 /* This flag is used to prevent redisplay optimizations. */
15456 if (windows_or_buffers_changed
|| cursor_type_changed
)
15459 /* Verify that narrowing has not changed.
15460 Also verify that we were not told to prevent redisplay optimizations.
15461 It would be nice to further
15462 reduce the number of cases where this prevents try_window_id. */
15463 if (current_buffer
->clip_changed
15464 || current_buffer
->prevent_redisplay_optimizations_p
)
15467 /* Window must either use window-based redisplay or be full width. */
15468 if (!FRAME_WINDOW_P (f
)
15469 && (!FRAME_LINE_INS_DEL_OK (f
)
15470 || !WINDOW_FULL_WIDTH_P (w
)))
15473 /* Give up if point is known NOT to appear in W. */
15474 if (PT
< CHARPOS (start
))
15477 /* Another way to prevent redisplay optimizations. */
15478 if (XFASTINT (w
->last_modified
) == 0)
15481 /* Verify that window is not hscrolled. */
15482 if (XFASTINT (w
->hscroll
) != 0)
15485 /* Verify that display wasn't paused. */
15486 if (NILP (w
->window_end_valid
))
15489 /* Can't use this if highlighting a region because a cursor movement
15490 will do more than just set the cursor. */
15491 if (!NILP (Vtransient_mark_mode
)
15492 && !NILP (current_buffer
->mark_active
))
15495 /* Likewise if highlighting trailing whitespace. */
15496 if (!NILP (Vshow_trailing_whitespace
))
15499 /* Likewise if showing a region. */
15500 if (!NILP (w
->region_showing
))
15503 /* Can't use this if overlay arrow position and/or string have
15505 if (overlay_arrows_changed_p ())
15508 /* When word-wrap is on, adding a space to the first word of a
15509 wrapped line can change the wrap position, altering the line
15510 above it. It might be worthwhile to handle this more
15511 intelligently, but for now just redisplay from scratch. */
15512 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15515 /* Under bidi reordering, adding or deleting a character in the
15516 beginning of a paragraph, before the first strong directional
15517 character, can change the base direction of the paragraph (unless
15518 the buffer specifies a fixed paragraph direction), which will
15519 require to redisplay the whole paragraph. It might be worthwhile
15520 to find the paragraph limits and widen the range of redisplayed
15521 lines to that, but for now just give up this optimization and
15522 redisplay from scratch. */
15523 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15524 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15527 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15528 only if buffer has really changed. The reason is that the gap is
15529 initially at Z for freshly visited files. The code below would
15530 set end_unchanged to 0 in that case. */
15531 if (MODIFF
> SAVE_MODIFF
15532 /* This seems to happen sometimes after saving a buffer. */
15533 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15535 if (GPT
- BEG
< BEG_UNCHANGED
)
15536 BEG_UNCHANGED
= GPT
- BEG
;
15537 if (Z
- GPT
< END_UNCHANGED
)
15538 END_UNCHANGED
= Z
- GPT
;
15541 /* The position of the first and last character that has been changed. */
15542 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15543 last_changed_charpos
= Z
- END_UNCHANGED
;
15545 /* If window starts after a line end, and the last change is in
15546 front of that newline, then changes don't affect the display.
15547 This case happens with stealth-fontification. Note that although
15548 the display is unchanged, glyph positions in the matrix have to
15549 be adjusted, of course. */
15550 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15551 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15552 && ((last_changed_charpos
< CHARPOS (start
)
15553 && CHARPOS (start
) == BEGV
)
15554 || (last_changed_charpos
< CHARPOS (start
) - 1
15555 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15557 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15558 struct glyph_row
*r0
;
15560 /* Compute how many chars/bytes have been added to or removed
15561 from the buffer. */
15562 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15563 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15565 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15567 /* Give up if PT is not in the window. Note that it already has
15568 been checked at the start of try_window_id that PT is not in
15569 front of the window start. */
15570 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15573 /* If window start is unchanged, we can reuse the whole matrix
15574 as is, after adjusting glyph positions. No need to compute
15575 the window end again, since its offset from Z hasn't changed. */
15576 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15577 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15578 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15579 /* PT must not be in a partially visible line. */
15580 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15581 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15583 /* Adjust positions in the glyph matrix. */
15584 if (delta
|| delta_bytes
)
15586 struct glyph_row
*r1
15587 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15588 increment_matrix_positions (w
->current_matrix
,
15589 MATRIX_ROW_VPOS (r0
, current_matrix
),
15590 MATRIX_ROW_VPOS (r1
, current_matrix
),
15591 delta
, delta_bytes
);
15594 /* Set the cursor. */
15595 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15597 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15604 /* Handle the case that changes are all below what is displayed in
15605 the window, and that PT is in the window. This shortcut cannot
15606 be taken if ZV is visible in the window, and text has been added
15607 there that is visible in the window. */
15608 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15609 /* ZV is not visible in the window, or there are no
15610 changes at ZV, actually. */
15611 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15612 || first_changed_charpos
== last_changed_charpos
))
15614 struct glyph_row
*r0
;
15616 /* Give up if PT is not in the window. Note that it already has
15617 been checked at the start of try_window_id that PT is not in
15618 front of the window start. */
15619 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15622 /* If window start is unchanged, we can reuse the whole matrix
15623 as is, without changing glyph positions since no text has
15624 been added/removed in front of the window end. */
15625 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15626 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15627 /* PT must not be in a partially visible line. */
15628 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15629 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15631 /* We have to compute the window end anew since text
15632 could have been added/removed after it. */
15634 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15635 w
->window_end_bytepos
15636 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15638 /* Set the cursor. */
15639 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15641 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15648 /* Give up if window start is in the changed area.
15650 The condition used to read
15652 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15654 but why that was tested escapes me at the moment. */
15655 if (CHARPOS (start
) >= first_changed_charpos
15656 && CHARPOS (start
) <= last_changed_charpos
)
15659 /* Check that window start agrees with the start of the first glyph
15660 row in its current matrix. Check this after we know the window
15661 start is not in changed text, otherwise positions would not be
15663 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15664 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15667 /* Give up if the window ends in strings. Overlay strings
15668 at the end are difficult to handle, so don't try. */
15669 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15670 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15673 /* Compute the position at which we have to start displaying new
15674 lines. Some of the lines at the top of the window might be
15675 reusable because they are not displaying changed text. Find the
15676 last row in W's current matrix not affected by changes at the
15677 start of current_buffer. Value is null if changes start in the
15678 first line of window. */
15679 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15680 if (last_unchanged_at_beg_row
)
15682 /* Avoid starting to display in the moddle of a character, a TAB
15683 for instance. This is easier than to set up the iterator
15684 exactly, and it's not a frequent case, so the additional
15685 effort wouldn't really pay off. */
15686 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15687 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15688 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15689 --last_unchanged_at_beg_row
;
15691 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15694 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15696 start_pos
= it
.current
.pos
;
15698 /* Start displaying new lines in the desired matrix at the same
15699 vpos we would use in the current matrix, i.e. below
15700 last_unchanged_at_beg_row. */
15701 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15703 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15704 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15706 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15710 /* There are no reusable lines at the start of the window.
15711 Start displaying in the first text line. */
15712 start_display (&it
, w
, start
);
15713 it
.vpos
= it
.first_vpos
;
15714 start_pos
= it
.current
.pos
;
15717 /* Find the first row that is not affected by changes at the end of
15718 the buffer. Value will be null if there is no unchanged row, in
15719 which case we must redisplay to the end of the window. delta
15720 will be set to the value by which buffer positions beginning with
15721 first_unchanged_at_end_row have to be adjusted due to text
15723 first_unchanged_at_end_row
15724 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15725 IF_DEBUG (debug_delta
= delta
);
15726 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15728 /* Set stop_pos to the buffer position up to which we will have to
15729 display new lines. If first_unchanged_at_end_row != NULL, this
15730 is the buffer position of the start of the line displayed in that
15731 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15732 that we don't stop at a buffer position. */
15734 if (first_unchanged_at_end_row
)
15736 xassert (last_unchanged_at_beg_row
== NULL
15737 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15739 /* If this is a continuation line, move forward to the next one
15740 that isn't. Changes in lines above affect this line.
15741 Caution: this may move first_unchanged_at_end_row to a row
15742 not displaying text. */
15743 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15744 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15745 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15746 < it
.last_visible_y
))
15747 ++first_unchanged_at_end_row
;
15749 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15750 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15751 >= it
.last_visible_y
))
15752 first_unchanged_at_end_row
= NULL
;
15755 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15757 first_unchanged_at_end_vpos
15758 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15759 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15762 else if (last_unchanged_at_beg_row
== NULL
)
15768 /* Either there is no unchanged row at the end, or the one we have
15769 now displays text. This is a necessary condition for the window
15770 end pos calculation at the end of this function. */
15771 xassert (first_unchanged_at_end_row
== NULL
15772 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15774 debug_last_unchanged_at_beg_vpos
15775 = (last_unchanged_at_beg_row
15776 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15778 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15780 #endif /* GLYPH_DEBUG != 0 */
15783 /* Display new lines. Set last_text_row to the last new line
15784 displayed which has text on it, i.e. might end up as being the
15785 line where the window_end_vpos is. */
15786 w
->cursor
.vpos
= -1;
15787 last_text_row
= NULL
;
15788 overlay_arrow_seen
= 0;
15789 while (it
.current_y
< it
.last_visible_y
15790 && !fonts_changed_p
15791 && (first_unchanged_at_end_row
== NULL
15792 || IT_CHARPOS (it
) < stop_pos
))
15794 if (display_line (&it
))
15795 last_text_row
= it
.glyph_row
- 1;
15798 if (fonts_changed_p
)
15802 /* Compute differences in buffer positions, y-positions etc. for
15803 lines reused at the bottom of the window. Compute what we can
15805 if (first_unchanged_at_end_row
15806 /* No lines reused because we displayed everything up to the
15807 bottom of the window. */
15808 && it
.current_y
< it
.last_visible_y
)
15811 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15813 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15814 run
.current_y
= first_unchanged_at_end_row
->y
;
15815 run
.desired_y
= run
.current_y
+ dy
;
15816 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15820 delta
= delta_bytes
= dvpos
= dy
15821 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15822 first_unchanged_at_end_row
= NULL
;
15824 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15827 /* Find the cursor if not already found. We have to decide whether
15828 PT will appear on this window (it sometimes doesn't, but this is
15829 not a very frequent case.) This decision has to be made before
15830 the current matrix is altered. A value of cursor.vpos < 0 means
15831 that PT is either in one of the lines beginning at
15832 first_unchanged_at_end_row or below the window. Don't care for
15833 lines that might be displayed later at the window end; as
15834 mentioned, this is not a frequent case. */
15835 if (w
->cursor
.vpos
< 0)
15837 /* Cursor in unchanged rows at the top? */
15838 if (PT
< CHARPOS (start_pos
)
15839 && last_unchanged_at_beg_row
)
15841 row
= row_containing_pos (w
, PT
,
15842 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15843 last_unchanged_at_beg_row
+ 1, 0);
15845 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15848 /* Start from first_unchanged_at_end_row looking for PT. */
15849 else if (first_unchanged_at_end_row
)
15851 row
= row_containing_pos (w
, PT
- delta
,
15852 first_unchanged_at_end_row
, NULL
, 0);
15854 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15855 delta_bytes
, dy
, dvpos
);
15858 /* Give up if cursor was not found. */
15859 if (w
->cursor
.vpos
< 0)
15861 clear_glyph_matrix (w
->desired_matrix
);
15866 /* Don't let the cursor end in the scroll margins. */
15868 int this_scroll_margin
, cursor_height
;
15870 this_scroll_margin
= max (0, scroll_margin
);
15871 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15872 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15873 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15875 if ((w
->cursor
.y
< this_scroll_margin
15876 && CHARPOS (start
) > BEGV
)
15877 /* Old redisplay didn't take scroll margin into account at the bottom,
15878 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15879 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15880 ? cursor_height
+ this_scroll_margin
15881 : 1)) > it
.last_visible_y
)
15883 w
->cursor
.vpos
= -1;
15884 clear_glyph_matrix (w
->desired_matrix
);
15889 /* Scroll the display. Do it before changing the current matrix so
15890 that xterm.c doesn't get confused about where the cursor glyph is
15892 if (dy
&& run
.height
)
15896 if (FRAME_WINDOW_P (f
))
15898 FRAME_RIF (f
)->update_window_begin_hook (w
);
15899 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15900 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15901 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15905 /* Terminal frame. In this case, dvpos gives the number of
15906 lines to scroll by; dvpos < 0 means scroll up. */
15907 int first_unchanged_at_end_vpos
15908 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15909 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15910 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15911 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15912 + window_internal_height (w
));
15914 /* Perform the operation on the screen. */
15917 /* Scroll last_unchanged_at_beg_row to the end of the
15918 window down dvpos lines. */
15919 set_terminal_window (f
, end
);
15921 /* On dumb terminals delete dvpos lines at the end
15922 before inserting dvpos empty lines. */
15923 if (!FRAME_SCROLL_REGION_OK (f
))
15924 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15926 /* Insert dvpos empty lines in front of
15927 last_unchanged_at_beg_row. */
15928 ins_del_lines (f
, from
, dvpos
);
15930 else if (dvpos
< 0)
15932 /* Scroll up last_unchanged_at_beg_vpos to the end of
15933 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15934 set_terminal_window (f
, end
);
15936 /* Delete dvpos lines in front of
15937 last_unchanged_at_beg_vpos. ins_del_lines will set
15938 the cursor to the given vpos and emit |dvpos| delete
15940 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15942 /* On a dumb terminal insert dvpos empty lines at the
15944 if (!FRAME_SCROLL_REGION_OK (f
))
15945 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15948 set_terminal_window (f
, 0);
15954 /* Shift reused rows of the current matrix to the right position.
15955 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15957 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15958 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15961 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15962 bottom_vpos
, dvpos
);
15963 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15966 else if (dvpos
> 0)
15968 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15969 bottom_vpos
, dvpos
);
15970 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15971 first_unchanged_at_end_vpos
+ dvpos
, 0);
15974 /* For frame-based redisplay, make sure that current frame and window
15975 matrix are in sync with respect to glyph memory. */
15976 if (!FRAME_WINDOW_P (f
))
15977 sync_frame_with_window_matrix_rows (w
);
15979 /* Adjust buffer positions in reused rows. */
15980 if (delta
|| delta_bytes
)
15981 increment_matrix_positions (current_matrix
,
15982 first_unchanged_at_end_vpos
+ dvpos
,
15983 bottom_vpos
, delta
, delta_bytes
);
15985 /* Adjust Y positions. */
15987 shift_glyph_matrix (w
, current_matrix
,
15988 first_unchanged_at_end_vpos
+ dvpos
,
15991 if (first_unchanged_at_end_row
)
15993 first_unchanged_at_end_row
+= dvpos
;
15994 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15995 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
15996 first_unchanged_at_end_row
= NULL
;
15999 /* If scrolling up, there may be some lines to display at the end of
16001 last_text_row_at_end
= NULL
;
16004 /* Scrolling up can leave for example a partially visible line
16005 at the end of the window to be redisplayed. */
16006 /* Set last_row to the glyph row in the current matrix where the
16007 window end line is found. It has been moved up or down in
16008 the matrix by dvpos. */
16009 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16010 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16012 /* If last_row is the window end line, it should display text. */
16013 xassert (last_row
->displays_text_p
);
16015 /* If window end line was partially visible before, begin
16016 displaying at that line. Otherwise begin displaying with the
16017 line following it. */
16018 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16020 init_to_row_start (&it
, w
, last_row
);
16021 it
.vpos
= last_vpos
;
16022 it
.current_y
= last_row
->y
;
16026 init_to_row_end (&it
, w
, last_row
);
16027 it
.vpos
= 1 + last_vpos
;
16028 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16032 /* We may start in a continuation line. If so, we have to
16033 get the right continuation_lines_width and current_x. */
16034 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16035 it
.hpos
= it
.current_x
= 0;
16037 /* Display the rest of the lines at the window end. */
16038 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16039 while (it
.current_y
< it
.last_visible_y
16040 && !fonts_changed_p
)
16042 /* Is it always sure that the display agrees with lines in
16043 the current matrix? I don't think so, so we mark rows
16044 displayed invalid in the current matrix by setting their
16045 enabled_p flag to zero. */
16046 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16047 if (display_line (&it
))
16048 last_text_row_at_end
= it
.glyph_row
- 1;
16052 /* Update window_end_pos and window_end_vpos. */
16053 if (first_unchanged_at_end_row
16054 && !last_text_row_at_end
)
16056 /* Window end line if one of the preserved rows from the current
16057 matrix. Set row to the last row displaying text in current
16058 matrix starting at first_unchanged_at_end_row, after
16060 xassert (first_unchanged_at_end_row
->displays_text_p
);
16061 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16062 first_unchanged_at_end_row
);
16063 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16065 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16066 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16068 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16069 xassert (w
->window_end_bytepos
>= 0);
16070 IF_DEBUG (debug_method_add (w
, "A"));
16072 else if (last_text_row_at_end
)
16075 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16076 w
->window_end_bytepos
16077 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16079 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16080 xassert (w
->window_end_bytepos
>= 0);
16081 IF_DEBUG (debug_method_add (w
, "B"));
16083 else if (last_text_row
)
16085 /* We have displayed either to the end of the window or at the
16086 end of the window, i.e. the last row with text is to be found
16087 in the desired matrix. */
16089 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16090 w
->window_end_bytepos
16091 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16093 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16094 xassert (w
->window_end_bytepos
>= 0);
16096 else if (first_unchanged_at_end_row
== NULL
16097 && last_text_row
== NULL
16098 && last_text_row_at_end
== NULL
)
16100 /* Displayed to end of window, but no line containing text was
16101 displayed. Lines were deleted at the end of the window. */
16102 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16103 int vpos
= XFASTINT (w
->window_end_vpos
);
16104 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16105 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16108 row
== NULL
&& vpos
>= first_vpos
;
16109 --vpos
, --current_row
, --desired_row
)
16111 if (desired_row
->enabled_p
)
16113 if (desired_row
->displays_text_p
)
16116 else if (current_row
->displays_text_p
)
16120 xassert (row
!= NULL
);
16121 w
->window_end_vpos
= make_number (vpos
+ 1);
16122 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16123 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16124 xassert (w
->window_end_bytepos
>= 0);
16125 IF_DEBUG (debug_method_add (w
, "C"));
16130 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16131 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16133 /* Record that display has not been completed. */
16134 w
->window_end_valid
= Qnil
;
16135 w
->desired_matrix
->no_scrolling_p
= 1;
16143 /***********************************************************************
16144 More debugging support
16145 ***********************************************************************/
16149 void dump_glyph_row (struct glyph_row
*, int, int);
16150 void dump_glyph_matrix (struct glyph_matrix
*, int);
16151 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16154 /* Dump the contents of glyph matrix MATRIX on stderr.
16156 GLYPHS 0 means don't show glyph contents.
16157 GLYPHS 1 means show glyphs in short form
16158 GLYPHS > 1 means show glyphs in long form. */
16161 dump_glyph_matrix (matrix
, glyphs
)
16162 struct glyph_matrix
*matrix
;
16166 for (i
= 0; i
< matrix
->nrows
; ++i
)
16167 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16171 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16172 the glyph row and area where the glyph comes from. */
16175 dump_glyph (row
, glyph
, area
)
16176 struct glyph_row
*row
;
16177 struct glyph
*glyph
;
16180 if (glyph
->type
== CHAR_GLYPH
)
16183 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16184 glyph
- row
->glyphs
[TEXT_AREA
],
16187 (BUFFERP (glyph
->object
)
16189 : (STRINGP (glyph
->object
)
16192 glyph
->pixel_width
,
16194 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16198 glyph
->left_box_line_p
,
16199 glyph
->right_box_line_p
);
16201 else if (glyph
->type
== STRETCH_GLYPH
)
16204 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16205 glyph
- row
->glyphs
[TEXT_AREA
],
16208 (BUFFERP (glyph
->object
)
16210 : (STRINGP (glyph
->object
)
16213 glyph
->pixel_width
,
16217 glyph
->left_box_line_p
,
16218 glyph
->right_box_line_p
);
16220 else if (glyph
->type
== IMAGE_GLYPH
)
16223 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16224 glyph
- row
->glyphs
[TEXT_AREA
],
16227 (BUFFERP (glyph
->object
)
16229 : (STRINGP (glyph
->object
)
16232 glyph
->pixel_width
,
16236 glyph
->left_box_line_p
,
16237 glyph
->right_box_line_p
);
16239 else if (glyph
->type
== COMPOSITE_GLYPH
)
16242 " %5d %4c %6d %c %3d 0x%05x",
16243 glyph
- row
->glyphs
[TEXT_AREA
],
16246 (BUFFERP (glyph
->object
)
16248 : (STRINGP (glyph
->object
)
16251 glyph
->pixel_width
,
16253 if (glyph
->u
.cmp
.automatic
)
16256 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16257 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16259 glyph
->left_box_line_p
,
16260 glyph
->right_box_line_p
);
16265 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16266 GLYPHS 0 means don't show glyph contents.
16267 GLYPHS 1 means show glyphs in short form
16268 GLYPHS > 1 means show glyphs in long form. */
16271 dump_glyph_row (row
, vpos
, glyphs
)
16272 struct glyph_row
*row
;
16277 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16278 fprintf (stderr
, "======================================================================\n");
16280 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16281 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16283 MATRIX_ROW_START_CHARPOS (row
),
16284 MATRIX_ROW_END_CHARPOS (row
),
16285 row
->used
[TEXT_AREA
],
16286 row
->contains_overlapping_glyphs_p
,
16288 row
->truncated_on_left_p
,
16289 row
->truncated_on_right_p
,
16291 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16292 row
->displays_text_p
,
16295 row
->ends_in_middle_of_char_p
,
16296 row
->starts_in_middle_of_char_p
,
16302 row
->visible_height
,
16305 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16306 row
->end
.overlay_string_index
,
16307 row
->continuation_lines_width
);
16308 fprintf (stderr
, "%9d %5d\n",
16309 CHARPOS (row
->start
.string_pos
),
16310 CHARPOS (row
->end
.string_pos
));
16311 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16312 row
->end
.dpvec_index
);
16319 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16321 struct glyph
*glyph
= row
->glyphs
[area
];
16322 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16324 /* Glyph for a line end in text. */
16325 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16328 if (glyph
< glyph_end
)
16329 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16331 for (; glyph
< glyph_end
; ++glyph
)
16332 dump_glyph (row
, glyph
, area
);
16335 else if (glyphs
== 1)
16339 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16341 char *s
= (char *) alloca (row
->used
[area
] + 1);
16344 for (i
= 0; i
< row
->used
[area
]; ++i
)
16346 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16347 if (glyph
->type
== CHAR_GLYPH
16348 && glyph
->u
.ch
< 0x80
16349 && glyph
->u
.ch
>= ' ')
16350 s
[i
] = glyph
->u
.ch
;
16356 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16362 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16363 Sdump_glyph_matrix
, 0, 1, "p",
16364 doc
: /* Dump the current matrix of the selected window to stderr.
16365 Shows contents of glyph row structures. With non-nil
16366 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16367 glyphs in short form, otherwise show glyphs in long form. */)
16368 (Lisp_Object glyphs
)
16370 struct window
*w
= XWINDOW (selected_window
);
16371 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16373 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16374 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16375 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16376 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16377 fprintf (stderr
, "=============================================\n");
16378 dump_glyph_matrix (w
->current_matrix
,
16379 NILP (glyphs
) ? 0 : XINT (glyphs
));
16384 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16385 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16388 struct frame
*f
= XFRAME (selected_frame
);
16389 dump_glyph_matrix (f
->current_matrix
, 1);
16394 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16395 doc
: /* Dump glyph row ROW to stderr.
16396 GLYPH 0 means don't dump glyphs.
16397 GLYPH 1 means dump glyphs in short form.
16398 GLYPH > 1 or omitted means dump glyphs in long form. */)
16399 (Lisp_Object row
, Lisp_Object glyphs
)
16401 struct glyph_matrix
*matrix
;
16404 CHECK_NUMBER (row
);
16405 matrix
= XWINDOW (selected_window
)->current_matrix
;
16407 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16408 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16410 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16415 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16416 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16417 GLYPH 0 means don't dump glyphs.
16418 GLYPH 1 means dump glyphs in short form.
16419 GLYPH > 1 or omitted means dump glyphs in long form. */)
16420 (Lisp_Object row
, Lisp_Object glyphs
)
16422 struct frame
*sf
= SELECTED_FRAME ();
16423 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16426 CHECK_NUMBER (row
);
16428 if (vpos
>= 0 && vpos
< m
->nrows
)
16429 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16430 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16435 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16436 doc
: /* Toggle tracing of redisplay.
16437 With ARG, turn tracing on if and only if ARG is positive. */)
16441 trace_redisplay_p
= !trace_redisplay_p
;
16444 arg
= Fprefix_numeric_value (arg
);
16445 trace_redisplay_p
= XINT (arg
) > 0;
16452 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16453 doc
: /* Like `format', but print result to stderr.
16454 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16455 (int nargs
, Lisp_Object
*args
)
16457 Lisp_Object s
= Fformat (nargs
, args
);
16458 fprintf (stderr
, "%s", SDATA (s
));
16462 #endif /* GLYPH_DEBUG */
16466 /***********************************************************************
16467 Building Desired Matrix Rows
16468 ***********************************************************************/
16470 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16471 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16473 static struct glyph_row
*
16474 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16476 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16477 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16478 struct buffer
*old
= current_buffer
;
16479 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16480 int arrow_len
= SCHARS (overlay_arrow_string
);
16481 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16482 const unsigned char *p
;
16485 int n_glyphs_before
;
16487 set_buffer_temp (buffer
);
16488 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16489 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16490 SET_TEXT_POS (it
.position
, 0, 0);
16492 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16494 while (p
< arrow_end
)
16496 Lisp_Object face
, ilisp
;
16498 /* Get the next character. */
16500 it
.c
= string_char_and_length (p
, &it
.len
);
16502 it
.c
= *p
, it
.len
= 1;
16505 /* Get its face. */
16506 ilisp
= make_number (p
- arrow_string
);
16507 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16508 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16510 /* Compute its width, get its glyphs. */
16511 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16512 SET_TEXT_POS (it
.position
, -1, -1);
16513 PRODUCE_GLYPHS (&it
);
16515 /* If this character doesn't fit any more in the line, we have
16516 to remove some glyphs. */
16517 if (it
.current_x
> it
.last_visible_x
)
16519 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16524 set_buffer_temp (old
);
16525 return it
.glyph_row
;
16529 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16530 glyphs are only inserted for terminal frames since we can't really
16531 win with truncation glyphs when partially visible glyphs are
16532 involved. Which glyphs to insert is determined by
16533 produce_special_glyphs. */
16536 insert_left_trunc_glyphs (struct it
*it
)
16538 struct it truncate_it
;
16539 struct glyph
*from
, *end
, *to
, *toend
;
16541 xassert (!FRAME_WINDOW_P (it
->f
));
16543 /* Get the truncation glyphs. */
16545 truncate_it
.current_x
= 0;
16546 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16547 truncate_it
.glyph_row
= &scratch_glyph_row
;
16548 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16549 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16550 truncate_it
.object
= make_number (0);
16551 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16553 /* Overwrite glyphs from IT with truncation glyphs. */
16554 if (!it
->glyph_row
->reversed_p
)
16556 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16557 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16558 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16559 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16564 /* There may be padding glyphs left over. Overwrite them too. */
16565 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16567 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16573 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16577 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16578 that back to front. */
16579 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16580 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16581 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16582 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16584 while (from
>= end
&& to
>= toend
)
16586 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16589 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16590 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16591 while (from
>= end
&& to
>= toend
)
16596 /* Need to free some room before prepending additional
16598 int move_by
= from
- end
+ 1;
16599 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16600 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16602 for ( ; g
>= g0
; g
--)
16604 while (from
>= end
)
16606 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16612 /* Compute the pixel height and width of IT->glyph_row.
16614 Most of the time, ascent and height of a display line will be equal
16615 to the max_ascent and max_height values of the display iterator
16616 structure. This is not the case if
16618 1. We hit ZV without displaying anything. In this case, max_ascent
16619 and max_height will be zero.
16621 2. We have some glyphs that don't contribute to the line height.
16622 (The glyph row flag contributes_to_line_height_p is for future
16623 pixmap extensions).
16625 The first case is easily covered by using default values because in
16626 these cases, the line height does not really matter, except that it
16627 must not be zero. */
16630 compute_line_metrics (struct it
*it
)
16632 struct glyph_row
*row
= it
->glyph_row
;
16635 if (FRAME_WINDOW_P (it
->f
))
16637 int i
, min_y
, max_y
;
16639 /* The line may consist of one space only, that was added to
16640 place the cursor on it. If so, the row's height hasn't been
16642 if (row
->height
== 0)
16644 if (it
->max_ascent
+ it
->max_descent
== 0)
16645 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16646 row
->ascent
= it
->max_ascent
;
16647 row
->height
= it
->max_ascent
+ it
->max_descent
;
16648 row
->phys_ascent
= it
->max_phys_ascent
;
16649 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16650 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16653 /* Compute the width of this line. */
16654 row
->pixel_width
= row
->x
;
16655 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16656 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16658 xassert (row
->pixel_width
>= 0);
16659 xassert (row
->ascent
>= 0 && row
->height
> 0);
16661 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16662 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16664 /* If first line's physical ascent is larger than its logical
16665 ascent, use the physical ascent, and make the row taller.
16666 This makes accented characters fully visible. */
16667 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16668 && row
->phys_ascent
> row
->ascent
)
16670 row
->height
+= row
->phys_ascent
- row
->ascent
;
16671 row
->ascent
= row
->phys_ascent
;
16674 /* Compute how much of the line is visible. */
16675 row
->visible_height
= row
->height
;
16677 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16678 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16680 if (row
->y
< min_y
)
16681 row
->visible_height
-= min_y
- row
->y
;
16682 if (row
->y
+ row
->height
> max_y
)
16683 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16687 row
->pixel_width
= row
->used
[TEXT_AREA
];
16688 if (row
->continued_p
)
16689 row
->pixel_width
-= it
->continuation_pixel_width
;
16690 else if (row
->truncated_on_right_p
)
16691 row
->pixel_width
-= it
->truncation_pixel_width
;
16692 row
->ascent
= row
->phys_ascent
= 0;
16693 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16694 row
->extra_line_spacing
= 0;
16697 /* Compute a hash code for this row. */
16699 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16700 for (i
= 0; i
< row
->used
[area
]; ++i
)
16701 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16702 + row
->glyphs
[area
][i
].u
.val
16703 + row
->glyphs
[area
][i
].face_id
16704 + row
->glyphs
[area
][i
].padding_p
16705 + (row
->glyphs
[area
][i
].type
<< 2));
16707 it
->max_ascent
= it
->max_descent
= 0;
16708 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16712 /* Append one space to the glyph row of iterator IT if doing a
16713 window-based redisplay. The space has the same face as
16714 IT->face_id. Value is non-zero if a space was added.
16716 This function is called to make sure that there is always one glyph
16717 at the end of a glyph row that the cursor can be set on under
16718 window-systems. (If there weren't such a glyph we would not know
16719 how wide and tall a box cursor should be displayed).
16721 At the same time this space let's a nicely handle clearing to the
16722 end of the line if the row ends in italic text. */
16725 append_space_for_newline (struct it
*it
, int default_face_p
)
16727 if (FRAME_WINDOW_P (it
->f
))
16729 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16731 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16732 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16734 /* Save some values that must not be changed.
16735 Must save IT->c and IT->len because otherwise
16736 ITERATOR_AT_END_P wouldn't work anymore after
16737 append_space_for_newline has been called. */
16738 enum display_element_type saved_what
= it
->what
;
16739 int saved_c
= it
->c
, saved_len
= it
->len
;
16740 int saved_x
= it
->current_x
;
16741 int saved_face_id
= it
->face_id
;
16742 struct text_pos saved_pos
;
16743 Lisp_Object saved_object
;
16746 saved_object
= it
->object
;
16747 saved_pos
= it
->position
;
16749 it
->what
= IT_CHARACTER
;
16750 memset (&it
->position
, 0, sizeof it
->position
);
16751 it
->object
= make_number (0);
16755 if (default_face_p
)
16756 it
->face_id
= DEFAULT_FACE_ID
;
16757 else if (it
->face_before_selective_p
)
16758 it
->face_id
= it
->saved_face_id
;
16759 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16760 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16762 PRODUCE_GLYPHS (it
);
16764 it
->override_ascent
= -1;
16765 it
->constrain_row_ascent_descent_p
= 0;
16766 it
->current_x
= saved_x
;
16767 it
->object
= saved_object
;
16768 it
->position
= saved_pos
;
16769 it
->what
= saved_what
;
16770 it
->face_id
= saved_face_id
;
16771 it
->len
= saved_len
;
16781 /* Extend the face of the last glyph in the text area of IT->glyph_row
16782 to the end of the display line. Called from display_line. If the
16783 glyph row is empty, add a space glyph to it so that we know the
16784 face to draw. Set the glyph row flag fill_line_p. If the glyph
16785 row is R2L, prepend a stretch glyph to cover the empty space to the
16786 left of the leftmost glyph. */
16789 extend_face_to_end_of_line (struct it
*it
)
16792 struct frame
*f
= it
->f
;
16794 /* If line is already filled, do nothing. Non window-system frames
16795 get a grace of one more ``pixel'' because their characters are
16796 1-``pixel'' wide, so they hit the equality too early. This grace
16797 is needed only for R2L rows that are not continued, to produce
16798 one extra blank where we could display the cursor. */
16799 if (it
->current_x
>= it
->last_visible_x
16800 + (!FRAME_WINDOW_P (f
)
16801 && it
->glyph_row
->reversed_p
16802 && !it
->glyph_row
->continued_p
))
16805 /* Face extension extends the background and box of IT->face_id
16806 to the end of the line. If the background equals the background
16807 of the frame, we don't have to do anything. */
16808 if (it
->face_before_selective_p
)
16809 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16811 face
= FACE_FROM_ID (f
, it
->face_id
);
16813 if (FRAME_WINDOW_P (f
)
16814 && it
->glyph_row
->displays_text_p
16815 && face
->box
== FACE_NO_BOX
16816 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16818 && !it
->glyph_row
->reversed_p
)
16821 /* Set the glyph row flag indicating that the face of the last glyph
16822 in the text area has to be drawn to the end of the text area. */
16823 it
->glyph_row
->fill_line_p
= 1;
16825 /* If current character of IT is not ASCII, make sure we have the
16826 ASCII face. This will be automatically undone the next time
16827 get_next_display_element returns a multibyte character. Note
16828 that the character will always be single byte in unibyte
16830 if (!ASCII_CHAR_P (it
->c
))
16832 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16835 if (FRAME_WINDOW_P (f
))
16837 /* If the row is empty, add a space with the current face of IT,
16838 so that we know which face to draw. */
16839 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16841 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16842 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16843 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16845 #ifdef HAVE_WINDOW_SYSTEM
16846 if (it
->glyph_row
->reversed_p
)
16848 /* Prepend a stretch glyph to the row, such that the
16849 rightmost glyph will be drawn flushed all the way to the
16850 right margin of the window. The stretch glyph that will
16851 occupy the empty space, if any, to the left of the
16853 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16854 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16855 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16857 int row_width
, stretch_ascent
, stretch_width
;
16858 struct text_pos saved_pos
;
16859 int saved_face_id
, saved_avoid_cursor
;
16861 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16862 row_width
+= g
->pixel_width
;
16863 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16864 if (stretch_width
> 0)
16867 (((it
->ascent
+ it
->descent
)
16868 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16869 saved_pos
= it
->position
;
16870 memset (&it
->position
, 0, sizeof it
->position
);
16871 saved_avoid_cursor
= it
->avoid_cursor_p
;
16872 it
->avoid_cursor_p
= 1;
16873 saved_face_id
= it
->face_id
;
16874 /* The last row's stretch glyph should get the default
16875 face, to avoid painting the rest of the window with
16876 the region face, if the region ends at ZV. */
16877 if (it
->glyph_row
->ends_at_zv_p
)
16878 it
->face_id
= DEFAULT_FACE_ID
;
16880 it
->face_id
= face
->id
;
16881 append_stretch_glyph (it
, make_number (0), stretch_width
,
16882 it
->ascent
+ it
->descent
, stretch_ascent
);
16883 it
->position
= saved_pos
;
16884 it
->avoid_cursor_p
= saved_avoid_cursor
;
16885 it
->face_id
= saved_face_id
;
16888 #endif /* HAVE_WINDOW_SYSTEM */
16892 /* Save some values that must not be changed. */
16893 int saved_x
= it
->current_x
;
16894 struct text_pos saved_pos
;
16895 Lisp_Object saved_object
;
16896 enum display_element_type saved_what
= it
->what
;
16897 int saved_face_id
= it
->face_id
;
16899 saved_object
= it
->object
;
16900 saved_pos
= it
->position
;
16902 it
->what
= IT_CHARACTER
;
16903 memset (&it
->position
, 0, sizeof it
->position
);
16904 it
->object
= make_number (0);
16907 /* The last row's blank glyphs should get the default face, to
16908 avoid painting the rest of the window with the region face,
16909 if the region ends at ZV. */
16910 if (it
->glyph_row
->ends_at_zv_p
)
16911 it
->face_id
= DEFAULT_FACE_ID
;
16913 it
->face_id
= face
->id
;
16915 PRODUCE_GLYPHS (it
);
16917 while (it
->current_x
<= it
->last_visible_x
)
16918 PRODUCE_GLYPHS (it
);
16920 /* Don't count these blanks really. It would let us insert a left
16921 truncation glyph below and make us set the cursor on them, maybe. */
16922 it
->current_x
= saved_x
;
16923 it
->object
= saved_object
;
16924 it
->position
= saved_pos
;
16925 it
->what
= saved_what
;
16926 it
->face_id
= saved_face_id
;
16931 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16932 trailing whitespace. */
16935 trailing_whitespace_p (int charpos
)
16937 int bytepos
= CHAR_TO_BYTE (charpos
);
16940 while (bytepos
< ZV_BYTE
16941 && (c
= FETCH_CHAR (bytepos
),
16942 c
== ' ' || c
== '\t'))
16945 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16947 if (bytepos
!= PT_BYTE
)
16954 /* Highlight trailing whitespace, if any, in ROW. */
16957 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16959 int used
= row
->used
[TEXT_AREA
];
16963 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16964 struct glyph
*glyph
= start
+ used
- 1;
16966 if (row
->reversed_p
)
16968 /* Right-to-left rows need to be processed in the opposite
16969 direction, so swap the edge pointers. */
16971 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16974 /* Skip over glyphs inserted to display the cursor at the
16975 end of a line, for extending the face of the last glyph
16976 to the end of the line on terminals, and for truncation
16977 and continuation glyphs. */
16978 if (!row
->reversed_p
)
16980 while (glyph
>= start
16981 && glyph
->type
== CHAR_GLYPH
16982 && INTEGERP (glyph
->object
))
16987 while (glyph
<= start
16988 && glyph
->type
== CHAR_GLYPH
16989 && INTEGERP (glyph
->object
))
16993 /* If last glyph is a space or stretch, and it's trailing
16994 whitespace, set the face of all trailing whitespace glyphs in
16995 IT->glyph_row to `trailing-whitespace'. */
16996 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
16997 && BUFFERP (glyph
->object
)
16998 && (glyph
->type
== STRETCH_GLYPH
16999 || (glyph
->type
== CHAR_GLYPH
17000 && glyph
->u
.ch
== ' '))
17001 && trailing_whitespace_p (glyph
->charpos
))
17003 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17007 if (!row
->reversed_p
)
17009 while (glyph
>= start
17010 && BUFFERP (glyph
->object
)
17011 && (glyph
->type
== STRETCH_GLYPH
17012 || (glyph
->type
== CHAR_GLYPH
17013 && glyph
->u
.ch
== ' ')))
17014 (glyph
--)->face_id
= face_id
;
17018 while (glyph
<= start
17019 && BUFFERP (glyph
->object
)
17020 && (glyph
->type
== STRETCH_GLYPH
17021 || (glyph
->type
== CHAR_GLYPH
17022 && glyph
->u
.ch
== ' ')))
17023 (glyph
++)->face_id
= face_id
;
17030 /* Value is non-zero if glyph row ROW in window W should be
17031 used to hold the cursor. */
17034 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
17036 int cursor_row_p
= 1;
17038 if (PT
== CHARPOS (row
->end
.pos
))
17040 /* Suppose the row ends on a string.
17041 Unless the row is continued, that means it ends on a newline
17042 in the string. If it's anything other than a display string
17043 (e.g. a before-string from an overlay), we don't want the
17044 cursor there. (This heuristic seems to give the optimal
17045 behavior for the various types of multi-line strings.) */
17046 if (CHARPOS (row
->end
.string_pos
) >= 0)
17048 if (row
->continued_p
)
17052 /* Check for `display' property. */
17053 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17054 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17055 struct glyph
*glyph
;
17058 for (glyph
= end
; glyph
>= beg
; --glyph
)
17059 if (STRINGP (glyph
->object
))
17062 = Fget_char_property (make_number (PT
),
17066 && display_prop_string_p (prop
, glyph
->object
));
17071 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17073 /* If the row ends in middle of a real character,
17074 and the line is continued, we want the cursor here.
17075 That's because CHARPOS (ROW->end.pos) would equal
17076 PT if PT is before the character. */
17077 if (!row
->ends_in_ellipsis_p
)
17078 cursor_row_p
= row
->continued_p
;
17080 /* If the row ends in an ellipsis, then
17081 CHARPOS (ROW->end.pos) will equal point after the
17082 invisible text. We want that position to be displayed
17083 after the ellipsis. */
17086 /* If the row ends at ZV, display the cursor at the end of that
17087 row instead of at the start of the row below. */
17088 else if (row
->ends_at_zv_p
)
17094 return cursor_row_p
;
17099 /* Push the display property PROP so that it will be rendered at the
17100 current position in IT. Return 1 if PROP was successfully pushed,
17104 push_display_prop (struct it
*it
, Lisp_Object prop
)
17108 if (STRINGP (prop
))
17110 if (SCHARS (prop
) == 0)
17117 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17118 it
->current
.overlay_string_index
= -1;
17119 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17120 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17121 it
->method
= GET_FROM_STRING
;
17122 it
->stop_charpos
= 0;
17124 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17126 it
->method
= GET_FROM_STRETCH
;
17129 #ifdef HAVE_WINDOW_SYSTEM
17130 else if (IMAGEP (prop
))
17132 it
->what
= IT_IMAGE
;
17133 it
->image_id
= lookup_image (it
->f
, prop
);
17134 it
->method
= GET_FROM_IMAGE
;
17136 #endif /* HAVE_WINDOW_SYSTEM */
17139 pop_it (it
); /* bogus display property, give up */
17146 /* Return the character-property PROP at the current position in IT. */
17149 get_it_property (struct it
*it
, Lisp_Object prop
)
17151 Lisp_Object position
;
17153 if (STRINGP (it
->object
))
17154 position
= make_number (IT_STRING_CHARPOS (*it
));
17155 else if (BUFFERP (it
->object
))
17156 position
= make_number (IT_CHARPOS (*it
));
17160 return Fget_char_property (position
, prop
, it
->object
);
17163 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17166 handle_line_prefix (struct it
*it
)
17168 Lisp_Object prefix
;
17169 if (it
->continuation_lines_width
> 0)
17171 prefix
= get_it_property (it
, Qwrap_prefix
);
17173 prefix
= Vwrap_prefix
;
17177 prefix
= get_it_property (it
, Qline_prefix
);
17179 prefix
= Vline_prefix
;
17181 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17183 /* If the prefix is wider than the window, and we try to wrap
17184 it, it would acquire its own wrap prefix, and so on till the
17185 iterator stack overflows. So, don't wrap the prefix. */
17186 it
->line_wrap
= TRUNCATE
;
17187 it
->avoid_cursor_p
= 1;
17193 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17194 only for R2L lines from display_line, when it decides that too many
17195 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17198 unproduce_glyphs (struct it
*it
, int n
)
17200 struct glyph
*glyph
, *end
;
17202 xassert (it
->glyph_row
);
17203 xassert (it
->glyph_row
->reversed_p
);
17204 xassert (it
->area
== TEXT_AREA
);
17205 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17207 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17208 n
= it
->glyph_row
->used
[TEXT_AREA
];
17209 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17210 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17211 for ( ; glyph
< end
; glyph
++)
17212 glyph
[-n
] = *glyph
;
17215 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17216 and ROW->maxpos. */
17218 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17219 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17220 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17222 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17223 lines' rows is implemented for bidi-reordered rows. */
17225 /* ROW->minpos is the value of min_pos, the minimal buffer position
17228 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17231 /* We didn't find _any_ valid buffer positions in any of the
17232 glyphs, so we must trust the iterator's computed
17234 row
->minpos
= row
->start
.pos
;
17235 max_pos
= CHARPOS (it
->current
.pos
);
17236 max_bpos
= BYTEPOS (it
->current
.pos
);
17242 /* Here are the various use-cases for ending the row, and the
17243 corresponding values for ROW->maxpos:
17245 Line ends in a newline from buffer eol_pos + 1
17246 Line is continued from buffer max_pos + 1
17247 Line is truncated on right it->current.pos
17248 Line ends in a newline from string max_pos
17249 Line is continued from string max_pos
17250 Line is continued from display vector max_pos
17251 Line is entirely from a string min_pos == max_pos
17252 Line is entirely from a display vector min_pos == max_pos
17253 Line that ends at ZV ZV
17255 If you discover other use-cases, please add them here as
17257 if (row
->ends_at_zv_p
)
17258 row
->maxpos
= it
->current
.pos
;
17259 else if (row
->used
[TEXT_AREA
])
17261 if (row
->ends_in_newline_from_string_p
)
17262 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17263 else if (CHARPOS (it
->eol_pos
) > 0)
17264 SET_TEXT_POS (row
->maxpos
,
17265 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17266 else if (row
->continued_p
)
17268 /* If max_pos is different from IT's current position, it
17269 means IT->method does not belong to the display element
17270 at max_pos. However, it also means that the display
17271 element at max_pos was displayed in its entirety on this
17272 line, which is equivalent to saying that the next line
17273 starts at the next buffer position. */
17274 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17275 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17278 INC_BOTH (max_pos
, max_bpos
);
17279 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17282 else if (row
->truncated_on_right_p
)
17283 /* display_line already called reseat_at_next_visible_line_start,
17284 which puts the iterator at the beginning of the next line, in
17285 the logical order. */
17286 row
->maxpos
= it
->current
.pos
;
17287 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17288 /* A line that is entirely from a string/image/stretch... */
17289 row
->maxpos
= row
->minpos
;
17294 row
->maxpos
= it
->current
.pos
;
17297 /* Construct the glyph row IT->glyph_row in the desired matrix of
17298 IT->w from text at the current position of IT. See dispextern.h
17299 for an overview of struct it. Value is non-zero if
17300 IT->glyph_row displays text, as opposed to a line displaying ZV
17304 display_line (struct it
*it
)
17306 struct glyph_row
*row
= it
->glyph_row
;
17307 Lisp_Object overlay_arrow_string
;
17309 int may_wrap
= 0, wrap_x
;
17310 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17311 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17312 int wrap_row_extra_line_spacing
;
17313 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17314 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17316 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17318 /* We always start displaying at hpos zero even if hscrolled. */
17319 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17321 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17322 >= it
->w
->desired_matrix
->nrows
)
17324 it
->w
->nrows_scale_factor
++;
17325 fonts_changed_p
= 1;
17329 /* Is IT->w showing the region? */
17330 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17332 /* Clear the result glyph row and enable it. */
17333 prepare_desired_row (row
);
17335 row
->y
= it
->current_y
;
17336 row
->start
= it
->start
;
17337 row
->continuation_lines_width
= it
->continuation_lines_width
;
17338 row
->displays_text_p
= 1;
17339 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17340 it
->starts_in_middle_of_char_p
= 0;
17342 /* Arrange the overlays nicely for our purposes. Usually, we call
17343 display_line on only one line at a time, in which case this
17344 can't really hurt too much, or we call it on lines which appear
17345 one after another in the buffer, in which case all calls to
17346 recenter_overlay_lists but the first will be pretty cheap. */
17347 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17349 /* Move over display elements that are not visible because we are
17350 hscrolled. This may stop at an x-position < IT->first_visible_x
17351 if the first glyph is partially visible or if we hit a line end. */
17352 if (it
->current_x
< it
->first_visible_x
)
17354 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17355 MOVE_TO_POS
| MOVE_TO_X
);
17359 /* We only do this when not calling `move_it_in_display_line_to'
17360 above, because move_it_in_display_line_to calls
17361 handle_line_prefix itself. */
17362 handle_line_prefix (it
);
17365 /* Get the initial row height. This is either the height of the
17366 text hscrolled, if there is any, or zero. */
17367 row
->ascent
= it
->max_ascent
;
17368 row
->height
= it
->max_ascent
+ it
->max_descent
;
17369 row
->phys_ascent
= it
->max_phys_ascent
;
17370 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17371 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17373 /* Utility macro to record max and min buffer positions seen until now. */
17374 #define RECORD_MAX_MIN_POS(IT) \
17377 if (IT_CHARPOS (*(IT)) < min_pos) \
17379 min_pos = IT_CHARPOS (*(IT)); \
17380 min_bpos = IT_BYTEPOS (*(IT)); \
17382 if (IT_CHARPOS (*(IT)) > max_pos) \
17384 max_pos = IT_CHARPOS (*(IT)); \
17385 max_bpos = IT_BYTEPOS (*(IT)); \
17390 /* Loop generating characters. The loop is left with IT on the next
17391 character to display. */
17394 int n_glyphs_before
, hpos_before
, x_before
;
17396 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17398 /* Retrieve the next thing to display. Value is zero if end of
17400 if (!get_next_display_element (it
))
17402 /* Maybe add a space at the end of this line that is used to
17403 display the cursor there under X. Set the charpos of the
17404 first glyph of blank lines not corresponding to any text
17406 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17407 row
->exact_window_width_line_p
= 1;
17408 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17409 || row
->used
[TEXT_AREA
] == 0)
17411 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17412 row
->displays_text_p
= 0;
17414 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17415 && (!MINI_WINDOW_P (it
->w
)
17416 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17417 row
->indicate_empty_line_p
= 1;
17420 it
->continuation_lines_width
= 0;
17421 row
->ends_at_zv_p
= 1;
17422 /* A row that displays right-to-left text must always have
17423 its last face extended all the way to the end of line,
17424 even if this row ends in ZV, because we still write to th
17425 screen left to right. */
17426 if (row
->reversed_p
)
17427 extend_face_to_end_of_line (it
);
17431 /* Now, get the metrics of what we want to display. This also
17432 generates glyphs in `row' (which is IT->glyph_row). */
17433 n_glyphs_before
= row
->used
[TEXT_AREA
];
17436 /* Remember the line height so far in case the next element doesn't
17437 fit on the line. */
17438 if (it
->line_wrap
!= TRUNCATE
)
17440 ascent
= it
->max_ascent
;
17441 descent
= it
->max_descent
;
17442 phys_ascent
= it
->max_phys_ascent
;
17443 phys_descent
= it
->max_phys_descent
;
17445 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17447 if (IT_DISPLAYING_WHITESPACE (it
))
17453 wrap_row_used
= row
->used
[TEXT_AREA
];
17454 wrap_row_ascent
= row
->ascent
;
17455 wrap_row_height
= row
->height
;
17456 wrap_row_phys_ascent
= row
->phys_ascent
;
17457 wrap_row_phys_height
= row
->phys_height
;
17458 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17459 wrap_row_min_pos
= min_pos
;
17460 wrap_row_min_bpos
= min_bpos
;
17461 wrap_row_max_pos
= max_pos
;
17462 wrap_row_max_bpos
= max_bpos
;
17468 PRODUCE_GLYPHS (it
);
17470 /* If this display element was in marginal areas, continue with
17472 if (it
->area
!= TEXT_AREA
)
17474 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17475 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17476 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17477 row
->phys_height
= max (row
->phys_height
,
17478 it
->max_phys_ascent
+ it
->max_phys_descent
);
17479 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17480 it
->max_extra_line_spacing
);
17481 set_iterator_to_next (it
, 1);
17485 /* Does the display element fit on the line? If we truncate
17486 lines, we should draw past the right edge of the window. If
17487 we don't truncate, we want to stop so that we can display the
17488 continuation glyph before the right margin. If lines are
17489 continued, there are two possible strategies for characters
17490 resulting in more than 1 glyph (e.g. tabs): Display as many
17491 glyphs as possible in this line and leave the rest for the
17492 continuation line, or display the whole element in the next
17493 line. Original redisplay did the former, so we do it also. */
17494 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17495 hpos_before
= it
->hpos
;
17498 if (/* Not a newline. */
17500 /* Glyphs produced fit entirely in the line. */
17501 && it
->current_x
< it
->last_visible_x
)
17503 it
->hpos
+= nglyphs
;
17504 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17505 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17506 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17507 row
->phys_height
= max (row
->phys_height
,
17508 it
->max_phys_ascent
+ it
->max_phys_descent
);
17509 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17510 it
->max_extra_line_spacing
);
17511 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17512 row
->x
= x
- it
->first_visible_x
;
17513 /* Record the maximum and minimum buffer positions seen so
17514 far in glyphs that will be displayed by this row. */
17516 RECORD_MAX_MIN_POS (it
);
17521 struct glyph
*glyph
;
17523 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17525 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17526 new_x
= x
+ glyph
->pixel_width
;
17528 if (/* Lines are continued. */
17529 it
->line_wrap
!= TRUNCATE
17530 && (/* Glyph doesn't fit on the line. */
17531 new_x
> it
->last_visible_x
17532 /* Or it fits exactly on a window system frame. */
17533 || (new_x
== it
->last_visible_x
17534 && FRAME_WINDOW_P (it
->f
))))
17536 /* End of a continued line. */
17539 || (new_x
== it
->last_visible_x
17540 && FRAME_WINDOW_P (it
->f
)))
17542 /* Current glyph is the only one on the line or
17543 fits exactly on the line. We must continue
17544 the line because we can't draw the cursor
17545 after the glyph. */
17546 row
->continued_p
= 1;
17547 it
->current_x
= new_x
;
17548 it
->continuation_lines_width
+= new_x
;
17550 /* Record the maximum and minimum buffer
17551 positions seen so far in glyphs that will be
17552 displayed by this row. */
17554 RECORD_MAX_MIN_POS (it
);
17555 if (i
== nglyphs
- 1)
17557 /* If line-wrap is on, check if a previous
17558 wrap point was found. */
17559 if (wrap_row_used
> 0
17560 /* Even if there is a previous wrap
17561 point, continue the line here as
17562 usual, if (i) the previous character
17563 was a space or tab AND (ii) the
17564 current character is not. */
17566 || IT_DISPLAYING_WHITESPACE (it
)))
17569 set_iterator_to_next (it
, 1);
17570 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17572 if (!get_next_display_element (it
))
17574 row
->exact_window_width_line_p
= 1;
17575 it
->continuation_lines_width
= 0;
17576 row
->continued_p
= 0;
17577 row
->ends_at_zv_p
= 1;
17579 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17581 row
->continued_p
= 0;
17582 row
->exact_window_width_line_p
= 1;
17587 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17588 && !FRAME_WINDOW_P (it
->f
))
17590 /* A padding glyph that doesn't fit on this line.
17591 This means the whole character doesn't fit
17593 if (row
->reversed_p
)
17594 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17595 - n_glyphs_before
);
17596 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17598 /* Fill the rest of the row with continuation
17599 glyphs like in 20.x. */
17600 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17601 < row
->glyphs
[1 + TEXT_AREA
])
17602 produce_special_glyphs (it
, IT_CONTINUATION
);
17604 row
->continued_p
= 1;
17605 it
->current_x
= x_before
;
17606 it
->continuation_lines_width
+= x_before
;
17608 /* Restore the height to what it was before the
17609 element not fitting on the line. */
17610 it
->max_ascent
= ascent
;
17611 it
->max_descent
= descent
;
17612 it
->max_phys_ascent
= phys_ascent
;
17613 it
->max_phys_descent
= phys_descent
;
17615 else if (wrap_row_used
> 0)
17618 if (row
->reversed_p
)
17619 unproduce_glyphs (it
,
17620 row
->used
[TEXT_AREA
] - wrap_row_used
);
17622 it
->continuation_lines_width
+= wrap_x
;
17623 row
->used
[TEXT_AREA
] = wrap_row_used
;
17624 row
->ascent
= wrap_row_ascent
;
17625 row
->height
= wrap_row_height
;
17626 row
->phys_ascent
= wrap_row_phys_ascent
;
17627 row
->phys_height
= wrap_row_phys_height
;
17628 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17629 min_pos
= wrap_row_min_pos
;
17630 min_bpos
= wrap_row_min_bpos
;
17631 max_pos
= wrap_row_max_pos
;
17632 max_bpos
= wrap_row_max_bpos
;
17633 row
->continued_p
= 1;
17634 row
->ends_at_zv_p
= 0;
17635 row
->exact_window_width_line_p
= 0;
17636 it
->continuation_lines_width
+= x
;
17638 /* Make sure that a non-default face is extended
17639 up to the right margin of the window. */
17640 extend_face_to_end_of_line (it
);
17642 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17644 /* A TAB that extends past the right edge of the
17645 window. This produces a single glyph on
17646 window system frames. We leave the glyph in
17647 this row and let it fill the row, but don't
17648 consume the TAB. */
17649 it
->continuation_lines_width
+= it
->last_visible_x
;
17650 row
->ends_in_middle_of_char_p
= 1;
17651 row
->continued_p
= 1;
17652 glyph
->pixel_width
= it
->last_visible_x
- x
;
17653 it
->starts_in_middle_of_char_p
= 1;
17657 /* Something other than a TAB that draws past
17658 the right edge of the window. Restore
17659 positions to values before the element. */
17660 if (row
->reversed_p
)
17661 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17662 - (n_glyphs_before
+ i
));
17663 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17665 /* Display continuation glyphs. */
17666 if (!FRAME_WINDOW_P (it
->f
))
17667 produce_special_glyphs (it
, IT_CONTINUATION
);
17668 row
->continued_p
= 1;
17670 it
->current_x
= x_before
;
17671 it
->continuation_lines_width
+= x
;
17672 extend_face_to_end_of_line (it
);
17674 if (nglyphs
> 1 && i
> 0)
17676 row
->ends_in_middle_of_char_p
= 1;
17677 it
->starts_in_middle_of_char_p
= 1;
17680 /* Restore the height to what it was before the
17681 element not fitting on the line. */
17682 it
->max_ascent
= ascent
;
17683 it
->max_descent
= descent
;
17684 it
->max_phys_ascent
= phys_ascent
;
17685 it
->max_phys_descent
= phys_descent
;
17690 else if (new_x
> it
->first_visible_x
)
17692 /* Increment number of glyphs actually displayed. */
17695 /* Record the maximum and minimum buffer positions
17696 seen so far in glyphs that will be displayed by
17699 RECORD_MAX_MIN_POS (it
);
17701 if (x
< it
->first_visible_x
)
17702 /* Glyph is partially visible, i.e. row starts at
17703 negative X position. */
17704 row
->x
= x
- it
->first_visible_x
;
17708 /* Glyph is completely off the left margin of the
17709 window. This should not happen because of the
17710 move_it_in_display_line at the start of this
17711 function, unless the text display area of the
17712 window is empty. */
17713 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17717 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17718 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17719 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17720 row
->phys_height
= max (row
->phys_height
,
17721 it
->max_phys_ascent
+ it
->max_phys_descent
);
17722 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17723 it
->max_extra_line_spacing
);
17725 /* End of this display line if row is continued. */
17726 if (row
->continued_p
|| row
->ends_at_zv_p
)
17731 /* Is this a line end? If yes, we're also done, after making
17732 sure that a non-default face is extended up to the right
17733 margin of the window. */
17734 if (ITERATOR_AT_END_OF_LINE_P (it
))
17736 int used_before
= row
->used
[TEXT_AREA
];
17738 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17740 /* Add a space at the end of the line that is used to
17741 display the cursor there. */
17742 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17743 append_space_for_newline (it
, 0);
17745 /* Extend the face to the end of the line. */
17746 extend_face_to_end_of_line (it
);
17748 /* Make sure we have the position. */
17749 if (used_before
== 0)
17750 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17752 /* Record the position of the newline, for use in
17754 it
->eol_pos
= it
->current
.pos
;
17756 /* Consume the line end. This skips over invisible lines. */
17757 set_iterator_to_next (it
, 1);
17758 it
->continuation_lines_width
= 0;
17762 /* Proceed with next display element. Note that this skips
17763 over lines invisible because of selective display. */
17764 set_iterator_to_next (it
, 1);
17766 /* If we truncate lines, we are done when the last displayed
17767 glyphs reach past the right margin of the window. */
17768 if (it
->line_wrap
== TRUNCATE
17769 && (FRAME_WINDOW_P (it
->f
)
17770 ? (it
->current_x
>= it
->last_visible_x
)
17771 : (it
->current_x
> it
->last_visible_x
)))
17773 /* Maybe add truncation glyphs. */
17774 if (!FRAME_WINDOW_P (it
->f
))
17778 if (!row
->reversed_p
)
17780 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17781 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17786 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17787 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17789 /* Remove any padding glyphs at the front of ROW, to
17790 make room for the truncation glyphs we will be
17791 adding below. The loop below always inserts at
17792 least one truncation glyph, so also remove the
17793 last glyph added to ROW. */
17794 unproduce_glyphs (it
, i
+ 1);
17795 /* Adjust i for the loop below. */
17796 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17799 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17801 row
->used
[TEXT_AREA
] = i
;
17802 produce_special_glyphs (it
, IT_TRUNCATION
);
17805 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17807 /* Don't truncate if we can overflow newline into fringe. */
17808 if (!get_next_display_element (it
))
17810 it
->continuation_lines_width
= 0;
17811 row
->ends_at_zv_p
= 1;
17812 row
->exact_window_width_line_p
= 1;
17815 if (ITERATOR_AT_END_OF_LINE_P (it
))
17817 row
->exact_window_width_line_p
= 1;
17818 goto at_end_of_line
;
17822 row
->truncated_on_right_p
= 1;
17823 it
->continuation_lines_width
= 0;
17824 reseat_at_next_visible_line_start (it
, 0);
17825 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17826 it
->hpos
= hpos_before
;
17827 it
->current_x
= x_before
;
17832 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17833 at the left window margin. */
17834 if (it
->first_visible_x
17835 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17837 if (!FRAME_WINDOW_P (it
->f
))
17838 insert_left_trunc_glyphs (it
);
17839 row
->truncated_on_left_p
= 1;
17842 /* If the start of this line is the overlay arrow-position, then
17843 mark this glyph row as the one containing the overlay arrow.
17844 This is clearly a mess with variable size fonts. It would be
17845 better to let it be displayed like cursors under X. */
17846 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17847 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17848 !NILP (overlay_arrow_string
)))
17850 /* Overlay arrow in window redisplay is a fringe bitmap. */
17851 if (STRINGP (overlay_arrow_string
))
17853 struct glyph_row
*arrow_row
17854 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17855 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17856 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17857 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17858 struct glyph
*p2
, *end
;
17860 /* Copy the arrow glyphs. */
17861 while (glyph
< arrow_end
)
17864 /* Throw away padding glyphs. */
17866 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17867 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17873 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17878 xassert (INTEGERP (overlay_arrow_string
));
17879 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17881 overlay_arrow_seen
= 1;
17884 /* Compute pixel dimensions of this line. */
17885 compute_line_metrics (it
);
17887 /* Remember the position at which this line ends. */
17888 row
->end
= it
->current
;
17891 row
->minpos
= row
->start
.pos
;
17892 row
->maxpos
= row
->end
.pos
;
17896 /* ROW->minpos and ROW->maxpos must be the smallest and
17897 `1 + the largest' buffer positions in ROW. But if ROW was
17898 bidi-reordered, these two positions can be anywhere in the
17899 row, so we must determine them now. */
17900 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17903 /* Record whether this row ends inside an ellipsis. */
17904 row
->ends_in_ellipsis_p
17905 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17906 && it
->ellipsis_p
);
17908 /* Save fringe bitmaps in this row. */
17909 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17910 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17911 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17912 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17914 it
->left_user_fringe_bitmap
= 0;
17915 it
->left_user_fringe_face_id
= 0;
17916 it
->right_user_fringe_bitmap
= 0;
17917 it
->right_user_fringe_face_id
= 0;
17919 /* Maybe set the cursor. */
17920 cvpos
= it
->w
->cursor
.vpos
;
17922 /* In bidi-reordered rows, keep checking for proper cursor
17923 position even if one has been found already, because buffer
17924 positions in such rows change non-linearly with ROW->VPOS,
17925 when a line is continued. One exception: when we are at ZV,
17926 display cursor on the first suitable glyph row, since all
17927 the empty rows after that also have their position set to ZV. */
17928 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17929 lines' rows is implemented for bidi-reordered rows. */
17931 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17932 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17933 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17934 && cursor_row_p (it
->w
, row
))
17935 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17937 /* Highlight trailing whitespace. */
17938 if (!NILP (Vshow_trailing_whitespace
))
17939 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17941 /* Prepare for the next line. This line starts horizontally at (X
17942 HPOS) = (0 0). Vertical positions are incremented. As a
17943 convenience for the caller, IT->glyph_row is set to the next
17945 it
->current_x
= it
->hpos
= 0;
17946 it
->current_y
+= row
->height
;
17947 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17950 /* The next row should by default use the same value of the
17951 reversed_p flag as this one. set_iterator_to_next decides when
17952 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17953 the flag accordingly. */
17954 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17955 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17956 it
->start
= row
->end
;
17957 return row
->displays_text_p
;
17959 #undef RECORD_MAX_MIN_POS
17962 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17963 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17964 doc
: /* Return paragraph direction at point in BUFFER.
17965 Value is either `left-to-right' or `right-to-left'.
17966 If BUFFER is omitted or nil, it defaults to the current buffer.
17968 Paragraph direction determines how the text in the paragraph is displayed.
17969 In left-to-right paragraphs, text begins at the left margin of the window
17970 and the reading direction is generally left to right. In right-to-left
17971 paragraphs, text begins at the right margin and is read from right to left.
17973 See also `bidi-paragraph-direction'. */)
17974 (Lisp_Object buffer
)
17976 struct buffer
*buf
;
17977 struct buffer
*old
;
17980 buf
= current_buffer
;
17983 CHECK_BUFFER (buffer
);
17984 buf
= XBUFFER (buffer
);
17985 old
= current_buffer
;
17988 if (NILP (buf
->bidi_display_reordering
))
17989 return Qleft_to_right
;
17990 else if (!NILP (buf
->bidi_paragraph_direction
))
17991 return buf
->bidi_paragraph_direction
;
17994 /* Determine the direction from buffer text. We could try to
17995 use current_matrix if it is up to date, but this seems fast
17996 enough as it is. */
17997 struct bidi_it itb
;
17998 EMACS_INT pos
= BUF_PT (buf
);
17999 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18001 if (buf
!= current_buffer
)
18002 set_buffer_temp (buf
);
18003 /* Find previous non-empty line. */
18004 if (pos
>= ZV
&& pos
> BEGV
)
18007 bytepos
= CHAR_TO_BYTE (pos
);
18009 while (FETCH_BYTE (bytepos
) == '\n')
18011 if (bytepos
<= BEGV_BYTE
)
18016 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18019 itb
.bytepos
= bytepos
;
18022 bidi_paragraph_init (NEUTRAL_DIR
, &itb
);
18023 if (buf
!= current_buffer
)
18024 set_buffer_temp (old
);
18025 switch (itb
.paragraph_dir
)
18028 return Qleft_to_right
;
18031 return Qright_to_left
;
18041 /***********************************************************************
18043 ***********************************************************************/
18045 /* Redisplay the menu bar in the frame for window W.
18047 The menu bar of X frames that don't have X toolkit support is
18048 displayed in a special window W->frame->menu_bar_window.
18050 The menu bar of terminal frames is treated specially as far as
18051 glyph matrices are concerned. Menu bar lines are not part of
18052 windows, so the update is done directly on the frame matrix rows
18053 for the menu bar. */
18056 display_menu_bar (struct window
*w
)
18058 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18063 /* Don't do all this for graphical frames. */
18065 if (FRAME_W32_P (f
))
18068 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18074 if (FRAME_NS_P (f
))
18076 #endif /* HAVE_NS */
18078 #ifdef USE_X_TOOLKIT
18079 xassert (!FRAME_WINDOW_P (f
));
18080 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18081 it
.first_visible_x
= 0;
18082 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18083 #else /* not USE_X_TOOLKIT */
18084 if (FRAME_WINDOW_P (f
))
18086 /* Menu bar lines are displayed in the desired matrix of the
18087 dummy window menu_bar_window. */
18088 struct window
*menu_w
;
18089 xassert (WINDOWP (f
->menu_bar_window
));
18090 menu_w
= XWINDOW (f
->menu_bar_window
);
18091 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18093 it
.first_visible_x
= 0;
18094 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18098 /* This is a TTY frame, i.e. character hpos/vpos are used as
18100 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18102 it
.first_visible_x
= 0;
18103 it
.last_visible_x
= FRAME_COLS (f
);
18105 #endif /* not USE_X_TOOLKIT */
18107 if (! mode_line_inverse_video
)
18108 /* Force the menu-bar to be displayed in the default face. */
18109 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18111 /* Clear all rows of the menu bar. */
18112 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18114 struct glyph_row
*row
= it
.glyph_row
+ i
;
18115 clear_glyph_row (row
);
18116 row
->enabled_p
= 1;
18117 row
->full_width_p
= 1;
18120 /* Display all items of the menu bar. */
18121 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18122 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18124 Lisp_Object string
;
18126 /* Stop at nil string. */
18127 string
= AREF (items
, i
+ 1);
18131 /* Remember where item was displayed. */
18132 ASET (items
, i
+ 3, make_number (it
.hpos
));
18134 /* Display the item, pad with one space. */
18135 if (it
.current_x
< it
.last_visible_x
)
18136 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18137 SCHARS (string
) + 1, 0, 0, -1);
18140 /* Fill out the line with spaces. */
18141 if (it
.current_x
< it
.last_visible_x
)
18142 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18144 /* Compute the total height of the lines. */
18145 compute_line_metrics (&it
);
18150 /***********************************************************************
18152 ***********************************************************************/
18154 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18155 FORCE is non-zero, redisplay mode lines unconditionally.
18156 Otherwise, redisplay only mode lines that are garbaged. Value is
18157 the number of windows whose mode lines were redisplayed. */
18160 redisplay_mode_lines (Lisp_Object window
, int force
)
18164 while (!NILP (window
))
18166 struct window
*w
= XWINDOW (window
);
18168 if (WINDOWP (w
->hchild
))
18169 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18170 else if (WINDOWP (w
->vchild
))
18171 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18173 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18174 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18176 struct text_pos lpoint
;
18177 struct buffer
*old
= current_buffer
;
18179 /* Set the window's buffer for the mode line display. */
18180 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18181 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18183 /* Point refers normally to the selected window. For any
18184 other window, set up appropriate value. */
18185 if (!EQ (window
, selected_window
))
18187 struct text_pos pt
;
18189 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18190 if (CHARPOS (pt
) < BEGV
)
18191 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18192 else if (CHARPOS (pt
) > (ZV
- 1))
18193 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18195 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18198 /* Display mode lines. */
18199 clear_glyph_matrix (w
->desired_matrix
);
18200 if (display_mode_lines (w
))
18203 w
->must_be_updated_p
= 1;
18206 /* Restore old settings. */
18207 set_buffer_internal_1 (old
);
18208 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18218 /* Display the mode and/or header line of window W. Value is the
18219 sum number of mode lines and header lines displayed. */
18222 display_mode_lines (struct window
*w
)
18224 Lisp_Object old_selected_window
, old_selected_frame
;
18227 old_selected_frame
= selected_frame
;
18228 selected_frame
= w
->frame
;
18229 old_selected_window
= selected_window
;
18230 XSETWINDOW (selected_window
, w
);
18232 /* These will be set while the mode line specs are processed. */
18233 line_number_displayed
= 0;
18234 w
->column_number_displayed
= Qnil
;
18236 if (WINDOW_WANTS_MODELINE_P (w
))
18238 struct window
*sel_w
= XWINDOW (old_selected_window
);
18240 /* Select mode line face based on the real selected window. */
18241 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18242 current_buffer
->mode_line_format
);
18246 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18248 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18249 current_buffer
->header_line_format
);
18253 selected_frame
= old_selected_frame
;
18254 selected_window
= old_selected_window
;
18259 /* Display mode or header line of window W. FACE_ID specifies which
18260 line to display; it is either MODE_LINE_FACE_ID or
18261 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18262 display. Value is the pixel height of the mode/header line
18266 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18270 int count
= SPECPDL_INDEX ();
18272 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18273 /* Don't extend on a previously drawn mode-line.
18274 This may happen if called from pos_visible_p. */
18275 it
.glyph_row
->enabled_p
= 0;
18276 prepare_desired_row (it
.glyph_row
);
18278 it
.glyph_row
->mode_line_p
= 1;
18280 if (! mode_line_inverse_video
)
18281 /* Force the mode-line to be displayed in the default face. */
18282 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18284 record_unwind_protect (unwind_format_mode_line
,
18285 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18287 mode_line_target
= MODE_LINE_DISPLAY
;
18289 /* Temporarily make frame's keyboard the current kboard so that
18290 kboard-local variables in the mode_line_format will get the right
18292 push_kboard (FRAME_KBOARD (it
.f
));
18293 record_unwind_save_match_data ();
18294 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18297 unbind_to (count
, Qnil
);
18299 /* Fill up with spaces. */
18300 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18302 compute_line_metrics (&it
);
18303 it
.glyph_row
->full_width_p
= 1;
18304 it
.glyph_row
->continued_p
= 0;
18305 it
.glyph_row
->truncated_on_left_p
= 0;
18306 it
.glyph_row
->truncated_on_right_p
= 0;
18308 /* Make a 3D mode-line have a shadow at its right end. */
18309 face
= FACE_FROM_ID (it
.f
, face_id
);
18310 extend_face_to_end_of_line (&it
);
18311 if (face
->box
!= FACE_NO_BOX
)
18313 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18314 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18315 last
->right_box_line_p
= 1;
18318 return it
.glyph_row
->height
;
18321 /* Move element ELT in LIST to the front of LIST.
18322 Return the updated list. */
18325 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18327 register Lisp_Object tail
, prev
;
18328 register Lisp_Object tem
;
18332 while (CONSP (tail
))
18338 /* Splice out the link TAIL. */
18340 list
= XCDR (tail
);
18342 Fsetcdr (prev
, XCDR (tail
));
18344 /* Now make it the first. */
18345 Fsetcdr (tail
, list
);
18350 tail
= XCDR (tail
);
18354 /* Not found--return unchanged LIST. */
18358 /* Contribute ELT to the mode line for window IT->w. How it
18359 translates into text depends on its data type.
18361 IT describes the display environment in which we display, as usual.
18363 DEPTH is the depth in recursion. It is used to prevent
18364 infinite recursion here.
18366 FIELD_WIDTH is the number of characters the display of ELT should
18367 occupy in the mode line, and PRECISION is the maximum number of
18368 characters to display from ELT's representation. See
18369 display_string for details.
18371 Returns the hpos of the end of the text generated by ELT.
18373 PROPS is a property list to add to any string we encounter.
18375 If RISKY is nonzero, remove (disregard) any properties in any string
18376 we encounter, and ignore :eval and :propertize.
18378 The global variable `mode_line_target' determines whether the
18379 output is passed to `store_mode_line_noprop',
18380 `store_mode_line_string', or `display_string'. */
18383 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18384 Lisp_Object elt
, Lisp_Object props
, int risky
)
18386 int n
= 0, field
, prec
;
18391 elt
= build_string ("*too-deep*");
18395 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18399 /* A string: output it and check for %-constructs within it. */
18403 if (SCHARS (elt
) > 0
18404 && (!NILP (props
) || risky
))
18406 Lisp_Object oprops
, aelt
;
18407 oprops
= Ftext_properties_at (make_number (0), elt
);
18409 /* If the starting string's properties are not what
18410 we want, translate the string. Also, if the string
18411 is risky, do that anyway. */
18413 if (NILP (Fequal (props
, oprops
)) || risky
)
18415 /* If the starting string has properties,
18416 merge the specified ones onto the existing ones. */
18417 if (! NILP (oprops
) && !risky
)
18421 oprops
= Fcopy_sequence (oprops
);
18423 while (CONSP (tem
))
18425 oprops
= Fplist_put (oprops
, XCAR (tem
),
18426 XCAR (XCDR (tem
)));
18427 tem
= XCDR (XCDR (tem
));
18432 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18433 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18435 /* AELT is what we want. Move it to the front
18436 without consing. */
18438 mode_line_proptrans_alist
18439 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18445 /* If AELT has the wrong props, it is useless.
18446 so get rid of it. */
18448 mode_line_proptrans_alist
18449 = Fdelq (aelt
, mode_line_proptrans_alist
);
18451 elt
= Fcopy_sequence (elt
);
18452 Fset_text_properties (make_number (0), Flength (elt
),
18454 /* Add this item to mode_line_proptrans_alist. */
18455 mode_line_proptrans_alist
18456 = Fcons (Fcons (elt
, props
),
18457 mode_line_proptrans_alist
);
18458 /* Truncate mode_line_proptrans_alist
18459 to at most 50 elements. */
18460 tem
= Fnthcdr (make_number (50),
18461 mode_line_proptrans_alist
);
18463 XSETCDR (tem
, Qnil
);
18472 prec
= precision
- n
;
18473 switch (mode_line_target
)
18475 case MODE_LINE_NOPROP
:
18476 case MODE_LINE_TITLE
:
18477 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18479 case MODE_LINE_STRING
:
18480 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18482 case MODE_LINE_DISPLAY
:
18483 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18484 0, prec
, 0, STRING_MULTIBYTE (elt
));
18491 /* Handle the non-literal case. */
18493 while ((precision
<= 0 || n
< precision
)
18494 && SREF (elt
, offset
) != 0
18495 && (mode_line_target
!= MODE_LINE_DISPLAY
18496 || it
->current_x
< it
->last_visible_x
))
18498 int last_offset
= offset
;
18500 /* Advance to end of string or next format specifier. */
18501 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18504 if (offset
- 1 != last_offset
)
18506 int nchars
, nbytes
;
18508 /* Output to end of string or up to '%'. Field width
18509 is length of string. Don't output more than
18510 PRECISION allows us. */
18513 prec
= c_string_width (SDATA (elt
) + last_offset
,
18514 offset
- last_offset
, precision
- n
,
18517 switch (mode_line_target
)
18519 case MODE_LINE_NOPROP
:
18520 case MODE_LINE_TITLE
:
18521 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18523 case MODE_LINE_STRING
:
18525 int bytepos
= last_offset
;
18526 int charpos
= string_byte_to_char (elt
, bytepos
);
18527 int endpos
= (precision
<= 0
18528 ? string_byte_to_char (elt
, offset
)
18529 : charpos
+ nchars
);
18531 n
+= store_mode_line_string (NULL
,
18532 Fsubstring (elt
, make_number (charpos
),
18533 make_number (endpos
)),
18537 case MODE_LINE_DISPLAY
:
18539 int bytepos
= last_offset
;
18540 int charpos
= string_byte_to_char (elt
, bytepos
);
18542 if (precision
<= 0)
18543 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18544 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18546 STRING_MULTIBYTE (elt
));
18551 else /* c == '%' */
18553 int percent_position
= offset
;
18555 /* Get the specified minimum width. Zero means
18558 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18559 field
= field
* 10 + c
- '0';
18561 /* Don't pad beyond the total padding allowed. */
18562 if (field_width
- n
> 0 && field
> field_width
- n
)
18563 field
= field_width
- n
;
18565 /* Note that either PRECISION <= 0 or N < PRECISION. */
18566 prec
= precision
- n
;
18569 n
+= display_mode_element (it
, depth
, field
, prec
,
18570 Vglobal_mode_string
, props
,
18575 int bytepos
, charpos
;
18576 unsigned char *spec
;
18577 Lisp_Object string
;
18579 bytepos
= percent_position
;
18580 charpos
= (STRING_MULTIBYTE (elt
)
18581 ? string_byte_to_char (elt
, bytepos
)
18583 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18584 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18586 switch (mode_line_target
)
18588 case MODE_LINE_NOPROP
:
18589 case MODE_LINE_TITLE
:
18590 n
+= store_mode_line_noprop (spec
, field
, prec
);
18592 case MODE_LINE_STRING
:
18594 int len
= strlen (spec
);
18595 Lisp_Object tem
= make_string (spec
, len
);
18596 props
= Ftext_properties_at (make_number (charpos
), elt
);
18597 /* Should only keep face property in props */
18598 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18601 case MODE_LINE_DISPLAY
:
18603 int nglyphs_before
, nwritten
;
18605 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18606 nwritten
= display_string (spec
, string
, elt
,
18611 /* Assign to the glyphs written above the
18612 string where the `%x' came from, position
18616 struct glyph
*glyph
18617 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18621 for (i
= 0; i
< nwritten
; ++i
)
18623 glyph
[i
].object
= elt
;
18624 glyph
[i
].charpos
= charpos
;
18641 /* A symbol: process the value of the symbol recursively
18642 as if it appeared here directly. Avoid error if symbol void.
18643 Special case: if value of symbol is a string, output the string
18646 register Lisp_Object tem
;
18648 /* If the variable is not marked as risky to set
18649 then its contents are risky to use. */
18650 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18653 tem
= Fboundp (elt
);
18656 tem
= Fsymbol_value (elt
);
18657 /* If value is a string, output that string literally:
18658 don't check for % within it. */
18662 if (!EQ (tem
, elt
))
18664 /* Give up right away for nil or t. */
18674 register Lisp_Object car
, tem
;
18676 /* A cons cell: five distinct cases.
18677 If first element is :eval or :propertize, do something special.
18678 If first element is a string or a cons, process all the elements
18679 and effectively concatenate them.
18680 If first element is a negative number, truncate displaying cdr to
18681 at most that many characters. If positive, pad (with spaces)
18682 to at least that many characters.
18683 If first element is a symbol, process the cadr or caddr recursively
18684 according to whether the symbol's value is non-nil or nil. */
18686 if (EQ (car
, QCeval
))
18688 /* An element of the form (:eval FORM) means evaluate FORM
18689 and use the result as mode line elements. */
18694 if (CONSP (XCDR (elt
)))
18697 spec
= safe_eval (XCAR (XCDR (elt
)));
18698 n
+= display_mode_element (it
, depth
, field_width
- n
,
18699 precision
- n
, spec
, props
,
18703 else if (EQ (car
, QCpropertize
))
18705 /* An element of the form (:propertize ELT PROPS...)
18706 means display ELT but applying properties PROPS. */
18711 if (CONSP (XCDR (elt
)))
18712 n
+= display_mode_element (it
, depth
, field_width
- n
,
18713 precision
- n
, XCAR (XCDR (elt
)),
18714 XCDR (XCDR (elt
)), risky
);
18716 else if (SYMBOLP (car
))
18718 tem
= Fboundp (car
);
18722 /* elt is now the cdr, and we know it is a cons cell.
18723 Use its car if CAR has a non-nil value. */
18726 tem
= Fsymbol_value (car
);
18733 /* Symbol's value is nil (or symbol is unbound)
18734 Get the cddr of the original list
18735 and if possible find the caddr and use that. */
18739 else if (!CONSP (elt
))
18744 else if (INTEGERP (car
))
18746 register int lim
= XINT (car
);
18750 /* Negative int means reduce maximum width. */
18751 if (precision
<= 0)
18754 precision
= min (precision
, -lim
);
18758 /* Padding specified. Don't let it be more than
18759 current maximum. */
18761 lim
= min (precision
, lim
);
18763 /* If that's more padding than already wanted, queue it.
18764 But don't reduce padding already specified even if
18765 that is beyond the current truncation point. */
18766 field_width
= max (lim
, field_width
);
18770 else if (STRINGP (car
) || CONSP (car
))
18772 Lisp_Object halftail
= elt
;
18776 && (precision
<= 0 || n
< precision
))
18778 n
+= display_mode_element (it
, depth
,
18779 /* Do padding only after the last
18780 element in the list. */
18781 (! CONSP (XCDR (elt
))
18784 precision
- n
, XCAR (elt
),
18788 if ((len
& 1) == 0)
18789 halftail
= XCDR (halftail
);
18790 /* Check for cycle. */
18791 if (EQ (halftail
, elt
))
18800 elt
= build_string ("*invalid*");
18804 /* Pad to FIELD_WIDTH. */
18805 if (field_width
> 0 && n
< field_width
)
18807 switch (mode_line_target
)
18809 case MODE_LINE_NOPROP
:
18810 case MODE_LINE_TITLE
:
18811 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18813 case MODE_LINE_STRING
:
18814 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18816 case MODE_LINE_DISPLAY
:
18817 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18826 /* Store a mode-line string element in mode_line_string_list.
18828 If STRING is non-null, display that C string. Otherwise, the Lisp
18829 string LISP_STRING is displayed.
18831 FIELD_WIDTH is the minimum number of output glyphs to produce.
18832 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18833 with spaces. FIELD_WIDTH <= 0 means don't pad.
18835 PRECISION is the maximum number of characters to output from
18836 STRING. PRECISION <= 0 means don't truncate the string.
18838 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18839 properties to the string.
18841 PROPS are the properties to add to the string.
18842 The mode_line_string_face face property is always added to the string.
18846 store_mode_line_string (char *string
, Lisp_Object lisp_string
, int copy_string
,
18847 int field_width
, int precision
, Lisp_Object props
)
18852 if (string
!= NULL
)
18854 len
= strlen (string
);
18855 if (precision
> 0 && len
> precision
)
18857 lisp_string
= make_string (string
, len
);
18859 props
= mode_line_string_face_prop
;
18860 else if (!NILP (mode_line_string_face
))
18862 Lisp_Object face
= Fplist_get (props
, Qface
);
18863 props
= Fcopy_sequence (props
);
18865 face
= mode_line_string_face
;
18867 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18868 props
= Fplist_put (props
, Qface
, face
);
18870 Fadd_text_properties (make_number (0), make_number (len
),
18871 props
, lisp_string
);
18875 len
= XFASTINT (Flength (lisp_string
));
18876 if (precision
> 0 && len
> precision
)
18879 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18882 if (!NILP (mode_line_string_face
))
18886 props
= Ftext_properties_at (make_number (0), lisp_string
);
18887 face
= Fplist_get (props
, Qface
);
18889 face
= mode_line_string_face
;
18891 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18892 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18894 lisp_string
= Fcopy_sequence (lisp_string
);
18897 Fadd_text_properties (make_number (0), make_number (len
),
18898 props
, lisp_string
);
18903 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18907 if (field_width
> len
)
18909 field_width
-= len
;
18910 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18912 Fadd_text_properties (make_number (0), make_number (field_width
),
18913 props
, lisp_string
);
18914 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18922 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18924 doc
: /* Format a string out of a mode line format specification.
18925 First arg FORMAT specifies the mode line format (see `mode-line-format'
18926 for details) to use.
18928 Optional second arg FACE specifies the face property to put
18929 on all characters for which no face is specified.
18930 The value t means whatever face the window's mode line currently uses
18931 \(either `mode-line' or `mode-line-inactive', depending).
18932 A value of nil means the default is no face property.
18933 If FACE is an integer, the value string has no text properties.
18935 Optional third and fourth args WINDOW and BUFFER specify the window
18936 and buffer to use as the context for the formatting (defaults
18937 are the selected window and the window's buffer). */)
18938 (Lisp_Object format
, Lisp_Object face
, Lisp_Object window
, Lisp_Object buffer
)
18943 struct buffer
*old_buffer
= NULL
;
18945 int no_props
= INTEGERP (face
);
18946 int count
= SPECPDL_INDEX ();
18948 int string_start
= 0;
18951 window
= selected_window
;
18952 CHECK_WINDOW (window
);
18953 w
= XWINDOW (window
);
18956 buffer
= w
->buffer
;
18957 CHECK_BUFFER (buffer
);
18959 /* Make formatting the modeline a non-op when noninteractive, otherwise
18960 there will be problems later caused by a partially initialized frame. */
18961 if (NILP (format
) || noninteractive
)
18962 return empty_unibyte_string
;
18970 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18971 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18975 face_id
= DEFAULT_FACE_ID
;
18977 if (XBUFFER (buffer
) != current_buffer
)
18978 old_buffer
= current_buffer
;
18980 /* Save things including mode_line_proptrans_alist,
18981 and set that to nil so that we don't alter the outer value. */
18982 record_unwind_protect (unwind_format_mode_line
,
18983 format_mode_line_unwind_data
18984 (old_buffer
, selected_window
, 1));
18985 mode_line_proptrans_alist
= Qnil
;
18987 Fselect_window (window
, Qt
);
18989 set_buffer_internal_1 (XBUFFER (buffer
));
18991 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18995 mode_line_target
= MODE_LINE_NOPROP
;
18996 mode_line_string_face_prop
= Qnil
;
18997 mode_line_string_list
= Qnil
;
18998 string_start
= MODE_LINE_NOPROP_LEN (0);
19002 mode_line_target
= MODE_LINE_STRING
;
19003 mode_line_string_list
= Qnil
;
19004 mode_line_string_face
= face
;
19005 mode_line_string_face_prop
19006 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19009 push_kboard (FRAME_KBOARD (it
.f
));
19010 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19015 len
= MODE_LINE_NOPROP_LEN (string_start
);
19016 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19020 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19021 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19022 empty_unibyte_string
);
19025 unbind_to (count
, Qnil
);
19029 /* Write a null-terminated, right justified decimal representation of
19030 the positive integer D to BUF using a minimal field width WIDTH. */
19033 pint2str (register char *buf
, register int width
, register int d
)
19035 register char *p
= buf
;
19043 *p
++ = d
% 10 + '0';
19048 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19059 /* Write a null-terminated, right justified decimal and "human
19060 readable" representation of the nonnegative integer D to BUF using
19061 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19063 static const char power_letter
[] =
19077 pint2hrstr (char *buf
, int width
, int d
)
19079 /* We aim to represent the nonnegative integer D as
19080 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19083 /* -1 means: do not use TENTHS. */
19087 /* Length of QUOTIENT.TENTHS as a string. */
19093 if (1000 <= quotient
)
19095 /* Scale to the appropriate EXPONENT. */
19098 remainder
= quotient
% 1000;
19102 while (1000 <= quotient
);
19104 /* Round to nearest and decide whether to use TENTHS or not. */
19107 tenths
= remainder
/ 100;
19108 if (50 <= remainder
% 100)
19115 if (quotient
== 10)
19123 if (500 <= remainder
)
19125 if (quotient
< 999)
19136 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19137 if (tenths
== -1 && quotient
<= 99)
19144 p
= psuffix
= buf
+ max (width
, length
);
19146 /* Print EXPONENT. */
19148 *psuffix
++ = power_letter
[exponent
];
19151 /* Print TENTHS. */
19154 *--p
= '0' + tenths
;
19158 /* Print QUOTIENT. */
19161 int digit
= quotient
% 10;
19162 *--p
= '0' + digit
;
19164 while ((quotient
/= 10) != 0);
19166 /* Print leading spaces. */
19171 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19172 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19173 type of CODING_SYSTEM. Return updated pointer into BUF. */
19175 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19178 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19181 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19182 const unsigned char *eol_str
;
19184 /* The EOL conversion we are using. */
19185 Lisp_Object eoltype
;
19187 val
= CODING_SYSTEM_SPEC (coding_system
);
19190 if (!VECTORP (val
)) /* Not yet decided. */
19195 eoltype
= eol_mnemonic_undecided
;
19196 /* Don't mention EOL conversion if it isn't decided. */
19201 Lisp_Object eolvalue
;
19203 attrs
= AREF (val
, 0);
19204 eolvalue
= AREF (val
, 2);
19207 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19211 /* The EOL conversion that is normal on this system. */
19213 if (NILP (eolvalue
)) /* Not yet decided. */
19214 eoltype
= eol_mnemonic_undecided
;
19215 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19216 eoltype
= eol_mnemonic_undecided
;
19217 else /* eolvalue is Qunix, Qdos, or Qmac. */
19218 eoltype
= (EQ (eolvalue
, Qunix
)
19219 ? eol_mnemonic_unix
19220 : (EQ (eolvalue
, Qdos
) == 1
19221 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19227 /* Mention the EOL conversion if it is not the usual one. */
19228 if (STRINGP (eoltype
))
19230 eol_str
= SDATA (eoltype
);
19231 eol_str_len
= SBYTES (eoltype
);
19233 else if (CHARACTERP (eoltype
))
19235 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19236 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19241 eol_str
= invalid_eol_type
;
19242 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19244 memcpy (buf
, eol_str
, eol_str_len
);
19245 buf
+= eol_str_len
;
19251 /* Return a string for the output of a mode line %-spec for window W,
19252 generated by character C. PRECISION >= 0 means don't return a
19253 string longer than that value. FIELD_WIDTH > 0 means pad the
19254 string returned with spaces to that value. Return a Lisp string in
19255 *STRING if the resulting string is taken from that Lisp string.
19257 Note we operate on the current buffer for most purposes,
19258 the exception being w->base_line_pos. */
19260 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19263 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19264 int precision
, Lisp_Object
*string
)
19267 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19268 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19269 struct buffer
*b
= current_buffer
;
19277 if (!NILP (b
->read_only
))
19279 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19284 /* This differs from %* only for a modified read-only buffer. */
19285 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19287 if (!NILP (b
->read_only
))
19292 /* This differs from %* in ignoring read-only-ness. */
19293 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19305 if (command_loop_level
> 5)
19307 p
= decode_mode_spec_buf
;
19308 for (i
= 0; i
< command_loop_level
; i
++)
19311 return decode_mode_spec_buf
;
19319 if (command_loop_level
> 5)
19321 p
= decode_mode_spec_buf
;
19322 for (i
= 0; i
< command_loop_level
; i
++)
19325 return decode_mode_spec_buf
;
19332 /* Let lots_of_dashes be a string of infinite length. */
19333 if (mode_line_target
== MODE_LINE_NOPROP
||
19334 mode_line_target
== MODE_LINE_STRING
)
19336 if (field_width
<= 0
19337 || field_width
> sizeof (lots_of_dashes
))
19339 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19340 decode_mode_spec_buf
[i
] = '-';
19341 decode_mode_spec_buf
[i
] = '\0';
19342 return decode_mode_spec_buf
;
19345 return lots_of_dashes
;
19353 /* %c and %l are ignored in `frame-title-format'.
19354 (In redisplay_internal, the frame title is drawn _before_ the
19355 windows are updated, so the stuff which depends on actual
19356 window contents (such as %l) may fail to render properly, or
19357 even crash emacs.) */
19358 if (mode_line_target
== MODE_LINE_TITLE
)
19362 int col
= (int) current_column (); /* iftc */
19363 w
->column_number_displayed
= make_number (col
);
19364 pint2str (decode_mode_spec_buf
, field_width
, col
);
19365 return decode_mode_spec_buf
;
19369 #ifndef SYSTEM_MALLOC
19371 if (NILP (Vmemory_full
))
19374 return "!MEM FULL! ";
19381 /* %F displays the frame name. */
19382 if (!NILP (f
->title
))
19383 return (char *) SDATA (f
->title
);
19384 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19385 return (char *) SDATA (f
->name
);
19394 int size
= ZV
- BEGV
;
19395 pint2str (decode_mode_spec_buf
, field_width
, size
);
19396 return decode_mode_spec_buf
;
19401 int size
= ZV
- BEGV
;
19402 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19403 return decode_mode_spec_buf
;
19408 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19409 int topline
, nlines
, junk
, height
;
19411 /* %c and %l are ignored in `frame-title-format'. */
19412 if (mode_line_target
== MODE_LINE_TITLE
)
19415 startpos
= XMARKER (w
->start
)->charpos
;
19416 startpos_byte
= marker_byte_position (w
->start
);
19417 height
= WINDOW_TOTAL_LINES (w
);
19419 /* If we decided that this buffer isn't suitable for line numbers,
19420 don't forget that too fast. */
19421 if (EQ (w
->base_line_pos
, w
->buffer
))
19423 /* But do forget it, if the window shows a different buffer now. */
19424 else if (BUFFERP (w
->base_line_pos
))
19425 w
->base_line_pos
= Qnil
;
19427 /* If the buffer is very big, don't waste time. */
19428 if (INTEGERP (Vline_number_display_limit
)
19429 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19431 w
->base_line_pos
= Qnil
;
19432 w
->base_line_number
= Qnil
;
19436 if (INTEGERP (w
->base_line_number
)
19437 && INTEGERP (w
->base_line_pos
)
19438 && XFASTINT (w
->base_line_pos
) <= startpos
)
19440 line
= XFASTINT (w
->base_line_number
);
19441 linepos
= XFASTINT (w
->base_line_pos
);
19442 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19447 linepos
= BUF_BEGV (b
);
19448 linepos_byte
= BUF_BEGV_BYTE (b
);
19451 /* Count lines from base line to window start position. */
19452 nlines
= display_count_lines (linepos
, linepos_byte
,
19456 topline
= nlines
+ line
;
19458 /* Determine a new base line, if the old one is too close
19459 or too far away, or if we did not have one.
19460 "Too close" means it's plausible a scroll-down would
19461 go back past it. */
19462 if (startpos
== BUF_BEGV (b
))
19464 w
->base_line_number
= make_number (topline
);
19465 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19467 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19468 || linepos
== BUF_BEGV (b
))
19470 int limit
= BUF_BEGV (b
);
19471 int limit_byte
= BUF_BEGV_BYTE (b
);
19473 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19475 if (startpos
- distance
> limit
)
19477 limit
= startpos
- distance
;
19478 limit_byte
= CHAR_TO_BYTE (limit
);
19481 nlines
= display_count_lines (startpos
, startpos_byte
,
19483 - (height
* 2 + 30),
19485 /* If we couldn't find the lines we wanted within
19486 line_number_display_limit_width chars per line,
19487 give up on line numbers for this window. */
19488 if (position
== limit_byte
&& limit
== startpos
- distance
)
19490 w
->base_line_pos
= w
->buffer
;
19491 w
->base_line_number
= Qnil
;
19495 w
->base_line_number
= make_number (topline
- nlines
);
19496 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19499 /* Now count lines from the start pos to point. */
19500 nlines
= display_count_lines (startpos
, startpos_byte
,
19501 PT_BYTE
, PT
, &junk
);
19503 /* Record that we did display the line number. */
19504 line_number_displayed
= 1;
19506 /* Make the string to show. */
19507 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19508 return decode_mode_spec_buf
;
19511 char* p
= decode_mode_spec_buf
;
19512 int pad
= field_width
- 2;
19518 return decode_mode_spec_buf
;
19524 obj
= b
->mode_name
;
19528 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19534 int pos
= marker_position (w
->start
);
19535 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19537 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19539 if (pos
<= BUF_BEGV (b
))
19544 else if (pos
<= BUF_BEGV (b
))
19548 if (total
> 1000000)
19549 /* Do it differently for a large value, to avoid overflow. */
19550 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19552 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19553 /* We can't normally display a 3-digit number,
19554 so get us a 2-digit number that is close. */
19557 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19558 return decode_mode_spec_buf
;
19562 /* Display percentage of size above the bottom of the screen. */
19565 int toppos
= marker_position (w
->start
);
19566 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19567 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19569 if (botpos
>= BUF_ZV (b
))
19571 if (toppos
<= BUF_BEGV (b
))
19578 if (total
> 1000000)
19579 /* Do it differently for a large value, to avoid overflow. */
19580 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19582 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19583 /* We can't normally display a 3-digit number,
19584 so get us a 2-digit number that is close. */
19587 if (toppos
<= BUF_BEGV (b
))
19588 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19590 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19591 return decode_mode_spec_buf
;
19596 /* status of process */
19597 obj
= Fget_buffer_process (Fcurrent_buffer ());
19599 return "no process";
19600 #ifdef subprocesses
19601 obj
= Fsymbol_name (Fprocess_status (obj
));
19607 int count
= inhibit_garbage_collection ();
19608 Lisp_Object val
= call1 (intern ("file-remote-p"),
19609 current_buffer
->directory
);
19610 unbind_to (count
, Qnil
);
19618 case 't': /* indicate TEXT or BINARY */
19619 #ifdef MODE_LINE_BINARY_TEXT
19620 return MODE_LINE_BINARY_TEXT (b
);
19626 /* coding-system (not including end-of-line format) */
19628 /* coding-system (including end-of-line type) */
19630 int eol_flag
= (c
== 'Z');
19631 char *p
= decode_mode_spec_buf
;
19633 if (! FRAME_WINDOW_P (f
))
19635 /* No need to mention EOL here--the terminal never needs
19636 to do EOL conversion. */
19637 p
= decode_mode_spec_coding (CODING_ID_NAME
19638 (FRAME_KEYBOARD_CODING (f
)->id
),
19640 p
= decode_mode_spec_coding (CODING_ID_NAME
19641 (FRAME_TERMINAL_CODING (f
)->id
),
19644 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19647 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19648 #ifdef subprocesses
19649 obj
= Fget_buffer_process (Fcurrent_buffer ());
19650 if (PROCESSP (obj
))
19652 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19654 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19657 #endif /* subprocesses */
19660 return decode_mode_spec_buf
;
19667 return (char *) SDATA (obj
);
19674 /* Count up to COUNT lines starting from START / START_BYTE.
19675 But don't go beyond LIMIT_BYTE.
19676 Return the number of lines thus found (always nonnegative).
19678 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19681 display_count_lines (int start
, int start_byte
, int limit_byte
, int count
,
19684 register unsigned char *cursor
;
19685 unsigned char *base
;
19687 register int ceiling
;
19688 register unsigned char *ceiling_addr
;
19689 int orig_count
= count
;
19691 /* If we are not in selective display mode,
19692 check only for newlines. */
19693 int selective_display
= (!NILP (current_buffer
->selective_display
)
19694 && !INTEGERP (current_buffer
->selective_display
));
19698 while (start_byte
< limit_byte
)
19700 ceiling
= BUFFER_CEILING_OF (start_byte
);
19701 ceiling
= min (limit_byte
- 1, ceiling
);
19702 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19703 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19706 if (selective_display
)
19707 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19710 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19713 if (cursor
!= ceiling_addr
)
19717 start_byte
+= cursor
- base
+ 1;
19718 *byte_pos_ptr
= start_byte
;
19722 if (++cursor
== ceiling_addr
)
19728 start_byte
+= cursor
- base
;
19733 while (start_byte
> limit_byte
)
19735 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19736 ceiling
= max (limit_byte
, ceiling
);
19737 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19738 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19741 if (selective_display
)
19742 while (--cursor
!= ceiling_addr
19743 && *cursor
!= '\n' && *cursor
!= 015)
19746 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19749 if (cursor
!= ceiling_addr
)
19753 start_byte
+= cursor
- base
+ 1;
19754 *byte_pos_ptr
= start_byte
;
19755 /* When scanning backwards, we should
19756 not count the newline posterior to which we stop. */
19757 return - orig_count
- 1;
19763 /* Here we add 1 to compensate for the last decrement
19764 of CURSOR, which took it past the valid range. */
19765 start_byte
+= cursor
- base
+ 1;
19769 *byte_pos_ptr
= limit_byte
;
19772 return - orig_count
+ count
;
19773 return orig_count
- count
;
19779 /***********************************************************************
19781 ***********************************************************************/
19783 /* Display a NUL-terminated string, starting with index START.
19785 If STRING is non-null, display that C string. Otherwise, the Lisp
19786 string LISP_STRING is displayed. There's a case that STRING is
19787 non-null and LISP_STRING is not nil. It means STRING is a string
19788 data of LISP_STRING. In that case, we display LISP_STRING while
19789 ignoring its text properties.
19791 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19792 FACE_STRING. Display STRING or LISP_STRING with the face at
19793 FACE_STRING_POS in FACE_STRING:
19795 Display the string in the environment given by IT, but use the
19796 standard display table, temporarily.
19798 FIELD_WIDTH is the minimum number of output glyphs to produce.
19799 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19800 with spaces. If STRING has more characters, more than FIELD_WIDTH
19801 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19803 PRECISION is the maximum number of characters to output from
19804 STRING. PRECISION < 0 means don't truncate the string.
19806 This is roughly equivalent to printf format specifiers:
19808 FIELD_WIDTH PRECISION PRINTF
19809 ----------------------------------------
19815 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19816 display them, and < 0 means obey the current buffer's value of
19817 enable_multibyte_characters.
19819 Value is the number of columns displayed. */
19822 display_string (unsigned char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19823 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19824 int field_width
, int precision
, int max_x
, int multibyte
)
19826 int hpos_at_start
= it
->hpos
;
19827 int saved_face_id
= it
->face_id
;
19828 struct glyph_row
*row
= it
->glyph_row
;
19830 /* Initialize the iterator IT for iteration over STRING beginning
19831 with index START. */
19832 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19833 precision
, field_width
, multibyte
);
19834 if (string
&& STRINGP (lisp_string
))
19835 /* LISP_STRING is the one returned by decode_mode_spec. We should
19836 ignore its text properties. */
19837 it
->stop_charpos
= -1;
19839 /* If displaying STRING, set up the face of the iterator
19840 from LISP_STRING, if that's given. */
19841 if (STRINGP (face_string
))
19847 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19848 0, it
->region_beg_charpos
,
19849 it
->region_end_charpos
,
19850 &endptr
, it
->base_face_id
, 0);
19851 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19852 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19855 /* Set max_x to the maximum allowed X position. Don't let it go
19856 beyond the right edge of the window. */
19858 max_x
= it
->last_visible_x
;
19860 max_x
= min (max_x
, it
->last_visible_x
);
19862 /* Skip over display elements that are not visible. because IT->w is
19864 if (it
->current_x
< it
->first_visible_x
)
19865 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19866 MOVE_TO_POS
| MOVE_TO_X
);
19868 row
->ascent
= it
->max_ascent
;
19869 row
->height
= it
->max_ascent
+ it
->max_descent
;
19870 row
->phys_ascent
= it
->max_phys_ascent
;
19871 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19872 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19874 /* This condition is for the case that we are called with current_x
19875 past last_visible_x. */
19876 while (it
->current_x
< max_x
)
19878 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19880 /* Get the next display element. */
19881 if (!get_next_display_element (it
))
19884 /* Produce glyphs. */
19885 x_before
= it
->current_x
;
19886 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19887 PRODUCE_GLYPHS (it
);
19889 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19892 while (i
< nglyphs
)
19894 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19896 if (it
->line_wrap
!= TRUNCATE
19897 && x
+ glyph
->pixel_width
> max_x
)
19899 /* End of continued line or max_x reached. */
19900 if (CHAR_GLYPH_PADDING_P (*glyph
))
19902 /* A wide character is unbreakable. */
19903 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19904 it
->current_x
= x_before
;
19908 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19913 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19915 /* Glyph is at least partially visible. */
19917 if (x
< it
->first_visible_x
)
19918 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19922 /* Glyph is off the left margin of the display area.
19923 Should not happen. */
19927 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19928 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19929 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19930 row
->phys_height
= max (row
->phys_height
,
19931 it
->max_phys_ascent
+ it
->max_phys_descent
);
19932 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19933 it
->max_extra_line_spacing
);
19934 x
+= glyph
->pixel_width
;
19938 /* Stop if max_x reached. */
19942 /* Stop at line ends. */
19943 if (ITERATOR_AT_END_OF_LINE_P (it
))
19945 it
->continuation_lines_width
= 0;
19949 set_iterator_to_next (it
, 1);
19951 /* Stop if truncating at the right edge. */
19952 if (it
->line_wrap
== TRUNCATE
19953 && it
->current_x
>= it
->last_visible_x
)
19955 /* Add truncation mark, but don't do it if the line is
19956 truncated at a padding space. */
19957 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19959 if (!FRAME_WINDOW_P (it
->f
))
19963 if (it
->current_x
> it
->last_visible_x
)
19965 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19966 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19968 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19970 row
->used
[TEXT_AREA
] = i
;
19971 produce_special_glyphs (it
, IT_TRUNCATION
);
19974 produce_special_glyphs (it
, IT_TRUNCATION
);
19976 it
->glyph_row
->truncated_on_right_p
= 1;
19982 /* Maybe insert a truncation at the left. */
19983 if (it
->first_visible_x
19984 && IT_CHARPOS (*it
) > 0)
19986 if (!FRAME_WINDOW_P (it
->f
))
19987 insert_left_trunc_glyphs (it
);
19988 it
->glyph_row
->truncated_on_left_p
= 1;
19991 it
->face_id
= saved_face_id
;
19993 /* Value is number of columns displayed. */
19994 return it
->hpos
- hpos_at_start
;
19999 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20000 appears as an element of LIST or as the car of an element of LIST.
20001 If PROPVAL is a list, compare each element against LIST in that
20002 way, and return 1/2 if any element of PROPVAL is found in LIST.
20003 Otherwise return 0. This function cannot quit.
20004 The return value is 2 if the text is invisible but with an ellipsis
20005 and 1 if it's invisible and without an ellipsis. */
20008 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20010 register Lisp_Object tail
, proptail
;
20012 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20014 register Lisp_Object tem
;
20016 if (EQ (propval
, tem
))
20018 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20019 return NILP (XCDR (tem
)) ? 1 : 2;
20022 if (CONSP (propval
))
20024 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20026 Lisp_Object propelt
;
20027 propelt
= XCAR (proptail
);
20028 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20030 register Lisp_Object tem
;
20032 if (EQ (propelt
, tem
))
20034 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20035 return NILP (XCDR (tem
)) ? 1 : 2;
20043 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20044 doc
: /* Non-nil if the property makes the text invisible.
20045 POS-OR-PROP can be a marker or number, in which case it is taken to be
20046 a position in the current buffer and the value of the `invisible' property
20047 is checked; or it can be some other value, which is then presumed to be the
20048 value of the `invisible' property of the text of interest.
20049 The non-nil value returned can be t for truly invisible text or something
20050 else if the text is replaced by an ellipsis. */)
20051 (Lisp_Object pos_or_prop
)
20054 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20055 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20057 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20058 return (invis
== 0 ? Qnil
20060 : make_number (invis
));
20063 /* Calculate a width or height in pixels from a specification using
20064 the following elements:
20067 NUM - a (fractional) multiple of the default font width/height
20068 (NUM) - specifies exactly NUM pixels
20069 UNIT - a fixed number of pixels, see below.
20070 ELEMENT - size of a display element in pixels, see below.
20071 (NUM . SPEC) - equals NUM * SPEC
20072 (+ SPEC SPEC ...) - add pixel values
20073 (- SPEC SPEC ...) - subtract pixel values
20074 (- SPEC) - negate pixel value
20077 INT or FLOAT - a number constant
20078 SYMBOL - use symbol's (buffer local) variable binding.
20081 in - pixels per inch *)
20082 mm - pixels per 1/1000 meter *)
20083 cm - pixels per 1/100 meter *)
20084 width - width of current font in pixels.
20085 height - height of current font in pixels.
20087 *) using the ratio(s) defined in display-pixels-per-inch.
20091 left-fringe - left fringe width in pixels
20092 right-fringe - right fringe width in pixels
20094 left-margin - left margin width in pixels
20095 right-margin - right margin width in pixels
20097 scroll-bar - scroll-bar area width in pixels
20101 Pixels corresponding to 5 inches:
20104 Total width of non-text areas on left side of window (if scroll-bar is on left):
20105 '(space :width (+ left-fringe left-margin scroll-bar))
20107 Align to first text column (in header line):
20108 '(space :align-to 0)
20110 Align to middle of text area minus half the width of variable `my-image'
20111 containing a loaded image:
20112 '(space :align-to (0.5 . (- text my-image)))
20114 Width of left margin minus width of 1 character in the default font:
20115 '(space :width (- left-margin 1))
20117 Width of left margin minus width of 2 characters in the current font:
20118 '(space :width (- left-margin (2 . width)))
20120 Center 1 character over left-margin (in header line):
20121 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20123 Different ways to express width of left fringe plus left margin minus one pixel:
20124 '(space :width (- (+ left-fringe left-margin) (1)))
20125 '(space :width (+ left-fringe left-margin (- (1))))
20126 '(space :width (+ left-fringe left-margin (-1)))
20130 #define NUMVAL(X) \
20131 ((INTEGERP (X) || FLOATP (X)) \
20136 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20137 struct font
*font
, int width_p
, int *align_to
)
20141 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20142 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20145 return OK_PIXELS (0);
20147 xassert (FRAME_LIVE_P (it
->f
));
20149 if (SYMBOLP (prop
))
20151 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20153 char *unit
= SDATA (SYMBOL_NAME (prop
));
20155 if (unit
[0] == 'i' && unit
[1] == 'n')
20157 else if (unit
[0] == 'm' && unit
[1] == 'm')
20159 else if (unit
[0] == 'c' && unit
[1] == 'm')
20166 #ifdef HAVE_WINDOW_SYSTEM
20167 if (FRAME_WINDOW_P (it
->f
)
20169 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20170 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20172 return OK_PIXELS (ppi
/ pixels
);
20175 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20176 || (CONSP (Vdisplay_pixels_per_inch
)
20178 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20179 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20181 return OK_PIXELS (ppi
/ pixels
);
20187 #ifdef HAVE_WINDOW_SYSTEM
20188 if (EQ (prop
, Qheight
))
20189 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20190 if (EQ (prop
, Qwidth
))
20191 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20193 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20194 return OK_PIXELS (1);
20197 if (EQ (prop
, Qtext
))
20198 return OK_PIXELS (width_p
20199 ? window_box_width (it
->w
, TEXT_AREA
)
20200 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20202 if (align_to
&& *align_to
< 0)
20205 if (EQ (prop
, Qleft
))
20206 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20207 if (EQ (prop
, Qright
))
20208 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20209 if (EQ (prop
, Qcenter
))
20210 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20211 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20212 if (EQ (prop
, Qleft_fringe
))
20213 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20214 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20215 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20216 if (EQ (prop
, Qright_fringe
))
20217 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20218 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20219 : window_box_right_offset (it
->w
, TEXT_AREA
));
20220 if (EQ (prop
, Qleft_margin
))
20221 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20222 if (EQ (prop
, Qright_margin
))
20223 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20224 if (EQ (prop
, Qscroll_bar
))
20225 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20227 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20228 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20229 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20234 if (EQ (prop
, Qleft_fringe
))
20235 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20236 if (EQ (prop
, Qright_fringe
))
20237 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20238 if (EQ (prop
, Qleft_margin
))
20239 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20240 if (EQ (prop
, Qright_margin
))
20241 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20242 if (EQ (prop
, Qscroll_bar
))
20243 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20246 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20249 if (INTEGERP (prop
) || FLOATP (prop
))
20251 int base_unit
= (width_p
20252 ? FRAME_COLUMN_WIDTH (it
->f
)
20253 : FRAME_LINE_HEIGHT (it
->f
));
20254 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20259 Lisp_Object car
= XCAR (prop
);
20260 Lisp_Object cdr
= XCDR (prop
);
20264 #ifdef HAVE_WINDOW_SYSTEM
20265 if (FRAME_WINDOW_P (it
->f
)
20266 && valid_image_p (prop
))
20268 int id
= lookup_image (it
->f
, prop
);
20269 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20271 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20274 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20280 while (CONSP (cdr
))
20282 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20283 font
, width_p
, align_to
))
20286 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20291 if (EQ (car
, Qminus
))
20293 return OK_PIXELS (pixels
);
20296 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20299 if (INTEGERP (car
) || FLOATP (car
))
20302 pixels
= XFLOATINT (car
);
20304 return OK_PIXELS (pixels
);
20305 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20306 font
, width_p
, align_to
))
20307 return OK_PIXELS (pixels
* fact
);
20318 /***********************************************************************
20320 ***********************************************************************/
20322 #ifdef HAVE_WINDOW_SYSTEM
20327 dump_glyph_string (s
)
20328 struct glyph_string
*s
;
20330 fprintf (stderr
, "glyph string\n");
20331 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20332 s
->x
, s
->y
, s
->width
, s
->height
);
20333 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20334 fprintf (stderr
, " hl = %d\n", s
->hl
);
20335 fprintf (stderr
, " left overhang = %d, right = %d\n",
20336 s
->left_overhang
, s
->right_overhang
);
20337 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20338 fprintf (stderr
, " extends to end of line = %d\n",
20339 s
->extends_to_end_of_line_p
);
20340 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20341 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20344 #endif /* GLYPH_DEBUG */
20346 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20347 of XChar2b structures for S; it can't be allocated in
20348 init_glyph_string because it must be allocated via `alloca'. W
20349 is the window on which S is drawn. ROW and AREA are the glyph row
20350 and area within the row from which S is constructed. START is the
20351 index of the first glyph structure covered by S. HL is a
20352 face-override for drawing S. */
20355 #define OPTIONAL_HDC(hdc) HDC hdc,
20356 #define DECLARE_HDC(hdc) HDC hdc;
20357 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20358 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20361 #ifndef OPTIONAL_HDC
20362 #define OPTIONAL_HDC(hdc)
20363 #define DECLARE_HDC(hdc)
20364 #define ALLOCATE_HDC(hdc, f)
20365 #define RELEASE_HDC(hdc, f)
20369 init_glyph_string (struct glyph_string
*s
,
20371 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20372 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20374 memset (s
, 0, sizeof *s
);
20376 s
->f
= XFRAME (w
->frame
);
20380 s
->display
= FRAME_X_DISPLAY (s
->f
);
20381 s
->window
= FRAME_X_WINDOW (s
->f
);
20382 s
->char2b
= char2b
;
20386 s
->first_glyph
= row
->glyphs
[area
] + start
;
20387 s
->height
= row
->height
;
20388 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20389 s
->ybase
= s
->y
+ row
->ascent
;
20393 /* Append the list of glyph strings with head H and tail T to the list
20394 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20397 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20398 struct glyph_string
*h
, struct glyph_string
*t
)
20412 /* Prepend the list of glyph strings with head H and tail T to the
20413 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20417 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20418 struct glyph_string
*h
, struct glyph_string
*t
)
20432 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20433 Set *HEAD and *TAIL to the resulting list. */
20436 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20437 struct glyph_string
*s
)
20439 s
->next
= s
->prev
= NULL
;
20440 append_glyph_string_lists (head
, tail
, s
, s
);
20444 /* Get face and two-byte form of character C in face FACE_ID on frame
20445 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20446 means we want to display multibyte text. DISPLAY_P non-zero means
20447 make sure that X resources for the face returned are allocated.
20448 Value is a pointer to a realized face that is ready for display if
20449 DISPLAY_P is non-zero. */
20451 static INLINE
struct face
*
20452 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20453 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20455 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20459 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20461 if (code
!= FONT_INVALID_CODE
)
20462 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20464 STORE_XCHAR2B (char2b
, 0, 0);
20467 /* Make sure X resources of the face are allocated. */
20468 #ifdef HAVE_X_WINDOWS
20472 xassert (face
!= NULL
);
20473 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20480 /* Get face and two-byte form of character glyph GLYPH on frame F.
20481 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20482 a pointer to a realized face that is ready for display. */
20484 static INLINE
struct face
*
20485 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20486 XChar2b
*char2b
, int *two_byte_p
)
20490 xassert (glyph
->type
== CHAR_GLYPH
);
20491 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20498 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20500 if (code
!= FONT_INVALID_CODE
)
20501 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20503 STORE_XCHAR2B (char2b
, 0, 0);
20506 /* Make sure X resources of the face are allocated. */
20507 xassert (face
!= NULL
);
20508 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20513 /* Fill glyph string S with composition components specified by S->cmp.
20515 BASE_FACE is the base face of the composition.
20516 S->cmp_from is the index of the first component for S.
20518 OVERLAPS non-zero means S should draw the foreground only, and use
20519 its physical height for clipping. See also draw_glyphs.
20521 Value is the index of a component not in S. */
20524 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20528 /* For all glyphs of this composition, starting at the offset
20529 S->cmp_from, until we reach the end of the definition or encounter a
20530 glyph that requires the different face, add it to S. */
20535 s
->for_overlaps
= overlaps
;
20538 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20540 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20544 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20547 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20548 s
->char2b
+ i
, 1, 1);
20554 s
->font
= s
->face
->font
;
20556 else if (s
->face
!= face
)
20564 /* All glyph strings for the same composition has the same width,
20565 i.e. the width set for the first component of the composition. */
20566 s
->width
= s
->first_glyph
->pixel_width
;
20568 /* If the specified font could not be loaded, use the frame's
20569 default font, but record the fact that we couldn't load it in
20570 the glyph string so that we can draw rectangles for the
20571 characters of the glyph string. */
20572 if (s
->font
== NULL
)
20574 s
->font_not_found_p
= 1;
20575 s
->font
= FRAME_FONT (s
->f
);
20578 /* Adjust base line for subscript/superscript text. */
20579 s
->ybase
+= s
->first_glyph
->voffset
;
20581 /* This glyph string must always be drawn with 16-bit functions. */
20588 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20589 int start
, int end
, int overlaps
)
20591 struct glyph
*glyph
, *last
;
20592 Lisp_Object lgstring
;
20595 s
->for_overlaps
= overlaps
;
20596 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20597 last
= s
->row
->glyphs
[s
->area
] + end
;
20598 s
->cmp_id
= glyph
->u
.cmp
.id
;
20599 s
->cmp_from
= glyph
->u
.cmp
.from
;
20600 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20601 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20602 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20603 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20605 while (glyph
< last
20606 && glyph
->u
.cmp
.automatic
20607 && glyph
->u
.cmp
.id
== s
->cmp_id
20608 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20609 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20611 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20613 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20614 unsigned code
= LGLYPH_CODE (lglyph
);
20616 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20618 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20619 return glyph
- s
->row
->glyphs
[s
->area
];
20623 /* Fill glyph string S from a sequence of character glyphs.
20625 FACE_ID is the face id of the string. START is the index of the
20626 first glyph to consider, END is the index of the last + 1.
20627 OVERLAPS non-zero means S should draw the foreground only, and use
20628 its physical height for clipping. See also draw_glyphs.
20630 Value is the index of the first glyph not in S. */
20633 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20634 int start
, int end
, int overlaps
)
20636 struct glyph
*glyph
, *last
;
20638 int glyph_not_available_p
;
20640 xassert (s
->f
== XFRAME (s
->w
->frame
));
20641 xassert (s
->nchars
== 0);
20642 xassert (start
>= 0 && end
> start
);
20644 s
->for_overlaps
= overlaps
;
20645 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20646 last
= s
->row
->glyphs
[s
->area
] + end
;
20647 voffset
= glyph
->voffset
;
20648 s
->padding_p
= glyph
->padding_p
;
20649 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20651 while (glyph
< last
20652 && glyph
->type
== CHAR_GLYPH
20653 && glyph
->voffset
== voffset
20654 /* Same face id implies same font, nowadays. */
20655 && glyph
->face_id
== face_id
20656 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20660 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20661 s
->char2b
+ s
->nchars
,
20663 s
->two_byte_p
= two_byte_p
;
20665 xassert (s
->nchars
<= end
- start
);
20666 s
->width
+= glyph
->pixel_width
;
20667 if (glyph
++->padding_p
!= s
->padding_p
)
20671 s
->font
= s
->face
->font
;
20673 /* If the specified font could not be loaded, use the frame's font,
20674 but record the fact that we couldn't load it in
20675 S->font_not_found_p so that we can draw rectangles for the
20676 characters of the glyph string. */
20677 if (s
->font
== NULL
|| glyph_not_available_p
)
20679 s
->font_not_found_p
= 1;
20680 s
->font
= FRAME_FONT (s
->f
);
20683 /* Adjust base line for subscript/superscript text. */
20684 s
->ybase
+= voffset
;
20686 xassert (s
->face
&& s
->face
->gc
);
20687 return glyph
- s
->row
->glyphs
[s
->area
];
20691 /* Fill glyph string S from image glyph S->first_glyph. */
20694 fill_image_glyph_string (struct glyph_string
*s
)
20696 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20697 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20699 s
->slice
= s
->first_glyph
->slice
;
20700 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20701 s
->font
= s
->face
->font
;
20702 s
->width
= s
->first_glyph
->pixel_width
;
20704 /* Adjust base line for subscript/superscript text. */
20705 s
->ybase
+= s
->first_glyph
->voffset
;
20709 /* Fill glyph string S from a sequence of stretch glyphs.
20711 ROW is the glyph row in which the glyphs are found, AREA is the
20712 area within the row. START is the index of the first glyph to
20713 consider, END is the index of the last + 1.
20715 Value is the index of the first glyph not in S. */
20718 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20719 enum glyph_row_area area
, int start
, int end
)
20721 struct glyph
*glyph
, *last
;
20722 int voffset
, face_id
;
20724 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20726 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20727 last
= s
->row
->glyphs
[s
->area
] + end
;
20728 face_id
= glyph
->face_id
;
20729 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20730 s
->font
= s
->face
->font
;
20731 s
->width
= glyph
->pixel_width
;
20733 voffset
= glyph
->voffset
;
20737 && glyph
->type
== STRETCH_GLYPH
20738 && glyph
->voffset
== voffset
20739 && glyph
->face_id
== face_id
);
20741 s
->width
+= glyph
->pixel_width
;
20743 /* Adjust base line for subscript/superscript text. */
20744 s
->ybase
+= voffset
;
20746 /* The case that face->gc == 0 is handled when drawing the glyph
20747 string by calling PREPARE_FACE_FOR_DISPLAY. */
20749 return glyph
- s
->row
->glyphs
[s
->area
];
20752 static struct font_metrics
*
20753 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20755 static struct font_metrics metrics
;
20756 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20758 if (! font
|| code
== FONT_INVALID_CODE
)
20760 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20765 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20766 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20767 assumed to be zero. */
20770 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20772 *left
= *right
= 0;
20774 if (glyph
->type
== CHAR_GLYPH
)
20778 struct font_metrics
*pcm
;
20780 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20781 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20783 if (pcm
->rbearing
> pcm
->width
)
20784 *right
= pcm
->rbearing
- pcm
->width
;
20785 if (pcm
->lbearing
< 0)
20786 *left
= -pcm
->lbearing
;
20789 else if (glyph
->type
== COMPOSITE_GLYPH
)
20791 if (! glyph
->u
.cmp
.automatic
)
20793 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20795 if (cmp
->rbearing
> cmp
->pixel_width
)
20796 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20797 if (cmp
->lbearing
< 0)
20798 *left
= - cmp
->lbearing
;
20802 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20803 struct font_metrics metrics
;
20805 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20806 glyph
->u
.cmp
.to
+ 1, &metrics
);
20807 if (metrics
.rbearing
> metrics
.width
)
20808 *right
= metrics
.rbearing
- metrics
.width
;
20809 if (metrics
.lbearing
< 0)
20810 *left
= - metrics
.lbearing
;
20816 /* Return the index of the first glyph preceding glyph string S that
20817 is overwritten by S because of S's left overhang. Value is -1
20818 if no glyphs are overwritten. */
20821 left_overwritten (struct glyph_string
*s
)
20825 if (s
->left_overhang
)
20828 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20829 int first
= s
->first_glyph
- glyphs
;
20831 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20832 x
-= glyphs
[i
].pixel_width
;
20843 /* Return the index of the first glyph preceding glyph string S that
20844 is overwriting S because of its right overhang. Value is -1 if no
20845 glyph in front of S overwrites S. */
20848 left_overwriting (struct glyph_string
*s
)
20851 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20852 int first
= s
->first_glyph
- glyphs
;
20856 for (i
= first
- 1; i
>= 0; --i
)
20859 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20862 x
-= glyphs
[i
].pixel_width
;
20869 /* Return the index of the last glyph following glyph string S that is
20870 overwritten by S because of S's right overhang. Value is -1 if
20871 no such glyph is found. */
20874 right_overwritten (struct glyph_string
*s
)
20878 if (s
->right_overhang
)
20881 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20882 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20883 int end
= s
->row
->used
[s
->area
];
20885 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20886 x
+= glyphs
[i
].pixel_width
;
20895 /* Return the index of the last glyph following glyph string S that
20896 overwrites S because of its left overhang. Value is negative
20897 if no such glyph is found. */
20900 right_overwriting (struct glyph_string
*s
)
20903 int end
= s
->row
->used
[s
->area
];
20904 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20905 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20909 for (i
= first
; i
< end
; ++i
)
20912 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20915 x
+= glyphs
[i
].pixel_width
;
20922 /* Set background width of glyph string S. START is the index of the
20923 first glyph following S. LAST_X is the right-most x-position + 1
20924 in the drawing area. */
20927 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20929 /* If the face of this glyph string has to be drawn to the end of
20930 the drawing area, set S->extends_to_end_of_line_p. */
20932 if (start
== s
->row
->used
[s
->area
]
20933 && s
->area
== TEXT_AREA
20934 && ((s
->row
->fill_line_p
20935 && (s
->hl
== DRAW_NORMAL_TEXT
20936 || s
->hl
== DRAW_IMAGE_RAISED
20937 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20938 || s
->hl
== DRAW_MOUSE_FACE
))
20939 s
->extends_to_end_of_line_p
= 1;
20941 /* If S extends its face to the end of the line, set its
20942 background_width to the distance to the right edge of the drawing
20944 if (s
->extends_to_end_of_line_p
)
20945 s
->background_width
= last_x
- s
->x
+ 1;
20947 s
->background_width
= s
->width
;
20951 /* Compute overhangs and x-positions for glyph string S and its
20952 predecessors, or successors. X is the starting x-position for S.
20953 BACKWARD_P non-zero means process predecessors. */
20956 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20962 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20963 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20973 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20974 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20984 /* The following macros are only called from draw_glyphs below.
20985 They reference the following parameters of that function directly:
20986 `w', `row', `area', and `overlap_p'
20987 as well as the following local variables:
20988 `s', `f', and `hdc' (in W32) */
20991 /* On W32, silently add local `hdc' variable to argument list of
20992 init_glyph_string. */
20993 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20994 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
20996 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20997 init_glyph_string (s, char2b, w, row, area, start, hl)
21000 /* Add a glyph string for a stretch glyph to the list of strings
21001 between HEAD and TAIL. START is the index of the stretch glyph in
21002 row area AREA of glyph row ROW. END is the index of the last glyph
21003 in that glyph row area. X is the current output position assigned
21004 to the new glyph string constructed. HL overrides that face of the
21005 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21006 is the right-most x-position of the drawing area. */
21008 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21009 and below -- keep them on one line. */
21010 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21013 s = (struct glyph_string *) alloca (sizeof *s); \
21014 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21015 START = fill_stretch_glyph_string (s, row, area, START, END); \
21016 append_glyph_string (&HEAD, &TAIL, s); \
21022 /* Add a glyph string for an image glyph to the list of strings
21023 between HEAD and TAIL. START is the index of the image glyph in
21024 row area AREA of glyph row ROW. END is the index of the last glyph
21025 in that glyph row area. X is the current output position assigned
21026 to the new glyph string constructed. HL overrides that face of the
21027 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21028 is the right-most x-position of the drawing area. */
21030 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21033 s = (struct glyph_string *) alloca (sizeof *s); \
21034 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21035 fill_image_glyph_string (s); \
21036 append_glyph_string (&HEAD, &TAIL, s); \
21043 /* Add a glyph string for a sequence of character glyphs to the list
21044 of strings between HEAD and TAIL. START is the index of the first
21045 glyph in row area AREA of glyph row ROW that is part of the new
21046 glyph string. END is the index of the last glyph in that glyph row
21047 area. X is the current output position assigned to the new glyph
21048 string constructed. HL overrides that face of the glyph; e.g. it
21049 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21050 right-most x-position of the drawing area. */
21052 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21058 face_id = (row)->glyphs[area][START].face_id; \
21060 s = (struct glyph_string *) alloca (sizeof *s); \
21061 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21062 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21063 append_glyph_string (&HEAD, &TAIL, s); \
21065 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21070 /* Add a glyph string for a composite sequence to the list of strings
21071 between HEAD and TAIL. START is the index of the first glyph in
21072 row area AREA of glyph row ROW that is part of the new glyph
21073 string. END is the index of the last glyph in that glyph row area.
21074 X is the current output position assigned to the new glyph string
21075 constructed. HL overrides that face of the glyph; e.g. it is
21076 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21077 x-position of the drawing area. */
21079 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21081 int face_id = (row)->glyphs[area][START].face_id; \
21082 struct face *base_face = FACE_FROM_ID (f, face_id); \
21083 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21084 struct composition *cmp = composition_table[cmp_id]; \
21086 struct glyph_string *first_s; \
21089 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21091 /* Make glyph_strings for each glyph sequence that is drawable by \
21092 the same face, and append them to HEAD/TAIL. */ \
21093 for (n = 0; n < cmp->glyph_len;) \
21095 s = (struct glyph_string *) alloca (sizeof *s); \
21096 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21097 append_glyph_string (&(HEAD), &(TAIL), s); \
21103 n = fill_composite_glyph_string (s, base_face, overlaps); \
21111 /* Add a glyph string for a glyph-string sequence to the list of strings
21112 between HEAD and TAIL. */
21114 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21118 Lisp_Object gstring; \
21120 face_id = (row)->glyphs[area][START].face_id; \
21121 gstring = (composition_gstring_from_id \
21122 ((row)->glyphs[area][START].u.cmp.id)); \
21123 s = (struct glyph_string *) alloca (sizeof *s); \
21124 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21125 * LGSTRING_GLYPH_LEN (gstring)); \
21126 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21127 append_glyph_string (&(HEAD), &(TAIL), s); \
21129 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21133 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21134 of AREA of glyph row ROW on window W between indices START and END.
21135 HL overrides the face for drawing glyph strings, e.g. it is
21136 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21137 x-positions of the drawing area.
21139 This is an ugly monster macro construct because we must use alloca
21140 to allocate glyph strings (because draw_glyphs can be called
21141 asynchronously). */
21143 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21146 HEAD = TAIL = NULL; \
21147 while (START < END) \
21149 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21150 switch (first_glyph->type) \
21153 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21157 case COMPOSITE_GLYPH: \
21158 if (first_glyph->u.cmp.automatic) \
21159 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21162 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21166 case STRETCH_GLYPH: \
21167 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21171 case IMAGE_GLYPH: \
21172 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21182 set_glyph_string_background_width (s, START, LAST_X); \
21189 /* Draw glyphs between START and END in AREA of ROW on window W,
21190 starting at x-position X. X is relative to AREA in W. HL is a
21191 face-override with the following meaning:
21193 DRAW_NORMAL_TEXT draw normally
21194 DRAW_CURSOR draw in cursor face
21195 DRAW_MOUSE_FACE draw in mouse face.
21196 DRAW_INVERSE_VIDEO draw in mode line face
21197 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21198 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21200 If OVERLAPS is non-zero, draw only the foreground of characters and
21201 clip to the physical height of ROW. Non-zero value also defines
21202 the overlapping part to be drawn:
21204 OVERLAPS_PRED overlap with preceding rows
21205 OVERLAPS_SUCC overlap with succeeding rows
21206 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21207 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21209 Value is the x-position reached, relative to AREA of W. */
21212 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21213 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21214 enum draw_glyphs_face hl
, int overlaps
)
21216 struct glyph_string
*head
, *tail
;
21217 struct glyph_string
*s
;
21218 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21219 int i
, j
, x_reached
, last_x
, area_left
= 0;
21220 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21223 ALLOCATE_HDC (hdc
, f
);
21225 /* Let's rather be paranoid than getting a SEGV. */
21226 end
= min (end
, row
->used
[area
]);
21227 start
= max (0, start
);
21228 start
= min (end
, start
);
21230 /* Translate X to frame coordinates. Set last_x to the right
21231 end of the drawing area. */
21232 if (row
->full_width_p
)
21234 /* X is relative to the left edge of W, without scroll bars
21236 area_left
= WINDOW_LEFT_EDGE_X (w
);
21237 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21241 area_left
= window_box_left (w
, area
);
21242 last_x
= area_left
+ window_box_width (w
, area
);
21246 /* Build a doubly-linked list of glyph_string structures between
21247 head and tail from what we have to draw. Note that the macro
21248 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21249 the reason we use a separate variable `i'. */
21251 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21253 x_reached
= tail
->x
+ tail
->background_width
;
21257 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21258 the row, redraw some glyphs in front or following the glyph
21259 strings built above. */
21260 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21262 struct glyph_string
*h
, *t
;
21263 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21264 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21267 /* If mouse highlighting is on, we may need to draw adjacent
21268 glyphs using mouse-face highlighting. */
21269 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21271 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21273 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21274 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21276 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21278 check_mouse_face
= 1;
21279 mouse_beg_col
= (row
== mouse_beg_row
)
21280 ? dpyinfo
->mouse_face_beg_col
: 0;
21281 mouse_end_col
= (row
== mouse_end_row
)
21282 ? dpyinfo
->mouse_face_end_col
21283 : row
->used
[TEXT_AREA
];
21287 /* Compute overhangs for all glyph strings. */
21288 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21289 for (s
= head
; s
; s
= s
->next
)
21290 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21292 /* Prepend glyph strings for glyphs in front of the first glyph
21293 string that are overwritten because of the first glyph
21294 string's left overhang. The background of all strings
21295 prepended must be drawn because the first glyph string
21297 i
= left_overwritten (head
);
21300 enum draw_glyphs_face overlap_hl
;
21302 /* If this row contains mouse highlighting, attempt to draw
21303 the overlapped glyphs with the correct highlight. This
21304 code fails if the overlap encompasses more than one glyph
21305 and mouse-highlight spans only some of these glyphs.
21306 However, making it work perfectly involves a lot more
21307 code, and I don't know if the pathological case occurs in
21308 practice, so we'll stick to this for now. --- cyd */
21309 if (check_mouse_face
21310 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21311 overlap_hl
= DRAW_MOUSE_FACE
;
21313 overlap_hl
= DRAW_NORMAL_TEXT
;
21316 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21317 overlap_hl
, dummy_x
, last_x
);
21319 compute_overhangs_and_x (t
, head
->x
, 1);
21320 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21324 /* Prepend glyph strings for glyphs in front of the first glyph
21325 string that overwrite that glyph string because of their
21326 right overhang. For these strings, only the foreground must
21327 be drawn, because it draws over the glyph string at `head'.
21328 The background must not be drawn because this would overwrite
21329 right overhangs of preceding glyphs for which no glyph
21331 i
= left_overwriting (head
);
21334 enum draw_glyphs_face overlap_hl
;
21336 if (check_mouse_face
21337 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21338 overlap_hl
= DRAW_MOUSE_FACE
;
21340 overlap_hl
= DRAW_NORMAL_TEXT
;
21343 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21344 overlap_hl
, dummy_x
, last_x
);
21345 for (s
= h
; s
; s
= s
->next
)
21346 s
->background_filled_p
= 1;
21347 compute_overhangs_and_x (t
, head
->x
, 1);
21348 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21351 /* Append glyphs strings for glyphs following the last glyph
21352 string tail that are overwritten by tail. The background of
21353 these strings has to be drawn because tail's foreground draws
21355 i
= right_overwritten (tail
);
21358 enum draw_glyphs_face overlap_hl
;
21360 if (check_mouse_face
21361 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21362 overlap_hl
= DRAW_MOUSE_FACE
;
21364 overlap_hl
= DRAW_NORMAL_TEXT
;
21366 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21367 overlap_hl
, x
, last_x
);
21368 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21369 we don't have `end = i;' here. */
21370 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21371 append_glyph_string_lists (&head
, &tail
, h
, t
);
21375 /* Append glyph strings for glyphs following the last glyph
21376 string tail that overwrite tail. The foreground of such
21377 glyphs has to be drawn because it writes into the background
21378 of tail. The background must not be drawn because it could
21379 paint over the foreground of following glyphs. */
21380 i
= right_overwriting (tail
);
21383 enum draw_glyphs_face overlap_hl
;
21384 if (check_mouse_face
21385 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21386 overlap_hl
= DRAW_MOUSE_FACE
;
21388 overlap_hl
= DRAW_NORMAL_TEXT
;
21391 i
++; /* We must include the Ith glyph. */
21392 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21393 overlap_hl
, x
, last_x
);
21394 for (s
= h
; s
; s
= s
->next
)
21395 s
->background_filled_p
= 1;
21396 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21397 append_glyph_string_lists (&head
, &tail
, h
, t
);
21399 if (clip_head
|| clip_tail
)
21400 for (s
= head
; s
; s
= s
->next
)
21402 s
->clip_head
= clip_head
;
21403 s
->clip_tail
= clip_tail
;
21407 /* Draw all strings. */
21408 for (s
= head
; s
; s
= s
->next
)
21409 FRAME_RIF (f
)->draw_glyph_string (s
);
21412 /* When focus a sole frame and move horizontally, this sets on_p to 0
21413 causing a failure to erase prev cursor position. */
21414 if (area
== TEXT_AREA
21415 && !row
->full_width_p
21416 /* When drawing overlapping rows, only the glyph strings'
21417 foreground is drawn, which doesn't erase a cursor
21421 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21422 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21423 : (tail
? tail
->x
+ tail
->background_width
: x
));
21427 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21428 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21432 /* Value is the x-position up to which drawn, relative to AREA of W.
21433 This doesn't include parts drawn because of overhangs. */
21434 if (row
->full_width_p
)
21435 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21437 x_reached
-= area_left
;
21439 RELEASE_HDC (hdc
, f
);
21444 /* Expand row matrix if too narrow. Don't expand if area
21447 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21449 if (!fonts_changed_p \
21450 && (it->glyph_row->glyphs[area] \
21451 < it->glyph_row->glyphs[area + 1])) \
21453 it->w->ncols_scale_factor++; \
21454 fonts_changed_p = 1; \
21458 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21459 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21462 append_glyph (struct it
*it
)
21464 struct glyph
*glyph
;
21465 enum glyph_row_area area
= it
->area
;
21467 xassert (it
->glyph_row
);
21468 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21470 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21471 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21473 /* If the glyph row is reversed, we need to prepend the glyph
21474 rather than append it. */
21475 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21479 /* Make room for the additional glyph. */
21480 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21482 glyph
= it
->glyph_row
->glyphs
[area
];
21484 glyph
->charpos
= CHARPOS (it
->position
);
21485 glyph
->object
= it
->object
;
21486 if (it
->pixel_width
> 0)
21488 glyph
->pixel_width
= it
->pixel_width
;
21489 glyph
->padding_p
= 0;
21493 /* Assure at least 1-pixel width. Otherwise, cursor can't
21494 be displayed correctly. */
21495 glyph
->pixel_width
= 1;
21496 glyph
->padding_p
= 1;
21498 glyph
->ascent
= it
->ascent
;
21499 glyph
->descent
= it
->descent
;
21500 glyph
->voffset
= it
->voffset
;
21501 glyph
->type
= CHAR_GLYPH
;
21502 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21503 glyph
->multibyte_p
= it
->multibyte_p
;
21504 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21505 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21506 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21507 || it
->phys_descent
> it
->descent
);
21508 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21509 glyph
->face_id
= it
->face_id
;
21510 glyph
->u
.ch
= it
->char_to_display
;
21511 glyph
->slice
= null_glyph_slice
;
21512 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21515 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21516 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21518 glyph
->bidi_type
= it
->bidi_it
.type
;
21522 glyph
->resolved_level
= 0;
21523 glyph
->bidi_type
= UNKNOWN_BT
;
21525 ++it
->glyph_row
->used
[area
];
21528 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21531 /* Store one glyph for the composition IT->cmp_it.id in
21532 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21536 append_composite_glyph (struct it
*it
)
21538 struct glyph
*glyph
;
21539 enum glyph_row_area area
= it
->area
;
21541 xassert (it
->glyph_row
);
21543 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21544 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21546 /* If the glyph row is reversed, we need to prepend the glyph
21547 rather than append it. */
21548 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21552 /* Make room for the new glyph. */
21553 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21555 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21557 glyph
->charpos
= it
->cmp_it
.charpos
;
21558 glyph
->object
= it
->object
;
21559 glyph
->pixel_width
= it
->pixel_width
;
21560 glyph
->ascent
= it
->ascent
;
21561 glyph
->descent
= it
->descent
;
21562 glyph
->voffset
= it
->voffset
;
21563 glyph
->type
= COMPOSITE_GLYPH
;
21564 if (it
->cmp_it
.ch
< 0)
21566 glyph
->u
.cmp
.automatic
= 0;
21567 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21571 glyph
->u
.cmp
.automatic
= 1;
21572 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21573 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21574 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21576 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21577 glyph
->multibyte_p
= it
->multibyte_p
;
21578 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21579 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21580 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21581 || it
->phys_descent
> it
->descent
);
21582 glyph
->padding_p
= 0;
21583 glyph
->glyph_not_available_p
= 0;
21584 glyph
->face_id
= it
->face_id
;
21585 glyph
->slice
= null_glyph_slice
;
21586 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21589 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21590 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21592 glyph
->bidi_type
= it
->bidi_it
.type
;
21594 ++it
->glyph_row
->used
[area
];
21597 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21601 /* Change IT->ascent and IT->height according to the setting of
21605 take_vertical_position_into_account (struct it
*it
)
21609 if (it
->voffset
< 0)
21610 /* Increase the ascent so that we can display the text higher
21612 it
->ascent
-= it
->voffset
;
21614 /* Increase the descent so that we can display the text lower
21616 it
->descent
+= it
->voffset
;
21621 /* Produce glyphs/get display metrics for the image IT is loaded with.
21622 See the description of struct display_iterator in dispextern.h for
21623 an overview of struct display_iterator. */
21626 produce_image_glyph (struct it
*it
)
21630 int glyph_ascent
, crop
;
21631 struct glyph_slice slice
;
21633 xassert (it
->what
== IT_IMAGE
);
21635 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21637 /* Make sure X resources of the face is loaded. */
21638 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21640 if (it
->image_id
< 0)
21642 /* Fringe bitmap. */
21643 it
->ascent
= it
->phys_ascent
= 0;
21644 it
->descent
= it
->phys_descent
= 0;
21645 it
->pixel_width
= 0;
21650 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21652 /* Make sure X resources of the image is loaded. */
21653 prepare_image_for_display (it
->f
, img
);
21655 slice
.x
= slice
.y
= 0;
21656 slice
.width
= img
->width
;
21657 slice
.height
= img
->height
;
21659 if (INTEGERP (it
->slice
.x
))
21660 slice
.x
= XINT (it
->slice
.x
);
21661 else if (FLOATP (it
->slice
.x
))
21662 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21664 if (INTEGERP (it
->slice
.y
))
21665 slice
.y
= XINT (it
->slice
.y
);
21666 else if (FLOATP (it
->slice
.y
))
21667 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21669 if (INTEGERP (it
->slice
.width
))
21670 slice
.width
= XINT (it
->slice
.width
);
21671 else if (FLOATP (it
->slice
.width
))
21672 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21674 if (INTEGERP (it
->slice
.height
))
21675 slice
.height
= XINT (it
->slice
.height
);
21676 else if (FLOATP (it
->slice
.height
))
21677 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21679 if (slice
.x
>= img
->width
)
21680 slice
.x
= img
->width
;
21681 if (slice
.y
>= img
->height
)
21682 slice
.y
= img
->height
;
21683 if (slice
.x
+ slice
.width
>= img
->width
)
21684 slice
.width
= img
->width
- slice
.x
;
21685 if (slice
.y
+ slice
.height
> img
->height
)
21686 slice
.height
= img
->height
- slice
.y
;
21688 if (slice
.width
== 0 || slice
.height
== 0)
21691 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21693 it
->descent
= slice
.height
- glyph_ascent
;
21695 it
->descent
+= img
->vmargin
;
21696 if (slice
.y
+ slice
.height
== img
->height
)
21697 it
->descent
+= img
->vmargin
;
21698 it
->phys_descent
= it
->descent
;
21700 it
->pixel_width
= slice
.width
;
21702 it
->pixel_width
+= img
->hmargin
;
21703 if (slice
.x
+ slice
.width
== img
->width
)
21704 it
->pixel_width
+= img
->hmargin
;
21706 /* It's quite possible for images to have an ascent greater than
21707 their height, so don't get confused in that case. */
21708 if (it
->descent
< 0)
21713 if (face
->box
!= FACE_NO_BOX
)
21715 if (face
->box_line_width
> 0)
21718 it
->ascent
+= face
->box_line_width
;
21719 if (slice
.y
+ slice
.height
== img
->height
)
21720 it
->descent
+= face
->box_line_width
;
21723 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21724 it
->pixel_width
+= eabs (face
->box_line_width
);
21725 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21726 it
->pixel_width
+= eabs (face
->box_line_width
);
21729 take_vertical_position_into_account (it
);
21731 /* Automatically crop wide image glyphs at right edge so we can
21732 draw the cursor on same display row. */
21733 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21734 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21736 it
->pixel_width
-= crop
;
21737 slice
.width
-= crop
;
21742 struct glyph
*glyph
;
21743 enum glyph_row_area area
= it
->area
;
21745 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21746 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21748 glyph
->charpos
= CHARPOS (it
->position
);
21749 glyph
->object
= it
->object
;
21750 glyph
->pixel_width
= it
->pixel_width
;
21751 glyph
->ascent
= glyph_ascent
;
21752 glyph
->descent
= it
->descent
;
21753 glyph
->voffset
= it
->voffset
;
21754 glyph
->type
= IMAGE_GLYPH
;
21755 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21756 glyph
->multibyte_p
= it
->multibyte_p
;
21757 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21758 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21759 glyph
->overlaps_vertically_p
= 0;
21760 glyph
->padding_p
= 0;
21761 glyph
->glyph_not_available_p
= 0;
21762 glyph
->face_id
= it
->face_id
;
21763 glyph
->u
.img_id
= img
->id
;
21764 glyph
->slice
= slice
;
21765 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21768 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21769 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21771 glyph
->bidi_type
= it
->bidi_it
.type
;
21773 ++it
->glyph_row
->used
[area
];
21776 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21781 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21782 of the glyph, WIDTH and HEIGHT are the width and height of the
21783 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21786 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21787 int width
, int height
, int ascent
)
21789 struct glyph
*glyph
;
21790 enum glyph_row_area area
= it
->area
;
21792 xassert (ascent
>= 0 && ascent
<= height
);
21794 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21795 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21797 /* If the glyph row is reversed, we need to prepend the glyph
21798 rather than append it. */
21799 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21803 /* Make room for the additional glyph. */
21804 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21806 glyph
= it
->glyph_row
->glyphs
[area
];
21808 glyph
->charpos
= CHARPOS (it
->position
);
21809 glyph
->object
= object
;
21810 glyph
->pixel_width
= width
;
21811 glyph
->ascent
= ascent
;
21812 glyph
->descent
= height
- ascent
;
21813 glyph
->voffset
= it
->voffset
;
21814 glyph
->type
= STRETCH_GLYPH
;
21815 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21816 glyph
->multibyte_p
= it
->multibyte_p
;
21817 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21818 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21819 glyph
->overlaps_vertically_p
= 0;
21820 glyph
->padding_p
= 0;
21821 glyph
->glyph_not_available_p
= 0;
21822 glyph
->face_id
= it
->face_id
;
21823 glyph
->u
.stretch
.ascent
= ascent
;
21824 glyph
->u
.stretch
.height
= height
;
21825 glyph
->slice
= null_glyph_slice
;
21826 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21829 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21830 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21832 glyph
->bidi_type
= it
->bidi_it
.type
;
21836 glyph
->resolved_level
= 0;
21837 glyph
->bidi_type
= UNKNOWN_BT
;
21839 ++it
->glyph_row
->used
[area
];
21842 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21846 /* Produce a stretch glyph for iterator IT. IT->object is the value
21847 of the glyph property displayed. The value must be a list
21848 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21851 1. `:width WIDTH' specifies that the space should be WIDTH *
21852 canonical char width wide. WIDTH may be an integer or floating
21855 2. `:relative-width FACTOR' specifies that the width of the stretch
21856 should be computed from the width of the first character having the
21857 `glyph' property, and should be FACTOR times that width.
21859 3. `:align-to HPOS' specifies that the space should be wide enough
21860 to reach HPOS, a value in canonical character units.
21862 Exactly one of the above pairs must be present.
21864 4. `:height HEIGHT' specifies that the height of the stretch produced
21865 should be HEIGHT, measured in canonical character units.
21867 5. `:relative-height FACTOR' specifies that the height of the
21868 stretch should be FACTOR times the height of the characters having
21869 the glyph property.
21871 Either none or exactly one of 4 or 5 must be present.
21873 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21874 of the stretch should be used for the ascent of the stretch.
21875 ASCENT must be in the range 0 <= ASCENT <= 100. */
21878 produce_stretch_glyph (struct it
*it
)
21880 /* (space :width WIDTH :height HEIGHT ...) */
21881 Lisp_Object prop
, plist
;
21882 int width
= 0, height
= 0, align_to
= -1;
21883 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21886 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21887 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21889 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21891 /* List should start with `space'. */
21892 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21893 plist
= XCDR (it
->object
);
21895 /* Compute the width of the stretch. */
21896 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21897 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21899 /* Absolute width `:width WIDTH' specified and valid. */
21900 zero_width_ok_p
= 1;
21903 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21906 /* Relative width `:relative-width FACTOR' specified and valid.
21907 Compute the width of the characters having the `glyph'
21910 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21913 if (it
->multibyte_p
)
21915 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21916 - IT_BYTEPOS (*it
));
21917 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21920 it2
.c
= *p
, it2
.len
= 1;
21922 it2
.glyph_row
= NULL
;
21923 it2
.what
= IT_CHARACTER
;
21924 x_produce_glyphs (&it2
);
21925 width
= NUMVAL (prop
) * it2
.pixel_width
;
21927 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21928 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21930 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21931 align_to
= (align_to
< 0
21933 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21934 else if (align_to
< 0)
21935 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21936 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21937 zero_width_ok_p
= 1;
21940 /* Nothing specified -> width defaults to canonical char width. */
21941 width
= FRAME_COLUMN_WIDTH (it
->f
);
21943 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21946 /* Compute height. */
21947 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21948 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21951 zero_height_ok_p
= 1;
21953 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21955 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21957 height
= FONT_HEIGHT (font
);
21959 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21962 /* Compute percentage of height used for ascent. If
21963 `:ascent ASCENT' is present and valid, use that. Otherwise,
21964 derive the ascent from the font in use. */
21965 if (prop
= Fplist_get (plist
, QCascent
),
21966 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21967 ascent
= height
* NUMVAL (prop
) / 100.0;
21968 else if (!NILP (prop
)
21969 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21970 ascent
= min (max (0, (int)tem
), height
);
21972 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21974 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21975 && it
->current_x
+ width
> it
->last_visible_x
)
21976 width
= it
->last_visible_x
- it
->current_x
- 1;
21978 if (width
> 0 && height
> 0 && it
->glyph_row
)
21980 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21981 if (!STRINGP (object
))
21982 object
= it
->w
->buffer
;
21983 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21986 it
->pixel_width
= width
;
21987 it
->ascent
= it
->phys_ascent
= ascent
;
21988 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21989 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21991 take_vertical_position_into_account (it
);
21994 /* Calculate line-height and line-spacing properties.
21995 An integer value specifies explicit pixel value.
21996 A float value specifies relative value to current face height.
21997 A cons (float . face-name) specifies relative value to
21998 height of specified face font.
22000 Returns height in pixels, or nil. */
22004 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22005 int boff
, int override
)
22007 Lisp_Object face_name
= Qnil
;
22008 int ascent
, descent
, height
;
22010 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22015 face_name
= XCAR (val
);
22017 if (!NUMBERP (val
))
22018 val
= make_number (1);
22019 if (NILP (face_name
))
22021 height
= it
->ascent
+ it
->descent
;
22026 if (NILP (face_name
))
22028 font
= FRAME_FONT (it
->f
);
22029 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22031 else if (EQ (face_name
, Qt
))
22040 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22042 return make_number (-1);
22044 face
= FACE_FROM_ID (it
->f
, face_id
);
22047 return make_number (-1);
22048 boff
= font
->baseline_offset
;
22049 if (font
->vertical_centering
)
22050 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22053 ascent
= FONT_BASE (font
) + boff
;
22054 descent
= FONT_DESCENT (font
) - boff
;
22058 it
->override_ascent
= ascent
;
22059 it
->override_descent
= descent
;
22060 it
->override_boff
= boff
;
22063 height
= ascent
+ descent
;
22067 height
= (int)(XFLOAT_DATA (val
) * height
);
22068 else if (INTEGERP (val
))
22069 height
*= XINT (val
);
22071 return make_number (height
);
22076 Produce glyphs/get display metrics for the display element IT is
22077 loaded with. See the description of struct it in dispextern.h
22078 for an overview of struct it. */
22081 x_produce_glyphs (struct it
*it
)
22083 int extra_line_spacing
= it
->extra_line_spacing
;
22085 it
->glyph_not_available_p
= 0;
22087 if (it
->what
== IT_CHARACTER
)
22091 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22092 struct font_metrics
*pcm
;
22093 int font_not_found_p
;
22094 int boff
; /* baseline offset */
22095 /* We may change it->multibyte_p upon unibyte<->multibyte
22096 conversion. So, save the current value now and restore it
22099 Note: It seems that we don't have to record multibyte_p in
22100 struct glyph because the character code itself tells whether
22101 or not the character is multibyte. Thus, in the future, we
22102 must consider eliminating the field `multibyte_p' in the
22104 int saved_multibyte_p
= it
->multibyte_p
;
22106 /* Maybe translate single-byte characters to multibyte, or the
22108 it
->char_to_display
= it
->c
;
22109 if (!ASCII_BYTE_P (it
->c
)
22110 && ! it
->multibyte_p
)
22112 if (SINGLE_BYTE_CHAR_P (it
->c
)
22113 && unibyte_display_via_language_environment
)
22115 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
22117 /* get_next_display_element assures that this decoding
22119 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
22120 it
->multibyte_p
= 1;
22121 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
22123 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22127 /* Get font to use. Encode IT->char_to_display. */
22128 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
22129 &char2b
, it
->multibyte_p
, 0);
22132 font_not_found_p
= font
== NULL
;
22133 if (font_not_found_p
)
22135 /* When no suitable font found, display an empty box based
22136 on the metrics of the font of the default face (or what
22138 struct face
*no_font_face
22139 = FACE_FROM_ID (it
->f
,
22140 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22141 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22142 font
= no_font_face
->font
;
22143 boff
= font
->baseline_offset
;
22147 boff
= font
->baseline_offset
;
22148 if (font
->vertical_centering
)
22149 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22152 if (it
->char_to_display
>= ' '
22153 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22155 /* Either unibyte or ASCII. */
22160 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22162 if (it
->override_ascent
>= 0)
22164 it
->ascent
= it
->override_ascent
;
22165 it
->descent
= it
->override_descent
;
22166 boff
= it
->override_boff
;
22170 it
->ascent
= FONT_BASE (font
) + boff
;
22171 it
->descent
= FONT_DESCENT (font
) - boff
;
22176 it
->phys_ascent
= pcm
->ascent
+ boff
;
22177 it
->phys_descent
= pcm
->descent
- boff
;
22178 it
->pixel_width
= pcm
->width
;
22182 it
->glyph_not_available_p
= 1;
22183 it
->phys_ascent
= it
->ascent
;
22184 it
->phys_descent
= it
->descent
;
22185 it
->pixel_width
= FONT_WIDTH (font
);
22188 if (it
->constrain_row_ascent_descent_p
)
22190 if (it
->descent
> it
->max_descent
)
22192 it
->ascent
+= it
->descent
- it
->max_descent
;
22193 it
->descent
= it
->max_descent
;
22195 if (it
->ascent
> it
->max_ascent
)
22197 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22198 it
->ascent
= it
->max_ascent
;
22200 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22201 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22202 extra_line_spacing
= 0;
22205 /* If this is a space inside a region of text with
22206 `space-width' property, change its width. */
22207 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22209 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22211 /* If face has a box, add the box thickness to the character
22212 height. If character has a box line to the left and/or
22213 right, add the box line width to the character's width. */
22214 if (face
->box
!= FACE_NO_BOX
)
22216 int thick
= face
->box_line_width
;
22220 it
->ascent
+= thick
;
22221 it
->descent
+= thick
;
22226 if (it
->start_of_box_run_p
)
22227 it
->pixel_width
+= thick
;
22228 if (it
->end_of_box_run_p
)
22229 it
->pixel_width
+= thick
;
22232 /* If face has an overline, add the height of the overline
22233 (1 pixel) and a 1 pixel margin to the character height. */
22234 if (face
->overline_p
)
22235 it
->ascent
+= overline_margin
;
22237 if (it
->constrain_row_ascent_descent_p
)
22239 if (it
->ascent
> it
->max_ascent
)
22240 it
->ascent
= it
->max_ascent
;
22241 if (it
->descent
> it
->max_descent
)
22242 it
->descent
= it
->max_descent
;
22245 take_vertical_position_into_account (it
);
22247 /* If we have to actually produce glyphs, do it. */
22252 /* Translate a space with a `space-width' property
22253 into a stretch glyph. */
22254 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22255 / FONT_HEIGHT (font
));
22256 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22257 it
->ascent
+ it
->descent
, ascent
);
22262 /* If characters with lbearing or rbearing are displayed
22263 in this line, record that fact in a flag of the
22264 glyph row. This is used to optimize X output code. */
22265 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22266 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22268 if (! stretched_p
&& it
->pixel_width
== 0)
22269 /* We assure that all visible glyphs have at least 1-pixel
22271 it
->pixel_width
= 1;
22273 else if (it
->char_to_display
== '\n')
22275 /* A newline has no width, but we need the height of the
22276 line. But if previous part of the line sets a height,
22277 don't increase that height */
22279 Lisp_Object height
;
22280 Lisp_Object total_height
= Qnil
;
22282 it
->override_ascent
= -1;
22283 it
->pixel_width
= 0;
22286 height
= get_it_property (it
, Qline_height
);
22287 /* Split (line-height total-height) list */
22289 && CONSP (XCDR (height
))
22290 && NILP (XCDR (XCDR (height
))))
22292 total_height
= XCAR (XCDR (height
));
22293 height
= XCAR (height
);
22295 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22297 if (it
->override_ascent
>= 0)
22299 it
->ascent
= it
->override_ascent
;
22300 it
->descent
= it
->override_descent
;
22301 boff
= it
->override_boff
;
22305 it
->ascent
= FONT_BASE (font
) + boff
;
22306 it
->descent
= FONT_DESCENT (font
) - boff
;
22309 if (EQ (height
, Qt
))
22311 if (it
->descent
> it
->max_descent
)
22313 it
->ascent
+= it
->descent
- it
->max_descent
;
22314 it
->descent
= it
->max_descent
;
22316 if (it
->ascent
> it
->max_ascent
)
22318 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22319 it
->ascent
= it
->max_ascent
;
22321 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22322 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22323 it
->constrain_row_ascent_descent_p
= 1;
22324 extra_line_spacing
= 0;
22328 Lisp_Object spacing
;
22330 it
->phys_ascent
= it
->ascent
;
22331 it
->phys_descent
= it
->descent
;
22333 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22334 && face
->box
!= FACE_NO_BOX
22335 && face
->box_line_width
> 0)
22337 it
->ascent
+= face
->box_line_width
;
22338 it
->descent
+= face
->box_line_width
;
22341 && XINT (height
) > it
->ascent
+ it
->descent
)
22342 it
->ascent
= XINT (height
) - it
->descent
;
22344 if (!NILP (total_height
))
22345 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22348 spacing
= get_it_property (it
, Qline_spacing
);
22349 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22351 if (INTEGERP (spacing
))
22353 extra_line_spacing
= XINT (spacing
);
22354 if (!NILP (total_height
))
22355 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22359 else if (it
->char_to_display
== '\t')
22361 if (font
->space_width
> 0)
22363 int tab_width
= it
->tab_width
* font
->space_width
;
22364 int x
= it
->current_x
+ it
->continuation_lines_width
;
22365 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22367 /* If the distance from the current position to the next tab
22368 stop is less than a space character width, use the
22369 tab stop after that. */
22370 if (next_tab_x
- x
< font
->space_width
)
22371 next_tab_x
+= tab_width
;
22373 it
->pixel_width
= next_tab_x
- x
;
22375 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22376 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22380 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22381 it
->ascent
+ it
->descent
, it
->ascent
);
22386 it
->pixel_width
= 0;
22392 /* A multi-byte character. Assume that the display width of the
22393 character is the width of the character multiplied by the
22394 width of the font. */
22396 /* If we found a font, this font should give us the right
22397 metrics. If we didn't find a font, use the frame's
22398 default font and calculate the width of the character by
22399 multiplying the width of font by the width of the
22402 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22404 if (font_not_found_p
|| !pcm
)
22406 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22408 if (char_width
== 0)
22409 /* This is a non spacing character. But, as we are
22410 going to display an empty box, the box must occupy
22411 at least one column. */
22413 it
->glyph_not_available_p
= 1;
22414 it
->pixel_width
= font
->space_width
* char_width
;
22415 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22416 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22420 it
->pixel_width
= pcm
->width
;
22421 it
->phys_ascent
= pcm
->ascent
+ boff
;
22422 it
->phys_descent
= pcm
->descent
- boff
;
22424 && (pcm
->lbearing
< 0
22425 || pcm
->rbearing
> pcm
->width
))
22426 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22429 it
->ascent
= FONT_BASE (font
) + boff
;
22430 it
->descent
= FONT_DESCENT (font
) - boff
;
22431 if (face
->box
!= FACE_NO_BOX
)
22433 int thick
= face
->box_line_width
;
22437 it
->ascent
+= thick
;
22438 it
->descent
+= thick
;
22443 if (it
->start_of_box_run_p
)
22444 it
->pixel_width
+= thick
;
22445 if (it
->end_of_box_run_p
)
22446 it
->pixel_width
+= thick
;
22449 /* If face has an overline, add the height of the overline
22450 (1 pixel) and a 1 pixel margin to the character height. */
22451 if (face
->overline_p
)
22452 it
->ascent
+= overline_margin
;
22454 take_vertical_position_into_account (it
);
22456 if (it
->ascent
< 0)
22458 if (it
->descent
< 0)
22463 if (it
->pixel_width
== 0)
22464 /* We assure that all visible glyphs have at least 1-pixel
22466 it
->pixel_width
= 1;
22468 it
->multibyte_p
= saved_multibyte_p
;
22470 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22472 /* A static composition.
22474 Note: A composition is represented as one glyph in the
22475 glyph matrix. There are no padding glyphs.
22477 Important note: pixel_width, ascent, and descent are the
22478 values of what is drawn by draw_glyphs (i.e. the values of
22479 the overall glyphs composed). */
22480 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22481 int boff
; /* baseline offset */
22482 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22483 int glyph_len
= cmp
->glyph_len
;
22484 struct font
*font
= face
->font
;
22488 /* If we have not yet calculated pixel size data of glyphs of
22489 the composition for the current face font, calculate them
22490 now. Theoretically, we have to check all fonts for the
22491 glyphs, but that requires much time and memory space. So,
22492 here we check only the font of the first glyph. This may
22493 lead to incorrect display, but it's very rare, and C-l
22494 (recenter-top-bottom) can correct the display anyway. */
22495 if (! cmp
->font
|| cmp
->font
!= font
)
22497 /* Ascent and descent of the font of the first character
22498 of this composition (adjusted by baseline offset).
22499 Ascent and descent of overall glyphs should not be less
22500 than these, respectively. */
22501 int font_ascent
, font_descent
, font_height
;
22502 /* Bounding box of the overall glyphs. */
22503 int leftmost
, rightmost
, lowest
, highest
;
22504 int lbearing
, rbearing
;
22505 int i
, width
, ascent
, descent
;
22506 int left_padded
= 0, right_padded
= 0;
22509 struct font_metrics
*pcm
;
22510 int font_not_found_p
;
22513 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22514 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22516 if (glyph_len
< cmp
->glyph_len
)
22518 for (i
= 0; i
< glyph_len
; i
++)
22520 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22522 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22527 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22528 : IT_CHARPOS (*it
));
22529 /* If no suitable font is found, use the default font. */
22530 font_not_found_p
= font
== NULL
;
22531 if (font_not_found_p
)
22533 face
= face
->ascii_face
;
22536 boff
= font
->baseline_offset
;
22537 if (font
->vertical_centering
)
22538 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22539 font_ascent
= FONT_BASE (font
) + boff
;
22540 font_descent
= FONT_DESCENT (font
) - boff
;
22541 font_height
= FONT_HEIGHT (font
);
22543 cmp
->font
= (void *) font
;
22546 if (! font_not_found_p
)
22548 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22549 &char2b
, it
->multibyte_p
, 0);
22550 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22553 /* Initialize the bounding box. */
22556 width
= pcm
->width
;
22557 ascent
= pcm
->ascent
;
22558 descent
= pcm
->descent
;
22559 lbearing
= pcm
->lbearing
;
22560 rbearing
= pcm
->rbearing
;
22564 width
= FONT_WIDTH (font
);
22565 ascent
= FONT_BASE (font
);
22566 descent
= FONT_DESCENT (font
);
22573 lowest
= - descent
+ boff
;
22574 highest
= ascent
+ boff
;
22576 if (! font_not_found_p
22577 && font
->default_ascent
22578 && CHAR_TABLE_P (Vuse_default_ascent
)
22579 && !NILP (Faref (Vuse_default_ascent
,
22580 make_number (it
->char_to_display
))))
22581 highest
= font
->default_ascent
+ boff
;
22583 /* Draw the first glyph at the normal position. It may be
22584 shifted to right later if some other glyphs are drawn
22586 cmp
->offsets
[i
* 2] = 0;
22587 cmp
->offsets
[i
* 2 + 1] = boff
;
22588 cmp
->lbearing
= lbearing
;
22589 cmp
->rbearing
= rbearing
;
22591 /* Set cmp->offsets for the remaining glyphs. */
22592 for (i
++; i
< glyph_len
; i
++)
22594 int left
, right
, btm
, top
;
22595 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22597 struct face
*this_face
;
22602 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22603 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22604 font
= this_face
->font
;
22610 this_boff
= font
->baseline_offset
;
22611 if (font
->vertical_centering
)
22612 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22613 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22614 &char2b
, it
->multibyte_p
, 0);
22615 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22618 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22621 width
= pcm
->width
;
22622 ascent
= pcm
->ascent
;
22623 descent
= pcm
->descent
;
22624 lbearing
= pcm
->lbearing
;
22625 rbearing
= pcm
->rbearing
;
22626 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22628 /* Relative composition with or without
22629 alternate chars. */
22630 left
= (leftmost
+ rightmost
- width
) / 2;
22631 btm
= - descent
+ boff
;
22632 if (font
->relative_compose
22633 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22634 || NILP (Faref (Vignore_relative_composition
,
22635 make_number (ch
)))))
22638 if (- descent
>= font
->relative_compose
)
22639 /* One extra pixel between two glyphs. */
22641 else if (ascent
<= 0)
22642 /* One extra pixel between two glyphs. */
22643 btm
= lowest
- 1 - ascent
- descent
;
22648 /* A composition rule is specified by an integer
22649 value that encodes global and new reference
22650 points (GREF and NREF). GREF and NREF are
22651 specified by numbers as below:
22653 0---1---2 -- ascent
22657 9--10--11 -- center
22659 ---3---4---5--- baseline
22661 6---7---8 -- descent
22663 int rule
= COMPOSITION_RULE (cmp
, i
);
22664 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22666 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22667 grefx
= gref
% 3, nrefx
= nref
% 3;
22668 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22670 xoff
= font_height
* (xoff
- 128) / 256;
22672 yoff
= font_height
* (yoff
- 128) / 256;
22675 + grefx
* (rightmost
- leftmost
) / 2
22676 - nrefx
* width
/ 2
22679 btm
= ((grefy
== 0 ? highest
22681 : grefy
== 2 ? lowest
22682 : (highest
+ lowest
) / 2)
22683 - (nrefy
== 0 ? ascent
+ descent
22684 : nrefy
== 1 ? descent
- boff
22686 : (ascent
+ descent
) / 2)
22690 cmp
->offsets
[i
* 2] = left
;
22691 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22693 /* Update the bounding box of the overall glyphs. */
22696 right
= left
+ width
;
22697 if (left
< leftmost
)
22699 if (right
> rightmost
)
22702 top
= btm
+ descent
+ ascent
;
22708 if (cmp
->lbearing
> left
+ lbearing
)
22709 cmp
->lbearing
= left
+ lbearing
;
22710 if (cmp
->rbearing
< left
+ rbearing
)
22711 cmp
->rbearing
= left
+ rbearing
;
22715 /* If there are glyphs whose x-offsets are negative,
22716 shift all glyphs to the right and make all x-offsets
22720 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22721 cmp
->offsets
[i
* 2] -= leftmost
;
22722 rightmost
-= leftmost
;
22723 cmp
->lbearing
-= leftmost
;
22724 cmp
->rbearing
-= leftmost
;
22727 if (left_padded
&& cmp
->lbearing
< 0)
22729 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22730 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22731 rightmost
-= cmp
->lbearing
;
22732 cmp
->rbearing
-= cmp
->lbearing
;
22735 if (right_padded
&& rightmost
< cmp
->rbearing
)
22737 rightmost
= cmp
->rbearing
;
22740 cmp
->pixel_width
= rightmost
;
22741 cmp
->ascent
= highest
;
22742 cmp
->descent
= - lowest
;
22743 if (cmp
->ascent
< font_ascent
)
22744 cmp
->ascent
= font_ascent
;
22745 if (cmp
->descent
< font_descent
)
22746 cmp
->descent
= font_descent
;
22750 && (cmp
->lbearing
< 0
22751 || cmp
->rbearing
> cmp
->pixel_width
))
22752 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22754 it
->pixel_width
= cmp
->pixel_width
;
22755 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22756 it
->descent
= it
->phys_descent
= cmp
->descent
;
22757 if (face
->box
!= FACE_NO_BOX
)
22759 int thick
= face
->box_line_width
;
22763 it
->ascent
+= thick
;
22764 it
->descent
+= thick
;
22769 if (it
->start_of_box_run_p
)
22770 it
->pixel_width
+= thick
;
22771 if (it
->end_of_box_run_p
)
22772 it
->pixel_width
+= thick
;
22775 /* If face has an overline, add the height of the overline
22776 (1 pixel) and a 1 pixel margin to the character height. */
22777 if (face
->overline_p
)
22778 it
->ascent
+= overline_margin
;
22780 take_vertical_position_into_account (it
);
22781 if (it
->ascent
< 0)
22783 if (it
->descent
< 0)
22787 append_composite_glyph (it
);
22789 else if (it
->what
== IT_COMPOSITION
)
22791 /* A dynamic (automatic) composition. */
22792 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22793 Lisp_Object gstring
;
22794 struct font_metrics metrics
;
22796 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22798 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22801 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22802 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22803 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22804 it
->descent
= it
->phys_descent
= metrics
.descent
;
22805 if (face
->box
!= FACE_NO_BOX
)
22807 int thick
= face
->box_line_width
;
22811 it
->ascent
+= thick
;
22812 it
->descent
+= thick
;
22817 if (it
->start_of_box_run_p
)
22818 it
->pixel_width
+= thick
;
22819 if (it
->end_of_box_run_p
)
22820 it
->pixel_width
+= thick
;
22822 /* If face has an overline, add the height of the overline
22823 (1 pixel) and a 1 pixel margin to the character height. */
22824 if (face
->overline_p
)
22825 it
->ascent
+= overline_margin
;
22826 take_vertical_position_into_account (it
);
22827 if (it
->ascent
< 0)
22829 if (it
->descent
< 0)
22833 append_composite_glyph (it
);
22835 else if (it
->what
== IT_IMAGE
)
22836 produce_image_glyph (it
);
22837 else if (it
->what
== IT_STRETCH
)
22838 produce_stretch_glyph (it
);
22840 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22841 because this isn't true for images with `:ascent 100'. */
22842 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22843 if (it
->area
== TEXT_AREA
)
22844 it
->current_x
+= it
->pixel_width
;
22846 if (extra_line_spacing
> 0)
22848 it
->descent
+= extra_line_spacing
;
22849 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22850 it
->max_extra_line_spacing
= extra_line_spacing
;
22853 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22854 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22855 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22856 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22860 Output LEN glyphs starting at START at the nominal cursor position.
22861 Advance the nominal cursor over the text. The global variable
22862 updated_window contains the window being updated, updated_row is
22863 the glyph row being updated, and updated_area is the area of that
22864 row being updated. */
22867 x_write_glyphs (struct glyph
*start
, int len
)
22871 xassert (updated_window
&& updated_row
);
22874 /* Write glyphs. */
22876 hpos
= start
- updated_row
->glyphs
[updated_area
];
22877 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22878 updated_row
, updated_area
,
22880 DRAW_NORMAL_TEXT
, 0);
22882 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22883 if (updated_area
== TEXT_AREA
22884 && updated_window
->phys_cursor_on_p
22885 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22886 && updated_window
->phys_cursor
.hpos
>= hpos
22887 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22888 updated_window
->phys_cursor_on_p
= 0;
22892 /* Advance the output cursor. */
22893 output_cursor
.hpos
+= len
;
22894 output_cursor
.x
= x
;
22899 Insert LEN glyphs from START at the nominal cursor position. */
22902 x_insert_glyphs (struct glyph
*start
, int len
)
22906 int line_height
, shift_by_width
, shifted_region_width
;
22907 struct glyph_row
*row
;
22908 struct glyph
*glyph
;
22909 int frame_x
, frame_y
;
22912 xassert (updated_window
&& updated_row
);
22914 w
= updated_window
;
22915 f
= XFRAME (WINDOW_FRAME (w
));
22917 /* Get the height of the line we are in. */
22919 line_height
= row
->height
;
22921 /* Get the width of the glyphs to insert. */
22922 shift_by_width
= 0;
22923 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22924 shift_by_width
+= glyph
->pixel_width
;
22926 /* Get the width of the region to shift right. */
22927 shifted_region_width
= (window_box_width (w
, updated_area
)
22932 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22933 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22935 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22936 line_height
, shift_by_width
);
22938 /* Write the glyphs. */
22939 hpos
= start
- row
->glyphs
[updated_area
];
22940 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22942 DRAW_NORMAL_TEXT
, 0);
22944 /* Advance the output cursor. */
22945 output_cursor
.hpos
+= len
;
22946 output_cursor
.x
+= shift_by_width
;
22952 Erase the current text line from the nominal cursor position
22953 (inclusive) to pixel column TO_X (exclusive). The idea is that
22954 everything from TO_X onward is already erased.
22956 TO_X is a pixel position relative to updated_area of
22957 updated_window. TO_X == -1 means clear to the end of this area. */
22960 x_clear_end_of_line (int to_x
)
22963 struct window
*w
= updated_window
;
22964 int max_x
, min_y
, max_y
;
22965 int from_x
, from_y
, to_y
;
22967 xassert (updated_window
&& updated_row
);
22968 f
= XFRAME (w
->frame
);
22970 if (updated_row
->full_width_p
)
22971 max_x
= WINDOW_TOTAL_WIDTH (w
);
22973 max_x
= window_box_width (w
, updated_area
);
22974 max_y
= window_text_bottom_y (w
);
22976 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22977 of window. For TO_X > 0, truncate to end of drawing area. */
22983 to_x
= min (to_x
, max_x
);
22985 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22987 /* Notice if the cursor will be cleared by this operation. */
22988 if (!updated_row
->full_width_p
)
22989 notice_overwritten_cursor (w
, updated_area
,
22990 output_cursor
.x
, -1,
22992 MATRIX_ROW_BOTTOM_Y (updated_row
));
22994 from_x
= output_cursor
.x
;
22996 /* Translate to frame coordinates. */
22997 if (updated_row
->full_width_p
)
22999 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23000 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23004 int area_left
= window_box_left (w
, updated_area
);
23005 from_x
+= area_left
;
23009 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23010 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23011 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23013 /* Prevent inadvertently clearing to end of the X window. */
23014 if (to_x
> from_x
&& to_y
> from_y
)
23017 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23018 to_x
- from_x
, to_y
- from_y
);
23023 #endif /* HAVE_WINDOW_SYSTEM */
23027 /***********************************************************************
23029 ***********************************************************************/
23031 /* Value is the internal representation of the specified cursor type
23032 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23033 of the bar cursor. */
23035 static enum text_cursor_kinds
23036 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23038 enum text_cursor_kinds type
;
23043 if (EQ (arg
, Qbox
))
23044 return FILLED_BOX_CURSOR
;
23046 if (EQ (arg
, Qhollow
))
23047 return HOLLOW_BOX_CURSOR
;
23049 if (EQ (arg
, Qbar
))
23056 && EQ (XCAR (arg
), Qbar
)
23057 && INTEGERP (XCDR (arg
))
23058 && XINT (XCDR (arg
)) >= 0)
23060 *width
= XINT (XCDR (arg
));
23064 if (EQ (arg
, Qhbar
))
23067 return HBAR_CURSOR
;
23071 && EQ (XCAR (arg
), Qhbar
)
23072 && INTEGERP (XCDR (arg
))
23073 && XINT (XCDR (arg
)) >= 0)
23075 *width
= XINT (XCDR (arg
));
23076 return HBAR_CURSOR
;
23079 /* Treat anything unknown as "hollow box cursor".
23080 It was bad to signal an error; people have trouble fixing
23081 .Xdefaults with Emacs, when it has something bad in it. */
23082 type
= HOLLOW_BOX_CURSOR
;
23087 /* Set the default cursor types for specified frame. */
23089 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23094 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23095 FRAME_CURSOR_WIDTH (f
) = width
;
23097 /* By default, set up the blink-off state depending on the on-state. */
23099 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23102 FRAME_BLINK_OFF_CURSOR (f
)
23103 = get_specified_cursor_type (XCDR (tem
), &width
);
23104 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23107 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23111 /* Return the cursor we want to be displayed in window W. Return
23112 width of bar/hbar cursor through WIDTH arg. Return with
23113 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23114 (i.e. if the `system caret' should track this cursor).
23116 In a mini-buffer window, we want the cursor only to appear if we
23117 are reading input from this window. For the selected window, we
23118 want the cursor type given by the frame parameter or buffer local
23119 setting of cursor-type. If explicitly marked off, draw no cursor.
23120 In all other cases, we want a hollow box cursor. */
23122 static enum text_cursor_kinds
23123 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23124 int *active_cursor
)
23126 struct frame
*f
= XFRAME (w
->frame
);
23127 struct buffer
*b
= XBUFFER (w
->buffer
);
23128 int cursor_type
= DEFAULT_CURSOR
;
23129 Lisp_Object alt_cursor
;
23130 int non_selected
= 0;
23132 *active_cursor
= 1;
23135 if (cursor_in_echo_area
23136 && FRAME_HAS_MINIBUF_P (f
)
23137 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23139 if (w
== XWINDOW (echo_area_window
))
23141 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23143 *width
= FRAME_CURSOR_WIDTH (f
);
23144 return FRAME_DESIRED_CURSOR (f
);
23147 return get_specified_cursor_type (b
->cursor_type
, width
);
23150 *active_cursor
= 0;
23154 /* Detect a nonselected window or nonselected frame. */
23155 else if (w
!= XWINDOW (f
->selected_window
)
23156 #ifdef HAVE_WINDOW_SYSTEM
23157 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23161 *active_cursor
= 0;
23163 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23169 /* Never display a cursor in a window in which cursor-type is nil. */
23170 if (NILP (b
->cursor_type
))
23173 /* Get the normal cursor type for this window. */
23174 if (EQ (b
->cursor_type
, Qt
))
23176 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23177 *width
= FRAME_CURSOR_WIDTH (f
);
23180 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23182 /* Use cursor-in-non-selected-windows instead
23183 for non-selected window or frame. */
23186 alt_cursor
= b
->cursor_in_non_selected_windows
;
23187 if (!EQ (Qt
, alt_cursor
))
23188 return get_specified_cursor_type (alt_cursor
, width
);
23189 /* t means modify the normal cursor type. */
23190 if (cursor_type
== FILLED_BOX_CURSOR
)
23191 cursor_type
= HOLLOW_BOX_CURSOR
;
23192 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23194 return cursor_type
;
23197 /* Use normal cursor if not blinked off. */
23198 if (!w
->cursor_off_p
)
23200 #ifdef HAVE_WINDOW_SYSTEM
23201 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23203 if (cursor_type
== FILLED_BOX_CURSOR
)
23205 /* Using a block cursor on large images can be very annoying.
23206 So use a hollow cursor for "large" images.
23207 If image is not transparent (no mask), also use hollow cursor. */
23208 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23209 if (img
!= NULL
&& IMAGEP (img
->spec
))
23211 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23212 where N = size of default frame font size.
23213 This should cover most of the "tiny" icons people may use. */
23215 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23216 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23217 cursor_type
= HOLLOW_BOX_CURSOR
;
23220 else if (cursor_type
!= NO_CURSOR
)
23222 /* Display current only supports BOX and HOLLOW cursors for images.
23223 So for now, unconditionally use a HOLLOW cursor when cursor is
23224 not a solid box cursor. */
23225 cursor_type
= HOLLOW_BOX_CURSOR
;
23229 return cursor_type
;
23232 /* Cursor is blinked off, so determine how to "toggle" it. */
23234 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23235 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23236 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23238 /* Then see if frame has specified a specific blink off cursor type. */
23239 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23241 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23242 return FRAME_BLINK_OFF_CURSOR (f
);
23246 /* Some people liked having a permanently visible blinking cursor,
23247 while others had very strong opinions against it. So it was
23248 decided to remove it. KFS 2003-09-03 */
23250 /* Finally perform built-in cursor blinking:
23251 filled box <-> hollow box
23252 wide [h]bar <-> narrow [h]bar
23253 narrow [h]bar <-> no cursor
23254 other type <-> no cursor */
23256 if (cursor_type
== FILLED_BOX_CURSOR
)
23257 return HOLLOW_BOX_CURSOR
;
23259 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23262 return cursor_type
;
23270 #ifdef HAVE_WINDOW_SYSTEM
23272 /* Notice when the text cursor of window W has been completely
23273 overwritten by a drawing operation that outputs glyphs in AREA
23274 starting at X0 and ending at X1 in the line starting at Y0 and
23275 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23276 the rest of the line after X0 has been written. Y coordinates
23277 are window-relative. */
23280 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23281 int x0
, int x1
, int y0
, int y1
)
23283 int cx0
, cx1
, cy0
, cy1
;
23284 struct glyph_row
*row
;
23286 if (!w
->phys_cursor_on_p
)
23288 if (area
!= TEXT_AREA
)
23291 if (w
->phys_cursor
.vpos
< 0
23292 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23293 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23294 !(row
->enabled_p
&& row
->displays_text_p
)))
23297 if (row
->cursor_in_fringe_p
)
23299 row
->cursor_in_fringe_p
= 0;
23300 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23301 w
->phys_cursor_on_p
= 0;
23305 cx0
= w
->phys_cursor
.x
;
23306 cx1
= cx0
+ w
->phys_cursor_width
;
23307 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23310 /* The cursor image will be completely removed from the
23311 screen if the output area intersects the cursor area in
23312 y-direction. When we draw in [y0 y1[, and some part of
23313 the cursor is at y < y0, that part must have been drawn
23314 before. When scrolling, the cursor is erased before
23315 actually scrolling, so we don't come here. When not
23316 scrolling, the rows above the old cursor row must have
23317 changed, and in this case these rows must have written
23318 over the cursor image.
23320 Likewise if part of the cursor is below y1, with the
23321 exception of the cursor being in the first blank row at
23322 the buffer and window end because update_text_area
23323 doesn't draw that row. (Except when it does, but
23324 that's handled in update_text_area.) */
23326 cy0
= w
->phys_cursor
.y
;
23327 cy1
= cy0
+ w
->phys_cursor_height
;
23328 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23331 w
->phys_cursor_on_p
= 0;
23334 #endif /* HAVE_WINDOW_SYSTEM */
23337 /************************************************************************
23339 ************************************************************************/
23341 #ifdef HAVE_WINDOW_SYSTEM
23344 Fix the display of area AREA of overlapping row ROW in window W
23345 with respect to the overlapping part OVERLAPS. */
23348 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23349 enum glyph_row_area area
, int overlaps
)
23356 for (i
= 0; i
< row
->used
[area
];)
23358 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23360 int start
= i
, start_x
= x
;
23364 x
+= row
->glyphs
[area
][i
].pixel_width
;
23367 while (i
< row
->used
[area
]
23368 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23370 draw_glyphs (w
, start_x
, row
, area
,
23372 DRAW_NORMAL_TEXT
, overlaps
);
23376 x
+= row
->glyphs
[area
][i
].pixel_width
;
23386 Draw the cursor glyph of window W in glyph row ROW. See the
23387 comment of draw_glyphs for the meaning of HL. */
23390 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23391 enum draw_glyphs_face hl
)
23393 /* If cursor hpos is out of bounds, don't draw garbage. This can
23394 happen in mini-buffer windows when switching between echo area
23395 glyphs and mini-buffer. */
23396 if ((row
->reversed_p
23397 ? (w
->phys_cursor
.hpos
>= 0)
23398 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23400 int on_p
= w
->phys_cursor_on_p
;
23402 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23403 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23405 w
->phys_cursor_on_p
= on_p
;
23407 if (hl
== DRAW_CURSOR
)
23408 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23409 /* When we erase the cursor, and ROW is overlapped by other
23410 rows, make sure that these overlapping parts of other rows
23412 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23414 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23416 if (row
> w
->current_matrix
->rows
23417 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23418 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23419 OVERLAPS_ERASED_CURSOR
);
23421 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23422 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23423 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23424 OVERLAPS_ERASED_CURSOR
);
23431 Erase the image of a cursor of window W from the screen. */
23434 erase_phys_cursor (struct window
*w
)
23436 struct frame
*f
= XFRAME (w
->frame
);
23437 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23438 int hpos
= w
->phys_cursor
.hpos
;
23439 int vpos
= w
->phys_cursor
.vpos
;
23440 int mouse_face_here_p
= 0;
23441 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23442 struct glyph_row
*cursor_row
;
23443 struct glyph
*cursor_glyph
;
23444 enum draw_glyphs_face hl
;
23446 /* No cursor displayed or row invalidated => nothing to do on the
23448 if (w
->phys_cursor_type
== NO_CURSOR
)
23449 goto mark_cursor_off
;
23451 /* VPOS >= active_glyphs->nrows means that window has been resized.
23452 Don't bother to erase the cursor. */
23453 if (vpos
>= active_glyphs
->nrows
)
23454 goto mark_cursor_off
;
23456 /* If row containing cursor is marked invalid, there is nothing we
23458 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23459 if (!cursor_row
->enabled_p
)
23460 goto mark_cursor_off
;
23462 /* If line spacing is > 0, old cursor may only be partially visible in
23463 window after split-window. So adjust visible height. */
23464 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23465 window_text_bottom_y (w
) - cursor_row
->y
);
23467 /* If row is completely invisible, don't attempt to delete a cursor which
23468 isn't there. This can happen if cursor is at top of a window, and
23469 we switch to a buffer with a header line in that window. */
23470 if (cursor_row
->visible_height
<= 0)
23471 goto mark_cursor_off
;
23473 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23474 if (cursor_row
->cursor_in_fringe_p
)
23476 cursor_row
->cursor_in_fringe_p
= 0;
23477 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23478 goto mark_cursor_off
;
23481 /* This can happen when the new row is shorter than the old one.
23482 In this case, either draw_glyphs or clear_end_of_line
23483 should have cleared the cursor. Note that we wouldn't be
23484 able to erase the cursor in this case because we don't have a
23485 cursor glyph at hand. */
23486 if ((cursor_row
->reversed_p
23487 ? (w
->phys_cursor
.hpos
< 0)
23488 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23489 goto mark_cursor_off
;
23491 /* If the cursor is in the mouse face area, redisplay that when
23492 we clear the cursor. */
23493 if (! NILP (dpyinfo
->mouse_face_window
)
23494 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23495 && (vpos
> dpyinfo
->mouse_face_beg_row
23496 || (vpos
== dpyinfo
->mouse_face_beg_row
23497 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23498 && (vpos
< dpyinfo
->mouse_face_end_row
23499 || (vpos
== dpyinfo
->mouse_face_end_row
23500 && hpos
< dpyinfo
->mouse_face_end_col
))
23501 /* Don't redraw the cursor's spot in mouse face if it is at the
23502 end of a line (on a newline). The cursor appears there, but
23503 mouse highlighting does not. */
23504 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23505 mouse_face_here_p
= 1;
23507 /* Maybe clear the display under the cursor. */
23508 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23511 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23514 cursor_glyph
= get_phys_cursor_glyph (w
);
23515 if (cursor_glyph
== NULL
)
23516 goto mark_cursor_off
;
23518 width
= cursor_glyph
->pixel_width
;
23519 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23520 x
= w
->phys_cursor
.x
;
23522 width
-= left_x
- x
;
23523 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23524 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23525 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23528 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23531 /* Erase the cursor by redrawing the character underneath it. */
23532 if (mouse_face_here_p
)
23533 hl
= DRAW_MOUSE_FACE
;
23535 hl
= DRAW_NORMAL_TEXT
;
23536 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23539 w
->phys_cursor_on_p
= 0;
23540 w
->phys_cursor_type
= NO_CURSOR
;
23545 Display or clear cursor of window W. If ON is zero, clear the
23546 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23547 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23550 display_and_set_cursor (struct window
*w
, int on
,
23551 int hpos
, int vpos
, int x
, int y
)
23553 struct frame
*f
= XFRAME (w
->frame
);
23554 int new_cursor_type
;
23555 int new_cursor_width
;
23557 struct glyph_row
*glyph_row
;
23558 struct glyph
*glyph
;
23560 /* This is pointless on invisible frames, and dangerous on garbaged
23561 windows and frames; in the latter case, the frame or window may
23562 be in the midst of changing its size, and x and y may be off the
23564 if (! FRAME_VISIBLE_P (f
)
23565 || FRAME_GARBAGED_P (f
)
23566 || vpos
>= w
->current_matrix
->nrows
23567 || hpos
>= w
->current_matrix
->matrix_w
)
23570 /* If cursor is off and we want it off, return quickly. */
23571 if (!on
&& !w
->phys_cursor_on_p
)
23574 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23575 /* If cursor row is not enabled, we don't really know where to
23576 display the cursor. */
23577 if (!glyph_row
->enabled_p
)
23579 w
->phys_cursor_on_p
= 0;
23584 if (!glyph_row
->exact_window_width_line_p
23585 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23586 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23588 xassert (interrupt_input_blocked
);
23590 /* Set new_cursor_type to the cursor we want to be displayed. */
23591 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23592 &new_cursor_width
, &active_cursor
);
23594 /* If cursor is currently being shown and we don't want it to be or
23595 it is in the wrong place, or the cursor type is not what we want,
23597 if (w
->phys_cursor_on_p
23599 || w
->phys_cursor
.x
!= x
23600 || w
->phys_cursor
.y
!= y
23601 || new_cursor_type
!= w
->phys_cursor_type
23602 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23603 && new_cursor_width
!= w
->phys_cursor_width
)))
23604 erase_phys_cursor (w
);
23606 /* Don't check phys_cursor_on_p here because that flag is only set
23607 to zero in some cases where we know that the cursor has been
23608 completely erased, to avoid the extra work of erasing the cursor
23609 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23610 still not be visible, or it has only been partly erased. */
23613 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23614 w
->phys_cursor_height
= glyph_row
->height
;
23616 /* Set phys_cursor_.* before x_draw_.* is called because some
23617 of them may need the information. */
23618 w
->phys_cursor
.x
= x
;
23619 w
->phys_cursor
.y
= glyph_row
->y
;
23620 w
->phys_cursor
.hpos
= hpos
;
23621 w
->phys_cursor
.vpos
= vpos
;
23624 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23625 new_cursor_type
, new_cursor_width
,
23626 on
, active_cursor
);
23630 /* Switch the display of W's cursor on or off, according to the value
23634 update_window_cursor (struct window
*w
, int on
)
23636 /* Don't update cursor in windows whose frame is in the process
23637 of being deleted. */
23638 if (w
->current_matrix
)
23641 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23642 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23648 /* Call update_window_cursor with parameter ON_P on all leaf windows
23649 in the window tree rooted at W. */
23652 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23656 if (!NILP (w
->hchild
))
23657 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23658 else if (!NILP (w
->vchild
))
23659 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23661 update_window_cursor (w
, on_p
);
23663 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23669 Display the cursor on window W, or clear it, according to ON_P.
23670 Don't change the cursor's position. */
23673 x_update_cursor (struct frame
*f
, int on_p
)
23675 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23680 Clear the cursor of window W to background color, and mark the
23681 cursor as not shown. This is used when the text where the cursor
23682 is about to be rewritten. */
23685 x_clear_cursor (struct window
*w
)
23687 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23688 update_window_cursor (w
, 0);
23693 Display the active region described by mouse_face_* according to DRAW. */
23696 show_mouse_face (Display_Info
*dpyinfo
, enum draw_glyphs_face draw
)
23698 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23699 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23701 if (/* If window is in the process of being destroyed, don't bother
23703 w
->current_matrix
!= NULL
23704 /* Don't update mouse highlight if hidden */
23705 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23706 /* Recognize when we are called to operate on rows that don't exist
23707 anymore. This can happen when a window is split. */
23708 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23710 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23711 struct glyph_row
*row
, *first
, *last
;
23713 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23714 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23716 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23718 int start_hpos
, end_hpos
, start_x
;
23720 /* For all but the first row, the highlight starts at column 0. */
23723 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23724 start_x
= dpyinfo
->mouse_face_beg_x
;
23733 end_hpos
= dpyinfo
->mouse_face_end_col
;
23736 end_hpos
= row
->used
[TEXT_AREA
];
23737 if (draw
== DRAW_NORMAL_TEXT
)
23738 row
->fill_line_p
= 1; /* Clear to end of line */
23741 if (end_hpos
> start_hpos
)
23743 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23744 start_hpos
, end_hpos
,
23748 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23752 /* When we've written over the cursor, arrange for it to
23753 be displayed again. */
23754 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23757 display_and_set_cursor (w
, 1,
23758 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23759 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23764 /* Change the mouse cursor. */
23765 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23766 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23767 else if (draw
== DRAW_MOUSE_FACE
)
23768 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23770 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23774 Clear out the mouse-highlighted active region.
23775 Redraw it un-highlighted first. Value is non-zero if mouse
23776 face was actually drawn unhighlighted. */
23779 clear_mouse_face (Display_Info
*dpyinfo
)
23783 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23785 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23789 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23790 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23791 dpyinfo
->mouse_face_window
= Qnil
;
23792 dpyinfo
->mouse_face_overlay
= Qnil
;
23798 Non-zero if physical cursor of window W is within mouse face. */
23801 cursor_in_mouse_face_p (struct window
*w
)
23803 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23804 int in_mouse_face
= 0;
23806 if (WINDOWP (dpyinfo
->mouse_face_window
)
23807 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23809 int hpos
= w
->phys_cursor
.hpos
;
23810 int vpos
= w
->phys_cursor
.vpos
;
23812 if (vpos
>= dpyinfo
->mouse_face_beg_row
23813 && vpos
<= dpyinfo
->mouse_face_end_row
23814 && (vpos
> dpyinfo
->mouse_face_beg_row
23815 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23816 && (vpos
< dpyinfo
->mouse_face_end_row
23817 || hpos
< dpyinfo
->mouse_face_end_col
23818 || dpyinfo
->mouse_face_past_end
))
23822 return in_mouse_face
;
23828 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23829 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23830 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23831 for the overlay or run of text properties specifying the mouse
23832 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23833 before-string and after-string that must also be highlighted.
23834 DISPLAY_STRING, if non-nil, is a display string that may cover some
23835 or all of the highlighted text. */
23838 mouse_face_from_buffer_pos (Lisp_Object window
,
23839 Display_Info
*dpyinfo
,
23840 EMACS_INT mouse_charpos
,
23841 EMACS_INT start_charpos
,
23842 EMACS_INT end_charpos
,
23843 Lisp_Object before_string
,
23844 Lisp_Object after_string
,
23845 Lisp_Object display_string
)
23847 struct window
*w
= XWINDOW (window
);
23848 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23849 struct glyph_row
*row
;
23850 struct glyph
*glyph
, *end
;
23854 xassert (NILP (display_string
) || STRINGP (display_string
));
23855 xassert (NILP (before_string
) || STRINGP (before_string
));
23856 xassert (NILP (after_string
) || STRINGP (after_string
));
23858 /* Find the first highlighted glyph. */
23859 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23861 dpyinfo
->mouse_face_beg_col
= 0;
23862 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23863 dpyinfo
->mouse_face_beg_x
= first
->x
;
23864 dpyinfo
->mouse_face_beg_y
= first
->y
;
23868 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23870 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23872 /* If the before-string or display-string contains newlines,
23873 row_containing_pos skips to its last row. Move back. */
23874 if (!NILP (before_string
) || !NILP (display_string
))
23876 struct glyph_row
*prev
;
23877 while ((prev
= row
- 1, prev
>= first
)
23878 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23879 && prev
->used
[TEXT_AREA
] > 0)
23881 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23882 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23883 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23885 || !(EQ (glyph
->object
, before_string
)
23886 || EQ (glyph
->object
, display_string
)))
23892 glyph
= row
->glyphs
[TEXT_AREA
];
23893 end
= glyph
+ row
->used
[TEXT_AREA
];
23895 dpyinfo
->mouse_face_beg_y
= row
->y
;
23896 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23898 /* Skip truncation glyphs at the start of the glyph row. */
23899 if (row
->displays_text_p
)
23901 && INTEGERP (glyph
->object
)
23902 && glyph
->charpos
< 0;
23904 x
+= glyph
->pixel_width
;
23906 /* Scan the glyph row, stopping before BEFORE_STRING or
23907 DISPLAY_STRING or START_CHARPOS. */
23909 && !INTEGERP (glyph
->object
)
23910 && !EQ (glyph
->object
, before_string
)
23911 && !EQ (glyph
->object
, display_string
)
23912 && !(BUFFERP (glyph
->object
)
23913 && glyph
->charpos
>= start_charpos
);
23915 x
+= glyph
->pixel_width
;
23917 dpyinfo
->mouse_face_beg_x
= x
;
23918 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23921 /* Find the last highlighted glyph. */
23922 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23925 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23926 dpyinfo
->mouse_face_past_end
= 1;
23928 else if (!NILP (after_string
))
23930 /* If the after-string has newlines, advance to its last row. */
23931 struct glyph_row
*next
;
23932 struct glyph_row
*last
23933 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23935 for (next
= row
+ 1;
23937 && next
->used
[TEXT_AREA
] > 0
23938 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23943 glyph
= row
->glyphs
[TEXT_AREA
];
23944 end
= glyph
+ row
->used
[TEXT_AREA
];
23946 dpyinfo
->mouse_face_end_y
= row
->y
;
23947 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23949 /* Skip truncation glyphs at the start of the row. */
23950 if (row
->displays_text_p
)
23952 && INTEGERP (glyph
->object
)
23953 && glyph
->charpos
< 0;
23955 x
+= glyph
->pixel_width
;
23957 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23960 && !INTEGERP (glyph
->object
)
23961 && !EQ (glyph
->object
, after_string
)
23962 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23964 x
+= glyph
->pixel_width
;
23966 /* If we found AFTER_STRING, consume it and stop. */
23967 if (EQ (glyph
->object
, after_string
))
23969 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23970 x
+= glyph
->pixel_width
;
23974 /* If there's no after-string, we must check if we overshot,
23975 which might be the case if we stopped after a string glyph.
23976 That glyph may belong to a before-string or display-string
23977 associated with the end position, which must not be
23979 Lisp_Object prev_object
;
23982 while (glyph
> row
->glyphs
[TEXT_AREA
])
23984 prev_object
= (glyph
- 1)->object
;
23985 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23988 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23989 if (pos
&& pos
< end_charpos
)
23992 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23993 && EQ ((glyph
- 1)->object
, prev_object
);
23995 x
-= (glyph
- 1)->pixel_width
;
23999 dpyinfo
->mouse_face_end_x
= x
;
24000 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24001 dpyinfo
->mouse_face_window
= window
;
24002 dpyinfo
->mouse_face_face_id
24003 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24005 !dpyinfo
->mouse_face_hidden
, -1);
24006 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24010 /* Find the position of the glyph for position POS in OBJECT in
24011 window W's current matrix, and return in *X, *Y the pixel
24012 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24014 RIGHT_P non-zero means return the position of the right edge of the
24015 glyph, RIGHT_P zero means return the left edge position.
24017 If no glyph for POS exists in the matrix, return the position of
24018 the glyph with the next smaller position that is in the matrix, if
24019 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24020 exists in the matrix, return the position of the glyph with the
24021 next larger position in OBJECT.
24023 Value is non-zero if a glyph was found. */
24026 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24027 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24029 int yb
= window_text_bottom_y (w
);
24030 struct glyph_row
*r
;
24031 struct glyph
*best_glyph
= NULL
;
24032 struct glyph_row
*best_row
= NULL
;
24035 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24036 r
->enabled_p
&& r
->y
< yb
;
24039 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24040 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24043 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24044 if (EQ (g
->object
, object
))
24046 if (g
->charpos
== pos
)
24053 else if (best_glyph
== NULL
24054 || ((eabs (g
->charpos
- pos
)
24055 < eabs (best_glyph
->charpos
- pos
))
24058 : g
->charpos
> pos
)))
24072 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24076 *x
+= best_glyph
->pixel_width
;
24081 *vpos
= best_row
- w
->current_matrix
->rows
;
24084 return best_glyph
!= NULL
;
24088 /* See if position X, Y is within a hot-spot of an image. */
24091 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24093 if (!CONSP (hot_spot
))
24096 if (EQ (XCAR (hot_spot
), Qrect
))
24098 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24099 Lisp_Object rect
= XCDR (hot_spot
);
24103 if (!CONSP (XCAR (rect
)))
24105 if (!CONSP (XCDR (rect
)))
24107 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24109 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24111 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24113 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24117 else if (EQ (XCAR (hot_spot
), Qcircle
))
24119 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24120 Lisp_Object circ
= XCDR (hot_spot
);
24121 Lisp_Object lr
, lx0
, ly0
;
24123 && CONSP (XCAR (circ
))
24124 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24125 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24126 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24128 double r
= XFLOATINT (lr
);
24129 double dx
= XINT (lx0
) - x
;
24130 double dy
= XINT (ly0
) - y
;
24131 return (dx
* dx
+ dy
* dy
<= r
* r
);
24134 else if (EQ (XCAR (hot_spot
), Qpoly
))
24136 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24137 if (VECTORP (XCDR (hot_spot
)))
24139 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24140 Lisp_Object
*poly
= v
->contents
;
24144 Lisp_Object lx
, ly
;
24147 /* Need an even number of coordinates, and at least 3 edges. */
24148 if (n
< 6 || n
& 1)
24151 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24152 If count is odd, we are inside polygon. Pixels on edges
24153 may or may not be included depending on actual geometry of the
24155 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24156 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24158 x0
= XINT (lx
), y0
= XINT (ly
);
24159 for (i
= 0; i
< n
; i
+= 2)
24161 int x1
= x0
, y1
= y0
;
24162 if ((lx
= poly
[i
], !INTEGERP (lx
))
24163 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24165 x0
= XINT (lx
), y0
= XINT (ly
);
24167 /* Does this segment cross the X line? */
24175 if (y
> y0
&& y
> y1
)
24177 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24187 find_hot_spot (Lisp_Object map
, int x
, int y
)
24189 while (CONSP (map
))
24191 if (CONSP (XCAR (map
))
24192 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24200 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24202 doc
: /* Lookup in image map MAP coordinates X and Y.
24203 An image map is an alist where each element has the format (AREA ID PLIST).
24204 An AREA is specified as either a rectangle, a circle, or a polygon:
24205 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24206 pixel coordinates of the upper left and bottom right corners.
24207 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24208 and the radius of the circle; r may be a float or integer.
24209 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24210 vector describes one corner in the polygon.
24211 Returns the alist element for the first matching AREA in MAP. */)
24212 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24220 return find_hot_spot (map
, XINT (x
), XINT (y
));
24224 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24226 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24228 /* Do not change cursor shape while dragging mouse. */
24229 if (!NILP (do_mouse_tracking
))
24232 if (!NILP (pointer
))
24234 if (EQ (pointer
, Qarrow
))
24235 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24236 else if (EQ (pointer
, Qhand
))
24237 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24238 else if (EQ (pointer
, Qtext
))
24239 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24240 else if (EQ (pointer
, intern ("hdrag")))
24241 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24242 #ifdef HAVE_X_WINDOWS
24243 else if (EQ (pointer
, intern ("vdrag")))
24244 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24246 else if (EQ (pointer
, intern ("hourglass")))
24247 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24248 else if (EQ (pointer
, Qmodeline
))
24249 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24251 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24254 if (cursor
!= No_Cursor
)
24255 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24258 /* Take proper action when mouse has moved to the mode or header line
24259 or marginal area AREA of window W, x-position X and y-position Y.
24260 X is relative to the start of the text display area of W, so the
24261 width of bitmap areas and scroll bars must be subtracted to get a
24262 position relative to the start of the mode line. */
24265 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24266 enum window_part area
)
24268 struct window
*w
= XWINDOW (window
);
24269 struct frame
*f
= XFRAME (w
->frame
);
24270 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24271 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24272 Lisp_Object pointer
= Qnil
;
24273 int charpos
, dx
, dy
, width
, height
;
24274 Lisp_Object string
, object
= Qnil
;
24275 Lisp_Object pos
, help
;
24277 Lisp_Object mouse_face
;
24278 int original_x_pixel
= x
;
24279 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24280 struct glyph_row
*row
;
24282 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24287 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24288 &object
, &dx
, &dy
, &width
, &height
);
24290 row
= (area
== ON_MODE_LINE
24291 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24292 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24295 if (row
->mode_line_p
&& row
->enabled_p
)
24297 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24298 end
= glyph
+ row
->used
[TEXT_AREA
];
24300 for (x0
= original_x_pixel
;
24301 glyph
< end
&& x0
>= glyph
->pixel_width
;
24303 x0
-= glyph
->pixel_width
;
24311 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24312 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24313 &object
, &dx
, &dy
, &width
, &height
);
24318 if (IMAGEP (object
))
24320 Lisp_Object image_map
, hotspot
;
24321 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24323 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24325 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24327 Lisp_Object area_id
, plist
;
24329 area_id
= XCAR (hotspot
);
24330 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24331 If so, we could look for mouse-enter, mouse-leave
24332 properties in PLIST (and do something...). */
24333 hotspot
= XCDR (hotspot
);
24334 if (CONSP (hotspot
)
24335 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24337 pointer
= Fplist_get (plist
, Qpointer
);
24338 if (NILP (pointer
))
24340 help
= Fplist_get (plist
, Qhelp_echo
);
24343 help_echo_string
= help
;
24344 /* Is this correct? ++kfs */
24345 XSETWINDOW (help_echo_window
, w
);
24346 help_echo_object
= w
->buffer
;
24347 help_echo_pos
= charpos
;
24351 if (NILP (pointer
))
24352 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24355 if (STRINGP (string
))
24357 pos
= make_number (charpos
);
24358 /* If we're on a string with `help-echo' text property, arrange
24359 for the help to be displayed. This is done by setting the
24360 global variable help_echo_string to the help string. */
24363 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24366 help_echo_string
= help
;
24367 XSETWINDOW (help_echo_window
, w
);
24368 help_echo_object
= string
;
24369 help_echo_pos
= charpos
;
24373 if (NILP (pointer
))
24374 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24376 /* Change the mouse pointer according to what is under X/Y. */
24377 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24380 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24381 if (!KEYMAPP (map
))
24382 map
= Fget_text_property (pos
, Qkeymap
, string
);
24383 if (!KEYMAPP (map
))
24384 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24387 /* Change the mouse face according to what is under X/Y. */
24388 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24389 if (!NILP (mouse_face
)
24390 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24395 struct glyph
* tmp_glyph
;
24399 int total_pixel_width
;
24404 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24405 Qmouse_face
, string
, Qnil
);
24407 b
= make_number (0);
24409 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24411 e
= make_number (SCHARS (string
));
24413 /* Calculate the position(glyph position: GPOS) of GLYPH in
24414 displayed string. GPOS is different from CHARPOS.
24416 CHARPOS is the position of glyph in internal string
24417 object. A mode line string format has structures which
24418 is converted to a flatten by emacs lisp interpreter.
24419 The internal string is an element of the structures.
24420 The displayed string is the flatten string. */
24422 if (glyph
> row_start_glyph
)
24424 tmp_glyph
= glyph
- 1;
24425 while (tmp_glyph
>= row_start_glyph
24426 && tmp_glyph
->charpos
>= XINT (b
)
24427 && EQ (tmp_glyph
->object
, glyph
->object
))
24434 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24435 displayed string holding GLYPH.
24437 GSEQ_LENGTH is different from SCHARS (STRING).
24438 SCHARS (STRING) returns the length of the internal string. */
24439 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24440 tmp_glyph
->charpos
< XINT (e
);
24441 tmp_glyph
++, gseq_length
++)
24443 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24447 total_pixel_width
= 0;
24448 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24449 total_pixel_width
+= tmp_glyph
->pixel_width
;
24451 /* Pre calculation of re-rendering position */
24453 hpos
= (area
== ON_MODE_LINE
24454 ? (w
->current_matrix
)->nrows
- 1
24457 /* If the re-rendering position is included in the last
24458 re-rendering area, we should do nothing. */
24459 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24460 && dpyinfo
->mouse_face_beg_col
<= vpos
24461 && vpos
< dpyinfo
->mouse_face_end_col
24462 && dpyinfo
->mouse_face_beg_row
== hpos
)
24465 if (clear_mouse_face (dpyinfo
))
24466 cursor
= No_Cursor
;
24468 dpyinfo
->mouse_face_beg_col
= vpos
;
24469 dpyinfo
->mouse_face_beg_row
= hpos
;
24471 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24472 dpyinfo
->mouse_face_beg_y
= 0;
24474 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24475 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24477 dpyinfo
->mouse_face_end_x
= 0;
24478 dpyinfo
->mouse_face_end_y
= 0;
24480 dpyinfo
->mouse_face_past_end
= 0;
24481 dpyinfo
->mouse_face_window
= window
;
24483 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24486 glyph
->face_id
, 1);
24487 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24489 if (NILP (pointer
))
24492 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24493 clear_mouse_face (dpyinfo
);
24495 define_frame_cursor1 (f
, cursor
, pointer
);
24500 Take proper action when the mouse has moved to position X, Y on
24501 frame F as regards highlighting characters that have mouse-face
24502 properties. Also de-highlighting chars where the mouse was before.
24503 X and Y can be negative or out of range. */
24506 note_mouse_highlight (struct frame
*f
, int x
, int y
)
24508 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24509 enum window_part part
;
24510 Lisp_Object window
;
24512 Cursor cursor
= No_Cursor
;
24513 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24516 /* When a menu is active, don't highlight because this looks odd. */
24517 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24518 if (popup_activated ())
24522 if (NILP (Vmouse_highlight
)
24523 || !f
->glyphs_initialized_p
24524 || f
->pointer_invisible
)
24527 dpyinfo
->mouse_face_mouse_x
= x
;
24528 dpyinfo
->mouse_face_mouse_y
= y
;
24529 dpyinfo
->mouse_face_mouse_frame
= f
;
24531 if (dpyinfo
->mouse_face_defer
)
24534 if (gc_in_progress
)
24536 dpyinfo
->mouse_face_deferred_gc
= 1;
24540 /* Which window is that in? */
24541 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24543 /* If we were displaying active text in another window, clear that.
24544 Also clear if we move out of text area in same window. */
24545 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24546 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24547 && !NILP (dpyinfo
->mouse_face_window
)))
24548 clear_mouse_face (dpyinfo
);
24550 /* Not on a window -> return. */
24551 if (!WINDOWP (window
))
24554 /* Reset help_echo_string. It will get recomputed below. */
24555 help_echo_string
= Qnil
;
24557 /* Convert to window-relative pixel coordinates. */
24558 w
= XWINDOW (window
);
24559 frame_to_window_pixel_xy (w
, &x
, &y
);
24561 /* Handle tool-bar window differently since it doesn't display a
24563 if (EQ (window
, f
->tool_bar_window
))
24565 note_tool_bar_highlight (f
, x
, y
);
24569 /* Mouse is on the mode, header line or margin? */
24570 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24571 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24573 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24577 if (part
== ON_VERTICAL_BORDER
)
24579 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24580 help_echo_string
= build_string ("drag-mouse-1: resize");
24582 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24583 || part
== ON_SCROLL_BAR
)
24584 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24586 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24588 /* Are we in a window whose display is up to date?
24589 And verify the buffer's text has not changed. */
24590 b
= XBUFFER (w
->buffer
);
24591 if (part
== ON_TEXT
24592 && EQ (w
->window_end_valid
, w
->buffer
)
24593 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24594 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24596 int hpos
, vpos
, i
, dx
, dy
, area
;
24598 struct glyph
*glyph
;
24599 Lisp_Object object
;
24600 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24601 Lisp_Object
*overlay_vec
= NULL
;
24603 struct buffer
*obuf
;
24604 int obegv
, ozv
, same_region
;
24606 /* Find the glyph under X/Y. */
24607 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24609 /* Look for :pointer property on image. */
24610 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24612 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24613 if (img
!= NULL
&& IMAGEP (img
->spec
))
24615 Lisp_Object image_map
, hotspot
;
24616 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24618 && (hotspot
= find_hot_spot (image_map
,
24619 glyph
->slice
.x
+ dx
,
24620 glyph
->slice
.y
+ dy
),
24622 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24624 Lisp_Object area_id
, plist
;
24626 area_id
= XCAR (hotspot
);
24627 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24628 If so, we could look for mouse-enter, mouse-leave
24629 properties in PLIST (and do something...). */
24630 hotspot
= XCDR (hotspot
);
24631 if (CONSP (hotspot
)
24632 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24634 pointer
= Fplist_get (plist
, Qpointer
);
24635 if (NILP (pointer
))
24637 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24638 if (!NILP (help_echo_string
))
24640 help_echo_window
= window
;
24641 help_echo_object
= glyph
->object
;
24642 help_echo_pos
= glyph
->charpos
;
24646 if (NILP (pointer
))
24647 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24651 /* Clear mouse face if X/Y not over text. */
24653 || area
!= TEXT_AREA
24654 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24656 if (clear_mouse_face (dpyinfo
))
24657 cursor
= No_Cursor
;
24658 if (NILP (pointer
))
24660 if (area
!= TEXT_AREA
)
24661 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24663 pointer
= Vvoid_text_area_pointer
;
24668 pos
= glyph
->charpos
;
24669 object
= glyph
->object
;
24670 if (!STRINGP (object
) && !BUFFERP (object
))
24673 /* If we get an out-of-range value, return now; avoid an error. */
24674 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24677 /* Make the window's buffer temporarily current for
24678 overlays_at and compute_char_face. */
24679 obuf
= current_buffer
;
24680 current_buffer
= b
;
24686 /* Is this char mouse-active or does it have help-echo? */
24687 position
= make_number (pos
);
24689 if (BUFFERP (object
))
24691 /* Put all the overlays we want in a vector in overlay_vec. */
24692 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24693 /* Sort overlays into increasing priority order. */
24694 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24699 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24700 && vpos
>= dpyinfo
->mouse_face_beg_row
24701 && vpos
<= dpyinfo
->mouse_face_end_row
24702 && (vpos
> dpyinfo
->mouse_face_beg_row
24703 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24704 && (vpos
< dpyinfo
->mouse_face_end_row
24705 || hpos
< dpyinfo
->mouse_face_end_col
24706 || dpyinfo
->mouse_face_past_end
));
24709 cursor
= No_Cursor
;
24711 /* Check mouse-face highlighting. */
24713 /* If there exists an overlay with mouse-face overlapping
24714 the one we are currently highlighting, we have to
24715 check if we enter the overlapping overlay, and then
24716 highlight only that. */
24717 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24718 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24720 /* Find the highest priority overlay with a mouse-face. */
24722 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24724 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24725 if (!NILP (mouse_face
))
24726 overlay
= overlay_vec
[i
];
24729 /* If we're highlighting the same overlay as before, there's
24730 no need to do that again. */
24731 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24732 goto check_help_echo
;
24733 dpyinfo
->mouse_face_overlay
= overlay
;
24735 /* Clear the display of the old active region, if any. */
24736 if (clear_mouse_face (dpyinfo
))
24737 cursor
= No_Cursor
;
24739 /* If no overlay applies, get a text property. */
24740 if (NILP (overlay
))
24741 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24743 /* Next, compute the bounds of the mouse highlighting and
24745 if (!NILP (mouse_face
) && STRINGP (object
))
24747 /* The mouse-highlighting comes from a display string
24748 with a mouse-face. */
24752 b
= Fprevious_single_property_change
24753 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24754 e
= Fnext_single_property_change
24755 (position
, Qmouse_face
, object
, Qnil
);
24757 b
= make_number (0);
24759 e
= make_number (SCHARS (object
) - 1);
24761 fast_find_string_pos (w
, XINT (b
), object
,
24762 &dpyinfo
->mouse_face_beg_col
,
24763 &dpyinfo
->mouse_face_beg_row
,
24764 &dpyinfo
->mouse_face_beg_x
,
24765 &dpyinfo
->mouse_face_beg_y
, 0);
24766 fast_find_string_pos (w
, XINT (e
), object
,
24767 &dpyinfo
->mouse_face_end_col
,
24768 &dpyinfo
->mouse_face_end_row
,
24769 &dpyinfo
->mouse_face_end_x
,
24770 &dpyinfo
->mouse_face_end_y
, 1);
24771 dpyinfo
->mouse_face_past_end
= 0;
24772 dpyinfo
->mouse_face_window
= window
;
24773 dpyinfo
->mouse_face_face_id
24774 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24775 glyph
->face_id
, 1);
24776 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24777 cursor
= No_Cursor
;
24781 /* The mouse-highlighting, if any, comes from an overlay
24782 or text property in the buffer. */
24783 Lisp_Object buffer
, display_string
;
24785 if (STRINGP (object
))
24787 /* If we are on a display string with no mouse-face,
24788 check if the text under it has one. */
24789 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24790 int start
= MATRIX_ROW_START_CHARPOS (r
);
24791 pos
= string_buffer_position (w
, object
, start
);
24794 mouse_face
= get_char_property_and_overlay
24795 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24796 buffer
= w
->buffer
;
24797 display_string
= object
;
24803 display_string
= Qnil
;
24806 if (!NILP (mouse_face
))
24808 Lisp_Object before
, after
;
24809 Lisp_Object before_string
, after_string
;
24811 if (NILP (overlay
))
24813 /* Handle the text property case. */
24814 before
= Fprevious_single_property_change
24815 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24816 Fmarker_position (w
->start
));
24817 after
= Fnext_single_property_change
24818 (make_number (pos
), Qmouse_face
, buffer
,
24819 make_number (BUF_Z (XBUFFER (buffer
))
24820 - XFASTINT (w
->window_end_pos
)));
24821 before_string
= after_string
= Qnil
;
24825 /* Handle the overlay case. */
24826 before
= Foverlay_start (overlay
);
24827 after
= Foverlay_end (overlay
);
24828 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24829 after_string
= Foverlay_get (overlay
, Qafter_string
);
24831 if (!STRINGP (before_string
)) before_string
= Qnil
;
24832 if (!STRINGP (after_string
)) after_string
= Qnil
;
24835 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24838 before_string
, after_string
,
24840 cursor
= No_Cursor
;
24847 /* Look for a `help-echo' property. */
24848 if (NILP (help_echo_string
)) {
24849 Lisp_Object help
, overlay
;
24851 /* Check overlays first. */
24852 help
= overlay
= Qnil
;
24853 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24855 overlay
= overlay_vec
[i
];
24856 help
= Foverlay_get (overlay
, Qhelp_echo
);
24861 help_echo_string
= help
;
24862 help_echo_window
= window
;
24863 help_echo_object
= overlay
;
24864 help_echo_pos
= pos
;
24868 Lisp_Object object
= glyph
->object
;
24869 int charpos
= glyph
->charpos
;
24871 /* Try text properties. */
24872 if (STRINGP (object
)
24874 && charpos
< SCHARS (object
))
24876 help
= Fget_text_property (make_number (charpos
),
24877 Qhelp_echo
, object
);
24880 /* If the string itself doesn't specify a help-echo,
24881 see if the buffer text ``under'' it does. */
24882 struct glyph_row
*r
24883 = MATRIX_ROW (w
->current_matrix
, vpos
);
24884 int start
= MATRIX_ROW_START_CHARPOS (r
);
24885 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24888 help
= Fget_char_property (make_number (pos
),
24889 Qhelp_echo
, w
->buffer
);
24893 object
= w
->buffer
;
24898 else if (BUFFERP (object
)
24901 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24906 help_echo_string
= help
;
24907 help_echo_window
= window
;
24908 help_echo_object
= object
;
24909 help_echo_pos
= charpos
;
24914 /* Look for a `pointer' property. */
24915 if (NILP (pointer
))
24917 /* Check overlays first. */
24918 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24919 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24921 if (NILP (pointer
))
24923 Lisp_Object object
= glyph
->object
;
24924 int charpos
= glyph
->charpos
;
24926 /* Try text properties. */
24927 if (STRINGP (object
)
24929 && charpos
< SCHARS (object
))
24931 pointer
= Fget_text_property (make_number (charpos
),
24933 if (NILP (pointer
))
24935 /* If the string itself doesn't specify a pointer,
24936 see if the buffer text ``under'' it does. */
24937 struct glyph_row
*r
24938 = MATRIX_ROW (w
->current_matrix
, vpos
);
24939 int start
= MATRIX_ROW_START_CHARPOS (r
);
24940 EMACS_INT pos
= string_buffer_position (w
, object
,
24943 pointer
= Fget_char_property (make_number (pos
),
24944 Qpointer
, w
->buffer
);
24947 else if (BUFFERP (object
)
24950 pointer
= Fget_text_property (make_number (charpos
),
24957 current_buffer
= obuf
;
24962 define_frame_cursor1 (f
, cursor
, pointer
);
24967 Clear any mouse-face on window W. This function is part of the
24968 redisplay interface, and is called from try_window_id and similar
24969 functions to ensure the mouse-highlight is off. */
24972 x_clear_window_mouse_face (struct window
*w
)
24974 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24975 Lisp_Object window
;
24978 XSETWINDOW (window
, w
);
24979 if (EQ (window
, dpyinfo
->mouse_face_window
))
24980 clear_mouse_face (dpyinfo
);
24986 Just discard the mouse face information for frame F, if any.
24987 This is used when the size of F is changed. */
24990 cancel_mouse_face (struct frame
*f
)
24992 Lisp_Object window
;
24993 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24995 window
= dpyinfo
->mouse_face_window
;
24996 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
24998 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
24999 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
25000 dpyinfo
->mouse_face_window
= Qnil
;
25005 #endif /* HAVE_WINDOW_SYSTEM */
25008 /***********************************************************************
25010 ***********************************************************************/
25012 #ifdef HAVE_WINDOW_SYSTEM
25014 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25015 which intersects rectangle R. R is in window-relative coordinates. */
25018 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25019 enum glyph_row_area area
)
25021 struct glyph
*first
= row
->glyphs
[area
];
25022 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25023 struct glyph
*last
;
25024 int first_x
, start_x
, x
;
25026 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25027 /* If row extends face to end of line write the whole line. */
25028 draw_glyphs (w
, 0, row
, area
,
25029 0, row
->used
[area
],
25030 DRAW_NORMAL_TEXT
, 0);
25033 /* Set START_X to the window-relative start position for drawing glyphs of
25034 AREA. The first glyph of the text area can be partially visible.
25035 The first glyphs of other areas cannot. */
25036 start_x
= window_box_left_offset (w
, area
);
25038 if (area
== TEXT_AREA
)
25041 /* Find the first glyph that must be redrawn. */
25043 && x
+ first
->pixel_width
< r
->x
)
25045 x
+= first
->pixel_width
;
25049 /* Find the last one. */
25053 && x
< r
->x
+ r
->width
)
25055 x
+= last
->pixel_width
;
25061 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25062 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25063 DRAW_NORMAL_TEXT
, 0);
25068 /* Redraw the parts of the glyph row ROW on window W intersecting
25069 rectangle R. R is in window-relative coordinates. Value is
25070 non-zero if mouse-face was overwritten. */
25073 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25075 xassert (row
->enabled_p
);
25077 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25078 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25079 0, row
->used
[TEXT_AREA
],
25080 DRAW_NORMAL_TEXT
, 0);
25083 if (row
->used
[LEFT_MARGIN_AREA
])
25084 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25085 if (row
->used
[TEXT_AREA
])
25086 expose_area (w
, row
, r
, TEXT_AREA
);
25087 if (row
->used
[RIGHT_MARGIN_AREA
])
25088 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25089 draw_row_fringe_bitmaps (w
, row
);
25092 return row
->mouse_face_p
;
25096 /* Redraw those parts of glyphs rows during expose event handling that
25097 overlap other rows. Redrawing of an exposed line writes over parts
25098 of lines overlapping that exposed line; this function fixes that.
25100 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25101 row in W's current matrix that is exposed and overlaps other rows.
25102 LAST_OVERLAPPING_ROW is the last such row. */
25105 expose_overlaps (struct window
*w
,
25106 struct glyph_row
*first_overlapping_row
,
25107 struct glyph_row
*last_overlapping_row
,
25110 struct glyph_row
*row
;
25112 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25113 if (row
->overlapping_p
)
25115 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25118 if (row
->used
[LEFT_MARGIN_AREA
])
25119 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25121 if (row
->used
[TEXT_AREA
])
25122 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25124 if (row
->used
[RIGHT_MARGIN_AREA
])
25125 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25131 /* Return non-zero if W's cursor intersects rectangle R. */
25134 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25136 XRectangle cr
, result
;
25137 struct glyph
*cursor_glyph
;
25138 struct glyph_row
*row
;
25140 if (w
->phys_cursor
.vpos
>= 0
25141 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25142 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25144 && row
->cursor_in_fringe_p
)
25146 /* Cursor is in the fringe. */
25147 cr
.x
= window_box_right_offset (w
,
25148 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25149 ? RIGHT_MARGIN_AREA
25152 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25153 cr
.height
= row
->height
;
25154 return x_intersect_rectangles (&cr
, r
, &result
);
25157 cursor_glyph
= get_phys_cursor_glyph (w
);
25160 /* r is relative to W's box, but w->phys_cursor.x is relative
25161 to left edge of W's TEXT area. Adjust it. */
25162 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25163 cr
.y
= w
->phys_cursor
.y
;
25164 cr
.width
= cursor_glyph
->pixel_width
;
25165 cr
.height
= w
->phys_cursor_height
;
25166 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25167 I assume the effect is the same -- and this is portable. */
25168 return x_intersect_rectangles (&cr
, r
, &result
);
25170 /* If we don't understand the format, pretend we're not in the hot-spot. */
25176 Draw a vertical window border to the right of window W if W doesn't
25177 have vertical scroll bars. */
25180 x_draw_vertical_border (struct window
*w
)
25182 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25184 /* We could do better, if we knew what type of scroll-bar the adjacent
25185 windows (on either side) have... But we don't :-(
25186 However, I think this works ok. ++KFS 2003-04-25 */
25188 /* Redraw borders between horizontally adjacent windows. Don't
25189 do it for frames with vertical scroll bars because either the
25190 right scroll bar of a window, or the left scroll bar of its
25191 neighbor will suffice as a border. */
25192 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25195 if (!WINDOW_RIGHTMOST_P (w
)
25196 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25198 int x0
, x1
, y0
, y1
;
25200 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25203 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25206 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25208 else if (!WINDOW_LEFTMOST_P (w
)
25209 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25211 int x0
, x1
, y0
, y1
;
25213 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25216 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25219 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25224 /* Redraw the part of window W intersection rectangle FR. Pixel
25225 coordinates in FR are frame-relative. Call this function with
25226 input blocked. Value is non-zero if the exposure overwrites
25230 expose_window (struct window
*w
, XRectangle
*fr
)
25232 struct frame
*f
= XFRAME (w
->frame
);
25234 int mouse_face_overwritten_p
= 0;
25236 /* If window is not yet fully initialized, do nothing. This can
25237 happen when toolkit scroll bars are used and a window is split.
25238 Reconfiguring the scroll bar will generate an expose for a newly
25240 if (w
->current_matrix
== NULL
)
25243 /* When we're currently updating the window, display and current
25244 matrix usually don't agree. Arrange for a thorough display
25246 if (w
== updated_window
)
25248 SET_FRAME_GARBAGED (f
);
25252 /* Frame-relative pixel rectangle of W. */
25253 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25254 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25255 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25256 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25258 if (x_intersect_rectangles (fr
, &wr
, &r
))
25260 int yb
= window_text_bottom_y (w
);
25261 struct glyph_row
*row
;
25262 int cursor_cleared_p
;
25263 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25265 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25266 r
.x
, r
.y
, r
.width
, r
.height
));
25268 /* Convert to window coordinates. */
25269 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25270 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25272 /* Turn off the cursor. */
25273 if (!w
->pseudo_window_p
25274 && phys_cursor_in_rect_p (w
, &r
))
25276 x_clear_cursor (w
);
25277 cursor_cleared_p
= 1;
25280 cursor_cleared_p
= 0;
25282 /* Update lines intersecting rectangle R. */
25283 first_overlapping_row
= last_overlapping_row
= NULL
;
25284 for (row
= w
->current_matrix
->rows
;
25289 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25291 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25292 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25293 || (r
.y
>= y0
&& r
.y
< y1
)
25294 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25296 /* A header line may be overlapping, but there is no need
25297 to fix overlapping areas for them. KFS 2005-02-12 */
25298 if (row
->overlapping_p
&& !row
->mode_line_p
)
25300 if (first_overlapping_row
== NULL
)
25301 first_overlapping_row
= row
;
25302 last_overlapping_row
= row
;
25306 if (expose_line (w
, row
, &r
))
25307 mouse_face_overwritten_p
= 1;
25310 else if (row
->overlapping_p
)
25312 /* We must redraw a row overlapping the exposed area. */
25314 ? y0
+ row
->phys_height
> r
.y
25315 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25317 if (first_overlapping_row
== NULL
)
25318 first_overlapping_row
= row
;
25319 last_overlapping_row
= row
;
25327 /* Display the mode line if there is one. */
25328 if (WINDOW_WANTS_MODELINE_P (w
)
25329 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25331 && row
->y
< r
.y
+ r
.height
)
25333 if (expose_line (w
, row
, &r
))
25334 mouse_face_overwritten_p
= 1;
25337 if (!w
->pseudo_window_p
)
25339 /* Fix the display of overlapping rows. */
25340 if (first_overlapping_row
)
25341 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25344 /* Draw border between windows. */
25345 x_draw_vertical_border (w
);
25347 /* Turn the cursor on again. */
25348 if (cursor_cleared_p
)
25349 update_window_cursor (w
, 1);
25353 return mouse_face_overwritten_p
;
25358 /* Redraw (parts) of all windows in the window tree rooted at W that
25359 intersect R. R contains frame pixel coordinates. Value is
25360 non-zero if the exposure overwrites mouse-face. */
25363 expose_window_tree (struct window
*w
, XRectangle
*r
)
25365 struct frame
*f
= XFRAME (w
->frame
);
25366 int mouse_face_overwritten_p
= 0;
25368 while (w
&& !FRAME_GARBAGED_P (f
))
25370 if (!NILP (w
->hchild
))
25371 mouse_face_overwritten_p
25372 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25373 else if (!NILP (w
->vchild
))
25374 mouse_face_overwritten_p
25375 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25377 mouse_face_overwritten_p
|= expose_window (w
, r
);
25379 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25382 return mouse_face_overwritten_p
;
25387 Redisplay an exposed area of frame F. X and Y are the upper-left
25388 corner of the exposed rectangle. W and H are width and height of
25389 the exposed area. All are pixel values. W or H zero means redraw
25390 the entire frame. */
25393 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
25396 int mouse_face_overwritten_p
= 0;
25398 TRACE ((stderr
, "expose_frame "));
25400 /* No need to redraw if frame will be redrawn soon. */
25401 if (FRAME_GARBAGED_P (f
))
25403 TRACE ((stderr
, " garbaged\n"));
25407 /* If basic faces haven't been realized yet, there is no point in
25408 trying to redraw anything. This can happen when we get an expose
25409 event while Emacs is starting, e.g. by moving another window. */
25410 if (FRAME_FACE_CACHE (f
) == NULL
25411 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25413 TRACE ((stderr
, " no faces\n"));
25417 if (w
== 0 || h
== 0)
25420 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25421 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25431 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25432 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25434 if (WINDOWP (f
->tool_bar_window
))
25435 mouse_face_overwritten_p
25436 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25438 #ifdef HAVE_X_WINDOWS
25440 #ifndef USE_X_TOOLKIT
25441 if (WINDOWP (f
->menu_bar_window
))
25442 mouse_face_overwritten_p
25443 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25444 #endif /* not USE_X_TOOLKIT */
25448 /* Some window managers support a focus-follows-mouse style with
25449 delayed raising of frames. Imagine a partially obscured frame,
25450 and moving the mouse into partially obscured mouse-face on that
25451 frame. The visible part of the mouse-face will be highlighted,
25452 then the WM raises the obscured frame. With at least one WM, KDE
25453 2.1, Emacs is not getting any event for the raising of the frame
25454 (even tried with SubstructureRedirectMask), only Expose events.
25455 These expose events will draw text normally, i.e. not
25456 highlighted. Which means we must redo the highlight here.
25457 Subsume it under ``we love X''. --gerd 2001-08-15 */
25458 /* Included in Windows version because Windows most likely does not
25459 do the right thing if any third party tool offers
25460 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25461 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25463 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25464 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25466 int x
= dpyinfo
->mouse_face_mouse_x
;
25467 int y
= dpyinfo
->mouse_face_mouse_y
;
25468 clear_mouse_face (dpyinfo
);
25469 note_mouse_highlight (f
, x
, y
);
25476 Determine the intersection of two rectangles R1 and R2. Return
25477 the intersection in *RESULT. Value is non-zero if RESULT is not
25481 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
25483 XRectangle
*left
, *right
;
25484 XRectangle
*upper
, *lower
;
25485 int intersection_p
= 0;
25487 /* Rearrange so that R1 is the left-most rectangle. */
25489 left
= r1
, right
= r2
;
25491 left
= r2
, right
= r1
;
25493 /* X0 of the intersection is right.x0, if this is inside R1,
25494 otherwise there is no intersection. */
25495 if (right
->x
<= left
->x
+ left
->width
)
25497 result
->x
= right
->x
;
25499 /* The right end of the intersection is the minimum of the
25500 the right ends of left and right. */
25501 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25504 /* Same game for Y. */
25506 upper
= r1
, lower
= r2
;
25508 upper
= r2
, lower
= r1
;
25510 /* The upper end of the intersection is lower.y0, if this is inside
25511 of upper. Otherwise, there is no intersection. */
25512 if (lower
->y
<= upper
->y
+ upper
->height
)
25514 result
->y
= lower
->y
;
25516 /* The lower end of the intersection is the minimum of the lower
25517 ends of upper and lower. */
25518 result
->height
= (min (lower
->y
+ lower
->height
,
25519 upper
->y
+ upper
->height
)
25521 intersection_p
= 1;
25525 return intersection_p
;
25528 #endif /* HAVE_WINDOW_SYSTEM */
25531 /***********************************************************************
25533 ***********************************************************************/
25536 syms_of_xdisp (void)
25538 Vwith_echo_area_save_vector
= Qnil
;
25539 staticpro (&Vwith_echo_area_save_vector
);
25541 Vmessage_stack
= Qnil
;
25542 staticpro (&Vmessage_stack
);
25544 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25545 staticpro (&Qinhibit_redisplay
);
25547 message_dolog_marker1
= Fmake_marker ();
25548 staticpro (&message_dolog_marker1
);
25549 message_dolog_marker2
= Fmake_marker ();
25550 staticpro (&message_dolog_marker2
);
25551 message_dolog_marker3
= Fmake_marker ();
25552 staticpro (&message_dolog_marker3
);
25555 defsubr (&Sdump_frame_glyph_matrix
);
25556 defsubr (&Sdump_glyph_matrix
);
25557 defsubr (&Sdump_glyph_row
);
25558 defsubr (&Sdump_tool_bar_row
);
25559 defsubr (&Strace_redisplay
);
25560 defsubr (&Strace_to_stderr
);
25562 #ifdef HAVE_WINDOW_SYSTEM
25563 defsubr (&Stool_bar_lines_needed
);
25564 defsubr (&Slookup_image_map
);
25566 defsubr (&Sformat_mode_line
);
25567 defsubr (&Sinvisible_p
);
25568 defsubr (&Scurrent_bidi_paragraph_direction
);
25570 staticpro (&Qmenu_bar_update_hook
);
25571 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25573 staticpro (&Qoverriding_terminal_local_map
);
25574 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25576 staticpro (&Qoverriding_local_map
);
25577 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25579 staticpro (&Qwindow_scroll_functions
);
25580 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25582 staticpro (&Qwindow_text_change_functions
);
25583 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25585 staticpro (&Qredisplay_end_trigger_functions
);
25586 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25588 staticpro (&Qinhibit_point_motion_hooks
);
25589 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25591 Qeval
= intern_c_string ("eval");
25592 staticpro (&Qeval
);
25594 QCdata
= intern_c_string (":data");
25595 staticpro (&QCdata
);
25596 Qdisplay
= intern_c_string ("display");
25597 staticpro (&Qdisplay
);
25598 Qspace_width
= intern_c_string ("space-width");
25599 staticpro (&Qspace_width
);
25600 Qraise
= intern_c_string ("raise");
25601 staticpro (&Qraise
);
25602 Qslice
= intern_c_string ("slice");
25603 staticpro (&Qslice
);
25604 Qspace
= intern_c_string ("space");
25605 staticpro (&Qspace
);
25606 Qmargin
= intern_c_string ("margin");
25607 staticpro (&Qmargin
);
25608 Qpointer
= intern_c_string ("pointer");
25609 staticpro (&Qpointer
);
25610 Qleft_margin
= intern_c_string ("left-margin");
25611 staticpro (&Qleft_margin
);
25612 Qright_margin
= intern_c_string ("right-margin");
25613 staticpro (&Qright_margin
);
25614 Qcenter
= intern_c_string ("center");
25615 staticpro (&Qcenter
);
25616 Qline_height
= intern_c_string ("line-height");
25617 staticpro (&Qline_height
);
25618 QCalign_to
= intern_c_string (":align-to");
25619 staticpro (&QCalign_to
);
25620 QCrelative_width
= intern_c_string (":relative-width");
25621 staticpro (&QCrelative_width
);
25622 QCrelative_height
= intern_c_string (":relative-height");
25623 staticpro (&QCrelative_height
);
25624 QCeval
= intern_c_string (":eval");
25625 staticpro (&QCeval
);
25626 QCpropertize
= intern_c_string (":propertize");
25627 staticpro (&QCpropertize
);
25628 QCfile
= intern_c_string (":file");
25629 staticpro (&QCfile
);
25630 Qfontified
= intern_c_string ("fontified");
25631 staticpro (&Qfontified
);
25632 Qfontification_functions
= intern_c_string ("fontification-functions");
25633 staticpro (&Qfontification_functions
);
25634 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25635 staticpro (&Qtrailing_whitespace
);
25636 Qescape_glyph
= intern_c_string ("escape-glyph");
25637 staticpro (&Qescape_glyph
);
25638 Qnobreak_space
= intern_c_string ("nobreak-space");
25639 staticpro (&Qnobreak_space
);
25640 Qimage
= intern_c_string ("image");
25641 staticpro (&Qimage
);
25642 Qtext
= intern_c_string ("text");
25643 staticpro (&Qtext
);
25644 Qboth
= intern_c_string ("both");
25645 staticpro (&Qboth
);
25646 Qboth_horiz
= intern_c_string ("both-horiz");
25647 staticpro (&Qboth_horiz
);
25648 QCmap
= intern_c_string (":map");
25649 staticpro (&QCmap
);
25650 QCpointer
= intern_c_string (":pointer");
25651 staticpro (&QCpointer
);
25652 Qrect
= intern_c_string ("rect");
25653 staticpro (&Qrect
);
25654 Qcircle
= intern_c_string ("circle");
25655 staticpro (&Qcircle
);
25656 Qpoly
= intern_c_string ("poly");
25657 staticpro (&Qpoly
);
25658 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25659 staticpro (&Qmessage_truncate_lines
);
25660 Qgrow_only
= intern_c_string ("grow-only");
25661 staticpro (&Qgrow_only
);
25662 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25663 staticpro (&Qinhibit_menubar_update
);
25664 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25665 staticpro (&Qinhibit_eval_during_redisplay
);
25666 Qposition
= intern_c_string ("position");
25667 staticpro (&Qposition
);
25668 Qbuffer_position
= intern_c_string ("buffer-position");
25669 staticpro (&Qbuffer_position
);
25670 Qobject
= intern_c_string ("object");
25671 staticpro (&Qobject
);
25672 Qbar
= intern_c_string ("bar");
25674 Qhbar
= intern_c_string ("hbar");
25675 staticpro (&Qhbar
);
25676 Qbox
= intern_c_string ("box");
25678 Qhollow
= intern_c_string ("hollow");
25679 staticpro (&Qhollow
);
25680 Qhand
= intern_c_string ("hand");
25681 staticpro (&Qhand
);
25682 Qarrow
= intern_c_string ("arrow");
25683 staticpro (&Qarrow
);
25684 Qtext
= intern_c_string ("text");
25685 staticpro (&Qtext
);
25686 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25687 staticpro (&Qrisky_local_variable
);
25688 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25689 staticpro (&Qinhibit_free_realized_faces
);
25691 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25692 Fcons (intern_c_string ("void-variable"), Qnil
)),
25694 staticpro (&list_of_error
);
25696 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25697 staticpro (&Qlast_arrow_position
);
25698 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25699 staticpro (&Qlast_arrow_string
);
25701 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25702 staticpro (&Qoverlay_arrow_string
);
25703 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25704 staticpro (&Qoverlay_arrow_bitmap
);
25706 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25707 staticpro (&echo_buffer
[0]);
25708 staticpro (&echo_buffer
[1]);
25710 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25711 staticpro (&echo_area_buffer
[0]);
25712 staticpro (&echo_area_buffer
[1]);
25714 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25715 staticpro (&Vmessages_buffer_name
);
25717 mode_line_proptrans_alist
= Qnil
;
25718 staticpro (&mode_line_proptrans_alist
);
25719 mode_line_string_list
= Qnil
;
25720 staticpro (&mode_line_string_list
);
25721 mode_line_string_face
= Qnil
;
25722 staticpro (&mode_line_string_face
);
25723 mode_line_string_face_prop
= Qnil
;
25724 staticpro (&mode_line_string_face_prop
);
25725 Vmode_line_unwind_vector
= Qnil
;
25726 staticpro (&Vmode_line_unwind_vector
);
25728 help_echo_string
= Qnil
;
25729 staticpro (&help_echo_string
);
25730 help_echo_object
= Qnil
;
25731 staticpro (&help_echo_object
);
25732 help_echo_window
= Qnil
;
25733 staticpro (&help_echo_window
);
25734 previous_help_echo_string
= Qnil
;
25735 staticpro (&previous_help_echo_string
);
25736 help_echo_pos
= -1;
25738 Qright_to_left
= intern_c_string ("right-to-left");
25739 staticpro (&Qright_to_left
);
25740 Qleft_to_right
= intern_c_string ("left-to-right");
25741 staticpro (&Qleft_to_right
);
25743 #ifdef HAVE_WINDOW_SYSTEM
25744 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25745 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25746 For example, if a block cursor is over a tab, it will be drawn as
25747 wide as that tab on the display. */);
25748 x_stretch_cursor_p
= 0;
25751 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25752 doc
: /* *Non-nil means highlight trailing whitespace.
25753 The face used for trailing whitespace is `trailing-whitespace'. */);
25754 Vshow_trailing_whitespace
= Qnil
;
25756 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25757 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25758 A value of t means highlight the character itself (for nobreak space,
25759 use face `nobreak-space').
25760 A value of nil means no highlighting.
25761 Other values mean display the escape glyph followed by an ordinary
25762 space or ordinary hyphen. */);
25763 Vnobreak_char_display
= Qt
;
25765 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25766 doc
: /* *The pointer shape to show in void text areas.
25767 A value of nil means to show the text pointer. Other options are `arrow',
25768 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25769 Vvoid_text_area_pointer
= Qarrow
;
25771 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25772 doc
: /* Non-nil means don't actually do any redisplay.
25773 This is used for internal purposes. */);
25774 Vinhibit_redisplay
= Qnil
;
25776 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25777 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25778 Vglobal_mode_string
= Qnil
;
25780 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25781 doc
: /* Marker for where to display an arrow on top of the buffer text.
25782 This must be the beginning of a line in order to work.
25783 See also `overlay-arrow-string'. */);
25784 Voverlay_arrow_position
= Qnil
;
25786 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25787 doc
: /* String to display as an arrow in non-window frames.
25788 See also `overlay-arrow-position'. */);
25789 Voverlay_arrow_string
= make_pure_c_string ("=>");
25791 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25792 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25793 The symbols on this list are examined during redisplay to determine
25794 where to display overlay arrows. */);
25795 Voverlay_arrow_variable_list
25796 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25798 DEFVAR_INT ("scroll-step", &scroll_step
,
25799 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25800 If that fails to bring point back on frame, point is centered instead.
25801 If this is zero, point is always centered after it moves off frame.
25802 If you want scrolling to always be a line at a time, you should set
25803 `scroll-conservatively' to a large value rather than set this to 1. */);
25805 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25806 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25807 If point moves off-screen, redisplay will scroll by up to
25808 `scroll-conservatively' lines in order to bring point just barely
25809 onto the screen again. If that cannot be done, then redisplay
25810 recenters point as usual.
25812 A value of zero means always recenter point if it moves off screen. */);
25813 scroll_conservatively
= 0;
25815 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25816 doc
: /* *Number of lines of margin at the top and bottom of a window.
25817 Recenter the window whenever point gets within this many lines
25818 of the top or bottom of the window. */);
25821 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25822 doc
: /* Pixels per inch value for non-window system displays.
25823 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25824 Vdisplay_pixels_per_inch
= make_float (72.0);
25827 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25830 DEFVAR_LISP ("truncate-partial-width-windows",
25831 &Vtruncate_partial_width_windows
,
25832 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25833 For an integer value, truncate lines in each window narrower than the
25834 full frame width, provided the window width is less than that integer;
25835 otherwise, respect the value of `truncate-lines'.
25837 For any other non-nil value, truncate lines in all windows that do
25838 not span the full frame width.
25840 A value of nil means to respect the value of `truncate-lines'.
25842 If `word-wrap' is enabled, you might want to reduce this. */);
25843 Vtruncate_partial_width_windows
= make_number (50);
25845 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25846 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25847 Any other value means to use the appropriate face, `mode-line',
25848 `header-line', or `menu' respectively. */);
25849 mode_line_inverse_video
= 1;
25851 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25852 doc
: /* *Maximum buffer size for which line number should be displayed.
25853 If the buffer is bigger than this, the line number does not appear
25854 in the mode line. A value of nil means no limit. */);
25855 Vline_number_display_limit
= Qnil
;
25857 DEFVAR_INT ("line-number-display-limit-width",
25858 &line_number_display_limit_width
,
25859 doc
: /* *Maximum line width (in characters) for line number display.
25860 If the average length of the lines near point is bigger than this, then the
25861 line number may be omitted from the mode line. */);
25862 line_number_display_limit_width
= 200;
25864 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25865 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25866 highlight_nonselected_windows
= 0;
25868 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25869 doc
: /* Non-nil if more than one frame is visible on this display.
25870 Minibuffer-only frames don't count, but iconified frames do.
25871 This variable is not guaranteed to be accurate except while processing
25872 `frame-title-format' and `icon-title-format'. */);
25874 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25875 doc
: /* Template for displaying the title bar of visible frames.
25876 \(Assuming the window manager supports this feature.)
25878 This variable has the same structure as `mode-line-format', except that
25879 the %c and %l constructs are ignored. It is used only on frames for
25880 which no explicit name has been set \(see `modify-frame-parameters'). */);
25882 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25883 doc
: /* Template for displaying the title bar of an iconified frame.
25884 \(Assuming the window manager supports this feature.)
25885 This variable has the same structure as `mode-line-format' (which see),
25886 and is used only on frames for which no explicit name has been set
25887 \(see `modify-frame-parameters'). */);
25889 = Vframe_title_format
25890 = pure_cons (intern_c_string ("multiple-frames"),
25891 pure_cons (make_pure_c_string ("%b"),
25892 pure_cons (pure_cons (empty_unibyte_string
,
25893 pure_cons (intern_c_string ("invocation-name"),
25894 pure_cons (make_pure_c_string ("@"),
25895 pure_cons (intern_c_string ("system-name"),
25899 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25900 doc
: /* Maximum number of lines to keep in the message log buffer.
25901 If nil, disable message logging. If t, log messages but don't truncate
25902 the buffer when it becomes large. */);
25903 Vmessage_log_max
= make_number (100);
25905 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25906 doc
: /* Functions called before redisplay, if window sizes have changed.
25907 The value should be a list of functions that take one argument.
25908 Just before redisplay, for each frame, if any of its windows have changed
25909 size since the last redisplay, or have been split or deleted,
25910 all the functions in the list are called, with the frame as argument. */);
25911 Vwindow_size_change_functions
= Qnil
;
25913 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25914 doc
: /* List of functions to call before redisplaying a window with scrolling.
25915 Each function is called with two arguments, the window and its new
25916 display-start position. Note that these functions are also called by
25917 `set-window-buffer'. Also note that the value of `window-end' is not
25918 valid when these functions are called. */);
25919 Vwindow_scroll_functions
= Qnil
;
25921 DEFVAR_LISP ("window-text-change-functions",
25922 &Vwindow_text_change_functions
,
25923 doc
: /* Functions to call in redisplay when text in the window might change. */);
25924 Vwindow_text_change_functions
= Qnil
;
25926 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25927 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25928 Each function is called with two arguments, the window and the end trigger value.
25929 See `set-window-redisplay-end-trigger'. */);
25930 Vredisplay_end_trigger_functions
= Qnil
;
25932 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25933 doc
: /* *Non-nil means autoselect window with mouse pointer.
25934 If nil, do not autoselect windows.
25935 A positive number means delay autoselection by that many seconds: a
25936 window is autoselected only after the mouse has remained in that
25937 window for the duration of the delay.
25938 A negative number has a similar effect, but causes windows to be
25939 autoselected only after the mouse has stopped moving. \(Because of
25940 the way Emacs compares mouse events, you will occasionally wait twice
25941 that time before the window gets selected.\)
25942 Any other value means to autoselect window instantaneously when the
25943 mouse pointer enters it.
25945 Autoselection selects the minibuffer only if it is active, and never
25946 unselects the minibuffer if it is active.
25948 When customizing this variable make sure that the actual value of
25949 `focus-follows-mouse' matches the behavior of your window manager. */);
25950 Vmouse_autoselect_window
= Qnil
;
25952 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25953 doc
: /* *Non-nil means automatically resize tool-bars.
25954 This dynamically changes the tool-bar's height to the minimum height
25955 that is needed to make all tool-bar items visible.
25956 If value is `grow-only', the tool-bar's height is only increased
25957 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25958 Vauto_resize_tool_bars
= Qt
;
25960 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25961 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25962 auto_raise_tool_bar_buttons_p
= 1;
25964 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25965 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25966 make_cursor_line_fully_visible_p
= 1;
25968 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25969 doc
: /* *Border below tool-bar in pixels.
25970 If an integer, use it as the height of the border.
25971 If it is one of `internal-border-width' or `border-width', use the
25972 value of the corresponding frame parameter.
25973 Otherwise, no border is added below the tool-bar. */);
25974 Vtool_bar_border
= Qinternal_border_width
;
25976 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25977 doc
: /* *Margin around tool-bar buttons in pixels.
25978 If an integer, use that for both horizontal and vertical margins.
25979 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25980 HORZ specifying the horizontal margin, and VERT specifying the
25981 vertical margin. */);
25982 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25984 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25985 doc
: /* *Relief thickness of tool-bar buttons. */);
25986 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25988 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
25989 doc
: /* *Tool bar style to use.
25991 image - show images only
25992 text - show text only
25993 both - show both, text under image
25994 both-horiz - show text to the right of the image
25995 any other - use system default or image if no system default. */);
25996 Vtool_bar_style
= Qnil
;
25998 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
25999 doc
: /* *Maximum number of characters a label can have to be shown.
26000 The tool bar style must also show labels for this to have any effect, see
26001 `tool-bar-style'. */);
26002 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26004 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
26005 doc
: /* List of functions to call to fontify regions of text.
26006 Each function is called with one argument POS. Functions must
26007 fontify a region starting at POS in the current buffer, and give
26008 fontified regions the property `fontified'. */);
26009 Vfontification_functions
= Qnil
;
26010 Fmake_variable_buffer_local (Qfontification_functions
);
26012 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26013 &unibyte_display_via_language_environment
,
26014 doc
: /* *Non-nil means display unibyte text according to language environment.
26015 Specifically, this means that raw bytes in the range 160-255 decimal
26016 are displayed by converting them to the equivalent multibyte characters
26017 according to the current language environment. As a result, they are
26018 displayed according to the current fontset.
26020 Note that this variable affects only how these bytes are displayed,
26021 but does not change the fact they are interpreted as raw bytes. */);
26022 unibyte_display_via_language_environment
= 0;
26024 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
26025 doc
: /* *Maximum height for resizing mini-windows.
26026 If a float, it specifies a fraction of the mini-window frame's height.
26027 If an integer, it specifies a number of lines. */);
26028 Vmax_mini_window_height
= make_float (0.25);
26030 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
26031 doc
: /* *How to resize mini-windows.
26032 A value of nil means don't automatically resize mini-windows.
26033 A value of t means resize them to fit the text displayed in them.
26034 A value of `grow-only', the default, means let mini-windows grow
26035 only, until their display becomes empty, at which point the windows
26036 go back to their normal size. */);
26037 Vresize_mini_windows
= Qgrow_only
;
26039 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
26040 doc
: /* Alist specifying how to blink the cursor off.
26041 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26042 `cursor-type' frame-parameter or variable equals ON-STATE,
26043 comparing using `equal', Emacs uses OFF-STATE to specify
26044 how to blink it off. ON-STATE and OFF-STATE are values for
26045 the `cursor-type' frame parameter.
26047 If a frame's ON-STATE has no entry in this list,
26048 the frame's other specifications determine how to blink the cursor off. */);
26049 Vblink_cursor_alist
= Qnil
;
26051 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
26052 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
26053 automatic_hscrolling_p
= 1;
26054 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26055 staticpro (&Qauto_hscroll_mode
);
26057 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
26058 doc
: /* *How many columns away from the window edge point is allowed to get
26059 before automatic hscrolling will horizontally scroll the window. */);
26060 hscroll_margin
= 5;
26062 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
26063 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26064 When point is less than `hscroll-margin' columns from the window
26065 edge, automatic hscrolling will scroll the window by the amount of columns
26066 determined by this variable. If its value is a positive integer, scroll that
26067 many columns. If it's a positive floating-point number, it specifies the
26068 fraction of the window's width to scroll. If it's nil or zero, point will be
26069 centered horizontally after the scroll. Any other value, including negative
26070 numbers, are treated as if the value were zero.
26072 Automatic hscrolling always moves point outside the scroll margin, so if
26073 point was more than scroll step columns inside the margin, the window will
26074 scroll more than the value given by the scroll step.
26076 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26077 and `scroll-right' overrides this variable's effect. */);
26078 Vhscroll_step
= make_number (0);
26080 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
26081 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26082 Bind this around calls to `message' to let it take effect. */);
26083 message_truncate_lines
= 0;
26085 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
26086 doc
: /* Normal hook run to update the menu bar definitions.
26087 Redisplay runs this hook before it redisplays the menu bar.
26088 This is used to update submenus such as Buffers,
26089 whose contents depend on various data. */);
26090 Vmenu_bar_update_hook
= Qnil
;
26092 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26093 doc
: /* Frame for which we are updating a menu.
26094 The enable predicate for a menu binding should check this variable. */);
26095 Vmenu_updating_frame
= Qnil
;
26097 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26098 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26099 inhibit_menubar_update
= 0;
26101 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26102 doc
: /* Prefix prepended to all continuation lines at display time.
26103 The value may be a string, an image, or a stretch-glyph; it is
26104 interpreted in the same way as the value of a `display' text property.
26106 This variable is overridden by any `wrap-prefix' text or overlay
26109 To add a prefix to non-continuation lines, use `line-prefix'. */);
26110 Vwrap_prefix
= Qnil
;
26111 staticpro (&Qwrap_prefix
);
26112 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26113 Fmake_variable_buffer_local (Qwrap_prefix
);
26115 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26116 doc
: /* Prefix prepended to all non-continuation lines at display time.
26117 The value may be a string, an image, or a stretch-glyph; it is
26118 interpreted in the same way as the value of a `display' text property.
26120 This variable is overridden by any `line-prefix' text or overlay
26123 To add a prefix to continuation lines, use `wrap-prefix'. */);
26124 Vline_prefix
= Qnil
;
26125 staticpro (&Qline_prefix
);
26126 Qline_prefix
= intern_c_string ("line-prefix");
26127 Fmake_variable_buffer_local (Qline_prefix
);
26129 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26130 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26131 inhibit_eval_during_redisplay
= 0;
26133 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26134 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26135 inhibit_free_realized_faces
= 0;
26138 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26139 doc
: /* Inhibit try_window_id display optimization. */);
26140 inhibit_try_window_id
= 0;
26142 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26143 doc
: /* Inhibit try_window_reusing display optimization. */);
26144 inhibit_try_window_reusing
= 0;
26146 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26147 doc
: /* Inhibit try_cursor_movement display optimization. */);
26148 inhibit_try_cursor_movement
= 0;
26149 #endif /* GLYPH_DEBUG */
26151 DEFVAR_INT ("overline-margin", &overline_margin
,
26152 doc
: /* *Space between overline and text, in pixels.
26153 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26154 margin to the caracter height. */);
26155 overline_margin
= 2;
26157 DEFVAR_INT ("underline-minimum-offset",
26158 &underline_minimum_offset
,
26159 doc
: /* Minimum distance between baseline and underline.
26160 This can improve legibility of underlined text at small font sizes,
26161 particularly when using variable `x-use-underline-position-properties'
26162 with fonts that specify an UNDERLINE_POSITION relatively close to the
26163 baseline. The default value is 1. */);
26164 underline_minimum_offset
= 1;
26166 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26167 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26168 display_hourglass_p
= 1;
26170 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26171 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26172 Value must be an integer or float. */);
26173 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26175 hourglass_atimer
= NULL
;
26176 hourglass_shown_p
= 0;
26180 /* Initialize this module when Emacs starts. */
26185 Lisp_Object root_window
;
26186 struct window
*mini_w
;
26188 current_header_line_height
= current_mode_line_height
= -1;
26190 CHARPOS (this_line_start_pos
) = 0;
26192 mini_w
= XWINDOW (minibuf_window
);
26193 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26195 if (!noninteractive
)
26197 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26200 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26201 set_window_height (root_window
,
26202 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26204 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26205 set_window_height (minibuf_window
, 1, 0);
26207 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26208 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26210 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26211 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26212 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26214 /* The default ellipsis glyphs `...'. */
26215 for (i
= 0; i
< 3; ++i
)
26216 default_invis_vector
[i
] = make_number ('.');
26220 /* Allocate the buffer for frame titles.
26221 Also used for `format-mode-line'. */
26223 mode_line_noprop_buf
= (char *) xmalloc (size
);
26224 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26225 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26226 mode_line_target
= MODE_LINE_DISPLAY
;
26229 help_echo_showing_p
= 0;
26232 /* Since w32 does not support atimers, it defines its own implementation of
26233 the following three functions in w32fns.c. */
26236 /* Platform-independent portion of hourglass implementation. */
26238 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26240 hourglass_started (void)
26242 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26245 /* Cancel a currently active hourglass timer, and start a new one. */
26247 start_hourglass (void)
26249 #if defined (HAVE_WINDOW_SYSTEM)
26251 int secs
, usecs
= 0;
26253 cancel_hourglass ();
26255 if (INTEGERP (Vhourglass_delay
)
26256 && XINT (Vhourglass_delay
) > 0)
26257 secs
= XFASTINT (Vhourglass_delay
);
26258 else if (FLOATP (Vhourglass_delay
)
26259 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26262 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26263 secs
= XFASTINT (tem
);
26264 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26267 secs
= DEFAULT_HOURGLASS_DELAY
;
26269 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26270 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26271 show_hourglass
, NULL
);
26276 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26279 cancel_hourglass (void)
26281 #if defined (HAVE_WINDOW_SYSTEM)
26282 if (hourglass_atimer
)
26284 cancel_atimer (hourglass_atimer
);
26285 hourglass_atimer
= NULL
;
26288 if (hourglass_shown_p
)
26292 #endif /* ! WINDOWSNT */
26294 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26295 (do not change this comment) */