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 (window
, just_this_one_p
, scroll_conservatively
,
13086 scroll_step
, temp_scroll_step
, last_line_misfit
)
13087 Lisp_Object window
;
13088 int just_this_one_p
;
13089 EMACS_INT scroll_conservatively
, scroll_step
;
13090 int temp_scroll_step
;
13091 int last_line_misfit
;
13093 struct window
*w
= XWINDOW (window
);
13094 struct frame
*f
= XFRAME (w
->frame
);
13095 struct text_pos pos
, startp
;
13097 int this_scroll_margin
, scroll_max
, rc
, height
;
13098 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13099 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13100 Lisp_Object aggressive
;
13101 int scroll_limit
= INT_MAX
/ FRAME_LINE_HEIGHT (f
);
13104 debug_method_add (w
, "try_scrolling");
13107 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13109 /* Compute scroll margin height in pixels. We scroll when point is
13110 within this distance from the top or bottom of the window. */
13111 if (scroll_margin
> 0)
13112 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13113 * FRAME_LINE_HEIGHT (f
);
13115 this_scroll_margin
= 0;
13117 /* Force scroll_conservatively to have a reasonable value, to avoid
13118 overflow while computing how much to scroll. Note that the user
13119 can supply scroll-conservatively equal to `most-positive-fixnum',
13120 which can be larger than INT_MAX. */
13121 if (scroll_conservatively
> scroll_limit
)
13123 scroll_conservatively
= scroll_limit
;
13124 scroll_max
= INT_MAX
;
13126 else if (scroll_step
|| scroll_conservatively
|| temp_scroll_step
)
13127 /* Compute how much we should try to scroll maximally to bring
13128 point into view. */
13129 scroll_max
= (max (scroll_step
,
13130 max (scroll_conservatively
, temp_scroll_step
))
13131 * FRAME_LINE_HEIGHT (f
));
13132 else if (NUMBERP (current_buffer
->scroll_down_aggressively
)
13133 || NUMBERP (current_buffer
->scroll_up_aggressively
))
13134 /* We're trying to scroll because of aggressive scrolling but no
13135 scroll_step is set. Choose an arbitrary one. */
13136 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13142 /* Decide whether to scroll down. */
13143 if (PT
> CHARPOS (startp
))
13145 int scroll_margin_y
;
13147 /* Compute the pixel ypos of the scroll margin, then move it to
13148 either that ypos or PT, whichever comes first. */
13149 start_display (&it
, w
, startp
);
13150 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
13151 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
13152 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
13153 (MOVE_TO_POS
| MOVE_TO_Y
));
13155 if (PT
> CHARPOS (it
.current
.pos
))
13157 int y0
= line_bottom_y (&it
);
13158 /* Compute how many pixels below window bottom to stop searching
13159 for PT. This avoids costly search for PT that is far away if
13160 the user limited scrolling by a small number of lines, but
13161 always finds PT if scroll_conservatively is set to a large
13162 number, such as most-positive-fixnum. */
13163 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
13165 slack
>= INT_MAX
- it
.last_visible_y
13167 : it
.last_visible_y
+ slack
;
13169 /* Compute the distance from the scroll margin to PT or to
13170 the scroll limit, whichever comes first. This should
13171 include the height of the cursor line, to make that line
13173 move_it_to (&it
, PT
, -1, y_to_move
,
13174 -1, MOVE_TO_POS
| MOVE_TO_Y
);
13175 dy
= line_bottom_y (&it
) - y0
;
13177 if (dy
> scroll_max
)
13178 return SCROLLING_FAILED
;
13186 /* Point is in or below the bottom scroll margin, so move the
13187 window start down. If scrolling conservatively, move it just
13188 enough down to make point visible. If scroll_step is set,
13189 move it down by scroll_step. */
13190 if (scroll_conservatively
)
13192 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
13193 FRAME_LINE_HEIGHT (f
) * scroll_conservatively
);
13194 else if (scroll_step
|| temp_scroll_step
)
13195 amount_to_scroll
= scroll_max
;
13198 aggressive
= current_buffer
->scroll_up_aggressively
;
13199 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13200 if (NUMBERP (aggressive
))
13202 double float_amount
= XFLOATINT (aggressive
) * height
;
13203 amount_to_scroll
= float_amount
;
13204 if (amount_to_scroll
== 0 && float_amount
> 0)
13205 amount_to_scroll
= 1;
13209 if (amount_to_scroll
<= 0)
13210 return SCROLLING_FAILED
;
13212 start_display (&it
, w
, startp
);
13213 if (scroll_max
< INT_MAX
)
13214 move_it_vertically (&it
, amount_to_scroll
);
13217 /* Extra precision for users who set scroll-conservatively
13218 to most-positive-fixnum: make sure the amount we scroll
13219 the window start is never less than amount_to_scroll,
13220 which was computed as distance from window bottom to
13221 point. This matters when lines at window top and lines
13222 below window bottom have different height. */
13223 struct it it1
= it
;
13224 /* We use a temporary it1 because line_bottom_y can modify
13225 its argument, if it moves one line down; see there. */
13226 int start_y
= line_bottom_y (&it1
);
13229 move_it_by_lines (&it
, 1, 1);
13231 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
13234 /* If STARTP is unchanged, move it down another screen line. */
13235 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
13236 move_it_by_lines (&it
, 1, 1);
13237 startp
= it
.current
.pos
;
13241 struct text_pos scroll_margin_pos
= startp
;
13243 /* See if point is inside the scroll margin at the top of the
13245 if (this_scroll_margin
)
13247 start_display (&it
, w
, startp
);
13248 move_it_vertically (&it
, this_scroll_margin
);
13249 scroll_margin_pos
= it
.current
.pos
;
13252 if (PT
< CHARPOS (scroll_margin_pos
))
13254 /* Point is in the scroll margin at the top of the window or
13255 above what is displayed in the window. */
13258 /* Compute the vertical distance from PT to the scroll
13259 margin position. Give up if distance is greater than
13261 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
13262 start_display (&it
, w
, pos
);
13264 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
13265 it
.last_visible_y
, -1,
13266 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13267 dy
= it
.current_y
- y0
;
13268 if (dy
> scroll_max
)
13269 return SCROLLING_FAILED
;
13271 /* Compute new window start. */
13272 start_display (&it
, w
, startp
);
13274 if (scroll_conservatively
)
13276 = max (dy
, FRAME_LINE_HEIGHT (f
) * max (scroll_step
, temp_scroll_step
));
13277 else if (scroll_step
|| temp_scroll_step
)
13278 amount_to_scroll
= scroll_max
;
13281 aggressive
= current_buffer
->scroll_down_aggressively
;
13282 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
13283 if (NUMBERP (aggressive
))
13285 double float_amount
= XFLOATINT (aggressive
) * height
;
13286 amount_to_scroll
= float_amount
;
13287 if (amount_to_scroll
== 0 && float_amount
> 0)
13288 amount_to_scroll
= 1;
13292 if (amount_to_scroll
<= 0)
13293 return SCROLLING_FAILED
;
13295 move_it_vertically_backward (&it
, amount_to_scroll
);
13296 startp
= it
.current
.pos
;
13300 /* Run window scroll functions. */
13301 startp
= run_window_scroll_functions (window
, startp
);
13303 /* Display the window. Give up if new fonts are loaded, or if point
13305 if (!try_window (window
, startp
, 0))
13306 rc
= SCROLLING_NEED_LARGER_MATRICES
;
13307 else if (w
->cursor
.vpos
< 0)
13309 clear_glyph_matrix (w
->desired_matrix
);
13310 rc
= SCROLLING_FAILED
;
13314 /* Maybe forget recorded base line for line number display. */
13315 if (!just_this_one_p
13316 || current_buffer
->clip_changed
13317 || BEG_UNCHANGED
< CHARPOS (startp
))
13318 w
->base_line_number
= Qnil
;
13320 /* If cursor ends up on a partially visible line,
13321 treat that as being off the bottom of the screen. */
13322 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0))
13324 clear_glyph_matrix (w
->desired_matrix
);
13325 ++extra_scroll_margin_lines
;
13328 rc
= SCROLLING_SUCCESS
;
13335 /* Compute a suitable window start for window W if display of W starts
13336 on a continuation line. Value is non-zero if a new window start
13339 The new window start will be computed, based on W's width, starting
13340 from the start of the continued line. It is the start of the
13341 screen line with the minimum distance from the old start W->start. */
13344 compute_window_start_on_continuation_line (struct window
*w
)
13346 struct text_pos pos
, start_pos
;
13347 int window_start_changed_p
= 0;
13349 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
13351 /* If window start is on a continuation line... Window start may be
13352 < BEGV in case there's invisible text at the start of the
13353 buffer (M-x rmail, for example). */
13354 if (CHARPOS (start_pos
) > BEGV
13355 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
13358 struct glyph_row
*row
;
13360 /* Handle the case that the window start is out of range. */
13361 if (CHARPOS (start_pos
) < BEGV
)
13362 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
13363 else if (CHARPOS (start_pos
) > ZV
)
13364 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
13366 /* Find the start of the continued line. This should be fast
13367 because scan_buffer is fast (newline cache). */
13368 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
13369 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
13370 row
, DEFAULT_FACE_ID
);
13371 reseat_at_previous_visible_line_start (&it
);
13373 /* If the line start is "too far" away from the window start,
13374 say it takes too much time to compute a new window start. */
13375 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
13376 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
13378 int min_distance
, distance
;
13380 /* Move forward by display lines to find the new window
13381 start. If window width was enlarged, the new start can
13382 be expected to be > the old start. If window width was
13383 decreased, the new window start will be < the old start.
13384 So, we're looking for the display line start with the
13385 minimum distance from the old window start. */
13386 pos
= it
.current
.pos
;
13387 min_distance
= INFINITY
;
13388 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
13389 distance
< min_distance
)
13391 min_distance
= distance
;
13392 pos
= it
.current
.pos
;
13393 move_it_by_lines (&it
, 1, 0);
13396 /* Set the window start there. */
13397 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
13398 window_start_changed_p
= 1;
13402 return window_start_changed_p
;
13406 /* Try cursor movement in case text has not changed in window WINDOW,
13407 with window start STARTP. Value is
13409 CURSOR_MOVEMENT_SUCCESS if successful
13411 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
13413 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
13414 display. *SCROLL_STEP is set to 1, under certain circumstances, if
13415 we want to scroll as if scroll-step were set to 1. See the code.
13417 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
13418 which case we have to abort this redisplay, and adjust matrices
13423 CURSOR_MOVEMENT_SUCCESS
,
13424 CURSOR_MOVEMENT_CANNOT_BE_USED
,
13425 CURSOR_MOVEMENT_MUST_SCROLL
,
13426 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
13430 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
13432 struct window
*w
= XWINDOW (window
);
13433 struct frame
*f
= XFRAME (w
->frame
);
13434 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
13437 if (inhibit_try_cursor_movement
)
13441 /* Handle case where text has not changed, only point, and it has
13442 not moved off the frame. */
13443 if (/* Point may be in this window. */
13444 PT
>= CHARPOS (startp
)
13445 /* Selective display hasn't changed. */
13446 && !current_buffer
->clip_changed
13447 /* Function force-mode-line-update is used to force a thorough
13448 redisplay. It sets either windows_or_buffers_changed or
13449 update_mode_lines. So don't take a shortcut here for these
13451 && !update_mode_lines
13452 && !windows_or_buffers_changed
13453 && !cursor_type_changed
13454 /* Can't use this case if highlighting a region. When a
13455 region exists, cursor movement has to do more than just
13457 && !(!NILP (Vtransient_mark_mode
)
13458 && !NILP (current_buffer
->mark_active
))
13459 && NILP (w
->region_showing
)
13460 && NILP (Vshow_trailing_whitespace
)
13461 /* Right after splitting windows, last_point may be nil. */
13462 && INTEGERP (w
->last_point
)
13463 /* This code is not used for mini-buffer for the sake of the case
13464 of redisplaying to replace an echo area message; since in
13465 that case the mini-buffer contents per se are usually
13466 unchanged. This code is of no real use in the mini-buffer
13467 since the handling of this_line_start_pos, etc., in redisplay
13468 handles the same cases. */
13469 && !EQ (window
, minibuf_window
)
13470 /* When splitting windows or for new windows, it happens that
13471 redisplay is called with a nil window_end_vpos or one being
13472 larger than the window. This should really be fixed in
13473 window.c. I don't have this on my list, now, so we do
13474 approximately the same as the old redisplay code. --gerd. */
13475 && INTEGERP (w
->window_end_vpos
)
13476 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
13477 && (FRAME_WINDOW_P (f
)
13478 || !overlay_arrow_in_current_buffer_p ()))
13480 int this_scroll_margin
, top_scroll_margin
;
13481 struct glyph_row
*row
= NULL
;
13484 debug_method_add (w
, "cursor movement");
13487 /* Scroll if point within this distance from the top or bottom
13488 of the window. This is a pixel value. */
13489 if (scroll_margin
> 0)
13491 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
13492 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
13495 this_scroll_margin
= 0;
13497 top_scroll_margin
= this_scroll_margin
;
13498 if (WINDOW_WANTS_HEADER_LINE_P (w
))
13499 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
13501 /* Start with the row the cursor was displayed during the last
13502 not paused redisplay. Give up if that row is not valid. */
13503 if (w
->last_cursor
.vpos
< 0
13504 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
13505 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13508 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
13509 if (row
->mode_line_p
)
13511 if (!row
->enabled_p
)
13512 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13515 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
13517 int scroll_p
= 0, must_scroll
= 0;
13518 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
13520 if (PT
> XFASTINT (w
->last_point
))
13522 /* Point has moved forward. */
13523 while (MATRIX_ROW_END_CHARPOS (row
) < PT
13524 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
13526 xassert (row
->enabled_p
);
13530 /* If the end position of a row equals the start
13531 position of the next row, and PT is at that position,
13532 we would rather display cursor in the next line. */
13533 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13534 && MATRIX_ROW_END_CHARPOS (row
) == PT
13535 && row
< w
->current_matrix
->rows
13536 + w
->current_matrix
->nrows
- 1
13537 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
13538 && !cursor_row_p (w
, row
))
13541 /* If within the scroll margin, scroll. Note that
13542 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
13543 the next line would be drawn, and that
13544 this_scroll_margin can be zero. */
13545 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
13546 || PT
> MATRIX_ROW_END_CHARPOS (row
)
13547 /* Line is completely visible last line in window
13548 and PT is to be set in the next line. */
13549 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
13550 && PT
== MATRIX_ROW_END_CHARPOS (row
)
13551 && !row
->ends_at_zv_p
13552 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
13555 else if (PT
< XFASTINT (w
->last_point
))
13557 /* Cursor has to be moved backward. Note that PT >=
13558 CHARPOS (startp) because of the outer if-statement. */
13559 while (!row
->mode_line_p
13560 && (MATRIX_ROW_START_CHARPOS (row
) > PT
13561 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13562 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
13563 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
13564 row
> w
->current_matrix
->rows
13565 && (row
-1)->ends_in_newline_from_string_p
))))
13566 && (row
->y
> top_scroll_margin
13567 || CHARPOS (startp
) == BEGV
))
13569 xassert (row
->enabled_p
);
13573 /* Consider the following case: Window starts at BEGV,
13574 there is invisible, intangible text at BEGV, so that
13575 display starts at some point START > BEGV. It can
13576 happen that we are called with PT somewhere between
13577 BEGV and START. Try to handle that case. */
13578 if (row
< w
->current_matrix
->rows
13579 || row
->mode_line_p
)
13581 row
= w
->current_matrix
->rows
;
13582 if (row
->mode_line_p
)
13586 /* Due to newlines in overlay strings, we may have to
13587 skip forward over overlay strings. */
13588 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13589 && MATRIX_ROW_END_CHARPOS (row
) == PT
13590 && !cursor_row_p (w
, row
))
13593 /* If within the scroll margin, scroll. */
13594 if (row
->y
< top_scroll_margin
13595 && CHARPOS (startp
) != BEGV
)
13600 /* Cursor did not move. So don't scroll even if cursor line
13601 is partially visible, as it was so before. */
13602 rc
= CURSOR_MOVEMENT_SUCCESS
;
13605 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
13606 || PT
> MATRIX_ROW_END_CHARPOS (row
))
13608 /* if PT is not in the glyph row, give up. */
13609 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13612 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13613 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13615 /* If rows are bidi-reordered and point moved, back up
13616 until we find a row that does not belong to a
13617 continuation line. This is because we must consider
13618 all rows of a continued line as candidates for the
13619 new cursor positioning, since row start and end
13620 positions change non-linearly with vertical position
13622 /* FIXME: Revisit this when glyph ``spilling'' in
13623 continuation lines' rows is implemented for
13624 bidi-reordered rows. */
13625 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
13627 xassert (row
->enabled_p
);
13629 /* If we hit the beginning of the displayed portion
13630 without finding the first row of a continued
13632 if (row
<= w
->current_matrix
->rows
)
13634 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13642 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13643 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
13644 && make_cursor_line_fully_visible_p
)
13646 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
13647 && !row
->ends_at_zv_p
13648 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
13649 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13650 else if (row
->height
> window_box_height (w
))
13652 /* If we end up in a partially visible line, let's
13653 make it fully visible, except when it's taller
13654 than the window, in which case we can't do much
13657 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13661 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13662 if (!cursor_row_fully_visible_p (w
, 0, 1))
13663 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13665 rc
= CURSOR_MOVEMENT_SUCCESS
;
13669 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13670 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
13671 && !NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
13673 /* With bidi-reordered rows, there could be more than
13674 one candidate row whose start and end positions
13675 occlude point. We need to let set_cursor_from_row
13676 find the best candidate. */
13677 /* FIXME: Revisit this when glyph ``spilling'' in
13678 continuation lines' rows is implemented for
13679 bidi-reordered rows. */
13684 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
13685 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
13686 && cursor_row_p (w
, row
))
13687 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
13689 /* As soon as we've found the first suitable row
13690 whose ends_at_zv_p flag is set, we are done. */
13692 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
13694 rc
= CURSOR_MOVEMENT_SUCCESS
;
13699 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
13700 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
13701 || (MATRIX_ROW_START_CHARPOS (row
) == PT
13702 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
13703 /* If we didn't find any candidate rows, or exited the
13704 loop before all the candidates were examined, signal
13705 to the caller that this method failed. */
13706 if (rc
!= CURSOR_MOVEMENT_SUCCESS
13707 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
13708 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
13710 rc
= CURSOR_MOVEMENT_SUCCESS
;
13716 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
13718 rc
= CURSOR_MOVEMENT_SUCCESS
;
13723 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
13724 && MATRIX_ROW_START_CHARPOS (row
) == PT
13725 && cursor_row_p (w
, row
));
13734 set_vertical_scroll_bar (struct window
*w
)
13736 int start
, end
, whole
;
13738 /* Calculate the start and end positions for the current window.
13739 At some point, it would be nice to choose between scrollbars
13740 which reflect the whole buffer size, with special markers
13741 indicating narrowing, and scrollbars which reflect only the
13744 Note that mini-buffers sometimes aren't displaying any text. */
13745 if (!MINI_WINDOW_P (w
)
13746 || (w
== XWINDOW (minibuf_window
)
13747 && NILP (echo_area_buffer
[0])))
13749 struct buffer
*buf
= XBUFFER (w
->buffer
);
13750 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
13751 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
13752 /* I don't think this is guaranteed to be right. For the
13753 moment, we'll pretend it is. */
13754 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
13758 if (whole
< (end
- start
))
13759 whole
= end
- start
;
13762 start
= end
= whole
= 0;
13764 /* Indicate what this scroll bar ought to be displaying now. */
13765 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13766 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
13767 (w
, end
- start
, whole
, start
);
13771 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
13772 selected_window is redisplayed.
13774 We can return without actually redisplaying the window if
13775 fonts_changed_p is nonzero. In that case, redisplay_internal will
13779 redisplay_window (Lisp_Object window
, int just_this_one_p
)
13781 struct window
*w
= XWINDOW (window
);
13782 struct frame
*f
= XFRAME (w
->frame
);
13783 struct buffer
*buffer
= XBUFFER (w
->buffer
);
13784 struct buffer
*old
= current_buffer
;
13785 struct text_pos lpoint
, opoint
, startp
;
13786 int update_mode_line
;
13789 /* Record it now because it's overwritten. */
13790 int current_matrix_up_to_date_p
= 0;
13791 int used_current_matrix_p
= 0;
13792 /* This is less strict than current_matrix_up_to_date_p.
13793 It indictes that the buffer contents and narrowing are unchanged. */
13794 int buffer_unchanged_p
= 0;
13795 int temp_scroll_step
= 0;
13796 int count
= SPECPDL_INDEX ();
13798 int centering_position
= -1;
13799 int last_line_misfit
= 0;
13800 int beg_unchanged
, end_unchanged
;
13802 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
13805 /* W must be a leaf window here. */
13806 xassert (!NILP (w
->buffer
));
13808 *w
->desired_matrix
->method
= 0;
13812 reconsider_clip_changes (w
, buffer
);
13814 /* Has the mode line to be updated? */
13815 update_mode_line
= (!NILP (w
->update_mode_line
)
13816 || update_mode_lines
13817 || buffer
->clip_changed
13818 || buffer
->prevent_redisplay_optimizations_p
);
13820 if (MINI_WINDOW_P (w
))
13822 if (w
== XWINDOW (echo_area_window
)
13823 && !NILP (echo_area_buffer
[0]))
13825 if (update_mode_line
)
13826 /* We may have to update a tty frame's menu bar or a
13827 tool-bar. Example `M-x C-h C-h C-g'. */
13828 goto finish_menu_bars
;
13830 /* We've already displayed the echo area glyphs in this window. */
13831 goto finish_scroll_bars
;
13833 else if ((w
!= XWINDOW (minibuf_window
)
13834 || minibuf_level
== 0)
13835 /* When buffer is nonempty, redisplay window normally. */
13836 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
13837 /* Quail displays non-mini buffers in minibuffer window.
13838 In that case, redisplay the window normally. */
13839 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
13841 /* W is a mini-buffer window, but it's not active, so clear
13843 int yb
= window_text_bottom_y (w
);
13844 struct glyph_row
*row
;
13847 for (y
= 0, row
= w
->desired_matrix
->rows
;
13849 y
+= row
->height
, ++row
)
13850 blank_row (w
, row
, y
);
13851 goto finish_scroll_bars
;
13854 clear_glyph_matrix (w
->desired_matrix
);
13857 /* Otherwise set up data on this window; select its buffer and point
13859 /* Really select the buffer, for the sake of buffer-local
13861 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13863 current_matrix_up_to_date_p
13864 = (!NILP (w
->window_end_valid
)
13865 && !current_buffer
->clip_changed
13866 && !current_buffer
->prevent_redisplay_optimizations_p
13867 && XFASTINT (w
->last_modified
) >= MODIFF
13868 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13870 /* Run the window-bottom-change-functions
13871 if it is possible that the text on the screen has changed
13872 (either due to modification of the text, or any other reason). */
13873 if (!current_matrix_up_to_date_p
13874 && !NILP (Vwindow_text_change_functions
))
13876 safe_run_hooks (Qwindow_text_change_functions
);
13880 beg_unchanged
= BEG_UNCHANGED
;
13881 end_unchanged
= END_UNCHANGED
;
13883 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
13885 specbind (Qinhibit_point_motion_hooks
, Qt
);
13888 = (!NILP (w
->window_end_valid
)
13889 && !current_buffer
->clip_changed
13890 && XFASTINT (w
->last_modified
) >= MODIFF
13891 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
13893 /* When windows_or_buffers_changed is non-zero, we can't rely on
13894 the window end being valid, so set it to nil there. */
13895 if (windows_or_buffers_changed
)
13897 /* If window starts on a continuation line, maybe adjust the
13898 window start in case the window's width changed. */
13899 if (XMARKER (w
->start
)->buffer
== current_buffer
)
13900 compute_window_start_on_continuation_line (w
);
13902 w
->window_end_valid
= Qnil
;
13905 /* Some sanity checks. */
13906 CHECK_WINDOW_END (w
);
13907 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
13909 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
13912 /* If %c is in mode line, update it if needed. */
13913 if (!NILP (w
->column_number_displayed
)
13914 /* This alternative quickly identifies a common case
13915 where no change is needed. */
13916 && !(PT
== XFASTINT (w
->last_point
)
13917 && XFASTINT (w
->last_modified
) >= MODIFF
13918 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
13919 && (XFASTINT (w
->column_number_displayed
)
13920 != (int) current_column ())) /* iftc */
13921 update_mode_line
= 1;
13923 /* Count number of windows showing the selected buffer. An indirect
13924 buffer counts as its base buffer. */
13925 if (!just_this_one_p
)
13927 struct buffer
*current_base
, *window_base
;
13928 current_base
= current_buffer
;
13929 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13930 if (current_base
->base_buffer
)
13931 current_base
= current_base
->base_buffer
;
13932 if (window_base
->base_buffer
)
13933 window_base
= window_base
->base_buffer
;
13934 if (current_base
== window_base
)
13938 /* Point refers normally to the selected window. For any other
13939 window, set up appropriate value. */
13940 if (!EQ (window
, selected_window
))
13942 int new_pt
= XMARKER (w
->pointm
)->charpos
;
13943 int new_pt_byte
= marker_byte_position (w
->pointm
);
13947 new_pt_byte
= BEGV_BYTE
;
13948 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
13950 else if (new_pt
> (ZV
- 1))
13953 new_pt_byte
= ZV_BYTE
;
13954 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
13957 /* We don't use SET_PT so that the point-motion hooks don't run. */
13958 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
13961 /* If any of the character widths specified in the display table
13962 have changed, invalidate the width run cache. It's true that
13963 this may be a bit late to catch such changes, but the rest of
13964 redisplay goes (non-fatally) haywire when the display table is
13965 changed, so why should we worry about doing any better? */
13966 if (current_buffer
->width_run_cache
)
13968 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
13970 if (! disptab_matches_widthtab (disptab
,
13971 XVECTOR (current_buffer
->width_table
)))
13973 invalidate_region_cache (current_buffer
,
13974 current_buffer
->width_run_cache
,
13976 recompute_width_table (current_buffer
, disptab
);
13980 /* If window-start is screwed up, choose a new one. */
13981 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
13984 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13986 /* If someone specified a new starting point but did not insist,
13987 check whether it can be used. */
13988 if (!NILP (w
->optional_new_start
)
13989 && CHARPOS (startp
) >= BEGV
13990 && CHARPOS (startp
) <= ZV
)
13992 w
->optional_new_start
= Qnil
;
13993 start_display (&it
, w
, startp
);
13994 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
13995 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
13996 if (IT_CHARPOS (it
) == PT
)
13997 w
->force_start
= Qt
;
13998 /* IT may overshoot PT if text at PT is invisible. */
13999 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14000 w
->force_start
= Qt
;
14005 /* Handle case where place to start displaying has been specified,
14006 unless the specified location is outside the accessible range. */
14007 if (!NILP (w
->force_start
)
14008 || w
->frozen_window_start_p
)
14010 /* We set this later on if we have to adjust point. */
14013 w
->force_start
= Qnil
;
14015 w
->window_end_valid
= Qnil
;
14017 /* Forget any recorded base line for line number display. */
14018 if (!buffer_unchanged_p
)
14019 w
->base_line_number
= Qnil
;
14021 /* Redisplay the mode line. Select the buffer properly for that.
14022 Also, run the hook window-scroll-functions
14023 because we have scrolled. */
14024 /* Note, we do this after clearing force_start because
14025 if there's an error, it is better to forget about force_start
14026 than to get into an infinite loop calling the hook functions
14027 and having them get more errors. */
14028 if (!update_mode_line
14029 || ! NILP (Vwindow_scroll_functions
))
14031 update_mode_line
= 1;
14032 w
->update_mode_line
= Qt
;
14033 startp
= run_window_scroll_functions (window
, startp
);
14036 w
->last_modified
= make_number (0);
14037 w
->last_overlay_modified
= make_number (0);
14038 if (CHARPOS (startp
) < BEGV
)
14039 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14040 else if (CHARPOS (startp
) > ZV
)
14041 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14043 /* Redisplay, then check if cursor has been set during the
14044 redisplay. Give up if new fonts were loaded. */
14045 /* We used to issue a CHECK_MARGINS argument to try_window here,
14046 but this causes scrolling to fail when point begins inside
14047 the scroll margin (bug#148) -- cyd */
14048 if (!try_window (window
, startp
, 0))
14050 w
->force_start
= Qt
;
14051 clear_glyph_matrix (w
->desired_matrix
);
14052 goto need_larger_matrices
;
14055 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14057 /* If point does not appear, try to move point so it does
14058 appear. The desired matrix has been built above, so we
14059 can use it here. */
14060 new_vpos
= window_box_height (w
) / 2;
14063 if (!cursor_row_fully_visible_p (w
, 0, 0))
14065 /* Point does appear, but on a line partly visible at end of window.
14066 Move it back to a fully-visible line. */
14067 new_vpos
= window_box_height (w
);
14070 /* If we need to move point for either of the above reasons,
14071 now actually do it. */
14074 struct glyph_row
*row
;
14076 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14077 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14080 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14081 MATRIX_ROW_START_BYTEPOS (row
));
14083 if (w
!= XWINDOW (selected_window
))
14084 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14085 else if (current_buffer
== old
)
14086 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14088 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14090 /* If we are highlighting the region, then we just changed
14091 the region, so redisplay to show it. */
14092 if (!NILP (Vtransient_mark_mode
)
14093 && !NILP (current_buffer
->mark_active
))
14095 clear_glyph_matrix (w
->desired_matrix
);
14096 if (!try_window (window
, startp
, 0))
14097 goto need_larger_matrices
;
14102 debug_method_add (w
, "forced window start");
14107 /* Handle case where text has not changed, only point, and it has
14108 not moved off the frame, and we are not retrying after hscroll.
14109 (current_matrix_up_to_date_p is nonzero when retrying.) */
14110 if (current_matrix_up_to_date_p
14111 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14112 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14116 case CURSOR_MOVEMENT_SUCCESS
:
14117 used_current_matrix_p
= 1;
14120 case CURSOR_MOVEMENT_MUST_SCROLL
:
14121 goto try_to_scroll
;
14127 /* If current starting point was originally the beginning of a line
14128 but no longer is, find a new starting point. */
14129 else if (!NILP (w
->start_at_line_beg
)
14130 && !(CHARPOS (startp
) <= BEGV
14131 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
14134 debug_method_add (w
, "recenter 1");
14139 /* Try scrolling with try_window_id. Value is > 0 if update has
14140 been done, it is -1 if we know that the same window start will
14141 not work. It is 0 if unsuccessful for some other reason. */
14142 else if ((tem
= try_window_id (w
)) != 0)
14145 debug_method_add (w
, "try_window_id %d", tem
);
14148 if (fonts_changed_p
)
14149 goto need_larger_matrices
;
14153 /* Otherwise try_window_id has returned -1 which means that we
14154 don't want the alternative below this comment to execute. */
14156 else if (CHARPOS (startp
) >= BEGV
14157 && CHARPOS (startp
) <= ZV
14158 && PT
>= CHARPOS (startp
)
14159 && (CHARPOS (startp
) < ZV
14160 /* Avoid starting at end of buffer. */
14161 || CHARPOS (startp
) == BEGV
14162 || (XFASTINT (w
->last_modified
) >= MODIFF
14163 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
14166 /* If first window line is a continuation line, and window start
14167 is inside the modified region, but the first change is before
14168 current window start, we must select a new window start.
14170 However, if this is the result of a down-mouse event (e.g. by
14171 extending the mouse-drag-overlay), we don't want to select a
14172 new window start, since that would change the position under
14173 the mouse, resulting in an unwanted mouse-movement rather
14174 than a simple mouse-click. */
14175 if (NILP (w
->start_at_line_beg
)
14176 && NILP (do_mouse_tracking
)
14177 && CHARPOS (startp
) > BEGV
14178 && CHARPOS (startp
) > BEG
+ beg_unchanged
14179 && CHARPOS (startp
) <= Z
- end_unchanged
14180 /* Even if w->start_at_line_beg is nil, a new window may
14181 start at a line_beg, since that's how set_buffer_window
14182 sets it. So, we need to check the return value of
14183 compute_window_start_on_continuation_line. (See also
14185 && XMARKER (w
->start
)->buffer
== current_buffer
14186 && compute_window_start_on_continuation_line (w
))
14188 w
->force_start
= Qt
;
14189 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14194 debug_method_add (w
, "same window start");
14197 /* Try to redisplay starting at same place as before.
14198 If point has not moved off frame, accept the results. */
14199 if (!current_matrix_up_to_date_p
14200 /* Don't use try_window_reusing_current_matrix in this case
14201 because a window scroll function can have changed the
14203 || !NILP (Vwindow_scroll_functions
)
14204 || MINI_WINDOW_P (w
)
14205 || !(used_current_matrix_p
14206 = try_window_reusing_current_matrix (w
)))
14208 IF_DEBUG (debug_method_add (w
, "1"));
14209 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
14210 /* -1 means we need to scroll.
14211 0 means we need new matrices, but fonts_changed_p
14212 is set in that case, so we will detect it below. */
14213 goto try_to_scroll
;
14216 if (fonts_changed_p
)
14217 goto need_larger_matrices
;
14219 if (w
->cursor
.vpos
>= 0)
14221 if (!just_this_one_p
14222 || current_buffer
->clip_changed
14223 || BEG_UNCHANGED
< CHARPOS (startp
))
14224 /* Forget any recorded base line for line number display. */
14225 w
->base_line_number
= Qnil
;
14227 if (!cursor_row_fully_visible_p (w
, 1, 0))
14229 clear_glyph_matrix (w
->desired_matrix
);
14230 last_line_misfit
= 1;
14232 /* Drop through and scroll. */
14237 clear_glyph_matrix (w
->desired_matrix
);
14242 w
->last_modified
= make_number (0);
14243 w
->last_overlay_modified
= make_number (0);
14245 /* Redisplay the mode line. Select the buffer properly for that. */
14246 if (!update_mode_line
)
14248 update_mode_line
= 1;
14249 w
->update_mode_line
= Qt
;
14252 /* Try to scroll by specified few lines. */
14253 if ((scroll_conservatively
14255 || temp_scroll_step
14256 || NUMBERP (current_buffer
->scroll_up_aggressively
)
14257 || NUMBERP (current_buffer
->scroll_down_aggressively
))
14258 && !current_buffer
->clip_changed
14259 && CHARPOS (startp
) >= BEGV
14260 && CHARPOS (startp
) <= ZV
)
14262 /* The function returns -1 if new fonts were loaded, 1 if
14263 successful, 0 if not successful. */
14264 int rc
= try_scrolling (window
, just_this_one_p
,
14265 scroll_conservatively
,
14267 temp_scroll_step
, last_line_misfit
);
14270 case SCROLLING_SUCCESS
:
14273 case SCROLLING_NEED_LARGER_MATRICES
:
14274 goto need_larger_matrices
;
14276 case SCROLLING_FAILED
:
14284 /* Finally, just choose place to start which centers point */
14287 if (centering_position
< 0)
14288 centering_position
= window_box_height (w
) / 2;
14291 debug_method_add (w
, "recenter");
14294 /* w->vscroll = 0; */
14296 /* Forget any previously recorded base line for line number display. */
14297 if (!buffer_unchanged_p
)
14298 w
->base_line_number
= Qnil
;
14300 /* Move backward half the height of the window. */
14301 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14302 it
.current_y
= it
.last_visible_y
;
14303 move_it_vertically_backward (&it
, centering_position
);
14304 xassert (IT_CHARPOS (it
) >= BEGV
);
14306 /* The function move_it_vertically_backward may move over more
14307 than the specified y-distance. If it->w is small, e.g. a
14308 mini-buffer window, we may end up in front of the window's
14309 display area. Start displaying at the start of the line
14310 containing PT in this case. */
14311 if (it
.current_y
<= 0)
14313 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
14314 move_it_vertically_backward (&it
, 0);
14318 it
.current_x
= it
.hpos
= 0;
14320 /* Set startp here explicitly in case that helps avoid an infinite loop
14321 in case the window-scroll-functions functions get errors. */
14322 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
14324 /* Run scroll hooks. */
14325 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
14327 /* Redisplay the window. */
14328 if (!current_matrix_up_to_date_p
14329 || windows_or_buffers_changed
14330 || cursor_type_changed
14331 /* Don't use try_window_reusing_current_matrix in this case
14332 because it can have changed the buffer. */
14333 || !NILP (Vwindow_scroll_functions
)
14334 || !just_this_one_p
14335 || MINI_WINDOW_P (w
)
14336 || !(used_current_matrix_p
14337 = try_window_reusing_current_matrix (w
)))
14338 try_window (window
, startp
, 0);
14340 /* If new fonts have been loaded (due to fontsets), give up. We
14341 have to start a new redisplay since we need to re-adjust glyph
14343 if (fonts_changed_p
)
14344 goto need_larger_matrices
;
14346 /* If cursor did not appear assume that the middle of the window is
14347 in the first line of the window. Do it again with the next line.
14348 (Imagine a window of height 100, displaying two lines of height
14349 60. Moving back 50 from it->last_visible_y will end in the first
14351 if (w
->cursor
.vpos
< 0)
14353 if (!NILP (w
->window_end_valid
)
14354 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
14356 clear_glyph_matrix (w
->desired_matrix
);
14357 move_it_by_lines (&it
, 1, 0);
14358 try_window (window
, it
.current
.pos
, 0);
14360 else if (PT
< IT_CHARPOS (it
))
14362 clear_glyph_matrix (w
->desired_matrix
);
14363 move_it_by_lines (&it
, -1, 0);
14364 try_window (window
, it
.current
.pos
, 0);
14368 /* Not much we can do about it. */
14372 /* Consider the following case: Window starts at BEGV, there is
14373 invisible, intangible text at BEGV, so that display starts at
14374 some point START > BEGV. It can happen that we are called with
14375 PT somewhere between BEGV and START. Try to handle that case. */
14376 if (w
->cursor
.vpos
< 0)
14378 struct glyph_row
*row
= w
->current_matrix
->rows
;
14379 if (row
->mode_line_p
)
14381 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14384 if (!cursor_row_fully_visible_p (w
, 0, 0))
14386 /* If vscroll is enabled, disable it and try again. */
14390 clear_glyph_matrix (w
->desired_matrix
);
14394 /* If centering point failed to make the whole line visible,
14395 put point at the top instead. That has to make the whole line
14396 visible, if it can be done. */
14397 if (centering_position
== 0)
14400 clear_glyph_matrix (w
->desired_matrix
);
14401 centering_position
= 0;
14407 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14408 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
14409 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
14412 /* Display the mode line, if we must. */
14413 if ((update_mode_line
14414 /* If window not full width, must redo its mode line
14415 if (a) the window to its side is being redone and
14416 (b) we do a frame-based redisplay. This is a consequence
14417 of how inverted lines are drawn in frame-based redisplay. */
14418 || (!just_this_one_p
14419 && !FRAME_WINDOW_P (f
)
14420 && !WINDOW_FULL_WIDTH_P (w
))
14421 /* Line number to display. */
14422 || INTEGERP (w
->base_line_pos
)
14423 /* Column number is displayed and different from the one displayed. */
14424 || (!NILP (w
->column_number_displayed
)
14425 && (XFASTINT (w
->column_number_displayed
)
14426 != (int) current_column ()))) /* iftc */
14427 /* This means that the window has a mode line. */
14428 && (WINDOW_WANTS_MODELINE_P (w
)
14429 || WINDOW_WANTS_HEADER_LINE_P (w
)))
14431 display_mode_lines (w
);
14433 /* If mode line height has changed, arrange for a thorough
14434 immediate redisplay using the correct mode line height. */
14435 if (WINDOW_WANTS_MODELINE_P (w
)
14436 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
14438 fonts_changed_p
= 1;
14439 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
14440 = DESIRED_MODE_LINE_HEIGHT (w
);
14443 /* If header line height has changed, arrange for a thorough
14444 immediate redisplay using the correct header line height. */
14445 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14446 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
14448 fonts_changed_p
= 1;
14449 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
14450 = DESIRED_HEADER_LINE_HEIGHT (w
);
14453 if (fonts_changed_p
)
14454 goto need_larger_matrices
;
14457 if (!line_number_displayed
14458 && !BUFFERP (w
->base_line_pos
))
14460 w
->base_line_pos
= Qnil
;
14461 w
->base_line_number
= Qnil
;
14466 /* When we reach a frame's selected window, redo the frame's menu bar. */
14467 if (update_mode_line
14468 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
14470 int redisplay_menu_p
= 0;
14471 int redisplay_tool_bar_p
= 0;
14473 if (FRAME_WINDOW_P (f
))
14475 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
14476 || defined (HAVE_NS) || defined (USE_GTK)
14477 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
14479 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14483 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
14485 if (redisplay_menu_p
)
14486 display_menu_bar (w
);
14488 #ifdef HAVE_WINDOW_SYSTEM
14489 if (FRAME_WINDOW_P (f
))
14491 #if defined (USE_GTK) || defined (HAVE_NS)
14492 redisplay_tool_bar_p
= FRAME_EXTERNAL_TOOL_BAR (f
);
14494 redisplay_tool_bar_p
= WINDOWP (f
->tool_bar_window
)
14495 && (FRAME_TOOL_BAR_LINES (f
) > 0
14496 || !NILP (Vauto_resize_tool_bars
));
14499 if (redisplay_tool_bar_p
&& redisplay_tool_bar (f
))
14501 extern int ignore_mouse_drag_p
;
14502 ignore_mouse_drag_p
= 1;
14508 #ifdef HAVE_WINDOW_SYSTEM
14509 if (FRAME_WINDOW_P (f
)
14510 && update_window_fringes (w
, (just_this_one_p
14511 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
14512 || w
->pseudo_window_p
)))
14516 if (draw_window_fringes (w
, 1))
14517 x_draw_vertical_border (w
);
14521 #endif /* HAVE_WINDOW_SYSTEM */
14523 /* We go to this label, with fonts_changed_p nonzero,
14524 if it is necessary to try again using larger glyph matrices.
14525 We have to redeem the scroll bar even in this case,
14526 because the loop in redisplay_internal expects that. */
14527 need_larger_matrices
:
14529 finish_scroll_bars
:
14531 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
14533 /* Set the thumb's position and size. */
14534 set_vertical_scroll_bar (w
);
14536 /* Note that we actually used the scroll bar attached to this
14537 window, so it shouldn't be deleted at the end of redisplay. */
14538 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
14539 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
14542 /* Restore current_buffer and value of point in it. The window
14543 update may have changed the buffer, so first make sure `opoint'
14544 is still valid (Bug#6177). */
14545 if (CHARPOS (opoint
) < BEGV
)
14546 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
14547 else if (CHARPOS (opoint
) > ZV
)
14548 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
14550 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
14552 set_buffer_internal_1 (old
);
14553 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
14554 shorter. This can be caused by log truncation in *Messages*. */
14555 if (CHARPOS (lpoint
) <= ZV
)
14556 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
14558 unbind_to (count
, Qnil
);
14562 /* Build the complete desired matrix of WINDOW with a window start
14563 buffer position POS.
14565 Value is 1 if successful. It is zero if fonts were loaded during
14566 redisplay which makes re-adjusting glyph matrices necessary, and -1
14567 if point would appear in the scroll margins.
14568 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
14569 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
14573 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
14575 struct window
*w
= XWINDOW (window
);
14577 struct glyph_row
*last_text_row
= NULL
;
14578 struct frame
*f
= XFRAME (w
->frame
);
14580 /* Make POS the new window start. */
14581 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
14583 /* Mark cursor position as unknown. No overlay arrow seen. */
14584 w
->cursor
.vpos
= -1;
14585 overlay_arrow_seen
= 0;
14587 /* Initialize iterator and info to start at POS. */
14588 start_display (&it
, w
, pos
);
14590 /* Display all lines of W. */
14591 while (it
.current_y
< it
.last_visible_y
)
14593 if (display_line (&it
))
14594 last_text_row
= it
.glyph_row
- 1;
14595 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
14599 /* Don't let the cursor end in the scroll margins. */
14600 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
14601 && !MINI_WINDOW_P (w
))
14603 int this_scroll_margin
;
14605 if (scroll_margin
> 0)
14607 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14608 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14611 this_scroll_margin
= 0;
14613 if ((w
->cursor
.y
>= 0 /* not vscrolled */
14614 && w
->cursor
.y
< this_scroll_margin
14615 && CHARPOS (pos
) > BEGV
14616 && IT_CHARPOS (it
) < ZV
)
14617 /* rms: considering make_cursor_line_fully_visible_p here
14618 seems to give wrong results. We don't want to recenter
14619 when the last line is partly visible, we want to allow
14620 that case to be handled in the usual way. */
14621 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
14623 w
->cursor
.vpos
= -1;
14624 clear_glyph_matrix (w
->desired_matrix
);
14629 /* If bottom moved off end of frame, change mode line percentage. */
14630 if (XFASTINT (w
->window_end_pos
) <= 0
14631 && Z
!= IT_CHARPOS (it
))
14632 w
->update_mode_line
= Qt
;
14634 /* Set window_end_pos to the offset of the last character displayed
14635 on the window from the end of current_buffer. Set
14636 window_end_vpos to its row number. */
14639 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
14640 w
->window_end_bytepos
14641 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14643 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14645 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14646 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
14647 ->displays_text_p
);
14651 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14652 w
->window_end_pos
= make_number (Z
- ZV
);
14653 w
->window_end_vpos
= make_number (0);
14656 /* But that is not valid info until redisplay finishes. */
14657 w
->window_end_valid
= Qnil
;
14663 /************************************************************************
14664 Window redisplay reusing current matrix when buffer has not changed
14665 ************************************************************************/
14667 /* Try redisplay of window W showing an unchanged buffer with a
14668 different window start than the last time it was displayed by
14669 reusing its current matrix. Value is non-zero if successful.
14670 W->start is the new window start. */
14673 try_window_reusing_current_matrix (struct window
*w
)
14675 struct frame
*f
= XFRAME (w
->frame
);
14676 struct glyph_row
*row
, *bottom_row
;
14679 struct text_pos start
, new_start
;
14680 int nrows_scrolled
, i
;
14681 struct glyph_row
*last_text_row
;
14682 struct glyph_row
*last_reused_text_row
;
14683 struct glyph_row
*start_row
;
14684 int start_vpos
, min_y
, max_y
;
14687 if (inhibit_try_window_reusing
)
14691 if (/* This function doesn't handle terminal frames. */
14692 !FRAME_WINDOW_P (f
)
14693 /* Don't try to reuse the display if windows have been split
14695 || windows_or_buffers_changed
14696 || cursor_type_changed
)
14699 /* Can't do this if region may have changed. */
14700 if ((!NILP (Vtransient_mark_mode
)
14701 && !NILP (current_buffer
->mark_active
))
14702 || !NILP (w
->region_showing
)
14703 || !NILP (Vshow_trailing_whitespace
))
14706 /* If top-line visibility has changed, give up. */
14707 if (WINDOW_WANTS_HEADER_LINE_P (w
)
14708 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
14711 /* Give up if old or new display is scrolled vertically. We could
14712 make this function handle this, but right now it doesn't. */
14713 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14714 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
14717 /* The variable new_start now holds the new window start. The old
14718 start `start' can be determined from the current matrix. */
14719 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
14720 start
= start_row
->minpos
;
14721 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14723 /* Clear the desired matrix for the display below. */
14724 clear_glyph_matrix (w
->desired_matrix
);
14726 if (CHARPOS (new_start
) <= CHARPOS (start
))
14730 /* Don't use this method if the display starts with an ellipsis
14731 displayed for invisible text. It's not easy to handle that case
14732 below, and it's certainly not worth the effort since this is
14733 not a frequent case. */
14734 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
14737 IF_DEBUG (debug_method_add (w
, "twu1"));
14739 /* Display up to a row that can be reused. The variable
14740 last_text_row is set to the last row displayed that displays
14741 text. Note that it.vpos == 0 if or if not there is a
14742 header-line; it's not the same as the MATRIX_ROW_VPOS! */
14743 start_display (&it
, w
, new_start
);
14744 first_row_y
= it
.current_y
;
14745 w
->cursor
.vpos
= -1;
14746 last_text_row
= last_reused_text_row
= NULL
;
14748 while (it
.current_y
< it
.last_visible_y
14749 && !fonts_changed_p
)
14751 /* If we have reached into the characters in the START row,
14752 that means the line boundaries have changed. So we
14753 can't start copying with the row START. Maybe it will
14754 work to start copying with the following row. */
14755 while (IT_CHARPOS (it
) > CHARPOS (start
))
14757 /* Advance to the next row as the "start". */
14759 start
= start_row
->minpos
;
14760 /* If there are no more rows to try, or just one, give up. */
14761 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
14762 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
14763 || CHARPOS (start
) == ZV
)
14765 clear_glyph_matrix (w
->desired_matrix
);
14769 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
14771 /* If we have reached alignment,
14772 we can copy the rest of the rows. */
14773 if (IT_CHARPOS (it
) == CHARPOS (start
))
14776 if (display_line (&it
))
14777 last_text_row
= it
.glyph_row
- 1;
14780 /* A value of current_y < last_visible_y means that we stopped
14781 at the previous window start, which in turn means that we
14782 have at least one reusable row. */
14783 if (it
.current_y
< it
.last_visible_y
)
14785 /* IT.vpos always starts from 0; it counts text lines. */
14786 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
14788 /* Find PT if not already found in the lines displayed. */
14789 if (w
->cursor
.vpos
< 0)
14791 int dy
= it
.current_y
- start_row
->y
;
14793 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14794 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
14796 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
14797 dy
, nrows_scrolled
);
14800 clear_glyph_matrix (w
->desired_matrix
);
14805 /* Scroll the display. Do it before the current matrix is
14806 changed. The problem here is that update has not yet
14807 run, i.e. part of the current matrix is not up to date.
14808 scroll_run_hook will clear the cursor, and use the
14809 current matrix to get the height of the row the cursor is
14811 run
.current_y
= start_row
->y
;
14812 run
.desired_y
= it
.current_y
;
14813 run
.height
= it
.last_visible_y
- it
.current_y
;
14815 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
14818 FRAME_RIF (f
)->update_window_begin_hook (w
);
14819 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14820 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14821 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
14825 /* Shift current matrix down by nrows_scrolled lines. */
14826 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
14827 rotate_matrix (w
->current_matrix
,
14829 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
14832 /* Disable lines that must be updated. */
14833 for (i
= 0; i
< nrows_scrolled
; ++i
)
14834 (start_row
+ i
)->enabled_p
= 0;
14836 /* Re-compute Y positions. */
14837 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14838 max_y
= it
.last_visible_y
;
14839 for (row
= start_row
+ nrows_scrolled
;
14843 row
->y
= it
.current_y
;
14844 row
->visible_height
= row
->height
;
14846 if (row
->y
< min_y
)
14847 row
->visible_height
-= min_y
- row
->y
;
14848 if (row
->y
+ row
->height
> max_y
)
14849 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
14850 row
->redraw_fringe_bitmaps_p
= 1;
14852 it
.current_y
+= row
->height
;
14854 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14855 last_reused_text_row
= row
;
14856 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
14860 /* Disable lines in the current matrix which are now
14861 below the window. */
14862 for (++row
; row
< bottom_row
; ++row
)
14863 row
->enabled_p
= row
->mode_line_p
= 0;
14866 /* Update window_end_pos etc.; last_reused_text_row is the last
14867 reused row from the current matrix containing text, if any.
14868 The value of last_text_row is the last displayed line
14869 containing text. */
14870 if (last_reused_text_row
)
14872 w
->window_end_bytepos
14873 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
14875 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
14877 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
14878 w
->current_matrix
));
14880 else if (last_text_row
)
14882 w
->window_end_bytepos
14883 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
14885 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
14887 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
14891 /* This window must be completely empty. */
14892 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
14893 w
->window_end_pos
= make_number (Z
- ZV
);
14894 w
->window_end_vpos
= make_number (0);
14896 w
->window_end_valid
= Qnil
;
14898 /* Update hint: don't try scrolling again in update_window. */
14899 w
->desired_matrix
->no_scrolling_p
= 1;
14902 debug_method_add (w
, "try_window_reusing_current_matrix 1");
14906 else if (CHARPOS (new_start
) > CHARPOS (start
))
14908 struct glyph_row
*pt_row
, *row
;
14909 struct glyph_row
*first_reusable_row
;
14910 struct glyph_row
*first_row_to_display
;
14912 int yb
= window_text_bottom_y (w
);
14914 /* Find the row starting at new_start, if there is one. Don't
14915 reuse a partially visible line at the end. */
14916 first_reusable_row
= start_row
;
14917 while (first_reusable_row
->enabled_p
14918 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
14919 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14920 < CHARPOS (new_start
)))
14921 ++first_reusable_row
;
14923 /* Give up if there is no row to reuse. */
14924 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
14925 || !first_reusable_row
->enabled_p
14926 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
14927 != CHARPOS (new_start
)))
14930 /* We can reuse fully visible rows beginning with
14931 first_reusable_row to the end of the window. Set
14932 first_row_to_display to the first row that cannot be reused.
14933 Set pt_row to the row containing point, if there is any. */
14935 for (first_row_to_display
= first_reusable_row
;
14936 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
14937 ++first_row_to_display
)
14939 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
14940 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
14941 pt_row
= first_row_to_display
;
14944 /* Start displaying at the start of first_row_to_display. */
14945 xassert (first_row_to_display
->y
< yb
);
14946 init_to_row_start (&it
, w
, first_row_to_display
);
14948 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
14950 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
14952 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
14953 + WINDOW_HEADER_LINE_HEIGHT (w
));
14955 /* Display lines beginning with first_row_to_display in the
14956 desired matrix. Set last_text_row to the last row displayed
14957 that displays text. */
14958 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
14959 if (pt_row
== NULL
)
14960 w
->cursor
.vpos
= -1;
14961 last_text_row
= NULL
;
14962 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
14963 if (display_line (&it
))
14964 last_text_row
= it
.glyph_row
- 1;
14966 /* If point is in a reused row, adjust y and vpos of the cursor
14970 w
->cursor
.vpos
-= nrows_scrolled
;
14971 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
14974 /* Give up if point isn't in a row displayed or reused. (This
14975 also handles the case where w->cursor.vpos < nrows_scrolled
14976 after the calls to display_line, which can happen with scroll
14977 margins. See bug#1295.) */
14978 if (w
->cursor
.vpos
< 0)
14980 clear_glyph_matrix (w
->desired_matrix
);
14984 /* Scroll the display. */
14985 run
.current_y
= first_reusable_row
->y
;
14986 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
14987 run
.height
= it
.last_visible_y
- run
.current_y
;
14988 dy
= run
.current_y
- run
.desired_y
;
14993 FRAME_RIF (f
)->update_window_begin_hook (w
);
14994 FRAME_RIF (f
)->clear_window_mouse_face (w
);
14995 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
14996 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15000 /* Adjust Y positions of reused rows. */
15001 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15002 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15003 max_y
= it
.last_visible_y
;
15004 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15007 row
->visible_height
= row
->height
;
15008 if (row
->y
< min_y
)
15009 row
->visible_height
-= min_y
- row
->y
;
15010 if (row
->y
+ row
->height
> max_y
)
15011 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15012 row
->redraw_fringe_bitmaps_p
= 1;
15015 /* Scroll the current matrix. */
15016 xassert (nrows_scrolled
> 0);
15017 rotate_matrix (w
->current_matrix
,
15019 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15022 /* Disable rows not reused. */
15023 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15024 row
->enabled_p
= 0;
15026 /* Point may have moved to a different line, so we cannot assume that
15027 the previous cursor position is valid; locate the correct row. */
15030 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15031 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15035 w
->cursor
.y
= row
->y
;
15037 if (row
< bottom_row
)
15039 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15040 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15042 /* Can't use this optimization with bidi-reordered glyph
15043 rows, unless cursor is already at point. */
15044 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15046 if (!(w
->cursor
.hpos
>= 0
15047 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15048 && BUFFERP (glyph
->object
)
15049 && glyph
->charpos
== PT
))
15054 && (!BUFFERP (glyph
->object
)
15055 || glyph
->charpos
< PT
);
15059 w
->cursor
.x
+= glyph
->pixel_width
;
15064 /* Adjust window end. A null value of last_text_row means that
15065 the window end is in reused rows which in turn means that
15066 only its vpos can have changed. */
15069 w
->window_end_bytepos
15070 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15072 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15074 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15079 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
15082 w
->window_end_valid
= Qnil
;
15083 w
->desired_matrix
->no_scrolling_p
= 1;
15086 debug_method_add (w
, "try_window_reusing_current_matrix 2");
15096 /************************************************************************
15097 Window redisplay reusing current matrix when buffer has changed
15098 ************************************************************************/
15100 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
15101 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
15103 static struct glyph_row
*
15104 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
15105 struct glyph_row
*);
15108 /* Return the last row in MATRIX displaying text. If row START is
15109 non-null, start searching with that row. IT gives the dimensions
15110 of the display. Value is null if matrix is empty; otherwise it is
15111 a pointer to the row found. */
15113 static struct glyph_row
*
15114 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
15115 struct glyph_row
*start
)
15117 struct glyph_row
*row
, *row_found
;
15119 /* Set row_found to the last row in IT->w's current matrix
15120 displaying text. The loop looks funny but think of partially
15123 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
15124 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15126 xassert (row
->enabled_p
);
15128 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
15137 /* Return the last row in the current matrix of W that is not affected
15138 by changes at the start of current_buffer that occurred since W's
15139 current matrix was built. Value is null if no such row exists.
15141 BEG_UNCHANGED us the number of characters unchanged at the start of
15142 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
15143 first changed character in current_buffer. Characters at positions <
15144 BEG + BEG_UNCHANGED are at the same buffer positions as they were
15145 when the current matrix was built. */
15147 static struct glyph_row
*
15148 find_last_unchanged_at_beg_row (struct window
*w
)
15150 int first_changed_pos
= BEG
+ BEG_UNCHANGED
;
15151 struct glyph_row
*row
;
15152 struct glyph_row
*row_found
= NULL
;
15153 int yb
= window_text_bottom_y (w
);
15155 /* Find the last row displaying unchanged text. */
15156 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15157 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15158 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
15161 if (/* If row ends before first_changed_pos, it is unchanged,
15162 except in some case. */
15163 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
15164 /* When row ends in ZV and we write at ZV it is not
15166 && !row
->ends_at_zv_p
15167 /* When first_changed_pos is the end of a continued line,
15168 row is not unchanged because it may be no longer
15170 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
15171 && (row
->continued_p
15172 || row
->exact_window_width_line_p
)))
15175 /* Stop if last visible row. */
15176 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
15184 /* Find the first glyph row in the current matrix of W that is not
15185 affected by changes at the end of current_buffer since the
15186 time W's current matrix was built.
15188 Return in *DELTA the number of chars by which buffer positions in
15189 unchanged text at the end of current_buffer must be adjusted.
15191 Return in *DELTA_BYTES the corresponding number of bytes.
15193 Value is null if no such row exists, i.e. all rows are affected by
15196 static struct glyph_row
*
15197 find_first_unchanged_at_end_row (struct window
*w
, int *delta
, int *delta_bytes
)
15199 struct glyph_row
*row
;
15200 struct glyph_row
*row_found
= NULL
;
15202 *delta
= *delta_bytes
= 0;
15204 /* Display must not have been paused, otherwise the current matrix
15205 is not up to date. */
15206 eassert (!NILP (w
->window_end_valid
));
15208 /* A value of window_end_pos >= END_UNCHANGED means that the window
15209 end is in the range of changed text. If so, there is no
15210 unchanged row at the end of W's current matrix. */
15211 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
15214 /* Set row to the last row in W's current matrix displaying text. */
15215 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15217 /* If matrix is entirely empty, no unchanged row exists. */
15218 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15220 /* The value of row is the last glyph row in the matrix having a
15221 meaningful buffer position in it. The end position of row
15222 corresponds to window_end_pos. This allows us to translate
15223 buffer positions in the current matrix to current buffer
15224 positions for characters not in changed text. */
15225 int Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15226 int Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15227 int last_unchanged_pos
, last_unchanged_pos_old
;
15228 struct glyph_row
*first_text_row
15229 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15231 *delta
= Z
- Z_old
;
15232 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15234 /* Set last_unchanged_pos to the buffer position of the last
15235 character in the buffer that has not been changed. Z is the
15236 index + 1 of the last character in current_buffer, i.e. by
15237 subtracting END_UNCHANGED we get the index of the last
15238 unchanged character, and we have to add BEG to get its buffer
15240 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
15241 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
15243 /* Search backward from ROW for a row displaying a line that
15244 starts at a minimum position >= last_unchanged_pos_old. */
15245 for (; row
> first_text_row
; --row
)
15247 /* This used to abort, but it can happen.
15248 It is ok to just stop the search instead here. KFS. */
15249 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15252 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
15257 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
15263 /* Make sure that glyph rows in the current matrix of window W
15264 reference the same glyph memory as corresponding rows in the
15265 frame's frame matrix. This function is called after scrolling W's
15266 current matrix on a terminal frame in try_window_id and
15267 try_window_reusing_current_matrix. */
15270 sync_frame_with_window_matrix_rows (struct window
*w
)
15272 struct frame
*f
= XFRAME (w
->frame
);
15273 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
15275 /* Preconditions: W must be a leaf window and full-width. Its frame
15276 must have a frame matrix. */
15277 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
15278 xassert (WINDOW_FULL_WIDTH_P (w
));
15279 xassert (!FRAME_WINDOW_P (f
));
15281 /* If W is a full-width window, glyph pointers in W's current matrix
15282 have, by definition, to be the same as glyph pointers in the
15283 corresponding frame matrix. Note that frame matrices have no
15284 marginal areas (see build_frame_matrix). */
15285 window_row
= w
->current_matrix
->rows
;
15286 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
15287 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
15288 while (window_row
< window_row_end
)
15290 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
15291 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
15293 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
15294 frame_row
->glyphs
[TEXT_AREA
] = start
;
15295 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
15296 frame_row
->glyphs
[LAST_AREA
] = end
;
15298 /* Disable frame rows whose corresponding window rows have
15299 been disabled in try_window_id. */
15300 if (!window_row
->enabled_p
)
15301 frame_row
->enabled_p
= 0;
15303 ++window_row
, ++frame_row
;
15308 /* Find the glyph row in window W containing CHARPOS. Consider all
15309 rows between START and END (not inclusive). END null means search
15310 all rows to the end of the display area of W. Value is the row
15311 containing CHARPOS or null. */
15314 row_containing_pos (struct window
*w
, int charpos
, struct glyph_row
*start
,
15315 struct glyph_row
*end
, int dy
)
15317 struct glyph_row
*row
= start
;
15318 struct glyph_row
*best_row
= NULL
;
15319 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
15322 /* If we happen to start on a header-line, skip that. */
15323 if (row
->mode_line_p
)
15326 if ((end
&& row
>= end
) || !row
->enabled_p
)
15329 last_y
= window_text_bottom_y (w
) - dy
;
15333 /* Give up if we have gone too far. */
15334 if (end
&& row
>= end
)
15336 /* This formerly returned if they were equal.
15337 I think that both quantities are of a "last plus one" type;
15338 if so, when they are equal, the row is within the screen. -- rms. */
15339 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
15342 /* If it is in this row, return this row. */
15343 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
15344 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
15345 /* The end position of a row equals the start
15346 position of the next row. If CHARPOS is there, we
15347 would rather display it in the next line, except
15348 when this line ends in ZV. */
15349 && !row
->ends_at_zv_p
15350 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15351 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
15355 if (NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
))
15357 /* In bidi-reordered rows, there could be several rows
15358 occluding point. We need to find the one which fits
15359 CHARPOS the best. */
15360 for (g
= row
->glyphs
[TEXT_AREA
];
15361 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
15364 if (!STRINGP (g
->object
))
15366 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
15368 mindif
= eabs (g
->charpos
- charpos
);
15381 /* Try to redisplay window W by reusing its existing display. W's
15382 current matrix must be up to date when this function is called,
15383 i.e. window_end_valid must not be nil.
15387 1 if display has been updated
15388 0 if otherwise unsuccessful
15389 -1 if redisplay with same window start is known not to succeed
15391 The following steps are performed:
15393 1. Find the last row in the current matrix of W that is not
15394 affected by changes at the start of current_buffer. If no such row
15397 2. Find the first row in W's current matrix that is not affected by
15398 changes at the end of current_buffer. Maybe there is no such row.
15400 3. Display lines beginning with the row + 1 found in step 1 to the
15401 row found in step 2 or, if step 2 didn't find a row, to the end of
15404 4. If cursor is not known to appear on the window, give up.
15406 5. If display stopped at the row found in step 2, scroll the
15407 display and current matrix as needed.
15409 6. Maybe display some lines at the end of W, if we must. This can
15410 happen under various circumstances, like a partially visible line
15411 becoming fully visible, or because newly displayed lines are displayed
15412 in smaller font sizes.
15414 7. Update W's window end information. */
15417 try_window_id (struct window
*w
)
15419 struct frame
*f
= XFRAME (w
->frame
);
15420 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
15421 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
15422 struct glyph_row
*last_unchanged_at_beg_row
;
15423 struct glyph_row
*first_unchanged_at_end_row
;
15424 struct glyph_row
*row
;
15425 struct glyph_row
*bottom_row
;
15428 int delta
= 0, delta_bytes
= 0, stop_pos
, dvpos
, dy
;
15429 struct text_pos start_pos
;
15431 int first_unchanged_at_end_vpos
= 0;
15432 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
15433 struct text_pos start
;
15434 int first_changed_charpos
, last_changed_charpos
;
15437 if (inhibit_try_window_id
)
15441 /* This is handy for debugging. */
15443 #define GIVE_UP(X) \
15445 fprintf (stderr, "try_window_id give up %d\n", (X)); \
15449 #define GIVE_UP(X) return 0
15452 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
15454 /* Don't use this for mini-windows because these can show
15455 messages and mini-buffers, and we don't handle that here. */
15456 if (MINI_WINDOW_P (w
))
15459 /* This flag is used to prevent redisplay optimizations. */
15460 if (windows_or_buffers_changed
|| cursor_type_changed
)
15463 /* Verify that narrowing has not changed.
15464 Also verify that we were not told to prevent redisplay optimizations.
15465 It would be nice to further
15466 reduce the number of cases where this prevents try_window_id. */
15467 if (current_buffer
->clip_changed
15468 || current_buffer
->prevent_redisplay_optimizations_p
)
15471 /* Window must either use window-based redisplay or be full width. */
15472 if (!FRAME_WINDOW_P (f
)
15473 && (!FRAME_LINE_INS_DEL_OK (f
)
15474 || !WINDOW_FULL_WIDTH_P (w
)))
15477 /* Give up if point is known NOT to appear in W. */
15478 if (PT
< CHARPOS (start
))
15481 /* Another way to prevent redisplay optimizations. */
15482 if (XFASTINT (w
->last_modified
) == 0)
15485 /* Verify that window is not hscrolled. */
15486 if (XFASTINT (w
->hscroll
) != 0)
15489 /* Verify that display wasn't paused. */
15490 if (NILP (w
->window_end_valid
))
15493 /* Can't use this if highlighting a region because a cursor movement
15494 will do more than just set the cursor. */
15495 if (!NILP (Vtransient_mark_mode
)
15496 && !NILP (current_buffer
->mark_active
))
15499 /* Likewise if highlighting trailing whitespace. */
15500 if (!NILP (Vshow_trailing_whitespace
))
15503 /* Likewise if showing a region. */
15504 if (!NILP (w
->region_showing
))
15507 /* Can't use this if overlay arrow position and/or string have
15509 if (overlay_arrows_changed_p ())
15512 /* When word-wrap is on, adding a space to the first word of a
15513 wrapped line can change the wrap position, altering the line
15514 above it. It might be worthwhile to handle this more
15515 intelligently, but for now just redisplay from scratch. */
15516 if (!NILP (XBUFFER (w
->buffer
)->word_wrap
))
15519 /* Under bidi reordering, adding or deleting a character in the
15520 beginning of a paragraph, before the first strong directional
15521 character, can change the base direction of the paragraph (unless
15522 the buffer specifies a fixed paragraph direction), which will
15523 require to redisplay the whole paragraph. It might be worthwhile
15524 to find the paragraph limits and widen the range of redisplayed
15525 lines to that, but for now just give up this optimization and
15526 redisplay from scratch. */
15527 if (!NILP (XBUFFER (w
->buffer
)->bidi_display_reordering
)
15528 && NILP (XBUFFER (w
->buffer
)->bidi_paragraph_direction
))
15531 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
15532 only if buffer has really changed. The reason is that the gap is
15533 initially at Z for freshly visited files. The code below would
15534 set end_unchanged to 0 in that case. */
15535 if (MODIFF
> SAVE_MODIFF
15536 /* This seems to happen sometimes after saving a buffer. */
15537 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
15539 if (GPT
- BEG
< BEG_UNCHANGED
)
15540 BEG_UNCHANGED
= GPT
- BEG
;
15541 if (Z
- GPT
< END_UNCHANGED
)
15542 END_UNCHANGED
= Z
- GPT
;
15545 /* The position of the first and last character that has been changed. */
15546 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
15547 last_changed_charpos
= Z
- END_UNCHANGED
;
15549 /* If window starts after a line end, and the last change is in
15550 front of that newline, then changes don't affect the display.
15551 This case happens with stealth-fontification. Note that although
15552 the display is unchanged, glyph positions in the matrix have to
15553 be adjusted, of course. */
15554 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
15555 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
15556 && ((last_changed_charpos
< CHARPOS (start
)
15557 && CHARPOS (start
) == BEGV
)
15558 || (last_changed_charpos
< CHARPOS (start
) - 1
15559 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
15561 int Z_old
, delta
, Z_BYTE_old
, delta_bytes
;
15562 struct glyph_row
*r0
;
15564 /* Compute how many chars/bytes have been added to or removed
15565 from the buffer. */
15566 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
15567 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
15569 delta_bytes
= Z_BYTE
- Z_BYTE_old
;
15571 /* Give up if PT is not in the window. Note that it already has
15572 been checked at the start of try_window_id that PT is not in
15573 front of the window start. */
15574 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + delta
)
15577 /* If window start is unchanged, we can reuse the whole matrix
15578 as is, after adjusting glyph positions. No need to compute
15579 the window end again, since its offset from Z hasn't changed. */
15580 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15581 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + delta
15582 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + delta_bytes
15583 /* PT must not be in a partially visible line. */
15584 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + delta
15585 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15587 /* Adjust positions in the glyph matrix. */
15588 if (delta
|| delta_bytes
)
15590 struct glyph_row
*r1
15591 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15592 increment_matrix_positions (w
->current_matrix
,
15593 MATRIX_ROW_VPOS (r0
, current_matrix
),
15594 MATRIX_ROW_VPOS (r1
, current_matrix
),
15595 delta
, delta_bytes
);
15598 /* Set the cursor. */
15599 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15601 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15608 /* Handle the case that changes are all below what is displayed in
15609 the window, and that PT is in the window. This shortcut cannot
15610 be taken if ZV is visible in the window, and text has been added
15611 there that is visible in the window. */
15612 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
15613 /* ZV is not visible in the window, or there are no
15614 changes at ZV, actually. */
15615 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
15616 || first_changed_charpos
== last_changed_charpos
))
15618 struct glyph_row
*r0
;
15620 /* Give up if PT is not in the window. Note that it already has
15621 been checked at the start of try_window_id that PT is not in
15622 front of the window start. */
15623 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
15626 /* If window start is unchanged, we can reuse the whole matrix
15627 as is, without changing glyph positions since no text has
15628 been added/removed in front of the window end. */
15629 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15630 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
15631 /* PT must not be in a partially visible line. */
15632 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
15633 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
15635 /* We have to compute the window end anew since text
15636 could have been added/removed after it. */
15638 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
15639 w
->window_end_bytepos
15640 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
15642 /* Set the cursor. */
15643 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
15645 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
15652 /* Give up if window start is in the changed area.
15654 The condition used to read
15656 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
15658 but why that was tested escapes me at the moment. */
15659 if (CHARPOS (start
) >= first_changed_charpos
15660 && CHARPOS (start
) <= last_changed_charpos
)
15663 /* Check that window start agrees with the start of the first glyph
15664 row in its current matrix. Check this after we know the window
15665 start is not in changed text, otherwise positions would not be
15667 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
15668 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
15671 /* Give up if the window ends in strings. Overlay strings
15672 at the end are difficult to handle, so don't try. */
15673 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
15674 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
15677 /* Compute the position at which we have to start displaying new
15678 lines. Some of the lines at the top of the window might be
15679 reusable because they are not displaying changed text. Find the
15680 last row in W's current matrix not affected by changes at the
15681 start of current_buffer. Value is null if changes start in the
15682 first line of window. */
15683 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
15684 if (last_unchanged_at_beg_row
)
15686 /* Avoid starting to display in the moddle of a character, a TAB
15687 for instance. This is easier than to set up the iterator
15688 exactly, and it's not a frequent case, so the additional
15689 effort wouldn't really pay off. */
15690 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
15691 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
15692 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
15693 --last_unchanged_at_beg_row
;
15695 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
15698 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
15700 start_pos
= it
.current
.pos
;
15702 /* Start displaying new lines in the desired matrix at the same
15703 vpos we would use in the current matrix, i.e. below
15704 last_unchanged_at_beg_row. */
15705 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
15707 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
15708 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
15710 xassert (it
.hpos
== 0 && it
.current_x
== 0);
15714 /* There are no reusable lines at the start of the window.
15715 Start displaying in the first text line. */
15716 start_display (&it
, w
, start
);
15717 it
.vpos
= it
.first_vpos
;
15718 start_pos
= it
.current
.pos
;
15721 /* Find the first row that is not affected by changes at the end of
15722 the buffer. Value will be null if there is no unchanged row, in
15723 which case we must redisplay to the end of the window. delta
15724 will be set to the value by which buffer positions beginning with
15725 first_unchanged_at_end_row have to be adjusted due to text
15727 first_unchanged_at_end_row
15728 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
15729 IF_DEBUG (debug_delta
= delta
);
15730 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
15732 /* Set stop_pos to the buffer position up to which we will have to
15733 display new lines. If first_unchanged_at_end_row != NULL, this
15734 is the buffer position of the start of the line displayed in that
15735 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
15736 that we don't stop at a buffer position. */
15738 if (first_unchanged_at_end_row
)
15740 xassert (last_unchanged_at_beg_row
== NULL
15741 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
15743 /* If this is a continuation line, move forward to the next one
15744 that isn't. Changes in lines above affect this line.
15745 Caution: this may move first_unchanged_at_end_row to a row
15746 not displaying text. */
15747 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
15748 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15749 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15750 < it
.last_visible_y
))
15751 ++first_unchanged_at_end_row
;
15753 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
15754 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
15755 >= it
.last_visible_y
))
15756 first_unchanged_at_end_row
= NULL
;
15759 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
15761 first_unchanged_at_end_vpos
15762 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
15763 xassert (stop_pos
>= Z
- END_UNCHANGED
);
15766 else if (last_unchanged_at_beg_row
== NULL
)
15772 /* Either there is no unchanged row at the end, or the one we have
15773 now displays text. This is a necessary condition for the window
15774 end pos calculation at the end of this function. */
15775 xassert (first_unchanged_at_end_row
== NULL
15776 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
15778 debug_last_unchanged_at_beg_vpos
15779 = (last_unchanged_at_beg_row
15780 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
15782 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
15784 #endif /* GLYPH_DEBUG != 0 */
15787 /* Display new lines. Set last_text_row to the last new line
15788 displayed which has text on it, i.e. might end up as being the
15789 line where the window_end_vpos is. */
15790 w
->cursor
.vpos
= -1;
15791 last_text_row
= NULL
;
15792 overlay_arrow_seen
= 0;
15793 while (it
.current_y
< it
.last_visible_y
15794 && !fonts_changed_p
15795 && (first_unchanged_at_end_row
== NULL
15796 || IT_CHARPOS (it
) < stop_pos
))
15798 if (display_line (&it
))
15799 last_text_row
= it
.glyph_row
- 1;
15802 if (fonts_changed_p
)
15806 /* Compute differences in buffer positions, y-positions etc. for
15807 lines reused at the bottom of the window. Compute what we can
15809 if (first_unchanged_at_end_row
15810 /* No lines reused because we displayed everything up to the
15811 bottom of the window. */
15812 && it
.current_y
< it
.last_visible_y
)
15815 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
15817 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
15818 run
.current_y
= first_unchanged_at_end_row
->y
;
15819 run
.desired_y
= run
.current_y
+ dy
;
15820 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
15824 delta
= delta_bytes
= dvpos
= dy
15825 = run
.current_y
= run
.desired_y
= run
.height
= 0;
15826 first_unchanged_at_end_row
= NULL
;
15828 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
15831 /* Find the cursor if not already found. We have to decide whether
15832 PT will appear on this window (it sometimes doesn't, but this is
15833 not a very frequent case.) This decision has to be made before
15834 the current matrix is altered. A value of cursor.vpos < 0 means
15835 that PT is either in one of the lines beginning at
15836 first_unchanged_at_end_row or below the window. Don't care for
15837 lines that might be displayed later at the window end; as
15838 mentioned, this is not a frequent case. */
15839 if (w
->cursor
.vpos
< 0)
15841 /* Cursor in unchanged rows at the top? */
15842 if (PT
< CHARPOS (start_pos
)
15843 && last_unchanged_at_beg_row
)
15845 row
= row_containing_pos (w
, PT
,
15846 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
15847 last_unchanged_at_beg_row
+ 1, 0);
15849 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15852 /* Start from first_unchanged_at_end_row looking for PT. */
15853 else if (first_unchanged_at_end_row
)
15855 row
= row_containing_pos (w
, PT
- delta
,
15856 first_unchanged_at_end_row
, NULL
, 0);
15858 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
15859 delta_bytes
, dy
, dvpos
);
15862 /* Give up if cursor was not found. */
15863 if (w
->cursor
.vpos
< 0)
15865 clear_glyph_matrix (w
->desired_matrix
);
15870 /* Don't let the cursor end in the scroll margins. */
15872 int this_scroll_margin
, cursor_height
;
15874 this_scroll_margin
= max (0, scroll_margin
);
15875 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15876 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
15877 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
15879 if ((w
->cursor
.y
< this_scroll_margin
15880 && CHARPOS (start
) > BEGV
)
15881 /* Old redisplay didn't take scroll margin into account at the bottom,
15882 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
15883 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
15884 ? cursor_height
+ this_scroll_margin
15885 : 1)) > it
.last_visible_y
)
15887 w
->cursor
.vpos
= -1;
15888 clear_glyph_matrix (w
->desired_matrix
);
15893 /* Scroll the display. Do it before changing the current matrix so
15894 that xterm.c doesn't get confused about where the cursor glyph is
15896 if (dy
&& run
.height
)
15900 if (FRAME_WINDOW_P (f
))
15902 FRAME_RIF (f
)->update_window_begin_hook (w
);
15903 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15904 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15905 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15909 /* Terminal frame. In this case, dvpos gives the number of
15910 lines to scroll by; dvpos < 0 means scroll up. */
15911 int first_unchanged_at_end_vpos
15912 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
15913 int from
= WINDOW_TOP_EDGE_LINE (w
) + first_unchanged_at_end_vpos
;
15914 int end
= (WINDOW_TOP_EDGE_LINE (w
)
15915 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
15916 + window_internal_height (w
));
15918 /* Perform the operation on the screen. */
15921 /* Scroll last_unchanged_at_beg_row to the end of the
15922 window down dvpos lines. */
15923 set_terminal_window (f
, end
);
15925 /* On dumb terminals delete dvpos lines at the end
15926 before inserting dvpos empty lines. */
15927 if (!FRAME_SCROLL_REGION_OK (f
))
15928 ins_del_lines (f
, end
- dvpos
, -dvpos
);
15930 /* Insert dvpos empty lines in front of
15931 last_unchanged_at_beg_row. */
15932 ins_del_lines (f
, from
, dvpos
);
15934 else if (dvpos
< 0)
15936 /* Scroll up last_unchanged_at_beg_vpos to the end of
15937 the window to last_unchanged_at_beg_vpos - |dvpos|. */
15938 set_terminal_window (f
, end
);
15940 /* Delete dvpos lines in front of
15941 last_unchanged_at_beg_vpos. ins_del_lines will set
15942 the cursor to the given vpos and emit |dvpos| delete
15944 ins_del_lines (f
, from
+ dvpos
, dvpos
);
15946 /* On a dumb terminal insert dvpos empty lines at the
15948 if (!FRAME_SCROLL_REGION_OK (f
))
15949 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
15952 set_terminal_window (f
, 0);
15958 /* Shift reused rows of the current matrix to the right position.
15959 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
15961 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
15962 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
15965 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
15966 bottom_vpos
, dvpos
);
15967 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
15970 else if (dvpos
> 0)
15972 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
15973 bottom_vpos
, dvpos
);
15974 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
15975 first_unchanged_at_end_vpos
+ dvpos
, 0);
15978 /* For frame-based redisplay, make sure that current frame and window
15979 matrix are in sync with respect to glyph memory. */
15980 if (!FRAME_WINDOW_P (f
))
15981 sync_frame_with_window_matrix_rows (w
);
15983 /* Adjust buffer positions in reused rows. */
15984 if (delta
|| delta_bytes
)
15985 increment_matrix_positions (current_matrix
,
15986 first_unchanged_at_end_vpos
+ dvpos
,
15987 bottom_vpos
, delta
, delta_bytes
);
15989 /* Adjust Y positions. */
15991 shift_glyph_matrix (w
, current_matrix
,
15992 first_unchanged_at_end_vpos
+ dvpos
,
15995 if (first_unchanged_at_end_row
)
15997 first_unchanged_at_end_row
+= dvpos
;
15998 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
15999 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16000 first_unchanged_at_end_row
= NULL
;
16003 /* If scrolling up, there may be some lines to display at the end of
16005 last_text_row_at_end
= NULL
;
16008 /* Scrolling up can leave for example a partially visible line
16009 at the end of the window to be redisplayed. */
16010 /* Set last_row to the glyph row in the current matrix where the
16011 window end line is found. It has been moved up or down in
16012 the matrix by dvpos. */
16013 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16014 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16016 /* If last_row is the window end line, it should display text. */
16017 xassert (last_row
->displays_text_p
);
16019 /* If window end line was partially visible before, begin
16020 displaying at that line. Otherwise begin displaying with the
16021 line following it. */
16022 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16024 init_to_row_start (&it
, w
, last_row
);
16025 it
.vpos
= last_vpos
;
16026 it
.current_y
= last_row
->y
;
16030 init_to_row_end (&it
, w
, last_row
);
16031 it
.vpos
= 1 + last_vpos
;
16032 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16036 /* We may start in a continuation line. If so, we have to
16037 get the right continuation_lines_width and current_x. */
16038 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
16039 it
.hpos
= it
.current_x
= 0;
16041 /* Display the rest of the lines at the window end. */
16042 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16043 while (it
.current_y
< it
.last_visible_y
16044 && !fonts_changed_p
)
16046 /* Is it always sure that the display agrees with lines in
16047 the current matrix? I don't think so, so we mark rows
16048 displayed invalid in the current matrix by setting their
16049 enabled_p flag to zero. */
16050 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
16051 if (display_line (&it
))
16052 last_text_row_at_end
= it
.glyph_row
- 1;
16056 /* Update window_end_pos and window_end_vpos. */
16057 if (first_unchanged_at_end_row
16058 && !last_text_row_at_end
)
16060 /* Window end line if one of the preserved rows from the current
16061 matrix. Set row to the last row displaying text in current
16062 matrix starting at first_unchanged_at_end_row, after
16064 xassert (first_unchanged_at_end_row
->displays_text_p
);
16065 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
16066 first_unchanged_at_end_row
);
16067 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
16069 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16070 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16072 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
16073 xassert (w
->window_end_bytepos
>= 0);
16074 IF_DEBUG (debug_method_add (w
, "A"));
16076 else if (last_text_row_at_end
)
16079 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
16080 w
->window_end_bytepos
16081 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
16083 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
16084 xassert (w
->window_end_bytepos
>= 0);
16085 IF_DEBUG (debug_method_add (w
, "B"));
16087 else if (last_text_row
)
16089 /* We have displayed either to the end of the window or at the
16090 end of the window, i.e. the last row with text is to be found
16091 in the desired matrix. */
16093 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16094 w
->window_end_bytepos
16095 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16097 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
16098 xassert (w
->window_end_bytepos
>= 0);
16100 else if (first_unchanged_at_end_row
== NULL
16101 && last_text_row
== NULL
16102 && last_text_row_at_end
== NULL
)
16104 /* Displayed to end of window, but no line containing text was
16105 displayed. Lines were deleted at the end of the window. */
16106 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
16107 int vpos
= XFASTINT (w
->window_end_vpos
);
16108 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
16109 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
16112 row
== NULL
&& vpos
>= first_vpos
;
16113 --vpos
, --current_row
, --desired_row
)
16115 if (desired_row
->enabled_p
)
16117 if (desired_row
->displays_text_p
)
16120 else if (current_row
->displays_text_p
)
16124 xassert (row
!= NULL
);
16125 w
->window_end_vpos
= make_number (vpos
+ 1);
16126 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16127 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16128 xassert (w
->window_end_bytepos
>= 0);
16129 IF_DEBUG (debug_method_add (w
, "C"));
16134 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
16135 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
16137 /* Record that display has not been completed. */
16138 w
->window_end_valid
= Qnil
;
16139 w
->desired_matrix
->no_scrolling_p
= 1;
16147 /***********************************************************************
16148 More debugging support
16149 ***********************************************************************/
16153 void dump_glyph_row (struct glyph_row
*, int, int);
16154 void dump_glyph_matrix (struct glyph_matrix
*, int);
16155 void dump_glyph (struct glyph_row
*, struct glyph
*, int);
16158 /* Dump the contents of glyph matrix MATRIX on stderr.
16160 GLYPHS 0 means don't show glyph contents.
16161 GLYPHS 1 means show glyphs in short form
16162 GLYPHS > 1 means show glyphs in long form. */
16165 dump_glyph_matrix (matrix
, glyphs
)
16166 struct glyph_matrix
*matrix
;
16170 for (i
= 0; i
< matrix
->nrows
; ++i
)
16171 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
16175 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
16176 the glyph row and area where the glyph comes from. */
16179 dump_glyph (row
, glyph
, area
)
16180 struct glyph_row
*row
;
16181 struct glyph
*glyph
;
16184 if (glyph
->type
== CHAR_GLYPH
)
16187 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16188 glyph
- row
->glyphs
[TEXT_AREA
],
16191 (BUFFERP (glyph
->object
)
16193 : (STRINGP (glyph
->object
)
16196 glyph
->pixel_width
,
16198 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
16202 glyph
->left_box_line_p
,
16203 glyph
->right_box_line_p
);
16205 else if (glyph
->type
== STRETCH_GLYPH
)
16208 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16209 glyph
- row
->glyphs
[TEXT_AREA
],
16212 (BUFFERP (glyph
->object
)
16214 : (STRINGP (glyph
->object
)
16217 glyph
->pixel_width
,
16221 glyph
->left_box_line_p
,
16222 glyph
->right_box_line_p
);
16224 else if (glyph
->type
== IMAGE_GLYPH
)
16227 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
16228 glyph
- row
->glyphs
[TEXT_AREA
],
16231 (BUFFERP (glyph
->object
)
16233 : (STRINGP (glyph
->object
)
16236 glyph
->pixel_width
,
16240 glyph
->left_box_line_p
,
16241 glyph
->right_box_line_p
);
16243 else if (glyph
->type
== COMPOSITE_GLYPH
)
16246 " %5d %4c %6d %c %3d 0x%05x",
16247 glyph
- row
->glyphs
[TEXT_AREA
],
16250 (BUFFERP (glyph
->object
)
16252 : (STRINGP (glyph
->object
)
16255 glyph
->pixel_width
,
16257 if (glyph
->u
.cmp
.automatic
)
16260 glyph
->u
.cmp
.from
, glyph
->u
.cmp
.to
);
16261 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
16263 glyph
->left_box_line_p
,
16264 glyph
->right_box_line_p
);
16269 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
16270 GLYPHS 0 means don't show glyph contents.
16271 GLYPHS 1 means show glyphs in short form
16272 GLYPHS > 1 means show glyphs in long form. */
16275 dump_glyph_row (row
, vpos
, glyphs
)
16276 struct glyph_row
*row
;
16281 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
16282 fprintf (stderr
, "======================================================================\n");
16284 fprintf (stderr
, "%3d %5d %5d %4d %1.1d%1.1d%1.1d%1.1d\
16285 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
16287 MATRIX_ROW_START_CHARPOS (row
),
16288 MATRIX_ROW_END_CHARPOS (row
),
16289 row
->used
[TEXT_AREA
],
16290 row
->contains_overlapping_glyphs_p
,
16292 row
->truncated_on_left_p
,
16293 row
->truncated_on_right_p
,
16295 MATRIX_ROW_CONTINUATION_LINE_P (row
),
16296 row
->displays_text_p
,
16299 row
->ends_in_middle_of_char_p
,
16300 row
->starts_in_middle_of_char_p
,
16306 row
->visible_height
,
16309 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
16310 row
->end
.overlay_string_index
,
16311 row
->continuation_lines_width
);
16312 fprintf (stderr
, "%9d %5d\n",
16313 CHARPOS (row
->start
.string_pos
),
16314 CHARPOS (row
->end
.string_pos
));
16315 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
16316 row
->end
.dpvec_index
);
16323 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16325 struct glyph
*glyph
= row
->glyphs
[area
];
16326 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
16328 /* Glyph for a line end in text. */
16329 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
16332 if (glyph
< glyph_end
)
16333 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
16335 for (; glyph
< glyph_end
; ++glyph
)
16336 dump_glyph (row
, glyph
, area
);
16339 else if (glyphs
== 1)
16343 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16345 char *s
= (char *) alloca (row
->used
[area
] + 1);
16348 for (i
= 0; i
< row
->used
[area
]; ++i
)
16350 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
16351 if (glyph
->type
== CHAR_GLYPH
16352 && glyph
->u
.ch
< 0x80
16353 && glyph
->u
.ch
>= ' ')
16354 s
[i
] = glyph
->u
.ch
;
16360 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
16366 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
16367 Sdump_glyph_matrix
, 0, 1, "p",
16368 doc
: /* Dump the current matrix of the selected window to stderr.
16369 Shows contents of glyph row structures. With non-nil
16370 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
16371 glyphs in short form, otherwise show glyphs in long form. */)
16372 (Lisp_Object glyphs
)
16374 struct window
*w
= XWINDOW (selected_window
);
16375 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16377 fprintf (stderr
, "PT = %d, BEGV = %d. ZV = %d\n",
16378 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
16379 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
16380 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
16381 fprintf (stderr
, "=============================================\n");
16382 dump_glyph_matrix (w
->current_matrix
,
16383 NILP (glyphs
) ? 0 : XINT (glyphs
));
16388 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
16389 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
16392 struct frame
*f
= XFRAME (selected_frame
);
16393 dump_glyph_matrix (f
->current_matrix
, 1);
16398 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
16399 doc
: /* Dump glyph row ROW to stderr.
16400 GLYPH 0 means don't dump glyphs.
16401 GLYPH 1 means dump glyphs in short form.
16402 GLYPH > 1 or omitted means dump glyphs in long form. */)
16403 (Lisp_Object row
, Lisp_Object glyphs
)
16405 struct glyph_matrix
*matrix
;
16408 CHECK_NUMBER (row
);
16409 matrix
= XWINDOW (selected_window
)->current_matrix
;
16411 if (vpos
>= 0 && vpos
< matrix
->nrows
)
16412 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
16414 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16419 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
16420 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
16421 GLYPH 0 means don't dump glyphs.
16422 GLYPH 1 means dump glyphs in short form.
16423 GLYPH > 1 or omitted means dump glyphs in long form. */)
16424 (Lisp_Object row
, Lisp_Object glyphs
)
16426 struct frame
*sf
= SELECTED_FRAME ();
16427 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
16430 CHECK_NUMBER (row
);
16432 if (vpos
>= 0 && vpos
< m
->nrows
)
16433 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
16434 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
16439 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
16440 doc
: /* Toggle tracing of redisplay.
16441 With ARG, turn tracing on if and only if ARG is positive. */)
16445 trace_redisplay_p
= !trace_redisplay_p
;
16448 arg
= Fprefix_numeric_value (arg
);
16449 trace_redisplay_p
= XINT (arg
) > 0;
16456 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
16457 doc
: /* Like `format', but print result to stderr.
16458 usage: (trace-to-stderr STRING &rest OBJECTS) */)
16459 (int nargs
, Lisp_Object
*args
)
16461 Lisp_Object s
= Fformat (nargs
, args
);
16462 fprintf (stderr
, "%s", SDATA (s
));
16466 #endif /* GLYPH_DEBUG */
16470 /***********************************************************************
16471 Building Desired Matrix Rows
16472 ***********************************************************************/
16474 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
16475 Used for non-window-redisplay windows, and for windows w/o left fringe. */
16477 static struct glyph_row
*
16478 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
16480 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
16481 struct buffer
*buffer
= XBUFFER (w
->buffer
);
16482 struct buffer
*old
= current_buffer
;
16483 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
16484 int arrow_len
= SCHARS (overlay_arrow_string
);
16485 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
16486 const unsigned char *p
;
16489 int n_glyphs_before
;
16491 set_buffer_temp (buffer
);
16492 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
16493 it
.glyph_row
->used
[TEXT_AREA
] = 0;
16494 SET_TEXT_POS (it
.position
, 0, 0);
16496 multibyte_p
= !NILP (buffer
->enable_multibyte_characters
);
16498 while (p
< arrow_end
)
16500 Lisp_Object face
, ilisp
;
16502 /* Get the next character. */
16504 it
.c
= string_char_and_length (p
, &it
.len
);
16506 it
.c
= *p
, it
.len
= 1;
16509 /* Get its face. */
16510 ilisp
= make_number (p
- arrow_string
);
16511 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
16512 it
.face_id
= compute_char_face (f
, it
.c
, face
);
16514 /* Compute its width, get its glyphs. */
16515 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
16516 SET_TEXT_POS (it
.position
, -1, -1);
16517 PRODUCE_GLYPHS (&it
);
16519 /* If this character doesn't fit any more in the line, we have
16520 to remove some glyphs. */
16521 if (it
.current_x
> it
.last_visible_x
)
16523 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
16528 set_buffer_temp (old
);
16529 return it
.glyph_row
;
16533 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
16534 glyphs are only inserted for terminal frames since we can't really
16535 win with truncation glyphs when partially visible glyphs are
16536 involved. Which glyphs to insert is determined by
16537 produce_special_glyphs. */
16540 insert_left_trunc_glyphs (struct it
*it
)
16542 struct it truncate_it
;
16543 struct glyph
*from
, *end
, *to
, *toend
;
16545 xassert (!FRAME_WINDOW_P (it
->f
));
16547 /* Get the truncation glyphs. */
16549 truncate_it
.current_x
= 0;
16550 truncate_it
.face_id
= DEFAULT_FACE_ID
;
16551 truncate_it
.glyph_row
= &scratch_glyph_row
;
16552 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
16553 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
16554 truncate_it
.object
= make_number (0);
16555 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
16557 /* Overwrite glyphs from IT with truncation glyphs. */
16558 if (!it
->glyph_row
->reversed_p
)
16560 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16561 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
16562 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16563 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
16568 /* There may be padding glyphs left over. Overwrite them too. */
16569 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
16571 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16577 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
16581 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
16582 that back to front. */
16583 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
16584 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16585 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16586 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16588 while (from
>= end
&& to
>= toend
)
16590 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
16593 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
16594 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
16595 while (from
>= end
&& to
>= toend
)
16600 /* Need to free some room before prepending additional
16602 int move_by
= from
- end
+ 1;
16603 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16604 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
16606 for ( ; g
>= g0
; g
--)
16608 while (from
>= end
)
16610 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
16616 /* Compute the pixel height and width of IT->glyph_row.
16618 Most of the time, ascent and height of a display line will be equal
16619 to the max_ascent and max_height values of the display iterator
16620 structure. This is not the case if
16622 1. We hit ZV without displaying anything. In this case, max_ascent
16623 and max_height will be zero.
16625 2. We have some glyphs that don't contribute to the line height.
16626 (The glyph row flag contributes_to_line_height_p is for future
16627 pixmap extensions).
16629 The first case is easily covered by using default values because in
16630 these cases, the line height does not really matter, except that it
16631 must not be zero. */
16634 compute_line_metrics (struct it
*it
)
16636 struct glyph_row
*row
= it
->glyph_row
;
16639 if (FRAME_WINDOW_P (it
->f
))
16641 int i
, min_y
, max_y
;
16643 /* The line may consist of one space only, that was added to
16644 place the cursor on it. If so, the row's height hasn't been
16646 if (row
->height
== 0)
16648 if (it
->max_ascent
+ it
->max_descent
== 0)
16649 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
16650 row
->ascent
= it
->max_ascent
;
16651 row
->height
= it
->max_ascent
+ it
->max_descent
;
16652 row
->phys_ascent
= it
->max_phys_ascent
;
16653 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
16654 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
16657 /* Compute the width of this line. */
16658 row
->pixel_width
= row
->x
;
16659 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
16660 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
16662 xassert (row
->pixel_width
>= 0);
16663 xassert (row
->ascent
>= 0 && row
->height
> 0);
16665 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
16666 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
16668 /* If first line's physical ascent is larger than its logical
16669 ascent, use the physical ascent, and make the row taller.
16670 This makes accented characters fully visible. */
16671 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
16672 && row
->phys_ascent
> row
->ascent
)
16674 row
->height
+= row
->phys_ascent
- row
->ascent
;
16675 row
->ascent
= row
->phys_ascent
;
16678 /* Compute how much of the line is visible. */
16679 row
->visible_height
= row
->height
;
16681 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
16682 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
16684 if (row
->y
< min_y
)
16685 row
->visible_height
-= min_y
- row
->y
;
16686 if (row
->y
+ row
->height
> max_y
)
16687 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16691 row
->pixel_width
= row
->used
[TEXT_AREA
];
16692 if (row
->continued_p
)
16693 row
->pixel_width
-= it
->continuation_pixel_width
;
16694 else if (row
->truncated_on_right_p
)
16695 row
->pixel_width
-= it
->truncation_pixel_width
;
16696 row
->ascent
= row
->phys_ascent
= 0;
16697 row
->height
= row
->phys_height
= row
->visible_height
= 1;
16698 row
->extra_line_spacing
= 0;
16701 /* Compute a hash code for this row. */
16703 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
16704 for (i
= 0; i
< row
->used
[area
]; ++i
)
16705 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
16706 + row
->glyphs
[area
][i
].u
.val
16707 + row
->glyphs
[area
][i
].face_id
16708 + row
->glyphs
[area
][i
].padding_p
16709 + (row
->glyphs
[area
][i
].type
<< 2));
16711 it
->max_ascent
= it
->max_descent
= 0;
16712 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
16716 /* Append one space to the glyph row of iterator IT if doing a
16717 window-based redisplay. The space has the same face as
16718 IT->face_id. Value is non-zero if a space was added.
16720 This function is called to make sure that there is always one glyph
16721 at the end of a glyph row that the cursor can be set on under
16722 window-systems. (If there weren't such a glyph we would not know
16723 how wide and tall a box cursor should be displayed).
16725 At the same time this space let's a nicely handle clearing to the
16726 end of the line if the row ends in italic text. */
16729 append_space_for_newline (struct it
*it
, int default_face_p
)
16731 if (FRAME_WINDOW_P (it
->f
))
16733 int n
= it
->glyph_row
->used
[TEXT_AREA
];
16735 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
16736 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
16738 /* Save some values that must not be changed.
16739 Must save IT->c and IT->len because otherwise
16740 ITERATOR_AT_END_P wouldn't work anymore after
16741 append_space_for_newline has been called. */
16742 enum display_element_type saved_what
= it
->what
;
16743 int saved_c
= it
->c
, saved_len
= it
->len
;
16744 int saved_x
= it
->current_x
;
16745 int saved_face_id
= it
->face_id
;
16746 struct text_pos saved_pos
;
16747 Lisp_Object saved_object
;
16750 saved_object
= it
->object
;
16751 saved_pos
= it
->position
;
16753 it
->what
= IT_CHARACTER
;
16754 memset (&it
->position
, 0, sizeof it
->position
);
16755 it
->object
= make_number (0);
16759 if (default_face_p
)
16760 it
->face_id
= DEFAULT_FACE_ID
;
16761 else if (it
->face_before_selective_p
)
16762 it
->face_id
= it
->saved_face_id
;
16763 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
16764 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
16766 PRODUCE_GLYPHS (it
);
16768 it
->override_ascent
= -1;
16769 it
->constrain_row_ascent_descent_p
= 0;
16770 it
->current_x
= saved_x
;
16771 it
->object
= saved_object
;
16772 it
->position
= saved_pos
;
16773 it
->what
= saved_what
;
16774 it
->face_id
= saved_face_id
;
16775 it
->len
= saved_len
;
16785 /* Extend the face of the last glyph in the text area of IT->glyph_row
16786 to the end of the display line. Called from display_line. If the
16787 glyph row is empty, add a space glyph to it so that we know the
16788 face to draw. Set the glyph row flag fill_line_p. If the glyph
16789 row is R2L, prepend a stretch glyph to cover the empty space to the
16790 left of the leftmost glyph. */
16793 extend_face_to_end_of_line (struct it
*it
)
16796 struct frame
*f
= it
->f
;
16798 /* If line is already filled, do nothing. Non window-system frames
16799 get a grace of one more ``pixel'' because their characters are
16800 1-``pixel'' wide, so they hit the equality too early. This grace
16801 is needed only for R2L rows that are not continued, to produce
16802 one extra blank where we could display the cursor. */
16803 if (it
->current_x
>= it
->last_visible_x
16804 + (!FRAME_WINDOW_P (f
)
16805 && it
->glyph_row
->reversed_p
16806 && !it
->glyph_row
->continued_p
))
16809 /* Face extension extends the background and box of IT->face_id
16810 to the end of the line. If the background equals the background
16811 of the frame, we don't have to do anything. */
16812 if (it
->face_before_selective_p
)
16813 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
16815 face
= FACE_FROM_ID (f
, it
->face_id
);
16817 if (FRAME_WINDOW_P (f
)
16818 && it
->glyph_row
->displays_text_p
16819 && face
->box
== FACE_NO_BOX
16820 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
16822 && !it
->glyph_row
->reversed_p
)
16825 /* Set the glyph row flag indicating that the face of the last glyph
16826 in the text area has to be drawn to the end of the text area. */
16827 it
->glyph_row
->fill_line_p
= 1;
16829 /* If current character of IT is not ASCII, make sure we have the
16830 ASCII face. This will be automatically undone the next time
16831 get_next_display_element returns a multibyte character. Note
16832 that the character will always be single byte in unibyte
16834 if (!ASCII_CHAR_P (it
->c
))
16836 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
16839 if (FRAME_WINDOW_P (f
))
16841 /* If the row is empty, add a space with the current face of IT,
16842 so that we know which face to draw. */
16843 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
16845 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
16846 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
16847 it
->glyph_row
->used
[TEXT_AREA
] = 1;
16849 #ifdef HAVE_WINDOW_SYSTEM
16850 if (it
->glyph_row
->reversed_p
)
16852 /* Prepend a stretch glyph to the row, such that the
16853 rightmost glyph will be drawn flushed all the way to the
16854 right margin of the window. The stretch glyph that will
16855 occupy the empty space, if any, to the left of the
16857 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
16858 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
16859 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
16861 int row_width
, stretch_ascent
, stretch_width
;
16862 struct text_pos saved_pos
;
16863 int saved_face_id
, saved_avoid_cursor
;
16865 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
16866 row_width
+= g
->pixel_width
;
16867 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
16868 if (stretch_width
> 0)
16871 (((it
->ascent
+ it
->descent
)
16872 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
16873 saved_pos
= it
->position
;
16874 memset (&it
->position
, 0, sizeof it
->position
);
16875 saved_avoid_cursor
= it
->avoid_cursor_p
;
16876 it
->avoid_cursor_p
= 1;
16877 saved_face_id
= it
->face_id
;
16878 /* The last row's stretch glyph should get the default
16879 face, to avoid painting the rest of the window with
16880 the region face, if the region ends at ZV. */
16881 if (it
->glyph_row
->ends_at_zv_p
)
16882 it
->face_id
= DEFAULT_FACE_ID
;
16884 it
->face_id
= face
->id
;
16885 append_stretch_glyph (it
, make_number (0), stretch_width
,
16886 it
->ascent
+ it
->descent
, stretch_ascent
);
16887 it
->position
= saved_pos
;
16888 it
->avoid_cursor_p
= saved_avoid_cursor
;
16889 it
->face_id
= saved_face_id
;
16892 #endif /* HAVE_WINDOW_SYSTEM */
16896 /* Save some values that must not be changed. */
16897 int saved_x
= it
->current_x
;
16898 struct text_pos saved_pos
;
16899 Lisp_Object saved_object
;
16900 enum display_element_type saved_what
= it
->what
;
16901 int saved_face_id
= it
->face_id
;
16903 saved_object
= it
->object
;
16904 saved_pos
= it
->position
;
16906 it
->what
= IT_CHARACTER
;
16907 memset (&it
->position
, 0, sizeof it
->position
);
16908 it
->object
= make_number (0);
16911 /* The last row's blank glyphs should get the default face, to
16912 avoid painting the rest of the window with the region face,
16913 if the region ends at ZV. */
16914 if (it
->glyph_row
->ends_at_zv_p
)
16915 it
->face_id
= DEFAULT_FACE_ID
;
16917 it
->face_id
= face
->id
;
16919 PRODUCE_GLYPHS (it
);
16921 while (it
->current_x
<= it
->last_visible_x
)
16922 PRODUCE_GLYPHS (it
);
16924 /* Don't count these blanks really. It would let us insert a left
16925 truncation glyph below and make us set the cursor on them, maybe. */
16926 it
->current_x
= saved_x
;
16927 it
->object
= saved_object
;
16928 it
->position
= saved_pos
;
16929 it
->what
= saved_what
;
16930 it
->face_id
= saved_face_id
;
16935 /* Value is non-zero if text starting at CHARPOS in current_buffer is
16936 trailing whitespace. */
16939 trailing_whitespace_p (int charpos
)
16941 int bytepos
= CHAR_TO_BYTE (charpos
);
16944 while (bytepos
< ZV_BYTE
16945 && (c
= FETCH_CHAR (bytepos
),
16946 c
== ' ' || c
== '\t'))
16949 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
16951 if (bytepos
!= PT_BYTE
)
16958 /* Highlight trailing whitespace, if any, in ROW. */
16961 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
16963 int used
= row
->used
[TEXT_AREA
];
16967 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
16968 struct glyph
*glyph
= start
+ used
- 1;
16970 if (row
->reversed_p
)
16972 /* Right-to-left rows need to be processed in the opposite
16973 direction, so swap the edge pointers. */
16975 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
16978 /* Skip over glyphs inserted to display the cursor at the
16979 end of a line, for extending the face of the last glyph
16980 to the end of the line on terminals, and for truncation
16981 and continuation glyphs. */
16982 if (!row
->reversed_p
)
16984 while (glyph
>= start
16985 && glyph
->type
== CHAR_GLYPH
16986 && INTEGERP (glyph
->object
))
16991 while (glyph
<= start
16992 && glyph
->type
== CHAR_GLYPH
16993 && INTEGERP (glyph
->object
))
16997 /* If last glyph is a space or stretch, and it's trailing
16998 whitespace, set the face of all trailing whitespace glyphs in
16999 IT->glyph_row to `trailing-whitespace'. */
17000 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17001 && BUFFERP (glyph
->object
)
17002 && (glyph
->type
== STRETCH_GLYPH
17003 || (glyph
->type
== CHAR_GLYPH
17004 && glyph
->u
.ch
== ' '))
17005 && trailing_whitespace_p (glyph
->charpos
))
17007 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17011 if (!row
->reversed_p
)
17013 while (glyph
>= start
17014 && BUFFERP (glyph
->object
)
17015 && (glyph
->type
== STRETCH_GLYPH
17016 || (glyph
->type
== CHAR_GLYPH
17017 && glyph
->u
.ch
== ' ')))
17018 (glyph
--)->face_id
= face_id
;
17022 while (glyph
<= start
17023 && BUFFERP (glyph
->object
)
17024 && (glyph
->type
== STRETCH_GLYPH
17025 || (glyph
->type
== CHAR_GLYPH
17026 && glyph
->u
.ch
== ' ')))
17027 (glyph
++)->face_id
= face_id
;
17034 /* Value is non-zero if glyph row ROW in window W should be
17035 used to hold the cursor. */
17038 cursor_row_p (struct window
*w
, struct glyph_row
*row
)
17040 int cursor_row_p
= 1;
17042 if (PT
== CHARPOS (row
->end
.pos
))
17044 /* Suppose the row ends on a string.
17045 Unless the row is continued, that means it ends on a newline
17046 in the string. If it's anything other than a display string
17047 (e.g. a before-string from an overlay), we don't want the
17048 cursor there. (This heuristic seems to give the optimal
17049 behavior for the various types of multi-line strings.) */
17050 if (CHARPOS (row
->end
.string_pos
) >= 0)
17052 if (row
->continued_p
)
17056 /* Check for `display' property. */
17057 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
17058 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
17059 struct glyph
*glyph
;
17062 for (glyph
= end
; glyph
>= beg
; --glyph
)
17063 if (STRINGP (glyph
->object
))
17066 = Fget_char_property (make_number (PT
),
17070 && display_prop_string_p (prop
, glyph
->object
));
17075 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
17077 /* If the row ends in middle of a real character,
17078 and the line is continued, we want the cursor here.
17079 That's because CHARPOS (ROW->end.pos) would equal
17080 PT if PT is before the character. */
17081 if (!row
->ends_in_ellipsis_p
)
17082 cursor_row_p
= row
->continued_p
;
17084 /* If the row ends in an ellipsis, then
17085 CHARPOS (ROW->end.pos) will equal point after the
17086 invisible text. We want that position to be displayed
17087 after the ellipsis. */
17090 /* If the row ends at ZV, display the cursor at the end of that
17091 row instead of at the start of the row below. */
17092 else if (row
->ends_at_zv_p
)
17098 return cursor_row_p
;
17103 /* Push the display property PROP so that it will be rendered at the
17104 current position in IT. Return 1 if PROP was successfully pushed,
17108 push_display_prop (struct it
*it
, Lisp_Object prop
)
17112 if (STRINGP (prop
))
17114 if (SCHARS (prop
) == 0)
17121 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
17122 it
->current
.overlay_string_index
= -1;
17123 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
17124 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
17125 it
->method
= GET_FROM_STRING
;
17126 it
->stop_charpos
= 0;
17128 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
17130 it
->method
= GET_FROM_STRETCH
;
17133 #ifdef HAVE_WINDOW_SYSTEM
17134 else if (IMAGEP (prop
))
17136 it
->what
= IT_IMAGE
;
17137 it
->image_id
= lookup_image (it
->f
, prop
);
17138 it
->method
= GET_FROM_IMAGE
;
17140 #endif /* HAVE_WINDOW_SYSTEM */
17143 pop_it (it
); /* bogus display property, give up */
17150 /* Return the character-property PROP at the current position in IT. */
17153 get_it_property (struct it
*it
, Lisp_Object prop
)
17155 Lisp_Object position
;
17157 if (STRINGP (it
->object
))
17158 position
= make_number (IT_STRING_CHARPOS (*it
));
17159 else if (BUFFERP (it
->object
))
17160 position
= make_number (IT_CHARPOS (*it
));
17164 return Fget_char_property (position
, prop
, it
->object
);
17167 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
17170 handle_line_prefix (struct it
*it
)
17172 Lisp_Object prefix
;
17173 if (it
->continuation_lines_width
> 0)
17175 prefix
= get_it_property (it
, Qwrap_prefix
);
17177 prefix
= Vwrap_prefix
;
17181 prefix
= get_it_property (it
, Qline_prefix
);
17183 prefix
= Vline_prefix
;
17185 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
17187 /* If the prefix is wider than the window, and we try to wrap
17188 it, it would acquire its own wrap prefix, and so on till the
17189 iterator stack overflows. So, don't wrap the prefix. */
17190 it
->line_wrap
= TRUNCATE
;
17191 it
->avoid_cursor_p
= 1;
17197 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
17198 only for R2L lines from display_line, when it decides that too many
17199 glyphs were produced by PRODUCE_GLYPHS, and the line needs to be
17202 unproduce_glyphs (struct it
*it
, int n
)
17204 struct glyph
*glyph
, *end
;
17206 xassert (it
->glyph_row
);
17207 xassert (it
->glyph_row
->reversed_p
);
17208 xassert (it
->area
== TEXT_AREA
);
17209 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
17211 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
17212 n
= it
->glyph_row
->used
[TEXT_AREA
];
17213 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
17214 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
17215 for ( ; glyph
< end
; glyph
++)
17216 glyph
[-n
] = *glyph
;
17219 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
17220 and ROW->maxpos. */
17222 find_row_edges (struct it
*it
, struct glyph_row
*row
,
17223 EMACS_INT min_pos
, EMACS_INT min_bpos
,
17224 EMACS_INT max_pos
, EMACS_INT max_bpos
)
17226 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17227 lines' rows is implemented for bidi-reordered rows. */
17229 /* ROW->minpos is the value of min_pos, the minimal buffer position
17232 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
17235 /* We didn't find _any_ valid buffer positions in any of the
17236 glyphs, so we must trust the iterator's computed
17238 row
->minpos
= row
->start
.pos
;
17239 max_pos
= CHARPOS (it
->current
.pos
);
17240 max_bpos
= BYTEPOS (it
->current
.pos
);
17246 /* Here are the various use-cases for ending the row, and the
17247 corresponding values for ROW->maxpos:
17249 Line ends in a newline from buffer eol_pos + 1
17250 Line is continued from buffer max_pos + 1
17251 Line is truncated on right it->current.pos
17252 Line ends in a newline from string max_pos
17253 Line is continued from string max_pos
17254 Line is continued from display vector max_pos
17255 Line is entirely from a string min_pos == max_pos
17256 Line is entirely from a display vector min_pos == max_pos
17257 Line that ends at ZV ZV
17259 If you discover other use-cases, please add them here as
17261 if (row
->ends_at_zv_p
)
17262 row
->maxpos
= it
->current
.pos
;
17263 else if (row
->used
[TEXT_AREA
])
17265 if (row
->ends_in_newline_from_string_p
)
17266 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17267 else if (CHARPOS (it
->eol_pos
) > 0)
17268 SET_TEXT_POS (row
->maxpos
,
17269 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
17270 else if (row
->continued_p
)
17272 /* If max_pos is different from IT's current position, it
17273 means IT->method does not belong to the display element
17274 at max_pos. However, it also means that the display
17275 element at max_pos was displayed in its entirety on this
17276 line, which is equivalent to saying that the next line
17277 starts at the next buffer position. */
17278 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
17279 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17282 INC_BOTH (max_pos
, max_bpos
);
17283 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
17286 else if (row
->truncated_on_right_p
)
17287 /* display_line already called reseat_at_next_visible_line_start,
17288 which puts the iterator at the beginning of the next line, in
17289 the logical order. */
17290 row
->maxpos
= it
->current
.pos
;
17291 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
17292 /* A line that is entirely from a string/image/stretch... */
17293 row
->maxpos
= row
->minpos
;
17298 row
->maxpos
= it
->current
.pos
;
17301 /* Construct the glyph row IT->glyph_row in the desired matrix of
17302 IT->w from text at the current position of IT. See dispextern.h
17303 for an overview of struct it. Value is non-zero if
17304 IT->glyph_row displays text, as opposed to a line displaying ZV
17308 display_line (struct it
*it
)
17310 struct glyph_row
*row
= it
->glyph_row
;
17311 Lisp_Object overlay_arrow_string
;
17313 int may_wrap
= 0, wrap_x
;
17314 int wrap_row_used
= -1, wrap_row_ascent
, wrap_row_height
;
17315 int wrap_row_phys_ascent
, wrap_row_phys_height
;
17316 int wrap_row_extra_line_spacing
;
17317 EMACS_INT wrap_row_min_pos
, wrap_row_min_bpos
;
17318 EMACS_INT wrap_row_max_pos
, wrap_row_max_bpos
;
17320 EMACS_INT min_pos
= ZV
+ 1, min_bpos
, max_pos
= 0, max_bpos
;
17322 /* We always start displaying at hpos zero even if hscrolled. */
17323 xassert (it
->hpos
== 0 && it
->current_x
== 0);
17325 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
17326 >= it
->w
->desired_matrix
->nrows
)
17328 it
->w
->nrows_scale_factor
++;
17329 fonts_changed_p
= 1;
17333 /* Is IT->w showing the region? */
17334 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
17336 /* Clear the result glyph row and enable it. */
17337 prepare_desired_row (row
);
17339 row
->y
= it
->current_y
;
17340 row
->start
= it
->start
;
17341 row
->continuation_lines_width
= it
->continuation_lines_width
;
17342 row
->displays_text_p
= 1;
17343 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
17344 it
->starts_in_middle_of_char_p
= 0;
17346 /* Arrange the overlays nicely for our purposes. Usually, we call
17347 display_line on only one line at a time, in which case this
17348 can't really hurt too much, or we call it on lines which appear
17349 one after another in the buffer, in which case all calls to
17350 recenter_overlay_lists but the first will be pretty cheap. */
17351 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
17353 /* Move over display elements that are not visible because we are
17354 hscrolled. This may stop at an x-position < IT->first_visible_x
17355 if the first glyph is partially visible or if we hit a line end. */
17356 if (it
->current_x
< it
->first_visible_x
)
17358 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
17359 MOVE_TO_POS
| MOVE_TO_X
);
17363 /* We only do this when not calling `move_it_in_display_line_to'
17364 above, because move_it_in_display_line_to calls
17365 handle_line_prefix itself. */
17366 handle_line_prefix (it
);
17369 /* Get the initial row height. This is either the height of the
17370 text hscrolled, if there is any, or zero. */
17371 row
->ascent
= it
->max_ascent
;
17372 row
->height
= it
->max_ascent
+ it
->max_descent
;
17373 row
->phys_ascent
= it
->max_phys_ascent
;
17374 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17375 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17377 /* Utility macro to record max and min buffer positions seen until now. */
17378 #define RECORD_MAX_MIN_POS(IT) \
17381 if (IT_CHARPOS (*(IT)) < min_pos) \
17383 min_pos = IT_CHARPOS (*(IT)); \
17384 min_bpos = IT_BYTEPOS (*(IT)); \
17386 if (IT_CHARPOS (*(IT)) > max_pos) \
17388 max_pos = IT_CHARPOS (*(IT)); \
17389 max_bpos = IT_BYTEPOS (*(IT)); \
17394 /* Loop generating characters. The loop is left with IT on the next
17395 character to display. */
17398 int n_glyphs_before
, hpos_before
, x_before
;
17400 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
17402 /* Retrieve the next thing to display. Value is zero if end of
17404 if (!get_next_display_element (it
))
17406 /* Maybe add a space at the end of this line that is used to
17407 display the cursor there under X. Set the charpos of the
17408 first glyph of blank lines not corresponding to any text
17410 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17411 row
->exact_window_width_line_p
= 1;
17412 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
17413 || row
->used
[TEXT_AREA
] == 0)
17415 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
17416 row
->displays_text_p
= 0;
17418 if (!NILP (XBUFFER (it
->w
->buffer
)->indicate_empty_lines
)
17419 && (!MINI_WINDOW_P (it
->w
)
17420 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
17421 row
->indicate_empty_line_p
= 1;
17424 it
->continuation_lines_width
= 0;
17425 row
->ends_at_zv_p
= 1;
17426 /* A row that displays right-to-left text must always have
17427 its last face extended all the way to the end of line,
17428 even if this row ends in ZV, because we still write to th
17429 screen left to right. */
17430 if (row
->reversed_p
)
17431 extend_face_to_end_of_line (it
);
17435 /* Now, get the metrics of what we want to display. This also
17436 generates glyphs in `row' (which is IT->glyph_row). */
17437 n_glyphs_before
= row
->used
[TEXT_AREA
];
17440 /* Remember the line height so far in case the next element doesn't
17441 fit on the line. */
17442 if (it
->line_wrap
!= TRUNCATE
)
17444 ascent
= it
->max_ascent
;
17445 descent
= it
->max_descent
;
17446 phys_ascent
= it
->max_phys_ascent
;
17447 phys_descent
= it
->max_phys_descent
;
17449 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
17451 if (IT_DISPLAYING_WHITESPACE (it
))
17457 wrap_row_used
= row
->used
[TEXT_AREA
];
17458 wrap_row_ascent
= row
->ascent
;
17459 wrap_row_height
= row
->height
;
17460 wrap_row_phys_ascent
= row
->phys_ascent
;
17461 wrap_row_phys_height
= row
->phys_height
;
17462 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
17463 wrap_row_min_pos
= min_pos
;
17464 wrap_row_min_bpos
= min_bpos
;
17465 wrap_row_max_pos
= max_pos
;
17466 wrap_row_max_bpos
= max_bpos
;
17472 PRODUCE_GLYPHS (it
);
17474 /* If this display element was in marginal areas, continue with
17476 if (it
->area
!= TEXT_AREA
)
17478 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17479 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17480 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17481 row
->phys_height
= max (row
->phys_height
,
17482 it
->max_phys_ascent
+ it
->max_phys_descent
);
17483 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17484 it
->max_extra_line_spacing
);
17485 set_iterator_to_next (it
, 1);
17489 /* Does the display element fit on the line? If we truncate
17490 lines, we should draw past the right edge of the window. If
17491 we don't truncate, we want to stop so that we can display the
17492 continuation glyph before the right margin. If lines are
17493 continued, there are two possible strategies for characters
17494 resulting in more than 1 glyph (e.g. tabs): Display as many
17495 glyphs as possible in this line and leave the rest for the
17496 continuation line, or display the whole element in the next
17497 line. Original redisplay did the former, so we do it also. */
17498 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
17499 hpos_before
= it
->hpos
;
17502 if (/* Not a newline. */
17504 /* Glyphs produced fit entirely in the line. */
17505 && it
->current_x
< it
->last_visible_x
)
17507 it
->hpos
+= nglyphs
;
17508 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17509 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17510 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17511 row
->phys_height
= max (row
->phys_height
,
17512 it
->max_phys_ascent
+ it
->max_phys_descent
);
17513 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17514 it
->max_extra_line_spacing
);
17515 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
17516 row
->x
= x
- it
->first_visible_x
;
17517 /* Record the maximum and minimum buffer positions seen so
17518 far in glyphs that will be displayed by this row. */
17520 RECORD_MAX_MIN_POS (it
);
17525 struct glyph
*glyph
;
17527 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
17529 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
17530 new_x
= x
+ glyph
->pixel_width
;
17532 if (/* Lines are continued. */
17533 it
->line_wrap
!= TRUNCATE
17534 && (/* Glyph doesn't fit on the line. */
17535 new_x
> it
->last_visible_x
17536 /* Or it fits exactly on a window system frame. */
17537 || (new_x
== it
->last_visible_x
17538 && FRAME_WINDOW_P (it
->f
))))
17540 /* End of a continued line. */
17543 || (new_x
== it
->last_visible_x
17544 && FRAME_WINDOW_P (it
->f
)))
17546 /* Current glyph is the only one on the line or
17547 fits exactly on the line. We must continue
17548 the line because we can't draw the cursor
17549 after the glyph. */
17550 row
->continued_p
= 1;
17551 it
->current_x
= new_x
;
17552 it
->continuation_lines_width
+= new_x
;
17554 /* Record the maximum and minimum buffer
17555 positions seen so far in glyphs that will be
17556 displayed by this row. */
17558 RECORD_MAX_MIN_POS (it
);
17559 if (i
== nglyphs
- 1)
17561 /* If line-wrap is on, check if a previous
17562 wrap point was found. */
17563 if (wrap_row_used
> 0
17564 /* Even if there is a previous wrap
17565 point, continue the line here as
17566 usual, if (i) the previous character
17567 was a space or tab AND (ii) the
17568 current character is not. */
17570 || IT_DISPLAYING_WHITESPACE (it
)))
17573 set_iterator_to_next (it
, 1);
17574 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17576 if (!get_next_display_element (it
))
17578 row
->exact_window_width_line_p
= 1;
17579 it
->continuation_lines_width
= 0;
17580 row
->continued_p
= 0;
17581 row
->ends_at_zv_p
= 1;
17583 else if (ITERATOR_AT_END_OF_LINE_P (it
))
17585 row
->continued_p
= 0;
17586 row
->exact_window_width_line_p
= 1;
17591 else if (CHAR_GLYPH_PADDING_P (*glyph
)
17592 && !FRAME_WINDOW_P (it
->f
))
17594 /* A padding glyph that doesn't fit on this line.
17595 This means the whole character doesn't fit
17597 if (row
->reversed_p
)
17598 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17599 - n_glyphs_before
);
17600 row
->used
[TEXT_AREA
] = n_glyphs_before
;
17602 /* Fill the rest of the row with continuation
17603 glyphs like in 20.x. */
17604 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
17605 < row
->glyphs
[1 + TEXT_AREA
])
17606 produce_special_glyphs (it
, IT_CONTINUATION
);
17608 row
->continued_p
= 1;
17609 it
->current_x
= x_before
;
17610 it
->continuation_lines_width
+= x_before
;
17612 /* Restore the height to what it was before the
17613 element not fitting on the line. */
17614 it
->max_ascent
= ascent
;
17615 it
->max_descent
= descent
;
17616 it
->max_phys_ascent
= phys_ascent
;
17617 it
->max_phys_descent
= phys_descent
;
17619 else if (wrap_row_used
> 0)
17622 if (row
->reversed_p
)
17623 unproduce_glyphs (it
,
17624 row
->used
[TEXT_AREA
] - wrap_row_used
);
17626 it
->continuation_lines_width
+= wrap_x
;
17627 row
->used
[TEXT_AREA
] = wrap_row_used
;
17628 row
->ascent
= wrap_row_ascent
;
17629 row
->height
= wrap_row_height
;
17630 row
->phys_ascent
= wrap_row_phys_ascent
;
17631 row
->phys_height
= wrap_row_phys_height
;
17632 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
17633 min_pos
= wrap_row_min_pos
;
17634 min_bpos
= wrap_row_min_bpos
;
17635 max_pos
= wrap_row_max_pos
;
17636 max_bpos
= wrap_row_max_bpos
;
17637 row
->continued_p
= 1;
17638 row
->ends_at_zv_p
= 0;
17639 row
->exact_window_width_line_p
= 0;
17640 it
->continuation_lines_width
+= x
;
17642 /* Make sure that a non-default face is extended
17643 up to the right margin of the window. */
17644 extend_face_to_end_of_line (it
);
17646 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
17648 /* A TAB that extends past the right edge of the
17649 window. This produces a single glyph on
17650 window system frames. We leave the glyph in
17651 this row and let it fill the row, but don't
17652 consume the TAB. */
17653 it
->continuation_lines_width
+= it
->last_visible_x
;
17654 row
->ends_in_middle_of_char_p
= 1;
17655 row
->continued_p
= 1;
17656 glyph
->pixel_width
= it
->last_visible_x
- x
;
17657 it
->starts_in_middle_of_char_p
= 1;
17661 /* Something other than a TAB that draws past
17662 the right edge of the window. Restore
17663 positions to values before the element. */
17664 if (row
->reversed_p
)
17665 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
17666 - (n_glyphs_before
+ i
));
17667 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
17669 /* Display continuation glyphs. */
17670 if (!FRAME_WINDOW_P (it
->f
))
17671 produce_special_glyphs (it
, IT_CONTINUATION
);
17672 row
->continued_p
= 1;
17674 it
->current_x
= x_before
;
17675 it
->continuation_lines_width
+= x
;
17676 extend_face_to_end_of_line (it
);
17678 if (nglyphs
> 1 && i
> 0)
17680 row
->ends_in_middle_of_char_p
= 1;
17681 it
->starts_in_middle_of_char_p
= 1;
17684 /* Restore the height to what it was before the
17685 element not fitting on the line. */
17686 it
->max_ascent
= ascent
;
17687 it
->max_descent
= descent
;
17688 it
->max_phys_ascent
= phys_ascent
;
17689 it
->max_phys_descent
= phys_descent
;
17694 else if (new_x
> it
->first_visible_x
)
17696 /* Increment number of glyphs actually displayed. */
17699 /* Record the maximum and minimum buffer positions
17700 seen so far in glyphs that will be displayed by
17703 RECORD_MAX_MIN_POS (it
);
17705 if (x
< it
->first_visible_x
)
17706 /* Glyph is partially visible, i.e. row starts at
17707 negative X position. */
17708 row
->x
= x
- it
->first_visible_x
;
17712 /* Glyph is completely off the left margin of the
17713 window. This should not happen because of the
17714 move_it_in_display_line at the start of this
17715 function, unless the text display area of the
17716 window is empty. */
17717 xassert (it
->first_visible_x
<= it
->last_visible_x
);
17721 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
17722 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
17723 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
17724 row
->phys_height
= max (row
->phys_height
,
17725 it
->max_phys_ascent
+ it
->max_phys_descent
);
17726 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
17727 it
->max_extra_line_spacing
);
17729 /* End of this display line if row is continued. */
17730 if (row
->continued_p
|| row
->ends_at_zv_p
)
17735 /* Is this a line end? If yes, we're also done, after making
17736 sure that a non-default face is extended up to the right
17737 margin of the window. */
17738 if (ITERATOR_AT_END_OF_LINE_P (it
))
17740 int used_before
= row
->used
[TEXT_AREA
];
17742 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
17744 /* Add a space at the end of the line that is used to
17745 display the cursor there. */
17746 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17747 append_space_for_newline (it
, 0);
17749 /* Extend the face to the end of the line. */
17750 extend_face_to_end_of_line (it
);
17752 /* Make sure we have the position. */
17753 if (used_before
== 0)
17754 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
17756 /* Record the position of the newline, for use in
17758 it
->eol_pos
= it
->current
.pos
;
17760 /* Consume the line end. This skips over invisible lines. */
17761 set_iterator_to_next (it
, 1);
17762 it
->continuation_lines_width
= 0;
17766 /* Proceed with next display element. Note that this skips
17767 over lines invisible because of selective display. */
17768 set_iterator_to_next (it
, 1);
17770 /* If we truncate lines, we are done when the last displayed
17771 glyphs reach past the right margin of the window. */
17772 if (it
->line_wrap
== TRUNCATE
17773 && (FRAME_WINDOW_P (it
->f
)
17774 ? (it
->current_x
>= it
->last_visible_x
)
17775 : (it
->current_x
> it
->last_visible_x
)))
17777 /* Maybe add truncation glyphs. */
17778 if (!FRAME_WINDOW_P (it
->f
))
17782 if (!row
->reversed_p
)
17784 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
17785 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17790 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
17791 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
17793 /* Remove any padding glyphs at the front of ROW, to
17794 make room for the truncation glyphs we will be
17795 adding below. The loop below always inserts at
17796 least one truncation glyph, so also remove the
17797 last glyph added to ROW. */
17798 unproduce_glyphs (it
, i
+ 1);
17799 /* Adjust i for the loop below. */
17800 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
17803 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
17805 row
->used
[TEXT_AREA
] = i
;
17806 produce_special_glyphs (it
, IT_TRUNCATION
);
17809 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
17811 /* Don't truncate if we can overflow newline into fringe. */
17812 if (!get_next_display_element (it
))
17814 it
->continuation_lines_width
= 0;
17815 row
->ends_at_zv_p
= 1;
17816 row
->exact_window_width_line_p
= 1;
17819 if (ITERATOR_AT_END_OF_LINE_P (it
))
17821 row
->exact_window_width_line_p
= 1;
17822 goto at_end_of_line
;
17826 row
->truncated_on_right_p
= 1;
17827 it
->continuation_lines_width
= 0;
17828 reseat_at_next_visible_line_start (it
, 0);
17829 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
17830 it
->hpos
= hpos_before
;
17831 it
->current_x
= x_before
;
17836 /* If line is not empty and hscrolled, maybe insert truncation glyphs
17837 at the left window margin. */
17838 if (it
->first_visible_x
17839 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
17841 if (!FRAME_WINDOW_P (it
->f
))
17842 insert_left_trunc_glyphs (it
);
17843 row
->truncated_on_left_p
= 1;
17846 /* If the start of this line is the overlay arrow-position, then
17847 mark this glyph row as the one containing the overlay arrow.
17848 This is clearly a mess with variable size fonts. It would be
17849 better to let it be displayed like cursors under X. */
17850 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
17851 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
17852 !NILP (overlay_arrow_string
)))
17854 /* Overlay arrow in window redisplay is a fringe bitmap. */
17855 if (STRINGP (overlay_arrow_string
))
17857 struct glyph_row
*arrow_row
17858 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
17859 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
17860 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
17861 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
17862 struct glyph
*p2
, *end
;
17864 /* Copy the arrow glyphs. */
17865 while (glyph
< arrow_end
)
17868 /* Throw away padding glyphs. */
17870 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17871 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
17877 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
17882 xassert (INTEGERP (overlay_arrow_string
));
17883 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
17885 overlay_arrow_seen
= 1;
17888 /* Compute pixel dimensions of this line. */
17889 compute_line_metrics (it
);
17891 /* Remember the position at which this line ends. */
17892 row
->end
= it
->current
;
17895 row
->minpos
= row
->start
.pos
;
17896 row
->maxpos
= row
->end
.pos
;
17900 /* ROW->minpos and ROW->maxpos must be the smallest and
17901 `1 + the largest' buffer positions in ROW. But if ROW was
17902 bidi-reordered, these two positions can be anywhere in the
17903 row, so we must determine them now. */
17904 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
17907 /* Record whether this row ends inside an ellipsis. */
17908 row
->ends_in_ellipsis_p
17909 = (it
->method
== GET_FROM_DISPLAY_VECTOR
17910 && it
->ellipsis_p
);
17912 /* Save fringe bitmaps in this row. */
17913 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
17914 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
17915 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
17916 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
17918 it
->left_user_fringe_bitmap
= 0;
17919 it
->left_user_fringe_face_id
= 0;
17920 it
->right_user_fringe_bitmap
= 0;
17921 it
->right_user_fringe_face_id
= 0;
17923 /* Maybe set the cursor. */
17924 cvpos
= it
->w
->cursor
.vpos
;
17926 /* In bidi-reordered rows, keep checking for proper cursor
17927 position even if one has been found already, because buffer
17928 positions in such rows change non-linearly with ROW->VPOS,
17929 when a line is continued. One exception: when we are at ZV,
17930 display cursor on the first suitable glyph row, since all
17931 the empty rows after that also have their position set to ZV. */
17932 /* FIXME: Revisit this when glyph ``spilling'' in continuation
17933 lines' rows is implemented for bidi-reordered rows. */
17935 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
17936 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
17937 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
17938 && cursor_row_p (it
->w
, row
))
17939 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
17941 /* Highlight trailing whitespace. */
17942 if (!NILP (Vshow_trailing_whitespace
))
17943 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
17945 /* Prepare for the next line. This line starts horizontally at (X
17946 HPOS) = (0 0). Vertical positions are incremented. As a
17947 convenience for the caller, IT->glyph_row is set to the next
17949 it
->current_x
= it
->hpos
= 0;
17950 it
->current_y
+= row
->height
;
17951 SET_TEXT_POS (it
->eol_pos
, 0, 0);
17954 /* The next row should by default use the same value of the
17955 reversed_p flag as this one. set_iterator_to_next decides when
17956 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
17957 the flag accordingly. */
17958 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
17959 it
->glyph_row
->reversed_p
= row
->reversed_p
;
17960 it
->start
= row
->end
;
17961 return row
->displays_text_p
;
17963 #undef RECORD_MAX_MIN_POS
17966 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
17967 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
17968 doc
: /* Return paragraph direction at point in BUFFER.
17969 Value is either `left-to-right' or `right-to-left'.
17970 If BUFFER is omitted or nil, it defaults to the current buffer.
17972 Paragraph direction determines how the text in the paragraph is displayed.
17973 In left-to-right paragraphs, text begins at the left margin of the window
17974 and the reading direction is generally left to right. In right-to-left
17975 paragraphs, text begins at the right margin and is read from right to left.
17977 See also `bidi-paragraph-direction'. */)
17978 (Lisp_Object buffer
)
17980 struct buffer
*buf
;
17981 struct buffer
*old
;
17984 buf
= current_buffer
;
17987 CHECK_BUFFER (buffer
);
17988 buf
= XBUFFER (buffer
);
17989 old
= current_buffer
;
17992 if (NILP (buf
->bidi_display_reordering
))
17993 return Qleft_to_right
;
17994 else if (!NILP (buf
->bidi_paragraph_direction
))
17995 return buf
->bidi_paragraph_direction
;
17998 /* Determine the direction from buffer text. We could try to
17999 use current_matrix if it is up to date, but this seems fast
18000 enough as it is. */
18001 struct bidi_it itb
;
18002 EMACS_INT pos
= BUF_PT (buf
);
18003 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
18005 if (buf
!= current_buffer
)
18006 set_buffer_temp (buf
);
18007 /* Find previous non-empty line. */
18008 if (pos
>= ZV
&& pos
> BEGV
)
18011 bytepos
= CHAR_TO_BYTE (pos
);
18013 while (FETCH_BYTE (bytepos
) == '\n')
18015 if (bytepos
<= BEGV_BYTE
)
18020 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
18023 itb
.bytepos
= bytepos
;
18026 bidi_paragraph_init (NEUTRAL_DIR
, &itb
);
18027 if (buf
!= current_buffer
)
18028 set_buffer_temp (old
);
18029 switch (itb
.paragraph_dir
)
18032 return Qleft_to_right
;
18035 return Qright_to_left
;
18045 /***********************************************************************
18047 ***********************************************************************/
18049 /* Redisplay the menu bar in the frame for window W.
18051 The menu bar of X frames that don't have X toolkit support is
18052 displayed in a special window W->frame->menu_bar_window.
18054 The menu bar of terminal frames is treated specially as far as
18055 glyph matrices are concerned. Menu bar lines are not part of
18056 windows, so the update is done directly on the frame matrix rows
18057 for the menu bar. */
18060 display_menu_bar (struct window
*w
)
18062 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18067 /* Don't do all this for graphical frames. */
18069 if (FRAME_W32_P (f
))
18072 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
18078 if (FRAME_NS_P (f
))
18080 #endif /* HAVE_NS */
18082 #ifdef USE_X_TOOLKIT
18083 xassert (!FRAME_WINDOW_P (f
));
18084 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
18085 it
.first_visible_x
= 0;
18086 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18087 #else /* not USE_X_TOOLKIT */
18088 if (FRAME_WINDOW_P (f
))
18090 /* Menu bar lines are displayed in the desired matrix of the
18091 dummy window menu_bar_window. */
18092 struct window
*menu_w
;
18093 xassert (WINDOWP (f
->menu_bar_window
));
18094 menu_w
= XWINDOW (f
->menu_bar_window
);
18095 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
18097 it
.first_visible_x
= 0;
18098 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
18102 /* This is a TTY frame, i.e. character hpos/vpos are used as
18104 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
18106 it
.first_visible_x
= 0;
18107 it
.last_visible_x
= FRAME_COLS (f
);
18109 #endif /* not USE_X_TOOLKIT */
18111 if (! mode_line_inverse_video
)
18112 /* Force the menu-bar to be displayed in the default face. */
18113 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18115 /* Clear all rows of the menu bar. */
18116 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
18118 struct glyph_row
*row
= it
.glyph_row
+ i
;
18119 clear_glyph_row (row
);
18120 row
->enabled_p
= 1;
18121 row
->full_width_p
= 1;
18124 /* Display all items of the menu bar. */
18125 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
18126 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
18128 Lisp_Object string
;
18130 /* Stop at nil string. */
18131 string
= AREF (items
, i
+ 1);
18135 /* Remember where item was displayed. */
18136 ASET (items
, i
+ 3, make_number (it
.hpos
));
18138 /* Display the item, pad with one space. */
18139 if (it
.current_x
< it
.last_visible_x
)
18140 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
18141 SCHARS (string
) + 1, 0, 0, -1);
18144 /* Fill out the line with spaces. */
18145 if (it
.current_x
< it
.last_visible_x
)
18146 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
18148 /* Compute the total height of the lines. */
18149 compute_line_metrics (&it
);
18154 /***********************************************************************
18156 ***********************************************************************/
18158 /* Redisplay mode lines in the window tree whose root is WINDOW. If
18159 FORCE is non-zero, redisplay mode lines unconditionally.
18160 Otherwise, redisplay only mode lines that are garbaged. Value is
18161 the number of windows whose mode lines were redisplayed. */
18164 redisplay_mode_lines (Lisp_Object window
, int force
)
18168 while (!NILP (window
))
18170 struct window
*w
= XWINDOW (window
);
18172 if (WINDOWP (w
->hchild
))
18173 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
18174 else if (WINDOWP (w
->vchild
))
18175 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
18177 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
18178 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
18180 struct text_pos lpoint
;
18181 struct buffer
*old
= current_buffer
;
18183 /* Set the window's buffer for the mode line display. */
18184 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
18185 set_buffer_internal_1 (XBUFFER (w
->buffer
));
18187 /* Point refers normally to the selected window. For any
18188 other window, set up appropriate value. */
18189 if (!EQ (window
, selected_window
))
18191 struct text_pos pt
;
18193 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
18194 if (CHARPOS (pt
) < BEGV
)
18195 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
18196 else if (CHARPOS (pt
) > (ZV
- 1))
18197 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
18199 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
18202 /* Display mode lines. */
18203 clear_glyph_matrix (w
->desired_matrix
);
18204 if (display_mode_lines (w
))
18207 w
->must_be_updated_p
= 1;
18210 /* Restore old settings. */
18211 set_buffer_internal_1 (old
);
18212 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
18222 /* Display the mode and/or header line of window W. Value is the
18223 sum number of mode lines and header lines displayed. */
18226 display_mode_lines (struct window
*w
)
18228 Lisp_Object old_selected_window
, old_selected_frame
;
18231 old_selected_frame
= selected_frame
;
18232 selected_frame
= w
->frame
;
18233 old_selected_window
= selected_window
;
18234 XSETWINDOW (selected_window
, w
);
18236 /* These will be set while the mode line specs are processed. */
18237 line_number_displayed
= 0;
18238 w
->column_number_displayed
= Qnil
;
18240 if (WINDOW_WANTS_MODELINE_P (w
))
18242 struct window
*sel_w
= XWINDOW (old_selected_window
);
18244 /* Select mode line face based on the real selected window. */
18245 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
18246 current_buffer
->mode_line_format
);
18250 if (WINDOW_WANTS_HEADER_LINE_P (w
))
18252 display_mode_line (w
, HEADER_LINE_FACE_ID
,
18253 current_buffer
->header_line_format
);
18257 selected_frame
= old_selected_frame
;
18258 selected_window
= old_selected_window
;
18263 /* Display mode or header line of window W. FACE_ID specifies which
18264 line to display; it is either MODE_LINE_FACE_ID or
18265 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
18266 display. Value is the pixel height of the mode/header line
18270 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
18274 int count
= SPECPDL_INDEX ();
18276 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18277 /* Don't extend on a previously drawn mode-line.
18278 This may happen if called from pos_visible_p. */
18279 it
.glyph_row
->enabled_p
= 0;
18280 prepare_desired_row (it
.glyph_row
);
18282 it
.glyph_row
->mode_line_p
= 1;
18284 if (! mode_line_inverse_video
)
18285 /* Force the mode-line to be displayed in the default face. */
18286 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
18288 record_unwind_protect (unwind_format_mode_line
,
18289 format_mode_line_unwind_data (NULL
, Qnil
, 0));
18291 mode_line_target
= MODE_LINE_DISPLAY
;
18293 /* Temporarily make frame's keyboard the current kboard so that
18294 kboard-local variables in the mode_line_format will get the right
18296 push_kboard (FRAME_KBOARD (it
.f
));
18297 record_unwind_save_match_data ();
18298 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
18301 unbind_to (count
, Qnil
);
18303 /* Fill up with spaces. */
18304 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
18306 compute_line_metrics (&it
);
18307 it
.glyph_row
->full_width_p
= 1;
18308 it
.glyph_row
->continued_p
= 0;
18309 it
.glyph_row
->truncated_on_left_p
= 0;
18310 it
.glyph_row
->truncated_on_right_p
= 0;
18312 /* Make a 3D mode-line have a shadow at its right end. */
18313 face
= FACE_FROM_ID (it
.f
, face_id
);
18314 extend_face_to_end_of_line (&it
);
18315 if (face
->box
!= FACE_NO_BOX
)
18317 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
18318 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
18319 last
->right_box_line_p
= 1;
18322 return it
.glyph_row
->height
;
18325 /* Move element ELT in LIST to the front of LIST.
18326 Return the updated list. */
18329 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
18331 register Lisp_Object tail
, prev
;
18332 register Lisp_Object tem
;
18336 while (CONSP (tail
))
18342 /* Splice out the link TAIL. */
18344 list
= XCDR (tail
);
18346 Fsetcdr (prev
, XCDR (tail
));
18348 /* Now make it the first. */
18349 Fsetcdr (tail
, list
);
18354 tail
= XCDR (tail
);
18358 /* Not found--return unchanged LIST. */
18362 /* Contribute ELT to the mode line for window IT->w. How it
18363 translates into text depends on its data type.
18365 IT describes the display environment in which we display, as usual.
18367 DEPTH is the depth in recursion. It is used to prevent
18368 infinite recursion here.
18370 FIELD_WIDTH is the number of characters the display of ELT should
18371 occupy in the mode line, and PRECISION is the maximum number of
18372 characters to display from ELT's representation. See
18373 display_string for details.
18375 Returns the hpos of the end of the text generated by ELT.
18377 PROPS is a property list to add to any string we encounter.
18379 If RISKY is nonzero, remove (disregard) any properties in any string
18380 we encounter, and ignore :eval and :propertize.
18382 The global variable `mode_line_target' determines whether the
18383 output is passed to `store_mode_line_noprop',
18384 `store_mode_line_string', or `display_string'. */
18387 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
18388 Lisp_Object elt
, Lisp_Object props
, int risky
)
18390 int n
= 0, field
, prec
;
18395 elt
= build_string ("*too-deep*");
18399 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
18403 /* A string: output it and check for %-constructs within it. */
18407 if (SCHARS (elt
) > 0
18408 && (!NILP (props
) || risky
))
18410 Lisp_Object oprops
, aelt
;
18411 oprops
= Ftext_properties_at (make_number (0), elt
);
18413 /* If the starting string's properties are not what
18414 we want, translate the string. Also, if the string
18415 is risky, do that anyway. */
18417 if (NILP (Fequal (props
, oprops
)) || risky
)
18419 /* If the starting string has properties,
18420 merge the specified ones onto the existing ones. */
18421 if (! NILP (oprops
) && !risky
)
18425 oprops
= Fcopy_sequence (oprops
);
18427 while (CONSP (tem
))
18429 oprops
= Fplist_put (oprops
, XCAR (tem
),
18430 XCAR (XCDR (tem
)));
18431 tem
= XCDR (XCDR (tem
));
18436 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
18437 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
18439 /* AELT is what we want. Move it to the front
18440 without consing. */
18442 mode_line_proptrans_alist
18443 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
18449 /* If AELT has the wrong props, it is useless.
18450 so get rid of it. */
18452 mode_line_proptrans_alist
18453 = Fdelq (aelt
, mode_line_proptrans_alist
);
18455 elt
= Fcopy_sequence (elt
);
18456 Fset_text_properties (make_number (0), Flength (elt
),
18458 /* Add this item to mode_line_proptrans_alist. */
18459 mode_line_proptrans_alist
18460 = Fcons (Fcons (elt
, props
),
18461 mode_line_proptrans_alist
);
18462 /* Truncate mode_line_proptrans_alist
18463 to at most 50 elements. */
18464 tem
= Fnthcdr (make_number (50),
18465 mode_line_proptrans_alist
);
18467 XSETCDR (tem
, Qnil
);
18476 prec
= precision
- n
;
18477 switch (mode_line_target
)
18479 case MODE_LINE_NOPROP
:
18480 case MODE_LINE_TITLE
:
18481 n
+= store_mode_line_noprop (SDATA (elt
), -1, prec
);
18483 case MODE_LINE_STRING
:
18484 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
18486 case MODE_LINE_DISPLAY
:
18487 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
18488 0, prec
, 0, STRING_MULTIBYTE (elt
));
18495 /* Handle the non-literal case. */
18497 while ((precision
<= 0 || n
< precision
)
18498 && SREF (elt
, offset
) != 0
18499 && (mode_line_target
!= MODE_LINE_DISPLAY
18500 || it
->current_x
< it
->last_visible_x
))
18502 int last_offset
= offset
;
18504 /* Advance to end of string or next format specifier. */
18505 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
18508 if (offset
- 1 != last_offset
)
18510 int nchars
, nbytes
;
18512 /* Output to end of string or up to '%'. Field width
18513 is length of string. Don't output more than
18514 PRECISION allows us. */
18517 prec
= c_string_width (SDATA (elt
) + last_offset
,
18518 offset
- last_offset
, precision
- n
,
18521 switch (mode_line_target
)
18523 case MODE_LINE_NOPROP
:
18524 case MODE_LINE_TITLE
:
18525 n
+= store_mode_line_noprop (SDATA (elt
) + last_offset
, 0, prec
);
18527 case MODE_LINE_STRING
:
18529 int bytepos
= last_offset
;
18530 int charpos
= string_byte_to_char (elt
, bytepos
);
18531 int endpos
= (precision
<= 0
18532 ? string_byte_to_char (elt
, offset
)
18533 : charpos
+ nchars
);
18535 n
+= store_mode_line_string (NULL
,
18536 Fsubstring (elt
, make_number (charpos
),
18537 make_number (endpos
)),
18541 case MODE_LINE_DISPLAY
:
18543 int bytepos
= last_offset
;
18544 int charpos
= string_byte_to_char (elt
, bytepos
);
18546 if (precision
<= 0)
18547 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
18548 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
18550 STRING_MULTIBYTE (elt
));
18555 else /* c == '%' */
18557 int percent_position
= offset
;
18559 /* Get the specified minimum width. Zero means
18562 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
18563 field
= field
* 10 + c
- '0';
18565 /* Don't pad beyond the total padding allowed. */
18566 if (field_width
- n
> 0 && field
> field_width
- n
)
18567 field
= field_width
- n
;
18569 /* Note that either PRECISION <= 0 or N < PRECISION. */
18570 prec
= precision
- n
;
18573 n
+= display_mode_element (it
, depth
, field
, prec
,
18574 Vglobal_mode_string
, props
,
18579 int bytepos
, charpos
;
18580 unsigned char *spec
;
18581 Lisp_Object string
;
18583 bytepos
= percent_position
;
18584 charpos
= (STRING_MULTIBYTE (elt
)
18585 ? string_byte_to_char (elt
, bytepos
)
18587 spec
= decode_mode_spec (it
->w
, c
, field
, prec
, &string
);
18588 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
18590 switch (mode_line_target
)
18592 case MODE_LINE_NOPROP
:
18593 case MODE_LINE_TITLE
:
18594 n
+= store_mode_line_noprop (spec
, field
, prec
);
18596 case MODE_LINE_STRING
:
18598 int len
= strlen (spec
);
18599 Lisp_Object tem
= make_string (spec
, len
);
18600 props
= Ftext_properties_at (make_number (charpos
), elt
);
18601 /* Should only keep face property in props */
18602 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
18605 case MODE_LINE_DISPLAY
:
18607 int nglyphs_before
, nwritten
;
18609 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
18610 nwritten
= display_string (spec
, string
, elt
,
18615 /* Assign to the glyphs written above the
18616 string where the `%x' came from, position
18620 struct glyph
*glyph
18621 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
18625 for (i
= 0; i
< nwritten
; ++i
)
18627 glyph
[i
].object
= elt
;
18628 glyph
[i
].charpos
= charpos
;
18645 /* A symbol: process the value of the symbol recursively
18646 as if it appeared here directly. Avoid error if symbol void.
18647 Special case: if value of symbol is a string, output the string
18650 register Lisp_Object tem
;
18652 /* If the variable is not marked as risky to set
18653 then its contents are risky to use. */
18654 if (NILP (Fget (elt
, Qrisky_local_variable
)))
18657 tem
= Fboundp (elt
);
18660 tem
= Fsymbol_value (elt
);
18661 /* If value is a string, output that string literally:
18662 don't check for % within it. */
18666 if (!EQ (tem
, elt
))
18668 /* Give up right away for nil or t. */
18678 register Lisp_Object car
, tem
;
18680 /* A cons cell: five distinct cases.
18681 If first element is :eval or :propertize, do something special.
18682 If first element is a string or a cons, process all the elements
18683 and effectively concatenate them.
18684 If first element is a negative number, truncate displaying cdr to
18685 at most that many characters. If positive, pad (with spaces)
18686 to at least that many characters.
18687 If first element is a symbol, process the cadr or caddr recursively
18688 according to whether the symbol's value is non-nil or nil. */
18690 if (EQ (car
, QCeval
))
18692 /* An element of the form (:eval FORM) means evaluate FORM
18693 and use the result as mode line elements. */
18698 if (CONSP (XCDR (elt
)))
18701 spec
= safe_eval (XCAR (XCDR (elt
)));
18702 n
+= display_mode_element (it
, depth
, field_width
- n
,
18703 precision
- n
, spec
, props
,
18707 else if (EQ (car
, QCpropertize
))
18709 /* An element of the form (:propertize ELT PROPS...)
18710 means display ELT but applying properties PROPS. */
18715 if (CONSP (XCDR (elt
)))
18716 n
+= display_mode_element (it
, depth
, field_width
- n
,
18717 precision
- n
, XCAR (XCDR (elt
)),
18718 XCDR (XCDR (elt
)), risky
);
18720 else if (SYMBOLP (car
))
18722 tem
= Fboundp (car
);
18726 /* elt is now the cdr, and we know it is a cons cell.
18727 Use its car if CAR has a non-nil value. */
18730 tem
= Fsymbol_value (car
);
18737 /* Symbol's value is nil (or symbol is unbound)
18738 Get the cddr of the original list
18739 and if possible find the caddr and use that. */
18743 else if (!CONSP (elt
))
18748 else if (INTEGERP (car
))
18750 register int lim
= XINT (car
);
18754 /* Negative int means reduce maximum width. */
18755 if (precision
<= 0)
18758 precision
= min (precision
, -lim
);
18762 /* Padding specified. Don't let it be more than
18763 current maximum. */
18765 lim
= min (precision
, lim
);
18767 /* If that's more padding than already wanted, queue it.
18768 But don't reduce padding already specified even if
18769 that is beyond the current truncation point. */
18770 field_width
= max (lim
, field_width
);
18774 else if (STRINGP (car
) || CONSP (car
))
18776 Lisp_Object halftail
= elt
;
18780 && (precision
<= 0 || n
< precision
))
18782 n
+= display_mode_element (it
, depth
,
18783 /* Do padding only after the last
18784 element in the list. */
18785 (! CONSP (XCDR (elt
))
18788 precision
- n
, XCAR (elt
),
18792 if ((len
& 1) == 0)
18793 halftail
= XCDR (halftail
);
18794 /* Check for cycle. */
18795 if (EQ (halftail
, elt
))
18804 elt
= build_string ("*invalid*");
18808 /* Pad to FIELD_WIDTH. */
18809 if (field_width
> 0 && n
< field_width
)
18811 switch (mode_line_target
)
18813 case MODE_LINE_NOPROP
:
18814 case MODE_LINE_TITLE
:
18815 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
18817 case MODE_LINE_STRING
:
18818 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
18820 case MODE_LINE_DISPLAY
:
18821 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
18830 /* Store a mode-line string element in mode_line_string_list.
18832 If STRING is non-null, display that C string. Otherwise, the Lisp
18833 string LISP_STRING is displayed.
18835 FIELD_WIDTH is the minimum number of output glyphs to produce.
18836 If STRING has fewer characters than FIELD_WIDTH, pad to the right
18837 with spaces. FIELD_WIDTH <= 0 means don't pad.
18839 PRECISION is the maximum number of characters to output from
18840 STRING. PRECISION <= 0 means don't truncate the string.
18842 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
18843 properties to the string.
18845 PROPS are the properties to add to the string.
18846 The mode_line_string_face face property is always added to the string.
18850 store_mode_line_string (char *string
, Lisp_Object lisp_string
, int copy_string
,
18851 int field_width
, int precision
, Lisp_Object props
)
18856 if (string
!= NULL
)
18858 len
= strlen (string
);
18859 if (precision
> 0 && len
> precision
)
18861 lisp_string
= make_string (string
, len
);
18863 props
= mode_line_string_face_prop
;
18864 else if (!NILP (mode_line_string_face
))
18866 Lisp_Object face
= Fplist_get (props
, Qface
);
18867 props
= Fcopy_sequence (props
);
18869 face
= mode_line_string_face
;
18871 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18872 props
= Fplist_put (props
, Qface
, face
);
18874 Fadd_text_properties (make_number (0), make_number (len
),
18875 props
, lisp_string
);
18879 len
= XFASTINT (Flength (lisp_string
));
18880 if (precision
> 0 && len
> precision
)
18883 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
18886 if (!NILP (mode_line_string_face
))
18890 props
= Ftext_properties_at (make_number (0), lisp_string
);
18891 face
= Fplist_get (props
, Qface
);
18893 face
= mode_line_string_face
;
18895 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
18896 props
= Fcons (Qface
, Fcons (face
, Qnil
));
18898 lisp_string
= Fcopy_sequence (lisp_string
);
18901 Fadd_text_properties (make_number (0), make_number (len
),
18902 props
, lisp_string
);
18907 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18911 if (field_width
> len
)
18913 field_width
-= len
;
18914 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
18916 Fadd_text_properties (make_number (0), make_number (field_width
),
18917 props
, lisp_string
);
18918 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
18926 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
18928 doc
: /* Format a string out of a mode line format specification.
18929 First arg FORMAT specifies the mode line format (see `mode-line-format'
18930 for details) to use.
18932 Optional second arg FACE specifies the face property to put
18933 on all characters for which no face is specified.
18934 The value t means whatever face the window's mode line currently uses
18935 \(either `mode-line' or `mode-line-inactive', depending).
18936 A value of nil means the default is no face property.
18937 If FACE is an integer, the value string has no text properties.
18939 Optional third and fourth args WINDOW and BUFFER specify the window
18940 and buffer to use as the context for the formatting (defaults
18941 are the selected window and the window's buffer). */)
18942 (Lisp_Object format
, Lisp_Object face
, Lisp_Object window
, Lisp_Object buffer
)
18947 struct buffer
*old_buffer
= NULL
;
18949 int no_props
= INTEGERP (face
);
18950 int count
= SPECPDL_INDEX ();
18952 int string_start
= 0;
18955 window
= selected_window
;
18956 CHECK_WINDOW (window
);
18957 w
= XWINDOW (window
);
18960 buffer
= w
->buffer
;
18961 CHECK_BUFFER (buffer
);
18963 /* Make formatting the modeline a non-op when noninteractive, otherwise
18964 there will be problems later caused by a partially initialized frame. */
18965 if (NILP (format
) || noninteractive
)
18966 return empty_unibyte_string
;
18974 face
= (EQ (window
, selected_window
) ? Qmode_line
: Qmode_line_inactive
);
18975 face_id
= lookup_named_face (XFRAME (WINDOW_FRAME (w
)), face
, 0);
18979 face_id
= DEFAULT_FACE_ID
;
18981 if (XBUFFER (buffer
) != current_buffer
)
18982 old_buffer
= current_buffer
;
18984 /* Save things including mode_line_proptrans_alist,
18985 and set that to nil so that we don't alter the outer value. */
18986 record_unwind_protect (unwind_format_mode_line
,
18987 format_mode_line_unwind_data
18988 (old_buffer
, selected_window
, 1));
18989 mode_line_proptrans_alist
= Qnil
;
18991 Fselect_window (window
, Qt
);
18993 set_buffer_internal_1 (XBUFFER (buffer
));
18995 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
18999 mode_line_target
= MODE_LINE_NOPROP
;
19000 mode_line_string_face_prop
= Qnil
;
19001 mode_line_string_list
= Qnil
;
19002 string_start
= MODE_LINE_NOPROP_LEN (0);
19006 mode_line_target
= MODE_LINE_STRING
;
19007 mode_line_string_list
= Qnil
;
19008 mode_line_string_face
= face
;
19009 mode_line_string_face_prop
19010 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
19013 push_kboard (FRAME_KBOARD (it
.f
));
19014 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19019 len
= MODE_LINE_NOPROP_LEN (string_start
);
19020 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
19024 mode_line_string_list
= Fnreverse (mode_line_string_list
);
19025 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
19026 empty_unibyte_string
);
19029 unbind_to (count
, Qnil
);
19033 /* Write a null-terminated, right justified decimal representation of
19034 the positive integer D to BUF using a minimal field width WIDTH. */
19037 pint2str (register char *buf
, register int width
, register int d
)
19039 register char *p
= buf
;
19047 *p
++ = d
% 10 + '0';
19052 for (width
-= (int) (p
- buf
); width
> 0; --width
)
19063 /* Write a null-terminated, right justified decimal and "human
19064 readable" representation of the nonnegative integer D to BUF using
19065 a minimal field width WIDTH. D should be smaller than 999.5e24. */
19067 static const char power_letter
[] =
19081 pint2hrstr (char *buf
, int width
, int d
)
19083 /* We aim to represent the nonnegative integer D as
19084 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
19087 /* -1 means: do not use TENTHS. */
19091 /* Length of QUOTIENT.TENTHS as a string. */
19097 if (1000 <= quotient
)
19099 /* Scale to the appropriate EXPONENT. */
19102 remainder
= quotient
% 1000;
19106 while (1000 <= quotient
);
19108 /* Round to nearest and decide whether to use TENTHS or not. */
19111 tenths
= remainder
/ 100;
19112 if (50 <= remainder
% 100)
19119 if (quotient
== 10)
19127 if (500 <= remainder
)
19129 if (quotient
< 999)
19140 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
19141 if (tenths
== -1 && quotient
<= 99)
19148 p
= psuffix
= buf
+ max (width
, length
);
19150 /* Print EXPONENT. */
19152 *psuffix
++ = power_letter
[exponent
];
19155 /* Print TENTHS. */
19158 *--p
= '0' + tenths
;
19162 /* Print QUOTIENT. */
19165 int digit
= quotient
% 10;
19166 *--p
= '0' + digit
;
19168 while ((quotient
/= 10) != 0);
19170 /* Print leading spaces. */
19175 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
19176 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
19177 type of CODING_SYSTEM. Return updated pointer into BUF. */
19179 static unsigned char invalid_eol_type
[] = "(*invalid*)";
19182 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
19185 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
19186 const unsigned char *eol_str
;
19188 /* The EOL conversion we are using. */
19189 Lisp_Object eoltype
;
19191 val
= CODING_SYSTEM_SPEC (coding_system
);
19194 if (!VECTORP (val
)) /* Not yet decided. */
19199 eoltype
= eol_mnemonic_undecided
;
19200 /* Don't mention EOL conversion if it isn't decided. */
19205 Lisp_Object eolvalue
;
19207 attrs
= AREF (val
, 0);
19208 eolvalue
= AREF (val
, 2);
19211 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
19215 /* The EOL conversion that is normal on this system. */
19217 if (NILP (eolvalue
)) /* Not yet decided. */
19218 eoltype
= eol_mnemonic_undecided
;
19219 else if (VECTORP (eolvalue
)) /* Not yet decided. */
19220 eoltype
= eol_mnemonic_undecided
;
19221 else /* eolvalue is Qunix, Qdos, or Qmac. */
19222 eoltype
= (EQ (eolvalue
, Qunix
)
19223 ? eol_mnemonic_unix
19224 : (EQ (eolvalue
, Qdos
) == 1
19225 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
19231 /* Mention the EOL conversion if it is not the usual one. */
19232 if (STRINGP (eoltype
))
19234 eol_str
= SDATA (eoltype
);
19235 eol_str_len
= SBYTES (eoltype
);
19237 else if (CHARACTERP (eoltype
))
19239 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
19240 eol_str_len
= CHAR_STRING (XINT (eoltype
), tmp
);
19245 eol_str
= invalid_eol_type
;
19246 eol_str_len
= sizeof (invalid_eol_type
) - 1;
19248 memcpy (buf
, eol_str
, eol_str_len
);
19249 buf
+= eol_str_len
;
19255 /* Return a string for the output of a mode line %-spec for window W,
19256 generated by character C. PRECISION >= 0 means don't return a
19257 string longer than that value. FIELD_WIDTH > 0 means pad the
19258 string returned with spaces to that value. Return a Lisp string in
19259 *STRING if the resulting string is taken from that Lisp string.
19261 Note we operate on the current buffer for most purposes,
19262 the exception being w->base_line_pos. */
19264 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
19267 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
19268 int precision
, Lisp_Object
*string
)
19271 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19272 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
19273 struct buffer
*b
= current_buffer
;
19281 if (!NILP (b
->read_only
))
19283 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19288 /* This differs from %* only for a modified read-only buffer. */
19289 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19291 if (!NILP (b
->read_only
))
19296 /* This differs from %* in ignoring read-only-ness. */
19297 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
19309 if (command_loop_level
> 5)
19311 p
= decode_mode_spec_buf
;
19312 for (i
= 0; i
< command_loop_level
; i
++)
19315 return decode_mode_spec_buf
;
19323 if (command_loop_level
> 5)
19325 p
= decode_mode_spec_buf
;
19326 for (i
= 0; i
< command_loop_level
; i
++)
19329 return decode_mode_spec_buf
;
19336 /* Let lots_of_dashes be a string of infinite length. */
19337 if (mode_line_target
== MODE_LINE_NOPROP
||
19338 mode_line_target
== MODE_LINE_STRING
)
19340 if (field_width
<= 0
19341 || field_width
> sizeof (lots_of_dashes
))
19343 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
19344 decode_mode_spec_buf
[i
] = '-';
19345 decode_mode_spec_buf
[i
] = '\0';
19346 return decode_mode_spec_buf
;
19349 return lots_of_dashes
;
19357 /* %c and %l are ignored in `frame-title-format'.
19358 (In redisplay_internal, the frame title is drawn _before_ the
19359 windows are updated, so the stuff which depends on actual
19360 window contents (such as %l) may fail to render properly, or
19361 even crash emacs.) */
19362 if (mode_line_target
== MODE_LINE_TITLE
)
19366 int col
= (int) current_column (); /* iftc */
19367 w
->column_number_displayed
= make_number (col
);
19368 pint2str (decode_mode_spec_buf
, field_width
, col
);
19369 return decode_mode_spec_buf
;
19373 #ifndef SYSTEM_MALLOC
19375 if (NILP (Vmemory_full
))
19378 return "!MEM FULL! ";
19385 /* %F displays the frame name. */
19386 if (!NILP (f
->title
))
19387 return (char *) SDATA (f
->title
);
19388 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
19389 return (char *) SDATA (f
->name
);
19398 int size
= ZV
- BEGV
;
19399 pint2str (decode_mode_spec_buf
, field_width
, size
);
19400 return decode_mode_spec_buf
;
19405 int size
= ZV
- BEGV
;
19406 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
19407 return decode_mode_spec_buf
;
19412 int startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
19413 int topline
, nlines
, junk
, height
;
19415 /* %c and %l are ignored in `frame-title-format'. */
19416 if (mode_line_target
== MODE_LINE_TITLE
)
19419 startpos
= XMARKER (w
->start
)->charpos
;
19420 startpos_byte
= marker_byte_position (w
->start
);
19421 height
= WINDOW_TOTAL_LINES (w
);
19423 /* If we decided that this buffer isn't suitable for line numbers,
19424 don't forget that too fast. */
19425 if (EQ (w
->base_line_pos
, w
->buffer
))
19427 /* But do forget it, if the window shows a different buffer now. */
19428 else if (BUFFERP (w
->base_line_pos
))
19429 w
->base_line_pos
= Qnil
;
19431 /* If the buffer is very big, don't waste time. */
19432 if (INTEGERP (Vline_number_display_limit
)
19433 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
19435 w
->base_line_pos
= Qnil
;
19436 w
->base_line_number
= Qnil
;
19440 if (INTEGERP (w
->base_line_number
)
19441 && INTEGERP (w
->base_line_pos
)
19442 && XFASTINT (w
->base_line_pos
) <= startpos
)
19444 line
= XFASTINT (w
->base_line_number
);
19445 linepos
= XFASTINT (w
->base_line_pos
);
19446 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
19451 linepos
= BUF_BEGV (b
);
19452 linepos_byte
= BUF_BEGV_BYTE (b
);
19455 /* Count lines from base line to window start position. */
19456 nlines
= display_count_lines (linepos
, linepos_byte
,
19460 topline
= nlines
+ line
;
19462 /* Determine a new base line, if the old one is too close
19463 or too far away, or if we did not have one.
19464 "Too close" means it's plausible a scroll-down would
19465 go back past it. */
19466 if (startpos
== BUF_BEGV (b
))
19468 w
->base_line_number
= make_number (topline
);
19469 w
->base_line_pos
= make_number (BUF_BEGV (b
));
19471 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
19472 || linepos
== BUF_BEGV (b
))
19474 int limit
= BUF_BEGV (b
);
19475 int limit_byte
= BUF_BEGV_BYTE (b
);
19477 int distance
= (height
* 2 + 30) * line_number_display_limit_width
;
19479 if (startpos
- distance
> limit
)
19481 limit
= startpos
- distance
;
19482 limit_byte
= CHAR_TO_BYTE (limit
);
19485 nlines
= display_count_lines (startpos
, startpos_byte
,
19487 - (height
* 2 + 30),
19489 /* If we couldn't find the lines we wanted within
19490 line_number_display_limit_width chars per line,
19491 give up on line numbers for this window. */
19492 if (position
== limit_byte
&& limit
== startpos
- distance
)
19494 w
->base_line_pos
= w
->buffer
;
19495 w
->base_line_number
= Qnil
;
19499 w
->base_line_number
= make_number (topline
- nlines
);
19500 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
19503 /* Now count lines from the start pos to point. */
19504 nlines
= display_count_lines (startpos
, startpos_byte
,
19505 PT_BYTE
, PT
, &junk
);
19507 /* Record that we did display the line number. */
19508 line_number_displayed
= 1;
19510 /* Make the string to show. */
19511 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
19512 return decode_mode_spec_buf
;
19515 char* p
= decode_mode_spec_buf
;
19516 int pad
= field_width
- 2;
19522 return decode_mode_spec_buf
;
19528 obj
= b
->mode_name
;
19532 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
19538 int pos
= marker_position (w
->start
);
19539 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19541 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
19543 if (pos
<= BUF_BEGV (b
))
19548 else if (pos
<= BUF_BEGV (b
))
19552 if (total
> 1000000)
19553 /* Do it differently for a large value, to avoid overflow. */
19554 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19556 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19557 /* We can't normally display a 3-digit number,
19558 so get us a 2-digit number that is close. */
19561 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19562 return decode_mode_spec_buf
;
19566 /* Display percentage of size above the bottom of the screen. */
19569 int toppos
= marker_position (w
->start
);
19570 int botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
19571 int total
= BUF_ZV (b
) - BUF_BEGV (b
);
19573 if (botpos
>= BUF_ZV (b
))
19575 if (toppos
<= BUF_BEGV (b
))
19582 if (total
> 1000000)
19583 /* Do it differently for a large value, to avoid overflow. */
19584 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
19586 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
19587 /* We can't normally display a 3-digit number,
19588 so get us a 2-digit number that is close. */
19591 if (toppos
<= BUF_BEGV (b
))
19592 sprintf (decode_mode_spec_buf
, "Top%2d%%", total
);
19594 sprintf (decode_mode_spec_buf
, "%2d%%", total
);
19595 return decode_mode_spec_buf
;
19600 /* status of process */
19601 obj
= Fget_buffer_process (Fcurrent_buffer ());
19603 return "no process";
19604 #ifdef subprocesses
19605 obj
= Fsymbol_name (Fprocess_status (obj
));
19611 int count
= inhibit_garbage_collection ();
19612 Lisp_Object val
= call1 (intern ("file-remote-p"),
19613 current_buffer
->directory
);
19614 unbind_to (count
, Qnil
);
19622 case 't': /* indicate TEXT or BINARY */
19623 #ifdef MODE_LINE_BINARY_TEXT
19624 return MODE_LINE_BINARY_TEXT (b
);
19630 /* coding-system (not including end-of-line format) */
19632 /* coding-system (including end-of-line type) */
19634 int eol_flag
= (c
== 'Z');
19635 char *p
= decode_mode_spec_buf
;
19637 if (! FRAME_WINDOW_P (f
))
19639 /* No need to mention EOL here--the terminal never needs
19640 to do EOL conversion. */
19641 p
= decode_mode_spec_coding (CODING_ID_NAME
19642 (FRAME_KEYBOARD_CODING (f
)->id
),
19644 p
= decode_mode_spec_coding (CODING_ID_NAME
19645 (FRAME_TERMINAL_CODING (f
)->id
),
19648 p
= decode_mode_spec_coding (b
->buffer_file_coding_system
,
19651 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
19652 #ifdef subprocesses
19653 obj
= Fget_buffer_process (Fcurrent_buffer ());
19654 if (PROCESSP (obj
))
19656 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
19658 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
19661 #endif /* subprocesses */
19664 return decode_mode_spec_buf
;
19671 return (char *) SDATA (obj
);
19678 /* Count up to COUNT lines starting from START / START_BYTE.
19679 But don't go beyond LIMIT_BYTE.
19680 Return the number of lines thus found (always nonnegative).
19682 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
19685 display_count_lines (int start
, int start_byte
, int limit_byte
, int count
,
19688 register unsigned char *cursor
;
19689 unsigned char *base
;
19691 register int ceiling
;
19692 register unsigned char *ceiling_addr
;
19693 int orig_count
= count
;
19695 /* If we are not in selective display mode,
19696 check only for newlines. */
19697 int selective_display
= (!NILP (current_buffer
->selective_display
)
19698 && !INTEGERP (current_buffer
->selective_display
));
19702 while (start_byte
< limit_byte
)
19704 ceiling
= BUFFER_CEILING_OF (start_byte
);
19705 ceiling
= min (limit_byte
- 1, ceiling
);
19706 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
19707 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
19710 if (selective_display
)
19711 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
19714 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
19717 if (cursor
!= ceiling_addr
)
19721 start_byte
+= cursor
- base
+ 1;
19722 *byte_pos_ptr
= start_byte
;
19726 if (++cursor
== ceiling_addr
)
19732 start_byte
+= cursor
- base
;
19737 while (start_byte
> limit_byte
)
19739 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
19740 ceiling
= max (limit_byte
, ceiling
);
19741 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
19742 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
19745 if (selective_display
)
19746 while (--cursor
!= ceiling_addr
19747 && *cursor
!= '\n' && *cursor
!= 015)
19750 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
19753 if (cursor
!= ceiling_addr
)
19757 start_byte
+= cursor
- base
+ 1;
19758 *byte_pos_ptr
= start_byte
;
19759 /* When scanning backwards, we should
19760 not count the newline posterior to which we stop. */
19761 return - orig_count
- 1;
19767 /* Here we add 1 to compensate for the last decrement
19768 of CURSOR, which took it past the valid range. */
19769 start_byte
+= cursor
- base
+ 1;
19773 *byte_pos_ptr
= limit_byte
;
19776 return - orig_count
+ count
;
19777 return orig_count
- count
;
19783 /***********************************************************************
19785 ***********************************************************************/
19787 /* Display a NUL-terminated string, starting with index START.
19789 If STRING is non-null, display that C string. Otherwise, the Lisp
19790 string LISP_STRING is displayed. There's a case that STRING is
19791 non-null and LISP_STRING is not nil. It means STRING is a string
19792 data of LISP_STRING. In that case, we display LISP_STRING while
19793 ignoring its text properties.
19795 If FACE_STRING is not nil, FACE_STRING_POS is a position in
19796 FACE_STRING. Display STRING or LISP_STRING with the face at
19797 FACE_STRING_POS in FACE_STRING:
19799 Display the string in the environment given by IT, but use the
19800 standard display table, temporarily.
19802 FIELD_WIDTH is the minimum number of output glyphs to produce.
19803 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19804 with spaces. If STRING has more characters, more than FIELD_WIDTH
19805 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
19807 PRECISION is the maximum number of characters to output from
19808 STRING. PRECISION < 0 means don't truncate the string.
19810 This is roughly equivalent to printf format specifiers:
19812 FIELD_WIDTH PRECISION PRINTF
19813 ----------------------------------------
19819 MULTIBYTE zero means do not display multibyte chars, > 0 means do
19820 display them, and < 0 means obey the current buffer's value of
19821 enable_multibyte_characters.
19823 Value is the number of columns displayed. */
19826 display_string (unsigned char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
19827 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
19828 int field_width
, int precision
, int max_x
, int multibyte
)
19830 int hpos_at_start
= it
->hpos
;
19831 int saved_face_id
= it
->face_id
;
19832 struct glyph_row
*row
= it
->glyph_row
;
19834 /* Initialize the iterator IT for iteration over STRING beginning
19835 with index START. */
19836 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
19837 precision
, field_width
, multibyte
);
19838 if (string
&& STRINGP (lisp_string
))
19839 /* LISP_STRING is the one returned by decode_mode_spec. We should
19840 ignore its text properties. */
19841 it
->stop_charpos
= -1;
19843 /* If displaying STRING, set up the face of the iterator
19844 from LISP_STRING, if that's given. */
19845 if (STRINGP (face_string
))
19851 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
19852 0, it
->region_beg_charpos
,
19853 it
->region_end_charpos
,
19854 &endptr
, it
->base_face_id
, 0);
19855 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19856 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
19859 /* Set max_x to the maximum allowed X position. Don't let it go
19860 beyond the right edge of the window. */
19862 max_x
= it
->last_visible_x
;
19864 max_x
= min (max_x
, it
->last_visible_x
);
19866 /* Skip over display elements that are not visible. because IT->w is
19868 if (it
->current_x
< it
->first_visible_x
)
19869 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
19870 MOVE_TO_POS
| MOVE_TO_X
);
19872 row
->ascent
= it
->max_ascent
;
19873 row
->height
= it
->max_ascent
+ it
->max_descent
;
19874 row
->phys_ascent
= it
->max_phys_ascent
;
19875 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19876 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19878 /* This condition is for the case that we are called with current_x
19879 past last_visible_x. */
19880 while (it
->current_x
< max_x
)
19882 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
19884 /* Get the next display element. */
19885 if (!get_next_display_element (it
))
19888 /* Produce glyphs. */
19889 x_before
= it
->current_x
;
19890 n_glyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19891 PRODUCE_GLYPHS (it
);
19893 nglyphs
= it
->glyph_row
->used
[TEXT_AREA
] - n_glyphs_before
;
19896 while (i
< nglyphs
)
19898 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19900 if (it
->line_wrap
!= TRUNCATE
19901 && x
+ glyph
->pixel_width
> max_x
)
19903 /* End of continued line or max_x reached. */
19904 if (CHAR_GLYPH_PADDING_P (*glyph
))
19906 /* A wide character is unbreakable. */
19907 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
19908 it
->current_x
= x_before
;
19912 it
->glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19917 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
19919 /* Glyph is at least partially visible. */
19921 if (x
< it
->first_visible_x
)
19922 it
->glyph_row
->x
= x
- it
->first_visible_x
;
19926 /* Glyph is off the left margin of the display area.
19927 Should not happen. */
19931 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19932 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19933 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19934 row
->phys_height
= max (row
->phys_height
,
19935 it
->max_phys_ascent
+ it
->max_phys_descent
);
19936 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19937 it
->max_extra_line_spacing
);
19938 x
+= glyph
->pixel_width
;
19942 /* Stop if max_x reached. */
19946 /* Stop at line ends. */
19947 if (ITERATOR_AT_END_OF_LINE_P (it
))
19949 it
->continuation_lines_width
= 0;
19953 set_iterator_to_next (it
, 1);
19955 /* Stop if truncating at the right edge. */
19956 if (it
->line_wrap
== TRUNCATE
19957 && it
->current_x
>= it
->last_visible_x
)
19959 /* Add truncation mark, but don't do it if the line is
19960 truncated at a padding space. */
19961 if (IT_CHARPOS (*it
) < it
->string_nchars
)
19963 if (!FRAME_WINDOW_P (it
->f
))
19967 if (it
->current_x
> it
->last_visible_x
)
19969 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19970 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19972 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19974 row
->used
[TEXT_AREA
] = i
;
19975 produce_special_glyphs (it
, IT_TRUNCATION
);
19978 produce_special_glyphs (it
, IT_TRUNCATION
);
19980 it
->glyph_row
->truncated_on_right_p
= 1;
19986 /* Maybe insert a truncation at the left. */
19987 if (it
->first_visible_x
19988 && IT_CHARPOS (*it
) > 0)
19990 if (!FRAME_WINDOW_P (it
->f
))
19991 insert_left_trunc_glyphs (it
);
19992 it
->glyph_row
->truncated_on_left_p
= 1;
19995 it
->face_id
= saved_face_id
;
19997 /* Value is number of columns displayed. */
19998 return it
->hpos
- hpos_at_start
;
20003 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
20004 appears as an element of LIST or as the car of an element of LIST.
20005 If PROPVAL is a list, compare each element against LIST in that
20006 way, and return 1/2 if any element of PROPVAL is found in LIST.
20007 Otherwise return 0. This function cannot quit.
20008 The return value is 2 if the text is invisible but with an ellipsis
20009 and 1 if it's invisible and without an ellipsis. */
20012 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
20014 register Lisp_Object tail
, proptail
;
20016 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20018 register Lisp_Object tem
;
20020 if (EQ (propval
, tem
))
20022 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
20023 return NILP (XCDR (tem
)) ? 1 : 2;
20026 if (CONSP (propval
))
20028 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
20030 Lisp_Object propelt
;
20031 propelt
= XCAR (proptail
);
20032 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
20034 register Lisp_Object tem
;
20036 if (EQ (propelt
, tem
))
20038 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
20039 return NILP (XCDR (tem
)) ? 1 : 2;
20047 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
20048 doc
: /* Non-nil if the property makes the text invisible.
20049 POS-OR-PROP can be a marker or number, in which case it is taken to be
20050 a position in the current buffer and the value of the `invisible' property
20051 is checked; or it can be some other value, which is then presumed to be the
20052 value of the `invisible' property of the text of interest.
20053 The non-nil value returned can be t for truly invisible text or something
20054 else if the text is replaced by an ellipsis. */)
20055 (Lisp_Object pos_or_prop
)
20058 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
20059 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
20061 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
20062 return (invis
== 0 ? Qnil
20064 : make_number (invis
));
20067 /* Calculate a width or height in pixels from a specification using
20068 the following elements:
20071 NUM - a (fractional) multiple of the default font width/height
20072 (NUM) - specifies exactly NUM pixels
20073 UNIT - a fixed number of pixels, see below.
20074 ELEMENT - size of a display element in pixels, see below.
20075 (NUM . SPEC) - equals NUM * SPEC
20076 (+ SPEC SPEC ...) - add pixel values
20077 (- SPEC SPEC ...) - subtract pixel values
20078 (- SPEC) - negate pixel value
20081 INT or FLOAT - a number constant
20082 SYMBOL - use symbol's (buffer local) variable binding.
20085 in - pixels per inch *)
20086 mm - pixels per 1/1000 meter *)
20087 cm - pixels per 1/100 meter *)
20088 width - width of current font in pixels.
20089 height - height of current font in pixels.
20091 *) using the ratio(s) defined in display-pixels-per-inch.
20095 left-fringe - left fringe width in pixels
20096 right-fringe - right fringe width in pixels
20098 left-margin - left margin width in pixels
20099 right-margin - right margin width in pixels
20101 scroll-bar - scroll-bar area width in pixels
20105 Pixels corresponding to 5 inches:
20108 Total width of non-text areas on left side of window (if scroll-bar is on left):
20109 '(space :width (+ left-fringe left-margin scroll-bar))
20111 Align to first text column (in header line):
20112 '(space :align-to 0)
20114 Align to middle of text area minus half the width of variable `my-image'
20115 containing a loaded image:
20116 '(space :align-to (0.5 . (- text my-image)))
20118 Width of left margin minus width of 1 character in the default font:
20119 '(space :width (- left-margin 1))
20121 Width of left margin minus width of 2 characters in the current font:
20122 '(space :width (- left-margin (2 . width)))
20124 Center 1 character over left-margin (in header line):
20125 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
20127 Different ways to express width of left fringe plus left margin minus one pixel:
20128 '(space :width (- (+ left-fringe left-margin) (1)))
20129 '(space :width (+ left-fringe left-margin (- (1))))
20130 '(space :width (+ left-fringe left-margin (-1)))
20134 #define NUMVAL(X) \
20135 ((INTEGERP (X) || FLOATP (X)) \
20140 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
20141 struct font
*font
, int width_p
, int *align_to
)
20145 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
20146 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
20149 return OK_PIXELS (0);
20151 xassert (FRAME_LIVE_P (it
->f
));
20153 if (SYMBOLP (prop
))
20155 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
20157 char *unit
= SDATA (SYMBOL_NAME (prop
));
20159 if (unit
[0] == 'i' && unit
[1] == 'n')
20161 else if (unit
[0] == 'm' && unit
[1] == 'm')
20163 else if (unit
[0] == 'c' && unit
[1] == 'm')
20170 #ifdef HAVE_WINDOW_SYSTEM
20171 if (FRAME_WINDOW_P (it
->f
)
20173 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
20174 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
20176 return OK_PIXELS (ppi
/ pixels
);
20179 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
20180 || (CONSP (Vdisplay_pixels_per_inch
)
20182 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
20183 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
20185 return OK_PIXELS (ppi
/ pixels
);
20191 #ifdef HAVE_WINDOW_SYSTEM
20192 if (EQ (prop
, Qheight
))
20193 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
20194 if (EQ (prop
, Qwidth
))
20195 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
20197 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
20198 return OK_PIXELS (1);
20201 if (EQ (prop
, Qtext
))
20202 return OK_PIXELS (width_p
20203 ? window_box_width (it
->w
, TEXT_AREA
)
20204 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
20206 if (align_to
&& *align_to
< 0)
20209 if (EQ (prop
, Qleft
))
20210 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
20211 if (EQ (prop
, Qright
))
20212 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
20213 if (EQ (prop
, Qcenter
))
20214 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
20215 + window_box_width (it
->w
, TEXT_AREA
) / 2);
20216 if (EQ (prop
, Qleft_fringe
))
20217 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20218 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
20219 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
20220 if (EQ (prop
, Qright_fringe
))
20221 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20222 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20223 : window_box_right_offset (it
->w
, TEXT_AREA
));
20224 if (EQ (prop
, Qleft_margin
))
20225 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
20226 if (EQ (prop
, Qright_margin
))
20227 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
20228 if (EQ (prop
, Qscroll_bar
))
20229 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
20231 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
20232 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
20233 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20238 if (EQ (prop
, Qleft_fringe
))
20239 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
20240 if (EQ (prop
, Qright_fringe
))
20241 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
20242 if (EQ (prop
, Qleft_margin
))
20243 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
20244 if (EQ (prop
, Qright_margin
))
20245 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
20246 if (EQ (prop
, Qscroll_bar
))
20247 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
20250 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
20253 if (INTEGERP (prop
) || FLOATP (prop
))
20255 int base_unit
= (width_p
20256 ? FRAME_COLUMN_WIDTH (it
->f
)
20257 : FRAME_LINE_HEIGHT (it
->f
));
20258 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
20263 Lisp_Object car
= XCAR (prop
);
20264 Lisp_Object cdr
= XCDR (prop
);
20268 #ifdef HAVE_WINDOW_SYSTEM
20269 if (FRAME_WINDOW_P (it
->f
)
20270 && valid_image_p (prop
))
20272 int id
= lookup_image (it
->f
, prop
);
20273 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
20275 return OK_PIXELS (width_p
? img
->width
: img
->height
);
20278 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
20284 while (CONSP (cdr
))
20286 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
20287 font
, width_p
, align_to
))
20290 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
20295 if (EQ (car
, Qminus
))
20297 return OK_PIXELS (pixels
);
20300 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
20303 if (INTEGERP (car
) || FLOATP (car
))
20306 pixels
= XFLOATINT (car
);
20308 return OK_PIXELS (pixels
);
20309 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
20310 font
, width_p
, align_to
))
20311 return OK_PIXELS (pixels
* fact
);
20322 /***********************************************************************
20324 ***********************************************************************/
20326 #ifdef HAVE_WINDOW_SYSTEM
20331 dump_glyph_string (s
)
20332 struct glyph_string
*s
;
20334 fprintf (stderr
, "glyph string\n");
20335 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
20336 s
->x
, s
->y
, s
->width
, s
->height
);
20337 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
20338 fprintf (stderr
, " hl = %d\n", s
->hl
);
20339 fprintf (stderr
, " left overhang = %d, right = %d\n",
20340 s
->left_overhang
, s
->right_overhang
);
20341 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
20342 fprintf (stderr
, " extends to end of line = %d\n",
20343 s
->extends_to_end_of_line_p
);
20344 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
20345 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
20348 #endif /* GLYPH_DEBUG */
20350 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
20351 of XChar2b structures for S; it can't be allocated in
20352 init_glyph_string because it must be allocated via `alloca'. W
20353 is the window on which S is drawn. ROW and AREA are the glyph row
20354 and area within the row from which S is constructed. START is the
20355 index of the first glyph structure covered by S. HL is a
20356 face-override for drawing S. */
20359 #define OPTIONAL_HDC(hdc) HDC hdc,
20360 #define DECLARE_HDC(hdc) HDC hdc;
20361 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
20362 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
20365 #ifndef OPTIONAL_HDC
20366 #define OPTIONAL_HDC(hdc)
20367 #define DECLARE_HDC(hdc)
20368 #define ALLOCATE_HDC(hdc, f)
20369 #define RELEASE_HDC(hdc, f)
20373 init_glyph_string (struct glyph_string
*s
,
20375 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
20376 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
20378 memset (s
, 0, sizeof *s
);
20380 s
->f
= XFRAME (w
->frame
);
20384 s
->display
= FRAME_X_DISPLAY (s
->f
);
20385 s
->window
= FRAME_X_WINDOW (s
->f
);
20386 s
->char2b
= char2b
;
20390 s
->first_glyph
= row
->glyphs
[area
] + start
;
20391 s
->height
= row
->height
;
20392 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
20393 s
->ybase
= s
->y
+ row
->ascent
;
20397 /* Append the list of glyph strings with head H and tail T to the list
20398 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
20401 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20402 struct glyph_string
*h
, struct glyph_string
*t
)
20416 /* Prepend the list of glyph strings with head H and tail T to the
20417 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
20421 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
20422 struct glyph_string
*h
, struct glyph_string
*t
)
20436 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
20437 Set *HEAD and *TAIL to the resulting list. */
20440 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
20441 struct glyph_string
*s
)
20443 s
->next
= s
->prev
= NULL
;
20444 append_glyph_string_lists (head
, tail
, s
, s
);
20448 /* Get face and two-byte form of character C in face FACE_ID on frame
20449 F. The encoding of C is returned in *CHAR2B. MULTIBYTE_P non-zero
20450 means we want to display multibyte text. DISPLAY_P non-zero means
20451 make sure that X resources for the face returned are allocated.
20452 Value is a pointer to a realized face that is ready for display if
20453 DISPLAY_P is non-zero. */
20455 static INLINE
struct face
*
20456 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
20457 XChar2b
*char2b
, int multibyte_p
, int display_p
)
20459 struct face
*face
= FACE_FROM_ID (f
, face_id
);
20463 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
20465 if (code
!= FONT_INVALID_CODE
)
20466 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20468 STORE_XCHAR2B (char2b
, 0, 0);
20471 /* Make sure X resources of the face are allocated. */
20472 #ifdef HAVE_X_WINDOWS
20476 xassert (face
!= NULL
);
20477 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20484 /* Get face and two-byte form of character glyph GLYPH on frame F.
20485 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
20486 a pointer to a realized face that is ready for display. */
20488 static INLINE
struct face
*
20489 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
20490 XChar2b
*char2b
, int *two_byte_p
)
20494 xassert (glyph
->type
== CHAR_GLYPH
);
20495 face
= FACE_FROM_ID (f
, glyph
->face_id
);
20502 unsigned code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
20504 if (code
!= FONT_INVALID_CODE
)
20505 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
20507 STORE_XCHAR2B (char2b
, 0, 0);
20510 /* Make sure X resources of the face are allocated. */
20511 xassert (face
!= NULL
);
20512 PREPARE_FACE_FOR_DISPLAY (f
, face
);
20517 /* Fill glyph string S with composition components specified by S->cmp.
20519 BASE_FACE is the base face of the composition.
20520 S->cmp_from is the index of the first component for S.
20522 OVERLAPS non-zero means S should draw the foreground only, and use
20523 its physical height for clipping. See also draw_glyphs.
20525 Value is the index of a component not in S. */
20528 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
20532 /* For all glyphs of this composition, starting at the offset
20533 S->cmp_from, until we reach the end of the definition or encounter a
20534 glyph that requires the different face, add it to S. */
20539 s
->for_overlaps
= overlaps
;
20542 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
20544 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
20548 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
20551 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
20552 s
->char2b
+ i
, 1, 1);
20558 s
->font
= s
->face
->font
;
20560 else if (s
->face
!= face
)
20568 /* All glyph strings for the same composition has the same width,
20569 i.e. the width set for the first component of the composition. */
20570 s
->width
= s
->first_glyph
->pixel_width
;
20572 /* If the specified font could not be loaded, use the frame's
20573 default font, but record the fact that we couldn't load it in
20574 the glyph string so that we can draw rectangles for the
20575 characters of the glyph string. */
20576 if (s
->font
== NULL
)
20578 s
->font_not_found_p
= 1;
20579 s
->font
= FRAME_FONT (s
->f
);
20582 /* Adjust base line for subscript/superscript text. */
20583 s
->ybase
+= s
->first_glyph
->voffset
;
20585 /* This glyph string must always be drawn with 16-bit functions. */
20592 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
20593 int start
, int end
, int overlaps
)
20595 struct glyph
*glyph
, *last
;
20596 Lisp_Object lgstring
;
20599 s
->for_overlaps
= overlaps
;
20600 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20601 last
= s
->row
->glyphs
[s
->area
] + end
;
20602 s
->cmp_id
= glyph
->u
.cmp
.id
;
20603 s
->cmp_from
= glyph
->u
.cmp
.from
;
20604 s
->cmp_to
= glyph
->u
.cmp
.to
+ 1;
20605 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20606 lgstring
= composition_gstring_from_id (s
->cmp_id
);
20607 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
20609 while (glyph
< last
20610 && glyph
->u
.cmp
.automatic
20611 && glyph
->u
.cmp
.id
== s
->cmp_id
20612 && s
->cmp_to
== glyph
->u
.cmp
.from
)
20613 s
->cmp_to
= (glyph
++)->u
.cmp
.to
+ 1;
20615 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
20617 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
20618 unsigned code
= LGLYPH_CODE (lglyph
);
20620 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
20622 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
20623 return glyph
- s
->row
->glyphs
[s
->area
];
20627 /* Fill glyph string S from a sequence of character glyphs.
20629 FACE_ID is the face id of the string. START is the index of the
20630 first glyph to consider, END is the index of the last + 1.
20631 OVERLAPS non-zero means S should draw the foreground only, and use
20632 its physical height for clipping. See also draw_glyphs.
20634 Value is the index of the first glyph not in S. */
20637 fill_glyph_string (struct glyph_string
*s
, int face_id
,
20638 int start
, int end
, int overlaps
)
20640 struct glyph
*glyph
, *last
;
20642 int glyph_not_available_p
;
20644 xassert (s
->f
== XFRAME (s
->w
->frame
));
20645 xassert (s
->nchars
== 0);
20646 xassert (start
>= 0 && end
> start
);
20648 s
->for_overlaps
= overlaps
;
20649 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20650 last
= s
->row
->glyphs
[s
->area
] + end
;
20651 voffset
= glyph
->voffset
;
20652 s
->padding_p
= glyph
->padding_p
;
20653 glyph_not_available_p
= glyph
->glyph_not_available_p
;
20655 while (glyph
< last
20656 && glyph
->type
== CHAR_GLYPH
20657 && glyph
->voffset
== voffset
20658 /* Same face id implies same font, nowadays. */
20659 && glyph
->face_id
== face_id
20660 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
20664 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
20665 s
->char2b
+ s
->nchars
,
20667 s
->two_byte_p
= two_byte_p
;
20669 xassert (s
->nchars
<= end
- start
);
20670 s
->width
+= glyph
->pixel_width
;
20671 if (glyph
++->padding_p
!= s
->padding_p
)
20675 s
->font
= s
->face
->font
;
20677 /* If the specified font could not be loaded, use the frame's font,
20678 but record the fact that we couldn't load it in
20679 S->font_not_found_p so that we can draw rectangles for the
20680 characters of the glyph string. */
20681 if (s
->font
== NULL
|| glyph_not_available_p
)
20683 s
->font_not_found_p
= 1;
20684 s
->font
= FRAME_FONT (s
->f
);
20687 /* Adjust base line for subscript/superscript text. */
20688 s
->ybase
+= voffset
;
20690 xassert (s
->face
&& s
->face
->gc
);
20691 return glyph
- s
->row
->glyphs
[s
->area
];
20695 /* Fill glyph string S from image glyph S->first_glyph. */
20698 fill_image_glyph_string (struct glyph_string
*s
)
20700 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
20701 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
20703 s
->slice
= s
->first_glyph
->slice
;
20704 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
20705 s
->font
= s
->face
->font
;
20706 s
->width
= s
->first_glyph
->pixel_width
;
20708 /* Adjust base line for subscript/superscript text. */
20709 s
->ybase
+= s
->first_glyph
->voffset
;
20713 /* Fill glyph string S from a sequence of stretch glyphs.
20715 ROW is the glyph row in which the glyphs are found, AREA is the
20716 area within the row. START is the index of the first glyph to
20717 consider, END is the index of the last + 1.
20719 Value is the index of the first glyph not in S. */
20722 fill_stretch_glyph_string (struct glyph_string
*s
, struct glyph_row
*row
,
20723 enum glyph_row_area area
, int start
, int end
)
20725 struct glyph
*glyph
, *last
;
20726 int voffset
, face_id
;
20728 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
20730 glyph
= s
->row
->glyphs
[s
->area
] + start
;
20731 last
= s
->row
->glyphs
[s
->area
] + end
;
20732 face_id
= glyph
->face_id
;
20733 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
20734 s
->font
= s
->face
->font
;
20735 s
->width
= glyph
->pixel_width
;
20737 voffset
= glyph
->voffset
;
20741 && glyph
->type
== STRETCH_GLYPH
20742 && glyph
->voffset
== voffset
20743 && glyph
->face_id
== face_id
);
20745 s
->width
+= glyph
->pixel_width
;
20747 /* Adjust base line for subscript/superscript text. */
20748 s
->ybase
+= voffset
;
20750 /* The case that face->gc == 0 is handled when drawing the glyph
20751 string by calling PREPARE_FACE_FOR_DISPLAY. */
20753 return glyph
- s
->row
->glyphs
[s
->area
];
20756 static struct font_metrics
*
20757 get_per_char_metric (struct frame
*f
, struct font
*font
, XChar2b
*char2b
)
20759 static struct font_metrics metrics
;
20760 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
20762 if (! font
|| code
== FONT_INVALID_CODE
)
20764 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
20769 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
20770 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
20771 assumed to be zero. */
20774 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
20776 *left
= *right
= 0;
20778 if (glyph
->type
== CHAR_GLYPH
)
20782 struct font_metrics
*pcm
;
20784 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
20785 if (face
->font
&& (pcm
= get_per_char_metric (f
, face
->font
, &char2b
)))
20787 if (pcm
->rbearing
> pcm
->width
)
20788 *right
= pcm
->rbearing
- pcm
->width
;
20789 if (pcm
->lbearing
< 0)
20790 *left
= -pcm
->lbearing
;
20793 else if (glyph
->type
== COMPOSITE_GLYPH
)
20795 if (! glyph
->u
.cmp
.automatic
)
20797 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
20799 if (cmp
->rbearing
> cmp
->pixel_width
)
20800 *right
= cmp
->rbearing
- cmp
->pixel_width
;
20801 if (cmp
->lbearing
< 0)
20802 *left
= - cmp
->lbearing
;
20806 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
20807 struct font_metrics metrics
;
20809 composition_gstring_width (gstring
, glyph
->u
.cmp
.from
,
20810 glyph
->u
.cmp
.to
+ 1, &metrics
);
20811 if (metrics
.rbearing
> metrics
.width
)
20812 *right
= metrics
.rbearing
- metrics
.width
;
20813 if (metrics
.lbearing
< 0)
20814 *left
= - metrics
.lbearing
;
20820 /* Return the index of the first glyph preceding glyph string S that
20821 is overwritten by S because of S's left overhang. Value is -1
20822 if no glyphs are overwritten. */
20825 left_overwritten (struct glyph_string
*s
)
20829 if (s
->left_overhang
)
20832 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20833 int first
= s
->first_glyph
- glyphs
;
20835 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
20836 x
-= glyphs
[i
].pixel_width
;
20847 /* Return the index of the first glyph preceding glyph string S that
20848 is overwriting S because of its right overhang. Value is -1 if no
20849 glyph in front of S overwrites S. */
20852 left_overwriting (struct glyph_string
*s
)
20855 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20856 int first
= s
->first_glyph
- glyphs
;
20860 for (i
= first
- 1; i
>= 0; --i
)
20863 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20866 x
-= glyphs
[i
].pixel_width
;
20873 /* Return the index of the last glyph following glyph string S that is
20874 overwritten by S because of S's right overhang. Value is -1 if
20875 no such glyph is found. */
20878 right_overwritten (struct glyph_string
*s
)
20882 if (s
->right_overhang
)
20885 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20886 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20887 int end
= s
->row
->used
[s
->area
];
20889 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
20890 x
+= glyphs
[i
].pixel_width
;
20899 /* Return the index of the last glyph following glyph string S that
20900 overwrites S because of its left overhang. Value is negative
20901 if no such glyph is found. */
20904 right_overwriting (struct glyph_string
*s
)
20907 int end
= s
->row
->used
[s
->area
];
20908 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
20909 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
20913 for (i
= first
; i
< end
; ++i
)
20916 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
20919 x
+= glyphs
[i
].pixel_width
;
20926 /* Set background width of glyph string S. START is the index of the
20927 first glyph following S. LAST_X is the right-most x-position + 1
20928 in the drawing area. */
20931 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
20933 /* If the face of this glyph string has to be drawn to the end of
20934 the drawing area, set S->extends_to_end_of_line_p. */
20936 if (start
== s
->row
->used
[s
->area
]
20937 && s
->area
== TEXT_AREA
20938 && ((s
->row
->fill_line_p
20939 && (s
->hl
== DRAW_NORMAL_TEXT
20940 || s
->hl
== DRAW_IMAGE_RAISED
20941 || s
->hl
== DRAW_IMAGE_SUNKEN
))
20942 || s
->hl
== DRAW_MOUSE_FACE
))
20943 s
->extends_to_end_of_line_p
= 1;
20945 /* If S extends its face to the end of the line, set its
20946 background_width to the distance to the right edge of the drawing
20948 if (s
->extends_to_end_of_line_p
)
20949 s
->background_width
= last_x
- s
->x
+ 1;
20951 s
->background_width
= s
->width
;
20955 /* Compute overhangs and x-positions for glyph string S and its
20956 predecessors, or successors. X is the starting x-position for S.
20957 BACKWARD_P non-zero means process predecessors. */
20960 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
20966 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20967 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20977 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
20978 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
20988 /* The following macros are only called from draw_glyphs below.
20989 They reference the following parameters of that function directly:
20990 `w', `row', `area', and `overlap_p'
20991 as well as the following local variables:
20992 `s', `f', and `hdc' (in W32) */
20995 /* On W32, silently add local `hdc' variable to argument list of
20996 init_glyph_string. */
20997 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
20998 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
21000 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
21001 init_glyph_string (s, char2b, w, row, area, start, hl)
21004 /* Add a glyph string for a stretch glyph to the list of strings
21005 between HEAD and TAIL. START is the index of the stretch glyph in
21006 row area AREA of glyph row ROW. END is the index of the last glyph
21007 in that glyph row area. X is the current output position assigned
21008 to the new glyph string constructed. HL overrides that face of the
21009 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21010 is the right-most x-position of the drawing area. */
21012 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
21013 and below -- keep them on one line. */
21014 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21017 s = (struct glyph_string *) alloca (sizeof *s); \
21018 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21019 START = fill_stretch_glyph_string (s, row, area, START, END); \
21020 append_glyph_string (&HEAD, &TAIL, s); \
21026 /* Add a glyph string for an image glyph to the list of strings
21027 between HEAD and TAIL. START is the index of the image glyph in
21028 row area AREA of glyph row ROW. END is the index of the last glyph
21029 in that glyph row area. X is the current output position assigned
21030 to the new glyph string constructed. HL overrides that face of the
21031 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
21032 is the right-most x-position of the drawing area. */
21034 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21037 s = (struct glyph_string *) alloca (sizeof *s); \
21038 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
21039 fill_image_glyph_string (s); \
21040 append_glyph_string (&HEAD, &TAIL, s); \
21047 /* Add a glyph string for a sequence of character glyphs to the list
21048 of strings between HEAD and TAIL. START is the index of the first
21049 glyph in row area AREA of glyph row ROW that is part of the new
21050 glyph string. END is the index of the last glyph in that glyph row
21051 area. X is the current output position assigned to the new glyph
21052 string constructed. HL overrides that face of the glyph; e.g. it
21053 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
21054 right-most x-position of the drawing area. */
21056 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21062 face_id = (row)->glyphs[area][START].face_id; \
21064 s = (struct glyph_string *) alloca (sizeof *s); \
21065 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
21066 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21067 append_glyph_string (&HEAD, &TAIL, s); \
21069 START = fill_glyph_string (s, face_id, START, END, overlaps); \
21074 /* Add a glyph string for a composite sequence to the list of strings
21075 between HEAD and TAIL. START is the index of the first glyph in
21076 row area AREA of glyph row ROW that is part of the new glyph
21077 string. END is the index of the last glyph in that glyph row area.
21078 X is the current output position assigned to the new glyph string
21079 constructed. HL overrides that face of the glyph; e.g. it is
21080 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
21081 x-position of the drawing area. */
21083 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21085 int face_id = (row)->glyphs[area][START].face_id; \
21086 struct face *base_face = FACE_FROM_ID (f, face_id); \
21087 int cmp_id = (row)->glyphs[area][START].u.cmp.id; \
21088 struct composition *cmp = composition_table[cmp_id]; \
21090 struct glyph_string *first_s; \
21093 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
21095 /* Make glyph_strings for each glyph sequence that is drawable by \
21096 the same face, and append them to HEAD/TAIL. */ \
21097 for (n = 0; n < cmp->glyph_len;) \
21099 s = (struct glyph_string *) alloca (sizeof *s); \
21100 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21101 append_glyph_string (&(HEAD), &(TAIL), s); \
21107 n = fill_composite_glyph_string (s, base_face, overlaps); \
21115 /* Add a glyph string for a glyph-string sequence to the list of strings
21116 between HEAD and TAIL. */
21118 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
21122 Lisp_Object gstring; \
21124 face_id = (row)->glyphs[area][START].face_id; \
21125 gstring = (composition_gstring_from_id \
21126 ((row)->glyphs[area][START].u.cmp.id)); \
21127 s = (struct glyph_string *) alloca (sizeof *s); \
21128 char2b = (XChar2b *) alloca ((sizeof *char2b) \
21129 * LGSTRING_GLYPH_LEN (gstring)); \
21130 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
21131 append_glyph_string (&(HEAD), &(TAIL), s); \
21133 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
21137 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
21138 of AREA of glyph row ROW on window W between indices START and END.
21139 HL overrides the face for drawing glyph strings, e.g. it is
21140 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
21141 x-positions of the drawing area.
21143 This is an ugly monster macro construct because we must use alloca
21144 to allocate glyph strings (because draw_glyphs can be called
21145 asynchronously). */
21147 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
21150 HEAD = TAIL = NULL; \
21151 while (START < END) \
21153 struct glyph *first_glyph = (row)->glyphs[area] + START; \
21154 switch (first_glyph->type) \
21157 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
21161 case COMPOSITE_GLYPH: \
21162 if (first_glyph->u.cmp.automatic) \
21163 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
21166 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
21170 case STRETCH_GLYPH: \
21171 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
21175 case IMAGE_GLYPH: \
21176 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
21186 set_glyph_string_background_width (s, START, LAST_X); \
21193 /* Draw glyphs between START and END in AREA of ROW on window W,
21194 starting at x-position X. X is relative to AREA in W. HL is a
21195 face-override with the following meaning:
21197 DRAW_NORMAL_TEXT draw normally
21198 DRAW_CURSOR draw in cursor face
21199 DRAW_MOUSE_FACE draw in mouse face.
21200 DRAW_INVERSE_VIDEO draw in mode line face
21201 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
21202 DRAW_IMAGE_RAISED draw an image with a raised relief around it
21204 If OVERLAPS is non-zero, draw only the foreground of characters and
21205 clip to the physical height of ROW. Non-zero value also defines
21206 the overlapping part to be drawn:
21208 OVERLAPS_PRED overlap with preceding rows
21209 OVERLAPS_SUCC overlap with succeeding rows
21210 OVERLAPS_BOTH overlap with both preceding/succeeding rows
21211 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
21213 Value is the x-position reached, relative to AREA of W. */
21216 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
21217 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
21218 enum draw_glyphs_face hl
, int overlaps
)
21220 struct glyph_string
*head
, *tail
;
21221 struct glyph_string
*s
;
21222 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
21223 int i
, j
, x_reached
, last_x
, area_left
= 0;
21224 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21227 ALLOCATE_HDC (hdc
, f
);
21229 /* Let's rather be paranoid than getting a SEGV. */
21230 end
= min (end
, row
->used
[area
]);
21231 start
= max (0, start
);
21232 start
= min (end
, start
);
21234 /* Translate X to frame coordinates. Set last_x to the right
21235 end of the drawing area. */
21236 if (row
->full_width_p
)
21238 /* X is relative to the left edge of W, without scroll bars
21240 area_left
= WINDOW_LEFT_EDGE_X (w
);
21241 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
21245 area_left
= window_box_left (w
, area
);
21246 last_x
= area_left
+ window_box_width (w
, area
);
21250 /* Build a doubly-linked list of glyph_string structures between
21251 head and tail from what we have to draw. Note that the macro
21252 BUILD_GLYPH_STRINGS will modify its start parameter. That's
21253 the reason we use a separate variable `i'. */
21255 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
21257 x_reached
= tail
->x
+ tail
->background_width
;
21261 /* If there are any glyphs with lbearing < 0 or rbearing > width in
21262 the row, redraw some glyphs in front or following the glyph
21263 strings built above. */
21264 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
21266 struct glyph_string
*h
, *t
;
21267 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
21268 int mouse_beg_col
, mouse_end_col
, check_mouse_face
= 0;
21271 /* If mouse highlighting is on, we may need to draw adjacent
21272 glyphs using mouse-face highlighting. */
21273 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
21275 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
21277 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
21278 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
21280 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
21282 check_mouse_face
= 1;
21283 mouse_beg_col
= (row
== mouse_beg_row
)
21284 ? dpyinfo
->mouse_face_beg_col
: 0;
21285 mouse_end_col
= (row
== mouse_end_row
)
21286 ? dpyinfo
->mouse_face_end_col
21287 : row
->used
[TEXT_AREA
];
21291 /* Compute overhangs for all glyph strings. */
21292 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
21293 for (s
= head
; s
; s
= s
->next
)
21294 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
21296 /* Prepend glyph strings for glyphs in front of the first glyph
21297 string that are overwritten because of the first glyph
21298 string's left overhang. The background of all strings
21299 prepended must be drawn because the first glyph string
21301 i
= left_overwritten (head
);
21304 enum draw_glyphs_face overlap_hl
;
21306 /* If this row contains mouse highlighting, attempt to draw
21307 the overlapped glyphs with the correct highlight. This
21308 code fails if the overlap encompasses more than one glyph
21309 and mouse-highlight spans only some of these glyphs.
21310 However, making it work perfectly involves a lot more
21311 code, and I don't know if the pathological case occurs in
21312 practice, so we'll stick to this for now. --- cyd */
21313 if (check_mouse_face
21314 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21315 overlap_hl
= DRAW_MOUSE_FACE
;
21317 overlap_hl
= DRAW_NORMAL_TEXT
;
21320 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
21321 overlap_hl
, dummy_x
, last_x
);
21323 compute_overhangs_and_x (t
, head
->x
, 1);
21324 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21328 /* Prepend glyph strings for glyphs in front of the first glyph
21329 string that overwrite that glyph string because of their
21330 right overhang. For these strings, only the foreground must
21331 be drawn, because it draws over the glyph string at `head'.
21332 The background must not be drawn because this would overwrite
21333 right overhangs of preceding glyphs for which no glyph
21335 i
= left_overwriting (head
);
21338 enum draw_glyphs_face overlap_hl
;
21340 if (check_mouse_face
21341 && mouse_beg_col
< start
&& mouse_end_col
> i
)
21342 overlap_hl
= DRAW_MOUSE_FACE
;
21344 overlap_hl
= DRAW_NORMAL_TEXT
;
21347 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
21348 overlap_hl
, dummy_x
, last_x
);
21349 for (s
= h
; s
; s
= s
->next
)
21350 s
->background_filled_p
= 1;
21351 compute_overhangs_and_x (t
, head
->x
, 1);
21352 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
21355 /* Append glyphs strings for glyphs following the last glyph
21356 string tail that are overwritten by tail. The background of
21357 these strings has to be drawn because tail's foreground draws
21359 i
= right_overwritten (tail
);
21362 enum draw_glyphs_face overlap_hl
;
21364 if (check_mouse_face
21365 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21366 overlap_hl
= DRAW_MOUSE_FACE
;
21368 overlap_hl
= DRAW_NORMAL_TEXT
;
21370 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21371 overlap_hl
, x
, last_x
);
21372 /* Because BUILD_GLYPH_STRINGS updates the first argument,
21373 we don't have `end = i;' here. */
21374 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21375 append_glyph_string_lists (&head
, &tail
, h
, t
);
21379 /* Append glyph strings for glyphs following the last glyph
21380 string tail that overwrite tail. The foreground of such
21381 glyphs has to be drawn because it writes into the background
21382 of tail. The background must not be drawn because it could
21383 paint over the foreground of following glyphs. */
21384 i
= right_overwriting (tail
);
21387 enum draw_glyphs_face overlap_hl
;
21388 if (check_mouse_face
21389 && mouse_beg_col
< i
&& mouse_end_col
> end
)
21390 overlap_hl
= DRAW_MOUSE_FACE
;
21392 overlap_hl
= DRAW_NORMAL_TEXT
;
21395 i
++; /* We must include the Ith glyph. */
21396 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
21397 overlap_hl
, x
, last_x
);
21398 for (s
= h
; s
; s
= s
->next
)
21399 s
->background_filled_p
= 1;
21400 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
21401 append_glyph_string_lists (&head
, &tail
, h
, t
);
21403 if (clip_head
|| clip_tail
)
21404 for (s
= head
; s
; s
= s
->next
)
21406 s
->clip_head
= clip_head
;
21407 s
->clip_tail
= clip_tail
;
21411 /* Draw all strings. */
21412 for (s
= head
; s
; s
= s
->next
)
21413 FRAME_RIF (f
)->draw_glyph_string (s
);
21416 /* When focus a sole frame and move horizontally, this sets on_p to 0
21417 causing a failure to erase prev cursor position. */
21418 if (area
== TEXT_AREA
21419 && !row
->full_width_p
21420 /* When drawing overlapping rows, only the glyph strings'
21421 foreground is drawn, which doesn't erase a cursor
21425 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
21426 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
21427 : (tail
? tail
->x
+ tail
->background_width
: x
));
21431 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
21432 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
21436 /* Value is the x-position up to which drawn, relative to AREA of W.
21437 This doesn't include parts drawn because of overhangs. */
21438 if (row
->full_width_p
)
21439 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
21441 x_reached
-= area_left
;
21443 RELEASE_HDC (hdc
, f
);
21448 /* Expand row matrix if too narrow. Don't expand if area
21451 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
21453 if (!fonts_changed_p \
21454 && (it->glyph_row->glyphs[area] \
21455 < it->glyph_row->glyphs[area + 1])) \
21457 it->w->ncols_scale_factor++; \
21458 fonts_changed_p = 1; \
21462 /* Store one glyph for IT->char_to_display in IT->glyph_row.
21463 Called from x_produce_glyphs when IT->glyph_row is non-null. */
21466 append_glyph (struct it
*it
)
21468 struct glyph
*glyph
;
21469 enum glyph_row_area area
= it
->area
;
21471 xassert (it
->glyph_row
);
21472 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
21474 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21475 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21477 /* If the glyph row is reversed, we need to prepend the glyph
21478 rather than append it. */
21479 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21483 /* Make room for the additional glyph. */
21484 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21486 glyph
= it
->glyph_row
->glyphs
[area
];
21488 glyph
->charpos
= CHARPOS (it
->position
);
21489 glyph
->object
= it
->object
;
21490 if (it
->pixel_width
> 0)
21492 glyph
->pixel_width
= it
->pixel_width
;
21493 glyph
->padding_p
= 0;
21497 /* Assure at least 1-pixel width. Otherwise, cursor can't
21498 be displayed correctly. */
21499 glyph
->pixel_width
= 1;
21500 glyph
->padding_p
= 1;
21502 glyph
->ascent
= it
->ascent
;
21503 glyph
->descent
= it
->descent
;
21504 glyph
->voffset
= it
->voffset
;
21505 glyph
->type
= CHAR_GLYPH
;
21506 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21507 glyph
->multibyte_p
= it
->multibyte_p
;
21508 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21509 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21510 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21511 || it
->phys_descent
> it
->descent
);
21512 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
21513 glyph
->face_id
= it
->face_id
;
21514 glyph
->u
.ch
= it
->char_to_display
;
21515 glyph
->slice
= null_glyph_slice
;
21516 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21519 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21520 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21522 glyph
->bidi_type
= it
->bidi_it
.type
;
21526 glyph
->resolved_level
= 0;
21527 glyph
->bidi_type
= UNKNOWN_BT
;
21529 ++it
->glyph_row
->used
[area
];
21532 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21535 /* Store one glyph for the composition IT->cmp_it.id in
21536 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
21540 append_composite_glyph (struct it
*it
)
21542 struct glyph
*glyph
;
21543 enum glyph_row_area area
= it
->area
;
21545 xassert (it
->glyph_row
);
21547 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21548 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21550 /* If the glyph row is reversed, we need to prepend the glyph
21551 rather than append it. */
21552 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
21556 /* Make room for the new glyph. */
21557 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
21559 glyph
= it
->glyph_row
->glyphs
[it
->area
];
21561 glyph
->charpos
= it
->cmp_it
.charpos
;
21562 glyph
->object
= it
->object
;
21563 glyph
->pixel_width
= it
->pixel_width
;
21564 glyph
->ascent
= it
->ascent
;
21565 glyph
->descent
= it
->descent
;
21566 glyph
->voffset
= it
->voffset
;
21567 glyph
->type
= COMPOSITE_GLYPH
;
21568 if (it
->cmp_it
.ch
< 0)
21570 glyph
->u
.cmp
.automatic
= 0;
21571 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21575 glyph
->u
.cmp
.automatic
= 1;
21576 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
21577 glyph
->u
.cmp
.from
= it
->cmp_it
.from
;
21578 glyph
->u
.cmp
.to
= it
->cmp_it
.to
- 1;
21580 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21581 glyph
->multibyte_p
= it
->multibyte_p
;
21582 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21583 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21584 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
21585 || it
->phys_descent
> it
->descent
);
21586 glyph
->padding_p
= 0;
21587 glyph
->glyph_not_available_p
= 0;
21588 glyph
->face_id
= it
->face_id
;
21589 glyph
->slice
= null_glyph_slice
;
21590 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21593 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21594 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21596 glyph
->bidi_type
= it
->bidi_it
.type
;
21598 ++it
->glyph_row
->used
[area
];
21601 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21605 /* Change IT->ascent and IT->height according to the setting of
21609 take_vertical_position_into_account (struct it
*it
)
21613 if (it
->voffset
< 0)
21614 /* Increase the ascent so that we can display the text higher
21616 it
->ascent
-= it
->voffset
;
21618 /* Increase the descent so that we can display the text lower
21620 it
->descent
+= it
->voffset
;
21625 /* Produce glyphs/get display metrics for the image IT is loaded with.
21626 See the description of struct display_iterator in dispextern.h for
21627 an overview of struct display_iterator. */
21630 produce_image_glyph (struct it
*it
)
21634 int glyph_ascent
, crop
;
21635 struct glyph_slice slice
;
21637 xassert (it
->what
== IT_IMAGE
);
21639 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21641 /* Make sure X resources of the face is loaded. */
21642 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21644 if (it
->image_id
< 0)
21646 /* Fringe bitmap. */
21647 it
->ascent
= it
->phys_ascent
= 0;
21648 it
->descent
= it
->phys_descent
= 0;
21649 it
->pixel_width
= 0;
21654 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
21656 /* Make sure X resources of the image is loaded. */
21657 prepare_image_for_display (it
->f
, img
);
21659 slice
.x
= slice
.y
= 0;
21660 slice
.width
= img
->width
;
21661 slice
.height
= img
->height
;
21663 if (INTEGERP (it
->slice
.x
))
21664 slice
.x
= XINT (it
->slice
.x
);
21665 else if (FLOATP (it
->slice
.x
))
21666 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
21668 if (INTEGERP (it
->slice
.y
))
21669 slice
.y
= XINT (it
->slice
.y
);
21670 else if (FLOATP (it
->slice
.y
))
21671 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
21673 if (INTEGERP (it
->slice
.width
))
21674 slice
.width
= XINT (it
->slice
.width
);
21675 else if (FLOATP (it
->slice
.width
))
21676 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
21678 if (INTEGERP (it
->slice
.height
))
21679 slice
.height
= XINT (it
->slice
.height
);
21680 else if (FLOATP (it
->slice
.height
))
21681 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
21683 if (slice
.x
>= img
->width
)
21684 slice
.x
= img
->width
;
21685 if (slice
.y
>= img
->height
)
21686 slice
.y
= img
->height
;
21687 if (slice
.x
+ slice
.width
>= img
->width
)
21688 slice
.width
= img
->width
- slice
.x
;
21689 if (slice
.y
+ slice
.height
> img
->height
)
21690 slice
.height
= img
->height
- slice
.y
;
21692 if (slice
.width
== 0 || slice
.height
== 0)
21695 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
21697 it
->descent
= slice
.height
- glyph_ascent
;
21699 it
->descent
+= img
->vmargin
;
21700 if (slice
.y
+ slice
.height
== img
->height
)
21701 it
->descent
+= img
->vmargin
;
21702 it
->phys_descent
= it
->descent
;
21704 it
->pixel_width
= slice
.width
;
21706 it
->pixel_width
+= img
->hmargin
;
21707 if (slice
.x
+ slice
.width
== img
->width
)
21708 it
->pixel_width
+= img
->hmargin
;
21710 /* It's quite possible for images to have an ascent greater than
21711 their height, so don't get confused in that case. */
21712 if (it
->descent
< 0)
21717 if (face
->box
!= FACE_NO_BOX
)
21719 if (face
->box_line_width
> 0)
21722 it
->ascent
+= face
->box_line_width
;
21723 if (slice
.y
+ slice
.height
== img
->height
)
21724 it
->descent
+= face
->box_line_width
;
21727 if (it
->start_of_box_run_p
&& slice
.x
== 0)
21728 it
->pixel_width
+= eabs (face
->box_line_width
);
21729 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
21730 it
->pixel_width
+= eabs (face
->box_line_width
);
21733 take_vertical_position_into_account (it
);
21735 /* Automatically crop wide image glyphs at right edge so we can
21736 draw the cursor on same display row. */
21737 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
21738 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
21740 it
->pixel_width
-= crop
;
21741 slice
.width
-= crop
;
21746 struct glyph
*glyph
;
21747 enum glyph_row_area area
= it
->area
;
21749 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21750 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21752 glyph
->charpos
= CHARPOS (it
->position
);
21753 glyph
->object
= it
->object
;
21754 glyph
->pixel_width
= it
->pixel_width
;
21755 glyph
->ascent
= glyph_ascent
;
21756 glyph
->descent
= it
->descent
;
21757 glyph
->voffset
= it
->voffset
;
21758 glyph
->type
= IMAGE_GLYPH
;
21759 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21760 glyph
->multibyte_p
= it
->multibyte_p
;
21761 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21762 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21763 glyph
->overlaps_vertically_p
= 0;
21764 glyph
->padding_p
= 0;
21765 glyph
->glyph_not_available_p
= 0;
21766 glyph
->face_id
= it
->face_id
;
21767 glyph
->u
.img_id
= img
->id
;
21768 glyph
->slice
= slice
;
21769 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21772 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21773 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21775 glyph
->bidi_type
= it
->bidi_it
.type
;
21777 ++it
->glyph_row
->used
[area
];
21780 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21785 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
21786 of the glyph, WIDTH and HEIGHT are the width and height of the
21787 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
21790 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
21791 int width
, int height
, int ascent
)
21793 struct glyph
*glyph
;
21794 enum glyph_row_area area
= it
->area
;
21796 xassert (ascent
>= 0 && ascent
<= height
);
21798 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
21799 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
21801 /* If the glyph row is reversed, we need to prepend the glyph
21802 rather than append it. */
21803 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
21807 /* Make room for the additional glyph. */
21808 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
21810 glyph
= it
->glyph_row
->glyphs
[area
];
21812 glyph
->charpos
= CHARPOS (it
->position
);
21813 glyph
->object
= object
;
21814 glyph
->pixel_width
= width
;
21815 glyph
->ascent
= ascent
;
21816 glyph
->descent
= height
- ascent
;
21817 glyph
->voffset
= it
->voffset
;
21818 glyph
->type
= STRETCH_GLYPH
;
21819 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
21820 glyph
->multibyte_p
= it
->multibyte_p
;
21821 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
21822 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
21823 glyph
->overlaps_vertically_p
= 0;
21824 glyph
->padding_p
= 0;
21825 glyph
->glyph_not_available_p
= 0;
21826 glyph
->face_id
= it
->face_id
;
21827 glyph
->u
.stretch
.ascent
= ascent
;
21828 glyph
->u
.stretch
.height
= height
;
21829 glyph
->slice
= null_glyph_slice
;
21830 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
21833 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
21834 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
21836 glyph
->bidi_type
= it
->bidi_it
.type
;
21840 glyph
->resolved_level
= 0;
21841 glyph
->bidi_type
= UNKNOWN_BT
;
21843 ++it
->glyph_row
->used
[area
];
21846 IT_EXPAND_MATRIX_WIDTH (it
, area
);
21850 /* Produce a stretch glyph for iterator IT. IT->object is the value
21851 of the glyph property displayed. The value must be a list
21852 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
21855 1. `:width WIDTH' specifies that the space should be WIDTH *
21856 canonical char width wide. WIDTH may be an integer or floating
21859 2. `:relative-width FACTOR' specifies that the width of the stretch
21860 should be computed from the width of the first character having the
21861 `glyph' property, and should be FACTOR times that width.
21863 3. `:align-to HPOS' specifies that the space should be wide enough
21864 to reach HPOS, a value in canonical character units.
21866 Exactly one of the above pairs must be present.
21868 4. `:height HEIGHT' specifies that the height of the stretch produced
21869 should be HEIGHT, measured in canonical character units.
21871 5. `:relative-height FACTOR' specifies that the height of the
21872 stretch should be FACTOR times the height of the characters having
21873 the glyph property.
21875 Either none or exactly one of 4 or 5 must be present.
21877 6. `:ascent ASCENT' specifies that ASCENT percent of the height
21878 of the stretch should be used for the ascent of the stretch.
21879 ASCENT must be in the range 0 <= ASCENT <= 100. */
21882 produce_stretch_glyph (struct it
*it
)
21884 /* (space :width WIDTH :height HEIGHT ...) */
21885 Lisp_Object prop
, plist
;
21886 int width
= 0, height
= 0, align_to
= -1;
21887 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
21890 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21891 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
21893 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
21895 /* List should start with `space'. */
21896 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
21897 plist
= XCDR (it
->object
);
21899 /* Compute the width of the stretch. */
21900 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
21901 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
21903 /* Absolute width `:width WIDTH' specified and valid. */
21904 zero_width_ok_p
= 1;
21907 else if (prop
= Fplist_get (plist
, QCrelative_width
),
21910 /* Relative width `:relative-width FACTOR' specified and valid.
21911 Compute the width of the characters having the `glyph'
21914 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
21917 if (it
->multibyte_p
)
21919 int maxlen
= ((IT_BYTEPOS (*it
) >= GPT
? ZV
: GPT
)
21920 - IT_BYTEPOS (*it
));
21921 it2
.c
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
21924 it2
.c
= *p
, it2
.len
= 1;
21926 it2
.glyph_row
= NULL
;
21927 it2
.what
= IT_CHARACTER
;
21928 x_produce_glyphs (&it2
);
21929 width
= NUMVAL (prop
) * it2
.pixel_width
;
21931 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
21932 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
21934 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
21935 align_to
= (align_to
< 0
21937 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
21938 else if (align_to
< 0)
21939 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
21940 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
21941 zero_width_ok_p
= 1;
21944 /* Nothing specified -> width defaults to canonical char width. */
21945 width
= FRAME_COLUMN_WIDTH (it
->f
);
21947 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
21950 /* Compute height. */
21951 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
21952 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21955 zero_height_ok_p
= 1;
21957 else if (prop
= Fplist_get (plist
, QCrelative_height
),
21959 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
21961 height
= FONT_HEIGHT (font
);
21963 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
21966 /* Compute percentage of height used for ascent. If
21967 `:ascent ASCENT' is present and valid, use that. Otherwise,
21968 derive the ascent from the font in use. */
21969 if (prop
= Fplist_get (plist
, QCascent
),
21970 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
21971 ascent
= height
* NUMVAL (prop
) / 100.0;
21972 else if (!NILP (prop
)
21973 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
21974 ascent
= min (max (0, (int)tem
), height
);
21976 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
21978 if (width
> 0 && it
->line_wrap
!= TRUNCATE
21979 && it
->current_x
+ width
> it
->last_visible_x
)
21980 width
= it
->last_visible_x
- it
->current_x
- 1;
21982 if (width
> 0 && height
> 0 && it
->glyph_row
)
21984 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
21985 if (!STRINGP (object
))
21986 object
= it
->w
->buffer
;
21987 append_stretch_glyph (it
, object
, width
, height
, ascent
);
21990 it
->pixel_width
= width
;
21991 it
->ascent
= it
->phys_ascent
= ascent
;
21992 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
21993 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
21995 take_vertical_position_into_account (it
);
21998 /* Calculate line-height and line-spacing properties.
21999 An integer value specifies explicit pixel value.
22000 A float value specifies relative value to current face height.
22001 A cons (float . face-name) specifies relative value to
22002 height of specified face font.
22004 Returns height in pixels, or nil. */
22008 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
22009 int boff
, int override
)
22011 Lisp_Object face_name
= Qnil
;
22012 int ascent
, descent
, height
;
22014 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
22019 face_name
= XCAR (val
);
22021 if (!NUMBERP (val
))
22022 val
= make_number (1);
22023 if (NILP (face_name
))
22025 height
= it
->ascent
+ it
->descent
;
22030 if (NILP (face_name
))
22032 font
= FRAME_FONT (it
->f
);
22033 boff
= FRAME_BASELINE_OFFSET (it
->f
);
22035 else if (EQ (face_name
, Qt
))
22044 face_id
= lookup_named_face (it
->f
, face_name
, 0);
22046 return make_number (-1);
22048 face
= FACE_FROM_ID (it
->f
, face_id
);
22051 return make_number (-1);
22052 boff
= font
->baseline_offset
;
22053 if (font
->vertical_centering
)
22054 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22057 ascent
= FONT_BASE (font
) + boff
;
22058 descent
= FONT_DESCENT (font
) - boff
;
22062 it
->override_ascent
= ascent
;
22063 it
->override_descent
= descent
;
22064 it
->override_boff
= boff
;
22067 height
= ascent
+ descent
;
22071 height
= (int)(XFLOAT_DATA (val
) * height
);
22072 else if (INTEGERP (val
))
22073 height
*= XINT (val
);
22075 return make_number (height
);
22080 Produce glyphs/get display metrics for the display element IT is
22081 loaded with. See the description of struct it in dispextern.h
22082 for an overview of struct it. */
22085 x_produce_glyphs (struct it
*it
)
22087 int extra_line_spacing
= it
->extra_line_spacing
;
22089 it
->glyph_not_available_p
= 0;
22091 if (it
->what
== IT_CHARACTER
)
22095 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22096 struct font_metrics
*pcm
;
22097 int font_not_found_p
;
22098 int boff
; /* baseline offset */
22099 /* We may change it->multibyte_p upon unibyte<->multibyte
22100 conversion. So, save the current value now and restore it
22103 Note: It seems that we don't have to record multibyte_p in
22104 struct glyph because the character code itself tells whether
22105 or not the character is multibyte. Thus, in the future, we
22106 must consider eliminating the field `multibyte_p' in the
22108 int saved_multibyte_p
= it
->multibyte_p
;
22110 /* Maybe translate single-byte characters to multibyte, or the
22112 it
->char_to_display
= it
->c
;
22113 if (!ASCII_BYTE_P (it
->c
)
22114 && ! it
->multibyte_p
)
22116 if (SINGLE_BYTE_CHAR_P (it
->c
)
22117 && unibyte_display_via_language_environment
)
22119 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
22121 /* get_next_display_element assures that this decoding
22123 it
->char_to_display
= DECODE_CHAR (unibyte
, it
->c
);
22124 it
->multibyte_p
= 1;
22125 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, it
->char_to_display
,
22127 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22131 /* Get font to use. Encode IT->char_to_display. */
22132 get_char_face_and_encoding (it
->f
, it
->char_to_display
, it
->face_id
,
22133 &char2b
, it
->multibyte_p
, 0);
22136 font_not_found_p
= font
== NULL
;
22137 if (font_not_found_p
)
22139 /* When no suitable font found, display an empty box based
22140 on the metrics of the font of the default face (or what
22142 struct face
*no_font_face
22143 = FACE_FROM_ID (it
->f
,
22144 NILP (Vface_remapping_alist
) ? DEFAULT_FACE_ID
22145 : lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
22146 font
= no_font_face
->font
;
22147 boff
= font
->baseline_offset
;
22151 boff
= font
->baseline_offset
;
22152 if (font
->vertical_centering
)
22153 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22156 if (it
->char_to_display
>= ' '
22157 && (!it
->multibyte_p
|| it
->char_to_display
< 128))
22159 /* Either unibyte or ASCII. */
22164 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22166 if (it
->override_ascent
>= 0)
22168 it
->ascent
= it
->override_ascent
;
22169 it
->descent
= it
->override_descent
;
22170 boff
= it
->override_boff
;
22174 it
->ascent
= FONT_BASE (font
) + boff
;
22175 it
->descent
= FONT_DESCENT (font
) - boff
;
22180 it
->phys_ascent
= pcm
->ascent
+ boff
;
22181 it
->phys_descent
= pcm
->descent
- boff
;
22182 it
->pixel_width
= pcm
->width
;
22186 it
->glyph_not_available_p
= 1;
22187 it
->phys_ascent
= it
->ascent
;
22188 it
->phys_descent
= it
->descent
;
22189 it
->pixel_width
= FONT_WIDTH (font
);
22192 if (it
->constrain_row_ascent_descent_p
)
22194 if (it
->descent
> it
->max_descent
)
22196 it
->ascent
+= it
->descent
- it
->max_descent
;
22197 it
->descent
= it
->max_descent
;
22199 if (it
->ascent
> it
->max_ascent
)
22201 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22202 it
->ascent
= it
->max_ascent
;
22204 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22205 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22206 extra_line_spacing
= 0;
22209 /* If this is a space inside a region of text with
22210 `space-width' property, change its width. */
22211 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
22213 it
->pixel_width
*= XFLOATINT (it
->space_width
);
22215 /* If face has a box, add the box thickness to the character
22216 height. If character has a box line to the left and/or
22217 right, add the box line width to the character's width. */
22218 if (face
->box
!= FACE_NO_BOX
)
22220 int thick
= face
->box_line_width
;
22224 it
->ascent
+= thick
;
22225 it
->descent
+= thick
;
22230 if (it
->start_of_box_run_p
)
22231 it
->pixel_width
+= thick
;
22232 if (it
->end_of_box_run_p
)
22233 it
->pixel_width
+= thick
;
22236 /* If face has an overline, add the height of the overline
22237 (1 pixel) and a 1 pixel margin to the character height. */
22238 if (face
->overline_p
)
22239 it
->ascent
+= overline_margin
;
22241 if (it
->constrain_row_ascent_descent_p
)
22243 if (it
->ascent
> it
->max_ascent
)
22244 it
->ascent
= it
->max_ascent
;
22245 if (it
->descent
> it
->max_descent
)
22246 it
->descent
= it
->max_descent
;
22249 take_vertical_position_into_account (it
);
22251 /* If we have to actually produce glyphs, do it. */
22256 /* Translate a space with a `space-width' property
22257 into a stretch glyph. */
22258 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
22259 / FONT_HEIGHT (font
));
22260 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22261 it
->ascent
+ it
->descent
, ascent
);
22266 /* If characters with lbearing or rbearing are displayed
22267 in this line, record that fact in a flag of the
22268 glyph row. This is used to optimize X output code. */
22269 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
22270 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22272 if (! stretched_p
&& it
->pixel_width
== 0)
22273 /* We assure that all visible glyphs have at least 1-pixel
22275 it
->pixel_width
= 1;
22277 else if (it
->char_to_display
== '\n')
22279 /* A newline has no width, but we need the height of the
22280 line. But if previous part of the line sets a height,
22281 don't increase that height */
22283 Lisp_Object height
;
22284 Lisp_Object total_height
= Qnil
;
22286 it
->override_ascent
= -1;
22287 it
->pixel_width
= 0;
22290 height
= get_it_property (it
, Qline_height
);
22291 /* Split (line-height total-height) list */
22293 && CONSP (XCDR (height
))
22294 && NILP (XCDR (XCDR (height
))))
22296 total_height
= XCAR (XCDR (height
));
22297 height
= XCAR (height
);
22299 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
22301 if (it
->override_ascent
>= 0)
22303 it
->ascent
= it
->override_ascent
;
22304 it
->descent
= it
->override_descent
;
22305 boff
= it
->override_boff
;
22309 it
->ascent
= FONT_BASE (font
) + boff
;
22310 it
->descent
= FONT_DESCENT (font
) - boff
;
22313 if (EQ (height
, Qt
))
22315 if (it
->descent
> it
->max_descent
)
22317 it
->ascent
+= it
->descent
- it
->max_descent
;
22318 it
->descent
= it
->max_descent
;
22320 if (it
->ascent
> it
->max_ascent
)
22322 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
22323 it
->ascent
= it
->max_ascent
;
22325 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
22326 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
22327 it
->constrain_row_ascent_descent_p
= 1;
22328 extra_line_spacing
= 0;
22332 Lisp_Object spacing
;
22334 it
->phys_ascent
= it
->ascent
;
22335 it
->phys_descent
= it
->descent
;
22337 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
22338 && face
->box
!= FACE_NO_BOX
22339 && face
->box_line_width
> 0)
22341 it
->ascent
+= face
->box_line_width
;
22342 it
->descent
+= face
->box_line_width
;
22345 && XINT (height
) > it
->ascent
+ it
->descent
)
22346 it
->ascent
= XINT (height
) - it
->descent
;
22348 if (!NILP (total_height
))
22349 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
22352 spacing
= get_it_property (it
, Qline_spacing
);
22353 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
22355 if (INTEGERP (spacing
))
22357 extra_line_spacing
= XINT (spacing
);
22358 if (!NILP (total_height
))
22359 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
22363 else if (it
->char_to_display
== '\t')
22365 if (font
->space_width
> 0)
22367 int tab_width
= it
->tab_width
* font
->space_width
;
22368 int x
= it
->current_x
+ it
->continuation_lines_width
;
22369 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
22371 /* If the distance from the current position to the next tab
22372 stop is less than a space character width, use the
22373 tab stop after that. */
22374 if (next_tab_x
- x
< font
->space_width
)
22375 next_tab_x
+= tab_width
;
22377 it
->pixel_width
= next_tab_x
- x
;
22379 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
22380 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22384 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
22385 it
->ascent
+ it
->descent
, it
->ascent
);
22390 it
->pixel_width
= 0;
22396 /* A multi-byte character. Assume that the display width of the
22397 character is the width of the character multiplied by the
22398 width of the font. */
22400 /* If we found a font, this font should give us the right
22401 metrics. If we didn't find a font, use the frame's
22402 default font and calculate the width of the character by
22403 multiplying the width of font by the width of the
22406 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22408 if (font_not_found_p
|| !pcm
)
22410 int char_width
= CHAR_WIDTH (it
->char_to_display
);
22412 if (char_width
== 0)
22413 /* This is a non spacing character. But, as we are
22414 going to display an empty box, the box must occupy
22415 at least one column. */
22417 it
->glyph_not_available_p
= 1;
22418 it
->pixel_width
= font
->space_width
* char_width
;
22419 it
->phys_ascent
= FONT_BASE (font
) + boff
;
22420 it
->phys_descent
= FONT_DESCENT (font
) - boff
;
22424 it
->pixel_width
= pcm
->width
;
22425 it
->phys_ascent
= pcm
->ascent
+ boff
;
22426 it
->phys_descent
= pcm
->descent
- boff
;
22428 && (pcm
->lbearing
< 0
22429 || pcm
->rbearing
> pcm
->width
))
22430 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22433 it
->ascent
= FONT_BASE (font
) + boff
;
22434 it
->descent
= FONT_DESCENT (font
) - boff
;
22435 if (face
->box
!= FACE_NO_BOX
)
22437 int thick
= face
->box_line_width
;
22441 it
->ascent
+= thick
;
22442 it
->descent
+= thick
;
22447 if (it
->start_of_box_run_p
)
22448 it
->pixel_width
+= thick
;
22449 if (it
->end_of_box_run_p
)
22450 it
->pixel_width
+= thick
;
22453 /* If face has an overline, add the height of the overline
22454 (1 pixel) and a 1 pixel margin to the character height. */
22455 if (face
->overline_p
)
22456 it
->ascent
+= overline_margin
;
22458 take_vertical_position_into_account (it
);
22460 if (it
->ascent
< 0)
22462 if (it
->descent
< 0)
22467 if (it
->pixel_width
== 0)
22468 /* We assure that all visible glyphs have at least 1-pixel
22470 it
->pixel_width
= 1;
22472 it
->multibyte_p
= saved_multibyte_p
;
22474 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
22476 /* A static composition.
22478 Note: A composition is represented as one glyph in the
22479 glyph matrix. There are no padding glyphs.
22481 Important note: pixel_width, ascent, and descent are the
22482 values of what is drawn by draw_glyphs (i.e. the values of
22483 the overall glyphs composed). */
22484 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22485 int boff
; /* baseline offset */
22486 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
22487 int glyph_len
= cmp
->glyph_len
;
22488 struct font
*font
= face
->font
;
22492 /* If we have not yet calculated pixel size data of glyphs of
22493 the composition for the current face font, calculate them
22494 now. Theoretically, we have to check all fonts for the
22495 glyphs, but that requires much time and memory space. So,
22496 here we check only the font of the first glyph. This may
22497 lead to incorrect display, but it's very rare, and C-l
22498 (recenter-top-bottom) can correct the display anyway. */
22499 if (! cmp
->font
|| cmp
->font
!= font
)
22501 /* Ascent and descent of the font of the first character
22502 of this composition (adjusted by baseline offset).
22503 Ascent and descent of overall glyphs should not be less
22504 than these, respectively. */
22505 int font_ascent
, font_descent
, font_height
;
22506 /* Bounding box of the overall glyphs. */
22507 int leftmost
, rightmost
, lowest
, highest
;
22508 int lbearing
, rbearing
;
22509 int i
, width
, ascent
, descent
;
22510 int left_padded
= 0, right_padded
= 0;
22513 struct font_metrics
*pcm
;
22514 int font_not_found_p
;
22517 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
22518 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
22520 if (glyph_len
< cmp
->glyph_len
)
22522 for (i
= 0; i
< glyph_len
; i
++)
22524 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
22526 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22531 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
22532 : IT_CHARPOS (*it
));
22533 /* If no suitable font is found, use the default font. */
22534 font_not_found_p
= font
== NULL
;
22535 if (font_not_found_p
)
22537 face
= face
->ascii_face
;
22540 boff
= font
->baseline_offset
;
22541 if (font
->vertical_centering
)
22542 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22543 font_ascent
= FONT_BASE (font
) + boff
;
22544 font_descent
= FONT_DESCENT (font
) - boff
;
22545 font_height
= FONT_HEIGHT (font
);
22547 cmp
->font
= (void *) font
;
22550 if (! font_not_found_p
)
22552 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
22553 &char2b
, it
->multibyte_p
, 0);
22554 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22557 /* Initialize the bounding box. */
22560 width
= pcm
->width
;
22561 ascent
= pcm
->ascent
;
22562 descent
= pcm
->descent
;
22563 lbearing
= pcm
->lbearing
;
22564 rbearing
= pcm
->rbearing
;
22568 width
= FONT_WIDTH (font
);
22569 ascent
= FONT_BASE (font
);
22570 descent
= FONT_DESCENT (font
);
22577 lowest
= - descent
+ boff
;
22578 highest
= ascent
+ boff
;
22580 if (! font_not_found_p
22581 && font
->default_ascent
22582 && CHAR_TABLE_P (Vuse_default_ascent
)
22583 && !NILP (Faref (Vuse_default_ascent
,
22584 make_number (it
->char_to_display
))))
22585 highest
= font
->default_ascent
+ boff
;
22587 /* Draw the first glyph at the normal position. It may be
22588 shifted to right later if some other glyphs are drawn
22590 cmp
->offsets
[i
* 2] = 0;
22591 cmp
->offsets
[i
* 2 + 1] = boff
;
22592 cmp
->lbearing
= lbearing
;
22593 cmp
->rbearing
= rbearing
;
22595 /* Set cmp->offsets for the remaining glyphs. */
22596 for (i
++; i
< glyph_len
; i
++)
22598 int left
, right
, btm
, top
;
22599 int ch
= COMPOSITION_GLYPH (cmp
, i
);
22601 struct face
*this_face
;
22606 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
22607 this_face
= FACE_FROM_ID (it
->f
, face_id
);
22608 font
= this_face
->font
;
22614 this_boff
= font
->baseline_offset
;
22615 if (font
->vertical_centering
)
22616 this_boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
22617 get_char_face_and_encoding (it
->f
, ch
, face_id
,
22618 &char2b
, it
->multibyte_p
, 0);
22619 pcm
= get_per_char_metric (it
->f
, font
, &char2b
);
22622 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
22625 width
= pcm
->width
;
22626 ascent
= pcm
->ascent
;
22627 descent
= pcm
->descent
;
22628 lbearing
= pcm
->lbearing
;
22629 rbearing
= pcm
->rbearing
;
22630 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
22632 /* Relative composition with or without
22633 alternate chars. */
22634 left
= (leftmost
+ rightmost
- width
) / 2;
22635 btm
= - descent
+ boff
;
22636 if (font
->relative_compose
22637 && (! CHAR_TABLE_P (Vignore_relative_composition
)
22638 || NILP (Faref (Vignore_relative_composition
,
22639 make_number (ch
)))))
22642 if (- descent
>= font
->relative_compose
)
22643 /* One extra pixel between two glyphs. */
22645 else if (ascent
<= 0)
22646 /* One extra pixel between two glyphs. */
22647 btm
= lowest
- 1 - ascent
- descent
;
22652 /* A composition rule is specified by an integer
22653 value that encodes global and new reference
22654 points (GREF and NREF). GREF and NREF are
22655 specified by numbers as below:
22657 0---1---2 -- ascent
22661 9--10--11 -- center
22663 ---3---4---5--- baseline
22665 6---7---8 -- descent
22667 int rule
= COMPOSITION_RULE (cmp
, i
);
22668 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
22670 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
22671 grefx
= gref
% 3, nrefx
= nref
% 3;
22672 grefy
= gref
/ 3, nrefy
= nref
/ 3;
22674 xoff
= font_height
* (xoff
- 128) / 256;
22676 yoff
= font_height
* (yoff
- 128) / 256;
22679 + grefx
* (rightmost
- leftmost
) / 2
22680 - nrefx
* width
/ 2
22683 btm
= ((grefy
== 0 ? highest
22685 : grefy
== 2 ? lowest
22686 : (highest
+ lowest
) / 2)
22687 - (nrefy
== 0 ? ascent
+ descent
22688 : nrefy
== 1 ? descent
- boff
22690 : (ascent
+ descent
) / 2)
22694 cmp
->offsets
[i
* 2] = left
;
22695 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
22697 /* Update the bounding box of the overall glyphs. */
22700 right
= left
+ width
;
22701 if (left
< leftmost
)
22703 if (right
> rightmost
)
22706 top
= btm
+ descent
+ ascent
;
22712 if (cmp
->lbearing
> left
+ lbearing
)
22713 cmp
->lbearing
= left
+ lbearing
;
22714 if (cmp
->rbearing
< left
+ rbearing
)
22715 cmp
->rbearing
= left
+ rbearing
;
22719 /* If there are glyphs whose x-offsets are negative,
22720 shift all glyphs to the right and make all x-offsets
22724 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22725 cmp
->offsets
[i
* 2] -= leftmost
;
22726 rightmost
-= leftmost
;
22727 cmp
->lbearing
-= leftmost
;
22728 cmp
->rbearing
-= leftmost
;
22731 if (left_padded
&& cmp
->lbearing
< 0)
22733 for (i
= 0; i
< cmp
->glyph_len
; i
++)
22734 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
22735 rightmost
-= cmp
->lbearing
;
22736 cmp
->rbearing
-= cmp
->lbearing
;
22739 if (right_padded
&& rightmost
< cmp
->rbearing
)
22741 rightmost
= cmp
->rbearing
;
22744 cmp
->pixel_width
= rightmost
;
22745 cmp
->ascent
= highest
;
22746 cmp
->descent
= - lowest
;
22747 if (cmp
->ascent
< font_ascent
)
22748 cmp
->ascent
= font_ascent
;
22749 if (cmp
->descent
< font_descent
)
22750 cmp
->descent
= font_descent
;
22754 && (cmp
->lbearing
< 0
22755 || cmp
->rbearing
> cmp
->pixel_width
))
22756 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22758 it
->pixel_width
= cmp
->pixel_width
;
22759 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
22760 it
->descent
= it
->phys_descent
= cmp
->descent
;
22761 if (face
->box
!= FACE_NO_BOX
)
22763 int thick
= face
->box_line_width
;
22767 it
->ascent
+= thick
;
22768 it
->descent
+= thick
;
22773 if (it
->start_of_box_run_p
)
22774 it
->pixel_width
+= thick
;
22775 if (it
->end_of_box_run_p
)
22776 it
->pixel_width
+= thick
;
22779 /* If face has an overline, add the height of the overline
22780 (1 pixel) and a 1 pixel margin to the character height. */
22781 if (face
->overline_p
)
22782 it
->ascent
+= overline_margin
;
22784 take_vertical_position_into_account (it
);
22785 if (it
->ascent
< 0)
22787 if (it
->descent
< 0)
22791 append_composite_glyph (it
);
22793 else if (it
->what
== IT_COMPOSITION
)
22795 /* A dynamic (automatic) composition. */
22796 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22797 Lisp_Object gstring
;
22798 struct font_metrics metrics
;
22800 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
22802 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
22805 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
22806 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
22807 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
22808 it
->descent
= it
->phys_descent
= metrics
.descent
;
22809 if (face
->box
!= FACE_NO_BOX
)
22811 int thick
= face
->box_line_width
;
22815 it
->ascent
+= thick
;
22816 it
->descent
+= thick
;
22821 if (it
->start_of_box_run_p
)
22822 it
->pixel_width
+= thick
;
22823 if (it
->end_of_box_run_p
)
22824 it
->pixel_width
+= thick
;
22826 /* If face has an overline, add the height of the overline
22827 (1 pixel) and a 1 pixel margin to the character height. */
22828 if (face
->overline_p
)
22829 it
->ascent
+= overline_margin
;
22830 take_vertical_position_into_account (it
);
22831 if (it
->ascent
< 0)
22833 if (it
->descent
< 0)
22837 append_composite_glyph (it
);
22839 else if (it
->what
== IT_IMAGE
)
22840 produce_image_glyph (it
);
22841 else if (it
->what
== IT_STRETCH
)
22842 produce_stretch_glyph (it
);
22844 /* Accumulate dimensions. Note: can't assume that it->descent > 0
22845 because this isn't true for images with `:ascent 100'. */
22846 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
22847 if (it
->area
== TEXT_AREA
)
22848 it
->current_x
+= it
->pixel_width
;
22850 if (extra_line_spacing
> 0)
22852 it
->descent
+= extra_line_spacing
;
22853 if (extra_line_spacing
> it
->max_extra_line_spacing
)
22854 it
->max_extra_line_spacing
= extra_line_spacing
;
22857 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
22858 it
->max_descent
= max (it
->max_descent
, it
->descent
);
22859 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
22860 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
22864 Output LEN glyphs starting at START at the nominal cursor position.
22865 Advance the nominal cursor over the text. The global variable
22866 updated_window contains the window being updated, updated_row is
22867 the glyph row being updated, and updated_area is the area of that
22868 row being updated. */
22871 x_write_glyphs (struct glyph
*start
, int len
)
22875 xassert (updated_window
&& updated_row
);
22878 /* Write glyphs. */
22880 hpos
= start
- updated_row
->glyphs
[updated_area
];
22881 x
= draw_glyphs (updated_window
, output_cursor
.x
,
22882 updated_row
, updated_area
,
22884 DRAW_NORMAL_TEXT
, 0);
22886 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
22887 if (updated_area
== TEXT_AREA
22888 && updated_window
->phys_cursor_on_p
22889 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
22890 && updated_window
->phys_cursor
.hpos
>= hpos
22891 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
22892 updated_window
->phys_cursor_on_p
= 0;
22896 /* Advance the output cursor. */
22897 output_cursor
.hpos
+= len
;
22898 output_cursor
.x
= x
;
22903 Insert LEN glyphs from START at the nominal cursor position. */
22906 x_insert_glyphs (struct glyph
*start
, int len
)
22910 int line_height
, shift_by_width
, shifted_region_width
;
22911 struct glyph_row
*row
;
22912 struct glyph
*glyph
;
22913 int frame_x
, frame_y
;
22916 xassert (updated_window
&& updated_row
);
22918 w
= updated_window
;
22919 f
= XFRAME (WINDOW_FRAME (w
));
22921 /* Get the height of the line we are in. */
22923 line_height
= row
->height
;
22925 /* Get the width of the glyphs to insert. */
22926 shift_by_width
= 0;
22927 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
22928 shift_by_width
+= glyph
->pixel_width
;
22930 /* Get the width of the region to shift right. */
22931 shifted_region_width
= (window_box_width (w
, updated_area
)
22936 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
22937 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
22939 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
22940 line_height
, shift_by_width
);
22942 /* Write the glyphs. */
22943 hpos
= start
- row
->glyphs
[updated_area
];
22944 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
22946 DRAW_NORMAL_TEXT
, 0);
22948 /* Advance the output cursor. */
22949 output_cursor
.hpos
+= len
;
22950 output_cursor
.x
+= shift_by_width
;
22956 Erase the current text line from the nominal cursor position
22957 (inclusive) to pixel column TO_X (exclusive). The idea is that
22958 everything from TO_X onward is already erased.
22960 TO_X is a pixel position relative to updated_area of
22961 updated_window. TO_X == -1 means clear to the end of this area. */
22964 x_clear_end_of_line (int to_x
)
22967 struct window
*w
= updated_window
;
22968 int max_x
, min_y
, max_y
;
22969 int from_x
, from_y
, to_y
;
22971 xassert (updated_window
&& updated_row
);
22972 f
= XFRAME (w
->frame
);
22974 if (updated_row
->full_width_p
)
22975 max_x
= WINDOW_TOTAL_WIDTH (w
);
22977 max_x
= window_box_width (w
, updated_area
);
22978 max_y
= window_text_bottom_y (w
);
22980 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
22981 of window. For TO_X > 0, truncate to end of drawing area. */
22987 to_x
= min (to_x
, max_x
);
22989 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
22991 /* Notice if the cursor will be cleared by this operation. */
22992 if (!updated_row
->full_width_p
)
22993 notice_overwritten_cursor (w
, updated_area
,
22994 output_cursor
.x
, -1,
22996 MATRIX_ROW_BOTTOM_Y (updated_row
));
22998 from_x
= output_cursor
.x
;
23000 /* Translate to frame coordinates. */
23001 if (updated_row
->full_width_p
)
23003 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
23004 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
23008 int area_left
= window_box_left (w
, updated_area
);
23009 from_x
+= area_left
;
23013 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
23014 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
23015 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
23017 /* Prevent inadvertently clearing to end of the X window. */
23018 if (to_x
> from_x
&& to_y
> from_y
)
23021 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
23022 to_x
- from_x
, to_y
- from_y
);
23027 #endif /* HAVE_WINDOW_SYSTEM */
23031 /***********************************************************************
23033 ***********************************************************************/
23035 /* Value is the internal representation of the specified cursor type
23036 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
23037 of the bar cursor. */
23039 static enum text_cursor_kinds
23040 get_specified_cursor_type (Lisp_Object arg
, int *width
)
23042 enum text_cursor_kinds type
;
23047 if (EQ (arg
, Qbox
))
23048 return FILLED_BOX_CURSOR
;
23050 if (EQ (arg
, Qhollow
))
23051 return HOLLOW_BOX_CURSOR
;
23053 if (EQ (arg
, Qbar
))
23060 && EQ (XCAR (arg
), Qbar
)
23061 && INTEGERP (XCDR (arg
))
23062 && XINT (XCDR (arg
)) >= 0)
23064 *width
= XINT (XCDR (arg
));
23068 if (EQ (arg
, Qhbar
))
23071 return HBAR_CURSOR
;
23075 && EQ (XCAR (arg
), Qhbar
)
23076 && INTEGERP (XCDR (arg
))
23077 && XINT (XCDR (arg
)) >= 0)
23079 *width
= XINT (XCDR (arg
));
23080 return HBAR_CURSOR
;
23083 /* Treat anything unknown as "hollow box cursor".
23084 It was bad to signal an error; people have trouble fixing
23085 .Xdefaults with Emacs, when it has something bad in it. */
23086 type
= HOLLOW_BOX_CURSOR
;
23091 /* Set the default cursor types for specified frame. */
23093 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
23098 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
23099 FRAME_CURSOR_WIDTH (f
) = width
;
23101 /* By default, set up the blink-off state depending on the on-state. */
23103 tem
= Fassoc (arg
, Vblink_cursor_alist
);
23106 FRAME_BLINK_OFF_CURSOR (f
)
23107 = get_specified_cursor_type (XCDR (tem
), &width
);
23108 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
23111 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
23115 /* Return the cursor we want to be displayed in window W. Return
23116 width of bar/hbar cursor through WIDTH arg. Return with
23117 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
23118 (i.e. if the `system caret' should track this cursor).
23120 In a mini-buffer window, we want the cursor only to appear if we
23121 are reading input from this window. For the selected window, we
23122 want the cursor type given by the frame parameter or buffer local
23123 setting of cursor-type. If explicitly marked off, draw no cursor.
23124 In all other cases, we want a hollow box cursor. */
23126 static enum text_cursor_kinds
23127 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
23128 int *active_cursor
)
23130 struct frame
*f
= XFRAME (w
->frame
);
23131 struct buffer
*b
= XBUFFER (w
->buffer
);
23132 int cursor_type
= DEFAULT_CURSOR
;
23133 Lisp_Object alt_cursor
;
23134 int non_selected
= 0;
23136 *active_cursor
= 1;
23139 if (cursor_in_echo_area
23140 && FRAME_HAS_MINIBUF_P (f
)
23141 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
23143 if (w
== XWINDOW (echo_area_window
))
23145 if (EQ (b
->cursor_type
, Qt
) || NILP (b
->cursor_type
))
23147 *width
= FRAME_CURSOR_WIDTH (f
);
23148 return FRAME_DESIRED_CURSOR (f
);
23151 return get_specified_cursor_type (b
->cursor_type
, width
);
23154 *active_cursor
= 0;
23158 /* Detect a nonselected window or nonselected frame. */
23159 else if (w
!= XWINDOW (f
->selected_window
)
23160 #ifdef HAVE_WINDOW_SYSTEM
23161 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
23165 *active_cursor
= 0;
23167 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
23173 /* Never display a cursor in a window in which cursor-type is nil. */
23174 if (NILP (b
->cursor_type
))
23177 /* Get the normal cursor type for this window. */
23178 if (EQ (b
->cursor_type
, Qt
))
23180 cursor_type
= FRAME_DESIRED_CURSOR (f
);
23181 *width
= FRAME_CURSOR_WIDTH (f
);
23184 cursor_type
= get_specified_cursor_type (b
->cursor_type
, width
);
23186 /* Use cursor-in-non-selected-windows instead
23187 for non-selected window or frame. */
23190 alt_cursor
= b
->cursor_in_non_selected_windows
;
23191 if (!EQ (Qt
, alt_cursor
))
23192 return get_specified_cursor_type (alt_cursor
, width
);
23193 /* t means modify the normal cursor type. */
23194 if (cursor_type
== FILLED_BOX_CURSOR
)
23195 cursor_type
= HOLLOW_BOX_CURSOR
;
23196 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
23198 return cursor_type
;
23201 /* Use normal cursor if not blinked off. */
23202 if (!w
->cursor_off_p
)
23204 #ifdef HAVE_WINDOW_SYSTEM
23205 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
23207 if (cursor_type
== FILLED_BOX_CURSOR
)
23209 /* Using a block cursor on large images can be very annoying.
23210 So use a hollow cursor for "large" images.
23211 If image is not transparent (no mask), also use hollow cursor. */
23212 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
23213 if (img
!= NULL
&& IMAGEP (img
->spec
))
23215 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
23216 where N = size of default frame font size.
23217 This should cover most of the "tiny" icons people may use. */
23219 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
23220 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
23221 cursor_type
= HOLLOW_BOX_CURSOR
;
23224 else if (cursor_type
!= NO_CURSOR
)
23226 /* Display current only supports BOX and HOLLOW cursors for images.
23227 So for now, unconditionally use a HOLLOW cursor when cursor is
23228 not a solid box cursor. */
23229 cursor_type
= HOLLOW_BOX_CURSOR
;
23233 return cursor_type
;
23236 /* Cursor is blinked off, so determine how to "toggle" it. */
23238 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
23239 if ((alt_cursor
= Fassoc (b
->cursor_type
, Vblink_cursor_alist
), !NILP (alt_cursor
)))
23240 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
23242 /* Then see if frame has specified a specific blink off cursor type. */
23243 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
23245 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
23246 return FRAME_BLINK_OFF_CURSOR (f
);
23250 /* Some people liked having a permanently visible blinking cursor,
23251 while others had very strong opinions against it. So it was
23252 decided to remove it. KFS 2003-09-03 */
23254 /* Finally perform built-in cursor blinking:
23255 filled box <-> hollow box
23256 wide [h]bar <-> narrow [h]bar
23257 narrow [h]bar <-> no cursor
23258 other type <-> no cursor */
23260 if (cursor_type
== FILLED_BOX_CURSOR
)
23261 return HOLLOW_BOX_CURSOR
;
23263 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
23266 return cursor_type
;
23274 #ifdef HAVE_WINDOW_SYSTEM
23276 /* Notice when the text cursor of window W has been completely
23277 overwritten by a drawing operation that outputs glyphs in AREA
23278 starting at X0 and ending at X1 in the line starting at Y0 and
23279 ending at Y1. X coordinates are area-relative. X1 < 0 means all
23280 the rest of the line after X0 has been written. Y coordinates
23281 are window-relative. */
23284 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
23285 int x0
, int x1
, int y0
, int y1
)
23287 int cx0
, cx1
, cy0
, cy1
;
23288 struct glyph_row
*row
;
23290 if (!w
->phys_cursor_on_p
)
23292 if (area
!= TEXT_AREA
)
23295 if (w
->phys_cursor
.vpos
< 0
23296 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
23297 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
23298 !(row
->enabled_p
&& row
->displays_text_p
)))
23301 if (row
->cursor_in_fringe_p
)
23303 row
->cursor_in_fringe_p
= 0;
23304 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
23305 w
->phys_cursor_on_p
= 0;
23309 cx0
= w
->phys_cursor
.x
;
23310 cx1
= cx0
+ w
->phys_cursor_width
;
23311 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
23314 /* The cursor image will be completely removed from the
23315 screen if the output area intersects the cursor area in
23316 y-direction. When we draw in [y0 y1[, and some part of
23317 the cursor is at y < y0, that part must have been drawn
23318 before. When scrolling, the cursor is erased before
23319 actually scrolling, so we don't come here. When not
23320 scrolling, the rows above the old cursor row must have
23321 changed, and in this case these rows must have written
23322 over the cursor image.
23324 Likewise if part of the cursor is below y1, with the
23325 exception of the cursor being in the first blank row at
23326 the buffer and window end because update_text_area
23327 doesn't draw that row. (Except when it does, but
23328 that's handled in update_text_area.) */
23330 cy0
= w
->phys_cursor
.y
;
23331 cy1
= cy0
+ w
->phys_cursor_height
;
23332 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
23335 w
->phys_cursor_on_p
= 0;
23338 #endif /* HAVE_WINDOW_SYSTEM */
23341 /************************************************************************
23343 ************************************************************************/
23345 #ifdef HAVE_WINDOW_SYSTEM
23348 Fix the display of area AREA of overlapping row ROW in window W
23349 with respect to the overlapping part OVERLAPS. */
23352 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
23353 enum glyph_row_area area
, int overlaps
)
23360 for (i
= 0; i
< row
->used
[area
];)
23362 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
23364 int start
= i
, start_x
= x
;
23368 x
+= row
->glyphs
[area
][i
].pixel_width
;
23371 while (i
< row
->used
[area
]
23372 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
23374 draw_glyphs (w
, start_x
, row
, area
,
23376 DRAW_NORMAL_TEXT
, overlaps
);
23380 x
+= row
->glyphs
[area
][i
].pixel_width
;
23390 Draw the cursor glyph of window W in glyph row ROW. See the
23391 comment of draw_glyphs for the meaning of HL. */
23394 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
23395 enum draw_glyphs_face hl
)
23397 /* If cursor hpos is out of bounds, don't draw garbage. This can
23398 happen in mini-buffer windows when switching between echo area
23399 glyphs and mini-buffer. */
23400 if ((row
->reversed_p
23401 ? (w
->phys_cursor
.hpos
>= 0)
23402 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
23404 int on_p
= w
->phys_cursor_on_p
;
23406 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
23407 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
23409 w
->phys_cursor_on_p
= on_p
;
23411 if (hl
== DRAW_CURSOR
)
23412 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23413 /* When we erase the cursor, and ROW is overlapped by other
23414 rows, make sure that these overlapping parts of other rows
23416 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
23418 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
23420 if (row
> w
->current_matrix
->rows
23421 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
23422 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
23423 OVERLAPS_ERASED_CURSOR
);
23425 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
23426 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
23427 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
23428 OVERLAPS_ERASED_CURSOR
);
23435 Erase the image of a cursor of window W from the screen. */
23438 erase_phys_cursor (struct window
*w
)
23440 struct frame
*f
= XFRAME (w
->frame
);
23441 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
23442 int hpos
= w
->phys_cursor
.hpos
;
23443 int vpos
= w
->phys_cursor
.vpos
;
23444 int mouse_face_here_p
= 0;
23445 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
23446 struct glyph_row
*cursor_row
;
23447 struct glyph
*cursor_glyph
;
23448 enum draw_glyphs_face hl
;
23450 /* No cursor displayed or row invalidated => nothing to do on the
23452 if (w
->phys_cursor_type
== NO_CURSOR
)
23453 goto mark_cursor_off
;
23455 /* VPOS >= active_glyphs->nrows means that window has been resized.
23456 Don't bother to erase the cursor. */
23457 if (vpos
>= active_glyphs
->nrows
)
23458 goto mark_cursor_off
;
23460 /* If row containing cursor is marked invalid, there is nothing we
23462 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
23463 if (!cursor_row
->enabled_p
)
23464 goto mark_cursor_off
;
23466 /* If line spacing is > 0, old cursor may only be partially visible in
23467 window after split-window. So adjust visible height. */
23468 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
23469 window_text_bottom_y (w
) - cursor_row
->y
);
23471 /* If row is completely invisible, don't attempt to delete a cursor which
23472 isn't there. This can happen if cursor is at top of a window, and
23473 we switch to a buffer with a header line in that window. */
23474 if (cursor_row
->visible_height
<= 0)
23475 goto mark_cursor_off
;
23477 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
23478 if (cursor_row
->cursor_in_fringe_p
)
23480 cursor_row
->cursor_in_fringe_p
= 0;
23481 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
23482 goto mark_cursor_off
;
23485 /* This can happen when the new row is shorter than the old one.
23486 In this case, either draw_glyphs or clear_end_of_line
23487 should have cleared the cursor. Note that we wouldn't be
23488 able to erase the cursor in this case because we don't have a
23489 cursor glyph at hand. */
23490 if ((cursor_row
->reversed_p
23491 ? (w
->phys_cursor
.hpos
< 0)
23492 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
23493 goto mark_cursor_off
;
23495 /* If the cursor is in the mouse face area, redisplay that when
23496 we clear the cursor. */
23497 if (! NILP (dpyinfo
->mouse_face_window
)
23498 && w
== XWINDOW (dpyinfo
->mouse_face_window
)
23499 && (vpos
> dpyinfo
->mouse_face_beg_row
23500 || (vpos
== dpyinfo
->mouse_face_beg_row
23501 && hpos
>= dpyinfo
->mouse_face_beg_col
))
23502 && (vpos
< dpyinfo
->mouse_face_end_row
23503 || (vpos
== dpyinfo
->mouse_face_end_row
23504 && hpos
< dpyinfo
->mouse_face_end_col
))
23505 /* Don't redraw the cursor's spot in mouse face if it is at the
23506 end of a line (on a newline). The cursor appears there, but
23507 mouse highlighting does not. */
23508 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
23509 mouse_face_here_p
= 1;
23511 /* Maybe clear the display under the cursor. */
23512 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
23515 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
23518 cursor_glyph
= get_phys_cursor_glyph (w
);
23519 if (cursor_glyph
== NULL
)
23520 goto mark_cursor_off
;
23522 width
= cursor_glyph
->pixel_width
;
23523 left_x
= window_box_left_offset (w
, TEXT_AREA
);
23524 x
= w
->phys_cursor
.x
;
23526 width
-= left_x
- x
;
23527 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
23528 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
23529 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
23532 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
23535 /* Erase the cursor by redrawing the character underneath it. */
23536 if (mouse_face_here_p
)
23537 hl
= DRAW_MOUSE_FACE
;
23539 hl
= DRAW_NORMAL_TEXT
;
23540 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
23543 w
->phys_cursor_on_p
= 0;
23544 w
->phys_cursor_type
= NO_CURSOR
;
23549 Display or clear cursor of window W. If ON is zero, clear the
23550 cursor. If it is non-zero, display the cursor. If ON is nonzero,
23551 where to put the cursor is specified by HPOS, VPOS, X and Y. */
23554 display_and_set_cursor (struct window
*w
, int on
,
23555 int hpos
, int vpos
, int x
, int y
)
23557 struct frame
*f
= XFRAME (w
->frame
);
23558 int new_cursor_type
;
23559 int new_cursor_width
;
23561 struct glyph_row
*glyph_row
;
23562 struct glyph
*glyph
;
23564 /* This is pointless on invisible frames, and dangerous on garbaged
23565 windows and frames; in the latter case, the frame or window may
23566 be in the midst of changing its size, and x and y may be off the
23568 if (! FRAME_VISIBLE_P (f
)
23569 || FRAME_GARBAGED_P (f
)
23570 || vpos
>= w
->current_matrix
->nrows
23571 || hpos
>= w
->current_matrix
->matrix_w
)
23574 /* If cursor is off and we want it off, return quickly. */
23575 if (!on
&& !w
->phys_cursor_on_p
)
23578 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
23579 /* If cursor row is not enabled, we don't really know where to
23580 display the cursor. */
23581 if (!glyph_row
->enabled_p
)
23583 w
->phys_cursor_on_p
= 0;
23588 if (!glyph_row
->exact_window_width_line_p
23589 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
23590 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
23592 xassert (interrupt_input_blocked
);
23594 /* Set new_cursor_type to the cursor we want to be displayed. */
23595 new_cursor_type
= get_window_cursor_type (w
, glyph
,
23596 &new_cursor_width
, &active_cursor
);
23598 /* If cursor is currently being shown and we don't want it to be or
23599 it is in the wrong place, or the cursor type is not what we want,
23601 if (w
->phys_cursor_on_p
23603 || w
->phys_cursor
.x
!= x
23604 || w
->phys_cursor
.y
!= y
23605 || new_cursor_type
!= w
->phys_cursor_type
23606 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
23607 && new_cursor_width
!= w
->phys_cursor_width
)))
23608 erase_phys_cursor (w
);
23610 /* Don't check phys_cursor_on_p here because that flag is only set
23611 to zero in some cases where we know that the cursor has been
23612 completely erased, to avoid the extra work of erasing the cursor
23613 twice. In other words, phys_cursor_on_p can be 1 and the cursor
23614 still not be visible, or it has only been partly erased. */
23617 w
->phys_cursor_ascent
= glyph_row
->ascent
;
23618 w
->phys_cursor_height
= glyph_row
->height
;
23620 /* Set phys_cursor_.* before x_draw_.* is called because some
23621 of them may need the information. */
23622 w
->phys_cursor
.x
= x
;
23623 w
->phys_cursor
.y
= glyph_row
->y
;
23624 w
->phys_cursor
.hpos
= hpos
;
23625 w
->phys_cursor
.vpos
= vpos
;
23628 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
23629 new_cursor_type
, new_cursor_width
,
23630 on
, active_cursor
);
23634 /* Switch the display of W's cursor on or off, according to the value
23638 update_window_cursor (struct window
*w
, int on
)
23640 /* Don't update cursor in windows whose frame is in the process
23641 of being deleted. */
23642 if (w
->current_matrix
)
23645 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23646 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23652 /* Call update_window_cursor with parameter ON_P on all leaf windows
23653 in the window tree rooted at W. */
23656 update_cursor_in_window_tree (struct window
*w
, int on_p
)
23660 if (!NILP (w
->hchild
))
23661 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
23662 else if (!NILP (w
->vchild
))
23663 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
23665 update_window_cursor (w
, on_p
);
23667 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
23673 Display the cursor on window W, or clear it, according to ON_P.
23674 Don't change the cursor's position. */
23677 x_update_cursor (struct frame
*f
, int on_p
)
23679 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
23684 Clear the cursor of window W to background color, and mark the
23685 cursor as not shown. This is used when the text where the cursor
23686 is about to be rewritten. */
23689 x_clear_cursor (struct window
*w
)
23691 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
23692 update_window_cursor (w
, 0);
23697 Display the active region described by mouse_face_* according to DRAW. */
23700 show_mouse_face (Display_Info
*dpyinfo
, enum draw_glyphs_face draw
)
23702 struct window
*w
= XWINDOW (dpyinfo
->mouse_face_window
);
23703 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23705 if (/* If window is in the process of being destroyed, don't bother
23707 w
->current_matrix
!= NULL
23708 /* Don't update mouse highlight if hidden */
23709 && (draw
!= DRAW_MOUSE_FACE
|| !dpyinfo
->mouse_face_hidden
)
23710 /* Recognize when we are called to operate on rows that don't exist
23711 anymore. This can happen when a window is split. */
23712 && dpyinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
23714 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
23715 struct glyph_row
*row
, *first
, *last
;
23717 first
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_beg_row
);
23718 last
= MATRIX_ROW (w
->current_matrix
, dpyinfo
->mouse_face_end_row
);
23720 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
23722 int start_hpos
, end_hpos
, start_x
;
23724 /* For all but the first row, the highlight starts at column 0. */
23727 start_hpos
= dpyinfo
->mouse_face_beg_col
;
23728 start_x
= dpyinfo
->mouse_face_beg_x
;
23737 end_hpos
= dpyinfo
->mouse_face_end_col
;
23740 end_hpos
= row
->used
[TEXT_AREA
];
23741 if (draw
== DRAW_NORMAL_TEXT
)
23742 row
->fill_line_p
= 1; /* Clear to end of line */
23745 if (end_hpos
> start_hpos
)
23747 draw_glyphs (w
, start_x
, row
, TEXT_AREA
,
23748 start_hpos
, end_hpos
,
23752 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
23756 /* When we've written over the cursor, arrange for it to
23757 be displayed again. */
23758 if (phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
23761 display_and_set_cursor (w
, 1,
23762 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
23763 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
23768 /* Change the mouse cursor. */
23769 if (draw
== DRAW_NORMAL_TEXT
&& !EQ (dpyinfo
->mouse_face_window
, f
->tool_bar_window
))
23770 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
23771 else if (draw
== DRAW_MOUSE_FACE
)
23772 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
23774 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
23778 Clear out the mouse-highlighted active region.
23779 Redraw it un-highlighted first. Value is non-zero if mouse
23780 face was actually drawn unhighlighted. */
23783 clear_mouse_face (Display_Info
*dpyinfo
)
23787 if (!dpyinfo
->mouse_face_hidden
&& !NILP (dpyinfo
->mouse_face_window
))
23789 show_mouse_face (dpyinfo
, DRAW_NORMAL_TEXT
);
23793 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
23794 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
23795 dpyinfo
->mouse_face_window
= Qnil
;
23796 dpyinfo
->mouse_face_overlay
= Qnil
;
23802 Non-zero if physical cursor of window W is within mouse face. */
23805 cursor_in_mouse_face_p (struct window
*w
)
23807 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
23808 int in_mouse_face
= 0;
23810 if (WINDOWP (dpyinfo
->mouse_face_window
)
23811 && XWINDOW (dpyinfo
->mouse_face_window
) == w
)
23813 int hpos
= w
->phys_cursor
.hpos
;
23814 int vpos
= w
->phys_cursor
.vpos
;
23816 if (vpos
>= dpyinfo
->mouse_face_beg_row
23817 && vpos
<= dpyinfo
->mouse_face_end_row
23818 && (vpos
> dpyinfo
->mouse_face_beg_row
23819 || hpos
>= dpyinfo
->mouse_face_beg_col
)
23820 && (vpos
< dpyinfo
->mouse_face_end_row
23821 || hpos
< dpyinfo
->mouse_face_end_col
23822 || dpyinfo
->mouse_face_past_end
))
23826 return in_mouse_face
;
23832 /* This function sets the mouse_face_* elements of DPYINFO, assuming
23833 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
23834 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
23835 for the overlay or run of text properties specifying the mouse
23836 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
23837 before-string and after-string that must also be highlighted.
23838 DISPLAY_STRING, if non-nil, is a display string that may cover some
23839 or all of the highlighted text. */
23842 mouse_face_from_buffer_pos (Lisp_Object window
,
23843 Display_Info
*dpyinfo
,
23844 EMACS_INT mouse_charpos
,
23845 EMACS_INT start_charpos
,
23846 EMACS_INT end_charpos
,
23847 Lisp_Object before_string
,
23848 Lisp_Object after_string
,
23849 Lisp_Object display_string
)
23851 struct window
*w
= XWINDOW (window
);
23852 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
23853 struct glyph_row
*row
;
23854 struct glyph
*glyph
, *end
;
23858 xassert (NILP (display_string
) || STRINGP (display_string
));
23859 xassert (NILP (before_string
) || STRINGP (before_string
));
23860 xassert (NILP (after_string
) || STRINGP (after_string
));
23862 /* Find the first highlighted glyph. */
23863 if (start_charpos
< MATRIX_ROW_START_CHARPOS (first
))
23865 dpyinfo
->mouse_face_beg_col
= 0;
23866 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (first
, w
->current_matrix
);
23867 dpyinfo
->mouse_face_beg_x
= first
->x
;
23868 dpyinfo
->mouse_face_beg_y
= first
->y
;
23872 row
= row_containing_pos (w
, start_charpos
, first
, NULL
, 0);
23874 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23876 /* If the before-string or display-string contains newlines,
23877 row_containing_pos skips to its last row. Move back. */
23878 if (!NILP (before_string
) || !NILP (display_string
))
23880 struct glyph_row
*prev
;
23881 while ((prev
= row
- 1, prev
>= first
)
23882 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
23883 && prev
->used
[TEXT_AREA
] > 0)
23885 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
23886 glyph
= beg
+ prev
->used
[TEXT_AREA
];
23887 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
23889 || !(EQ (glyph
->object
, before_string
)
23890 || EQ (glyph
->object
, display_string
)))
23896 glyph
= row
->glyphs
[TEXT_AREA
];
23897 end
= glyph
+ row
->used
[TEXT_AREA
];
23899 dpyinfo
->mouse_face_beg_y
= row
->y
;
23900 dpyinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23902 /* Skip truncation glyphs at the start of the glyph row. */
23903 if (row
->displays_text_p
)
23905 && INTEGERP (glyph
->object
)
23906 && glyph
->charpos
< 0;
23908 x
+= glyph
->pixel_width
;
23910 /* Scan the glyph row, stopping before BEFORE_STRING or
23911 DISPLAY_STRING or START_CHARPOS. */
23913 && !INTEGERP (glyph
->object
)
23914 && !EQ (glyph
->object
, before_string
)
23915 && !EQ (glyph
->object
, display_string
)
23916 && !(BUFFERP (glyph
->object
)
23917 && glyph
->charpos
>= start_charpos
);
23919 x
+= glyph
->pixel_width
;
23921 dpyinfo
->mouse_face_beg_x
= x
;
23922 dpyinfo
->mouse_face_beg_col
= glyph
- row
->glyphs
[TEXT_AREA
];
23925 /* Find the last highlighted glyph. */
23926 row
= row_containing_pos (w
, end_charpos
, first
, NULL
, 0);
23929 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23930 dpyinfo
->mouse_face_past_end
= 1;
23932 else if (!NILP (after_string
))
23934 /* If the after-string has newlines, advance to its last row. */
23935 struct glyph_row
*next
;
23936 struct glyph_row
*last
23937 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
23939 for (next
= row
+ 1;
23941 && next
->used
[TEXT_AREA
] > 0
23942 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
23947 glyph
= row
->glyphs
[TEXT_AREA
];
23948 end
= glyph
+ row
->used
[TEXT_AREA
];
23950 dpyinfo
->mouse_face_end_y
= row
->y
;
23951 dpyinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
23953 /* Skip truncation glyphs at the start of the row. */
23954 if (row
->displays_text_p
)
23956 && INTEGERP (glyph
->object
)
23957 && glyph
->charpos
< 0;
23959 x
+= glyph
->pixel_width
;
23961 /* Scan the glyph row, stopping at END_CHARPOS or when we encounter
23964 && !INTEGERP (glyph
->object
)
23965 && !EQ (glyph
->object
, after_string
)
23966 && !(BUFFERP (glyph
->object
) && glyph
->charpos
>= end_charpos
);
23968 x
+= glyph
->pixel_width
;
23970 /* If we found AFTER_STRING, consume it and stop. */
23971 if (EQ (glyph
->object
, after_string
))
23973 for (; EQ (glyph
->object
, after_string
) && glyph
< end
; ++glyph
)
23974 x
+= glyph
->pixel_width
;
23978 /* If there's no after-string, we must check if we overshot,
23979 which might be the case if we stopped after a string glyph.
23980 That glyph may belong to a before-string or display-string
23981 associated with the end position, which must not be
23983 Lisp_Object prev_object
;
23986 while (glyph
> row
->glyphs
[TEXT_AREA
])
23988 prev_object
= (glyph
- 1)->object
;
23989 if (!STRINGP (prev_object
) || EQ (prev_object
, display_string
))
23992 pos
= string_buffer_position (w
, prev_object
, end_charpos
);
23993 if (pos
&& pos
< end_charpos
)
23996 for (; glyph
> row
->glyphs
[TEXT_AREA
]
23997 && EQ ((glyph
- 1)->object
, prev_object
);
23999 x
-= (glyph
- 1)->pixel_width
;
24003 dpyinfo
->mouse_face_end_x
= x
;
24004 dpyinfo
->mouse_face_end_col
= glyph
- row
->glyphs
[TEXT_AREA
];
24005 dpyinfo
->mouse_face_window
= window
;
24006 dpyinfo
->mouse_face_face_id
24007 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
24009 !dpyinfo
->mouse_face_hidden
, -1);
24010 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24014 /* Find the position of the glyph for position POS in OBJECT in
24015 window W's current matrix, and return in *X, *Y the pixel
24016 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
24018 RIGHT_P non-zero means return the position of the right edge of the
24019 glyph, RIGHT_P zero means return the left edge position.
24021 If no glyph for POS exists in the matrix, return the position of
24022 the glyph with the next smaller position that is in the matrix, if
24023 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
24024 exists in the matrix, return the position of the glyph with the
24025 next larger position in OBJECT.
24027 Value is non-zero if a glyph was found. */
24030 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
24031 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
24033 int yb
= window_text_bottom_y (w
);
24034 struct glyph_row
*r
;
24035 struct glyph
*best_glyph
= NULL
;
24036 struct glyph_row
*best_row
= NULL
;
24039 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
24040 r
->enabled_p
&& r
->y
< yb
;
24043 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
24044 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
24047 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
24048 if (EQ (g
->object
, object
))
24050 if (g
->charpos
== pos
)
24057 else if (best_glyph
== NULL
24058 || ((eabs (g
->charpos
- pos
)
24059 < eabs (best_glyph
->charpos
- pos
))
24062 : g
->charpos
> pos
)))
24076 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
24080 *x
+= best_glyph
->pixel_width
;
24085 *vpos
= best_row
- w
->current_matrix
->rows
;
24088 return best_glyph
!= NULL
;
24092 /* See if position X, Y is within a hot-spot of an image. */
24095 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
24097 if (!CONSP (hot_spot
))
24100 if (EQ (XCAR (hot_spot
), Qrect
))
24102 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
24103 Lisp_Object rect
= XCDR (hot_spot
);
24107 if (!CONSP (XCAR (rect
)))
24109 if (!CONSP (XCDR (rect
)))
24111 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
24113 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
24115 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
24117 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
24121 else if (EQ (XCAR (hot_spot
), Qcircle
))
24123 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
24124 Lisp_Object circ
= XCDR (hot_spot
);
24125 Lisp_Object lr
, lx0
, ly0
;
24127 && CONSP (XCAR (circ
))
24128 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
24129 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
24130 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
24132 double r
= XFLOATINT (lr
);
24133 double dx
= XINT (lx0
) - x
;
24134 double dy
= XINT (ly0
) - y
;
24135 return (dx
* dx
+ dy
* dy
<= r
* r
);
24138 else if (EQ (XCAR (hot_spot
), Qpoly
))
24140 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
24141 if (VECTORP (XCDR (hot_spot
)))
24143 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
24144 Lisp_Object
*poly
= v
->contents
;
24148 Lisp_Object lx
, ly
;
24151 /* Need an even number of coordinates, and at least 3 edges. */
24152 if (n
< 6 || n
& 1)
24155 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
24156 If count is odd, we are inside polygon. Pixels on edges
24157 may or may not be included depending on actual geometry of the
24159 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
24160 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
24162 x0
= XINT (lx
), y0
= XINT (ly
);
24163 for (i
= 0; i
< n
; i
+= 2)
24165 int x1
= x0
, y1
= y0
;
24166 if ((lx
= poly
[i
], !INTEGERP (lx
))
24167 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
24169 x0
= XINT (lx
), y0
= XINT (ly
);
24171 /* Does this segment cross the X line? */
24179 if (y
> y0
&& y
> y1
)
24181 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
24191 find_hot_spot (Lisp_Object map
, int x
, int y
)
24193 while (CONSP (map
))
24195 if (CONSP (XCAR (map
))
24196 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
24204 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
24206 doc
: /* Lookup in image map MAP coordinates X and Y.
24207 An image map is an alist where each element has the format (AREA ID PLIST).
24208 An AREA is specified as either a rectangle, a circle, or a polygon:
24209 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
24210 pixel coordinates of the upper left and bottom right corners.
24211 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
24212 and the radius of the circle; r may be a float or integer.
24213 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
24214 vector describes one corner in the polygon.
24215 Returns the alist element for the first matching AREA in MAP. */)
24216 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
24224 return find_hot_spot (map
, XINT (x
), XINT (y
));
24228 /* Display frame CURSOR, optionally using shape defined by POINTER. */
24230 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
24232 /* Do not change cursor shape while dragging mouse. */
24233 if (!NILP (do_mouse_tracking
))
24236 if (!NILP (pointer
))
24238 if (EQ (pointer
, Qarrow
))
24239 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24240 else if (EQ (pointer
, Qhand
))
24241 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
24242 else if (EQ (pointer
, Qtext
))
24243 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24244 else if (EQ (pointer
, intern ("hdrag")))
24245 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24246 #ifdef HAVE_X_WINDOWS
24247 else if (EQ (pointer
, intern ("vdrag")))
24248 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
24250 else if (EQ (pointer
, intern ("hourglass")))
24251 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
24252 else if (EQ (pointer
, Qmodeline
))
24253 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
24255 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24258 if (cursor
!= No_Cursor
)
24259 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
24262 /* Take proper action when mouse has moved to the mode or header line
24263 or marginal area AREA of window W, x-position X and y-position Y.
24264 X is relative to the start of the text display area of W, so the
24265 width of bitmap areas and scroll bars must be subtracted to get a
24266 position relative to the start of the mode line. */
24269 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
24270 enum window_part area
)
24272 struct window
*w
= XWINDOW (window
);
24273 struct frame
*f
= XFRAME (w
->frame
);
24274 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24275 Cursor cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24276 Lisp_Object pointer
= Qnil
;
24277 int charpos
, dx
, dy
, width
, height
;
24278 Lisp_Object string
, object
= Qnil
;
24279 Lisp_Object pos
, help
;
24281 Lisp_Object mouse_face
;
24282 int original_x_pixel
= x
;
24283 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
24284 struct glyph_row
*row
;
24286 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
24291 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
24292 &object
, &dx
, &dy
, &width
, &height
);
24294 row
= (area
== ON_MODE_LINE
24295 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
24296 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
24299 if (row
->mode_line_p
&& row
->enabled_p
)
24301 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
24302 end
= glyph
+ row
->used
[TEXT_AREA
];
24304 for (x0
= original_x_pixel
;
24305 glyph
< end
&& x0
>= glyph
->pixel_width
;
24307 x0
-= glyph
->pixel_width
;
24315 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
24316 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
24317 &object
, &dx
, &dy
, &width
, &height
);
24322 if (IMAGEP (object
))
24324 Lisp_Object image_map
, hotspot
;
24325 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
24327 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
24329 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24331 Lisp_Object area_id
, plist
;
24333 area_id
= XCAR (hotspot
);
24334 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24335 If so, we could look for mouse-enter, mouse-leave
24336 properties in PLIST (and do something...). */
24337 hotspot
= XCDR (hotspot
);
24338 if (CONSP (hotspot
)
24339 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24341 pointer
= Fplist_get (plist
, Qpointer
);
24342 if (NILP (pointer
))
24344 help
= Fplist_get (plist
, Qhelp_echo
);
24347 help_echo_string
= help
;
24348 /* Is this correct? ++kfs */
24349 XSETWINDOW (help_echo_window
, w
);
24350 help_echo_object
= w
->buffer
;
24351 help_echo_pos
= charpos
;
24355 if (NILP (pointer
))
24356 pointer
= Fplist_get (XCDR (object
), QCpointer
);
24359 if (STRINGP (string
))
24361 pos
= make_number (charpos
);
24362 /* If we're on a string with `help-echo' text property, arrange
24363 for the help to be displayed. This is done by setting the
24364 global variable help_echo_string to the help string. */
24367 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
24370 help_echo_string
= help
;
24371 XSETWINDOW (help_echo_window
, w
);
24372 help_echo_object
= string
;
24373 help_echo_pos
= charpos
;
24377 if (NILP (pointer
))
24378 pointer
= Fget_text_property (pos
, Qpointer
, string
);
24380 /* Change the mouse pointer according to what is under X/Y. */
24381 if (NILP (pointer
) && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
24384 map
= Fget_text_property (pos
, Qlocal_map
, string
);
24385 if (!KEYMAPP (map
))
24386 map
= Fget_text_property (pos
, Qkeymap
, string
);
24387 if (!KEYMAPP (map
))
24388 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
24391 /* Change the mouse face according to what is under X/Y. */
24392 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
24393 if (!NILP (mouse_face
)
24394 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24399 struct glyph
* tmp_glyph
;
24403 int total_pixel_width
;
24408 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
24409 Qmouse_face
, string
, Qnil
);
24411 b
= make_number (0);
24413 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
24415 e
= make_number (SCHARS (string
));
24417 /* Calculate the position(glyph position: GPOS) of GLYPH in
24418 displayed string. GPOS is different from CHARPOS.
24420 CHARPOS is the position of glyph in internal string
24421 object. A mode line string format has structures which
24422 is converted to a flatten by emacs lisp interpreter.
24423 The internal string is an element of the structures.
24424 The displayed string is the flatten string. */
24426 if (glyph
> row_start_glyph
)
24428 tmp_glyph
= glyph
- 1;
24429 while (tmp_glyph
>= row_start_glyph
24430 && tmp_glyph
->charpos
>= XINT (b
)
24431 && EQ (tmp_glyph
->object
, glyph
->object
))
24438 /* Calculate the lenght(glyph sequence length: GSEQ_LENGTH) of
24439 displayed string holding GLYPH.
24441 GSEQ_LENGTH is different from SCHARS (STRING).
24442 SCHARS (STRING) returns the length of the internal string. */
24443 for (tmp_glyph
= glyph
, gseq_length
= gpos
;
24444 tmp_glyph
->charpos
< XINT (e
);
24445 tmp_glyph
++, gseq_length
++)
24447 if (!EQ (tmp_glyph
->object
, glyph
->object
))
24451 total_pixel_width
= 0;
24452 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
24453 total_pixel_width
+= tmp_glyph
->pixel_width
;
24455 /* Pre calculation of re-rendering position */
24457 hpos
= (area
== ON_MODE_LINE
24458 ? (w
->current_matrix
)->nrows
- 1
24461 /* If the re-rendering position is included in the last
24462 re-rendering area, we should do nothing. */
24463 if ( EQ (window
, dpyinfo
->mouse_face_window
)
24464 && dpyinfo
->mouse_face_beg_col
<= vpos
24465 && vpos
< dpyinfo
->mouse_face_end_col
24466 && dpyinfo
->mouse_face_beg_row
== hpos
)
24469 if (clear_mouse_face (dpyinfo
))
24470 cursor
= No_Cursor
;
24472 dpyinfo
->mouse_face_beg_col
= vpos
;
24473 dpyinfo
->mouse_face_beg_row
= hpos
;
24475 dpyinfo
->mouse_face_beg_x
= original_x_pixel
- (total_pixel_width
+ dx
);
24476 dpyinfo
->mouse_face_beg_y
= 0;
24478 dpyinfo
->mouse_face_end_col
= vpos
+ gseq_length
;
24479 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_beg_row
;
24481 dpyinfo
->mouse_face_end_x
= 0;
24482 dpyinfo
->mouse_face_end_y
= 0;
24484 dpyinfo
->mouse_face_past_end
= 0;
24485 dpyinfo
->mouse_face_window
= window
;
24487 dpyinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
24490 glyph
->face_id
, 1);
24491 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24493 if (NILP (pointer
))
24496 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
24497 clear_mouse_face (dpyinfo
);
24499 define_frame_cursor1 (f
, cursor
, pointer
);
24504 Take proper action when the mouse has moved to position X, Y on
24505 frame F as regards highlighting characters that have mouse-face
24506 properties. Also de-highlighting chars where the mouse was before.
24507 X and Y can be negative or out of range. */
24510 note_mouse_highlight (struct frame
*f
, int x
, int y
)
24512 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24513 enum window_part part
;
24514 Lisp_Object window
;
24516 Cursor cursor
= No_Cursor
;
24517 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
24520 /* When a menu is active, don't highlight because this looks odd. */
24521 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
24522 if (popup_activated ())
24526 if (NILP (Vmouse_highlight
)
24527 || !f
->glyphs_initialized_p
24528 || f
->pointer_invisible
)
24531 dpyinfo
->mouse_face_mouse_x
= x
;
24532 dpyinfo
->mouse_face_mouse_y
= y
;
24533 dpyinfo
->mouse_face_mouse_frame
= f
;
24535 if (dpyinfo
->mouse_face_defer
)
24538 if (gc_in_progress
)
24540 dpyinfo
->mouse_face_deferred_gc
= 1;
24544 /* Which window is that in? */
24545 window
= window_from_coordinates (f
, x
, y
, &part
, 0, 0, 1);
24547 /* If we were displaying active text in another window, clear that.
24548 Also clear if we move out of text area in same window. */
24549 if (! EQ (window
, dpyinfo
->mouse_face_window
)
24550 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
24551 && !NILP (dpyinfo
->mouse_face_window
)))
24552 clear_mouse_face (dpyinfo
);
24554 /* Not on a window -> return. */
24555 if (!WINDOWP (window
))
24558 /* Reset help_echo_string. It will get recomputed below. */
24559 help_echo_string
= Qnil
;
24561 /* Convert to window-relative pixel coordinates. */
24562 w
= XWINDOW (window
);
24563 frame_to_window_pixel_xy (w
, &x
, &y
);
24565 /* Handle tool-bar window differently since it doesn't display a
24567 if (EQ (window
, f
->tool_bar_window
))
24569 note_tool_bar_highlight (f
, x
, y
);
24573 /* Mouse is on the mode, header line or margin? */
24574 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
24575 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
24577 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
24581 if (part
== ON_VERTICAL_BORDER
)
24583 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
24584 help_echo_string
= build_string ("drag-mouse-1: resize");
24586 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
24587 || part
== ON_SCROLL_BAR
)
24588 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24590 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
24592 /* Are we in a window whose display is up to date?
24593 And verify the buffer's text has not changed. */
24594 b
= XBUFFER (w
->buffer
);
24595 if (part
== ON_TEXT
24596 && EQ (w
->window_end_valid
, w
->buffer
)
24597 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
24598 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
24600 int hpos
, vpos
, i
, dx
, dy
, area
;
24602 struct glyph
*glyph
;
24603 Lisp_Object object
;
24604 Lisp_Object mouse_face
= Qnil
, overlay
= Qnil
, position
;
24605 Lisp_Object
*overlay_vec
= NULL
;
24607 struct buffer
*obuf
;
24608 int obegv
, ozv
, same_region
;
24610 /* Find the glyph under X/Y. */
24611 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
24613 /* Look for :pointer property on image. */
24614 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24616 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24617 if (img
!= NULL
&& IMAGEP (img
->spec
))
24619 Lisp_Object image_map
, hotspot
;
24620 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
24622 && (hotspot
= find_hot_spot (image_map
,
24623 glyph
->slice
.x
+ dx
,
24624 glyph
->slice
.y
+ dy
),
24626 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
24628 Lisp_Object area_id
, plist
;
24630 area_id
= XCAR (hotspot
);
24631 /* Could check AREA_ID to see if we enter/leave this hot-spot.
24632 If so, we could look for mouse-enter, mouse-leave
24633 properties in PLIST (and do something...). */
24634 hotspot
= XCDR (hotspot
);
24635 if (CONSP (hotspot
)
24636 && (plist
= XCAR (hotspot
), CONSP (plist
)))
24638 pointer
= Fplist_get (plist
, Qpointer
);
24639 if (NILP (pointer
))
24641 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
24642 if (!NILP (help_echo_string
))
24644 help_echo_window
= window
;
24645 help_echo_object
= glyph
->object
;
24646 help_echo_pos
= glyph
->charpos
;
24650 if (NILP (pointer
))
24651 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
24655 /* Clear mouse face if X/Y not over text. */
24657 || area
!= TEXT_AREA
24658 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
)
24660 if (clear_mouse_face (dpyinfo
))
24661 cursor
= No_Cursor
;
24662 if (NILP (pointer
))
24664 if (area
!= TEXT_AREA
)
24665 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
24667 pointer
= Vvoid_text_area_pointer
;
24672 pos
= glyph
->charpos
;
24673 object
= glyph
->object
;
24674 if (!STRINGP (object
) && !BUFFERP (object
))
24677 /* If we get an out-of-range value, return now; avoid an error. */
24678 if (BUFFERP (object
) && pos
> BUF_Z (b
))
24681 /* Make the window's buffer temporarily current for
24682 overlays_at and compute_char_face. */
24683 obuf
= current_buffer
;
24684 current_buffer
= b
;
24690 /* Is this char mouse-active or does it have help-echo? */
24691 position
= make_number (pos
);
24693 if (BUFFERP (object
))
24695 /* Put all the overlays we want in a vector in overlay_vec. */
24696 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
24697 /* Sort overlays into increasing priority order. */
24698 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
24703 same_region
= (EQ (window
, dpyinfo
->mouse_face_window
)
24704 && vpos
>= dpyinfo
->mouse_face_beg_row
24705 && vpos
<= dpyinfo
->mouse_face_end_row
24706 && (vpos
> dpyinfo
->mouse_face_beg_row
24707 || hpos
>= dpyinfo
->mouse_face_beg_col
)
24708 && (vpos
< dpyinfo
->mouse_face_end_row
24709 || hpos
< dpyinfo
->mouse_face_end_col
24710 || dpyinfo
->mouse_face_past_end
));
24713 cursor
= No_Cursor
;
24715 /* Check mouse-face highlighting. */
24717 /* If there exists an overlay with mouse-face overlapping
24718 the one we are currently highlighting, we have to
24719 check if we enter the overlapping overlay, and then
24720 highlight only that. */
24721 || (OVERLAYP (dpyinfo
->mouse_face_overlay
)
24722 && mouse_face_overlay_overlaps (dpyinfo
->mouse_face_overlay
)))
24724 /* Find the highest priority overlay with a mouse-face. */
24726 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
24728 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
24729 if (!NILP (mouse_face
))
24730 overlay
= overlay_vec
[i
];
24733 /* If we're highlighting the same overlay as before, there's
24734 no need to do that again. */
24735 if (!NILP (overlay
) && EQ (overlay
, dpyinfo
->mouse_face_overlay
))
24736 goto check_help_echo
;
24737 dpyinfo
->mouse_face_overlay
= overlay
;
24739 /* Clear the display of the old active region, if any. */
24740 if (clear_mouse_face (dpyinfo
))
24741 cursor
= No_Cursor
;
24743 /* If no overlay applies, get a text property. */
24744 if (NILP (overlay
))
24745 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
24747 /* Next, compute the bounds of the mouse highlighting and
24749 if (!NILP (mouse_face
) && STRINGP (object
))
24751 /* The mouse-highlighting comes from a display string
24752 with a mouse-face. */
24756 b
= Fprevious_single_property_change
24757 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
24758 e
= Fnext_single_property_change
24759 (position
, Qmouse_face
, object
, Qnil
);
24761 b
= make_number (0);
24763 e
= make_number (SCHARS (object
) - 1);
24765 fast_find_string_pos (w
, XINT (b
), object
,
24766 &dpyinfo
->mouse_face_beg_col
,
24767 &dpyinfo
->mouse_face_beg_row
,
24768 &dpyinfo
->mouse_face_beg_x
,
24769 &dpyinfo
->mouse_face_beg_y
, 0);
24770 fast_find_string_pos (w
, XINT (e
), object
,
24771 &dpyinfo
->mouse_face_end_col
,
24772 &dpyinfo
->mouse_face_end_row
,
24773 &dpyinfo
->mouse_face_end_x
,
24774 &dpyinfo
->mouse_face_end_y
, 1);
24775 dpyinfo
->mouse_face_past_end
= 0;
24776 dpyinfo
->mouse_face_window
= window
;
24777 dpyinfo
->mouse_face_face_id
24778 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
24779 glyph
->face_id
, 1);
24780 show_mouse_face (dpyinfo
, DRAW_MOUSE_FACE
);
24781 cursor
= No_Cursor
;
24785 /* The mouse-highlighting, if any, comes from an overlay
24786 or text property in the buffer. */
24787 Lisp_Object buffer
, display_string
;
24789 if (STRINGP (object
))
24791 /* If we are on a display string with no mouse-face,
24792 check if the text under it has one. */
24793 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
24794 int start
= MATRIX_ROW_START_CHARPOS (r
);
24795 pos
= string_buffer_position (w
, object
, start
);
24798 mouse_face
= get_char_property_and_overlay
24799 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
24800 buffer
= w
->buffer
;
24801 display_string
= object
;
24807 display_string
= Qnil
;
24810 if (!NILP (mouse_face
))
24812 Lisp_Object before
, after
;
24813 Lisp_Object before_string
, after_string
;
24815 if (NILP (overlay
))
24817 /* Handle the text property case. */
24818 before
= Fprevious_single_property_change
24819 (make_number (pos
+ 1), Qmouse_face
, buffer
,
24820 Fmarker_position (w
->start
));
24821 after
= Fnext_single_property_change
24822 (make_number (pos
), Qmouse_face
, buffer
,
24823 make_number (BUF_Z (XBUFFER (buffer
))
24824 - XFASTINT (w
->window_end_pos
)));
24825 before_string
= after_string
= Qnil
;
24829 /* Handle the overlay case. */
24830 before
= Foverlay_start (overlay
);
24831 after
= Foverlay_end (overlay
);
24832 before_string
= Foverlay_get (overlay
, Qbefore_string
);
24833 after_string
= Foverlay_get (overlay
, Qafter_string
);
24835 if (!STRINGP (before_string
)) before_string
= Qnil
;
24836 if (!STRINGP (after_string
)) after_string
= Qnil
;
24839 mouse_face_from_buffer_pos (window
, dpyinfo
, pos
,
24842 before_string
, after_string
,
24844 cursor
= No_Cursor
;
24851 /* Look for a `help-echo' property. */
24852 if (NILP (help_echo_string
)) {
24853 Lisp_Object help
, overlay
;
24855 /* Check overlays first. */
24856 help
= overlay
= Qnil
;
24857 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
24859 overlay
= overlay_vec
[i
];
24860 help
= Foverlay_get (overlay
, Qhelp_echo
);
24865 help_echo_string
= help
;
24866 help_echo_window
= window
;
24867 help_echo_object
= overlay
;
24868 help_echo_pos
= pos
;
24872 Lisp_Object object
= glyph
->object
;
24873 int charpos
= glyph
->charpos
;
24875 /* Try text properties. */
24876 if (STRINGP (object
)
24878 && charpos
< SCHARS (object
))
24880 help
= Fget_text_property (make_number (charpos
),
24881 Qhelp_echo
, object
);
24884 /* If the string itself doesn't specify a help-echo,
24885 see if the buffer text ``under'' it does. */
24886 struct glyph_row
*r
24887 = MATRIX_ROW (w
->current_matrix
, vpos
);
24888 int start
= MATRIX_ROW_START_CHARPOS (r
);
24889 EMACS_INT pos
= string_buffer_position (w
, object
, start
);
24892 help
= Fget_char_property (make_number (pos
),
24893 Qhelp_echo
, w
->buffer
);
24897 object
= w
->buffer
;
24902 else if (BUFFERP (object
)
24905 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
24910 help_echo_string
= help
;
24911 help_echo_window
= window
;
24912 help_echo_object
= object
;
24913 help_echo_pos
= charpos
;
24918 /* Look for a `pointer' property. */
24919 if (NILP (pointer
))
24921 /* Check overlays first. */
24922 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
24923 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
24925 if (NILP (pointer
))
24927 Lisp_Object object
= glyph
->object
;
24928 int charpos
= glyph
->charpos
;
24930 /* Try text properties. */
24931 if (STRINGP (object
)
24933 && charpos
< SCHARS (object
))
24935 pointer
= Fget_text_property (make_number (charpos
),
24937 if (NILP (pointer
))
24939 /* If the string itself doesn't specify a pointer,
24940 see if the buffer text ``under'' it does. */
24941 struct glyph_row
*r
24942 = MATRIX_ROW (w
->current_matrix
, vpos
);
24943 int start
= MATRIX_ROW_START_CHARPOS (r
);
24944 EMACS_INT pos
= string_buffer_position (w
, object
,
24947 pointer
= Fget_char_property (make_number (pos
),
24948 Qpointer
, w
->buffer
);
24951 else if (BUFFERP (object
)
24954 pointer
= Fget_text_property (make_number (charpos
),
24961 current_buffer
= obuf
;
24966 define_frame_cursor1 (f
, cursor
, pointer
);
24971 Clear any mouse-face on window W. This function is part of the
24972 redisplay interface, and is called from try_window_id and similar
24973 functions to ensure the mouse-highlight is off. */
24976 x_clear_window_mouse_face (struct window
*w
)
24978 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (XFRAME (w
->frame
));
24979 Lisp_Object window
;
24982 XSETWINDOW (window
, w
);
24983 if (EQ (window
, dpyinfo
->mouse_face_window
))
24984 clear_mouse_face (dpyinfo
);
24990 Just discard the mouse face information for frame F, if any.
24991 This is used when the size of F is changed. */
24994 cancel_mouse_face (struct frame
*f
)
24996 Lisp_Object window
;
24997 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
24999 window
= dpyinfo
->mouse_face_window
;
25000 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
25002 dpyinfo
->mouse_face_beg_row
= dpyinfo
->mouse_face_beg_col
= -1;
25003 dpyinfo
->mouse_face_end_row
= dpyinfo
->mouse_face_end_col
= -1;
25004 dpyinfo
->mouse_face_window
= Qnil
;
25009 #endif /* HAVE_WINDOW_SYSTEM */
25012 /***********************************************************************
25014 ***********************************************************************/
25016 #ifdef HAVE_WINDOW_SYSTEM
25018 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
25019 which intersects rectangle R. R is in window-relative coordinates. */
25022 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
25023 enum glyph_row_area area
)
25025 struct glyph
*first
= row
->glyphs
[area
];
25026 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
25027 struct glyph
*last
;
25028 int first_x
, start_x
, x
;
25030 if (area
== TEXT_AREA
&& row
->fill_line_p
)
25031 /* If row extends face to end of line write the whole line. */
25032 draw_glyphs (w
, 0, row
, area
,
25033 0, row
->used
[area
],
25034 DRAW_NORMAL_TEXT
, 0);
25037 /* Set START_X to the window-relative start position for drawing glyphs of
25038 AREA. The first glyph of the text area can be partially visible.
25039 The first glyphs of other areas cannot. */
25040 start_x
= window_box_left_offset (w
, area
);
25042 if (area
== TEXT_AREA
)
25045 /* Find the first glyph that must be redrawn. */
25047 && x
+ first
->pixel_width
< r
->x
)
25049 x
+= first
->pixel_width
;
25053 /* Find the last one. */
25057 && x
< r
->x
+ r
->width
)
25059 x
+= last
->pixel_width
;
25065 draw_glyphs (w
, first_x
- start_x
, row
, area
,
25066 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
25067 DRAW_NORMAL_TEXT
, 0);
25072 /* Redraw the parts of the glyph row ROW on window W intersecting
25073 rectangle R. R is in window-relative coordinates. Value is
25074 non-zero if mouse-face was overwritten. */
25077 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
25079 xassert (row
->enabled_p
);
25081 if (row
->mode_line_p
|| w
->pseudo_window_p
)
25082 draw_glyphs (w
, 0, row
, TEXT_AREA
,
25083 0, row
->used
[TEXT_AREA
],
25084 DRAW_NORMAL_TEXT
, 0);
25087 if (row
->used
[LEFT_MARGIN_AREA
])
25088 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
25089 if (row
->used
[TEXT_AREA
])
25090 expose_area (w
, row
, r
, TEXT_AREA
);
25091 if (row
->used
[RIGHT_MARGIN_AREA
])
25092 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
25093 draw_row_fringe_bitmaps (w
, row
);
25096 return row
->mouse_face_p
;
25100 /* Redraw those parts of glyphs rows during expose event handling that
25101 overlap other rows. Redrawing of an exposed line writes over parts
25102 of lines overlapping that exposed line; this function fixes that.
25104 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
25105 row in W's current matrix that is exposed and overlaps other rows.
25106 LAST_OVERLAPPING_ROW is the last such row. */
25109 expose_overlaps (struct window
*w
,
25110 struct glyph_row
*first_overlapping_row
,
25111 struct glyph_row
*last_overlapping_row
,
25114 struct glyph_row
*row
;
25116 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
25117 if (row
->overlapping_p
)
25119 xassert (row
->enabled_p
&& !row
->mode_line_p
);
25122 if (row
->used
[LEFT_MARGIN_AREA
])
25123 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
25125 if (row
->used
[TEXT_AREA
])
25126 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
25128 if (row
->used
[RIGHT_MARGIN_AREA
])
25129 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
25135 /* Return non-zero if W's cursor intersects rectangle R. */
25138 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
25140 XRectangle cr
, result
;
25141 struct glyph
*cursor_glyph
;
25142 struct glyph_row
*row
;
25144 if (w
->phys_cursor
.vpos
>= 0
25145 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
25146 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
25148 && row
->cursor_in_fringe_p
)
25150 /* Cursor is in the fringe. */
25151 cr
.x
= window_box_right_offset (w
,
25152 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
25153 ? RIGHT_MARGIN_AREA
25156 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
25157 cr
.height
= row
->height
;
25158 return x_intersect_rectangles (&cr
, r
, &result
);
25161 cursor_glyph
= get_phys_cursor_glyph (w
);
25164 /* r is relative to W's box, but w->phys_cursor.x is relative
25165 to left edge of W's TEXT area. Adjust it. */
25166 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
25167 cr
.y
= w
->phys_cursor
.y
;
25168 cr
.width
= cursor_glyph
->pixel_width
;
25169 cr
.height
= w
->phys_cursor_height
;
25170 /* ++KFS: W32 version used W32-specific IntersectRect here, but
25171 I assume the effect is the same -- and this is portable. */
25172 return x_intersect_rectangles (&cr
, r
, &result
);
25174 /* If we don't understand the format, pretend we're not in the hot-spot. */
25180 Draw a vertical window border to the right of window W if W doesn't
25181 have vertical scroll bars. */
25184 x_draw_vertical_border (struct window
*w
)
25186 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25188 /* We could do better, if we knew what type of scroll-bar the adjacent
25189 windows (on either side) have... But we don't :-(
25190 However, I think this works ok. ++KFS 2003-04-25 */
25192 /* Redraw borders between horizontally adjacent windows. Don't
25193 do it for frames with vertical scroll bars because either the
25194 right scroll bar of a window, or the left scroll bar of its
25195 neighbor will suffice as a border. */
25196 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
25199 if (!WINDOW_RIGHTMOST_P (w
)
25200 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
25202 int x0
, x1
, y0
, y1
;
25204 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25207 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25210 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
25212 else if (!WINDOW_LEFTMOST_P (w
)
25213 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
25215 int x0
, x1
, y0
, y1
;
25217 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
25220 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
25223 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
25228 /* Redraw the part of window W intersection rectangle FR. Pixel
25229 coordinates in FR are frame-relative. Call this function with
25230 input blocked. Value is non-zero if the exposure overwrites
25234 expose_window (struct window
*w
, XRectangle
*fr
)
25236 struct frame
*f
= XFRAME (w
->frame
);
25238 int mouse_face_overwritten_p
= 0;
25240 /* If window is not yet fully initialized, do nothing. This can
25241 happen when toolkit scroll bars are used and a window is split.
25242 Reconfiguring the scroll bar will generate an expose for a newly
25244 if (w
->current_matrix
== NULL
)
25247 /* When we're currently updating the window, display and current
25248 matrix usually don't agree. Arrange for a thorough display
25250 if (w
== updated_window
)
25252 SET_FRAME_GARBAGED (f
);
25256 /* Frame-relative pixel rectangle of W. */
25257 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
25258 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
25259 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
25260 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
25262 if (x_intersect_rectangles (fr
, &wr
, &r
))
25264 int yb
= window_text_bottom_y (w
);
25265 struct glyph_row
*row
;
25266 int cursor_cleared_p
;
25267 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
25269 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
25270 r
.x
, r
.y
, r
.width
, r
.height
));
25272 /* Convert to window coordinates. */
25273 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
25274 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
25276 /* Turn off the cursor. */
25277 if (!w
->pseudo_window_p
25278 && phys_cursor_in_rect_p (w
, &r
))
25280 x_clear_cursor (w
);
25281 cursor_cleared_p
= 1;
25284 cursor_cleared_p
= 0;
25286 /* Update lines intersecting rectangle R. */
25287 first_overlapping_row
= last_overlapping_row
= NULL
;
25288 for (row
= w
->current_matrix
->rows
;
25293 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
25295 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
25296 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
25297 || (r
.y
>= y0
&& r
.y
< y1
)
25298 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
25300 /* A header line may be overlapping, but there is no need
25301 to fix overlapping areas for them. KFS 2005-02-12 */
25302 if (row
->overlapping_p
&& !row
->mode_line_p
)
25304 if (first_overlapping_row
== NULL
)
25305 first_overlapping_row
= row
;
25306 last_overlapping_row
= row
;
25310 if (expose_line (w
, row
, &r
))
25311 mouse_face_overwritten_p
= 1;
25314 else if (row
->overlapping_p
)
25316 /* We must redraw a row overlapping the exposed area. */
25318 ? y0
+ row
->phys_height
> r
.y
25319 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
25321 if (first_overlapping_row
== NULL
)
25322 first_overlapping_row
= row
;
25323 last_overlapping_row
= row
;
25331 /* Display the mode line if there is one. */
25332 if (WINDOW_WANTS_MODELINE_P (w
)
25333 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
25335 && row
->y
< r
.y
+ r
.height
)
25337 if (expose_line (w
, row
, &r
))
25338 mouse_face_overwritten_p
= 1;
25341 if (!w
->pseudo_window_p
)
25343 /* Fix the display of overlapping rows. */
25344 if (first_overlapping_row
)
25345 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
25348 /* Draw border between windows. */
25349 x_draw_vertical_border (w
);
25351 /* Turn the cursor on again. */
25352 if (cursor_cleared_p
)
25353 update_window_cursor (w
, 1);
25357 return mouse_face_overwritten_p
;
25362 /* Redraw (parts) of all windows in the window tree rooted at W that
25363 intersect R. R contains frame pixel coordinates. Value is
25364 non-zero if the exposure overwrites mouse-face. */
25367 expose_window_tree (struct window
*w
, XRectangle
*r
)
25369 struct frame
*f
= XFRAME (w
->frame
);
25370 int mouse_face_overwritten_p
= 0;
25372 while (w
&& !FRAME_GARBAGED_P (f
))
25374 if (!NILP (w
->hchild
))
25375 mouse_face_overwritten_p
25376 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
25377 else if (!NILP (w
->vchild
))
25378 mouse_face_overwritten_p
25379 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
25381 mouse_face_overwritten_p
|= expose_window (w
, r
);
25383 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
25386 return mouse_face_overwritten_p
;
25391 Redisplay an exposed area of frame F. X and Y are the upper-left
25392 corner of the exposed rectangle. W and H are width and height of
25393 the exposed area. All are pixel values. W or H zero means redraw
25394 the entire frame. */
25397 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
25400 int mouse_face_overwritten_p
= 0;
25402 TRACE ((stderr
, "expose_frame "));
25404 /* No need to redraw if frame will be redrawn soon. */
25405 if (FRAME_GARBAGED_P (f
))
25407 TRACE ((stderr
, " garbaged\n"));
25411 /* If basic faces haven't been realized yet, there is no point in
25412 trying to redraw anything. This can happen when we get an expose
25413 event while Emacs is starting, e.g. by moving another window. */
25414 if (FRAME_FACE_CACHE (f
) == NULL
25415 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
25417 TRACE ((stderr
, " no faces\n"));
25421 if (w
== 0 || h
== 0)
25424 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
25425 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
25435 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
25436 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
25438 if (WINDOWP (f
->tool_bar_window
))
25439 mouse_face_overwritten_p
25440 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
25442 #ifdef HAVE_X_WINDOWS
25444 #ifndef USE_X_TOOLKIT
25445 if (WINDOWP (f
->menu_bar_window
))
25446 mouse_face_overwritten_p
25447 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
25448 #endif /* not USE_X_TOOLKIT */
25452 /* Some window managers support a focus-follows-mouse style with
25453 delayed raising of frames. Imagine a partially obscured frame,
25454 and moving the mouse into partially obscured mouse-face on that
25455 frame. The visible part of the mouse-face will be highlighted,
25456 then the WM raises the obscured frame. With at least one WM, KDE
25457 2.1, Emacs is not getting any event for the raising of the frame
25458 (even tried with SubstructureRedirectMask), only Expose events.
25459 These expose events will draw text normally, i.e. not
25460 highlighted. Which means we must redo the highlight here.
25461 Subsume it under ``we love X''. --gerd 2001-08-15 */
25462 /* Included in Windows version because Windows most likely does not
25463 do the right thing if any third party tool offers
25464 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
25465 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
25467 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
25468 if (f
== dpyinfo
->mouse_face_mouse_frame
)
25470 int x
= dpyinfo
->mouse_face_mouse_x
;
25471 int y
= dpyinfo
->mouse_face_mouse_y
;
25472 clear_mouse_face (dpyinfo
);
25473 note_mouse_highlight (f
, x
, y
);
25480 Determine the intersection of two rectangles R1 and R2. Return
25481 the intersection in *RESULT. Value is non-zero if RESULT is not
25485 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
25487 XRectangle
*left
, *right
;
25488 XRectangle
*upper
, *lower
;
25489 int intersection_p
= 0;
25491 /* Rearrange so that R1 is the left-most rectangle. */
25493 left
= r1
, right
= r2
;
25495 left
= r2
, right
= r1
;
25497 /* X0 of the intersection is right.x0, if this is inside R1,
25498 otherwise there is no intersection. */
25499 if (right
->x
<= left
->x
+ left
->width
)
25501 result
->x
= right
->x
;
25503 /* The right end of the intersection is the minimum of the
25504 the right ends of left and right. */
25505 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
25508 /* Same game for Y. */
25510 upper
= r1
, lower
= r2
;
25512 upper
= r2
, lower
= r1
;
25514 /* The upper end of the intersection is lower.y0, if this is inside
25515 of upper. Otherwise, there is no intersection. */
25516 if (lower
->y
<= upper
->y
+ upper
->height
)
25518 result
->y
= lower
->y
;
25520 /* The lower end of the intersection is the minimum of the lower
25521 ends of upper and lower. */
25522 result
->height
= (min (lower
->y
+ lower
->height
,
25523 upper
->y
+ upper
->height
)
25525 intersection_p
= 1;
25529 return intersection_p
;
25532 #endif /* HAVE_WINDOW_SYSTEM */
25535 /***********************************************************************
25537 ***********************************************************************/
25540 syms_of_xdisp (void)
25542 Vwith_echo_area_save_vector
= Qnil
;
25543 staticpro (&Vwith_echo_area_save_vector
);
25545 Vmessage_stack
= Qnil
;
25546 staticpro (&Vmessage_stack
);
25548 Qinhibit_redisplay
= intern_c_string ("inhibit-redisplay");
25549 staticpro (&Qinhibit_redisplay
);
25551 message_dolog_marker1
= Fmake_marker ();
25552 staticpro (&message_dolog_marker1
);
25553 message_dolog_marker2
= Fmake_marker ();
25554 staticpro (&message_dolog_marker2
);
25555 message_dolog_marker3
= Fmake_marker ();
25556 staticpro (&message_dolog_marker3
);
25559 defsubr (&Sdump_frame_glyph_matrix
);
25560 defsubr (&Sdump_glyph_matrix
);
25561 defsubr (&Sdump_glyph_row
);
25562 defsubr (&Sdump_tool_bar_row
);
25563 defsubr (&Strace_redisplay
);
25564 defsubr (&Strace_to_stderr
);
25566 #ifdef HAVE_WINDOW_SYSTEM
25567 defsubr (&Stool_bar_lines_needed
);
25568 defsubr (&Slookup_image_map
);
25570 defsubr (&Sformat_mode_line
);
25571 defsubr (&Sinvisible_p
);
25572 defsubr (&Scurrent_bidi_paragraph_direction
);
25574 staticpro (&Qmenu_bar_update_hook
);
25575 Qmenu_bar_update_hook
= intern_c_string ("menu-bar-update-hook");
25577 staticpro (&Qoverriding_terminal_local_map
);
25578 Qoverriding_terminal_local_map
= intern_c_string ("overriding-terminal-local-map");
25580 staticpro (&Qoverriding_local_map
);
25581 Qoverriding_local_map
= intern_c_string ("overriding-local-map");
25583 staticpro (&Qwindow_scroll_functions
);
25584 Qwindow_scroll_functions
= intern_c_string ("window-scroll-functions");
25586 staticpro (&Qwindow_text_change_functions
);
25587 Qwindow_text_change_functions
= intern_c_string ("window-text-change-functions");
25589 staticpro (&Qredisplay_end_trigger_functions
);
25590 Qredisplay_end_trigger_functions
= intern_c_string ("redisplay-end-trigger-functions");
25592 staticpro (&Qinhibit_point_motion_hooks
);
25593 Qinhibit_point_motion_hooks
= intern_c_string ("inhibit-point-motion-hooks");
25595 Qeval
= intern_c_string ("eval");
25596 staticpro (&Qeval
);
25598 QCdata
= intern_c_string (":data");
25599 staticpro (&QCdata
);
25600 Qdisplay
= intern_c_string ("display");
25601 staticpro (&Qdisplay
);
25602 Qspace_width
= intern_c_string ("space-width");
25603 staticpro (&Qspace_width
);
25604 Qraise
= intern_c_string ("raise");
25605 staticpro (&Qraise
);
25606 Qslice
= intern_c_string ("slice");
25607 staticpro (&Qslice
);
25608 Qspace
= intern_c_string ("space");
25609 staticpro (&Qspace
);
25610 Qmargin
= intern_c_string ("margin");
25611 staticpro (&Qmargin
);
25612 Qpointer
= intern_c_string ("pointer");
25613 staticpro (&Qpointer
);
25614 Qleft_margin
= intern_c_string ("left-margin");
25615 staticpro (&Qleft_margin
);
25616 Qright_margin
= intern_c_string ("right-margin");
25617 staticpro (&Qright_margin
);
25618 Qcenter
= intern_c_string ("center");
25619 staticpro (&Qcenter
);
25620 Qline_height
= intern_c_string ("line-height");
25621 staticpro (&Qline_height
);
25622 QCalign_to
= intern_c_string (":align-to");
25623 staticpro (&QCalign_to
);
25624 QCrelative_width
= intern_c_string (":relative-width");
25625 staticpro (&QCrelative_width
);
25626 QCrelative_height
= intern_c_string (":relative-height");
25627 staticpro (&QCrelative_height
);
25628 QCeval
= intern_c_string (":eval");
25629 staticpro (&QCeval
);
25630 QCpropertize
= intern_c_string (":propertize");
25631 staticpro (&QCpropertize
);
25632 QCfile
= intern_c_string (":file");
25633 staticpro (&QCfile
);
25634 Qfontified
= intern_c_string ("fontified");
25635 staticpro (&Qfontified
);
25636 Qfontification_functions
= intern_c_string ("fontification-functions");
25637 staticpro (&Qfontification_functions
);
25638 Qtrailing_whitespace
= intern_c_string ("trailing-whitespace");
25639 staticpro (&Qtrailing_whitespace
);
25640 Qescape_glyph
= intern_c_string ("escape-glyph");
25641 staticpro (&Qescape_glyph
);
25642 Qnobreak_space
= intern_c_string ("nobreak-space");
25643 staticpro (&Qnobreak_space
);
25644 Qimage
= intern_c_string ("image");
25645 staticpro (&Qimage
);
25646 Qtext
= intern_c_string ("text");
25647 staticpro (&Qtext
);
25648 Qboth
= intern_c_string ("both");
25649 staticpro (&Qboth
);
25650 Qboth_horiz
= intern_c_string ("both-horiz");
25651 staticpro (&Qboth_horiz
);
25652 QCmap
= intern_c_string (":map");
25653 staticpro (&QCmap
);
25654 QCpointer
= intern_c_string (":pointer");
25655 staticpro (&QCpointer
);
25656 Qrect
= intern_c_string ("rect");
25657 staticpro (&Qrect
);
25658 Qcircle
= intern_c_string ("circle");
25659 staticpro (&Qcircle
);
25660 Qpoly
= intern_c_string ("poly");
25661 staticpro (&Qpoly
);
25662 Qmessage_truncate_lines
= intern_c_string ("message-truncate-lines");
25663 staticpro (&Qmessage_truncate_lines
);
25664 Qgrow_only
= intern_c_string ("grow-only");
25665 staticpro (&Qgrow_only
);
25666 Qinhibit_menubar_update
= intern_c_string ("inhibit-menubar-update");
25667 staticpro (&Qinhibit_menubar_update
);
25668 Qinhibit_eval_during_redisplay
= intern_c_string ("inhibit-eval-during-redisplay");
25669 staticpro (&Qinhibit_eval_during_redisplay
);
25670 Qposition
= intern_c_string ("position");
25671 staticpro (&Qposition
);
25672 Qbuffer_position
= intern_c_string ("buffer-position");
25673 staticpro (&Qbuffer_position
);
25674 Qobject
= intern_c_string ("object");
25675 staticpro (&Qobject
);
25676 Qbar
= intern_c_string ("bar");
25678 Qhbar
= intern_c_string ("hbar");
25679 staticpro (&Qhbar
);
25680 Qbox
= intern_c_string ("box");
25682 Qhollow
= intern_c_string ("hollow");
25683 staticpro (&Qhollow
);
25684 Qhand
= intern_c_string ("hand");
25685 staticpro (&Qhand
);
25686 Qarrow
= intern_c_string ("arrow");
25687 staticpro (&Qarrow
);
25688 Qtext
= intern_c_string ("text");
25689 staticpro (&Qtext
);
25690 Qrisky_local_variable
= intern_c_string ("risky-local-variable");
25691 staticpro (&Qrisky_local_variable
);
25692 Qinhibit_free_realized_faces
= intern_c_string ("inhibit-free-realized-faces");
25693 staticpro (&Qinhibit_free_realized_faces
);
25695 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
25696 Fcons (intern_c_string ("void-variable"), Qnil
)),
25698 staticpro (&list_of_error
);
25700 Qlast_arrow_position
= intern_c_string ("last-arrow-position");
25701 staticpro (&Qlast_arrow_position
);
25702 Qlast_arrow_string
= intern_c_string ("last-arrow-string");
25703 staticpro (&Qlast_arrow_string
);
25705 Qoverlay_arrow_string
= intern_c_string ("overlay-arrow-string");
25706 staticpro (&Qoverlay_arrow_string
);
25707 Qoverlay_arrow_bitmap
= intern_c_string ("overlay-arrow-bitmap");
25708 staticpro (&Qoverlay_arrow_bitmap
);
25710 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
25711 staticpro (&echo_buffer
[0]);
25712 staticpro (&echo_buffer
[1]);
25714 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
25715 staticpro (&echo_area_buffer
[0]);
25716 staticpro (&echo_area_buffer
[1]);
25718 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
25719 staticpro (&Vmessages_buffer_name
);
25721 mode_line_proptrans_alist
= Qnil
;
25722 staticpro (&mode_line_proptrans_alist
);
25723 mode_line_string_list
= Qnil
;
25724 staticpro (&mode_line_string_list
);
25725 mode_line_string_face
= Qnil
;
25726 staticpro (&mode_line_string_face
);
25727 mode_line_string_face_prop
= Qnil
;
25728 staticpro (&mode_line_string_face_prop
);
25729 Vmode_line_unwind_vector
= Qnil
;
25730 staticpro (&Vmode_line_unwind_vector
);
25732 help_echo_string
= Qnil
;
25733 staticpro (&help_echo_string
);
25734 help_echo_object
= Qnil
;
25735 staticpro (&help_echo_object
);
25736 help_echo_window
= Qnil
;
25737 staticpro (&help_echo_window
);
25738 previous_help_echo_string
= Qnil
;
25739 staticpro (&previous_help_echo_string
);
25740 help_echo_pos
= -1;
25742 Qright_to_left
= intern_c_string ("right-to-left");
25743 staticpro (&Qright_to_left
);
25744 Qleft_to_right
= intern_c_string ("left-to-right");
25745 staticpro (&Qleft_to_right
);
25747 #ifdef HAVE_WINDOW_SYSTEM
25748 DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p
,
25749 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
25750 For example, if a block cursor is over a tab, it will be drawn as
25751 wide as that tab on the display. */);
25752 x_stretch_cursor_p
= 0;
25755 DEFVAR_LISP ("show-trailing-whitespace", &Vshow_trailing_whitespace
,
25756 doc
: /* *Non-nil means highlight trailing whitespace.
25757 The face used for trailing whitespace is `trailing-whitespace'. */);
25758 Vshow_trailing_whitespace
= Qnil
;
25760 DEFVAR_LISP ("nobreak-char-display", &Vnobreak_char_display
,
25761 doc
: /* *Control highlighting of nobreak space and soft hyphen.
25762 A value of t means highlight the character itself (for nobreak space,
25763 use face `nobreak-space').
25764 A value of nil means no highlighting.
25765 Other values mean display the escape glyph followed by an ordinary
25766 space or ordinary hyphen. */);
25767 Vnobreak_char_display
= Qt
;
25769 DEFVAR_LISP ("void-text-area-pointer", &Vvoid_text_area_pointer
,
25770 doc
: /* *The pointer shape to show in void text areas.
25771 A value of nil means to show the text pointer. Other options are `arrow',
25772 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
25773 Vvoid_text_area_pointer
= Qarrow
;
25775 DEFVAR_LISP ("inhibit-redisplay", &Vinhibit_redisplay
,
25776 doc
: /* Non-nil means don't actually do any redisplay.
25777 This is used for internal purposes. */);
25778 Vinhibit_redisplay
= Qnil
;
25780 DEFVAR_LISP ("global-mode-string", &Vglobal_mode_string
,
25781 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
25782 Vglobal_mode_string
= Qnil
;
25784 DEFVAR_LISP ("overlay-arrow-position", &Voverlay_arrow_position
,
25785 doc
: /* Marker for where to display an arrow on top of the buffer text.
25786 This must be the beginning of a line in order to work.
25787 See also `overlay-arrow-string'. */);
25788 Voverlay_arrow_position
= Qnil
;
25790 DEFVAR_LISP ("overlay-arrow-string", &Voverlay_arrow_string
,
25791 doc
: /* String to display as an arrow in non-window frames.
25792 See also `overlay-arrow-position'. */);
25793 Voverlay_arrow_string
= make_pure_c_string ("=>");
25795 DEFVAR_LISP ("overlay-arrow-variable-list", &Voverlay_arrow_variable_list
,
25796 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
25797 The symbols on this list are examined during redisplay to determine
25798 where to display overlay arrows. */);
25799 Voverlay_arrow_variable_list
25800 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
25802 DEFVAR_INT ("scroll-step", &scroll_step
,
25803 doc
: /* *The number of lines to try scrolling a window by when point moves out.
25804 If that fails to bring point back on frame, point is centered instead.
25805 If this is zero, point is always centered after it moves off frame.
25806 If you want scrolling to always be a line at a time, you should set
25807 `scroll-conservatively' to a large value rather than set this to 1. */);
25809 DEFVAR_INT ("scroll-conservatively", &scroll_conservatively
,
25810 doc
: /* *Scroll up to this many lines, to bring point back on screen.
25811 If point moves off-screen, redisplay will scroll by up to
25812 `scroll-conservatively' lines in order to bring point just barely
25813 onto the screen again. If that cannot be done, then redisplay
25814 recenters point as usual.
25816 A value of zero means always recenter point if it moves off screen. */);
25817 scroll_conservatively
= 0;
25819 DEFVAR_INT ("scroll-margin", &scroll_margin
,
25820 doc
: /* *Number of lines of margin at the top and bottom of a window.
25821 Recenter the window whenever point gets within this many lines
25822 of the top or bottom of the window. */);
25825 DEFVAR_LISP ("display-pixels-per-inch", &Vdisplay_pixels_per_inch
,
25826 doc
: /* Pixels per inch value for non-window system displays.
25827 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
25828 Vdisplay_pixels_per_inch
= make_float (72.0);
25831 DEFVAR_INT ("debug-end-pos", &debug_end_pos
, doc
: /* Don't ask. */);
25834 DEFVAR_LISP ("truncate-partial-width-windows",
25835 &Vtruncate_partial_width_windows
,
25836 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
25837 For an integer value, truncate lines in each window narrower than the
25838 full frame width, provided the window width is less than that integer;
25839 otherwise, respect the value of `truncate-lines'.
25841 For any other non-nil value, truncate lines in all windows that do
25842 not span the full frame width.
25844 A value of nil means to respect the value of `truncate-lines'.
25846 If `word-wrap' is enabled, you might want to reduce this. */);
25847 Vtruncate_partial_width_windows
= make_number (50);
25849 DEFVAR_BOOL ("mode-line-inverse-video", &mode_line_inverse_video
,
25850 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
25851 Any other value means to use the appropriate face, `mode-line',
25852 `header-line', or `menu' respectively. */);
25853 mode_line_inverse_video
= 1;
25855 DEFVAR_LISP ("line-number-display-limit", &Vline_number_display_limit
,
25856 doc
: /* *Maximum buffer size for which line number should be displayed.
25857 If the buffer is bigger than this, the line number does not appear
25858 in the mode line. A value of nil means no limit. */);
25859 Vline_number_display_limit
= Qnil
;
25861 DEFVAR_INT ("line-number-display-limit-width",
25862 &line_number_display_limit_width
,
25863 doc
: /* *Maximum line width (in characters) for line number display.
25864 If the average length of the lines near point is bigger than this, then the
25865 line number may be omitted from the mode line. */);
25866 line_number_display_limit_width
= 200;
25868 DEFVAR_BOOL ("highlight-nonselected-windows", &highlight_nonselected_windows
,
25869 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
25870 highlight_nonselected_windows
= 0;
25872 DEFVAR_BOOL ("multiple-frames", &multiple_frames
,
25873 doc
: /* Non-nil if more than one frame is visible on this display.
25874 Minibuffer-only frames don't count, but iconified frames do.
25875 This variable is not guaranteed to be accurate except while processing
25876 `frame-title-format' and `icon-title-format'. */);
25878 DEFVAR_LISP ("frame-title-format", &Vframe_title_format
,
25879 doc
: /* Template for displaying the title bar of visible frames.
25880 \(Assuming the window manager supports this feature.)
25882 This variable has the same structure as `mode-line-format', except that
25883 the %c and %l constructs are ignored. It is used only on frames for
25884 which no explicit name has been set \(see `modify-frame-parameters'). */);
25886 DEFVAR_LISP ("icon-title-format", &Vicon_title_format
,
25887 doc
: /* Template for displaying the title bar of an iconified frame.
25888 \(Assuming the window manager supports this feature.)
25889 This variable has the same structure as `mode-line-format' (which see),
25890 and is used only on frames for which no explicit name has been set
25891 \(see `modify-frame-parameters'). */);
25893 = Vframe_title_format
25894 = pure_cons (intern_c_string ("multiple-frames"),
25895 pure_cons (make_pure_c_string ("%b"),
25896 pure_cons (pure_cons (empty_unibyte_string
,
25897 pure_cons (intern_c_string ("invocation-name"),
25898 pure_cons (make_pure_c_string ("@"),
25899 pure_cons (intern_c_string ("system-name"),
25903 DEFVAR_LISP ("message-log-max", &Vmessage_log_max
,
25904 doc
: /* Maximum number of lines to keep in the message log buffer.
25905 If nil, disable message logging. If t, log messages but don't truncate
25906 the buffer when it becomes large. */);
25907 Vmessage_log_max
= make_number (100);
25909 DEFVAR_LISP ("window-size-change-functions", &Vwindow_size_change_functions
,
25910 doc
: /* Functions called before redisplay, if window sizes have changed.
25911 The value should be a list of functions that take one argument.
25912 Just before redisplay, for each frame, if any of its windows have changed
25913 size since the last redisplay, or have been split or deleted,
25914 all the functions in the list are called, with the frame as argument. */);
25915 Vwindow_size_change_functions
= Qnil
;
25917 DEFVAR_LISP ("window-scroll-functions", &Vwindow_scroll_functions
,
25918 doc
: /* List of functions to call before redisplaying a window with scrolling.
25919 Each function is called with two arguments, the window and its new
25920 display-start position. Note that these functions are also called by
25921 `set-window-buffer'. Also note that the value of `window-end' is not
25922 valid when these functions are called. */);
25923 Vwindow_scroll_functions
= Qnil
;
25925 DEFVAR_LISP ("window-text-change-functions",
25926 &Vwindow_text_change_functions
,
25927 doc
: /* Functions to call in redisplay when text in the window might change. */);
25928 Vwindow_text_change_functions
= Qnil
;
25930 DEFVAR_LISP ("redisplay-end-trigger-functions", &Vredisplay_end_trigger_functions
,
25931 doc
: /* Functions called when redisplay of a window reaches the end trigger.
25932 Each function is called with two arguments, the window and the end trigger value.
25933 See `set-window-redisplay-end-trigger'. */);
25934 Vredisplay_end_trigger_functions
= Qnil
;
25936 DEFVAR_LISP ("mouse-autoselect-window", &Vmouse_autoselect_window
,
25937 doc
: /* *Non-nil means autoselect window with mouse pointer.
25938 If nil, do not autoselect windows.
25939 A positive number means delay autoselection by that many seconds: a
25940 window is autoselected only after the mouse has remained in that
25941 window for the duration of the delay.
25942 A negative number has a similar effect, but causes windows to be
25943 autoselected only after the mouse has stopped moving. \(Because of
25944 the way Emacs compares mouse events, you will occasionally wait twice
25945 that time before the window gets selected.\)
25946 Any other value means to autoselect window instantaneously when the
25947 mouse pointer enters it.
25949 Autoselection selects the minibuffer only if it is active, and never
25950 unselects the minibuffer if it is active.
25952 When customizing this variable make sure that the actual value of
25953 `focus-follows-mouse' matches the behavior of your window manager. */);
25954 Vmouse_autoselect_window
= Qnil
;
25956 DEFVAR_LISP ("auto-resize-tool-bars", &Vauto_resize_tool_bars
,
25957 doc
: /* *Non-nil means automatically resize tool-bars.
25958 This dynamically changes the tool-bar's height to the minimum height
25959 that is needed to make all tool-bar items visible.
25960 If value is `grow-only', the tool-bar's height is only increased
25961 automatically; to decrease the tool-bar height, use \\[recenter]. */);
25962 Vauto_resize_tool_bars
= Qt
;
25964 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", &auto_raise_tool_bar_buttons_p
,
25965 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
25966 auto_raise_tool_bar_buttons_p
= 1;
25968 DEFVAR_BOOL ("make-cursor-line-fully-visible", &make_cursor_line_fully_visible_p
,
25969 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
25970 make_cursor_line_fully_visible_p
= 1;
25972 DEFVAR_LISP ("tool-bar-border", &Vtool_bar_border
,
25973 doc
: /* *Border below tool-bar in pixels.
25974 If an integer, use it as the height of the border.
25975 If it is one of `internal-border-width' or `border-width', use the
25976 value of the corresponding frame parameter.
25977 Otherwise, no border is added below the tool-bar. */);
25978 Vtool_bar_border
= Qinternal_border_width
;
25980 DEFVAR_LISP ("tool-bar-button-margin", &Vtool_bar_button_margin
,
25981 doc
: /* *Margin around tool-bar buttons in pixels.
25982 If an integer, use that for both horizontal and vertical margins.
25983 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
25984 HORZ specifying the horizontal margin, and VERT specifying the
25985 vertical margin. */);
25986 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
25988 DEFVAR_INT ("tool-bar-button-relief", &tool_bar_button_relief
,
25989 doc
: /* *Relief thickness of tool-bar buttons. */);
25990 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
25992 DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style
,
25993 doc
: /* *Tool bar style to use.
25995 image - show images only
25996 text - show text only
25997 both - show both, text under image
25998 both-horiz - show text to the right of the image
25999 any other - use system default or image if no system default. */);
26000 Vtool_bar_style
= Qnil
;
26002 DEFVAR_INT ("tool-bar-max-label-size", &tool_bar_max_label_size
,
26003 doc
: /* *Maximum number of characters a label can have to be shown.
26004 The tool bar style must also show labels for this to have any effect, see
26005 `tool-bar-style'. */);
26006 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
26008 DEFVAR_LISP ("fontification-functions", &Vfontification_functions
,
26009 doc
: /* List of functions to call to fontify regions of text.
26010 Each function is called with one argument POS. Functions must
26011 fontify a region starting at POS in the current buffer, and give
26012 fontified regions the property `fontified'. */);
26013 Vfontification_functions
= Qnil
;
26014 Fmake_variable_buffer_local (Qfontification_functions
);
26016 DEFVAR_BOOL ("unibyte-display-via-language-environment",
26017 &unibyte_display_via_language_environment
,
26018 doc
: /* *Non-nil means display unibyte text according to language environment.
26019 Specifically, this means that raw bytes in the range 160-255 decimal
26020 are displayed by converting them to the equivalent multibyte characters
26021 according to the current language environment. As a result, they are
26022 displayed according to the current fontset.
26024 Note that this variable affects only how these bytes are displayed,
26025 but does not change the fact they are interpreted as raw bytes. */);
26026 unibyte_display_via_language_environment
= 0;
26028 DEFVAR_LISP ("max-mini-window-height", &Vmax_mini_window_height
,
26029 doc
: /* *Maximum height for resizing mini-windows.
26030 If a float, it specifies a fraction of the mini-window frame's height.
26031 If an integer, it specifies a number of lines. */);
26032 Vmax_mini_window_height
= make_float (0.25);
26034 DEFVAR_LISP ("resize-mini-windows", &Vresize_mini_windows
,
26035 doc
: /* *How to resize mini-windows.
26036 A value of nil means don't automatically resize mini-windows.
26037 A value of t means resize them to fit the text displayed in them.
26038 A value of `grow-only', the default, means let mini-windows grow
26039 only, until their display becomes empty, at which point the windows
26040 go back to their normal size. */);
26041 Vresize_mini_windows
= Qgrow_only
;
26043 DEFVAR_LISP ("blink-cursor-alist", &Vblink_cursor_alist
,
26044 doc
: /* Alist specifying how to blink the cursor off.
26045 Each element has the form (ON-STATE . OFF-STATE). Whenever the
26046 `cursor-type' frame-parameter or variable equals ON-STATE,
26047 comparing using `equal', Emacs uses OFF-STATE to specify
26048 how to blink it off. ON-STATE and OFF-STATE are values for
26049 the `cursor-type' frame parameter.
26051 If a frame's ON-STATE has no entry in this list,
26052 the frame's other specifications determine how to blink the cursor off. */);
26053 Vblink_cursor_alist
= Qnil
;
26055 DEFVAR_BOOL ("auto-hscroll-mode", &automatic_hscrolling_p
,
26056 doc
: /* *Non-nil means scroll the display automatically to make point visible. */);
26057 automatic_hscrolling_p
= 1;
26058 Qauto_hscroll_mode
= intern_c_string ("auto-hscroll-mode");
26059 staticpro (&Qauto_hscroll_mode
);
26061 DEFVAR_INT ("hscroll-margin", &hscroll_margin
,
26062 doc
: /* *How many columns away from the window edge point is allowed to get
26063 before automatic hscrolling will horizontally scroll the window. */);
26064 hscroll_margin
= 5;
26066 DEFVAR_LISP ("hscroll-step", &Vhscroll_step
,
26067 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
26068 When point is less than `hscroll-margin' columns from the window
26069 edge, automatic hscrolling will scroll the window by the amount of columns
26070 determined by this variable. If its value is a positive integer, scroll that
26071 many columns. If it's a positive floating-point number, it specifies the
26072 fraction of the window's width to scroll. If it's nil or zero, point will be
26073 centered horizontally after the scroll. Any other value, including negative
26074 numbers, are treated as if the value were zero.
26076 Automatic hscrolling always moves point outside the scroll margin, so if
26077 point was more than scroll step columns inside the margin, the window will
26078 scroll more than the value given by the scroll step.
26080 Note that the lower bound for automatic hscrolling specified by `scroll-left'
26081 and `scroll-right' overrides this variable's effect. */);
26082 Vhscroll_step
= make_number (0);
26084 DEFVAR_BOOL ("message-truncate-lines", &message_truncate_lines
,
26085 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
26086 Bind this around calls to `message' to let it take effect. */);
26087 message_truncate_lines
= 0;
26089 DEFVAR_LISP ("menu-bar-update-hook", &Vmenu_bar_update_hook
,
26090 doc
: /* Normal hook run to update the menu bar definitions.
26091 Redisplay runs this hook before it redisplays the menu bar.
26092 This is used to update submenus such as Buffers,
26093 whose contents depend on various data. */);
26094 Vmenu_bar_update_hook
= Qnil
;
26096 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
26097 doc
: /* Frame for which we are updating a menu.
26098 The enable predicate for a menu binding should check this variable. */);
26099 Vmenu_updating_frame
= Qnil
;
26101 DEFVAR_BOOL ("inhibit-menubar-update", &inhibit_menubar_update
,
26102 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
26103 inhibit_menubar_update
= 0;
26105 DEFVAR_LISP ("wrap-prefix", &Vwrap_prefix
,
26106 doc
: /* Prefix prepended to all continuation lines at display time.
26107 The value may be a string, an image, or a stretch-glyph; it is
26108 interpreted in the same way as the value of a `display' text property.
26110 This variable is overridden by any `wrap-prefix' text or overlay
26113 To add a prefix to non-continuation lines, use `line-prefix'. */);
26114 Vwrap_prefix
= Qnil
;
26115 staticpro (&Qwrap_prefix
);
26116 Qwrap_prefix
= intern_c_string ("wrap-prefix");
26117 Fmake_variable_buffer_local (Qwrap_prefix
);
26119 DEFVAR_LISP ("line-prefix", &Vline_prefix
,
26120 doc
: /* Prefix prepended to all non-continuation lines at display time.
26121 The value may be a string, an image, or a stretch-glyph; it is
26122 interpreted in the same way as the value of a `display' text property.
26124 This variable is overridden by any `line-prefix' text or overlay
26127 To add a prefix to continuation lines, use `wrap-prefix'. */);
26128 Vline_prefix
= Qnil
;
26129 staticpro (&Qline_prefix
);
26130 Qline_prefix
= intern_c_string ("line-prefix");
26131 Fmake_variable_buffer_local (Qline_prefix
);
26133 DEFVAR_BOOL ("inhibit-eval-during-redisplay", &inhibit_eval_during_redisplay
,
26134 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
26135 inhibit_eval_during_redisplay
= 0;
26137 DEFVAR_BOOL ("inhibit-free-realized-faces", &inhibit_free_realized_faces
,
26138 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
26139 inhibit_free_realized_faces
= 0;
26142 DEFVAR_BOOL ("inhibit-try-window-id", &inhibit_try_window_id
,
26143 doc
: /* Inhibit try_window_id display optimization. */);
26144 inhibit_try_window_id
= 0;
26146 DEFVAR_BOOL ("inhibit-try-window-reusing", &inhibit_try_window_reusing
,
26147 doc
: /* Inhibit try_window_reusing display optimization. */);
26148 inhibit_try_window_reusing
= 0;
26150 DEFVAR_BOOL ("inhibit-try-cursor-movement", &inhibit_try_cursor_movement
,
26151 doc
: /* Inhibit try_cursor_movement display optimization. */);
26152 inhibit_try_cursor_movement
= 0;
26153 #endif /* GLYPH_DEBUG */
26155 DEFVAR_INT ("overline-margin", &overline_margin
,
26156 doc
: /* *Space between overline and text, in pixels.
26157 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
26158 margin to the caracter height. */);
26159 overline_margin
= 2;
26161 DEFVAR_INT ("underline-minimum-offset",
26162 &underline_minimum_offset
,
26163 doc
: /* Minimum distance between baseline and underline.
26164 This can improve legibility of underlined text at small font sizes,
26165 particularly when using variable `x-use-underline-position-properties'
26166 with fonts that specify an UNDERLINE_POSITION relatively close to the
26167 baseline. The default value is 1. */);
26168 underline_minimum_offset
= 1;
26170 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
26171 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
26172 display_hourglass_p
= 1;
26174 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
26175 doc
: /* *Seconds to wait before displaying an hourglass pointer.
26176 Value must be an integer or float. */);
26177 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
26179 hourglass_atimer
= NULL
;
26180 hourglass_shown_p
= 0;
26184 /* Initialize this module when Emacs starts. */
26189 Lisp_Object root_window
;
26190 struct window
*mini_w
;
26192 current_header_line_height
= current_mode_line_height
= -1;
26194 CHARPOS (this_line_start_pos
) = 0;
26196 mini_w
= XWINDOW (minibuf_window
);
26197 root_window
= FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (mini_w
)));
26199 if (!noninteractive
)
26201 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (root_window
)));
26204 XWINDOW (root_window
)->top_line
= make_number (FRAME_TOP_MARGIN (f
));
26205 set_window_height (root_window
,
26206 FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
),
26208 mini_w
->top_line
= make_number (FRAME_LINES (f
) - 1);
26209 set_window_height (minibuf_window
, 1, 0);
26211 XWINDOW (root_window
)->total_cols
= make_number (FRAME_COLS (f
));
26212 mini_w
->total_cols
= make_number (FRAME_COLS (f
));
26214 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
26215 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
26216 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
26218 /* The default ellipsis glyphs `...'. */
26219 for (i
= 0; i
< 3; ++i
)
26220 default_invis_vector
[i
] = make_number ('.');
26224 /* Allocate the buffer for frame titles.
26225 Also used for `format-mode-line'. */
26227 mode_line_noprop_buf
= (char *) xmalloc (size
);
26228 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
26229 mode_line_noprop_ptr
= mode_line_noprop_buf
;
26230 mode_line_target
= MODE_LINE_DISPLAY
;
26233 help_echo_showing_p
= 0;
26236 /* Since w32 does not support atimers, it defines its own implementation of
26237 the following three functions in w32fns.c. */
26240 /* Platform-independent portion of hourglass implementation. */
26242 /* Return non-zero if houglass timer has been started or hourglass is shown. */
26244 hourglass_started (void)
26246 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
26249 /* Cancel a currently active hourglass timer, and start a new one. */
26251 start_hourglass (void)
26253 #if defined (HAVE_WINDOW_SYSTEM)
26255 int secs
, usecs
= 0;
26257 cancel_hourglass ();
26259 if (INTEGERP (Vhourglass_delay
)
26260 && XINT (Vhourglass_delay
) > 0)
26261 secs
= XFASTINT (Vhourglass_delay
);
26262 else if (FLOATP (Vhourglass_delay
)
26263 && XFLOAT_DATA (Vhourglass_delay
) > 0)
26266 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
26267 secs
= XFASTINT (tem
);
26268 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
26271 secs
= DEFAULT_HOURGLASS_DELAY
;
26273 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
26274 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
26275 show_hourglass
, NULL
);
26280 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
26283 cancel_hourglass (void)
26285 #if defined (HAVE_WINDOW_SYSTEM)
26286 if (hourglass_atimer
)
26288 cancel_atimer (hourglass_atimer
);
26289 hourglass_atimer
= NULL
;
26292 if (hourglass_shown_p
)
26296 #endif /* ! WINDOWSNT */
26298 /* arch-tag: eacc864d-bb6a-4b74-894a-1a4399a1358b
26299 (do not change this comment) */